@shopify/cli-kit 3.69.3 → 3.70.0

package/dist/public/node/themes/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/public/node/themes/types.ts"],"names":[],"mappings":"AAsNA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;AACnB,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB","sourcesContent":["import {AdminSession} from '../session.js'\n\n/**\n * {@link Key} represents the unique identifier of a file in a theme.\n */\nexport type Key = string\n\nexport type ThemeFSEventName = 'add' | 'change' | 'unlink'\n\ntype ThemeFSEvent =\n  | {\n      type: 'unlink'\n      payload: {fileKey: Key; onSync?: (fn: () => void) => void}\n    }\n  | {\n      type: 'add' | 'change'\n      payload: {\n        fileKey: Key\n        onContent: (fn: (content: string) => void) => void\n        onSync: (fn: () => void) => void\n      }\n    }\n\nexport type ThemeFSEventPayload<T extends ThemeFSEventName = 'add'> = (ThemeFSEvent & {type: T})['payload']\n\nexport interface ThemeFileSystemOptions {\n  filters?: {ignore?: string[]; only?: string[]}\n  notify?: string\n}\n\n/**\n * Represents a theme on the file system.\n */\nexport interface VirtualFileSystem {\n  /**\n   * The root path of the theme.\n   */\n  root: string\n\n  /**\n   * Local files.\n   */\n  files: Map<Key, ThemeAsset>\n\n  /**\n   * File keys that have been modified in memory and are not uploaded yet.\n   */\n  unsyncedFileKeys: Set<Key>\n\n  /**\n   * Promise that resolves when all the initial files are found.\n   */\n  ready: () => Promise<void>\n\n  /**\n   * Removes a file from the local disk and updates the file system\n   *\n   * @param fileKey - The key of the file to remove\n   */\n  delete: (fileKey: Key) => Promise<void>\n\n  /**\n   * Writes a file to the local disk and updates the file system\n   *\n   * @param asset - The ThemeAsset representing the file to write\n   */\n  write: (asset: ThemeAsset) => Promise<void>\n\n  /**\n   * Reads a file from the local disk and updates the file system\n   * Returns a ThemeAsset representing the file that was read\n   * Returns undefined if the file does not exist\n   *\n   * @param fileKey - The key of the file to read\n   */\n  read: (fileKey: Key) => Promise<string | Buffer | undefined>\n\n  /**\n   * Add callbacks to run after certain events are fired.\n   */\n  addEventListener: <T extends ThemeFSEventName>(eventName: T, cb: (params: ThemeFSEventPayload<T>) => void) => void\n}\n\n/**\n * Represents a theme on the file system.\n */\nexport interface ThemeFileSystem extends VirtualFileSystem {\n  /**\n   * Starts a file watcher for the theme directory.\n   *\n   * @param themeId - The ID of the theme being watched.\n   * @param adminSession - The admin session for API communication.\n   * @returns A Promise that resolves to an FSWatcher instance.\n   */\n  startWatcher: (themeId: string, adminSession: AdminSession) => Promise<void>\n\n  /**\n   * Applies filters to ignore files from .shopifyignore file, --ignore and --only flags.\n   */\n  applyIgnoreFilters: <T extends {key: string}>(files: T[]) => T[]\n}\n\n/**\n * Represents a theme on the file system.\n */\nexport interface ThemeExtensionFileSystem extends VirtualFileSystem {\n  /**\n   * Starts a file watcher for the theme extension directory.\n   */\n  startWatcher: () => Promise<void>\n}\n\n/**\n * Represents a theme.\n */\nexport interface Theme {\n  /**\n   * The remote ID of the theme.\n   */\n  id: number\n\n  /**\n   * The remote name of the theme.\n   */\n  name: string\n\n  /**\n   * A boolean determining whether or not the theme was created at runtime.\n   */\n  createdAtRuntime: boolean\n\n  /**\n   * A boolean determining if the theme is processing at the theme library.\n   */\n  processing: boolean\n\n  /**\n   * The remote role of the theme.\n   */\n  role: string\n\n  /**\n   * A public URL where Shopify can access the theme code.\n   */\n  src?: string\n}\n\n/**\n * Represents the remote checksum for a file in a theme.\n */\nexport interface Checksum {\n  /**\n   * Identifier of the theme file.\n   */\n  key: Key\n\n  /**\n   * Represents the checksum value of the theme file.\n   */\n  checksum: string\n}\n\n/**\n * Represents a theme or theme extension asset.\n */\nexport interface ThemeAsset extends Checksum {\n  /**\n   * A base64-encoded image.\n   */\n  attachment?: string\n\n  /**\n   * The text content of the asset, such as the HTML and Liquid markup of a template file.\n   */\n  value?: string\n\n  /**\n   * File stats at time of last modification. For attachments, this is the size of the base64 string.\n   */\n  stats?: {mtime: number; size: number}\n}\n\n/**\n * Represents a single result for an upload or delete operation on a single file\n * Each result includes the unique identifier for the file, the type of the operation,\n * the success status of the operation, any errors that occurred, and the asset value of the file.\n */\nexport interface Result {\n  /**\n   * The unique identifier for the file being uploaded.\n   */\n  key: string\n\n  /**\n   * The operation associated with the result.\n   */\n  operation: Operation\n\n  /**\n   * Indicates whether the upload operation for this file was successful.\n   */\n  success: boolean\n\n  /**\n   * Error message that was generated during the upload operation for this file.\n   */\n  errors?: {asset?: string[]}\n\n  /**\n   * The asset that was uploaded as part of the upload operation for this file.\n   */\n  asset?: Omit<ThemeAsset, 'stats'>\n}\n\nexport enum Operation {\n  Delete = 'DELETE',\n  Upload = 'UPLOAD',\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/public/node/themes/types.ts"],"names":[],"mappings":"AAuNA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;AACnB,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB","sourcesContent":["import {AdminSession} from '../session.js'\n\n/**\n * {@link Key} represents the unique identifier of a file in a theme.\n */\nexport type Key = string\n\nexport type ThemeFSEventName = 'add' | 'change' | 'unlink'\n\ntype ThemeFSEvent =\n  | {\n      type: 'unlink'\n      payload: {fileKey: Key; onSync?: (fn: () => void) => void}\n    }\n  | {\n      type: 'add' | 'change'\n      payload: {\n        fileKey: Key\n        onContent: (fn: (content: string) => void) => void\n        onSync: (fn: () => void) => void\n      }\n    }\n\nexport type ThemeFSEventPayload<T extends ThemeFSEventName = 'add'> = (ThemeFSEvent & {type: T})['payload']\n\nexport interface ThemeFileSystemOptions {\n  filters?: {ignore?: string[]; only?: string[]}\n  notify?: string\n  noDelete?: boolean\n}\n\n/**\n * Represents a theme on the file system.\n */\nexport interface VirtualFileSystem {\n  /**\n   * The root path of the theme.\n   */\n  root: string\n\n  /**\n   * Local files.\n   */\n  files: Map<Key, ThemeAsset>\n\n  /**\n   * File keys that have been modified in memory and are not uploaded yet.\n   */\n  unsyncedFileKeys: Set<Key>\n\n  /**\n   * Promise that resolves when all the initial files are found.\n   */\n  ready: () => Promise<void>\n\n  /**\n   * Removes a file from the local disk and updates the file system\n   *\n   * @param fileKey - The key of the file to remove\n   */\n  delete: (fileKey: Key) => Promise<void>\n\n  /**\n   * Writes a file to the local disk and updates the file system\n   *\n   * @param asset - The ThemeAsset representing the file to write\n   */\n  write: (asset: ThemeAsset) => Promise<void>\n\n  /**\n   * Reads a file from the local disk and updates the file system\n   * Returns a ThemeAsset representing the file that was read\n   * Returns undefined if the file does not exist\n   *\n   * @param fileKey - The key of the file to read\n   */\n  read: (fileKey: Key) => Promise<string | Buffer | undefined>\n\n  /**\n   * Add callbacks to run after certain events are fired.\n   */\n  addEventListener: <T extends ThemeFSEventName>(eventName: T, cb: (params: ThemeFSEventPayload<T>) => void) => void\n}\n\n/**\n * Represents a theme on the file system.\n */\nexport interface ThemeFileSystem extends VirtualFileSystem {\n  /**\n   * Starts a file watcher for the theme directory.\n   *\n   * @param themeId - The ID of the theme being watched.\n   * @param adminSession - The admin session for API communication.\n   * @returns A Promise that resolves to an FSWatcher instance.\n   */\n  startWatcher: (themeId: string, adminSession: AdminSession) => Promise<void>\n\n  /**\n   * Applies filters to ignore files from .shopifyignore file, --ignore and --only flags.\n   */\n  applyIgnoreFilters: <T extends {key: string}>(files: T[]) => T[]\n}\n\n/**\n * Represents a theme on the file system.\n */\nexport interface ThemeExtensionFileSystem extends VirtualFileSystem {\n  /**\n   * Starts a file watcher for the theme extension directory.\n   */\n  startWatcher: () => Promise<void>\n}\n\n/**\n * Represents a theme.\n */\nexport interface Theme {\n  /**\n   * The remote ID of the theme.\n   */\n  id: number\n\n  /**\n   * The remote name of the theme.\n   */\n  name: string\n\n  /**\n   * A boolean determining whether or not the theme was created at runtime.\n   */\n  createdAtRuntime: boolean\n\n  /**\n   * A boolean determining if the theme is processing at the theme library.\n   */\n  processing: boolean\n\n  /**\n   * The remote role of the theme.\n   */\n  role: string\n\n  /**\n   * A public URL where Shopify can access the theme code.\n   */\n  src?: string\n}\n\n/**\n * Represents the remote checksum for a file in a theme.\n */\nexport interface Checksum {\n  /**\n   * Identifier of the theme file.\n   */\n  key: Key\n\n  /**\n   * Represents the checksum value of the theme file.\n   */\n  checksum: string\n}\n\n/**\n * Represents a theme or theme extension asset.\n */\nexport interface ThemeAsset extends Checksum {\n  /**\n   * A base64-encoded image.\n   */\n  attachment?: string\n\n  /**\n   * The text content of the asset, such as the HTML and Liquid markup of a template file.\n   */\n  value?: string\n\n  /**\n   * File stats at time of last modification. For attachments, this is the size of the base64 string.\n   */\n  stats?: {mtime: number; size: number}\n}\n\n/**\n * Represents a single result for an upload or delete operation on a single file\n * Each result includes the unique identifier for the file, the type of the operation,\n * the success status of the operation, any errors that occurred, and the asset value of the file.\n */\nexport interface Result {\n  /**\n   * The unique identifier for the file being uploaded.\n   */\n  key: string\n\n  /**\n   * The operation associated with the result.\n   */\n  operation: Operation\n\n  /**\n   * Indicates whether the upload operation for this file was successful.\n   */\n  success: boolean\n\n  /**\n   * Error message that was generated during the upload operation for this file.\n   */\n  errors?: {asset?: string[]}\n\n  /**\n   * The asset that was uploaded as part of the upload operation for this file.\n   */\n  asset?: Omit<ThemeAsset, 'stats'>\n}\n\nexport enum Operation {\n  Delete = 'DELETE',\n  Upload = 'UPLOAD',\n}\n"]}

package/dist/public/node/themes/utils.d.ts

@@ -5,3 +5,5 @@ export declare const UNPUBLISHED_THEME_ROLE = "unpublished";
 export type Role = typeof DEVELOPMENT_THEME_ROLE | typeof LIVE_THEME_ROLE | typeof UNPUBLISHED_THEME_ROLE;
 export declare function isDevelopmentTheme(theme: Theme): boolean;
 export declare function promptThemeName(message: string): Promise<string>;
+export declare function composeThemeGid(id: number): string;
+export declare function parseGid(gid: string): number;

package/dist/public/node/themes/utils.js

@@ -1,5 +1,6 @@
 import { renderTextPrompt } from '../ui.js';
 import { getRandomName } from '@shopify/cli-kit/common/string';
+const GID_REGEXP = /gid:\/\/shopify\/\w*\/(\d+)/;
 export const DEVELOPMENT_THEME_ROLE = 'development';
 export const LIVE_THEME_ROLE = 'live';
 export const UNPUBLISHED_THEME_ROLE = 'unpublished';
@@ -13,4 +14,14 @@ export async function promptThemeName(message) {
         defaultValue: defaultName,
     });
 }
