Skip to content

Refactor SDK types and add CreateViewRequest support#72

Merged
jfrench9 merged 1 commit intomainfrom
feature/connection-improvements
Feb 28, 2026
Merged

Refactor SDK types and add CreateViewRequest support#72
jfrench9 merged 1 commit intomainfrom
feature/connection-improvements

Conversation

@jfrench9
Copy link
Member

Summary

This PR refactors the SDK type definitions and generated client code to improve type safety and introduce support for the CreateViewRequest type. The changes span the core SDK layer (sdk/index.ts, sdk/sdk.gen.ts, sdk/types.gen.ts) with a net addition of ~223 new lines, primarily in type definitions.

Changes

Type Definitions (types.gen.ts)

  • Added CreateViewRequest type and associated supporting types for view creation workflows
  • Significantly expanded and refined existing type definitions (+243 lines / -12 lines), improving granularity and correctness of the generated types
  • Reorganized and restructured existing types for better clarity and alignment with the backend API schema

SDK Client (sdk.gen.ts)

  • Updated generated SDK methods to align with the revised type definitions
  • Adjusted function signatures and request/response types to reflect the new and refactored types (~40 lines changed)

SDK Barrel Export (index.ts)

  • Minor updates to export declarations to expose newly added types

Key Improvements

  • Stronger type safety: More precise and comprehensive type definitions reduce the risk of runtime errors from malformed API requests
  • New capability: CreateViewRequest enables programmatic view creation through the SDK, unblocking downstream feature work
  • Better DX: Refined types improve IDE autocompletion and inline documentation for developers consuming the SDK

Breaking Changes

⚠️ Potential breaking changes: Since existing types in types.gen.ts were refactored (not just extended), any consuming code that relies on the previous type shapes may need to be updated. Reviewers should verify:

  • All existing SDK method call sites still compile without errors
  • Any components or hooks that destructure SDK response types are compatible with the updated shapes

Testing Notes

  • Verify that existing API calls using the SDK still function correctly (no regressions)
  • Test any view creation flows if UI surfaces have been wired up to CreateViewRequest
  • Run tsc --noEmit across the project to catch any type incompatibilities introduced by the refactored types
  • Confirm that SDK code generation is deterministic — re-running the generator should produce the same output

Browser Compatibility

No browser compatibility concerns — all changes are TypeScript type definitions and SDK client code that compile down to standard JavaScript. No new runtime APIs, DOM interactions, or CSS changes are introduced.


🤖 Generated with Claude Code

Branch Info:

  • Source: feature/connection-improvements
  • Target: main
  • Type: feature

Co-Authored-By: Claude noreply@anthropic.com

## Summary
This update refines the SDK by removing unused types and introducing a new `CreateViewRequest` type, enhancing the overall structure and usability of the SDK.

## Changes Made
- **Removed Types**: Eliminated the `PlaidConnectionConfig` type and related definitions to streamline the SDK.
- **Updated Types**: Modified `ConnectionProviderInfo` and `ConnectionResponse` to remove references to the `plaid` provider, reflecting current integration capabilities.
- **New Type Added**: Introduced `CreateViewRequest` to facilitate view creation with detailed configuration options.

## Key Benefits
- **Improved Clarity**: The removal of unused types and the addition of structured request types enhance the SDK's clarity and maintainability.
- **Enhanced Functionality**: The new `CreateViewRequest` type provides developers with a clear interface for creating views, improving integration capabilities.

## Breaking Changes
- The removal of `PlaidConnectionConfig` may affect consumers relying on this type; ensure to update any related implementations.

## Testing Notes for Reviewers
- Verify that the SDK compiles without errors and that the new `CreateViewRequest` type integrates correctly into existing workflows.
- Ensure that all references to removed types are eliminated from the codebase.

## Technical Impact
- **Files Modified**: Updated `types.gen.ts`, `index.ts`, and `sdk.gen.ts` to reflect the changes in type definitions.
@jfrench9 jfrench9 merged commit c69c346 into main Feb 28, 2026
1 check passed
@jfrench9 jfrench9 deleted the feature/connection-improvements branch February 28, 2026 20:52
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.

1 participant