@bopen-io/messagebox-server 1.2.2 → 1.2.3

package/out/types/src/routes/permissions/getQuote.d.ts

@@ -0,0 +1,50 @@
+import { Response } from 'express';
+import { AuthRequest } from '@bsv/auth-express-middleware';
+export interface GetQuoteRequest extends AuthRequest {
+    query: {
+        recipient: string | string[];
+        messageBox?: string;
+    };
+}
+/**
+ * @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
+ */
+declare const _default: {
+    type: string;
+    path: string;
+    func: (req: GetQuoteRequest, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=getQuote.d.ts.map

package/out/types/src/routes/permissions/getQuote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getQuote.d.ts","sourceRoot":"","sources":["../../../../../src/routes/permissions/getQuote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGlC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAG1D,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;QAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;;;;gBAIiB,eAAe,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AAHtE,wBA+IC"}

package/out/types/src/routes/permissions/index.d.ts

@@ -0,0 +1,18 @@
+export declare const permissionRoutes: ({
+    type: string;
+    path: string;
+    func: (req: import("./setPermission.js").SetPermissionRequestType, res: import("express").Response) => Promise<import("express").Response>;
+} | {
+    type: string;
+    path: string;
+    func: (req: import("./getPermission.js").GetPermissionRequest, res: import("express").Response) => Promise<import("express").Response>;
+} | {
+    type: string;
+    path: string;
+    func: (req: import("./getQuote.js").GetQuoteRequest, res: import("express").Response) => Promise<import("express").Response>;
+} | {
+    type: string;
+    path: string;
+    func: (req: import("./listPermissions.js").ListPermissionsRequest, res: import("express").Response) => Promise<import("express").Response>;
+})[];
+//# sourceMappingURL=index.d.ts.map

package/out/types/src/routes/permissions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/routes/permissions/index.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;IAK5B,CAAA"}

package/out/types/src/routes/permissions/listPermissions.d.ts

@@ -0,0 +1,106 @@
+import { Response } from 'express';
+import { AuthRequest } from '@bsv/auth-express-middleware';
+export interface ListPermissionsRequest extends AuthRequest {
+    query: {
+        messageBox?: string;
+        limit?: string;
+        offset?: string;
+        createdAtOrder?: string;
+    };
+}
+/**
+ * @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
+ */
+declare const _default: {
+    type: string;
+    path: string;
+    /**
+     * 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: (req: ListPermissionsRequest, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=listPermissions.d.ts.map

package/out/types/src/routes/permissions/listPermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listPermissions.d.ts","sourceRoot":"","sources":["../../../../../src/routes/permissions/listPermissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAI1D,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,KAAK,EAAE;QACL,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG;;;;IAID;;;;;;OAMG;gBACe,sBAAsB,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AAV7E,wBAyGC"}

package/out/types/src/routes/permissions/setPermission.d.ts

@@ -0,0 +1,53 @@
+import { Response } from 'express';
+import { AuthRequest } from '@bsv/auth-express-middleware';
+export interface SetPermissionRequestType extends AuthRequest {
+    body: {
+        sender?: string;
+        messageBox: string;
+        recipientFee: number;
+    };
+}
+/**
+ * @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
+ */
+declare const _default: {
+    type: string;
+    path: string;
+    func: (req: SetPermissionRequestType, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=setPermission.d.ts.map

package/out/types/src/routes/permissions/setPermission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setPermission.d.ts","sourceRoot":"","sources":["../../../../../src/routes/permissions/setPermission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGlC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAG1D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,IAAI,EAAE;QACJ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,EAAE,MAAM,CAAA;QAClB,YAAY,EAAE,MAAM,CAAA;KACrB,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;;;;gBAIiB,wBAAwB,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AAH/E,wBAuGC"}

package/out/types/src/routes/registerDevice.d.ts

@@ -0,0 +1,67 @@
+import { Response } from 'express';
+import { AuthRequest } from '@bsv/auth-express-middleware';
+export interface RegisterDeviceRequest extends AuthRequest {
+    body: {
+        fcmToken: string;
+        deviceId?: string;
+        platform?: string;
+    };
+}
+/**
+ * @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
+ */
+declare const _default: {
+    type: string;
+    path: string;
+    func: (req: RegisterDeviceRequest, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=registerDevice.d.ts.map

package/out/types/src/routes/registerDevice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registerDevice.d.ts","sourceRoot":"","sources":["../../../../src/routes/registerDevice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAG1D,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACxD,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;;;;gBAKiB,qBAAqB,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AAH5E,wBAyFC"}

package/out/types/src/routes/sendMessage.d.ts

@@ -0,0 +1,140 @@
+/**
+ * @file sendMessage.ts
+ * @description
+ * Route handler to send a message to another identity's messageBox.
+ * This route is used for P2P communication in the MessageBox system.
+ *
+ * It handles:
+ * - Validation of message structure
+ * - Validation of the recipient public key
+ * - MessageBox creation if one doesn't exist
+ * - Insertion of the message into the database
+ * - Deduplication based on messageId
+ *
+ */
+import { Response } from 'express';
+import { AtomicBEEF, Base64String, BasketStringUnder300Bytes, BooleanDefaultTrue, DescriptionString5to50Bytes, LabelStringUnder300Bytes, OutputTagStringUnder300Bytes, PositiveIntegerOrZero, PubKeyHex } from '@bsv/sdk';
+import { AuthRequest } from '@bsv/auth-express-middleware';
+export interface Message {
+    recipient: PubKeyHex | PubKeyHex[];
+    recipients?: PubKeyHex[];
+    messageBox: string;
+    messageId: string | string[];
+    body: string;
+}
+export interface Payment {
+    tx: AtomicBEEF;
+    outputs: Array<{
+        outputIndex: PositiveIntegerOrZero;
+        protocol: 'wallet payment' | 'basket insertion';
+        paymentRemittance?: {
+            derivationPrefix: Base64String;
+            derivationSuffix: Base64String;
+            senderIdentityKey: PubKeyHex;
+            customInstructions?: unknown;
+        };
+        insertionRemittance?: {
+            basket: BasketStringUnder300Bytes;
+            customInstructions?: string;
+            tags?: OutputTagStringUnder300Bytes[];
+        };
+    }>;
+    description: DescriptionString5to50Bytes;
+    labels?: LabelStringUnder300Bytes[];
+    seekPermission?: BooleanDefaultTrue;
+}
+export interface SendMessageRequest extends AuthRequest {
+    body: {
+        message?: Message;
+        payment?: Payment;
+    };
+}
+/**
+ * @function calculateMessagePrice
+ * @description Determines the price (in satoshis) to send a message, optionally with priority.
+ */
+export declare function calculateMessagePrice(message: string, priority?: boolean): number;
+/**
+ * @openapi
+ * /sendMessage:
+ *   post:
+ *     summary: Send a message to a recipient’s message box
+ *     description: |
+ *       Inserts a message into the target recipient’s message box on the server.
+ *       The recipient, message box name, and message ID must be provided.
+ *     tags:
+ *       - Message
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               message:
+ *                 type: object
+ *                 required:
+ *                   - recipient
+ *                   - messageBox
+ *                   - messageId
+ *                   - body
+ *                 properties:
+ *                   recipient:
+ *                     type: string
+ *                     description: Identity key of the recipient
+ *                   messageBox:
+ *                     type: string
+ *                     description: The name of the recipient's message box
+ *                   messageId:
+ *                     type: string
+ *                     description: Unique identifier for the message (usually an HMAC)
+ *                   body:
+ *                     oneOf:
+ *                       - type: string
+ *                       - type: object
+ *                     description: The message content
+ *     responses:
+ *       200:
+ *         description: Message stored successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: success
+ *                 messageId:
+ *                   type: string
+ *                 message:
+ *                   type: string
+ *       400:
+ *         description: Invalid request or duplicate message
+ *       500:
+ *         description: Internal server error
+ */
+/**
+ * @exports
+ * Express-compatible route definition for `/sendMessage`, used to send messages to other users.
+ * Contains metadata for auto-generation of route documentation and Swagger/OpenAPI integration.
+ */
+declare const _default: {
+    type: string;
+    path: string;
+    readonly knex: import("knex").Knex<any, any[]>;
+    summary: string;
+    parameters: {
+        message: {
+            recipient: string;
+            messageBox: string;
+            messageId: string;
+            body: string;
+        };
+    };
+    exampleResponse: {
+        status: string;
+    };
+    func: (req: SendMessageRequest, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=sendMessage.d.ts.map

package/out/types/src/routes/sendMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendMessage.d.ts","sourceRoot":"","sources":["../../../../src/routes/sendMessage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,EACL,UAAU,EACV,YAAY,EACZ,yBAAyB,EACzB,kBAAkB,EAClB,2BAA2B,EAC3B,wBAAwB,EACxB,4BAA4B,EAC5B,qBAAqB,EACrB,SAAS,EAEV,MAAM,UAAU,CAAA;AAEjB,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAQ1D,MAAM,WAAW,OAAO;IAEtB,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,CAAA;IAClC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC5B,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,UAAU,CAAA;IACd,OAAO,EAAE,KAAK,CAAC;QACb,WAAW,EAAE,qBAAqB,CAAA;QAClC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,CAAA;QAC/C,iBAAiB,CAAC,EAAE;YAClB,gBAAgB,EAAE,YAAY,CAAA;YAC9B,gBAAgB,EAAE,YAAY,CAAA;YAC9B,iBAAiB,EAAE,SAAS,CAAA;YAK5B,kBAAkB,CAAC,EAAE,OAAO,CAAA;SAC7B,CAAA;QACD,mBAAmB,CAAC,EAAE;YACpB,MAAM,EAAE,yBAAyB,CAAA;YACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;YAC3B,IAAI,CAAC,EAAE,4BAA4B,EAAE,CAAA;SACtC,CAAA;KACF,CAAC,CAAA;IACF,WAAW,EAAE,2BAA2B,CAAA;IACxC,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACnC,cAAc,CAAC,EAAE,kBAAkB,CAAA;CACpC;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,IAAI,EAAE;QACJ,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,CAAA;CACF;AAOD;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAe,GAAG,MAAM,CAIxF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAEH;;;;GAIG;;;;;;;;;;;;;;;;;gBAgBiB,kBAAkB,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AAfzE,wBAmXC"}

package/out/types/src/runtimeDeps.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Injectable knex/wallet for route handlers.
+ * Binary entry and mountMessageBoxRoutes call bindMessageBoxRuntime before serving.
+ */
+import type { Knex } from 'knex';
+import type { WalletInterface } from '@bsv/sdk';
+/** Bound before serving; routes read knex/wallet from here. */
+export declare const runtimeDeps: {
+    knex: Knex;
+    wallet?: WalletInterface;
+};
+export declare function bindMessageBoxRuntime(deps: {
+    knex: Knex;
+    wallet?: WalletInterface;
+}): void;
+export declare function getWallet(): Promise<WalletInterface>;
+//# sourceMappingURL=runtimeDeps.d.ts.map

package/out/types/src/runtimeDeps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeDeps.d.ts","sourceRoot":"","sources":["../../../src/runtimeDeps.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAChC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE/C,+DAA+D;AAC/D,eAAO,MAAM,WAAW,EAAE;IACxB,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,CAAC,EAAE,eAAe,CAAA;CAGzB,CAAA;AAED,wBAAgB,qBAAqB,CAAE,IAAI,EAAE;IAC3C,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,GAAG,IAAI,CAGP;AAED,wBAAsB,SAAS,IAAK,OAAO,CAAC,eAAe,CAAC,CAK3D"}

package/out/types/src/swagger.d.ts

@@ -0,0 +1,3 @@
+import { Express } from 'express';
+export declare function setupSwagger(app: Express): void;
+//# sourceMappingURL=swagger.d.ts.map

package/out/types/src/swagger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.d.ts","sourceRoot":"","sources":["../../../src/swagger.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEjC,wBAAgB,YAAY,CAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAiDhD"}

package/out/types/src/telemetry.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=telemetry.d.ts.map

package/out/types/src/telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../../../src/telemetry.ts"],"names":[],"mappings":""}

package/out/types/src/types/messagePermissions.d.ts

@@ -0,0 +1,15 @@
+import { PubKeyHex } from '@bsv/sdk';
+export interface MessagePermission {
+    id: number;
+    recipient: PubKeyHex;
+    sender: PubKeyHex | null;
+    message_box: string;
+    recipient_fee: number;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface FeeCalculationResult {
+    deliveryFee: number;
+    recipientFee: number;
+}
+//# sourceMappingURL=messagePermissions.d.ts.map

package/out/types/src/types/messagePermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messagePermissions.d.ts","sourceRoot":"","sources":["../../../../src/types/messagePermissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAGpC,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,SAAS,CAAA;IACpB,MAAM,EAAE,SAAS,GAAG,IAAI,CAAA;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;CACjB;AAGD,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;CACrB"}

package/out/types/src/types/notifications.d.ts

@@ -0,0 +1,20 @@
+import { PubKeyHex } from '@bsv/sdk';
+export interface EncryptedNotificationPayload {
+    title?: string;
+}
+export interface NotificationPayment {
+    amount: number;
+    recipient: PubKeyHex;
+}
+export interface FCMPayload {
+    title: string;
+    body: string;
+    icon?: string;
+    badge?: number;
+    data?: Record<string, string>;
+}
+export interface SendNotificationResult {
+    success: boolean;
+    messageId: string;
+}
+//# sourceMappingURL=notifications.d.ts.map

package/out/types/src/types/notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../../../../src/types/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAGpC,MAAM,WAAW,4BAA4B;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAGD,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,SAAS,CAAA;CAErB;AAGD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB"}

package/out/types/src/utils/logger.d.ts

@@ -0,0 +1,17 @@
+import pino from 'pino';
+export declare const log: pino.Logger<never, boolean>;
+/**
+ * Backwards-compatible static facade over the structured logger. Existing
+ * Logger.log/warn/error call sites keep working but now emit structured,
+ * trace-correlated records. `enable`/`disable` toggle info/warn verbosity;
+ * errors are always emitted.
+ */
+export declare class Logger {
+    private static isEnabled;
+    static enable(): void;
+    static disable(): void;
+    static log(...args: unknown[]): void;
+    static warn(...args: unknown[]): void;
+    static error(...args: unknown[]): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/out/types/src/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../../src/utils/logger.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AAoCvB,eAAO,MAAM,GAAG,6BAAa,CAAA;AAsB7B;;;;;GAKG;AAEH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAQ;IAEhC,MAAM,CAAC,MAAM,IAAI,IAAI;IAIrB,MAAM,CAAC,OAAO,IAAI,IAAI;IAItB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMpC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMrC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;CAGvC"}

package/out/types/src/utils/messagePermissions.d.ts

@@ -0,0 +1,29 @@
+import { PubKeyHex } from '@bsv/sdk';
+/**
+ * Fee calculation result structure
+ */
+export interface FeeCalculationResult {
+    delivery_fee: number;
+    recipient_fee: number;
+    total_cost: number;
+    allowed: boolean;
+    requires_payment: boolean;
+    blocked_reason?: string;
+}
+/**
+ * Get server delivery fee for a message box type
+ */
+export declare function getServerDeliveryFee(messageBox: string): Promise<number>;
+/**
+ * Get recipient fee for a sender/messageBox combination with hierarchical fallback
+ */
+export declare function getRecipientFee(recipient: PubKeyHex, sender: PubKeyHex | null, messageBox: string): Promise<number>;
+/**
+ * Set message permission for a sender/recipient/messageBox combination
+ */
+export declare function setMessagePermission(recipient: PubKeyHex, sender: PubKeyHex | null, messageBox: string, recipientFee: number): Promise<boolean>;
+/**
+ * Check if FCM delivery should be used for this message box
+ */
+export declare function shouldUseFCMDelivery(messageBox: string): boolean;
+//# sourceMappingURL=messagePermissions.d.ts.map

package/out/types/src/utils/messagePermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messagePermissions.d.ts","sourceRoot":"","sources":["../../../../src/utils/messagePermissions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAGpC;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,gBAAgB,EAAE,OAAO,CAAA;IACzB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAY9E;AAED;;GAEG;AACH,wBAAsB,eAAe,CACnC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,GAAG,IAAI,EACxB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,CAoDjB;AAeD;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,SAAS,GAAG,IAAI,EACxB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,OAAO,CAAC,CAyBlB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAEhE"}

package/out/types/src/utils/sendFCMNotification.d.ts

@@ -0,0 +1,22 @@
+import { PubKeyHex } from '@bsv/sdk';
+/**
+ * FCM Payload interface
+ */
+export interface FCMPayload {
+    title: string;
+    messageId: string;
+    originator?: string;
+}
+/**
+ * FCM notification result
+ */
+export interface SendNotificationResult {
+    success: boolean;
+    error?: string;
+}
+/**
+ * Send FCM push notification to all registered devices for a recipient
+ * Looks up FCM tokens from device_registrations table and sends to all active devices
+ */
+export declare function sendFCMNotification(recipient: PubKeyHex, payload: FCMPayload): Promise<SendNotificationResult>;
+//# sourceMappingURL=sendFCMNotification.d.ts.map

package/out/types/src/utils/sendFCMNotification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendFCMNotification.d.ts","sourceRoot":"","sources":["../../../../src/utils/sendFCMNotification.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAGpC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CACvC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,CAiHjC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bopen-io/messagebox-server",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "main": "./out/src/compose.js",
   "exports": {
     ".": {