@mercurjs/dashboard-sdk 2.2.0-rc.0 → 2.2.0-rc.2

package/dist/index.d.cts

@@ -1,94 +1,173 @@
-import * as Vite from 'vite';
+export { B as BuiltMercurConfig, M as MercurConfig, R as RouteConfig } from './types-zgnwn8ra.cjs';
 import { ComponentType } from 'react';
 
 /**
- * Configuration for the Mercur dashboard plugin.
- *
- * Passed to `mercurDashboardPlugin()` in `vite.config.ts` to configure
- * the vendor or admin dashboard at build time.
+ * Open registry interfaces. Each panel package ships a generated
+ * `extension-targets.d.ts` that seeds the built-in ids into these interfaces
+ * (declaration merging), and a developer augments them by hand to register a
+ * zone their own page renders. The helper unions read off the interface keys.
  *
  * @example
- * ```ts
- * mercurDashboardPlugin({
- *   medusaConfigPath: '../../packages/api/medusa-config.ts',
- *   enableSellerRegistration: true,
- * })
- * ```
+ * declare module "@mercurjs/dashboard-sdk" {
+ *   interface WidgetZoneRegistry {
+ *     "erp.dashboard.before": true
+ *   }
+ * }
  */
-interface MercurConfig {
-    /** Path to the MedusaJS config file, resolved relative to the project root. */
-    medusaConfigPath: string;
-    /**
-     * Backend URL for API requests.
-     * @default "http://localhost:9000"
-     */
-    backendUrl?: string;
-    /**
-     * Absolute base URL for the vendor dashboard, including any path prefix
-     * (for example `https://vendors.example.com/seller`).
-     *
-     * The plugin does not read `.env` files on its own. Load env in your
-     * app's `vite.config.ts` and pass the value here when you need
-     * cross-origin links such as seller invite URLs.
-     *
-     * If omitted, the plugin falls back to vendor module dev server
-     * detection in development and to the configured vendor path in
-     * production.
-     */
-    vendorUrl?: string;
-    /** Dashboard display name. */
-    name?: string;
-    /** Path to a logo asset for the dashboard. */
-    logo?: string;
-    /**
-     * Override built-in layout components with custom implementations.
-     * Paths are resolved relative to `src/`.
-     */
-    components?: {
-        MainSidebar?: string;
-        SettingsSidebar?: string;
-        TopbarActions?: string;
-        StoreSetup?: string;
-    };
-    /** Internationalization settings. */
-    i18n?: {
-        /** The default language code (e.g. `"en"`). */
-        defaultLanguage: string;
-    };
-    /** Whether to allow new sellers to register from the login screen. */
-    enableSellerRegistration?: boolean;
+interface WidgetZoneRegistry {
+}
+interface NavItemRegistry {
+}
+interface NavParentRegistry {
+}
+type WidgetZoneId = keyof WidgetZoneRegistry extends never ? string : keyof WidgetZoneRegistry;
+type NavItemId = keyof NavItemRegistry extends never ? string : keyof NavItemRegistry;
+type NavParentId = keyof NavParentRegistry extends never ? string : keyof NavParentRegistry;
+/**
+ * A widget is a React component attached to a named zone on a page. The
+ * placement (`before | after`) is encoded as the zone-id suffix, so there is no
+ * separate rank field — multiple `before`/`after` widgets stack in registration
+ * order.
+ */
+interface WidgetConfig {
+    zone: WidgetZoneId | WidgetZoneId[];
+    /** Stable id; derived from the file path at build time when omitted. */
+    id?: string;
+}
+/** Override for a single built-in navigation item. */
+interface NavItemOverride {
+    id: NavItemId;
+    /** Order within the item's parent (or among top-level items). */
+    rank?: number;
+    /** Remove from the sidebar (route may still be reachable directly). */
+    hidden?: boolean;
+    /** i18n key or literal replacing the item's label. */
+    label?: string;
+    /** Icon component replacing the item's icon. */
+    icon?: ComponentType;
     /**
-     * Maximum allowed size for image uploads, in bytes.
-     * Used by dashboard upload components to reject oversized files
-     * before they are sent to the backend.
-     * @default 2_097_152 // 2 MB
+     * Re-parent the item: a built-in parent id moves it under that parent's
+     * children; `null` promotes a nested item to the top level.
      */
-    imageLimit?: number;
+    nested?: NavParentId | null;
 }
-interface BuiltMercurConfig extends MercurConfig {
-    backendUrl: string;
-    base?: string;
-    root: string;
-    srcDir: string;
-    pluginExtensions: string[];
-    imageLimit: number;
+interface NavigationConfig {
+    items: NavItemOverride[];
 }
-type RouteConfig = {
-    label: string;
-    icon?: ComponentType;
-    rank?: number;
-    nested?: string;
-    translationNs?: string;
-    public?: boolean;
-};
-
-declare function mercurDashboardPlugin(pluginConfig: MercurConfig): Vite.Plugin;
 
 /**
- * Generates a plugin entry module for a given source directory (e.g. src/vendor).
- * Scans routes, menu items, and i18n — outputs a single module string
- * that exports default `{ routeModule, menuItemModule, i18nModule }`.
+ * Minimal structural stand-in for a Zod schema, so the SDK stays free of a zod
+ * dependency. `createFormHelper` (in `@mercurjs/dashboard-shared`) produces real
+ * zod schemas that satisfy this shape.
  */
-declare function generatePluginEntryModule(srcDir: string): string;
+type FieldValidation = {
+    safeParse?: (value: unknown) => unknown;
+    parse?: (value: unknown) => unknown;
+    def?: {
+        type?: string;
+    };
+    _def?: unknown;
+};
+/**
+ * Per-model registry seeded by each panel's generated `extension-targets.d.ts`
+ * and extendable by hand. Shapes the typed form/display zones per model.
+ *
+ * @example
+ * declare module "@mercurjs/dashboard-sdk" {
+ *   interface CustomFieldsRegistry {
+ *     product: {
+ *       formZones: "create" | "edit" | "organize" | "attributes"
+ *       formTabs: { create: "general" | "organize"; edit: never }
+ *       displayZones: "general" | "organize"
+ *     }
+ *   }
+ * }
+ */
+interface CustomFieldsRegistry {
+}
+type DefaultModelShape = {
+    formZones: string;
+    formTabs: Record<string, string>;
+    displayZones: string;
+    displayFieldIds: string;
+};
+type CustomFieldModel = keyof CustomFieldsRegistry extends never ? string : keyof CustomFieldsRegistry;
+type ModelShape<TModel> = TModel extends keyof CustomFieldsRegistry ? CustomFieldsRegistry[TModel] & DefaultModelShape : DefaultModelShape;
+type CustomFormField<TData = unknown> = {
+    /** Zod schema — drives the input type and validation. */
+    validation: FieldValidation;
+    /** Static default or a resolver from the loaded entity. */
+    defaultValue?: ((data: TData) => unknown) | unknown;
+    label?: string;
+    description?: string;
+    placeholder?: string;
+    /** Custom render component; falls back to a default input for the type. */
+    component?: ComponentType;
+};
+type CustomFormZone<TModel> = ModelShape<TModel>["formZones"];
+/**
+ * Valid tab ids for a model's form zone. Narrows to the scanned union when the
+ * zone has tabbed forms; falls back to `string` for zones without tabs (e.g.
+ * 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> ? {
+    zone: TZone;
+    /** TabbedForm tab id, or onboarding wizard step id for `zone: "onboarding"`. */
+    tab?: CustomFormTab<TModel, TZone>;
+    fields: Record<string, CustomFormField>;
+} : never : never;
+/**
+ * ADD (unknown id + component), REPLACE (built-in id + component), or REMOVE
+ * (built-in id + `component: null`) a section field. Built-in ids autocomplete
+ * from the model's generated `displayFieldIds`; any other string adds a new row.
+ */
+type CustomDisplayField<TModel = unknown> = {
+    id: ModelShape<TModel>["displayFieldIds"] | (string & {});
+    component: ComponentType<{
+        data?: unknown;
+    }> | null;
+};
+/** Same `{ rank?, component }` shape as list bulk actions. */
+type SectionAction = {
+    rank?: number;
+    component: ComponentType<{
+        data?: unknown;
+    }>;
+};
+type CustomDisplayEntry<TModel> = {
+    zone: ModelShape<TModel>["displayZones"];
+    fields?: CustomDisplayField<TModel>[];
+    actions?: SectionAction[];
+};
+type CustomColumn = {
+    id: string;
+    header?: string;
+    component?: ComponentType<{
+        row?: unknown;
+        value?: unknown;
+    }>;
+};
+type CustomListExtension = {
+    columns?: CustomColumn[];
+    bulkActions?: SectionAction[];
+    filters?: unknown[];
+    viewDefaults?: {
+        columnVisibility?: Record<string, boolean>;
+        columnOrder?: string[];
+    };
+};
+interface CustomFieldsConfig<TModel extends CustomFieldModel = CustomFieldModel> {
+    model: TModel;
+    /** Module link(s) fetched alongside the entity (e.g. `brand`). */
+    link?: string | string[];
+    list?: CustomListExtension;
+    forms?: CustomFormEntry<TModel>[];
+    displays?: CustomDisplayEntry<TModel>[];
+}
+
+declare function defineWidgetConfig(config: WidgetConfig): WidgetConfig;
+declare function defineNavigationConfig(config: NavigationConfig): NavigationConfig;
+declare function defineCustomFieldsConfig<TModel extends CustomFieldModel>(config: CustomFieldsConfig<TModel>): CustomFieldsConfig<TModel>;
 
-export { type BuiltMercurConfig, type MercurConfig, type RouteConfig, generatePluginEntryModule, mercurDashboardPlugin };
+export { type CustomColumn, type CustomDisplayEntry, type CustomDisplayField, type CustomFieldModel, type CustomFieldsConfig, type CustomFieldsRegistry, type CustomFormEntry, type CustomFormField, type CustomFormTab, type CustomFormZone, type CustomListExtension, type FieldValidation, type NavItemId, type NavItemOverride, type NavItemRegistry, type NavParentId, type NavParentRegistry, type NavigationConfig, type SectionAction, type WidgetConfig, type WidgetZoneId, type WidgetZoneRegistry, defineCustomFieldsConfig, defineNavigationConfig, defineWidgetConfig };

package/dist/index.d.ts

@@ -0,0 +1,173 @@
+export { B as BuiltMercurConfig, M as MercurConfig, R as RouteConfig } from './types-zgnwn8ra.js';
+import { ComponentType } from 'react';
+
+/**
+ * Open registry interfaces. Each panel package ships a generated
+ * `extension-targets.d.ts` that seeds the built-in ids into these interfaces
+ * (declaration merging), and a developer augments them by hand to register a
+ * zone their own page renders. The helper unions read off the interface keys.
+ *
+ * @example
+ * declare module "@mercurjs/dashboard-sdk" {
+ *   interface WidgetZoneRegistry {
+ *     "erp.dashboard.before": true
+ *   }
+ * }
+ */
+interface WidgetZoneRegistry {
+}
+interface NavItemRegistry {
+}
+interface NavParentRegistry {
+}
+type WidgetZoneId = keyof WidgetZoneRegistry extends never ? string : keyof WidgetZoneRegistry;
+type NavItemId = keyof NavItemRegistry extends never ? string : keyof NavItemRegistry;
+type NavParentId = keyof NavParentRegistry extends never ? string : keyof NavParentRegistry;
+/**
+ * A widget is a React component attached to a named zone on a page. The
+ * placement (`before | after`) is encoded as the zone-id suffix, so there is no
+ * separate rank field — multiple `before`/`after` widgets stack in registration
+ * order.
+ */
+interface WidgetConfig {
+    zone: WidgetZoneId | WidgetZoneId[];
+    /** Stable id; derived from the file path at build time when omitted. */
+    id?: string;
+}
+/** Override for a single built-in navigation item. */
+interface NavItemOverride {
+    id: NavItemId;
+    /** Order within the item's parent (or among top-level items). */
+    rank?: number;
+    /** Remove from the sidebar (route may still be reachable directly). */
+    hidden?: boolean;
+    /** i18n key or literal replacing the item's label. */
+    label?: string;
+    /** Icon component replacing the item's icon. */
+    icon?: ComponentType;
+    /**
+     * Re-parent the item: a built-in parent id moves it under that parent's
+     * children; `null` promotes a nested item to the top level.
+     */
+    nested?: NavParentId | null;
+}
+interface NavigationConfig {
+    items: NavItemOverride[];
+}
+
+/**
+ * Minimal structural stand-in for a Zod schema, so the SDK stays free of a zod
+ * dependency. `createFormHelper` (in `@mercurjs/dashboard-shared`) produces real
+ * zod schemas that satisfy this shape.
+ */
+type FieldValidation = {
+    safeParse?: (value: unknown) => unknown;
+    parse?: (value: unknown) => unknown;
+    def?: {
+        type?: string;
+    };
+    _def?: unknown;
+};
+/**
+ * Per-model registry seeded by each panel's generated `extension-targets.d.ts`
+ * and extendable by hand. Shapes the typed form/display zones per model.
+ *
+ * @example
+ * declare module "@mercurjs/dashboard-sdk" {
+ *   interface CustomFieldsRegistry {
+ *     product: {
+ *       formZones: "create" | "edit" | "organize" | "attributes"
+ *       formTabs: { create: "general" | "organize"; edit: never }
+ *       displayZones: "general" | "organize"
+ *     }
+ *   }
+ * }
+ */
+interface CustomFieldsRegistry {
+}
+type DefaultModelShape = {
+    formZones: string;
+    formTabs: Record<string, string>;
+    displayZones: string;
+    displayFieldIds: string;
+};
+type CustomFieldModel = keyof CustomFieldsRegistry extends never ? string : keyof CustomFieldsRegistry;
+type ModelShape<TModel> = TModel extends keyof CustomFieldsRegistry ? CustomFieldsRegistry[TModel] & DefaultModelShape : DefaultModelShape;
+type CustomFormField<TData = unknown> = {
+    /** Zod schema — drives the input type and validation. */
+    validation: FieldValidation;
+    /** Static default or a resolver from the loaded entity. */
+    defaultValue?: ((data: TData) => unknown) | unknown;
+    label?: string;
+    description?: string;
+    placeholder?: string;
+    /** Custom render component; falls back to a default input for the type. */
+    component?: ComponentType;
+};
+type CustomFormZone<TModel> = ModelShape<TModel>["formZones"];
+/**
+ * Valid tab ids for a model's form zone. Narrows to the scanned union when the
+ * zone has tabbed forms; falls back to `string` for zones without tabs (e.g.
+ * 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> ? {
+    zone: TZone;
+    /** TabbedForm tab id, or onboarding wizard step id for `zone: "onboarding"`. */
+    tab?: CustomFormTab<TModel, TZone>;
+    fields: Record<string, CustomFormField>;
+} : never : never;
+/**
+ * ADD (unknown id + component), REPLACE (built-in id + component), or REMOVE
+ * (built-in id + `component: null`) a section field. Built-in ids autocomplete
+ * from the model's generated `displayFieldIds`; any other string adds a new row.
+ */
+type CustomDisplayField<TModel = unknown> = {
+    id: ModelShape<TModel>["displayFieldIds"] | (string & {});
+    component: ComponentType<{
+        data?: unknown;
+    }> | null;
+};
+/** Same `{ rank?, component }` shape as list bulk actions. */
+type SectionAction = {
+    rank?: number;
+    component: ComponentType<{
+        data?: unknown;
+    }>;
+};
+type CustomDisplayEntry<TModel> = {
+    zone: ModelShape<TModel>["displayZones"];
+    fields?: CustomDisplayField<TModel>[];
+    actions?: SectionAction[];
+};
+type CustomColumn = {
+    id: string;
+    header?: string;
+    component?: ComponentType<{
+        row?: unknown;
+        value?: unknown;
+    }>;
+};
+type CustomListExtension = {
+    columns?: CustomColumn[];
+    bulkActions?: SectionAction[];
+    filters?: unknown[];
+    viewDefaults?: {
+        columnVisibility?: Record<string, boolean>;
+        columnOrder?: string[];
+    };
+};
+interface CustomFieldsConfig<TModel extends CustomFieldModel = CustomFieldModel> {
+    model: TModel;
+    /** Module link(s) fetched alongside the entity (e.g. `brand`). */
+    link?: string | string[];
+    list?: CustomListExtension;
+    forms?: CustomFormEntry<TModel>[];
+    displays?: CustomDisplayEntry<TModel>[];
+}
+
+declare function defineWidgetConfig(config: WidgetConfig): WidgetConfig;
+declare function defineNavigationConfig(config: NavigationConfig): NavigationConfig;
+declare function defineCustomFieldsConfig<TModel extends CustomFieldModel>(config: CustomFieldsConfig<TModel>): CustomFieldsConfig<TModel>;
+
+export { type CustomColumn, type CustomDisplayEntry, type CustomDisplayField, type CustomFieldModel, type CustomFieldsConfig, type CustomFieldsRegistry, type CustomFormEntry, type CustomFormField, type CustomFormTab, type CustomFormZone, type CustomListExtension, type FieldValidation, type NavItemId, type NavItemOverride, type NavItemRegistry, type NavParentId, type NavParentRegistry, type NavigationConfig, type SectionAction, type WidgetConfig, type WidgetZoneId, type WidgetZoneRegistry, defineCustomFieldsConfig, defineNavigationConfig, defineWidgetConfig };

