@shopify/cli-kit 0.0.0-nightly-20230110194301

package/dist/content-tokens.js

@@ -0,0 +1,105 @@
+import { relativize as relativizePath } from './path.js';
+import colors from './public/node/colors.js';
+import { stringifyMessage } from './output.js';
+import terminalLink from 'terminal-link';
+import cjs from 'color-json';
+export class ContentToken {
+    constructor(value) {
+        this.value = value;
+    }
+}
+export class RawContentToken extends ContentToken {
+    output() {
+        return this.value;
+    }
+}
+export class LinkContentToken extends ContentToken {
+    constructor(value, link) {
+        super(value);
+        this.link = link;
+    }
+    output() {
+        const text = colors.green(stringifyMessage(this.value));
+        const url = this.link ?? '';
+        return terminalLink(text, url, { fallback: () => `${text} ( ${url} )` });
+    }
+}
+export class CommandContentToken extends ContentToken {
+    output() {
+        return colors.bold(colors.yellow(stringifyMessage(this.value)));
+    }
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export class JsonContentToken extends ContentToken {
+    output() {
+        try {
+            return cjs(stringifyMessage(this.value) ?? {});
+            // eslint-disable-next-line no-catch-all/no-catch-all
+        }
+        catch (_) {
+            return JSON.stringify(stringifyMessage(this.value) ?? {}, null, 2);
+        }
+    }
+}
+export class LinesDiffContentToken extends ContentToken {
+    output() {
+        return this.value
+            .map((part) => {
+            if (part.added) {
+                return part.value
+                    .split(/\n/)
+                    .filter((line) => line !== '')
+                    .map((line) => {
+                    return colors.green(`+ ${line}\n`);
+                });
+            }
+            else if (part.removed) {
+                return part.value
+                    .split(/\n/)
+                    .filter((line) => line !== '')
+                    .map((line) => {
+                    return colors.magenta(`- ${line}\n`);
+                });
+            }
+            else {
+                return part.value;
+            }
+        })
+            .flat();
+    }
+}
+export class ColorContentToken extends ContentToken {
+    constructor(value, color) {
+        super(value);
+        this.color = color;
+    }
+    output() {
+        return this.color(stringifyMessage(this.value));
+    }
+}
+export class ErrorContentToken extends ContentToken {
+    output() {
+        return colors.bold.redBright(stringifyMessage(this.value));
+    }
+}
+export class PathContentToken extends ContentToken {
+    output() {
+        return relativizePath(stringifyMessage(this.value));
+    }
+}
+export class HeadingContentToken extends ContentToken {
+    output() {
+        return colors.bold.underline(stringifyMessage(this.value));
+    }
+}
+export class SubHeadingContentToken extends ContentToken {
+    output() {
+        return colors.underline(stringifyMessage(this.value));
+    }
+}
+export class ItalicContentToken extends ContentToken {
+    output() {
+        return colors.italic(stringifyMessage(this.value));
+    }
+}
+//# sourceMappingURL=content-tokens.js.map

package/dist/content-tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-tokens.js","sourceRoot":"","sources":["../src/content-tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,IAAI,cAAc,EAAC,MAAM,WAAW,CAAA;AACtD,OAAO,MAAM,MAAM,yBAAyB,CAAA;AAC5C,OAAO,EAAU,gBAAgB,EAAC,MAAM,aAAa,CAAA;AACrD,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,GAAG,MAAM,YAAY,CAAA;AAG5B,MAAM,OAAgB,YAAY;IAGhC,YAAY,KAAQ;QAClB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CAGF;AAED,MAAM,OAAO,eAAgB,SAAQ,YAAoB;IACvD,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,YAAqB;IAGzD,YAAY,KAAc,EAAE,IAAY;QACtC,KAAK,CAAC,KAAK,CAAC,CAAA;QACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,MAAM;QACJ,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAA;QAC3B,OAAO,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,EAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,MAAM,GAAG,IAAI,EAAC,CAAC,CAAA;IACxE,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,YAAqB;IAC5D,MAAM;QACJ,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACjE,CAAC;CACF;AAED,8DAA8D;AAC9D,MAAM,OAAO,gBAAiB,SAAQ,YAAiB;IACrD,MAAM;QACJ,IAAI;YACF,OAAO,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;YAC9C,qDAAqD;SACtD;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;SACnE;IACH,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,YAAsB;IAC/D,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK;aACd,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACZ,IAAI,IAAI,CAAC,KAAK,EAAE;gBACd,OAAO,IAAI,CAAC,KAAK;qBACd,KAAK,CAAC,IAAI,CAAC;qBACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;qBAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;oBACZ,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;gBACpC,CAAC,CAAC,CAAA;aACL;iBAAM,IAAI,IAAI,CAAC,OAAO,EAAE;gBACvB,OAAO,IAAI,CAAC,KAAK;qBACd,KAAK,CAAC,IAAI,CAAC;qBACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;qBAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;oBACZ,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;gBACtC,CAAC,CAAC,CAAA;aACL;iBAAM;gBACL,OAAO,IAAI,CAAC,KAAK,CAAA;aAClB;QACH,CAAC,CAAC;aACD,IAAI,EAAE,CAAA;IACX,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,YAAqB;IAG1D,YAAY,KAAc,EAAE,KAA+B;QACzD,KAAK,CAAC,KAAK,CAAC,CAAA;QACZ,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IACjD,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,YAAqB;IAC1D,MAAM;QACJ,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5D,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,YAAqB;IACzD,MAAM;QACJ,OAAO,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IACrD,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,YAAqB;IAC5D,MAAM;QACJ,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5D,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,YAAqB;IAC/D,MAAM;QACJ,OAAO,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IACvD,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,YAAqB;IAC3D,MAAM;QACJ,OAAO,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IACpD,CAAC;CACF","sourcesContent":["import {relativize as relativizePath} from './path.js'\nimport colors from './public/node/colors.js'\nimport {Message, stringifyMessage} from './output.js'\nimport terminalLink from 'terminal-link'\nimport cjs from 'color-json'\nimport type {Change} from 'diff'\n\nexport abstract class ContentToken<T> {\n  value: T\n\n  constructor(value: T) {\n    this.value = value\n  }\n\n  abstract output(): string | string[]\n}\n\nexport class RawContentToken extends ContentToken<string> {\n  output(): string {\n    return this.value\n  }\n}\n\nexport class LinkContentToken extends ContentToken<Message> {\n  link: string\n\n  constructor(value: Message, link: string) {\n    super(value)\n    this.link = link\n  }\n\n  output() {\n    const text = colors.green(stringifyMessage(this.value))\n    const url = this.link ?? ''\n    return terminalLink(text, url, {fallback: () => `${text} ( ${url} )`})\n  }\n}\n\nexport class CommandContentToken extends ContentToken<Message> {\n  output(): string {\n    return colors.bold(colors.yellow(stringifyMessage(this.value)))\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport class JsonContentToken extends ContentToken<any> {\n  output(): string {\n    try {\n      return cjs(stringifyMessage(this.value) ?? {})\n      // eslint-disable-next-line no-catch-all/no-catch-all\n    } catch (_) {\n      return JSON.stringify(stringifyMessage(this.value) ?? {}, null, 2)\n    }\n  }\n}\n\nexport class LinesDiffContentToken extends ContentToken<Change[]> {\n  output(): string[] {\n    return this.value\n      .map((part) => {\n        if (part.added) {\n          return part.value\n            .split(/\\n/)\n            .filter((line) => line !== '')\n            .map((line) => {\n              return colors.green(`+ ${line}\\n`)\n            })\n        } else if (part.removed) {\n          return part.value\n            .split(/\\n/)\n            .filter((line) => line !== '')\n            .map((line) => {\n              return colors.magenta(`- ${line}\\n`)\n            })\n        } else {\n          return part.value\n        }\n      })\n      .flat()\n  }\n}\n\nexport class ColorContentToken extends ContentToken<Message> {\n  color: (text: string) => string\n\n  constructor(value: Message, color: (text: string) => string) {\n    super(value)\n    this.color = color\n  }\n\n  output(): string {\n    return this.color(stringifyMessage(this.value))\n  }\n}\n\nexport class ErrorContentToken extends ContentToken<Message> {\n  output(): string {\n    return colors.bold.redBright(stringifyMessage(this.value))\n  }\n}\n\nexport class PathContentToken extends ContentToken<Message> {\n  output(): string {\n    return relativizePath(stringifyMessage(this.value))\n  }\n}\n\nexport class HeadingContentToken extends ContentToken<Message> {\n  output(): string {\n    return colors.bold.underline(stringifyMessage(this.value))\n  }\n}\n\nexport class SubHeadingContentToken extends ContentToken<Message> {\n  output(): string {\n    return colors.underline(stringifyMessage(this.value))\n  }\n}\n\nexport class ItalicContentToken extends ContentToken<Message> {\n  output(): string {\n    return colors.italic(stringifyMessage(this.value))\n  }\n}\n"]}

package/dist/environment/fqdn.d.ts

@@ -0,0 +1,29 @@
+import { Abort } from '../error.js';
+export declare const CouldntObtainPartnersSpinFQDNError: Abort;
+export declare const CouldntObtainIdentitySpinFQDNError: Abort;
+export declare const CouldntObtainShopifySpinFQDNError: Abort;
+export declare const NotProvidedStoreFQDNError: Abort;
+/**
+ * It returns the Partners' API service we should interact with.
+ * @returns Fully-qualified domain of the partners service we should interact with.
+ */
+export declare function partners(): Promise<string>;
+/**
+ * It returns the Identity service we should interact with.
+ * @returns Fully-qualified domain of the Identity service we should interact with.
+ */
+export declare function identity(): Promise<string>;
+/**
+ * It returns the Shopify service we should interact with.
+ * Note the same fqdn is sued for the Admin and the Storefront Renderer APIs.
+ * @returns Fully-qualified domain of the Shopify service we should interact with.
+ */
+export declare function shopify(options?: {
+    storeFqdn?: string;
+}): Promise<string>;
+/**
+ * Given a store, returns a valid store fqdn removing protocol and adding the proper domain in case is missing
+ * @param store - Original store name provided by the user
+ * @returns a valid store fqdn
+ */
+export declare function normalizeStoreName(store: string): Promise<string>;

package/dist/environment/fqdn.js

@@ -0,0 +1,72 @@
+import { fqdn, fqdn as spinFqdn } from './spin.js';
+import { isSpinEnvironment, serviceEnvironment } from './service.js';
+import { Abort } from '../error.js';
+export const CouldntObtainPartnersSpinFQDNError = new Abort("Couldn't obtain the Spin FQDN for Partners when the CLI is not running from a Spin environment.");
+export const CouldntObtainIdentitySpinFQDNError = new Abort("Couldn't obtain the Spin FQDN for Identity when the CLI is not running from a Spin environment.");
+export const CouldntObtainShopifySpinFQDNError = new Abort("Couldn't obtain the Spin FQDN for Shopify when the CLI is not running from a Spin environment.");
+export const NotProvidedStoreFQDNError = new Abort("Couldn't obtain the Shopify FQDN because the store FQDN was not provided.");
+/**
+ * It returns the Partners' API service we should interact with.
+ * @returns Fully-qualified domain of the partners service we should interact with.
+ */
+export async function partners() {
+    const environment = serviceEnvironment();
+    const productionFqdn = 'partners.shopify.com';
+    switch (environment) {
+        case 'local':
+            return 'partners.myshopify.io';
+        case 'spin':
+            return `partners.${await spinFqdn()}`;
+        default:
+            return productionFqdn;
+    }
+}
+/**
+ * It returns the Identity service we should interact with.
+ * @returns Fully-qualified domain of the Identity service we should interact with.
+ */
+export async function identity() {
+    const environment = serviceEnvironment();
+    const productionFqdn = 'accounts.shopify.com';
+    switch (environment) {
+        case 'local':
+            return 'identity.myshopify.io';
+        case 'spin':
+            return `identity.${await spinFqdn()}`;
+        default:
+            return productionFqdn;
+    }
+}
+/**
+ * It returns the Shopify service we should interact with.
+ * Note the same fqdn is sued for the Admin and the Storefront Renderer APIs.
+ * @returns Fully-qualified domain of the Shopify service we should interact with.
+ */
+export async function shopify(options = {}) {
+    const environment = serviceEnvironment();
+    switch (environment) {
+        case 'local':
+            return 'shopify.myshopify.io';
+        case 'spin':
+            return `identity.${await spinFqdn()}`;
+        default:
+            if (options.storeFqdn) {
+                return options.storeFqdn;
+            }
+            else {
+                throw NotProvidedStoreFQDNError;
+            }
+    }
+}
+/**
+ * Given a store, returns a valid store fqdn removing protocol and adding the proper domain in case is missing
+ * @param store - Original store name provided by the user
+ * @returns a valid store fqdn
+ */
+export async function normalizeStoreName(store) {
+    const storeFqdn = store.replace(/^https?:\/\//, '').replace(/\/$/, '');
+    const addDomain = async (storeFqdn) => isSpinEnvironment() ? `${storeFqdn}.shopify.${await fqdn()}` : `${storeFqdn}.myshopify.com`;
+    const containDomain = (storeFqdn) => storeFqdn.includes('.myshopify.com') || storeFqdn.includes('spin.dev');
+    return containDomain(storeFqdn) ? storeFqdn : addDomain(storeFqdn);
+}
+//# sourceMappingURL=fqdn.js.map

package/dist/environment/fqdn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fqdn.js","sourceRoot":"","sources":["../../src/environment/fqdn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAE,IAAI,IAAI,QAAQ,EAAC,MAAM,WAAW,CAAA;AAChD,OAAO,EAAC,iBAAiB,EAAE,kBAAkB,EAAC,MAAM,cAAc,CAAA;AAClE,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AAEjC,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,KAAK,CACzD,iGAAiG,CAClG,CAAA;AACD,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,KAAK,CACzD,iGAAiG,CAClG,CAAA;AACD,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,KAAK,CACxD,gGAAgG,CACjG,CAAA;AACD,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,KAAK,CAChD,2EAA2E,CAC5E,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC5B,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,sBAAsB,CAAA;IAC7C,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,uBAAuB,CAAA;QAChC,KAAK,MAAM;YACT,OAAO,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAA;QACvC;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC5B,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,MAAM,cAAc,GAAG,sBAAsB,CAAA;IAC7C,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,uBAAuB,CAAA;QAChC,KAAK,MAAM;YACT,OAAO,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAA;QACvC;YACE,OAAO,cAAc,CAAA;KACxB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,UAAgC,EAAE;IAC9D,MAAM,WAAW,GAAG,kBAAkB,EAAE,CAAA;IACxC,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,sBAAsB,CAAA;QAC/B,KAAK,MAAM;YACT,OAAO,YAAY,MAAM,QAAQ,EAAE,EAAE,CAAA;QACvC;YACE,IAAI,OAAO,CAAC,SAAS,EAAE;gBACrB,OAAO,OAAO,CAAC,SAAS,CAAA;aACzB;iBAAM;gBACL,MAAM,yBAAyB,CAAA;aAChC;KACJ;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAa;IACpD,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,SAAS,GAAG,KAAK,EAAE,SAAiB,EAAE,EAAE,CAC5C,iBAAiB,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,YAAY,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,gBAAgB,CAAA;IAC7F,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IACnH,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;AACpE,CAAC","sourcesContent":["import {fqdn, fqdn as spinFqdn} from './spin.js'\nimport {isSpinEnvironment, serviceEnvironment} from './service.js'\nimport {Abort} from '../error.js'\n\nexport const CouldntObtainPartnersSpinFQDNError = new Abort(\n  \"Couldn't obtain the Spin FQDN for Partners when the CLI is not running from a Spin environment.\",\n)\nexport const CouldntObtainIdentitySpinFQDNError = new Abort(\n  \"Couldn't obtain the Spin FQDN for Identity when the CLI is not running from a Spin environment.\",\n)\nexport const CouldntObtainShopifySpinFQDNError = new Abort(\n  \"Couldn't obtain the Spin FQDN for Shopify when the CLI is not running from a Spin environment.\",\n)\nexport const NotProvidedStoreFQDNError = new Abort(\n  \"Couldn't obtain the Shopify FQDN because the store FQDN was not provided.\",\n)\n\n/**\n * It returns the Partners' API service we should interact with.\n * @returns Fully-qualified domain of the partners service we should interact with.\n */\nexport async function partners(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'partners.shopify.com'\n  switch (environment) {\n    case 'local':\n      return 'partners.myshopify.io'\n    case 'spin':\n      return `partners.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * It returns the Identity service we should interact with.\n * @returns Fully-qualified domain of the Identity service we should interact with.\n */\nexport async function identity(): Promise<string> {\n  const environment = serviceEnvironment()\n  const productionFqdn = 'accounts.shopify.com'\n  switch (environment) {\n    case 'local':\n      return 'identity.myshopify.io'\n    case 'spin':\n      return `identity.${await spinFqdn()}`\n    default:\n      return productionFqdn\n  }\n}\n\n/**\n * It returns the Shopify service we should interact with.\n * Note the same fqdn is sued for the Admin and the Storefront Renderer APIs.\n * @returns Fully-qualified domain of the Shopify service we should interact with.\n */\nexport async function shopify(options: {storeFqdn?: string} = {}): Promise<string> {\n  const environment = serviceEnvironment()\n  switch (environment) {\n    case 'local':\n      return 'shopify.myshopify.io'\n    case 'spin':\n      return `identity.${await spinFqdn()}`\n    default:\n      if (options.storeFqdn) {\n        return options.storeFqdn\n      } else {\n        throw NotProvidedStoreFQDNError\n      }\n  }\n}\n\n/**\n * Given a store, returns a valid store fqdn removing protocol and adding the proper domain in case is missing\n * @param store - Original store name provided by the user\n * @returns a valid store fqdn\n */\nexport async function normalizeStoreName(store: string) {\n  const storeFqdn = store.replace(/^https?:\\/\\//, '').replace(/\\/$/, '')\n  const addDomain = async (storeFqdn: string) =>\n    isSpinEnvironment() ? `${storeFqdn}.shopify.${await fqdn()}` : `${storeFqdn}.myshopify.com`\n  const containDomain = (storeFqdn: string) => storeFqdn.includes('.myshopify.com') || storeFqdn.includes('spin.dev')\n  return containDomain(storeFqdn) ? storeFqdn : addDomain(storeFqdn)\n}\n"]}

package/dist/environment/local.d.ts

@@ -0,0 +1,92 @@
+/// <reference types="node" />
+/**
+ * It returns true if the terminal is interactive.
+ * @returns True if the terminal is interactive.
+ */
+export declare function isTerminalInteractive(): boolean;
+/**
+ * Returns the path to the user's home directory.
+ * @returns The path to the user's home directory.
+ */
+export declare function homeDirectory(): string;
+/**
+ * Returns true if the CLI is running in debug mode.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns true if SHOPIFY_ENV is development
+ */
+export declare function isDevelopment(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns true if the CLI is running in verbose mode.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns true if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed
+ */
+export declare function isVerbose(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns true if the environment in which the CLI is running is either
+ * a local environment (where dev is present) or a cloud environment (spin).
+ * @returns True if the CLI is used in a Shopify environment.
+ */
+export declare function isShopify(env?: NodeJS.ProcessEnv): Promise<boolean>;
+/**
+ * This variable is used when running unit tests to indicate that the CLI's business logic
+ * is run as a subject of a unit test. We can use this variable to disable output through
+ * the standard streams.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if the SHOPIFY_UNIT_TEST environment variable is truthy.
+ */
+export declare function isUnitTest(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns true if reporting analytics is enabled.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns true unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.
+ */
+export declare function analyticsDisabled(env?: NodeJS.ProcessEnv): boolean;
+/** Returns true if reporting analytics should always happen, regardless of DEBUG mode etc. */
+export declare function alwaysLogAnalytics(env?: NodeJS.ProcessEnv): boolean;
+export declare function firstPartyDev(env?: NodeJS.ProcessEnv): boolean;
+export declare function useDeviceAuth(env?: NodeJS.ProcessEnv): boolean;
+export declare function useFunctionMatching(env?: NodeJS.ProcessEnv): boolean;
+export declare function useThemeBundling(env?: NodeJS.ProcessEnv): boolean;
+export declare function gitpodURL(env?: NodeJS.ProcessEnv): string | undefined;
+export declare function codespaceURL(env?: NodeJS.ProcessEnv): string | undefined;
+/**
+ * Checks if the CLI is run from a cloud environment
+ *
+ * @param env - Environment variables used when the cli is launched
+ *
+ * @returns True in case the CLI is run from a cloud environment
+ */
+export declare function isCloudEnvironment(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns the cloud environment platform name and if the platform support online IDE in case the CLI is run from one of
+ * them. Platform name 'localhost' is returned otherwise
+ *
+ * @param env - Environment variables used when the cli is launched
+ *
+ * @returns Cloud platform information
+ */
+export declare function cloudEnvironment(env?: NodeJS.ProcessEnv): {
+    platform: 'spin' | 'codespaces' | 'gitpod' | 'localhost';
+    editor: boolean;
+};
+/**
+ * Returns whether the environment has Git available.
+ * @returns A promise that resolves with the value.
+ */
+export declare function hasGit(): Promise<boolean>;
+/**
+ * Gets info on the CI platform the CLI is running on, if applicable
+ */
+export declare function ciPlatform(env?: NodeJS.ProcessEnv): {
+    isCI: true;
+    name: string;
+} | {
+    isCI: false;
+    name?: undefined;
+};
+/**
+ * Returns the first mac address found
+ *
+ * @returns Mac address
+ */
+export declare function macAddress(): Promise<string>;

package/dist/environment/local.js

@@ -0,0 +1,169 @@
+import { isTruthy, isSet } from './utilities.js';
+import { isSpin } from './spin.js';
+import constants from '../constants.js';
+import { exists as fileExists } from '../file.js';
+import { exec } from '../system.js';
+import isInteractive from 'is-interactive';
+import macaddress from 'macaddress';
+import { homedir } from 'os';
+/**
+ * It returns true if the terminal is interactive.
+ * @returns True if the terminal is interactive.
+ */
+export function isTerminalInteractive() {
+    return isInteractive();
+}
+/**
+ * Returns the path to the user's home directory.
+ * @returns The path to the user's home directory.
+ */
+export function homeDirectory() {
+    return homedir();
+}
+/**
+ * Returns true if the CLI is running in debug mode.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns true if SHOPIFY_ENV is development
+ */
+export function isDevelopment(env = process.env) {
+    return env[constants.environmentVariables.env] === 'development';
+}
+/**
+ * Returns true if the CLI is running in verbose mode.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns true if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed
+ */
+export function isVerbose(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.verbose]) || process.argv.includes('--verbose');
+}
+/**
+ * Returns true if the environment in which the CLI is running is either
+ * a local environment (where dev is present) or a cloud environment (spin).
+ * @returns True if the CLI is used in a Shopify environment.
+ */
+export async function isShopify(env = process.env) {
+    if (Object.prototype.hasOwnProperty.call(env, constants.environmentVariables.runAsUser)) {
+        return !isTruthy(env[constants.environmentVariables.runAsUser]);
+    }
+    const devInstalled = await fileExists(constants.paths.executables.dev);
+    return devInstalled || isSpin(env);
+}
+/**
+ * This variable is used when running unit tests to indicate that the CLI's business logic
+ * is run as a subject of a unit test. We can use this variable to disable output through
+ * the standard streams.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if the SHOPIFY_UNIT_TEST environment variable is truthy.
+ */
+export function isUnitTest(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.unitTest]);
+}
+/**
+ * Returns true if reporting analytics is enabled.
+ * @param env - The environment variables from the environment of the current process.
+ * @returns true unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.
+ */
+export function analyticsDisabled(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.noAnalytics]) || isDevelopment(env);
+}
+/** Returns true if reporting analytics should always happen, regardless of DEBUG mode etc. */
+export function alwaysLogAnalytics(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.alwaysLogAnalytics]);
+}
+export function firstPartyDev(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.firstPartyDev]);
+}
+export function useDeviceAuth(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.deviceAuth]) || isCloudEnvironment(env);
+}
+export function useFunctionMatching(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.functionMatching]);
+}
+export function useThemeBundling(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.themeBundling]);
+}
+// https://www.gitpod.io/docs/environment-variables#default-environment-variables
+export function gitpodURL(env = process.env) {
+    return env[constants.environmentVariables.gitpod];
+}
+// https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables
+export function codespaceURL(env = process.env) {
+    return env[constants.environmentVariables.codespaceName];
+}
+/**
+ * Checks if the CLI is run from a cloud environment
+ *
+ * @param env - Environment variables used when the cli is launched
+ *
+ * @returns True in case the CLI is run from a cloud environment
+ */
+export function isCloudEnvironment(env = process.env) {
+    return cloudEnvironment(env).platform !== 'localhost';
+}
+/**
+ * Returns the cloud environment platform name and if the platform support online IDE in case the CLI is run from one of
+ * them. Platform name 'localhost' is returned otherwise
+ *
+ * @param env - Environment variables used when the cli is launched
+ *
+ * @returns Cloud platform information
+ */
+export function cloudEnvironment(env = process.env) {
+    if (isSet(env[constants.environmentVariables.codespaces])) {
+        return { platform: 'codespaces', editor: true };
+    }
+    if (isSet(env[constants.environmentVariables.gitpod])) {
+        return { platform: 'gitpod', editor: true };
+    }
+    if (isSpin(env)) {
+        return { platform: 'spin', editor: false };
+    }
+    return { platform: 'localhost', editor: false };
+}
+/**
+ * Returns whether the environment has Git available.
+ * @returns A promise that resolves with the value.
+ */
+export async function hasGit() {
+    try {
+        await exec('git', ['--version']);
+        return true;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Gets info on the CI platform the CLI is running on, if applicable
+ */
+export function ciPlatform(env = process.env) {
+    if (isTruthy(env.CI)) {
+        let name = 'unknown';
+        if (isTruthy(env.CIRCLECI)) {
+            name = 'circleci';
+        }
+        else if (isSet(env.GITHUB_ACTION)) {
+            name = 'github';
+        }
+        else if (isTruthy(env.GITLAB_CI)) {
+            name = 'gitlab';
+        }
+        return {
+            isCI: true,
+            name,
+        };
+    }
+    return {
+        isCI: false,
+    };
+}
+/**
+ * Returns the first mac address found
+ *
+ * @returns Mac address
+ */
+export function macAddress() {
+    return macaddress.one();
+}
+//# sourceMappingURL=local.js.map

package/dist/environment/local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.js","sourceRoot":"","sources":["../../src/environment/local.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAC,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAA;AAChC,OAAO,SAAS,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAC,MAAM,IAAI,UAAU,EAAC,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAC,IAAI,EAAC,MAAM,cAAc,CAAA;AACjC,OAAO,aAAa,MAAM,gBAAgB,CAAA;AAC1C,OAAO,UAAU,MAAM,YAAY,CAAA;AACnC,OAAO,EAAC,OAAO,EAAC,MAAM,IAAI,CAAA;AAE1B;;;GAGG;AACH,MAAM,UAAU,qBAAqB;IACnC,OAAO,aAAa,EAAE,CAAA;AACxB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,OAAO,EAAE,CAAA;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC7C,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,KAAK,aAAa,CAAA;AAClE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;AACpG,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC/C,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE;QACvF,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAA;KAChE;IACD,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IACtE,OAAO,YAAY,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC1C,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC/D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACjD,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,CAAA;AACxF,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,kBAAkB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAClD,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAA;AACzE,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC7C,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAA;AACpE,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC7C,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAA;AAC5F,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACnD,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAChD,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAA;AACpE,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAA;AACnD,CAAC;AAED,wJAAwJ;AACxJ,MAAM,UAAU,YAAY,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC5C,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AAC1D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAyB,OAAO,CAAC,GAAG;IACrE,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,WAAW,CAAA;AACvD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAyB,OAAO,CAAC,GAAG;IAInE,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,EAAE;QACzD,OAAO,EAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAC,CAAA;KAC9C;IACD,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE;QACrD,OAAO,EAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,CAAA;KAC1C;IACD,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;QACf,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAC,CAAA;KACzC;IACD,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAC,CAAA;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,IAAI;QACF,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAA;QAChC,OAAO,IAAI,CAAA;QACX,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC1C,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QACpB,IAAI,IAAI,GAAG,SAAS,CAAA;QACpB,IAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YAC1B,IAAI,GAAG,UAAU,CAAA;SAClB;aAAM,IAAI,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YACnC,IAAI,GAAG,QAAQ,CAAA;SAChB;aAAM,IAAI,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAClC,IAAI,GAAG,QAAQ,CAAA;SAChB;QAED,OAAO;YACL,IAAI,EAAE,IAAI;YACV,IAAI;SACL,CAAA;KACF;IACD,OAAO;QACL,IAAI,EAAE,KAAK;KACZ,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,UAAU,CAAC,GAAG,EAAE,CAAA;AACzB,CAAC","sourcesContent":["import {isTruthy, isSet} from './utilities.js'\nimport {isSpin} from './spin.js'\nimport constants from '../constants.js'\nimport {exists as fileExists} from '../file.js'\nimport {exec} from '../system.js'\nimport isInteractive from 'is-interactive'\nimport macaddress from 'macaddress'\nimport {homedir} from 'os'\n\n/**\n * It returns true if the terminal is interactive.\n * @returns True if the terminal is interactive.\n */\nexport function isTerminalInteractive(): boolean {\n  return isInteractive()\n}\n\n/**\n * Returns the path to the user's home directory.\n * @returns The path to the user's home directory.\n */\nexport function homeDirectory(): string {\n  return homedir()\n}\n\n/**\n * Returns true if the CLI is running in debug mode.\n * @param env - The environment variables from the environment of the current process.\n * @returns true if SHOPIFY_ENV is development\n */\nexport function isDevelopment(env = process.env): boolean {\n  return env[constants.environmentVariables.env] === 'development'\n}\n\n/**\n * Returns true if the CLI is running in verbose mode.\n * @param env - The environment variables from the environment of the current process.\n * @returns true if SHOPIFY_FLAG_VERBOSE is truthy or the flag --verbose has been passed\n */\nexport function isVerbose(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.verbose]) || process.argv.includes('--verbose')\n}\n\n/**\n * Returns true if the environment in which the CLI is running is either\n * a local environment (where dev is present) or a cloud environment (spin).\n * @returns True if the CLI is used in a Shopify environment.\n */\nexport async function isShopify(env = process.env): Promise<boolean> {\n  if (Object.prototype.hasOwnProperty.call(env, constants.environmentVariables.runAsUser)) {\n    return !isTruthy(env[constants.environmentVariables.runAsUser])\n  }\n  const devInstalled = await fileExists(constants.paths.executables.dev)\n  return devInstalled || isSpin(env)\n}\n\n/**\n * This variable is used when running unit tests to indicate that the CLI's business logic\n * is run as a subject of a unit test. We can use this variable to disable output through\n * the standard streams.\n * @param env - The environment variables from the environment of the current process.\n * @returns True if the SHOPIFY_UNIT_TEST environment variable is truthy.\n */\nexport function isUnitTest(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.unitTest])\n}\n\n/**\n * Returns true if reporting analytics is enabled.\n * @param env - The environment variables from the environment of the current process.\n * @returns true unless SHOPIFY_CLI_NO_ANALYTICS is truthy or debug mode is enabled.\n */\nexport function analyticsDisabled(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.noAnalytics]) || isDevelopment(env)\n}\n\n/** Returns true if reporting analytics should always happen, regardless of DEBUG mode etc. */\nexport function alwaysLogAnalytics(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.alwaysLogAnalytics])\n}\n\nexport function firstPartyDev(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.firstPartyDev])\n}\n\nexport function useDeviceAuth(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.deviceAuth]) || isCloudEnvironment(env)\n}\n\nexport function useFunctionMatching(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.functionMatching])\n}\n\nexport function useThemeBundling(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.themeBundling])\n}\n\n// https://www.gitpod.io/docs/environment-variables#default-environment-variables\nexport function gitpodURL(env = process.env): string | undefined {\n  return env[constants.environmentVariables.gitpod]\n}\n\n// https://docs.github.com/en/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables\nexport function codespaceURL(env = process.env): string | undefined {\n  return env[constants.environmentVariables.codespaceName]\n}\n\n/**\n * Checks if the CLI is run from a cloud environment\n *\n * @param env - Environment variables used when the cli is launched\n *\n * @returns True in case the CLI is run from a cloud environment\n */\nexport function isCloudEnvironment(env: NodeJS.ProcessEnv = process.env): boolean {\n  return cloudEnvironment(env).platform !== 'localhost'\n}\n\n/**\n * Returns the cloud environment platform name and if the platform support online IDE in case the CLI is run from one of\n * them. Platform name 'localhost' is returned otherwise\n *\n * @param env - Environment variables used when the cli is launched\n *\n * @returns Cloud platform information\n */\nexport function cloudEnvironment(env: NodeJS.ProcessEnv = process.env): {\n  platform: 'spin' | 'codespaces' | 'gitpod' | 'localhost'\n  editor: boolean\n} {\n  if (isSet(env[constants.environmentVariables.codespaces])) {\n    return {platform: 'codespaces', editor: true}\n  }\n  if (isSet(env[constants.environmentVariables.gitpod])) {\n    return {platform: 'gitpod', editor: true}\n  }\n  if (isSpin(env)) {\n    return {platform: 'spin', editor: false}\n  }\n  return {platform: 'localhost', editor: false}\n}\n\n/**\n * Returns whether the environment has Git available.\n * @returns A promise that resolves with the value.\n */\nexport async function hasGit(): Promise<boolean> {\n  try {\n    await exec('git', ['--version'])\n    return true\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return false\n  }\n}\n\n/**\n * Gets info on the CI platform the CLI is running on, if applicable\n */\nexport function ciPlatform(env = process.env): {isCI: true; name: string} | {isCI: false; name?: undefined} {\n  if (isTruthy(env.CI)) {\n    let name = 'unknown'\n    if (isTruthy(env.CIRCLECI)) {\n      name = 'circleci'\n    } else if (isSet(env.GITHUB_ACTION)) {\n      name = 'github'\n    } else if (isTruthy(env.GITLAB_CI)) {\n      name = 'gitlab'\n    }\n\n    return {\n      isCI: true,\n      name,\n    }\n  }\n  return {\n    isCI: false,\n  }\n}\n\n/**\n * Returns the first mac address found\n *\n * @returns Mac address\n */\nexport function macAddress() {\n  return macaddress.one()\n}\n"]}

