@wix/echo 1.0.25 → 1.0.26

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yEAA2D;AAGzD,wCAAc"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yEAA2D;AAEzD,wCAAc"}

package/build/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,cAAc,MAAM,0BAA0B,CAAC;AAE3D,OAAO,EACL,cAAc,GACf,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,cAAc,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EACL,cAAc,GACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/echo",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,10 +18,9 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/echo_metroinspector": "1.0.3"
+    "@wix/echo_metroinspector": "1.0.4"
   },
   "devDependencies": {
-    "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
     "glob": "^10.4.1",
     "rollup": "^4.18.0",
     "rollup-plugin-dts": "^6.1.1",
@@ -29,7 +28,7 @@
   },
   "scripts": {
     "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
-    "build:dts-bundles": "test -f config/rollup-config.js && rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
+    "build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
     "test": ":"
   },
   "wix": {
@@ -43,5 +42,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "6331b969018459c7428b34f3a8da5af7f0f6f3e8aac44311090ff975"
+  "falconPackageHash": "c58b318780c8e3d1fab917c1afd609277847d6d391913c8667ce4a08"
 }

package/type-bundles/context.bundle.d.ts

@@ -1,6 +1,8 @@
 type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -26,17 +28,127 @@ type EventDefinition<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
     type: Type;
     isDomainEvent?: boolean;
-    transformations?: unknown;
+    transformations?: (envelope: unknown) => Payload;
     __payload: Payload;
 };
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
 type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
 type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
 
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+interface MessageItem {
+    /** inner_message comment from EchoMessage proto def */
+    innerMessage?: string;
+}
+interface EchoRequest {
+    /** 1st part of the message */
+    arg1: string;
+    /** 2nd part of the message */
+    arg2?: string;
+    /** this field test translatable annotation */
+    titleField?: string;
+    someInt32?: number;
+    someDate?: Date;
+}
+interface EchoResponse {
+    /**
+     * override EchoResponse.echoMessage
+     *
+     */
+    echoMessage?: EchoMessage;
+    /** messge reseult as string */
+    message?: string;
+}
 interface Dispatched {
     /** the message someone says */
     echo?: EchoMessage;
 }
