@wix/bex-utils 2.71.0 → 2.72.0

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/variants_generator/v1/variant.proto

@@ -0,0 +1,92 @@
+syntax = "proto3";
+
+package wix.personalize.variants_generator.v1;
+option java_package = "com.wixpress.personalize.variants.generator.v1";
+
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "google/protobuf/wrappers.proto";
+
+/**
+  A Variant is a variation of a content with a persona voice.
+ */
+message Variant {
+  // flynt-disable missing-extensible
+  // flynt-disable missing-taggable-annotation
+  option (wix.api.entity) = {
+    fqdn: "wix.personalize.generate_variants.v1.variant"
+    segment: PUBLIC
+    app_def_id: "f4b79adb-9998-48b2-b637-e45ab5358ca9"
+    appendix_files: {
+      type: DOCS_CONF,
+      path: "appendices/docs"
+    }
+  };
+
+  // Variant ID.
+  google.protobuf.StringValue id = 1 [(wix.api.maxLength) = 5, (wix.api.readOnly) = true];
+
+  // The variant string value.
+  string text = 2 [(.wix.api.maxLength) = 10000];
+
+  // The persona voice describes the variant.
+  Persona persona = 3;
+}
+
+message Persona {
+  // The name describes the persona.
+  Name name = 1;
+
+  // The tone of voice describes the persona.
+  ToneOfVoice tone_of_voice = 2;
+
+  // The emotion describes the persona.
+  Emotion emotion = 3;
+
+  // The name persuasion technique the persona.
+  PersuasionTechnique persuasion_technique = 4;
+
+  // The formality level describes the persona.
+  FormalityLevel formality_level = 5;
+
+  enum Name {
+    UNKNOWN_NAME = 0;
+    FRIENDLY_GUIDE = 1;
+    PROFESSIONAL_EXPERT = 2;
+    EMPATHETIC_HELPER = 3;
+    ENTHUSIASTIC_INNOVATOR = 4;
+    AUTHORITATIVE_LEADER = 5;
+    INSPIRATIONAL_MENTOR = 6;
+  }
+
+  enum ToneOfVoice {
+    UNKNOWN_TONE_OF_VOICE = 0;
+    FRIENDLY = 1;
+    PROFESSIONAL = 2;
+    EMPATHETIC = 3;
+    ENTHUSIASTIC = 4;
+    AUTHORITATIVE = 5;
+    INSPIRATIONAL = 6;
+  }
+
+  enum Emotion {
+    UNKNOWN_EMOTION = 0;
+    JOY = 1;
+    TRUST = 2;
+    ANTICIPATION = 3;
+  }
+
+  enum PersuasionTechnique {
+    UNKNOWN_PERSUASION_TECHNIQUE = 0;
+    LIKING = 1;
+    AUTHORITY = 2;
+    SOCIAL_PROOF = 3;
+  }
+
+  enum FormalityLevel {
+    UNKNOWN_FORMALITY_LEVEL = 0;
+    CASUAL = 1;
+    FORMAL = 2;
+    NEUTRAL = 3;
+  }
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/variants_generator/v1/variants_generator_service.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+
+package wix.personalize.variants_generator.v1;
+option java_package = "com.wixpress.personalize.variants.generator.v1";
+
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/entity.proto";
+import "wix/api/permissions.proto";
+import "wix/api/validations.proto";
+import "wix/personalize/variants_generator/v1/variant.proto";
+import "google/protobuf/wrappers.proto";
+
+/**
+  Manages Variants Generation
+ */
+service VariantsGeneratorService {
+  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_exposure) = PUBLIC;
+  option (wix.api.service_entity).message = "wix.personalize.variants_generator.v1.Variant";
+
+  /**
+   Generate Text Variants.
+   Get a text and generate content-equivalent text variants.
+  */
+  rpc GenerateTextVariants (GenerateTextVariantsRequest) returns (GenerateTextVariantsResponse) {
+    option (google.api.http).post = "/v1/variants/text";
+    option (wix.api.permission).name = "PERSONALIZE.GENERATE_VARIANTS";
+    option (wix.api.required) = "GenerateTextVariantsRequest.text";
+  }
+
+  /**
+   List The Personas.
+   Return the personas with their characteristics.
+  */
+  rpc ListPersonas (ListPersonasRequest) returns (ListPersonasResponse) {
+    option (google.api.http).get = "/v1/personas";
+    option (wix.api.permission).name = "PERSONALIZE.GENERATE_VARIANTS";
+  }
+}
+
+message GenerateTextVariantsRequest {
+  // The original text to generate analogous variants.
+  string text = 1 [(wix.api.maxLength) = 10000];
+
+  // The requested personas of variants.
+  repeated Persona.Name personas = 2 [(wix.api.maxSize) = 6];
+
+  // The minimum number of characters for text variant.
+  google.protobuf.Int32Value min_char_num = 3;
+
+  // The maximum number of characters for text variant.
+  google.protobuf.Int32Value max_char_num = 4;
+
+  // The keywords mush be included in each variant.
+  repeated google.protobuf.StringValue included_keywords = 5 [(wix.api.maxLength) = 200, (wix.api.maxSize) = 100];
+
+  // The keywords mush not be included in each variant.
+  repeated google.protobuf.StringValue excluded_keywords = 6 [(wix.api.maxLength) = 200, (wix.api.maxSize) = 100];
+}
+
+message GenerateTextVariantsResponse {
+  // The generated variants.
+  repeated Variant variants = 1;
+}
+
+message ListPersonasRequest {
+}
+
+message ListPersonasResponse {
+  // The personas with their characteristics.
+  repeated Persona personas = 1;
+}

