@shopify/cli-kit 0.0.0-nightly-20230110194301

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+export { default as constants } from './constants.js';
+export * as api from './api.js';
+export * as cli from './cli.js';
+export * as environment from './environment.js';
+export * as error from './error.js';
+export * as file from './file.js';
+export * as git from './git.js';
+export * as http from './http.js';
+export * as npm from './npm.js';
+export * as output from './output.js';
+export * as path from './path.js';
+export * as plugins from './plugins.js';
+export * as schema from './schema.js';
+export * as session from './session.js';
+export * as store from './store.js';
+export * as string from './string.js';
+export * as system from './system.js';
+export * as template from './template.js';
+export * as toml from './toml.js';
+export * as ui from './ui.js';
+export * as vscode from './vscode.js';
+export * as outputMocker from './testing/output.js';
+export * as metadata from './metadata.js';
+export * as monorail from './monorail.js';

package/dist/index.js

@@ -0,0 +1,25 @@
+export { default as constants } from './constants.js';
+export * as api from './api.js';
+export * as cli from './cli.js';
+export * as environment from './environment.js';
+export * as error from './error.js';
+export * as file from './file.js';
+export * as git from './git.js';
+export * as http from './http.js';
+export * as npm from './npm.js';
+export * as output from './output.js';
+export * as path from './path.js';
+export * as plugins from './plugins.js';
+export * as schema from './schema.js';
+export * as session from './session.js';
+export * as store from './store.js';
+export * as string from './string.js';
+export * as system from './system.js';
+export * as template from './template.js';
+export * as toml from './toml.js';
+export * as ui from './ui.js';
+export * as vscode from './vscode.js';
+export * as outputMocker from './testing/output.js';
+export * as metadata from './metadata.js';
+export * as monorail from './monorail.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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,GAAG,MAAM,UAAU,CAAA;AAC/B,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,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,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,MAAM,MAAM,aAAa,CAAA;AACrC,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 api from './api.js'\nexport * as cli from './cli.js'\nexport * as environment from './environment.js'\nexport * as error from './error.js'\nexport * as file from './file.js'\nexport * as git from './git.js'\nexport * as http from './http.js'\nexport * as npm from './npm.js'\nexport * as output from './output.js'\nexport * as path from './path.js'\nexport * as plugins from './plugins.js'\nexport * as schema from './schema.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 vscode from './vscode.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

@@ -0,0 +1,53 @@
+import { AnyJson } from './private/common/json.js';
+import { MonorailEventPublic } from './monorail.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: (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: (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 */
+    getAllSensitive: () => Partial<TSensitive>;
+}
+export declare type PublicSchema<T> = T extends RuntimeMetadataManager<infer TPublic, infer _TSensitive> ? TPublic : never;
+export declare type SensitiveSchema<T> = T extends RuntimeMetadataManager<infer _TPublic, infer TSensitive> ? TSensitive : never;
+/**
+ * Creates a container for metadata collected at runtime.
+ *
+ * The container provides async-safe functions for extracting the gathered metadata, and for setting it.
+ *
+ */
+export declare function createRuntimeMetadataContainer<TPublic extends AnyJson, TSensitive extends AnyJson = {
+    [key: string]: never;
+}>(): RuntimeMetadataManager<TPublic, TSensitive>;
+declare type CmdFieldsFromMonorail = PickByPrefix<MonorailEventPublic, 'cmd_all_'> & PickByPrefix<MonorailEventPublic, 'cmd_app_'>;
+declare const coreData: RuntimeMetadataManager<CmdFieldsFromMonorail, {
+    commandStartOptions: {
+        startTime: number;
+        startCommand: string;
+        startTopic?: string;
+        startArgs: string[];
+    };
+}>;
+export declare const getAllPublic: () => Partial<CmdFieldsFromMonorail>, getAllSensitive: () => Partial<{
+    commandStartOptions: {
+        startTime: number;
+        startCommand: string;
+        startTopic?: string;
+        startArgs: string[];
+    };
+}>, addPublic: (getData: ProvideMetadata<CmdFieldsFromMonorail>, onError?: MetadataErrorHandling) => Promise<void>, addSensitive: (getData: ProvideMetadata<{
+    commandStartOptions: {
+        startTime: number;
+        startCommand: string;
+        startTopic?: string;
+        startArgs: string[];
+    };
+}>, onError?: MetadataErrorHandling) => Promise<void>;
+export declare type Public = PublicSchema<typeof coreData>;
+export declare type Sensitive = SensitiveSchema<typeof coreData>;
+export {};

