@orkestrel/form 0.0.4 → 0.0.6

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,14 +1,16 @@
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.
11
- Built on `@orkestrel/contract` and `@orkestrel/emitter`.
3
+ > The environment-agnostic form document: a `FormSchema` stating what is asked, a `Form` holding
4
+ > the answers given against it, declarative `FieldRule` data stating what those answers must
5
+ > satisfy, and one submit that settles the form exactly once.
6
+
7
+ A terminal prompt and a browser form ask the same thing in different places, so this package ships
8
+ what they share and neither renders nor reads input itself. Its `answer` promise is the parking seam
9
+ a server needs: hand the document out, wait, receive the answers back. A live form can take a field
10
+ out and put it back with `disable` and `enable`, and exported budgets bound what one schema and its
11
+ answers may retain, so a document that arrives from a wire costs a known maximum before anything
12
+ decides to trust it. Built on `@orkestrel/contract` and `@orkestrel/emitter`, and part of the
13
+ `@orkestrel` line.
12
14
 
13
15
  ## Install
14
16
 
@@ -57,11 +59,11 @@ await parked // { email: 'ada@example.com', secret: 'correct horse battery', ter
57
59
 
58
60
  ## Guide
59
61
 
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.
62
+ See [guides/form.md](./guides/form.md) for the documented surface — the controls and their value
63
+ shapes, the rule table and the custom cross-field seam, the presence model behind `required`, the
64
+ lifecycle and its events, taking a field out of a live form with `disable` and `enable`, the budgets
65
+ that bound what a schema and its answers may retain, the serialize/parse wire boundary, and the
66
+ concept inventory of what this package leaves to the layer above.
65
67
 
66
68
  ## Package
67
69