@nzpr/kb 0.1.0

package/migrations/0001_initial.sql

@@ -0,0 +1,77 @@
+CREATE EXTENSION IF NOT EXISTS vector;
+
+CREATE TABLE IF NOT EXISTS schema_migrations (
+  version INTEGER PRIMARY KEY,
+  name TEXT NOT NULL,
+  checksum TEXT NOT NULL,
+  applied_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
+);
+
+CREATE TABLE IF NOT EXISTS kb_metadata (
+  key TEXT PRIMARY KEY,
+  value TEXT NOT NULL
+);
+
+CREATE TABLE IF NOT EXISTS documents (
+  doc_id TEXT PRIMARY KEY,
+  path TEXT NOT NULL,
+  title TEXT NOT NULL,
+  scope TEXT NOT NULL,
+  topic TEXT NOT NULL,
+  status TEXT NOT NULL,
+  owner TEXT NOT NULL,
+  audience TEXT NOT NULL,
+  projects TEXT[] NOT NULL DEFAULT '{}',
+  tags TEXT[] NOT NULL DEFAULT '{}',
+  last_reviewed DATE NOT NULL,
+  content_hash TEXT NOT NULL,
+  updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
+);
+
+CREATE TABLE IF NOT EXISTS chunks (
+  chunk_id TEXT PRIMARY KEY,
+  doc_id TEXT NOT NULL REFERENCES documents(doc_id) ON DELETE CASCADE,
+  title TEXT NOT NULL,
+  heading TEXT NOT NULL,
+  content TEXT NOT NULL,
+  projects TEXT[] NOT NULL DEFAULT '{}',
+  tags TEXT[] NOT NULL DEFAULT '{}',
+  scope TEXT NOT NULL,
+  status TEXT NOT NULL,
+  topic TEXT NOT NULL,
+  path TEXT NOT NULL,
+  last_reviewed DATE NOT NULL,
+  embedding VECTOR(256) NOT NULL,
+  search_tsv tsvector NOT NULL DEFAULT ''::tsvector
+);
+
+CREATE OR REPLACE FUNCTION update_chunks_search_tsv()
+RETURNS trigger
+LANGUAGE plpgsql
+AS $$
+BEGIN
+  NEW.search_tsv :=
+    setweight(to_tsvector('english', coalesce(NEW.title, '')), 'A') ||
+    setweight(to_tsvector('english', coalesce(NEW.heading, '')), 'A') ||
+    setweight(to_tsvector('english', coalesce(NEW.content, '')), 'B') ||
+    setweight(to_tsvector('english', array_to_string(NEW.projects, ' ')), 'C') ||
+    setweight(to_tsvector('english', array_to_string(NEW.tags, ' ')), 'C');
+  RETURN NEW;
+END;
+$$;
+
+CREATE TRIGGER trg_chunks_search_tsv
+BEFORE INSERT OR UPDATE OF title, heading, content, projects, tags
+ON chunks
+FOR EACH ROW
+EXECUTE FUNCTION update_chunks_search_tsv();
+
+CREATE INDEX IF NOT EXISTS idx_chunks_search_tsv ON chunks USING GIN (search_tsv);
+CREATE INDEX IF NOT EXISTS idx_chunks_doc_id ON chunks (doc_id);
+CREATE INDEX IF NOT EXISTS idx_chunks_topic_status ON chunks (topic, status);
+CREATE INDEX IF NOT EXISTS idx_chunks_embedding_ivfflat
+  ON chunks USING ivfflat (embedding vector_cosine_ops) WITH (lists = 100);
+
+INSERT INTO kb_metadata (key, value)
+VALUES ('embedding_mode', 'local-hash'), ('embedding_dim', '256')
+ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value;

package/migrations/0002_relax_embedding_dimension.sql

@@ -0,0 +1,9 @@
+DROP INDEX IF EXISTS idx_chunks_embedding_ivfflat;
+
+ALTER TABLE chunks
+  ALTER COLUMN embedding TYPE VECTOR
+  USING embedding::VECTOR;
+
+INSERT INTO kb_metadata (key, value)
+VALUES ('embedding_model', '')
+ON CONFLICT (key) DO NOTHING;

package/migrations/0003_simplify_documents_table.sql

