@abide/abide 0.117.1 → 0.118.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abide/abide",
-    "version": "0.117.1",
+    "version": "0.118.0",
     "type": "module",
     "description": "Isomorphic type-safe framework for reactive async interfaces for humans and machines",
     "license": "MIT",

package/scaffold/AGENTS.md

@@ -36,7 +36,7 @@ before writing code, rather than guessing from Svelte, Vue or React. It installs
 - A file's path below `src/` is its address. `src/invoices/index.abide` answers `/invoices`,
   `src/invoices/[id].abide` answers `/invoices/123`, and `layout.abide` wraps the pages below it;
   the outermost one writes `<html>`. Run `bun run routes` to see every address and the file behind it.
-- A `.ts` beside the pages is a handler: `src/invoices/getInvoice.ts` holds
+- A `<name>.handler.ts` beside the pages is a handler: `src/invoices/getInvoice.handler.ts` holds
   `export default GET(…)` and answers `/invoices/getInvoice`. It is the app's public API, for pages,
   scripts, the CLI and MCP alike.
 - A `.abide` cannot export. A `<script server>` in one holds that file's private handlers

package/scaffold/src/getGreeting.test.ts

@@ -1,5 +1,5 @@
 import { expect, test } from 'bun:test'
-import getGreeting from './getGreeting.ts'
+import getGreeting from './getGreeting.handler.ts'
 
 test('the handler answers with the name it is given', async () => {
     expect(await getGreeting({ name: 'Ada' })).toBe('Hello, Ada')

package/scaffold/src/index.abide

@@ -1,6 +1,6 @@
 <script>
 import { reactive } from '@abide/abide'
-import getGreeting from '#src/getGreeting.ts'
+import getGreeting from '#src/getGreeting.handler.ts'
 
 let count = reactive(0)
 const greeting = reactive(() => getGreeting({ name: 'world' }))

package/src/compiler/ShadowMap.ts

@@ -167,7 +167,7 @@ function copiedFrom(
  * markup, or a read the lowering rewrote. Runs are ascending by where they stand, not by where they
  * came from, so this is a scan.
  */
-function mapForward(
+export function mapForward(
     origins: readonly Origin[],
     position: number,
 ): number | undefined {

package/src/compiler/TypeSession.ts

@@ -21,9 +21,10 @@ import {
     type Type,
 } from 'typescript/unstable/async'
 import { placeOf } from '#server/placement.ts'
+import { parseRoutePattern } from '#shared/routePattern.ts'
 import { aliasedSymbol } from './aliasedSymbol.ts'
 import { AMBIENT_SOURCES, ambientReadsIn } from './ambientReadsIn.ts'
-import type { AppLayout, PlacedSource } from './appLayout.ts'
+import type { AppLayout, AppRoute, PlacedSource } from './appLayout.ts'
 import { argsDefaultsIn } from './argsDefaultsIn.ts'
 import { type CheckerAnswer, UNCHECKED } from './CheckerAnswer.ts'
 import {
@@ -38,10 +39,15 @@ import { CHECKED_VALUES } from './Lowering.ts'
 import { diagnosisAt, lineOf } from './lineOf.ts'
 import type { AbideFile } from './parseAbide.ts'
 import { projectShadow, type Span } from './projectShadow.ts'
-import { abideIn } from './reactiveTypes.ts'
+import { type Abide, abideIn, isReactiveType } from './reactiveTypes.ts'
 import type { ParsedSource, ReadSource } from './readSources.ts'
 import { readsIn, type ShadowSpans } from './readsIn.ts'
-import { CHECKED_SUFFIX, SHADOW_SUFFIX, ShadowMap } from './ShadowMap.ts'
+import {
+    CHECKED_SUFFIX,
+    mapForward,
+    SHADOW_SUFFIX,
+    ShadowMap,
+} from './ShadowMap.ts'
 import { SOURCE_SUFFIX } from './splitImports.ts'
 import { type TemplateContext, templateContext } from './templateContext.ts'
 import { templateWarnings } from './templateWarnings.ts'
@@ -711,56 +717,144 @@ export class TypeSession {
         if (queries.every((query) => query === undefined))
             return { answers, warnings }
 
-        const project = await this.currentProject(created, changed)
+        let project = await this.currentProject(created, changed)
         if (project === undefined) return { answers, warnings }
-        const checker = project.checker
-        const abide = await abideIn(project)
-
-        await Promise.all(
-            queries.map(async (query, at) => {
-                if (query === undefined) return
-                const source = sources[at] as (typeof sources)[number]
-                const sourceFile = await project.program.getSourceFile(
+        // Per source, its compiler warnings, the bindings the projection could not type
+        // (`bindingsOfReads`), and those the lowered program proved a `Reactive`.
+        const warned: Diagnosis[][] = sources.map(() => [])
+        const suspects: number[][] = sources.map(() => [])
+        const held: Set<number>[] = sources.map(() => new Set())
+        const answer = async (
+            asked: Project,
+            abide: Abide,
+            at: number,
+        ): Promise<void> => {
+            const query = queries[at]
+            if (query === undefined) return
+            const source = sources[at] as (typeof sources)[number]
+            const sourceFile = await asked.program.getSourceFile(
+                query.map.shadowPath,
+            )
+            // The shadow has to be INSIDE the opened project or the checker never reads it.
+            // Refusing loudly rather than answering nothing: no reads is a file whose every
+            // name lowers as written, which renders `[object Object]` where a value was due —
+            // a wrong page, with nothing about it saying so.
+            if (sourceFile === undefined)
+                throw new Error(
+                    `abide: ${source.path} is not inside the project ${this.tsconfig}, so no name in it can be typed (RULEBOOK 31.3). Give the app a tsconfig whose include reaches it.`,
+                )
+            const read = await readsIn(
+                asked.checker,
+                abide,
+                sourceFile,
+                query.map.shadowPath,
+                query.spans,
+                source.file,
+                held[at] as Set<number>,
+            )
+            answers[at] = read.answer
+            suspects[at] = read.suspects
+            const placed: Diagnosis[] = []
+            for (const warning of read.warnings) {
+                const offset = query.map.toSource(
                     query.map.shadowPath,
+                    warning.at,
+                )
+                if (
+                    source.text === undefined ||
+                    !isIgnored(source.text, offset, warning.message)
                 )
-                // The shadow has to be INSIDE the opened project or the checker never reads it.
-                // Refusing loudly rather than answering nothing: no reads is a file whose every
-                // name lowers as written, which renders `[object Object]` where a value was due —
-                // a wrong page, with nothing about it saying so.
-                if (sourceFile === undefined)
-                    throw new Error(
-                        `abide: ${source.path} is not inside the project ${this.tsconfig}, so no name in it can be typed (RULEBOOK 31.3). Give the app a tsconfig whose include reaches it.`,
+                    placed.push(
+                        diagnosisAt(
+                            source.path,
+                            source.text,
+                            offset,
+                            'warning',
+                            warning.message,
+                        ),
                     )
-                const read = await readsIn(
-                    checker,
-                    abide,
-                    sourceFile,
-                    query.map.shadowPath,
-                    query.spans,
+            }
+            warned[at] = placed
+        }
+        const every = queries.map((_, at) => at)
+        const first = project
+        const firstAbide = await abideIn(first)
+        await Promise.all(every.map((at) => answer(first, firstAbide, at)))
+        // 31.1 — A BINDING THE PROJECTION TYPED FROM A `Reactive` IS ASKED OF THE PROGRAM IT RUNS
+        // AS: each file holding one is lowered with what it has answered so far, and a binding that
+        // is a `Reactive` there is one in the projection too. A binding typed from one that just
+        // turned out to be a `Reactive` is asked again, until a round turns none. Nothing is asked,
+        // and no second snapshot taken, where no file holds one (`bindingsOfReads`).
+        for (;;) {
+            const asking = every.filter(
+                (at) => (suspects[at] as number[]).length > 0,
+            )
+            if (asking.length === 0) break
+            const loweredCreated: string[] = []
+            const loweredChanged: string[] = []
+            const lowered = asking.map((at) => {
+                const source = sources[at] as (typeof sources)[number]
+                const query = queries[at] as { map: ShadowMap }
+                const shadow = checkedShadow(
                     source.file,
+                    answers[at] as CheckerAnswer,
                 )
-                answers[at] = read.answer
-                for (const warning of read.warnings) {
-                    const offset = query.map.toSource(
-                        query.map.shadowPath,
-                        warning.at,
-                    )
-                    if (
-                        source.text === undefined ||
-                        !isIgnored(source.text, offset, warning.message)
-                    )
-                        warnings.push(
-                            diagnosisAt(
-                                source.path,
-                                source.text,
-                                offset,
-                                'warning',
-                                warning.message,
-                            ),
-                        )
+                this.register(
+                    query.map.checkedPath,
+                    shadow.text,
+                    loweredCreated,
+                    loweredChanged,
+                )
+                this.openOutside(
+                    source.path,
+                    query.map.checkedPath,
+                    loweredChanged,
+                )
+                return {
+                    at,
+                    path: query.map.checkedPath,
+                    origins: shadow.origins,
                 }
-            }),
-        )
+            })
+            project = await this.currentProject(loweredCreated, loweredChanged)
+            if (project === undefined) return { answers, warnings }
+            const asked = project
+            const abide = await abideIn(asked)
+            const turned = new Set<number>()
+            await Promise.all(
+                lowered.map(async ({ at, path, origins }) => {
+                    const sourceFile = await asked.program.getSourceFile(path)
+                    if (sourceFile === undefined) return
+                    for (const start of suspects[at] as number[]) {
+                        const position = mapForward(origins, start)
+                        if (position === undefined) continue
+                        const symbol = await asked.checker.getSymbolAtLocation(
+                            getTouchingPropertyName(sourceFile, position),
+                        )
+                        const type =
+                            symbol === undefined
+                                ? undefined
+                                : await asked.checker.getTypeOfSymbol(symbol)
+                        if (
+                            type !== undefined &&
+                            (await isReactiveType(
+                                asked.checker,
+                                abide,
+                                type,
+                                false,
+                            ))
+                        ) {
+                            ;(held[at] as Set<number>).add(start)
+                            turned.add(at)
+                        }
+                    }
+                }),
+            )
+            if (turned.size === 0) break
+            await Promise.all([...turned].map((at) => answer(asked, abide, at)))
+            for (const at of asking) if (!turned.has(at)) suspects[at] = []
+        }
+        for (const placed of warned) warnings.push(...placed)
         return { answers, warnings }
     }
 
@@ -881,7 +975,7 @@ export class TypeSession {
             Partial<Pick<PlacedSource, 'kind' | 'route'>> & {
                 quiet?: boolean
             })[],
-        app: Pick<AppLayout, 'root' | 'addresses' | 'handlers'>,
+        app: Pick<AppLayout, 'root' | 'addresses' | 'handlers' | 'routes'>,
         scripts = true,
     ): Promise<{ diagnoses: Diagnosis[]; refused: Set<string> }> {
         using _held = this.hold()
@@ -940,7 +1034,7 @@ export class TypeSession {
         // module augments one.
         this.register(
             `${this.canonical(within)}/${ROUTES_DECLARATION}`,
-            routesDeclaration(app.addresses),
+            routesDeclaration(app.addresses, app.routes),
             created,
             changed,
         )
@@ -1477,13 +1571,45 @@ function isFile(path: string): boolean {
 const ROUTES_DECLARATION = 'abide-routes.d.ts'
 const URL_SOURCE = Bun.fileURLToPath(new URL('../shared/url', import.meta.url))
 
-/** 30.26 — each of `addresses` as a key of abide's `Routes`. */
-function routesDeclaration(addresses: readonly string[]): string {
+/**
+ * 30.26 — each of `addresses` as a key of abide's `Routes`, and 23.9, 30.3 — a page route's params
+ * narrowed where its matcher is an alternation of literals, which is the one matcher a type can say.
+ */
+function routesDeclaration(
+    addresses: readonly string[],
+    routes: readonly AppRoute[],
+): string {
+    const narrowed = new Map<string, string>()
+    for (const route of routes) {
+        let members = ''
+        for (const segment of parseRoutePattern(route.pattern)) {
+            if (segment.kind !== 'required' && segment.kind !== 'optional')
+                continue
+            const literals = literalsOf(
+                segment.matcher === undefined
+                    ? undefined
+                    : route.matchers[segment.matcher],
+            )
+            if (literals === undefined) continue
+            members += ` ${JSON.stringify(segment.name)}${segment.kind === 'optional' ? '?' : ''}: ${literals};`
+        }
+        if (members !== '') narrowed.set(route.pattern, `{${members} }`)
+    }
     let keys = ''
     for (const route of addresses)
-        keys += `        ${JSON.stringify(route)}: true\n`
+        keys += `        ${JSON.stringify(route)}: ${narrowed.get(route) ?? 'true'}\n`
     return `export {}\ndeclare module ${JSON.stringify(URL_SOURCE)} {\n    interface Routes {\n${keys}    }\n}\n`
 }
+
+/** The union of the literals an anchored matcher source alternates between, or `undefined`. */
+function literalsOf(source: string | undefined): string | undefined {
+    const body = source?.match(/^\^\(\?!\\\.\\\.\?\$\)\(\?:(.*)\)\$$/)?.[1]
+    if (body === undefined || !/^[\w~-]+(?:\|[\w~-]+)*$/.test(body)) return undefined
+    return body
+        .split('|')
+        .map((literal) => JSON.stringify(literal))
+        .join(' | ')
+}
 const AMBIENT_DECLARATIONS = `declare module '*.css' {}
 declare module '*.md' {
     const text: string

package/src/compiler/appLayout.ts

@@ -16,6 +16,7 @@ import {
 import { abideImportsOf, componentGraph } from './componentGraph.ts'
 import type { HandlerFile } from './handlersUnder.ts'
 import { hookCalls, hooksIn } from './hookCalls.ts'
+import { type MountedTree, matchersOf } from './matchersOf.ts'
 import { mountsOf } from './mountsOf.ts'
 import { type AbideFile, scriptBodies } from './parseAbide.ts'
 import { Refusals } from './Refusals.ts'
@@ -49,6 +50,8 @@ export type PlacedHandler = HandlerFile & {
     scope: string
     text: string
     hooks: string[]
+    /** 23.26 — each matcher its route names, to the anchored source the route tables carry. */
+    matchers: Record<string, string>
 }
 
 /** A page or an error page and the layouts it renders inside. */
@@ -64,6 +67,8 @@ export type AppRoute = {
      * cannot be declared twice.
      */
     layouts: string[]
+    /** 23.26 — each matcher its pattern names, to the anchored source the route tables carry. */
+    matchers: Record<string, string>
 }
 
 /** The app at a root, laid out (`appLayout`). */
@@ -105,7 +110,10 @@ export async function appLayout(root: string): Promise<AppLayout> {
     // COLLECTED, whoever asks: a layout is kept across checks (`AppChecker`), and a build adopts
     // what it found (`Refusals.adopt`).
     const refusals = new Refusals(root, true)
-    const { abide, handlers, modules, published } = appFiles(root, refusals)
+    const { abide, handlers, params, modules, published } = appFiles(
+        root,
+        refusals,
+    )
     await refuseModuleHooks(root, modules, refusals)
     const resolve = resolverIn()
     const unparsed = new Refusals(root, true)
@@ -149,10 +157,43 @@ export async function appLayout(root: string): Promise<AppLayout> {
             scope: placement(file.relative, file.position).scope,
             text,
             hooks: hooksIn([text]),
+            matchers: {},
         })
     }
     refuseStrayLauncher(sources, placedHandlers, refusals)
     const { routes, errors } = routesOf(sources, refusals)
+    // 23.26 — every routed file's matchers, a layout's among them for 23.27's sake though no table
+    // carries a layout's own.
+    const routed: {
+        path: string
+        relative: string
+        position: string
+        route: string
+    }[] = []
+    const relativeToPath = new Map<string, string>()
+    for (const source of sources) {
+        if (source.route === undefined) continue
+        relativeToPath.set(source.relative, source.path)
+        routed.push({
+            path: source.path,
+            relative: source.relative,
+            position: source.position,
+            route: source.route,
+        })
+    }
+    for (const handler of placedHandlers) routed.push(handler)
+    const matchers = await matchersOf(
+        root,
+        routed,
+        params.map((path) => `${root}/${path}`),
+        found.trees,
+        refusals,
+    )
+    for (const handler of placedHandlers)
+        handler.matchers = matchers.get(handler.path) ?? {}
+    for (const route of [...routes, ...errors])
+        route.matchers =
+            matchers.get(relativeToPath.get(route.source) ?? '') ?? {}
     const addresses = new Set<string>()
     for (const route of routes) addresses.add(route.pattern)
     for (const address of published.values()) addresses.add(address)
@@ -215,6 +256,8 @@ export async function withDependencies(
     handlers: HandlerFile[]
     /** 23.19 — each mounted `.abide`'s position, by its path; one at its own path is not here. */
     positions: Map<string, string>
+    /** 23.26 — each mounted directory, where it mounts, and the param files under it. */
+    trees: MountedTree[]
 }> {
     const all = [...parsed]
     const handlers: HandlerFile[] = []
@@ -231,6 +274,7 @@ export async function withDependencies(
     const positions = new Map<string, string>()
     // 23.20 — a directory mounts once, and by whom.
     const mountedBy = new Map<string, string>()
+    const trees: MountedTree[] = []
     const add = async (path: string): Promise<void> => {
         let text: string
         try {
@@ -268,6 +312,11 @@ export async function withDependencies(
                 continue
             }
             mountedBy.set(mount.directory, position)
+            trees.push({
+                directory: mount.directory,
+                at: mount.at,
+                params: mount.params,
+            })
             for (const placed of mount.handlers) {
                 // Two mounts can overlap, one directory inside the other; a file is placed once.
                 if (handled.has(placed.path)) continue
@@ -292,7 +341,7 @@ export async function withDependencies(
             if (!byPath.has(target)) await add(target)
         }
     }
-    return { sources: all, handlers, positions }
+    return { sources: all, handlers, positions, trees }
 }
 
 /** Whether a page or an error page has anything to paint: a template, or a head. 23.3, 35.14. */
@@ -450,6 +499,7 @@ function routesOf(
             pattern,
             source: source.relative,
             layouts: around,
+            matchers: {},
         })
     }
     return { routes, errors }

package/src/compiler/appMap.ts

@@ -14,6 +14,8 @@ type MappedRoute = {
     address: string
     file: string
     kind: 'page' | 'handler' | 'private'
+    /** 23.26 — each matcher its address names, to the anchored pattern it takes a part by. */
+    matchers: Record<string, string>
 }
 
 /** One hook call, the route it is filed at, and the file making it. */
@@ -39,6 +41,7 @@ export async function appMap(
             address: route.pattern,
             file: route.source,
             kind: 'page',
+            matchers: route.matchers,
         })
     for (const mount of app.mounts)
         routes.push({
@@ -46,6 +49,7 @@ export async function appMap(
             address: mount.address,
             file: mount.source,
             kind: mount.private ? 'private' : 'handler',
+            matchers: mount.matchers,
         })
     routes.sort((one, two) =>
         one.address === two.address
@@ -79,6 +83,17 @@ export function mapText(map: Awaited<ReturnType<typeof appMap>>): string {
         lines.push(
             `${route.method.padEnd(methods)}  ${route.address.padEnd(addresses)}  ${route.file}${route.kind === 'private' ? '  (private)' : ''}`,
         )
+    // 23.26 — each matcher once, whichever routes name it: what a part must match to be taken.
+    const matchers = new Map<string, string>()
+    for (const route of map.routes)
+        for (const name in route.matchers)
+            matchers.set(name, route.matchers[name] as string)
+    if (matchers.size > 0) {
+        lines.push('', 'matchers')
+        const names = width([...matchers.keys()])
+        for (const [name, pattern] of matchers)
+            lines.push(`  ${name.padEnd(names)}  /${pattern}/`)
+    }
     if (map.hooks.length > 0) {
         lines.push('', 'hooks')
         const hooks = width(map.hooks.map((hook) => hook.hook))

package/src/compiler/compileApp.ts

@@ -514,7 +514,7 @@ function tableOf(
             (layout) => `() => import(${tableImport(layout)})`,
         )
         rows.push(
-            `    { pattern: ${JSON.stringify(route.pattern)}, load: () => import(${tableImport(route.source)}), layouts: [${wrapping.join(', ')}]${column(route)} },`,
+            `    { pattern: ${JSON.stringify(route.pattern)}, load: () => import(${tableImport(route.source)}), layouts: [${wrapping.join(', ')}], matchers: ${JSON.stringify(route.matchers)}${column(route)} },`,
         )
     }
     return rows.join('\n')

package/src/compiler/compiledEntry.ts

@@ -120,7 +120,7 @@ import * as table from ${JSON.stringify(tablePath(app.root, SERVER_TABLE))}
     return `// Written by \`abide compile\`. The whole app, as what one executable holds.
 ${imports}
 // 38.56 — a file declaring handlers as a script names it through the app's one alias:
-// \`#src/invoices/getInvoice.ts\`, to the module it is.
+// \`#src/invoices/getInvoice.handler.ts\`, to the module it is.
 const declared = {}
 for (const row of table.handlers) declared[\`#src/\${row.source}\`] = row.load
 

package/src/compiler/handlersUnder.ts

@@ -45,7 +45,7 @@ export async function handlersUnder(
     sources: readonly Source[],
     files: readonly Pick<
         PlacedHandler,
-        'path' | 'relative' | 'route' | 'scope'
+        'path' | 'relative' | 'route' | 'scope' | 'matchers'
     >[],
     refusals: Refusals,
 ): Promise<{ mounts: Mount[]; warnings: Diagnosis[] }> {
@@ -84,6 +84,7 @@ export async function handlersUnder(
             relative,
             route: address,
             scope,
+            matchers,
         } = files[at] as (typeof files)[number]
         const exported = declared[at]
         if (exported === undefined) continue
@@ -99,7 +100,7 @@ export async function handlersUnder(
                     )
             if (handler?.method === undefined)
                 throw new Error(
-                    `abide: ${relative} is a handler file — a .ts directly in an address directory — and exports no handler as its default. Export one (\`export default GET(…)\`), or move the file into a lib directory. RULEBOOK 16.73, 23.22.`,
+                    `abide: ${relative} is a handler file — a <name>.handler.ts directly in an address directory — and exports no handler as its default. Export one (\`export default GET(…)\`), or move the file into a lib directory. RULEBOOK 16.73, 23.22.`,
                 )
             const framework = frameworkRouteRefusal(address, relative)
             if (framework !== undefined) throw framework
@@ -119,6 +120,7 @@ export async function handlersUnder(
                 name: address.slice(address.lastIndexOf('/') + 1),
                 export: 'default',
                 scope,
+                matchers,
                 private: false,
                 ui: handler.ui,
                 cli: handler.cli,
@@ -150,6 +152,7 @@ export async function handlersUnder(
                 name,
                 export: each.name,
                 scope,
+                matchers: {},
                 private: true,
                 ui: each.ui,
                 cli: false,