@shopify/cli-kit 3.65.2 → 3.66.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/cli-kit",
-  "version": "3.65.2",
+  "version": "3.66.0",
   "private": false,
   "description": "A set of utilities, interfaces, and models that are common across all the platform features",
   "keywords": [
@@ -156,8 +156,7 @@
     "node-stream-zip": "^1.15.0",
     "ts-morph": "^17.0.1",
     "typedoc": "^0.25.7",
-    "typescript": "5.2.2",
-    "vitest": "^1.6.0"
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": "^18.20.0 || >=20.10.0"

package/dist/private/node/themes/themes-api/headers.d.ts

@@ -1,3 +0,0 @@
-import { RestResponse } from '@shopify/cli-kit/node/api/admin';
-export declare function retryAfter(response: RestResponse): number;
-export declare function apiCallLimit(response: RestResponse): [number, number] | undefined;

package/dist/private/node/themes/themes-api/headers.js

@@ -1,29 +0,0 @@
-import { tryParseInt } from '@shopify/cli-kit/common/string';
-export function retryAfter(response) {
-    const retryAfterStr = header(response, 'retry-after');
-    const retryAfter = tryParseInt(retryAfterStr);
-    if (!retryAfter) {
-        return 0;
-    }
-    return retryAfter;
-}
-export function apiCallLimit(response) {
-    const apiCallLimit = header(response, 'x-shopify-shop-api-call-limit');
-    const [used, limit] = apiCallLimit
-        .split('/')
-        .map((num) => tryParseInt(num))
-        .filter(Boolean);
-    if (!used || !limit) {
-        return;
-    }
-    return [used, limit];
-}
-function header(response, name) {
-    const headers = response.headers;
-    const header = headers[name];
-    if (header?.length === 1) {
-        return header[0] ?? '';
-    }
-    return '';
-}
-//# sourceMappingURL=headers.js.map

package/dist/private/node/themes/themes-api/headers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"headers.js","sourceRoot":"","sources":["../../../../../src/private/node/themes/themes-api/headers.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,WAAW,EAAC,MAAM,gCAAgC,CAAA;AAE1D,MAAM,UAAU,UAAU,CAAC,QAAsB;IAC/C,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IACrD,MAAM,UAAU,GAAG,WAAW,CAAC,aAAa,CAAC,CAAA;IAE7C,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,CAAC,CAAA;KACT;IAED,OAAO,UAAU,CAAA;AACnB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,QAAsB;IACjD,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,+BAA+B,CAAC,CAAA;IAEtE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,YAAY;SAC/B,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SAC9B,MAAM,CAAC,OAAO,CAAC,CAAA;IAElB,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE;QACnB,OAAM;KACP;IAED,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;AACtB,CAAC;AAED,SAAS,MAAM,CAAC,QAAsB,EAAE,IAAY;IAClD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5B,IAAI,MAAM,EAAE,MAAM,KAAK,CAAC,EAAE;QACxB,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;KACvB;IAED,OAAO,EAAE,CAAA;AACX,CAAC","sourcesContent":["import {RestResponse} from '@shopify/cli-kit/node/api/admin'\nimport {tryParseInt} from '@shopify/cli-kit/common/string'\n\nexport function retryAfter(response: RestResponse): number {\n  const retryAfterStr = header(response, 'retry-after')\n  const retryAfter = tryParseInt(retryAfterStr)\n\n  if (!retryAfter) {\n    return 0\n  }\n\n  return retryAfter\n}\n\nexport function apiCallLimit(response: RestResponse): [number, number] | undefined {\n  const apiCallLimit = header(response, 'x-shopify-shop-api-call-limit')\n\n  const [used, limit] = apiCallLimit\n    .split('/')\n    .map((num) => tryParseInt(num))\n    .filter(Boolean)\n\n  if (!used || !limit) {\n    return\n  }\n\n  return [used, limit]\n}\n\nfunction header(response: RestResponse, name: string): string {\n  const headers = response.headers\n  const header = headers[name]\n\n  if (header?.length === 1) {\n    return header[0] ?? ''\n  }\n\n  return ''\n}\n"]}

package/dist/private/node/themes/themes-api/retry.d.ts

@@ -1 +0,0 @@
-export declare function retry<T>(operation: () => T, retryDelay: number): Promise<T>;

package/dist/private/node/themes/themes-api/retry.js

@@ -1,6 +0,0 @@
-export async function retry(operation, retryDelay) {
-    return new Promise((resolve, _reject) => {
-        setTimeout(() => resolve(operation()), retryDelay);
-    });
-}
-//# sourceMappingURL=retry.js.map

package/dist/private/node/themes/themes-api/retry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"retry.js","sourceRoot":"","sources":["../../../../../src/private/node/themes/themes-api/retry.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,KAAK,CAAI,SAAkB,EAAE,UAAkB;IACnE,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACzC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,UAAU,CAAC,CAAA;IACpD,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["export async function retry<T>(operation: () => T, retryDelay: number) {\n  return new Promise<T>((resolve, _reject) => {\n    setTimeout(() => resolve(operation()), retryDelay)\n  })\n}\n"]}

package/dist/private/node/themes/themes-api/throttler.d.ts

@@ -1,2 +0,0 @@
-export declare function throttle<T>(request: () => T): Promise<T>;
-export declare function updateApiCallLimit(callLimit: [number, number] | undefined): void;

package/dist/private/node/themes/themes-api/throttler.js

@@ -1,82 +0,0 @@
-const MAX_NUMBER_OF_PARALLEL_REQUESTS = 5;
-const MARGIN_TO_RATE_LIMIT = 5;
-export async function throttle(request) {
-    return new Promise((resolve, _reject) => {
-        const performRequest = () => {
-            throttlingState().requestCounter += 1;
-            resolve(request());
-        };
-        /**
-         * Performs the {@link performRequest} taking into account the
-         * limit of parallel requests only when the API limit has not
-         * been reached.
-         *
-         * Otherwise, performs the request to get the updated API limit
-         * headers, so throttler parameters get updates.
-         */
-        const throttleByHeader = () => {
-            if (!isReachingApiLimit()) {
-                throttleByCounter(performRequest);
-                return;
-            }
-            setTimeout(() => throttleByCounter(performRequest), 4000);
-        };
-        /**
-         * Performs the {@link command} only when the the limit
-         * of parallel request has not been reached.
-         *
-         * Otherwise, defers the execution to the {@link throttleByHeader},
-         * still respecting the limit of parallel requests.
-         */
-        const throttleByCounter = (command) => {
-            if (!hasTooManyRequests()) {
-                command();
-                return;
-            }
-            setTimeout(() => throttleByCounter(throttleByHeader), 1000);
-        };
-        /**
-         * Start throttling by counter to get the API limit headers.
-         */
-        throttleByCounter(throttleByHeader);
-    }).finally(() => {
-        throttlingState().requestCounter -= 1;
-    });
-}
-export function updateApiCallLimit(callLimit) {
-    if (!callLimit) {
-        return;
-    }
-    const [used, limit] = callLimit;
-    latestRequestInfo().apiCallLimit = { used, limit };
-}
-function hasTooManyRequests() {
-    return throttlingState().requestCounter > MAX_NUMBER_OF_PARALLEL_REQUESTS;
-}
-function isReachingApiLimit() {
-    const { used, limit } = latestRequestInfo().apiCallLimit;
-    return used >= limit - MARGIN_TO_RATE_LIMIT;
-}
-function latestRequestInfo() {
-    return throttlingState().latestRequestInfo;
-}
-/**
- * Even considering the Stateless modules convention,
- * tracking information about the latest request is
- * critical to optimize the request throttler efficiently.
- *
- * Thus, in this case, this module deliberately avoids
- * IO cost and uses the `_throttlingState` instance for
- * that purpose.
- */
-function throttlingState() {
-    return (_throttlingState ??
-        (_throttlingState = {
-            requestCounter: 0,
-            latestRequestInfo: {
-                apiCallLimit: { used: 0, limit: 40 },
-            },
-        }));
-}
-let _throttlingState;
-//# sourceMappingURL=throttler.js.map

package/dist/private/node/themes/themes-api/throttler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"throttler.js","sourceRoot":"","sources":["../../../../../src/private/node/themes/themes-api/throttler.ts"],"names":[],"mappings":"AAAA,MAAM,+BAA+B,GAAG,CAAC,CAAA;AACzC,MAAM,oBAAoB,GAAG,CAAC,CAAA;AAE9B,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,OAAgB;IAChD,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACzC,MAAM,cAAc,GAAG,GAAG,EAAE;YAC1B,eAAe,EAAE,CAAC,cAAc,IAAI,CAAC,CAAA;YACrC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;QACpB,CAAC,CAAA;QAED;;;;;;;WAOG;QACH,MAAM,gBAAgB,GAAG,GAAG,EAAE;YAC5B,IAAI,CAAC,kBAAkB,EAAE,EAAE;gBACzB,iBAAiB,CAAC,cAAc,CAAC,CAAA;gBACjC,OAAM;aACP;YAED,UAAU,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC,CAAA;QAC3D,CAAC,CAAA;QAED;;;;;;WAMG;QACH,MAAM,iBAAiB,GAAG,CAAC,OAAmB,EAAE,EAAE;YAChD,IAAI,CAAC,kBAAkB,EAAE,EAAE;gBACzB,OAAO,EAAE,CAAA;gBACT,OAAM;aACP;YAED,UAAU,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,CAAA;QAC7D,CAAC,CAAA;QAED;;WAEG;QACH,iBAAiB,CAAC,gBAAgB,CAAC,CAAA;IACrC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;QACd,eAAe,EAAE,CAAC,cAAc,IAAI,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAuC;IACxE,IAAI,CAAC,SAAS,EAAE;QACd,OAAM;KACP;IAED,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,SAAS,CAAA;IAE/B,iBAAiB,EAAE,CAAC,YAAY,GAAG,EAAC,IAAI,EAAE,KAAK,EAAC,CAAA;AAClD,CAAC;AAED,SAAS,kBAAkB;IACzB,OAAO,eAAe,EAAE,CAAC,cAAc,GAAG,+BAA+B,CAAA;AAC3E,CAAC;AAED,SAAS,kBAAkB;IACzB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,iBAAiB,EAAE,CAAC,YAAY,CAAA;IACtD,OAAO,IAAI,IAAI,KAAK,GAAG,oBAAoB,CAAA;AAC7C,CAAC;AAED,SAAS,iBAAiB;IACxB,OAAO,eAAe,EAAE,CAAC,iBAAiB,CAAA;AAC5C,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe;IACtB,OAAO,CACL,gBAAgB;QAChB,CAAC,gBAAgB,GAAG;YAClB,cAAc,EAAE,CAAC;YACjB,iBAAiB,EAAE;gBACjB,YAAY,EAAE,EAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAC;aACnC;SACF,CAAC,CACH,CAAA;AACH,CAAC;AAED,IAAI,gBAUH,CAAA","sourcesContent":["const MAX_NUMBER_OF_PARALLEL_REQUESTS = 5\nconst MARGIN_TO_RATE_LIMIT = 5\n\nexport async function throttle<T>(request: () => T) {\n  return new Promise<T>((resolve, _reject) => {\n    const performRequest = () => {\n      throttlingState().requestCounter += 1\n      resolve(request())\n    }\n\n    /**\n     * Performs the {@link performRequest} taking into account the\n     * limit of parallel requests only when the API limit has not\n     * been reached.\n     *\n     * Otherwise, performs the request to get the updated API limit\n     * headers, so throttler parameters get updates.\n     */\n    const throttleByHeader = () => {\n      if (!isReachingApiLimit()) {\n        throttleByCounter(performRequest)\n        return\n      }\n\n      setTimeout(() => throttleByCounter(performRequest), 4000)\n    }\n\n    /**\n     * Performs the {@link command} only when the the limit\n     * of parallel request has not been reached.\n     *\n     * Otherwise, defers the execution to the {@link throttleByHeader},\n     * still respecting the limit of parallel requests.\n     */\n    const throttleByCounter = (command: () => void) => {\n      if (!hasTooManyRequests()) {\n        command()\n        return\n      }\n\n      setTimeout(() => throttleByCounter(throttleByHeader), 1000)\n    }\n\n    /**\n     * Start throttling by counter to get the API limit headers.\n     */\n    throttleByCounter(throttleByHeader)\n  }).finally(() => {\n    throttlingState().requestCounter -= 1\n  })\n}\n\nexport function updateApiCallLimit(callLimit: [number, number] | undefined) {\n  if (!callLimit) {\n    return\n  }\n\n  const [used, limit] = callLimit\n\n  latestRequestInfo().apiCallLimit = {used, limit}\n}\n\nfunction hasTooManyRequests() {\n  return throttlingState().requestCounter > MAX_NUMBER_OF_PARALLEL_REQUESTS\n}\n\nfunction isReachingApiLimit() {\n  const {used, limit} = latestRequestInfo().apiCallLimit\n  return used >= limit - MARGIN_TO_RATE_LIMIT\n}\n\nfunction latestRequestInfo() {\n  return throttlingState().latestRequestInfo\n}\n\n/**\n * Even considering the Stateless modules convention,\n * tracking information about the latest request is\n * critical to optimize the request throttler efficiently.\n *\n * Thus, in this case, this module deliberately avoids\n * IO cost and uses the `_throttlingState` instance for\n * that purpose.\n */\nfunction throttlingState() {\n  return (\n    _throttlingState ??\n    (_throttlingState = {\n      requestCounter: 0,\n      latestRequestInfo: {\n        apiCallLimit: {used: 0, limit: 40},\n      },\n    })\n  )\n}\n\nlet _throttlingState: {\n  /**\n   * Number of parallel requests */\n  requestCounter: number\n\n  /**\n   * Latest request information */\n  latestRequestInfo: {\n    apiCallLimit: {used: number; limit: number}\n  }\n}\n"]}