@bopen-io/messagebox-server 1.2.1 → 1.2.3

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

@@ -0,0 +1,179 @@
+import { Logger } from '../../utils/logger.js';
+import { runtimeDeps } from '../../runtimeDeps.js';
+/**
+ * @swagger
+ * /permissions/list:
+ *   get:
+ *     summary: List message permissions for the authenticated user
+ *     description: Retrieve all permissions set by the authenticated user with optional filtering and pagination
+ *     tags:
+ *       - Permissions
+ *     parameters:
+ *       - in: query
+ *         name: messageBox
+ *         required: false
+ *         schema:
+ *           type: string
+ *         description: Optional messageBox type filter (e.g., 'notifications', 'inbox')
+ *       - in: query
+ *         name: limit
+ *         required: false
+ *         schema:
+ *           type: integer
+ *           minimum: 1
+ *           maximum: 1000
+ *           default: 100
+ *         description: Maximum number of permissions to return
+ *       - in: query
+ *         name: offset
+ *         required: false
+ *         schema:
+ *           type: integer
+ *           minimum: 0
+ *           default: 0
+ *         description: Number of permissions to skip for pagination
+ *       - in: query
+ *         name: createdAtOrder
+ *         required: false
+ *         schema:
+ *           type: string
+ *           enum: ['asc', 'desc']
+ *           default: 'desc'
+ *         description: Sort order for created_at date (asc=oldest first, desc=newest first)
+ *     responses:
+ *       200:
+ *         description: Permissions retrieved successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: 'success'
+ *                 permissions:
+ *                   type: array
+ *                   items:
+ *                     type: object
+ *                     properties:
+ *                       sender:
+ *                         type: string
+ *                         nullable: true
+ *                         description: Sender identity key (null for box-wide defaults)
+ *                       messageBox:
+ *                         type: string
+ *                         description: MessageBox type
+ *                       recipientFee:
+ *                         type: integer
+ *                         description: Fee setting (-1=block all, 0=always allow, >0=satoshi amount)
+ *                       created_at:
+ *                         type: string
+ *                         format: date-time
+ *                       updated_at:
+ *                         type: string
+ *                         format: date-time
+ *                 total_count:
+ *                   type: integer
+ *                   description: Total number of permissions (useful for pagination)
+ *       400:
+ *         description: Invalid query parameters
+ *       401:
+ *         description: Unauthorized - authentication required
+ *       500:
+ *         description: Internal server error
+ */
+export default {
+    type: 'get',
+    path: '/permissions/list',
+    /**
+     * List message permissions for the authenticated user
+     *
+     * @param {ListPermissionsRequest} req - Authenticated request with query parameters
+     * @param {Response} res - Express response object
+     * @returns {Promise<Response>} JSON response with permissions list
+     */
+    func: async (req, res) => {
+        Logger.log('[DEBUG] Processing /permissions/list request...');
+        try {
+            // Validate authentication
+            if (req.auth?.identityKey == null) {
+                return res.status(401).json({
+                    status: 'error',
+                    code: 'ERR_UNAUTHORIZED',
+                    description: 'Authentication required'
+                });
+            }
+            // Parse and validate query parameters
+            const { messageBox, limit: limitStr, offset: offsetStr, createdAtOrder } = req.query;
+            const limit = limitStr != null ? Number.parseInt(limitStr, 10) : 100;
+            const offset = offsetStr != null ? Number.parseInt(offsetStr, 10) : 0;
+            const sortOrder = createdAtOrder === 'asc' ? 'asc' : 'desc'; // Default to 'desc'
+            // Validate pagination parameters
+            if (Number.isNaN(limit) || limit < 1 || limit > 1000) {
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_LIMIT',
+                    description: 'Limit must be a number between 1 and 1000'
+                });
+            }
+            if (Number.isNaN(offset) || offset < 0) {
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_OFFSET',
+                    description: 'Offset must be a non-negative number'
+                });
+            }
+            // Validate identity key format
+            const recipientKey = req.auth.identityKey;
+            Logger.log(`[DEBUG] Listing permissions for recipient: ${recipientKey}, messageBox: ${messageBox ?? 'all'}, limit: ${limit}, offset: ${offset}, createdAtOrder: ${sortOrder}`);
+            // Build base query
+            let query = runtimeDeps.knex('message_permissions')
+                .select([
+                'sender',
+                'message_box',
+                'recipient_fee',
+                'created_at',
+                'updated_at'
+            ])
+                .where('recipient', recipientKey)
+                .orderBy([
+                { column: 'message_box', order: 'asc' },
+                { column: 'sender', order: 'asc', nulls: 'first' }, // Box-wide (null) first
+                { column: 'created_at', order: sortOrder }
+            ]);
+            // Apply messageBox filter if provided
+            if (messageBox != null) {
+                query = query.where('message_box', messageBox);
+            }
+            // Get total count for pagination info (before applying limit/offset)
+            const countQuery = query.clone().clearSelect().clearOrder().count('* as count');
+            const [{ count: totalCount }] = await countQuery;
+            const total = Number.parseInt(String(totalCount), 10);
+            // Apply pagination
+            const permissions = await query
+                .limit(limit)
+                .offset(offset);
+            Logger.log(`[DEBUG] Found ${permissions.length} permissions (${total} total)`);
+            return res.status(200).json({
+                status: 'success',
+                permissions: permissions.map(p => ({
+                    sender: p.sender, // null for box-wide defaults
+                    messageBox: p.message_box,
+                    recipientFee: p.recipient_fee,
+                    createdAt: p.created_at,
+                    updatedAt: p.updated_at
+                })),
+                totalCount: total
+            });
+        }
+        catch (error) {
+            Logger.error('[ERROR] Error listing permissions:', error);
+            return res.status(500).json({
+                status: 'error',
+                code: 'ERR_LIST_PERMISSIONS_FAILED',
+                description: 'Failed to list permissions'
+            });
+        }
+    }
+};
+//# sourceMappingURL=listPermissions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"listPermissions.js","sourceRoot":"","sources":["../../../../src/routes/permissions/listPermissions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAWlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG;AACH,eAAe;IACb,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,mBAAmB;IACzB;;;;;;OAMG;IACH,IAAI,EAAE,KAAK,EAAE,GAA2B,EAAE,GAAa,EAAqB,EAAE;QAC5E,MAAM,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAA;QAE7D,IAAI,CAAC;YACH,0BAA0B;YAC1B,IAAI,GAAG,CAAC,IAAI,EAAE,WAAW,IAAI,IAAI,EAAE,CAAC;gBAClC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,kBAAkB;oBACxB,WAAW,EAAE,yBAAyB;iBACvC,CAAC,CAAA;YACJ,CAAC;YAED,sCAAsC;YACtC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,GAAG,GAAG,CAAC,KAAK,CAAA;YAEpF,MAAM,KAAK,GAAG,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;YACpE,MAAM,MAAM,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACrE,MAAM,SAAS,GAAG,cAAc,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAA,CAAC,oBAAoB;YAEhF,iCAAiC;YACjC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;gBACrD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,mBAAmB;oBACzB,WAAW,EAAE,2CAA2C;iBACzD,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,oBAAoB;oBAC1B,WAAW,EAAE,sCAAsC;iBACpD,CAAC,CAAA;YACJ,CAAC;YAED,+BAA+B;YAC/B,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,WAAW,CAAA;YAEzC,MAAM,CAAC,GAAG,CAAC,8CAA8C,YAAY,iBAAiB,UAAU,IAAI,KAAK,YAAY,KAAK,aAAa,MAAM,qBAAqB,SAAS,EAAE,CAAC,CAAA;YAE9K,mBAAmB;YACnB,IAAI,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC;iBAChD,MAAM,CAAC;gBACN,QAAQ;gBACR,aAAa;gBACb,eAAe;gBACf,YAAY;gBACZ,YAAY;aACb,CAAC;iBACD,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC;iBAChC,OAAO,CAAC;gBACP,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE;gBACvC,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,wBAAwB;gBAC5E,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE;aAC3C,CAAC,CAAA;YAEJ,sCAAsC;YACtC,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,CAAA;YAChD,CAAC;YAED,qEAAqE;YACrE,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;YAC/E,MAAM,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,GAAG,MAAM,UAAU,CAAA;YAChD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAA;YAErD,mBAAmB;YACnB,MAAM,WAAW,GAAG,MAAM,KAAK;iBAC5B,KAAK,CAAC,KAAK,CAAC;iBACZ,MAAM,CAAC,MAAM,CAAC,CAAA;YAEjB,MAAM,CAAC,GAAG,CAAC,iBAAiB,WAAW,CAAC,MAAM,iBAAiB,KAAK,SAAS,CAAC,CAAA;YAE9E,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,SAAS;gBACjB,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBACjC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,6BAA6B;oBAC/C,UAAU,EAAE,CAAC,CAAC,WAAW;oBACzB,YAAY,EAAE,CAAC,CAAC,aAAa;oBAC7B,SAAS,EAAE,CAAC,CAAC,UAAU;oBACvB,SAAS,EAAE,CAAC,CAAC,UAAU;iBACxB,CAAC,CAAC;gBACH,UAAU,EAAE,KAAK;aAClB,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAA;YACzD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,6BAA6B;gBACnC,WAAW,EAAE,4BAA4B;aAC1C,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CACF,CAAA"}

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

