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

package/src/integrations/box/README.md

@@ -4,8 +4,8 @@ Upload, download, and manage files in Box.
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
+| Method                        | Description                                     |
+| ----------------------------- | ----------------------------------------------- |
 | `apiRequest(options, schema)` | Make any Box API request with schema validation |
 
 ## Usage
@@ -13,7 +13,7 @@ Upload, download, and manage files in Box.
 ### List Files in a Folder
 
 ```typescript
-import { api, z } from "@superblocksteam/sdk-api";
+import { api, z, box } from "@superblocksteam/sdk-api";
 
 // Integration ID from the integrations panel
 const PROD_BOX = "a1b2c3d4-5678-90ab-cdef-box000000001";
@@ -45,10 +45,14 @@ const ListItemsResponseSchema = z.object({
   total_count: z.number(),
   offset: z.number(),
   limit: z.number(),
-  order: z.array(z.object({
-    by: z.string(),
-    direction: z.string(),
-  })).optional(),
+  order: z
+    .array(
+      z.object({
+        by: z.string(),
+        direction: z.string(),
+      }),
+    )
+    .optional(),
 });
 
 export default api({
@@ -58,17 +62,17 @@ export default api({
     limit: z.number().default(100),
   }),
   output: z.object({
-    items: z.array(z.object({
-      id: z.string(),
-      name: z.string(),
-      type: z.string(),
-    })),
+    items: z.array(
+      z.object({
+        id: z.string(),
+        name: z.string(),
+        type: z.string(),
+      }),
+    ),
     totalCount: z.number(),
   }),
   async run(ctx, { folderId, limit }) {
-    const box = ctx.box(PROD_BOX);
-
-    const result = await box.apiRequest(
+    const result = await ctx.integrations.box.apiRequest(
       {
         method: "GET",
         path: `/2.0/folders/${folderId}/items`,
@@ -78,7 +82,7 @@ export default api({
           fields: "id,name,type,size,created_at,modified_at",
         },
       },
-      { response: ListItemsResponseSchema }
+      { response: ListItemsResponseSchema },
     );
 
     return {
@@ -118,21 +122,24 @@ const FileInfoSchema = z.object({
     name: z.string(),
   }),
   sha1: z.string(),
-  shared_link: z.object({
-    url: z.string(),
-    access: z.string(),
-  }).nullable(),
+  shared_link: z
+    .object({
+      url: z.string(),
+      access: z.string(),
+    })
+    .nullable(),
 });
 
-const file = await box.apiRequest(
+const file = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
     path: `/2.0/files/${fileId}`,
     params: {
-      fields: "id,name,size,created_at,modified_at,created_by,modified_by,parent,sha1,shared_link",
+      fields:
+        "id,name,size,created_at,modified_at,created_by,modified_by,parent,sha1,shared_link",
     },
   },
-  { response: FileInfoSchema }
+  { response: FileInfoSchema },
 );
 
 console.log(`File: ${file.name} (${file.size} bytes)`);
@@ -144,12 +151,12 @@ console.log(`File: ${file.name} (${file.size} bytes)`);
 // Get download URL
 const DownloadUrlResponseSchema = z.string();
 
-const content = await box.apiRequest(
+const content = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
     path: `/2.0/files/${fileId}/content`,
   },
-  { response: DownloadUrlResponseSchema }
+  { response: DownloadUrlResponseSchema },
 );
 ```
 
@@ -162,7 +169,7 @@ const UploadResponseSchema = z.object({
 });
 
 // For files < 50MB, use direct upload
-const result = await box.apiRequest(
+const result = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
     path: "/2.0/files/content",
@@ -177,7 +184,7 @@ const result = await box.apiRequest(
       file: fileContent,
     },
   },
-  { response: UploadResponseSchema }
+  { response: UploadResponseSchema },
 );
 
 const uploadedFile = result.entries[0];
@@ -199,7 +206,7 @@ const FolderInfoSchema = z.object({
   }),
 });
 
-const folder = await box.apiRequest(
+const folder = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
     path: "/2.0/folders",
@@ -210,7 +217,7 @@ const folder = await box.apiRequest(
       },
     },
   },
-  { response: FolderInfoSchema }
+  { response: FolderInfoSchema },
 );
 
 console.log(`Created folder: ${folder.name} (${folder.id})`);
