@shopify/cli-kit 0.0.0-nightly-20230110194301

package/dist/output.js

@@ -0,0 +1,310 @@
+/* eslint-disable no-console */
+import { isUnitTest, isVerbose } from './environment/local.js';
+import colors from './public/node/colors.js';
+import { ColorContentToken, CommandContentToken, ErrorContentToken, HeadingContentToken, ItalicContentToken, JsonContentToken, LinesDiffContentToken, LinkContentToken, PathContentToken, RawContentToken, SubHeadingContentToken, } from './content-tokens.js';
+import stripAnsi from 'strip-ansi';
+import { Writable } from 'stream';
+export { default as logUpdate } from 'log-update';
+export class TokenizedString {
+    constructor(value) {
+        this.value = value;
+    }
+}
+export const token = {
+    raw: (value) => {
+        return new RawContentToken(value);
+    },
+    genericShellCommand: (value) => {
+        return new CommandContentToken(value);
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    json: (value) => {
+        return new JsonContentToken(value);
+    },
+    path: (value) => {
+        return new PathContentToken(value);
+    },
+    link: (value, link) => {
+        return new LinkContentToken(value, link);
+    },
+    heading: (value) => {
+        return new HeadingContentToken(value);
+    },
+    subheading: (value) => {
+        return new SubHeadingContentToken(value);
+    },
+    italic: (value) => {
+        return new ItalicContentToken(value);
+    },
+    errorText: (value) => {
+        return new ErrorContentToken(value);
+    },
+    cyan: (value) => {
+        return new ColorContentToken(value, colors.cyan);
+    },
+    yellow: (value) => {
+        return new ColorContentToken(value, colors.yellow);
+    },
+    magenta: (value) => {
+        return new ColorContentToken(value, colors.magenta);
+    },
+    green: (value) => {
+        return new ColorContentToken(value, colors.green);
+    },
+    packagejsonScript: (packageManager, scriptName, ...scriptArgs) => {
+        return new CommandContentToken(formatPackageManagerCommand(packageManager, scriptName, ...scriptArgs));
+    },
+    successIcon: () => {
+        return new ColorContentToken('✔', colors.green);
+    },
+    failIcon: () => {
+        return new ErrorContentToken('✖');
+    },
+    linesDiff: (value) => {
+        return new LinesDiffContentToken(value);
+    },
+};
+export function formatPackageManagerCommand(packageManager, scriptName, ...scriptArgs) {
+    switch (packageManager) {
+        case 'yarn': {
+            const pieces = ['yarn', scriptName, ...scriptArgs];
+            return pieces.join(' ');
+        }
+        case 'pnpm':
+        case 'npm': {
+            const pieces = [packageManager, 'run', scriptName];
+            if (scriptArgs.length > 0) {
+                pieces.push('--');
+                pieces.push(...scriptArgs);
+            }
+            return pieces.join(' ');
+        }
+    }
+}
+export function content(strings, ...keys) {
+    let output = ``;
+    strings.forEach((string, i) => {
+        output += string;
+        if (i >= keys.length) {
+            return;
+        }
+        const token = keys[i];
+        if (typeof token === 'string') {
+            output += token;
+        }
+        else {
+            const enumTokenOutput = token.output();
+            if (Array.isArray(enumTokenOutput)) {
+                enumTokenOutput.forEach((line) => {
+                    output += line;
+                });
+            }
+            else {
+                output += enumTokenOutput;
+            }
+        }
+    });
+    return new TokenizedString(output);
+}
+/**
+ * It maps a level to a numeric value.
+ * @param level - The level for which we'll return its numeric value.
+ * @returns The numeric value of the level.
+ */
+const logLevelValue = (level) => {
+    switch (level) {
+        case 'trace':
+            return 10;
+        case 'debug':
+            return 20;
+        case 'info':
+            return 30;
+        case 'warn':
+            return 40;
+        case 'error':
+            return 50;
+        case 'fatal':
+            return 60;
+        default:
+            return 30;
+    }
+};
+/**
+ *
+ * @returns It returns the log level set by the user.
+ */
+export const currentLogLevel = () => {
+    if (isVerbose()) {
+        return 'debug';
+    }
+    else {
+        return 'info';
+    }
+};
+export const shouldOutput = (logLevel) => {
+    if (isUnitTest()) {
+        return false;
+    }
+    const currentLogLevelValue = logLevelValue(currentLogLevel());
+    const messageLogLevelValue = logLevelValue(logLevel);
+    return messageLogLevelValue >= currentLogLevelValue;
+};
+// eslint-disable-next-line import/no-mutable-exports
+export let collectedLogs = {};
+/**
+ * This is only used during UnitTesting.
+ * If we are in a testing context, instead of printing the logs to the console,
+ * we will store them in a variable that can be accessed from the tests.
+ * @param key - The key of the log.
+ * @param content - The content of the log.
+ */
+export const collectLog = (key, content) => {
+    const output = collectedLogs.output ?? [];
+    const data = collectedLogs[key] ?? [];
+    data.push(stripAnsi(stringifyMessage(content) ?? ''));
+    output.push(stripAnsi(stringifyMessage(content) ?? ''));
+    collectedLogs[key] = data;
+    collectedLogs.output = output;
+};
+export const clearCollectedLogs = () => {
+    collectedLogs = {};
+};
+/**
+ * Ouputs information to the user.
+ * Info messages don't get additional formatting.
+ * Note: Info messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export const info = (content, logger = consoleLog) => {
+    const message = stringifyMessage(content);
+    if (isUnitTest())
+        collectLog('info', content);
+    outputWhereAppropriate('info', logger, message);
+};
+/**
+ * Outputs a success message to the user.
+ * Success messages receive a special formatting to make them stand out in the console.
+ * Note: Success messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export const success = (content, logger = consoleLog) => {
+    const message = colors.bold(`✅ Success! ${stringifyMessage(content)}.`);
+    if (isUnitTest())
+        collectLog('success', content);
+    outputWhereAppropriate('info', logger, message);
+};
+/**
+ * Outputs a completed message to the user.
+ * Completed message receive a special formatting to make them stand out in the console.
+ * Note: Completed messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export const completed = (content, logger = consoleLog) => {
+    const message = `${colors.green('✔')} ${stringifyMessage(content)}`;
+    if (isUnitTest())
+        collectLog('completed', content);
+    outputWhereAppropriate('info', logger, message);
+};
+/**
+ * Ouputs debug information to the user. By default these output is hidden unless the user calls the CLI with --verbose.
+ * Debug messages don't get additional formatting.
+ * Note: Debug messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export const debug = (content, logger = consoleLog) => {
+    if (isUnitTest())
+        collectLog('debug', content);
+    const message = colors.gray(stringifyMessage(content));
+    outputWhereAppropriate('debug', logger, `${new Date().toISOString()}: ${message}`);
+};
+/**
+ * Outputs a warning message to the user.
+ * Warning messages receive a special formatting to make them stand out in the console.
+ * Note: Warning messages are sent through the standard output.
+ * @param content - The content to be output to the user.
+ * @param logger - The logging function to use to output to the user.
+ */
+export const warn = (content, logger = consoleWarn) => {
+    if (isUnitTest())
+        collectLog('warn', content);
+    const message = colors.yellow(stringifyMessage(content));
+    outputWhereAppropriate('warn', logger, message);
+};
+/**
+ * Prints a new line in the terminal.
+ */
+export const newline = () => {
+    console.log();
+};
+export function stringifyMessage(message) {
+    if (message instanceof TokenizedString) {
+        return message.value;
+    }
+    else {
+        return message;
+    }
+}
+const message = (content, level = 'info') => {
+    const stringifiedMessage = stringifyMessage(content);
+    outputWhereAppropriate(level, consoleLog, stringifiedMessage);
+};
+export function consoleLog(message) {
+    console.log(withOrWithoutStyle(message));
+}
+export function consoleError(message) {
+    console.error(withOrWithoutStyle(message));
+}
+export function consoleWarn(message) {
+    console.warn(withOrWithoutStyle(message));
+}
+export function outputWhereAppropriate(logLevel, logger, message) {
+    if (shouldOutput(logLevel)) {
+        if (logger instanceof Writable) {
+            logger.write(message);
+        }
+        else {
+            logger(message);
+        }
+    }
+}
+function withOrWithoutStyle(message) {
+    if (shouldDisplayColors()) {
+        return message;
+    }
+    else {
+        return unstyled(message);
+    }
+}
+export function unstyled(message) {
+    return stripAnsi(message);
+}
+export function shouldDisplayColors() {
+    return Boolean(process.stdout.isTTY || process.env.FORCE_COLOR);
+}
+/**
+ * @param packageManager - The package manager that is being used.
+ * @param version - The version to update to
+ */
+export function getOutputUpdateCLIReminder(packageManager, version) {
+    const versionMessage = `💡 Version ${version} available!`;
+    if (!packageManager || packageManager === 'unknown')
+        return versionMessage;
+    const updateCommand = token.packagejsonScript(packageManager, 'shopify upgrade');
+    return content `${versionMessage} Run ${updateCommand}`.value;
+}
+/**
+ * Parse title and body to be a single formatted string
+ * @param title - The title of the message. Will be formatted as a heading.
+ * @param body - The body of the message. Will respect the original formatting.
+ * @returns The formatted message.
+ */
+export function section(title, body) {
+    const formattedTitle = `${title.toUpperCase()}${' '.repeat(35 - title.length)}`;
+    return content `${token.heading(formattedTitle)}\n${body}`.value;
+}
+/* eslint-enable no-console */
+//# sourceMappingURL=output.js.map

package/dist/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../src/output.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,EAAC,UAAU,EAAE,SAAS,EAAC,MAAM,wBAAwB,CAAA;AAE5D,OAAO,MAAM,MAAM,yBAAyB,CAAA;AAC5C,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EAEnB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,sBAAsB,GACvB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,SAAS,MAAM,YAAY,CAAA;AAElC,OAAO,EAAC,QAAQ,EAAC,MAAM,QAAQ,CAAA;AAG/B,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,YAAY,CAAA;AAI/C,MAAM,OAAO,eAAe;IAE1B,YAAY,KAAa;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF;AAID,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,GAAG,EAAE,CAAC,KAAa,EAAE,EAAE;QACrB,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC;IACD,mBAAmB,EAAE,CAAC,KAAc,EAAE,EAAE;QACtC,OAAO,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;IACD,8DAA8D;IAC9D,IAAI,EAAE,CAAC,KAAU,EAAE,EAAE;QACnB,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IACD,IAAI,EAAE,CAAC,KAAc,EAAE,EAAE;QACvB,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IACD,IAAI,EAAE,CAAC,KAAc,EAAE,IAAY,EAAE,EAAE;QACrC,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;IACD,OAAO,EAAE,CAAC,KAAc,EAAE,EAAE;QAC1B,OAAO,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;IACD,UAAU,EAAE,CAAC,KAAc,EAAE,EAAE;QAC7B,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAA;IAC1C,CAAC;IACD,MAAM,EAAE,CAAC,KAAc,EAAE,EAAE;QACzB,OAAO,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACtC,CAAC;IACD,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE;QAC5B,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAA;IACrC,CAAC;IACD,IAAI,EAAE,CAAC,KAAc,EAAE,EAAE;QACvB,OAAO,IAAI,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IACD,MAAM,EAAE,CAAC,KAAc,EAAE,EAAE;QACzB,OAAO,IAAI,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IACpD,CAAC;IACD,OAAO,EAAE,CAAC,KAAc,EAAE,EAAE;QAC1B,OAAO,IAAI,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;IACrD,CAAC;IACD,KAAK,EAAE,CAAC,KAAc,EAAE,EAAE;QACxB,OAAO,IAAI,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IACnD,CAAC;IACD,iBAAiB,EAAE,CAAC,cAA8B,EAAE,UAAkB,EAAE,GAAG,UAAoB,EAAE,EAAE;QACjG,OAAO,IAAI,mBAAmB,CAAC,2BAA2B,CAAC,cAAc,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,CAAC,CAAA;IACxG,CAAC;IACD,WAAW,EAAE,GAAG,EAAE;QAChB,OAAO,IAAI,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IACjD,CAAC;IACD,QAAQ,EAAE,GAAG,EAAE;QACb,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAA;IACnC,CAAC;IACD,SAAS,EAAE,CAAC,KAAe,EAAE,EAAE;QAC7B,OAAO,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAA;IACzC,CAAC;CACF,CAAA;AAED,MAAM,UAAU,2BAA2B,CACzC,cAA8B,EAC9B,UAAkB,EAClB,GAAG,UAAoB;IAEvB,QAAQ,cAAc,EAAE;QACtB,KAAK,MAAM,CAAC,CAAC;YACX,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,CAAA;YAClD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACxB;QACD,KAAK,MAAM,CAAC;QACZ,KAAK,KAAK,CAAC,CAAC;YACV,MAAM,MAAM,GAAG,CAAC,cAAc,EAAE,KAAK,EAAE,UAAU,CAAC,CAAA;YAClD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACjB,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;aAC3B;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACxB;KACF;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,OAA6B,EAAE,GAAG,IAAwC;IAChG,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC5B,MAAM,IAAI,MAAM,CAAA;QAChB,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;YACpB,OAAM;SACP;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAE,CAAA;QAEtB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAA;SAChB;aAAM;YACL,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,EAAE,CAAA;YAEtC,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;gBAClC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;oBACvC,MAAM,IAAI,IAAI,CAAA;gBAChB,CAAC,CAAC,CAAA;aACH;iBAAM;gBACL,MAAM,IAAI,eAAe,CAAA;aAC1B;SACF;IACH,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAA;AACpC,CAAC;AAKD;;;;GAIG;AACH,MAAM,aAAa,GAAG,CAAC,KAAe,EAAU,EAAE;IAChD,QAAQ,KAAK,EAAE;QACb,KAAK,OAAO;YACV,OAAO,EAAE,CAAA;QACX,KAAK,OAAO;YACV,OAAO,EAAE,CAAA;QACX,KAAK,MAAM;YACT,OAAO,EAAE,CAAA;QACX,KAAK,MAAM;YACT,OAAO,EAAE,CAAA;QACX,KAAK,OAAO;YACV,OAAO,EAAE,CAAA;QACX,KAAK,OAAO;YACV,OAAO,EAAE,CAAA;QACX;YACE,OAAO,EAAE,CAAA;KACZ;AACH,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAa,EAAE;IAC5C,IAAI,SAAS,EAAE,EAAE;QACf,OAAO,OAAO,CAAA;KACf;SAAM;QACL,OAAO,MAAM,CAAA;KACd;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAW,EAAE;IAC1D,IAAI,UAAU,EAAE,EAAE;QAChB,OAAO,KAAK,CAAA;KACb;IACD,MAAM,oBAAoB,GAAG,aAAa,CAAC,eAAe,EAAE,CAAC,CAAA;IAC7D,MAAM,oBAAoB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;IACpD,OAAO,oBAAoB,IAAI,oBAAoB,CAAA;AACrD,CAAC,CAAA;AAED,qDAAqD;AACrD,MAAM,CAAC,IAAI,aAAa,GAA8B,EAAE,CAAA;AAExD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,OAAgB,EAAE,EAAE;IAC1D,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,IAAI,EAAE,CAAA;IACzC,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;IACrC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IACrD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IACvD,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IACzB,aAAa,CAAC,MAAM,GAAG,MAAM,CAAA;AAC/B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,EAAE;IACrC,aAAa,GAAG,EAAE,CAAA;AACpB,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,OAAgB,EAAE,SAAiB,UAAU,EAAE,EAAE;IACpE,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACzC,IAAI,UAAU,EAAE;QAAE,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7C,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AACjD,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAgB,EAAE,SAAiB,UAAU,EAAE,EAAE;IACvE,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IACvE,IAAI,UAAU,EAAE;QAAE,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAChD,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AACjD,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAgB,EAAE,SAAiB,UAAU,EAAE,EAAE;IACzE,MAAM,OAAO,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAA;IACnE,IAAI,UAAU,EAAE;QAAE,UAAU,CAAC,WAAW,EAAE,OAAO,CAAC,CAAA;IAClD,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AACjD,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,OAAgB,EAAE,SAAiB,UAAU,EAAE,EAAE;IACrE,IAAI,UAAU,EAAE;QAAE,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC9C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;IACtD,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC,CAAA;AACpF,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,OAAgB,EAAE,SAAiB,WAAW,EAAE,EAAE;IACrE,IAAI,UAAU,EAAE;QAAE,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;IACxD,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AACjD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,EAAE;IAC1B,OAAO,CAAC,GAAG,EAAE,CAAA;AACf,CAAC,CAAA;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAC/C,IAAI,OAAO,YAAY,eAAe,EAAE;QACtC,OAAO,OAAO,CAAC,KAAK,CAAA;KACrB;SAAM;QACL,OAAO,OAAO,CAAA;KACf;AACH,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,OAAgB,EAAE,QAAkB,MAAM,EAAE,EAAE;IAC7D,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACpD,sBAAsB,CAAC,KAAK,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAA;AAC/D,CAAC,CAAA;AAeD,MAAM,UAAU,UAAU,CAAC,OAAe;IACxC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;AAC1C,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;AAC5C,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAe;IACzC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,QAAkB,EAAE,MAAc,EAAE,OAAe;IACxF,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;QAC1B,IAAI,MAAM,YAAY,QAAQ,EAAE;YAC9B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SACtB;aAAM;YACL,MAAM,CAAC,OAAO,CAAC,CAAA;SAChB;KACF;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAe;IACzC,IAAI,mBAAmB,EAAE,EAAE;QACzB,OAAO,OAAO,CAAA;KACf;SAAM;QACL,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAA;KACzB;AACH,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,OAAe;IACtC,OAAO,SAAS,CAAC,OAAO,CAAC,CAAA;AAC3B,CAAC;AAED,MAAM,UAAU,mBAAmB;IACjC,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CACxC,cAAsD,EACtD,OAAe;IAEf,MAAM,cAAc,GAAG,cAAc,OAAO,aAAa,CAAA;IACzD,IAAI,CAAC,cAAc,IAAI,cAAc,KAAK,SAAS;QAAE,OAAO,cAAc,CAAA;IAE1E,MAAM,aAAa,GAAG,KAAK,CAAC,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAA;IAChF,OAAO,OAAO,CAAA,GAAG,cAAc,QAAQ,aAAa,EAAE,CAAC,KAAK,CAAA;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa,EAAE,IAAY;IACjD,MAAM,cAAc,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAA;IAC/E,OAAO,OAAO,CAAA,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK,CAAA;AACjE,CAAC;AAED,8BAA8B","sourcesContent":["/* eslint-disable no-console */\nimport {isUnitTest, isVerbose} from './environment/local.js'\nimport {PackageManager} from './public/node/node-package-manager.js'\nimport colors from './public/node/colors.js'\nimport {\n  ColorContentToken,\n  CommandContentToken,\n  ContentToken,\n  ErrorContentToken,\n  HeadingContentToken,\n  ItalicContentToken,\n  JsonContentToken,\n  LinesDiffContentToken,\n  LinkContentToken,\n  PathContentToken,\n  RawContentToken,\n  SubHeadingContentToken,\n} from './content-tokens.js'\nimport stripAnsi from 'strip-ansi'\nimport {AbortSignal} from '@shopify/cli-kit/node/abort'\nimport {Writable} from 'stream'\nimport type {Change} from 'diff'\n\nexport {default as logUpdate} from 'log-update'\n\nexport type Logger = Writable | ((message: string) => void)\n\nexport class TokenizedString {\n  value: string\n  constructor(value: string) {\n    this.value = value\n  }\n}\n\nexport type Message = string | TokenizedString\n\nexport const token = {\n  raw: (value: string) => {\n    return new RawContentToken(value)\n  },\n  genericShellCommand: (value: Message) => {\n    return new CommandContentToken(value)\n  },\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  json: (value: any) => {\n    return new JsonContentToken(value)\n  },\n  path: (value: Message) => {\n    return new PathContentToken(value)\n  },\n  link: (value: Message, link: string) => {\n    return new LinkContentToken(value, link)\n  },\n  heading: (value: Message) => {\n    return new HeadingContentToken(value)\n  },\n  subheading: (value: Message) => {\n    return new SubHeadingContentToken(value)\n  },\n  italic: (value: Message) => {\n    return new ItalicContentToken(value)\n  },\n  errorText: (value: Message) => {\n    return new ErrorContentToken(value)\n  },\n  cyan: (value: Message) => {\n    return new ColorContentToken(value, colors.cyan)\n  },\n  yellow: (value: Message) => {\n    return new ColorContentToken(value, colors.yellow)\n  },\n  magenta: (value: Message) => {\n    return new ColorContentToken(value, colors.magenta)\n  },\n  green: (value: Message) => {\n    return new ColorContentToken(value, colors.green)\n  },\n  packagejsonScript: (packageManager: PackageManager, scriptName: string, ...scriptArgs: string[]) => {\n    return new CommandContentToken(formatPackageManagerCommand(packageManager, scriptName, ...scriptArgs))\n  },\n  successIcon: () => {\n    return new ColorContentToken('✔', colors.green)\n  },\n  failIcon: () => {\n    return new ErrorContentToken('✖')\n  },\n  linesDiff: (value: Change[]) => {\n    return new LinesDiffContentToken(value)\n  },\n}\n\nexport function formatPackageManagerCommand(\n  packageManager: PackageManager,\n  scriptName: string,\n  ...scriptArgs: string[]\n): string {\n  switch (packageManager) {\n    case 'yarn': {\n      const pieces = ['yarn', scriptName, ...scriptArgs]\n      return pieces.join(' ')\n    }\n    case 'pnpm':\n    case 'npm': {\n      const pieces = [packageManager, 'run', scriptName]\n      if (scriptArgs.length > 0) {\n        pieces.push('--')\n        pieces.push(...scriptArgs)\n      }\n      return pieces.join(' ')\n    }\n  }\n}\n\nexport function content(strings: TemplateStringsArray, ...keys: (ContentToken<unknown> | string)[]): TokenizedString {\n  let output = ``\n  strings.forEach((string, i) => {\n    output += string\n    if (i >= keys.length) {\n      return\n    }\n    const token = keys[i]!\n\n    if (typeof token === 'string') {\n      output += token\n    } else {\n      const enumTokenOutput = token.output()\n\n      if (Array.isArray(enumTokenOutput)) {\n        enumTokenOutput.forEach((line: string) => {\n          output += line\n        })\n      } else {\n        output += enumTokenOutput\n      }\n    }\n  })\n  return new TokenizedString(output)\n}\n\n/** Log levels */\nexport type LogLevel = 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent'\n\n/**\n * It maps a level to a numeric value.\n * @param level - The level for which we'll return its numeric value.\n * @returns The numeric value of the level.\n */\nconst logLevelValue = (level: LogLevel): number => {\n  switch (level) {\n    case 'trace':\n      return 10\n    case 'debug':\n      return 20\n    case 'info':\n      return 30\n    case 'warn':\n      return 40\n    case 'error':\n      return 50\n    case 'fatal':\n      return 60\n    default:\n      return 30\n  }\n}\n\n/**\n *\n * @returns It returns the log level set by the user.\n */\nexport const currentLogLevel = (): LogLevel => {\n  if (isVerbose()) {\n    return 'debug'\n  } else {\n    return 'info'\n  }\n}\n\nexport const shouldOutput = (logLevel: LogLevel): boolean => {\n  if (isUnitTest()) {\n    return false\n  }\n  const currentLogLevelValue = logLevelValue(currentLogLevel())\n  const messageLogLevelValue = logLevelValue(logLevel)\n  return messageLogLevelValue >= currentLogLevelValue\n}\n\n// eslint-disable-next-line import/no-mutable-exports\nexport let collectedLogs: {[key: string]: string[]} = {}\n\n/**\n * This is only used during UnitTesting.\n * If we are in a testing context, instead of printing the logs to the console,\n * we will store them in a variable that can be accessed from the tests.\n * @param key - The key of the log.\n * @param content - The content of the log.\n */\nexport const collectLog = (key: string, content: Message) => {\n  const output = collectedLogs.output ?? []\n  const data = collectedLogs[key] ?? []\n  data.push(stripAnsi(stringifyMessage(content) ?? ''))\n  output.push(stripAnsi(stringifyMessage(content) ?? ''))\n  collectedLogs[key] = data\n  collectedLogs.output = output\n}\n\nexport const clearCollectedLogs = () => {\n  collectedLogs = {}\n}\n\n/**\n * Ouputs information to the user.\n * Info messages don't get additional formatting.\n * Note: Info messages are sent through the standard output.\n * @param content - The content to be output to the user.\n * @param logger - The logging function to use to output to the user.\n */\nexport const info = (content: Message, logger: Logger = consoleLog) => {\n  const message = stringifyMessage(content)\n  if (isUnitTest()) collectLog('info', content)\n  outputWhereAppropriate('info', logger, message)\n}\n\n/**\n * Outputs a success message to the user.\n * Success messages receive a special formatting to make them stand out in the console.\n * Note: Success messages are sent through the standard output.\n * @param content - The content to be output to the user.\n * @param logger - The logging function to use to output to the user.\n */\nexport const success = (content: Message, logger: Logger = consoleLog) => {\n  const message = colors.bold(`✅ Success! ${stringifyMessage(content)}.`)\n  if (isUnitTest()) collectLog('success', content)\n  outputWhereAppropriate('info', logger, message)\n}\n\n/**\n * Outputs a completed message to the user.\n * Completed message receive a special formatting to make them stand out in the console.\n * Note: Completed messages are sent through the standard output.\n * @param content - The content to be output to the user.\n * @param logger - The logging function to use to output to the user.\n */\nexport const completed = (content: Message, logger: Logger = consoleLog) => {\n  const message = `${colors.green('✔')} ${stringifyMessage(content)}`\n  if (isUnitTest()) collectLog('completed', content)\n  outputWhereAppropriate('info', logger, message)\n}\n\n/**\n * Ouputs debug information to the user. By default these output is hidden unless the user calls the CLI with --verbose.\n * Debug messages don't get additional formatting.\n * Note: Debug messages are sent through the standard output.\n * @param content - The content to be output to the user.\n * @param logger - The logging function to use to output to the user.\n */\nexport const debug = (content: Message, logger: Logger = consoleLog) => {\n  if (isUnitTest()) collectLog('debug', content)\n  const message = colors.gray(stringifyMessage(content))\n  outputWhereAppropriate('debug', logger, `${new Date().toISOString()}: ${message}`)\n}\n\n/**\n * Outputs a warning message to the user.\n * Warning messages receive a special formatting to make them stand out in the console.\n * Note: Warning messages are sent through the standard output.\n * @param content - The content to be output to the user.\n * @param logger - The logging function to use to output to the user.\n */\nexport const warn = (content: Message, logger: Logger = consoleWarn) => {\n  if (isUnitTest()) collectLog('warn', content)\n  const message = colors.yellow(stringifyMessage(content))\n  outputWhereAppropriate('warn', logger, message)\n}\n\n/**\n * Prints a new line in the terminal.\n */\nexport const newline = () => {\n  console.log()\n}\n\nexport function stringifyMessage(message: Message): string {\n  if (message instanceof TokenizedString) {\n    return message.value\n  } else {\n    return message\n  }\n}\n\nconst message = (content: Message, level: LogLevel = 'info') => {\n  const stringifiedMessage = stringifyMessage(content)\n  outputWhereAppropriate(level, consoleLog, stringifiedMessage)\n}\n\nexport interface OutputProcess {\n  /** The prefix to include in the logs\n   *   [vite] Output coming from Vite\n   */\n  prefix: string\n  /**\n   * A callback to invoke the process. stdout and stderr should be used\n   * to send standard output and error data that gets formatted with the\n   * right prefix.\n   */\n  action: (stdout: Writable, stderr: Writable, signal: AbortSignal) => Promise<void>\n}\n\nexport function consoleLog(message: string): void {\n  console.log(withOrWithoutStyle(message))\n}\n\nexport function consoleError(message: string): void {\n  console.error(withOrWithoutStyle(message))\n}\n\nexport function consoleWarn(message: string): void {\n  console.warn(withOrWithoutStyle(message))\n}\n\nexport function outputWhereAppropriate(logLevel: LogLevel, logger: Logger, message: string): void {\n  if (shouldOutput(logLevel)) {\n    if (logger instanceof Writable) {\n      logger.write(message)\n    } else {\n      logger(message)\n    }\n  }\n}\n\nfunction withOrWithoutStyle(message: string): string {\n  if (shouldDisplayColors()) {\n    return message\n  } else {\n    return unstyled(message)\n  }\n}\n\nexport function unstyled(message: string): string {\n  return stripAnsi(message)\n}\n\nexport function shouldDisplayColors(): boolean {\n  return Boolean(process.stdout.isTTY || process.env.FORCE_COLOR)\n}\n\n/**\n * @param packageManager - The package manager that is being used.\n * @param version - The version to update to\n */\nexport function getOutputUpdateCLIReminder(\n  packageManager: PackageManager | 'unknown' | undefined,\n  version: string,\n): string {\n  const versionMessage = `💡 Version ${version} available!`\n  if (!packageManager || packageManager === 'unknown') return versionMessage\n\n  const updateCommand = token.packagejsonScript(packageManager, 'shopify upgrade')\n  return content`${versionMessage} Run ${updateCommand}`.value\n}\n\n/**\n * Parse title and body to be a single formatted string\n * @param title - The title of the message. Will be formatted as a heading.\n * @param body - The body of the message. Will respect the original formatting.\n * @returns The formatted message.\n */\nexport function section(title: string, body: string): string {\n  const formattedTitle = `${title.toUpperCase()}${' '.repeat(35 - title.length)}`\n  return content`${token.heading(formattedTitle)}\\n${body}`.value\n}\n\n/* eslint-enable no-console */\n"]}

package/dist/path.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import { OverloadParameters } from './typing/overloaded-parameters.js';
+import { relative, dirname, join, normalize, resolve, basename, extname, isAbsolute, parse } from 'pathe';
+import { findUp as internalFindUp } from 'find-up';
+import type { URL } from 'url';
+import type { Pattern, Options } from 'fast-glob';
+export { join, relative, dirname, normalize, resolve, basename, extname, isAbsolute, parse };
+export declare function glob(pattern: Pattern | Pattern[], options?: Options): Promise<string[]>;
+export { pathToFileURL } from 'url';
+export declare function findUp(matcher: OverloadParameters<typeof internalFindUp>[0], options: OverloadParameters<typeof internalFindUp>[1]): ReturnType<typeof internalFindUp>;
+/**
+ * Given an absolute filesystem path, it makes it relative to
+ * the current working directory. This is useful when logging paths
+ * to allow the users to click on the file and let the OS open it
+ * in the editor of choice.
+ * @param path - Path to relativize
+ * @returns Relativized path.
+ */
+export declare function relativize(path: string): string;
+/**
+ * Given a module's import.meta.url it returns the directory containing the module.
+ * @param moduleURL - The value of import.meta.url in the context of the caller module.
+ * @returns The path to the directory containing the caller module.
+ */
+export declare function moduleDirectory(moduleURL: string | URL): string;

package/dist/path.js

@@ -0,0 +1,48 @@
+import commondir from 'commondir';
+import { relative, dirname, join, normalize, resolve, basename, extname, isAbsolute, parse } from 'pathe';
+import { findUp as internalFindUp } from 'find-up';
+import { fileURLToPath } from 'url';
+export { join, relative, dirname, normalize, resolve, basename, extname, isAbsolute, parse };
+export async function glob(pattern, options) {
+    const { default: fastGlob } = await import('fast-glob');
+    let overridenOptions = options;
+    if (options?.dot == null) {
+        overridenOptions = { ...options, dot: true };
+    }
+    return fastGlob(pattern, overridenOptions);
+}
+export { pathToFileURL } from 'url';
+export async function findUp(matcher, options) {
+    // findUp has odd typing
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const got = await internalFindUp(matcher, options);
+    return got ? normalize(got) : undefined;
+}
+/**
+ * Given an absolute filesystem path, it makes it relative to
+ * the current working directory. This is useful when logging paths
+ * to allow the users to click on the file and let the OS open it
+ * in the editor of choice.
+ * @param path - Path to relativize
+ * @returns Relativized path.
+ */
+export function relativize(path) {
+    const result = commondir([path, process.cwd()]);
+    const relativePath = relative(process.cwd(), path);
+    const relativeComponents = relativePath.split('/').filter((component) => component === '..').length;
+    if (result === '/' || relativePath === '' || relativeComponents > 2) {
+        return path;
+    }
+    else {
+        return relativePath;
+    }
+}
+/**
+ * Given a module's import.meta.url it returns the directory containing the module.
+ * @param moduleURL - The value of import.meta.url in the context of the caller module.
+ * @returns The path to the directory containing the caller module.
+ */
+export function moduleDirectory(moduleURL) {
+    return dirname(fileURLToPath(moduleURL));
+}
+//# sourceMappingURL=path.js.map

package/dist/path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAA;AACjC,OAAO,EAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAC,MAAM,OAAO,CAAA;AACvG,OAAO,EAAC,MAAM,IAAI,cAAc,EAAC,MAAM,SAAS,CAAA;AAChD,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAA;AAKjC,OAAO,EAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAC,CAAA;AAE1F,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAA4B,EAAE,OAAiB;IACxE,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;IACrD,IAAI,gBAAgB,GAAG,OAAO,CAAA;IAC9B,IAAI,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE;QACxB,gBAAgB,GAAG,EAAC,GAAG,OAAO,EAAE,GAAG,EAAE,IAAI,EAAC,CAAA;KAC3C;IACD,OAAO,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AAC5C,CAAC;AACD,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAA;AAEjC,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,OAAqD,EACrD,OAAqD;IAErD,wBAAwB;IACxB,8DAA8D;IAC9D,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,OAAc,EAAE,OAAO,CAAC,CAAA;IACzD,OAAO,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;IAC/C,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAA;IAClD,MAAM,kBAAkB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,MAAM,CAAA;IACnG,IAAI,MAAM,KAAK,GAAG,IAAI,YAAY,KAAK,EAAE,IAAI,kBAAkB,GAAG,CAAC,EAAE;QACnE,OAAO,IAAI,CAAA;KACZ;SAAM;QACL,OAAO,YAAY,CAAA;KACpB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,SAAuB;IACrD,OAAO,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAA;AAC1C,CAAC","sourcesContent":["import {OverloadParameters} from './typing/overloaded-parameters.js'\nimport commondir from 'commondir'\nimport {relative, dirname, join, normalize, resolve, basename, extname, isAbsolute, parse} from 'pathe'\nimport {findUp as internalFindUp} from 'find-up'\nimport {fileURLToPath} from 'url'\n// eslint-disable-next-line node/prefer-global/url\nimport type {URL} from 'url'\nimport type {Pattern, Options} from 'fast-glob'\n\nexport {join, relative, dirname, normalize, resolve, basename, extname, isAbsolute, parse}\n\nexport async function glob(pattern: Pattern | Pattern[], options?: Options): Promise<string[]> {\n  const {default: fastGlob} = await import('fast-glob')\n  let overridenOptions = options\n  if (options?.dot == null) {\n    overridenOptions = {...options, dot: true}\n  }\n  return fastGlob(pattern, overridenOptions)\n}\nexport {pathToFileURL} from 'url'\n\nexport async function findUp(\n  matcher: OverloadParameters<typeof internalFindUp>[0],\n  options: OverloadParameters<typeof internalFindUp>[1],\n): ReturnType<typeof internalFindUp> {\n  // findUp has odd typing\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const got = await internalFindUp(matcher as any, options)\n  return got ? normalize(got) : undefined\n}\n\n/**\n * Given an absolute filesystem path, it makes it relative to\n * the current working directory. This is useful when logging paths\n * to allow the users to click on the file and let the OS open it\n * in the editor of choice.\n * @param path - Path to relativize\n * @returns Relativized path.\n */\nexport function relativize(path: string): string {\n  const result = commondir([path, process.cwd()])\n  const relativePath = relative(process.cwd(), path)\n  const relativeComponents = relativePath.split('/').filter((component) => component === '..').length\n  if (result === '/' || relativePath === '' || relativeComponents > 2) {\n    return path\n  } else {\n    return relativePath\n  }\n}\n\n/**\n * Given a module's import.meta.url it returns the directory containing the module.\n * @param moduleURL - The value of import.meta.url in the context of the caller module.\n * @returns The path to the directory containing the caller module.\n */\nexport function moduleDirectory(moduleURL: string | URL): string {\n  return dirname(fileURLToPath(moduleURL))\n}\n"]}

package/dist/plugins.d.ts

@@ -0,0 +1,73 @@
+import { JsonMap } from './private/common/json.js';
+import { PickByPrefix } from './typing/pick-by-prefix.js';
+import { MonorailEventPublic, MonorailEventSensitive } from './monorail.js';
+import { HookReturnPerTunnelPlugin } from './public/node/plugins/tunnel.js';
+import { Result } from './public/node/result.js';
+import { Config, Interfaces } from '@oclif/core';
+/**
+ * Convenience function to trigger a hook, and gather any successful responses. Failures are ignored.
+ *
+ * Responses are organised into a dictionary, keyed by plug-in name. Only plug-ins that have hooks registered for the given event, and the hooks were run successfully, are included.
+ */
+export declare function fanoutHooks<TPluginMap extends HookReturnsPerPlugin, TEvent extends string & keyof TPluginMap>(config: Interfaces.Config, event: TEvent, options: TPluginMap[typeof event]['options'], timeout?: number): Promise<Partial<TPluginMap[typeof event]['pluginReturns']>>;
+declare type AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id'> & PickByPrefix<MonorailEventPublic, 'cmd_extensions_'> & PickByPrefix<MonorailEventPublic, 'cmd_scaffold_'>;
+declare type AppSpecificSensitiveMonorailFields = PickByPrefix<MonorailEventSensitive, 'app_'>;
+export interface HookReturnsPerPlugin extends HookReturnPerTunnelPlugin {
+    public_command_metadata: {
+        options: {
+            [key: string]: never;
+        };
+        pluginReturns: {
+            '@shopify/app': Partial<AppSpecificMonorailFields>;
+            [pluginName: string]: JsonMap;
+        };
+    };
+    sensitive_command_metadata: {
+        options: {
+            [key: string]: never;
+        };
+        pluginReturns: {
+            '@shopify/app': Partial<AppSpecificSensitiveMonorailFields>;
+            [pluginName: string]: JsonMap;
+        };
+    };
+    [hookName: string]: {
+        options: {
+            [key: string]: unknown;
+        };
+        pluginReturns: {
+            [key: string]: unknown;
+        };
+    };
+}
+export declare type PluginReturnsForHook<TEvent extends keyof TPluginMap, TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'], TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin> = TPluginMap[TEvent]['pluginReturns'][TPluginName];
+export declare type FanoutHookFunction<TEvent extends keyof TPluginMap = string, TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'] = string, TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin> = (this: Interfaces.Hook.Context, options: TPluginMap[TEvent]['options'] & {
+    config: Interfaces.Config;
+}) => Promise<PluginReturnsForHook<TEvent, TPluginName, TPluginMap>>;
+/**
+ * Execute the 'tunnel_provider' hook, and return the list of available tunnel providers.
+ * Fail if there are multiple plugins for the same provider
+ *
+ * @param config - oclif config used to execute hooks
+ * @returns list of available tunnel plugins
+ */
+export declare function getListOfTunnelPlugins(config: Config): Promise<{
+    plugins: string[];
+    error?: string;
+}>;
+export interface TunnelPluginError {
+    provider: string;
+    type: 'multiple-urls' | 'handled-error' | 'unknown' | 'no-provider';
+    message?: string;
+}
+/**
+ * Execute the 'tunnel_start' hook for the given provider.
+ * Fails if there aren't plugins for that provider or if there are more than one.
+ *
+ * @param config - oclif config used to execute hooks
+ * @param port - port where the tunnel will be started
+ * @param provider - selected provider, must be unique
+ * @returns tunnel URL from the selected provider
+ */
+export declare function runTunnelPlugin(config: Config, port: number, provider: string): Promise<Result<string, TunnelPluginError>>;
+export {};

