@wix/bex-utils 2.43.0 → 2.45.0

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/src/main/proto/com/wixpress/items_selection/spi/v1/items_selection_spi.proto

@@ -0,0 +1,145 @@
+syntax = "proto3";
+
+package com.wixpress.items_selection.spi.v1;
+
+import "google/protobuf/wrappers.proto";
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/spi/definitions.proto";
+import "wix/common/paging.proto";
+import "wix/common/sorting.proto";
+import "google/protobuf/struct.proto";
+import "src/main/proto/com/wixpress/items_selection/spi/v1/items_selection_config.proto";
+import "src/main/proto/com/wixpress/items_selection/spi/v1/image.proto";
+import "src/main/proto/com/wixpress/items_selection/spi/v1/additional_data.proto";
+import "wix/api/entity.proto";
+
+service ItemsSelectionProviderService {
+  option (.wix.api.service_exposure) = PUBLIC;
+  option (.wix.spi.service) = {
+    spi_identifier: "com.wixpress.appservice.api.ComponentType.ITEMS_SELECTION_PROVIDER",
+    config_message: "com.wixpress.items_selection.spi.v1.ItemsSelectionProviderConfig",
+    host_service: "wix.items_selection.spi_host.v1.ItemsSelectionService",
+    app_id: "a1313905-2aa8-4e8c-a5eb-ddf623c2deb1",
+    fqdn: "wix.interfaces.items_selection.v1.items_selection_provider",
+    appendix_files: {
+      type: DOCS_CONF
+      path: "appendices/docs"
+    }
+  };
+
+  /*
+   This endpoint retrieves a list of items that match the search criteria specified in the request.
+
+   Wix calls this endpoint when a service within the Wix ecosystem wants to make an app's items available for selection in the Wix UI. For example, this endpoint is called when a Wix site owner wants to add an app's item to an existing Wix Stores order.
+
+   > You cannot try out this endpoint because it has to be implemented by
+   > an app and can have an arbitrary URL. Therefore, ignore the **Authorization**
+   > and **POST** sections below as well as the **Try It Out** button.
+   */
+  rpc QueryItems (QueryItemsRequest) returns (QueryItemsResponse) {
+    option (.google.api.http).post = "/v1/items";
+
+    option (.wix.spi.error) = {
+      name: "QueryItemsFailed"
+      http_code: INTERNAL
+      application_code: "QUERY_ITEMS_FAILED"
+      data: "com.wixpress.items_selection.spi.v1.FailureData"
+    };
+  };
+}
+
+message FailureData {
+  // Error details.
+  QueryError error = 1;
+}
+
+message QueryError {
+  enum Code {
+    NONE = 0;
+    SYSTEM_ERROR = 1;
+    OTHER = 2;
+  }
+
+  // Error code.
+  Code code = 1;
+
+  // Error message.
+  string message = 2;
+
+  // Raw error data.
+  google.protobuf.Struct data = 3;
+}
+
+message QueryItemsRequest {
+  // Query options.
+  Query query = 1;
+
+  // A tag representing the Wix service requesting the list of items.
+  ItemsSelectionProviderConfig.Tag tag = 2;
+}
+
+message QueryItemsResponse {
+  // List of items.
+  repeated Item items = 1;
+
+  // Details on the paged set of results returned.
+  wix.common.PagingMetadataV2 paging_metadata = 2;
+}
+
+message Query {
+  /* Filter object.
+  See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
+  */
+  google.protobuf.Struct filter = 1;
+
+  // An optional repeated field that allows to specify sorting criteria for the search results.
+  repeated wix.common.Sorting sort = 2 [deprecated = true, (.wix.api.field_exposure) = PRIVATE];
+
+  /* Plain text search for an exact match.
+
+  Supported properties are defined in the `searchParams.fields` property of the Item Selection Provider configuration in the Wix Developers Center.
+
+  Max: 100 characters
+*/
+  google.protobuf.StringValue search = 3;
+
+  oneof paging_method {
+    // Paging options to limit and skip the number of items.
+    wix.common.Paging paging = 4;
+    // Cursor token pointing to a page of results. Not used in the first request. Following requests include a cursor token and do not define `filter`.
+    wix.common.CursorPaging cursor_paging = 5;
+  }
+}
+
+//flynt-disable deleted-field-enum-reserved
+message Item {
+  // Item ID.
+  string id = 1;
+
+  // Item name.
+  google.protobuf.StringValue name = 2 [(.wix.api.maxLength) = 250];
+
+  // Item description.
+  google.protobuf.StringValue description = 3 [(.wix.api.maxLength) = 1000];
+
+  // Item image.
+  Image image = 4;
+
+  // Additional information about the item. For example, an item's price.
+  google.protobuf.StringValue note = 5 [(.wix.api.maxLength) = 100];
+
+  // Indicates whether the item has additional steps, additional step will replace any existing additional_data exists on the item.
+  google.protobuf.BoolValue has_additional_step = 6 [(.wix.api.field_exposure) = INTERNAL];
+
+  // Additional data associated with an item. The content of this object changes based on the Wix service defined in the `tag` field.
+  AdditionalData additional_data = 7 [(.wix.api.field_exposure) = PRIVATE, deprecated = true, (.wix.api.field_deprecated) = {
+    replaced_by: "additional_fields"
+    target_removal_date: "2025-01-01"
+  }];
+
+  // Additional fields associated with an item. The content of this object might changes based on the Wix service defined in the `tag` field.
+  //flynt-disable renamed-field-breaking-change
+  google.protobuf.Struct additional_fields = 8;
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/annotations.proto

@@ -98,6 +98,7 @@ message Crud {
         UPDATE_EXTENDED_FIELDS = 21;
         BULK_UPDATE_TAGS = 22;
         BULK_UPDATE_TAGS_BY_FILTER = 23;
+        CUSTOM_ACTION = 24;
     }
     required Method method = 1; // method type
     oneof method_options {
@@ -122,6 +123,9 @@ message Crud {
         CountOptions count_options = 21;
         SearchRelatedOptions search_related_options = 22;
         UpdateExtendedFieldsOptions update_extended_fields_options = 23;
+        CustomActionOptions custom_action_options = 24; // marks that this method is a custom-action, that unfolds a read/write operation
+        BulkUpdateTagsMethodOptions bulk_update_tags_options = 25;
+        BulkUpdateTagsByFilterMethodOptions bulk_update_tags_by_filter_options = 26;
     }
 }
 
@@ -130,9 +134,27 @@ message Paging {
         UNKNOWN_TYPE = 0;
         OFFSET = 1;
         CURSOR = 2;
+        BOTH = 3;
     }
     optional Type type = 1; // paging type
-    optional string paging_metadata_field = 2; // paging field name in response object. default is `metadata`
+    optional string paging_metadata_field = 2 [deprecated=true]; // paging field name in response object. default is `metadata`, DEPRECATED in commons V2
+    optional string cursor_paging_metadata_field = 3; // cursor paging field name in response object. default is `cursorPagingMetadata`
+    optional string offset_paging_metadata_field = 4; // offset paging field name in response object. default is `offsetPagingMetadata`
+}
+
+message CustomActionOptions {
+    optional bool read_operation = 1; // the custom-action's operation will do nothing but read data.
+    optional WqlOptions wql = 2; // if WQL validation is needed in this method, provide the data needed for the validator
+}
+
+message WqlOptions {
+    optional string query_options_name = 1; // Name of WQL variant to use
+    // The action may use either filter (struct), query (QueryV2) or search (Search) field. Point to the right one
+    oneof field {
+        string filter_field = 2; // provide path to filter field (struct) in your request message
+        string query_field = 3; // provide path to query field (wix.common.QueryV2) in your request message
+        string search_field = 4; // provide path to search field (wix.common.Search) in your request message
+    }
 }
 
 message CreateMethodOptions {
@@ -166,25 +188,29 @@ message ListMethodOptions {
 }
 
 message QueryMethodOptions {
-    optional string query_field = 1; // query field name in request object. default is `query`
+    optional string query_field = 1 [deprecated=true]; // query field name in request object. default is `query`, DEPRECATED in commons V2
+    optional string cursor_query_field = 7; // cursor query field name in request object. default is `cursorQuery`
+    optional string offset_query_field = 8; // offset query field name in request object. default is `offsetQuery`
     required string items_field = 3; // items field name in response object.
     optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
     oneof wql_options {
         // mark fields that are available for filtering and sorting via WixQueryLanguage
         // Deprecated - use wql annotation on the entity level
         Wql wql = 4 [deprecated = true];
-        string query_options_name = 6; //Name of WQL variant to use
+        string query_options_name = 6; // Name of WQL variant to use
     }
     repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
 }
 
 message SearchMethodOptions {
-    optional string search_field = 1; // search field name in request object. default is `search`
+    optional string search_field = 1 [deprecated=true]; // search field name in request object. default is `search`, DEPRECATED in commons V2
+    optional string cursor_search_field = 8; // cursor search field name in request object. default is `cursorSearch`
+    optional string offset_search_field = 9; // offset search field name in request object. default is `offsetSearch`
     required string items_field = 3; // items field name in response object.
     optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
     oneof wql_options {
         Wql wql = 4; // mark fields that are available for filtering and sorting via WixQueryLanguage
-        string query_options_name = 7; //Name of WQL variant to use
+        string query_options_name = 7; // Name of WQL variant to use
     }
     repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
     repeated Search search = 6; // mark fields that are available for search
@@ -203,7 +229,16 @@ message BulkUpdateByFilterMethodOptions {
     optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
     optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
     optional string filter_field = 3; // filter field name in request object. default is `filter`
-    optional string query_options_name = 4; //Name of WQL variant to use
+    optional string query_options_name = 4; // Name of WQL variant to use
+}
+
+message BulkUpdateTagsMethodOptions {
+    optional string ids_field = 1; // ids field name in request object. default is `<entity-name>_ids`
+}
+
+message BulkUpdateTagsByFilterMethodOptions {
+    optional string filter_field = 1; // filter field name in request object. default is `filter`
+    optional string query_options_name = 2; // Name of WQL variant to use
 }
 
 message BulkUpsertMethodOptions {
@@ -217,7 +252,7 @@ message BulkDeleteMethodOptions {
 
 message BulkDeleteByFilterMethodOptions {
     optional string filter_field = 1; // filter field name in request object. default is `filter`
-    optional string query_options_name = 2; //Name of WQL variant to use
+    optional string query_options_name = 2; // Name of WQL variant to use
 }
 
 message ListDeletedMethodOptions {
@@ -247,8 +282,10 @@ message CountOptions {
     // Usually, that will be the query endpoint since you want the same filter capabilities for query and count
     string inherit_wql_from = 1 [deprecated = true];
 
-    string query_options_name = 2; //Name of WQL variant to use
+    string query_options_name = 2; // Name of WQL variant to use
   }
+  optional string filter_field = 3; // query field name in request object. default is `filter`
+  optional string count_field = 4; // count field name in response object. default is `count`
 }
 
 message SearchRelatedOptions {
@@ -257,7 +294,7 @@ message SearchRelatedOptions {
     // Usually, that will be the search endpoint since you want the same filter capabilities for search and related search
     string inherit_wql_from = 1 [deprecated = true];
 
-    string query_options_name = 2; //Name of WQL variant to use
+    string query_options_name = 2; // Name of WQL variant to use
   }
 }
 
@@ -266,6 +303,7 @@ message UpdateExtendedFieldsOptions {
 }
 
 message Wql {
+    reserved 7;
     enum Operator {
         option allow_alias = true;
         ALL_APPLICABLE_OPERATORS = 0; // Applicable by type. i.e. if we allow LT/GT for **, it means for numeric fields only.
@@ -286,6 +324,15 @@ message Wql {
         EMPTY = 13; // [Array] Matches arrays that contain no elements.
         MATCH_ALL = 14; // Matches all items. Intended for expressing intent in selecting everything for ex. destructive operations - bulk deletes, updates, etc.
         MATCH_ITEMS = 16; // [Array] match multiple fields within array with AND operator semantics.
+        /* Enhances field, marked as LOCAL_DATE format, with additional subFields to sort and filter on.
+            For local date, formatted as yyyy-mm-dd, available subfields are:
+                '.dayOfMonth' - sorts/filters on the day of the month (dd), integer
+                '.month' - sorts/filters on the month (mm), integer
+                '.year' - sorts/filters on the year (yyyy), integer
+            Example, there is a local date field named 'clientBirthday', you may use 'clientBirthday.dayOfMonth',
+            'clientBirthday.month', 'clientBirthday.year' for filtering and sorting.
+            You may also use the field without the enhanced subfields ('clientBirthday'). Then the usual date sorting/filtering is applied */
+        ENHANCED_DATE = 17 [deprecated = true];
     }
     enum Sort {
         NONE = 0; // no sorting enabled
@@ -305,6 +352,18 @@ message Wql {
         }
         repeated RequiredField required_field = 2; // all required field configurations to satisfy composite index
     }
+
+    enum VirtualSubfields {
+      NO_VIRTUAL_SUBFIELDS = 0;
+      /* Can be set for a field, marked as LOCAL_DATE format, allows filtering by following subfields:
+          - '.dayOfMonth' - sorts/filters on the day of the month (dd), integer
+          - '.month' - sorts/filters on the month (mm), integer
+          - '.year' - sorts/filters on the year (yyyy), integer
+         For example, for a local date field named 'clientBirthday', you may use 'clientBirthday.dayOfMonth',
+         'clientBirthday.month', 'clientBirthday.year' for filtering and sorting. */
+      DATE = 1;
+    }
+
     message OperatorFieldSupport {
         repeated Operator operator = 1; // Operators supported for fields that match the glob
         // this field is deprecated because glob is hard to read. moved to a direct field config approach
@@ -316,6 +375,7 @@ message Wql {
         optional Sort sort = 3; // sort type enabled for this glob
         repeated RequiredFields required_fields = 4; // fields that match this glob, can be used only if the query is also filtered by required_fields
         optional Maturity maturity = 6;
+        optional VirtualSubfields virtual_subfields = 7; // kind of virtual subfields are supported for this field
     }
     // this field is deprecated due to a better and shorter naming
     repeated OperatorFieldSupport operator_field_support = 3 [(.wix.api.field_deprecated) = {

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/callback.proto

@@ -108,6 +108,8 @@ message DomainEvent {
     optional EventType event_type = 4;
     optional Exposure exposure = 6;
     optional Maturity maturity = 7;
+    optional string additional_metadata_fqn = 8;
+    optional DomainEventDeprecation deprecated = 9; // assigned and detailed where the subject event is deprecated
 }
 
 message Emits {
@@ -115,6 +117,11 @@ message Emits {
     optional string action_message_fqn = 2; // Required when event_type == ACTION, otherwise must not be set
 }
 
+message DomainEventDeprecation {
+    optional string replaced_by = 1;
+    optional string target_removal_date = 2;
+}
+
 message CallbackDeprecation {
     optional string replaced_by = 1;
     optional string target_removal_date = 2;

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/entity.proto

@@ -63,6 +63,16 @@ message Entity {
     optional QueryOptions query_options = 14;
     optional Exposure events_exposure = 15; // default events exposure, may be overridden in `wix.api.domain_event`
     optional Maturity events_maturity = 16; // default events maturity, may be overridden in `wix.api.domain_event`
+    optional Persistence persistence = 17; // persistence config: type and tenancy model
+}
+
+message Persistence {
+    enum Type {
+        STANDARD = 0; // multiple records per tenant
+        SINGLETON = 1; // single record per tenant
+        NONE = 2; // zero records per tenant - stateless
+    }
+    optional Type type = 1;
 }
 
 message Extensible {

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/errors.proto

@@ -82,6 +82,9 @@ message ValidationError {
         REQUIRED_FIELD = 15;
         FIELD_NOT_ALLOWED = 16;
         ONE_OF_ALIGNMENT = 17;
+        EXACT_LENGTH = 18;
+        EXACT_SIZE = 19;
+        REQUIRED_ONE_OF_FIELD = 20;
     }
     message FieldViolation {
         string field = 1;
@@ -117,3 +120,8 @@ message FormatRuleDataPayload {
 message EnumRuleDataPayload {
     repeated string supported = 1;
 }
+
+// for required one-of violations
+message RequiredOneOfRuleDataPayload {
+    repeated string supported = 1;
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/validations.proto

@@ -36,16 +36,22 @@ extend google.protobuf.FieldOptions {
     optional int32 maxLength = 50203;
     // min length for strings
     optional int32 minLength = 50204;
+    // exact length for strings
+    optional int32 exactLength = 50206;
     // max size for repeated field, map
     optional int32 maxSize = 50209;
     // min size for repeated field, map
     optional int32 minSize = 50210;
+    // exact size for repeated field, map
+    optional int32 exactSize = 50213;
     // common known formats like email, URI, etc.
     optional Format format = 50205;
     // indicates this field cannot be set by the client. E.g. Id field assigned by the server
     optional bool readOnly = 50208;
     // indicates this field can be set by the client, but can never be changed or updated
     optional bool immutable = 50212;
+    // indicates this field is input-only, it will NOT be returned in output response
+    optional bool writeOnly = 50154;
     // decimal value format
     optional DecimalValueOptions decimalValue = 50211;
     // declare custom field validation for all methods
@@ -131,4 +137,6 @@ enum Format {
     LOCAL_DATE_TIME = 18; // ISO-8601 extended local date-time format (YYYY-MM-DDThh:mm[:ss][.sss])
     URL_SLUG = 19;
     SYSTEM_SLUG = 20;
+    SECURE_WEB_URL = 21; // HTTPS only
+    SUBDIVISION = 22; // ISO-3166-2
 }

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/data/errors.proto

@@ -1,4 +1,4 @@
-//flynt-disable missing-array-limits
+//flynt-disable missing-array-limits, missing-string-validations
 syntax = "proto3";
 
 package wix.common.data;
@@ -162,6 +162,7 @@ message PatchErrorDetails {
         ValueExceeded value_exceeded = 9;
         InvalidUUID invalid_uuid = 10;
         SystemFieldNotAllowed system_field_not_allowed = 11;
+        FailedToWriteType failed_to_write_type = 12;
     }
 
     message IllegalFieldRemoved {
@@ -190,6 +191,12 @@ message PatchErrorDetails {
         string expected = 3;
     }
 
+    message FailedToWriteType {
+        string path = 1;
+        string expected_type = 2;
+        string value = 3;
+    }
+
     message IllegalPath {
         string path = 1;
     }
@@ -280,6 +287,7 @@ message ErrorDetails {
         UniqueKeyNotFound unique_key_not_found = 27;
         InvalidUniqueKey invalid_unique_key = 29;
         MaxSizeViolations max_size_violations = 30;
+        PageSizeExceedsMaximum page_size_exceeds_maximum = 31;
     }
 
     message BulkSizeExceedsMaximum {
@@ -418,5 +426,10 @@ message ErrorDetails {
         string field_path = 1;
         string field_type = 2;
     }
+
+    message PageSizeExceedsMaximum {
+        int32 size = 1;
+        int32 max_page_size = 2;
+    }
 }
 

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/media.proto

@@ -33,6 +33,8 @@ message Image {
     google.protobuf.StringValue filename = 7 [(.wix.api.readOnly) = true];
     // Image size in bytes.
     google.protobuf.StringValue size_in_bytes = 8 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.format) = DECIMAL_VALUE];
+    // Focal point of the image.
+    FocalPoint focal_point = 9 [(.wix.api.field_exposure) = PRIVATE];
 }
 
 // Deprecated - use VideoV2
@@ -81,6 +83,10 @@ message VideoV2 {
     google.protobuf.StringValue title = 9 [(wix.api.maxLength) = 300, (.wix.api.field_exposure) = PRIVATE];
     // A long description for the video. will be used for SEO purposes.
     google.protobuf.StringValue description = 10 [(wix.api.maxLength) = 2000, (.wix.api.field_exposure) = PRIVATE];
+    // Original video height.
+    google.protobuf.Int32Value height = 11 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.min) = 0];
+    // Original video width.
+    google.protobuf.Int32Value width = 12 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.min) = 0];
 }
 
 message VideoResolution {
@@ -174,6 +180,8 @@ message Document {
     google.protobuf.StringValue size_in_bytes = 4 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.format) = DECIMAL_VALUE];
     // Document filename.
     google.protobuf.StringValue filename = 5;
+    // Document thumbnail.
+    Image thumbnail = 6 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
 }
 
 message Model3D {
@@ -234,3 +242,14 @@ message MediaItem {
         Document document = 3; // WixMedia document
     }
 }
+
+message FocalPoint {
+    // X-coordinate of the focal point.
+    double x = 1;
+    // Y-coordinate of the focal point.
+    double y = 2;
+    // crop by height
+    google.protobuf.Int32Value height = 3;
+    // crop by width
+    google.protobuf.Int32Value width = 4;
+}