@bopen-io/messagebox-server 1.2.2 → 1.2.3

package/out/src/routes/listMessages.js

@@ -0,0 +1,176 @@
+/**
+ * @file listMessages.ts
+ * @description
+ * This route allows an authenticated user to retrieve messages from a specific named messageBox.
+ *
+ * Messages are only returned if the authenticated identity has access to the specified messageBox.
+ * If the messageBox does not exist, an empty message list is returned.
+ *
+ * Typical usage: Inbox or queue retrieval for real-time or deferred message delivery.
+ */
+import { log } from '../utils/logger.js';
+import { runtimeDeps } from '../runtimeDeps.js';
+/**
+ * @openapi
+ * /listMessages:
+ *   post:
+ *     summary: Retrieve messages from a specific messageBox
+ *     description: |
+ *       Returns all stored messages for the specified messageBox that belong to the authenticated identity.
+ *       If the box does not exist or has no messages, an empty array is returned.
+ *     tags:
+ *       - Message
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               messageBox:
+ *                 type: string
+ *                 description: The name of the messageBox to retrieve messages from
+ *     responses:
+ *       200:
+ *         description: Successfully retrieved messages (can be empty)
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: success
+ *                 messages:
+ *                   type: array
+ *                   items:
+ *                     type: object
+ *                     properties:
+ *                       messageId:
+ *                         type: string
+ *                       body:
+ *                         type: string
+ *                       sender:
+ *                         type: string
+ *                       createdAt:
+ *                         type: string
+ *                         format: date-time
+ *                       updatedAt:
+ *                         type: string
+ *                         format: date-time
+ *       400:
+ *         description: Invalid or missing messageBox name
+ *       500:
+ *         description: Internal server/database error
+ */
+/**
+ * @exports
+ * Route definition used by the Express router to expose the `/listMessages` POST endpoint.
+ * Responsible for querying stored messages from a messageBox owned by the authenticated user.
+ */
+export default {
+    type: 'post',
+    path: '/listMessages',
+    get knex() { return runtimeDeps.knex; },
+    summary: 'Use this route to list messages from your messageBox.',
+    parameters: {
+        messageBox: 'The name of the messageBox you would like to list messages from.'
+    },
+    exampleResponse: {
+        status: 'success',
+        messages: [
+            {
+                messageId: '3301',
+                body: '{}',
+                sender: '028d37b941208cd6b8a4c28288eda5f2f16c2b3ab0fcb6d13c18b47fe37b971fc1'
+            }
+        ]
+    },
+    /**
+   * @function func
+   * @description
+   * Express handler for listing stored messages in a specified messageBox.
+   *
+   * Input:
+   * - `req.body.messageBox`: Name of the messageBox to retrieve messages from.
+   * - `req.auth.identityKey`: Authenticated user’s public identity key.
+   *
+   * Behavior:
+   * - Checks if the specified messageBox exists for the identity.
+   * - If found, returns all messages in that messageBox.
+   * - If not found, returns an empty array.
+   * - Normalizes all message bodies to strings for consistent output.
+   *
+   * Output:
+   * - 200 with `{ status: 'success', messages: [...] }`
+   * - 400 if input is missing or malformed.
+   * - 500 on internal server/database errors.
+   *
+   * @param {ListMessagesRequest} req - Authenticated request containing the messageBox name
+   * @param {Response} res - Express response object
+   * @returns {Promise<Response>} JSON response containing message records or an error
+   */
+    func: async (req, res) => {
+        try {
+            const { messageBox } = req.body;
+            // Validate a messageBox is provided and is a string
+            if (messageBox == null || messageBox === '') {
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_MESSAGEBOX_REQUIRED',
+                    description: 'Please provide the name of a valid MessageBox!'
+                });
+            }
+            if (typeof messageBox !== 'string') {
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_MESSAGEBOX',
+                    description: 'MessageBox name must be a string!'
+                });
+            }
+            // Find the messageBox ID for this user
+            const [messageBoxRecord] = await runtimeDeps.knex('messageBox')
+                .where({
+                identityKey: req.auth?.identityKey,
+                type: messageBox
+            })
+                .select('messageBoxId');
+            // Return empty array if no messageBox was found
+            if (messageBoxRecord === undefined) {
+                return res.status(200).json({
+                    status: 'success',
+                    messages: []
+                });
+            }
+            // Retrieve all messages associated with the messageBox
+            const messages = await runtimeDeps.knex('messages')
+                .where({
+                recipient: req.auth?.identityKey,
+                messageBoxId: messageBoxRecord.messageBoxId
+            })
+                .select('messageId', 'body', 'sender', 'created_at', 'updated_at');
+            // Normalize all message bodies to strings and convert to camelCase
+            const formattedMessages = messages.map(message => ({
+                messageId: message.messageId,
+                body: typeof message.body === 'string' ? message.body : JSON.stringify(message.body),
+                sender: message.sender,
+                createdAt: message.created_at,
+                updatedAt: message.updated_at
+            }));
+            // Return a list of matching messages
+            return res.status(200).json({
+                status: 'success',
+                messages: formattedMessages
+            });
+        }
+        catch (e) {
+            log.error({ operation: 'messages.list', outcome: 'error', err: e }, 'Failed to list messages');
+            return res.status(500).json({
+                status: 'error',
+                code: 'ERR_INTERNAL_ERROR',
+                description: 'An internal error has occurred while listing messages.'
+            });
+        }
+    }
+};
+//# sourceMappingURL=listMessages.js.map

