@agentshouse/mdruntime-adapter 0.1.0-alpha.19 → 0.1.0-alpha.20

package/AGENTS.md

@@ -7,7 +7,7 @@ enforcement.
 ## The MD Runtime API
 
 App code reaches the MD Runtime through the remote client. The surfaces are
-Rooms, Slots, Query, Observe, Types, Room Draft, Save, History, Call, Log,
+Rooms, Slots, Query, Search, Observe, Types, Room Draft, Save, History, Call, Log,
 storage loss, the reported persistence answer, deployment facts, Sync Status, reauthorization,
 conversation, the chat draft, and Presentation State.
 
@@ -22,7 +22,8 @@ queued.
 Slots answers each Slot the Provider declares, in its order, with its entries
 in order, each a Room and its segment; a Room two Slots list is the same Room.
 
-Rooms, Slots, Query, Observe, Types, Room Draft, and Save never touch the network.
+Rooms, Slots, Query, Search, Observe, Types, Room 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
@@ -72,6 +73,26 @@ the whole result at once and again only when it changes. A query is data:
   `unknown-type`, `unknown-field` or `wrong-kind`, naming where, and never
   answers an empty result in its place.
 
+## Local Search rules
+
+`search({ text, documents, conversations, limit })` answers once, by words, from
+local state, with MiniSearch at its default configuration. There is no observed
+search.
+
+- **What is found.** A Document by its field values, its sections' headings and
+  text, its preamble and its Path; a message by its text. Frontmatter keys, Room
+  Drafts, chat drafts and growing text are never found. There are no phrases,
+  word forms, typo tolerance or prefix matching.
+- **Narrowing.** `documents` is a Local Query filter: `rooms`, `types`, `where`,
+  `pathPrefix`, `hop` and `backlinks`. `conversations` names conversations. Both
+  apply before `limit`, which bounds each list; without it every hit returns.
+- **Results.** `{ documents, messages }`, each ranked by `score`, which compares
+  hits of one list of one search. A Document hit names its `room`, `path` and
+  `type`, a message hit its `conversation` and `identity`, and `matches` maps each
+  matched word to the parts it matched in: `fields`, `sections`, `preamble` or
+  `path`, or `text`. A hit carries no position; mark the words in the text you
+  show. An invalid filter fails with its Local Query error.
+
 ## Room Draft, Save, and outcome rules
 
 The MD Runtime owns one Room Draft per Room and Path, shared by every App and
@@ -130,8 +151,8 @@ 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.
+of these promises by itself. Reading, querying and searching 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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentshouse/mdruntime-adapter",
-  "version": "0.1.0-alpha.19",
+  "version": "0.1.0-alpha.20",
   "description": "Agents House Adapter for the MD Runtime",
   "license": "MIT",
   "type": "module",
@@ -34,6 +34,6 @@
   },
   "dependencies": {
     "@agentshouse/mdmodel": "0.1.0-alpha.14",
-    "@agentshouse/mdruntime": "0.1.0-alpha.25"
+    "@agentshouse/mdruntime": "0.1.0-alpha.26"
   }
 }