@bopen-io/messagebox-server 1.2.2 → 1.2.3

package/out/types/jest.config.d.ts

@@ -0,0 +1,4 @@
+import type { JestConfigWithTsJest } from 'ts-jest';
+declare const config: JestConfigWithTsJest;
+export default config;
+//# sourceMappingURL=jest.config.d.ts.map

package/out/types/jest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.d.ts","sourceRoot":"","sources":["../../jest.config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD,QAAA,MAAM,MAAM,EAAE,oBA6Bb,CAAA;AAED,eAAe,MAAM,CAAA"}

package/out/types/jest.config.integration.d.ts

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+import type { JestConfigWithTsJest } from 'ts-jest';
+declare const config: JestConfigWithTsJest;
+export default config;
+//# sourceMappingURL=jest.config.integration.d.ts.map

package/out/types/jest.config.integration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.integration.d.ts","sourceRoot":"","sources":["../../jest.config.integration.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD,QAAA,MAAM,MAAM,EAAE,oBAoBb,CAAA;AAED,eAAe,MAAM,CAAA"}

package/out/types/knexfile.d.ts

@@ -0,0 +1,6 @@
+import type { Knex } from 'knex';
+declare const knexfile: {
+    [key: string]: Knex.Config;
+};
+export default knexfile;
+//# sourceMappingURL=knexfile.d.ts.map

package/out/types/knexfile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knexfile.d.ts","sourceRoot":"","sources":["../../knexfile.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAqBhC,QAAA,MAAM,QAAQ,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;CAI3C,CAAA;AAED,eAAe,QAAQ,CAAA"}

package/out/types/src/__tests/compose.test.d.ts

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

package/out/types/src/__tests/compose.test.d.ts.map

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

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

@@ -0,0 +1,63 @@
+/**
+ * @file app.ts
+ * @description
+ * Initializes the MessageBoxServer Express app.
+ *
+ * Responsibilities:
+ * - Parses environment variables and loads config
+ * - Sets up Knex for DB access
+ * - Initializes WalletClient from the BSV SDK
+ * - Mounts Express routes (pre-auth and post-auth)
+ * - Applies auth middleware using wallet identity
+ *
+ * This file exports:
+ * - `app`: the configured Express instance
+ * - `walletReady`: a promise that resolves once the wallet is ready
+ * - `getWallet()`: async accessor for the WalletClient
+ * - `useRoutes()`: middleware + route initialization
+ * - `appReady`: promise that completes once all setup is done
+ */
+import { Express } from 'express';
+import { Knex } from 'knex';
+import type { WalletInterface } from '@bsv/sdk';
+export declare const app: Express;
+/**
+ * Knex instance connected based on environment (development, production, or staging).
+ */
+export declare const knex: Knex;
+export declare const walletReady: Promise<void>;
+/**
+ * @function initializeWallet
+ * @description Initializes the WalletClient with a root identity key and storage backend.
+ *
+ * Loads configuration from the environment and connects to the wallet service.
+ *
+ * @returns {Promise<void>} Resolves when the wallet is initialized.
+ * @throws If SERVER_PRIVATE_KEY is missing or invalid.
+ */
+export declare function initializeWallet(): Promise<void>;
+/**
+ * @function getWallet
+ * @description Waits for the WalletClient to be ready and returns the instance.
+ *
+ * @returns {Promise<WalletInterface>} The initialized wallet client
+ * @throws {Error} If called before the wallet is initialized
+ */
+export declare function getWallet(): Promise<WalletInterface>;
+export declare const appReady: Promise<void>;
+/**
+ * @function useRoutes
+ * @description Registers all routes and middleware on the Express app instance.
+ *
+ * Steps:
+ * - Applies JSON body parser
+ * - Enables CORS headers for all routes
+ * - Waits for WalletClient to initialize
+ * - Adds authentication middleware
+ * - Mounts pre-auth and post-auth route handlers
+ *
+ * @returns {Promise<void>} Once all middleware and routes are mounted
+ * @throws If wallet is not available when needed
+ */
+export declare function useRoutes(): Promise<void>;
+//# sourceMappingURL=app.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAGH,OAAgB,EACd,OAAO,EAKR,MAAM,SAAS,CAAA;AAMhB,OAAgB,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAEpC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAW/C,eAAO,MAAM,GAAG,EAAE,OAAmB,CAAA;AAgBrC;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,IAQlB,CAAA;AAKD,eAAO,MAAM,WAAW,eAEtB,CAAA;AAEF;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,IAAK,OAAO,CAAC,IAAI,CAAC,CAavD;AAED;;;;;;GAMG;AACH,wBAAsB,SAAS,IAAK,OAAO,CAAC,eAAe,CAAC,CAM3D;AAGD,eAAO,MAAM,QAAQ,eAGjB,CAAA;AAEJ;;;;;;;;;;;;;GAaG;AACH,wBAAsB,SAAS,IAAK,OAAO,CAAC,IAAI,CAAC,CAoEhD"}

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

