bunderstack 0.17.0-beta.0 → 0.17.0-beta.3

package/src/access.ts

@@ -1,552 +0,0 @@
-import { getTableColumns, getTableName, isTable } from 'drizzle-orm'
-
-import { INTERNAL_TABLE_NAMES } from './internal-tables'
-
-export const AUTH_TABLE_NAMES = new Set([
-  'user',
-  'session',
-  'account',
-  'verification',
-])
-
-const EXPOSEABLE_AUTH_TABLES = new Set(['user'])
-
-export type AccessUser = {
-  id: string
-  email: string
-  name?: string
-  role?: string
-}
-
-export type AccessContext = {
-  user: AccessUser | null
-  request: Request
-  row?: Record<string, unknown>
-  body?: Record<string, unknown>
-  session?: { activeOrganizationId: string | null } | null
-}
-
-export type OperationRule =
-  | 'public'
-  | 'authenticated'
-  | 'owner'
-  | 'deny'
-  | ((ctx: AccessContext) => boolean | Promise<boolean>)
-
-export type ScopeMap = Record<string, string | string[]>
-export type ScopeResolver = (ctx: AccessContext) => ScopeMap
-
-export type CrudOperation = 'list' | 'get' | 'create' | 'update' | 'delete'
-
-const RESERVED_LIST_PARAMS = new Set([
-  'limit',
-  'offset',
-  'sort',
-  'order',
-  'q',
-  'cursor',
-  'count',
-])
-
-export type SortOrder = 'asc' | 'desc'
-
-export type DefaultSort = {
-  column: string
-  order: SortOrder
-}
-
-export type TableAccessInput = {
-  crud?: boolean
-  /** Opt the BetterAuth `user` table into auto-CRUD (read profiles, owner-update image). */
-  exposeAuthTable?: boolean
-  ownerColumn?: string
-  list?: OperationRule
-  get?: OperationRule
-  create?: OperationRule
-  update?: OperationRule
-  delete?: OperationRule
-  /** Explicit write allowlist. Entries override matching system-readonly
-   * defaults such as `updatedAt`; `id` remains immutable on update. */
-  writableColumns?: string[]
-  readonlyColumns?: string[]
-  /** Columns matched by `?q=` on list — opt-in; omitted columns are never searched. */
-  searchableColumns?: string[]
-  /** Columns filterable via flat `?column=value` query params. */
-  filterableColumns?: string[]
-  /** Columns allowed in `?sort=`. Defaults to `['id']`. */
-  sortableColumns?: string[]
-  /** Default list ordering when `?sort` is omitted. Defaults to `{ column: 'id', order: 'desc' }`. */
-  defaultSort?: DefaultSort
-  scope?: {
-    read?: ScopeResolver
-    write?: ScopeResolver
-  }
-}
-
-export type ResolvedTableAccess = {
-  tableKey: string
-  tableName: string
-  enabled: boolean
-  ownerColumn?: string
-  list: OperationRule
-  get: OperationRule
-  create: OperationRule
-  update: OperationRule
-  delete: OperationRule
-  writableColumns?: string[]
-  readonlyColumns: string[]
-  searchableColumns?: string[]
-  filterableColumns: string[]
-  sortableColumns: string[]
-  defaultSort: DefaultSort
-  readScope?: ScopeResolver
-  writeScope?: ScopeResolver
-}
-
-export type ResolvedAccess = Map<string, ResolvedTableAccess>
-
-/**
- * Look up a table's resolved access by its physical table name.
- *
- * `ResolvedAccess` is keyed by schema export name, not table name, so every
- * consumer that starts from a physical name needs this scan. It lives here so
- * CRUD, realtime, and route validation cannot drift apart on which tables they
- * consider enabled.
- */
-export function tableEntryForName(
-  access: ResolvedAccess,
-  tableName: string,
-): ResolvedTableAccess | undefined {
-  for (const entry of access.values()) {
-    if (entry.tableName === tableName) return entry
-  }
-  return undefined
-}
-
-const DEFAULT_READONLY = [
-  'id',
-  'createdAt',
-  'updatedAt',
-  'created_at',
-  'updated_at',
-]
-
-function getSchemaTables<TSchema extends Record<string, unknown>>(
-  schema: TSchema,
-) {
-  const tables: {
-    key: string
-    table: Parameters<typeof getTableName>[0]
-    name: string
-    columns: string[]
-  }[] = []
-  for (const [key, value] of Object.entries(schema)) {
-    if (!isTable(value)) continue
-    const name = getTableName(value)
-    const columns = Object.keys(getTableColumns(value))
-    tables.push({ key, table: value, name, columns })
-  }
-  return tables
-}
-
-function resolveListAccess(
-  input: TableAccessInput,
-  columns: string[],
-): Pick<
-  ResolvedTableAccess,
-  'filterableColumns' | 'sortableColumns' | 'defaultSort'
-> {
-  const sortableColumns =
-    input.sortableColumns ?? (columns.includes('id') ? ['id'] : [])
-  const defaultSort: DefaultSort = input.defaultSort ?? {
-    column: sortableColumns[0] ?? 'id',
-    order: 'desc',
-  }
-
-  if (!columns.includes(defaultSort.column)) {
-    throw new Error(
-      `[bunderstack] defaultSort.column "${defaultSort.column}" is not a column on this table`,
-    )
-  }
-  if (!sortableColumns.includes(defaultSort.column)) {
-    throw new Error(
-      `[bunderstack] defaultSort.column "${defaultSort.column}" must be listed in sortableColumns`,
-    )
-  }
-
-  const filterableColumns = input.filterableColumns ?? []
-  for (const col of filterableColumns) {
-    if (RESERVED_LIST_PARAMS.has(col)) {
-      throw new Error(
-        `[bunderstack] filterableColumns cannot include reserved query param "${col}"`,
-      )
-    }
-    if (!columns.includes(col)) {
-      throw new Error(
-        `[bunderstack] filterableColumns references unknown column "${col}"`,
-      )
-    }
-  }
-
-  for (const col of sortableColumns) {
-    if (RESERVED_LIST_PARAMS.has(col)) {
-      throw new Error(
-        `[bunderstack] sortableColumns cannot include reserved query param "${col}"`,
-      )
-    }
-    if (!columns.includes(col)) {
-      throw new Error(
-        `[bunderstack] sortableColumns references unknown column "${col}"`,
-      )
-    }
-  }
-
-  return { filterableColumns, sortableColumns, defaultSort }
-}
-
-function resolveDefaults(
-  input: TableAccessInput,
-  ownerColumn: string | undefined,
-  columns: string[],
-): Omit<ResolvedTableAccess, 'tableKey' | 'tableName' | 'enabled'> {
-  const listAccess = resolveListAccess(input, columns)
-  const explicitlyWritable = new Set(input.writableColumns ?? [])
-  return {
-    ownerColumn,
-    list: input.list ?? 'public',
-    get: input.get ?? 'public',
-    create: input.create ?? 'public',
-    update: input.update ?? (ownerColumn ? 'owner' : 'deny'),
-    delete: input.delete ?? (ownerColumn ? 'owner' : 'deny'),
-    writableColumns: input.writableColumns,
-    readonlyColumns: [
-      ...DEFAULT_READONLY.filter(
-        (column) => column === 'id' || !explicitlyWritable.has(column),
-      ),
-      ...(input.readonlyColumns ?? []),
-      ...(ownerColumn ? [ownerColumn] : []),
-    ],
-    searchableColumns: input.searchableColumns,
-    readScope: input.scope?.read,
-    writeScope: input.scope?.write,
-    ...listAccess,
-  }
-}
-
-function detectOwnerColumn(
-  columns: string[],
-  input?: TableAccessInput,
-): string | undefined {
-  if (input?.ownerColumn) return input.ownerColumn
-  if (columns.includes('userId')) return 'userId'
-  return undefined
-}
-
-export function validateAndResolveAccess<
-  TSchema extends Record<string, unknown>,
->(
-  schema: TSchema,
-  accessInput?: Record<string, TableAccessInput>,
-): ResolvedAccess {
-  const tables = getSchemaTables(schema)
-  const tableByKey = new Map(tables.map((t) => [t.key, t]))
-  const resolved: ResolvedAccess = new Map()
-
-  if (accessInput) {
-    for (const key of Object.keys(accessInput)) {
-      if (!tableByKey.has(key)) {
-        throw new Error(
-          `[bunderstack] access.${key} does not match any table in schema`,
-        )
-      }
-      const tableName = tableByKey.get(key)!.name
-      const input = accessInput[key]
-      if (AUTH_TABLE_NAMES.has(tableName)) {
-        if (input?.crud === false) continue
-        if (!EXPOSEABLE_AUTH_TABLES.has(tableName) || !input?.exposeAuthTable) {
-          throw new Error(
-            `[bunderstack] access.${key} cannot target auth table "${tableName}" — use { crud: false } to silence, or exposeAuthTable on user`,
-          )
-        }
-      }
-    }
-  }
-
-  for (const { key, name, columns } of tables) {
-    const input = accessInput?.[key]
-    if (input?.crud === false) continue
-    if (INTERNAL_TABLE_NAMES.has(name)) continue
-
-    if (AUTH_TABLE_NAMES.has(name)) {
-      if (!input?.exposeAuthTable || !EXPOSEABLE_AUTH_TABLES.has(name)) continue
-
-      const ownerColumn = input.ownerColumn ?? 'id'
-      if (!columns.includes(ownerColumn)) {
-        throw new Error(
-          `[bunderstack] access.${key}.ownerColumn "${ownerColumn}" is not a column on table "${name}"`,
-        )
-      }
-
-      const defaults = resolveDefaults(
-        {
-          ...input,
-          create: input.create ?? 'deny',
-          delete: input.delete ?? 'deny',
-        },
-        ownerColumn,
-        columns,
-      )
-
-      const existingReadonly = defaults.readonlyColumns.filter((col) =>
-        columns.includes(col),
-      )
-      const resolvedReadonly = [...new Set(existingReadonly)]
-
-      for (const col of [
-        ...(defaults.writableColumns ?? []),
-        ...(defaults.searchableColumns ?? []),
-        ...defaults.filterableColumns,
-        ...defaults.sortableColumns,
-        ...resolvedReadonly,
-      ]) {
-        if (!columns.includes(col)) {
-          throw new Error(
-            `[bunderstack] access.${key} references unknown column "${col}" on table "${name}"`,
-          )
-        }
-      }
-
-      resolved.set(key, {
-        tableKey: key,
-        tableName: name,
-        enabled: true,
-        ...defaults,
-        readonlyColumns: resolvedReadonly,
-      })
-      continue
-    }
-
-    const ownerColumn = detectOwnerColumn(columns, input)
-    const hasExplicitRules = input !== undefined
-    const hasConventionOwner =
-      ownerColumn !== undefined &&
-      input?.ownerColumn === undefined &&
-      columns.includes('userId')
-
-    if (!hasExplicitRules && !hasConventionOwner) continue
-    if (
-      !ownerColumn &&
-      input?.crud !== true &&
-      !input?.scope?.read &&
-      !input?.scope?.write
-    )
-      continue
-
-    if (input?.ownerColumn && !columns.includes(input.ownerColumn)) {
-      throw new Error(
-        `[bunderstack] access.${key}.ownerColumn "${input.ownerColumn}" is not a column on table "${name}"`,
-      )
-    }
-
-    const defaults = resolveDefaults(input ?? {}, ownerColumn, columns)
-    const existingReadonly = defaults.readonlyColumns.filter((col) =>
-      columns.includes(col),
-    )
-    const resolvedReadonly = [...new Set(existingReadonly)]
-
-    for (const col of [
-      ...(defaults.writableColumns ?? []),
-      ...(defaults.searchableColumns ?? []),
-      ...defaults.filterableColumns,
-      ...defaults.sortableColumns,
-      ...resolvedReadonly,
-    ]) {
-      if (!columns.includes(col)) {
-        throw new Error(
-          `[bunderstack] access.${key} references unknown column "${col}" on table "${name}"`,
-        )
-      }
-    }
-
-    const needsOwner = [defaults.update, defaults.delete].some(
-      (r) => r === 'owner',
-    )
-    if (needsOwner && !ownerColumn) {
-      throw new Error(
-        `[bunderstack] access.${key} requires ownerColumn for owner-based update/delete rules`,
-      )
-    }
-
-    resolved.set(key, {
-      tableKey: key,
-      tableName: name,
-      enabled: true,
-      ...defaults,
-      readonlyColumns: resolvedReadonly,
-    })
-  }
-
-  return resolved
-}
-
-export function defineAccess<
-  TSchema extends Record<string, unknown>,
-  const TRules extends Record<string, TableAccessInput>,
->(schema: TSchema, rules: TRules): TRules {
-  validateAndResolveAccess(schema, rules)
-  return rules
-}
-
-export function rowMatchesScope(
-  row: Record<string, unknown>,
-  scope: ScopeMap,
-): boolean {
-  for (const [col, expected] of Object.entries(scope)) {
-    const actual = row[col]
-    if (actual == null) return false
-    if (Array.isArray(expected)) {
-      if (!expected.map(String).includes(String(actual))) return false
-    } else if (String(actual) !== String(expected)) {
-      return false
-    }
-  }
-  return true
-}
-
-export function stampScope(
-  values: Record<string, unknown>,
-  scope: ScopeMap,
-): Record<string, unknown> {
-  const out = { ...values }
-  for (const [col, expected] of Object.entries(scope)) {
-    if (!Array.isArray(expected)) out[col] = expected
-  }
-  return out
-}
-
-export function checkAccessSync(
-  rule: Exclude<
-    OperationRule,
-    (ctx: AccessContext) => boolean | Promise<boolean>
-  >,
-  ctx: AccessContext,
-  ownerColumn?: string,
-): { allowed: boolean } {
-  if (rule === 'deny') return { allowed: false }
-  if (rule === 'public') return { allowed: true }
-  if (!ctx.user) return { allowed: false }
-  if (rule === 'authenticated') return { allowed: true }
-  if (rule === 'owner') {
-    if (!ownerColumn) return { allowed: false }
-    const owner = ctx.row?.[ownerColumn]
-    return { allowed: owner != null && String(owner) === ctx.user.id }
-  }
-  return { allowed: false }
-}
-
-export async function checkAccess(
-  rule: OperationRule,
-  ctx: AccessContext,
-  ownerColumn?: string,
-): Promise<{ allowed: boolean; status: 401 | 403 }> {
-  if (rule === 'deny') return { allowed: false, status: 403 }
-
-  if (typeof rule === 'function') {
-    return (await rule(ctx))
-      ? { allowed: true, status: 403 }
-      : { allowed: false, status: 403 }
-  }
-
-  if (rule === 'public') return { allowed: true, status: 403 }
-
-  if (!ctx.user) return { allowed: false, status: 401 }
-
-  if (rule === 'authenticated') return { allowed: true, status: 403 }
-
-  if (rule === 'owner') {
-    if (!ownerColumn) return { allowed: false, status: 403 }
-    const rowOwner = ctx.row?.[ownerColumn] ?? ctx.body?.[ownerColumn]
-    if (rowOwner == null) return { allowed: false, status: 403 }
-    if (String(rowOwner) !== ctx.user.id) return { allowed: false, status: 403 }
-    return { allowed: true, status: 403 }
-  }
-
-  return { allowed: false, status: 403 }
-}
-
-export function sanitizeWriteBody(
-  body: Record<string, unknown>,
-  access: ResolvedTableAccess,
-  mode: 'create' | 'update',
-  userId: string | null,
-): Record<string, unknown> {
-  const out: Record<string, unknown> = {}
-  const readonly = new Set(access.readonlyColumns)
-
-  for (const [key, value] of Object.entries(body)) {
-    // On create, allow client-supplied `id` even if it appears in readonlyColumns,
-    // but still respect an explicit writableColumns allowlist if provided.
-    if (mode === 'create' && key === 'id') {
-      if (access.writableColumns && !access.writableColumns.includes(key))
-        continue
-      out[key] = value
-      continue
-    }
-    if (readonly.has(key)) continue
-    if (access.writableColumns && !access.writableColumns.includes(key))
-      continue
-    out[key] = value
-  }
-
-  if (mode === 'create' && access.ownerColumn) {
-    out[access.ownerColumn] = userId ?? null
-  }
-
-  if (mode === 'update' && access.ownerColumn) {
-    delete out[access.ownerColumn]
-  }
-
-  return out
-}
-
-export type AuthSessionResolver = {
-  api: {
-    getSession: (opts: { headers: Headers }) => Promise<{
-      user: { id: string; email: string; name?: string; role?: string } | null
-      session?: { activeOrganizationId?: string | null } | null
-    } | null>
-  }
-}
-
-export async function resolveAccessUser(
-  auth: AuthSessionResolver | undefined,
-  headers: Headers,
-): Promise<AccessUser | null> {
-  if (!auth) return null
-  const session = await auth.api.getSession({ headers })
-  if (!session?.user) return null
-  return {
-    id: session.user.id,
-    email: session.user.email,
-    name: session.user.name,
-    role: session.user.role,
-  }
-}
-
-export async function resolveSession(
-  auth: AuthSessionResolver | undefined,
-  headers: Headers,
-): Promise<{ user: AccessUser | null; activeOrganizationId: string | null }> {
-  if (!auth) return { user: null, activeOrganizationId: null }
-  const session = await auth.api.getSession({ headers })
-  if (!session?.user) return { user: null, activeOrganizationId: null }
-  return {
-    user: {
-      id: session.user.id,
-      email: session.user.email,
-      name: session.user.name,
-      role: session.user.role,
-    },
-    activeOrganizationId: session.session?.activeOrganizationId ?? null,
-  }
-}

