@wix/public-editor-platform-interfaces 1.39.0 → 1.40.0

package/dist/Elements.d.ts

@@ -1,11 +1,65 @@
-export interface IElementBase<TType, TProps extends Record<string, any>> {
-    type: TType;
-    getProp: <K extends keyof TProps | string>(prop: K) => Promise<TProps[K] | null | undefined | void>;
-    setProp<K extends keyof TProps>(prop: K, value: TProps[K] | null | undefined): Promise<void>;
+import type { ElementData, ElementDataInput, ElementDataDefinitions, ElementStyles, ElementStylesUpdate, ElementStylesRemoval, ElementStyleDefinitions, ElementPresetDefinitions, ElementStateDefinitions, ElementLink, ElementDataValue } from './sdk';
+import type { BackgroundPickerOptions } from './Inputs';
+import type { SelectFontParams, SelectFontFamilyParams, SelectFontWeightParams, SelectMediaParams, SelectLinkParams, SelectColorParams, SelectTextThemeParams, IFontFamily, IFontWeight, IFontFamilyAndWeight } from './sdk/pickers';
+/**
+ * Unified element interface returned by `elements.getSelection()` (Classic / Studio)
+ * and structurally satisfied by the `element` singleton (Harmony).
+ *
+ * @remarks
+ * In Classic / Studio editors, builder-specific methods (`getStyles`, `getData`,
+ * `applyPreset`, pickers, etc.) return inert empty values. They are functional only
+ * when the component is selected in Harmony (Editor 3).
+ */
+export interface IElement {
+    /** Component type id. Populated in Classic/Studio (text|image|null). Always null in Harmony. */
+    type: string | null;
+    getProp<T = unknown>(prop: string): Promise<T | null | undefined | void>;
+    setProp<T = unknown>(prop: string, value: T | null | undefined): Promise<void>;
+    getData<T extends ElementData = ElementData>(): Promise<T>;
+    setData<T extends ElementData = ElementData>(values: ElementDataInput<T>): Promise<void>;
+    getResolvedData(options: {
+        dataItemKey: string;
+    }): Promise<ElementDataValue>;
+    getDataDefinitions(): Promise<ElementDataDefinitions>;
+    getStyles(): Promise<ElementStyles>;
+    setStyles(values?: ElementStylesUpdate): Promise<void>;
+    removeStyles(values?: ElementStylesRemoval): Promise<void>;
+    getStyleDefinitions(): Promise<ElementStyleDefinitions>;
+    getPresetDefinitions(): Promise<ElementPresetDefinitions>;
+    getAppliedPreset(): Promise<string | null>;
+    applyPreset(options: {
+        key: string;
+    }): Promise<void>;
+    getState(): Promise<string | null>;
+    setState(stateKey: string | null): Promise<void>;
+    getStateDefinitions(): Promise<ElementStateDefinitions>;
+    getDisplayGroupDefinitions(options?: {
+        filter?: {
+            groupType?: string;
+        };
+    }): Promise<Record<string, unknown>>;
+    getDisplayName(): Promise<string>;
+    onChange(callback: (patch: {
+        type: 'styles' | 'data' | 'state' | 'preset' | 'props' | 'manifest';
+        value: unknown;
+    }) => void): Promise<() => void>;
+    selectFont(params: SelectFontParams): Promise<IFontFamilyAndWeight | undefined>;
+    selectFontFamily(params: SelectFontFamilyParams): Promise<IFontFamily | undefined>;
+    selectFontWeight(params: SelectFontWeightParams): Promise<IFontWeight>;
+    selectMedia(params: SelectMediaParams): Promise<unknown>;
+    selectLink(params: SelectLinkParams): Promise<ElementLink | null | undefined>;
+    selectColor(params: SelectColorParams): Promise<string | undefined>;
+    selectBackground(options: BackgroundPickerOptions): Promise<unknown>;
+    selectTextTheme(params: SelectTextThemeParams): Promise<unknown>;
+    getArrayItemsSelectedIndex(options?: {
+        arrayItemsDisplayGroupKey?: string;
+    }): Promise<number>;
+    setArrayItemsSelectedIndex(options: {
+        index: number;
+        arrayItemsDisplayGroupKey?: string;
+    }): Promise<void>;
+    resetArrayItemsSelectedIndex(options?: {
+        arrayItemsDisplayGroupKey?: string;
+    }): Promise<void>;
+    getBiToken(): Promise<string>;
 }
-export type IElement = IElementBase<'text', {
-    text: string;
-}> | IElementBase<'image', {
-    src: string;
-    responsive: boolean;
-}> | IElementBase<null, Record<string, string | number | boolean>>;

package/dist/sdk/index.d.ts

@@ -2,3 +2,4 @@ export * from './data';
 export * from './styles';
 export * from './definitions';
 export * from './css-properties';
+export * from './pickers';

package/dist/sdk/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./data"), exports);
 __exportStar(require("./styles"), exports);
 __exportStar(require("./definitions"), exports);
 __exportStar(require("./css-properties"), exports);
+__exportStar(require("./pickers"), exports);

package/dist/sdk/pickers.d.ts

@@ -0,0 +1,97 @@
+import type { ElementLink } from './data';
+/** Represents a font family and its weight. */
+export 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. */
+export interface IFontWeight {
+    /** The font weight. For example, '400' or 'bold'. */
+    weight: string;
+}
+/** Combination of font family and weight properties. */
+export type IFontFamilyAndWeight = IFontFamily & IFontWeight;
+export 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. */
+export 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;
+};
+export type SelectFontParams = {
+    styleItemKey: string;
+} | {
+    selectedFontFamily?: IFontFamilyAndWeight;
+    target?: HTMLElement;
+    panelOptions?: IPanelOptions;
+    onChange?: (value: IFontFamilyAndWeight) => void;
+    onPreview?: (value: IFontFamilyAndWeight) => void;
+};
+export type SelectFontFamilyParams = {
+    styleItemKey: string;
+} | {
+    selectedFontFamily?: IFontFamily;
+    target?: HTMLElement;
+    panelOptions?: IPanelOptions;
+    onChange?: (value: IFontFamily) => void;
+    onPreview?: (value: IFontFamily) => void;
+};
+export type SelectFontWeightParams = {
+    fontFamilyStyleItemKey: string;
+    fontWeightStyleItemKey: string;
+} | {
+    fontStyleItemKey: string;
+} | {
+    fontFamily?: IFontFamily;
+    target?: HTMLElement;
+    onChange?: (value: IFontWeight) => void;
+};
+export type SelectMediaParams = {
+    dataItemKey: string;
+} | {
+    isMultiSelect?: boolean;
+    category?: string;
+};
+export type SelectLinkParams = {
+    dataItemKey: string;
+    options?: ISelectLinkSharedOptions;
+} | {
+    value?: ElementLink;
+    options?: ISelectLinkSharedOptions & {
+        linkTypes?: string[];
+    };
+};
+export type SelectColorParams = {
+    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;
+};
+export type SelectTextThemeParams = {
+    target?: HTMLElement;
+    initialValue?: {
+        font?: string;
+        color?: string;
+    };
+};

package/dist/sdk/pickers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/public-editor-platform-interfaces",
-  "version": "1.39.0",
+  "version": "1.40.0",
   "license": "UNLICENSED",
   "contributors": [
     {
@@ -52,5 +52,5 @@
       ]
     }
   },
-  "falconPackageHash": "6a0c2dacdb4c4cc2087fbf379ac967c7319e0edc5c17a06ca4298b57"
+  "falconPackageHash": "a8c951ca90455f089a3982bab36d21f4e7525ffa07a5eb1201a8378e"
 }