wyzie-lib 1.0.5 → 2.0.1

package/README.md

@@ -1,12 +1,9 @@
-<p align="center">
-  <a href="https://www.npmjs.com/package/wyzie-lib">
-    <img src="https://i.postimg.cc/L5ppKYC5/cclogo.png" height="120">
-    <h1 align="center">Wyzie Lib</h1>
-  </a>
-</p>
+# Wyzie Lib
 
 Wyzie Lib is a package made for easily implementing [Wyzie Subs](https://subs.wyzie.ru) into your project without all the fuss.
 
+<sup>2.0 Out Now!</sup>
+
 ## 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.
@@ -21,23 +18,63 @@ npm install wyzie-lib
 ```bash
 pnpm install wyzie-lib
 ```
+### Yarn
+```bash
+yarn add wyzie-lib
+```
+
+## Parameters
+- **tmdb_id**: The TMDB ID of the movie or TV show. *(tmdb_id or imdb_id is required)*
+- **imdb_id**: The IMDB ID of the movie or TV show. *(imdb_id or tmdb_id is required)*
+- **type**: The file format of the subtitles returned. *(srt, ass, vtt, txt, sub, mpl, webvtt, dfxp)*
+- **season**: Disired season of subtites *(this requires episode parameter aswell)*
+- **episode**: The episode of the given season.
+- **language**: The ISO 3166 code of the provided subtitles.
+- **display**: The actual name of the language capitalized.
+- **isHearingImpaired**: A boolean indicating if the subtitles are hearing impaired.
 
 ## Usage
 ```ts
 import { type SubtitleData, searchSubtitles } from "wyzie-lib";
 
-const data: SubtitleData[] = await searchSubtitles({ tmdb_id: 286217, language: "en" });
-console.log(data[0].id);
+// IMDB is faster then TMDB due to less API calls behind the scenes
+const data: SubtitleData[] = await searchSubtitles({ tmdb_id: 286217 });
+console.log(data[0].id); // Prints the ID of the first subtitle provided in the search
 ```
-or
+### Types
+- **SubtitleData**: All returned values from the API with their respective types.
+- **SearchSubtitlesParams**: All valid parameters recognized by the API.
+- **QueryParams**: All parameters (optional and required) available for the wyzie-subs API. 
 ```ts
-import wyzieLib from "wyzie-lib";
+interface SearchSubtitlesParams {  // Parameters for the searchSubtitles() function
+  tmdb_id?: number;           // Parsed automatically by the API to recognize if its TMDB or IMDB
+  imdb_id?: number;           // Parsed automatically by the API to recognize if its TMDB or IMDB
+  season?: number;
+  episode?: number;           // Season is required if episode is provided
+  language?: string;          // ISO 3166 code
+  type?: string;              // Subtitle file format
+}
+
+interface QueryParams {  // Parameters for the wyzie-subs API
+  id: string;                 // (Required) The TMDB or IMDB ID of the movie or TV show
+  season?: number;            // The season of the TV show (Required if episode is provided)
+  episode?: number;           // The episode of the TV show (Required if season is provided)
+  language?: string;          // ISO 3166 code
+  type?: string;              // Subtitle file format
+}
 
-const { searchSubtitles } = wyzieLib;
-const data = await searchSubtitles({ tmdb_id: 286217, language: "en" });
-console.log(data[0].id);
+type SubtitleData = {  // Data returned by the API
+  id: string;                 // Unique ID of the subtitle from opensubtitles
+  url: string;                // Direct download link of the subtitle
+  type: string;               // Subtitle file format
+  isHearingImpaired: boolean; // If the subtitle is hearing impaired
+  flagUrl: string;            // Flag of the language
+  display: string;            // Actual name of the language
+  language: string;           // ISO 3166 code
+};
 ```
 
+<hr />
 
 <sup>
   Created by <a href="https://github.com/itzcozi" alt="github" title="itzCozi on Github">BadDeveloper</a> with 💙

package/dist/wyzie-lib.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});async function h({tmdb_id:r,imdb_id:t,season:n,episode:c,language:o,type:a}){const e=new URL("https://subs.wyzie.ru/search"),i={id:String(r||t),season:n,episode:c,language:o,type:a};return Object.entries(i).forEach(([u,s])=>{s!==void 0&&e.searchParams.append(u,s)}),e}async function f(r){const t=await fetch(r.toString());if(!t.ok)throw new Error(`HTTP error! status: ${t.status}`);return t.json()}async function l(r){try{const t=await h(r);return await f(t)}catch(t){throw new Error(`Error fetching subtitles: ${t}`)}}exports.searchSubtitles=l;

package/dist/wyzie-lib.es.js