@@ -219,7 +226,7 @@ console.log(`Created folder: ${folder.name} (${folder.id})`);
 ### Copy a File
 
 ```typescript
-const copiedFile = await box.apiRequest(
+const copiedFile = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
     path: `/2.0/files/${fileId}/copy`,
@@ -230,14 +237,14 @@ const copiedFile = await box.apiRequest(
       name: "Copy of file.txt", // Optional new name
     },
   },
-  { response: FileInfoSchema }
+  { response: FileInfoSchema },
 );
 ```
 
 ### Move a File
 
 ```typescript
-const movedFile = await box.apiRequest(
+const movedFile = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
     path: `/2.0/files/${fileId}`,
@@ -247,14 +254,14 @@ const movedFile = await box.apiRequest(
       },
     },
   },
-  { response: FileInfoSchema }
+  { response: FileInfoSchema },
 );
 ```
 
 ### Update File Information
 
 ```typescript
-const updatedFile = await box.apiRequest(
+const updatedFile = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
     path: `/2.0/files/${fileId}`,
@@ -264,19 +271,19 @@ const updatedFile = await box.apiRequest(
       tags: ["important", "quarterly"],
     },
   },
-  { response: FileInfoSchema }
+  { response: FileInfoSchema },
 );
 ```
 
 ### Delete a File
 
 ```typescript
-await box.apiRequest(
+await ctx.integrations.box.apiRequest(
   {
     method: "DELETE",
     path: `/2.0/files/${fileId}`,
   },
-  { response: z.void() }
+  { response: z.void() },
 );
 ```
 
@@ -294,7 +301,7 @@ const SharedLinkSchema = z.object({
   }),
 });
 
-const file = await box.apiRequest(
+const file = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
     path: `/2.0/files/${fileId}`,
@@ -311,7 +318,7 @@ const file = await box.apiRequest(
       },
     },
   },
-  { response: z.object({ shared_link: SharedLinkSchema }) }
+  { response: z.object({ shared_link: SharedLinkSchema }) },
 );
 
 console.log(`Share URL: ${file.shared_link.url}`);
@@ -327,7 +334,7 @@ const SearchResponseSchema = z.object({
   limit: z.number(),
 });
 
-const result = await box.apiRequest(
+const result = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
     path: "/2.0/search",
@@ -340,7 +347,7 @@ const result = await box.apiRequest(
       fields: "id,name,type,size,created_at",
     },
   },
-  { response: SearchResponseSchema }
+  { response: SearchResponseSchema },
 );
 
 result.entries.forEach((entry) => {
@@ -362,7 +369,7 @@ const CommentSchema = z.object({
   created_at: z.string(),
 });
 
-const comment = await box.apiRequest(
+const comment = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
     path: "/2.0/comments",
@@ -374,7 +381,7 @@ const comment = await box.apiRequest(
       message: "Great work on this document!",
     },
   },
-  { response: CommentSchema }
+  { response: CommentSchema },
 );
 ```
 
@@ -388,7 +395,7 @@ await box.listFiles({ ... });
 await box.uploadFile({ ... });
 
 // CORRECT - Use apiRequest
-await box.apiRequest(
+await ctx.integrations.box.apiRequest(
   { method: "GET", path: `/2.0/folders/${folderId}/items`, params: { ... } },
   { response: ListItemsResponseSchema }
 );
@@ -425,13 +432,13 @@ Use `fields` to get specific data:
 
 ```typescript
 // Without fields, you get minimal data
-const result = await box.apiRequest(
+const result = await ctx.integrations.box.apiRequest(
   { method: "GET", path: `/2.0/files/${fileId}` },
-  { response: FileSchema }
+  { response: FileSchema },
 );
 
 // With fields, specify what you need
-const result = await box.apiRequest(
+const result = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
     path: `/2.0/files/${fileId}`,
@@ -439,7 +446,7 @@ const result = await box.apiRequest(
       fields: "id,name,size,created_at,modified_at,parent,shared_link",
     },
   },
-  { response: FileInfoSchema }
+  { response: FileInfoSchema },
 );
 ```
 
@@ -463,7 +470,7 @@ const uploadedFile = result.entries[0];
 Use `If-Match` with etag for safe updates:
 
 ```typescript
-const result = await box.apiRequest(
+const result = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
     path: `/2.0/files/${fileId}`,
@@ -474,7 +481,7 @@ const result = await box.apiRequest(
       name: "new-name.txt",
     },
   },
-  { response: FileInfoSchema }
+  { response: FileInfoSchema },
 );
 ```
 
@@ -489,13 +496,13 @@ async function getAllItems(box: BoxClient, folderId: string) {
   let offset = 0;
 
   while (true) {
-    const result = await box.apiRequest(
+    const result = await ctx.integrations.box.apiRequest(
       {
         method: "GET",
         path: `/2.0/folders/${folderId}/items`,
         params: { limit, offset, fields: "id,name,type" },
       },
-      { response: ListItemsResponseSchema }
+      { response: ListItemsResponseSchema },
     );
 
     allItems.push(...result.entries);
@@ -545,7 +552,7 @@ const body = {
 import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
-  const result = await box.apiRequest(
+  const result = await ctx.integrations.box.apiRequest(
     { method: "GET", path: `/2.0/folders/${folderId}/items`, params: { ... } },
     { response: ListItemsResponseSchema }
   );

package/src/integrations/box/client.ts

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

package/src/integrations/box/index.ts

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

package/src/integrations/box/types.ts

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