@wix/bex-utils 2.108.0 → 2.110.0

package/@wix/ambassador-data-v1-external-database-connection/package.json

@@ -0,0 +1,108 @@
+{
+  "name": "@wix/ambassador-data-v1-external-database-connection",
+  "version": "1.0.133",
+  "publishConfig": {
+    "registry": "https://npm-cache.dev.wixpress.com/",
+    "access": "restricted"
+  },
+  "type": "module",
+  "files": [
+    "cjs",
+    "es/build",
+    "http",
+    "rpc",
+    "builders",
+    "types",
+    "validators",
+    "meta",
+    "crud/**/package.json",
+    "src/main/proto"
+  ],
+  "sideEffects": false,
+  "exports": {
+    "./package.json": "./package.json",
+    "./http": {
+      "types": "./cjs/build/http.impl.d.ts",
+      "require": "./cjs/build/http.impl.js",
+      "import": "./es/build/http.impl.js"
+    },
+    "./rpc": {
+      "types": "./cjs/build/rpc.impl.d.ts",
+      "require": "./cjs/build/rpc.impl.js",
+      "import": "./es/build/rpc.impl.js"
+    },
+    "./builders": {
+      "types": "./cjs/build/builders.impl.d.ts",
+      "require": "./cjs/build/builders.impl.js",
+      "import": "./es/build/builders.impl.js"
+    },
+    "./types": {
+      "types": "./cjs/build/types.impl.d.ts",
+      "require": "./cjs/build/types.impl.js",
+      "import": "./es/build/types.impl.js"
+    },
+    "./validators": {
+      "types": "./cjs/build/validators.impl.d.ts",
+      "require": "./cjs/build/validators.impl.js",
+      "import": "./es/build/validators.impl.js"
+    },
+    "./meta": {
+      "types": "./cjs/build/meta.impl.d.ts",
+      "require": "./cjs/build/meta.impl.js",
+      "import": "./es/build/meta.impl.js"
+    },
+    "./crud/rpc": {
+      "types": "./cjs/build/crud/rpc.impl.d.ts",
+      "require": "./cjs/build/crud/rpc.impl.js",
+      "import": "./es/build/crud/rpc.impl.js"
+    },
+    "./crud/http": {
+      "types": "./cjs/build/crud/http.impl.d.ts",
+      "require": "./cjs/build/crud/http.impl.js",
+      "import": "./es/build/crud/http.impl.js"
+    }
+  },
+  "scripts": {
+    "build": "yarn generate && yarn proto:clean && yarn build:cjs && yarn build:esm",
+    "build:clean": "rm -rf ./cjs/build ./es/build",
+    "build:cjs": "yarn proto:cjs && yarn tsc:cjs && cp -r ./proto ./cjs/build/proto",
+    "build:esm": "yarn proto:esm && yarn tsc:esm && cp -r ./proto ./es/build/proto",
+    "proto:clean": "rm -rf ./proto",
+    "proto:gen": "wix-proto-codegen --module . --dir proto --stringEnums --tsClasses --stringLongs",
+    "proto:cjs": "yarn proto:gen",
+    "proto:esm": "yarn proto:gen --esm",
+    "tsc:cjs": "tsc -p tsconfig.json",
+    "tsc:esm": "tsc -p tsconfig.esm.json",
+    "test": ":",
+    "generate": "YARN_ENABLE_SCRIPTS=false yarn dlx @wix/metro-ambassador-cli@$(jq -r '.cliVersion' manifest.json) --manifest ./manifest.json --entity ./entity.json --output . --proto-dir ./src/main/proto --data-mapper ./data-mapper.json"
+  },
+  "dependencies": {
+    "@wix/auto-crud": "^1.0.0",
+    "@wix/http-client": "^1.0.0",
+    "@wix/metro-common-builders": "^1.0.1763",
+    "@wix/metro-runtime": "^1.2116.0",
+    "callsite": "^1.0.0",
+    "joi": "^17.0.0"
+  },
+  "devDependencies": {
+    "@types/callsite": "^1.0.0",
+    "@wix/wix-proto-codegen": "^2.0.1176",
+    "typescript": "~5.9.3"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "data-v1-external-database-connection",
+      "groupId": "com.wixpress.metro-packages"
+    },
+    "ambassador": {
+      "fqdn": "wix.data.v1.external_database_connection",
+      "protoArtifactId": "com.wixpress.cloud:external-database-connection-api"
+    }
+  },
+  "falconPackageHash": "c06056f03c04d640028aca73e17e9c1557cfce194d783555acc4668d",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wix-private/metro-packages.git",
+    "directory": "packages/ambassador/data-v1-external-database-connection"
+  }
+}

