@shopify/cli-kit 4.9.5 → 5.0.0

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,cAAc,CAAA;AACvD,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,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,8BAA8B,CAAA;AAChF,OAAO,EAAmB,YAAY,EAAC,MAAM,YAAY,CAAA;AACzD,OAAO,EAAC,iBAAiB,EAAC,MAAM,iEAAiE,CAAA;AACjG,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;AAItD,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAkB,CAAA;AAExD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,KAAa,EACb,OAAqB,EACrB,SAA4B,EAC5B,OAAgB;IAEhB,MAAM,GAAG,GAAG,OAAO,CAAA;IACnB,MAAM,UAAU,GAAG,OAAO,IAAI,CAAC,MAAM,8BAA8B,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7E,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAA;IACnC,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,UAAU,EAAE,OAAO,CAAC,CAAA;IACtD,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,UAAU,KAAK,MAAM,8BAA8B,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IAChF,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAA;IACnC,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;IAE3E,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,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAqB,EACrB,kBAAqC;IAErC,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,wDAAwD,WAAW,CAAC,IAAI,CACnF,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;QAED,2FAA2F;QAC3F,+DAA+D;QAC/D,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAClE,MAAM,IAAI,UAAU,CAClB,aAAa,OAAO,CAAC,SAAS,4BAA4B,EAC1D,uIAAuI,CACxI,CAAA;QACH,CAAC;QAED,4FAA4F;QAC5F,8FAA8F;QAC9F,2DAA2D;QAC3D,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACjE,MAAM,IAAI,UAAU,CAClB,qBAAqB,OAAO,CAAC,SAAS,kCAAkC,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,EACjG,4FAA4F,CAC7F,CAAA;QACH,CAAC;QAED,qFAAqF;QACrF,sFAAsF;QACtF,qBAAqB;QACrB,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,UAAU,CAClB,cAAc,OAAO,CAAC,SAAS,mCAAmC,EAClE,mGAAmG,CACpG,CAAA;QACH,CAAC;QAED,2GAA2G;QAC3G,2EAA2E;QAC3E,+EAA+E;QAC/E,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,UAAU,CAClB,0CAA0C,OAAO,CAAC,SAAS,KACzD,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CACvD,EAAE,EACF,+CAA+C,CAChD,CAAA;QACH,CAAC;QAED,4CAA4C;QAC5C,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;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,eAAuC,EAAE,EACzC,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 '../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 {isAbortedFetchError, isNetworkError} from '../../../private/node/api.js'\nimport {RequestModeInput, shopifyFetch} from '../http.js'\nimport {PublicApiVersions} from '../../../cli/api/graphql/admin/generated/public_api_versions.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'\n\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 * @param version - API version.\n * @returns The response of the query of generic type <T>.\n */\nexport async function adminRequest<T>(\n  query: string,\n  session: AdminSession,\n  variables?: GraphQLVariables,\n  version?: string,\n): Promise<T> {\n  const api = 'Admin'\n  const apiVersion = version ?? (await fetchLatestSupportedApiVersion(session))\n  let storeDomain = 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, apiVersion, 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  apiVersion ??= await fetchLatestSupportedApiVersion(session, preferredBehaviour)\n  let storeDomain = 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): Record<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\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 */\nexport async function fetchApiVersions(\n  session: AdminSession,\n  preferredBehaviour?: RequestModeInput,\n): 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 to 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    }\n\n    // HTTP 402 means the shop is frozen, paused, or closed. That is a store state the user can\n    // fix, not a CLI bug, so it must not reach the BugError below.\n    if (error instanceof ClientError && error.response.status === 402) {\n      throw new AbortError(\n        `The store ${session.storeFqdn} is currently unavailable.`,\n        'This usually means the store is frozen, paused, or closed. Check the store in the Shopify admin and try again once it is reactivated.',\n      )\n    }\n\n    // HTTP 5xx is a Shopify-side failure. This query takes no user input, so the user's command\n    // cannot have caused it. `isExpectedApiError` covers 502/503/504, but only for raw errors, so\n    // it never sees one we have already wrapped in a BugError.\n    if (error instanceof ClientError && error.response.status >= 500) {\n      throw new AbortError(\n        `The Admin API for ${session.storeFqdn} returned a server error (HTTP ${error.response.status}).`,\n        'This is a problem on the Shopify side, not with your command. Wait a moment and try again.',\n      )\n    }\n\n    // A cancelled request is neither a store-state failure nor a CLI bug. Checked before\n    // `isNetworkError` so the message says the request was aborted instead of blaming the\n    // user's connection.\n    if (isAbortedFetchError(error)) {\n      throw new AbortError(\n        `Request to ${session.storeFqdn} was aborted before it completed.`,\n        'The request was cancelled or timed out before the store responded. Try running the command again.',\n      )\n    }\n\n    // Check for network-level errors (connection issues, timeouts, DNS failures, TLS/certificate errors, etc.)\n    // All network errors should be treated as user-facing errors, not CLI bugs\n    // Note: Some of these may have been retried already by lower-level retry logic\n    if (isNetworkError(error)) {\n      throw new AbortError(\n        `Network error connecting to your store ${session.storeFqdn}: ${\n          error instanceof Error ? error.message : String(error)\n        }`,\n        'Check your internet connection and try again.',\n      )\n    }\n\n    // Unknown errors are likely bugs in the CLI\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 * 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: Record<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: Record<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,cAAc,CAAA;AACvD,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,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,8BAA8B,CAAA;AAChF,OAAO,EAAmB,YAAY,EAAC,MAAM,YAAY,CAAA;AACzD,OAAO,EAAC,iBAAiB,EAAC,MAAM,iEAAiE,CAAA;AACjG,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;AAItD,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAkB,CAAA;AAExD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,KAAa,EACb,OAAqB,EACrB,SAA4B,EAC5B,OAAgB;IAEhB,MAAM,GAAG,GAAG,OAAO,CAAA;IACnB,MAAM,UAAU,GAAG,OAAO,IAAI,CAAC,MAAM,8BAA8B,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7E,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAA;IACnC,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,UAAU,EAAE,OAAO,CAAC,CAAA;IACtD,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,UAAU,KAAK,MAAM,8BAA8B,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IAChF,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAA;IACnC,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;IAE3E,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,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAqB,EACrB,kBAAqC;IAErC,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,wDAAwD,WAAW,CAAC,IAAI,CACnF,SAAS,EACT,WAAW,OAAO,CAAC,SAAS,EAAE,CAC/B,GAAG,EACJ,aAAa,CAAA,wEAAwE,CACtF,CAAA;QACH,CAAC;QACD,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;YACnG,MAAM,IAAI,UAAU,CAClB,wDAAwD,OAAO,CAAC,SAAS,GAAG,EAC5E,2HAA2H,EAC3H;gBACE,qGAAqG;gBACrG;oBACE,8BAA8B;oBAC9B,EAAC,OAAO,EAAE,SAAS,EAAC;oBACpB,EAAC,IAAI,EAAE,GAAG,EAAC;oBACX,mEAAmE;oBACnE,EAAC,OAAO,EAAE,oBAAoB,EAAC;oBAC/B,EAAC,IAAI,EAAE,GAAG,EAAC;iBACZ;aACF,CACF,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;QAED,2FAA2F;QAC3F,+DAA+D;QAC/D,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAClE,MAAM,IAAI,UAAU,CAClB,aAAa,OAAO,CAAC,SAAS,4BAA4B,EAC1D,uIAAuI,CACxI,CAAA;QACH,CAAC;QAED,4FAA4F;QAC5F,8FAA8F;QAC9F,2DAA2D;QAC3D,IAAI,KAAK,YAAY,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACjE,MAAM,IAAI,UAAU,CAClB,qBAAqB,OAAO,CAAC,SAAS,kCAAkC,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,EACjG,4FAA4F,CAC7F,CAAA;QACH,CAAC;QAED,qFAAqF;QACrF,sFAAsF;QACtF,qBAAqB;QACrB,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,UAAU,CAClB,cAAc,OAAO,CAAC,SAAS,mCAAmC,EAClE,mGAAmG,CACpG,CAAA;QACH,CAAC;QAED,2GAA2G;QAC3G,2EAA2E;QAC3E,+EAA+E;QAC/E,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,UAAU,CAClB,0CAA0C,OAAO,CAAC,SAAS,KACzD,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CACvD,EAAE,EACF,+CAA+C,CAChD,CAAA;QACH,CAAC;QAED,4CAA4C;QAC5C,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;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,eAAuC,EAAE,EACzC,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 '../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 {isAbortedFetchError, isNetworkError} from '../../../private/node/api.js'\nimport {RequestModeInput, shopifyFetch} from '../http.js'\nimport {PublicApiVersions} from '../../../cli/api/graphql/admin/generated/public_api_versions.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'\n\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 * @param version - API version.\n * @returns The response of the query of generic type <T>.\n */\nexport async function adminRequest<T>(\n  query: string,\n  session: AdminSession,\n  variables?: GraphQLVariables,\n  version?: string,\n): Promise<T> {\n  const api = 'Admin'\n  const apiVersion = version ?? (await fetchLatestSupportedApiVersion(session))\n  let storeDomain = 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, apiVersion, 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  apiVersion ??= await fetchLatestSupportedApiVersion(session, preferredBehaviour)\n  let storeDomain = 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): Record<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\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 */\nexport async function fetchApiVersions(\n  session: AdminSession,\n  preferredBehaviour?: RequestModeInput,\n): 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 to 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 && isThemeAccessSession(session)) {\n      throw new AbortError(\n        `The Theme Access password was rejected for the store ${session.storeFqdn}.`,\n        'Theme Access passwords only work on the store they were generated for, and only with its permanent .myshopify.com domain.',\n        [\n          'Check that the password was created in the Theme Access app on this store and has not been deleted.',\n          [\n            'Pass the permanent domain to',\n            {command: '--store'},\n            {char: '.'},\n            'It is the .myshopify.com domain listed in the Shopify admin under',\n            {subdued: 'Settings > Domains'},\n            {char: '.'},\n          ],\n        ],\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    }\n\n    // HTTP 402 means the shop is frozen, paused, or closed. That is a store state the user can\n    // fix, not a CLI bug, so it must not reach the BugError below.\n    if (error instanceof ClientError && error.response.status === 402) {\n      throw new AbortError(\n        `The store ${session.storeFqdn} is currently unavailable.`,\n        'This usually means the store is frozen, paused, or closed. Check the store in the Shopify admin and try again once it is reactivated.',\n      )\n    }\n\n    // HTTP 5xx is a Shopify-side failure. This query takes no user input, so the user's command\n    // cannot have caused it. `isExpectedApiError` covers 502/503/504, but only for raw errors, so\n    // it never sees one we have already wrapped in a BugError.\n    if (error instanceof ClientError && error.response.status >= 500) {\n      throw new AbortError(\n        `The Admin API for ${session.storeFqdn} returned a server error (HTTP ${error.response.status}).`,\n        'This is a problem on the Shopify side, not with your command. Wait a moment and try again.',\n      )\n    }\n\n    // A cancelled request is neither a store-state failure nor a CLI bug. Checked before\n    // `isNetworkError` so the message says the request was aborted instead of blaming the\n    // user's connection.\n    if (isAbortedFetchError(error)) {\n      throw new AbortError(\n        `Request to ${session.storeFqdn} was aborted before it completed.`,\n        'The request was cancelled or timed out before the store responded. Try running the command again.',\n      )\n    }\n\n    // Check for network-level errors (connection issues, timeouts, DNS failures, TLS/certificate errors, etc.)\n    // All network errors should be treated as user-facing errors, not CLI bugs\n    // Note: Some of these may have been retried already by lower-level retry logic\n    if (isNetworkError(error)) {\n      throw new AbortError(\n        `Network error connecting to your store ${session.storeFqdn}: ${\n          error instanceof Error ? error.message : String(error)\n        }`,\n        'Check your internet connection and try again.',\n      )\n    }\n\n    // Unknown errors are likely bugs in the CLI\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 * 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: Record<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: Record<string, string[]>\n}\n"]}

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

