@beechcms/api 0.5.0 → 0.6.0-preview.2

package/src/middleware.ts

@@ -1,47 +1,45 @@
-/// <reference types="@cloudflare/workers-types" />
-import type { Context, Next } from 'hono'
-import { HTTPException } from 'hono/http-exception'
-import type { Env, Variables } from './types'
-
-export type JwtPayload = {
-  sub: string
-  email?: string
-  name?: string
-}
-
-const UNAUTHORIZED_JSON = JSON.stringify({ error: 'Unauthorized' })
-
-function unauthorizedResponse() {
-  return new Response(UNAUTHORIZED_JSON, {
-    status: 401,
-    headers: { 'Content-Type': 'application/json' },
-  })
-}
-
-/**
- * JWT authentication middleware. Reads the Bearer token from the Authorization
- * header and delegates verification to the ITokenService injected in context.
- * Returns 401 on any missing or invalid token; never exposes failure details.
- */
-export function authMiddleware() {
-  return async (c: Context<{ Bindings: Env; Variables: Variables }>, next: Next): Promise<Response | void> => {
-    const authHeader = c.req.header('Authorization')
-    if (!authHeader?.startsWith('Bearer ')) {
-      throw new HTTPException(401, { res: unauthorizedResponse() })
-    }
-
-    const token = authHeader.slice(7)
-    if (!token) {
-      throw new HTTPException(401, { res: unauthorizedResponse() })
-    }
-
-    const claims = await c.get('tokenService').verify(token)
-
-    if (!claims) {
-      throw new HTTPException(401, { res: unauthorizedResponse() })
-    }
-
-    c.set('jwtPayload', claims as JwtPayload)
-    await next()
-  }
-}
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+/// <reference types="@cloudflare/workers-types" />
+import type { Context, Next } from 'hono'
+import { HTTPException } from 'hono/http-exception'
+import type { Env, Variables } from './types'
+
+const UNAUTHORIZED_JSON = JSON.stringify({ error: 'Unauthorized' })
+
+function unauthorizedResponse() {
+  return new Response(UNAUTHORIZED_JSON, {
+    status: 401,
+    headers: { 'Content-Type': 'application/json' },
+  })
+}
+
+/**
+ * JWT authentication middleware. Reads the Bearer token from the Authorization
+ * header and delegates verification to the ITokenService injected in context.
+ * Returns 401 on any missing or invalid token; never exposes failure details.
+ */
+export function authMiddleware() {
+  return async (c: Context<{ Bindings: Env; Variables: Variables }>, next: Next): Promise<Response | void> => {
+    const authHeader = c.req.header('Authorization')
+    if (!authHeader?.startsWith('Bearer ')) {
+      throw new HTTPException(401, { res: unauthorizedResponse() })
+    }
+
+    const token = authHeader.slice(7)
+    if (!token) {
+      throw new HTTPException(401, { res: unauthorizedResponse() })
+    }
+
+    const claims = await c.get('tokenService').verify(token)
+
+    if (!claims) {
+      throw new HTTPException(401, { res: unauthorizedResponse() })
+    }
+
+    c.set('jwtPayload', claims)
+    await next()
+  }
+}

package/src/public/access-policy.ts

@@ -1,23 +1,27 @@
-import type { Seed } from '@beechcms/core'
-
-export type PublicOperation = 'read' | 'add' | 'edit'
-
-function isAllowed(seed: Seed, operation: PublicOperation): boolean {
-  if (operation === 'read') return seed.allowPublicRead === true
-  if (operation === 'add') return seed.allowPublicPost === true
-  return seed.allowPublicEdit === true
-}
-
-export function checkPublicOperation(seed: Seed, operation: PublicOperation) {
-  if (isAllowed(seed, operation)) {
-    return { ok: true } as const
-  }
-
-  return {
-    ok: false,
-    error: {
-      error: 'Forbidden',
-      message: `Public ${operation.toUpperCase()} is not allowed for content type '${seed.slug}'.`,
-    },
-  } as const
-}
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import type { Seed } from '@beechcms/core'
+
+export type PublicOperation = 'read' | 'add' | 'edit'
+
+function isAllowed(seed: Seed, operation: PublicOperation): boolean {
+  if (operation === 'read') return seed.allowPublicRead === true
+  if (operation === 'add') return seed.allowPublicPost === true
+  return seed.allowPublicEdit === true
+}
+
+export function checkPublicOperation(seed: Seed, operation: PublicOperation) {
+  if (isAllowed(seed, operation)) {
+    return { ok: true } as const
+  }
+
+  return {
+    ok: false,
+    error: {
+      error: 'Forbidden',
+      message: `Public ${operation.toUpperCase()} is not allowed for content type '${seed.slug}'.`,
+    },
+  } as const
+}

