@superblocksteam/sdk-api 0.0.4

package/src/integrations/s3/README.md

@@ -0,0 +1,136 @@
+# S3 Client
+
+Interact with Amazon S3 buckets with full type safety and runtime validation.
+
+## Methods
+
+| Method                                                  | Description              |
+| ------------------------------------------------------- | ------------------------ |
+| `listBuckets(schema, metadata?)`                        | List all buckets         |
+| `listObjects(bucket, schema, options?, metadata?)`      | List objects in a bucket |
+| `getObject(bucket, path, schema, options?, metadata?)`  | Get an object            |
+| `deleteObject(bucket, path, metadata?)`                 | Delete an object         |
+| `uploadObject(bucket, path, body, metadata?)`           | Upload a single object   |
+| `uploadMultipleObjects(bucket, fileObjects, metadata?)` | Upload multiple objects  |
+| `generatePresignedUrl(bucket, path, schema, metadata?)` | Generate a presigned URL |
+
+## Usage
+
+### List Objects in a Bucket
+
+```typescript
+import { api, z, s3 } from "@superblocksteam/sdk-api";
+
+// Integration ID from the integrations panel
+const PROD_S3 = "a1b2c3d4-5678-90ab-cdef-s300000001";
+
+export default api({
+  integrations: {
+    storage: s3(PROD_S3),
+  },
+  input: z.object({
+    bucket: z.string(),
+    prefix: z.string().optional(),
+  }),
+  output: z.object({
+    files: z.array(
+      z.object({
+        Key: z.string(),
+        Size: z.number(),
+      }),
+    ),
+  }),
+  async run(ctx, { bucket, prefix }) {
+    const files = await ctx.integrations.storage.listObjects(
+      bucket,
+      z.array(z.object({ Key: z.string(), Size: z.number() })),
+      prefix ? { prefix } : undefined,
+    );
+
+    return { files };
+  },
+});
+```
+
+### Get Object Content
+
+```typescript
+// For text files
+const content = await ctx.integrations.storage.getObject(
+  "my-bucket",
+  "data/file.txt",
+  z.string(),
+);
+
+// For JSON files
+const data = await ctx.integrations.storage.getObject(
+  "my-bucket",
+  "data/config.json",
+  z.object({ name: z.string(), value: z.number() }),
+);
+```
+
+### Upload Object
+
+```typescript
+await ctx.integrations.storage.uploadObject(
+  "my-bucket",
+  "uploads/file.txt",
+  "File content here",
+);
+```
+
+### Delete Object
+
+```typescript
+await ctx.integrations.storage.deleteObject("my-bucket", "uploads/file.txt");
+```
+
+### List Buckets
+
+```typescript
+const buckets = await ctx.integrations.storage.listBuckets(
+  z.array(z.object({ Name: z.string(), CreationDate: z.string() })),
+);
+```
+
+### Generate Presigned URL
+
+```typescript
+const url = await ctx.integrations.storage.generatePresignedUrl(
+  "my-bucket",
+  "private/document.pdf",
+  z.string(),
+);
+```
+
+## Trace Metadata
+
+All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
+
+## Error Handling
+
+```typescript
+import {
+  RestApiValidationError,
+  IntegrationError,
+} from "@superblocksteam/sdk-api";
+
+try {
+  const content = await ctx.integrations.storage.getObject(
+    "my-bucket",
+    "file.txt",
+    z.string(),
+  );
+} catch (error) {
+  if (error instanceof RestApiValidationError) {
+    console.error("Validation failed:", error.details.zodError);
+  } else if (error instanceof IntegrationError) {
+    console.error("S3 error:", error.message);
+  }
+}
+```
+
+## API Reference
+
+- [Amazon S3 Documentation](https://docs.aws.amazon.com/s3/)

package/src/integrations/s3/client.ts

@@ -0,0 +1,235 @@
+/**
+ * S3 client implementation.
+ *
+ * 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, TraceMetadata } from "../registry.js";
+import { RestApiValidationError } from "../../errors.js";
+import { IntegrationError } from "../../runtime/errors.js";
+import type {
+  S3Client,
+  S3Action,
+  S3ListObjectsOptions,
+  S3GetObjectOptions,
+} from "./types.js";
+
+/**
+ * Internal implementation of S3Client.
+ */
+export class S3ClientImpl implements S3Client, IntegrationClientImpl {
+  readonly config: IntegrationConfig;
+  private readonly executeQuery: QueryExecutor;
+
+  constructor(config: IntegrationConfig, executeQuery: QueryExecutor) {
+    this.config = config;
+    this.executeQuery = executeQuery;
+  }
+
+  get name(): string {
+    return this.config.name;
+  }
+
+  get pluginId(): string {
+    return this.config.pluginId;
+  }
+
+  /**
+   * Builds an S3 plugin request and executes it.
+   */
+  private async execute(
+    action: S3Action,
+    request: PartialMessage<S3Plugin>,
+    metadata?: TraceMetadata,
+  ): Promise<unknown> {
+    const fullRequest: PartialMessage<S3Plugin> = {
+      ...request,
+      action,
+    };
+
+    return this.executeQuery(
+      fullRequest as Record<string, unknown>,
+      undefined,
+      metadata,
+    );
+  }
+
+  /**
+   * Validates a result against a Zod schema.
+   */
+  private validate<T>(
+    result: unknown,
+    schema: z.ZodSchema<T>,
+    operation: string,
+  ): T {
+    const parseResult = schema.safeParse(result);
+
+    if (!parseResult.success) {
+      throw new RestApiValidationError(
+        `Result validation failed: ${parseResult.error.message}`,
+        {
+          zodError: parseResult.error,
+          data: result,
+        },
+      );
+    }
+
+    return parseResult.data;
+  }
+
+  /**
+   * Wraps an operation with standard error handling.
+   */
+  private async withErrorHandling<T>(
+    operation: string,
+    fn: () => Promise<T>,
+  ): Promise<T> {
+    try {
+      return await fn();
+    } catch (error) {
+      if (
+        error instanceof RestApiValidationError ||
+        error instanceof IntegrationError
+      ) {
+        throw error;
+      }
+
+      throw new IntegrationError(this.config.name, operation, error);
+    }
+  }
+
+  async listBuckets<T>(
+    schema: z.ZodSchema<T>,
+    metadata?: TraceMetadata,
+  ): Promise<T> {
+    return this.withErrorHandling("listBuckets", async () => {
+      const result = await this.execute("LIST_BUCKETS", {}, metadata);
+      return this.validate(result, schema, "listBuckets");
+    });
+  }
+
+  async listObjects<T>(
+    bucket: string,
+    schema: z.ZodSchema<T>,
+    options?: S3ListObjectsOptions,
+    metadata?: TraceMetadata,
+  ): Promise<T> {
+    return this.withErrorHandling("listObjects", async () => {
+      const request: PartialMessage<S3Plugin> = {
+        resource: bucket,
+      };
+
+      if (options?.prefix || options?.delimiter) {
+        request.listFilesConfig = {
+          prefix: options.prefix,
+          delimiter: options.delimiter,
+        };
+      }
+
+      const result = await this.execute(
+        "LIST_BUCKET_OBJECTS",
+        request,
+        metadata,
+      );
+      return this.validate(result, schema, "listObjects");
+    });
+  }
+
+  async getObject<T>(
+    bucket: string,
+    path: string,
+    schema: z.ZodSchema<T>,
+    options?: S3GetObjectOptions,
+    metadata?: TraceMetadata,
+  ): Promise<T> {
+    return this.withErrorHandling("getObject", async () => {
+      const request: PartialMessage<S3Plugin> = {
+        resource: bucket,
+        path,
+      };
+
+      if (options?.responseType) {
+        request.responseType = options.responseType;
+      }
+
+      const result = await this.execute("GET_OBJECT", request, metadata);
+      return this.validate(result, schema, "getObject");
+    });
+  }
+
+  async deleteObject(
+    bucket: string,
+    path: string,
+    metadata?: TraceMetadata,
+  ): Promise<void> {
+    return this.withErrorHandling("deleteObject", async () => {
+      await this.execute(
+        "DELETE_OBJECT",
+        {
+          resource: bucket,
+          path,
+        },
+        metadata,
+      );
+    });
+  }
+
+  async uploadObject(
+    bucket: string,
+    path: string,
+    body: string,
+    metadata?: TraceMetadata,
+  ): Promise<void> {
+    return this.withErrorHandling("uploadObject", async () => {
+      await this.execute(
+        "UPLOAD_OBJECT",
+        {
+          resource: bucket,
+          path,
+          body,
+        },
+        metadata,
+      );
+    });
+  }
+
+  async uploadMultipleObjects(
+    bucket: string,
+    fileObjects: string,
+    metadata?: TraceMetadata,
+  ): Promise<void> {
+    return this.withErrorHandling("uploadMultipleObjects", async () => {
+      await this.execute(
+        "UPLOAD_MULTIPLE_OBJECTS",
+        {
+          resource: bucket,
+          fileObjects,
+        },
+        metadata,
+      );
+    });
+  }
+
+  async generatePresignedUrl<T>(
+    bucket: string,
+    path: string,
+    schema: z.ZodSchema<T>,
+    metadata?: TraceMetadata,
+  ): Promise<T> {
+    return this.withErrorHandling("generatePresignedUrl", async () => {
+      const result = await this.execute(
+        "GENERATE_PRESIGNED_URL",
+        {
+          resource: bucket,
+          path,
+        },
+        metadata,
+      );
+      return this.validate(result, schema, "generatePresignedUrl");
+    });
+  }
+}

package/src/integrations/s3/index.ts

@@ -0,0 +1,13 @@
+/**
+ * S3 integration client.
+ *
+ * @module
+ */
+
+export type {
+  S3Client,
+  S3Action,
+  S3ListObjectsOptions,
+  S3GetObjectOptions,
+} from "./types.js";
+export { S3ClientImpl } from "./client.js";

package/src/integrations/s3/types.ts

@@ -0,0 +1,170 @@
+/**
+ * S3 client types.
+ */
+
+import type { z } from "zod";
+import type { BaseIntegrationClient } from "../../types.js";
+import type { TraceMetadata } from "../registry.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";
+
+/**
+ * Options for listing objects in a bucket.
+ */
+export interface S3ListObjectsOptions {
+  /** Prefix filter for listing */
+  prefix?: string;
+  /** Delimiter for listing (e.g., '/' for directory-like grouping) */
+  delimiter?: string;
+}
+
+/**
+ * Options for getting an object.
+ */
+export interface S3GetObjectOptions {
+  /** Response type (e.g., 'text', 'binary', 'json') */
+  responseType?: string;
+}
+
+/**
+ * S3 client for storage operations.
+ *
+ * Provides per-operation methods for common S3 tasks with schema validation.
+ *
+ * @example
+ * ```typescript
+ * const s3 = ctx.integrations.storage;
+ *
+ * // List buckets
+ * const buckets = await s3.listBuckets(z.array(z.object({ Name: z.string() })));
+ *
+ * // List objects in a bucket
+ * const files = await s3.listObjects('my-bucket', z.array(z.object({
+ *   Key: z.string(),
+ *   Size: z.number(),
+ * })), { prefix: 'uploads/' });
+ *
+ * // Get an object
+ * const content = await s3.getObject('my-bucket', 'data/file.txt', z.string());
+ *
+ * // Upload an object
+ * await s3.uploadObject('my-bucket', 'data/file.txt', 'Hello, World!');
+ *
+ * // Delete an object
+ * await s3.deleteObject('my-bucket', 'data/file.txt');
+ *
+ * // Generate a presigned URL
+ * const url = await s3.generatePresignedUrl('my-bucket', 'data/file.txt', z.string());
+ * ```
+ */
+export interface S3Client extends BaseIntegrationClient {
+  /**
+   * List all S3 buckets.
+   *
+   * @param schema - Zod schema for validating the result
+   * @returns The validated bucket list
+   */
+  listBuckets<T>(schema: z.ZodSchema<T>, metadata?: TraceMetadata): Promise<T>;
+
+  /**
+   * List objects in a bucket.
+   *
+   * @param bucket - Bucket name
+   * @param schema - Zod schema for validating the result
+   * @param options - Optional prefix and delimiter filters
+   * @param metadata - Optional trace metadata for diagnostics
+   * @returns The validated object list
+   */
+  listObjects<T>(
+    bucket: string,
+    schema: z.ZodSchema<T>,
+    options?: S3ListObjectsOptions,
+    metadata?: TraceMetadata,
+  ): Promise<T>;
+
+  /**
+   * Get an object from a bucket.
+   *
+   * @param bucket - Bucket name
+   * @param path - Object key/path
+   * @param schema - Zod schema for validating the result
+   * @param options - Optional response type
+   * @param metadata - Optional trace metadata for diagnostics
+   * @returns The validated object content
+   */
+  getObject<T>(
+    bucket: string,
+    path: string,
+    schema: z.ZodSchema<T>,
+    options?: S3GetObjectOptions,
+    metadata?: TraceMetadata,
+  ): Promise<T>;
+
+  /**
+   * Delete an object from a bucket.
+   *
+   * @param bucket - Bucket name
+   * @param path - Object key/path
+   * @param metadata - Optional trace metadata for diagnostics
+   */
+  deleteObject(
+    bucket: string,
+    path: string,
+    metadata?: TraceMetadata,
+  ): Promise<void>;
+
+  /**
+   * Upload an object to a bucket.
+   *
+   * @param bucket - Bucket name
+   * @param path - Object key/path
+   * @param body - File content (base64 or text)
+   * @param metadata - Optional trace metadata for diagnostics
+   */
+  uploadObject(
+    bucket: string,
+    path: string,
+    body: string,
+    metadata?: TraceMetadata,
+  ): Promise<void>;
+
+  /**
+   * Upload multiple objects to a bucket.
+   *
+   * @param bucket - Bucket name
+   * @param fileObjects - Serialized file objects
+   * @param metadata - Optional trace metadata for diagnostics
+   */
+  uploadMultipleObjects(
+    bucket: string,
+    fileObjects: string,
+    metadata?: TraceMetadata,
+  ): Promise<void>;
+
+  /**
+   * Generate a presigned URL for an object.
+   *
+   * @param bucket - Bucket name
+   * @param path - Object key/path
+   * @param schema - Zod schema for validating the result
+   * @param metadata - Optional trace metadata for diagnostics
+   * @returns The validated presigned URL
+   */
+  generatePresignedUrl<T>(
+    bucket: string,
+    path: string,
+    schema: z.ZodSchema<T>,
+    metadata?: TraceMetadata,
+  ): Promise<T>;
+}