@spiffcommerce/theme-bridge 1.25.4-alpha.2 → 1.26.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ConversionDataType, OptionResource, SpiffCommerceClient, DesignCreationMessage, BundleDesignCreationMessage } from '@repo/core';
+import { ConversionDataType, OptionResource, CollectionProduct, SpiffCommerceClient, DesignCreationMessage, BundleDesignCreationMessage } from '@repo/core';
 export { ConversionDataType } from '@repo/core';
 import { ThemeInstallConfigurationGraphQl } from '@repo/types';
 export { ThemeInstallConfigurationGraphQl } from '@repo/types';
@@ -88,18 +88,24 @@ interface ConfigurableField extends FieldBase {
      * Optional: A brief description of what the field might be used for. This is displayed beneath the field in the configuration form.
      */
     description?: string;
+}
+interface RequiredOption {
     /**
      * Optional: Set to `true` to require a value to be provided in the configuration form.
      */
     required?: boolean;
+    /** Cannot combine required and defaultValue options. */
+    readonly defaultValue?: undefined;
 }
-interface DefaultValueOption {
+type RequiredOrDefault = RequiredOption | {
     /**
      * Optional: A default value to supply. Values are always supplied as strings.
      * When the `type` is `"Select"`, this should be one of the `key` fields in the `options` array.
      */
     defaultValue?: string;
-}
+    /** Cannot combine required and defaultValue options. */
+    readonly required?: undefined;
+};
 interface LimitOption {
     /**
      * Optional: A limit to impose on the input.
@@ -112,9 +118,10 @@ interface LimitOption {
 /**
  * Generic fields which have no extra configuration and can accept default values from the Theme developer.
  */
-interface GenericField extends ConfigurableField, DefaultValueOption {
+interface GenericFieldBase extends ConfigurableField {
     type: FieldType.Boolean | FieldType.Color | FieldType.Number | FieldType.DateRange;
 }
+type GenericField = GenericFieldBase & RequiredOrDefault;
 declare enum AssetType {
     Color = "Color",
     ColorProfile = "ColorProfile",
@@ -128,7 +135,7 @@ declare enum AssetType {
     Model = "Model",
     Video = "Video"
 }
-interface AssetField extends ConfigurableField {
+interface AssetField extends ConfigurableField, RequiredOption {
     /**
      * The type of asset, e.g. Image, Model, Font, etc.
      */
@@ -138,7 +145,7 @@ interface AssetField extends ConfigurableField {
 interface ConversionConfigurationField extends ConfigurableField {
     type: FieldType.ConversionConfiguration;
 }
-interface SelectField extends ConfigurableField, DefaultValueOption {
+interface SelectFieldBase extends ConfigurableField {
     /**
      * The options available for the Partner to select in the configuration form.
      */
@@ -154,13 +161,15 @@ interface SelectField extends ConfigurableField, DefaultValueOption {
     }[];
     type: FieldType.Select;
 }
-interface TextField extends ConfigurableField, LimitOption, DefaultValueOption {
+type SelectField = SelectFieldBase & RequiredOrDefault;
+interface TextFieldBase extends ConfigurableField, LimitOption {
     /**
      * Allows the Partner to configure the field in a multi-line text editor.
      */
     multiLine?: boolean;
     type: FieldType.Text;
 }
+type TextField = TextFieldBase & RequiredOrDefault;
 /**
  * Displays a heading in the Configuration Editor page in Hub.
  */
@@ -170,7 +179,7 @@ interface HeadingField extends FieldBase {
 /**
  * A list of one specific field type.
  */
-interface ListField extends ConfigurableField, LimitOption {
+interface ListField extends ConfigurableField, RequiredOption, LimitOption {
     type: FieldType.List;
     /**
      * Defines the configuration schema for the entries in this list.
@@ -180,16 +189,16 @@ interface ListField extends ConfigurableField, LimitOption {
 /**
  * A collection of any number of different fields.
  */
-interface ObjectField extends ConfigurableField {
+interface ObjectField extends ConfigurableField, RequiredOption {
     type: FieldType.Object;
     /**
      * Defines the configuration schema for the fields in this object.
      */
     fields: ThemeConfigurationSchemaField[];
     /**
-     * The schema to use from the `customSchemas` field. Leave this null when not using a pre-defined schema.
+     * The schema to use from the `customSchemas` field. Leave this undefined when not using a pre-defined schema.
      */
-    schema?: null;
+    schema?: undefined;
 }
 interface CustomObjectField extends Omit<ObjectField, "fields" | "schema"> {
     schema: string;
@@ -308,6 +317,7 @@ interface ThemeConfigurationSchemaFieldResource {
         value: string;
     }[];
     assetType?: string;
+    entityType?: string;
     multiLine?: boolean;
     /** An arbitrary limit which applies differently depending on the field type. When Text, this is a character limit. */
     limit?: number;
@@ -384,17 +394,18 @@ interface ConversionConfiguration {
 }
 interface ThemeInstallConfigurationFieldResource {
     key?: string;
+    /** @deprecated No longer supported. */
     fallbackToDefaultConfiguration?: boolean;
     value?: string | null;
     type: FieldType;
     /** When the type is `Asset`, this will be the configured Asset resource. */
     asset?: AssetResource | null;
     /** When the type is `ConversionConfiguration`, this will be the configured ConversionConfiguration resource. */
-    conversionConfiguration?: ConversionConfiguration;
+    conversionConfiguration?: ConversionConfiguration | null;
     /** When the type is `MetafieldConfiguration`, this will be the configured MetafieldConfiguration resource. */
-    metafieldConfiguration?: MetafieldConfigurationResource;
+    metafieldConfiguration?: MetafieldConfigurationResource | null;
     /** When the type is `ProductCollection`, this will be the configured ProductCollection resource. */
-    productCollection?: ProductCollectionResource;
+    productCollection?: ProductCollectionResource | null;
     /** When the type is `List`, this will be the configured values */
     listValues?: ThemeInstallConfigurationFieldResource[];
     /** When the type is `Object`, this will be the configured field values */
@@ -469,6 +480,13 @@ interface ThemeContextBase {
 interface ThemeContextBundleOptionsNew {
     integrationProductId?: string;
     productCollectionId?: string;
+    singleProductMode?: boolean;
+    /**
+     * The active CollectionProduct. Use this to determine Workflows instead of fetching them from the IntegrationProduct.
+     *
+     * Only present when `singleProductMode === true`.
+     */
+    collectionProduct?: CollectionProduct;
     type: "new";
 }
 interface ThemeContextBundleOptionsExisting {
@@ -498,6 +516,11 @@ interface ThemeContextWorkflowOptionsExternalProduct extends ThemeContextWorkflo
     type: "external";
 }
 type ThemeContextWorkflowOptions = ThemeContextWorkflowOptionsTransaction | ThemeContextWorkflowOptionsIntegrationProduct | ThemeContextWorkflowOptionsExternalProduct;
+/**
+ * @deprecated Transaction contexts are to be replaced entirely by Bundle contexts.
+ * If you are creating a testing context, single product flows should be achieved by creating a Bundle context with an Activation, and providing:
+ * `singleProductMode = true` and the appropriate `collectionProduct`.
+ */
 interface ThemeContextTransaction extends ThemeContextBase {
     workflowOptions: ThemeContextWorkflowOptions;
     type: "transaction";

package/dist/index.js

@@ -57,7 +57,6 @@ function dT(M) {
     case oi.Select:
       return M.value;
     case oi.Heading:
-    default:
       return;
   }
 }