@flyingrobots/bijou-tui 3.0.0 → 4.0.0

package/dist/notification.d.ts

@@ -0,0 +1,89 @@
+import type { BijouContext, OverflowBehavior, TokenValue } from '@flyingrobots/bijou';
+import type { Overlay } from './overlay.js';
+import type { LayoutRect } from './layout-rect.js';
+export type NotificationVariant = 'ACTIONABLE' | 'INLINE' | 'TOAST';
+export type NotificationTone = 'INFO' | 'SUCCESS' | 'WARNING' | 'ERROR';
+export type NotificationPlacement = 'UPPER_LEFT' | 'UPPER_RIGHT' | 'LOWER_LEFT' | 'LOWER_RIGHT' | 'TOP_CENTER' | 'BOTTOM_CENTER' | 'CENTER';
+export type NotificationHistoryFilter = 'ALL' | 'ACTIONABLE' | NotificationTone;
+export interface NotificationAction<Msg> {
+    readonly label: string;
+    readonly payload: Msg;
+}
+export interface NotificationSpec<Msg> {
+    readonly title: string;
+    readonly message?: string;
+    readonly variant?: NotificationVariant;
+    readonly tone?: NotificationTone;
+    readonly durationMs?: number | null;
+    readonly placement?: NotificationPlacement;
+    readonly action?: NotificationAction<Msg>;
+    readonly bgToken?: TokenValue;
+    readonly accentToken?: TokenValue;
+    readonly overflow?: OverflowBehavior;
+}
+export type NotificationPhase = 'entering' | 'visible' | 'exiting';
+export interface NotificationRecord<Msg> {
+    readonly id: number;
+    readonly title: string;
+    readonly message: string;
+    readonly variant: NotificationVariant;
+    readonly tone: NotificationTone;
+    readonly durationMs: number | null;
+    readonly placement: NotificationPlacement;
+    readonly action?: NotificationAction<Msg>;
+    readonly bgToken?: TokenValue;
+    readonly accentToken?: TokenValue;
+    readonly overflow: OverflowBehavior;
+    readonly createdAtMs: number;
+    readonly updatedAtMs: number;
+    readonly enteredAtMs?: number;
+    readonly exitStartedAtMs?: number;
+    readonly phase: NotificationPhase;
+    readonly progress: number;
+}
+export interface NotificationState<Msg> {
+    readonly items: readonly NotificationRecord<Msg>[];
+    readonly overflowExits: readonly NotificationRecord<Msg>[];
+    readonly history: readonly NotificationRecord<Msg>[];
+    readonly nextId: number;
+    readonly focusedId?: number;
+}
+export interface RenderNotificationStackOptions {
+    readonly screenWidth: number;
+    readonly screenHeight: number;
+    readonly region?: LayoutRect;
+    readonly ctx?: BijouContext;
+    readonly margin?: number;
+    readonly gap?: number;
+}
+export interface RenderNotificationHistoryOptions {
+    readonly width: number;
+    readonly height: number;
+    readonly scroll?: number;
+    readonly filter?: NotificationHistoryFilter;
+    readonly ctx?: BijouContext;
+}
+export type NotificationMouseTargetKind = 'dismiss' | 'action' | 'body';
+export interface NotificationMouseTarget<Msg> {
+    readonly item: NotificationRecord<Msg>;
+    readonly kind: NotificationMouseTargetKind;
+}
+export declare function createNotificationState<Msg>(): NotificationState<Msg>;
+export declare function countNotificationHistory<Msg>(state: NotificationState<Msg>, filter?: NotificationHistoryFilter): number;
+export declare function renderNotificationHistory<Msg>(state: NotificationState<Msg>, options: RenderNotificationHistoryOptions): string;
+export declare function pushNotification<Msg>(state: NotificationState<Msg>, spec: NotificationSpec<Msg>, nowMs: number): NotificationState<Msg>;
+export declare function dismissNotification<Msg>(state: NotificationState<Msg>, id: number, nowMs: number): NotificationState<Msg>;
+export declare function dismissFocusedNotification<Msg>(state: NotificationState<Msg>, nowMs: number): NotificationState<Msg>;
+export declare function relocateNotifications<Msg>(state: NotificationState<Msg>, placement: NotificationPlacement, nowMs?: number): NotificationState<Msg>;
+export declare function cycleNotificationFocus<Msg>(state: NotificationState<Msg>, delta: number): NotificationState<Msg>;
+export declare function activateFocusedNotification<Msg>(state: NotificationState<Msg>, nowMs: number): {
+    readonly state: NotificationState<Msg>;
+    readonly payload?: Msg;
+};
+export declare function tickNotifications<Msg>(state: NotificationState<Msg>, nowMs: number): NotificationState<Msg>;
+export declare function hasNotifications<Msg>(state: NotificationState<Msg>): boolean;
+export declare function notificationsNeedTick<Msg>(state: NotificationState<Msg>): boolean;
+export declare function trimNotificationsToViewport<Msg>(state: NotificationState<Msg>, options: RenderNotificationStackOptions, nowMs?: number): NotificationState<Msg>;
+export declare function hitTestNotificationStack<Msg>(state: NotificationState<Msg>, options: RenderNotificationStackOptions, col: number, row: number): NotificationMouseTarget<Msg> | undefined;
+export declare function renderNotificationStack<Msg>(state: NotificationState<Msg>, options: RenderNotificationStackOptions): readonly Overlay[];
+//# sourceMappingURL=notification.d.ts.map

