@orkestrel/form 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Orkestrel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# @orkestrel/form
+
+The environment-agnostic form document for the `@orkestrel` line — a schema of twelve field
+controls, the answers given against it, declarative validation carried as data, and a submit that
+settles exactly once. A terminal prompt and a browser form ask the same thing in different places,
+so this package ships what they share and neither renders nor reads input itself. Its `answer`
+promise is the parking seam a server needs: hand the document out, wait, receive the answers back.
+A live form can take a field out and put it back with `disable` and `enable`, and nine exported
+budgets bound what one schema and its answers may retain, so a document that arrives from a wire
+costs a known maximum before anything decides to trust it.
+Built on `@orkestrel/contract` and `@orkestrel/emitter`.
+
+## Install
+
+```sh
+npm install @orkestrel/form
+```
+
+## Requirements
+
+- Node.js >= 22.12
+- Host-independent: no `node:*`, no DOM. Ships dual ESM+CJS builds.
+
+## Usage
+
+Declare what is asked, answer it, and settle it once:
+
+```ts
+import { createForm } from '@orkestrel/form'
+
+const form = createForm({
+	label: 'Sign up',
+	fields: [
+		{ control: 'text', name: 'email', label: 'Email', rule: { required: true, email: true } },
+		{
+			control: 'password',
+			name: 'secret',
+			label: 'Password',
+			rule: { required: true, minimum: 12 },
+		},
+		{ control: 'confirm', name: 'terms', label: 'I accept the terms', rule: { required: true } },
+	],
+})
+
+// A task somewhere else parks on the answer.
+const parked = form.answer
+
+form.fill({ email: 'ada@example.com', secret: 'correct horse battery' })
+form.errors // [{ field: 'terms', message: 'This field is required', rule: 'required' }]
+
+form.fill('terms', true)
+const result = form.submit()
+result.success // true
+
+await parked // { email: 'ada@example.com', secret: 'correct horse battery', terms: true }
+```
+
+## Guide
+
+See [guides/form.md](./guides/form.md) for the documented surface — the twelve controls and their
+value shapes, the rule table and the custom cross-field seam, the presence model behind `required`,
+the lifecycle and its seven events, taking a field out of a live form with `disable` and `enable`,
+the budgets that bound what a schema and its answers may retain, the serialize/parse wire boundary,
+and the concept inventory of what this package leaves to the layer above.
+
+## Package
+
+Published as one entry point per the `exports` field in `package.json`: `.`, the host-independent
+core. It ships dual ESM+CJS builds with declarations for both.
+
+## Development
+
+```sh
+npm install
+npm test
+```
+
+## License
+
+MIT © [Orkestrel](https://github.com/orkestrel) — see [LICENSE](./LICENSE).