package/dist/environment/service.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { Environment } from '../network/service.js';
+export declare function serviceEnvironment(env?: NodeJS.ProcessEnv): Environment;
+export declare function isSpinEnvironment(env?: NodeJS.ProcessEnv): boolean;

package/dist/environment/service.js

@@ -0,0 +1,19 @@
+import { isSpin } from './spin.js';
+import constants from '../constants.js';
+import { Environment } from '../network/service.js';
+export function serviceEnvironment(env = process.env) {
+    const value = env[constants.environmentVariables.serviceEnv];
+    if (value === 'local') {
+        return Environment.Local;
+    }
+    else if (value === 'spin' || isSpin(env)) {
+        return Environment.Spin;
+    }
+    else {
+        return Environment.Production;
+    }
+}
+export function isSpinEnvironment(env = process.env) {
+    return serviceEnvironment(env) === Environment.Spin;
+}
+//# sourceMappingURL=service.js.map

package/dist/environment/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/environment/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAA;AAChC,OAAO,SAAS,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAC,WAAW,EAAC,MAAM,uBAAuB,CAAA;AAEjD,MAAM,UAAU,kBAAkB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAClD,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;IAC5D,IAAI,KAAK,KAAK,OAAO,EAAE;QACrB,OAAO,WAAW,CAAC,KAAK,CAAA;KACzB;SAAM,IAAI,KAAK,KAAK,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;QAC1C,OAAO,WAAW,CAAC,IAAI,CAAA;KACxB;SAAM;QACL,OAAO,WAAW,CAAC,UAAU,CAAA;KAC9B;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACjD,OAAO,kBAAkB,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,IAAI,CAAA;AACrD,CAAC","sourcesContent":["import {isSpin} from './spin.js'\nimport constants from '../constants.js'\nimport {Environment} from '../network/service.js'\n\nexport function serviceEnvironment(env = process.env): Environment {\n  const value = env[constants.environmentVariables.serviceEnv]\n  if (value === 'local') {\n    return Environment.Local\n  } else if (value === 'spin' || isSpin(env)) {\n    return Environment.Spin\n  } else {\n    return Environment.Production\n  }\n}\n\nexport function isSpinEnvironment(env = process.env): boolean {\n  return serviceEnvironment(env) === Environment.Spin\n}\n"]}

