✨ Support for self-hosted api

README.md

@@ -64,6 +64,47 @@ function App() {
 export default App;
 ```
 
+# 🤞 Using Self-Hosted API
+
+You can use this package to connect to your own self-hosted Lanyard API. To do this, you need to pass the `apiUrl` option to the `useLanyard` hook. See [Lanyard self-hosting guide](https://github.com/Phineas/lanyard#self-host-with-docker) for more information.
+
+Using without websocket:
+
+```js
+import { useLanyard } from "react-use-lanyard";
+
+function App() {
+	const lanyard = useLanyard({
+		userId: "952574663916154960",
+		apiUrl: "lanyard.338.rocks",
+	});
+
+	return (
+		<pre>{!lanyard.isValidating && JSON.stringify(lanyard, null, 4)}</pre>
+	);
+}
+
+export default App;
+```
+
+Using with websocket:
+
+```js
+import { useLanyard } from "react-use-lanyard";
+
+function App() {
+	const { loading, status /*, websocket */ } = useLanyard({
+		userId: "952574663916154960",
+		socket: true,
+		apiUrl: "lanyard.338.rocks",
+	});
+
+	return <pre>{!loading && JSON.stringify(status, null, 4)}</pre>;
+}
+
+export default App;
+```
+
 # 📄 License
 
 Copyright © 2021 [Barış DEMİRCİ](https://github.com/barbarbar338).

package.json

@@ -1,50 +1,48 @@
-{
-	"name": "react-use-lanyard",
-	"version": "0.1.4",
-	"main": "dist",
-	"typings": "dist",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/barbarbar338/react-use-lanyard"
-	},
-	"author": {
-		"email": "[email protected]",
-		"name": "Barış DEMİRCİ",
-		"url": "https://338.rocks/"
-	},
-	"license": "GPL-3.0",
-	"description": "🚀 Use Lanyard API easily in you React app!",
-	"scripts": {
-		"prebuild": "rimraf dist",
-		"build": "tsc",
-		"format": "prettier --write .",
-		"format:watch": "onchange . -- prettier --write {{changed}}",
-		"lint": "eslint --fix .",
-		"lint:watch": "onchange . -- eslint --fix {{changed}}",
-		"update": "taze major -w && yarn"
-	},
-	"devDependencies": {
-		"@types/node": "^18.7.23",
-		"@types/react": "^18.0.21",
-		"@types/react-dom": "^18.0.6",
-		"@typescript-eslint/eslint-plugin": "^5.38.1",
-		"@typescript-eslint/parser": "^5.38.1",
-		"eslint": "^8.24.0",
-		"eslint-config-prettier": "^8.5.0",
-		"eslint-plugin-import": "^2.26.0",
-		"onchange": "^7.1.0",
-		"prettier": "^2.7.1",
-		"react": "^18.2.0",
-		"react-dom": "^18.2.0",
-		"taze": "^0.8.2",
-		"ts-node": "^10.9.1",
-		"typescript": "^4.8.4"
-	},
-	"peerDependencies": {
-		"react": ">=16"
-	},
-	"dependencies": {
-		"swr": "^1.3.0",
-		"tslib": "^2.4.0"
-	}
-}
+{
+	"name": "react-use-lanyard",
+	"version": "0.1.5",
+	"main": "dist",
+	"typings": "dist",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/barbarbar338/react-use-lanyard"
+	},
+	"author": {
+		"email": "[email protected]",
+		"name": "Barış DEMİRCİ",
+		"url": "https://338.rocks/"
+	},
+	"license": "GPL-3.0",
+	"description": "🚀 Use Lanyard API easily in you React app!",
+	"scripts": {
+		"prebuild": "rimraf dist",
+		"build": "tsc",
+		"format": "prettier --write .",
+		"lint": "eslint --fix .",
+		"update": "taze latest -w"
+	},
+	"devDependencies": {
+		"@types/node": "^18.11.11",
+		"@types/react": "^18.0.26",
+		"@types/react-dom": "^18.0.9",
+		"@typescript-eslint/eslint-plugin": "^5.45.1",
+		"@typescript-eslint/parser": "^5.45.1",
+		"eslint": "^8.29.0",
+		"eslint-config-prettier": "^8.5.0",
+		"eslint-plugin-import": "^2.26.0",
+		"prettier": "^2.8.0",
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0",
+		"taze": "^0.8.4",
+		"ts-node": "^10.9.1",
+		"typescript": "^4.9.3"
+	},
+	"peerDependencies": {
+		"react": ">=16"
+	},
+	"dependencies": {
+		"swr": "^1.3.0",
+		"tslib": "^2.4.1"
+	}
+}
+

src/constants.ts

@@ -1,3 +1,2 @@
-export const API_URL = "https://lanyard.rest/v1";
-export const WEBSOCKET_URL = "wss://lanyard.rest/socket";
+export const API_URL = "lanyard.rest";
 export const HEARTBEAT_INTERVAL = 30_000;

src/index.ts

@@ -1,3 +1,3 @@
-export * from "./types";
 export * from "./constants";
 export * from "./lanyard";
+export * from "./types";

src/lanyard.ts

@@ -1,16 +1,18 @@
+import { useEffect, useState } from "react";
+import useSWR from "swr";
+import { API_URL, HEARTBEAT_INTERVAL } from "./constants";
 import type {
 	LanyardData,
+	LanyardGeneric,
 	LanyardOptions,
 	LanyardResponse,
-	LanyardGeneric,
 } from "./types";
-import { API_URL, HEARTBEAT_INTERVAL, WEBSOCKET_URL } from "./constants";
-import { useEffect, useState } from "react";
-import useSWR from "swr";
 
 export const useLanyard = <T extends LanyardOptions>(
 	options: T,
 ): LanyardGeneric<T> => {
+	const apiUrl = options.apiUrl || API_URL;
+
 	if (options.socket) {
 		const [status, setStatus] = useState<LanyardData>();
 		const [websocket, setWebsocket] = useState<WebSocket>();
@@ -35,7 +37,7 @@ export const useLanyard = <T extends LanyardOptions>(
 			const connectWebsocket = () => {
 				if (heartbeat) clearInterval(heartbeat);
 
-				socket = new WebSocket(WEBSOCKET_URL);
+				socket = new WebSocket(`wss://${apiUrl}/socket`);
 				setWebsocket(socket);
 				setLoading(true);
 
@@ -88,7 +90,7 @@ export const useLanyard = <T extends LanyardOptions>(
 				`lanyard_${options.userId}`,
 				async () => {
 					const req = await fetch(
-						`${API_URL}/users/${options.userId}`,
+						`https://${apiUrl}/v1/users/${options.userId}`,
 					);
 
 					const body = (await req.json()) as LanyardResponse;
@@ -104,7 +106,9 @@ export const useLanyard = <T extends LanyardOptions>(
 					const responseArray: LanyardResponse[] = [];
 
 					for (const id of options.userId) {
-						const req = await fetch(`${API_URL}/users/${id}`);
+						const req = await fetch(
+							`https://${apiUrl}/v1/users/${id}`,
+						);
 
 						const body = (await req.json()) as LanyardResponse;
 						if (body.error) throw new Error(body.error.message);

src/types.ts

@@ -25,6 +25,7 @@ export type LanyardGeneric<T> = T extends { socket: true }
 export interface LanyardOptions {
 	userId: string | string[];
 	socket?: boolean;
+	apiUrl?: string;
 }
 
 export interface LanyardResponse {