npm - @syncular/server-hono - Versions diffs - 0.0.6-96 → 0.2.1 - Mend

@syncular/server-hono 0.0.6-96 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (104) hide show

package/README.md +5 -23
package/dist/admin-page.d.ts +14 -0
package/dist/admin-page.js +217 -0
package/dist/admin.d.ts +39 -0
package/dist/admin.js +142 -0
package/dist/index.d.ts +16 -14
package/dist/index.js +134 -23
package/package.json +19 -53
package/src/admin-page.ts +217 -0
package/src/admin.ts +193 -0
package/src/index.ts +175 -31
package/dist/api-key-auth.d.ts +0 -49
package/dist/api-key-auth.d.ts.map +0 -1
package/dist/api-key-auth.js +0 -110
package/dist/api-key-auth.js.map +0 -1
package/dist/blobs.d.ts +0 -69
package/dist/blobs.d.ts.map +0 -1
package/dist/blobs.js +0 -383
package/dist/blobs.js.map +0 -1
package/dist/console/gateway.d.ts +0 -33
package/dist/console/gateway.d.ts.map +0 -1
package/dist/console/gateway.js +0 -2534
package/dist/console/gateway.js.map +0 -1
package/dist/console/index.d.ts +0 -11
package/dist/console/index.d.ts.map +0 -1
package/dist/console/index.js +0 -11
package/dist/console/index.js.map +0 -1
package/dist/console/routes.d.ts +0 -33
package/dist/console/routes.d.ts.map +0 -1
package/dist/console/routes.js +0 -3029
package/dist/console/routes.js.map +0 -1
package/dist/console/schemas.d.ts +0 -490
package/dist/console/schemas.d.ts.map +0 -1
package/dist/console/schemas.js +0 -303
package/dist/console/schemas.js.map +0 -1
package/dist/console/types.d.ts +0 -175
package/dist/console/types.d.ts.map +0 -1
package/dist/console/types.js +0 -2
package/dist/console/types.js.map +0 -1
package/dist/console/ui.d.ts +0 -38
package/dist/console/ui.d.ts.map +0 -1
package/dist/console/ui.js +0 -43
package/dist/console/ui.js.map +0 -1
package/dist/create-server.d.ts +0 -68
package/dist/create-server.d.ts.map +0 -1
package/dist/create-server.js +0 -110
package/dist/create-server.js.map +0 -1
package/dist/index.d.ts.map +0 -1
package/dist/index.js.map +0 -1
package/dist/openapi.d.ts +0 -45
package/dist/openapi.d.ts.map +0 -1
package/dist/openapi.js +0 -59
package/dist/openapi.js.map +0 -1
package/dist/proxy/connection-manager.d.ts +0 -78
package/dist/proxy/connection-manager.d.ts.map +0 -1
package/dist/proxy/connection-manager.js +0 -251
package/dist/proxy/connection-manager.js.map +0 -1
package/dist/proxy/index.d.ts +0 -8
package/dist/proxy/index.d.ts.map +0 -1
package/dist/proxy/index.js +0 -8
package/dist/proxy/index.js.map +0 -1
package/dist/proxy/routes.d.ts +0 -74
package/dist/proxy/routes.d.ts.map +0 -1
package/dist/proxy/routes.js +0 -147
package/dist/proxy/routes.js.map +0 -1
package/dist/rate-limit.d.ts +0 -101
package/dist/rate-limit.d.ts.map +0 -1
package/dist/rate-limit.js +0 -186
package/dist/rate-limit.js.map +0 -1
package/dist/routes.d.ts +0 -161
package/dist/routes.d.ts.map +0 -1
package/dist/routes.js +0 -1493
package/dist/routes.js.map +0 -1
package/dist/ws.d.ts +0 -235
package/dist/ws.d.ts.map +0 -1
package/dist/ws.js +0 -614
package/dist/ws.js.map +0 -1
package/src/__tests__/blob-routes.test.ts +0 -424
package/src/__tests__/console-gateway-live-routes.test.ts +0 -297
package/src/__tests__/console-gateway-routes.test.ts +0 -1364
package/src/__tests__/console-routes.test.ts +0 -1626
package/src/__tests__/console-ui.test.ts +0 -114
package/src/__tests__/create-server.test.ts +0 -485
package/src/__tests__/pull-chunk-storage.test.ts +0 -576
package/src/__tests__/rate-limit.test.ts +0 -78
package/src/__tests__/realtime-bridge.test.ts +0 -135
package/src/__tests__/sync-rate-limit-routing.test.ts +0 -185
package/src/__tests__/ws-connection-manager.test.ts +0 -176
package/src/api-key-auth.ts +0 -179
package/src/blobs.ts +0 -534
package/src/console/gateway.ts +0 -3603
package/src/console/index.ts +0 -11
package/src/console/routes.ts +0 -3936
package/src/console/schemas.ts +0 -434
package/src/console/types.ts +0 -185
package/src/console/ui.ts +0 -100
package/src/create-server.ts +0 -207
package/src/openapi.ts +0 -74
package/src/proxy/connection-manager.ts +0 -340
package/src/proxy/index.ts +0 -8
package/src/proxy/routes.ts +0 -223
package/src/rate-limit.ts +0 -321
package/src/routes.ts +0 -2059
package/src/ws.ts +0 -802

