transcriptyt 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TranscriptYT
+
+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

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# transcriptyt
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+JavaScript/TypeScript client for the [TranscriptYT YouTube Transcript API](https://transcript-yt.com). Zero dependencies; works in Node.js 18+, Bun, Deno, and edge runtimes.
+
+```bash
+npm install transcriptyt
+```
+
+```js
+import { TranscriptYT, TranscriptYTError } from "transcriptyt";
+
+const client = new TranscriptYT({ apiKey: process.env.TRANSCRIPTYT_API_KEY });
+
+// Timestamped JSON (default)
+const t = await client.getTranscript("https://youtu.be/dQw4w9WgXcQ");
+t.segments; // [{ start, duration, text }, ...]
+
+// Files: "text" | "srt" | "vtt" | "csv" | "md" return a string
+const srt = await client.getTranscript("dQw4w9WgXcQ", { format: "srt" });
+
+// Translate (150+ languages), merge cues into paragraphs, add timestamps
+const md = await client.getTranscript("dQw4w9WgXcQ", { translateTo: "es", format: "md", paragraphs: true, timestamps: true });
+
+// Free calls
+await client.listLanguages("dQw4w9WgXcQ");
+await client.getUsage();
+
+try {
+  await client.getTranscript("not-a-video");
+} catch (e) {
+  if (e instanceof TranscriptYTError) console.log(e.status, e.code, e.message);
+}
+```
+
+Get a free API key (100 transcripts) at [transcript-yt.com](https://transcript-yt.com/login). Docs: [transcript-yt.com/docs](https://transcript-yt.com/docs).

package/index.d.ts

@@ -0,0 +1,68 @@
+export type Format = "json" | "text" | "srt" | "vtt" | "csv" | "md";
+
+export interface Segment {
+  start: number;
+  duration: number;
+  text: string;
+}
+
+export interface Track {
+  languageCode: string;
+  languageName: string;
+  autoGenerated: boolean;
+}
+
+export interface Transcript {
+  videoId: string;
+  title: string | null;
+  author: string | null;
+  channelId: string | null;
+  durationSeconds: number;
+  language: string;
+  translated: boolean;
+  autoGenerated: boolean;
+  source: "captions" | "speech_to_text";
+  segments: Segment[];
+  text: string;
+  availableLanguages: Track[];
+}
+
+export interface TranscriptOptions {
+  /** BCP-47 code of the caption track to use. */
+  language?: string;
+  /** BCP-47 code to machine-translate into (150+ languages). */
+  translateTo?: string;
+  format?: Format;
+  /** JSON only: set false to return just the full text. */
+  includeSegments?: boolean;
+  /** Prefix lines with [HH:MM:SS] in text and md output. */
+  timestamps?: boolean;
+  /** Merge caption cues into paragraph-length segments. */
+  paragraphs?: boolean;
+}
+
+export interface Usage {
+  plan: string;
+  credits_remaining: number;
+  plan_credits: { total: number; used: number; remaining: number };
+  topup_credits: { remaining: number; grants: Array<{ remaining: number; expires_at: string }> };
+  period_resets_at: string | null;
+  rate_limit_per_minute: number;
+}
+
+export class TranscriptYTError extends Error {
+  status?: number;
+  /** e.g. INVALID_VIDEO, VIDEO_UNAVAILABLE, NO_CAPTIONS, LANGUAGE_NOT_AVAILABLE, RATE_LIMITED, BLOCKED, QUOTA_EXCEEDED */
+  code?: string;
+  body?: unknown;
+}
+
+export class TranscriptYT {
+  constructor(options?: { apiKey?: string; baseUrl?: string; fetch?: typeof fetch });
+  getTranscript(url: string, options?: TranscriptOptions & { format?: "json" }): Promise<Transcript>;
+  getTranscript(url: string, options: TranscriptOptions & { format: Exclude<Format, "json"> }): Promise<string>;
+  listLanguages(url: string): Promise<{ videoId: string; languages: Track[] }>;
+  getUsage(): Promise<Usage>;
+}
+
+export default TranscriptYT;

package/index.js

@@ -0,0 +1,69 @@
+const DEFAULT_BASE_URL = "https://transcript-yt.com";
+
+export class TranscriptYTError extends Error {
+  constructor(message, { status, code, body } = {}) {
+    super(message);
+    this.name = "TranscriptYTError";
+    this.status = status;
+    this.code = code;
+    this.body = body;
+  }
+}
+
+export class TranscriptYT {
+  constructor({ apiKey = globalThis.process?.env?.TRANSCRIPTYT_API_KEY, baseUrl = DEFAULT_BASE_URL, fetch: fetchImpl = globalThis.fetch } = {}) {
+    if (!apiKey) throw new TranscriptYTError("Missing API key. Pass { apiKey } or set TRANSCRIPTYT_API_KEY.");
+    this.apiKey = apiKey;
+    this.baseUrl = baseUrl.replace(/\/$/, "");
+    this.fetch = fetchImpl;
+  }
+
+  async #request(path, params = {}) {
+    const url = new URL(this.baseUrl + path);
+    for (const [name, value] of Object.entries(params)) {
+      if (value !== undefined && value !== null) url.searchParams.set(name, String(value));
+    }
+    const res = await this.fetch(url, { headers: { Authorization: `Bearer ${this.apiKey}` } });
+    if (res.ok) return res;
+
+    let body;
+    try {
+      body = await res.json();
+    } catch {
+      body = undefined;
+    }
+    // 402 (out of credits) uses a flat shape; every other error uses { error: { code, message } }.
+    const code = res.status === 402 ? "QUOTA_EXCEEDED" : body?.error?.code;
+    const message = res.status === 402 ? "Out of credits" : body?.error?.message ?? `HTTP ${res.status}`;
+    throw new TranscriptYTError(message, { status: res.status, code, body });
+  }
+
+  /**
+   * Fetch a transcript. Returns parsed JSON for format "json" (default), otherwise the file body as a string.
+   * @param {string} url YouTube URL or 11-character video ID
+   */
+  async getTranscript(url, { language, translateTo, format, includeSegments, timestamps, paragraphs } = {}) {
+    const res = await this.#request("/v1/transcript", {
+      url,
+      language,
+      translate_to: translateTo,
+      format,
+      includeSegments,
+      timestamps,
+      paragraphs,
+    });
+    return !format || format === "json" ? res.json() : res.text();
+  }
+
+  /** List a video's caption tracks. Free. */
+  async listLanguages(url) {
+    return (await this.#request("/v1/languages", { url })).json();
+  }
+
+  /** Plan and remaining credits. Free. */
+  async getUsage() {
+    return (await this.#request("/v1/usage")).json();
+  }
+}
+
+export default TranscriptYT;

package/package.json

@@ -1,6 +1,21 @@
 {
   "name": "transcriptyt",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "YouTube Transcript API client: get any YouTube video's transcript as JSON, text, SRT, or VTT in 150+ languages.",
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "files": ["index.js", "index.d.ts", "README.md", "LICENSE"],
+  "engines": { "node": ">=18" },
+  "keywords": ["youtube", "transcript", "youtube-transcript", "youtube-transcript-api", "captions", "subtitles", "srt", "vtt", "mcp", "llm"],
+  "homepage": "https://transcript-yt.com",
+  "repository": { "type": "git", "url": "git+https://github.com/rajdeep-automation/transcriptyt.git", "directory": "js" },
+  "bugs": "https://github.com/rajdeep-automation/transcriptyt/issues",
+  "license": "MIT"
+}