@@ -0,0 +1,22 @@
+/**
+ * Composable entrypoints for embedding messagebox in a parent app.
+ * Standalone binary continues to use index.ts → app.ts as before.
+ */
+import { type Express } from 'express';
+import type { Server as HttpServer } from 'node:http';
+import { AuthSocketServer } from '@bsv/authsocket';
+import type { MessageBoxContext } from './context.js';
+export { createMessageBoxContext } from './context.js';
+export type { MessageBoxContext, CreateMessageBoxContextOptions } from './context.js';
+export declare function createMessageBoxApp(): Express;
+/**
+ * Mount messagebox HTTP routes on an Express app.
+ * Auth/payment middleware apply only to this router (not the parent app).
+ */
+export declare function mountMessageBoxRoutes(app: Express, ctx: MessageBoxContext): void;
+/**
+ * Attach authenticated WebSocket handlers. Mirrors standalone index.ts behavior
+ * with injected wallet/knex instead of module singletons.
+ */
+export declare function attachMessageBoxWebSockets(httpServer: HttpServer, ctx: MessageBoxContext): AuthSocketServer | null;
+//# sourceMappingURL=compose.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"compose.d.ts","sourceRoot":"","sources":["../../../src/compose.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAgB,EACd,KAAK,OAAO,EAMb,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,WAAW,CAAA;AAIrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAMlD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAErD,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA;AACtD,YAAY,EAAE,iBAAiB,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAA;AAKrF,wBAAgB,mBAAmB,IAAK,OAAO,CAE9C;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB,GAAG,IAAI,CAuDjF;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,EACtB,GAAG,EAAE,iBAAiB,GACrB,gBAAgB,GAAG,IAAI,CAsLzB"}

package/out/types/src/config/firebase.d.ts

@@ -0,0 +1,34 @@
+import { type App } from 'firebase-admin/app';
+import { type Messaging } from 'firebase-admin/messaging';
+import { type Firestore } from 'firebase-admin/firestore';
+/**
+ * Initialize Firebase Admin SDK.
+ * Returns null (and logs a warning) when ENABLE_FIREBASE is not 'true',
+ * or when FIREBASE_PROJECT_ID is absent, so the server can run without Firebase.
+ */
+export declare function initializeFirebase(): App | null;
+/**
+ * Get Firebase Messaging instance, or null if Firebase is not initialized.
+ */
+export declare function getFirebaseMessaging(): Messaging | null;
+/**
+ * Get Firestore instance
+ */
+export declare function getFirebaseFirestore(): Firestore;
+interface FCMPayload {
+    title: string;
+    body: string;
+    icon?: string;
+    badge?: number;
+    data?: Record<string, string>;
+}
+interface SendNotificationResult {
+    success: boolean;
+    messageId: string;
+}
+/**
+ * Send a push notification via FCM
+ */
+export declare function sendNotification(fcmToken: string, payload: FCMPayload): Promise<SendNotificationResult>;
+export {};
+//# sourceMappingURL=firebase.d.ts.map

package/out/types/src/config/firebase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"firebase.d.ts","sourceRoot":"","sources":["../../../../src/config/firebase.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4D,KAAK,GAAG,EAAE,MAAM,oBAAoB,CAAA;AACvG,OAAO,EAAgB,KAAK,SAAS,EAAgB,MAAM,0BAA0B,CAAA;AACrF,OAAO,EAAgB,KAAK,SAAS,EAAE,MAAM,0BAA0B,CAAA;AASvE;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,GAAG,GAAG,IAAI,CA4E/C;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,SAAS,GAAG,IAAI,CAKvD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,SAAS,CAOhD;AAED,UAAU,UAAU;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,UAAU,sBAAsB;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,sBAAsB,CAAC,CA+CjC"}

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

