@vyla-entertainment/sdk 1.0.0 → 1.4.0

package/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish npm package
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - run: npm ci
+
+      - name: Bump version
+        run: |
+          npm version minor
+          git push --follow-tags
+
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_KEY }}

package/README.md

@@ -40,5 +40,22 @@ await sdk.probeAllSources(); -> {'key': {ok, ms}, ...}
 
 // Get HLS streams
 // Args: source key, tmdb id, season?, episode?, clientIP?
-await sdk.getStream('nebula', '0000000', null, null, null) -> {allUrls: {url, quality, label, ...}[]}
-```
+await sdk.getStream('nebula', '0000000', null, null, null) -> {allUrls: {url, quality, label?, server?, type?, skipProxy?, skipVerify?, headers? ...}[]}
+```
+
+# [DMCA](https://docs.vyla.cc/misc/dmca)
+
+If your source is listed here, I sincerely apologize. I understand that its inclusion may be costing you a lot of money, and that was never my intention. Please contact me as soon as possible, and I'll remove it ASAP.
+
+This is a small hobby project that I built for learning and personal interest, not for profit. I genuinely want to respect the wishes of source owners and will address any removal requests as quickly as I can.
+
+This project is developed and maintained by [Vyla Entertainment](https://github.com/vyla-entertainment) (@vyla-entertainment).
+
+Original work and core authorship:
+
+[@endoverdosing](https://github.com/EndOverdosing)
+
+[@GavinGoGaming](https://github.com/GavinGoGaming)
+
+Full credits and acknowledgements:
+https://docs.vyla.cc/misc/credit

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vyla-entertainment/sdk",
-  "version": "1.0.0",
+  "version": "1.4.0",
   "scripts": {
     "test": "node test/index.js"
   },
@@ -18,6 +18,7 @@
   "type": "module",
   "description": "Vyla's multi-provider stream scraper SDK",
   "main": "src/sdk.js",
+  "types": "src/sdk.d.ts",
   "directories": {
     "test": "test"
   },
@@ -28,4 +29,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/sdk.d.ts

@@ -0,0 +1,123 @@
+export interface SourceConfig {
+    key: string;
+    label: string;
+    sourceFile: string;
+    proxyParam: string;
+    timeout: number;
+    jitter: number;
+    retries: number;
+    multiUrl: boolean;
+    skipProxy?: boolean;
+    cdnHeaders?: {
+        pattern: RegExp;
+        headers: {
+            Referer: string;
+            Origin: string;
+        };
+    }[];
+    skipVerify?: boolean;
+    verifyHeaders?: boolean;
+    disabled?: boolean;
+    sourcesTimeout?: number;
+}
+export interface ProbeResult {
+    ok: boolean;
+    ms: number | null;
+}
+export interface StreamResult {
+    url: string;
+    headers: {
+        "User-Agent": string;
+        Referer: string;
+        Origin: string;
+        [key: string]: string;
+    };
+    server: string;
+    quality: string;
+    type: "mp4" | "hls";
+    skipVerify?: boolean;
+    skipProxy?: boolean;
+}
+
+export interface DownloadResult {
+    url: string;
+    quality: string;
+    size: number | null;
+    type: "mkv";
+    active: boolean;
+}
+export interface SubtitleResult {
+    label: string;
+    file: string;
+    type: "vtt" | "srt";
+    source: string;
+}
+
+export type ProbeAllResult = Record<string, ProbeResult>;
+
+export interface VylaSDKOptions {
+    tmdbApiKey?: string;
+}
+
+// Descriptions written with Claude.
+export default class VylaSDK {
+    tmdbApiKey?: string;
+
+    constructor(options?: VylaSDKOptions);
+
+    /**
+     * Get the list of configured sources.
+     * @param excludeDisabled If true, filters out disabled sources.
+     */
+    getSources(excludeDisabled?: boolean): SourceConfig[];
+
+    /**
+     * Probe all active (non-disabled) sources for availability.
+     */
+    probeAllSources(): Promise<ProbeAllResult>;
+
+    /**
+     * Probe a single source by key.
+     */
+    probeSource(key: string): Promise<ProbeResult>;
+
+    /**
+     * Get a playable stream for a given source/media id.
+     * @param key Source key
+     * @param id Media id (e.g. TMDB id)
+     * @param s Season number (for TV), or null for movies
+     * @param e Episode number (for TV), or null for movies
+     * @param clientIP Optional client IP for source-specific logic
+     */
+    getStream(
+        key: string,
+        id: string | number,
+        s?: number | null,
+        e?: number | null,
+        clientIP?: string | null
+    ): Promise<StreamResult>;
+
+    /**
+     * Get subtitles for a movie or TV episode.
+     * @param id Media id
+     * @param s Season number (for TV), or null for movies
+     * @param e Episode number (for TV), or null for movies
+     */
+    getSubtitles(
+        id: string | number,
+        s?: number | null,
+        e?: number | null
+    ): Promise<SubtitleResult[]>;
+
+    /**
+     * Get download links for a movie or TV episode.
+     * @param id Media id
+     * @param s Season number (for TV), or null for movies
+     * @param e Episode number (for TV), or null for movies
+     */
+    getDownloads(
+        id: string | number,
+        s?: number | null,
+        e?: number | null
+    ): Promise<DownloadResult[]>;
+}