package/src/__tests__/console-ui.test.ts DELETED Viewed

@@ -1,114 +0,0 @@
-import { afterEach, describe, expect, it } from 'bun:test';
-import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import path from 'node:path';
-import {
-  CONSOLE_BASEPATH_META,
-  CONSOLE_SERVER_URL_META,
-  CONSOLE_TOKEN_META,
-} from '@syncular/console/runtime-config';
-import { Hono } from 'hono';
-import { mountConsoleUi } from '../console/ui';
-const tempDirs: string[] = [];
-async function createStaticFixture(): Promise<string> {
-  const staticDir = await mkdtemp(path.join(tmpdir(), 'syncular-console-ui-'));
-  tempDirs.push(staticDir);
-  await mkdir(path.join(staticDir, 'assets'), { recursive: true });
-  await writeFile(
-    path.join(staticDir, 'index.html'),
-    `<!doctype html>
-<html>
-  <head>
-    <meta name="${CONSOLE_BASEPATH_META}" content="" />
-    <meta name="${CONSOLE_SERVER_URL_META}" content="" />
-    <meta name="${CONSOLE_TOKEN_META}" content="" />
-    <link rel="stylesheet" href="/assets/console.css" />
-  </head>
-  <body>
-    <script type="module" src="/assets/main.js"></script>
-  </body>
-</html>`
-  );
-  await writeFile(
-    path.join(staticDir, 'assets', 'main.js'),
-    'console.log(1);\n'
-  );
-  await writeFile(path.join(staticDir, 'assets', 'console.css'), 'body{}\n');
-  return staticDir;
-}
-afterEach(async () => {
-  await Promise.all(
-    tempDirs.splice(0).map((dir) => rm(dir, { recursive: true, force: true }))
-  );
-});
-describe('mountConsoleUi', () => {
-  it('serves console UI with default prefill derived from mount/api paths', async () => {
-    const staticDir = await createStaticFixture();
-    const app = new Hono();
-    mountConsoleUi(app, {
-      mountPath: 'console',
-      apiBasePath: 'api',
-      staticDir,
-    });
-    const response = await app.request('http://example.test/console');
-    const html = await response.text();
-    expect(response.status).toBe(200);
-    expect(html).toContain(
-      `<meta name="${CONSOLE_BASEPATH_META}" content="/console" />`
-    );
-    expect(html).toContain(
-      `<meta name="${CONSOLE_SERVER_URL_META}" content="http://example.test/api" />`
-    );
-    expect(html).toContain(`<meta name="${CONSOLE_TOKEN_META}" content="" />`);
-    expect(html).toContain('href="/console/assets/console.css"');
-    expect(html).toContain('src="/console/assets/main.js"');
-    const asset = await app.request(
-      'http://example.test/console/assets/main.js'
-    );
-    expect(asset.status).toBe(200);
-    expect(await asset.text()).toContain('console.log(1);');
-  });
-  it('merges resolvePrefill and allows resolveToken to override token', async () => {
-    const staticDir = await createStaticFixture();
-    const app = new Hono();
-    mountConsoleUi(app, {
-      mountPath: '/ops-console',
-      apiBasePath: '/api/internal',
-      staticDir,
-      resolvePrefill: async () => ({
-        basePath: '/prefilled',
-        serverUrl: 'https://prefill.example/api',
-        token: 'prefill-token',
-      }),
-      resolveToken: async () => 'resolver-token',
-    });
-    const response = await app.request('http://localhost/ops-console');
-    const html = await response.text();
-    expect(response.status).toBe(200);
-    expect(html).toContain(
-      `<meta name="${CONSOLE_BASEPATH_META}" content="/prefilled" />`
-    );
-    expect(html).toContain(
-      `<meta name="${CONSOLE_SERVER_URL_META}" content="https://prefill.example/api" />`
-    );
-    expect(html).toContain(
-      `<meta name="${CONSOLE_TOKEN_META}" content="resolver-token" />`
-    );
-    expect(html).toContain('href="/prefilled/assets/console.css"');
-    expect(html).toContain('src="/prefilled/assets/main.js"');
-  });
-});

