@stateforge-labs/herdr-sdk 0.0.0-stage → 0.3.0
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/LICENSE +18 -0
- package/NOTICE.md +51 -0
- package/README.md +211 -2
- package/bin/herdr-drift.js +14 -0
- package/bin/herdr-skill.js +38 -0
- package/dist/admin.d.ts +2 -0
- package/dist/admin.js +3 -0
- package/dist/constants.d.ts +236 -0
- package/dist/constants.js +294 -0
- package/dist/core/backoff.d.ts +20 -0
- package/dist/core/backoff.js +53 -0
- package/dist/core/constants.d.ts +143 -0
- package/dist/core/constants.js +98 -0
- package/dist/core/errors.d.ts +35 -0
- package/dist/core/errors.js +16 -0
- package/dist/core/events.d.ts +42 -0
- package/dist/core/events.js +128 -0
- package/dist/core/kernel.d.ts +65 -0
- package/dist/core/kernel.js +138 -0
- package/dist/core/link.d.ts +47 -0
- package/dist/core/link.js +187 -0
- package/dist/core/test-kit/constants.d.ts +51 -0
- package/dist/core/test-kit/constants.js +43 -0
- package/dist/core/test-kit/fake-core.d.ts +61 -0
- package/dist/core/test-kit/fake-core.js +228 -0
- package/dist/core/test-kit/frames.d.ts +1 -0
- package/dist/core/test-kit/frames.js +480 -0
- package/dist/core/test-kit/setup-test.d.ts +18 -0
- package/dist/core/test-kit/setup-test.js +35 -0
- package/dist/core/wire.d.ts +85 -0
- package/dist/core/wire.js +199 -0
- package/dist/core-test-kit.d.ts +5 -0
- package/dist/core-test-kit.js +5 -0
- package/dist/core.d.ts +15 -0
- package/dist/core.js +12 -0
- package/dist/drift/cli.d.ts +22 -0
- package/dist/drift/cli.js +146 -0
- package/dist/drift/constants.d.ts +83 -0
- package/dist/drift/constants.js +73 -0
- package/dist/drift/diff.d.ts +7 -0
- package/dist/drift/diff.js +91 -0
- package/dist/drift/schema.d.ts +19 -0
- package/dist/drift/schema.js +190 -0
- package/dist/drift/types.d.ts +76 -0
- package/dist/drift/types.js +1 -0
- package/dist/drift.d.ts +5 -0
- package/dist/drift.js +6 -0
- package/dist/effect.d.ts +3 -0
- package/dist/effect.js +4 -0
- package/dist/herdr/client/connect.d.ts +5 -0
- package/dist/herdr/client/connect.js +81 -0
- package/dist/herdr/client/held.d.ts +54 -0
- package/dist/herdr/client/held.js +100 -0
- package/dist/herdr/client/long-poll.d.ts +33 -0
- package/dist/herdr/client/long-poll.js +66 -0
- package/dist/herdr/client/scoped.d.ts +45 -0
- package/dist/herdr/client/scoped.js +241 -0
- package/dist/herdr/client/streams.d.ts +9 -0
- package/dist/herdr/client/streams.js +40 -0
- package/dist/herdr/client/subscribe.d.ts +75 -0
- package/dist/herdr/client/subscribe.js +208 -0
- package/dist/herdr/client/types.d.ts +150 -0
- package/dist/herdr/client/types.js +1 -0
- package/dist/herdr/client/watch-pane-set.d.ts +34 -0
- package/dist/herdr/client/watch-pane-set.js +271 -0
- package/dist/herdr/client/watch.d.ts +117 -0
- package/dist/herdr/client/watch.js +138 -0
- package/dist/herdr/effect/to-tagged-error.d.ts +2 -0
- package/dist/herdr/effect/to-tagged-error.js +54 -0
- package/dist/herdr/effect/types.d.ts +51 -0
- package/dist/herdr/effect/types.js +26 -0
- package/dist/herdr/errors.d.ts +53 -0
- package/dist/herdr/errors.js +87 -0
- package/dist/herdr/generated/entries/admin.d.ts +2 -0
- package/dist/herdr/generated/entries/admin.js +5 -0
- package/dist/herdr/generated/entries/client.d.ts +2 -0
- package/dist/herdr/generated/entries/client.js +5 -0
- package/dist/herdr/generated/entries/held.d.ts +2 -0
- package/dist/herdr/generated/entries/held.js +5 -0
- package/dist/herdr/generated/entries/prompt.d.ts +2 -0
- package/dist/herdr/generated/entries/prompt.js +5 -0
- package/dist/herdr/generated/entries/read-only-content.d.ts +2 -0
- package/dist/herdr/generated/entries/read-only-content.js +5 -0
- package/dist/herdr/generated/entries/read-only.d.ts +2 -0
- package/dist/herdr/generated/entries/read-only.js +5 -0
- package/dist/herdr/generated/entry-methods.d.ts +9 -0
- package/dist/herdr/generated/entry-methods.js +17 -0
- package/dist/herdr/generated/errors.d.ts +4 -0
- package/dist/herdr/generated/errors.js +3 -0
- package/dist/herdr/generated/events.d.ts +274 -0
- package/dist/herdr/generated/events.js +3 -0
- package/dist/herdr/generated/index.d.ts +20 -0
- package/dist/herdr/generated/index.js +19 -0
- package/dist/herdr/generated/method-table.d.ts +615 -0
- package/dist/herdr/generated/method-table.js +106 -0
- package/dist/herdr/generated/names/agent-status.d.ts +10 -0
- package/dist/herdr/generated/names/agent-status.js +10 -0
- package/dist/herdr/generated/names/capability-class.d.ts +14 -0
- package/dist/herdr/generated/names/capability-class.js +15 -0
- package/dist/herdr/generated/names/event-kind.d.ts +31 -0
- package/dist/herdr/generated/names/event-kind.js +31 -0
- package/dist/herdr/generated/names/event-match-kind.d.ts +23 -0
- package/dist/herdr/generated/names/event-match-kind.js +24 -0
- package/dist/herdr/generated/names/index.d.ts +10 -0
- package/dist/herdr/generated/names/index.js +12 -0
- package/dist/herdr/generated/names/method.d.ts +209 -0
- package/dist/herdr/generated/names/method.js +209 -0
- package/dist/herdr/generated/names/result-tag.d.ts +68 -0
- package/dist/herdr/generated/names/result-tag.js +68 -0
- package/dist/herdr/generated/names/server-capability.d.ts +10 -0
- package/dist/herdr/generated/names/server-capability.js +11 -0
- package/dist/herdr/generated/names/subscription-event-kind.d.ts +8 -0
- package/dist/herdr/generated/names/subscription-event-kind.js +8 -0
- package/dist/herdr/generated/names/subscription-type.d.ts +31 -0
- package/dist/herdr/generated/names/subscription-type.js +32 -0
- package/dist/herdr/generated/names/token-name-pattern.d.ts +2 -0
- package/dist/herdr/generated/names/token-name-pattern.js +4 -0
- package/dist/herdr/generated/namespaces.d.ts +785 -0
- package/dist/herdr/generated/namespaces.js +3 -0
- package/dist/herdr/generated/overrides.d.ts +33 -0
- package/dist/herdr/generated/overrides.js +20 -0
- package/dist/herdr/generated/params.d.ts +799 -0
- package/dist/herdr/generated/params.js +3 -0
- package/dist/herdr/generated/preset-methods.d.ts +4 -0
- package/dist/herdr/generated/preset-methods.js +7 -0
- package/dist/herdr/generated/presets/sessions-reader.d.ts +2 -0
- package/dist/herdr/generated/presets/sessions-reader.js +5 -0
- package/dist/herdr/generated/results.d.ts +978 -0
- package/dist/herdr/generated/results.js +52 -0
- package/dist/herdr/generated/test-data/defaults.d.ts +739 -0
- package/dist/herdr/generated/test-data/defaults.js +741 -0
- package/dist/herdr/generated/test-data/shapes.d.ts +1325 -0
- package/dist/herdr/generated/test-data/shapes.js +2245 -0
- package/dist/herdr/test-kit/fake-herdr.d.ts +13 -0
- package/dist/herdr/test-kit/fake-herdr.js +216 -0
- package/dist/herdr/test-kit/fake-protocol.d.ts +107 -0
- package/dist/herdr/test-kit/fake-protocol.js +436 -0
- package/dist/herdr/test-kit/types.d.ts +88 -0
- package/dist/herdr/test-kit/types.js +1 -0
- package/dist/herdr/wire/codec.d.ts +36 -0
- package/dist/herdr/wire/codec.js +62 -0
- package/dist/herdr/wire/connection.d.ts +13 -0
- package/dist/herdr/wire/connection.js +65 -0
- package/dist/herdr/wire/dedicated.d.ts +2 -0
- package/dist/herdr/wire/dedicated.js +238 -0
- package/dist/herdr/wire/push-decoder.d.ts +2 -0
- package/dist/herdr/wire/push-decoder.js +40 -0
- package/dist/herdr/wire/rpc.d.ts +3 -0
- package/dist/herdr/wire/rpc.js +141 -0
- package/dist/herdr/wire/socket-path.d.ts +8 -0
- package/dist/herdr/wire/socket-path.js +23 -0
- package/dist/herdr/wire/types.d.ts +78 -0
- package/dist/herdr/wire/types.js +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +7 -0
- package/dist/read-only.d.ts +5 -0
- package/dist/read-only.js +6 -0
- package/dist/schema.d.ts +5 -0
- package/dist/schema.js +6 -0
- package/dist/test-kit.d.ts +2 -0
- package/dist/test-kit.js +3 -0
- package/docs/api/events.md +43 -0
- package/docs/api/methods.md +232 -0
- package/package.json +112 -4
- package/schema/herdr-api.schema.json +10759 -0
- package/schema/herdr-version.json +5 -0
- package/skills/herdr-sdk/SKILL.md +75 -0
- package/skills/herdr-sdk/references/api-map.md +28 -0
- package/skills/herdr-sdk/references/errors.md +19 -0
- package/skills/herdr-sdk/references/recipes.md +171 -0
- package/skills/herdr-sdk/references/versions.md +7 -0
package/dist/test-kit.js
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
// Role: the test-kit entry: the minimal fake herdr for tests (a subpath entry, imported by tests only).
|
|
2
|
+
// Informs plan 3 (test-kit.ts is the only entry that may import test-kit/) and HERDR-ADR-0003 (layers); test-kit imports wire and generated only.
|
|
3
|
+
export { createFakeHerdr } from './herdr/test-kit/fake-herdr.js';
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
<!-- GENERATED by tools/gen/ from schema/herdr-api.schema.json. Do not edit. -->
|
|
2
|
+
<!-- herdr protocol 22, schema_version 1. -->
|
|
3
|
+
# Event reference
|
|
4
|
+
|
|
5
|
+
26 event kinds and 27 subscription types. A subscription type is the event kind with its first `_` replaced by `.`, except for the parameterised kinds that have no event kind.
|
|
6
|
+
|
|
7
|
+
| EventKind | Subscription type | EventMatch | Frame |
|
|
8
|
+
| --- | --- | --- | --- |
|
|
9
|
+
| `workspace_created` | `workspace.created` | yes | `EventFrame` |
|
|
10
|
+
| `workspace_updated` | `workspace.updated` | yes | `EventFrame` |
|
|
11
|
+
| `workspace_metadata_updated` | `workspace.metadata_updated` | no | `EventFrame` |
|
|
12
|
+
| `workspace_closed` | `workspace.closed` | yes | `EventFrame` |
|
|
13
|
+
| `workspace_renamed` | `workspace.renamed` | yes | `EventFrame` |
|
|
14
|
+
| `workspace_moved` | `workspace.moved` | yes | `EventFrame` |
|
|
15
|
+
| `workspace_reordered` | `workspace.reordered` | no | `EventFrame` |
|
|
16
|
+
| `workspace_focused` | `workspace.focused` | yes | `EventFrame` |
|
|
17
|
+
| `worktree_created` | `worktree.created` | no | `EventFrame` |
|
|
18
|
+
| `worktree_opened` | `worktree.opened` | no | `EventFrame` |
|
|
19
|
+
| `worktree_removed` | `worktree.removed` | no | `EventFrame` |
|
|
20
|
+
| `tab_created` | `tab.created` | yes | `EventFrame` |
|
|
21
|
+
| `tab_closed` | `tab.closed` | yes | `EventFrame` |
|
|
22
|
+
| `tab_renamed` | `tab.renamed` | yes | `EventFrame` |
|
|
23
|
+
| `tab_moved` | `tab.moved` | yes | `EventFrame` |
|
|
24
|
+
| `tab_focused` | `tab.focused` | yes | `EventFrame` |
|
|
25
|
+
| `pane_created` | `pane.created` | yes | `EventFrame` |
|
|
26
|
+
| `pane_closed` | `pane.closed` | yes | `EventFrame` |
|
|
27
|
+
| `pane_updated` | `pane.updated` | no | `EventFrame` |
|
|
28
|
+
| `pane_focused` | `pane.focused` | yes | `EventFrame` |
|
|
29
|
+
| `pane_moved` | `pane.moved` | yes | `EventFrame` |
|
|
30
|
+
| `pane_output_changed` | — | yes | `EventFrame` |
|
|
31
|
+
| `pane_exited` | `pane.exited` | yes | `EventFrame` |
|
|
32
|
+
| `pane_agent_detected` | `pane.agent_detected` | yes | `EventFrame` |
|
|
33
|
+
| `pane_agent_status_changed` | `pane.agent_status_changed` | yes | `SubscriptionEventFrame` |
|
|
34
|
+
| `layout_updated` | `layout.updated` | no | `EventFrame` |
|
|
35
|
+
| — | `pane.output_matched` | no | `SubscriptionEventFrame` |
|
|
36
|
+
| — | `pane.scroll_changed` | no | `SubscriptionEventFrame` |
|
|
37
|
+
|
|
38
|
+
## Facts
|
|
39
|
+
|
|
40
|
+
- 7 kinds are not awaitable with `events.wait` (no EventMatch): `workspace_metadata_updated`, `workspace_reordered`, `worktree_created`, `worktree_opened`, `worktree_removed`, `pane_updated`, `layout_updated`.
|
|
41
|
+
- `pane_output_changed` has no subscription type and is reachable only through `events.wait`.
|
|
42
|
+
- `pane.output_matched`, `pane.scroll_changed` have no EventKind; they carry the parameterised subscription frame.
|
|
43
|
+
- `pane_agent_status_changed` is in both shapes: the lifecycle EventFrame and the SubscriptionEventFrame.
|
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
<!-- GENERATED by tools/gen/ from schema/herdr-api.schema.json. Do not edit. -->
|
|
2
|
+
<!-- herdr protocol 22, schema_version 1. -->
|
|
3
|
+
# Method reference
|
|
4
|
+
|
|
5
|
+
102 methods. Each row gives the wire method, the generated params type, the response tag and its source (tools/gen/method-result-map.ts), the capability class, whether the call is long-poll, and the capability gate.
|
|
6
|
+
|
|
7
|
+
## root
|
|
8
|
+
|
|
9
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
10
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
11
|
+
| `ping` | `P.PingParams` | `pong` | seed | R-meta | no | — |
|
|
12
|
+
|
|
13
|
+
## server
|
|
14
|
+
|
|
15
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
16
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
17
|
+
| `server.stop` | `P.EmptyParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | S | no | — |
|
|
18
|
+
| `server.live_handoff` | `P.ServerLiveHandoffParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | S | no | live_handoff |
|
|
19
|
+
| `server.reload_config` | `P.EmptyParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | S | no | — |
|
|
20
|
+
| `server.ssh_agent.register` | `P.ServerSshAgentRegisterParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | C | no | ssh_agent_registration |
|
|
21
|
+
| `server.agent_manifests` | `P.EmptyParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | R-meta | no | — |
|
|
22
|
+
| `server.reload_agent_manifests` | `P.EmptyParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | S | no | — |
|
|
23
|
+
|
|
24
|
+
## notification
|
|
25
|
+
|
|
26
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
27
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
28
|
+
| `notification.show` | `P.NotificationShowParams` | `notification_show` | name | W | no | — |
|
|
29
|
+
|
|
30
|
+
## product_announcement
|
|
31
|
+
|
|
32
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
33
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
34
|
+
| `product_announcement.dismiss` | `P.ProductAnnouncementDismissParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
35
|
+
|
|
36
|
+
## release_notes
|
|
37
|
+
|
|
38
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
39
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
40
|
+
| `release_notes.dismiss` | `P.ReleaseNotesDismissParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
41
|
+
|
|
42
|
+
## command
|
|
43
|
+
|
|
44
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
45
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
46
|
+
| `command.invoke` | `P.CommandInvokeParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | X | no | — |
|
|
47
|
+
|
|
48
|
+
## client
|
|
49
|
+
|
|
50
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
51
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
52
|
+
| `client.window_title.set` | `P.ClientWindowTitleSetParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | C | no | — |
|
|
53
|
+
| `client.window_title.clear` | `P.EmptyParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | C | no | — |
|
|
54
|
+
|
|
55
|
+
## client_shell
|
|
56
|
+
|
|
57
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
58
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
59
|
+
| `client_shell.surface.set` | `P.ClientShellSurfaceSetParams` | `client_shell_surface_set` | name | C | no | surface_interest |
|
|
60
|
+
|
|
61
|
+
## session
|
|
62
|
+
|
|
63
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
64
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
65
|
+
| `session.snapshot` | `P.EmptyParams` | `session_snapshot` | seed | R-meta | no | — |
|
|
66
|
+
|
|
67
|
+
## workspace
|
|
68
|
+
|
|
69
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
70
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
71
|
+
| `workspace.create` | `P.WorkspaceCreateParams` | `workspace_created` | seed | W | no | — |
|
|
72
|
+
| `workspace.list` | `P.EmptyParams` | `workspace_list` | seed | R-meta | no | — |
|
|
73
|
+
| `workspace.get` | `P.WorkspaceTarget` | `workspace_info` | seed | R-meta | no | — |
|
|
74
|
+
| `workspace.focus` | `P.WorkspaceTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
75
|
+
| `workspace.rename` | `P.WorkspaceRenameParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
76
|
+
| `workspace.move` | `P.WorkspaceMoveParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
77
|
+
| `workspace.move_block` | `P.WorkspaceMoveBlockParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
78
|
+
| `workspace.report_metadata` | `P.WorkspaceReportMetadataParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | H | no | — |
|
|
79
|
+
| `workspace.close` | `P.WorkspaceCloseParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | D | no | — |
|
|
80
|
+
|
|
81
|
+
## worktree
|
|
82
|
+
|
|
83
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
84
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
85
|
+
| `worktree.list` | `P.WorktreeListParams` | `worktree_list` | seed | R-meta | no | — |
|
|
86
|
+
| `worktree.create` | `P.WorktreeCreateParams` | `worktree_created` | seed | W | no | — |
|
|
87
|
+
| `worktree.open` | `P.WorktreeOpenParams` | `worktree_opened` | seed | W | no | — |
|
|
88
|
+
| `worktree.remove` | `P.WorktreeRemoveParams` | `worktree_removed` | seed | D | no | — |
|
|
89
|
+
|
|
90
|
+
## tab
|
|
91
|
+
|
|
92
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
93
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
94
|
+
| `tab.create` | `P.TabCreateParams` | `tab_created` | seed | W | no | — |
|
|
95
|
+
| `tab.list` | `P.TabListParams` | `tab_list` | seed | R-meta | no | — |
|
|
96
|
+
| `tab.get` | `P.TabTarget` | `tab_info` | seed | R-meta | no | — |
|
|
97
|
+
| `tab.focus` | `P.TabTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
98
|
+
| `tab.rename` | `P.TabRenameParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
99
|
+
| `tab.move` | `P.TabMoveParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
100
|
+
| `tab.close` | `P.TabTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | D | no | — |
|
|
101
|
+
|
|
102
|
+
## agent
|
|
103
|
+
|
|
104
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
105
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
106
|
+
| `agent.list` | `P.EmptyParams` | `agent_list` | seed | R-meta | no | — |
|
|
107
|
+
| `agent.get` | `P.AgentTarget` | `agent_info` | seed | R-meta | no | — |
|
|
108
|
+
| `agent.read` | `P.AgentReadParams` | `pane_read` | seed | R-content | no | — |
|
|
109
|
+
| `agent.explain` | `P.AgentTarget` | `agent_explain` | name | R-meta | no | — |
|
|
110
|
+
| `agent.send_keys` | `P.AgentSendKeysParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | I | no | — |
|
|
111
|
+
| `agent.rename` | `P.AgentRenameParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
112
|
+
| `agent.view.set` | `P.AgentViewSetParams` | `agent_view` | seed | W | no | — |
|
|
113
|
+
| `agent.view.clear` | `P.AgentViewClearParams` | `agent_view` | seed | W | no | — |
|
|
114
|
+
| `agent.focus` | `P.AgentTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
115
|
+
| `agent.start` | `P.AgentStartParams` | `agent_started` | seed | X | yes | — |
|
|
116
|
+
| `agent.prompt` | `P.AgentPromptParams` | `agent_prompted` | seed | I | yes | — |
|
|
117
|
+
| `agent.wait` | `P.AgentWaitParams` | `agent_info` | seed | L | yes | — |
|
|
118
|
+
|
|
119
|
+
## pane
|
|
120
|
+
|
|
121
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
122
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
123
|
+
| `pane.split` | `P.PaneSplitParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
124
|
+
| `pane.swap` | `P.PaneSwapParams` | `pane_swap` | name | W | no | — |
|
|
125
|
+
| `pane.move` | `P.PaneMoveParams` | `pane_move` | name | W | no | — |
|
|
126
|
+
| `pane.zoom` | `P.PaneZoomParams` | `pane_zoom` | name | W | no | — |
|
|
127
|
+
| `pane.layout` | `P.PaneLayoutParams` | `pane_layout` | name | R-meta | no | — |
|
|
128
|
+
| `pane.process_info` | `P.PaneProcessInfoParams` | `pane_process_info` | name | R-meta | no | — |
|
|
129
|
+
| `pane.neighbor` | `P.PaneNeighborParams` | `pane_neighbor` | name | R-meta | no | — |
|
|
130
|
+
| `pane.edges` | `P.PaneEdgesParams` | `pane_edges` | name | R-meta | no | — |
|
|
131
|
+
| `pane.focus_direction` | `P.PaneFocusDirectionParams` | `pane_focus_direction` | name | W | no | — |
|
|
132
|
+
| `pane.resize` | `P.PaneResizeParams` | `pane_resize` | name | W | no | — |
|
|
133
|
+
| `pane.scroll` | `P.PaneScrollParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
134
|
+
| `pane.clear` | `P.PaneTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
135
|
+
| `pane.edit_scrollback` | `P.PaneTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | X | no | — |
|
|
136
|
+
| `pane.selection.read` | `P.PaneSelectionReadParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | R-content | no | — |
|
|
137
|
+
| `pane.copy_motion` | `P.PaneCopyMotionParams` | `pane_copy_motion` | name | W | no | — |
|
|
138
|
+
| `pane.copy_search` | `P.PaneCopySearchParams` | `pane_copy_search` | name | W | no | — |
|
|
139
|
+
| `pane.list` | `P.PaneListParams` | `pane_list` | seed | R-meta | no | — |
|
|
140
|
+
| `pane.current` | `P.PaneCurrentParams` | `pane_current` | seed | R-meta | no | — |
|
|
141
|
+
| `pane.get` | `P.PaneTarget` | `pane_info` | seed | R-meta | no | — |
|
|
142
|
+
| `pane.focus` | `P.PaneTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
143
|
+
| `pane.input.set` | `P.PaneInputSetParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | I | no | — |
|
|
144
|
+
| `pane.link.activate` | `P.PaneLinkActivateParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | X | no | — |
|
|
145
|
+
| `pane.link.resolve` | `P.PaneLinkActivateParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | R-meta | no | — |
|
|
146
|
+
| `pane.rename` | `P.PaneRenameParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
147
|
+
| `pane.send_text` | `P.PaneSendTextParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | I | no | — |
|
|
148
|
+
| `pane.send_keys` | `P.PaneSendKeysParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | I | no | — |
|
|
149
|
+
| `pane.send_input` | `P.PaneSendInputParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | I | no | — |
|
|
150
|
+
| `pane.read` | `P.PaneReadParams` | `pane_read` | seed | R-content | no | — |
|
|
151
|
+
| `pane.report_agent` | `P.PaneReportAgentParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | H | no | — |
|
|
152
|
+
| `pane.report_agent_session` | `P.PaneReportAgentSessionParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | H | no | — |
|
|
153
|
+
| `pane.report_metadata` | `P.PaneReportMetadataParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | H | no | — |
|
|
154
|
+
| `pane.clear_agent_authority` | `P.PaneClearAgentAuthorityParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | H | no | — |
|
|
155
|
+
| `pane.release_agent` | `P.PaneReleaseAgentParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | H | no | — |
|
|
156
|
+
| `pane.close` | `P.PaneTarget` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | D | no | — |
|
|
157
|
+
| `pane.wait_for_output` | `P.PaneWaitForOutputParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | L | yes | — |
|
|
158
|
+
|
|
159
|
+
## layout
|
|
160
|
+
|
|
161
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
162
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
163
|
+
| `layout.export` | `P.LayoutExportParams` | `layout_export` | name | R-meta | no | — |
|
|
164
|
+
| `layout.apply` | `P.LayoutApplyParams` | `layout_apply` | name | W | no | — |
|
|
165
|
+
| `layout.set_split_ratio` | `P.LayoutSetSplitRatioParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
166
|
+
|
|
167
|
+
## popup
|
|
168
|
+
|
|
169
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
170
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
171
|
+
| `popup.close` | `P.EmptyParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | D | no | — |
|
|
172
|
+
|
|
173
|
+
## events
|
|
174
|
+
|
|
175
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
176
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
177
|
+
| `events.subscribe` | `P.EventsSubscribeParams` | `subscription_started` | seed | L | yes | — |
|
|
178
|
+
| `events.wait` | `P.EventsWaitParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | L | yes | — |
|
|
179
|
+
|
|
180
|
+
## integration
|
|
181
|
+
|
|
182
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
183
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
184
|
+
| `integration.list` | `P.EmptyParams` | `integration_list` | name | R-meta | no | — |
|
|
185
|
+
| `integration.install` | `P.IntegrationInstallParams` | `integration_install` | name | X | no | — |
|
|
186
|
+
| `integration.uninstall` | `P.IntegrationUninstallParams` | `integration_uninstall` | name | D | no | — |
|
|
187
|
+
|
|
188
|
+
## plugin
|
|
189
|
+
|
|
190
|
+
| Method | Params type | Result tag | Source | Class | Long-poll | Gate |
|
|
191
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
192
|
+
| `plugin.link` | `P.PluginLinkParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | X | no | — |
|
|
193
|
+
| `plugin.list` | `P.PluginListParams` | `plugin_list` | name | R-meta | no | — |
|
|
194
|
+
| `plugin.unlink` | `P.PluginUnlinkParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | D | no | — |
|
|
195
|
+
| `plugin.enable` | `P.PluginSetEnabledParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | X | no | — |
|
|
196
|
+
| `plugin.disable` | `P.PluginSetEnabledParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
197
|
+
| `plugin.action.list` | `P.PluginActionListParams` | `plugin_action_list` | name | R-meta | no | — |
|
|
198
|
+
| `plugin.action.invoke` | `P.PluginActionInvokeParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | X | no | — |
|
|
199
|
+
| `plugin.log.list` | `P.PluginLogListParams` | `plugin_log_list` | name | R-meta | no | — |
|
|
200
|
+
| `plugin.pane.open` | `P.PluginPaneOpenParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | X | no | — |
|
|
201
|
+
| `plugin.pane.focus` | `P.PluginPaneFocusParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | W | no | — |
|
|
202
|
+
| `plugin.pane.close` | `P.PluginPaneCloseParams` | — | tag unverified: no herdr docs on this machine for 0.9.5; ResponseResult until phase 5b records it | D | no | — |
|
|
203
|
+
|
|
204
|
+
## Class counts
|
|
205
|
+
|
|
206
|
+
| Class | Methods |
|
|
207
|
+
| --- | --- |
|
|
208
|
+
| R-meta | 24 |
|
|
209
|
+
| R-content | 3 |
|
|
210
|
+
| W | 34 |
|
|
211
|
+
| I | 6 |
|
|
212
|
+
| H | 6 |
|
|
213
|
+
| L | 4 |
|
|
214
|
+
| C | 4 |
|
|
215
|
+
| X | 9 |
|
|
216
|
+
| D | 8 |
|
|
217
|
+
| S | 4 |
|
|
218
|
+
|
|
219
|
+
## Entry points
|
|
220
|
+
|
|
221
|
+
Each entry point lists the classes it carries (`ENTRY_CLASSES` in tools/gen/capabilities.ts). The prompt entry also carries `agent.prompt`.
|
|
222
|
+
|
|
223
|
+
| Entry | R-meta | R-content | W | I | H | L | C | X | D | S |
|
|
224
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
225
|
+
| `readOnly` | yes | no | no | no | no | yes | no | no | no | no |
|
|
226
|
+
| `readOnlyContent` | yes | yes | no | no | no | yes | no | no | no | no |
|
|
227
|
+
| `prompt` | yes | no | no | no | no | no | no | no | no | no |
|
|
228
|
+
| `client` | yes | yes | yes | yes | yes | yes | no | no | no | no |
|
|
229
|
+
| `admin` | yes | yes | yes | yes | yes | yes | no | yes | yes | yes |
|
|
230
|
+
| `held` | no | no | no | no | no | no | yes | no | no | no |
|
|
231
|
+
|
|
232
|
+
Expanded entry methods: readOnly 28, readOnlyContent 31, prompt 25, client 77, admin 98, held 4.
|
package/package.json
CHANGED
|
@@ -1,6 +1,114 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stateforge-labs/herdr-sdk",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"sideEffects": false,
|
|
6
|
+
"description": "Typed client for the herdr socket API (protocol 22), generated from herdr's published schema.",
|
|
7
|
+
"license": "MIT",
|
|
8
|
+
"keywords": [
|
|
9
|
+
"herdr",
|
|
10
|
+
"herdr-core",
|
|
11
|
+
"terminal-multiplexer",
|
|
12
|
+
"coding-agents",
|
|
13
|
+
"unix-socket",
|
|
14
|
+
"json-rpc",
|
|
15
|
+
"sdk",
|
|
16
|
+
"typescript"
|
|
17
|
+
],
|
|
18
|
+
"author": "stateforge-labs",
|
|
19
|
+
"homepage": "https://github.com/stateforge-labs/herdr-sdk#readme",
|
|
20
|
+
"bugs": {
|
|
21
|
+
"url": "https://github.com/stateforge-labs/herdr-sdk/issues"
|
|
22
|
+
},
|
|
23
|
+
"repository": {
|
|
24
|
+
"type": "git",
|
|
25
|
+
"url": "git+https://github.com/stateforge-labs/herdr-sdk.git"
|
|
26
|
+
},
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public",
|
|
29
|
+
"registry": "https://registry.npmjs.org/",
|
|
30
|
+
"provenance": true
|
|
31
|
+
},
|
|
32
|
+
"herdr": {
|
|
33
|
+
"protocol": 22,
|
|
34
|
+
"schemaVersion": 1,
|
|
35
|
+
"testedWith": "0.9.5"
|
|
36
|
+
},
|
|
37
|
+
"engines": {
|
|
38
|
+
"node": ">=22.18"
|
|
39
|
+
},
|
|
40
|
+
"exports": {
|
|
41
|
+
".": {
|
|
42
|
+
"types": "./dist/index.d.ts",
|
|
43
|
+
"default": "./dist/index.js"
|
|
44
|
+
},
|
|
45
|
+
"./read-only": {
|
|
46
|
+
"types": "./dist/read-only.d.ts",
|
|
47
|
+
"default": "./dist/read-only.js"
|
|
48
|
+
},
|
|
49
|
+
"./admin": {
|
|
50
|
+
"types": "./dist/admin.d.ts",
|
|
51
|
+
"default": "./dist/admin.js"
|
|
52
|
+
},
|
|
53
|
+
"./effect": {
|
|
54
|
+
"types": "./dist/effect.d.ts",
|
|
55
|
+
"default": "./dist/effect.js"
|
|
56
|
+
},
|
|
57
|
+
"./schema": {
|
|
58
|
+
"types": "./dist/schema.d.ts",
|
|
59
|
+
"default": "./dist/schema.js"
|
|
60
|
+
},
|
|
61
|
+
"./drift": {
|
|
62
|
+
"types": "./dist/drift.d.ts",
|
|
63
|
+
"default": "./dist/drift.js"
|
|
64
|
+
},
|
|
65
|
+
"./test-kit": {
|
|
66
|
+
"types": "./dist/test-kit.d.ts",
|
|
67
|
+
"default": "./dist/test-kit.js"
|
|
68
|
+
},
|
|
69
|
+
"./core": {
|
|
70
|
+
"types": "./dist/core.d.ts",
|
|
71
|
+
"default": "./dist/core.js"
|
|
72
|
+
},
|
|
73
|
+
"./core/test-kit": {
|
|
74
|
+
"types": "./dist/core-test-kit.d.ts",
|
|
75
|
+
"default": "./dist/core-test-kit.js"
|
|
76
|
+
},
|
|
77
|
+
"./package.json": "./package.json"
|
|
78
|
+
},
|
|
79
|
+
"files": [
|
|
80
|
+
"dist",
|
|
81
|
+
"bin",
|
|
82
|
+
"schema",
|
|
83
|
+
"skills",
|
|
84
|
+
"docs/api",
|
|
85
|
+
"README.md",
|
|
86
|
+
"LICENSE",
|
|
87
|
+
"NOTICE.md"
|
|
88
|
+
],
|
|
89
|
+
"scripts": {
|
|
90
|
+
"gen": "bun tools/gen/index.ts",
|
|
91
|
+
"capture": "bun tools/scripts/capture-schema.ts",
|
|
92
|
+
"test": "bun test",
|
|
93
|
+
"test:gen": "bun test test/tools/gen",
|
|
94
|
+
"check:pins": "bun tools/scripts/check-pins.ts",
|
|
95
|
+
"lint:layers": "bun tools/scripts/check-layers.ts",
|
|
96
|
+
"typecheck": "tsc --noEmit -p . && tsc --noEmit -p tsconfig.test.json",
|
|
97
|
+
"typecheck:types": "tsc -p test/types",
|
|
98
|
+
"build:test": "tsc -p tsconfig.dist-test.json",
|
|
99
|
+
"test:node": "bun run build:test && node --test --test-reporter=tap \"dist-test/test/herdr/wire/**/*.test.js\" \"dist-test/test/herdr/client/connect/**/*.test.js\" > dist-test/node-tap.txt; status=$?; cat dist-test/node-tap.txt; [ $status -eq 0 ] && grep -Eq \"^# tests [1-9]\" dist-test/node-tap.txt",
|
|
100
|
+
"test:wire": "bun test test/herdr/wire test/herdr/client/connect",
|
|
101
|
+
"build": "rm -rf dist && tsc -p tsconfig.build.json && tsc -p tsconfig.build-test-kit.json && bun tools/scripts/rewrite-dts.ts",
|
|
102
|
+
"prepack": "bun run build",
|
|
103
|
+
"check:size": "bun run build && bun tools/scripts/check-size.ts",
|
|
104
|
+
"pretest": "bun run build"
|
|
105
|
+
},
|
|
106
|
+
"devDependencies": {
|
|
107
|
+
"@types/node": "22.20.5",
|
|
108
|
+
"typescript": "7.0.2"
|
|
109
|
+
},
|
|
110
|
+
"bin": {
|
|
111
|
+
"herdr-drift": "./bin/herdr-drift.js",
|
|
112
|
+
"herdr-skill": "./bin/herdr-skill.js"
|
|
113
|
+
}
|
|
114
|
+
}
|