@arbidocs/react 0.3.183 → 0.3.185

package/dist/index-4WwLZsQO.d.cts

@@ -0,0 +1,78 @@
+import * as zustand from 'zustand';
+import * as React from 'react';
+import { ReactNode } from 'react';
+import { ToasterProps } from 'sonner';
+
+type NotifyVariant = 'success' | 'error' | 'info' | 'warning';
+interface AppNotification {
+    id: string;
+    title: string;
+    description?: string;
+    variant: NotifyVariant;
+    /** Epoch ms the entry was recorded. */
+    ts: number;
+    read: boolean;
+    /** Optional in-app link the entry deep-links to (passed to the bell's onNavigate). */
+    href?: string;
+    /** Optional click action — wins over `href` when both are present. Session
+     *  history only; entries are never serialized, so a closure is safe here. */
+    onSelect?: () => void;
+    /** Routine session activity ("Opening workspace…", "Saved") — kept for the
+     *  log but not something that demands attention: excluded from the unread
+     *  badge and from the bell's default list (shown under "All activity"). */
+    ambient?: boolean;
+    /** Where the entry comes from. Session entries (`record`) have none; a
+     *  backend bridge stamps its own (e.g. 'server') so {@link syncSource} can
+     *  replace exactly its slice on every refetch without touching the rest. */
+    source?: string;
+}
+interface NotifyOptions {
+    description?: string;
+    /** Also record a persistent notification-centre entry (default true). */
+    record?: boolean;
+    href?: string;
+    duration?: number;
+    /** A toast action button (sonner). */
+    action?: {
+        label: ReactNode;
+        onClick: () => void;
+    };
+    /** Override the toast glyph (sonner). */
+    icon?: ReactNode;
+    /** Record as routine session activity (see {@link AppNotification.ambient}). */
+    ambient?: boolean;
+}
+interface NotifyState {
+    notifications: AppNotification[];
+    markRead: (id: string) => void;
+    markAllRead: () => void;
+    removeNotification: (id: string) => void;
+    clearNotifications: () => void;
+    /** Replace the centre's history (e.g. seed a demo/initial set). */
+    seed: (items: AppNotification[]) => void;
+    /** Record a centre entry (used by `notify.*`; sonner renders the toast). */
+    record: (note: AppNotification) => void;
+    /** Reconcile one source's slice with fresh truth (e.g. a backend list on
+     *  every refetch): entries stamped with `source` are replaced wholesale —
+     *  including their read state, which the source owns — while entries from
+     *  other sources (session activity) stay untouched. Newest first. */
+    syncSource: (source: string, items: AppNotification[]) => void;
+}
+declare const useNotify: zustand.UseBoundStore<zustand.StoreApi<NotifyState>>;
+declare const notify: {
+    success: (title: string, opts?: NotifyOptions) => string;
+    error: (title: string, opts?: NotifyOptions) => string;
+    info: (title: string, opts?: NotifyOptions) => string;
+    warning: (title: string, opts?: NotifyOptions) => string;
+};
+/** Replace the notification centre's history — inject a seed/initial set. */
+declare function seedNotifications(items: AppNotification[]): void;
+/** Unread count selector for the topbar bell — ambient session activity never
+ *  demands attention, so it never counts. */
+declare const selectUnread: (s: NotifyState) => number;
+/** Default glyph colour per variant (raw palette, override via `toneClassNames`). */
+declare const DEFAULT_NOTIFY_TONE: Record<NotifyVariant, string>;
+
+declare function Toaster({ toastOptions, ...props }: ToasterProps): React.JSX.Element;
+
+export { type AppNotification as A, DEFAULT_NOTIFY_TONE as D, type NotifyOptions as N, Toaster as T, type NotifyVariant as a, selectUnread as b, notify as n, seedNotifications as s, useNotify as u };

package/dist/index-4WwLZsQO.d.ts

@@ -0,0 +1,78 @@
+import * as zustand from 'zustand';
+import * as React from 'react';
+import { ReactNode } from 'react';
+import { ToasterProps } from 'sonner';
+
+type NotifyVariant = 'success' | 'error' | 'info' | 'warning';
+interface AppNotification {
+    id: string;
+    title: string;
+    description?: string;
+    variant: NotifyVariant;
+    /** Epoch ms the entry was recorded. */
+    ts: number;
+    read: boolean;
+    /** Optional in-app link the entry deep-links to (passed to the bell's onNavigate). */
+    href?: string;
+    /** Optional click action — wins over `href` when both are present. Session
+     *  history only; entries are never serialized, so a closure is safe here. */
+    onSelect?: () => void;
+    /** Routine session activity ("Opening workspace…", "Saved") — kept for the
+     *  log but not something that demands attention: excluded from the unread
+     *  badge and from the bell's default list (shown under "All activity"). */
+    ambient?: boolean;
+    /** Where the entry comes from. Session entries (`record`) have none; a
+     *  backend bridge stamps its own (e.g. 'server') so {@link syncSource} can
+     *  replace exactly its slice on every refetch without touching the rest. */
+    source?: string;
+}
+interface NotifyOptions {
+    description?: string;
+    /** Also record a persistent notification-centre entry (default true). */
+    record?: boolean;
+    href?: string;
+    duration?: number;
+    /** A toast action button (sonner). */
+    action?: {
+        label: ReactNode;
+        onClick: () => void;
+    };
+    /** Override the toast glyph (sonner). */
+    icon?: ReactNode;
+    /** Record as routine session activity (see {@link AppNotification.ambient}). */
+    ambient?: boolean;
+}
+interface NotifyState {
+    notifications: AppNotification[];
+    markRead: (id: string) => void;
+    markAllRead: () => void;
+    removeNotification: (id: string) => void;
+    clearNotifications: () => void;
+    /** Replace the centre's history (e.g. seed a demo/initial set). */
+    seed: (items: AppNotification[]) => void;
+    /** Record a centre entry (used by `notify.*`; sonner renders the toast). */
+    record: (note: AppNotification) => void;
+    /** Reconcile one source's slice with fresh truth (e.g. a backend list on
+     *  every refetch): entries stamped with `source` are replaced wholesale —
+     *  including their read state, which the source owns — while entries from
+     *  other sources (session activity) stay untouched. Newest first. */
+    syncSource: (source: string, items: AppNotification[]) => void;
+}
+declare const useNotify: zustand.UseBoundStore<zustand.StoreApi<NotifyState>>;
+declare const notify: {
+    success: (title: string, opts?: NotifyOptions) => string;
+    error: (title: string, opts?: NotifyOptions) => string;
+    info: (title: string, opts?: NotifyOptions) => string;
+    warning: (title: string, opts?: NotifyOptions) => string;
+};
+/** Replace the notification centre's history — inject a seed/initial set. */
+declare function seedNotifications(items: AppNotification[]): void;
+/** Unread count selector for the topbar bell — ambient session activity never
+ *  demands attention, so it never counts. */
+declare const selectUnread: (s: NotifyState) => number;
+/** Default glyph colour per variant (raw palette, override via `toneClassNames`). */
+declare const DEFAULT_NOTIFY_TONE: Record<NotifyVariant, string>;
+
+declare function Toaster({ toastOptions, ...props }: ToasterProps): React.JSX.Element;
+
+export { type AppNotification as A, DEFAULT_NOTIFY_TONE as D, type NotifyOptions as N, Toaster as T, type NotifyVariant as a, selectUnread as b, notify as n, seedNotifications as s, useNotify as u };