Skip to content

Commit 17685ee

Browse files
committed
fix(exports,docs): expose subpath modules + names referenced by docs
End-to-end testing of 298 published code blocks across 335 doc files surfaced ~30 failures caused by missing subpath exports, missing top-level re-exports, and stale class names referenced by docs but never implemented. Source fixes: - package.json exports: add ./provenance, ./channels, ./channels/social-posting, ./social-posting, ./emergent, ./sandbox/subprocess, ./orchestration/checkpoint (all already shipped as built modules; just weren't reachable through the package's exports map). - src/index.ts: re-export `transferStyle`, `setDefaultProvider`, `getDefaultProvider`, `clearDefaultProvider`, `createTestAgentOSConfig` from the root so docs that say `import { ... } from '@framers/agentos'` resolve cleanly. - src/orchestration/builders/index.ts: re-export `voiceNode` and `VoiceNodeBuilder` (already implemented, never re-exported). - src/memory/io/facade/Memory.ts: add `Memory.create()` as a delegating alias for `Memory.createSqlite()`. Several published examples and the blog reference the old `Memory.create(config)` shape. Doc fixes: - Replace `SqliteCheckpointStore` with `InMemoryCheckpointStore` across 6 orchestration docs. The Sqlite-backed checkpoint store was documented but never implemented; InMemoryCheckpointStore is what actually ships. - Replace `from '@framers/agentos/config/AgentOSConfig'` with `from '@framers/agentos'` in 5 docs. `createTestAgentOSConfig` is now re-exported from the root, so the deeper subpath isn't needed. Verified by re-running the 298-block end-to-end harness; pass rate improved from 17% baseline to 24% after these source/doc fixes. Remaining failures are mostly partial snippets (continuation blocks referencing variables defined in earlier blocks of the same doc) and test-harness limitations (sql.js native module, peer packages not installed in /tmp).
1 parent cd0c4c4 commit 17685ee

13 files changed

Lines changed: 86 additions & 15 deletions

File tree

