@wix/public-editor-platform-interfaces 1.72.0 → 1.74.0

package/dist/Bindings.d.ts

@@ -1,4 +1,4 @@
-import { FunctionParameter } from '@wix/app-extensions/trusted';
+import { DataType, FunctionParameter } from '@wix/app-extensions/trusted';
 import { ElementDataDefinition } from './sdk';
 import { AttachState, ProviderArrayItem, ProviderFunctionItem, ProviderObjectItem, ProviderSimpleItem, ProviderTextEnumItem, ProviderType } from './Providers';
 export declare const UNBIND_ALL: "ALL";
@@ -59,8 +59,15 @@ export interface ListBindingsOptions {
     providerIdentifiers?: string[];
     providerTypes?: ProviderType[];
 }
+export type Converter = ProviderFunctionItem & {
+    providerIdentifier: string;
+    providerType: ProviderType.FunctionLibrary;
+};
 export type BaseCandidate = {
     itemPath: string;
+    providerIdentifier: string;
+    providerType: ProviderType;
+    withConverter?: Converter;
 };
 export type SimpleCandidate = ProviderSimpleItem & BaseCandidate;
 export type TextEnumCandidate = ProviderTextEnumItem & BaseCandidate;
@@ -83,6 +90,8 @@ export type BindingDetails = {
     providerIdentifier: string;
     providerItem: PropertyBinding;
     providerDisplayName?: string;
+    bindingDisplayName?: string;
+    bindingItemType?: DataType;
 };
 export type BindingDetailsMap = Record<string, BindingDetails>;
 export type SelectBindingOptions = {
@@ -94,5 +103,6 @@ export type SelectBindingOptions = {
 };
 export type findBindingCandidatesOptions = {
     filterAttachState?: AttachState[];
+    includeCandidatesWithConverters?: boolean;
 };
 export type OverriddenSelectBindingOptions = SelectBindingOptions | ((options: SelectBindingOptions) => SelectBindingOptions);

package/dist/Element.d.ts

@@ -1,9 +1,9 @@
-import type { ElementData, ElementDataInput, ElementDataValue, ElementLink } from './sdk/data';
+import type { ElementData, ElementDataInput, ElementDataValue, ElementLink, ElementSort } from './sdk/data';
 import type { ElementStyles, ElementStylesUpdate, ElementStylesRemoval } from './sdk/styles';
 import type { ElementDataDefinitions, ElementPresetDefinitions, ElementStateDefinitions, ElementStyleDefinitions } from './sdk/definitions';
-import type { IPickerModes, IFontFamily, IFontWeight, IFontFamilyAndWeight, ISelectLinkSharedOptions, IPanelOptions, SelectFontParams, SelectFontFamilyParams, SelectFontWeightParams, SelectMediaParams, SelectLinkParams, SelectColorParams, SelectTextThemeParams, SelectedTextTheme } from './sdk/pickers';
+import type { IPickerModes, IFontFamily, IFontWeight, IFontFamilyAndWeight, ISelectLinkSharedOptions, IPanelOptions, SelectFontParams, SelectFontFamilyParams, SelectFontWeightParams, SelectMediaParams, SelectLinkParams, SelectSortParams, SelectColorParams, SelectTextThemeParams, SelectedTextTheme } from './sdk/pickers';
 import type { BackgroundPickerOptions } from './Inputs';
-export type { IPickerModes, IFontFamily, IFontWeight, IFontFamilyAndWeight, ISelectLinkSharedOptions, IPanelOptions, SelectFontParams, SelectFontFamilyParams, SelectFontWeightParams, SelectMediaParams, SelectLinkParams, SelectColorParams, SelectTextThemeParams, SelectedTextTheme, };
+export type { IPickerModes, IFontFamily, IFontWeight, IFontFamilyAndWeight, ISelectLinkSharedOptions, IPanelOptions, SelectFontParams, SelectFontFamilyParams, SelectFontWeightParams, SelectMediaParams, SelectLinkParams, SelectSortParams, SelectColorParams, SelectTextThemeParams, SelectedTextTheme, };
 /**
  * Use `reactElements` from `@wix/editor` in a custom panel to read and update the component's styles,
  * data, presets, and states, and to open editor pickers. Picker methods use {@link IPickerModes}. See each `select*` method for its parameter type.
@@ -431,6 +431,19 @@ export interface IElementSDK {
      * ```
      */
     selectLink(params: SelectLinkParams): Promise<ElementLink | null | undefined>;
+    /**
+     * Opens the WQL sort panel for a sort data item.
+     *
+     * @param params - See {@link SelectSortParams} and {@link IPickerModes}.
+     *
+     * @example
+     * ```ts
+     * import { reactElements } from '@wix/editor';
+     *
+     * const sort = await reactElements.selectSort({ dataItemKey: 'productSort' });
+     * ```
+     */
+    selectSort(params: SelectSortParams): Promise<ElementSort | undefined>;
     /**
      * Opens the color picker for selecting a color.
      *

package/dist/sdk/pickers.d.ts

@@ -1,9 +1,10 @@
 import type { ElementLink } from './data';
 /**
- * Each {@link IElementSDK | `reactElements`} `select*` method accepts one of two types of arguments:
+ * Most {@link IElementSDK | `reactElements`} `select*` methods accept one of two types of arguments:
  * a manifest key for automatic editor handling, or explicit options to manage the value yourself.
  * Use manifest-key mode to let the editor connect the picker to a manifest-backed data or style field.
  * Use explicit-options mode when your panel owns the selected value and handles callbacks itself.
+ * Some picker methods are currently manifest-key only.
  *
  * @see IElementSDK.selectFont
  * @see IElementSDK.selectFontFamily
@@ -149,6 +150,14 @@ export type SelectLinkParams = {
         linkTypes?: string[];
     };
 };
+/**
+ * Options for {@link IElementSDK.selectSort | `reactElements.selectSort()`}.
+ * Pass a manifest key for automatic editor handling. See {@link IPickerModes}.
+ */
+export type SelectSortParams = {
+    /** Pass a manifest key: field connected to `dataItemKey` in the manifest. See {@link IPickerModes}. */
+    dataItemKey: string;
+};
 /**
  * Options for {@link IElementSDK.selectColor | `reactElements.selectColor()`}.
  * Pass either a manifest key or explicit options. See {@link IPickerModes}. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/public-editor-platform-interfaces",
-  "version": "1.72.0",
+  "version": "1.74.0",
   "license": "UNLICENSED",
   "contributors": [
     {
@@ -52,5 +52,5 @@
       ]
     }
   },
-  "falconPackageHash": "8c6f1695e6f874f0f6b2616f3ac0441b996f03db1eb5f1f5c927dc49"
+  "falconPackageHash": "781a49201f22dd23ee12cfb1c7246af61e393f47273602685a673800"
 }