@shopify/cli-kit 3.6.1 → 3.8.0

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAC7B,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAC7B,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAC7B,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,YAAY,MAAM,qBAAqB,CAAA;AACnD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA","sourcesContent":["export {default as constants} from './constants.js'\nexport * as abort from './abort.js'\nexport * as analytics from './analytics.js'\nexport * as api from './api.js'\nexport * as array from './array.js'\nexport * as cli from './cli.js'\nexport * as environment from './environment.js'\nexport * as error from './error.js'\nexport * as fastify from 'fastify'\nexport * as file from './file.js'\nexport * as git from './git.js'\nexport * as github from './github.js'\nexport * as haiku from './haiku.js'\nexport * as http from './http.js'\nexport * as id from './id.js'\nexport * as npm from './npm.js'\nexport * as os from './os.js'\nexport * as output from './output.js'\nexport * as path from './path.js'\nexport * as plugins from './plugins.js'\nexport * as port from './port.js'\nexport * as schema from './schema.js'\nexport * as semver from './semver.js'\nexport * as session from './session.js'\nexport * as store from './store.js'\nexport * as string from './string.js'\nexport * as system from './system.js'\nexport * as template from './template.js'\nexport * as toml from './toml.js'\nexport * as ui from './ui.js'\nexport * as version from './version.js'\nexport * as vscode from './vscode.js'\nexport * as yaml from './yaml.js'\nexport * as outputMocker from './testing/output.js'\nexport * as metadata from './metadata.js'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAC7B,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAC7B,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAC7B,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,YAAY,MAAM,qBAAqB,CAAA;AACnD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA","sourcesContent":["export {default as constants} from './constants.js'\nexport * as abort from './abort.js'\nexport * as analytics from './analytics.js'\nexport * as api from './api.js'\nexport * as array from './array.js'\nexport * as cli from './cli.js'\nexport * as environment from './environment.js'\nexport * as error from './error.js'\nexport * as fastify from 'fastify'\nexport * as file from './file.js'\nexport * as git from './git.js'\nexport * as github from './github.js'\nexport * as haiku from './haiku.js'\nexport * as http from './http.js'\nexport * as id from './id.js'\nexport * as npm from './npm.js'\nexport * as os from './os.js'\nexport * as output from './output.js'\nexport * as path from './path.js'\nexport * as plugins from './plugins.js'\nexport * as port from './port.js'\nexport * as schema from './schema.js'\nexport * as semver from './semver.js'\nexport * as session from './session.js'\nexport * as store from './store.js'\nexport * as string from './string.js'\nexport * as system from './system.js'\nexport * as template from './template.js'\nexport * as toml from './toml.js'\nexport * as ui from './ui.js'\nexport * as version from './version.js'\nexport * as vscode from './vscode.js'\nexport * as yaml from './yaml.js'\nexport * as outputMocker from './testing/output.js'\nexport * as metadata from './metadata.js'\nexport * as monorail from './monorail.js'\n"]}

package/dist/metadata.d.ts

@@ -1,9 +1,12 @@
 import { AnyJson } from './json.js';
