@kybernesis/dispatch 0.1.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 +202 -0
- package/NOTICE +2 -0
- package/README.md +84 -0
- package/dist/channel.d.ts +66 -0
- package/dist/channel.js +61 -0
- package/dist/index.d.ts +25 -0
- package/dist/index.js +25 -0
- package/dist/remote-peer.d.ts +60 -0
- package/dist/remote-peer.js +39 -0
- package/package.json +51 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# @kybernesis/dispatch
|
|
2
|
+
|
|
3
|
+
Agent-to-agent dispatch for [eve](https://eve.dev) agents: declared remote-peer
|
|
4
|
+
edges with principal forwarding on by default, and a receiver channel that makes
|
|
5
|
+
trusting the wrong caller hard to express.
|
|
6
|
+
|
|
7
|
+
Two separately deployed eve agents talk over a declared **edge**. The caller
|
|
8
|
+
mounts a `remotePeer` under `agent/subagents/`; the receiver authors its eve
|
|
9
|
+
channel with `dispatchChannel`. Underneath is eve's native `defineRemoteAgent`
|
|
10
|
+
transport — durable park-and-resume dispatch, retried callbacks, recursive
|
|
11
|
+
cancellation — with the governance defaults locked in.
|
|
12
|
+
|
|
13
|
+
## Caller side — one file per peer
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
// agent/subagents/gtm.ts (file name = tool name the model sees)
|
|
17
|
+
import { remotePeer } from "@kybernesis/dispatch";
|
|
18
|
+
|
|
19
|
+
export default remotePeer({
|
|
20
|
+
envVar: "GTM_AGENT_URL",
|
|
21
|
+
description:
|
|
22
|
+
"The company's GTM operator: posting cadence and history, open go-to-market plays, outreach targets, LinkedIn/X content drafting in the house voice.",
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The `description` is a **routing hint**, not documentation: the calling agent's
|
|
27
|
+
model reads it to decide when to delegate. Write the concrete topics people
|
|
28
|
+
actually ask about. A vague description means the edge never fires.
|
|
29
|
+
|
|
30
|
+
Defaults you'd otherwise have to remember: outbound auth is Vercel OIDC, the
|
|
31
|
+
URL resolves from env at runtime (no rebuild to repoint), and
|
|
32
|
+
`forwardPrincipal: true` — the peer runs as the human who asked, so its memory
|
|
33
|
+
scoping, per-user connections, and telemetry attribution see the real person.
|
|
34
|
+
|
|
35
|
+
## Receiver side — enumerate your peers
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
// agent/channels/eve.ts
|
|
39
|
+
import { dispatchChannel } from "@kybernesis/dispatch";
|
|
40
|
+
|
|
41
|
+
export default dispatchChannel({
|
|
42
|
+
trustedPeers: [{ teamSlug: "acme", projectName: "acme-router" }],
|
|
43
|
+
});
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
One declaration feeds both trust surfaces — the OIDC `subjects` allowlist
|
|
47
|
+
(which deployments may call at all) and the `trustedForwarders` predicate
|
|
48
|
+
(which of them may assert an end-user identity) — so the two can never drift
|
|
49
|
+
apart. There is deliberately no predicate form: `trustedForwarders: () => true`
|
|
50
|
+
(any authenticated caller asserts any identity, including your own preview
|
|
51
|
+
deployments) is not expressible through this API. Peers default to
|
|
52
|
+
`environment: "production"`; previews are never trusted implicitly.
|
|
53
|
+
|
|
54
|
+
Your own project's deployments and `eve dev` keep working (current-project
|
|
55
|
+
OIDC bypass + `localDev()`); production browser traffic stays rejected unless
|
|
56
|
+
you pass your app's real auth via `extraAuth`.
|
|
57
|
+
|
|
58
|
+
## Bidirectional edges
|
|
59
|
+
|
|
60
|
+
Answering is built into one edge — the caller parks until the peer's terminal
|
|
61
|
+
callback arrives, so request and response are one round trip on one wire. Add
|
|
62
|
+
the mirror-image files only when the *other* agent should also be able to
|
|
63
|
+
**initiate**: each direction is its own declared edge.
|
|
64
|
+
|
|
65
|
+
## Operational rules
|
|
66
|
+
|
|
67
|
+
- **Scheduled/proactive turns have no human to forward.** A turn triggered by
|
|
68
|
+
a cron schedule carries no signed-in principal, so a dispatch made from it
|
|
69
|
+
reaches the peer as the calling app's service identity even with
|
|
70
|
+
`forwardPrincipal: true`. Design peer-side capabilities that scheduled turns
|
|
71
|
+
rely on to be app-scoped (static keys), not user-scoped.
|
|
72
|
+
|
|
73
|
+
- **Upgrade both ends of an edge together.** A receiver on an eve version
|
|
74
|
+
predating principal forwarding silently drops it and runs the session as the
|
|
75
|
+
calling app's service identity — a security downgrade with no error.
|
|
76
|
+
- The env var (`GTM_AGENT_URL` above) holds the peer's stable production URL.
|
|
77
|
+
Unset with no `fallbackUrl` fails the dispatch loudly — intended.
|
|
78
|
+
- Remote peers trace under their own deployment. Correlate hops in your
|
|
79
|
+
observability via the `eve:forwarded-by` attribute and the child session id
|
|
80
|
+
on the caller's `subagent.called` event.
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
Apache-2.0
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { eveChannel } from "eve/channels/eve";
|
|
2
|
+
import { type VercelSubjectEnvironment } from "eve/channels/auth";
|
|
3
|
+
/**
|
|
4
|
+
* A peer deployment allowed to call this agent, named by its Vercel identity.
|
|
5
|
+
*
|
|
6
|
+
* Slugs, not IDs: `teamSlug` and `projectName` are the values embedded in the
|
|
7
|
+
* OIDC `sub` claim (what `vercel ls` shows), not `team_…`/`prj_…` IDs. They
|
|
8
|
+
* may not contain `*` or `:` — the underlying `vercelSubject` helper rejects
|
|
9
|
+
* wildcarded inputs so a typo cannot silently widen trust.
|
|
10
|
+
*/
|
|
11
|
+
export interface PeerRef {
|
|
12
|
+
/** Vercel team slug of the peer deployment (e.g. `"acme"`). */
|
|
13
|
+
teamSlug: string;
|
|
14
|
+
/** Vercel project name of the peer deployment (e.g. `"acme-router"`). */
|
|
15
|
+
projectName: string;
|
|
16
|
+
/**
|
|
17
|
+
* Which environment of the peer to trust. Defaults to `"production"` so a
|
|
18
|
+
* preview deployment can never assert identities against this agent unless
|
|
19
|
+
* you opt in explicitly.
|
|
20
|
+
*/
|
|
21
|
+
environment?: VercelSubjectEnvironment;
|
|
22
|
+
}
|
|
23
|
+
/** Compose the OIDC subject string for a peer. Exposed for doctor checks and tests. */
|
|
24
|
+
export declare function peerSubject(peer: PeerRef): string;
|
|
25
|
+
/** Options for {@link dispatchChannel}. */
|
|
26
|
+
export interface DispatchChannelOptions {
|
|
27
|
+
/**
|
|
28
|
+
* The deployments allowed to call this agent AND assert a forwarded
|
|
29
|
+
* end-user principal. Must be non-empty — an agent with no peers should
|
|
30
|
+
* simply not author a dispatch channel. There is deliberately no predicate
|
|
31
|
+
* form: enumerating concrete peers is the whole point.
|
|
32
|
+
*/
|
|
33
|
+
trustedPeers: readonly PeerRef[];
|
|
34
|
+
/**
|
|
35
|
+
* Extra `AuthFn`s appended to the walk (e.g. your web app's auth for a
|
|
36
|
+
* browser frontend). The Vercel OIDC verifier for peers always runs first.
|
|
37
|
+
*/
|
|
38
|
+
extraAuth?: Parameters<typeof eveChannel>[0] extends {
|
|
39
|
+
auth?: infer A;
|
|
40
|
+
} ? A : never;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* The receiving side of an agent-to-agent edge: an authored eve channel that
|
|
44
|
+
* accepts calls — and forwarded end-user principals — from exactly the peers
|
|
45
|
+
* you enumerate.
|
|
46
|
+
*
|
|
47
|
+
* ```ts title="agent/channels/eve.ts"
|
|
48
|
+
* import { dispatchChannel } from "@kybernesis/dispatch";
|
|
49
|
+
*
|
|
50
|
+
* export default dispatchChannel({
|
|
51
|
+
* trustedPeers: [{ teamSlug: "acme", projectName: "acme-router" }],
|
|
52
|
+
* });
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* What you get over hand-rolling `eveChannel`:
|
|
56
|
+
*
|
|
57
|
+
* - Cross-project callers are enumerated in the OIDC `subjects` list AND the
|
|
58
|
+
* `trustedForwarders` predicate from one declaration — the two lists cannot
|
|
59
|
+
* drift apart.
|
|
60
|
+
* - `trustedForwarders: () => true` is not expressible: trust is a list of
|
|
61
|
+
* concrete Vercel projects, never a function you can accidentally widen.
|
|
62
|
+
* - This project's own deployments and `eve dev` keep working (current-project
|
|
63
|
+
* OIDC bypass + `localDev()`), and production browser traffic stays rejected
|
|
64
|
+
* via `placeholderAuth()` unless you pass real auth in `extraAuth`.
|
|
65
|
+
*/
|
|
66
|
+
export declare function dispatchChannel(options: DispatchChannelOptions): import("eve/channels/eve").EveChannel;
|
package/dist/channel.js
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { eveChannel } from "eve/channels/eve";
|
|
2
|
+
import { localDev, placeholderAuth, vercelOidc, vercelSubject, } from "eve/channels/auth";
|
|
3
|
+
/** Compose the OIDC subject string for a peer. Exposed for doctor checks and tests. */
|
|
4
|
+
export function peerSubject(peer) {
|
|
5
|
+
return vercelSubject({
|
|
6
|
+
teamSlug: peer.teamSlug,
|
|
7
|
+
projectName: peer.projectName,
|
|
8
|
+
...(peer.environment !== undefined
|
|
9
|
+
? { environment: peer.environment }
|
|
10
|
+
: {}),
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* The receiving side of an agent-to-agent edge: an authored eve channel that
|
|
15
|
+
* accepts calls — and forwarded end-user principals — from exactly the peers
|
|
16
|
+
* you enumerate.
|
|
17
|
+
*
|
|
18
|
+
* ```ts title="agent/channels/eve.ts"
|
|
19
|
+
* import { dispatchChannel } from "@kybernesis/dispatch";
|
|
20
|
+
*
|
|
21
|
+
* export default dispatchChannel({
|
|
22
|
+
* trustedPeers: [{ teamSlug: "acme", projectName: "acme-router" }],
|
|
23
|
+
* });
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* What you get over hand-rolling `eveChannel`:
|
|
27
|
+
*
|
|
28
|
+
* - Cross-project callers are enumerated in the OIDC `subjects` list AND the
|
|
29
|
+
* `trustedForwarders` predicate from one declaration — the two lists cannot
|
|
30
|
+
* drift apart.
|
|
31
|
+
* - `trustedForwarders: () => true` is not expressible: trust is a list of
|
|
32
|
+
* concrete Vercel projects, never a function you can accidentally widen.
|
|
33
|
+
* - This project's own deployments and `eve dev` keep working (current-project
|
|
34
|
+
* OIDC bypass + `localDev()`), and production browser traffic stays rejected
|
|
35
|
+
* via `placeholderAuth()` unless you pass real auth in `extraAuth`.
|
|
36
|
+
*/
|
|
37
|
+
export function dispatchChannel(options) {
|
|
38
|
+
const peers = options.trustedPeers;
|
|
39
|
+
if (!Array.isArray(peers) || peers.length === 0) {
|
|
40
|
+
throw new Error("dispatchChannel: trustedPeers must name at least one peer deployment — an agent with no peers should not author a dispatch channel.");
|
|
41
|
+
}
|
|
42
|
+
const subjects = peers.map(peerSubject);
|
|
43
|
+
const subjectSet = new Set(subjects);
|
|
44
|
+
const extra = (options.extraAuth ?? []);
|
|
45
|
+
return eveChannel({
|
|
46
|
+
auth: [
|
|
47
|
+
// Verifies which deployment is calling: this project's own tokens are
|
|
48
|
+
// always accepted; other projects only when enumerated as peers.
|
|
49
|
+
vercelOidc({ subjects }),
|
|
50
|
+
// Open on localhost for `eve dev` and the REPL; ignored in production.
|
|
51
|
+
localDev(),
|
|
52
|
+
...extra,
|
|
53
|
+
// Rejects production browser traffic with a structured 401 unless the
|
|
54
|
+
// caller passed real auth above.
|
|
55
|
+
placeholderAuth(),
|
|
56
|
+
],
|
|
57
|
+
// Only enumerated peers may assert a forwarded end-user principal.
|
|
58
|
+
trustedForwarders: (forwarder) => typeof forwarder.subject === "string" &&
|
|
59
|
+
subjectSet.has(forwarder.subject),
|
|
60
|
+
});
|
|
61
|
+
}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @kybernesis/dispatch — agent-to-agent dispatch for eve agents.
|
|
3
|
+
*
|
|
4
|
+
* Two deployed eve agents talk over a declared edge: the caller mounts a
|
|
5
|
+
* {@link remotePeer} under `agent/subagents/`, the receiver authors its eve
|
|
6
|
+
* channel with {@link dispatchChannel}. Together they give you eve's native
|
|
7
|
+
* `defineRemoteAgent` transport (durable park-and-resume dispatch) with the
|
|
8
|
+
* Kybernesis defaults locked in:
|
|
9
|
+
*
|
|
10
|
+
* - **Principal forwarding on by default** — the receiving agent runs as the
|
|
11
|
+
* human who asked, so memory scoping, per-user connections, and telemetry
|
|
12
|
+
* attribution compose across the hop unchanged.
|
|
13
|
+
* - **Peers are pinned, never open** — `dispatchChannel` only accepts an
|
|
14
|
+
* enumerated list of Vercel projects. The `trustedForwarders: () => true`
|
|
15
|
+
* footgun (any authenticated caller may assert any identity) is not
|
|
16
|
+
* expressible through this API.
|
|
17
|
+
* - **URLs come from env** — edges resolve their target at runtime, so
|
|
18
|
+
* repointing an agent never needs a rebuild.
|
|
19
|
+
*
|
|
20
|
+
* Both deployments must run compatible eve versions: a receiver predating
|
|
21
|
+
* principal forwarding silently drops it and runs the session as the calling
|
|
22
|
+
* app's service identity. Upgrade both ends of an edge together.
|
|
23
|
+
*/
|
|
24
|
+
export { remotePeer, type RemotePeerOptions } from "./remote-peer.js";
|
|
25
|
+
export { dispatchChannel, peerSubject, type DispatchChannelOptions, type PeerRef, } from "./channel.js";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @kybernesis/dispatch — agent-to-agent dispatch for eve agents.
|
|
3
|
+
*
|
|
4
|
+
* Two deployed eve agents talk over a declared edge: the caller mounts a
|
|
5
|
+
* {@link remotePeer} under `agent/subagents/`, the receiver authors its eve
|
|
6
|
+
* channel with {@link dispatchChannel}. Together they give you eve's native
|
|
7
|
+
* `defineRemoteAgent` transport (durable park-and-resume dispatch) with the
|
|
8
|
+
* Kybernesis defaults locked in:
|
|
9
|
+
*
|
|
10
|
+
* - **Principal forwarding on by default** — the receiving agent runs as the
|
|
11
|
+
* human who asked, so memory scoping, per-user connections, and telemetry
|
|
12
|
+
* attribution compose across the hop unchanged.
|
|
13
|
+
* - **Peers are pinned, never open** — `dispatchChannel` only accepts an
|
|
14
|
+
* enumerated list of Vercel projects. The `trustedForwarders: () => true`
|
|
15
|
+
* footgun (any authenticated caller may assert any identity) is not
|
|
16
|
+
* expressible through this API.
|
|
17
|
+
* - **URLs come from env** — edges resolve their target at runtime, so
|
|
18
|
+
* repointing an agent never needs a rebuild.
|
|
19
|
+
*
|
|
20
|
+
* Both deployments must run compatible eve versions: a receiver predating
|
|
21
|
+
* principal forwarding silently drops it and runs the session as the calling
|
|
22
|
+
* app's service identity. Upgrade both ends of an edge together.
|
|
23
|
+
*/
|
|
24
|
+
export { remotePeer } from "./remote-peer.js";
|
|
25
|
+
export { dispatchChannel, peerSubject, } from "./channel.js";
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { defineRemoteAgent } from "eve";
|
|
2
|
+
/** Options for {@link remotePeer}. */
|
|
3
|
+
export interface RemotePeerOptions {
|
|
4
|
+
/**
|
|
5
|
+
* Environment variable holding the peer deployment's URL (e.g.
|
|
6
|
+
* `"GTM_AGENT_URL"`). Read at runtime on every dispatch, so repointing the
|
|
7
|
+
* edge is an env change, not a rebuild.
|
|
8
|
+
*/
|
|
9
|
+
envVar: string;
|
|
10
|
+
/**
|
|
11
|
+
* Fallback URL when the env var is unset. Optional — without it, a missing
|
|
12
|
+
* env var fails the dispatch loudly, which is usually what you want in a
|
|
13
|
+
* fresh environment.
|
|
14
|
+
*/
|
|
15
|
+
fallbackUrl?: string;
|
|
16
|
+
/**
|
|
17
|
+
* The routing hint. The calling agent's model reads this to decide when to
|
|
18
|
+
* delegate here — write it like the specialist's job description, with the
|
|
19
|
+
* concrete topics people actually ask about, not a generic blurb. A vague
|
|
20
|
+
* description means the edge never fires (or fires for the wrong asks).
|
|
21
|
+
*/
|
|
22
|
+
description: string;
|
|
23
|
+
/**
|
|
24
|
+
* Forward the verified end-user principal across the hop (default `true`).
|
|
25
|
+
* The receiver must name this deployment in its `dispatchChannel`
|
|
26
|
+
* `trustedPeers` for the assertion to be accepted — otherwise the dispatch
|
|
27
|
+
* fails with a 403 rather than silently downgrading.
|
|
28
|
+
*
|
|
29
|
+
* Set `false` only when the peer should treat calls as coming from this
|
|
30
|
+
* app itself (service identity) rather than from the human behind it.
|
|
31
|
+
*/
|
|
32
|
+
forwardPrincipal?: boolean;
|
|
33
|
+
/**
|
|
34
|
+
* JSON Schema for task-mode structured output. When set, the peer returns
|
|
35
|
+
* one validated result object instead of free text.
|
|
36
|
+
*/
|
|
37
|
+
outputSchema?: Parameters<typeof defineRemoteAgent>[0]["outputSchema"];
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Declares a separately deployed eve agent as a callable peer of this agent.
|
|
41
|
+
*
|
|
42
|
+
* Mount under `agent/subagents/<name>.ts` — the file name becomes the tool
|
|
43
|
+
* name the model sees. Lowers to the same `{ message }` tool shape as a local
|
|
44
|
+
* subagent, with eve's durable dispatch underneath: the calling turn parks
|
|
45
|
+
* without holding compute until the peer posts its terminal callback.
|
|
46
|
+
*
|
|
47
|
+
* ```ts title="agent/subagents/gtm.ts"
|
|
48
|
+
* import { remotePeer } from "@kybernesis/dispatch";
|
|
49
|
+
*
|
|
50
|
+
* export default remotePeer({
|
|
51
|
+
* envVar: "GTM_AGENT_URL",
|
|
52
|
+
* description:
|
|
53
|
+
* "The company's GTM operator: posting cadence, open plays, outreach targets, content drafting.",
|
|
54
|
+
* });
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* Outbound auth is always Vercel OIDC — the peer verifies which deployment is
|
|
58
|
+
* calling before any principal assertion is considered.
|
|
59
|
+
*/
|
|
60
|
+
export declare function remotePeer(options: RemotePeerOptions): import("eve").RemoteAgentDefinition;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { defineRemoteAgent } from "eve";
|
|
2
|
+
import { vercelOidc } from "eve/agents/auth";
|
|
3
|
+
/**
|
|
4
|
+
* Declares a separately deployed eve agent as a callable peer of this agent.
|
|
5
|
+
*
|
|
6
|
+
* Mount under `agent/subagents/<name>.ts` — the file name becomes the tool
|
|
7
|
+
* name the model sees. Lowers to the same `{ message }` tool shape as a local
|
|
8
|
+
* subagent, with eve's durable dispatch underneath: the calling turn parks
|
|
9
|
+
* without holding compute until the peer posts its terminal callback.
|
|
10
|
+
*
|
|
11
|
+
* ```ts title="agent/subagents/gtm.ts"
|
|
12
|
+
* import { remotePeer } from "@kybernesis/dispatch";
|
|
13
|
+
*
|
|
14
|
+
* export default remotePeer({
|
|
15
|
+
* envVar: "GTM_AGENT_URL",
|
|
16
|
+
* description:
|
|
17
|
+
* "The company's GTM operator: posting cadence, open plays, outreach targets, content drafting.",
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* Outbound auth is always Vercel OIDC — the peer verifies which deployment is
|
|
22
|
+
* calling before any principal assertion is considered.
|
|
23
|
+
*/
|
|
24
|
+
export function remotePeer(options) {
|
|
25
|
+
const { envVar, fallbackUrl, description, outputSchema } = options;
|
|
26
|
+
return defineRemoteAgent({
|
|
27
|
+
url: () => {
|
|
28
|
+
const url = process.env[envVar] ?? fallbackUrl;
|
|
29
|
+
if (!url) {
|
|
30
|
+
throw new Error(`remotePeer: ${envVar} is not set and no fallbackUrl was provided — set the peer deployment URL in the environment.`);
|
|
31
|
+
}
|
|
32
|
+
return url;
|
|
33
|
+
},
|
|
34
|
+
description,
|
|
35
|
+
auth: vercelOidc(),
|
|
36
|
+
forwardPrincipal: options.forwardPrincipal ?? true,
|
|
37
|
+
...(outputSchema !== undefined ? { outputSchema } : {}),
|
|
38
|
+
});
|
|
39
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@kybernesis/dispatch",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Agent-to-agent dispatch for eve agents: declared remote-peer edges with principal forwarding on by default, and a receiver channel that makes trusting the wrong caller hard to express.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"homepage": "https://kybernesis.ai",
|
|
8
|
+
"keywords": [
|
|
9
|
+
"eve",
|
|
10
|
+
"kybernesis",
|
|
11
|
+
"agent-to-agent",
|
|
12
|
+
"remote-agent",
|
|
13
|
+
"dispatch",
|
|
14
|
+
"a2a"
|
|
15
|
+
],
|
|
16
|
+
"files": [
|
|
17
|
+
"dist",
|
|
18
|
+
"NOTICE"
|
|
19
|
+
],
|
|
20
|
+
"exports": {
|
|
21
|
+
".": {
|
|
22
|
+
"types": "./dist/index.d.ts",
|
|
23
|
+
"default": "./dist/index.js"
|
|
24
|
+
},
|
|
25
|
+
"./package.json": "./package.json"
|
|
26
|
+
},
|
|
27
|
+
"scripts": {
|
|
28
|
+
"build": "tsc -p tsconfig.build.json",
|
|
29
|
+
"prepare": "tsc -p tsconfig.build.json",
|
|
30
|
+
"typecheck": "tsc --noEmit"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@types/node": "24.x",
|
|
34
|
+
"eve": "0.30.8",
|
|
35
|
+
"typescript": "7.0.2"
|
|
36
|
+
},
|
|
37
|
+
"peerDependencies": {
|
|
38
|
+
"eve": ">=0.30.0 <0.31.0"
|
|
39
|
+
},
|
|
40
|
+
"engines": {
|
|
41
|
+
"node": ">=20"
|
|
42
|
+
},
|
|
43
|
+
"repository": {
|
|
44
|
+
"type": "git",
|
|
45
|
+
"url": "https://github.com/KybernesisAI/platform.git",
|
|
46
|
+
"directory": "packages/dispatch"
|
|
47
|
+
},
|
|
48
|
+
"publishConfig": {
|
|
49
|
+
"access": "public"
|
|
50
|
+
}
|
|
51
|
+
}
|