package/src/__tests__/create-server.test.ts DELETED Viewed

@@ -1,485 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it } from 'bun:test';
-import { createDatabase } from '@syncular/core';
-import { createPgliteDialect } from '@syncular/dialect-pglite';
-import {
-  createServerHandler,
-  ensureSyncSchema,
-  type SyncCoreDb,
-} from '@syncular/server';
-import { createPostgresServerDialect } from '@syncular/server-dialect-postgres';
-import { Hono } from 'hono';
-import { defineWebSocketHelper } from 'hono/ws';
-import { type Kysely, sql } from 'kysely';
-import { createSyncServer } from '../create-server';
-import { getSyncWebSocketConnectionManager } from '../routes';
-import type { WebSocketConnection } from '../ws';
-interface TasksTable {
-  id: string;
-  user_id: string;
-  title: string;
-  server_version: number;
-}
-interface ServerDb extends SyncCoreDb {
-  tasks: TasksTable;
-}
-interface ClientDb {
-  tasks: TasksTable;
-}
-describe('createSyncServer console configuration', () => {
-  let db: Kysely<ServerDb>;
-  let previousConsoleToken: string | undefined;
-  beforeEach(async () => {
-    db = createDatabase<ServerDb>({
-      dialect: createPgliteDialect(),
-      family: 'postgres',
-    });
-    await ensureSyncSchema(db, createPostgresServerDialect());
-    await db.schema
-      .createTable('tasks')
-      .ifNotExists()
-      .addColumn('id', 'text', (col) => col.primaryKey())
-      .addColumn('user_id', 'text', (col) => col.notNull())
-      .addColumn('title', 'text', (col) => col.notNull())
-      .addColumn('server_version', 'integer', (col) =>
-        col.notNull().defaultTo(0)
-      )
-      .execute();
-    previousConsoleToken = process.env.SYNC_CONSOLE_TOKEN;
-    delete process.env.SYNC_CONSOLE_TOKEN;
-  });
-  afterEach(async () => {
-    if (previousConsoleToken === undefined) {
-      delete process.env.SYNC_CONSOLE_TOKEN;
-    } else {
-      process.env.SYNC_CONSOLE_TOKEN = previousConsoleToken;
-    }
-    await db.destroy();
-  });
-  function createTestHandler() {
-    return createServerHandler<ServerDb, ClientDb, 'tasks'>({
-      table: 'tasks',
-      scopes: ['user:{user_id}'],
-      resolveScopes: async (ctx) => ({ user_id: [ctx.actorId] }),
-    });
-  }
-  function createOptions() {
-    return {
-      db,
-      dialect: createPostgresServerDialect(),
-      sync: {
-        handlers: [createTestHandler()],
-        authenticate: async () => ({ actorId: 'u1' }),
-      },
-    };
-  }
-  function createConn(args: {
-    actorId: string;
-    clientId: string;
-  }): WebSocketConnection {
-    return {
-      actorId: args.actorId,
-      clientId: args.clientId,
-      transportPath: 'direct',
-      get isOpen() {
-        return true;
-      },
-      sendSync() {},
-      sendHeartbeat() {},
-      sendPresence() {},
-      sendError() {},
-      close() {},
-    };
-  }
-  function createPushRequest(args?: {
-    requestId?: string;
-    title?: string;
-  }): Request {
-    return new Request('http://localhost/sync', {
-      method: 'POST',
-      headers: {
-        'content-type': 'application/json',
-        ...(args?.requestId ? { 'x-request-id': args.requestId } : {}),
-      },
-      body: JSON.stringify({
-        clientId: 'client-1',
-        push: {
-          clientCommitId: 'commit-1',
-          schemaVersion: 1,
-          operations: [
-            {
-              table: 'tasks',
-              row_id: 'task-1',
-              op: 'upsert',
-              payload: {
-                id: 'task-1',
-                user_id: 'u1',
-                title: args?.title ?? 'Task 1',
-                server_version: 0,
-              },
-            },
-          ],
-        },
-      }),
-    });
-  }
-  function parseSnapshotValue(value: unknown): unknown {
-    if (typeof value !== 'string') {
-      return value;
-    }
-    try {
-      return JSON.parse(value);
-    } catch {
-      return value;
-    }
-  }
-  async function waitForRequestEventRow(requestId: string): Promise<{
-    payload_ref: string | null;
-  }> {
-    for (let attempt = 0; attempt < 40; attempt++) {
-      const result = await sql<{ payload_ref: string | null }>`
-        SELECT payload_ref
-        FROM sync_request_events
-        WHERE request_id = ${requestId}
-        ORDER BY event_id DESC
-        LIMIT 1
-      `.execute(db);
-      const row = result.rows[0];
-      if (row) {
-        return row;
-      }
-      await new Promise((resolve) => setTimeout(resolve, 25));
-    }
-    throw new Error(`Timed out waiting for request event: ${requestId}`);
-  }
-  async function waitForRequestPayloadSnapshot(
-    payloadRef: string
-  ): Promise<unknown> {
-    for (let attempt = 0; attempt < 40; attempt++) {
-      const result = await sql<{ request_payload: unknown | null }>`
-        SELECT request_payload
-        FROM sync_request_payloads
-        WHERE payload_ref = ${payloadRef}
-        LIMIT 1
-      `.execute(db);
-      const row = result.rows[0];
-      if (row && row.request_payload !== null) {
-        return parseSnapshotValue(row.request_payload);
-      }
-      await new Promise((resolve) => setTimeout(resolve, 25));
-    }
-    throw new Error(`Timed out waiting for payload snapshot: ${payloadRef}`);
-  }
-  it('keeps console routes disabled when console config is omitted', () => {
-    const server = createSyncServer(createOptions());
-    expect(server.consoleRoutes).toBeUndefined();
-  });
-  it('throws when console is enabled without a token', () => {
-    const options = createOptions();
-    expect(() =>
-      createSyncServer({
-        ...options,
-        console: {},
-      })
-    ).toThrow(
-      'Console is enabled but no token is configured. Set `console.token` or SYNC_CONSOLE_TOKEN.'
-    );
-  });
-  it('accepts SYNC_CONSOLE_TOKEN when console token is omitted', () => {
-    process.env.SYNC_CONSOLE_TOKEN = 'env-token';
-    const options = createOptions();
-    const server = createSyncServer({
-      ...options,
-      console: {},
-    });
-    expect(server.consoleRoutes).toBeDefined();
-  });
-  it('accepts an explicit console token', () => {
-    process.env.SYNC_CONSOLE_TOKEN = 'env-token';
-    const options = createOptions();
-    const server = createSyncServer({
-      ...options,
-      console: { token: 'explicit-token' },
-    });
-    expect(server.consoleRoutes).toBeDefined();
-  });
-  it('returns not implemented when blobBucket is not configured', async () => {
-    const options = createOptions();
-    const server = createSyncServer({
-      ...options,
-      console: {
-        token: 'console-token',
-      },
-    });
-    const app = new Hono();
-    app.route('/console', server.consoleRoutes!);
-    const response = await app.request('http://localhost/console/storage', {
-      headers: { Authorization: 'Bearer console-token' },
-    });
-    expect(response.status).toBe(501);
-    expect(await response.json()).toEqual({
-      error: 'BLOB_STORAGE_NOT_CONFIGURED',
-    });
-  });
-  it('enables storage console routes when blobBucket is configured', async () => {
-    const options = createOptions();
-    const server = createSyncServer({
-      ...options,
-      console: {
-        token: 'blob-token',
-        blobBucket: {
-          list: async () => ({
-            objects: [
-              {
-                key: 'hello.txt',
-                size: 12,
-                uploaded: new Date('2025-01-01T00:00:00.000Z'),
-                httpMetadata: { contentType: 'text/plain' },
-              },
-            ],
-            truncated: false,
-            cursor: undefined,
-          }),
-          get: async () => null,
-          delete: async () => {},
-          head: async () => null,
-        },
-      },
-    });
-    const app = new Hono();
-    app.route('/console', server.consoleRoutes!);
-    const unauthenticated = await app.request(
-      'http://localhost/console/storage'
-    );
-    expect(unauthenticated.status).toBe(401);
-    const response = await app.request('http://localhost/console/storage', {
-      headers: { Authorization: 'Bearer blob-token' },
-    });
-    expect(response.status).toBe(200);
-    expect(await response.json()).toEqual({
-      items: [
-        {
-          key: 'hello.txt',
-          size: 12,
-          uploaded: '2025-01-01T00:00:00.000Z',
-          httpMetadata: { contentType: 'text/plain' },
-        },
-      ],
-      truncated: false,
-      cursor: null,
-    });
-  });
-  it('forwards maxConnectionsPerClient from factory to realtime route', async () => {
-    const options = createOptions();
-    const upgradeWebSocket = defineWebSocketHelper(async () => {});
-    const server = createSyncServer({
-      ...options,
-      upgradeWebSocket,
-      routes: {
-        websocket: {
-          maxConnectionsPerClient: 1,
-        },
-      },
-    });
-    const manager = getSyncWebSocketConnectionManager(server.syncRoutes);
-    if (!manager) {
-      throw new Error('Expected websocket manager to be enabled.');
-    }
-    manager.register(createConn({ actorId: 'u1', clientId: 'client-1' }), []);
-    const app = new Hono();
-    app.route('/sync', server.syncRoutes);
-    const response = await app.request(
-      'http://localhost/sync/realtime?clientId=client-1'
-    );
-    expect(response.status).toBe(429);
-    expect(await response.json()).toEqual({
-      error: 'WEBSOCKET_CONNECTION_LIMIT_CLIENT',
-    });
-  });
-  it('allows disabling request payload snapshots for privacy-sensitive deployments', async () => {
-    process.env.SYNC_CONSOLE_TOKEN = 'env-token';
-    const options = createOptions();
-    const server = createSyncServer({
-      ...options,
-      console: {},
-      routes: {
-        requestPayloadSnapshots: {
-          enabled: false,
-        },
-      },
-    });
-    const app = new Hono();
-    app.route('/sync', server.syncRoutes);
-    const requestId = 'req-no-payload-snapshot';
-    const response = await app.request(createPushRequest({ requestId }));
-    expect(response.status).toBe(200);
-    const eventRow = await waitForRequestEventRow(requestId);
-    expect(eventRow.payload_ref).toBeNull();
-    const payloadCountResult = await sql<{ total: number | string }>`
-      SELECT COUNT(*)::int AS total
-      FROM sync_request_payloads
-    `.execute(db);
-    const payloadCount = Number(payloadCountResult.rows[0]?.total ?? 0);
-    expect(payloadCount).toBe(0);
-  });
-  it('supports aggressively reducing stored payload snapshot size', async () => {
-    process.env.SYNC_CONSOLE_TOKEN = 'env-token';
-    const options = createOptions();
-    const server = createSyncServer({
-      ...options,
-      console: {},
-      routes: {
-        requestPayloadSnapshots: {
-          maxBytes: 32,
-        },
-      },
-    });
-    const app = new Hono();
-    app.route('/sync', server.syncRoutes);
-    const requestId = 'req-small-payload-preview';
-    const response = await app.request(
-      createPushRequest({
-        requestId,
-        title: 'x'.repeat(1024),
-      })
-    );
-    expect(response.status).toBe(200);
-    const eventRow = await waitForRequestEventRow(requestId);
-    expect(typeof eventRow.payload_ref).toBe('string');
-    if (!eventRow.payload_ref) {
-      throw new Error('Expected payload_ref to be present.');
-    }
-    const storedPayload = await waitForRequestPayloadSnapshot(
-      eventRow.payload_ref
-    );
-    expect(typeof storedPayload).toBe('object');
-    expect(Array.isArray(storedPayload)).toBe(false);
-    if (!storedPayload || typeof storedPayload !== 'object') {
-      throw new Error('Expected stored payload snapshot to be an object.');
-    }
-    const truncated = Reflect.get(storedPayload, 'truncated');
-    const preview = Reflect.get(storedPayload, 'preview');
-    expect(truncated).toBe(true);
-    expect(typeof preview).toBe('string');
-    if (typeof preview === 'string') {
-      expect(preview.length).toBeLessThanOrEqual(32);
-    }
-  });
-  it('forwards maxConnectionsTotal from factory to realtime route', async () => {
-    const options = createOptions();
-    const upgradeWebSocket = defineWebSocketHelper(async () => {});
-    const server = createSyncServer({
-      ...options,
-      upgradeWebSocket,
-      routes: {
-        websocket: {
-          maxConnectionsTotal: 1,
-        },
-      },
-    });
-    const manager = getSyncWebSocketConnectionManager(server.syncRoutes);
-    if (!manager) {
-      throw new Error('Expected websocket manager to be enabled.');
-    }
-    manager.register(createConn({ actorId: 'u1', clientId: 'client-1' }), []);
-    const app = new Hono();
-    app.route('/sync', server.syncRoutes);
-    const response = await app.request(
-      'http://localhost/sync/realtime?clientId=client-2'
-    );
-    expect(response.status).toBe(429);
-    expect(await response.json()).toEqual({
-      error: 'WEBSOCKET_CONNECTION_LIMIT_TOTAL',
-    });
-  });
-  it('emits live console events from sync lifecycle when console is enabled', async () => {
-    process.env.SYNC_CONSOLE_TOKEN = 'env-token';
-    const options = createOptions();
-    const server = createSyncServer({
-      ...options,
-      console: {},
-    });
-    const liveEvents: Array<{
-      type: string;
-      data: Record<string, unknown>;
-    }> = [];
-    const listener = (event: {
-      type: 'push' | 'pull' | 'commit' | 'client_update';
-      timestamp: string;
-      data: Record<string, unknown>;
-    }) => {
-      liveEvents.push({ type: event.type, data: event.data });
-    };
-    server.consoleEventEmitter?.addListener(listener);
-    const app = new Hono();
-    app.route('/sync', server.syncRoutes);
-    const response = await app.request(createPushRequest());
-    expect(response.status).toBe(200);
-    const emittedTypes = liveEvents.map((event) => event.type);
-    expect(emittedTypes).toContain('push');
-    expect(emittedTypes).toContain('commit');
-    const pushEvent = liveEvents.find((event) => event.type === 'push');
-    expect(pushEvent?.data.actorId).toBe('u1');
-    expect(pushEvent?.data.clientId).toBe('client-1');
-    server.consoleEventEmitter?.removeListener(listener);
-  });
-});