@epam/ai-dial-ui-kit 0.15.0-dev.44 → 0.15.0-dev.46

package/dist/src/components/New/SchemaRenderer/types.d.ts

@@ -0,0 +1,76 @@
+import { ReactElement, ReactNode } from 'react';
+import { JsonSchema, JsonSchemaDef, SchemaRendererTexts } from '../../../models/json-schema';
+import { SchemaRendererVariant } from '../../../types/json-schema';
+export type SchemaRenderField = (path: string[], schema: JsonSchemaDef, defaultElement: ReactElement) => ReactNode;
+export interface SchemaRendererProps {
+    schema: JsonSchema;
+    defaultValue?: Record<string, unknown>;
+    texts?: Partial<SchemaRendererTexts>;
+    className?: string;
+    readonly?: boolean;
+    defaultExpanded?: boolean;
+    /** Additional classes for the container of every text, number and select field. */
+    inputClassName?: string;
+    /**
+     * `Sections` (default) — every top-level property is a collapsible section card.
+     * `Flat` — primitive top-level properties render as labelled fields; object and
+     * array properties still use collapsible sections.
+     * `FlatSections` — every top-level property renders under a plain heading.
+     */
+    variant?: SchemaRendererVariant;
+    /**
+     * When `true`, required-field errors are only shown after the user has interacted
+     * with a field. When `false` (default), all unfilled required fields are highlighted immediately.
+     */
+    skipUntouched?: boolean;
+    /**
+     * Live resource options for schema properties flagged with `dial:resource: true`.
+     * Keyed by the resource type name referenced in a property's `acceptableResourceTypes`
+     * array; each value provides the selectable entries for that resource type (a string
+     * array for string-typed properties).
+     */
+    acceptableResourceTypes?: Record<string, unknown>;
+    onChange?: (value: Record<string, unknown>) => void;
+    onPropertyChange?: (path: string, value: unknown) => void;
+    onDefaultValues?: (value: Record<string, unknown>) => void;
+    /**
+     * Override the rendered element for any field by path. The field's label and
+     * error stay outside the element, so an override replaces the control only.
+     * Return `defaultElement` to fall back to the built-in renderer.
+     * @param path - Array of schema property keys leading to this field (e.g. ['connection', 'token'])
+     * @param schema - The resolved JSON Schema definition for this field
+     * @param defaultElement - The element that would be rendered without customization
+     */
+    renderField?: SchemaRenderField;
+}
+export interface SchemaFieldContentProps {
+    schema: JsonSchemaDef;
+    value: unknown;
+    onChange: (value: unknown) => void;
+    path: string[];
+    level: number;
+    required?: boolean;
+    suppressInlineError?: boolean;
+    /** The id given to a primitive control, so a visible label can point at it. */
+    fieldId?: string;
+    /**
+     * Accessible name for the control. Sections, array items and key-value rows
+     * have no visible label next to their control, so this is what names it.
+     */
+    ariaLabel?: string;
+}
+export interface SchemaFieldProps extends Omit<SchemaFieldContentProps, 'fieldId' | 'ariaLabel' | 'suppressInlineError'> {
+    label?: string;
+}
+export interface SchemaRendererContextValue {
+    rootSchema: JsonSchema;
+    texts: SchemaRendererTexts;
+    readonly?: boolean;
+    defaultExpanded?: boolean;
+    inputClassName?: string;
+    acceptableResourceTypes?: Record<string, unknown>;
+    renderField?: SchemaRenderField;
+    touchedPaths?: ReadonlySet<string>;
+    markTouched?: (path: string) => void;
+    skipUntouched?: boolean;
+}

package/dist/src/components/SchemaRenderer/types.d.ts

@@ -1,98 +1,10 @@
 import { default as React } from 'react';
 import { EditorThemes } from '../../types/editor';
