@netlisian/softconfig 0.0.11 → 0.1.1

package/dist/puck/index.d.ts

@@ -1,6 +1,6 @@
 import * as zustand from 'zustand';
 import { StoreApi } from 'zustand';
-import { History, AppState, PuckApi, ComponentConfig, ComponentData, DefaultComponentProps, Field, Config, Fields, Data } from '@measured/puck';
+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 react_jsx_runtime from 'react/jsx-runtime';
@@ -21,7 +21,7 @@ type BuildersSlice = {
     build: (history: History<AppState>[], selectedItem: PuckApi["selectedItem"], itemSelector: {
         index: number;
         zone?: string;
-    } | null, puckDispatch: PuckApi["dispatch"]) => void | null;
+    } | null, puckDispatch: PuckApi["dispatch"], name?: string) => void | null;
     /**
      * Remodel the selected soft component by decomposing it and resetting as root.
      *
@@ -38,7 +38,7 @@ type BuildersSlice = {
     remodel: (history: History<AppState>[], selectedItem: PuckApi["selectedItem"], itemSelector: {
         index: number;
         zone?: string;
-    } | null, puckDispatch: PuckApi["dispatch"]) => void;
+    } | null, puckDispatch: PuckApi["dispatch"], refreshPermission: () => void) => void;
     /**
      * Switch to a different version of the soft component being remodeled.
      *
@@ -61,7 +61,7 @@ type BuildersSlice = {
      *    - Strip the build settings fields
      *    - Apply modified history to puck data.
      */
-    complete: (appState: AppState<any>, setHistories: PuckApi["history"]["setHistories"]) => string;
+    complete: (appState: AppState<any>, setHistories: PuckApi["history"]["setHistories"], getItemBySelector: PuckApi["getItemBySelector"]) => string;
     demolish: (componentName: string, data: AppState["data"], puckDispatch: PuckApi["dispatch"]) => void;
     inspect: (componentName: string, puckDispatch: PuckApi["dispatch"]) => void;
     /**
@@ -77,7 +77,7 @@ type BuildersSlice = {
     /** Compose multiple components into a soft component.
      * 1. SoftComponent: Get soft fields + default values from the appState.root + sub-component maps + fixedProps
      */
-    compose: (appState: AppState, componentName: string) => [ComponentConfig, string] | undefined;
+    compose: (appState: AppState, componentName: string, editedItem: ComponentData, displayName: string, category?: string) => [ComponentConfig, string] | undefined;
     /** Break down a composed component into its parts.
      * 1. Get softComponentProps
      * 2. Create a virtual component with all the props from soft-component.
@@ -88,6 +88,7 @@ type BuildersSlice = {
 
 type BuilderRootConfig = {
     _name: string;
+    _category?: string;
     _version?: string;
     _versions?: string[];
     _fields?: {
@@ -125,6 +126,8 @@ type SoftSubComponent = {
     }[];
 }[];
 type SoftComponent = {
+    name: string;
+    category?: string;
     fields: Fields;
     fieldSettings?: Record<string, any>;
     defaultProps: DefaultComponentProps;
@@ -135,6 +138,8 @@ type SoftComponent = {
 };
 type VersionedSoftComponent = {
     defaultVersion: string;
+    name: string;
+    category?: string;
     versions: {
         [version: string]: {
             fields: Fields;
@@ -146,6 +151,13 @@ type VersionedSoftComponent = {
             };
         };
     };
+    /**
+     * 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>;
 
@@ -163,8 +175,8 @@ type ActionEventPayload = {
     type: "complete";
     payload: {
         id: string;
-        componentData: DefaultComponentProps;
-        softComponent: SoftComponent;
+        componentData: Record<string, any>;
+        softComponent: VersionedSoftComponent["versions"][string];
     };
 } | {
     type: "cancel";
@@ -205,6 +217,10 @@ type RenderFunc<Props extends {
     children: ReactNode;
 }> = (props: Props) => ReactElement;
 type Overrides = {
+    componentNameToKey?: (displayName: string, context: {
+        existingKeys: string[];
+        state: "building" | "remodeling" | "ready" | "inspecting";
+    }) => string;
     map?: RenderFunc<{
         rootProps: BuilderRootConfig;
         toOptions: {
@@ -229,6 +245,16 @@ type Overrides = {
         softComponent: VersionedSoftComponent["versions"][string];
     }) => ((inputs: any[], props: DefaultComponentProps) => any) | undefined;
     onActions?: OnActionsCallback;
+    name?: Field<string>;
+    categories?: Field<string | undefined>;
+    onRootsDataChange?: (data: RootData<AsFieldProps<WithChildren<BuilderRootConfig>>>, params: {
+        changed: Partial<Record<keyof BuilderRootConfig, boolean> & {
+            id: string;
+        }>;
+        lastData: RootData<AsFieldProps<WithChildren<BuilderRootConfig>>> | null;
+        metadata: Metadata;
+        trigger: ResolveDataTrigger;
+    }) => void;
 };
 
 type Status = "building" | "remodeling" | "ready" | "inspecting";
@@ -269,9 +295,50 @@ type AppStore = {
     hydrateTransforms: () => void;
     setSoftComponentDefaultVersion: (key: string, version: string) => void;
     removeSoftComponent: (key: string) => void;
+    editingComponentId: string | null;
+    editableComponentIds: Set<string>;
+    setEditableComponentIds: (ids: Set<string>) => void;
+    addEditableComponentId: (id: string) => void;
+    clearEditingState: () => void;
+    /**
+     * Reverse dependency graph: componentName -> Set of components that depend on it
+     * Used to efficiently rebuild dependent components when a soft component is updated
+     */
+    dependencyGraph: Map<string, Set<string>>;
+    /**
+     * Rebuild all dependent components after a soft component is updated
+     * Only rebuilds components that depend on the changed component
+     *
+     * @param componentName - The component that was updated
+     * @param version - The version that was updated
+     */
+    rebuildDependents: (componentName: string, version: string) => void;
+    /**
+     * Iframe document reference for applying styling and edit visibility
+     * Stored as a mutable ref to avoid triggering store updates.
+     */
+    iframeDocRef: {
+        current: Document | null;
+    };
+    /**
+     * Get the current iframe document reference
+     */
+    getIframeDoc: () => Document | null;
+    /**
+     * Set the iframe document reference without causing re-renders
+     */
+    setIframeDoc: (doc: Document | null) => void;
+    /**
+     * Flag to control visibility of version config fields
+     */
+    showVersionFields: boolean;
+    /**
+     * Toggle the visibility of version config fields
+     */
+    setShowVersionFields: (show: boolean) => void;
 };
 type AppStoreApi = StoreApi<AppStore>;