package/dist/plugins.js

@@ -0,0 +1,49 @@
+import { getArrayContainsDuplicates, getArrayRejectingUndefined } from './public/common/array.js';
+import { err } from './public/node/result.js';
+/**
+ * Convenience function to trigger a hook, and gather any successful responses. Failures are ignored.
+ *
+ * Responses are organised into a dictionary, keyed by plug-in name. Only plug-ins that have hooks registered for the given event, and the hooks were run successfully, are included.
+ */
+export async function fanoutHooks(config, event, options, timeout) {
+    const res = await config.runHook(event, options, timeout);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return Object.fromEntries(res.successes.map(({ result, plugin }) => [plugin.name, result]));
+}
+/**
+ * Execute the 'tunnel_provider' hook, and return the list of available tunnel providers.
+ * Fail if there are multiple plugins for the same provider
+ *
+ * @param config - oclif config used to execute hooks
+ * @returns list of available tunnel plugins
+ */
+export async function getListOfTunnelPlugins(config) {
+    const hooks = await fanoutHooks(config, 'tunnel_provider', {});
+    const names = getArrayRejectingUndefined(Object.values(hooks).map((key) => key?.name));
+    if (getArrayContainsDuplicates(names))
+        return { plugins: names, error: 'multiple-plugins-for-provider' };
+    return { plugins: names };
+}
+/**
+ * Execute the 'tunnel_start' hook for the given provider.
+ * Fails if there aren't plugins for that provider or if there are more than one.
+ *
+ * @param config - oclif config used to execute hooks
+ * @param port - port where the tunnel will be started
+ * @param provider - selected provider, must be unique
+ * @returns tunnel URL from the selected provider
+ */
+export async function runTunnelPlugin(config, port, provider) {
+    const hooks = await fanoutHooks(config, 'tunnel_start', { port, provider });
+    const urlResults = Object.values(hooks).filter((tunnelResponse) => !tunnelResponse?.isErr() || tunnelResponse.error.type !== 'invalid-provider');
+    if (urlResults.length > 1)
+        return err({ provider, type: 'multiple-urls' });
+    if (urlResults.length === 0 || !urlResults[0])
+        return err({ provider, type: 'no-provider' });
+    return urlResults[0]
+        .map((data) => data.url)
+        .mapError((error) => error.type === 'unknown'
+        ? { provider, type: 'unknown', message: error.message }
+        : { provider, type: 'handled-error' });
+}
+//# sourceMappingURL=plugins.js.map

