@wix/public-editor-platform-interfaces 1.67.0 → 1.69.0

package/dist/generated/dm-types.d.ts

@@ -7,7 +7,7 @@ export interface DataItem extends DataItemDataValueOneOf {
     textEnum?: TextEnum;
     /** Image reference with optional metadata. */
     image?: Image;
-    /** Numeric value (integer or decimal). */
+    /** Numeric value, either integer or decimal. */
     number?: _Number;
     /** Date without time component. */
     localDate?: LocalDate;
@@ -35,7 +35,7 @@ export interface DataItem extends DataItemDataValueOneOf {
     link?: Link;
     /** Container reference. */
     container?: Container;
-    /** Text direction (LTR/RTL/auto). */
+    /** Text direction value: LTR, RTL, or auto. */
     direction?: Direction;
     /** Menu items collection. */
     menuItems?: MenuItems;
@@ -51,7 +51,11 @@ export interface DataItem extends DataItemDataValueOneOf {
     arrayItems?: ArrayItems;
     /** Function definition with parameters, return value, and async flag. */
     function?: _Function;
-    /** Data type of this item. Uses the app-service `DataTypeEnum.DataType` enum. */
+    /** WQL-compliant filter expression for querying data. */
+    filter?: Filter;
+    /** WQL-compliant sort specification for ordering data. */
+    sort?: Sort;
+    /** Data type of this item. Determines which `dataValue` field is populated. */
     dataType?: DataType;
 }
 export interface DataItemDataValueOneOf {
@@ -63,7 +67,7 @@ export interface DataItemDataValueOneOf {
     textEnum?: TextEnum;
     /** Image reference with optional metadata. */
     image?: Image;
-    /** Numeric value (integer or decimal). */
+    /** Numeric value, either integer or decimal. */
     number?: _Number;
     /** Date without time component. */
     localDate?: LocalDate;
@@ -91,7 +95,7 @@ export interface DataItemDataValueOneOf {
     link?: Link;
     /** Container reference. */
     container?: Container;
-    /** Text direction (LTR/RTL/auto). */
+    /** Text direction value: LTR, RTL, or auto. */
     direction?: Direction;
     /** Menu items collection. */
     menuItems?: MenuItems;
@@ -107,6 +111,10 @@ export interface DataItemDataValueOneOf {
     arrayItems?: ArrayItems;
     /** Function definition with parameters, return value, and async flag. */
     function?: _Function;
+    /** WQL-compliant filter expression for querying data. */
+    filter?: Filter;
+    /** WQL-compliant sort specification for ordering data. */
+    sort?: Sort;
 }
 export declare enum DataType {
     UNKNOWN_DataType = "UNKNOWN_DataType",
@@ -164,16 +172,20 @@ export declare enum DataType {
     data = "data",
     /** A custom function that can be used to call a function from a custom library */
     'function' = "function",
-    /** Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event), can also handle: `()=>void` */
+    /** Deprecated: use function with pointerEvent parameter. Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) */
     onClick = "onClick",
-    /** Standard input event [onChange](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) for text inputs, can also handle: `(value: string) => void` */
+    /** Deprecated: use function with changeEvent parameter. Standard [onChange handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) */
     onChange = "onChange",
-    /** Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event), can also handle: `(event: KeyboardEvent) => void` */
+    /** Deprecated: use function with keyboardEvent parameter. Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event) */
     onKeyPress = "onKeyPress",
-    /** Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event), can also handle: `(event: KeyboardEvent) => void` */
+    /** Deprecated: use function with keyboardEvent parameter. Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event) */
     onKeyUp = "onKeyUp",
-    /** Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event), can also handle: `() => void` */
-    onSubmit = "onSubmit"
+    /** Deprecated: use function with submitEvent parameter. Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event) */
+    onSubmit = "onSubmit",
+    /** A WQL-compliant filter definition for querying data */
+    filter = "filter",
+    /** A WQL-compliant sort definition for ordering data */
+    sort = "sort"
 }
 export interface Text {
     /**
@@ -225,13 +237,13 @@ export interface Image {
     crop?: Crop;
 }
 export interface Crop {
-    /** Width of the crop region as a fraction of the original image (0.0 to 1.0). */
+    /** Width of the crop region as a fraction of the original image, from 0.0 to 1.0. */
     width?: number;
-    /** Height of the crop region as a fraction of the original image (0.0 to 1.0). */
+    /** Height of the crop region as a fraction of the original image, from 0.0 to 1.0. */
     height?: number;
-    /** X-coordinate of the crop origin as a fraction of the original image (0.0 to 1.0). */
+    /** X-coordinate of the crop origin as a fraction of the original image, from 0.0 to 1.0. */
     x?: number;
-    /** Y-coordinate of the crop origin as a fraction of the original image (0.0 to 1.0). */
+    /** Y-coordinate of the crop origin as a fraction of the original image, from 0.0 to 1.0. */
     y?: number;
 }
 export interface _Number {
@@ -240,21 +252,21 @@ export interface _Number {
 }
 export interface LocalDate {
     /**
-     * Date value in YYYY-MM-DD format.
+     * Date value in `YYYY-MM-DD` format.
      * @format LOCAL_DATE
      */
     value?: string;
 }
 export interface LocalTime {
     /**
-     * Time value in HH:MM:SS format.
+     * Time value in `HH:MM:SS` format.
      * @format LOCAL_TIME
      */
     value?: string;
 }
 export interface LocalDateTime {
     /**
-     * Date-time value in ISO 8601 format.
+     * Date-time value in ISO 8601 format, such as `2024-03-15T14:30:00`.
      * @format LOCAL_DATE_TIME
      */
     value?: string;
@@ -487,7 +499,7 @@ export interface Audio {
     loop?: boolean | null;
     /** Whether the audio player is visible. */
     visible?: boolean | null;
-    /** Volume level (0-100). */
+    /** Volume level, from 0 to 100. */
     volume?: number | null;
     /**
      * Audio track title.
@@ -512,6 +524,52 @@ export interface VectorArt {
      */
     uri?: string | null;
 }
+export interface Filter {
+    /** Per-field conditions keyed by field name. Multiple fields are implicitly combined with logical AND. */
+    fields?: Record<string, FieldConditions>;
+    /**
+     * Subfilters combined with logical AND, corresponding to `$and` in the underlying JSON schema.
+     * @maxSize 100
+     */
+    and?: Filter[];
+    /**
+     * Subfilters combined with logical OR, corresponding to `$or` in the underlying JSON schema.
+     * @maxSize 100
+     */
+    or?: Filter[];
+    /**
+     * Negated subfilters, corresponding to `$not` in the underlying JSON schema.
+     * @maxSize 100
+     */
+    not?: Filter[];
+}
+export interface Sort {
+    /**
+     * Ordered list of sort directives, applied in sequence.
+     * @maxSize 100
+     */
+    items?: SortItem[];
+}
+export interface FieldConditions {
+    operators?: Record<string, any>;
+}
+export interface SortItem {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 200
+     */
+    fieldName?: string;
+    /** Sort direction. */
+    order?: SortOrderEnumSortOrder;
+}
+export declare enum SortOrderEnumSortOrder {
+    /** Unknown sort order. */
+    UNKNOWN_SORT_ORDER = "UNKNOWN_SORT_ORDER",
+    /** Ascending order. */
+    ASC = "ASC",
+    /** Descending order. */
+    DESC = "DESC"
+}
 export interface ComponentData {
     /** Data properties keyed by property name. Available properties depend on the component type. */
     properties?: Record<string, DataItem>;
@@ -577,7 +635,7 @@ export declare enum StyleType {
 export interface CssStyleProperties {
     /** CSS properties keyed by property name. For example, `backgroundColor`, `borderWidth`. */
     properties?: Record<string, string>;
-    /** CSS custom properties (variables) keyed by variable name. For example, `--primary-color`, `--spacing-unit`. */
+    /** CSS custom properties, also known as CSS variables, keyed by variable name. For example, `--primary-color`, `--spacing-unit`. */
     customProperties?: Record<string, string>;
 }
 export interface LegacyStyleProperties {
@@ -600,22 +658,22 @@ export declare enum PropertySource {
 }
 export interface PartialTextTheme {
     /**
-     * Font style (normal, italic).
+     * Font style, such as `normal` or `italic`.
      * @maxLength 100
      */
     fontStyle?: string | null;
     /**
-     * Font weight (normal, bold, 100-900).
+     * Font weight, such as `normal`, `bold`, or a numeric value from `100` to `900`.
      * @maxLength 100
      */
     fontWeight?: string | null;
     /**
-     * Font variant (normal, small-caps, inherit).
+     * Font variant, such as `normal`, `small-caps`, or `inherit`.
      * @maxLength 100
      */
     fontVariant?: string | null;
     /**
-     * Font size with unit (e.g., "14px", "1em").
+     * Font size with unit, such as `14px` or `1em`.
      * @maxLength 100
      */
     fontSize?: string | null;
@@ -686,7 +744,7 @@ export interface ComponentStyleOverrideStylePropertiesOneOf {
 }
 export interface ConditionalTrigger {
     /**
-     * ID of the condition that triggers this override. Examples include responsive breakpoint IDs and interaction states such as hover.
+     * ID of the condition that triggers this override. Condition IDs are system-defined identifiers for responsive breakpoints and interaction states such as hover. To discover available condition IDs for a component, retrieve the component and inspect any existing style overrides.
      * @maxLength 100
      */
     conditionId?: string;

package/dist/generated/dm-types.js

@@ -2,7 +2,7 @@
 // Auto-generated from Ambassador packages
 // Do not edit manually - run 'yarn generate:public-types' to regenerate
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AriaInvalid = exports.AriaCurrent = exports.AriaLive = exports.AriaRole = exports.AriaRelevant = exports.AriaHaspopup = exports.AriaPressed = exports.LoginDialog = exports.TextLinkType = exports.LinkType = exports.LinkRelEnumLinkRel = exports.LinkTarget = exports.PropertySource = exports.StyleType = exports.AdaptiveFormat = exports.VideoFormat = exports.VideoQuality = exports.DirectionValue = exports.DataType = void 0;
+exports.AriaInvalid = exports.AriaCurrent = exports.AriaLive = exports.AriaRole = exports.AriaRelevant = exports.AriaHaspopup = exports.AriaPressed = exports.LoginDialog = exports.TextLinkType = exports.LinkType = exports.LinkRelEnumLinkRel = exports.LinkTarget = exports.PropertySource = exports.StyleType = exports.SortOrderEnumSortOrder = exports.AdaptiveFormat = exports.VideoFormat = exports.VideoQuality = exports.DirectionValue = exports.DataType = void 0;
 var DataType;
 (function (DataType) {
     DataType["UNKNOWN_DataType"] = "UNKNOWN_DataType";
@@ -60,16 +60,20 @@ var DataType;
     DataType["data"] = "data";
     /** A custom function that can be used to call a function from a custom library */
     DataType["function"] = "function";
-    /** Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event), can also handle: `()=>void` */
+    /** Deprecated: use function with pointerEvent parameter. Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) */
     DataType["onClick"] = "onClick";
-    /** Standard input event [onChange](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) for text inputs, can also handle: `(value: string) => void` */
+    /** Deprecated: use function with changeEvent parameter. Standard [onChange handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) */
     DataType["onChange"] = "onChange";
-    /** Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event), can also handle: `(event: KeyboardEvent) => void` */
+    /** Deprecated: use function with keyboardEvent parameter. Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event) */
     DataType["onKeyPress"] = "onKeyPress";
-    /** Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event), can also handle: `(event: KeyboardEvent) => void` */
+    /** Deprecated: use function with keyboardEvent parameter. Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event) */
     DataType["onKeyUp"] = "onKeyUp";
-    /** Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event), can also handle: `() => void` */
+    /** Deprecated: use function with submitEvent parameter. Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event) */
     DataType["onSubmit"] = "onSubmit";
+    /** A WQL-compliant filter definition for querying data */
+    DataType["filter"] = "filter";
+    /** A WQL-compliant sort definition for ordering data */
+    DataType["sort"] = "sort";
 })(DataType || (exports.DataType = DataType = {}));
 var DirectionValue;
 (function (DirectionValue) {
@@ -113,6 +117,15 @@ var AdaptiveFormat;
     /** Dynamic Adaptive Streaming over HTTP. */
     AdaptiveFormat["DASH"] = "DASH";
 })(AdaptiveFormat || (exports.AdaptiveFormat = AdaptiveFormat = {}));
+var SortOrderEnumSortOrder;
+(function (SortOrderEnumSortOrder) {
+    /** Unknown sort order. */
+    SortOrderEnumSortOrder["UNKNOWN_SORT_ORDER"] = "UNKNOWN_SORT_ORDER";
+    /** Ascending order. */
+    SortOrderEnumSortOrder["ASC"] = "ASC";
+    /** Descending order. */
+    SortOrderEnumSortOrder["DESC"] = "DESC";
+})(SortOrderEnumSortOrder || (exports.SortOrderEnumSortOrder = SortOrderEnumSortOrder = {}));
 var StyleType;
 (function (StyleType) {
     /** Unknown style type. */

package/dist/sdk/data.d.ts

@@ -118,7 +118,9 @@ export type ElementRichText = Omit<DmTypes.RichText, 'linkList'> & {
     linkList?: ElementLink[];
 };
 export type ElementFunctionDefinition = DmTypes._Function;
-export type ElementDataValue = string | number | boolean | ElementLink | ElementImage | ElementVideo | ElementAudio | ElementVectorArt | ElementMenuItems | ElementA11y | ElementRichText | ElementFunctionDefinition | ElementDirection | ElementDataObject | ElementDataValue[] | null | undefined;
+export type ElementFilter = DmTypes.Filter;
+export type ElementSort = DmTypes.Sort;
+export type ElementDataValue = string | number | boolean | ElementLink | ElementImage | ElementVideo | ElementAudio | ElementVectorArt | ElementMenuItems | ElementA11y | ElementRichText | ElementFunctionDefinition | ElementDirection | ElementFilter | ElementSort | ElementDataObject | ElementDataValue[] | null | undefined;
 export type ElementDataObject = {
     [key: string]: ElementDataValue;
 };
@@ -157,6 +159,8 @@ export type ElementDataTypeMap = {
     [DataType.onSubmit]: ElementFunctionDefinition;
     [DataType.schema]: ElementDataValue;
     [DataType.UNKNOWN_DataType]: ElementDataValue;
+    [DataType.filter]: ElementFilter;
+    [DataType.sort]: ElementSort;
     ['function']: ElementFunctionDefinition;
 };
 export type ElementDefaultValueFor<TypeKey extends keyof ElementDataTypeMap> = ElementDataTypeMap[TypeKey];

package/dist/sdk/definitions.d.ts

@@ -6,6 +6,7 @@ import type { DataType } from '../generated/dm-types';
 import type { ElementDataTypeMap, ElementDataValue } from './data';
 import type { CssPropertyType, CssPropertyOptions } from './css-properties';
 import type { ElementStyleValue, CssPropertyKey } from './styles';
+import type { FilterDefinition, SortDefinition } from '@wix/app-extensions/trusted';
 export { DataType } from '../generated/dm-types';
 export type ElementStyleDefinition = {
     displayName?: string | null;
@@ -41,11 +42,20 @@ export type ElementStateDefinition = {
     props?: Record<string, unknown>;
 };
 export type ElementStateDefinitions = Record<string, ElementStateDefinition>;
+type ElementDataDefinitionExtraFields = {
+    [DataType.filter]: {
+        filter?: FilterDefinition;
+    };
+    [DataType.sort]: {
+        sort?: SortDefinition;
+    };
+};
+type ExtraFieldsFor<TypeKey extends DataType> = TypeKey extends keyof ElementDataDefinitionExtraFields ? ElementDataDefinitionExtraFields[TypeKey] : {};
 export type ElementDataDefinition<TypeKey extends DataType = DataType> = {
     dataType?: TypeKey;
     displayName?: string | null;
     defaultValue?: TypeKey extends keyof ElementDataTypeMap ? ElementDataTypeMap[TypeKey] : ElementDataValue;
-};
+} & ExtraFieldsFor<TypeKey>;
 export type ElementDataDefinitions = Record<string, ElementDataDefinition>;
 export type ElementDataDefaultValues = Partial<{
     [Key in DataType]: ElementDataTypeMap[Key];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/public-editor-platform-interfaces",
-  "version": "1.67.0",
+  "version": "1.69.0",
   "license": "UNLICENSED",
   "contributors": [
     {
@@ -23,7 +23,7 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/app-extensions": "^1.0.62",
+    "@wix/app-extensions": "^1.0.63",
     "@wix/sdk-types": "^1.17.8"
   },
   "devDependencies": {
@@ -52,5 +52,5 @@
       ]
     }
   },
-  "falconPackageHash": "b78f464ba0c437442061d894a336cd428688212329ca5e6dcdca14c7"
+  "falconPackageHash": "a09ce2e428999c892c11295fca4b72a865e2ff9337e8239e12f897e4"
 }