@bopen-io/messagebox-server 1.1.5 → 1.2.0

package/docker-compose.yml

@@ -0,0 +1,64 @@
+version: '3.8'
+services:
+  ## Backend API
+  backend:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    restart: always
+    ports:
+      - "8080:8080"
+      - 9229:9229
+    command: node --inspect=0.0.0.0 --import ./out/src/telemetry.js ./out/src/index.js
+    environment:
+      HOSTING_DOMAIN: 'http://localhost:8080'
+      PORT: 8080
+      SERVER_PRIVATE_KEY: 'f8b4b466417e3fede5f95cb0651fb6371c3c9c0753a3e15c1c30155461d03c18' # EXAMPLE TEST KEY
+      KNEX_DB_CLIENT: mysql
+      KNEX_DB_CONNECTION: '{"port":3306,"host":"backend-mysql","user":"root","password":"test","database":"messagebox-backend"}'
+      NODE_ENV: development
+      WALLET_STORAGE_URL: 'https://storage.babbage.systems'
+      # OpenTelemetry — point at any OTLP/HTTP collector. Unset => console exporters.
+      OTEL_EXPORTER_OTLP_ENDPOINT: ${OTEL_EXPORTER_OTLP_ENDPOINT:-}
+      OTEL_EXPORTER_OTLP_HEADERS: ${OTEL_EXPORTER_OTLP_HEADERS:-}
+      OTEL_SERVICE_NAME: ${OTEL_SERVICE_NAME:-message-box-server}
+      OTEL_RESOURCE_ATTRIBUTES: ${OTEL_RESOURCE_ATTRIBUTES:-}
+      DEPLOY_ENV: ${DEPLOY_ENV:-development}
+    depends_on:
+      backend-mysql:
+        condition: service_healthy
+
+  ## Backend database
+  backend-mysql:
+    image: "mysql:8.0"
+    platform: linux/amd64
+    hostname: 'backend-mysql'
+    command: 'mysqld --default-authentication-plugin=mysql_native_password --sync_binlog=0 --innodb_doublewrite=OFF  --innodb-flush-log-at-trx-commit=0 --innodb-flush-method=nosync'
+    restart: always
+    volumes:
+      - './data/backend-mysql-data:/var/lib/mysql'
+    environment:
+      MYSQL_HOST: "127.0.0.1"
+      MYSQL_TCP_PORT: 3306
+      MYSQL_ROOT_PASSWORD: "test"
+      MYSQL_DATABASE: "messagebox-backend"
+    ports:
+      - "3306:3306"
+    healthcheck:
+      test: ["CMD-SHELL", 'mysqladmin ping']
+      interval: 10s
+      timeout: 2s
+      retries: 10
+
+  # Optional: PHPMyAdmin for DB browsing
+  phpmyadmin:
+    image: phpmyadmin/phpmyadmin
+    links:
+      - backend-mysql
+    environment:
+      PMA_HOST: backend-mysql
+      PMA_PORT: 3306
+      PMA_ARBITRARY: 1
+    restart: always
+    ports:
+      - 3003:80

package/jest.config.integration.ts

@@ -0,0 +1,26 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+import type { JestConfigWithTsJest } from 'ts-jest'
+
+const config: JestConfigWithTsJest = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  testPathIgnorePatterns: ['dist/'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  transform: {
+    '^.+\\.ts?$': ['ts-jest', {
+      useESM: true,
+      tsconfig: {
+        module: 'ESNext',
+        moduleResolution: 'bundler',
+        isolatedModules: true
+      }
+    }]
+  },
+  testMatch: ['**/test/integration/**/*.test.ts'], // Only run integration tests
+  verbose: true,
+  setupFilesAfterEnv: ['./jest.setup.ts'], // Ensures the test server/db start correctly
+  testTimeout: 30000 // Longer timeout for integration tests
+}
+
+export default config

package/jest.config.mjs