package/dist/environment/spin-cache.d.ts

@@ -0,0 +1,2 @@
+export declare function getCachedSpinFqdn(): string | undefined;
+export declare function setCachedSpinFqdn(fqdn: string): void;

package/dist/environment/spin-cache.js

@@ -0,0 +1,8 @@
+let cachedSpinFQDN;
+export function getCachedSpinFqdn() {
+    return cachedSpinFQDN;
+}
+export function setCachedSpinFqdn(fqdn) {
+    cachedSpinFQDN = fqdn;
+}
+//# sourceMappingURL=spin-cache.js.map

package/dist/environment/spin-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spin-cache.js","sourceRoot":"","sources":["../../src/environment/spin-cache.ts"],"names":[],"mappings":"AAAA,IAAI,cAAsB,CAAA;AAE1B,MAAM,UAAU,iBAAiB;IAC/B,OAAO,cAAc,CAAA;AACvB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,cAAc,GAAG,IAAI,CAAA;AACvB,CAAC","sourcesContent":["let cachedSpinFQDN: string\n\nexport function getCachedSpinFqdn(): string | undefined {\n  return cachedSpinFQDN\n}\n\nexport function setCachedSpinFqdn(fqdn: string) {\n  cachedSpinFQDN = fqdn\n}\n"]}

