@shopify/cli-kit 0.0.0-nightly-20230110194301

package/dist/public/common/lang.js

@@ -0,0 +1,22 @@
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+/**
+ * Performs a deep comparison between two values to determine if they are
+ * equivalent.
+ *
+ * **Note:** This method supports comparing arrays, array buffers, booleans,
+ * date objects, error objects, maps, numbers, `Object` objects, regexes,
+ * sets, strings, symbols, and typed arrays. `Object` objects are compared
+ * by their own, not inherited, enumerable properties. Functions and DOM
+ * nodes are **not** supported.
+ *
+ * @param value - The value to compare.
+ * @param other - The other value to compare.
+ * @returns Returns `true` if the values are equivalent, else `false`.
+ * @example
+ */
+export function isEqual(value, other) {
+    const lodashIsEqual = require('lodash/isEqual');
+    return lodashIsEqual(value, other);
+}
+//# sourceMappingURL=lang.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lang.js","sourceRoot":"","sources":["../../../src/public/common/lang.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAA;AAEpC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE9C;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,OAAO,CAAC,KAAc,EAAE,KAAc;IACpD,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAC/C,OAAO,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AACpC,CAAC","sourcesContent":["import {createRequire} from 'module'\n\nconst require = createRequire(import.meta.url)\n\n/**\n * Performs a deep comparison between two values to determine if they are\n * equivalent.\n *\n * **Note:** This method supports comparing arrays, array buffers, booleans,\n * date objects, error objects, maps, numbers, `Object` objects, regexes,\n * sets, strings, symbols, and typed arrays. `Object` objects are compared\n * by their own, not inherited, enumerable properties. Functions and DOM\n * nodes are **not** supported.\n *\n * @param value - The value to compare.\n * @param other - The other value to compare.\n * @returns Returns `true` if the values are equivalent, else `false`.\n * @example\n */\nexport function isEqual(value: unknown, other: unknown): boolean {\n  const lodashIsEqual = require('lodash/isEqual')\n  return lodashIsEqual(value, other)\n}\n"]}

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

@@ -0,0 +1,32 @@
+import { Dictionary, ObjectIterator, ValueKeyIteratee } from 'lodash';
+/**
+ * Deep merges the two objects and returns a new object with the merge result.
+ *
+ * @param lhs - One of the objects to be merged.
+ * @param rhs - Another object to be merged.
+ * @param arrayMergeStrategy - Strategy used to merge the array typed fields. Union strategy is used by default to avoid
+ * duplicated elements.
+ * @returns A Javascrip tobject with th emerged objects.
+ */
+export declare function deepMergeObjects<T1, T2>(lhs: Partial<T1>, rhs: Partial<T2>, arrayMergeStrategy?: (destinationArray: unknown[], sourceArray: unknown[]) => unknown[]): T1 & T2;
+/**
+ * Creates an object composed of the `object` properties `predicate` returns
+ * truthy for. The predicate is invoked with two arguments: (value, key).
+ *
+ * @param object-  The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
+ */
+export declare function pickBy<T, S extends T>(object: Dictionary<T> | null | undefined, predicate?: ValueKeyIteratee<T>): Dictionary<S>;
+/**
+ * Creates an object with the same keys as object and values generated by running each own
+ * enumerable property of object through iteratee. The iteratee function is
+ * invoked with three arguments: (value, key, object).
+ *
+ * @param object - The object to iterate over.
+ * @param callback -  The function invoked per iteration.
+ * @returns Returns the new mapped object.
+ */
+export declare function mapValues<T extends object, TResult>(obj: T | null | undefined, callback: ObjectIterator<T, TResult>): {
+    [P in keyof T]: TResult;
+};

package/dist/public/common/object.js

