@shopify/cli-kit 3.53.0 → 3.54.0

package/assets/cli-ruby/lib/shopify_cli/theme/dev_server/proxy.rb

@@ -49,6 +49,7 @@ module ShopifyCLI
           return [204, {}, []] if IGNORED_ENDPOINTS.any? { |endpoint| env["PATH_INFO"].include?(endpoint) }
 
           headers = extract_http_request_headers(env)
+          is_chrome = headers["User-Agent"] =~ /[Cc]hrome/
           headers["Host"] = shop
           headers["Cookie"] = add_session_cookie(headers["Cookie"])
           headers["Accept-Encoding"] = "none"
@@ -76,6 +77,7 @@ module ShopifyCLI
           end
 
           headers = get_response_headers(response, env)
+          headers = modify_headers(headers) unless is_chrome
 
           unless headers["x-storefront-renderer-rendered"]
             @core_endpoints << env["PATH_INFO"]
@@ -268,6 +270,18 @@ module ShopifyCLI
 
           true
         end
+
+        def modify_headers(headers)
+          if headers["set-cookie"]&.include?("storefront_digest")
+            headers["set-cookie"] = modify_set_cookie_header_for_safari(headers["set-cookie"])
+          end
+
+          headers
+        end
+
+        def modify_set_cookie_header_for_safari(set_cookie_header)
+          set_cookie_header.gsub("secure;", "secure: false;")
+        end
       end
     end
   end

package/dist/private/node/analytics.js

@@ -47,9 +47,7 @@ export async function getSensitiveEnvironmentData(config) {
     };
 }
 function getPluginNames(config) {
-    return config.plugins
-        .map((plugin) => plugin.name)
-        .sort()
-        .filter((plugin) => !plugin.startsWith('@oclif/'));
+    const pluginNames = [...config.plugins.keys()];
+    return pluginNames.sort().filter((plugin) => !plugin.startsWith('@oclif/'));
 }
 //# sourceMappingURL=analytics.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/private/node/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAC,iBAAiB,EAAE,2BAA2B,EAAC,MAAM,2CAA2C,CAAA;AAGxG,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAA;AACzD,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AAEvD,OAAO,EAAC,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAC,MAAM,qCAAqC,CAAA;AAC5F,OAAO,EAAC,GAAG,EAAC,MAAM,4BAA4B,CAAA;AAS9C,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,cAAc,EACd,IAAI,EACJ,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAClC,YAAY,GACC;IACb,IAAI,YAAY,GAAW,cAAc,CAAC,OAAO,CAAA;IACjD,IAAI,YAAY,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,EAAE;QAC/F,YAAY,GAAI,YAAmC,CAAC,qBAAqB,EAAE,IAAI,cAAc,CAAC,OAAO,CAAA;KACtG;IAED,MAAM,QAAQ,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAC,CAAC;QACzC,mBAAmB,EAAE;YACnB,SAAS,EAAE,WAAW;YACtB,YAAY;YACZ,SAAS,EAAE,IAAI;SAChB;KACF,CAAC,CAAC,CAAA;IAEH,MAAM,QAAQ,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC;QACtC,gBAAgB,EAAE,2BAA2B,EAAE;QAC/C,kBAAkB,EAAE,cAAc,CAAC,KAAK;QACxC,aAAa,EAAE,cAAc,CAAC,KAAK;QACnC,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI;KAC3C,CAAC,CAAC,CAAA;AACL,CAAC;AAeD,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAyB;IAChE,MAAM,UAAU,GAAG,UAAU,EAAE,CAAA;IAE/B,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;IAErF,MAAM,EAAC,QAAQ,EAAE,IAAI,EAAC,GAAG,eAAe,EAAE,CAAA;IAE1C,OAAO;QACL,KAAK,EAAE,GAAG,QAAQ,IAAI,IAAI,EAAE;QAC5B,MAAM,EAAE,UAAU,CAAC,IAAI;QACvB,eAAe,EAAE,UAAU,CAAC,IAAI;QAChC,+BAA+B,EAAE,WAAW,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;QAC7E,4BAA4B,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;QAC5D,SAAS,EAAE,MAAM,CAAC,KAAK;QACvB,WAAW,EAAE,gBAAgB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;QAChF,aAAa,EAAE,UAAU,CAAC,MAAM,UAAU,EAAE,CAAC;QAC7C,SAAS,EAAE,gBAAgB,EAAE,CAAC,QAAQ;QACtC,mBAAmB,EAAE,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC;KACpD,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,MAAyB;IACzE,OAAO;QACL,wBAAwB,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;KACjE,CAAA;AACH,CAAC;AAED,SAAS,cAAc,CAAC,MAAyB;IAC/C,OAAO,MAAM,CAAC,OAAO;SAClB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;SAC5B,IAAI,EAAE;SACN,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;AACtD,CAAC","sourcesContent":["import {hashString} from '../../public/node/crypto.js'\nimport {getPackageManager, packageManagerFromUserAgent} from '../../public/node/node-package-manager.js'\nimport BaseCommand from '../../public/node/base-command.js'\nimport {CommandContent} from '../../public/node/hooks/prerun.js'\nimport * as metadata from '../../public/node/metadata.js'\nimport {platformAndArch} from '../../public/node/os.js'\nimport {Command, Interfaces} from '@oclif/core'\nimport {ciPlatform, cloudEnvironment, macAddress} from '@shopify/cli-kit/node/context/local'\nimport {cwd} from '@shopify/cli-kit/node/path'\n\ninterface StartOptions {\n  commandContent: CommandContent\n  args: string[]\n  currentTime?: number\n  commandClass?: Command.Class | typeof BaseCommand\n}\n\nexport async function startAnalytics({\n  commandContent,\n  args,\n  currentTime = new Date().getTime(),\n  commandClass,\n}: StartOptions): Promise<void> {\n  let startCommand: string = commandContent.command\n  if (commandClass && Object.prototype.hasOwnProperty.call(commandClass, 'analyticsNameOverride')) {\n    startCommand = (commandClass as typeof BaseCommand).analyticsNameOverride() ?? commandContent.command\n  }\n\n  await metadata.addSensitiveMetadata(() => ({\n    commandStartOptions: {\n      startTime: currentTime,\n      startCommand,\n      startArgs: args,\n    },\n  }))\n\n  await metadata.addPublicMetadata(() => ({\n    cmd_all_launcher: packageManagerFromUserAgent(),\n    cmd_all_alias_used: commandContent.alias,\n    cmd_all_topic: commandContent.topic,\n    cmd_all_plugin: commandClass?.plugin?.name,\n  }))\n}\n\ninterface EnvironmentData {\n  uname: string\n  env_ci: boolean\n  env_ci_platform?: string\n  env_plugin_installed_any_custom: boolean\n  env_plugin_installed_shopify: string\n  env_shell: string\n  env_web_ide: string | undefined\n  env_device_id: string\n  env_cloud: string\n  env_package_manager: string\n}\n\nexport async function getEnvironmentData(config: Interfaces.Config): Promise<EnvironmentData> {\n  const ciplatform = ciPlatform()\n\n  const pluginNames = getPluginNames(config)\n  const shopifyPlugins = pluginNames.filter((plugin) => plugin.startsWith('@shopify/'))\n\n  const {platform, arch} = platformAndArch()\n\n  return {\n    uname: `${platform} ${arch}`,\n    env_ci: ciplatform.isCI,\n    env_ci_platform: ciplatform.name,\n    env_plugin_installed_any_custom: pluginNames.length !== shopifyPlugins.length,\n    env_plugin_installed_shopify: JSON.stringify(shopifyPlugins),\n    env_shell: config.shell,\n    env_web_ide: cloudEnvironment().editor ? cloudEnvironment().platform : undefined,\n    env_device_id: hashString(await macAddress()),\n    env_cloud: cloudEnvironment().platform,\n    env_package_manager: await getPackageManager(cwd()),\n  }\n}\n\nexport async function getSensitiveEnvironmentData(config: Interfaces.Config) {\n  return {\n    env_plugin_installed_all: JSON.stringify(getPluginNames(config)),\n  }\n}\n\nfunction getPluginNames(config: Interfaces.Config) {\n  return config.plugins\n    .map((plugin) => plugin.name)\n    .sort()\n    .filter((plugin) => !plugin.startsWith('@oclif/'))\n}\n"]}
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/private/node/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAC,iBAAiB,EAAE,2BAA2B,EAAC,MAAM,2CAA2C,CAAA;AAGxG,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAA;AACzD,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AAEvD,OAAO,EAAC,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAC,MAAM,qCAAqC,CAAA;AAC5F,OAAO,EAAC,GAAG,EAAC,MAAM,4BAA4B,CAAA;AAS9C,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,cAAc,EACd,IAAI,EACJ,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAClC,YAAY,GACC;IACb,IAAI,YAAY,GAAW,cAAc,CAAC,OAAO,CAAA;IACjD,IAAI,YAAY,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,EAAE;QAC/F,YAAY,GAAI,YAAmC,CAAC,qBAAqB,EAAE,IAAI,cAAc,CAAC,OAAO,CAAA;KACtG;IAED,MAAM,QAAQ,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAC,CAAC;QACzC,mBAAmB,EAAE;YACnB,SAAS,EAAE,WAAW;YACtB,YAAY;YACZ,SAAS,EAAE,IAAI;SAChB;KACF,CAAC,CAAC,CAAA;IAEH,MAAM,QAAQ,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC;QACtC,gBAAgB,EAAE,2BAA2B,EAAE;QAC/C,kBAAkB,EAAE,cAAc,CAAC,KAAK;QACxC,aAAa,EAAE,cAAc,CAAC,KAAK;QACnC,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI;KAC3C,CAAC,CAAC,CAAA;AACL,CAAC;AAeD,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAyB;IAChE,MAAM,UAAU,GAAG,UAAU,EAAE,CAAA;IAE/B,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;IAErF,MAAM,EAAC,QAAQ,EAAE,IAAI,EAAC,GAAG,eAAe,EAAE,CAAA;IAE1C,OAAO;QACL,KAAK,EAAE,GAAG,QAAQ,IAAI,IAAI,EAAE;QAC5B,MAAM,EAAE,UAAU,CAAC,IAAI;QACvB,eAAe,EAAE,UAAU,CAAC,IAAI;QAChC,+BAA+B,EAAE,WAAW,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;QAC7E,4BAA4B,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;QAC5D,SAAS,EAAE,MAAM,CAAC,KAAK;QACvB,WAAW,EAAE,gBAAgB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;QAChF,aAAa,EAAE,UAAU,CAAC,MAAM,UAAU,EAAE,CAAC;QAC7C,SAAS,EAAE,gBAAgB,EAAE,CAAC,QAAQ;QACtC,mBAAmB,EAAE,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC;KACpD,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,MAAyB;IACzE,OAAO;QACL,wBAAwB,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;KACjE,CAAA;AACH,CAAC;AAED,SAAS,cAAc,CAAC,MAAyB;IAC/C,MAAM,WAAW,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IAC9C,OAAO,WAAW,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;AAC7E,CAAC","sourcesContent":["import {hashString} from '../../public/node/crypto.js'\nimport {getPackageManager, packageManagerFromUserAgent} from '../../public/node/node-package-manager.js'\nimport BaseCommand from '../../public/node/base-command.js'\nimport {CommandContent} from '../../public/node/hooks/prerun.js'\nimport * as metadata from '../../public/node/metadata.js'\nimport {platformAndArch} from '../../public/node/os.js'\nimport {Command, Interfaces} from '@oclif/core'\nimport {ciPlatform, cloudEnvironment, macAddress} from '@shopify/cli-kit/node/context/local'\nimport {cwd} from '@shopify/cli-kit/node/path'\n\ninterface StartOptions {\n  commandContent: CommandContent\n  args: string[]\n  currentTime?: number\n  commandClass?: Command.Class | typeof BaseCommand\n}\n\nexport async function startAnalytics({\n  commandContent,\n  args,\n  currentTime = new Date().getTime(),\n  commandClass,\n}: StartOptions): Promise<void> {\n  let startCommand: string = commandContent.command\n  if (commandClass && Object.prototype.hasOwnProperty.call(commandClass, 'analyticsNameOverride')) {\n    startCommand = (commandClass as typeof BaseCommand).analyticsNameOverride() ?? commandContent.command\n  }\n\n  await metadata.addSensitiveMetadata(() => ({\n    commandStartOptions: {\n      startTime: currentTime,\n      startCommand,\n      startArgs: args,\n    },\n  }))\n\n  await metadata.addPublicMetadata(() => ({\n    cmd_all_launcher: packageManagerFromUserAgent(),\n    cmd_all_alias_used: commandContent.alias,\n    cmd_all_topic: commandContent.topic,\n    cmd_all_plugin: commandClass?.plugin?.name,\n  }))\n}\n\ninterface EnvironmentData {\n  uname: string\n  env_ci: boolean\n  env_ci_platform?: string\n  env_plugin_installed_any_custom: boolean\n  env_plugin_installed_shopify: string\n  env_shell: string\n  env_web_ide: string | undefined\n  env_device_id: string\n  env_cloud: string\n  env_package_manager: string\n}\n\nexport async function getEnvironmentData(config: Interfaces.Config): Promise<EnvironmentData> {\n  const ciplatform = ciPlatform()\n\n  const pluginNames = getPluginNames(config)\n  const shopifyPlugins = pluginNames.filter((plugin) => plugin.startsWith('@shopify/'))\n\n  const {platform, arch} = platformAndArch()\n\n  return {\n    uname: `${platform} ${arch}`,\n    env_ci: ciplatform.isCI,\n    env_ci_platform: ciplatform.name,\n    env_plugin_installed_any_custom: pluginNames.length !== shopifyPlugins.length,\n    env_plugin_installed_shopify: JSON.stringify(shopifyPlugins),\n    env_shell: config.shell,\n    env_web_ide: cloudEnvironment().editor ? cloudEnvironment().platform : undefined,\n    env_device_id: hashString(await macAddress()),\n    env_cloud: cloudEnvironment().platform,\n    env_package_manager: await getPackageManager(cwd()),\n  }\n}\n\nexport async function getSensitiveEnvironmentData(config: Interfaces.Config) {\n  return {\n    env_plugin_installed_all: JSON.stringify(getPluginNames(config)),\n  }\n}\n\nfunction getPluginNames(config: Interfaces.Config) {\n  const pluginNames = [...config.plugins.keys()]\n  return pluginNames.sort().filter((plugin) => !plugin.startsWith('@oclif/'))\n}\n"]}

