@wix/bex-utils 1.28.0

package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/devcenter/apps/components/v1/component.proto

@@ -0,0 +1,50 @@
+syntax = "proto3";
+
+package wix.devcenter.apps.components.v1;
+option java_package = "com.wixpress.devcenter.apps.components.v1";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "google/protobuf/timestamp.proto";
+import "components_catalog_data.proto";
+import "google/protobuf/struct.proto";
+import "com/wixpress/appservice/api/components_catalog_type.proto";
+
+// Component is the main entity of ComponentsService
+message Component {
+  option (.wix.api.entity) = {
+    fqdn: "wix.devcenter.v1.component"
+    segment: USERS
+  };
+
+  google.protobuf.StringValue id = 1 [(.wix.api.format) = GUID]; // Component Id
+  google.protobuf.Int64Value version = 2 [(wix.api.readOnly) = true]; //The version of the component: None (the mutable instance) or Long (versioned immutable). Domain Entity has 0 instead of None for proper indexing
+  string app_id = 3 [(.wix.api.format) = GUID]; //The app id of the application which this component belongs to
+  google.protobuf.StringValue name = 4; //The name of the component
+  com.wixpress.appservice.api.ComponentType type = 5 [(wix.api.readOnly) = true]; // the type of the component
+  com.wixpress.appservice.api.ComponentData data = 6; // the data of the component
+  google.protobuf.Int64Value revision = 7 [(wix.api.readOnly) = true]; // revision of draft component
+  google.protobuf.StringValue external_id = 10 [(wix.api.minLength) = 1, (wix.api.maxLength) = 64];
+  CreatedBy created_by = 11;
+  google.protobuf.Timestamp created_date = 8 [(wix.api.readOnly) = true];
+  google.protobuf.Timestamp updated_date = 9 [(wix.api.readOnly) = true];
+}
+
+message OldComponentChangedEvent {
+  Component component = 1;
+  Action component_action = 2;
+  google.protobuf.Struct data = 3;
+}
+
+enum Action {
+  CREATED = 0;
+  UPDATED = 1;
+  DELETED = 2;
+}
+
+enum CreatedBy {
+  UNKNOWN = 0;
+  BLOCKS = 1;
+  CLI = 2;
+}

package/@wix/ambassador-data-extensions-v1-data-extension-schema/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-data-extensions-v1-data-extension-schema/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-data-extensions-v1-data-extension-schema/src/main/proto/wix/infra/dataextensions/v1/data_extension_schema.proto

@@ -0,0 +1,114 @@
+syntax = "proto3";
+
+package wix.infra.dataextensions.v1;
+option java_package = "com.wixpress.infra.dataextensions.v1";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "wix/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/struct.proto";
+
+/**
+  DataExtensionSchema is the main entity of DataExtensionSchemaService
+ */
+message DataExtensionSchema {
+  option (wix.api.entity) = {
+    fqdn: "wix.data_extensions.v1.data_extension_schema"
+    segment: PUBLIC
+  };
+
+  google.protobuf.StringValue id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true, (wix.api.immutable) = true]; // Unique identifier for a schema
+  google.protobuf.StringValue fqdn = 2 [(wix.api.immutable) = true, (wix.api.maxLength) = 255]; // FQDN of the entity that this schema extends
+  /*
+  Namespace of this extension. may be:
+    * `@company/app1`
+        An app in dev-center that defines this extension for itself.
+    * `_user_fields`
+        A user that defines this extension for self usage.
+  */
+  google.protobuf.StringValue namespace = 3 [(wix.api.immutable) = true, (wix.api.maxLength) = 164];
+  /*
+  // Actual schema definition of this extension is JSON-SCHEMA format with the following vocab extension:
+  ```
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://wixapis.com/v1/json-schema/extensions",
+    "$vocabulary": {
+        "https://wixapis.com/v1/json-schema/extensions/vocab/data-extensions": true
+    },
+    "$dynamicAnchor": "meta",
+    "title": "Wix' data-extensions vocabulary meta schema",
+    "type": [
+        "object",
+        "boolean"
+    ],
+    "properties": {
+        "x-wix-permissions": {
+            "type": "object",
+            "description": "list of identity types that are allowed reading schema properties",
+            "properties": {
+                "read": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "apps",
+                            "owning-app",
+                            "users",
+                            "users-of-users"
+                        ]
+                    }
+                },
+                "write": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "apps",
+                            "owning-app",
+                            "users",
+                            "users-of-users"
+                        ]
+                    }
+                }
+            }
+        },
+        "x-wix-display": {
+            "type": "object",
+            "description": "field display properties",
+            "schema": {
+                "properties": {
+                    "placeholder": {
+                        "type": "string",
+                        "maxLength": 255,
+                        "description": "placeholder text for input fields"
+                    },
+                    "label": {
+                        "type": "string",
+                        "maxLength": 255,
+                        "description": "label of the input fields"
+                    },
+                    "hint": {
+                        "type": "string",
+                        "maxLength": 255,
+                        "description": "a short explanation that appears next to the input field"
+                    }
+                }
+            }
+        }
+    }
+}
+  ```
+  */
+  google.protobuf.Struct json_schema = 5;
+  google.protobuf.Timestamp updated_date = 6 [(wix.api.readOnly) = true]; // last updated
+  google.protobuf.Timestamp created_date = 7 [(wix.api.readOnly) = true]; // creation date
+  google.protobuf.Int64Value revision = 8 [(wix.api.readOnly) = true]; // revision of data record
+
+  google.protobuf.StringValue app_def_id = 101 [(wix.api.format) = GUID, (wix.api.readOnly) = true, (wix.api.field_exposure) = PRIVATE]; // app def if of the app in the given namespace
+
+  google.protobuf.Int32Value max_limit_bytes = 9 [(wix.api.readOnly) = true]; // Maximum allowed schema size in bytes
+  google.protobuf.Int32Value current_size_bytes = 10 [(wix.api.readOnly) = true]; // Current schema size in bytes
+}

