@wix/bex-utils 2.78.0 → 2.80.0

package/@wix/ambassador-dealer-v1-offer-event/src/main/proto/wix/dealerOfferEvents/api/v1/event.proto

@@ -0,0 +1,131 @@
+syntax = "proto3";
+
+package wix.dealerOfferEvents.api.v1;
+
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/entity.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_package = "com.wix.dealerOfferEvents.api.v1";
+
+message OfferEvent {
+    option (wix.api.entity).fqdn = "wix.dealer.v1.offer_event";
+
+    // unique guid
+    string offer_id = 1 [(wix.api.format) = GUID];
+
+    // the direct user recieved the offer - returned only for AGENT_MARK summary/query
+    // OPTIONAL - NOT RECOMMENDED to pass in report event.
+    google.protobuf.StringValue user_id = 2 [(wix.api.format) = GUID];
+
+    // the target account context recieved the offer
+    // OPTIONAL - NOT RECOMMENDED to pass in report event.
+    google.protobuf.StringValue target_account_id = 3 [(wix.api.format) = GUID];
+
+    // returned only for AGENT_MARK summary/query
+    // OPTIONAL - NOT RECOMMENDED to pass in report event.
+    google.protobuf.StringValue logged_in_account_id = 4 [(wix.api.format) = GUID];
+
+    // the site context recieved the offer
+    // OPTIONAL - NOT RECOMMENDED to pass in report event.
+    google.protobuf.StringValue site_id = 5 [(wix.api.format) = GUID];
+
+    // returned only for AGENT_MARK summary/query
+    google.protobuf.StringValue event_id = 6 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+    // creation timestamp
+    google.protobuf.Timestamp created_at = 7 [(wix.api.readOnly) = true];
+
+    // for some of the event types a payload should be passed
+    // for example if u pass MAIN_CTA_CLICK then main_cta_click payload should also be passed with target_url
+    EventType type = 8;
+
+    oneof payload {
+        // a payload when event type is AGENT_MARK
+        AgentMarkedPayload agent_mark = 9;
+
+        // a payload when event type is MAIN_CTA_CLICK
+        // currently will not be returned as part of summary response
+        CTAClickPayload main_cta_click = 17;
+
+        // a payload when event type is SECONDARY_CTA_CLICK
+        // currently will not be returned as part of summary response
+        CTAClickPayload secondary_cta_click = 18;
+
+    }
+
+    // currently will not be returned as part of summary/query response
+    google.protobuf.StringValue real_estate_id = 11;
+
+    reserved 10, 12, 20;
+
+    // URL of a web page which is initial cause/source of the event (if available)
+    // if left blank and grpc endpoint is exposed over http rest - taken from HTTP referrer header
+    // currently will not be returned as part of summary response - not supported for AGENT_MARK
+    google.protobuf.StringValue http_referrer = 13;
+
+    // Some external asset guid. Can be the banner/LB campaign creative guid, but isn't specific to LB/banner assets.
+    // currently will not be returned as part of summary response - not supported for AGENT_MARK
+    google.protobuf.StringValue asset_id = 14 [(wix.api.format) = GUID];
+
+    // For placements that are used in multiple platforms simultaneously, pass the information of where this interaction happened.
+    // standard platforms for bi: BUSINESS_MANAGER, EDITORX, EDITORX, ADI, OWNER_APP
+    PlatformEnum platform = 15;
+
+    enum PlatformEnum {
+        UNKNOWN = 0;
+        BUSINESS_MANAGER = 1;
+        EDITORX = 2;
+        EDITOR = 3;
+        ADI = 4;
+        OWNER_APP = 5;
+        BRANDED_APP = 6;
+        DEV_CENTER = 7;
+    }
+
+}
+
+message CTAClickPayload {
+    // destination url of the cta if available (i.e. CTA href etc.)
+    // in some cases Cta is not url - therfore a simple string can be passed
+    google.protobuf.StringValue target_url = 1;
+}
+
+message AgentMarkedPayload {
+    // id of related agent
+    google.protobuf.StringValue agent_id = 1 [(wix.api.format) = GUID];
+
+    // Offer status
+    AgentOfferStatusEnum status = 2;
+
+    enum AgentOfferStatusEnum {
+        NOT_STARTED = 0;
+        SUGGESTED = 1;
+        REJECTED = 2;
+        REQUESTED = 3;
+        ALREADY_COMPLETED = 4;
+        NOT_RELEVANT = 5;
+        PAUSED = 6;
+    }
+}
+
+enum EventType {
+    UNKNOWN = 0;
+    VIEW = 1;
+
+    MAIN_CTA_CLICK = 3;
+    SECONDARY_CTA_CLICK = 4;
+    AGENT_MARK = 5;
+
+    reserved 6, 2;
+
+    SKIP = 7;
+    UNSKIP = 8;
+    CLOSE = 9;
+    SHOW_LATER = 10;
+}

package/@wix/ambassador-dealer-v1-offer-event/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-dealer-v1-offer-event/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-dealer-v1-offer-event/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-offer-event/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-offer-event/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-offer-event/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.78.0",
+  "version": "2.80.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Kobi",
@@ -36,7 +36,7 @@
     "@formatjs/intl-relativetimeformat": "^4.5.16",
     "@sentry/browser": "5.30.0",
     "@sentry/types": "5.30.0",
-    "@wix/metro-common-builders": "^1.0.1737",
+    "@wix/metro-common-builders": "^1.0.0",
     "@wix/metro-runtime": "^1.2055.0",
     "callsite": "^1.0.0",
     "i18next": "^19.9.2",
@@ -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-offer-event": "^1.0.85",
     "@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",
@@ -153,5 +154,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "c3cb930eb3c96d7ae99ab9f514c7265ce761777fc95884baeb36a795"
+  "falconPackageHash": "37704cd720ff68acd644b21d09f7f0c9d727c123bf37a8d9546aee32"
 }