M3 #30: TypeScript SDK: Types and definitions#70
Merged
Conversation
- Create ts-sdk package with TypeScript type definitions: - package.json: @matchbook/sdk npm package configuration - tsconfig.json: TypeScript strict mode configuration - Build outputs: ESM, CommonJS, and type declarations - Core types (src/types/): - primitives.ts: Price, Quantity, Side, OrderType, TimeInForce, OrderStatus - market.ts: Market, MarketSummary - order.ts: Order, PlaceOrderParams, CancelOrderParams - trade.ts: Trade, TradeFilter - book.ts: BookLevel, OrderBook, BookChange, OrderBookUpdate - balance.ts: Balance, DepositParams, WithdrawParams - API types (src/api/): - rest.ts: REST response types (ApiResponse, PaginatedResponse, etc.) - websocket.ts: WebSocket message types (WsSubscribeMessage, WsBookSnapshot, etc.) - Type guards (src/guards/): - validators.ts: Runtime validation functions - isSide, isOrderType, isMarket, isOrder, isTrade, isOrderBook, isBalance - assertMarket, assertOrder, assertTrade, etc. - Testing: - 34 unit tests for type guards - vitest configuration - JSDoc documentation on all public exports
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
Implements TypeScript type definitions that mirror the Rust SDK types, providing type safety for JavaScript/TypeScript clients integrating with Matchbook.
Changes
New Package:
ts-sdk/(@matchbook/sdk)src/types/src/api/src/guards/tests/Core Types (
src/types/)primitives.tsmarket.tsorder.tstrade.tsbook.tsbalance.tsAPI Types (
src/api/)rest.tswebsocket.tsType Guards (
src/guards/)isSide,isOrderType,isTimeInForce,isOrderStatusisMarket,isOrder,isTrade,isOrderBook,isBalanceassertMarket,assertOrder,assertTrade, etc.Package Configuration
Technical Decisions
SIDES,ORDER_TYPES, etc. for iteration and validationTesting
Checklist
Closes #30