@wix/bex-utils 1.28.0

package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_common.proto

@@ -0,0 +1,193 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+
+message DisplayProperties {
+    DisplayValue top = 1;
+    DisplayValue right = 2;
+    DisplayValue bottom = 3;
+    DisplayValue left = 4;
+}
+
+message DisplayValue {
+    UnitType type = 1;
+    google.protobuf.Int32Value value = 2;
+}
+
+enum UnitType {
+    NO_UNIT = 0;
+    AUTO = 1;
+    PX = 2;
+    VH = 3;
+    VW = 4;
+    PERCENTAGE = 5;
+}
+
+message Docking {
+    DockingProperties desktop = 1;
+    DockingProperties tablet = 2;
+    DockingProperties mobile = 3;
+}
+
+message Margins {
+    DisplayProperties desktop = 1;
+    DisplayProperties tablet = 2;
+    DisplayProperties mobile = 3;
+}
+
+message Height {
+    DisplayValue desktop = 1;
+    DisplayValue tablet = 2;
+    DisplayValue mobile = 3;
+}
+
+message Width {
+    DisplayValue desktop = 1;
+    DisplayValue tablet = 2;
+    DisplayValue mobile = 3;
+}
+
+message IsStretched {
+    google.protobuf.BoolValue desktop = 1;
+    google.protobuf.BoolValue tablet = 2;
+    google.protobuf.BoolValue mobile = 3;
+}
+
+message DockingProperties {
+    HorizontalDocking horizontal = 1;
+    VerticalDocking vertical = 2;
+}
+
+enum HorizontalDocking {
+    NO_HDOCKING = 0;
+    LEFT_DOCKING = 1;
+    HCENTER = 2;
+    RIGHT_DOCKING = 3;
+}
+
+enum VerticalDocking {
+    NO_VDOCKING = 0;
+    TOP_DOCKING = 1;
+    VCENTER = 2;
+    BOTTOM_DOCKING = 3;
+}
+
+message WidgetDisplay {
+    string name = 1;
+    google.protobuf.StringValue short_description = 2 [(wix.api.maxLength) = 300]; // short description about the widget
+    repeated string images = 3; // images showing off how the widget looks
+    google.protobuf.Int32Value order = 4; // optional, if no order exist for all components, will be decided by order in array (non-deterministic)
+    google.protobuf.FloatValue price = 5;
+    google.protobuf.StringValue variation_id = 6;
+}
+
+message SubPage {
+    // The path of the subpage
+    string key = 1;
+    // If it's sub entities are enumerable for querying (for example, a search endpoint is not enumerable)
+    bool enumerable = 2;
+}
+
+// Error reporting configuration for the App
+message ErrorReporting {
+    // An error reporting URL to be used by our infra (Example: A sentry DSN url)
+    string url = 1;
+}
+
+// List of back-office hosting platforms 
+enum BackOfficeHostingPlatforms {
+    NO_HOSTING_PLATFORM = 0;
+    // Site Dashboard (The Wix Dashboard)
+    BUSINESS_MANAGER = 1;
+    // User Account Dashboard 
+    ACCOUNT_MANAGER = 2;
+    // Internal: Dev center
+    DEV_CENTER = 3;
+    // Enterprise dashboard (available to enterprise accounts only)
+    ENTERPRISE = 4;
+    //Partners dashboard (available to partners accounts only)
+    PARTNERS_DASHBOARD = 5;
+    //Employee only financial support dashboard
+    FINANCIALS_INTERNAL_BO = 6;
+    //FED Guild POC dashboard
+    FED_GUILD_POC = 7;
+    // Studio dashboard
+    STUDIO_DASHBOARD = 8;
+}
+
+// Internal: Specifications for loading an asset via JS in the back office
+message BackOfficeScriptAsset {
+    // Type attribute for the script tag
+    enum BackOfficeScriptAssetType {
+        // Script will be loaded without a type attribute
+        UNKNOWN_TYPE = 0;
+        // Use "module" as the script type
+        MODULE = 1;
+    }
+
+    // The JavaScript file to load
+    string url = 1 [(wix.api.format) = WEB_URL];
+    // Namespacing of the component in the Webpack Module Federation registry
+    string container_id = 2 [(.wix.api.minLength) = 1];
+    // Key name for the retrieval of the component
+    string exported_name = 3 [(.wix.api.minLength) = 1];
+    // Optional: What type should by used on <script> tag.
+    BackOfficeScriptAssetType script_type = 4;
+}
+
+// Options for widgets that are added as a page during installation
+message PageOptions {
+    // Display name of the page that will be shown in the page menu.
+	string page_name = 1;
+    // The page ID used for navigation purposes. Once set cannot be changed.
+	string page_id = 2;
+}
+
+message LightboxOptions {
+    // Display name of the lightbox that will be shown in the lightbox menu.
+	string lightbox_name = 1;
+    // The lightbox ID used for navigation purposes. Once set cannot be changed.
+	string lightbox_id = 2;
+}
+
+// Defines the main preset per breakpoint for the widget.
+message MainPresets {
+    // The main desktop preset.
+	string desktop_preset_id = 1;
+    // The main tablet preset.
+	string tablet_preset_id = 2;
+    // The main mobile preset.
+	string mobile_preset_id = 3;
+}
+
+// Settings to control the behavour of widgets when installed in a wix site.
+message InstallationSettings {
+    // The page to which a new widget can be added
+    enum InstallPage {
+        // Don't add widget to a page
+        NO_PAGE = 0;
+        // Add widget to the current page in the editor
+        CURRENT = 1;
+        // Add widget to a new page in the editor
+        PAGE = 2;
+        // Add widget to a new lightbox in the editor
+        LIGHTBOX = 3;
+    }
+
+    // How to add the widget automatically to the site. Options could be `NO_PAGE`, `CURRENT`, `PAGE` or `LIGHTBOX`.
+    InstallPage install_page = 1;
+    // Controls whether to show or hide the widget in the add panel.
+    google.protobuf.BoolValue show_in_add_panel = 2;
+    // Defines the main preset per breakpoint for the widget.
+    MainPresets main_presets = 3;
+    
+    oneof options {
+        // Extra options needed when `install_page` is set to `PAGE`.
+        PageOptions page_options = 4;
+        // Extra options needed when `install_page` is set to `LIGHTBOX`.
+        LightboxOptions lightbox_options = 5;
+    }
+}

package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/alert_enricher/com/wixpress/appservice/api/upstream/spi/com/wixpress/vi/enricher/spi/enrichment_spi.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+import "wix/api/annotations.proto";
+import "wix/spi/definitions.proto";
+
+package com.wixpress.appservice.api.upstream.spi.com.wixpress.vi.enricher.spi;
+
+message AlertEnricherSpiConfiguration {
+  string deployment_uri = 1 [(.wix.spi.base_uri) = true];
+}

package/@wix/ambassador-data-extensions-v1-data-extension-schema/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-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/application_automation/com/wixpress/appservice/api/upstream/com/wixpress/automations/service/application_automation_component.proto

@@ -0,0 +1,167 @@
+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;
+}
+
+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) = 3000];
+
+  // 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;
+
+  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 {
+    // 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-data-extensions-v1-data-extension-schema/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-data-extensions-v1-data-extension-schema/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,173 @@
+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;
+    // implements OnDelete
+    bool on_delete = 7;
+  }
+
+  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;
+    }
+  }
+}