@overandoutnerd/dumbledore-bot-core 1.0.2 → 1.0.4

package/README.md

@@ -1,14 +1,180 @@
 # Dumbledore Bot Core
 
-Shared library used by:
+A TypeScript library for searching and retrieving Albus Dumbledore quotes using semantic similarity powered by Gemini embeddings.
 
-- Reddit Dumbledore Bot
-- Discord Dumbledore Bot
+The package includes:
+
+- Dumbledore quote dataset
+- Dumbledore GIF dataset
+- Precomputed quote embeddings
+- Semantic quote search
+- Random quote selection
+- Random GIF selection
 
 ## Installation
 
-npm install github:overandoutnerd/Dumbledore-Bot-Core
+```bash
+npm install @overandoutnerd/dumbledore-bot-core
+```
+
+## Requirements
+
+- Node.js 18+
+- Gemini API key
 
 ## Usage
 
-import { getRelevantQuote } from "dumbledore-bot-core";
+### Get a Relevant Quote
+
+```ts
+import {
+    getRelevantQuote,
+} from "@overandoutnerd/dumbledore-bot-core";
+
+const quote =
+    await getRelevantQuote(
+        "dumbledore, is sirius innocent?",
+        process.env.GEMINI_API_KEY!,
+    );
+
+console.log(quote);
+```
+
+### Get Top Matches
+
+```ts
+import {
+    getTopMatches,
+} from "@overandoutnerd/dumbledore-bot-core";
+
+const matches =
+    await getTopMatches(
+        "tell me about sirius black",
+        process.env.GEMINI_API_KEY!,
+        5,
+    );
+
+console.log(matches);
+```
+
+Example output:
+
+```ts
+[
+    {
+        text: "Sirius has not acted like an innocent man.",
+        score: 0.82,
+    },
+]
+```
+
+### Get a Random Quote
+
+```ts
+import {
+    getRandomQuote,
+} from "@overandoutnerd/dumbledore-bot-core";
+
+const quote =
+    getRandomQuote();
+
+console.log(quote);
+```
+
+### Get a Random GIF
+
+```ts
+import {
+    getRandomGif,
+} from "@overandoutnerd/dumbledore-bot-core";
+
+const gifUrl =
+    getRandomGif();
+
+console.log(gifUrl);
+```
+
+### Access All Quotes
+
+```ts
+import {
+    QUOTES,
+} from "@overandoutnerd/dumbledore-bot-core";
+
+console.log(
+    QUOTES.length,
+);
+```
+
+### Access All GIFs
+
+```ts
+import {
+    GIFS,
+} from "@overandoutnerd/dumbledore-bot-core";
+
+console.log(
+    GIFS.length,
+);
+```
+
+## API
+
+### getRelevantQuote
+
+Returns a semantically relevant quote.
+
+```ts
+getRelevantQuote(
+    message: string,
+    apiKey: string,
+): Promise<string>
+```
+
+### getTopMatches
+
+Returns the highest-scoring quote matches.
+
+```ts
+getTopMatches(
+    message: string,
+    apiKey: string,
+    limit?: number,
+): Promise<QuoteMatch[]>
+```
+
+### getRandomQuote
+
+Returns a random quote.
+
+```ts
+getRandomQuote(): string
+```
+
+### getRandomGif
+
+Returns a random GIF URL.
+
+```ts
+getRandomGif(): string
+```
+
+### QUOTES
+
+Array containing all quotes in the dataset.
+
+```ts
+const QUOTES: string[]
+```
+
+### GIFS
+
+Array containing all GIF URLs in the dataset.
+
+```ts
+const GIFS: string[]
+```
+
+## License
+
+MIT

package/dist/quoteSearch.js

@@ -54,7 +54,7 @@ export async function getRelevantQuote(message, apiKey) {
     console.log("[QuoteSearch] Message:", message);
     const matches = await getTopMatches(message, apiKey, 5);
     console.log("[QuoteSearch] Top Matches:", matches);
-    const selected = matches[Math.floor(Math.random() * 2)];
+    const selected = matches[Math.floor(Math.random() * matches.length)];
     if (!selected) {
         throw new Error("No matching quotes found");
     }

package/package.json

@@ -1,13 +1,26 @@
 {
   "name": "@overandoutnerd/dumbledore-bot-core",
-  "version": "1.0.2",
-  "description": "Shared Dumbledore bot library",
+  "version": "1.0.4",
+  "description": "Semantic Dumbledore quote search powered by Gemini embeddings",
+  "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
+  "keywords": [
+    "dumbledore",
+    "harry-potter",
+    "quotes",
+    "semantic-search",
+    "embeddings",
+    "gemini",
+    "discord-bot",
+    "reddit-bot"
+  ],
+  "author": "Abdul Lateef",
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build"