+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 in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    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 */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date;
+}
+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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
 interface IdentificationData extends IdentificationDataIdOneOf {
     /** ID of a site visitor that has not logged in to the site. */
     anonymousVisitorId?: string;
@@ -67,6 +179,18 @@ declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface MessageItemNonNullableFields {
+    innerMessage: string;
+}
+interface EchoMessageNonNullableFields {
+    message: string;
+    messagesList: MessageItemNonNullableFields[];
+    _id: string;
+}
+interface EchoResponseNonNullableFields {
+    echoMessage?: EchoMessageNonNullableFields;
+    message: string;
+}
 interface EchoMessage {
     veloMessage: string;
     id: string;
@@ -98,7 +222,7 @@ interface EventMetadata extends BaseEventMetadata {
     slug?: string;
     /** ID of the entity associated with the event. */
     entityId?: string;
-    /** Event timestamp. */
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
     eventTime?: Date;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
@@ -130,34 +254,39 @@ interface EchoOptions {
     someDate?: Date;
 }
 
-/**
- * Another override description function 4
- * @param arg1 - 1st part of the message
- * @public
- * @documentationMaturity preview
- * @requiredField arg1
- * @param arg2 - modified comment for arg2 el hovav
- * @returns ## override return 4
- */
-declare function echo$1(httpClient: HttpClient): (arg1: string, options?: EchoOptions) => Promise<string>;
-declare const onEchoDispatched$1: EventDefinition<EchoDispatchedEnvelope, "wix.metroinspector.v1.echo_dispatched">;
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
-/**
- * Another thing for context
- * @param arg1 - 1st part of the message
- * @public
- * @documentationMaturity preview
- * @requiredField arg1
- * @param arg2 - modified comment for arg2 el hovav
- * @returns ## override return 4
- */
-declare const echo: BuildRESTFunction<typeof echo$1>;
-declare const onEchoDispatched: BuildEventDefinition<typeof onEchoDispatched$1>;
+declare const echo: ReturnType<typeof createRESTModule<typeof publicEcho>>;
+declare const onEchoDispatched: ReturnType<typeof createEventModule<typeof publicOnEchoDispatched>>;
 
+type context_ActionEvent = ActionEvent;
+type context_BaseEventMetadata = BaseEventMetadata;
+type context_Dispatched = Dispatched;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_EchoDispatchedEnvelope = EchoDispatchedEnvelope;
+type context_EchoMessage = EchoMessage;
+type context_EchoOptions = EchoOptions;
+type context_EchoRequest = EchoRequest;
+type context_EchoResponse = EchoResponse;
+type context_EchoResponseNonNullableFields = EchoResponseNonNullableFields;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_EventMetadata = EventMetadata;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_MessageEnvelope = MessageEnvelope;
+type context_MessageItem = MessageItem;
+type context_RestoreInfo = RestoreInfo;
+type context_WebhookIdentityType = WebhookIdentityType;
+declare const context_WebhookIdentityType: typeof WebhookIdentityType;
 declare const context_echo: typeof echo;
 declare const context_onEchoDispatched: typeof onEchoDispatched;
 declare namespace context {
-  export { context_echo as echo, context_onEchoDispatched as onEchoDispatched };
+  export { type context_ActionEvent as ActionEvent, type context_BaseEventMetadata as BaseEventMetadata, type context_Dispatched as Dispatched, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EchoDispatchedEnvelope as EchoDispatchedEnvelope, type context_EchoMessage as EchoMessage, type context_EchoOptions as EchoOptions, type context_EchoRequest as EchoRequest, type context_EchoResponse as EchoResponse, type context_EchoResponseNonNullableFields as EchoResponseNonNullableFields, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_MessageEnvelope as MessageEnvelope, type context_MessageItem as MessageItem, type context_RestoreInfo as RestoreInfo, context_WebhookIdentityType as WebhookIdentityType, context_echo as echo, context_onEchoDispatched as onEchoDispatched };
 }
 
 export { context as metroinspector };

package/type-bundles/index.bundle.d.ts

@@ -1,5 +1,8 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -20,14 +23,24 @@ type APIMetadata = {
     entityFqdn?: string;
     packageName?: string;
 };
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
 type EventDefinition<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
     type: Type;
     isDomainEvent?: boolean;
-    transformations?: unknown;
+    transformations?: (envelope: unknown) => Payload;
     __payload: Payload;
 };
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
 
 interface MessageItem {
     /** inner_message comment from EchoMessage proto def */
@@ -79,7 +92,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     slug?: string;
     /** ID of the entity associated with the event. */
     entityId?: string;
-    /** Event timestamp. */
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
     eventTime?: Date;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
@@ -108,6 +121,9 @@ interface DomainEventBodyOneOf {
 interface EntityCreatedEvent {
     entity?: string;
 }
+interface RestoreInfo {
+    deletedDate?: Date;
+}
 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.
@@ -163,14 +179,16 @@ declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface MessageItemNonNullableFields {
+    innerMessage: string;
+}
+interface EchoMessageNonNullableFields {
+    message: string;
+    messagesList: MessageItemNonNullableFields[];
+    _id: string;
+}
 interface EchoResponseNonNullableFields {
-    echoMessage?: {
-        message: string;
-        messagesList: {
-            innerMessage: string;
-        }[];
-        _id: string;
-    };
+    echoMessage?: EchoMessageNonNullableFields;
     message: string;
 }
 interface EchoMessage {
@@ -204,7 +222,7 @@ interface EventMetadata extends BaseEventMetadata {
     slug?: string;
     /** ID of the entity associated with the event. */
     entityId?: string;
-    /** Event timestamp. */
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
     eventTime?: Date;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
@@ -236,20 +254,12 @@ interface EchoOptions {
     someDate?: Date;
 }
 
-declare const __metadata: {
-    PACKAGE_NAME: string;
-};
-/**
- * Another override description function 4
- * @param arg1 - 1st part of the message
- * @public
- * @documentationMaturity preview
- * @requiredField arg1
- * @param arg2 - modified comment for arg2 el hovav
- * @returns ## override return 4
- */
-declare function echo(httpClient: HttpClient): (arg1: string, options?: EchoOptions) => Promise<string>;
-declare const onEchoDispatched: EventDefinition<EchoDispatchedEnvelope, "wix.metroinspector.v1.echo_dispatched">;
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const echo: ReturnType<typeof createRESTModule<typeof publicEcho>>;
+declare const onEchoDispatched: ReturnType<typeof createEventModule<typeof publicOnEchoDispatched>>;
 
 type index_d_ActionEvent = ActionEvent;
 type index_d_BaseEventMetadata = BaseEventMetadata;
@@ -270,13 +280,13 @@ type index_d_IdentificationData = IdentificationData;
 type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
 type index_d_MessageEnvelope = MessageEnvelope;
 type index_d_MessageItem = MessageItem;
+type index_d_RestoreInfo = RestoreInfo;
 type index_d_WebhookIdentityType = WebhookIdentityType;
 declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
-declare const index_d___metadata: typeof __metadata;
 declare const index_d_echo: typeof echo;
 declare const index_d_onEchoDispatched: typeof onEchoDispatched;
 declare namespace index_d {
-  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_Dispatched as Dispatched, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EchoDispatchedEnvelope as EchoDispatchedEnvelope, type index_d_EchoMessage as EchoMessage, type index_d_EchoOptions as EchoOptions, type index_d_EchoRequest as EchoRequest, type index_d_EchoResponse as EchoResponse, type index_d_EchoResponseNonNullableFields as EchoResponseNonNullableFields, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MessageItem as MessageItem, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_echo as echo, index_d_onEchoDispatched as onEchoDispatched };
+  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_Dispatched as Dispatched, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EchoDispatchedEnvelope as EchoDispatchedEnvelope, type index_d_EchoMessage as EchoMessage, type index_d_EchoOptions as EchoOptions, type index_d_EchoRequest as EchoRequest, type index_d_EchoResponse as EchoResponse, type index_d_EchoResponseNonNullableFields as EchoResponseNonNullableFields, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MessageItem as MessageItem, type index_d_RestoreInfo as RestoreInfo, index_d_WebhookIdentityType as WebhookIdentityType, index_d_echo as echo, index_d_onEchoDispatched as onEchoDispatched };
 }
 
 export { index_d as metroinspector };

package/type-bundles/meta.bundle.d.ts

@@ -25,14 +25,16 @@ interface EchoResponse$1 {
     /** messge reseult as string */
     message?: string;
 }
+interface MessageItemNonNullableFields$1 {
+    innerMessage: string;
+}
+interface EchoMessageNonNullableFields$1 {
+    message: string;
+    messagesList: MessageItemNonNullableFields$1[];
+    id: string;
+}
 interface EchoResponseNonNullableFields$1 {
-    echoMessage?: {
-        message: string;
-        messagesList: {
-            innerMessage: string;
-        }[];
-        id: string;
-    };
+    echoMessage?: EchoMessageNonNullableFields$1;
     message: string;
 }
 
@@ -55,14 +57,16 @@ interface EchoResponse {
     /** messge reseult as string */
     message?: string;
 }
+interface MessageItemNonNullableFields {
+    innerMessage: string;
+}
+interface EchoMessageNonNullableFields {
+    message: string;
+    messagesList: MessageItemNonNullableFields[];
+    _id: string;
+}
 interface EchoResponseNonNullableFields {
-    echoMessage?: {
-        message: string;
-        messagesList: {
-            innerMessage: string;
-        }[];
-        _id: string;
-    };
+    echoMessage?: EchoMessageNonNullableFields;
     message: string;
 }
 interface EchoMessage {