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

package/src/integrations/s3/client.ts

@@ -4,19 +4,19 @@
  * Uses the native S3 plugin type from @superblocksteam/types.
  */
 
-import type { z } from 'zod';
-import type { PartialMessage } from '@bufbuild/protobuf';
-import type { Plugin as S3Plugin } from '@superblocksteam/types/dist/src/plugins/s3/v1/plugin_pb';
-import type { IntegrationConfig, IntegrationClientImpl } from '../types.js';
-import type { QueryExecutor } from '../registry.js';
-import { RestApiValidationError } from '../../errors.js';
-import { IntegrationError } from '../../runtime/errors.js';
+import type { z } from "zod";
+import type { PartialMessage } from "@bufbuild/protobuf";
+import type { Plugin as S3Plugin } from "@superblocksteam/types/dist/src/plugins/s3/v1/plugin_pb";
+import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
+import type { QueryExecutor } from "../registry.js";
+import { RestApiValidationError } from "../../errors.js";
+import { IntegrationError } from "../../runtime/errors.js";
 import type {
   S3Client,
   S3Action,
   S3ListObjectsOptions,
   S3GetObjectOptions,
-} from './types.js';
+} from "./types.js";
 
 /**
  * Internal implementation of S3Client.
@@ -98,9 +98,9 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
   }
 
   async listBuckets<T>(schema: z.ZodSchema<T>): Promise<T> {
-    return this.withErrorHandling('listBuckets', async () => {
-      const result = await this.execute('LIST_BUCKETS', {});
-      return this.validate(result, schema, 'listBuckets');
+    return this.withErrorHandling("listBuckets", async () => {
+      const result = await this.execute("LIST_BUCKETS", {});
+      return this.validate(result, schema, "listBuckets");
     });
   }
 
@@ -109,7 +109,7 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
     schema: z.ZodSchema<T>,
     options?: S3ListObjectsOptions,
   ): Promise<T> {
-    return this.withErrorHandling('listObjects', async () => {
+    return this.withErrorHandling("listObjects", async () => {
       const request: PartialMessage<S3Plugin> = {
         resource: bucket,
       };
@@ -121,8 +121,8 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
         };
       }
 
-      const result = await this.execute('LIST_BUCKET_OBJECTS', request);
-      return this.validate(result, schema, 'listObjects');
+      const result = await this.execute("LIST_BUCKET_OBJECTS", request);
+      return this.validate(result, schema, "listObjects");
     });
   }
 
@@ -132,7 +132,7 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
     schema: z.ZodSchema<T>,
     options?: S3GetObjectOptions,
   ): Promise<T> {
-    return this.withErrorHandling('getObject', async () => {
+    return this.withErrorHandling("getObject", async () => {
       const request: PartialMessage<S3Plugin> = {
         resource: bucket,
         path,
@@ -142,14 +142,14 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
         request.responseType = options.responseType;
       }
 
-      const result = await this.execute('GET_OBJECT', request);
-      return this.validate(result, schema, 'getObject');
+      const result = await this.execute("GET_OBJECT", request);
+      return this.validate(result, schema, "getObject");
     });
   }
 
   async deleteObject(bucket: string, path: string): Promise<void> {
-    return this.withErrorHandling('deleteObject', async () => {
-      await this.execute('DELETE_OBJECT', {
+    return this.withErrorHandling("deleteObject", async () => {
+      await this.execute("DELETE_OBJECT", {
         resource: bucket,
         path,
       });
@@ -161,8 +161,8 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
     path: string,
     body: string,
   ): Promise<void> {
-    return this.withErrorHandling('uploadObject', async () => {
-      await this.execute('UPLOAD_OBJECT', {
+    return this.withErrorHandling("uploadObject", async () => {
+      await this.execute("UPLOAD_OBJECT", {
         resource: bucket,
         path,
         body,
@@ -174,8 +174,8 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
     bucket: string,
     fileObjects: string,
   ): Promise<void> {
-    return this.withErrorHandling('uploadMultipleObjects', async () => {
-      await this.execute('UPLOAD_MULTIPLE_OBJECTS', {
+    return this.withErrorHandling("uploadMultipleObjects", async () => {
+      await this.execute("UPLOAD_MULTIPLE_OBJECTS", {
         resource: bucket,
         fileObjects,
       });
@@ -187,13 +187,12 @@ export class S3ClientImpl implements S3Client, IntegrationClientImpl {
     path: string,
     schema: z.ZodSchema<T>,
   ): Promise<T> {
-    return this.withErrorHandling('generatePresignedUrl', async () => {
-      const result = await this.execute('GENERATE_PRESIGNED_URL', {
+    return this.withErrorHandling("generatePresignedUrl", async () => {
+      const result = await this.execute("GENERATE_PRESIGNED_URL", {
         resource: bucket,
         path,
       });
-      return this.validate(result, schema, 'generatePresignedUrl');
+      return this.validate(result, schema, "generatePresignedUrl");
     });
   }
-
 }

package/src/integrations/s3/index.ts

@@ -9,5 +9,5 @@ export type {
   S3Action,
   S3ListObjectsOptions,
   S3GetObjectOptions,
-} from './types.js';
-export { S3ClientImpl } from './client.js';
+} from "./types.js";
+export { S3ClientImpl } from "./client.js";

package/src/integrations/s3/types.ts

@@ -2,21 +2,21 @@
  * S3 client types.
  */
 
