@wix/bex-utils 1.28.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/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-fedinfra-exportservice-v1-export-async-job/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-fedinfra-exportservice-v1-export-async-job/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
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/wixlink.proto

@@ -0,0 +1,152 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_outer_classname = "WixLinkProto";
+option java_package = "com.wix.common";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+//The link object generated by panels in the editor and used by applications in Wix
+message WixLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "external"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "page"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "anchor"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "dynamic_page"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "document"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "email"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "phone"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "address"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "whats_app"
+    };
+    oneof Link {
+        ExternalLink external = 1; // External link type
+        PageLink page = 2; // Page link type
+        AnchorLink anchor = 3; // Anchor link type
+        DynamicPageLink dynamic_page = 4; // Dynamic page link type
+        DocumentLink document = 5; // Document link type
+        EmailLink email = 6; // Email link type
+        PhoneLink phone = 7; // Phone link type
+        AddressLink address = 8; // Address link type
+        WhatsAppLink whats_app = 9; // WhatsApp link type
+    }
+}
+
+message ExternalLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "url"
+    };
+    //The url of the page
+    string url = 1 [(.wix.api.format) = URI];
+    //Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page.
+    google.protobuf.StringValue target = 2;
+}
+
+message PageLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "page_id"
+    };
+    //The page id we want from the site
+    string page_id = 1;
+    //Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page.
+    google.protobuf.StringValue target = 2;
+}
+
+message AnchorLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "anchor_name"
+        field: "anchor_data_id"
+        field: "page_id"
+    };
+    //The name of the anchor
+    string anchor_name = 1;
+    //The data id (from the JSON page) of the anchor that should be used
+    string anchor_data_id = 2;
+    //The page id we want from the site
+    string page_id = 3;
+}
+
+message DynamicPageLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "router_id"
+        field: "inner_route"
+        field: "anchor_data_id"
+    };
+    //The router that handles this link
+    string router_id = 1;
+    //The path data we'd like
+    string inner_route = 2;
+    //The data id (from the JSON page) of the anchor that should be used
+    google.protobuf.StringValue anchor_data_id = 3;
+}
+
+message DocumentLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "doc_id"
+        field: "name"
+    };
+    //The id of the document
+    string doc_id = 1;
+    //The name of the document for download purposes
+    google.protobuf.StringValue name = 2;
+    //If this document can be indexed by scrapers, default is false
+    bool indexable = 3;
+}
+
+message EmailLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "recipient"
+        field: "subject"
+        field: "body"
+    };
+    //The email we will be sending a message to
+    string recipient = 1 [(.wix.api.format) = EMAIL];
+    //The subject of the email
+    google.protobuf.StringValue subject = 2;
+    //The body of the email
+    google.protobuf.StringValue body = 3;
+}
+
+message PhoneLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "phone_number"
+    };
+    //The phone number we want to link to
+    string phone_number = 1 [(.wix.api.pii) = true, (.wix.api.format) = PHONE, (.wix.api.maxLength) = 100];
+}
+
+message AddressLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "address"
+    };
+    //An address that we can link to
+    string address = 1 [(.wix.api.pii) = true];
+}
+
+message WhatsAppLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "phone_number"
+    };
+    //The whatsApp phone number we want to connect with
+    string phone_number = 1 [(.wix.api.pii) = true, (.wix.api.format) = PHONE];
+}