@39choko/lanyard 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 39Choko
+
+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,69 @@
+# @39choko/lanyard
+
+<div align="center">
+	<p>
+		<a href="https://www.npmjs.com/package/@39choko/lanyard"><img src="https://img.shields.io/npm/v/@39choko/lanyard.svg?maxAge=3600" alt="npm version" /></a>
+		<a href="https://www.npmjs.com/package/@39choko/lanyard"><img src="https://img.shields.io/npm/dt/@39choko/lanyard.svg?maxAge=3600" alt="npm downloads" /></a>
+		<a href="https://github.com/39Choko/lanyard/commits/main/"><img alt="Last commit." src="https://img.shields.io/github/last-commit/39Choko/lanyard?logo=github&logoColor=ffffff">
+	</p>
+</div>
+
+## About
+
+@39choko/lanyard is a [npm](https://www.npmjs.com/) package that allows you to interacting with [Lanyard](https://github.com/Phineas/lanyard).
+
+## Installation
+
+```sh
+npm install @39choko/lanyard
+yarn add @39choko/lanyard
+pnpm add @39choko/lanyard
+bun add @39choko/lanyard
+deno install npm:@39choko/lanyard
+```
+
+## Example usage
+
+```ts
+import { Client } from '@39choko/lanyard';
+
+const client = new Client();
+```
+
+### Example
+
+Getting User Info
+
+```ts
+const user = await client.user.getUser("826467976484094023");
+if (!user.success) return throw Error("Failed to fetch user.")
+
+console.log(user.data);
+```
+
+Getting User display name
+
+```ts
+const avatarURL = await client.user.getAvatarURL("826467976484094023");
+if (!avatarURL) return throw Error("Failed to fetch the avatar url.")
+
+console.log(avatarURL); // "https://cdn.discordapp.com/avatars/826467976484094023/e4479e082bb156a6f004fb3b34d678ac.png"
+```
+
+Getting User platform status
+
+```ts
+const platformStatus = await client.user.getPlatformStatus("826467976484094023");
+if (!platformStatus) return throw Error("Failed to fetch the platform status.")
+
+console.log(platformStatus); // ["desktop", "mobile"]
+```
+
+## Links
+
+- [npm](https://www.npmjs.com/package/@39choko/lanyard)
+- [Lanyard](https://github.com/Phineas/lanyard)
+
+## More
+
+If you want to contribute to this repo please make a pull request or dm me on discord (39choko / 826467976484094023)

package/dist/api/Users.d.ts

@@ -0,0 +1,10 @@
+import { Client } from "../client/Client";
+import { APIResponse, UserData } from "../types";
+export declare class Users {
+    private client;
+    constructor(client: Client);
+    getUser(userId: string): Promise<APIResponse<UserData>>;
+    getDisplayName(userId: string): Promise<string | null>;
+    getAvatarURL(userId: string): Promise<string | null>;
+    getPlatformStatus(userId: string): Promise<string[] | null>;
+}

package/dist/api/Users.js

@@ -0,0 +1,51 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: !0 });
+}, __copyProps = (to, from, except, desc) => {
+  if (from && typeof from == "object" || typeof from == "function")
+    for (let key of __getOwnPropNames(from))
+      !__hasOwnProp.call(to, key) && key !== except && __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: !0 }), mod);
+var Users_exports = {};
+__export(Users_exports, {
+  Users: () => Users
+});
+module.exports = __toCommonJS(Users_exports);
+class Users {
+  constructor(client) {
+    this.client = client;
+  }
+  async getUser(userId) {
+    const request = await this.client.request(`users/${userId}`);
+    return request.success === !1, request;
+  }
+  async getDisplayName(userId) {
+    const userRequest = await this.getUser(userId);
+    return userRequest.success === !1 ? null : userRequest.data.discord_user.display_name;
+  }
+  async getAvatarURL(userId) {
+    const userRequest = await this.getUser(userId);
+    if (userRequest.success === !1)
+      return null;
+    const avatarHash = userRequest.data.discord_user.avatar;
+    return `https://cdn.discordapp.com/avatars/${userId}/${avatarHash}.png`;
+  }
+  async getPlatformStatus(userId) {
+    const userRequest = await this.getUser(userId), platform = [];
+    if (userRequest.success === !1)
+      return null;
+    const data = userRequest.data;
+    return data.active_on_discord_desktop && platform.push("desktop"), data.active_on_discord_mobile && platform.push("mobile"), data.active_on_discord_web && platform.push("web"), data.active_on_discord_embedded && platform.push("embedded"), platform;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Users
+});