package/src/public/api-key-middleware.ts

@@ -1,53 +1,57 @@
-import type { Context, Next } from 'hono'
-import { PUBLIC_ERRORS } from './public-errors'
-import { publicProblem } from './problem-details'
-
-type PublicBindings = {
-  PUBLIC_READ_API_KEY?: string
-  PUBLIC_WRITE_API_KEY?: string
-}
-
-function isReadMethod(method: string): boolean {
-  return method === 'GET' || method === 'HEAD' || method === 'OPTIONS'
-}
-
-function getConfiguredKey(env: PublicBindings, method: string): string | undefined {
-  if (isReadMethod(method)) {
-    return env.PUBLIC_READ_API_KEY
-  }
-  return env.PUBLIC_WRITE_API_KEY
-}
-
-/**
- * API key auth middleware for Public API routes.
- * Uses X-API-Key header only.
- */
-export function apiKeyMiddleware() {
-  return async (c: Context, next: Next): Promise<Response | void> => {
-    const env = c.env as PublicBindings
-    const configuredKey = getConfiguredKey(env, c.req.method)
-
-    if (!configuredKey) {
-      return publicProblem(c, {
-        type: 'public-api-not-configured',
-        title: PUBLIC_ERRORS.API_KEY_FORBIDDEN.error,
-        status: 403,
-        detail: PUBLIC_ERRORS.API_KEY_FORBIDDEN.message,
-      })
-    }
-
-    const providedKey = c.req.header('X-API-Key')
-
-    if (!providedKey || providedKey !== configuredKey) {
-      return publicProblem(c, {
-        type: 'public-api-key-unauthorized',
-        title: PUBLIC_ERRORS.API_KEY_UNAUTHORIZED.error,
-        status: 401,
-        detail: PUBLIC_ERRORS.API_KEY_UNAUTHORIZED.message,
-      })
-    }
-
-    await next()
-  }
-}
-
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import type { Context, Next } from 'hono'
+import { PUBLIC_ERRORS } from './public-errors'
+import { publicProblem } from './problem-details'
+
+type PublicBindings = {
+  PUBLIC_READ_API_KEY?: string
+  PUBLIC_WRITE_API_KEY?: string
+}
+
+function isReadMethod(method: string): boolean {
+  return method === 'GET' || method === 'HEAD' || method === 'OPTIONS'
+}
+
+function getConfiguredKey(env: PublicBindings, method: string): string | undefined {
+  if (isReadMethod(method)) {
+    return env.PUBLIC_READ_API_KEY
+  }
+  return env.PUBLIC_WRITE_API_KEY
+}
+
+/**
+ * API key auth middleware for Public API routes.
+ * Uses X-API-Key header only.
+ */
+export function apiKeyMiddleware() {
+  return async (c: Context, next: Next): Promise<Response | void> => {
+    const env = c.env as PublicBindings
+    const configuredKey = getConfiguredKey(env, c.req.method)
+
+    if (!configuredKey) {
+      return publicProblem(c, {
+        type: 'public-api-not-configured',
+        title: PUBLIC_ERRORS.API_KEY_FORBIDDEN.error,
+        status: 403,
+        detail: PUBLIC_ERRORS.API_KEY_FORBIDDEN.message,
+      })
+    }
+
+    const providedKey = c.req.header('X-API-Key')
+
+    if (!providedKey || providedKey !== configuredKey) {
+      return publicProblem(c, {
+        type: 'public-api-key-unauthorized',
+        title: PUBLIC_ERRORS.API_KEY_UNAUTHORIZED.error,
+        status: 401,
+        detail: PUBLIC_ERRORS.API_KEY_UNAUTHORIZED.message,
+      })
+    }
+
+    await next()
+  }
+}
+

package/src/public/cache-utils.ts

