@wix/editor 1.490.0 → 1.492.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, ComponentRef, ElementStyleDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementDataDefinitions, ElementData, ElementDataInput, ElementPresetDefinitions, ElementStateDefinitions, SelectFontParams, IFontFamilyAndWeight, SelectFontFamilyParams, IFontFamily, SelectMediaParams, SelectLinkParams, ElementLink, SelectColorParams, BackgroundPickerOptions, SelectFontWeightParams, IFontWeight, SelectTextThemeParams, DsItem, BuilderStyle, StyleRef, OpenLinkPanelFn, OpenColorPickerFn, ListProvidersOptions, Provider, BindingProperties, UnbindAll, ListBindingsOptions, BindingTargetDetails, BindingCandidate, SelectBindingOptions } from '@wix/public-editor-platform-interfaces';
+import { IElement, ComponentRef, ElementStyleDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementDataDefinitions, ElementData, ElementDataInput, ElementPresetDefinitions, ElementStateDefinitions, ElementLink, BackgroundPickerOptions, DsItem, BuilderStyle, StyleRef, OpenLinkPanelFn, OpenColorPickerFn, ListProvidersOptions, Provider, BindingProperties, UnbindAll, ListBindingsOptions, BindingTargetDetails, BindingCandidate, SelectBindingOptions } 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 } from '@wix/public-editor-platform-interfaces';
 
 declare class Workspace implements NonNullable<WorkspaceHost$1['workspace']> {
@@ -134,6 +134,31 @@ declare class ModalsSDKShape extends BaseSDKShape {
 }
 declare const _default$6: 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.
  *
@@ -153,28 +178,10 @@ declare const _default$6: ModalsSDKShape & _wix_sdk_runtime_host_modules.HostMod
  * }
  * ```
  */
-declare class ElementSDKShape extends BaseSDKShape implements IElement {
-    #private;
+declare class ElementSDKShape extends BaseSDKShape {
     protected overriddenApplicationContext: Promise<ApplicationContext> | null;
     private childPath;
-    readonly type: string | null;
-    readonly compRef?: unknown;
-    constructor(overriddenApplicationContext?: Promise<ApplicationContext> | null, childPath?: number[], overrides?: {
-        manifestContextId?: string;
-        type?: string;
-        compRef?: unknown;
-    });
-    protected getManifestContextId(): Promise<string | null | undefined>;
-    /**
-     * Reads a single data-item value by key. Equivalent to `(await getData())[prop]`.
-     * Provided for interface parity with elements.getSelection() results.
-     */
-    getProp<T = unknown>(prop: string): Promise<T | null | undefined | void>;
-    /**
-     * Writes a single data-item value by key. Equivalent to
-     * `setData({ [prop]: value })`. Other data items are left unchanged.
-     */
-    setProp<T = unknown>(prop: string, value: T | null | undefined): Promise<void>;
+    constructor(overriddenApplicationContext?: Promise<ApplicationContext> | null, childPath?: number[]);
     /**
      * Retrieves the style definitions declared in the component's manifest,
      * including `cssProperties` and `cssCustomProperties`.
@@ -470,7 +477,15 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      * });
      * ```
      */
-    selectFont(params: SelectFontParams): Promise<IFontFamilyAndWeight | undefined>;
+    selectFont(params: {
+        styleItemKey: string;
+    } | {
+        selectedFontFamily?: IFontFamilyAndWeight;
+        target?: HTMLElement;
+        panelOptions?: IPanelOptions;
+        onChange?: (value: IFontFamilyAndWeight) => void;
+        onPreview?: (value: IFontFamilyAndWeight) => void;
+    }): Promise<any>;
     /**
      * Opens the font family picker for selecting a font family without
      * weight options. Works the same as {@link selectFont} but without
@@ -491,7 +506,15 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      * });
      * ```
      */
-    selectFontFamily(params: SelectFontFamilyParams): Promise<IFontFamily | undefined>;
+    selectFontFamily(params: {
+        styleItemKey: string;
+    } | {
+        selectedFontFamily?: IFontFamily;
+        target?: HTMLElement;
+        panelOptions?: IPanelOptions;
+        onChange?: (value: IFontFamily) => void;
+        onPreview?: (value: IFontFamily) => void;
+    }): Promise<any>;
     /**
      * Opens the media picker for selecting images, videos, or other media
      * from the Wix Media Manager.
@@ -514,7 +537,12 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      * });
      * ```
      */
-    selectMedia(params: SelectMediaParams): Promise<any>;
+    selectMedia(params: {
+        dataItemKey: string;
+    } | {
+        isMultiSelect?: boolean;
+        category?: string;
+    }): Promise<any>;
     /**
      * Opens the link picker for creating or editing a link.
      *
@@ -536,7 +564,15 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      * });
      * ```
      */