@@ -0,0 +1,45 @@
+import deepMerge from 'deepmerge';
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+/**
+ * Deep merges the two objects and returns a new object with the merge result.
+ *
+ * @param lhs - One of the objects to be merged.
+ * @param rhs - Another object to be merged.
+ * @param arrayMergeStrategy - Strategy used to merge the array typed fields. Union strategy is used by default to avoid
+ * duplicated elements.
+ * @returns A Javascrip tobject with th emerged objects.
+ */
+export function deepMergeObjects(lhs, rhs, arrayMergeStrategy = unionArrayStrategy) {
+    return deepMerge(lhs, rhs, { arrayMerge: arrayMergeStrategy });
+}
+function unionArrayStrategy(destinationArray, sourceArray) {
+    return Array.from(new Set([...destinationArray, ...sourceArray]));
+}
+/**
+ * Creates an object composed of the `object` properties `predicate` returns
+ * truthy for. The predicate is invoked with two arguments: (value, key).
+ *
+ * @param object-  The source object.
+ * @param predicate - The function invoked per property.
+ * @returns Returns the new object.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export function pickBy(object, predicate) {
+    const lodashPickBy = require('lodash/pickBy.js');
+    return lodashPickBy(object, predicate);
+}
+/**
+ * Creates an object with the same keys as object and values generated by running each own
+ * enumerable property of object through iteratee. The iteratee function is
+ * invoked with three arguments: (value, key, object).
+ *
+ * @param object - The object to iterate over.
+ * @param callback -  The function invoked per iteration.
+ * @returns Returns the new mapped object.
+ */
+export function mapValues(obj, callback) {
+    const lodashMapValues = require('lodash/mapValues.js');
+    return lodashMapValues(obj, callback);
+}
+//# sourceMappingURL=object.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/public/common/object.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAC,aAAa,EAAC,MAAM,QAAQ,CAAA;AAEpC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE9C;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,GAAgB,EAChB,GAAgB,EAChB,qBAAyF,kBAAkB;IAE3G,OAAO,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAC,UAAU,EAAE,kBAAkB,EAAC,CAAC,CAAA;AAC9D,CAAC;AAED,SAAS,kBAAkB,CAAC,gBAA2B,EAAE,WAAsB;IAC7E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;AACnE,CAAC;AAED;;;;;;;GAOG;AACH,gEAAgE;AAChE,MAAM,UAAU,MAAM,CACpB,MAAwC,EACxC,SAA+B;IAE/B,MAAM,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAChD,OAAO,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CACvB,GAAyB,EACzB,QAAoC;IAEpC,MAAM,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IACtD,OAAO,eAAe,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;AACvC,CAAC","sourcesContent":["import deepMerge from 'deepmerge'\nimport {Dictionary, ObjectIterator, ValueKeyIteratee} from 'lodash'\nimport {createRequire} from 'module'\n\nconst require = createRequire(import.meta.url)\n\n/**\n * Deep merges the two objects and returns a new object with the merge result.\n *\n * @param lhs - One of the objects to be merged.\n * @param rhs - Another object to be merged.\n * @param arrayMergeStrategy - Strategy used to merge the array typed fields. Union strategy is used by default to avoid\n * duplicated elements.\n * @returns A Javascrip tobject with th emerged objects.\n */\nexport function deepMergeObjects<T1, T2>(\n  lhs: Partial<T1>,\n  rhs: Partial<T2>,\n  arrayMergeStrategy: (destinationArray: unknown[], sourceArray: unknown[]) => unknown[] = unionArrayStrategy,\n): T1 & T2 {\n  return deepMerge(lhs, rhs, {arrayMerge: arrayMergeStrategy})\n}\n\nfunction unionArrayStrategy(destinationArray: unknown[], sourceArray: unknown[]): unknown[] {\n  return Array.from(new Set([...destinationArray, ...sourceArray]))\n}\n\n/**\n * Creates an object composed of the `object` properties `predicate` returns\n * truthy for. The predicate is invoked with two arguments: (value, key).\n *\n * @param object-  The source object.\n * @param predicate - The function invoked per property.\n * @returns Returns the new object.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport function pickBy<T, S extends T>(\n  object: Dictionary<T> | null | undefined,\n  predicate?: ValueKeyIteratee<T>,\n): Dictionary<S> {\n  const lodashPickBy = require('lodash/pickBy.js')\n  return lodashPickBy(object, predicate)\n}\n\n/**\n * Creates an object with the same keys as object and values generated by running each own\n * enumerable property of object through iteratee. The iteratee function is\n * invoked with three arguments: (value, key, object).\n *\n * @param object - The object to iterate over.\n * @param callback -  The function invoked per iteration.\n * @returns Returns the new mapped object.\n */\nexport function mapValues<T extends object, TResult>(\n  obj: T | null | undefined,\n  callback: ObjectIterator<T, TResult>,\n): {[P in keyof T]: TResult} {\n  const lodashMapValues = require('lodash/mapValues.js')\n  return lodashMapValues(obj, callback)\n}\n"]}

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

