@wix/bex-utils 2.36.0 → 2.39.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/stores/catalog/location/v3/upstream/wix/common/paging.proto

@@ -1,121 +0,0 @@
-syntax = "proto3";
-
-package wix.stores.catalog.location.v3.upstream.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.stores.catalog.location.v3.upstream.wix.common";
-
-message Paging {
-    option (.wix.api.decomposite_of) = "wix.common.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.decomposite_of) = "wix.common.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 [(.wix.api.maxLength) = 16000];;
-}
-
-message PagingMetadata {
-    option (.wix.api.decomposite_of) = "wix.common.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;
-    /*
-    Whether there are more pages to retrieve following the current page.
-
-    + `true`: Another page of results can be retrieved.
-    + `false`: This is the last page.
-    */
-    google.protobuf.BoolValue has_next = 5 [(.wix.api.field_exposure) = PRIVATE];
-}
-
-message PagingMetadataV2 {
-    option (.wix.api.decomposite_of) = "wix.common.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;
-    /*
-    Whether there are more pages to retrieve following the current page.
-
-    + `true`: Another page of results can be retrieved.
-    + `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.CursorPagingMetadata";
-    // Number of items returned in the response.
-    google.protobuf.Int32Value count = 1;
-    // Offset that was requested.
-    Cursors cursors = 2;
-    /*
-    Whether there are more pages to retrieve following the current page.
-
-    + `true`: Another page of results can be retrieved.
-    + `false`: This is the last page.
-    */
-    google.protobuf.BoolValue has_next = 3;
-}
-
-message Cursors {
-    option (.wix.api.decomposite_of) = "wix.common.Cursors";
-    option (.wix.api.decomposition_minimum_fields) = {
-        field: "next"
-    };
-    // Cursor pointing to next page in the list of results.
-    google.protobuf.StringValue next = 1 [(.wix.api.maxLength) = 16000];
-    // Cursor pointing to previous page in the list of results.
-    google.protobuf.StringValue prev = 2 [(.wix.api.maxLength) = 16000];
-}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/stores/catalog/location/v3/upstream/wix/common/sorting.proto

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

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/stores/catalog/location/v3/upstream/wix/query/query.proto

