@zag-js/toast 0.19.0 → 0.20.0

package/dist/index.d.mts

@@ -1,25 +1,12 @@
 import * as _zag_js_core from '@zag-js/core';
 import { Machine, StateMachine } from '@zag-js/core';
+import * as _zag_js_types from '@zag-js/types';
 import { RootProperties, CommonProperties, Direction, PropTypes, DirectionProperty, Context, RequiredBy, NormalizeProps } from '@zag-js/types';
 import * as _zag_js_anatomy from '@zag-js/anatomy';
 
 type Type = "success" | "error" | "loading" | "info" | "custom";
 type Placement = "top-start" | "top" | "top-end" | "bottom-start" | "bottom" | "bottom-end";
-type SharedContext = {
-    /**
-     * Whether to pause toast when the user leaves the browser tab
-     */
-    pauseOnPageIdle?: boolean;
-    /**
-     * Whether to pause the toast when interacted with
-     */
-    pauseOnInteraction?: boolean;
-    /**
-     * The default options for the toast
-     */
-    defaultOptions?: Partial<Pick<ToastOptions, "duration" | "removeDelay" | "placement">>;
-};
-type ToastOptions = {
+interface ToastOptions {
     /**
      * The unique id of the toast
      */
@@ -69,12 +56,26 @@ type ToastOptions = {
      * Function called when the toast is updated
      */
     onUpdate?: VoidFunction;
-};
+}
 type Options = Partial<ToastOptions>;
 type RenderOptions = Omit<ToastOptions, "render"> & {
     dismiss(): void;
 };
-type MachineContext = SharedContext & RootProperties & CommonProperties & Omit<ToastOptions, "removeDelay"> & {
+interface SharedContext {
+    /**
+     * Whether to pause toast when the user leaves the browser tab
+     */
+    pauseOnPageIdle?: boolean;
+    /**
+     * Whether to pause the toast when interacted with
+     */
+    pauseOnInteraction?: boolean;
+    /**
+     * The default options for the toast
+     */
+    defaultOptions?: Partial<Pick<ToastOptions, "duration" | "removeDelay" | "placement">>;
+}
+interface MachineContext extends SharedContext, RootProperties, CommonProperties, Omit<ToastOptions, "removeDelay"> {
     /**
      * The duration for the toast to kept alive before it is removed.
      * Useful for exit transitions.
@@ -92,15 +93,15 @@ type MachineContext = SharedContext & RootProperties & CommonProperties & Omit<T
      * The time left before the toast is removed
      */
     remaining: number;
-};
-type MachineState = {
+}
+interface MachineState {
     value: "active" | "active:temp" | "dismissing" | "inactive" | "persist";
     tags: "visible" | "paused" | "updating";
-};
+}
 type State = StateMachine.State<MachineContext, MachineState>;
 type Send = StateMachine.Send;
 type Service = Machine<MachineContext, MachineState>;
-type GroupPublicContext = SharedContext & DirectionProperty & CommonProperties & {
+interface GroupPublicContext extends SharedContext, DirectionProperty, CommonProperties {
     /**
      * The gutter or spacing between toasts
      */
@@ -117,7 +118,7 @@ type GroupPublicContext = SharedContext & DirectionProperty & CommonProperties &
      * The offset from the safe environment edge of the viewport
      */
     offsets: string | Record<"left" | "right" | "bottom" | "top", string>;
-};
+}
 type UserDefinedGroupContext = RequiredBy<GroupPublicContext, "id">;
 type GroupComputedContext = Readonly<{
     /**
@@ -127,20 +128,21 @@ type GroupComputedContext = Readonly<{
     count: number;
 }>;
 type GroupPrivateContext = Context<{}>;
-type GroupMachineContext = GroupPublicContext & GroupComputedContext & GroupPrivateContext;
+interface GroupMachineContext extends GroupPublicContext, GroupComputedContext, GroupPrivateContext {
+}
 type GroupState = StateMachine.State<GroupMachineContext>;
-type GroupSend = (event: StateMachine.Event<StateMachine.AnyEventObject>) => void;
+type GroupSend = StateMachine.Send;
 type MaybeFunction<Value, Args> = Value | ((arg: Args) => Value);
-type PromiseOptions<Value> = {
+interface PromiseOptions<Value> {
     loading: ToastOptions;
     success: MaybeFunction<ToastOptions, Value>;
     error: MaybeFunction<ToastOptions, Error>;
-};
-type GroupProps = {
+}
+interface GroupProps {
     placement: Placement;
     label?: string;
-};
-type GroupMachineApi<T extends PropTypes = PropTypes> = {
+}
+interface GroupMachineApi<T extends PropTypes = PropTypes> {
     /**
      * The total number of toasts
      */
@@ -214,8 +216,8 @@ type GroupMachineApi<T extends PropTypes = PropTypes> = {
      */
     subscribe(callback: (toasts: Service[]) => void): VoidFunction;
     getGroupProps(options: GroupProps): T["element"];
-};
-type MachineApi<T extends PropTypes = PropTypes> = {
+}
+interface MachineApi<T extends PropTypes = PropTypes> {
     /**
      * The type of the toast.
      */
@@ -264,7 +266,7 @@ type MachineApi<T extends PropTypes = PropTypes> = {
     titleProps: T["element"];
     descriptionProps: T["element"];
     closeTriggerProps: T["button"];
-};
+}
 
 declare function groupConnect<T extends PropTypes>(state: GroupState, send: GroupSend, normalize: NormalizeProps<T>): GroupMachineApi<T>;
 
@@ -280,6 +282,6 @@ declare const group: {
     connect: typeof groupConnect;
     machine: typeof groupMachine;
 };
-declare function api(): GroupMachineApi | undefined;
+declare function api(): GroupMachineApi<_zag_js_types.PropTypes> | undefined;
 
 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

@@ -1,25 +1,12 @@
 import * as _zag_js_core from '@zag-js/core';
 import { Machine, StateMachine } from '@zag-js/core';
+import * as _zag_js_types from '@zag-js/types';
 import { RootProperties, CommonProperties, Direction, PropTypes, DirectionProperty, Context, RequiredBy, NormalizeProps } from '@zag-js/types';
 import * as _zag_js_anatomy from '@zag-js/anatomy';
 
 type Type = "success" | "error" | "loading" | "info" | "custom";
 type Placement = "top-start" | "top" | "top-end" | "bottom-start" | "bottom" | "bottom-end";
-type SharedContext = {
-    /**
-     * Whether to pause toast when the user leaves the browser tab
-     */
-    pauseOnPageIdle?: boolean;
-    /**
-     * Whether to pause the toast when interacted with
-     */
-    pauseOnInteraction?: boolean;
-    /**
-     * The default options for the toast
-     */
-    defaultOptions?: Partial<Pick<ToastOptions, "duration" | "removeDelay" | "placement">>;
-};
-type ToastOptions = {
+interface ToastOptions {
     /**
      * The unique id of the toast
      */
@@ -69,12 +56,26 @@ type ToastOptions = {
      * Function called when the toast is updated
      */
     onUpdate?: VoidFunction;
-};
+}
 type Options = Partial<ToastOptions>;
 type RenderOptions = Omit<ToastOptions, "render"> & {
     dismiss(): void;
 };
-type MachineContext = SharedContext & RootProperties & CommonProperties & Omit<ToastOptions, "removeDelay"> & {
+interface SharedContext {
+    /**
+     * Whether to pause toast when the user leaves the browser tab
+     */
+    pauseOnPageIdle?: boolean;
+    /**
+     * Whether to pause the toast when interacted with
+     */
+    pauseOnInteraction?: boolean;
+    /**
+     * The default options for the toast
+     */
+    defaultOptions?: Partial<Pick<ToastOptions, "duration" | "removeDelay" | "placement">>;
+}
+interface MachineContext extends SharedContext, RootProperties, CommonProperties, Omit<ToastOptions, "removeDelay"> {
     /**
      * The duration for the toast to kept alive before it is removed.
      * Useful for exit transitions.
@@ -92,15 +93,15 @@ type MachineContext = SharedContext & RootProperties & CommonProperties & Omit<T
      * The time left before the toast is removed
      */
     remaining: number;
-};
-type MachineState = {
+}
+interface MachineState {
     value: "active" | "active:temp" | "dismissing" | "inactive" | "persist";
     tags: "visible" | "paused" | "updating";
-};
+}
 type State = StateMachine.State<MachineContext, MachineState>;
 type Send = StateMachine.Send;
 type Service = Machine<MachineContext, MachineState>;
-type GroupPublicContext = SharedContext & DirectionProperty & CommonProperties & {
+interface GroupPublicContext extends SharedContext, DirectionProperty, CommonProperties {
     /**
      * The gutter or spacing between toasts
      */
@@ -117,7 +118,7 @@ type GroupPublicContext = SharedContext & DirectionProperty & CommonProperties &
      * The offset from the safe environment edge of the viewport
      */
     offsets: string | Record<"left" | "right" | "bottom" | "top", string>;
-};
+}
 type UserDefinedGroupContext = RequiredBy<GroupPublicContext, "id">;
 type GroupComputedContext = Readonly<{
     /**
@@ -127,20 +128,21 @@ type GroupComputedContext = Readonly<{
     count: number;
 }>;
 type GroupPrivateContext = Context<{}>;
-type GroupMachineContext = GroupPublicContext & GroupComputedContext & GroupPrivateContext;
+interface GroupMachineContext extends GroupPublicContext, GroupComputedContext, GroupPrivateContext {
+}
 type GroupState = StateMachine.State<GroupMachineContext>;
-type GroupSend = (event: StateMachine.Event<StateMachine.AnyEventObject>) => void;
+type GroupSend = StateMachine.Send;
 type MaybeFunction<Value, Args> = Value | ((arg: Args) => Value);
-type PromiseOptions<Value> = {
+interface PromiseOptions<Value> {
     loading: ToastOptions;
     success: MaybeFunction<ToastOptions, Value>;
     error: MaybeFunction<ToastOptions, Error>;
-};
-type GroupProps = {
+}
+interface GroupProps {
     placement: Placement;
     label?: string;
-};
-type GroupMachineApi<T extends PropTypes = PropTypes> = {
+}
+interface GroupMachineApi<T extends PropTypes = PropTypes> {
     /**
      * The total number of toasts
      */
@@ -214,8 +216,8 @@ type GroupMachineApi<T extends PropTypes = PropTypes> = {
      */
     subscribe(callback: (toasts: Service[]) => void): VoidFunction;
     getGroupProps(options: GroupProps): T["element"];
-};
-type MachineApi<T extends PropTypes = PropTypes> = {
+}
+interface MachineApi<T extends PropTypes = PropTypes> {
     /**
      * The type of the toast.
      */
@@ -264,7 +266,7 @@ type MachineApi<T extends PropTypes = PropTypes> = {
     titleProps: T["element"];
     descriptionProps: T["element"];
     closeTriggerProps: T["button"];
-};
+}
 
 declare function groupConnect<T extends PropTypes>(state: GroupState, send: GroupSend, normalize: NormalizeProps<T>): GroupMachineApi<T>;
 
@@ -280,6 +282,6 @@ declare const group: {
     connect: typeof groupConnect;
     machine: typeof groupMachine;
 };
-declare function api(): GroupMachineApi | undefined;
+declare function api(): GroupMachineApi<_zag_js_types.PropTypes> | undefined;
 
 export { MachineApi as Api, GroupMachineApi as GroupApi, GroupMachineContext, MachineContext, MachineState, Placement, Service, ToastOptions, Type, anatomy, api, connect, createToastMachine as createMachine, group };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zag-js/toast",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Core logic for the toast widget implemented as a state machine",
   "keywords": [
     "js",
@@ -27,12 +27,12 @@
     "url": "https://github.com/chakra-ui/zag/issues"
   },
   "dependencies": {
-    "@zag-js/anatomy": "0.19.0",
-    "@zag-js/core": "0.19.0",
-    "@zag-js/dom-query": "0.19.0",
-    "@zag-js/dom-event": "0.19.0",
-    "@zag-js/utils": "0.19.0",
-    "@zag-js/types": "0.19.0"
+    "@zag-js/anatomy": "0.20.0",
+    "@zag-js/core": "0.20.0",
+    "@zag-js/dom-query": "0.20.0",
+    "@zag-js/dom-event": "0.20.0",
+    "@zag-js/utils": "0.20.0",
+    "@zag-js/types": "0.20.0"
   },
   "devDependencies": {
     "clean-package": "2.2.0"

package/src/toast.types.ts

@@ -13,23 +13,7 @@ export type Type = "success" | "error" | "loading" | "info" | "custom"
 
 export type Placement = "top-start" | "top" | "top-end" | "bottom-start" | "bottom" | "bottom-end"
 
-type SharedContext = {
-  /**
-   * Whether to pause toast when the user leaves the browser tab
-   */
-  pauseOnPageIdle?: boolean
-  /**
-   * Whether to pause the toast when interacted with
-   */
-  pauseOnInteraction?: boolean
-
-  /**
-   * The default options for the toast
-   */
-  defaultOptions?: Partial<Pick<ToastOptions, "duration" | "removeDelay" | "placement">>
-}
-
-export type ToastOptions = {
+export interface ToastOptions {
   /**
    * The unique id of the toast
    */
@@ -87,30 +71,51 @@ export type RenderOptions = Omit<ToastOptions, "render"> & {
   dismiss(): void
 }
 
-export type MachineContext = SharedContext &
-  RootProperties &
-  CommonProperties &
-  Omit<ToastOptions, "removeDelay"> & {
-    /**
-     * The duration for the toast to kept alive before it is removed.
-     * Useful for exit transitions.
-     */
-    removeDelay: number
-    /**
-     * The document's text/writing direction.
-     */
-    dir?: Direction
-    /**
-     * The time the toast was created
-     */
-    createdAt: number
-    /**
-     * The time left before the toast is removed
-     */
-    remaining: number
-  }
+/* -----------------------------------------------------------------------------
+ * Machine context
+ * -----------------------------------------------------------------------------*/
+
+interface SharedContext {
+  /**
+   * Whether to pause toast when the user leaves the browser tab
+   */
+  pauseOnPageIdle?: boolean
+  /**
+   * Whether to pause the toast when interacted with
+   */
+  pauseOnInteraction?: boolean
+
+  /**
+   * The default options for the toast
+   */
+  defaultOptions?: Partial<Pick<ToastOptions, "duration" | "removeDelay" | "placement">>
+}
+
+export interface MachineContext
+  extends SharedContext,
+    RootProperties,
+    CommonProperties,
+    Omit<ToastOptions, "removeDelay"> {
+  /**
+   * The duration for the toast to kept alive before it is removed.
+   * Useful for exit transitions.
+   */
+  removeDelay: number
+  /**
+   * The document's text/writing direction.
+   */
+  dir?: Direction
+  /**
+   * The time the toast was created
+   */
+  createdAt: number
+  /**
+   * The time left before the toast is removed
+   */
+  remaining: number
+}
 
-export type MachineState = {
+export interface MachineState {
   value: "active" | "active:temp" | "dismissing" | "inactive" | "persist"
   tags: "visible" | "paused" | "updating"
 }
@@ -121,26 +126,24 @@ export type Send = S.Send
 
 export type Service = Machine<MachineContext, MachineState>
 
-type GroupPublicContext = SharedContext &
-  DirectionProperty &
-  CommonProperties & {
-    /**
-     * The gutter or spacing between toasts
-     */
-    gutter: string
-    /**
-     * The z-index applied to each toast group
-     */
-    zIndex: number
-    /**
-     * The maximum number of toasts that can be shown at once
-     */
-    max: number
-    /**
-     * The offset from the safe environment edge of the viewport
-     */
-    offsets: string | Record<"left" | "right" | "bottom" | "top", string>
-  }
+interface GroupPublicContext extends SharedContext, DirectionProperty, CommonProperties {
+  /**
+   * The gutter or spacing between toasts
+   */
+  gutter: string
+  /**
+   * The z-index applied to each toast group
+   */
+  zIndex: number
+  /**
+   * The maximum number of toasts that can be shown at once
+   */
+  max: number
+  /**
+   * The offset from the safe environment edge of the viewport
+   */
+  offsets: string | Record<"left" | "right" | "bottom" | "top", string>
+}
 
 export type UserDefinedGroupContext = RequiredBy<GroupPublicContext, "id">
 
@@ -160,26 +163,30 @@ type GroupPrivateContext = Context<{
   toasts: Service[]
 }>
 
-export type GroupMachineContext = GroupPublicContext & GroupComputedContext & GroupPrivateContext
+export interface GroupMachineContext extends GroupPublicContext, GroupComputedContext, GroupPrivateContext {}
 
 export type GroupState = S.State<GroupMachineContext>
 
-export type GroupSend = (event: S.Event<S.AnyEventObject>) => void
+export type GroupSend = S.Send
+
+/* -----------------------------------------------------------------------------
+ * Component API
+ * -----------------------------------------------------------------------------*/
 
 type MaybeFunction<Value, Args> = Value | ((arg: Args) => Value)
 
-export type PromiseOptions<Value> = {
+export interface PromiseOptions<Value> {
   loading: ToastOptions
   success: MaybeFunction<ToastOptions, Value>
   error: MaybeFunction<ToastOptions, Error>
 }
 
-export type GroupProps = {
+export interface GroupProps {
   placement: Placement
   label?: string
 }
 
-export type GroupMachineApi<T extends PropTypes = PropTypes> = {
+export interface GroupMachineApi<T extends PropTypes = PropTypes> {
   /**
    * The total number of toasts
    */
@@ -255,7 +262,7 @@ export type GroupMachineApi<T extends PropTypes = PropTypes> = {
   getGroupProps(options: GroupProps): T["element"]
 }
 
-export type MachineApi<T extends PropTypes = PropTypes> = {
+export interface MachineApi<T extends PropTypes = PropTypes> {
   /**
    * The type of the toast.
    */