@@ -0,0 +1,6 @@
+export declare type RandomNameFamily = 'business' | 'creative';
+/**
+ * @param family - Theme to use for the random name
+ * @returns A random name generated by combining an adjective and noun.
+ */
+export declare function getRandomName(family?: RandomNameFamily): string;

package/dist/public/common/string.js

@@ -0,0 +1,109 @@
+import { takeRandomFromArray } from './array.js';
+const SAFE_RANDOM_BUSINESS_ADJECTIVES = [
+    'commercial',
+    'profitable',
+    'amortizable',
+    'branded',
+    'integrated',
+    'synergistic',
+    'consolidated',
+    'diversified',
+    'lean',
+    'niche',
+    'premium',
+    'luxury',
+    'scalable',
+    'optimized',
+    'empowered',
+    'international',
+    'beneficial',
+    'fruitful',
+    'extensive',
+    'lucrative',
+    'modern',
+];
+const SAFE_RANDOM_CREATIVE_ADJECTIVES = [
+    'bright',
+    'impactful',
+    'stylish',
+    'colorful',
+    'modern',
+    'minimal',
+    'trendy',
+    'creative',
+    'artistic',
+    'spectacular',
+    'glamorous',
+    'luxury',
+    'retro',
+    'nostalgic',
+    'comfy',
+    'polished',
+    'fabulous',
+    'balanced',
+    'monochrome',
+    'glitched',
+];
+const SAFE_RANDOM_BUSINESS_NOUNS = [
+    'account',
+    'consumer',
+    'customer',
+    'enterprise',
+    'business',
+    'venture',
+    'marketplace',
+    'revenue',
+    'vertical',
+    'portfolio',
+    'negotiation',
+    'shipping',
+    'demand',
+    'supply',
+    'growth',
+    'merchant',
+    'investment',
+    'shareholder',
+    'conversion',
+    'capital',
+    'projection',
+    'upside',
+    'trade',
+    'deal',
+    'merchandise',
+    'transaction',
+    'sale',
+];
+const SAFE_RANDOM_CREATIVE_NOUNS = [
+    'vibe',
+    'style',
+    'moment',
+    'mood',
+    'flavor',
+    'look',
+    'appearance',
+    'perspective',
+    'aspect',
+    'ambience',
+    'quality',
+    'backdrop',
+    'focus',
+    'tone',
+];
+/**
+ * @param family - Theme to use for the random name
+ * @returns A random name generated by combining an adjective and noun.
+ */
+export function getRandomName(family = 'business') {
+    const mapping = {
+        business: {
+            adjectives: SAFE_RANDOM_BUSINESS_ADJECTIVES,
+            nouns: SAFE_RANDOM_BUSINESS_NOUNS,
+        },
+        creative: {
+            adjectives: SAFE_RANDOM_CREATIVE_ADJECTIVES,
+            nouns: SAFE_RANDOM_CREATIVE_NOUNS,
+        },
+    };
+    return `${takeRandomFromArray(mapping[family].adjectives)}-${takeRandomFromArray(mapping[family].nouns)}`;
+}
+//# sourceMappingURL=string.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../src/public/common/string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,YAAY,CAAA;AAE9C,MAAM,+BAA+B,GAAG;IACtC,YAAY;IACZ,YAAY;IACZ,aAAa;IACb,SAAS;IACT,YAAY;IACZ,aAAa;IACb,cAAc;IACd,aAAa;IACb,MAAM;IACN,OAAO;IACP,SAAS;IACT,QAAQ;IACR,UAAU;IACV,WAAW;IACX,WAAW;IACX,eAAe;IACf,YAAY;IACZ,UAAU;IACV,WAAW;IACX,WAAW;IACX,QAAQ;CACT,CAAA;AAED,MAAM,+BAA+B,GAAG;IACtC,QAAQ;IACR,WAAW;IACX,SAAS;IACT,UAAU;IACV,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,UAAU;IACV,UAAU;IACV,aAAa;IACb,WAAW;IACX,QAAQ;IACR,OAAO;IACP,WAAW;IACX,OAAO;IACP,UAAU;IACV,UAAU;IACV,UAAU;IACV,YAAY;IACZ,UAAU;CACX,CAAA;AAED,MAAM,0BAA0B,GAAG;IACjC,SAAS;IACT,UAAU;IACV,UAAU;IACV,YAAY;IACZ,UAAU;IACV,SAAS;IACT,aAAa;IACb,SAAS;IACT,UAAU;IACV,WAAW;IACX,aAAa;IACb,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,SAAS;IACT,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,MAAM;IACN,aAAa;IACb,aAAa;IACb,MAAM;CACP,CAAA;AAED,MAAM,0BAA0B,GAAG;IACjC,MAAM;IACN,OAAO;IACP,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,MAAM;IACN,YAAY;IACZ,aAAa;IACb,QAAQ;IACR,UAAU;IACV,SAAS;IACT,UAAU;IACV,OAAO;IACP,MAAM;CACP,CAAA;AAID;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,SAA2B,UAAU;IACjE,MAAM,OAAO,GAAG;QACd,QAAQ,EAAE;YACR,UAAU,EAAE,+BAA+B;YAC3C,KAAK,EAAE,0BAA0B;SAClC;QACD,QAAQ,EAAE;YACR,UAAU,EAAE,+BAA+B;YAC3C,KAAK,EAAE,0BAA0B;SAClC;KACF,CAAA;IACD,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,EAAE,CAAA;AAC3G,CAAC","sourcesContent":["import {takeRandomFromArray} from './array.js'\n\nconst SAFE_RANDOM_BUSINESS_ADJECTIVES = [\n  'commercial',\n  'profitable',\n  'amortizable',\n  'branded',\n  'integrated',\n  'synergistic',\n  'consolidated',\n  'diversified',\n  'lean',\n  'niche',\n  'premium',\n  'luxury',\n  'scalable',\n  'optimized',\n  'empowered',\n  'international',\n  'beneficial',\n  'fruitful',\n  'extensive',\n  'lucrative',\n  'modern',\n]\n\nconst SAFE_RANDOM_CREATIVE_ADJECTIVES = [\n  'bright',\n  'impactful',\n  'stylish',\n  'colorful',\n  'modern',\n  'minimal',\n  'trendy',\n  'creative',\n  'artistic',\n  'spectacular',\n  'glamorous',\n  'luxury',\n  'retro',\n  'nostalgic',\n  'comfy',\n  'polished',\n  'fabulous',\n  'balanced',\n  'monochrome',\n  'glitched',\n]\n\nconst SAFE_RANDOM_BUSINESS_NOUNS = [\n  'account',\n  'consumer',\n  'customer',\n  'enterprise',\n  'business',\n  'venture',\n  'marketplace',\n  'revenue',\n  'vertical',\n  'portfolio',\n  'negotiation',\n  'shipping',\n  'demand',\n  'supply',\n  'growth',\n  'merchant',\n  'investment',\n  'shareholder',\n  'conversion',\n  'capital',\n  'projection',\n  'upside',\n  'trade',\n  'deal',\n  'merchandise',\n  'transaction',\n  'sale',\n]\n\nconst SAFE_RANDOM_CREATIVE_NOUNS = [\n  'vibe',\n  'style',\n  'moment',\n  'mood',\n  'flavor',\n  'look',\n  'appearance',\n  'perspective',\n  'aspect',\n  'ambience',\n  'quality',\n  'backdrop',\n  'focus',\n  'tone',\n]\n\nexport type RandomNameFamily = 'business' | 'creative'\n\n/**\n * @param family - Theme to use for the random name\n * @returns A random name generated by combining an adjective and noun.\n */\nexport function getRandomName(family: RandomNameFamily = 'business'): string {\n  const mapping = {\n    business: {\n      adjectives: SAFE_RANDOM_BUSINESS_ADJECTIVES,\n      nouns: SAFE_RANDOM_BUSINESS_NOUNS,\n    },\n    creative: {\n      adjectives: SAFE_RANDOM_CREATIVE_ADJECTIVES,\n      nouns: SAFE_RANDOM_CREATIVE_NOUNS,\n    },\n  }\n  return `${takeRandomFromArray(mapping[family].adjectives)}-${takeRandomFromArray(mapping[family].nouns)}`\n}\n"]}

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

