@wix/notifications 1.0.36 → 1.0.38

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

@@ -1,9 +1,9 @@
-type HostModule$1<T, H extends Host$1> = {
+type HostModule<T, H extends Host> = {
     __type: 'host';
     create(host: H): T;
 };
-type HostModuleAPI$1<T extends HostModule$1<any, any>> = T extends HostModule$1<infer U, any> ? U : never;
-type Host$1<Environment = unknown> = {
+type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
+type Host<Environment = unknown> = {
     channel: {
         observeState(callback: (props: unknown, environment: Environment) => unknown): {
             disconnect: () => void;
@@ -36,92 +36,92 @@ type Host$1<Environment = unknown> = {
     };
 };
 
-type RESTFunctionDescriptor$1<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$1) => T;
-interface HttpClient$1 {
-    request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
+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>;
     getActiveToken?: () => string | undefined;
 }
-type RequestOptionsFactory$1<TResponse = any, TData = any> = (context: any) => RequestOptions$1<TResponse, TData>;
-type HttpResponse$1<T = any> = {
+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$1<_TResponse = any, Data = any> = {
+type RequestOptions<_TResponse = any, Data = any> = {
     method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
     url: string;
     data?: Data;
     params?: URLSearchParams;
-} & APIMetadata$1;
-type APIMetadata$1 = {
+} & APIMetadata;
+type APIMetadata = {
     methodFqn?: string;
     entityFqdn?: string;
     packageName?: string;
 };
-type BuildRESTFunction$1<T extends RESTFunctionDescriptor$1> = T extends RESTFunctionDescriptor$1<infer U> ? U : never;
-type EventDefinition$1<Payload = unknown, Type extends string = 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?: (envelope: unknown) => Payload;
     __payload: Payload;
 };
-declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
-type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<T>) => void;
+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;
 
-type ServicePluginMethodInput$1 = {
+type ServicePluginMethodInput = {
     request: any;
     metadata: any;
 };
-type ServicePluginContract$1 = Record<string, (payload: ServicePluginMethodInput$1) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata$1 = {
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
     name: string;
     primaryHttpMappingPath: string;
     transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput$1;
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
         toREST: (...args: unknown[]) => unknown;
     };
 };
-type ServicePluginDefinition$1<Contract extends ServicePluginContract$1> = {
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
     __type: 'service-plugin-definition';
     componentType: string;
-    methods: ServicePluginMethodMetadata$1[];
+    methods: ServicePluginMethodMetadata[];
     __contract: Contract;
 };
-declare function ServicePluginDefinition$1<Contract extends ServicePluginContract$1>(componentType: string, methods: ServicePluginMethodMetadata$1[]): ServicePluginDefinition$1<Contract>;
-type BuildServicePluginDefinition$1<T extends ServicePluginDefinition$1<any>> = (implementation: T['__contract']) => void;
-declare const SERVICE_PLUGIN_ERROR_TYPE$1 = "wix_spi_error";
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
 
-type RequestContext$1 = {
+type RequestContext = {
     isSSR: boolean;
     host: string;
     protocol?: string;
 };
-type ResponseTransformer$1 = (data: any, headers?: any) => any;
+type ResponseTransformer = (data: any, headers?: any) => any;
 /**
  * Ambassador request options types are copied mostly from AxiosRequestConfig.
  * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
  * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
  */
-type Method$1 = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
-type AmbassadorRequestOptions$1<T = any> = {
+type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+type AmbassadorRequestOptions<T = any> = {
     _?: T;
     url?: string;
-    method?: Method$1;
+    method?: Method;
     params?: any;
     data?: any;
-    transformResponse?: ResponseTransformer$1 | ResponseTransformer$1[];
+    transformResponse?: ResponseTransformer | ResponseTransformer[];
 };
-type AmbassadorFactory$1<Request, Response> = (payload: Request) => ((context: RequestContext$1) => AmbassadorRequestOptions$1<Response>) & {
+type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
     __isAmbassador: boolean;
 };
-type AmbassadorFunctionDescriptor$1<Request = any, Response = any> = AmbassadorFactory$1<Request, Response>;
-type BuildAmbassadorFunction$1<T extends AmbassadorFunctionDescriptor$1> = T extends AmbassadorFunctionDescriptor$1<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
+type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
+type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -130,7 +130,7 @@ declare global {
 	}
 }
 
-declare const emptyObjectSymbol$1: unique symbol;
+declare const emptyObjectSymbol: unique symbol;
 
 /**
 Represents a strictly empty plain object, the `{}` value.
@@ -158,7 +158,7 @@ Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<n
 
 @category Object
 */
-type EmptyObject$1 = {[emptyObjectSymbol$1]?: never};
+type EmptyObject = {[emptyObjectSymbol]?: never};
 
 /**
 Returns a boolean for whether the two given types are equal.
@@ -186,7 +186,7 @@ type Includes<Value extends readonly any[], Item> =
 @category Type Guard
 @category Utilities
 */
-type IsEqual$1<A, B> =
+type IsEqual<A, B> =
 	(<G>() => G extends A ? 1 : 2) extends
 	(<G>() => G extends B ? 1 : 2)
 		? true
@@ -219,9 +219,9 @@ type Filtered = Filter<'bar', 'foo'>;
 
 @see {Except}
 */
-type Filter$1<KeyType, ExcludeType> = IsEqual$1<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
 
-type ExceptOptions$1 = {
+type ExceptOptions = {
 	/**
 	Disallow assigning non-specified properties.
 
@@ -265,8 +265,8 @@ const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
 
 @category Object
 */
-type Except$1<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions$1 = {requireExactProps: false}> = {
-	[KeyType in keyof ObjectType as Filter$1<KeyType, KeysType>]: ObjectType[KeyType];
+type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
 } & (Options['requireExactProps'] extends true
 	? Partial<Record<KeysType, never>>
 	: {});
@@ -303,7 +303,7 @@ type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
 
 @category Object
 */
-type ConditionalKeys$1<Base, Condition> = NonNullable<
+type ConditionalKeys<Base, Condition> = NonNullable<
 // Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
 {
 	// Map through all the keys of the given base type.
@@ -357,9 +357,9 @@ type NonStringKeysOnly = ConditionalExcept<Example, string>;
 
 @category Object
 */
-type ConditionalExcept$1<Base, Condition> = Except$1<
+type ConditionalExcept<Base, Condition> = Except<
 Base,
-ConditionalKeys$1<Base, Condition>
+ConditionalKeys<Base, Condition>
 >;
 
 /**
@@ -367,8 +367,8 @@ ConditionalKeys$1<Base, Condition>
  * can either be a REST module or a host module.
  * This type is recursive, so it can describe nested modules.
  */
-type Descriptors$1 = RESTFunctionDescriptor$1 | AmbassadorFunctionDescriptor$1 | HostModule$1<any, any> | EventDefinition$1<any> | ServicePluginDefinition$1<any> | {
-    [key: string]: Descriptors$1 | PublicMetadata$1 | any;
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
+    [key: string]: Descriptors | PublicMetadata | any;
 };
 /**
  * This type takes in a descriptors object of a certain Host (including an `unknown` host)
@@ -376,12 +376,12 @@ type Descriptors$1 = RESTFunctionDescriptor$1 | AmbassadorFunctionDescriptor$1 |
  * Any non-descriptor properties are removed from the returned object, including descriptors that
  * do not match the given host (as they will not work with the given host).
  */
-type BuildDescriptors$1<T extends Descriptors$1, H extends Host$1<any> | undefined, Depth extends number = 5> = {
+type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
     done: T;
     recurse: T extends {
-        __type: typeof SERVICE_PLUGIN_ERROR_TYPE$1;
-    } ? never : T extends AmbassadorFunctionDescriptor$1 ? BuildAmbassadorFunction$1<T> : T extends RESTFunctionDescriptor$1 ? BuildRESTFunction$1<T> : T extends EventDefinition$1<any> ? BuildEventDefinition$1<T> : T extends ServicePluginDefinition$1<any> ? BuildServicePluginDefinition$1<T> : T extends HostModule$1<any, any> ? HostModuleAPI$1<T> : ConditionalExcept$1<{
-        [Key in keyof T]: T[Key] extends Descriptors$1 ? BuildDescriptors$1<T[Key], H, [
+        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
             -1,
             0,
             1,
@@ -390,9 +390,9 @@ type BuildDescriptors$1<T extends Descriptors$1, H extends Host$1<any> | undefin
             4,
             5
         ][Depth]> : never;
-    }, EmptyObject$1>;
+    }, EmptyObject>;
 }[Depth extends -1 ? 'done' : 'recurse'];
-type PublicMetadata$1 = {
+type PublicMetadata = {
     PACKAGE_NAME?: string;
 };
 
@@ -404,47 +404,37 @@ declare global {
  * A type used to create concerete types from SDK descriptors in
  * case a contextual client is available.
  */
-type MaybeContext$1<T extends Descriptors$1> = globalThis.ContextualClient extends {
-    host: Host$1;
-} ? BuildDescriptors$1<T, globalThis.ContextualClient['host']> : T;
+type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
+    host: Host;
+} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
 
 interface Public_notification {
     /** Notification ID. */
     _id?: string | null;
 }
 interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
-    /** List of site contributors to notify. */
+    /** Send to [site contributors]((https://support.wix.com/en/article/roles-permissions-overview)). This includes site administrators, website managers, and back office managers. */
     toSiteContributors?: ToSiteContributors;
-    /** List of contacts to notify. */
+    /** Send to [site contacts](https://support.wix.com/en/article/about-your-contact-list). */
     toContacts?: ToContacts;
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
-    /**
-     * Notification title. Only displayed on mobile and browser notifications.
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification. Max: 512 characters. */
     title?: string | null;
     /**
-     * Contents of the notification.
-     *
+     * Body of the notification. This contains the main content of the notification.
      * Max: 512 characters
      */
     body?: string | null;
-    /**
-     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page. */
     action?: string | null;
     /**
-     * The channels to send the notification on. One or more of:
-     *
+     * Channel through which users receive the notification.
      * - `"Mobile"`: Sends the notification to the Wix App.
-     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
-     * - `"Browser"`: Sends the notification to the contributor's browser.
+     * - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the collaborator's browser.
      */
     channels?: Channel[];
 }
@@ -459,15 +449,14 @@ interface PublicNotifyRequestRecipientsFilterOneOf {
 interface PublicNotifyRequestActionTargetOneOf {
     /** URL to navigate to when the `action` text is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
 }
 interface ToSiteContributors {
     /**
-     * Roles to receive the notification. One of:
-     *
-     * - `"All_Contributors"`: All site contributors (default).
-     * - `"Owner"`: Only the site owner.
+     * Role assigned to site contributors. Only contributors with the specified roles receive the notification:
+     * - `"All_Contributors"`: All site collaborators (default).
+     * - `"Owner"`: Site owner only.
      */
     withRole?: Role;
 }
@@ -478,13 +467,13 @@ declare enum Role {
     Owner = "Owner"
 }
 interface ToContacts {
-    /** List of contact IDs. */
+    /** Contacts that receive the notification.  */
     contactIds?: string[];
 }
 interface ToTopicsSubscribers {
-    /** List of topics. */
+    /** Notification topics to which the recipients have subscribed. Only contacts who subscribed to the specified topics receive the notification. */
     topics?: string[];
-    /** List of contact IDs to exclude from notification. */
+    /** Excluded contact IDs. Contacts with these IDs don't receive the notification. */
     excludedContactIds?: string[];
 }
 declare enum Channel {
@@ -509,25 +498,21 @@ interface NotifyOptions$1 extends PublicNotifyRequestRecipientsFilterOneOf, Publ
     toSiteContributors?: ToSiteContributors;
     /** List of contacts to notify. */
     toContacts?: ToContacts;
-    /**
-     * Notification title. Only displayed on mobile and browser notifications.
-     *
-     * Max: 512 characters
-     */
+    /** Title of the notification. Max: 512 characters. */
     title?: string | null;
     /**
-     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
+     *  Title of the notification action. Clicking the action refers the user to a target URL or a dashboard page.
      *
-     * Max: 512 characters
+     * Max: 512 characters.
      */
     action?: string | null;
-    /** URL to navigate to when the `action` text is clicked. */
+    /** External URL to open when the notification action is clicked. */
     targetUrl?: string | null;
-    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    /** Dashboard page to open when the notification action is clicked. */
     targetDashboardPage?: DashboardPages;
 }
 
-declare function notify$3(httpClient: HttpClient$1): NotifySignature$1;
+declare function notify$3(httpClient: HttpClient): NotifySignature$1;
 interface NotifySignature$1 {
     /**
      * Sends a notification.
@@ -539,20 +524,17 @@ interface NotifySignature$1 {
      *
      * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
      * @param - Notification options.
-     * @param - The body of the notification.
-     *
-     * Max: 512 characters
-     * @param - The channels to send the notification on. One or more of:
-     *
+     * @param - Body of the notification. This contains the main content of the notification.
+     * @param - Channel through which users receive the notification.
      * - `"Mobile"`: Sends the notification to the Wix App.
-     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
-     * - `"Browser"`: Sends the notification to the contributor's browser.
+     * - `"Dashboard"`: Sends the notification to the collaborator's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the collaborator's browser.
      * @returns Fulfilled when the send notification request is received.
      */
     (body: string | null, channels: Channel[], options?: NotifyOptions$1 | undefined): Promise<void>;
 }
 
-declare const notify$2: MaybeContext$1<BuildRESTFunction$1<typeof notify$3> & typeof notify$3>;
+declare const notify$2: MaybeContext<BuildRESTFunction<typeof notify$3> & typeof notify$3>;
 
 type index_d$1_Channel = Channel;
 declare const index_d$1_Channel: typeof Channel;
@@ -572,416 +554,6 @@ declare namespace index_d$1 {
   export { index_d$1_Channel as Channel, index_d$1_DashboardPages as DashboardPages, type index_d$1_Empty as Empty, type NotifyOptions$1 as NotifyOptions, type index_d$1_PublicNotifyRequest as PublicNotifyRequest, type index_d$1_PublicNotifyRequestActionTargetOneOf as PublicNotifyRequestActionTargetOneOf, type index_d$1_PublicNotifyRequestRecipientsFilterOneOf as PublicNotifyRequestRecipientsFilterOneOf, type index_d$1_Public_notification as Public_notification, index_d$1_Role as Role, type index_d$1_ToContacts as ToContacts, type index_d$1_ToSiteContributors as ToSiteContributors, type index_d$1_ToTopicsSubscribers as ToTopicsSubscribers, notify$2 as notify };
 }
 
-type HostModule<T, H extends Host> = {
-    __type: 'host';
-    create(host: H): T;
-};
-type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
-type Host<Environment = unknown> = {
-    channel: {
-        observeState(callback: (props: unknown, environment: Environment) => unknown): {
-            disconnect: () => void;
-        } | Promise<{
-            disconnect: () => void;
-        }>;
-    };
-    environment?: Environment;
-    /**
-     * Optional bast url to use for API requests, for example `www.wixapis.com`
-     */
-    apiBaseUrl?: string;
-    /**
-     * Possible data to be provided by every host, for cross cutting concerns
-     * like internationalization, billing, etc.
-     */
-    essentials?: {
-        /**
-         * The language of the currently viewed session
-         */
-        language?: string;
-        /**
-         * The locale of the currently viewed session
-         */
-        locale?: string;
-        /**
-         * Any headers that should be passed through to the API requests
-         */
-        passThroughHeaders?: Record<string, string>;
-    };
-};
-
-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>;
-    getActiveToken?: () => string | undefined;
-}
-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?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-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;
-
-type ServicePluginMethodInput = {
-    request: any;
-    metadata: any;
-};
-type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata = {
-    name: string;
-    primaryHttpMappingPath: string;
-    transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
-        toREST: (...args: unknown[]) => unknown;
-    };
-};
-type ServicePluginDefinition<Contract extends ServicePluginContract> = {
-    __type: 'service-plugin-definition';
-    componentType: string;
-    methods: ServicePluginMethodMetadata[];
-    __contract: Contract;
-};
-declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
-type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
-declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
-
-type RequestContext = {
-    isSSR: boolean;
-    host: string;
-    protocol?: string;
-};
-type ResponseTransformer = (data: any, headers?: any) => any;
-/**
- * Ambassador request options types are copied mostly from AxiosRequestConfig.
- * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
- * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
- */
-type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
-type AmbassadorRequestOptions<T = any> = {
-    _?: T;
-    url?: string;
-    method?: Method;
-    params?: any;
-    data?: any;
-    transformResponse?: ResponseTransformer | ResponseTransformer[];
-};
-type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
-    __isAmbassador: boolean;
-};
-type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
-type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : 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 const emptyObjectSymbol: unique symbol;
-
-/**
-Represents a strictly empty plain object, the `{}` value.
-
-When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
-
-@example
-```
-import type {EmptyObject} from 'type-fest';
-
-// The following illustrates the problem with `{}`.
-const foo1: {} = {}; // Pass
-const foo2: {} = []; // Pass
-const foo3: {} = 42; // Pass
-const foo4: {} = {a: 1}; // Pass
-
-// With `EmptyObject` only the first case is valid.
-const bar1: EmptyObject = {}; // Pass
-const bar2: EmptyObject = 42; // Fail
-const bar3: EmptyObject = []; // Fail
-const bar4: EmptyObject = {a: 1}; // Fail
-```
-
-Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
-
-@category Object
-*/
-type EmptyObject = {[emptyObjectSymbol]?: never};
-
-/**
-Returns a boolean for whether the two given types are equal.
-
-@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
-@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
-
-Use-cases:
-- If you want to make a conditional branch based on the result of a comparison of two types.
-
-@example
-```
-import type {IsEqual} from 'type-fest';
-
-// This type returns a boolean for whether the given array includes the given item.
-// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
-type Includes<Value extends readonly any[], Item> =
-	Value extends readonly [Value[0], ...infer rest]
-		? IsEqual<Value[0], Item> extends true
-			? true
-			: Includes<rest, Item>
-		: false;
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IsEqual<A, B> =
-	(<G>() => G extends A ? 1 : 2) extends
-	(<G>() => G extends B ? 1 : 2)
-		? true
-		: false;
-
-/**
-Filter out keys from an object.
-
-Returns `never` if `Exclude` is strictly equal to `Key`.
-Returns `never` if `Key` extends `Exclude`.
-Returns `Key` otherwise.
-
-@example
-```
-type Filtered = Filter<'foo', 'foo'>;
-//=> never
-```
-
-@example
-```
-type Filtered = Filter<'bar', string>;
-//=> never
-```
-
-@example
-```
-type Filtered = Filter<'bar', 'foo'>;
-//=> 'bar'
-```
-
-@see {Except}
-*/
-type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
-
-type ExceptOptions = {
-	/**
-	Disallow assigning non-specified properties.
-
-	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
-
-	@default false
-	*/
-	requireExactProps?: boolean;
-};
-
-/**
-Create a type from an object type without certain keys.
-
-We recommend setting the `requireExactProps` option to `true`.
-
-This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
-
-This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
-
-@example
-```
-import type {Except} from 'type-fest';
-
-type Foo = {
-	a: number;
-	b: string;
-};
-
-type FooWithoutA = Except<Foo, 'a'>;
-//=> {b: string}
-
-const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
-//=> errors: 'a' does not exist in type '{ b: string; }'
-
-type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
-//=> {a: number} & Partial<Record<"b", never>>
-
-const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
-//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
-```
-
-@category Object
-*/
-type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
-	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
-} & (Options['requireExactProps'] extends true
-	? Partial<Record<KeysType, never>>
-	: {});
-
-/**
-Extract the keys from a type where the value type of the key extends the given `Condition`.
-
-Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
-
-@example
-```
-import type {ConditionalKeys} from 'type-fest';
-
-interface Example {
-	a: string;
-	b: string | number;
-	c?: string;
-	d: {};
-}
-
-type StringKeysOnly = ConditionalKeys<Example, string>;
-//=> 'a'
-```
-
-To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
-
-@example
-```
-import type {ConditionalKeys} from 'type-fest';
-
-type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
-//=> 'a' | 'c'
-```
-
-@category Object
-*/
-type ConditionalKeys<Base, Condition> = NonNullable<
-// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
-{
-	// Map through all the keys of the given base type.
-	[Key in keyof Base]:
-	// Pick only keys with types extending the given `Condition` type.
-	Base[Key] extends Condition
-	// Retain this key since the condition passes.
-		? Key
-	// Discard this key since the condition fails.
-		: never;
-
-	// Convert the produced object into a union type of the keys which passed the conditional test.
-}[keyof Base]
->;
-
-/**
-Exclude keys from a shape that matches the given `Condition`.
-
-This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
-
-@example
-```
-import type {Primitive, ConditionalExcept} from 'type-fest';
-
-class Awesome {
-	name: string;
-	successes: number;
-	failures: bigint;
-
-	run() {}
-}
-
-type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
-//=> {run: () => void}
-```
-
-@example
-```
-import type {ConditionalExcept} from 'type-fest';
-
-interface Example {
-	a: string;
-	b: string | number;
-	c: () => void;
-	d: {};
-}
-
-type NonStringKeysOnly = ConditionalExcept<Example, string>;
-//=> {b: string | number; c: () => void; d: {}}
-```
-
-@category Object
-*/
-type ConditionalExcept<Base, Condition> = Except<
-Base,
-ConditionalKeys<Base, Condition>
->;
-
-/**
- * Descriptors are objects that describe the API of a module, and the module
- * can either be a REST module or a host module.
- * This type is recursive, so it can describe nested modules.
- */
-type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
-    [key: string]: Descriptors | PublicMetadata | any;
-};
-/**
- * This type takes in a descriptors object of a certain Host (including an `unknown` host)
- * and returns an object with the same structure, but with all descriptors replaced with their API.
- * Any non-descriptor properties are removed from the returned object, including descriptors that
- * do not match the given host (as they will not work with the given host).
- */
-type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
-    done: T;
-    recurse: T extends {
-        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
-    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
-        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
-            -1,
-            0,
-            1,
-            2,
-            3,
-            4,
-            5
-        ][Depth]> : never;
-    }, EmptyObject>;
-}[Depth extends -1 ? 'done' : 'recurse'];
-type PublicMetadata = {
-    PACKAGE_NAME?: string;
-};
-
-declare global {
-    interface ContextualClient {
-    }
-}
-/**
- * A type used to create concerete types from SDK descriptors in
- * case a contextual client is available.
- */
-type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
-    host: Host;
-} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
-
 interface Notification {
     /** The id of the notification */
     _id?: string;