@inner-dj/common 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Cory Sanin
+
+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/lib/src/debug-interface.d.ts

@@ -0,0 +1,8 @@
+import type express from 'express';
+import { Payload } from './index.js';
+import type { ClientInterface, Method } from './ireceiver.js';
+export declare class DebugClientInterface implements ClientInterface {
+    sendPayload(payload: Payload): Promise<boolean>;
+    registerRoute(method: Method, route: string, _fn: (req: express.Request, res: express.Response) => any): void;
+    registerGuide(html: string): number;
+}

package/lib/src/debug-interface.js

@@ -0,0 +1,14 @@
+export class DebugClientInterface {
+    async sendPayload(payload) {
+        console.log(`Receiver requested the following:\n`, payload);
+        return true;
+    }
+    registerRoute(method, route, _fn) {
+        console.log(`method: ${method} route: ${route}`);
+    }
+    registerGuide(html) {
+        console.log('registered guide:\n', html);
+        return 1;
+    }
+}
+//# sourceMappingURL=debug-interface.js.map

package/lib/src/debug-interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug-interface.js","sourceRoot":"","sources":["../../src/debug-interface.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,oBAAoB;IAC7B,KAAK,CAAC,WAAW,CAAC,OAAgB;QAC9B,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,aAAa,CAAC,MAAc,EAAE,KAAa,EAAE,GAAyD;QAClG,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,WAAW,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,aAAa,CAAC,IAAY;QACtB,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;QACzC,OAAO,CAAC,CAAC;IACb,CAAC;CACJ"}

package/lib/src/index.d.ts

@@ -0,0 +1,61 @@
+import { type ytdlpOptions, type sponsorblock, ytdlpDefaults, ytdlpExec, ytdlp } from './yt-dlp.js';
+import { iReceiver, type iReceiverConfig, type iReceiverStatic, type ClientInterface, type Method } from './ireceiver.js';
+import { DebugClientInterface } from './debug-interface.js';
+export type YouTubeVideoID = string;
+export type { ytdlpOptions, sponsorblock };
+export { ytdlpDefaults, ytdlpExec, ytdlp };
+export type { iReceiverConfig, iReceiverStatic, ClientInterface, Method };
+export { iReceiver };
+export { DebugClientInterface };
+/**
+ * Encodes a payload to be sent over a socket
+ * @param payload any valid payload
+ * @param jwtSecret the JWT secret for signing
+ * @returns string ready to be sent
+ */
+export declare function encodePayload(payload: Payload, jwtSecret: string): string;
+/**
+ * parseint with wider range of accepted input types
+ * @param v input to parse
+ * @returns a number (or not a number)
+ */
+export declare function notStupidParseInt(v: string | number | undefined): number;
+/**
+ * Get a boolean config value
+ * @param envname environment variable to check
+ * @param cfg object that might have $key
+ * @param key key from the input object
+ * @param fallback the default value
+ * @returns computed boolean from the given sources
+ */
+export declare function getBoolean<T>(envname: string, cfg: Partial<T> | undefined, key: keyof T, fallback: boolean): boolean;
+/**
+ * Throw an error inline
+ * @param msg error message
+ */
+export declare function throwNewError<T>(msg: string): T;
+export type Payload = RegistrationPayload | AckPayload | NowPlayingPayload | SkipPayload | QueuePayload;
+export interface PayloadBase {
+    type: string;
+    body?: any;
+}
+export interface AckPayload extends PayloadBase {
+    type: 'ack';
+    body?: never;
+}
+export interface RegistrationPayload extends PayloadBase {
+    type: 'reg';
+    body: string;
+}
+export interface NowPlayingPayload extends PayloadBase {
+    type: 'nowPlaying';
+    body: string;
+}
+export interface SkipPayload extends PayloadBase {
+    type: 'skip';
+    body?: never;
+}
+export interface QueuePayload extends PayloadBase {
+    type: 'queue';
+    body: string;
+}

package/lib/src/index.js