@@ -0,0 +1,7 @@
+/**
+ * Check if the format of a URL is valid or not.
+ *
+ * @param url - URL to be checked.
+ * @returns True if the URL is valid, false otherwise.
+ */
+export declare const isValidURL: (url: string) => boolean;

package/dist/public/common/url.js

@@ -0,0 +1,17 @@
+/**
+ * Check if the format of a URL is valid or not.
+ *
+ * @param url - URL to be checked.
+ * @returns True if the URL is valid, false otherwise.
+ */
+export const isValidURL = (url) => {
+    try {
+        return Boolean(new URL(url));
+    }
+    catch (error) {
+        if (error instanceof TypeError)
+            return false;
+        throw error;
+    }
+};
+//# sourceMappingURL=url.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../src/public/common/url.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAW,EAAW,EAAE;IACjD,IAAI;QACF,OAAO,OAAO,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;KAC7B;IAAC,OAAO,KAAc,EAAE;QACvB,IAAI,KAAK,YAAY,SAAS;YAAE,OAAO,KAAK,CAAA;QAC5C,MAAM,KAAK,CAAA;KACZ;AACH,CAAC,CAAA","sourcesContent":["/**\n * Check if the format of a URL is valid or not.\n *\n * @param url - URL to be checked.\n * @returns True if the URL is valid, false otherwise.\n */\nexport const isValidURL = (url: string): boolean => {\n  try {\n    return Boolean(new URL(url))\n  } catch (error: unknown) {\n    if (error instanceof TypeError) return false\n    throw error\n  }\n}\n"]}

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

