@openlivesync/server 1.0.2

package/src/storage/mysql.ts

@@ -0,0 +1,117 @@
+/**
+ * MySQL chat storage. Requires optional peer dependency: mysql2
+ * Install with: npm install mysql2
+ */
+
+import type { ChatMessageInput, StoredChatMessage } from "../protocol.js";
+import type { ChatStorage } from "./chat-storage.js";
+
+export interface MySQLChatStorageOptions {
+  tableName?: string;
+  historyLimit?: number;
+}
+
+const DEFAULT_TABLE = "openlivesync_chat";
+
+export interface MySQLConnectionConfig {
+  host?: string;
+  port?: number;
+  database?: string;
+  user?: string;
+  password?: string;
+  [key: string]: unknown;
+}
+
+export async function createMySQLChatStorage(
+  connectionConfig: MySQLConnectionConfig,
+  options: MySQLChatStorageOptions = {}
+): Promise<ChatStorage> {
+  let createPool: typeof import("mysql2/promise").createPool;
+  try {
+    const mysql = await import("mysql2/promise");
+    createPool = mysql.createPool;
+  } catch {
+    throw new Error(
+      'MySQL storage requires the "mysql2" package. Install it with: npm install mysql2'
+    );
+  }
+
+  const pool = createPool(connectionConfig);
+  const tableName = options.tableName ?? DEFAULT_TABLE;
+
+  const init = async (): Promise<void> => {
+    await pool.query(`
+      CREATE TABLE IF NOT EXISTS \`${tableName}\` (
+        id VARCHAR(64) PRIMARY KEY,
+        room_id VARCHAR(255) NOT NULL,
+        connection_id VARCHAR(255) NOT NULL,
+        user_id VARCHAR(255),
+        message TEXT NOT NULL,
+        metadata JSON,
+        created_at BIGINT NOT NULL,
+        INDEX idx_room_created (room_id, created_at)
+      )
+    `);
+  };
+  await init();
+
+  return {
+    async append(roomId: string, message: ChatMessageInput): Promise<void> {
+      const id = `msg_${Date.now()}_${Math.random().toString(36).slice(2, 11)}`;
+      const createdAt = Date.now();
+      await pool.query(
+        `INSERT INTO \`${tableName}\` (id, room_id, connection_id, user_id, message, metadata, created_at) VALUES (?, ?, ?, ?, ?, ?, ?)`,
+        [
+          id,
+          roomId,
+          message.connectionId,
+          message.userId ?? null,
+          message.message,
+          message.metadata ? JSON.stringify(message.metadata) : null,
+          createdAt,
+        ]
+      );
+    },
+
+    async getHistory(
+      roomId: string,
+      limit: number = (options.historyLimit ?? 100),
+      offset: number = 0
+    ): Promise<StoredChatMessage[]> {
+      const [rows] = await pool.query<
+        Array<{
+          id: string;
+          room_id: string;
+          connection_id: string;
+          user_id: string | null;
+          message: string;
+          metadata: string | null;
+          created_at: number | string;
+        }>
+      >(
+        `SELECT id, room_id, connection_id, user_id, message, metadata, created_at
+         FROM \`${tableName}\`
+         WHERE room_id = ?
+         ORDER BY created_at DESC
+         LIMIT ? OFFSET ?`,
+        [roomId, limit, offset]
+      );
+      const list = Array.isArray(rows) ? rows : [];
+      return list
+        .map((r) => ({
+          id: r.id,
+          roomId: r.room_id,
+          connectionId: r.connection_id,
+          userId: r.user_id ?? undefined,
+          message: r.message,
+          metadata: r.metadata ? (JSON.parse(r.metadata) as Record<string, unknown>) : undefined,
+          createdAt: Number(r.created_at),
+        }))
+        .reverse();
+    },
+
+    async close(): Promise<void> {
+      await pool.end();
+    },
+  };
+}

package/src/storage/postgres.ts

