@superblocksteam/sdk-api 0.0.9 → 0.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/index.d.ts +1 -1
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/index.js.map +1 -1
  4. package/dist/integrations/dynamodb/client.d.ts +6 -2
  5. package/dist/integrations/dynamodb/client.d.ts.map +1 -1
  6. package/dist/integrations/dynamodb/client.js +83 -10
  7. package/dist/integrations/dynamodb/client.js.map +1 -1
  8. package/dist/integrations/dynamodb/client.test.d.ts +8 -0
  9. package/dist/integrations/dynamodb/client.test.d.ts.map +1 -0
  10. package/dist/integrations/dynamodb/client.test.js +198 -0
  11. package/dist/integrations/dynamodb/client.test.js.map +1 -0
  12. package/dist/integrations/dynamodb/index.d.ts +1 -1
  13. package/dist/integrations/dynamodb/index.d.ts.map +1 -1
  14. package/dist/integrations/dynamodb/index.js.map +1 -1
  15. package/dist/integrations/dynamodb/types.d.ts +27 -1
  16. package/dist/integrations/dynamodb/types.d.ts.map +1 -1
  17. package/dist/integrations/index.d.ts +1 -1
  18. package/dist/integrations/index.d.ts.map +1 -1
  19. package/dist/integrations/index.js.map +1 -1
  20. package/package.json +1 -1
  21. package/src/index.ts +1 -0
  22. package/src/integrations/anthropic/README.md +7 -0
  23. package/src/integrations/bigquery/README.md +1 -0
  24. package/src/integrations/box/README.md +3 -0
  25. package/src/integrations/cohere/README.md +7 -0
  26. package/src/integrations/dynamodb/README.md +33 -12
  27. package/src/integrations/dynamodb/client.test.ts +254 -0
  28. package/src/integrations/dynamodb/client.ts +121 -16
  29. package/src/integrations/dynamodb/index.ts +5 -1
  30. package/src/integrations/dynamodb/types.ts +33 -1
  31. package/src/integrations/fireworks/README.md +7 -0
  32. package/src/integrations/gemini/README.md +8 -0
  33. package/src/integrations/groq/README.md +7 -0
  34. package/src/integrations/index.ts +1 -0
  35. package/src/integrations/mistral/README.md +7 -0
  36. package/src/integrations/openai_v2/README.md +7 -0
  37. package/src/integrations/perplexity/README.md +7 -0
  38. package/src/integrations/s3/README.md +1 -0
  39. package/src/integrations/snowflakecortex/README.md +8 -0
  40. package/src/integrations/stabilityai/README.md +7 -0
@@ -251,6 +251,13 @@ All methods accept an optional `metadata` parameter as the last argument for dia
251
251
 
252
252
  ## Common Pitfalls
253
253
 
254
+ ### Streaming Is Not Supported
255
+
256
+ `apiRequest()` does not support streaming or Server-Sent Events. Do not set
257
+ `stream: true` — streaming responses fail schema validation. Every call
258
+ returns the complete response; if a UI needs real-time token streaming,
259
+ handle it at the frontend layer, not through the SDK.
260
+
254
261
  ### No Specialized Methods
255
262
 
256
263
  ```typescript
@@ -363,6 +363,7 @@ export { MongoDBClientImpl } from "./mongodb/index.js";
363
363
  export type {
364
364
  DynamoDBClient,
365
365
  DynamoDBAttributeValue,
366
+ DynamoDBScanOptions,
366
367
  } from "./dynamodb/index.js";
367
368
  export { DynamoDBClientImpl } from "./dynamodb/index.js";
368
369
 
@@ -277,6 +277,13 @@ All methods accept an optional `metadata` parameter as the last argument for dia
277
277
 
278
278
  ## Common Pitfalls
279
279
 
280
+ ### Streaming Is Not Supported
281
+
282
+ `apiRequest()` does not support streaming or Server-Sent Events. Do not set
283
+ `stream: true` — streaming responses fail schema validation. Every call
284
+ returns the complete response; if a UI needs real-time token streaming,
285
+ handle it at the frontend layer, not through the SDK.
286
+
280
287
  ### No Specialized Methods
281
288
 
282
289
  ```typescript
@@ -257,6 +257,13 @@ All methods accept an optional `metadata` parameter as the last argument for dia
257
257
 
258
258
  ## Common Pitfalls
259
259
 
260
+ ### Streaming Is Not Supported
261
+
262
+ `apiRequest()` does not support streaming or Server-Sent Events. Do not set
263
+ `stream: true` — streaming responses fail schema validation. Every call
264
+ returns the complete response; if a UI needs real-time token streaming,
265
+ handle it at the frontend layer, not through the SDK.
266
+
260
267
  ### No Specialized Methods
261
268
 
262
269
  The OpenAI client only provides `apiRequest()`. There are no other specialized methods:
@@ -189,6 +189,13 @@ All methods accept an optional `metadata` parameter as the last argument for dia
189
189
 
190
190
  ## Common Pitfalls
191
191
 
192
+ ### Streaming Is Not Supported
193
+
194
+ `apiRequest()` does not support streaming or Server-Sent Events. Do not set
195
+ `stream: true` — streaming responses fail schema validation. Every call
196
+ returns the complete response; if a UI needs real-time token streaming,
197
+ handle it at the frontend layer, not through the SDK.
198
+
192
199
  ### No Specialized Methods
193
200
 
194
201
  ```typescript
@@ -25,6 +25,7 @@ import { api, z, s3 } from "@superblocksteam/sdk-api";
25
25
  const PROD_S3 = "a1b2c3d4-5678-90ab-cdef-s300000001";
26
26
 
27
27
  export default api({
28
+ name: "ListBucketObjects",
28
29
  integrations: {
29
30
  storage: s3(PROD_S3),
30
31
  },
@@ -108,6 +108,14 @@ All methods accept an optional `metadata` parameter as the last argument for dia
108
108
 
109
109
  ## Common Pitfalls
110
110
 
111
+ ### Streaming Is Not Supported
112
+
113
+ `apiRequest()` does not support streaming or Server-Sent Events. Always set
114
+ `stream: false` in Cortex request bodies (as the examples do) — a streaming
115
+ response fails schema validation. Every call returns the complete response;
116
+ if a UI needs real-time token streaming, handle it at the frontend layer,
117
+ not through the SDK.
118
+
111
119
  ### No Specialized Methods
112
120
 
113
121
  The Snowflake Cortex client only provides `apiRequest()`. There are no other specialized methods:
@@ -234,6 +234,13 @@ All methods accept an optional `metadata` parameter as the last argument for dia
234
234
 
235
235
  ## Common Pitfalls
236
236
 
237
+ ### Streaming Is Not Supported
238
+
239
+ `apiRequest()` does not support streaming or Server-Sent Events. Do not set
240
+ `stream: true` — streaming responses fail schema validation. Every call
241
+ returns the complete response; if a UI needs real-time token streaming,
242
+ handle it at the frontend layer, not through the SDK.
243
+
237
244
  ### No Specialized Methods
238
245
 
239
246
  ```typescript