@@ -0,0 +1,16 @@
+import { AbortController as NodeAbortController, AbortSignal as NodeAbortControllerSignal } from 'node-abort-controller';
+/**
+ * The AbortController interface represents a controller object that allows you to abort one or more Web requests as and when desired.
+ *
+ * - MDN Documentation: https://developer.mozilla.org/en-US/docs/Web/API/AbortController
+ *
+ * This class is necessary because AbortController support was added to Node 15 and the minimum
+ * version that we support is Node 14.
+ */
+export declare class AbortController extends NodeAbortController {
+}
+/**
+ * The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a fetch request) and abort it if required via an AbortController object.
+ */
+export declare class AbortSignal extends NodeAbortControllerSignal {
+}

package/dist/public/node/abort.js

@@ -0,0 +1,17 @@
+import { AbortController as NodeAbortController, AbortSignal as NodeAbortControllerSignal } from 'node-abort-controller';
+/**
+ * The AbortController interface represents a controller object that allows you to abort one or more Web requests as and when desired.
+ *
+ * - MDN Documentation: https://developer.mozilla.org/en-US/docs/Web/API/AbortController
+ *
+ * This class is necessary because AbortController support was added to Node 15 and the minimum
+ * version that we support is Node 14.
+ */
+export class AbortController extends NodeAbortController {
+}
+/**
+ * The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a fetch request) and abort it if required via an AbortController object.
+ */
+export class AbortSignal extends NodeAbortControllerSignal {
+}
+//# sourceMappingURL=abort.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"abort.js","sourceRoot":"","sources":["../../../src/public/node/abort.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,IAAI,mBAAmB,EAAE,WAAW,IAAI,yBAAyB,EAAC,MAAM,uBAAuB,CAAA;AAEtH;;;;;;;GAOG;AACH,MAAM,OAAO,eAAgB,SAAQ,mBAAmB;CAAG;AAE3D;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,yBAAyB;CAAG","sourcesContent":["import {AbortController as NodeAbortController, AbortSignal as NodeAbortControllerSignal} from 'node-abort-controller'\n\n/**\n * The AbortController interface represents a controller object that allows you to abort one or more Web requests as and when desired.\n *\n * - MDN Documentation: https://developer.mozilla.org/en-US/docs/Web/API/AbortController\n *\n * This class is necessary because AbortController support was added to Node 15 and the minimum\n * version that we support is Node 14.\n */\nexport class AbortController extends NodeAbortController {}\n\n/**\n * The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a fetch request) and abort it if required via an AbortController object.\n */\nexport class AbortSignal extends NodeAbortControllerSignal {}\n"]}

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

@@ -0,0 +1,13 @@
+import { Interfaces } from '@oclif/core';
+interface ReportAnalyticsEventOptions {
+    config: Interfaces.Config;
+    errorMessage?: string;
+}
+/**
+ * Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.
+ *
+ * The payload for an event includes both generic data, and data gathered from installed plug-ins.
+ *
+ */
+export declare function reportAnalyticsEvent(options: ReportAnalyticsEventOptions): Promise<void>;
+export {};

package/dist/public/node/analytics.js

