@wix/editor 1.561.0 → 1.563.0

package/dist/types/index.d.ts

@@ -5,7 +5,7 @@ import * as _wix_sdk_types from '@wix/sdk-types';
 import { Host } from '@wix/sdk-types';
 import * as _wix_sdk_runtime_host_modules from '@wix/sdk-runtime/host-modules';
 import * as _wix_editor_platform_transport from '@wix/editor-platform-transport';
-import { IElement, SiteLocale, ComponentRef, ElementStyleDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementDataDefinitions, ElementData, ElementDataInput, ElementPresetDefinitions, ElementStateDefinitions, ElementLink, BackgroundPickerOptions, DsItem, BuilderStyle, StyleRef, OpenLinkPanelFn, OpenColorPickerFn, ListProvidersOptions, Provider, BindingProperties, BindingDetailsMap, UnbindAll, ListBindingsOptions, BindingTargetDetails, findBindingCandidatesOptions, BindingCandidate, SelectBindingOptions, IRouter, IPage, AddTemplateOptions, AddExtensionOptions } from '@wix/public-editor-platform-interfaces';
+import { IElement, SiteLocale, ComponentRef, IElementSDK, ElementStyleDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementDataDefinitions, ElementData, ElementDataInput, ElementPresetDefinitions, ElementStateDefinitions, SelectFontParams, SelectFontFamilyParams, SelectMediaParams, SelectLinkParams, ElementLink, SelectColorParams, BackgroundPickerOptions, SelectFontWeightParams, IFontWeight, SelectTextThemeParams, DsItem, BuilderStyle, StyleRef, OpenLinkPanelFn, OpenColorPickerFn, ListProvidersOptions, Provider, BindingProperties, BindingDetailsMap, UnbindAll, ListBindingsOptions, BindingTargetDetails, findBindingCandidatesOptions, BindingCandidate, SelectBindingOptions, IRouter, IPage, AddTemplateOptions, AddExtensionOptions } from '@wix/public-editor-platform-interfaces';
 export { DataType, ElementA11y, ElementAddressLink, ElementAnchorLink, ElementAudio, ElementData, ElementDataDefinition, ElementDataDefinitions, ElementDataInput, ElementDataObject, ElementDataValue, ElementDirection, ElementDocumentLink, ElementDynamicPageLink, ElementEmailLink, ElementExternalLink, ElementImage, ElementLink, ElementLoginToWixLink, ElementMenuItems, ElementPageLink, ElementPhoneLink, ElementPresetDefinition, ElementPresetDefinitions, ElementRichText, ElementStateDefinition, ElementStateDefinitions, ElementStyleDefinition, ElementStyleDefinitions, ElementStyles, ElementStylesRemoval, ElementStylesUpdate, ElementTextLink, ElementTpaPageLink, ElementVectorArt, ElementVideo, ElementWhatsAppLink, NativeStateType, SiteLocale } from '@wix/public-editor-platform-interfaces';
 
 declare class Workspace implements NonNullable<WorkspaceHost$1['workspace']> {
@@ -139,31 +139,6 @@ declare class ModalsSDKShape extends BaseSDKShape {
 }
 declare const _default$8: ModalsSDKShape & _wix_sdk_runtime_host_modules.HostModule<ModalsSDKShape, _wix_sdk_types.Host>;
 
-/** Represents a font family and its weight. */
-interface IFontFamily {
-    /** The font family name. For example, 'Arial' or 'Helvetica Neue'. */
-    family: string;
-    /** The font weight. For example, '400' or 'bold'. */
-    weight: string;
-}
-/** Represents a font weight value. */
-interface IFontWeight {
-    /** The font weight. For example, '400' or 'bold'. */
-    weight: string;
-}
-/** Combination of font family and weight properties. */
-type IFontFamilyAndWeight = IFontFamily & IFontWeight;
-type ISelectLinkSharedOptions = {
-    /** Identifier for the origin of the link selection (used for BI tracking). */
-    origin?: string;
-};
-/** Options for positioning a picker panel relative to a target element. */
-type IPanelOptions = {
-    /** Where to place the picker panel relative to the target element. */
-    placement?: 'top' | 'bottom' | 'top-start' | 'bottom-start' | 'top-end' | 'bottom-end';
-    /** Vertical offset in pixels to shift the panel from its computed position. */
-    YShift?: number;
-};
 /**
  * Methods for interacting with a component from a custom panel.
  *
@@ -183,7 +158,7 @@ type IPanelOptions = {
  * }
  * ```
  */
-declare class ElementSDKShape extends BaseSDKShape {
+declare class ElementSDKShape extends BaseSDKShape implements IElementSDK {
     protected overriddenApplicationContext: Promise<ApplicationContext> | null;
     private childPath;
     constructor(overriddenApplicationContext?: Promise<ApplicationContext> | null, childPath?: number[]);
@@ -256,9 +231,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      */
     removeStyles(values?: ElementStylesRemoval): Promise<void>;
     /**
-     * Retrieves the data item definitions declared in the component's manifest.
+     * Lists the data fields defined on the selected component's manifest.
      *
-     * @returns Data item definitions keyed by data item key.
+     * Each key in the result is a valid **`dataItemKey`** for `getData`, `setData`, and `getResolvedData`.
+     *
+     * @returns Definitions keyed by `dataItemKey`.
      *
      * @example
      * ```ts
@@ -283,19 +260,21 @@ declare class ElementSDKShape extends BaseSDKShape {
      */
     getData<T extends ElementData = ElementData>(): Promise<T>;
     /**
-     * Retrieves the resolved value of a specific data item.
+     * Returns one data field from the selected component by **`dataItemKey`**.
+     *
+     * A **`dataItemKey`** is the property name of a data field in that component's manifest — the same names
+     * returned from `getDataDefinitions`. Example: `'heroImage'` for a field declared under `editorElement.data`.
      *
-     * Unlike {@link getData}, this method returns the fully resolved value
-     * for a single data item.
+     * `getData` returns all fields at once. This method returns only the field you name.
      *
-     * @param options - Object containing the `dataItemKey` to resolve.
-     * @returns Resolved value for the specified data item.
+     * @param options.dataItemKey - Key of the data field to read. Must exist on the component manifest.
+     * @returns Value for that data field.
      *
      * @example
      * ```ts
      * import { reactElements } from '@wix/editor';
      *
-     * const resolved = await reactElements.getResolvedData({
+     * const hero = await reactElements.getResolvedData({
      *   dataItemKey: 'heroImage',
      * });
      * ```
@@ -321,7 +300,7 @@ declare class ElementSDKShape extends BaseSDKShape {
     /**
      * Retrieves the preset definitions declared in the component's manifest.
      *
-     * @returns Preset definitions keyed by preset key.
+     * @returns An object mapping each preset key to its definition.
      *
      * @example
      * ```ts
@@ -396,7 +375,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      */
     getDisplayName(): Promise<any>;
     /**
-     * Retrieves the currently active state for the component.
+     * Retrieves the active state for the component.
      *
      * @returns Key of the active state, or `null` if the default state is active.
      *
@@ -427,7 +406,7 @@ declare class ElementSDKShape extends BaseSDKShape {
     /**
      * Retrieves the state definitions declared in the component's manifest.
      *
-     * @returns State definitions keyed by state key.
+     * @returns An object mapping each state key to its definition.
      *
      * @example
      * ```ts
@@ -462,137 +441,90 @@ declare class ElementSDKShape extends BaseSDKShape {
         value: unknown;
     }) => void): Promise<() => {}>;
     /**
-     * Opens the font picker for selecting a font family and weight.
+     * Opens the font picker for selecting a font family and weight from a custom panel.
      *
-     * Pass `styleItemKey` to bind the picker to a manifest style item,
-     * or pass manual options to handle the selection via callbacks.
+     * Pass `target` and `panelOptions` to position the popup next to the control that opened it.
+     * Use `onChange` / `onPreview` to handle the selection; the editor does not write to the manifest for you.
      *
-     * @param params - `styleItemKey` for manifest binding, or manual picker options.
+     * @param params - Picker options.
      * @returns Selected font family and weight, or `undefined` if dismissed.
      *
      * @example
      * ```ts
      * import { reactElements } from '@wix/editor';
      *
-     * const font = await reactElements.selectFont({ styleItemKey: 'headingFont' });
-     *
      * const font = await reactElements.selectFont({
      *   selectedFontFamily: { family: 'Arial', weight: '400' },
+     *   target: buttonRef.current,
      *   onChange: (value) => console.log('Selected:', value),
      * });
      * ```
      */
-    selectFont(params: {
-        styleItemKey: string;
-    } | {
-        selectedFontFamily?: IFontFamilyAndWeight;
-        target?: HTMLElement;
-        panelOptions?: IPanelOptions;
-        onChange?: (value: IFontFamilyAndWeight) => void;
-        onPreview?: (value: IFontFamilyAndWeight) => void;
-    }): Promise<any>;
+    selectFont(params: SelectFontParams): Promise<any>;
     /**
-     * Opens the font family picker for selecting a font family without
-     * weight options. Works the same as {@link selectFont} but without
-     * the weight selector.
+     * Opens the font family picker without weight selection, from a custom panel.
      *
-     * @param params - `styleItemKey` for manifest binding, or manual picker options.
+     * Same pattern as {@link selectFont}: `target`, `panelOptions`, and callbacks.
+     *
+     * @param params - Picker options.
      * @returns Selected font family, or `undefined` if dismissed.
      *
      * @example
      * ```ts
      * import { reactElements } from '@wix/editor';
      *
-     * const font = await reactElements.selectFontFamily({ styleItemKey: 'bodyFont' });
-     *
      * const font = await reactElements.selectFontFamily({
      *   selectedFontFamily: { family: 'Helvetica', weight: '400' },
+     *   target: buttonRef.current,
      *   onChange: (value) => console.log('Selected:', value.family),
      * });
      * ```
      */
-    selectFontFamily(params: {
-        styleItemKey: string;
-    } | {
-        selectedFontFamily?: IFontFamily;
-        target?: HTMLElement;
-        panelOptions?: IPanelOptions;
-        onChange?: (value: IFontFamily) => void;
-        onPreview?: (value: IFontFamily) => void;
-    }): Promise<any>;
+    selectFontFamily(params: SelectFontFamilyParams): Promise<any>;
     /**
-     * Opens the media picker for selecting images, videos, or other media
-     * from the Wix Media Manager.
-     *
-     * Pass `dataItemKey` to bind the picker to a manifest data item,
-     * or pass manual options to configure the picker.
+     * Opens the media picker for selecting images, videos, or other media from a custom panel.
      *
-     * @param params - `dataItemKey` for manifest binding, or manual picker options.
+     * @param params - Picker options.
      * @returns Selected media items.
      *
      * @example
      * ```ts
      * import { reactElements } from '@wix/editor';
      *
-     * const media = await reactElements.selectMedia({ dataItemKey: 'heroImage' });
-     *
      * const media = await reactElements.selectMedia({
      *   isMultiSelect: true,
      *   category: 'image',
      * });
      * ```
      */
-    selectMedia(params: {
-        dataItemKey: string;
-    } | {
-        isMultiSelect?: boolean;
-        category?: string;
-    }): Promise<any>;
+    selectMedia(params: SelectMediaParams): Promise<any>;
     /**
-     * Opens the link picker for creating or editing a link.
+     * Opens the link picker for creating or editing a link from a custom panel.
      *
-     * Pass `dataItemKey` to bind the picker to a manifest data item,
-     * or pass a `value` and optional `linkTypes` to configure manually.
-     *
-     * @param params - `dataItemKey` for manifest binding, or manual picker options.
+     * @param params - Picker options.
      * @returns Selected link, or `null`/`undefined` if dismissed.
      *
      * @example
      * ```ts
      * import { reactElements } from '@wix/editor';
      *
-     * const link = await reactElements.selectLink({ dataItemKey: 'buttonLink' });
-     *
      * const link = await reactElements.selectLink({
      *   value: currentLink,
      *   options: { linkTypes: ['ExternalLink', 'PageLink'] },
      * });
      * ```
      */
-    selectLink(params: {
-        dataItemKey: string;
-        options?: ISelectLinkSharedOptions;
-    } | {
-        value?: ElementLink;
-        options?: ISelectLinkSharedOptions & {
-            linkTypes?: string[];
-        };
-    }): Promise<ElementLink | null | undefined>;
+    selectLink(params: SelectLinkParams): Promise<ElementLink | null | undefined>;
     /**
-     * Opens the color picker for selecting a color.
+     * Opens the color picker for selecting a color from a custom panel.
      *
-     * Pass `styleItemKey` to bind the picker to a manifest style item,
-     * or pass manual options to configure the picker.
-     *
-     * @param params - `styleItemKey` for manifest binding, or manual picker options.
+     * @param params - Picker options.
      * @returns Selected color value, or `undefined` if dismissed.
      *
      * @example
      * ```ts
      * import { reactElements } from '@wix/editor';
      *
-     * const color = await reactElements.selectColor({ styleItemKey: 'backgroundColor' });
-     *
      * const color = await reactElements.selectColor({
      *   initialValue: '#ff0000',
      *   mode: ['solid', 'gradient'],
@@ -602,27 +534,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      * });
      * ```
      */
-    selectColor(params: {
-        styleItemKey: string;
-    } | {
-        initialValue?: string;
-        mode?: ('solid' | 'gradient')[];
-        showBrand?: boolean;
-        showCustom?: boolean;
-        showAdvancedSettings?: boolean;
-        showOpacity?: boolean;
-        position?: {
-            x: number;
-            y: number;
-        };
-        biData?: {
-            origin: string;
-        };
-        onChange?: (color: string) => void;
-        onApply?: (color: string) => void;
-        onClose?: () => void;
-        onCancel?: () => void;
-    }): Promise<any>;
+    selectColor(params: SelectColorParams): Promise<any>;
     /**
      * Opens the background picker for selecting a background fill
      * (color, gradient, or image).
@@ -642,13 +554,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      */
     selectBackground(options: BackgroundPickerOptions): Promise<any>;
     /**
-     * Opens the font weight picker for selecting a font weight for a specified
-     * font family.
-     *
-     * Pass manifest style item keys to bind the picker, or pass manual
-     * options to handle the selection via callbacks.
+     * Opens the font weight picker for a specified font family, from a custom panel.
      *
-     * @param params - Manifest style item keys, or manual picker options.
+     * @param params - Picker options.
      * @returns Selected font weight.
      *
      * @example
@@ -656,32 +564,17 @@ declare class ElementSDKShape extends BaseSDKShape {
      * import { reactElements } from '@wix/editor';
      *
      * const weight = await reactElements.selectFontWeight({
-     *   fontFamilyStyleItemKey: 'headingFontFamily',
-     *   fontWeightStyleItemKey: 'headingFontWeight',
-     * });
-     *
-     * const weight = await reactElements.selectFontWeight({
      *   fontFamily: { family: 'Arial', weight: '400' },
+     *   target: buttonRef.current,
      *   onChange: (value) => console.log('Selected weight:', value.weight),
      * });
      * ```
      */
-    selectFontWeight(params: {
-        fontFamilyStyleItemKey: string;
-        fontWeightStyleItemKey: string;
-    } | {
-        fontStyleItemKey: string;
-    } | {
-        fontFamily?: IFontFamily;
-        target?: HTMLElement;
-        onChange?: (value: IFontWeight) => void;
-    }): Promise<IFontWeight>;
+    selectFontWeight(params: SelectFontWeightParams): Promise<IFontWeight>;
     /**
-     * Opens the text theme picker for selecting a predefined text theme
-     * (a combination of font and color from the site's theme).
+     * Opens the text theme picker from a custom panel — a site theme combination of font and color.
      *
-     * @param params - Text theme picker configuration.
-     * @param params.target - HTML element to anchor the picker to.
+     * @param params - Picker options. Pass `target` for the element in your panel that opened the picker.
      * @param params.initialValue - Initial font and color values.
      * @returns Selected text theme.
      *
@@ -690,17 +583,12 @@ declare class ElementSDKShape extends BaseSDKShape {
      * import { reactElements } from '@wix/editor';
      *
      * const theme = await reactElements.selectTextTheme({
+     *   target: buttonRef.current,
      *   initialValue: { font: 'Heading 1', color: '#333' },
      * });
      * ```
      */
-    selectTextTheme(params: {
-        target?: HTMLElement;
-        initialValue?: {
-            font?: string;
-            color?: string;
-        };
-    }): Promise<any>;
+    selectTextTheme(params: SelectTextThemeParams): Promise<any>;
     /**
      * Retrieves the currently selected index in an array items data group.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/editor",
-  "version": "1.561.0",
+  "version": "1.563.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Editor Platform <editor-platform-dev@wix.com>",
@@ -25,17 +25,17 @@
     "lint": "prettier --check ./src",
     "lint:fix": "prettier --write ./src",
     "typecheck": "tsc --noEmit",
-    "docs": "docs-ts-model --entryPoint src/element/index.ts"
+    "docs": "docs-ts-model --entryPoint ../public-editor-platform-interfaces/src/Element.ts"
   },
   "lint-staged": {
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/editor-platform-contexts": "1.116.0",
-    "@wix/editor-platform-environment-api": "1.117.0",
+    "@wix/editor-platform-contexts": "1.117.0",
+    "@wix/editor-platform-environment-api": "1.118.0",
     "@wix/monitoring-browser-sdk-host": "^0.1.25",
     "@wix/public-editor-platform-errors": "1.9.0",
-    "@wix/public-editor-platform-interfaces": "1.59.0",
+    "@wix/public-editor-platform-interfaces": "1.60.0",
     "@wix/sdk-runtime": "^0.7.0",
     "@wix/sdk-types": "^1.17.8",
     "@wix/workspace": "^1.3.11"
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "falconPackageHash": "13d9fc6128892b1df425d237539e2b26279e553174192b16e9f01a3f"
+  "falconPackageHash": "df6bc8486e4cea7ca1fd33278a2ae2f82ff049469776285f10543ffd"
 }