@wix/bex-utils 1.28.0

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

@@ -0,0 +1,346 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+
+// A draggable custom element. Add your custom script and generate ui directly in the viewer
+message WebComponentData {
+    // A link to a preview image we can render in the editor in place of your component
+    string image_preview = 1; // todo: WEB_URL? ask oron
+    // Web component size
+    Size size = 2;
+    // This script url should render temp empty state
+    string script_tag = 3 [(wix.api.format) = WEB_URL];
+    // Unique tag name to use in order to connect your JS script to your web component
+    string tag_name = 4;
+    //The settings panel URL for this component
+    google.protobuf.StringValue settings_url = 5 [(wix.api.format) = WEB_URL];
+    // The editor modal that the user will see
+    string modal_title = 6;
+    // Settings CTA label
+    string connect_label = 7;
+    // Dynamic settings(Graphic Floating Properties Panel settings)
+    Settings gfpp_settings = 8;
+    // Custom element type PAGE / WIDGET
+    ElementType type = 9;
+    // Boolean to make this component be available for free sites
+    bool allowed_for_free_site = 10;
+    // A public link to the SEO endpoint
+    google.protobuf.StringValue seo_url = 11 [(wix.api.format) = WEB_URL];
+    // For case that the widget will be used as page
+    google.protobuf.StringValue slug = 12;
+    // For case that the widget will be used as page
+    bool show_page_in_menu = 13;
+    //The details of the selected widget to add
+    WidgetDetails widget = 14;
+   //Give the option to change the script type
+    ScriptType scriptType = 15;
+    // Web component default mobile height
+    google.protobuf.Int32Value default_mobile_height = 16;
+    // Prevent the deletion of the widget when set to true.
+    bool essential = 17;
+    // Toggle to mark whether the editor should revoke an app that contains this component.
+    bool exclude_from_auto_revoke = 18;
+    // defines the widget's behaviour in editor page
+    WidgetBehavior widget_behavior = 19;
+
+     enum ScriptType {
+        NO_SCRIPT_TYPE = 0;
+        MODULE = 1;
+    }
+    
+    enum ElementType {
+        WIDGET = 0;
+        PAGE = 1;
+    }
+}
+
+// Web component size
+message Size {
+    // Height in pixels
+    int32 height = 1 [(wix.api.min) = 0, (wix.api.max) = 9999];
+    // Width in pixels
+    int32 width = 2 [(wix.api.min) = 0, (wix.api.max) = 9999];
+}
+
+// Graphic Floating Properties Panel settings
+message Settings {
+    string active_tab = 1;
+    google.protobuf.StringValue fetch_initial_data = 2 [(wix.api.format) = WEB_URL];
+    repeated Tab tabs = 3;
+}
+
+// Setting tab definition
+message Tab {
+    string label = 1;
+    repeated Container items = 2;
+    // hidden tab will not be visible in editor and dev center preview
+    bool hidden = 3;
+}
+
+// UI definition for tab
+message Item {
+     oneof data {
+        //items
+        FontFamilyWithColorPicker font_family_with_color_picker = 1;
+        RadioButtonLabeled radio_button_labeled = 2;
+        ColorSelectLabeled color_select_labeled = 3;  
+        Thumbnails thumbnails = 4;
+        SliderLabeled slider_labeled = 5;
+        DropDownLabeled drop_down_labeled = 6;
+        ToggleLabeled toggle_labeled = 7;
+        BarAlignment bar_alignment = 8;
+        TextInputLabeled text_input_labeled = 9;
+        TextStyle text_style = 10;
+    }
+}
+
+// UI Container in page
+message Container {
+    oneof data {
+        //containers 
+        Main main = 1;
+        Section section = 2;
+        DrillInListItem drill_in_list_item = 3;
+        //items
+        Thumbnails thumbnails = 4;
+        SliderLabeled slider_labeled = 5;
+        DropDownLabeled drop_down_labeled = 6;
+        ToggleLabeled toggle_labeled = 7;
+        BarAlignment bar_alignment = 8;
+        TextInputLabeled text_input_labeled = 9;
+        ResetButton reset_button = 10;
+        FontFamilyWithColorPicker font_family_with_color_picker = 11;
+        RadioButtonLabeled radio_button_labeled = 12;
+        ColorSelectLabeled color_select_labeled = 13;  
+        TextStyle text_style = 14;
+    }
+}
+// DrillInListItem 3
+message DrillInListItem {
+    repeated DrillItem items = 1;
+    string label = 2;
+}
+// Main 1
+message Main {
+    repeated MainPropsData items = 1;
+}
+// DrillItem
+message DrillItem {
+   oneof data {
+         //containers 
+         Section section = 1;
+         //items
+         RadioButtonLabeled radio_button_labeled = 2;
+         ColorSelectLabeled color_select_labeled = 3;  
+         Thumbnails thumbnails = 4;
+         SliderLabeled slider_labeled = 5;
+         DropDownLabeled drop_down_labeled = 6;
+         ToggleLabeled toggle_labeled = 7;
+         BarAlignment bar_alignment = 8;
+         TextInputLabeled text_input_labeled = 9;
+         FontFamilyWithColorPicker font_family_with_color_picker = 10;
+         TextStyle text_style = 11;
+    }
+}
+
+// Section 2
+message Section {
+    string label = 1;
+}
+
+// Elements =========
+// BarAlignment 8
+message BarAlignment {
+    BarAlignmentSelected selected = 1 [deprecated = true];
+    string key = 2;
+    string title = 3;
+    string description = 4;
+    BarAlignmentSelected value = 5;
+    repeated Condition conditions = 6;
+
+}
+// SliderLabeled 5
+message SliderLabeled {
+    string key = 1;
+    string title = 2;
+    string size = 3;
+    string placeholder = 4;
+    string description = 5;
+    int32 minSize = 6;
+    int32 maxSize = 7;
+}
+// Thumbnails 4
+message Thumbnails {
+    string key = 1;
+    string title = 2;
+    string value = 3;
+    repeated ThumbnailData options = 4;
+    ThumbnailsSize size = 5;
+    string description = 6;
+    repeated Condition conditions = 7;
+}
+//11
+message FontFamilyWithColorPicker {
+    string key = 1;
+    string title = 2;
+    string description = 3;
+    FontDefinition value = 4;
+    FontDefinition defaultValue = 5;
+}
+//10
+message ResetButton {
+    string label = 1;
+}
+// TextInputLabeled 9
+message TextInputLabeled {
+    string key = 1;
+    string title = 2;
+    string placeholder = 3;
+    string value = 4;
+    string description = 5;
+}
+// ToggleLabeled 7
+message ToggleLabeled {
+    string key = 1;
+    string title = 2;
+    bool value = 3;
+    string description = 5;
+    repeated Condition conditions = 4;
+}
+
+// RichTextWithIllustrationVertical main 1
+message RichTextWithIllustrationVertical {
+    string key = 1;
+    string label = 2;
+    string text = 3;
+}
+
+// DropDownLabeled 6
+message DropDownLabeled {
+    string key = 1;
+    string title = 2;
+    string value = 3;
+    repeated string options = 4;
+    string description = 5;
+    repeated Condition conditions = 6;
+}
+
+// RadioButtonLabeled 12
+message RadioButtonLabeled {
+    string key = 1;
+    string title = 2;
+    string value = 3;
+    repeated string options = 4;
+    string description = 5;
+    repeated Condition conditions = 6;
+}
+
+// ColorSelectLabeled 13
+message ColorSelectLabeled {
+    string title = 1;
+    string key = 2;
+    string color = 3 [deprecated = true];
+    oneof data {
+        ColorDefinition customColor = 4;
+    TemplateDefaultColor templateColor = 5;
+    };
+    ColorDefinition defaultData = 6;
+    string description = 7;
+}
+
+// TextStyle 14
+message TextStyle {
+    string key = 1;
+    string title = 2;
+    string description = 3;
+    DefaultTextStyle defaultTextStyle = 4;
+    oneof defaultColor {
+    ColorDefinition customColor = 5;
+    TemplateDefaultColor templateColor = 6;
+    };
+}
+
+enum DefaultTextStyle {
+    TITLE = 0;
+    PARAGRAPH = 1;
+    LOWER_HIERARCHY_TEXTS = 2;
+}
+
+enum TemplateDefaultColor {
+    BACKGROUND = 0;
+    SECONDARY_TEXTS = 1;
+    MAIN_TEXT_AND_ICONS = 2;
+    BORDERS_AND_DIVIDERS = 3;
+    BUTTONS_AND_LINKS = 4;
+}
+
+// DashboardButton main 2
+message DashboardButton {
+    string title = 1;
+    string label = 2;
+}
+
+// defintion and enums
+message FontDefinition { 
+    string font = 1;
+    ColorDefinition color = 2;
+}
+message ColorDefinition {
+    string value = 1;
+    string opacity = 2;
+}
+
+// Structure for thumbnail
+message ThumbnailData {
+    string value = 1;
+    google.protobuf.StringValue src = 2 [(wix.api.format) = WEB_URL];
+    google.protobuf.StringValue selected_src = 3 [(wix.api.format) = WEB_URL];
+    google.protobuf.StringValue on_hover_src = 4 [(wix.api.format) = WEB_URL];
+    string label = 5;
+}
+
+enum ThumbnailsSize {
+    SMALL = 0;
+    MEDIUM = 1;
+    LARGE = 2;
+    XLARGE = 3;
+}
+//Bar alignment selected value
+enum BarAlignmentSelected {
+    ALIGN_LEFT = 0;
+    ALIGN_CENTER = 1;
+    ALIGN_RIGHT = 2;
+}
+
+// MainPropsData
+message MainPropsData {
+    DashboardButton dashboard_button = 1;
+    RichTextWithIllustrationVertical rich_text_with_illustration_vertical = 2;
+}
+
+message Condition {
+    string value = 1;
+    repeated SingleKeyCondition state = 2;
+
+}
+message SingleKeyCondition {
+    string key = 1;
+    string value = 2;
+    bool visible = 3;
+}
+
+message WidgetDetails {
+    google.protobuf.StringValue name = 1;
+    google.protobuf.StringValue icon = 2;
+    google.protobuf.StringValue description =3;
+}
+
+message WidgetBehavior {
+    // Toggle whether the widget is removable from the page.
+    bool removable = 1;
+    // Toggle whether the widget is duplicatable from the page.
+    bool duplicatable = 2;
+}

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

