unlayer-types 1.398.0 → 1.399.0

package/embed.d.ts

@@ -1737,8 +1737,7 @@ declare module "packages/editor/src/state/types/types" {
             [id: string]: unknown;
         };
     }, placeholder: string) => (dispatch: AppDispatch, getState: () => RootState) => Promise<void>;
-    export interface JSONSchema {
-    }
+    export type { JSONSchema } from '@libs/schemas/types/types';
     export interface SuggestedSelection {
         parent?: Location | null;
         location: Location | null;
@@ -2337,6 +2336,7 @@ declare module "packages/editor/src/editor/helpers/sortArrayByPosition" {
     }>(arr: T[]): T[];
 }
 declare module "packages/editor/src/engine/config/tools" {
+    import type { JSONSchema } from "packages/editor/src/state/types/types";
     import Mustache from 'mustache';
     import { Entitlements } from '@libs/entitlements';
     import type { PropertyEditorJSONSchemas, PropertyEditorZodSchemas } from '@libs/schemas/types/property_editor';
@@ -2638,6 +2638,14 @@ declare module "packages/editor/src/engine/config/tools" {
     };
     export function isRowToolEnabled(): boolean;
     export function getTool(toolItem: ToolItem): ToolConfig<ValueMap, Validator>;
+    /**
+     * Returns true if a custom tool has schemas for all its custom widget options.
+     * Built-in widgets are always supported. Custom widgets need an explicit schema
+     * (via createWidget, registerPropertyEditor, or the option itself).
+     */
+    export function hasAISchemas(tool: ToolConfig, { displayMode }?: {
+        displayMode?: DisplayMode;
+    }): boolean;
     export function getAllTools(): any[];
     export function getTools(collection?: Collection): any[];
     export function getCustomToolsCount(): number;
@@ -2654,7 +2662,10 @@ declare module "packages/editor/src/engine/config/tools" {
     export function registerOptions(config: OptionConfig & {
         category?: string;
     }): void;
-    export function registerPropertyEditor<Props extends EditorProps<any>>(config: PropertyEditorConfig<Props>): void;
+    export function registerPropertyEditor<Props extends EditorProps<any>>(config: PropertyEditorConfig<Props> & {
+        /** Shorthand for `schemas.value`. Prefer setting `schema` on `createWidget()` instead. */
+        schema?: JSONSchema;
+    }): void;
     export function getPropertyEditor(config: {
         id: PropertyEditorConfig['id'];
         name?: PropertyEditorConfig['name'];
@@ -2903,68 +2914,53 @@ declare module "packages/editor/src/engine/config/createViewer" {
 }
 declare module "packages/editor/src/engine/config/createWidget" {
     import React from 'react';
-    export type WidgetMountFn = (node: HTMLDivElement | null, value: unknown, updateValue: unknown, data: unknown) => void;
-    export type WidgetRenderFn = (value: unknown, updateValue: unknown, data: unknown) => string;
-    export interface WidgetConfig {
-        mount: WidgetMountFn;
-        render: WidgetRenderFn;
-    }
-    export interface WidgetProps {
-        value: unknown;
-        updateValue: unknown;
+    import type { InferSchemaType } from '@libs/schemas/types/common';
+    import type { JSONSchema } from "packages/editor/src/state/types/types";
+    export type { InferSchemaType };
+    export type UpdateValueFn<Value = unknown> = (newValue: Value | undefined, data?: object) => void;
+    export type WidgetMountFn<Value = unknown> = (node: HTMLDivElement | null, value: Value | undefined, updateValue: UpdateValueFn<Value>, data: unknown) => void;
+    export type WidgetRenderFn<Value = unknown> = (value: Value | undefined, updateValue: UpdateValueFn<Value>, data: unknown) => string;
+    export interface WidgetConfig<Value = unknown> {
+        mount: WidgetMountFn<Value>;
+        render: WidgetRenderFn<Value>;
+        /**
+         * JSON Schema describing the value shape produced by this widget.
+         * Used by the AI Copilot to understand what fields this custom property editor supports.
+         *
+         * @example
+         * ```js
+         * unlayer.registerPropertyEditor({
+         *   name: 'qr_generator',
+         *   Widget: unlayer.createWidget({
+         *     schema: {
+         *       type: 'object',
+         *       properties: {
+         *         qrCode: { type: 'string', description: 'Base64-encoded QR image' },
+         *         srcUrl: { type: 'string', description: 'URL encoded in the QR code' },
+         *       },
+         *     },
+         *     render(value) { ... },
+         *     mount(node, value, updateValue) { ... },
+         *   }),
+         * });
+         * ```
+         */
+        schema?: JSONSchema | null;
+    }
+    export interface WidgetProps<Value = unknown> {
+        value: Value | undefined;
+        updateValue: UpdateValueFn<Value>;
         data: unknown;
     }
-    export function createWidget(config: WidgetConfig): {
-        new (props: WidgetProps): {
-            ref: HTMLDivElement | null;
-            componentDidMount(): void;
-            shouldComponentUpdate(nextProps: WidgetProps): boolean;
-            componentDidUpdate(prevProps: WidgetProps): void;
-            render(): React.JSX.Element;
-            context: unknown;
-            setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<WidgetProps>) => {} | Pick<{}, K>) | Pick<{}, K>, callback?: () => void): void;
-            forceUpdate(callback?: () => void): void;
-            readonly props: Readonly<WidgetProps>;
-            state: Readonly<{}>;
-            refs: {
-                [key: string]: React.ReactInstance;
-            };
-            componentWillUnmount?(): void;
-            componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-            getSnapshotBeforeUpdate?(prevProps: Readonly<WidgetProps>, prevState: Readonly<{}>): any;
-            componentWillMount?(): void;
-            UNSAFE_componentWillMount?(): void;
-            componentWillReceiveProps?(nextProps: Readonly<WidgetProps>, nextContext: any): void;
-            UNSAFE_componentWillReceiveProps?(nextProps: Readonly<WidgetProps>, nextContext: any): void;
-            componentWillUpdate?(nextProps: Readonly<WidgetProps>, nextState: Readonly<{}>, nextContext: any): void;
-            UNSAFE_componentWillUpdate?(nextProps: Readonly<WidgetProps>, nextState: Readonly<{}>, nextContext: any): void;
-        };
-        new (props: WidgetProps, context: any): {
-            ref: HTMLDivElement | null;
-            componentDidMount(): void;
-            shouldComponentUpdate(nextProps: WidgetProps): boolean;
-            componentDidUpdate(prevProps: WidgetProps): void;
-            render(): React.JSX.Element;
-            context: unknown;
-            setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<WidgetProps>) => {} | Pick<{}, K>) | Pick<{}, K>, callback?: () => void): void;
-            forceUpdate(callback?: () => void): void;
-            readonly props: Readonly<WidgetProps>;
-            state: Readonly<{}>;
-            refs: {
-                [key: string]: React.ReactInstance;
-            };
-            componentWillUnmount?(): void;
-            componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-            getSnapshotBeforeUpdate?(prevProps: Readonly<WidgetProps>, prevState: Readonly<{}>): any;
-            componentWillMount?(): void;
-            UNSAFE_componentWillMount?(): void;
-            componentWillReceiveProps?(nextProps: Readonly<WidgetProps>, nextContext: any): void;
-            UNSAFE_componentWillReceiveProps?(nextProps: Readonly<WidgetProps>, nextContext: any): void;
-            componentWillUpdate?(nextProps: Readonly<WidgetProps>, nextState: Readonly<{}>, nextContext: any): void;
-            UNSAFE_componentWillUpdate?(nextProps: Readonly<WidgetProps>, nextState: Readonly<{}>, nextContext: any): void;
-        };
-        contextType?: React.Context<any> | undefined;
+    type WidgetComponentClass = React.ComponentClass<WidgetProps> & {
+        schema?: Record<string, unknown> | null;
     };
+    export function createWidget<const S extends Record<string, unknown>>(config: {
+        schema: S;
+        mount: WidgetMountFn<InferSchemaType<S>>;
+        render: WidgetRenderFn<InferSchemaType<S>>;
+    }): WidgetComponentClass;
+    export function createWidget<Value = unknown>(config: WidgetConfig<Value>): WidgetComponentClass;
 }
 declare module "packages/editor/src/engine/options/bodies" {
     export type { BodyValues } from '@libs/schemas/options/containers/bodies';
@@ -3170,7 +3166,7 @@ declare module "packages/editor/src/embed/Editor" {
     import type { TabConfig } from "packages/editor/src/engine/config/tabs";
     import type { PanelConfig } from "packages/editor/src/engine/config/createPanel";
     import type { ViewerConfig } from "packages/editor/src/engine/config/createViewer";
-    import type { WidgetConfig } from "packages/editor/src/engine/config/createWidget";
+    import type { InferSchemaType, WidgetConfig, WidgetMountFn, WidgetRenderFn } from "packages/editor/src/engine/config/createWidget";
     import type { AppearanceConfig, Audit, DesignMode, DesignTagsConfig, Device, DisplayConditions, DisplayMode, JSONTemplate, Language, LinkTypes, LinkTypesSharedConfig, MergeTags, MergeTagsConfig, SpecialLink, StyleGuideConfig, Tabs, Translations, User, Validator, Container, BodyContainerExporter, RowContainerExporter, ColumnContainerExporter, ContentContainerExporter, ItemExporter } from "packages/editor/src/state/types/types";
     import type { BodyValues } from "packages/editor/src/engine/options/bodies";
     import type { Locale, TextDirection } from "packages/editor/src/engine/config/intl";
@@ -3263,7 +3259,12 @@ declare module "packages/editor/src/embed/Editor" {
         registerTab(_config: TabConfig): void;
         createPanel(_config: PanelConfig): void;
         createViewer(_config: ViewerConfig): void;
-        createWidget(_config: WidgetConfig): void;
+        createWidget<const S extends Record<string, unknown>>(_config: {
+            schema: S;
+            mount: WidgetMountFn<InferSchemaType<S>>;
+            render: WidgetRenderFn<InferSchemaType<S>>;
+        }): void;
+        createWidget<Value = unknown>(_config: WidgetConfig<Value>): void;
     }
 }
 declare module "packages/editor/src/embed/index" {

package/package.json

@@ -1,5 +1,5 @@
 {
   "name": "unlayer-types",
-  "version": "1.398.0",
+  "version": "1.399.0",
   "license": "MIT"
 }