@wix/editor 1.477.0 → 1.479.0

package/dist/types/index.d.ts

@@ -4,7 +4,7 @@ import { WorkspaceHost as WorkspaceHost$1, AppsNamespace } from '@wix/workspace'
 import * as _wix_sdk_types from '@wix/sdk-types';
 import { Host } from '@wix/sdk-types';
 import * as _wix_editor_platform_transport from '@wix/editor-platform-transport';
-import { IElement, ComponentRef, ElementStyleDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementDataDefinitions, ElementData, ElementDataInput, ElementPresetDefinitions, ElementStateDefinitions, ElementLink, BackgroundPickerOptions, DsItem, BuilderStyle, StyleRef, OpenLinkPanelFn, OpenColorPickerFn, ListProvidersOptions, Provider, BindingProperties, UnbindAll, ListBindingsOptions } from '@wix/public-editor-platform-interfaces';
+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 } 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']> {
@@ -133,31 +133,6 @@ declare class ModalsSDKShape extends BaseSDKShape {
 }
 declare const _default$6: ModalsSDKShape & _wix_sdk_types.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.
  *
@@ -177,10 +152,28 @@ type IPanelOptions = {
  * }
  * ```
  */
-declare class ElementSDKShape extends BaseSDKShape {
+declare class ElementSDKShape extends BaseSDKShape implements IElement {
+    #private;
     protected overriddenApplicationContext: Promise<ApplicationContext> | null;
     private childPath;
-    constructor(overriddenApplicationContext?: Promise<ApplicationContext> | null, childPath?: number[]);
+    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>;
     /**
      * Retrieves the style definitions declared in the component's manifest,
      * including `cssProperties` and `cssCustomProperties`.
@@ -476,15 +469,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      * });
      * ```
      */
-    selectFont(params: {
-        styleItemKey: string;
-    } | {
-        selectedFontFamily?: IFontFamilyAndWeight;
-        target?: HTMLElement;
-        panelOptions?: IPanelOptions;
-        onChange?: (value: IFontFamilyAndWeight) => void;
-        onPreview?: (value: IFontFamilyAndWeight) => void;
-    }): Promise<any>;
+    selectFont(params: SelectFontParams): Promise<IFontFamilyAndWeight | undefined>;
     /**
      * Opens the font family picker for selecting a font family without
      * weight options. Works the same as {@link selectFont} but without
@@ -505,15 +490,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      * });
      * ```
      */
-    selectFontFamily(params: {
-        styleItemKey: string;
-    } | {
-        selectedFontFamily?: IFontFamily;
-        target?: HTMLElement;
-        panelOptions?: IPanelOptions;
-        onChange?: (value: IFontFamily) => void;
-        onPreview?: (value: IFontFamily) => void;
-    }): Promise<any>;
+    selectFontFamily(params: SelectFontFamilyParams): Promise<IFontFamily | undefined>;
     /**
      * Opens the media picker for selecting images, videos, or other media
      * from the Wix Media Manager.
@@ -536,12 +513,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      * });
      * ```
      */
-    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.
      *
@@ -563,15 +535,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      * });
      * ```
      */
-    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.
      *
@@ -596,27 +560,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).
@@ -660,16 +604,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      * });
      * ```
      */
-    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).
@@ -688,13 +623,7 @@ declare class ElementSDKShape extends BaseSDKShape {
      * });
      * ```
      */
-    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.477.0",
+  "version": "1.479.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Editor Platform <editor-platform-dev@wix.com>",
@@ -31,11 +31,11 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/editor-platform-contexts": "1.96.0",
-    "@wix/editor-platform-environment-api": "1.97.0",
+    "@wix/editor-platform-contexts": "1.97.0",
+    "@wix/editor-platform-environment-api": "1.98.0",
     "@wix/monitoring-browser-sdk-host": "^0.1.8",
     "@wix/public-editor-platform-errors": "1.9.0",
-    "@wix/public-editor-platform-interfaces": "1.39.0",
+    "@wix/public-editor-platform-interfaces": "1.40.0",
     "@wix/sdk-runtime": "^0.7.0",
     "@wix/sdk-types": "^1.14.0",
     "@wix/workspace": "^1.3.1"
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "falconPackageHash": "e7d8f40ce3d89b996645408c49500420bf39d50cec28c3e43448acf0"
+  "falconPackageHash": "d6ae6b7d87cb5a00afdff75bd971fdd50dad88d821cbe0c2809a2f8f"
 }