@shopify/cli-kit 3.0.24 → 3.0.27

package/dist/environment/local.js

@@ -0,0 +1,82 @@
+import { isTruthy } 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 { homedir } from 'node:os';
+/**
+ * It returns true if the terminal is interactive.
+ * @returns {boolean} True if the terminal is interactive.
+ */
+export function isTerminalInteractive() {
+    return isInteractive();
+}
+/**
+ * Returns the path to the user's home directory.
+ * @returns {string} 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_CONFIG is debug
+ */
+export function isDebug(env = process.env) {
+    return env[constants.environmentVariables.shopifyConfig] === 'debug';
+}
+/**
+ * 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 {boolean} 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();
+}
+/**
+ * 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]) || isDebug(env);
+}
+/**
+ * Returns whether the environment has Git available.
+ * @returns {Promise<boolean>} 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;
+    }
+}
+//# 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,EAAC,MAAM,gBAAgB,CAAA;AACvC,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,EAAC,OAAO,EAAC,MAAM,SAAS,CAAA;AAE/B;;;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,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACvC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,KAAK,OAAO,CAAA;AACtE,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,EAAE,CAAA;AACjC,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,OAAO,CAAC,GAAG,CAAC,CAAA;AAClF,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","sourcesContent":["import {isTruthy} 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 {homedir} from 'node:os'\n\n/**\n * It returns true if the terminal is interactive.\n * @returns {boolean} 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 {string} 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_CONFIG is debug\n */\nexport function isDebug(env = process.env): boolean {\n  return env[constants.environmentVariables.shopifyConfig] === 'debug'\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 {boolean} 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()\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]) || isDebug(env)\n}\n\n/**\n * Returns whether the environment has Git available.\n * @returns {Promise<boolean>} 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"]}

package/dist/environment/service.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import { Environment } from '../network/service.js';
+/**
+ * Returns the environment to be used for the interactions with the partners' CLI API.
+ * @param env The environment variables from the environment of the current process.
+ */
+export declare function partners(env?: NodeJS.ProcessEnv): Environment;
+/**
+ * Returns the environment to be used for the interactions with the admin API.
+ * @param env The environment variables from the environment of the current process.
+ */
+export declare function shopify(env?: NodeJS.ProcessEnv): Environment;
+/**
+ * Returns the environment to be used for the interactions with identity.
+ * @param env The environment variables from the environment of the current process.
+ */
+export declare function identity(env?: NodeJS.ProcessEnv): Environment;

package/dist/environment/service.js

@@ -0,0 +1,41 @@
+import { Environment } from '../network/service.js';
+import constants from '../constants.js';
+/**
+ * Given an environment variable that represents the environment to use for a given serve,
+ * it returns the environment as a enum;
+ * @param value The environment variable value.
+ * @returns {Environment} representing the environment to use.
+ */
+function service(value) {
+    if (value === 'local') {
+        return Environment.Local;
+    }
+    else if (value === 'spin') {
+        return Environment.Spin;
+    }
+    else {
+        return Environment.Production;
+    }
+}
+/**
+ * Returns the environment to be used for the interactions with the partners' CLI API.
+ * @param env The environment variables from the environment of the current process.
+ */
+export function partners(env = process.env) {
+    return service(env[constants.environmentVariables.partnersEnv]);
+}
+/**
+ * Returns the environment to be used for the interactions with the admin API.
+ * @param env The environment variables from the environment of the current process.
+ */
+export function shopify(env = process.env) {
+    return service(env[constants.environmentVariables.shopifyEnv]);
+}
+/**
+ * Returns the environment to be used for the interactions with identity.
+ * @param env The environment variables from the environment of the current process.
+ */
+export function identity(env = process.env) {
+    return service(env[constants.environmentVariables.identityEnv]);
+}
+//# 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,WAAW,EAAC,MAAM,uBAAuB,CAAA;AACjD,OAAO,SAAS,MAAM,iBAAiB,CAAA;AAEvC;;;;;GAKG;AACH,SAAS,OAAO,CAAC,KAAyB;IACxC,IAAI,KAAK,KAAK,OAAO,EAAE;QACrB,OAAO,WAAW,CAAC,KAAK,CAAA;KACzB;SAAM,IAAI,KAAK,KAAK,MAAM,EAAE;QAC3B,OAAO,WAAW,CAAC,IAAI,CAAA;KACxB;SAAM;QACL,OAAO,WAAW,CAAC,UAAU,CAAA;KAC9B;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACxC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACvC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAA;AAChE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACxC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAA;AACjE,CAAC","sourcesContent":["import {Environment} from '../network/service.js'\nimport constants from '../constants.js'\n\n/**\n * Given an environment variable that represents the environment to use for a given serve,\n * it returns the environment as a enum;\n * @param value The environment variable value.\n * @returns {Environment} representing the environment to use.\n */\nfunction service(value: undefined | string): Environment {\n  if (value === 'local') {\n    return Environment.Local\n  } else if (value === 'spin') {\n    return Environment.Spin\n  } else {\n    return Environment.Production\n  }\n}\n\n/**\n * Returns the environment to be used for the interactions with the partners' CLI API.\n * @param env The environment variables from the environment of the current process.\n */\nexport function partners(env = process.env): Environment {\n  return service(env[constants.environmentVariables.partnersEnv])\n}\n\n/**\n * Returns the environment to be used for the interactions with the admin API.\n * @param env The environment variables from the environment of the current process.\n */\nexport function shopify(env = process.env): Environment {\n  return service(env[constants.environmentVariables.shopifyEnv])\n}\n\n/**\n * Returns the environment to be used for the interactions with identity.\n * @param env The environment variables from the environment of the current process.\n */\nexport function identity(env = process.env): Environment {\n  return service(env[constants.environmentVariables.identityEnv])\n}\n"]}

