@wix/bex-utils 2.4.0 → 2.6.0

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/app_config.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+
+//
+message AppConfig {
+    //
+    SiteConfig site_config = 1;
+    //
+    string namespace = 2;
+}
+
+//
+message SiteConfig {
+    //
+    google.protobuf.StringValue site_structure_api = 1 [(wix.api.format) = URI];  //todo: WEB_URL
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/application_automation/com/wixpress/appservice/api/upstream/com/wixpress/automations/service/application_automation_component.proto

@@ -0,0 +1,195 @@
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+package com.wixpress.appservice.api.upstream.com.wixpress.automations.service;
+
+// Automation Component data that is stored in dev center
+message ApplicationAutomationComponent {
+  // A rule that contains a trigger & some actions
+  Rule rule = 1;
+
+  // Automation name
+  google.protobuf.StringValue name = 2 [(.wix.api.maxLength) = 500];
+
+  // Automation description
+  google.protobuf.StringValue description = 3 [(.wix.api.maxLength) = 2000];
+
+  // Automation metadata
+  AutomationMetadata metadata = 4;
+
+  // Automation status
+  Status status = 5;
+
+  enum Status {
+    ACTIVE = 0;
+    INACTIVE = 1;
+  }
+}
+
+message AutomationMetadata {
+  // Is this Automation hidden on a site?
+  bool hidden = 1;
+
+  // Can this Automation be deactivated on a site?
+  bool always_active = 2;
+
+  // Is this Automation's scheduling modification is disabled on a site?
+  bool scheduling_modification_disabled = 3;
+
+  // Is the removal of this Automation's actions disabled?
+  bool action_removal_disabled = 4;
+
+  // Is conditions editing for this Automation allowed on a site?
+  bool action_conditions_editing_disabled = 5;
+}
+
+message Rule {
+  option (.wix.api.decomposite_of) = "com.wixpress.automations.service.Rule";
+  // an event triggered by visitors on a site, or by a site manager (owner & team).
+  Trigger trigger = 1;
+  // the actions responding to the trigger happening
+  repeated Action actions = 2 [(.wix.api.minSize) = 0, (.wix.api.maxSize) = 100];
+}
+
+message Trigger {
+  option (.wix.api.decomposite_of) = "com.wixpress.automations.service.Trigger";
+  // the id of the app defining the trigger
+  string app_id = 1 [(.wix.api.format) = GUID];
+  // Identifier for this trigger - human readable action key
+  string trigger_key = 2 [(.wix.api.maxLength) = 80];
+  // optional list of filters on schema fields
+  repeated Filter filters = 3 [(.wix.api.maxSize) = 5];
+
+  // optional - allows to define a trigger whose following actions will be executed only if the same event for the same resource has not in the last X seconds.
+  // for example, if the trigger is "session booked", the resource is a contact and the timeframe is 3600 seconds (contact hasn't booked another session in the last hour),
+  // then the actions will be executed only if the same event (session booked for that contact) has not happened in the last hour.
+  // resource id is sent in runtime via the externalEntityId parameter, ReportEvent method.
+  Debounce debounce = 4;
+
+  message Debounce {
+    // Amount of time in seconds to wait for any additional events to occur before triggering the actions.
+    // If no additional events occur within the specified time, the actions will be triggered.
+    // If additional events occur within the specified time, the timer will be reset.
+    int32 time_frame_in_seconds = 1 [(.wix.api.min) = 1];
+
+    // The field key in the event payload, which indicates the identifier of the entity/event to debounce on
+    // For example: if the trigger is "user logged in", the resource is a contact and the resource key is "contactId",
+    // Another example: if the trigger is "visitor logged in", the resource is a visitor and the resource key is "visitorId".
+    string field_key = 2 [(.wix.api.minLength) = 0, (.wix.api.maxLength) = 100];
+  }
+
+  message Filter {
+    // the filter identifier
+    google.protobuf.StringValue id = 3 [(.wix.api.format) = GUID];
+    // the field key from the schema, for example "formId"
+    string field_key  = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 50];
+    // filter expression that evaluates to a boolean, for example - {{ contains(["guid1","guid2"];formId) }}
+    string filter_expression = 2;
+  }
+}
+
+message Action {
+  option (.wix.api.decomposite_of) = "com.wixpress.automations.service.Action";
+  // the id of the action for delayed events
+  google.protobuf.StringValue id = 1 [(.wix.api.format) = GUID, (.wix.api.readOnly) = true];
+
+  // the id of the app defining the action
+  string app_id = 2 [(.wix.api.format) = GUID];
+
+  // Identifier for this action - human readable action key - unique per app def id
+  string action_key = 3 [(.wix.api.maxLength) = 80];
+
+  // input mapping expression for the action inputs
+  // for example:
+  // `{  "subject": "Thanks for reaching out!"
+  //    "message": "Hi {{contact.name.first}}, thanks for contacting our business"
+  //  }`
+  //  where the value for "contact.name.first" comes from the trigger's payload
+  string action_config = 4 [(.wix.api.minLength) = 0, (.wix.api.maxLength) = 5000];
+
+  // output mapping expression for the action output
+  // for example in get-contact action:
+  // `{ "author": "{{$}}" }`
+  // This will map the entire entity of contact under `author` namespace
+  google.protobuf.StringValue output_action_config = 5 [(.wix.api.minLength) = 0, (.wix.api.maxLength) = 3000];
+
+  // Optional delay configuration for the action
+  Delay delay = 6;
+
+  // allows you define an activation policy - like number of activations in a time frame, or limit by some identifier, like contact (e.g. send email to user only at first login)
+  RateLimit rate_limit = 7;
+
+  // allows the user to define a condition for the action to be executed, if the condition fails the action (and following actions) will not be executed
+  Condition condition = 8 [(.wix.api.field_deprecated) = {
+    replaced_by: "conditions"
+    target_removal_date: "2023-08-01"
+  }];
+
+  Conditions conditions = 9;
+  
+  // allows the user to define a namespace for the action output
+  google.protobuf.StringValue namespace = 10 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 100];
+
+  message Conditions {
+    // condition evaluates to `true` if either of the blocks evaluate to `true` (aka OR between all)
+    repeated ConditionBlock condition_blocks = 1 [(.wix.api.minSize) = 1, (.wix.api.maxSize) = 10];
+
+    message ConditionBlock {
+      BlockType type = 1;
+      repeated string line_expressions = 2 [(.wix.api.minSize) = 1, (.wix.api.maxSize) = 20];
+    }
+
+    enum BlockType {
+      UNKNOWN = 0;
+      OR = 1;
+      AND = 2;
+    }
+  }
+
+  message Delay {
+    oneof type {
+      // A delay which is calculated based on the immediate time when the action is triggered.
+      Offset for    = 1;
+      // A delay which is calculated based on a date field in the trigger payload. May also be used together with an Offset delay.
+      Until until   = 2;
+    }
+
+    message Offset {
+      oneof value {
+        // A delay in seconds
+        int32 seconds     = 1;
+        // The key of the field in the trigger payload which contains a delay, in seconds.
+        string delay_field_key = 2;
+      }
+    }
+
+    // calculated as date + delay
+    message Until {
+      // The key of the field in the trigger payload which contains the date to delay until
+      string date_field_key = 1;
+
+      // Optional: a delay to add together with the date described in the payload
+      Offset offset         = 2;
+    }
+  }
+
+  message RateLimit {
+    // time frame in minutes
+    google.protobuf.Int32Value time_frame = 1 [(.wix.api.min) = 1];
+
+    // number of activations allowed in the given time frame
+    int32 activations = 2 [(.wix.api.min) = 1];
+
+    // limit the activation by an entity, for example activate once per contact. example: {{contact.id}}
+    google.protobuf.StringValue unique_identifier_expression = 3 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 300];
+  }
+
+  message Condition {
+    // entity object is deprecated due to the new approach to conditions
+    // the condition expression, for example - {{and(gt(price;10);lt(price;100))}}
+    string condition_expression = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 2000];
+  }
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/automation_trigger.proto