@@ -0,0 +1,46 @@
+import { ytdlpDefaults, ytdlpExec, ytdlp } from './yt-dlp.js';
+import jwt from 'jsonwebtoken';
+import { iReceiver } from './ireceiver.js';
+import { DebugClientInterface } from './debug-interface.js';
+export { ytdlpDefaults, ytdlpExec, ytdlp };
+export { iReceiver };
+export { DebugClientInterface };
+/**
+ * Encodes a payload to be sent over a socket
+ * @param payload any valid payload
+ * @param jwtSecret the JWT secret for signing
+ * @returns string ready to be sent
+ */
+export function encodePayload(payload, jwtSecret) {
+    return jwt.sign(JSON.stringify(payload), jwtSecret);
+}
+/**
+ * parseint with wider range of accepted input types
+ * @param v input to parse
+ * @returns a number (or not a number)
+ */
+export function notStupidParseInt(v) {
+    if (typeof v === 'number') {
+        return v;
+    }
+    return v === undefined ? NaN : parseInt(v);
+}
+/**
+ * Get a boolean config value
+ * @param envname environment variable to check
+ * @param cfg object that might have $key
+ * @param key key from the input object
+ * @param fallback the default value
+ * @returns computed boolean from the given sources
+ */
+export function getBoolean(envname, cfg, key, fallback) {
+    return (process.env[envname] ?? `${cfg?.[key] ?? fallback}`) === 'true';
+}
+/**
+ * Throw an error inline
+ * @param msg error message
+ */
+export function throwNewError(msg) {
+    throw new Error(msg);
+}
+//# sourceMappingURL=index.js.map

package/lib/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpG,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAiF,MAAM,gBAAgB,CAAC;AAC1H,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAI5D,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,CAAC;AACrB,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,OAAgB,EAAE,SAAiB;IAC7D,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,CAA8B;IAC5D,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QACxB,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAI,OAAe,EAAE,GAA2B,EAAE,GAAY,EAAE,QAAiB;IACvG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,QAAQ,EAAE,CAAC,KAAK,MAAM,CAAC;AAC5E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAI,GAAW;IACxC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC"}

package/lib/src/ireceiver.d.ts

@@ -0,0 +1,25 @@
+import type express from 'express';
+import type { Payload } from "./index.js";
+export type Method = "all" | "get" | "post" | "put" | "delete" | "patch" | "options" | "head";
+export interface ClientInterface {
+    sendPayload(payload: Payload): Promise<boolean>;
+    registerRoute(method: Method, route: string, fn: (req: express.Request, res: express.Response, next?: express.NextFunction) => any): any;
+    registerGuide(html: string): number;
+}
+export interface iReceiverConfig {
+    enabled: boolean;
+}
+export interface iReceiverStatic<T extends iReceiverConfig> {
+    new (config: T, web: ClientInterface): iReceiver<T>;
+    getConfig(cfg?: Partial<T>): T;
+}
+export declare abstract class iReceiver<T extends iReceiverConfig> {
+    protected config: T;
+    private web;
+    constructor(config: T, web: ClientInterface);
+    request: (url: string) => Promise<boolean>;
+    registerRoute: (method: Method, route: string, handler: (req: express.Request, res: express.Response, next?: express.NextFunction) => any) => void;
+    registerGuide: (html: string) => number;
+    start: () => void;
+    close: () => void;
+}

package/lib/src/ireceiver.js

@@ -0,0 +1,24 @@
+;
+export class iReceiver {
+    config;
+    web;
+    constructor(config, web) {
+        this.config = config;
+        this.web = web;
+    }
+    request = (url) => {
+        return this.web.sendPayload({
+            type: 'queue',
+            body: url
+        });
+    };
+    registerRoute = (method, route, handler) => {
+        this.web.registerRoute(method, route, handler);
+    };
+    registerGuide = (html) => {
+        return this.web.registerGuide(html);
+    };
+    start = () => { };
+    close = () => { };
+}
+//# sourceMappingURL=ireceiver.js.map

package/lib/src/ireceiver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ireceiver.js","sourceRoot":"","sources":["../../src/ireceiver.ts"],"names":[],"mappings":"AAaC,CAAC;AAOF,MAAM,OAAgB,SAAS;IACjB,MAAM,CAAI;IACZ,GAAG,CAAkB;IAE7B,YAAY,MAAS,EAAE,GAAoB;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACnB,CAAC;IAED,OAAO,GAAG,CAAC,GAAW,EAAE,EAAE;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC;YACxB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,GAAG;SACZ,CAAC,CAAC;IACP,CAAC,CAAA;IAED,aAAa,GAAG,CAAC,MAAc,EAAE,KAAa,EAAE,OAA0F,EAAE,EAAE;QAC1I,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC,CAAA;IAED,aAAa,GAAG,CAAC,IAAY,EAAE,EAAE;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC,CAAA;IAED,KAAK,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;IAClB,KAAK,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;CACrB"}