package/dist/environment/spin.d.ts

@@ -0,0 +1,47 @@
+/// <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.
+ * @returns {string} fqdn of the Spin environment.
+ */
+export declare function fqdn(env?: NodeJS.ProcessEnv): Promise<string>;
+/**
+ * Runs "spin show" and returns the JSON-parsed output.
+ * @param {latest} Whether to pass --latest when running the command.
+ * @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 {[key: string]: string} Environment variables
+ * @returns {boolean} 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 {[key: string]: string} Environment variables
+ * @returns {string | undefined} 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 {[key: string]: string} Environment variables
+ * @returns {string | undefined} 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 {[key: string]: string} Environment variables
+ * @returns {string | undefined} 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 {[key: string]: string} Environment variables
+ * @returns {string | undefined} The value of the SPIN_HOST environment variable.
+ */
+export declare function host(env?: NodeJS.ProcessEnv): string | undefined;

package/dist/environment/spin.js

@@ -0,0 +1,83 @@
+import { isTruthy } from './utilities.js';
+import constants from '../constants.js';
+import { captureOutput } from '../system.js';
+import { Abort } from '../error.js';
+import { content, token } from '../output.js';
+export const SpinInstanceNotFound = (spinInstance, error) => {
+    const errorMessage = content `${token.genericShellCommand(`spin`)} yielded the following error trying to obtain the fully qualified domain name of the Spin instance:
+${error}
+  `;
+    let nextSteps;
+    if (spinInstance) {
+        nextSteps = `Make sure ${spinInstance} is the instance name and not a fully qualified domain name`;
+    }
+    return new Abort(errorMessage, nextSteps);
+};
+/**
+ * When ran in a Spin environment, it returns the fqdn of the instance.
+ * @returns {string} fqdn of the Spin environment.
+ */
+export async function fqdn(env = process.env) {
+    const spinInstance = await instance(env);
+    const showResponse = await show(spinInstance, env);
+    return showResponse.fqdn;
+}
+/**
+ * Runs "spin show" and returns the JSON-parsed output.
+ * @param {latest} Whether to pass --latest when running the command.
+ * @returns The JSON-parsed output of the Spin CLI.
+ * @throws Any error raised from the underlying Spin CLI.
+ */
+export async function show(spinInstance, env = process.env) {
+    const latest = spinInstance === undefined;
+    const args = latest ? ['show', '--latest', '--json'] : ['show', '--json'];
+    const output = await captureOutput('spin', args, { env });
+    const json = JSON.parse(output);
+    if (json.error) {
+        throw SpinInstanceNotFound(spinInstance, json.error);
+    }
+    else {
+        return json;
+    }
+}
+/**
+ * Returns true if the CLI is running in a Spin environment.
+ * @param env {[key: string]: string} Environment variables
+ * @returns {boolean} True if the CLI is running in a Spin environment.
+ */
+export function isSpin(env = process.env) {
+    return isTruthy(env[constants.environmentVariables.spin]);
+}
+/**
+ * Returns the value of the SPIN_INSTANCE environment variable.
+ * @param env {[key: string]: string} Environment variables
+ * @returns {string | undefined} The value of the SPIN_INSTANCE environment variable.
+ */
+export function instance(env = process.env) {
+    return env[constants.environmentVariables.spinInstance];
+}
+/**
+ * Returns the value of the SPIN_WORKSPACE environment variable.
+ * @param env {[key: string]: string} Environment variables
+ * @returns {string | undefined} The value of the SPIN_WORKSPACE environment variable.
+ */
+export function workspace(env = process.env) {
+    return env[constants.environmentVariables.spinWorkspace];
+}
+/**
+ * Returns the value of the SPIN_NAMESPACE environment variable.
+ * @param env {[key: string]: string} Environment variables
+ * @returns {string | undefined} The value of the SPIN_NAMESPACE environment variable.
+ */
+export function namespace(env = process.env) {
+    return env[constants.environmentVariables.spinNamespace];
+}
+/**
+ * Returns the value of the SPIN_HOST environment variable.
+ * @param env {[key: string]: string} Environment variables
+ * @returns {string | undefined} The value of the SPIN_HOST environment variable.
+ */
+export function host(env = process.env) {
+    return env[constants.environmentVariables.spinHost];
+}
+//# sourceMappingURL=spin.js.map