package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/infra/dataextensions/v1/data_extension_schema_service.proto

@@ -0,0 +1,162 @@
+syntax = "proto3";
+
+package wix.infra.dataextensions.v1;
+option java_package = "com.wixpress.infra.dataextensions.v1";
+
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/permissions.proto";
+import "wix/api/callback.proto";
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+import "wix/infra/dataextensions/v1/data_extension_schema.proto";
+
+/**
+  Manages DataExtensionSchemas
+ */
+service DataExtensionSchemaService {
+  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_exposure) = INTERNAL;
+  option (wix.api.service_entity).message = "wix.infra.dataextensions.v1.DataExtensionSchema";
+
+  // Creates a new data extension schema
+  rpc CreateDataExtensionSchema (CreateDataExtensionSchemaRequest) returns (CreateDataExtensionSchemaResponse) {
+    option (wix.api.crud) = {
+      method: CREATE
+    };
+    option (wix.api.exposure) = INTERNAL;
+    option (google.api.http) = {
+      post: "/v1/schemas"
+    };
+    option (wix.api.required) = "CreateDataExtensionSchemaRequest.data_extension_schema";
+    option (wix.api.required) = "CreateDataExtensionSchemaRequest.data_extension_schema.json_schema";
+    option (wix.api.required) = "CreateDataExtensionSchemaRequest.data_extension_schema.fqdn";
+    option (wix.api.required) = "CreateDataExtensionSchemaRequest.data_extension_schema.namespace";
+    option (wix.api.writable) = "CreateDataExtensionSchemaRequest.data_extension_schema.fqdn";
+    option (wix.api.writable) = "CreateDataExtensionSchemaRequest.data_extension_schema.namespace";
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+    option (wix.api.permission).name = "DATA_EXTENSION_SCHEMA.WRITE";
+  }
+
+  // Updates an existing data extension schema
+  rpc UpdateDataExtensionSchema (UpdateDataExtensionSchemaRequest) returns (UpdateDataExtensionSchemaResponse) {
+    option (wix.api.exposure) = INTERNAL;
+    option (google.api.http) = {
+      put: "/v1/schemas"
+    };
+    option (wix.api.required) = "UpdateDataExtensionSchemaRequest.data_extension_schema.id";
+    option (wix.api.required) = "UpdateDataExtensionSchemaRequest.data_extension_schema.revision";
+    option (wix.api.required) = "UpdateDataExtensionSchemaRequest.data_extension_schema.json_schema";
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+    option (wix.api.permission).name = "DATA_EXTENSION_SCHEMA.WRITE";
+  }
+
+  // Lists both global and user defined data extensions schema for the fqdn
+  rpc ListDataExtensionSchemas (ListDataExtensionSchemasRequest) returns (ListDataExtensionSchemasResponse) {
+    option (wix.api.exposure) = INTERNAL;
+    option (wix.api.required) = "ListDataExtensionSchemasRequest.fqdn";
+    option (google.api.http) = {
+      get: "/v1/schemas"
+    };
+    option (wix.api.permission).name = "DATA_EXTENSION_SCHEMA.READ";
+  }
+
+  // Upsert global extension schemas
+  rpc UpsertDataExtensionGlobalSchema (UpsertDataExtensionGlobalSchemaRequest) returns (UpsertDataExtensionGlobalSchemaResponse) {
+    option (wix.api.exposure) = PRIVATE;
+    option (wix.api.required) = "UpsertDataExtensionGlobalSchemaRequest.data_extension_schema";
+    option (wix.api.required) = "UpsertDataExtensionGlobalSchemaRequest.data_extension_schema.json_schema";
+    option (wix.api.required) = "UpsertDataExtensionGlobalSchemaRequest.data_extension_schema.fqdn";
+    option (wix.api.required) = "UpsertDataExtensionGlobalSchemaRequest.data_extension_schema.namespace";
+    option (wix.api.writable) = "UpsertDataExtensionGlobalSchemaRequest.data_extension_schema.fqdn";
+    option (wix.api.writable) = "UpsertDataExtensionGlobalSchemaRequest.data_extension_schema.namespace";
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+    option (wix.api.permission).name = "DATA_EXTENSION_SCHEMA.MANAGE_APP_DEFINED";
+  }
+
+  // Delete demo data extension schema (only allowed for demo entity fqdn: wix.prime.auto.*.demo_entity)
+  rpc DeleteDemoDataExtensionSchema (DeleteDemoDataExtensionSchemaRequest) returns (DeleteDemoDataExtensionSchemaResponse) {
+    option (wix.api.exposure) = PRIVATE;
+    option (wix.api.required) = "DeleteDemoDataExtensionSchemaRequest.data_extension_schema_id";
+    option (wix.api.callback) = {
+      event_type: DELETED
+    };
+    option (wix.api.permission).name = "DATA_EXTENSION_SCHEMA.MANAGE_APP_DEFINED";
+  }
+
+  // Enrich and save existing data extension schema (temporary endpoint for data migration)
+  rpc EnrichAndSaveDataExtensionSchema (EnrichAndSaveDataExtensionSchemaRequest) returns (EnrichAndSaveDataExtensionSchemaResponse) {
+    option (wix.api.exposure) = PRIVATE;
+    option (wix.api.required) = "EnrichAndSaveDataExtensionSchemaRequest.data_extension_schema_id";
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+    option (google.api.http) = {
+      post: "/v1/schemas/enrich"
+    };
+    option (wix.api.permission).name = "DATA_EXTENSION_SCHEMA.MANAGE_APP_DEFINED";
+  }
+}
+
+message ListDataExtensionSchemasRequest {
+  string fqdn = 1 [(wix.api.maxLength) = 255]; // fqdn
+  repeated string namespaces = 2 [(wix.api.maxSize) = 100, (wix.api.maxLength) = 164]; // namespaces
+  repeated RequestedField fields = 3 [(wix.api.maxSize) = 5]; // Shows additional requested fields
+}
+
+message ListDataExtensionSchemasResponse {
+  repeated DataExtensionSchema data_extension_schemas = 1; // resulted schemas
+}
+
+message UpdateDataExtensionSchemaRequest {
+  DataExtensionSchema data_extension_schema = 1; // the schema to update
+}
+
+message UpdateDataExtensionSchemaResponse {
+  DataExtensionSchema data_extension_schema = 1; // the updated schema
+}
+
+message CreateDataExtensionSchemaRequest {
+  DataExtensionSchema data_extension_schema = 1; // the schema to create
+}
+
+message CreateDataExtensionSchemaResponse {
+  DataExtensionSchema data_extension_schema = 1; // the created schema
+}
+
+message UpsertDataExtensionGlobalSchemaRequest {
+  DataExtensionSchema data_extension_schema = 1; // the upsert to create
+}
+
+message UpsertDataExtensionGlobalSchemaResponse {
+  DataExtensionSchema data_extension_schema = 1; // the upsert schema
+}
+
+enum RequestedField {
+  UNKNOWN_REQUESTED_FIELD = 0; // Doesn't do anything
+  ARCHIVED = 1; // Shows x-wix-archived fields in DataExtensionSchema.json_schema
+}
+
+message DeleteDemoDataExtensionSchemaRequest {
+  string data_extension_schema_id = 1 [(wix.api.format) = GUID]; // schema id
+}
+
+message DeleteDemoDataExtensionSchemaResponse {}
+
+message EnrichAndSaveDataExtensionSchemaRequest {
+  string data_extension_schema_id = 1 [(wix.api.format) = GUID]; // schema id
+  string tenant_id = 2 [(wix.api.format) = GUID]; // tenant id
+}
+
+message EnrichAndSaveDataExtensionSchemaResponse {
+  DataExtensionSchema data_extension_schema = 1; // the updated schema
+}

package/@wix/ambassador-data-extensions-v1-data-extension-schema/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;
+}