package/@wix/ambassador-data-v1-external-database-connection/rpc/package.json

@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "main": "../cjs/build/rpc.impl.js",
+  "types": "../cjs/build/rpc.impl.d.ts",
+  "sideEffects": false
+}

package/@wix/ambassador-data-v1-external-database-connection/src/main/proto/com/wixpress/cloud/data/api/common.proto

@@ -0,0 +1,63 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api;
+
+import "wix/api/annotations.proto";
+
+enum Environment {
+  // Place holder. Never returned by the service.
+  UNKNOWN_ENVIRONMENT = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+  // Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections).
+  SANDBOX = 1;
+  // If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment.
+  SANDBOX_PREFERRED = 2;
+  // Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections).
+  LIVE = 3;
+}
+
+enum FieldType {
+  UNKNOWN_FIELD_TYPE = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+  TEXT = 1;
+  NUMBER = 2;
+  DATE = 3;
+  DATETIME = 4;
+  IMAGE = 5;
+  BOOLEAN = 6;
+  DOCUMENT = 7;
+  URL = 8;
+  RICH_TEXT = 9;
+  VIDEO = 10;
+  ANY = 11;
+  ARRAY_STRING = 12;
+  ARRAY_DOCUMENT = 13;
+  AUDIO = 14;
+  TIME = 15;
+  LANGUAGE = 16;
+  RICH_CONTENT = 17;
+  MEDIA_GALLERY = 18;
+  ADDRESS = 19;
+  PAGE_LINK = 20;
+  REFERENCE = 21;
+  MULTI_REFERENCE = 22;
+  OBJECT = 23;
+  ARRAY = 24;
+  // Deprecated - can’t be added to collections. Can only appear in older collections.
+  LEGACY_TIME = 25;
+  // Deprecated - can’t be added to collections. Can only appear in older collections.
+  LEGACY_BOOK = 26;
+  // Deprecated - can’t be added to collections. Can only appear in older collections.
+  LEGACY_EXTERNAL_URL = 27;
+  // Deprecated - can’t be added to collections. Can only appear in older collections.
+  LEGACY_BROKEN_REFERENCE = 28;
+  // Deprecated - can’t be added to collections. Can only appear in older collections.
+  LEGACY_IMAGE = 29;
+  // Deprecated - can’t be added to collections. Can only appear in older collections.
+  LEGACY_COLOR = 30;
+  // Deprecated - can’t be added to collections. Can only appear in older collections.
+  LEGACY_EXTERNAL_VIDEO = 31;
+  SLUG = 32 [(.wix.api.enum_maturity) = ALPHA, (.wix.api.enum_exposure) = INTERNAL];
+  EMAIL = 33 [(.wix.api.enum_maturity) = ALPHA];
+  SECURED_MEDIA = 34 [(.wix.api.enum_maturity) = ALPHA];
+  MEDIA_IMAGE = 35 [(.wix.api.enum_maturity) = ALPHA];
+  MEDIA_VECTOR_ART = 36 [(.wix.api.enum_maturity) = ALPHA];
+}

package/@wix/ambassador-data-v1-external-database-connection/src/main/proto/com/wixpress/cloud/data/api/externaldatabase/external-database-connection-service.proto

