@agentshouse/panel-contract 0.1.0-alpha.159757594113478

package/README.md

@@ -0,0 +1,34 @@
+# @agentshouse/panel-contract
+
+What one agents.house release serves to its panel. House generates it from its
+own code, and its version is derived from its content: two releases with equal
+contracts and recorded days carry one version.
+
+```js
+import { contract, version } from '@agentshouse/panel-contract';
+```
+
+`contract` holds four parts, each schema a JSON Schema (2020-12):
+
+- `acts` - every application-door act by name, posted to `/door/<name>`, with
+  its `input` schema and, once the act states one, its `answer` schema, which
+  covers each refusal it answers by code.
+- `documents` - every House document type House writes, with the schema of its
+  frontmatter `fields`, where it has them, its `sections`, and, where House
+  writes one, its Markdown `body`. A list entry's
+  word grammar is a `pattern` whose named groups are its words; a field that
+  holds JSON names `contentMediaType` and its `contentSchema`.
+- `notifications` - every Human Notification kind with the value fields its
+  `house-notification` document carries.
+- `served` - the exact `@agentshouse/mdruntime`, `@agentshouse/mdruntime-adapter`
+  and `@agentshouse/app-bridge` versions this release serves.
+
+`index.d.ts` types `contract` as its literal value, so a schema can be turned
+into a TypeScript type at build time. `contract.json` holds the same value.
+
+`day.json` (`@agentshouse/panel-contract/day.json`) is the recorded day: what
+House produced for a scripted day of real acts by several Users. `users` holds
+each User's House documents by path, `acts` each door answer with its act,
+User, request and status, and `frames` each conversation frame a User's House
+stream received, with its User. Identities are numbered from the day's start and
+no credential is kept.