@spiffcommerce/theme-bridge 1.9.0 → 1.9.2

package/dist/index.d.ts

@@ -1,31 +1,47 @@
 import { DesignCreationMessage, SpiffCommerceClient } from '@spiffcommerce/core';
 
 interface ThemeConfigurationFile {
+    /**
+     * Information the theme loader needs in order to launch your theme.
+     */
     launchData: ThemeConfigurationLaunchData;
-    configurationSchema: ThemeConfigurationSchema;
+    /**
+     * An object that describes information that's configurable by a Partner when they install your theme.
+     */
+    configurationSchema?: ThemeConfigurationSchema;
 }
 declare enum ThemeFileType {
     Javascript = "Javascript",
     CSS = "CSS"
 }
 interface ThemeConfigurationLaunchData {
+    /**
+     * Files that will be loaded when launching the theme.
+     */
     targetFiles: ThemeConfigurationLaunchDataTargetFile[];
 }
-interface ThemeConfigurationLaunchDataTargetFile {
+interface LaunchFileBase {
+    /**
+     * The local path to the file.
+     */
     filename: string;
-    type: ThemeFileType;
+    /**
+     * The MIME type of the file.
+     */
     mimeType: string;
-    preload?: boolean;
 }
-interface ThemeLaunchData {
-    targetFiles: ThemeLaunchDataTargetFile[];
+interface GenericLaunchFile extends LaunchFileBase {
+    type: ThemeFileType.CSS;
 }
-interface ThemeLaunchDataTargetFile {
-    filename: string;
-    type: ThemeFileType;
-    mimeType: string;
-    fileLink: string;
+interface JavascriptLaunchFile extends LaunchFileBase {
+    /**
+     * When `false`, the file will be loaded immediately. When `true`, the file will instead be pre-loaded.
+     * With javascript files, this will insert them into the page as `<link rel="modulepreload" ... >`.
+     */
+    preload?: boolean;
+    type: ThemeFileType.Javascript;
 }
+type ThemeConfigurationLaunchDataTargetFile = GenericLaunchFile | JavascriptLaunchFile;
 declare enum FieldType {
     Asset = "Asset",
     Boolean = "Boolean",
@@ -37,6 +53,9 @@ declare enum FieldType {
     SingleLineText = "SingleLineText"
 }
 interface ThemeConfigurationSchema {
+    /**
+     * An array of fields that a Partner can configure when they install the theme.
+     */
     fields: ThemeConfigurationSchemaField[];
 }
 interface FieldBase {
@@ -153,6 +172,7 @@ interface ThemeLaunchDataTargetFileResource {
     type: ThemeFileType;
     mimeType: string;
     fileLink: string;
+    preload?: boolean;
 }
 interface ThemeInstallConfigurationResource {
     id: string;
@@ -269,4 +289,4 @@ type SpiffDevOptions = Omit<ThemeContextTransaction, "container"> | Omit<ThemeCo
 declare function setSpiffDevOptions(container: HTMLElement | string, context: SpiffDevOptions): void;
 declare function exampleThemeInstallConfig(opts?: Partial<ThemeInstallConfigurationResource>): ThemeInstallConfigurationResource;
 
-export { type AssetResource, AssetType, type BundleDesignCreationMessage, type DesignCreationMessageWithQuantity, FieldType, type SpiffDevOptions, type SpiffThemeLoader, type ThemeConfigurationFile, type ThemeConfigurationLaunchData, type ThemeConfigurationLaunchDataTargetFile, type ThemeConfigurationSchema, type ThemeConfigurationSchemaField, type ThemeConfigurationSchemaFieldResource, type ThemeConfigurationSchemaResource, type ThemeContext, type ThemeContextBundle, type ThemeContextBundleOptions, type ThemeContextBundleOptionsExisting, type ThemeContextBundleOptionsNew, type ThemeContextTransaction, type ThemeContextWorkflowOptions, type ThemeContextWorkflowOptionsExternalProduct, type ThemeContextWorkflowOptionsIntegrationProduct, type ThemeContextWorkflowOptionsTransaction, ThemeFileType, type ThemeInstallConfigurationField, type ThemeInstallConfigurationResource, type ThemeLaunchData, type ThemeLaunchDataResource, type ThemeLaunchDataTargetFile, type ThemeLaunchDataTargetFileResource, type ThemeResource, type ThemeVersionResource, exampleThemeInstallConfig, setSpiffDevOptions };
+export { type AssetResource, AssetType, type BundleDesignCreationMessage, type DesignCreationMessageWithQuantity, FieldType, type SpiffDevOptions, type SpiffThemeLoader, type ThemeConfigurationFile, type ThemeConfigurationLaunchData, type ThemeConfigurationLaunchDataTargetFile, type ThemeConfigurationSchema, type ThemeConfigurationSchemaField, type ThemeConfigurationSchemaFieldResource, type ThemeConfigurationSchemaResource, type ThemeContext, type ThemeContextBundle, type ThemeContextBundleOptions, type ThemeContextBundleOptionsExisting, type ThemeContextBundleOptionsNew, type ThemeContextTransaction, type ThemeContextWorkflowOptions, type ThemeContextWorkflowOptionsExternalProduct, type ThemeContextWorkflowOptionsIntegrationProduct, type ThemeContextWorkflowOptionsTransaction, ThemeFileType, type ThemeInstallConfigurationField, type ThemeInstallConfigurationResource, type ThemeLaunchDataResource, type ThemeLaunchDataTargetFileResource, type ThemeResource, type ThemeVersionResource, exampleThemeInstallConfig, setSpiffDevOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/theme-bridge",
-    "version": "1.9.0",
+    "version": "1.9.2",
     "type": "module",
     "scripts": {
         "build": "tsc && vite build",
@@ -20,6 +20,11 @@
         "@preact/preset-vite": "^2.7.0",
         "@spiffcommerce/core": "^19.1.0",
         "@types/node": "^20.11.16",
+        "@typescript-eslint/eslint-plugin": "^7.1.0",
+        "@typescript-eslint/parser": "^7.1.0",
+        "eslint": "^8.57.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.1.3",
         "preact": "^10.19.3",
         "prettier": "^3.2.4",
         "ts-json-schema-generator": "^1.5.0",