@vercel/board 0.0.0 → 0.16.0

package/package.json

@@ -1 +1,168 @@
-{"name":"@vercel/board","version":"0.0.0"}
+{
+  "name": "@vercel/board",
+  "version": "0.16.0",
+  "description": "A message board you mount in one route: one durable log, verified authors, live tail, and two-way sync.",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=22.18"
+  },
+  "files": [
+    "dist",
+    "docs",
+    "sql",
+    "README.md"
+  ],
+  "bin": {
+    "board": "./dist/cli.mjs",
+    "vb": "./dist/cli.mjs"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "node": "./dist/index.node.mjs",
+      "default": "./dist/index.mjs"
+    },
+    "./access": {
+      "types": "./dist/access.d.mts",
+      "default": "./dist/access.mjs"
+    },
+    "./conformance": {
+      "types": "./dist/conformance.d.mts",
+      "default": "./dist/conformance.mjs"
+    },
+    "./backend-a2": {
+      "types": "./dist/backend-a2.d.mts",
+      "default": "./dist/backend-a2.mjs"
+    },
+    "./backend-a2/contract": {
+      "types": "./dist/backend-a2/contract.d.mts",
+      "default": "./dist/backend-a2/contract.mjs"
+    },
+    "./backend-a2/blob-vercel": {
+      "types": "./dist/backend-a2/blob-vercel.d.mts",
+      "default": "./dist/backend-a2/blob-vercel.mjs"
+    },
+    "./backend-a2/store-postgres": {
+      "types": "./dist/backend-a2/store-postgres.d.mts",
+      "default": "./dist/backend-a2/store-postgres.mjs"
+    },
+    "./backend-a2/store-redis": {
+      "types": "./dist/backend-a2/store-redis.d.mts",
+      "default": "./dist/backend-a2/store-redis.mjs"
+    },
+    "./backend-a2/store-redis-http": {
+      "types": "./dist/backend-a2/store-redis-http.d.mts",
+      "default": "./dist/backend-a2/store-redis-http.mjs"
+    },
+    "./backend-a2/store-sqlite": {
+      "types": "./dist/backend-a2/store-sqlite.d.mts",
+      "default": "./dist/backend-a2/store-sqlite.mjs"
+    },
+    "./backend-a2/store-memory": {
+      "types": "./dist/backend-a2/store-memory.d.mts",
+      "default": "./dist/backend-a2/store-memory.mjs"
+    },
+    "./backend-a2/scheduler-vercel": {
+      "types": "./dist/backend-a2/scheduler-vercel.d.mts",
+      "default": "./dist/backend-a2/scheduler-vercel.mjs"
+    },
+    "./backend-a2/scheduler-qstash": {
+      "types": "./dist/backend-a2/scheduler-qstash.d.mts",
+      "default": "./dist/backend-a2/scheduler-qstash.mjs"
+    },
+    "./backend-a2/scheduler-local": {
+      "types": "./dist/backend-a2/scheduler-local.d.mts",
+      "default": "./dist/backend-a2/scheduler-local.mjs"
+    },
+    "./backend-http": {
+      "types": "./dist/backend-http.d.mts",
+      "node": "./dist/backend-http.node.mjs",
+      "default": "./dist/backend-http.mjs"
+    },
+    "./sync": {
+      "types": "./dist/sync.d.mts",
+      "default": "./dist/sync.mjs"
+    },
+    "./sync/chat": {
+      "types": "./dist/sync.chat.d.mts",
+      "default": "./dist/sync.chat.mjs"
+    },
+    "./sync-slack": {
+      "types": "./dist/sync-slack.d.mts",
+      "default": "./dist/sync-slack.mjs"
+    },
+    "./sync-github": {
+      "types": "./dist/sync-github.d.mts",
+      "default": "./dist/sync-github.mjs"
+    },
+    "./sync-kapso": {
+      "types": "./dist/sync-kapso.d.mts",
+      "default": "./dist/sync-kapso.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@chat-adapter/github": "^4.41.1",
+    "@chat-adapter/slack": "^4.41.1",
+    "@vercel/connect": "^2.3.4",
+    "@vercel/oidc": "^3.8.9",
+    "chat": "^4.41.1",
+    "experimental-a2": "0.22.0",
+    "jose": "^6.2.12",
+    "zod": "^4.6.5"
+  },
+  "peerDependencies": {
+    "@upstash/qstash": "^2.11.0",
+    "@vercel/blob": "^2.8.0",
+    "@vercel/queue": "*",
+    "ioredis": "^5.4.0",
+    "pg": "^8.11.0"
+  },
+  "devDependencies": {
+    "@base-ui/react": "^1.8.0",
+    "@chat-adapter/tests": "^4.41.1",
+    "@electric-sql/pglite": "0.3.15",
+    "@kapso/chat-adapter": "^0.1.1",
+    "@types/node": "^26.6.3",
+    "@types/pg": "8.15.5",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "@vercel/blob": "^2.8.0",
+    "ai": "^7.0.130",
+    "ioredis": "5.11.1",
+    "lucide-react": "^1.49.0",
+    "pg": "^8.16.3",
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0",
+    "react-markdown": "^10.1.0",
+    "remark-breaks": "^4.0.0",
+    "remark-gfm": "^4.0.1",
+    "tsdown": "^0.23.0",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.3"
+  },
+  "peerDependenciesMeta": {
+    "@upstash/qstash": {
+      "optional": true
+    },
+    "@vercel/blob": {
+      "optional": true
+    },
+    "@vercel/queue": {
+      "optional": true
+    },
+    "ioredis": {
+      "optional": true
+    },
+    "pg": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsdown && node scripts/schema.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "pretest": "tsdown --log-level warn"
+  }
+}