@@ -0,0 +1,82 @@
+import { version as rubyVersion } from './ruby.js';
+import * as environment from '../../environment.js';
+import { content, debug, token } from '../../output.js';
+import constants from '../../constants.js';
+import * as metadata from '../../metadata.js';
+import { publishEvent, MONORAIL_COMMAND_TOPIC } from '../../monorail.js';
+import { fanoutHooks } from '../../plugins.js';
+import { getEnvironmentData, getSensitiveEnvironmentData } from '../../private/node/analytics.js';
+/**
+ * Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.
+ *
+ * The payload for an event includes both generic data, and data gathered from installed plug-ins.
+ *
+ */
+export async function reportAnalyticsEvent(options) {
+    try {
+        const payload = await buildPayload(options);
+        if (payload === undefined) {
+            // Nothing to log
+            return;
+        }
+        if (!environment.local.alwaysLogAnalytics() && environment.local.analyticsDisabled()) {
+            debug(content `Skipping command analytics, payload: ${token.json(payload)}`);
+            return;
+        }
+        const response = await publishEvent(MONORAIL_COMMAND_TOPIC, payload.public, payload.sensitive);
+        if (response.type === 'error') {
+            debug(response.message);
+        }
+        // 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);
+    }
+}
+async function buildPayload({ config, errorMessage }) {
+    const { commandStartOptions, ...sensitiveMetadata } = metadata.getAllSensitive();
+    if (commandStartOptions === undefined) {
+        debug('Unable to log analytics event - no information on executed command');
+        return;
+    }
+    const { startCommand, startArgs, startTime } = commandStartOptions;
+    const currentTime = new Date().getTime();
+    const { '@shopify/app': appPublic, ...otherPluginsPublic } = await fanoutHooks(config, 'public_command_metadata', {});
+    const { '@shopify/app': appSensitive, ...otherPluginsSensitive } = await fanoutHooks(config, 'sensitive_command_metadata', {});
+    const environmentData = await getEnvironmentData(config);
+    const sensitiveEnvironmentData = await getSensitiveEnvironmentData(config);
+    return {
+        public: {
+            command: startCommand,
+            time_start: startTime,
+            time_end: currentTime,
+            total_time: currentTime - startTime,
+            success: errorMessage === undefined,
+            cli_version: await constants.versions.cliKit(),
+            ruby_version: (await rubyVersion()) || '',
+            node_version: process.version.replace('v', ''),
+            is_employee: await environment.local.isShopify(),
+            ...environmentData,
+            ...appPublic,
+            ...metadata.getAllPublic(),
+        },
+        sensitive: {
+            args: startArgs.join(' '),
+            error_message: errorMessage,
+            ...appSensitive,
+            ...sensitiveEnvironmentData,
+            metadata: JSON.stringify({
+                ...sensitiveMetadata,
+                extraPublic: {
+                    ...otherPluginsPublic,
+                },
+                extraSensitive: { ...otherPluginsSensitive },
+            }),
+        },
+    };
+}
+//# sourceMappingURL=analytics.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/public/node/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,WAAW,CAAA;AAChD,OAAO,KAAK,WAAW,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AACrD,OAAO,SAAS,MAAM,oBAAoB,CAAA;AAC1C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAC,YAAY,EAAE,sBAAsB,EAAC,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAA;AAC5C,OAAO,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,iCAAiC,CAAA;AAQ/F;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAoC;IAC7E,IAAI;QACF,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,iBAAiB;YACjB,OAAM;SACP;QACD,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,kBAAkB,EAAE,IAAI,WAAW,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE;YACpF,KAAK,CAAC,OAAO,CAAA,wCAAwC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC3E,OAAM;SACP;QACD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,sBAAsB,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;QAC9F,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE;YAC7B,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;SACxB;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;KACf;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,EAAC,MAAM,EAAE,YAAY,EAA8B;IAC7E,MAAM,EAAC,mBAAmB,EAAE,GAAG,iBAAiB,EAAC,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAA;IAC9E,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACrC,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAC3E,OAAM;KACP;IACD,MAAM,EAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAC,GAAG,mBAAmB,CAAA;IAChE,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;IAExC,MAAM,EAAC,cAAc,EAAE,SAAS,EAAE,GAAG,kBAAkB,EAAC,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAA;IACnH,MAAM,EAAC,cAAc,EAAE,YAAY,EAAE,GAAG,qBAAqB,EAAC,GAAG,MAAM,WAAW,CAChF,MAAM,EACN,4BAA4B,EAC5B,EAAE,CACH,CAAA;IAED,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACxD,MAAM,wBAAwB,GAAG,MAAM,2BAA2B,CAAC,MAAM,CAAC,CAAA;IAE1E,OAAO;QACL,MAAM,EAAE;YACN,OAAO,EAAE,YAAY;YACrB,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,WAAW;YACrB,UAAU,EAAE,WAAW,GAAG,SAAS;YACnC,OAAO,EAAE,YAAY,KAAK,SAAS;YACnC,WAAW,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;YAC9C,YAAY,EAAE,CAAC,MAAM,WAAW,EAAE,CAAC,IAAI,EAAE;YACzC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;YAC9C,WAAW,EAAE,MAAM,WAAW,CAAC,KAAK,CAAC,SAAS,EAAE;YAChD,GAAG,eAAe;YAClB,GAAG,SAAS;YACZ,GAAG,QAAQ,CAAC,YAAY,EAAE;SAC3B;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;YACzB,aAAa,EAAE,YAAY;YAC3B,GAAG,YAAY;YACf,GAAG,wBAAwB;YAC3B,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;gBACvB,GAAG,iBAAiB;gBACpB,WAAW,EAAE;oBACX,GAAG,kBAAkB;iBACtB;gBACD,cAAc,EAAE,EAAC,GAAG,qBAAqB,EAAC;aAC3C,CAAC;SACH;KACF,CAAA;AACH,CAAC","sourcesContent":["import {version as rubyVersion} from './ruby.js'\nimport * as environment from '../../environment.js'\nimport {content, debug, token} from '../../output.js'\nimport constants from '../../constants.js'\nimport * as metadata from '../../metadata.js'\nimport {publishEvent, MONORAIL_COMMAND_TOPIC} from '../../monorail.js'\nimport {fanoutHooks} from '../../plugins.js'\nimport {getEnvironmentData, getSensitiveEnvironmentData} from '../../private/node/analytics.js'\nimport {Interfaces} from '@oclif/core'\n\ninterface ReportAnalyticsEventOptions {\n  config: Interfaces.Config\n  errorMessage?: string\n}\n\n/**\n * Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.\n *\n * The payload for an event includes both generic data, and data gathered from installed plug-ins.\n *\n */\nexport async function reportAnalyticsEvent(options: ReportAnalyticsEventOptions): Promise<void> {\n  try {\n    const payload = await buildPayload(options)\n    if (payload === undefined) {\n      // Nothing to log\n      return\n    }\n    if (!environment.local.alwaysLogAnalytics() && environment.local.analyticsDisabled()) {\n      debug(content`Skipping command analytics, payload: ${token.json(payload)}`)\n      return\n    }\n    const response = await publishEvent(MONORAIL_COMMAND_TOPIC, payload.public, payload.sensitive)\n    if (response.type === 'error') {\n      debug(response.message)\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  }\n}\n\nasync function buildPayload({config, errorMessage}: ReportAnalyticsEventOptions) {\n  const {commandStartOptions, ...sensitiveMetadata} = metadata.getAllSensitive()\n  if (commandStartOptions === undefined) {\n    debug('Unable to log analytics event - no information on executed command')\n    return\n  }\n  const {startCommand, startArgs, startTime} = commandStartOptions\n  const currentTime = new Date().getTime()\n\n  const {'@shopify/app': appPublic, ...otherPluginsPublic} = await fanoutHooks(config, 'public_command_metadata', {})\n  const {'@shopify/app': appSensitive, ...otherPluginsSensitive} = await fanoutHooks(\n    config,\n    'sensitive_command_metadata',\n    {},\n  )\n\n  const environmentData = await getEnvironmentData(config)\n  const sensitiveEnvironmentData = await getSensitiveEnvironmentData(config)\n\n  return {\n    public: {\n      command: startCommand,\n      time_start: startTime,\n      time_end: currentTime,\n      total_time: currentTime - startTime,\n      success: errorMessage === undefined,\n      cli_version: await constants.versions.cliKit(),\n      ruby_version: (await rubyVersion()) || '',\n      node_version: process.version.replace('v', ''),\n      is_employee: await environment.local.isShopify(),\n      ...environmentData,\n      ...appPublic,\n      ...metadata.getAllPublic(),\n    },\n    sensitive: {\n      args: startArgs.join(' '),\n      error_message: errorMessage,\n      ...appSensitive,\n      ...sensitiveEnvironmentData,\n      metadata: JSON.stringify({\n        ...sensitiveMetadata,\n        extraPublic: {\n          ...otherPluginsPublic,\n        },\n        extraSensitive: {...otherPluginsSensitive},\n      }),\n    },\n  }\n}\n"]}

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

