@zag-js/toast 0.16.0 → 0.18.0

package/dist/index.d.mts

@@ -118,63 +118,13 @@ type GroupPublicContext = SharedContext & DirectionProperty & CommonProperties &
      */
     offsets: string | Record<"left" | "right" | "bottom" | "top", string>;
 };
-type PublicApi<T extends PropTypes = PropTypes> = {
-    /**
-     * The type of the toast.
-     */
-    type: Type;
-    /**
-     * The title of the toast.
-     */
-    title: string | undefined;
-    /**
-     *  The description of the toast.
-     */
-    description: string | undefined;
-    /**
-     * The current placement of the toast.
-     */
-    placement: Placement;
-    /**
-     * Whether the toast is visible.
-     */
-    isVisible: boolean;
-    /**
-     * Whether the toast is paused.
-     */
-    isPaused: boolean;
-    /**
-     * Whether the toast is in RTL mode.
-     */
-    isRtl: boolean;
-    /**
-     * Function to pause the toast (keeping it visible).
-     */
-    pause(): void;
-    /**
-     * Function to resume the toast dismissing.
-     */
-    resume(): void;
-    /**
-     * Function to instantly dismiss the toast.
-     */
-    dismiss(): void;
-    /**
-     * Function render the toast in the DOM (based on the defined `render` property)
-     */
-    render(): any;
-    rootProps: T["element"];
-    titleProps: T["element"];
-    descriptionProps: T["element"];
-    closeTriggerProps: T["button"];
-};
 type UserDefinedGroupContext = RequiredBy<GroupPublicContext, "id">;
 type GroupComputedContext = Readonly<{
     /**
      * @computed
      * The total number of toasts in the group
      */
-    readonly count: number;
+    count: number;
 }>;
 type GroupPrivateContext = Context<{}>;
 type GroupMachineContext = GroupPublicContext & GroupComputedContext & GroupPrivateContext;
@@ -190,20 +140,7 @@ type GroupProps = {
     placement: Placement;
     label?: string;
 };
