@orkestrel/form 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,13 +1,13 @@
1
1
  # @orkestrel/form
2
2
 
3
- The environment-agnostic form document for the `@orkestrel` line — a schema of twelve field
4
- controls, the answers given against it, declarative validation carried as data, and a submit that
5
- settles exactly once. A terminal prompt and a browser form ask the same thing in different places,
6
- so this package ships what they share and neither renders nor reads input itself. Its `answer`
7
- promise is the parking seam a server needs: hand the document out, wait, receive the answers back.
8
- A live form can take a field out and put it back with `disable` and `enable`, and nine exported
9
- budgets bound what one schema and its answers may retain, so a document that arrives from a wire
10
- costs a known maximum before anything decides to trust it.
3
+ The environment-agnostic form document for the `@orkestrel` line — a schema of field controls, the
4
+ answers given against it, declarative validation carried as data, and a submit that settles exactly
5
+ once. A terminal prompt and a browser form ask the same thing in different places, so this package
6
+ ships what they share and neither renders nor reads input itself. Its `answer` promise is the
7
+ parking seam a server needs: hand the document out, wait, receive the answers back. A live form can
8
+ take a field out and put it back with `disable` and `enable`, and exported budgets bound what one
9
+ schema and its answers may retain, so a document that arrives from a wire costs a known maximum
10
+ before anything decides to trust it.
11
11
  Built on `@orkestrel/contract` and `@orkestrel/emitter`.
12
12
 
13
13
  ## Install
@@ -57,11 +57,11 @@ await parked // { email: 'ada@example.com', secret: 'correct horse battery', ter
57
57
 
58
58
  ## Guide
59
59
 
60
- See [guides/form.md](./guides/form.md) for the documented surface — the twelve controls and their
61
- value shapes, the rule table and the custom cross-field seam, the presence model behind `required`,
62
- the lifecycle and its seven events, taking a field out of a live form with `disable` and `enable`,
63
- the budgets that bound what a schema and its answers may retain, the serialize/parse wire boundary,
64
- and the concept inventory of what this package leaves to the layer above.
60
+ See [guides/form.md](./guides/form.md) for the documented surface — the controls and their value
61
+ shapes, the rule table and the custom cross-field seam, the presence model behind `required`, the
62
+ lifecycle and its events, taking a field out of a live form with `disable` and `enable`, the budgets
63
+ that bound what a schema and its answers may retain, the serialize/parse wire boundary, and the
64
+ concept inventory of what this package leaves to the layer above.
65
65
 
66
66
  ## Package
67
67