@@ -0,0 +1,9 @@
+/**
+ * It zips a directory normalizing the paths to be forward-slash. Note that unzipping
+ * the zip generated by this function from a Windows environment won't work because paths
+ * need to be made backward-slash.
+ *
+ * @param inputDirectory - The absolute path to the directory to be zipped.
+ * @param outputZipPath - The absolute path to the output zip file.
+ */
+export declare function zip(inputDirectory: string, outputZipPath: string): Promise<void>;

package/dist/public/node/archiver.js

@@ -0,0 +1,34 @@
+import { debug, content, token } from '../../output.js';
+import { glob, relative as relativePath } from '../../path.js';
+import archiver from 'archiver';
+import { createWriteStream } from 'fs';
+/**
+ * It zips a directory normalizing the paths to be forward-slash. Note that unzipping
+ * the zip generated by this function from a Windows environment won't work because paths
+ * need to be made backward-slash.
+ *
+ * @param inputDirectory - The absolute path to the directory to be zipped.
+ * @param outputZipPath - The absolute path to the output zip file.
+ */
+export async function zip(inputDirectory, outputZipPath) {
+    debug(content `Zipping ${token.path(inputDirectory)} into ${token.path(outputZipPath)}`);
+    const pathsToZip = await glob('**/*', { cwd: inputDirectory, absolute: true, dot: true, followSymbolicLinks: false });
+    return new Promise((resolve, reject) => {
+        const archive = archiver('zip');
+        const output = createWriteStream(outputZipPath);
+        output.on('close', function () {
+            resolve();
+        });
+        archive.on('error', function (error) {
+            reject(error);
+        });
+        archive.pipe(output);
+        for (const filePath of pathsToZip) {
+            const fileRelativePath = relativePath(inputDirectory, filePath);
+            archive.file(filePath, { name: fileRelativePath });
+        }
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        archive.finalize();
+    });
+}
+//# sourceMappingURL=archiver.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"archiver.js","sourceRoot":"","sources":["../../../src/public/node/archiver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAC,IAAI,EAAE,QAAQ,IAAI,YAAY,EAAC,MAAM,eAAe,CAAA;AAC5D,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,iBAAiB,EAAC,MAAM,IAAI,CAAA;AACpC;;;;;;;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 '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 - The absolute path to the directory to be zipped.\n * @param outputZipPath - 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/public/node/base-command.d.ts