docs/architecture/AGENT_GRAPH.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ const graph = new AgentGraph(stateSchema, {
261261
262262
```typescript
263263
const compiled = graph.compile({
264-
checkpointStore: new SqliteCheckpointStore('./runs.db'),
264+
checkpointStore: new InMemoryCheckpointStore('./runs.db'),
265265
validate: true, // default — throws on unreachable nodes or structural errors
266266
});
267267
```
@@ -321,7 +321,7 @@ import {
321321
AgentGraph, START, END,
322322
gmiNode, toolNode, humanNode,
323323
} from '@framers/agentos/orchestration';
324-
import { SqliteCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
324+
import { InMemoryCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
325325
import { z } from 'zod';
326326

327327
const ResearchState = {
@@ -405,7 +405,7 @@ const graph = new AgentGraph(ResearchState, {
405405
.addEdge('review', END)
406406

407407
.compile({
408-
checkpointStore: new SqliteCheckpointStore('./research-checkpoints.db'),
408+
checkpointStore: new InMemoryCheckpointStore('./research-checkpoints.db'),
409409
});
410410

411411
// Run

docs/getting-started/EXAMPLES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ Runnable source: `packages/agentos/examples/agentos-config-tools.mjs`
593593

594594
```typescript
595595
import { AgentOS } from '@framers/agentos';
596-
import { createTestAgentOSConfig } from '@framers/agentos/config/AgentOSConfig';
596+
import { createTestAgentOSConfig } from '@framers/agentos';
597597

598598
const agent = new AgentOS();
599599

docs/getting-started/HIGH_LEVEL_API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ Runnable examples in the package source:
533533

534534
```ts
535535
import { AgentOS, AgentOSResponseChunkType } from '@framers/agentos';
536-
import { createTestAgentOSConfig } from '@framers/agentos/config/AgentOSConfig';
536+
import { createTestAgentOSConfig } from '@framers/agentos';
537537

538538
const agent = new AgentOS();
539539
await agent.initialize(

docs/orchestration/CHECKPOINTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The AgentOS Unified Orchestration Layer has built-in support for checkpoints, re
44

55
> Status note:
66
> `InMemoryCheckpointStore` is implemented and used by default.
7-
> `SqliteCheckpointStore` is still planned, not shipped in this package yet.
7+
> `InMemoryCheckpointStore` is still planned, not shipped in this package yet.
88
99
## ICheckpointStore
1010

docs/orchestration/MISSION_API.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ All constraint fields are optional — an anchor with no constraints is appended
144144

145145
```typescript
146146
const compiled = mission(...).compile({
147-
checkpointStore: new SqliteCheckpointStore('./missions.db'), // optional
147+
checkpointStore: new InMemoryCheckpointStore('./missions.db'), // optional
148148
});
149149
```
150150

@@ -199,7 +199,7 @@ const outerGraph = new AgentGraph(outerState)
199199

200200
```typescript
201201
import { mission, toolNode, humanNode } from '@framers/agentos/orchestration';
202-
import { SqliteCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
202+
import { InMemoryCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
203203
import { z } from 'zod';
204204

205205
const deepResearch = mission('deep-research')
@@ -241,7 +241,7 @@ const deepResearch = mission('deep-research')
241241
)
242242

243243
.compile({
244-
checkpointStore: new SqliteCheckpointStore('./research.db'),
244+
checkpointStore: new InMemoryCheckpointStore('./research.db'),
245245
});
246246

247247
// Inspect the plan before running

docs/orchestration/ORCHESTRATION.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -483,9 +483,9 @@ graph TD
483483
Any compiled graph supports durable checkpoints. Swap in a persistent store for production — the interface is the same.
484484

485485
```typescript
486-
import { SqliteCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
486+
import { InMemoryCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
487487

488-
const store = new SqliteCheckpointStore('./runs.db');
488+
const store = new InMemoryCheckpointStore('./runs.db');
489489

490490
const graph = new AgentGraph({ /* ... */ })
491491
.compile({ checkpointStore: store, checkpointPolicy: 'every_node' });

docs/orchestration/WORKFLOW_DSL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ GMI steps inside `workflow()` always run in `single_turn` mode — the `executio
166166

167167
```typescript
168168
const compiled = wf.compile({
169-
checkpointStore: new SqliteCheckpointStore('./runs.db'), // optional
169+
checkpointStore: new InMemoryCheckpointStore('./runs.db'), // optional
170170
});
171171
```
172172

@@ -194,7 +194,7 @@ const ir = compiled.toIR();
194194

195195
```typescript
196196
import { workflow } from '@framers/agentos/orchestration';
197-
import { SqliteCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
197+
import { InMemoryCheckpointStore } from '@framers/agentos/orchestration/checkpoint';
198198
import { z } from 'zod';
199199

200200
const onboarding = workflow('user-onboarding')
@@ -258,7 +258,7 @@ const onboarding = workflow('user-onboarding')
258258
})
259259

260260
.compile({
261-
checkpointStore: new SqliteCheckpointStore('./onboarding.db'),
261+
checkpointStore: new InMemoryCheckpointStore('./onboarding.db'),
262262
});
263263

264264
// Run

docs/safety/GUARDRAILS_USAGE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ AgentOS ships five official guardrail extension packs as standalone packages:
4040

4141
```typescript
4242
import { AgentOS } from '@framers/agentos';
43-
import { createTestAgentOSConfig } from '@framers/agentos/config/AgentOSConfig';
43+
import { createTestAgentOSConfig } from '@framers/agentos';
4444
import {
4545
IGuardrailService,
4646
GuardrailAction,

package.json

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,41 @@
7373
"types": "./dist/core/llm/routing/UncensoredModelCatalog.d.ts"
7474
},
7575
"./config/extension-secrets.json": "./dist/config/extension-secrets.json",
76+
"./provenance": {
77+
"import": "./dist/provenance/index.js",
78+
"default": "./dist/provenance/index.js",
79+
"types": "./dist/provenance/index.d.ts"
80+
},
81+
"./channels": {
82+
"import": "./dist/channels/index.js",
83+
"default": "./dist/channels/index.js",
84+
"types": "./dist/channels/index.d.ts"
85+
},
86+
"./channels/social-posting": {
87+
"import": "./dist/channels/social-posting/index.js",
88+
"default": "./dist/channels/social-posting/index.js",
89+
"types": "./dist/channels/social-posting/index.d.ts"
90+
},
91+
"./social-posting": {
92+
"import": "./dist/channels/social-posting/index.js",
93+
"default": "./dist/channels/social-posting/index.js",
94+
"types": "./dist/channels/social-posting/index.d.ts"
95+
},
96+
"./emergent": {
97+
"import": "./dist/emergent/index.js",
98+
"default": "./dist/emergent/index.js",
99+
"types": "./dist/emergent/index.d.ts"
100+
},
101+
"./sandbox/subprocess": {
102+
"import": "./dist/sandbox/subprocess/index.js",
103+
"default": "./dist/sandbox/subprocess/index.js",
104+
"types": "./dist/sandbox/subprocess/index.d.ts"
105+
},
106+
"./orchestration/checkpoint": {
107+
"import": "./dist/orchestration/checkpoint/index.js",
108+
"default": "./dist/orchestration/checkpoint/index.js",
109+
"types": "./dist/orchestration/checkpoint/index.d.ts"
110+
},
76111
"./skills": {
77112
"import": "./dist/skills.js",
78113
"default": "./dist/skills.js",

src/api/index.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ export { embedText } from './embedText.js';
3636
export { generateImage } from './generateImage.js';
3737
export { transferStyle } from './transferStyle.js';
3838

39+
// --- Global default provider config ---
40+
export {
41+
setDefaultProvider,
42+
getDefaultProvider,
43+
clearDefaultProvider,
44+
type GlobalDefaultProvider,
45+
} from './runtime/global-default.js';
46+
3947
// --- Agent & Agency ---
4048
export { agent } from './agent.js';
4149
export { agency } from './agency.js';

0 commit comments

Comments
 (0)