@@ -0,0 +1,117 @@
+/**
+ * Postgres chat storage. Requires optional peer dependency: pg
+ * Install with: npm install pg
+ */
+
+import type { ChatMessageInput, StoredChatMessage } from "../protocol.js";
+import type { ChatStorage } from "./chat-storage.js";
+
+export interface PostgresChatStorageOptions {
+  tableName?: string;
+  historyLimit?: number;
+}
+
+const DEFAULT_TABLE = "openlivesync_chat";
+
+export type PostgresConnectionConfig =
+  | { connectionString: string }
+  | {
+      host?: string;
+      port?: number;
+      database?: string;
+      user?: string;
+      password?: string;
+      [key: string]: unknown;
+    };
+
+export async function createPostgresChatStorage(
+  connectionConfig: PostgresConnectionConfig,
+  options: PostgresChatStorageOptions = {}
+): Promise<ChatStorage> {
+  let Pool: typeof import("pg").Pool;
+  try {
+    const pg = await import("pg");
+    Pool = pg.Pool;
+  } catch {
+    throw new Error(
+      'Postgres storage requires the "pg" package. Install it with: npm install pg'
+    );
+  }
+
+  const pool = new Pool(connectionConfig as import("pg").PoolConfig);
+  const tableName = options.tableName ?? DEFAULT_TABLE;
+
+  const init = async (): Promise<void> => {
+    await pool.query(`
+      CREATE TABLE IF NOT EXISTS ${tableName} (
+        id TEXT PRIMARY KEY,
+        room_id TEXT NOT NULL,
+        connection_id TEXT NOT NULL,
+        user_id TEXT,
+        message TEXT NOT NULL,
+        metadata JSONB,
+        created_at BIGINT NOT NULL
+      );
+      CREATE INDEX IF NOT EXISTS idx_${tableName.replace(/-/g, "_")}_room_created ON ${tableName}(room_id, created_at);
+    `);
+  };
+  await init();
+
+  return {
+    async append(roomId: string, message: ChatMessageInput): Promise<void> {
+      const id = `msg_${Date.now()}_${Math.random().toString(36).slice(2, 11)}`;
+      const createdAt = Date.now();
+      await pool.query(
+        `INSERT INTO ${tableName} (id, room_id, connection_id, user_id, message, metadata, created_at) VALUES ($1, $2, $3, $4, $5, $6, $7)`,
+        [
+          id,
+          roomId,
+          message.connectionId,
+          message.userId ?? null,
+          message.message,
+          message.metadata ? JSON.stringify(message.metadata) : null,
+          createdAt,
+        ]
+      );
+    },
+
+    async getHistory(
+      roomId: string,
+      limit: number = (options.historyLimit ?? 100),
+      offset: number = 0
+    ): Promise<StoredChatMessage[]> {
+      const result = await pool.query(
+        `SELECT id, room_id AS "roomId", connection_id AS "connectionId", user_id AS "userId", message, metadata, created_at AS "createdAt"
+         FROM ${tableName}
+         WHERE room_id = $1
+         ORDER BY created_at DESC
+         LIMIT $2 OFFSET $3`,
+        [roomId, limit, offset]
+      );
+      const rows = result.rows as Array<{
+        id: string;
+        roomId: string;
+        connectionId: string;
+        userId: string | null;
+        message: string;
+        metadata: string | null;
+        createdAt: string;
+      }>;
+      return rows
+        .map((r) => ({
+          id: r.id,
+          roomId: r.roomId,
+          connectionId: r.connectionId,
+          userId: r.userId ?? undefined,
+          message: r.message,
+          metadata: r.metadata ? (JSON.parse(r.metadata) as Record<string, unknown>) : undefined,
+          createdAt: Number(r.createdAt),
+        }))
+        .reverse();
+    },
+
+    async close(): Promise<void> {
+      await pool.end();
+    },
+  };
+}

package/src/storage/sqlite.ts

