Add declarative definitions import service

[shauns]

WHY are these changes introduced?

To enable importing metafield and metaobject definitions from a shop into a TOML configuration file, making it easier for developers to migrate existing custom data structures into their app configuration.

The service loads metafield definitions across all owner types, as well as metaobject definitions. These are then converted into their TOML equivalent, and for finessed rendering, a collection of patches to apply to control TOML formatting.

This service is not exposed within this PR.

[shauns]

• Add declarative definitions import service #6651 : 2 dependent PRs (#6652 , #6658 ) 👈 (View in Graphite)
• Automatic rate limit restoration w/ admin API calls #6688
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	79.47% (+0.26% 🔼)	14141/17794
🟡	Branches	73.53% (+0.33% 🔼)	6936/9433
🟡	Functions	79.62% (+0.27% 🔼)	3630/4559
🟡	Lines	79.84% (+0.27% 🔼)	13367/16743

Show new covered files 🐣

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / metafield_definitions.ts	100%	100%	100%	100%
🟢	... / metaobject_definitions.ts	100%	100%	100%	100%
🟢	... / declarative-definitions.ts	98.54%	93.18%	100%	98.51%

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / execute-operation.ts	92.86%	80% (-3.33% 🔻)	100%	92.31%
🟢	... / execute-bulk-operation.ts	92.98%	86.11% (-0.73% 🔻)	100%	92.73%
🟢	... / developer-platform-client.ts	84.62%	71.43% (-2.26% 🔻)	81.82%	93.75% (+3.13% 🔼)
🔴	... / environment.ts	35% (-6.67% 🔻)	41.18% (-1.68% 🔻)	40% (-10% 🔻)	36.84% (-6.64% 🔻)

Test suite run success

3532 tests passing in 1413 suites.

Report generated by 🧪jest coverage report action from b44cf4a

[gonzaloriestra]

The code is a bit hard to follow, I would try to simplify in general.

Also, I would add some debug messages around to be able to investigate issues from verbose outputs.

I left some random suggestions, but nothing really important.

[gonzaloriestra]

Couldn't we just replace all these with something like this?
"{projectRoot}/src/cli/api/graphql/**/generated/**/*.ts"

[shauns]

Good shout. But let me add as a separate piece of stack -- there could be good reason, nx has its idiosyncrasies.

[gonzaloriestra]

Same here

[gonzaloriestra]

And here

[github-actions]

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

• Some seemingly private modules might be re-exported through public modules.
• If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/http.d.ts

@@ -18,7 +18,7 @@ type AutomaticCancellationBehaviour = {
 } | {
     useAbortSignal: AbortSignal | (() => AbortSignal);
 };
-type RequestBehaviour = NetworkRetryBehaviour & AutomaticCancellationBehaviour;
+export type RequestBehaviour = NetworkRetryBehaviour & AutomaticCancellationBehaviour;
 export type RequestModeInput = PresetFetchBehaviour | RequestBehaviour;
 /**
  * Specify the behaviour of a network request.

packages/cli-kit/dist/public/node/api/graphql.d.ts

@@ -47,6 +47,7 @@ export type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOp
     }>>;
     variables?: TVariables;
     unauthorizedHandler?: UnauthorizedHandler;
+    autoRateLimitRestore?: boolean;
 };
 export interface GraphQLResponseOptions<T> {
     handleErrors?: boolean;