@shopify/cli-kit 3.55.3 → 3.56.0

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

@@ -1,18 +1,26 @@
-import { Checksum, Theme, ThemeAsset } from '@shopify/cli-kit/node/themes/types';
-interface RemoteThemeJson {
+import { BulkUploadResult, Checksum, Theme, ThemeAsset } from '@shopify/cli-kit/node/themes/types';
+interface RemoteThemeResponse {
     id: number;
     name: string;
     role: string;
     createdAtRuntime?: boolean;
     processing?: boolean;
 }
-interface RemoteAssetJson {
+interface RemoteAssetResponse {
     key: string;
     checksum: string;
     attachment: string;
     value: string;
 }
-export declare function buildTheme(themeJson?: RemoteThemeJson): Theme | undefined;
-export declare function buildChecksum(assetJson?: RemoteAssetJson): Checksum | undefined;
-export declare function buildThemeAsset(assetJson?: RemoteAssetJson): ThemeAsset | undefined;
+interface RemoteBulkUploadResponse {
+    body: {
+        asset: RemoteAssetResponse;
+    };
+    code: number;
+    errors?: string[];
+}
+export declare function buildTheme(themeJson?: RemoteThemeResponse): Theme | undefined;
+export declare function buildChecksum(asset?: RemoteAssetResponse): Checksum | undefined;
+export declare function buildThemeAsset(asset?: RemoteAssetResponse): ThemeAsset | undefined;
+export declare function buildBulkUploadResults(bulkUpload?: RemoteBulkUploadResponse): BulkUploadResult | undefined;
 export {};

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

@@ -12,16 +12,26 @@ export function buildTheme(themeJson) {
         role: role === 'main' ? 'live' : role,
     };
 }
-export function buildChecksum(assetJson) {
-    if (!assetJson)
+export function buildChecksum(asset) {
+    if (!asset)
         return;
-    const { key, checksum } = assetJson;
+    const { key, checksum } = asset;
     return { key, checksum };
 }
-export function buildThemeAsset(assetJson) {
-    if (!assetJson)
+export function buildThemeAsset(asset) {
+    if (!asset)
         return;
-    const { key, checksum, attachment, value } = assetJson;
+    const { key, checksum, attachment, value } = asset;
     return { key, checksum, attachment, value };
 }
+export function buildBulkUploadResults(bulkUpload) {
+    if (!bulkUpload)
+        return;
+    return {
+        key: bulkUpload.body.asset.key,
+        success: bulkUpload.code === 200,
+        errors: bulkUpload.errors || [],
+        asset: bulkUpload.body.asset || {},
+    };
+}
 //# sourceMappingURL=factories.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"factories.js","sourceRoot":"","sources":["../../../../src/public/node/themes/factories.ts"],"names":[],"mappings":"AAiBA,MAAM,UAAU,UAAU,CAAC,SAA2B;IACpD,IAAI,CAAC,SAAS;QAAE,OAAM;IAEtB,SAAS,CAAC,UAAU,KAApB,SAAS,CAAC,UAAU,GAAK,KAAK,EAAA;IAC9B,SAAS,CAAC,gBAAgB,KAA1B,SAAS,CAAC,gBAAgB,GAAK,KAAK,EAAA;IAEpC,MAAM,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,gBAAgB,EAAC,GAAG,SAAS,CAAA;IAEhE,OAAO;QACL,EAAE;QACF,IAAI;QACJ,UAAU;QACV,gBAAgB;QAChB,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;KACtC,CAAA;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,SAA2B;IACvD,IAAI,CAAC,SAAS;QAAE,OAAM;IAEtB,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAC,GAAG,SAAS,CAAA;IACjC,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAC,CAAA;AACxB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,SAA2B;IACzD,IAAI,CAAC,SAAS;QAAE,OAAM;IAEtB,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAC,GAAG,SAAS,CAAA;IACpD,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAC,CAAA;AAC3C,CAAC","sourcesContent":["import {Checksum, Theme, ThemeAsset} from '@shopify/cli-kit/node/themes/types'\n\ninterface RemoteThemeJson {\n  id: number\n  name: string\n  role: string\n  createdAtRuntime?: boolean\n  processing?: boolean\n}\n\ninterface RemoteAssetJson {\n  key: string\n  checksum: string\n  attachment: string\n  value: string\n}\n\nexport function buildTheme(themeJson?: RemoteThemeJson): Theme | undefined {\n  if (!themeJson) return\n\n  themeJson.processing ??= false\n  themeJson.createdAtRuntime ??= false\n\n  const {id, name, role, processing, createdAtRuntime} = themeJson\n\n  return {\n    id,\n    name,\n    processing,\n    createdAtRuntime,\n    role: role === 'main' ? 'live' : role,\n  }\n}\n\nexport function buildChecksum(assetJson?: RemoteAssetJson): Checksum | undefined {\n  if (!assetJson) return\n\n  const {key, checksum} = assetJson\n  return {key, checksum}\n}\n\nexport function buildThemeAsset(assetJson?: RemoteAssetJson): ThemeAsset | undefined {\n  if (!assetJson) return\n\n  const {key, checksum, attachment, value} = assetJson\n  return {key, checksum, attachment, value}\n}\n"]}
+{"version":3,"file":"factories.js","sourceRoot":"","sources":["../../../../src/public/node/themes/factories.ts"],"names":[],"mappings":"AAuBA,MAAM,UAAU,UAAU,CAAC,SAA+B;IACxD,IAAI,CAAC,SAAS;QAAE,OAAM;IAEtB,SAAS,CAAC,UAAU,KAApB,SAAS,CAAC,UAAU,GAAK,KAAK,EAAA;IAC9B,SAAS,CAAC,gBAAgB,KAA1B,SAAS,CAAC,gBAAgB,GAAK,KAAK,EAAA;IAEpC,MAAM,EAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,gBAAgB,EAAC,GAAG,SAAS,CAAA;IAEhE,OAAO;QACL,EAAE;QACF,IAAI;QACJ,UAAU;QACV,gBAAgB;QAChB,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;KACtC,CAAA;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAA2B;IACvD,IAAI,CAAC,KAAK;QAAE,OAAM;IAElB,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAC,GAAG,KAAK,CAAA;IAC7B,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAC,CAAA;AACxB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAA2B;IACzD,IAAI,CAAC,KAAK;QAAE,OAAM;IAElB,MAAM,EAAC,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAC,GAAG,KAAK,CAAA;IAChD,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAAqC;IAC1E,IAAI,CAAC,UAAU;QAAE,OAAM;IAEvB,OAAO;QACL,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;QAC9B,OAAO,EAAE,UAAU,CAAC,IAAI,KAAK,GAAG;QAChC,MAAM,EAAE,UAAU,CAAC,MAAM,IAAI,EAAE;QAC/B,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;KACnC,CAAA;AACH,CAAC","sourcesContent":["import {BulkUploadResult, Checksum, Theme, ThemeAsset} from '@shopify/cli-kit/node/themes/types'\n\ninterface RemoteThemeResponse {\n  id: number\n  name: string\n  role: string\n  createdAtRuntime?: boolean\n  processing?: boolean\n}\n\ninterface RemoteAssetResponse {\n  key: string\n  checksum: string\n  attachment: string\n  value: string\n}\n\ninterface RemoteBulkUploadResponse {\n  body: {asset: RemoteAssetResponse}\n  code: number\n  errors?: string[]\n}\n\nexport function buildTheme(themeJson?: RemoteThemeResponse): Theme | undefined {\n  if (!themeJson) return\n\n  themeJson.processing ??= false\n  themeJson.createdAtRuntime ??= false\n\n  const {id, name, role, processing, createdAtRuntime} = themeJson\n\n  return {\n    id,\n    name,\n    processing,\n    createdAtRuntime,\n    role: role === 'main' ? 'live' : role,\n  }\n}\n\nexport function buildChecksum(asset?: RemoteAssetResponse): Checksum | undefined {\n  if (!asset) return\n\n  const {key, checksum} = asset\n  return {key, checksum}\n}\n\nexport function buildThemeAsset(asset?: RemoteAssetResponse): ThemeAsset | undefined {\n  if (!asset) return\n\n  const {key, checksum, attachment, value} = asset\n  return {key, checksum, attachment, value}\n}\n\nexport function buildBulkUploadResults(bulkUpload?: RemoteBulkUploadResponse): BulkUploadResult | undefined {\n  if (!bulkUpload) return\n\n  return {\n    key: bulkUpload.body.asset.key,\n    success: bulkUpload.code === 200,\n    errors: bulkUpload.errors || [],\n    asset: bulkUpload.body.asset || {},\n  }\n}\n"]}

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

@@ -66,3 +66,26 @@ export interface ThemeAsset extends Checksum {
      */
     value?: string;
 }
+/**
+ * Represents a single result returned within the response of a bulk upload operation.
+ * Each result includes the unique identifier for the file being uploaded,
+ * the status of the upload operation, any errors that occurred, and the asset that was uploaded.
+ */
+export interface BulkUploadResult {
+    /**
+     * The unique identifier for the file being uploaded.
+     */
+    key: string;
+    /**
+     * Indicates whether the upload operation for this file was successful.
+     */
+    success: boolean;
+    /**
+     * An array of error messages that were generated during the upload operation for this file.
+     */
+    errors?: string[];
+    /**
+     * The asset that was uploaded as part of the upload operation for this file.
+     */
+    asset: ThemeAsset;
+}

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":"","sourcesContent":["/**\n * {@link Key} represents the unique identifier of a file in a theme.\n */\nexport type Key = string\n\n/**\n * Represents a theme on the file system.\n */\nexport interface ThemeFileSystem {\n  /**\n   * The root path of the theme.\n   */\n  root: string\n\n  /**\n   * Local theme files.\n   */\n  files: Map<Key, ThemeAsset>\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/**\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   * Reresents the checksum value of the theme file.\n   */\n  checksum: string\n}\n\n/**\n * Represents a file in a theme.\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"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/public/node/themes/types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * {@link Key} represents the unique identifier of a file in a theme.\n */\nexport type Key = string\n\n/**\n * Represents a theme on the file system.\n */\nexport interface ThemeFileSystem {\n  /**\n   * The root path of the theme.\n   */\n  root: string\n\n  /**\n   * Local theme files.\n   */\n  files: Map<Key, ThemeAsset>\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/**\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   * Reresents the checksum value of the theme file.\n   */\n  checksum: string\n}\n\n/**\n * Represents a file in a theme.\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/**\n * Represents a single result returned within the response of a bulk upload operation.\n * Each result includes the unique identifier for the file being uploaded,\n * the status of the upload operation, any errors that occurred, and the asset that was uploaded.\n */\nexport interface BulkUploadResult {\n  /**\n   * The unique identifier for the file being uploaded.\n   */\n  key: string\n\n  /**\n   * Indicates whether the upload operation for this file was successful.\n   */\n  success: boolean\n\n  /**\n   * An array of error messages that were generated during the upload operation for this file.\n   */\n  errors?: string[]\n\n  /**\n   * The asset that was uploaded as part of the upload operation for this file.\n   */\n  asset: ThemeAsset\n}\n"]}