@wix/bex-utils 1.28.0

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

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+// Common money formats.
+
+// Money.
+// Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
+message Money {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "value"
+        field: "currency"
+    };
+    // For special cases, one may use just a value without currency to represent money. But:
+    // - money MUST be a decimal string, as described below
+    // - currency MUST be provided somewhere at the top level of your object
+
+    // Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
+    string value = 1 [(.wix.api.format) = DECIMAL_VALUE];
+    // Currency code. Must be valid ISO 4217 currency code (e.g., USD).
+    string currency = 2 [(.wix.api.format) = CURRENCY];
+    // Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
+    google.protobuf.StringValue formatted_value = 3;
+
+}

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

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_outer_classname = "PageUrlProto";
+option java_package = "com.wix.common";
+
+import "wix/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+
+message PageUrl {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "base"
+        field: "path"
+    };
+    // The base URL. For premium sites, this will be the domain. For free sites, this would be site URL (e.g mysite.wixsite.com/mysite)
+    string base = 1;
+    // The path to that page - e.g /product-page/a-product
+    string path = 2;
+}
+
+message PageUrlV2 {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "relative_path"
+        field: "url"
+    };
+    // The path to that page - e.g /product-page/a-product
+    string relative_path = 1;
+    // The URL of that page. e.g https://mysite.com/product-page/a-product
+    google.protobuf.StringValue url = 2;
+}

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

@@ -0,0 +1,107 @@
+syntax = "proto3";
+
+package wix.common;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+message Paging {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "limit"
+        field: "offset"
+    };
+    // Number of items to load.
+    google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0];
+    // Number of items to skip in the current sort order.
+    google.protobuf.Int32Value offset = 2 [(.wix.api.min) = 0];
+}
+
+message CursorPaging {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "limit"
+        field: "cursor"
+    };
+    // Number of items to load.
+    google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0, (.wix.api.max) = 100];
+    /*
+    Pointer to the next or previous page in the list of results.
+
+    You can get the relevant cursor token
+    from the `pagingMetadata` object in the previous call's response.
+    Not relevant for the first request.
+    */
+    google.protobuf.StringValue cursor = 2;
+}
+
+message PagingMetadata {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "offset"
+    };
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    google.protobuf.Int32Value offset = 2;
+    // Total number of items that match the query.
+    google.protobuf.Int32Value total = 3;
+    // Flag that indicates the server failed to calculate the `total` field.
+    google.protobuf.BoolValue too_many_to_count = 4;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 5 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+message PagingMetadataV2 {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "offset"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "cursors"
+    };
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    google.protobuf.Int32Value offset = 2;
+    // Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.
+    google.protobuf.Int32Value total = 3;
+    // Flag that indicates the server failed to calculate the `total` field.
+    google.protobuf.BoolValue too_many_to_count = 4;
+    // Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.
+    Cursors cursors = 5;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 6 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+
+// This is the preferred message for cursor-paging enabled services
+
+message CursorPagingMetadata {
+    option (.wix.api.decomposite_of) = "wix.common.PagingMetadataV2";
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    Cursors cursors = 2;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 3;
+}
+
+message Cursors {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "next"
+    };
+    // Cursor pointing to next page in the list of results.
+    google.protobuf.StringValue next = 1;
+    // Cursor pointing to previous page in the list of results.
+    google.protobuf.StringValue prev = 2;
+}

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

