@niscorp/cortex 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 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/README.md ADDED
@@ -0,0 +1,291 @@
1
+ # @niscorp/cortex
2
+
3
+ Agent runtime. One tool loop, typed envelopes, code-hook gates,
4
+ streamed events. Two peer dependencies — the app owns the one copy of
5
+ each, because both cross the API: [`@niscorp/signal`](../signal) (you
6
+ hand cortex the client) and `zod` (you hand it the schemas).
7
+ [`@niscorp/solid`](../solid) is an ordinary dependency.
8
+
9
+ ```bash
10
+ pnpm add @niscorp/cortex @niscorp/signal zod
11
+ ```
12
+
13
+ For the *why* behind the architecture — the envelope, output
14
+ strategies, the append-only loop, gates over rules — see
15
+ [DESIGN.md](./DESIGN.md).
16
+
17
+ ---
18
+
19
+ ## Quick example
20
+
21
+ ```ts
22
+ import { z } from 'zod';
23
+ import { createSignal } from '@niscorp/signal';
24
+ import { defineAgent, defineTool } from '@niscorp/cortex';
25
+
26
+ const calculator = defineTool({
27
+ id: 'calculator',
28
+ name: 'calculator',
29
+ description: 'Evaluates a simple arithmetic expression.',
30
+ input: z.object({ expression: z.string() }),
31
+ execute: ({ expression }) => new Function(`return (${expression})`)(),
32
+ });
33
+
34
+ const calcAgent = defineAgent({
35
+ id: 'calc',
36
+ description: 'Arithmetic with a tool.',
37
+ instructions: 'Use the calculator tool, then give the answer.',
38
+ tools: [calculator],
39
+ output: { schema: z.object({ answer: z.number() }) },
40
+ });
41
+
42
+ const llm = createSignal('groq'); // qwen/qwen3.8-27b — the registry default
43
+
44
+ const result = await calcAgent.run('What is (2 + 3) * 7 - 6?', { llm }).result;
45
+ if (result.ok) console.log(result.output.data.answer); // 29
46
+ ```
47
+
48
+ ---
49
+
50
+ ## The envelope
51
+
52
+ Every agent returns the same shape — there is no separate text mode:
53
+
54
+ ```ts
55
+ type Envelope<TData> = {
56
+ response?: string; // human-facing text
57
+ data: TData; // schema-typed payload (undefined for pure chat agents)
58
+ reasoning?: string; // the model's short WHY
59
+ };
60
+ ```
61
+
62
+ A chat agent omits `output.schema` (its `response` becomes required);
63
+ a data agent sets it; a rich assistant returns both — prose *and* a
64
+ payload in one turn. Run-level metadata (usage, resolved strategy,
65
+ attempts, elapsed) is authored by cortex on `result.meta`, never by
66
+ the model.
67
+
68
+ ```ts
69
+ const result = await agent.run(input, { llm, deps }).result;
70
+ // { ok: true, output: Envelope<T>, meta: RunMeta }
71
+ // { ok: false, error: CortexError, meta: RunMeta }
72
+ ```
73
+
74
+ ---
75
+
76
+ ## Output strategies
77
+
78
+ How the envelope travels from model to runtime. One field,
79
+ `output.strategy`, default `'auto'`:
80
+
81
+ | Strategy | Mechanism | Fits |
82
+ |---|---|---|
83
+ | `native` | provider `response_format: json_schema`, in-loop | small strict-compatible schemas on capable providers (auto-picked) |
84
+ | `respond` | a synthesized `respond` tool; the envelope is its arguments | where the tool params can ENFORCE the contract — the endpoint does not validate tool args itself, the schema is small, the model carries nested args intact (auto-picked there) |
85
+ | `emit` | the model's completion IS the envelope (content channel) | everything else — auto-picked wherever neither of the above enforces anything: all of Groq, big schemas, models that mangle nested tool args |
86
+
87
+ Zod validates in **every** strategy. Invalid output feeds back as a
88
+ correction *inside the same run* (a tool error result / an appended
89
+ message) — never a full re-run. Big recursive schemas (Prism nodes,
90
+ Nova actions) ride `emit`; cortex injects
91
+ the JSON Schema into the prompt automatically (`output.doc: 'auto'`,
92
+ via `schemaDoc()` — single-sourced from the Zod schema).
93
+
94
+ Async output validation closes generate→verify loops in-run:
95
+
96
+ ```ts
97
+ output: {
98
+ schema: ActionDefinitionSchema,
99
+ validate: async (out) => (await mounts(out.data)) ? { ok: true } : { retry: 'why' },
100
+ }
101
+ ```
102
+
103
+ ---
104
+
105
+ ## defineAgent
106
+
107
+ ```ts
108
+ const agent = defineAgent<Data, Deps>({
109
+ id: 'action.builder',
110
+ description: 'One sentence.',
111
+ llm, // per-agent model binding (optional)
112
+ instructions: ({ deps }) => `…`, // string, or function of typed deps
113
+ context: [ // functions that build the prefix, ONCE per run
114
+ 'A static system chunk.',
115
+ ({ deps }) => renderCatalog(deps.palette),
116
+ ],
117
+ tools: [queryTool], // definitions, not id strings
118
+ output: { schema: DataSchema, validate, strategy: 'auto', forceTool: false, doc: 'auto' },
119
+ stopWhen: [stepCount(16), tokens(100_000), duration('6m'), outputRetries(3)],
120
+ policy: { tools: { requireApproval: ['transfer'], maxRiskLevel: 'medium' } },
121
+ toolGates: [myGate], // code hooks, run BEFORE each call
122
+ onToolResult: [redactor], // replace/redact results
123
+ prepareStep: ({ step, usage }) => ({ activeTools, toolChoice, inject, llm }),
124
+ });
125
+ ```
126
+
127
+ Deps are per-invocation, typed, and consumed by context entries,
128
+ gates and hooks — agents are defined once, never rebuilt per call.
129
+ Defaults when `stopWhen` is omitted: `stepCount(20)`,
130
+ `outputRetries(3)`.
131
+
132
+ Multi-turn history is caller-owned: `input` accepts a `string`, a
133
+ `Message[]` transcript, or any JSON value.
134
+
135
+ Per-run additions ride the options:
136
+
137
+ ```ts
138
+ agent.run(input, {
139
+ llm, deps,
140
+ tools: [perRequestTool], // appended to the agent's static tools
141
+ gates: [uiApprovalGate],
142
+ onToolResult: [traceHook],
143
+ onEvent: (e) => …,
144
+ signal: abortController.signal,
145
+ });
146
+ ```
147
+
148
+ ---
149
+
150
+ ## Events — the run is the stream
151
+
152
+ ```ts
153
+ const run = agent.run(input, { llm, deps });
154
+ for await (const e of run.events) {
155
+ // run-start · step-start · model-delta · tool-start · tool-end
156
+ // approval-required · output-delta · output-partial · retry · run-end
157
+ }
158
+ const result = await run.result; // the no-streaming opt-out
159
+ ```
160
+
161
+ - `tool-start` fires **before** execution — drives live "running…" UIs.
162
+ - `tool-end` carries a typed `ToolObservation` union (result / error /
163
+ denied / unknown-tool). No casting.
164
+ - `output-delta` streams the raw envelope JSON as it generates;
165
+ `output-partial` streams the progressively parsed envelope via
166
+ [`@niscorp/solid`](../solid) — a chat `response` streams token-ish,
167
+ a Nova screen in `data` becomes renderable before the run ends.
168
+ - `retry` resets partial-output state (same contract consumers had
169
+ in v1).
170
+ - Nested runs (`asTool`) forward their events into the parent stream
171
+ with an extended `agentPath` — one subscription sees the tree.
172
+
173
+ ---
174
+
175
+ ## Gates and approvals
176
+
177
+ All steering is plain typed functions; `policy` is sugar that
178
+ compiles into one gate. Gates run **before** the call; a deny becomes
179
+ a tool error the model reacts to; the run continues.
180
+
181
+ ```ts
182
+ type GateDecision =
183
+ | { allow: true; args?: unknown } // optionally rewrite args
184
+ | { deny: string }
185
+ | { ask: { reason: string } }; // suspend for a human
186
+ ```
187
+
188
+ `ask` emits `approval-required` and suspends the run:
189
+
190
+ ```ts
191
+ run.onEvent((e) => {
192
+ if (e.type === 'approval-required') {
193
+ void showDialog(e.approval).then((ok) =>
194
+ ok ? run.approve(e.approval.id, { args: maybeEdited }) : run.deny(e.approval.id, 'user said no'),
195
+ );
196
+ }
197
+ });
198
+ ```
199
+
200
+ Suspended runs serialize: `run.snapshot()` → JSON →
201
+ `resumeRun(agent, snapshot, { llm, deps })` re-asks the pending
202
+ approval and continues — approvals survive reloads and restarts.
203
+ `policy.approvalTimeoutMs` turns an unanswered ask into a denial
204
+ (an observation, not a run failure).
205
+
206
+ ---
207
+
208
+ ## The manifold
209
+
210
+ A catalog, defaults, and a tap — `agent.run()` and `manifold.run()`
211
+ are the same execution path.
212
+
213
+ ```ts
214
+ const manifold = createManifold({
215
+ llm: groqQwen, // fallback model
216
+ gates: [uiApprovalGate], // appended to every run
217
+ onRun: (run) => trace.attach(run),
218
+ });
219
+
220
+ manifold.register(vexQueryAgent, novaLayoutAgent, queryTool);
221
+ const run = manifold.run<Query>('vex.query', input, { deps });
222
+ ```
223
+
224
+ Delegation is a tool call:
225
+
226
+ ```ts
227
+ import { asTool } from '@niscorp/cortex';
228
+
229
+ const orchestrator = defineAgent({
230
+ id: 'orchestrator',
231
+ instructions: 'Delegate, then respond.',
232
+ tools: [asTool(vexQueryAgent, { deps, llm: groqQwen })],
233
+ });
234
+ // or from the catalog: manifold.asTool('vex.query')
235
+ ```
236
+
237
+ The child's envelope maps to the tool result (`data` if present, else
238
+ `response`; override with `select`), and its events nest in the
239
+ parent stream.
240
+
241
+ ---
242
+
243
+ ## preview
244
+
245
+ The exact messages and tools a run would send — no model call:
246
+
247
+ ```ts
248
+ const p = await agent.preview(input, { deps, llm });
249
+ p.strategy; // 'respond' | 'native' | 'emit' — what would actually run
250
+ p.messages; // the assembled prefix, including injected schema docs
251
+ p.tools; // real descriptors, including the respond tool's params
252
+ p.estimatedTokens;
253
+ ```
254
+
255
+ Anything you can't explain in the preview, the model can't either.
256
+
257
+ ---
258
+
259
+ ## Errors
260
+
261
+ Programmer errors throw at definition/registration time. Runtime
262
+ conditions return:
263
+
264
+ ```ts
265
+ type CortexError = {
266
+ code: 'model_call_failed' | 'output_invalid' | 'stopped' | 'aborted' | 'unknown';
267
+ stop?: 'steps' | 'tokens' | 'duration' | 'output_retries' | 'custom';
268
+ message: string;
269
+ runId: string;
270
+ agentPath: ReadonlyArray<string>;
271
+ };
272
+ ```
273
+
274
+ Tool failures are **observations**, not exceptions — the model sees
275
+ them and decides; the run fails only on structural conditions.
276
+
277
+ ---
278
+
279
+ ## Building
280
+
281
+ ```bash
282
+ pnpm build # tsup ESM + CJS + DTS
283
+ pnpm test # vitest run — scripted SignalClient stub, no network
284
+ pnpm typecheck # tsc on src
285
+ ```
286
+
287
+ ---
288
+
289
+ ## License
290
+
291
+ Apache-2.0