fix(typescript): pipeline built-in tools + docs events parity for #114/#115 + CHANGELOG backfill#118
Merged
Conversation
…115) - Pipeline mode in `libraries/typescript/src/stream-handler.ts` did not inject the built-in `transfer_call` / `end_call` tools into the `LLMLoop` (both `new LLMLoop(...)` call sites at lines 1891 and 1906 passed `agent.tools` through unchanged). The Realtime path injects them at `server.ts:374`; pipeline was missing the parity. Added `augmentWithBuiltinHandoffTools` helper mirroring the Python helper shipped in #115; it builds handler closures that validate E.164 / default `reason` and dispatch to the existing telephony bridge methods (`bridge.transferCall` / `bridge.endCall`). Built-ins are skipped when the corresponding callback is missing, keeping non-telephony test harnesses clean. Exported `TRANSFER_CALL_TOOL` / `END_CALL_TOOL` from `server.ts` so the helper can re-use the canonical schema. - Docs: `docs/typescript-sdk/events.mdx` advertised the same non-existent `phone.events.on(PatterEventType.X, handler)` API as the Python events page (closed by #114). Replaced the broken `EventBus` section with documentation of the APIs that actually exist on the TypeScript `Patter` class: speech-edge attribute setters (`onUserSpeechStarted` / `onAgentSpeechEnded` / `onLlmToken` / `onAudioOut` etc.) and tool events via `onTranscript` with `role === "tool"`. - CHANGELOG: backfilled `## Unreleased` `### Fixed` entries for upstream PRs #113, #114, #115 (Python fixes by @knowsuchagency that landed without the corresponding TypeScript / changelog updates), plus entries for the two TypeScript parity fixes shipped here. Test plan: - Python: covered by tests added in the upstream PRs (#113, #115). - TypeScript: 8 new unit tests in `libraries/typescript/tests/pipeline-builtin-tools.test.ts` cover empty-user-tools, non-empty user tools order, missing-callback skip, transfer dispatch + E.164 rejection, end_call default and user-supplied `reason`. Full suite: 1521 passed / 8 skipped, lint clean, build green.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Summary
## UnreleasedinCHANGELOG.mdwith### Fixedentries for the three external bug-fix PRs that just landed (fix(websockets): use is_ws_alive across modern websockets>=12 API #113, docs(events): remove non-existent phone.events; document real API #114, fix(pipeline): inject built-in transfer_call / end_call tools into LLMLoop #115), each citing the issue, file:line, and fix.libraries/typescript/src/stream-handler.tswas missing the built-intransfer_call/end_calltools at bothnew LLMLoop(...)call sites (lines 1891 and 1906). The Realtime path injects them atserver.ts:374; pipeline was passingagent.toolsthrough unchanged.docs/typescript-sdk/events.mdxadvertised the same non-existentphone.events.on(PatterEventType.X, handler)API as the Python events page.Implementation
libraries/typescript/src/server.ts— exportedTRANSFER_CALL_TOOL/END_CALL_TOOLconstants so the pipeline helper can re-use the canonical schema instead of redefining it.libraries/typescript/src/stream-handler.ts— addedaugmentWithBuiltinHandoffTools(userTools, { transferCall, endCall })that mirrors the Python helper shipped in fix(pipeline): inject built-in transfer_call / end_call tools into LLMLoop #115. Built-ins are appended (user tools keep their order) with handler closures that validate E.164 / defaultreasonand dispatch to the existing telephony bridge methods. Both pipeline-modenew LLMLoop(...)call sites now pass the augmented list.docs/typescript-sdk/events.mdx— replaced the broken## EventBussection with documentation of the real TypeScript API: Speech-edge events (attribute setters onPatterproxied tospeechEvents) and Tool events viaonTranscript(filtered onrole === "tool").libraries/typescript/tests/pipeline-builtin-tools.test.ts— 8 new unit tests cover empty-user-tools, non-empty user tools order, missing-callback skip, partial-callback skip, transfer dispatch, E.164 rejection without dispatch,end_calldefaultreason,end_calluser-suppliedreason.CHANGELOG.md— 5 new### Fixedentries under## Unreleased: three for the upstream Python PRs (fix(websockets): use is_ws_alive across modern websockets>=12 API #113, docs(events): remove non-existent phone.events; document real API #114, fix(pipeline): inject built-in transfer_call / end_call tools into LLMLoop #115 — credited to @knowsuchagency) and two for the TypeScript parity fixes shipped here. Each entry leads with the user-visible effect and links file:line.Files touched:
CHANGELOG.md(+91 / −0)docs/typescript-sdk/events.mdx(+58 / −17)libraries/typescript/src/server.ts(+2 / −2)libraries/typescript/src/stream-handler.ts(+72 / −3)libraries/typescript/tests/pipeline-builtin-tools.test.ts(+128 new file)libraries/typescript/package-lock.json(version literal sync 0.6.1 → 0.6.2)No new runtime dependencies.
Breaking change?
No.
augmentWithBuiltinHandoffToolsis purely additive on a previously broken code path (no app code relied on the missing built-ins), and the docs page replacement removes an API that crashedAttributeErrorimmediately on import.Test plan
npm run lint— cleannpm test— 1521 passed / 8 skipped (full suite, 86 files)npm run build— green (CJS + DTS + CLI)tests/pipeline-builtin-tools.test.ts— 8/8 passingDocs updates
docs/typescript-sdk/events.mdxupdated in-PR (matches the Python events page rewritten in docs(events): remove non-existent phone.events; document real API #114).