@netlisian/softconfig 0.1.2 → 0.1.4

package/dist/puck/index.d.ts

@@ -1,10 +1,94 @@
 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 _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;
+    };
+    [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;
+    rootProps?: Record<string, any>;
+    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;
+            rootProps?: Record<string, any>;
+            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 +145,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 +170,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 +179,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 +204,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";
@@ -217,10 +238,13 @@ type RenderFunc<Props extends {
     children: ReactNode;
 }> = (props: Props) => ReactElement;
 type Overrides = {
-    componentNameToKey?: (displayName: string, context: {
+    componentNameToKey?: (displayName: string, context: Partial<BuilderRootConfig> & {
         existingKeys: string[];
         state: "building" | "remodeling" | "ready" | "inspecting";
     }) => string;
+    componentKeyToName?: (key: string) => string;
+    onRemodel?: (key: string) => Record<string, any>;
+    additionalRootFields?: Record<string, Field>;
     map?: RenderFunc<{
         rootProps: BuilderRootConfig;
         toOptions: {
@@ -247,14 +271,19 @@ type Overrides = {
     onActions?: OnActionsCallback;
     name?: Field<string>;
     categories?: Field<string | undefined>;
-    onRootsDataChange?: (data: RootData<AsFieldProps<WithChildren<BuilderRootConfig>>>, params: {
+    resolveRootData?: (props: RootData<AsFieldProps<WithChildren<BuilderRootConfig>>>, params: {
         changed: Partial<Record<keyof BuilderRootConfig, boolean> & {
             id: string;
         }>;
         lastData: RootData<AsFieldProps<WithChildren<BuilderRootConfig>>> | null;
         metadata: Metadata;
         trigger: ResolveDataTrigger;
-    }) => void;
+    }, context: {
+        editingComponent?: string;
+    }) => {
+        props: RootData<AsFieldProps<WithChildren<BuilderRootConfig>>> | Promise<RootData<AsFieldProps<WithChildren<BuilderRootConfig>>>>;
+        readOnly: Readonly<Record<string, boolean>> | undefined;
+    };
 };
 
 type Status = "building" | "remodeling" | "ready" | "inspecting";
@@ -295,6 +324,7 @@ type AppStore = {
     hydrateTransforms: () => void;
     setSoftComponentDefaultVersion: (key: string, version: string) => void;
     removeSoftComponent: (key: string) => void;
+    editingComponent: string | null;
     editingComponentId: string | null;
     editableComponentIds: Set<string>;
     setEditableComponentIds: (ids: Set<string>) => void;
@@ -367,15 +397,32 @@ declare const useBuild: (name?: string) => {
 };
 
 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;
+            rootProps?: Record<string, any>;
+            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$1.Dispatch<React$1.SetStateAction<string | null>>;
+    newComponent: CompletedComponentResult | null;
+    setNewComponent: React$1.Dispatch<React$1.SetStateAction<CompletedComponentResult | null>>;
 };
 
 declare const useCancel: () => {
@@ -383,7 +430,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;