@wix/data 1.0.73 → 1.0.75

package/build/cjs/src/data-v1-external-database-connection.public.d.ts

@@ -1,5 +1,5 @@
 import { HttpClient } from '@wix/sdk-types';
-import { ExternalDatabaseConnection, UpdateExternalDatabaseConnection, ListExternalDatabaseConnectionsOptions } from './data-v1-external-database-connection.universal';
+import { ExternalDatabaseConnection, UpdateExternalDatabaseConnection, CreateExternalDatabaseConnectionOptions, ListExternalDatabaseConnectionsOptions } from './data-v1-external-database-connection.universal';
 export declare const __metadata: {
     PACKAGE_NAME: string;
 };
@@ -10,21 +10,19 @@ export declare function getExternalDatabaseConnection(httpClient: HttpClient): (
         causeOfFailure: import("./data-v1-external-database-connection.universal").CauseOfFailure;
         hasCollections: import("./data-v1-external-database-connection.universal").CollectionsFound;
     } | undefined;
-    protocolVersion: import("./data-v1-external-database-connection.universal").ProtocolVersion;
     capabilities?: {
         collectionModificationsSupported: boolean;
         fieldTypes: import("./data-v1-external-database-connection.universal").FieldType[];
     } | undefined;
 }>;
 export declare function listExternalDatabaseConnections(httpClient: HttpClient): (options?: ListExternalDatabaseConnectionsOptions) => Promise<import("./data-v1-external-database-connection.universal").ListExternalDatabaseConnectionsResponse & import("./data-v1-external-database-connection.universal").ListExternalDatabaseConnectionsResponseNonNullableFields>;