package/src/api/api-types.types.ts

@@ -1,106 +0,0 @@
-import type { InferRouterInputs, InferRouterOutputs } from '@orpc/server'
-
-import { pgTable, text } from 'drizzle-orm/pg-core'
-import * as v from 'valibot'
-
-import type { ExposedApiTables } from './types'
-
-import { pglite } from '../database/pglite'
-import { createBunderstack } from '../index'
-
-type Equal<A, B> =
-  (<T>() => T extends A ? 1 : 2) extends <T>() => T extends B ? 1 : 2
-    ? true
-    : false
-type Expect<T extends true> = T
-
-const posts = pgTable('posts', {
-  id: text('id').primaryKey(),
-  title: text('title').notNull(),
-})
-
-const privateNotes = pgTable('private_notes', {
-  id: text('id').primaryKey(),
-  content: text('content').notNull(),
-})
-
-const ownedPosts = pgTable('owned_posts', {
-  id: text('id').primaryKey(),
-  userId: text('user_id').notNull(),
-})
-
-type ImplicitTables = ExposedApiTables<
-  { posts: typeof posts; ownedPosts: typeof ownedPosts },
-  undefined
->
-type _ImplicitAccessHidesUnownedTable = Expect<
-  Equal<'posts' extends ImplicitTables ? true : false, false>
->
-type _ImplicitAccessIncludesConventionTable = Expect<
-  Equal<'ownedPosts' extends ImplicitTables ? true : false, true>
->
-
-const typedApp = await createBunderstack({
-  schema: { posts, privateNotes },
-  database: { adapter: pglite() },
-  processEnv: {
-    DATABASE_URL: 'memory://',
-    BUNDERSTACK_ROLE: 'web',
-  },
-  access: {
-    posts: { crud: true, list: 'public', create: 'public' },
-    privateNotes: { crud: false },
-  },
-  api: (o) => ({
-    stats: o.protected
-      .input(v.object({ period: v.picklist(['day', 'week']) }))
-      .output(
-        v.object({ period: v.picklist(['day', 'week']), userId: v.string() }),
-      )
-      .handler(async ({ input, context }) => {
-        const _userId: string = context.user.id
-        const _db = context.db
-        const _env = context.env
-        return {
-          period: input.period,
-          userId: context.user.id,
-        }
-      }),
-  }),
-})
-
-type Api = NonNullable<typeof typedApp.$inferClient>['api']
-
-type _HasPosts = Expect<Equal<'posts' extends keyof Api ? true : false, true>>
-type _HidesPrivateNotes = Expect<
-  Equal<'privateNotes' extends keyof Api ? true : false, false>
->
-type _HasStats = Expect<Equal<'stats' extends keyof Api ? true : false, true>>
-
-type PostsInputs = InferRouterInputs<Api>['posts']
-type PostsOutputs = InferRouterOutputs<Api>['posts']
-type IsAny<T> = 0 extends 1 & T ? true : false
-type ExpectedUpdateInput = {
-  params: { id: string }
-  query?: Record<string, unknown>
-  headers?: Record<string, unknown>
-  body: { title?: string }
-}
-
-type _CreateInput = Expect<
-  Equal<
-    PostsInputs['create'],
-    Partial<typeof posts.$inferInsert>
-  >
->
-type _GetInput = Expect<Equal<PostsInputs['get'], { id: string }>>
-type _UpdateInputToExpected = Expect<
-  PostsInputs['update'] extends ExpectedUpdateInput ? true : false
->
-type _ExpectedToUpdateInput = Expect<
-  ExpectedUpdateInput extends PostsInputs['update'] ? true : false
->
-type _ListItems = Expect<
-  Equal<PostsOutputs['list']['items'], Array<{ id: string; title: string }>>
->
-type _GetOutputIsTyped = Expect<Equal<IsAny<PostsOutputs['get']>, false>>