package/dist/environment/spin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spin.js","sourceRoot":"","sources":["../../src/environment/spin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAA;AACvC,OAAO,SAAS,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAA;AACjC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,cAAc,CAAA;AAE3C,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,YAAgC,EAAE,KAAa,EAAE,EAAE;IACtF,MAAM,YAAY,GAAG,OAAO,CAAA,GAAG,KAAK,CAAC,mBAAmB,CACtD,MAAM,CACP;EACD,KAAK;GACJ,CAAA;IACD,IAAI,SAA6B,CAAA;IACjC,IAAI,YAAY,EAAE;QAChB,SAAS,GAAG,aAAa,YAAY,6DAA6D,CAAA;KACnG;IACD,OAAO,IAAI,KAAK,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;AAC3C,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IAC1C,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;IACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IAClD,OAAO,YAAY,CAAC,IAAI,CAAA;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,YAAgC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG;IAC5E,MAAM,MAAM,GAAG,YAAY,KAAK,SAAS,CAAA;IACzC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACzE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,EAAC,GAAG,EAAC,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,MAAM,oBAAoB,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;KACrD;SAAM;QACL,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACtC,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACxC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AAC1D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACzC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AAC1D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;IACpC,OAAO,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AACrD,CAAC","sourcesContent":["import {isTruthy} from './utilities.js'\nimport constants from '../constants.js'\nimport {captureOutput} from '../system.js'\nimport {Abort} from '../error.js'\nimport {content, token} from '../output.js'\n\nexport const SpinInstanceNotFound = (spinInstance: string | undefined, error: string) => {\n  const errorMessage = content`${token.genericShellCommand(\n    `spin`,\n  )} yielded the following error trying to obtain the fully qualified domain name of the Spin instance:\n${error}\n  `\n  let nextSteps: string | undefined\n  if (spinInstance) {\n    nextSteps = `Make sure ${spinInstance} is the instance name and not a fully qualified domain name`\n  }\n  return new Abort(errorMessage, nextSteps)\n}\n\n/**\n * When ran in a Spin environment, it returns the fqdn of the instance.\n * @returns {string} fqdn of the Spin environment.\n */\nexport async function fqdn(env = process.env): Promise<string> {\n  const spinInstance = await instance(env)\n  const showResponse = await show(spinInstance, env)\n  return showResponse.fqdn\n}\n\n/**\n * Runs \"spin show\" and returns the JSON-parsed output.\n * @param {latest} Whether to pass --latest when running the command.\n * @returns The JSON-parsed output of the Spin CLI.\n * @throws Any error raised from the underlying Spin CLI.\n */\nexport async function show(spinInstance: string | undefined, env = process.env): Promise<{fqdn: string}> {\n  const latest = spinInstance === undefined\n  const args = latest ? ['show', '--latest', '--json'] : ['show', '--json']\n  const output = await captureOutput('spin', args, {env})\n  const json = JSON.parse(output)\n  if (json.error) {\n    throw SpinInstanceNotFound(spinInstance, json.error)\n  } else {\n    return json\n  }\n}\n\n/**\n * Returns true if the CLI is running in a Spin environment.\n * @param env {[key: string]: string} Environment variables\n * @returns {boolean} True if the CLI is running in a Spin environment.\n */\nexport function isSpin(env = process.env): boolean {\n  return isTruthy(env[constants.environmentVariables.spin])\n}\n\n/**\n * Returns the value of the SPIN_INSTANCE environment variable.\n * @param env {[key: string]: string} Environment variables\n * @returns {string | undefined} The value of the SPIN_INSTANCE environment variable.\n */\nexport function instance(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinInstance]\n}\n\n/**\n * Returns the value of the SPIN_WORKSPACE environment variable.\n * @param env {[key: string]: string} Environment variables\n * @returns {string | undefined} The value of the SPIN_WORKSPACE environment variable.\n */\nexport function workspace(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinWorkspace]\n}\n\n/**\n * Returns the value of the SPIN_NAMESPACE environment variable.\n * @param env {[key: string]: string} Environment variables\n * @returns {string | undefined} The value of the SPIN_NAMESPACE environment variable.\n */\nexport function namespace(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinNamespace]\n}\n\n/**\n * Returns the value of the SPIN_HOST environment variable.\n * @param env {[key: string]: string} Environment variables\n * @returns {string | undefined} The value of the SPIN_HOST environment variable.\n */\nexport function host(env = process.env): string | undefined {\n  return env[constants.environmentVariables.spinHost]\n}\n"]}

