@bopen-io/messagebox-server 1.1.5

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

@@ -0,0 +1,31 @@
+import { Knex } from 'knex'
+
+export async function up (knex: Knex): Promise<void> {
+  await knex.schema.createTable('messageBox', (table) => {
+    table.increments('messageBoxId').primary()
+    table.timestamps(true, true)
+    table.string('type').notNullable() // What type of messages go in here?
+    table.string('identityKey').notNullable() // Who's message box is this?
+    table.unique(['type', 'identityKey'])
+  })
+
+  await knex.schema.createTable('messages', (table) => {
+    table.increments('messageId').primary()
+    table.timestamps(true, true)
+    table
+      .integer('messageBoxId')
+      .unsigned()
+      .references('messageBoxId')
+      .inTable('messageBox')
+      .onDelete('CASCADE') // All messages get deleted if the messageBox is deleted
+    table.string('sender').notNullable()
+    table.string('recipient').notNullable()
+    table.text('body', 'longtext').notNullable() // Contents of the message
+    table.boolean('acknowledged').defaultTo(false)
+  })
+}
+
+export async function down (knex: Knex): Promise<void> {
+  await knex.schema.dropTableIfExists('messages')
+  await knex.schema.dropTableIfExists('messageBox')
+}

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

@@ -0,0 +1,13 @@
+import { Knex } from 'knex'
+
+export async function up (knex: Knex): Promise<void> {
+  await knex.schema.alterTable('messages', (table) => {
+    table.dropColumn('acknowledged')
+  })
+}
+
+export async function down (knex: Knex): Promise<void> {
+  await knex.schema.alterTable('messages', (table) => {
+    table.boolean('acknowledged').defaultTo(false)
+  })
+}

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

@@ -0,0 +1,25 @@
+import { Knex } from 'knex'
+
+export async function up (knex: Knex): Promise<void> {
+  // Drop the existing 'messageId' column
+  await knex.schema.alterTable('messages', (table) => {
+    table.dropColumn('messageId')
+  })
+
+  // Add 'messageId' back as a unique string
+  await knex.schema.alterTable('messages', (table) => {
+    table.string('messageId').unique().notNullable()
+  })
+}
+
+export async function down (knex: Knex): Promise<void> {
+  // Drop the new 'messageId' column
+  await knex.schema.alterTable('messages', (table) => {
+    table.dropColumn('messageId')
+  })
+
+  // Restore 'messageId' as an auto-incrementing primary key
+  await knex.schema.alterTable('messages', (table) => {
+    table.increments('messageId').primary()
+  })
+}

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

@@ -0,0 +1,68 @@
+import { Knex } from 'knex'
+
+export async function up(knex: Knex): Promise<void> {
+  // Create generalized message permissions table for all box/sender combinations
+  await knex.schema.createTable('message_permissions', (table) => {
+    table.increments('id').primary()
+    table.timestamp('created_at').defaultTo(knex.fn.now())
+    table.timestamp('updated_at').defaultTo(knex.fn.now())
+    table.string('recipient', 255).notNullable() // identityKey of who this permission belongs to
+    table.string('sender', 255).nullable() // identityKey of sender (NULL for box-wide defaults)
+    table.string('message_box', 255).notNullable() // messageBox type (e.g., 'notifications', 'inbox', etc.)
+    table.integer('recipient_fee').notNullable() // -1 = block all, 0 = always allow, >0 = satoshi amount required
+
+    table.unique(['recipient', 'sender', 'message_box'])
+
+    table.index('recipient')
+    table.index(['recipient', 'message_box'])
+    table.index('message_box')
+    table.index('sender')
+  })
+
+  // Create server fee configuration table
+  await knex.schema.createTable('server_fees', (table) => {
+    table.increments('id').primary()
+    table.timestamp('created_at').defaultTo(knex.fn.now())
+    table.timestamp('updated_at').defaultTo(knex.fn.now())
+    table.string('message_box').notNullable() // messageBox type
+    table.integer('delivery_fee').notNullable() // Server delivery fee in satoshis
+    table.unique(['message_box']) // Each box type can only have one server fee setting
+  })
+
+  // Insert default server fees for different message box types
+  const existingFees = await knex('server_fees').select('message_box')
+  const existingMessageBoxes = existingFees.map(fee => fee.message_box)
+
+  const defaultFees = [
+    {
+      message_box: 'notifications',
+      delivery_fee: 10, // Higher fee for FCM delivery
+      created_at: new Date(),
+      updated_at: new Date()
+    },
+    {
+      message_box: 'inbox',
+      delivery_fee: 0, // Free for regular inbox
+      created_at: new Date(),
+      updated_at: new Date()
+    },
+    {
+      message_box: 'payment_inbox',
+      delivery_fee: 0, // Free for payment inbox
+      created_at: new Date(),
+      updated_at: new Date()
+    }
+  ]
+
+  // Only insert fees for message boxes that don't already exist
+  const feesToInsert = defaultFees.filter(fee => !existingMessageBoxes.includes(fee.message_box))
+
+  if (feesToInsert.length > 0) {
+    await knex('server_fees').insert(feesToInsert)
+  }
+}
+
+export async function down(knex: Knex): Promise<void> {
+  await knex.schema.dropTableIfExists('server_fees')
+  await knex.schema.dropTableIfExists('message_permissions')
+}

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