@@ -0,0 +1,121 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "components_catalog_common.proto";
+
+// An iframe to be displayed on the user’s site
+message WidgetComponentData {
+    // Allow users to resize and move the widget, or pin it to a specific position on all pages of the site.
+    FixedPositionOptions fixed_position_option = 1;
+    // Widget will automatically be stretched to this width after installing it
+    WidgetWidthType widget_width_type = 2;
+    // Widget width size
+    google.protobuf.Int32Value width = 3 [(wix.api.min) = 0, (wix.api.max) = 9999];
+    // Widget width height
+    google.protobuf.Int32Value height = 4 [(wix.api.min) = 0, (wix.api.max) = 9999];
+    // A public link to the widget endpoint
+    google.protobuf.StringValue widget_endpoint_url = 5 [(wix.api.format) = WEB_URL];
+    // A public link to the mobile endpoint
+    google.protobuf.StringValue widget_mobile_endpoint_url = 6;
+    // A public link to the settings endpoint
+    google.protobuf.StringValue settings_endpoint_url = 7;
+    // A public link to the SEO endpoint
+    google.protobuf.StringValue seo_endpoint_url = 8;
+    //Product display data for this component
+    WidgetDisplay widget_display = 9;
+    // When true, this is the default component
+    bool default = 11;
+    // When this is turned on, this page will be added to the site when installing the app, regardless of whether it's the default component or not
+    bool essential = 12;
+    // Published state for this widget
+    bool published = 13;
+    // When true, allow this widget to be added only once
+    bool add_only_once = 14;
+    // This ID is used to identify your widget endpoint in a Wix site. You can use this ID when using methods of the Wix SDK
+    string tpa_widget_id = 15 [(wix.api.readOnly) = true];
+    //Where this should be rendered
+    Position position = 16;
+    // Article id in settings panel
+    google.protobuf.StringValue help_id = 17;
+    // Default Mobile Height
+    google.protobuf.Int32Value default_mobile_height = 18;
+    // Min Mobile Height
+    google.protobuf.Int32Value min_mobile_height = 19;
+    // Mobile Settings Enabled
+    bool mobile_settings_enabled = 20;
+    // Mobile article id in settings panel
+    google.protobuf.StringValue mobile_help_id = 21;
+    // Editor setting version. optional values: 1 (old - deprecated) or 2 (new). default value is 2
+    google.protobuf.Int32Value settings_version = 22 [(wix.api.min) = 1, (wix.api.max) = 2];
+    // If setting version is 1, this will be the public link to the settings endpoint
+    google.protobuf.StringValue settings_endpoint_url_v1 = 23; //todo: WEB_URL only after migration from oldJson
+    // A public link to the settings endpoint on ADI editor
+    google.protobuf.StringValue on_boarding_settings_endpoint_url = 24; //todo: WEB_URL check if need to migrate from oldJson
+    // The sub pages list for this component to be rendered in
+    repeated SubPage sub_pages = 25;
+    //If this component should be stretched in relation to a form factor (desktop, tablet, mobile)
+    IsStretched is_stretched = 26;
+    //Any margins this page should have in relation to a form factor (desktop, tablet, mobile)
+    Margins margins = 27;
+    //Any docking this page (horizontal / vertical) should have in relation to a form factor (desktop, tablet, mobile)
+    Docking docking = 28;
+    //The height of this page in relation to a form factor (desktop, tablet, mobile)
+    Height height_break_points = 29;
+    //The width of this page in relation to a form factor (desktop, tablet, mobile)
+    Width width_break_points = 30;
+    // Keep default and let users stretch widget to full width (GFPP)
+    bool add_stretch_button = 31;
+    // toggle to mark whether the editor should revoke an app that contains this component.
+    bool exclude_from_auto_revoke = 32;
+    // should be <%=serviceUrl('your_artifact_id', '<resource-path>')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget**
+    google.protobuf.StringValue settings_endpoint_url_template = 33;
+    // should be <%=serviceUrl('your_artifact_id', '<resource-path>')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget**
+    google.protobuf.StringValue settings_endpoint_url_v1_template = 34;
+}
+
+// Allow users to resize and move the widget, or pin it to a specific position on all pages of the site.
+message FixedPositionOptions {
+    // Vertical widget position in the browser window
+    WidgetVertical widget_vertical = 1;
+    // Horizontal widget position in the browser window
+    WidgetHorizontal widget_horizontal = 2;
+}
+
+// Vertical widget position in the browser window
+enum WidgetVertical {
+    NONE_VERTICAL = 0;
+    TOP = 1;
+    CENTER_VERTICAL = 2;
+    BOTTOM = 3;
+}
+
+// Horizontal widget position in the browser window
+enum WidgetHorizontal {
+    NONE_HORIZONTAL = 0;
+    LEFT = 1;
+    CENTER_HORIZONTAL = 2;
+    RIGHT = 3;
+}
+
+// Widget will automatically be stretched to this width after installing it
+enum WidgetWidthType {
+    NONE_TYPE = 0;
+    // A custom width for the widget
+    CUSTOM = 1;
+    // Full width of the browser window
+    FULL = 2;
+}
+
+enum Region {
+    no_region = 0;
+    header = 1;
+    pageContainer = 2;
+    footer = 3;
+}
+
+message Position {
+    Region region = 1;
+}

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

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "components_catalog_data/widget.proto";
+import "components_catalog_data/out_of_iframe.proto";
+
+// A widget out of iframe component that loads directly in the Editor DOM
+message WidgetOutOfIframeComponentData {
+    // A link to the out of iframe component
+    string component_url = 1 [(wix.api.format) = WEB_URL];
+    // A link to the out of iframe controller
+    google.protobuf.StringValue controller_url = 2 [(wix.api.format) = WEB_URL];
+    // This is that widget's data.
+    WidgetComponentData widget_data = 3;
+    // A link to the out of iframe SSR
+    google.protobuf.StringValue ssr_component_url = 4 [(wix.api.format) = WEB_URL];
+    // should be <%=serviceUrl('your_artifact_id', 'component_url_bundle_file')%>
+    google.protobuf.StringValue component_url_template = 5;
+    // should be <%=serviceUrl('your_artifact_id', 'controller_url_bundle_file')%>
+    google.protobuf.StringValue controller_url_template = 6;
+    // Additional info on this OOI widget
+    OutOfIframeData out_of_iframe_data = 7;
+    // should be <%=serviceUrl('your_artifact_id', 'no_css_component_url_bundle_file')%>
+    google.protobuf.StringValue no_css_component_url_template = 8;
+    // A link to the out of iframe no css component url
+    google.protobuf.StringValue no_css_component_url = 9 [(wix.api.format) = WEB_URL];
+}

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

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "components_catalog_data/plugin-interface.proto";
+
+// A component to be rendered within Widget Slots
+message WidgetPluginComponentData {
+    // The ID of the actual widget used that is the Plugin component
+    string reference_component_id = 1 [(wix.api.format) = GUID];
+
+    // The APIs implemented by the Plugin's widget
+    repeated PluginInterface plugin_interfaces = 2;
+
+    // Marketing information about the plugin
+    PluginMarketData market_data = 3;
+
+    // Marketing information about the plugin
+    message PluginMarketData {
+        reserved 4;
+
+        // The name of the Plugin
+        string name = 1 [(wix.api.minLength) = 5];
+
+        // The short description of the Plugin
+        string description = 2 [(wix.api.minLength) = 10];
+
+        // The logo of the Plugin, should be a square image 35 x 35 px in `JPG` or `PNG` format
+        google.protobuf.StringValue logo_url = 3 [(wix.api.format) = WEB_URL];
+    }
+}
+

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

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+// Redirects to either a page component in the Business Manager or to a wix answers article
+message WixOfferingComponentData {
+    // The offering to redirect to
+    oneof offering {
+        BusinessManagerPage business_manager_page = 1; // Redirect to a page in the Business Manager
+        string article_guid = 2 [(wix.api.format) = GUID]; // Redirect to an article with this ID
+    }
+}
+
+message BusinessManagerPage {
+    string component_id = 1; // The ID of the page component to redirect to
+    google.protobuf.StringValue app_state = 2; // Redirect to this app state
+    bool show_regular_app_page = 3; // Whether to show the regular app page in the App Market instead of redirect to the Business Manager page
+}

package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/wix_reviews/com/wixpress/appservice/api/upstream/wix/reviews/product/catalog/spi/v1/reviews_product_catalog_provider.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api.upstream.wix.reviews.product.catalog.spi.v1;
+option java_package = "com.wixpress.appservice.api.upstream.wix.reviews.product.catalog.spi.v1";
+
+import "wix/spi/definitions.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/common/spi.proto";
+
+message ReviewsProductCatalogProviderConfig {
+  option (.wix.api.decomposite_of) = "wix.reviews.product.catalog.spi.v1.ReviewsProductCatalogProviderConfig";
+  // URI where the SPI Implementer is deployed
+  .wix.common.spi.SpiBaseUri uri_config = 1;
+
+  // Namespace of catalog provider
+  string namespace = 2;
+}

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

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "wix/api/validations.proto";
+
+// An invisible iframe to track site activity. It’ll be added to every page on the user’s site
+message WorkerComponentData {
+    // A public link to the worker endpoint
+    string worker_endpoint_url = 1 [(wix.api.format) = URI];
+}