package/dist/environment/utilities.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns whether an environment variable value represents a truthy value.
+ * @param variable {string | undefined} Given a environment variable value, it returns true if it represents a truthy value.
+ * @returns {boolean}
+ */
+export declare function isTruthy(variable: string | undefined): boolean;

package/dist/environment/utilities.js

@@ -0,0 +1,12 @@
+/**
+ * Returns whether an environment variable value represents a truthy value.
+ * @param variable {string | undefined} Given a environment variable value, it returns true if it represents a truthy value.
+ * @returns {boolean}
+ */
+export function isTruthy(variable) {
+    if (!variable) {
+        return false;
+    }
+    return ['1', 'true', 'TRUE', 'yes', 'YES'].includes(variable);
+}
+//# sourceMappingURL=utilities.js.map

package/dist/environment/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../../src/environment/utilities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,QAA4B;IACnD,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,KAAK,CAAA;KACb;IACD,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAC/D,CAAC","sourcesContent":["/**\n * Returns whether an environment variable value represents a truthy value.\n * @param variable {string | undefined} Given a environment variable value, it returns true if it represents a truthy value.\n * @returns {boolean}\n */\nexport function isTruthy(variable: string | undefined): boolean {\n  if (!variable) {\n    return false\n  }\n  return ['1', 'true', 'TRUE', 'yes', 'YES'].includes(variable)\n}\n"]}

package/dist/environment.d.ts

@@ -0,0 +1,5 @@
+import * as local from './environment/local.js';
+import * as service from './environment/service.js';
+import * as fqdn from './environment/fqdn.js';
+import * as utilities from './environment/utilities.js';
+export { local, service, fqdn, utilities };

package/dist/environment.js

@@ -0,0 +1,6 @@
+import * as local from './environment/local.js';
+import * as service from './environment/service.js';
+import * as fqdn from './environment/fqdn.js';
+import * as utilities from './environment/utilities.js';
+export { local, service, fqdn, utilities };
+//# sourceMappingURL=environment.js.map

