@beechcms/api 0.4.0-preview.9 → 0.4.1

package/src/search-utils.ts

@@ -1,192 +1,209 @@
-// apps/api/src/search-utils.ts
-// Pure functions — zero Hono dependencies, importable from Vitest.
-// v0.4.0: FTS is per-seed (fts_{slug}), joined with content_{slug} for metadata.
-
-import type { Seed } from "@beechcms/core"
-
-// ─── Types ───────────────────────────────────────────────────────────────────
-
-// Row returned by UNION ALL query across fts_{slug} JOIN content_{slug}
-export interface FtsRow {
-  entry_id:    string
-  schema_slug: string
-  slug:        string | null
-  status:      string
-  title:       string | null
-  excerpt:     string
-  rank:        number
-}
-
-export interface SearchResultItem {
-  id:          string
-  schema_slug: string
-  slug:        string | null
-  status:      string
-  title:       string
-  excerpt:     string
-  data:        Record<string, unknown>
-}
-
-export interface SearchResponse {
-  items:      SearchResultItem[]
-  nextCursor: string | null
-  total:      number
-}
-
-export interface SearchQueryParams {
-  q:          string
-  schemaSlug: string | null
-  status:     string | null
-  limit:      number         // already clamped 1–50 by handler
-  cursor:     string | null
-}
-
-// ─── Cursor ──────────────────────────────────────────────────────────────────
-
-export function encodeCursor(rank: number, entryId: string): string {
-  return btoa(`${rank}:${entryId}`)
-}
-
-export function decodeCursor(cursor: string): { rank: number; entryId: string } | null {
-  try {
-    const decoded = atob(cursor)
-    const sep     = decoded.lastIndexOf(":")
-    if (sep === -1) return null
-    return {
-      rank:    parseFloat(decoded.slice(0, sep)),
-      entryId: decoded.slice(sep + 1),
-    }
-  } catch {
-    return null
-  }
-}
-
-// ─── Helpers ─────────────────────────────────────────────────────────────────
-
-function hasSearchableFts(seed: Seed): boolean {
-  return seed.branches.some(b =>
-    (b.type === 'text' || b.type === 'richtext') && b.policies?.search !== false
-  )
-}
-
-function buildMatchExpr(q: string): string {
-  const MIN_PREFIX = 3
-  const safeQ = q.replace(/["*^()]/g, " ").trim()
-  const terms = safeQ.split(/\s+/).filter(t => t.length >= 2)
-  if (terms.length === 0) throw new Error("EMPTY_QUERY")
-
-  return terms
-    .map(t => {
-      if (/^\d+$/.test(t)) return `"${t}"`
-      if (t.length <= MIN_PREFIX) return `"${t}"*`
-      const prefixes: string[] = []
-      for (let i = MIN_PREFIX; i <= t.length; i++) {
-        prefixes.push(`"${t.slice(0, i)}"*`)
-      }
-      return `(${prefixes.join(" OR ")})`
-    })
-    .join(" ")
-}
-
-// ─── Query builder ───────────────────────────────────────────────────────────
-
-/**
- * Builds a UNION ALL query across all per-seed fts_{slug} tables (v0.4.0).
- * Each SELECT joins fts_{slug} with content_{slug} to fetch title, slug, status.
- * Seeds param: full registry — filtered internally by schemaSlug and FTS availability.
- */
-export function buildFtsQuery(
-  params: SearchQueryParams,
-  seeds: Seed[],
-): {
-  sql:        string
-  binds:      unknown[]
-  countSql:   string
-  countBinds: unknown[]
-} {
-  const { q, schemaSlug, status, limit, cursor } = params
-
-  const matchExpr = buildMatchExpr(q)  // throws EMPTY_QUERY if needed
-
-  const targetSeeds = seeds.filter(s =>
-    hasSearchableFts(s) && (schemaSlug === null || s.slug === schemaSlug)
-  )
-
-  if (targetSeeds.length === 0) {
-    return {
-      sql:        "SELECT NULL as entry_id, NULL as schema_slug, NULL as slug, NULL as status, NULL as title, '' as excerpt, 0 as rank WHERE 1=0",
-      binds:      [],
-      countSql:   "SELECT 0 as total",
-      countBinds: [],
-    }
-  }
-
-  const decoded = cursor ? decodeCursor(cursor) : null
-
-  const parts:       string[]  = []
-  const binds:       unknown[] = []
-  const countParts:  string[]  = []
-  const countBinds:  unknown[] = []
-
-  for (const seed of targetSeeds) {
-    const fts   = `fts_${seed.slug}`
-    const table = `content_${seed.slug}`
-    const title = seed.displayNameAlias
-
-    // Main query per seed
-    const where: string[]  = [`${fts} MATCH ?`]
-    const lb:    unknown[] = [matchExpr]
-
-    if (status) { where.push("ce.status = ?"); lb.push(status) }
-
-    if (decoded) {
-      where.push(`(bm25(${fts}) > ? OR (bm25(${fts}) = ? AND f.entry_id > ?))`)
-      lb.push(decoded.rank, decoded.rank, decoded.entryId)
-    }
-
-    parts.push(
-      `SELECT f.entry_id, '${seed.slug}' AS schema_slug, ce.slug, ce.status,` +
-      ` ce.${title} AS title,` +
-      ` snippet(${fts}, 1, '<mark>', '</mark>', '…', 16) AS excerpt,` +
-      ` bm25(${fts}) AS rank` +
-      ` FROM ${fts} f JOIN ${table} ce ON ce.id = f.entry_id` +
-      ` WHERE ${where.join(' AND ')}`
-    )
-    binds.push(...lb)
-
-    // Count per seed (no cursor, no limit)
-    const cw: string[]  = [`${fts} MATCH ?`]
-    const cb: unknown[] = [matchExpr]
-    if (status) { cw.push("ce.status = ?"); cb.push(status) }
-
-    countParts.push(
-      `SELECT COUNT(*) as c FROM ${fts} f JOIN ${table} ce ON ce.id = f.entry_id WHERE ${cw.join(' AND ')}`
-    )
-    countBinds.push(...cb)
-  }
-
-  const sql      = `${parts.join(' UNION ALL ')} ORDER BY rank, entry_id LIMIT ?`
-  binds.push(limit + 1)
-
-  const countSql = `SELECT SUM(c) as total FROM (${countParts.join(' UNION ALL ')})`
-
-  return { sql, binds, countSql, countBinds }
-}
-
-// ─── Mapper ──────────────────────────────────────────────────────────────────
-
-function stripHtmlPreserveMark(html: string): string {
-  return html.replace(/<(?!\/?mark\b)[^>]*>/gi, ' ').replace(/\s+/g, ' ').trim()
-}
-
-export function mapFtsRow(row: FtsRow): SearchResultItem {
-  return {
-    id:          row.entry_id,
-    schema_slug: row.schema_slug,
-    slug:        row.slug,
-    status:      row.status,
-    title:       row.title ?? "",
-    excerpt:     stripHtmlPreserveMark(row.excerpt ?? ""),
-    data:        {},
-  }
-}
+// apps/api/src/search-utils.ts
+// Pure functions — zero Hono dependencies, importable from Vitest.
+// v0.4.0: FTS is per-seed (fts_{slug}), joined with content_{slug} for metadata.
+
+import type { Seed, SearchResultRow } from "@beechcms/core"
+
+// ─── Types ───────────────────────────────────────────────────────────────────
+
+// Row returned by UNION ALL query across fts_{slug} JOIN content_{slug}
+export interface FtsRow {
+  entry_id:    string
+  schema_slug: string
+  slug:        string | null
+  status:      string
+  title:       string | null
+  excerpt:     string
+  rank:        number
+}
+
+export interface SearchResultItem {
+  id:          string
+  schema_slug: string
+  slug:        string | null
+  status:      string
+  title:       string
+  excerpt:     string
+  data:        Record<string, unknown>
+}
+
+export interface SearchResponse {
+  items:      SearchResultItem[]
+  nextCursor: string | null
+  total:      number
+}
+
+export interface SearchQueryParams {
+  q:          string
+  schemaSlug: string | null
+  status:     string | null
+  limit:      number         // already clamped 1–50 by handler
+  cursor:     string | null
+}
+
+// ─── Cursor ──────────────────────────────────────────────────────────────────
+
+export function encodeCursor(rank: number, entryId: string): string {
+  return btoa(`${rank}:${entryId}`)
+}
+
+export function decodeCursor(cursor: string): { rank: number; entryId: string } | null {
+  try {
+    const decoded = atob(cursor)
+    const sep     = decoded.lastIndexOf(":")
+    if (sep === -1) return null
+    return {
+      rank:    parseFloat(decoded.slice(0, sep)),
+      entryId: decoded.slice(sep + 1),
+    }
+  } catch {
+    return null
+  }
+}
+
+// ─── Helpers ─────────────────────────────────────────────────────────────────
+
+function hasSearchableFts(seed: Seed): boolean {
+  return seed.branches.some(b =>
+    (b.type === 'text' || b.type === 'richtext') && b.policies?.search !== false
+  )
+}
+
+function buildMatchExpr(q: string): string {
+  const MIN_PREFIX = 3
+  const safeQ = q.replace(/["*^()]/g, " ").trim()
+  const terms = safeQ.split(/\s+/).filter(t => t.length >= 2)
+  if (terms.length === 0) throw new Error("EMPTY_QUERY")
+
+  return terms
+    .map(t => {
+      if (/^\d+$/.test(t)) return `"${t}"`
+      if (t.length <= MIN_PREFIX) return `"${t}"*`
+      const prefixes: string[] = []
+      for (let i = MIN_PREFIX; i <= t.length; i++) {
+        prefixes.push(`"${t.slice(0, i)}"*`)
+      }
+      return `(${prefixes.join(" OR ")})`
+    })
+    .join(" ")
+}
+
+// ─── Query builder ───────────────────────────────────────────────────────────
+
+/**
+ * Builds a UNION ALL query across all per-seed fts_{slug} tables (v0.4.0).
+ * Each SELECT joins fts_{slug} with content_{slug} to fetch title, slug, status.
+ * Seeds param: full registry — filtered internally by schemaSlug and FTS availability.
+ */
+export function buildFtsQuery(
+  params: SearchQueryParams,
+  seeds: Seed[],
+): {
+  sql:        string
+  binds:      unknown[]
+  countSql:   string
+  countBinds: unknown[]
+} {
+  const { q, schemaSlug, status, limit, cursor } = params
+
+  const matchExpr = buildMatchExpr(q)  // throws EMPTY_QUERY if needed
+
+  const targetSeeds = seeds.filter(s =>
+    hasSearchableFts(s) && (schemaSlug === null || s.slug === schemaSlug)
+  )
+
+  if (targetSeeds.length === 0) {
+    return {
+      sql:        "SELECT NULL as entry_id, NULL as schema_slug, NULL as slug, NULL as status, NULL as title, '' as excerpt, 0 as rank WHERE 1=0",
+      binds:      [],
+      countSql:   "SELECT 0 as total",
+      countBinds: [],
+    }
+  }
+
+  const decoded = cursor ? decodeCursor(cursor) : null
+
+  const parts:       string[]  = []
+  const binds:       unknown[] = []
+  const countParts:  string[]  = []
+  const countBinds:  unknown[] = []
+
+  for (const seed of targetSeeds) {
+    const fts   = `fts_${seed.slug}`
+    const table = `content_${seed.slug}`
+    const title = seed.displayNameAlias
+
+    // Main query per seed
+    const where: string[]  = [`${fts} MATCH ?`]
+    const lb:    unknown[] = [matchExpr]
+
+    if (status) { where.push("ce.status = ?"); lb.push(status) }
+
+    if (decoded) {
+      where.push(`(bm25(${fts}) > ? OR (bm25(${fts}) = ? AND f.entry_id > ?))`)
+      lb.push(decoded.rank, decoded.rank, decoded.entryId)
+    }
+
+    parts.push(
+      `SELECT f.entry_id, '${seed.slug}' AS schema_slug, ce.slug, ce.status,` +
+      ` ce.${title} AS title,` +
+      ` snippet(${fts}, 1, '<mark>', '</mark>', '…', 16) AS excerpt,` +
+      ` bm25(${fts}) AS rank` +
+      ` FROM ${fts} f JOIN ${table} ce ON ce.id = f.entry_id` +
+      ` WHERE ${where.join(' AND ')}`
+    )
+    binds.push(...lb)
+
+    // Count per seed (no cursor, no limit)
+    const cw: string[]  = [`${fts} MATCH ?`]
+    const cb: unknown[] = [matchExpr]
+    if (status) { cw.push("ce.status = ?"); cb.push(status) }
+
+    countParts.push(
+      `SELECT COUNT(*) as c FROM ${fts} f JOIN ${table} ce ON ce.id = f.entry_id WHERE ${cw.join(' AND ')}`
+    )
+    countBinds.push(...cb)
+  }
+
+  const sql      = `${parts.join(' UNION ALL ')} ORDER BY rank, entry_id LIMIT ?`
+  binds.push(limit + 1)
+
+  const countSql = `SELECT SUM(c) as total FROM (${countParts.join(' UNION ALL ')})`
+
+  return { sql, binds, countSql, countBinds }
+}
+
+// ─── Mapper ──────────────────────────────────────────────────────────────────
+
+function stripHtmlPreserveMark(html: string): string {
+  return html.replace(/<(?!\/?mark\b)[^>]*>/gi, ' ').replace(/\s+/g, ' ').trim()
+}
+
+export function mapFtsRow(row: FtsRow): SearchResultItem {
+  return {
+    id:          row.entry_id,
+    schema_slug: row.schema_slug,
+    slug:        row.slug,
+    status:      row.status,
+    title:       row.title ?? "",
+    excerpt:     stripHtmlPreserveMark(row.excerpt ?? ""),
+    data:        {},
+  }
+}
+
+/**
+ * Maps a repository-shaped SearchResultRow (camelCase) to the wire-format
+ * SearchResultItem returned by the /api/search route. Keeps the HTML
+ * stripping behaviour previously inlined inside mapFtsRow.
+ */
+export function mapSearchResultRow(row: SearchResultRow): SearchResultItem {
+  return {
+    id:          row.entryId,
+    schema_slug: row.schemaSlug,
+    slug:        row.slug,
+    status:      row.status,
+    title:       row.title ?? "",
+    excerpt:     stripHtmlPreserveMark(row.excerpt ?? ""),
+    data:        {},
+  }
+}

package/src/search.ts

@@ -1,72 +1,61 @@
-// apps/api/src/search.ts
-
-import { Hono }              from "hono"
-import type { Env, Variables } from "./types"
-import { authMiddleware }    from "./middleware"
-import {
-  buildFtsQuery,
-  encodeCursor,
-  mapFtsRow,
-  type FtsRow,
-  type SearchResponse,
-} from "./search-utils"
-
-export const searchRouter = new Hono<{ Bindings: Env; Variables: Variables }>()
-
-searchRouter.use("*", async (c, next) => {
-  return authMiddleware(c.env.JWT_SECRET, {
-    issuer: c.env.JWT_ISSUER,
-    audience: c.env.JWT_AUDIENCE,
-  })(c, next)
-})
-
-// GET /api/search?q=...&schema_slug=...&status=...&limit=20&cursor=...
-searchRouter.get("/", async (c) => {
-  const q          = c.req.query("q")?.trim() ?? ""
-  const schemaSlug = c.req.query("schema_slug") ?? null
-  const status     = c.req.query("status") ?? null
-  const rawLimit   = parseInt(c.req.query("limit") ?? "20", 10)
-  const limit      = Math.min(Math.max(rawLimit, 1), 50)
-  const cursor     = c.req.query("cursor") ?? null
-
-  if (q.length < 2) {
-    return c.json({ error: "Il parametro 'q' deve avere almeno 2 caratteri." }, 400)
-  }
-
-  const seeds = Object.values(c.get('seedRegistry'))
-
-  let queryParts: ReturnType<typeof buildFtsQuery>
-  try {
-    queryParts = buildFtsQuery({ q, schemaSlug, status, limit, cursor }, seeds)
-  } catch (e) {
-    if ((e as Error).message === "EMPTY_QUERY") {
-      return c.json({ items: [], nextCursor: null, total: 0 } satisfies SearchResponse)
-    }
-    throw e
-  }
-
-  const { sql, binds, countSql, countBinds } = queryParts
-
-  const [ftsResult, countResult] = await Promise.all([
-    c.env.DB.prepare(sql).bind(...binds).all<FtsRow>(),
-    c.env.DB.prepare(countSql).bind(...countBinds).first<{ total: number }>(),
-  ])
-
-  const rows  = ftsResult.results ?? []
-  const total = countResult?.total ?? 0
-
-  const hasMore  = rows.length > limit
-  const pageRows = hasMore ? rows.slice(0, limit) : rows
-
-  const nextCursor = hasMore
-    ? encodeCursor(pageRows.at(-1)!.rank, pageRows.at(-1)!.entry_id)
-    : null
-
-  if (pageRows.length === 0) {
-    return c.json({ items: [], nextCursor: null, total } satisfies SearchResponse)
-  }
-
-  const items = pageRows.map(row => mapFtsRow(row))
-
-  return c.json({ items, nextCursor, total } satisfies SearchResponse)
-})
+// apps/api/src/search.ts
+
+import { Hono }              from "hono"
+import type { Env, Variables } from "./types"
+import { authMiddleware }    from "./middleware"
+import {
+  encodeCursor,
+  mapSearchResultRow,
+  type SearchResponse,
+} from "./search-utils"
+
+export const searchRouter = new Hono<{ Bindings: Env; Variables: Variables }>()
+
+searchRouter.use("*", authMiddleware())
+
+// GET /api/search?q=...&schema_slug=...&status=...&limit=20&cursor=...
+searchRouter.get("/", async (c) => {
+  const queryText  = c.req.query("q")?.trim() ?? ""
+  const schemaSlug = c.req.query("schema_slug") ?? null
+  const status     = c.req.query("status") ?? null
+  const rawLimit   = parseInt(c.req.query("limit") ?? "20", 10)
+  const limit      = Math.min(Math.max(rawLimit, 1), 50)
+  const cursor     = c.req.query("cursor") ?? null
+
+  if (queryText.length < 2) {
+    return c.json({ error: "Il parametro 'q' deve avere almeno 2 caratteri." }, 400)
+  }
+
+  const seeds = c.get('seedRegistry').all()
+  const searchRepository = c.get('searchRepository')
+
+  const queryOptions = {
+    queryText,
+    schemaSlug,
+    statusFilter: status,
+    limit,
+    cursor,
+  }
+  const countOptions = { queryText, schemaSlug, statusFilter: status }
+
+  const [rawRows, countResult] = await Promise.all([
+    searchRepository.search(queryOptions, seeds),
+    searchRepository.count(countOptions, seeds),
+  ])
+
+  const hasMore  = rawRows.length > limit
+  const pageRows = hasMore ? rawRows.slice(0, limit) : rawRows
+
+  const lastRow = pageRows.at(-1)
+  const nextCursor = hasMore && lastRow
+    ? encodeCursor(lastRow.rank, lastRow.entryId)
+    : null
+
+  if (pageRows.length === 0) {
+    return c.json({ items: [], nextCursor: null, total: countResult.total } satisfies SearchResponse)
+  }
+
+  const items = pageRows.map(mapSearchResultRow)
+
+  return c.json({ items, nextCursor, total: countResult.total } satisfies SearchResponse)
+})

package/src/shared/apply-policies.test.ts

@@ -0,0 +1,77 @@
+import { describe, it, expect } from 'vitest'
+import { applyPrivacy, applyVisibility, PrivacyPolicyError } from './apply-policies'
+import type { Seed } from '@beechcms/core'
+
+function makeSeed(branches: any[]): Seed {
+  return { slug: 'test', displayNameAlias: 'title', branches } as unknown as Seed
+}
+
+// ─── applyPrivacy ─────────────────────────────────────────────────────────────
+
+describe('applyPrivacy', () => {
+  it('passes through fields with no privacy policy (default: public)', async () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'title', type: 'text' }])
+    const result = await applyPrivacy({ title: 'Hello' }, seed)
+    expect(result.title).toBe('Hello')
+  })
+
+  it('hashes the value when branch privacy is "hash"', async () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'email', type: 'text', policies: { privacy: 'hash' } }])
+    const result = await applyPrivacy({ email: 'user@test.com' }, seed)
+    // sha256 produces a 64-char hex string
+    expect(typeof result.email).toBe('string')
+    expect((result.email as string).length).toBe(64)
+    expect(result.email).not.toBe('user@test.com')
+  })
+
+  it('leaves null/undefined values unhashed even when privacy is "hash"', async () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'email', type: 'text', policies: { privacy: 'hash' } }])
+    const result = await applyPrivacy({ email: null }, seed)
+    expect(result.email).toBeNull()
+  })
+
+  it('throws PrivacyPolicyError for "encrypt" privacy (not yet implemented)', async () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'secret', type: 'text', policies: { privacy: 'encrypt' } }])
+    await expect(applyPrivacy({ secret: 'value' }, seed)).rejects.toBeInstanceOf(PrivacyPolicyError)
+  })
+
+  it('passes through fields not present in the seed branches unchanged', async () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'title', type: 'text' }])
+    const result = await applyPrivacy({ title: 'Hi', extraField: 'extra' }, seed)
+    expect(result.extraField).toBe('extra')
+  })
+})
+
+// ─── applyVisibility ──────────────────────────────────────────────────────────
+
+describe('applyVisibility', () => {
+  it('includes fields with default (visible) visibility', () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'title', type: 'text' }])
+    const result = applyVisibility({ title: 'Hello' }, seed)
+    expect(result.title).toBe('Hello')
+  })
+
+  it('omits fields with visibility "hidden"', () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'internal', type: 'text', policies: { visibility: 'hidden' } }])
+    const result = applyVisibility({ internal: 'secret' }, seed)
+    expect(result).not.toHaveProperty('internal')
+  })
+
+  it('masks non-empty string fields with visibility "masked"', () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'password', type: 'text', policies: { visibility: 'masked' } }])
+    const result = applyVisibility({ password: 'secret123' }, seed)
+    expect(result.password).toBe('••••••••')
+  })
+
+  it('returns null for empty string fields with visibility "masked"', () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'password', type: 'text', policies: { visibility: 'masked' } }])
+    const result = applyVisibility({ password: '' }, seed)
+    expect(result.password).toBeNull()
+  })
+
+  it('passes through fields not present in the seed branches', () => {
+    const seed = makeSeed([{ id: 'br_01', alias: 'title', type: 'text' }])
+    const result = applyVisibility({ title: 'Hi', extraField: 'pass' }, seed)
+    expect(result.extraField).toBe('pass')
+  })
+})