package/out/src/routes/listMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listMessages.js","sourceRoot":"","sources":["../../../src/routes/listMessages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAW/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AAEH;;;;GAIG;AACH,eAAe;IACb,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,eAAe;IACrB,IAAI,IAAI,KAAM,OAAO,WAAW,CAAC,IAAI,CAAA,CAAC,CAAC;IACvC,OAAO,EAAE,uDAAuD;IAChE,UAAU,EAAE;QACV,UAAU,EAAE,kEAAkE;KAC/E;IACD,eAAe,EAAE;QACf,MAAM,EAAE,SAAS;QACjB,QAAQ,EAAE;YACR;gBACE,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,oEAAoE;aAC7E;SACF;KACF;IACD;;;;;;;;;;;;;;;;;;;;;;;KAuBC;IACD,IAAI,EAAE,KAAK,EAAE,GAAwB,EAAE,GAAa,EAAqB,EAAE;QACzE,IAAI,CAAC;YACH,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,IAAI,CAAA;YAE/B,oDAAoD;YACpD,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;gBAC5C,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,yBAAyB;oBAC/B,WAAW,EAAE,gDAAgD;iBAC9D,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBACnC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,wBAAwB;oBAC9B,WAAW,EAAE,mCAAmC;iBACjD,CAAC,CAAA;YACJ,CAAC;YAED,uCAAuC;YACvC,MAAM,CAAC,gBAAgB,CAAC,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC;iBAC5D,KAAK,CAAC;gBACL,WAAW,EAAE,GAAG,CAAC,IAAI,EAAE,WAAW;gBAClC,IAAI,EAAE,UAAU;aACjB,CAAC;iBACD,MAAM,CAAC,cAAc,CAAC,CAAA;YAEzB,gDAAgD;YAChD,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;gBACnC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,SAAS;oBACjB,QAAQ,EAAE,EAAE;iBACb,CAAC,CAAA;YACJ,CAAC;YAED,uDAAuD;YACvD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC;iBAChD,KAAK,CAAC;gBACL,SAAS,EAAE,GAAG,CAAC,IAAI,EAAE,WAAW;gBAChC,YAAY,EAAE,gBAAgB,CAAC,YAAY;aAC5C,CAAC;iBACD,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,CAAC,CAAA;YAEpE,mEAAmE;YACnE,MAAM,iBAAiB,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACjD,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,IAAI,EAAE,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;gBACpF,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS,EAAE,OAAO,CAAC,UAAU;gBAC7B,SAAS,EAAE,OAAO,CAAC,UAAU;aAC9B,CAAC,CAAC,CAAA;YAEH,qCAAqC;YACrC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,SAAS;gBACjB,QAAQ,EAAE,iBAAiB;aAC5B,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,GAAG,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,yBAAyB,CAAC,CAAA;YAC9F,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,oBAAoB;gBAC1B,WAAW,EAAE,wDAAwD;aACtE,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CACF,CAAA"}

