@spiffcommerce/theme-bridge 1.27.1-alpha.4 → 1.27.1-alpha.5

package/dist/index.d.ts

@@ -84,6 +84,12 @@ interface ThemeConfigurationPageItem {
     /**
      * Optional: HTML code to render in the middle preview section, using Handlebars.js templating
      * syntax to inject configuration values into the preview whenever changes are made.
+     *
+     * Available context variables are:
+     * - Every field from your configuration (that you expect to be available).
+     * - A "sampleData" object with the following fields: `{
+     *  products: []{name: string};
+     * }`
      */
     previewElement?: string;
     /**
@@ -209,9 +215,18 @@ interface LimitOption {
  * Generic fields which have no extra configuration and can accept default values from the Theme developer.
  */
 interface GenericFieldBase extends ConfigurableField {
-    type: FieldType.Boolean | FieldType.Color | FieldType.Number | FieldType.DateRange;
+    type: FieldType.Boolean | FieldType.Color | FieldType.DateRange;
 }
 type GenericField = GenericFieldBase & RequiredOrDefault;
+type NumberField = ConfigurableField & RequiredOrDefault & {
+    type: FieldType.Number;
+    /** Optional: the minimum value a user can configure this to be. */
+    min?: number;
+    /** Optional: the maximum value a user can configure this to be. */
+    max?: number;
+    /** Optional: when using step controls or a slider, the value will increase by this amount. */
+    step?: number;
+};
 declare enum AssetType {
     Color = "Color",
     ColorProfile = "ColorProfile",
@@ -318,7 +333,7 @@ type DistributiveOmit<T, K extends keyof any> = T extends any ? Omit<T, K> : nev
 /**
  * All field types that are configurable by a user in Hub.
  */
-type ThemeConfigurationConfigurableFields = GenericField | AssetField | ConversionConfigurationField | SelectField | TextField | ListField | ObjectField | CustomObjectField | ProductCollectionField | MetafieldConfigurationField;
+type ThemeConfigurationConfigurableFields = GenericField | NumberField | AssetField | ConversionConfigurationField | SelectField | TextField | ListField | ObjectField | CustomObjectField | ProductCollectionField | MetafieldConfigurationField;
 /**
  * All field types, including non-configurable ones.
  */
@@ -418,6 +433,9 @@ interface ThemeConfigurationSchemaFieldResource {
     fields?: ThemeConfigurationSchemaFieldResource[];
     /** When this field is type `Object` this will point to a pre-defined schema to use, if any. */
     schema?: string;
+    min?: number;
+    max?: number;
+    step?: number;
 }
 interface ThemeLaunchDataResource {
     targetFiles: ThemeLaunchDataTargetFileResource[];