@syncular/cli 0.0.0

package/templates/libraries/syncular-migrate.ts.tpl

@@ -0,0 +1,81 @@
+/**
+ * Syncular CLI migration adapter.
+ *
+ * Generated by `syncular create`.
+ */
+
+import { getSchemaVersion, runMigrations, type DefinedMigrations } from '@syncular/migrations';
+import type { Kysely } from 'kysely';
+
+// Replace with your app DB type and concrete implementation.
+type Db = Record<string, never>;
+
+async function createDb(): Promise<Kysely<Db>> {
+  throw new Error('TODO: implement createDb() in scripts/syncular-migrate.ts');
+}
+
+async function loadMigrations(): Promise<DefinedMigrations<Db>> {
+  throw new Error('TODO: return your defineMigrations(...) export in scripts/syncular-migrate.ts');
+}
+
+export const <%= it.ADAPTER_EXPORT %> = {
+  async status() {
+    const db = await createDb();
+    try {
+      const migrations = await loadMigrations();
+      const currentVersion = await getSchemaVersion(db);
+      const targetVersion = migrations.currentVersion;
+      const pendingVersions = migrations.migrations
+        .map((migration) => migration.version)
+        .filter((version) => version > currentVersion);
+
+      return {
+        currentVersion,
+        targetVersion,
+        pendingVersions,
+        trackingTable: 'sync_migration_state',
+      };
+    } finally {
+      await db.destroy();
+    }
+  },
+
+  async up(options: {
+    onChecksumMismatch: 'error' | 'reset';
+    dryRun: boolean;
+  }) {
+    const db = await createDb();
+    try {
+      const migrations = await loadMigrations();
+      const currentVersion = await getSchemaVersion(db);
+
+      if (options.dryRun) {
+        const pendingVersions = migrations.migrations
+          .map((migration) => migration.version)
+          .filter((version) => version > currentVersion);
+
+        return {
+          appliedVersions: pendingVersions,
+          currentVersion,
+          wasReset: false,
+          dryRun: true,
+        };
+      }
+
+      const result = await runMigrations({
+        db,
+        migrations,
+        onChecksumMismatch: options.onChecksumMismatch,
+      });
+
+      return {
+        appliedVersions: result.applied,
+        currentVersion: result.currentVersion,
+        wasReset: result.wasReset,
+        dryRun: false,
+      };
+    } finally {
+      await db.destroy();
+    }
+  },
+};

package/templates/libraries/syncular-proxy-api.ts.tpl

@@ -0,0 +1,32 @@
+/**
+ * Syncular proxy API scaffold.
+ */
+
+import { createProxyRoutes } from '@syncular/server-hono';
+import { ProxyTableRegistry } from '@syncular/server';
+
+type ProxyRouteOptions = Parameters<typeof createProxyRoutes>[0];
+
+export function createSyncularProxyRoutes(args: {
+  db: ProxyRouteOptions['db'];
+  dialect: ProxyRouteOptions['dialect'];
+  upgradeWebSocket: ProxyRouteOptions['upgradeWebSocket'];
+  validateToken: (token: string | undefined) => string | null;
+}) {
+  const handlers = new ProxyTableRegistry().register({
+    table: 'tasks',
+    computeScopes: (row) => ({ user_id: String(row.user_id ?? '') }),
+  });
+
+  return createProxyRoutes({
+    db: args.db,
+    dialect: args.dialect,
+    handlers,
+    upgradeWebSocket: args.upgradeWebSocket,
+    authenticate: async (c) => {
+      const token = c.req.query('token') ?? c.req.header('x-api-key');
+      const actorId = args.validateToken(token);
+      return actorId ? { actorId } : null;
+    },
+  });
+}

package/templates/libraries/syncular-react-native.ts.tpl

@@ -0,0 +1,32 @@
+/**
+ * Syncular React Native module scaffold (Nitro SQLite).
+ */
+
+import { createClient } from '@syncular/client';
+import type { SyncClientDb } from '@syncular/client';
+import { createNitroSqliteDb } from '@syncular/dialect-react-native-nitro-sqlite';
+import { createHttpTransport } from '@syncular/transport-http';
+
+export function createClientDb<DB extends SyncClientDb>() {
+  return createNitroSqliteDb<DB>({ name: 'app.sqlite' });
+}
+
+export async function createSyncularReactNativeClient<DB extends SyncClientDb>(args: {
+  actorId: string;
+  token: string;
+  baseUrl: string;
+  tables: string[];
+  scopes: string[];
+}) {
+  const db = createClientDb<DB>();
+  return createClient({
+    db,
+    actorId: args.actorId,
+    transport: createHttpTransport({
+      baseUrl: args.baseUrl,
+      getHeaders: () => ({ Authorization: `Bearer ${args.token}` }),
+    }),
+    tables: args.tables,
+    scopes: args.scopes,
+  });
+}

package/templates/libraries/syncular-react.ts.tpl

@@ -0,0 +1,27 @@
+/**
+ * Syncular React module scaffold.
+ *
+ * Dialect: <%= it.CLIENT_DIALECT_LABEL %>
+ */
+
+<%= it.CLIENT_DIALECT_IMPORT %>
+import type { SyncClientDb } from '@syncular/client';
+import { createSyncularReact } from '@syncular/client-react';
+import { createHttpTransport } from '@syncular/transport-http';
+
+export const clientDialect = '<%= it.CLIENT_DIALECT %>';
+
+export function createClientDb<DB>() {
+  <%= it.CLIENT_DB_FACTORY_LINE %>
+}
+
+export function createSyncTransport(args: { baseUrl: string; token: string }) {
+  return createHttpTransport({
+    baseUrl: args.baseUrl,
+    getHeaders: () => ({ Authorization: `Bearer ${args.token}` }),
+  });
+}
+
+export function createReactBindings<DB extends SyncClientDb>() {
+  return createSyncularReact<DB>();
+}