package/lib/src/yt-dlp.d.ts

@@ -0,0 +1,17 @@
+export type sponsorblock = 'sponsor' | 'selfpromo' | 'interaction' | 'intro' | 'outro' | 'preview' | 'hook' | 'filler' | 'music_offtopic';
+export interface ytdlpOptions {
+    sponsorblock?: sponsorblock[];
+    sponsorblockAPI?: string;
+    optput?: string;
+    audioOnly?: boolean;
+    audioFormat?: string;
+    audioQuality?: number;
+    restrictFilenames?: boolean;
+}
+export declare const ytdlpDefaults: ytdlpOptions;
+export declare function ytdlpExec(options: ytdlpOptions, url: string): Promise<void>;
+export declare class ytdlp {
+    private options;
+    constructor(options: ytdlpOptions);
+    exec(url: string): Promise<void>;
+}

package/lib/src/yt-dlp.js

@@ -0,0 +1,44 @@
+import { spawn } from 'spawn-but-with-promises';
+;
+export const ytdlpDefaults = {
+    sponsorblock: ['sponsor', 'selfpromo', 'interaction', 'music_offtopic'],
+    optput: '%(id)s.%(title)s.%(ext)s',
+    audioOnly: true,
+    restrictFilenames: true,
+};
+export async function ytdlpExec(options, url) {
+    const args = [];
+    if (options.sponsorblock?.length) {
+        args.push('--sponsorblock-remove', options.sponsorblock.join(','));
+    }
+    if (options.sponsorblockAPI) {
+        args.push('--sponsorblock-api', options.sponsorblockAPI);
+    }
+    if (options.restrictFilenames) {
+        args.push('--restrict-filenames');
+    }
+    if (options.optput) {
+        args.push('-o', options.optput);
+    }
+    if (options.audioOnly) {
+        args.push('-x');
+        if (options.audioFormat) {
+            args.push('--audio-format', options.audioFormat);
+        }
+        if (typeof options.audioQuality === 'number') {
+            args.push('--audio-quality', `${options.audioQuality}`);
+        }
+    }
+    args.push(url);
+    await spawn('yt-dlp', args, { rejectOnNonZero: true });
+}
+export class ytdlp {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    exec(url) {
+        return ytdlpExec(this.options, url);
+    }
+}
+//# sourceMappingURL=yt-dlp.js.map

package/lib/src/yt-dlp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yt-dlp.js","sourceRoot":"","sources":["../../src/yt-dlp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAY/C,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAiB;IACvC,YAAY,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,CAAC;IACvE,MAAM,EAAE,0BAA0B;IAClC,SAAS,EAAE,IAAI;IACf,iBAAiB,EAAE,IAAI;CAC1B,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAqB,EAAE,GAAW;IAC9D,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEf,MAAM,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,OAAO,KAAK;IACN,OAAO,CAAe;IAE9B,YAAY,OAAqB;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,CAAC,GAAW;QACZ,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;CACJ"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@inner-dj/common",
+  "version": "0.0.3",
+  "description": "common component of inner-dj",
+  "repository": {
+    "type": "git",
+    "url": "https://codeberg.org/sanin/inner-dj.git"
+  },
+  "license": "MIT",
+  "author": "Cory Sanin",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./lib/src/index.d.ts",
+      "import": "./lib/src/index.js"
+    }
+  },
+  "main": "./lib/src/index.js",
+  "types": "./lib/src/index.d.ts",
+  "files": [
+    "lib/src",
+    "!lib/**/*.js.map"
+  ],
+  "dependencies": {
+    "jsonwebtoken": "9.0.3",
+    "spawn-but-with-promises": "^1.0.4"
+  },
+  "devDependencies": {
+    "@sindresorhus/tsconfig": "8.1.0",
+    "@types/express": "^5.0.6",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/node": "^24.12.4",
+    "express": "^5.2.1",
+    "typescript": "^6.0.3"
+  },
+  "scripts": {
+    "build": "tsc"
+  }
+}