Skip to content

Finalize TS code before OSS release#19

Merged
devwdave merged 6 commits intomainfrom
ts-oss-polish
Feb 25, 2026
Merged

Finalize TS code before OSS release#19
devwdave merged 6 commits intomainfrom
ts-oss-polish

Conversation

@rpkruse
Copy link
Copy Markdown
Contributor

@rpkruse rpkruse commented Feb 25, 2026

  • Updated CONTRIBUTING.md and README.md (root) to remove the python support information. That SDK will be a future feature support

  • Added TsDoc linting to our linter to catch bad / malformed TS documentation

  • bumped version for our next release

  • Fixed TSDoc issues found from new linter

  • Moved exported types from llm register to their own file in the types folder to be consistent with our other setups

  • Added more TsDocs to any interface, type, method, etc that is public facing to make using our package easier

  • Minor code clean up to make our providers more consistent looking

  • Added automated release for publishing

Introduce a new types/registry.ts defining ClientMatcher and ClientPatcher and export it from the public types entry. Improve TSDoc and typing across the TypeScript SDK: tighten provider client shapes (OpenAI, Anthropic, Gemini), add detection comments, refine hook/llm JSDoc, and update imports to use the new registry types. Add and enable eslint-plugin-tsdoc (package.json + package-lock + eslint.config.js) and bump the package version to 0.1.4-beta. Trim CONTRIBUTING/README content to focus on the TypeScript SDK and adjust package description.
Delete the CONTRIBUTING.MD file containing contribution guidelines, TypeScript SDK setup, testing commands, project structure, code quality rules, and PR guidelines. Removes the obsolete contributor documentation from the repository.
Introduce a CONTRIBUTING.md outlining contribution and development workflows for the Axon TypeScript SDK. Covers prerequisites (Node.js >=18), local setup, build/test commands, common NPM scripts, testing and coverage with Vitest, project structure, code quality rules (ESLint/Prettier/TypeScript strict), guidance for adding provider integrations, and pull request best practices.
Add the 'release: types: [published]' event to the Publish to npm (TS) workflow so it runs automatically when a GitHub release is published. The existing manual 'workflow_dispatch' trigger is preserved to allow manual runs.
@rpkruse rpkruse requested a review from devwdave February 25, 2026 16:51
@devwdave devwdave merged commit 2fff420 into main Feb 25, 2026
4 checks passed
@devwdave devwdave deleted the ts-oss-polish branch February 25, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants