@wix/core-services-d 1.0.20 → 1.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/core-services-d",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/core-services-d_echo": "1.0.4"
+    "@wix/core-services-d_echo": "1.0.5"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -42,5 +42,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "937a96b054bbaaf1cb2178b64dd5d307acb0e3340f21492e82c3fc81"
+  "falconPackageHash": "b71ce77c74e373a7113addae4beda24f4837b06b494bab06d8853cba"
 }

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

@@ -0,0 +1,200 @@
+interface LongMessage {
+    int64Field?: string;
+    uint64Field?: string;
+    int64ValueField?: string | null;
+    uint64ValueField?: string | null;
+    sint64Field?: string;
+    sfixed64Field?: string;
+    fixed64Field?: string;
+    durationField?: GoogleProtoDuration;
+    _id?: string | null;
+}
+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;
+    /** 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 LongMessageNonNullableFields {
+    int64Field: string;
+    uint64Field: string;
+    sint64Field: string;
+    sfixed64Field: string;
+    fixed64Field: string;
+}
+type GoogleProtoDuration = any;
+interface PublicLongEchoOptions {
+    int64Field?: string;
+    uint64Field?: string;
+    int64ValueField?: string | null;
+    uint64ValueField?: string | null;
+    sint64Field?: string;
+    sfixed64Field?: string;
+    fixed64Field?: string;
+    durationField?: GoogleProtoDuration;
+    _id?: string | null;
+}
+
+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> = {
+    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;
+
+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;
+	}
+}
+
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare const publicLongEcho: ReturnType<typeof createRESTModule<typeof publicPublicLongEcho>>;
+
+type context_ActionEvent = ActionEvent;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_LongMessage = LongMessage;
+type context_LongMessageNonNullableFields = LongMessageNonNullableFields;
+type context_MessageEnvelope = MessageEnvelope;
+type context_PublicLongEchoOptions = PublicLongEchoOptions;
+type context_RestoreInfo = RestoreInfo;
+type context_WebhookIdentityType = WebhookIdentityType;
+declare const context_WebhookIdentityType: typeof WebhookIdentityType;
+declare const context_publicLongEcho: typeof publicLongEcho;
+declare namespace context {
+  export { type context_ActionEvent as ActionEvent, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_LongMessage as LongMessage, type context_LongMessageNonNullableFields as LongMessageNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_PublicLongEchoOptions as PublicLongEchoOptions, type context_RestoreInfo as RestoreInfo, context_WebhookIdentityType as WebhookIdentityType, context_publicLongEcho as publicLongEcho };
+}
+
+export { context as echo };

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

@@ -0,0 +1,200 @@
+interface LongMessage {
+    int64Field?: string;
+    uint64Field?: string;
+    int64ValueField?: string | null;
+    uint64ValueField?: string | null;
+    sint64Field?: string;
+    sfixed64Field?: string;
+    fixed64Field?: string;
+    durationField?: GoogleProtoDuration;
+    _id?: string | null;
+}
+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;
+    /** 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 LongMessageNonNullableFields {
+    int64Field: string;
+    uint64Field: string;
+    sint64Field: string;
+    sfixed64Field: string;
+    fixed64Field: string;
+}
+type GoogleProtoDuration = any;
+interface PublicLongEchoOptions {
+    int64Field?: string;
+    uint64Field?: string;
+    int64ValueField?: string | null;
+    uint64ValueField?: string | null;
+    sint64Field?: string;
+    sfixed64Field?: string;
+    fixed64Field?: string;
+    durationField?: GoogleProtoDuration;
+    _id?: string | null;
+}
+
+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> = {
+    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;
+
+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;
+	}
+}
+
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare const publicLongEcho: ReturnType<typeof createRESTModule<typeof publicPublicLongEcho>>;
+
+type index_d_ActionEvent = ActionEvent;
+type index_d_DomainEvent = DomainEvent;
+type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type index_d_EntityCreatedEvent = EntityCreatedEvent;
+type index_d_EntityDeletedEvent = EntityDeletedEvent;
+type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
+type index_d_IdentificationData = IdentificationData;
+type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type index_d_LongMessage = LongMessage;
+type index_d_LongMessageNonNullableFields = LongMessageNonNullableFields;
+type index_d_MessageEnvelope = MessageEnvelope;
+type index_d_PublicLongEchoOptions = PublicLongEchoOptions;
+type index_d_RestoreInfo = RestoreInfo;
+type index_d_WebhookIdentityType = WebhookIdentityType;
+declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
+declare const index_d_publicLongEcho: typeof publicLongEcho;
+declare namespace index_d {
+  export { type index_d_ActionEvent as ActionEvent, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_LongMessage as LongMessage, type index_d_LongMessageNonNullableFields as LongMessageNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, type index_d_PublicLongEchoOptions as PublicLongEchoOptions, type index_d_RestoreInfo as RestoreInfo, index_d_WebhookIdentityType as WebhookIdentityType, index_d_publicLongEcho as publicLongEcho };
+}
+
+export { index_d as echo };

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

@@ -0,0 +1,63 @@
+declare type GoogleProtoDuration$1 = {
+    seconds?: string;
+    nanos?: number;
+};
+
+interface LongMessage$1 {
+    int64Field?: string;
+    uint64Field?: string;
+    int64ValueField?: string | null;
+    uint64ValueField?: string | null;
+    sint64Field?: string;
+    sfixed64Field?: string;
+    fixed64Field?: string;
+    durationField?: GoogleProtoDuration$1;
+    id?: string | null;
+}
+interface LongMessageNonNullableFields$1 {
+    int64Field: string;
+    uint64Field: string;
+    sint64Field: string;
+    sfixed64Field: string;
+    fixed64Field: string;
+}
+
+interface LongMessage {
+    int64Field?: string;
+    uint64Field?: string;
+    int64ValueField?: string | null;
+    uint64ValueField?: string | null;
+    sint64Field?: string;
+    sfixed64Field?: string;
+    fixed64Field?: string;
+    durationField?: GoogleProtoDuration;
+    _id?: string | null;
+}
+interface LongMessageNonNullableFields {
+    int64Field: string;
+    uint64Field: string;
+    sint64Field: string;
+    sfixed64Field: string;
+    fixed64Field: string;
+}
+type GoogleProtoDuration = any;
+
+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 publicLongEcho(): __PublicMethodMetaInfo<'GET', {}, LongMessage, LongMessage$1, LongMessage & LongMessageNonNullableFields, LongMessage$1 & LongMessageNonNullableFields$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_publicLongEcho: typeof publicLongEcho;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_publicLongEcho as publicLongEcho };
+}
+
+export { meta as echo };