supabase/apps/docs/scripts/generate-dart-reference.ts

/**
 * Generate the Dart/Flutter reference dump consumed by the new reference
 * pipeline (`scripts/build-reference-content.ts`).
 *
 * Dart has no upstream TypeDoc output, so this script is the "pre-step" the
 * reference README describes: it adapts the hand-authored legacy spec
 * (`spec/supabase_dart_v2.yml`) into a TypeDoc-shaped JSON dump at
 * `spec/reference/dart/v2/supabase_flutter.json`.
 *
 * Each method's section comes from `category` / `subcategory` fields on its own
 * YAML entry, so adding or moving a method only ever touches this one file. The
 * `build-reference-content.ts` "barebone" step then generates the navigation
 * tree from those tags — no separate section list to maintain.
 *
 * Each Dart method becomes a `variant: 'declaration'` node tagged with
 * `@category` / `@subcategory` (so the build groups it into the right section)
 * and carries the legacy function shape (description, notes, params, examples)
 * on a non-TypeDoc `content` field. `build-reference-content.ts` spreads that
 * straight onto the functions.json entry, so the renderer shows params,
 * examples, and notes exactly as the legacy YAML did, with no typeSpec
 * round-trip.
 *
 * Overview/header entries (e.g. "Using filters", "Auth MFA") and the top-level
 * markdown sections (introduction, installing, upgrade-guide, initializing) are
 * not emitted here. They live as hand-authored partials under
 * `spec/reference/dart/v2/partials/`, matching how the JavaScript lib is set up.
 *
 * The dump is gitignored (like every other reference dump); only `config.json`
 * and `partials/` are committed. Run via `pnpm codegen:references:new` (the
 * ensure step regenerates this file when it is missing).
 *
 * Usage: pnpm tsx scripts/generate-dart-reference.ts
 */

import { mkdir, readFile, writeFile } from 'node:fs/promises'
import { dirname, join } from 'node:path'
import { fileURLToPath } from 'node:url'
import { parse } from 'yaml'

const __dirname = dirname(fileURLToPath(import.meta.url))
const DOCS_DIR = join(__dirname, '..')
const YAML_PATH = join(DOCS_DIR, 'spec/supabase_dart_v2.yml')
const VERSION_DIR = join(DOCS_DIR, 'spec/reference/dart/v2')
const CONFIG_PATH = join(VERSION_DIR, 'config.json')
const OUT_PATH = join(VERSION_DIR, 'supabase_flutter.json')

/**
 * Ids whose YAML entry is a section header rather than a method. Each header
 * carries the `category` (and optional `subcategory`) that every method after
 * it inherits, up to the next header. This is what lets individual methods omit
 * section metadata entirely: authoring a new method just means placing it in the
 * right section. Headers are skipped when building method declarations; their
 * overview text is rendered from the committed JSON partials (keyed by the
 * category/subcategory title slug).
 *
 * Listed in file order for readability.
 */
const HEADER_IDS = new Set([
  'auth-api',
  'auth-mfa-api',
  'oauth-server-api',
  'passkey-api',
  'admin-api',
  'admin-passkey-api',
  'admin-custom-providers-api',
  'functions-api',
  'database-api',
  'realtime-api',
  'file-buckets',
  'analytics-buckets',
  'vector-buckets',
  'using-modifiers',
  'using-filters',
])

/** Top-level entries handled by markdown / top-level JSON partials, not methods. */
const SKIP_IDS = new Set(['introduction', 'installing', 'upgrade-guide', 'initializing'])

/** Method-name overrides for titles that don't yield a clean identifier. */
const NAME_OVERRIDE: Record<string, string> = {
  explain: 'explain',
}

interface DartFunction {
  id: string
  title: string
  category?: string
  subcategory?: string | null
  description?: string
  notes?: string
  params?: unknown[]
  examples?: unknown[]
}

/**
 * Derive a Dart method identifier from a legacy title:
 *   'signUp()'              -> 'signUp'
 *   'Fetch data: select()'  -> 'select'
 *   'from.upload()'         -> 'upload'
 *   'mfa.enroll()'          -> 'enroll'
 *   'on().subscribe()'      -> 'subscribe'
 */
