@hunt-labs/bytekit-sdk 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -0,0 +1,91 @@
+# Changelog
+
+All notable changes to `@hunt-labs/bytekit-sdk` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+This file records only the delta between versions. For how to use the package
+today, see [README.md](./README.md), which remains the authoritative usage guide.
+
+## [0.2.2] - 2026-07-16
+
+### Changed
+
+- Re-release of 0.2.1. The 0.2.1 artifacts never reached npm — the prod publish's
+  `publish-sdk` step failed on a CI test-isolation flake (`cjs-require.test.ts`
+  rebuilding the shared `dist`), which is now fixed. No consumer-facing changes
+  beyond 0.2.1.
+
+## [0.2.1] - 2026-07-16
+
+### Changed
+
+- Primary exports renamed `RapidCrawl`→`ByteKit`, `RapidCrawlError`→`ByteKitError`,
+  `RapidCrawlOptions`→`ByteKitOptions`. The old names remain as deprecated,
+  identity-preserving aliases (`RapidCrawl === ByteKit`), so existing imports keep
+  working. (#2421)
+
+### Fixed
+
+- `request()` now returns `undefined` on `204 No Content` / empty-body responses
+  instead of throwing a JSON-parse error — `account.apiKeys.revoke()` now resolves
+  as its `Promise<void>` contract declares. (#2450)
+
+### Removed
+
+- `client.recordings` (the `/v1/recordings` endpoint is permanently `410`
+  deactivated). (#2421)
+
+## [0.2.0] - 2026-07-15
+
+This is a breaking release. Four runtime behavior changes affect code written
+against 0.1.0 — read each one before upgrading.
+
+### Changed (breaking)
+
+- **Default client-side timeout (120s).** Requests now abort after 120000 ms by
+  default (`DEFAULT_TIMEOUT_MS` in `src/client.ts`); 0.1.0 had no client-side
+  timeout and would hang indefinitely. A slow request now rejects with
+  `RapidCrawlConnectionError` carrying `code: 'timeout'`. Override per client via
+  `new RapidCrawl({ apiKey, timeoutMs })`.
+- **Network failures throw `RapidCrawlConnectionError`.** Every `fetch()` rejection
+  is now wrapped by `toConnectionError()` and re-thrown as `RapidCrawlConnectionError`.
+  0.1.0 surfaced undici's bare `TypeError: fetch failed`. Code that matched on a bare
+  `TypeError` to detect a network failure will no longer match — catch
+  `RapidCrawlConnectionError` instead.
+- **Constructor throws on an empty `apiKey`.** `new RapidCrawl({ apiKey: '' })` (or a
+  missing key) now throws a `TypeError` immediately instead of silently sending
+  `Authorization: Bearer undefined`. Ensure `apiKey` is populated (e.g. from
+  `process.env.BYTEKIT_API_KEY`) before constructing the client.
+- **Request-body types narrowed to the OpenAPI schema.** Request payloads are now
+  typed from spec-derived types generated from the OpenAPI schema
+  (`src/generated/api.d.ts`) rather than `Record<string, unknown>`. Payloads that
+  previously compiled by virtue of the loose index type may now be rejected by the
+  type checker; align them with the documented request shape.
+
+### Changed
+
+- Package renamed to `@hunt-labs/bytekit-sdk` (the `@bytekit` npm scope was
+  unobtainable). The prior `rapidcrawl`/`@rapidcrawl/sdk` name remains installable at
+  its last version but is deprecated.
+- Generated API types (`dist/generated/api.d.ts`) are now shipped in the tarball so
+  consumers get the typed request/response surface without regenerating from the spec.
+
+### Added
+
+- Publish-ready packaging metadata: types-first `exports`, `engines`, `keywords`,
+  `homepage`, `bugs`, `README.md`, `LICENSE`, and an MIT `license` field.
+
+## [0.1.0] - 2026
+
+### Added
+
+- Initial release of the ByteKit TypeScript SDK — a typed client for the ByteKit API
+  (scrape, screenshot, search, and related endpoints), published under the original
+  `@rapidcrawl/sdk` name.
+
+[0.2.2]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/sdk-typescript
+[0.2.1]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/sdk-typescript
+[0.2.0]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/sdk-typescript
+[0.1.0]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/sdk-typescript

package/README.md

@@ -10,11 +10,14 @@ screenshots, sitemaps, page monitors, and web search.
 npm install @hunt-labs/bytekit-sdk
 ```
 
-> **ESM-only.** This package ships as ESM (`"type": "module"`) and has no
-> CommonJS build. Use it from an ESM project (`"type": "module"` in your
-> `package.json`, or a `.mjs` entrypoint), or load it from CommonJS with a
-> dynamic `await import('@hunt-labs/bytekit-sdk')`. A top-level
-> `require('@hunt-labs/bytekit-sdk')` will not work.
+> **ESM-only.** This package ships a single ESM build (`"type": "module"`) with
+> no separate CommonJS bundle. Use it from an ESM project (`"type": "module"` in
+> your `package.json`, or a `.mjs` entrypoint). From CommonJS you can either load
+> it with a dynamic `await import('@hunt-labs/bytekit-sdk')`, or — on **Node
+> ≥20.19 / ≥22.12**, which resolve `require()` of ESM — call a top-level
+> `require('@hunt-labs/bytekit-sdk')` directly (the package's `exports` map
+> carries a `default` condition for exactly this). On older Node, a top-level
+> `require()` throws `ERR_REQUIRE_ESM`; use the dynamic `import()` there.
 
 Requires Node.js 18+ (the client uses the global `fetch`).
 
@@ -142,9 +145,6 @@ const account = await client.account.get();
 const keys = await client.account.apiKeys.list();
 ```
 
-> `client.recordings.*` targets the `/v1/recordings` endpoints, which are
-> deactivated server-side and return HTTP 410.
-
 ## Error handling
 
 Any 4xx/5xx response throws a `RapidCrawlError` carrying the HTTP status and

package/dist/client.d.ts

@@ -1,13 +1,12 @@
 import { ScrapeResource } from './resources/scrape.js';
 import { ScreenshotsResource } from './resources/screenshots.js';
-import { RecordingsResource } from './resources/recordings.js';
 import { BulkResource } from './resources/bulk.js';
 import { FetchResource } from './resources/fetch.js';
 import { MonitorsResource } from './resources/monitors.js';
 import { SitemapResource } from './resources/sitemap.js';
 import { SearchResource } from './resources/search.js';
 import { AccountResource } from './resources/account.js';
-export interface RapidCrawlOptions {
+export interface ByteKitOptions {
     apiKey: string;
     baseUrl?: string;
     /**
@@ -42,38 +41,37 @@ export interface RequestOptions {
 /** Why a request never produced an HTTP response. */
 export type ConnectionErrorCode = 'timeout' | 'aborted' | 'connection';
 /** Thrown when the API responds with a 4xx or 5xx status code. */
-export declare class RapidCrawlError extends Error {
+export declare class ByteKitError extends Error {
     readonly status: number;
     readonly code: string;
     constructor(status: number, code: string, message: string);
 }
 /**
  * Thrown when the request never produced an HTTP response at all — DNS, socket, TLS,
- * a client-side timeout, or a caller-initiated abort. Distinct from `RapidCrawlError`,
+ * a client-side timeout, or a caller-initiated abort. Distinct from `ByteKitError`,
  * which always carries a real HTTP status: catch both to cover every failure.
  *
  * The original failure is preserved on `.cause`.
  */
-export declare class RapidCrawlConnectionError extends Error {
+export declare class ByteKitConnectionError extends Error {
     readonly code: ConnectionErrorCode;
     constructor(code: ConnectionErrorCode, message: string, options?: {
         cause?: unknown;
     });
 }
-export declare class RapidCrawl {
+export declare class ByteKit {
     private readonly apiKey;
     private readonly baseUrl;
     private readonly defaultTimeoutMs;
     readonly scrape: ScrapeResource;
     readonly screenshots: ScreenshotsResource;
-    readonly recordings: RecordingsResource;
     readonly bulk: BulkResource;
     readonly fetch: FetchResource;
     readonly monitors: MonitorsResource;
     readonly sitemap: SitemapResource;
     readonly search: SearchResource;
     readonly account: AccountResource;
-    constructor(options: RapidCrawlOptions);
+    constructor(options: ByteKitOptions);
     /**
      * Resolve the abort budget for one request from the caller's options and the
      * constructor default. Precedence:
@@ -89,11 +87,13 @@ export declare class RapidCrawl {
      */
     private resolveSignal;
     /**
-     * Make an authenticated JSON request to the RapidCrawl API.
+     * Make an authenticated JSON request to the ByteKit API.
      *
-     * Throws `RapidCrawlError` on 4xx/5xx responses, and `RapidCrawlConnectionError`
+     * Throws `ByteKitError` on 4xx/5xx responses, and `ByteKitConnectionError`
      * when no HTTP response was produced at all (DNS/socket/TLS failure, client-side
      * timeout, or caller abort).
      */
     request<T>(method: string, path: string, body?: unknown, options?: RequestOptions): Promise<T>;
 }
+export { ByteKit as RapidCrawl, ByteKitError as RapidCrawlError, ByteKitConnectionError as RapidCrawlConnectionError, };
+export type { ByteKitOptions as RapidCrawlOptions };

package/dist/client.js

@@ -1,6 +1,5 @@
 import { ScrapeResource } from './resources/scrape.js';
 import { ScreenshotsResource } from './resources/screenshots.js';
-import { RecordingsResource } from './resources/recordings.js';
 import { BulkResource } from './resources/bulk.js';
 import { FetchResource } from './resources/fetch.js';
 import { MonitorsResource } from './resources/monitors.js';
@@ -17,28 +16,28 @@ const DEFAULT_BASE_URL = 'https://api.bytekit.com';
  */
 const DEFAULT_TIMEOUT_MS = 120_000;
 /** Thrown when the API responds with a 4xx or 5xx status code. */
-export class RapidCrawlError extends Error {
+export class ByteKitError extends Error {
     status;
     code;
     constructor(status, code, message) {
         super(message);
-        this.name = 'RapidCrawlError';
+        this.name = 'ByteKitError';
         this.status = status;
         this.code = code;
     }
 }
 /**
  * Thrown when the request never produced an HTTP response at all — DNS, socket, TLS,
- * a client-side timeout, or a caller-initiated abort. Distinct from `RapidCrawlError`,
+ * a client-side timeout, or a caller-initiated abort. Distinct from `ByteKitError`,
  * which always carries a real HTTP status: catch both to cover every failure.
  *
  * The original failure is preserved on `.cause`.
  */
-export class RapidCrawlConnectionError extends Error {
+export class ByteKitConnectionError extends Error {
     code;
     constructor(code, message, options) {
         super(message, options);
-        this.name = 'RapidCrawlConnectionError';
+        this.name = 'ByteKitConnectionError';
         this.code = code;
     }
 }
@@ -52,7 +51,7 @@ function validateTimeout(value, optionName) {
     if (value === undefined)
         return undefined;
     if (typeof value !== 'number' || !Number.isFinite(value) || value < 0) {
-        throw new TypeError(`RapidCrawl: ${optionName} must be a non-negative finite number (got ${describe(value)})`);
+        throw new TypeError(`ByteKit: ${optionName} must be a non-negative finite number (got ${describe(value)})`);
     }
     return value;
 }
@@ -69,7 +68,7 @@ function describe(value) {
 }
 /** The abort reason used by the `setTimeout` fallback; named so it maps to `code: 'timeout'`. */
 function timeoutReason(ms) {
-    const reason = new Error(`RapidCrawl: request timed out after ${ms}ms`);
+    const reason = new Error(`ByteKit: request timed out after ${ms}ms`);
     reason.name = 'TimeoutError';
     return reason;
 }
@@ -147,17 +146,16 @@ function toConnectionError(err, method, url, timeoutSignal) {
         : code === 'aborted'
             ? 'request aborted by the caller'
             : 'connection failed before a response was received';
-    return new RapidCrawlConnectionError(code, `RapidCrawl: ${method} ${url} — ${detail}`, {
+    return new ByteKitConnectionError(code, `ByteKit: ${method} ${url} — ${detail}`, {
         cause: err,
     });
 }
-export class RapidCrawl {
+export class ByteKit {
     apiKey;
     baseUrl;
     defaultTimeoutMs;
     scrape;
     screenshots;
-    recordings;
     bulk;
     fetch;
     monitors;
@@ -166,14 +164,13 @@ export class RapidCrawl {
     account;
     constructor(options) {
         if (!options?.apiKey) {
-            throw new TypeError('RapidCrawl: `apiKey` is required — got an empty value. Pass options.apiKey (e.g. from process.env.BYTEKIT_API_KEY).');
+            throw new TypeError('ByteKit: `apiKey` is required — got an empty value. Pass options.apiKey (e.g. from process.env.BYTEKIT_API_KEY).');
         }
         this.apiKey = options.apiKey;
         this.baseUrl = options.baseUrl ?? DEFAULT_BASE_URL;
         this.defaultTimeoutMs = validateTimeout(options.timeoutMs, '"timeoutMs"') ?? DEFAULT_TIMEOUT_MS;
         this.scrape = new ScrapeResource(this);
         this.screenshots = new ScreenshotsResource(this);
-        this.recordings = new RecordingsResource(this);
         this.bulk = new BulkResource(this);
         this.fetch = new FetchResource(this);
         this.monitors = new MonitorsResource(this);
@@ -218,9 +215,9 @@ export class RapidCrawl {
         };
     }
     /**
-     * Make an authenticated JSON request to the RapidCrawl API.
+     * Make an authenticated JSON request to the ByteKit API.
      *
-     * Throws `RapidCrawlError` on 4xx/5xx responses, and `RapidCrawlConnectionError`
+     * Throws `ByteKitError` on 4xx/5xx responses, and `ByteKitConnectionError`
      * when no HTTP response was produced at all (DNS/socket/TLS failure, client-side
      * timeout, or caller abort).
      */
@@ -264,8 +261,32 @@ export class RapidCrawl {
             catch {
                 // leave defaults
             }
-            throw new RapidCrawlError(response.status, code, message);
+            throw new ByteKitError(response.status, code, message);
         }
-        return response.json();
+        // A 204 No Content has an empty body, and a genuinely empty body can arrive on
+        // other success codes too (defensive). Calling response.json() on an empty body
+        // rejects with a SyntaxError — which is how a successful revoke() (DELETE → 204)
+        // used to throw instead of resolving. Read the body once as text and short-circuit
+        // to `undefined` when it is empty; a JSON-bearing response (scrape.create,
+        // apiKeys.create/get, …) still parses and returns unchanged.
+        if (response.status === 204) {
+            return undefined;
+        }
+        const text = await response.text();
+        if (text.trim().length === 0) {
+            return undefined;
+        }
+        return JSON.parse(text);
     }
 }
+// ---------------------------------------------------------------------------
+// Deprecated RapidCrawl* aliases (#2421).
+//
+// The public surface renamed from RapidCrawl to ByteKit. These aliases point at
+// the SAME implementations (identity preserved: `RapidCrawl === ByteKit`), so an
+// existing consumer's `instanceof` / error-shape contract keeps holding for one
+// minor version. Exported here — not only from index.ts — so the SDK's own
+// resource files can keep importing the legacy type name from './client.js'
+// without churn. Re-exported (with @deprecated JSDoc) from index.ts.
+// ---------------------------------------------------------------------------
+export { ByteKit as RapidCrawl, ByteKitError as RapidCrawlError, ByteKitConnectionError as RapidCrawlConnectionError, };

package/dist/index.d.ts

@@ -1,5 +1,9 @@
+export { ByteKit, ByteKitError, ByteKitConnectionError } from './client.js';
+export type { ByteKitOptions, RequestOptions, ConnectionErrorCode } from './client.js';
+/** @deprecated Renamed to ByteKit / ByteKitError / ByteKitConnectionError — kept as aliases for one minor version. */
 export { RapidCrawl, RapidCrawlError, RapidCrawlConnectionError } from './client.js';
-export type { RapidCrawlOptions, RequestOptions, ConnectionErrorCode } from './client.js';
+/** @deprecated Renamed to ByteKitOptions — kept as an alias for one minor version. */
+export type { RapidCrawlOptions } from './client.js';
 export { V01_METHODS } from './allowlist.js';
 export type { V01Method } from './allowlist.js';
 export type { ScrapeId, ScreenshotId, RecordingId, BulkId, MonitorId, SitemapId, ApiKeyId, SearchType, SearchDateRange, SearchOpts, SearchResult, SearchResultImage, SearchResponse, } from './types.js';

package/dist/index.js

@@ -1,2 +1,4 @@
+export { ByteKit, ByteKitError, ByteKitConnectionError } from './client.js';
+/** @deprecated Renamed to ByteKit / ByteKitError / ByteKitConnectionError — kept as aliases for one minor version. */
 export { RapidCrawl, RapidCrawlError, RapidCrawlConnectionError } from './client.js';
 export { V01_METHODS } from './allowlist.js';

package/dist/resources/account.d.ts

@@ -63,10 +63,9 @@ declare class ApiKeysResource {
      * declares `content?: never`, so there is no JSON arm to derive a payload
      * from — hence `Promise<void>`.
      *
-     * KNOWN DRIFT: `client.request()` calls `response.json()` unconditionally,
-     * which throws on the gateway's empty 204 body — so this method currently
-     * rejects at runtime. The fix belongs in `client.ts` (tracked separately);
-     * typing it here states the intended contract rather than encoding the bug.
+     * `client.request()` short-circuits an empty body (204 or any empty response)
+     * to `undefined` before it would parse the body as JSON (#2450), so this
+     * method resolves cleanly on the gateway's empty 204 body.
      */
     revoke(id: ApiKeyId): Promise<void>;
     /** POST /v1/account/api-keys/{id}/reveal — reveal the plaintext API key value */

package/dist/resources/account.js

@@ -43,10 +43,9 @@ class ApiKeysResource {
      * declares `content?: never`, so there is no JSON arm to derive a payload
      * from — hence `Promise<void>`.
      *
-     * KNOWN DRIFT: `client.request()` calls `response.json()` unconditionally,
-     * which throws on the gateway's empty 204 body — so this method currently
-     * rejects at runtime. The fix belongs in `client.ts` (tracked separately);
-     * typing it here states the intended contract rather than encoding the bug.
+     * `client.request()` short-circuits an empty body (204 or any empty response)
+     * to `undefined` before it would parse the body as JSON (#2450), so this
+     * method resolves cleanly on the gateway's empty 204 body.
      */
     revoke(id) {
         return this.client.request('DELETE', `/v1/account/api-keys/${id}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hunt-labs/bytekit-sdk",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Official TypeScript SDK for the ByteKit API",
   "license": "MIT",
   "type": "module",
@@ -22,14 +22,9 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
-  "devDependencies": {
-    "openapi-typescript": "7.13.0",
-    "tsx": "*",
-    "typescript": "^5.4.5",
-    "vitest": "^1.6.0"
-  },
   "engines": {
     "node": ">=18"
   },
@@ -49,10 +44,11 @@
   ],
   "homepage": "https://bytekit.com/docs",
   "bugs": {
-    "email": "support@bytekit.com"
+    "email": "support@bytekit.com",
+    "url": "https://bytekit.com/contact"
   },
   "scripts": {
-    "build": "rm -rf dist tsconfig.tsbuildinfo && tsc && mkdir -p dist/generated && cp src/generated/api.d.ts dist/generated/api.d.ts",
+    "build": "rm -rf dist tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo && tsc -p tsconfig.build.json && mkdir -p dist/generated && cp src/generated/api.d.ts dist/generated/api.d.ts",
     "gen:types": "openapi-typescript ../../docs/api/openapi.yaml -o src/generated/api.d.ts",
     "gen:types-check": "pnpm gen:types && git diff --exit-code src/generated/api.d.ts",
     "generate:docs": "tsx scripts/generate-docs.ts",

package/dist/resources/recordings.d.ts

@@ -1,10 +0,0 @@
-import type { RapidCrawl } from '../client.js';
-import type { RecordingId } from '../types.js';
-export declare class RecordingsResource {
-    private readonly client;
-    constructor(client: RapidCrawl);
-    /** POST /v1/recordings — start a recording */
-    create(opts: Record<string, unknown>): Promise<unknown>;
-    /** GET /v1/recordings/{id} — poll a recording by ID */
-    get(id: RecordingId): Promise<unknown>;
-}

package/dist/resources/recordings.js

@@ -1,14 +0,0 @@
-export class RecordingsResource {
-    client;
-    constructor(client) {
-        this.client = client;
-    }
-    /** POST /v1/recordings — start a recording */
-    create(opts) {
-        return this.client.request('POST', '/v1/recordings', opts);
-    }
-    /** GET /v1/recordings/{id} — poll a recording by ID */
-    get(id) {
-        return this.client.request('GET', `/v1/recordings/${id}`);
-    }
-}

package/dist/test-helpers/signal-aware-never-resolver.d.ts

@@ -1,9 +0,0 @@
-/**
- * A `fetch` mock that never settles until the request's own signal aborts.
- *
- * Shared between `client.test.ts` and `resources/__tests__/scrape.test.ts` (#2424 code review
- * cr-3) — both suites need a `fetch` stand-in that hangs forever except for reacting to the
- * abort signal the SDK attaches, so timeout/abort-ordering tests can assert on elapsed time and
- * error code without a real network call.
- */
-export declare function signalAwareNeverResolver(): (url: string, init: RequestInit) => Promise<Response>;

package/dist/test-helpers/signal-aware-never-resolver.js

@@ -1,25 +0,0 @@
-// Test-only fixture, compiled like any other `src` file (not excluded from the tsc build):
-// excluding it broke ESLint's typed-lint project-service resolution (it requires every linted
-// file to be part of the tsconfig `include` set). The tradeoff is a small compiled fixture
-// landing in `dist/test-helpers/` alongside the package's real exports — negligible, and no
-// consumer imports it (it's not re-exported from `index.ts`).
-/**
- * A `fetch` mock that never settles until the request's own signal aborts.
- *
- * Shared between `client.test.ts` and `resources/__tests__/scrape.test.ts` (#2424 code review
- * cr-3) — both suites need a `fetch` stand-in that hangs forever except for reacting to the
- * abort signal the SDK attaches, so timeout/abort-ordering tests can assert on elapsed time and
- * error code without a real network call.
- */
-export function signalAwareNeverResolver() {
-    return (_url, init) => new Promise((_resolve, reject) => {
-        const signal = init.signal;
-        if (!signal)
-            return; // hangs — only used by tests that always pass a signal
-        if (signal.aborted) {
-            reject(signal.reason);
-            return;
-        }
-        signal.addEventListener('abort', () => reject(signal.reason));
-    });
-}