package/dist/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAA;AAC/C,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AACnD,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAA;AAC7C,OAAO,KAAK,SAAS,MAAM,4BAA4B,CAAA;AAEvD,OAAO,EAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAC,CAAA","sourcesContent":["import * as local from './environment/local.js'\nimport * as service from './environment/service.js'\nimport * as fqdn from './environment/fqdn.js'\nimport * as utilities from './environment/utilities.js'\n\nexport {local, service, fqdn, utilities}\n"]}

package/dist/error.d.ts

@@ -0,0 +1,44 @@
+import { Message } from './output.js';
+export { ExtendableError } from 'ts-error';
+export { AbortSignal } from 'abort-controller';
+declare enum FatalErrorType {
+    Abort = 0,
+    AbortSilent = 1,
+    Bug = 2
+}
+export declare class CancelExecution extends Error {
+}
+/**
+ * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.
+ * There shouldn't be code that catches fatal errors.
+ */
+export declare abstract class Fatal extends Error {
+    tryMessage: string | null;
+    type: FatalErrorType;
+    constructor(message: Message, type: FatalErrorType, tryMessage?: Message | null);
+}
+/**
+ * An abort error is a fatal error that shouldn't be reported as a bug.
+ * Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer
+ */
+export declare class Abort extends Fatal {
+    constructor(message: Message, tryMessage?: Message | null);
+}
+export declare class AbortSilent extends Fatal {
+    constructor();
+}
+/**
+ * A bug error is an error that represents a bug and therefore should be reported.
+ */
+export declare class Bug extends Fatal {
+    constructor(message: Message, tryMessage?: string | null);
+}
+/**
+ * A function that handles errors that blow up in the CLI.
+ * @param error Error to be handled.
+ * @returns A promise that resolves with the error passed.
+ */
+export declare function handler(error: Error): Promise<Error>;
+export declare function mapper(error: Error): Promise<Error>;
+export declare function isFatal(error: Error): boolean;
+export declare function shouldReport(error: Error): boolean;

package/dist/error.js

@@ -0,0 +1,91 @@
+import { stringifyMessage, error as outputError } from './output.js';
+import { Errors } from '@oclif/core';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import sourceMapSupport from 'source-map-support';
+export { ExtendableError } from 'ts-error';
+export { AbortSignal } from 'abort-controller';
+sourceMapSupport.install();
+var FatalErrorType;
+(function (FatalErrorType) {
+    FatalErrorType[FatalErrorType["Abort"] = 0] = "Abort";
+    FatalErrorType[FatalErrorType["AbortSilent"] = 1] = "AbortSilent";
+    FatalErrorType[FatalErrorType["Bug"] = 2] = "Bug";
+})(FatalErrorType || (FatalErrorType = {}));
+export class CancelExecution extends Error {
+}
+/**
+ * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.
+ * There shouldn't be code that catches fatal errors.
+ */
+export class Fatal extends Error {
+    constructor(message, type, tryMessage = null) {
+        super(stringifyMessage(message));
+        this.tryMessage = tryMessage ? stringifyMessage(tryMessage) : null;
+        this.type = type;
+    }
+}
+/**
+ * An abort error is a fatal error that shouldn't be reported as a bug.
+ * Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer
+ */
+export class Abort extends Fatal {
+    constructor(message, tryMessage = null) {
+        super(message, FatalErrorType.Abort, tryMessage);
+    }
+}
+export class AbortSilent extends Fatal {
+    constructor() {
+        super('', FatalErrorType.AbortSilent);
+    }
+}
+/**
+ * A bug error is an error that represents a bug and therefore should be reported.
+ */
+export class Bug extends Fatal {
+    constructor(message, tryMessage = null) {
+        super(message, FatalErrorType.Bug, tryMessage);
+    }
+}
+/**
+ * A function that handles errors that blow up in the CLI.
+ * @param error Error to be handled.
+ * @returns A promise that resolves with the error passed.
+ */
+export async function handler(error) {
+    let fatal;
+    if (isFatal(error)) {
+        fatal = error;
+    }
+    else {
+        fatal = new Bug(error.message);
+    }
+    if (fatal.type === FatalErrorType.Bug) {
+        fatal.stack = error.stack;
+    }
+    await outputError(fatal);
+    return Promise.resolve(error);
+}
+export function mapper(error) {
+    if (error instanceof Errors.CLIError) {
+        const mappedError = new Abort(error.message);
+        mappedError.stack = error.stack;
+        return Promise.resolve(mappedError);
+    }
+    else {
+        return Promise.resolve(error);
+    }
+}
+export function isFatal(error) {
+    return Object.prototype.hasOwnProperty.call(error, 'type');
+}
+export function shouldReport(error) {
+    if (!isFatal(error)) {
+        return true;
+    }
+    if (error.type === FatalErrorType.Bug) {
+        return true;
+    }
+    return false;
+}
+//# sourceMappingURL=error.js.map