function deriveName(title: string): string {
  let name = String(title)
    .trim()
    .replace(/^['"]|['"]$/g, '')
  if (name.includes(': ')) name = name.split(': ').pop() as string
  name = name.replace(/\([^)]*\)/g, '')
  name = name.split('.').filter(Boolean).pop() ?? name
  return name.trim()
}

function textTag(tag: string, text: string) {
  return { tag, content: [{ kind: 'text', text }] }
}

type NavigationPrefixes = Record<string, string | false>

/**
 * Recomputes the slug `build-reference-content.ts` will assign to a method, so
 * collisions are caught here (and reported by id) rather than silently dropped
 * by the build's first-wins dedup. Mirrors that script's `functionPrefix` /
 * slug logic, keyed on the nearest container (subcategory, else category).
 */
function functionSlug(
  name: string,
  category: string,
  subcategory: string | null,
  navigationPrefixes: NavigationPrefixes
): string {
  const key = subcategory ?? category
  const override = navigationPrefixes[key]
  const prefix = override === false ? null : typeof override === 'string' ? override : slugify(key)
  const nameLower = name.toLowerCase()
  return prefix === null ? nameLower : `${prefix}-${nameLower}`
}

function slugify(value: string): string {
  return value.toLowerCase().trim().replace(/\s+/g, '-')
}

export async function generateDartReferenceDump(): Promise<{ methodCount: number }> {
  const doc = parse(await readFile(YAML_PATH, 'utf-8')) as { functions: DartFunction[] }
  const config = JSON.parse(await readFile(CONFIG_PATH, 'utf-8')) as {
    navigationPrefixes?: NavigationPrefixes
  }
  const navigationPrefixes = config.navigationPrefixes ?? {}

  let nextId = 1
  const children: unknown[] = []
  const slugOwners = new Map<string, string>()
  const orphaned: string[] = []

  // The section a method belongs to is the one opened by the nearest preceding
  // header entry. We walk the spec in order, updating the current section each
  // time we hit a header, so methods themselves carry no section metadata.
  let currentCategory: string | null = null
  let currentSubcategory: string | null = null

  for (const fn of doc.functions) {
    if (SKIP_IDS.has(fn.id)) continue

    if (HEADER_IDS.has(fn.id)) {
      if (!fn.category) {
        throw new Error(
          `Dart converter: header "${fn.id}" needs a "category" field; it defines the ` +
            `section that the methods after it inherit.`
        )
      }
      currentCategory = fn.category
      currentSubcategory = fn.subcategory ?? null
      continue
    }

    // A method inherits the current section. It may still override either field
    // independently: an explicit `subcategory` always wins, an explicit
    // `category` (with no subcategory) starts a fresh, subcategory-less section,
    // and anything left unset is inherited from the current header.
    const category = fn.category ?? currentCategory
    const subcategory =
      fn.subcategory !== undefined
        ? fn.subcategory
        : fn.category !== undefined
          ? null
          : currentSubcategory
    if (!category) {
      orphaned.push(fn.id)
      continue
    }
    const section = { category, subcategory }

    const name = NAME_OVERRIDE[fn.id] ?? deriveName(fn.title)
    if (!/^[A-Za-z][A-Za-z0-9]*$/.test(name)) {
      throw new Error(`Dart converter: id "${fn.id}" yielded an invalid method name "${name}"`)
    }

    const slug = functionSlug(name, section.category, section.subcategory, navigationPrefixes)
    const owner = slugOwners.get(slug)
    if (owner) {
      throw new Error(`Dart converter: ids "${owner}" and "${fn.id}" both map to slug "${slug}"`)
    }
    slugOwners.set(slug, fn.id)

    const blockTags = [textTag('@category', section.category)]
    if (section.subcategory) blockTags.push(textTag('@subcategory', section.subcategory))

    const content: Record<string, unknown> = {}
    if (fn.description) content.description = fn.description
    if (fn.notes) content.notes = fn.notes
    if (fn.params?.length) content.params = fn.params
    if (fn.examples?.length) content.examples = fn.examples

    children.push({
      id: nextId++,
      name,
      variant: 'declaration',
      kind: 2048,
      flags: {},
      comment: { summary: [], blockTags },
      content,
    })
  }

  const dump = {
    id: 0,
    name: 'supabase_flutter',
    variant: 'project',
    kind: 1,
    flags: {},
    children,
  }

  await mkdir(dirname(OUT_PATH), { recursive: true })
  await writeFile(OUT_PATH, JSON.stringify(dump, null, 2))

  if (orphaned.length) {
    throw new Error(
      `Dart converter: ${orphaned.length} ids have no section (they appear before any ` +
        `section header in supabase_dart_v2.yml). Move them under a header, add a header ` +
        `before them, or list them in SKIP_IDS if they are not methods: ${orphaned.join(', ')}`
    )
  }

  console.log(
    `[dart/v2] wrote ${children.length} method declarations to ${OUT_PATH.replace(DOCS_DIR + '/', '')}`
  )

  return { methodCount: children.length }
}

// Only run when invoked as a script (via `tsx`); importing from a test must not
// trigger the side-effecting file write.
if (import.meta.url === `file://${process.argv[1]}`) {
  generateDartReferenceDump().catch((err) => {
    console.error(err)
    process.exit(1)
  })
}