@wix/bex-utils 2.30.0 → 2.31.0

package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/sorting.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package wix.common;
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/struct.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 [(.wix.api.maxLength) = 512];
+    // Sort order.
+    SortOrder order = 2;
+    // When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+    // a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    //
+    // If multiple filters are provided, they are combined with AND operator.
+    //
+    // Example:
+    // Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+    // and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+    // { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+    repeated google.protobuf.Struct select_items_by = 3 [(.wix.api.maxSize) = 10, (.wix.api.field_exposure) = PRIVATE];
+}
+
+enum SortOrder {
+    ASC = 0;
+    DESC = 1;
+}

package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/spi.proto

@@ -0,0 +1,85 @@
+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 {
+        /*
+        Name of the method to create a custom URI for.  
+        
+        For `methodName`, use the name of the method in PascalCase. 
+        For example, for Get Shipping Rates use `GetShippingRates`.
+        */
+        string method_name = 1 [(.wix.api.minLength) = 3, (.wix.api.maxLength) = 128];
+        /*
+        Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI. 
+        Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
+        */
+        string absolute_uri = 2 [(.wix.api.minLength) = 6, (.wix.api.maxLength) = 2048];
+    }
+    /*
+    Base URI where the methods are called. Wix appends the path to the `baseUri`. 
+    For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
+    */
+    string base_uri = 1 [(.wix.api.minLength) = 6, (.wix.api.maxLength) = 2048];
+    // Alternate, custom URIs to replace the default URIs for specific service plugin methods.
+    repeated AlternativeUri alternative_uris = 2;
+}
+
+/**
+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, metadata }: OrderCanceledEvent) {
+  ...
+}
+```
+ */
+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 of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.
+    google.protobuf.StringValue currency = 2 [(.wix.api.format) = CURRENCY]; // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+    IdentificationData identity = 3; // An object that describes the identity that triggered this request.
+    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. For example, `"en-US"`.
+    google.protobuf.StringValue instance_id = 5 [(.wix.api.format) = GUID]; // The service provider app's instance ID.
+    google.protobuf.StringValue app_extension_id = 6 [(.wix.api.maxLength) = 256, (wix.api.field_maturity) = ALPHA]; // Extension ID in Dev Center.
+    google.protobuf.StringValue app_extension_type = 7 [(.wix.api.maxLength) = 256, (wix.api.field_maturity) = ALPHA]; // Extension type in Dev Center.
+    google.protobuf.StringValue function_name = 8 [(.wix.api.maxLength) = 256, (wix.api.field_maturity) = ALPHA]; // Invoked function.
+
+}

package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/tags.proto

@@ -0,0 +1,55 @@
+syntax = "proto3";
+
+package wix.common.tags;
+
+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";
+/*
+  Common object for tags.
+  Should be use as in this example:
+  message Foo {
+    string id = 1;
+    // ...
+    Tags tags = 5
+  }
+
+  example of taggable entity
+  {
+    id: "123"
+    tags: {
+      tags: {
+        tag_ids:["11","22"]
+      },
+      private_tags: {
+        tag_ids: ["33", "44"]
+      }
+    }
+  }
+ */
+message Tags {
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "tags"
+  };
+
+  message TagList {
+    repeated string tag_ids = 1 [(.wix.api.maxSize) = 100, (.wix.api.maxLength) = 5]; // List of tag IDs
+  }
+  TagList private_tags = 1; // Tags that require an additional permission in order to access them, normally not given to site members or visitors.
+  TagList tags = 2; // Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
+}
+
+message PublicTags {
+  option (.wix.api.decomposite_of) = "wix.common.tags.Tags";
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "tags"
+  };
+
+  message TagList {
+    repeated string tag_ids = 1 [(.wix.api.maxSize) = 100, (.wix.api.maxLength) = 5]; // List of tag IDs
+  }
+  TagList tags = 2; // Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
+}

package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/wixlink.proto

@@ -0,0 +1,201 @@
+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"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "tpa_page_link"
+    };
+    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
+        TpaPageLink tpa_page = 10; // TPA link type
+    }
+}
+
+message ExternalLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "url"
+    };
+    //The url of the page
+    string url = 1 [(.wix.api.format) = WEB_URL];
+    //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;
+    //rel of link
+    repeated LinkRel rel = 3 [(wix.api.maxSize) = 20];
+}
+
+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;
+    //rel of link
+    repeated LinkRel rel = 4 [(wix.api.maxSize) = 20];
+}
+
+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;
+    //rel of link
+    repeated LinkRel rel = 4 [(wix.api.maxSize) = 20];
+}
+
+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];
+}
+
+//Link to a TPA page
+message TpaPageLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "item_type_identifier"
+        field: "item_id"
+        field: "page_id"
+        field: "app_definition_id"
+        field: "path"
+    };
+    //Type of item (e.g. 'wix.stores.sub_pages.product')
+    string item_type_identifier = 1;
+    //Id of linked item
+    string item_id = 2;
+    //Id of linked page
+    string page_id = 3;
+    //Id of app being linked to (AppDefId)
+    string app_definition_id = 4;
+    //The relativepath of linked page
+    string path = 5;
+    //rel of link
+    repeated LinkRel rel = 6 [(wix.api.maxSize) = 20];
+}
+
+//The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
+//Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
+//Following are the accepted 'rel' types by Wix applications.
+enum LinkRel {
+    // default (not implemented)
+    unknown_link_rel = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    //Indicates that the current document's original author or publisher does not endorse the referenced document.
+    nofollow = 1;
+    //Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it.
+    noopener = 2;
+    //No Referer header will be included. Additionally, has the same effect as noopener.
+    noreferrer = 3;
+    //Indicates a link that resulted from advertisements or paid placements.
+    sponsored = 4;
+}