@@ -0,0 +1,23 @@
+import type { Knex } from 'knex';
+import type { WalletInterface } from '@bsv/sdk';
+import type { Request } from 'express';
+export interface MessageBoxContext {
+    wallet: WalletInterface;
+    knex: Knex;
+    routingPrefix: string;
+    enableWebSockets: boolean;
+    enableSwagger: boolean;
+    calculateRequestPrice: (req: Request) => Promise<number> | number;
+    logger: Console;
+}
+export interface CreateMessageBoxContextOptions {
+    wallet: WalletInterface;
+    knex: Knex;
+    routingPrefix?: string;
+    enableWebSockets?: boolean;
+    enableSwagger?: boolean;
+    calculateRequestPrice?: (req: Request) => Promise<number> | number;
+    logger?: Console;
+}
+export declare function createMessageBoxContext(deps: CreateMessageBoxContextOptions): MessageBoxContext;
+//# sourceMappingURL=context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAChC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEtC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,eAAe,CAAA;IACvB,IAAI,EAAE,IAAI,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,gBAAgB,EAAE,OAAO,CAAA;IACzB,aAAa,EAAE,OAAO,CAAA;IACtB,qBAAqB,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;IACjE,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,eAAe,CAAA;IACvB,IAAI,EAAE,IAAI,CAAA;IACV,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,qBAAqB,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;IAClE,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,8BAA8B,GACnC,iBAAiB,CAsBnB"}

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

@@ -0,0 +1,43 @@
+/**
+ * @file index.ts
+ * @description
+ * Main entry point for the MessageBox Server.
+ *
+ * Responsibilities:
+ * - Initializes environment variables and config
+ * - Creates HTTP and WebSocket servers
+ * - Boots authentication and route handlers
+ * - Sets up database migrations after a short delay
+ * - Emits and handles real-time message events over WebSocket
+ *
+ * Exports:
+ * - `start()` for programmatic bootstrapping
+ * - `http` and `io` server instances
+ * - `HTTP_PORT` and `ROUTING_PREFIX` for external reference
+ */
+import { AuthSocketServer } from '@bsv/authsocket';
+declare const ROUTING_PREFIX: string;
+declare const HTTP_PORT: number;
+declare const http: import("node:http").Server<typeof import("node:http").IncomingMessage, typeof import("node:http").ServerResponse>;
+declare const ioRef: {
+    current: AuthSocketServer | null;
+};
+/**
+ * @function start
+ * @description
+ * Initializes the WebSocket server with identity-key-based authentication
+ * and attaches all supported event handlers for:
+ * - `sendMessage`
+ * - `joinRoom`
+ * - `leaveRoom`
+ * - `disconnect`
+ *
+ * Only runs if `ENABLE_WEBSOCKETS` is set to `true` in the environment.
+ *
+ * @returns {Promise<void>} Resolves once WebSocket listeners are fully attached.
+ */
+export declare const start: () => Promise<void>;
+export { ioRef as io, http, HTTP_PORT, ROUTING_PREFIX };
+export { createMessageBoxContext, createMessageBoxApp, mountMessageBoxRoutes, attachMessageBoxWebSockets } from './compose.js';
+export type { MessageBoxContext, CreateMessageBoxContextOptions } from './context.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AASH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAQlD,QAAA,MAKE,cAAc,QACD,CAAA;AAUf,QAAA,MAAM,SAAS,EAAE,MAML,CAAA;AAYZ,QAAA,MAAM,IAAI,mHAAoB,CAAA;AAI9B,QAAA,MAAM,KAAK,EAAE;IAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;CAAsB,CAAA;AAErE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,KAAK,QAAa,OAAO,CAAC,IAAI,CAsP1C,CAAA;AAID,OAAO,EAAE,KAAK,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,CAAA;AA+BvD,OAAO,EACL,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,cAAc,CAAA;AACrB,YAAY,EAAE,iBAAiB,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAA"}

