@nice2dev/ui-forms 1.3.11 → 1.3.12

package/dist/index.d.ts

@@ -11,6 +11,7 @@ import { NiceHookBinding } from '@nice2dev/ui';
 import { NiceRbacModel } from '@nice2dev/ui';
 import { NiceScriptRunnerProps } from '@nice2dev/ui';
 import { NiceStandardProps } from '@nice2dev/ui';
+import { NiceTabItem } from '@nice2dev/ui';
 import { NiceViewDefinition } from '@nice2dev/ui';
 import { NiceWorkflowDefinition } from '@nice2dev/ui';
 import { RefAttributes } from 'react';
@@ -377,45 +378,56 @@ export declare interface NiceArrayFileKindOptions {
 export declare const NiceDevelopmentStudio: ForwardRefExoticComponent<NiceDevelopmentStudioProps & RefAttributes<HTMLDivElement>>;
 
 export declare interface NiceDevelopmentStudioProps extends NiceStandardProps {
-    /** Where modules come from and go to. Without it the studio shows an empty explorer. */
+    /** Where modules come from and go to. Without it the studio shows an empty tree. */
     provider?: NiceStudioProvider;
     /**
      * How the host's modules look (file kinds, manifest sections, languages, rules, generator).
      * A function gets the translator, for translated section titles. Default: the native format.
      */
     preset?: NiceStudioPreset | ((t: (key: string, fallback: string) => string) => NiceStudioPreset);
-    /** A module to open at start (e.g. from a `?module=` link). */
+    /** A module to show at start (e.g. from a `?module=` link). */
     defaultModule?: NiceStudioModuleKey;
-    /** Which explorer tree shows first. Default `'modules'`. */
+    /** `'templates'` opens the tree's Templates row at start. Default `'modules'`. */
     defaultExplorerTab?: 'modules' | 'templates';
+    /**
+     * `'standard'` (default): forms only — files without a form stay as they are and out of sight.
+     * `'advanced'`: also the module's files with their source, entries without a designer as JSON
+     * and the log of what the studio did.
+     */
+    displayMode?: 'standard' | 'advanced';
+    /** The host's own actions above the tree (e.g. "Open a folder…"). */
+    actions?: NiceStudioAction[];
     /** A module was opened. */
     onModuleOpen?: (key: NiceStudioModuleKey) => void;
     /** A module was saved. */
     onSaved?: (key: NiceStudioModuleKey, result: Extract<NiceStudioWriteResult, {
         ok: true;
     }>) => void;
-    /** A provider call failed (also logged in the output panel). */
+    /** A provider call failed (also shown in the status bar). */
     onError?: (error: unknown, context: string) => void;
     /** Show the changed files before saving. Default `true`. */
     reviewBeforeSave?: boolean;
     /** Runs script files (`script` documents) in a NiceScriptRunner. */
     scriptRunner?: Omit<NiceScriptRunnerProps, 'value' | 'onChange'>;
-    /** The host's own preview of a view (e.g. its runtime renderer), next to the designer. */
+    /** The host's own preview of a view (e.g. its runtime renderer): small in the preview, full beside the designer. */
     renderViewPreview?: (ctx: NiceStudioViewPreviewContext) => React.ReactNode;
-    /** Extra panels on a module's overview (payments, webhooks, …). */
+    /** Extra parts of a module (payments, webhooks, …): rows under the module, opened full-screen. */
     modulePanels?: (ctx: NiceStudioModulePanelContext) => NiceStudioPanel[];
     /** Browse and read only. */
     readOnly?: boolean;
-    /** Console theme. Default `'light'`. */
+    /** @deprecated No effect since 1.3.12: the studio follows the page theme. */
     theme?: 'dark' | 'light';
     /** Studio height. Default `720`. */
     height?: number | string;
-    /** Explorer width in px. Default `300`. */
+    /** The tree's least width in px; it takes the room the preview leaves. Default `320`. */
     explorerWidth?: number;
+    /** Width of the preview beside the tree, in px. Default `260`. */
+    previewWidth?: number;
     /** Optional guided tour. `true` = built-in tour; array/object = custom steps. Shows a "?" button. */
     tutorial?: NiceComponentTutorial;
 }
 
+/** An entity definition (the OmniVerk ModuleEntity shape by default). */
 export declare type NiceEntity = Record<string, unknown>;
 
 export declare const NiceEntityEditor: ForwardRefExoticComponent<NiceEntityEditorProps & RefAttributes<HTMLDivElement>>;
@@ -445,6 +457,35 @@ export declare interface NiceEntityEditorProps extends NiceStandardProps {
     tutorial?: NiceComponentTutorial;
 }
 
+export declare const NiceEntityForm: ForwardRefExoticComponent<NiceEntityFormProps & RefAttributes<HTMLDivElement>>;
+
+export declare interface NiceEntityFormProps extends NiceStandardProps {
+    /** The entity being edited (controlled). Omit it to let the form keep its own. */
+    value?: NiceEntity;
+    /** Initial entity when uncontrolled. */
+    defaultValue?: NiceEntity;
+    /** Change callback with the whole updated entity. */
+    onChange?: (entity: NiceEntity) => void;
+    /** JSON Schema for entity metadata (name, table, flags …). Defaults to the OmniVerk shape. */
+    entityMetaSchema?: JsonSchema;
+    /** JSON Schema for a single field. Defaults to the OmniVerk ModuleEntityField shape. */
+    fieldSchema?: JsonSchema;
+    /** Property holding the entity's fields. Default `'fields'`. */
+    fieldsKey?: string;
+    /** Property holding the entity's validation rules (NiceFieldValidationRule[]). Default `'validations'`. */
+    validationsKey?: string;
+    /** The open tab: `'general'`, `'fields'`, `'validation'` or an extra tab's id. Omit it to let the form keep its own. */
+    activeTab?: string;
+    /** Initial tab when uncontrolled. Default `'general'`. */
+    defaultActiveTab?: string;
+    /** The user switched tabs. */
+    onActiveTabChange?: (tab: string) => void;
+    /** More tabs after Validation (e.g. an ER diagram). */
+    extraTabs?: NiceTabItem[];
+    /** Render read-only. */
+    readOnly?: boolean;
+}
+
 export declare const NiceI18nEditor: ForwardRefExoticComponent<NiceI18nEditorProps & RefAttributes<HTMLDivElement>>;
 
 export declare interface NiceI18nEditorProps extends NiceBaseProps {
@@ -662,6 +703,16 @@ export declare interface NiceSchemaFormProps extends NiceStandardProps {
     tutorial?: NiceComponentTutorial;
 }
 
+/** A host's own action in the studio's tree header (e.g. "Open a folder…"). */
+export declare interface NiceStudioAction {
+    key: string;
+    label: string;
+    /** NiceIcon name. */
+    icon?: string;
+    disabled?: boolean;
+    onSelect: () => void;
+}
+
 /** What a file kind's decode and encode know about the module. */
 export declare interface NiceStudioCodecContext {
     moduleId: string;
@@ -861,7 +912,7 @@ export declare interface NiceStudioPackage {
     readOnly?: boolean;
 }
 
-/** An extra panel on a module's overview (payments, webhooks — anything host-specific). */
+/** An extra part of a module (payments, webhooks — anything host-specific): a row under the module in the tree, its content full-screen. */
 export declare interface NiceStudioPanel {
     key: string;
     label: string;