@@ -3,7 +3,7 @@ import { debugLogRequestInfo, errorHandler } from '../../../private/node/api/gra
 import { addPublicMetadata, runWithTimer } from '../metadata.js';
 import { retryAwareRequest } from '../../../private/node/api.js';
 import { requestIdsCollection } from '../../../private/node/request-ids.js';
-import { nonRandomUUID } from '../crypto.js';
+import { nonRandomUUID, sha256 } from '../crypto.js';
 import { cacheRetrieveOrRepopulate, timeIntervalToMilliseconds, } from '../../../private/node/conf-store.js';
 import { abortSignalFromRequestBehaviour, requestMode } from '../http.js';
 import { CLI_KIT_VERSION } from '../../common/version.js';
@@ -95,7 +95,16 @@ async function performGraphQLRequest(options) {
             }
         }
         : undefined;
-    const request = () => retryAwareRequest({ request: rawGraphQLRequest, url, ...behaviour }, responseOptions?.handleErrors === false ? undefined : errorHandler(api));
+    const handleErrors = responseOptions?.handleErrors !== false;
+    const request = () => retryAwareRequest({ request: rawGraphQLRequest, url, ...behaviour }, handleErrors ? errorHandler(api) : undefined);
+    // `retryAwareRequest` hands a 401 back raw so the token can be refreshed and the request repeated. Once that is
+    // settled, the error goes through the same handler as every other failed response: a raw graphql-request error
+    // carries the whole request, query text included, and would otherwise reach the user as a CLI bug.
+    const unauthorizedError = (error) => {
+        if (!handleErrors || !(error instanceof ClientError) || error.response.status !== 401)
+            return error;
+        return errorHandler(api)(error, requestIdFromClientError(error));
+    };
     const executeWithTimer = () => runWithTimer('cmd_all_timing_network_ms')(async () => {
         let response;
         try {
@@ -104,14 +113,19 @@ async function performGraphQLRequest(options) {
         catch (error) {
             if (error instanceof ClientError && error.response.status === 401 && tokenRefreshUnauthorizedHandlerFunction) {
                 if (await tokenRefreshUnauthorizedHandlerFunction()) {
-                    response = await request();
+                    try {
+                        response = await request();
+                    }
+                    catch (retryError) {
+                        throw unauthorizedError(retryError);
+                    }
                 }
                 else {
-                    throw error;
+                    throw unauthorizedError(error);
                 }
             }
             else {
-                throw error;
+                throw unauthorizedError(error);
             }
         }
         if (responseOptions?.onResponse) {
@@ -124,16 +138,33 @@ async function performGraphQLRequest(options) {
         return executeWithTimer();
     }
     const { cacheTTL, cacheExtraKey, cacheStore } = cacheOptions;
-    // The cache key is a combination of the hashed query and variables, with an optional extra key provided by the user.
+    // The cache key is a combination of the hashed query and variables, the hashed endpoint and token, and an optional
+    // extra key provided by the user. The endpoint and token keep one principal's cached response from being returned
+    // to another principal or another API; they are hashed so the raw token is never written to the cache.
     const queryHash = nonRandomUUID(queryAsString);
     const variablesHash = nonRandomUUID(JSON.stringify(variables ?? {}));
-    const cacheKey = `q-${queryHash}-${variablesHash}-${CLI_KIT_VERSION}-${cacheExtraKey ?? ''}`;
+    const principalHash = graphQLCachePrincipalHash(url, token);
+    const cacheKey = `q-${queryHash}-${variablesHash}-${CLI_KIT_VERSION}-${principalHash}-${cacheExtraKey ?? ''}`;
     const result = await cacheRetrieveOrRepopulate(cacheKey, async () => {
         const result = await executeWithTimer();
         return JSON.stringify(result);
     }, timeIntervalToMilliseconds(cacheTTL), cacheStore);
     return JSON.parse(result);
 }
+function requestIdFromClientError(error) {
+    try {
+        // graphql-request types the response without headers, but it carries the fetch Response's headers.
+        const headers = error.response.headers;
+        return headers?.get?.('x-request-id') ?? undefined;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return undefined;
+    }
+}
+function graphQLCachePrincipalHash(url, token) {
+    return sha256(JSON.stringify([url, token ?? ''])).toString('hex');
+}
 async function logLastRequestIdFromResponse(response) {
     try {
         const requestId = response.headers.get('x-request-id');

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,EAAoB,WAAW,EAAmB,MAAM,YAAY,CAAA;AAC3G,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAC,KAAK,EAAC,MAAM,cAAc,CAAA;AAClC,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,cAAc,CAAA;AACvD,OAAO,EACL,aAAa,EAGb,sBAAsB,EAEtB,WAAW,GACZ,MAAM,iBAAiB,CAAA;AA4ExB,MAAM,oCAAoC,GAAG,GAAG,CAAA;AAEhD,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,KAAK,UAAU,uBAAuB,CAAC,YAAsC;IAC3E,8DAA8D;IAC9D,MAAM,IAAI,GAAI,YAAY,CAAC,UAAkB,EAAE,IAAI,CAAA;IACnD,MAAM,eAAe,GAAG,IAAI,EAAE,eAAe,CAAA;IAC7C,MAAM,WAAW,GAAG,IAAI,EAAE,cAAc,EAAE,WAAW,CAAA;IACrD,IAAI,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC7G,MAAM,oBAAoB,GAAG,eAAe,GAAG,WAAW,CAAA;QAC1D,WAAW,CAAC,aAAa,CAAA,gBAAgB,oBAAoB,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAA;QAC9G,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,oCAAoC,CAAC,CAAC,CAAA;IACnF,CAAC;AACH,CAAC;AAED,KAAK,UAAU,0BAA0B,CACvC,OAA6C;IAE7C,MAAM,EAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,oBAAoB,EAAC,GAAG,OAAO,CAAA;IACnF,IAAI,YAAsC,CAAA;IAC1C,6GAA6G;IAC7G,SAAS;IACT,IAAI,CAAC;QACH,MAAM,CAAC,cAAc,CAAC,+BAA+B,CAAC,SAAS,CAAC,CAAC,CAAA;QACjE,YAAY,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAChE,MAAM,4BAA4B,CAAC,YAAY,CAAC,CAAA;QAEhD,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,uBAAuB,CAAC,YAAY,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,kGAAkG;YAClG,8DAA8D;YAC9D,MAAM,4BAA4B,CAAC,KAAK,CAAC,QAAe,CAAC,CAAA;QAC3D,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAU,OAA8C;IAC1F,MAAM,EACJ,KAAK,EACL,YAAY,EACZ,aAAa,EACb,SAAS,EACT,GAAG,EACH,GAAG,EACH,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,GACrB,GAAG,OAAO,CAAA;IACX,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,OAAO,0BAA0B,CAAC;YAChC,MAAM,EAAE;gBACN,8DAA8D;gBAC9D,cAAc,EAAE,CAAC,MAAW,EAAE,EAAE;oBAC9B,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,MAAM,CAAA;gBACtC,CAAC;gBACD,UAAU,EAAE,CAAC,KAAa,EAAE,SAAqB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAU,KAAK,EAAE,SAAS,CAAC;aACnG;YACD,SAAS;YACT,aAAa;YACb,SAAS;YACT,oBAAoB,EAAE,oBAAoB,IAAI,KAAK;SACpD,CAAC,CAAA;IACJ,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, RequestBehaviour, requestMode, RequestModeInput} from '../http.js'\nimport {CLI_KIT_VERSION} from '../../common/version.js'\nimport {sleep} from '../system.js'\nimport {outputContent, outputDebug} from '../output.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 Record<string, unknown>> = {[K in keyof T]: T[K]}\n\n// Using a more permissive type to allow generated GraphQL variable interfaces\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type GraphQLVariables = Record<string, any>\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?: Record<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  autoRateLimitRestore?: boolean\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<Record<string, never>>>\n  variables?: TVariables\n  unauthorizedHandler?: UnauthorizedHandler\n  autoRateLimitRestore?: boolean\n}\n\ninterface RunRawGraphQLRequestOptions<TResult> {\n  client: {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    setAbortSignal: (signal: any) => void\n    rawRequest: (query: string, variables?: Variables) => Promise<GraphQLResponse<TResult>>\n  }\n  behaviour: RequestBehaviour\n  queryAsString: string\n  variables?: Variables\n  autoRateLimitRestore: boolean\n}\n\nexport interface GraphQLResponseOptions<T> {\n  handleErrors?: boolean\n  onResponse?: (response: GraphQLResponse<T>) => void\n}\n\nconst MAX_RATE_LIMIT_RESTORE_DELAY_SECONDS = 0.3\n\nasync function createGraphQLClient({\n  url,\n  addedHeaders,\n  token,\n}: {\n  url: string\n  token: string | undefined\n  addedHeaders?: Record<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\nasync function waitForRateLimitRestore(fullResponse: GraphQLResponse<unknown>) {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const cost = (fullResponse.extensions as any)?.cost\n  const actualQueryCost = cost?.actualQueryCost\n  const restoreRate = cost?.throttleStatus?.restoreRate\n  if (actualQueryCost && typeof actualQueryCost === 'number' && restoreRate && typeof restoreRate === 'number') {\n    const secondsToRestoreRate = actualQueryCost / restoreRate\n    outputDebug(outputContent`Sleeping for ${secondsToRestoreRate.toString()} seconds to restore the rate limit.`)\n    await sleep(Math.min(secondsToRestoreRate, MAX_RATE_LIMIT_RESTORE_DELAY_SECONDS))\n  }\n}\n\nasync function runSingleRawGraphQLRequest<TResult>(\n  options: RunRawGraphQLRequestOptions<TResult>,\n): Promise<GraphQLResponse<TResult>> {\n  const {client, behaviour, queryAsString, variables, autoRateLimitRestore} = options\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    client.setAbortSignal(abortSignalFromRequestBehaviour(behaviour))\n    fullResponse = await client.rawRequest(queryAsString, variables)\n    await logLastRequestIdFromResponse(fullResponse)\n\n    if (autoRateLimitRestore) {\n      await waitForRateLimitRestore(fullResponse)\n    }\n\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\nasync function performGraphQLRequest<TResult>(options: PerformGraphQLRequestOptions<TResult>) {\n  const {\n    token,\n    addedHeaders,\n    queryAsString,\n    variables,\n    api,\n    url,\n    responseOptions,\n    unauthorizedHandler,\n    cacheOptions,\n    autoRateLimitRestore,\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    return runSingleRawGraphQLRequest({\n      client: {\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        setAbortSignal: (signal: any) => {\n          client.requestConfig.signal = signal\n        },\n        rawRequest: (query: string, variables?: Variables) => client.rawRequest<TResult>(query, variables),\n      },\n      behaviour,\n      queryAsString,\n      variables,\n      autoRateLimitRestore: autoRateLimitRestore ?? false,\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"]}
+{"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,EAAE,MAAM,EAAC,MAAM,cAAc,CAAA;AAClD,OAAO,EACL,yBAAyB,EAIzB,0BAA0B,GAC3B,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAC,+BAA+B,EAAoB,WAAW,EAAmB,MAAM,YAAY,CAAA;AAC3G,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAC,KAAK,EAAC,MAAM,cAAc,CAAA;AAClC,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,cAAc,CAAA;AACvD,OAAO,EACL,aAAa,EAGb,sBAAsB,EAEtB,WAAW,GACZ,MAAM,iBAAiB,CAAA;AA4ExB,MAAM,oCAAoC,GAAG,GAAG,CAAA;AAEhD,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,KAAK,UAAU,uBAAuB,CAAC,YAAsC;IAC3E,8DAA8D;IAC9D,MAAM,IAAI,GAAI,YAAY,CAAC,UAAkB,EAAE,IAAI,CAAA;IACnD,MAAM,eAAe,GAAG,IAAI,EAAE,eAAe,CAAA;IAC7C,MAAM,WAAW,GAAG,IAAI,EAAE,cAAc,EAAE,WAAW,CAAA;IACrD,IAAI,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC7G,MAAM,oBAAoB,GAAG,eAAe,GAAG,WAAW,CAAA;QAC1D,WAAW,CAAC,aAAa,CAAA,gBAAgB,oBAAoB,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAA;QAC9G,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,oCAAoC,CAAC,CAAC,CAAA;IACnF,CAAC;AACH,CAAC;AAED,KAAK,UAAU,0BAA0B,CACvC,OAA6C;IAE7C,MAAM,EAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,oBAAoB,EAAC,GAAG,OAAO,CAAA;IACnF,IAAI,YAAsC,CAAA;IAC1C,6GAA6G;IAC7G,SAAS;IACT,IAAI,CAAC;QACH,MAAM,CAAC,cAAc,CAAC,+BAA+B,CAAC,SAAS,CAAC,CAAC,CAAA;QACjE,YAAY,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;QAChE,MAAM,4BAA4B,CAAC,YAAY,CAAC,CAAA;QAEhD,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,uBAAuB,CAAC,YAAY,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,kGAAkG;YAClG,8DAA8D;YAC9D,MAAM,4BAA4B,CAAC,KAAK,CAAC,QAAe,CAAC,CAAA;QAC3D,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAU,OAA8C;IAC1F,MAAM,EACJ,KAAK,EACL,YAAY,EACZ,aAAa,EACb,SAAS,EACT,GAAG,EACH,GAAG,EACH,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,GACrB,GAAG,OAAO,CAAA;IACX,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,OAAO,0BAA0B,CAAC;YAChC,MAAM,EAAE;gBACN,8DAA8D;gBAC9D,cAAc,EAAE,CAAC,MAAW,EAAE,EAAE;oBAC9B,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,MAAM,CAAA;gBACtC,CAAC;gBACD,UAAU,EAAE,CAAC,KAAa,EAAE,SAAqB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAU,KAAK,EAAE,SAAS,CAAC;aACnG;YACD,SAAS;YACT,aAAa;YACb,SAAS;YACT,oBAAoB,EAAE,oBAAoB,IAAI,KAAK;SACpD,CAAC,CAAA;IACJ,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,YAAY,GAAG,eAAe,EAAE,YAAY,KAAK,KAAK,CAAA;IAE5D,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,iBAAiB,CAAC,EAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAG,SAAS,EAAC,EAAE,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAElH,gHAAgH;IAChH,+GAA+G;IAC/G,mGAAmG;IACnG,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAW,EAAE;QACpD,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,KAAK,CAAA;QACnG,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAA;IAClE,CAAC,CAAA;IAED,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,IAAI,CAAC;wBACH,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAA;oBAC5B,CAAC;oBAAC,OAAO,UAAU,EAAE,CAAC;wBACpB,MAAM,iBAAiB,CAAC,UAAU,CAAC,CAAA;oBACrC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,iBAAiB,CAAC,KAAK,CAAC,CAAA;gBAChC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,iBAAiB,CAAC,KAAK,CAAC,CAAA;YAChC,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,mHAAmH;IACnH,kHAAkH;IAClH,uGAAuG;IACvG,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,aAAa,GAAG,yBAAyB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC3D,MAAM,QAAQ,GAAsB,KAAK,SAAS,IAAI,aAAa,IAAI,eAAe,IAAI,aAAa,IACrG,aAAa,IAAI,EACnB,EAAE,CAAA;IAEF,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,SAAS,wBAAwB,CAAC,KAAkB;IAClD,IAAI,CAAC;QACH,mGAAmG;QACnG,MAAM,OAAO,GAAI,KAAK,CAAC,QAAgE,CAAC,OAAO,CAAA;QAC/F,OAAO,OAAO,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,SAAS,CAAA;QAClD,qDAAqD;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,GAAW,EAAE,KAAyB;IACvE,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACnE,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, sha256} 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, RequestBehaviour, requestMode, RequestModeInput} from '../http.js'\nimport {CLI_KIT_VERSION} from '../../common/version.js'\nimport {sleep} from '../system.js'\nimport {outputContent, outputDebug} from '../output.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 Record<string, unknown>> = {[K in keyof T]: T[K]}\n\n// Using a more permissive type to allow generated GraphQL variable interfaces\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type GraphQLVariables = Record<string, any>\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?: Record<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  autoRateLimitRestore?: boolean\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<Record<string, never>>>\n  variables?: TVariables\n  unauthorizedHandler?: UnauthorizedHandler\n  autoRateLimitRestore?: boolean\n}\n\ninterface RunRawGraphQLRequestOptions<TResult> {\n  client: {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    setAbortSignal: (signal: any) => void\n    rawRequest: (query: string, variables?: Variables) => Promise<GraphQLResponse<TResult>>\n  }\n  behaviour: RequestBehaviour\n  queryAsString: string\n  variables?: Variables\n  autoRateLimitRestore: boolean\n}\n\nexport interface GraphQLResponseOptions<T> {\n  handleErrors?: boolean\n  onResponse?: (response: GraphQLResponse<T>) => void\n}\n\nconst MAX_RATE_LIMIT_RESTORE_DELAY_SECONDS = 0.3\n\nasync function createGraphQLClient({\n  url,\n  addedHeaders,\n  token,\n}: {\n  url: string\n  token: string | undefined\n  addedHeaders?: Record<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\nasync function waitForRateLimitRestore(fullResponse: GraphQLResponse<unknown>) {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const cost = (fullResponse.extensions as any)?.cost\n  const actualQueryCost = cost?.actualQueryCost\n  const restoreRate = cost?.throttleStatus?.restoreRate\n  if (actualQueryCost && typeof actualQueryCost === 'number' && restoreRate && typeof restoreRate === 'number') {\n    const secondsToRestoreRate = actualQueryCost / restoreRate\n    outputDebug(outputContent`Sleeping for ${secondsToRestoreRate.toString()} seconds to restore the rate limit.`)\n    await sleep(Math.min(secondsToRestoreRate, MAX_RATE_LIMIT_RESTORE_DELAY_SECONDS))\n  }\n}\n\nasync function runSingleRawGraphQLRequest<TResult>(\n  options: RunRawGraphQLRequestOptions<TResult>,\n): Promise<GraphQLResponse<TResult>> {\n  const {client, behaviour, queryAsString, variables, autoRateLimitRestore} = options\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    client.setAbortSignal(abortSignalFromRequestBehaviour(behaviour))\n    fullResponse = await client.rawRequest(queryAsString, variables)\n    await logLastRequestIdFromResponse(fullResponse)\n\n    if (autoRateLimitRestore) {\n      await waitForRateLimitRestore(fullResponse)\n    }\n\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\nasync function performGraphQLRequest<TResult>(options: PerformGraphQLRequestOptions<TResult>) {\n  const {\n    token,\n    addedHeaders,\n    queryAsString,\n    variables,\n    api,\n    url,\n    responseOptions,\n    unauthorizedHandler,\n    cacheOptions,\n    autoRateLimitRestore,\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    return runSingleRawGraphQLRequest({\n      client: {\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        setAbortSignal: (signal: any) => {\n          client.requestConfig.signal = signal\n        },\n        rawRequest: (query: string, variables?: Variables) => client.rawRequest<TResult>(query, variables),\n      },\n      behaviour,\n      queryAsString,\n      variables,\n      autoRateLimitRestore: autoRateLimitRestore ?? false,\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 handleErrors = responseOptions?.handleErrors !== false\n\n  const request = () =>\n    retryAwareRequest({request: rawGraphQLRequest, url, ...behaviour}, handleErrors ? errorHandler(api) : undefined)\n\n  // `retryAwareRequest` hands a 401 back raw so the token can be refreshed and the request repeated. Once that is\n  // settled, the error goes through the same handler as every other failed response: a raw graphql-request error\n  // carries the whole request, query text included, and would otherwise reach the user as a CLI bug.\n  const unauthorizedError = (error: unknown): unknown => {\n    if (!handleErrors || !(error instanceof ClientError) || error.response.status !== 401) return error\n    return errorHandler(api)(error, requestIdFromClientError(error))\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            try {\n              response = await request()\n            } catch (retryError) {\n              throw unauthorizedError(retryError)\n            }\n          } else {\n            throw unauthorizedError(error)\n          }\n        } else {\n          throw unauthorizedError(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, the hashed endpoint and token, and an optional\n  // extra key provided by the user. The endpoint and token keep one principal's cached response from being returned\n  // to another principal or another API; they are hashed so the raw token is never written to the cache.\n  const queryHash = nonRandomUUID(queryAsString)\n  const variablesHash = nonRandomUUID(JSON.stringify(variables ?? {}))\n  const principalHash = graphQLCachePrincipalHash(url, token)\n  const cacheKey: GraphQLRequestKey = `q-${queryHash}-${variablesHash}-${CLI_KIT_VERSION}-${principalHash}-${\n    cacheExtraKey ?? ''\n  }`\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\nfunction requestIdFromClientError(error: ClientError): string | undefined {\n  try {\n    // graphql-request types the response without headers, but it carries the fetch Response's headers.\n    const headers = (error.response as {headers?: {get?: (name: string) => string | null}}).headers\n    return headers?.get?.('x-request-id') ?? undefined\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return undefined\n  }\n}\n\nfunction graphQLCachePrincipalHash(url: string, token: string | undefined): string {\n  return sha256(JSON.stringify([url, token ?? ''])).toString('hex')\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

@@ -26,11 +26,19 @@ export async function zip(options) {
     return new Promise((resolve, reject) => {
         const archive = archiver('zip');
         const output = createWriteStream(outputZipPath);
+        let outputError;
+        output.on('error', (error) => {
+            outputError = error;
+            archive.abort();
+        });
         output.on('close', () => {
-            resolve();
+            if (outputError)
+                reject(outputError);
+            else
+                resolve();
         });
         archive.on('error', (error) => {
-            reject(error);
+            output.destroy(error);
         });
         archive.pipe(output);
         const directoriesToAdd = new Set();
@@ -51,12 +59,11 @@ export async function zip(options) {
         // Wait for all files to be read and added before finalizing
         Promise.all(addFilesPromises)
             .then(() => {
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            archive.finalize();
+            if (!output.destroyed)
+                return archive.finalize();
         })
             .catch((error) => {
-            // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
-            reject(error);
+            output.destroy(error instanceof Error ? error : new Error(String(error)));
         });
     });
 }

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,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,aAAa,CAAA;AACnE,OAAO,EAAC,IAAI,EAAE,UAAU,EAAC,MAAM,SAAS,CAAA;AACxC,OAAO,EAAC,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAC,MAAM,WAAW,CAAA;AACzD,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAC,MAAM,IAAI,CAAA;AACjE,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AACpC,OAAO,EAAC,MAAM,EAAC,MAAM,IAAI,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,QAAQ,CAAA;AACjC,OAAO,EAAC,kBAAkB,EAAE,SAAS,IAAI,aAAa,EAAC,MAAM,MAAM,CAAA;AAmBnE;;;;;;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,+EAA+E;QAC/E,8FAA8F;QAC9F,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACzD,MAAM,WAAW,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QACtD,CAAC,CAAC,CAAA;QAEF,4DAA4D;QAC5D,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;aAC1B,IAAI,CAAC,GAAG,EAAE;YACT,mEAAmE;YACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;QACpB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,2EAA2E;YAC3E,MAAM,CAAC,KAAK,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;IACN,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;AAED,KAAK,UAAU,WAAW,CAAC,cAAsB,EAAE,QAAgB,EAAE,OAA0B;IAC7F,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IAC/D,IAAI,CAAC,QAAQ,IAAI,CAAC,gBAAgB;QAAE,OAAM;IAE1C,yDAAyD;IACzD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAC5C,sEAAsE;IACtE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;AACvD,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,KAAK,EAAE,UAAU,EAAE,EAAE;gBACzB,6EAA6E;gBAC7E,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;oBACzD,MAAM,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;gBAC9D,CAAC,CAAC,CAAA;gBAEF,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;gBACnC,mEAAmE;gBACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;YACpB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACnE,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QAEF,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAC5C,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,EAAE;YAChD,MAAM,EAAE;gBACN,CAAC,aAAa,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACvC,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,aAAa,CAAC,mBAAmB;aACrE;SACF,CAAC,CAAA;QAEF,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 {outputDebug, outputContent, outputToken} from './output.js'\nimport {glob, removeFile} from './fs.js'\nimport {relativePath, joinPath, dirname} from './path.js'\nimport archiver from 'archiver'\nimport {createWriteStream, readFileSync, writeFileSync} from 'fs'\nimport {readFile} from 'fs/promises'\nimport {tmpdir} from 'os'\nimport {randomUUID} from 'crypto'\nimport {brotliCompressSync, constants as zlibConstants} from 'zlib'\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    // Read all files immediately before adding to archive to prevent ENOENT errors\n    // Using archive.file() causes lazy loading which fails if files are deleted before finalize()\n    const addFilesPromises = pathsToZip.map(async (filePath) => {\n      await archiveFile(inputDirectory, filePath, archive)\n    })\n\n    // Wait for all files to be read and added before finalizing\n    Promise.all(addFilesPromises)\n      .then(() => {\n        // eslint-disable-next-line @typescript-eslint/no-floating-promises\n        archive.finalize()\n      })\n      .catch((error) => {\n        // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors\n        reject(error)\n      })\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\nasync function archiveFile(inputDirectory: string, filePath: string, archive: archiver.Archiver): Promise<void> {\n  const fileRelativePath = relativePath(inputDirectory, filePath)\n  if (!filePath || !fileRelativePath) return\n\n  // Read file content immediately to avoid race conditions\n  const fileContent = await readFile(filePath)\n  // Use append with Buffer instead of file() to avoid lazy file reading\n  archive.append(fileContent, {name: fileRelativePath})\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(async (pathsToZip) => {\n          // Read all files immediately to prevent ENOENT errors during race conditions\n          const addFilesPromises = pathsToZip.map(async (filePath) => {\n            await archiveFile(options.inputDirectory, filePath, archive)\n          })\n\n          await Promise.all(addFilesPromises)\n          // eslint-disable-next-line @typescript-eslint/no-floating-promises\n          archive.finalize()\n        })\n        .catch((error) => {\n          reject(error instanceof Error ? error : new Error(String(error)))\n        })\n    })\n\n    const tarContent = readFileSync(tempTarPath)\n    const compressed = brotliCompressSync(tarContent, {\n      params: {\n        [zlibConstants.BROTLI_PARAM_QUALITY]: 7,\n        [zlibConstants.BROTLI_PARAM_MODE]: zlibConstants.BROTLI_MODE_GENERIC,\n      },\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,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,aAAa,CAAA;AACnE,OAAO,EAAC,IAAI,EAAE,UAAU,EAAC,MAAM,SAAS,CAAA;AACxC,OAAO,EAAC,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAC,MAAM,WAAW,CAAA;AACzD,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAC,MAAM,IAAI,CAAA;AACjE,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AACpC,OAAO,EAAC,MAAM,EAAC,MAAM,IAAI,CAAA;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,QAAQ,CAAA;AACjC,OAAO,EAAC,kBAAkB,EAAE,SAAS,IAAI,aAAa,EAAC,MAAM,MAAM,CAAA;AAmBnE;;;;;;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,IAAI,WAA8B,CAAA;QAClC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3B,WAAW,GAAG,KAAK,CAAA;YACnB,OAAO,CAAC,KAAK,EAAE,CAAA;QACjB,CAAC,CAAC,CAAA;QACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,IAAI,WAAW;gBAAE,MAAM,CAAC,WAAW,CAAC,CAAA;;gBAC/B,OAAO,EAAE,CAAA;QAChB,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACvB,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,+EAA+E;QAC/E,8FAA8F;QAC9F,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACzD,MAAM,WAAW,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QACtD,CAAC,CAAC,CAAA;QAEF,4DAA4D;QAC5D,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;aAC1B,IAAI,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,MAAM,CAAC,SAAS;gBAAE,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAA;QAClD,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,CAAC,OAAO,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC3E,CAAC,CAAC,CAAA;IACN,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;AAED,KAAK,UAAU,WAAW,CAAC,cAAsB,EAAE,QAAgB,EAAE,OAA0B;IAC7F,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IAC/D,IAAI,CAAC,QAAQ,IAAI,CAAC,gBAAgB;QAAE,OAAM;IAE1C,yDAAyD;IACzD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAC5C,sEAAsE;IACtE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;AACvD,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,KAAK,EAAE,UAAU,EAAE,EAAE;gBACzB,6EAA6E;gBAC7E,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;oBACzD,MAAM,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;gBAC9D,CAAC,CAAC,CAAA;gBAEF,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;gBACnC,mEAAmE;gBACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;YACpB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACnE,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QAEF,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAC5C,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,EAAE;YAChD,MAAM,EAAE;gBACN,CAAC,aAAa,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACvC,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,aAAa,CAAC,mBAAmB;aACrE;SACF,CAAC,CAAA;QAEF,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 {outputDebug, outputContent, outputToken} from './output.js'\nimport {glob, removeFile} from './fs.js'\nimport {relativePath, joinPath, dirname} from './path.js'\nimport archiver from 'archiver'\nimport {createWriteStream, readFileSync, writeFileSync} from 'fs'\nimport {readFile} from 'fs/promises'\nimport {tmpdir} from 'os'\nimport {randomUUID} from 'crypto'\nimport {brotliCompressSync, constants as zlibConstants} from 'zlib'\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    let outputError: Error | undefined\n    output.on('error', (error) => {\n      outputError = error\n      archive.abort()\n    })\n    output.on('close', () => {\n      if (outputError) reject(outputError)\n      else resolve()\n    })\n    archive.on('error', (error) => {\n      output.destroy(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    // Read all files immediately before adding to archive to prevent ENOENT errors\n    // Using archive.file() causes lazy loading which fails if files are deleted before finalize()\n    const addFilesPromises = pathsToZip.map(async (filePath) => {\n      await archiveFile(inputDirectory, filePath, archive)\n    })\n\n    // Wait for all files to be read and added before finalizing\n    Promise.all(addFilesPromises)\n      .then(() => {\n        if (!output.destroyed) return archive.finalize()\n      })\n      .catch((error) => {\n        output.destroy(error instanceof Error ? error : new Error(String(error)))\n      })\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\nasync function archiveFile(inputDirectory: string, filePath: string, archive: archiver.Archiver): Promise<void> {\n  const fileRelativePath = relativePath(inputDirectory, filePath)\n  if (!filePath || !fileRelativePath) return\n\n  // Read file content immediately to avoid race conditions\n  const fileContent = await readFile(filePath)\n  // Use append with Buffer instead of file() to avoid lazy file reading\n  archive.append(fileContent, {name: fileRelativePath})\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(async (pathsToZip) => {\n          // Read all files immediately to prevent ENOENT errors during race conditions\n          const addFilesPromises = pathsToZip.map(async (filePath) => {\n            await archiveFile(options.inputDirectory, filePath, archive)\n          })\n\n          await Promise.all(addFilesPromises)\n          // eslint-disable-next-line @typescript-eslint/no-floating-promises\n          archive.finalize()\n        })\n        .catch((error) => {\n          reject(error instanceof Error ? error : new Error(String(error)))\n        })\n    })\n\n    const tarContent = readFileSync(tempTarPath)\n    const compressed = brotliCompressSync(tarContent, {\n      params: {\n        [zlibConstants.BROTLI_PARAM_QUALITY]: 7,\n        [zlibConstants.BROTLI_PARAM_MODE]: zlibConstants.BROTLI_MODE_GENERIC,\n      },\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/base-command.d.ts

@@ -1,4 +1,5 @@
 import { type JsonOutputSchema } from './json-output-schema.js';
+import { JsonMap } from '../../private/common/json.js';
 import { Command } from '@oclif/core';
 import { OutputFlags, Input, ParserOutput, FlagInput, OutputArgs } from '@oclif/core/parser';
 export type ArgOutput = OutputArgs<any>;
@@ -20,12 +21,14 @@ declare abstract class BaseCommand extends Command {
     static descriptionWithoutMarkdown(): string | undefined;
     static analyticsNameOverride(): string | undefined;
     static analyticsStopCommand(): string | undefined;
+    private jsonOutputFromFlags;
     catch(error: Error & {
         skipOclifErrorHandling: boolean;
     }): Promise<void>;
     protected _run<T>(): Promise<T>;
     protected init(): Promise<unknown>;
     protected showNpmFlagWarning(): void;
+    protected showDeprecatedAutomationTokenVariableWarning(): Promise<void>;
     protected exitWithTimestampWhenEnvVariablePresent(): void;
     protected parse<TFlags extends FlagOutput & {
         path?: string;
@@ -34,7 +37,10 @@ declare abstract class BaseCommand extends Command {
     }, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(options?: Input<TFlags, TGlobalFlags, TArgs>, argv?: string[]): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {
         argv: string[];
     }>;
+    protected runWithParsedOutput<T>(flags: FlagOutput, execute: () => T): T;
     protected environmentsFilename(): string | undefined;
+    protected parseEnvironmentFlags<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(environment: JsonMap, options: Input<TFlags, TGlobalFlags, TArgs>, explicitFlags: FlagOutput): Promise<FlagOutput>;
+    protected validateNonTTYFlags(flags: FlagOutput): void;
     protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void;
     private failMissingNonTTYFlagRequirements;
     private applicableNonTTYFlagRequirements;

package/dist/public/node/base-command.js

@@ -1,13 +1,16 @@
 import { isDevelopment } from './context/local.js';
 import { addPublicMetadata } from './metadata.js';
 import { AbortError } from './error.js';
-import { runWithCommandEventsForCommand } from './command-events.js';
+import { commandEventOutputMode, emitCommandEvent, renderCommandEventAsJson, runWithCommandEvents, runWithCommandEventsForCommand, } from './command-events.js';
 import { outputContent, outputResult, outputToken } from './output.js';
 import { setCurrentSessionAlias } from './session.js';
 import { terminalSupportsPrompting } from './system.js';
 import { hashString } from './crypto.js';
 import { isTruthy } from './context/utilities.js';
 import { setCurrentCommandId } from './global-context.js';
+import { environmentVariables } from '../../private/node/constants.js';
+import { deprecatedAutomationTokenVariable } from '../../private/node/session/automation-token.js';
+import { runAtMinimumInterval } from '../../private/node/conf-store.js';
 import { underscore } from '../common/string.js';
 import { Command, Errors, Flags } from '@oclif/core';
 class BaseCommand extends Command {
@@ -42,11 +45,18 @@ class BaseCommand extends Command {
     static analyticsStopCommand() {
         return undefined;
     }
+    jsonOutputFromFlags = false;
     async catch(error) {
-        error.skipOclifErrorHandling = true;
-        const { errorHandler } = await import('./error-handler.js');
-        await errorHandler(error, this.config);
-        return Errors.handle(error);
+        const handleError = async () => {
+            error.skipOclifErrorHandling = true;
+            const { errorHandler } = await import('./error-handler.js');
+            await errorHandler(error, this.config);
+            return Errors.handle(error);
+        };
+        if (this.jsonOutputFromFlags && commandEventOutputMode() !== 'json') {
+            return runWithCommandEvents({ outputMode: 'json', sink: renderCommandEventAsJson }, handleError);
+        }
+        return handleError();
     }
     async _run() {
         return runWithCommandEventsForCommand(this.argv, () => super._run());
@@ -61,6 +71,7 @@ class BaseCommand extends Command {
         }
         await removeDuplicatedPlugins(this.config);
         this.showNpmFlagWarning();
+        await this.showDeprecatedAutomationTokenVariableWarning();
         const { showNotificationsIfNeeded } = await import('./notifications-system.js');
         await showNotificationsIfNeeded();
         return super.init();
@@ -86,6 +97,21 @@ class BaseCommand extends Command {
             });
         }
     }
+    // SHOPIFY_APP_AUTOMATION_TOKEN and SHOPIFY_CLI_PARTNERS_TOKEN keep working, but SHOPIFY_SERVICE_ACCOUNT_TOKEN replaces
+    // them and takes the same tokens. This warning is how people still using an old name find out about the new one.
+    async showDeprecatedAutomationTokenVariableWarning() {
+        const variable = deprecatedAutomationTokenVariable();
+        if (!variable)
+            return;
+        // Show the warning only once per day
+        await runAtMinimumInterval('warn-on-deprecated-automation-token-variable', { days: 1 }, async () => {
+            const { renderWarning } = await import('./ui.js');
+            renderWarning({
+                headline: `${variable} is deprecated.`,
+                body: `Move the token to ${environmentVariables.serviceAccountToken}. ${variable} still works for now, but a future release will stop reading it.`,
+            });
+        });
+    }
     exitWithTimestampWhenEnvVariablePresent() {
         if (isTruthy(process.env.SHOPIFY_CLI_ENV_STARTUP_PERFORMANCE_RUN)) {
             outputResult(`
@@ -97,17 +123,46 @@ class BaseCommand extends Command {
         }
     }
     async parse(options, argv) {
-        let result = await super.parse(options, argv);
-        result = await this.resultWithEnvironment(result, options, argv);
-        await setCurrentSessionAlias(result.flags['auth-alias']);
-        await addFromParsedFlags(result.flags);
-        this.failMissingNonTTYFlagRequirements(result.flags, this.applicableNonTTYFlagRequirements(result.flags));
-        return { ...result, ...{ argv: result.argv } };
+        const parsed = await super.parse(options, argv);
+        const result = await this.resultWithEnvironment(parsed, options, argv);
+        return this.runWithParsedOutput(result.flags, async () => {
+            await setCurrentSessionAlias(result.flags['auth-alias']);
+            await addFromParsedFlags(result.flags);
+            this.validateNonTTYFlags(result.flags);
+            return { ...result, ...{ argv: result.argv } };
+        });
+    }
+    runWithParsedOutput(flags, execute) {
+        const command = this.constructor;
+        const json = commandSupportsFlag(command.flags, 'json') &&
+            (flags.json === true || (commandSupportsJsonOutputFormat(command.flags) && flags.output === 'json'));
+        this.jsonOutputFromFlags ||= json;
+        if (json && commandEventOutputMode() !== 'json') {
+            return runWithCommandEvents({ outputMode: 'json', sink: renderCommandEventAsJson }, execute);
+        }
+        return execute();
     }
     environmentsFilename() {
         // To be re-implemented if needed
         return undefined;
     }
+    async parseEnvironmentFlags(environment, options, explicitFlags) {
+        const originalArgv = this.argv;
+        try {
+            const result = await super.parse(options, [
+                ...originalArgv,
+                ...argsFromEnvironment(environment, options, explicitFlags),
+            ]);
+            return result.flags;
+        }
+        finally {
+            // Oclif replaces argv when parsing; the next environment needs the original arguments.
+            this.argv = originalArgv;
+        }
+    }
+    validateNonTTYFlags(flags) {
+        this.failMissingNonTTYFlagRequirements(flags, this.applicableNonTTYFlagRequirements(flags));
+    }
     failMissingNonTTYFlags(flags, requiredFlags) {
         this.failMissingNonTTYFlagRequirements(flags, requiredFlags.map((flag) => ({ flags: [flag] })));
     }
@@ -164,17 +219,28 @@ ${explanation} in non-interactive terminal environments, such as a CI environmen
         // Parse using noDefaultsOptions to derive a list of flags specified as
         // command-line arguments.
         const noDefaultsResult = await super.parse(noDefaultsOptions(options), argv);
+        // Remember the requested format before environment flag validation can fail.
+        const effectiveFlags = { ...environment, ...noDefaultsResult.flags };
+        this.jsonOutputFromFlags =
+            (commandSupportsFlag(options?.flags, 'json') && effectiveFlags.json === true) ||
+                (commandSupportsJsonOutputFormat(options?.flags) && effectiveFlags.output === 'json');
+        const normalizedEnvironment = commandSupportsFlag(options?.flags, 'json') &&
+            commandSupportsJsonOutputFormat(options?.flags) &&
+            effectiveFlags.output === 'json'
+            ? { json: true, ...environment }
+            : environment;
         // Add the environment's settings to argv and pass them to `super.parse`. This
         // invokes oclif's validation system without breaking the oclif black box.
         // Replace the original result with this one.
         const result = await super.parse(options, [
             // Need to specify argv default because we're merging with argsFromEnvironment.
             ...(argv ?? this.argv),
-            ...argsFromEnvironment(environment, options, noDefaultsResult),
+            ...argsFromEnvironment(normalizedEnvironment, options, noDefaultsResult.flags),
             ...(isDefaultEnvironment ? ['--environment', 'default'] : []),
         ]);
         // Report successful application of the environment.
-        reportEnvironmentApplication(noDefaultsResult.flags, result.flags, isDefaultEnvironment ? 'default' : environments[0], environment);
+        const report = () => reportEnvironmentApplication(noDefaultsResult.flags, result.flags, isDefaultEnvironment ? 'default' : environments[0], environment);
+        this.runWithParsedOutput(result.flags, report);
         return result;
     }
     /**
@@ -216,13 +282,21 @@ function reportEnvironmentApplication(noDefaultsFlags, flagsWithEnvironments, en
         const userSpecifiedThisFlag = Object.prototype.hasOwnProperty.call(noDefaultsFlags, name);
         const environmentContainsFlag = Object.prototype.hasOwnProperty.call(environment, name);
         if (!userSpecifiedThisFlag && environmentContainsFlag) {
-            const valueToReport = name === 'password' ? `********${value.substr(-4)}` : value;
+            const valueToReport = name === 'password' || name === 'store-password' ? `********${value.substr(-4)}` : value;
             changes[name] = valueToReport;
         }
     }
     if (Object.keys(changes).length === 0)
         return;
     const items = Object.entries(changes).map(([name, value]) => `${name}: ${value}`);
+    if (commandEventOutputMode() === 'json') {
+        emitCommandEvent({
+            type: 'diagnostic',
+            level: 'info',
+            message: `Using applicable flags from ${environmentName} environment:\n${items.join('\n')}`,
+        });
+        return;
+    }
     // eslint-disable-next-line no-void
     void import('./ui.js').then(({ renderInfo }) => {
         renderInfo({
@@ -268,12 +342,15 @@ export function noDefaultsOptions(options) {
  * Converts the environment's settings to arguments as though passed on the command
  * line, skipping any arguments the user specified on the command line.
  */
-function argsFromEnvironment(environment, options, noDefaultsResult) {
+function argsFromEnvironment(environment, options, explicitFlags) {
     const args = [];
     for (const [label, value] of Object.entries(environment)) {
         const flagIsRelevantToCommand = commandSupportsFlag(options?.flags, label);
-        const userSpecifiedThisFlag = noDefaultsResult.flags && Object.prototype.hasOwnProperty.call(noDefaultsResult.flags, label);
+        const userSpecifiedThisFlag = Object.prototype.hasOwnProperty.call(explicitFlags, label);
         if (flagIsRelevantToCommand && !userSpecifiedThisFlag) {
+            if (options?.flags?.[label]?.type === 'boolean' && typeof value !== 'boolean') {
+                throw new AbortError(outputContent `Environment flag ${outputToken.yellow(label)} must be a boolean.`);
+            }
             if (typeof value === 'boolean') {
                 if (value) {
                     args.push(`--${label}`);
@@ -295,6 +372,10 @@ function argsFromEnvironment(environment, options, noDefaultsResult) {
 function commandSupportsFlag(flags, flagName) {
     return Boolean(flags) && Object.prototype.hasOwnProperty.call(flags, flagName);
 }
+function commandSupportsJsonOutputFormat(flags) {
+    const output = flags?.output;
+    return output?.type === 'option' && output.options?.includes('json') === true;
+}
 function appendJsonOutputSchema(description, outputSchema) {
     if (!outputSchema)
         return description;