package/out/src/routes/permissions/getPermission.js

@@ -0,0 +1,138 @@
+import { PublicKey } from '@bsv/sdk';
+import { Logger } from '../../utils/logger.js';
+import { runtimeDeps } from '../../runtimeDeps.js';
+/**
+ * @swagger
+ * /permissions/get:
+ *   get:
+ *     summary: Get message permission for a sender/box combination
+ *     description: Retrieve the permission setting for a specific sender and message box combination
+ *     tags:
+ *       - Permissions
+ *     parameters:
+ *       - in: query
+ *         name: sender
+ *         required: false
+ *         schema:
+ *           type: string
+ *         description: identityKey of the sender to check (omit for box-wide default)
+ *       - in: query
+ *         name: messageBox
+ *         required: true
+ *         schema:
+ *           type: string
+ *         description: messageBox type to check
+ *     responses:
+ *       200:
+ *         description: Permission setting retrieved successfully (or undefined if not set)
+ *       400:
+ *         description: Invalid request parameters
+ *       401:
+ *         description: Authentication required
+ *       500:
+ *         description: Internal server error
+ */
+export default {
+    type: 'get',
+    path: '/permissions/get',
+    func: async (req, res) => {
+        try {
+            Logger.log('[DEBUG] Processing get message permission request');
+            // Validate authentication
+            if (req.auth?.identityKey == null) {
+                Logger.log('[DEBUG] Authentication required for get permission');
+                return res.status(401).json({
+                    status: 'error',
+                    code: 'ERR_AUTHENTICATION_REQUIRED',
+                    description: 'Authentication required.'
+                });
+            }
+            const { sender, messageBox } = req.query;
+            // Validate required parameters
+            if (messageBox == null) {
+                Logger.log('[DEBUG] Missing required parameters for get permission');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_MISSING_PARAMETERS',
+                    description: 'messageBox parameter is required.'
+                });
+            }
+            // Validate sender public key format if provided
+            if (sender != null) {
+                try {
+                    PublicKey.fromString(sender);
+                }
+                catch (error) {
+                    Logger.log('[DEBUG] Invalid sender public key format');
+                    return res.status(400).json({
+                        status: 'error',
+                        code: 'ERR_INVALID_PUBLIC_KEY',
+                        description: 'Invalid sender public key format.'
+                    });
+                }
+            }
+            const recipient = req.auth.identityKey;
+            // Get message permission directly from database
+            const whereClause = {
+                recipient,
+                message_box: messageBox
+            };
+            // Add sender condition (null for box-wide, specific sender for sender-specific)
+            if (sender != null) {
+                whereClause.sender = sender;
+            }
+            else {
+                whereClause.sender = null;
+            }
+            const permission = await runtimeDeps.knex('message_permissions')
+                .where(whereClause)
+                .select('recipient_fee', 'created_at', 'updated_at')
+                .first();
+            Logger.log(`[DEBUG] Permission record for ${sender ?? 'box-wide'} -> ${recipient} (${messageBox}): ${JSON.stringify(permission)}`);
+            if (permission != null) {
+                // Helper function to determine status from recipient fee
+                const getStatusFromFee = (fee) => {
+                    if (fee === -1)
+                        return 'blocked';
+                    if (fee === 0)
+                        return 'always_allow';
+                    return 'payment_required';
+                };
+                // Permission is set, return it
+                return res.status(200).json({
+                    status: 'success',
+                    description: sender != null
+                        ? `Permission setting found for sender ${sender} to ${messageBox}.`
+                        : `Box-wide permission setting found for ${messageBox}.`,
+                    permission: {
+                        sender: sender ?? null,
+                        messageBox,
+                        recipientFee: permission.recipient_fee,
+                        status: getStatusFromFee(permission.recipient_fee),
+                        createdAt: permission.created_at.toISOString(),
+                        updatedAt: permission.updated_at.toISOString()
+                    }
+                });
+            }
+            else {
+                // No permission set, return undefined
+                return res.status(200).json({
+                    status: 'success',
+                    description: sender != null
+                        ? `No permission setting found for sender ${sender} to ${messageBox}.`
+                        : `No box-wide permission setting found for ${messageBox}.`,
+                    permission: undefined
+                });
+            }
+        }
+        catch (error) {
+            Logger.error('[ERROR] Internal Server Error in get permission:', error);
+            return res.status(500).json({
+                status: 'error',
+                code: 'ERR_INTERNAL',
+                description: 'An internal error has occurred.'
+            });
+        }
+    }
+};
+//# sourceMappingURL=getPermission.js.map

