Commit 53bce87
refactor: flatten client structure and add Zod validation to RPC client (#168)
* feat!: replace @stackone/stackone-client-ts with custom RPC client
Remove the external TypeScript client SDK dependency and implement a
custom RPC client for the StackOne API. This reduces dependencies and
gives full control over the API client implementation.
Changes:
- Add src/client/rpc-client.ts with RpcClient class
- Update toolsets/base.ts to use new RpcClient instead of StackOne
- Update tests to mock RpcClient instead of StackOne
- Add comprehensive tests for the new RPC client using MSW
- Add MSW handler for /actions/rpc endpoint
- Remove @stackone/stackone-client-ts from dependencies
BREAKING CHANGE: BaseToolSetConfig.stackOneClient is now rpcClient
* refactor(client): flatten directory structure
- Merge rpc-client.ts implementation into client/index.ts
- Rename tests/rpc-client.spec.ts to index.spec.ts
- Remove empty client/tests/ directory
- Update import paths in test file
* refactor: flatten client directory structure
- Move src/client/index.ts to src/rpc-client.ts
- Move src/client/index.spec.ts to src/rpc-client.spec.ts
- Rename src/mcp.ts to src/mcp-client.ts
- Update import paths in base.ts and test files
- Remove src/client/ directory
This simplifies the directory structure by placing small client
modules at the src/ root level rather than in nested directories.
* refactor(tests): remove redundant outer describe block in rpc-client.spec.ts
* refactor(tests): remove useless constructor tests from rpc-client.spec.ts
* refactor(tests): remove describe block and use test() instead of it()
* feat(rpc-client): add Zod validation for request/response schemas
- Add Zod schemas for RpcActionRequest, RpcActionResponse, and RpcClientConfig
- Validate config in constructor and request in rpcAction
- Validate response body before returning
- Use catalog:dev for zod dependency
- Remove duplicate catalog entry from pnpm-workspace.yaml
* refactor(tests): replace type assertions with toMatchObject in rpc-client tests
- Use toMatchObject for structural validation instead of 'as' type assertions
- Use expect.any(String) for dynamic values
- Use rejects.toMatchObject for error property validation
- Remove all type casting from test file
* refactor(rpc-client): use safeParse and improve type safety
- Use safeParse instead of parse for response validation
- Throw StackOneAPIError with context on validation failure
- Add 'as const satisfies' for requestBody type narrowing
- Remove type assertion from return value
* docs(rpc-client): add API reference links to RpcClient class
* fix: lint errors - sort imports and remove unused JsonDict import
* refactor(tests): use nullish coalescing (??) instead of logical OR (||)
* fix(rpc-client): align response schema with server's ActionsRpcResponseApiModel
The previous implementation wrapped the API response in an artificial
`actionsRpcResponse` property which didn't match the actual server
response structure from unified-cloud-api.
Changes:
- Update RpcActionResponseSchema to match server's ActionsRpcResponseApiModel:
- `data`: object, array of objects, or null
- `next`: optional pagination cursor
- Use passthrough() to allow additional connector-specific fields
- Fix headers type from Record<string, string> to Record<string, unknown>
to match server's ActionsRpcRequestDto
- Remove artificial wrapping of response in `actionsRpcResponse` property
- Add explicit `unknown` type annotation to response.json() for type safety
- Export RpcActionResponseData type for consumers needing the data shape
This enables proper type inference without type assertions when consuming
the RPC client response.
Refs: unified-cloud-api/src/modules/actions/models/actions-rpc-response.api.model.ts
* refactor(toolsets): eliminate type assertion with type-safe conversion
Replace `as JsonDict` type assertion with explicit conversion function
`rpcResponseToJsonDict()` that iterates over response properties.
The RpcActionResponse type uses z.passthrough() which preserves
additional fields beyond `data` and `next`. This makes it structurally
compatible with Record<string, unknown>, but TypeScript's type system
requires explicit conversion to maintain type safety.
This change ensures no implicit `any` or unsafe type assertions are
used when handling RPC responses in the toolset.
* test(rpc-client): update tests for correct response structure
Update test expectations to match the actual server response structure
where `data` is a direct property of the response, not nested under
`actionsRpcResponse`.
Changes:
- Access response.data directly instead of response.actionsRpcResponse
- Add explicit assertions for response data content
- Rename test to clarify array data handling
- Add comments explaining response structure alignment with server
---------
Co-authored-by: Claude <noreply@anthropic.com>1 parent 12d3e35 commit 53bce87
File tree
8 files changed
+353
-31
lines changed- mocks
- src
- toolsets
8 files changed
+353
-31
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
214 | 214 | | |
215 | 215 | | |
216 | 216 | | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
217 | 288 | | |
218 | 289 | | |
219 | 290 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | | - | |
37 | 36 | | |
38 | 37 | | |
39 | 38 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
36 | 35 | | |
37 | 36 | | |
38 | 37 | | |
39 | 38 | | |
40 | 39 | | |
41 | 40 | | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | 41 | | |
46 | 42 | | |
47 | 43 | | |
| |||
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
0 commit comments