@unlayer/types 1.397.0 → 1.399.0

package/dist/containers/body.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterName, Variant } from '../editor/types';
 
 type BodyValuesBase = {
   _styleGuide: string;
@@ -147,8 +147,6 @@ export type BodyValues<
       ? BodyValuesForDocument
       : never;
 
-import type { Variant } from '../editor/types';
-
 type BodyExporter = (
   innerHTML: string,
   bodyValues: Record<string, any>, // @deprecated use last param instead

package/dist/containers/column.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterName, Variant } from '../editor/types';
 
 type ColumnValuesBase = {
   border: {
@@ -60,7 +60,6 @@ export type ColumnValues<
 
 import type { BodyValues } from '../containers/body';
 import type { RowValues } from '../containers/row';
-import type { Variant } from '../editor/types';
 
 type ColumnExporter = (
   innerHTML: string,

package/dist/containers/content.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { Device, DisplayMode, ExporterConfig, ExporterName, Variant } from '../editor/types';
 
 export type ContentValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -33,7 +33,6 @@ import type { BodyValues } from '../containers/body';
 import type { ColumnValues } from '../containers/column';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig, Variant } from '../editor/types';
 
 type ContentExporter = (
   innerHTML: string,

package/dist/containers/row.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { Collection, Device, DisplayMode, ExporterConfig, ExporterName, Variant } from '../editor/types';
 
 type RowValuesBase = {
   [x: string]: unknown;
@@ -79,7 +79,6 @@ export type RowValues<
       : never;
 
 import type { BodyValues } from '../containers/body';
-import type { Collection, ExporterConfig, Variant } from '../editor/types';
 
 type RowExporter = (
   innerHTML: string,

package/dist/design.d.ts

@@ -53,9 +53,18 @@ type DesignContentItemOf<
   values: TValues & ContentValues<TDisplayMode>;
 };
 
+type DesignCustomContentItem<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  id?: string;
+  type: 'custom';
+  slug: string;
+  values: ContentValues<TDisplayMode> & Record<string, unknown>;
+};
+
 export type DesignContentType = keyof ContentToolValuesMap | (string & {});
 
-export type DesignContentItem<
+type DesignBuiltInContentItem<
   TDisplayMode extends DisplayMode | undefined = undefined,
 > = {
   [K in keyof ContentToolValuesMap<TDisplayMode>]: DesignContentItemOf<
@@ -65,6 +74,12 @@ export type DesignContentItem<
   >;
 }[keyof ContentToolValuesMap<TDisplayMode>];
 
+export type DesignContentItem<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> =
+  | DesignBuiltInContentItem<TDisplayMode>
+  | DesignCustomContentItem<TDisplayMode>;
+
 export type DesignColumn<
   TDisplayMode extends DisplayMode | undefined = undefined,
 > = {

package/dist/editor/config.d.ts

@@ -39,3 +39,57 @@ export type User = {
     email?: string;
     signature?: string;
 };
+
+type JSONSchema = Record<string, unknown>;
+
+type InferSchemaType<S> = S extends { readonly type: 'string' }
+  ? string
+  : S extends { readonly type: 'number' | 'integer' }
+    ? number
+    : S extends { readonly type: 'boolean' }
+      ? boolean
+      : S extends { readonly type: 'array'; readonly items: infer I }
+        ? InferSchemaType<I>[]
+        : S extends { readonly type: 'array' }
+          ? unknown[]
+          : S extends {
+                readonly type: 'object';
+                readonly properties: infer P extends Record<string, unknown>;
+              }
+            ? { -readonly [K in keyof P]: InferSchemaType<P[K]> }
+            : unknown;
+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;
+}

package/dist/editor/editor.d.ts

@@ -1,7 +1,7 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
 import type { Audit, Validator } from './audit';
-import type { EditorSettings, SafeHtmlOptions, Tabs, User } from './config';
+import type { EditorSettings, InferSchemaType, SafeHtmlOptions, Tabs, User, WidgetConfig, WidgetMountFn, WidgetRenderFn } from './config';
 import type { DesignMode, DesignTags, DesignTagsConfig, JSONTemplate } from './design';
 import type { DisplayConditions } from './display-conditions';
 import type { ExportFromApiResult, ExportHtmlOptions, ExportHtmlResult, ExportImageFromApiOptions, ExportLiveHtmlOptions, ExportLiveHtmlResult, ExportPdfFromApiOptions, ExportPlainTextOptions, ExportPlainTextResult, ExportZipFromApiOptions, SaveDesignOptions } from './export';
@@ -16,13 +16,7 @@ import type { CallbackTypeMap, Collection, Device, DisplayMode, ExporterConfig,
 import type { DeepPartial, LanguagesValue } from './utils';
 import type { BodyValues } from '../containers/body';
 import type { ColumnValues } from '../containers/column';
-
-type RowValues = any;
-
-/**
- * Server-safe configuration for exporters.
- * Passed via meta to allow dependency injection instead of importing config directly.
- */
+import type { RowValues } from '../containers/row';
 
 export type Container = 'body' | 'row' | 'column' | 'content';
 
@@ -295,7 +289,12 @@ declare class EditorClass<TClassDisplayMode extends DisplayMode | undefined = un
     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 class Embed extends EditorClass {
@@ -359,7 +358,7 @@ export type OptionGroupEmbeddedConfig<Values extends ValueMap = ValueMap> = {
 export type OptionGroupConfig<Values extends ValueMap = ValueMap> = {
     rightLabel?: string;
     title: string | null;
-    dynamicTitle?: (state: RootState) => string | undefined;
+    dynamicTitle?: (state: Record<string, any>) => string | undefined;
     icon?: string | string[];
     position?: number;
     supportedDesignModes?: DesignMode[];
@@ -471,11 +470,6 @@ export interface ViewerConfig {
     render: ViewerRenderFn;
 }
 
-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;
-}
+type WidgetComponentClass = any & {
+    schema?: Record<string, unknown> | null;
+};

package/dist/tools/button.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type ButtonValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -80,7 +80,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type ButtonExporter = (
   renderValues: ContentValues & ButtonValues,

package/dist/tools/carousel.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type CarouselValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -22,7 +22,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type CarouselExporter = (
   renderValues: ContentValues & CarouselValues,

package/dist/tools/divider.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type DividerValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -24,7 +24,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type DividerExporter = (
   renderValues: ContentValues & DividerValues,

package/dist/tools/form.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type FormValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -128,7 +128,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type FormExporter = (
   renderValues: ContentValues & FormValues,

package/dist/tools/heading.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type HeadingValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -49,7 +49,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type HeadingExporter = (
   renderValues: ContentValues & HeadingValues,

package/dist/tools/html.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type HtmlValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -18,7 +18,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type HtmlExporter = (
   renderValues: ContentValues & HtmlValues,

package/dist/tools/image.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type ImageValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -45,7 +45,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type ImageExporter = (
   renderValues: ContentValues & ImageValues,

package/dist/tools/menu.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type MenuValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -61,7 +61,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type MenuExporter = (
   renderValues: ContentValues & MenuValues,

package/dist/tools/page-break.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type PageBreakValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -27,7 +27,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type PageBreakExporter = (
   renderValues: ContentValues & PageBreakValues,

package/dist/tools/paragraph.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type ParagraphValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -46,7 +46,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type ParagraphExporter = (
   renderValues: ContentValues & ParagraphValues,

package/dist/tools/social.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type SocialValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -28,7 +28,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type SocialExporter = (
   renderValues: ContentValues & SocialValues,

package/dist/tools/table.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type TableValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -148,7 +148,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type TableExporter = (
   renderValues: ContentValues & TableValues,

package/dist/tools/text.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type TextValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -46,7 +46,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type TextExporter = (
   renderValues: ContentValues & TextValues,

package/dist/tools/timer.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type TimerValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -57,7 +57,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type TimerExporter = (
   renderValues: ContentValues & TimerValues,

package/dist/tools/video.d.ts

@@ -1,6 +1,6 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
-import type { DisplayMode, ExporterName } from '../editor/types';
+import type { DisplayMode, ExporterConfig, ExporterName } from '../editor/types';
 
 export type VideoValues<
   TDisplayMode extends DisplayMode | undefined = undefined,
@@ -42,7 +42,6 @@ import type { ColumnValues } from '../containers/column';
 import type { ContentValues } from '../containers/content';
 import type { RowValues } from '../containers/row';
 import type { MergeTagsValues } from '../editor/merge-tags';
-import type { ExporterConfig } from '../editor/types';
 
 type VideoExporter = (
   renderValues: ContentValues & VideoValues,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unlayer/types",
-  "version": "1.397.0",
+  "version": "1.399.0",
   "license": "MIT",
   "private": false,
   "types": "./dist/index.d.ts",