@@ -0,0 +1,64 @@
+ALTER TABLE documents
+  ADD COLUMN IF NOT EXISTS content TEXT NOT NULL DEFAULT '',
+  ADD COLUMN IF NOT EXISTS embedding VECTOR,
+  ADD COLUMN IF NOT EXISTS search_tsv tsvector NOT NULL DEFAULT ''::tsvector;
+
+CREATE OR REPLACE FUNCTION update_documents_search_tsv()
+RETURNS trigger
+LANGUAGE plpgsql
+AS $$
+BEGIN
+  NEW.search_tsv :=
+    setweight(to_tsvector('english', coalesce(NEW.title, '')), 'A') ||
+    setweight(to_tsvector('english', coalesce(NEW.content, '')), 'B');
+  RETURN NEW;
+END;
+$$;
+
+DROP TRIGGER IF EXISTS trg_documents_search_tsv ON documents;
+CREATE TRIGGER trg_documents_search_tsv
+BEFORE INSERT OR UPDATE OF title, content
+ON documents
+FOR EACH ROW
+EXECUTE FUNCTION update_documents_search_tsv();
+
+UPDATE documents AS d
+SET
+  content = COALESCE(
+    (
+      SELECT string_agg(c.content, E'\n\n' ORDER BY c.chunk_id)
+      FROM chunks AS c
+      WHERE c.doc_id = d.doc_id
+    ),
+    d.content,
+    ''
+  ),
+  embedding = COALESCE(
+    (
+      SELECT c.embedding
+      FROM chunks AS c
+      WHERE c.doc_id = d.doc_id
+      ORDER BY c.chunk_id
+      LIMIT 1
+    ),
+    d.embedding
+  );
+
+DELETE FROM documents WHERE embedding IS NULL;
+
+ALTER TABLE documents
+  ALTER COLUMN embedding SET NOT NULL;
+
+DROP TABLE IF EXISTS chunks;
+
+DROP INDEX IF EXISTS idx_documents_search_tsv;
+CREATE INDEX idx_documents_search_tsv ON documents USING GIN (search_tsv);
+
+ALTER TABLE documents DROP COLUMN IF EXISTS scope;
+ALTER TABLE documents DROP COLUMN IF EXISTS topic;
+ALTER TABLE documents DROP COLUMN IF EXISTS status;
+ALTER TABLE documents DROP COLUMN IF EXISTS owner;
+ALTER TABLE documents DROP COLUMN IF EXISTS audience;
+ALTER TABLE documents DROP COLUMN IF EXISTS projects;
+ALTER TABLE documents DROP COLUMN IF EXISTS tags;
+ALTER TABLE documents DROP COLUMN IF EXISTS last_reviewed;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@nzpr/kb",
+  "version": "0.1.0",
+  "description": "Postgres/pgvector-backed knowledge base CLI for LLM agents and engineering teams.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nzpr/kb.git"
+  },
+  "homepage": "https://github.com/nzpr/kb#readme",
+  "bugs": {
+    "url": "https://github.com/nzpr/kb/issues"
+  },
+  "type": "module",
+  "bin": {
+    "kb": "./bin/kb.js",
+    "kb-admin": "./bin/kb-admin.js"
+  },
+  "files": [
+    "bin/",
+    "lib/",
+    "migrations/",
+    "README.md",
+    "docker-compose.pgvector.yml",
+    ".env.example"
+  ],
+  "scripts": {
+    "test": "node --test",
+    "validate": "node --test",
+    "prepublishOnly": "npm test",
+    "start": "node ./bin/kb.js",
+    "publish-knowledge": "node ./bin/kb.js publish",
+    "admin": "node ./bin/kb-admin.js",
+    "migrate": "node ./bin/kb-admin.js migrate",
+    "init-db": "node ./bin/kb-admin.js init-db",
+    "ingest": "node ./bin/kb-admin.js ingest",
+    "schema-status": "node ./bin/kb-admin.js status",
+    "doctor": "node ./bin/kb.js doctor"
+  },
+  "keywords": [
+    "knowledge-base",
+    "cli",
+    "postgres",
+    "pgvector",
+    "llm",
+    "rag"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "pg": "^8.16.3",
+    "yaml": "^2.8.1"
+  }
+}