@@ -0,0 +1,137 @@
+import { PublicKey } from '@bsv/sdk';
+import { Logger } from '../../utils/logger.js';
+import { setMessagePermission } from '../../utils/messagePermissions.js';
+/**
+ * @swagger
+ * /permissions/set:
+ *   post:
+ *     summary: Set message permission for a sender/box combination or box-wide default
+ *     description: Set permission level for receiving messages. If sender is provided, sets permission for that specific sender. If sender is omitted, sets box-wide default for all senders.
+ *     tags:
+ *       - Permissions
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - messageBox
+ *               - recipientFee
+ *             properties:
+ *               sender:
+ *                 type: string
+ *                 description: identityKey of the sender (optional - if omitted, sets box-wide default for all senders)
+ *               messageBox:
+ *                 type: string
+ *                 description: messageBox type (e.g., 'notifications', 'inbox')
+ *               recipientFee:
+ *                 type: integer
+ *                 description: Fee level (-1=blocked, 0=always allow, >0=satoshi amount required)
+ *     responses:
+ *       200:
+ *         description: Permission successfully set/updated
+ *       400:
+ *         description: Invalid request data
+ *       401:
+ *         description: Authentication required
+ *       500:
+ *         description: Internal server error
+ */
+export default {
+    type: 'post',
+    path: '/permissions/set',
+    func: async (req, res) => {
+        try {
+            Logger.log('[DEBUG] Processing set message permission request');
+            // Validate authentication
+            const recipient = req.auth?.identityKey;
+            if (recipient == null) {
+                Logger.log('[DEBUG] Authentication required for set permission');
+                return res.status(401).json({
+                    status: 'error',
+                    code: 'ERR_AUTHENTICATION_REQUIRED',
+                    description: 'Authentication required.'
+                });
+            }
+            const { sender, messageBox, recipientFee } = req.body;
+            // Validate request body (sender is optional)
+            if (messageBox == null || typeof recipientFee !== 'number') {
+                Logger.log('[DEBUG] Invalid request body for set permission');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_REQUEST',
+                    description: 'messageBox (string) and recipientFee (number) are required. sender (string) is optional for box-wide settings.'
+                });
+            }
+            // Validate sender public key format only 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.'
+                    });
+                }
+            }
+            // Validate recipientFee value
+            if (!Number.isInteger(recipientFee)) {
+                Logger.log('[DEBUG] Invalid recipientFee value - must be integer');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_FEE_VALUE',
+                    description: 'recipientFee must be an integer (-1, 0, or positive number).'
+                });
+            }
+            // Validate messageBox value
+            if (typeof messageBox !== 'string' || messageBox.trim() === '') {
+                Logger.log('[DEBUG] Invalid messageBox value');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_MESSAGE_BOX',
+                    description: 'messageBox must be a non-empty string.'
+                });
+            }
+            // Set the message permission (convert undefined sender to null for box-wide)
+            const success = await setMessagePermission(recipient, sender ?? null, messageBox, recipientFee);
+            if (success == null) {
+                return res.status(500).json({
+                    status: 'error',
+                    code: 'ERR_DATABASE_ERROR',
+                    description: 'Failed to update message permission.'
+                });
+            }
+            const isBoxWide = sender == null;
+            Logger.log(`[DEBUG] Successfully updated message permission: ${sender ?? 'BOX-WIDE'} -> ${recipient} (${messageBox}), fee: ${recipientFee}`);
+            let description;
+            const senderText = isBoxWide ? 'all senders' : sender;
+            const actionText = isBoxWide ? 'Box-wide default for' : 'Messages from';
+            if (recipientFee === -1) {
+                description = `${actionText} ${senderText} to ${messageBox} ${isBoxWide ? 'is' : 'are'} now blocked.`;
+            }
+            else if (recipientFee === 0) {
+                description = `${actionText} ${senderText} to ${messageBox} ${isBoxWide ? 'is' : 'are'} now always allowed.`;
+            }
+            else {
+                description = `${actionText} ${senderText} to ${messageBox} now require${isBoxWide ? 's' : ''} ${recipientFee} satoshis.`;
+            }
+            return res.status(200).json({
+                status: 'success',
+                description
+            });
+        }
+        catch (error) {
+            Logger.error('[ERROR] Internal Server Error in set permission:', error);
+            return res.status(500).json({
+                status: 'error',
+                code: 'ERR_INTERNAL',
+                description: 'An internal error has occurred.'
+            });
+        }
+    }
+};
+//# sourceMappingURL=setPermission.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setPermission.js","sourceRoot":"","sources":["../../../../src/routes/permissions/setPermission.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAE9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AAUxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAe;IACb,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,KAAK,EAAE,GAA6B,EAAE,GAAa,EAAqB,EAAE;QAC9E,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAA;YAE/D,0BAA0B;YAC1B,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,EAAE,WAAW,CAAA;YACvC,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;gBACtB,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,YAAY,EAAE,GAAG,GAAG,CAAC,IAAI,CAAA;YAErD,6CAA6C;YAC7C,IAAI,UAAU,IAAI,IAAI,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;gBAC3D,MAAM,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAA;gBAC7D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,qBAAqB;oBAC3B,WAAW,EAAE,gHAAgH;iBAC9H,CAAC,CAAA;YACJ,CAAC;YAED,qDAAqD;YACrD,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,8BAA8B;YAC9B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;gBACpC,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,uBAAuB;oBAC7B,WAAW,EAAE,8DAA8D;iBAC5E,CAAC,CAAA;YACJ,CAAC;YAED,4BAA4B;YAC5B,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC/D,MAAM,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAA;gBAC9C,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,yBAAyB;oBAC/B,WAAW,EAAE,wCAAwC;iBACtD,CAAC,CAAA;YACJ,CAAC;YAED,6EAA6E;YAC7E,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,SAAS,EAAE,MAAM,IAAI,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC,CAAA;YAE/F,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,oBAAoB;oBAC1B,WAAW,EAAE,sCAAsC;iBACpD,CAAC,CAAA;YACJ,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,IAAI,IAAI,CAAA;YAChC,MAAM,CAAC,GAAG,CAAC,oDAAoD,MAAM,IAAI,UAAU,OAAO,SAAS,KAAK,UAAU,WAAW,YAAY,EAAE,CAAC,CAAA;YAE5I,IAAI,WAAmB,CAAA;YACvB,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAA;YACrD,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,eAAe,CAAA;YAEvE,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxB,WAAW,GAAG,GAAG,UAAU,IAAI,UAAU,OAAO,UAAU,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,eAAe,CAAA;YACvG,CAAC;iBAAM,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;gBAC9B,WAAW,GAAG,GAAG,UAAU,IAAI,UAAU,OAAO,UAAU,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,sBAAsB,CAAA;YAC9G,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,GAAG,UAAU,IAAI,UAAU,OAAO,UAAU,eAAe,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,YAAY,CAAA;YAC3H,CAAC;YAED,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,MAAM,EAAE,SAAS;gBACjB,WAAW;aACZ,CAAC,CAAA;QACJ,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/registerDevice.js

