@shopify/cli-kit 3.20.0 → 3.21.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @shopify/cli-kit
 
+## 3.21.0
+
+### Minor Changes
+
+- 5cda6300: Enable external access to cli inside a spin instance
+
+### Patch Changes
+
+- e4352f2e: Do not report handled tunnel plugin errors to Bugsnag
+- c906187f: Add backticks surrounding command tokens
+
+## 3.20.1
+
+### Patch Changes
+
+- 3f285ff9: Fix homebrew upgrade to handle shopify-cli package
+
 ## 3.20.0
 
 ### Minor Changes

package/dist/node/error-handler.d.ts

@@ -16,10 +16,10 @@ export declare function sendErrorToBugsnag(error: unknown): Promise<{
     reported: true;
 }>;
 /**
- * If the given file path comes from within a plugin, return the relative path, plus the plugin name.
- *
- * This gives us very consistent paths for errors thrown from plugin code.
+ * If the given file path is within a node_modules folder, remove prefix up
+ * to and including the node_modules folder.
  *
+ * This gives us very consistent paths for errors generated by the CLI.
  */
 export declare function cleanStackFrameFilePath({ currentFilePath, projectRoot, pluginLocations, }: {
     currentFilePath: string;

package/dist/node/error-handler.js

@@ -92,10 +92,10 @@ export async function sendErrorToBugsnag(error) {
     return { error: reportableError, reported: report };
 }
 /**
- * If the given file path comes from within a plugin, return the relative path, plus the plugin name.
- *
- * This gives us very consistent paths for errors thrown from plugin code.
+ * If the given file path is within a node_modules folder, remove prefix up
+ * to and including the node_modules folder.
  *
+ * This gives us very consistent paths for errors generated by the CLI.
  */
 export function cleanStackFrameFilePath({ currentFilePath, projectRoot, pluginLocations, }) {
     const fullLocation = path.isAbsolute(currentFilePath) ? currentFilePath : path.join(projectRoot, currentFilePath);
@@ -104,7 +104,8 @@ export function cleanStackFrameFilePath({ currentFilePath, projectRoot, pluginLo
         // the plugin name (e.g. @shopify/cli-kit), plus the relative path of the error line from within the plugin's code (e.g. dist/something.js )
         return path.join(matchingPluginPath.name, path.relative(matchingPluginPath.pluginPath, fullLocation));
     }
-    return currentFilePath;
+    // strip prefix up to node_modules folder, so we can normalize error reporting
+    return currentFilePath.replace(/.*node_modules\//, '');
 }
 /**
  * Register a Bugsnag error listener to clean up stack traces for errors within plugin code.

package/dist/node/error-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../../src/node/error-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,eAAe,EACf,MAAM,IAAI,WAAW,EACrB,YAAY,IAAI,iBAAiB,EACjC,OAAO,EACP,yBAAyB,GAC1B,MAAM,aAAa,CAAA;AACpB,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,MAAM,cAAc,CAAA;AACxC,OAAO,EAAC,kBAAkB,EAAE,WAAW,EAAC,MAAM,iBAAiB,CAAA;AAC/D,OAAO,KAAK,IAAI,MAAM,YAAY,CAAA;AAClC,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAA;AACzC,OAAO,SAAS,EAAE,EAAC,aAAa,EAAC,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAC,QAAQ,EAAa,MAAM,aAAa,CAAA;AAChD,OAAO,WAAW,MAAM,aAAa,CAAA;AACrC,OAAO,OAAgB,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AAEpC,MAAM,UAAU,YAAY,CAAC,KAA8C,EAAE,MAA0B;IACrG,IAAI,KAAK,YAAY,eAAe,EAAE;QACpC,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;SAC5B;KACF;SAAM,IAAI,KAAK,YAAY,WAAW,EAAE;QACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KAChB;SAAM;QACL,OAAO,WAAW,CAAC,KAAK,CAAC;aACtB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;aACvD,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;KACL;AACH,CAAC;AAED,MAAM,WAAW,GAAG,KAAK,EAAE,KAAc,EAAE,MAA0B,EAAiB,EAAE;IACtF,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,+CAA+C;QAC/C,MAAM,WAAW,CAAC,EAAC,MAAM,EAAE,YAAY,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAC,CAAC,CAAA;KAC9F;IACD,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAA;AACjC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAc;IAEd,IAAI,QAAQ,CAAC,KAAK,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;QAAE,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAC,CAAA;IAEhF,IAAI,eAAsB,CAAA;IAC1B,IAAI,UAA8B,CAAA;IAClC,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,MAAM,GAAG,IAAI,CAAA;QACb,eAAe,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC1C,UAAU,GAAG,KAAK,CAAC,KAAK,CAAA;QAExB;;;;;;WAMG;KACJ;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;QACjE,MAAM,GAAG,IAAI,CAAA;QACb,eAAe,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;QAClC,UAAU,GAAG,eAAe,CAAC,KAAK,CAAA;KACnC;SAAM;QACL,MAAM,GAAG,KAAK,CAAA;QACd,eAAe,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;KAC7C;IAED,MAAM,mBAAmB,GAAG,IAAI,WAAW,CAAC,UAAU,IAAI,EAAE,CAAC;SAC1D,KAAK,EAAE;SACP,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAClB,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrD,OAAO,UAAU,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAA;IAC1E,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;IACb,eAAe,CAAC,KAAK,GAAG,UAAU,eAAe,CAAC,OAAO,KAAK,mBAAmB,EAAE,CAAA;IAEnF,IAAI,MAAM,EAAE;QACV,MAAM,iBAAiB,EAAE,CAAA;QACzB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBAC1D,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAA;iBACd;qBAAM;oBACL,OAAO,CAAC,eAAe,CAAC,CAAA;iBACzB;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;IACD,OAAO,EAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAC,CAAA;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,eAAe,EACf,WAAW,EACX,eAAe,GAKhB;IACC,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;IAEjH,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,EAAC,UAAU,EAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE9G,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpC,4IAA4I;QAC5I,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAA;KACtG;IACD,OAAO,eAAe,CAAA;AACxB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,2CAA2C,CAAC,MAAyB;IACzF,8DAA8D;IAC9D,8DAA8D;IAC9D,MAAM,wBAAwB,GAAY,OAAe,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;IACzG,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAA;IAC5D,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAClC,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAClD,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAC,CAAA;IACxE,CAAC,CAAC,CACH,CAAA;IACD,MAAM,iBAAiB,EAAE,CAAA;IACzB,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACjC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtC,UAAU,CAAC,IAAI,GAAG,uBAAuB,CAAC,EAAC,eAAe,EAAE,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,eAAe,EAAC,CAAC,CAAA;YAC7G,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI;YACF,MAAM,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YACvC,qDAAqD;SACtD;QAAC,OAAO,aAAa,EAAE;YACtB,KAAK,CAAC,sFAAsF,aAAa,EAAE,CAAC,CAAA;SAC7G;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAY,EAAE,MAAyB;IAC9E,MAAM,UAAU,GAAG,QAAQ,CAAC,YAAY,EAAE,CAAA;IAC1C,MAAM,EAAC,mBAAmB,EAAC,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAA;IACxD,MAAM,EAAC,YAAY,EAAC,GAAG,mBAAmB,IAAI,EAAE,CAAA;IAEhD,MAAM,EAAC,cAAc,EAAE,SAAS,EAAE,GAAG,kBAAkB,EAAC,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAA;IAEnH,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAA;IAEpD,MAAM,WAAW,GAAG;QAClB,OAAO,EAAE,YAAY;QACrB,GAAG,SAAS;QACZ,GAAG,UAAU;QACb,GAAG,WAAW;QACd,UAAU,EAAE,kBAAkB;KAC/B,CAAA;IAED,MAAM,OAAO,GAAG,EAA8B,CAAA;IAC9C,MAAM,WAAW,GAAG,EAA8B,CAAA;IAClD,MAAM,eAAe,GAAG,EAA8B,CAAA;IACtD,MAAM,QAAQ,GAAG,EAA8B,CAAA;IAC/C,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,CAAC,CAAA;IACzD,MAAM,WAAW,GAAG,CAAC,SAAS,CAAC,CAAA;IAC/B,MAAM,eAAe,GAAG,CAAC,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAEhF,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACnD,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACrB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9D,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACzB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,eAAe,EAAE;YACpD,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SAC7B;aAAM;YACL,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACtB;IACH,CAAC,CAAC,CAAA;IAEF,kCAAkC;IAClC,MAAM,eAAe,GAAG;QACtB,aAAa,EAAE,OAAO;QACtB,OAAO,EAAE,WAAW;QACpB,WAAW,EAAE,eAAe;QAC5B,IAAI,EAAE,QAAQ;KACf,CAAA;IACD,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE;QAC5D,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACpC,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB;IAC9B,IAAI,OAAO,CAAC,SAAS,EAAE,EAAE;QACvB,OAAM;KACP;IACD,OAAO,CAAC,KAAK,CAAC;QACZ,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC7C,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;KACxB,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {\n  AbortSilent,\n  CancelExecution,\n  mapper as errorMapper,\n  shouldReport as shouldReportError,\n  handler,\n  cleanSingleStackTracePath,\n} from '../error.js'\nimport {debug, info} from '../output.js'\nimport {getEnvironmentData, reportEvent} from '../analytics.js'\nimport * as path from '../path.js'\nimport * as metadata from '../metadata.js'\nimport {fanoutHooks} from '../plugins.js'\nimport constants, {bugsnagApiKey} from '../constants.js'\nimport {settings, Interfaces} from '@oclif/core'\nimport StackTracey from 'stacktracey'\nimport Bugsnag, {Event} from '@bugsnag/js'\nimport {realpath} from 'fs/promises'\n\nexport function errorHandler(error: Error & {exitCode?: number | undefined}, config?: Interfaces.Config) {\n  if (error instanceof CancelExecution) {\n    if (error.message && error.message !== '') {\n      info(`✨  ${error.message}`)\n    }\n  } else if (error instanceof AbortSilent) {\n    process.exit(1)\n  } else {\n    return errorMapper(error)\n      .then((error) => {\n        return handler(error)\n      })\n      .then((mappedError) => reportError(mappedError, config))\n      .then(() => {\n        process.exit(1)\n      })\n  }\n}\n\nconst reportError = async (error: unknown, config?: Interfaces.Config): Promise<void> => {\n  if (config !== undefined) {\n    // Log an analytics event when there's an error\n    await reportEvent({config, errorMessage: error instanceof Error ? error.message : undefined})\n  }\n  await sendErrorToBugsnag(error)\n}\n\n/**\n * Sends an error to Bugsnag. This is configured automatically for uncaught errors from CLI commands, but can also be used to manually record an error.\n *\n * @returns the reported error (this may have been tweaked for better reporting), and a bool to indicate if the error was actually submitted or not\n */\nexport async function sendErrorToBugsnag(\n  error: unknown,\n): Promise<{reported: false; error: unknown} | {error: Error; reported: true}> {\n  if (settings.debug || !shouldReportError(error)) return {reported: false, error}\n\n  let reportableError: Error\n  let stacktrace: string | undefined\n  let report = false\n\n  if (error instanceof Error) {\n    report = true\n    reportableError = new Error(error.message)\n    stacktrace = error.stack\n\n    /**\n     * Some errors that reach this point have an empty string. For example:\n     * https://app.bugsnag.com/shopify/cli/errors/62cd5d31fd5040000814086c?filters[event.since]=30d&filters[error.status]=new&filters[release.seen_in]=3.1.0\n     *\n     * Because at this point we have neither the error message nor a stack trace reporting them\n     * to Bugsnag is pointless and adds noise.\n     */\n  } else if (typeof error === 'string' && error.trim().length !== 0) {\n    report = true\n    reportableError = new Error(error)\n    stacktrace = reportableError.stack\n  } else {\n    report = false\n    reportableError = new Error('Unknown error')\n  }\n\n  const formattedStacktrace = new StackTracey(stacktrace ?? '')\n    .clean()\n    .items.map((item) => {\n      const filePath = cleanSingleStackTracePath(item.file)\n      return `    at ${item.callee} (${filePath}:${item.line}:${item.column})`\n    })\n    .join('\\n')\n  reportableError.stack = `Error: ${reportableError.message}\\n${formattedStacktrace}`\n\n  if (report) {\n    await initializeBugsnag()\n    await new Promise((resolve, reject) => {\n      Bugsnag.notify(reportableError, undefined, (error, event) => {\n        if (error) {\n          reject(error)\n        } else {\n          resolve(reportableError)\n        }\n      })\n    })\n  }\n  return {error: reportableError, reported: report}\n}\n\n/**\n * If the given file path comes from within a plugin, return the relative path, plus the plugin name.\n *\n * This gives us very consistent paths for errors thrown from plugin code.\n *\n */\nexport function cleanStackFrameFilePath({\n  currentFilePath,\n  projectRoot,\n  pluginLocations,\n}: {\n  currentFilePath: string\n  projectRoot: string\n  pluginLocations: {name: string; pluginPath: string}[]\n}): string {\n  const fullLocation = path.isAbsolute(currentFilePath) ? currentFilePath : path.join(projectRoot, currentFilePath)\n\n  const matchingPluginPath = pluginLocations.filter(({pluginPath}) => fullLocation.indexOf(pluginPath) === 0)[0]\n\n  if (matchingPluginPath !== undefined) {\n    // the plugin name (e.g. @shopify/cli-kit), plus the relative path of the error line from within the plugin's code (e.g. dist/something.js )\n    return path.join(matchingPluginPath.name, path.relative(matchingPluginPath.pluginPath, fullLocation))\n  }\n  return currentFilePath\n}\n\n/**\n * Register a Bugsnag error listener to clean up stack traces for errors within plugin code.\n *\n */\nexport async function registerCleanBugsnagErrorsFromWithinPlugins(config: Interfaces.Config) {\n  // Bugsnag have their own plug-ins that use this private field\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const bugsnagConfigProjectRoot: string = (Bugsnag as any)?._client?._config?.projectRoot ?? process.cwd()\n  const projectRoot = path.normalize(bugsnagConfigProjectRoot)\n  const pluginLocations = await Promise.all(\n    config.plugins.map(async (plugin) => {\n      const followSymlinks = await realpath(plugin.root)\n      return {name: plugin.name, pluginPath: path.normalize(followSymlinks)}\n    }),\n  )\n  await initializeBugsnag()\n  Bugsnag.addOnError(async (event) => {\n    event.errors.forEach((error) => {\n      error.stacktrace.forEach((stackFrame) => {\n        stackFrame.file = cleanStackFrameFilePath({currentFilePath: stackFrame.file, projectRoot, pluginLocations})\n      })\n    })\n    try {\n      await addBugsnagMetadata(event, config)\n      // eslint-disable-next-line no-catch-all/no-catch-all\n    } catch (metadataError) {\n      debug(`There was an error adding metadata to the Bugsnag report; Ignoring and carrying on ${metadataError}`)\n    }\n  })\n}\n\nexport async function addBugsnagMetadata(event: Event, config: Interfaces.Config) {\n  const publicData = metadata.getAllPublic()\n  const {commandStartOptions} = metadata.getAllSensitive()\n  const {startCommand} = commandStartOptions ?? {}\n\n  const {'@shopify/app': appPublic, ...otherPluginsPublic} = await fanoutHooks(config, 'public_command_metadata', {})\n\n  const environment = await getEnvironmentData(config)\n\n  const allMetadata = {\n    command: startCommand,\n    ...appPublic,\n    ...publicData,\n    ...environment,\n    pluginData: otherPluginsPublic,\n  }\n\n  const appData = {} as {[key: string]: unknown}\n  const commandData = {} as {[key: string]: unknown}\n  const environmentData = {} as {[key: string]: unknown}\n  const miscData = {} as {[key: string]: unknown}\n  const appKeys = ['api_key', 'partner_id', 'project_type']\n  const commandKeys = ['command']\n  const environmentKeys = ['cli_version', 'node_version', 'ruby_version', 'uname']\n\n  Object.entries(allMetadata).forEach(([key, value]) => {\n    if (key.startsWith('app_') || appKeys.includes(key)) {\n      appData[key] = value\n    } else if (key.startsWith('cmd_') || commandKeys.includes(key)) {\n      commandData[key] = value\n    } else if (key.startsWith('env_') || environmentKeys) {\n      environmentData[key] = value\n    } else {\n      miscData[key] = value\n    }\n  })\n\n  // app, command, environment, misc\n  const bugsnagMetadata = {\n    'Shopify App': appData,\n    Command: commandData,\n    Environment: environmentData,\n    Misc: miscData,\n  }\n  Object.entries(bugsnagMetadata).forEach(([section, values]) => {\n    event.addMetadata(section, values)\n  })\n}\n\nasync function initializeBugsnag() {\n  if (Bugsnag.isStarted()) {\n    return\n  }\n  Bugsnag.start({\n    appType: 'node',\n    apiKey: bugsnagApiKey,\n    logger: null,\n    appVersion: await constants.versions.cliKit(),\n    autoTrackSessions: false,\n    autoDetectErrors: false,\n  })\n}\n"]}
+{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../../src/node/error-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,eAAe,EACf,MAAM,IAAI,WAAW,EACrB,YAAY,IAAI,iBAAiB,EACjC,OAAO,EACP,yBAAyB,GAC1B,MAAM,aAAa,CAAA;AACpB,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,MAAM,cAAc,CAAA;AACxC,OAAO,EAAC,kBAAkB,EAAE,WAAW,EAAC,MAAM,iBAAiB,CAAA;AAC/D,OAAO,KAAK,IAAI,MAAM,YAAY,CAAA;AAClC,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAA;AACzC,OAAO,SAAS,EAAE,EAAC,aAAa,EAAC,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAC,QAAQ,EAAa,MAAM,aAAa,CAAA;AAChD,OAAO,WAAW,MAAM,aAAa,CAAA;AACrC,OAAO,OAAgB,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AAEpC,MAAM,UAAU,YAAY,CAAC,KAA8C,EAAE,MAA0B;IACrG,IAAI,KAAK,YAAY,eAAe,EAAE;QACpC,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;SAC5B;KACF;SAAM,IAAI,KAAK,YAAY,WAAW,EAAE;QACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KAChB;SAAM;QACL,OAAO,WAAW,CAAC,KAAK,CAAC;aACtB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;aACvD,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;KACL;AACH,CAAC;AAED,MAAM,WAAW,GAAG,KAAK,EAAE,KAAc,EAAE,MAA0B,EAAiB,EAAE;IACtF,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,+CAA+C;QAC/C,MAAM,WAAW,CAAC,EAAC,MAAM,EAAE,YAAY,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAC,CAAC,CAAA;KAC9F;IACD,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAA;AACjC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAc;IAEd,IAAI,QAAQ,CAAC,KAAK,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;QAAE,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAC,CAAA;IAEhF,IAAI,eAAsB,CAAA;IAC1B,IAAI,UAA8B,CAAA;IAClC,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,MAAM,GAAG,IAAI,CAAA;QACb,eAAe,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC1C,UAAU,GAAG,KAAK,CAAC,KAAK,CAAA;QAExB;;;;;;WAMG;KACJ;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;QACjE,MAAM,GAAG,IAAI,CAAA;QACb,eAAe,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;QAClC,UAAU,GAAG,eAAe,CAAC,KAAK,CAAA;KACnC;SAAM;QACL,MAAM,GAAG,KAAK,CAAA;QACd,eAAe,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;KAC7C;IAED,MAAM,mBAAmB,GAAG,IAAI,WAAW,CAAC,UAAU,IAAI,EAAE,CAAC;SAC1D,KAAK,EAAE;SACP,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAClB,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrD,OAAO,UAAU,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAA;IAC1E,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;IACb,eAAe,CAAC,KAAK,GAAG,UAAU,eAAe,CAAC,OAAO,KAAK,mBAAmB,EAAE,CAAA;IAEnF,IAAI,MAAM,EAAE;QACV,MAAM,iBAAiB,EAAE,CAAA;QACzB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBAC1D,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAA;iBACd;qBAAM;oBACL,OAAO,CAAC,eAAe,CAAC,CAAA;iBACzB;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;IACD,OAAO,EAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAC,CAAA;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,eAAe,EACf,WAAW,EACX,eAAe,GAKhB;IACC,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;IAEjH,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,EAAC,UAAU,EAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE9G,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpC,4IAA4I;QAC5I,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAA;KACtG;IAED,8EAA8E;IAC9E,OAAO,eAAe,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;AACxD,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,2CAA2C,CAAC,MAAyB;IACzF,8DAA8D;IAC9D,8DAA8D;IAC9D,MAAM,wBAAwB,GAAY,OAAe,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;IACzG,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAA;IAC5D,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAClC,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAClD,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAC,CAAA;IACxE,CAAC,CAAC,CACH,CAAA;IACD,MAAM,iBAAiB,EAAE,CAAA;IACzB,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACjC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtC,UAAU,CAAC,IAAI,GAAG,uBAAuB,CAAC,EAAC,eAAe,EAAE,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,eAAe,EAAC,CAAC,CAAA;YAC7G,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI;YACF,MAAM,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YACvC,qDAAqD;SACtD;QAAC,OAAO,aAAa,EAAE;YACtB,KAAK,CAAC,sFAAsF,aAAa,EAAE,CAAC,CAAA;SAC7G;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAY,EAAE,MAAyB;IAC9E,MAAM,UAAU,GAAG,QAAQ,CAAC,YAAY,EAAE,CAAA;IAC1C,MAAM,EAAC,mBAAmB,EAAC,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAA;IACxD,MAAM,EAAC,YAAY,EAAC,GAAG,mBAAmB,IAAI,EAAE,CAAA;IAEhD,MAAM,EAAC,cAAc,EAAE,SAAS,EAAE,GAAG,kBAAkB,EAAC,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAA;IAEnH,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAA;IAEpD,MAAM,WAAW,GAAG;QAClB,OAAO,EAAE,YAAY;QACrB,GAAG,SAAS;QACZ,GAAG,UAAU;QACb,GAAG,WAAW;QACd,UAAU,EAAE,kBAAkB;KAC/B,CAAA;IAED,MAAM,OAAO,GAAG,EAA8B,CAAA;IAC9C,MAAM,WAAW,GAAG,EAA8B,CAAA;IAClD,MAAM,eAAe,GAAG,EAA8B,CAAA;IACtD,MAAM,QAAQ,GAAG,EAA8B,CAAA;IAC/C,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,CAAC,CAAA;IACzD,MAAM,WAAW,GAAG,CAAC,SAAS,CAAC,CAAA;IAC/B,MAAM,eAAe,GAAG,CAAC,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAEhF,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACnD,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACrB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9D,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACzB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,eAAe,EAAE;YACpD,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SAC7B;aAAM;YACL,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;SACtB;IACH,CAAC,CAAC,CAAA;IAEF,kCAAkC;IAClC,MAAM,eAAe,GAAG;QACtB,aAAa,EAAE,OAAO;QACtB,OAAO,EAAE,WAAW;QACpB,WAAW,EAAE,eAAe;QAC5B,IAAI,EAAE,QAAQ;KACf,CAAA;IACD,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE;QAC5D,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACpC,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB;IAC9B,IAAI,OAAO,CAAC,SAAS,EAAE,EAAE;QACvB,OAAM;KACP;IACD,OAAO,CAAC,KAAK,CAAC;QACZ,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC7C,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;KACxB,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {\n  AbortSilent,\n  CancelExecution,\n  mapper as errorMapper,\n  shouldReport as shouldReportError,\n  handler,\n  cleanSingleStackTracePath,\n} from '../error.js'\nimport {debug, info} from '../output.js'\nimport {getEnvironmentData, reportEvent} from '../analytics.js'\nimport * as path from '../path.js'\nimport * as metadata from '../metadata.js'\nimport {fanoutHooks} from '../plugins.js'\nimport constants, {bugsnagApiKey} from '../constants.js'\nimport {settings, Interfaces} from '@oclif/core'\nimport StackTracey from 'stacktracey'\nimport Bugsnag, {Event} from '@bugsnag/js'\nimport {realpath} from 'fs/promises'\n\nexport function errorHandler(error: Error & {exitCode?: number | undefined}, config?: Interfaces.Config) {\n  if (error instanceof CancelExecution) {\n    if (error.message && error.message !== '') {\n      info(`✨  ${error.message}`)\n    }\n  } else if (error instanceof AbortSilent) {\n    process.exit(1)\n  } else {\n    return errorMapper(error)\n      .then((error) => {\n        return handler(error)\n      })\n      .then((mappedError) => reportError(mappedError, config))\n      .then(() => {\n        process.exit(1)\n      })\n  }\n}\n\nconst reportError = async (error: unknown, config?: Interfaces.Config): Promise<void> => {\n  if (config !== undefined) {\n    // Log an analytics event when there's an error\n    await reportEvent({config, errorMessage: error instanceof Error ? error.message : undefined})\n  }\n  await sendErrorToBugsnag(error)\n}\n\n/**\n * Sends an error to Bugsnag. This is configured automatically for uncaught errors from CLI commands, but can also be used to manually record an error.\n *\n * @returns the reported error (this may have been tweaked for better reporting), and a bool to indicate if the error was actually submitted or not\n */\nexport async function sendErrorToBugsnag(\n  error: unknown,\n): Promise<{reported: false; error: unknown} | {error: Error; reported: true}> {\n  if (settings.debug || !shouldReportError(error)) return {reported: false, error}\n\n  let reportableError: Error\n  let stacktrace: string | undefined\n  let report = false\n\n  if (error instanceof Error) {\n    report = true\n    reportableError = new Error(error.message)\n    stacktrace = error.stack\n\n    /**\n     * Some errors that reach this point have an empty string. For example:\n     * https://app.bugsnag.com/shopify/cli/errors/62cd5d31fd5040000814086c?filters[event.since]=30d&filters[error.status]=new&filters[release.seen_in]=3.1.0\n     *\n     * Because at this point we have neither the error message nor a stack trace reporting them\n     * to Bugsnag is pointless and adds noise.\n     */\n  } else if (typeof error === 'string' && error.trim().length !== 0) {\n    report = true\n    reportableError = new Error(error)\n    stacktrace = reportableError.stack\n  } else {\n    report = false\n    reportableError = new Error('Unknown error')\n  }\n\n  const formattedStacktrace = new StackTracey(stacktrace ?? '')\n    .clean()\n    .items.map((item) => {\n      const filePath = cleanSingleStackTracePath(item.file)\n      return `    at ${item.callee} (${filePath}:${item.line}:${item.column})`\n    })\n    .join('\\n')\n  reportableError.stack = `Error: ${reportableError.message}\\n${formattedStacktrace}`\n\n  if (report) {\n    await initializeBugsnag()\n    await new Promise((resolve, reject) => {\n      Bugsnag.notify(reportableError, undefined, (error, event) => {\n        if (error) {\n          reject(error)\n        } else {\n          resolve(reportableError)\n        }\n      })\n    })\n  }\n  return {error: reportableError, reported: report}\n}\n\n/**\n * If the given file path is within a node_modules folder, remove prefix up\n * to and including the node_modules folder.\n *\n * This gives us very consistent paths for errors generated by the CLI.\n */\nexport function cleanStackFrameFilePath({\n  currentFilePath,\n  projectRoot,\n  pluginLocations,\n}: {\n  currentFilePath: string\n  projectRoot: string\n  pluginLocations: {name: string; pluginPath: string}[]\n}): string {\n  const fullLocation = path.isAbsolute(currentFilePath) ? currentFilePath : path.join(projectRoot, currentFilePath)\n\n  const matchingPluginPath = pluginLocations.filter(({pluginPath}) => fullLocation.indexOf(pluginPath) === 0)[0]\n\n  if (matchingPluginPath !== undefined) {\n    // the plugin name (e.g. @shopify/cli-kit), plus the relative path of the error line from within the plugin's code (e.g. dist/something.js )\n    return path.join(matchingPluginPath.name, path.relative(matchingPluginPath.pluginPath, fullLocation))\n  }\n\n  // strip prefix up to node_modules folder, so we can normalize error reporting\n  return currentFilePath.replace(/.*node_modules\\//, '')\n}\n\n/**\n * Register a Bugsnag error listener to clean up stack traces for errors within plugin code.\n *\n */\nexport async function registerCleanBugsnagErrorsFromWithinPlugins(config: Interfaces.Config) {\n  // Bugsnag have their own plug-ins that use this private field\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const bugsnagConfigProjectRoot: string = (Bugsnag as any)?._client?._config?.projectRoot ?? process.cwd()\n  const projectRoot = path.normalize(bugsnagConfigProjectRoot)\n  const pluginLocations = await Promise.all(\n    config.plugins.map(async (plugin) => {\n      const followSymlinks = await realpath(plugin.root)\n      return {name: plugin.name, pluginPath: path.normalize(followSymlinks)}\n    }),\n  )\n  await initializeBugsnag()\n  Bugsnag.addOnError(async (event) => {\n    event.errors.forEach((error) => {\n      error.stacktrace.forEach((stackFrame) => {\n        stackFrame.file = cleanStackFrameFilePath({currentFilePath: stackFrame.file, projectRoot, pluginLocations})\n      })\n    })\n    try {\n      await addBugsnagMetadata(event, config)\n      // eslint-disable-next-line no-catch-all/no-catch-all\n    } catch (metadataError) {\n      debug(`There was an error adding metadata to the Bugsnag report; Ignoring and carrying on ${metadataError}`)\n    }\n  })\n}\n\nexport async function addBugsnagMetadata(event: Event, config: Interfaces.Config) {\n  const publicData = metadata.getAllPublic()\n  const {commandStartOptions} = metadata.getAllSensitive()\n  const {startCommand} = commandStartOptions ?? {}\n\n  const {'@shopify/app': appPublic, ...otherPluginsPublic} = await fanoutHooks(config, 'public_command_metadata', {})\n\n  const environment = await getEnvironmentData(config)\n\n  const allMetadata = {\n    command: startCommand,\n    ...appPublic,\n    ...publicData,\n    ...environment,\n    pluginData: otherPluginsPublic,\n  }\n\n  const appData = {} as {[key: string]: unknown}\n  const commandData = {} as {[key: string]: unknown}\n  const environmentData = {} as {[key: string]: unknown}\n  const miscData = {} as {[key: string]: unknown}\n  const appKeys = ['api_key', 'partner_id', 'project_type']\n  const commandKeys = ['command']\n  const environmentKeys = ['cli_version', 'node_version', 'ruby_version', 'uname']\n\n  Object.entries(allMetadata).forEach(([key, value]) => {\n    if (key.startsWith('app_') || appKeys.includes(key)) {\n      appData[key] = value\n    } else if (key.startsWith('cmd_') || commandKeys.includes(key)) {\n      commandData[key] = value\n    } else if (key.startsWith('env_') || environmentKeys) {\n      environmentData[key] = value\n    } else {\n      miscData[key] = value\n    }\n  })\n\n  // app, command, environment, misc\n  const bugsnagMetadata = {\n    'Shopify App': appData,\n    Command: commandData,\n    Environment: environmentData,\n    Misc: miscData,\n  }\n  Object.entries(bugsnagMetadata).forEach(([section, values]) => {\n    event.addMetadata(section, values)\n  })\n}\n\nasync function initializeBugsnag() {\n  if (Bugsnag.isStarted()) {\n    return\n  }\n  Bugsnag.start({\n    appType: 'node',\n    apiKey: bugsnagApiKey,\n    logger: null,\n    appVersion: await constants.versions.cliKit(),\n    autoTrackSessions: false,\n    autoDetectErrors: false,\n  })\n}\n"]}

package/dist/plugins/tunnel.d.ts

@@ -1,4 +1,11 @@
+import { Result } from '../public/common/result.js';
 import { FanoutHookFunction, PluginReturnsForHook } from '../plugins.js';
+import { ExtendableError } from '../error.js';
+export declare type TunnelErrorType = 'invalid-provider' | 'tunnel-already-running' | 'wrong-credentials' | 'unknown';
+export declare class TunnelError extends ExtendableError {
+    type: TunnelErrorType;
+    constructor(type: TunnelErrorType, message?: string);
+}
 /**
  * Tunnel Plugins types
  *
@@ -11,9 +18,9 @@ export interface HookReturnPerTunnelPlugin {
             provider: string;
         };
         pluginReturns: {
-            [pluginName: string]: {
-                url: string | undefined;
-            };
+            [pluginName: string]: Result<{
+                url: string;
+            }, TunnelError>;
         };
     };
     tunnel_provider: {

package/dist/plugins/tunnel.js

@@ -1,10 +1,18 @@
+import { err } from '../public/common/result.js';
+import { ExtendableError } from '../error.js';
+export class TunnelError extends ExtendableError {
+    constructor(type, message) {
+        super(message);
+        this.type = type;
+    }
+}
 export const defineProvider = (input) => {
     return async () => input;
 };
 export const startTunnel = (options) => {
     return async (inputs) => {
         if (inputs.provider !== options.provider)
-            return { url: undefined };
+            return err(new TunnelError('invalid-provider'));
         return options.action(inputs.port);
     };
 };

package/dist/plugins/tunnel.js.map

@@ -1 +1 @@
-{"version":3,"file":"tunnel.js","sourceRoot":"","sources":["../../src/plugins/tunnel.ts"],"names":[],"mappings":"AA2BA,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAqB,EAA0B,EAAE;IAC9E,OAAO,KAAK,IAAI,EAAE,CAAC,KAAK,CAAA;AAC1B,CAAC,CAAA;AACD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAsD,EAAuB,EAAE;IACzG,OAAO,KAAK,EAAE,MAAwC,EAA8B,EAAE;QACpF,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAAE,OAAO,EAAC,GAAG,EAAE,SAAS,EAAC,CAAA;QACjE,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC,CAAA;AACH,CAAC,CAAA","sourcesContent":["import {FanoutHookFunction, PluginReturnsForHook} from '../plugins.js'\n\n/**\n * Tunnel Plugins types\n *\n * Any plugin that provides tunnel functionality should implement `defineProvider`and `startTunnel`\n */\nexport interface HookReturnPerTunnelPlugin {\n  tunnel_start: {\n    options: {port: number; provider: string}\n    pluginReturns: {\n      [pluginName: string]: {url: string | undefined}\n    }\n  }\n  tunnel_provider: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      [pluginName: string]: {name: string}\n    }\n  }\n}\n\nexport type TunnelProviderFunction = FanoutHookFunction<'tunnel_provider', ''>\nexport type TunnelStartFunction = FanoutHookFunction<'tunnel_start', ''>\nexport type TunnelStartReturn = PluginReturnsForHook<'tunnel_start', ''>\nexport type TunnelStartAction = (port: number) => Promise<TunnelStartReturn>\n\nexport const defineProvider = (input: {name: string}): TunnelProviderFunction => {\n  return async () => input\n}\nexport const startTunnel = (options: {provider: string; action: TunnelStartAction}): TunnelStartFunction => {\n  return async (inputs: {provider: string; port: number}): Promise<TunnelStartReturn> => {\n    if (inputs.provider !== options.provider) return {url: undefined}\n    return options.action(inputs.port)\n  }\n}\n"]}
+{"version":3,"file":"tunnel.js","sourceRoot":"","sources":["../../src/plugins/tunnel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAS,MAAM,4BAA4B,CAAA;AAEtD,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAA;AAG3C,MAAM,OAAO,WAAY,SAAQ,eAAe;IAE9C,YAAY,IAAqB,EAAE,OAAgB;QACjD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AA2BD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAqB,EAA0B,EAAE;IAC9E,OAAO,KAAK,IAAI,EAAE,CAAC,KAAK,CAAA;AAC1B,CAAC,CAAA;AACD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAsD,EAAuB,EAAE;IACzG,OAAO,KAAK,EAAE,MAAwC,EAA8B,EAAE;QACpF,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAAE,OAAO,GAAG,CAAC,IAAI,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAA;QACzF,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC,CAAA;AACH,CAAC,CAAA","sourcesContent":["import {err, Result} from '../public/common/result.js'\nimport {FanoutHookFunction, PluginReturnsForHook} from '../plugins.js'\nimport {ExtendableError} from '../error.js'\n\nexport type TunnelErrorType = 'invalid-provider' | 'tunnel-already-running' | 'wrong-credentials' | 'unknown'\nexport class TunnelError extends ExtendableError {\n  type: TunnelErrorType\n  constructor(type: TunnelErrorType, message?: string) {\n    super(message)\n    this.type = type\n  }\n}\n\n/**\n * Tunnel Plugins types\n *\n * Any plugin that provides tunnel functionality should implement `defineProvider`and `startTunnel`\n */\nexport interface HookReturnPerTunnelPlugin {\n  tunnel_start: {\n    options: {port: number; provider: string}\n    pluginReturns: {\n      [pluginName: string]: Result<{url: string}, TunnelError>\n    }\n  }\n  tunnel_provider: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      [pluginName: string]: {name: string}\n    }\n  }\n}\n\nexport type TunnelProviderFunction = FanoutHookFunction<'tunnel_provider', ''>\nexport type TunnelStartFunction = FanoutHookFunction<'tunnel_start', ''>\nexport type TunnelStartReturn = PluginReturnsForHook<'tunnel_start', ''>\nexport type TunnelStartAction = (port: number) => Promise<TunnelStartReturn>\n\nexport const defineProvider = (input: {name: string}): TunnelProviderFunction => {\n  return async () => input\n}\nexport const startTunnel = (options: {provider: string; action: TunnelStartAction}): TunnelStartFunction => {\n  return async (inputs: {provider: string; port: number}): Promise<TunnelStartReturn> => {\n    if (inputs.provider !== options.provider) return err(new TunnelError('invalid-provider'))\n    return options.action(inputs.port)\n  }\n}\n"]}

package/dist/plugins.d.ts

@@ -2,6 +2,7 @@ import { JsonMap } from './json.js';
 import { PickByPrefix } from './typing/pick-by-prefix.js';
 import { MonorailEventPublic, MonorailEventSensitive } from './monorail.js';
 import { HookReturnPerTunnelPlugin } from './plugins/tunnel.js';
+import { Result } from './public/common/result.js';
 import { Config, Interfaces } from '@oclif/core';
 /**
  * Convenience function to trigger a hook, and gather any successful responses. Failures are ignored.
@@ -35,7 +36,7 @@ interface HookReturnsPerPlugin extends HookReturnPerTunnelPlugin {
             [key: string]: unknown;
         };
         pluginReturns: {
-            [key: string]: JsonMap;
+            [key: string]: JsonMap | Result<JsonMap, Error>;
         };
     };
 }
@@ -54,6 +55,11 @@ export declare function getListOfTunnelPlugins(config: Config): Promise<{
     plugins: string[];
     error?: string;
 }>;
+export interface TunnelPluginError {
+    provider: string;
+    type: 'multiple-urls' | 'handled-error' | 'unknown' | 'no-provider';
+    message?: string;
+}
 /**
  * Execute the 'tunnel_start' hook for the given provider.
  * Fails if there aren't plugins for that provider or if there are more than one.
@@ -63,8 +69,5 @@ export declare function getListOfTunnelPlugins(config: Config): Promise<{
  * @param provider - selected provider, must be unique
  * @returns tunnel URL from the selected provider
  */
-export declare function runTunnelPlugin(config: Config, port: number, provider: string): Promise<{
-    url?: string;
-    error?: string;
-}>;
+export declare function runTunnelPlugin(config: Config, port: number, provider: string): Promise<Result<string, TunnelPluginError>>;
 export {};

package/dist/plugins.js

@@ -1,4 +1,5 @@
 import { getArrayContainsDuplicates, getArrayRejectingUndefined } from './public/common/array.js';
+import { err } from './public/common/result.js';
 /**
  * Convenience function to trigger a hook, and gather any successful responses. Failures are ignored.
  *
@@ -34,11 +35,15 @@ export async function getListOfTunnelPlugins(config) {
  */
 export async function runTunnelPlugin(config, port, provider) {
     const hooks = await fanoutHooks(config, 'tunnel_start', { port, provider });
-    const urls = getArrayRejectingUndefined(Object.values(hooks).map((key) => key?.url));
-    if (urls.length > 1)
-        return { error: 'multiple-urls' };
-    if (urls.length === 0)
-        return { error: 'no-urls' };
-    return { url: urls[0] };
+    const urlResults = Object.values(hooks).filter((tunnelResponse) => !tunnelResponse?.isErr() || tunnelResponse.error.type !== 'invalid-provider');
+    if (urlResults.length > 1)
+        return err({ provider, type: 'multiple-urls' });
+    if (urlResults.length === 0 || !urlResults[0])
+        return err({ provider, type: 'no-provider' });
+    return urlResults[0]
+        .map((data) => data.url)
+        .mapError((error) => error.type === 'unknown'
+        ? { provider, type: 'unknown', message: error.message }
+        : { provider, type: 'handled-error' });
 }
 //# sourceMappingURL=plugins.js.map

package/dist/plugins.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,0BAA0B,EAAE,0BAA0B,EAAC,MAAM,0BAA0B,CAAA;AAG/F;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAyB,EACzB,KAAa,EACb,OAA4C,EAC5C,OAAgB;IAEhB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACzD,8DAA8D;IAC9D,OAAO,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAQ,CAAA;AAClG,CAAC;AA4CD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,MAAc;IACzD,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAA;IAC9D,MAAM,KAAK,GAAG,0BAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;IACtF,IAAI,0BAA0B,CAAC,KAAK,CAAC;QAAE,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,+BAA+B,EAAC,CAAA;IACtG,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,CAAA;AACzB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,IAAY,EACZ,QAAgB;IAEhB,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAA;IACzE,MAAM,IAAI,GAAG,0BAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;IACpF,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAC,KAAK,EAAE,eAAe,EAAC,CAAA;IACpD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,CAAA;IAChD,OAAO,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAC,CAAA;AACvB,CAAC","sourcesContent":["import {JsonMap} from './json.js'\nimport {PickByPrefix} from './typing/pick-by-prefix.js'\nimport {MonorailEventPublic, MonorailEventSensitive} from './monorail.js'\nimport {HookReturnPerTunnelPlugin} from './plugins/tunnel.js'\nimport {getArrayContainsDuplicates, getArrayRejectingUndefined} from './public/common/array.js'\nimport {Config, Interfaces} from '@oclif/core'\n\n/**\n * Convenience function to trigger a hook, and gather any successful responses. Failures are ignored.\n *\n * Responses are organised into a dictionary, keyed by plug-in name. Only plug-ins that have hooks registered for the given event, and the hooks were run successfully, are included.\n */\nexport async function fanoutHooks<TPluginMap extends HookReturnsPerPlugin, TEvent extends string & keyof TPluginMap>(\n  config: Interfaces.Config,\n  event: TEvent,\n  options: TPluginMap[typeof event]['options'],\n  timeout?: number,\n): Promise<Partial<TPluginMap[typeof event]['pluginReturns']>> {\n  const res = await config.runHook(event, options, timeout)\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  return Object.fromEntries(res.successes.map(({result, plugin}) => [plugin.name, result])) as any\n}\n\ntype AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id'> &\n  PickByPrefix<MonorailEventPublic, 'cmd_extensions_'> &\n  PickByPrefix<MonorailEventPublic, 'cmd_scaffold_'>\n\ntype AppSpecificSensitiveMonorailFields = PickByPrefix<MonorailEventSensitive, 'app_'>\n\ninterface HookReturnsPerPlugin extends HookReturnPerTunnelPlugin {\n  public_command_metadata: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      '@shopify/app': Partial<AppSpecificMonorailFields>\n      [pluginName: string]: JsonMap\n    }\n  }\n  sensitive_command_metadata: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      '@shopify/app': Partial<AppSpecificSensitiveMonorailFields>\n      [pluginName: string]: JsonMap\n    }\n  }\n  [hookName: string]: {\n    options: {[key: string]: unknown}\n    pluginReturns: {[key: string]: JsonMap}\n  }\n}\n\nexport type PluginReturnsForHook<\n  TEvent extends keyof TPluginMap,\n  TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'],\n  TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin,\n> = TPluginMap[TEvent]['pluginReturns'][TPluginName]\n\nexport type FanoutHookFunction<\n  TEvent extends keyof TPluginMap = string,\n  TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'] = string,\n  TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin,\n> = (\n  this: Interfaces.Hook.Context,\n  options: TPluginMap[TEvent]['options'] & {config: Interfaces.Config},\n) => Promise<PluginReturnsForHook<TEvent, TPluginName, TPluginMap>>\n\n/**\n * Execute the 'tunnel_provider' hook, and return the list of available tunnel providers.\n * Fail if there are multiple plugins for the same provider\n *\n * @param config - oclif config used to execute hooks\n * @returns list of available tunnel plugins\n */\nexport async function getListOfTunnelPlugins(config: Config): Promise<{plugins: string[]; error?: string}> {\n  const hooks = await fanoutHooks(config, 'tunnel_provider', {})\n  const names = getArrayRejectingUndefined(Object.values(hooks).map((key) => key?.name))\n  if (getArrayContainsDuplicates(names)) return {plugins: names, error: 'multiple-plugins-for-provider'}\n  return {plugins: names}\n}\n\n/**\n * Execute the 'tunnel_start' hook for the given provider.\n * Fails if there aren't plugins for that provider or if there are more than one.\n *\n * @param config - oclif config used to execute hooks\n * @param port - port where the tunnel will be started\n * @param provider - selected provider, must be unique\n * @returns tunnel URL from the selected provider\n */\nexport async function runTunnelPlugin(\n  config: Config,\n  port: number,\n  provider: string,\n): Promise<{url?: string; error?: string}> {\n  const hooks = await fanoutHooks(config, 'tunnel_start', {port, provider})\n  const urls = getArrayRejectingUndefined(Object.values(hooks).map((key) => key?.url))\n  if (urls.length > 1) return {error: 'multiple-urls'}\n  if (urls.length === 0) return {error: 'no-urls'}\n  return {url: urls[0]}\n}\n"]}
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,0BAA0B,EAAE,0BAA0B,EAAC,MAAM,0BAA0B,CAAA;AAC/F,OAAO,EAAC,GAAG,EAAS,MAAM,2BAA2B,CAAA;AAGrD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAyB,EACzB,KAAa,EACb,OAA4C,EAC5C,OAAgB;IAEhB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACzD,8DAA8D;IAC9D,OAAO,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAQ,CAAA;AAClG,CAAC;AA4CD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,MAAc;IACzD,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAA;IAC9D,MAAM,KAAK,GAAG,0BAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;IACtF,IAAI,0BAA0B,CAAC,KAAK,CAAC;QAAE,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,+BAA+B,EAAC,CAAA;IACtG,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,CAAA;AACzB,CAAC;AAQD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,IAAY,EACZ,QAAgB;IAEhB,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAA;IACzE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAC5C,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,cAAc,EAAE,KAAK,EAAE,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,KAAK,kBAAkB,CACjG,CAAA;IACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAC,CAAC,CAAA;IACxE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,EAAC,CAAC,CAAA;IAE1F,OAAO,UAAU,CAAC,CAAC,CAAC;SACjB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;SACvB,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAClB,KAAK,CAAC,IAAI,KAAK,SAAS;QACtB,CAAC,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAC;QACrD,CAAC,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAC,CACtC,CAAA;AACL,CAAC","sourcesContent":["import {JsonMap} from './json.js'\nimport {PickByPrefix} from './typing/pick-by-prefix.js'\nimport {MonorailEventPublic, MonorailEventSensitive} from './monorail.js'\nimport {HookReturnPerTunnelPlugin} from './plugins/tunnel.js'\nimport {getArrayContainsDuplicates, getArrayRejectingUndefined} from './public/common/array.js'\nimport {err, Result} from './public/common/result.js'\nimport {Config, Interfaces} from '@oclif/core'\n\n/**\n * Convenience function to trigger a hook, and gather any successful responses. Failures are ignored.\n *\n * Responses are organised into a dictionary, keyed by plug-in name. Only plug-ins that have hooks registered for the given event, and the hooks were run successfully, are included.\n */\nexport async function fanoutHooks<TPluginMap extends HookReturnsPerPlugin, TEvent extends string & keyof TPluginMap>(\n  config: Interfaces.Config,\n  event: TEvent,\n  options: TPluginMap[typeof event]['options'],\n  timeout?: number,\n): Promise<Partial<TPluginMap[typeof event]['pluginReturns']>> {\n  const res = await config.runHook(event, options, timeout)\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  return Object.fromEntries(res.successes.map(({result, plugin}) => [plugin.name, result])) as any\n}\n\ntype AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id'> &\n  PickByPrefix<MonorailEventPublic, 'cmd_extensions_'> &\n  PickByPrefix<MonorailEventPublic, 'cmd_scaffold_'>\n\ntype AppSpecificSensitiveMonorailFields = PickByPrefix<MonorailEventSensitive, 'app_'>\n\ninterface HookReturnsPerPlugin extends HookReturnPerTunnelPlugin {\n  public_command_metadata: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      '@shopify/app': Partial<AppSpecificMonorailFields>\n      [pluginName: string]: JsonMap\n    }\n  }\n  sensitive_command_metadata: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      '@shopify/app': Partial<AppSpecificSensitiveMonorailFields>\n      [pluginName: string]: JsonMap\n    }\n  }\n  [hookName: string]: {\n    options: {[key: string]: unknown}\n    pluginReturns: {[key: string]: JsonMap | Result<JsonMap, Error>}\n  }\n}\n\nexport type PluginReturnsForHook<\n  TEvent extends keyof TPluginMap,\n  TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'],\n  TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin,\n> = TPluginMap[TEvent]['pluginReturns'][TPluginName]\n\nexport type FanoutHookFunction<\n  TEvent extends keyof TPluginMap = string,\n  TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'] = string,\n  TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin,\n> = (\n  this: Interfaces.Hook.Context,\n  options: TPluginMap[TEvent]['options'] & {config: Interfaces.Config},\n) => Promise<PluginReturnsForHook<TEvent, TPluginName, TPluginMap>>\n\n/**\n * Execute the 'tunnel_provider' hook, and return the list of available tunnel providers.\n * Fail if there are multiple plugins for the same provider\n *\n * @param config - oclif config used to execute hooks\n * @returns list of available tunnel plugins\n */\nexport async function getListOfTunnelPlugins(config: Config): Promise<{plugins: string[]; error?: string}> {\n  const hooks = await fanoutHooks(config, 'tunnel_provider', {})\n  const names = getArrayRejectingUndefined(Object.values(hooks).map((key) => key?.name))\n  if (getArrayContainsDuplicates(names)) return {plugins: names, error: 'multiple-plugins-for-provider'}\n  return {plugins: names}\n}\n\nexport interface TunnelPluginError {\n  provider: string\n  type: 'multiple-urls' | 'handled-error' | 'unknown' | 'no-provider'\n  message?: string\n}\n\n/**\n * Execute the 'tunnel_start' hook for the given provider.\n * Fails if there aren't plugins for that provider or if there are more than one.\n *\n * @param config - oclif config used to execute hooks\n * @param port - port where the tunnel will be started\n * @param provider - selected provider, must be unique\n * @returns tunnel URL from the selected provider\n */\nexport async function runTunnelPlugin(\n  config: Config,\n  port: number,\n  provider: string,\n): Promise<Result<string, TunnelPluginError>> {\n  const hooks = await fanoutHooks(config, 'tunnel_start', {port, provider})\n  const urlResults = Object.values(hooks).filter(\n    (tunnelResponse) => !tunnelResponse?.isErr() || tunnelResponse.error.type !== 'invalid-provider',\n  )\n  if (urlResults.length > 1) return err({provider, type: 'multiple-urls'})\n  if (urlResults.length === 0 || !urlResults[0]) return err({provider, type: 'no-provider'})\n\n  return urlResults[0]\n    .map((data) => data.url)\n    .mapError((error) =>\n      error.type === 'unknown'\n        ? {provider, type: 'unknown', message: error.message}\n        : {provider, type: 'handled-error'},\n    )\n}\n"]}

package/dist/private/node/ui/components/Command.js

@@ -4,7 +4,10 @@ import React from 'react';
  * `Command` displays a command as non-dimmed text.
  */
 const Command = ({ command }) => {
-    return React.createElement(Text, null, command);
+    return React.createElement(Text, null,
+        "`",
+        command,
+        "`");
 };
 export { Command };
 //# sourceMappingURL=Command.js.map

package/dist/private/node/ui/components/Command.js.map

@@ -1 +1 @@
-{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/Command.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB;;GAEG;AACH,MAAM,OAAO,GAAoB,CAAC,EAAC,OAAO,EAAiC,EAAe,EAAE;IAC1F,OAAO,oBAAC,IAAI,QAAE,OAAO,CAAQ,CAAA;AAC/B,CAAC,CAAA;AAED,OAAO,EAAC,OAAO,EAAC,CAAA","sourcesContent":["import {Text} from 'ink'\nimport React from 'react'\n\ninterface Props {\n  command: string\n}\n\n/**\n * `Command` displays a command as non-dimmed text.\n */\nconst Command: React.FC<Props> = ({command}: React.PropsWithChildren<Props>): JSX.Element => {\n  return <Text>{command}</Text>\n}\n\nexport {Command}\n"]}
+{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/Command.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB;;GAEG;AACH,MAAM,OAAO,GAAoB,CAAC,EAAC,OAAO,EAAiC,EAAe,EAAE;IAC1F,OAAO,oBAAC,IAAI;;QAAG,OAAO;YAAS,CAAA;AACjC,CAAC,CAAA;AAED,OAAO,EAAC,OAAO,EAAC,CAAA","sourcesContent":["import {Text} from 'ink'\nimport React from 'react'\n\ninterface Props {\n  command: string\n}\n\n/**\n * `Command` displays a command as non-dimmed text.\n */\nconst Command: React.FC<Props> = ({command}: React.PropsWithChildren<Props>): JSX.Element => {\n  return <Text>`{command}`</Text>\n}\n\nexport {Command}\n"]}

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

@@ -0,0 +1,88 @@
+export declare type Result<TValue, TError> = Ok<TValue, TError> | Err<TValue, TError>;
+/**
+ * Utility metho to create an `Ok` result from a `value`
+ *
+ * @param value - `value` used to crete the `Result`
+ * @returns an instance of a `Ok` `Result` inferring its type
+ */
+export declare const ok: <TValue, TError = never>(value: TValue) => Ok<TValue, TError>;
+/**
+ * Utility method to create an `Error` result from an `error`
+ *
+ * @param err - `error` used to crete the `Result`
+ * @returns an instance of an `Error` `Result` inferring its type
+ */
+export declare const err: <TValue = never, TError = unknown>(err: TError) => Err<TValue, TError>;
+export declare class Ok<TValue, TError> {
+    readonly value: TValue;
+    constructor(value: TValue);
+    /**
+     * Check if a `Result` is an `Err` inferring its type. `!isErr()` should be used before accessing the `value`
+     *
+     * @returns `false` as the `Resul` is `OK`
+     */
+    isErr(): this is Err<TValue, TError>;
+    /**
+     * Runs the `handler` method an return the same an unaltered copy of the `Result`. It could be used to log an
+     * output when the result is `Ok` without breaking the flow
+     *
+     * @param handler - method to be run when the result is `Ok`
+     * @returns a copy of the same `Result`
+     */
+    doOnOk(handler: (value: TValue) => void): Result<TValue, TError>;
+    /**
+     * A safe mode to get the `value` of the `Result`
+     *
+     * @returns the `value` of the `Result`
+     */
+    valueOrThrow(): TValue;
+    /**
+     * Maps the value to another one with a different type. It leaves the `Error` type unaltered
+     *
+     * @param mapper - The mapper method to apply an `OK` value
+     * @returns a new result with the new mapped value
+     */
+    map<TMappedValue>(mapper: (value: TValue) => TMappedValue): Result<TMappedValue, TError>;
+    /**
+     * Maps the error type to another one. It leaves the `Ok` type and value unaltered
+     *
+     * @param _mapper - This mapper method is not used for an `Ok` value
+     * @returns a new result with the new mapped error type and an value
+     */
+    mapError<TMappedError>(_mapper: (error: TError) => TMappedError): Result<TValue, TMappedError>;
+}
+export declare class Err<TValue, TError> {
+    readonly error: TError;
+    constructor(error: TError);
+    /**
+     * Check if a `Result` is an `Err` inferring its type. `!isErr()` should be used before accessing the `value`
+     *
+     * @returns `false` as the `Resul` is `OK`
+     */
+    isErr(): this is Err<TValue, TError>;
+    /**
+     * Return an unaltered copy of the `Error` without doing anything.
+     *
+     * @param _handler - This handler method is not used for an `Error`
+     * @returns a copy of the same `Error`
+     */
+    doOnOk(_handler: (value: TValue) => void): Result<TValue, TError>;
+    /**
+     * A safe mode to throw the `error` of the `Result`
+     */
+    valueOrThrow(): TValue;
+    /**
+     * Maps the value type to another one. It leaves the `Error` unaltered
+     *
+     * @param _mapper - This mapper method is not used for an `Error` value
+     * @returns a new result with the new value type and an unaltered error
+     */
+    map<TMappedValue>(_mapper: (valueOrThrow: TValue) => TMappedValue): Result<TMappedValue, TError>;
+    /**
+     * Maps the error to another one with a different type. It leaves the value type unaltered
+     *
+     * @param mapper - The mapper method to apply an `Error` value
+     * @returns a new result with the new mapped error
+     */
+    mapError<TMappedError>(mapper: (error: TError) => TMappedError): Result<TValue, TMappedError>;
+}

package/dist/public/common/result.js

@@ -0,0 +1,111 @@
+/**
+ * Utility metho to create an `Ok` result from a `value`
+ *
+ * @param value - `value` used to crete the `Result`
+ * @returns an instance of a `Ok` `Result` inferring its type
+ */
+export const ok = (value) => new Ok(value);
+/**
+ * Utility method to create an `Error` result from an `error`
+ *
+ * @param err - `error` used to crete the `Result`
+ * @returns an instance of an `Error` `Result` inferring its type
+ */
+export const err = (err) => new Err(err);
+export class Ok {
+    constructor(value) {
+        this.value = value;
+    }
+    /**
+     * Check if a `Result` is an `Err` inferring its type. `!isErr()` should be used before accessing the `value`
+     *
+     * @returns `false` as the `Resul` is `OK`
+     */
+    isErr() {
+        return false;
+    }
+    /**
+     * Runs the `handler` method an return the same an unaltered copy of the `Result`. It could be used to log an
+     * output when the result is `Ok` without breaking the flow
+     *
+     * @param handler - method to be run when the result is `Ok`
+     * @returns a copy of the same `Result`
+     */
+    doOnOk(handler) {
+        handler(this.value);
+        return ok(this.value);
+    }
+    /**
+     * A safe mode to get the `value` of the `Result`
+     *
+     * @returns the `value` of the `Result`
+     */
+    valueOrThrow() {
+        return this.value;
+    }
+    /**
+     * Maps the value to another one with a different type. It leaves the `Error` type unaltered
+     *
+     * @param mapper - The mapper method to apply an `OK` value
+     * @returns a new result with the new mapped value
+     */
+    map(mapper) {
+        return ok(mapper(this.value));
+    }
+    /**
+     * Maps the error type to another one. It leaves the `Ok` type and value unaltered
+     *
+     * @param _mapper - This mapper method is not used for an `Ok` value
+     * @returns a new result with the new mapped error type and an value
+     */
+    mapError(_mapper) {
+        return ok(this.value);
+    }
+}
+export class Err {
+    constructor(error) {
+        this.error = error;
+    }
+    /**
+     * Check if a `Result` is an `Err` inferring its type. `!isErr()` should be used before accessing the `value`
+     *
+     * @returns `false` as the `Resul` is `OK`
+     */
+    isErr() {
+        return true;
+    }
+    /**
+     * Return an unaltered copy of the `Error` without doing anything.
+     *
+     * @param _handler - This handler method is not used for an `Error`
+     * @returns a copy of the same `Error`
+     */
+    doOnOk(_handler) {
+        return err(this.error);
+    }
+    /**
+     * A safe mode to throw the `error` of the `Result`
+     */
+    valueOrThrow() {
+        throw this.error;
+    }
+    /**
+     * Maps the value type to another one. It leaves the `Error` unaltered
+     *
+     * @param _mapper - This mapper method is not used for an `Error` value
+     * @returns a new result with the new value type and an unaltered error
+     */
+    map(_mapper) {
+        return err(this.error);
+    }
+    /**
+     * Maps the error to another one with a different type. It leaves the value type unaltered
+     *
+     * @param mapper - The mapper method to apply an `Error` value
+     * @returns a new result with the new mapped error
+     */
+    mapError(mapper) {
+        return err(mapper(this.error));
+    }
+}
+//# sourceMappingURL=result.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../../src/public/common/result.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,EAAE,GAAG,CAAyB,KAAa,EAAsB,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;AAE9F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAmC,GAAW,EAAuB,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;AAEvG,MAAM,OAAO,EAAE;IACb,YAAqB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAEtC;;;;OAIG;IACH,KAAK;QACH,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAgC;QACrC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnB,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED;;;;OAIG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAe,MAAuC;QACvD,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAe,OAAwC;QAC7D,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;CACF;AAED,MAAM,OAAO,GAAG;IACd,YAAqB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAEtC;;;;OAIG;IACH,KAAK;QACH,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAiC;QACtC,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,YAAY;QACV,MAAM,IAAI,CAAC,KAAK,CAAA;IAClB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAe,OAA+C;QAC/D,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAe,MAAuC;QAC5D,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IAChC,CAAC;CACF","sourcesContent":["/* eslint-disable node/handle-callback-err */\nexport type Result<TValue, TError> = Ok<TValue, TError> | Err<TValue, TError>\n\n/**\n * Utility metho to create an `Ok` result from a `value`\n *\n * @param value - `value` used to crete the `Result`\n * @returns an instance of a `Ok` `Result` inferring its type\n */\nexport const ok = <TValue, TError = never>(value: TValue): Ok<TValue, TError> => new Ok(value)\n\n/**\n * Utility method to create an `Error` result from an `error`\n *\n * @param err - `error` used to crete the `Result`\n * @returns an instance of an `Error` `Result` inferring its type\n */\nexport const err = <TValue = never, TError = unknown>(err: TError): Err<TValue, TError> => new Err(err)\n\nexport class Ok<TValue, TError> {\n  constructor(readonly value: TValue) {}\n\n  /**\n   * Check if a `Result` is an `Err` inferring its type. `!isErr()` should be used before accessing the `value`\n   *\n   * @returns `false` as the `Resul` is `OK`\n   */\n  isErr(): this is Err<TValue, TError> {\n    return false\n  }\n\n  /**\n   * Runs the `handler` method an return the same an unaltered copy of the `Result`. It could be used to log an\n   * output when the result is `Ok` without breaking the flow\n   *\n   * @param handler - method to be run when the result is `Ok`\n   * @returns a copy of the same `Result`\n   */\n  doOnOk(handler: (value: TValue) => void): Result<TValue, TError> {\n    handler(this.value)\n    return ok(this.value)\n  }\n\n  /**\n   * A safe mode to get the `value` of the `Result`\n   *\n   * @returns the `value` of the `Result`\n   */\n  valueOrThrow(): TValue {\n    return this.value\n  }\n\n  /**\n   * Maps the value to another one with a different type. It leaves the `Error` type unaltered\n   *\n   * @param mapper - The mapper method to apply an `OK` value\n   * @returns a new result with the new mapped value\n   */\n  map<TMappedValue>(mapper: (value: TValue) => TMappedValue): Result<TMappedValue, TError> {\n    return ok(mapper(this.value))\n  }\n\n  /**\n   * Maps the error type to another one. It leaves the `Ok` type and value unaltered\n   *\n   * @param _mapper - This mapper method is not used for an `Ok` value\n   * @returns a new result with the new mapped error type and an value\n   */\n  mapError<TMappedError>(_mapper: (error: TError) => TMappedError): Result<TValue, TMappedError> {\n    return ok(this.value)\n  }\n}\n\nexport class Err<TValue, TError> {\n  constructor(readonly error: TError) {}\n\n  /**\n   * Check if a `Result` is an `Err` inferring its type. `!isErr()` should be used before accessing the `value`\n   *\n   * @returns `false` as the `Resul` is `OK`\n   */\n  isErr(): this is Err<TValue, TError> {\n    return true\n  }\n\n  /**\n   * Return an unaltered copy of the `Error` without doing anything.\n   *\n   * @param _handler - This handler method is not used for an `Error`\n   * @returns a copy of the same `Error`\n   */\n  doOnOk(_handler: (value: TValue) => void): Result<TValue, TError> {\n    return err(this.error)\n  }\n\n  /**\n   * A safe mode to throw the `error` of the `Result`\n   */\n  valueOrThrow(): TValue {\n    throw this.error\n  }\n\n  /**\n   * Maps the value type to another one. It leaves the `Error` unaltered\n   *\n   * @param _mapper - This mapper method is not used for an `Error` value\n   * @returns a new result with the new value type and an unaltered error\n   */\n  map<TMappedValue>(_mapper: (valueOrThrow: TValue) => TMappedValue): Result<TMappedValue, TError> {\n    return err(this.error)\n  }\n\n  /**\n   * Maps the error to another one with a different type. It leaves the value type unaltered\n   *\n   * @param mapper - The mapper method to apply an `Error` value\n   * @returns a new result with the new mapped error\n   */\n  mapError<TMappedError>(mapper: (error: TError) => TMappedError): Result<TValue, TMappedError> {\n    return err(mapper(this.error))\n  }\n}\n"]}

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

@@ -0,0 +1,4 @@
+export { Fatal as FatalError } from '../../error.js';
+export { Abort as AbortError } from '../../error.js';
+export { Bug as BugError } from '../../error.js';
+export { AbortSilent as AbortSilentError } from '../../error.js';

package/dist/public/node/error.js

@@ -0,0 +1,5 @@
+export { Fatal as FatalError } from '../../error.js';
+export { Abort as AbortError } from '../../error.js';
+export { Bug as BugError } from '../../error.js';
+export { AbortSilent as AbortSilentError } from '../../error.js';
+//# sourceMappingURL=error.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/public/node/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,IAAI,UAAU,EAAC,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAC,KAAK,IAAI,UAAU,EAAC,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAC,GAAG,IAAI,QAAQ,EAAC,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAC,WAAW,IAAI,gBAAgB,EAAC,MAAM,gBAAgB,CAAA","sourcesContent":["export {Fatal as FatalError} from '../../error.js'\nexport {Abort as AbortError} from '../../error.js'\nexport {Bug as BugError} from '../../error.js'\nexport {AbortSilent as AbortSilentError} from '../../error.js'\n"]}

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

@@ -35,12 +35,12 @@ declare type RenderAlertOptions = Omit<AlertProps, 'type'>;
  * │  Body                                                    │
  * │                                                          │
  * │  Next steps                                              │
- * │    • Run cd santorini-goods                              │
- * │    • To preview your project, run npm app dev            │
- * │    • To add extensions, run npm generate extension       │
+ * │    • Run `cd santorini-goods`                            │
+ * │    • To preview your project, run `npm app dev`          │
+ * │    • To add extensions, run `npm generate extension`     │
  * │                                                          │
  * │  Reference                                               │
- * │    • Run npm shopify help                                │
+ * │    • Run `npm shopify help`                              │
  * │    • Press 'return' to open the dev docs:                │
  * │      https://shopify.dev                                 │
  * │                                                          │
@@ -72,12 +72,12 @@ export declare function renderInfo(options: RenderAlertOptions): void;
  * │  Body                                                    │
  * │                                                          │
  * │  Next steps                                              │
- * │    • Run cd santorini-goods                              │
- * │    • To preview your project, run npm app dev            │
- * │    • To add extensions, run npm generate extension       │
+ * │    • Run `cd santorini-goods`                              │
+ * │    • To preview your project, run `npm app dev`            │
+ * │    • To add extensions, run `npm generate extension`       │
  * │                                                          │
  * │  Reference                                               │
- * │    • Run npm shopify help                                │
+ * │    • Run `npm shopify help`                                │
  * │    • Press 'return' to open the dev docs:                │
  * │      https://shopify.dev                                 │
  * │                                                          │
@@ -109,12 +109,12 @@ export declare function renderSuccess(options: RenderAlertOptions): void;
  * │  Body                                                    │
  * │                                                          │
  * │  Next steps                                              │
- * │    • Run cd santorini-goods                              │
- * │    • To preview your project, run npm app dev            │
- * │    • To add extensions, run npm generate extension       │
+ * │    • Run `cd santorini-goods`                            │
+ * │    • To preview your project, run `npm app dev`          │
+ * │    • To add extensions, run `npm generate extension`     │
  * │                                                          │
  * │  Reference                                               │
- * │    • Run npm shopify help                                │
+ * │    • Run `npm shopify help`                              │
  * │    • Press 'return' to open the dev docs:                │
  * │      https://shopify.dev                                 │
  * │                                                          │