@superblocksteam/sdk-api 2.0.93 → 2.0.94-next.1

package/src/integrations/fireworks/README.md

@@ -4,8 +4,8 @@ Interact with Fireworks AI's fast inference platform for LLM chat completions an
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
+| Method                        | Description                                           |
+| ----------------------------- | ----------------------------------------------------- |
 | `apiRequest(options, schema)` | Make any Fireworks API request with schema validation |
 
 ## Usage
@@ -13,7 +13,7 @@ Interact with Fireworks AI's fast inference platform for LLM chat completions an
 ### Chat Completion
 
 ```typescript
-import { api, z } from "@superblocksteam/sdk-api";
+import { api, z, fireworks } from "@superblocksteam/sdk-api";
 
 // Integration ID from the integrations panel
 const PROD_FIREWORKS = "a1b2c3d4-5678-90ab-cdef-fireworks001";
@@ -31,7 +31,7 @@ const ChatCompletionResponseSchema = z.object({
         content: z.string(),
       }),
       finish_reason: z.string(),
-    })
+    }),
   ),
   usage: z.object({
     prompt_tokens: z.number(),
@@ -41,6 +41,9 @@ const ChatCompletionResponseSchema = z.object({
 });
 
 export default api({
+  integrations: {
+    fireworks: fireworks(PROD_FIREWORKS),
+  },
   name: "FireworksExample",
   input: z.object({
     prompt: z.string(),
@@ -49,9 +52,7 @@ export default api({
     response: z.string(),
   }),
   async run(ctx, { prompt }) {
-    const fireworks = ctx.fireworks(PROD_FIREWORKS);
-
-    const result = await fireworks.apiRequest(
+    const result = await ctx.integrations.fireworks.apiRequest(
       {
         method: "POST",
         path: "/inference/v1/chat/completions",
@@ -60,7 +61,7 @@ export default api({
           messages: [{ role: "user", content: prompt }],
         },
       },
-      { response: ChatCompletionResponseSchema }
+      { response: ChatCompletionResponseSchema },
     );
 
     return { response: result.choices[0]?.message.content ?? "" };
@@ -72,7 +73,7 @@ export default api({
 
 ```typescript
 // Llama 3.1 70B - High quality
-const llama70b = await fireworks.apiRequest(
+const llama70b = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/chat/completions",
@@ -81,11 +82,11 @@ const llama70b = await fireworks.apiRequest(
       messages: [{ role: "user", content: "Complex task..." }],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 
 // Llama 3.1 8B - Fast and efficient
-const llama8b = await fireworks.apiRequest(
+const llama8b = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/chat/completions",
@@ -94,11 +95,11 @@ const llama8b = await fireworks.apiRequest(
       messages: [{ role: "user", content: "Simple task..." }],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 
 // Mixtral MoE - Good for diverse tasks
-const mixtral = await fireworks.apiRequest(
+const mixtral = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/chat/completions",
@@ -107,11 +108,11 @@ const mixtral = await fireworks.apiRequest(
       messages: [{ role: "user", content: "..." }],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 
 // Qwen for code
-const qwen = await fireworks.apiRequest(
+const qwen = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/chat/completions",
@@ -120,7 +121,7 @@ const qwen = await fireworks.apiRequest(
       messages: [{ role: "user", content: "Write code..." }],
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 ```
 
@@ -134,7 +135,7 @@ const EmbeddingsResponseSchema = z.object({
       object: z.string(),
       embedding: z.array(z.number()),
       index: z.number(),
-    })
+    }),
   ),
   model: z.string(),
   usage: z.object({
@@ -143,7 +144,7 @@ const EmbeddingsResponseSchema = z.object({
   }),
 });
 
-const result = await fireworks.apiRequest(
+const result = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/embeddings",
@@ -152,7 +153,7 @@ const result = await fireworks.apiRequest(
       input: ["Hello world", "How are you?"],
     },
   },
-  { response: EmbeddingsResponseSchema }
+  { response: EmbeddingsResponseSchema },
 );
 ```
 
@@ -175,24 +176,22 @@ const FunctionCallResponseSchema = z.object({
                 name: z.string(),
                 arguments: z.string(),
               }),
-            })
+            }),
           )
           .optional(),
       }),
       finish_reason: z.string(),
-    })
+    }),
   ),
 });
 