@@ -0,0 +1,26 @@
+import { Command, Interfaces } from '@oclif/core';
+declare abstract class BaseCommand extends Command {
+    static analyticsNameOverride(): string | undefined;
+    catch(error: Error & {
+        exitCode?: number | undefined;
+    }): Promise<void>;
+    protected init(): Promise<any>;
+    protected exitWithTimestampWhenEnvVariablePresent(): void;
+    protected parse<TFlags extends Interfaces.FlagOutput & {
+        path?: string;
+        verbose?: boolean;
+    }, TGlobalFlags extends Interfaces.FlagOutput, TArgs extends Interfaces.OutputArgs>(options?: Interfaces.Input<TFlags, TGlobalFlags>, argv?: string[]): Promise<Interfaces.ParserOutput<TFlags, TGlobalFlags, TArgs>>;
+    protected resultWithPreset<TFlags extends Interfaces.FlagOutput & {
+        path?: string;
+        verbose?: boolean;
+    }, TGlobalFlags extends Interfaces.FlagOutput, TArgs extends Interfaces.OutputArgs>(originalResult: Interfaces.ParserOutput<TFlags, TGlobalFlags, TArgs>, options?: Interfaces.Input<TFlags, TGlobalFlags>, argv?: string[]): Promise<Interfaces.ParserOutput<TFlags, TGlobalFlags, TArgs>>;
+    protected presetsPath(rawFlags: {
+        path?: string;
+    }): Promise<string>;
+    protected findUpForPresets(): boolean;
+}
+export declare function addFromParsedFlags(flags: {
+    path?: string;
+    verbose?: boolean;
+}): Promise<void>;
+export default BaseCommand;