-export declare enum SchemaRendererVariant {
-    Sections = "sections",
-    Flat = "flat",
-    FlatSections = "flat-sections"
-}
-export declare enum SchemaDisplayMode {
-    Select = "select",
-    Radio = "radio"
-}
-export declare enum SchemaOrientation {
-    Row = "row",
-    Column = "column"
-}
-export declare enum JsonSchemaType {
-    String = "string",
-    Number = "number",
-    Integer = "integer",
-    Boolean = "boolean",
-    Object = "object",
-    Array = "array",
-    Null = "null"
-}
-export interface DialMeta {
-    'dial:propertyOrder'?: number;
-    [key: string]: unknown;
-}
-export interface JsonSchemaDef {
-    $ref?: string;
-    type?: string | string[];
-    title?: string;
-    description?: string;
-    isHidden?: boolean;
-    isProtected?: boolean;
-    enumDisplay?: SchemaDisplayMode;
-    enumOrientation?: SchemaOrientation;
-    discriminatorDisplay?: SchemaDisplayMode;
-    discriminatorOrientation?: SchemaOrientation;
-    default?: unknown;
-    const?: unknown;
-    enum?: unknown[];
-    properties?: Record<string, JsonSchemaDef>;
-    required?: string[];
-    items?: JsonSchemaDef;
-    oneOf?: JsonSchemaDef[];
-    anyOf?: JsonSchemaDef[];
-    allOf?: JsonSchemaDef[];
-    discriminator?: {
-        propertyName: string;
-        mapping: Record<string, string>;
-    };
-    'dial:meta'?: DialMeta;
-    'dial:resource'?: boolean;
-    acceptableResourceTypes?: string[];
-    [key: string]: unknown;
-}
-export interface JsonSchema extends JsonSchemaDef {
-    $defs?: Record<string, JsonSchemaDef>;
-}
-export interface ValidationError {
-    path: string;
-    message: string;
-}
-export interface SchemaRendererTexts {
-    noItemSchema: string;
-    noItemsYet: string;
-    addItem: string;
-    selectTypeToAdd: string;
-    noConfigurableProperties: string;
-    noFieldsYet: string;
-    keyColumnHeader: string;
-    valueColumnHeader: string;
-    addField: string;
-    keyInputPlaceholder: string;
-    stringInputPlaceholder: string;
-    integerInputPlaceholder: string;
-    numberInputPlaceholder: string;
-    enumSelectPlaceholder: string;
-    selectTypePlaceholder: string;
-    removeItemAriaLabel: string;
-    removeFieldAriaLabel: string;
-    typeColumnHeader: string;
-    entryTypeString: string;
-    entryTypeNumber: string;
-    entryTypeBoolean: string;
-    entryTypeNull: string;
-    entryTypeObject: string;
-    entryTypeArray: string;
-    entryTypeChangeWarning: string;
-    booleanTrueOption: string;
-    booleanFalseOption: string;
-    invalidJsonError: string;
-}
-export declare const DEFAULT_SCHEMA_TEXTS: SchemaRendererTexts;
+import { SchemaRendererVariant } from '../../types/json-schema';
+import { JsonSchema, JsonSchemaDef, SchemaRendererTexts } from '../../models/json-schema';
+export { SchemaRendererVariant, SchemaDisplayMode, SchemaOrientation, JsonSchemaType, } from '../../types/json-schema';
+export type { DialMeta, JsonSchemaDef, JsonSchema, ValidationError, SchemaRendererTexts, } from '../../models/json-schema';
+export { DEFAULT_SCHEMA_TEXTS } from '../../constants/schema-renderer';
 export interface DialSchemaRendererProps {
     schema: JsonSchema;
     defaultValue?: Record<string, unknown>;

package/dist/src/components/SchemaRenderer/utils.d.ts

@@ -1,22 +1 @@
-import { JsonSchemaType, JsonSchema, JsonSchemaDef, ValidationError } from './types';
-export declare function resolveRef(schema: JsonSchemaDef, rootSchema: JsonSchema, depth?: number): JsonSchemaDef;
-export declare function sortByPropertyOrder(entries: [string, JsonSchemaDef][]): [string, JsonSchemaDef][];
-export declare function isMissingRequiredValue(value: unknown): boolean;
-export declare function isObjectType(schema: JsonSchemaDef): boolean;
-export declare function toFieldLabel(key: string): string;
-/**
- * Builds the "required" error message for a field. The label is quoted so a
- * long title stays visually separate from the "is required" suffix.
- */
-export declare const toRequiredMessage: (label: string) => string;
-export declare function getOptionLabel(schema: JsonSchemaDef, rootSchema: JsonSchema): string;
-export declare function extractDefaults(schema: JsonSchemaDef, rootSchema: JsonSchema, depth?: number): unknown;
-export declare function validateRequired(value: unknown, schema: JsonSchemaDef, rootSchema: JsonSchema, path?: string, depth?: number): ValidationError[];
-export declare function buildSummary(value: unknown, schema: JsonSchemaDef, rootSchema: JsonSchema): string;
-export declare function detectAnyOfVariant(value: unknown, schemas: JsonSchemaDef[], rootSchema: JsonSchema): number;
-export declare function getItemTitle(item: unknown, discriminatorProp: string | undefined, index: number): string;
-export declare function getSchemaDefault(schema: JsonSchemaDef): unknown;
-export type EntryType = JsonSchemaType.String | JsonSchemaType.Number | JsonSchemaType.Boolean | JsonSchemaType.Null | JsonSchemaType.Object | JsonSchemaType.Array;
-export declare const ENTRY_TYPE_OPTIONS: EntryType[];
-export declare function inferEntryType(value: unknown): EntryType;
-export declare function getEntryTypeDefault(type: EntryType): unknown;
+export * from '../../utils/json-schema';

package/dist/src/constants/public-class-names.d.ts

@@ -111,6 +111,14 @@ export declare const DIAL_KIT_CLASS: {
     readonly inlineSelect: "dial-kit-inline-select";
     /** The root of a `Calendar`, wrapping its label and date field. */
     readonly calendar: "dial-kit-calendar";
+    /** The root of a `SchemaRenderer`, wrapping its top-level sections or fields. */
+    readonly schemaRenderer: "dial-kit-schema-renderer";
+    /**
+     * The card of one collapsible `SchemaRenderer` section, at any depth: a
+     * top-level property, a nested object or array, an array item, or a
+     * key-value entry holding an object.
+     */
+    readonly schemaRendererSection: "dial-kit-schema-renderer-section";
     /** The drop area of a `FileDropzone`. */
     readonly fileDropzone: "dial-kit-file-dropzone";
     /**

package/dist/src/constants/schema-renderer.d.ts

@@ -0,0 +1,2 @@
+import { SchemaRendererTexts } from '../models/json-schema';
+export declare const DEFAULT_SCHEMA_TEXTS: SchemaRendererTexts;

package/dist/src/index.d.ts

@@ -146,7 +146,9 @@ export { NOT_ALLOWED_SYMBOLS, NOT_ALLOWED_SPACES, NOT_ALLOWED_SYMBOLS_REGEXP, NO
 export { DIAL_KIT_CLASS } from './constants/public-class-names';
 export { DialSchemaRenderer } from './components/SchemaRenderer/SchemaRenderer';
 export { SchemaRendererVariant, SchemaDisplayMode, SchemaOrientation, JsonSchemaType, } from './components/SchemaRenderer/types';
-export type { DialSchemaRendererProps, JsonSchema, JsonSchemaDef, ValidationError, } from './components/SchemaRenderer/types';
+export type { DialSchemaRendererProps, JsonSchema, JsonSchemaDef, ValidationError, SchemaRendererTexts, } from './components/SchemaRenderer/types';
+export { SchemaRenderer } from './components/New/SchemaRenderer/SchemaRenderer';
+export type { SchemaRendererProps, SchemaRenderField, } from './components/New/SchemaRenderer/types';
 export { LazyDialJsonEditor } from './components/JsonEditor/lazy';
 export { LazyDialMarkdownEditor } from './components/MarkdownEditor/lazy';
 export { NotificationVariant, NotificationType } from './types/notification.ts';

package/dist/src/models/json-schema.d.ts

@@ -0,0 +1,71 @@
+import { SchemaDisplayMode, SchemaOrientation } from '../types/json-schema';
+export interface DialMeta {
+    'dial:propertyOrder'?: number;
+    [key: string]: unknown;
+}
+export interface JsonSchemaDef {
+    $ref?: string;
+    type?: string | string[];
+    title?: string;
+    description?: string;
+    isHidden?: boolean;
+    isProtected?: boolean;
+    enumDisplay?: SchemaDisplayMode;
+    enumOrientation?: SchemaOrientation;
+    discriminatorDisplay?: SchemaDisplayMode;
+    discriminatorOrientation?: SchemaOrientation;
+    default?: unknown;
+    const?: unknown;
+    enum?: unknown[];
+    properties?: Record<string, JsonSchemaDef>;
+    required?: string[];
+    items?: JsonSchemaDef;
+    oneOf?: JsonSchemaDef[];
+    anyOf?: JsonSchemaDef[];
+    allOf?: JsonSchemaDef[];
+    discriminator?: {
+        propertyName: string;
+        mapping: Record<string, string>;
+    };
+    'dial:meta'?: DialMeta;
+    'dial:resource'?: boolean;
+    acceptableResourceTypes?: string[];
+    [key: string]: unknown;
+}
+export interface JsonSchema extends JsonSchemaDef {
+    $defs?: Record<string, JsonSchemaDef>;
+}
+export interface ValidationError {
+    path: string;
+    message: string;
+}
+export interface SchemaRendererTexts {
+    noItemSchema: string;
+    noItemsYet: string;
+    addItem: string;
+    selectTypeToAdd: string;
+    noConfigurableProperties: string;
+    noFieldsYet: string;
+    keyColumnHeader: string;
+    valueColumnHeader: string;
+    addField: string;
+    keyInputPlaceholder: string;
+    stringInputPlaceholder: string;
+    integerInputPlaceholder: string;
+    numberInputPlaceholder: string;
+    enumSelectPlaceholder: string;
+    selectTypePlaceholder: string;
+    removeItemAriaLabel: string;
+    removeFieldAriaLabel: string;
+    typeColumnHeader: string;
+    entryTypeString: string;
+    entryTypeNumber: string;
+    entryTypeBoolean: string;
+    entryTypeNull: string;
+    entryTypeObject: string;
+    entryTypeArray: string;
+    entryTypeChangeWarning: string;
+    booleanTrueOption: string;
+    booleanFalseOption: string;
+    invalidJsonError: string;
+}

package/dist/src/types/json-schema.d.ts

@@ -0,0 +1,22 @@
+export declare enum SchemaRendererVariant {
+    Sections = "sections",
+    Flat = "flat",
+    FlatSections = "flat-sections"
+}
+export declare enum SchemaDisplayMode {
+    Select = "select",
+    Radio = "radio"
+}
+export declare enum SchemaOrientation {
+    Row = "row",
+    Column = "column"
+}
+export declare enum JsonSchemaType {
+    String = "string",
+    Number = "number",
+    Integer = "integer",
+    Boolean = "boolean",
+    Object = "object",
+    Array = "array",
+    Null = "null"
+}

package/dist/src/utils/json-schema.d.ts

@@ -0,0 +1,23 @@
+import { JsonSchemaType } from '../types/json-schema';
+import { JsonSchema, JsonSchemaDef, ValidationError } from '../models/json-schema';
+export declare function resolveRef(schema: JsonSchemaDef, rootSchema: JsonSchema, depth?: number): JsonSchemaDef;
+export declare function sortByPropertyOrder(entries: [string, JsonSchemaDef][]): [string, JsonSchemaDef][];
+export declare function isMissingRequiredValue(value: unknown): boolean;
+export declare function isObjectType(schema: JsonSchemaDef): boolean;
+export declare function toFieldLabel(key: string): string;
+/**
+ * Builds the "required" error message for a field. The label is quoted so a
+ * long title stays visually separate from the "is required" suffix.
+ */
+export declare const toRequiredMessage: (label: string) => string;
+export declare function getOptionLabel(schema: JsonSchemaDef, rootSchema: JsonSchema): string;
+export declare function extractDefaults(schema: JsonSchemaDef, rootSchema: JsonSchema, depth?: number): unknown;
+export declare function validateRequired(value: unknown, schema: JsonSchemaDef, rootSchema: JsonSchema, path?: string, depth?: number): ValidationError[];
+export declare function buildSummary(value: unknown, schema: JsonSchemaDef, rootSchema: JsonSchema): string;
+export declare function detectAnyOfVariant(value: unknown, schemas: JsonSchemaDef[], rootSchema: JsonSchema): number;
+export declare function getItemTitle(item: unknown, discriminatorProp: string | undefined, index: number): string;
+export declare function getSchemaDefault(schema: JsonSchemaDef): unknown;
+export type EntryType = JsonSchemaType.String | JsonSchemaType.Number | JsonSchemaType.Boolean | JsonSchemaType.Null | JsonSchemaType.Object | JsonSchemaType.Array;
+export declare const ENTRY_TYPE_OPTIONS: EntryType[];
+export declare function inferEntryType(value: unknown): EntryType;
+export declare function getEntryTypeDefault(type: EntryType): unknown;

package/dist/types/json-schema.js

@@ -0,0 +1,7 @@
+var t = /* @__PURE__ */ ((r) => (r.Sections = "sections", r.Flat = "flat", r.FlatSections = "flat-sections", r))(t || {}), l = /* @__PURE__ */ ((r) => (r.Select = "select", r.Radio = "radio", r))(l || {}), u = /* @__PURE__ */ ((r) => (r.Row = "row", r.Column = "column", r))(u || {}), o = /* @__PURE__ */ ((r) => (r.String = "string", r.Number = "number", r.Integer = "integer", r.Boolean = "boolean", r.Object = "object", r.Array = "array", r.Null = "null", r))(o || {});
+export {
+  o as JsonSchemaType,
+  l as SchemaDisplayMode,
+  u as SchemaOrientation,
+  t as SchemaRendererVariant
+};