package/dist/private/node/ui/components/List.d.ts

@@ -1,9 +1,16 @@
 import { InlineToken, TokenItem } from './TokenizedText.js';
 import { TextProps } from 'ink';
 import { FunctionComponent } from 'react';
+export interface CustomListItem {
+    type?: string;
+    item: TokenItem<InlineToken>;
+    bullet?: string;
+    color?: TextProps['color'];
+}
+type ListItem = TokenItem<InlineToken> | CustomListItem;
 interface ListProps {
     title?: TokenItem<InlineToken>;
-    items: TokenItem<InlineToken>[];
+    items: ListItem[];
     ordered?: boolean;
     margin?: boolean;
     color?: TextProps['color'];

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

@@ -7,14 +7,35 @@ const DOT = '•';
  * and wrapped to the container width.
  */
 const List = ({ title, items, margin = true, ordered = false, color, bullet = DOT, }) => {
-    return (React.createElement(Box, { flexDirection: "column" },
-        title ? (React.createElement(Text, { color: color },
-            React.createElement(TokenizedText, { item: title }))) : null,
-        items.map((item, index) => (React.createElement(Box, { key: index, marginLeft: margin ? 2 : 0 },
+    function isCustomListItem(item) {
+        return item.item !== undefined;
+    }
+    function resolveListItem(item, index) {
+        const resolvedItem = {
+            index,
+            color,
+            bullet,
+            ordered,
+            item: item,
+        };
+        return isCustomListItem(item)
+            ? {
+                ...resolvedItem,
+                ...item,
+            }
+            : resolvedItem;
+    }
+    const ListItem = ({ item, color, bullet, index, ordered }) => {
+        return (React.createElement(Box, { key: index, marginLeft: margin ? 2 : 0 },
             React.createElement(Text, { color: color }, `${ordered ? `${index + 1}.` : bullet}`),
             React.createElement(Box, { flexGrow: 1, marginLeft: 1 },
                 React.createElement(Text, { color: color },
-                    React.createElement(TokenizedText, { item: item }))))))));
+                    React.createElement(TokenizedText, { item: item })))));
+    };
+    return (React.createElement(Box, { flexDirection: "column" },
+        title ? (React.createElement(Text, { color: color },
+            React.createElement(TokenizedText, { item: title }))) : null,
+        items.map(resolveListItem).map(({ index, item, color, bullet, ordered }) => (React.createElement(ListItem, { key: index, item: item, color: color, bullet: bullet, index: index, ordered: ordered })))));
 };
 export { List };
 //# sourceMappingURL=List.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/List.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAyB,aAAa,EAAC,MAAM,oBAAoB,CAAA;AACxE,OAAO,EAAC,GAAG,EAAE,IAAI,EAAY,MAAM,KAAK,CAAA;AACxC,OAAO,KAA0B,MAAM,OAAO,CAAA;AAW9C,MAAM,GAAG,GAAG,GAAG,CAAA;AAEf;;;GAGG;AACH,MAAM,IAAI,GAAiC,CAAC,EAC1C,KAAK,EACL,KAAK,EACL,MAAM,GAAG,IAAI,EACb,OAAO,GAAG,KAAK,EACf,KAAK,EACL,MAAM,GAAG,GAAG,GACb,EAAe,EAAE;IAChB,OAAO,CACL,oBAAC,GAAG,IAAC,aAAa,EAAC,QAAQ;QACxB,KAAK,CAAC,CAAC,CAAC,CACP,oBAAC,IAAI,IAAC,KAAK,EAAE,KAAK;YAChB,oBAAC,aAAa,IAAC,IAAI,EAAE,KAAK,GAAI,CACzB,CACR,CAAC,CAAC,CAAC,IAAI;QACP,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAC1B,oBAAC,GAAG,IAAC,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,oBAAC,IAAI,IAAC,KAAK,EAAE,KAAK,IAAG,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAQ;YAEpE,oBAAC,GAAG,IAAC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;gBAC7B,oBAAC,IAAI,IAAC,KAAK,EAAE,KAAK;oBAChB,oBAAC,aAAa,IAAC,IAAI,EAAE,IAAI,GAAI,CACxB,CACH,CACF,CACP,CAAC,CACE,CACP,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAC,IAAI,EAAC,CAAA","sourcesContent":["import {InlineToken, TokenItem, TokenizedText} from './TokenizedText.js'\nimport {Box, Text, TextProps} from 'ink'\nimport React, {FunctionComponent} from 'react'\n\ninterface ListProps {\n  title?: TokenItem<InlineToken>\n  items: TokenItem<InlineToken>[]\n  ordered?: boolean\n  margin?: boolean\n  color?: TextProps['color']\n  bullet?: string\n}\n\nconst DOT = '•'\n\n/**\n * `List` displays an unordered or ordered list with text aligned with the bullet point\n * and wrapped to the container width.\n */\nconst List: FunctionComponent<ListProps> = ({\n  title,\n  items,\n  margin = true,\n  ordered = false,\n  color,\n  bullet = DOT,\n}): JSX.Element => {\n  return (\n    <Box flexDirection=\"column\">\n      {title ? (\n        <Text color={color}>\n          <TokenizedText item={title} />\n        </Text>\n      ) : null}\n      {items.map((item, index) => (\n        <Box key={index} marginLeft={margin ? 2 : 0}>\n          <Text color={color}>{`${ordered ? `${index + 1}.` : bullet}`}</Text>\n\n          <Box flexGrow={1} marginLeft={1}>\n            <Text color={color}>\n              <TokenizedText item={item} />\n            </Text>\n          </Box>\n        </Box>\n      ))}\n    </Box>\n  )\n}\n\nexport {List}\n"]}
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/List.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAyB,aAAa,EAAC,MAAM,oBAAoB,CAAA;AACxE,OAAO,EAAC,GAAG,EAAE,IAAI,EAAY,MAAM,KAAK,CAAA;AACxC,OAAO,KAA0B,MAAM,OAAO,CAAA;AAoB9C,MAAM,GAAG,GAAG,GAAG,CAAA;AAEf;;;GAGG;AACH,MAAM,IAAI,GAAiC,CAAC,EAC1C,KAAK,EACL,KAAK,EACL,MAAM,GAAG,IAAI,EACb,OAAO,GAAG,KAAK,EACf,KAAK,EACL,MAAM,GAAG,GAAG,GACb,EAAe,EAAE;IAChB,SAAS,gBAAgB,CAAC,IAA6C;QACrE,OAAQ,IAAuB,CAAC,IAAI,KAAK,SAAS,CAAA;IACpD,CAAC;IAED,SAAS,eAAe,CAAC,IAAc,EAAE,KAAa;QACpD,MAAM,YAAY,GAAG;YACnB,KAAK;YACL,KAAK;YACL,MAAM;YACN,OAAO;YACP,IAAI,EAAE,IAA8B;SACrC,CAAA;QACD,OAAO,gBAAgB,CAAC,IAAI,CAAC;YAC3B,CAAC,CAAC;gBACE,GAAG,YAAY;gBACf,GAAG,IAAI;aACR;YACH,CAAC,CAAC,YAAY,CAAA;IAClB,CAAC;IAUD,MAAM,QAAQ,GAAqC,CAAC,EAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAC,EAAE,EAAE;QAC3F,OAAO,CACL,oBAAC,GAAG,IAAC,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,oBAAC,IAAI,IAAC,KAAK,EAAE,KAAK,IAAG,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAQ;YAEpE,oBAAC,GAAG,IAAC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;gBAC7B,oBAAC,IAAI,IAAC,KAAK,EAAE,KAAK;oBAChB,oBAAC,aAAa,IAAC,IAAI,EAAE,IAAI,GAAI,CACxB,CACH,CACF,CACP,CAAA;IACH,CAAC,CAAA;IAED,OAAO,CACL,oBAAC,GAAG,IAAC,aAAa,EAAC,QAAQ;QACxB,KAAK,CAAC,CAAC,CAAC,CACP,oBAAC,IAAI,IAAC,KAAK,EAAE,KAAK;YAChB,oBAAC,aAAa,IAAC,IAAI,EAAE,KAAK,GAAI,CACzB,CACR,CAAC,CAAC,CAAC,IAAI;QACP,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,EAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAC,EAAE,EAAE,CAAC,CACzE,oBAAC,QAAQ,IAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,GAAI,CACnG,CAAC,CACE,CACP,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAC,IAAI,EAAC,CAAA","sourcesContent":["import {InlineToken, TokenItem, TokenizedText} from './TokenizedText.js'\nimport {Box, Text, TextProps} from 'ink'\nimport React, {FunctionComponent} from 'react'\n\nexport interface CustomListItem {\n  type?: string\n  item: TokenItem<InlineToken>\n  bullet?: string\n  color?: TextProps['color']\n}\n\ntype ListItem = TokenItem<InlineToken> | CustomListItem\n\ninterface ListProps {\n  title?: TokenItem<InlineToken>\n  items: ListItem[]\n  ordered?: boolean\n  margin?: boolean\n  color?: TextProps['color']\n  bullet?: string\n}\n\nconst DOT = '•'\n\n/**\n * `List` displays an unordered or ordered list with text aligned with the bullet point\n * and wrapped to the container width.\n */\nconst List: FunctionComponent<ListProps> = ({\n  title,\n  items,\n  margin = true,\n  ordered = false,\n  color,\n  bullet = DOT,\n}): JSX.Element => {\n  function isCustomListItem(item: TokenItem<InlineToken> | CustomListItem): item is CustomListItem {\n    return (item as CustomListItem).item !== undefined\n  }\n\n  function resolveListItem(item: ListItem, index: number) {\n    const resolvedItem = {\n      index,\n      color,\n      bullet,\n      ordered,\n      item: item as TokenItem<InlineToken>,\n    }\n    return isCustomListItem(item)\n      ? {\n          ...resolvedItem,\n          ...item,\n        }\n      : resolvedItem\n  }\n\n  interface ListItemProps {\n    item: TokenItem<InlineToken>\n    color: TextProps['color']\n    bullet: string\n    index: number\n    ordered: boolean\n  }\n\n  const ListItem: FunctionComponent<ListItemProps> = ({item, color, bullet, index, ordered}) => {\n    return (\n      <Box key={index} marginLeft={margin ? 2 : 0}>\n        <Text color={color}>{`${ordered ? `${index + 1}.` : bullet}`}</Text>\n\n        <Box flexGrow={1} marginLeft={1}>\n          <Text color={color}>\n            <TokenizedText item={item} />\n          </Text>\n        </Box>\n      </Box>\n    )\n  }\n\n  return (\n    <Box flexDirection=\"column\">\n      {title ? (\n        <Text color={color}>\n          <TokenizedText item={title} />\n        </Text>\n      ) : null}\n      {items.map(resolveListItem).map(({index, item, color, bullet, ordered}) => (\n        <ListItem key={index} item={item} color={color} bullet={bullet} index={index} ordered={ordered} />\n      ))}\n    </Box>\n  )\n}\n\nexport {List}\n"]}