package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/graphql/definitions.proto

@@ -0,0 +1,13 @@
+syntax = "proto2";
+
+package wix.graphql;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "GraphqlProto";
+option java_package = "com.wix.graphql";
+
+extend google.protobuf.FileOptions {
+  optional string namespace = 66000;
+}

package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/http/field_mask.proto

@@ -0,0 +1,46 @@
+syntax = "proto2";
+
+package wix.http;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "FieldmaskProto";
+option java_package = "com.wix.http";
+
+/*
+When (most commonly) update endpoint accepts FieldMask object, from REST client perspective it is redundant and can be
+inferred from the actual JSON payload that was sent. This field annotation will tell the framework to use the JSON body
+and automatically construct the fieldmask. E.g.
+```
+import "wix/http/field_mask.proto";
+
+rpc UpdateProduct (UpdateProductRequest) returns (UpdateProductResponse) {
+  option (google.api.http) = {
+    PATCH: "/v1/products/{product.id}
+  };
+  option (wix.http.infer_fieldmask) = {
+    from: "product"
+    fieldmask: "mask"
+  };
+}
+
+message UpdateProductRequest {
+  Product product = 1;
+  google.protobuf.FieldMask mask = 2;
+}
+```
+*/
+extend google.protobuf.FieldOptions {
+  optional string infer_fieldmask_from = 50901 [deprecated=true];
+}
+
+extend google.protobuf.MethodOptions {
+  optional InferFieldmask infer_fieldmask = 50902;
+}
+
+message InferFieldmask {
+  required string from = 1; // ref to field on which we want to infer
+  required string fieldmask = 2; // ref to actual fieldmask member
+  optional bool snake_case_comma_separated_mask = 3; // recase comma-separated field mask to snake_case (legacy behavior)
+}

package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/sdk/definitions.proto

@@ -0,0 +1,191 @@
+syntax = "proto2";
+
+package wix.sdk;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "DefinitionsProto";
+option java_package = "com.wix.sdk";
+
+
+/**
+logic of signature generation:
+==============================
+
+1) `id` (path-param) should be the first argument.
+2) if there are more identifiers (path-params), a parent object called `identifiers` containing those will be the first argument.
+3) first payload member will be the second argument unless overridden via proto option. in case of override, args will be taken from override option value in-order.
+4) rest of arguments (if exist) will follow under the `options` parent.
+
+internal logic for `identifiers` field:
+take all path-params, merge with all `unique` fields, distinct.
+if you have total args > 1 -> put all in `identifiers` parent.
+otherwise - use single (usually id) arg as is and make it the first param.
+
+`sdk.signature.params` cannot control neither `options` (last param) nor `id`/`identifiers` (first param) as those are needed by convention in Velo.
+
+
+Examples:
+=========
+
+  // Example-1: Default behavior, single identifier:
+  message GetProductRequest {
+    option (.wix.api.unique) = {field: "id"}; //not needed, automatically assumed
+    string id = 1;
+    string product_family = 2;
+    bool include_pii = 3;
+  }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/products/{id}"
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(id: string, productFamily: string, options: {includePii: boolean}) Product {...}
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            field: {
+              path: "id"  <-- field name in proto request message
+            }
+          },
+          {
+            field: {
+              path: "productFamily"  <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "includePii" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+
+  // Example-2: Default behavior, multiple identifiers:
+    message GetProductRequest {
+      option (.wix.api.unique) = {
+        field: "catalogId"
+        field: "productId"
+      };
+      string catalogId = 1;
+      string productId = 2;
+      string product_family = 3;
+      bool include_pii = 4;
+    }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/catalog/{catalogId}/products/{productId}"
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, productFamily: string, options: {includePii: boolean}) Product {...}
+  // schema response:
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            parent: {
+              name: "identifiers"
+              fields: [
+                {
+                  path: "catalogId"  <-- field name in proto request message
+                },
+                {
+                  path: "productId" <-- field name in proto request message
+                },
+              ]
+            }
+          },
+          {
+            field: {
+              path: "productFamily" <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "includePii" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+
+  // Example-3: Using override option, multiple identifiers:
+    message GetProductRequest {
+      option (.wix.api.unique) = {
+        field: "catalogId"
+        field: "productId"
+      };
+      string catalogId = 1;
+      string productId = 2;
+      string product_family = 3;
+      bool include_pii = 4;
+    }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/catalog/{catalogId}/products/{productId}"
+    };
+    option (.wix.sdk.signature) = {
+      params = "include_pii" // the rest will be auto wired to options arg
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, includePii: boolean, options: {productFamily: string}) Product {...}
+  // schema response:
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            parent: {
+              name: "identifiers"
+              fields: [
+                {
+                  path: "catalogId"  <-- field name in proto request message
+                },
+                {
+                  path: "productId" <-- field name in proto request message
+                }
+              ]
+            }
+          },
+          {
+            field: {
+              path: "includePii" <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "productFamily" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+**/
+
+extend google.protobuf.MethodOptions {
+  repeated Signature signature = 60100;
+}
+
+message Signature {
+  repeated string params = 1;
+}