@@ -1,34 +1,38 @@
-import type { Context } from 'hono'
-
-type EdgeCache = {
-  cache: Cache
-  executionCtx: { waitUntil: (p: Promise<unknown>) => void }
-} | null
-
-export function resolveEdgeCache(c: Context): EdgeCache {
-  try {
-    const cache = caches.default
-    let executionCtx: any
-    try {
-      executionCtx = c.executionCtx
-    } catch {
-      return null
-    }
-
-    if (!executionCtx?.waitUntil) return null
-    return { cache, executionCtx: executionCtx as { waitUntil: (p: Promise<unknown>) => void } }
-  } catch {
-    return null
-  }
-}
-
-export function withCachedResponse(edgeCache: EdgeCache, cacheKey: Request, response: Response): Response {
-  if (!edgeCache) return response
-  const cloned = response.clone()
-  const headers = new Headers(cloned.headers)
-  headers.set('Cache-Control', 'public, max-age=60')
-  edgeCache.executionCtx.waitUntil(
-    edgeCache.cache.put(cacheKey, new Response(cloned.body, { status: cloned.status, headers }))
-  )
-  return response
-}
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import type { Context } from 'hono'
+
+type EdgeCache = {
+  cache: Cache
+  executionCtx: { waitUntil: (p: Promise<unknown>) => void }
+} | null
+
+export function resolveEdgeCache(c: Context): EdgeCache {
+  try {
+    const cache = caches.default
+    let executionCtx: any
+    try {
+      executionCtx = c.executionCtx
+    } catch {
+      return null
+    }
+
+    if (!executionCtx?.waitUntil) return null
+    return { cache, executionCtx: executionCtx as { waitUntil: (p: Promise<unknown>) => void } }
+  } catch {
+    return null
+  }
+}
+
+export function withCachedResponse(edgeCache: EdgeCache, cacheKey: Request, response: Response): Response {
+  if (!edgeCache) return response
+  const cloned = response.clone()
+  const headers = new Headers(cloned.headers)
+  headers.set('Cache-Control', 'public, max-age=60')
+  edgeCache.executionCtx.waitUntil(
+    edgeCache.cache.put(cacheKey, new Response(cloned.body, { status: cloned.status, headers }))
+  )
+  return response
+}

package/src/public/entry-projection.ts

@@ -1,42 +1,46 @@
-import { resolvePolicies } from '@beechcms/core'
-import type { Seed } from '@beechcms/core'
-
-const SYSTEM_FIELDS = ['id', 'slug', 'status', 'created_at', 'updated_at']
-const IDENTITY_FIELDS = ['id', 'slug']
-
-function applyPublicPolicies(data: Record<string, unknown>, seed: Seed): Record<string, unknown> {
-  const result: Record<string, unknown> = {}
-
-  for (const key of SYSTEM_FIELDS) {
-    if (key in data) result[key] = data[key]
-  }
-
-  for (const branch of seed.branches) {
-    const value = data[branch.alias]
-    const { public: isPublic, visibility } = resolvePolicies(branch)
-    if (!isPublic) continue
-    if (visibility === 'hidden') continue
-    result[branch.alias] = visibility === 'masked' && typeof value === 'string' && value.length > 0
-      ? '••••••••'
-      : value
-  }
-  return result
-}
-
-export function toFlatPublicEntry(data: Record<string, unknown>, seed: Seed, fieldsParam?: string): Record<string, unknown> {
-  const projected = applyPublicPolicies(data, seed)
-  const requestedFields = (fieldsParam ?? '').split(',').map(f => f.trim()).filter(Boolean)
-
-  if (requestedFields.length === 0) return projected
-
-  const filtered: Record<string, unknown> = {}
-  for (const field of requestedFields) {
-    if (field in projected) filtered[field] = projected[field]
-  }
-
-  for (const key of IDENTITY_FIELDS) {
-    if (key in projected && !filtered[key]) filtered[key] = projected[key]
-  }
-
-  return filtered
-}
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import { resolvePolicies } from '@beechcms/core'
+import type { Seed } from '@beechcms/core'
+
+const SYSTEM_FIELDS = ['id', 'slug', 'status', 'created_at', 'updated_at']
+const IDENTITY_FIELDS = ['id', 'slug']
+
+function applyPublicPolicies(data: Record<string, unknown>, seed: Seed): Record<string, unknown> {
+  const result: Record<string, unknown> = {}
+
+  for (const key of SYSTEM_FIELDS) {
+    if (key in data) result[key] = data[key]
+  }
+
+  for (const branch of seed.branches) {
+    const value = data[branch.alias]
+    const { public: isPublic, visibility } = resolvePolicies(branch)
+    if (!isPublic) continue
+    if (visibility === 'hidden') continue
+    result[branch.alias] = visibility === 'masked' && typeof value === 'string' && value.length > 0
+      ? '••••••••'
+      : value
+  }
+  return result
+}
+
+export function toFlatPublicEntry(data: Record<string, unknown>, seed: Seed, fieldsParam?: string): Record<string, unknown> {
+  const projected = applyPublicPolicies(data, seed)
+  const requestedFields = (fieldsParam ?? '').split(',').map(f => f.trim()).filter(Boolean)
+
+  if (requestedFields.length === 0) return projected
+
+  const filtered: Record<string, unknown> = {}
+  for (const field of requestedFields) {
+    if (field in projected) filtered[field] = projected[field]
+  }
+
+  for (const key of IDENTITY_FIELDS) {
+    if (key in projected && !filtered[key]) filtered[key] = projected[key]
+  }
+
+  return filtered
+}

