wyzie-lib 2.1.2 → 2.1.4

package/README.md

@@ -7,9 +7,9 @@ project without all the fuss. [Read our source code!](https://github.com/itzcozi
 
 ## Features
 
-- **VTT Parser**: Convert SRT subtitles to VTT format quickly.
 - **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.
+- **VTT Parser**: Convert SRT subtitles to VTT format quickly.
 - **Open-Source**: The API and package are open-source.
 
 ## Installation
@@ -48,6 +48,8 @@ const vttContent = await parseToVTT(data[0].url); // Passes the first subtitle U
 console.log(vttContent); // Prints the raw VTT content
 ```
 
+Check out demo.html for a working example using the VTT parser.
+
 ### Parameters
 
 | Parameter               | Name              | Description                                                                               |
@@ -66,41 +68,6 @@ console.log(vttContent); // Prints the raw VTT content
 - **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
-  season?: number;
-  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
-  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
-  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
-};
-```
-
 <hr />
 
 <sup>

package/lib/main.d.ts

@@ -1,25 +1,33 @@
 export declare function parseToVTT(subtitleUrl: string): Promise<string>;
 
-export declare interface QueryParams {
+export declare type QueryParams = {
     id: string;
     season?: number;
     episode?: number;
     language?: string;
     format?: string;
     hi?: boolean;
-}
+};
 
 export declare function searchSubtitles(params: SearchSubtitlesParams): Promise<SubtitleData[]>;
 
-export declare interface SearchSubtitlesParams {
-    tmdb_id?: number;
-    imdb_id?: number;
-    season?: number;
-    episode?: number;
+export declare type SearchSubtitlesParams = ({
+    tmdb_id: number;
+    imdb_id?: never;
+} | {
+    imdb_id: string;
+    tmdb_id?: never;
+}) & {
     language?: string;
     format?: string;
     hi?: boolean;
-}
+} & ({
+    season: number;
+    episode: number;
+} | {
+    season?: never;
+    episode?: never;
+});
 
 export declare type SubtitleData = {
     id: string;

package/lib/main.js

@@ -18,7 +18,7 @@ async function constructUrl({
   };
   Object.entries(queryParams).forEach(([key, value]) => {
     if (value !== void 0) {
-      url.searchParams.append(key, value);
+      url.searchParams.append(key, String(value));
     }
   });
   return url;

package/lib/main.umd.cjs

@@ -22,7 +22,7 @@
     };
     Object.entries(queryParams).forEach(([key, value]) => {
       if (value !== void 0) {
-        url.searchParams.append(key, value);
+        url.searchParams.append(key, String(value));
       }
     });
     return url;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wyzie-lib",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "icon": "https://i.postimg.cc/L5ppKYC5/cclogo.png",
   "license": "MIT",
   "keywords": [
@@ -13,7 +13,8 @@
     "vite",
     "fast",
     "scraper",
-    "subtitle scraper"
+    "subtitle scraper",
+    "open subtitles"
   ],
   "type": "module",
   "main": "./lib/main.js",
@@ -38,18 +39,17 @@
     "url": "git+https://github.com/itzcozi/wyzie-lib.git"
   },
   "devDependencies": {
-    "globals": "^15.14.0",
     "prettier": "^3.4.2",
-    "typescript": "^5.7.2",
+    "typescript": "^5.7.3",
     "vite": "^4.5.5",
-    "vite-plugin-dts": "^4.4.0",
+    "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,js,html,css},*.{ts,js,html,css,json,md,xml}}\"",
+    "format": "prettier --log-level warn --write \"{src/**/*.{ts},*.{ts,js,html,css,json,md,xml}}\"",
     "preview": "vite preview"
   }
 }