@spiffcommerce/theme-bridge 1.27.0 → 1.27.1-alpha.1

package/dist/index.d.ts

@@ -12,6 +12,69 @@ interface ThemeConfigurationFile {
      * An object that describes information that's configurable by a Partner when they install your theme.
      */
     configurationSchema?: ThemeConfigurationSchema;
+    /**
+     * Optional: Settings for how the Spiff Hub displays your theme's configuration fields.
+     * If this is not present, all of your fields will be placed in an auto-generated `Misc` page.
+     */
+    pageSettings?: ThemeConfigurationPageSettings;
+}
+interface ThemeConfigurationPageSettings {
+    /**
+     * Settings for each page to display in the Spiff Hub. Use this to group large sections of fields together.
+     * Any fields not configured into these pages will be placed in an auto-generated `Misc` page.
+     */
+    items: ThemeConfigurationPageItem[];
+    /**
+     * Optional: configuration for which pages can be reordered.
+     * All pages which fall between `start` and `end` (inclusive) will be reorderable by the user.
+     */
+    reorderablePageSettings?: {
+        /** The key of the first page which can be reordered. */
+        start: string;
+        /** The key of the final page which can be reordered. */
+        end: string;
+    };
+}
+interface ThemeConfigurationPageItem {
+    /**
+     * An identifier used for the system to reference this page by.
+     * You may also use this to reference the page in your theme at runtime.
+     */
+    key: string;
+    /**
+     * The heading to display in the configuration page.
+     * This will also be displayed in summary views.
+     */
+    title: string;
+    /**
+     * Optional: A sub-heading to display in the configuration page.
+     */
+    subtitle?: string | null;
+    /**
+     * Groups of configuration fields to be editable on this page.
+     */
+    sections: ThemeConfigurationPageSection[];
+    /**
+     * Whether this page can be disabled/enabled/hidden/visible.
+     * Note that fields on page will still be configurable by the user.
+     */
+    toggleable: boolean;
+    /**
+     * When true, this page will not be active by default.
+     * Note that if you specify `toggleable: true`, this only acts as a default value.
+     */
+    disabled?: boolean;
+}
+interface ThemeConfigurationPageSection {
+    /** A heading to group these fields by. */
+    title: string;
+    /** Optional: Sub-heading to display underneath the heading. */
+    subtitle?: string | null;
+    /**
+     * The `key` names of the fields to display in this section.
+     * These **must** be static fields.
+     */
+    fields: string[];
 }
 declare enum ThemeFileType {
     Javascript = "Javascript",
@@ -288,6 +351,7 @@ interface ThemeVersionResource {
     updatedAt: string;
     configurationSchema: ThemeConfigurationSchemaResource;
     launchData: ThemeLaunchDataResource;
+    pageSettings?: ThemeConfigurationPageSettings;
 }
 interface ThemeConfigurationSchemaResource {
     fields: ThemeConfigurationSchemaFieldResource[];
@@ -346,6 +410,17 @@ interface ThemeInstallConfigurationResource {
     createdAt: string;
     updatedAt: string;
     fields: ThemeInstallConfigurationFieldResource[];
+    pageSettings?: ThemeInstallPageSettings;
+}
+/** The user-configured values for the given theme's page settings */
+interface ThemeInstallPageSettings {
+    pageOrder?: string[];
+    items: ThemeInstallPageSettingsItem[];
+}
+interface ThemeInstallPageSettingsItem {
+    key: string;
+    /** Only provided if the user actually changed the default value. */
+    enabled?: boolean;
 }
 /**
  * Defines the locations at which a conversion attempt can take place.
@@ -609,4 +684,4 @@ declare function setSpiffDevOptions(container: HTMLElement | string, context: Sp
 declare function exampleThemeInstallConfig(opts?: Partial<ThemeInstallConfigurationResource>): ThemeInstallConfigurationResource;
 declare function getDefaultsForSchema(schema: ThemeConfigurationSchema, ...excludeKeys: string[]): ThemeInstallConfigurationFieldResource[];
 
-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 };
+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 ThemeConfigurationPageItem, type ThemeConfigurationPageSection, type ThemeConfigurationPageSettings, 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 ThemeInstallPageSettings, type ThemeInstallPageSettingsItem, type ThemeLaunchDataResource, type ThemeLaunchDataTargetFileResource, type ThemeResource, type ThemeVersionGraphQl, type ThemeVersionResource, exampleThemeInstallConfig, getDefaultsForSchema, setSpiffDevOptions, themeInstallConfigurationFieldsToRecordObject, themeInstallConfigurationGraphQlToResource, themeInstallConfigurationToRecordObject, themeVersionConfigurationGraphQlToResource, themeVersionGraphQlToResource };