package/dist/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,gBAAgB,EAAE,KAAK,IAAI,WAAW,EAAC,MAAM,aAAa,CAAA;AAC3E,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAA;AAElC,6DAA6D;AAC7D,aAAa;AACb,OAAO,gBAAgB,MAAM,oBAAoB,CAAA;AAEjD,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAA;AACxC,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAA;AAE5C,gBAAgB,CAAC,OAAO,EAAE,CAAA;AAE1B,IAAK,cAIJ;AAJD,WAAK,cAAc;IACjB,qDAAK,CAAA;IACL,iEAAW,CAAA;IACX,iDAAG,CAAA;AACL,CAAC,EAJI,cAAc,KAAd,cAAc,QAIlB;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;CAAG;AAE7C;;;GAGG;AACH,MAAM,OAAgB,KAAM,SAAQ,KAAK;IAGvC,YAAY,OAAgB,EAAE,IAAoB,EAAE,aAA6B,IAAI;QACnF,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;QAChC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAClE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,KAAM,SAAQ,KAAK;IAC9B,YAAY,OAAgB,EAAE,aAA6B,IAAI;QAC7D,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IAClD,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC;QACE,KAAK,CAAC,EAAE,EAAE,cAAc,CAAC,WAAW,CAAC,CAAA;IACvC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,KAAK;IAC5B,YAAY,OAAgB,EAAE,aAA4B,IAAI;QAC5D,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;IAChD,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,KAAY;IACxC,IAAI,KAAY,CAAA;IAChB,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;QAClB,KAAK,GAAG,KAAc,CAAA;KACvB;SAAM;QACL,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;KAC/B;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,GAAG,EAAE;QACrC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;KAC1B;IAED,MAAM,WAAW,CAAC,KAAK,CAAC,CAAA;IACxB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,KAAY;IACjC,IAAI,KAAK,YAAY,MAAM,CAAC,QAAQ,EAAE;QACpC,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC5C,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;QAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;KACpC;SAAM;QACL,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC9B;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAY;IAClC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAC5D,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAY;IACvC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACnB,OAAO,IAAI,CAAA;KACZ;IACD,IAAK,KAAe,CAAC,IAAI,KAAK,cAAc,CAAC,GAAG,EAAE;QAChD,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC","sourcesContent":["import {Message, stringifyMessage, error as outputError} from './output.js'\nimport {Errors} from '@oclif/core'\n\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport sourceMapSupport from 'source-map-support'\n\nexport {ExtendableError} from 'ts-error'\nexport {AbortSignal} from 'abort-controller'\n\nsourceMapSupport.install()\n\nenum FatalErrorType {\n  Abort,\n  AbortSilent,\n  Bug,\n}\n\nexport class CancelExecution extends Error {}\n\n/**\n * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.\n * There shouldn't be code that catches fatal errors.\n */\nexport abstract class Fatal extends Error {\n  tryMessage: string | null\n  type: FatalErrorType\n  constructor(message: Message, type: FatalErrorType, tryMessage: Message | null = null) {\n    super(stringifyMessage(message))\n    this.tryMessage = tryMessage ? stringifyMessage(tryMessage) : null\n    this.type = type\n  }\n}\n\n/**\n * An abort error is a fatal error that shouldn't be reported as a bug.\n * Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer\n */\nexport class Abort extends Fatal {\n  constructor(message: Message, tryMessage: Message | null = null) {\n    super(message, FatalErrorType.Abort, tryMessage)\n  }\n}\n\nexport class AbortSilent extends Fatal {\n  constructor() {\n    super('', FatalErrorType.AbortSilent)\n  }\n}\n\n/**\n * A bug error is an error that represents a bug and therefore should be reported.\n */\nexport class Bug extends Fatal {\n  constructor(message: Message, tryMessage: string | null = null) {\n    super(message, FatalErrorType.Bug, tryMessage)\n  }\n}\n\n/**\n * A function that handles errors that blow up in the CLI.\n * @param error Error to be handled.\n * @returns A promise that resolves with the error passed.\n */\nexport async function handler(error: Error): Promise<Error> {\n  let fatal: Fatal\n  if (isFatal(error)) {\n    fatal = error as Fatal\n  } else {\n    fatal = new Bug(error.message)\n  }\n\n  if (fatal.type === FatalErrorType.Bug) {\n    fatal.stack = error.stack\n  }\n\n  await outputError(fatal)\n  return Promise.resolve(error)\n}\n\nexport function mapper(error: Error): Promise<Error> {\n  if (error instanceof Errors.CLIError) {\n    const mappedError = new Abort(error.message)\n    mappedError.stack = error.stack\n    return Promise.resolve(mappedError)\n  } else {\n    return Promise.resolve(error)\n  }\n}\n\nexport function isFatal(error: Error): boolean {\n  return Object.prototype.hasOwnProperty.call(error, 'type')\n}\n\nexport function shouldReport(error: Error): boolean {\n  if (!isFatal(error)) {\n    return true\n  }\n  if ((error as Fatal).type === FatalErrorType.Bug) {\n    return true\n  }\n  return false\n}\n"]}