-type Toaster = {
-    count: number;
-    isVisible(id: string): boolean;
-    upsert(options: ToastOptions): string | undefined;
-    create(options: ToastOptions): string | undefined;
-    success(options: ToastOptions): string | undefined;
-    error(options: ToastOptions): string | undefined;
-    loading(options: ToastOptions): string | undefined;
-    dismiss(id?: string | undefined): void;
-    remove(id?: string | undefined): void;
-    promise<T>(promise: Promise<T>, options: PromiseOptions<T>, shared?: ToastOptions): Promise<T>;
-};
-
-declare function groupConnect<T extends PropTypes>(state: GroupState, send: GroupSend, normalize: NormalizeProps<T>): {
+type GroupMachineApi<T extends PropTypes = PropTypes> = {
     /**
      * The total number of toasts
      */
@@ -228,66 +165,121 @@ declare function groupConnect<T extends PropTypes>(state: GroupState, send: Grou
      * Function to create or update a toast.
      */
     upsert(options: Options): string | undefined;
+    /**
+     * Function to update a toast's options by id.
+     */
+    update(id: string, options: Options): void;
+    /**
+     * Function to create a success toast.
+     */
+    success(options: Options): string | undefined;
+    /**
+     * Function to create an error toast.
+     */
+    error(options: Options): string | undefined;
+    /**
+     * Function to create a loading toast.
+     */
+    loading(options: Options): string | undefined;
+    /**
+     * Function to resume a toast by id.
+     */
+    resume(id?: string | undefined): void;
+    /**
+     * Function to pause a toast by id.
+     */
+    pause(id?: string | undefined): void;
     /**
      * Function to dismiss a toast by id.
      * If no id is provided, all toasts will be dismissed.
      */
-    dismiss(id?: string): void;
+    dismiss(id?: string | undefined): void;
+    /**
+     * Function to dismiss all toasts by placement.
+     */
+    dismissByPlacement(placement: Placement): void;
     /**
      * Function to remove a toast by id.
      * If no id is provided, all toasts will be removed.
      */
-    remove(id?: string): void;
+    remove(id?: string | undefined): void;
     /**
-     * Function to dismiss all toasts by placement.
+     * Function to create a toast from a promise.
+     * - When the promise resolves, the toast will be updated with the success options.
+     * - When the promise rejects, the toast will be updated with the error options.
      */
-    dismissByPlacement(placement: Placement): void;
+    promise<T>(promise: Promise<T>, options: PromiseOptions<T>, shared?: ToastOptions): Promise<T>;
     /**
-     * Function to update a toast's options by id.
+     * Function to subscribe to the toast group.
      */
-    update(id: string, options: Options): string | undefined;
+    subscribe(callback: (toasts: Service[]) => void): VoidFunction;
+    getGroupProps(options: GroupProps): T["element"];
+};
+type MachineApi<T extends PropTypes = PropTypes> = {
     /**
-     * Function to create a loading toast.
+     * The type of the toast.
      */
-    loading(options: Options): string | undefined;
+    type: Type;
     /**
-     * Function to create a success toast.
+     * The title of the toast.
      */
-    success(options: Options): string | undefined;
+    title: string | undefined;
     /**
-     * Function to create an error toast.
+     *  The description of the toast.
      */
-    error(options: Options): string | undefined;
+    description: string | undefined;
     /**
-     * Function to create a toast from a promise.
-     * - When the promise resolves, the toast will be updated with the success options.
-     * - When the promise rejects, the toast will be updated with the error options.
+     * The current placement of the toast.
      */
-    promise<T_1>(promise: Promise<T_1>, options: PromiseOptions<T_1>, shared?: Options): Promise<T_1>;
+    placement: Placement;
     /**
-     * Function to pause a toast by id.
+     * Whether the toast is visible.
      */
-    pause(id?: string): void;
+    isVisible: boolean;
     /**
-     * Function to resume a toast by id.
+     * Whether the toast is paused.
      */
-    resume(id?: string): void;
-    getGroupProps(options: GroupProps): T["element"];
-    subscribe(fn: (toasts: GroupMachineContext["toasts"]) => void): () => void;
+    isPaused: boolean;
+    /**
+     * Whether the toast is in RTL mode.
+     */
+    isRtl: boolean;
+    /**
+     * Function to pause the toast (keeping it visible).
+     */
+    pause(): void;
+    /**
+     * Function to resume the toast dismissing.
+     */
+    resume(): void;
+    /**
+     * Function to instantly dismiss the toast.
+     */
+    dismiss(): void;
+    /**
+     * Function render the toast in the DOM (based on the defined `render` property)
+     */
+    render(): any;
+    rootProps: T["element"];
+    titleProps: T["element"];
+    descriptionProps: T["element"];
+    closeTriggerProps: T["button"];
 };
 
+declare function groupConnect<T extends PropTypes>(state: GroupState, send: GroupSend, normalize: NormalizeProps<T>): GroupMachineApi<T>;
+
 declare function groupMachine(userContext: UserDefinedGroupContext): _zag_js_core.Machine<GroupMachineContext, _zag_js_core.StateMachine.StateSchema, _zag_js_core.StateMachine.AnyEventObject>;
 
 declare function createToastMachine(options?: Options): _zag_js_core.Machine<MachineContext, MachineState, _zag_js_core.StateMachine.AnyEventObject>;
 
 declare const anatomy: _zag_js_anatomy.AnatomyInstance<"title" | "group" | "root" | "description" | "closeTrigger">;
 
-declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): PublicApi<T>;
+declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): MachineApi<T>;
 
 declare const group: {
     connect: typeof groupConnect;
     machine: typeof groupMachine;
 };
-declare function api(): Toaster | undefined;
+declare function api(): GroupMachineApi | undefined;
 
-export { GroupMachineContext, MachineContext, MachineState, Placement, PublicApi, Service, ToastOptions, Type, anatomy, api, connect, createToastMachine as createMachine, group };
+export { MachineApi as Api, GroupMachineApi as GroupApi, GroupMachineContext, MachineContext, MachineState, Placement, Service, ToastOptions, Type, anatomy, api, connect, createToastMachine as createMachine, group };

