@mercurjs/dashboard-sdk 2.3.4 → 2.3.5

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 export { B as BuiltMercurConfig, M as MercurConfig, O as OPERATION_IMPLICATIONS, P as Permission, a as PermissionOperation, b as PermissionRequirement, c as PermissionResource, d as PermissionsContextValue, e as PermissionsRequirementsContextValue, R as RouteConfig, f as RouteHandle, U as UserPolicy, g as buildPermission, p as parsePermission } from './types-CTuDKgPc.cjs';
-import { ComponentType } from 'react';
+import { ComponentType, ReactNode } from 'react';
 
 /**
  * Open registry interfaces. Each panel package ships a generated
@@ -157,10 +157,32 @@ type CustomListExtension = {
         columnOrder?: string[];
     };
 };
+/**
+ * Action ids a plugin can lock per model. `order` narrows to the RMA and payment
+ * actions the order detail sections guard; other models accept any string.
+ */
+interface CustomFieldActionRegistry {
+    order: "edit" | "return" | "exchange" | "claim" | "fulfill" | "capture" | "refund";
+}
+type CustomFieldAction<TModel> = TModel extends keyof CustomFieldActionRegistry ? CustomFieldActionRegistry[TModel] : string;
+type ActivityEntry = {
+    title: ReactNode;
+    timestamp: string | Date;
+    children?: ReactNode;
+};
 interface CustomFieldsConfig<TModel extends CustomFieldModel = CustomFieldModel> {
     model: TModel;
     /** Module link(s) fetched alongside the entity (e.g. `brand`). */
     link?: string | string[];
+    /**
+     * Reasons an action on this entity is unavailable, keyed by action id. A
+     * returned string disables the action and becomes its tooltip; `undefined`
+     * leaves it alone. Evaluated on render with the entity as fetched, including
+     * `link` data.
+     */
+    actionLocks?: Partial<Record<CustomFieldAction<TModel>, (entity: unknown) => string | undefined>>;
+    /** Extra timeline entries for the entity, merged and sorted with the built-ins. */
+    activity?: (entity: unknown) => ActivityEntry[];
     list?: CustomListExtension;
     forms?: CustomFormEntry<TModel>[];
     displays?: CustomDisplayEntry<TModel>[];
@@ -170,4 +192,4 @@ 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 };
+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 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

@@ -1,5 +1,5 @@
 export { B as BuiltMercurConfig, M as MercurConfig, O as OPERATION_IMPLICATIONS, P as Permission, a as PermissionOperation, b as PermissionRequirement, c as PermissionResource, d as PermissionsContextValue, e as PermissionsRequirementsContextValue, R as RouteConfig, f as RouteHandle, U as UserPolicy, g as buildPermission, p as parsePermission } from './types-CTuDKgPc.js';
-import { ComponentType } from 'react';
+import { ComponentType, ReactNode } from 'react';
 
 /**
  * Open registry interfaces. Each panel package ships a generated
@@ -157,10 +157,32 @@ type CustomListExtension = {
         columnOrder?: string[];
     };
 };
+/**
+ * Action ids a plugin can lock per model. `order` narrows to the RMA and payment
+ * actions the order detail sections guard; other models accept any string.
+ */
+interface CustomFieldActionRegistry {
+    order: "edit" | "return" | "exchange" | "claim" | "fulfill" | "capture" | "refund";
+}
+type CustomFieldAction<TModel> = TModel extends keyof CustomFieldActionRegistry ? CustomFieldActionRegistry[TModel] : string;
+type ActivityEntry = {
+    title: ReactNode;
+    timestamp: string | Date;
+    children?: ReactNode;
+};
 interface CustomFieldsConfig<TModel extends CustomFieldModel = CustomFieldModel> {
     model: TModel;
     /** Module link(s) fetched alongside the entity (e.g. `brand`). */
     link?: string | string[];
+    /**
+     * Reasons an action on this entity is unavailable, keyed by action id. A
+     * returned string disables the action and becomes its tooltip; `undefined`
+     * leaves it alone. Evaluated on render with the entity as fetched, including
+     * `link` data.
+     */
+    actionLocks?: Partial<Record<CustomFieldAction<TModel>, (entity: unknown) => string | undefined>>;
+    /** Extra timeline entries for the entity, merged and sorted with the built-ins. */
+    activity?: (entity: unknown) => ActivityEntry[];
     list?: CustomListExtension;
     forms?: CustomFormEntry<TModel>[];
     displays?: CustomDisplayEntry<TModel>[];
@@ -170,4 +192,4 @@ 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 };
+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 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/package.json

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