@nice2dev/ui-forms 1.4.10 → 1.4.12

package/dist/index.d.ts

@@ -328,6 +328,9 @@ export declare const nativeDataSourcesKind: NiceStudioFileKind<NiceDataSourceDef
 
 export declare const nativeEntitiesKind: NiceStudioFileKind<Row_3[]>;
 
+/** `{id}.environments.json`: declared variables and the sets of their values (1.4.12). */
+export declare const nativeEnvironmentsKind: NiceStudioFileKind<Record<string, unknown>>;
+
 /** The file kinds of the native format, in matching order. */
 export declare const nativeFileKinds: NiceStudioFileKind[];
 
@@ -335,6 +338,12 @@ export declare const nativeHooksKind: NiceStudioFileKind<NiceHookBinding[]>;
 
 export declare const nativeI18nKind: NiceStudioFileKind<NiceStudioTranslations>;
 
+/**
+ * `{id}.integrations.json`: `{ integrations: [...] }` (1.4.12) — edited by the host's `integrations`
+ * editor plug-in (@nice2dev/ui-api), else as JSON.
+ */
+export declare const nativeIntegrationsKind: NiceStudioFileKind<Record<string, unknown>>;
+
 export declare const nativeManifestKind: NiceStudioFileKind<Row_3>;
 
 export declare const nativeRbacKind: NiceStudioFileKind<NiceRbacModel>;
@@ -454,6 +463,14 @@ export declare interface NiceDevelopmentStudioProps extends NiceStandardProps {
     reviewBeforeSave?: boolean;
     /** Runs script files (`script` documents) in a NiceScriptRunner. */
     scriptRunner?: Omit<NiceScriptRunnerProps, 'value' | 'onChange'>;
+    /**
+     * Editors for file kinds the studio has none of (1.4.12), by the kind's `editor` id — e.g.
+     * `niceApiStudioEditors()` from @nice2dev/ui-api for `integrations` and `environments`. A kind with
+     * no editor opens as JSON.
+     */
+    editors?: Readonly<Record<string, NiceStudioEditorPlugin>>;
+    /** What the editor plug-ins are given: the host's proxy, data source preview, script runner, secrets. */
+    editorServices?: NiceStudioEditorServices;
     /**
      * The host's data for a module's no-code scripts (1.4.6): with it the script editor's Run runs
      * the steps against it (`read` a data source, `write` rows, `callScript`).
@@ -810,12 +827,54 @@ export declare interface NiceStudioDocument<M = unknown> {
     error?: string;
 }
 
+/** What an editor plug-in is given for the document it edits (1.4.12). */
+export declare interface NiceStudioEditorContext {
+    /** The document's model (its kind's `decode`). */
+    value: unknown;
+    /** A new model — the studio encodes and saves it like any other draft. */
+    onChange: (value: unknown) => void;
+    readOnly: boolean;
+    module: {
+        workspaceId: string;
+        id: string;
+        label: string;
+    };
+    /** The module's files as edited — a plug-in may read its neighbours (an environments file). */
+    files: ReadonlyArray<{
+        path: string;
+        text: string;
+    }>;
+    services: NiceStudioEditorServices;
+}
+
 /**
  * The editors a file kind can open in: a built-in one, or the id of an editor the host registers
  * (1.4.5 — the union was closed; an unknown id opens as raw JSON / text until one is registered).
  */
 export declare type NiceStudioEditorId = NiceStudioBuiltinEditorId | (string & {});
 
+/**
+ * An editor the host registers for a file kind's `editor` id (1.4.12) — e.g. the integrations
+ * and environment sets editors of @nice2dev/ui-api (`niceApiStudioEditors()`).
+ */
+export declare interface NiceStudioEditorPlugin {
+    /** A React node (typed `unknown` so this core stays free of React types). */
+    render: (ctx: NiceStudioEditorContext) => unknown;
+}
+
+/**
+ * The services a host hands editor plug-ins (1.4.12): sending HTTP through its proxy, running data
+ * sources and scripts, resolving secrets — whatever its plug-ins need. Typed loosely: the studio
+ * passes them on and knows none of them.
+ */
+export declare interface NiceStudioEditorServices {
+    sendRequest?: unknown;
+    previewDataSource?: unknown;
+    runScript?: unknown;
+    resolveSecret?: (key: string) => string | undefined;
+    [name: string]: unknown;
+}
+
 /** New and removed files of an encoded document. */
 export declare interface NiceStudioEncoded {
     files: Array<{