@@ -0,0 +1,417 @@
+syntax = "proto3";
+
+package wix.common;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/common/paging.proto";
+import "wix/common/sorting.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "QueryProto";
+option java_package = "com.wix.common";
+
+message Query {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "filter"
+        field: "sort"
+        field: "paging"
+    };
+    //Filter object in the following format:
+    //`"filter" : {
+    //              "fieldName1": "value1",
+    //              "fieldName2":{"$operator":"value2"}
+    //  }`
+    //Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    google.protobuf.Value filter = 1;
+     //Sort object in the following format:
+     //`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    repeated Sorting sort = 2;
+    //Paging options to limit and skip the number of items.
+    Paging paging = 3;
+    //Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+    repeated string fields = 4;
+    //Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+    repeated string fieldsets = 5;
+}
+
+message QueryV2 {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "filter"
+        field: "sort"
+        field: "paging"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "filter"
+        field: "sort"
+        field: "cursor_paging"
+    };
+    //Filter object in the following format:
+    //`"filter" : {
+    //              "fieldName1": "value1",
+    //              "fieldName2":{"$operator":"value2"}
+    //  }`
+    //Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    google.protobuf.Struct filter = 1;
+    //Sort object in the following format:
+    //`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    repeated Sorting sort = 2;
+    //Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+    repeated string fields = 4;
+    //Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+    repeated string fieldsets = 5;
+    oneof pagingMethod {
+        //Paging options to limit and skip the number of items.
+        Paging paging = 3;
+        //Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+        CursorPaging cursor_paging = 6;
+    }
+}
+
+message CursorQuery {
+    option (.wix.api.decomposite_of) = "wix.common.QueryV2";
+    //Filter object in the following format:
+    //`"filter" : {
+    //              "fieldName1": "value1",
+    //              "fieldName2":{"$operator":"value2"}
+    //  }`
+    //Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    google.protobuf.Struct filter = 1;
+    //Sort object in the following format:
+    //`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    repeated Sorting sort = 2;
+    reserved 3;
+    reserved 4;
+    reserved 5;
+    oneof pagingMethod {
+        //Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+        CursorPaging cursor_paging = 6;
+    }
+}
+
+message Search {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "filter"
+        field: "sort"
+        field: "paging"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "filter"
+        field: "sort"
+        field: "cursor_paging"
+    };
+    //A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
+    google.protobuf.Struct filter = 1;
+    //Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+    repeated Sorting sort = 2;
+    //Projection on the result object - list of specific field names to return. If fieldsets are also specified, return the union of fieldsets and fields
+    repeated string fields = 3;
+    //Projection on the result object - list of named projections. E.g. "basic" will return id and name fields. Specifying multiple fieldsets will return the union of fields from all. Specifying fieldsets and fields will also return the union of fields.
+    repeated string fieldsets = 4;
+    //Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
+    repeated Aggregation aggregations = 5;
+    //free text to match in searchable fields
+    SearchDetails search = 6;
+    oneof paging_method {
+        //Pointer to page of results using offset. Can not be used together with 'cursor_paging'
+        Paging paging = 7;
+        //Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort'
+        CursorPaging cursor_paging = 8;
+    }
+}
+
+message CursorSearch {
+    option (.wix.api.decomposite_of) = "wix.common.Search";
+    //A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
+    google.protobuf.Struct filter = 1;
+    //Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+    repeated Sorting sort = 2;
+    reserved 3;
+    reserved 4;
+    reserved 7;
+    //Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
+    repeated Aggregation aggregations = 5;
+    //free text to match in searchable fields
+    SearchDetails search = 6;
+    oneof paging_method {
+        //Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort'
+        CursorPaging cursor_paging = 8;
+    }
+}
+
+message SearchDetails {
+    enum Mode {
+        OR = 0; // any
+        AND = 1; // all
+    }
+    Mode mode = 1; // boolean search mode
+    google.protobuf.StringValue expression = 2; // search term or expression
+    repeated string fields = 3; // fields to search in. if empty - server will search in own default fields
+    bool fuzzy = 4; // flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
+}
+
+enum AggregationType {
+    UNKNOWN_AGGREGATION_TYPE = 0;
+    VALUE = 1;
+    RANGE = 2;
+    SCALAR = 3;
+}
+
+enum ScalarType {
+    UNKNOWN_SCALAR_TYPE = 0;
+    COUNT_DISTINCT = 1;
+    MIN = 2;
+    MAX = 3;
+    SUM = 4 [(.wix.api.enum_exposure) = PRIVATE];
+    AVG = 5 [(.wix.api.enum_exposure) = PRIVATE];
+}
+
+message Aggregation {
+    message RangeAggregation {
+        message RangeBucket {
+            google.protobuf.Int32Value from = 1; // Inclusive lower bound of the range. Required if to is not given.
+            google.protobuf.Int32Value to = 2; // Exclusive upper bound of the range. Required if from is not given.
+        }
+        repeated RangeBucket buckets = 1;
+    }
+
+    message ValueAggregation {
+        enum SortType {
+            COUNT = 0;
+            VALUE = 1;
+        }
+        enum SortDirection {
+            DESC = 0;
+            ASC = 1;
+        }
+        SortType sort_type = 1;
+        SortDirection sort_direction = 2;
+        google.protobuf.Int32Value limit = 3; // How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.
+    }
+
+    message ScalarAggregation {
+        ScalarType type = 1;
+    }
+
+    google.protobuf.StringValue name = 1;
+    AggregationType type = 2;
+    string field_path = 3;
+    oneof kind {
+        ValueAggregation value = 4;
+        RangeAggregation range = 5;
+        ScalarAggregation scalar = 6;
+    }
+}
+
+message AggregationData {
+    message AggregationResults {
+        message ValueResults {
+            message ValueAggregationResult {
+                string value = 1;
+                int32 count = 2;
+            }
+            repeated ValueAggregationResult results = 1;
+        }
+
+        message RangeResults {
+            message RangeAggregationResult {
+                google.protobuf.Int32Value from = 1;
+                google.protobuf.Int32Value to = 2;
+                int32 count = 3;
+            }
+            repeated RangeAggregationResult results = 1;
+        }
+
+        message ScalarResult {
+            ScalarType type = 1;
+            double value = 2;
+        }
+
+        string name = 1;
+        AggregationType type = 2;
+        oneof result {
+            ValueResults values = 3;
+            RangeResults ranges = 4;
+            ScalarResult scalar = 5;
+        }
+    }
+
+    repeated AggregationResults results = 1; // key = aggregation name (as derived from search request)
+}
+
+/*
+// Usage example in response composition:
+message ProductSearchResponse {
+    AggregationData aggregations = 1;
+    PagingMetadataV2 metadata = 2;
+    repeated Product products = 3;
+}
+
+// example Value type Request:
+{
+    search: {
+        expression: "term"
+    },
+    aggregations: [
+        {
+            name: "my-value-aggregation",
+            type: "VALUE",
+            fieldPath: "path.to.field",
+            value: {
+                sort_type: "VALUE",
+                sort_direction: "DESC",
+                limit: 15
+            }
+        }
+    ]
+}
+
+// example Value type Response:
+{
+    aggregations: {
+        results: [
+            {
+                name: "my-value-aggregation",
+                type: "VALUE",
+                values: {
+                    results: [
+                        {
+                            value: "v1",
+                            count: 9
+                        },
+                        {
+                            value: "v2",
+                            count: 6
+                        }
+                    ]
+                }
+            }
+        ]
+    },
+    metadata: {
+      items: 25,
+      offset: 25,
+      total: 420,
+      tooManyToCount: false,
+      cursors: {
+        next: "SOMEHASHFORNEXT",
+        prev: "SOMEHASHFORPREV"
+      }
+    },
+    products: [...]
+}
+
+// example Range type Request:
+{
+    search: {
+        expression: "term"
+    },
+    aggregations: [
+        {
+            name: "my-range-aggregation",
+            type: "RANGE",
+            fieldPath: "path.to.field",
+            range: {
+                buckets: [
+                    {
+                        to: 10
+                    },
+                    {
+                        from: 10,
+                        to: 20
+                    },
+                    {
+                        from: 20
+                    }
+                ]
+            }
+        }
+    ]
+}
+
+// example Range type Response:
+{
+    aggregations: {
+        results: [
+            {
+                name: "my-range-aggregation",
+                type: "RANGE",
+                ranges: {
+                    results: [
+                        {
+                            to: 10,
+                            count: 5
+                        },
+                        {
+                            from: 10,
+                            to: 20,
+                            count: 3
+                        },
+                        {
+                            from: 20,
+                            count: 1
+                        }
+                    ]
+                }
+            }
+        ]
+    },
+    metadata: {
+        items: 25,
+        offset: 25,
+        total: 420,
+        tooManyToCount: false,
+        cursors: {
+          next: "SOMEHASHFORNEXT",
+          prev: "SOMEHASHFORPREV"
+        }
+      },
+      products: [...]
+}
+
+// example Scalar type Request:
+{
+    search: {
+        expression: "term"
+    },
+    aggregations: [
+        {
+            name: "my-scalar-aggregation",
+            type: "SCALAR",
+            fieldPath: "path.to.field",
+            scalar: {
+                type: "AVG"
+            }
+        }
+    ]
+}
+
+// example Scalar type Response:
+{
+    aggregations: {
+        results: [
+            {
+                name: "my-scalar-agregation",
+                type: "SCALAR",
+                scalar: {
+                    type: "AVG",
+                    value: 5.555
+                }
+            }
+        ]
+    },
+    metadata: {
+        items: 25,
+        offset: 25,
+        total: 420,
+        tooManyToCount: false,
+        cursors: {
+          next: "SOMEHASHFORNEXT",
+          prev: "SOMEHASHFORPREV"
+        }
+      },
+      products: [...]
+}
+*/

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

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+package wix.common;
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+message Sorting {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "field_name"
+        field: "order"
+    };
+    // Name of the field to sort by.
+    string field_name = 1;
+    // Sort order.
+    SortOrder order = 2;
+}
+
+enum SortOrder {
+    ASC = 0;
+    DESC = 1;
+}

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