package/dist/index.d.ts

@@ -118,63 +118,13 @@ type GroupPublicContext = SharedContext & DirectionProperty & CommonProperties &
      */
     offsets: string | Record<"left" | "right" | "bottom" | "top", string>;
 };
-type PublicApi<T extends PropTypes = PropTypes> = {
-    /**
-     * The type of the toast.
-     */
-    type: Type;
-    /**
-     * The title of the toast.
-     */
-    title: string | undefined;
-    /**
-     *  The description of the toast.
-     */
-    description: string | undefined;
-    /**
-     * The current placement of the toast.
-     */
-    placement: Placement;
-    /**
-     * Whether the toast is visible.
-     */
-    isVisible: boolean;
-    /**
-     * Whether the toast is paused.
-     */
-    isPaused: boolean;
-    /**
-     * Whether the toast is in RTL mode.
-     */
-    isRtl: boolean;
-    /**
-     * Function to pause the toast (keeping it visible).
-     */
-    pause(): void;
-    /**
-     * Function to resume the toast dismissing.
-     */
-    resume(): void;
-    /**
-     * Function to instantly dismiss the toast.
-     */
-    dismiss(): void;
-    /**
-     * Function render the toast in the DOM (based on the defined `render` property)
-     */
-    render(): any;
-    rootProps: T["element"];
-    titleProps: T["element"];
-    descriptionProps: T["element"];
-    closeTriggerProps: T["button"];
-};
 type UserDefinedGroupContext = RequiredBy<GroupPublicContext, "id">;
 type GroupComputedContext = Readonly<{
     /**
      * @computed
      * The total number of toasts in the group
      */
-    readonly count: number;
+    count: number;
 }>;
 type GroupPrivateContext = Context<{}>;
 type GroupMachineContext = GroupPublicContext & GroupComputedContext & GroupPrivateContext;
@@ -190,20 +140,7 @@ type GroupProps = {
     placement: Placement;
     label?: string;
 };
