feat: notificationsOutboxRead RPC caller and handler

src/client/callers/index.ts

@@ -46,6 +46,7 @@ import nodesListConnections from './nodesListConnections';
 import nodesPing from './nodesPing';
 import notificationsClear from './notificationsClear';
 import notificationsOutboxClear from './notificationsOutboxClear';
+import notificationsOutboxRead from './notificationsOutboxRead';
 import notificationsRead from './notificationsRead';
 import notificationsSend from './notificationsSend';
 import vaultsClone from './vaultsClone';
@@ -123,6 +124,7 @@ const clientManifest = {
   nodesPing,
   notificationsClear,
   notificationsOutboxClear,
+  notificationsOutboxRead,
   notificationsRead,
   notificationsSend,
   vaultsClone,

src/client/callers/notificationsOutboxRead.ts

@@ -0,0 +1,12 @@
+import type { HandlerTypes } from '@matrixai/rpc';
+import type NotificationsOutboxRead from '../handlers/NotificationsOutboxRead';
+import { ServerCaller } from '@matrixai/rpc';
+
+type CallerTypes = HandlerTypes<NotificationsOutboxRead>;
+
+const notificationsOutboxRead = new ServerCaller<
+  CallerTypes['input'],
+  CallerTypes['output']
+>();
+
+export default notificationsOutboxRead;

src/client/handlers/NotificationsOutboxRead.ts

@@ -0,0 +1,43 @@
+import type { DB } from '@matrixai/db';
+import type {
+  ClientRPCRequestParams,
+  ClientRPCResponseResult,
+  NotificationMessage,
+  NotificationOutboxReadMessage,
+} from '../types';
+import type NotificationsManager from '../../notifications/NotificationsManager';
+import { ServerHandler } from '@matrixai/rpc';
+
+class NotificationsOutboxRead extends ServerHandler<
+  {
+    db: DB;
+    notificationsManager: NotificationsManager;
+  },
+  ClientRPCRequestParams<NotificationOutboxReadMessage>,
+  ClientRPCResponseResult<NotificationMessage>
+> {
+  public async *handle(
+    input: ClientRPCRequestParams<NotificationOutboxReadMessage>,
+    _cancel,
+    _meta,
+    ctx,
+  ): AsyncGenerator<ClientRPCResponseResult<NotificationMessage>> {
+    if (ctx.signal.aborted) throw ctx.signal.reason;
+    const { db, notificationsManager } = this.container;
+    const notifications = await db.withTransactionF((tran) =>
+      notificationsManager.readOutboxNotifications({
+        number: input.number,
+        order: input.order,
+        tran,
+      }),
+    );
+    for (const notification of notifications) {
+      if (ctx.signal.aborted) throw ctx.signal.reason;
+      yield {
+        notification: notification,
+      };
+    }
+  }
+}
+
+export default NotificationsOutboxRead;

src/client/handlers/index.ts

@@ -61,6 +61,7 @@ import NodesListConnections from './NodesListConnections';
 import NodesPing from './NodesPing';
 import NotificationsClear from './NotificationsClear';
 import NotificationsOutboxClear from './NotificationsOutboxClear';
+import NotificationsOutboxRead from './NotificationsOutboxRead';
 import NotificationsRead from './NotificationsRead';
 import NotificationsSend from './NotificationsSend';
 import VaultsClone from './VaultsClone';
@@ -163,6 +164,7 @@ const serverManifest = (container: {
     nodesPing: new NodesPing(container),
     notificationsClear: new NotificationsClear(container),
     notificationsOutboxClear: new NotificationsOutboxClear(container),
+    notificationsOutboxRead: new NotificationsOutboxRead(container),
     notificationsRead: new NotificationsRead(container),
     notificationsSend: new NotificationsSend(container),
     vaultsClone: new VaultsClone(container),

src/client/types.ts

@@ -211,6 +211,11 @@ type NotificationReadMessage = {
   order?: 'newest' | 'oldest';
 };
 
+type NotificationOutboxReadMessage = {
+  number?: number | 'all';
+  order?: 'newest' | 'oldest';
+};
+
 type NotificationMessage = {
   notification: Notification;
 };
@@ -374,6 +379,7 @@ export type {
   SuccessMessage,
   NotificationMessage,
   NotificationReadMessage,
+  NotificationOutboxReadMessage,
   NotificationSendMessage,
   VaultNameMessage,
   VaultIdMessage,