@wix/echo 1.0.21 → 1.0.22

package/context/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/context.js",
   "main": "../build/cjs/context.js",
-  "typings": "../build/cjs/context.d.ts"
+  "typings": "../build/cjs/context.d.ts",
+  "typesBundle": "../type-bundles/context.bundle.d.ts"
 }

package/meta/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/meta.js",
   "main": "../build/cjs/meta.js",
-  "typings": "../build/cjs/meta.d.ts"
+  "typings": "../build/cjs/meta.d.ts",
+  "typesBundle": "../type-bundles/meta.bundle.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/echo",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -9,21 +9,27 @@
   "module": "build/es/index.js",
   "main": "build/cjs/index.js",
   "typings": "./build/cjs/index.d.ts",
+  "typesBundle": "./type-bundles/index.bundle.d.ts",
   "files": [
     "build",
     "frontend/package.json",
     "meta",
-    "context"
+    "context",
+    "type-bundles"
   ],
   "dependencies": {
-    "@wix/echo_metroinspector": "1.0.0"
+    "@wix/echo_metroinspector": "1.0.1"
   },
   "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",
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json",
+    "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!'",
     "test": ":"
   },
   "wix": {
@@ -37,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "b159539884ec35b131818b0fe917c1ea37faac9dad1bf198ba3ef1d6"
+  "falconPackageHash": "ccc441413df9b1201de1a9f2b38f388740def639a035170674d25d85"
 }

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

@@ -0,0 +1,145 @@
+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>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    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;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: 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;
+
+interface Dispatched {
+    /** the message someone says */
+    echo?: EchoMessage;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface EchoMessage {
+    veloMessage: string;
+    id: string;
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * 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;
+}
+interface EchoDispatchedEnvelope {
+    data: Dispatched;
+    metadata: EventMetadata;
+}
+interface EchoOptions {
+    /** 2nd part of the message */
+    arg2?: string;
+    /** this field test translatable annotation */
+    titleField?: string;
+    someInt32?: number;
+    someDate?: Date;
+}
+
+declare function echo$1(httpClient: HttpClient): (arg1: string, options?: EchoOptions) => Promise<string>;
+declare const onEchoDispatched$1: EventDefinition<EchoDispatchedEnvelope, "wix.metroinspector.v1.echo_dispatched">;
+
+declare const echo: BuildRESTFunction<typeof echo$1>;
+declare const onEchoDispatched: BuildEventDefinition<typeof onEchoDispatched$1>;
+
+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 { context as metroinspector };

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

@@ -0,0 +1,273 @@
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+
+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. */
+    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 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;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface EchoResponseNonNullableFields {
+    echoMessage?: {
+        message: string;
+        messagesList: {
+            innerMessage: string;
+        }[];
+        _id: string;
+    };
+    message: string;
+}
+interface EchoMessage {
+    veloMessage: string;
+    id: string;
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * 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;
+}
+interface EchoDispatchedEnvelope {
+    data: Dispatched;
+    metadata: EventMetadata;
+}
+interface EchoOptions {
+    /** 2nd part of the message */
+    arg2?: string;
+    /** this field test translatable annotation */
+    titleField?: string;
+    someInt32?: number;
+    someDate?: Date;
+}
+
+declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+declare function echo(httpClient: HttpClient): (arg1: string, options?: EchoOptions) => Promise<string>;
+declare const onEchoDispatched: EventDefinition<EchoDispatchedEnvelope, "wix.metroinspector.v1.echo_dispatched">;
+
+type index_d_ActionEvent = ActionEvent;
+type index_d_BaseEventMetadata = BaseEventMetadata;
+type index_d_Dispatched = Dispatched;
+type index_d_DomainEvent = DomainEvent;
+type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type index_d_EchoDispatchedEnvelope = EchoDispatchedEnvelope;
+type index_d_EchoMessage = EchoMessage;
+type index_d_EchoOptions = EchoOptions;
+type index_d_EchoRequest = EchoRequest;
+type index_d_EchoResponse = EchoResponse;
+type index_d_EchoResponseNonNullableFields = EchoResponseNonNullableFields;
+type index_d_EntityCreatedEvent = EntityCreatedEvent;
+type index_d_EntityDeletedEvent = EntityDeletedEvent;
+type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
+type index_d_EventMetadata = EventMetadata;
+type index_d_IdentificationData = IdentificationData;
+type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type index_d_MessageEnvelope = MessageEnvelope;
+type index_d_MessageItem = MessageItem;
+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 { index_d as metroinspector };

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

@@ -0,0 +1,93 @@
+interface EchoMessage$1 {
+    /** message comment from EchoMessage proto def, with special comment */
+    message?: string;
+    /** messages_list comment from EchoMessage proto def */
+    messagesList?: MessageItem[];
+    id?: string;
+}
+interface MessageItem {
+    /** inner_message comment from EchoMessage proto def */
+    innerMessage?: string;
+}
+interface EchoRequest$1 {
+    /** 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$1 {
+    /** message result as EchoMessage */
+    echoMessage?: EchoMessage$1;
+    /** messge reseult as string */
+    message?: string;
+}
+interface EchoResponseNonNullableFields$1 {
+    echoMessage?: {
+        message: string;
+        messagesList: {
+            innerMessage: string;
+        }[];
+        id: string;
+    };
+    message: 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 EchoResponseNonNullableFields {
+    echoMessage?: {
+        message: string;
+        messagesList: {
+            innerMessage: string;
+        }[];
+        _id: string;
+    };
+    message: string;
+}
+interface EchoMessage {
+    veloMessage: string;
+    id: string;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function echo(): __PublicMethodMetaInfo<'POST', {
+    arg1: string;
+}, EchoRequest, EchoRequest$1, EchoResponse & EchoResponseNonNullableFields, EchoResponse$1 & EchoResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_echo: typeof echo;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_echo as echo };
+}
+
+export { meta as metroinspector };