@@ -0,0 +1,120 @@
+/**
+ * SQLite chat storage. Requires optional peer dependency: better-sqlite3
+ * Install with: npm install better-sqlite3
+ */
+
+import { createRequire } from "node:module";
+import type { ChatMessageInput, StoredChatMessage } from "../protocol.js";
+import type { ChatStorage } from "./chat-storage.js";
+
+const require = createRequire(import.meta.url);
+
+export interface SQLiteChatStorageOptions {
+  tableName?: string;
+  historyLimit?: number;
+}
+
+const DEFAULT_TABLE = "openlivesync_chat";
+
+export type SQLiteConnectionConfig = string | { filename: string; [key: string]: unknown };
+
+export function createSQLiteChatStorage(
+  connectionConfig: SQLiteConnectionConfig,
+  options: SQLiteChatStorageOptions = {}
+): ChatStorage {
+  let Database: new (filename: string, options?: Record<string, unknown>) => {
+    exec(sql: string): unknown;
+    prepare(sql: string): { run(...args: unknown[]): unknown; all(...args: unknown[]): unknown[] };
+    close(): void;
+  };
+  try {
+    Database = require("better-sqlite3") as typeof Database;
+  } catch {
+    throw new Error(
+      'SQLite storage requires the "better-sqlite3" package. Install it with: npm install better-sqlite3'
+    );
+  }
+
+  const config =
+    typeof connectionConfig === "string"
+      ? { filename: connectionConfig }
+      : connectionConfig;
+  const db = new Database(config.filename as string);
+  const tableName = options.tableName ?? DEFAULT_TABLE;
+
+  db.exec(`
+    CREATE TABLE IF NOT EXISTS ${tableName} (
+      id TEXT PRIMARY KEY,
+      room_id TEXT NOT NULL,
+      connection_id TEXT NOT NULL,
+      user_id TEXT,
+      message TEXT NOT NULL,
+      metadata TEXT,
+      created_at INTEGER NOT NULL
+    );
+    CREATE INDEX IF NOT EXISTS idx_${tableName.replace(/-/g, "_")}_room_created ON ${tableName}(room_id, created_at);
+  `);
+
+  const appendStmt = db.prepare(`
+    INSERT INTO ${tableName} (id, room_id, connection_id, user_id, message, metadata, created_at)
+    VALUES (?, ?, ?, ?, ?, ?, ?)
+  `);
+
+  return {
+    append(roomId: string, message: ChatMessageInput): Promise<void> {
+      const id = `msg_${Date.now()}_${Math.random().toString(36).slice(2, 11)}`;
+      const createdAt = Date.now();
+      appendStmt.run(
+        id,
+        roomId,
+        message.connectionId,
+        message.userId ?? null,
+        message.message,
+        message.metadata ? JSON.stringify(message.metadata) : null,
+        createdAt
+      );
+      return Promise.resolve();
+    },
+
+    getHistory(
+      roomId: string,
+      limit: number = (options.historyLimit ?? 100),
+      offset: number = 0
+    ): Promise<StoredChatMessage[]> {
+      const rows = db
+        .prepare(
+          `SELECT id, room_id AS roomId, connection_id AS connectionId, user_id AS userId, message, metadata, created_at AS createdAt
+           FROM ${tableName}
+           WHERE room_id = ?
+           ORDER BY created_at DESC
+           LIMIT ? OFFSET ?`
+        )
+        .all(roomId, limit, offset) as Array<{
+        id: string;
+        roomId: string;
+        connectionId: string;
+        userId: string | null;
+        message: string;
+        metadata: string | null;
+        createdAt: number;
+      }>;
+      const result = rows
+        .map((r) => ({
+          id: r.id,
+          roomId: r.roomId,
+          connectionId: r.connectionId,
+          userId: r.userId ?? undefined,
+          message: r.message,
+          metadata: r.metadata ? (JSON.parse(r.metadata) as Record<string, unknown>) : undefined,
+          createdAt: r.createdAt,
+        }))
+        .reverse();
+      return Promise.resolve(result);
+    },
+
+    close(): Promise<void> {
+      db.close();
+      return Promise.resolve();
+    },
+  };
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "module": "NodeNext",
+    "target": "ES2022"
+  },
+  "include": ["src"],
+  "exclude": ["src/**/*.test.ts", "src/**/*.spec.ts"]
+}

package/vitest.config.ts

@@ -0,0 +1,32 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    globals: false,
+    environment: "node",
+    include: ["src/**/*.test.ts"],
+    hookTimeout: 15000,
+    testTimeout: 15000,
+    coverage: {
+      provider: "v8",
+      reporter: ["text", "text-summary", "html", "lcov"],
+      reportsDirectory: "./coverage",
+      include: ["src/**/*.ts"],
+      exclude: [
+        "node_modules/",
+        "dist/",
+        "examples/", // examples are demos, not library code
+        "**/*.test.ts",
+        "**/*.spec.ts",
+        "**/db-types.d.ts",
+        "vitest.config.ts",
+        "src/storage/postgres.ts",
+        "src/storage/mysql.ts",
+        "src/storage/sqlite.ts",
+        "src/index.ts",
+        "src/storage/chat-storage.ts",
+        "src/auth/index.ts",
+      ],
+    },
+  },
+});