package/dist/private/node/ui/components/List.test.js

@@ -81,5 +81,22 @@ describe('List', async () => {
         • Item 3"
     `);
     });
+    test('renders custom items', async () => {
+        const options = {
+            items: [
+                { bullet: '-', color: 'red', item: 'Custom Item 1' },
+                'Item 1',
+                { bullet: '_', color: 'green', item: 'Custom Item 2' },
+            ],
+            bullet: '*',
+            color: 'gray',
+        };
+        const { lastFrame } = render(React.createElement(List, { ...options }));
+        expect(lastFrame()).toMatchInlineSnapshot(`
+      "  - Custom Item 1
+        * Item 1
+        _ Custom Item 2"
+    `);
+    });
 });
 //# sourceMappingURL=List.test.js.map

package/dist/private/node/ui/components/List.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"List.test.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/List.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAC,QAAQ,EAAC,MAAM,mCAAmC,CAAA;AAC1D,OAAO,EAAC,MAAM,EAAC,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;IAC1B,IAAI,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,KAAK;SACf,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;KAKpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,MAAM,EAAE,IAAI;SACb,CAAA;QAED,MAAM,EAAC,SAAS,EAAE,eAAe,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAElE,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;KAI1D,CAAC,CAAA;QAEF,MAAM,EAAC,SAAS,EAAE,iBAAiB,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,EAAE,MAAM,EAAE,KAAK,GAAI,CAAC,CAAA;QAEnF,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;KAI5D,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,KAAK,EAAE,KAAK;SACb,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,qBAAqB,CAAC;;;;;KAKzC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,IAAI;SACd,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;KAIpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,OAAO,GAAG;YACd,KAAK,EAAE;gBACL,YAAY;gBACZ;oBACE,IAAI,EAAE,SAAS;iBAChB;aACF;YACD,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,KAAK;SACf,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,qBAAqB,CAAC;;;;;KAKzC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {List} from './List.js'\nimport {unstyled} from '../../../../public/node/output.js'\nimport {render} from '../../testing/ui.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('List', async () => {\n  test('renders unordered items', async () => {\n    const options = {\n      title: 'List title',\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: false,\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"List title\n        • Item 1\n        • Item 2\n        • Item 3\"\n    `)\n  })\n\n  test('renders items with margin or not', async () => {\n    const options = {\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      margin: true,\n    }\n\n    const {lastFrame: marginLastFrame} = render(<List {...options} />)\n\n    expect(unstyled(marginLastFrame()!)).toMatchInlineSnapshot(`\n      \"  • Item 1\n        • Item 2\n        • Item 3\"\n    `)\n\n    const {lastFrame: noMarginLastFrame} = render(<List {...options} margin={false} />)\n\n    expect(unstyled(noMarginLastFrame()!)).toMatchInlineSnapshot(`\n      \"• Item 1\n      • Item 2\n      • Item 3\"\n    `)\n  })\n\n  test('can give the text a color', async () => {\n    const options = {\n      title: 'List title',\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      color: 'red',\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(lastFrame()).toMatchInlineSnapshot(`\n      \"\u001b[31mList title\u001b[39m\n        \u001b[31m•\u001b[39m \u001b[31mItem 1\u001b[39m\n        \u001b[31m•\u001b[39m \u001b[31mItem 2\u001b[39m\n        \u001b[31m•\u001b[39m \u001b[31mItem 3\u001b[39m\"\n    `)\n  })\n\n  test('renders ordered items', async () => {\n    const options = {\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: true,\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"  1. Item 1\n        2. Item 2\n        3. Item 3\"\n    `)\n  })\n\n  test('title can be made of tokens', async () => {\n    const options = {\n      title: [\n        'List title',\n        {\n          bold: ' (bold)',\n        },\n      ],\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: false,\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(lastFrame()).toMatchInlineSnapshot(`\n      \"List title \u001b[1m (bold)\u001b[22m\n        • Item 1\n        • Item 2\n        • Item 3\"\n    `)\n  })\n})\n"]}
+{"version":3,"file":"List.test.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/List.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAC,QAAQ,EAAC,MAAM,mCAAmC,CAAA;AAC1D,OAAO,EAAC,MAAM,EAAC,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;IAC1B,IAAI,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,KAAK;SACf,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;KAKpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,MAAM,EAAE,IAAI;SACb,CAAA;QAED,MAAM,EAAC,SAAS,EAAE,eAAe,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAElE,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;KAI1D,CAAC,CAAA;QAEF,MAAM,EAAC,SAAS,EAAE,iBAAiB,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,EAAE,MAAM,EAAE,KAAK,GAAI,CAAC,CAAA;QAEnF,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;KAI5D,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,KAAK,EAAE,KAAK;SACb,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,qBAAqB,CAAC;;;;;KAKzC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,IAAI;SACd,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;KAIpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,OAAO,GAAG;YACd,KAAK,EAAE;gBACL,YAAY;gBACZ;oBACE,IAAI,EAAE,SAAS;iBAChB;aACF;YACD,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,KAAK;SACf,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,qBAAqB,CAAC;;;;;KAKzC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE;gBACL,EAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAC;gBAClD,QAAQ;gBACR,EAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAC;aACrD;YACD,MAAM,EAAE,GAAG;YACX,KAAK,EAAE,MAAM;SACd,CAAA;QAED,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,SAAS,EAAG,CAAC,CAAC,qBAAqB,CAAC;;;;KAI1C,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {List} from './List.js'\nimport {unstyled} from '../../../../public/node/output.js'\nimport {render} from '../../testing/ui.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('List', async () => {\n  test('renders unordered items', async () => {\n    const options = {\n      title: 'List title',\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: false,\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"List title\n        • Item 1\n        • Item 2\n        • Item 3\"\n    `)\n  })\n\n  test('renders items with margin or not', async () => {\n    const options = {\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      margin: true,\n    }\n\n    const {lastFrame: marginLastFrame} = render(<List {...options} />)\n\n    expect(unstyled(marginLastFrame()!)).toMatchInlineSnapshot(`\n      \"  • Item 1\n        • Item 2\n        • Item 3\"\n    `)\n\n    const {lastFrame: noMarginLastFrame} = render(<List {...options} margin={false} />)\n\n    expect(unstyled(noMarginLastFrame()!)).toMatchInlineSnapshot(`\n      \"• Item 1\n      • Item 2\n      • Item 3\"\n    `)\n  })\n\n  test('can give the text a color', async () => {\n    const options = {\n      title: 'List title',\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      color: 'red',\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(lastFrame()).toMatchInlineSnapshot(`\n      \"\u001b[31mList title\u001b[39m\n        \u001b[31m•\u001b[39m \u001b[31mItem 1\u001b[39m\n        \u001b[31m•\u001b[39m \u001b[31mItem 2\u001b[39m\n        \u001b[31m•\u001b[39m \u001b[31mItem 3\u001b[39m\"\n    `)\n  })\n\n  test('renders ordered items', async () => {\n    const options = {\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: true,\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"  1. Item 1\n        2. Item 2\n        3. Item 3\"\n    `)\n  })\n\n  test('title can be made of tokens', async () => {\n    const options = {\n      title: [\n        'List title',\n        {\n          bold: ' (bold)',\n        },\n      ],\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: false,\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(lastFrame()).toMatchInlineSnapshot(`\n      \"List title \u001b[1m (bold)\u001b[22m\n        • Item 1\n        • Item 2\n        • Item 3\"\n    `)\n  })\n\n  test('renders custom items', async () => {\n    const options = {\n      items: [\n        {bullet: '-', color: 'red', item: 'Custom Item 1'},\n        'Item 1',\n        {bullet: '_', color: 'green', item: 'Custom Item 2'},\n      ],\n      bullet: '*',\n      color: 'gray',\n    }\n\n    const {lastFrame} = render(<List {...options} />)\n\n    expect(lastFrame()!).toMatchInlineSnapshot(`\n      \"  \u001b[31m-\u001b[39m \u001b[31mCustom Item 1\u001b[39m\n        \u001b[90m*\u001b[39m \u001b[90mItem 1\u001b[39m\n        \u001b[32m_\u001b[39m \u001b[32mCustom Item 2\u001b[39m\"\n    `)\n  })\n})\n"]}

package/dist/private/node/ui/components/Prompts/InfoTable.d.ts

@@ -1,13 +1,15 @@
+import { CustomListItem } from '../List.js';
 import { InlineToken, TokenItem } from '../TokenizedText.js';
 import { TextProps } from 'ink';
 import { FunctionComponent } from 'react';
-type Items = TokenItem<InlineToken>[];
+type Items = (TokenItem<InlineToken> | CustomListItem)[];
 export interface InfoTableSection {
     color?: TextProps['color'];
     header: string;
     bullet?: string;
     helperText?: string;
     items: Items;
+    emptyItemsText?: string;
 }
 export interface InfoTableProps {
     table: {

package/dist/private/node/ui/components/Prompts/InfoTable.js

@@ -1,5 +1,6 @@
 import { List } from '../List.js';
 import { capitalize } from '../../../../../public/common/string.js';
+import { TokenizedText } from '../TokenizedText.js';
 import { Box, Text } from 'ink';
 import React from 'react';
 const InfoTable = ({ table }) => {
@@ -11,6 +12,7 @@ const InfoTable = ({ table }) => {
             color: undefined,
             helperText: undefined,
             bullet: undefined,
+            emptyItemsText: undefined,
         }));
     const headerColumnWidth = Math.max(...sections.map((section) => {
         return Math.max(...section.header.split('\n').map((line) => {
@@ -21,7 +23,8 @@ const InfoTable = ({ table }) => {
         section.header.length > 0 && (React.createElement(Box, { width: headerColumnWidth + 1 },
             React.createElement(Text, { color: section.color, bold: true }, capitalize(section.header)))),
         React.createElement(Box, { flexGrow: 1, flexDirection: "column", gap: 1 },
-            React.createElement(List, { margin: false, items: section.items, color: section.color, bullet: section.bullet }),
+            section.emptyItemsText && section.items.length === 0 ? (React.createElement(Text, { color: section.color },
+                React.createElement(TokenizedText, { item: { subdued: section.emptyItemsText } }))) : (React.createElement(List, { margin: false, items: section.items, color: section.color, bullet: section.bullet })),
             section.helperText ? React.createElement(Text, { color: section.color }, section.helperText) : null))))));
 };
 export { InfoTable };

package/dist/private/node/ui/components/Prompts/InfoTable.js.map

@@ -1 +1 @@
-{"version":3,"file":"InfoTable.js","sourceRoot":"","sources":["../../../../../../src/private/node/ui/components/Prompts/InfoTable.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,YAAY,CAAA;AAC/B,OAAO,EAAC,UAAU,EAAC,MAAM,wCAAwC,CAAA;AAEjE,OAAO,EAAC,GAAG,EAAE,IAAI,EAAY,MAAM,KAAK,CAAA;AACxC,OAAO,KAA0B,MAAM,OAAO,CAAA;AAoB9C,MAAM,SAAS,GAAsC,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE;IAC/D,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACnC,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAClC,MAAM;YACN,KAAK,EAAE,KAAK,CAAC,MAAM,CAAE;YACrB,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,SAAS;YACrB,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC,CAAA;IAEP,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAChC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAC1B,OAAO,IAAI,CAAC,GAAG,CACb,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC,CAAC,CACH,CAAA;IACH,CAAC,CAAC,CACH,CAAA;IAED,OAAO,CACL,oBAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,IACxB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAChC,oBAAC,GAAG,IAAC,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,aAAa,EAAC,QAAQ;QACzF,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAC5B,oBAAC,GAAG,IAAC,KAAK,EAAE,iBAAiB,GAAG,CAAC;YAC/B,oBAAC,IAAI,IAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,UAC7B,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CACtB,CACH,CACP;QACD,oBAAC,GAAG,IAAC,QAAQ,EAAE,CAAC,EAAE,aAAa,EAAC,QAAQ,EAAC,GAAG,EAAE,CAAC;YAC7C,oBAAC,IAAI,IAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,GAAI;YAC1F,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,oBAAC,IAAI,IAAC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAG,OAAO,CAAC,UAAU,CAAQ,CAAC,CAAC,CAAC,IAAI,CAChF,CACF,CACP,CAAC,CACE,CACP,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAC,SAAS,EAAC,CAAA","sourcesContent":["import {List} from '../List.js'\nimport {capitalize} from '../../../../../public/common/string.js'\nimport {InlineToken, TokenItem} from '../TokenizedText.js'\nimport {Box, Text, TextProps} from 'ink'\nimport React, {FunctionComponent} from 'react'\n\ntype Items = TokenItem<InlineToken>[]\n\nexport interface InfoTableSection {\n  color?: TextProps['color']\n  header: string\n  bullet?: string\n  helperText?: string\n  items: Items\n}\n\nexport interface InfoTableProps {\n  table:\n    | {\n        [header: string]: Items\n      }\n    | InfoTableSection[]\n}\n\nconst InfoTable: FunctionComponent<InfoTableProps> = ({table}) => {\n  const sections = Array.isArray(table)\n    ? table\n    : Object.keys(table).map((header) => ({\n        header,\n        items: table[header]!,\n        color: undefined,\n        helperText: undefined,\n        bullet: undefined,\n      }))\n\n  const headerColumnWidth = Math.max(\n    ...sections.map((section) => {\n      return Math.max(\n        ...section.header.split('\\n').map((line) => {\n          return line.length\n        }),\n      )\n    }),\n  )\n\n  return (\n    <Box flexDirection=\"column\">\n      {sections.map((section, index) => (\n        <Box key={index} marginBottom={index === sections.length - 1 ? 0 : 1} flexDirection=\"column\">\n          {section.header.length > 0 && (\n            <Box width={headerColumnWidth + 1}>\n              <Text color={section.color} bold>\n                {capitalize(section.header)}\n              </Text>\n            </Box>\n          )}\n          <Box flexGrow={1} flexDirection=\"column\" gap={1}>\n            <List margin={false} items={section.items} color={section.color} bullet={section.bullet} />\n            {section.helperText ? <Text color={section.color}>{section.helperText}</Text> : null}\n          </Box>\n        </Box>\n      ))}\n    </Box>\n  )\n}\n\nexport {InfoTable}\n"]}
+{"version":3,"file":"InfoTable.js","sourceRoot":"","sources":["../../../../../../src/private/node/ui/components/Prompts/InfoTable.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,IAAI,EAAC,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAC,UAAU,EAAC,MAAM,wCAAwC,CAAA;AACjE,OAAO,EAAyB,aAAa,EAAC,MAAM,qBAAqB,CAAA;AACzE,OAAO,EAAC,GAAG,EAAE,IAAI,EAAY,MAAM,KAAK,CAAA;AACxC,OAAO,KAA0B,MAAM,OAAO,CAAA;AAqB9C,MAAM,SAAS,GAAsC,CAAC,EAAC,KAAK,EAAC,EAAE,EAAE;IAC/D,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACnC,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAClC,MAAM;YACN,KAAK,EAAE,KAAK,CAAC,MAAM,CAAE;YACrB,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,SAAS;YACrB,MAAM,EAAE,SAAS;YACjB,cAAc,EAAE,SAAS;SAC1B,CAAC,CAAC,CAAA;IAEP,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAChC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAC1B,OAAO,IAAI,CAAC,GAAG,CACb,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC,CAAC,CACH,CAAA;IACH,CAAC,CAAC,CACH,CAAA;IAED,OAAO,CACL,oBAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,IACxB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAChC,oBAAC,GAAG,IAAC,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,aAAa,EAAC,QAAQ;QACzF,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAC5B,oBAAC,GAAG,IAAC,KAAK,EAAE,iBAAiB,GAAG,CAAC;YAC/B,oBAAC,IAAI,IAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,UAC7B,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CACtB,CACH,CACP;QACD,oBAAC,GAAG,IAAC,QAAQ,EAAE,CAAC,EAAE,aAAa,EAAC,QAAQ,EAAC,GAAG,EAAE,CAAC;YAC5C,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CACtD,oBAAC,IAAI,IAAC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACxB,oBAAC,aAAa,IAAC,IAAI,EAAE,EAAC,OAAO,EAAE,OAAO,CAAC,cAAc,EAAC,GAAI,CACrD,CACR,CAAC,CAAC,CAAC,CACF,oBAAC,IAAI,IAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,GAAI,CAC5F;YACA,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,oBAAC,IAAI,IAAC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAG,OAAO,CAAC,UAAU,CAAQ,CAAC,CAAC,CAAC,IAAI,CAChF,CACF,CACP,CAAC,CACE,CACP,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAC,SAAS,EAAC,CAAA","sourcesContent":["import {CustomListItem, List} from '../List.js'\nimport {capitalize} from '../../../../../public/common/string.js'\nimport {InlineToken, TokenItem, TokenizedText} from '../TokenizedText.js'\nimport {Box, Text, TextProps} from 'ink'\nimport React, {FunctionComponent} from 'react'\n\ntype Items = (TokenItem<InlineToken> | CustomListItem)[]\n\nexport interface InfoTableSection {\n  color?: TextProps['color']\n  header: string\n  bullet?: string\n  helperText?: string\n  items: Items\n  emptyItemsText?: string\n}\n\nexport interface InfoTableProps {\n  table:\n    | {\n        [header: string]: Items\n      }\n    | InfoTableSection[]\n}\n\nconst InfoTable: FunctionComponent<InfoTableProps> = ({table}) => {\n  const sections = Array.isArray(table)\n    ? table\n    : Object.keys(table).map((header) => ({\n        header,\n        items: table[header]!,\n        color: undefined,\n        helperText: undefined,\n        bullet: undefined,\n        emptyItemsText: undefined,\n      }))\n\n  const headerColumnWidth = Math.max(\n    ...sections.map((section) => {\n      return Math.max(\n        ...section.header.split('\\n').map((line) => {\n          return line.length\n        }),\n      )\n    }),\n  )\n\n  return (\n    <Box flexDirection=\"column\">\n      {sections.map((section, index) => (\n        <Box key={index} marginBottom={index === sections.length - 1 ? 0 : 1} flexDirection=\"column\">\n          {section.header.length > 0 && (\n            <Box width={headerColumnWidth + 1}>\n              <Text color={section.color} bold>\n                {capitalize(section.header)}\n              </Text>\n            </Box>\n          )}\n          <Box flexGrow={1} flexDirection=\"column\" gap={1}>\n            {section.emptyItemsText && section.items.length === 0 ? (\n              <Text color={section.color}>\n                <TokenizedText item={{subdued: section.emptyItemsText}} />\n              </Text>\n            ) : (\n              <List margin={false} items={section.items} color={section.color} bullet={section.bullet} />\n            )}\n            {section.helperText ? <Text color={section.color}>{section.helperText}</Text> : null}\n          </Box>\n        </Box>\n      ))}\n    </Box>\n  )\n}\n\nexport {InfoTable}\n"]}

package/dist/private/node/ui/components/Prompts/InfoTable.test.js

@@ -28,5 +28,31 @@ describe('InfoTable', async () => {
       • items"
     `);
     });
+    test('when the list of items has elements doesnt render the empty message', async () => {
+        const { lastFrame } = render(React.createElement(InfoTable, { table: [
+                {
+                    header: 'header',
+                    items: ['item'],
+                    emptyItemsText: 'empty',
+                },
+            ] }));
+        expect(unstyled(lastFrame())).toMatchInlineSnapshot(`
+      "Header
+      • item"
+    `);
+    });
+    test('when the list of items is empty renders the empty message subdued if set', async () => {
+        const { lastFrame } = render(React.createElement(InfoTable, { table: [
+                {
+                    header: 'header',
+                    items: [],
+                    emptyItemsText: 'empty',
+                },
+            ] }));
+        expect(lastFrame()).toMatchInlineSnapshot(`
+      "Header
+      empty"
+    `);
+    });
 });
 //# sourceMappingURL=InfoTable.test.js.map

package/dist/private/node/ui/components/Prompts/InfoTable.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"InfoTable.test.js","sourceRoot":"","sources":["../../../../../../src/private/node/ui/components/Prompts/InfoTable.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAC,MAAM,sCAAsC,CAAA;AAC7D,OAAO,EAAC,MAAM,EAAC,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;IAC/B,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CACxB,oBAAC,SAAS,IACR,KAAK,EAAE;gBACL,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;gBAC7B,4BAA4B,EAAE,CAAC,CAAC,UAAU,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,qBAAqB,EAAC,EAAC,CAAC,CAAC;aACrG,GACD,CACH,CAAA;QAED,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;KAQpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CACxB,oBAAC,SAAS,IACR,KAAK,EAAE;gBACL,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;aACtB,GACD,CACH,CAAA;QAED,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;KAGpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {InfoTable} from './InfoTable.js'\nimport {unstyled} from '../../../../../public/node/output.js'\nimport {render} from '../../../testing/ui.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('InfoTable', async () => {\n  test('renders a horizontal table with bullet points', async () => {\n    const {lastFrame} = render(\n      <InfoTable\n        table={{\n          'header 1': ['some', 'items'],\n          'header 2\\nlonger text here': [['one item', {link: {label: 'Shopify', url: 'https://shopify.com'}}]],\n        }}\n      />,\n    )\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"Header 1\n      • some\n      • items\n\n      Header 2\n      longer text here\n      • one item Shopify ( https://shopify.com )\"\n    `)\n  })\n\n  test('supports an empty header value', async () => {\n    const {lastFrame} = render(\n      <InfoTable\n        table={{\n          '': ['some', 'items'],\n        }}\n      />,\n    )\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"• some\n      • items\"\n    `)\n  })\n})\n"]}
+{"version":3,"file":"InfoTable.test.js","sourceRoot":"","sources":["../../../../../../src/private/node/ui/components/Prompts/InfoTable.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAC,MAAM,sCAAsC,CAAA;AAC7D,OAAO,EAAC,MAAM,EAAC,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;IAC/B,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CACxB,oBAAC,SAAS,IACR,KAAK,EAAE;gBACL,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;gBAC7B,4BAA4B,EAAE,CAAC,CAAC,UAAU,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,qBAAqB,EAAC,EAAC,CAAC,CAAC;aACrG,GACD,CACH,CAAA;QAED,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;KAQpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CACxB,oBAAC,SAAS,IACR,KAAK,EAAE;gBACL,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;aACtB,GACD,CACH,CAAA;QAED,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;KAGpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CACxB,oBAAC,SAAS,IACR,KAAK,EAAE;gBACL;oBACE,MAAM,EAAE,QAAQ;oBAChB,KAAK,EAAE,CAAC,MAAM,CAAC;oBACf,cAAc,EAAE,OAAO;iBACxB;aACF,GACD,CACH,CAAA;QAED,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;KAGpD,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QAC1F,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CACxB,oBAAC,SAAS,IACR,KAAK,EAAE;gBACL;oBACE,MAAM,EAAE,QAAQ;oBAChB,KAAK,EAAE,EAAE;oBACT,cAAc,EAAE,OAAO;iBACxB;aACF,GACD,CACH,CAAA;QAED,MAAM,CAAC,SAAS,EAAG,CAAC,CAAC,qBAAqB,CAAC;;;KAG1C,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {InfoTable} from './InfoTable.js'\nimport {unstyled} from '../../../../../public/node/output.js'\nimport {render} from '../../../testing/ui.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('InfoTable', async () => {\n  test('renders a horizontal table with bullet points', async () => {\n    const {lastFrame} = render(\n      <InfoTable\n        table={{\n          'header 1': ['some', 'items'],\n          'header 2\\nlonger text here': [['one item', {link: {label: 'Shopify', url: 'https://shopify.com'}}]],\n        }}\n      />,\n    )\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"Header 1\n      • some\n      • items\n\n      Header 2\n      longer text here\n      • one item Shopify ( https://shopify.com )\"\n    `)\n  })\n\n  test('supports an empty header value', async () => {\n    const {lastFrame} = render(\n      <InfoTable\n        table={{\n          '': ['some', 'items'],\n        }}\n      />,\n    )\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"• some\n      • items\"\n    `)\n  })\n\n  test('when the list of items has elements doesnt render the empty message', async () => {\n    const {lastFrame} = render(\n      <InfoTable\n        table={[\n          {\n            header: 'header',\n            items: ['item'],\n            emptyItemsText: 'empty',\n          },\n        ]}\n      />,\n    )\n\n    expect(unstyled(lastFrame()!)).toMatchInlineSnapshot(`\n      \"Header\n      • item\"\n    `)\n  })\n\n  test('when the list of items is empty renders the empty message subdued if set', async () => {\n    const {lastFrame} = render(\n      <InfoTable\n        table={[\n          {\n            header: 'header',\n            items: [],\n            emptyItemsText: 'empty',\n          },\n        ]}\n      />,\n    )\n\n    expect(lastFrame()!).toMatchInlineSnapshot(`\n      \"\u001b[1mHeader\u001b[22m\n      \u001b[2mempty\u001b[22m\"\n    `)\n  })\n})\n"]}

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

@@ -63,3 +63,10 @@ export declare function getPathValue<T = object>(object: object, path: string):
  * @returns - Returns object.
  */
 export declare function setPathValue(object: object, path: string, value?: unknown): object;
+/**
+ * Checks if value is an empty object, collection, map, or set.
+ *
+ * @param object - The value to check.
+ * @returns - Returns true if value is empty, else false.
+ */
+export declare function isEmpty(object: object): boolean;

package/dist/public/common/object.js

@@ -89,4 +89,14 @@ export function setPathValue(object, path, value) {
     const set = require('lodash/set.js');
     return set(object, path, value);
 }
+/**
+ * Checks if value is an empty object, collection, map, or set.
+ *
+ * @param object - The value to check.
+ * @returns - Returns true if value is empty, else false.
+ */
+export function isEmpty(object) {
+    const isEmpty = require('lodash/isEmpty.js');
+    return isEmpty(object);
+}
 //# sourceMappingURL=object.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/public/common/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAA;AAChE,OAAO,SAAS,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAA;AAEpC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE9C;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,GAAgB,EAChB,GAAgB,EAChB,qBAAyF,kBAAkB;IAE3G,OAAO,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC,CAAC,CAAA;AAC9D,CAAC;AAED;;;;;;;GAOG;AACH,gEAAgE;AAChE,MAAM,UAAU,MAAM,CACpB,MAAwC,EACxC,SAA+B;IAE/B,MAAM,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAChD,OAAO,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CACvB,MAA4B,EAC5B,QAAoC;IAEpC,MAAM,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IACtD,OAAO,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,GAAW;IAClD,MAAM,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAClD,OAAO,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,GAAW;IACrD,MAAM,cAAc,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAA;IAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAChD,MAAM,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC5C,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAA;IACvE,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAA;IACxE,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;AAClD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAa,MAAc,EAAE,IAAY;IACnE,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAEpC,OAAO,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAO,CAAA;AAC/E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,IAAY,EAAE,KAAe;IACxE,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAEpC,OAAO,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;AACjC,CAAC","sourcesContent":["import {unionArrayStrategy} from '../../private/common/array.js'\nimport deepMerge from 'deepmerge'\nimport {Dictionary, ObjectIterator, ValueKeyIteratee} from 'lodash'\nimport {createRequire} from 'module'\n\nconst require = createRequire(import.meta.url)\n\n/**\n * Deep merges the two objects and returns a new object with the merge result.\n *\n * @param lhs - One of the objects to be merged.\n * @param rhs - Another object to be merged.\n * @param arrayMergeStrategy - Strategy used to merge the array typed fields. Union strategy is used by default to avoid\n * duplicated elements.\n * @returns A Javascrip tobject with th emerged objects.\n */\nexport function deepMergeObjects<T1, T2>(\n  lhs: Partial<T1>,\n  rhs: Partial<T2>,\n  arrayMergeStrategy: (destinationArray: unknown[], sourceArray: unknown[]) => unknown[] = unionArrayStrategy,\n): T1 & T2 {\n  return deepMerge(lhs, rhs, {arrayMerge: arrayMergeStrategy})\n}\n\n/**\n * Creates an object composed of the `object` properties `predicate` returns\n * truthy for. The predicate is invoked with two arguments: (value, key).\n *\n * @param object - The source object.\n * @param predicate - The function invoked per property.\n * @returns Returns the new object.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport function pickBy<T, S extends T>(\n  object: Dictionary<T> | null | undefined,\n  predicate?: ValueKeyIteratee<T>,\n): Dictionary<S> {\n  const lodashPickBy = require('lodash/pickBy.js')\n  return lodashPickBy(object, predicate)\n}\n\n/**\n * Creates an object with the same keys as object and values generated by running each own\n * enumerable property of object through iteratee. The iteratee function is\n * invoked with three arguments: (value, key, object).\n *\n * @param source - The object to iterate over.\n * @param callback - The function invoked per iteration.\n * @returns Returns the new mapped object.\n */\nexport function mapValues<T extends object, TResult>(\n  source: T | null | undefined,\n  callback: ObjectIterator<T, TResult>,\n): {[P in keyof T]: TResult} {\n  const lodashMapValues = require('lodash/mapValues.js')\n  return lodashMapValues(source, callback)\n}\n\n/**\n * Deeply compares two objects and returns true if they are equal.\n *\n * @param one - The first object to be compared.\n * @param two - The second object to be compared.\n * @returns True if the objects are equal, false otherwise.\n */\nexport function deepCompare(one: object, two: object): boolean {\n  const lodashIsEqual = require('lodash/isEqual.js')\n  return lodashIsEqual(one, two)\n}\n\n/**\n * Return the difference between two nested objects.\n *\n * @param one - The first object to be compared.\n * @param two - The second object to be compared.\n * @returns Two objects containing the fields that are different, each one with the values of one object.\n */\nexport function deepDifference(one: object, two: object): [object, object] {\n  const differenceWith = require('lodash/differenceWith.js')\n  const fromPairs = require('lodash/fromPairs.js')\n  const toPairs = require('lodash/toPairs.js')\n  const changes = differenceWith(toPairs(one), toPairs(two), deepCompare)\n  const changes2 = differenceWith(toPairs(two), toPairs(one), deepCompare)\n  return [fromPairs(changes), fromPairs(changes2)]\n}\n\n/**\n * Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.\n *\n * @param object - The object to query.\n * @param path - The path of the property to get.\n * @returns - Returns the resolved value.\n */\nexport function getPathValue<T = object>(object: object, path: string): T | undefined {\n  const get = require('lodash/get.js')\n\n  return get(object, path) === undefined ? undefined : (get(object, path) as T)\n}\n\n/**\n * Sets the value at path of object. If a portion of path doesn't exist, it's create.\n *\n * @param object - The object to modify.\n * @param path - The path of the property to set.\n * @param value - The value to set.\n * @returns - Returns object.\n */\nexport function setPathValue(object: object, path: string, value?: unknown): object {\n  const set = require('lodash/set.js')\n\n  return set(object, path, value)\n}\n"]}
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/public/common/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAA;AAChE,OAAO,SAAS,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAA;AAEpC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE9C;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,GAAgB,EAChB,GAAgB,EAChB,qBAAyF,kBAAkB;IAE3G,OAAO,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC,CAAC,CAAA;AAC9D,CAAC;AAED;;;;;;;GAOG;AACH,gEAAgE;AAChE,MAAM,UAAU,MAAM,CACpB,MAAwC,EACxC,SAA+B;IAE/B,MAAM,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAChD,OAAO,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CACvB,MAA4B,EAC5B,QAAoC;IAEpC,MAAM,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IACtD,OAAO,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,GAAW;IAClD,MAAM,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAClD,OAAO,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,GAAW;IACrD,MAAM,cAAc,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAA;IAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAChD,MAAM,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC5C,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAA;IACvE,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAA;IACxE,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;AAClD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAa,MAAc,EAAE,IAAY;IACnE,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAEpC,OAAO,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAO,CAAA;AAC/E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,IAAY,EAAE,KAAe;IACxE,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAEpC,OAAO,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,MAAc;IACpC,MAAM,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE5C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAA;AACxB,CAAC","sourcesContent":["import {unionArrayStrategy} from '../../private/common/array.js'\nimport deepMerge from 'deepmerge'\nimport {Dictionary, ObjectIterator, ValueKeyIteratee} from 'lodash'\nimport {createRequire} from 'module'\n\nconst require = createRequire(import.meta.url)\n\n/**\n * Deep merges the two objects and returns a new object with the merge result.\n *\n * @param lhs - One of the objects to be merged.\n * @param rhs - Another object to be merged.\n * @param arrayMergeStrategy - Strategy used to merge the array typed fields. Union strategy is used by default to avoid\n * duplicated elements.\n * @returns A Javascrip tobject with th emerged objects.\n */\nexport function deepMergeObjects<T1, T2>(\n  lhs: Partial<T1>,\n  rhs: Partial<T2>,\n  arrayMergeStrategy: (destinationArray: unknown[], sourceArray: unknown[]) => unknown[] = unionArrayStrategy,\n): T1 & T2 {\n  return deepMerge(lhs, rhs, {arrayMerge: arrayMergeStrategy})\n}\n\n/**\n * Creates an object composed of the `object` properties `predicate` returns\n * truthy for. The predicate is invoked with two arguments: (value, key).\n *\n * @param object - The source object.\n * @param predicate - The function invoked per property.\n * @returns Returns the new object.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport function pickBy<T, S extends T>(\n  object: Dictionary<T> | null | undefined,\n  predicate?: ValueKeyIteratee<T>,\n): Dictionary<S> {\n  const lodashPickBy = require('lodash/pickBy.js')\n  return lodashPickBy(object, predicate)\n}\n\n/**\n * Creates an object with the same keys as object and values generated by running each own\n * enumerable property of object through iteratee. The iteratee function is\n * invoked with three arguments: (value, key, object).\n *\n * @param source - The object to iterate over.\n * @param callback - The function invoked per iteration.\n * @returns Returns the new mapped object.\n */\nexport function mapValues<T extends object, TResult>(\n  source: T | null | undefined,\n  callback: ObjectIterator<T, TResult>,\n): {[P in keyof T]: TResult} {\n  const lodashMapValues = require('lodash/mapValues.js')\n  return lodashMapValues(source, callback)\n}\n\n/**\n * Deeply compares two objects and returns true if they are equal.\n *\n * @param one - The first object to be compared.\n * @param two - The second object to be compared.\n * @returns True if the objects are equal, false otherwise.\n */\nexport function deepCompare(one: object, two: object): boolean {\n  const lodashIsEqual = require('lodash/isEqual.js')\n  return lodashIsEqual(one, two)\n}\n\n/**\n * Return the difference between two nested objects.\n *\n * @param one - The first object to be compared.\n * @param two - The second object to be compared.\n * @returns Two objects containing the fields that are different, each one with the values of one object.\n */\nexport function deepDifference(one: object, two: object): [object, object] {\n  const differenceWith = require('lodash/differenceWith.js')\n  const fromPairs = require('lodash/fromPairs.js')\n  const toPairs = require('lodash/toPairs.js')\n  const changes = differenceWith(toPairs(one), toPairs(two), deepCompare)\n  const changes2 = differenceWith(toPairs(two), toPairs(one), deepCompare)\n  return [fromPairs(changes), fromPairs(changes2)]\n}\n\n/**\n * Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.\n *\n * @param object - The object to query.\n * @param path - The path of the property to get.\n * @returns - Returns the resolved value.\n */\nexport function getPathValue<T = object>(object: object, path: string): T | undefined {\n  const get = require('lodash/get.js')\n\n  return get(object, path) === undefined ? undefined : (get(object, path) as T)\n}\n\n/**\n * Sets the value at path of object. If a portion of path doesn't exist, it's create.\n *\n * @param object - The object to modify.\n * @param path - The path of the property to set.\n * @param value - The value to set.\n * @returns - Returns object.\n */\nexport function setPathValue(object: object, path: string, value?: unknown): object {\n  const set = require('lodash/set.js')\n\n  return set(object, path, value)\n}\n\n/**\n * Checks if value is an empty object, collection, map, or set.\n *\n * @param object - The value to check.\n * @returns - Returns true if value is empty, else false.\n */\nexport function isEmpty(object: object): boolean {\n  const isEmpty = require('lodash/isEmpty.js')\n\n  return isEmpty(object)\n}\n"]}

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

@@ -0,0 +1,14 @@
+/**
+ * Perform an action optimistically. If it fails the first time, first initiate
+ * a provided recovery procedure, then retry the action. If it fails again,
+ * throw the error.
+ *
+ * This is useful for actions that may fail due to recoverable errors, such as
+ * an expired token that can be refreshed. In this case, the recovery procedure
+ * would refresh the token.
+ *
+ * @param performAction - The action to perform.
+ * @param recoveryProcedure - The recovery procedure to perform if the action
+ * fails the first time.
+ */
+export declare function performActionWithRetryAfterRecovery<T>(performAction: () => Promise<T>, recoveryProcedure: () => Promise<unknown>): Promise<T>;

package/dist/public/common/retry.js

@@ -0,0 +1,27 @@
+/**
+ * Perform an action optimistically. If it fails the first time, first initiate
+ * a provided recovery procedure, then retry the action. If it fails again,
+ * throw the error.
+ *
+ * This is useful for actions that may fail due to recoverable errors, such as
+ * an expired token that can be refreshed. In this case, the recovery procedure
+ * would refresh the token.
+ *
+ * @param performAction - The action to perform.
+ * @param recoveryProcedure - The recovery procedure to perform if the action
+ * fails the first time.
+ */
+export async function performActionWithRetryAfterRecovery(performAction, recoveryProcedure) {
+    let returnVal;
+    try {
+        returnVal = await performAction();
+        return returnVal;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch (err) {
+        // Run the provided recovery procedure, then retry the action
+        await recoveryProcedure();
+        return performAction();
+    }
+}
+//# sourceMappingURL=retry.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"retry.js","sourceRoot":"","sources":["../../../src/public/common/retry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,mCAAmC,CACvD,aAA+B,EAC/B,iBAAyC;IAEzC,IAAI,SAAwB,CAAA;IAC5B,IAAI;QACF,SAAS,GAAG,MAAM,aAAa,EAAE,CAAA;QACjC,OAAO,SAAS,CAAA;QAChB,qDAAqD;KACtD;IAAC,OAAO,GAAG,EAAE;QACZ,6DAA6D;QAC7D,MAAM,iBAAiB,EAAE,CAAA;QACzB,OAAO,aAAa,EAAE,CAAA;KACvB;AACH,CAAC","sourcesContent":["/**\n * Perform an action optimistically. If it fails the first time, first initiate\n * a provided recovery procedure, then retry the action. If it fails again,\n * throw the error.\n *\n * This is useful for actions that may fail due to recoverable errors, such as\n * an expired token that can be refreshed. In this case, the recovery procedure\n * would refresh the token.\n *\n * @param performAction - The action to perform.\n * @param recoveryProcedure - The recovery procedure to perform if the action\n * fails the first time.\n */\nexport async function performActionWithRetryAfterRecovery<T>(\n  performAction: () => Promise<T>,\n  recoveryProcedure: () => Promise<unknown>,\n): Promise<T> {\n  let returnVal: T | undefined\n  try {\n    returnVal = await performAction()\n    return returnVal\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (err) {\n    // Run the provided recovery procedure, then retry the action\n    await recoveryProcedure()\n    return performAction()\n  }\n}\n"]}

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

@@ -1 +1 @@
-export declare const CLI_KIT_VERSION = "3.53.0";
+export declare const CLI_KIT_VERSION = "3.54.0";

package/dist/public/common/version.js

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

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

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

package/dist/public/node/analytics.js

@@ -91,7 +91,7 @@ async function buildPayload({ config, errorMessage, exitMode }) {
             time_start: startTime,
             time_end: currentTime,
             total_time: wallClockElapsed,
-            success: errorMessage === undefined,
+            success: exitMode === 'ok' && errorMessage === undefined,
             cli_version: CLI_KIT_VERSION,
             ruby_version: (await rubyVersion()) || '',
             node_version: process.version.replace('v', ''),

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

@@ -1 +1 @@
-{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/public/node/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,WAAW,CAAA;AAChD,OAAO,EAAC,kBAAkB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAC,MAAM,oBAAoB,CAAA;AACrG,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,EAAC,oBAAoB,EAAE,sBAAsB,EAAC,MAAM,eAAe,CAAA;AAC1E,OAAO,EAAC,WAAW,EAAC,MAAM,cAAc,CAAA;AAExC,OAAO,EAAC,aAAa,EAAE,WAAW,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACnF,OAAO,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,iCAAiC,CAAA;AAC/F,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAA;AACpD,OAAO,EAAC,aAAa,EAAC,MAAM,oCAAoC,CAAA;AAiBhE;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAoC;IAC7E,IAAI;QACF,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,iBAAiB;YACjB,OAAM;SACP;QAED,MAAM,qBAAqB,GAAG,CAAC,kBAAkB,EAAE,IAAI,iBAAiB,EAAE,CAAA;QAC1E,MAAM,mBAAmB,GAAG,CAAC,gBAAgB,EAAE,IAAI,iBAAiB,EAAE,CAAA;QACtE,IAAI,qBAAqB,IAAI,mBAAmB,EAAE;YAChD,WAAW,CAAC,aAAa,CAAA,wCAAwC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;SAC9F;QAED,MAAM,UAAU,GAAG,KAAK,IAAI,EAAE;YAC5B,IAAI,qBAAqB,EAAE;gBACzB,OAAM;aACP;YACD,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,sBAAsB,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;YACtG,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC7B,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;aAC9B;QACH,CAAC,CAAA;QACD,MAAM,eAAe,GAAG,KAAK,IAAI,EAAE;YACjC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,wBAAwB,IAAI,CAAC,CAAA;YAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,yBAAyB,IAAI,CAAC,CAAA;YAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,yBAAyB,IAAI,CAAC,CAAA;YAE5D,OAAO,aAAa,CAClB;gBACE,mBAAmB;gBACnB,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW;gBACtC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,IAAI,cAAc;gBAC7D,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;gBAC/B,QAAQ,EAAE,OAAO,CAAC,QAAQ;aAC3B,EACD;gBACE,MAAM;gBACN,OAAO;gBACP,MAAM;aACP,CACF,CAAA;QACH,CAAC,CAAA;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,CAAA;QAEpD,qDAAqD;KACtD;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,OAAO,GAAG,kCAAkC,CAAA;QAChD,IAAI,KAAK,YAAY,KAAK,EAAE;YAC1B,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;SAC/C;QACD,WAAW,CAAC,OAAO,CAAC,CAAA;KACrB;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,EAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAA8B;IACvF,MAAM,EAAC,mBAAmB,EAAE,gBAAgB,EAAE,GAAG,iBAAiB,EAAC,GAAG,QAAQ,CAAC,uBAAuB,EAAE,CAAA;IACxG,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACrC,WAAW,CAAC,oEAAoE,CAAC,CAAA;QACjF,OAAM;KACP;IACD,MAAM,EAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAC,GAAG,mBAAmB,CAAA;IAChE,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;IAExC,MAAM,EAAC,cAAc,EAAE,SAAS,EAAE,GAAG,kBAAkB,EAAC,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAA;IACnH,MAAM,EAAC,cAAc,EAAE,YAAY,EAAE,GAAG,qBAAqB,EAAC,GAAG,MAAM,WAAW,CAChF,MAAM,EACN,4BAA4B,EAC5B,EAAE,CACH,CAAA;IAED,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACxD,MAAM,wBAAwB,GAAG,MAAM,2BAA2B,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,cAAc,GAAG,QAAQ,CAAC,oBAAoB,EAAE,CAAA;IAEtD,kGAAkG;IAClG,MAAM,SAAS,GAAG,CAAC,2BAA2B,EAAE,2BAA2B,CAAU,CAAA;IACrF,MAAM,sBAAsB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC/D,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;QACnC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,KAAK,GAAG,KAAK,CAAA;SACrB;QACD,OAAO,KAAK,CAAA;IACd,CAAC,EAAE,CAAC,CAAC,CAAA;IACL,MAAM,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAA;IAChD,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,sBAAsB,CAAA;IAE3E,IAAI,OAAO,GAAG;QACZ,MAAM,EAAE;YACN,OAAO,EAAE,YAAY;YACrB,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,WAAW;YACrB,UAAU,EAAE,gBAAgB;YAC5B,OAAO,EAAE,YAAY,KAAK,SAAS;YACnC,WAAW,EAAE,eAAe;YAC5B,YAAY,EAAE,CAAC,MAAM,WAAW,EAAE,CAAC,IAAI,EAAE;YACzC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;YAC9C,WAAW,EAAE,MAAM,SAAS,EAAE;YAC9B,GAAG,eAAe;YAClB,GAAG,SAAS;YACZ,GAAG,cAAc;YACjB,wBAAwB,EAAE,yBAAyB;YACnD,YAAY,EAAE,QAAQ;SACvB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;YACzB,yBAAyB,EAAE,gBAAgB;YAC3C,aAAa,EAAE,YAAY;YAC3B,GAAG,YAAY;YACf,GAAG,wBAAwB;YAC3B,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;gBACvB,GAAG,iBAAiB;gBACpB,WAAW,EAAE;oBACX,GAAG,kBAAkB;iBACtB;gBACD,cAAc,EAAE,EAAC,GAAG,qBAAqB,EAAC;aAC3C,CAAC;SACH;KACF,CAAA;IAED,4BAA4B;IAC5B,MAAM,aAAa,GAAG,CAAC,0BAA0B,EAAE,2BAA2B,EAAE,2BAA2B,CAAU,CAAA;IACrH,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC7C;IACH,CAAC,CAAC,CAAA;IAEF,kGAAkG;IAClG,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAE7C,OAAO,eAAe,CAAC,OAAO,CAAC,CAAA;AACjC,CAAC;AAED,SAAS,eAAe,CAAI,OAAU;IACpC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IAC7C,iDAAiD;IACjD,MAAM,sBAAsB,GAAG,aAAa,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAC5E,OAAO,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;AAC3C,CAAC","sourcesContent":["import {version as rubyVersion} from './ruby.js'\nimport {alwaysLogAnalytics, alwaysLogMetrics, analyticsDisabled, isShopify} from './context/local.js'\nimport * as metadata from './metadata.js'\nimport {publishMonorailEvent, MONORAIL_COMMAND_TOPIC} from './monorail.js'\nimport {fanoutHooks} from './plugins.js'\n\nimport {outputContent, outputDebug, outputToken} from '../../public/node/output.js'\nimport {getEnvironmentData, getSensitiveEnvironmentData} from '../../private/node/analytics.js'\nimport {CLI_KIT_VERSION} from '../common/version.js'\nimport {recordMetrics} from '../../private/node/otel-metrics.js'\nimport {Interfaces} from '@oclif/core'\n\nexport type CommandExitMode =\n  // The command completed successfully\n  | 'ok'\n  // The command exited for some unexpected reason -- i.e. a bug\n  | 'unexpected_error'\n  // The command exited with an error, but its one we expect and doesn't point to a bug -- i.e. malformed config files\n  | 'expected_error'\n\ninterface ReportAnalyticsEventOptions {\n  config: Interfaces.Config\n  errorMessage?: string\n  exitMode: CommandExitMode\n}\n\n/**\n * Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.\n *\n * The payload for an event includes both generic data, and data gathered from installed plug-ins.\n *\n */\nexport async function reportAnalyticsEvent(options: ReportAnalyticsEventOptions): Promise<void> {\n  try {\n    const payload = await buildPayload(options)\n    if (payload === undefined) {\n      // Nothing to log\n      return\n    }\n\n    const skipMonorailAnalytics = !alwaysLogAnalytics() && analyticsDisabled()\n    const skipMetricAnalytics = !alwaysLogMetrics() && analyticsDisabled()\n    if (skipMonorailAnalytics || skipMetricAnalytics) {\n      outputDebug(outputContent`Skipping command analytics, payload: ${outputToken.json(payload)}`)\n    }\n\n    const doMonorail = async () => {\n      if (skipMonorailAnalytics) {\n        return\n      }\n      const response = await publishMonorailEvent(MONORAIL_COMMAND_TOPIC, payload.public, payload.sensitive)\n      if (response.type === 'error') {\n        outputDebug(response.message)\n      }\n    }\n    const doOpenTelemetry = async () => {\n      const active = payload.public.cmd_all_timing_active_ms || 0\n      const network = payload.public.cmd_all_timing_network_ms || 0\n      const prompt = payload.public.cmd_all_timing_prompts_ms || 0\n\n      return recordMetrics(\n        {\n          skipMetricAnalytics,\n          cliVersion: payload.public.cli_version,\n          owningPlugin: payload.public.cmd_all_plugin || '@shopify/cli',\n          command: payload.public.command,\n          exitMode: options.exitMode,\n        },\n        {\n          active,\n          network,\n          prompt,\n        },\n      )\n    }\n    await Promise.all([doMonorail(), doOpenTelemetry()])\n\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (error) {\n    let message = 'Failed to report usage analytics'\n    if (error instanceof Error) {\n      message = message.concat(`: ${error.message}`)\n    }\n    outputDebug(message)\n  }\n}\n\nasync function buildPayload({config, errorMessage, exitMode}: ReportAnalyticsEventOptions) {\n  const {commandStartOptions, environmentFlags, ...sensitiveMetadata} = metadata.getAllSensitiveMetadata()\n  if (commandStartOptions === undefined) {\n    outputDebug('Unable to log analytics event - no information on executed command')\n    return\n  }\n  const {startCommand, startArgs, startTime} = commandStartOptions\n  const currentTime = new Date().getTime()\n\n  const {'@shopify/app': appPublic, ...otherPluginsPublic} = await fanoutHooks(config, 'public_command_metadata', {})\n  const {'@shopify/app': appSensitive, ...otherPluginsSensitive} = await fanoutHooks(\n    config,\n    'sensitive_command_metadata',\n    {},\n  )\n\n  const environmentData = await getEnvironmentData(config)\n  const sensitiveEnvironmentData = await getSensitiveEnvironmentData(config)\n  const publicMetadata = metadata.getAllPublicMetadata()\n\n  // Automatically calculate the total time spent in the command, excluding time spent in subtimers.\n  const subTimers = ['cmd_all_timing_network_ms', 'cmd_all_timing_prompts_ms'] as const\n  const totalTimeFromSubtimers = subTimers.reduce((total, timer) => {\n    const value = publicMetadata[timer]\n    if (value !== undefined) {\n      return total + value\n    }\n    return total\n  }, 0)\n  const wallClockElapsed = currentTime - startTime\n  const totalTimeWithoutSubtimers = wallClockElapsed - totalTimeFromSubtimers\n\n  let payload = {\n    public: {\n      command: startCommand,\n      time_start: startTime,\n      time_end: currentTime,\n      total_time: wallClockElapsed,\n      success: errorMessage === undefined,\n      cli_version: CLI_KIT_VERSION,\n      ruby_version: (await rubyVersion()) || '',\n      node_version: process.version.replace('v', ''),\n      is_employee: await isShopify(),\n      ...environmentData,\n      ...appPublic,\n      ...publicMetadata,\n      cmd_all_timing_active_ms: totalTimeWithoutSubtimers,\n      cmd_all_exit: exitMode,\n    },\n    sensitive: {\n      args: startArgs.join(' '),\n      cmd_all_environment_flags: environmentFlags,\n      error_message: errorMessage,\n      ...appSensitive,\n      ...sensitiveEnvironmentData,\n      metadata: JSON.stringify({\n        ...sensitiveMetadata,\n        extraPublic: {\n          ...otherPluginsPublic,\n        },\n        extraSensitive: {...otherPluginsSensitive},\n      }),\n    },\n  }\n\n  // round down timing metrics\n  const timingMetrics = ['cmd_all_timing_active_ms', 'cmd_all_timing_network_ms', 'cmd_all_timing_prompts_ms'] as const\n  timingMetrics.forEach((metric) => {\n    const current = payload.public[metric]\n    if (current !== undefined) {\n      payload.public[metric] = Math.floor(current)\n    }\n  })\n\n  // strip undefined fields -- they make up the majority of payloads due to wide metadata structure.\n  payload = JSON.parse(JSON.stringify(payload))\n\n  return sanitizePayload(payload)\n}\n\nfunction sanitizePayload<T>(payload: T): T {\n  const payloadString = JSON.stringify(payload)\n  // Remove Theme Access passwords from the payload\n  const sanitizedPayloadString = payloadString.replace(/shptka_\\w*/g, '*****')\n  return JSON.parse(sanitizedPayloadString)\n}\n"]}
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/public/node/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,WAAW,CAAA;AAChD,OAAO,EAAC,kBAAkB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAC,MAAM,oBAAoB,CAAA;AACrG,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,EAAC,oBAAoB,EAAE,sBAAsB,EAAC,MAAM,eAAe,CAAA;AAC1E,OAAO,EAAC,WAAW,EAAC,MAAM,cAAc,CAAA;AAExC,OAAO,EAAC,aAAa,EAAE,WAAW,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACnF,OAAO,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,iCAAiC,CAAA;AAC/F,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAA;AACpD,OAAO,EAAC,aAAa,EAAC,MAAM,oCAAoC,CAAA;AAiBhE;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAoC;IAC7E,IAAI;QACF,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,iBAAiB;YACjB,OAAM;SACP;QAED,MAAM,qBAAqB,GAAG,CAAC,kBAAkB,EAAE,IAAI,iBAAiB,EAAE,CAAA;QAC1E,MAAM,mBAAmB,GAAG,CAAC,gBAAgB,EAAE,IAAI,iBAAiB,EAAE,CAAA;QACtE,IAAI,qBAAqB,IAAI,mBAAmB,EAAE;YAChD,WAAW,CAAC,aAAa,CAAA,wCAAwC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;SAC9F;QAED,MAAM,UAAU,GAAG,KAAK,IAAI,EAAE;YAC5B,IAAI,qBAAqB,EAAE;gBACzB,OAAM;aACP;YACD,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,sBAAsB,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;YACtG,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC7B,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;aAC9B;QACH,CAAC,CAAA;QACD,MAAM,eAAe,GAAG,KAAK,IAAI,EAAE;YACjC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,wBAAwB,IAAI,CAAC,CAAA;YAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,yBAAyB,IAAI,CAAC,CAAA;YAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,yBAAyB,IAAI,CAAC,CAAA;YAE5D,OAAO,aAAa,CAClB;gBACE,mBAAmB;gBACnB,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW;gBACtC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,IAAI,cAAc;gBAC7D,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;gBAC/B,QAAQ,EAAE,OAAO,CAAC,QAAQ;aAC3B,EACD;gBACE,MAAM;gBACN,OAAO;gBACP,MAAM;aACP,CACF,CAAA;QACH,CAAC,CAAA;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,CAAA;QAEpD,qDAAqD;KACtD;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,OAAO,GAAG,kCAAkC,CAAA;QAChD,IAAI,KAAK,YAAY,KAAK,EAAE;YAC1B,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;SAC/C;QACD,WAAW,CAAC,OAAO,CAAC,CAAA;KACrB;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,EAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAA8B;IACvF,MAAM,EAAC,mBAAmB,EAAE,gBAAgB,EAAE,GAAG,iBAAiB,EAAC,GAAG,QAAQ,CAAC,uBAAuB,EAAE,CAAA;IACxG,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACrC,WAAW,CAAC,oEAAoE,CAAC,CAAA;QACjF,OAAM;KACP;IACD,MAAM,EAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAC,GAAG,mBAAmB,CAAA;IAChE,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;IAExC,MAAM,EAAC,cAAc,EAAE,SAAS,EAAE,GAAG,kBAAkB,EAAC,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAA;IACnH,MAAM,EAAC,cAAc,EAAE,YAAY,EAAE,GAAG,qBAAqB,EAAC,GAAG,MAAM,WAAW,CAChF,MAAM,EACN,4BAA4B,EAC5B,EAAE,CACH,CAAA;IAED,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACxD,MAAM,wBAAwB,GAAG,MAAM,2BAA2B,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,cAAc,GAAG,QAAQ,CAAC,oBAAoB,EAAE,CAAA;IAEtD,kGAAkG;IAClG,MAAM,SAAS,GAAG,CAAC,2BAA2B,EAAE,2BAA2B,CAAU,CAAA;IACrF,MAAM,sBAAsB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC/D,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;QACnC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,KAAK,GAAG,KAAK,CAAA;SACrB;QACD,OAAO,KAAK,CAAA;IACd,CAAC,EAAE,CAAC,CAAC,CAAA;IACL,MAAM,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAA;IAChD,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,sBAAsB,CAAA;IAE3E,IAAI,OAAO,GAAG;QACZ,MAAM,EAAE;YACN,OAAO,EAAE,YAAY;YACrB,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,WAAW;YACrB,UAAU,EAAE,gBAAgB;YAC5B,OAAO,EAAE,QAAQ,KAAK,IAAI,IAAI,YAAY,KAAK,SAAS;YACxD,WAAW,EAAE,eAAe;YAC5B,YAAY,EAAE,CAAC,MAAM,WAAW,EAAE,CAAC,IAAI,EAAE;YACzC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;YAC9C,WAAW,EAAE,MAAM,SAAS,EAAE;YAC9B,GAAG,eAAe;YAClB,GAAG,SAAS;YACZ,GAAG,cAAc;YACjB,wBAAwB,EAAE,yBAAyB;YACnD,YAAY,EAAE,QAAQ;SACvB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;YACzB,yBAAyB,EAAE,gBAAgB;YAC3C,aAAa,EAAE,YAAY;YAC3B,GAAG,YAAY;YACf,GAAG,wBAAwB;YAC3B,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;gBACvB,GAAG,iBAAiB;gBACpB,WAAW,EAAE;oBACX,GAAG,kBAAkB;iBACtB;gBACD,cAAc,EAAE,EAAC,GAAG,qBAAqB,EAAC;aAC3C,CAAC;SACH;KACF,CAAA;IAED,4BAA4B;IAC5B,MAAM,aAAa,GAAG,CAAC,0BAA0B,EAAE,2BAA2B,EAAE,2BAA2B,CAAU,CAAA;IACrH,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC7C;IACH,CAAC,CAAC,CAAA;IAEF,kGAAkG;IAClG,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAE7C,OAAO,eAAe,CAAC,OAAO,CAAC,CAAA;AACjC,CAAC;AAED,SAAS,eAAe,CAAI,OAAU;IACpC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IAC7C,iDAAiD;IACjD,MAAM,sBAAsB,GAAG,aAAa,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAC5E,OAAO,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;AAC3C,CAAC","sourcesContent":["import {version as rubyVersion} from './ruby.js'\nimport {alwaysLogAnalytics, alwaysLogMetrics, analyticsDisabled, isShopify} from './context/local.js'\nimport * as metadata from './metadata.js'\nimport {publishMonorailEvent, MONORAIL_COMMAND_TOPIC} from './monorail.js'\nimport {fanoutHooks} from './plugins.js'\n\nimport {outputContent, outputDebug, outputToken} from '../../public/node/output.js'\nimport {getEnvironmentData, getSensitiveEnvironmentData} from '../../private/node/analytics.js'\nimport {CLI_KIT_VERSION} from '../common/version.js'\nimport {recordMetrics} from '../../private/node/otel-metrics.js'\nimport {Interfaces} from '@oclif/core'\n\nexport type CommandExitMode =\n  // The command completed successfully\n  | 'ok'\n  // The command exited for some unexpected reason -- i.e. a bug\n  | 'unexpected_error'\n  // The command exited with an error, but its one we expect and doesn't point to a bug -- i.e. malformed config files\n  | 'expected_error'\n\ninterface ReportAnalyticsEventOptions {\n  config: Interfaces.Config\n  errorMessage?: string\n  exitMode: CommandExitMode\n}\n\n/**\n * Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.\n *\n * The payload for an event includes both generic data, and data gathered from installed plug-ins.\n *\n */\nexport async function reportAnalyticsEvent(options: ReportAnalyticsEventOptions): Promise<void> {\n  try {\n    const payload = await buildPayload(options)\n    if (payload === undefined) {\n      // Nothing to log\n      return\n    }\n\n    const skipMonorailAnalytics = !alwaysLogAnalytics() && analyticsDisabled()\n    const skipMetricAnalytics = !alwaysLogMetrics() && analyticsDisabled()\n    if (skipMonorailAnalytics || skipMetricAnalytics) {\n      outputDebug(outputContent`Skipping command analytics, payload: ${outputToken.json(payload)}`)\n    }\n\n    const doMonorail = async () => {\n      if (skipMonorailAnalytics) {\n        return\n      }\n      const response = await publishMonorailEvent(MONORAIL_COMMAND_TOPIC, payload.public, payload.sensitive)\n      if (response.type === 'error') {\n        outputDebug(response.message)\n      }\n    }\n    const doOpenTelemetry = async () => {\n      const active = payload.public.cmd_all_timing_active_ms || 0\n      const network = payload.public.cmd_all_timing_network_ms || 0\n      const prompt = payload.public.cmd_all_timing_prompts_ms || 0\n\n      return recordMetrics(\n        {\n          skipMetricAnalytics,\n          cliVersion: payload.public.cli_version,\n          owningPlugin: payload.public.cmd_all_plugin || '@shopify/cli',\n          command: payload.public.command,\n          exitMode: options.exitMode,\n        },\n        {\n          active,\n          network,\n          prompt,\n        },\n      )\n    }\n    await Promise.all([doMonorail(), doOpenTelemetry()])\n\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (error) {\n    let message = 'Failed to report usage analytics'\n    if (error instanceof Error) {\n      message = message.concat(`: ${error.message}`)\n    }\n    outputDebug(message)\n  }\n}\n\nasync function buildPayload({config, errorMessage, exitMode}: ReportAnalyticsEventOptions) {\n  const {commandStartOptions, environmentFlags, ...sensitiveMetadata} = metadata.getAllSensitiveMetadata()\n  if (commandStartOptions === undefined) {\n    outputDebug('Unable to log analytics event - no information on executed command')\n    return\n  }\n  const {startCommand, startArgs, startTime} = commandStartOptions\n  const currentTime = new Date().getTime()\n\n  const {'@shopify/app': appPublic, ...otherPluginsPublic} = await fanoutHooks(config, 'public_command_metadata', {})\n  const {'@shopify/app': appSensitive, ...otherPluginsSensitive} = await fanoutHooks(\n    config,\n    'sensitive_command_metadata',\n    {},\n  )\n\n  const environmentData = await getEnvironmentData(config)\n  const sensitiveEnvironmentData = await getSensitiveEnvironmentData(config)\n  const publicMetadata = metadata.getAllPublicMetadata()\n\n  // Automatically calculate the total time spent in the command, excluding time spent in subtimers.\n  const subTimers = ['cmd_all_timing_network_ms', 'cmd_all_timing_prompts_ms'] as const\n  const totalTimeFromSubtimers = subTimers.reduce((total, timer) => {\n    const value = publicMetadata[timer]\n    if (value !== undefined) {\n      return total + value\n    }\n    return total\n  }, 0)\n  const wallClockElapsed = currentTime - startTime\n  const totalTimeWithoutSubtimers = wallClockElapsed - totalTimeFromSubtimers\n\n  let payload = {\n    public: {\n      command: startCommand,\n      time_start: startTime,\n      time_end: currentTime,\n      total_time: wallClockElapsed,\n      success: exitMode === 'ok' && errorMessage === undefined,\n      cli_version: CLI_KIT_VERSION,\n      ruby_version: (await rubyVersion()) || '',\n      node_version: process.version.replace('v', ''),\n      is_employee: await isShopify(),\n      ...environmentData,\n      ...appPublic,\n      ...publicMetadata,\n      cmd_all_timing_active_ms: totalTimeWithoutSubtimers,\n      cmd_all_exit: exitMode,\n    },\n    sensitive: {\n      args: startArgs.join(' '),\n      cmd_all_environment_flags: environmentFlags,\n      error_message: errorMessage,\n      ...appSensitive,\n      ...sensitiveEnvironmentData,\n      metadata: JSON.stringify({\n        ...sensitiveMetadata,\n        extraPublic: {\n          ...otherPluginsPublic,\n        },\n        extraSensitive: {...otherPluginsSensitive},\n      }),\n    },\n  }\n\n  // round down timing metrics\n  const timingMetrics = ['cmd_all_timing_active_ms', 'cmd_all_timing_network_ms', 'cmd_all_timing_prompts_ms'] as const\n  timingMetrics.forEach((metric) => {\n    const current = payload.public[metric]\n    if (current !== undefined) {\n      payload.public[metric] = Math.floor(current)\n    }\n  })\n\n  // strip undefined fields -- they make up the majority of payloads due to wide metadata structure.\n  payload = JSON.parse(JSON.stringify(payload))\n\n  return sanitizePayload(payload)\n}\n\nfunction sanitizePayload<T>(payload: T): T {\n  const payloadString = JSON.stringify(payload)\n  // Remove Theme Access passwords from the payload\n  const sanitizedPayloadString = payloadString.replace(/shptka_\\w*/g, '*****')\n  return JSON.parse(sanitizedPayloadString)\n}\n"]}

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

@@ -8,18 +8,26 @@ import { GraphQLVariables, GraphQLResponse } from './graphql.js';
  * @returns The response of the query of generic type <T>.
  */
 export declare function partnersRequest<T>(query: string, token: string, variables?: GraphQLVariables): Promise<T>;
+export interface FunctionUploadUrlGenerateResponse {
+    functionUploadUrlGenerate: {
+        generatedUrlDetails: {
+            url: string;
+            moduleId: string;
+            headers: {
+                [key: string]: string;
+            };
+            maxBytes: number;
+            maxSize: string;
+        };
+    };
+}
 /**
- * Function queries are proxied through the script service proxy.
- * To execute a query, we encapsulate it inside another query (including the variables)
- * This is done automatically, you just need to provide the query and the variables.
+ * Request a URL from partners to which we will upload our function.
  *
- * @param apiKey - APIKey of the app where the query will be executed.
- * @param query - GraphQL query to execute.
  * @param token - Partners token.
- * @param variables - GraphQL variables to pass to the query.
  * @returns The response of the query.
  */
-export declare function functionProxyRequest<T>(apiKey: string, query: unknown, token: string, variables?: unknown): Promise<T>;
+export declare function getFunctionUploadUrl(token: string): Promise<FunctionUploadUrlGenerateResponse>;
 /**
  * Sets the next deprecation date from [GraphQL response extensions](https://www.apollographql.com/docs/resources/graphql-glossary/#extensions)
  * if `response.extensions.deprecations` objects contain a `supportedUntilDate` (ISO 8601-formatted string).

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

@@ -33,31 +33,27 @@ export async function partnersRequest(query, token, variables) {
     return result;
 }
 /**
- * Function queries are proxied through the script service proxy.
- * To execute a query, we encapsulate it inside another query (including the variables)
- * This is done automatically, you just need to provide the query and the variables.
+ * Request a URL from partners to which we will upload our function.
  *
- * @param apiKey - APIKey of the app where the query will be executed.
- * @param query - GraphQL query to execute.
  * @param token - Partners token.
- * @param variables - GraphQL variables to pass to the query.
  * @returns The response of the query.
  */
-export async function functionProxyRequest(apiKey, query, token, variables) {
-    const proxyVariables = {
-        api_key: apiKey,
-        query,
-        variables: JSON.stringify(variables) || '{}',
-    };
-    const proxyQuery = ScriptServiceProxyQuery;
-    const res = await partnersRequest(proxyQuery, token, proxyVariables);
-    const json = JSON.parse(res.scriptServiceProxy);
-    handleDeprecations(json);
-    return json;
+export async function getFunctionUploadUrl(token) {
+    const functionUploadUrlGenerateMutation = FunctionUploadUrlGenerateMutation;
+    const res = await partnersRequest(FunctionUploadUrlGenerateMutation, token);
+    return res;
 }
-const ScriptServiceProxyQuery = gql `
-  query ProxyRequest($api_key: String, $query: String!, $variables: String) {
-    scriptServiceProxy(apiKey: $api_key, query: $query, variables: $variables)
+const FunctionUploadUrlGenerateMutation = gql `
+  mutation functionUploadUrlGenerateMutation {
+    functionUploadUrlGenerate {
+      generatedUrlDetails {
+        url
+        moduleId
+        headers
+        maxBytes
+        maxSize
+      }
+    }
   }
 `;
 /**