StaticapplicationThe application's key, subject, and relationships. They are part of the model and are not attributes the TypeSpec property list can show on their own.
the page being built
StaticattributeOne attribute's description: secret, families, the model's own sentence, and a citation when the row has one.
a catalogue attribute
the cell text
StaticattributeAppends an attribute table.
the page being built
the attributes
StaticattributeThe TypeScript type of a directory kind.
single, multi or unspecified
the type
StaticattributeThe Zod expression of a directory kind, before .optional().
single, multi or unspecified
the expression
StaticcaptureCaptures documents the caller already built. This does not build
them, and check() does not call it.
document name and the builder's object
one captured model per document
StaticcheckTwo directory collects agree, and the reading pages and the TypeSpec match the model. OpenAPI is not built here.
the package root
problems, empty when the check passes
StaticclassOne object class, in RFC 4512's form.
a class with an OID
the definition
StaticclassA TypeScript name. application stays Application. A dotted id
such as policy.password becomes PolicyPassword, because the
dot is not part of a class name.
an object id or a table name
the class name
StaticcolumnNotes for one column of the reading page.
a column
the notes cell
StaticcolumnThe TypeScript type of a SQL type token.
the type from the column
the type
StaticcolumnThe Zod expression of a SQL type token, before .optional(). The
same mapping as PostgresImport.zodOf.
the type from the column
the expression
StaticdirectoryThe body of one directory model, under a heading the caller writes.
the page being built
the catalogue object
the person-side attributes of a policy
StaticdirectoryClass text for one directory object, and a second class when the object lists person attributes. The text is not compiled here.
a catalogue object
the class text
StaticdirectoryThe directory models, as a page a person can read.
a catalogue from DirectoryModel.collect()
the Markdown page, including its front matter
StaticdirectoryThe heading a reader sees for one directory object.
the object id
the heading
StaticdocA doc comment, wrapped to 80 columns. An empty text writes nothing. A single token longer than the width is kept whole.
the file being built
the sentence
the indent of the comment
StaticescapeEscapes the end of a block comment.
the sentence
the text safe to put in a block comment
StaticexpectOne generated file, compared to a fresh render. A missing file is stale.
the package root
the path under the package root
what the file should contain
the list being built
StaticfieldsThe class text. schema() is a z.strictObject, so an unknown key
fails. The tests read this text. They do not compile it.
the class name
name, optional, TypeScript type, Zod expression
the class text
StaticheadingA heading's kramdown id: lower case, spaces as hyphens, and no
other punctuation. The same rule as tests/doc_links.js.
the heading text
the id
StaticldapRFC 4512 definitions of everything in the model that has an OID. A name with no OID cannot be written as a definition, so it is listed instead.
objects from a compiled model
the definitions and the names that have no OID
Staticmainnode common/model_emit.js --check, --docs, or --write.
--docs rewrites the TypeSpec and the reading pages.
arguments after the program name
StaticoneOne directory class.
the class name
the attributes
directory attributes are always optional
the class text
StaticoriginWhere a name comes from, in words.
the catalogue provenance
the word
StaticpersistenceThe persistence models, as a page a person can read.
a model from PostgresImport.read()
the Markdown page, including its front matter
StaticsourceThe sentence under a model that says where it was recorded.
a catalogue object
the sentence
StatictableA Markdown table cell. A pipe or a newline would split the row.
the cell
the escaped cell
StatictableClass text for one table. One property per column. jsonb and any
type this mapping does not name are unknown. The same tokens as
PostgresImport.zodOf.
a table from the PostgreSQL model
the class text
StatictypeOne attribute type, in RFC 4512's form.
an attribute with an OID
the definition
StaticvalueHow many values an attribute holds, in words.
single, multi, or anything else
the word
StaticwrapWraps on spaces. A token longer than width stays on its own line.
one paragraph
the maximum line length
the lines
StaticwriteWrites the TypeSpec, the reading pages, a structural model.json
and gaps.json. Class text and OpenAPI documents are not written:
a class file would be compiled into the image, and an OpenAPI file
rebuilt from pieces would not be the served document.
the package root
StaticwriteCollects both namespaces and writes the TypeSpec and the reading pages.
the package root
StaticwriteWrites the TypeSpec and the two reading pages. model.json is not
written here.
the package root
the directory catalogue
the persistence model
Turns a collected catalogue into TypeSpec and class text.