-import type { z } from 'zod';
-import type { BaseIntegrationClient } from '../../types.js';
+import type { z } from "zod";
+import type { BaseIntegrationClient } from "../../types.js";
 
 /**
  * S3 action types (used internally by the client).
  */
 export type S3Action =
-  | 'LIST_OBJECTS'
-  | 'LIST_BUCKET_OBJECTS'
-  | 'GET_OBJECT'
-  | 'DELETE_OBJECT'
-  | 'UPLOAD_OBJECT'
-  | 'LIST_BUCKETS'
-  | 'UPLOAD_MULTIPLE_OBJECTS'
-  | 'GENERATE_PRESIGNED_URL';
+  | "LIST_OBJECTS"
+  | "LIST_BUCKET_OBJECTS"
+  | "GET_OBJECT"
+  | "DELETE_OBJECT"
+  | "UPLOAD_OBJECT"
+  | "LIST_BUCKETS"
+  | "UPLOAD_MULTIPLE_OBJECTS"
+  | "GENERATE_PRESIGNED_URL";
 
 /**
  * Options for listing objects in a bucket.
@@ -129,10 +129,7 @@ export interface S3Client extends BaseIntegrationClient {
    * @param bucket - Bucket name
    * @param fileObjects - Serialized file objects
    */
-  uploadMultipleObjects(
-    bucket: string,
-    fileObjects: string,
-  ): Promise<void>;
+  uploadMultipleObjects(bucket: string, fileObjects: string): Promise<void>;
 
   /**
    * Generate a presigned URL for an object.
@@ -147,5 +144,4 @@ export interface S3Client extends BaseIntegrationClient {
     path: string,
     schema: z.ZodSchema<T>,
   ): Promise<T>;
-
 }

package/src/integrations/salesforce/README.md

@@ -4,24 +4,24 @@ Execute SOQL queries, CRUD operations, and bulk operations against Salesforce wi
 
 ## Methods
 
-| Method | Description |
-| ------ | ----------- |
-| `query(soql, schema)` | Execute a SOQL query with per-row schema validation |
-| `create(resourceType, body)` | Create a new Salesforce object |
-| `read(resourceType, resourceId, schema)` | Read a single object by ID |
-| `update(resourceType, resourceId, body)` | Update an existing object |
-| `remove(resourceType, resourceId)` | Delete an object by ID |
-| `bulkCreate(resourceType, records)` | Bulk create multiple objects |
-| `bulkUpdate(resourceType, records)` | Bulk update multiple objects |
-| `bulkDelete(resourceType, records)` | Bulk delete multiple objects |
-| `bulkUpsert(resourceType, records, externalId)` | Bulk upsert with external ID matching |
+| Method                                          | Description                                         |
+| ----------------------------------------------- | --------------------------------------------------- |
+| `query(soql, schema)`                           | Execute a SOQL query with per-row schema validation |
+| `create(resourceType, body)`                    | Create a new Salesforce object                      |
+| `read(resourceType, resourceId, schema)`        | Read a single object by ID                          |
+| `update(resourceType, resourceId, body)`        | Update an existing object                           |
+| `remove(resourceType, resourceId)`              | Delete an object by ID                              |
+| `bulkCreate(resourceType, records)`             | Bulk create multiple objects                        |
+| `bulkUpdate(resourceType, records)`             | Bulk update multiple objects                        |
+| `bulkDelete(resourceType, records)`             | Bulk delete multiple objects                        |
+| `bulkUpsert(resourceType, records, externalId)` | Bulk upsert with external ID matching               |
 
 ## Usage
 
 ### SOQL Query
 
 ```typescript
-import { api, z } from "@superblocksteam/sdk-api";
+import { api, z, salesforce } from "@superblocksteam/sdk-api";
 
 // Integration ID from the integrations panel
 const PROD_SALESFORCE = "a1b2c3d4-5678-90ab-cdef-salesfor0001";
@@ -33,17 +33,18 @@ const AccountSchema = z.object({
 });
 
 export default api({
+  integrations: {
+    salesforce: salesforce(PROD_SALESFORCE),
+  },
   name: "SalesforceExample",
   input: z.object({}),
   output: z.object({
     accounts: z.array(AccountSchema),
   }),
   async run(ctx) {
-    const salesforce = ctx.salesforce(PROD_SALESFORCE);
-
-    const accounts = await salesforce.query(
+    const accounts = await ctx.integrations.salesforce.query(
       "SELECT Id, Name, Industry FROM Account LIMIT 10",
-      AccountSchema
+      AccountSchema,
     );
 
     return { accounts };
@@ -58,16 +59,18 @@ const OpportunitySchema = z.object({
   Id: z.string(),
   Name: z.string(),
   Amount: z.number().nullable(),
-  Account: z.object({
-    Name: z.string(),
-  }).nullable(),
+  Account: z
+    .object({
+      Name: z.string(),
+    })
+    .nullable(),
 });
 
-const opportunities = await salesforce.query(
+const opportunities = await ctx.integrations.salesforce.query(
   `SELECT Id, Name, Amount, Account.Name
    FROM Opportunity
    WHERE StageName = 'Closed Won'`,
-  OpportunitySchema
+  OpportunitySchema,
 );
 ```
 
@@ -91,7 +94,7 @@ const account = await salesforce.read(
     Id: z.string(),
     Name: z.string(),
     Industry: z.string().nullable(),
-  })
+  }),
 );
 ```
 
@@ -107,7 +110,7 @@ await salesforce.update("Account", "001xx000003DGb2AAG", {
 ### Delete a Record
 
 ```typescript
-await salesforce.remove("Account", "001xx000003DGb2AAG");
+await ctx.integrations.salesforce.remove("Account", "001xx000003DGb2AAG");
 ```
 
 ### Bulk Create
@@ -147,7 +150,7 @@ await salesforce.bulkUpsert(
     { ExternalId__c: "EXT-001", Name: "Acme Corp", Industry: "Tech" },
     { ExternalId__c: "EXT-002", Name: "Globex Inc", Industry: "Finance" },
   ],
-  "ExternalId__c"
+  "ExternalId__c",
 );
 ```
 
@@ -196,20 +199,22 @@ await salesforce.bulkUpdate("Contact", [
 ]);
 
 // WRONG - Missing Id field
-await salesforce.bulkUpdate("Contact", [
-  { Email: "new@example.com" },
-]);
+await salesforce.bulkUpdate("Contact", [{ Email: "new@example.com" }]);
 ```
 
 ## Error Handling
 
 ```typescript
-import { QueryValidationError, RestApiValidationError, IntegrationError } from "@superblocksteam/sdk-api";
+import {
+  QueryValidationError,
+  RestApiValidationError,
+  IntegrationError,
+} from "@superblocksteam/sdk-api";
 
 try {
-  const accounts = await salesforce.query(
+  const accounts = await ctx.integrations.salesforce.query(
     "SELECT Id, Name FROM Account",
-    AccountSchema
+    AccountSchema,
   );
 } catch (error) {
   if (error instanceof QueryValidationError) {

package/src/integrations/salesforce/client.ts

@@ -5,37 +5,37 @@
  * including SOQL queries, single-object CRUD, and bulk operations.
  */
 
