@spiffcommerce/theme-bridge 1.25.2 → 1.25.4-alpha.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { ConversionDataType, OptionResource, SpiffCommerceClient, DesignCreationMessage, BundleDesignCreationMessage } from '@repo/core';
 export { ConversionDataType } from '@repo/core';
-import { Plugin } from 'vite';
+import { ThemeInstallConfigurationGraphQl } from '@repo/types';
+export { ThemeInstallConfigurationGraphQl } from '@repo/types';
 
 interface ThemeConfigurationFile {
     /**
@@ -55,7 +56,9 @@ declare enum FieldType {
     Object = "Object",
     Select = "Select",
     Text = "Text",
-    DateRange = "DateRange"
+    DateRange = "DateRange",
+    ProductCollection = "ProductCollection",
+    MetafieldConfiguration = "MetafieldConfiguration"
 }
 interface ThemeConfigurationSchema {
     /**
@@ -85,8 +88,6 @@ 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.
      */
@@ -108,24 +109,36 @@ interface LimitOption {
      */
     limit?: number;
 }
-interface GenericFieldBase extends ConfigurableField {
+/**
+ * Generic fields which have no extra configuration and can accept default values from the Theme developer.
+ */
+interface GenericField extends ConfigurableField, DefaultValueOption {
     type: FieldType.Boolean | FieldType.Color | FieldType.Number | FieldType.DateRange;
 }
-type GenericField = GenericFieldBase & RequiredOption & DefaultValueOption;
-interface AssetField extends ConfigurableField, RequiredOption {
+declare enum AssetType {
+    Color = "Color",
+    ColorProfile = "ColorProfile",
+    Data = "Data",
+    Environment = "Environment",
+    Font = "Font",
+    Frame = "Frame",
+    Illustration = "Illustration",
+    Image = "Image",
+    Material = "Material",
+    Model = "Model",
+    Video = "Video"
+}
+interface AssetField extends ConfigurableField {
     /**
      * The type of asset, e.g. Image, Model, Font, etc.
      */
     assetType: AssetType;
     type: FieldType.Asset;
 }
-interface DateRangeField extends ConfigurableField {
-    type: FieldType.DateRange;
-}
 interface ConversionConfigurationField extends ConfigurableField {
     type: FieldType.ConversionConfiguration;
 }
-interface SelectFieldBase extends ConfigurableField {
+interface SelectField extends ConfigurableField, DefaultValueOption {
     /**
      * The options available for the Partner to select in the configuration form.
      */
@@ -141,15 +154,13 @@ interface SelectFieldBase extends ConfigurableField {
     }[];
     type: FieldType.Select;
 }
-type SelectField = SelectFieldBase & RequiredOption & DefaultValueOption;
-interface TextFieldBase extends ConfigurableField, LimitOption {
+interface TextField extends ConfigurableField, LimitOption, DefaultValueOption {
     /**
      * Allows the Partner to configure the field in a multi-line text editor.
      */
     multiLine?: boolean;
     type: FieldType.Text;
 }
-type TextField = TextFieldBase & RequiredOption & DefaultValueOption;
 /**
  * Displays a heading in the Configuration Editor page in Hub.
  */
@@ -159,7 +170,7 @@ interface HeadingField extends FieldBase {
 /**
  * A list of one specific field type.
  */
-interface ListField extends ConfigurableField, RequiredOption, LimitOption {
+interface ListField extends ConfigurableField, LimitOption {
     type: FieldType.List;
     /**
      * Defines the configuration schema for the entries in this list.
@@ -169,7 +180,7 @@ interface ListField extends ConfigurableField, RequiredOption, LimitOption {
 /**
  * A collection of any number of different fields.
  */
-interface ObjectField extends ConfigurableField, RequiredOption {
+interface ObjectField extends ConfigurableField {
     type: FieldType.Object;
     /**
      * Defines the configuration schema for the fields in this object.
@@ -183,29 +194,36 @@ interface ObjectField extends ConfigurableField, RequiredOption {
 interface CustomObjectField extends Omit<ObjectField, "fields" | "schema"> {
     schema: string;
 }
+interface ProductCollectionField extends ConfigurableField {
+    type: FieldType.ProductCollection;
+}
+declare enum MetafieldConfigurationEntityType {
+    Asset = "Asset",
+    Customer = "Customer",
+    Integration = "Integration",
+    Option = "Option",
+    Order = "Order",
+    Partner = "Partner",
+    Product = "Product",
+    ProductCollection = "ProductCollection",
+    Variant = "Variant",
+    Workflow = "Workflow",
+    WorkflowStep = "WorkflowStep"
+}
+interface MetafieldConfigurationField extends ConfigurableField {
+    type: FieldType.MetafieldConfiguration;
+    entityType: MetafieldConfigurationEntityType;
+}
 /** https://stackoverflow.com/a/57103940/23523714 */
 type DistributiveOmit<T, K extends keyof any> = T extends any ? Omit<T, K> : never;
 /**
- * All fields that are configurable by a user in Hub.
+ * All field types that are configurable by a user in Hub.
  */
-type ThemeConfigurationConfigurableFields = GenericField | AssetField | DateRangeField | ConversionConfigurationField | SelectField | TextField | ListField | ObjectField | CustomObjectField;
+type ThemeConfigurationConfigurableFields = GenericField | AssetField | ConversionConfigurationField | SelectField | TextField | ListField | ObjectField | CustomObjectField | ProductCollectionField | MetafieldConfigurationField;
 /**
- * All fields.
+ * All field types, including non-configurable ones.
  */
 type ThemeConfigurationSchemaField = ThemeConfigurationConfigurableFields | HeadingField;
-declare enum AssetType {
-    Color = "Color",
-    ColorProfile = "ColorProfile",
-    Data = "Data",
-    Environment = "Environment",
-    Font = "Font",
-    Frame = "Frame",
-    Illustration = "Illustration",
-    Image = "Image",
-    Material = "Material",
-    Model = "Model",
-    Video = "Video"
-}
 declare enum CustomSchemaType {
     Object = "Object",
     Union = "Union"
@@ -367,11 +385,16 @@ interface ConversionConfiguration {
 interface ThemeInstallConfigurationFieldResource {
     key?: string;
     fallbackToDefaultConfiguration?: boolean;
-    value?: string;
+    value?: string | null;
     type: FieldType;
-    asset?: AssetResource;
-    dateRange?: DateRange;
+    /** 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;
+    /** When the type is `MetafieldConfiguration`, this will be the configured MetafieldConfiguration resource. */
+    metafieldConfiguration?: MetafieldConfigurationResource;
+    /** When the type is `ProductCollection`, this will be the configured ProductCollection resource. */
+    productCollection?: ProductCollectionResource;
     /** 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 */
@@ -389,9 +412,17 @@ interface AssetResource {
     fileLink: string;
     type: AssetType;
 }
-interface DateRange {
-    start: Date;
-    end: Date;
+interface MetafieldConfigurationResource {
+    id: string;
+    name: string;
+    description: string | null;
+    metafieldType: string;
+}
+interface ProductCollectionResource {
+    id: string;
+    name: string;
+    description: string | null;
+    image: AssetResource | null;
 }
 /**
  * Maps a `ThemeInstallConfigurationResource`'s fields (which is essentially `{ key: string; value: string; }[]`), to the form `{ [key: string]: any }`.
@@ -533,9 +564,7 @@ type ThemeConfigurationSchemaFieldGraphQl = Omit<ThemeConfigurationSchemaFieldRe
     /** Whether this field is on the root. Otherwise this is a child. */
     root?: boolean | null;
 };
-type ThemeInstallConfigurationGraphQl = Omit<ThemeInstallConfigurationResource, "fields"> & {
-    fields: ThemeInstallConfigurationFieldGraphQl[];
-};
+
 type ThemeInstallConfigurationFieldGraphQl = Omit<ThemeInstallConfigurationFieldResource, "listValues" | "objectValues"> & {
     /** When the type is `List`, this will be the indices of the configured values */
     listValues?: number[] | null;
@@ -553,33 +582,4 @@ declare function setSpiffDevOptions(container: HTMLElement | string, context: Sp
 declare function exampleThemeInstallConfig(opts?: Partial<ThemeInstallConfigurationResource>): ThemeInstallConfigurationResource;
 declare function getDefaultsForSchema(schema: ThemeConfigurationSchema, ...excludeKeys: string[]): ThemeInstallConfigurationFieldResource[];
 
-interface PluginOptions {
-    /**
-     * When `true`, will automatically insert files from the build into the `launchData.targetFiles` field.
-     * @default true
-     */
-    autoGenerateTargetFiles?: boolean;
-    /**
-     * A configuration schema to allow installs to customize your theme.
-     * @default undefined
-     */
-    configurationSchema?: ThemeConfigurationSchema;
-    /**
-     * Generates `targetFiles` entries with preload set to true. Only applies when `autoGenerateTargetFiles` is set to true.
-     * By default this will only include the primary entry file(s).
-     * @default false
-     */
-    includePreloadChunks?: boolean;
-    /**
-     * Manually add/override specific files.
-     * @default undefined
-     */
-    targetFiles?: ThemeConfigurationLaunchDataTargetFile[];
-}
-/**
- * Automatically generates a `spiffTheme.json` file in your output directory.
- * @param opts Options to customize the generated file.
- */
-declare function spiffThemePlugin(opts?: PluginOptions): Plugin;
-
-export { type AssetResource, AssetType, type CompleteQuoteMessage, type ConversionConfiguration, type ConversionData, ConversionLocation, CustomSchemaType, type DateRange, FieldType, type SpiffDevOptions, type SpiffThemeLoader, type ThemeConfigurationConfigurableFields, type ThemeConfigurationFile, type ThemeConfigurationLaunchData, type ThemeConfigurationLaunchDataTargetFile, type ThemeConfigurationSchema, type ThemeConfigurationSchemaCustomSchema, type ThemeConfigurationSchemaCustomSchemaGraphQl, type ThemeConfigurationSchemaCustomSchemaResource, type ThemeConfigurationSchemaField, type ThemeConfigurationSchemaFieldGraphQl, type ThemeConfigurationSchemaFieldResource, type ThemeConfigurationSchemaGraphQl, type ThemeConfigurationSchemaResource, type ThemeContext, type ThemeContextBundle, type ThemeContextBundleOptions, type ThemeContextBundleOptionsExisting, type ThemeContextBundleOptionsNew, type ThemeContextTransaction, type ThemeContextWorkflowOptions, type ThemeContextWorkflowOptionsExternalProduct, type ThemeContextWorkflowOptionsIntegrationProduct, type ThemeContextWorkflowOptionsNewBase, type ThemeContextWorkflowOptionsTransaction, ThemeFileType, type ThemeInstallConfigurationField, type ThemeInstallConfigurationFieldGraphQl, type ThemeInstallConfigurationFieldResource, type ThemeInstallConfigurationGraphQl, type ThemeInstallConfigurationResource, type ThemeLaunchDataResource, type ThemeLaunchDataTargetFileResource, type ThemeResource, type ThemeVersionGraphQl, type ThemeVersionResource, exampleThemeInstallConfig, getDefaultsForSchema, setSpiffDevOptions, spiffThemePlugin, themeInstallConfigurationFieldsToRecordObject, themeInstallConfigurationGraphQlToResource, themeInstallConfigurationToRecordObject, themeVersionConfigurationGraphQlToResource, themeVersionGraphQlToResource };
+export { type AssetResource, AssetType, type CompleteQuoteMessage, type ConversionConfiguration, type ConversionData, ConversionLocation, CustomSchemaType, FieldType, MetafieldConfigurationEntityType, type MetafieldConfigurationResource, type ProductCollectionResource, type SpiffDevOptions, type SpiffThemeLoader, type ThemeConfigurationConfigurableFields, type ThemeConfigurationFile, type ThemeConfigurationLaunchData, type ThemeConfigurationLaunchDataTargetFile, type ThemeConfigurationSchema, type ThemeConfigurationSchemaCustomSchema, type ThemeConfigurationSchemaCustomSchemaGraphQl, type ThemeConfigurationSchemaCustomSchemaResource, type ThemeConfigurationSchemaField, type ThemeConfigurationSchemaFieldGraphQl, type ThemeConfigurationSchemaFieldResource, type ThemeConfigurationSchemaGraphQl, type ThemeConfigurationSchemaResource, type ThemeContext, type ThemeContextBundle, type ThemeContextBundleOptions, type ThemeContextBundleOptionsExisting, type ThemeContextBundleOptionsNew, type ThemeContextTransaction, type ThemeContextWorkflowOptions, type ThemeContextWorkflowOptionsExternalProduct, type ThemeContextWorkflowOptionsIntegrationProduct, type ThemeContextWorkflowOptionsNewBase, type ThemeContextWorkflowOptionsTransaction, ThemeFileType, type ThemeInstallConfigurationField, type ThemeInstallConfigurationFieldGraphQl, type ThemeInstallConfigurationFieldResource, type ThemeInstallConfigurationResource, type ThemeLaunchDataResource, type ThemeLaunchDataTargetFileResource, type ThemeResource, type ThemeVersionGraphQl, type ThemeVersionResource, exampleThemeInstallConfig, getDefaultsForSchema, setSpiffDevOptions, themeInstallConfigurationFieldsToRecordObject, themeInstallConfigurationGraphQlToResource, themeInstallConfigurationToRecordObject, themeVersionConfigurationGraphQlToResource, themeVersionGraphQlToResource };