@badstagram/urban-dictionary 1.0.0

package/LICENCE

@@ -0,0 +1,7 @@
+Copyright 2025 Badstagram
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# @badstagram/urban-dictionary
+
+A simple [Urban Dictionary](https://urbandictionary.com) API wrapper
+
+<details>
+<summary>Define a word</summary>
+
+```ts
+const client = new UrbanDictionaryClient();
+
+console.log(client.define("term"));
+/**
+  [{
+   author: "...",
+   current_vote: "",
+   defid: ...,
+   definition: "...",
+   example: "...",
+   permalink: "...",
+   thumbs_down: 0,
+   thumbs_up: 0,
+   word: "...",
+   written_on: "...",
+  }, ...]
+  **/
+```
+
+</details>
+
+<details>
+<summary>Get Auto Completion</summary>
+
+```ts
+const client = new UrbanDictionaryClient();
+
+console.log(client.autoComplete("term"));
+/**
+  [{
+    preview: '...',
+    term: '...'
+  }, ...]
+  **/
+```
+
+</details>
+
+</details>
+
+<details>
+<summary>Get a random definition</summary>
+
+```ts
+const client = new UrbanDictionaryClient();
+
+console.log(client.random()); // Also supports an optional 'count' parameter
+/**
+  [{
+   author: "...",
+   current_vote: "",
+   defid: ...,
+   definition: "...",
+   example: "...",
+   permalink: "...",
+   thumbs_down: 0,
+   thumbs_up: 0,
+   word: "...",
+   written_on: "...",
+  }, ...]
+  **/
+```
+
+</details>

package/dist/index.cjs

@@ -0,0 +1,47 @@
+
+//#region src/lib/util.ts
+function pickRandom(arr) {
+	return arr[Math.floor(Math.random() * arr.length)];
+}
+
+//#endregion
+//#region src/lib/UrbanDictionaryClient.ts
+var UrbanDictionaryClient = class {
+	BASE_URL;
+	/**
+	* Creates a UrbanDictionaryClient
+	*
+	*/
+	constructor() {
+		this.BASE_URL = new URL("http://api.urbandictionary.com/v0");
+	}
+	/**
+	* Defines a term
+	* @param term The term to define
+	* @returns The definitions of the term
+	*/
+	async define(term) {
+		const url = new URL(`${this.BASE_URL}/define`);
+		url.searchParams.append("term", term);
+		return (await fetch(url).then((r) => r.json())).list;
+	}
+	async autoComplete(term) {
+		const url = new URL(`${this.BASE_URL}/autocomplete-extra`);
+		url.searchParams.append("term", term);
+		return (await fetch(url).then((r) => r.json())).results;
+	}
+	/**
+	*
+	* @returns A random definition
+	*/
+	async random(count = 1) {
+		const url = new URL(`${this.BASE_URL}/random`);
+		const res = await fetch(url).then((r) => r.json());
+		const results = [];
+		for (let i = 0; i < count; i++) results.push(pickRandom(res.list));
+		return results;
+	}
+};
+
+//#endregion
+exports.UrbanDictionaryClient = UrbanDictionaryClient;

package/dist/index.d.cts

@@ -0,0 +1,49 @@
+//#region src/lib/interfaces/UrbanDictionaryResult.d.ts
+interface UrbanDictionary {
+  list: Array<UrbanDictionaryList>;
+}
+interface UrbanDictionaryList {
+  author: string;
+  current_vote: string;
+  defid: number;
+  definition: string;
+  example: string;
+  permalink: string;
+  thumbs_down: number;
+  thumbs_up: number;
+  word: string;
+  written_on: Date;
+}
+//#endregion
+//#region src/lib/UrbanDictionaryClient.d.ts
+declare class UrbanDictionaryClient {
+  private readonly BASE_URL;
+  /**
+   * Creates a UrbanDictionaryClient
+   *
+   */
+  constructor();
+  /**
+   * Defines a term
+   * @param term The term to define
+   * @returns The definitions of the term
+   */
+  define(term: string): Promise<Array<UrbanDictionaryList>>;
+  autoComplete(term: string): Promise<UrbanDictionaryAutoCompleteResults[]>;
+  /**
+   *
+   * @returns A random definition
+   */
+  random(count?: number): Promise<UrbanDictionaryList[]>;
+}
+//#endregion
+//#region src/lib/interfaces/UrbanDictionaryAutoComplete.d.ts
+interface UrbanDictionaryAutoComplete {
+  results: Array<UrbanDictionaryAutoCompleteResults>;
+}
+interface UrbanDictionaryAutoCompleteResults {
+  preview: string;
+  term: string;
+}
+//#endregion
+export { UrbanDictionary, UrbanDictionaryAutoComplete, UrbanDictionaryAutoCompleteResults, UrbanDictionaryClient, UrbanDictionaryList };

package/dist/index.d.mts

@@ -0,0 +1,49 @@
+//#region src/lib/interfaces/UrbanDictionaryResult.d.ts
+interface UrbanDictionary {
+  list: Array<UrbanDictionaryList>;
+}
+interface UrbanDictionaryList {
+  author: string;
+  current_vote: string;
+  defid: number;
+  definition: string;
+  example: string;
+  permalink: string;
+  thumbs_down: number;
+  thumbs_up: number;
+  word: string;
+  written_on: Date;
+}
+//#endregion
+//#region src/lib/UrbanDictionaryClient.d.ts
+declare class UrbanDictionaryClient {
+  private readonly BASE_URL;
+  /**
+   * Creates a UrbanDictionaryClient
+   *
+   */
+  constructor();
+  /**
+   * Defines a term
+   * @param term The term to define
+   * @returns The definitions of the term
+   */
+  define(term: string): Promise<Array<UrbanDictionaryList>>;
+  autoComplete(term: string): Promise<UrbanDictionaryAutoCompleteResults[]>;
+  /**
+   *
+   * @returns A random definition
+   */
+  random(count?: number): Promise<UrbanDictionaryList[]>;
+}
+//#endregion
+//#region src/lib/interfaces/UrbanDictionaryAutoComplete.d.ts
+interface UrbanDictionaryAutoComplete {
+  results: Array<UrbanDictionaryAutoCompleteResults>;
+}
+interface UrbanDictionaryAutoCompleteResults {
+  preview: string;
+  term: string;
+}
+//#endregion
+export { UrbanDictionary, UrbanDictionaryAutoComplete, UrbanDictionaryAutoCompleteResults, UrbanDictionaryClient, UrbanDictionaryList };

package/dist/index.mjs

@@ -0,0 +1,46 @@
+//#region src/lib/util.ts
+function pickRandom(arr) {
+	return arr[Math.floor(Math.random() * arr.length)];
+}
+
+//#endregion
+//#region src/lib/UrbanDictionaryClient.ts
+var UrbanDictionaryClient = class {
+	BASE_URL;
+	/**
+	* Creates a UrbanDictionaryClient
+	*
+	*/
+	constructor() {
+		this.BASE_URL = new URL("http://api.urbandictionary.com/v0");
+	}
+	/**
+	* Defines a term
+	* @param term The term to define
+	* @returns The definitions of the term
+	*/
+	async define(term) {
+		const url = new URL(`${this.BASE_URL}/define`);
+		url.searchParams.append("term", term);
+		return (await fetch(url).then((r) => r.json())).list;
+	}
+	async autoComplete(term) {
+		const url = new URL(`${this.BASE_URL}/autocomplete-extra`);
+		url.searchParams.append("term", term);
+		return (await fetch(url).then((r) => r.json())).results;
+	}
+	/**
+	*
+	* @returns A random definition
+	*/
+	async random(count = 1) {
+		const url = new URL(`${this.BASE_URL}/random`);
+		const res = await fetch(url).then((r) => r.json());
+		const results = [];
+		for (let i = 0; i < count; i++) results.push(pickRandom(res.list));
+		return results;
+	}
+};
+
+//#endregion
+export { UrbanDictionaryClient };

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@badstagram/urban-dictionary",
+	"description": "An urban dictionary API wrapper",
+	"version": "1.0.0",
+	"private": false,
+	"main": "dist/index.cjs",
+	"module": "dist/index.js",
+	"types": "dist/index.d.mts",
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"build": "tsdown",
+		"clean:build": "rm -rf dist/ && rm *.tgz; npm run build"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://git.badstagram.gay/badstagram/urban-dictionary"
+	},
+	"keywords": [
+		"discord",
+		"markdown"
+	],
+	"author": "Badstagram",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://git.badstagram.gay/badstagram/urban-dictionary/issues"
+	},
+	"homepage": "https://git.badstagram.gay/badstagram/urban-dictionary",
+	"devDependencies": {
+		"@types/node": "^24.10.1",
+		"tsdown": "^0.18.1",
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.13"
+	}
+}