-declare const createSoftConfigStore: (hardConfig?: Config, softComponents?: SoftComponents, overrides?: Overrides, onActions?: OnActionsCallback) => zustand.UseBoundStore<Omit<Omit<StoreApi<AppStore>, "subscribe"> & {
+declare const createSoftConfigStore: (hardConfig?: Config, softComponents?: SoftComponents, overrides?: Overrides, onActions?: OnActionsCallback, showVersionFields?: boolean) => zustand.UseBoundStore<Omit<StoreApi<AppStore>, "subscribe"> & {
     subscribe: {
         (listener: (selectedState: AppStore, previousSelectedState: AppStore) => void): () => void;
         <U>(selector: (state: AppStore) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
@@ -279,35 +346,20 @@ declare const createSoftConfigStore: (hardConfig?: Config, softComponents?: Soft
             fireImmediately?: boolean;
         } | undefined): () => void;
     };
-}, "setState" | "devtools"> & {
-    setState(partial: AppStore | Partial<AppStore> | ((state: AppStore) => AppStore | Partial<AppStore>), replace?: false | undefined, action?: (string | {
-        [x: string]: unknown;
-        [x: number]: unknown;
-        [x: symbol]: unknown;
-        type: string;
-    }) | undefined): void;
-    setState(state: AppStore | ((state: AppStore) => AppStore), replace: true, action?: (string | {
-        [x: string]: unknown;
-        [x: number]: unknown;
-        [x: symbol]: unknown;
-        type: string;
-    }) | undefined): void;
-    devtools: {
-        cleanup: () => void;
-    };
 }>;
 
-declare const SoftConfigProvider: ({ children, hardConfig, softComponents, overrides, value, onActions, }: {
-    children: (softConfig: Config, softComponents: SoftComponents) => ReactNode;
+declare const SoftConfigProvider: ({ children, hardConfig, softComponents, overrides, value, onActions, useVersioning, }: {
+    children: (softConfig: Config, softComponents: SoftComponents, iframeDoc: AppStore["setIframeDoc"], validateAction: (action: PuckAction) => boolean) => ReactNode;
     hardConfig: Config;
     softComponents: SoftComponents;
-    overrides: Overrides;
+    overrides?: Overrides;
     value?: StoreApi<AppStore>;
     onActions?: OnActionsCallback;
+    useVersioning?: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-declare const createUseSoftConfig: () => <T>(selector: (state: AppStore) => T) => T;
-declare const useSoftConfig: <T>(selector: (state: AppStore) => T) => T;
+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: () => {
     handleBuild: () => void;
@@ -386,6 +438,15 @@ declare const setConfirmHandler: (handler: ConfirmHandler) => void;
  */
 declare const confirm: (message: string) => Promise<boolean>;
 
+/**
+ * Create an action callback that validates and handles actions with undo support
+ *
+ * @param validateAction Function to validate if an action is allowed
+ * @param undo Function to undo the last action (from Puck's history)
+ * @returns Action handler function
+ */
+declare const createActionCallback: (validateAction: (action: PuckAction) => boolean, undo: PuckApi["history"]["back"]) => (action: PuckAction) => void;
+
 /**
  * Resolves soft components in data by dissolving them to hard components only.
  *
@@ -411,4 +472,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, 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, 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 };