package/dist/file.d.ts

@@ -0,0 +1,67 @@
+export declare function stripUp(path: string, strip: number): string;
+/**
+ * Creates a temporary directory and ties its lifecycle ot the lifecycle of the callback.
+ * @param callback - The callback that receives the temporary directory.
+ */
+export declare function inTemporaryDirectory<T>(callback: (tmpDir: string) => T | Promise<T>): Promise<T>;
+/**
+ * It reads a file and returns its content as a string using the
+ * utf-8 encoding
+ * @param path {string} Path to the file to read.
+ * @returns {Promise<string>} A promise that resolves with the content of the file.
+ */
+export declare function read(path: string, options?: object): Promise<string>;
+export declare function readSync(path: string, options?: object): string;
+/**
+ * Copies a file
+ * @param from {string} Path to the directory or file to be copied.
+ * @param to {string} Destination path.
+ */
+export declare function copy(from: string, to: string): Promise<void>;
+export declare function touch(path: string): Promise<void>;
+export declare function touchSync(path: string): Promise<void>;
+export declare function write(path: string, data: string): Promise<void>;
+export declare function writeSync(path: string, data: string): void;
+export declare function append(path: string, data: string): Promise<void>;
+export declare function mkdir(path: string): Promise<void>;
+export declare function mkdirSync(path: string): void;
+export declare function remove(path: string): Promise<void>;
+export declare function rmdir(path: string, { force }?: {
+    force?: boolean;
+}): Promise<void>;
+export declare function mkTmpDir(): Promise<string>;
+export declare function isDirectory(path: string): Promise<boolean>;
+export declare function size(path: string): Promise<number>;
+export declare function sizeSync(path: string): number;
+/**
+ * Moves a file.
+ * @param src {string} File to be moved.
+ * @param dest {string} Path to be moved to.
+ * @param options {object} Moving options.
+ */
+export declare function move(src: string, dest: string, options?: {
+    overwrite?: boolean;
+}): Promise<void>;
+/**
+ * Changes the permissions of a directory or file.
+ * @param path {string} Path to the file or directory whose permissions will be modified.
+ * @param mode {string | numbers} Permissions to set to the file or directory.
+ */
+export declare function chmod(path: string, mode: number | string): Promise<void>;
+/**
+ * Checks if a file has executable permissions.
+ * @param path {string} Path to the file whose permissions will be checked.
+ */
+export declare function hasExecutablePermissions(path: string): Promise<boolean>;
+/**
+ * Returns true if a file or directory exists
+ * @param path {string} Path to the directory or file.
+ * @returns {boolean} True if it exists.
+ */
+export declare function exists(path: string): Promise<boolean>;
+/**
+ * Format a string using prettier. Return the formatted content.
+ */
+export declare function format(content: string, options: {
+    path: string;
+}): Promise<string>;