+import { PickByPrefix } from './typing/pick-by-prefix.js';
+declare type ProvideMetadata<T> = () => Partial<T> | Promise<Partial<T>>;
+declare type MetadataErrorHandling = 'auto' | 'mute-and-report' | 'bubble';
 export interface RuntimeMetadataManager<TPublic extends AnyJson, TSensitive extends AnyJson> {
     /** Add some public metadata -- this should not contain any PII */
-    addPublic: (data: Partial<TPublic>) => void;
+    addPublic: (getData: ProvideMetadata<TPublic>, onError?: MetadataErrorHandling) => Promise<void>;
     /** Add some potentially sensitive metadata -- this may include PII, but unnecessary data should never be tracked (this is a good fit for command args for instance) */
-    addSensitive: (data: Partial<TSensitive>) => void;
+    addSensitive: (getData: ProvideMetadata<TSensitive>, onError?: MetadataErrorHandling) => Promise<void>;
     /** Get a snapshot of the tracked public data */
     getAllPublic: () => Partial<TPublic>;
     /** Get a snapshot of the tracked sensitive data */
@@ -20,32 +23,197 @@ export declare type SensitiveSchema<T> = T extends RuntimeMetadataManager<infer
 export declare function createRuntimeMetadataContainer<TPublic extends AnyJson, TSensitive extends AnyJson = {
     [key: string]: never;
 }>(): RuntimeMetadataManager<TPublic, TSensitive>;
-declare const coreData: RuntimeMetadataManager<{
-    placeholder: string;
-}, {
+declare const coreData: RuntimeMetadataManager<PickByPrefix<import("./typing/deep-required.js").DeepRequired<{
+    partner_id?: (number | null) | undefined;
+    command: string;
+    project_type?: (string | null) | undefined;
+    time_start: number;
+    time_end: number;
+    total_time: number;
+    success: boolean;
+    api_key?: (string | null) | undefined;
+    cli_version: string;
+    uname: string;
+    ruby_version: string;
+    node_version: string;
+    is_employee: boolean;
+    cmd_all_alias_used?: (string | null) | undefined;
+    cmd_all_launcher?: (string | null) | undefined;
+    cmd_all_path_override?: (boolean | null) | undefined;
+    cmd_all_path_override_hash?: (string | null) | undefined;
+    cmd_all_plugin?: (string | null) | undefined;
+    cmd_all_topic?: (string | null) | undefined;
+    cmd_all_verbose?: (boolean | null) | undefined;
+    cmd_extensions_binary_from_source?: (boolean | null) | undefined;
+    cmd_scaffold_required_auth?: (boolean | null) | undefined;
+    cmd_scaffold_template_custom?: (boolean | null) | undefined;
+    cmd_scaffold_template_flavor?: (string | null) | undefined;
+    cmd_scaffold_type?: (string | null) | undefined;
+    cmd_scaffold_type_category?: (string | null) | undefined;
+    cmd_scaffold_type_gated?: (boolean | null) | undefined;
+    cmd_scaffold_type_owner?: (string | null) | undefined;
+    cmd_scaffold_used_prompts_for_type?: (boolean | null) | undefined;
+    app_extensions_any?: (boolean | null) | undefined;
+    app_extensions_breakdown?: (string | null) | undefined;
+    app_extensions_count?: (number | null) | undefined;
+    app_extensions_custom_layout?: (boolean | null) | undefined;
+    app_extensions_function_any?: (boolean | null) | undefined;
+    app_extensions_function_count?: (number | null) | undefined;
+    app_extensions_function_custom_layout?: (boolean | null) | undefined;
+    app_extensions_theme_any?: (boolean | null) | undefined;
+    app_extensions_theme_count?: (number | null) | undefined;
+    app_extensions_theme_custom_layout?: (boolean | null) | undefined;
+    app_extensions_ui_any?: (boolean | null) | undefined;
+    app_extensions_ui_count?: (number | null) | undefined;
+    app_extensions_ui_custom_layout?: (boolean | null) | undefined;
+    app_name_hash?: (string | null) | undefined;
+    app_path_hash?: (string | null) | undefined;
+    app_scopes?: (string | null) | undefined;
+    app_web_backend_any?: (boolean | null) | undefined;
+    app_web_backend_count?: (number | null) | undefined;
+    app_web_custom_layout?: (boolean | null) | undefined;
+    app_web_frontend_any?: (boolean | null) | undefined;
+    app_web_frontend_count?: (number | null) | undefined;
+    env_ci?: (boolean | null) | undefined;
+    env_ci_platform?: (string | null) | undefined;
+    env_plugin_installed_any_custom?: (boolean | null) | undefined;
+    env_plugin_installed_shopify?: (string | null) | undefined;
+    env_shell?: (string | null) | undefined;
+    env_web_ide?: (string | null) | undefined;
+}>, "cmd_all_", never>, {
     commandStartOptions: {
         startTime: number;
         startCommand: string;
         startArgs: string[];
     };
 }>;
-export declare const getAllPublic: () => Partial<{
-    placeholder: string;
-}>, getAllSensitive: () => Partial<{
+export declare const getAllPublic: () => Partial<PickByPrefix<import("./typing/deep-required.js").DeepRequired<{
+    partner_id?: (number | null) | undefined;
+    command: string;
+    project_type?: (string | null) | undefined;
+    time_start: number;
+    time_end: number;
+    total_time: number;
+    success: boolean;
+    api_key?: (string | null) | undefined;
+    cli_version: string;
+    uname: string;
+    ruby_version: string;
+    node_version: string;
+    is_employee: boolean;
+    cmd_all_alias_used?: (string | null) | undefined;
+    cmd_all_launcher?: (string | null) | undefined;
+    cmd_all_path_override?: (boolean | null) | undefined;
+    cmd_all_path_override_hash?: (string | null) | undefined;
+    cmd_all_plugin?: (string | null) | undefined;
+    cmd_all_topic?: (string | null) | undefined;
+    cmd_all_verbose?: (boolean | null) | undefined;
+    cmd_extensions_binary_from_source?: (boolean | null) | undefined;
+    cmd_scaffold_required_auth?: (boolean | null) | undefined;
+    cmd_scaffold_template_custom?: (boolean | null) | undefined;
+    cmd_scaffold_template_flavor?: (string | null) | undefined;
+    cmd_scaffold_type?: (string | null) | undefined;
+    cmd_scaffold_type_category?: (string | null) | undefined;
+    cmd_scaffold_type_gated?: (boolean | null) | undefined;
+    cmd_scaffold_type_owner?: (string | null) | undefined;
+    cmd_scaffold_used_prompts_for_type?: (boolean | null) | undefined;
+    app_extensions_any?: (boolean | null) | undefined;
+    app_extensions_breakdown?: (string | null) | undefined;
+    app_extensions_count?: (number | null) | undefined;
+    app_extensions_custom_layout?: (boolean | null) | undefined;
+    app_extensions_function_any?: (boolean | null) | undefined;
+    app_extensions_function_count?: (number | null) | undefined;
+    app_extensions_function_custom_layout?: (boolean | null) | undefined;
+    app_extensions_theme_any?: (boolean | null) | undefined;
+    app_extensions_theme_count?: (number | null) | undefined;
+    app_extensions_theme_custom_layout?: (boolean | null) | undefined;
+    app_extensions_ui_any?: (boolean | null) | undefined;
+    app_extensions_ui_count?: (number | null) | undefined;
+    app_extensions_ui_custom_layout?: (boolean | null) | undefined;
+    app_name_hash?: (string | null) | undefined;
+    app_path_hash?: (string | null) | undefined;
+    app_scopes?: (string | null) | undefined;
+    app_web_backend_any?: (boolean | null) | undefined;
+    app_web_backend_count?: (number | null) | undefined;
+    app_web_custom_layout?: (boolean | null) | undefined;
+    app_web_frontend_any?: (boolean | null) | undefined;
+    app_web_frontend_count?: (number | null) | undefined;
+    env_ci?: (boolean | null) | undefined;
+    env_ci_platform?: (string | null) | undefined;
+    env_plugin_installed_any_custom?: (boolean | null) | undefined;
+    env_plugin_installed_shopify?: (string | null) | undefined;
+    env_shell?: (string | null) | undefined;
+    env_web_ide?: (string | null) | undefined;
+}>, "cmd_all_", never>>, getAllSensitive: () => Partial<{
     commandStartOptions: {
         startTime: number;
         startCommand: string;
         startArgs: string[];
     };
-}>, addPublic: (data: Partial<{
-    placeholder: string;
-}>) => void, addSensitive: (data: Partial<{
+}>, addPublic: (getData: ProvideMetadata<PickByPrefix<import("./typing/deep-required.js").DeepRequired<{
+    partner_id?: (number | null) | undefined;
+    command: string;
+    project_type?: (string | null) | undefined;
+    time_start: number;
+    time_end: number;
+    total_time: number;
+    success: boolean;
+    api_key?: (string | null) | undefined;
+    cli_version: string;
+    uname: string;
+    ruby_version: string;
+    node_version: string;
+    is_employee: boolean;
+    cmd_all_alias_used?: (string | null) | undefined;
+    cmd_all_launcher?: (string | null) | undefined;
+    cmd_all_path_override?: (boolean | null) | undefined;
+    cmd_all_path_override_hash?: (string | null) | undefined;
+    cmd_all_plugin?: (string | null) | undefined;
+    cmd_all_topic?: (string | null) | undefined;
+    cmd_all_verbose?: (boolean | null) | undefined;
+    cmd_extensions_binary_from_source?: (boolean | null) | undefined;
+    cmd_scaffold_required_auth?: (boolean | null) | undefined;
+    cmd_scaffold_template_custom?: (boolean | null) | undefined;
+    cmd_scaffold_template_flavor?: (string | null) | undefined;
+    cmd_scaffold_type?: (string | null) | undefined;
+    cmd_scaffold_type_category?: (string | null) | undefined;
+    cmd_scaffold_type_gated?: (boolean | null) | undefined;
+    cmd_scaffold_type_owner?: (string | null) | undefined;
+    cmd_scaffold_used_prompts_for_type?: (boolean | null) | undefined;
+    app_extensions_any?: (boolean | null) | undefined;
+    app_extensions_breakdown?: (string | null) | undefined;
+    app_extensions_count?: (number | null) | undefined;
+    app_extensions_custom_layout?: (boolean | null) | undefined;
+    app_extensions_function_any?: (boolean | null) | undefined;
+    app_extensions_function_count?: (number | null) | undefined;
+    app_extensions_function_custom_layout?: (boolean | null) | undefined;
+    app_extensions_theme_any?: (boolean | null) | undefined;
+    app_extensions_theme_count?: (number | null) | undefined;
+    app_extensions_theme_custom_layout?: (boolean | null) | undefined;
+    app_extensions_ui_any?: (boolean | null) | undefined;
+    app_extensions_ui_count?: (number | null) | undefined;
+    app_extensions_ui_custom_layout?: (boolean | null) | undefined;
+    app_name_hash?: (string | null) | undefined;
+    app_path_hash?: (string | null) | undefined;
+    app_scopes?: (string | null) | undefined;
+    app_web_backend_any?: (boolean | null) | undefined;
+    app_web_backend_count?: (number | null) | undefined;
+    app_web_custom_layout?: (boolean | null) | undefined;
+    app_web_frontend_any?: (boolean | null) | undefined;
+    app_web_frontend_count?: (number | null) | undefined;
+    env_ci?: (boolean | null) | undefined;
+    env_ci_platform?: (string | null) | undefined;
+    env_plugin_installed_any_custom?: (boolean | null) | undefined;
+    env_plugin_installed_shopify?: (string | null) | undefined;
+    env_shell?: (string | null) | undefined;
+    env_web_ide?: (string | null) | undefined;
+}>, "cmd_all_", never>>, onError?: MetadataErrorHandling) => Promise<void>, addSensitive: (getData: ProvideMetadata<{
     commandStartOptions: {
         startTime: number;
         startCommand: string;
         startArgs: string[];
     };
-}>) => void;
+}>, onError?: MetadataErrorHandling) => Promise<void>;
 export declare type Public = PublicSchema<typeof coreData>;
 export declare type Sensitive = SensitiveSchema<typeof coreData>;
 export {};

package/dist/metadata.js

@@ -1,3 +1,11 @@
+import { isUnitTest } from './environment/local.js';
+import { sendErrorToBugsnag } from './node/error-handler.js';
+function getMetadataErrorHandlingStrategy() {
+    if (isUnitTest()) {
+        return 'bubble';
+    }
+    return 'mute-and-report';
+}
 /**
  * Creates a container for metadata collected at runtime.
  *
@@ -9,19 +17,44 @@ export function createRuntimeMetadataContainer() {
         sensitive: {},
         public: {},
     };
+    const addPublic = (data) => {
+        Object.assign(raw.public, data);
+    };
+    const addSensitive = (data) => {
+        Object.assign(raw.sensitive, data);
+    };
+    const addMetadata = async (addFn, getFn, onError) => {
+        const errorHandling = onError === 'auto' ? getMetadataErrorHandlingStrategy() : onError;
+        const getAndSet = async () => {
+            const data = await getFn();
+            addFn(data);
+        };
+        if (errorHandling === 'bubble') {
+            await getAndSet();
+        }
+        else {
+            try {
+                await getAndSet();
+                // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any
+            }
+            catch (error) {
+                await sendErrorToBugsnag(error);
+            }
+        }
+    };
     return {
-        addPublic: (data) => {
-            Object.assign(raw.public, data);
-        },
-        addSensitive: (data) => {
-            Object.assign(raw.sensitive, data);
-        },
         getAllPublic: () => {
             return { ...raw.public };
         },
         getAllSensitive: () => {
             return { ...raw.sensitive };
         },
+        addPublic: async (getData, onError = 'auto') => {
+            return addMetadata(addPublic, getData, onError);
+        },
+        addSensitive: async (getData, onError = 'auto') => {
+            return addMetadata(addSensitive, getData, onError);
+        },
     };
 }
 const coreData = createRuntimeMetadataContainer();

package/dist/metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAgBA;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B;IAI5C,MAAM,GAAG,GAA+D;QACtE,SAAS,EAAE,EAAE;QACb,MAAM,EAAE,EAAE;KACX,CAAA;IACD,OAAO;QACL,SAAS,EAAE,CAAC,IAAsB,EAAE,EAAE;YACpC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QACjC,CAAC;QACD,YAAY,EAAE,CAAC,IAAyB,EAAE,EAAE;YAC1C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;QACpC,CAAC;QACD,YAAY,EAAE,GAAG,EAAE;YACjB,OAAO,EAAC,GAAG,GAAG,CAAC,MAAM,EAAC,CAAA;QACxB,CAAC;QACD,eAAe,EAAE,GAAG,EAAE;YACpB,OAAO,EAAC,GAAG,GAAG,CAAC,SAAS,EAAC,CAAA;QAC3B,CAAC;KACF,CAAA;AACH,CAAC;AAED,MAAM,QAAQ,GAAG,8BAA8B,EAS5C,CAAA;AAEH,MAAM,CAAC,MAAM,EAAC,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,YAAY,EAAC,GAAG,QAAQ,CAAA","sourcesContent":["import {AnyJson} from './json.js'\n\nexport interface RuntimeMetadataManager<TPublic extends AnyJson, TSensitive extends AnyJson> {\n  /** Add some public metadata -- this should not contain any PII */\n  addPublic: (data: Partial<TPublic>) => void\n  /** Add some potentially sensitive metadata -- this may include PII, but unnecessary data should never be tracked (this is a good fit for command args for instance) */\n  addSensitive: (data: Partial<TSensitive>) => void\n  /** Get a snapshot of the tracked public data */\n  getAllPublic: () => Partial<TPublic>\n  /** Get a snapshot of the tracked sensitive data */\n  getAllSensitive: () => Partial<TSensitive>\n}\n\nexport type PublicSchema<T> = T extends RuntimeMetadataManager<infer TPublic, infer _TSensitive> ? TPublic : never\nexport type SensitiveSchema<T> = T extends RuntimeMetadataManager<infer _TPublic, infer TSensitive> ? TSensitive : never\n\n/**\n * Creates a container for metadata collected at runtime.\n *\n * The container provides async-safe functions for extracting the gathered metadata, and for setting it.\n *\n */\nexport function createRuntimeMetadataContainer<\n  TPublic extends AnyJson,\n  TSensitive extends AnyJson = {[key: string]: never},\n>(): RuntimeMetadataManager<TPublic, TSensitive> {\n  const raw: {sensitive: Partial<TSensitive>; public: Partial<TPublic>} = {\n    sensitive: {},\n    public: {},\n  }\n  return {\n    addPublic: (data: Partial<TPublic>) => {\n      Object.assign(raw.public, data)\n    },\n    addSensitive: (data: Partial<TSensitive>) => {\n      Object.assign(raw.sensitive, data)\n    },\n    getAllPublic: () => {\n      return {...raw.public}\n    },\n    getAllSensitive: () => {\n      return {...raw.sensitive}\n    },\n  }\n}\n\nconst coreData = createRuntimeMetadataContainer<\n  {placeholder: string},\n  {\n    commandStartOptions: {\n      startTime: number\n      startCommand: string\n      startArgs: string[]\n    }\n  }\n>()\n\nexport const {getAllPublic, getAllSensitive, addPublic, addSensitive} = coreData\n\nexport type Public = PublicSchema<typeof coreData>\nexport type Sensitive = SensitiveSchema<typeof coreData>\n"]}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AAGjD,OAAO,EAAC,kBAAkB,EAAC,MAAM,yBAAyB,CAAA;AAa1D,SAAS,gCAAgC;IACvC,IAAI,UAAU,EAAE,EAAE;QAChB,OAAO,QAAQ,CAAA;KAChB;IACD,OAAO,iBAAiB,CAAA;AAC1B,CAAC;AAgBD;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B;IAI5C,MAAM,GAAG,GAA+D;QACtE,SAAS,EAAE,EAAE;QACb,MAAM,EAAE,EAAE;KACX,CAAA;IACD,MAAM,SAAS,GAAG,CAAC,IAAsB,EAAE,EAAE;QAC3C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACjC,CAAC,CAAA;IACD,MAAM,YAAY,GAAG,CAAC,IAAyB,EAAE,EAAE;QACjD,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;IACpC,CAAC,CAAA;IAED,MAAM,WAAW,GAAG,KAAK,EACvB,KAAiC,EACjC,KAAyB,EACzB,OAA8B,EAC9B,EAAE;QACF,MAAM,aAAa,GAAG,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,gCAAgC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAA;QACvF,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAI,GAAG,MAAM,KAAK,EAAE,CAAA;YAC1B,KAAK,CAAC,IAAI,CAAC,CAAA;QACb,CAAC,CAAA;QAED,IAAI,aAAa,KAAK,QAAQ,EAAE;YAC9B,MAAM,SAAS,EAAE,CAAA;SAClB;aAAM;YACL,IAAI;gBACF,MAAM,SAAS,EAAE,CAAA;gBACjB,yFAAyF;aAC1F;YAAC,OAAO,KAAU,EAAE;gBACnB,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAA;aAChC;SACF;IACH,CAAC,CAAA;IAED,OAAO;QACL,YAAY,EAAE,GAAG,EAAE;YACjB,OAAO,EAAC,GAAG,GAAG,CAAC,MAAM,EAAC,CAAA;QACxB,CAAC;QACD,eAAe,EAAE,GAAG,EAAE;YACpB,OAAO,EAAC,GAAG,GAAG,CAAC,SAAS,EAAC,CAAA;QAC3B,CAAC;QACD,SAAS,EAAE,KAAK,EAAE,OAAiC,EAAE,UAAiC,MAAM,EAAE,EAAE;YAC9F,OAAO,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QACjD,CAAC;QACD,YAAY,EAAE,KAAK,EAAE,OAAoC,EAAE,UAAiC,MAAM,EAAE,EAAE;YACpG,OAAO,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QACpD,CAAC;KACF,CAAA;AACH,CAAC;AAKD,MAAM,QAAQ,GAAG,8BAA8B,EAS5C,CAAA;AAEH,MAAM,CAAC,MAAM,EAAC,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,YAAY,EAAC,GAAG,QAAQ,CAAA","sourcesContent":["import {isUnitTest} from './environment/local.js'\nimport {AnyJson} from './json.js'\nimport {MonorailEventPublic} from './monorail.js'\nimport {sendErrorToBugsnag} from './node/error-handler.js'\nimport {PickByPrefix} from './typing/pick-by-prefix.js'\n\ntype ProvideMetadata<T> = () => Partial<T> | Promise<Partial<T>>\n\ntype MetadataErrorHandling =\n  // Mute & report errors in production, throw them whilst testing\n  | 'auto'\n  // Errors are not reported to the user and do not stop execution, but they are reported to Bugsnag\n  | 'mute-and-report'\n  // Errors are not caught and will bubble out as normal\n  | 'bubble'\n\nfunction getMetadataErrorHandlingStrategy(): 'mute-and-report' | 'bubble' {\n  if (isUnitTest()) {\n    return 'bubble'\n  }\n  return 'mute-and-report'\n}\n\nexport interface RuntimeMetadataManager<TPublic extends AnyJson, TSensitive extends AnyJson> {\n  /** Add some public metadata -- this should not contain any PII */\n  addPublic: (getData: ProvideMetadata<TPublic>, onError?: MetadataErrorHandling) => Promise<void>\n  /** Add some potentially sensitive metadata -- this may include PII, but unnecessary data should never be tracked (this is a good fit for command args for instance) */\n  addSensitive: (getData: ProvideMetadata<TSensitive>, onError?: MetadataErrorHandling) => Promise<void>\n  /** Get a snapshot of the tracked public data */\n  getAllPublic: () => Partial<TPublic>\n  /** Get a snapshot of the tracked sensitive data */\n  getAllSensitive: () => Partial<TSensitive>\n}\n\nexport type PublicSchema<T> = T extends RuntimeMetadataManager<infer TPublic, infer _TSensitive> ? TPublic : never\nexport type SensitiveSchema<T> = T extends RuntimeMetadataManager<infer _TPublic, infer TSensitive> ? TSensitive : never\n\n/**\n * Creates a container for metadata collected at runtime.\n *\n * The container provides async-safe functions for extracting the gathered metadata, and for setting it.\n *\n */\nexport function createRuntimeMetadataContainer<\n  TPublic extends AnyJson,\n  TSensitive extends AnyJson = {[key: string]: never},\n>(): RuntimeMetadataManager<TPublic, TSensitive> {\n  const raw: {sensitive: Partial<TSensitive>; public: Partial<TPublic>} = {\n    sensitive: {},\n    public: {},\n  }\n  const addPublic = (data: Partial<TPublic>) => {\n    Object.assign(raw.public, data)\n  }\n  const addSensitive = (data: Partial<TSensitive>) => {\n    Object.assign(raw.sensitive, data)\n  }\n\n  const addMetadata = async <T>(\n    addFn: (data: Partial<T>) => void,\n    getFn: ProvideMetadata<T>,\n    onError: MetadataErrorHandling,\n  ) => {\n    const errorHandling = onError === 'auto' ? getMetadataErrorHandlingStrategy() : onError\n    const getAndSet = async () => {\n      const data = await getFn()\n      addFn(data)\n    }\n\n    if (errorHandling === 'bubble') {\n      await getAndSet()\n    } else {\n      try {\n        await getAndSet()\n        // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any\n      } catch (error: any) {\n        await sendErrorToBugsnag(error)\n      }\n    }\n  }\n\n  return {\n    getAllPublic: () => {\n      return {...raw.public}\n    },\n    getAllSensitive: () => {\n      return {...raw.sensitive}\n    },\n    addPublic: async (getData: ProvideMetadata<TPublic>, onError: MetadataErrorHandling = 'auto') => {\n      return addMetadata(addPublic, getData, onError)\n    },\n    addSensitive: async (getData: ProvideMetadata<TSensitive>, onError: MetadataErrorHandling = 'auto') => {\n      return addMetadata(addSensitive, getData, onError)\n    },\n  }\n}\n\n// We want to track anything that ends up getting sent to monorail as `cmd_all_*`\ntype CmdFieldsFromMonorail = PickByPrefix<MonorailEventPublic, 'cmd_all_'>\n\nconst coreData = createRuntimeMetadataContainer<\n  CmdFieldsFromMonorail,\n  {\n    commandStartOptions: {\n      startTime: number\n      startCommand: string\n      startArgs: string[]\n    }\n  }\n>()\n\nexport const {getAllPublic, getAllSensitive, addPublic, addSensitive} = coreData\n\nexport type Public = PublicSchema<typeof coreData>\nexport type Sensitive = SensitiveSchema<typeof coreData>\n"]}

