@voltro/plugin-notifications 0.24.0 → 0.26.0

package/dist/index.d.ts

@@ -127,6 +127,8 @@ export declare interface InboxItem {
     readonly body: string;
     readonly data: Record<string, unknown>;
     readonly readAt: string | null;
+    /** When the user cleared it out of the inbox. A different state from read. */
+    readonly archivedAt: string | null;
     readonly createdAt: string;
     readonly tenantId: string | null;
 }
@@ -139,6 +141,17 @@ export declare const inboxTable: Table<"_voltro_notification_inbox", FieldDefini
     readonly body: ColumnBuilder<string, "text", boolean>;
     readonly data: ColumnBuilder<Record<string, unknown>, "json", boolean>;
     readonly readAt: ColumnBuilder<Date | null, "timestamp", boolean>;
+    /**
+     * ARCHIVED is a different state from READ, and for a user the more important
+     * one: it is what empties the inbox.
+     *
+     * Reported as the reason an app could not adopt this plugin. `readAt` covers
+     * read and `status` on the delivery table is the delivery outcome
+     * ('sent' | 'failed' | 'skipped') — neither is an archive, and the word did
+     * not appear anywhere in this plugin's types. An inbox a user cannot clear is
+     * one they stop opening.
+     */
+    readonly archivedAt: ColumnBuilder<Date | null, "timestamp", boolean>;
     readonly createdAt: ColumnBuilder<Date, "timestamp", true>;
     readonly tenantId: ColumnBuilder<string | null, "text", boolean>;
 }>, true, "byInboxSubject">;
@@ -166,6 +179,13 @@ export declare interface NotificationServiceShape {
     }) => Promise<ReadonlyArray<InboxItem>>;
     readonly unreadCount: (subjectId: string) => Promise<number>;
     readonly markRead: (id: string, subjectId: string) => Promise<boolean>;
+    /** Undo a read. An inbox without the way back is a one-way ratchet. */
+    readonly markUnread: (id: string, subjectId: string) => Promise<boolean>;
+    /** Read everything; returns how many rows changed. */
+    readonly markAllRead: (subjectId: string) => Promise<number>;
+    /** Archive / unarchive. A different state from read — and the one that
+     *  empties the inbox, which is why it matters more to a user. */
+    readonly setArchived: (id: string, subjectId: string, archived: boolean) => Promise<boolean>;
     readonly getPreferences: (subjectId: string) => Promise<ReadonlyArray<ChannelPreference>>;
     readonly setPreference: (pref: ChannelPreference) => Promise<void>;
     readonly subscribe: (topic: string, subjectId: string, tenantId?: string | null) => Promise<void>;
@@ -198,7 +218,7 @@ export declare interface NotificationsPluginOptions {
 }
 
 export declare interface NotificationStore {
-    readonly addInbox: (item: Omit<InboxItem, 'id' | 'readAt' | 'createdAt'> & {
+    readonly addInbox: (item: Omit<InboxItem, 'id' | 'readAt' | 'archivedAt' | 'createdAt'> & {
         id: string;
         createdAt: string;
     }) => Promise<void>;
@@ -207,6 +227,13 @@ export declare interface NotificationStore {
         limit?: number;
     }) => Promise<ReadonlyArray<InboxItem>>;
     readonly markRead: (id: string, subjectId: string) => Promise<boolean>;
+    /** Clear the read stamp — an inbox needs the way back, not just forward. */
+    readonly markUnread: (id: string, subjectId: string) => Promise<boolean>;
+    /** Read EVERYTHING for this subject. Returns how many rows changed. */
+    readonly markAllRead: (subjectId: string) => Promise<number>;
+    /** Archive / unarchive — a different state from read, and the one that
+     *  actually empties the inbox. */
+    readonly setArchived: (id: string, subjectId: string, archived: boolean) => Promise<boolean>;
     readonly unreadCount: (subjectId: string) => Promise<number>;
     readonly getPreferences: (subjectId: string) => Promise<ReadonlyArray<ChannelPreference>>;
     readonly setPreference: (pref: ChannelPreference) => Promise<void>;