-const result = await fireworks.apiRequest(
+const result = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/chat/completions",
     body: {
       model: "accounts/fireworks/models/firefunction-v2",
-      messages: [
-        { role: "user", content: "What's the weather in Paris?" },
-      ],
+      messages: [{ role: "user", content: "What's the weather in Paris?" }],
       tools: [
         {
           type: "function",
@@ -211,26 +210,24 @@ const result = await fireworks.apiRequest(
       ],
     },
   },
-  { response: FunctionCallResponseSchema }
+  { response: FunctionCallResponseSchema },
 );
 ```
 
 ### JSON Mode
 
 ```typescript
-const result = await fireworks.apiRequest(
+const result = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/chat/completions",
     body: {
       model: "accounts/fireworks/models/llama-v3p1-70b-instruct",
-      messages: [
-        { role: "user", content: "List 3 colors in JSON format" },
-      ],
+      messages: [{ role: "user", content: "List 3 colors in JSON format" }],
       response_format: { type: "json_object" },
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 
 const data = JSON.parse(result.choices[0]?.message.content ?? "{}");
@@ -239,7 +236,7 @@ const data = JSON.parse(result.choices[0]?.message.content ?? "{}");
 ### Grammar-Constrained Output
 
 ```typescript
-const result = await fireworks.apiRequest(
+const result = await ctx.integrations.fireworks.apiRequest(
   {
     method: "POST",
     path: "/inference/v1/chat/completions",
@@ -260,7 +257,7 @@ const result = await fireworks.apiRequest(
       },
     },
   },
-  { response: ChatCompletionResponseSchema }
+  { response: ChatCompletionResponseSchema },
 );
 ```
 
@@ -274,7 +271,7 @@ await fireworks.chat({ ... });
 await fireworks.complete({ ... });
 
 // CORRECT - Use apiRequest
-await fireworks.apiRequest(
+await ctx.integrations.fireworks.apiRequest(
   { method: "POST", path: "/inference/v1/chat/completions", body: { ... } },
   { response: ChatCompletionResponseSchema }
 );
@@ -304,13 +301,13 @@ Fireworks uses `/inference/v1/` prefix:
 
 ```typescript
 // WRONG - Missing inference prefix
-await fireworks.apiRequest(
+await ctx.integrations.fireworks.apiRequest(
   { method: "POST", path: "/v1/chat/completions", body: { ... } },
   { response: schema }
 );
 
 // CORRECT - Include inference prefix
-await fireworks.apiRequest(
+await ctx.integrations.fireworks.apiRequest(
   { method: "POST", path: "/inference/v1/chat/completions", body: { ... } },
   { response: schema }
 );
@@ -335,7 +332,7 @@ Fireworks has rate limits. Check response headers:
 
 ```typescript
 // Monitor usage for rate limiting
-const result = await fireworks.apiRequest(...);
+const result = await ctx.integrations.fireworks.apiRequest(...);
 console.log("Tokens used:", result.usage.total_tokens);
 ```
 
@@ -345,7 +342,7 @@ console.log("Tokens used:", result.usage.total_tokens);
 import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
-  const result = await fireworks.apiRequest(
+  const result = await ctx.integrations.fireworks.apiRequest(
     { method: "POST", path: "/inference/v1/chat/completions", body: { ... } },
     { response: ChatCompletionResponseSchema }
   );

package/src/integrations/fireworks/client.ts

@@ -5,8 +5,8 @@
  * Fireworks integrations use the REST API Integration plugin under the hood.
  */
 
-import { RestApiIntegrationClient } from '../base/index.js';
-import type { FireworksClient } from './types.js';
+import { RestApiIntegrationClient } from "../base/index.js";
+import type { FireworksClient } from "./types.js";
 
 /**
  * Internal implementation of FireworksClient.
@@ -16,6 +16,8 @@ import type { FireworksClient } from './types.js';
  * Fireworks API calls. At runtime, the orchestrator handles authentication
  * and API request execution.
  */
-export class FireworksClientImpl extends RestApiIntegrationClient implements FireworksClient {
+export class FireworksClientImpl
+  extends RestApiIntegrationClient
+  implements FireworksClient {
   // Inherits: name, pluginId, config, executeQuery, apiRequest()
 }

package/src/integrations/fireworks/index.ts

@@ -1,2 +1,2 @@
-export { FireworksClientImpl } from './client.js';
-export type { FireworksClient } from './types.js';
+export { FireworksClientImpl } from "./client.js";
+export type { FireworksClient } from "./types.js";

package/src/integrations/fireworks/types.ts

@@ -2,8 +2,8 @@
  * Fireworks client types.
  */
 
-import type { BaseIntegrationClient } from '../../types.js';
-import type { SupportsApiRequest } from '../base/index.js';
+import type { BaseIntegrationClient } from "../../types.js";
+import type { SupportsApiRequest } from "../base/index.js";
 
 /**
  * Fireworks client for API interactions.
@@ -13,7 +13,8 @@ import type { SupportsApiRequest } from '../base/index.js';
  *
  * @example
  * ```typescript
- * const fireworks = ctx.fireworks('My Fireworks');
+ * // Declare in api(): integrations: { fireworks: fireworks(INTEGRATION_ID) }
+ * // In run(), access via ctx.integrations.fireworks
  *
  * // Make API requests
  * const ResponseSchema = z.object({
@@ -29,6 +30,7 @@ import type { SupportsApiRequest } from '../base/index.js';
  * );
  * ```
  */
-export interface FireworksClient extends BaseIntegrationClient, SupportsApiRequest {
+export interface FireworksClient
+  extends BaseIntegrationClient, SupportsApiRequest {
   // apiRequest() method inherited from SupportsApiRequest
 }

package/src/integrations/front/README.md

@@ -4,8 +4,8 @@ Manage conversations, contacts, and team inboxes with Front's collaborative emai
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
+| Method                        | Description                                       |
+| ----------------------------- | ------------------------------------------------- |
 | `apiRequest(options, schema)` | Make any Front API request with schema validation |
 
 ## Usage
@@ -13,7 +13,7 @@ Manage conversations, contacts, and team inboxes with Front's collaborative emai
 ### Get Conversation
 
 ```typescript
-import { api, z } from "@superblocksteam/sdk-api";
+import { api, z, front } from "@superblocksteam/sdk-api";
 
 // Integration ID from the integrations panel
 const PROD_FRONT = "a1b2c3d4-5678-90ab-cdef-front0000001";
@@ -41,6 +41,9 @@ const ConversationResponseSchema = z.object({
 });
 
 export default api({
+  integrations: {
+    front: front(PROD_FRONT),
+  },
   name: "FrontExample",
   input: z.object({
     conversationId: z.string(),
@@ -50,14 +53,12 @@ export default api({
     status: z.string(),
   }),
   async run(ctx, { conversationId }) {
-    const front = ctx.front(PROD_FRONT);
-
-    const result = await front.apiRequest(
+    const result = await ctx.integrations.front.apiRequest(
       {
         method: "GET",
         path: `/conversations/${conversationId}`,
       },
-      { response: ConversationResponseSchema }
+      { response: ConversationResponseSchema },
     );
 
     return { subject: result.subject, status: result.status };
@@ -85,7 +86,7 @@ const MessageResponseSchema = z.object({
     .nullable(),
 });
 
-const result = await front.apiRequest(
+const result = await ctx.integrations.front.apiRequest(
   {
     method: "POST",
     path: `/conversations/${conversationId}/messages`,
@@ -97,14 +98,14 @@ const result = await front.apiRequest(
       },
     },
   },
-  { response: MessageResponseSchema }
+  { response: MessageResponseSchema },
 );
 ```
 
 ### Create a New Conversation
 
 ```typescript
-const result = await front.apiRequest(
+const result = await ctx.integrations.front.apiRequest(
   {
     method: "POST",
     path: `/channels/${channelId}/messages`,
@@ -118,7 +119,7 @@ const result = await front.apiRequest(
       },
     },
   },
-  { response: MessageResponseSchema }
+  { response: MessageResponseSchema },
 );
 ```
 
@@ -135,7 +136,7 @@ const ListConversationsResponseSchema = z.object({
   }),
 });
 
-const result = await front.apiRequest(
+const result = await ctx.integrations.front.apiRequest(
   {
     method: "GET",
     path: `/inboxes/${inboxId}/conversations`,
@@ -144,7 +145,7 @@ const result = await front.apiRequest(
       limit: 25,
     },
   },
-  { response: ListConversationsResponseSchema }
+  { response: ListConversationsResponseSchema },
 );
 
 result._results.forEach((conv) => {
@@ -168,7 +169,7 @@ const CommentResponseSchema = z.object({
   created_at: z.number(),
 });
 
-const result = await front.apiRequest(
+const result = await ctx.integrations.front.apiRequest(
   {
     method: "POST",
     path: `/conversations/${conversationId}/comments`,
@@ -177,14 +178,14 @@ const result = await front.apiRequest(
       body: "Internal note: Customer is a VIP, handle with care.",
     },
   },
-  { response: CommentResponseSchema }
+  { response: CommentResponseSchema },
 );
 ```
 
 ### Assign Conversation
 
 ```typescript
-await front.apiRequest(
+await ctx.integrations.front.apiRequest(
   {
     method: "PATCH",
     path: `/conversations/${conversationId}`,
@@ -193,14 +194,14 @@ await front.apiRequest(
       status: "open",
     },
   },
-  { response: ConversationResponseSchema }
+  { response: ConversationResponseSchema },
 );
 ```
 
 ### Add Tags to Conversation
 
 ```typescript
-await front.apiRequest(
+await ctx.integrations.front.apiRequest(
   {
     method: "POST",
     path: `/conversations/${conversationId}/tags`,
@@ -208,7 +209,7 @@ await front.apiRequest(
       tag_ids: ["tag_123", "tag_456"],
     },
   },
-  { response: z.object({}).optional() }
+  { response: z.object({}).optional() },
 );
 ```
 
@@ -226,30 +227,30 @@ const ContactResponseSchema = z.object({
     z.object({
       handle: z.string(),
       source: z.string(),
-    })
+    }),
   ),
   groups: z.array(
     z.object({
       id: z.string(),
       name: z.string(),
-    })
+    }),
   ),
   custom_fields: z.record(z.unknown()),
 });
 
-const result = await front.apiRequest(
+const result = await ctx.integrations.front.apiRequest(
   {
     method: "GET",
     path: `/contacts/${contactId}`,
   },
-  { response: ContactResponseSchema }
+  { response: ContactResponseSchema },
 );
 ```
 
 ### Create Contact
 
 ```typescript
-const result = await front.apiRequest(
+const result = await ctx.integrations.front.apiRequest(
   {
     method: "POST",
     path: "/contacts",
@@ -266,7 +267,7 @@ const result = await front.apiRequest(
       },
     },
   },
-  { response: ContactResponseSchema }
+  { response: ContactResponseSchema },
 );
 ```
 
@@ -280,7 +281,7 @@ await front.sendMessage({ ... });
 await front.createConversation({ ... });
 
 // CORRECT - Use apiRequest
-await front.apiRequest(
+await ctx.integrations.front.apiRequest(
   { method: "POST", path: `/conversations/${id}/messages`, body: { ... } },
   { response: MessageResponseSchema }
 );
@@ -376,9 +377,9 @@ const params = {
 import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
-  const result = await front.apiRequest(
+  const result = await ctx.integrations.front.apiRequest(
     { method: "GET", path: `/conversations/${id}` },
-    { response: ConversationResponseSchema }
+    { response: ConversationResponseSchema },
   );
 } catch (error) {
   if (error instanceof RestApiValidationError) {

package/src/integrations/front/client.ts

@@ -5,8 +5,8 @@
  * Front integrations use the REST API Integration plugin under the hood.
  */
 
-import { RestApiIntegrationClient } from '../base/index.js';
-import type { FrontClient } from './types.js';
+import { RestApiIntegrationClient } from "../base/index.js";
+import type { FrontClient } from "./types.js";
 
 /**
  * Internal implementation of FrontClient.
@@ -16,6 +16,8 @@ import type { FrontClient } from './types.js';
  * Front API calls. At runtime, the orchestrator handles authentication
  * and API request execution.
  */
-export class FrontClientImpl extends RestApiIntegrationClient implements FrontClient {
+export class FrontClientImpl
+  extends RestApiIntegrationClient
+  implements FrontClient {
   // Inherits: name, pluginId, config, executeQuery, apiRequest()
 }

package/src/integrations/front/index.ts

@@ -1,2 +1,2 @@
-export { FrontClientImpl } from './client.js';
-export type { FrontClient } from './types.js';
+export { FrontClientImpl } from "./client.js";
+export type { FrontClient } from "./types.js";

package/src/integrations/front/types.ts

@@ -2,8 +2,8 @@
  * Front client types.
  */
 
-import type { BaseIntegrationClient } from '../../types.js';
-import type { SupportsApiRequest } from '../base/index.js';
+import type { BaseIntegrationClient } from "../../types.js";
+import type { SupportsApiRequest } from "../base/index.js";
 
 /**
  * Front client for API interactions.
@@ -13,7 +13,8 @@ import type { SupportsApiRequest } from '../base/index.js';
  *
  * @example
  * ```typescript
- * const front = ctx.front('My Front');
+ * // Declare in api(): integrations: { front: front(INTEGRATION_ID) }
+ * // In run(), access via ctx.integrations.front
  *
  * // Make API requests
  * const ResponseSchema = z.object({

package/src/integrations/gcs/README.md

@@ -4,15 +4,15 @@ Interact with Google Cloud Storage buckets with full type safety and runtime val
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
-| `listBuckets(schema)` | List all buckets |
-| `listObjects(bucket, schema, options?)` | List objects in a bucket |
-| `getObject(bucket, path, schema, options?)` | Get an object |
-| `deleteObject(bucket, path)` | Delete an object |
-| `uploadObject(bucket, path, body)` | Upload a single object |
-| `uploadMultipleObjects(bucket, fileObjects)` | Upload multiple objects |
-| `generateSignedUrl(bucket, path, schema)` | Generate a signed URL |
+| Method                                       | Description              |
+| -------------------------------------------- | ------------------------ |
+| `listBuckets(schema)`                        | List all buckets         |
+| `listObjects(bucket, schema, options?)`      | List objects in a bucket |
+| `getObject(bucket, path, schema, options?)`  | Get an object            |
+| `deleteObject(bucket, path)`                 | Delete an object         |
+| `uploadObject(bucket, path, body)`           | Upload a single object   |
+| `uploadMultipleObjects(bucket, fileObjects)` | Upload multiple objects  |
+| `generateSignedUrl(bucket, path, schema)`    | Generate a signed URL    |
 
 ## Usage
 
@@ -21,19 +21,24 @@ Interact with Google Cloud Storage buckets with full type safety and runtime val
 ```typescript
 import { api, z, gcs } from "@superblocksteam/sdk-api";
 
+// Integration ID from the integrations panel
+const PROD_GCS = "a1b2c3d4-5678-90ab-cdef-gcs0000001";
+
 export default api({
   integrations: {
-    storage: gcs("Production GCS"),
+    storage: gcs(PROD_GCS),
   },
   input: z.object({
     bucket: z.string(),
     prefix: z.string().optional(),
   }),
   output: z.object({
-    files: z.array(z.object({
-      name: z.string(),
-      size: z.string(),
-    })),
+    files: z.array(
+      z.object({
+        name: z.string(),
+        size: z.string(),
+      }),
+    ),
   }),
   async run(ctx, { bucket, prefix }) {
     const files = await ctx.integrations.storage.listObjects(
@@ -78,10 +83,7 @@ await ctx.integrations.storage.uploadObject(
 ### Delete Object
 
 ```typescript
-await ctx.integrations.storage.deleteObject(
-  "my-bucket",
-  "uploads/file.txt",
-);
+await ctx.integrations.storage.deleteObject("my-bucket", "uploads/file.txt");
 ```
 
 ### List Buckets
@@ -118,7 +120,10 @@ const schema = z.object({
 ## Error Handling
 
 ```typescript
-import { RestApiValidationError, IntegrationError } from "@superblocksteam/sdk-api";
+import {
+  RestApiValidationError,
+  IntegrationError,
+} from "@superblocksteam/sdk-api";
 
 try {
   const content = await ctx.integrations.storage.getObject(