package/dist/monorail.d.ts

@@ -1,7 +1,9 @@
 import { JsonMap } from './json.js';
+import { DeepRequired } from './typing/deep-required.js';
 declare type Optional<T> = T | null;
+export declare const MONORAIL_COMMAND_TOPIC: "app_cli3_command/1.1";
 export interface Schemas {
-    'app_cli3_command/1.0': {
+    [MONORAIL_COMMAND_TOPIC]: {
         sensitive: {
             args: string;
             error_message?: Optional<string>;
@@ -21,6 +23,49 @@ export interface Schemas {
             ruby_version: string;
             node_version: string;
             is_employee: boolean;
+            cmd_all_alias_used?: Optional<string>;
+            cmd_all_launcher?: Optional<string>;
+            cmd_all_path_override?: Optional<boolean>;
+            cmd_all_path_override_hash?: Optional<string>;
+            cmd_all_plugin?: Optional<string>;
+            cmd_all_topic?: Optional<string>;
+            cmd_all_verbose?: Optional<boolean>;
+            cmd_extensions_binary_from_source?: Optional<boolean>;
+            cmd_scaffold_required_auth?: Optional<boolean>;
+            cmd_scaffold_template_custom?: Optional<boolean>;
+            cmd_scaffold_template_flavor?: Optional<string>;
+            cmd_scaffold_type?: Optional<string>;
+            cmd_scaffold_type_category?: Optional<string>;
+            cmd_scaffold_type_gated?: Optional<boolean>;
+            cmd_scaffold_type_owner?: Optional<string>;
+            cmd_scaffold_used_prompts_for_type?: Optional<boolean>;
+            app_extensions_any?: Optional<boolean>;
+            app_extensions_breakdown?: Optional<string>;
+            app_extensions_count?: Optional<number>;
+            app_extensions_custom_layout?: Optional<boolean>;
+            app_extensions_function_any?: Optional<boolean>;
+            app_extensions_function_count?: Optional<number>;
+            app_extensions_function_custom_layout?: Optional<boolean>;
+            app_extensions_theme_any?: Optional<boolean>;
+            app_extensions_theme_count?: Optional<number>;
+            app_extensions_theme_custom_layout?: Optional<boolean>;
+            app_extensions_ui_any?: Optional<boolean>;
+            app_extensions_ui_count?: Optional<number>;
+            app_extensions_ui_custom_layout?: Optional<boolean>;
+            app_name_hash?: Optional<string>;
+            app_path_hash?: Optional<string>;
+            app_scopes?: Optional<string>;
+            app_web_backend_any?: Optional<boolean>;
+            app_web_backend_count?: Optional<number>;
+            app_web_custom_layout?: Optional<boolean>;
+            app_web_frontend_any?: Optional<boolean>;
+            app_web_frontend_count?: Optional<number>;
+            env_ci?: Optional<boolean>;
+            env_ci_platform?: Optional<string>;
+            env_plugin_installed_any_custom?: Optional<boolean>;
+            env_plugin_installed_shopify?: Optional<string>;
+            env_shell?: Optional<string>;
+            env_web_ide?: Optional<string>;
         };
     };
     [schemaId: string]: {
@@ -28,6 +73,8 @@ export interface Schemas {
         public: JsonMap;
     };
 }
+export declare type MonorailEventPublic = DeepRequired<Schemas[typeof MONORAIL_COMMAND_TOPIC]['public']>;
+export declare type MonorailEventSensitive = Schemas[typeof MONORAIL_COMMAND_TOPIC]['sensitive'];
 declare type MonorailResult = {
     type: 'ok';
 } | {

package/dist/monorail.js

@@ -1,7 +1,8 @@
-/* eslint-disable @typescript-eslint/naming-convention */
 import { fetch } from './http.js';
 import { debug, content, token } from './output.js';
 const url = 'https://monorail-edge.shopifysvc.com/v1/produce';
+// This is the topic name of the main event we log to Monorail, the command tracker
+export const MONORAIL_COMMAND_TOPIC = 'app_cli3_command/1.1';
 export async function publishEvent(schemaId, publicData, sensitiveData) {
     try {
         const currentTime = new Date().getTime();

package/dist/monorail.js.map

@@ -1 +1 @@
-{"version":3,"file":"monorail.js","sourceRoot":"","sources":["../src/monorail.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,MAAM,aAAa,CAAA;AAGjD,MAAM,GAAG,GAAG,iDAAiD,CAAA;AA4B7D,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAmB,EACnB,UAA8B,EAC9B,aAAoC;IAEpC,IAAI;QACF,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QACxC,MAAM,OAAO,GAAG,EAAC,GAAG,UAAU,EAAE,GAAG,aAAa,EAAC,CAAA;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAA;QAC3D,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAEzC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAC,CAAC,CAAA;QAElE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,KAAK,CAAC,OAAO,CAAA,yBAAyB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC5D,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAA;SACpB;aAAM;YACL,KAAK,CAAC,qCAAqC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;YACjE,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAC,CAAA;SACrD;QACD,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,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAC,CAAA;KAChC;AACH,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC3C,OAAO;QACL,cAAc,EAAE,iCAAiC;QACjD,qCAAqC,EAAE,WAAW,CAAC,QAAQ,EAAE;QAC7D,kCAAkC,EAAE,WAAW,CAAC,QAAQ,EAAE;KAC3D,CAAA;AACH,CAAC,CAAA","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport {fetch} from './http.js'\nimport {debug, content, token} from './output.js'\nimport {JsonMap} from './json.js'\n\nconst url = 'https://monorail-edge.shopifysvc.com/v1/produce'\n\ntype Optional<T> = T | null\n\nexport interface Schemas {\n  'app_cli3_command/1.0': {\n    sensitive: {args: string; error_message?: Optional<string>; metadata?: Optional<string>}\n    public: {\n      partner_id?: Optional<number>\n      command: string\n      project_type?: Optional<string>\n      time_start: number\n      time_end: number\n      total_time: number\n      success: boolean\n      api_key?: Optional<string>\n      cli_version: string\n      uname: string\n      ruby_version: string\n      node_version: string\n      is_employee: boolean\n    }\n  }\n  [schemaId: string]: {sensitive: JsonMap; public: JsonMap}\n}\n\ntype MonorailResult = {type: 'ok'} | {type: 'error'; message: string}\n\nexport async function publishEvent<TSchemaId extends keyof Schemas, TPayload extends Schemas[TSchemaId]>(\n  schemaId: TSchemaId,\n  publicData: TPayload['public'],\n  sensitiveData: TPayload['sensitive'],\n): Promise<MonorailResult> {\n  try {\n    const currentTime = new Date().getTime()\n    const payload = {...publicData, ...sensitiveData}\n    const body = JSON.stringify({schema_id: schemaId, payload})\n    const headers = buildHeaders(currentTime)\n\n    const response = await fetch(url, {method: 'POST', body, headers})\n\n    if (response.status === 200) {\n      debug(content`Analytics event sent: ${token.json(payload)}`)\n      return {type: 'ok'}\n    } else {\n      debug(`Failed to report usage analytics: ${response.statusText}`)\n      return {type: 'error', message: response.statusText}\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    debug(message)\n    return {type: 'error', message}\n  }\n}\n\nconst buildHeaders = (currentTime: number) => {\n  return {\n    'Content-Type': 'application/json; charset=utf-8',\n    'X-Monorail-Edge-Event-Created-At-Ms': currentTime.toString(),\n    'X-Monorail-Edge-Event-Sent-At-Ms': currentTime.toString(),\n  }\n}\n"]}
+{"version":3,"file":"monorail.js","sourceRoot":"","sources":["../src/monorail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,MAAM,aAAa,CAAA;AAIjD,MAAM,GAAG,GAAG,iDAAiD,CAAA;AAI7D,mFAAmF;AACnF,MAAM,CAAC,MAAM,sBAAsB,GAAG,sBAA+B,CAAA;AAoFrE,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAmB,EACnB,UAA8B,EAC9B,aAAoC;IAEpC,IAAI;QACF,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QACxC,MAAM,OAAO,GAAG,EAAC,GAAG,UAAU,EAAE,GAAG,aAAa,EAAC,CAAA;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAA;QAC3D,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAEzC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAC,CAAC,CAAA;QAElE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,KAAK,CAAC,OAAO,CAAA,yBAAyB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC5D,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAA;SACpB;aAAM;YACL,KAAK,CAAC,qCAAqC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;YACjE,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAC,CAAA;SACrD;QACD,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,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAC,CAAA;KAChC;AACH,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC3C,OAAO;QACL,cAAc,EAAE,iCAAiC;QACjD,qCAAqC,EAAE,WAAW,CAAC,QAAQ,EAAE;QAC7D,kCAAkC,EAAE,WAAW,CAAC,QAAQ,EAAE;KAC3D,CAAA;AACH,CAAC,CAAA","sourcesContent":["import {fetch} from './http.js'\nimport {debug, content, token} from './output.js'\nimport {JsonMap} from './json.js'\nimport {DeepRequired} from './typing/deep-required.js'\n\nconst url = 'https://monorail-edge.shopifysvc.com/v1/produce'\n\ntype Optional<T> = T | null\n\n// This is the topic name of the main event we log to Monorail, the command tracker\nexport const MONORAIL_COMMAND_TOPIC = 'app_cli3_command/1.1' as const\n\nexport interface Schemas {\n  [MONORAIL_COMMAND_TOPIC]: {\n    sensitive: {args: string; error_message?: Optional<string>; metadata?: Optional<string>}\n    public: {\n      partner_id?: Optional<number>\n      command: string\n      project_type?: Optional<string>\n      time_start: number\n      time_end: number\n      total_time: number\n      success: boolean\n      api_key?: Optional<string>\n      cli_version: string\n      uname: string\n      ruby_version: string\n      node_version: string\n      is_employee: boolean\n\n      // Any and all commands\n      cmd_all_alias_used?: Optional<string>\n      cmd_all_launcher?: Optional<string>\n      cmd_all_path_override?: Optional<boolean>\n      cmd_all_path_override_hash?: Optional<string>\n      cmd_all_plugin?: Optional<string>\n      cmd_all_topic?: Optional<string>\n      cmd_all_verbose?: Optional<boolean>\n\n      // Any extension related command\n      cmd_extensions_binary_from_source?: Optional<boolean>\n\n      // Scaffolding related commands\n      cmd_scaffold_required_auth?: Optional<boolean>\n      cmd_scaffold_template_custom?: Optional<boolean>\n      cmd_scaffold_template_flavor?: Optional<string>\n      cmd_scaffold_type?: Optional<string>\n      cmd_scaffold_type_category?: Optional<string>\n      cmd_scaffold_type_gated?: Optional<boolean>\n      cmd_scaffold_type_owner?: Optional<string>\n      cmd_scaffold_used_prompts_for_type?: Optional<boolean>\n\n      // App setup\n      app_extensions_any?: Optional<boolean>\n      app_extensions_breakdown?: Optional<string>\n      app_extensions_count?: Optional<number>\n      app_extensions_custom_layout?: Optional<boolean>\n      app_extensions_function_any?: Optional<boolean>\n      app_extensions_function_count?: Optional<number>\n      app_extensions_function_custom_layout?: Optional<boolean>\n      app_extensions_theme_any?: Optional<boolean>\n      app_extensions_theme_count?: Optional<number>\n      app_extensions_theme_custom_layout?: Optional<boolean>\n      app_extensions_ui_any?: Optional<boolean>\n      app_extensions_ui_count?: Optional<number>\n      app_extensions_ui_custom_layout?: Optional<boolean>\n      app_name_hash?: Optional<string>\n      app_path_hash?: Optional<string>\n      app_scopes?: Optional<string>\n      app_web_backend_any?: Optional<boolean>\n      app_web_backend_count?: Optional<number>\n      app_web_custom_layout?: Optional<boolean>\n      app_web_frontend_any?: Optional<boolean>\n      app_web_frontend_count?: Optional<number>\n\n      // Environment\n      env_ci?: Optional<boolean>\n      env_ci_platform?: Optional<string>\n      env_plugin_installed_any_custom?: Optional<boolean>\n      env_plugin_installed_shopify?: Optional<string>\n      env_shell?: Optional<string>\n      env_web_ide?: Optional<string>\n    }\n  }\n  [schemaId: string]: {sensitive: JsonMap; public: JsonMap}\n}\n\n// In reality, we're normally most interested in just this from Schemas, so export it for ease of use.\n// The monorail schema itself has lots of optional values as it must be backwards-compatible. For our schema we want mandatory values instead.\nexport type MonorailEventPublic = DeepRequired<Schemas[typeof MONORAIL_COMMAND_TOPIC]['public']>\nexport type MonorailEventSensitive = Schemas[typeof MONORAIL_COMMAND_TOPIC]['sensitive']\n\ntype MonorailResult = {type: 'ok'} | {type: 'error'; message: string}\n\nexport async function publishEvent<TSchemaId extends keyof Schemas, TPayload extends Schemas[TSchemaId]>(\n  schemaId: TSchemaId,\n  publicData: TPayload['public'],\n  sensitiveData: TPayload['sensitive'],\n): Promise<MonorailResult> {\n  try {\n    const currentTime = new Date().getTime()\n    const payload = {...publicData, ...sensitiveData}\n    const body = JSON.stringify({schema_id: schemaId, payload})\n    const headers = buildHeaders(currentTime)\n\n    const response = await fetch(url, {method: 'POST', body, headers})\n\n    if (response.status === 200) {\n      debug(content`Analytics event sent: ${token.json(payload)}`)\n      return {type: 'ok'}\n    } else {\n      debug(`Failed to report usage analytics: ${response.statusText}`)\n      return {type: 'error', message: response.statusText}\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    debug(message)\n    return {type: 'error', message}\n  }\n}\n\nconst buildHeaders = (currentTime: number) => {\n  return {\n    'Content-Type': 'application/json; charset=utf-8',\n    'X-Monorail-Edge-Event-Created-At-Ms': currentTime.toString(),\n    'X-Monorail-Edge-Event-Sent-At-Ms': currentTime.toString(),\n  }\n}\n"]}

package/dist/node/archiver.js

@@ -27,6 +27,7 @@ export async function zip(inputDirectory, outputZipPath) {
             const fileRelativePath = relativePath(inputDirectory, filePath);
             archive.file(filePath, { name: fileRelativePath });
         }
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         archive.finalize();
     });
 }

package/dist/node/archiver.js.map

@@ -1 +1 @@
-{"version":3,"file":"archiver.js","sourceRoot":"","sources":["../../src/node/archiver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AAClD,OAAO,EAAC,IAAI,EAAE,QAAQ,IAAI,YAAY,EAAC,MAAM,YAAY,CAAA;AACzD,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,iBAAiB,EAAC,MAAM,SAAS,CAAA;AACzC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,cAAsB,EAAE,aAAqB;IACrE,KAAK,CAAC,OAAO,CAAA,WAAW,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAA;IACvF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,EAAC,GAAG,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAC,CAAC,CAAA;IACnH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC/B,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAA;QAE/C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;YACjB,OAAO,EAAE,CAAA;QACX,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK;YACjC,MAAM,CAAC,KAAK,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEpB,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;YACjC,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;YAC/D,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;SACjD;QAED,OAAO,CAAC,QAAQ,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {debug, content, token} from '../output.js'\nimport {glob, relative as relativePath} from '../path.js'\nimport archiver from 'archiver'\nimport {createWriteStream} from 'node:fs'\n/**\n * It zips a directory normalizing the paths to be forward-slash. Note that unzipping\n * the zip generated by this function from a Windows environment won't work because paths\n * need to be made backward-slash.\n *\n * @param inputDirectory {string} The absolute path to the directory to be zipped.\n * @param outputZipPath {string} The absolute path to the output zip file.\n */\nexport async function zip(inputDirectory: string, outputZipPath: string): Promise<void> {\n  debug(content`Zipping ${token.path(inputDirectory)} into ${token.path(outputZipPath)}`)\n  const pathsToZip = await glob('**/*', {cwd: inputDirectory, absolute: true, dot: true, followSymbolicLinks: false})\n  return new Promise((resolve, reject) => {\n    const archive = archiver('zip')\n    const output = createWriteStream(outputZipPath)\n\n    output.on('close', function () {\n      resolve()\n    })\n    archive.on('error', function (error) {\n      reject(error)\n    })\n    archive.pipe(output)\n\n    for (const filePath of pathsToZip) {\n      const fileRelativePath = relativePath(inputDirectory, filePath)\n      archive.file(filePath, {name: fileRelativePath})\n    }\n\n    archive.finalize()\n  })\n}\n"]}
+{"version":3,"file":"archiver.js","sourceRoot":"","sources":["../../src/node/archiver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AAClD,OAAO,EAAC,IAAI,EAAE,QAAQ,IAAI,YAAY,EAAC,MAAM,YAAY,CAAA;AACzD,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,iBAAiB,EAAC,MAAM,SAAS,CAAA;AACzC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,cAAsB,EAAE,aAAqB;IACrE,KAAK,CAAC,OAAO,CAAA,WAAW,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAA;IACvF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,EAAC,GAAG,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAC,CAAC,CAAA;IACnH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC/B,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAA;QAE/C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;YACjB,OAAO,EAAE,CAAA;QACX,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK;YACjC,MAAM,CAAC,KAAK,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEpB,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;YACjC,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;YAC/D,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;SACjD;QAED,mEAAmE;QACnE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {debug, content, token} from '../output.js'\nimport {glob, relative as relativePath} from '../path.js'\nimport archiver from 'archiver'\nimport {createWriteStream} from 'node:fs'\n/**\n * It zips a directory normalizing the paths to be forward-slash. Note that unzipping\n * the zip generated by this function from a Windows environment won't work because paths\n * need to be made backward-slash.\n *\n * @param inputDirectory {string} The absolute path to the directory to be zipped.\n * @param outputZipPath {string} The absolute path to the output zip file.\n */\nexport async function zip(inputDirectory: string, outputZipPath: string): Promise<void> {\n  debug(content`Zipping ${token.path(inputDirectory)} into ${token.path(outputZipPath)}`)\n  const pathsToZip = await glob('**/*', {cwd: inputDirectory, absolute: true, dot: true, followSymbolicLinks: false})\n  return new Promise((resolve, reject) => {\n    const archive = archiver('zip')\n    const output = createWriteStream(outputZipPath)\n\n    output.on('close', function () {\n      resolve()\n    })\n    archive.on('error', function (error) {\n      reject(error)\n    })\n    archive.pipe(output)\n\n    for (const filePath of pathsToZip) {\n      const fileRelativePath = relativePath(inputDirectory, filePath)\n      archive.file(filePath, {name: fileRelativePath})\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\n    archive.finalize()\n  })\n}\n"]}

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

@@ -1,7 +1,17 @@
-import { Command } from '@oclif/core';
+import { Command, Interfaces } from '@oclif/core';
 export default abstract class extends Command {
     catch(error: Error & {
         exitCode?: number | undefined;
     }): Promise<void>;
     protected init(): Promise<any>;
+    protected parse<TFlags extends {
+        path?: string;
+        verbose?: boolean;
+    }, TArgs extends {
+        [name: string]: any;
+    }>(options?: Interfaces.Input<TFlags> | undefined, argv?: string[] | undefined): Promise<Interfaces.ParserOutput<TFlags, TArgs>>;
 }
+export declare function addFromParsedFlags(flags: {
+    path?: string;
+    verbose?: boolean;
+}): Promise<void>;

package/dist/node/base-command.js

@@ -1,18 +1,33 @@
 import { errorHandler, registerCleanBugsnagErrorsFromWithinPlugins } from './error-handler.js';
-import { isDebug } from '../environment/local.js';
+import { isDevelopment } from '../environment/local.js';
+import { addPublic } from '../metadata.js';
+import { hashString } from '../string.js';
 import { Command } from '@oclif/core';
 // eslint-disable-next-line import/no-anonymous-default-export
 export default class extends Command {
     async catch(error) {
-        errorHandler(error, this.config);
+        await errorHandler(error, this.config);
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     async init() {
-        if (!isDebug()) {
+        if (!isDevelopment()) {
             // This function runs just prior to `run`
-            registerCleanBugsnagErrorsFromWithinPlugins(this.config.plugins);
+            await registerCleanBugsnagErrorsFromWithinPlugins(this.config);
         }
         return super.init();
     }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async parse(options, argv) {
+        const result = await super.parse(options, argv);
+        await addFromParsedFlags(result.flags);
+        return result;
+    }
+}
+export async function addFromParsedFlags(flags) {
+    await addPublic(() => ({
+        cmd_all_verbose: flags.verbose,
+        cmd_all_path_override: flags.path !== undefined,
+        cmd_all_path_override_hash: flags.path === undefined ? undefined : hashString(flags.path),
+    }));
 }
 //# sourceMappingURL=base-command.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"base-command.js","sourceRoot":"","sources":["../../src/node/base-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,2CAA2C,EAAC,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EAAC,OAAO,EAAC,MAAM,yBAAyB,CAAA;AAC/C,OAAO,EAAC,OAAO,EAAC,MAAM,aAAa,CAAA;AAEnC,8DAA8D;AAC9D,MAAM,CAAC,OAAO,MAAgB,SAAQ,OAAO;IAC3C,KAAK,CAAC,KAAK,CAAC,KAA8C;QACxD,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;IAED,8DAA8D;IACpD,KAAK,CAAC,IAAI;QAClB,IAAI,CAAC,OAAO,EAAE,EAAE;YACd,yCAAyC;YACzC,2CAA2C,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;SACjE;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;CACF","sourcesContent":["import {errorHandler, registerCleanBugsnagErrorsFromWithinPlugins} from './error-handler.js'\nimport {isDebug} from '../environment/local.js'\nimport {Command} from '@oclif/core'\n\n// eslint-disable-next-line import/no-anonymous-default-export\nexport default abstract class extends Command {\n  async catch(error: Error & {exitCode?: number | undefined}) {\n    errorHandler(error, this.config)\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  protected async init(): Promise<any> {\n    if (!isDebug()) {\n      // This function runs just prior to `run`\n      registerCleanBugsnagErrorsFromWithinPlugins(this.config.plugins)\n    }\n    return super.init()\n  }\n}\n"]}
+{"version":3,"file":"base-command.js","sourceRoot":"","sources":["../../src/node/base-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,2CAA2C,EAAC,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAA;AACrD,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAA;AACxC,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAA;AACvC,OAAO,EAAC,OAAO,EAAa,MAAM,aAAa,CAAA;AAE/C,8DAA8D;AAC9D,MAAM,CAAC,OAAO,MAAgB,SAAQ,OAAO;IAC3C,KAAK,CAAC,KAAK,CAAC,KAA8C;QACxD,MAAM,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACxC,CAAC;IAED,8DAA8D;IACpD,KAAK,CAAC,IAAI;QAClB,IAAI,CAAC,aAAa,EAAE,EAAE;YACpB,yCAAyC;YACzC,MAAM,2CAA2C,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;SAC/D;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;IAED,8DAA8D;IACpD,KAAK,CAAC,KAAK,CACnB,OAA8C,EAC9C,IAA2B;QAE3B,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAgB,OAAO,EAAE,IAAI,CAAC,CAAA;QAC9D,MAAM,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACtC,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAyC;IAChF,MAAM,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC;QACrB,eAAe,EAAE,KAAK,CAAC,OAAO;QAC9B,qBAAqB,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS;QAC/C,0BAA0B,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC;KAC1F,CAAC,CAAC,CAAA;AACL,CAAC","sourcesContent":["import {errorHandler, registerCleanBugsnagErrorsFromWithinPlugins} from './error-handler.js'\nimport {isDevelopment} from '../environment/local.js'\nimport {addPublic} from '../metadata.js'\nimport {hashString} from '../string.js'\nimport {Command, Interfaces} from '@oclif/core'\n\n// eslint-disable-next-line import/no-anonymous-default-export\nexport default abstract class extends Command {\n  async catch(error: Error & {exitCode?: number | undefined}) {\n    await errorHandler(error, this.config)\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  protected async init(): Promise<any> {\n    if (!isDevelopment()) {\n      // This function runs just prior to `run`\n      await registerCleanBugsnagErrorsFromWithinPlugins(this.config)\n    }\n    return super.init()\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  protected async parse<TFlags extends {path?: string; verbose?: boolean}, TArgs extends {[name: string]: any}>(\n    options?: Interfaces.Input<TFlags> | undefined,\n    argv?: string[] | undefined,\n  ): Promise<Interfaces.ParserOutput<TFlags, TArgs>> {\n    const result = await super.parse<TFlags, TArgs>(options, argv)\n    await addFromParsedFlags(result.flags)\n    return result\n  }\n}\n\nexport async function addFromParsedFlags(flags: {path?: string; verbose?: boolean}) {\n  await addPublic(() => ({\n    cmd_all_verbose: flags.verbose,\n    cmd_all_path_override: flags.path !== undefined,\n    cmd_all_path_override_hash: flags.path === undefined ? undefined : hashString(flags.path),\n  }))\n}\n"]}

package/dist/node/cli.js

@@ -1,7 +1,7 @@
 // CLI
 import { findUpAndReadPackageJson } from './node-package-manager.js';
 import { errorHandler } from './error-handler.js';
-import { isDebug } from '../environment/local.js';
+import { isDevelopment } from '../environment/local.js';
 import constants, { bugsnagApiKey } from '../constants.js';
 import { moduleDirectory } from '../path.js';
 import { run, settings, flush } from '@oclif/core';
@@ -12,7 +12,7 @@ import Bugsnag from '@bugsnag/js';
  * @param module {RunCLIOptions} Options.
  */
 export async function runCLI(options) {
-    if (isDebug()) {
+    if (isDevelopment()) {
         settings.debug = true;
     }
     else {

package/dist/node/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/node/cli.ts"],"names":[],"mappings":"AAAA,MAAM;AACN,OAAO,EAAC,wBAAwB,EAAC,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAC,OAAO,EAAC,MAAM,yBAAyB,CAAA;AAC/C,OAAO,SAAS,EAAE,EAAC,aAAa,EAAC,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAC,eAAe,EAAC,MAAM,YAAY,CAAA;AAC1C,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAC,MAAM,aAAa,CAAA;AAChD,OAAO,OAAO,MAAM,aAAa,CAAA;AAOjC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAsB;IACjD,IAAI,OAAO,EAAE,EAAE;QACb,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAA;KACtB;SAAM;QACL,OAAO,CAAC,KAAK,CAAC;YACZ,OAAO,EAAE,MAAM;YACf,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;YAC7C,iBAAiB,EAAE,KAAK;YACxB,gBAAgB,EAAE,KAAK;SACxB,CAAC,CAAA;KACH;IAED,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB;IACvD,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IACtF,8DAA8D;IAC9D,MAAM,WAAW,GAAI,WAAW,CAAC,OAAe,CAAC,IAAc,CAAA;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACvE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;QACpB,MAAM,SAAS,GACb,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACtG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAC1C;IACD,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;AACvB,CAAC;AAED,eAAe,MAAM,CAAA","sourcesContent":["// CLI\nimport {findUpAndReadPackageJson} from './node-package-manager.js'\nimport {errorHandler} from './error-handler.js'\nimport {isDebug} from '../environment/local.js'\nimport constants, {bugsnagApiKey} from '../constants.js'\nimport {moduleDirectory} from '../path.js'\nimport {run, settings, flush} from '@oclif/core'\nimport Bugsnag from '@bugsnag/js'\n\ninterface RunCLIOptions {\n  /** The value of import.meta.url of the CLI executable module */\n  moduleURL: string\n}\n\n/**\n * A function that abstracts away setting up the environment and running\n * a CLI\n * @param module {RunCLIOptions} Options.\n */\nexport async function runCLI(options: RunCLIOptions) {\n  if (isDebug()) {\n    settings.debug = true\n  } else {\n    Bugsnag.start({\n      appType: 'node',\n      apiKey: bugsnagApiKey,\n      logger: null,\n      appVersion: await constants.versions.cliKit(),\n      autoTrackSessions: false,\n      autoDetectErrors: false,\n    })\n  }\n\n  run(undefined, options.moduleURL).then(flush).catch(errorHandler)\n}\n\n/**\n * A function for create-x CLIs that automatically runs the \"init\" command.\n * @param options\n */\nexport async function runCreateCLI(options: RunCLIOptions) {\n  const packageJson = await findUpAndReadPackageJson(moduleDirectory(options.moduleURL))\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const packageName = (packageJson.content as any).name as string\n  const name = packageName.replace('@shopify/create-', '')\n  const initIndex = process.argv.findIndex((arg) => arg.includes('init'))\n  if (initIndex === -1) {\n    const initIndex =\n      process.argv.findIndex((arg) => arg.match(new RegExp(`bin(\\\\/|\\\\\\\\)+(create-${name}|dev|run)`))) + 1\n    process.argv.splice(initIndex, 0, 'init')\n  }\n  await runCLI(options)\n}\n\nexport default runCLI\n"]}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/node/cli.ts"],"names":[],"mappings":"AAAA,MAAM;AACN,OAAO,EAAC,wBAAwB,EAAC,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAA;AACrD,OAAO,SAAS,EAAE,EAAC,aAAa,EAAC,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAC,eAAe,EAAC,MAAM,YAAY,CAAA;AAC1C,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAC,MAAM,aAAa,CAAA;AAChD,OAAO,OAAO,MAAM,aAAa,CAAA;AAOjC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAsB;IACjD,IAAI,aAAa,EAAE,EAAE;QACnB,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAA;KACtB;SAAM;QACL,OAAO,CAAC,KAAK,CAAC;YACZ,OAAO,EAAE,MAAM;YACf,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;YAC7C,iBAAiB,EAAE,KAAK;YACxB,gBAAgB,EAAE,KAAK;SACxB,CAAC,CAAA;KACH;IAED,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB;IACvD,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IACtF,8DAA8D;IAC9D,MAAM,WAAW,GAAI,WAAW,CAAC,OAAe,CAAC,IAAc,CAAA;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACvE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;QACpB,MAAM,SAAS,GACb,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACtG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAA;KAC1C;IACD,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;AACvB,CAAC;AAED,eAAe,MAAM,CAAA","sourcesContent":["// CLI\nimport {findUpAndReadPackageJson} from './node-package-manager.js'\nimport {errorHandler} from './error-handler.js'\nimport {isDevelopment} from '../environment/local.js'\nimport constants, {bugsnagApiKey} from '../constants.js'\nimport {moduleDirectory} from '../path.js'\nimport {run, settings, flush} from '@oclif/core'\nimport Bugsnag from '@bugsnag/js'\n\ninterface RunCLIOptions {\n  /** The value of import.meta.url of the CLI executable module */\n  moduleURL: string\n}\n\n/**\n * A function that abstracts away setting up the environment and running\n * a CLI\n * @param module {RunCLIOptions} Options.\n */\nexport async function runCLI(options: RunCLIOptions) {\n  if (isDevelopment()) {\n    settings.debug = true\n  } else {\n    Bugsnag.start({\n      appType: 'node',\n      apiKey: bugsnagApiKey,\n      logger: null,\n      appVersion: await constants.versions.cliKit(),\n      autoTrackSessions: false,\n      autoDetectErrors: false,\n    })\n  }\n\n  run(undefined, options.moduleURL).then(flush).catch(errorHandler)\n}\n\n/**\n * A function for create-x CLIs that automatically runs the \"init\" command.\n * @param options\n */\nexport async function runCreateCLI(options: RunCLIOptions) {\n  const packageJson = await findUpAndReadPackageJson(moduleDirectory(options.moduleURL))\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const packageName = (packageJson.content as any).name as string\n  const name = packageName.replace('@shopify/create-', '')\n  const initIndex = process.argv.findIndex((arg) => arg.includes('init'))\n  if (initIndex === -1) {\n    const initIndex =\n      process.argv.findIndex((arg) => arg.match(new RegExp(`bin(\\\\/|\\\\\\\\)+(create-${name}|dev|run)`))) + 1\n    process.argv.splice(initIndex, 0, 'init')\n  }\n  await runCLI(options)\n}\n\nexport default runCLI\n"]}

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

@@ -31,3 +31,12 @@ export declare function readAndParseDotEnv(path: string): Promise<DotEnvFile>;
  * @param file {DotEnvFile} .env file to be written.
  */
 export declare function writeDotEnv(file: DotEnvFile): Promise<void>;
+/**
+ * Given an .env file content, generates a new one with new values
+ * without removing already existing lines.
+ * @param envFileContent {string | null} .env file contents.
+ * @param updatedValues {[key: string]: string}} object containing new env variables values.
+ */
+export declare function patchEnvFile(envFileContent: string | null, updatedValues: {
+    [key: string]: string;
+}): string;

package/dist/node/dot-env.js

@@ -33,4 +33,35 @@ export async function readAndParseDotEnv(path) {
 export async function writeDotEnv(file) {
     await writeFile(file.path, stringify(file.variables));
 }
+/**
+ * Given an .env file content, generates a new one with new values
+ * without removing already existing lines.
+ * @param envFileContent {string | null} .env file contents.
+ * @param updatedValues {[key: string]: string}} object containing new env variables values.
+ */
+export function patchEnvFile(envFileContent, updatedValues) {
+    const outputLines = [];
+    const lines = envFileContent === null ? [] : envFileContent.split('\n');
+    const alreadyPresentKeys = [];
+    const toLine = (key, value) => `${key}=${value}`;
+    for (const line of lines) {
+        const match = line.match(/^([^=:#]+?)[=:](.*)/);
+        let lineToWrite = line;
+        if (match) {
+            const key = match[1].trim();
+            const newValue = updatedValues[key];
+            if (newValue) {
+                alreadyPresentKeys.push(key);
+                lineToWrite = toLine(key, newValue);
+            }
+        }
+        outputLines.push(lineToWrite);
+    }
+    for (const [patchKey, updatedValue] of Object.entries(updatedValues)) {
+        if (!alreadyPresentKeys.includes(patchKey)) {
+            outputLines.push(toLine(patchKey, updatedValue));
+        }
+    }
+    return outputLines.join('\n');
+}
 //# sourceMappingURL=dot-env.js.map