@@ -0,0 +1,42 @@
+// jest.config.mjs - ES Module version of Jest config
+export default {
+  // Setup file to provide globals and env vars
+  setupFilesAfterEnv: ['./jest.setup.mjs'],
+  // Use Node environment
+  testEnvironment: 'node',
+  // Force exit after tests complete (module-level knex pools stay open)
+  forceExit: true,
+  
+  // Transform TypeScript files
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+        tsconfig: {
+          module: 'ESNext',
+          moduleResolution: 'bundler',
+        },
+      },
+    ],
+  },
+  
+  // Tell Jest these extensions should be treated as ESM
+  extensionsToTreatAsEsm: ['.ts', '.tsx'],
+  
+  // Handle .js extensions in import statements for TypeScript files
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  
+  // Ignore compiled output
+  testPathIgnorePatterns: ['/node_modules/', '/out/'],
+  
+  // Important for ES modules
+  transformIgnorePatterns: [
+    '/node_modules/(?!.*\\.mjs$)'
+  ],
+  
+  // Use .mjs extension for Jest config to indicate ESM
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node', 'mjs'],
+};

package/jest.config.ts

@@ -0,0 +1,35 @@
+// jest.config.ts
+import type { JestConfigWithTsJest } from 'ts-jest'
+
+const config: JestConfigWithTsJest = {
+  // Use the preset specifically designed for ESM
+  preset: 'ts-jest/presets/default-esm',
+
+  // Use the Node environment for testing
+  testEnvironment: 'node',
+
+  // Ignore compiled output
+  testPathIgnorePatterns: ['dist/'],
+
+  // These globals configure ts-jest to output ESM
+  globals: {
+    'ts-jest': {
+      useESM: true,
+      tsconfig: {
+        module: 'ESNext',
+        moduleResolution: 'bundler'
+      }
+    }
+  },
+
+  // Tell Jest that files ending in .ts should be treated as ESM modules
+  extensionsToTreatAsEsm: ['.ts'],
+
+  // Optionally, if you have imports with a .js extension in your source (or tests)
+  // but your source files are actually TypeScript, this mapper will remove the extension.
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1'
+  }
+}
+
+export default config

package/jest.setup.mjs

@@ -0,0 +1,18 @@
+// Import Jest types from the jest package
+import { jest } from '@jest/globals';
+
+// Make Jest available globally
+global.jest = jest;
+global.expect = expect;
+global.test = test;
+global.describe = describe;
+global.beforeEach = beforeEach;
+global.afterEach = afterEach;
+global.beforeAll = beforeAll;
+global.afterAll = afterAll;
+
+// Add mock environment variables needed for tests
+process.env.SERVER_PRIVATE_KEY = 'test_private_key_for_jest_environment';
+process.env.NODE_ENV = 'test';
+process.env.KNEX_DB_CLIENT = 'better-sqlite3';
+process.env.KNEX_DB_CONNECTION = '{"filename":":memory:"}';

package/nginx.conf

@@ -0,0 +1,36 @@
+user  nginx;
+worker_processes  auto;
+daemon off;
+error_log stderr info;
+pid        /var/run/nginx.pid;
+events {
+    worker_connections  1024;
+}
+http {
+    access_log stdout;
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+    sendfile        on;
+    keepalive_timeout  3540;
+    gzip  on;
+    server {
+        listen       8080 http2;
+        listen  [::]:8080 http2;
+        server_name  localhost;
+
+        # Set maximum allowed request size
+        client_max_body_size 1g;
+
+        location / {
+            proxy_set_header X-Real-IP $remote_addr;
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header Host $host;
+            proxy_set_header X-NginX-Proxy true;
+            proxy_pass http://localhost:3000;
+            proxy_redirect off;
+        }
+    }
+}

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@bopen-io/messagebox-server",
-  "version": "1.1.5",
-  "main": "./out/src/index.js",
+  "version": "1.2.0",
+  "main": "./out/src/compose.js",
+  "exports": {
+    ".": {
+      "import": "./out/src/compose.js",
+      "default": "./out/src/compose.js"
+    },
+    "./server": {
+      "import": "./out/src/index.js",
+      "default": "./out/src/index.js"
+    }
+  },
   "type": "module",
