Skip to content

Release new GraphQL SDK#230

Merged
mattvagni merged 9 commits intomainfrom
mattvagni/sdk-rename-docs
Mar 30, 2026
Merged

Release new GraphQL SDK#230
mattvagni merged 9 commits intomainfrom
mattvagni/sdk-rename-docs

Conversation

@mattvagni
Copy link
Copy Markdown
Member

@mattvagni mattvagni commented Mar 28, 2026

Summary

Replaces the deprecated @team-plain/typescript-sdk documentation with docs for the three new SDK packages:

  • @team-plain/graphql — typed GraphQL client with auto-pagination, lazy-loaded relations, union type support (__typename / instanceof narrowing), sub-connection queries, and namespaced client.query.* / client.mutation.* API
  • @team-plain/webhooks — webhook payload parsing and HMAC-SHA256 signature verification
  • @team-plain/ui-components — typed helpers for building ComponentInput objects

Also removes all old TypeScript SDK snippet files, tab wrappers, and inline code examples — pages now show raw GraphQL only, with a callout linking to the new SDK where relevant.

🤖 Generated with Claude Code

mattvagni and others added 9 commits March 24, 2026 22:36
The TypeScript SDK is being deprecated. This removes all references
to it across the docs, including snippets, tab components, prose
mentions, and navigation entries. All pages now show only GraphQL
examples.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Rename @team-plain/sdk → @team-plain/graphql everywhere
- Update API examples to use namespaced client.query.* and client.mutation.*
- Add union types section with __typename narrowing and instanceof examples
- Add sub-connection queries documentation
- Add migration guide link for users upgrading from @team-plain/typescript-sdk
- Update peer dependency references in ui-components and webhooks docs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@mattvagni mattvagni changed the title Update SDK docs: rename to @team-plain/graphql, add union types Release new GraphQL SDK Mar 30, 2026
@mattvagni mattvagni enabled auto-merge (squash) March 30, 2026 10:17
Copy link
Copy Markdown
Contributor

@ndom91 ndom91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to approve to unblock, but should we think about adding redirects for the old URLs? (vercel.json in team-plain/reverse-proxy? Does mintlify have a mechansim for this?)

Also, I'm surprised they dont have preview deploys / comments for them - maybe we're just missing some config / linking of the repo in Mintlify?

@mattvagni mattvagni merged commit b4800b6 into main Mar 30, 2026
7 checks passed
@mattvagni mattvagni deleted the mattvagni/sdk-rename-docs branch March 30, 2026 10:22
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