@agentshouse/mdruntime 0.1.0-alpha.10 → 0.1.0-alpha.11

package/AGENTS.md

@@ -0,0 +1,78 @@
+# Instructions for the App Creator's agent
+
+These instructions address an agent in an environment with Git. Obtain the
+App Repository, change it, build, and push. They are documentation, not
+enforcement.
+
+## The MD Runtime API
+
+App code reaches the MD Runtime through the remote client. The surfaces are
+Rooms, Query, Observe, Types, Draft, Save, Queue, History, Call, Log,
+storage loss, the reported persistence answer, Sync Status, reauthorization,
+conversation, the unsent instruction, and Presentation State.
+
+Rooms, Query, Observe, Types, Draft, and Save never touch the network.
+History and Call go to the Provider through the Adapter. Every member of the
+client is asynchronous. Results are detached snapshots. Nothing in this
+surface returns the authorization, performs a request the App's code
+composes, or exposes the browser store.
+
+The in-memory Adapter at `@agentshouse/mdruntime/memory` is for tests and
+ships in no bundle.
+
+## Draft, Save, and outcome rules
+
+A Draft is durable: it survives reload and navigation. Save takes structured
+changes, validates locally, and on success appends one Change Batch to that
+Room's queue. A local validation failure leaves the Draft and creates
+nothing.
+
+Outcomes follow the Provider's answer. Accepted advances the confirmed
+layer. Conflicted and Rejected leave the head in place, carry the affected
+current state and the Provider's structured refusal code and fields as
+returned, and block that Room's queue. The App's code resolves a head by
+discarding it or by saving a corrected Change Batch that replaces it in
+place. Transport failure and Provider unavailability keep work Pending and
+do not infer a rejection. A refusal the Provider marks retryable stays
+Pending until the reset it names; the MD Runtime retries the same Change
+Batch identity and payload and never infers an outcome from transport
+uncertainty. The MD Runtime never combines, reorders, or rebases.
+
+## The neutrality rule
+
+No module outside an Adapter package imports, names, or special-cases a
+Provider. MD UI and every App reach data only through the client entry.
+
+## Content-safety rules
+
+The Provider authorization belongs to the Runtime host and is never readable
+by the App's code. The App's code reaches the network only at the external
+origins its manifest declares, empty by default, and the Provider enforces
+that set. Every request to the Provider itself goes through the MD Runtime.
+Rendered Markdown never executes scripts, renders raw HTML only for the
+details and summary elements, and loads images and other resources only from
+origins the Provider's policy allows.
+
+## Launch promises MD UI keeps
+
+MD UI uses semantic HTML, is fully operable from a keyboard with visible
+focus and labelled controls, and lays out from a 360 pixel wide viewport to
+a desktop. Its strings are English only, dates and numbers follow the
+browser locale, and content is never translated. Light and dark themes come
+from CSS custom properties with the browser's preference as the default and
+an App's override respected. What an App Creator's agent adds carries none
+of these promises by itself. Reading and querying never wait for the
+network. Data lives only in the App Creator's browser and with the Provider.
+
+## App code imports only the client entry and never constructs a Runtime
+
+App code imports only `@agentshouse/mdruntime/client` and calls
+`connectMdRuntime` on the port the host hands it. It never constructs a
+Runtime. It does not import the package main, the host entry, or the Adapter
+package, and it does not call `createMdRuntime` or `serveMdRuntime`. Hosts
+and tests use those entries; the served App does not.
+
+## What an agent must never do
+
+An agent must never read the authorization, load code from a Room, call the
+Provider directly, or rebase a refused Change Batch.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentshouse/mdruntime",
-  "version": "0.1.0-alpha.10",
+  "version": "0.1.0-alpha.11",
   "description": "The headless core of MD App",
   "license": "MIT",
   "type": "module",
@@ -32,6 +32,7 @@
   },
   "files": [
     "dist",
+    "AGENTS.md",
     "LICENSE"
   ],
   "repository": {
@@ -44,7 +45,7 @@
     "url": "https://github.com/agentshouse/mdruntime/issues"
   },
   "dependencies": {
-    "@agentshouse/mdmodel": "0.1.0-alpha.5",
-    "@agentshouse/query": "0.1.0-alpha.3"
+    "@agentshouse/mdmodel": "0.1.0-alpha.7",
+    "@agentshouse/query": "0.1.0-alpha.5"
   }
 }