-type Toaster = {
-    count: number;
-    isVisible(id: string): boolean;
-    upsert(options: ToastOptions): string | undefined;
-    create(options: ToastOptions): string | undefined;
-    success(options: ToastOptions): string | undefined;
-    error(options: ToastOptions): string | undefined;
-    loading(options: ToastOptions): string | undefined;
-    dismiss(id?: string | undefined): void;
-    remove(id?: string | undefined): void;
-    promise<T>(promise: Promise<T>, options: PromiseOptions<T>, shared?: ToastOptions): Promise<T>;
-};
-
-declare function groupConnect<T extends PropTypes>(state: GroupState, send: GroupSend, normalize: NormalizeProps<T>): {
+type GroupMachineApi<T extends PropTypes = PropTypes> = {
     /**
      * The total number of toasts
      */
@@ -228,66 +165,121 @@ declare function groupConnect<T extends PropTypes>(state: GroupState, send: Grou
      * Function to create or update a toast.
      */
     upsert(options: Options): string | undefined;
+    /**
+     * Function to update a toast's options by id.
+     */
+    update(id: string, options: Options): void;
+    /**
+     * Function to create a success toast.
+     */
+    success(options: Options): string | undefined;
+    /**
+     * Function to create an error toast.
+     */
+    error(options: Options): string | undefined;
+    /**
+     * Function to create a loading toast.
+     */
+    loading(options: Options): string | undefined;
+    /**
+     * Function to resume a toast by id.
+     */
+    resume(id?: string | undefined): void;
+    /**
+     * Function to pause a toast by id.
+     */
+    pause(id?: string | undefined): void;
     /**
      * Function to dismiss a toast by id.
      * If no id is provided, all toasts will be dismissed.
      */
-    dismiss(id?: string): void;
+    dismiss(id?: string | undefined): void;
+    /**
+     * Function to dismiss all toasts by placement.
+     */
+    dismissByPlacement(placement: Placement): void;
     /**
      * Function to remove a toast by id.
      * If no id is provided, all toasts will be removed.
      */
-    remove(id?: string): void;
+    remove(id?: string | undefined): void;
     /**
-     * Function to dismiss all toasts by placement.
+     * Function to create a toast from a promise.
+     * - When the promise resolves, the toast will be updated with the success options.
+     * - When the promise rejects, the toast will be updated with the error options.
      */
-    dismissByPlacement(placement: Placement): void;
+    promise<T>(promise: Promise<T>, options: PromiseOptions<T>, shared?: ToastOptions): Promise<T>;
     /**
-     * Function to update a toast's options by id.
+     * Function to subscribe to the toast group.
      */
-    update(id: string, options: Options): string | undefined;
+    subscribe(callback: (toasts: Service[]) => void): VoidFunction;
+    getGroupProps(options: GroupProps): T["element"];
+};
+type MachineApi<T extends PropTypes = PropTypes> = {
     /**
-     * Function to create a loading toast.
+     * The type of the toast.
      */
-    loading(options: Options): string | undefined;
+    type: Type;
     /**
-     * Function to create a success toast.
+     * The title of the toast.
      */
-    success(options: Options): string | undefined;
+    title: string | undefined;
     /**
-     * Function to create an error toast.
+     *  The description of the toast.
      */
-    error(options: Options): string | undefined;
+    description: string | undefined;
     /**
-     * Function to create a toast from a promise.
-     * - When the promise resolves, the toast will be updated with the success options.
-     * - When the promise rejects, the toast will be updated with the error options.
+     * The current placement of the toast.
      */
-    promise<T_1>(promise: Promise<T_1>, options: PromiseOptions<T_1>, shared?: Options): Promise<T_1>;
+    placement: Placement;
     /**
-     * Function to pause a toast by id.
+     * Whether the toast is visible.
      */
-    pause(id?: string): void;
+    isVisible: boolean;
     /**
-     * Function to resume a toast by id.
+     * Whether the toast is paused.
      */
-    resume(id?: string): void;
-    getGroupProps(options: GroupProps): T["element"];
-    subscribe(fn: (toasts: GroupMachineContext["toasts"]) => void): () => void;
+    isPaused: boolean;
+    /**
+     * Whether the toast is in RTL mode.
+     */
+    isRtl: boolean;
+    /**
+     * Function to pause the toast (keeping it visible).
+     */
+    pause(): void;
+    /**
+     * Function to resume the toast dismissing.
+     */
+    resume(): void;
+    /**
+     * Function to instantly dismiss the toast.
+     */
+    dismiss(): void;
+    /**
+     * Function render the toast in the DOM (based on the defined `render` property)
+     */
+    render(): any;
+    rootProps: T["element"];
+    titleProps: T["element"];
+    descriptionProps: T["element"];
+    closeTriggerProps: T["button"];
 };
 
+declare function groupConnect<T extends PropTypes>(state: GroupState, send: GroupSend, normalize: NormalizeProps<T>): GroupMachineApi<T>;
+
 declare function groupMachine(userContext: UserDefinedGroupContext): _zag_js_core.Machine<GroupMachineContext, _zag_js_core.StateMachine.StateSchema, _zag_js_core.StateMachine.AnyEventObject>;
 
 declare function createToastMachine(options?: Options): _zag_js_core.Machine<MachineContext, MachineState, _zag_js_core.StateMachine.AnyEventObject>;
 
 declare const anatomy: _zag_js_anatomy.AnatomyInstance<"title" | "group" | "root" | "description" | "closeTrigger">;
 
-declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): PublicApi<T>;
+declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): MachineApi<T>;
 
 declare const group: {
     connect: typeof groupConnect;
     machine: typeof groupMachine;
 };
-declare function api(): Toaster | undefined;
+declare function api(): GroupMachineApi | undefined;
 