package/out/src/routes/permissions/getPermission.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPermission.js","sourceRoot":"","sources":["../../../../src/routes/permissions/getPermission.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAE9C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AASlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAe;IACb,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,KAAK,EAAE,GAAyB,EAAE,GAAa,EAAqB,EAAE;QAC1E,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAA;YAE/D,0BAA0B;YAC1B,IAAI,GAAG,CAAC,IAAI,EAAE,WAAW,IAAI,IAAI,EAAE,CAAC;gBAClC,MAAM,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAA;gBAChE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,6BAA6B;oBACnC,WAAW,EAAE,0BAA0B;iBACxC,CAAC,CAAA;YACJ,CAAC;YAED,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,KAAK,CAAA;YAExC,+BAA+B;YAC/B,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,CAAC,GAAG,CAAC,wDAAwD,CAAC,CAAA;gBACpE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,wBAAwB;oBAC9B,WAAW,EAAE,mCAAmC;iBACjD,CAAC,CAAA;YACJ,CAAC;YAED,gDAAgD;YAChD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,IAAI,CAAC;oBACH,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;gBAC9B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAA;oBACtD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBAC1B,MAAM,EAAE,OAAO;wBACf,IAAI,EAAE,wBAAwB;wBAC9B,WAAW,EAAE,mCAAmC;qBACjD,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;YAED,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,WAAW,CAAA;YAEtC,gDAAgD;YAChD,MAAM,WAAW,GAAQ;gBACvB,SAAS;gBACT,WAAW,EAAE,UAAU;aACxB,CAAA;YAED,gFAAgF;YAChF,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,WAAW,CAAC,MAAM,GAAG,MAAM,CAAA;YAC7B,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,MAAM,GAAG,IAAI,CAAA;YAC3B,CAAC;YAED,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC;iBAC7D,KAAK,CAAC,WAAW,CAAC;iBAClB,MAAM,CAAC,eAAe,EAAE,YAAY,EAAE,YAAY,CAAC;iBACnD,KAAK,EAAE,CAAA;YAEV,MAAM,CAAC,GAAG,CAAC,iCAAiC,MAAM,IAAI,UAAU,OAAO,SAAS,KAAK,UAAU,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;YAElI,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,yDAAyD;gBACzD,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAmD,EAAE;oBACxF,IAAI,GAAG,KAAK,CAAC,CAAC;wBAAE,OAAO,SAAS,CAAA;oBAChC,IAAI,GAAG,KAAK,CAAC;wBAAE,OAAO,cAAc,CAAA;oBACpC,OAAO,kBAAkB,CAAA;gBAC3B,CAAC,CAAA;gBAED,+BAA+B;gBAC/B,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,SAAS;oBACjB,WAAW,EAAE,MAAM,IAAI,IAAI;wBACzB,CAAC,CAAC,uCAAuC,MAAM,OAAO,UAAU,GAAG;wBACnE,CAAC,CAAC,yCAAyC,UAAU,GAAG;oBAC1D,UAAU,EAAE;wBACV,MAAM,EAAE,MAAM,IAAI,IAAI;wBACtB,UAAU;wBACV,YAAY,EAAE,UAAU,CAAC,aAAa;wBACtC,MAAM,EAAE,gBAAgB,CAAC,UAAU,CAAC,aAAa,CAAC;wBAClD,SAAS,EAAE,UAAU,CAAC,UAAU,CAAC,WAAW,EAAE;wBAC9C,SAAS,EAAE,UAAU,CAAC,UAAU,CAAC,WAAW,EAAE;qBAC/C;iBACF,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,sCAAsC;gBACtC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,SAAS;oBACjB,WAAW,EAAE,MAAM,IAAI,IAAI;wBACzB,CAAC,CAAC,0CAA0C,MAAM,OAAO,UAAU,GAAG;wBACtE,CAAC,CAAC,4CAA4C,UAAU,GAAG;oBAC7D,UAAU,EAAE,SAAS;iBACtB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,kDAAkD,EAAE,KAAK,CAAC,CAAA;YACvE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,iCAAiC;aAC/C,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CACF,CAAA"}

