@shopify/cli-kit 3.83.2 → 3.84.0

package/README.md

@@ -41,7 +41,7 @@ To work with themes, the CLI needs to be installed globally with:
 
 You can also use do it through Homebrew on macOS: `brew tap shopify/shopify && brew install shopify-cli`
 
-Learn more in the docs: [Shopify CLI for themes](https://shopify.dev/docs/themes/tools/cli)
+Learn more in the docs: [Shopify CLI for themes](https://shopify.dev/docs/storefronts/themes/tools/cli)
 
 <p>&nbsp;</p>
 

package/dist/private/node/api.js

@@ -22,18 +22,21 @@ function isARetryableNetworkError(error) {
     if (error instanceof Error) {
         const networkErrorMessages = [
             'socket hang up',
-            'ECONNRESET',
-            'ECONNABORTED',
-            'ENOTFOUND',
-            'ENETUNREACH',
-            'network socket disonnected',
-            'ETIMEDOUT',
-            'ECONNREFUSED',
-            'EAI_FAIL',
-            'The operation was aborted.',
+            'econnreset',
+            'econnaborted',
+            'enotfound',
+            'enetunreach',
+            'network socket disconnected',
+            'etimedout',
+            'econnrefused',
+            'eai_again',
+            'epipe',
+            'the operation was aborted',
         ];
-        const anyMatches = networkErrorMessages.some((issueMessage) => error.message.includes(issueMessage));
-        return anyMatches;
+        const errorMessage = error.message.toLowerCase();
+        const anyMatches = networkErrorMessages.some((issueMessage) => errorMessage.includes(issueMessage));
+        const missingReason = /^request to .* failed, reason:\s*$/.test(errorMessage);
+        return anyMatches || missingReason;
     }
     return false;
 }

package/dist/private/node/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/private/node/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,sBAAsB,EAAC,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAA;AACzC,OAAO,EAAC,qBAAqB,EAAC,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAC,WAAW,EAAC,MAAM,6BAA6B,CAAA;AAEvD,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAA;AAItC,MAAM,CAAC,MAAM,OAAO,GAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,mBAAmB,EAAE,gBAAgB,CAAC,CAAA;AAEjH,MAAM,sBAAsB,GAAG,IAAI,CAAA;AACnC,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAgB9B,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAC;IACzC,eAAe;IACf,cAAc;IACd,MAAM;IACN,cAAc;IACd,eAAe;IACf,aAAa;CACd,CAAC,CAAA;AAEF,SAAS,2BAA2B,CAAC,MAAc;IACjD,OAAO,0BAA0B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AAC/C,CAAC;AA8BD,SAAS,wBAAwB,CAAC,KAAc;IAC9C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,oBAAoB,GAAG;YAC3B,gBAAgB;YAChB,YAAY;YACZ,cAAc;YACd,WAAW;YACX,aAAa;YACb,4BAA4B;YAC5B,WAAW;YACX,cAAc;YACd,UAAU;YACV,4BAA4B;SAC7B,CAAA;QACD,MAAM,UAAU,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAA;QACpG,OAAO,UAAU,CAAA;IACnB,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,KAAK,UAAU,+BAA+B,CAC5C,cAAiC;IAEjC,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;QACzC,OAAO,cAAc,CAAC,OAAO,EAAE,CAAA;IACjC,CAAC;IAED,IAAI,aAAsB,CAAA;IAE1B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,qBAAqB,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,CAAC;QAClF,IAAI,CAAC;YACH,OAAO,MAAM,cAAc,CAAC,OAAO,EAAE,CAAA;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,aAAa,GAAG,GAAG,CAAA;YACnB,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,GAAG,CAAA;YACX,CAAC;YACD,WAAW,CAAC,uBAAuB,cAAc,CAAC,GAAG,yBAAyB,GAAG,EAAE,CAAC,CAAA;QACtF,CAAC;IACH,CAAC;IACD,MAAM,aAAa,CAAA;AACrB,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,cAAiC;IAEjC,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;IAC5B,IAAI,QAAQ,GAAG,CAAC,CAAA;IAChB,MAAM,eAAe,GAA4B,EAAE,CAAA;IACnD,MAAM,YAAY,GAAG,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;IACpD,IAAI,QAAQ,GAAM,EAAO,CAAA;IACzB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,+BAA+B,CAAC,cAAc,CAAC,CAAA;QAChE,8DAA8D;QAC9D,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,GAAQ,EAAE,EAAE;YAChD,IAAI,2BAA2B,CAAC,GAAG,CAAC;gBAAE,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QACpE,CAAC,CAAC,CAAA;QACF,qDAAqD;IACvD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;QAC5B,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;QAE9B,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;YAC/B,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACzB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAqC,EAAE,CAAC;oBAC9E,IAAI,2BAA2B,CAAC,GAAG,CAAC;wBAAE,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;gBACpE,CAAC;YACH,CAAC;YACD,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,eAAe,CAAC,CAAA;YAEhE,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,IAAI,OAA2B,CAAA;gBAE/B,IAAI,CAAC;oBACH,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;oBAC1G,qDAAqD;gBACvD,CAAC;gBAAC,MAAM,CAAC;oBACP,iDAAiD;gBACnD,CAAC;gBACD,OAAO;oBACL,MAAM,EAAE,WAAW;oBACnB,WAAW,EAAE,GAAG;oBAChB,QAAQ;oBACR,gBAAgB;oBAChB,YAAY;oBACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;oBAC1C,OAAO;iBACR,CAAA;YACH,CAAC;iBAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvC,OAAO;oBACL,MAAM,EAAE,cAAc;oBACtB,WAAW,EAAE,GAAG;oBAChB,QAAQ;oBACR,gBAAgB;oBAChB,YAAY;oBACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;oBAC1C,OAAO,EAAE,GAAG;iBACb,CAAA;YACH,CAAC;YAED,OAAO;gBACL,MAAM,EAAE,cAAc;gBACtB,WAAW,EAAE,GAAG;gBAChB,QAAQ;gBACR,gBAAgB;gBAChB,YAAY;gBACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;aAC3C,CAAA;QACH,CAAC;QACD,OAAO;YACL,MAAM,EAAE,eAAe;YACvB,KAAK,EAAE,GAAG;YACV,QAAQ;YACR,gBAAgB,EAAE,sBAAsB,CAAC,eAAe,CAAC;YACzD,YAAY;YACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;SAC3C,CAAA;IACH,CAAC;IACD,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;IAC5B,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;IAC9B,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,QAAQ;QACR,QAAQ;QACR,gBAAgB,EAAE,sBAAsB,CAAC,eAAe,CAAC;QACzD,YAAY;QACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;KAC3C,CAAA;AACH,CAAC;AAED,SAAS,sBAAsB,CAAC,KAAkB;IAChD,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,oEAAoE;IACpE,oEAAoE;IACpE,IAAI,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,CAAA;AAC1F,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,cAAiC,EACjC,YAAyE;IAEzE,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,cAAc,CAAC,CAAA;IAEvD,WAAW,CAAC,cAAc,MAAM,CAAC,YAAY,iBAAiB,MAAM,CAAC,QAAQ;;EAE7E,MAAM,CAAC,gBAAgB;KACpB,CAAC,CAAA;IAEJ,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,MAAM,CAAC,QAAQ,CAAA;QACxB,CAAC;QACD,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,KAAK,CAAA;YACpB,CAAC;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;QACD,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,cAAiC,EACjC,YAAyE,EACzE,eAII;IACF,aAAa,EAAE,UAAU;CAC1B;IAED,IAAI,WAAW,GAAG,CAAC,CAAA;IACnB,MAAM,cAAc,GAAG,YAAY,CAAC,cAAc,IAAI,mBAAmB,CAAA;IAEzE,IAAI,MAAM,GAAG,MAAM,kBAAkB,CAAC,cAAc,CAAC,CAAA;IAErD,WAAW,CAAC,cAAc,MAAM,CAAC,YAAY,iBAAiB,MAAM,CAAC,QAAQ;;EAE7E,MAAM,CAAC,gBAAgB;KACpB,CAAC,CAAA;IAEJ,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC3B,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;gBACpB,WAAW,CAAC,cAAc,MAAM,CAAC,YAAY,oBAAoB,WAAW,UAAU,CAAC,CAAA;YACzF,CAAC;YACD,OAAO,MAAM,CAAC,QAAQ,CAAA;QACxB,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;YAC5C,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,eAAe,EAAE,CAAC;YAC7C,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,KAAK,CAAA;YACpB,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;YAC5C,MAAM,MAAM,CAAC,WAAW,CAAA;QAC1B,CAAC;QAED,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;YAClC,WAAW,CAAC,GAAG,cAAc,qCAAqC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;YACxF,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;QACD,WAAW,IAAI,CAAC,CAAA;QAEhB,uGAAuG;QACvG,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,IAAI,YAAY,CAAC,cAAc,IAAI,sBAAsB,CAAA;QAC5F,WAAW,CAAC,6BAA6B,WAAW,OAAO,MAAM,CAAC,YAAY,OAAO,YAAY,KAAK,CAAC,CAAA;QAEvG,4CAA4C;QAC5C,MAAM,GAAG,MAAM,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;YACzD,YAAY,CAAC,aAAa,CAAC,GAAG,EAAE;gBAC9B,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAA;YAC7C,CAAC,EAAE,YAAY,CAAC,CAAA;QAClB,CAAC,CAAC,CAAA;IACJ,CAAC;AACH,CAAC","sourcesContent":["import {sanitizedHeadersOutput} from './api/headers.js'\nimport {sanitizeURL} from './api/urls.js'\nimport {sleepWithBackoffUntil} from './sleep-with-backoff.js'\nimport {outputDebug} from '../../public/node/output.js'\nimport {Headers} from 'form-data'\nimport {ClientError} from 'graphql-request'\nimport {performance} from 'perf_hooks'\n\nexport type API = 'admin' | 'storefront-renderer' | 'partners' | 'business-platform' | 'app-management'\n\nexport const allAPIs: API[] = ['admin', 'storefront-renderer', 'partners', 'business-platform', 'app-management']\n\nconst DEFAULT_RETRY_DELAY_MS = 1000\nconst DEFAULT_RETRY_LIMIT = 10\n\nexport type NetworkRetryBehaviour =\n  | {\n      useNetworkLevelRetry: true\n      maxRetryTimeMs: number\n    }\n  | {\n      useNetworkLevelRetry: false\n    }\n\ntype RequestOptions<T> = {\n  request: () => Promise<T>\n  url: string\n} & NetworkRetryBehaviour\n\nconst interestingResponseHeaders = new Set([\n  'cache-control',\n  'content-type',\n  'etag',\n  'x-request-id',\n  'server-timing',\n  'retry-after',\n])\n\nfunction responseHeaderIsInteresting(header: string): boolean {\n  return interestingResponseHeaders.has(header)\n}\n\ninterface CommonResponse {\n  duration: number\n  sanitizedHeaders: string\n  sanitizedUrl: string\n  requestId?: string\n}\n\ntype OkResponse<T> = CommonResponse & {status: 'ok'; response: T}\ntype ClientErrorResponse = CommonResponse & {status: 'client-error'; clientError: ClientError}\ntype UnknownErrorResponse = CommonResponse & {status: 'unknown-error'; error: unknown}\ntype CanRetryErrorResponse = CommonResponse & {\n  status: 'can-retry'\n  clientError: ClientError\n  delayMs: number | undefined\n}\ntype UnauthorizedErrorResponse = CommonResponse & {\n  status: 'unauthorized'\n  clientError: ClientError\n  delayMs: number | undefined\n}\n\ntype VerboseResponse<T> =\n  | OkResponse<T>\n  | ClientErrorResponse\n  | UnknownErrorResponse\n  | CanRetryErrorResponse\n  | UnauthorizedErrorResponse\n\nfunction isARetryableNetworkError(error: unknown): boolean {\n  if (error instanceof Error) {\n    const networkErrorMessages = [\n      'socket hang up',\n      'ECONNRESET',\n      'ECONNABORTED',\n      'ENOTFOUND',\n      'ENETUNREACH',\n      'network socket disonnected',\n      'ETIMEDOUT',\n      'ECONNREFUSED',\n      'EAI_FAIL',\n      'The operation was aborted.',\n    ]\n    const anyMatches = networkErrorMessages.some((issueMessage) => error.message.includes(issueMessage))\n    return anyMatches\n  }\n  return false\n}\n\nasync function runRequestWithNetworkLevelRetry<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n): Promise<T> {\n  if (!requestOptions.useNetworkLevelRetry) {\n    return requestOptions.request()\n  }\n\n  let lastSeenError: unknown\n\n  for await (const _delayMs of sleepWithBackoffUntil(requestOptions.maxRetryTimeMs)) {\n    try {\n      return await requestOptions.request()\n    } catch (err) {\n      lastSeenError = err\n      if (!isARetryableNetworkError(err)) {\n        throw err\n      }\n      outputDebug(`Retrying request to ${requestOptions.url} due to network error ${err}`)\n    }\n  }\n  throw lastSeenError\n}\n\nasync function makeVerboseRequest<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n): Promise<VerboseResponse<T>> {\n  const t0 = performance.now()\n  let duration = 0\n  const responseHeaders: {[key: string]: string} = {}\n  const sanitizedUrl = sanitizeURL(requestOptions.url)\n  let response: T = {} as T\n  try {\n    response = await runRequestWithNetworkLevelRetry(requestOptions)\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    response.headers.forEach((value: any, key: any) => {\n      if (responseHeaderIsInteresting(key)) responseHeaders[key] = value\n    })\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (err) {\n    const t1 = performance.now()\n    duration = Math.round(t1 - t0)\n\n    if (err instanceof ClientError) {\n      if (err.response.headers) {\n        for (const [key, value] of err.response.headers as Iterable<[string, string]>) {\n          if (responseHeaderIsInteresting(key)) responseHeaders[key] = value\n        }\n      }\n      const sanitizedHeaders = sanitizedHeadersOutput(responseHeaders)\n\n      if (errorsIncludeStatus429(err)) {\n        let delayMs: number | undefined\n\n        try {\n          delayMs = responseHeaders['retry-after'] ? Number.parseInt(responseHeaders['retry-after'], 10) : undefined\n          // eslint-disable-next-line no-catch-all/no-catch-all\n        } catch {\n          // ignore errors in extracting retry-after header\n        }\n        return {\n          status: 'can-retry',\n          clientError: err,\n          duration,\n          sanitizedHeaders,\n          sanitizedUrl,\n          requestId: responseHeaders['x-request-id'],\n          delayMs,\n        }\n      } else if (err.response.status === 401) {\n        return {\n          status: 'unauthorized',\n          clientError: err,\n          duration,\n          sanitizedHeaders,\n          sanitizedUrl,\n          requestId: responseHeaders['x-request-id'],\n          delayMs: 500,\n        }\n      }\n\n      return {\n        status: 'client-error',\n        clientError: err,\n        duration,\n        sanitizedHeaders,\n        sanitizedUrl,\n        requestId: responseHeaders['x-request-id'],\n      }\n    }\n    return {\n      status: 'unknown-error',\n      error: err,\n      duration,\n      sanitizedHeaders: sanitizedHeadersOutput(responseHeaders),\n      sanitizedUrl,\n      requestId: responseHeaders['x-request-id'],\n    }\n  }\n  const t1 = performance.now()\n  duration = Math.round(t1 - t0)\n  return {\n    status: 'ok',\n    response,\n    duration,\n    sanitizedHeaders: sanitizedHeadersOutput(responseHeaders),\n    sanitizedUrl,\n    requestId: responseHeaders['x-request-id'],\n  }\n}\n\nfunction errorsIncludeStatus429(error: ClientError): boolean {\n  if (error.response.status === 429) {\n    return true\n  }\n\n  // GraphQL returns a 401 with a string error message when auth fails\n  // Therefore error.response.errors can be a string or GraphQLError[]\n  if (typeof error.response.errors === 'string') {\n    return false\n  }\n  return error.response.errors?.some((error) => error.extensions?.code === '429') ?? false\n}\n\nexport async function simpleRequestWithDebugLog<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n  errorHandler?: (error: unknown, requestId: string | undefined) => unknown,\n): Promise<T> {\n  const result = await makeVerboseRequest(requestOptions)\n\n  outputDebug(`Request to ${result.sanitizedUrl} completed in ${result.duration} ms\nWith response headers:\n${result.sanitizedHeaders}\n    `)\n\n  switch (result.status) {\n    case 'ok': {\n      return result.response\n    }\n    case 'client-error': {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n    case 'unknown-error': {\n      if (errorHandler) {\n        throw errorHandler(result.error, result.requestId)\n      } else {\n        throw result.error\n      }\n    }\n    case 'can-retry': {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n    case 'unauthorized': {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n  }\n}\n\n/**\n * Makes a HTTP request to some API, retrying if response headers indicate a retryable error.\n *\n * If a request fails with a 429, the retry-after header determines a delay before an automatic retry is performed.\n *\n * If unauthorizedHandler is provided, then it will be called in the case of a 401 and a retry performed. This allows\n * for a token refresh for instance.\n *\n * If there's a network error, e.g. DNS fails to resolve, then API calls are automatically retried.\n *\n * @param request - A function that returns a promise of the response\n * @param url - The URL to request\n * @param errorHandler - A function that handles errors\n * @param unauthorizedHandler - A function that handles unauthorized errors\n * @param retryOptions - Options for the retry\n * @returns The response from the request\n */\nexport async function retryAwareRequest<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n  errorHandler?: (error: unknown, requestId: string | undefined) => unknown,\n  retryOptions: {\n    limitRetriesTo?: number\n    defaultDelayMs?: number\n    scheduleDelay: (fn: () => void, delay: number) => void\n  } = {\n    scheduleDelay: setTimeout,\n  },\n): Promise<T> {\n  let retriesUsed = 0\n  const limitRetriesTo = retryOptions.limitRetriesTo ?? DEFAULT_RETRY_LIMIT\n\n  let result = await makeVerboseRequest(requestOptions)\n\n  outputDebug(`Request to ${result.sanitizedUrl} completed in ${result.duration} ms\nWith response headers:\n${result.sanitizedHeaders}\n    `)\n\n  while (true) {\n    if (result.status === 'ok') {\n      if (retriesUsed > 0) {\n        outputDebug(`Request to ${result.sanitizedUrl} succeeded after ${retriesUsed} retries`)\n      }\n      return result.response\n    } else if (result.status === 'client-error') {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    } else if (result.status === 'unknown-error') {\n      if (errorHandler) {\n        throw errorHandler(result.error, result.requestId)\n      } else {\n        throw result.error\n      }\n    } else if (result.status === 'unauthorized') {\n      throw result.clientError\n    }\n\n    if (limitRetriesTo <= retriesUsed) {\n      outputDebug(`${limitRetriesTo} retries exhausted for request to ${result.sanitizedUrl}`)\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n    retriesUsed += 1\n\n    // prefer to wait based on a header if given; the caller's preference if not; and a default if neither.\n    const retryDelayMs = result.delayMs ?? retryOptions.defaultDelayMs ?? DEFAULT_RETRY_DELAY_MS\n    outputDebug(`Scheduling retry request #${retriesUsed} to ${result.sanitizedUrl} in ${retryDelayMs} ms`)\n\n    // eslint-disable-next-line no-await-in-loop\n    result = await new Promise<VerboseResponse<T>>((resolve) => {\n      retryOptions.scheduleDelay(() => {\n        resolve(makeVerboseRequest(requestOptions))\n      }, retryDelayMs)\n    })\n  }\n}\n"]}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/private/node/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,sBAAsB,EAAC,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAA;AACzC,OAAO,EAAC,qBAAqB,EAAC,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAC,WAAW,EAAC,MAAM,6BAA6B,CAAA;AAEvD,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAA;AAItC,MAAM,CAAC,MAAM,OAAO,GAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,mBAAmB,EAAE,gBAAgB,CAAC,CAAA;AAEjH,MAAM,sBAAsB,GAAG,IAAI,CAAA;AACnC,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAgB9B,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAC;IACzC,eAAe;IACf,cAAc;IACd,MAAM;IACN,cAAc;IACd,eAAe;IACf,aAAa;CACd,CAAC,CAAA;AAEF,SAAS,2BAA2B,CAAC,MAAc;IACjD,OAAO,0BAA0B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AAC/C,CAAC;AA8BD,SAAS,wBAAwB,CAAC,KAAc;IAC9C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,oBAAoB,GAAG;YAC3B,gBAAgB;YAChB,YAAY;YACZ,cAAc;YACd,WAAW;YACX,aAAa;YACb,6BAA6B;YAC7B,WAAW;YACX,cAAc;YACd,WAAW;YACX,OAAO;YACP,2BAA2B;SAC5B,CAAA;QACD,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;QAChD,MAAM,UAAU,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAA;QACnG,MAAM,aAAa,GAAG,oCAAoC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAC7E,OAAO,UAAU,IAAI,aAAa,CAAA;IACpC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,KAAK,UAAU,+BAA+B,CAC5C,cAAiC;IAEjC,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;QACzC,OAAO,cAAc,CAAC,OAAO,EAAE,CAAA;IACjC,CAAC;IAED,IAAI,aAAsB,CAAA;IAE1B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,qBAAqB,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,CAAC;QAClF,IAAI,CAAC;YACH,OAAO,MAAM,cAAc,CAAC,OAAO,EAAE,CAAA;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,aAAa,GAAG,GAAG,CAAA;YACnB,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,GAAG,CAAA;YACX,CAAC;YACD,WAAW,CAAC,uBAAuB,cAAc,CAAC,GAAG,yBAAyB,GAAG,EAAE,CAAC,CAAA;QACtF,CAAC;IACH,CAAC;IACD,MAAM,aAAa,CAAA;AACrB,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,cAAiC;IAEjC,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;IAC5B,IAAI,QAAQ,GAAG,CAAC,CAAA;IAChB,MAAM,eAAe,GAA4B,EAAE,CAAA;IACnD,MAAM,YAAY,GAAG,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;IACpD,IAAI,QAAQ,GAAM,EAAO,CAAA;IACzB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,+BAA+B,CAAC,cAAc,CAAC,CAAA;QAChE,8DAA8D;QAC9D,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,GAAQ,EAAE,EAAE;YAChD,IAAI,2BAA2B,CAAC,GAAG,CAAC;gBAAE,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QACpE,CAAC,CAAC,CAAA;QACF,qDAAqD;IACvD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;QAC5B,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;QAE9B,IAAI,GAAG,YAAY,WAAW,EAAE,CAAC;YAC/B,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACzB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAqC,EAAE,CAAC;oBAC9E,IAAI,2BAA2B,CAAC,GAAG,CAAC;wBAAE,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;gBACpE,CAAC;YACH,CAAC;YACD,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,eAAe,CAAC,CAAA;YAEhE,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,IAAI,OAA2B,CAAA;gBAE/B,IAAI,CAAC;oBACH,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;oBAC1G,qDAAqD;gBACvD,CAAC;gBAAC,MAAM,CAAC;oBACP,iDAAiD;gBACnD,CAAC;gBACD,OAAO;oBACL,MAAM,EAAE,WAAW;oBACnB,WAAW,EAAE,GAAG;oBAChB,QAAQ;oBACR,gBAAgB;oBAChB,YAAY;oBACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;oBAC1C,OAAO;iBACR,CAAA;YACH,CAAC;iBAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvC,OAAO;oBACL,MAAM,EAAE,cAAc;oBACtB,WAAW,EAAE,GAAG;oBAChB,QAAQ;oBACR,gBAAgB;oBAChB,YAAY;oBACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;oBAC1C,OAAO,EAAE,GAAG;iBACb,CAAA;YACH,CAAC;YAED,OAAO;gBACL,MAAM,EAAE,cAAc;gBACtB,WAAW,EAAE,GAAG;gBAChB,QAAQ;gBACR,gBAAgB;gBAChB,YAAY;gBACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;aAC3C,CAAA;QACH,CAAC;QACD,OAAO;YACL,MAAM,EAAE,eAAe;YACvB,KAAK,EAAE,GAAG;YACV,QAAQ;YACR,gBAAgB,EAAE,sBAAsB,CAAC,eAAe,CAAC;YACzD,YAAY;YACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;SAC3C,CAAA;IACH,CAAC;IACD,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;IAC5B,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;IAC9B,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,QAAQ;QACR,QAAQ;QACR,gBAAgB,EAAE,sBAAsB,CAAC,eAAe,CAAC;QACzD,YAAY;QACZ,SAAS,EAAE,eAAe,CAAC,cAAc,CAAC;KAC3C,CAAA;AACH,CAAC;AAED,SAAS,sBAAsB,CAAC,KAAkB;IAChD,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,oEAAoE;IACpE,oEAAoE;IACpE,IAAI,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,CAAA;AAC1F,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,cAAiC,EACjC,YAAyE;IAEzE,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,cAAc,CAAC,CAAA;IAEvD,WAAW,CAAC,cAAc,MAAM,CAAC,YAAY,iBAAiB,MAAM,CAAC,QAAQ;;EAE7E,MAAM,CAAC,gBAAgB;KACpB,CAAC,CAAA;IAEJ,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,MAAM,CAAC,QAAQ,CAAA;QACxB,CAAC;QACD,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,KAAK,CAAA;YACpB,CAAC;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;QACD,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,cAAiC,EACjC,YAAyE,EACzE,eAII;IACF,aAAa,EAAE,UAAU;CAC1B;IAED,IAAI,WAAW,GAAG,CAAC,CAAA;IACnB,MAAM,cAAc,GAAG,YAAY,CAAC,cAAc,IAAI,mBAAmB,CAAA;IAEzE,IAAI,MAAM,GAAG,MAAM,kBAAkB,CAAC,cAAc,CAAC,CAAA;IAErD,WAAW,CAAC,cAAc,MAAM,CAAC,YAAY,iBAAiB,MAAM,CAAC,QAAQ;;EAE7E,MAAM,CAAC,gBAAgB;KACpB,CAAC,CAAA;IAEJ,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC3B,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;gBACpB,WAAW,CAAC,cAAc,MAAM,CAAC,YAAY,oBAAoB,WAAW,UAAU,CAAC,CAAA;YACzF,CAAC;YACD,OAAO,MAAM,CAAC,QAAQ,CAAA;QACxB,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;YAC5C,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,eAAe,EAAE,CAAC;YAC7C,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,KAAK,CAAA;YACpB,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;YAC5C,MAAM,MAAM,CAAC,WAAW,CAAA;QAC1B,CAAC;QAED,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;YAClC,WAAW,CAAC,GAAG,cAAc,qCAAqC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;YACxF,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,CAAC,WAAW,CAAA;YAC1B,CAAC;QACH,CAAC;QACD,WAAW,IAAI,CAAC,CAAA;QAEhB,uGAAuG;QACvG,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,IAAI,YAAY,CAAC,cAAc,IAAI,sBAAsB,CAAA;QAC5F,WAAW,CAAC,6BAA6B,WAAW,OAAO,MAAM,CAAC,YAAY,OAAO,YAAY,KAAK,CAAC,CAAA;QAEvG,4CAA4C;QAC5C,MAAM,GAAG,MAAM,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;YACzD,YAAY,CAAC,aAAa,CAAC,GAAG,EAAE;gBAC9B,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAA;YAC7C,CAAC,EAAE,YAAY,CAAC,CAAA;QAClB,CAAC,CAAC,CAAA;IACJ,CAAC;AACH,CAAC","sourcesContent":["import {sanitizedHeadersOutput} from './api/headers.js'\nimport {sanitizeURL} from './api/urls.js'\nimport {sleepWithBackoffUntil} from './sleep-with-backoff.js'\nimport {outputDebug} from '../../public/node/output.js'\nimport {Headers} from 'form-data'\nimport {ClientError} from 'graphql-request'\nimport {performance} from 'perf_hooks'\n\nexport type API = 'admin' | 'storefront-renderer' | 'partners' | 'business-platform' | 'app-management'\n\nexport const allAPIs: API[] = ['admin', 'storefront-renderer', 'partners', 'business-platform', 'app-management']\n\nconst DEFAULT_RETRY_DELAY_MS = 1000\nconst DEFAULT_RETRY_LIMIT = 10\n\nexport type NetworkRetryBehaviour =\n  | {\n      useNetworkLevelRetry: true\n      maxRetryTimeMs: number\n    }\n  | {\n      useNetworkLevelRetry: false\n    }\n\ntype RequestOptions<T> = {\n  request: () => Promise<T>\n  url: string\n} & NetworkRetryBehaviour\n\nconst interestingResponseHeaders = new Set([\n  'cache-control',\n  'content-type',\n  'etag',\n  'x-request-id',\n  'server-timing',\n  'retry-after',\n])\n\nfunction responseHeaderIsInteresting(header: string): boolean {\n  return interestingResponseHeaders.has(header)\n}\n\ninterface CommonResponse {\n  duration: number\n  sanitizedHeaders: string\n  sanitizedUrl: string\n  requestId?: string\n}\n\ntype OkResponse<T> = CommonResponse & {status: 'ok'; response: T}\ntype ClientErrorResponse = CommonResponse & {status: 'client-error'; clientError: ClientError}\ntype UnknownErrorResponse = CommonResponse & {status: 'unknown-error'; error: unknown}\ntype CanRetryErrorResponse = CommonResponse & {\n  status: 'can-retry'\n  clientError: ClientError\n  delayMs: number | undefined\n}\ntype UnauthorizedErrorResponse = CommonResponse & {\n  status: 'unauthorized'\n  clientError: ClientError\n  delayMs: number | undefined\n}\n\ntype VerboseResponse<T> =\n  | OkResponse<T>\n  | ClientErrorResponse\n  | UnknownErrorResponse\n  | CanRetryErrorResponse\n  | UnauthorizedErrorResponse\n\nfunction isARetryableNetworkError(error: unknown): boolean {\n  if (error instanceof Error) {\n    const networkErrorMessages = [\n      'socket hang up',\n      'econnreset',\n      'econnaborted',\n      'enotfound',\n      'enetunreach',\n      'network socket disconnected',\n      'etimedout',\n      'econnrefused',\n      'eai_again',\n      'epipe',\n      'the operation was aborted',\n    ]\n    const errorMessage = error.message.toLowerCase()\n    const anyMatches = networkErrorMessages.some((issueMessage) => errorMessage.includes(issueMessage))\n    const missingReason = /^request to .* failed, reason:\\s*$/.test(errorMessage)\n    return anyMatches || missingReason\n  }\n  return false\n}\n\nasync function runRequestWithNetworkLevelRetry<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n): Promise<T> {\n  if (!requestOptions.useNetworkLevelRetry) {\n    return requestOptions.request()\n  }\n\n  let lastSeenError: unknown\n\n  for await (const _delayMs of sleepWithBackoffUntil(requestOptions.maxRetryTimeMs)) {\n    try {\n      return await requestOptions.request()\n    } catch (err) {\n      lastSeenError = err\n      if (!isARetryableNetworkError(err)) {\n        throw err\n      }\n      outputDebug(`Retrying request to ${requestOptions.url} due to network error ${err}`)\n    }\n  }\n  throw lastSeenError\n}\n\nasync function makeVerboseRequest<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n): Promise<VerboseResponse<T>> {\n  const t0 = performance.now()\n  let duration = 0\n  const responseHeaders: {[key: string]: string} = {}\n  const sanitizedUrl = sanitizeURL(requestOptions.url)\n  let response: T = {} as T\n  try {\n    response = await runRequestWithNetworkLevelRetry(requestOptions)\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    response.headers.forEach((value: any, key: any) => {\n      if (responseHeaderIsInteresting(key)) responseHeaders[key] = value\n    })\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (err) {\n    const t1 = performance.now()\n    duration = Math.round(t1 - t0)\n\n    if (err instanceof ClientError) {\n      if (err.response.headers) {\n        for (const [key, value] of err.response.headers as Iterable<[string, string]>) {\n          if (responseHeaderIsInteresting(key)) responseHeaders[key] = value\n        }\n      }\n      const sanitizedHeaders = sanitizedHeadersOutput(responseHeaders)\n\n      if (errorsIncludeStatus429(err)) {\n        let delayMs: number | undefined\n\n        try {\n          delayMs = responseHeaders['retry-after'] ? Number.parseInt(responseHeaders['retry-after'], 10) : undefined\n          // eslint-disable-next-line no-catch-all/no-catch-all\n        } catch {\n          // ignore errors in extracting retry-after header\n        }\n        return {\n          status: 'can-retry',\n          clientError: err,\n          duration,\n          sanitizedHeaders,\n          sanitizedUrl,\n          requestId: responseHeaders['x-request-id'],\n          delayMs,\n        }\n      } else if (err.response.status === 401) {\n        return {\n          status: 'unauthorized',\n          clientError: err,\n          duration,\n          sanitizedHeaders,\n          sanitizedUrl,\n          requestId: responseHeaders['x-request-id'],\n          delayMs: 500,\n        }\n      }\n\n      return {\n        status: 'client-error',\n        clientError: err,\n        duration,\n        sanitizedHeaders,\n        sanitizedUrl,\n        requestId: responseHeaders['x-request-id'],\n      }\n    }\n    return {\n      status: 'unknown-error',\n      error: err,\n      duration,\n      sanitizedHeaders: sanitizedHeadersOutput(responseHeaders),\n      sanitizedUrl,\n      requestId: responseHeaders['x-request-id'],\n    }\n  }\n  const t1 = performance.now()\n  duration = Math.round(t1 - t0)\n  return {\n    status: 'ok',\n    response,\n    duration,\n    sanitizedHeaders: sanitizedHeadersOutput(responseHeaders),\n    sanitizedUrl,\n    requestId: responseHeaders['x-request-id'],\n  }\n}\n\nfunction errorsIncludeStatus429(error: ClientError): boolean {\n  if (error.response.status === 429) {\n    return true\n  }\n\n  // GraphQL returns a 401 with a string error message when auth fails\n  // Therefore error.response.errors can be a string or GraphQLError[]\n  if (typeof error.response.errors === 'string') {\n    return false\n  }\n  return error.response.errors?.some((error) => error.extensions?.code === '429') ?? false\n}\n\nexport async function simpleRequestWithDebugLog<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n  errorHandler?: (error: unknown, requestId: string | undefined) => unknown,\n): Promise<T> {\n  const result = await makeVerboseRequest(requestOptions)\n\n  outputDebug(`Request to ${result.sanitizedUrl} completed in ${result.duration} ms\nWith response headers:\n${result.sanitizedHeaders}\n    `)\n\n  switch (result.status) {\n    case 'ok': {\n      return result.response\n    }\n    case 'client-error': {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n    case 'unknown-error': {\n      if (errorHandler) {\n        throw errorHandler(result.error, result.requestId)\n      } else {\n        throw result.error\n      }\n    }\n    case 'can-retry': {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n    case 'unauthorized': {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n  }\n}\n\n/**\n * Makes a HTTP request to some API, retrying if response headers indicate a retryable error.\n *\n * If a request fails with a 429, the retry-after header determines a delay before an automatic retry is performed.\n *\n * If unauthorizedHandler is provided, then it will be called in the case of a 401 and a retry performed. This allows\n * for a token refresh for instance.\n *\n * If there's a network error, e.g. DNS fails to resolve, then API calls are automatically retried.\n *\n * @param request - A function that returns a promise of the response\n * @param url - The URL to request\n * @param errorHandler - A function that handles errors\n * @param unauthorizedHandler - A function that handles unauthorized errors\n * @param retryOptions - Options for the retry\n * @returns The response from the request\n */\nexport async function retryAwareRequest<T extends {headers: Headers; status: number}>(\n  requestOptions: RequestOptions<T>,\n  errorHandler?: (error: unknown, requestId: string | undefined) => unknown,\n  retryOptions: {\n    limitRetriesTo?: number\n    defaultDelayMs?: number\n    scheduleDelay: (fn: () => void, delay: number) => void\n  } = {\n    scheduleDelay: setTimeout,\n  },\n): Promise<T> {\n  let retriesUsed = 0\n  const limitRetriesTo = retryOptions.limitRetriesTo ?? DEFAULT_RETRY_LIMIT\n\n  let result = await makeVerboseRequest(requestOptions)\n\n  outputDebug(`Request to ${result.sanitizedUrl} completed in ${result.duration} ms\nWith response headers:\n${result.sanitizedHeaders}\n    `)\n\n  while (true) {\n    if (result.status === 'ok') {\n      if (retriesUsed > 0) {\n        outputDebug(`Request to ${result.sanitizedUrl} succeeded after ${retriesUsed} retries`)\n      }\n      return result.response\n    } else if (result.status === 'client-error') {\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    } else if (result.status === 'unknown-error') {\n      if (errorHandler) {\n        throw errorHandler(result.error, result.requestId)\n      } else {\n        throw result.error\n      }\n    } else if (result.status === 'unauthorized') {\n      throw result.clientError\n    }\n\n    if (limitRetriesTo <= retriesUsed) {\n      outputDebug(`${limitRetriesTo} retries exhausted for request to ${result.sanitizedUrl}`)\n      if (errorHandler) {\n        throw errorHandler(result.clientError, result.requestId)\n      } else {\n        throw result.clientError\n      }\n    }\n    retriesUsed += 1\n\n    // prefer to wait based on a header if given; the caller's preference if not; and a default if neither.\n    const retryDelayMs = result.delayMs ?? retryOptions.defaultDelayMs ?? DEFAULT_RETRY_DELAY_MS\n    outputDebug(`Scheduling retry request #${retriesUsed} to ${result.sanitizedUrl} in ${retryDelayMs} ms`)\n\n    // eslint-disable-next-line no-await-in-loop\n    result = await new Promise<VerboseResponse<T>>((resolve) => {\n      retryOptions.scheduleDelay(() => {\n        resolve(makeVerboseRequest(requestOptions))\n      }, retryDelayMs)\n    })\n  }\n}\n"]}

package/dist/public/common/version.d.ts

@@ -1 +1 @@
-export declare const CLI_KIT_VERSION = "3.83.2";
+export declare const CLI_KIT_VERSION = "3.84.0";

package/dist/public/common/version.js

@@ -1,2 +1,2 @@
-export const CLI_KIT_VERSION = '3.83.2';
+export const CLI_KIT_VERSION = '3.84.0';
 //# sourceMappingURL=version.js.map

package/dist/public/common/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/public/common/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG,QAAQ,CAAA","sourcesContent":["export const CLI_KIT_VERSION = '3.83.2'\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/public/common/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG,QAAQ,CAAA","sourcesContent":["export const CLI_KIT_VERSION = '3.84.0'\n"]}

package/dist/public/node/api/admin.d.ts

@@ -24,7 +24,7 @@ export interface AdminRequestOptions<TResult, TVariables extends Variables> {
     /** Control how API responses will be handled. */
     responseOptions?: GraphQLResponseOptions<TResult>;
     /** Custom request behaviour for retries and timeouts. */
-    requestBehaviour?: RequestModeInput;
+    preferredBehaviour?: RequestModeInput;
 }
 /**
  * Executes a GraphQL query against the Admin API. Uses typed documents.
@@ -37,9 +37,10 @@ export declare function adminRequestDoc<TResult, TVariables extends Variables>(o
  * GraphQL query to retrieve all supported API versions.
  *
  * @param session - Shopify admin session including token and Store FQDN.
+ * @param preferredBehaviour - Custom request behaviour for retries and timeouts.
  * @returns - An array of supported API versions.
  */
-export declare function supportedApiVersions(session: AdminSession): Promise<string[]>;
+export declare function supportedApiVersions(session: AdminSession, preferredBehaviour?: RequestModeInput): Promise<string[]>;
 /**
  * Returns the Admin API URL for the given store and version.
  *

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

@@ -37,10 +37,10 @@ export async function adminRequest(query, session, variables) {
  * @returns The response of the query of generic type <TResult>.
  */
 export async function adminRequestDoc(options) {
-    const { query, session, variables, version, responseOptions, requestBehaviour } = options;
+    const { query, session, variables, version, responseOptions, preferredBehaviour } = options;
     let apiVersion = version ?? LatestApiVersionByFQDN.get(session.storeFqdn);
     if (!apiVersion) {
-        apiVersion = await fetchLatestSupportedApiVersion(session);
+        apiVersion = await fetchLatestSupportedApiVersion(session, preferredBehaviour);
     }
     let storeDomain = await normalizeStoreFqdn(session.storeFqdn);
     const addedHeaders = themeAccessHeaders(session);
@@ -64,7 +64,7 @@ export async function adminRequestDoc(options) {
         variables,
         responseOptions,
         unauthorizedHandler,
-        requestBehaviour,
+        preferredBehaviour,
     });
     return result;
 }
@@ -77,10 +77,11 @@ function themeAccessHeaders(session) {
  * GraphQL query to retrieve the latest supported API version.
  *
  * @param session - Shopify admin session including token and Store FQDN.
+ * @param preferredBehaviour - Custom request behaviour for retries and timeouts.
  * @returns - The latest supported API version.
  */
-async function fetchLatestSupportedApiVersion(session) {
-    const apiVersions = await supportedApiVersions(session);
+async function fetchLatestSupportedApiVersion(session, preferredBehaviour) {
+    const apiVersions = await supportedApiVersions(session, preferredBehaviour);
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const latest = apiVersions.reverse()[0];
     LatestApiVersionByFQDN.set(session.storeFqdn, latest);
@@ -90,10 +91,11 @@ async function fetchLatestSupportedApiVersion(session) {
  * GraphQL query to retrieve all supported API versions.
  *
  * @param session - Shopify admin session including token and Store FQDN.
+ * @param preferredBehaviour - Custom request behaviour for retries and timeouts.
  * @returns - An array of supported API versions.
  */
-export async function supportedApiVersions(session) {
-    const apiVersions = await fetchApiVersions(session);
+export async function supportedApiVersions(session, preferredBehaviour) {
+    const apiVersions = await fetchApiVersions(session, preferredBehaviour);
     return apiVersions
         .filter((item) => item.supported)
         .map((item) => item.handle)
@@ -103,9 +105,10 @@ export async function supportedApiVersions(session) {
  * GraphQL query to retrieve all API versions.
  *
  * @param session - Shopify admin session including token and Store FQDN.
+ * @param preferredBehaviour - Custom request behaviour for retries and timeouts.
  * @returns - An array of supported and unsupported API versions.
  */
-async function fetchApiVersions(session) {
+async function fetchApiVersions(session, preferredBehaviour) {
     try {
         const response = await adminRequestDoc({
             query: PublicApiVersions,
@@ -113,6 +116,7 @@ async function fetchApiVersions(session) {
             variables: {},
             version: 'unstable',
             responseOptions: { handleErrors: false },
+            preferredBehaviour,
         });
         return response.publicApiVersions;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"admin.js","sourceRoot":"","sources":["../../../../src/public/node/api/admin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,iBAAiB,GAIlB,MAAM,cAAc,CAAA;AAErB,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,gCAAgC,CAAA;AACzE,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAC,MAAM,aAAa,CAAA;AAChD,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,oBAAoB,GACrB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAmB,YAAY,EAAC,MAAM,YAAY,CAAA;AACzD,OAAO,EAAC,iBAAiB,EAAC,MAAM,iEAAiE,CAAA;AACjG,OAAO,EAAC,kBAAkB,EAAC,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAA;AACvE,OAAO,EAAC,kBAAkB,EAAC,MAAM,0CAA0C,CAAA;AAC3E,OAAO,EAAC,aAAa,EAAC,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAC,WAAW,EAAY,MAAM,iBAAiB,CAAA;AAGtD,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAkB,CAAA;AAExD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAI,KAAa,EAAE,OAAqB,EAAE,SAA4B;IACtG,MAAM,GAAG,GAAG,OAAO,CAAA;IACnB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,OAAO,CAAC,CAAA;IAC7D,IAAI,WAAW,GAAG,MAAM,kBAAkB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC7D,MAAM,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAEhD,IAAI,kBAAkB,EAAE,KAAK,OAAO,EAAE,CAAC;QACrC,YAAY,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAA;QAC9C,WAAW,GAAG,IAAI,aAAa,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACnD,OAAO,cAAc,CAAC,EAAC,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;AACzF,CAAC;AAiBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAiD;IAEjD,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAC,GAAG,OAAO,CAAA;IAEvF,IAAI,UAAU,GAAG,OAAO,IAAI,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IACzE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,UAAU,GAAG,MAAM,8BAA8B,CAAC,OAAO,CAAC,CAAA;IAC5D,CAAC;IACD,IAAI,WAAW,GAAG,MAAM,kBAAkB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC7D,MAAM,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAEhD,IAAI,kBAAkB,EAAE,KAAK,OAAO,EAAE,CAAC;QACrC,YAAY,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAA;QAC9C,WAAW,GAAG,IAAI,aAAa,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,OAAO,CAAC;QAC/C,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,YAAY;KACb,CAAA;IACD,IAAI,mBAAoD,CAAA;IACxD,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;QACzB,mBAAmB,GAAG,EAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,OAAyC,EAAC,CAAA;IAC3G,CAAC;IACD,MAAM,MAAM,GAAG,iBAAiB,CAAsB;QACpD,GAAG,IAAI;QACP,KAAK;QACL,SAAS;QACT,eAAe;QACf,mBAAmB;QACnB,gBAAgB;KACjB,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAqB;IAC/C,OAAO,oBAAoB,CAAC,OAAO,CAAC;QAClC,CAAC,CAAC,EAAC,gBAAgB,EAAE,OAAO,CAAC,SAAS,EAAE,wBAAwB,EAAE,OAAO,CAAC,KAAK,EAAC;QAChF,CAAC,CAAC,EAAE,CAAA;AACR,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,8BAA8B,CAAC,OAAqB;IACjE,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAA;IACvD,oEAAoE;IACpE,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAE,CAAA;IACxC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACrD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAqB;IAC9D,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACnD,OAAO,WAAW;SACf,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;SAChC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;SAC1B,IAAI,EAAE,CAAA;AACX,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,OAAqB;IACnD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;YACrC,KAAK,EAAE,iBAAiB;YACxB,OAAO;YACP,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,UAAU;YACnB,eAAe,EAAE,EAAC,YAAY,EAAE,KAAK,EAAC;SACvC,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,iBAAiB,CAAA;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAClE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;YACjE,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA,qDAAqD,WAAW,CAAC,IAAI,CAChF,SAAS,EACT,WAAW,OAAO,CAAC,SAAS,EAAE,CAC/B,GAAG,EACJ,aAAa,CAAA,wEAAwE,CACtF,CAAA;QACH,CAAC;QACD,IAAI,KAAK,YAAY,WAAW,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,EAAE,CAAC;YACrG,MAAM,IAAI,UAAU,CAClB,kCAAkC,OAAO,CAAC,SAAS,KAAK,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CACxH,CAAA;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,QAAQ,CAChB,0CAA0C,OAAO,CAAC,SAAS,KACzD,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CACvD,EAAE,CACH,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAa,EAAE,OAA2B,EAAE,OAAsB;IACzF,MAAM,WAAW,GAAG,OAAO,IAAI,UAAU,CAAA;IAEzC,MAAM,GAAG,GACP,OAAO,IAAI,oBAAoB,CAAC,OAAO,CAAC;QACtC,CAAC,CAAC,WAAW,oBAAoB,kBAAkB,WAAW,eAAe;QAC7E,CAAC,CAAC,WAAW,KAAK,cAAc,WAAW,eAAe,CAAA;IAC9D,OAAO,GAAG,CAAA;AACZ,CAAC;AAOD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAc,EACd,IAAY,EACZ,OAAqB,EACrB,WAAe,EACf,eAAyC,EAAE,EAC3C,UAAU,GAAG,UAAU;IAEvB,MAAM,GAAG,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;IACnE,MAAM,IAAI,GAAG,eAAe,CAAI,WAAW,CAAC,CAAA;IAE5C,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC3C,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE;QACvC,OAAO;QACP,MAAM;QACN,IAAI;KACL,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAEpD,OAAO;QACL,IAAI;QACJ,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE;KAChC,CAAA;AACH,CAAC","sourcesContent":["import {\n  graphqlRequest,\n  graphqlRequestDoc,\n  GraphQLResponseOptions,\n  GraphQLVariables,\n  UnauthorizedHandler,\n} from './graphql.js'\nimport {AdminSession} from '../session.js'\nimport {outputContent, outputToken} from '../../../public/node/output.js'\nimport {AbortError, BugError} from '../error.js'\nimport {\n  restRequestBody,\n  restRequestHeaders,\n  restRequestUrl,\n  isThemeAccessSession,\n} from '../../../private/node/api/rest.js'\nimport {RequestModeInput, shopifyFetch} from '../http.js'\nimport {PublicApiVersions} from '../../../cli/api/graphql/admin/generated/public_api_versions.js'\nimport {normalizeStoreFqdn} from '../context/fqdn.js'\nimport {themeKitAccessDomain} from '../../../private/node/constants.js'\nimport {serviceEnvironment} from '../../../private/node/context/service.js'\nimport {DevServerCore} from '../vendor/dev_server/index.js'\nimport {ClientError, Variables} from 'graphql-request'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\n\nconst LatestApiVersionByFQDN = new Map<string, string>()\n\n/**\n * Executes a GraphQL query against the Admin API.\n *\n * @param query - GraphQL query to execute.\n * @param session - Shopify admin session including token and Store FQDN.\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 adminRequest<T>(query: string, session: AdminSession, variables?: GraphQLVariables): Promise<T> {\n  const api = 'Admin'\n  const version = await fetchLatestSupportedApiVersion(session)\n  let storeDomain = await normalizeStoreFqdn(session.storeFqdn)\n  const addedHeaders = themeAccessHeaders(session)\n\n  if (serviceEnvironment() === 'local') {\n    addedHeaders['x-forwarded-host'] = storeDomain\n    storeDomain = new DevServerCore().host('app')\n  }\n\n  const url = adminUrl(storeDomain, version, session)\n  return graphqlRequest({query, api, addedHeaders, url, token: session.token, variables})\n}\n\nexport interface AdminRequestOptions<TResult, TVariables extends Variables> {\n  /** GraphQL query to execute. */\n  query: TypedDocumentNode<TResult, TVariables>\n  /** Shopify admin session including token and Store FQDN. */\n  session: AdminSession\n  /** GraphQL variables to pass to the query. */\n  variables?: TVariables\n  /** API version. */\n  version?: string\n  /** Control how API responses will be handled. */\n  responseOptions?: GraphQLResponseOptions<TResult>\n  /** Custom request behaviour for retries and timeouts. */\n  requestBehaviour?: RequestModeInput\n}\n\n/**\n * Executes a GraphQL query against the Admin API. Uses typed documents.\n *\n * @param options - Admin request options.\n * @returns The response of the query of generic type <TResult>.\n */\nexport async function adminRequestDoc<TResult, TVariables extends Variables>(\n  options: AdminRequestOptions<TResult, TVariables>,\n): Promise<TResult> {\n  const {query, session, variables, version, responseOptions, requestBehaviour} = options\n\n  let apiVersion = version ?? LatestApiVersionByFQDN.get(session.storeFqdn)\n  if (!apiVersion) {\n    apiVersion = await fetchLatestSupportedApiVersion(session)\n  }\n  let storeDomain = await normalizeStoreFqdn(session.storeFqdn)\n  const addedHeaders = themeAccessHeaders(session)\n\n  if (serviceEnvironment() === 'local') {\n    addedHeaders['x-forwarded-host'] = storeDomain\n    storeDomain = new DevServerCore().host('app')\n  }\n\n  const opts = {\n    url: adminUrl(storeDomain, apiVersion, session),\n    api: 'Admin',\n    token: session.token,\n    addedHeaders,\n  }\n  let unauthorizedHandler: UnauthorizedHandler | undefined\n  if ('refresh' in session) {\n    unauthorizedHandler = {type: 'token_refresh', handler: session.refresh as () => Promise<{token: string}>}\n  }\n  const result = graphqlRequestDoc<TResult, TVariables>({\n    ...opts,\n    query,\n    variables,\n    responseOptions,\n    unauthorizedHandler,\n    requestBehaviour,\n  })\n  return result\n}\n\nfunction themeAccessHeaders(session: AdminSession): {[header: string]: string} {\n  return isThemeAccessSession(session)\n    ? {'X-Shopify-Shop': session.storeFqdn, 'X-Shopify-Access-Token': session.token}\n    : {}\n}\n\n/**\n * GraphQL query to retrieve the latest supported API version.\n *\n * @param session - Shopify admin session including token and Store FQDN.\n * @returns - The latest supported API version.\n */\nasync function fetchLatestSupportedApiVersion(session: AdminSession): Promise<string> {\n  const apiVersions = await supportedApiVersions(session)\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  const latest = apiVersions.reverse()[0]!\n  LatestApiVersionByFQDN.set(session.storeFqdn, latest)\n  return latest\n}\n\n/**\n * GraphQL query to retrieve all supported API versions.\n *\n * @param session - Shopify admin session including token and Store FQDN.\n * @returns - An array of supported API versions.\n */\nexport async function supportedApiVersions(session: AdminSession): Promise<string[]> {\n  const apiVersions = await fetchApiVersions(session)\n  return apiVersions\n    .filter((item) => item.supported)\n    .map((item) => item.handle)\n    .sort()\n}\n\n/**\n * GraphQL query to retrieve all API versions.\n *\n * @param session - Shopify admin session including token and Store FQDN.\n * @returns - An array of supported and unsupported API versions.\n */\nasync function fetchApiVersions(session: AdminSession): Promise<ApiVersion[]> {\n  try {\n    const response = await adminRequestDoc({\n      query: PublicApiVersions,\n      session,\n      variables: {},\n      version: 'unstable',\n      responseOptions: {handleErrors: false},\n    })\n    return response.publicApiVersions\n  } catch (error) {\n    if (error instanceof ClientError && error.response.status === 403) {\n      const storeName = session.storeFqdn.replace('.myshopify.com', '')\n      throw new AbortError(\n        outputContent`Looks like you don't have access this dev store: (${outputToken.link(\n          storeName,\n          `https://${session.storeFqdn}`,\n        )})`,\n        outputContent`If you're not the owner, create a dev store staff account for yourself`,\n      )\n    }\n    if (error instanceof ClientError && (error.response.status === 401 || error.response.status === 404)) {\n      throw new AbortError(\n        `Error connecting to your store ${session.storeFqdn}: ${error.message} ${error.response.status} ${error.response.data}`,\n      )\n    } else {\n      throw new BugError(\n        `Unknown error connecting to your store ${session.storeFqdn}: ${\n          error instanceof Error ? error.message : String(error)\n        }`,\n      )\n    }\n  }\n}\n\n/**\n * Returns the Admin API URL for the given store and version.\n *\n * @param store - Store FQDN.\n * @param version - API version.\n * @param session - User session.\n * @returns - Admin API URL.\n */\nexport function adminUrl(store: string, version: string | undefined, session?: AdminSession): string {\n  const realVersion = version ?? 'unstable'\n\n  const url =\n    session && isThemeAccessSession(session)\n      ? `https://${themeKitAccessDomain}/cli/admin/api/${realVersion}/graphql.json`\n      : `https://${store}/admin/api/${realVersion}/graphql.json`\n  return url\n}\n\ninterface ApiVersion {\n  handle: string\n  supported: boolean\n}\n\n/**\n * Executes a REST request against the Admin API.\n *\n * @param method - Request's HTTP method.\n * @param path - Path of the REST resource.\n * @param session - Shopify Admin session including token and Store FQDN.\n * @param requestBody - Request body of including REST resource specific parameters.\n * @param searchParams - Search params, appended to the URL.\n * @param apiVersion - Admin API version.\n * @returns - The {@link RestResponse}.\n */\nexport async function restRequest<T>(\n  method: string,\n  path: string,\n  session: AdminSession,\n  requestBody?: T,\n  searchParams: {[name: string]: string} = {},\n  apiVersion = 'unstable',\n): Promise<RestResponse> {\n  const url = restRequestUrl(session, apiVersion, path, searchParams)\n  const body = restRequestBody<T>(requestBody)\n\n  const headers = restRequestHeaders(session)\n  const response = await shopifyFetch(url, {\n    headers,\n    method,\n    body,\n  })\n\n  const json = await response.json().catch(() => ({}))\n\n  return {\n    json,\n    status: response.status,\n    headers: response.headers.raw(),\n  }\n}\n\n/**\n * Respose of a REST request.\n */\nexport interface RestResponse {\n  /**\n   * REST JSON respose.\n   */\n  // Using `any` to avoid introducing extra DTO layers.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  json: any\n\n  /**\n   * HTTP response status.\n   */\n  status: number\n\n  /**\n   * HTTP response headers.\n   */\n  headers: {[key: string]: string[]}\n}\n"]}
+{"version":3,"file":"admin.js","sourceRoot":"","sources":["../../../../src/public/node/api/admin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,iBAAiB,GAIlB,MAAM,cAAc,CAAA;AAErB,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,gCAAgC,CAAA;AACzE,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAC,MAAM,aAAa,CAAA;AAChD,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,oBAAoB,GACrB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAmB,YAAY,EAAC,MAAM,YAAY,CAAA;AACzD,OAAO,EAAC,iBAAiB,EAAC,MAAM,iEAAiE,CAAA;AACjG,OAAO,EAAC,kBAAkB,EAAC,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAA;AACvE,OAAO,EAAC,kBAAkB,EAAC,MAAM,0CAA0C,CAAA;AAC3E,OAAO,EAAC,aAAa,EAAC,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAC,WAAW,EAAY,MAAM,iBAAiB,CAAA;AAGtD,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAkB,CAAA;AAExD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAI,KAAa,EAAE,OAAqB,EAAE,SAA4B;IACtG,MAAM,GAAG,GAAG,OAAO,CAAA;IACnB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,OAAO,CAAC,CAAA;IAC7D,IAAI,WAAW,GAAG,MAAM,kBAAkB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC7D,MAAM,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAEhD,IAAI,kBAAkB,EAAE,KAAK,OAAO,EAAE,CAAC;QACrC,YAAY,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAA;QAC9C,WAAW,GAAG,IAAI,aAAa,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACnD,OAAO,cAAc,CAAC,EAAC,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;AACzF,CAAC;AAiBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAiD;IAEjD,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAC,GAAG,OAAO,CAAA;IAEzF,IAAI,UAAU,GAAG,OAAO,IAAI,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IACzE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,UAAU,GAAG,MAAM,8BAA8B,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IAChF,CAAC;IACD,IAAI,WAAW,GAAG,MAAM,kBAAkB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC7D,MAAM,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAEhD,IAAI,kBAAkB,EAAE,KAAK,OAAO,EAAE,CAAC;QACrC,YAAY,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAA;QAC9C,WAAW,GAAG,IAAI,aAAa,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,OAAO,CAAC;QAC/C,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,YAAY;KACb,CAAA;IACD,IAAI,mBAAoD,CAAA;IACxD,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;QACzB,mBAAmB,GAAG,EAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,OAAyC,EAAC,CAAA;IAC3G,CAAC;IACD,MAAM,MAAM,GAAG,iBAAiB,CAAsB;QACpD,GAAG,IAAI;QACP,KAAK;QACL,SAAS;QACT,eAAe;QACf,mBAAmB;QACnB,kBAAkB;KACnB,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAqB;IAC/C,OAAO,oBAAoB,CAAC,OAAO,CAAC;QAClC,CAAC,CAAC,EAAC,gBAAgB,EAAE,OAAO,CAAC,SAAS,EAAE,wBAAwB,EAAE,OAAO,CAAC,KAAK,EAAC;QAChF,CAAC,CAAC,EAAE,CAAA;AACR,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,8BAA8B,CAC3C,OAAqB,EACrB,kBAAqC;IAErC,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IAC3E,oEAAoE;IACpE,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAE,CAAA;IACxC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACrD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAqB,EACrB,kBAAqC;IAErC,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IACvE,OAAO,WAAW;SACf,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;SAChC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;SAC1B,IAAI,EAAE,CAAA;AACX,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAAC,OAAqB,EAAE,kBAAqC;IAC1F,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;YACrC,KAAK,EAAE,iBAAiB;YACxB,OAAO;YACP,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,UAAU;YACnB,eAAe,EAAE,EAAC,YAAY,EAAE,KAAK,EAAC;YACtC,kBAAkB;SACnB,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,iBAAiB,CAAA;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAClE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA;YACjE,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA,qDAAqD,WAAW,CAAC,IAAI,CAChF,SAAS,EACT,WAAW,OAAO,CAAC,SAAS,EAAE,CAC/B,GAAG,EACJ,aAAa,CAAA,wEAAwE,CACtF,CAAA;QACH,CAAC;QACD,IAAI,KAAK,YAAY,WAAW,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,EAAE,CAAC;YACrG,MAAM,IAAI,UAAU,CAClB,kCAAkC,OAAO,CAAC,SAAS,KAAK,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CACxH,CAAA;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,QAAQ,CAChB,0CAA0C,OAAO,CAAC,SAAS,KACzD,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CACvD,EAAE,CACH,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAa,EAAE,OAA2B,EAAE,OAAsB;IACzF,MAAM,WAAW,GAAG,OAAO,IAAI,UAAU,CAAA;IAEzC,MAAM,GAAG,GACP,OAAO,IAAI,oBAAoB,CAAC,OAAO,CAAC;QACtC,CAAC,CAAC,WAAW,oBAAoB,kBAAkB,WAAW,eAAe;QAC7E,CAAC,CAAC,WAAW,KAAK,cAAc,WAAW,eAAe,CAAA;IAC9D,OAAO,GAAG,CAAA;AACZ,CAAC;AAOD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAc,EACd,IAAY,EACZ,OAAqB,EACrB,WAAe,EACf,eAAyC,EAAE,EAC3C,UAAU,GAAG,UAAU;IAEvB,MAAM,GAAG,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;IACnE,MAAM,IAAI,GAAG,eAAe,CAAI,WAAW,CAAC,CAAA;IAE5C,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC3C,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE;QACvC,OAAO;QACP,MAAM;QACN,IAAI;KACL,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAEpD,OAAO;QACL,IAAI;QACJ,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE;KAChC,CAAA;AACH,CAAC","sourcesContent":["import {\n  graphqlRequest,\n  graphqlRequestDoc,\n  GraphQLResponseOptions,\n  GraphQLVariables,\n  UnauthorizedHandler,\n} from './graphql.js'\nimport {AdminSession} from '../session.js'\nimport {outputContent, outputToken} from '../../../public/node/output.js'\nimport {AbortError, BugError} from '../error.js'\nimport {\n  restRequestBody,\n  restRequestHeaders,\n  restRequestUrl,\n  isThemeAccessSession,\n} from '../../../private/node/api/rest.js'\nimport {RequestModeInput, shopifyFetch} from '../http.js'\nimport {PublicApiVersions} from '../../../cli/api/graphql/admin/generated/public_api_versions.js'\nimport {normalizeStoreFqdn} from '../context/fqdn.js'\nimport {themeKitAccessDomain} from '../../../private/node/constants.js'\nimport {serviceEnvironment} from '../../../private/node/context/service.js'\nimport {DevServerCore} from '../vendor/dev_server/index.js'\nimport {ClientError, Variables} from 'graphql-request'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\n\nconst LatestApiVersionByFQDN = new Map<string, string>()\n\n/**\n * Executes a GraphQL query against the Admin API.\n *\n * @param query - GraphQL query to execute.\n * @param session - Shopify admin session including token and Store FQDN.\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 adminRequest<T>(query: string, session: AdminSession, variables?: GraphQLVariables): Promise<T> {\n  const api = 'Admin'\n  const version = await fetchLatestSupportedApiVersion(session)\n  let storeDomain = await normalizeStoreFqdn(session.storeFqdn)\n  const addedHeaders = themeAccessHeaders(session)\n\n  if (serviceEnvironment() === 'local') {\n    addedHeaders['x-forwarded-host'] = storeDomain\n    storeDomain = new DevServerCore().host('app')\n  }\n\n  const url = adminUrl(storeDomain, version, session)\n  return graphqlRequest({query, api, addedHeaders, url, token: session.token, variables})\n}\n\nexport interface AdminRequestOptions<TResult, TVariables extends Variables> {\n  /** GraphQL query to execute. */\n  query: TypedDocumentNode<TResult, TVariables>\n  /** Shopify admin session including token and Store FQDN. */\n  session: AdminSession\n  /** GraphQL variables to pass to the query. */\n  variables?: TVariables\n  /** API version. */\n  version?: string\n  /** Control how API responses will be handled. */\n  responseOptions?: GraphQLResponseOptions<TResult>\n  /** Custom request behaviour for retries and timeouts. */\n  preferredBehaviour?: RequestModeInput\n}\n\n/**\n * Executes a GraphQL query against the Admin API. Uses typed documents.\n *\n * @param options - Admin request options.\n * @returns The response of the query of generic type <TResult>.\n */\nexport async function adminRequestDoc<TResult, TVariables extends Variables>(\n  options: AdminRequestOptions<TResult, TVariables>,\n): Promise<TResult> {\n  const {query, session, variables, version, responseOptions, preferredBehaviour} = options\n\n  let apiVersion = version ?? LatestApiVersionByFQDN.get(session.storeFqdn)\n  if (!apiVersion) {\n    apiVersion = await fetchLatestSupportedApiVersion(session, preferredBehaviour)\n  }\n  let storeDomain = await normalizeStoreFqdn(session.storeFqdn)\n  const addedHeaders = themeAccessHeaders(session)\n\n  if (serviceEnvironment() === 'local') {\n    addedHeaders['x-forwarded-host'] = storeDomain\n    storeDomain = new DevServerCore().host('app')\n  }\n\n  const opts = {\n    url: adminUrl(storeDomain, apiVersion, session),\n    api: 'Admin',\n    token: session.token,\n    addedHeaders,\n  }\n  let unauthorizedHandler: UnauthorizedHandler | undefined\n  if ('refresh' in session) {\n    unauthorizedHandler = {type: 'token_refresh', handler: session.refresh as () => Promise<{token: string}>}\n  }\n  const result = graphqlRequestDoc<TResult, TVariables>({\n    ...opts,\n    query,\n    variables,\n    responseOptions,\n    unauthorizedHandler,\n    preferredBehaviour,\n  })\n  return result\n}\n\nfunction themeAccessHeaders(session: AdminSession): {[header: string]: string} {\n  return isThemeAccessSession(session)\n    ? {'X-Shopify-Shop': session.storeFqdn, 'X-Shopify-Access-Token': session.token}\n    : {}\n}\n\n/**\n * GraphQL query to retrieve the latest supported API version.\n *\n * @param session - Shopify admin session including token and Store FQDN.\n * @param preferredBehaviour - Custom request behaviour for retries and timeouts.\n * @returns - The latest supported API version.\n */\nasync function fetchLatestSupportedApiVersion(\n  session: AdminSession,\n  preferredBehaviour?: RequestModeInput,\n): Promise<string> {\n  const apiVersions = await supportedApiVersions(session, preferredBehaviour)\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n  const latest = apiVersions.reverse()[0]!\n  LatestApiVersionByFQDN.set(session.storeFqdn, latest)\n  return latest\n}\n\n/**\n * GraphQL query to retrieve all supported API versions.\n *\n * @param session - Shopify admin session including token and Store FQDN.\n * @param preferredBehaviour - Custom request behaviour for retries and timeouts.\n * @returns - An array of supported API versions.\n */\nexport async function supportedApiVersions(\n  session: AdminSession,\n  preferredBehaviour?: RequestModeInput,\n): Promise<string[]> {\n  const apiVersions = await fetchApiVersions(session, preferredBehaviour)\n  return apiVersions\n    .filter((item) => item.supported)\n    .map((item) => item.handle)\n    .sort()\n}\n\n/**\n * GraphQL query to retrieve all API versions.\n *\n * @param session - Shopify admin session including token and Store FQDN.\n * @param preferredBehaviour - Custom request behaviour for retries and timeouts.\n * @returns - An array of supported and unsupported API versions.\n */\nasync function fetchApiVersions(session: AdminSession, preferredBehaviour?: RequestModeInput): Promise<ApiVersion[]> {\n  try {\n    const response = await adminRequestDoc({\n      query: PublicApiVersions,\n      session,\n      variables: {},\n      version: 'unstable',\n      responseOptions: {handleErrors: false},\n      preferredBehaviour,\n    })\n    return response.publicApiVersions\n  } catch (error) {\n    if (error instanceof ClientError && error.response.status === 403) {\n      const storeName = session.storeFqdn.replace('.myshopify.com', '')\n      throw new AbortError(\n        outputContent`Looks like you don't have access this dev store: (${outputToken.link(\n          storeName,\n          `https://${session.storeFqdn}`,\n        )})`,\n        outputContent`If you're not the owner, create a dev store staff account for yourself`,\n      )\n    }\n    if (error instanceof ClientError && (error.response.status === 401 || error.response.status === 404)) {\n      throw new AbortError(\n        `Error connecting to your store ${session.storeFqdn}: ${error.message} ${error.response.status} ${error.response.data}`,\n      )\n    } else {\n      throw new BugError(\n        `Unknown error connecting to your store ${session.storeFqdn}: ${\n          error instanceof Error ? error.message : String(error)\n        }`,\n      )\n    }\n  }\n}\n\n/**\n * Returns the Admin API URL for the given store and version.\n *\n * @param store - Store FQDN.\n * @param version - API version.\n * @param session - User session.\n * @returns - Admin API URL.\n */\nexport function adminUrl(store: string, version: string | undefined, session?: AdminSession): string {\n  const realVersion = version ?? 'unstable'\n\n  const url =\n    session && isThemeAccessSession(session)\n      ? `https://${themeKitAccessDomain}/cli/admin/api/${realVersion}/graphql.json`\n      : `https://${store}/admin/api/${realVersion}/graphql.json`\n  return url\n}\n\ninterface ApiVersion {\n  handle: string\n  supported: boolean\n}\n\n/**\n * Executes a REST request against the Admin API.\n *\n * @param method - Request's HTTP method.\n * @param path - Path of the REST resource.\n * @param session - Shopify Admin session including token and Store FQDN.\n * @param requestBody - Request body of including REST resource specific parameters.\n * @param searchParams - Search params, appended to the URL.\n * @param apiVersion - Admin API version.\n * @returns - The {@link RestResponse}.\n */\nexport async function restRequest<T>(\n  method: string,\n  path: string,\n  session: AdminSession,\n  requestBody?: T,\n  searchParams: {[name: string]: string} = {},\n  apiVersion = 'unstable',\n): Promise<RestResponse> {\n  const url = restRequestUrl(session, apiVersion, path, searchParams)\n  const body = restRequestBody<T>(requestBody)\n\n  const headers = restRequestHeaders(session)\n  const response = await shopifyFetch(url, {\n    headers,\n    method,\n    body,\n  })\n\n  const json = await response.json().catch(() => ({}))\n\n  return {\n    json,\n    status: response.status,\n    headers: response.headers.raw(),\n  }\n}\n\n/**\n * Respose of a REST request.\n */\nexport interface RestResponse {\n  /**\n   * REST JSON respose.\n   */\n  // Using `any` to avoid introducing extra DTO layers.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  json: any\n\n  /**\n   * HTTP response status.\n   */\n  status: number\n\n  /**\n   * HTTP response headers.\n   */\n  headers: {[key: string]: string[]}\n}\n"]}

package/dist/public/node/api/app-management.d.ts

@@ -22,7 +22,6 @@ export interface RequestOptions {
  * @param unauthorizedHandler - Optional handler for unauthorized requests.
  */
 export interface AppManagementRequestOptions<TResult, TVariables extends Variables> {
-    organizationId: string;
     query: TypedDocumentNode<TResult, TVariables>;
     token: string;
     variables?: TVariables;

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

@@ -11,10 +11,10 @@ const limiter = new Bottleneck({
     minTime: 150,
     maxConcurrent: 10,
 });
-async function setupRequest(orgId, token) {
+async function setupRequest(token) {
     const api = 'App Management';
     const fqdn = await appManagementFqdn();
-    const url = `https://${fqdn}/app_management/unstable/organizations/${orgId}/graphql.json`;
+    const url = `https://${fqdn}/app_management/unstable/graphql.json`;
     return {
         token,
         api,
@@ -37,11 +37,10 @@ export const appManagementAppLogsUrl = async (organizationId, cursor, filters) =
  * @returns The response of the query of generic type <T>.
  */
 export async function appManagementRequestDoc(options) {
-    // For app management, we need to cache the response based on the orgId.
-    const cacheExtraKey = (options.cacheOptions?.cacheExtraKey ?? '') + options.organizationId;
+    const cacheExtraKey = options.cacheOptions?.cacheExtraKey ?? '';
     const newCacheOptions = options.cacheOptions ? { ...options.cacheOptions, cacheExtraKey } : undefined;
     const result = limiter.schedule(async () => graphqlRequestDoc({
-        ...(await setupRequest(options.organizationId, options.token)),
+        ...(await setupRequest(options.token)),
         query: options.query,
         variables: options.variables,
         cacheOptions: newCacheOptions,

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

@@ -1 +1 @@
-{"version":3,"file":"app-management.js","sourceRoot":"","sources":["../../../../src/public/node/api/app-management.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqD,iBAAiB,EAAC,MAAM,cAAc,CAAA;AAClG,OAAO,EAAC,+BAA+B,EAAC,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,qDAAqD,CAAA;AAC1F,OAAO,EAAC,YAAY,EAAC,MAAM,sCAAsC,CAAA;AAEjE,OAAO,UAAU,MAAM,YAAY,CAAA;AAInC,sEAAsE;AACtE,yEAAyE;AACzE,iDAAiD;AACjD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;IAC7B,OAAO,EAAE,GAAG;IACZ,aAAa,EAAE,EAAE;CAClB,CAAC,CAAA;AAEF,KAAK,UAAU,YAAY,CAAC,KAAa,EAAE,KAAa;IACtD,MAAM,GAAG,GAAG,gBAAgB,CAAA;IAC5B,MAAM,IAAI,GAAG,MAAM,iBAAiB,EAAE,CAAA;IACtC,MAAM,GAAG,GAAG,WAAW,IAAI,0CAA0C,KAAK,eAAe,CAAA;IACzF,OAAO;QACL,KAAK;QACL,GAAG;QACH,GAAG;QACH,eAAe,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC;KAClD,CAAA;AACH,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAA2B,EAAE;IAC7E,OAAO,YAAY,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAC1C,cAAsB,EACtB,MAAe,EACf,OAGC,EACgB,EAAE;IACnB,MAAM,IAAI,GAAG,MAAM,iBAAiB,EAAE,CAAA;IACtC,MAAM,GAAG,GAAG,WAAW,IAAI,0CAA0C,cAAc,gBAAgB,CAAA;IACnG,OAAO,+BAA+B,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AAC9D,CAAC,CAAA;AAyBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAAyD;IAEzD,wEAAwE;IACxE,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,aAAa,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,cAAc,CAAA;IAC1F,MAAM,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,GAAG,OAAO,CAAC,YAAY,EAAE,aAAa,EAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAEnG,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAU,KAAK,IAAI,EAAE,CAClD,iBAAiB,CAAsB;QACrC,GAAG,CAAC,MAAM,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9D,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,YAAY,EAAE,eAAe;QAC7B,kBAAkB,EAAE,OAAO,CAAC,cAAc,EAAE,WAAW;QACvD,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;KACjD,CAAC,CACH,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAUD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAI,QAA4B;IAChE,IAAI,CAAC,QAAQ,CAAC,UAAU;QAAE,OAAM;IAEhC,MAAM,gBAAgB,GAAW,EAAE,CAAA;IACnC,KAAK,MAAM,WAAW,IAAK,QAAQ,CAAC,UAA+B,CAAC,YAAY,EAAE,CAAC;QACjF,IAAI,WAAW,CAAC,kBAAkB,EAAE,CAAC;YACnC,gBAAgB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAA;QACjE,CAAC;IACH,CAAC;IAED,sBAAsB,CAAC,gBAAgB,CAAC,CAAA;AAC1C,CAAC","sourcesContent":["import {CacheOptions, GraphQLResponse, UnauthorizedHandler, graphqlRequestDoc} from './graphql.js'\nimport {addCursorAndFiltersToAppLogsUrl} from './utilities.js'\nimport {appManagementFqdn} from '../context/fqdn.js'\nimport {setNextDeprecationDate} from '../../../private/node/context/deprecations-store.js'\nimport {buildHeaders} from '../../../private/node/api/headers.js'\nimport {RequestModeInput} from '../http.js'\nimport Bottleneck from 'bottleneck'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\nimport {Variables} from 'graphql-request'\n\n// API Rate limiter for partners API (Limit is 10 requests per second)\n// Jobs are launched every 150ms to add an extra 50ms margin per request.\n// Only 10 requests can be executed concurrently.\nconst limiter = new Bottleneck({\n  minTime: 150,\n  maxConcurrent: 10,\n})\n\nasync function setupRequest(orgId: string, token: string) {\n  const api = 'App Management'\n  const fqdn = await appManagementFqdn()\n  const url = `https://${fqdn}/app_management/unstable/organizations/${orgId}/graphql.json`\n  return {\n    token,\n    api,\n    url,\n    responseOptions: {onResponse: handleDeprecations},\n  }\n}\n\nexport const appManagementHeaders = (token: string): {[key: string]: string} => {\n  return buildHeaders(token)\n}\n\nexport const appManagementAppLogsUrl = async (\n  organizationId: string,\n  cursor?: string,\n  filters?: {\n    status?: string\n    source?: string\n  },\n): Promise<string> => {\n  const fqdn = await appManagementFqdn()\n  const url = `https://${fqdn}/app_management/unstable/organizations/${organizationId}/app_logs/poll`\n  return addCursorAndFiltersToAppLogsUrl(url, cursor, filters)\n}\n\nexport interface RequestOptions {\n  requestMode: RequestModeInput\n}\n\n/**\n * @param orgId - The organization ID.\n * @param query - GraphQL query to execute.\n * @param token - Partners token.\n * @param variables - GraphQL variables to pass to the query.\n * @param cacheOptions - Cache options for the request. If not present, the request will not be cached.\n * @param requestOptions - Preferred behaviour for the request.\n * @param unauthorizedHandler - Optional handler for unauthorized requests.\n */\nexport interface AppManagementRequestOptions<TResult, TVariables extends Variables> {\n  organizationId: string\n  query: TypedDocumentNode<TResult, TVariables>\n  token: string\n  variables?: TVariables\n  cacheOptions?: CacheOptions\n  requestOptions?: RequestOptions\n  unauthorizedHandler: UnauthorizedHandler\n}\n\n/**\n * Executes an org-scoped GraphQL query against the App Management API. Uses typed documents.\n *\n * @param options - The options for the request.\n * @returns The response of the query of generic type <T>.\n */\nexport async function appManagementRequestDoc<TResult, TVariables extends Variables>(\n  options: AppManagementRequestOptions<TResult, TVariables>,\n): Promise<TResult> {\n  // For app management, we need to cache the response based on the orgId.\n  const cacheExtraKey = (options.cacheOptions?.cacheExtraKey ?? '') + options.organizationId\n  const newCacheOptions = options.cacheOptions ? {...options.cacheOptions, cacheExtraKey} : undefined\n\n  const result = limiter.schedule<TResult>(async () =>\n    graphqlRequestDoc<TResult, TVariables>({\n      ...(await setupRequest(options.organizationId, options.token)),\n      query: options.query,\n      variables: options.variables,\n      cacheOptions: newCacheOptions,\n      preferredBehaviour: options.requestOptions?.requestMode,\n      unauthorizedHandler: options.unauthorizedHandler,\n    }),\n  )\n\n  return result\n}\n\ninterface Deprecation {\n  supportedUntilDate?: string\n}\n\ninterface WithDeprecations {\n  deprecations: Deprecation[]\n}\n\n/**\n * Sets the next deprecation date from [GraphQL response extensions](https://www.apollographql.com/docs/resources/graphql-glossary/#extensions)\n * if `response.extensions.deprecations` objects contain a `supportedUntilDate` (ISO 8601-formatted string).\n *\n * @param response - The response of the query.\n */\nexport function handleDeprecations<T>(response: GraphQLResponse<T>): void {\n  if (!response.extensions) return\n\n  const deprecationDates: Date[] = []\n  for (const deprecation of (response.extensions as WithDeprecations).deprecations) {\n    if (deprecation.supportedUntilDate) {\n      deprecationDates.push(new Date(deprecation.supportedUntilDate))\n    }\n  }\n\n  setNextDeprecationDate(deprecationDates)\n}\n"]}
+{"version":3,"file":"app-management.js","sourceRoot":"","sources":["../../../../src/public/node/api/app-management.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqD,iBAAiB,EAAC,MAAM,cAAc,CAAA;AAClG,OAAO,EAAC,+BAA+B,EAAC,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,qDAAqD,CAAA;AAC1F,OAAO,EAAC,YAAY,EAAC,MAAM,sCAAsC,CAAA;AAEjE,OAAO,UAAU,MAAM,YAAY,CAAA;AAInC,sEAAsE;AACtE,yEAAyE;AACzE,iDAAiD;AACjD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;IAC7B,OAAO,EAAE,GAAG;IACZ,aAAa,EAAE,EAAE;CAClB,CAAC,CAAA;AAEF,KAAK,UAAU,YAAY,CAAC,KAAa;IACvC,MAAM,GAAG,GAAG,gBAAgB,CAAA;IAC5B,MAAM,IAAI,GAAG,MAAM,iBAAiB,EAAE,CAAA;IACtC,MAAM,GAAG,GAAG,WAAW,IAAI,uCAAuC,CAAA;IAClE,OAAO;QACL,KAAK;QACL,GAAG;QACH,GAAG;QACH,eAAe,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC;KAClD,CAAA;AACH,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAA2B,EAAE;IAC7E,OAAO,YAAY,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAC1C,cAAsB,EACtB,MAAe,EACf,OAGC,EACgB,EAAE;IACnB,MAAM,IAAI,GAAG,MAAM,iBAAiB,EAAE,CAAA;IACtC,MAAM,GAAG,GAAG,WAAW,IAAI,0CAA0C,cAAc,gBAAgB,CAAA;IACnG,OAAO,+BAA+B,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AAC9D,CAAC,CAAA;AAwBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAAyD;IAEzD,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,aAAa,IAAI,EAAE,CAAA;IAC/D,MAAM,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,GAAG,OAAO,CAAC,YAAY,EAAE,aAAa,EAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAEnG,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAU,KAAK,IAAI,EAAE,CAClD,iBAAiB,CAAsB;QACrC,GAAG,CAAC,MAAM,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACtC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,YAAY,EAAE,eAAe;QAC7B,kBAAkB,EAAE,OAAO,CAAC,cAAc,EAAE,WAAW;QACvD,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;KACjD,CAAC,CACH,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAUD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAI,QAA4B;IAChE,IAAI,CAAC,QAAQ,CAAC,UAAU;QAAE,OAAM;IAEhC,MAAM,gBAAgB,GAAW,EAAE,CAAA;IACnC,KAAK,MAAM,WAAW,IAAK,QAAQ,CAAC,UAA+B,CAAC,YAAY,EAAE,CAAC;QACjF,IAAI,WAAW,CAAC,kBAAkB,EAAE,CAAC;YACnC,gBAAgB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAA;QACjE,CAAC;IACH,CAAC;IAED,sBAAsB,CAAC,gBAAgB,CAAC,CAAA;AAC1C,CAAC","sourcesContent":["import {CacheOptions, GraphQLResponse, UnauthorizedHandler, graphqlRequestDoc} from './graphql.js'\nimport {addCursorAndFiltersToAppLogsUrl} from './utilities.js'\nimport {appManagementFqdn} from '../context/fqdn.js'\nimport {setNextDeprecationDate} from '../../../private/node/context/deprecations-store.js'\nimport {buildHeaders} from '../../../private/node/api/headers.js'\nimport {RequestModeInput} from '../http.js'\nimport Bottleneck from 'bottleneck'\nimport {TypedDocumentNode} from '@graphql-typed-document-node/core'\nimport {Variables} from 'graphql-request'\n\n// API Rate limiter for partners API (Limit is 10 requests per second)\n// Jobs are launched every 150ms to add an extra 50ms margin per request.\n// Only 10 requests can be executed concurrently.\nconst limiter = new Bottleneck({\n  minTime: 150,\n  maxConcurrent: 10,\n})\n\nasync function setupRequest(token: string) {\n  const api = 'App Management'\n  const fqdn = await appManagementFqdn()\n  const url = `https://${fqdn}/app_management/unstable/graphql.json`\n  return {\n    token,\n    api,\n    url,\n    responseOptions: {onResponse: handleDeprecations},\n  }\n}\n\nexport const appManagementHeaders = (token: string): {[key: string]: string} => {\n  return buildHeaders(token)\n}\n\nexport const appManagementAppLogsUrl = async (\n  organizationId: string,\n  cursor?: string,\n  filters?: {\n    status?: string\n    source?: string\n  },\n): Promise<string> => {\n  const fqdn = await appManagementFqdn()\n  const url = `https://${fqdn}/app_management/unstable/organizations/${organizationId}/app_logs/poll`\n  return addCursorAndFiltersToAppLogsUrl(url, cursor, filters)\n}\n\nexport interface RequestOptions {\n  requestMode: RequestModeInput\n}\n\n/**\n * @param orgId - The organization ID.\n * @param query - GraphQL query to execute.\n * @param token - Partners token.\n * @param variables - GraphQL variables to pass to the query.\n * @param cacheOptions - Cache options for the request. If not present, the request will not be cached.\n * @param requestOptions - Preferred behaviour for the request.\n * @param unauthorizedHandler - Optional handler for unauthorized requests.\n */\nexport interface AppManagementRequestOptions<TResult, TVariables extends Variables> {\n  query: TypedDocumentNode<TResult, TVariables>\n  token: string\n  variables?: TVariables\n  cacheOptions?: CacheOptions\n  requestOptions?: RequestOptions\n  unauthorizedHandler: UnauthorizedHandler\n}\n\n/**\n * Executes an org-scoped GraphQL query against the App Management API. Uses typed documents.\n *\n * @param options - The options for the request.\n * @returns The response of the query of generic type <T>.\n */\nexport async function appManagementRequestDoc<TResult, TVariables extends Variables>(\n  options: AppManagementRequestOptions<TResult, TVariables>,\n): Promise<TResult> {\n  const cacheExtraKey = options.cacheOptions?.cacheExtraKey ?? ''\n  const newCacheOptions = options.cacheOptions ? {...options.cacheOptions, cacheExtraKey} : undefined\n\n  const result = limiter.schedule<TResult>(async () =>\n    graphqlRequestDoc<TResult, TVariables>({\n      ...(await setupRequest(options.token)),\n      query: options.query,\n      variables: options.variables,\n      cacheOptions: newCacheOptions,\n      preferredBehaviour: options.requestOptions?.requestMode,\n      unauthorizedHandler: options.unauthorizedHandler,\n    }),\n  )\n\n  return result\n}\n\ninterface Deprecation {\n  supportedUntilDate?: string\n}\n\ninterface WithDeprecations {\n  deprecations: Deprecation[]\n}\n\n/**\n * Sets the next deprecation date from [GraphQL response extensions](https://www.apollographql.com/docs/resources/graphql-glossary/#extensions)\n * if `response.extensions.deprecations` objects contain a `supportedUntilDate` (ISO 8601-formatted string).\n *\n * @param response - The response of the query.\n */\nexport function handleDeprecations<T>(response: GraphQLResponse<T>): void {\n  if (!response.extensions) return\n\n  const deprecationDates: Date[] = []\n  for (const deprecation of (response.extensions as WithDeprecations).deprecations) {\n    if (deprecation.supportedUntilDate) {\n      deprecationDates.push(new Date(deprecation.supportedUntilDate))\n    }\n  }\n\n  setNextDeprecationDate(deprecationDates)\n}\n"]}

package/dist/public/node/api/graphql.d.ts

@@ -40,7 +40,6 @@ export type GraphQLRequestOptions<T> = GraphQLRequestBaseOptions<T> & {
     query: RequestDocument;
     variables?: Variables;
     unauthorizedHandler?: UnauthorizedHandler;
-    requestBehaviour?: RequestModeInput;
 };
 export type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOptions<TResult> & {
     query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{
@@ -48,7 +47,6 @@ export type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOp
     }>>;
     variables?: TVariables;
     unauthorizedHandler?: UnauthorizedHandler;
-    requestBehaviour?: RequestModeInput;
 };
 export interface GraphQLResponseOptions<T> {
     handleErrors?: boolean;

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

@@ -26,7 +26,7 @@ async function createGraphQLClient({ url, addedHeaders, token, }) {
  */
 async function performGraphQLRequest(options) {
     const { token, addedHeaders, queryAsString, variables, api, url, responseOptions, unauthorizedHandler, cacheOptions } = options;
-    const requestBehaviour = requestMode(options.preferredBehaviour ?? 'default');
+    const behaviour = requestMode(options.preferredBehaviour ?? 'default');
     let { headers, client } = await createGraphQLClient({ url, addedHeaders, token });
     debugLogRequestInfo(api, queryAsString, url, variables, headers);
     const rawGraphQLRequest = async () => {
@@ -36,7 +36,7 @@ async function performGraphQLRequest(options) {
         try {
             // mapping signal to any due to polyfill meaning types don't exactly match (but are functionally equivalent)
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            client.requestConfig.signal = abortSignalFromRequestBehaviour(requestBehaviour);
+            client.requestConfig.signal = abortSignalFromRequestBehaviour(behaviour);
             fullResponse = await client.rawRequest(queryAsString, variables);
             await logLastRequestIdFromResponse(fullResponse);
             return fullResponse;
@@ -69,7 +69,7 @@ async function performGraphQLRequest(options) {
             }
         }
         : undefined;
-    const request = () => retryAwareRequest({ request: rawGraphQLRequest, url, ...requestBehaviour }, responseOptions?.handleErrors === false ? undefined : errorHandler(api));
+    const request = () => retryAwareRequest({ request: rawGraphQLRequest, url, ...behaviour }, responseOptions?.handleErrors === false ? undefined : errorHandler(api));
     const executeWithTimer = () => runWithTimer('cmd_all_timing_network_ms')(async () => {
         let response;
         try {

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,iBAAiB,EAAE,YAAY,EAAC,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAC,iBAAiB,EAAC,MAAM,8BAA8B,CAAA;AAC9D,OAAO,EAAC,oBAAoB,EAAC,MAAM,sCAAsC,CAAA;AACzE,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAA;AAC1C,OAAO,EACL,yBAAyB,EAIzB,0BAA0B,GAC3B,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAC,+BAA+B,EAAE,WAAW,EAAmB,MAAM,YAAY,CAAA;AACzF,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AACvD,OAAO,EACL,aAAa,EAGb,sBAAsB,EAEtB,WAAW,GACZ,MAAM,iBAAiB,CAAA;AAkExB,KAAK,UAAU,mBAAmB,CAAC,EACjC,GAAG,EACH,YAAY,EACZ,KAAK,GAKN;IACC,MAAM,OAAO,GAAG;QACd,GAAG,YAAY;QACf,GAAG,YAAY,CAAC,KAAK,CAAC;KACvB,CAAA;IACD,MAAM,aAAa,GAAG,EAAC,KAAK,EAAE,MAAM,UAAU,EAAE,EAAE,OAAO,EAAC,CAAA;IAE1D,OAAO;QACL,MAAM,EAAE,IAAI,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC;QAC7C,OAAO;KACR,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,qBAAqB,CAAU,OAA8C;IAC1F,MAAM,EAAC,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,EAAC,GACjH,OAAO,CAAA;IACT,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,IAAI,SAAS,CAAC,CAAA;IAE7E,IAAI,EAAC,OAAO,EAAE,MAAM,EAAC,GAAG,MAAM,mBAAmB,CAAC,EAAC,GAAG,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,CAAA;IAC7E,mBAAmB,CAAC,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;IAEhE,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;QACnC,IAAI,YAAsC,CAAA;QAC1C,6GAA6G;QAC7G,SAAS;QACT,IAAI,CAAC;YACH,4GAA4G;YAC5G,8DAA8D;YAC9D,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,+BAA+B,CAAC,gBAAgB,CAAQ,CAAA;YACtF,YAAY,GAAG,MAAM,MAAM,CAAC,UAAU,CAAU,aAAa,EAAE,SAAS,CAAC,CAAA;YACzE,MAAM,4BAA4B,CAAC,YAAY,CAAC,CAAA;YAChD,OAAO,YAAY,CAAA;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;gBACjC,kGAAkG;gBAClG,8DAA8D;gBAC9D,MAAM,4BAA4B,CAAC,KAAK,CAAC,QAAe,CAAC,CAAA;YAC3D,CAAC;YACD,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC,CAAA;IAED,MAAM,mBAAmB,GAAG,mBAAmB,EAAE,OAAO,CAAA;IAExD,MAAM,uCAAuC,GAAG,mBAAmB;QACjE,CAAC,CAAC,KAAK,IAAI,EAAE;YACT,MAAM,kBAAkB,GAAG,MAAM,mBAAmB,EAAE,CAAA;YACtD,IAAI,kBAAkB,CAAC,KAAK,EAAE,CAAC;gBAC7B,MAAM,EAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAC,GAAG,MAAM,mBAAmB,CAAC;oBACzE,GAAG;oBACH,YAAY;oBACZ,KAAK,EAAE,kBAAkB,CAAC,KAAK;iBAChC,CAAC,CAAA;gBACF,MAAM,GAAG,SAAS,CAAA;gBAClB,OAAO,GAAG,UAAU,CAAA;gBACpB,OAAO,IAAI,CAAA;YACb,CAAC;iBAAM,CAAC;gBACN,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QACH,CAAC,CAAC,SAAS,CAAA;IAEb,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,iBAAiB,CACf,EAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAG,gBAAgB,EAAC,EACtD,eAAe,EAAE,YAAY,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CACxE,CAAA;IAEH,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAC5B,YAAY,CAAC,2BAA2B,CAAC,CAAC,KAAK,IAAI,EAAE;QACnD,IAAI,QAAQ,CAAA;QACZ,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAA;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,uCAAuC,EAAE,CAAC;gBAC7G,IAAI,MAAM,uCAAuC,EAAE,EAAE,CAAC;oBACpD,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAA;gBAC5B,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,CAAA;gBACb,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;QAED,IAAI,eAAe,EAAE,UAAU,EAAE,CAAC;YAChC,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QACtC,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC,CAAC,CAAA;IAEJ,qFAAqF;IACrF,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,gBAAgB,EAAE,CAAA;IAC3B,CAAC;IAED,MAAM,EAAC,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAC,GAAG,YAAY,CAAA;IAE1D,qHAAqH;IACrH,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC,CAAA;IAC9C,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAA;IACpE,MAAM,QAAQ,GAAsB,KAAK,SAAS,IAAI,aAAa,IAAI,eAAe,IAAI,aAAa,IAAI,EAAE,EAAE,CAAA;IAE/G,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAC5C,QAAQ,EACR,KAAK,IAAI,EAAE;QACT,MAAM,MAAM,GAAG,MAAM,gBAAgB,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC,EACD,0BAA0B,CAAC,QAAQ,CAAC,EACpC,UAAU,CACX,CAAA;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAY,CAAA;AACtC,CAAC;AAED,KAAK,UAAU,4BAA4B,CAAC,QAAkC;IAC5E,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QACtD,oBAAoB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QAC5C,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC;YAC7B,+BAA+B,EAAE,SAAS,IAAI,SAAS;SACxD,CAAC,CAAC,CAAA;QACH,qDAAqD;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,0CAA0C;IAC5C,CAAC;AACH,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 {addPublicMetadata, runWithTimer} from '../metadata.js'\nimport {retryAwareRequest} from '../../../private/node/api.js'\nimport {requestIdsCollection} from '../../../private/node/request-ids.js'\nimport {nonRandomUUID} from '../crypto.js'\nimport {\n  cacheRetrieveOrRepopulate,\n  ConfSchema,\n  GraphQLRequestKey,\n  TimeInterval,\n  timeIntervalToMilliseconds,\n} from '../../../private/node/conf-store.js'\nimport {LocalStorage} from '../local-storage.js'\nimport {abortSignalFromRequestBehaviour, requestMode, RequestModeInput} from '../http.js'\nimport {CLI_KIT_VERSION} from '../../common/version.js'\nimport {\n  GraphQLClient,\n  rawRequest,\n  RequestDocument,\n  resolveRequestDocument,\n  Variables,\n  ClientError,\n} 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\nexport interface CacheOptions {\n  cacheTTL: TimeInterval\n  cacheExtraKey?: string\n  cacheStore?: LocalStorage<ConfSchema>\n}\n\ninterface RefreshedTokenOnAuthorizedResponse {\n  token?: string\n}\n\nexport type RefreshTokenOnAuthorizedResponse = Promise<RefreshedTokenOnAuthorizedResponse>\n\nexport interface UnauthorizedHandler {\n  type: 'token_refresh'\n  handler: () => RefreshTokenOnAuthorizedResponse\n}\n\ninterface GraphQLRequestBaseOptions<TResult> {\n  api: string\n  url: string\n  token?: string\n  addedHeaders?: {[header: string]: string}\n  responseOptions?: GraphQLResponseOptions<TResult>\n  cacheOptions?: CacheOptions\n  preferredBehaviour?: RequestModeInput\n}\n\ntype PerformGraphQLRequestOptions<TResult> = GraphQLRequestBaseOptions<TResult> & {\n  queryAsString: string\n  variables?: Variables\n  unauthorizedHandler?: UnauthorizedHandler\n  requestBehaviour?: RequestModeInput\n}\n\nexport type GraphQLRequestOptions<T> = GraphQLRequestBaseOptions<T> & {\n  query: RequestDocument\n  variables?: Variables\n  unauthorizedHandler?: UnauthorizedHandler\n  requestBehaviour?: RequestModeInput\n}\n\nexport type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOptions<TResult> & {\n  query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{[key: string]: never}>>\n  variables?: TVariables\n  unauthorizedHandler?: UnauthorizedHandler\n  requestBehaviour?: RequestModeInput\n}\n\nexport interface GraphQLResponseOptions<T> {\n  handleErrors?: boolean\n  onResponse?: (response: GraphQLResponse<T>) => void\n}\n\nasync function createGraphQLClient({\n  url,\n  addedHeaders,\n  token,\n}: {\n  url: string\n  token: string | undefined\n  addedHeaders?: {[header: string]: string}\n}) {\n  const headers = {\n    ...addedHeaders,\n    ...buildHeaders(token),\n  }\n  const clientOptions = {agent: await httpsAgent(), headers}\n\n  return {\n    client: new GraphQLClient(url, clientOptions),\n    headers,\n  }\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, unauthorizedHandler, cacheOptions} =\n    options\n  const requestBehaviour = requestMode(options.preferredBehaviour ?? 'default')\n\n  let {headers, client} = await createGraphQLClient({url, addedHeaders, token})\n  debugLogRequestInfo(api, queryAsString, url, variables, headers)\n\n  const rawGraphQLRequest = async () => {\n    let fullResponse: GraphQLResponse<TResult>\n    // there is a errorPolicy option which returns rather than throwing on errors, but we _do_ ultimately want to\n    // throw.\n    try {\n      // mapping signal to any due to polyfill meaning types don't exactly match (but are functionally equivalent)\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      client.requestConfig.signal = abortSignalFromRequestBehaviour(requestBehaviour) as any\n      fullResponse = await client.rawRequest<TResult>(queryAsString, variables)\n      await logLastRequestIdFromResponse(fullResponse)\n      return fullResponse\n    } catch (error) {\n      if (error instanceof ClientError) {\n        // error.response does have a headers property like a normal response, but it's not typed as such.\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        await logLastRequestIdFromResponse(error.response as any)\n      }\n      throw error\n    }\n  }\n\n  const tokenRefreshHandler = unauthorizedHandler?.handler\n\n  const tokenRefreshUnauthorizedHandlerFunction = tokenRefreshHandler\n    ? async () => {\n        const refreshTokenResult = await tokenRefreshHandler()\n        if (refreshTokenResult.token) {\n          const {client: newClient, headers: newHeaders} = await createGraphQLClient({\n            url,\n            addedHeaders,\n            token: refreshTokenResult.token,\n          })\n          client = newClient\n          headers = newHeaders\n          return true\n        } else {\n          return false\n        }\n      }\n    : undefined\n\n  const request = () =>\n    retryAwareRequest(\n      {request: rawGraphQLRequest, url, ...requestBehaviour},\n      responseOptions?.handleErrors === false ? undefined : errorHandler(api),\n    )\n\n  const executeWithTimer = () =>\n    runWithTimer('cmd_all_timing_network_ms')(async () => {\n      let response\n      try {\n        response = await request()\n      } catch (error) {\n        if (error instanceof ClientError && error.response.status === 401 && tokenRefreshUnauthorizedHandlerFunction) {\n          if (await tokenRefreshUnauthorizedHandlerFunction()) {\n            response = await request()\n          } else {\n            throw error\n          }\n        } else {\n          throw error\n        }\n      }\n\n      if (responseOptions?.onResponse) {\n        responseOptions.onResponse(response)\n      }\n      return response.data\n    })\n\n  // If there is no cache config for this query, just execute it and return the result.\n  if (cacheOptions === undefined) {\n    return executeWithTimer()\n  }\n\n  const {cacheTTL, cacheExtraKey, cacheStore} = cacheOptions\n\n  // The cache key is a combination of the hashed query and variables, with an optional extra key provided by the user.\n  const queryHash = nonRandomUUID(queryAsString)\n  const variablesHash = nonRandomUUID(JSON.stringify(variables ?? {}))\n  const cacheKey: GraphQLRequestKey = `q-${queryHash}-${variablesHash}-${CLI_KIT_VERSION}-${cacheExtraKey ?? ''}`\n\n  const result = await cacheRetrieveOrRepopulate(\n    cacheKey,\n    async () => {\n      const result = await executeWithTimer()\n      return JSON.stringify(result)\n    },\n    timeIntervalToMilliseconds(cacheTTL),\n    cacheStore,\n  )\n\n  return JSON.parse(result) as TResult\n}\n\nasync function logLastRequestIdFromResponse(response: GraphQLResponse<unknown>) {\n  try {\n    const requestId = response.headers.get('x-request-id')\n    requestIdsCollection.addRequestId(requestId)\n    await addPublicMetadata(() => ({\n      cmd_all_last_graphql_request_id: requestId ?? undefined,\n    }))\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    // no problem if unable to get request ID.\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,iBAAiB,EAAE,YAAY,EAAC,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAC,iBAAiB,EAAC,MAAM,8BAA8B,CAAA;AAC9D,OAAO,EAAC,oBAAoB,EAAC,MAAM,sCAAsC,CAAA;AACzE,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAA;AAC1C,OAAO,EACL,yBAAyB,EAIzB,0BAA0B,GAC3B,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAC,+BAA+B,EAAE,WAAW,EAAmB,MAAM,YAAY,CAAA;AACzF,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AACvD,OAAO,EACL,aAAa,EAGb,sBAAsB,EAEtB,WAAW,GACZ,MAAM,iBAAiB,CAAA;AA+DxB,KAAK,UAAU,mBAAmB,CAAC,EACjC,GAAG,EACH,YAAY,EACZ,KAAK,GAKN;IACC,MAAM,OAAO,GAAG;QACd,GAAG,YAAY;QACf,GAAG,YAAY,CAAC,KAAK,CAAC;KACvB,CAAA;IACD,MAAM,aAAa,GAAG,EAAC,KAAK,EAAE,MAAM,UAAU,EAAE,EAAE,OAAO,EAAC,CAAA;IAE1D,OAAO;QACL,MAAM,EAAE,IAAI,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC;QAC7C,OAAO;KACR,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,qBAAqB,CAAU,OAA8C;IAC1F,MAAM,EAAC,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,EAAC,GACjH,OAAO,CAAA;IACT,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,IAAI,SAAS,CAAC,CAAA;IAEtE,IAAI,EAAC,OAAO,EAAE,MAAM,EAAC,GAAG,MAAM,mBAAmB,CAAC,EAAC,GAAG,EAAE,YAAY,EAAE,KAAK,EAAC,CAAC,CAAA;IAC7E,mBAAmB,CAAC,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;IAEhE,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;QACnC,IAAI,YAAsC,CAAA;QAC1C,6GAA6G;QAC7G,SAAS;QACT,IAAI,CAAC;YACH,4GAA4G;YAC5G,8DAA8D;YAC9D,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,+BAA+B,CAAC,SAAS,CAAQ,CAAA;YAC/E,YAAY,GAAG,MAAM,MAAM,CAAC,UAAU,CAAU,aAAa,EAAE,SAAS,CAAC,CAAA;YACzE,MAAM,4BAA4B,CAAC,YAAY,CAAC,CAAA;YAChD,OAAO,YAAY,CAAA;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;gBACjC,kGAAkG;gBAClG,8DAA8D;gBAC9D,MAAM,4BAA4B,CAAC,KAAK,CAAC,QAAe,CAAC,CAAA;YAC3D,CAAC;YACD,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC,CAAA;IAED,MAAM,mBAAmB,GAAG,mBAAmB,EAAE,OAAO,CAAA;IAExD,MAAM,uCAAuC,GAAG,mBAAmB;QACjE,CAAC,CAAC,KAAK,IAAI,EAAE;YACT,MAAM,kBAAkB,GAAG,MAAM,mBAAmB,EAAE,CAAA;YACtD,IAAI,kBAAkB,CAAC,KAAK,EAAE,CAAC;gBAC7B,MAAM,EAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAC,GAAG,MAAM,mBAAmB,CAAC;oBACzE,GAAG;oBACH,YAAY;oBACZ,KAAK,EAAE,kBAAkB,CAAC,KAAK;iBAChC,CAAC,CAAA;gBACF,MAAM,GAAG,SAAS,CAAA;gBAClB,OAAO,GAAG,UAAU,CAAA;gBACpB,OAAO,IAAI,CAAA;YACb,CAAC;iBAAM,CAAC;gBACN,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QACH,CAAC,CAAC,SAAS,CAAA;IAEb,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,iBAAiB,CACf,EAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAG,SAAS,EAAC,EAC/C,eAAe,EAAE,YAAY,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CACxE,CAAA;IAEH,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAC5B,YAAY,CAAC,2BAA2B,CAAC,CAAC,KAAK,IAAI,EAAE;QACnD,IAAI,QAAQ,CAAA;QACZ,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAA;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,uCAAuC,EAAE,CAAC;gBAC7G,IAAI,MAAM,uCAAuC,EAAE,EAAE,CAAC;oBACpD,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAA;gBAC5B,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,CAAA;gBACb,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;QAED,IAAI,eAAe,EAAE,UAAU,EAAE,CAAC;YAChC,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QACtC,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC,CAAC,CAAA;IAEJ,qFAAqF;IACrF,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,gBAAgB,EAAE,CAAA;IAC3B,CAAC;IAED,MAAM,EAAC,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAC,GAAG,YAAY,CAAA;IAE1D,qHAAqH;IACrH,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC,CAAA;IAC9C,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAA;IACpE,MAAM,QAAQ,GAAsB,KAAK,SAAS,IAAI,aAAa,IAAI,eAAe,IAAI,aAAa,IAAI,EAAE,EAAE,CAAA;IAE/G,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAC5C,QAAQ,EACR,KAAK,IAAI,EAAE;QACT,MAAM,MAAM,GAAG,MAAM,gBAAgB,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC,EACD,0BAA0B,CAAC,QAAQ,CAAC,EACpC,UAAU,CACX,CAAA;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAY,CAAA;AACtC,CAAC;AAED,KAAK,UAAU,4BAA4B,CAAC,QAAkC;IAC5E,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QACtD,oBAAoB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QAC5C,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC;YAC7B,+BAA+B,EAAE,SAAS,IAAI,SAAS;SACxD,CAAC,CAAC,CAAA;QACH,qDAAqD;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,0CAA0C;IAC5C,CAAC;AACH,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 {addPublicMetadata, runWithTimer} from '../metadata.js'\nimport {retryAwareRequest} from '../../../private/node/api.js'\nimport {requestIdsCollection} from '../../../private/node/request-ids.js'\nimport {nonRandomUUID} from '../crypto.js'\nimport {\n  cacheRetrieveOrRepopulate,\n  ConfSchema,\n  GraphQLRequestKey,\n  TimeInterval,\n  timeIntervalToMilliseconds,\n} from '../../../private/node/conf-store.js'\nimport {LocalStorage} from '../local-storage.js'\nimport {abortSignalFromRequestBehaviour, requestMode, RequestModeInput} from '../http.js'\nimport {CLI_KIT_VERSION} from '../../common/version.js'\nimport {\n  GraphQLClient,\n  rawRequest,\n  RequestDocument,\n  resolveRequestDocument,\n  Variables,\n  ClientError,\n} 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\nexport interface CacheOptions {\n  cacheTTL: TimeInterval\n  cacheExtraKey?: string\n  cacheStore?: LocalStorage<ConfSchema>\n}\n\ninterface RefreshedTokenOnAuthorizedResponse {\n  token?: string\n}\n\nexport type RefreshTokenOnAuthorizedResponse = Promise<RefreshedTokenOnAuthorizedResponse>\n\nexport interface UnauthorizedHandler {\n  type: 'token_refresh'\n  handler: () => RefreshTokenOnAuthorizedResponse\n}\n\ninterface GraphQLRequestBaseOptions<TResult> {\n  api: string\n  url: string\n  token?: string\n  addedHeaders?: {[header: string]: string}\n  responseOptions?: GraphQLResponseOptions<TResult>\n  cacheOptions?: CacheOptions\n  preferredBehaviour?: RequestModeInput\n}\n\ntype PerformGraphQLRequestOptions<TResult> = GraphQLRequestBaseOptions<TResult> & {\n  queryAsString: string\n  variables?: Variables\n  unauthorizedHandler?: UnauthorizedHandler\n}\n\nexport type GraphQLRequestOptions<T> = GraphQLRequestBaseOptions<T> & {\n  query: RequestDocument\n  variables?: Variables\n  unauthorizedHandler?: UnauthorizedHandler\n}\n\nexport type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOptions<TResult> & {\n  query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{[key: string]: never}>>\n  variables?: TVariables\n  unauthorizedHandler?: UnauthorizedHandler\n}\n\nexport interface GraphQLResponseOptions<T> {\n  handleErrors?: boolean\n  onResponse?: (response: GraphQLResponse<T>) => void\n}\n\nasync function createGraphQLClient({\n  url,\n  addedHeaders,\n  token,\n}: {\n  url: string\n  token: string | undefined\n  addedHeaders?: {[header: string]: string}\n}) {\n  const headers = {\n    ...addedHeaders,\n    ...buildHeaders(token),\n  }\n  const clientOptions = {agent: await httpsAgent(), headers}\n\n  return {\n    client: new GraphQLClient(url, clientOptions),\n    headers,\n  }\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, unauthorizedHandler, cacheOptions} =\n    options\n  const behaviour = requestMode(options.preferredBehaviour ?? 'default')\n\n  let {headers, client} = await createGraphQLClient({url, addedHeaders, token})\n  debugLogRequestInfo(api, queryAsString, url, variables, headers)\n\n  const rawGraphQLRequest = async () => {\n    let fullResponse: GraphQLResponse<TResult>\n    // there is a errorPolicy option which returns rather than throwing on errors, but we _do_ ultimately want to\n    // throw.\n    try {\n      // mapping signal to any due to polyfill meaning types don't exactly match (but are functionally equivalent)\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      client.requestConfig.signal = abortSignalFromRequestBehaviour(behaviour) as any\n      fullResponse = await client.rawRequest<TResult>(queryAsString, variables)\n      await logLastRequestIdFromResponse(fullResponse)\n      return fullResponse\n    } catch (error) {\n      if (error instanceof ClientError) {\n        // error.response does have a headers property like a normal response, but it's not typed as such.\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        await logLastRequestIdFromResponse(error.response as any)\n      }\n      throw error\n    }\n  }\n\n  const tokenRefreshHandler = unauthorizedHandler?.handler\n\n  const tokenRefreshUnauthorizedHandlerFunction = tokenRefreshHandler\n    ? async () => {\n        const refreshTokenResult = await tokenRefreshHandler()\n        if (refreshTokenResult.token) {\n          const {client: newClient, headers: newHeaders} = await createGraphQLClient({\n            url,\n            addedHeaders,\n            token: refreshTokenResult.token,\n          })\n          client = newClient\n          headers = newHeaders\n          return true\n        } else {\n          return false\n        }\n      }\n    : undefined\n\n  const request = () =>\n    retryAwareRequest(\n      {request: rawGraphQLRequest, url, ...behaviour},\n      responseOptions?.handleErrors === false ? undefined : errorHandler(api),\n    )\n\n  const executeWithTimer = () =>\n    runWithTimer('cmd_all_timing_network_ms')(async () => {\n      let response\n      try {\n        response = await request()\n      } catch (error) {\n        if (error instanceof ClientError && error.response.status === 401 && tokenRefreshUnauthorizedHandlerFunction) {\n          if (await tokenRefreshUnauthorizedHandlerFunction()) {\n            response = await request()\n          } else {\n            throw error\n          }\n        } else {\n          throw error\n        }\n      }\n\n      if (responseOptions?.onResponse) {\n        responseOptions.onResponse(response)\n      }\n      return response.data\n    })\n\n  // If there is no cache config for this query, just execute it and return the result.\n  if (cacheOptions === undefined) {\n    return executeWithTimer()\n  }\n\n  const {cacheTTL, cacheExtraKey, cacheStore} = cacheOptions\n\n  // The cache key is a combination of the hashed query and variables, with an optional extra key provided by the user.\n  const queryHash = nonRandomUUID(queryAsString)\n  const variablesHash = nonRandomUUID(JSON.stringify(variables ?? {}))\n  const cacheKey: GraphQLRequestKey = `q-${queryHash}-${variablesHash}-${CLI_KIT_VERSION}-${cacheExtraKey ?? ''}`\n\n  const result = await cacheRetrieveOrRepopulate(\n    cacheKey,\n    async () => {\n      const result = await executeWithTimer()\n      return JSON.stringify(result)\n    },\n    timeIntervalToMilliseconds(cacheTTL),\n    cacheStore,\n  )\n\n  return JSON.parse(result) as TResult\n}\n\nasync function logLastRequestIdFromResponse(response: GraphQLResponse<unknown>) {\n  try {\n    const requestId = response.headers.get('x-request-id')\n    requestIdsCollection.addRequestId(requestId)\n    await addPublicMetadata(() => ({\n      cmd_all_last_graphql_request_id: requestId ?? undefined,\n    }))\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    // no problem if unable to get request ID.\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/archiver.js

@@ -1,4 +1,4 @@
-import { relativePath, joinPath } from './path.js';
+import { relativePath, joinPath, dirname } from './path.js';
 import { glob, removeFile } from './fs.js';
 import { outputDebug, outputContent, outputToken } from '../../public/node/output.js';
 import archiver from 'archiver';
@@ -31,14 +31,35 @@ export async function zip(options) {
             reject(error);
         });
         archive.pipe(output);
+        const directoriesToAdd = new Set();
         for (const filePath of pathsToZip) {
             const fileRelativePath = relativePath(inputDirectory, filePath);
-            archive.file(filePath, { name: fileRelativePath });
+            collectParentDirectories(fileRelativePath, directoriesToAdd);
+        }
+        const sortedDirs = Array.from(directoriesToAdd).sort((left, right) => left.localeCompare(right));
+        for (const dir of sortedDirs) {
+            const dirName = dir.endsWith('/') ? dir : `${dir}/`;
+            archive.append(Buffer.alloc(0), { name: dirName });
+        }
+        for (const filePath of pathsToZip) {
+            const fileRelativePath = relativePath(inputDirectory, filePath);
+            if (filePath && fileRelativePath)
+                archive.file(filePath, { name: fileRelativePath });
         }
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         archive.finalize();
     });
 }
+function collectParentDirectories(fileRelativePath, accumulator) {
+    let currentDir = dirname(fileRelativePath);
+    while (currentDir && currentDir !== '.' && currentDir !== '/') {
+        accumulator.add(currentDir);
+        const parent = dirname(currentDir);
+        if (parent === currentDir)
+            break;
+        currentDir = parent;
+    }
+}
 /**
  * It compresses a directory with Brotli.
  * First creates a tar archive to preserve directory structure,
@@ -70,7 +91,7 @@ export async function brotliCompress(options) {
                 // eslint-disable-next-line @typescript-eslint/no-floating-promises
                 archive.finalize();
             })
-                .catch((error) => reject(error));
+                .catch((error) => reject(error instanceof Error ? error : new Error(String(error))));
         });
         const tarContent = readFileSync(tempTarPath);
         const brotli = await import('brotli');

package/dist/public/node/archiver.js.map

@@ -1 +1 @@
-{"version":3,"file":"archiver.js","sourceRoot":"","sources":["../../../src/public/node/archiver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAA;AAChD,OAAO,EAAC,IAAI,EAAE,UAAU,EAAC,MAAM,SAAS,CAAA;AACxC,OAAO,EAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACnF,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAC,MAAM,IAAI,CAAA;AACjE,OAAO,EAAC,MAAM,EAAC,MAAM,IAAI,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,QAAQ,CAAA;AAmBjC;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,OAAmB;IAC3C,MAAM,EAAC,cAAc,EAAE,aAAa,EAAE,gBAAgB,GAAG,MAAM,EAAC,GAAG,OAAO,CAAA;IAC1E,WAAW,CAAC,aAAa,CAAA,WAAW,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAA;IAC/G,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE;QAC9C,GAAG,EAAE,cAAc;QACnB,QAAQ,EAAE,IAAI;QACd,GAAG,EAAE,IAAI;QACT,mBAAmB,EAAE,KAAK;KAC3B,CAAC,CAAA;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QAE/B,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAA;QAC/C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,OAAO,EAAE,CAAA;QACX,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEpB,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;YAC/D,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;QAClD,CAAC;QAED,mEAAmE;QACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;AACJ,CAAC;AAuCD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAsB;IACzD,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,GAAG,UAAU,EAAE,MAAM,CAAC,CAAA;IAE7D,IAAI,CAAC;QACH,oCAAoC;QACpC,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC/B,MAAM,MAAM,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA;YAE7C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;YACnC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAEpB,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,MAAM,EAAE;gBACvC,GAAG,EAAE,OAAO,CAAC,cAAc;gBAC3B,QAAQ,EAAE,IAAI;gBACd,GAAG,EAAE,IAAI;gBACT,mBAAmB,EAAE,KAAK;aAC3B,CAAC;iBACC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE;gBACnB,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClC,MAAM,gBAAgB,GAAG,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;oBACvE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;gBAClD,CAAC;gBACD,mEAAmE;gBACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;YACpB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;QAEF,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAC5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE;YACrD,OAAO,EAAE,CAAC;YACV,IAAI,EAAE,CAAC;SACR,CAAC,CAAA;QAEF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAC9C,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;IAC/C,CAAC;YAAS,CAAC;QACT,IAAI,CAAC;YACH,MAAM,UAAU,CAAC,WAAW,CAAC,CAAA;YAC7B,qDAAqD;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,aAAa,CAAA,sCAAsC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;QACjG,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["import {relativePath, joinPath} from './path.js'\nimport {glob, removeFile} from './fs.js'\nimport {outputDebug, outputContent, outputToken} from '../../public/node/output.js'\nimport archiver from 'archiver'\nimport {createWriteStream, readFileSync, writeFileSync} from 'fs'\nimport {tmpdir} from 'os'\nimport {randomUUID} from 'crypto'\n\ninterface ZipOptions {\n  /**\n   * The absolute path to the directory to be zipped.\n   */\n  inputDirectory: string\n\n  /**\n   * The absolute path to the output zip file.\n   */\n  outputZipPath: string\n\n  /**\n   * Pattern(s) to match when adding files to zip, uses glob expressions.\n   */\n  matchFilePattern?: string | string[]\n}\n\n/**\n * It zips a directory and by default normalizes the paths to be forward-slash.\n * Even with forward-slash paths, zip files should still be able to be opened on\n * Windows.\n *\n * @param options - ZipOptions.\n */\nexport async function zip(options: ZipOptions): Promise<void> {\n  const {inputDirectory, outputZipPath, matchFilePattern = '**/*'} = options\n  outputDebug(outputContent`Zipping ${outputToken.path(inputDirectory)} into ${outputToken.path(outputZipPath)}`)\n  const pathsToZip = await glob(matchFilePattern, {\n    cwd: inputDirectory,\n    absolute: true,\n    dot: true,\n    followSymbolicLinks: false,\n  })\n\n  return new Promise((resolve, reject) => {\n    const archive = archiver('zip')\n\n    const output = createWriteStream(outputZipPath)\n    output.on('close', () => {\n      resolve()\n    })\n    archive.on('error', (error) => {\n      reject(error)\n    })\n    archive.pipe(output)\n\n    for (const filePath of pathsToZip) {\n      const fileRelativePath = relativePath(inputDirectory, filePath)\n      archive.file(filePath, {name: fileRelativePath})\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\n    archive.finalize()\n  })\n}\n\nexport interface BrotliOptions {\n  /**\n   * The directory to compress.\n   */\n  inputDirectory: string\n\n  /**\n   * The path where the compressed file will be saved.\n   */\n  outputPath: string\n\n  /**\n   * An optional glob pattern to match files.\n   */\n  matchFilePattern?: string | string[]\n\n  /**\n   * Brotli compression level (0-11, default: 11).\n   */\n  level?: number\n}\n\n/**\n * Options for decompressing a Brotli compressed tar archive.\n */\nexport interface DecompressionOptions {\n  /**\n   * Path to the compressed file.\n   */\n  inputFile: string\n\n  /**\n   * Directory where files should be extracted.\n   */\n  outputDirectory: string\n}\n\n/**\n * It compresses a directory with Brotli.\n * First creates a tar archive to preserve directory structure,\n * then compresses it with Brotli.\n *\n * @param options - BrotliOptions.\n */\nexport async function brotliCompress(options: BrotliOptions): Promise<void> {\n  const tempTarPath = joinPath(tmpdir(), `${randomUUID()}.tar`)\n\n  try {\n    // Create tar archive using archiver\n    await new Promise<void>((resolve, reject) => {\n      const archive = archiver('tar')\n      const output = createWriteStream(tempTarPath)\n\n      output.on('close', () => resolve())\n      archive.on('error', (error) => reject(error))\n      archive.pipe(output)\n\n      glob(options.matchFilePattern ?? '**/*', {\n        cwd: options.inputDirectory,\n        absolute: true,\n        dot: true,\n        followSymbolicLinks: false,\n      })\n        .then((pathsToZip) => {\n          for (const filePath of pathsToZip) {\n            const fileRelativePath = relativePath(options.inputDirectory, filePath)\n            archive.file(filePath, {name: fileRelativePath})\n          }\n          // eslint-disable-next-line @typescript-eslint/no-floating-promises\n          archive.finalize()\n        })\n        .catch((error) => reject(error))\n    })\n\n    const tarContent = readFileSync(tempTarPath)\n    const brotli = await import('brotli')\n    const compressed = brotli.default.compress(tarContent, {\n      quality: 7,\n      mode: 0,\n    })\n\n    if (!compressed) {\n      throw new Error('Brotli compression failed')\n    }\n\n    writeFileSync(options.outputPath, compressed)\n  } finally {\n    try {\n      await removeFile(tempTarPath)\n      // eslint-disable-next-line no-catch-all/no-catch-all\n    } catch (error) {\n      outputDebug(outputContent`Failed to clean up temporary file: ${outputToken.path(tempTarPath)}`)\n    }\n  }\n}\n"]}
+{"version":3,"file":"archiver.js","sourceRoot":"","sources":["../../../src/public/node/archiver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAC,MAAM,WAAW,CAAA;AACzD,OAAO,EAAC,IAAI,EAAE,UAAU,EAAC,MAAM,SAAS,CAAA;AACxC,OAAO,EAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACnF,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAC,MAAM,IAAI,CAAA;AACjE,OAAO,EAAC,MAAM,EAAC,MAAM,IAAI,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,QAAQ,CAAA;AAmBjC;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,OAAmB;IAC3C,MAAM,EAAC,cAAc,EAAE,aAAa,EAAE,gBAAgB,GAAG,MAAM,EAAC,GAAG,OAAO,CAAA;IAC1E,WAAW,CAAC,aAAa,CAAA,WAAW,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAA;IAC/G,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE;QAC9C,GAAG,EAAE,cAAc;QACnB,QAAQ,EAAE,IAAI;QACd,GAAG,EAAE,IAAI;QACT,mBAAmB,EAAE,KAAK;KAC3B,CAAC,CAAA;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QAE/B,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAA;QAC/C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,OAAO,EAAE,CAAA;QACX,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEpB,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAA;QAC1C,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;YAC/D,wBAAwB,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;QAC9D,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;QAChG,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAA;YACnD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAC,IAAI,EAAE,OAAO,EAAC,CAAC,CAAA;QAClD,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;YAC/D,IAAI,QAAQ,IAAI,gBAAgB;gBAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;QACpF,CAAC;QAED,mEAAmE;QACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,gBAAwB,EAAE,WAAwB;IAClF,IAAI,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAC1C,OAAO,UAAU,IAAI,UAAU,KAAK,GAAG,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;QAC9D,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;QAClC,IAAI,MAAM,KAAK,UAAU;YAAE,MAAK;QAChC,UAAU,GAAG,MAAM,CAAA;IACrB,CAAC;AACH,CAAC;AAuCD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAsB;IACzD,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,GAAG,UAAU,EAAE,MAAM,CAAC,CAAA;IAE7D,IAAI,CAAC;QACH,oCAAoC;QACpC,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC/B,MAAM,MAAM,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA;YAE7C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;YACnC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAEpB,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,MAAM,EAAE;gBACvC,GAAG,EAAE,OAAO,CAAC,cAAc;gBAC3B,QAAQ,EAAE,IAAI;gBACd,GAAG,EAAE,IAAI;gBACT,mBAAmB,EAAE,KAAK;aAC3B,CAAC;iBACC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE;gBACnB,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClC,MAAM,gBAAgB,GAAG,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;oBACvE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;gBAClD,CAAC;gBACD,mEAAmE;gBACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;YACpB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QACxF,CAAC,CAAC,CAAA;QAEF,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAC5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE;YACrD,OAAO,EAAE,CAAC;YACV,IAAI,EAAE,CAAC;SACR,CAAC,CAAA;QAEF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAC9C,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;IAC/C,CAAC;YAAS,CAAC;QACT,IAAI,CAAC;YACH,MAAM,UAAU,CAAC,WAAW,CAAC,CAAA;YAC7B,qDAAqD;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,aAAa,CAAA,sCAAsC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;QACjG,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["import {relativePath, joinPath, dirname} from './path.js'\nimport {glob, removeFile} from './fs.js'\nimport {outputDebug, outputContent, outputToken} from '../../public/node/output.js'\nimport archiver from 'archiver'\nimport {createWriteStream, readFileSync, writeFileSync} from 'fs'\nimport {tmpdir} from 'os'\nimport {randomUUID} from 'crypto'\n\ninterface ZipOptions {\n  /**\n   * The absolute path to the directory to be zipped.\n   */\n  inputDirectory: string\n\n  /**\n   * The absolute path to the output zip file.\n   */\n  outputZipPath: string\n\n  /**\n   * Pattern(s) to match when adding files to zip, uses glob expressions.\n   */\n  matchFilePattern?: string | string[]\n}\n\n/**\n * It zips a directory and by default normalizes the paths to be forward-slash.\n * Even with forward-slash paths, zip files should still be able to be opened on\n * Windows.\n *\n * @param options - ZipOptions.\n */\nexport async function zip(options: ZipOptions): Promise<void> {\n  const {inputDirectory, outputZipPath, matchFilePattern = '**/*'} = options\n  outputDebug(outputContent`Zipping ${outputToken.path(inputDirectory)} into ${outputToken.path(outputZipPath)}`)\n  const pathsToZip = await glob(matchFilePattern, {\n    cwd: inputDirectory,\n    absolute: true,\n    dot: true,\n    followSymbolicLinks: false,\n  })\n\n  return new Promise((resolve, reject) => {\n    const archive = archiver('zip')\n\n    const output = createWriteStream(outputZipPath)\n    output.on('close', () => {\n      resolve()\n    })\n    archive.on('error', (error) => {\n      reject(error)\n    })\n    archive.pipe(output)\n\n    const directoriesToAdd = new Set<string>()\n    for (const filePath of pathsToZip) {\n      const fileRelativePath = relativePath(inputDirectory, filePath)\n      collectParentDirectories(fileRelativePath, directoriesToAdd)\n    }\n\n    const sortedDirs = Array.from(directoriesToAdd).sort((left, right) => left.localeCompare(right))\n    for (const dir of sortedDirs) {\n      const dirName = dir.endsWith('/') ? dir : `${dir}/`\n      archive.append(Buffer.alloc(0), {name: dirName})\n    }\n\n    for (const filePath of pathsToZip) {\n      const fileRelativePath = relativePath(inputDirectory, filePath)\n      if (filePath && fileRelativePath) archive.file(filePath, {name: fileRelativePath})\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\n    archive.finalize()\n  })\n}\n\nfunction collectParentDirectories(fileRelativePath: string, accumulator: Set<string>): void {\n  let currentDir = dirname(fileRelativePath)\n  while (currentDir && currentDir !== '.' && currentDir !== '/') {\n    accumulator.add(currentDir)\n    const parent = dirname(currentDir)\n    if (parent === currentDir) break\n    currentDir = parent\n  }\n}\n\nexport interface BrotliOptions {\n  /**\n   * The directory to compress.\n   */\n  inputDirectory: string\n\n  /**\n   * The path where the compressed file will be saved.\n   */\n  outputPath: string\n\n  /**\n   * An optional glob pattern to match files.\n   */\n  matchFilePattern?: string | string[]\n\n  /**\n   * Brotli compression level (0-11, default: 11).\n   */\n  level?: number\n}\n\n/**\n * Options for decompressing a Brotli compressed tar archive.\n */\nexport interface DecompressionOptions {\n  /**\n   * Path to the compressed file.\n   */\n  inputFile: string\n\n  /**\n   * Directory where files should be extracted.\n   */\n  outputDirectory: string\n}\n\n/**\n * It compresses a directory with Brotli.\n * First creates a tar archive to preserve directory structure,\n * then compresses it with Brotli.\n *\n * @param options - BrotliOptions.\n */\nexport async function brotliCompress(options: BrotliOptions): Promise<void> {\n  const tempTarPath = joinPath(tmpdir(), `${randomUUID()}.tar`)\n\n  try {\n    // Create tar archive using archiver\n    await new Promise<void>((resolve, reject) => {\n      const archive = archiver('tar')\n      const output = createWriteStream(tempTarPath)\n\n      output.on('close', () => resolve())\n      archive.on('error', (error) => reject(error))\n      archive.pipe(output)\n\n      glob(options.matchFilePattern ?? '**/*', {\n        cwd: options.inputDirectory,\n        absolute: true,\n        dot: true,\n        followSymbolicLinks: false,\n      })\n        .then((pathsToZip) => {\n          for (const filePath of pathsToZip) {\n            const fileRelativePath = relativePath(options.inputDirectory, filePath)\n            archive.file(filePath, {name: fileRelativePath})\n          }\n          // eslint-disable-next-line @typescript-eslint/no-floating-promises\n          archive.finalize()\n        })\n        .catch((error) => reject(error instanceof Error ? error : new Error(String(error))))\n    })\n\n    const tarContent = readFileSync(tempTarPath)\n    const brotli = await import('brotli')\n    const compressed = brotli.default.compress(tarContent, {\n      quality: 7,\n      mode: 0,\n    })\n\n    if (!compressed) {\n      throw new Error('Brotli compression failed')\n    }\n\n    writeFileSync(options.outputPath, compressed)\n  } finally {\n    try {\n      await removeFile(tempTarPath)\n      // eslint-disable-next-line no-catch-all/no-catch-all\n    } catch (error) {\n      outputDebug(outputContent`Failed to clean up temporary file: ${outputToken.path(tempTarPath)}`)\n    }\n  }\n}\n"]}

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

@@ -324,4 +324,11 @@ export declare function matchGlob(key: string, pattern: string, options?: MatchG
  * @returns A promise that resolves to an array of file names.
  */
 export declare function readdir(path: string): Promise<string[]>;
+/**
+ * Copies the contents of a directory to another directory.
+ *
+ * @param srcDir - Source directory path.
+ * @param destDir - Destination directory path.
+ */
+export declare function copyDirectoryContents(srcDir: string, destDir: string): Promise<void>;
 export {};