Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-002
The layered-model lens (commons 0011-documentation FR-029): the models of a library that is built in layers (governance, logical, physical or surface), as pages for a developer and an agent and as a Markdown twin and a JSON file for each. It is given a function that makes LayeredModel values (a library's own pure builder, such as commons data's describeModels) and knows nothing of the library: what the models say is read from the values, where they are written is found from the files that export them (by the identity of the value), and each page says which layer it is of and how that layer is used.
Pages: the models and the layers (what each layer is for, which code writes it, what may be edited, how to change a model and regenerate what follows); for each model its overview and a diagram of its concepts; for each concept its definition, where it is written (a link to the line), its attributes and relationships, what it projects to and the SQL and the typed table it is written as; for each code list its codes; and registers of what the models annotate (personal data, security, ownership). Every element has an anchor that is its id, so that a link and a diff can name it.
Source: commons/docs/src/lens/layered.ts
1 of 2 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.
LayeredLensOptionsinterfaceno test imports itinterface LayeredLensOptions
What the lens is given.
| Member | Type | What it is |
|---|
name | string | Its name, which the build reports it by. |
group? | string | The group of the Models section the pages are in. |
source | LayeredSource | Makes the models; it is told how to find where a value is written. |
exports | readonly string[] | The files, from the repository's root, whose exports are the values the models are made of: where an element is written is found from them. |
regenerate? | readonly string[] | The command that regenerates what follows the top layer, and the file a person edits first, written into the page that says how to change a model. |
function layeredLens(options: LayeredLensOptions): Lens
The layered-model lens.
Imported by 4 tests of the run (4 passed, 0 failed): the library's results