@timeax/form-palette 0.0.27 → 0.0.29

package/dist/index.d.mts

@@ -3357,6 +3357,289 @@ interface ShadcnEditorVariantProps extends Pick<VariantBaseProps<string | undefi
     className?: string;
 }
 
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+type JsonObject = Record<string, JsonValue>;
+type JsonPath = string;
+type JsonWildcard = string;
+
+/**
+ * A "variant spec" can be:
+ * - a plain VariantKey ("text", "number", "toggle", ...)
+ * - a variant key + props to pass into that variant
+ */
+type JsonEditorVariantSpec = VariantKey | {
+    variant: VariantKey;
+    props?: VariantPropsFor<any>;
+};
+/**
+ * Map a key-path (or wildcard) to a variant spec.
+ *
+ * Keys are matched against:
+ * - full path:  "config.apiEndpoint"
+ * - leaf key:   "apiEndpoint"
+ *
+ * Wild examples:
+ * - "*api*"             (segment contains "api")
+ * - "config.*"          (direct children)
+ * - "config.**"         (subtree)
+ * - "**.*token*"        (any route/leaf)
+ */
+type JsonEditorFieldMap = Record<JsonWildcard, JsonEditorVariantSpec>;
+/**
+ * Layout is scoped to a "page" (object route path).
+ *
+ * Each entry is a "row":
+ * - string: render a single field row
+ * - string[]: render these fields side-by-side (grid row)
+ *
+ * Example:
+ * layout: {
+ *   "": [["projectName","version"], "description"],
+ *   "config": [["maxEntries","apiEndpoint"], "retry"]
+ * }
+ */
+type JsonEditorLayoutRow = string | string[];
+type JsonEditorLayoutMap = Record<JsonWildcard, JsonEditorLayoutRow[]>;
+interface JsonEditorFilters {
+    /** Hide entire object routes/pages (navigation + rendering) */
+    excludeRoutes?: JsonWildcard[];
+    includeRoutes?: JsonWildcard[];
+    /** Hide specific fields (by full path or leaf/wild patterns) */
+    excludeFields?: JsonWildcard[];
+    includeFields?: JsonWildcard[];
+    /**
+     * If true, excluding "config" also excludes "config.**".
+     * Default: true
+     */
+    excludeRouteSubtree?: boolean;
+}
+/**
+ * Default value for a newly created key (or a new array item).
+ * Can be a constant JsonValue, or a function.
+ */
+type JsonEditorDefaultValueSpec = JsonValue | ((ctx: {
+    parentPath: JsonPath;
+    key: string;
+    current: JsonValue | undefined;
+}) => JsonValue);
+interface JsonEditorDefaults {
+    /**
+     * When adding a new array item, you can pick from allowed variants.
+     * You can pass VariantKey or a {variant, props} spec.
+     */
+    array?: JsonEditorVariantSpec[];
+    /**
+     * Optional default values for new keys.
+     * Keyed by wildcard path (full path / leaf / patterns).
+     */
+    values?: Record<JsonWildcard, JsonEditorDefaultValueSpec>;
+}
+type JsonEditorNavMode = "sidebar" | "tabs" | "drawer";
+interface JsonEditorNavOptions {
+    mode?: JsonEditorNavMode;
+    /** Show root "" as a page in navigation. Default: true */
+    showRoot?: boolean;
+    /** Initial active route/page. Default: "" */
+    defaultRoute?: JsonPath;
+    /** Optional label overrides for route nodes */
+    routeLabels?: Record<JsonWildcard, React.ReactNode>;
+    /** Max object nesting to generate routes for. Optional safety */
+    maxDepth?: number;
+    /**
+     * Whether arrays containing objects can contribute routes.
+     * - "none": arrays never create routes (default)
+     * - "objects": array items that are objects become routes like "config.items.0"
+     */
+    arrayRoutes?: "none" | "objects";
+}
+interface JsonRouteNode {
+    path: JsonPath;
+    key: string;
+    label: React.ReactNode;
+    children: JsonRouteNode[];
+}
+type JsonEditorViewMode = "split" | "visual" | "raw";
+interface JsonEditorPermissions {
+    canAdd?: boolean;
+    canDelete?: boolean;
+    canViewRaw?: boolean;
+    canEditRaw?: boolean;
+    /**
+     * Keys/paths in this shape cannot be deleted even if canDelete is true.
+     * (treated as "locked")
+     */
+    defaultShape?: JsonObject;
+    /**
+     * Optional finer-grain locks by wildcard.
+     * If true, this key/path cannot be added/deleted/edited.
+     */
+    lockPaths?: JsonWildcard[];
+}
+type JsonEditorEditAction = "add" | "delete" | "edit" | "edit-raw";
+interface JsonEditorEditMeta {
+    action: JsonEditorEditAction;
+    /** the page (object route) currently being edited */
+    route: JsonPath;
+    /** the exact key path being changed (field path) */
+    path: JsonPath;
+    /** parent object path of the key */
+    parent: JsonPath;
+    /** leaf key (segment) */
+    key: string;
+}
+interface JsonEditorCallbacks {
+    onAdd?: (nextRoot: JsonObject, meta: JsonEditorEditMeta) => void;
+    onDelete?: (nextRoot: JsonObject, meta: JsonEditorEditMeta) => void;
+    onEdit?: (nextRoot: JsonObject, meta: JsonEditorEditMeta) => void;
+}
+interface JsonEditorResolvedField {
+    path: JsonPath;
+    key: string;
+    value: JsonValue;
+    valueType: "string" | "number" | "boolean" | "null" | "object" | "array";
+    variant?: JsonEditorVariantSpec;
+    hidden?: boolean;
+}
+/**
+ * This is the "shared" props contract for the JSON editor variant UI.
+ *
+ * NOTE:
+ * - `title` is purely UI (header text)
+ * - `schema` is NOT a title — it’s a schema id/key for validation (later use)
+ */
+interface ShadcnJsonEditorVariantProps extends Pick<VariantBaseProps<JsonObject | undefined>, "value" | "onValue" | "error" | "disabled" | "readOnly"> {
+    /** Header title (UI only) */
+    title?: React.ReactNode;
+    /** Optional schema id/key or raw JSON Schema object for validation */
+    schema?: string | JsonObject;
+    /** Primary config */
+    fieldMap?: JsonEditorFieldMap;
+    layout?: JsonEditorLayoutMap;
+    defaults?: JsonEditorDefaults;
+    /** Navigation derived from JSON structure */
+    nav?: JsonEditorNavOptions;
+    /** include/exclude for routes + fields */
+    filters?: JsonEditorFilters;
+    /** permissions + locks */
+    permissions?: JsonEditorPermissions;
+    /** callbacks */
+    callbacks?: JsonEditorCallbacks;
+    /**
+     * Page rendering mode:
+     * - "accordion": page sections expand/collapse in main panel
+     * - "popover": nested objects open as overlays (optional UX)
+     */
+    mode?: "accordion" | "popover";
+    /**
+     * Routing:
+     * - route: controlled current page
+     * - defaultRoute: uncontrolled initial page (overrides nav.defaultRoute)
+     * - onRouteChange: called whenever the editor navigates
+     */
+    route?: JsonPath;
+    defaultRoute?: JsonPath;
+    onRouteChange?: (route: JsonPath) => void;
+    /**
+     * View mode (top toggle):
+     * - "split": raw sidebar + visual editor (default)
+     * - "visual": visual editor only
+     * - "raw": raw editor only
+     *
+     * If viewMode is provided, it is controlled.
+     * Otherwise, the defaultViewMode seeds the internal state.
+     */
+    viewMode?: JsonEditorViewMode;
+    defaultViewMode?: JsonEditorViewMode;
+    onViewModeChange?: (mode: JsonEditorViewMode) => void;
+    /** Close button intent (optional). Actual close UI is controlled by the wrapper (index.tsx). */
+    onClose?: () => void;
+    /** Visual (editor-level styling) */
+    className?: string;
+    contentClassName?: string;
+    navClassName?: string;
+    /**
+     * Optional hooks to customize nav + page rendering.
+     */
+    renderRouteLabel?: (ctx: {
+        node: JsonRouteNode;
+        active: boolean;
+    }) => React.ReactNode;
+    renderField?: (ctx: {
+        field: JsonEditorResolvedField;
+        route: JsonPath;
+    }) => React.ReactNode;
+}
+/**
+ * Wrapper mode:
+ * - "popover": show trigger + popover
+ * - "accordion": inline panel that can expand/collapse
+ */
+type JsonEditorMode = "popover" | "accordion";
+/**
+ * Typed to match your shadcn button variants/sizes.
+ * If your project differs, change these unions here once.
+ */
+type JsonEditorTriggerVariant = "default" | "destructive" | "outline" | "secondary" | "ghost" | "link";
+type JsonEditorTriggerSize = "default" | "sm" | "lg" | "icon";
+/**
+ * Standalone wiring:
+ * - caller provides root/onRoot directly
+ */
+type JsonEditorStandaloneWiring = {
+    root: JsonObject;
+    onRoot: (nextRoot: JsonObject, detail?: any) => void;
+    value?: never;
+    onValue?: never;
+};
+/**
+ * Variant wiring:
+ * - InputField variant uses value/onValue
+ */
+type JsonEditorVariantWiring = Pick<VariantBaseProps<JsonObject | undefined>, "value" | "onValue" | "disabled" | "readOnly" | "error" | "size" | "density"> & {
+    root?: never;
+    onRoot?: never;
+};
+/**
+ * Props for the exported component (index.tsx):
+ * - accepts standalone OR variant wiring
+ * - wrapper owns mode/open/trigger UI
+ * - editor-specific props are passed through, without redefining a second type list
+ *
+ * IMPORTANT:
+ * - wrapper uses `wrapperClassName` (outer container)
+ * - editor uses `className` (inner editor surface)
+ */
+interface JsonEditorWrapperProps {
+    /** Wrapper mode (popover vs accordion). */
+    mode?: JsonEditorMode;
+    /** Trigger UI (popover mode) */
+    triggerLabel?: React.ReactNode;
+    triggerVariant?: JsonEditorTriggerVariant;
+    triggerSize?: JsonEditorTriggerSize;
+    /** Popover sizing/skin */
+    popoverClassName?: string;
+    /** Inline/accordion container class */
+    panelClassName?: string;
+    /** Outer wrapper class */
+    wrapperClassName?: string;
+    /** Optional: controlled popover open state */
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    /** Accessibility (useful when rendered as an InputField variant) */
+    id?: string;
+    describedBy?: string;
+    /** Called when the wrapper closes (popover close / accordion hide). */
+    onClose?: () => void;
+}
+/**
+ * Single source of truth for what index.tsx accepts:
+ * - (standalone OR variant wiring)
+ * - wrapper props
+ * - editor props (minus a few keys owned by wrapper)
+ */
+type ShadcnJsonEditorProps = (JsonEditorStandaloneWiring | JsonEditorVariantWiring) & JsonEditorWrapperProps & Omit<ShadcnJsonEditorVariantProps, "onValue" | "value" | "disabled" | "readOnly" | "error" | "size" | "density" | "onClose">;
+
 /**
  * Helper type for a single variant registry entry.
  *
@@ -3412,6 +3695,7 @@ interface Variants<H = unknown> {
     treeselect: VariantEntry<string | number | undefined, ShadcnTreeSelectVariantProps>;
     file: VariantEntry<FileLike, ShadcnFileVariantProps>;
     editor: VariantEntry<string | undefined, ShadcnEditorVariantProps>;
+    'json-editor': VariantEntry<JsonObject | undefined, ShadcnJsonEditorProps>;
 }
 /**
  * Union of all variant keys.

package/dist/index.d.ts

@@ -3357,6 +3357,289 @@ interface ShadcnEditorVariantProps extends Pick<VariantBaseProps<string | undefi
     className?: string;
 }
 
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+type JsonObject = Record<string, JsonValue>;
+type JsonPath = string;
+type JsonWildcard = string;
+
+/**
+ * A "variant spec" can be:
+ * - a plain VariantKey ("text", "number", "toggle", ...)
+ * - a variant key + props to pass into that variant
+ */
+type JsonEditorVariantSpec = VariantKey | {
+    variant: VariantKey;
+    props?: VariantPropsFor<any>;
+};
+/**
+ * Map a key-path (or wildcard) to a variant spec.
+ *
+ * Keys are matched against:
+ * - full path:  "config.apiEndpoint"
+ * - leaf key:   "apiEndpoint"
+ *
+ * Wild examples:
+ * - "*api*"             (segment contains "api")
+ * - "config.*"          (direct children)
+ * - "config.**"         (subtree)
+ * - "**.*token*"        (any route/leaf)
+ */
+type JsonEditorFieldMap = Record<JsonWildcard, JsonEditorVariantSpec>;
+/**
+ * Layout is scoped to a "page" (object route path).
+ *
+ * Each entry is a "row":
+ * - string: render a single field row
+ * - string[]: render these fields side-by-side (grid row)
+ *
+ * Example:
+ * layout: {
+ *   "": [["projectName","version"], "description"],
+ *   "config": [["maxEntries","apiEndpoint"], "retry"]
+ * }
+ */
+type JsonEditorLayoutRow = string | string[];
+type JsonEditorLayoutMap = Record<JsonWildcard, JsonEditorLayoutRow[]>;
+interface JsonEditorFilters {
+    /** Hide entire object routes/pages (navigation + rendering) */
+    excludeRoutes?: JsonWildcard[];
+    includeRoutes?: JsonWildcard[];
+    /** Hide specific fields (by full path or leaf/wild patterns) */
+    excludeFields?: JsonWildcard[];
+    includeFields?: JsonWildcard[];
+    /**
+     * If true, excluding "config" also excludes "config.**".
+     * Default: true
+     */
+    excludeRouteSubtree?: boolean;
+}
+/**
+ * Default value for a newly created key (or a new array item).
+ * Can be a constant JsonValue, or a function.
+ */
+type JsonEditorDefaultValueSpec = JsonValue | ((ctx: {
+    parentPath: JsonPath;
+    key: string;
+    current: JsonValue | undefined;
+}) => JsonValue);
+interface JsonEditorDefaults {
+    /**
+     * When adding a new array item, you can pick from allowed variants.
+     * You can pass VariantKey or a {variant, props} spec.
+     */
+    array?: JsonEditorVariantSpec[];
+    /**
+     * Optional default values for new keys.
+     * Keyed by wildcard path (full path / leaf / patterns).
+     */
+    values?: Record<JsonWildcard, JsonEditorDefaultValueSpec>;
+}
+type JsonEditorNavMode = "sidebar" | "tabs" | "drawer";
+interface JsonEditorNavOptions {
+    mode?: JsonEditorNavMode;
+    /** Show root "" as a page in navigation. Default: true */
+    showRoot?: boolean;
+    /** Initial active route/page. Default: "" */
+    defaultRoute?: JsonPath;
+    /** Optional label overrides for route nodes */
+    routeLabels?: Record<JsonWildcard, React.ReactNode>;
+    /** Max object nesting to generate routes for. Optional safety */
+    maxDepth?: number;
+    /**
+     * Whether arrays containing objects can contribute routes.
+     * - "none": arrays never create routes (default)
+     * - "objects": array items that are objects become routes like "config.items.0"
+     */
+    arrayRoutes?: "none" | "objects";
+}
+interface JsonRouteNode {
+    path: JsonPath;
+    key: string;
+    label: React.ReactNode;
+    children: JsonRouteNode[];
+}
+type JsonEditorViewMode = "split" | "visual" | "raw";
+interface JsonEditorPermissions {
+    canAdd?: boolean;
+    canDelete?: boolean;
+    canViewRaw?: boolean;
+    canEditRaw?: boolean;
+    /**
+     * Keys/paths in this shape cannot be deleted even if canDelete is true.
+     * (treated as "locked")
+     */
+    defaultShape?: JsonObject;
+    /**
+     * Optional finer-grain locks by wildcard.
+     * If true, this key/path cannot be added/deleted/edited.
+     */
+    lockPaths?: JsonWildcard[];
+}
+type JsonEditorEditAction = "add" | "delete" | "edit" | "edit-raw";
+interface JsonEditorEditMeta {
+    action: JsonEditorEditAction;
+    /** the page (object route) currently being edited */
+    route: JsonPath;
+    /** the exact key path being changed (field path) */
+    path: JsonPath;
+    /** parent object path of the key */
+    parent: JsonPath;
+    /** leaf key (segment) */
+    key: string;
+}
+interface JsonEditorCallbacks {
+    onAdd?: (nextRoot: JsonObject, meta: JsonEditorEditMeta) => void;
+    onDelete?: (nextRoot: JsonObject, meta: JsonEditorEditMeta) => void;
+    onEdit?: (nextRoot: JsonObject, meta: JsonEditorEditMeta) => void;
+}
+interface JsonEditorResolvedField {
+    path: JsonPath;
+    key: string;
+    value: JsonValue;
+    valueType: "string" | "number" | "boolean" | "null" | "object" | "array";
+    variant?: JsonEditorVariantSpec;
+    hidden?: boolean;
+}
+/**
+ * This is the "shared" props contract for the JSON editor variant UI.
+ *
+ * NOTE:
+ * - `title` is purely UI (header text)
+ * - `schema` is NOT a title — it’s a schema id/key for validation (later use)
+ */
+interface ShadcnJsonEditorVariantProps extends Pick<VariantBaseProps<JsonObject | undefined>, "value" | "onValue" | "error" | "disabled" | "readOnly"> {
+    /** Header title (UI only) */
+    title?: React.ReactNode;
+    /** Optional schema id/key or raw JSON Schema object for validation */
+    schema?: string | JsonObject;
+    /** Primary config */
+    fieldMap?: JsonEditorFieldMap;
+    layout?: JsonEditorLayoutMap;
+    defaults?: JsonEditorDefaults;
+    /** Navigation derived from JSON structure */
+    nav?: JsonEditorNavOptions;
+    /** include/exclude for routes + fields */
+    filters?: JsonEditorFilters;
+    /** permissions + locks */
+    permissions?: JsonEditorPermissions;
+    /** callbacks */
+    callbacks?: JsonEditorCallbacks;
+    /**
+     * Page rendering mode:
+     * - "accordion": page sections expand/collapse in main panel
+     * - "popover": nested objects open as overlays (optional UX)
+     */
+    mode?: "accordion" | "popover";
+    /**
+     * Routing:
+     * - route: controlled current page
+     * - defaultRoute: uncontrolled initial page (overrides nav.defaultRoute)
+     * - onRouteChange: called whenever the editor navigates
+     */
+    route?: JsonPath;
+    defaultRoute?: JsonPath;
+    onRouteChange?: (route: JsonPath) => void;
+    /**
+     * View mode (top toggle):
+     * - "split": raw sidebar + visual editor (default)
+     * - "visual": visual editor only
+     * - "raw": raw editor only
+     *
+     * If viewMode is provided, it is controlled.
+     * Otherwise, the defaultViewMode seeds the internal state.
+     */
+    viewMode?: JsonEditorViewMode;
+    defaultViewMode?: JsonEditorViewMode;
+    onViewModeChange?: (mode: JsonEditorViewMode) => void;
+    /** Close button intent (optional). Actual close UI is controlled by the wrapper (index.tsx). */
+    onClose?: () => void;
+    /** Visual (editor-level styling) */
+    className?: string;
+    contentClassName?: string;
+    navClassName?: string;
+    /**
+     * Optional hooks to customize nav + page rendering.
+     */
+    renderRouteLabel?: (ctx: {
+        node: JsonRouteNode;
+        active: boolean;
+    }) => React.ReactNode;
+    renderField?: (ctx: {
+        field: JsonEditorResolvedField;
+        route: JsonPath;
+    }) => React.ReactNode;
+}
+/**
+ * Wrapper mode:
+ * - "popover": show trigger + popover
+ * - "accordion": inline panel that can expand/collapse
+ */
+type JsonEditorMode = "popover" | "accordion";
+/**
+ * Typed to match your shadcn button variants/sizes.
+ * If your project differs, change these unions here once.
+ */
+type JsonEditorTriggerVariant = "default" | "destructive" | "outline" | "secondary" | "ghost" | "link";
+type JsonEditorTriggerSize = "default" | "sm" | "lg" | "icon";
+/**
+ * Standalone wiring:
+ * - caller provides root/onRoot directly
+ */
+type JsonEditorStandaloneWiring = {
+    root: JsonObject;
+    onRoot: (nextRoot: JsonObject, detail?: any) => void;
+    value?: never;
+    onValue?: never;
+};
+/**
+ * Variant wiring:
+ * - InputField variant uses value/onValue
+ */
+type JsonEditorVariantWiring = Pick<VariantBaseProps<JsonObject | undefined>, "value" | "onValue" | "disabled" | "readOnly" | "error" | "size" | "density"> & {
+    root?: never;
+    onRoot?: never;
+};
+/**
+ * Props for the exported component (index.tsx):
+ * - accepts standalone OR variant wiring
+ * - wrapper owns mode/open/trigger UI
+ * - editor-specific props are passed through, without redefining a second type list
+ *
+ * IMPORTANT:
+ * - wrapper uses `wrapperClassName` (outer container)
+ * - editor uses `className` (inner editor surface)
+ */
+interface JsonEditorWrapperProps {
+    /** Wrapper mode (popover vs accordion). */
+    mode?: JsonEditorMode;
+    /** Trigger UI (popover mode) */
+    triggerLabel?: React.ReactNode;
+    triggerVariant?: JsonEditorTriggerVariant;
+    triggerSize?: JsonEditorTriggerSize;
+    /** Popover sizing/skin */
+    popoverClassName?: string;
+    /** Inline/accordion container class */
+    panelClassName?: string;
+    /** Outer wrapper class */
+    wrapperClassName?: string;
+    /** Optional: controlled popover open state */
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    /** Accessibility (useful when rendered as an InputField variant) */
+    id?: string;
+    describedBy?: string;
+    /** Called when the wrapper closes (popover close / accordion hide). */
+    onClose?: () => void;
+}
+/**
+ * Single source of truth for what index.tsx accepts:
+ * - (standalone OR variant wiring)
+ * - wrapper props
+ * - editor props (minus a few keys owned by wrapper)
+ */
+type ShadcnJsonEditorProps = (JsonEditorStandaloneWiring | JsonEditorVariantWiring) & JsonEditorWrapperProps & Omit<ShadcnJsonEditorVariantProps, "onValue" | "value" | "disabled" | "readOnly" | "error" | "size" | "density" | "onClose">;
+
 /**
  * Helper type for a single variant registry entry.
  *
@@ -3412,6 +3695,7 @@ interface Variants<H = unknown> {
     treeselect: VariantEntry<string | number | undefined, ShadcnTreeSelectVariantProps>;
     file: VariantEntry<FileLike, ShadcnFileVariantProps>;
     editor: VariantEntry<string | undefined, ShadcnEditorVariantProps>;
+    'json-editor': VariantEntry<JsonObject | undefined, ShadcnJsonEditorProps>;
 }
 /**
  * Union of all variant keys.