@crawlora-org/sdk 1.2.0-sdk.12 → 1.2.0-sdk.14

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v1.2.0-sdk.14
+
+- Aligned the promoted SDK beta tag with the Python and Go SDKs.
+- Added explicit coverage for request-level header overrides.
+
+## v1.2.0-sdk.13
+
+- Updated the published npmjs package homepage to `https://crawlora.net`.
+
 ## v1.2.0-sdk.12
 
 - Added tag/manual CI/CD workflows for npmjs publishing and GitHub Packages

package/README.md

@@ -1,96 +1,154 @@
 # Crawlora JavaScript SDK
 
-JavaScript and TypeScript SDK for the public Crawlora API. It works in Node.js
-18+ and modern runtimes with `fetch`.
+Official JavaScript and TypeScript client for the public Crawlora API. Use it
+to call Crawlora scraping, search, marketplace, media, maps, finance, and usage
+endpoints with a small `fetch`-based client and generated TypeScript types.
 
-Website: [crawlora.net](https://crawlora.net)
+- Runtime: Node.js 18+ or any modern runtime with `fetch`
+- Auth: `x-api-key`
+- Default API base URL: `https://api.crawlora.net/api/v1`
+- Reference: [operations](docs/operations.md) and [recipes](docs/recipes.md)
 
 ## Install
 
+Install the latest published npm package:
+
+```sh
+npm install @crawlora-org/sdk
+```
+
+For reproducible builds, pin a published package version:
+
 ```sh
-npm install @crawlora-org/sdk@latest
+npm install @crawlora-org/sdk@VERSION
 ```
 
-For reproducible builds, pin the current package version:
+## API Key
+
+Create or sign in to your Crawlora account at [crawlora.net](https://crawlora.net),
+then create an API key in the dashboard.
 
 ```sh
-npm install @crawlora-org/sdk@1.2.0-sdk.12
+read -r CRAWLORA_API_KEY
+export CRAWLORA_API_KEY
 ```
 
-## Usage
+## First Request
 
 ```js
 import { CrawloraClient } from "@crawlora-org/sdk";
 
-const crawlora = new CrawloraClient({ apiKey: process.env.CRAWLORA_API_KEY });
-const result = await crawlora.bing.search({ q: "coffee shops", count: 10 });
-console.log(result);
+const crawlora = new CrawloraClient({
+  apiKey: process.env.CRAWLORA_API_KEY
+});
+
+const response = await crawlora.bing.search({
+  q: "coffee shops",
+  count: 10
+});
+
+console.log(response.data?.results?.[0]);
 ```
 
-Generated TypeScript declarations cover operation ids, endpoint groups,
-parameter objects, enum values, request options, and response aliases.
-Dynamic calls infer parameter and response types from literal operation ids:
+Endpoint groups are generated from the public API contract, so common calls are
+available as methods such as `crawlora.bing.search(...)`,
+`crawlora.youtube.transcript(...)`, and `crawlora.google.mapSearch(...)`.
+
+## Typed Dynamic Calls
+
+You can also call by operation id. Literal operation ids infer parameter and
+response types in TypeScript:
 
 ```ts
-const result = await crawlora.request("bing-search", { q: "coffee shops" });
-result.data?.results?.[0]?.title;
+const response = await crawlora.request("bing-search", {
+  q: "coffee shops",
+  count: 10
+});
+
+response.data?.results?.[0]?.title;
 ```
 
+Generated declarations include operation ids, endpoint groups, request
+parameters, enum values, response aliases, and request options.
+
 ## Configuration
 
 ```js
 const crawlora = new CrawloraClient({
   apiKey: process.env.CRAWLORA_API_KEY,
   baseUrl: "https://api.crawlora.net/api/v1",
+  timeout: 30_000,
   retries: 2,
   retryDelay: 250,
-  headers: { "x-client": "example" }
+  headers: {
+    "x-client": "my-app"
+  }
 });
 ```
 
-Per-request options support headers, timeout, abort signals, and response mode:
+Per-request options can override headers, timeout, abort signal, and response
+mode:
 
 ```js
-const text = await crawlora.youtube.transcript(
-  { id: "VIDEO_ID", format: "text" },
-  { responseType: "text", timeout: 10000 }
+const controller = new AbortController();
+
+const response = await crawlora.bing.search(
+  { q: "coffee shops" },
+  {
+    timeout: 10_000,
+    signal: controller.signal,
+    headers: { "x-request-id": "search-001" }
+  }
 );
 ```
 
-Failed API calls throw `CrawloraError` with `status`, optional API `code`,
-parsed `body`, and the original `response` when available.
+## Text Responses
 
-## Reference
+Most endpoints return JSON. Endpoints that support alternate text output, such
+as YouTube transcripts, can opt into text mode:
 
-- [Operation reference](docs/operations.md)
-- [Usage recipes](docs/recipes.md)
+```js
+const transcript = await crawlora.youtube.transcript(
+  { id: "VIDEO_ID", format: "text" },
+  { responseType: "text" }
+);
 
-## Examples
+console.log(transcript);
+```
 
-Runnable examples live under `examples/`:
+## Errors
 
-```sh
-CRAWLORA_API_KEY=... npm run example:bing-search
-CRAWLORA_API_KEY=... CRAWLORA_YOUTUBE_VIDEO_ID=... npm run example:youtube-transcript
+Failed API calls throw `CrawloraError`:
+
+```js
+import { CrawloraClient, CrawloraError } from "@crawlora-org/sdk";
+
+try {
+  await crawlora.bing.search({ q: "coffee shops" });
+} catch (error) {
+  if (error instanceof CrawloraError) {
+    console.error(error.status, error.code, error.body);
+  }
+  throw error;
+}
 ```
 
-Each example also accepts `CRAWLORA_BASE_URL` for staging or local API testing.
-The examples exit without making a request when the required live environment
-variables are not set. `npm run smoke:live` runs all live examples in sequence.
+The error includes `status`, optional API `code`, parsed `body`, the original
+`response` when available, and a parser or transport `cause` when relevant.
 
-## Versioning
+## Examples
 
-This SDK is published to npmjs and mirrored to GitHub Packages. The package
-`latest` dist-tag and the moving Git tag named `latest` track the current
-promoted beta. Explicit package versions and Git beta tags such as
-`1.2.0-sdk.12` / `v1.2.0-sdk.12` remain available for reproducible builds. Pin
-an explicit version in production applications and upgrade intentionally.
+Runnable examples live under `examples/` and skip cleanly when required
+environment variables are missing:
 
-GitHub Packages installs require a project `.npmrc` that maps the
-`@crawlora-org` scope to `https://npm.pkg.github.com` and a GitHub token that
-can read packages.
+```sh
+npm run example:bing-search
+npm run example:youtube-transcript
+```
+
+Set `CRAWLORA_BASE_URL` to point examples at a staging or local API.
 
-## Package Name
+## Package Notes
 
 The npm package name is `@crawlora-org/sdk`:
 
@@ -98,11 +156,10 @@ The npm package name is `@crawlora-org/sdk`:
 import { CrawloraClient } from "@crawlora-org/sdk";
 ```
 
-The package names `crawlora` and `@crawlora/sdk` are not used by this repository
-because they already exist on npm and point to a different package source.
-
-## Optional Live Smoke Test
+The package names `crawlora` and `@crawlora/sdk` are not used by this
+repository because they already exist on npm and point to different package
+sources.
 
-Default tests use mock `fetch` implementations. The programs under `examples/`
-can be used as optional live smoke tests when `CRAWLORA_API_KEY` is available.
-Live calls are not part of default CI.
+This SDK is published to npmjs and may also be mirrored to GitHub Packages. Pin
+an explicit published version for production applications and upgrade
+intentionally.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crawlora-org/sdk",
-  "version": "1.2.0-sdk.12",
+  "version": "1.2.0-sdk.14",
   "description": "JavaScript and TypeScript SDK for the public Crawlora API.",
   "keywords": [
     "crawlora",
@@ -8,7 +8,7 @@
     "web-scraping",
     "api-client"
   ],
-  "homepage": "https://github.com/Crawlora-org/crawlora-typescript-sdk#readme",
+  "homepage": "https://crawlora.net",
   "bugs": {
     "url": "https://github.com/Crawlora-org/crawlora-typescript-sdk/issues"
   },

package/src/client.js

@@ -1,7 +1,7 @@
 import { operations, groups } from "./operations.js";
 
 const DEFAULT_BASE_URL = "https://api.crawlora.net/api/v1";
-export const VERSION = "1.2.0-sdk.12";
+export const VERSION = "1.2.0-sdk.14";
 const DEFAULT_USER_AGENT = `crawlora-js-sdk/${VERSION}`;
 
 export class CrawloraError extends Error {