package/dist/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,0BAA0B,EAAE,0BAA0B,EAAC,MAAM,0BAA0B,CAAA;AAC/F,OAAO,EAAC,GAAG,EAAS,MAAM,yBAAyB,CAAA;AAGnD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAyB,EACzB,KAAa,EACb,OAA4C,EAC5C,OAAgB;IAEhB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACzD,8DAA8D;IAC9D,OAAO,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAQ,CAAA;AAClG,CAAC;AA4CD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,MAAc;IACzD,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAA;IAC9D,MAAM,KAAK,GAAG,0BAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;IACtF,IAAI,0BAA0B,CAAC,KAAK,CAAC;QAAE,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,+BAA+B,EAAC,CAAA;IACtG,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,CAAA;AACzB,CAAC;AAQD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAc,EACd,IAAY,EACZ,QAAgB;IAEhB,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC,CAAA;IACzE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAC5C,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,cAAc,EAAE,KAAK,EAAE,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,KAAK,kBAAkB,CACjG,CAAA;IACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAC,CAAC,CAAA;IACxE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,EAAC,CAAC,CAAA;IAE1F,OAAO,UAAU,CAAC,CAAC,CAAC;SACjB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;SACvB,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAClB,KAAK,CAAC,IAAI,KAAK,SAAS;QACtB,CAAC,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAC;QACrD,CAAC,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAC,CACtC,CAAA;AACL,CAAC","sourcesContent":["import {JsonMap} from './private/common/json.js'\nimport {PickByPrefix} from './typing/pick-by-prefix.js'\nimport {MonorailEventPublic, MonorailEventSensitive} from './monorail.js'\nimport {HookReturnPerTunnelPlugin} from './public/node/plugins/tunnel.js'\nimport {getArrayContainsDuplicates, getArrayRejectingUndefined} from './public/common/array.js'\nimport {err, Result} from './public/node/result.js'\nimport {Config, Interfaces} from '@oclif/core'\n\n/**\n * Convenience function to trigger a hook, and gather any successful responses. Failures are ignored.\n *\n * Responses are organised into a dictionary, keyed by plug-in name. Only plug-ins that have hooks registered for the given event, and the hooks were run successfully, are included.\n */\nexport async function fanoutHooks<TPluginMap extends HookReturnsPerPlugin, TEvent extends string & keyof TPluginMap>(\n  config: Interfaces.Config,\n  event: TEvent,\n  options: TPluginMap[typeof event]['options'],\n  timeout?: number,\n): Promise<Partial<TPluginMap[typeof event]['pluginReturns']>> {\n  const res = await config.runHook(event, options, timeout)\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  return Object.fromEntries(res.successes.map(({result, plugin}) => [plugin.name, result])) as any\n}\n\ntype AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id'> &\n  PickByPrefix<MonorailEventPublic, 'cmd_extensions_'> &\n  PickByPrefix<MonorailEventPublic, 'cmd_scaffold_'>\n\ntype AppSpecificSensitiveMonorailFields = PickByPrefix<MonorailEventSensitive, 'app_'>\n\nexport interface HookReturnsPerPlugin extends HookReturnPerTunnelPlugin {\n  public_command_metadata: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      '@shopify/app': Partial<AppSpecificMonorailFields>\n      [pluginName: string]: JsonMap\n    }\n  }\n  sensitive_command_metadata: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      '@shopify/app': Partial<AppSpecificSensitiveMonorailFields>\n      [pluginName: string]: JsonMap\n    }\n  }\n  [hookName: string]: {\n    options: {[key: string]: unknown}\n    pluginReturns: {[key: string]: unknown}\n  }\n}\n\nexport type PluginReturnsForHook<\n  TEvent extends keyof TPluginMap,\n  TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'],\n  TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin,\n> = TPluginMap[TEvent]['pluginReturns'][TPluginName]\n\nexport type FanoutHookFunction<\n  TEvent extends keyof TPluginMap = string,\n  TPluginName extends keyof TPluginMap[TEvent]['pluginReturns'] = string,\n  TPluginMap extends HookReturnsPerPlugin = HookReturnsPerPlugin,\n> = (\n  this: Interfaces.Hook.Context,\n  options: TPluginMap[TEvent]['options'] & {config: Interfaces.Config},\n) => Promise<PluginReturnsForHook<TEvent, TPluginName, TPluginMap>>\n\n/**\n * Execute the 'tunnel_provider' hook, and return the list of available tunnel providers.\n * Fail if there are multiple plugins for the same provider\n *\n * @param config - oclif config used to execute hooks\n * @returns list of available tunnel plugins\n */\nexport async function getListOfTunnelPlugins(config: Config): Promise<{plugins: string[]; error?: string}> {\n  const hooks = await fanoutHooks(config, 'tunnel_provider', {})\n  const names = getArrayRejectingUndefined(Object.values(hooks).map((key) => key?.name))\n  if (getArrayContainsDuplicates(names)) return {plugins: names, error: 'multiple-plugins-for-provider'}\n  return {plugins: names}\n}\n\nexport interface TunnelPluginError {\n  provider: string\n  type: 'multiple-urls' | 'handled-error' | 'unknown' | 'no-provider'\n  message?: string\n}\n\n/**\n * Execute the 'tunnel_start' hook for the given provider.\n * Fails if there aren't plugins for that provider or if there are more than one.\n *\n * @param config - oclif config used to execute hooks\n * @param port - port where the tunnel will be started\n * @param provider - selected provider, must be unique\n * @returns tunnel URL from the selected provider\n */\nexport async function runTunnelPlugin(\n  config: Config,\n  port: number,\n  provider: string,\n): Promise<Result<string, TunnelPluginError>> {\n  const hooks = await fanoutHooks(config, 'tunnel_start', {port, provider})\n  const urlResults = Object.values(hooks).filter(\n    (tunnelResponse) => !tunnelResponse?.isErr() || tunnelResponse.error.type !== 'invalid-provider',\n  )\n  if (urlResults.length > 1) return err({provider, type: 'multiple-urls'})\n  if (urlResults.length === 0 || !urlResults[0]) return err({provider, type: 'no-provider'})\n\n  return urlResults[0]\n    .map((data) => data.url)\n    .mapError((error) =>\n      error.type === 'unknown'\n        ? {provider, type: 'unknown', message: error.message}\n        : {provider, type: 'handled-error'},\n    )\n}\n"]}