package/src/public/idempotency.ts

@@ -1,19 +1,23 @@
-import { sha256hex } from '@beechcms/core'
-
-export function parseIdempotencyKey(rawValue: string | undefined): string | null {
-  if (!rawValue) return null
-  const key = rawValue.trim()
-  if (!key || key.length > 128) return null
-  return key
-}
-
-type FingerprintInput = {
-  seedSlug: string
-  statusValue: unknown
-  slug: string | null
-  data: Record<string, unknown>
-}
-
-export function buildRequestFingerprint(input: FingerprintInput): Promise<string> {
-  return sha256hex(JSON.stringify({ seedSlug: input.seedSlug, statusValue: input.statusValue, slug: input.slug, data: input.data }))
-}
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+import { sha256hex } from '@beechcms/core'
+
+export function parseIdempotencyKey(rawValue: string | undefined): string | null {
+  if (!rawValue) return null
+  const key = rawValue.trim()
+  if (!key || key.length > 128) return null
+  return key
+}
+
+type FingerprintInput = {
+  seedSlug: string
+  statusValue: unknown
+  slug: string | null
+  data: Record<string, unknown>
+}
+
+export function buildRequestFingerprint(input: FingerprintInput): Promise<string> {
+  return sha256hex(JSON.stringify({ seedSlug: input.seedSlug, statusValue: input.statusValue, slug: input.slug, data: input.data }))
+}

package/src/public/index.ts

@@ -1,12 +1,16 @@
-export { apiKeyMiddleware } from './api-key-middleware'
-export { publicRateLimitMiddleware } from './rate-limit-middleware'
-export { publicRoutes } from './public-routes'
-export { PUBLIC_ERRORS } from './public-errors'
-export { sanitizePublicPayload } from './sanitize'
-export { generateEntrySlug, slugify } from './slug-utils'
-export { buildPublicListMeta, buildPublicSingleMeta } from './response-builder'
-export { parseLatestCount, parsePublicPagination } from './query-builder'
-export { publicReadHandler } from './public-read'
-export { publicAddHandler } from './public-add'
-export { publicEditHandler } from './public-edit'
-
+// SPDX-License-Identifier: BUSL-1.1
+// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
+// See LICENSE in the repository root for license terms.
+
+export { apiKeyMiddleware } from './api-key-middleware'
+export { publicRateLimitMiddleware } from './rate-limit-middleware'
+export { publicRoutes } from './public-routes'
+export { PUBLIC_ERRORS } from './public-errors'
+export { sanitizePublicPayload } from './sanitize'
+export { generateEntrySlug, slugify } from './slug-utils'
+export { buildPublicListMeta, buildPublicSingleMeta } from './response-builder'
+export { parseLatestCount, parsePublicPagination } from './query-builder'
+export { publicReadHandler } from './public-read'
+export { publicAddHandler } from './public-add'
+export { publicEditHandler } from './public-edit'
+