wyzie-lib 2.1.5 → 2.1.7

package/README.md

@@ -1,4 +1,9 @@
-# Wyzie Lib
+<p align="center">
+  <a href="https://sub.wyzie.ru/">
+    <img src="https://i.postimg.cc/L5ppKYC5/cclogo.png" height="120">
+    <h1 align="center">Wyzie Lib</h1>
+  </a>
+</p>
 
 Wyzie Lib is a package made for easily implementing [Wyzie Subs](https://sub.wyzie.ru) into your
 project without all the fuss. [Read our source code!](https://github.com/itzcozi/wyzie-lib)
@@ -7,8 +12,8 @@ project without all the fuss. [Read our source code!](https://github.com/itzcozi
 
 ## Features
 
-- **Simple**: Just one function for searching subtitles using Wyzie Subs API.
 - **Fast**: This package was written in Vite with TypeScript, so it's fast and reliable.
+- **Simple**: Just one function for searching subtitles using Wyzie Subs API.
 - **VTT Parser**: Convert SRT subtitles to VTT format quickly.
 - **Open-Source**: The API and package are open-source.
 
@@ -38,17 +43,16 @@ yarn add wyzie-lib
 import { type SubtitleData, searchSubtitles, parseToVTT } from "wyzie-lib";
 
 // Fetches all subtitles for the media with the TMDB ID 286217
-// -----------------------------------------------------------
 const data: SubtitleData[] = await searchSubtitles({ tmdb_id: 286217, format: "srt" });
 console.log(data[0].id); // Prints the ID of the first subtitle object
 
 // Converts the first subtitle from SRT to VTT format
-// --------------------------------------------------
 const vttContent = await parseToVTT(data[0].url); // Passes the first subtitle URL
 console.log(vttContent); // Prints the raw VTT content
 ```
 
-Check out [demo.html](https://raw.githubusercontent.com/itzCozi/wyzie-lib/refs/heads/main/demo.html) for a working example using the VTT parser.
+Check out [demo.html](https://raw.githubusercontent.com/itzCozi/wyzie-lib/refs/heads/main/demo.html)
+for a working example using the VTT parser.
 
 ### Parameters
 
@@ -68,6 +72,10 @@ Check out [demo.html](https://raw.githubusercontent.com/itzCozi/wyzie-lib/refs/h
 - **QueryParams**: All parameters (optional and required) available for the wyzie-subs API.
 - **SubtitleData**: All returned values from the API with their respective types.
 
+![SearchSubtitlesParams](https://i.postimg.cc/yYZVMzH0/searchsubparam.png)
+![QueryParams](https://i.postimg.cc/v8SrP5Yc/Screenshot-2025-01-13-8-40-11-AM.png)
+![SubtitleData](https://i.postimg.cc/6QdCb8xP/subdata.png)
+
 <hr />
 
 <sup>

package/lib/main.amd.js

@@ -0,0 +1,88 @@
+define(["exports"], function(exports) {
+  "use strict";
+  async function constructUrl({
+    tmdb_id,
+    imdb_id,
+    season,
+    episode,
+    encoding,
+    language,
+    format,
+    hi
+  }) {
+    const url = new URL("https://sub.wyzie.ru/search");
+    const queryParams = {
+      id: String(tmdb_id || imdb_id),
+      season,
+      episode,
+      encoding,
+      language,
+      format,
+      hi
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+      if (value !== void 0) {
+        url.searchParams.append(key, String(value));
+      }
+    });
+    return url;
+  }
+  async function fetchSubtitles(url) {
+    const response = await fetch(url.toString());
+    if (!response.ok) {
+      throw new Error(`HTTP error! status: ${response.status}`);
+    }
+    return response.json();
+  }
+  async function searchSubtitles(params) {
+    try {
+      const url = await constructUrl(params);
+      return await fetchSubtitles(url);
+    } catch (error) {
+      throw new Error(`Error fetching subtitles: ${error}`);
+    }
+  }
+  async function parseToVTT(subtitleUrl) {
+    try {
+      const response = await fetch(subtitleUrl);
+      if (!response.ok) {
+        throw new Error(`Failed to fetch subtitle content: ${response.status}`);
+      }
+      const content = await response.text();
+      const normalizedContent = content.replace(/\r\n|\r/g, "\n").trim();
+      const blocks = normalizedContent.split(/\n\n+/);
+      const timestampRegex = /^\d{1,2}:\d{2}:\d{2}[,.]\d{3}\s*-->\s*\d{1,2}:\d{2}:\d{2}[,.]\d{3}$/;
+      const hasValidSRTFormat = blocks.some((block) => {
+        const lines = block.split("\n").map((line) => line.trim());
+        return lines.some((line) => timestampRegex.test(line));
+      });
+      if (!hasValidSRTFormat) {
+        throw new Error("Invalid subtitle format: not SRT");
+      }
+      const vttLines = ["WEBVTT", ""];
+      for (const block of blocks) {
+        const lines = block.split("\n").map((line) => line.trim()).filter((line) => line.length > 0);
+        if (lines.length < 2)
+          continue;
+        const timestampIndex = lines.findIndex((line) => timestampRegex.test(line));
+        if (timestampIndex === -1)
+          continue;
+        const textLines = lines.slice(timestampIndex + 1).filter((line) => !/^\d+$/.test(line));
+        if (textLines.length === 0)
+          continue;
+        let timestampLine = lines[timestampIndex];
+        timestampLine = timestampLine.replace(/[,.](?=\s*-->)/, "").replace(/[,.]$/, "").replace(/,(\d{3})/g, ".$1");
+        vttLines.push(`${timestampLine}
+${textLines.join("\n")}
+`);
+      }
+      return vttLines.join("\n").replace(/\n{3,}/g, "\n\n").trim() + "\n\n";
+    } catch (error) {
+      console.error("Error in parseToVTT:", error);
+      throw error;
+    }
+  }
+  exports.parseToVTT = parseToVTT;
+  exports.searchSubtitles = searchSubtitles;
+  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+});

package/lib/main.cjs

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+async function constructUrl({
+  tmdb_id,
+  imdb_id,
+  season,
+  episode,
+  encoding,
+  language,
+  format,
+  hi
+}) {
+  const url = new URL("https://sub.wyzie.ru/search");
+  const queryParams = {
+    id: String(tmdb_id || imdb_id),
+    season,
+    episode,
+    encoding,
+    language,
+    format,
+    hi
+  };
+  Object.entries(queryParams).forEach(([key, value]) => {
+    if (value !== void 0) {
+      url.searchParams.append(key, String(value));
+    }
+  });
+  return url;
+}
+async function fetchSubtitles(url) {
+  const response = await fetch(url.toString());
+  if (!response.ok) {
+    throw new Error(`HTTP error! status: ${response.status}`);
+  }
+  return response.json();
+}
+async function searchSubtitles(params) {
+  try {
+    const url = await constructUrl(params);
+    return await fetchSubtitles(url);
+  } catch (error) {
+    throw new Error(`Error fetching subtitles: ${error}`);
+  }
+}
+async function parseToVTT(subtitleUrl) {
+  try {
+    const response = await fetch(subtitleUrl);
+    if (!response.ok) {
+      throw new Error(`Failed to fetch subtitle content: ${response.status}`);
+    }
+    const content = await response.text();
+    const normalizedContent = content.replace(/\r\n|\r/g, "\n").trim();
+    const blocks = normalizedContent.split(/\n\n+/);
+    const timestampRegex = /^\d{1,2}:\d{2}:\d{2}[,.]\d{3}\s*-->\s*\d{1,2}:\d{2}:\d{2}[,.]\d{3}$/;
+    const hasValidSRTFormat = blocks.some((block) => {
+      const lines = block.split("\n").map((line) => line.trim());
+      return lines.some((line) => timestampRegex.test(line));
+    });
+    if (!hasValidSRTFormat) {
+      throw new Error("Invalid subtitle format: not SRT");
+    }
+    const vttLines = ["WEBVTT", ""];
+    for (const block of blocks) {
+      const lines = block.split("\n").map((line) => line.trim()).filter((line) => line.length > 0);
+      if (lines.length < 2)
+        continue;
+      const timestampIndex = lines.findIndex((line) => timestampRegex.test(line));
+      if (timestampIndex === -1)
+        continue;
+      const textLines = lines.slice(timestampIndex + 1).filter((line) => !/^\d+$/.test(line));
+      if (textLines.length === 0)
+        continue;
+      let timestampLine = lines[timestampIndex];
+      timestampLine = timestampLine.replace(/[,.](?=\s*-->)/, "").replace(/[,.]$/, "").replace(/,(\d{3})/g, ".$1");
+      vttLines.push(`${timestampLine}
+${textLines.join("\n")}
+`);
+    }
+    return vttLines.join("\n").replace(/\n{3,}/g, "\n\n").trim() + "\n\n";
+  } catch (error) {
+    console.error("Error in parseToVTT:", error);
+    throw error;
+  }
+}
+exports.parseToVTT = parseToVTT;
+exports.searchSubtitles = searchSubtitles;

package/lib/main.d.ts

@@ -1,42 +1,97 @@
+/**
+ * Parses subtitle content from a URL to VTT format.
+ *
+ * @param {string} subtitleUrl - The URL of the subtitle to parse.
+ * @returns {Promise<string>} A promise that resolves to the subtitle content in VTT format.
+ * @throws {Error} Throws an error if fetching or parsing the subtitle content fails.
+ */
 export declare function parseToVTT(subtitleUrl: string): Promise<string>;
 
+/**
+ * Parameters used to construct the URL for subtitle search (requires an ID).
+ */
 export declare type QueryParams = {
+    /** Unique identifier (either TMDB or IMDB ID). */
     id: string;
+    /** Season number if the content is a series. */
     season?: number;
+    /** Episode number if the content is a series. */
     episode?: number;
+    /** Encoding of the subtitle files. */
+    encoding?: string;
+    /** ISO 3166 code of the subtitle desired. */
     language?: string;
+    /** Which subtitle file format you want */
     format?: string;
+    /** Determines if you get a hearing impaired subtitles */
     hi?: boolean;
 };
 
+/**
+ * Searches for subtitles based on the provided parameters.
+ *
+ * @param {SearchSubtitlesParams} params - The parameters for searching: SearchSubtitlesParams.
+ * @returns {Promise<SubtitleData[]>} A promise that resolves to an array of subtitle data.
+ * @throws {Error} Throws an error if fetching subtitles fails or something goes wrong.
+ */
 export declare function searchSubtitles(params: SearchSubtitlesParams): Promise<SubtitleData[]>;
 
-export declare type SearchSubtitlesParams = ({
+/**
+ * Parameters for searching subtitles.
+ * Either IMDB or TMDB ID is required and if episode is provided, season is also required.
+ */
+export declare type SearchSubtitlesParams = (
+/** The TMDB ID of the media you want subtitles for (either TMDB or IMDB ID). */
+    {
     tmdb_id: number;
     imdb_id?: never;
-} | {
+}
+/** The IMDB ID of the media you want subtitles for (either TMDB or IMDB ID). */
+| {
     imdb_id: string;
     tmdb_id?: never;
 }) & {
+    /** ISO 3166 code of the subtitle desired. */
     language?: string;
+    /** The subtitle file's encoding (UTF-8, ASCII)   */
+    encoding?: string;
+    /** Which subtitle file format you want. */
     format?: string;
+    /** Determines if you get hearing impaired subtitles. */
     hi?: boolean;
-} & ({
+} & (
+/** The number of the desired season you want subtitles for. */
+    {
     season: number;
     episode: number;
-} | {
+}
+/** The number of the desired episode you want subtitles for. */
+| {
     season?: never;
     episode?: never;
 });
 
+/**
+ * Data structure representing a single subtitle object.
+ */
 export declare type SubtitleData = {
+    /** Unique identifier (either TMDB or IMDB ID). */
     id: string;
+    /** The subtitle file's URL. */
     url: string;
+    /** The format of the subtitle file. */
     format: string;
+    /** The encoding of the subtitle files. (UTF-8, ASCII, ETC) */
+    encoding: string;
+    /** Boolean indicating if the subtitle's is hearing impaired. */
     isHearingImpaired: boolean;
+    /** URL to a PNG of the flag of the subtitle's language. */
     flagUrl: string;
+    /** The name/title of the media. */
     media: string;
+    /** The display language; Example: English. */
     display: string;
+    /** ISO 3166 code; Example: en (2 alphabetic letters). */
     language: string;
 };
 

package/lib/main.iife.js

@@ -0,0 +1,89 @@
+var main = function(exports) {
+  "use strict";
+  async function constructUrl({
+    tmdb_id,
+    imdb_id,
+    season,
+    episode,
+    encoding,
+    language,
+    format,
+    hi
+  }) {
+    const url = new URL("https://sub.wyzie.ru/search");
+    const queryParams = {
+      id: String(tmdb_id || imdb_id),
+      season,
+      episode,
+      encoding,
+      language,
+      format,
+      hi
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+      if (value !== void 0) {
+        url.searchParams.append(key, String(value));
+      }
+    });
+    return url;
+  }
+  async function fetchSubtitles(url) {
+    const response = await fetch(url.toString());
+    if (!response.ok) {
+      throw new Error(`HTTP error! status: ${response.status}`);
+    }
+    return response.json();
+  }
+  async function searchSubtitles(params) {
+    try {
+      const url = await constructUrl(params);
+      return await fetchSubtitles(url);
+    } catch (error) {
+      throw new Error(`Error fetching subtitles: ${error}`);
+    }
+  }
+  async function parseToVTT(subtitleUrl) {
+    try {
+      const response = await fetch(subtitleUrl);
+      if (!response.ok) {
+        throw new Error(`Failed to fetch subtitle content: ${response.status}`);
+      }
+      const content = await response.text();
+      const normalizedContent = content.replace(/\r\n|\r/g, "\n").trim();
+      const blocks = normalizedContent.split(/\n\n+/);
+      const timestampRegex = /^\d{1,2}:\d{2}:\d{2}[,.]\d{3}\s*-->\s*\d{1,2}:\d{2}:\d{2}[,.]\d{3}$/;
+      const hasValidSRTFormat = blocks.some((block) => {
+        const lines = block.split("\n").map((line) => line.trim());
+        return lines.some((line) => timestampRegex.test(line));
+      });
+      if (!hasValidSRTFormat) {
+        throw new Error("Invalid subtitle format: not SRT");
+      }
+      const vttLines = ["WEBVTT", ""];
+      for (const block of blocks) {
+        const lines = block.split("\n").map((line) => line.trim()).filter((line) => line.length > 0);
+        if (lines.length < 2)
+          continue;
+        const timestampIndex = lines.findIndex((line) => timestampRegex.test(line));
+        if (timestampIndex === -1)
+          continue;
+        const textLines = lines.slice(timestampIndex + 1).filter((line) => !/^\d+$/.test(line));
+        if (textLines.length === 0)
+          continue;
+        let timestampLine = lines[timestampIndex];
+        timestampLine = timestampLine.replace(/[,.](?=\s*-->)/, "").replace(/[,.]$/, "").replace(/,(\d{3})/g, ".$1");
+        vttLines.push(`${timestampLine}
+${textLines.join("\n")}
+`);
+      }
+      return vttLines.join("\n").replace(/\n{3,}/g, "\n\n").trim() + "\n\n";
+    } catch (error) {
+      console.error("Error in parseToVTT:", error);
+      throw error;
+    }
+  }
+  exports.parseToVTT = parseToVTT;
+  exports.searchSubtitles = searchSubtitles;
+  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+  return exports;
+}({});

package/lib/main.js

@@ -3,6 +3,7 @@ async function constructUrl({
   imdb_id,
   season,
   episode,
+  encoding,
   language,
   format,
   hi
@@ -12,6 +13,7 @@ async function constructUrl({
     id: String(tmdb_id || imdb_id),
     season,
     episode,
+    encoding,
     language,
     format,
     hi

package/lib/main.umd.cjs

@@ -7,6 +7,7 @@
     imdb_id,
     season,
     episode,
+    encoding,
     language,
     format,
     hi
@@ -16,6 +17,7 @@
       id: String(tmdb_id || imdb_id),
       season,
       episode,
+      encoding,
       language,
       format,
       hi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wyzie-lib",
-  "version": "2.1.5",
+  "version": "2.1.7",
   "icon": "https://i.postimg.cc/L5ppKYC5/cclogo.png",
   "license": "MIT",
   "keywords": [
@@ -31,6 +31,26 @@
       "require": {
         "types": "./lib/main.d.ts",
         "default": "./lib/main.umd.cjs"
+      },
+      "umd": {
+        "types": "./lib/main.d.ts",
+        "default": "./lib/main.umd.js"
+      },
+      "es": {
+        "types": "./lib/main.d.ts",
+        "default": "./lib/main.es.js"
+      },
+      "cjs": {
+        "types": "./lib/main.d.ts",
+        "default": "./lib/main.cjs.js"
+      },
+      "iife": {
+        "types": "./lib/main.d.ts",
+        "default": "./lib/main.iife.js"
+      },
+      "amd": {
+        "types": "./lib/main.d.ts",
+        "default": "./lib/main.amd.js"
       }
     }
   },
@@ -38,18 +58,17 @@
     "type": "git",
     "url": "git+https://github.com/itzcozi/wyzie-lib.git"
   },
-  "devDependencies": {
-    "prettier": "^3.4.2",
-    "typescript": "^5.7.3",
-    "vite": "^4.5.5",
-    "vite-plugin-dts": "^4.5.0",
-    "vitest": "^2.1.8"
-  },
   "scripts": {
-    "dev": "vite",
     "build": "vite build && tsc",
     "test": "npx vitest",
     "format": "prettier --log-level warn --write \"{src/**/*.{ts},*.{ts,js,html,css,json,md,xml}}\"",
     "preview": "vite preview"
+  },
+  "devDependencies": {
+    "prettier": "^3.5.1",
+    "typescript": "^5.7.3",
+    "vite": "^4.5.9",
+    "vite-plugin-dts": "^4.5.0",
+    "vitest": "^2.1.9"
   }
-}
+}