@shopify/cli-kit 3.57.1 → 3.58.0

package/dist/public/node/base-command.d.ts

@@ -1,6 +1,7 @@
 import { Command } from '@oclif/core';
 import { FlagOutput, Input, ParserOutput, ArgOutput } from '@oclif/core/lib/interfaces/parser.js';
 declare abstract class BaseCommand extends Command {
+    static descriptionWithoutMarkdown(): string | undefined;
     static analyticsNameOverride(): string | undefined;
     static analyticsStopCommand(): string | undefined;
     catch(error: Error & {

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

@@ -11,6 +11,11 @@ import { isTruthy } from './context/utilities.js';
 import { underscore } from '../common/string.js';
 import { Command, Errors } from '@oclif/core';
 class BaseCommand extends Command {
+    // Replace markdown links to plain text like: "link label" (url)
+    static descriptionWithoutMarkdown() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return (this.descriptionWithMarkdown ?? '').replace(/(\[)(.*?)(])(\()(.*?)(\))/gm, '"$2" ($5)');
+    }
     static analyticsNameOverride() {
         return undefined;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"base-command.js","sourceRoot":"","sources":["../../../src/public/node/base-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,2CAA2C,EAAC,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAC,aAAa,EAAC,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAC,iBAAiB,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,EAAC,UAAU,EAAC,MAAM,YAAY,CAAA;AACrC,OAAO,EAAC,UAAU,EAAE,aAAa,EAAC,MAAM,SAAS,CAAA;AACjD,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,aAAa,CAAA;AAClE,OAAO,EAAC,uBAAuB,EAAC,MAAM,aAAa,CAAA;AACnD,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAA;AAE/C,OAAO,EAAC,UAAU,EAAC,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAC,OAAO,EAAE,MAAM,EAAC,MAAM,aAAa,CAAA;AAQ3C,MAAe,WAAY,SAAQ,OAAO;IACjC,MAAM,CAAC,qBAAqB;QACjC,OAAO,SAAS,CAAA;IAClB,CAAC;IAEM,MAAM,CAAC,oBAAoB;QAChC,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,KAA8C;QACxD,MAAM,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC;IAED,8DAA8D;IACpD,KAAK,CAAC,IAAI;QAClB,IAAI,CAAC,uCAAuC,EAAE,CAAA;QAC9C,IAAI,CAAC,aAAa,EAAE,EAAE;YACpB,yCAAyC;YACzC,MAAM,2CAA2C,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;SAC/D;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAA;QACzB,OAAO,KAAK,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;IAED,yEAAyE;IACzE,0EAA0E;IAC1E,gDAAgD;IACtC,kBAAkB;QAC1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAA0C,CAAA;QACxE,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;QAC9D,MAAM,kBAAkB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;QAEzG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,EAAE;YACtE,aAAa,CAAC;gBACZ,IAAI,EAAE;oBACJ,8BAA8B;oBAC9B,EAAC,OAAO,EAAE,IAAI,EAAC;oBACf,uCAAuC;oBACvC,EAAC,OAAO,EAAE,wBAAwB,EAAC;iBACpC;aACF,CAAC,CAAA;SACH;IACH,CAAC;IAED,6EAA6E;IACnE,uCAAuC;QAC/C,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,EAAE;YACjE,UAAU,CAAC;;uBAEM,IAAI,CAAC,GAAG,EAAE;;OAE1B,CAAC,CAAA;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SAChB;IACH,CAAC;IAES,KAAK,CAAC,KAAK,CAKnB,OAA4C,EAC5C,IAAe;QAEf,IAAI,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAA8B,OAAO,EAAE,IAAI,CAAC,CAAA;QAC1E,MAAM,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAA8B,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;QAC7F,MAAM,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACtC,OAAO,EAAC,GAAG,MAAM,EAAE,GAAG,EAAC,IAAI,EAAE,MAAM,CAAC,IAAgB,EAAC,EAAC,CAAA;IACxD,CAAC;IAES,oBAAoB;QAC5B,iCAAiC;QACjC,OAAO,SAAS,CAAA;IAClB,CAAC;IAES,sBAAsB,CAAC,KAAiB,EAAE,aAAuB;QACzE,IAAI,uBAAuB,EAAE;YAAE,OAAM;QAErC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;YACrC,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE;gBACpB,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA;;EAErB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;;qIAE6G,EAC3H,mIAAmI,CACpI,CAAA;aACF;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAKjC,cAAyD,EACzD,OAA4C,EAC5C,IAAe;QAEf,2DAA2D;QAC3D,MAAM,KAAK,GAAG,cAAc,CAAC,KAAyB,CAAA;QACtD,MAAM,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;QACxD,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,oBAAoB;YAAE,OAAO,cAAc,CAAA;QAEtE,qEAAqE;QACrE,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,WAAW,EAAE,oBAAoB,EAAE,EAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAC,CAAC,CAAA;QACtG,IAAI,CAAC,WAAW;YAAE,OAAO,cAAc,CAAA;QAEvC,uEAAuE;QACvE,0BAA0B;QAC1B,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,KAAK,CAA8B,iBAAiB,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAA;QAEzG,8EAA8E;QAC9E,0EAA0E;QAC1E,6CAA6C;QAC7C,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAA8B,OAAO,EAAE;YACrE,+EAA+E;YAC/E,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;YACtB,GAAG,mBAAmB,CAA8B,WAAW,EAAE,OAAO,EAAE,gBAAgB,CAAC;SAC5F,CAAC,CAAA;QAEF,oDAAoD;QACpD,4BAA4B,CAC1B,gBAAgB,CAAC,KAAK,EACtB,MAAM,CAAC,KAAK,EACZ,KAAK,CAAC,WAAW,EACjB,WAAW,CACZ,CAAA;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAyC;IAChF,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC7B,eAAe,EAAE,KAAK,CAAC,OAAO;QAC9B,qBAAqB,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS;QAC/C,0BAA0B,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC;KAC1F,CAAC,CAAC,CAAA;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CAKnC,eAAmE,EACnE,qBAAyE,EACzE,eAAuB,EACvB,WAAoB;IAEpB,MAAM,OAAO,GAAY,EAAE,CAAA;IAC3B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE;QACjE,MAAM,qBAAqB,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;QACzF,MAAM,uBAAuB,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;QACvF,IAAI,CAAC,qBAAqB,IAAI,uBAAuB,EAAE;YACrD,MAAM,aAAa,GAAG,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YACjF,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAA;SAC9B;KACF;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAM;IAE7C,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,KAAK,EAAE,CAAC,CAAA;IACjF,UAAU,CAAC;QACT,QAAQ,EAAE,CAAC,6BAA6B,EAAE,EAAC,SAAS,EAAE,eAAe,EAAC,EAAE,cAAc,CAAC;QACvF,IAAI,EAAE,CAAC,EAAC,IAAI,EAAE,EAAC,KAAK,EAAC,EAAC,CAAC;KACxB,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,iBAAiB,CACxB,OAAuD;IAEvD,IAAI,CAAC,OAAO,EAAE,KAAK;QAAE,OAAO,OAAO,CAAA;IACnC,OAAO;QACL,GAAG,OAAO;QACV,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACtD,MAAM,cAAc,GAAG,EAAC,GAAI,QAAgC,EAAC,CAAA;YAC7D,OAAO,cAAc,CAAC,OAAO,CAAA;YAC7B,OAAO,CAAC,KAAK,EAAE,cAAc,CAAC,CAAA;QAChC,CAAC,CAAC,CACkB;KACvB,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,WAAoB,EACpB,OAAuD,EACvD,gBAA6C;IAE7C,MAAM,IAAI,GAAa,EAAE,CAAA;IACzB,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACxD,MAAM,uBAAuB,GAAG,OAAO,EAAE,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAC5G,MAAM,qBAAqB,GACzB,gBAAgB,CAAC,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAC/F,IAAI,uBAAuB,IAAI,CAAC,qBAAqB,EAAE;YACrD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;gBAC9B,IAAI,KAAK,KAAK,IAAI,EAAE;oBAClB,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,CAAA;iBACxB;qBAAM;oBACL,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA,0EAA0E,WAAW,CAAC,MAAM,CACvG,KAAK,CACN,YAAY,CACd,CAAA;iBACF;aACF;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC/B,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAA;aAClE;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAA;aACpC;SACF;KACF;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,eAAe,WAAW,CAAA","sourcesContent":["import {errorHandler, registerCleanBugsnagErrorsFromWithinPlugins} from './error-handler.js'\nimport {loadEnvironment} from './environments.js'\nimport {isDevelopment} from './context/local.js'\nimport {addPublicMetadata} from './metadata.js'\nimport {AbortError} from './error.js'\nimport {renderInfo, renderWarning} from './ui.js'\nimport {outputContent, outputInfo, outputToken} from './output.js'\nimport {terminalSupportsRawMode} from './system.js'\nimport {hashString} from './crypto.js'\nimport {isTruthy} from './context/utilities.js'\nimport {JsonMap} from '../../private/common/json.js'\nimport {underscore} from '../common/string.js'\nimport {Command, Errors} from '@oclif/core'\nimport {FlagOutput, Input, ParserOutput, FlagInput, ArgOutput} from '@oclif/core/lib/interfaces/parser.js'\n\ninterface EnvironmentFlags {\n  environment?: string\n  path?: string\n}\n\nabstract class BaseCommand extends Command {\n  public static analyticsNameOverride(): string | undefined {\n    return undefined\n  }\n\n  public static analyticsStopCommand(): string | undefined {\n    return undefined\n  }\n\n  async catch(error: Error & {exitCode?: number | undefined}): Promise<void> {\n    await errorHandler(error, this.config)\n    return Errors.handle(error)\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  protected async init(): Promise<any> {\n    this.exitWithTimestampWhenEnvVariablePresent()\n    if (!isDevelopment()) {\n      // This function runs just prior to `run`\n      await registerCleanBugsnagErrorsFromWithinPlugins(this.config)\n    }\n    this.showNpmFlagWarning()\n    return super.init()\n  }\n\n  // NPM creates an environment variable for every flag passed to a script.\n  // This function checks for the presence of any of the available CLI flags\n  // and warns the user to use the `--` separator.\n  protected showNpmFlagWarning(): void {\n    const commandVariables = this.constructor as unknown as {flags: JsonMap}\n    const commandFlags = Object.keys(commandVariables.flags || {})\n    const possibleNpmEnvVars = commandFlags.map((key) => `npm_config_${underscore(key).replace(/^no_/, '')}`)\n\n    if (possibleNpmEnvVars.some((flag) => process.env[flag] !== undefined)) {\n      renderWarning({\n        body: [\n          'NPM scripts require an extra',\n          {command: '--'},\n          'separator to pass the flags. Example:',\n          {command: 'npm run dev -- --reset'},\n        ],\n      })\n    }\n  }\n\n  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types\n  protected exitWithTimestampWhenEnvVariablePresent() {\n    if (isTruthy(process.env.SHOPIFY_CLI_ENV_STARTUP_PERFORMANCE_RUN)) {\n      outputInfo(`\n      SHOPIFY_CLI_TIMESTAMP_START\n      { \"timestamp\": ${Date.now()} }\n      SHOPIFY_CLI_TIMESTAMP_END\n      `)\n      process.exit(0)\n    }\n  }\n\n  protected async parse<\n    TFlags extends FlagOutput & {path?: string; verbose?: boolean},\n    TGlobalFlags extends FlagOutput,\n    TArgs extends ArgOutput,\n  >(\n    options?: Input<TFlags, TGlobalFlags, TArgs>,\n    argv?: string[],\n  ): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {argv: string[]}> {\n    let result = await super.parse<TFlags, TGlobalFlags, TArgs>(options, argv)\n    result = await this.resultWithEnvironment<TFlags, TGlobalFlags, TArgs>(result, options, argv)\n    await addFromParsedFlags(result.flags)\n    return {...result, ...{argv: result.argv as string[]}}\n  }\n\n  protected environmentsFilename(): string | undefined {\n    // To be re-implemented if needed\n    return undefined\n  }\n\n  protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void {\n    if (terminalSupportsRawMode()) return\n\n    requiredFlags.forEach((name: string) => {\n      if (!(name in flags)) {\n        throw new AbortError(\n          outputContent`Flag not specified:\n\n${outputToken.cyan(name)}\n\nThis flag is required in non-interactive terminal environments, such as a CI environment, or when piping input from another process.`,\n          'To resolve this, specify the option in the command, or run the command in an interactive environment such as your local terminal.',\n        )\n      }\n    })\n  }\n\n  private async resultWithEnvironment<\n    TFlags extends FlagOutput & {path?: string; verbose?: boolean},\n    TGlobalFlags extends FlagOutput,\n    TArgs extends ArgOutput,\n  >(\n    originalResult: ParserOutput<TFlags, TGlobalFlags, TArgs>,\n    options?: Input<TFlags, TGlobalFlags, TArgs>,\n    argv?: string[],\n  ): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs>> {\n    // If no environment is specified, don't modify the results\n    const flags = originalResult.flags as EnvironmentFlags\n    const environmentsFileName = this.environmentsFilename()\n    if (!flags.environment || !environmentsFileName) return originalResult\n\n    // If the specified environment isn't found, don't modify the results\n    const environment = await loadEnvironment(flags.environment, environmentsFileName, {from: flags.path})\n    if (!environment) return originalResult\n\n    // Parse using noDefaultsOptions to derive a list of flags specified as\n    // command-line arguments.\n    const noDefaultsResult = await super.parse<TFlags, TGlobalFlags, TArgs>(noDefaultsOptions(options), argv)\n\n    // Add the environment's settings to argv and pass them to `super.parse`. This\n    // invokes oclif's validation system without breaking the oclif black box.\n    // Replace the original result with this one.\n    const result = await super.parse<TFlags, TGlobalFlags, TArgs>(options, [\n      // Need to specify argv default because we're merging with argsFromEnvironment.\n      ...(argv || this.argv),\n      ...argsFromEnvironment<TFlags, TGlobalFlags, TArgs>(environment, options, noDefaultsResult),\n    ])\n\n    // Report successful application of the environment.\n    reportEnvironmentApplication<TFlags, TGlobalFlags, TArgs>(\n      noDefaultsResult.flags,\n      result.flags,\n      flags.environment,\n      environment,\n    )\n\n    return result\n  }\n}\n\nexport async function addFromParsedFlags(flags: {path?: string; verbose?: boolean}): Promise<void> {\n  await addPublicMetadata(() => ({\n    cmd_all_verbose: flags.verbose,\n    cmd_all_path_override: flags.path !== undefined,\n    cmd_all_path_override_hash: flags.path === undefined ? undefined : hashString(flags.path),\n  }))\n}\n\n/**\n * Any flag which is:\n *\n * 1. Present in the final set of flags\n * 2. Specified in the environment\n * 3. Not specified by the user as a command line argument\n *\n * should be reported.\n *\n * It doesn't matter if the environment flag's value was the same as the default; from\n * the user's perspective, they want to know their environment was applied.\n */\nfunction reportEnvironmentApplication<\n  TFlags extends FlagOutput,\n  TGlobalFlags extends FlagOutput,\n  TArgs extends ArgOutput,\n>(\n  noDefaultsFlags: ParserOutput<TFlags, TGlobalFlags, TArgs>['flags'],\n  flagsWithEnvironments: ParserOutput<TFlags, TGlobalFlags, TArgs>['flags'],\n  environmentName: string,\n  environment: JsonMap,\n): void {\n  const changes: JsonMap = {}\n  for (const [name, value] of Object.entries(flagsWithEnvironments)) {\n    const userSpecifiedThisFlag = Object.prototype.hasOwnProperty.call(noDefaultsFlags, name)\n    const environmentContainsFlag = Object.prototype.hasOwnProperty.call(environment, name)\n    if (!userSpecifiedThisFlag && environmentContainsFlag) {\n      const valueToReport = name === 'password' ? `********${value.substr(-4)}` : value\n      changes[name] = valueToReport\n    }\n  }\n  if (Object.keys(changes).length === 0) return\n\n  const items = Object.entries(changes).map(([name, value]) => `${name}: ${value}`)\n  renderInfo({\n    headline: ['Using applicable flags from', {userInput: environmentName}, 'environment:'],\n    body: [{list: {items}}],\n  })\n}\n\n/**\n * Strips the defaults from configured flags. For example, if flags contains:\n *\n * ```\n *   someFlag: Flags.boolean({\n *     description: 'some flag',\n *     default: false\n *   })\n * ```\n *\n * it becomes:\n *\n * ```\n *   someFlag: Flags.boolean({\n *     description: 'some flag'\n *   })\n * ```\n *\n * If we parse using this configuration, the only specified flags will be those\n * the user actually passed on the command line.\n */\nfunction noDefaultsOptions<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(\n  options: Input<TFlags, TGlobalFlags, TArgs> | undefined,\n): Input<TFlags, TGlobalFlags, TArgs> | undefined {\n  if (!options?.flags) return options\n  return {\n    ...options,\n    flags: Object.fromEntries(\n      Object.entries(options.flags).map(([label, settings]) => {\n        const copiedSettings = {...(settings as {default?: unknown})}\n        delete copiedSettings.default\n        return [label, copiedSettings]\n      }),\n    ) as FlagInput<TFlags>,\n  }\n}\n\n/**\n * Converts the environment's settings to arguments as though passed on the command\n * line, skipping any arguments the user specified on the command line.\n */\nfunction argsFromEnvironment<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(\n  environment: JsonMap,\n  options: Input<TFlags, TGlobalFlags, TArgs> | undefined,\n  noDefaultsResult: ParserOutput<TFlags, TArgs>,\n): string[] {\n  const args: string[] = []\n  for (const [label, value] of Object.entries(environment)) {\n    const flagIsRelevantToCommand = options?.flags && Object.prototype.hasOwnProperty.call(options.flags, label)\n    const userSpecifiedThisFlag =\n      noDefaultsResult.flags && Object.prototype.hasOwnProperty.call(noDefaultsResult.flags, label)\n    if (flagIsRelevantToCommand && !userSpecifiedThisFlag) {\n      if (typeof value === 'boolean') {\n        if (value === true) {\n          args.push(`--${label}`)\n        } else {\n          throw new AbortError(\n            outputContent`Environments can only specify true for boolean flags. Attempted to set ${outputToken.yellow(\n              label,\n            )} to false.`,\n          )\n        }\n      } else if (Array.isArray(value)) {\n        value.forEach((element) => args.push(`--${label}`, `${element}`))\n      } else {\n        args.push(`--${label}`, `${value}`)\n      }\n    }\n  }\n  return args\n}\n\nexport default BaseCommand\n"]}
+{"version":3,"file":"base-command.js","sourceRoot":"","sources":["../../../src/public/node/base-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,2CAA2C,EAAC,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAC,aAAa,EAAC,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAC,iBAAiB,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,EAAC,UAAU,EAAC,MAAM,YAAY,CAAA;AACrC,OAAO,EAAC,UAAU,EAAE,aAAa,EAAC,MAAM,SAAS,CAAA;AACjD,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,aAAa,CAAA;AAClE,OAAO,EAAC,uBAAuB,EAAC,MAAM,aAAa,CAAA;AACnD,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAA;AAE/C,OAAO,EAAC,UAAU,EAAC,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAC,OAAO,EAAE,MAAM,EAAC,MAAM,aAAa,CAAA;AAQ3C,MAAe,WAAY,SAAQ,OAAO;IACxC,gEAAgE;IACzD,MAAM,CAAC,0BAA0B;QACtC,8DAA8D;QAC9D,OAAO,CAAE,IAAY,CAAC,uBAAuB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,6BAA6B,EAAE,WAAW,CAAC,CAAA;IAC1G,CAAC;IAEM,MAAM,CAAC,qBAAqB;QACjC,OAAO,SAAS,CAAA;IAClB,CAAC;IAEM,MAAM,CAAC,oBAAoB;QAChC,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,KAA8C;QACxD,MAAM,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC;IAED,8DAA8D;IACpD,KAAK,CAAC,IAAI;QAClB,IAAI,CAAC,uCAAuC,EAAE,CAAA;QAC9C,IAAI,CAAC,aAAa,EAAE,EAAE;YACpB,yCAAyC;YACzC,MAAM,2CAA2C,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;SAC/D;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAA;QACzB,OAAO,KAAK,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;IAED,yEAAyE;IACzE,0EAA0E;IAC1E,gDAAgD;IACtC,kBAAkB;QAC1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAA0C,CAAA;QACxE,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;QAC9D,MAAM,kBAAkB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;QAEzG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,EAAE;YACtE,aAAa,CAAC;gBACZ,IAAI,EAAE;oBACJ,8BAA8B;oBAC9B,EAAC,OAAO,EAAE,IAAI,EAAC;oBACf,uCAAuC;oBACvC,EAAC,OAAO,EAAE,wBAAwB,EAAC;iBACpC;aACF,CAAC,CAAA;SACH;IACH,CAAC;IAED,6EAA6E;IACnE,uCAAuC;QAC/C,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,EAAE;YACjE,UAAU,CAAC;;uBAEM,IAAI,CAAC,GAAG,EAAE;;OAE1B,CAAC,CAAA;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SAChB;IACH,CAAC;IAES,KAAK,CAAC,KAAK,CAKnB,OAA4C,EAC5C,IAAe;QAEf,IAAI,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAA8B,OAAO,EAAE,IAAI,CAAC,CAAA;QAC1E,MAAM,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAA8B,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;QAC7F,MAAM,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACtC,OAAO,EAAC,GAAG,MAAM,EAAE,GAAG,EAAC,IAAI,EAAE,MAAM,CAAC,IAAgB,EAAC,EAAC,CAAA;IACxD,CAAC;IAES,oBAAoB;QAC5B,iCAAiC;QACjC,OAAO,SAAS,CAAA;IAClB,CAAC;IAES,sBAAsB,CAAC,KAAiB,EAAE,aAAuB;QACzE,IAAI,uBAAuB,EAAE;YAAE,OAAM;QAErC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;YACrC,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE;gBACpB,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA;;EAErB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;;qIAE6G,EAC3H,mIAAmI,CACpI,CAAA;aACF;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAKjC,cAAyD,EACzD,OAA4C,EAC5C,IAAe;QAEf,2DAA2D;QAC3D,MAAM,KAAK,GAAG,cAAc,CAAC,KAAyB,CAAA;QACtD,MAAM,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;QACxD,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,oBAAoB;YAAE,OAAO,cAAc,CAAA;QAEtE,qEAAqE;QACrE,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,WAAW,EAAE,oBAAoB,EAAE,EAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAC,CAAC,CAAA;QACtG,IAAI,CAAC,WAAW;YAAE,OAAO,cAAc,CAAA;QAEvC,uEAAuE;QACvE,0BAA0B;QAC1B,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,KAAK,CAA8B,iBAAiB,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAA;QAEzG,8EAA8E;QAC9E,0EAA0E;QAC1E,6CAA6C;QAC7C,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAA8B,OAAO,EAAE;YACrE,+EAA+E;YAC/E,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;YACtB,GAAG,mBAAmB,CAA8B,WAAW,EAAE,OAAO,EAAE,gBAAgB,CAAC;SAC5F,CAAC,CAAA;QAEF,oDAAoD;QACpD,4BAA4B,CAC1B,gBAAgB,CAAC,KAAK,EACtB,MAAM,CAAC,KAAK,EACZ,KAAK,CAAC,WAAW,EACjB,WAAW,CACZ,CAAA;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAyC;IAChF,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC7B,eAAe,EAAE,KAAK,CAAC,OAAO;QAC9B,qBAAqB,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS;QAC/C,0BAA0B,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC;KAC1F,CAAC,CAAC,CAAA;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CAKnC,eAAmE,EACnE,qBAAyE,EACzE,eAAuB,EACvB,WAAoB;IAEpB,MAAM,OAAO,GAAY,EAAE,CAAA;IAC3B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE;QACjE,MAAM,qBAAqB,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;QACzF,MAAM,uBAAuB,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;QACvF,IAAI,CAAC,qBAAqB,IAAI,uBAAuB,EAAE;YACrD,MAAM,aAAa,GAAG,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YACjF,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAA;SAC9B;KACF;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAM;IAE7C,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,KAAK,KAAK,EAAE,CAAC,CAAA;IACjF,UAAU,CAAC;QACT,QAAQ,EAAE,CAAC,6BAA6B,EAAE,EAAC,SAAS,EAAE,eAAe,EAAC,EAAE,cAAc,CAAC;QACvF,IAAI,EAAE,CAAC,EAAC,IAAI,EAAE,EAAC,KAAK,EAAC,EAAC,CAAC;KACxB,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,iBAAiB,CACxB,OAAuD;IAEvD,IAAI,CAAC,OAAO,EAAE,KAAK;QAAE,OAAO,OAAO,CAAA;IACnC,OAAO;QACL,GAAG,OAAO;QACV,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACtD,MAAM,cAAc,GAAG,EAAC,GAAI,QAAgC,EAAC,CAAA;YAC7D,OAAO,cAAc,CAAC,OAAO,CAAA;YAC7B,OAAO,CAAC,KAAK,EAAE,cAAc,CAAC,CAAA;QAChC,CAAC,CAAC,CACkB;KACvB,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,WAAoB,EACpB,OAAuD,EACvD,gBAA6C;IAE7C,MAAM,IAAI,GAAa,EAAE,CAAA;IACzB,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACxD,MAAM,uBAAuB,GAAG,OAAO,EAAE,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAC5G,MAAM,qBAAqB,GACzB,gBAAgB,CAAC,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAC/F,IAAI,uBAAuB,IAAI,CAAC,qBAAqB,EAAE;YACrD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;gBAC9B,IAAI,KAAK,KAAK,IAAI,EAAE;oBAClB,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,CAAA;iBACxB;qBAAM;oBACL,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA,0EAA0E,WAAW,CAAC,MAAM,CACvG,KAAK,CACN,YAAY,CACd,CAAA;iBACF;aACF;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC/B,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAA;aAClE;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAA;aACpC;SACF;KACF;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,eAAe,WAAW,CAAA","sourcesContent":["import {errorHandler, registerCleanBugsnagErrorsFromWithinPlugins} from './error-handler.js'\nimport {loadEnvironment} from './environments.js'\nimport {isDevelopment} from './context/local.js'\nimport {addPublicMetadata} from './metadata.js'\nimport {AbortError} from './error.js'\nimport {renderInfo, renderWarning} from './ui.js'\nimport {outputContent, outputInfo, outputToken} from './output.js'\nimport {terminalSupportsRawMode} from './system.js'\nimport {hashString} from './crypto.js'\nimport {isTruthy} from './context/utilities.js'\nimport {JsonMap} from '../../private/common/json.js'\nimport {underscore} from '../common/string.js'\nimport {Command, Errors} from '@oclif/core'\nimport {FlagOutput, Input, ParserOutput, FlagInput, ArgOutput} from '@oclif/core/lib/interfaces/parser.js'\n\ninterface EnvironmentFlags {\n  environment?: string\n  path?: string\n}\n\nabstract class BaseCommand extends Command {\n  // Replace markdown links to plain text like: \"link label\" (url)\n  public static descriptionWithoutMarkdown(): string | undefined {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    return ((this as any).descriptionWithMarkdown ?? '').replace(/(\\[)(.*?)(])(\\()(.*?)(\\))/gm, '\"$2\" ($5)')\n  }\n\n  public static analyticsNameOverride(): string | undefined {\n    return undefined\n  }\n\n  public static analyticsStopCommand(): string | undefined {\n    return undefined\n  }\n\n  async catch(error: Error & {exitCode?: number | undefined}): Promise<void> {\n    await errorHandler(error, this.config)\n    return Errors.handle(error)\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  protected async init(): Promise<any> {\n    this.exitWithTimestampWhenEnvVariablePresent()\n    if (!isDevelopment()) {\n      // This function runs just prior to `run`\n      await registerCleanBugsnagErrorsFromWithinPlugins(this.config)\n    }\n    this.showNpmFlagWarning()\n    return super.init()\n  }\n\n  // NPM creates an environment variable for every flag passed to a script.\n  // This function checks for the presence of any of the available CLI flags\n  // and warns the user to use the `--` separator.\n  protected showNpmFlagWarning(): void {\n    const commandVariables = this.constructor as unknown as {flags: JsonMap}\n    const commandFlags = Object.keys(commandVariables.flags || {})\n    const possibleNpmEnvVars = commandFlags.map((key) => `npm_config_${underscore(key).replace(/^no_/, '')}`)\n\n    if (possibleNpmEnvVars.some((flag) => process.env[flag] !== undefined)) {\n      renderWarning({\n        body: [\n          'NPM scripts require an extra',\n          {command: '--'},\n          'separator to pass the flags. Example:',\n          {command: 'npm run dev -- --reset'},\n        ],\n      })\n    }\n  }\n\n  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types\n  protected exitWithTimestampWhenEnvVariablePresent() {\n    if (isTruthy(process.env.SHOPIFY_CLI_ENV_STARTUP_PERFORMANCE_RUN)) {\n      outputInfo(`\n      SHOPIFY_CLI_TIMESTAMP_START\n      { \"timestamp\": ${Date.now()} }\n      SHOPIFY_CLI_TIMESTAMP_END\n      `)\n      process.exit(0)\n    }\n  }\n\n  protected async parse<\n    TFlags extends FlagOutput & {path?: string; verbose?: boolean},\n    TGlobalFlags extends FlagOutput,\n    TArgs extends ArgOutput,\n  >(\n    options?: Input<TFlags, TGlobalFlags, TArgs>,\n    argv?: string[],\n  ): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {argv: string[]}> {\n    let result = await super.parse<TFlags, TGlobalFlags, TArgs>(options, argv)\n    result = await this.resultWithEnvironment<TFlags, TGlobalFlags, TArgs>(result, options, argv)\n    await addFromParsedFlags(result.flags)\n    return {...result, ...{argv: result.argv as string[]}}\n  }\n\n  protected environmentsFilename(): string | undefined {\n    // To be re-implemented if needed\n    return undefined\n  }\n\n  protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void {\n    if (terminalSupportsRawMode()) return\n\n    requiredFlags.forEach((name: string) => {\n      if (!(name in flags)) {\n        throw new AbortError(\n          outputContent`Flag not specified:\n\n${outputToken.cyan(name)}\n\nThis flag is required in non-interactive terminal environments, such as a CI environment, or when piping input from another process.`,\n          'To resolve this, specify the option in the command, or run the command in an interactive environment such as your local terminal.',\n        )\n      }\n    })\n  }\n\n  private async resultWithEnvironment<\n    TFlags extends FlagOutput & {path?: string; verbose?: boolean},\n    TGlobalFlags extends FlagOutput,\n    TArgs extends ArgOutput,\n  >(\n    originalResult: ParserOutput<TFlags, TGlobalFlags, TArgs>,\n    options?: Input<TFlags, TGlobalFlags, TArgs>,\n    argv?: string[],\n  ): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs>> {\n    // If no environment is specified, don't modify the results\n    const flags = originalResult.flags as EnvironmentFlags\n    const environmentsFileName = this.environmentsFilename()\n    if (!flags.environment || !environmentsFileName) return originalResult\n\n    // If the specified environment isn't found, don't modify the results\n    const environment = await loadEnvironment(flags.environment, environmentsFileName, {from: flags.path})\n    if (!environment) return originalResult\n\n    // Parse using noDefaultsOptions to derive a list of flags specified as\n    // command-line arguments.\n    const noDefaultsResult = await super.parse<TFlags, TGlobalFlags, TArgs>(noDefaultsOptions(options), argv)\n\n    // Add the environment's settings to argv and pass them to `super.parse`. This\n    // invokes oclif's validation system without breaking the oclif black box.\n    // Replace the original result with this one.\n    const result = await super.parse<TFlags, TGlobalFlags, TArgs>(options, [\n      // Need to specify argv default because we're merging with argsFromEnvironment.\n      ...(argv || this.argv),\n      ...argsFromEnvironment<TFlags, TGlobalFlags, TArgs>(environment, options, noDefaultsResult),\n    ])\n\n    // Report successful application of the environment.\n    reportEnvironmentApplication<TFlags, TGlobalFlags, TArgs>(\n      noDefaultsResult.flags,\n      result.flags,\n      flags.environment,\n      environment,\n    )\n\n    return result\n  }\n}\n\nexport async function addFromParsedFlags(flags: {path?: string; verbose?: boolean}): Promise<void> {\n  await addPublicMetadata(() => ({\n    cmd_all_verbose: flags.verbose,\n    cmd_all_path_override: flags.path !== undefined,\n    cmd_all_path_override_hash: flags.path === undefined ? undefined : hashString(flags.path),\n  }))\n}\n\n/**\n * Any flag which is:\n *\n * 1. Present in the final set of flags\n * 2. Specified in the environment\n * 3. Not specified by the user as a command line argument\n *\n * should be reported.\n *\n * It doesn't matter if the environment flag's value was the same as the default; from\n * the user's perspective, they want to know their environment was applied.\n */\nfunction reportEnvironmentApplication<\n  TFlags extends FlagOutput,\n  TGlobalFlags extends FlagOutput,\n  TArgs extends ArgOutput,\n>(\n  noDefaultsFlags: ParserOutput<TFlags, TGlobalFlags, TArgs>['flags'],\n  flagsWithEnvironments: ParserOutput<TFlags, TGlobalFlags, TArgs>['flags'],\n  environmentName: string,\n  environment: JsonMap,\n): void {\n  const changes: JsonMap = {}\n  for (const [name, value] of Object.entries(flagsWithEnvironments)) {\n    const userSpecifiedThisFlag = Object.prototype.hasOwnProperty.call(noDefaultsFlags, name)\n    const environmentContainsFlag = Object.prototype.hasOwnProperty.call(environment, name)\n    if (!userSpecifiedThisFlag && environmentContainsFlag) {\n      const valueToReport = name === 'password' ? `********${value.substr(-4)}` : value\n      changes[name] = valueToReport\n    }\n  }\n  if (Object.keys(changes).length === 0) return\n\n  const items = Object.entries(changes).map(([name, value]) => `${name}: ${value}`)\n  renderInfo({\n    headline: ['Using applicable flags from', {userInput: environmentName}, 'environment:'],\n    body: [{list: {items}}],\n  })\n}\n\n/**\n * Strips the defaults from configured flags. For example, if flags contains:\n *\n * ```\n *   someFlag: Flags.boolean({\n *     description: 'some flag',\n *     default: false\n *   })\n * ```\n *\n * it becomes:\n *\n * ```\n *   someFlag: Flags.boolean({\n *     description: 'some flag'\n *   })\n * ```\n *\n * If we parse using this configuration, the only specified flags will be those\n * the user actually passed on the command line.\n */\nfunction noDefaultsOptions<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(\n  options: Input<TFlags, TGlobalFlags, TArgs> | undefined,\n): Input<TFlags, TGlobalFlags, TArgs> | undefined {\n  if (!options?.flags) return options\n  return {\n    ...options,\n    flags: Object.fromEntries(\n      Object.entries(options.flags).map(([label, settings]) => {\n        const copiedSettings = {...(settings as {default?: unknown})}\n        delete copiedSettings.default\n        return [label, copiedSettings]\n      }),\n    ) as FlagInput<TFlags>,\n  }\n}\n\n/**\n * Converts the environment's settings to arguments as though passed on the command\n * line, skipping any arguments the user specified on the command line.\n */\nfunction argsFromEnvironment<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(\n  environment: JsonMap,\n  options: Input<TFlags, TGlobalFlags, TArgs> | undefined,\n  noDefaultsResult: ParserOutput<TFlags, TArgs>,\n): string[] {\n  const args: string[] = []\n  for (const [label, value] of Object.entries(environment)) {\n    const flagIsRelevantToCommand = options?.flags && Object.prototype.hasOwnProperty.call(options.flags, label)\n    const userSpecifiedThisFlag =\n      noDefaultsResult.flags && Object.prototype.hasOwnProperty.call(noDefaultsResult.flags, label)\n    if (flagIsRelevantToCommand && !userSpecifiedThisFlag) {\n      if (typeof value === 'boolean') {\n        if (value === true) {\n          args.push(`--${label}`)\n        } else {\n          throw new AbortError(\n            outputContent`Environments can only specify true for boolean flags. Attempted to set ${outputToken.yellow(\n              label,\n            )} to false.`,\n          )\n        }\n      } else if (Array.isArray(value)) {\n        value.forEach((element) => args.push(`--${label}`, `${element}`))\n      } else {\n        args.push(`--${label}`, `${value}`)\n      }\n    }\n  }\n  return args\n}\n\nexport default BaseCommand\n"]}

package/dist/public/node/cli.js

@@ -1,6 +1,8 @@
 import { isTruthy } from './context/utilities.js';
 import { printEventsJson } from '../../private/node/demo-recorder.js';
 import { Flags } from '@oclif/core';
+// eslint-disable-next-line @shopify/cli/specific-imports-in-bootstrap-code
+import { fileURLToPath } from 'url';
 async function warnIfOldNodeVersion() {
     const nodeVersion = process.versions.node;
     const nodeMajorVersion = Number(nodeVersion.split('.')[0]);
@@ -61,11 +63,15 @@ export async function runCLI(options) {
     const { errorHandler } = await import('./error-handler.js');
     const { isDevelopment } = await import('./context/local.js');
     const { run, settings, flush, Errors } = await import('@oclif/core');
+    const { ShopifyConfig } = await import('./custom-oclif-loader.js');
     if (isDevelopment()) {
         settings.debug = true;
     }
     try {
-        await run(undefined, options.moduleURL);
+        // Use a custom OCLIF config to customize the behavior of the CLI
+        const config = new ShopifyConfig({ root: fileURLToPath(options.moduleURL) });
+        await config.load();
+        await run(undefined, config);
         await flush();
         printEventsJson();
         // eslint-disable-next-line no-catch-all/no-catch-all

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

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/public/node/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAA;AAC/C,OAAO,EAAC,eAAe,EAAC,MAAM,qCAAqC,CAAA;AACnE,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AAajC,KAAK,UAAU,oBAAoB;IACjC,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAA;IACzC,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE1D,MAAM,2BAA2B,GAAG,EAAE,CAAA;IACtC,IAAI,gBAAgB,GAAG,2BAA2B,EAAE;QAClD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAA;QAC/C,aAAa,CAAC;YACZ,QAAQ,EAAE,0CAA0C;YACpD,IAAI,EAAE;gBACJ,QAAQ,gBAAgB,0EAA0E;gBAClG;oBACE,IAAI,EAAE;wBACJ,GAAG,EAAE,+CAA+C;wBACpD,KAAK,EAAE,mBAAmB;qBAC3B;iBACF;gBACD,EAAC,IAAI,EAAE,GAAG,EAAC;gBACX,yDAAyD;aAC1D;SACF,CAAC,CAAA;KACH;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,OAA2C;IAC5E;;;;OAIG;IACH,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;QACtC,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAA;KAC7C;IACD,IAAI,OAAO,CAAC,WAAW,EAAE;QACvB,OAAO,CAAC,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,aAAa,CAAA;KAC3E;AACH,CAAC;AAED,SAAS,YAAY;IACnB,IACE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QACnC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC9B,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,EAC3B;QACA,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,GAAG,CAAA;KAC9B;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAsB;IACjD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAClC,YAAY,EAAE,CAAA;IACd,MAAM,oBAAoB,EAAE,CAAA;IAC5B;;;;OAIG;IACH,MAAM,EAAC,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAA;IACzD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAA;IAC1D,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAElE,IAAI,aAAa,EAAE,EAAE;QACnB,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAA;KACtB;IAED,IAAI;QACF,MAAM,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;QACvC,MAAM,KAAK,EAAE,CAAA;QACb,eAAe,EAAE,CAAA;QACjB,qDAAqD;KACtD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,YAAY,CAAC,KAAc,CAAC,CAAA;QAClC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAc,CAAC,CAAA;KACrC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB;IACvD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAElC,MAAM,EAAC,wBAAwB,EAAC,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,CAAA;IAC5E,MAAM,EAAC,eAAe,EAAC,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;IAEnD,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IACtF,8DAA8D;IAC9D,MAAM,WAAW,GAAI,WAAW,CAAC,OAAe,CAAC,IAAc,CAAA;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACvE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;QACpB,MAAM,SAAS,GACb,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACtG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAC1C;IACD,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;AACvB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAgB;IAC1D,MAAM,EAAC,oBAAoB,EAAC,GAAG,MAAM,MAAM,CAAC,iCAAiC,CAAC,CAAA;IAC9E,MAAM,EAAC,QAAQ,EAAE,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;IAClD,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAE1C,oFAAoF;IACpF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAEhF,8EAA8E;IAC9E,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAE7E,wFAAwF;IACxF,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB;QAAE,OAAO,KAAK,CAAA;IAEnD,MAAM,UAAU,GAAG,MAAM,eAAe,EAAE,CAAA;IAC1C,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAE7B,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3E,IAAI,qBAAqB,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACpD,IAAI;QACF,MAAM,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YAC5E,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,EAAC,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,GAAG,EAAC;SACnD,CAAC,CAAA;QACF,yFAAyF;KAC1F;IAAC,OAAO,YAAiB,EAAE;QAC1B,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;KACpC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAaD,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAEnD,IAAI,aAAa,GAAG,EAAE,CAAA;IACtB,IAAI,eAAe,GAAgB,EAAE,CAAA;IACrC,IAAI;QACF,aAAa,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;QACpF,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QAC3C,qDAAqD;KACtD;IAAC,OAAO,GAAG,EAAE;QACZ,OAAM;KACP;IACD,MAAM,gBAAgB,GAAG;QACvB,GAAG,eAAe,CAAC,gBAAgB;QACnC,GAAG,eAAe,CAAC,eAAe;QAClC,GAAG,eAAe,CAAC,YAAY;KAChC,CAAA;IACD,OAAO,gBAAgB,CAAC,cAAc,CAAC,CAAA;AACzC,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC;QACxB,MAAM,EAAE,KAAK;QACb,WAAW,EAAE,uBAAuB;QACpC,GAAG,EAAE,uBAAuB;KAC7B,CAAC;IACF,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACrB,MAAM,EAAE,KAAK;QACb,WAAW,EAAE,qCAAqC;QAClD,GAAG,EAAE,sBAAsB;KAC5B,CAAC;CACH,CAAA;AAED,eAAe,MAAM,CAAA","sourcesContent":["import {isTruthy} from './context/utilities.js'\nimport {printEventsJson} from '../../private/node/demo-recorder.js'\nimport {Flags} from '@oclif/core'\n\n/**\n * IMPORTANT NOTE: Imports in this module are dynamic to ensure that \"setupEnvironmentVariables\" can dynamically\n * set the DEBUG environment variable before the 'debug' package sets up its configuration when modules\n * are loaded statically.\n */\ninterface RunCLIOptions {\n  /** The value of import.meta.url of the CLI executable module */\n  moduleURL: string\n  development: boolean\n}\n\nasync function warnIfOldNodeVersion() {\n  const nodeVersion = process.versions.node\n  const nodeMajorVersion = Number(nodeVersion.split('.')[0])\n\n  const currentSupportedNodeVersion = 18\n  if (nodeMajorVersion < currentSupportedNodeVersion) {\n    const {renderWarning} = await import('./ui.js')\n    renderWarning({\n      headline: 'Upgrade to a supported Node version now.',\n      body: [\n        `Node ${nodeMajorVersion} has reached end-of-life and poses security risks. When you upgrade to a`,\n        {\n          link: {\n            url: 'https://nodejs.dev/en/about/previous-releases',\n            label: 'supported version',\n          },\n        },\n        {char: ','},\n        \"you'll be able to use Shopify CLI without interruption.\",\n      ],\n    })\n  }\n}\n\nfunction setupEnvironmentVariables(options: Pick<RunCLIOptions, 'development'>) {\n  /**\n   * By setting DEBUG=* when --verbose is passed we are increasing the\n   * verbosity of oclif. Oclif uses debug (https://www.npmjs.com/package/debug)\n   * for logging, and it's configured through the DEBUG= environment variable.\n   */\n  if (process.argv.includes('--verbose')) {\n    process.env.DEBUG = process.env.DEBUG ?? '*'\n  }\n  if (options.development) {\n    process.env.SHOPIFY_CLI_ENV = process.env.SHOPIFY_CLI_ENV ?? 'development'\n  }\n}\n\nfunction forceNoColor() {\n  if (\n    process.argv.includes('--no-color') ||\n    isTruthy(process.env.NO_COLOR) ||\n    isTruthy(process.env.SHOPIFY_FLAG_NO_COLOR) ||\n    process.env.TERM === 'dumb'\n  ) {\n    process.env.FORCE_COLOR = '0'\n  }\n}\n\n/**\n * A function that abstracts away setting up the environment and running\n * a CLI\n * @param options - Options.\n */\nexport async function runCLI(options: RunCLIOptions): Promise<void> {\n  setupEnvironmentVariables(options)\n  forceNoColor()\n  await warnIfOldNodeVersion()\n  /**\n   * These imports need to be dynamic because if they are static\n   * they are loaded before we set the DEBUG=* environment variable\n   * and therefore it has no effect.\n   */\n  const {errorHandler} = await import('./error-handler.js')\n  const {isDevelopment} = await import('./context/local.js')\n  const {run, settings, flush, Errors} = await import('@oclif/core')\n\n  if (isDevelopment()) {\n    settings.debug = true\n  }\n\n  try {\n    await run(undefined, options.moduleURL)\n    await flush()\n    printEventsJson()\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (error) {\n    await errorHandler(error as Error)\n    return Errors.handle(error as Error)\n  }\n}\n\n/**\n * A function for create-x CLIs that automatically runs the \"init\" command.\n */\nexport async function runCreateCLI(options: RunCLIOptions): Promise<void> {\n  setupEnvironmentVariables(options)\n\n  const {findUpAndReadPackageJson} = await import('./node-package-manager.js')\n  const {moduleDirectory} = await import('./path.js')\n\n  const packageJson = await findUpAndReadPackageJson(moduleDirectory(options.moduleURL))\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const packageName = (packageJson.content as any).name as string\n  const name = packageName.replace('@shopify/create-', '')\n  const initIndex = process.argv.findIndex((arg) => arg.includes('init'))\n  if (initIndex === -1) {\n    const initIndex =\n      process.argv.findIndex((arg) => arg.match(new RegExp(`bin(\\\\/|\\\\\\\\)+(create-${name}|dev|run)`))) + 1\n    process.argv.splice(initIndex, 0, 'init')\n  }\n  await runCLI(options)\n}\n\nexport async function useLocalCLIIfDetected(filepath: string): Promise<boolean> {\n  const {environmentVariables} = await import('../../private/node/constants.js')\n  const {joinPath: join} = await import('./path.js')\n  const {exec} = await import('./system.js')\n\n  // Temporary flag while we test out this feature and ensure it won't break anything!\n  if (!isTruthy(process.env[environmentVariables.enableCliRedirect])) return false\n\n  // Setting an env variable in the child process prevents accidental recursion.\n  if (isTruthy(process.env[environmentVariables.skipCliRedirect])) return false\n\n  // If already running via package manager, we can assume it's running correctly already.\n  if (process.env.npm_config_user_agent) return false\n\n  const cliPackage = await localCliPackage()\n  if (!cliPackage) return false\n\n  const correctExecutablePath = join(cliPackage.path, cliPackage.bin.shopify)\n  if (correctExecutablePath === filepath) return false\n  try {\n    await exec(correctExecutablePath, process.argv.slice(2, process.argv.length), {\n      stdio: 'inherit',\n      env: {[environmentVariables.skipCliRedirect]: '1'},\n    })\n    // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any\n  } catch (processError: any) {\n    process.exit(processError.exitCode)\n  }\n  return true\n}\n\ninterface CliPackageInfo {\n  path: string\n  bin: {shopify: string}\n}\n\ninterface PackageJSON {\n  dependencies?: {[packageName: string]: CliPackageInfo}\n  devDependencies?: {[packageName: string]: CliPackageInfo}\n  peerDependencies?: {[packageName: string]: CliPackageInfo}\n}\n\nexport async function localCliPackage(): Promise<CliPackageInfo | undefined> {\n  const {captureOutput} = await import('./system.js')\n\n  let npmListOutput = ''\n  let localShopifyCLI: PackageJSON = {}\n  try {\n    npmListOutput = await captureOutput('npm', ['list', '@shopify/cli', '--json', '-l'])\n    localShopifyCLI = JSON.parse(npmListOutput)\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (err) {\n    return\n  }\n  const dependenciesList = {\n    ...localShopifyCLI.peerDependencies,\n    ...localShopifyCLI.devDependencies,\n    ...localShopifyCLI.dependencies,\n  }\n  return dependenciesList['@shopify/cli']\n}\n\n/**\n * An object that contains the flags that\n * are shared across all the commands.\n */\nexport const globalFlags = {\n  'no-color': Flags.boolean({\n    hidden: false,\n    description: 'Disable color output.',\n    env: 'SHOPIFY_FLAG_NO_COLOR',\n  }),\n  verbose: Flags.boolean({\n    hidden: false,\n    description: 'Increase the verbosity of the logs.',\n    env: 'SHOPIFY_FLAG_VERBOSE',\n  }),\n}\n\nexport default runCLI\n"]}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/public/node/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAA;AAC/C,OAAO,EAAC,eAAe,EAAC,MAAM,qCAAqC,CAAA;AACnE,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AACjC,2EAA2E;AAC3E,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAA;AAajC,KAAK,UAAU,oBAAoB;IACjC,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAA;IACzC,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE1D,MAAM,2BAA2B,GAAG,EAAE,CAAA;IACtC,IAAI,gBAAgB,GAAG,2BAA2B,EAAE;QAClD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAA;QAC/C,aAAa,CAAC;YACZ,QAAQ,EAAE,0CAA0C;YACpD,IAAI,EAAE;gBACJ,QAAQ,gBAAgB,0EAA0E;gBAClG;oBACE,IAAI,EAAE;wBACJ,GAAG,EAAE,+CAA+C;wBACpD,KAAK,EAAE,mBAAmB;qBAC3B;iBACF;gBACD,EAAC,IAAI,EAAE,GAAG,EAAC;gBACX,yDAAyD;aAC1D;SACF,CAAC,CAAA;KACH;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,OAA2C;IAC5E;;;;OAIG;IACH,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;QACtC,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAA;KAC7C;IACD,IAAI,OAAO,CAAC,WAAW,EAAE;QACvB,OAAO,CAAC,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,aAAa,CAAA;KAC3E;AACH,CAAC;AAED,SAAS,YAAY;IACnB,IACE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QACnC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC9B,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,EAC3B;QACA,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,GAAG,CAAA;KAC9B;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAsB;IACjD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAClC,YAAY,EAAE,CAAA;IACd,MAAM,oBAAoB,EAAE,CAAA;IAC5B;;;;OAIG;IACH,MAAM,EAAC,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAA;IACzD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAA;IAC1D,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAClE,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,0BAA0B,CAAC,CAAA;IAEhE,IAAI,aAAa,EAAE,EAAE;QACnB,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAA;KACtB;IAED,IAAI;QACF,iEAAiE;QACjE,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,EAAC,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,EAAC,CAAC,CAAA;QAC1E,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;QAEnB,MAAM,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;QAC5B,MAAM,KAAK,EAAE,CAAA;QACb,eAAe,EAAE,CAAA;QACjB,qDAAqD;KACtD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,YAAY,CAAC,KAAc,CAAC,CAAA;QAClC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAc,CAAC,CAAA;KACrC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB;IACvD,yBAAyB,CAAC,OAAO,CAAC,CAAA;IAElC,MAAM,EAAC,wBAAwB,EAAC,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,CAAA;IAC5E,MAAM,EAAC,eAAe,EAAC,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;IAEnD,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IACtF,8DAA8D;IAC9D,MAAM,WAAW,GAAI,WAAW,CAAC,OAAe,CAAC,IAAc,CAAA;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACvE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;QACpB,MAAM,SAAS,GACb,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACtG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAC1C;IACD,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;AACvB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAgB;IAC1D,MAAM,EAAC,oBAAoB,EAAC,GAAG,MAAM,MAAM,CAAC,iCAAiC,CAAC,CAAA;IAC9E,MAAM,EAAC,QAAQ,EAAE,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;IAClD,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAE1C,oFAAoF;IACpF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAEhF,8EAA8E;IAC9E,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAE7E,wFAAwF;IACxF,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB;QAAE,OAAO,KAAK,CAAA;IAEnD,MAAM,UAAU,GAAG,MAAM,eAAe,EAAE,CAAA;IAC1C,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAE7B,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3E,IAAI,qBAAqB,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACpD,IAAI;QACF,MAAM,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YAC5E,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,EAAC,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,GAAG,EAAC;SACnD,CAAC,CAAA;QACF,yFAAyF;KAC1F;IAAC,OAAO,YAAiB,EAAE;QAC1B,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;KACpC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAaD,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAA;IAEnD,IAAI,aAAa,GAAG,EAAE,CAAA;IACtB,IAAI,eAAe,GAAgB,EAAE,CAAA;IACrC,IAAI;QACF,aAAa,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;QACpF,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QAC3C,qDAAqD;KACtD;IAAC,OAAO,GAAG,EAAE;QACZ,OAAM;KACP;IACD,MAAM,gBAAgB,GAAG;QACvB,GAAG,eAAe,CAAC,gBAAgB;QACnC,GAAG,eAAe,CAAC,eAAe;QAClC,GAAG,eAAe,CAAC,YAAY;KAChC,CAAA;IACD,OAAO,gBAAgB,CAAC,cAAc,CAAC,CAAA;AACzC,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC;QACxB,MAAM,EAAE,KAAK;QACb,WAAW,EAAE,uBAAuB;QACpC,GAAG,EAAE,uBAAuB;KAC7B,CAAC;IACF,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACrB,MAAM,EAAE,KAAK;QACb,WAAW,EAAE,qCAAqC;QAClD,GAAG,EAAE,sBAAsB;KAC5B,CAAC;CACH,CAAA;AAED,eAAe,MAAM,CAAA","sourcesContent":["import {isTruthy} from './context/utilities.js'\nimport {printEventsJson} from '../../private/node/demo-recorder.js'\nimport {Flags} from '@oclif/core'\n// eslint-disable-next-line @shopify/cli/specific-imports-in-bootstrap-code\nimport {fileURLToPath} from 'url'\n\n/**\n * IMPORTANT NOTE: Imports in this module are dynamic to ensure that \"setupEnvironmentVariables\" can dynamically\n * set the DEBUG environment variable before the 'debug' package sets up its configuration when modules\n * are loaded statically.\n */\ninterface RunCLIOptions {\n  /** The value of import.meta.url of the CLI executable module */\n  moduleURL: string\n  development: boolean\n}\n\nasync function warnIfOldNodeVersion() {\n  const nodeVersion = process.versions.node\n  const nodeMajorVersion = Number(nodeVersion.split('.')[0])\n\n  const currentSupportedNodeVersion = 18\n  if (nodeMajorVersion < currentSupportedNodeVersion) {\n    const {renderWarning} = await import('./ui.js')\n    renderWarning({\n      headline: 'Upgrade to a supported Node version now.',\n      body: [\n        `Node ${nodeMajorVersion} has reached end-of-life and poses security risks. When you upgrade to a`,\n        {\n          link: {\n            url: 'https://nodejs.dev/en/about/previous-releases',\n            label: 'supported version',\n          },\n        },\n        {char: ','},\n        \"you'll be able to use Shopify CLI without interruption.\",\n      ],\n    })\n  }\n}\n\nfunction setupEnvironmentVariables(options: Pick<RunCLIOptions, 'development'>) {\n  /**\n   * By setting DEBUG=* when --verbose is passed we are increasing the\n   * verbosity of oclif. Oclif uses debug (https://www.npmjs.com/package/debug)\n   * for logging, and it's configured through the DEBUG= environment variable.\n   */\n  if (process.argv.includes('--verbose')) {\n    process.env.DEBUG = process.env.DEBUG ?? '*'\n  }\n  if (options.development) {\n    process.env.SHOPIFY_CLI_ENV = process.env.SHOPIFY_CLI_ENV ?? 'development'\n  }\n}\n\nfunction forceNoColor() {\n  if (\n    process.argv.includes('--no-color') ||\n    isTruthy(process.env.NO_COLOR) ||\n    isTruthy(process.env.SHOPIFY_FLAG_NO_COLOR) ||\n    process.env.TERM === 'dumb'\n  ) {\n    process.env.FORCE_COLOR = '0'\n  }\n}\n\n/**\n * A function that abstracts away setting up the environment and running\n * a CLI\n * @param options - Options.\n */\nexport async function runCLI(options: RunCLIOptions): Promise<void> {\n  setupEnvironmentVariables(options)\n  forceNoColor()\n  await warnIfOldNodeVersion()\n  /**\n   * These imports need to be dynamic because if they are static\n   * they are loaded before we set the DEBUG=* environment variable\n   * and therefore it has no effect.\n   */\n  const {errorHandler} = await import('./error-handler.js')\n  const {isDevelopment} = await import('./context/local.js')\n  const {run, settings, flush, Errors} = await import('@oclif/core')\n  const {ShopifyConfig} = await import('./custom-oclif-loader.js')\n\n  if (isDevelopment()) {\n    settings.debug = true\n  }\n\n  try {\n    // Use a custom OCLIF config to customize the behavior of the CLI\n    const config = new ShopifyConfig({root: fileURLToPath(options.moduleURL)})\n    await config.load()\n\n    await run(undefined, config)\n    await flush()\n    printEventsJson()\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (error) {\n    await errorHandler(error as Error)\n    return Errors.handle(error as Error)\n  }\n}\n\n/**\n * A function for create-x CLIs that automatically runs the \"init\" command.\n */\nexport async function runCreateCLI(options: RunCLIOptions): Promise<void> {\n  setupEnvironmentVariables(options)\n\n  const {findUpAndReadPackageJson} = await import('./node-package-manager.js')\n  const {moduleDirectory} = await import('./path.js')\n\n  const packageJson = await findUpAndReadPackageJson(moduleDirectory(options.moduleURL))\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const packageName = (packageJson.content as any).name as string\n  const name = packageName.replace('@shopify/create-', '')\n  const initIndex = process.argv.findIndex((arg) => arg.includes('init'))\n  if (initIndex === -1) {\n    const initIndex =\n      process.argv.findIndex((arg) => arg.match(new RegExp(`bin(\\\\/|\\\\\\\\)+(create-${name}|dev|run)`))) + 1\n    process.argv.splice(initIndex, 0, 'init')\n  }\n  await runCLI(options)\n}\n\nexport async function useLocalCLIIfDetected(filepath: string): Promise<boolean> {\n  const {environmentVariables} = await import('../../private/node/constants.js')\n  const {joinPath: join} = await import('./path.js')\n  const {exec} = await import('./system.js')\n\n  // Temporary flag while we test out this feature and ensure it won't break anything!\n  if (!isTruthy(process.env[environmentVariables.enableCliRedirect])) return false\n\n  // Setting an env variable in the child process prevents accidental recursion.\n  if (isTruthy(process.env[environmentVariables.skipCliRedirect])) return false\n\n  // If already running via package manager, we can assume it's running correctly already.\n  if (process.env.npm_config_user_agent) return false\n\n  const cliPackage = await localCliPackage()\n  if (!cliPackage) return false\n\n  const correctExecutablePath = join(cliPackage.path, cliPackage.bin.shopify)\n  if (correctExecutablePath === filepath) return false\n  try {\n    await exec(correctExecutablePath, process.argv.slice(2, process.argv.length), {\n      stdio: 'inherit',\n      env: {[environmentVariables.skipCliRedirect]: '1'},\n    })\n    // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any\n  } catch (processError: any) {\n    process.exit(processError.exitCode)\n  }\n  return true\n}\n\ninterface CliPackageInfo {\n  path: string\n  bin: {shopify: string}\n}\n\ninterface PackageJSON {\n  dependencies?: {[packageName: string]: CliPackageInfo}\n  devDependencies?: {[packageName: string]: CliPackageInfo}\n  peerDependencies?: {[packageName: string]: CliPackageInfo}\n}\n\nexport async function localCliPackage(): Promise<CliPackageInfo | undefined> {\n  const {captureOutput} = await import('./system.js')\n\n  let npmListOutput = ''\n  let localShopifyCLI: PackageJSON = {}\n  try {\n    npmListOutput = await captureOutput('npm', ['list', '@shopify/cli', '--json', '-l'])\n    localShopifyCLI = JSON.parse(npmListOutput)\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (err) {\n    return\n  }\n  const dependenciesList = {\n    ...localShopifyCLI.peerDependencies,\n    ...localShopifyCLI.devDependencies,\n    ...localShopifyCLI.dependencies,\n  }\n  return dependenciesList['@shopify/cli']\n}\n\n/**\n * An object that contains the flags that\n * are shared across all the commands.\n */\nexport const globalFlags = {\n  'no-color': Flags.boolean({\n    hidden: false,\n    description: 'Disable color output.',\n    env: 'SHOPIFY_FLAG_NO_COLOR',\n  }),\n  verbose: Flags.boolean({\n    hidden: false,\n    description: 'Increase the verbosity of the logs.',\n    env: 'SHOPIFY_FLAG_VERBOSE',\n  }),\n}\n\nexport default runCLI\n"]}

package/dist/public/node/context/fqdn.d.ts

@@ -9,6 +9,12 @@ export declare const NotProvidedStoreFQDNError: AbortError;
  * @returns Fully-qualified domain of the partners service we should interact with.
  */
 export declare function partnersFqdn(): Promise<string>;
+/**
+ * It returns the Shopify Developers' API service we should interact with.
+ *
+ * @returns Fully-qualified domain of the Shopify Developers service we should interact with.
+ */
+export declare function shopifyDevelopersFqdn(): Promise<string>;
 /**
  * It returns the BusinessPlatform' API service we should interact with.
  *

package/dist/public/node/context/fqdn.js

@@ -22,6 +22,23 @@ export async function partnersFqdn() {
             return productionFqdn;
     }
 }
+/**
+ * It returns the Shopify Developers' API service we should interact with.
+ *
+ * @returns Fully-qualified domain of the Shopify Developers service we should interact with.
+ */
+export async function shopifyDevelopersFqdn() {
+    const environment = serviceEnvironment();
+    const productionFqdn = 'shopify.com';
+    switch (environment) {
+        case 'local':
+            return 'app.shopify.myshopify.io';
+        case 'spin':
+            return `app.shopify.${await spinFqdn()}`;
+        default:
+            return productionFqdn;
+    }
+}
 /**
  * It returns the BusinessPlatform' API service we should interact with.
  *

package/dist/public/node/context/fqdn.js.map

@@ -1 +1 @@
-{"version":3,"file":"fqdn.js","sourceRoot":"","sources":["../../../../src/public/node/context/fqdn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAA;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,kBAAkB,EAAC,MAAM,0CAA0C,CAAA;AAE3E,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,UAAU,CAC9D,iGAAiG,CAClG,CAAA;AACD,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,UAAU,CAC9D,iGAAiG,CAClG,CAAA;AACD,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,UAAU,CAC7D,gGAAgG,CACjG,CAAA;AACD,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,UAAU,CACrD,2EAA2E,CAC5E,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,sBAAsB,CAAA;IAC7C,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,uBAAuB,CAAA;QAChC,KAAK,MAAM;YACT,OAAO,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAA;QACvC;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,6BAA6B,CAAA;IACpD,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,gCAAgC,CAAA;QACzC,KAAK,MAAM;YACT,OAAO,qBAAqB,MAAM,QAAQ,EAAE,EAAE,CAAA;QAChD;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,sBAAsB,CAAA;IAC7C,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,uBAAuB,CAAA;QAChC,KAAK,MAAM;YACT,OAAO,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAA;QACvC;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAa;IACpD,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,SAAS,GAAG,KAAK,EAAE,SAAiB,EAAE,EAAE,CAC5C,iBAAiB,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,gBAAgB,CAAA;IACjG,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IACnH,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;AACpE,CAAC","sourcesContent":["import {isSpinEnvironment, spinFqdn} from './spin.js'\nimport {AbortError} from '../error.js'\nimport {serviceEnvironment} from '../../../private/node/context/service.js'\n\nexport const CouldntObtainPartnersSpinFQDNError = new AbortError(\n  \"Couldn't obtain the Spin FQDN for Partners when the CLI is not running from a Spin environment.\",\n)\nexport const CouldntObtainIdentitySpinFQDNError = new AbortError(\n  \"Couldn't obtain the Spin FQDN for Identity when the CLI is not running from a Spin environment.\",\n)\nexport const CouldntObtainShopifySpinFQDNError = new AbortError(\n  \"Couldn't obtain the Spin FQDN for Shopify when the CLI is not running from a Spin environment.\",\n)\nexport const NotProvidedStoreFQDNError = new AbortError(\n  \"Couldn't obtain the Shopify FQDN because the store FQDN was not provided.\",\n)\n\n/**\n * It returns the Partners' API service we should interact with.\n *\n * @returns Fully-qualified domain of the partners service we should interact with.\n */\nexport async function partnersFqdn(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'partners.shopify.com'\n  switch (environment) {\n    case 'local':\n      return 'partners.myshopify.io'\n    case 'spin':\n      return `partners.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * It returns the BusinessPlatform' API service we should interact with.\n *\n * @returns Fully-qualified domain of the partners service we should interact with.\n */\nexport async function businessPlatformFqdn(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'destinations.shopifysvc.com'\n  switch (environment) {\n    case 'local':\n      return 'business-platform.myshopify.io'\n    case 'spin':\n      return `business-platform.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * It returns the Identity service we should interact with.\n *\n * @returns Fully-qualified domain of the Identity service we should interact with.\n */\nexport async function identityFqdn(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'accounts.shopify.com'\n  switch (environment) {\n    case 'local':\n      return 'identity.myshopify.io'\n    case 'spin':\n      return `identity.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * Normalize the store name to be used in the CLI.\n * It will add the .myshopify.com domain if it's not present.\n * It will add the spin domain if it's not present and we're in a Spin environment.\n *\n * @param store - Store name.\n * @returns Normalized store name.\n */\nexport async function normalizeStoreFqdn(store: string): Promise<string> {\n  const storeFqdn = store.replace(/^https?:\\/\\//, '').replace(/\\/$/, '')\n  const addDomain = async (storeFqdn: string) =>\n    isSpinEnvironment() ? `${storeFqdn}.shopify.${await spinFqdn()}` : `${storeFqdn}.myshopify.com`\n  const containDomain = (storeFqdn: string) => storeFqdn.includes('.myshopify.com') || storeFqdn.includes('spin.dev')\n  return containDomain(storeFqdn) ? storeFqdn : addDomain(storeFqdn)\n}\n"]}
+{"version":3,"file":"fqdn.js","sourceRoot":"","sources":["../../../../src/public/node/context/fqdn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAA;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,kBAAkB,EAAC,MAAM,0CAA0C,CAAA;AAE3E,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,UAAU,CAC9D,iGAAiG,CAClG,CAAA;AACD,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,UAAU,CAC9D,iGAAiG,CAClG,CAAA;AACD,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,UAAU,CAC7D,gGAAgG,CACjG,CAAA;AACD,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,UAAU,CACrD,2EAA2E,CAC5E,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,sBAAsB,CAAA;IAC7C,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,uBAAuB,CAAA;QAChC,KAAK,MAAM;YACT,OAAO,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAA;QACvC;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,aAAa,CAAA;IACpC,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,0BAA0B,CAAA;QACnC,KAAK,MAAM;YACT,OAAO,eAAe,MAAM,QAAQ,EAAE,EAAE,CAAA;QAC1C;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,6BAA6B,CAAA;IACpD,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,gCAAgC,CAAA;QACzC,KAAK,MAAM;YACT,OAAO,qBAAqB,MAAM,QAAQ,EAAE,EAAE,CAAA;QAChD;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY;IAChC,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,sBAAsB,CAAA;IAC7C,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,uBAAuB,CAAA;QAChC,KAAK,MAAM;YACT,OAAO,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAA;QACvC;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAa;IACpD,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,SAAS,GAAG,KAAK,EAAE,SAAiB,EAAE,EAAE,CAC5C,iBAAiB,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,gBAAgB,CAAA;IACjG,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IACnH,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;AACpE,CAAC","sourcesContent":["import {isSpinEnvironment, spinFqdn} from './spin.js'\nimport {AbortError} from '../error.js'\nimport {serviceEnvironment} from '../../../private/node/context/service.js'\n\nexport const CouldntObtainPartnersSpinFQDNError = new AbortError(\n  \"Couldn't obtain the Spin FQDN for Partners when the CLI is not running from a Spin environment.\",\n)\nexport const CouldntObtainIdentitySpinFQDNError = new AbortError(\n  \"Couldn't obtain the Spin FQDN for Identity when the CLI is not running from a Spin environment.\",\n)\nexport const CouldntObtainShopifySpinFQDNError = new AbortError(\n  \"Couldn't obtain the Spin FQDN for Shopify when the CLI is not running from a Spin environment.\",\n)\nexport const NotProvidedStoreFQDNError = new AbortError(\n  \"Couldn't obtain the Shopify FQDN because the store FQDN was not provided.\",\n)\n\n/**\n * It returns the Partners' API service we should interact with.\n *\n * @returns Fully-qualified domain of the partners service we should interact with.\n */\nexport async function partnersFqdn(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'partners.shopify.com'\n  switch (environment) {\n    case 'local':\n      return 'partners.myshopify.io'\n    case 'spin':\n      return `partners.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * It returns the Shopify Developers' API service we should interact with.\n *\n * @returns Fully-qualified domain of the Shopify Developers service we should interact with.\n */\nexport async function shopifyDevelopersFqdn(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'shopify.com'\n  switch (environment) {\n    case 'local':\n      return 'app.shopify.myshopify.io'\n    case 'spin':\n      return `app.shopify.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * It returns the BusinessPlatform' API service we should interact with.\n *\n * @returns Fully-qualified domain of the partners service we should interact with.\n */\nexport async function businessPlatformFqdn(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'destinations.shopifysvc.com'\n  switch (environment) {\n    case 'local':\n      return 'business-platform.myshopify.io'\n    case 'spin':\n      return `business-platform.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * It returns the Identity service we should interact with.\n *\n * @returns Fully-qualified domain of the Identity service we should interact with.\n */\nexport async function identityFqdn(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'accounts.shopify.com'\n  switch (environment) {\n    case 'local':\n      return 'identity.myshopify.io'\n    case 'spin':\n      return `identity.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * Normalize the store name to be used in the CLI.\n * It will add the .myshopify.com domain if it's not present.\n * It will add the spin domain if it's not present and we're in a Spin environment.\n *\n * @param store - Store name.\n * @returns Normalized store name.\n */\nexport async function normalizeStoreFqdn(store: string): Promise<string> {\n  const storeFqdn = store.replace(/^https?:\\/\\//, '').replace(/\\/$/, '')\n  const addDomain = async (storeFqdn: string) =>\n    isSpinEnvironment() ? `${storeFqdn}.shopify.${await spinFqdn()}` : `${storeFqdn}.myshopify.com`\n  const containDomain = (storeFqdn: string) => storeFqdn.includes('.myshopify.com') || storeFqdn.includes('spin.dev')\n  return containDomain(storeFqdn) ? storeFqdn : addDomain(storeFqdn)\n}\n"]}

package/dist/public/node/context/spin.d.ts

@@ -55,3 +55,16 @@ export declare function appPort(env?: NodeJS.ProcessEnv): number | undefined;
  * @returns The value of the SPIN_APP_HOST environment variable.
  */
 export declare function appHost(env?: NodeJS.ProcessEnv): string | undefined;
+export declare const spinVariables: {
+    partnersSpinService: string;
+    manualCliSpinPortName: string;
+};
+/**
+ * Fetches the port for a given spin service and port environment variable.
+ *
+ * @param service - The name of the spin service to fetch the port for.
+ * @param portEnvName - The name of the environment variable to fetch the port from.
+ * @param basePath - The base path to look for the port file.
+ * @returns The port number or undefined if the port could not be found.
+ */
+export declare function fetchSpinPort(service: string, portEnvName: string, basePath?: string): Promise<number | undefined>;

package/dist/public/node/context/spin.js

@@ -1,11 +1,12 @@
 import { isTruthy } from './utilities.js';
-import { fileExists, readFileSync } from '../fs.js';
+import { fileExists, readFile, readFileSync } from '../fs.js';
 import { environmentVariables } from '../../../private/node/constants.js';
 import { captureOutput } from '../system.js';
 import { outputContent, outputToken } from '../output.js';
 import { getCachedSpinFqdn, setCachedSpinFqdn } from '../../../private/node/context/spin-cache.js';
 import { AbortError } from '../error.js';
 import { Environment, serviceEnvironment } from '../../../private/node/context/service.js';
+import { joinPath } from '../path.js';
 const SpinInstanceNotFoundMessages = (spinInstance, error) => {
     const errorMessage = outputContent `${outputToken.genericShellCommand(`spin`)} yielded the following error trying to obtain the fully qualified domain name of the Spin instance:
 ${error}
@@ -108,4 +109,44 @@ export function appPort(env = process.env) {
 export function appHost(env = process.env) {
     return env[environmentVariables.spinAppHost];
 }
+export const spinVariables = {
+    partnersSpinService: 'shopify--partners',
+    manualCliSpinPortName: 'CLI_EXTENSION_SERVER',
+};
+/**
+ * Fetches the port for a given spin service and port environment variable.
+ *
+ * @param service - The name of the spin service to fetch the port for.
+ * @param portEnvName - The name of the environment variable to fetch the port from.
+ * @param basePath - The base path to look for the port file.
+ * @returns The port number or undefined if the port could not be found.
+ */
+export async function fetchSpinPort(service, portEnvName, basePath = '/run') {
+    const spinVersionConfigurations = [
+        {
+            path: joinPath(basePath, 'ports2', service, 'custom', portEnvName),
+            contentPattern: /\[{"internal":(\d+)}\]/,
+        },
+        {
+            path: joinPath(basePath, 'ports', service, 'proc', portEnvName),
+            contentPattern: /(\d+)/,
+        },
+    ];
+    for (const config of spinVersionConfigurations) {
+        let fileContent;
+        try {
+            // eslint-disable-next-line no-await-in-loop
+            fileContent = await readFile(config.path);
+            // eslint-disable-next-line no-catch-all/no-catch-all
+        }
+        catch (error) {
+            continue;
+        }
+        const match = config.contentPattern.exec(fileContent);
+        if (match && match[1] && !isNaN(parseInt(match[1], 10))) {
+            return parseInt(match[1], 10);
+        }
+    }
+    return undefined;
+}
 //# sourceMappingURL=spin.js.map

package/dist/public/node/context/spin.js.map

@@ -1 +1 @@
-{"version":3,"file":"spin.js","sourceRoot":"","sources":["../../../../src/public/node/context/spin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,UAAU,CAAA;AACjD,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAA;AACvE,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,cAAc,CAAA;AACvD,OAAO,EAAC,iBAAiB,EAAE,iBAAiB,EAAC,MAAM,6CAA6C,CAAA;AAChG,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,WAAW,EAAE,kBAAkB,EAAC,MAAM,0CAA0C,CAAA;AAExF,MAAM,4BAA4B,GAAG,CAAC,YAAgC,EAAE,KAAa,EAAE,EAAE;IACvF,MAAM,YAAY,GAAG,aAAa,CAAA,GAAG,WAAW,CAAC,mBAAmB,CAClE,MAAM,CACP;EACD,KAAK;GACJ,CAAA;IACD,IAAI,SAA6B,CAAA;IACjC,IAAI,YAAY,EAAE;QAChB,SAAS,GAAG,aAAa,YAAY,6DAA6D,CAAA;KACnG;IACD,OAAO,EAAC,YAAY,EAAE,SAAS,EAAC,CAAA;AAClC,CAAC,CAAA;AAED,MAAM,gBAAgB,GAAG,wBAAwB,CAAA;AAEjD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC9C,IAAI,QAAQ,GAAG,iBAAiB,EAAE,CAAA;IAClC,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAA;IAE7B,IAAI,MAAM,UAAU,CAAC,gBAAgB,CAAC,EAAE;QACtC,QAAQ,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAA;KAC3D;SAAM;QACL,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;QACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;QAElD,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAA;KAC7B;IACD,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAC3B,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,YAAgC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG;IAC5E,MAAM,MAAM,GAAG,YAAY,KAAK,SAAS,CAAA;IACzC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACzE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,EAAC,GAAG,EAAC,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,MAAM,EAAC,YAAY,EAAE,SAAS,EAAC,GAAG,4BAA4B,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACxF,MAAM,IAAI,UAAU,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;KAC9C;SAAM;QACL,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACtC,OAAO,QAAQ,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;AACjD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACxC,OAAO,GAAG,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;AAC/C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACjD,OAAO,kBAAkB,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,IAAI,CAAA;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACvC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAA;IAC1D,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,SAAS,CAAA;AAC5C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACvC,OAAO,GAAG,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAA;AAC9C,CAAC","sourcesContent":["import {isTruthy} from './utilities.js'\nimport {fileExists, readFileSync} from '../fs.js'\nimport {environmentVariables} from '../../../private/node/constants.js'\nimport {captureOutput} from '../system.js'\nimport {outputContent, outputToken} from '../output.js'\nimport {getCachedSpinFqdn, setCachedSpinFqdn} from '../../../private/node/context/spin-cache.js'\nimport {AbortError} from '../error.js'\nimport {Environment, serviceEnvironment} from '../../../private/node/context/service.js'\n\nconst SpinInstanceNotFoundMessages = (spinInstance: string | undefined, error: string) => {\n  const errorMessage = outputContent`${outputToken.genericShellCommand(\n    `spin`,\n  )} yielded the following error trying to obtain the fully qualified domain name of the Spin instance:\n${error}\n  `\n  let nextSteps: string | undefined\n  if (spinInstance) {\n    nextSteps = `Make sure ${spinInstance} is the instance name and not a fully qualified domain name`\n  }\n  return {errorMessage, nextSteps}\n}\n\nconst spinFqdnFilePath = '/etc/spin/machine/fqdn'\n\n/**\n * When ran in a Spin environment, it returns the fqdn of the instance.\n *\n * Will cache the value of the Spin FQDN during the execution of the CLI.\n * To avoid multiple calls to `readSync` or `show`.\n *\n * @param env - Environment variables.\n * @returns Fqdn of the Spin environment.\n */\nexport async function spinFqdn(env = process.env): Promise<string> {\n  let spinFqdn = getCachedSpinFqdn()\n  if (spinFqdn) return spinFqdn\n\n  if (await fileExists(spinFqdnFilePath)) {\n    spinFqdn = await readFileSync(spinFqdnFilePath).toString()\n  } else {\n    const spinInstance = await instance(env)\n    const showResponse = await show(spinInstance, env)\n\n    spinFqdn = showResponse.fqdn\n  }\n  setCachedSpinFqdn(spinFqdn)\n  return spinFqdn\n}\n\n/**\n * Runs \"spin show\" and returns the JSON-parsed output.\n *\n * @param spinInstance - When it's undefined, we'll fetch the latest one.\n * @param env - Environment variables.\n * @returns The JSON-parsed output of the Spin CLI.\n * @throws Any error raised from the underlying Spin CLI.\n */\nexport async function show(spinInstance: string | undefined, env = process.env): Promise<{fqdn: string}> {\n  const latest = spinInstance === undefined\n  const args = latest ? ['show', '--latest', '--json'] : ['show', '--json']\n  const output = await captureOutput('spin', args, {env})\n  const json = JSON.parse(output)\n  if (json.error) {\n    const {errorMessage, nextSteps} = SpinInstanceNotFoundMessages(spinInstance, json.error)\n    throw new AbortError(errorMessage, nextSteps)\n  } else {\n    return json\n  }\n}\n\n/**\n * Returns true if the CLI is running in a Spin environment.\n *\n * @param env - Environment variables.\n * @returns True if the CLI is running in a Spin environment.\n */\nexport function isSpin(env = process.env): boolean {\n  return isTruthy(env[environmentVariables.spin])\n}\n\n/**\n * Returns the value of the SPIN_INSTANCE environment variable.\n *\n * @param env - Environment variables.\n * @returns The value of the SPIN_INSTANCE environment variable.\n */\nexport function instance(env = process.env): string | undefined {\n  return env[environmentVariables.spinInstance]\n}\n\n/**\n * Returns true if the CLI is running in a Spin environment.\n *\n * @param env - Environment variables.\n * @returns True if the CLI is running in a Spin environment.\n */\nexport function isSpinEnvironment(env = process.env): boolean {\n  return serviceEnvironment(env) === Environment.Spin\n}\n\n/**\n * Returns the value of the SERVER_PORT environment variable.\n *\n * @param env - Environment variables.\n * @returns The value of the SERVER_PORT environment variable.\n */\nexport function appPort(env = process.env): number | undefined {\n  const port = Number(env[environmentVariables.spinAppPort])\n  return (!isNaN(port) && port) || undefined\n}\n\n/**\n * Returns the value of the SPIN_APP_HOST environment variable.\n *\n * @param env - Environment variables.\n * @returns The value of the SPIN_APP_HOST environment variable.\n */\nexport function appHost(env = process.env): string | undefined {\n  return env[environmentVariables.spinAppHost]\n}\n"]}
+{"version":3,"file":"spin.js","sourceRoot":"","sources":["../../../../src/public/node/context/spin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAC,MAAM,UAAU,CAAA;AAC3D,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAA;AACvE,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,cAAc,CAAA;AACvD,OAAO,EAAC,iBAAiB,EAAE,iBAAiB,EAAC,MAAM,6CAA6C,CAAA;AAChG,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAC,WAAW,EAAE,kBAAkB,EAAC,MAAM,0CAA0C,CAAA;AACxF,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAA;AAEnC,MAAM,4BAA4B,GAAG,CAAC,YAAgC,EAAE,KAAa,EAAE,EAAE;IACvF,MAAM,YAAY,GAAG,aAAa,CAAA,GAAG,WAAW,CAAC,mBAAmB,CAClE,MAAM,CACP;EACD,KAAK;GACJ,CAAA;IACD,IAAI,SAA6B,CAAA;IACjC,IAAI,YAAY,EAAE;QAChB,SAAS,GAAG,aAAa,YAAY,6DAA6D,CAAA;KACnG;IACD,OAAO,EAAC,YAAY,EAAE,SAAS,EAAC,CAAA;AAClC,CAAC,CAAA;AAED,MAAM,gBAAgB,GAAG,wBAAwB,CAAA;AAEjD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC9C,IAAI,QAAQ,GAAG,iBAAiB,EAAE,CAAA;IAClC,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAA;IAE7B,IAAI,MAAM,UAAU,CAAC,gBAAgB,CAAC,EAAE;QACtC,QAAQ,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAA;KAC3D;SAAM;QACL,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;QACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;QAElD,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAA;KAC7B;IACD,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAC3B,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,YAAgC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG;IAC5E,MAAM,MAAM,GAAG,YAAY,KAAK,SAAS,CAAA;IACzC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACzE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,EAAC,GAAG,EAAC,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,MAAM,EAAC,YAAY,EAAE,SAAS,EAAC,GAAG,4BAA4B,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACxF,MAAM,IAAI,UAAU,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;KAC9C;SAAM;QACL,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACtC,OAAO,QAAQ,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;AACjD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACxC,OAAO,GAAG,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;AAC/C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACjD,OAAO,kBAAkB,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,IAAI,CAAA;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACvC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAA;IAC1D,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,SAAS,CAAA;AAC5C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACvC,OAAO,GAAG,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAA;AAC9C,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,mBAAmB,EAAE,mBAAmB;IACxC,qBAAqB,EAAE,sBAAsB;CAC9C,CAAA;AACD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,OAAe,EACf,WAAmB,EACnB,QAAQ,GAAG,MAAM;IAEjB,MAAM,yBAAyB,GAAG;QAChC;YACE,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC;YAClE,cAAc,EAAE,wBAAwB;SACzC;QACD;YACE,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;YAC/D,cAAc,EAAE,OAAO;SACxB;KACF,CAAA;IACD,KAAK,MAAM,MAAM,IAAI,yBAAyB,EAAE;QAC9C,IAAI,WAAmB,CAAA;QAEvB,IAAI;YACF,4CAA4C;YAC5C,WAAW,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACzC,qDAAqD;SACtD;QAAC,OAAO,KAAK,EAAE;YACd,SAAQ;SACT;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACrD,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE;YACvD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;SAC9B;KACF;IAED,OAAO,SAAS,CAAA;AAClB,CAAC","sourcesContent":["import {isTruthy} from './utilities.js'\nimport {fileExists, readFile, readFileSync} from '../fs.js'\nimport {environmentVariables} from '../../../private/node/constants.js'\nimport {captureOutput} from '../system.js'\nimport {outputContent, outputToken} from '../output.js'\nimport {getCachedSpinFqdn, setCachedSpinFqdn} from '../../../private/node/context/spin-cache.js'\nimport {AbortError} from '../error.js'\nimport {Environment, serviceEnvironment} from '../../../private/node/context/service.js'\nimport {joinPath} from '../path.js'\n\nconst SpinInstanceNotFoundMessages = (spinInstance: string | undefined, error: string) => {\n  const errorMessage = outputContent`${outputToken.genericShellCommand(\n    `spin`,\n  )} yielded the following error trying to obtain the fully qualified domain name of the Spin instance:\n${error}\n  `\n  let nextSteps: string | undefined\n  if (spinInstance) {\n    nextSteps = `Make sure ${spinInstance} is the instance name and not a fully qualified domain name`\n  }\n  return {errorMessage, nextSteps}\n}\n\nconst spinFqdnFilePath = '/etc/spin/machine/fqdn'\n\n/**\n * When ran in a Spin environment, it returns the fqdn of the instance.\n *\n * Will cache the value of the Spin FQDN during the execution of the CLI.\n * To avoid multiple calls to `readSync` or `show`.\n *\n * @param env - Environment variables.\n * @returns Fqdn of the Spin environment.\n */\nexport async function spinFqdn(env = process.env): Promise<string> {\n  let spinFqdn = getCachedSpinFqdn()\n  if (spinFqdn) return spinFqdn\n\n  if (await fileExists(spinFqdnFilePath)) {\n    spinFqdn = await readFileSync(spinFqdnFilePath).toString()\n  } else {\n    const spinInstance = await instance(env)\n    const showResponse = await show(spinInstance, env)\n\n    spinFqdn = showResponse.fqdn\n  }\n  setCachedSpinFqdn(spinFqdn)\n  return spinFqdn\n}\n\n/**\n * Runs \"spin show\" and returns the JSON-parsed output.\n *\n * @param spinInstance - When it's undefined, we'll fetch the latest one.\n * @param env - Environment variables.\n * @returns The JSON-parsed output of the Spin CLI.\n * @throws Any error raised from the underlying Spin CLI.\n */\nexport async function show(spinInstance: string | undefined, env = process.env): Promise<{fqdn: string}> {\n  const latest = spinInstance === undefined\n  const args = latest ? ['show', '--latest', '--json'] : ['show', '--json']\n  const output = await captureOutput('spin', args, {env})\n  const json = JSON.parse(output)\n  if (json.error) {\n    const {errorMessage, nextSteps} = SpinInstanceNotFoundMessages(spinInstance, json.error)\n    throw new AbortError(errorMessage, nextSteps)\n  } else {\n    return json\n  }\n}\n\n/**\n * Returns true if the CLI is running in a Spin environment.\n *\n * @param env - Environment variables.\n * @returns True if the CLI is running in a Spin environment.\n */\nexport function isSpin(env = process.env): boolean {\n  return isTruthy(env[environmentVariables.spin])\n}\n\n/**\n * Returns the value of the SPIN_INSTANCE environment variable.\n *\n * @param env - Environment variables.\n * @returns The value of the SPIN_INSTANCE environment variable.\n */\nexport function instance(env = process.env): string | undefined {\n  return env[environmentVariables.spinInstance]\n}\n\n/**\n * Returns true if the CLI is running in a Spin environment.\n *\n * @param env - Environment variables.\n * @returns True if the CLI is running in a Spin environment.\n */\nexport function isSpinEnvironment(env = process.env): boolean {\n  return serviceEnvironment(env) === Environment.Spin\n}\n\n/**\n * Returns the value of the SERVER_PORT environment variable.\n *\n * @param env - Environment variables.\n * @returns The value of the SERVER_PORT environment variable.\n */\nexport function appPort(env = process.env): number | undefined {\n  const port = Number(env[environmentVariables.spinAppPort])\n  return (!isNaN(port) && port) || undefined\n}\n\n/**\n * Returns the value of the SPIN_APP_HOST environment variable.\n *\n * @param env - Environment variables.\n * @returns The value of the SPIN_APP_HOST environment variable.\n */\nexport function appHost(env = process.env): string | undefined {\n  return env[environmentVariables.spinAppHost]\n}\n\nexport const spinVariables = {\n  partnersSpinService: 'shopify--partners',\n  manualCliSpinPortName: 'CLI_EXTENSION_SERVER',\n}\n/**\n * Fetches the port for a given spin service and port environment variable.\n *\n * @param service - The name of the spin service to fetch the port for.\n * @param portEnvName - The name of the environment variable to fetch the port from.\n * @param basePath - The base path to look for the port file.\n * @returns The port number or undefined if the port could not be found.\n */\nexport async function fetchSpinPort(\n  service: string,\n  portEnvName: string,\n  basePath = '/run',\n): Promise<number | undefined> {\n  const spinVersionConfigurations = [\n    {\n      path: joinPath(basePath, 'ports2', service, 'custom', portEnvName),\n      contentPattern: /\\[{\"internal\":(\\d+)}\\]/,\n    },\n    {\n      path: joinPath(basePath, 'ports', service, 'proc', portEnvName),\n      contentPattern: /(\\d+)/,\n    },\n  ]\n  for (const config of spinVersionConfigurations) {\n    let fileContent: string\n\n    try {\n      // eslint-disable-next-line no-await-in-loop\n      fileContent = await readFile(config.path)\n      // eslint-disable-next-line no-catch-all/no-catch-all\n    } catch (error) {\n      continue\n    }\n\n    const match = config.contentPattern.exec(fileContent)\n    if (match && match[1] && !isNaN(parseInt(match[1], 10))) {\n      return parseInt(match[1], 10)\n    }\n  }\n\n  return undefined\n}\n"]}

package/dist/public/node/custom-oclif-loader.d.ts

@@ -0,0 +1,6 @@
+import { Command, Config } from '@oclif/core';
+import { Options } from '@oclif/core/lib/interfaces/plugin.js';
+export declare class ShopifyConfig extends Config {
+    constructor(options: Options);
+    customPriority(commands: Command.Loadable[]): Command.Loadable | undefined;
+}

package/dist/public/node/custom-oclif-loader.js

@@ -0,0 +1,54 @@
+import { Config } from '@oclif/core';
+export class ShopifyConfig extends Config {
+    constructor(options) {
+        super(options);
+        // eslint-disable-next-line dot-notation
+        this['determinePriority'] = this.customPriority;
+    }
+    customPriority(commands) {
+        const oclifPlugins = this.pjson.oclif?.plugins ?? [];
+        const commandPlugins = commands.sort((aCommand, bCommand) => {
+            // eslint-disable-next-line no-restricted-syntax
+            const pluginAliasA = aCommand.pluginAlias ?? 'A-Cannot-Find-This';
+            // eslint-disable-next-line no-restricted-syntax
+            const pluginAliasB = bCommand.pluginAlias ?? 'B-Cannot-Find-This';
+            const aIndex = oclifPlugins.indexOf(pluginAliasA);
+            const bIndex = oclifPlugins.indexOf(pluginAliasB);
+            // Hydrogen has higher priority than core plugins to override the custom init method.
+            if (aCommand.pluginType === 'core' && bCommand.pluginAlias === '@shopify/cli-hydrogen') {
+                // If b is hydrogen and a is core sort b first
+                return 1;
+            }
+            if (aCommand.pluginAlias === '@shopify/cli-hydrogen' && bCommand.pluginType === 'core') {
+                // If a is hydrogen and b is core sort a first
+                return -1;
+            }
+            // All other cases are the default implementation from the private `determinePriority` method
+            // When both plugin types are 'core' plugins sort based on index
+            if (aCommand.pluginType === 'core' && bCommand.pluginType === 'core') {
+                // If b appears first in the pjson.plugins sort it first
+                return aIndex - bIndex;
+            }
+            // if b is a core plugin and a is not sort b first
+            if (bCommand.pluginType === 'core' && aCommand.pluginType !== 'core') {
+                return 1;
+            }
+            // if a is a core plugin and b is not sort a first
+            if (aCommand.pluginType === 'core' && bCommand.pluginType !== 'core') {
+                return -1;
+            }
+            // if a is a jit plugin and b is not sort b first
+            if (aCommand.pluginType === 'jit' && bCommand.pluginType !== 'jit') {
+                return 1;
+            }
+            // if b is a jit plugin and a is not sort a first
+            if (bCommand.pluginType === 'jit' && aCommand.pluginType !== 'jit') {
+                return -1;
+            }
+            // neither plugin is core, so do not change the order
+            return 0;
+        });
+        return commandPlugins[0];
+    }
+}
+//# sourceMappingURL=custom-oclif-loader.js.map

package/dist/public/node/custom-oclif-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-oclif-loader.js","sourceRoot":"","sources":["../../../src/public/node/custom-oclif-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,MAAM,EAAC,MAAM,aAAa,CAAA;AAG3C,MAAM,OAAO,aAAc,SAAQ,MAAM;IACvC,YAAY,OAAgB;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,wCAAwC;QACxC,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAA;IACjD,CAAC;IAED,cAAc,CAAC,QAA4B;QACzC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,EAAE,CAAA;QACpD,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE;YAC1D,gDAAgD;YAChD,MAAM,YAAY,GAAG,QAAQ,CAAC,WAAW,IAAI,oBAAoB,CAAA;YACjE,gDAAgD;YAChD,MAAM,YAAY,GAAG,QAAQ,CAAC,WAAW,IAAI,oBAAoB,CAAA;YACjE,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YACjD,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YAEjD,qFAAqF;YACrF,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,IAAI,QAAQ,CAAC,WAAW,KAAK,uBAAuB,EAAE;gBACtF,8CAA8C;gBAC9C,OAAO,CAAC,CAAA;aACT;YAED,IAAI,QAAQ,CAAC,WAAW,KAAK,uBAAuB,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,EAAE;gBACtF,8CAA8C;gBAC9C,OAAO,CAAC,CAAC,CAAA;aACV;YAED,6FAA6F;YAC7F,gEAAgE;YAChE,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,EAAE;gBACpE,wDAAwD;gBACxD,OAAO,MAAM,GAAG,MAAM,CAAA;aACvB;YAED,kDAAkD;YAClD,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,EAAE;gBACpE,OAAO,CAAC,CAAA;aACT;YAED,kDAAkD;YAClD,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,IAAI,QAAQ,CAAC,UAAU,KAAK,MAAM,EAAE;gBACpE,OAAO,CAAC,CAAC,CAAA;aACV;YAED,iDAAiD;YACjD,IAAI,QAAQ,CAAC,UAAU,KAAK,KAAK,IAAI,QAAQ,CAAC,UAAU,KAAK,KAAK,EAAE;gBAClE,OAAO,CAAC,CAAA;aACT;YAED,iDAAiD;YACjD,IAAI,QAAQ,CAAC,UAAU,KAAK,KAAK,IAAI,QAAQ,CAAC,UAAU,KAAK,KAAK,EAAE;gBAClE,OAAO,CAAC,CAAC,CAAA;aACV;YAED,qDAAqD;YACrD,OAAO,CAAC,CAAA;QACV,CAAC,CAAC,CAAA;QACF,OAAO,cAAc,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC;CACF","sourcesContent":["import {Command, Config} from '@oclif/core'\nimport {Options} from '@oclif/core/lib/interfaces/plugin.js'\n\nexport class ShopifyConfig extends Config {\n  constructor(options: Options) {\n    super(options)\n    // eslint-disable-next-line dot-notation\n    this['determinePriority'] = this.customPriority\n  }\n\n  customPriority(commands: Command.Loadable[]): Command.Loadable | undefined {\n    const oclifPlugins = this.pjson.oclif?.plugins ?? []\n    const commandPlugins = commands.sort((aCommand, bCommand) => {\n      // eslint-disable-next-line no-restricted-syntax\n      const pluginAliasA = aCommand.pluginAlias ?? 'A-Cannot-Find-This'\n      // eslint-disable-next-line no-restricted-syntax\n      const pluginAliasB = bCommand.pluginAlias ?? 'B-Cannot-Find-This'\n      const aIndex = oclifPlugins.indexOf(pluginAliasA)\n      const bIndex = oclifPlugins.indexOf(pluginAliasB)\n\n      // Hydrogen has higher priority than core plugins to override the custom init method.\n      if (aCommand.pluginType === 'core' && bCommand.pluginAlias === '@shopify/cli-hydrogen') {\n        // If b is hydrogen and a is core sort b first\n        return 1\n      }\n\n      if (aCommand.pluginAlias === '@shopify/cli-hydrogen' && bCommand.pluginType === 'core') {\n        // If a is hydrogen and b is core sort a first\n        return -1\n      }\n\n      // All other cases are the default implementation from the private `determinePriority` method\n      // When both plugin types are 'core' plugins sort based on index\n      if (aCommand.pluginType === 'core' && bCommand.pluginType === 'core') {\n        // If b appears first in the pjson.plugins sort it first\n        return aIndex - bIndex\n      }\n\n      // if b is a core plugin and a is not sort b first\n      if (bCommand.pluginType === 'core' && aCommand.pluginType !== 'core') {\n        return 1\n      }\n\n      // if a is a core plugin and b is not sort a first\n      if (aCommand.pluginType === 'core' && bCommand.pluginType !== 'core') {\n        return -1\n      }\n\n      // if a is a jit plugin and b is not sort b first\n      if (aCommand.pluginType === 'jit' && bCommand.pluginType !== 'jit') {\n        return 1\n      }\n\n      // if b is a jit plugin and a is not sort a first\n      if (bCommand.pluginType === 'jit' && aCommand.pluginType !== 'jit') {\n        return -1\n      }\n\n      // neither plugin is core, so do not change the order\n      return 0\n    })\n    return commandPlugins[0]\n  }\n}\n"]}

package/dist/public/node/dot-env.d.ts

@@ -33,3 +33,4 @@ export declare function writeDotEnv(file: DotEnvFile): Promise<void>;
 export declare function patchEnvFile(envFileContent: string | null, updatedValues: {
     [key: string]: string | undefined;
 }): string;
+export declare function createDotEnvFileLine(key: string, value?: string, quote?: string): string;

package/dist/public/node/dot-env.js

@@ -1,9 +1,7 @@
 import { AbortError } from './error.js';
 import { fileExists, readFile, writeFile } from './fs.js';
 import { outputDebug, outputContent, outputToken } from '../../public/node/output.js';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import { parse, stringify } from 'envfile';
+import { parse } from 'dotenv';
 /**
  * Reads and parses a .env file.
  * @param path - Path to the .env file
@@ -25,7 +23,10 @@ export async function readAndParseDotEnv(path) {
  * @param file - .env file to be written.
  */
 export async function writeDotEnv(file) {
-    await writeFile(file.path, stringify(file.variables));
+    const fileContent = Object.entries(file.variables)
+        .map(([key, value]) => createDotEnvFileLine(key, value))
+        .join('\n');
+    await writeFile(file.path, fileContent);
 }
 /**
  * Given an .env file content, generates a new one with new values
@@ -35,27 +36,68 @@ export async function writeDotEnv(file) {
  */
 export function patchEnvFile(envFileContent, updatedValues) {
     const outputLines = [];
-    const lines = envFileContent === null ? [] : envFileContent.split('\n');
+    const envFileLines = envFileContent === null ? [] : envFileContent.split('\n');
     const alreadyPresentKeys = [];
-    const toLine = (key, value) => `${key}=${value}`;
-    for (const line of lines) {
+    let multilineVariable;
+    for (const line of envFileLines) {
+        if (multilineVariable) {
+            if (line.endsWith(multilineVariable.quote)) {
+                let lineToWrite = createDotEnvFileLine(multilineVariable.key, multilineVariable.value + line.slice(0, -1), multilineVariable.quote);
+                const newValue = updatedValues[multilineVariable.key];
+                if (newValue) {
+                    alreadyPresentKeys.push(multilineVariable.key);
+                    lineToWrite = createDotEnvFileLine(multilineVariable.key, newValue);
+                }
+                outputLines.push(lineToWrite);
+                multilineVariable = undefined;
+            }
+            else {
+                multilineVariable.value += `${line}\n`;
+            }
+            continue;
+        }
         const match = line.match(/^([^=:#]+?)[=:](.*)/);
         let lineToWrite = line;
         if (match) {
             const key = match[1].trim();
+            const value = (match[2] || '').trim();
+            if (/^["'`]/.test(value) && !value.endsWith(value[0])) {
+                multilineVariable = {
+                    key,
+                    value: `${value.slice(1)}\n`,
+                    quote: value[0],
+                };
+                continue;
+            }
             const newValue = updatedValues[key];
             if (newValue) {
                 alreadyPresentKeys.push(key);
-                lineToWrite = toLine(key, newValue);
+                lineToWrite = createDotEnvFileLine(key, newValue);
             }
         }
         outputLines.push(lineToWrite);
     }
+    if (multilineVariable) {
+        throw new AbortError(`Multi-line environment variable '${multilineVariable.key}' is not properly enclosed.`);
+    }
     for (const [patchKey, updatedValue] of Object.entries(updatedValues)) {
         if (!alreadyPresentKeys.includes(patchKey)) {
-            outputLines.push(toLine(patchKey, updatedValue));
+            outputLines.push(createDotEnvFileLine(patchKey, updatedValue));
         }
     }
     return outputLines.join('\n');
 }
+export function createDotEnvFileLine(key, value, quote) {
+    if (quote) {
+        return `${key}=${quote}${value}${quote}`;
+    }
+    if (value && value.includes('\n')) {
+        const quoteCharacter = ['"', "'", '`'].find((char) => !value.includes(char));
+        if (!quoteCharacter) {
+            throw new AbortError(`The environment file patch has an env value that can't be surrounded by quotes: ${value}`);
+        }
+        return `${key}=${quoteCharacter}${value}${quoteCharacter}`;
+    }
+    return `${key}=${value}`;
+}
 //# sourceMappingURL=dot-env.js.map

package/dist/public/node/dot-env.js.map

@@ -1 +1 @@
-{"version":3,"file":"dot-env.js","sourceRoot":"","sources":["../../../src/public/node/dot-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,YAAY,CAAA;AACrC,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,SAAS,CAAA;AACvD,OAAO,EAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACnF,6DAA6D;AAC7D,aAAa;AACb,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,SAAS,CAAA;AAgBxC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,IAAY;IACnD,WAAW,CAAC,aAAa,CAAA,4BAA4B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9E,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE;QAC7B,MAAM,IAAI,UAAU,CAAC,2BAA2B,IAAI,kBAAkB,CAAC,CAAA;KACxE;IACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;IACpC,OAAO;QACL,IAAI;QACJ,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;KAC1B,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAgB;IAChD,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,cAA6B,EAC7B,aAAkD;IAElD,MAAM,WAAW,GAAa,EAAE,CAAA;IAChC,MAAM,KAAK,GAAG,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEvE,MAAM,kBAAkB,GAAa,EAAE,CAAA;IAEvC,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,KAAc,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAA;IAEjE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAA;QAC/C,IAAI,WAAW,GAAG,IAAI,CAAA;QAEtB,IAAI,KAAK,EAAE;YACT,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAA;YAC5B,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,QAAQ,EAAE;gBACZ,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBAC5B,WAAW,GAAG,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;aACpC;SACF;QAED,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;KAC9B;IAED,KAAK,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC1C,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAA;SACjD;KACF;IAED,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC","sourcesContent":["import {AbortError} from './error.js'\nimport {fileExists, readFile, writeFile} from './fs.js'\nimport {outputDebug, outputContent, outputToken} from '../../public/node/output.js'\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport {parse, stringify} from 'envfile'\n\n/**\n * This interface represents a .env file.\n */\nexport interface DotEnvFile {\n  /**\n   * Path to the .env file.\n   */\n  path: string\n  /**\n   * Variables of the .env file.\n   */\n  variables: {[name: string]: string}\n}\n\n/**\n * Reads and parses a .env file.\n * @param path - Path to the .env file\n * @returns An in-memory representation of the .env file.\n */\nexport async function readAndParseDotEnv(path: string): Promise<DotEnvFile> {\n  outputDebug(outputContent`Reading the .env file at ${outputToken.path(path)}`)\n  if (!(await fileExists(path))) {\n    throw new AbortError(`The environment file at ${path} does not exist.`)\n  }\n  const content = await readFile(path)\n  return {\n    path,\n    variables: parse(content),\n  }\n}\n\n/**\n * Writes a .env file to disk.\n * @param file - .env file to be written.\n */\nexport async function writeDotEnv(file: DotEnvFile): Promise<void> {\n  await writeFile(file.path, stringify(file.variables))\n}\n\n/**\n * Given an .env file content, generates a new one with new values\n * without removing already existing lines.\n * @param envFileContent - .env file contents.\n * @param updatedValues - object containing new env variables values.\n */\nexport function patchEnvFile(\n  envFileContent: string | null,\n  updatedValues: {[key: string]: string | undefined},\n): string {\n  const outputLines: string[] = []\n  const lines = envFileContent === null ? [] : envFileContent.split('\\n')\n\n  const alreadyPresentKeys: string[] = []\n\n  const toLine = (key: string, value?: string) => `${key}=${value}`\n\n  for (const line of lines) {\n    const match = line.match(/^([^=:#]+?)[=:](.*)/)\n    let lineToWrite = line\n\n    if (match) {\n      const key = match[1]!.trim()\n      const newValue = updatedValues[key]\n      if (newValue) {\n        alreadyPresentKeys.push(key)\n        lineToWrite = toLine(key, newValue)\n      }\n    }\n\n    outputLines.push(lineToWrite)\n  }\n\n  for (const [patchKey, updatedValue] of Object.entries(updatedValues)) {\n    if (!alreadyPresentKeys.includes(patchKey)) {\n      outputLines.push(toLine(patchKey, updatedValue))\n    }\n  }\n\n  return outputLines.join('\\n')\n}\n"]}
+{"version":3,"file":"dot-env.js","sourceRoot":"","sources":["../../../src/public/node/dot-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,YAAY,CAAA;AACrC,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,SAAS,CAAA;AACvD,OAAO,EAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACnF,OAAO,EAAC,KAAK,EAAC,MAAM,QAAQ,CAAA;AAgB5B;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,IAAY;IACnD,WAAW,CAAC,aAAa,CAAA,4BAA4B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9E,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE;QAC7B,MAAM,IAAI,UAAU,CAAC,2BAA2B,IAAI,kBAAkB,CAAC,CAAA;KACxE;IACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;IACpC,OAAO;QACL,IAAI;QACJ,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;KAC1B,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAgB;IAChD,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC;SAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACvD,IAAI,CAAC,IAAI,CAAC,CAAA;IAEb,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,cAA6B,EAC7B,aAAkD;IAElD,MAAM,WAAW,GAAa,EAAE,CAAA;IAChC,MAAM,YAAY,GAAG,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAE9E,MAAM,kBAAkB,GAAa,EAAE,CAAA;IAEvC,IAAI,iBAMS,CAAA;IAEb,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE;QAC/B,IAAI,iBAAiB,EAAE;YACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;gBAC1C,IAAI,WAAW,GAAG,oBAAoB,CACpC,iBAAiB,CAAC,GAAG,EACrB,iBAAiB,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAC3C,iBAAiB,CAAC,KAAK,CACxB,CAAA;gBACD,MAAM,QAAQ,GAAG,aAAa,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;gBACrD,IAAI,QAAQ,EAAE;oBACZ,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;oBAC9C,WAAW,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;iBACpE;gBACD,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC7B,iBAAiB,GAAG,SAAS,CAAA;aAC9B;iBAAM;gBACL,iBAAiB,CAAC,KAAK,IAAI,GAAG,IAAI,IAAI,CAAA;aACvC;YACD,SAAQ;SACT;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAA;QAC/C,IAAI,WAAW,GAAG,IAAI,CAAA;QAEtB,IAAI,KAAK,EAAE;YACT,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAA;YAC5B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAE,CAAC,IAAI,EAAE,CAAA;YAEtC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,EAAE;gBACtD,iBAAiB,GAAG;oBAClB,GAAG;oBACH,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;oBAC5B,KAAK,EAAE,KAAK,CAAC,CAAC,CAAE;iBACjB,CAAA;gBACD,SAAQ;aACT;YAED,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,QAAQ,EAAE;gBACZ,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBAC5B,WAAW,GAAG,oBAAoB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;aAClD;SACF;QAED,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;KAC9B;IAED,IAAI,iBAAiB,EAAE;QACrB,MAAM,IAAI,UAAU,CAAC,oCAAoC,iBAAiB,CAAC,GAAG,6BAA6B,CAAC,CAAA;KAC7G;IAED,KAAK,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC1C,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAA;SAC/D;KACF;IAED,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,GAAW,EAAE,KAAc,EAAE,KAAc;IAC9E,IAAI,KAAK,EAAE;QACT,OAAO,GAAG,GAAG,IAAI,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE,CAAA;KACzC;IACD,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACjC,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;QAE5E,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,IAAI,UAAU,CAAC,mFAAmF,KAAK,EAAE,CAAC,CAAA;SACjH;QAED,OAAO,GAAG,GAAG,IAAI,cAAc,GAAG,KAAK,GAAG,cAAc,EAAE,CAAA;KAC3D;IACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAA;AAC1B,CAAC","sourcesContent":["import {AbortError} from './error.js'\nimport {fileExists, readFile, writeFile} from './fs.js'\nimport {outputDebug, outputContent, outputToken} from '../../public/node/output.js'\nimport {parse} from 'dotenv'\n\n/**\n * This interface represents a .env file.\n */\nexport interface DotEnvFile {\n  /**\n   * Path to the .env file.\n   */\n  path: string\n  /**\n   * Variables of the .env file.\n   */\n  variables: {[name: string]: string}\n}\n\n/**\n * Reads and parses a .env file.\n * @param path - Path to the .env file\n * @returns An in-memory representation of the .env file.\n */\nexport async function readAndParseDotEnv(path: string): Promise<DotEnvFile> {\n  outputDebug(outputContent`Reading the .env file at ${outputToken.path(path)}`)\n  if (!(await fileExists(path))) {\n    throw new AbortError(`The environment file at ${path} does not exist.`)\n  }\n  const content = await readFile(path)\n  return {\n    path,\n    variables: parse(content),\n  }\n}\n\n/**\n * Writes a .env file to disk.\n * @param file - .env file to be written.\n */\nexport async function writeDotEnv(file: DotEnvFile): Promise<void> {\n  const fileContent = Object.entries(file.variables)\n    .map(([key, value]) => createDotEnvFileLine(key, value))\n    .join('\\n')\n\n  await writeFile(file.path, fileContent)\n}\n\n/**\n * Given an .env file content, generates a new one with new values\n * without removing already existing lines.\n * @param envFileContent - .env file contents.\n * @param updatedValues - object containing new env variables values.\n */\nexport function patchEnvFile(\n  envFileContent: string | null,\n  updatedValues: {[key: string]: string | undefined},\n): string {\n  const outputLines: string[] = []\n  const envFileLines = envFileContent === null ? [] : envFileContent.split('\\n')\n\n  const alreadyPresentKeys: string[] = []\n\n  let multilineVariable:\n    | {\n        key: string\n        value: string\n        quote: string\n      }\n    | undefined\n\n  for (const line of envFileLines) {\n    if (multilineVariable) {\n      if (line.endsWith(multilineVariable.quote)) {\n        let lineToWrite = createDotEnvFileLine(\n          multilineVariable.key,\n          multilineVariable.value + line.slice(0, -1),\n          multilineVariable.quote,\n        )\n        const newValue = updatedValues[multilineVariable.key]\n        if (newValue) {\n          alreadyPresentKeys.push(multilineVariable.key)\n          lineToWrite = createDotEnvFileLine(multilineVariable.key, newValue)\n        }\n        outputLines.push(lineToWrite)\n        multilineVariable = undefined\n      } else {\n        multilineVariable.value += `${line}\\n`\n      }\n      continue\n    }\n\n    const match = line.match(/^([^=:#]+?)[=:](.*)/)\n    let lineToWrite = line\n\n    if (match) {\n      const key = match[1]!.trim()\n      const value = (match[2] || '')!.trim()\n\n      if (/^[\"'`]/.test(value) && !value.endsWith(value[0]!)) {\n        multilineVariable = {\n          key,\n          value: `${value.slice(1)}\\n`,\n          quote: value[0]!,\n        }\n        continue\n      }\n\n      const newValue = updatedValues[key]\n      if (newValue) {\n        alreadyPresentKeys.push(key)\n        lineToWrite = createDotEnvFileLine(key, newValue)\n      }\n    }\n\n    outputLines.push(lineToWrite)\n  }\n\n  if (multilineVariable) {\n    throw new AbortError(`Multi-line environment variable '${multilineVariable.key}' is not properly enclosed.`)\n  }\n\n  for (const [patchKey, updatedValue] of Object.entries(updatedValues)) {\n    if (!alreadyPresentKeys.includes(patchKey)) {\n      outputLines.push(createDotEnvFileLine(patchKey, updatedValue))\n    }\n  }\n\n  return outputLines.join('\\n')\n}\n\nexport function createDotEnvFileLine(key: string, value?: string, quote?: string): string {\n  if (quote) {\n    return `${key}=${quote}${value}${quote}`\n  }\n  if (value && value.includes('\\n')) {\n    const quoteCharacter = ['\"', \"'\", '`'].find((char) => !value.includes(char))\n\n    if (!quoteCharacter) {\n      throw new AbortError(`The environment file patch has an env value that can't be surrounded by quotes: ${value}`)\n    }\n\n    return `${key}=${quoteCharacter}${value}${quoteCharacter}`\n  }\n  return `${key}=${value}`\n}\n"]}