package/dist/api/Users.mjs

@@ -0,0 +1,30 @@
+class Users {
+  constructor(client) {
+    this.client = client;
+  }
+  async getUser(userId) {
+    const request = await this.client.request(`users/${userId}`);
+    return request.success === !1, request;
+  }
+  async getDisplayName(userId) {
+    const userRequest = await this.getUser(userId);
+    return userRequest.success === !1 ? null : userRequest.data.discord_user.display_name;
+  }
+  async getAvatarURL(userId) {
+    const userRequest = await this.getUser(userId);
+    if (userRequest.success === !1)
+      return null;
+    const avatarHash = userRequest.data.discord_user.avatar;
+    return `https://cdn.discordapp.com/avatars/${userId}/${avatarHash}.png`;
+  }
+  async getPlatformStatus(userId) {
+    const userRequest = await this.getUser(userId), platform = [];
+    if (userRequest.success === !1)
+      return null;
+    const data = userRequest.data;
+    return data.active_on_discord_desktop && platform.push("desktop"), data.active_on_discord_mobile && platform.push("mobile"), data.active_on_discord_web && platform.push("web"), data.active_on_discord_embedded && platform.push("embedded"), platform;
+  }
+}
+export {
+  Users
+};

package/dist/client/Client.d.ts

@@ -0,0 +1,10 @@
+import { Users } from "../api/Users";
+import { APIResponse, ClientOptions } from "../types";
+export declare class Client {
+    private readonly baseURL;
+    private readonly userAgent;
+    readonly users: Users;
+    constructor(options?: ClientOptions);
+    request<T>(endpoint?: string): Promise<APIResponse<T>>;
+    getUserAgent(): string | undefined;
+}

package/dist/client/Client.js

@@ -0,0 +1,42 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: !0 });
+}, __copyProps = (to, from, except, desc) => {
+  if (from && typeof from == "object" || typeof from == "function")
+    for (let key of __getOwnPropNames(from))
+      !__hasOwnProp.call(to, key) && key !== except && __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: !0 }), mod);
+var Client_exports = {};
+__export(Client_exports, {
+  Client: () => Client
+});
+module.exports = __toCommonJS(Client_exports);
+var import_Users = require('../api/Users.js');
+class Client {
+  constructor(options) {
+    this.baseURL = "https://api.lanyard.rest/v1";
+    options?.userAgent && (this.userAgent = options.userAgent), this.users = new import_Users.Users(this);
+  }
+  async request(endpoint) {
+    const headers = {};
+    this.userAgent && (headers["User-Agent"] = this.userAgent);
+    const finalEndpoint = endpoint ?? "", result = await fetch(`${this.baseURL}/${finalEndpoint}`, {
+      headers
+    });
+    return result.ok ? await result.json() : await result.json();
+  }
+  getUserAgent() {
+    return this.userAgent;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Client
+});

package/dist/client/Client.mjs

@@ -0,0 +1,21 @@
+import { Users } from "../api/Users.mjs";
+class Client {
+  constructor(options) {
+    this.baseURL = "https://api.lanyard.rest/v1";
+    options?.userAgent && (this.userAgent = options.userAgent), this.users = new Users(this);
+  }
+  async request(endpoint) {
+    const headers = {};
+    this.userAgent && (headers["User-Agent"] = this.userAgent);
+    const finalEndpoint = endpoint ?? "", result = await fetch(`${this.baseURL}/${finalEndpoint}`, {
+      headers
+    });
+    return result.ok ? await result.json() : await result.json();
+  }
+  getUserAgent() {
+    return this.userAgent;
+  }
+}
+export {
+  Client
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/Client";

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from == "object" || typeof from == "function")
+    for (let key of __getOwnPropNames(from))
+      !__hasOwnProp.call(to, key) && key !== except && __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  return to;
+}, __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: !0 }), mod);
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);
+__reExport(index_exports, require('./client/Client.js'), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require('./client/Client.js')
+});

package/dist/index.mjs

@@ -0,0 +1 @@
+export * from "./client/Client.mjs";

package/dist/types.d.ts

