ngx-recipe-forms 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,131 @@
-# Temporary Holding Version
+# ngx-recipe-forms
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Generic **recipe-based** form engine, built on Angular Signal Forms (`@angular/forms/signals`, Angular 22.2) and Tailwind 4.
+A recipe is **an object typed by the model**, declared in code; the engine derives the Signal Forms schema, the rendering, the messages and the layout from it.
+
+To write a recipe, follow [`AGENTS.md`](https://github.com/SrenoG/ngx-recipe-forms/blob/main/AGENTS.md) (in French: method, catalog, pitfalls, checklist).
+
+## What the library does
+
+- **Recipe types**: `FormRecipe<TModel>`, nodes `section`, `row`, `sectionGroup`, `field`, `linked`, `array`; controls and rules constrained by the type of the value; typed builder `recipeBuilder<TModel>()`. The nodes of an `array` item are built with `recipeBuilder<ItemModel, RootModel>()`: their rules read the root through `ctx.root(key)`.
+- **Schema**: `RecipeSchema.build(recipe)` turns each rule into a native function (`required`, `pattern`, `min`…, `validate`, `validateTree`, `validateAsync`, `metadata`), and applies `disabled`, `hidden`, `readonly` (per field, per section or for the whole recipe), the rules of `array` items (`applyEach`), the rules of the whole list (`minItems`, `maxItems`, `unique`, `validate`), non-blocking warnings (`warn`), linked controls and `extraRules`. When a server validator fails, the engine sets the "validation unavailable" warning without blocking: the server still decides on save.
+- **Messages**: priority field → recipe → default → raw message; server errors are shown by their `message`, translated by the caller, otherwise by the key `errors.<code>`; a field error set by the host application as `{ kind: 'server', error: { code, constraint?, message } }` is read as is.
+- **Server errors by path**: `RecipeServerPaths` records the position → key mapping of each `array` when the request is sent; `rooms[2].code` is set on the item that was at position 2, the error clears as soon as the value changes, and whatever cannot be placed comes out through `unplacedServerErrors`.
+- **Sections**: `RecipeSections` (field index, error count, first field in error).
+- **Tailwind layout**, **response time measurement** of server validators.
+- **Rendering**: `<app-recipe-form>`, `<app-recipe-node>`, `<app-recipe-section-group>` (`plain`, `panel` and `tabs` formats, error counts per panel or per tab, opening the panel or activating the tab of the first field in error; no format destroys a section), `<app-recipe-field>`, `array` as a list or a table with a slot and an API (`addItem`, `removeItem`, `has`, `items`, declared sort). Default wrappers `app-input-text`, `app-input-number` (decimals bounded by `minFractionDigits` and `maxFractionDigits`), `app-select`, `app-date-picker`, `app-date-picker-multiple`, `app-checkbox`, `app-button`, `app-panel`, `app-tabs` (with `TabPanelDirective`), and `app-message` for field, group and list messages. Under a field: the hint (`hintKey`, conditional through `{ key, when?, showWhenReadonly? }`, hidden in read-only mode like the required asterisk), then the translated reason of an active `disabled` rule (`reasonKey`), in the same style, removed when the field is enabled again. The `labelKey` options of a `select` are translated by the engine before they reach the wrapper. A table `array` scrolls in its own container (`overflow-x-auto`); a cell message wraps instead of widening its column.
+
+## Usage
+
+```ts
+// 1. The form model, in plain values (the conversion to the DTO stays in the mapper).
+interface CourseFormData { deliveryMode: string | null; sessions: readonly CourseSession[]; totalHours: number | null; }
+interface CourseSession extends ArrayItem { date: Date | null; hours: number | null; }
+
+// 2. The recipe, built from its context (permission signals, options, validators).
+const b = recipeBuilder<CourseFormData>();
+const item = recipeBuilder<Omit<CourseSession, 'key'>, CourseFormData>();
+export const courseRecipe = (ctx: Ctx) => b.recipe('course', {
+  readonly: () => ctx.readOnly(),
+  nodes: [
+    b.sectionGroup('main', { display: SectionDisplayEnum.PANEL, sections: [
+      b.section('sessions', { legendKey: 'course.sections.sessions', nodes: [
+        b.array('sessions', {
+          display: ArrayDisplayEnum.TABLE,
+          emptyItem: (key) => ({ key, date: null, hours: 7 }),
+          sort: (a, c) => (a.date?.getTime() ?? 0) - (c.date?.getTime() ?? 0),
+          slot: { name: 'calendar', position: 'before' },
+          rules: [{ rule: RuleTypeEnum.MIN_ITEMS, value: 1 }, { rule: RuleTypeEnum.UNIQUE, by: (s) => String(s.date) }],
+          item: [
+            item.field('date', { labelKey: 'course.fields.date', control: { type: ControlTypeEnum.DISPLAY } }),
+            item.field('hours', { labelKey: 'course.fields.hours', control: { type: ControlTypeEnum.NUMBER },
+              rules: [{ rule: RuleTypeEnum.VALIDATE, fn: (hours, c) => (c.root('deliveryMode') === 'REMOTE' && hours !== null && hours > 4 ? { kind: 'remoteHours' } : undefined) }] }),
+          ],
+        }),
+        b.field('totalHours', { labelKey: 'course.fields.totalHours', control: { type: ControlTypeEnum.DISPLAY, compute: (m) => String(m.sessions.reduce((sum, s) => sum + (s.hours ?? 0), 0)) } }),
+      ] }),
+    ] }),
+  ],
+});
+
+// 3. The caller creates the FieldTree and receives the submitted value.
+readonly model = signal<CourseFormData>(initial);
+readonly form = form(this.model, RecipeSchema.build(this.recipe, { timing: inject(FORM_VALIDATION_TIMING) }));
+```
+
+```html
+<app-recipe-form
+  [recipe]="recipe"
+  [form]="form"
+  [serverErrors]="rejection()"
+  (submitted)="save($event)"
+  (invalidSubmit)="…"
+  (unplacedServerErrors)="generalErrors.set($event)"
+>
+  <ng-template appRecipeSlot="calendar" let-list let-api="api">
+    <app-date-picker-multiple
+      [value]="selectedDates()"
+      (dateAdded)="api.addItem({ date: $event })"
+      (dateRemoved)="api.removeItem(keyOf($event))"
+    />
+  </ng-template>
+  <button appRecipeActions type="submit">Save</button>
+</app-recipe-form>
+```
+
+Providers: `provideRecipeForms({ production, translator, translationChanges, keyGenerator })`. `translator` and `translationChanges` are factories run in the injection context (`useFactory`). For example with Transloco:
+
+```ts
+provideRecipeForms({
+  production,
+  translator: () => {
+    const transloco = inject(TranslocoService);
+    return (key, params) => transloco.translate(key, params);
+  },
+  // A new object on each event: lazily loaded scope, language change.
+  translationChanges: () => toSignal(inject(TranslocoService).events$),
+});
+```
+
+`translationChanges` (token `RECIPE_FORM_TRANSLATION_CHANGES`, a constant signal by default) returns a signal whose value changes each time translations are loaded or changed. The engine reads it before calling the translator for tab titles, error count texts, the `labelKey` options of a `select` and the `recipeTranslate` pipe: a scope loaded after the first render replaces the raw keys on screen. A value equal to the previous one (`Object.is`) triggers nothing: with Transloco, `langChanges$` alone is not enough, since it does not change when a scope loads.
+
+## Plugging in your design system
+
+- Selectors are `app-*` and classes end with `Component`.
+- **Controls**: the engine renders each control (`text`, `number`, `select`, `date`, `dateMultiple`, `checkbox`) with a template from the `RecipeUi` registry. The host passes to `provideRecipeForms({ ui })` a component that declares one `<ng-template appRecipeTextControl let-field let-inputId="inputId" …>` (`appRecipeNumberControl`, `appRecipeSelectControl`, `appRecipeDateControl`, `appRecipeDateMultipleControl`, `appRecipeCheckboxControl`) per control to render with its design system, and binds its wrapper to it with `[formField]="field"`. A control it does not declare keeps the default template. `RecipeDefaultUiComponent` (`ui/recipe-default-ui.ts`) declares the six templates with the wrappers from `ui/` and serves as a model; the context of each template is typed (`RecipeTextControlContext`…). The registry creates these components once, outside the application tree; a template's view is refreshed with the field that inserts it, and updated in place when its context changes (the control keeps its focus). Learning tests: `specs/ui-seam.learning.spec.ts`.
+- **Messages, buttons, panels and tabs**: the engine renders them through `app-recipe-message`, `app-recipe-button`, `app-recipe-panel` and `app-recipe-tabs`, which keep the id targeted by `aria-describedby`, the placement classes and the state (collapsed panel, active tab), and render the registry template inside: `appRecipeMessage` (translated text, `severity`, `inline`), `appRecipeButton` (label, `variant`, `severity`, `click`), `appRecipePanel` (`let-content` to render with `ngTemplateOutlet`, texts, `collapsed` and `toggle`), `appRecipeTabs` (`let-panels`, one `{ value, template }` per section, to render without ever destroying it, `options`, `value`, `select`, `fill`). The tabs template tracks panels by `value`: the list is recreated on each computation of the context.
+- For a single field, a `SLOT` control renders the template provided by the caller. The wrappers in `ui/` remain those of the default templates. Contracts expected from the wrappers:
+  - every control: Signal Forms contract (`value` or `checked`, `disabled`, `invalid`, `touched`, `touch` output), `inputId` and `describedBy` inputs (`aria-describedby` set on the element that receives focus), a `focus(options?: FocusOptions)` method that passes `options` to the native focus (focus of the first field in error, called with `preventScroll: true`: the engine then scrolls `app-recipe-field` to the center with `scrollIntoView({ block: 'center' })`);
+  - `app-input-text`: `placeholder` (`''` by default), `inputmode` (`'text'` by default), `maxLength` (a `FormValueControl` input, bound by `[formField]` to the `MAX_LENGTH` rule), `icon` (trailing icon, none by default; the engine passes `TextControlDef.icon` as is, an icon name of the host's wrapper, `string` by default and restricted to the host's names if it extends `RecipeIconTypes` (`declare module 'ngx-recipe-forms' { interface RecipeIconTypes { icon: IconEnum } }`); the default wrapper accepts it without drawing it);
+  - `app-input-number`: `step`, `minFractionDigits` (decimals always shown), `maxFractionDigits` (decimals allowed when typing, 3 by default);
+  - `app-select`: `options: SelectOption<T>[]` (`[]` by default; the field passes a copy, with `label` already translated for a recipe option using `labelKey`), `showClear`, `filter` (search in the list, `false` by default; the engine passes `filter ?? false`; the native `<select>` of the default wrapper ignores it and keeps the browser's first-letter search), `ariaLabelledBy` (id of the label: a design system's dropdown is often not a native field), `placeholder` (text shown when the value is `null`, translation of `SelectControlDef.placeholderKey`, `''` without a key). In `readonly` mode, the list stays focusable (never `disabled` for read-only), does not open, does not change value from the keyboard, has neither chevron nor pointer cursor and carries `aria-readonly="true"`; the `RecipeSelectControlContext` context passes `placeholder` and `readonly` to the template. Contract spec of the default template: `specs/recipe-select-readonly.spec.ts`;
+  - `app-date-picker-multiple`: `FormValueControl<readonly Date[]>`, `maxDate`, `numberOfMonths` (months shown side by side, 3 by default; the engine passes `months ?? 3`; the native field of the default wrapper ignores it), `ariaLabel` (name of the group, the translated label), `dateAdded` and `dateRemoved` outputs for each day checked or unchecked;
+  - `app-panel`: `header`, `collapsible`, `collapsed` (model), `badge` (number, absent at zero), `badgeLabel`, `collapseLabel` and `expandLabel` (name of the collapse button, with `aria-expanded`);
+  - `app-tabs`: `value` (model, `string`), `options: TabOption[]` (`label`, `value`, `disabled`, `badge` absent at zero, `badgeLabel`; same shape as `SelectOption<string>`), `fill` (`false` by default; when true: below 768 px, the tabs share the full width, `flex-1` on a zero basis, and their title wraps between words only, never inside a word, so no tab is out of view; smaller padding and text (`px-2`, `text-xs`); badge in the top right corner of the tab (`absolute`, tab `relative`), in a top space reserved even without a count (`pt-6`): the title gets the full width and the tab keeps the same height with or without a count; nothing changes above that width; the section group sets it to true); one panel per projected `<ng-template [appTabPanel]="value">` (`TabPanelDirective`, in template order), hidden (`hidden`) when its tab is inactive and never destroyed; the bar alone without a template; ARIA tabs pattern (`aria-controls`, `aria-labelledby`, roving focus, arrows, Home, End); sticky bar at the top of the scrolling container (`sticky z-10`, opaque white background), panels in the same block, at `top: var(--app-sticky-top, 0px)` (class `top-[var(--app-sticky-top,0px)]`): a scrolling container with a top padding sets `--app-sticky-top` to the negative of that padding (`-20px` for 20 px), otherwise content stays visible in the strip above the stuck bar; when the user changes tab (click or keyboard) while the bar is stuck (top of the host above the top of the bar), the host scrolls to the start of the area (`scrollIntoView({ block: 'start' })`, after rendering), nothing without prior scrolling, nothing when `value` is changed by the parent (tab of the first field in error: the field's focus takes over); name of the tab (and of the panel) = title only, `badgeLabel` in a `hidden` element targeted by the tab's `aria-describedby`, badge `aria-hidden`; same tab height with or without a badge (`leading-none` in an `h-5` container, the title's line);
+  - `app-checkbox` (and any `appRecipeCheckboxControl` template): `FormCheckboxControl`; in `readonly` mode, the box never changes state, neither on screen nor for assistive technologies (click, click on the label and Space are cancelled, the native box does not get checked), stays focusable (never `disabled` for read-only), carries `aria-readonly="true"` on the focusable element, and keeps the default cursor on the box and its label. The `RecipeCheckboxControlContext` context passes `readonly` to the template. Contract spec of the default template: `specs/recipe-readonly-field.spec.ts`;
+  - `app-message`: `severity` (`SeverityEnum`, including the `WARNING` key), `inline`, projected content; `[id]` set on the host element.
+- Translator: `RECIPE_FORM_TRANSLATOR` and `RECIPE_FORM_TRANSLATION_CHANGES` are provided with `useFactory`: the factory can inject the application's i18n service (see "Providers" above). Without a translator, the key is shown as is. The `recipeTranslate` pipe is impure (lazily loaded scopes).
+- `translationChanges`: the `labelKey` options of a `select`, tab titles and count texts are translated by the translator in a `computed`, not by the impure pipe: they are recomputed whenever their data changes and, with `translationChanges`, whenever translations load; without this option, the scope that holds their keys must be loaded before the form renders.
+- Default keys: they are listed by the `RECIPE_FORM_DEFAULT_KEYS` constant (`constants/recipe-form-default-keys.constants.ts`); a host spec checks that its flattened dictionary (`forms.array.add`) contains each of them (model: `projects/playground/src/app/i18n/fr.spec.ts`): `forms.errors.*` (including `minItems`, `maxItems`, `unique`), `forms.warnings.validationUnavailable`, `forms.pending`, `forms.array.*`, `forms.display.errorCountOne` and `forms.display.errorCount` ("{{ count }} error", "{{ count }} errors": the engine uses the first one when `count` is 1 and the second otherwise, since the translator has no plural), `forms.display.collapsePanel` and `forms.display.expandPanel` ("Collapse panel {{ title }}", "Expand panel {{ title }}"), and, outside the constant, `errors.<code>` (or `<scope>.errors.<code>`) for server codes.
+
+## In the host application
+
+- Tailwind 4: the library's classes are literal. If the package is consumed from `node_modules`, add `@source "../node_modules/ngx-recipe-forms";` to the host's stylesheet.
+- Server validators (`ServerValidator<T>`) return an `Observable<ServerValidationResult>`; the adapter to the application's HTTP services is written by the caller. A validator that needs other keys of the model (for example the start date and the format of a training course) is declared `ServerValidator<T, RootModel>`, receives `(value, ctx)` and reads through `ctx.root(key)` the keys its rule declares in `dependsOn`. The errors of a write (`RecipeServerError[]`: `fields`, `code`, `message?`) are passed as is to `serverErrors`.
+- `server` rules call their validator through the resource of `RECIPE_FORM_RX_RESOURCE` (`rxResource` by default): an application that enforces its own resource wrapper passes it to `provideRecipeForms({ rxResource })`, with the signature of `rxResource`. The timing collector is a `@Service({ autoProvided: false })`.
+- `npm run check:loose` compiles the library and its specs under less strict options, like an application that sets neither `strict` nor `strictTemplates`: the `@ts-expect-error` of `recipe-types.spec.ts` must hold. The specs use no API specific to Vitest 5. Those that submit an invalid form replace `Element.prototype.scrollIntoView`, which jsdom does not implement, with a `vi.fn` spy for each test; a host spec that submits an invalid recipe form must do the same.
+
+## Commands
+
+```bash
+npm run build:lib      # ng build recipe-forms
+npm run pack:lib       # builds then packs the package (dist/ngx-recipe-forms-<version>.tgz)
+npm run publish:lib    # builds then publishes dist/recipe-forms to npm
+npm run test:lib       # ng test recipe-forms --watch=false
+npm run check:loose    # tsc with less strict options
+npm start              # ng serve playground
+npm run install:host -- <host folder>   # installs the built package in a host (file:…tgz)
+npm run export:host -- <folder>         # copies the sources into a host, with the hash manifest
+```
+
+Both scripts are described in the [repository README](https://github.com/SrenoG/ngx-recipe-forms#readme) ("Trying it in an application before publication", "Copying it into an application").