package/dist/index.js

@@ -0,0 +1,23 @@
+import "./chunk-3RG5ZIWI.js";
+
+// src/config/utils.ts
+function createConfigHelper(config) {
+  return {
+    ...config,
+    $$typeof: /* @__PURE__ */ Symbol.for("react.memo")
+  };
+}
+function defineWidgetConfig(config) {
+  return createConfigHelper(config);
+}
+function defineNavigationConfig(config) {
+  return createConfigHelper(config);
+}
+function defineCustomFieldsConfig(config) {
+  return createConfigHelper(config);
+}
+export {
+  defineCustomFieldsConfig,
+  defineNavigationConfig,
+  defineWidgetConfig
+};

package/dist/types-zgnwn8ra.d.cts

@@ -0,0 +1,74 @@
+import { ComponentType } from 'react';
+
+/**
+ * Configuration for the Mercur dashboard plugin.
+ *
+ * Passed to `mercurDashboardPlugin()` in `vite.config.ts` to configure
+ * the vendor or admin dashboard at build time.
+ *
+ * @example
+ * ```ts
+ * mercurDashboardPlugin({
+ *   medusaConfigPath: '../../packages/api/medusa-config.ts',
+ *   enableSellerRegistration: true,
+ * })
+ * ```
+ */
+interface MercurConfig {
+    /** Path to the MedusaJS config file, resolved relative to the project root. */
+    medusaConfigPath: string;
+    /**
+     * Backend URL for API requests.
+     * @default "http://localhost:9000"
+     */
+    backendUrl?: string;
+    /**
+     * Absolute base URL for the vendor dashboard, including any path prefix
+     * (for example `https://vendors.example.com/seller`).
+     *
+     * The plugin does not read `.env` files on its own. Load env in your
+     * app's `vite.config.ts` and pass the value here when you need
+     * cross-origin links such as seller invite URLs.
+     *
+     * If omitted, the plugin falls back to vendor module dev server
+     * detection in development and to the configured vendor path in
+     * production.
+     */
+    vendorUrl?: string;
+    /** Dashboard display name. */
+    name?: string;
+    /** Path to a logo asset for the dashboard. */
+    logo?: string;
+    /** Internationalization settings. */
+    i18n?: {
+        /** The default language code (e.g. `"en"`). */
+        defaultLanguage: string;
+    };
+    /** Whether to allow new sellers to register from the login screen. */
+    enableSellerRegistration?: boolean;
+    /**
+     * Maximum allowed size for image uploads, in bytes.
+     * Used by dashboard upload components to reject oversized files
+     * before they are sent to the backend.
+     * @default 2_097_152 // 2 MB
+     */
+    imageLimit?: number;
+}
+interface BuiltMercurConfig extends MercurConfig {
+    backendUrl: string;
+    base?: string;
+    root: string;
+    srcDir: string;
+    pluginExtensions: string[];
+    imageLimit: number;
+}
+type RouteConfig = {
+    label: string;
+    icon?: ComponentType;
+    rank?: number;
+    nested?: string;
+    translationNs?: string;
+    public?: boolean;
+};
+
+export type { BuiltMercurConfig as B, MercurConfig as M, RouteConfig as R };

