@agentshouse/mdruntime 0.1.0-alpha.34 → 0.1.0-alpha.35
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/AGENTS.md +1 -2
- package/README.md +40 -0
- package/package.json +2 -10
package/AGENTS.md
CHANGED
|
@@ -37,8 +37,7 @@ composes, or exposes the browser store.
|
|
|
37
37
|
|
|
38
38
|
Read deployment facts with `deploymentFacts()` and observe replacements with
|
|
39
39
|
`observe('deployment-facts')`. Interpret the opaque value using the
|
|
40
|
-
host's contract.
|
|
41
|
-
owns their boundary.
|
|
40
|
+
host's contract.
|
|
42
41
|
|
|
43
42
|
The in-memory Adapter at `@agentshouse/mdruntime/memory` is for tests and
|
|
44
43
|
ships in no bundle.
|
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# `@agentshouse/mdruntime`
|
|
2
|
+
|
|
3
|
+
The headless core of MD App: local Rooms of typed Markdown Documents with
|
|
4
|
+
query, search, observation, Room Drafts, and queued saves that synchronize
|
|
5
|
+
with a Provider through an Adapter.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install @agentshouse/mdruntime
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Entries
|
|
14
|
+
|
|
15
|
+
| Entry | For |
|
|
16
|
+
| ------------------------------- | --------------------------------------------------- |
|
|
17
|
+
| `@agentshouse/mdruntime/client` | App code: `connectMdRuntime(port)` |
|
|
18
|
+
| `@agentshouse/mdruntime/host` | The host that serves a Runtime: `serveMdRuntime` |
|
|
19
|
+
| `@agentshouse/mdruntime` | Hosts and tests: `createMdRuntime` and shared types |
|
|
20
|
+
| `@agentshouse/mdruntime/memory` | Tests: `createMemoryAdapter`, an in-memory Adapter |
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
App code imports only the client entry and connects on the port its host hands
|
|
25
|
+
it:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import { connectMdRuntime } from '@agentshouse/mdruntime/client';
|
|
29
|
+
|
|
30
|
+
const runtime = connectMdRuntime(port);
|
|
31
|
+
const rooms = await runtime.rooms();
|
|
32
|
+
const notes = await runtime.query({ types: ['note'], select: 'all', limit: 20 });
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The rules an App's agent follows, including Local Query, Local Search, Room
|
|
36
|
+
Draft and Save, are in [`AGENTS.md`](AGENTS.md).
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agentshouse/mdruntime",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.35",
|
|
4
4
|
"description": "The headless core of MD App",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -33,17 +33,9 @@
|
|
|
33
33
|
"files": [
|
|
34
34
|
"dist",
|
|
35
35
|
"AGENTS.md",
|
|
36
|
+
"README.md",
|
|
36
37
|
"LICENSE"
|
|
37
38
|
],
|
|
38
|
-
"repository": {
|
|
39
|
-
"type": "git",
|
|
40
|
-
"url": "git+https://github.com/agentshouse/mdruntime.git",
|
|
41
|
-
"directory": "packages/mdruntime"
|
|
42
|
-
},
|
|
43
|
-
"homepage": "https://github.com/agentshouse/mdruntime#readme",
|
|
44
|
-
"bugs": {
|
|
45
|
-
"url": "https://github.com/agentshouse/mdruntime/issues"
|
|
46
|
-
},
|
|
47
39
|
"dependencies": {
|
|
48
40
|
"@agentshouse/mdmodel": "0.1.0-alpha.15",
|
|
49
41
|
"@tanstack/db": "0.9.2",
|