@shopify/cli-kit 3.65.3 → 3.66.1

package/dist/public/node/api/app-dev.js

@@ -1,4 +1,5 @@
 import { graphqlRequestDoc } from './graphql.js';
+import { normalizeStoreFqdn } from '../context/fqdn.js';
 import Bottleneck from 'bottleneck';
 // API Rate limiter
 // Jobs are launched every 150ms
@@ -19,7 +20,8 @@ const limiter = new Bottleneck({
  */
 export async function appDevRequest(query, shopFqdn, token, variables) {
     const api = 'App Dev';
-    const url = `https://${shopFqdn}/app_dev/unstable/graphql.json`;
+    const normalizedShopFqdn = await normalizeStoreFqdn(shopFqdn);
+    const url = `https://${normalizedShopFqdn}/app_dev/unstable/graphql.json`;
     const result = limiter.schedule(() => graphqlRequestDoc({
         query,
         api,

package/dist/public/node/api/app-dev.js.map

@@ -1 +1 @@
-{"version":3,"file":"app-dev.js","sourceRoot":"","sources":["../../../../src/public/node/api/app-dev.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAA;AAC9C,OAAO,UAAU,MAAM,YAAY,CAAA;AAInC,mBAAmB;AACnB,gCAAgC;AAChC,iDAAiD;AACjD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;IAC7B,OAAO,EAAE,GAAG;IACZ,aAAa,EAAE,EAAE;CAClB,CAAC,CAAA;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,KAA6C,EAC7C,QAAgB,EAChB,KAAa,EACb,SAAsB;IAEtB,MAAM,GAAG,GAAG,SAAS,CAAA;IACrB,MAAM,GAAG,GAAG,WAAW,QAAQ,gCAAgC,CAAA;IAC/D,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAU,GAAG,EAAE,CAC5C,iBAAiB,CAAsB;QACrC,KAAK;QACL,GAAG;QACH,GAAG;QACH,KAAK;QACL,SAAS;KACV,CAAC,CACH,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import {graphqlRequestDoc} from './graphql.js'\nimport Bottleneck from 'bottleneck'\nimport {Variables} from 'graphql-request'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\n\n// API Rate limiter\n// Jobs are launched every 150ms\n// Only 10 requests can be executed concurrently.\nconst limiter = new Bottleneck({\n  minTime: 150,\n  maxConcurrent: 10,\n})\n\n/**\n * Executes an org-scoped GraphQL query against the App Management API.\n * Uses typed documents.\n *\n * @param query - GraphQL query to execute.\n * @param shopFqdn - The shop fqdn.\n * @param token - Partners token.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <T>.\n */\nexport async function appDevRequest<TResult, TVariables extends Variables>(\n  query: TypedDocumentNode<TResult, TVariables>,\n  shopFqdn: string,\n  token: string,\n  variables?: TVariables,\n): Promise<TResult> {\n  const api = 'App Dev'\n  const url = `https://${shopFqdn}/app_dev/unstable/graphql.json`\n  const result = limiter.schedule<TResult>(() =>\n    graphqlRequestDoc<TResult, TVariables>({\n      query,\n      api,\n      url,\n      token,\n      variables,\n    }),\n  )\n\n  return result\n}\n"]}
+{"version":3,"file":"app-dev.js","sourceRoot":"","sources":["../../../../src/public/node/api/app-dev.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAC,kBAAkB,EAAC,MAAM,oBAAoB,CAAA;AACrD,OAAO,UAAU,MAAM,YAAY,CAAA;AAInC,mBAAmB;AACnB,gCAAgC;AAChC,iDAAiD;AACjD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;IAC7B,OAAO,EAAE,GAAG;IACZ,aAAa,EAAE,EAAE;CAClB,CAAC,CAAA;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,KAA6C,EAC7C,QAAgB,EAChB,KAAa,EACb,SAAsB;IAEtB,MAAM,GAAG,GAAG,SAAS,CAAA;IACrB,MAAM,kBAAkB,GAAG,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAA;IAC7D,MAAM,GAAG,GAAG,WAAW,kBAAkB,gCAAgC,CAAA;IACzE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAU,GAAG,EAAE,CAC5C,iBAAiB,CAAsB;QACrC,KAAK;QACL,GAAG;QACH,GAAG;QACH,KAAK;QACL,SAAS;KACV,CAAC,CACH,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import {graphqlRequestDoc} from './graphql.js'\nimport {normalizeStoreFqdn} from '../context/fqdn.js'\nimport Bottleneck from 'bottleneck'\nimport {Variables} from 'graphql-request'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\n\n// API Rate limiter\n// Jobs are launched every 150ms\n// Only 10 requests can be executed concurrently.\nconst limiter = new Bottleneck({\n  minTime: 150,\n  maxConcurrent: 10,\n})\n\n/**\n * Executes an org-scoped GraphQL query against the App Management API.\n * Uses typed documents.\n *\n * @param query - GraphQL query to execute.\n * @param shopFqdn - The shop fqdn.\n * @param token - Partners token.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <T>.\n */\nexport async function appDevRequest<TResult, TVariables extends Variables>(\n  query: TypedDocumentNode<TResult, TVariables>,\n  shopFqdn: string,\n  token: string,\n  variables?: TVariables,\n): Promise<TResult> {\n  const api = 'App Dev'\n  const normalizedShopFqdn = await normalizeStoreFqdn(shopFqdn)\n  const url = `https://${normalizedShopFqdn}/app_dev/unstable/graphql.json`\n  const result = limiter.schedule<TResult>(() =>\n    graphqlRequestDoc<TResult, TVariables>({\n      query,\n      api,\n      url,\n      token,\n      variables,\n    }),\n  )\n\n  return result\n}\n"]}

package/dist/public/node/api/business-platform.d.ts

@@ -24,10 +24,20 @@ export declare function businessPlatformRequestDoc<TResult, TVariables extends V
  *
  * @param query - GraphQL query to execute.
  * @param token - Business Platform token.
+ * @param organizationId - Organization ID as a numeric (non-GID) value.
+ * @param variables - GraphQL variables to pass to the query.
+ * @returns The response of the query of generic type <T>.
+ */
+export declare function businessPlatformOrganizationsRequest<T>(query: string, token: string, organizationId: string, variables?: GraphQLVariables): Promise<T>;
+/**
+ * Executes a GraphQL query against the Business Platform Organizations API. Uses typed documents.
+ *
+ * @param query - GraphQL query to execute.
+ * @param token - Business Platform token.
  * @param organizationId - Organization ID as a numeric value.
  * @param variables - GraphQL variables to pass to the query.
  * @returns The response of the query of generic type <T>.
  */
-export declare function businessPlatformOrganizationsRequest<TResult>(query: TypedDocumentNode<TResult, GraphQLVariables> | TypedDocumentNode<TResult, Exact<{
+export declare function businessPlatformOrganizationsRequestDoc<TResult>(query: TypedDocumentNode<TResult, GraphQLVariables> | TypedDocumentNode<TResult, Exact<{
     [key: string]: never;
 }>>, token: string, organizationId: string, variables?: GraphQLVariables): Promise<TResult>;

package/dist/public/node/api/business-platform.js

@@ -47,26 +47,53 @@ export async function businessPlatformRequestDoc(query, token, variables) {
         variables,
     });
 }
+/**
+ * Sets up the request to the Business Platform Organizations API.
+ *
+ * @param token - Business Platform token.
+ * @param organizationId - Organization ID as a numeric (non-GID) value.
+ */
+async function setupOrganizationsRequest(token, organizationId) {
+    const api = 'BusinessPlatform';
+    const fqdn = await businessPlatformFqdn();
+    const url = `https://${fqdn}/organizations/api/unstable/organization/${organizationId}/graphql`;
+    return {
+        token,
+        api,
+        url,
+        responseOptions: { onResponse: handleDeprecations },
+    };
+}
 /**
  * Executes a GraphQL query against the Business Platform Organizations API.
  *
  * @param query - GraphQL query to execute.
  * @param token - Business Platform token.
- * @param organizationId - Organization ID as a numeric value.
+ * @param organizationId - Organization ID as a numeric (non-GID) value.
  * @param variables - GraphQL variables to pass to the query.
  * @returns The response of the query of generic type <T>.
  */
 export async function businessPlatformOrganizationsRequest(query, token, organizationId, variables) {
-    const api = 'BusinessPlatform';
-    const fqdn = await businessPlatformFqdn();
-    const url = `https://${fqdn}/organizations/api/unstable/organization/${organizationId}/graphql`;
+    return graphqlRequest({
+        query,
+        ...(await setupOrganizationsRequest(token, organizationId)),
+        variables,
+    });
+}
+/**
+ * Executes a GraphQL query against the Business Platform Organizations API. Uses typed documents.
+ *
+ * @param query - GraphQL query to execute.
+ * @param token - Business Platform token.
+ * @param organizationId - Organization ID as a numeric value.
+ * @param variables - GraphQL variables to pass to the query.
+ * @returns The response of the query of generic type <T>.
+ */
+export async function businessPlatformOrganizationsRequestDoc(query, token, organizationId, variables) {
     return graphqlRequestDoc({
         query,
-        api,
-        url,
-        token,
+        ...(await setupOrganizationsRequest(token, organizationId)),
         variables,
-        responseOptions: { onResponse: handleDeprecations },
     });
 }
 //# sourceMappingURL=business-platform.js.map

package/dist/public/node/api/business-platform.js.map

@@ -1 +1 @@
-{"version":3,"file":"business-platform.js","sourceRoot":"","sources":["../../../../src/public/node/api/business-platform.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,cAAc,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAA;AACvF,OAAO,EAAC,kBAAkB,EAAC,MAAM,eAAe,CAAA;AAChD,OAAO,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAA;AAIvD;;;;GAIG;AACH,KAAK,UAAU,YAAY,CAAC,KAAa;IACvC,MAAM,GAAG,GAAG,kBAAkB,CAAA;IAC9B,MAAM,IAAI,GAAG,MAAM,oBAAoB,EAAE,CAAA;IACzC,MAAM,GAAG,GAAG,WAAW,IAAI,mCAAmC,CAAA;IAC9D,OAAO;QACL,KAAK;QACL,GAAG;QACH,GAAG;QACH,eAAe,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC;KAClD,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,KAAa,EACb,KAAa,EACb,SAA4B;IAE5B,OAAO,cAAc,CAAI;QACvB,GAAG,CAAC,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;QAC9B,KAAK;QACL,SAAS;KACV,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,KAA6C,EAC7C,KAAa,EACb,SAAsB;IAEtB,OAAO,iBAAiB,CAAsB;QAC5C,GAAG,CAAC,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;QAC9B,KAAK;QACL,SAAS;KACV,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,oCAAoC,CACxD,KAA+G,EAC/G,KAAa,EACb,cAAsB,EACtB,SAA4B;IAE5B,MAAM,GAAG,GAAG,kBAAkB,CAAA;IAC9B,MAAM,IAAI,GAAG,MAAM,oBAAoB,EAAE,CAAA;IACzC,MAAM,GAAG,GAAG,WAAW,IAAI,4CAA4C,cAAc,UAAU,CAAA;IAC/F,OAAO,iBAAiB,CAAC;QACvB,KAAK;QACL,GAAG;QACH,GAAG;QACH,KAAK;QACL,SAAS;QACT,eAAe,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC;KAClD,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {Exact, GraphQLVariables, graphqlRequest, graphqlRequestDoc} from './graphql.js'\nimport {handleDeprecations} from './partners.js'\nimport {businessPlatformFqdn} from '../context/fqdn.js'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\nimport {Variables} from 'graphql-request'\n\n/**\n * Sets up the request to the Business Platform Destinations API.\n *\n * @param token - Business Platform token.\n */\nasync function setupRequest(token: string) {\n  const api = 'BusinessPlatform'\n  const fqdn = await businessPlatformFqdn()\n  const url = `https://${fqdn}/destinations/api/2020-07/graphql`\n  return {\n    token,\n    api,\n    url,\n    responseOptions: {onResponse: handleDeprecations},\n  }\n}\n\n/**\n * Executes a GraphQL query against the Business Platform Destinations API.\n *\n * @param query - GraphQL query to execute.\n * @param token - Business Platform token.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <T>.\n */\nexport async function businessPlatformRequest<T>(\n  query: string,\n  token: string,\n  variables?: GraphQLVariables,\n): Promise<T> {\n  return graphqlRequest<T>({\n    ...(await setupRequest(token)),\n    query,\n    variables,\n  })\n}\n\n/**\n * Executes a GraphQL query against the Business Platform Destinations API. Uses typed documents.\n *\n * @param query - GraphQL query to execute.\n * @param token - Business Platform token.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <TResult>.\n */\nexport async function businessPlatformRequestDoc<TResult, TVariables extends Variables>(\n  query: TypedDocumentNode<TResult, TVariables>,\n  token: string,\n  variables?: TVariables,\n): Promise<TResult> {\n  return graphqlRequestDoc<TResult, TVariables>({\n    ...(await setupRequest(token)),\n    query,\n    variables,\n  })\n}\n\n/**\n * Executes a GraphQL query against the Business Platform Organizations API.\n *\n * @param query - GraphQL query to execute.\n * @param token - Business Platform token.\n * @param organizationId - Organization ID as a numeric value.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <T>.\n */\nexport async function businessPlatformOrganizationsRequest<TResult>(\n  query: TypedDocumentNode<TResult, GraphQLVariables> | TypedDocumentNode<TResult, Exact<{[key: string]: never}>>,\n  token: string,\n  organizationId: string,\n  variables?: GraphQLVariables,\n): Promise<TResult> {\n  const api = 'BusinessPlatform'\n  const fqdn = await businessPlatformFqdn()\n  const url = `https://${fqdn}/organizations/api/unstable/organization/${organizationId}/graphql`\n  return graphqlRequestDoc({\n    query,\n    api,\n    url,\n    token,\n    variables,\n    responseOptions: {onResponse: handleDeprecations},\n  })\n}\n"]}
+{"version":3,"file":"business-platform.js","sourceRoot":"","sources":["../../../../src/public/node/api/business-platform.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,cAAc,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAA;AACvF,OAAO,EAAC,kBAAkB,EAAC,MAAM,eAAe,CAAA;AAChD,OAAO,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAA;AAIvD;;;;GAIG;AACH,KAAK,UAAU,YAAY,CAAC,KAAa;IACvC,MAAM,GAAG,GAAG,kBAAkB,CAAA;IAC9B,MAAM,IAAI,GAAG,MAAM,oBAAoB,EAAE,CAAA;IACzC,MAAM,GAAG,GAAG,WAAW,IAAI,mCAAmC,CAAA;IAC9D,OAAO;QACL,KAAK;QACL,GAAG;QACH,GAAG;QACH,eAAe,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC;KAClD,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,KAAa,EACb,KAAa,EACb,SAA4B;IAE5B,OAAO,cAAc,CAAI;QACvB,GAAG,CAAC,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;QAC9B,KAAK;QACL,SAAS;KACV,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,KAA6C,EAC7C,KAAa,EACb,SAAsB;IAEtB,OAAO,iBAAiB,CAAsB;QAC5C,GAAG,CAAC,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;QAC9B,KAAK;QACL,SAAS;KACV,CAAC,CAAA;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,yBAAyB,CAAC,KAAa,EAAE,cAAsB;IAC5E,MAAM,GAAG,GAAG,kBAAkB,CAAA;IAC9B,MAAM,IAAI,GAAG,MAAM,oBAAoB,EAAE,CAAA;IACzC,MAAM,GAAG,GAAG,WAAW,IAAI,4CAA4C,cAAc,UAAU,CAAA;IAC/F,OAAO;QACL,KAAK;QACL,GAAG;QACH,GAAG;QACH,eAAe,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC;KAClD,CAAA;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,oCAAoC,CACxD,KAAa,EACb,KAAa,EACb,cAAsB,EACtB,SAA4B;IAE5B,OAAO,cAAc,CAAI;QACvB,KAAK;QACL,GAAG,CAAC,MAAM,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC3D,SAAS;KACV,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,uCAAuC,CAC3D,KAA+G,EAC/G,KAAa,EACb,cAAsB,EACtB,SAA4B;IAE5B,OAAO,iBAAiB,CAAC;QACvB,KAAK;QACL,GAAG,CAAC,MAAM,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC3D,SAAS;KACV,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {Exact, GraphQLVariables, graphqlRequest, graphqlRequestDoc} from './graphql.js'\nimport {handleDeprecations} from './partners.js'\nimport {businessPlatformFqdn} from '../context/fqdn.js'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\nimport {Variables} from 'graphql-request'\n\n/**\n * Sets up the request to the Business Platform Destinations API.\n *\n * @param token - Business Platform token.\n */\nasync function setupRequest(token: string) {\n  const api = 'BusinessPlatform'\n  const fqdn = await businessPlatformFqdn()\n  const url = `https://${fqdn}/destinations/api/2020-07/graphql`\n  return {\n    token,\n    api,\n    url,\n    responseOptions: {onResponse: handleDeprecations},\n  }\n}\n\n/**\n * Executes a GraphQL query against the Business Platform Destinations API.\n *\n * @param query - GraphQL query to execute.\n * @param token - Business Platform token.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <T>.\n */\nexport async function businessPlatformRequest<T>(\n  query: string,\n  token: string,\n  variables?: GraphQLVariables,\n): Promise<T> {\n  return graphqlRequest<T>({\n    ...(await setupRequest(token)),\n    query,\n    variables,\n  })\n}\n\n/**\n * Executes a GraphQL query against the Business Platform Destinations API. Uses typed documents.\n *\n * @param query - GraphQL query to execute.\n * @param token - Business Platform token.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <TResult>.\n */\nexport async function businessPlatformRequestDoc<TResult, TVariables extends Variables>(\n  query: TypedDocumentNode<TResult, TVariables>,\n  token: string,\n  variables?: TVariables,\n): Promise<TResult> {\n  return graphqlRequestDoc<TResult, TVariables>({\n    ...(await setupRequest(token)),\n    query,\n    variables,\n  })\n}\n\n/**\n * Sets up the request to the Business Platform Organizations API.\n *\n * @param token - Business Platform token.\n * @param organizationId - Organization ID as a numeric (non-GID) value.\n */\nasync function setupOrganizationsRequest(token: string, organizationId: string) {\n  const api = 'BusinessPlatform'\n  const fqdn = await businessPlatformFqdn()\n  const url = `https://${fqdn}/organizations/api/unstable/organization/${organizationId}/graphql`\n  return {\n    token,\n    api,\n    url,\n    responseOptions: {onResponse: handleDeprecations},\n  }\n}\n\n/**\n * Executes a GraphQL query against the Business Platform Organizations API.\n *\n * @param query - GraphQL query to execute.\n * @param token - Business Platform token.\n * @param organizationId - Organization ID as a numeric (non-GID) value.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <T>.\n */\nexport async function businessPlatformOrganizationsRequest<T>(\n  query: string,\n  token: string,\n  organizationId: string,\n  variables?: GraphQLVariables,\n): Promise<T> {\n  return graphqlRequest<T>({\n    query,\n    ...(await setupOrganizationsRequest(token, organizationId)),\n    variables,\n  })\n}\n\n/**\n * Executes a GraphQL query against the Business Platform Organizations API. Uses typed documents.\n *\n * @param query - GraphQL query to execute.\n * @param token - Business Platform token.\n * @param organizationId - Organization ID as a numeric value.\n * @param variables - GraphQL variables to pass to the query.\n * @returns The response of the query of generic type <T>.\n */\nexport async function businessPlatformOrganizationsRequestDoc<TResult>(\n  query: TypedDocumentNode<TResult, GraphQLVariables> | TypedDocumentNode<TResult, Exact<{[key: string]: never}>>,\n  token: string,\n  organizationId: string,\n  variables?: GraphQLVariables,\n): Promise<TResult> {\n  return graphqlRequestDoc({\n    query,\n    ...(await setupOrganizationsRequest(token, organizationId)),\n    variables,\n  })\n}\n"]}

package/dist/public/node/api/graphql.js

@@ -1,7 +1,7 @@
 import { buildHeaders, httpsAgent } from '../../../private/node/api/headers.js';
 import { debugLogRequestInfo, errorHandler } from '../../../private/node/api/graphql.js';
-import { debugLogResponseInfo } from '../../../private/node/api.js';
 import { runWithTimer } from '../metadata.js';
+import { retryAwareRequest } from '../../../private/node/api.js';
 import { GraphQLClient, resolveRequestDocument } from 'graphql-request';
 /**
  * Handles execution of a GraphQL query.
@@ -18,7 +18,7 @@ async function performGraphQLRequest(options) {
     const clientOptions = { agent: await httpsAgent(), headers };
     const client = new GraphQLClient(url, clientOptions);
     return runWithTimer('cmd_all_timing_network_ms')(async () => {
-        const response = await debugLogResponseInfo({ request: client.rawRequest(queryAsString, variables), url }, responseOptions?.handleErrors === false ? undefined : errorHandler(api));
+        const response = await retryAwareRequest({ request: () => client.rawRequest(queryAsString, variables), url }, responseOptions?.handleErrors === false ? undefined : errorHandler(api));
         if (responseOptions?.onResponse) {
             responseOptions.onResponse(response);
         }

package/dist/public/node/api/graphql.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql.js","sourceRoot":"","sources":["../../../../src/public/node/api/graphql.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,UAAU,EAAC,MAAM,sCAAsC,CAAA;AAC7E,OAAO,EAAC,mBAAmB,EAAE,YAAY,EAAC,MAAM,sCAAsC,CAAA;AACtF,OAAO,EAAC,oBAAoB,EAAC,MAAM,8BAA8B,CAAA;AACjE,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAC,aAAa,EAA+B,sBAAsB,EAAY,MAAM,iBAAiB,CAAA;AAyC7G;;;;GAIG;AACH,KAAK,UAAU,qBAAqB,CAAU,OAA8C;IAC1F,MAAM,EAAC,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAC,GAAG,OAAO,CAAA;IAC1F,MAAM,OAAO,GAAG;QACd,GAAG,YAAY;QACf,GAAG,YAAY,CAAC,KAAK,CAAC;KACvB,CAAA;IAED,mBAAmB,CAAC,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;IAC3D,MAAM,aAAa,GAAG,EAAC,KAAK,EAAE,MAAM,UAAU,EAAE,EAAE,OAAO,EAAC,CAAA;IAC1D,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;IAEpD,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,KAAK,IAAI,EAAE;QAC1D,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CACzC,EAAC,OAAO,EAAE,MAAM,CAAC,UAAU,CAAU,aAAa,EAAE,SAAS,CAAC,EAAE,GAAG,EAAC,EACpE,eAAe,EAAE,YAAY,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CACxE,CAAA;QAED,IAAI,eAAe,EAAE,UAAU,EAAE;YAC/B,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;SACrC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAI,OAAiC;IACvE,OAAO,qBAAqB,CAAI;QAC9B,GAAG,OAAO;QACV,aAAa,EAAE,OAAO,CAAC,KAAe;KACvC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAsD;IAEtD,OAAO,qBAAqB,CAAU;QACpC,GAAG,OAAO;QACV,aAAa,EAAE,sBAAsB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK;KAC3D,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {buildHeaders, httpsAgent} from '../../../private/node/api/headers.js'\nimport {debugLogRequestInfo, errorHandler} from '../../../private/node/api/graphql.js'\nimport {debugLogResponseInfo} from '../../../private/node/api.js'\nimport {runWithTimer} from '../metadata.js'\nimport {GraphQLClient, rawRequest, RequestDocument, resolveRequestDocument, Variables} from 'graphql-request'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\n\n// to replace TVariable type when there graphql query has no variables\nexport type Exact<T extends {[key: string]: unknown}> = {[K in keyof T]: T[K]}\n\nexport interface GraphQLVariables {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [key: string]: any\n}\n\nexport type GraphQLResponse<T> = Awaited<ReturnType<typeof rawRequest<T>>>\n\ninterface GraphQLRequestBaseOptions<TResult> {\n  api: string\n  url: string\n  token?: string\n  addedHeaders?: {[header: string]: string}\n  responseOptions?: GraphQLResponseOptions<TResult>\n}\n\ntype PerformGraphQLRequestOptions<TResult> = GraphQLRequestBaseOptions<TResult> & {\n  queryAsString: string\n  variables?: Variables\n}\n\nexport type GraphQLRequestOptions<T> = GraphQLRequestBaseOptions<T> & {\n  query: RequestDocument\n  variables?: Variables\n}\n\nexport type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOptions<TResult> & {\n  query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{[key: string]: never}>>\n  variables?: TVariables\n}\n\nexport interface GraphQLResponseOptions<T> {\n  handleErrors?: boolean\n  onResponse?: (response: GraphQLResponse<T>) => void\n}\n\n/**\n * Handles execution of a GraphQL query.\n *\n * @param options - GraphQL request options.\n */\nasync function performGraphQLRequest<TResult>(options: PerformGraphQLRequestOptions<TResult>) {\n  const {token, addedHeaders, queryAsString, variables, api, url, responseOptions} = options\n  const headers = {\n    ...addedHeaders,\n    ...buildHeaders(token),\n  }\n\n  debugLogRequestInfo(api, queryAsString, variables, headers)\n  const clientOptions = {agent: await httpsAgent(), headers}\n  const client = new GraphQLClient(url, clientOptions)\n\n  return runWithTimer('cmd_all_timing_network_ms')(async () => {\n    const response = await debugLogResponseInfo(\n      {request: client.rawRequest<TResult>(queryAsString, variables), url},\n      responseOptions?.handleErrors === false ? undefined : errorHandler(api),\n    )\n\n    if (responseOptions?.onResponse) {\n      responseOptions.onResponse(response)\n    }\n\n    return response.data\n  })\n}\n\n/**\n * Executes a GraphQL query to an endpoint.\n *\n * @param options - GraphQL request options.\n * @returns The response of the query of generic type <T>.\n */\nexport async function graphqlRequest<T>(options: GraphQLRequestOptions<T>): Promise<T> {\n  return performGraphQLRequest<T>({\n    ...options,\n    queryAsString: options.query as string,\n  })\n}\n\n/**\n * Executes a GraphQL query to an endpoint. Uses typed documents.\n *\n * @param options - GraphQL request options.\n * @returns The response of the query of generic type <TResult>.\n */\nexport async function graphqlRequestDoc<TResult, TVariables extends Variables>(\n  options: GraphQLRequestDocOptions<TResult, TVariables>,\n): Promise<TResult> {\n  return performGraphQLRequest<TResult>({\n    ...options,\n    queryAsString: resolveRequestDocument(options.query).query,\n  })\n}\n"]}
+{"version":3,"file":"graphql.js","sourceRoot":"","sources":["../../../../src/public/node/api/graphql.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,UAAU,EAAC,MAAM,sCAAsC,CAAA;AAC7E,OAAO,EAAC,mBAAmB,EAAE,YAAY,EAAC,MAAM,sCAAsC,CAAA;AACtF,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAC,iBAAiB,EAAC,MAAM,8BAA8B,CAAA;AAC9D,OAAO,EAAC,aAAa,EAA+B,sBAAsB,EAAY,MAAM,iBAAiB,CAAA;AAyC7G;;;;GAIG;AACH,KAAK,UAAU,qBAAqB,CAAU,OAA8C;IAC1F,MAAM,EAAC,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAC,GAAG,OAAO,CAAA;IAC1F,MAAM,OAAO,GAAG;QACd,GAAG,YAAY;QACf,GAAG,YAAY,CAAC,KAAK,CAAC;KACvB,CAAA;IAED,mBAAmB,CAAC,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;IAC3D,MAAM,aAAa,GAAG,EAAC,KAAK,EAAE,MAAM,UAAU,EAAE,EAAE,OAAO,EAAC,CAAA;IAC1D,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;IAEpD,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,KAAK,IAAI,EAAE;QAC1D,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CACtC,EAAC,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAU,aAAa,EAAE,SAAS,CAAC,EAAE,GAAG,EAAC,EAC1E,eAAe,EAAE,YAAY,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CACxE,CAAA;QAED,IAAI,eAAe,EAAE,UAAU,EAAE;YAC/B,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;SACrC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAI,OAAiC;IACvE,OAAO,qBAAqB,CAAI;QAC9B,GAAG,OAAO;QACV,aAAa,EAAE,OAAO,CAAC,KAAe;KACvC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAsD;IAEtD,OAAO,qBAAqB,CAAU;QACpC,GAAG,OAAO;QACV,aAAa,EAAE,sBAAsB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK;KAC3D,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {buildHeaders, httpsAgent} from '../../../private/node/api/headers.js'\nimport {debugLogRequestInfo, errorHandler} from '../../../private/node/api/graphql.js'\nimport {runWithTimer} from '../metadata.js'\nimport {retryAwareRequest} from '../../../private/node/api.js'\nimport {GraphQLClient, rawRequest, RequestDocument, resolveRequestDocument, Variables} from 'graphql-request'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\n\n// to replace TVariable type when there graphql query has no variables\nexport type Exact<T extends {[key: string]: unknown}> = {[K in keyof T]: T[K]}\n\nexport interface GraphQLVariables {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [key: string]: any\n}\n\nexport type GraphQLResponse<T> = Awaited<ReturnType<typeof rawRequest<T>>>\n\ninterface GraphQLRequestBaseOptions<TResult> {\n  api: string\n  url: string\n  token?: string\n  addedHeaders?: {[header: string]: string}\n  responseOptions?: GraphQLResponseOptions<TResult>\n}\n\ntype PerformGraphQLRequestOptions<TResult> = GraphQLRequestBaseOptions<TResult> & {\n  queryAsString: string\n  variables?: Variables\n}\n\nexport type GraphQLRequestOptions<T> = GraphQLRequestBaseOptions<T> & {\n  query: RequestDocument\n  variables?: Variables\n}\n\nexport type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOptions<TResult> & {\n  query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{[key: string]: never}>>\n  variables?: TVariables\n}\n\nexport interface GraphQLResponseOptions<T> {\n  handleErrors?: boolean\n  onResponse?: (response: GraphQLResponse<T>) => void\n}\n\n/**\n * Handles execution of a GraphQL query.\n *\n * @param options - GraphQL request options.\n */\nasync function performGraphQLRequest<TResult>(options: PerformGraphQLRequestOptions<TResult>) {\n  const {token, addedHeaders, queryAsString, variables, api, url, responseOptions} = options\n  const headers = {\n    ...addedHeaders,\n    ...buildHeaders(token),\n  }\n\n  debugLogRequestInfo(api, queryAsString, variables, headers)\n  const clientOptions = {agent: await httpsAgent(), headers}\n  const client = new GraphQLClient(url, clientOptions)\n\n  return runWithTimer('cmd_all_timing_network_ms')(async () => {\n    const response = await retryAwareRequest(\n      {request: () => client.rawRequest<TResult>(queryAsString, variables), url},\n      responseOptions?.handleErrors === false ? undefined : errorHandler(api),\n    )\n\n    if (responseOptions?.onResponse) {\n      responseOptions.onResponse(response)\n    }\n\n    return response.data\n  })\n}\n\n/**\n * Executes a GraphQL query to an endpoint.\n *\n * @param options - GraphQL request options.\n * @returns The response of the query of generic type <T>.\n */\nexport async function graphqlRequest<T>(options: GraphQLRequestOptions<T>): Promise<T> {\n  return performGraphQLRequest<T>({\n    ...options,\n    queryAsString: options.query as string,\n  })\n}\n\n/**\n * Executes a GraphQL query to an endpoint. Uses typed documents.\n *\n * @param options - GraphQL request options.\n * @returns The response of the query of generic type <TResult>.\n */\nexport async function graphqlRequestDoc<TResult, TVariables extends Variables>(\n  options: GraphQLRequestDocOptions<TResult, TVariables>,\n): Promise<TResult> {\n  return performGraphQLRequest<TResult>({\n    ...options,\n    queryAsString: resolveRequestDocument(options.query).query,\n  })\n}\n"]}

package/dist/public/node/api/rest-api-throttler.d.ts

@@ -0,0 +1,23 @@
+import { RestResponse } from './admin.js';
+/**
+ * Throttles a provided action, limiting the number of globally parallel requests, or by the last seen API limit
+ * headers.
+ *
+ * @param request - A function performing a request.
+ * @returns - The result of the request, once it eventually runs.
+ */
+export declare function throttle<T>(request: () => T): Promise<T>;
+/**
+ * Keep track of the latest API call limit data from a response.
+ *
+ * @param response - The response object.
+ */
+export declare function updateApiCallLimitFromResponse(response: RestResponse): void;
+/**
+ * Retries an operation after a delay specified in the response headers.
+ *
+ * @param response - The response object.
+ * @param operation - The operation to retry.
+ * @returns - The response of the operation.
+ */
+export declare function delayAwareRetry(response: RestResponse, operation: () => Promise<RestResponse>): Promise<RestResponse>;

package/dist/public/node/api/rest-api-throttler.js

@@ -0,0 +1,239 @@
+import { tryParseInt } from '@shopify/cli-kit/common/string';
+const MAX_NUMBER_OF_PARALLEL_REQUESTS = 5;
+const MARGIN_TO_RATE_LIMIT = 5;
+const DELAY_FOR_TOO_MANY_PARALLEL_REQUESTS = 1000;
+const DELAY_FOR_TOO_CLOSE_TO_API_LIMIT = 4000;
+const THEME_CONTEXT = 'theme';
+/**
+ * Throttles a provided action, limiting the number of globally parallel requests, or by the last seen API limit
+ * headers.
+ *
+ * @param request - A function performing a request.
+ * @returns - The result of the request, once it eventually runs.
+ */
+export async function throttle(request) {
+    return new Promise((resolve, _reject) => {
+        const performRequest = () => {
+            throttlingState(THEME_CONTEXT).requestCounter += 1;
+            resolve(request());
+        };
+        /**
+         * Performs the request taking into account the
+         * limit of parallel requests only when the API limit has not
+         * been reached.
+         *
+         * Otherwise, performs the request to get the updated API limit
+         * headers, so throttler parameters get updates.
+         */
+        const throttleByHeader = () => {
+            if (isReachingApiLimit()) {
+                setTimeout(() => throttleByParallelCounter(performRequest), DELAY_FOR_TOO_CLOSE_TO_API_LIMIT);
+            }
+            else {
+                throttleByParallelCounter(performRequest);
+            }
+        };
+        /**
+         * Performs the command only when the the limit
+         * of parallel request has not been reached.
+         *
+         * Otherwise, defers the execution to the throttle by rate-limit function,
+         * still respecting the limit of parallel requests.
+         *
+         * @param command - The action to execute.
+         */
+        const throttleByParallelCounter = (command) => {
+            if (hasTooManyRequests()) {
+                setTimeout(() => throttleByParallelCounter(throttleByHeader), DELAY_FOR_TOO_MANY_PARALLEL_REQUESTS);
+            }
+            else {
+                command();
+            }
+        };
+        /**
+         * Start throttling by counter to get the API limit headers.
+         */
+        throttleByParallelCounter(throttleByHeader);
+    }).finally(() => {
+        throttlingState(THEME_CONTEXT).requestCounter -= 1;
+    });
+}
+/**
+ * Keep track of the latest API call limit data from a response.
+ *
+ * @param response - The response object.
+ */
+export function updateApiCallLimitFromResponse(response) {
+    const callLimit = extractApiCallLimitFromResponse(response);
+    if (!callLimit) {
+        return;
+    }
+    const [used, limit] = callLimit;
+    latestRequestInfo().apiCallLimit = { used, limit };
+}
+function hasTooManyRequests() {
+    return throttlingState(THEME_CONTEXT).requestCounter > MAX_NUMBER_OF_PARALLEL_REQUESTS;
+}
+function isReachingApiLimit() {
+    const { used, limit } = latestRequestInfo().apiCallLimit;
+    return used >= limit - MARGIN_TO_RATE_LIMIT;
+}
+function latestRequestInfo() {
+    return throttlingState(THEME_CONTEXT).latestRequestInfo;
+}
+/**
+ * Even considering the Stateless modules convention,
+ * tracking information about the latest request is
+ * critical to optimize the request throttler efficiently.
+ *
+ * Thus, in this case, this module deliberately avoids
+ * IO cost and uses the `_throttlingState` instance for
+ * that purpose.
+ *
+ * A context option is used if multiple APIs are using these capabilities.
+ *
+ * @param context - The context which we're tracking throttle state within.
+ */
+function throttlingState(context) {
+    const stateForContext = _throttlingState[context];
+    if (stateForContext === undefined) {
+        const startingState = {
+            requestCounter: 0,
+            latestRequestInfo: {
+                apiCallLimit: { used: 0, limit: 40 },
+            },
+        };
+        _throttlingState[context] = startingState;
+        return startingState;
+    }
+    else {
+        return stateForContext;
+    }
+}
+const _throttlingState = {};
+function extractRetryDelayMsFromResponse(response) {
+    const retryAfterStr = header(response, 'retry-after');
+    const retryAfter = tryParseInt(retryAfterStr);
+    if (!retryAfter) {
+        return 0;
+    }
+    return retryAfter;
+}
+/**
+ * Retries an operation after a delay specified in the response headers.
+ *
+ * @param response - The response object.
+ * @param operation - The operation to retry.
+ * @returns - The response of the operation.
+ */
+export async function delayAwareRetry(response, operation) {
+    const retryDelay = extractRetryDelayMsFromResponse(response);
+    return new Promise((resolve, _reject) => {
+        setTimeout(() => resolve(operation()), retryDelay);
+    });
+}
+function extractApiCallLimitFromResponse(response) {
+    const apiCallLimit = header(response, 'x-shopify-shop-api-call-limit');
+    const [used, limit] = apiCallLimit
+        .split('/')
+        .map((num) => tryParseInt(num))
+        .filter(Boolean);
+    if (!used || !limit) {
+        return;
+    }
+    return [used, limit];
+}
+function header(response, name) {
+    const headers = response.headers;
+    const header = headers[name];
+    if (header?.length === 1) {
+        return header[0] ?? '';
+    }
+    return '';
+}
+if (import.meta.vitest) {
+    const { describe, test, expect, beforeEach } = import.meta.vitest;
+    let response;
+    beforeEach(() => {
+        response = {
+            json: {},
+            status: 200,
+            headers: {},
+        };
+    });
+    describe('retryAfter', () => {
+        test('when the "retry-after" header value is valid', async () => {
+            // Given
+            response.headers = {
+                'retry-after': ['2.0'],
+            };
+            // When
+            const retryAfterDelay = extractRetryDelayMsFromResponse(response);
+            // Then
+            expect(retryAfterDelay).toBe(2);
+        });
+        test('when the "retry-after" header value is not present', async () => {
+            // Given
+            response.headers = {
+                'retry-after': [],
+            };
+            // When
+            const retryAfterDelay = extractRetryDelayMsFromResponse(response);
+            // Then
+            expect(retryAfterDelay).toBe(0);
+        });
+        test('when the "retry-after" header value is valid', async () => {
+            // Given
+            response.headers = {
+                'retry-after': ['invalid'],
+            };
+            // When
+            const retryAfterDelay = extractRetryDelayMsFromResponse(response);
+            // Then
+            expect(retryAfterDelay).toBe(0);
+        });
+        test('when the "retry-after" header is not present', async () => {
+            // Given
+            response.headers = {};
+            // When
+            const retryAfterDelay = extractRetryDelayMsFromResponse(response);
+            // Then
+            expect(retryAfterDelay).toBe(0);
+        });
+    });
+    describe('apiCallLimit', () => {
+        test('when the "x-shopify-shop-api-call-limit" header is valid', async () => {
+            // Given
+            response.headers = {
+                'x-shopify-shop-api-call-limit': ['10/40'],
+            };
+            // When
+            const callLimit = extractApiCallLimitFromResponse(response);
+            const [used, limit] = callLimit;
+            // Then
+            expect(used).toBe(10);
+            expect(limit).toBe(40);
+        });
+        test('when the "x-shopify-shop-api-call-limit" header is invalid', async () => {
+            // Given
+            response.headers = {
+                'x-shopify-shop-api-call-limit': ['foo/bar'],
+            };
+            // When
+            const callLimit = extractApiCallLimitFromResponse(response);
+            // Then
+            expect(callLimit).toBeUndefined();
+        });
+        test('when the "x-shopify-shop-api-call-limit" header is not formatted as expected', async () => {
+            // Given
+            response.headers = {
+                'x-shopify-shop-api-call-limit': ['/10'],
+            };
+            // When
+            const callLimit = extractApiCallLimitFromResponse(response);
+            // Then
+            expect(callLimit).toBeUndefined();
+        });
+    });
+}
+//# sourceMappingURL=rest-api-throttler.js.map

package/dist/public/node/api/rest-api-throttler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-api-throttler.js","sourceRoot":"","sources":["../../../../src/public/node/api/rest-api-throttler.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,WAAW,EAAC,MAAM,gCAAgC,CAAA;AAE1D,MAAM,+BAA+B,GAAG,CAAC,CAAA;AACzC,MAAM,oBAAoB,GAAG,CAAC,CAAA;AAE9B,MAAM,oCAAoC,GAAG,IAAI,CAAA;AACjD,MAAM,gCAAgC,GAAG,IAAI,CAAA;AAE7C,MAAM,aAAa,GAAG,OAAO,CAAA;AAE7B;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,OAAgB;IAChD,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACzC,MAAM,cAAc,GAAG,GAAG,EAAE;YAC1B,eAAe,CAAC,aAAa,CAAC,CAAC,cAAc,IAAI,CAAC,CAAA;YAClD,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;QACpB,CAAC,CAAA;QAED;;;;;;;WAOG;QACH,MAAM,gBAAgB,GAAG,GAAG,EAAE;YAC5B,IAAI,kBAAkB,EAAE,EAAE;gBACxB,UAAU,CAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC,cAAc,CAAC,EAAE,gCAAgC,CAAC,CAAA;aAC9F;iBAAM;gBACL,yBAAyB,CAAC,cAAc,CAAC,CAAA;aAC1C;QACH,CAAC,CAAA;QAED;;;;;;;;WAQG;QACH,MAAM,yBAAyB,GAAG,CAAC,OAAmB,EAAE,EAAE;YACxD,IAAI,kBAAkB,EAAE,EAAE;gBACxB,UAAU,CAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,oCAAoC,CAAC,CAAA;aACpG;iBAAM;gBACL,OAAO,EAAE,CAAA;aACV;QACH,CAAC,CAAA;QAED;;WAEG;QACH,yBAAyB,CAAC,gBAAgB,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;QACd,eAAe,CAAC,aAAa,CAAC,CAAC,cAAc,IAAI,CAAC,CAAA;IACpD,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,QAAsB;IACnE,MAAM,SAAS,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;IAE3D,IAAI,CAAC,SAAS,EAAE;QACd,OAAM;KACP;IAED,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,SAAS,CAAA;IAE/B,iBAAiB,EAAE,CAAC,YAAY,GAAG,EAAC,IAAI,EAAE,KAAK,EAAC,CAAA;AAClD,CAAC;AAED,SAAS,kBAAkB;IACzB,OAAO,eAAe,CAAC,aAAa,CAAC,CAAC,cAAc,GAAG,+BAA+B,CAAA;AACxF,CAAC;AAED,SAAS,kBAAkB;IACzB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,iBAAiB,EAAE,CAAC,YAAY,CAAA;IACtD,OAAO,IAAI,IAAI,KAAK,GAAG,oBAAoB,CAAA;AAC7C,CAAC;AAED,SAAS,iBAAiB;IACxB,OAAO,eAAe,CAAC,aAAa,CAAC,CAAC,iBAAiB,CAAA;AACzD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,eAAe,CAAC,OAAe;IACtC,MAAM,eAAe,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACjD,IAAI,eAAe,KAAK,SAAS,EAAE;QACjC,MAAM,aAAa,GAAG;YACpB,cAAc,EAAE,CAAC;YACjB,iBAAiB,EAAE;gBACjB,YAAY,EAAE,EAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAC;aACnC;SACF,CAAA;QACD,gBAAgB,CAAC,OAAO,CAAC,GAAG,aAAa,CAAA;QACzC,OAAO,aAAa,CAAA;KACrB;SAAM;QACL,OAAO,eAAe,CAAA;KACvB;AACH,CAAC;AAgBD,MAAM,gBAAgB,GAElB,EAAE,CAAA;AAEN,SAAS,+BAA+B,CAAC,QAAsB;IAC7D,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IACrD,MAAM,UAAU,GAAG,WAAW,CAAC,aAAa,CAAC,CAAA;IAE7C,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,CAAC,CAAA;KACT;IAED,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,QAAsB,EACtB,SAAsC;IAEtC,MAAM,UAAU,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;IAC5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACtC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,UAAU,CAAC,CAAA;IACpD,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,+BAA+B,CAAC,QAAsB;IAC7D,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,+BAA+B,CAAC,CAAA;IAEtE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,YAAY;SAC/B,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SAC9B,MAAM,CAAC,OAAO,CAAC,CAAA;IAElB,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE;QACnB,OAAM;KACP;IAED,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;AACtB,CAAC;AAED,SAAS,MAAM,CAAC,QAAsB,EAAE,IAAY;IAClD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5B,IAAI,MAAM,EAAE,MAAM,KAAK,CAAC,EAAE;QACxB,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;KACvB;IAED,OAAO,EAAE,CAAA;AACX,CAAC;AAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE;IACtB,MAAM,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAA;IAC/D,IAAI,QAAsB,CAAA;IAE1B,UAAU,CAAC,GAAG,EAAE;QACd,QAAQ,GAAG;YACT,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,GAAG;YACX,OAAO,EAAE,EAAE;SACZ,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,IAAI,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC9D,QAAQ;YACR,QAAQ,CAAC,OAAO,GAAG;gBACjB,aAAa,EAAE,CAAC,KAAK,CAAC;aACvB,CAAA;YAED,OAAO;YACP,MAAM,eAAe,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;YAEjE,OAAO;YACP,MAAM,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YACpE,QAAQ;YACR,QAAQ,CAAC,OAAO,GAAG;gBACjB,aAAa,EAAE,EAAE;aAClB,CAAA;YAED,OAAO;YACP,MAAM,eAAe,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;YAEjE,OAAO;YACP,MAAM,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC9D,QAAQ;YACR,QAAQ,CAAC,OAAO,GAAG;gBACjB,aAAa,EAAE,CAAC,SAAS,CAAC;aAC3B,CAAA;YAED,OAAO;YACP,MAAM,eAAe,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;YAEjE,OAAO;YACP,MAAM,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC9D,QAAQ;YACR,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAA;YAErB,OAAO;YACP,MAAM,eAAe,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;YAEjE,OAAO;YACP,MAAM,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,IAAI,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YAC1E,QAAQ;YACR,QAAQ,CAAC,OAAO,GAAG;gBACjB,+BAA+B,EAAE,CAAC,OAAO,CAAC;aAC3C,CAAA;YAED,OAAO;YACP,MAAM,SAAS,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;YAC3D,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,SAAU,CAAA;YAEhC,OAAO;YACP,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACrB,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC5E,QAAQ;YACR,QAAQ,CAAC,OAAO,GAAG;gBACjB,+BAA+B,EAAE,CAAC,SAAS,CAAC;aAC7C,CAAA;YAED,OAAO;YACP,MAAM,SAAS,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;YAE3D,OAAO;YACP,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;YAC9F,QAAQ;YACR,QAAQ,CAAC,OAAO,GAAG;gBACjB,+BAA+B,EAAE,CAAC,KAAK,CAAC;aACzC,CAAA;YAED,OAAO;YACP,MAAM,SAAS,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAA;YAE3D,OAAO;YACP,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAA;QACnC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;CACH","sourcesContent":["import {RestResponse} from './admin.js'\nimport {tryParseInt} from '@shopify/cli-kit/common/string'\n\nconst MAX_NUMBER_OF_PARALLEL_REQUESTS = 5\nconst MARGIN_TO_RATE_LIMIT = 5\n\nconst DELAY_FOR_TOO_MANY_PARALLEL_REQUESTS = 1000\nconst DELAY_FOR_TOO_CLOSE_TO_API_LIMIT = 4000\n\nconst THEME_CONTEXT = 'theme'\n\n/**\n * Throttles a provided action, limiting the number of globally parallel requests, or by the last seen API limit\n * headers.\n *\n * @param request - A function performing a request.\n * @returns - The result of the request, once it eventually runs.\n */\nexport async function throttle<T>(request: () => T): Promise<T> {\n  return new Promise<T>((resolve, _reject) => {\n    const performRequest = () => {\n      throttlingState(THEME_CONTEXT).requestCounter += 1\n      resolve(request())\n    }\n\n    /**\n     * Performs the request taking into account the\n     * limit of parallel requests only when the API limit has not\n     * been reached.\n     *\n     * Otherwise, performs the request to get the updated API limit\n     * headers, so throttler parameters get updates.\n     */\n    const throttleByHeader = () => {\n      if (isReachingApiLimit()) {\n        setTimeout(() => throttleByParallelCounter(performRequest), DELAY_FOR_TOO_CLOSE_TO_API_LIMIT)\n      } else {\n        throttleByParallelCounter(performRequest)\n      }\n    }\n\n    /**\n     * Performs the command only when the the limit\n     * of parallel request has not been reached.\n     *\n     * Otherwise, defers the execution to the throttle by rate-limit function,\n     * still respecting the limit of parallel requests.\n     *\n     * @param command - The action to execute.\n     */\n    const throttleByParallelCounter = (command: () => void) => {\n      if (hasTooManyRequests()) {\n        setTimeout(() => throttleByParallelCounter(throttleByHeader), DELAY_FOR_TOO_MANY_PARALLEL_REQUESTS)\n      } else {\n        command()\n      }\n    }\n\n    /**\n     * Start throttling by counter to get the API limit headers.\n     */\n    throttleByParallelCounter(throttleByHeader)\n  }).finally(() => {\n    throttlingState(THEME_CONTEXT).requestCounter -= 1\n  })\n}\n\n/**\n * Keep track of the latest API call limit data from a response.\n *\n * @param response - The response object.\n */\nexport function updateApiCallLimitFromResponse(response: RestResponse): void {\n  const callLimit = extractApiCallLimitFromResponse(response)\n\n  if (!callLimit) {\n    return\n  }\n\n  const [used, limit] = callLimit\n\n  latestRequestInfo().apiCallLimit = {used, limit}\n}\n\nfunction hasTooManyRequests() {\n  return throttlingState(THEME_CONTEXT).requestCounter > MAX_NUMBER_OF_PARALLEL_REQUESTS\n}\n\nfunction isReachingApiLimit() {\n  const {used, limit} = latestRequestInfo().apiCallLimit\n  return used >= limit - MARGIN_TO_RATE_LIMIT\n}\n\nfunction latestRequestInfo() {\n  return throttlingState(THEME_CONTEXT).latestRequestInfo\n}\n\n/**\n * Even considering the Stateless modules convention,\n * tracking information about the latest request is\n * critical to optimize the request throttler efficiently.\n *\n * Thus, in this case, this module deliberately avoids\n * IO cost and uses the `_throttlingState` instance for\n * that purpose.\n *\n * A context option is used if multiple APIs are using these capabilities.\n *\n * @param context - The context which we're tracking throttle state within.\n */\nfunction throttlingState(context: string): ThrottlingState {\n  const stateForContext = _throttlingState[context]\n  if (stateForContext === undefined) {\n    const startingState = {\n      requestCounter: 0,\n      latestRequestInfo: {\n        apiCallLimit: {used: 0, limit: 40},\n      },\n    }\n    _throttlingState[context] = startingState\n    return startingState\n  } else {\n    return stateForContext\n  }\n}\n\ninterface ThrottlingState {\n  /**\n   * Number of parallel requests.\n   */\n  requestCounter: number\n\n  /**\n   * Latest request information.\n   */\n  latestRequestInfo: {\n    apiCallLimit: {used: number; limit: number}\n  }\n}\n\nconst _throttlingState: {\n  [context: string]: ThrottlingState\n} = {}\n\nfunction extractRetryDelayMsFromResponse(response: RestResponse): number {\n  const retryAfterStr = header(response, 'retry-after')\n  const retryAfter = tryParseInt(retryAfterStr)\n\n  if (!retryAfter) {\n    return 0\n  }\n\n  return retryAfter\n}\n\n/**\n * Retries an operation after a delay specified in the response headers.\n *\n * @param response - The response object.\n * @param operation - The operation to retry.\n * @returns - The response of the operation.\n */\nexport async function delayAwareRetry(\n  response: RestResponse,\n  operation: () => Promise<RestResponse>,\n): Promise<RestResponse> {\n  const retryDelay = extractRetryDelayMsFromResponse(response)\n  return new Promise((resolve, _reject) => {\n    setTimeout(() => resolve(operation()), retryDelay)\n  })\n}\n\nfunction extractApiCallLimitFromResponse(response: RestResponse): [number, number] | undefined {\n  const apiCallLimit = header(response, 'x-shopify-shop-api-call-limit')\n\n  const [used, limit] = apiCallLimit\n    .split('/')\n    .map((num) => tryParseInt(num))\n    .filter(Boolean)\n\n  if (!used || !limit) {\n    return\n  }\n\n  return [used, limit]\n}\n\nfunction header(response: RestResponse, name: string): string {\n  const headers = response.headers\n  const header = headers[name]\n\n  if (header?.length === 1) {\n    return header[0] ?? ''\n  }\n\n  return ''\n}\n\nif (import.meta.vitest) {\n  const {describe, test, expect, beforeEach} = import.meta.vitest\n  let response: RestResponse\n\n  beforeEach(() => {\n    response = {\n      json: {},\n      status: 200,\n      headers: {},\n    }\n  })\n\n  describe('retryAfter', () => {\n    test('when the \"retry-after\" header value is valid', async () => {\n      // Given\n      response.headers = {\n        'retry-after': ['2.0'],\n      }\n\n      // When\n      const retryAfterDelay = extractRetryDelayMsFromResponse(response)\n\n      // Then\n      expect(retryAfterDelay).toBe(2)\n    })\n\n    test('when the \"retry-after\" header value is not present', async () => {\n      // Given\n      response.headers = {\n        'retry-after': [],\n      }\n\n      // When\n      const retryAfterDelay = extractRetryDelayMsFromResponse(response)\n\n      // Then\n      expect(retryAfterDelay).toBe(0)\n    })\n\n    test('when the \"retry-after\" header value is valid', async () => {\n      // Given\n      response.headers = {\n        'retry-after': ['invalid'],\n      }\n\n      // When\n      const retryAfterDelay = extractRetryDelayMsFromResponse(response)\n\n      // Then\n      expect(retryAfterDelay).toBe(0)\n    })\n\n    test('when the \"retry-after\" header is not present', async () => {\n      // Given\n      response.headers = {}\n\n      // When\n      const retryAfterDelay = extractRetryDelayMsFromResponse(response)\n\n      // Then\n      expect(retryAfterDelay).toBe(0)\n    })\n  })\n\n  describe('apiCallLimit', () => {\n    test('when the \"x-shopify-shop-api-call-limit\" header is valid', async () => {\n      // Given\n      response.headers = {\n        'x-shopify-shop-api-call-limit': ['10/40'],\n      }\n\n      // When\n      const callLimit = extractApiCallLimitFromResponse(response)\n      const [used, limit] = callLimit!\n\n      // Then\n      expect(used).toBe(10)\n      expect(limit).toBe(40)\n    })\n\n    test('when the \"x-shopify-shop-api-call-limit\" header is invalid', async () => {\n      // Given\n      response.headers = {\n        'x-shopify-shop-api-call-limit': ['foo/bar'],\n      }\n\n      // When\n      const callLimit = extractApiCallLimitFromResponse(response)\n\n      // Then\n      expect(callLimit).toBeUndefined()\n    })\n\n    test('when the \"x-shopify-shop-api-call-limit\" header is not formatted as expected', async () => {\n      // Given\n      response.headers = {\n        'x-shopify-shop-api-call-limit': ['/10'],\n      }\n\n      // When\n      const callLimit = extractApiCallLimitFromResponse(response)\n\n      // Then\n      expect(callLimit).toBeUndefined()\n    })\n  })\n}\n"]}

package/dist/public/node/fs.d.ts

@@ -19,6 +19,11 @@ export declare function stripUpPath(path: string, strip: number): string;
  * @param callback - The callback that receives the temporary directory.
  */
 export declare function inTemporaryDirectory<T>(callback: (tmpDir: string) => T | Promise<T>): Promise<T>;
+/**
+ * Return a temporary directory
+ * @returns - The path to the temporary directory.
+ */
+export declare function tempDirectory(): string;
 /**
  * It reads a file and returns its content as a string using the
  * utf-8 encoding.

package/dist/public/node/fs.js

@@ -5,7 +5,7 @@ import { copy as fsCopy, ensureFile as fsEnsureFile, ensureFileSync as fsEnsureF
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
  } from 'fs-extra/esm';
-import { temporaryDirectoryTask } from 'tempy';
+import { temporaryDirectory, temporaryDirectoryTask } from 'tempy';
 import { sep, join } from 'pathe';
 import { findUp as internalFindUp } from 'find-up';
 import { minimatch } from 'minimatch';
@@ -32,6 +32,13 @@ export function stripUpPath(path, strip) {
 export async function inTemporaryDirectory(callback) {
     return temporaryDirectoryTask(callback);
 }
+/**
+ * Return a temporary directory
+ * @returns - The path to the temporary directory.
+ */
+export function tempDirectory() {
+    return temporaryDirectory();
+}
 /**
  * It reads a file and returns its content as a string.
  * Uses utf-8 encoding by default.