wyzie-lib 2.0.0 → 2.0.2

package/README.md

@@ -37,8 +37,41 @@ yarn add wyzie-lib
 ```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
+```
+### 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
+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
+}
+
+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 />

package/dist/wyzie-lib.cjs.js

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

package/dist/wyzie-lib.iife.js

@@ -1 +1 @@
-var WyzieLib=function(e){"use strict";async function c({tmdb_id:t,imdb_id:r,season:i,episode:u,language:h,type:f}){const n=new URL("https://subs.wyzie.ru/search");return Object.entries({id:t||r,season:i,episode:u,language:h,type:f}).forEach(([l,s])=>{s!==void 0&&n.searchParams.append(l,String(s))}),n}async function a(t){const r=await fetch(t.toString());if(!r.ok)throw new Error(`HTTP error! status: ${r.status}`);return r.json()}async function o(t){try{const r=await c(t);return await a(r)}catch(r){throw console.error("Error fetching subtitles:",r),r}}return e.searchSubtitles=o,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),e}({});
+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({tmdb_id:n,imdb_id:t,season:u,episode:a,language:f,type:h}){const s=new URL("https://subs.wyzie.ru/search");return Object.entries({id:n||t,season:u,episode:a,language:f,type:h}).forEach(([d,o])=>{o!==void 0&&s.searchParams.append(d,String(o))}),s}async function i(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 i(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,7 +1,8 @@
 {
   "name": "wyzie-lib",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "icon": "https://i.postimg.cc/L5ppKYC5/cclogo.png",
+  "license": "MIT",
   "keywords": [
     "wyzie-subs",
     "wyzie subs",
@@ -28,16 +29,16 @@
     }
   },
   "devDependencies": {
-    "@eslint/js": "^9.10.0",
-    "eslint": "^9.10.0",
+    "@eslint/js": "^9.12.0",
+    "eslint": "^9.12.0",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-prettier": "^5.2.1",
-    "globals": "^15.9.0",
+    "globals": "^15.11.0",
     "prettier": "^3.3.3",
-    "typescript": "^5.6.2",
-    "vite": "^4.5.5",
-    "eslint-plugin-import": "^2.30.0",
-    "typescript-eslint": "^8.6.0"
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.8.1",
+    "vite": "^4.5.5"
   },
   "scripts": {
     "dev": "vite",