package/sql/postgres/board.sql

@@ -0,0 +1,145 @@
+-- board's tables, which live next to A2's. schema.sql holds both: apply that.
+
+create table if not exists board_positions (
+  consumer text primary key,
+  log_index bigint not null
+);
+--> statement-breakpoint
+create table if not exists board_messages (
+  id bigint primary key,
+  event_id text not null unique,
+  channel text not null,
+  re bigint,
+  by_actor text not null,
+  by_principal text not null,
+  by_profile text,
+  from_key text,
+  no_sync boolean not null,
+  text_lower text not null,
+  deleted boolean not null,
+  created_at bigint not null,
+  replies integer not null default 0,
+  at bigint,
+  data text not null
+);
+--> statement-breakpoint
+create index if not exists board_messages_channel on board_messages (channel, id);
+--> statement-breakpoint
+create index if not exists board_messages_re on board_messages (re, id);
+--> statement-breakpoint
+create index if not exists board_messages_by_actor on board_messages (by_actor, id);
+--> statement-breakpoint
+create index if not exists board_messages_by_principal on board_messages (by_principal, id);
+--> statement-breakpoint
+create index if not exists board_threads_at on board_messages (at) where re is null;
+--> statement-breakpoint
+create index if not exists board_threads_channel on board_messages (channel, at) where re is null;
+--> statement-breakpoint
+create table if not exists board_versions (
+  log_index bigint primary key,
+  message_id bigint not null,
+  data text not null
+);
+--> statement-breakpoint
+create index if not exists board_versions_message on board_versions (message_id, log_index);
+--> statement-breakpoint
+create table if not exists board_terms (
+  message_id bigint not null,
+  term text not null,
+  value text not null,
+  primary key (message_id, term, value)
+);
+--> statement-breakpoint
+create index if not exists board_terms_term on board_terms (term, value, message_id);
+--> statement-breakpoint
+create table if not exists board_sync_threads (
+  thread text primary key,
+  data text not null
+);
+--> statement-breakpoint
+create table if not exists board_external_threads (
+  external text primary key,
+  thread text not null
+);
+--> statement-breakpoint
+create table if not exists board_copies (
+  message_id bigint not null,
+  target text not null,
+  data text not null,
+  primary key (message_id, target)
+);
+--> statement-breakpoint
+create table if not exists board_external_messages (
+  key text primary key,
+  message_id bigint not null
+);
+--> statement-breakpoint
+create index if not exists board_messages_recent on board_messages (by_principal, created_at) where re is null;
+--> statement-breakpoint
+drop function if exists board_apply(text, bigint, boolean, jsonb, jsonb, jsonb);
+--> statement-breakpoint
+create or replace function board_apply(
+  apply_consumer text,
+  apply_index bigint,
+  apply_next boolean,
+  apply_message jsonb,
+  apply_terms jsonb,
+  apply_summary jsonb,
+  apply_sync jsonb
+) returns boolean language plpgsql as $$
+begin
+  if apply_next then
+    update board_positions set log_index = apply_index
+      where consumer = apply_consumer and log_index = apply_index - 1;
+  else
+    insert into board_positions (consumer, log_index) values (apply_consumer, apply_index)
+      on conflict (consumer) do update set log_index = excluded.log_index
+      where board_positions.log_index < excluded.log_index;
+  end if;
+  if not found then
+    return false;
+  end if;
+  if apply_message is not null then
+    if (apply_message->>'created')::boolean then
+      insert into board_messages
+        (id, event_id, channel, re, by_actor, by_principal, by_profile, from_key, no_sync, text_lower, deleted, created_at, data)
+        values (
+          (apply_message->>'id')::bigint, apply_message->>'event_id', apply_message->>'channel', (apply_message->>'re')::bigint,
+          apply_message->>'by_actor', apply_message->>'by_principal', apply_message->>'by_profile', apply_message->>'from_key',
+          (apply_message->>'no_sync')::boolean, apply_message->>'text_lower', (apply_message->>'deleted')::boolean,
+          (apply_message->>'created_at')::bigint, apply_message->>'data');
+    else
+      update board_messages
+        set text_lower = apply_message->>'text_lower', deleted = (apply_message->>'deleted')::boolean, data = apply_message->>'data'
+        where id = (apply_message->>'id')::bigint;
+    end if;
+    insert into board_versions (log_index, message_id, data)
+      values (apply_index, (apply_message->>'id')::bigint, apply_message->>'data');
+    if apply_terms is not null then
+      delete from board_terms where message_id = (apply_message->>'id')::bigint;
+      insert into board_terms (message_id, term, value)
+        select (apply_message->>'id')::bigint, term->>0, term->>1 from jsonb_array_elements(apply_terms) as term;
+    end if;
+  end if;
+  if apply_summary is not null then
+    update board_messages set replies = (apply_summary->>'replies')::int, at = (apply_summary->>'at')::bigint
+      where id = (apply_summary->>'root')::bigint;
+  end if;
+  if apply_sync is not null then
+    if jsonb_typeof(apply_sync->'thread') = 'object' then
+      insert into board_sync_threads (thread, data) values (apply_sync->'thread'->>'key', apply_sync->'thread'->>'data')
+        on conflict (thread) do update set data = excluded.data;
+    end if;
+    insert into board_external_threads (external, thread)
+      select entry->>0, entry->>1 from jsonb_array_elements(apply_sync->'external_threads') as entry
+      on conflict (external) do update set thread = excluded.thread;
+    insert into board_copies (message_id, target, data)
+      select (entry->>0)::bigint, entry->>1, entry->>2 from jsonb_array_elements(apply_sync->'copies') as entry
+      on conflict (message_id, target) do update set data = excluded.data;
+    insert into board_external_messages (key, message_id)
+      select entry->>0, (entry->>1)::bigint from jsonb_array_elements(apply_sync->'external_messages') as entry
+      on conflict (key) do update set message_id = excluded.message_id;
+  end if;
+  return true;
+end
+$$;