@@ -0,0 +1,28 @@
+import { Knex } from 'knex'
+
+export async function up(knex: Knex): Promise<void> {
+  // Create device registrations table for FCM push notifications
+  await knex.schema.createTable('device_registrations', (table) => {
+    table.increments('id').primary()
+    table.timestamp('created_at').defaultTo(knex.fn.now())
+    table.timestamp('updated_at').defaultTo(knex.fn.now())
+    table.string('identity_key', 255).notNullable() // User's identity key
+    table.string('fcm_token', 500).notNullable() // Firebase Cloud Messaging token (can be long)
+    table.string('device_id', 255).nullable() // Optional device identifier
+    table.string('platform', 50).nullable() // 'ios', 'android', 'web', etc.
+    table.timestamp('last_used').nullable() // When this token was last successfully used
+    table.boolean('active').defaultTo(true) // Whether this token is still active
+
+    // Unique constraint to prevent duplicate token registrations
+    table.unique(['fcm_token'])
+
+    // Index for efficient lookups by identity key
+    table.index('identity_key')
+    table.index(['identity_key', 'active'])
+    table.index('last_used')
+  })
+}
+
+export async function down(knex: Knex): Promise<void> {
+  await knex.schema.dropTableIfExists('device_registrations')
+}

package/src/templates/documentation.ejs

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1, shrink-to-fit=no"
+    />
+    <title>MessageBox Server</title>
+    <style>
+      body {
+        font-family: Arial;
+        padding: 1em;
+      }
+      .main {
+        max-width: min(1440px, 100vw);
+        margin: auto;
+        word-wrap: break-word;
+      }
+      .method {
+        background-color: lime;
+        text-transform: uppercase;
+      }
+    </style>
+  </head>
+  <body>
+    <div class='main'>
+      <h1>PeerServ</h1>
+      <p>
+        Facilitates general secure peer-to-peer message exchanges between parties.
+      </p>
+      <p>Learn more on <a href='https://github.com/bitcoin-sv/message-box-server'>GitHub</a></p>
+      <h2>Endpoint Documentation</h2>
+      <% for (let i in routes) { %>
+        <% if (routes[i].hidden !== true) { %>
+         <h3>
+           <b class='method'><%= routes[i].type %></b> <%= routes[i].path %>
+         </h3>
+         <p>
+           <%= routes[i].summary %>
+         </p>
+         <% if (typeof routes[i].parameters === 'object') { %>
+           <h4>Parameters</h4>
+           <ul>
+              <% Object.entries(routes[i].parameters).forEach(([k, v]) => { %>
+                <% if (typeof v === 'object') { %>
+                  <pre><%= JSON.stringify(routes[i].parameters, null, 2) %></pre>
+                <% } else { %>
+                  <li><b><%= k %></b>: <%= v %></li>
+                <% } %>
+              <% }) %>
+           </ul>
+         <% } %>
+         <% if (typeof routes[i].exampleResponse === 'object') { %>
+           <h4>Example Response</h4>
+           <pre><%= JSON.stringify(routes[i].exampleResponse, null, 2) %></pre>
+         <% } %>
+       <% } %>
+   <% } %>
+    </div>
+  </body>
+</html>