package/@wix/ambassador-dealer-v1-serving-offer/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;
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/spi/definitions.proto

@@ -0,0 +1,187 @@
+syntax = "proto2";
+
+package wix.spi;
+
+import "google/protobuf/descriptor.proto";
+import "wix/spi/http_error_status.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "DefinitionsProto";
+option java_package = "com.wix.spi";
+
+/**
+Example SPI proto files:
+
+syntax = "proto3";
+
+package com.wixpress.ecom.couponsSpi;
+
+// this service is bla bla bla...
+//
+// changelog:
+// revision 2: added couponGenerated event
+service CouponsProvider {
+ // since this is an SPI interface definition, the FQDN of the service_entity must start with `wix.interfaces.*`
+ option (.wix.spi.service) = {
+   fqdn: "wix.interfaces.ecom.v1.coupons_provider" // must be `wix.interfaces.*` for entities that define SPI
+   spi_identifier: "com.wixpress.appservice.api.ComponentType.AUTOMATION_TRIGGER"
+   config_message: "com.wixpresss.ecom.CouponsProviderConfig"
+   host_service: "com.wixpress.ecom.couponsSpi.CouponsSpiHost"
+   business_manager_url: "/ecom/coupons" // used to provide deep-link to biz-mgr to finish configuration after code publish in Velo
+ };
+
+ // The provider has to send this event when a coupon is generated on the provider system.
+ // When the coupon code will be used by a user during checkout,
+ // wix-ecom will call the provider in order to calculate the effect of the coupon on the cart
+ option (.wix.spi.event) = {
+   method_name: "CouponGenerated" // Name of the method on the SPI-Host service that needs to be called. Together with `host_service` annotation above, you can get the full FQN
+ };
+
+ // called when the system has to calculate how a coupon affects a given cart
+ rpc CalculateCart (CalculateCartRequest) returns (CalculateCartResponse) {
+   option (google.api.http) = {
+     post: "/calculate-cart"
+   };
+   option (.wix.spi.error) = {
+     name: "CouponNotSupportedError"
+     http_code: INVALID_ARGUMENT
+     application_code: "COUPON_TYPE_NOT_SUPPORTED"
+     data: "com.wixpress.ecom.couponsSpi.TypeNotSupportedError"
+   };
+ }
+
+ // called when a coupon is applied during checkout and has to be reserved until the checkout is completed
+ // redeem will later be called using the reservation_code returned by this method
+ rpc Reserve (ReserveCouponRequest) returns (ReserveCouponResponse) {
+   option (google.api.http) = {
+     post: "/reserve"
+   };
+ }
+
+ // called after a successful transaction that used a coupon was made, in order to notify the coupons provider
+ // that the coupon was redeemed.
+ // sends the reservation_code that the was returned by reserve method
+ rpc Redeem (RedeemCouponRequest) returns (RedeemCouponResponse) {
+   option (google.api.http) = {
+     post: "/redeem"
+   };
+ }
+
+ // called in order to extend coupon expiration date
+ // this method was added later than other methods and therefore needs to be toggled in config_message
+ rpc ExtendCoupon (ExtendCouponRequest) returns (ExtendCouponResponse) {
+   option (google.api.http) ={
+     post: "/extend-coupon"
+   };
+   option (.wix.spi.feature_toggle) = "toggle_extend_coupon_enabled";
+ }
+}
+
+message CouponsProviderConfig {
+ string base_uri = 1 [(.wix.spi.base_uri) = true]; // the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider"
+ repeated string supported_coupon_types = 2; // specific field related to this SPI
+ bool toggle_extend_coupon_enabled = 3; // feature toggle initialized with default value = false. should be true if implemented by spi provider
+}
+
+message TypeNotSupportedError {
+  string type = 1; The received type that is not supported by the service
+}
+
+// =========== another file, standard proto, no SPI annotation ================
+
+service CouponsSpiHost {
+ // we cannot use the same service_entity as the SPI definition, because it is only interface definition. Here we need concrete FQDN
+ option (.wix.api.service_entity).message = "com.wixpress.ecom.couponsProviderGateway";
+
+ // The provider has to send this event when a coupon is generated on the provider system.
+ // When the coupon code will be used by a user during checkout,
+ // wix-ecom will call the provider in order to calculate the effect of the coupon on the cart
+ rpc CouponGenerated (CouponGeneratedRequest) returns (CouponGeneratedResponse) {
+   option (google.api.http) = {
+     post: "/v1/coupon-generated"
+   };
+ }
+
+ // The following 3 methods are an implementation of the SPI interface
+
+ rpc CalculateCart (CalculateCartRequest) returns (CalculateCartResponse) {
+   option (google.api.http) = {
+     post: "/calculate-cart"
+   };
+ }
+
+ rpc Reserve (ReserveCouponRequest) returns (ReserveCouponResponse) {
+   option (google.api.http) = {
+     post: "/reserve"
+   };
+ }
+
+ rpc Redeem (RedeemCouponRequest) returns (RedeemCouponResponse) {
+   option (google.api.http) ={
+     post: "/redeem"
+   };
+ }
+
+ rpc ExtendCoupon (ExtendCouponRequest) returns (RedeemCouponResponse) {
+   option (google.api.http) ={
+     post: "/extend-coupon"
+   };
+ }
+
+}
+
+message CouponsProviderGateway {
+  option (.wix.api.entity) = {
+    fqdn: "wix.gateways.ecom.v1.coupons_provider_gateway"
+    implements: "wix.intefaces.ecom.v1.coupons_provider"
+  };
+}
+**/
+
+extend google.protobuf.ServiceOptions {
+  optional Service service = 65000;
+  repeated Event event = 65001; // spi event is essentially an endpoint that will get requests from spi implementor
+}
+
+extend google.protobuf.FieldOptions {
+  optional bool base_uri = 65020; // holds the base URI of the implementing service for this spi. (can be https://... | grpc://... | velo:///...)
+}
+
+extend google.protobuf.MethodOptions {
+  repeated Error error = 65040; // errors that can be thrown by the method
+  optional string feature_toggle = 65041; // name of the controlling feature toggle boolean field as it appears in the config message
+}
+
+message Service {
+  required string spi_identifier = 1; // string representation of dev-center's catalog [ComponentType](https://github.com/wix-private/devcenter/blob/master/app-service/app-service-api/src/main/proto/components_catalog/components_catalog_type.proto)
+  required string config_message = 2; // FQN ref to message with config details
+  optional string host_service = 3; // FQN ref to proto service of SPI host that implements endpoints that the provider needs to call
+  optional string business_manager_url = 4; // relative deeplink to business-manager page where the user needs to continue configuration of current spi
+  optional string fqdn = 5; // may be used to define an FQDN directly on SPI service without having a main entity. must start with `wix.interfaces.*`
+  optional string app_id = 6; // SPI Host's App Id
+  repeated ServiceAppendix appendix_files = 7; // declare external configuration info
+}
+
+message ServiceAppendix {
+  enum Type {
+    UNKNOWN_APPENDIX_TYPE = 0;
+    AUTO_VELO = 1 [deprecated = true]; // auto velo configuration
+    DOCS_CONF = 2; // wix docs configuration: `documentation.yaml`
+    MULTILINGUAL = 3; // wix multilingual configuration
+    SEARCH = 4; // nile search configuration
+    AUTO_SDK = 5; // auto sdk configuration 
+  }
+  required Type type = 1; // appendix type
+  required string path = 2; // absolute from module root
+}
+
+message Error {
+  required string name = 1; // name that can be used by SDKs to generate error class
+  required HttpStatusCode http_code = 2; // HTTP status code that will be returned with this type of error
+  required string application_code = 3; // a constant string in the format of ALL_CAPS that describes the specific error type
+  optional string data = 4; // FQN of a message that describes structured data that should be provided in the error body
+}
+
+message Event {
+  required string method_name = 1; // name of the implemented method in SPI host service. Together with `host_service` annotation above, you can get the full FQN
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/spi/http_error_status.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package wix.spi;
+
+import "google/protobuf/descriptor.proto";
+
+option java_package = "com.wix.spi";
+
+enum HttpStatusCode {
+  UNKNOWN_ERROR = 0; // Should not be used
+  UNAUTHENTICATED = 1; // 401 - thrown when the request signature could be validated
+  INVALID_ARGUMENT = 3; // 400 - thrown when one of the properties has unexpected value or type
+  // 500 - thrown when something happened that is the result of server bug, network issue, DB issue,
+  // or anything that is not affected by the request itself, and is not the fault of the client in any way.
+  INTERNAL = 5;
+  RESOURCE_EXHAUSTED = 7; // 429 - The client has sent too many requests in a given amount of time (rate limit)
+  CANCELED = 8; // 499 - Request cancelled by the client
+
+  NOT_FOUND = 4; // 404 - thrown when the resource requested could not be found
+  ALREADY_EXISTS = 9; //409 - Can't recreate same resource or concurrency conflict
+  // 428 - request cannot be executed in current system state
+  // such as deleting a non-empty folder or paying with no funds
+  FAILED_PRECONDITION = 10;
+}

package/@wix/ambassador-dealer-v1-serving-offer/types/package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "main": "../build/cjs/types.impl",
+  "types": "../build/cjs/types.impl.d.ts",
+  "sideEffects": false,
+  "module": "../build/es/types.impl"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/bex-utils",
-  "version": "2.71.0",
+  "version": "2.72.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Kobi",
@@ -36,8 +36,8 @@
     "@formatjs/intl-relativetimeformat": "^4.5.16",
     "@sentry/browser": "5.30.0",
     "@sentry/types": "5.30.0",
-    "@wix/metro-common-builders": "^1.0.0",
-    "@wix/metro-runtime": "^1.1939.0",
+    "@wix/metro-common-builders": "^1.0.1737",
+    "@wix/metro-runtime": "^1.2055.0",
     "callsite": "^1.0.0",
     "i18next": "^19.9.2",
     "intl-messageformat": "^7.8.4",
@@ -52,6 +52,7 @@
     "@types/react-native": "^0.73.0",
     "@wix/ambassador-app-settings-v1-settings": "^1.0.0",
     "@wix/ambassador-data-extensions-v1-data-extension-schema": "^1.0.93",
+    "@wix/ambassador-dealer-v1-serving-offer": "^1.0.132",
     "@wix/ambassador-devcenter-app-market-listing-v1-market-listing": "^1.0.70",
     "@wix/ambassador-fedinfra-exportservice-v1-export-async-job": "^1.0.174",
     "@wix/ambassador-infra-asyncjobs-v1-async-job": "^1.0.87",
@@ -152,5 +153,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "00f9743d8357c6bf5006cb20552b46dff60e28edb380cf1eb1f7b384"
+  "falconPackageHash": "fe84a3e31be9d736c99200b83337ed53dd16265c24c50ea33446dc38"
 }