wyzie-lib 2.0.3 → 2.0.5

package/README.md

@@ -1,77 +1,96 @@
 # Wyzie Lib
 
-Wyzie Lib is a package made for easily implementing [Wyzie Subs](https://subs.wyzie.ru) into your project without all the fuss.
+Wyzie Lib is a package made for easily implementing [Wyzie Subs](https://subs.wyzie.ru) into your
+project without all the fuss. [Read our source code!](https://github.com/itzcozi/wyzie-lib)
 
 <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.
 - **Open-Source**: The API and package are open-source.
-  
+
 ## Installation
-### NPM
+
+**NPM**
+
 ```bash
 npm install wyzie-lib
 ```
-### PNPM
+
+**PNPM**
+
 ```bash
 pnpm install wyzie-lib
 ```
-### Yarn
+
+**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";
 
 // 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
+console.log(data[0]); // Prints the object of the first subtitle provided in the search
 ```
+
+### Parameters
+
+| Parameter               | Name              | Description                                                                               |
+| ----------------------- | ----------------- | ----------------------------------------------------------------------------------------- |
+| **tmdb_id** - _number_  | TmdbId            | The TMDB ID of the movie or TV show. _(tmdb_id or imdb_id is required)_                   |
+| **imdb_id** - _number_  | ImdbId            | The IMDB ID of the movie or TV show. _(imdb_id or tmdb_id is required)_                   |
+| **format** - _string_   | format            | The file format of the subtitles returned. _(srt, ass, vtt, txt, sub, mpl, webvtt, dfxp)_ |
+| **season** - _number_   | season            | Disired season of subtites _(this requires episode parameter aswell)_                     |
+| **episode** - _number_  | episode           | The episode of the given season.                                                          |
+| **language** - _string_ | language          | The ISO 3166 code of the provided subtitles.                                              |
+| **hi** - _boolean_      | isHearingImpaired | A boolean indicating if the subtitles are hearing impaired.                               |
+
 ### 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. 
+- **QueryParams**: All parameters (optional and required) available for the wyzie-subs API.
+- **SubtitleData**: All returned values from the API with their respective types.
+
 ```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
+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
+  episode?: number; // Season is required if episode is provided
+  language?: string; // ISO 3166 code
+  format?: string; // Subtitle file format
+  hi?: boolean; // If the subtitle is hearing impaired
 }
 
-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
+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
+  format?: string; // Subtitle file format
+  hi?: boolean; // If the subtitle is hearing impaired
 }
 
-type SubtitleData = {  // Data returned by the API
-  id: string;                 // Unique ID of the subtitle from opensubtitles
-  url: string;                // Direct download link of the subtitle
-  format: 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
+  format: string; // Subtitle file format
   isHearingImpaired: boolean; // If the subtitle is hearing impaired
-  flagUrl: string;            // Flag of the language
-  media: string;              // Media name of the subtitle
-  display: string;            // Actual name of the language
-  language: string;           // ISO 3166 code
+  flagUrl: string; // Flag of the language
+  media: string; // Media name of the subtitle
+  display: string; // Actual name of the language
+  language: string; // ISO 3166 code
 };
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wyzie-lib",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "icon": "https://i.postimg.cc/L5ppKYC5/cclogo.png",
   "license": "MIT",
   "keywords": [
@@ -37,7 +37,7 @@
     "globals": "^15.12.0",
     "prettier": "^3.3.3",
     "typescript": "^5.6.3",
-    "typescript-eslint": "^8.12.2",
+    "typescript-eslint": "^8.13.0",
     "vite": "^4.5.5"
   },
   "scripts": {
@@ -45,7 +45,7 @@
     "build": "vite build && tsc",
     "lint": "eslint src",
     "lint:fix": "eslint --fix src",
-    "format": "prettier --log-level warn --write \"src/**/*.{tsx,ts}\"",
+    "format": "prettier --log-level warn --write \"{src/**/*.{ts,js,html,css},*.{ts,js,html,css,json,md,xml}}\"",
     "preview": "vite preview"
   }
 }

package/dist/wyzie-lib.cjs.js

@@ -1 +0,0 @@
-"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,36 +0,0 @@
-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: o,
-    type: a
-  };
-  return Object.entries(i).forEach(([u, n]) => {
-    n !== void 0 && s.searchParams.append(u, n);
-  }), s;
-}
-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(t) {
-  try {
-    const r = await h(t);
-    return await f(r);
-  } catch (r) {
-    throw new Error(`Error fetching subtitles: ${r}`);
-  }
-}
-export {
-  w as searchSubtitles
-};

package/dist/wyzie-lib.iife.js

@@ -1 +0,0 @@
-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 +0,0 @@
-(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"})});