package/dist/notification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../src/notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAEhB,UAAU,EACX,MAAM,qBAAqB,CAAC;AAO7B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAInD,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AACxE,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,eAAe,GACf,QAAQ,CAAC;AAEb,MAAM,MAAM,yBAAyB,GACjC,KAAK,GACL,YAAY,GACZ,gBAAgB,CAAC;AAErB,MAAM,WAAW,kBAAkB,CAAC,GAAG;IACrC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB,CAAC,GAAG;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IACvC,QAAQ,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACjC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAC3C,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CACtC;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;AAEnE,MAAM,WAAW,kBAAkB,CAAC,GAAG;IACrC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB,CAAC,GAAG;IACpC,QAAQ,CAAC,KAAK,EAAE,SAAS,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;IACnD,QAAQ,CAAC,aAAa,EAAE,SAAS,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;IAC3D,QAAQ,CAAC,OAAO,EAAE,SAAS,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;IACrD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,yBAAyB,CAAC;IAC5C,QAAQ,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,MAAM,2BAA2B,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;AAExE,MAAM,WAAW,uBAAuB,CAAC,GAAG;IAC1C,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACvC,QAAQ,CAAC,IAAI,EAAE,2BAA2B,CAAC;CAC5C;AAsCD,wBAAgB,uBAAuB,CAAC,GAAG,KAAK,iBAAiB,CAAC,GAAG,CAAC,CAOrE;AAWD,wBAAgB,wBAAwB,CAAC,GAAG,EAC1C,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,MAAM,GAAE,yBAAiC,GACxC,MAAM,CAMR;AAqCD,wBAAgB,yBAAyB,CAAC,GAAG,EAC3C,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,OAAO,EAAE,gCAAgC,GACxC,MAAM,CAkDR;AAkED,wBAAgB,gBAAgB,CAAC,GAAG,EAClC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,EAC3B,KAAK,EAAE,MAAM,GACZ,iBAAiB,CAAC,GAAG,CAAC,CA2BxB;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EACrC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,GACZ,iBAAiB,CAAC,GAAG,CAAC,CAgBxB;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAC5C,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,KAAK,EAAE,MAAM,GACZ,iBAAiB,CAAC,GAAG,CAAC,CAGxB;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EACvC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,SAAS,EAAE,qBAAqB,EAChC,KAAK,CAAC,EAAE,MAAM,GACb,iBAAiB,CAAC,GAAG,CAAC,CAoBxB;AAED,wBAAgB,sBAAsB,CAAC,GAAG,EACxC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,KAAK,EAAE,MAAM,GACZ,iBAAiB,CAAC,GAAG,CAAC,CAaxB;AAED,wBAAgB,2BAA2B,CAAC,GAAG,EAC7C,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,KAAK,EAAE,MAAM,GACZ;IAAE,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAA;CAAE,CAQpE;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EACnC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,KAAK,EAAE,MAAM,GACZ,iBAAiB,CAAC,GAAG,CAAC,CA2ExB;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAAG,OAAO,CAE5E;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAAG,OAAO,CAGjF;AAiaD,wBAAgB,2BAA2B,CAAC,GAAG,EAC7C,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,OAAO,EAAE,8BAA8B,EACvC,KAAK,CAAC,EAAE,MAAM,GACb,iBAAiB,CAAC,GAAG,CAAC,CA+BxB;AA8JD,wBAAgB,wBAAwB,CAAC,GAAG,EAC1C,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,OAAO,EAAE,8BAA8B,EACvC,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,uBAAuB,CAAC,GAAG,CAAC,GAAG,SAAS,CAyB1C;AAED,wBAAgB,uBAAuB,CAAC,GAAG,EACzC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAC7B,OAAO,EAAE,8BAA8B,GACtC,SAAS,OAAO,EAAE,CASpB"}