reelscribe 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ReelScribe
+
+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,182 @@
+# ReelScribe Node.js SDK
+
+Official Node.js/TypeScript client for the [ReelScribe](https://www.reelscribe.app) API — transcribe Instagram Reels, TikTok videos, and YouTube Shorts programmatically.
+
+[![npm version](https://img.shields.io/npm/v/reelscribe)](https://www.npmjs.com/package/reelscribe)
+[![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](LICENSE)
+
+## Installation
+
+```bash
+npm install reelscribe
+```
+
+## Quick Start
+
+```ts
+import { ReelScribe } from 'reelscribe'
+
+const rs = new ReelScribe('rs_your_api_key')
+
+// Submit a video for transcription
+const { requestId } = await rs.transcribe({
+  url: 'https://www.instagram.com/reel/ABC123/',
+})
+
+// Poll for the result
+const transcription = await rs.getTranscription({ requestId })
+console.log(transcription.transcription)
+```
+
+> Get your API key from the [ReelScribe dashboard](https://www.reelscribe.app/api).
+
+## Usage
+
+### Transcribe a Video
+
+Submit an Instagram Reel, TikTok video, or YouTube Short for transcription. Costs 1 credit per request.
+
+```ts
+const result = await rs.transcribe({
+  url: 'https://www.youtube.com/shorts/dQw4w9WgXcQ',
+})
+
+console.log(result.requestId) // use this to check status
+```
+
+#### With Webhook
+
+Instead of polling, provide a `resumeUrl` to receive a POST when the transcription is ready:
+
+```ts
+const result = await rs.transcribe({
+  url: 'https://www.tiktok.com/@user/video/1234567890',
+  resumeUrl: 'https://your-server.com/webhook',
+})
+```
+
+Your server will receive the full transcription result as a POST request. See the [webhook docs](https://www.reelscribe.app/api) for the payload format.
+
+### Get a Transcription
+
+Retrieve a transcription by the `requestId` returned from `transcribe()`:
+
+```ts
+const t = await rs.getTranscription({ requestId: '550e8400-...' })
+
+console.log(t.status)         // 'completed'
+console.log(t.transcription)  // 'The full transcription text...'
+console.log(t.caption)        // Original post caption
+console.log(t.hashtags)       // ['tag1', 'tag2']
+console.log(t.stats)          // { likes: 1234, views: 56789, comments: 42 }
+console.log(t.segments)       // [{ start: 0, end: 2.5, text: 'Hello...' }]
+```
+
+Or fetch by Convex document ID:
+
+```ts
+const t = await rs.getTranscription({ id: 'abc123' })
+```
+
+### List Transcriptions
+
+```ts
+// All transcriptions
+const { transcriptions, total } = await rs.listTranscriptions()
+
+// Filter by status
+const completed = await rs.listTranscriptions({ status: 'completed' })
+```
+
+### Check Credits
+
+```ts
+const credits = await rs.getCredits()
+
+console.log(credits.credits)            // 450
+console.log(credits.tier)               // 'creator'
+console.log(credits.subscriptionStatus) // 'active'
+console.log(credits.storageUsed)        // 42
+console.log(credits.storageLimit)       // 100
+```
+
+### Settings
+
+```ts
+// Read settings
+const settings = await rs.getSettings()
+console.log(settings.autoPruneStorage) // true
+
+// Update settings
+await rs.updateSettings({ autoPruneStorage: false })
+```
+
+### Health Check
+
+```ts
+const health = await rs.health()
+console.log(health.healthy) // true
+```
+
+## Error Handling
+
+All API errors throw a `ReelScribeError` with a machine-readable `code` and HTTP `status`:
+
+```ts
+import { ReelScribe, ReelScribeError } from 'reelscribe'
+
+try {
+  await rs.transcribe({ url: 'https://www.instagram.com/reel/ABC123/' })
+} catch (err) {
+  if (err instanceof ReelScribeError) {
+    console.log(err.code)    // 'INSUFFICIENT_CREDITS'
+    console.log(err.status)  // 402
+    console.log(err.message) // 'You need at least 1 credit'
+  }
+}
+```
+
+| Code | Status | Description |
+|------|--------|-------------|
+| `INVALID_REQUEST` | 400 | Bad request body or missing fields |
+| `INVALID_URL` | 400 | Unsupported video platform |
+| `UNAUTHORIZED` | 401 | Missing or invalid API key |
+| `INSUFFICIENT_CREDITS` | 402 | No credits remaining |
+| `STORAGE_LIMIT` | 403 | Transcript storage full |
+| `NOT_FOUND` | 404 | Transcription not found |
+| `SERVICE_ERROR` | 503 | Transcription service unavailable (credit refunded) |
+
+## Configuration
+
+```ts
+const rs = new ReelScribe('rs_your_api_key', {
+  // Override the base URL (useful for testing)
+  baseUrl: 'https://staging.reelscribe.app',
+  // Provide a custom fetch implementation
+  fetch: myCustomFetch,
+})
+```
+
+## Supported Platforms
+
+| Platform | Example URL |
+|----------|-------------|
+| Instagram Reels | `https://www.instagram.com/reel/ABC123/` |
+| TikTok Videos | `https://www.tiktok.com/@user/video/1234567890` |
+| YouTube Shorts | `https://www.youtube.com/shorts/dQw4w9WgXcQ` |
+| YouTube Videos | `https://www.youtube.com/watch?v=dQw4w9WgXcQ` |
+
+## Requirements
+
+- Node.js 18+ (uses native `fetch`)
+- A [ReelScribe](https://www.reelscribe.app) account with API access
+
+## Links
+
+- [ReelScribe](https://www.reelscribe.app) — Video transcription for content creators
+- [API Documentation](https://www.reelscribe.app/api) — Full endpoint reference & API key management
+- [Pricing](https://www.reelscribe.app/pricing) — Plans starting at $9.99/month
+
+## License
+
+[MIT](LICENSE)

package/dist/index.d.mts

@@ -0,0 +1,178 @@
+/** Supported video platforms. */
+type Platform = 'instagram' | 'tiktok' | 'youtube';
+/** Transcription lifecycle status. */
+type TranscriptionStatus = 'submitted' | 'processing' | 'completed' | 'failed' | 'cancelled';
+/** Subscription tier. */
+type Tier = 'free' | 'creator' | 'agency' | 'enterprise';
+interface TranscribeOptions {
+    /** Instagram, TikTok, or YouTube URL (max 2048 chars). */
+    url: string;
+    /** Optional HTTPS webhook URL — receives a POST when the job finishes. */
+    resumeUrl?: string;
+}
+interface ListTranscriptionsOptions {
+    /** Filter by status. */
+    status?: TranscriptionStatus;
+}
+interface GetTranscriptionOptions {
+    /** Convex document ID. */
+    id?: string;
+    /** The requestId returned from `transcribe()`. */
+    requestId?: string;
+}
+interface UpdateSettingsOptions {
+    /** Enable or disable automatic storage pruning. */
+    autoPruneStorage: boolean;
+}
+interface TranscribeResult {
+    requestId: string;
+    status: 'submitted';
+    message: string;
+}
+interface DuplicateResult {
+    duplicate: true;
+    message: string;
+    transcription: {
+        id: string;
+        status: TranscriptionStatus;
+        transcription: string | null;
+        createdAt: number;
+    };
+}
+interface VideoStats {
+    likes: number | null;
+    views: number | null;
+    comments: number | null;
+}
+interface Segment {
+    start: number;
+    end: number;
+    text: string;
+}
+interface Transcription {
+    id: string;
+    requestId: string | null;
+    url: string;
+    platform: Platform | null;
+    status: TranscriptionStatus;
+    transcription: string | null;
+    createdAt: number;
+    completedAt: number | null;
+    caption: string | null;
+    hashtags: string[] | null;
+    mentions: string[] | null;
+    owner: string | null;
+    duration: number | null;
+    stats: VideoStats | null;
+    segments: Segment[] | null;
+    thumbnailUrl: string | null;
+    videoTimestamp: string | null;
+    errorMessage: string | null;
+    errorType: string | null;
+}
+interface TranscriptionList {
+    transcriptions: Transcription[];
+    total: number;
+}
+interface Credits {
+    credits: number;
+    tier: Tier;
+    subscriptionStatus: string | null;
+    storageUsed: number;
+    storageLimit: number;
+}
+interface Settings {
+    autoPruneStorage: boolean;
+}
+interface HealthCheck {
+    healthy: boolean;
+    timestamp: string;
+}
+interface ApiErrorBody {
+    code: string;
+    message: string;
+    status: number;
+}
+interface ReelScribeOptions {
+    /** Override the base URL (default: `https://www.reelscribe.app`). */
+    baseUrl?: string;
+    /** Override the global `fetch` implementation. */
+    fetch?: typeof globalThis.fetch;
+}
+
+/**
+ * ReelScribe API client.
+ *
+ * @example
+ * ```ts
+ * const rs = new ReelScribe('rs_your_api_key')
+ * const { requestId } = await rs.transcribe({ url: 'https://www.instagram.com/reel/ABC123/' })
+ * const result = await rs.getTranscription({ requestId })
+ * ```
+ *
+ * @see https://www.reelscribe.app/api — full API documentation
+ */
+declare class ReelScribe {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly _fetch;
+    constructor(apiKey: string, options?: ReelScribeOptions);
+    private request;
+    /**
+     * Submit a video URL for transcription. Costs 1 credit.
+     *
+     * If the video was already transcribed, returns a `DuplicateResult` instead.
+     *
+     * @see https://www.reelscribe.app/api — POST /v1/transcribe
+     */
+    transcribe(options: TranscribeOptions): Promise<TranscribeResult | DuplicateResult>;
+    /**
+     * Fetch a single transcription by Convex document ID or requestId.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/transcriptions?id=...
+     */
+    getTranscription(options: GetTranscriptionOptions): Promise<Transcription>;
+    /**
+     * List all your transcriptions, optionally filtered by status.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/transcriptions
+     */
+    listTranscriptions(options?: ListTranscriptionsOptions): Promise<TranscriptionList>;
+    /**
+     * Check your credit balance, subscription tier, and storage usage.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/credits
+     */
+    getCredits(): Promise<Credits>;
+    /**
+     * Get your current settings.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/settings
+     */
+    getSettings(): Promise<Settings>;
+    /**
+     * Update your settings (e.g. auto-prune storage).
+     *
+     * @see https://www.reelscribe.app/api — PATCH /v1/settings
+     */
+    updateSettings(options: UpdateSettingsOptions): Promise<Settings>;
+    /**
+     * Check whether the API is healthy. Does not require authentication.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/health
+     */
+    health(): Promise<HealthCheck>;
+}
+
+/**
+ * Error thrown when the ReelScribe API returns a non-2xx response.
+ */
+declare class ReelScribeError extends Error {
+    /** Machine-readable error code (e.g. `INSUFFICIENT_CREDITS`). */
+    readonly code: string;
+    /** HTTP status code. */
+    readonly status: number;
+    constructor(body: ApiErrorBody);
+}
+
+export { type ApiErrorBody, type Credits, type DuplicateResult, type GetTranscriptionOptions, type HealthCheck, type ListTranscriptionsOptions, type Platform, ReelScribe, ReelScribeError, type ReelScribeOptions, type Segment, type Settings, type Tier, type TranscribeOptions, type TranscribeResult, type Transcription, type TranscriptionList, type TranscriptionStatus, type UpdateSettingsOptions, type VideoStats };

package/dist/index.d.ts

@@ -0,0 +1,178 @@
+/** Supported video platforms. */
+type Platform = 'instagram' | 'tiktok' | 'youtube';
+/** Transcription lifecycle status. */
+type TranscriptionStatus = 'submitted' | 'processing' | 'completed' | 'failed' | 'cancelled';
+/** Subscription tier. */
+type Tier = 'free' | 'creator' | 'agency' | 'enterprise';
+interface TranscribeOptions {
+    /** Instagram, TikTok, or YouTube URL (max 2048 chars). */
+    url: string;
+    /** Optional HTTPS webhook URL — receives a POST when the job finishes. */
+    resumeUrl?: string;
+}
+interface ListTranscriptionsOptions {
+    /** Filter by status. */
+    status?: TranscriptionStatus;
+}
+interface GetTranscriptionOptions {
+    /** Convex document ID. */
+    id?: string;
+    /** The requestId returned from `transcribe()`. */
+    requestId?: string;
+}
+interface UpdateSettingsOptions {
+    /** Enable or disable automatic storage pruning. */
+    autoPruneStorage: boolean;
+}
+interface TranscribeResult {
+    requestId: string;
+    status: 'submitted';
+    message: string;
+}
+interface DuplicateResult {
+    duplicate: true;
+    message: string;
+    transcription: {
+        id: string;
+        status: TranscriptionStatus;
+        transcription: string | null;
+        createdAt: number;
+    };
+}
+interface VideoStats {
+    likes: number | null;
+    views: number | null;
+    comments: number | null;
+}
+interface Segment {
+    start: number;
+    end: number;
+    text: string;
+}
+interface Transcription {
+    id: string;
+    requestId: string | null;
+    url: string;
+    platform: Platform | null;
+    status: TranscriptionStatus;
+    transcription: string | null;
+    createdAt: number;
+    completedAt: number | null;
+    caption: string | null;
+    hashtags: string[] | null;
+    mentions: string[] | null;
+    owner: string | null;
+    duration: number | null;
+    stats: VideoStats | null;
+    segments: Segment[] | null;
+    thumbnailUrl: string | null;
+    videoTimestamp: string | null;
+    errorMessage: string | null;
+    errorType: string | null;
+}
+interface TranscriptionList {
+    transcriptions: Transcription[];
+    total: number;
+}
+interface Credits {
+    credits: number;
+    tier: Tier;
+    subscriptionStatus: string | null;
+    storageUsed: number;
+    storageLimit: number;
+}
+interface Settings {
+    autoPruneStorage: boolean;
+}
+interface HealthCheck {
+    healthy: boolean;
+    timestamp: string;
+}
+interface ApiErrorBody {
+    code: string;
+    message: string;
+    status: number;
+}
+interface ReelScribeOptions {
+    /** Override the base URL (default: `https://www.reelscribe.app`). */
+    baseUrl?: string;
+    /** Override the global `fetch` implementation. */
+    fetch?: typeof globalThis.fetch;
+}
+
+/**
+ * ReelScribe API client.
+ *
+ * @example
+ * ```ts
+ * const rs = new ReelScribe('rs_your_api_key')
+ * const { requestId } = await rs.transcribe({ url: 'https://www.instagram.com/reel/ABC123/' })
+ * const result = await rs.getTranscription({ requestId })
+ * ```
+ *
+ * @see https://www.reelscribe.app/api — full API documentation
+ */
+declare class ReelScribe {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly _fetch;
+    constructor(apiKey: string, options?: ReelScribeOptions);
+    private request;
+    /**
+     * Submit a video URL for transcription. Costs 1 credit.
+     *
+     * If the video was already transcribed, returns a `DuplicateResult` instead.
+     *
+     * @see https://www.reelscribe.app/api — POST /v1/transcribe
+     */
+    transcribe(options: TranscribeOptions): Promise<TranscribeResult | DuplicateResult>;
+    /**
+     * Fetch a single transcription by Convex document ID or requestId.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/transcriptions?id=...
+     */
+    getTranscription(options: GetTranscriptionOptions): Promise<Transcription>;
+    /**
+     * List all your transcriptions, optionally filtered by status.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/transcriptions
+     */
+    listTranscriptions(options?: ListTranscriptionsOptions): Promise<TranscriptionList>;
+    /**
+     * Check your credit balance, subscription tier, and storage usage.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/credits
+     */
+    getCredits(): Promise<Credits>;
+    /**
+     * Get your current settings.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/settings
+     */
+    getSettings(): Promise<Settings>;
+    /**
+     * Update your settings (e.g. auto-prune storage).
+     *
+     * @see https://www.reelscribe.app/api — PATCH /v1/settings
+     */
+    updateSettings(options: UpdateSettingsOptions): Promise<Settings>;
+    /**
+     * Check whether the API is healthy. Does not require authentication.
+     *
+     * @see https://www.reelscribe.app/api — GET /v1/health
+     */
+    health(): Promise<HealthCheck>;
+}
+
+/**
+ * Error thrown when the ReelScribe API returns a non-2xx response.
+ */
+declare class ReelScribeError extends Error {
+    /** Machine-readable error code (e.g. `INSUFFICIENT_CREDITS`). */
+    readonly code: string;
+    /** HTTP status code. */
+    readonly status: number;
+    constructor(body: ApiErrorBody);
+}
+
+export { type ApiErrorBody, type Credits, type DuplicateResult, type GetTranscriptionOptions, type HealthCheck, type ListTranscriptionsOptions, type Platform, ReelScribe, ReelScribeError, type ReelScribeOptions, type Segment, type Settings, type Tier, type TranscribeOptions, type TranscribeResult, type Transcription, type TranscriptionList, type TranscriptionStatus, type UpdateSettingsOptions, type VideoStats };

package/dist/index.js

@@ -0,0 +1,141 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ReelScribe: () => ReelScribe,
+  ReelScribeError: () => ReelScribeError
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/errors.ts
+var ReelScribeError = class extends Error {
+  constructor(body) {
+    super(body.message);
+    this.name = "ReelScribeError";
+    this.code = body.code;
+    this.status = body.status;
+  }
+};
+
+// src/client.ts
+var DEFAULT_BASE_URL = "https://www.reelscribe.app";
+var ReelScribe = class {
+  constructor(apiKey, options) {
+    if (!apiKey) throw new Error("An API key is required. Get one at https://www.reelscribe.app/api");
+    this.apiKey = apiKey;
+    this.baseUrl = (options?.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this._fetch = options?.fetch ?? globalThis.fetch;
+  }
+  // -------------------------------------------------------------------------
+  // Internal helpers
+  // -------------------------------------------------------------------------
+  async request(method, path, body) {
+    const url = `${this.baseUrl}/v1/${path}`;
+    const headers = {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Content-Type": "application/json"
+    };
+    const res = await this._fetch(url, {
+      method,
+      headers,
+      body: body ? JSON.stringify(body) : void 0
+    });
+    const json = await res.json();
+    if (!res.ok) {
+      throw new ReelScribeError(json.error ?? { code: "UNKNOWN", message: res.statusText, status: res.status });
+    }
+    return json;
+  }
+  // -------------------------------------------------------------------------
+  // Public methods
+  // -------------------------------------------------------------------------
+  /**
+   * Submit a video URL for transcription. Costs 1 credit.
+   *
+   * If the video was already transcribed, returns a `DuplicateResult` instead.
+   *
+   * @see https://www.reelscribe.app/api — POST /v1/transcribe
+   */
+  async transcribe(options) {
+    return this.request("POST", "transcribe", options);
+  }
+  /**
+   * Fetch a single transcription by Convex document ID or requestId.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/transcriptions?id=...
+   */
+  async getTranscription(options) {
+    const params = new URLSearchParams();
+    if (options.id) params.set("id", options.id);
+    if (options.requestId) params.set("requestId", options.requestId);
+    return this.request("GET", `transcriptions?${params}`);
+  }
+  /**
+   * List all your transcriptions, optionally filtered by status.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/transcriptions
+   */
+  async listTranscriptions(options) {
+    const params = new URLSearchParams();
+    if (options?.status) params.set("status", options.status);
+    const qs = params.toString();
+    return this.request("GET", `transcriptions${qs ? `?${qs}` : ""}`);
+  }
+  /**
+   * Check your credit balance, subscription tier, and storage usage.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/credits
+   */
+  async getCredits() {
+    return this.request("GET", "credits");
+  }
+  /**
+   * Get your current settings.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/settings
+   */
+  async getSettings() {
+    return this.request("GET", "settings");
+  }
+  /**
+   * Update your settings (e.g. auto-prune storage).
+   *
+   * @see https://www.reelscribe.app/api — PATCH /v1/settings
+   */
+  async updateSettings(options) {
+    return this.request("PATCH", "settings", options);
+  }
+  /**
+   * Check whether the API is healthy. Does not require authentication.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/health
+   */
+  async health() {
+    const res = await this._fetch(`${this.baseUrl}/v1/health`);
+    return res.json();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ReelScribe,
+  ReelScribeError
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/errors.ts","../src/client.ts"],"sourcesContent":["export { ReelScribe } from './client'\nexport { ReelScribeError } from './errors'\nexport type {\n  ApiErrorBody,\n  Credits,\n  DuplicateResult,\n  GetTranscriptionOptions,\n  HealthCheck,\n  ListTranscriptionsOptions,\n  Platform,\n  ReelScribeOptions,\n  Segment,\n  Settings,\n  Tier,\n  TranscribeOptions,\n  TranscribeResult,\n  Transcription,\n  TranscriptionList,\n  TranscriptionStatus,\n  UpdateSettingsOptions,\n  VideoStats,\n} from './types'\n","import type { ApiErrorBody } from './types'\n\n/**\n * Error thrown when the ReelScribe API returns a non-2xx response.\n */\nexport class ReelScribeError extends Error {\n  /** Machine-readable error code (e.g. `INSUFFICIENT_CREDITS`). */\n  readonly code: string\n  /** HTTP status code. */\n  readonly status: number\n\n  constructor(body: ApiErrorBody) {\n    super(body.message)\n    this.name = 'ReelScribeError'\n    this.code = body.code\n    this.status = body.status\n  }\n}\n","import { ReelScribeError } from './errors'\nimport type {\n  Credits,\n  DuplicateResult,\n  GetTranscriptionOptions,\n  HealthCheck,\n  ListTranscriptionsOptions,\n  ReelScribeOptions,\n  Settings,\n  TranscribeOptions,\n  TranscribeResult,\n  Transcription,\n  TranscriptionList,\n  UpdateSettingsOptions,\n} from './types'\n\nconst DEFAULT_BASE_URL = 'https://www.reelscribe.app'\n\n/**\n * ReelScribe API client.\n *\n * @example\n * ```ts\n * const rs = new ReelScribe('rs_your_api_key')\n * const { requestId } = await rs.transcribe({ url: 'https://www.instagram.com/reel/ABC123/' })\n * const result = await rs.getTranscription({ requestId })\n * ```\n *\n * @see https://www.reelscribe.app/api — full API documentation\n */\nexport class ReelScribe {\n  private readonly apiKey: string\n  private readonly baseUrl: string\n  private readonly _fetch: typeof globalThis.fetch\n\n  constructor(apiKey: string, options?: ReelScribeOptions) {\n    if (!apiKey) throw new Error('An API key is required. Get one at https://www.reelscribe.app/api')\n    this.apiKey = apiKey\n    this.baseUrl = (options?.baseUrl ?? DEFAULT_BASE_URL).replace(/\\/+$/, '')\n    this._fetch = options?.fetch ?? globalThis.fetch\n  }\n\n  // -------------------------------------------------------------------------\n  // Internal helpers\n  // -------------------------------------------------------------------------\n\n  private async request<T>(method: string, path: string, body?: unknown): Promise<T> {\n    const url = `${this.baseUrl}/v1/${path}`\n    const headers: Record<string, string> = {\n      Authorization: `Bearer ${this.apiKey}`,\n      'Content-Type': 'application/json',\n    }\n\n    const res = await this._fetch(url, {\n      method,\n      headers,\n      body: body ? JSON.stringify(body) : undefined,\n    })\n\n    const json = await res.json()\n\n    if (!res.ok) {\n      throw new ReelScribeError(json.error ?? { code: 'UNKNOWN', message: res.statusText, status: res.status })\n    }\n\n    return json as T\n  }\n\n  // -------------------------------------------------------------------------\n  // Public methods\n  // -------------------------------------------------------------------------\n\n  /**\n   * Submit a video URL for transcription. Costs 1 credit.\n   *\n   * If the video was already transcribed, returns a `DuplicateResult` instead.\n   *\n   * @see https://www.reelscribe.app/api — POST /v1/transcribe\n   */\n  async transcribe(options: TranscribeOptions): Promise<TranscribeResult | DuplicateResult> {\n    return this.request('POST', 'transcribe', options)\n  }\n\n  /**\n   * Fetch a single transcription by Convex document ID or requestId.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/transcriptions?id=...\n   */\n  async getTranscription(options: GetTranscriptionOptions): Promise<Transcription> {\n    const params = new URLSearchParams()\n    if (options.id) params.set('id', options.id)\n    if (options.requestId) params.set('requestId', options.requestId)\n    return this.request('GET', `transcriptions?${params}`)\n  }\n\n  /**\n   * List all your transcriptions, optionally filtered by status.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/transcriptions\n   */\n  async listTranscriptions(options?: ListTranscriptionsOptions): Promise<TranscriptionList> {\n    const params = new URLSearchParams()\n    if (options?.status) params.set('status', options.status)\n    const qs = params.toString()\n    return this.request('GET', `transcriptions${qs ? `?${qs}` : ''}`)\n  }\n\n  /**\n   * Check your credit balance, subscription tier, and storage usage.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/credits\n   */\n  async getCredits(): Promise<Credits> {\n    return this.request('GET', 'credits')\n  }\n\n  /**\n   * Get your current settings.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/settings\n   */\n  async getSettings(): Promise<Settings> {\n    return this.request('GET', 'settings')\n  }\n\n  /**\n   * Update your settings (e.g. auto-prune storage).\n   *\n   * @see https://www.reelscribe.app/api — PATCH /v1/settings\n   */\n  async updateSettings(options: UpdateSettingsOptions): Promise<Settings> {\n    return this.request('PATCH', 'settings', options)\n  }\n\n  /**\n   * Check whether the API is healthy. Does not require authentication.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/health\n   */\n  async health(): Promise<HealthCheck> {\n    const res = await this._fetch(`${this.baseUrl}/v1/health`)\n    return res.json()\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EAMzC,YAAY,MAAoB;AAC9B,UAAM,KAAK,OAAO;AAClB,SAAK,OAAO;AACZ,SAAK,OAAO,KAAK;AACjB,SAAK,SAAS,KAAK;AAAA,EACrB;AACF;;;ACDA,IAAM,mBAAmB;AAclB,IAAM,aAAN,MAAiB;AAAA,EAKtB,YAAY,QAAgB,SAA6B;AACvD,QAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,mEAAmE;AAChG,SAAK,SAAS;AACd,SAAK,WAAW,SAAS,WAAW,kBAAkB,QAAQ,QAAQ,EAAE;AACxE,SAAK,SAAS,SAAS,SAAS,WAAW;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAMA,MAAc,QAAW,QAAgB,MAAc,MAA4B;AACjF,UAAM,MAAM,GAAG,KAAK,OAAO,OAAO,IAAI;AACtC,UAAM,UAAkC;AAAA,MACtC,eAAe,UAAU,KAAK,MAAM;AAAA,MACpC,gBAAgB;AAAA,IAClB;AAEA,UAAM,MAAM,MAAM,KAAK,OAAO,KAAK;AAAA,MACjC;AAAA,MACA;AAAA,MACA,MAAM,OAAO,KAAK,UAAU,IAAI,IAAI;AAAA,IACtC,CAAC;AAED,UAAM,OAAO,MAAM,IAAI,KAAK;AAE5B,QAAI,CAAC,IAAI,IAAI;AACX,YAAM,IAAI,gBAAgB,KAAK,SAAS,EAAE,MAAM,WAAW,SAAS,IAAI,YAAY,QAAQ,IAAI,OAAO,CAAC;AAAA,IAC1G;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,WAAW,SAAyE;AACxF,WAAO,KAAK,QAAQ,QAAQ,cAAc,OAAO;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,iBAAiB,SAA0D;AAC/E,UAAM,SAAS,IAAI,gBAAgB;AACnC,QAAI,QAAQ,GAAI,QAAO,IAAI,MAAM,QAAQ,EAAE;AAC3C,QAAI,QAAQ,UAAW,QAAO,IAAI,aAAa,QAAQ,SAAS;AAChE,WAAO,KAAK,QAAQ,OAAO,kBAAkB,MAAM,EAAE;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,mBAAmB,SAAiE;AACxF,UAAM,SAAS,IAAI,gBAAgB;AACnC,QAAI,SAAS,OAAQ,QAAO,IAAI,UAAU,QAAQ,MAAM;AACxD,UAAM,KAAK,OAAO,SAAS;AAC3B,WAAO,KAAK,QAAQ,OAAO,iBAAiB,KAAK,IAAI,EAAE,KAAK,EAAE,EAAE;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAA+B;AACnC,WAAO,KAAK,QAAQ,OAAO,SAAS;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAiC;AACrC,WAAO,KAAK,QAAQ,OAAO,UAAU;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,eAAe,SAAmD;AACtE,WAAO,KAAK,QAAQ,SAAS,YAAY,OAAO;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,SAA+B;AACnC,UAAM,MAAM,MAAM,KAAK,OAAO,GAAG,KAAK,OAAO,YAAY;AACzD,WAAO,IAAI,KAAK;AAAA,EAClB;AACF;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,113 @@
+// src/errors.ts
+var ReelScribeError = class extends Error {
+  constructor(body) {
+    super(body.message);
+    this.name = "ReelScribeError";
+    this.code = body.code;
+    this.status = body.status;
+  }
+};
+
+// src/client.ts
+var DEFAULT_BASE_URL = "https://www.reelscribe.app";
+var ReelScribe = class {
+  constructor(apiKey, options) {
+    if (!apiKey) throw new Error("An API key is required. Get one at https://www.reelscribe.app/api");
+    this.apiKey = apiKey;
+    this.baseUrl = (options?.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this._fetch = options?.fetch ?? globalThis.fetch;
+  }
+  // -------------------------------------------------------------------------
+  // Internal helpers
+  // -------------------------------------------------------------------------
+  async request(method, path, body) {
+    const url = `${this.baseUrl}/v1/${path}`;
+    const headers = {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Content-Type": "application/json"
+    };
+    const res = await this._fetch(url, {
+      method,
+      headers,
+      body: body ? JSON.stringify(body) : void 0
+    });
+    const json = await res.json();
+    if (!res.ok) {
+      throw new ReelScribeError(json.error ?? { code: "UNKNOWN", message: res.statusText, status: res.status });
+    }
+    return json;
+  }
+  // -------------------------------------------------------------------------
+  // Public methods
+  // -------------------------------------------------------------------------
+  /**
+   * Submit a video URL for transcription. Costs 1 credit.
+   *
+   * If the video was already transcribed, returns a `DuplicateResult` instead.
+   *
+   * @see https://www.reelscribe.app/api — POST /v1/transcribe
+   */
+  async transcribe(options) {
+    return this.request("POST", "transcribe", options);
+  }
+  /**
+   * Fetch a single transcription by Convex document ID or requestId.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/transcriptions?id=...
+   */
+  async getTranscription(options) {
+    const params = new URLSearchParams();
+    if (options.id) params.set("id", options.id);
+    if (options.requestId) params.set("requestId", options.requestId);
+    return this.request("GET", `transcriptions?${params}`);
+  }
+  /**
+   * List all your transcriptions, optionally filtered by status.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/transcriptions
+   */
+  async listTranscriptions(options) {
+    const params = new URLSearchParams();
+    if (options?.status) params.set("status", options.status);
+    const qs = params.toString();
+    return this.request("GET", `transcriptions${qs ? `?${qs}` : ""}`);
+  }
+  /**
+   * Check your credit balance, subscription tier, and storage usage.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/credits
+   */
+  async getCredits() {
+    return this.request("GET", "credits");
+  }
+  /**
+   * Get your current settings.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/settings
+   */
+  async getSettings() {
+    return this.request("GET", "settings");
+  }
+  /**
+   * Update your settings (e.g. auto-prune storage).
+   *
+   * @see https://www.reelscribe.app/api — PATCH /v1/settings
+   */
+  async updateSettings(options) {
+    return this.request("PATCH", "settings", options);
+  }
+  /**
+   * Check whether the API is healthy. Does not require authentication.
+   *
+   * @see https://www.reelscribe.app/api — GET /v1/health
+   */
+  async health() {
+    const res = await this._fetch(`${this.baseUrl}/v1/health`);
+    return res.json();
+  }
+};
+export {
+  ReelScribe,
+  ReelScribeError
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts","../src/client.ts"],"sourcesContent":["import type { ApiErrorBody } from './types'\n\n/**\n * Error thrown when the ReelScribe API returns a non-2xx response.\n */\nexport class ReelScribeError extends Error {\n  /** Machine-readable error code (e.g. `INSUFFICIENT_CREDITS`). */\n  readonly code: string\n  /** HTTP status code. */\n  readonly status: number\n\n  constructor(body: ApiErrorBody) {\n    super(body.message)\n    this.name = 'ReelScribeError'\n    this.code = body.code\n    this.status = body.status\n  }\n}\n","import { ReelScribeError } from './errors'\nimport type {\n  Credits,\n  DuplicateResult,\n  GetTranscriptionOptions,\n  HealthCheck,\n  ListTranscriptionsOptions,\n  ReelScribeOptions,\n  Settings,\n  TranscribeOptions,\n  TranscribeResult,\n  Transcription,\n  TranscriptionList,\n  UpdateSettingsOptions,\n} from './types'\n\nconst DEFAULT_BASE_URL = 'https://www.reelscribe.app'\n\n/**\n * ReelScribe API client.\n *\n * @example\n * ```ts\n * const rs = new ReelScribe('rs_your_api_key')\n * const { requestId } = await rs.transcribe({ url: 'https://www.instagram.com/reel/ABC123/' })\n * const result = await rs.getTranscription({ requestId })\n * ```\n *\n * @see https://www.reelscribe.app/api — full API documentation\n */\nexport class ReelScribe {\n  private readonly apiKey: string\n  private readonly baseUrl: string\n  private readonly _fetch: typeof globalThis.fetch\n\n  constructor(apiKey: string, options?: ReelScribeOptions) {\n    if (!apiKey) throw new Error('An API key is required. Get one at https://www.reelscribe.app/api')\n    this.apiKey = apiKey\n    this.baseUrl = (options?.baseUrl ?? DEFAULT_BASE_URL).replace(/\\/+$/, '')\n    this._fetch = options?.fetch ?? globalThis.fetch\n  }\n\n  // -------------------------------------------------------------------------\n  // Internal helpers\n  // -------------------------------------------------------------------------\n\n  private async request<T>(method: string, path: string, body?: unknown): Promise<T> {\n    const url = `${this.baseUrl}/v1/${path}`\n    const headers: Record<string, string> = {\n      Authorization: `Bearer ${this.apiKey}`,\n      'Content-Type': 'application/json',\n    }\n\n    const res = await this._fetch(url, {\n      method,\n      headers,\n      body: body ? JSON.stringify(body) : undefined,\n    })\n\n    const json = await res.json()\n\n    if (!res.ok) {\n      throw new ReelScribeError(json.error ?? { code: 'UNKNOWN', message: res.statusText, status: res.status })\n    }\n\n    return json as T\n  }\n\n  // -------------------------------------------------------------------------\n  // Public methods\n  // -------------------------------------------------------------------------\n\n  /**\n   * Submit a video URL for transcription. Costs 1 credit.\n   *\n   * If the video was already transcribed, returns a `DuplicateResult` instead.\n   *\n   * @see https://www.reelscribe.app/api — POST /v1/transcribe\n   */\n  async transcribe(options: TranscribeOptions): Promise<TranscribeResult | DuplicateResult> {\n    return this.request('POST', 'transcribe', options)\n  }\n\n  /**\n   * Fetch a single transcription by Convex document ID or requestId.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/transcriptions?id=...\n   */\n  async getTranscription(options: GetTranscriptionOptions): Promise<Transcription> {\n    const params = new URLSearchParams()\n    if (options.id) params.set('id', options.id)\n    if (options.requestId) params.set('requestId', options.requestId)\n    return this.request('GET', `transcriptions?${params}`)\n  }\n\n  /**\n   * List all your transcriptions, optionally filtered by status.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/transcriptions\n   */\n  async listTranscriptions(options?: ListTranscriptionsOptions): Promise<TranscriptionList> {\n    const params = new URLSearchParams()\n    if (options?.status) params.set('status', options.status)\n    const qs = params.toString()\n    return this.request('GET', `transcriptions${qs ? `?${qs}` : ''}`)\n  }\n\n  /**\n   * Check your credit balance, subscription tier, and storage usage.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/credits\n   */\n  async getCredits(): Promise<Credits> {\n    return this.request('GET', 'credits')\n  }\n\n  /**\n   * Get your current settings.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/settings\n   */\n  async getSettings(): Promise<Settings> {\n    return this.request('GET', 'settings')\n  }\n\n  /**\n   * Update your settings (e.g. auto-prune storage).\n   *\n   * @see https://www.reelscribe.app/api — PATCH /v1/settings\n   */\n  async updateSettings(options: UpdateSettingsOptions): Promise<Settings> {\n    return this.request('PATCH', 'settings', options)\n  }\n\n  /**\n   * Check whether the API is healthy. Does not require authentication.\n   *\n   * @see https://www.reelscribe.app/api — GET /v1/health\n   */\n  async health(): Promise<HealthCheck> {\n    const res = await this._fetch(`${this.baseUrl}/v1/health`)\n    return res.json()\n  }\n}\n"],"mappings":";AAKO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EAMzC,YAAY,MAAoB;AAC9B,UAAM,KAAK,OAAO;AAClB,SAAK,OAAO;AACZ,SAAK,OAAO,KAAK;AACjB,SAAK,SAAS,KAAK;AAAA,EACrB;AACF;;;ACDA,IAAM,mBAAmB;AAclB,IAAM,aAAN,MAAiB;AAAA,EAKtB,YAAY,QAAgB,SAA6B;AACvD,QAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,mEAAmE;AAChG,SAAK,SAAS;AACd,SAAK,WAAW,SAAS,WAAW,kBAAkB,QAAQ,QAAQ,EAAE;AACxE,SAAK,SAAS,SAAS,SAAS,WAAW;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAMA,MAAc,QAAW,QAAgB,MAAc,MAA4B;AACjF,UAAM,MAAM,GAAG,KAAK,OAAO,OAAO,IAAI;AACtC,UAAM,UAAkC;AAAA,MACtC,eAAe,UAAU,KAAK,MAAM;AAAA,MACpC,gBAAgB;AAAA,IAClB;AAEA,UAAM,MAAM,MAAM,KAAK,OAAO,KAAK;AAAA,MACjC;AAAA,MACA;AAAA,MACA,MAAM,OAAO,KAAK,UAAU,IAAI,IAAI;AAAA,IACtC,CAAC;AAED,UAAM,OAAO,MAAM,IAAI,KAAK;AAE5B,QAAI,CAAC,IAAI,IAAI;AACX,YAAM,IAAI,gBAAgB,KAAK,SAAS,EAAE,MAAM,WAAW,SAAS,IAAI,YAAY,QAAQ,IAAI,OAAO,CAAC;AAAA,IAC1G;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,WAAW,SAAyE;AACxF,WAAO,KAAK,QAAQ,QAAQ,cAAc,OAAO;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,iBAAiB,SAA0D;AAC/E,UAAM,SAAS,IAAI,gBAAgB;AACnC,QAAI,QAAQ,GAAI,QAAO,IAAI,MAAM,QAAQ,EAAE;AAC3C,QAAI,QAAQ,UAAW,QAAO,IAAI,aAAa,QAAQ,SAAS;AAChE,WAAO,KAAK,QAAQ,OAAO,kBAAkB,MAAM,EAAE;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,mBAAmB,SAAiE;AACxF,UAAM,SAAS,IAAI,gBAAgB;AACnC,QAAI,SAAS,OAAQ,QAAO,IAAI,UAAU,QAAQ,MAAM;AACxD,UAAM,KAAK,OAAO,SAAS;AAC3B,WAAO,KAAK,QAAQ,OAAO,iBAAiB,KAAK,IAAI,EAAE,KAAK,EAAE,EAAE;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAA+B;AACnC,WAAO,KAAK,QAAQ,OAAO,SAAS;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAiC;AACrC,WAAO,KAAK,QAAQ,OAAO,UAAU;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,eAAe,SAAmD;AACtE,WAAO,KAAK,QAAQ,SAAS,YAAY,OAAO;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,SAA+B;AACnC,UAAM,MAAM,MAAM,KAAK,OAAO,GAAG,KAAK,OAAO,YAAY;AACzD,WAAO,IAAI,KAAK;AAAA,EAClB;AACF;","names":[]}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "reelscribe",
+  "version": "1.0.0",
+  "description": "Official Node.js/TypeScript SDK for the ReelScribe API — transcribe Instagram Reels, TikTok videos, and YouTube shorts programmatically.",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "reelscribe",
+    "transcription",
+    "instagram",
+    "tiktok",
+    "youtube",
+    "reels",
+    "shorts",
+    "video",
+    "api",
+    "sdk",
+    "speech-to-text"
+  ],
+  "author": "ReelScribe <support@reelscribe.app>",
+  "license": "MIT",
+  "homepage": "https://www.reelscribe.app",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rara-cyber/reelscribe-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rara-cyber/reelscribe-js/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0"
+  }
+}