-import type { z } from 'zod';
-import type { IntegrationConfig, IntegrationClientImpl } from '../types.js';
-import type { QueryExecutor } from '../registry.js';
-import { QueryValidationError, RestApiValidationError } from '../../errors.js';
-import { IntegrationError } from '../../runtime/errors.js';
-import { describeType } from '../utils.js';
-import type { SalesforceClient } from './types.js';
+import type { z } from "zod";
+import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
+import type { QueryExecutor } from "../registry.js";
+import { QueryValidationError, RestApiValidationError } from "../../errors.js";
+import { IntegrationError } from "../../runtime/errors.js";
+import { describeType } from "../utils.js";
+import type { SalesforceClient } from "./types.js";
 
 /**
  * SOQL action string value expected by the backend.
  */
-const SOQL_ACTION_SOQL = 'SOQL_ACTION_SOQL';
+const SOQL_ACTION_SOQL = "SOQL_ACTION_SOQL";
 
 /**
  * CRUD action string values matching proto CrudAction enum.
  */
 const CRUD_ACTION = {
-  CREATE: 'CRUD_ACTION_CREATE',
-  UPDATE: 'CRUD_ACTION_UPDATE',
-  DELETE: 'CRUD_ACTION_DELETE',
-  READ: 'CRUD_ACTION_READ',
+  CREATE: "CRUD_ACTION_CREATE",
+  UPDATE: "CRUD_ACTION_UPDATE",
+  DELETE: "CRUD_ACTION_DELETE",
+  READ: "CRUD_ACTION_READ",
 } as const;
 
 /**
  * Bulk action string values matching proto BulkAction enum.
  */
 const BULK_ACTION = {
-  CREATE: 'BULK_ACTION_CREATE',
-  UPDATE: 'BULK_ACTION_UPDATE',
-  DELETE: 'BULK_ACTION_DELETE',
-  UPSERT: 'BULK_ACTION_UPSERT',
+  CREATE: "BULK_ACTION_CREATE",
+  UPDATE: "BULK_ACTION_UPDATE",
+  DELETE: "BULK_ACTION_DELETE",
+  UPSERT: "BULK_ACTION_UPSERT",
 } as const;
 
 /**
@@ -138,13 +138,13 @@ export class SalesforceClientImpl
 
     const result = await this.exec(
       request as unknown as Record<string, unknown>,
-      'query',
+      "query",
     );
 
     if (!Array.isArray(result)) {
       throw new IntegrationError(
         this.config.name,
-        'query',
+        "query",
         `Expected array result from Salesforce query, got: ${describeType(result)}`,
       );
     }
@@ -181,7 +181,7 @@ export class SalesforceClientImpl
     const request = this.buildCrudRequest(CRUD_ACTION.CREATE, resourceType, {
       resourceBody: JSON.stringify(body),
     });
-    return this.exec(request, 'create');
+    return this.exec(request, "create");
   }
 
   async read<T>(
@@ -192,7 +192,7 @@ export class SalesforceClientImpl
     const request = this.buildCrudRequest(CRUD_ACTION.READ, resourceType, {
       resourceId,
     });
-    const result = await this.exec(request, 'read');
+    const result = await this.exec(request, "read");
 
     const parseResult = schema.safeParse(result);
     if (!parseResult.success) {
@@ -217,17 +217,14 @@ export class SalesforceClientImpl
       resourceId,
       resourceBody: JSON.stringify(body),
     });
-    return this.exec(request, 'update');
+    return this.exec(request, "update");
   }
 
-  async remove(
-    resourceType: string,
-    resourceId: string,
-  ): Promise<unknown> {
+  async remove(resourceType: string, resourceId: string): Promise<unknown> {
     const request = this.buildCrudRequest(CRUD_ACTION.DELETE, resourceType, {
       resourceId,
     });
-    return this.exec(request, 'remove');
+    return this.exec(request, "remove");
   }
 
   async bulkCreate(
@@ -239,7 +236,7 @@ export class SalesforceClientImpl
       resourceType,
       records,
     );
-    return this.exec(request, 'bulkCreate');
+    return this.exec(request, "bulkCreate");
   }
 
   async bulkUpdate(
@@ -251,7 +248,7 @@ export class SalesforceClientImpl
       resourceType,
       records,
     );
-    return this.exec(request, 'bulkUpdate');
+    return this.exec(request, "bulkUpdate");
   }
 
   async bulkDelete(
@@ -263,7 +260,7 @@ export class SalesforceClientImpl
       resourceType,
       records,
     );
-    return this.exec(request, 'bulkDelete');
+    return this.exec(request, "bulkDelete");
   }
 
   async bulkUpsert(
@@ -277,6 +274,6 @@ export class SalesforceClientImpl
       records,
       externalId,
     );
-    return this.exec(request, 'bulkUpsert');
+    return this.exec(request, "bulkUpsert");
   }
 }

package/src/integrations/salesforce/index.ts

@@ -4,5 +4,9 @@
  * @module
  */
 