@@ -0,0 +1,66 @@
+syntax = "proto3";
+
+package wix.common.spi;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+message SpiBaseUri {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "base_uri"
+        field: "alternative_uris"
+    };
+    message AlternativeUri {
+        string method_name = 1 [(.wix.api.minLength) = 3]; // name of the method as it appears in the proto
+        string absolute_uri = 2 [(.wix.api.format) = URI]; // absolute uri that will be used by the host to call that method. The path-suffix mapped from the method http option will NOT be appended to this URI. For TPAs. it must be https
+    }
+    string base_uri = 1 [(.wix.api.format) = URI]; // URI that will be used by the host to call the implementer. The path-suffix defined on the method will be appended to it
+    repeated AlternativeUri alternative_uris = 2; // override method mappings per method
+}
+
+/**
+this message is not directly used by any service,
+it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+e.g. SPIs, event-handlers, etc..
+NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+
+Example:
+```typescript
+export function wixStores_onOrderCanceled(event: OrderCanceledEvent, context: Context) {
+  ...
+}
+```
+ */
+message Context {
+    message IdentificationData {
+        option (.wix.api.decomposite_of) = "wix.common.IdentificationData";
+        enum IdentityType {
+            UNKNOWN = 0;
+            ANONYMOUS_VISITOR = 1;
+            MEMBER = 2;
+            WIX_USER = 3;
+            APP = 4;
+        }
+        reserved 1;
+        IdentityType identity_type = 6 [(.wix.api.readOnly) = true];
+        oneof id {
+            // ID of a site visitor that has not logged in to the site.
+            string anonymous_visitor_id = 2 [(.wix.api.format) = GUID];
+            // ID of a site visitor that has logged in to the site.
+            string member_id = 3 [(.wix.api.format) = GUID, (.wix.api.referenced_entity) = "wix.members.v1.member"];
+            // ID of a Wix user (site owner, contributor, etc.).
+            string wix_user_id = 4 [(.wix.api.format) = GUID];
+            // ID of an app.
+            string app_id = 5 [(.wix.api.format) = GUID];
+        }
+    }
+    google.protobuf.StringValue request_id = 1; // A unique identifier for each request. Can be used for logging / troubleshooting
+    google.protobuf.StringValue currency = 2 [(.wix.api.format) = CURRENCY]; // 3 capital letters string representing a currency according to ISO-4217
+    IdentificationData identity = 3; // The identification type and identity data
+    repeated string languages = 4; // A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2
+    google.protobuf.StringValue instance_id = 5 [(.wix.api.format) = GUID]; // App instance ID of SPI in context
+}