docs(contact-center): add SDK manifest generator for cross-repo sync#4800
Open
ciscoRankush wants to merge 3 commits intowebex:task-refactorfrom
Open
docs(contact-center): add SDK manifest generator for cross-repo sync#4800ciscoRankush wants to merge 3 commits intowebex:task-refactorfrom
ciscoRankush wants to merge 3 commits intowebex:task-refactorfrom
Conversation
Add ts-morph based script that auto-generates sdk-manifest.yaml describing the public API surface (classes, methods, events, types, constants). This enables cross-repo SDK synchronization by providing a machine-readable contract that consumers can diff to detect API changes. - scripts/generate-manifest.ts: ts-morph AST analysis of exported APIs - sdk-manifest.yaml: generated artifact (ships with npm package) - package.json: added generate:manifest script and files array - .claude/commands/generate-manifest.md: /generate-manifest skill Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add usage instructions for the SDK manifest generator to the root AGENTS.md, including when/how to regenerate and mandatory API verification steps for AI agents. Co-Authored-By: Claude Opus 4.6 (1M context) <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
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.
COMPLETES #N/A (new tooling initiative)
This pull request addresses
The need for automated cross-repo SDK synchronization. When SDK APIs change (methods, events, types), consumer repos (ccWidgets) currently discover breakage through manual changelog reading, compile-time errors, or runtime failures. There is no machine-readable contract that consumers can programmatically diff to detect what changed.
by making the following changes
scripts/generate-manifest.ts: ts-morph based AST analysis script that statically analyzes the@webex/contact-centerpackage and extracts all exported classes (with public methods, params, return types, event emissions), enums, types/interfaces, and constants into a structured YAML file.sdk-manifest.yaml: Auto-generated machine-readable API surface contract. Added topackage.jsonfilesarray so it ships with the npm package. Consumers can diff this between versions to detect API changes.package.json: Addedgenerate:manifestscript andfilesarray includingsdk-manifest.yaml..claude/commands/generate-manifest.md:/generate-manifestClaude Code skill for developers to regenerate the manifest locally.Key capabilities:
this.trigger()/this.emit()calls to actual event string valuesChange Type
The following scenarios were tested
npx ts-node scripts/generate-manifest.ts— generates sdk-manifest.yaml with 3 classes, 37 methods, 2 enums, 71 types, 2 constantsstartTranscriptioncorrectly maps totask:transcriptionStarted(success) andtask:transcriptionFailed(failure)defaultclass re-export andTaskEvents/AgentEventstype re-exports excludedstationLogin), regenerated manifest, diffed against previous version — change correctly detectedThe GAI Coding Policy And Copyright Annotation Best Practices
I certified that