-export type { SalesforceClient, SalesforceCrudAction, SalesforceBulkAction } from './types.js';
-export { SalesforceClientImpl } from './client.js';
+export type {
+  SalesforceClient,
+  SalesforceCrudAction,
+  SalesforceBulkAction,
+} from "./types.js";
+export { SalesforceClientImpl } from "./client.js";

package/src/integrations/salesforce/types.ts

@@ -2,26 +2,26 @@
  * Salesforce client types.
  */
 
-import type { z } from 'zod';
-import type { BaseIntegrationClient } from '../../types.js';
+import type { z } from "zod";
+import type { BaseIntegrationClient } from "../../types.js";
 
 /**
  * Salesforce CRUD action identifiers matching proto CrudAction enum.
  */
 export type SalesforceCrudAction =
-  | 'CRUD_ACTION_CREATE'
-  | 'CRUD_ACTION_UPDATE'
-  | 'CRUD_ACTION_DELETE'
-  | 'CRUD_ACTION_READ';
+  | "CRUD_ACTION_CREATE"
+  | "CRUD_ACTION_UPDATE"
+  | "CRUD_ACTION_DELETE"
+  | "CRUD_ACTION_READ";
 
 /**
  * Salesforce bulk action identifiers matching proto BulkAction enum.
  */
 export type SalesforceBulkAction =