package/out/types/src/migrations/2022-12-28-001-initial-migration.d.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;
+//# sourceMappingURL=2022-12-28-001-initial-migration.d.ts.map

package/out/types/src/migrations/2022-12-28-001-initial-migration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"2022-12-28-001-initial-migration.d.ts","sourceRoot":"","sources":["../../../../src/migrations/2022-12-28-001-initial-migration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,wBAAsB,EAAE,CAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBnD;AAED,wBAAsB,IAAI,CAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAGrD"}

package/out/types/src/migrations/2023-01-17-messages-update.d.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;
+//# sourceMappingURL=2023-01-17-messages-update.d.ts.map

package/out/types/src/migrations/2023-01-17-messages-update.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"2023-01-17-messages-update.d.ts","sourceRoot":"","sources":["../../../../src/migrations/2023-01-17-messages-update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,wBAAsB,EAAE,CAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAInD;AAED,wBAAsB,IAAI,CAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAIrD"}

package/out/types/src/migrations/2024-03-05-001-messageID-upgrade.d.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;
+//# sourceMappingURL=2024-03-05-001-messageID-upgrade.d.ts.map

package/out/types/src/migrations/2024-03-05-001-messageID-upgrade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"2024-03-05-001-messageID-upgrade.d.ts","sourceRoot":"","sources":["../../../../src/migrations/2024-03-05-001-messageID-upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,wBAAsB,EAAE,CAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAUnD;AAED,wBAAsB,IAAI,CAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAUrD"}

package/out/types/src/migrations/2025-01-31-001-notification-permissions.d.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;
+//# sourceMappingURL=2025-01-31-001-notification-permissions.d.ts.map

package/out/types/src/migrations/2025-01-31-001-notification-permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"2025-01-31-001-notification-permissions.d.ts","sourceRoot":"","sources":["../../../../src/migrations/2025-01-31-001-notification-permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,wBAAsB,EAAE,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CA4DlD;AAED,wBAAsB,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAGpD"}

package/out/types/src/migrations/2025-01-31-002-device-registrations.d.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;
+//# sourceMappingURL=2025-01-31-002-device-registrations.d.ts.map

package/out/types/src/migrations/2025-01-31-002-device-registrations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"2025-01-31-002-device-registrations.d.ts","sourceRoot":"","sources":["../../../../src/migrations/2025-01-31-002-device-registrations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,wBAAsB,EAAE,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBlD;AAED,wBAAsB,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpD"}

package/out/types/src/routes/__tests/acknowledgeMessage.test.d.ts

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

package/out/types/src/routes/__tests/acknowledgeMessage.test.d.ts.map

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

package/out/types/src/routes/__tests/listMessages.test.d.ts

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

package/out/types/src/routes/__tests/listMessages.test.d.ts.map

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

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

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

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

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

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