@@ -0,0 +1,139 @@
+import { Logger } from '../utils/logger.js';
+import { runtimeDeps } from '../runtimeDeps.js';
+/**
+ * @swagger
+ * /registerDevice:
+ *   post:
+ *     summary: Register device for push notifications
+ *     description: Register a device's FCM token for receiving push notifications
+ *     tags:
+ *       - Device
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - fcmToken
+ *             properties:
+ *               fcmToken:
+ *                 type: string
+ *                 description: Firebase Cloud Messaging token
+ *               deviceId:
+ *                 type: string
+ *                 description: Optional device identifier
+ *               platform:
+ *                 type: string
+ *                 description: Device platform (ios, android, web)
+ *                 enum: [ios, android, web]
+ *     responses:
+ *       200:
+ *         description: Device registered successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: success
+ *                 message:
+ *                   type: string
+ *                   example: Device registered successfully
+ *                 deviceId:
+ *                   type: integer
+ *                   description: Database ID of the registered device
+ *       400:
+ *         description: Invalid request parameters
+ *       401:
+ *         description: Authentication required
+ *       500:
+ *         description: Internal server error
+ */
+export default {
+    type: 'post',
+    path: '/registerDevice',
+    func: async (req, res) => {
+        try {
+            Logger.log('[DEBUG] Processing device registration request');
+            // Validate authentication
+            const identityKey = req.auth?.identityKey;
+            if (identityKey == null) {
+                Logger.log('[DEBUG] Authentication required for device registration');
+                return res.status(401).json({
+                    status: 'error',
+                    code: 'ERR_AUTHENTICATION_REQUIRED',
+                    description: 'Authentication required.'
+                });
+            }
+            const { fcmToken, deviceId, platform } = req.body;
+            // Validate required fields
+            if (fcmToken == null || typeof fcmToken !== 'string' || fcmToken.trim() === '') {
+                Logger.log('[DEBUG] Invalid FCM token provided');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_FCM_TOKEN',
+                    description: 'fcmToken is required and must be a non-empty string.'
+                });
+            }
+            // Validate platform if provided
+            const validPlatforms = ['ios', 'android', 'web'];
+            if (platform != null && !validPlatforms.includes(platform)) {
+                Logger.log('[DEBUG] Invalid platform provided');
+                return res.status(400).json({
+                    status: 'error',
+                    code: 'ERR_INVALID_PLATFORM',
+                    description: 'platform must be one of: ios, android, web'
+                });
+            }
+            try {
+                // Insert or update device registration
+                const now = new Date();
+                const [deviceRegistrationId] = await runtimeDeps.knex('device_registrations')
+                    .insert({
+                    identity_key: identityKey,
+                    fcm_token: fcmToken.trim(),
+                    device_id: deviceId?.trim() ?? null,
+                    platform: platform ?? null,
+                    created_at: now,
+                    updated_at: now,
+                    active: true,
+                    last_used: now
+                })
+                    .onConflict('fcm_token')
+                    .merge({
+                    identity_key: identityKey, // Update identity key in case token was reassigned
+                    device_id: deviceId?.trim() ?? null,
+                    platform: platform ?? null,
+                    updated_at: now,
+                    active: true,
+                    last_used: now
+                });
+                Logger.log(`[DEBUG] Device registered successfully: ${identityKey} with token ending in ...${fcmToken.slice(-10)}`);
+                return res.status(200).json({
+                    status: 'success',
+                    message: 'Device registered successfully for push notifications',
+                    deviceId: deviceRegistrationId
+                });
+            }
+            catch (dbError) {
+                Logger.error('[ERROR] Database error during device registration:', dbError);
+                return res.status(500).json({
+                    status: 'error',
+                    code: 'ERR_DATABASE_ERROR',
+                    description: 'Failed to register device.'
+                });
+            }
+        }
+        catch (error) {
+            Logger.error('[ERROR] Internal Server Error in registerDevice:', error);
+            return res.status(500).json({
+                status: 'error',
+                code: 'ERR_INTERNAL',
+                description: 'An internal error has occurred.'
+            });
+        }
+    }
+};
+//# sourceMappingURL=registerDevice.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"registerDevice.js","sourceRoot":"","sources":["../../../src/routes/registerDevice.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAU/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AAEH,eAAe;IACb,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,KAAK,EAAE,GAA0B,EAAE,GAAa,EAAqB,EAAE;QAC3E,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAA;YAE5D,0BAA0B;YAC1B,MAAM,WAAW,GAAG,GAAG,CAAC,IAAI,EAAE,WAAW,CAAA;YACzC,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAA;gBACrE,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,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC,IAAI,CAAA;YAEjD,2BAA2B;YAC3B,IAAI,QAAQ,IAAI,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC/E,MAAM,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAA;gBAChD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,uBAAuB;oBAC7B,WAAW,EAAE,sDAAsD;iBACpE,CAAC,CAAA;YACJ,CAAC;YAED,gCAAgC;YAChC,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;YAChD,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3D,MAAM,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAA;gBAC/C,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,sBAAsB;oBAC5B,WAAW,EAAE,4CAA4C;iBAC1D,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,CAAC;gBACH,uCAAuC;gBACvC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;gBACtB,MAAM,CAAC,oBAAoB,CAAC,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,sBAAsB,CAAC;qBAC1E,MAAM,CAAC;oBACN,YAAY,EAAE,WAAW;oBACzB,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE;oBAC1B,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,IAAI;oBACnC,QAAQ,EAAE,QAAQ,IAAI,IAAI;oBAC1B,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,GAAG;oBACf,MAAM,EAAE,IAAI;oBACZ,SAAS,EAAE,GAAG;iBACf,CAAC;qBACD,UAAU,CAAC,WAAW,CAAC;qBACvB,KAAK,CAAC;oBACL,YAAY,EAAE,WAAW,EAAE,mDAAmD;oBAC9E,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,IAAI;oBACnC,QAAQ,EAAE,QAAQ,IAAI,IAAI;oBAC1B,UAAU,EAAE,GAAG;oBACf,MAAM,EAAE,IAAI;oBACZ,SAAS,EAAE,GAAG;iBACf,CAAC,CAAA;gBAEJ,MAAM,CAAC,GAAG,CAAC,2CAA2C,WAAW,4BAA4B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;gBAEnH,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,SAAS;oBACjB,OAAO,EAAE,uDAAuD;oBAChE,QAAQ,EAAE,oBAAoB;iBAC/B,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,OAAY,EAAE,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,oDAAoD,EAAE,OAAO,CAAC,CAAA;gBAC3E,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC1B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,oBAAoB;oBAC1B,WAAW,EAAE,4BAA4B;iBAC1C,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"}