-    selectLink(params: SelectLinkParams): Promise<ElementLink | null | undefined>;
+    selectLink(params: {
+        dataItemKey: string;
+        options?: ISelectLinkSharedOptions;
+    } | {
+        value?: ElementLink;
+        options?: ISelectLinkSharedOptions & {
+            linkTypes?: string[];
+        };
+    }): Promise<ElementLink | null | undefined>;
     /**
      * Opens the color picker for selecting a color.
      *
@@ -561,7 +597,27 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      * });
      * ```
      */
-    selectColor(params: SelectColorParams): Promise<any>;
+    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>;
     /**
      * Opens the background picker for selecting a background fill
      * (color, gradient, or image).
@@ -605,7 +661,16 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      * });
      * ```
      */
-    selectFontWeight(params: SelectFontWeightParams): Promise<IFontWeight>;
+    selectFontWeight(params: {
+        fontFamilyStyleItemKey: string;
+        fontWeightStyleItemKey: string;
+    } | {
+        fontStyleItemKey: string;
+    } | {
+        fontFamily?: IFontFamily;
+        target?: HTMLElement;
+        onChange?: (value: IFontWeight) => void;
+    }): Promise<IFontWeight>;
     /**
      * Opens the text theme picker for selecting a predefined text theme
      * (a combination of font and color from the site's theme).
@@ -624,7 +689,13 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      * });
      * ```
      */
-    selectTextTheme(params: SelectTextThemeParams): Promise<any>;
+    selectTextTheme(params: {
+        target?: HTMLElement;
+        initialValue?: {
+            font?: string;
+            color?: string;
+        };
+    }): Promise<any>;
     /**
      * Retrieves the currently selected index in an array items data group.
      *
@@ -689,6 +760,7 @@ declare class ElementSDKShape extends BaseSDKShape implements IElement {
      */
     getBiToken(): Promise<string>;
 }
+
 declare const _default$5: ElementSDKShape & _wix_sdk_runtime_host_modules.HostModule<ElementSDKShape, _wix_sdk_types.Host>;
 
 declare class PreferencesSDKShape extends BaseSDKShape {
@@ -796,4 +868,4 @@ declare const editor: {
     };
 };
 
-export { BaseSDKShape, ElementSDKShape, PlatformSDKShape, Workspace, WorkspaceHost, _default$d as application, bindingsPublicSDKShape as bindings, _default as bindingsProviders, _default$1 as cmsBindings, _default$2 as controllers, editor, _default$5 as element, _default$c as elements, _default$b as events, _default$3 as externalPanels, _default$a as info, _default$8 as inputs, _default$6 as modals, _default$7 as panels, _default$4 as preferences, providersPublicSDKShape as providers, _default$9 as widget };
+export { BaseSDKShape, ElementSDKShape, PlatformSDKShape, ElementSDKShape as ReactElementsSDKShape, Workspace, WorkspaceHost, _default$d as application, bindingsPublicSDKShape as bindings, _default as bindingsProviders, _default$1 as cmsBindings, _default$2 as controllers, editor, _default$5 as element, _default$c as elements, _default$b as events, _default$3 as externalPanels, _default$a as info, _default$8 as inputs, _default$6 as modals, _default$7 as panels, _default$4 as preferences, providersPublicSDKShape as providers, _default$5 as reactElements, _default$9 as widget };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/editor",
-  "version": "1.490.0",
+  "version": "1.492.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Editor Platform <editor-platform-dev@wix.com>",
@@ -31,13 +31,13 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/editor-platform-contexts": "1.99.0",
-    "@wix/editor-platform-environment-api": "1.100.0",
+    "@wix/editor-platform-contexts": "1.100.0",
+    "@wix/editor-platform-environment-api": "1.101.0",
     "@wix/monitoring-browser-sdk-host": "^0.1.8",
     "@wix/public-editor-platform-errors": "1.9.0",
-    "@wix/public-editor-platform-interfaces": "1.42.0",
+    "@wix/public-editor-platform-interfaces": "1.43.0",
     "@wix/sdk-runtime": "^0.7.0",
-    "@wix/sdk-types": "^1.14.0",
+    "@wix/sdk-types": "^1.17.7",
     "@wix/workspace": "^1.3.1"
   },
   "devDependencies": {
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "falconPackageHash": "015a8f4d2ffdb912e02e90e2f521c4525a628593501fc048ca0291b0"
+  "falconPackageHash": "80b987a5a1035a102955283e2334c8211f4b00ec9aad2251a125d031"
 }