package/dist/environment/spin.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import { Abort } from '../error.js';
+export declare const SpinInstanceNotFound: (spinInstance: string | undefined, error: string) => Abort;
+/**
+ * When ran in a Spin environment, it returns the fqdn of the instance.
+ *
+ * Will cache the value of the Spin FQDN during the execution of the CLI.
+ * To avoid multiple calls to `readSync` or `show`
+ * @returns fqdn of the Spin environment.
+ */
+export declare function fqdn(env?: NodeJS.ProcessEnv): Promise<string>;
+/**
+ * Runs "spin show" and returns the JSON-parsed output.
+ * @param spinInstance - When it's undefined, we'll fetch the latest one.
+ * @returns The JSON-parsed output of the Spin CLI.
+ * @throws Any error raised from the underlying Spin CLI.
+ */
+export declare function show(spinInstance: string | undefined, env?: NodeJS.ProcessEnv): Promise<{
+    fqdn: string;
+}>;
+/**
+ * Returns true if the CLI is running in a Spin environment.
+ * @param env - Environment variables
+ * @returns True if the CLI is running in a Spin environment.
+ */
+export declare function isSpin(env?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns the value of the SPIN_INSTANCE environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_INSTANCE environment variable.
+ */
+export declare function instance(env?: NodeJS.ProcessEnv): string | undefined;
+/**
+ * Returns the value of the SPIN_WORKSPACE environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_WORKSPACE environment variable.
+ */
+export declare function workspace(env?: NodeJS.ProcessEnv): string | undefined;
+/**
+ * Returns the value of the SPIN_NAMESPACE environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_NAMESPACE environment variable.
+ */
+export declare function namespace(env?: NodeJS.ProcessEnv): string | undefined;
+/**
+ * Returns the value of the SPIN_HOST environment variable.
+ * @param env - Environment variables
+ * @returns The value of the SPIN_HOST environment variable.
+ */
+export declare function host(env?: NodeJS.ProcessEnv): string | undefined;