@@ -0,0 +1,305 @@
+//flynt-disable missing-autovelo-def
+//flynt-disable required-annotation-breaking-change
+//flynt-disable http-mapping-breaking-change
+//flynt-disable missing-taggable-annotation
+//flynt-disable update-missing-inferred-fieldmask
+//flynt-disable missing-entity-id-field
+//flynt-disable update-must-support-http-patch
+
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.externaldatabase;
+
+import "google/protobuf/empty.proto";
+import "google/api/annotations.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/callback.proto";
+import "wix/api/entity.proto";
+import "wix/api/permissions.proto";
+import "wix/api/validations.proto";
+import "wix/sdk/definitions.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/externaldatabase/upstream/externaldatabase/wix/common/paging.proto";
+
+// Manage external database connections.
+service ExternalDatabaseConnectionService {
+  option (wix.api.service_entity).message = "com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection";
+  option (wix.api.service_exposure) = PUBLIC;
+  option (wix.api.service_maturity) = GA;
+
+  // Retrieves the specified external database connection.
+  rpc GetExternalDatabaseConnection (GetExternalDatabaseConnectionRequest) returns (GetExternalDatabaseConnectionResponse) {
+    option (wix.api.required) = "GetExternalDatabaseConnectionRequest.name";
+    option (wix.api.permission).name = "WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION";
+    option (google.api.http).get = "/v1/external-database-connections/{name=**}";
+
+    option (wix.api.crud) = {
+      method: GET_ITEM
+      get_options: {
+        id_field: "name",
+        item_field: "external_database_connection"
+      }
+    };
+  }
+
+  // Lists all of the site's external database connections of all adaptor types.
+  rpc ListExternalDatabaseConnections (ListExternalDatabaseConnectionsRequest) returns (ListExternalDatabaseConnectionsResponse) {
+    option (wix.api.permission).name = "WIX_DATA.LIST_EXTERNAL_DATABASE_CONNECTIONS";
+    option (google.api.http).get = "/v1/external-database-connections";
+  }
+
+  // Creates a new external database connection.
+  //
+  // Before you can establish a connection between a site and an external database, you must prepare an external database adaptor.
+  rpc CreateExternalDatabaseConnection (CreateExternalDatabaseConnectionRequest) returns (CreateExternalDatabaseConnectionResponse) {
+    option (wix.api.required) = "CreateExternalDatabaseConnectionRequest.external_database_connection";
+    option (wix.api.writable) = "CreateExternalDatabaseConnectionRequest.external_database_connection.name";
+    option (wix.api.required) = "CreateExternalDatabaseConnectionRequest.external_database_connection.name";
+    option (wix.api.required) = "CreateExternalDatabaseConnectionRequest.connection_type";
+    option (wix.api.permission).name = "WIX_DATA.CREATE_EXTERNAL_DATABASE_CONNECTION";
+    option (google.api.http).post = "/v1/external-database-connections";
+    option (.wix.sdk.signature) = {
+      params: "external_database_connection",
+      params: "connection_type"
+    };
+
+    // Triggered when an external database connection is created.
+    option (wix.api.emits) = {
+      event_type: CREATED,
+    };
+
+    option (wix.api.crud) = {
+      method: CREATE
+      create_options: {
+        item_field: "external_database_connection"
+      }
+    };
+  }
+
+  // Updates an external database connection.
+  //
+  // > **Note:** After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.
+  rpc UpdateExternalDatabaseConnection (UpdateExternalDatabaseConnectionRequest) returns (UpdateExternalDatabaseConnectionResponse) {
+    option (wix.api.required) = "UpdateExternalDatabaseConnectionRequest.external_database_connection";
+    option (wix.api.required) = "UpdateExternalDatabaseConnectionRequest.external_database_connection.name";
+    option (wix.api.permission).name = "WIX_DATA.UPDATE_EXTERNAL_DATABASE_CONNECTION";
+    option (google.api.http).put = "/v1/external-database-connections/{externalDatabaseConnection.name=**}";
+
+    // Triggered when an external database connection is updated.
+    option (wix.api.emits) = {
+      event_type: UPDATED
+    };
+
+    option (wix.api.crud) = {
+      method: UPDATE
+      update_options: {
+        item_field: "external_database_connection"
+      }
+    };
+  }
+
+  // Deletes an external database connection.
+  //
+  // > **Note:** Once an external database connection is deleted, it can't be restored. To reconnect the database, create a new external database connection.
+  rpc DeleteExternalDatabaseConnection (DeleteExternalDatabaseConnectionRequest) returns (DeleteExternalDatabaseConnectionResponse) {
+    option (wix.api.required) = "DeleteExternalDatabaseConnectionRequest.name";
+    option (wix.api.permission).name = "WIX_DATA.DELETE_EXTERNAL_DATABASE_CONNECTION";
+    option (google.api.http).delete = "/v1/external-database-connections/{name=**}";
+
+    // Triggered when an external database connection is deleted.
+    option (wix.api.emits) = {
+      event_type: DELETED
+    };
+
+    option (wix.api.crud) = {
+      method: DELETE
+      delete_options: {
+        id_field: "name"
+      }
+    };
+  }
+}
+
+// An external database connection defines a connection between an external database and a Wix site.
+message ExternalDatabaseConnection {
+  option (.wix.api.entity) = {
+    fqdn: "wix.data.v1.external_database_connection",
+    app_def_id: "e593b0bd-b783-45b8-97c2-873d42aacaf4",
+    segment: USERS,
+    appendix_files: {
+      type: AUTO_VELO
+      path: "appendices/velo"
+    },
+    appendix_files: {
+      type: DOCS_CONF
+      path: "appendices/docs"
+    },
+    domain_events_read_permission: "WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"
+  };
+
+  // Triggered when an external database connection is created.
+  option (.wix.api.domain_event) = {
+    event_type: CREATED
+    exposure: PUBLIC
+  };
+
+  // Triggered when an external database connection is updated.
+  option (.wix.api.domain_event) = {
+    event_type: UPDATED
+    exposure: PUBLIC
+  };
+
+  // Triggered when an external database connection is deleted.
+  option (.wix.api.domain_event) = {
+    event_type: DELETED
+    exposure: PUBLIC
+  };
+
+  message ConnectionStatus {
+    enum CauseOfFailure {
+      // No connection failure.
+      NONE = 0;
+
+      // General communication failure.
+      COMMUNICATION_FAILURE = 1;
+
+      // External database host is unreachable.
+      DESTINATION_HOST_UNREACHABLE = 2;
+
+      // Unauthorized to access the external database.
+      UNAUTHORIZED = 3;
+
+      // `endpoint` is not set.
+      DESTINATION_ENDPOINT_NOT_DEFINED = 4;
+    }
+    enum CollectionsFound {
+      // Attempt to connect to the external database failed, so status is unknown.
+      UNKNOWN = 0;
+      // External database has collections.
+      YES = 1;
+      // External database does not have any collections.
+      NO = 2;
+    }
+
+    // Whether the connection was established successfully.
+    bool successful = 1;
+
+    // Whether and why the connection attempt failed.
+    CauseOfFailure cause_of_failure = 2;
+
+    // Whether the external database has collections.
+    CollectionsFound has_collections = 3 [(.wix.api.readOnly) = true];
+  };
+  message Capabilities {
+    // Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them.
+    bool collection_modifications_supported = 1;
+    // Field types the external database supports. Applies only when `collectionModificationsSupported` is set to `true`.
+    repeated FieldType field_types = 2 [(.wix.api.maxSize) = 255];
+  }
+
+  // Name of the external database connection.
+  //
+  // An external database connection can connect to one or more external data collections or tables. These appear as `connectionName/dataCollectionId`.
+  string name = 1 [(.wix.api.immutable) = true, (wix.api.minLength) = 1, (wix.api.maxLength) = 255];
+
+  // Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`.
+  // Required for STANDALONE connection type.
+  google.protobuf.StringValue endpoint = 2 [(wix.api.format) = WEB_URL];
+
+  // Settings specified to the external database connection as part of each request.
+  //
+  // These settings can relate to authentication, tenancy, or provide any other information necessary for processing a request. Their content and structure depend on the specific requirements of the external database's API.
+  google.protobuf.Struct configuration = 3;
+
+  // Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.
+  ConnectionStatus connection_status = 4 [(.wix.api.readOnly) = true];
+
+  // Protocol version of the external database connection.
+  ProtocolVersion protocol_version = 5 [(.wix.api.readOnly) = true, (wix.api.field_exposure) = INTERNAL];
+
+  // Public key used to validate requests to the external database.
+  google.protobuf.StringValue public_key = 6 [(.wix.api.readOnly) = true, (.wix.api.maxLength) = 128];
+
+  // Capabilities of the external database.
+  Capabilities capabilities = 7 [(.wix.api.readOnly) = true];
+
+  // ID of the app used to integrate this external database.
+  google.protobuf.StringValue application_id = 8 [(.wix.api.readOnly) = true, (.wix.api.maxLength) = 128, (wix.api.field_exposure) = INTERNAL];
+
+  enum ProtocolVersion {
+    UNKNOWN_PROTOCOL_VERSION = 0  [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    V1 = 1;
+    V2 = 2;
+    V3 = 3;
+  }
+}
+
+
+message GetExternalDatabaseConnectionRequest {
+  // Name of the external database connection to retrieve.
+  string name = 1 [(.wix.api.maxLength) = 255];
+}
+
+message GetExternalDatabaseConnectionResponse {
+  // Details of the retrieved external database connection.
+  ExternalDatabaseConnection external_database_connection = 1;
+}
+
+message ListExternalDatabaseConnectionsRequest {
+  // Paging metadata.
+  upstream.externaldatabase.wix.common.Paging paging = 1;
+}
+
+message ListExternalDatabaseConnectionsResponse {
+  // List of external database connections.
+  repeated ExternalDatabaseConnection external_database_connections = 1;
+
+  // Paging metadata.
+  upstream.externaldatabase.wix.common.PagingMetadata paging_metadata = 2;
+}
+
+message CreateExternalDatabaseConnectionRequest {
+  // External database connection details.
+  ExternalDatabaseConnection external_database_connection = 1;
+
+  // Connection type. The connection type specifies the type of adaptor by which the external collection is integrated with the site.
+  ConnectionType connection_type = 2;
+
+  // Whether the database is managed by Wix.
+  bool database_managed_by_wix = 3 [(wix.api.field_exposure) = PRIVATE];
+}
+
+enum ConnectionType {
+  // Unknown connection type.
+  UNKNOWN_CONNECTION_TYPE = 0  [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+  // External database connection based on the legacy [external database collection service plugin](https://dev.wix.com/docs/velo/api-reference/wix-data-v2/service-plugins-spis/external-database-collection-legacy/introduction).
+  STANDALONE = 1;
+  // External database connection based on the [external database service plugin](https://dev.wix.com/docs/rest/business-solutions/cms/service-plugins/external-database-service-plugin/introduction).
+  WIX_SERVICE_PLUGIN = 2;
+}
+
+message CreateExternalDatabaseConnectionResponse {
+  // Details of the created external database connection.
+  ExternalDatabaseConnection external_database_connection = 1;
+}
+
+message UpdateExternalDatabaseConnectionRequest {
+  // Updated external database connection. The existing connection is replaced with this version.
+  ExternalDatabaseConnection external_database_connection = 2;
+}
+
+message UpdateExternalDatabaseConnectionResponse {
+  // Details of the updated external database connection.
+  ExternalDatabaseConnection external_database_connection = 1;
+}
+
+message DeleteExternalDatabaseConnectionRequest {
+  // Name of the external database connection to delete.
+  string name = 1 [(.wix.api.maxLength) = 255];
+}
+
+message DeleteExternalDatabaseConnectionResponse {
+
+}

package/@wix/ambassador-data-v1-external-database-connection/src/main/proto/com/wixpress/cloud/data/api/externaldatabase/upstream/externaldatabase/wix/common/paging.proto

@@ -0,0 +1,112 @@
+syntax = "proto3";
+
+package upstream.externaldatabase.wix.common;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_multiple_files = true;
+option java_package = "com.upstream.externaldatabase.wix.common";
+
+message Paging {
+    option (.wix.api.decomposite_of) = "wix.common.Paging";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "limit"
+        field: "offset"
+    };
+    // Number of items to load.
+    google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0];
+    // Number of items to skip in the current sort order.
+    google.protobuf.Int32Value offset = 2 [(.wix.api.min) = 0];
+}
+
+message CursorPaging {
+    option (.wix.api.decomposite_of) = "wix.common.CursorPaging";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "limit"
+        field: "cursor"
+    };
+    // Number of items to load.
+    google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0, (.wix.api.max) = 100];
+    /*
+    Pointer to the next or previous page in the list of results.
+
+    You can get the relevant cursor token
+    from the `pagingMetadata` object in the previous call's response.
+    Not relevant for the first request.
+    */
+    google.protobuf.StringValue cursor = 2 [(.wix.api.maxLength) = 16000];
+}
+
+message PagingMetadata {
+    option (.wix.api.decomposite_of) = "wix.common.PagingMetadata";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "offset"
+    };
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    google.protobuf.Int32Value offset = 2;
+    // Total number of items that match the query.
+    google.protobuf.Int32Value total = 3;
+    // Flag that indicates the server failed to calculate the `total` field.
+    google.protobuf.BoolValue too_many_to_count = 4;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 5 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+message PagingMetadataV2 {
+    option (.wix.api.decomposite_of) = "wix.common.PagingMetadataV2";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "offset"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "cursors"
+    };
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    google.protobuf.Int32Value offset = 2;
+    // Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.
+    google.protobuf.Int32Value total = 3;
+    // Flag that indicates the server failed to calculate the `total` field.
+    google.protobuf.BoolValue too_many_to_count = 4;
+    // Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.
+    Cursors cursors = 5;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 6 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+
+// This is the preferred message for cursor-paging enabled services
+
+message CursorPagingMetadata {
+    option (.wix.api.decomposite_of) = "wix.common.CursorPagingMetadata";
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    Cursors cursors = 2;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 3;
+}
+
+message Cursors {
+    option (.wix.api.decomposite_of) = "wix.common.Cursors";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "next"
+    };
+    // Cursor pointing to next page in the list of results.
+    google.protobuf.StringValue next = 1 [(.wix.api.maxLength) = 16000];
+    // Cursor pointing to previous page in the list of results.
+    google.protobuf.StringValue prev = 2 [(.wix.api.maxLength) = 16000];
+}

