@wix/bex-utils 1.28.0

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/errors.proto

@@ -0,0 +1,113 @@
+syntax = "proto3";
+
+package wix.api;
+
+option java_package = "com.wix.api";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+
+message Details {
+    oneof kind {
+        ApplicationError application_error = 1;
+        ValidationError validation_error = 2;
+    }
+    map<string, string> tracing = 3 [deprecated = true]; // deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
+}
+
+message ApplicationError {
+    // Error code.
+    string code = 1;
+    // Description of the error.
+    string description = 2;
+    // Data related to the error.
+    google.protobuf.Struct data = 3;
+}
+
+/**
+example result:
+{
+  "fieldViolations": [
+    {
+      "field": "fieldA",
+      "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
+      "violatedRule": "OTHER",
+      "ruleName": "INVALID_NOTE",
+      "data": {
+        "value": "FI"
+      }
+    },
+    {
+      "field": "fieldB",
+      "description": "field value out of range. supported range: [0-20]",
+      "violatedRule": "MAX",
+      "data": {
+        "threshold": 20
+      }
+    },
+    {
+      "field": "fieldC",
+      "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
+      "violatedRule": "FORMAT",
+      "data": {
+        "type": "PHONE"
+      }
+    }
+  ]
+}
+**/
+message ValidationError {
+    enum RuleType {
+        VALIDATION = 0;
+        OTHER = 1;
+        MAX = 2;
+        MIN = 3;
+        MAX_LENGTH = 4;
+        MIN_LENGTH = 5;
+        MAX_SIZE = 6;
+        MIN_SIZE = 7;
+        FORMAT = 8;
+        DECIMAL_LTE = 9;
+        DECIMAL_GTE = 10;
+        DECIMAL_LT = 11;
+        DECIMAL_GT = 12;
+        DECIMAL_MAX_SCALE = 13;
+        INVALID_ENUM_VALUE = 14;
+        REQUIRED_FIELD = 15;
+        FIELD_NOT_ALLOWED = 16;
+        ONE_OF_ALIGNMENT = 17;
+    }
+    message FieldViolation {
+        string field = 1;
+        string description = 2;
+        RuleType violated_rule = 3;
+        google.protobuf.StringValue rule_name = 4; // applicable when violated_rule=OTHER
+        google.protobuf.Struct data = 5;
+    }
+    repeated FieldViolation field_violations = 1;
+}
+
+// for all kinds of min/max violations - match to type provided in annotation
+message LimitRuleInt32DataPayload {
+    int32 threshold = 1;
+}
+
+// for all kinds of min/max violations - match to type provided in annotation
+message LimitRuleDoubleDataPayload {
+    double threshold = 1;
+}
+
+// for all kinds of min/max violations - match to type provided in annotation
+message LimitRuleStringDataPayload {
+    string threshold = 1;
+}
+
+// for format violations
+message FormatRuleDataPayload {
+    string type = 1;
+}
+
+// for enum violations
+message EnumRuleDataPayload {
+    repeated string supported = 1;
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/permissions.proto

@@ -0,0 +1,40 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "PermissionsProto";
+option java_package = "com.wix.api";
+
+/**
+* Annotation for method permission rules
+* example usage:
+* import "wix/api/permissions.proto";
+* service Bloop {
+*    rpc Create (CreateBloopRequest) returns (CreateBloopResponse) {
+*        option (wix.api.permission).name = "SOME_PERMISSION_NAME";
+*    }
+*    rpc SpecialDelete (SpecialDeleteBloopRequest) returns (SpecialDeleteResponse) {
+*        option (wix.api.permission) = {
+*           name: "SOME_PERMISSION_NAME"
+*           type: MANUAL
+*        }
+*    }
+* }
+**/
+extend google.protobuf.MethodOptions {
+    optional PermissionRule permission = 50301;
+    repeated PermissionRule additional_permission = 50302;
+}
+
+message PermissionRule {
+  optional string name = 1;
+  optional PermissionType type = 2;
+}
+
+enum PermissionType {
+    AUTO = 0;
+    MANUAL = 1;
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/sla.proto

@@ -0,0 +1,24 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "SlaProto";
+option java_package = "com.wix.api";
+
+extend google.protobuf.MethodOptions {
+    optional Sla sla = 50700;
+}
+
+message Sla {
+    /*
+     * Number of milliseconds after which the method will timeout
+     * and return TIMEOUT (504) response for http or DEADLINE_EXCEEDED
+     * for grpc.
+     * This default deadline will be applied automatically
+     * iff request does not contain deadline information.
+     */
+    optional int32 response_time_ms = 1;
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/subscription.proto

@@ -0,0 +1,31 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+import "wix/api/callback.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "SubscriptionProto";
+option java_package = "com.wix.api";
+
+/*
+Marks a method as a topic consumer.
+service BlooperService {
+   rpc Update (BlooperUpdateNotification) returns (google.protobuf.Empty) {
+       option (wix.api.subscription) = {
+           topic: "Blooper.Update"
+       };
+   };
+}
+*/
+extend google.protobuf.MethodOptions {
+    optional Subscription subscription = 50400;
+}
+
+message Subscription {
+    optional string topic = 1;
+    optional Segment.Segment segment = 4; // currently defaults to "legacy", will be `required` when legacy cluster is removed
+    optional bool batch = 2 [deprecated = true];
+    optional string entity = 3;
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/validations.proto

@@ -0,0 +1,133 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "wix/api/api_errors.proto";
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "ValidationsProto";
+option java_package = "com.wix.api";
+
+/**
+*  Annotation for field validation rules
+*  example usage:
+*    import "wix/api/validations.proto";
+*
+*    message User {
+*      string id = 1 [(wix.api.readOnly)=true, (wix.api.format)=GUID];
+*      double age = 2 [(wix.api.max)=120, (wix.api.min)=0];
+*      string email = 3 [(wix.api.format)=EMAIL];
+*      string username = 4 [(wix.api.minLength)=3];
+*      string phone = 5 [(wix.api.format)=PHONE];
+*    }
+*
+*    message Invoice {
+*      string id = 1 [(wix.api.readOnly)=true, (wix.api.format)=GUID];
+*      string amount_paid = 2 [(wix.api.decimalValue) = { gte: "0.01" lt: "10" maxScale: 2 }];
+*    }
+**/
+extend google.protobuf.FieldOptions {
+    // max possible value
+    optional double max = 50201;
+    // min possible value
+    optional double min = 50202;
+    // max length for strings
+    optional int32 maxLength = 50203;
+    // min length for strings
+    optional int32 minLength = 50204;
+    // max size for repeated field, map
+    optional int32 maxSize = 50209;
+    // min size for repeated field, map
+    optional int32 minSize = 50210;
+    // common known formats like email, URI, etc.
+    optional Format format = 50205;
+    // indicates this field cannot be set by the client. E.g. Id field assigned by the server
+    optional bool readOnly = 50208;
+    // indicates this field can be set by the client, but can never be changed or updated
+    optional bool immutable = 50212;
+    // decimal value format
+    optional DecimalValueOptions decimalValue = 50211;
+    // declare custom field validation for all methods
+    optional CustomValidationError custom_validation = 50214;
+}
+
+/**
+* Decimal value validation rules.
+* Based on java.math.BigDecimal, implies (wix.api.format) = DECIMAL_VALUE
+*/
+message DecimalValueOptions {
+    optional string lte = 1; // less than or equal
+    optional string gte = 2; // greater than or equal
+    optional string lt = 3; // less than
+    optional string gt = 4; // greater than
+    optional int32 maxScale = 5; // max number of fractional digits
+}
+
+/**
+* Annotation for method validation rules
+* example usage:
+* import "wix/api/validations.proto";
+* service Bloop {
+*    rpc Create (CreateBloopRequest) returns (CreateBloopResponse) {
+*       option (wix.api.required) = "CreateBloopRequest.Bloop.name";
+*    }
+* }
+**/
+extend google.protobuf.MethodOptions {
+    // Specify which fields are required in this method.
+    // Annotating a nested field as `required` does not imply that the whole path to that field is required, eg.
+    // `option (wix.api.required) = "person.pet.name";` means that if a `person` has a `pet`, then the `pet` must have
+    // a `name` set; it does not mean that `person` or `person.pet` themselves are required - these fields should be
+    // annotated individually if needed.
+    // This option can be repeated multiple times to specify multiple fields.
+    // example use:
+    //    option (wix.api.required) = "userId";
+    //    option (wix.api.required) = "userName";
+    repeated string required = 50200;
+    // Specify list of `immutable` fields which can be writable in this method.
+    // Most common in Create methods
+    // Only `immutable` AND NOT `readOnly` fields are allowed to be referenced via this annotation
+    // example use:
+    //    option (wix.api.writable) = "id"; // user-generated id is enabled
+    repeated string writable = 50213;
+}
+
+extend google.protobuf.OneofOptions {
+    // name of the enum field that must be aligned with this oneof (AIP 7015)
+    // ADR 038: Linking oneOf with Enum: https://github.com/wix-private/server-infra/blob/master/framework/docs/adr/adr-038-aligned-with-enum.md
+    optional AlignedWithEnum aligned_with_enum = 50800;
+}
+
+message AlignedWithEnum {
+    required string field = 1;
+}
+
+enum Format {
+    EMAIL = 0;
+    HOSTNAME = 1;
+    IPV4 = 2;
+    IPV6 = 3;
+    URI = 4;
+    WEB_URL = 5; // HTTP or HTTPS
+    PHONE = 7;
+    CREDIT_CARD = 8;
+    GUID = 9;
+    COUNTRY = 10; // 2 letters ISO-3166-1
+    LANGUAGE = 11; // 2 letters ISO-639-1
+    /*
+      Use this on string or stringValue types to validate the format of that field is same as a decimal value.
+      This will ensure keeping the precision of decimal value, such as when passing monetary values.
+    */
+    DECIMAL_VALUE = 12;
+    CURRENCY = 13; // 3 letters - all available currencies
+    LANGUAGE_TAG = 14; // IETF BCP 47 language tag (e.g. en-US)
+    COLOR_HEX = 15;
+    LOCAL_DATE = 16; // ISO-8601 extended local date format (YYYY-MM-DD)
+    LOCAL_TIME = 17; // ISO-8601 extended local time format (hh:mm[:ss][.sss])
+    LOCAL_DATE_TIME = 18; // ISO-8601 extended local date-time format (YYYY-MM-DDThh:mm[:ss][.sss])
+    URL_SLUG = 19;
+    SYSTEM_SLUG = 20;
+}
+
+

package/@wix/ambassador-app-settings-v1-settings/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-app-settings-v1-settings/src/main/proto/wix/http/field_mask.proto

@@ -0,0 +1,45 @@
+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
+}

package/@wix/ambassador-app-settings-v1-settings/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;
+}