package/dist/private/common/json.d.ts

@@ -0,0 +1,6 @@
+export interface JsonMap {
+    [key: string]: AnyJson;
+}
+declare type JsonArray = undefined[] | null[] | boolean[] | number[] | string[] | JsonMap[] | Date[];
+export declare type AnyJson = undefined | null | boolean | number | string | JsonMap | Date | JsonArray | JsonArray[];
+export {};

package/dist/private/common/json.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=json.js.map

package/dist/private/common/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/private/common/json.ts"],"names":[],"mappings":"","sourcesContent":["export interface JsonMap {\n  [key: string]: AnyJson\n}\ntype JsonArray = undefined[] | null[] | boolean[] | number[] | string[] | JsonMap[] | Date[]\nexport type AnyJson = undefined | null | boolean | number | string | JsonMap | Date | JsonArray | JsonArray[]\n"]}

package/dist/private/common/lodash.d.ts

@@ -0,0 +1,47 @@
+export declare type PartialShallow<T> = {
+    [P in keyof T]?: T[P] extends object ? object : T[P];
+};
+export declare type PropertyName = string | number | symbol;
+export declare type IterateeShorthand<T> = PropertyName | [PropertyName, unknown] | PartialShallow<T>;
+export declare type ValueIteratee<T> = ((value: T) => unknown) | IterateeShorthand<T>;
+export interface Dictionary<T> {
+    [index: string]: T;
+}
+export interface DebounceSettings {
+    /**
+     * @see _.leading
+     */
+    leading?: boolean | undefined;
+    /**
+     * @see _.maxWait
+     */
+    maxWait?: number | undefined;
+    /**
+     * @see _.trailing
+     */
+    trailing?: boolean | undefined;
+}
+export interface DebouncedFunc<T extends (...args: unknown[]) => unknown> {
+    /**
+     * Call the original function, but applying the debounce rules.
+     *
+     * If the debounced function can be run immediately, this calls it and returns its return
+     * value.
+     *
+     * Otherwise, it returns the return value of the last invocation, or undefined if the debounced
+     * function was not invoked yet.
+     */
+    (...args: Parameters<T>): ReturnType<T> | undefined;
+    /**
+     * Throw away any pending invocation of the debounced function.
+     */
+    cancel(): void;
+    /**
+     * If there is a pending invocation of the debounced function, invoke it immediately and return
+     * its return value.
+     *
+     * Otherwise, return the value from the last invocation, or undefined if the debounced function
+     * was never invoked.
+     */
+    flush(): ReturnType<T> | undefined;
+}

