@speechweave/node 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SpeechWeave
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,116 @@
+# @speechweave/node
+
+[![npm version](https://img.shields.io/npm/v/@speechweave/node.svg)](https://www.npmjs.com/package/@speechweave/node)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Official Node.js client for the SpeechWeave `/v1` API. Node.js 18+.
+
+**Docs:** [speechweave.com/docs](https://speechweave.com/docs) · [API reference](https://speechweave.com/docs/api)
+
+## Install
+
+```bash
+npm install @speechweave/node
+```
+
+Set your API key:
+
+```bash
+export SPEECHWEAVE_API_KEY="sk_..."
+```
+
+## Migrating from OpenAI
+
+You don't need this SDK for a quick swap — use the official `openai` package and point it at SpeechWeave:
+
+```ts
+import fs from "node:fs";
+import OpenAI from "openai";
+
+const client = new OpenAI({
+	apiKey: process.env.SPEECHWEAVE_API_KEY!,
+	baseURL: "https://api.speechweave.com/v1",
+});
+
+const result = await client.audio.transcriptions.create({
+	file: fs.createReadStream("clip.mp3"),
+	model: "core",
+});
+
+console.log(result.text);
+```
+
+OpenAI model names like `whisper-1` are aliased to `core` on our backend. See the [OpenAI migration guide](https://speechweave.com/docs/migration/openai).
+
+**When to use @speechweave/node:** native jobs API, presigned uploads for large files, `waitForJob`, and webhook verification.
+
+## Quick start
+
+```ts
+import { SpeechWeave, waitForJob } from "@speechweave/node";
+
+const client = new SpeechWeave();
+
+const job = await client.transcribeFile(buffer, {
+	filename: "audio.wav",
+	model: "core",
+	language: "en",
+});
+
+const result = await waitForJob(client, job.id, { timeout_ms: 300_000 });
+console.log(result.transcript);
+```
+
+For `jobs.create`, URL input, cancel, and other job operations, see the [API reference](https://speechweave.com/docs/api).
+
+## Provider-shaped helpers (optional)
+
+Convenience helpers if you want OpenAI/Deepgram/AssemblyAI response shapes without adding another package. They use presigned uploads like the native API.
+
+```ts
+const { text } = await client.audio.transcriptions.create({
+	file: buffer,
+	filename: "clip.mp3",
+	model: "core",
+});
+```
+
+Pass `wait: false` to return the created job without polling.
+
+More examples: [OpenAI](https://speechweave.com/docs/migration/openai) · [Deepgram](https://speechweave.com/docs/migration/deepgram) · [AssemblyAI](https://speechweave.com/docs/migration/assemblyai)
+
+## Configuration
+
+- `api_key` — or set `SPEECHWEAVE_API_KEY`
+- `base_url` — defaults to `https://api.speechweave.com/v1`
+- `fetch_func` — optional custom `fetch` implementation
+
+## Errors
+
+```ts
+import { SpeechWeave, SpeechWeaveError } from "@speechweave/node";
+
+try {
+	const client = new SpeechWeave({ api_key: "bad_key" });
+	await client.getJob("job_123");
+} catch (e) {
+	if (e instanceof SpeechWeaveError) {
+		console.log(e.status);
+		console.log(e.code);
+	}
+}
+```
+
+## Webhooks
+
+```ts
+import { verifyWebhook } from "@speechweave/node";
+
+const result = verifyWebhook(
+	WEBHOOK_SECRET,
+	rawBody,
+	signatureHeader,
+);
+```
+
+Configure webhooks in the dashboard. Payloads are signed with `SpeechWeave-Signature`.