@@ -1,436 +0,0 @@
-syntax = "proto3";
-
-package wix.stores.catalog.location.v3.upstream.wix.query;
-
-import "google/protobuf/struct.proto";
-import "google/protobuf/wrappers.proto";
-import "wix/stores/catalog/location/v3/upstream/wix/common/sorting.proto";
-import "wix/stores/catalog/location/v3/upstream/wix/common/paging.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.stores.catalog.location.v3.upstream.wix.query";
-
-message Query {
-    option (.wix.api.decomposite_of) = "wix.common.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 wix.common.Sorting sort = 2 [(.wix.api.maxSize) = 8];
-    //Paging options to limit and skip the number of items.
-    wix.common.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 [(.wix.api.maxSize) = 100, (.wix.api.maxLength) = 20];
-    //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 [(.wix.api.maxSize) = 100, (.wix.api.maxLength) = 20];
-}
-
-message QueryV2 {
-    option (.wix.api.decomposite_of) = "wix.common.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 wix.common.Sorting sort = 2 [(.wix.api.maxSize) = 8];
-    //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 [(.wix.api.maxSize) = 100, (.wix.api.maxLength) = 20];
-    //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 [(.wix.api.maxSize) = 100, (.wix.api.maxLength) = 20];
-    oneof pagingMethod {
-        //Paging options to limit and skip the number of items.
-        wix.common.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`.
-        wix.common.CursorPaging cursor_paging = 6;
-    }
-}
-
-message CursorQuery {
-    option (.wix.api.decomposite_of) = "wix.common.CursorQuery";
-    //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 wix.common.Sorting sort = 2 [(.wix.api.maxSize) = 8];
-    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`.
-        wix.common.CursorPaging cursor_paging = 6;
-    }
-}
-
-message Search {
-    option (.wix.api.decomposite_of) = "wix.common.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 wix.common.Sorting sort = 2 [(.wix.api.maxSize) = 8];
-    //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 [(.wix.api.maxLength) = 200, (.wix.api.maxSize) = 20];
-    //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 [(.wix.api.maxLength) = 100, (.wix.api.maxSize) = 20];
-    //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 [(.wix.api.maxSize) = 8];
-    //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'
-        wix.common.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'
-        wix.common.CursorPaging cursor_paging = 8;
-    }
-}
-
-message CursorSearch {
-    option (.wix.api.decomposite_of) = "wix.common.CursorSearch";
-    //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 wix.common.Sorting sort = 2 [(.wix.api.maxSize) = 8];
-    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 [(.wix.api.maxSize) = 8];
-    //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'
-        wix.common.CursorPaging cursor_paging = 8;
-    }
-}
-
-message SearchDetails {
-    option (.wix.api.decomposite_of) = "wix.common.SearchDetails";
-    enum Mode {
-        OR = 0; // any
-        AND = 1; // all
-    }
-    Mode mode = 1; // boolean search mode
-    google.protobuf.StringValue expression = 2 [(.wix.api.maxLength) = 100]; // Search term or expression
-    // Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
-    repeated string fields = 3 [(.wix.api.maxLength) = 200, (.wix.api.maxSize) = 20];
-    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 {
-    option (.wix.api.decomposite_of) = "wix.common.Aggregation";
-    message RangeAggregation {
-        option (.wix.api.decomposite_of) = "wix.common.Aggregation.RangeAggregation";
-        message RangeBucket {
-            option (.wix.api.decomposite_of) = "wix.common.Aggregation.RangeAggregation.RangeBucket";
-            google.protobuf.DoubleValue from = 1; // Inclusive lower bound of the range. Required if to is not given.
-            google.protobuf.DoubleValue to = 2; // Exclusive upper bound of the range. Required if from is not given.
-        }
-        // List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
-        repeated RangeBucket buckets = 1 [(.wix.api.maxSize) = 50];
-    }
-
-    message ValueAggregation {
-        option (.wix.api.decomposite_of) = "wix.common.Aggregation.ValueAggregation";
-        enum SortType {
-            COUNT = 0;
-            VALUE = 1;
-        }
-        enum SortDirection {
-            DESC = 0;
-            ASC = 1;
-        }
-        SortType sort_type = 1; // Should sort by number of matches or value of the field
-        SortDirection sort_direction = 2; // Should sort in ascending or descending order
-        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 {
-        option (.wix.api.decomposite_of) = "wix.common.Aggregation.ScalarAggregation";
-        ScalarType type = 1; // Define the operator for the scalar aggregation
-    }
-
-    google.protobuf.StringValue name = 1 [(.wix.api.maxLength) = 100]; // User-defined name of aggregation, should be unique, will appear in aggregation results
-    AggregationType type = 2; // Type of aggregation, client must provide matching aggregation field below
-    string field_path = 3 [(.wix.api.maxLength) = 200]; // Field to aggregate by, use dot notation to specify json path
-    oneof kind {
-        ValueAggregation value = 4; // Value aggregation
-        RangeAggregation range = 5; // Range aggregation
-        ScalarAggregation scalar = 6; // Scalar aggregation
-    }
-}
-
-message AggregationData {
-    option (.wix.api.decomposite_of) = "wix.common.AggregationData";
-    message AggregationResults {
-        option (.wix.api.decomposite_of) = "wix.common.AggregationData.AggregationResults";
-        message ValueResults {
-            option (.wix.api.decomposite_of) = "wix.common.AggregationData.AggregationResults.ValueResults";
-            message ValueAggregationResult {
-                option (.wix.api.decomposite_of) = "wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult";
-                string value = 1 [(.wix.api.maxLength) = 100]; // Value of the field
-                int32 count = 2; // Count of entities with this value
-            }
-            repeated ValueAggregationResult results = 1 [(.wix.api.maxSize) = 250]; // List of value aggregations
-        }
-
-        message RangeResults {
-            option (.wix.api.decomposite_of) = "wix.common.AggregationData.AggregationResults.RangeResults";
-            message RangeAggregationResult {
-                option (.wix.api.decomposite_of) = "wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult";
-                google.protobuf.DoubleValue from = 1; // Inclusive lower bound of the range
-                google.protobuf.DoubleValue to = 2; // Exclusive upper bound of the range
-                int32 count = 3; // Count of entities in this range
-            }
-            repeated RangeAggregationResult results = 1 [(.wix.api.maxSize) = 50]; // List of ranges returned in same order as requested
-        }
-
-        message ScalarResult {
-            option (.wix.api.decomposite_of) = "wix.common.AggregationData.AggregationResults.ScalarResult";
-            ScalarType type = 1; // Type of scalar aggregation
-            double value = 2; // Value of the scalar aggregation
-        }
-
-        string name = 1 [(.wix.api.maxLength) = 100]; // User-defined name of aggregation as derived from search request
-        AggregationType type = 2; // Type of aggregation that must match provided kind as derived from search request
-        oneof result {
-            ValueResults values = 3; // Value aggregation results
-            RangeResults ranges = 4; // Range aggregation results
-            ScalarResult scalar = 5; // Scalar aggregation results
-        }
-    }
-
-    repeated AggregationResults results = 1 [(.wix.api.maxSize) = 10000]; // key = aggregation name (as derived from search request)
-}
-
-/*
-// Usage example in response composition:
-message ProductSearchResponse {
-    option (.wix.api.decomposite_of) = "wix.common.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: [...]
-}
-*/