chore: regenerate api docs for 4 libs + drop dead AgentRef interface#153
Merged
Conversation
1. generate-api-docs.ts: rewrite to iterate over all four publishable libraries (langgraph, chat, render, ag-ui). The old script only knew about a single 'libs/angular' entry point that hasn't existed since the rename. Output now goes to: - apps/website/content/docs/agent/api/ (from libs/langgraph) - apps/website/content/docs/chat/api/ (from libs/chat) - apps/website/content/docs/render/api/ (from libs/render) - apps/website/content/docs/ag-ui/api/ (from libs/ag-ui) 2. Regenerated api-docs.json files reflect the unified LangGraphAgent API. Verified: zero residual AgentRef references in agent docs. 3. Drop the unused AgentRef interface from libs/langgraph/src/lib/ agent.types.ts. Following the unification PR (#152), the type was defined but never imported. Comments in agent.fn.ts and mock-langgraph-agent.ts that referenced "AgentRef fields preserved" stay as historical notes. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Manual validation pass to prove @ngaf/*@0.0.1 packages install + build + run from npm. Two thin Angular apps share one workspace: - ag-ui-fake: end-to-end runtime test using FakeAgent (no backend) - langgraph-build: build-only smoke against published @ngaf/langgraph Catches packaging bugs, missing peerDeps, broken exports that internal tsconfig-paths resolution hides. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Smoke-tested @ngaf/*@0.0.1 by tarballing dist/ and installing into
a fresh Angular 21 app at ~/tmp/ngaf/smoke-workspace. Three packaging
bugs surfaced; all fixed in this commit.
1. @ngaf/a2ui, @ngaf/partial-json, @ngaf/licensing publish-target
missing. Their project.json files lacked an explicit
nx-release-publish target, so Nx Release defaulted to publishing
the project root (raw source) instead of dist/. Added explicit
target with packageRoot: "dist/{projectRoot}".
2. @ngaf/a2ui, @ngaf/partial-json built with emitDeclarationOnly:
true (inherited from tsconfig.base.json). Their dists contained
only .d.ts files, no .js. Added emitDeclarationOnly: false
override to libs/a2ui/tsconfig.lib.json and
libs/partial-json/tsconfig.lib.json.
(libs/licensing already had this override.)
3. @ngaf/chat bundled vitest into the runtime FESM file.
runAgentConformance and runAgentWithHistoryConformance import
{ describe, it, expect } from 'vitest' at module level and were
exported from the main public-api. Moved to a secondary entry
point @ngaf/chat/testing:
- Created libs/chat/testing/ng-package.json + public-api.ts
- git mv'd agent-conformance.ts and agent-with-history-conformance
.ts (and the conformance spec) into libs/chat/testing/
- Updated their import of Agent/AgentWithHistory from '../agent'
to '@ngaf/chat' (cross-entry-point convention)
- Removed conformance exports from libs/chat/src/public-api.ts
- Added @ngaf/chat/testing path to tsconfig.base.json
- Updated internal consumers (libs/ag-ui and libs/langgraph
conformance specs) to import from @ngaf/chat/testing.
Verified: smoke-app/ag-ui-fake builds (755kB initial), serves at
localhost:4300, no minting-service leakage in dist, all @ngaf/*
packages credited as MIT in 3rdpartylicenses.txt.
smoke-app/langgraph-build builds (606kB initial).
This commit fixes the artifacts; next step is to bump to 0.0.2 and
republish.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two follow-ups from PR #152.
generate-api-docs.tsrewrite. The old script looked forlibs/angular/src/public-api.ts(a path that hasn't existed since the rename). Updated to iterate over all four publishable libraries — langgraph, chat, render, ag-ui — writing to their respective/docs/<slug>/api/api-docs.jsonfiles. Verified: zeroAgentRefreferences in regenerated agent docs;LangGraphAgentis documented as the public type.Drop unused
AgentRefinterface fromlibs/langgraph/src/lib/agent.types.ts. Defined but never imported after PR refactor(langgraph): unify agent() return type as LangGraphAgent #152.Generated artifact regeneration
Running
npm run generate-api-docsnow produces:/docs/agent/api/api-docs.json— 19 entries (LangGraphAgent, MockLangGraphAgent, AgentConfig, etc.)/docs/chat/api/api-docs.json— 109 entries/docs/render/api/api-docs.json— 21 entries/docs/ag-ui/api/api-docs.json— 7 entries (new)Test Plan
🤖 Generated with Claude Code