package/out/src/routes/permissions/getQuote.js

@@ -0,0 +1,165 @@
+import { PublicKey } from '@bsv/sdk';
+import { Logger, log } from '../../utils/logger.js';
+import { getRecipientFee, getServerDeliveryFee } from '../../utils/messagePermissions.js';
+/**
+ * @swagger
+ * /permissions/quote:
+ *   get:
+ *     summary: Get message delivery quote(s)
+ *     description: Get pricing information for sending messages to one or many recipients' message boxes
+ *     tags:
+ *       - Permissions
+ *     parameters:
+ *       - in: query
+ *         name: recipient
+ *         required: true
+ *         schema:
+ *           oneOf:
+ *             - type: string
+ *             - type: array
+ *               items:
+ *                 type: string
+ *         description: identityKey of the recipient, or multiple recipients by repeating the parameter (?recipient=A&recipient=B)
+ *       - in: query
+ *         name: messageBox
+ *         required: true
+ *         schema:
+ *           type: string
+ *         description: messageBox type
+ *     responses:
+ *       200:
+ *         description: Quote(s) retrieved successfully
+ *       400:
+ *         description: Invalid request parameters
+ *       401:
+ *         description: Authentication required
+ *       500:
+ *         description: Internal server error
+ */
+export default {
+    type: 'get',
+    path: '/permissions/quote',
+    func: async (req, res) => {
+        try {
+            Logger.log('[DEBUG] Processing message quote request');
+            log.debug({ operation: 'permissions.quote' }, 'Processing message quote request');
+            // Validate authentication (the caller is the SENDER)
+            const sender = req.auth?.identityKey;
+            if (sender == null) {
+                Logger.log('[DEBUG] Authentication required for message quote');
+                return res.status(401).json({
+                    status: 'error',
+                    code: 'ERR_AUTHENTICATION_REQUIRED',
+                    description: 'Authentication required.'
+                });
+            }
+            const { recipient, messageBox } = req.query;
+            // Required params
+            if (recipient == null || messageBox == null) {
+                Logger.log('[DEBUG] Missing required parameters for message quote');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_MISSING_PARAMETERS',
+                    description: 'recipient and messageBox parameters are required.'
+                });
+            }
+            // Normalize recipients to array (preserve order)
+            const recipients = Array.isArray(recipient) ? recipient : [recipient];
+            if (recipients.length === 0) {
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_MISSING_PARAMETERS',
+                    description: 'At least one recipient is required.'
+                });
+            }
+            // Validate each recipient public key
+            const invalidIdx = [];
+            for (let i = 0; i < recipients.length; i++) {
+                try {
+                    PublicKey.fromString(recipients[i]);
+                }
+                catch {
+                    invalidIdx.push(i);
+                }
+            }
+            if (invalidIdx.length > 0) {
+                Logger.log('[DEBUG] Invalid recipient public key format in array');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_PUBLIC_KEY',
+                    description: `Invalid recipient public key at index(es): ${invalidIdx.join(', ')}.`
+                });
+            }
+            // Delivery fee for this messageBox (applies per message/recipient)
+            const perMessageDeliveryFee = await getServerDeliveryFee(messageBox);
+            // Single-recipient path → keep legacy response shape for compatibility
+            if (recipients.length === 1) {
+                const recipientKey = recipients[0];
+                const recipientFee = await getRecipientFee(recipientKey, sender, messageBox);
+                return res.status(200).json({
+                    status: 'success',
+                    description: 'Message delivery quote generated.',
+                    quote: {
+                        deliveryFee: perMessageDeliveryFee,
+                        recipientFee
+                    }
+                });
+            }
+            // Multi-recipient path → compute per-recipient, plus aggregates
+            const quotesByRecipient = [];
+            const blockedRecipients = [];
+            let totalRecipientFees = 0;
+            let totalDeliveryFees = 0;
+            // Helper to map fee -> status
+            const feeToStatus = (fee) => {
+                if (fee === -1)
+                    return 'blocked';
+                if (fee === 0)
+                    return 'always_allow';
+                return 'payment_required';
+            };
+            for (const r of recipients) {
+                const recipientFee = await getRecipientFee(r, sender, messageBox);
+                const status = feeToStatus(recipientFee);
+                quotesByRecipient.push({
+                    recipient: r,
+                    messageBox,
+                    deliveryFee: perMessageDeliveryFee,
+                    recipientFee,
+                    status
+                });
+                // Aggregate: count deliveryFee per intended message, and recipientFee if not blocked
+                totalDeliveryFees += perMessageDeliveryFee;
+                if (recipientFee === -1) {
+                    blockedRecipients.push(r);
+                }
+                else {
+                    totalRecipientFees += recipientFee;
+                }
+            }
+            const totals = {
+                deliveryFees: totalDeliveryFees,
+                recipientFees: totalRecipientFees,
+                // If any are blocked, caller may want to handle those separately.
+                // We still provide a full monetary total for non-blocked recipients:
+                totalForPayableRecipients: totalDeliveryFees + totalRecipientFees
+            };
+            return res.status(200).json({
+                status: 'success',
+                description: `Message delivery quotes generated for ${recipients.length} recipients.`,
+                quotesByRecipient,
+                totals,
+                blockedRecipients
+            });
+        }
+        catch (error) {
+            Logger.error('[ERROR] Internal Server Error in message quote:', error);
+            return res.status(500).json({
+                status: 'error',
+                code: 'ERR_INTERNAL',
+                description: 'An internal error has occurred.'
+            });
+        }
+    }
+};
+//# sourceMappingURL=getQuote.js.map