-  | 'BULK_ACTION_CREATE'
-  | 'BULK_ACTION_UPDATE'
-  | 'BULK_ACTION_DELETE'
-  | 'BULK_ACTION_UPSERT';
+  | "BULK_ACTION_CREATE"
+  | "BULK_ACTION_UPDATE"
+  | "BULK_ACTION_DELETE"
+  | "BULK_ACTION_UPSERT";
 
 /**
  * Salesforce client for SOQL queries, CRUD, and bulk operations.
@@ -31,30 +31,31 @@ export type SalesforceBulkAction =
  *
  * @example
  * ```typescript
- * const sf = ctx.salesforce('Production Salesforce');
+ * // Declare in api(): integrations: { sf: salesforce(INTEGRATION_ID) }
+ * // In run(), access via ctx.integrations.sf
  *
  * // SOQL query
- * const accounts = await sf.query(
+ * const accounts = await ctx.integrations.sf.query(
  *   'SELECT Id, Name FROM Account LIMIT 10',
  *   z.object({ Id: z.string(), Name: z.string() })
  * );
  *
  * // Create a record
- * await sf.create('Account', { Name: 'Acme Corp', Industry: 'Tech' });
+ * await ctx.integrations.sf.create('Account', { Name: 'Acme Corp', Industry: 'Tech' });
  *
  * // Read a record
- * const account = await sf.read('Account', '001xx000003DGb2AAG',
+ * const account = await ctx.integrations.sf.read('Account', '001xx000003DGb2AAG',
  *   z.object({ Id: z.string(), Name: z.string() })
  * );
  *
  * // Update a record
- * await sf.update('Account', '001xx000003DGb2AAG', { Name: 'New Name' });
+ * await ctx.integrations.sf.update('Account', '001xx000003DGb2AAG', { Name: 'New Name' });
  *
  * // Delete a record
- * await sf.remove('Account', '001xx000003DGb2AAG');
+ * await ctx.integrations.sf.remove('Account', '001xx000003DGb2AAG');
  *
  * // Bulk upsert
- * await sf.bulkUpsert('Account', [{ Name: 'A' }, { Name: 'B' }], 'ExternalId__c');
+ * await ctx.integrations.sf.bulkUpsert('Account', [{ Name: 'A' }, { Name: 'B' }], 'ExternalId__c');
  * ```
  */
 export interface SalesforceClient extends BaseIntegrationClient {
@@ -84,7 +85,11 @@ export interface SalesforceClient extends BaseIntegrationClient {
    * @param schema - Zod schema for validating the result
    * @returns The validated record
    */
-  read<T>(resourceType: string, resourceId: string, schema: z.ZodSchema<T>): Promise<T>;
+  read<T>(
+    resourceType: string,
+    resourceId: string,
+    schema: z.ZodSchema<T>,
+  ): Promise<T>;
 
   /**
    * Update a Salesforce object by ID.