-export { GroupMachineContext, MachineContext, MachineState, Placement, PublicApi, Service, ToastOptions, Type, anatomy, api, connect, createToastMachine as createMachine, group };
+export { MachineApi as Api, GroupMachineApi as GroupApi, GroupMachineContext, MachineContext, MachineState, Placement, Service, ToastOptions, Type, anatomy, api, connect, createToastMachine as createMachine, group };

package/dist/index.js

@@ -114,29 +114,14 @@ function getGroupPlacementStyle(ctx, placement) {
 var toaster = {};
 function groupConnect(state, send, normalize) {
   const group2 = {
-    /**
-     * The total number of toasts
-     */
     count: state.context.count,
-    /**
-     * The active toasts
-     */
     toasts: state.context.toasts,
-    /**
-     * The active toasts by placement
-     */
     toastsByPlacement: getToastsByPlacement(state.context.toasts),
-    /**
-     * Returns whether the toast id is visible
-     */
     isVisible(id) {
       if (!state.context.toasts.length)
         return false;
       return !!state.context.toasts.find((toast) => toast.id == id);
     },
-    /**
-     * Function to create a toast.
-     */
     create(options) {
       const uid = `toast:${(0, import_utils.uuid)()}`;
       const id = options.id ? options.id : uid;
@@ -145,9 +130,6 @@ function groupConnect(state, send, normalize) {
       send({ type: "ADD_TOAST", toast: { ...options, id } });
       return id;
     },
-    /**
-     * Function to create or update a toast.
-     */
     upsert(options) {
       const { id } = options;
       const isVisible = id ? group2.isVisible(id) : false;
@@ -157,10 +139,6 @@ function groupConnect(state, send, normalize) {
         return group2.create(options);
       }
     },
-    /**
-     * Function to dismiss a toast by id.
-     * If no id is provided, all toasts will be dismissed.
-     */
     dismiss(id) {
       if (id == null) {
         send("DISMISS_ALL");
@@ -168,10 +146,6 @@ function groupConnect(state, send, normalize) {
         send({ type: "DISMISS_TOAST", id });
       }
     },
-    /**
-     * Function to remove a toast by id.
-     * If no id is provided, all toasts will be removed.
-     */
     remove(id) {
       if (id == null) {
         send("REMOVE_ALL");
@@ -179,50 +153,30 @@ function groupConnect(state, send, normalize) {
         send({ type: "REMOVE_TOAST", id });
       }
     },
-    /**
-     * Function to dismiss all toasts by placement.
-     */
     dismissByPlacement(placement) {
       const toasts = group2.toastsByPlacement[placement];
       if (toasts) {
         toasts.forEach((toast) => group2.dismiss(toast.id));
       }
     },
-    /**
-     * Function to update a toast's options by id.
-     */
     update(id, options) {
       if (!group2.isVisible(id))
         return;
       send({ type: "UPDATE_TOAST", id, toast: options });
       return id;
     },
-    /**
-     * Function to create a loading toast.
-     */
     loading(options) {
       options.type = "loading";
       return group2.upsert(options);
     },
-    /**
-     * Function to create a success toast.
-     */
     success(options) {
       options.type = "success";
       return group2.upsert(options);
     },
-    /**
-     * Function to create an error toast.
-     */
     error(options) {
       options.type = "error";
       return group2.upsert(options);
     },
-    /**
-     * Function to create a toast from a promise.
-     * - When the promise resolves, the toast will be updated with the success options.
-     * - When the promise rejects, the toast will be updated with the error options.
-     */
     promise(promise, options, shared = {}) {
       const id = group2.loading({ ...shared, ...options.loading });
       promise.then((response) => {
@@ -234,9 +188,6 @@ function groupConnect(state, send, normalize) {
       });
       return promise;
     },
-    /**
-     * Function to pause a toast by id.
-     */
     pause(id) {
       if (id == null) {
         send("PAUSE_ALL");
@@ -244,9 +195,6 @@ function groupConnect(state, send, normalize) {
         send({ type: "PAUSE_TOAST", id });
       }
     },
-    /**
-     * Function to resume a toast by id.
-     */
     resume(id) {
       if (id == null) {
         send("RESUME_ALL");