package/src/api/builder.ts

@@ -1,52 +0,0 @@
-import { os, type AnyRouter } from '@orpc/server'
-
-import type { ApiContext } from './context'
-
-import {
-  BUNDERSTACK_ERRORS,
-  BunderstackError,
-  mapBunderstackErrors,
-} from '../errors'
-export type { ProtectedContextAdditions } from './types'
-
-export function createApiBuilder<
-  TSchema extends Record<string, unknown> = Record<string, unknown>,
-  TEnv = Record<string, unknown>,
->() {
-  const base = os
-    .$context<ApiContext<TSchema, TEnv>>()
-    .errors(BUNDERSTACK_ERRORS)
-    .use(mapBunderstackErrors)
-
-  const protectedProc = base.use(async ({ context, next }) => {
-    const session = await context.getSession()
-    if (!session.user) {
-      throw new BunderstackError('UNAUTHORIZED', 'Authentication required')
-    }
-    return next({
-      context: {
-        user: session.user,
-        session: {
-          activeOrganizationId: session.activeOrganizationId,
-        },
-      },
-    })
-  })
-
-  return {
-    public: base,
-    protected: protectedProc,
-    webhook: base,
-  }
-}
-
-export type BunderstackApiBuilder<
-  TSchema extends Record<string, unknown>,
-  TEnv = Record<string, unknown>,
-> = ReturnType<typeof createApiBuilder<TSchema, TEnv>>
-
-export type ApiFactory<
-  TSchema extends Record<string, unknown>,
-  TEnv,
-  TCustomApiRouter extends AnyRouter,
-> = (builder: BunderstackApiBuilder<TSchema, TEnv>) => TCustomApiRouter