@@ -1,27 +1,34 @@
-async function h(r) {
-  const { tmdb_id: t, imdb_id: o, season: a, episode: c, language: i, format: u } = r, e = new URL("https://subs.wyzie.ru/search"), s = {
-    id: t || o,
-    season: a,
+async function h({
+  tmdb_id: t,
+  imdb_id: r,
+  season: e,
+  episode: c,
+  language: o,
+  type: a
+}) {
+  const s = new URL("https://subs.wyzie.ru/search"), i = {
+    id: String(t || r),
+    season: e,
     episode: c,
-    language: i,
-    format: u
+    language: o,
+    type: a
   };
-  return Object.keys(s).forEach((n) => {
-    s[n] !== void 0 && e.searchParams.append(n, String(s[n]));
-  }), e;
+  return Object.entries(i).forEach(([u, n]) => {
+    n !== void 0 && s.searchParams.append(u, n);
+  }), s;
 }
-async function f(r) {
-  const t = await fetch(r.toString());
-  if (!t.ok)
-    throw new Error(`HTTP error! status: ${t.status}`);
-  return await t.json();
+async function f(t) {
+  const r = await fetch(t.toString());
+  if (!r.ok)
+    throw new Error(`HTTP error! status: ${r.status}`);
+  return r.json();
 }
-async function w(r) {
+async function w(t) {
   try {
-    const t = await h(r);
-    return await f(t);
-  } catch (t) {
-    throw console.error("Error fetching subtitles:", t), t;
+    const r = await h(t);
+    return await f(r);
+  } catch (r) {
+    throw new Error(`Error fetching subtitles: ${r}`);
   }
 }
 export {

package/dist/wyzie-lib.iife.js

@@ -0,0 +1 @@
+var WyzieLib=function(e){"use strict";async function c({tmdb_id:r,imdb_id:t,season:o,episode:u,language:h,type:f}){const n=new URL("https://subs.wyzie.ru/search"),b={id:String(r||t),season:o,episode:u,language:h,type:f};return Object.entries(b).forEach(([l,s])=>{s!==void 0&&n.searchParams.append(l,s)}),n}async function i(r){const t=await fetch(r.toString());if(!t.ok)throw new Error(`HTTP error! status: ${t.status}`);return t.json()}async function a(r){try{const t=await c(r);return await i(t)}catch(t){throw new Error(`Error fetching subtitles: ${t}`)}}return e.searchSubtitles=a,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),e}({});

package/dist/wyzie-lib.umd.js

@@ -1 +1 @@
-(function(e,r){typeof exports=="object"&&typeof module<"u"?r(exports):typeof define=="function"&&define.amd?define(["exports"],r):(e=typeof globalThis<"u"?globalThis:e||self,r(e.WyzieLib={}))})(this,function(e){"use strict";async function r(n){const{tmdb_id:t,imdb_id:u,season:f,episode:d,language:h,format:l}=n,i=new URL("https://subs.wyzie.ru/search"),s={id:t||u,season:f,episode:d,language:h,format:l};return Object.keys(s).forEach(o=>{s[o]!==void 0&&i.searchParams.append(o,String(s[o]))}),i}async function a(n){const t=await fetch(n.toString());if(!t.ok)throw new Error(`HTTP error! status: ${t.status}`);return await t.json()}async function c(n){try{const t=await r(n);return await a(t)}catch(t){throw console.error("Error fetching subtitles:",t),t}}e.searchSubtitles=c,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});
+(function(e,r){typeof exports=="object"&&typeof module<"u"?r(exports):typeof define=="function"&&define.amd?define(["exports"],r):(e=typeof globalThis<"u"?globalThis:e||self,r(e.WyzieLib={}))})(this,function(e){"use strict";async function r({tmdb_id:n,imdb_id:t,season:u,episode:a,language:f,type:h}){const s=new URL("https://subs.wyzie.ru/search"),d={id:String(n||t),season:u,episode:a,language:f,type:h};return Object.entries(d).forEach(([l,i])=>{i!==void 0&&s.searchParams.append(l,i)}),s}async function o(n){const t=await fetch(n.toString());if(!t.ok)throw new Error(`HTTP error! status: ${t.status}`);return t.json()}async function c(n){try{const t=await r(n);return await o(t)}catch(t){throw new Error(`Error fetching subtitles: ${t}`)}}e.searchSubtitles=c,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,6 +1,8 @@
 {
   "name": "wyzie-lib",
-  "version": "1.0.5",
+  "version": "2.0.1",
+  "icon": "https://i.postimg.cc/L5ppKYC5/cclogo.png",
+  "license": "MIT",
   "keywords": [
     "wyzie-subs",
     "wyzie subs",
@@ -13,28 +15,30 @@
     "scraper",
     "subtitle scraper"
   ],
-  "main": "dist/wyzie-lib.umd.js",
+  "main": "dist/wyzie-lib.cjs.js",
   "module": "dist/wyzie-lib.es.js",
+  "browser": "dist/wyzie-lib.iife.js",
   "files": [
-    "dist",
-    "dist/types"
+    "dist"
   ],
   "exports": {
     ".": {
       "import": "./dist/wyzie-lib.es.js",
-      "require": "./dist/wyzie-lib.umd.js"
-    },
-    "./*": "./dist/*"
+      "require": "./dist/wyzie-lib.cjs.js",
+      "umd": "./dist/wyzie-lib.umd.js"
+    }
   },
   "devDependencies": {
-    "@eslint/js": "^9.10.0",
-    "eslint": "^9.10.0",
+    "@eslint/js": "^9.11.1",
+    "eslint": "^9.11.1",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.30.0",
     "eslint-plugin-prettier": "^5.2.1",
     "globals": "^15.9.0",
     "prettier": "^3.3.3",
     "typescript": "^5.6.2",
-    "vite": "^4.0.0"
+    "typescript-eslint": "^8.7.0",
+    "vite": "^4.5.5"
   },
   "scripts": {
     "dev": "vite",