search-web-api 1.0.76 → 1.0.77

package/src/sources/torrents/nyaa.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that scrapes Nyaa torrent search results.
+ */
 import { parseHTML } from "linkedom";
 import { EngineFunction } from "../../types/search-engine-interface.js";
 

package/src/sources/torrents/solidtorrents.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that scrapes SolidTorrents search results.
+ */
 import { parseHTML } from "linkedom";
 import { EngineFunction } from "../../types/search-engine-interface.js";
 

package/src/sources/torrents/thepiratebay.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that scrapes The Pirate Bay search results.
+ */
 import { parseHTML } from "linkedom";
 import { EngineFunction } from "../../types/search-engine-interface.js";
 

package/src/sources/torrents/yts.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that queries the YTS API for movie torrent search results.
+ */
 import { EngineFunction } from "../../types/search-engine-interface.js";
 
 export const yts: EngineFunction = async (

package/src/sources/videos/bing_videos.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that scrapes Bing Videos search results.
+ */
 import { parseHTML } from "linkedom";
 import { EngineFunction } from "../../types/search-engine-interface.js";
 

package/src/sources/videos/dailymotion.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that queries the Dailymotion API for video search results.
+ */
 import { EngineFunction } from "../../types/search-engine-interface.js";
 
 export const dailymotion: EngineFunction = async (

package/src/sources/videos/invidious.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that queries public Invidious instances for YouTube video search results.
+ */
 import { EngineFunction } from "../../types/search-engine-interface.js";
 
 // Public Invidious instances - user can configure their own

package/src/sources/videos/peertube.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that queries the PeerTube API for video search results.
+ */
 import { EngineFunction } from "../../types/search-engine-interface.js";
 
 export const peertube: EngineFunction = async (

package/src/sources/videos/vimeo.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that queries the Vimeo API for video search results.
+ */
 import { EngineFunction } from "../../types/search-engine-interface.js";
 
 export const vimeo: EngineFunction = async (

package/src/sources/videos/youtube.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Engine adapter that queries YouTube video search via public Invidious instances, with fallback across multiple instances.
+ */
 import { EngineFunction } from "../../types/search-engine-interface.js";
 
 // Multiple Invidious instances for fallback

package/src/suggest-next-words/autocomplete-ai.ts

@@ -1,38 +1,41 @@
-import { pipeline, type TextGenerationSingle } from "@huggingface/transformers";
-
-/**
- * Generates the next words for a given prompt using a text generation model.
- *
- * The DistilGPT2 model is a distilled, smaller version of OpenAI's GPT-2, featuring
- * around 82 million parameters (~80MB), and available in Hugging Face Transformers
- * for efficient next word (next-token) prediction tasks in English text. It is
- * well-suited for sequence generation and can be used as a next word prediction
- * model with code similar to GPT2, but offers faster and lighter inference compared
- * GPT-2 (124M parameter) model, preserving most capabilities but running
- * significantly faster and requiring less memory.
- * @see https://huggingface.co/Xenova/distilgpt2
- * @param {string} prompt - The input prompt to complete.
- * @param {Object} [options] - Generation options.
- * @param {number} [options.maxTokens=16] - Maximum number of new tokens to generate.
- * @param {string} [options.model='Xenova/distilgpt2'] - The model identifier to use.
- * @returns {Promise<string>} - The generated text completions.
- */
-export async function predictNextWordsWithSmallLocalModel(
-  prompt: string,
-  { model = "Xenova/distilgpt2", maxTokens = 16, modelParams = {} } = {}
-): Promise<string> {
-  if (!prompt) throw new Error("Prompt is required");
-  return (
-    await (
-      await pipeline("text-generation", model, {
-        dtype: "fp16",
-        device: "cpu",
-        ...modelParams,
-      })
-    )(prompt, { max_new_tokens: maxTokens })
-  )
-    .map((res) => (res as TextGenerationSingle).generated_text)
-    .join(" ")
-    .replace(prompt, "")
-    .trim();
-}
+/**
+ * @fileoverview Local next-word prediction using the DistilGPT-2 model via Hugging Face Transformers.js.
+ */
+import { pipeline, type TextGenerationSingle } from "@huggingface/transformers";
+
+/**
+ * Generates the next words for a given prompt using a text generation model.
+ *
+ * The DistilGPT2 model is a distilled, smaller version of OpenAI's GPT-2, featuring
+ * around 82 million parameters (~80MB), and available in Hugging Face Transformers
+ * for efficient next word (next-token) prediction tasks in English text. It is
+ * well-suited for sequence generation and can be used as a next word prediction
+ * model with code similar to GPT2, but offers faster and lighter inference compared
+ * GPT-2 (124M parameter) model, preserving most capabilities but running
+ * significantly faster and requiring less memory.
+ * @see https://huggingface.co/Xenova/distilgpt2
+ * @param {string} prompt - The input prompt to complete.
+ * @param {Object} [options] - Generation options.
+ * @param {number} [options.maxTokens=16] - Maximum number of new tokens to generate.
+ * @param {string} [options.model='Xenova/distilgpt2'] - The model identifier to use.
+ * @returns {Promise<string>} - The generated text completions.
+ */
+export async function predictNextWordsWithSmallLocalModel(
+  prompt: string,
+  { model = "Xenova/distilgpt2", maxTokens = 16, modelParams = {} } = {}
+): Promise<string> {
+  if (!prompt) throw new Error("Prompt is required");
+  return (
+    await (
+      await pipeline("text-generation", model, {
+        dtype: "fp16",
+        device: "cpu",
+        ...modelParams,
+      })
+    )(prompt, { max_new_tokens: maxTokens })
+  )
+    .map((res) => (res as TextGenerationSingle).generated_text)
+    .join(" ")
+    .replace(prompt, "")
+    .trim();
+}

package/src/types/search-engine-interface.ts

@@ -5,9 +5,9 @@
  * import `EngineFunction` and `EngineResult` from here.
  */
 
-import { EngineResult, Engine, EngineFunction } from "./search-result-types.js";
+import type { EngineResult, Engine, EngineFunction } from "./search-result-types.js";
 
-export { EngineResult, Engine, EngineFunction };
+export type { EngineResult, Engine, EngineFunction };
 
 /**
  * Extract the actual data from a grab-url response.