@@ -0,0 +1,115 @@
+export interface ClientOptions {
+    userAgent?: string;
+}
+export interface ErrorResponse {
+    error: {
+        code: string;
+        message: string;
+    };
+    success: false;
+}
+export interface SuccessResponse<T> {
+    data: T;
+    success: true;
+}
+export type APIResponse<T> = SuccessResponse<T> | ErrorResponse;
+export interface RootData {
+    info: string;
+    monitored_user_count: number;
+    discord_invite: string;
+}
+export interface UserData {
+    kv: {
+        [key: string]: string;
+    };
+    discord_user: {
+        avatar: string | null;
+        avatar_decoration: AvatarDecoration | null;
+        bot: boolean;
+        collectibles: Collectibles | null;
+        discriminator: string;
+        display_name: string;
+        display_name_styles: DisplayNameStyles | null;
+        global_name: string;
+        id: string;
+        primary_guild: PrimaryGuild | null;
+        public_flags: number;
+        username: string;
+    };
+    activities: Activity[] | [];
+    discord_status: "online" | "idle" | "dnd" | "offline";
+    active_on_discord_web: boolean;
+    active_on_discord_mobile: boolean;
+    active_on_discord_desktop: boolean;
+    active_on_discord_embedded: boolean;
+    listening_to_spotify: boolean;
+    spotify: SpotifyData | null;
+}
+export interface AvatarDecoration {
+    asset: string;
+    expire_at: number | null;
+    sku_id: string;
+}
+export interface Collectibles {
+    nameplate: {
+        asset: string;
+        expire_at: number | null;
+        label: string;
+        palette: string;
+        sku_id: string;
+    };
+}
+export interface DisplayNameStyles {
+    color: number[];
+    effect_id: number;
+    font_id: number;
+}
+export interface PrimaryGuild {
+    badge: string;
+    identity_enabled: boolean;
+    identity_guild_id: string;
+    tag: string;
+}
+export interface Activity {
+    application_id?: string;
+    asserts?: Partial<Record<"large_image" | "large_text" | "large_url" | "small_image" | "small_text" | "small_url", string>>;
+    buttons?: string[] | GatewayActivityButton[];
+    created_at: number;
+    details?: null | string;
+    details_url?: null | string;
+    flags?: number;
+    id: string;
+    instance?: boolean;
+    name: string;
+    party?: {
+        id?: string;
+        size?: [current_size: number, max_size: number];
+    };
+    platform?: string;
+    secrets?: Partial<Record<"join" | "match" | "spectate", string>>;
+    session_id?: string;
+    state?: null | string;
+    status_display_type?: null | number;
+    sync_id?: string;
+    timestamps?: {
+        end?: number;
+        start?: number;
+    };
+    type: number;
+    url: null | string;
+}
+export interface GatewayActivityButton {
+    id: string;
+    url: string;
+}
+export interface SpotifyData {
+    track_id: string;
+    timestamps: {
+        start: number;
+        end: number;
+    };
+    song: string;
+    artist: string;
+    album: string;
+    album_art_url: string;
+}

package/dist/types.js

@@ -0,0 +1,14 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from == "object" || typeof from == "function")
+    for (let key of __getOwnPropNames(from))
+      !__hasOwnProp.call(to, key) && key !== except && __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: !0 }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@39choko/lanyard",
+  "description": "A simple Lanyard client.",
+  "version": "1.0.0",
+  "homepage": "https://github.com/39Choko/lanyard",
+  "bugs": "https://github.com/39Choko/lanyard/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/39Choko/lanyard.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "license": "MIT",
+  "author": {
+    "name": "39Choko",
+    "url": "https://github.com/39Choko"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "prettier": "bunx prettier --write .",
+    "test": "bun test",
+    "build": "bun build.ts",
+    "release": "bun run prettier && bun run build && bun run test && bun publish"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./client": {
+      "import": "./dist/client/index.mjs",
+      "require": "./dist/client/index.js",
+      "types": "./dist/client/index.d.ts"
+    },
+    "./api": {
+      "import": "./dist/api/index.mjs",
+      "require": "./dist/api/index.js",
+      "types": "./dist/api/index.d.ts"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.mjs",
+      "require": "./dist/types.js"
+    }
+  },
+  "keywords": [
+    "discord",
+    "lanyard",
+    "presence"
+  ],
+  "devDependencies": {
+    "@39choko/prettier-config": "^1.0.2",
+    "@types/bun": "latest",
+    "esbuild-fix-imports-plugin": "^1.0.23",
+    "prettier": "^3.7.4",
+    "tsup": "^8.5.1"
+  },
+  "peerDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "peerDependenciesMeta": {
+    "@types/bun": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  }
+}