@@ -0,0 +1,101 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/spi/definitions.proto";
+
+message AutomationTrigger {
+    // The name that will be passed with trigger report event to activate an Automation.
+    string name = 1 [(wix.api.maxLength) = 80];
+    // The name displayed to the user.
+    string display_name = 2 [(wix.api.maxLength) = 80];
+    // The schema of the payload that will be passed with trigger when activating an Automation.
+    SchemaConfig schema_config = 3;
+    // flynt-disable unannotated-pii-fields
+    // Email template to be shown when user choose this trigger and email action.
+    google.protobuf.StringValue email_template_name = 4 [(wix.api.field_exposure) = INTERNAL];
+
+    string deployment_uri = 5 [(.wix.spi.base_uri) = true];
+    int32 revision = 6;
+}
+
+message SchemaConfig {
+    // The fields of the payload as sent in the report event
+    repeated SchemaField fields = 1;
+    // Dynamic schema service URL.
+    // Dynamic schema is used when user needs to choose specific entities from site to activate the Automation.
+    // For example form name, purchased product, etc.
+    google.protobuf.StringValue dynamic_schema_url = 2 [(wix.api.format) = WEB_URL];
+}
+
+message SchemaField {
+    // The key as it appears on the report event payload.
+    string key = 1;
+    // The name displayed to the user.
+    string display_name = 2;
+    // The field type
+    SchemaFieldType field_type = 3;
+    // Sample values, values that could show up in the payload of a trigger.
+    repeated string sample_values = 4;
+    // The field exposure
+    Exposure exposure = 5;
+
+
+    enum Exposure {
+        UNKNOWN_EXPOSURE = 0;
+        // Not sent to the action provider
+        SETUP = 1;
+        // Sent to the action provider and usually hidden from user
+        HIDDEN = 2;
+        // Sent to the action provider and usually shown to user
+        EXPOSED = 3;
+    }
+
+    message SchemaFieldType {
+        oneof fieldType {
+            Primitive primitive = 1;
+            Simple simple = 2;
+            // The field value must conform to the following JSON structure { "timestamp": string, "timeZone": string }, where the timestamp is ISO format UTC, and the time zone is the full name
+            // Example: { "timestamp": "2021-03-22T11:41:47.992Z", timeZone: "Asia/Jerusalem" }
+            Date date = 3;
+        }
+
+        message Primitive {
+            PrimitiveType primitive_type = 1;
+
+            enum PrimitiveType {
+                UNKNOWN_PRIMITIVE_TYPE = 0;
+                TEXT = 1;
+                BOOLEAN = 2;
+                NUMBER = 3;
+            }
+        }
+
+        message Simple {
+            SimpleType simple_type = 1;
+
+            enum SimpleType {
+                UNKNOWN_SIMPLE_TYPE = 0;
+                MONEY = 1;
+                LINK = 2;
+                BACKOFFICE_LINK = 3;
+                LIVESITE_LINK = 4;
+                MULTILINGUAL = 5;
+                IMAGE_LINK = 6;
+                GUID = 7;
+                EMAIL = 8;
+                PHONE = 9;
+                CONTACT_ID = 10;
+            }
+        }
+
+        message Date {
+            // Default: false, set this to true if the date is normally a future date, like: Invoice expiration date, Membership renewal date
+            google.protobuf.BoolValue allow_negative_offset = 1;
+        }
+    }
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/automations_action_provider/com/wixpress/appservice/api/upstream/com/wixpress/esb/spi/action/v1/action_spi_provider.proto

@@ -0,0 +1,178 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/common/media.proto";
+import "wix/spi/definitions.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+package com.wixpress.appservice.api.upstream.com.wixpress.esb.spi.action.v1;
+
+message ActionProviderSPIConfig {
+  reserved 1;  
+  option (.wix.api.decomposite_of) = "com.wixpress.esb.spi.action.v1.ActionProviderSPIConfig";
+  // URL to action provider service for this action
+  string base_uri = 2 [(.wix.spi.base_uri) = true];
+  // action SPI configuration
+  ActionSPIConfig action_config = 3;
+}
+
+message ActionSPIConfig {
+  option (.wix.api.decomposite_of) = "com.wixpress.esb.spi.action.v1.ActionSPIConfig";
+  // identifier for this action - human readable action key - unique per app def id
+  string action_key = 1 [(.wix.api.minLength) = 5, (.wix.api.maxLength) = 50];
+
+  //  The action expects the following input
+  //  The schema is described according to JSON Schema standard: https://json-schema.org/
+  //
+  //  Example - Add Label to Contact Action input schema:
+  //  {
+  //  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  //  "type": "object",
+  //  "title": "Add label to contact input schema",
+  //  "description": "The schema of the json that is sent when invoking this add label to contact action",
+  //  "default": {},
+  //  "examples": [
+  //  {
+  //  "contactId": "a647eb32-c5f4-11ec-9d64-0242ac120002",
+  //  "labelId": "1e8b5e5e-dba2-11ec-9d64-0242ac120002"
+  //  }
+  //  ],
+  //  "required": [
+  //  "contactId",
+  //  "labelId"
+  //  ],
+  //  "properties": {
+  //  "contactId": {
+  //  "$id": "#/properties/contactId",
+  //  "type": "string",
+  //  "format": "uuid",
+  //  "title": "Contact Id",
+  //  "description": "The Id of the contact to apply the label to",
+  //  "default": "",
+  //  "identityType": "contact" // can be contact/visitor/user, limited to 1 type per identity.
+  //  },
+  //  "labelId": {
+  //  "$id": "#/properties/labelId",
+  //  "type": "string",
+  //  "format": "uuid",
+  //  "title": "Label Id",
+  //  "description": "The Id of label to apply",
+  //  "default": "",
+  //  }
+  //  }
+  //  }
+  //
+  google.protobuf.Struct input_schema = 3;
+
+  //  The output of the action which will be added to the payload after execution
+  //  The schema is described according to JSON Schema standard: https://json-schema.org/
+  //
+  //  Example - Output of create task action
+  //  {
+  //  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  //  "type": "object",
+  //  "title": "Create task action schema",
+  //  "description": "The schema of the json that is sent when invoking this create task action",
+  //  "default": {},
+  //  "examples": [
+  //  {
+  //  "taskId": "a647eb32-c5f4-11ec-9d64-0242ac120002",
+  //  }
+  //  ],
+  //  "required": [
+  //  "taskId"
+  //  ],
+  //  "properties": {
+  //  "taskId": {
+  //  "$id": "#/properties/taskId",
+  //  "type": "string",
+  //  "format": "uuid",
+  //  "title": "Contact Id",
+  //  "description": "The Id of the task created",
+  //  "default": "",
+  //  }
+  //  }
+  //  }
+  //
+  google.protobuf.Struct output_schema = 4;
+
+  // actions display name - human readable field. ex. - "Send SMS"
+  google.protobuf.StringValue display_name = 7 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 80];
+
+  google.protobuf.StringValue description = 8;
+
+  // specifies which optional methods were implemented
+  ImplementedMethods implemented_methods = 5;
+  // Lets us know if we should wait for the action to complete before executing the next actions or finish and
+  // expect a call back in actionCompleted method
+  ExecutionType execution_type = 2;
+
+  Metadata metadata = 6;
+  // chosen ui interface for action
+  InterfaceConfiguration interface_configuration = 9;
+  // icon representing the action in UI
+  wix.common.Image icon = 10;
+
+  message ImplementedMethods {
+    option (.wix.api.decomposite_of) = "com.wixpress.esb.spi.action.v1.ActionSPIConfig.ImplementedMethods";
+    // implements ValidateConfiguration
+    bool validate_configuration = 1;
+    // implements DuplicateInputMapping
+    bool duplicate_input_mapping = 2;
+    // implements GenerateApplicationAutomationInputMapping
+    bool generate_application_automation_input_mapping = 3;
+    // implements GetQuotaInfo
+    bool get_quota_info = 4;
+    // implements OnBeforeSave
+    bool on_before_save = 5;
+    // implements OnReset
+    bool on_reset = 6;
+    reserved 7;
+    // implements generateActionInputMappingFromTemplate
+    bool generate_action_input_mapping_from_template = 8;
+    // implements OnRemove
+    bool on_remove = 9;
+    // Implements GetDynamicInputSchema
+    bool get_dynamic_input_schema = 10;
+  }
+
+  enum ExecutionType {
+    UNKNOWN_EXECUTION_TYPE  = 0;
+    SYNC                    = 1;
+    ASYNC                   = 2;
+  }
+
+  message Metadata {
+    option (.wix.api.decomposite_of) = "com.wixpress.esb.spi.action.v1.ActionSPIConfig.Metadata";
+    // if the action is hidden from Users in the UI (Wizard)
+    bool hidden = 1;
+  }
+
+  message InterfaceConfiguration {
+    // type of chosen interface
+    Type type = 1;
+    oneof options {
+      option (.wix.api.aligned_with_enum).field = "type";
+      WidgetComponentOptions widget_component_options = 2;
+      GenericOptions generic_options = 3;
+    }
+
+    enum Type {
+      UNKNOWN_TYPE             = 0;
+      WIDGET_COMPONENT         = 1;
+      GENERIC                  = 2;
+    }
+
+    message WidgetComponentOptions {
+      // name of provided component
+      string component_name = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 80];
+    }
+
+    message GenericOptions {
+      // ui schema
+      google.protobuf.Struct ui_schema = 1;
+    }
+  }
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/automations_trigger_provider/com/wixpress/appservice/api/upstream/com/wixpress/esb/spi/trigger/v1/trigger_spi_provider.proto