package/dist/metadata.js

@@ -0,0 +1,62 @@
+import { isUnitTest } from './environment/local.js';
+import { sendErrorToBugsnag } from './public/node/error-handler.js';
+function getMetadataErrorHandlingStrategy() {
+    if (isUnitTest()) {
+        return 'bubble';
+    }
+    return 'mute-and-report';
+}
+/**
+ * Creates a container for metadata collected at runtime.
+ *
+ * The container provides async-safe functions for extracting the gathered metadata, and for setting it.
+ *
+ */
+export function createRuntimeMetadataContainer() {
+    const raw = {
+        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 {
+        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();
+export const { getAllPublic, getAllSensitive, addPublic, addSensitive } = coreData;
+//# sourceMappingURL=metadata.js.map

package/dist/metadata.js.map

@@ -0,0 +1 @@
+{"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,gCAAgC,CAAA;AAajE,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;AAOD,MAAM,QAAQ,GAAG,8BAA8B,EAU5C,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 './private/common/json.js'\nimport {MonorailEventPublic} from './monorail.js'\nimport {sendErrorToBugsnag} from './public/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_*` and\n// `cmd_app_*`\ntype CmdFieldsFromMonorail = PickByPrefix<MonorailEventPublic, 'cmd_all_'> &\n  PickByPrefix<MonorailEventPublic, 'cmd_app_'>\n\nconst coreData = createRuntimeMetadataContainer<\n  CmdFieldsFromMonorail,\n  {\n    commandStartOptions: {\n      startTime: number\n      startCommand: string\n      startTopic?: 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

@@ -0,0 +1,100 @@
+import { JsonMap } from './private/common/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.2";
+export interface Schemas {
+    [MONORAIL_COMMAND_TOPIC]: {
+        sensitive: {
+            args: string;
+            error_message?: Optional<string>;
+            app_name?: Optional<string>;
+            metadata?: Optional<string>;
+            store_fqdn?: Optional<string>;
+            cmd_dev_tunnel_custom?: Optional<string>;
+            env_plugin_installed_all?: Optional<string>;
+        };
+        public: {
+            partner_id?: Optional<number>;
+            command: string;
+            project_type?: Optional<string>;
+            time_start: number;
+            time_end: number;
+            total_time: number;
+            success: boolean;
+            api_key?: Optional<string>;
+            cli_version: string;
+            uname: string;
+            ruby_version: string;
+            node_version: string;
+            is_employee: boolean;
+            store_fqdn_hash?: Optional<string>;
+            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>;
+            cmd_app_dependency_installation_skipped?: Optional<boolean>;
+            cmd_app_reset_used?: Optional<boolean>;
+            cmd_dev_tunnel_type?: Optional<string>;
+            cmd_dev_tunnel_custom_hash?: Optional<string>;
+            cmd_dev_urls_updated?: 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_framework?: Optional<string>;
+            app_web_frontend_any?: Optional<boolean>;
+            app_web_frontend_count?: Optional<number>;
+            env_ci?: Optional<boolean>;
+            env_ci_platform?: Optional<string>;
+            env_device_id?: Optional<string>;
+            env_package_manager?: Optional<string>;
+            env_package_manager_workspaces?: Optional<boolean>;
+            env_plugin_installed_any_custom?: Optional<boolean>;
+            env_plugin_installed_shopify?: Optional<string>;
+            env_shell?: Optional<string>;
+            env_web_ide?: Optional<string>;
+            env_cloud?: Optional<string>;
+        };
+    };
+    [schemaId: string]: {
+        sensitive: JsonMap;
+        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';
+} | {
+    type: 'error';
+    message: string;
+};
+export declare function publishEvent<TSchemaId extends keyof Schemas, TPayload extends Schemas[TSchemaId]>(schemaId: TSchemaId, publicData: TPayload['public'], sensitiveData: TPayload['sensitive']): Promise<MonorailResult>;
+export {};

package/dist/monorail.js

@@ -0,0 +1,39 @@
+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.2';
+export async function publishEvent(schemaId, publicData, sensitiveData) {
+    try {
+        const currentTime = new Date().getTime();
+        const payload = { ...publicData, ...sensitiveData };
+        const body = JSON.stringify({ schema_id: schemaId, payload });
+        const headers = buildHeaders(currentTime);
+        const response = await fetch(url, { method: 'POST', body, headers });
+        if (response.status === 200) {
+            debug(content `Analytics event sent: ${token.json(payload)}`);
+            return { type: 'ok' };
+        }
+        else {
+            debug(`Failed to report usage analytics: ${response.statusText}`);
+            return { type: 'error', message: response.statusText };
+        }
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch (error) {
+        let message = 'Failed to report usage analytics';
+        if (error instanceof Error) {
+            message = message.concat(`: ${error.message}`);
+        }
+        debug(message);
+        return { type: 'error', message };
+    }
+}
+const buildHeaders = (currentTime) => {
+    return {
+        'Content-Type': 'application/json; charset=utf-8',
+        'X-Monorail-Edge-Event-Created-At-Ms': currentTime.toString(),
+        'X-Monorail-Edge-Event-Sent-At-Ms': currentTime.toString(),
+    };
+};
+//# sourceMappingURL=monorail.js.map

package/dist/monorail.js.map

@@ -0,0 +1 @@
+{"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;AA+GrE,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 './private/common/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.2' as const\n\nexport interface Schemas {\n  [MONORAIL_COMMAND_TOPIC]: {\n    sensitive: {\n      args: string\n      error_message?: Optional<string>\n      app_name?: Optional<string>\n      metadata?: Optional<string>\n      store_fqdn?: Optional<string>\n\n      // Dev related commands\n      cmd_dev_tunnel_custom?: Optional<string>\n\n      // Environment\n      env_plugin_installed_all?: Optional<string>\n    }\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      store_fqdn_hash?: Optional<string>\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      // Used in several but not all commands\n      cmd_app_dependency_installation_skipped?: Optional<boolean>\n      cmd_app_reset_used?: Optional<boolean>\n\n      // Dev related commands\n      cmd_dev_tunnel_type?: Optional<string>\n      cmd_dev_tunnel_custom_hash?: Optional<string>\n      cmd_dev_urls_updated?: 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_framework?: Optional<string>\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_device_id?: Optional<string>\n      env_package_manager?: Optional<string>\n      env_package_manager_workspaces?: Optional<boolean>\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      env_cloud?: 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/network/api.d.ts

@@ -0,0 +1,2 @@
+export declare type API = 'admin' | 'storefront-renderer' | 'partners';
+export declare const allAPIs: API[];

package/dist/network/api.js

@@ -0,0 +1,2 @@
+export const allAPIs = ['admin', 'storefront-renderer', 'partners'];
+//# sourceMappingURL=api.js.map

package/dist/network/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/network/api.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,OAAO,GAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAA","sourcesContent":["export type API = 'admin' | 'storefront-renderer' | 'partners'\n\nexport const allAPIs: API[] = ['admin', 'storefront-renderer', 'partners']\n"]}

package/dist/network/service.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Enum for the differnet APIs the CLI can interact with.
+ * @readonly
+ */
+export declare type Service = 'shopify' | 'partners' | 'identity';
+/**
+ * Enum that represents the environment to use for a given service.
+ * @readonly
+ */
+export declare enum Environment {
+    Local = "local",
+    Production = "production",
+    Spin = "spin"
+}

package/dist/network/service.js

@@ -0,0 +1,11 @@
+/**
+ * Enum that represents the environment to use for a given service.
+ * @readonly
+ */
+export var Environment;
+(function (Environment) {
+    Environment["Local"] = "local";
+    Environment["Production"] = "production";
+    Environment["Spin"] = "spin";
+})(Environment || (Environment = {}));
+//# sourceMappingURL=service.js.map

package/dist/network/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/network/service.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,wCAAyB,CAAA;IACzB,4BAAa,CAAA;AACf,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB","sourcesContent":["/**\n * Enum for the differnet APIs the CLI can interact with.\n * @readonly\n */\nexport type Service = 'shopify' | 'partners' | 'identity'\n\n/**\n * Enum that represents the environment to use for a given service.\n * @readonly\n */\nexport enum Environment {\n  Local = 'local',\n  Production = 'production',\n  Spin = 'spin',\n}\n"]}

package/dist/npm.d.ts

@@ -0,0 +1,27 @@
+interface JSON {
+    [key: string]: JSONValue;
+}
+declare type JSONValue = string | number | boolean | JSON | JSONValue[];
+export interface PackageJSON extends JSON {
+    name: string;
+    author: string;
+    dependencies: {
+        [key: string]: string;
+    };
+    devDependencies: {
+        [key: string]: string;
+    };
+    resolutions: {
+        [key: string]: string;
+    };
+    overrides: {
+        [key: string]: string;
+    };
+    scripts: {
+        [key: string]: string;
+    };
+}
+export declare function readPackageJSON(directory: string): Promise<PackageJSON>;
+export declare function writePackageJSON(directory: string, packageJSON: JSON): Promise<void>;
+export declare function updateAppData(packageJSON: JSON, name: string): Promise<void>;
+export {};

package/dist/npm.js

@@ -0,0 +1,20 @@
+import { join } from './path.js';
+import * as file from './file.js';
+import * as os from './public/node/os.js';
+import { debug, token, content } from './output.js';
+export async function readPackageJSON(directory) {
+    debug(content `Reading and decoding the content from package.json at ${token.path(directory)}...`);
+    const packagePath = join(directory, 'package.json');
+    const packageJSON = JSON.parse(await file.read(packagePath));
+    return packageJSON;
+}
+export async function writePackageJSON(directory, packageJSON) {
+    debug(content `JSON-encoding and writing content to package.json at ${token.path(directory)}...`);
+    const packagePath = join(directory, 'package.json');
+    await file.write(packagePath, JSON.stringify(packageJSON, null, 2));
+}
+export async function updateAppData(packageJSON, name) {
+    packageJSON.name = name;
+    packageJSON.author = (await os.username()) ?? '';
+}
+//# sourceMappingURL=npm.js.map

package/dist/npm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"npm.js","sourceRoot":"","sources":["../src/npm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,qBAAqB,CAAA;AACzC,OAAO,EAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAC,MAAM,aAAa,CAAA;AAkBjD,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,SAAiB;IACrD,KAAK,CAAC,OAAO,CAAA,yDAAyD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACjG,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IACnD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAA;IAE5D,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,SAAiB,EAAE,WAAiB;IACzE,KAAK,CAAC,OAAO,CAAA,wDAAwD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAChG,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IACnD,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;AACrE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,WAAiB,EAAE,IAAY;IACjE,WAAW,CAAC,IAAI,GAAG,IAAI,CAAA;IACvB,WAAW,CAAC,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAA;AAClD,CAAC","sourcesContent":["import {join} from './path.js'\nimport * as file from './file.js'\nimport * as os from './public/node/os.js'\nimport {debug, token, content} from './output.js'\n\ninterface JSON {\n  [key: string]: JSONValue\n}\n\ntype JSONValue = string | number | boolean | JSON | JSONValue[]\n\nexport interface PackageJSON extends JSON {\n  name: string\n  author: string\n  dependencies: {[key: string]: string}\n  devDependencies: {[key: string]: string}\n  resolutions: {[key: string]: string}\n  overrides: {[key: string]: string}\n  scripts: {[key: string]: string}\n}\n\nexport async function readPackageJSON(directory: string): Promise<PackageJSON> {\n  debug(content`Reading and decoding the content from package.json at ${token.path(directory)}...`)\n  const packagePath = join(directory, 'package.json')\n  const packageJSON = JSON.parse(await file.read(packagePath))\n\n  return packageJSON\n}\n\nexport async function writePackageJSON(directory: string, packageJSON: JSON): Promise<void> {\n  debug(content`JSON-encoding and writing content to package.json at ${token.path(directory)}...`)\n  const packagePath = join(directory, 'package.json')\n  await file.write(packagePath, JSON.stringify(packageJSON, null, 2))\n}\n\nexport async function updateAppData(packageJSON: JSON, name: string): Promise<void> {\n  packageJSON.name = name\n  packageJSON.author = (await os.username()) ?? ''\n}\n"]}

package/dist/output.d.ts

@@ -0,0 +1,129 @@
+/// <reference types="node" />
+import { PackageManager } from './public/node/node-package-manager.js';
+import { ColorContentToken, CommandContentToken, ContentToken, ErrorContentToken, HeadingContentToken, ItalicContentToken, JsonContentToken, LinesDiffContentToken, LinkContentToken, PathContentToken, RawContentToken, SubHeadingContentToken } from './content-tokens.js';
+import { AbortSignal } from '@shopify/cli-kit/node/abort';
+import { Writable } from 'stream';
+import type { Change } from 'diff';
+export { default as logUpdate } from 'log-update';
+export declare type Logger = Writable | ((message: string) => void);
+export declare class TokenizedString {
+    value: string;
+    constructor(value: string);
+}
+export declare type Message = string | TokenizedString;
+export declare const token: {
+    raw: (value: string) => RawContentToken;
+    genericShellCommand: (value: Message) => CommandContentToken;
+    json: (value: any) => JsonContentToken;
+    path: (value: Message) => PathContentToken;
+    link: (value: Message, link: string) => LinkContentToken;
+    heading: (value: Message) => HeadingContentToken;
+    subheading: (value: Message) => SubHeadingContentToken;
+    italic: (value: Message) => ItalicContentToken;
+    errorText: (value: Message) => ErrorContentToken;
+    cyan: (value: Message) => ColorContentToken;
+    yellow: (value: Message) => ColorContentToken;
+    magenta: (value: Message) => ColorContentToken;
+    green: (value: Message) => ColorContentToken;
+    packagejsonScript: (packageManager: PackageManager, scriptName: string, ...scriptArgs: string[]) => CommandContentToken;
+    successIcon: () => ColorContentToken;
+    failIcon: () => ErrorContentToken;
+    linesDiff: (value: Change[]) => LinesDiffContentToken;
+};
+export declare function formatPackageManagerCommand(packageManager: PackageManager, scriptName: string, ...scriptArgs: string[]): string;
+export declare function content(strings: TemplateStringsArray, ...keys: (ContentToken<unknown> | string)[]): TokenizedString;
+/** Log levels */
+export declare type LogLevel = 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
+/**
+ *
+ * @returns It returns the log level set by the user.
+ */
+export declare const currentLogLevel: () => LogLevel;
+export declare const shouldOutput: (logLevel: LogLevel) => boolean;
+export declare let collectedLogs: {
+    [key: string]: string[];
+};
+/**
+ * This is only used during UnitTesting.
+ * If we are in a testing context, instead of printing the logs to the console,
+ * we will store them in a variable that can be accessed from the tests.
+ * @param key - The key of the log.
+ * @param content - The content of the log.
+ */
+export declare const collectLog: (key: string, content: Message) => void;
+export declare const clearCollectedLogs: () => void;
+/**
+ * Ouputs information to the user.
+ * Info messages don't get additional formatting.
+ * Note: Info messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export declare const info: (content: Message, logger?: Logger) => void;
+/**
+ * Outputs a success message to the user.
+ * Success messages receive a special formatting to make them stand out in the console.
+ * Note: Success messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export declare const success: (content: Message, logger?: Logger) => void;
+/**
+ * Outputs a completed message to the user.
+ * Completed message receive a special formatting to make them stand out in the console.
+ * Note: Completed messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export declare const completed: (content: Message, logger?: Logger) => void;
+/**
+ * Ouputs debug information to the user. By default these output is hidden unless the user calls the CLI with --verbose.
+ * Debug messages don't get additional formatting.
+ * Note: Debug messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export declare const debug: (content: Message, logger?: Logger) => void;
+/**
+ * Outputs a warning message to the user.
+ * Warning messages receive a special formatting to make them stand out in the console.
+ * Note: Warning messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export declare const warn: (content: Message, logger?: Logger) => void;
+/**
+ * Prints a new line in the terminal.
+ */
+export declare const newline: () => void;
+export declare function stringifyMessage(message: Message): string;
+export interface OutputProcess {
+    /** The prefix to include in the logs
+     *   [vite] Output coming from Vite
+     */
+    prefix: string;
+    /**
+     * A callback to invoke the process. stdout and stderr should be used
+     * to send standard output and error data that gets formatted with the
+     * right prefix.
+     */
+    action: (stdout: Writable, stderr: Writable, signal: AbortSignal) => Promise<void>;
+}
+export declare function consoleLog(message: string): void;
+export declare function consoleError(message: string): void;
+export declare function consoleWarn(message: string): void;
+export declare function outputWhereAppropriate(logLevel: LogLevel, logger: Logger, message: string): void;
+export declare function unstyled(message: string): string;
+export declare function shouldDisplayColors(): boolean;
+/**
+ * @param packageManager - The package manager that is being used.
+ * @param version - The version to update to
+ */
+export declare function getOutputUpdateCLIReminder(packageManager: PackageManager | 'unknown' | undefined, version: string): string;
+/**
+ * Parse title and body to be a single formatted string
+ * @param title - The title of the message. Will be formatted as a heading.
+ * @param body - The body of the message. Will respect the original formatting.
+ * @returns The formatted message.
+ */
+export declare function section(title: string, body: string): string;