@wix/bex-utils 2.34.0 → 2.36.0

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/src/main/proto/com/wixpress/items_selection/spi/v1/additional_data/inbox_data.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package com.wixpress.items_selection.spi.v1;
+
+import "wix/api/validations.proto";
+
+message InboxData {
+  // An array of actions that is supported by Inbox page
+  repeated Action actions = 1 [(wix.api.maxSize) = 50];
+}
+
+message Action {
+  // The title of the action
+  string title = 1 [(.wix.api.maxLength) = 100];
+  // The url of the action
+  string url = 2 [(.wix.api.maxLength) = 2048];
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/src/main/proto/com/wixpress/items_selection/spi/v1/additional_data.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+package com.wixpress.items_selection.spi.v1;
+
+import "src/main/proto/com/wixpress/items_selection/spi/v1/additional_data/ecom_catalog_data.proto";
+import "src/main/proto/com/wixpress/items_selection/spi/v1/additional_data/inbox_data.proto";
+
+
+message AdditionalData {
+  oneof data {
+    // Additional data associated with ecom catalog order.
+    EcomCatalogData ecom_catalog_data = 1;
+    // Additional data associated with inbox
+    InboxData inbox_data = 2;
+  }
+};

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/src/main/proto/com/wixpress/items_selection/spi/v1/image.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package com.wixpress.items_selection.spi.v1;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+
+message Image {
+  // Image URL.
+  google.protobuf.StringValue url = 1 [(.wix.api.maxLength) = 2048];
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/src/main/proto/com/wixpress/items_selection/spi/v1/items_selection_config.proto

@@ -0,0 +1,246 @@
+syntax = "proto3";
+
+package com.wixpress.items_selection.spi.v1;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/spi/definitions.proto";
+import "wix/api/annotations.proto";
+
+message ItemsSelectionProviderConfig {
+  // Base URI which Wix calls to retrieve the selected items. For example, `"deploymentUri": "https://my-items.com"`.
+  string deployment_uri = 1 [(.wix.spi.base_uri) = true, (wix.api.minLength) = 1];
+
+  // A unique identifier for the provider.
+  string key = 2 [(wix.api.minLength) = 3, (wix.api.maxLength) = 250];
+
+  // Supported search parameters.
+  SearchParams search_params = 3;
+
+  // Display data such as provider name and icon.
+  ContentData content_data = 4;
+
+  // Optional additional step taken after the initial item selection.
+  AdditionalStepInfo additional_step_info = 5 [(.wix.api.field_exposure) = INTERNAL];
+
+  // An array of strings representing the Wix UI pages supported by your SPI implementation. If no tags are listed, Wix assumes that the implementation supports all eligible pages.
+  repeated Tag supported_tags = 6 [(wix.api.maxSize) = 50];
+
+  // Optional create new item option, to define a widget that will be opened to create a new item
+  CreateNewItemInfo create_new_item_info = 7 [(.wix.api.field_exposure) = INTERNAL];
+
+  // Configuration settings for how the thumbnail is displayed.
+  ItemThumbnail item_thumbnail = 8;
+
+  //flynt-disable deleted-field-enum-reserved
+  enum Tag {
+    UNKNOWN_TAG = 0;
+    EMBEDDABLE = 1;
+    ECOM_EDIT_ORDER = 2;
+    ECOM_CREATE_ORDER = 3;
+    INBOX = 4;
+    ECOM_CREATE_PAY_LINK = 5;
+    ECOM_DELIVERY_PROFILES = 6;
+    ADD_TO_CATEGORY = 7;
+  }
+
+  message AdditionalStepInfo {
+    // ID of the widget associated with the step.
+    string widget_id = 1;
+    // one app (mobile) component id that will be opened to show additional step
+    google.protobuf.StringValue mobile_component_id = 5 [(.wix.api.field_exposure) = INTERNAL, (wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+
+    // Title of the additional step.
+    string title = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Additional Step Title"
+      grouping: "metadata"
+    }];
+
+    // Subtitle of the additional step.
+    google.protobuf.StringValue subtitle = 3 [(wix.api.maxLength) = 100, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Additional Step Subtitle"
+      grouping: "metadata"
+    }];
+
+    // Hide item note if exists when showing selected item on additional step header, default: false.
+    google.protobuf.BoolValue hide_item_note = 4;
+  }
+
+  message CreateNewItemInfo {
+    // ID of the widget associated with the new item modal.
+    string widget_id = 1;
+    // one app (mobile) component id that will be opened to create a new item
+    google.protobuf.StringValue mobile_component_id = 2 [(.wix.api.field_exposure) = INTERNAL, (wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    // Button label for creating a new item
+    google.protobuf.StringValue button_text = 3 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Create New Item Button"
+      grouping: "metadata"
+    }];
+  }
+
+  message ContentData {
+    // Provider icon. Choose an icon name from the [Wix Design System](https://www.wixdesignsystem.com/).
+    google.protobuf.StringValue icon_key = 1 [(wix.api.minLength) = 3, (wix.api.maxLength) = 50];
+
+    // Provider name.
+    string provider_name = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Provider Name"
+      grouping: "metadata"
+    }];
+
+    // Item title.
+    string title = 3 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Picker Title"
+      grouping: "metadata"
+    }];
+
+    // Button label.
+    string button = 4 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Select Button"
+      grouping: "metadata"
+    }];
+
+    // Item description.
+    google.protobuf.StringValue subtitle = 5 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Picker Subtitle"
+      grouping: "metadata"
+    }];
+
+    // Learn more link.
+    LearnMore learn_more = 6;
+  }
+
+  message ItemThumbnail {
+    // Thumbnail type
+    ThumbnailType type = 1;
+
+    // Whether the thumbnail is hidden from the UI.
+    google.protobuf.BoolValue hidden = 2;
+
+    oneof options {
+      option (.wix.api.aligned_with_enum) = {
+        field: "type";
+        suffix: "config";
+      };
+      // Configuration specific to images.
+      ImageConfig image_config = 3;
+
+      // Configuration specific to avatars.
+      AvatarConfig avatar_config = 4;
+    }
+  }
+
+  enum ThumbnailType {
+    UNKNOWN_THUMBNAIL_TYPE = 0;
+    IMAGE = 1;
+    AVATAR = 2;
+  }
+
+  message ImageConfig {
+    ImageShape shape = 1;
+
+    enum ImageShape {
+      UNKNOWN_SHAPE = 0;
+      // Circle
+      CIRCLE = 1;
+      // Square
+      SQUARE = 2;
+      // Rectangle
+      RECTANGLE = 3;
+    }
+  }
+
+  message AvatarConfig {
+    AvatarShape shape = 1;
+
+    enum AvatarShape {
+      UNKNOWN_SHAPE = 0;
+      // Circle
+      CIRCLE = 1;
+      // Square
+      SQUARE = 2;
+    }
+  }
+
+  message SearchParams {
+    // Supported search parameters.
+    repeated SearchField fields = 1 [(.wix.api.maxSize) = 50];
+
+    // Filter for viewing only part of the items.
+    FilterInfo filter = 2;
+  }
+
+  message SearchField {
+    // Supported searchable fields.
+    string key = 1;
+
+    // Item description.
+    string description = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+  }
+
+  message FilterInfo {
+    // Key of the filter
+    string key = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+  
+    // Optional filter will be shown only for consumers with this tag. Only one filter is allowed per tag.
+    Tag tag = 2;
+
+    // The filter selection type. For now only single selection is available
+    FilterSelectionType selection_type = 3;
+
+     // Filter options type. For now only static options are supported
+     FilterOptionsType options_type = 4;
+     oneof options {
+       option (.wix.api.aligned_with_enum).field = "options_type";
+       // Static hardcoded options  
+       StaticFilterOptions static_options = 5;
+     }
+  }
+
+  message StaticFilterOptions {
+    // List of hardcoded options for a filter
+    repeated StaticFilterOption data = 1 [(.wix.api.maxSize) = 50];
+  }
+
+  message StaticFilterOption {
+    option (.wix.api.unique) = {field: "value"};
+    // Title of a filter option
+    string label = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 500, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Filter Option Label"
+      grouping: "metadata"
+    }];
+    // Value of a filter option
+    string value = 2 [(wix.api.minLength) = 1, (.wix.api.maxLength) = 100];
+  }
+
+  message LearnMore {
+    // The url of the learn more link. If you want a dynamic url according to the user locale, you can add {{locale}} variable within the string.
+    string url = 1 [(.wix.api.maxLength) = 2048];
+    // Optional link label.
+    google.protobuf.StringValue label = 2 [(wix.api.maxLength) = 500, (wix.api.translatable) = {
+      type: SHORT_TEXT
+      name: "Learn More Label"
+      grouping: "metadata"
+    }];
+  }
+
+  enum FilterSelectionType {
+    UNKNOWN_SELECTION = 0;
+    // Allow to select only a single item
+    SINGLE_SELECTION = 1;
+  }
+
+  enum FilterOptionsType {
+    UNKNOWN_FILTER_OPTIONS = 0;
+    // Static hardcoded options
+    STATIC = 1;
+  }
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/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-items-selection-spi-host-v1-provider/src/main/proto/wix/api/action_payload.proto

@@ -0,0 +1,33 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "ActionPayloadProto";
+option java_package = "com.wix.api";
+
+/*
+action_payload option is used to configure custom slugs for the payload type of a DomainEvent Action:
+service BlooperService {
+   option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
+   rpc MissedBlooper (MissedBlooperRequest) returns (MissedBlooperResponse) {
+       option (wix.api.callback) = {
+           event_type: Action
+           payload: "com.wixpress.examples.BlooperWasMissed"
+       };
+   };
+}
+message BlooperWasMissed {
+   option (wix.api.action_payload).custom_slug = "super_custom_slug"; // only define if the default slug value (snake case of the message name) is out of the question
+    int32 how_funny_it_could_have_been = 1;
+}
+*/
+extend google.protobuf.MessageOptions {
+    optional ActionPayload action_payload = 50600;
+}
+
+message ActionPayload {
+    optional string custom_slug = 1;
+}