@@ -0,0 +1,77 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+import "wix/spi/definitions.proto";
+import "wix/api/annotations.proto";
+
+package com.wixpress.appservice.api.upstream.com.wixpress.esb.spi.trigger.v1;
+
+message TriggerProviderSPIConfig {
+    option (.wix.api.decomposite_of) = "com.wixpress.esb.spi.trigger.v1.TriggerProviderSPIConfig";
+  /*
+    The trigger configuration
+
+    example of a trigger:
+
+    {
+      appId: "56cc7843-fdfc-417f-a660-d4af9a2eafe3",
+      triggerKey: "form_submit",
+      displayName: "Visitor submits a form",
+      payloadDataSchema: {
+        "$schema": "http://json-schema.org/draft-07/schema",
+        "type": "object",
+        "title": "Visitor submits a form Payload Schema",
+        "description": "The schema of the payload that is part of the triggered event",
+        "default": {},
+        "examples": [
+          {
+            "formId": "60d2cd50-1047-4164-884d-8c24fbda84bb",
+            "formName": "My Cool Form
+          }
+        ],
+        "properties": {
+          "formId": {
+            "$id": "#/properties/formId",
+            "type": "string",
+            "format": "uuid",
+            "title": "Form ID",
+            "description": "The form identifier",
+            "default": "",
+            "examples": [
+              "60d2cd50-1047-4164-884d-8c24fbda84bb"
+            ]
+          },
+          "formName": {
+            "$id": "#/properties/formName",
+            "type": "string",
+            "title": "Form Name",
+            "description": "The form display name",
+            "default": "",
+            "examples": [
+              "My Form"
+            ]
+          },
+          "contactId": {
+            "$id": "#/properties/contactId",
+            "type": "string",
+            "format": "uuid",
+            "title": "Contact Id",
+            "description": "The Id of the contact which submitted the form",
+            "default": "",
+            "identityType": "contact", // can be contact, visitor, user limited to 1 type per identity,
+            "name": "contact" // friendly name to be used later on, in order to user that person's data "contact.firstName"
+          }
+        },
+        "required": [
+          "formId",
+          "formName",
+          "contactId"
+        ],
+        "additionalProperties": false
+      }
+    }
+ */
+  google.protobuf.Struct trigger_config = 1;
+  // URL to the trigger provider service
+  string base_uri = 2 [(.wix.spi.base_uri) = true];
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/automations_velo_action_provider/com/wixpress/appservice/api/upstream/com/wixpress/automations/velo_spi/v1/velo_spi.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+import "wix/common/spi.proto";
+import "wix/spi/definitions.proto";
+import "wix/api/annotations.proto";
+
+package com.wixpress.appservice.api.upstream.com.wixpress.automations.velo_spi.v1;
+
+message VeloActionConfig {
+    option (.wix.api.decomposite_of) = "com.wixpress.automations.v1.velo_spi.VeloActionConfig";
+  wix.common.spi.SpiBaseUri base_uri = 1;
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/availability_time_slots_configuration_provider/com/wixpress/appservice/api/upstream/com/wixpress/bookings/availability/spi/v2/availability_time_slots_configuration_provider.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api.upstream.com.wixpress.bookings.availability.spi.v2;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/spi/definitions.proto";
+import "wix/common/spi.proto";
+
+message AvailabilityTimeSlotsProviderConfig {
+    option (.wix.api.decomposite_of) = "com.wixpress.bookings.availability.spi.v2.AvailabilityTimeSlotsProviderConfig";
+  // URI where the SPI Implementer is deployed.
+  .wix.common.spi.SpiBaseUri deployment_uri = 1;
+  // User-friendly name of the provider.
+  google.protobuf.StringValue provider_name = 2 [(.wix.api.maxLength) = 100];
+}