package/out/src/routes/permissions/getQuote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getQuote.js","sourceRoot":"","sources":["../../../../src/routes/permissions/getQuote.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAEnD,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AASzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAe;IACb,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,KAAK,EAAE,GAAoB,EAAE,GAAa,EAAqB,EAAE;QACrE,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAA;YACtD,GAAG,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,EAAE,kCAAkC,CAAC,CAAA;YAEjF,qDAAqD;YACrD,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,WAAW,CAAA;YACpC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAA;gBAC/D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,6BAA6B;oBACnC,WAAW,EAAE,0BAA0B;iBACxC,CAAC,CAAA;YACJ,CAAC;YAED,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,KAAK,CAAA;YAE3C,kBAAkB;YAClB,IAAI,SAAS,IAAI,IAAI,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBAC5C,MAAM,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAA;gBACnE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,wBAAwB;oBAC9B,WAAW,EAAE,mDAAmD;iBACjE,CAAC,CAAA;YACJ,CAAC;YAED,iDAAiD;YACjD,MAAM,UAAU,GAAa,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;YAE/E,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,wBAAwB;oBAC9B,WAAW,EAAE,qCAAqC;iBACnD,CAAC,CAAA;YACJ,CAAC;YAED,qCAAqC;YACrC,MAAM,UAAU,GAAa,EAAE,CAAA;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,IAAI,CAAC;oBACH,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;gBACrC,CAAC;gBAAC,MAAM,CAAC;oBACP,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACpB,CAAC;YACH,CAAC;YACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,CAAC,GAAG,CAAC,sDAAsD,CAAC,CAAA;gBAClE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,wBAAwB;oBAC9B,WAAW,EAAE,8CAA8C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;iBACpF,CAAC,CAAA;YACJ,CAAC;YAED,mEAAmE;YACnE,MAAM,qBAAqB,GAAG,MAAM,oBAAoB,CAAC,UAAU,CAAC,CAAA;YAEpE,uEAAuE;YACvE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;gBAClC,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,CAAA;gBAE5E,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,SAAS;oBACjB,WAAW,EAAE,mCAAmC;oBAChD,KAAK,EAAE;wBACL,WAAW,EAAE,qBAAqB;wBAClC,YAAY;qBACb;iBACF,CAAC,CAAA;YACJ,CAAC;YAED,gEAAgE;YAChE,MAAM,iBAAiB,GAMlB,EAAE,CAAA;YAEP,MAAM,iBAAiB,GAAa,EAAE,CAAA;YACtC,IAAI,kBAAkB,GAAG,CAAC,CAAA;YAC1B,IAAI,iBAAiB,GAAG,CAAC,CAAA;YAEzB,8BAA8B;YAC9B,MAAM,WAAW,GAAG,CAAC,GAAW,EAAmD,EAAE;gBACnF,IAAI,GAAG,KAAK,CAAC,CAAC;oBAAE,OAAO,SAAS,CAAA;gBAChC,IAAI,GAAG,KAAK,CAAC;oBAAE,OAAO,cAAc,CAAA;gBACpC,OAAO,kBAAkB,CAAA;YAC3B,CAAC,CAAA;YAED,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;gBAC3B,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAA;gBACjE,MAAM,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,CAAA;gBAExC,iBAAiB,CAAC,IAAI,CAAC;oBACrB,SAAS,EAAE,CAAC;oBACZ,UAAU;oBACV,WAAW,EAAE,qBAAqB;oBAClC,YAAY;oBACZ,MAAM;iBACP,CAAC,CAAA;gBAEF,qFAAqF;gBACrF,iBAAiB,IAAI,qBAAqB,CAAA;gBAC1C,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;oBACxB,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBAC3B,CAAC;qBAAM,CAAC;oBACN,kBAAkB,IAAI,YAAY,CAAA;gBACpC,CAAC;YACH,CAAC;YAED,MAAM,MAAM,GAAG;gBACb,YAAY,EAAE,iBAAiB;gBAC/B,aAAa,EAAE,kBAAkB;gBACjC,kEAAkE;gBAClE,qEAAqE;gBACrE,yBAAyB,EAAE,iBAAiB,GAAG,kBAAkB;aAClE,CAAA;YAED,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,SAAS;gBACjB,WAAW,EAAE,yCAAyC,UAAU,CAAC,MAAM,cAAc;gBACrF,iBAAiB;gBACjB,MAAM;gBACN,iBAAiB;aAClB,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,iDAAiD,EAAE,KAAK,CAAC,CAAA;YACtE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,iCAAiC;aAC/C,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CACF,CAAA"}

package/out/src/routes/permissions/index.js

@@ -0,0 +1,12 @@
+// Export all permission-related routes
+import setPermission from './setPermission.js';
+import getPermission from './getPermission.js';
+import getQuote from './getQuote.js';
+import listPermissions from './listPermissions.js';
+export const permissionRoutes = [
+    setPermission,
+    getPermission,
+    getQuote,
+    listPermissions
+];
+//# sourceMappingURL=index.js.map

package/out/src/routes/permissions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/routes/permissions/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,OAAO,aAAa,MAAM,oBAAoB,CAAA;AAC9C,OAAO,aAAa,MAAM,oBAAoB,CAAA;AAC9C,OAAO,QAAQ,MAAM,eAAe,CAAA;AACpC,OAAO,eAAe,MAAM,sBAAsB,CAAA;AAElD,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,aAAa;IACb,aAAa;IACb,QAAQ;IACR,eAAe;CAChB,CAAA"}