@agentshouse/mdruntime-adapter 0.1.0-cc1bdabaf4e28 → 0.1.0-cc34762b70bb0
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/dist/actions.d.ts +4 -59
- package/dist/actions.d.ts.map +1 -1
- package/dist/actions.js +7 -289
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js +134 -327
- package/dist/discovery.d.ts +19 -6
- package/dist/discovery.d.ts.map +1 -1
- package/dist/discovery.js +63 -30
- package/dist/history.d.ts +12 -0
- package/dist/history.d.ts.map +1 -0
- package/dist/history.js +92 -0
- package/dist/house-model.d.ts +718 -1
- package/dist/house-model.d.ts.map +1 -1
- package/dist/house-model.js +393 -442
- package/dist/index.d.ts +8 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -3
- package/dist/model.d.ts +2 -3
- package/dist/model.d.ts.map +1 -1
- package/dist/model.js +0 -17
- package/dist/part.d.ts +11 -12
- package/dist/part.d.ts.map +1 -1
- package/dist/part.js +63 -55
- package/dist/read.d.ts +10 -58
- package/dist/read.d.ts.map +1 -1
- package/dist/read.js +37 -220
- package/dist/refusal.d.ts +0 -3
- package/dist/refusal.d.ts.map +1 -1
- package/dist/refusal.js +0 -5
- package/dist/room-stream.d.ts +19 -0
- package/dist/room-stream.d.ts.map +1 -0
- package/dist/room-stream.js +57 -0
- package/dist/room-types.d.ts +3 -3
- package/dist/room-types.d.ts.map +1 -1
- package/dist/room-types.js +8 -7
- package/dist/search.d.ts +5 -0
- package/dist/search.d.ts.map +1 -0
- package/dist/search.js +47 -0
- package/dist/site.d.ts.map +1 -1
- package/dist/site.js +75 -158
- package/dist/stream.d.ts +13 -14
- package/dist/stream.d.ts.map +1 -1
- package/dist/stream.js +163 -425
- package/dist/transport.d.ts +48 -35
- package/dist/transport.d.ts.map +1 -1
- package/dist/transport.js +54 -11
- package/dist/upload.d.ts.map +1 -1
- package/dist/upload.js +2 -2
- package/dist/write.d.ts +6 -1
- package/dist/write.d.ts.map +1 -1
- package/dist/write.js +17 -24
- package/package.json +2 -2
- package/dist/gather.d.ts +0 -4
- package/dist/gather.d.ts.map +0 -1
- package/dist/gather.js +0 -35
package/dist/house-model.d.ts
CHANGED
|
@@ -1,2 +1,719 @@
|
|
|
1
|
-
export declare const HOUSE_MODEL_TYPES = "$defs:\n room:\n description: A Room, by its Room reference, under the key `room`.\n type: string\n pattern: '^r_([0123456789abcdefghjkmnpqrstvwxyz]+)\\.([0123456789abcdefghjkmnpqrstvwxyz])$'\n app:\n description: An App, by its App reference, under the key `app`.\n type: string\n pattern: '^a_([0123456789abcdefghjkmnpqrstvwxyz]+)\\.([0123456789abcdefghjkmnpqrstvwxyz])$'\n document:\n description: A document of a Room, by its file reference, under the key `document`.\n type: string\n pattern: '^af_([123456789abcdefghjkmnpqrstvwxyz][0123456789abcdefghjkmnpqrstvwxyz]*)\\.([0123456789abcdefghjkmnpqrstvwxyz])$'\n id:\n description: Any other entity, by its identifier, under the key of its kind. An entity a type says more about is an object holding it under that key beside its facts.\n type: string\n format: uuid\n namespace:\n description: The Namespace a grant entry covers, an App or a Room by its reference with the area of it.\n type: string\n maxLength: 512\n pattern: '^(?:a_[A-Za-z0-9._-]+(?:\\/source)?|r_[A-Za-z0-9._-]+(?:\\/(?:settings|settings\\/schema|settings\\/model|settings\\/indexing|content))?)$'\n request:\n description: One Routine Request of a Room.\n type: object\n additionalProperties: false\n properties:\n routine_request: { $ref: '#/$defs/id' }\n conversation: { $ref: '#/$defs/id' }\n origin: { enum: [ user, trigger ] }\n state: { enum: [ awaiting_approval, started, finished, not_started, withdrawn_by_author, withdrawn_admission, declined ] }\n target: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' } }, required: [ user ] }\n record: { $ref: '#/$defs/id' }\n routine_access: { $ref: '#/$defs/id' }\n agent: { $ref: '#/$defs/id' }\n routine: { type: object, additionalProperties: false, properties: { name: { type: string }, version: { type: integer, exclusiveMinimum: 0 } }, minProperties: 1 }\n approved: { type: string, format: date-time }\n approved_by: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' } }, required: [ user ] }\n settled_by: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' } }, required: [ user ] }\n failure_category: { enum: [ routine_access_not_found, routine_retired, target_agent_unavailable, agent_unavailable, admission_lapsed ] }\n created: { type: string, format: date-time }\n activated: { type: string, format: date-time }\n settled: { type: string, format: date-time }\n environment_starting: { const: true }\n result: { type: string }\n url: { type: string, format: uri }\n required: [ routine_request, origin, state, target, created ]\n caller:\n description: One caller of a Routine Access, a User under `user` with their account `email` and display `name`, or under `user` alone once they left the Room, or the Access's `room`, whose Triggers then call.\n type: object\n additionalProperties: false\n properties:\n user: { $ref: '#/$defs/id' }\n email: { type: string }\n name: { type: string }\n room: { $ref: '#/$defs/room' }\n minProperties: 1\nhouse-account:\n description: \"The User's own identifier as `user`, their registration as `created`, their email verification and chosen language, every notification group with the channels it now reaches as `notifications`, `telegram: available` while the Building runs a Telegram bot and no Telegram account is linked to it, `linked` while one is, `meta`, the Building's Meta app as `application` and its signup configuration as `configuration`, with `business_app` where its signup offers to keep the WhatsApp Business app on the number's phone, while it offers Connect Meta, `tiktok: available` while it offers Connect TikTok, and `building: administrator` while the User is one of the Building's administrators.\"\n properties:\n reflected: { type: string, format: date-time }\n user: { $ref: '#/$defs/id' }\n email_verified: { type: string, format: date-time }\n language: { enum: [ en ] }\n notifications: { type: array, items: { type: object, additionalProperties: false, properties: { group: { type: string }, channels: { type: array, items: { type: string } } }, required: [ group, channels ] } }\n created: { type: string, format: date-time }\n telegram: { enum: [ available, linked ] }\n meta: { type: object, additionalProperties: false, properties: { application: { type: string, pattern: '^\\d{1,32}$' }, configuration: { type: string, pattern: '^\\d{1,32}$' }, business_app: { const: true } }, required: [ application, configuration ] }\n tiktok: { enum: [ available ] }\n building: { enum: [ administrator ] }\n required: [ reflected, user, email_verified, notifications, created ]\nhouse-agent:\n description: One registered Agent this User owns, with the `profile` and `environment` it binds, when it was `created` and, once it is, `retired`.\n properties:\n reflected: { type: string, format: date-time }\n agent: { $ref: '#/$defs/id' }\n name: { type: string }\n profile: { $ref: '#/$defs/id' }\n environment: { $ref: '#/$defs/id' }\n launch_directory: { type: string }\n created: { type: string, format: date-time }\n retired: { type: string, format: date-time }\n required: [ reflected, agent, name, profile, environment, launch_directory, created ]\nhouse-agent-profile:\n description: One reusable Agent Profile this User owns, with the execution route it binds and the `arguments` that route passes its CLI. Its body is its instructions, whole, in Markdown.\n properties:\n reflected: { type: string, format: date-time }\n profile: { $ref: '#/$defs/id' }\n name: { type: string }\n revision: { type: integer, minimum: 0 }\n adapter_kind: { type: string }\n model: { type: string }\n effort: { type: string }\n mode: { type: string }\n arguments: { type: array, items: { type: string } }\n required: [ reflected, profile, name, revision ]\nhouse-app:\n description: \"One App this User owns, holds or installed, `ownership` naming whether it is its own or one it holds, its `owner` by `name` when another User owns it, and `my_app` `true` on this User's My App alone, with the path of its window on the control origin as `address`, its tab icon for a light and for a dark appearance as image data addresses with, while the icon is generated, its one to four colours, blend and angle, its running release as `latest_release` by `release` and `sequence`, with the external origins it declares as `external_origins`, whether its code reaches this User's conversations as `conversations` and the Room slots it declares in order as `room_slots`, each `slot` with its `access` and `types`, each installation this User holds, and every User who holds the App as `holders`, this User and its owner included, by `user`, `name` and `email`. Each installation entry names the `installation`, the App's running `release` and when it was installed as `created`. Each features entry names a browser `feature` of an App this User does not own and its `consent`, `allowed` or `denied` the first time the App asked; a feature never asked is absent. `features_version` is the version of this User's latest consent change for the App, which apps/features/set answers as `features_version`.\"\n properties:\n reflected: { type: string, format: date-time }\n app: { $ref: '#/$defs/app' }\n address: { type: string, pattern: '^\\/app\\/a_([0123456789abcdefghjkmnpqrstvwxyz]+)\\.([0123456789abcdefghjkmnpqrstvwxyz])$' }\n name: { type: string }\n ownership: { enum: [ own, held ] }\n owner: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }\n my_app: { const: true }\n created: { type: string, format: date-time }\n tab_icon_light: { type: string, pattern: ^data:image\\/ }\n tab_icon_dark: { type: string, pattern: ^data:image\\/ }\n tab_icon_colours: { type: array, items: { type: string, pattern: '^#[0-9a-f]{6}$' } }\n tab_icon_blend: { enum: [ linear, radial ] }\n tab_icon_angle: { type: integer, minimum: 0, maximum: 359 }\n latest_release: { type: object, additionalProperties: false, properties: { release: { $ref: '#/$defs/id' }, sequence: { type: integer, exclusiveMinimum: 0 } }, required: [ release, sequence ] }\n external_origins: { type: array, items: { type: string, format: uri } }\n conversations: { enum: [ yes, no ] }\n room_slots: { type: array, items: { type: object, additionalProperties: false, properties: { slot: { type: string }, access: { enum: [ read, write ] }, types: { type: array, items: { type: string } } }, required: [ slot, access, types ] } }\n installations: { type: array, items: { type: object, additionalProperties: false, properties: { installation: { $ref: '#/$defs/id' }, release: { $ref: '#/$defs/id' }, created: { type: string, format: date-time } }, required: [ installation, release, created ] } }\n holders: { type: array, items: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, name: { type: string }, email: { type: string } }, required: [ user, name, email ] } }\n features: { type: array, items: { type: object, additionalProperties: false, properties: { feature: { enum: [ microphone, camera, geolocation, clipboard-read, notifications ] }, consent: { enum: [ allowed, denied ] } }, required: [ feature, consent ] } }\n features_version: { type: integer, exclusiveMinimum: 0 }\n required: [ reflected, app, address, name, ownership, created ]\nhouse-app-preferences:\n description: An App's preferences. Its own vocabulary is in the body.\n properties:\n app: { $ref: '#/$defs/app' }\n required: [ app ]\nhouse-app-room-binding:\n description: \"One durable App-Room binding this User holds: an ordered Room list, one Shared schema, or `rooms`, `all` for every Room this User has or `all_but_private` for every one but their Private Room, for a named Room slot of one `app`, shared by every device and browser installation they sign in from. Only this User's own bindings appear here. A Shared-schema binding names the `shared_schema` with its own structural `compatibility` and `findings`, the Rooms that currently use it and this User reads, and how many Rooms the instance bound leaves out. A `rooms` binding holds this User's Rooms that fit the slot, and `left_out` counts the others and those past the instance bound. Each entry names a `room` and the last structural comparison of the slot with its selected model as `compatibility`, `unchecked`, `compatible` or `incompatible`, and each finding a `room` and one exact structural `finding` of it against the slot. An explicit entry whose Room this User cannot read is absent until access returns; an empty explicit list has no document. An incompatible entry or Shared schema blocks nothing: the App still opens and the model still changes.\"\n properties:\n reflected: { type: string, format: date-time }\n app: { $ref: '#/$defs/app' }\n slot: { type: string, pattern: '^[a-z0-9]([a-z0-9-]*[a-z0-9])?$' }\n types: { type: array, items: { type: string } }\n slot_access: { enum: [ read, write ] }\n shared_schema: { type: object, additionalProperties: false, properties: { shared_schema: { $ref: '#/$defs/id' }, compatibility: { enum: [ unchecked, compatible, incompatible ] }, findings: { type: array, items: { type: string } } }, required: [ shared_schema, compatibility, findings ] }\n rooms: { enum: [ all, all_but_private ] }\n left_out: { type: integer, minimum: 0 }\n entries: { type: array, items: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' }, compatibility: { enum: [ unchecked, compatible, incompatible ] } }, required: [ room, compatibility ] } }\n findings: { type: array, items: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' }, finding: { type: string } }, required: [ room, finding ] } }\n required: [ reflected, app, slot ]\nhouse-client:\n description: One MCP client this User authorized, named as it was created. Its last use and whether its credentials expired are read on request.\n properties:\n reflected: { type: string, format: date-time }\n client: { $ref: '#/$defs/id' }\n name: { type: string }\n kind: { enum: [ browser, headless ] }\n created: { type: string, format: date-time }\n ended: { type: string, format: date-time }\n end: { enum: [ revoked ] }\n required: [ reflected, client, name, kind, created ]\nhouse-environment:\n description: \"One Environment this User holds, with its configuration, its `name`, the one its User entered, when it was `created`, the Rooms it reaches, `all`, `all_but_private` or the `selected` ones `rooms` names, each by its `room`, `login_code`, `yes` while it holds a reusable login code, the agent CLI kinds House admits in `offered`, the kinds House last set in `wanted`, and the latest readiness its Kit reported in `agents`. `kind` is the kind of Environment, `sandbox`, a small Environment House runs with limited capacity, especially disk, `vps`, an always-on Environment House runs with better specs, or `own` for its owner's own computer. `lifecycle` is the state of that Sandbox or VPS: `provisioning` while House creates it, `starting` while it starts or House wakes it, `available` once its Kit connected, `stopped` or `failed`. For a Sandbox, `budget` is its runtime budget in hours a month and `budget_spent` is `yes` once its runtime this UTC month reached it. Each offered entry names one adapter kind the owner may select for this Environment. Each wanted entry names one adapter kind the Kit should hold. Each agent entry names the adapter `kind`, its installed `version` or null when the Kit could not install it, for a CLI below its adapter's minimum that `minimum`, `failure`, that install's cause, `installing`, true only while the Kit installs it, whether the CLI is `signed_in`, its `models`, each `model` with its `efforts` as the CLI's session options name them, its `modes`, each `mode` with the `name` the CLI gives it, and `full_access`, the mode that bypasses every permission, or null for a CLI that offers no mode and always runs so. A wanted kind no entry names is not yet reported. `transcribe` is whether the Kit transcribes a message's audio files, as House last set it, and `transcription` names whether the Kit has the engine `installed` and the `failure` of its last download or null, as the Kit last reported it. `os` is the operating system and version of the Environment, `kit_release` the installed Kit release and `form` the computer's form, `laptop`, `desktop` or `server`, as the Kit last reported them. Placement failure is projected on its transitions; `failed` names the failure's category and never its cause. For a VPS, `ssh` is its owner's root login on port 22.\"\n properties:\n reflected: { type: string, format: date-time }\n environment: { $ref: '#/$defs/id' }\n name: { type: string }\n created: { type: string, format: date-time }\n revoked: { type: string, format: date-time }\n reach: { enum: [ all, all_but_private, selected ] }\n rooms: { type: array, items: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' } }, required: [ room ] } }\n login_code: { enum: [ yes, no ] }\n kind: { enum: [ sandbox, vps, own ] }\n lifecycle: { enum: [ provisioning, starting, available, stopped, failed ] }\n offered: { type: array, items: { type: string } }\n wanted: { type: array, items: { type: string } }\n agents: { type: array, items: { type: object, additionalProperties: false, properties: { kind: { type: string, minLength: 1, maxLength: 64 }, version: { anyOf: [ { type: string, minLength: 1, maxLength: 64 }, { type: 'null' } ] }, minimum: { description: \"Present only for a CLI below its adapter's minimum version: that minimum.\", type: string, minLength: 1, maxLength: 64 }, failure: { anyOf: [ { type: string, minLength: 1, maxLength: 4096 }, { type: 'null' } ] }, installing: { description: 'Present only while the Kit installs the CLI, whose version and failure are then null.', type: boolean, const: true }, signed_in: { type: boolean }, models: { maxItems: 256, type: array, items: { type: object, additionalProperties: false, properties: { model: { type: string, minLength: 1 }, efforts: { maxItems: 32, type: array, items: { type: string, minLength: 1 } } }, required: [ model, efforts ] } }, modes: { maxItems: 32, type: array, items: { type: object, additionalProperties: false, properties: { mode: { type: string, minLength: 1 }, name: { type: string, minLength: 1, maxLength: 128 } }, required: [ mode, name ] } }, full_access: { anyOf: [ { type: string, minLength: 1 }, { type: 'null' } ] } }, required: [ kind, version, failure, signed_in, models, modes, full_access ] } }\n transcribe: { enum: [ on, off ] }\n transcription: { type: object, additionalProperties: false, properties: { installed: { type: boolean }, failure: { anyOf: [ { type: string, minLength: 1, maxLength: 4096 }, { type: 'null' } ] } }, required: [ installed, failure ] }\n os: { type: string }\n kit_release: { type: string }\n form: { enum: [ laptop, desktop, server ] }\n failed: { enum: [ provisioning_failed, bootstrap_timeout, provider_capacity, provider_unavailable, provider_removed, placement_conflict, placement_intervention, environment_authority_unavailable ] }\n budget: { type: string, pattern: ^\\d+(?:\\.\\d+)?$ }\n budget_spent: { enum: [ yes, no ] }\n ssh: { type: string, pattern: ^root@\\S+$ }\n required: [ reflected, environment, name, created, reach, kind, offered, transcribe ]\nhouse-exports:\n description: This User's Exports, each with its `status`, when it was `created` and, once it has one, when it `expires`; a ready one names its download page as `page`.\n properties:\n reflected: { type: string, format: date-time }\n exports: { type: array, items: { type: object, additionalProperties: false, properties: { export: { $ref: '#/$defs/id' }, status: { enum: [ queued, running, ready, failed ] }, created: { type: string, format: date-time }, expires: { type: string, format: date-time }, page: { type: string, pattern: '^\\/exports\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' } }, required: [ export, status, created ] } }\n required: [ reflected ]\nhouse-external-account:\n description: \"One outside account this User owns, or may use through a Room it is added to, `ownership` naming which, never its key: the origin it is sent to, the `form` it is sent in, its `kind` with the header or query parameter `name` or the path `prefix`, the address of its origin's icon once House kept one, and as `connections` each App slot connected to it in a Room this User belongs to, with that Room. To its owner, `rooms` names each Room the account is added to, the Schema Roles that may use it there and whether its use there is `suspended` until its owner adds it again.\"\n properties:\n reflected: { type: string, format: date-time }\n external_account: { $ref: '#/$defs/id' }\n name: { type: string }\n origin: { type: string, format: uri }\n form: { type: object, additionalProperties: false, properties: { kind: { enum: [ bearer, header, query, basic, path ] }, name: { type: string }, prefix: { type: string } }, required: [ kind ] }\n ownership: { enum: [ own, used ] }\n icon: { type: string, pattern: '^\\/external-accounts\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/icon$' }\n rooms: { type: array, items: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' }, schema_roles: { type: array, items: { type: string } }, suspended: { type: boolean } }, required: [ room, schema_roles, suspended ] } }\n connections: { type: array, items: { type: object, additionalProperties: false, properties: { app: { $ref: '#/$defs/app' }, slot: { type: string, pattern: '^[a-z0-9]([a-z0-9-]*[a-z0-9])?$' }, room: { $ref: '#/$defs/room' } }, required: [ app, slot, room ] } }\n required: [ reflected, external_account, name, origin, form, ownership ]\nhouse-member:\n description: One User who shares a Room with this User, with their current display name and accepted about-me Markdown. Their email, the Rooms they share and each one's access are in the `roster` of each `house-room` document.\n properties:\n reflected: { type: string, format: date-time }\n user: { $ref: '#/$defs/id' }\n name: { type: string }\n about_me: { type: string }\n required: [ reflected, user, name ]\nhouse-notification:\n description: \"One kept Human Notification for this User: its kind, when it was sent as `created`, its way in, its email's subject and each fact of its value that is not sealed, named in snake_case. An entity a fact names is an object holding its identifier under the key of its kind, when the notification carries it, and its `name`, `email` and other facts beside it; a fact holding null is absent. `way_in` is either the House `path` it opens or the entity it is about, by its identifier under the key of its kind, a Trigger with its `room`. Its body is its email's words in Markdown. Both were worded once, in the User's language when it was delivered; an App may show them or word it itself from its kind and value. Read state belongs to each browser.\"\n properties:\n notification: { $ref: '#/$defs/id' }\n kind: { type: string, enum: [ share-offer, join-request, join-request-approved, app-room-binding-incompatible, app-deleted, app-call, room-ownership-offer, managed-environment-retention-opened, managed-environment-placement-intervention, storage-full, sandbox-budget-spent, break-glass-owner-disclosure, routine-start-approval-request, routine-request-declined, routine-request-started, routine-request-finished, routine-request-not-started, export-ready, export-failed, site-disabled, site-binding-incompatible, site-room-left, site-images-full, custom, trigger-did-nothing ] }\n created: { type: string, format: date-time }\n way_in: { type: object, additionalProperties: false, properties: { path: { type: string, pattern: ^\\/ }, room: { $ref: '#/$defs/room' }, app: { $ref: '#/$defs/app' }, agent: { $ref: '#/$defs/id' }, environment: { $ref: '#/$defs/id' }, routine: { $ref: '#/$defs/id' }, routine_request: { $ref: '#/$defs/id' }, trigger: { $ref: '#/$defs/id' }, site: { $ref: '#/$defs/id' } }, minProperties: 1 }\n subject: { type: string }\n share: { $ref: '#/$defs/id' }\n issuer: { type: object, additionalProperties: false, properties: { name: { type: string }, email: { type: string, format: email } }, required: [ name, email ] }\n rooms: { type: array, items: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] } }\n apps: { maxItems: 20, type: array, items: { type: object, additionalProperties: false, properties: { name: { type: string, minLength: 1, maxLength: 200 }, reaches: { type: array, items: { type: string, minLength: 1, maxLength: 512 } } }, required: [ name, reaches ] } }\n expires_at: { type: string, format: date-time }\n join_request: { $ref: '#/$defs/id' }\n user: { type: object, additionalProperties: false, properties: { name: { type: string }, email: { type: string, format: email } }, required: [ name, email ] }\n room: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' }, name: { type: string } }, minProperties: 1 }\n app: { type: object, additionalProperties: false, properties: { app: { $ref: '#/$defs/app' }, name: { type: string } }, minProperties: 1 }\n binding: { $ref: '#/$defs/id' }\n slot: { type: string }\n findings: { type: array, items: { type: string } }\n owner: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }\n caller: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ user, name ] }\n ownership_offer: { $ref: '#/$defs/id' }\n offerer: { type: object, additionalProperties: false, properties: { name: { type: string }, email: { type: string, format: email } }, required: [ name, email ] }\n environment: { type: object, additionalProperties: false, properties: { environment: { $ref: '#/$defs/id' }, name: { type: string }, kind: { enum: [ vps, sandbox ] } }, required: [ environment, name ] }\n reason: { type: string }\n deadline: { type: string, format: date-time }\n operation_kind: { type: string }\n free: { type: object, additionalProperties: false, properties: { held: { type: string, pattern: ^\\d+$ }, limit: { type: string, pattern: '^[1-9]\\d*$' }, measure: { type: string, enum: [ content, retained ] } }, required: [ held, limit, measure ] }\n budget: { type: string, pattern: ^\\d+(?:\\.\\d+)?$ }\n resets_at: { type: string, format: date-time }\n grant: { $ref: '#/$defs/id' }\n category: { type: string }\n access_started_at: { type: string, format: date-time }\n access_ended_at: { type: string, format: date-time }\n systems: { type: array, items: { type: string } }\n case_reference: { type: string }\n routine_request: { $ref: '#/$defs/id' }\n requester: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }\n agent: { type: object, additionalProperties: false, properties: { agent: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ name ] }\n conversation: { $ref: '#/$defs/id' }\n routine: { type: object, additionalProperties: false, properties: { routine: { $ref: '#/$defs/id' }, name: { type: string }, version: { type: integer, minimum: 1 } }, required: [ name ] }\n decliner: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }\n input: { type: string }\n export: { $ref: '#/$defs/id' }\n size_bytes: { type: integer, minimum: 0 }\n site: { type: object, additionalProperties: false, properties: { site: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ site, name ] }\n address: { type: string, maxLength: 300, format: uri }\n to: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }\n copies: { type: integer, minimum: 0 }\n bound: { type: integer, minimum: 0 }\n title: { type: string }\n body: { type: string }\n authorship: { type: object, additionalProperties: false, properties: { kind: { type: string, const: trigger-action }, trigger: { $ref: '#/$defs/id' }, position: { type: integer, minimum: 0 } }, required: [ kind, trigger, position ] }\n path: { type: string, maxLength: 4096, pattern: ^\\/.* }\n trigger: { type: object, additionalProperties: false, properties: { trigger: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ trigger, name ] }\n cause: { type: string }\n required: [ notification, kind, created, way_in, subject ]\nhouse-ownership-offer:\n description: One open Room ownership offer addressed to this User. The Room's name and the name of the owner it is `from` are captured when the offer is made. The page is the House approval path where this User accepts or declines.\n properties:\n reflected: { type: string, format: date-time }\n ownership_offer: { $ref: '#/$defs/id' }\n room: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' }, name: { type: string } }, required: [ room, name ] }\n from: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }\n page: { type: string, pattern: '^\\/approve\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' }\n created: { type: string, format: date-time }\n expires: { type: string, format: date-time }\n required: [ reflected, ownership_offer, room, from, page, created, expires ]\nhouse-panel-preferences:\n description: The panel's preferences at /rooms/private/settings/panel.md. Its own vocabulary is in the body.\n properties: {}\nhouse-profile:\n description: The User's display name, the email they sign in with and accepted about-me Markdown.\n properties:\n reflected: { type: string, format: date-time }\n name: { type: string }\n email: { type: string }\n about_me: { type: string }\n required: [ reflected, name, email ]\nhouse-public-room:\n description: One Public Room this User added and reads without being its member. Its members are read with `list_members`, and `leave_room` removes it.\n properties:\n reflected: { type: string, format: date-time }\n room: { $ref: '#/$defs/room' }\n handle: { type: string, minLength: 6, maxLength: 63, pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$' }\n name: { type: string }\n archived: { type: string, format: date-time }\n required: [ reflected, room, handle, name ]\nhouse-push-address:\n description: \"One push address this User minted, never its secret: the Room it captures into, the Source it names, and where an outside service's post carries its event's identifier, the header `event_header` or the JSON pointer `event_json`.\"\n properties:\n reflected: { type: string, format: date-time }\n push_address: { $ref: '#/$defs/id' }\n room: { $ref: '#/$defs/room' }\n source: { type: string }\n event_header: { type: string }\n event_json: { type: string }\n required: [ reflected, push_address, room, source ]\nhouse-requests:\n description: \"The Routine Requests of one Room this User reads by Local Read: each one waiting or started under `current` and the 50 that changed last under `history`. Each names its `routine` by `name` and `version`, the `target` User whose Agent it asks, the `agent` that took it, the `routine_access` and `record` it went through, the Users it was `approved_by` and `settled_by`, and when it was `created`, `approved`, `activated` and `settled`; a fact it does not hold is absent. Only the Agent\u2019s owner sees a request\u2019s conversation. A Room with no request has no such document.\"\n properties:\n reflected: { type: string, format: date-time }\n room: { $ref: '#/$defs/room' }\n current: { type: array, items: { $ref: '#/$defs/request' } }\n history: { type: array, items: { $ref: '#/$defs/request' } }\n required: [ reflected, room, current, history ]\nhouse-room:\n description: \"One Room this User reads, with the processing configuration that indexes it. `my_room` is `true` on this User's My Room alone, whatever its name and handle become. `admission` is `pending` while House is still settling this User into the Room, which finishes on its own and needs no act. `read` is how this User reads the Room, `mcp`, `online` or `local`, and `operations` are their own on its content. `policy` is whether House indexes the Room's documents, `Off` while it withholds indexing. Each indexing entry names a folder `path` and the `policy` set on it. `shared_schema` names the Shared schema whose copy is the Room's schema while the Room uses one, with its `name`. The owner alone sees `ownership_offer`, the `nominee` it is offered to and when it `expires`, while an offer is open, and `public`, the time they made the Room public, while every House User may read it; a member who does not own it sees its `owner` by name. `roster` lists the Room's members, each with when they were `admitted`, their member `document` and the read level and operations a Room Share could offer them without giving them anything new as `held`; it and `rights` carry the access this User may see, every member's to one who manages the Room and their own otherwise; `routines` lists the Routine Accesses this User or the Room's Triggers may call in it, each with its `routine`, by `name`, `description`, `input` and `version`, its `agent` and that Agent's `owner` by name: `starts_without_approval` on one this User may call and `triggers: true` on one the Triggers may call.\"\n properties:\n reflected: { type: string, format: date-time }\n room: { $ref: '#/$defs/room' }\n handle: { type: string, minLength: 6, maxLength: 63, pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$' }\n name: { type: string }\n my_room: { const: true }\n membership: { enum: [ owner, member ] }\n ownership_offer: { type: object, additionalProperties: false, properties: { nominee: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ user, name ] }, expires: { type: string, format: date-time } }, required: [ nominee, expires ] }\n access: { enum: [ owner, manage, edit, read ] }\n read: { enum: [ mcp, online, local ] }\n operations: { type: array, items: { type: string, enum: [ write, delete, export, manageAccess ] } }\n owner: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }\n members: { type: integer, minimum: 0 }\n triggers: { type: integer, minimum: 0 }\n published: { enum: [ yes, no ] }\n intake: { enum: [ yes, no ] }\n size: { type: number }\n admission: { enum: [ admitted, pending ] }\n created: { type: string, format: date-time }\n archived: { type: string, format: date-time }\n public: { type: string, format: date-time }\n policy: { enum: [ On, Off ] }\n indexing: { type: array, items: { type: object, additionalProperties: false, properties: { path: { type: string, minLength: 1 }, policy: { enum: [ On, Off ] } }, required: [ path, policy ] } }\n shared_schema: { type: object, additionalProperties: false, properties: { shared_schema: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ shared_schema, name ] }\n roster: { type: array, items: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, name: { type: string }, owner: { type: boolean }, email: { type: string }, admitted: { type: string, format: date-time }, access: { type: string, enum: [ owner, manage, edit, read ] }, document: { $ref: '#/$defs/document' }, schema_roles: { type: array, items: { type: string } }, held: { type: object, additionalProperties: false, properties: { read: { anyOf: [ { type: string, enum: [ mcp, online, local ] }, { type: 'null' } ] }, operations: { type: array, items: { type: string, enum: [ write, delete, export, manageAccess ] } } }, required: [ read, operations ] } }, required: [ user, name, owner, email ] } }\n rights: { type: array, items: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, name: { type: string }, entries: { type: array, items: { type: object, additionalProperties: false, properties: { namespace: { $ref: '#/$defs/namespace' }, read: { anyOf: [ { type: string, enum: [ mcp, online, local ] }, { type: 'null' } ] }, operations: { type: array, items: { type: string, enum: [ write, delete, export, manageAccess ] } }, sources: { type: array, items: { type: object, additionalProperties: false, properties: { kind: { type: string, enum: [ direct, inherited ] }, namespace: { $ref: '#/$defs/namespace' }, read: { anyOf: [ { type: string, enum: [ mcp, online, local ] }, { type: 'null' } ] }, operations: { type: array, items: { type: string, enum: [ write, delete, export, manageAccess ] } } }, required: [ kind, namespace, read, operations ] } } }, required: [ namespace, read, operations, sources ] } }, direct: { type: array, items: { type: object, additionalProperties: false, properties: { namespace: { $ref: '#/$defs/namespace' }, read: { anyOf: [ { type: string, enum: [ mcp, online, local ] }, { type: 'null' } ] }, operations: { type: array, items: { type: string, enum: [ write, delete, export, manageAccess ] } } }, required: [ namespace, read, operations ] } }, admitted: { type: string, format: date-time }, schema_roles: { type: array, items: { type: string } } }, required: [ user, name, entries, direct, schema_roles ] } }\n routines: { type: array, items: { type: object, additionalProperties: false, properties: { routine_access: { $ref: '#/$defs/id' }, agent: { $ref: '#/$defs/id' }, owner: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }, routine: { type: object, additionalProperties: false, properties: { name: { type: string }, description: { type: string }, input: { type: string }, version: { type: integer, exclusiveMinimum: 0 } }, required: [ name, description, input, version ] }, starts_without_approval: { type: boolean }, triggers: { type: boolean, const: true } }, required: [ routine_access, agent, owner, routine ] } }\n required: [ reflected, room, name, membership, access, admission, created, policy ]\nhouse-routine-access:\n description: \"One Routine Access this User granted, its `routine` by identifier and `name`, the `agent` it calls, its `room` and when it was `created`. While a scope is `selected_users`, each invokers or starters entry names one `user` by identifier with their account `email` and display `name` as of the last write of this document, or by identifier alone once that User has left the Room. An entry naming the Access's `room` admits the Room's Triggers as a caller, or lets them start without approval, whatever the scope. `allowance` is the daily request allowance every caller is under, absent when open, `0` excluding them. Each allowances entry names a caller under a value of their own instead: the `user` or the `room` and their `allowance`, or the caller alone when they have none. While `follow_up_scope` is `selected_users`, each follow_ups entry names one User who may send follow-up mail to the conversations their requests started, as invokers entries name them; `all_admitted` lets every User caller send it, and the Agent's owner always may. `mail_allowance` is the daily follow-up mail allowance every User caller is under, and each mail_allowances entry names a `user` under an `allowance` of their own. `last_failure` is the latest withdrawn request, whatever starts after it: its `origin`, `user` or `trigger`, its time `at` and its `reason`.\"\n properties:\n reflected: { type: string, format: date-time }\n routine_access: { $ref: '#/$defs/id' }\n routine: { type: object, additionalProperties: false, properties: { routine: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ routine, name ] }\n agent: { $ref: '#/$defs/id' }\n room: { $ref: '#/$defs/room' }\n invoker_scope: { type: string, enum: [ all_members, selected_users ] }\n start_scope: { type: string, enum: [ none, all_admitted, selected_users ] }\n follow_up_scope: { type: string, enum: [ none, all_admitted, selected_users ] }\n created: { type: string, format: date-time }\n revoked: { type: string, format: date-time }\n invokers: { type: array, items: { $ref: '#/$defs/caller' } }\n starters: { type: array, items: { $ref: '#/$defs/caller' } }\n follow_ups: { type: array, items: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, email: { type: string }, name: { type: string } }, required: [ user ] } }\n allowance: { type: integer, minimum: 0 }\n allowances: { type: array, items: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, room: { $ref: '#/$defs/room' }, allowance: { type: integer, minimum: 0 } }, minProperties: 1 } }\n mail_allowance: { type: integer, minimum: 0 }\n mail_allowances: { type: array, items: { type: object, additionalProperties: false, properties: { user: { $ref: '#/$defs/id' }, allowance: { type: integer, minimum: 0 } }, required: [ user, allowance ] } }\n last_failure: { type: object, additionalProperties: false, properties: { origin: { enum: [ user, trigger ] }, at: { type: string, format: date-time }, reason: { type: string } }, required: [ origin, at, reason ] }\n required: [ reflected, routine_access, routine, agent, room, invoker_scope, start_scope, follow_up_scope, created ]\nhouse-share:\n description: \"One Share this User issued, kept until it expires or is cancelled. An email delivery carries `share_to`, the address this User entered; a link delivery never carries the link. Each item names its `kind`, `room` or `app`, the Room or App under that key with its `name`, its `state`, `offerable`, `held`, `accepted`, `declined` or `superseded`, for a Room item the `read` level it grants, the `operations` it grants as this User chose them and the Schema Roles its member gets as `roles` when it names any, and for an App item the external `origins` its latest release declared when this document was written, when it declared any. An App item is never shown `held`. Each pack entry names an App item's `app`, one of its `slot`s, and the `room` of the Room item that fills it, with that Room's `name`. Each `join_requests` entry of a link delivery names one Join request, its `state`, `waiting`, `approved` or `declined`, and the User it is `from` by account `email` and display `name` as House held them when this document was written, oldest first; the House approval path of a Join request is `/approve/` followed by its identifier.\"\n properties:\n reflected: { type: string, format: date-time }\n share: { $ref: '#/$defs/id' }\n share_link: { enum: [ yes, no ] }\n share_to: { type: string, format: email }\n items: { type: array, items: { type: object, additionalProperties: false, properties: { kind: { enum: [ room, app ] }, name: { type: string }, state: { enum: [ offerable, held, accepted, declined, superseded ] }, read: { enum: [ mcp, online, local ] }, operations: { type: array, items: { type: string, enum: [ write, delete, export, manageAccess ] } }, roles: { type: array, items: { type: string } }, origins: { type: array, items: { type: string, format: uri } }, room: { $ref: '#/$defs/room' }, app: { $ref: '#/$defs/app' } }, required: [ kind, name, state, operations ] } }\n pack: { type: array, items: { type: object, additionalProperties: false, properties: { app: { $ref: '#/$defs/app' }, slot: { type: string, pattern: '^[a-z0-9]([a-z0-9-]*[a-z0-9])?$' }, room: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' }, name: { type: string } }, required: [ room, name ] } }, required: [ app, slot, room ] } }\n join_requests: { type: array, items: { type: object, additionalProperties: false, properties: { join_request: { $ref: '#/$defs/id' }, state: { enum: [ waiting, approved, declined ] }, from: { type: object, additionalProperties: false, properties: { email: { type: string }, name: { type: string } }, required: [ email, name ] } }, required: [ join_request, state, from ] } }\n created: { type: string, format: date-time }\n expires: { type: string, format: date-time }\n required: [ reflected, share, share_link, created, expires ]\nhouse-share-offer:\n description: \"One live Share offered to this User by email while an item of it is still offered, `from` its issuer by display `name` and account `email`. Each item names its `kind`, `room` or `app`, its `name`, its `state` for this User, `offerable`, `held`, `accepted`, `declined` or `superseded`, for a Room item the `read` level it grants and the `operations` it grants; it carries no reference. A Room item's read level and operations are the ones its issuer chose for the Room's content; its holder reads the Room's settings at that level, and holds `manageAccess` over its document model when it names `manageAccess`. A Room item naming Schema Roles names them as `roles`, which accepting the Share adds to this User's own in that Room. An App item grants use of the App and never its source, is never shown `held`, and names as `origins` the external origins its latest release declared when this document was written, when it declared any, which accepting the Share lets its code reach. Each pack entry names an offered `app`, one of its `slot`s, and the offered `room` that fills it, each by `name`. Names are as House held them when this document was written. The page is the House approval path where this User accepts or declines the whole Share.\"\n properties:\n reflected: { type: string, format: date-time }\n share: { $ref: '#/$defs/id' }\n from: { type: object, additionalProperties: false, properties: { name: { type: string }, email: { type: string, format: email } }, required: [ name, email ] }\n page: { type: string, pattern: '^\\/approve\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' }\n items: { type: array, items: { type: object, additionalProperties: false, properties: { kind: { enum: [ room, app ] }, name: { type: string }, state: { enum: [ offerable, held, accepted, declined, superseded ] }, read: { enum: [ mcp, online, local ] }, operations: { type: array, items: { type: string, enum: [ write, delete, export, manageAccess ] } }, roles: { type: array, items: { type: string } }, origins: { type: array, items: { type: string, format: uri } } }, required: [ kind, name, state, operations ] } }\n pack: { type: array, items: { type: object, additionalProperties: false, properties: { app: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] }, slot: { type: string, pattern: '^[a-z0-9]([a-z0-9-]*[a-z0-9])?$' }, room: { type: object, additionalProperties: false, properties: { name: { type: string } }, required: [ name ] } }, required: [ app, slot, room ] } }\n created: { type: string, format: date-time }\n expires: { type: string, format: date-time }\n required: [ reflected, share, from, page, created, expires ]\nhouse-site:\n description: \"One Site this User owns: its `name`, its address under this environment's Site suffix, its own `app` with that App's tab icon as a Site shows it, the running `release` of that App, which the Site serves, by `release` and `sequence`, its title and `intake_room`, the Intake Room by its `room`, whether an operator disabled it, its mode, and every Room slot of that release in its order. Each slot names its `slot` and as `entries` each Room its list holds, in list order, by its `room`, with that entry's address `segment` and the last `compatibility` outcome of that entry; a slot that lists no Room has no entry. Each finding names its `slot`, its `room` and one exact structural `finding` of that Room against the slot. An incompatible entry stays listed and blocks nothing. `release` is absent until that App's first release. `disabled` is `yes` while an operator holds the Site disabled, and `disabled_reason` carries the reason the operator stated; visitors then find the Site unavailable, this User may still change or delete it, and only an operator enables it again. `mode` is `snapshot` while visitors see the Published Snapshot `publication` names, or `live` while they see what its Rooms hold as it changes, which needs Full House; only this User changes it. `unpublished` is `yes` while this User holds the Site unpublished: visitors then find it unavailable at every address and nothing else changes, and only this User's republication serves it again; an operator's enable never does. `suspended` is `yes` while visitors find the Site unavailable at every address for the reason `suspended_reason` names: `full_house_required` while the Site is `live` and this User lacks Full House, or `public_delivery_limit` while what House's server sent for this User's Sites this UTC month has reached this User's Public delivery limit, unless `public_overage` is `on` while this User holds Full House. A suspension keeps the publication, the addresses, the Custom domains and every act of this User's, and ends by itself at the next UTC month, when this User gains Full House or when `public_overage` turns `on` while this User holds Full House; it lifts no Unpublish and no operator's disable. `public_overage` is `on` while this User keeps the Site serving past the Public delivery limit, which it does only while this User holds Full House; what it sends past the limit is charged as overage. It stays `on` when Full House ends and acts again when Full House returns. `publication` is the Published Snapshot the Site serves, or serves once republished, absent while it holds none. `acts` names the publication acts this User may take now: `unpublish` while the Site is published, `republish` while it is unpublished and holds a publication to serve; Publish data also serves an unpublished Site again, with what its Rooms hold. A cleared title is absent. `description` carries presentation. `screenshot` is the address of the image House captured of the Site at its primary address after a release, which a shared link to the Site shows, absent before the first capture. `analytics` is the owner's measurement ID the Site loads its analytics tag with, absent while unset. `indexing` is the search-engines-and-agents switch: while it is `yes`, the Site serves its documents as Markdown and lists them in its indexes. `entry_fallback` names the last time this release's Entry Data Contract could not serve an Entry Page as HTML: its `cause` (`over_bound`, `query_refused` or `unavailable`), the `route` and when it was `recorded`; that page then started the App as usual. `external_origins` names the declared external origins of that release. `notify_me` is `on` while the Site's notification Trigger is present and enabled in its Intake Room. `addresses` lists every address the Site answers at: its address under the Site suffix and each active Custom domain; every address other than `primary_address` redirects to it. Each `domains` entry names one Custom domain's `host`, its `state`, `pending`, `active` or `failed`, the DNS alias target its hostname must point at as `dns_target`, which is this environment's and the same for every domain, and the edge's `reason` when it gives one.\"\n properties:\n reflected: { type: string, format: date-time }\n site: { $ref: '#/$defs/id' }\n name: { type: string }\n address: { type: string, format: uri }\n addresses: { type: array, items: { type: string, format: uri } }\n primary_address: { type: string, format: uri }\n domains: { type: array, items: { type: object, additionalProperties: false, properties: { host: { type: string }, state: { enum: [ pending, active, failed ] }, dns_target: { type: string }, reason: { type: string } }, required: [ host, state, dns_target ] } }\n app: { $ref: '#/$defs/app' }\n tab_icon_light: { type: string, pattern: ^data:image\\/ }\n tab_icon_dark: { type: string, pattern: ^data:image\\/ }\n tab_icon_colours: { type: array, items: { type: string, pattern: '^#[0-9a-f]{6}$' } }\n tab_icon_blend: { enum: [ linear, radial ] }\n tab_icon_angle: { type: integer, minimum: 0, maximum: 359 }\n release: { type: object, additionalProperties: false, properties: { release: { $ref: '#/$defs/id' }, sequence: { type: integer, exclusiveMinimum: 0 } }, required: [ release, sequence ] }\n title: { type: string }\n description: { type: string }\n screenshot: { type: string, format: uri }\n analytics: { type: string, pattern: '^G-[A-Z0-9]{1,32}$' }\n intake_room: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' } }, required: [ room ] }\n external_origins: { type: array, items: { type: string, format: uri } }\n disabled: { enum: [ yes, no ] }\n disabled_reason: { type: string }\n mode: { enum: [ snapshot, live ] }\n unpublished: { enum: [ yes, no ] }\n suspended: { enum: [ yes, no ] }\n suspended_reason: { type: string, enum: [ full_house_required, public_delivery_limit ] }\n public_overage: { enum: [ on, off ] }\n publication: { $ref: '#/$defs/id' }\n acts: { type: array, items: { type: string, enum: [ unpublish, republish ] } }\n indexing: { enum: [ yes, no ] }\n entry_fallback: { type: object, additionalProperties: false, properties: { cause: { enum: [ over_bound, query_refused, unavailable ] }, route: { type: string }, recorded: { type: string, format: date-time } }, required: [ cause, route, recorded ] }\n created: { type: string, format: date-time }\n new_browsers: { type: integer, minimum: 0 }\n submissions: { type: integer, minimum: 0 }\n notify_me: { enum: [ on, off ] }\n image_copies: { type: integer, minimum: 0 }\n image_copy_bound: { type: integer, minimum: 0 }\n image_copy_limit_reached: { enum: [ yes, no ] }\n slots: { type: array, items: { type: object, additionalProperties: false, properties: { slot: { type: string, pattern: '^[a-z0-9]([a-z0-9-]*[a-z0-9])?$' }, entries: { type: array, items: { type: object, additionalProperties: false, properties: { room: { $ref: '#/$defs/room' }, segment: { type: string }, compatibility: { enum: [ unchecked, compatible, incompatible ] } }, required: [ room, segment, compatibility ] } } }, required: [ slot, entries ] } }\n findings: { type: array, items: { type: object, additionalProperties: false, properties: { slot: { type: string, pattern: '^[a-z0-9]([a-z0-9-]*[a-z0-9])?$' }, room: { $ref: '#/$defs/room' }, finding: { type: string } }, required: [ slot, room, finding ] } }\n required: [ reflected, site, name, address, primary_address, app, disabled, mode, unpublished, suspended, public_overage, indexing, created, new_browsers, submissions, notify_me, image_copies, image_copy_bound, image_copy_limit_reached ]\nhouse-web-wizard:\n description: \"One Web Wizard an agent made for this User: the `environment` it runs on, with that Environment's `name`, and its `state`, `waiting` until its owner presses Run, `running`, `finished` with the script's `exit_code`, `failed`, `cancelled` when its page closed before the script ended, or `lapsed` when nobody ran it in its time. Its body is the script, whole, in one fenced code block. The terminal's output is never kept.\"\n properties:\n reflected: { type: string, format: date-time }\n web_wizard: { $ref: '#/$defs/id' }\n environment: { type: object, additionalProperties: false, properties: { environment: { $ref: '#/$defs/id' }, name: { type: string } }, required: [ environment, name ] }\n state: { enum: [ waiting, running, finished, failed, cancelled, lapsed ] }\n exit_code: { type: integer }\n required: [ reflected, web_wizard, environment, state ]\n";
|
|
1
|
+
import type { TypedPath } from '@agentshouse/mdruntime';
|
|
2
|
+
export declare const HOUSE_MODEL_DECLARATION: {
|
|
3
|
+
readonly $defs: {
|
|
4
|
+
readonly room: {
|
|
5
|
+
readonly description: 'A Room, by its Room reference, under the key `room`.';
|
|
6
|
+
readonly type: 'string';
|
|
7
|
+
readonly pattern: '^r_([0123456789abcdefghjkmnpqrstvwxyz]+)\\.([0123456789abcdefghjkmnpqrstvwxyz])$';
|
|
8
|
+
};
|
|
9
|
+
readonly app: {
|
|
10
|
+
readonly description: 'An App, by its App reference, under the key `app`.';
|
|
11
|
+
readonly type: 'string';
|
|
12
|
+
readonly pattern: '^a_([0123456789abcdefghjkmnpqrstvwxyz]+)\\.([0123456789abcdefghjkmnpqrstvwxyz])$';
|
|
13
|
+
};
|
|
14
|
+
readonly document: {
|
|
15
|
+
readonly description: 'A document of a Room, by its file reference, under the key `document`.';
|
|
16
|
+
readonly type: 'string';
|
|
17
|
+
readonly pattern: '^af_([123456789abcdefghjkmnpqrstvwxyz][0123456789abcdefghjkmnpqrstvwxyz]*)\\.([0123456789abcdefghjkmnpqrstvwxyz])$';
|
|
18
|
+
};
|
|
19
|
+
readonly id: {
|
|
20
|
+
readonly description: 'Any other entity, by its identifier, under the key of its kind. An entity a type says more about is an object holding it under that key beside its facts.';
|
|
21
|
+
readonly type: 'string';
|
|
22
|
+
readonly format: 'uuid';
|
|
23
|
+
};
|
|
24
|
+
readonly namespace: {
|
|
25
|
+
readonly description: 'The Namespace a grant entry covers, an App or a Room by its reference with the area of it.';
|
|
26
|
+
readonly type: 'string';
|
|
27
|
+
readonly maxLength: 512;
|
|
28
|
+
readonly pattern: '^(?:a_[A-Za-z0-9._-]+(?:\\/source)?|r_[A-Za-z0-9._-]+(?:\\/(?:settings|settings\\/schema|settings\\/model|settings\\/indexing|content))?)$';
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
readonly 'house-app-preferences': {
|
|
32
|
+
readonly description: "An App's preferences. Its own vocabulary is in the body.";
|
|
33
|
+
readonly properties: {
|
|
34
|
+
readonly app: {
|
|
35
|
+
readonly $ref: '#/$defs/app';
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
|
+
readonly required: readonly ['app'];
|
|
39
|
+
};
|
|
40
|
+
readonly 'house-notification': {
|
|
41
|
+
readonly description: "One kept Human Notification for this User: its kind, when it was sent as `created`, its way in, its email's subject and each fact of its value that is not sealed, named in snake_case. An entity a fact names is an object holding its identifier under the key of its kind, when the notification carries it, and its `name`, `email` and other facts beside it; a fact holding null is absent. `way_in` is either the House `path` it opens or the entity it is about, by its identifier under the key of its kind, a Trigger with its `room`. Its body is its email's words in Markdown. Both were worded once, in the User's language when it was delivered; an App may show them or word it itself from its kind and value. Read state belongs to each browser.";
|
|
42
|
+
readonly properties: {
|
|
43
|
+
readonly notification: {
|
|
44
|
+
readonly $ref: '#/$defs/id';
|
|
45
|
+
};
|
|
46
|
+
readonly kind: {
|
|
47
|
+
readonly type: 'string';
|
|
48
|
+
readonly enum: readonly ['share-offer', 'join-request', 'join-request-approved', 'app-room-binding-incompatible', 'app-call', 'room-ownership-offer', 'managed-environment-retention-opened', 'managed-environment-placement-intervention', 'storage-full', 'sandbox-budget-spent', 'break-glass-owner-disclosure', 'agent-function-start-approval-request', 'export-ready', 'export-failed', 'site-disabled', 'site-binding-incompatible', 'site-images-full', 'custom'];
|
|
49
|
+
};
|
|
50
|
+
readonly created: {
|
|
51
|
+
readonly type: 'string';
|
|
52
|
+
readonly format: 'date-time';
|
|
53
|
+
};
|
|
54
|
+
readonly way_in: {
|
|
55
|
+
readonly type: 'object';
|
|
56
|
+
readonly additionalProperties: false;
|
|
57
|
+
readonly properties: {
|
|
58
|
+
readonly path: {
|
|
59
|
+
readonly type: 'string';
|
|
60
|
+
readonly pattern: '^\\/';
|
|
61
|
+
};
|
|
62
|
+
readonly room: {
|
|
63
|
+
readonly $ref: '#/$defs/room';
|
|
64
|
+
};
|
|
65
|
+
readonly app: {
|
|
66
|
+
readonly $ref: '#/$defs/app';
|
|
67
|
+
};
|
|
68
|
+
readonly environment: {
|
|
69
|
+
readonly $ref: '#/$defs/id';
|
|
70
|
+
};
|
|
71
|
+
readonly trigger: {
|
|
72
|
+
readonly $ref: '#/$defs/id';
|
|
73
|
+
};
|
|
74
|
+
readonly site: {
|
|
75
|
+
readonly $ref: '#/$defs/id';
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
readonly minProperties: 1;
|
|
79
|
+
};
|
|
80
|
+
readonly subject: {
|
|
81
|
+
readonly type: 'string';
|
|
82
|
+
};
|
|
83
|
+
readonly share: {
|
|
84
|
+
readonly $ref: '#/$defs/id';
|
|
85
|
+
};
|
|
86
|
+
readonly issuer: {
|
|
87
|
+
readonly type: 'object';
|
|
88
|
+
readonly additionalProperties: false;
|
|
89
|
+
readonly properties: {
|
|
90
|
+
readonly name: {
|
|
91
|
+
readonly type: 'string';
|
|
92
|
+
};
|
|
93
|
+
readonly email: {
|
|
94
|
+
readonly type: 'string';
|
|
95
|
+
readonly format: 'email';
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
readonly required: readonly ['name', 'email'];
|
|
99
|
+
};
|
|
100
|
+
readonly rooms: {
|
|
101
|
+
readonly type: 'array';
|
|
102
|
+
readonly items: {
|
|
103
|
+
readonly type: 'object';
|
|
104
|
+
readonly additionalProperties: false;
|
|
105
|
+
readonly properties: {
|
|
106
|
+
readonly name: {
|
|
107
|
+
readonly type: 'string';
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
readonly required: readonly ['name'];
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
readonly apps: {
|
|
114
|
+
readonly maxItems: 20;
|
|
115
|
+
readonly type: 'array';
|
|
116
|
+
readonly items: {
|
|
117
|
+
readonly type: 'object';
|
|
118
|
+
readonly additionalProperties: false;
|
|
119
|
+
readonly properties: {
|
|
120
|
+
readonly name: {
|
|
121
|
+
readonly type: 'string';
|
|
122
|
+
readonly minLength: 1;
|
|
123
|
+
readonly maxLength: 200;
|
|
124
|
+
};
|
|
125
|
+
readonly reaches: {
|
|
126
|
+
readonly type: 'array';
|
|
127
|
+
readonly items: {
|
|
128
|
+
readonly type: 'string';
|
|
129
|
+
readonly minLength: 1;
|
|
130
|
+
readonly maxLength: 512;
|
|
131
|
+
};
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
readonly required: readonly ['name', 'reaches'];
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
readonly expires_at: {
|
|
138
|
+
readonly type: 'string';
|
|
139
|
+
readonly format: 'date-time';
|
|
140
|
+
};
|
|
141
|
+
readonly join_request: {
|
|
142
|
+
readonly $ref: '#/$defs/id';
|
|
143
|
+
};
|
|
144
|
+
readonly user: {
|
|
145
|
+
readonly type: 'object';
|
|
146
|
+
readonly additionalProperties: false;
|
|
147
|
+
readonly properties: {
|
|
148
|
+
readonly name: {
|
|
149
|
+
readonly type: 'string';
|
|
150
|
+
};
|
|
151
|
+
readonly email: {
|
|
152
|
+
readonly type: 'string';
|
|
153
|
+
readonly format: 'email';
|
|
154
|
+
};
|
|
155
|
+
};
|
|
156
|
+
readonly required: readonly ['name', 'email'];
|
|
157
|
+
};
|
|
158
|
+
readonly room: {
|
|
159
|
+
readonly type: 'object';
|
|
160
|
+
readonly additionalProperties: false;
|
|
161
|
+
readonly properties: {
|
|
162
|
+
readonly room: {
|
|
163
|
+
readonly $ref: '#/$defs/room';
|
|
164
|
+
};
|
|
165
|
+
readonly name: {
|
|
166
|
+
readonly type: 'string';
|
|
167
|
+
};
|
|
168
|
+
};
|
|
169
|
+
readonly minProperties: 1;
|
|
170
|
+
};
|
|
171
|
+
readonly app: {
|
|
172
|
+
readonly type: 'object';
|
|
173
|
+
readonly additionalProperties: false;
|
|
174
|
+
readonly properties: {
|
|
175
|
+
readonly app: {
|
|
176
|
+
readonly $ref: '#/$defs/app';
|
|
177
|
+
};
|
|
178
|
+
readonly name: {
|
|
179
|
+
readonly type: 'string';
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
readonly minProperties: 1;
|
|
183
|
+
};
|
|
184
|
+
readonly release: {
|
|
185
|
+
readonly type: 'integer';
|
|
186
|
+
readonly minimum: 1;
|
|
187
|
+
};
|
|
188
|
+
readonly binding: {
|
|
189
|
+
readonly $ref: '#/$defs/id';
|
|
190
|
+
};
|
|
191
|
+
readonly slot: {
|
|
192
|
+
readonly type: 'string';
|
|
193
|
+
};
|
|
194
|
+
readonly findings: {
|
|
195
|
+
readonly type: 'array';
|
|
196
|
+
readonly items: {
|
|
197
|
+
readonly type: 'string';
|
|
198
|
+
};
|
|
199
|
+
};
|
|
200
|
+
readonly caller: {
|
|
201
|
+
readonly type: 'object';
|
|
202
|
+
readonly additionalProperties: false;
|
|
203
|
+
readonly properties: {
|
|
204
|
+
readonly user: {
|
|
205
|
+
readonly $ref: '#/$defs/id';
|
|
206
|
+
};
|
|
207
|
+
readonly name: {
|
|
208
|
+
readonly type: 'string';
|
|
209
|
+
};
|
|
210
|
+
};
|
|
211
|
+
readonly required: readonly ['user', 'name'];
|
|
212
|
+
};
|
|
213
|
+
readonly ownership_offer: {
|
|
214
|
+
readonly $ref: '#/$defs/id';
|
|
215
|
+
};
|
|
216
|
+
readonly offerer: {
|
|
217
|
+
readonly type: 'object';
|
|
218
|
+
readonly additionalProperties: false;
|
|
219
|
+
readonly properties: {
|
|
220
|
+
readonly name: {
|
|
221
|
+
readonly type: 'string';
|
|
222
|
+
};
|
|
223
|
+
readonly email: {
|
|
224
|
+
readonly type: 'string';
|
|
225
|
+
readonly format: 'email';
|
|
226
|
+
};
|
|
227
|
+
};
|
|
228
|
+
readonly required: readonly ['name', 'email'];
|
|
229
|
+
};
|
|
230
|
+
readonly environment: {
|
|
231
|
+
readonly type: 'object';
|
|
232
|
+
readonly additionalProperties: false;
|
|
233
|
+
readonly properties: {
|
|
234
|
+
readonly environment: {
|
|
235
|
+
readonly $ref: '#/$defs/id';
|
|
236
|
+
};
|
|
237
|
+
readonly name: {
|
|
238
|
+
readonly type: 'string';
|
|
239
|
+
};
|
|
240
|
+
readonly kind: {
|
|
241
|
+
readonly enum: readonly ['vps', 'sandbox'];
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
readonly required: readonly ['environment', 'name'];
|
|
245
|
+
};
|
|
246
|
+
readonly reason: {
|
|
247
|
+
readonly type: 'string';
|
|
248
|
+
};
|
|
249
|
+
readonly deadline: {
|
|
250
|
+
readonly type: 'string';
|
|
251
|
+
readonly format: 'date-time';
|
|
252
|
+
};
|
|
253
|
+
readonly operation_kind: {
|
|
254
|
+
readonly type: 'string';
|
|
255
|
+
};
|
|
256
|
+
readonly free: {
|
|
257
|
+
readonly type: 'object';
|
|
258
|
+
readonly additionalProperties: false;
|
|
259
|
+
readonly properties: {
|
|
260
|
+
readonly held: {
|
|
261
|
+
readonly type: 'string';
|
|
262
|
+
readonly pattern: '^\\d+$';
|
|
263
|
+
};
|
|
264
|
+
readonly limit: {
|
|
265
|
+
readonly type: 'string';
|
|
266
|
+
readonly pattern: '^[1-9]\\d*$';
|
|
267
|
+
};
|
|
268
|
+
readonly measure: {
|
|
269
|
+
readonly type: 'string';
|
|
270
|
+
readonly enum: readonly ['content', 'retained'];
|
|
271
|
+
};
|
|
272
|
+
};
|
|
273
|
+
readonly required: readonly ['held', 'limit', 'measure'];
|
|
274
|
+
};
|
|
275
|
+
readonly budget: {
|
|
276
|
+
readonly type: 'string';
|
|
277
|
+
readonly pattern: '^\\d+(?:\\.\\d+)?$';
|
|
278
|
+
};
|
|
279
|
+
readonly resets_at: {
|
|
280
|
+
readonly type: 'string';
|
|
281
|
+
readonly format: 'date-time';
|
|
282
|
+
};
|
|
283
|
+
readonly grant: {
|
|
284
|
+
readonly $ref: '#/$defs/id';
|
|
285
|
+
};
|
|
286
|
+
readonly category: {
|
|
287
|
+
readonly type: 'string';
|
|
288
|
+
};
|
|
289
|
+
readonly access_started_at: {
|
|
290
|
+
readonly type: 'string';
|
|
291
|
+
readonly format: 'date-time';
|
|
292
|
+
};
|
|
293
|
+
readonly access_ended_at: {
|
|
294
|
+
readonly type: 'string';
|
|
295
|
+
readonly format: 'date-time';
|
|
296
|
+
};
|
|
297
|
+
readonly systems: {
|
|
298
|
+
readonly type: 'array';
|
|
299
|
+
readonly items: {
|
|
300
|
+
readonly type: 'string';
|
|
301
|
+
};
|
|
302
|
+
};
|
|
303
|
+
readonly case_reference: {
|
|
304
|
+
readonly type: 'string';
|
|
305
|
+
};
|
|
306
|
+
readonly agent_function_request: {
|
|
307
|
+
readonly $ref: '#/$defs/id';
|
|
308
|
+
};
|
|
309
|
+
readonly requester: {
|
|
310
|
+
readonly type: 'object';
|
|
311
|
+
readonly additionalProperties: false;
|
|
312
|
+
readonly properties: {
|
|
313
|
+
readonly name: {
|
|
314
|
+
readonly type: 'string';
|
|
315
|
+
};
|
|
316
|
+
};
|
|
317
|
+
readonly required: readonly ['name'];
|
|
318
|
+
};
|
|
319
|
+
readonly agent: {
|
|
320
|
+
readonly type: 'object';
|
|
321
|
+
readonly additionalProperties: false;
|
|
322
|
+
readonly properties: {
|
|
323
|
+
readonly agent: {
|
|
324
|
+
readonly $ref: '#/$defs/id';
|
|
325
|
+
};
|
|
326
|
+
readonly name: {
|
|
327
|
+
readonly type: 'string';
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
readonly required: readonly ['name'];
|
|
331
|
+
};
|
|
332
|
+
readonly conversation: {
|
|
333
|
+
readonly $ref: '#/$defs/id';
|
|
334
|
+
};
|
|
335
|
+
readonly agent_function: {
|
|
336
|
+
readonly type: 'object';
|
|
337
|
+
readonly additionalProperties: false;
|
|
338
|
+
readonly properties: {
|
|
339
|
+
readonly name: {
|
|
340
|
+
readonly type: 'string';
|
|
341
|
+
};
|
|
342
|
+
readonly version: {
|
|
343
|
+
readonly type: 'integer';
|
|
344
|
+
readonly minimum: 1;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
readonly required: readonly ['name'];
|
|
348
|
+
};
|
|
349
|
+
readonly export: {
|
|
350
|
+
readonly $ref: '#/$defs/id';
|
|
351
|
+
};
|
|
352
|
+
readonly size_bytes: {
|
|
353
|
+
readonly type: 'integer';
|
|
354
|
+
readonly minimum: 0;
|
|
355
|
+
};
|
|
356
|
+
readonly site: {
|
|
357
|
+
readonly type: 'object';
|
|
358
|
+
readonly additionalProperties: false;
|
|
359
|
+
readonly properties: {
|
|
360
|
+
readonly site: {
|
|
361
|
+
readonly $ref: '#/$defs/id';
|
|
362
|
+
};
|
|
363
|
+
readonly name: {
|
|
364
|
+
readonly type: 'string';
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
readonly required: readonly ['site', 'name'];
|
|
368
|
+
};
|
|
369
|
+
readonly address: {
|
|
370
|
+
readonly type: 'string';
|
|
371
|
+
readonly maxLength: 300;
|
|
372
|
+
readonly format: 'uri';
|
|
373
|
+
};
|
|
374
|
+
readonly copies: {
|
|
375
|
+
readonly type: 'integer';
|
|
376
|
+
readonly minimum: 0;
|
|
377
|
+
};
|
|
378
|
+
readonly bound: {
|
|
379
|
+
readonly type: 'integer';
|
|
380
|
+
readonly minimum: 0;
|
|
381
|
+
};
|
|
382
|
+
readonly title: {
|
|
383
|
+
readonly type: 'string';
|
|
384
|
+
};
|
|
385
|
+
readonly body: {
|
|
386
|
+
readonly type: 'string';
|
|
387
|
+
};
|
|
388
|
+
readonly authorship: {
|
|
389
|
+
readonly type: 'object';
|
|
390
|
+
readonly additionalProperties: false;
|
|
391
|
+
readonly properties: {
|
|
392
|
+
readonly kind: {
|
|
393
|
+
readonly type: 'string';
|
|
394
|
+
readonly const: 'trigger-action';
|
|
395
|
+
};
|
|
396
|
+
readonly trigger: {
|
|
397
|
+
readonly $ref: '#/$defs/id';
|
|
398
|
+
};
|
|
399
|
+
readonly position: {
|
|
400
|
+
readonly type: 'integer';
|
|
401
|
+
readonly minimum: 0;
|
|
402
|
+
};
|
|
403
|
+
};
|
|
404
|
+
readonly required: readonly ['kind', 'trigger', 'position'];
|
|
405
|
+
};
|
|
406
|
+
readonly path: {
|
|
407
|
+
readonly type: 'string';
|
|
408
|
+
readonly maxLength: 4096;
|
|
409
|
+
readonly pattern: '^\\/.*';
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
readonly required: readonly ['notification', 'kind', 'created', 'way_in', 'subject'];
|
|
413
|
+
};
|
|
414
|
+
readonly 'house-panel-preferences': {
|
|
415
|
+
readonly description: "The panel's preferences at /rooms/private/settings/panel.md. Its own vocabulary is in the body.";
|
|
416
|
+
readonly properties: {};
|
|
417
|
+
};
|
|
418
|
+
readonly 'house-agent-function': {
|
|
419
|
+
readonly description: "One Agent function that serves this Room, which House alone writes from its owner's document in their Private Room: the `agent_function` by identifier, its `description`, the `input` a caller sends, empty when it takes nothing, and the `agent` it starts, by `agent` and the `name` that Agent had when this card was last written. The Agent function's instruction is never written here.";
|
|
420
|
+
readonly properties: {
|
|
421
|
+
readonly reflected: {
|
|
422
|
+
readonly type: 'string';
|
|
423
|
+
readonly format: 'date-time';
|
|
424
|
+
};
|
|
425
|
+
readonly agent_function: {
|
|
426
|
+
readonly $ref: '#/$defs/id';
|
|
427
|
+
};
|
|
428
|
+
readonly description: {
|
|
429
|
+
readonly type: 'string';
|
|
430
|
+
};
|
|
431
|
+
readonly input: {
|
|
432
|
+
readonly type: 'string';
|
|
433
|
+
};
|
|
434
|
+
readonly agent: {
|
|
435
|
+
readonly type: 'object';
|
|
436
|
+
readonly additionalProperties: false;
|
|
437
|
+
readonly properties: {
|
|
438
|
+
readonly agent: {
|
|
439
|
+
readonly $ref: '#/$defs/id';
|
|
440
|
+
};
|
|
441
|
+
readonly name: {
|
|
442
|
+
readonly type: 'string';
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
readonly required: readonly ['agent', 'name'];
|
|
446
|
+
};
|
|
447
|
+
};
|
|
448
|
+
readonly required: readonly ['reflected', 'agent_function', 'description', 'input', 'agent'];
|
|
449
|
+
};
|
|
450
|
+
readonly 'house-agent-function-document': {
|
|
451
|
+
readonly description: 'One Agent function as its owner writes it in their Private Room at rooms/<room-handle>/agent-functions/<name>.md, a path that binds this type and a document that names no type: what it does as `description`, what a caller sends as `input`, empty when it takes nothing, and the `agent` it starts, by identifier. Its body is the instruction that Agent follows.';
|
|
452
|
+
readonly properties: {
|
|
453
|
+
readonly description: {
|
|
454
|
+
readonly type: 'string';
|
|
455
|
+
readonly maxLength: 2000;
|
|
456
|
+
readonly pattern: '\\S';
|
|
457
|
+
};
|
|
458
|
+
readonly input: {
|
|
459
|
+
readonly type: 'string';
|
|
460
|
+
};
|
|
461
|
+
readonly agent: {
|
|
462
|
+
readonly $ref: '#/$defs/id';
|
|
463
|
+
};
|
|
464
|
+
};
|
|
465
|
+
readonly required: readonly ['description', 'input', 'agent'];
|
|
466
|
+
};
|
|
467
|
+
readonly 'house-trigger': {
|
|
468
|
+
readonly description: "One Trigger of this Room as its acts wrote it, which House alone writes: its `description`, the `condition` it fires on, its `actions` in order, whether each action and the Trigger are `enabled`, `paused_by` `types` while a change of the Room's types paused it, its `creator` by `user` and the `name` they had then, and when it was `created`. A `notify` action reaches the `users` its `to` names, the members its `fields` name in the matched document and the holders of its `roles`; an `agent_function` action sends its `payload` to the Agent function whose card under this Room's `house/agent-functions/` its `card` names, absent while this Room holds no card of that Agent function; a `message` action puts its `text` into the active conversation that Agent function started for what the Event is about, or starts that Agent function when none is active; a `done` action marks Done every active conversation an Agent function request of this Room started for the Event's document; a `function` action runs the `function` its `app`'s latest release declares, on House's servers, or, naming no `app`, the Room owner's Environment function of that name on its Environment, which only a Trigger of their Private Room holds. Whether an action's target holds is not written: it follows from the Room's members, the Agent function's card, the App's latest release and the owner's functions.";
|
|
469
|
+
readonly properties: {
|
|
470
|
+
readonly reflected: {
|
|
471
|
+
readonly type: 'string';
|
|
472
|
+
readonly format: 'date-time';
|
|
473
|
+
};
|
|
474
|
+
readonly trigger: {
|
|
475
|
+
readonly $ref: '#/$defs/id';
|
|
476
|
+
};
|
|
477
|
+
readonly description: {
|
|
478
|
+
readonly type: 'string';
|
|
479
|
+
};
|
|
480
|
+
readonly condition: {
|
|
481
|
+
readonly description: 'When it fires, as the Trigger reference page writes it, a document it names at its current path.';
|
|
482
|
+
readonly type: 'object';
|
|
483
|
+
readonly additionalProperties: true;
|
|
484
|
+
};
|
|
485
|
+
readonly actions: {
|
|
486
|
+
readonly type: 'array';
|
|
487
|
+
readonly items: {
|
|
488
|
+
readonly anyOf: readonly [{
|
|
489
|
+
readonly type: 'object';
|
|
490
|
+
readonly additionalProperties: false;
|
|
491
|
+
readonly properties: {
|
|
492
|
+
readonly kind: {
|
|
493
|
+
readonly const: 'notify';
|
|
494
|
+
};
|
|
495
|
+
readonly enabled: {
|
|
496
|
+
readonly type: 'boolean';
|
|
497
|
+
};
|
|
498
|
+
readonly title: {
|
|
499
|
+
readonly type: 'string';
|
|
500
|
+
};
|
|
501
|
+
readonly text: {
|
|
502
|
+
readonly type: 'string';
|
|
503
|
+
};
|
|
504
|
+
readonly to: {
|
|
505
|
+
readonly type: 'object';
|
|
506
|
+
readonly additionalProperties: false;
|
|
507
|
+
readonly properties: {
|
|
508
|
+
readonly users: {
|
|
509
|
+
readonly type: 'array';
|
|
510
|
+
readonly items: {
|
|
511
|
+
readonly type: 'object';
|
|
512
|
+
readonly additionalProperties: false;
|
|
513
|
+
readonly properties: {
|
|
514
|
+
readonly user: {
|
|
515
|
+
readonly $ref: '#/$defs/id';
|
|
516
|
+
};
|
|
517
|
+
};
|
|
518
|
+
readonly required: readonly ['user'];
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
readonly fields: {
|
|
522
|
+
readonly type: 'array';
|
|
523
|
+
readonly items: {
|
|
524
|
+
readonly type: 'string';
|
|
525
|
+
};
|
|
526
|
+
};
|
|
527
|
+
readonly roles: {
|
|
528
|
+
readonly type: 'array';
|
|
529
|
+
readonly items: {
|
|
530
|
+
readonly type: 'string';
|
|
531
|
+
};
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
readonly required: readonly ['users', 'fields', 'roles'];
|
|
535
|
+
};
|
|
536
|
+
};
|
|
537
|
+
readonly required: readonly ['kind', 'enabled', 'title', 'text', 'to'];
|
|
538
|
+
}, {
|
|
539
|
+
readonly type: 'object';
|
|
540
|
+
readonly additionalProperties: false;
|
|
541
|
+
readonly properties: {
|
|
542
|
+
readonly kind: {
|
|
543
|
+
readonly const: 'agent_function';
|
|
544
|
+
};
|
|
545
|
+
readonly enabled: {
|
|
546
|
+
readonly type: 'boolean';
|
|
547
|
+
};
|
|
548
|
+
readonly card: {
|
|
549
|
+
readonly type: 'string';
|
|
550
|
+
readonly minLength: 1;
|
|
551
|
+
};
|
|
552
|
+
readonly payload: {
|
|
553
|
+
readonly type: 'string';
|
|
554
|
+
};
|
|
555
|
+
};
|
|
556
|
+
readonly required: readonly ['kind', 'enabled', 'payload'];
|
|
557
|
+
}, {
|
|
558
|
+
readonly type: 'object';
|
|
559
|
+
readonly additionalProperties: false;
|
|
560
|
+
readonly properties: {
|
|
561
|
+
readonly kind: {
|
|
562
|
+
readonly const: 'message';
|
|
563
|
+
};
|
|
564
|
+
readonly enabled: {
|
|
565
|
+
readonly type: 'boolean';
|
|
566
|
+
};
|
|
567
|
+
readonly card: {
|
|
568
|
+
readonly type: 'string';
|
|
569
|
+
readonly minLength: 1;
|
|
570
|
+
};
|
|
571
|
+
readonly text: {
|
|
572
|
+
readonly type: 'string';
|
|
573
|
+
};
|
|
574
|
+
};
|
|
575
|
+
readonly required: readonly ['kind', 'enabled', 'text'];
|
|
576
|
+
}, {
|
|
577
|
+
readonly type: 'object';
|
|
578
|
+
readonly additionalProperties: false;
|
|
579
|
+
readonly properties: {
|
|
580
|
+
readonly kind: {
|
|
581
|
+
readonly const: 'done';
|
|
582
|
+
};
|
|
583
|
+
readonly enabled: {
|
|
584
|
+
readonly type: 'boolean';
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
readonly required: readonly ['kind', 'enabled'];
|
|
588
|
+
}, {
|
|
589
|
+
readonly type: 'object';
|
|
590
|
+
readonly additionalProperties: false;
|
|
591
|
+
readonly properties: {
|
|
592
|
+
readonly kind: {
|
|
593
|
+
readonly const: 'function';
|
|
594
|
+
};
|
|
595
|
+
readonly enabled: {
|
|
596
|
+
readonly type: 'boolean';
|
|
597
|
+
};
|
|
598
|
+
readonly app: {
|
|
599
|
+
readonly $ref: '#/$defs/app';
|
|
600
|
+
};
|
|
601
|
+
readonly function: {
|
|
602
|
+
readonly type: 'string';
|
|
603
|
+
};
|
|
604
|
+
};
|
|
605
|
+
readonly required: readonly ['kind', 'enabled', 'function'];
|
|
606
|
+
}];
|
|
607
|
+
};
|
|
608
|
+
};
|
|
609
|
+
readonly enabled: {
|
|
610
|
+
readonly type: 'boolean';
|
|
611
|
+
};
|
|
612
|
+
readonly paused_by: {
|
|
613
|
+
readonly enum: readonly ['types'];
|
|
614
|
+
};
|
|
615
|
+
readonly creator: {
|
|
616
|
+
readonly type: 'object';
|
|
617
|
+
readonly additionalProperties: false;
|
|
618
|
+
readonly properties: {
|
|
619
|
+
readonly user: {
|
|
620
|
+
readonly $ref: '#/$defs/id';
|
|
621
|
+
};
|
|
622
|
+
readonly name: {
|
|
623
|
+
readonly type: 'string';
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
readonly required: readonly ['user', 'name'];
|
|
627
|
+
};
|
|
628
|
+
readonly created: {
|
|
629
|
+
readonly type: 'string';
|
|
630
|
+
readonly format: 'date-time';
|
|
631
|
+
};
|
|
632
|
+
};
|
|
633
|
+
readonly required: readonly ['reflected', 'trigger', 'description', 'condition', 'actions', 'enabled', 'creator', 'created'];
|
|
634
|
+
};
|
|
635
|
+
readonly 'house-web-wizard': {
|
|
636
|
+
readonly description: "One Web Wizard an agent made for this User: the `environment` it runs on, with the `name` that Environment had when the Web Wizard was made, and its `state`, `waiting` until its owner presses Run or Keep, `running`, `finished` with the script's `exit_code`, `failed`, `cancelled` when its page closed before the script ended, `lapsed` when nobody ran it in its time, or `kept` when its owner kept the script, without running it, as their Environment function named `function`. Its body is the script, whole, in one fenced code block. The terminal's output is never kept.";
|
|
637
|
+
readonly properties: {
|
|
638
|
+
readonly reflected: {
|
|
639
|
+
readonly type: 'string';
|
|
640
|
+
readonly format: 'date-time';
|
|
641
|
+
};
|
|
642
|
+
readonly web_wizard: {
|
|
643
|
+
readonly $ref: '#/$defs/id';
|
|
644
|
+
};
|
|
645
|
+
readonly environment: {
|
|
646
|
+
readonly type: 'object';
|
|
647
|
+
readonly additionalProperties: false;
|
|
648
|
+
readonly properties: {
|
|
649
|
+
readonly environment: {
|
|
650
|
+
readonly $ref: '#/$defs/id';
|
|
651
|
+
};
|
|
652
|
+
readonly name: {
|
|
653
|
+
readonly type: 'string';
|
|
654
|
+
};
|
|
655
|
+
};
|
|
656
|
+
readonly required: readonly ['environment', 'name'];
|
|
657
|
+
};
|
|
658
|
+
readonly state: {
|
|
659
|
+
readonly enum: readonly ['waiting', 'running', 'finished', 'failed', 'cancelled', 'lapsed', 'kept'];
|
|
660
|
+
};
|
|
661
|
+
readonly exit_code: {
|
|
662
|
+
readonly type: 'integer';
|
|
663
|
+
};
|
|
664
|
+
readonly function: {
|
|
665
|
+
readonly type: 'string';
|
|
666
|
+
};
|
|
667
|
+
};
|
|
668
|
+
readonly required: readonly ['reflected', 'web_wizard', 'environment', 'state'];
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
export declare const HOUSE_MODEL_TYPES: string;
|
|
672
|
+
export declare const HOUSE_TYPED_PATHS: readonly TypedPath[];
|
|
673
|
+
type Model = typeof HOUSE_MODEL_DECLARATION;
|
|
674
|
+
type Definitions = Model['$defs'];
|
|
675
|
+
export type HouseModelType = Exclude<keyof Model, '$defs'>;
|
|
676
|
+
type Needed<S> = S extends {
|
|
677
|
+
readonly required: readonly (infer Name)[];
|
|
678
|
+
} ? Name : never;
|
|
679
|
+
type Shape<T> = {
|
|
680
|
+
[K in keyof T]: T[K];
|
|
681
|
+
} & {};
|
|
682
|
+
type Properties<S> = S extends {
|
|
683
|
+
readonly properties: infer P;
|
|
684
|
+
} ? Shape<{
|
|
685
|
+
readonly [K in keyof P as K extends Needed<S> ? K : never]: Value<P[K]>;
|
|
686
|
+
} & {
|
|
687
|
+
readonly [K in keyof P as K extends Needed<S> ? never : K]?: Value<P[K]>;
|
|
688
|
+
}> : S extends {
|
|
689
|
+
readonly additionalProperties: false;
|
|
690
|
+
} ? Readonly<Record<string, never>> : Readonly<Record<string, unknown>>;
|
|
691
|
+
type Typed<T, S> = T extends 'string' ? string : T extends 'integer' | 'number' ? number : T extends 'boolean' ? boolean : T extends 'null' ? null : T extends 'array' ? readonly (S extends {
|
|
692
|
+
readonly items: infer I;
|
|
693
|
+
} ? Value<I> : unknown)[] : T extends 'object' ? Properties<S> : never;
|
|
694
|
+
type Value<S> = S extends {
|
|
695
|
+
readonly const: infer C;
|
|
696
|
+
} ? C : S extends {
|
|
697
|
+
readonly enum: readonly (infer E)[];
|
|
698
|
+
} ? E : S extends {
|
|
699
|
+
readonly anyOf: readonly (infer A)[];
|
|
700
|
+
} ? Value<A> : S extends {
|
|
701
|
+
readonly $ref: `#/$defs/${infer D}`;
|
|
702
|
+
} ? D extends keyof Definitions ? Value<Definitions[D]> : never : S extends {
|
|
703
|
+
readonly type: infer T;
|
|
704
|
+
} ? Typed<T, S> : S extends {
|
|
705
|
+
readonly properties: object;
|
|
706
|
+
} ? Properties<S> : unknown;
|
|
707
|
+
type Declared<Type extends HouseModelType> = Model[Type] extends {
|
|
708
|
+
readonly properties: infer P;
|
|
709
|
+
} ? P : {};
|
|
710
|
+
export type HouseDocumentFields<Type extends HouseModelType> = Properties<{
|
|
711
|
+
readonly properties: {
|
|
712
|
+
readonly type: {
|
|
713
|
+
readonly const: Type;
|
|
714
|
+
};
|
|
715
|
+
} & Declared<Type>;
|
|
716
|
+
readonly required: readonly ('type' | Needed<Model[Type]>)[];
|
|
717
|
+
}>;
|
|
718
|
+
export {};
|
|
2
719
|
//# sourceMappingURL=house-model.d.ts.map
|