@bugbug-io/sdk 14.0.4 → 14.0.8

package/README.md

@@ -1,75 +1,56 @@
-<div align="center">
-
-![BugBug Logo](https://bugbug.io/favicon-96x96.png)
+![BugBug logo](https://bugbug.io/favicon-96x96.png)
 
 # BugBug SDK
 
-**TypeScript SDK for BugBug**
-
-A comprehensive TypeScript SDK for interacting with the [BugBug](https://bugbug.io) API, featuring rate limiting, error handling, and built-in progress watching utilities.
-
-</div>
-
-## Features
+`@bugbug-io/sdk` is the TypeScript client for building integrations with the
+BugBug API. SDK access requires a BugBug Business plan.
 
-- **Easy to use** - Simple factory function and intuitive API
-- **Type-safe** - Full TypeScript support with comprehensive type definitions
-- **Rate limiting** - Built-in exponential backoff and request throttling
-- **Error handling** - Comprehensive error types and automatic retries
-- **Request cancellation** - AbortController support for all requests
-- **Progress watching utilities** - Built-in polling for test and suite completion
-- **Verbose logging** - Detailed request/response logging for debugging
-- **Metrics collection** - Optional telemetry and performance tracking
-
-## Installation
-
-```bash
+```sh
 npm install @bugbug-io/sdk
 ```
 
-## Quick Start
+## Quick start
 
-```typescript
+```ts
 import { createBugBug } from '@bugbug-io/sdk';
 
-const bugbug = createBugBug({
-  apiToken: 'your-api-token',
-  verbose: true, // Enable detailed logging
-});
+const bugbug = createBugBug({ apiToken: process.env.BUGBUG_API_TOKEN! });
 
-// Run a test and watch progress until completion
-const result = await bugbug.tests.startRun('my-test', {
+const run = await bugbug.tests.startRun('test-id', {
   watchProgress: true,
-  onProgress: (run) => console.log(`Status: ${run.status}`),
+  onProgress: (state) => console.log(state.status),
 });
 
-console.log('Test completed:', result.status);
+console.log(run.status);
+```
 
-// Get recent test runs
-const recentTests = await bugbug.tests.getRecentRuns({ hours: 24 });
+## What it supports
 
-// Run a suite
-const suiteResult = await bugbug.suites.startRun('suite-id', {
-  watchProgress: true,
-});
-```
+- Tests, suites, runs, profiles, project settings, and reusable components.
+- Typed API responses and Zod-backed validation.
+- Rate-limit retries, request cancellation, timeout handling, and run-progress
+  watching.
 
 ## Configuration
 
-### Basic Configuration
+Pass an API token when creating the client. You can also set `BUGBUG_API_TOKEN`
+and optionally `BUGBUG_API_URL`; the production API base URL is
+`https://app.bugbug.io/api/v2`.
 
-```typescript
+```ts
 const bugbug = createBugBug({
-  apiToken: 'your-api-token',
+  apiToken: process.env.BUGBUG_API_TOKEN!,
+  apiUrl: 'https://app.bugbug.io/api/v2',
 });
 ```
 
-### Advanced Configuration
+### Advanced configuration
 
-```typescript
+```ts
 const bugbug = createBugBug({
   apiToken: 'your-api-token',
   apiUrl: 'https://app.bugbug.io/api/v2', // Full API base URL. Default: https://app.bugbug.io/api/v2
+  projectId: 'project-id', // Active project for organization/user tokens
   verbose: false, // Enable detailed logging
   logLevel: 'info', // 'debug' | 'info' | 'warn' | 'error'
   timeout: 30000, // Request timeout in milliseconds
@@ -78,6 +59,7 @@ const bugbug = createBugBug({
   rateLimit: {
     maxRequests: 100, // Max requests per window
     windowMs: 60000, // Time window in milliseconds
+    retryServer429: true, // Retry server-side 429s. Default: true
     exponentialBackoff: {
       baseDelay: 1000, // Base delay for retries (ms)
       maxDelay: 30000, // Maximum delay (ms)
@@ -89,33 +71,12 @@ const bugbug = createBugBug({
 
 > **Note on `apiUrl`:** The SDK treats `apiUrl` as the **full API base URL** and does not auto-append `/api/v2` or rewrite the value in any way. Pass a complete URL like `https://app.bugbug.io/api/v2`. Host-only values will route to the wrong endpoint.
 
-## API Reference
-
-### Auth
+> **Note on `retryServer429`:** When enabled, a 429 returned mid-POST is retried transparently, which can create **duplicate resources** for non-idempotent calls such as `tests.startRun` or `tests.create`. Set it to `false` in integrations that mutate data and retry idempotently yourself.
 
-```typescript
-import {
-  BUGBUG_CLI_OAUTH_CLIENT_ID,
-  BUGBUG_OAUTH_CODE_CHALLENGE_METHOD,
-  createOAuthCodeChallenge,
-  createOAuthCodeVerifier,
-  createOAuthState,
-  createBugBug,
-} from '@bugbug-io/sdk';
+Use `bugbug.tests`, `bugbug.suites`, `bugbug.profiles`, `bugbug.groups`, and
+`bugbug.config` for the respective API areas.
 
-const bugbug = createBugBug({ apiToken: 'placeholder' });
-const codeVerifier = createOAuthCodeVerifier();
-const authorize = await bugbug.auth.getAuth({
-  clientId: BUGBUG_CLI_OAUTH_CLIENT_ID,
-  redirectUri: 'http://127.0.0.1:48123/callback',
-  codeChallenge: createOAuthCodeChallenge(codeVerifier),
-  codeChallengeMethod: BUGBUG_OAUTH_CODE_CHALLENGE_METHOD,
-  state: createOAuthState(),
-});
-```
-
-`auth.getAuth` and `auth.exchangeCode` call root `/auth/...` endpoints and do
-not send the configured API token. `auth.identity` validates the configured token.
+## API Reference
 
 ### Tests
 

package/dist/index.js

@@ -9577,7 +9577,7 @@ var buildUserAgent = (clientType, version) => `BugBug ${clientType.toUpperCase()
 // ../core/package.json
 var package_default = {
   name: "@bugbug-io/core",
-  version: "14.0.4",
+  version: "14.0.8",
   private: true,
   type: "module",
   main: "dist/index.js",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bugbug-io/sdk",
-  "version": "14.0.4",
-  "description": "A comprehensive TypeScript SDK for BugBug API with modular architecture, rate limiting, and built-in utilities",
+  "version": "14.0.8",
+  "description": "TypeScript SDK for building integrations with the BugBug API",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",