@mercurjs/dashboard-sdk 2.3.7 → 2.3.8-canary.1

package/dist/index.d.cts

@@ -58,11 +58,31 @@ type CustomFormZone<TModel> = ModelShape<TModel>["formZones"];
  * onboarding steps) and for unknown models.
  */
 type CustomFormTab<TModel, TZone> = TZone extends keyof ModelShape<TModel>["formTabs"] ? ModelShape<TModel>["formTabs"][TZone] : string;
-type CustomFormEntry<TModel> = CustomFormZone<TModel> extends infer TZone ? TZone extends CustomFormZone<TModel> ? {
+/**
+ * Onboarding wizard step settings, read only for `zone: "onboarding"`. A tab id
+ * the wizard doesn't ship becomes a new step; on a built-in step these override
+ * its defaults. Built-in ranks: store 10, address 20, company 30, payment 40.
+ */
+type OnboardingStepOptions = {
+    /** Step heading. Required in practice for new steps. */
+    label?: string;
+    /** Sort position. New steps without a rank go last. */
+    rank?: number;
+    /** Shows a Skip button on the step. */
+    optional?: boolean;
+};
+type CustomFormEntry<TModel> = CustomFormZone<TModel> extends infer TZone ? TZone extends CustomFormZone<TModel> ? ({
     zone: TZone;
     /** TabbedForm tab id, or onboarding wizard step id for `zone: "onboarding"`. */
     tab?: CustomFormTab<TModel, TZone>;
-    fields: Record<string, CustomFormField>;
+    fields?: Record<string, CustomFormField>;
+    disabled?: false;
+} & OnboardingStepOptions) | {
+    zone: TZone;
+    tab: CustomFormTab<TModel, TZone>;
+    /** Removes a built-in onboarding step. The store step can't be removed. */
+    disabled: true;
+    fields?: never;
 } : never : never;
 /**
  * ADD (unknown id + component), REPLACE (built-in id + component), or REMOVE
@@ -164,4 +184,4 @@ declare function defineWidgetConfig(config: WidgetConfig): WidgetConfig;
 declare function defineNavigationConfig<TGroup extends string = never>(config: NavigationConfig<TGroup>): NavigationConfig<TGroup>;
 declare function defineCustomFieldsConfig<TModel extends CustomFieldModel>(config: CustomFieldsConfig<TModel>): CustomFieldsConfig<TModel>;
 
-export { type ActivityEntry, type CustomColumn, type CustomDisplayEntry, type CustomDisplayField, type CustomFieldAction, type CustomFieldActionRegistry, type CustomFieldModel, type CustomFieldsConfig, type CustomFieldsRegistry, type CustomFormEntry, type CustomFormField, type CustomFormTab, type CustomFormZone, type CustomListExtension, type CustomListFilter, type CustomListFilterOption, type FieldValidation, NavigationConfig, type SectionAction, WidgetConfig, defineCustomFieldsConfig, defineNavigationConfig, defineWidgetConfig };
+export { type ActivityEntry, type CustomColumn, type CustomDisplayEntry, type CustomDisplayField, type CustomFieldAction, type CustomFieldActionRegistry, type CustomFieldModel, type CustomFieldsConfig, type CustomFieldsRegistry, type CustomFormEntry, type CustomFormField, type CustomFormTab, type CustomFormZone, type CustomListExtension, type CustomListFilter, type CustomListFilterOption, type FieldValidation, NavigationConfig, type OnboardingStepOptions, type SectionAction, WidgetConfig, defineCustomFieldsConfig, defineNavigationConfig, defineWidgetConfig };

package/dist/index.d.ts

@@ -58,11 +58,31 @@ type CustomFormZone<TModel> = ModelShape<TModel>["formZones"];
  * onboarding steps) and for unknown models.
  */
 type CustomFormTab<TModel, TZone> = TZone extends keyof ModelShape<TModel>["formTabs"] ? ModelShape<TModel>["formTabs"][TZone] : string;
-type CustomFormEntry<TModel> = CustomFormZone<TModel> extends infer TZone ? TZone extends CustomFormZone<TModel> ? {
+/**
+ * Onboarding wizard step settings, read only for `zone: "onboarding"`. A tab id
+ * the wizard doesn't ship becomes a new step; on a built-in step these override
+ * its defaults. Built-in ranks: store 10, address 20, company 30, payment 40.
+ */
+type OnboardingStepOptions = {
+    /** Step heading. Required in practice for new steps. */
+    label?: string;
+    /** Sort position. New steps without a rank go last. */
+    rank?: number;
+    /** Shows a Skip button on the step. */
+    optional?: boolean;
+};
+type CustomFormEntry<TModel> = CustomFormZone<TModel> extends infer TZone ? TZone extends CustomFormZone<TModel> ? ({
     zone: TZone;
     /** TabbedForm tab id, or onboarding wizard step id for `zone: "onboarding"`. */
     tab?: CustomFormTab<TModel, TZone>;
-    fields: Record<string, CustomFormField>;
+    fields?: Record<string, CustomFormField>;
+    disabled?: false;
+} & OnboardingStepOptions) | {
+    zone: TZone;
+    tab: CustomFormTab<TModel, TZone>;
+    /** Removes a built-in onboarding step. The store step can't be removed. */
+    disabled: true;
+    fields?: never;
 } : never : never;
 /**
  * ADD (unknown id + component), REPLACE (built-in id + component), or REMOVE
@@ -164,4 +184,4 @@ declare function defineWidgetConfig(config: WidgetConfig): WidgetConfig;
 declare function defineNavigationConfig<TGroup extends string = never>(config: NavigationConfig<TGroup>): NavigationConfig<TGroup>;
 declare function defineCustomFieldsConfig<TModel extends CustomFieldModel>(config: CustomFieldsConfig<TModel>): CustomFieldsConfig<TModel>;
 
-export { type ActivityEntry, type CustomColumn, type CustomDisplayEntry, type CustomDisplayField, type CustomFieldAction, type CustomFieldActionRegistry, type CustomFieldModel, type CustomFieldsConfig, type CustomFieldsRegistry, type CustomFormEntry, type CustomFormField, type CustomFormTab, type CustomFormZone, type CustomListExtension, type CustomListFilter, type CustomListFilterOption, type FieldValidation, NavigationConfig, type SectionAction, WidgetConfig, defineCustomFieldsConfig, defineNavigationConfig, defineWidgetConfig };
+export { type ActivityEntry, type CustomColumn, type CustomDisplayEntry, type CustomDisplayField, type CustomFieldAction, type CustomFieldActionRegistry, type CustomFieldModel, type CustomFieldsConfig, type CustomFieldsRegistry, type CustomFormEntry, type CustomFormField, type CustomFormTab, type CustomFormZone, type CustomListExtension, type CustomListFilter, type CustomListFilterOption, type FieldValidation, NavigationConfig, type OnboardingStepOptions, type SectionAction, WidgetConfig, defineCustomFieldsConfig, defineNavigationConfig, defineWidgetConfig };

package/dist/vite.cjs

@@ -852,8 +852,8 @@ function generateCustomFields({
     (_, i) => `    ...(__plugin${i}.customFieldsModule?.configs ?? [])`
   );
   const configs = [
-    ...localRefs.map((ref) => `    ${ref}`),
-    ...pluginSpreads
+    ...pluginSpreads,
+    ...localRefs.map((ref) => `    ${ref}`)
   ];
   if (configs.length === 0 && pluginDeclarations.length === 0) {
     return `export default { configs: [] }`;

package/dist/vite.js

@@ -832,8 +832,8 @@ function generateCustomFields({
     (_, i) => `    ...(__plugin${i}.customFieldsModule?.configs ?? [])`
   );
   const configs = [
-    ...localRefs.map((ref) => `    ${ref}`),
-    ...pluginSpreads
+    ...pluginSpreads,
+    ...localRefs.map((ref) => `    ${ref}`)
   ];
   if (configs.length === 0 && pluginDeclarations.length === 0) {
     return `export default { configs: [] }`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercurjs/dashboard-sdk",
-  "version": "2.3.7",
+  "version": "2.3.8-canary.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/mercurjs/mercur",