package/templates/libraries/syncular-server.postgres.ts.tpl

@@ -0,0 +1,40 @@
+/**
+ * Syncular server module scaffold (Postgres).
+ */
+
+import { createServerHandler, ensureSyncSchema, type SyncCoreDb } from '@syncular/server';
+import { createPostgresServerDialect } from '@syncular/server-dialect-postgres';
+import { createSyncServer } from '@syncular/server-hono';
+import { Kysely, PostgresDialect } from 'kysely';
+import { Pool } from 'pg';
+
+export interface AppServerDb extends SyncCoreDb {}
+
+export async function createSyncularServer() {
+  const db = new Kysely<AppServerDb>({
+    dialect: new PostgresDialect({
+      pool: new Pool({ connectionString: process.env.DATABASE_URL }),
+    }),
+  });
+
+  const dialect = createPostgresServerDialect();
+  await ensureSyncSchema(db, dialect);
+
+  const tasksHandler = createServerHandler({
+    table: 'tasks',
+    scopes: ['user:{user_id}'],
+    resolveScopes: async (ctx) => ({ user_id: [ctx.actorId] }),
+  });
+
+  const server = createSyncServer({
+    db,
+    dialect,
+    handlers: [tasksHandler],
+    authenticate: async (c) => {
+      const actorId = c.req.header('x-user-id');
+      return actorId ? { actorId } : null;
+    },
+  });
+
+  return { ...server, db, dialect };
+}

package/templates/libraries/syncular-server.sqlite.ts.tpl

@@ -0,0 +1,34 @@
+/**
+ * Syncular server module scaffold (SQLite).
+ */
+
+import { createBunSqliteDb } from '@syncular/dialect-bun-sqlite';
+import { createServerHandler, ensureSyncSchema, type SyncCoreDb } from '@syncular/server';
+import { createSqliteServerDialect } from '@syncular/server-dialect-sqlite';
+import { createSyncServer } from '@syncular/server-hono';
+
+export interface AppServerDb extends SyncCoreDb {}
+
+export async function createSyncularServer() {
+  const db = createBunSqliteDb<AppServerDb>({ path: './data/server.sqlite' });
+  const dialect = createSqliteServerDialect();
+  await ensureSyncSchema(db, dialect);
+
+  const tasksHandler = createServerHandler({
+    table: 'tasks',
+    scopes: ['user:{user_id}'],
+    resolveScopes: async (ctx) => ({ user_id: [ctx.actorId] }),
+  });
+
+  const server = createSyncServer({
+    db,
+    dialect,
+    handlers: [tasksHandler],
+    authenticate: async (c) => {
+      const actorId = c.req.header('x-user-id');
+      return actorId ? { actorId } : null;
+    },
+  });
+
+  return { ...server, db, dialect };
+}

package/templates/libraries/syncular-typegen.ts.tpl

@@ -0,0 +1,29 @@
+/**
+ * Syncular type generation scaffold.
+ *
+ * Wire your migrations export and run via `bun run db:typegen`.
+ */
+
+import { generateTypes } from '@syncular/typegen';
+
+async function main() {
+  throw new Error('TODO: import your migrations and call generateTypes(...)');
+
+  // Example:
+  // const result = await generateTypes({
+  //   migrations,
+  //   output: './src/syncular/types.generated.ts',
+  //   extendsSyncClientDb: true,
+  // });
+  // console.log(`Generated ${result.outputPath}`);
+  // await generateTypes({
+  //   migrations,
+  //   output: './src/syncular/types.generated.ts',
+  //   extendsSyncClientDb: true,
+  // });
+}
+
+main().catch((error) => {
+  console.error('Typegen failed:', error);
+  process.exit(1);
+});

package/templates/libraries/syncular-vanilla.ts.tpl

@@ -0,0 +1,38 @@
+/**
+ * Syncular vanilla module scaffold.
+ *
+ * Dialect: <%= it.CLIENT_DIALECT_LABEL %>
+ */
+
+import { createClient } from '@syncular/client';
+import type { SyncClientDb } from '@syncular/client';
+<%= it.CLIENT_DIALECT_IMPORT %>
+import { createHttpTransport } from '@syncular/transport-http';
+
+export const clientDialect = '<%= it.CLIENT_DIALECT %>';
+
+export function createClientDb<DB extends SyncClientDb>() {
+  <%= it.CLIENT_DB_FACTORY_LINE %>
+}
+
+export async function createSyncularClient<DB extends SyncClientDb>(args: {
+  actorId: string;
+  token: string;
+  baseUrl: string;
+  tables: string[];
+  scopes: string[];
+}) {
+  const db = createClientDb<DB>();
+  const transport = createHttpTransport({
+    baseUrl: args.baseUrl,
+    getHeaders: () => ({ Authorization: `Bearer ${args.token}` }),
+  });
+
+  return createClient({
+    db,
+    actorId: args.actorId,
+    transport,
+    tables: args.tables,
+    scopes: args.scopes,
+  });
+}

package/templates/libraries/syncular.config.json.tpl

@@ -0,0 +1,9 @@
+{
+  "mode": <%= it.MODE_JSON %>,
+  "targets": <%= it.TARGETS_JSON %>,
+  "dialects": <%= it.DIALECTS_JSON %>,
+  "migrate": {
+    "adapter": "<%= it.ADAPTER_PATH %>",
+    "export": "<%= it.ADAPTER_EXPORT %>"
+  }
+}