@netlisian/softconfig 0.1.1 → 0.1.3

package/dist/puck/index.d.mts

@@ -1,10 +1,91 @@
 import * as zustand from 'zustand';
 import { StoreApi } from 'zustand';
-import { History, AppState, PuckApi, ComponentData, ComponentConfig, DefaultComponentProps, Field, Config, Fields, RootData, AsFieldProps, WithChildren, Metadata, ResolveDataTrigger, PuckAction, Data } from '@measured/puck';
-import * as react from 'react';
-import react__default, { ReactNode, ReactElement } from 'react';
+import * as _measured_puck from '@measured/puck';
+import { DefaultComponentProps, Field, Config, Fields, History, AppState, PuckApi, ComponentData, ComponentConfig, RootData, AsFieldProps, WithChildren, Metadata, ResolveDataTrigger, PuckAction, Data } from '@measured/puck';
+import * as React$1 from 'react';
+import React__default, { ReactNode, ReactElement } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+type BuilderRootConfig = {
+    _name: string;
+    _category?: string;
+    _version?: string;
+    _versions?: string[];
+    _fields?: {
+        name: string;
+        type: Field["type"];
+    }[];
+    _fieldSettings?: {
+        [key: string]: any;
+    };
+};
+type BuilderComponentConfig = {
+    _slot?: {
+        slot: string;
+    }[];
+    _map?: {
+        to: string | string[];
+        from: string | string[];
+        transform?: (inputs: any[], props: DefaultComponentProps) => any;
+        [key: string]: any;
+    }[];
+    [key: string]: any;
+};
+type BuilderConfig = Config<any, BuilderRootConfig>;
+
+type SoftSubComponent = {
+    type: string;
+    map: BuilderComponentConfig['_map'];
+    components: {
+        [slot: string]: SoftSubComponent;
+    };
+    fixedProps?: DefaultComponentProps;
+    enabledSlots: {
+        slot: string;
+        name?: string;
+    }[];
+}[];
+type SoftComponent = {
+    name: string;
+    category?: string;
+    fields: Fields;
+    fieldSettings?: Record<string, any>;
+    defaultProps: DefaultComponentProps;
+    components: SoftSubComponent;
+    slots: {
+        [slot: string]: DefaultComponentProps;
+    };
+};
+type VersionedSoftComponent = {
+    defaultVersion: string;
+    name: string;
+    category?: string;
+    versions: {
+        [version: string]: {
+            fields: Fields;
+            fieldSettings?: Record<string, any>;
+            defaultProps: DefaultComponentProps;
+            components: SoftSubComponent;
+            slots: {
+                [slot: string]: DefaultComponentProps;
+            };
+        };
+    };
+    /**
+     * Dependencies map: version -> Set of component names this component depends on
+     * Automatically inferred from component structure but can be overridden
+     */
+    dependencies?: {
+        [version: string]: Set<string>;
+    };
+};
+type SoftComponents = Record<string, VersionedSoftComponent>;
+
+type CompletedComponentResult = {
+    id: string;
+    version: string;
+    softComponent: VersionedSoftComponent["versions"][string];
+};
 type BuildersSlice = {
     /**
      * Build a new soft component based on the selected item in history.
@@ -61,7 +142,7 @@ type BuildersSlice = {
      *    - Strip the build settings fields
      *    - Apply modified history to puck data.
      */
-    complete: (appState: AppState<any>, setHistories: PuckApi["history"]["setHistories"], getItemBySelector: PuckApi["getItemBySelector"]) => string;
+    complete: (appState: AppState<any>, setHistories: PuckApi["history"]["setHistories"], getItemBySelector: PuckApi["getItemBySelector"]) => CompletedComponentResult;
     demolish: (componentName: string, data: AppState["data"], puckDispatch: PuckApi["dispatch"]) => void;
     inspect: (componentName: string, puckDispatch: PuckApi["dispatch"]) => void;
     /**
@@ -86,81 +167,6 @@ type BuildersSlice = {
     decompose: (componentData: ComponentData) => ComponentData[];
 };
 
-type BuilderRootConfig = {
-    _name: string;
-    _category?: string;
-    _version?: string;
-    _versions?: string[];
-    _fields?: {
-        name: string;
-        type: Field["type"];
-    }[];
-    _fieldSettings?: {
-        [key: string]: any;
-    };
-};
-type BuilderComponentConfig = {
-    _slot?: {
-        slot: string;
-    }[];
-    _map?: {
-        to: string | string[];
-        from: string | string[];
-        transform?: (inputs: any[], props: DefaultComponentProps) => any;
-        [key: string]: any;
-    }[];
-    [key: string]: any;
-};
-type BuilderConfig = Config<any, BuilderRootConfig>;
-
-type SoftSubComponent = {
-    type: string;
-    map: BuilderComponentConfig['_map'];
-    components: {
-        [slot: string]: SoftSubComponent;
-    };
-    fixedProps?: DefaultComponentProps;
-    enabledSlots: {
-        slot: string;
-        name?: string;
-    }[];
-}[];
-type SoftComponent = {
-    name: string;
-    category?: string;
-    fields: Fields;
-    fieldSettings?: Record<string, any>;
-    defaultProps: DefaultComponentProps;
-    components: SoftSubComponent;
-    slots: {
-        [slot: string]: DefaultComponentProps;
-    };
-};
-type VersionedSoftComponent = {
-    defaultVersion: string;
-    name: string;
-    category?: string;
-    versions: {
-        [version: string]: {
-            fields: Fields;
-            fieldSettings?: Record<string, any>;
-            defaultProps: DefaultComponentProps;
-            components: SoftSubComponent;
-            slots: {
-                [slot: string]: DefaultComponentProps;
-            };
-        };
-    };
-    /**
-     * Dependencies map: version -> Set of component names this component depends on
-     * Automatically inferred from component structure but can be overridden
-     */
-    dependencies?: {
-        [version: string]: Set<string>;
-    };
-};
-type SoftComponents = Record<string, VersionedSoftComponent>;
-
 type ActionEventPayload = {
     type: "build";
     payload: {
@@ -170,11 +176,14 @@ type ActionEventPayload = {
     type: "remodel";
     payload: {
         id: string;
+        version?: string;
+        softComponent?: VersionedSoftComponent["versions"][string];
     };
 } | {
     type: "complete";
     payload: {
         id: string;
+        version: string;
         componentData: Record<string, any>;
         softComponent: VersionedSoftComponent["versions"][string];
     };
@@ -192,10 +201,19 @@ type ActionEventPayload = {
         id: string;
         version: string;
     };
+} | {
+    type: "deleteVersion";
+    payload: {
+        id: string;
+        version: string;
+        migrateToVersion?: string;
+    };
 } | {
     type: "inspect";
     payload: {
         id: string;
+        version?: string;
+        softComponent?: VersionedSoftComponent["versions"][string];
     };
 } | {
     type: "decompose";
@@ -361,21 +379,37 @@ declare const SoftConfigProvider: ({ children, hardConfig, softComponents, overr
 declare const createUseSoftConfig: () => <T>(selector: (state: AppStore) => T, equalityFn?: (a: T, b: T) => boolean) => T;
 declare const useSoftConfig: <T>(selector: (state: AppStore) => T, equalityFn?: (a: T, b: T) => boolean) => T;
 
-declare const useBuild: () => {
+declare const useBuild: (name?: string) => {
     handleBuild: () => void;
     canBuild: boolean;
 };
 
 declare const useRemodel: () => {
-    handleRemodel: (componentName?: string) => void;
+    handleRemodel: (componentName?: string) => {
+        id: string;
+        version: string;
+        softComponent: {
+            fields: _measured_puck.Fields;
+            fieldSettings?: Record<string, any>;
+            defaultProps: DefaultComponentProps;
+            components: SoftSubComponent;
+            slots: {
+                [slot: string]: DefaultComponentProps;
+            };
+        };
+    } | {
+        id: string;
+        version: string;
+        softComponent?: undefined;
+    } | null;
     canRemodel: (componentName?: string) => boolean;
 };
 
 declare const useComplete: () => {
-    handleComplete: () => string | null;
+    handleComplete: () => CompletedComponentResult | null;
     canComplete: boolean;
-    newComponent: string | null;
-    setNewComponent: react.Dispatch<react.SetStateAction<string | null>>;
+    newComponent: CompletedComponentResult | null;
+    setNewComponent: React$1.Dispatch<React$1.SetStateAction<CompletedComponentResult | null>>;
 };
 
 declare const useCancel: () => {
@@ -383,7 +417,7 @@ declare const useCancel: () => {
     canCancel: boolean;
 };
 
-declare const useInspect: (componentName: string | null) => void;
+declare const useInspect: (component: CompletedComponentResult | null) => void;
 
 declare const useDecompose: () => {
     handleDecompose: (componentData?: ComponentData) => void;
@@ -404,20 +438,42 @@ declare const useSetDefaultVersion: () => {
 
 declare const Header: ({ onPublish, children, }: {
     onPublish?: (data: Data, softComponents: SoftComponents) => void;
-    children: react__default.ReactNode;
+    children: React__default.ReactNode;
 }) => react_jsx_runtime.JSX.Element;
 
 declare const ActionBarOverride: (props: {
     label?: string;
-    parentAction?: react__default.ReactNode;
-    children?: react__default.ReactNode;
+    parentAction?: React__default.ReactNode;
+    children?: React__default.ReactNode;
 }) => react_jsx_runtime.JSX.Element;
 
+declare const DrawerItem: (props: {
+    name: string;
+    children: React.ReactNode;
+}) => React.ReactElement;
+/** @deprecated Use DrawerItem instead */
 declare const ComponentItem: (props: {
     name: string;
     children: React.ReactNode;
 }) => React.ReactElement;
 
+/**
+ * Drawer — custom drawer override for the Puck editor.
+ *
+ * Reads config.categories from puck and renders a collapsible section per
+ * category, each containing a PuckDrawer with DrawerItem as the item
+ * renderer (soft-config versioning, demolish, and settings modal included).
+ * Components not assigned to any category render under "Other components".
+ *
+ * Falls back to a flat list when no categories are defined.
+ *
+ * Usage:
+ *   overrides={{ drawer: Drawer }}
+ */
+declare const Drawer: (_props: {
+    children?: React__default.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
 type NotificationHandler = (message: string, type: "error" | "success") => void;
 declare const setNotificationHandler: (handler: NotificationHandler) => void;
 declare const notify: {
@@ -472,4 +528,4 @@ declare const Modal: ({ children, onClose, isOpen, }: {
     isOpen: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { ActionBarOverride as ActionBar, type ActionEventPayload, type AppStore, type AppStoreApi, type BuilderComponentConfig, type BuilderConfig, type BuilderRootConfig, ComponentItem, Header, Modal, type OnActionsCallback, type Overrides, type SoftComponent, type SoftComponents, SoftConfigProvider, type VersionedSoftComponent, confirm, createActionCallback, createSoftConfigStore, createUseSoftConfig, notify, resolveSoftConfig, setConfirmHandler, setNotificationHandler, useBuild, useCancel, useComplete, useDecompose, useDemolish, useInspect, useRemodel, useSetDefaultVersion, useSoftConfig };
+export { ActionBarOverride as ActionBar, type ActionEventPayload, type AppStore, type AppStoreApi, type BuilderComponentConfig, type BuilderConfig, type BuilderRootConfig, ComponentItem, Drawer as ComponentList, Drawer, DrawerItem, Header, Modal, type OnActionsCallback, type Overrides, type SoftComponent, type SoftComponents, SoftConfigProvider, type VersionedSoftComponent, confirm, createActionCallback, createSoftConfigStore, createUseSoftConfig, notify, resolveSoftConfig, setConfirmHandler, setNotificationHandler, useBuild, useCancel, useComplete, useDecompose, useDemolish, useInspect, useRemodel, useSetDefaultVersion, useSoftConfig };

package/dist/puck/index.d.ts

@@ -1,10 +1,91 @@
 import * as zustand from 'zustand';
 import { StoreApi } from 'zustand';
-import { History, AppState, PuckApi, ComponentData, ComponentConfig, DefaultComponentProps, Field, Config, Fields, RootData, AsFieldProps, WithChildren, Metadata, ResolveDataTrigger, PuckAction, Data } from '@measured/puck';
-import * as react from 'react';
-import react__default, { ReactNode, ReactElement } from 'react';
+import * as _measured_puck from '@measured/puck';
+import { DefaultComponentProps, Field, Config, Fields, History, AppState, PuckApi, ComponentData, ComponentConfig, RootData, AsFieldProps, WithChildren, Metadata, ResolveDataTrigger, PuckAction, Data } from '@measured/puck';
+import * as React$1 from 'react';
+import React__default, { ReactNode, ReactElement } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+type BuilderRootConfig = {
+    _name: string;
+    _category?: string;
+    _version?: string;
+    _versions?: string[];
+    _fields?: {
+        name: string;
+        type: Field["type"];
+    }[];
+    _fieldSettings?: {
+        [key: string]: any;
+    };
+};
+type BuilderComponentConfig = {
+    _slot?: {
+        slot: string;
+    }[];
+    _map?: {
+        to: string | string[];
+        from: string | string[];
+        transform?: (inputs: any[], props: DefaultComponentProps) => any;
+        [key: string]: any;
+    }[];
+    [key: string]: any;
+};
+type BuilderConfig = Config<any, BuilderRootConfig>;
+
+type SoftSubComponent = {
+    type: string;
+    map: BuilderComponentConfig['_map'];
+    components: {
+        [slot: string]: SoftSubComponent;
+    };
+    fixedProps?: DefaultComponentProps;
+    enabledSlots: {
+        slot: string;
+        name?: string;
+    }[];
+}[];
+type SoftComponent = {
+    name: string;
+    category?: string;
+    fields: Fields;
+    fieldSettings?: Record<string, any>;
+    defaultProps: DefaultComponentProps;
+    components: SoftSubComponent;
+    slots: {
+        [slot: string]: DefaultComponentProps;
+    };
+};
+type VersionedSoftComponent = {
+    defaultVersion: string;
+    name: string;
+    category?: string;
+    versions: {
+        [version: string]: {
+            fields: Fields;
+            fieldSettings?: Record<string, any>;
+            defaultProps: DefaultComponentProps;
+            components: SoftSubComponent;
+            slots: {
+                [slot: string]: DefaultComponentProps;
+            };
+        };
+    };
+    /**
+     * Dependencies map: version -> Set of component names this component depends on
+     * Automatically inferred from component structure but can be overridden
+     */
+    dependencies?: {
+        [version: string]: Set<string>;
+    };
+};
+type SoftComponents = Record<string, VersionedSoftComponent>;
+
+type CompletedComponentResult = {
+    id: string;
+    version: string;
+    softComponent: VersionedSoftComponent["versions"][string];
+};
 type BuildersSlice = {
     /**
      * Build a new soft component based on the selected item in history.
@@ -61,7 +142,7 @@ type BuildersSlice = {
      *    - Strip the build settings fields
      *    - Apply modified history to puck data.
      */
-    complete: (appState: AppState<any>, setHistories: PuckApi["history"]["setHistories"], getItemBySelector: PuckApi["getItemBySelector"]) => string;
+    complete: (appState: AppState<any>, setHistories: PuckApi["history"]["setHistories"], getItemBySelector: PuckApi["getItemBySelector"]) => CompletedComponentResult;
     demolish: (componentName: string, data: AppState["data"], puckDispatch: PuckApi["dispatch"]) => void;
     inspect: (componentName: string, puckDispatch: PuckApi["dispatch"]) => void;
     /**
@@ -86,81 +167,6 @@ type BuildersSlice = {
     decompose: (componentData: ComponentData) => ComponentData[];
 };
 
-type BuilderRootConfig = {
-    _name: string;
-    _category?: string;
-    _version?: string;
-    _versions?: string[];
-    _fields?: {
-        name: string;
-        type: Field["type"];
-    }[];
-    _fieldSettings?: {
-        [key: string]: any;
-    };
-};
-type BuilderComponentConfig = {
-    _slot?: {
-        slot: string;
-    }[];
-    _map?: {
-        to: string | string[];
-        from: string | string[];
-        transform?: (inputs: any[], props: DefaultComponentProps) => any;
-        [key: string]: any;
-    }[];
-    [key: string]: any;
-};
-type BuilderConfig = Config<any, BuilderRootConfig>;
-
-type SoftSubComponent = {
-    type: string;
-    map: BuilderComponentConfig['_map'];
-    components: {
-        [slot: string]: SoftSubComponent;
-    };
-    fixedProps?: DefaultComponentProps;
-    enabledSlots: {
-        slot: string;
-        name?: string;
-    }[];
-}[];
-type SoftComponent = {
-    name: string;
-    category?: string;
-    fields: Fields;
-    fieldSettings?: Record<string, any>;
-    defaultProps: DefaultComponentProps;
-    components: SoftSubComponent;
-    slots: {
-        [slot: string]: DefaultComponentProps;
-    };
-};
-type VersionedSoftComponent = {
-    defaultVersion: string;
-    name: string;
-    category?: string;
-    versions: {
-        [version: string]: {
-            fields: Fields;
-            fieldSettings?: Record<string, any>;
-            defaultProps: DefaultComponentProps;
-            components: SoftSubComponent;
-            slots: {
-                [slot: string]: DefaultComponentProps;
-            };
-        };
-    };
-    /**
-     * Dependencies map: version -> Set of component names this component depends on
-     * Automatically inferred from component structure but can be overridden
-     */
-    dependencies?: {
-        [version: string]: Set<string>;
-    };
-};
-type SoftComponents = Record<string, VersionedSoftComponent>;
-
 type ActionEventPayload = {
     type: "build";
     payload: {
@@ -170,11 +176,14 @@ type ActionEventPayload = {
     type: "remodel";
     payload: {
         id: string;
+        version?: string;
+        softComponent?: VersionedSoftComponent["versions"][string];
     };
 } | {
     type: "complete";
     payload: {
         id: string;
+        version: string;
         componentData: Record<string, any>;
         softComponent: VersionedSoftComponent["versions"][string];
     };
@@ -192,10 +201,19 @@ type ActionEventPayload = {
         id: string;
         version: string;
     };
+} | {
+    type: "deleteVersion";
+    payload: {
+        id: string;
+        version: string;
+        migrateToVersion?: string;
+    };
 } | {
     type: "inspect";
     payload: {
         id: string;
+        version?: string;
+        softComponent?: VersionedSoftComponent["versions"][string];
     };
 } | {
     type: "decompose";
@@ -361,21 +379,37 @@ declare const SoftConfigProvider: ({ children, hardConfig, softComponents, overr
 declare const createUseSoftConfig: () => <T>(selector: (state: AppStore) => T, equalityFn?: (a: T, b: T) => boolean) => T;
 declare const useSoftConfig: <T>(selector: (state: AppStore) => T, equalityFn?: (a: T, b: T) => boolean) => T;
 
-declare const useBuild: () => {
+declare const useBuild: (name?: string) => {
     handleBuild: () => void;
     canBuild: boolean;
 };
 
 declare const useRemodel: () => {
-    handleRemodel: (componentName?: string) => void;
+    handleRemodel: (componentName?: string) => {
+        id: string;
+        version: string;
+        softComponent: {
+            fields: _measured_puck.Fields;
+            fieldSettings?: Record<string, any>;
+            defaultProps: DefaultComponentProps;
+            components: SoftSubComponent;
+            slots: {
+                [slot: string]: DefaultComponentProps;
+            };
+        };
+    } | {
+        id: string;
+        version: string;
+        softComponent?: undefined;
+    } | null;
     canRemodel: (componentName?: string) => boolean;
 };
 
 declare const useComplete: () => {
-    handleComplete: () => string | null;
+    handleComplete: () => CompletedComponentResult | null;
     canComplete: boolean;
-    newComponent: string | null;
-    setNewComponent: react.Dispatch<react.SetStateAction<string | null>>;
+    newComponent: CompletedComponentResult | null;
+    setNewComponent: React$1.Dispatch<React$1.SetStateAction<CompletedComponentResult | null>>;
 };
 
 declare const useCancel: () => {
@@ -383,7 +417,7 @@ declare const useCancel: () => {
     canCancel: boolean;
 };
 
-declare const useInspect: (componentName: string | null) => void;
+declare const useInspect: (component: CompletedComponentResult | null) => void;
 
 declare const useDecompose: () => {
     handleDecompose: (componentData?: ComponentData) => void;
@@ -404,20 +438,42 @@ declare const useSetDefaultVersion: () => {
 
 declare const Header: ({ onPublish, children, }: {
     onPublish?: (data: Data, softComponents: SoftComponents) => void;
-    children: react__default.ReactNode;
+    children: React__default.ReactNode;
 }) => react_jsx_runtime.JSX.Element;
 
 declare const ActionBarOverride: (props: {
     label?: string;
-    parentAction?: react__default.ReactNode;
-    children?: react__default.ReactNode;
+    parentAction?: React__default.ReactNode;
+    children?: React__default.ReactNode;
 }) => react_jsx_runtime.JSX.Element;
 
+declare const DrawerItem: (props: {
+    name: string;
+    children: React.ReactNode;
+}) => React.ReactElement;
+/** @deprecated Use DrawerItem instead */
 declare const ComponentItem: (props: {
     name: string;
     children: React.ReactNode;
 }) => React.ReactElement;
 
+/**
+ * Drawer — custom drawer override for the Puck editor.
+ *
+ * Reads config.categories from puck and renders a collapsible section per
+ * category, each containing a PuckDrawer with DrawerItem as the item
+ * renderer (soft-config versioning, demolish, and settings modal included).
+ * Components not assigned to any category render under "Other components".
+ *
+ * Falls back to a flat list when no categories are defined.
+ *
+ * Usage:
+ *   overrides={{ drawer: Drawer }}
+ */
+declare const Drawer: (_props: {
+    children?: React__default.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
 type NotificationHandler = (message: string, type: "error" | "success") => void;
 declare const setNotificationHandler: (handler: NotificationHandler) => void;
 declare const notify: {
@@ -472,4 +528,4 @@ declare const Modal: ({ children, onClose, isOpen, }: {
     isOpen: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { ActionBarOverride as ActionBar, type ActionEventPayload, type AppStore, type AppStoreApi, type BuilderComponentConfig, type BuilderConfig, type BuilderRootConfig, ComponentItem, Header, Modal, type OnActionsCallback, type Overrides, type SoftComponent, type SoftComponents, SoftConfigProvider, type VersionedSoftComponent, confirm, createActionCallback, createSoftConfigStore, createUseSoftConfig, notify, resolveSoftConfig, setConfirmHandler, setNotificationHandler, useBuild, useCancel, useComplete, useDecompose, useDemolish, useInspect, useRemodel, useSetDefaultVersion, useSoftConfig };
+export { ActionBarOverride as ActionBar, type ActionEventPayload, type AppStore, type AppStoreApi, type BuilderComponentConfig, type BuilderConfig, type BuilderRootConfig, ComponentItem, Drawer as ComponentList, Drawer, DrawerItem, Header, Modal, type OnActionsCallback, type Overrides, type SoftComponent, type SoftComponents, SoftConfigProvider, type VersionedSoftComponent, confirm, createActionCallback, createSoftConfigStore, createUseSoftConfig, notify, resolveSoftConfig, setConfirmHandler, setNotificationHandler, useBuild, useCancel, useComplete, useDecompose, useDemolish, useInspect, useRemodel, useSetDefaultVersion, useSoftConfig };