@wix/bex-utils 1.28.0

package/@wix/ambassador-os-tags-v1-tag/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.format) = GUID]; // 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.format) = GUID]; // 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-os-tags-v1-tag/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];
+}

package/@wix/ambassador-os-tags-v1-tag/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-os-tags-v1-tag/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-os-tags-v1-tag/src/main/proto/wix/os/v1/tag.proto

@@ -0,0 +1,39 @@
+syntax = "proto3";
+
+package wix.os.v1;
+option java_package = "com.wixpress.os.v1";
+
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "wix/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "wix/os/v1/tag_exposure.proto";
+
+message Tag {
+  option (wix.api.entity) = {
+    fqdn: "wix.os.tags.v1.tag"
+    segment: USERS
+  };
+
+  // Tag ID.
+  google.protobuf.StringValue id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  // Revision number.
+  google.protobuf.Int64Value revision = 2 [(wix.api.readOnly) = true];
+
+  // Date and time the Tag was created.
+  google.protobuf.Timestamp created_date = 3 [(wix.api.readOnly) = true];
+
+  // Date and time the Tag was last updated.
+  google.protobuf.Timestamp updated_date = 4 [(wix.api.readOnly) = true];
+
+  // Tag name
+  google.protobuf.StringValue name = 5 [(wix.api.maxLength) = 255];
+
+  // FQDN of the entity that belongs to this tag
+  google.protobuf.StringValue fqdn = 6 [(wix.api.immutable) = true, (wix.api.maxLength) = 255];
+
+  // Tag exposure
+  TagExposure exposure = 7;
+}

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

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package wix.os.v1;
+option java_package = "com.wixpress.os.v1";
+
+import "wix/api/annotations.proto";
+
+enum TagExposure {
+  UNKNOWN = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+  PRIVATE = 1;
+  PUBLIC = 2;
+}

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

@@ -0,0 +1,192 @@
+syntax = "proto3";
+
+package wix.os.v1;
+option java_package = "com.wixpress.os.v1";
+
+import "google/protobuf/field_mask.proto";
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "wix/api/permissions.proto";
+import "wix/api/callback.proto";
+import "wix/http/field_mask.proto";
+import "wix/common/query.proto";
+import "wix/common/paging.proto";
+import "wix/os/v1/tag.proto";
+import "wix/os/v1/tag_exposure.proto";
+import "wix/api/errors.proto";
+import "wix/api/api_errors.proto";
+
+/**
+  Manages Tags
+ */
+service TagsService {
+  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_exposure) = INTERNAL;
+  option (wix.api.service_entity).message = "wix.os.v1.Tag";
+
+  /**
+    Creates a Tag.
+   */
+  rpc CreateTag (CreateTagRequest) returns (CreateTagResponse) {
+    option (google.api.http).post = "/v1/tags";
+    option (wix.api.permission).name = "TAGS.TAG_CREATE";
+    option (wix.api.required) = "CreateTagRequest.tag";
+    option (wix.api.required) = "CreateTagRequest.tag.fqdn";
+    option (wix.api.required) = "CreateTagRequest.tag.exposure";
+    option (wix.api.required) = "CreateTagRequest.tag.name";
+
+    option (wix.api.crud) = {
+      method: CREATE
+      create_options: {
+        item_field: "tag"
+      }
+    };
+
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+
+    option (.wix.api.error) = {
+      http_code: NOT_FOUND
+      application_code: "FQDN_NOT_FOUND"
+    };
+
+    option (.wix.api.error) = {
+      http_code: ALREADY_EXISTS
+      application_code: "TAG_NAME_ALREADY_EXISTS"
+    };
+
+    option (.wix.api.error) = {
+      http_code: RESOURCE_EXHAUSTED
+      application_code: "TAGS_REACHED_LIMIT"
+    };
+  }
+
+  /**
+    Retrieves a Tag.
+   */
+  rpc GetTag (GetTagRequest) returns (GetTagResponse) {
+    option (google.api.http).get = "/v1/tags/{tag_id}";
+    option (wix.api.permission).name = "TAGS.TAG_READ";
+    option (wix.api.required) = "GetTagRequest.tag_id";
+
+    option (wix.api.crud) = {
+      method: GET_ITEM
+      get_options: {
+        id_field: "tag_id"
+      }
+    };
+  }
+
+  /**
+  Updates a Tag.
+   */
+  rpc UpdateTag (UpdateTagRequest) returns (UpdateTagResponse) {
+    option (google.api.http).patch = "/v1/tags/{tag.id}";
+    option (wix.api.permission).name = "TAGS.TAG_UPDATE";
+    option (wix.api.required) = "UpdateTagRequest.tag";
+    option (wix.api.required) = "UpdateTagRequest.tag.id";
+    option (wix.api.required) = "UpdateTagRequest.tag.revision";
+    option (wix.api.required) = "UpdateTagRequest.tag.name";
+
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+
+    option (wix.api.crud) = {
+      method: UPDATE
+      update_options: {
+        item_field: "tag"
+      }
+    };
+  }
+
+  /**
+    Deletes a Tag.
+   */
+  rpc DeleteTag (DeleteTagRequest) returns (DeleteTagResponse) {
+    option (google.api.http).delete = "/v1/tags/{tag_id}";
+    option (wix.api.permission).name = "TAGS.TAG_DELETE";
+    option (wix.api.required) = "DeleteTagRequest.tag_id";
+
+    option (wix.api.callback) = {
+      event_type: DELETED
+    };
+
+    option (wix.api.crud) = {
+      method: DELETE
+      delete_options: {
+        id_field: "tag_id"
+      }
+    };
+  }
+
+  /**
+    Retrieves a list of Tags
+   */
+  rpc ListTags (ListTagsRequest) returns (ListTagsResponse) {
+    option (google.api.http).get = "/v1/tags";
+    option (wix.api.permission).name = "TAGS.TAG_READ";
+    option (wix.api.required) = "ListTagsRequest.fqdn";
+
+    option (wix.api.crud) = {
+      method: LIST
+      list_options: {
+        items_field: "tags"
+      }
+    };
+  }
+}
+
+message CreateTagRequest {
+  // Tag to be created.
+  Tag tag = 1;
+}
+
+message CreateTagResponse {
+  // The created Tag.
+  Tag tag = 1;
+}
+
+message GetTagRequest {
+  // ID of the Tag to retrieve.
+  string tag_id = 1 [(wix.api.format) = GUID];
+}
+
+message GetTagResponse {
+  // The requested Tag.
+  Tag tag = 1;
+}
+
+message UpdateTagRequest {
+  // Tag to be updated, may be partial.
+  Tag tag = 1;
+}
+
+message UpdateTagResponse {
+  // Updated Tag.
+  Tag tag = 1;
+}
+
+message DeleteTagRequest {
+  // Id of the Tag to delete.
+  string tag_id = 1 [(wix.api.format) = GUID];
+}
+
+message DeleteTagResponse {
+}
+
+message ListTagsRequest {
+  // FQDN
+  string fqdn = 1 [(wix.api.maxLength) = 255];
+
+  // Exposure
+  TagExposure exposure = 2;
+}
+
+message ListTagsResponse {
+  // List of Tags.
+  repeated Tag tags = 1;
+}

package/@wix/ambassador-os-tags-v1-tag/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;
+}