package/dist/private/common/lodash.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lodash.js.map

package/dist/private/common/lodash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lodash.js","sourceRoot":"","sources":["../../../src/private/common/lodash.ts"],"names":[],"mappings":"","sourcesContent":["export type PartialShallow<T> = {\n  [P in keyof T]?: T[P] extends object ? object : T[P]\n}\nexport type PropertyName = string | number | symbol\nexport type IterateeShorthand<T> = PropertyName | [PropertyName, unknown] | PartialShallow<T>\nexport type ValueIteratee<T> = ((value: T) => unknown) | IterateeShorthand<T>\nexport interface Dictionary<T> {\n  [index: string]: T\n}\n\nexport interface DebounceSettings {\n  /**\n   * @see _.leading\n   */\n  leading?: boolean | undefined\n  /**\n   * @see _.maxWait\n   */\n  maxWait?: number | undefined\n  /**\n   * @see _.trailing\n   */\n  trailing?: boolean | undefined\n}\n\nexport interface DebouncedFunc<T extends (...args: unknown[]) => unknown> {\n  /**\n   * Call the original function, but applying the debounce rules.\n   *\n   * If the debounced function can be run immediately, this calls it and returns its return\n   * value.\n   *\n   * Otherwise, it returns the return value of the last invocation, or undefined if the debounced\n   * function was not invoked yet.\n   */\n  (...args: Parameters<T>): ReturnType<T> | undefined\n\n  /**\n   * Throw away any pending invocation of the debounced function.\n   */\n  cancel(): void\n\n  /**\n   * If there is a pending invocation of the debounced function, invoke it immediately and return\n   * its return value.\n   *\n   * Otherwise, return the value from the last invocation, or undefined if the debounced function\n   * was never invoked.\n   */\n  flush(): ReturnType<T> | undefined\n}\n"]}