-export declare function createExternalDatabaseConnection(httpClient: HttpClient): (externalDatabaseConnection: ExternalDatabaseConnection) => Promise<ExternalDatabaseConnection & {
+export declare function createExternalDatabaseConnection(httpClient: HttpClient): (externalDatabaseConnection: ExternalDatabaseConnection, options?: CreateExternalDatabaseConnectionOptions) => Promise<ExternalDatabaseConnection & {
     name: string;
     connectionStatus?: {
         successful: boolean;
         causeOfFailure: import("./data-v1-external-database-connection.universal").CauseOfFailure;
         hasCollections: import("./data-v1-external-database-connection.universal").CollectionsFound;
     } | undefined;
-    protocolVersion: import("./data-v1-external-database-connection.universal").ProtocolVersion;
     capabilities?: {
         collectionModificationsSupported: boolean;
         fieldTypes: import("./data-v1-external-database-connection.universal").FieldType[];
@@ -37,12 +35,11 @@ export declare function updateExternalDatabaseConnection(httpClient: HttpClient)
         causeOfFailure: import("./data-v1-external-database-connection.universal").CauseOfFailure;
         hasCollections: import("./data-v1-external-database-connection.universal").CollectionsFound;
     } | undefined;
-    protocolVersion: import("./data-v1-external-database-connection.universal").ProtocolVersion;
     capabilities?: {
         collectionModificationsSupported: boolean;
         fieldTypes: import("./data-v1-external-database-connection.universal").FieldType[];
     } | undefined;
 }>;
 export declare function deleteExternalDatabaseConnection(httpClient: HttpClient): (name: string) => Promise<void>;
-export { CauseOfFailure, CollectionsFound, FieldType, ProtocolVersion, } from './data-v1-external-database-connection.universal';
-export { ExternalDatabaseConnection, ConnectionStatus, Capabilities, GetExternalDatabaseConnectionRequest, GetExternalDatabaseConnectionResponse, ListExternalDatabaseConnectionsRequest, Paging, ListExternalDatabaseConnectionsResponse, PagingMetadata, CreateExternalDatabaseConnectionRequest, CreateExternalDatabaseConnectionResponse, UpdateExternalDatabaseConnectionRequest, UpdateExternalDatabaseConnectionResponse, DeleteExternalDatabaseConnectionRequest, DeleteExternalDatabaseConnectionResponse, GetExternalDatabaseConnectionResponseNonNullableFields, ListExternalDatabaseConnectionsResponseNonNullableFields, CreateExternalDatabaseConnectionResponseNonNullableFields, UpdateExternalDatabaseConnectionResponseNonNullableFields, ListExternalDatabaseConnectionsOptions, UpdateExternalDatabaseConnection, } from './data-v1-external-database-connection.universal';
+export { CauseOfFailure, CollectionsFound, FieldType, ProtocolVersion, ConnectionType, } from './data-v1-external-database-connection.universal';
+export { ExternalDatabaseConnection, ConnectionStatus, Capabilities, GetExternalDatabaseConnectionRequest, GetExternalDatabaseConnectionResponse, ListExternalDatabaseConnectionsRequest, Paging, ListExternalDatabaseConnectionsResponse, PagingMetadata, CreateExternalDatabaseConnectionRequest, CreateExternalDatabaseConnectionResponse, UpdateExternalDatabaseConnectionRequest, UpdateExternalDatabaseConnectionResponse, DeleteExternalDatabaseConnectionRequest, DeleteExternalDatabaseConnectionResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, GetExternalDatabaseConnectionResponseNonNullableFields, ListExternalDatabaseConnectionsResponseNonNullableFields, CreateExternalDatabaseConnectionResponseNonNullableFields, UpdateExternalDatabaseConnectionResponseNonNullableFields, ListExternalDatabaseConnectionsOptions, CreateExternalDatabaseConnectionOptions, UpdateExternalDatabaseConnection, } from './data-v1-external-database-connection.universal';

package/build/cjs/src/data-v1-external-database-connection.public.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProtocolVersion = exports.FieldType = exports.CollectionsFound = exports.CauseOfFailure = exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.__metadata = void 0;
+exports.ConnectionType = exports.ProtocolVersion = exports.FieldType = exports.CollectionsFound = exports.CauseOfFailure = exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.__metadata = void 0;
 const data_v1_external_database_connection_universal_1 = require("./data-v1-external-database-connection.universal");
 exports.__metadata = { PACKAGE_NAME: '@wix/data' };
 function getExternalDatabaseConnection(httpClient) {
@@ -16,7 +16,7 @@ function listExternalDatabaseConnections(httpClient) {
 }
 exports.listExternalDatabaseConnections = listExternalDatabaseConnections;
 function createExternalDatabaseConnection(httpClient) {
-    return (externalDatabaseConnection) => (0, data_v1_external_database_connection_universal_1.createExternalDatabaseConnection)(externalDatabaseConnection, 
+    return (externalDatabaseConnection, options) => (0, data_v1_external_database_connection_universal_1.createExternalDatabaseConnection)(externalDatabaseConnection, options, 
     // @ts-ignore
     { httpClient });
 }
@@ -38,4 +38,5 @@ Object.defineProperty(exports, "CauseOfFailure", { enumerable: true, get: functi
 Object.defineProperty(exports, "CollectionsFound", { enumerable: true, get: function () { return data_v1_external_database_connection_universal_2.CollectionsFound; } });
 Object.defineProperty(exports, "FieldType", { enumerable: true, get: function () { return data_v1_external_database_connection_universal_2.FieldType; } });
 Object.defineProperty(exports, "ProtocolVersion", { enumerable: true, get: function () { return data_v1_external_database_connection_universal_2.ProtocolVersion; } });
+Object.defineProperty(exports, "ConnectionType", { enumerable: true, get: function () { return data_v1_external_database_connection_universal_2.ConnectionType; } });
 //# sourceMappingURL=data-v1-external-database-connection.public.js.map

package/build/cjs/src/data-v1-external-database-connection.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-v1-external-database-connection.public.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.public.ts"],"names":[],"mappings":";;;AACA,qHAS0D;AAE7C,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,8EAAsC,EACpC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sEAOC;AAED,SAAgB,+BAA+B,CAAC,UAAsB;IACpE,OAAO,CAAC,OAAgD,EAAE,EAAE,CAC1D,IAAA,gFAAwC,EACtC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,0EAOC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,0BAAsD,EAAE,EAAE,CAChE,IAAA,iFAAyC,EACvC,0BAA0B;IAC1B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4EAOC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CACL,IAAY,EACZ,0BAA4D,EAC5D,EAAE,CACF,IAAA,iFAAyC,EACvC,IAAI,EACJ,0BAA0B;IAC1B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAXD,4EAWC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,iFAAyC,EACvC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4EAOC;AAED,mHAK0D;AAJxD,gJAAA,cAAc,OAAA;AACd,kJAAA,gBAAgB,OAAA;AAChB,2IAAA,SAAS,OAAA;AACT,iJAAA,eAAe,OAAA"}
+{"version":3,"file":"data-v1-external-database-connection.public.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.public.ts"],"names":[],"mappings":";;;AACA,qHAU0D;AAE7C,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,8EAAsC,EACpC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sEAOC;AAED,SAAgB,+BAA+B,CAAC,UAAsB;IACpE,OAAO,CAAC,OAAgD,EAAE,EAAE,CAC1D,IAAA,gFAAwC,EACtC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,0EAOC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CACL,0BAAsD,EACtD,OAAiD,EACjD,EAAE,CACF,IAAA,iFAAyC,EACvC,0BAA0B,EAC1B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAXD,4EAWC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CACL,IAAY,EACZ,0BAA4D,EAC5D,EAAE,CACF,IAAA,iFAAyC,EACvC,IAAI,EACJ,0BAA0B;IAC1B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAXD,4EAWC;AAED,SAAgB,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CAAC,IAAY,EAAE,EAAE,CACtB,IAAA,iFAAyC,EACvC,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4EAOC;AAED,mHAM0D;AALxD,gJAAA,cAAc,OAAA;AACd,kJAAA,gBAAgB,OAAA;AAChB,2IAAA,SAAS,OAAA;AACT,iJAAA,eAAe,OAAA;AACf,gJAAA,cAAc,OAAA"}

package/build/cjs/src/data-v1-external-database-connection.types.d.ts

@@ -19,23 +19,11 @@ export interface ExternalDatabaseConnection {
      * @readonly
      */
     connectionStatus?: ConnectionStatus;
-    /** The protocol version of the external database connection. */
-    protocolVersion?: ProtocolVersion;
-    /**
-     * The public key used to validate requests to the external database. Applicable only when the protocol version is `V3`.
-     * @readonly
-     */
-    publicKey?: string | null;
     /**
      * The external database's capabilities.
      * @readonly
      */
     capabilities?: Capabilities;
-    /**
-     * The application ID of the external database. Applicable only when the protocol version is `V3`.
-     * @readonly
-     */
-    applicationId?: string | null;
 }
 export declare enum CauseOfFailure {
     /** No connection failure. */
@@ -45,7 +33,9 @@ export declare enum CauseOfFailure {
     /** External database host is unreachable. */
     DESTINATION_HOST_UNREACHABLE = "DESTINATION_HOST_UNREACHABLE",
     /** Unauthorized to access external database. */
-    UNAUTHORIZED = "UNAUTHORIZED"
+    UNAUTHORIZED = "UNAUTHORIZED",
+    /** `Endpoint` property is not set. */
+    DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
 }
 export declare enum CollectionsFound {
     UNKNOWN = "UNKNOWN",
@@ -97,11 +87,12 @@ export interface ConnectionStatus {
     /** Whether the connection was established successfully. */
     successful?: boolean;
     /**
-     * Reason for the failure, if a connection isn't established successfully.
+     * If and why a connection attempt failed.
      * + `NONE`: No connection failure.
      * + `COMMUNICATION_FAILURE`: General communication failure.
      * + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
      * + `UNAUTHORIZED`: Unauthorized to access external database.
+     * + `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.
      */
     causeOfFailure?: CauseOfFailure;
     /**
@@ -165,6 +156,23 @@ export interface PagingMetadata {
 export interface CreateExternalDatabaseConnectionRequest {
     /** External database connection details. */
     externalDatabaseConnection: ExternalDatabaseConnection;
+    /** Connection type. */
+    connectionType?: ConnectionType;
+}
+export declare enum ConnectionType {
+    /** Unknown connection type. */
+    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
+    /**
+     * Connection to database adapter that implements legacy External Database Collections SPI (protocol version 1 or 2)
+     * https://www.wix.com/velo/reference/spis/external-database-collections/introduction
+     */
+    STANDALONE = "STANDALONE",
+    /**
+     * Connection to database adapter that implements External Database SPI (protocol version 3)
+     * https://dev.wix.com/docs/rest/internal-only/wix-data/external-database-spi/introduction
+     * https://dev.wix.com/docs/rest/articles/getting-started/service-provider-interface
+     */
+    WIX_SPI = "WIX_SPI"
 }
 export interface CreateExternalDatabaseConnectionResponse {
     /** Details of external database connection created. */
@@ -184,6 +192,73 @@ export interface DeleteExternalDatabaseConnectionRequest {
 }
 export interface DeleteExternalDatabaseConnectionResponse {
 }
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
 export interface GetExternalDatabaseConnectionResponseNonNullableFields {
     externalDatabaseConnection?: {
         name: string;

package/build/cjs/src/data-v1-external-database-connection.types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProtocolVersion = exports.FieldType = exports.CollectionsFound = exports.CauseOfFailure = void 0;
+exports.ConnectionType = exports.ProtocolVersion = exports.FieldType = exports.CollectionsFound = exports.CauseOfFailure = void 0;
 var CauseOfFailure;
 (function (CauseOfFailure) {
     /** No connection failure. */
@@ -11,6 +11,8 @@ var CauseOfFailure;
     CauseOfFailure["DESTINATION_HOST_UNREACHABLE"] = "DESTINATION_HOST_UNREACHABLE";
     /** Unauthorized to access external database. */
     CauseOfFailure["UNAUTHORIZED"] = "UNAUTHORIZED";
+    /** `Endpoint` property is not set. */
+    CauseOfFailure["DESTINATION_ENDPOINT_NOT_DEFINED"] = "DESTINATION_ENDPOINT_NOT_DEFINED";
 })(CauseOfFailure || (exports.CauseOfFailure = CauseOfFailure = {}));
 var CollectionsFound;
 (function (CollectionsFound) {
@@ -67,4 +69,20 @@ var ProtocolVersion;
     ProtocolVersion["V2"] = "V2";
     ProtocolVersion["V3"] = "V3";
 })(ProtocolVersion || (exports.ProtocolVersion = ProtocolVersion = {}));
+var ConnectionType;
+(function (ConnectionType) {
+    /** Unknown connection type. */
+    ConnectionType["UNKNOWN_CONNECTION_TYPE"] = "UNKNOWN_CONNECTION_TYPE";
+    /**
+     * Connection to database adapter that implements legacy External Database Collections SPI (protocol version 1 or 2)
+     * https://www.wix.com/velo/reference/spis/external-database-collections/introduction
+     */
+    ConnectionType["STANDALONE"] = "STANDALONE";
+    /**
+     * Connection to database adapter that implements External Database SPI (protocol version 3)
+     * https://dev.wix.com/docs/rest/internal-only/wix-data/external-database-spi/introduction
+     * https://dev.wix.com/docs/rest/articles/getting-started/service-provider-interface
+     */
+    ConnectionType["WIX_SPI"] = "WIX_SPI";
+})(ConnectionType || (exports.ConnectionType = ConnectionType = {}));
 //# sourceMappingURL=data-v1-external-database-connection.types.js.map

package/build/cjs/src/data-v1-external-database-connection.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-v1-external-database-connection.types.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.types.ts"],"names":[],"mappings":";;;AAwCA,IAAY,cASX;AATD,WAAY,cAAc;IACxB,6BAA6B;IAC7B,+BAAa,CAAA;IACb,qCAAqC;IACrC,iEAA+C,CAAA;IAC/C,6CAA6C;IAC7C,+EAA6D,CAAA;IAC7D,gDAAgD;IAChD,+CAA6B,CAAA;AAC/B,CAAC,EATW,cAAc,8BAAd,cAAc,QASzB;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,+BAAW,CAAA;IACX,6BAAS,CAAA;AACX,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAED,IAAY,SAwCX;AAxCD,WAAY,SAAS;IACnB,sDAAyC,CAAA;IACzC,0BAAa,CAAA;IACb,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,wBAAW,CAAA;IACX,oCAAuB,CAAA;IACvB,4BAAe,CAAA;IACf,wBAAW,CAAA;IACX,0CAA6B,CAAA;IAC7B,8CAAiC,CAAA;IACjC,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,0CAA6B,CAAA;IAC7B,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gDAAmC,CAAA;IACnC,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,wFAAwF;IACxF,wCAA2B,CAAA;IAC3B,wFAAwF;IACxF,wCAA2B,CAAA;IAC3B,wFAAwF;IACxF,wDAA2C,CAAA;IAC3C,wFAAwF;IACxF,gEAAmD,CAAA;IACnD,wFAAwF;IACxF,0CAA6B,CAAA;IAC7B,wFAAwF;IACxF,0CAA6B,CAAA;IAC7B,wFAAwF;IACxF,4DAA+C,CAAA;AACjD,CAAC,EAxCW,SAAS,yBAAT,SAAS,QAwCpB;AAuBD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;AACX,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B"}
+{"version":3,"file":"data-v1-external-database-connection.types.js","sourceRoot":"","sources":["../../../src/data-v1-external-database-connection.types.ts"],"names":[],"mappings":";;;AA4BA,IAAY,cAWX;AAXD,WAAY,cAAc;IACxB,6BAA6B;IAC7B,+BAAa,CAAA;IACb,qCAAqC;IACrC,iEAA+C,CAAA;IAC/C,6CAA6C;IAC7C,+EAA6D,CAAA;IAC7D,gDAAgD;IAChD,+CAA6B,CAAA;IAC7B,sCAAsC;IACtC,uFAAqE,CAAA;AACvE,CAAC,EAXW,cAAc,8BAAd,cAAc,QAWzB;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,+BAAW,CAAA;IACX,6BAAS,CAAA;AACX,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAED,IAAY,SAwCX;AAxCD,WAAY,SAAS;IACnB,sDAAyC,CAAA;IACzC,0BAAa,CAAA;IACb,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,wBAAW,CAAA;IACX,oCAAuB,CAAA;IACvB,4BAAe,CAAA;IACf,wBAAW,CAAA;IACX,0CAA6B,CAAA;IAC7B,8CAAiC,CAAA;IACjC,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,0CAA6B,CAAA;IAC7B,4CAA+B,CAAA;IAC/B,gCAAmB,CAAA;IACnB,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,gDAAmC,CAAA;IACnC,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,wFAAwF;IACxF,wCAA2B,CAAA;IAC3B,wFAAwF;IACxF,wCAA2B,CAAA;IAC3B,wFAAwF;IACxF,wDAA2C,CAAA;IAC3C,wFAAwF;IACxF,gEAAmD,CAAA;IACnD,wFAAwF;IACxF,0CAA6B,CAAA;IAC7B,wFAAwF;IACxF,0CAA6B,CAAA;IAC7B,wFAAwF;IACxF,4DAA+C,CAAA;AACjD,CAAC,EAxCW,SAAS,yBAAT,SAAS,QAwCpB;AAwBD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;AACX,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AA2DD,IAAY,cAcX;AAdD,WAAY,cAAc;IACxB,+BAA+B;IAC/B,qEAAmD,CAAA;IACnD;;;OAGG;IACH,2CAAyB,CAAA;IACzB;;;;OAIG;IACH,qCAAmB,CAAA;AACrB,CAAC,EAdW,cAAc,8BAAd,cAAc,QAczB"}

package/build/cjs/src/data-v1-external-database-connection.universal.d.ts

@@ -25,27 +25,11 @@ export interface ExternalDatabaseConnection {
      * @readonly
      */
     connectionStatus?: ConnectionStatus;
-    /**
-     * The protocol version of the external database connection.
-     *
-     * Supported values: `V1`, `V2`, `V3`.
-     */
-    protocolVersion?: ProtocolVersion;
-    /**
-     * The public key used to validate requests to the external database. Applicable only when the protocol version is `V3`.
-     * @readonly
-     */
-    publicKey?: string | null;
     /**
      * The external database's capabilities.
      * @readonly
      */
     capabilities?: Capabilities;
-    /**
-     * The application ID of the external database. Applicable only when the protocol version is `V3`.
-     * @readonly
-     */
-    applicationId?: string | null;
 }
 export declare enum CauseOfFailure {
     /** No connection failure. */
@@ -55,7 +39,9 @@ export declare enum CauseOfFailure {
     /** External database host is unreachable. */
     DESTINATION_HOST_UNREACHABLE = "DESTINATION_HOST_UNREACHABLE",
     /** Unauthorized to access external database. */
-    UNAUTHORIZED = "UNAUTHORIZED"
+    UNAUTHORIZED = "UNAUTHORIZED",
+    /** `Endpoint` property is not set. */
+    DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
 }
 export declare enum CollectionsFound {
     UNKNOWN = "UNKNOWN",
@@ -107,11 +93,12 @@ export interface ConnectionStatus {
     /** Whether the connection was established successfully. */
     successful?: boolean;
     /**
-     * Reason for the failure, if a connection isn't established successfully.
+     * If and why a connection attempt failed.
      * + `NONE`: No connection failure.
      * + `COMMUNICATION_FAILURE`: General communication failure.
      * + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
      * + `UNAUTHORIZED`: Unauthorized to access external database.
+     * + `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.
      */
     causeOfFailure?: CauseOfFailure;
     /**
@@ -175,6 +162,23 @@ export interface PagingMetadata {
 export interface CreateExternalDatabaseConnectionRequest {
     /** External database connection details. */
     externalDatabaseConnection: ExternalDatabaseConnection;
+    /** Connection type. */
+    connectionType?: ConnectionType;
+}
+export declare enum ConnectionType {
+    /** Unknown connection type. */
+    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
+    /**
+     * Connection to database adapter that implements legacy External Database Collections SPI (protocol version 1 or 2)
+     * https://www.wix.com/velo/reference/spis/external-database-collections/introduction
+     */
+    STANDALONE = "STANDALONE",
+    /**
+     * Connection to database adapter that implements External Database SPI (protocol version 3)
+     * https://dev.wix.com/docs/rest/internal-only/wix-data/external-database-spi/introduction
+     * https://dev.wix.com/docs/rest/articles/getting-started/service-provider-interface
+     */
+    WIX_SPI = "WIX_SPI"
 }
 export interface CreateExternalDatabaseConnectionResponse {
     /** Details of external database connection created. */
@@ -194,6 +198,73 @@ export interface DeleteExternalDatabaseConnectionRequest {
 }
 export interface DeleteExternalDatabaseConnectionResponse {
 }
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
 export interface GetExternalDatabaseConnectionResponseNonNullableFields {
     externalDatabaseConnection?: {
         name: string;
@@ -202,7 +273,6 @@ export interface GetExternalDatabaseConnectionResponseNonNullableFields {
             causeOfFailure: CauseOfFailure;
             hasCollections: CollectionsFound;
         };
-        protocolVersion: ProtocolVersion;
         capabilities?: {
             collectionModificationsSupported: boolean;
             fieldTypes: FieldType[];
@@ -217,7 +287,6 @@ export interface ListExternalDatabaseConnectionsResponseNonNullableFields {
             causeOfFailure: CauseOfFailure;
             hasCollections: CollectionsFound;
         };
-        protocolVersion: ProtocolVersion;
         capabilities?: {
             collectionModificationsSupported: boolean;
             fieldTypes: FieldType[];
@@ -232,7 +301,6 @@ export interface CreateExternalDatabaseConnectionResponseNonNullableFields {
             causeOfFailure: CauseOfFailure;
             hasCollections: CollectionsFound;
         };
-        protocolVersion: ProtocolVersion;
         capabilities?: {
             collectionModificationsSupported: boolean;
             fieldTypes: FieldType[];
@@ -247,7 +315,6 @@ export interface UpdateExternalDatabaseConnectionResponseNonNullableFields {
             causeOfFailure: CauseOfFailure;
             hasCollections: CollectionsFound;
         };
-        protocolVersion: ProtocolVersion;
         capabilities?: {
             collectionModificationsSupported: boolean;
             fieldTypes: FieldType[];
@@ -292,7 +359,11 @@ export interface ListExternalDatabaseConnectionsOptions {
  * @applicableIdentity APP
  * @returns Details of external database connection created.
  */
-export declare function createExternalDatabaseConnection(externalDatabaseConnection: ExternalDatabaseConnection): Promise<ExternalDatabaseConnection & NonNullable<CreateExternalDatabaseConnectionResponseNonNullableFields>['externalDatabaseConnection']>;
+export declare function createExternalDatabaseConnection(externalDatabaseConnection: ExternalDatabaseConnection, options?: CreateExternalDatabaseConnectionOptions): Promise<ExternalDatabaseConnection & NonNullable<CreateExternalDatabaseConnectionResponseNonNullableFields>['externalDatabaseConnection']>;
+export interface CreateExternalDatabaseConnectionOptions {
+    /** Connection type. */
+    connectionType?: ConnectionType;
+}
 /**
  * Updates an external database connection.
  *
@@ -329,27 +400,11 @@ export interface UpdateExternalDatabaseConnection {
      * @readonly
      */
     connectionStatus?: ConnectionStatus;
-    /**
-     * The protocol version of the external database connection.
-     *
-     * Supported values: `V1`, `V2`, `V3`.
-     */
-    protocolVersion?: ProtocolVersion;
-    /**
-     * The public key used to validate requests to the external database. Applicable only when the protocol version is `V3`.
-     * @readonly
-     */
-    publicKey?: string | null;
     /**
      * The external database's capabilities.
      * @readonly
      */
     capabilities?: Capabilities;
-    /**
-     * The application ID of the external database. Applicable only when the protocol version is `V3`.
-     * @readonly
-     */
-    applicationId?: string | null;
 }
 /**
  * Deletes an external database connection.

package/build/cjs/src/data-v1-external-database-connection.universal.js

@@ -32,8 +32,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.ProtocolVersion = exports.FieldType = exports.CollectionsFound = exports.CauseOfFailure = exports.__debug = void 0;
+exports.deleteExternalDatabaseConnection = exports.updateExternalDatabaseConnection = exports.createExternalDatabaseConnection = exports.listExternalDatabaseConnections = exports.getExternalDatabaseConnection = exports.ConnectionType = exports.ProtocolVersion = exports.FieldType = exports.CollectionsFound = exports.CauseOfFailure = exports.__debug = void 0;
 const velo_1 = require("@wix/metro-runtime/velo");
+const transform_error_1 = require("@wix/sdk-runtime/transform-error");
 const ambassadorWixDataV1ExternalDatabaseConnection = __importStar(require("./data-v1-external-database-connection.http"));
 let __verbose = false;
 function __log(...args) {
@@ -60,6 +61,8 @@ var CauseOfFailure;
     CauseOfFailure["DESTINATION_HOST_UNREACHABLE"] = "DESTINATION_HOST_UNREACHABLE";
     /** Unauthorized to access external database. */
     CauseOfFailure["UNAUTHORIZED"] = "UNAUTHORIZED";
+    /** `Endpoint` property is not set. */
+    CauseOfFailure["DESTINATION_ENDPOINT_NOT_DEFINED"] = "DESTINATION_ENDPOINT_NOT_DEFINED";
 })(CauseOfFailure || (exports.CauseOfFailure = CauseOfFailure = {}));
 var CollectionsFound;
 (function (CollectionsFound) {
@@ -116,6 +119,22 @@ var ProtocolVersion;
     ProtocolVersion["V2"] = "V2";
     ProtocolVersion["V3"] = "V3";
 })(ProtocolVersion || (exports.ProtocolVersion = ProtocolVersion = {}));
+var ConnectionType;
+(function (ConnectionType) {
+    /** Unknown connection type. */
+    ConnectionType["UNKNOWN_CONNECTION_TYPE"] = "UNKNOWN_CONNECTION_TYPE";
+    /**
+     * Connection to database adapter that implements legacy External Database Collections SPI (protocol version 1 or 2)
+     * https://www.wix.com/velo/reference/spis/external-database-collections/introduction
+     */
+    ConnectionType["STANDALONE"] = "STANDALONE";
+    /**
+     * Connection to database adapter that implements External Database SPI (protocol version 3)
+     * https://dev.wix.com/docs/rest/internal-only/wix-data/external-database-spi/introduction
+     * https://dev.wix.com/docs/rest/articles/getting-started/service-provider-interface
+     */
+    ConnectionType["WIX_SPI"] = "WIX_SPI";
+})(ConnectionType || (exports.ConnectionType = ConnectionType = {}));
 const _createExternalDatabaseConnectionRequest = {};
 const _createExternalDatabaseConnectionResponse = {};
 const _deleteExternalDatabaseConnectionRequest = {};
@@ -171,9 +190,11 @@ function getExternalDatabaseConnection(name) {
             return fromJSON(result.data);
         }
         catch (err) {
-            const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
-                'name',
-            ]);
+            const transformedError = (0, transform_error_1.transformError)(err, {
+                spreadPathsToArguments: {},
+                explicitPathsToArguments: { name: '$[0]' },
+                singleArgumentUnchanged: false,
+            }, ['name']);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
             throw transformedError;
         }
@@ -222,9 +243,11 @@ function listExternalDatabaseConnections(options) {
             return fromJSON(result.data);
         }
         catch (err) {
-            const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
-                'options',
-            ]);
+            const transformedError = (0, transform_error_1.transformError)(err, {
+                spreadPathsToArguments: {},
+                explicitPathsToArguments: { paging: '$[0].paging' },
+                singleArgumentUnchanged: false,
+            }, ['options']);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
             throw transformedError;
         }
@@ -246,13 +269,16 @@ exports.listExternalDatabaseConnections = listExternalDatabaseConnections;
  * @applicableIdentity APP
  * @returns Details of external database connection created.
  */
-function createExternalDatabaseConnection(externalDatabaseConnection) {
+function createExternalDatabaseConnection(externalDatabaseConnection, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = { externalDatabaseConnection: '$[0]' };
+        const requestTransformation = {
+            externalDatabaseConnection: '$[0]',
+            connectionType: '$[1].connectionType',
+        };
         const responseTransformation = '$.externalDatabaseConnection';
         // @ts-ignore
-        const { httpClient, sideEffects } = arguments[1];
+        const { httpClient, sideEffects } = arguments[2];
         const { toAmbassadorRequest } = (0, velo_1.serializer)({
             rootSchema: _createExternalDatabaseConnectionRequest,
             depSchemas: {},
@@ -271,7 +297,7 @@ function createExternalDatabaseConnection(externalDatabaseConnection) {
             },
             customTransformation: responseTransformation,
         });
-        const payload = toAmbassadorRequest([externalDatabaseConnection]);
+        const payload = toAmbassadorRequest([externalDatabaseConnection, options]);
         const reqOpts = ambassadorWixDataV1ExternalDatabaseConnection.createExternalDatabaseConnection(payload);
         __log(`"CreateExternalDatabaseConnection" sending request with: ${__inspect(reqOpts)}`);
         (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
@@ -281,9 +307,14 @@ function createExternalDatabaseConnection(externalDatabaseConnection) {
             return fromJSON(result.data);
         }
         catch (err) {
-            const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
-                'externalDatabaseConnection',
-            ]);
+            const transformedError = (0, transform_error_1.transformError)(err, {
+                spreadPathsToArguments: {},
+                explicitPathsToArguments: {
+                    externalDatabaseConnection: '$[0]',
+                    connectionType: '$[1].connectionType',
+                },
+                singleArgumentUnchanged: false,
+            }, ['externalDatabaseConnection', 'options']);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
             throw transformedError;
         }
@@ -348,10 +379,11 @@ function updateExternalDatabaseConnection(name, externalDatabaseConnection) {
             return fromJSON(result.data);
         }
         catch (err) {
-            const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
-                'name',
-                'externalDatabaseConnection',
-            ]);
+            const transformedError = (0, transform_error_1.transformError)(err, {
+                spreadPathsToArguments: { externalDatabaseConnection: '$[1]' },
+                explicitPathsToArguments: { 'externalDatabaseConnection.name': '$[0]' },
+                singleArgumentUnchanged: false,
+            }, ['name', 'externalDatabaseConnection']);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
             throw transformedError;
         }
@@ -403,9 +435,11 @@ function deleteExternalDatabaseConnection(name) {
             (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
         }
         catch (err) {
-            const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
-                'name',
-            ]);
+            const transformedError = (0, transform_error_1.transformError)(err, {
+                spreadPathsToArguments: {},
+                explicitPathsToArguments: { name: '$[0]' },
+                singleArgumentUnchanged: false,
+            }, ['name']);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
             throw transformedError;
         }