package/sql/postgres/notifications.sql

@@ -0,0 +1,24 @@
+-- Notification triggers for experimental-a2/store-postgres, needed only with
+-- `listenConnectionString`. Apply after schema.sql. They wake live streams
+-- for every write to A2's event and presence tables, including writes from
+-- stores without the option. Safe to re-run.
+
+create or replace function a2_notify_events() returns trigger language plpgsql as $$
+begin
+  perform pg_notify('a2_events_' || md5(new.session_id), '');
+  return null;
+end $$;
+create or replace function a2_notify_presence() returns trigger language plpgsql as $$
+begin
+  perform pg_notify('a2_presence_' || md5(case when TG_OP = 'DELETE' then old.ns else new.ns end),
+    coalesce(current_setting('a2.presence_source', true), ''));
+  return null;
+end $$;
+do $$ begin
+  if not exists (select 1 from pg_trigger where tgname = 'a2_notify_events' and tgrelid = 'a2_events'::regclass) then
+    create trigger a2_notify_events after insert on a2_events for each row execute function a2_notify_events();
+  end if;
+  if not exists (select 1 from pg_trigger where tgname = 'a2_notify_presence' and tgrelid = 'a2_presence'::regclass) then
+    create trigger a2_notify_presence after insert or update or delete on a2_presence for each row execute function a2_notify_presence();
+  end if;
+end $$;