package/dist/types-zgnwn8ra.d.ts

@@ -0,0 +1,74 @@
+import { ComponentType } from 'react';
+
+/**
+ * Configuration for the Mercur dashboard plugin.
+ *
+ * Passed to `mercurDashboardPlugin()` in `vite.config.ts` to configure
+ * the vendor or admin dashboard at build time.
+ *
+ * @example
+ * ```ts
+ * mercurDashboardPlugin({
+ *   medusaConfigPath: '../../packages/api/medusa-config.ts',
+ *   enableSellerRegistration: true,
+ * })
+ * ```
+ */
+interface MercurConfig {
+    /** Path to the MedusaJS config file, resolved relative to the project root. */
+    medusaConfigPath: string;
+    /**
+     * Backend URL for API requests.
+     * @default "http://localhost:9000"
+     */
+    backendUrl?: string;
+    /**
+     * Absolute base URL for the vendor dashboard, including any path prefix
+     * (for example `https://vendors.example.com/seller`).
+     *
+     * The plugin does not read `.env` files on its own. Load env in your
+     * app's `vite.config.ts` and pass the value here when you need
+     * cross-origin links such as seller invite URLs.
+     *
+     * If omitted, the plugin falls back to vendor module dev server
+     * detection in development and to the configured vendor path in
+     * production.
+     */
+    vendorUrl?: string;
+    /** Dashboard display name. */
+    name?: string;
+    /** Path to a logo asset for the dashboard. */
+    logo?: string;
+    /** Internationalization settings. */
+    i18n?: {
+        /** The default language code (e.g. `"en"`). */
+        defaultLanguage: string;
+    };
+    /** Whether to allow new sellers to register from the login screen. */
+    enableSellerRegistration?: boolean;
+    /**
+     * Maximum allowed size for image uploads, in bytes.
+     * Used by dashboard upload components to reject oversized files
+     * before they are sent to the backend.
+     * @default 2_097_152 // 2 MB
+     */
+    imageLimit?: number;
+}
+interface BuiltMercurConfig extends MercurConfig {
+    backendUrl: string;
+    base?: string;
+    root: string;
+    srcDir: string;
+    pluginExtensions: string[];
+    imageLimit: number;
+}
+type RouteConfig = {
+    label: string;
+    icon?: ComponentType;
+    rank?: number;
+    nested?: string;
+    translationNs?: string;
+    public?: boolean;
+};
+
+export type { BuiltMercurConfig as B, MercurConfig as M, RouteConfig as R };