-  "files": [
-    "out/",
-    "src/migrations/",
-    "src/templates/",
-    "knexfile.ts",
-    "knexfile.d.ts"
-  ],
   "scripts": {
     "start": "node out/src/index.js",
     "dev": "nodemon --inspect --watch .env --watch src --exec tsx src/index.ts",
@@ -20,68 +23,79 @@
     "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config=jest.config.mjs --watch",
     "lint": "ts-standard --fix .",
     "clean": "rimraf dist node_modules && npm install",
-    "prebuild": "rimraf dist",
-    "prepublishOnly": "bun run build"
+    "prebuild": "rimraf dist"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "description": "",
+  "description": "BSV message-box server with composable mount API (build from ts-stack main)",
   "devDependencies": {
-    "@eslint/js": "^9.20.0",
     "@types/better-sqlite3": "^7.6.13",
-    "@types/body-parser": "^1.19.5",
-    "@types/dotenv": "^6.1.1",
-    "@types/express": "^5.0.0",
-    "@types/jest": "^29.5.14",
-    "@types/knex": "^0.15.2",
+    "@types/body-parser": "^1.19.6",
+    "@types/dotenv": "^8.2.3",
+    "@types/express": "^5.0.6",
+    "@types/jest": "^30.0.0",
+    "@types/knex": "^0.16.1",
     "@types/mock-knex": "^0.4.8",
-    "@types/node": "^22.13.1",
+    "@types/node": "^26.0.0",
     "@types/prettyjson": "^0.0.33",
-    "@types/superagent": "^8.1.9",
-    "@types/supertest": "^6.0.2",
+    "@types/superagent": "^8.1.10",
+    "@types/supertest": "^7.2.0",
     "@types/swagger-jsdoc": "^6.0.4",
     "@types/swagger-ui-express": "^4.1.8",
     "@types/web-push": "^3.6.4",
-    "@typescript-eslint/eslint-plugin": "^8.24.0",
-    "@typescript-eslint/parser": "^8.24.0",
-    "axios": "^1.8.4",
+    "axios": "^1.17.0",
     "axios-mock-adapter": "^2.1.0",
-    "better-sqlite3": "^12.6.2",
-    "ejs": "^3.1.10",
-    "eslint": "^8.57.1",
-    "eslint-plugin-react": "^7.37.4",
-    "globals": "^15.14.0",
-    "jest": "^29.7.0",
+    "better-sqlite3": "^12.10.0",
+    "ejs": "^6.0.1",
+    "jest": "^30.3.0",
     "mock-knex": "^0.4.13",
-    "rimraf": "^6.0.1",
-    "superagent": "^10.2.1",
-    "supertest": "^7.1.1",
-    "ts-jest": "^29.2.5",
+    "rimraf": "^6.1.3",
+    "superagent": "^10.3.0",
+    "supertest": "^7.2.2",
+    "ts-jest": "^29.4.9",
     "ts-node": "^10.9.2",
     "ts-standard": "^12.0.2",
-    "tsx": "^4.19.3",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.24.0"
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3"
   },
   "overrides": {
-    "@tootallnate/once": "3.0.1"
+    "@tootallnate/once": "3.0.1",
+    "tar": ">=7.5.11",
+    "minimatch": ">=9.0.7",
+    "cross-spawn": ">=7.0.6",
+    "glob": ">=10.5.0"
   },
   "dependencies": {
-    "@bsv/auth-express-middleware": "^2.0.4",
-    "@bsv/authsocket": "^2.0.1",
-    "@bsv/payment-express-middleware": "^2.0.1",
-    "@bsv/sdk": "^2.0.7",
-    "@bsv/wallet-toolbox": "^2.1.5",
-    "body-parser": "^1.20.3",
-    "dotenv": "^8.6.0",
-    "express": "^4.21.2",
-    "firebase-admin": "^13.7.0",
-    "knex": "^2.5.1",
-    "mongodb": "^6.15.0",
-    "mysql2": "^3.12.0",
+    "@bsv/auth-express-middleware": "^2.1.0",
+    "@bsv/authsocket": "^2.1.0",
+    "@bsv/payment-express-middleware": "^2.1.0",
+    "@bsv/sdk": "^2.1.6",
+    "@bsv/wallet-toolbox": "^2.3.3",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/api-logs": "^0.219.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.77.0",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.219.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.219.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.219.0",
+    "@opentelemetry/instrumentation": "^0.219.0",
+    "@opentelemetry/instrumentation-runtime-node": "^0.32.0",
+    "@opentelemetry/resources": "^2.8.0",
+    "@opentelemetry/sdk-logs": "^0.219.0",
+    "@opentelemetry/sdk-metrics": "^2.8.0",
+    "@opentelemetry/sdk-node": "^0.219.0",
+    "@opentelemetry/sdk-trace-base": "^2.8.0",
+    "@opentelemetry/semantic-conventions": "^1.41.1",
+    "body-parser": "^2.2.2",
+    "dotenv": "^17.4.2",
+    "express": "^5.2.1",
+    "firebase-admin": "^14.0.0",
+    "knex": "^3.2.10",
+    "mongodb": "^7.2.0",
+    "mysql2": "^3.22.5",
+    "pino": "^10.3.1",
     "prettyjson": "^1.2.5",
-    "swagger-jsdoc": "^6.2.8",
+    "swagger-jsdoc": "^6.3.0",
     "swagger-ui-express": "^5.0.1",
     "web-push": "^3.6.7"
   }

package/scripts/build.js

@@ -0,0 +1,19 @@
+const ejs = require('ejs')
+const fs = require('fs')
+require('dotenv').config()
+
+ejs.renderFile(
+  'src/templates/documentation.ejs',
+  {
+    ...process.env,
+    routes: require('../src/routes').postAuthrite
+  },
+  {},
+  (err, res) => {
+    if (err) {
+      throw err
+    }
+    console.log('Generating API Documentation...')
+    fs.writeFileSync('public/index.html', res)
+  }
+)

package/scripts/mkenv.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+echo "Creating $1"
+echo "apiVersion: serving.knative.dev/v1
+kind: Service
+metadata:
+  name: $SERVICE
+spec:
+  template:
+    spec:
+      timeoutSeconds: 3540
+      containers:
+      - image: $IMAGE
+        ports:
+        - name: h2c
+          containerPort: 8080
+        env:" > $1
+
+echo "Appending environment variables to $1"
+perl -E'
+  say "        - name: $_
+          value: \x27$ENV{$_}\x27" for @ARGV;
+' NODE_ENV \
+    KNEX_DB_CONNECTION \
+    BSV_NETWORK \
+    WALLET_STORAGE_URL \
+    LOGGING_ENABLED \
+    SERVER_PRIVATE_KEY >> $1
+
+echo "Built! Contents of $1:"
+cat $1

package/scripts/start.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+if [[ $NODE_ENV = 'production' ]] || [[ $NODE_ENV = 'staging' ]]
+then
+  npm run build
+  node src/index.js
+  exit
+fi
+
+until nc -z -v -w30 messagebox-backend-mysql 3001
+do
+  echo "Waiting for database connection..."
+  sleep 1
+done
+knex migrate:latest
+npm run start

package/src/__tests/compose.test.ts

@@ -0,0 +1,30 @@
+/* eslint-env jest */
+import knexLib from 'knex'
+import {
+  createMessageBoxContext,
+  createMessageBoxApp,
+  mountMessageBoxRoutes
+} from '../compose.js'
+
+describe('compose API', () => {
+  it('createMessageBoxContext requires wallet and knex', () => {
+    expect(() => createMessageBoxContext({} as any)).toThrow(/wallet/)
+  })
+
+  it('mountMessageBoxRoutes attaches without throwing', () => {
+    const knexConfig = { client: 'mysql2', connection: {}, useNullAsDefault: true }
+    const knex = (knexLib as any).default?.(knexConfig) ?? (knexLib as any)(knexConfig)
+    const wallet = {
+      getPublicKey: async () => ({ publicKey: '02' + '11'.repeat(32) })
+    } as any
+    const app = createMessageBoxApp()
+    const ctx = createMessageBoxContext({
+      wallet,
+      knex,
+      enableSwagger: false,
+      enableWebSockets: false
+    })
+    expect(() => { mountMessageBoxRoutes(app, ctx) }).not.toThrow()
+    expect(typeof app.use).toBe('function')
+  })
+})