@@ -0,0 +1,100 @@
+/**
+ * @file acknowledgeMessage.ts
+ * @description
+ * Express route to allow a client to acknowledge receipt of one or more messages.
+ * Acknowledged messages are permanently removed from the database for the
+ * authenticated identity key (recipient).
+ *
+ * This is used in the MessageBox system to clear delivered messages once received
+ * and handled on the client side (e.g., after syncing or displaying them).
+ */
+import { Request, Response } from 'express';
+/**
+ * @interface AcknowledgeRequest
+ * @extends Request
+ * @description Represents an authenticated request body for acknowledging messages.
+ */
+export interface AcknowledgeRequest extends Request {
+    auth: {
+        identityKey: string;
+    };
+    body: {
+        messageIds?: string[];
+    };
+}
+/**
+ * @openapi
+ * /acknowledgeMessage:
+ *   post:
+ *     summary: Acknowledge receipt of one or more messages
+ *     description: |
+ *       Removes acknowledged messages from the database for the authenticated identity key.
+ *       This is used after a client has received and handled messages.
+ *     tags:
+ *       - Message
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               messageIds:
+ *                 type: array
+ *                 items:
+ *                   type: string
+ *                 description: Array of message IDs to acknowledge
+ *     responses:
+ *       200:
+ *         description: Successfully acknowledged messages
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: success
+ *       400:
+ *         description: Invalid input or message not found
+ *       500:
+ *         description: Internal server error
+ */
+/**
+ * @exports
+ * Route definition for acknowledging MessageBox messages.
+ * This object is consumed by the Express route loader to register the endpoint.
+ */
+declare const _default: {
+    type: string;
+    path: string;
+    readonly knex: import("knex").Knex<any, any[]>;
+    summary: string;
+    parameters: {
+        messageIds: string[];
+    };
+    exampleResponse: {
+        status: string;
+    };
+    errors: never[];
+    /**
+     * @function func
+     * @description
+     * Express route handler that processes a POST request to acknowledge messages.
+     * Deletes messages from the database where:
+     *   - recipient matches the authenticated identity key
+     *   - messageId matches one or more of the provided IDs
+     *
+     * Returns:
+     *   - 200 success if deletion occurs
+     *   - 400 if no messages were found or input is invalid
+     *   - 500 on internal error
+     *
+     * @param {AcknowledgeRequest} req - Express request object containing auth and message IDs
+     * @param {Response} res - Express response object
+     * @returns {Promise<Response>} JSON response with status and optional error codes
+     */
+    func: (req: AcknowledgeRequest, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=acknowledgeMessage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"acknowledgeMessage.d.ts","sourceRoot":"","sources":["../../../../src/routes/acknowledgeMessage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAI3C;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,OAAO;IACjD,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7B,IAAI,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH;;;;GAIG;;;;;;;;;;;;;IAcD;;;;;;;;;;;;;;;;OAgBG;gBACe,kBAAkB,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AA9BzE,wBAmFC"}

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

@@ -0,0 +1,11 @@
+export declare const preAuth: Array<{
+    type: string;
+    path: string;
+    func: Function;
+}>;
+export declare const postAuth: Array<{
+    type: string;
+    path: string;
+    func: Function;
+}>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/routes/index.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAM,CAAA;AAChF,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,CAO1E,CAAA"}

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

@@ -0,0 +1,19 @@
+import { Response } from 'express';
+import { AuthRequest } from '@bsv/auth-express-middleware';
+export interface RegisteredDevice {
+    id: number;
+    deviceId: string | null;
+    platform: string | null;
+    fcmToken: string;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+    lastUsed: string;
+}
+declare const _default: {
+    type: string;
+    path: string;
+    func: (req: AuthRequest, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=listDevices.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"listDevices.d.ts","sourceRoot":"","sources":["../../../../src/routes/listDevices.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAG1D,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB;;;;gBAKmB,WAAW,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AAHlE,wBA+DC"}

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

@@ -0,0 +1,124 @@
+/**
+ * @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 { Response } from 'express';
+import { AuthRequest } from '@bsv/auth-express-middleware';
+/**
+ * @interface ListMessagesRequest
+ * @extends Request
+ * @description Extends Express Request to include `auth` identity and expected `messageBox` body property.
+ */
+interface ListMessagesRequest extends AuthRequest {
+    body: {
+        messageBox?: string;
+    };
+}
+/**
+ * @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.
+ */
+declare const _default: {
+    type: string;
+    path: string;
+    readonly knex: import("knex").Knex<any, any[]>;
+    summary: string;
+    parameters: {
+        messageBox: string;
+    };
+    exampleResponse: {
+        status: string;
+        messages: {
+            messageId: string;
+            body: string;
+            sender: string;
+        }[];
+    };
+    /**
+   * @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: (req: ListMessagesRequest, res: Response) => Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=listMessages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"listMessages.d.ts","sourceRoot":"","sources":["../../../../src/routes/listMessages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAI1D;;;;GAIG;AACH,UAAU,mBAAoB,SAAQ,WAAW;IAC/C,IAAI,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AAEH;;;;GAIG;;;;;;;;;;;;;;;;;IAmBD;;;;;;;;;;;;;;;;;;;;;;;KAuBC;gBACiB,mBAAmB,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AA1C1E,wBA8GC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"getPermission.d.ts","sourceRoot":"","sources":["../../../../../src/routes/permissions/getPermission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGlC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAG1D,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,KAAK,EAAE;QACL,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;;;;gBAIiB,oBAAoB,OAAO,QAAQ,KAAG,OAAO,CAAC,QAAQ,CAAC;;AAH3E,wBA2GC"}