@supadata/js 1.0.0

package/README.md

@@ -0,0 +1,66 @@
+# @supadata/ts
+
+Official TypeScript/JavaScript SDK for the Supadata API.
+
+## Installation
+
+```bash
+npm install @supadata/js
+```
+
+## Usage
+
+```typescript
+import { Supadata, Transcript } from "@supadata/js";
+
+// Initialize the client
+const supadata = new Supadata({
+  apiKey: "YOUR_API_KEY",
+});
+
+// Get YouTube transcript
+const transcript = await supadata.youtube.transcript({
+  videoId: "VIDEO_ID",
+});
+
+// Translate YouTube transcript
+const translated = await supadata.youtube.translate({
+  videoId: "VIDEO_ID",
+  lang: "es",
+});
+
+// Scrape web content
+const webContent = await supadata.web.scrape("https://supadata.ai");
+
+// Map website URLs
+const siteMap = await supadata.web.map("https://supadata.ai");
+```
+
+## Error Handling
+
+The SDK throws `SupadataError` for API-related errors. You can catch and handle these errors as follows:
+
+```typescript
+import { SupadataError } from "@supadata/js";
+
+try {
+  const transcript = await supadata.youtube.transcript({
+    videoId: "INVALID_ID",
+  });
+} catch (error) {
+  if (error instanceof SupadataError) {
+    console.error(error.code); // e.g., 'video-not-found'
+    console.error(error.title); // Human readable error title
+    console.error(error.message); // Detailed error description
+    console.error(error.documentationUrl); // Link to error documentation
+  }
+}
+```
+
+## API Reference
+
+See the [Documentation](https://supadata.ai/documentation) for more details on all possible parameters and options.
+
+## License
+
+MIT

package/dist/client.d.ts

@@ -0,0 +1,12 @@
+import { SupadataConfig, Error } from "./types.js";
+export declare class BaseClient {
+    protected config: SupadataConfig;
+    constructor(config: SupadataConfig);
+    fetch<T>(endpoint: string, params: Record<string, unknown> | object): Promise<T>;
+}
+export declare class SupadataError extends Error {
+    code: Error["code"];
+    title: string;
+    documentationUrl: string;
+    constructor(error: Error);
+}

package/dist/client.js

@@ -0,0 +1,43 @@
+export class BaseClient {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    async fetch(endpoint, params) {
+        const baseUrl = this.config.baseUrl || "https://api.supadata.ai/v1";
+        let url = `${baseUrl}${endpoint.startsWith("/") ? endpoint : `/${endpoint}`}`;
+        if (params) {
+            const queryParams = new URLSearchParams();
+            Object.entries(params).forEach(([key, value]) => {
+                if (value !== undefined && value !== null) {
+                    queryParams.append(key, String(value));
+                }
+            });
+            url += `?${queryParams.toString()}`;
+        }
+        const response = await fetch(url, {
+            method: "GET",
+            headers: {
+                "x-api-key": this.config.apiKey,
+                "Content-Type": "application/json",
+            },
+        });
+        const data = await response.json();
+        if (!response.ok) {
+            const error = data;
+            throw new SupadataError(error);
+        }
+        return data;
+    }
+}
+export class SupadataError extends Error {
+    code;
+    title;
+    documentationUrl;
+    constructor(error) {
+        super(error.description);
+        this.code = error.code;
+        this.title = error.title;
+        this.documentationUrl = error.documentationUrl;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { SupadataConfig } from './types.js';
+import { YouTubeService } from './services/youtube.js';
+import { WebService } from './services/web.js';
+export * from './types.js';
+export * from './client.js';
+export * from './services/youtube.js';
+export * from './services/web.js';
+export declare class Supadata {
+    readonly youtube: YouTubeService;
+    readonly web: WebService;
+    constructor(config: SupadataConfig);
+}

package/dist/index.js

@@ -0,0 +1,14 @@
+import { YouTubeService } from './services/youtube.js';
+import { WebService } from './services/web.js';
+export * from './types.js';
+export * from './client.js';
+export * from './services/youtube.js';
+export * from './services/web.js';
+export class Supadata {
+    youtube;
+    web;
+    constructor(config) {
+        this.youtube = new YouTubeService(config);
+        this.web = new WebService(config);
+    }
+}

package/dist/services/web.d.ts

@@ -0,0 +1,6 @@
+import { BaseClient } from '../client.js';
+import { Scrape, Map } from '../types.js';
+export declare class WebService extends BaseClient {
+    scrape(url: string): Promise<Scrape>;
+    map(url: string): Promise<Map>;
+}

package/dist/services/web.js

@@ -0,0 +1,9 @@
+import { BaseClient } from '../client.js';
+export class WebService extends BaseClient {
+    async scrape(url) {
+        return this.fetch('/web/scrape', { url });
+    }
+    async map(url) {
+        return this.fetch('/web/map', { url });
+    }
+}

package/dist/services/youtube.d.ts

@@ -0,0 +1,14 @@
+import { BaseClient } from "../client.js";
+import { Transcript, TranslatedTranscript } from "../types.js";
+export interface TranscriptParams {
+    videoId: string;
+    lang?: string;
+    text?: boolean;
+}
+export interface TranslateParams extends TranscriptParams {
+    lang: string;
+}
+export declare class YouTubeService extends BaseClient {
+    transcript(params: TranscriptParams): Promise<Transcript>;
+    translate(params: TranslateParams): Promise<TranslatedTranscript>;
+}

package/dist/services/youtube.js

@@ -0,0 +1,9 @@
+import { BaseClient } from "../client.js";
+export class YouTubeService extends BaseClient {
+    async transcript(params) {
+        return this.fetch("/youtube/transcript", params);
+    }
+    async translate(params) {
+        return this.fetch("/youtube/transcript/translate", params);
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,37 @@
+export interface TranscriptChunk {
+    text: string;
+    offset: number;
+    duration: number;
+    lang: string;
+}
+export interface Transcript {
+    content: TranscriptChunk[] | string;
+    lang: string;
+    availableLangs: string[];
+}
+export interface TranslatedTranscript {
+    content: TranscriptChunk[] | string;
+    lang: string;
+}
+export interface Scrape {
+    url: string;
+    content: string;
+    name: string;
+    description: string;
+    ogUrl: string;
+    countCharacters: number;
+    urls: string[];
+}
+export interface Map {
+    urls: string[];
+}
+export interface SupadataConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+export interface Error {
+    code: 'invalid-request' | 'missing-parameters' | 'internal-error' | 'transcript-unavailable' | 'video-not-found' | 'video-id-invalid' | 'youtube-api-error' | 'quota-exceeded' | 'rate-limit-exceeded';
+    title: string;
+    description: string;
+    documentationUrl: string;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@supadata/js",
+  "version": "1.0.0",
+  "description": "TypeScript / JavaScript SDK for Supadata API",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "prepare": "npm run build",
+    "format": "prettier --write \"src/**/*.{js,ts}\"",
+    "format:check": "prettier --check \"src/**/*.{js,ts}\""
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "supadata",
+    "api",
+    "sdk",
+    "typescript",
+    "youtube",
+    "transcript",
+    "web scraping"
+  ],
+  "author": "Supadata AI",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.10",
+    "jest": "^29.7.0",
+    "jest-fetch-mock": "^3.0.3",
+    "prettier": "^3.4.2",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
+  }
+}