package/@wix/ambassador-data-v1-external-database-connection/src/main/proto/com/wixpress/iptf/webhooks/debug.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+import "google/api/annotations.proto";
+
+package com.wixpress.iptf.webhooks;
+
+service Debug {
+  rpc queryMessageId(QueryMessageIdRequest) returns (QueryResponse){
+    option (google.api.http) = {
+      post: "/queryMessageId"
+    };
+  };
+
+  rpc queryOffset(QueryOffsetRequest) returns (QueryResponse){
+    option (google.api.http) = {
+      post: "/queryOffset"
+    };
+  };
+}
+
+message QueryOffsetRequest {
+  string topic = 1;
+  int32 partition = 2;
+  int64 offset = 3;
+}
+
+message QueryMessageIdRequest {
+  string message_id = 1;
+}
+
+message QueryResponse {
+  repeated string json = 1;
+}

package/@wix/ambassador-data-v1-external-database-connection/src/main/proto/com/wixpress/iptf/webhooks/kv.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+import "google/api/annotations.proto";
+
+package com.wixpress.iptf.webhooks;
+
+service WebhooksKV {
+  rpc queryApp(QueryAppRequest) returns (QueryAppResponse){
+    option (google.api.http) = {};
+  };
+
+  rpc queryAppSecretAndPrivateKey(QueryAppSecretAndPrivateKeyRequest) returns (QueryAppSecretAndPrivateKeyResponse){
+    option (google.api.http) = {};
+  };
+}
+
+message QueryAppRequest {
+  string app_def_id = 1;
+  string version = 2;
+}
+
+message QueryAppSecretAndPrivateKeyRequest {
+  string app_def_id = 1;
+}
+
+message QueryAppSecretAndPrivateKeyResponse {
+  google.protobuf.StringValue private_key = 1;
+  string secret = 2;
+}
+
+message QueryAppResponse {
+  repeated string permissions = 1;
+  google.protobuf.StringValue private_key = 2;
+  string secret = 3;
+  repeated DispatcherAppWebhook webhook = 4;
+}
+
+message DispatcherAppWebhook {
+    string webhookSlug = 1;
+    string callback_url = 2;
+}