@oasis-path/gamma-sdk 1.0.5 → 1.0.6

package/dist/client.d.ts

@@ -9,6 +9,6 @@ export declare class GammaFilesClient {
     deleteFile(fileId: string): Promise<DeleteFileResponse>;
     getFileMetadata(fileId: string): Promise<FileMetadataResponse>;
     generatePresignedUrl(options: PresignedUrlOptions): Promise<PresignedUrlResponse>;
-    viewFileByToken(token: string): Promise<ViewFileByTokenResult>;
+    viewFileByToken(fileId: string, token: string): Promise<ViewFileByTokenResult>;
     private request;
 }

package/dist/client.js

@@ -32,8 +32,8 @@ class GammaFilesClient {
     async generatePresignedUrl(options) {
         return (0, generatePresignedUrl_1.generatePresignedUrl)(options, this.request.bind(this));
     }
-    async viewFileByToken(token) {
-        return (0, viewFileByToken_1.viewFileByToken)(token, this.request.bind(this));
+    async viewFileByToken(fileId, token) {
+        return (0, viewFileByToken_1.viewFileByToken)(fileId, token, this.request.bind(this));
     }
     async request(method, path, options) {
         return (0, request_1.makeRequest)(method, path, this.baseUrl, this.apiKey, options);

package/dist/methods/uploadFile.js

@@ -5,35 +5,57 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.uploadFile = uploadFile;
 const form_data_1 = __importDefault(require("form-data"));
+const stream_1 = require("stream");
 async function uploadFile(baseUrl, apiKey, options, request) {
     const { file, filename, mimeType, folderId } = options;
     const form = new form_data_1.default();
-    let fileBuffer;
     let contentType = mimeType || 'application/octet-stream';
-    if (Buffer.isBuffer(file)) {
-        fileBuffer = file;
+    // Handle different file input types
+    if (file instanceof stream_1.Readable || file.pipe) {
+        // Stream support for Node.js - efficient for large files
+        form.append('file', file, {
+            filename,
+            contentType,
+        });
+    }
+    else if (Buffer.isBuffer(file)) {
+        // Direct buffer support
+        form.append('file', file, {
+            filename,
+            contentType,
+        });
     }
     else if (typeof file === 'string') {
-        // Handle base64 string
-        fileBuffer = Buffer.from(file, 'base64');
+        // Handle base64 string - convert to buffer
+        const fileBuffer = Buffer.from(file, 'base64');
+        form.append('file', fileBuffer, {
+            filename,
+            contentType,
+        });
     }
     else if (typeof Blob !== 'undefined' && file instanceof Blob) {
+        // Browser Blob support - must convert to buffer
         const arrayBuffer = await file.arrayBuffer();
-        fileBuffer = Buffer.from(arrayBuffer);
+        const fileBuffer = Buffer.from(arrayBuffer);
         contentType = mimeType || file.type || 'application/octet-stream';
+        form.append('file', fileBuffer, {
+            filename,
+            contentType,
+        });
     }
     else if (typeof File !== 'undefined' && file instanceof File) {
+        // Browser File support - must convert to buffer
         const arrayBuffer = await file.arrayBuffer();
-        fileBuffer = Buffer.from(arrayBuffer);
+        const fileBuffer = Buffer.from(arrayBuffer);
         contentType = mimeType || file.type || 'application/octet-stream';
+        form.append('file', fileBuffer, {
+            filename,
+            contentType,
+        });
     }
     else {
-        throw new Error('Unsupported file type');
+        throw new Error('Unsupported file type. Supported types: Buffer, Stream, Blob, File, or base64 string');
     }
-    form.append('file', fileBuffer, {
-        filename,
-        contentType,
-    });
     const url = folderId
         ? `/api/files/upload/${folderId}`
         : '/api/files/upload';

package/dist/methods/viewFileByToken.d.ts

@@ -1,2 +1,2 @@
 import { ViewFileByTokenResult } from '../types';
-export declare function viewFileByToken(token: string, request: <T>(method: string, path: string, options?: any) => Promise<T>): Promise<ViewFileByTokenResult>;
+export declare function viewFileByToken(fileId: string, token: string, request: <T>(method: string, path: string, options?: any) => Promise<T>): Promise<ViewFileByTokenResult>;

package/dist/methods/viewFileByToken.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.viewFileByToken = viewFileByToken;
-async function viewFileByToken(token, request) {
-    const url = `/api/files/view/${token}`;
+async function viewFileByToken(fileId, token, request) {
+    const url = `/api/files/view/${fileId}?token=${encodeURIComponent(token)}`;
     return request('GET', url, {
         binary: true,
         skipAuth: true,

package/dist/types.d.ts

@@ -13,7 +13,7 @@ export interface FileMetadata {
     createdAt: string;
 }
 export interface UploadFileOptions {
-    file: Buffer | Blob | File | string;
+    file: Buffer | Blob | File | string | NodeJS.ReadableStream;
     filename: string;
     mimeType?: string;
     folderId?: string;

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@oasis-path/gamma-sdk",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "TypeScript SDK for Gamma Files API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "publishConfig": {
-    "access": "public"
+  "publishConfig": { "access": "public" },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "prepublishOnly": "pnpm run build"
   },
   "keywords": [
     "gamma",
@@ -26,9 +29,5 @@
   },
   "files": [
     "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "watch": "tsc --watch"
-  }
-}
+  ]
+}

package/README.md

@@ -1,306 +0,0 @@
-# Gamma Files SDK
-
-TypeScript/JavaScript SDK for interacting with the Gamma Files API.
-
-## Installation
-
-```bash
-pnpm install @gamma/files-sdk
-```
-
-Or if you're developing locally:
-
-```bash
-cd sdk
-pnpm install
-pnpm run build
-```
-
-Then in your project:
-
-```bash
-pnpm install ../sdk
-```
-
-## Configuration
-
-Create a client instance with your API key and base URL:
-
-```typescript
-import { GammaFilesClient } from '@gamma/files-sdk';
-
-const client = new GammaFilesClient({
-  baseUrl: 'http://localhost:3000',
-  apiKey: 'your-api-key-here'
-});
-```
-
-## Usage Examples
-
-### Upload a File
-
-```typescript
-import * as fs from 'fs';
-
-// Upload from Node.js Buffer
-const fileBuffer = fs.readFileSync('./document.pdf');
-const result = await client.uploadFile({
-  file: fileBuffer,
-  filename: 'document.pdf',
-  mimeType: 'application/pdf',
-  folderId: 'folder-id-here' // optional, uploads to root if not specified
-});
-
-console.log('Uploaded file:', result.file);
-```
-
-In browser environment:
-
-```typescript
-// Upload from File input
-const fileInput = document.querySelector('input[type="file"]');
-const file = fileInput.files[0];
-
-const result = await client.uploadFile({
-  file: file,
-  filename: file.name,
-  mimeType: file.type,
-  folderId: 'folder-id-here' // optional
-});
-```
-
-### Download a File
-
-```typescript
-const fileData = await client.downloadFile('file-id-here');
-
-// In Node.js, save to disk
-const buffer = Buffer.from(fileData);
-fs.writeFileSync('./downloaded-file.pdf', buffer);
-
-// In browser, create a download link
-const blob = new Blob([fileData]);
-const url = URL.createObjectURL(blob);
-const a = document.createElement('a');
-a.href = url;
-a.download = 'file.pdf';
-a.click();
-```
-
-### List Files in a Folder
-
-```typescript
-const result = await client.listFiles('folder-id-here');
-
-console.log('Files:', result.files);
-result.files.forEach(file => {
-  console.log(`- ${file.originalName} (${file.size} bytes)`);
-});
-```
-
-### Get File Metadata
-
-```typescript
-const result = await client.getFileMetadata('file-id-here');
-
-console.log('File metadata:', result.file);
-console.log('Name:', result.file.originalName);
-console.log('Size:', result.file.size);
-console.log('Type:', result.file.mimeType);
-console.log('Uploaded:', result.file.createdAt);
-```
-
-### Delete a File
-
-```typescript
-const result = await client.deleteFile('file-id-here');
-console.log(result.message); // "File deleted successfully"
-```
-
-### Generate Presigned URL
-
-Generate a temporary URL for file access without requiring API key authentication:
-
-```typescript
-const result = await client.generatePresignedUrl({
-  fileId: 'file-id-here',
-  expiresIn: 3600 // optional, defaults to 3600 seconds (1 hour)
-});
-
-console.log('Presigned URL:', result.url);
-console.log('Token:', result.token);
-console.log('Expires at:', result.expiresAt);
-
-// Share this URL with anyone - no API key needed
-```
-
-### View File by Token
-
-Access a file using a presigned token (no API key required). Returns the file data along with response headers including caching information:
-
-```typescript
-const result = await client.viewFileByToken('presigned-token-here');
-
-// Access file data
-const buffer = Buffer.from(result.data);
-fs.writeFileSync('./viewed-file.pdf', buffer);
-
-// Access cache headers for optimization
-console.log('Content Type:', result.headers.contentType);
-console.log('File Size:', result.headers.contentLength);
-console.log('ETag:', result.headers.etag); // For cache validation
-console.log('Cache Control:', result.headers.cacheControl);
-console.log('Cloudflare Cache Tag:', result.headers.cfCacheTag); // File ID for consistent caching
-
-// In browser, use the headers to implement client-side caching
-if (result.headers.etag) {
-  localStorage.setItem(`file-etag-${result.headers.cfCacheTag}`, result.headers.etag);
-}
-```
-
-## API Reference
-
-### `GammaFilesClient`
-
-#### Constructor
-
-```typescript
-new GammaFilesClient(config: GammaFilesClientConfig)
-```
-
-**Parameters:**
-- `config.baseUrl` - Base URL of the Gamma API
-- `config.apiKey` - Your API key (must have appropriate permissions)
-
-#### Methods
-
-##### `uploadFile(options: UploadFileOptions): Promise<UploadFileResponse>`
-
-Upload a file to the server.
-
-**Parameters:**
-- `options.file` - File data (Buffer, Blob, or File object)
-- `options.filename` - Name of the file
-- `options.mimeType` - MIME type (optional, will be detected if not provided)
-- `options.folderId` - Target folder ID (optional, uploads to root folder if not specified)
-
-**Returns:** Upload response with file metadata
-
-**API Key Permissions Required:** `write` or `admin`
-
-##### `downloadFile(fileId: string): Promise<ArrayBuffer>`
-
-Download a file by ID.
-
-**Parameters:**
-- `fileId` - ID of the file to download
-
-**Returns:** File data as ArrayBuffer
-
-**API Key Permissions Required:** `read`, `write`, or `admin`
-
-##### `listFiles(folderId: string): Promise<ListFilesResponse>`
-
-List all files in a folder.
-
-**Parameters:**
-- `folderId` - ID of the folder
-
-**Returns:** List of files with metadata
-
-**API Key Permissions Required:** `read`, `write`, or `admin`
-
-##### `deleteFile(fileId: string): Promise<DeleteFileResponse>`
-
-Delete a file by ID.
-
-**Parameters:**
-- `fileId` - ID of the file to delete
-
-**Returns:** Deletion confirmation message
-
-**API Key Permissions Required:** `write` or `admin`
-
-##### `getFileMetadata(fileId: string): Promise<FileMetadataResponse>`
-
-Get metadata for a specific file.
-
-**Parameters:**
-- `fileId` - ID of the file
-
-**Returns:** File metadata
-
-**API Key Permissions Required:** `read`, `write`, or `admin`
-
-##### `generatePresignedUrl(options: PresignedUrlOptions): Promise<PresignedUrlResponse>`
-
-Generate a presigned URL for temporary file access.
-
-**Parameters:**
-- `options.fileId` - ID of the file
-- `options.expiresIn` - Expiration time in seconds (min: 60, max: 86400, default: 3600)
-
-**Returns:** Presigned URL information including token, full URL, and expiration time
-
-**API Key Permissions Required:** `read`, `write`, or `admin`
-
-##### `viewFileByToken(token: string): Promise<ViewFileByTokenResult>`
-
-Access a file using a presigned token (no API key required). Returns file data along with response headers including caching information.
-
-**Parameters:**
-- `token` - Presigned token from `generatePresignedUrl`
-
-**Returns:** Object containing:
-- `data` - File data as ArrayBuffer
-- `headers` - Response headers including:
-  - `contentType` - MIME type of the file
-  - `contentLength` - Size of the file in bytes
-  - `contentDisposition` - Content disposition header (inline)
-  - `etag` - Entity tag for cache validation (based on file ID)
-  - `cacheControl` - Cache control directives (1 year immutable)
-  - `cfCacheTag` - Cloudflare cache tag (file ID for consistent caching across tokens)
-
-**API Key Permissions Required:** None (uses token authentication)
-
-## Types
-
-All TypeScript types are exported from the package:
-
-```typescript
-import {
-  GammaFilesClient,
-  GammaFilesClientConfig,
-  FileMetadata,
-  UploadFileOptions,
-  UploadFileResponse,
-  ListFilesResponse,
-  FileMetadataResponse,
-  DeleteFileResponse,
-  PresignedUrlOptions,
-  PresignedUrlResponse,
-  DownloadFileResult,
-  ViewFileByTokenResult,
-  ApiErrorResponse
-} from '@gamma/files-sdk';
-```
-
-## Error Handling
-
-All methods throw errors when requests fail:
-
-```typescript
-try {
-  const result = await client.uploadFile({
-    file: buffer,
-    filename: 'test.pdf'
-  });
-  console.log('Success:', result);
-} catch (error) {
-  console.error('Upload failed:', error.message);
-}
-```
-
-## License
-
-MIT