@gpt-core/client 0.10.20 → 0.11.0

package/README.md

@@ -29,8 +29,11 @@ AI_CONTEXT_END -->
 > **TL;DR for Claude, Cursor, Copilot, and other AI assistants:**
 >
 > ```typescript
-> import { GptClient } from '@gpt-core/client';
-> const client = new GptClient({ baseUrl: 'https://api.example.com', token: 'jwt' });
+> import { GptClient } from "@gpt-core/client";
+> const client = new GptClient({
+>   baseUrl: "https://api.example.com",
+>   token: "jwt",
+> });
 > ```
 >
 > **Common operations:**
@@ -70,26 +73,26 @@ pnpm add @gpt-core/client
 ## Quick Start
 
 ```typescript
-import { GptClient } from '@gpt-core/client';
+import { GptClient } from "@gpt-core/client";
 
 // Initialize client
 const client = new GptClient({
-  baseUrl: 'https://api.gpt-core.com',
-  apiKey: 'your-api-key',      // For machine-to-machine
-  token: 'user-jwt-token',     // For user-authenticated requests
+  baseUrl: "https://api.gpt-core.com",
+  apiKey: "your-api-key", // For machine-to-machine
+  token: "user-jwt-token", // For user-authenticated requests
 });
 
 // Authenticate a user
 const { user, token } = await client.identity.login(
-  'user@example.com',
-  'password'
+  "user@example.com",
+  "password",
 );
 
 console.log(`Welcome, ${user.attributes.full_name}!`);
 
 // Use the token for subsequent requests
 const authenticatedClient = new GptClient({
-  baseUrl: 'https://api.gpt-core.com',
+  baseUrl: "https://api.gpt-core.com",
   token: token,
 });
 
@@ -117,9 +120,9 @@ Pin a specific API version to protect your integration from breaking changes:
 
 ```typescript
 const client = new GptClient({
-  baseUrl: 'https://api.gpt-core.com',
-  apiKey: 'sk_live_...',
-  apiVersion: '2025-12-03',  // Pin to this version
+  baseUrl: "https://api.gpt-core.com",
+  apiKey: "sk_live_...",
+  apiVersion: "2025-12-03", // Pin to this version
 });
 ```
 
@@ -153,29 +156,29 @@ This returns the full list of versions with descriptions and deprecation status.
 ```typescript
 const client = new GptClient({
   // Required: API base URL
-  baseUrl: 'https://api.gpt-core.com',
+  baseUrl: "https://api.gpt-core.com",
 
   // Authentication (provide one or both)
-  apiKey: 'sk_live_...',      // Application API key
-  token: 'eyJhbGc...',        // User JWT token
+  apiKey: "sk_live_...", // Application API key
+  token: "eyJhbGc...", // User JWT token
 
   // API version (optional, uses SDK default if not specified)
-  apiVersion: '2025-12-03',
+  apiVersion: "2025-12-03",
 
   // Security configuration (optional)
   security: {
-    requireHttps: false,       // Throw error on HTTP (default: warn only)
-    warnBrowserApiKey: true,   // Warn about API keys in browser (default: true)
+    requireHttps: false, // Throw error on HTTP (default: warn only)
+    warnBrowserApiKey: true, // Warn about API keys in browser (default: true)
   },
 
   // Retry configuration (optional)
   retry: {
-    maxRetries: 3,             // Default: 3
-    initialDelay: 1000,        // Default: 1000ms (renamed from minTimeout)
-    maxDelay: 32000,           // Default: 32000ms (renamed from maxTimeout)
+    maxRetries: 3, // Default: 3
+    initialDelay: 1000, // Default: 1000ms (renamed from minTimeout)
+    maxDelay: 32000, // Default: 32000ms (renamed from maxTimeout)
     retryableStatusCodes: [429, 500, 502, 503, 504],
-    totalTimeout: 300000,      // Total timeout across all retries (ms)
-    maxRetryAfter: 60,         // Max Retry-After header value (seconds)
+    totalTimeout: 300000, // Total timeout across all retries (ms)
+    maxRetryAfter: 60, // Max Retry-After header value (seconds)
   },
 
   // Disable retries
@@ -185,24 +188,24 @@ const client = new GptClient({
 
 ## Security Options
 
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `requireHttps` | boolean | `false` | Throw `InsecureConnectionError` on non-HTTPS URLs |
-| `warnBrowserApiKey` | boolean | `true` | Warn when API key detected in browser environment |
+| Option              | Type    | Default | Description                                       |
+| ------------------- | ------- | ------- | ------------------------------------------------- |
+| `requireHttps`      | boolean | `false` | Throw `InsecureConnectionError` on non-HTTPS URLs |
+| `warnBrowserApiKey` | boolean | `true`  | Warn when API key detected in browser environment |
 
 ### HTTPS Enforcement
 
 ```typescript
 // Development: Warns only
 const devClient = new GptClient({
-  baseUrl: 'http://localhost:22222',
+  baseUrl: "http://localhost:22222",
   apiKey: process.env.API_KEY,
   security: { requireHttps: false },
 });
 
 // Production: Blocks HTTP
 const prodClient = new GptClient({
-  baseUrl: 'https://api.gpt-core.com',
+  baseUrl: "https://api.gpt-core.com",
   apiKey: process.env.API_KEY,
   security: { requireHttps: true },
 });
@@ -211,7 +214,7 @@ try {
   await prodClient.agents.list();
 } catch (error) {
   if (error instanceof InsecureConnectionError) {
-    console.error('Cannot use HTTP in production');
+    console.error("Cannot use HTTP in production");
   }
 }
 ```
@@ -225,7 +228,7 @@ The SDK validates API key format and warns about elevated privilege keys:
 // sk_sys_* keys trigger warnings (elevated privileges)
 
 const client = new GptClient({
-  apiKey: 'sk_sys_abc123',
+  apiKey: "sk_sys_abc123",
 });
 // [GPT Core SDK] Using system-level API key (sk_sys_).
 // Ensure this is intended for platform operations.
@@ -242,7 +245,11 @@ Manage users, authentication, and API keys.
 const { user, token } = await client.identity.login(email, password);
 
 // Register
-const user = await client.identity.register(email, password, passwordConfirmation);
+const user = await client.identity.register(
+  email,
+  password,
+  passwordConfirmation,
+);
 
 // Get current user
 const user = await client.identity.me();
@@ -252,8 +259,8 @@ const profile = await client.identity.profile();
 
 // API Keys
 const keys = await client.identity.apiKeys.list();
-const newKey = await client.identity.apiKeys.create('Production Key');
-await client.identity.apiKeys.allocate('key-id', 1000, 'Monthly credits');
+const newKey = await client.identity.apiKeys.create("Production Key");
+await client.identity.apiKeys.allocate("key-id", 1000, "Monthly credits");
 ```
 
 ### Platform
@@ -264,22 +271,25 @@ Manage applications, workspaces, and tenants.
 // Applications
 const apps = await client.platform.applications.list();
 const app = await client.platform.applications.create({
-  name: 'My App',
-  slug: 'my-app',
+  name: "My App",
+  slug: "my-app",
 });
-const app = await client.platform.applications.getBySlug('my-app');
+const app = await client.platform.applications.getBySlug("my-app");
 
 // Workspaces
 const workspaces = await client.platform.workspaces.list();
 const myWorkspaces = await client.platform.workspaces.mine();
-const workspace = await client.platform.workspaces.create('New Workspace', 'new-workspace');
+const workspace = await client.platform.workspaces.create(
+  "New Workspace",
+  "new-workspace",
+);
 
 // Invitations
 await client.platform.invitations.invite(
-  'colleague@example.com',
-  'editor',
-  'workspace',
-  'workspace-id'
+  "colleague@example.com",
+  "editor",
+  "workspace",
+  "workspace-id",
 );
 ```
 
@@ -291,20 +301,20 @@ Interact with agents, threads, and semantic search.
 // Agents
 const agents = await client.ai.agents.list();
 const agent = await client.ai.agents.create(
-  'Support Agent',
-  'You are a helpful customer support agent'
+  "Support Agent",
+  "You are a helpful customer support agent",
 );
 
 // Threads (Conversations)
 const threads = await client.ai.threads.list();
-const thread = await client.ai.threads.create('Bug Report Discussion');
-const message = await client.ai.threads.sendMessage(thread.id, 'Hello AI!');
+const thread = await client.ai.threads.create("Bug Report Discussion");
+const message = await client.ai.threads.sendMessage(thread.id, "Hello AI!");
 
 // Search
-const results = await client.ai.search('quarterly earnings', 10);
+const results = await client.ai.search("quarterly earnings", 10);
 
 // Embeddings
-const embedding = await client.ai.embed('text to embed');
+const embedding = await client.ai.embed("text to embed");
 ```
 
 ### Extraction
@@ -317,18 +327,18 @@ const documents = await client.extraction.documents.list();
 
 // Upload (base64)
 const doc = await client.extraction.documents.uploadBase64(
-  'report.pdf',
-  base64Content
+  "report.pdf",
+  base64Content,
 );
 
 // Analyze
 await client.extraction.documents.analyze(doc.id);
 
 // Retrieve
-const doc = await client.extraction.documents.get('doc-id');
+const doc = await client.extraction.documents.get("doc-id");
 
 // Delete
-await client.extraction.documents.delete('doc-id');
+await client.extraction.documents.delete("doc-id");
 
 // Results
 const results = await client.extraction.results.list();
@@ -341,14 +351,14 @@ Manage buckets and files.
 ```typescript
 // Buckets
 const buckets = await client.storage.buckets.list();
-const bucket = await client.storage.buckets.create('uploads', false);
+const bucket = await client.storage.buckets.create("uploads", false);
 
 // Presigned URLs
 const uploadUrl = await client.storage.presigned.upload(
-  'image.png',
-  'image/png'
+  "image.png",
+  "image/png",
 );
-const downloadUrl = await client.storage.presigned.download('file-id');
+const downloadUrl = await client.storage.presigned.download("file-id");
 ```
 
 ### Billing
@@ -377,16 +387,16 @@ import {
   ValidationError,
   RateLimitError,
   ServerError,
-} from '@gpt-core/client';
+} from "@gpt-core/client";
 
 try {
-  await client.identity.login('user@example.com', 'wrong-password');
+  await client.identity.login("user@example.com", "wrong-password");
 } catch (error) {
   if (error instanceof AuthenticationError) {
-    console.error('Invalid credentials:', error.message);
-    console.error('Request ID:', error.requestId);
+    console.error("Invalid credentials:", error.message);
+    console.error("Request ID:", error.requestId);
   } else if (error instanceof ValidationError) {
-    console.error('Validation errors:', error.errors);
+    console.error("Validation errors:", error.errors);
   } else if (error instanceof RateLimitError) {
     console.error(`Rate limited. Retry after ${error.retryAfter}s`);
   }
@@ -398,7 +408,7 @@ try {
 Easily iterate over large datasets with built-in memory protection:
 
 ```typescript
-import { paginateAll } from '@gpt-core/client';
+import { paginateAll } from "@gpt-core/client";
 
 // Using async iteration
 for await (const workspace of client.platform.workspaces.listAll()) {
@@ -427,18 +437,18 @@ for await (const item of paginateAll(fetcher, { pageSize: 50, limit: 1000 })) {
 Stream AI responses in real-time:
 
 ```typescript
-import { streamMessage } from '@gpt-core/client';
+import { streamMessage } from "@gpt-core/client";
 
 // Make streaming request
 const response = await fetch(streamingEndpoint, {
-  method: 'POST',
-  headers: { 'Accept': 'text/event-stream' },
-  body: JSON.stringify({ content: 'Hello AI' }),
+  method: "POST",
+  headers: { Accept: "text/event-stream" },
+  body: JSON.stringify({ content: "Hello AI" }),
 });
 
 // Stream the response
 for await (const chunk of streamMessage(response)) {
-  if (chunk.type === 'content') {
+  if (chunk.type === "content") {
     process.stdout.write(chunk.content); // Real-time output
   }
 }
@@ -451,21 +461,21 @@ Automatic retries with exponential backoff and circuit breaker:
 ```typescript
 // Retries are enabled by default with circuit breaker protection
 const client = new GptClient({
-  baseUrl: 'https://api.gpt-core.com',
-  token: 'token',
+  baseUrl: "https://api.gpt-core.com",
+  token: "token",
   retry: {
-    maxRetries: 5,            // Retry up to 5 times
-    initialDelay: 1000,       // Start with 1s delay
-    maxDelay: 32000,           // Max delay between retries
-    totalTimeout: 300000,     // Total timeout (5 min) prevents infinite loops
-    maxRetryAfter: 60,        // Cap Retry-After header to 60s
+    maxRetries: 5, // Retry up to 5 times
+    initialDelay: 1000, // Start with 1s delay
+    maxDelay: 32000, // Max delay between retries
+    totalTimeout: 300000, // Total timeout (5 min) prevents infinite loops
+    maxRetryAfter: 60, // Cap Retry-After header to 60s
   },
 });
 
 // Disable retries for specific operations
 const noRetryClient = new GptClient({
-  baseUrl: 'https://api.gpt-core.com',
-  token: 'token',
+  baseUrl: "https://api.gpt-core.com",
+  token: "token",
   retry: false,
 });
 ```
@@ -478,13 +488,13 @@ const noRetryClient = new GptClient({
 - **Protected Status Codes**: 429, 500, 502, 503, 504
 
 ```typescript
-import { RetryTimeoutError } from '@gpt-core/client';
+import { RetryTimeoutError } from "@gpt-core/client";
 
 try {
   await client.agents.list();
 } catch (error) {
   if (error instanceof RetryTimeoutError) {
-    console.error('Retry timeout exceeded:', error.message);
+    console.error("Retry timeout exceeded:", error.message);
   }
 }
 ```
@@ -494,12 +504,12 @@ try {
 The SDK is written in TypeScript and provides full type safety:
 
 ```typescript
-import type { user, workspace, document } from '@gpt-core/client';
+import type { user, workspace, document } from "@gpt-core/client";
 
 const user: user = await client.identity.me();
 // TypeScript knows: user.attributes.email, user.id, etc.
 
-const workspace: workspace = await client.platform.workspaces.create('Test');
+const workspace: workspace = await client.platform.workspaces.create("Test");
 // TypeScript enforces correct parameters
 ```
 

package/dist/index.d.mts

@@ -42138,7 +42138,7 @@ declare function streamSSE<T = unknown>(response: Response, options?: StreamOpti
  * Stream AI thread messages with Server-Sent Events
  */
 interface StreamMessageChunk {
-    type: 'content' | 'done' | 'error';
+    type: "content" | "done" | "error";
     content?: string;
     error?: string;
     metadata?: Record<string, any>;

package/dist/index.d.ts

@@ -42138,7 +42138,7 @@ declare function streamSSE<T = unknown>(response: Response, options?: StreamOpti
  * Stream AI thread messages with Server-Sent Events
  */
 interface StreamMessageChunk {
-    type: 'content' | 'done' | 'error';
+    type: "content" | "done" | "error";
     content?: string;
     error?: string;
     metadata?: Record<string, any>;

package/dist/index.js

@@ -5405,7 +5405,9 @@ function handleApiError(error) {
     const entries = hdrs instanceof Headers ? Array.from(hdrs.entries()) : Object.entries(hdrs);
     const filtered = entries.filter(([key]) => {
       const lowerKey = key.toLowerCase();
-      return !sensitiveHeaderPatterns.some((pattern) => lowerKey.includes(pattern));
+      return !sensitiveHeaderPatterns.some(
+        (pattern) => lowerKey.includes(pattern)
+      );
     });
     return filtered.length > 0 ? Object.fromEntries(filtered) : void 0;
   };
@@ -5428,7 +5430,11 @@ function handleApiError(error) {
       throw new ValidationError(message, errors, errorOptions);
     case 429: {
       const retryAfter = headers?.get?.("retry-after") || headers?.["retry-after"];
-      throw new RateLimitError(message, retryAfter ? parseInt(retryAfter, 10) : void 0, errorOptions);
+      throw new RateLimitError(
+        message,
+        retryAfter ? parseInt(retryAfter, 10) : void 0,
+        errorOptions
+      );
     }
     case 500:
     case 502:
@@ -5700,7 +5706,9 @@ async function* streamSSE(response, options = {}) {
       const elapsed = Date.now() - startTime;
       if (elapsed > timeout) {
         reader.cancel();
-        throw new Error(`Stream timeout exceeded after ${elapsed}ms (limit: ${timeout}ms)`);
+        throw new Error(
+          `Stream timeout exceeded after ${elapsed}ms (limit: ${timeout}ms)`
+        );
       }
       if (chunkCount >= maxChunks) {
         reader.cancel();
@@ -5717,7 +5725,9 @@ async function* streamSSE(response, options = {}) {
       bufferSize += value.length;
       if (bufferSize > maxBufferSize) {
         reader.cancel();
-        throw new Error(`Stream buffer size exceeded (${bufferSize} bytes, limit: ${maxBufferSize})`);
+        throw new Error(
+          `Stream buffer size exceeded (${bufferSize} bytes, limit: ${maxBufferSize})`
+        );
       }
       buffer += decoder.decode(value, { stream: true });
       const lines = buffer.split("\n");

package/dist/index.mjs

@@ -4938,7 +4938,9 @@ function handleApiError(error) {
     const entries = hdrs instanceof Headers ? Array.from(hdrs.entries()) : Object.entries(hdrs);
     const filtered = entries.filter(([key]) => {
       const lowerKey = key.toLowerCase();
-      return !sensitiveHeaderPatterns.some((pattern) => lowerKey.includes(pattern));
+      return !sensitiveHeaderPatterns.some(
+        (pattern) => lowerKey.includes(pattern)
+      );
     });
     return filtered.length > 0 ? Object.fromEntries(filtered) : void 0;
   };
@@ -4961,7 +4963,11 @@ function handleApiError(error) {
       throw new ValidationError(message, errors, errorOptions);
     case 429: {
       const retryAfter = headers?.get?.("retry-after") || headers?.["retry-after"];
-      throw new RateLimitError(message, retryAfter ? parseInt(retryAfter, 10) : void 0, errorOptions);
+      throw new RateLimitError(
+        message,
+        retryAfter ? parseInt(retryAfter, 10) : void 0,
+        errorOptions
+      );
     }
     case 500:
     case 502:
@@ -5233,7 +5239,9 @@ async function* streamSSE(response, options = {}) {
       const elapsed = Date.now() - startTime;
       if (elapsed > timeout) {
         reader.cancel();
-        throw new Error(`Stream timeout exceeded after ${elapsed}ms (limit: ${timeout}ms)`);
+        throw new Error(
+          `Stream timeout exceeded after ${elapsed}ms (limit: ${timeout}ms)`
+        );
       }
       if (chunkCount >= maxChunks) {
         reader.cancel();
@@ -5250,7 +5258,9 @@ async function* streamSSE(response, options = {}) {
       bufferSize += value.length;
       if (bufferSize > maxBufferSize) {
         reader.cancel();
-        throw new Error(`Stream buffer size exceeded (${bufferSize} bytes, limit: ${maxBufferSize})`);
+        throw new Error(
+          `Stream buffer size exceeded (${bufferSize} bytes, limit: ${maxBufferSize})`
+        );
       }
       buffer += decoder.decode(value, { stream: true });
       const lines = buffer.split("\n");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gpt-core/client",
-  "version": "0.10.20",
+  "version": "0.11.0",
   "description": "TypeScript SDK for GPT Core Client API - Document extraction, AI agents, and workspace management",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -46,12 +46,21 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/GPT-Integrators/gpt-core-sdks.git",
-    "directory": "ts/packages/client"
+    "url": "https://github.com/GPT-Integrators/gpt-core-client-sdk.git"
   },
+  "homepage": "https://gpt-integrators.github.io/gpt-core-client-sdk",
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "generate": "bunx openapi-ts",
+    "typecheck": "bunx tsc --noEmit",
+    "build": "bun run typecheck && bunx tsup src/index.ts --format cjs,esm --dts",
+    "test": "bunx vitest run",
+    "test:watch": "bunx vitest",
+    "test:ui": "bunx vitest --ui",
+    "test:coverage": "bunx vitest run --coverage"
+  },
   "dependencies": {
     "eventsource-parser": "^3.0.6",
     "zod": "^3.25.76"
@@ -63,14 +72,5 @@
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
     "vitest": "^4.0.15"
-  },
-  "scripts": {
-    "generate": "bunx openapi-ts",
-    "typecheck": "bunx tsc --noEmit",
-    "build": "bun run typecheck && bunx tsup src/index.ts --format cjs,esm --dts",
-    "test": "bunx vitest run",
-    "test:watch": "bunx vitest",
-    "test:ui": "bunx vitest --ui",
-    "test:coverage": "bunx vitest run --coverage"
   }
-}
+}