+export function composeThemeGid(id) {
+    return `gid://shopify/OnlineStoreTheme/${id}`;
+}
+export function parseGid(gid) {
+    const matches = GID_REGEXP.exec(gid);
+    if (matches && matches[1] !== undefined) {
+        return parseInt(matches[1], 10);
+    }
+    throw new Error(`Invalid GID: ${gid}`);
+}
 //# sourceMappingURL=utils.js.map

package/dist/public/node/themes/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/public/node/themes/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAA;AACzC,OAAO,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAA;AAG5D,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAA;AACnD,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAA;AACrC,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAA;AAInD,MAAM,UAAU,kBAAkB,CAAC,KAAY;IAC7C,OAAO,KAAK,CAAC,IAAI,KAAK,sBAAsB,CAAA;AAC9C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAe;IACnD,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAA;IACnD,OAAO,gBAAgB,CAAC;QACtB,OAAO;QACP,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import {renderTextPrompt} from '../ui.js'\nimport {getRandomName} from '@shopify/cli-kit/common/string'\nimport {Theme} from '@shopify/cli-kit/node/themes/types'\n\nexport const DEVELOPMENT_THEME_ROLE = 'development'\nexport const LIVE_THEME_ROLE = 'live'\nexport const UNPUBLISHED_THEME_ROLE = 'unpublished'\n\nexport type Role = typeof DEVELOPMENT_THEME_ROLE | typeof LIVE_THEME_ROLE | typeof UNPUBLISHED_THEME_ROLE\n\nexport function isDevelopmentTheme(theme: Theme) {\n  return theme.role === DEVELOPMENT_THEME_ROLE\n}\n\nexport async function promptThemeName(message: string) {\n  const defaultName = await getRandomName('creative')\n  return renderTextPrompt({\n    message,\n    defaultValue: defaultName,\n  })\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/public/node/themes/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAA;AACzC,OAAO,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAA;AAG5D,MAAM,UAAU,GAAG,6BAA6B,CAAA;AAEhD,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAA;AACnD,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAA;AACrC,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAA;AAInD,MAAM,UAAU,kBAAkB,CAAC,KAAY;IAC7C,OAAO,KAAK,CAAC,IAAI,KAAK,sBAAsB,CAAA;AAC9C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAe;IACnD,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAA;IACnD,OAAO,gBAAgB,CAAC;QACtB,OAAO;QACP,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,EAAU;IACxC,OAAO,kCAAkC,EAAE,EAAE,CAAA;AAC/C,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACpC,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;QACvC,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;KAChC;IACD,MAAM,IAAI,KAAK,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAA;AACxC,CAAC","sourcesContent":["import {renderTextPrompt} from '../ui.js'\nimport {getRandomName} from '@shopify/cli-kit/common/string'\nimport {Theme} from '@shopify/cli-kit/node/themes/types'\n\nconst GID_REGEXP = /gid:\\/\\/shopify\\/\\w*\\/(\\d+)/\n\nexport const DEVELOPMENT_THEME_ROLE = 'development'\nexport const LIVE_THEME_ROLE = 'live'\nexport const UNPUBLISHED_THEME_ROLE = 'unpublished'\n\nexport type Role = typeof DEVELOPMENT_THEME_ROLE | typeof LIVE_THEME_ROLE | typeof UNPUBLISHED_THEME_ROLE\n\nexport function isDevelopmentTheme(theme: Theme) {\n  return theme.role === DEVELOPMENT_THEME_ROLE\n}\n\nexport async function promptThemeName(message: string) {\n  const defaultName = await getRandomName('creative')\n  return renderTextPrompt({\n    message,\n    defaultValue: defaultName,\n  })\n}\n\nexport function composeThemeGid(id: number): string {\n  return `gid://shopify/OnlineStoreTheme/${id}`\n}\n\nexport function parseGid(gid: string): number {\n  const matches = GID_REGEXP.exec(gid)\n  if (matches && matches[1] !== undefined) {\n    return parseInt(matches[1], 10)\n  }\n  throw new Error(`Invalid GID: ${gid}`)\n}\n"]}

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

@@ -0,0 +1,13 @@
+/**
+ * Returns the version of the local dependency of the CLI if it's installed in the provided directory.
+ *
+ * @param directory - Path of the project to look for the dependency.
+ * @returns The CLI version or undefined if the dependency is not installed.
+ */
+export declare function localCLIVersion(directory: string): Promise<string | undefined>;
+/**
+ * Returns the version of the globally installed CLI, only if it's greater than 3.59.0 (when the global CLI was introduced).
+ *
+ * @returns The version of the CLI if it is globally installed or undefined.
+ */
+export declare function globalCLIVersion(): Promise<string | undefined>;

package/dist/public/node/version.js

@@ -0,0 +1,38 @@
+import { versionSatisfies } from '../node/node-package-manager.js';
+import { captureOutput } from '../node/system.js';
+/**
+ * Returns the version of the local dependency of the CLI if it's installed in the provided directory.
+ *
+ * @param directory - Path of the project to look for the dependency.
+ * @returns The CLI version or undefined if the dependency is not installed.
+ */
+export async function localCLIVersion(directory) {
+    try {
+        const output = await captureOutput('npm', ['list', '@shopify/cli'], { cwd: directory });
+        return output.match(/@shopify\/cli@([\w.-]*)/)?.[1];
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Returns the version of the globally installed CLI, only if it's greater than 3.59.0 (when the global CLI was introduced).
+ *
+ * @returns The version of the CLI if it is globally installed or undefined.
+ */
+export async function globalCLIVersion() {
+    try {
+        const env = { ...process.env, SHOPIFY_CLI_NO_ANALYTICS: '1' };
+        const version = await captureOutput('shopify', ['version'], { env });
+        if (versionSatisfies(version, `>=3.59.0`)) {
+            return version;
+        }
+        return undefined;
+        // eslint-disable-next-line no-catch-all/no-catch-all
+    }
+    catch {
+        return undefined;
+    }
+}
+//# sourceMappingURL=version.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/public/node/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,iCAAiC,CAAA;AAChE,OAAO,EAAC,aAAa,EAAC,MAAM,mBAAmB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,SAAiB;IACrD,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,EAAC,GAAG,EAAE,SAAS,EAAC,CAAC,CAAA;QACrF,OAAO,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACnD,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,SAAS,CAAA;KACjB;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI;QACF,MAAM,GAAG,GAAG,EAAC,GAAG,OAAO,CAAC,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAC,CAAA;QAC3D,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,GAAG,EAAC,CAAC,CAAA;QAClE,IAAI,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE;YACzC,OAAO,OAAO,CAAA;SACf;QACD,OAAO,SAAS,CAAA;QAChB,qDAAqD;KACtD;IAAC,MAAM;QACN,OAAO,SAAS,CAAA;KACjB;AACH,CAAC","sourcesContent":["import {versionSatisfies} from '../node/node-package-manager.js'\nimport {captureOutput} from '../node/system.js'\n\n/**\n * Returns the version of the local dependency of the CLI if it's installed in the provided directory.\n *\n * @param directory - Path of the project to look for the dependency.\n * @returns The CLI version or undefined if the dependency is not installed.\n */\nexport async function localCLIVersion(directory: string): Promise<string | undefined> {\n  try {\n    const output = await captureOutput('npm', ['list', '@shopify/cli'], {cwd: directory})\n    return output.match(/@shopify\\/cli@([\\w.-]*)/)?.[1]\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return undefined\n  }\n}\n\n/**\n * Returns the version of the globally installed CLI, only if it's greater than 3.59.0 (when the global CLI was introduced).\n *\n * @returns The version of the CLI if it is globally installed or undefined.\n */\nexport async function globalCLIVersion(): Promise<string | undefined> {\n  try {\n    const env = {...process.env, SHOPIFY_CLI_NO_ANALYTICS: '1'}\n    const version = await captureOutput('shopify', ['version'], {env})\n    if (versionSatisfies(version, `>=3.59.0`)) {\n      return version\n    }\n    return undefined\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch {\n    return undefined\n  }\n}\n"]}