@ctrl/nzbget 0.0.1

package/dist/src/nzbget.js

@@ -0,0 +1,341 @@
+import { UsenetNotFoundError, } from '@ctrl/shared-usenet';
+import { ofetch } from 'ofetch';
+import { joinURL } from 'ufo';
+import { stringToBase64, stringToUint8Array, uint8ArrayToBase64 } from 'uint8array-extras';
+import { configItemsToMap, deriveCategories, deriveScripts, normalizeNzbgetHistoryItem, normalizeNzbgetJob, normalizeNzbgetStatus, normalizedPriorityToNzbget, } from './normalizeUsenetData.js';
+const defaults = {
+    baseUrl: 'http://localhost:6789/',
+    path: '/jsonrpc',
+    username: 'nzbget',
+    password: 'tegbzn6789',
+    timeout: 5000,
+};
+function encodeBasicAuth(username, password) {
+    return stringToBase64(`${username}:${password}`);
+}
+function normalizeIds(ids) {
+    const values = Array.isArray(ids) ? ids : [ids];
+    return values.map(value => Number.parseInt(`${value}`, 10)).filter(value => !Number.isNaN(value));
+}
+function toBase64(input) {
+    return uint8ArrayToBase64(typeof input === 'string' ? stringToUint8Array(input) : input);
+}
+async function sleep(milliseconds) {
+    await new Promise(resolve => {
+        setTimeout(resolve, milliseconds);
+    });
+}
+export class Nzbget {
+    static createFromState(config, state) {
+        const client = new Nzbget(config);
+        client.state = { ...state };
+        return client;
+    }
+    config;
+    state = {};
+    constructor(options = {}) {
+        this.config = { ...defaults, ...options };
+    }
+    exportState() {
+        return JSON.parse(JSON.stringify(this.state));
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/version | version}. */
+    async getVersion() {
+        const version = await this.rpc('version');
+        this.state.version = { version };
+        return version;
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/shutdown | shutdown}. */
+    async shutdown() {
+        return this.rpc('shutdown');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/reload | reload}. */
+    async reload() {
+        return this.rpc('reload');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/status | status}. */
+    async status() {
+        return this.rpc('status');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/listgroups | listgroups}. */
+    async listGroups() {
+        return this.rpc('listgroups', [0]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/history | history}. */
+    async history(hidden = false) {
+        return this.rpc('history', [hidden]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/config | config}. */
+    async getConfig() {
+        const items = await this.rpc('config');
+        return configItemsToMap(items);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/configtemplates | configtemplates}. */
+    async configTemplates(loadFromDisk = false) {
+        return this.rpc('configtemplates', [loadFromDisk]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/listfiles | listfiles}. */
+    async listFiles(id) {
+        return this.rpc('listfiles', [0, 0, Number.parseInt(`${id}`, 10)]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/pausedownload | pausedownload}. */
+    async pauseDownload() {
+        return this.rpc('pausedownload');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/resumedownload | resumedownload}. */
+    async resumeDownload() {
+        return this.rpc('resumedownload');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/pausepost | pausepost}. */
+    async pausePost() {
+        return this.rpc('pausepost');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/resumepost | resumepost}. */
+    async resumePost() {
+        return this.rpc('resumepost');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/pausescan | pausescan}. */
+    async pauseScan() {
+        return this.rpc('pausescan');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/resumescan | resumescan}. */
+    async resumeScan() {
+        return this.rpc('resumescan');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/scheduleresume | scheduleresume}. */
+    async scheduleResume(seconds) {
+        return this.rpc('scheduleresume', [seconds]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/rate | rate}. */
+    async setRate(limitBytesPerSecond) {
+        return this.rpc('rate', [limitBytesPerSecond]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/append | append}. */
+    async append(name, contentOrUrl, options = {}) {
+        return this.rpc('append', [
+            name,
+            contentOrUrl,
+            options.category ?? '',
+            options.priority ?? 0,
+            options.addToTop ?? false,
+            options.addPaused ?? false,
+            options.dupeKey ?? '',
+            options.dupeScore ?? 0,
+            options.dupeMode ?? 'all',
+            options.ppParameters ?? [],
+        ]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/editqueue | editqueue}. */
+    async editQueue(command, parameter, ids) {
+        const normalizedIds = normalizeIds(ids);
+        try {
+            return await this.rpc('editqueue', [command, `${parameter}`, normalizedIds]);
+        }
+        catch {
+            return this.rpc('editqueue', [command, 0, `${parameter}`, normalizedIds]);
+        }
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/scan | scan}. */
+    async scan() {
+        return this.rpc('scan');
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/log | log}. */
+    async log(idFrom, numberOfEntries) {
+        return this.rpc('log', [idFrom, numberOfEntries]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/writelog | writelog}. */
+    async writeLog(kind, text) {
+        return this.rpc('writelog', [kind, text]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/loadlog | loadlog}. */
+    async loadLog(nzbId, idFrom, numberOfEntries) {
+        return this.rpc('loadlog', [
+            Number.parseInt(`${nzbId}`, 10),
+            idFrom,
+            numberOfEntries,
+        ]);
+    }
+    /** Calls {@link https://nzbget-ng.github.io/api/servervolumes | servervolumes}. */
+    async serverVolumes() {
+        return this.rpc('servervolumes');
+    }
+    async getCategories() {
+        return deriveCategories(await this.getConfig());
+    }
+    async getScripts() {
+        return deriveScripts(await this.configTemplates());
+    }
+    async pauseQueue() {
+        return this.pauseDownload();
+    }
+    async resumeQueue() {
+        return this.resumeDownload();
+    }
+    async pauseJob(id) {
+        return this.editQueue('GroupPause', '', id);
+    }
+    async resumeJob(id) {
+        return this.editQueue('GroupResume', '', id);
+    }
+    async removeJob(id, removeData = false) {
+        return this.editQueue(removeData ? 'GroupFinalDelete' : 'GroupDelete', '', id);
+    }
+    async moveJob(id, position) {
+        const queue = await this.listGroups();
+        const rawId = Number.parseInt(id, 10);
+        const currentIndex = queue.findIndex(item => item.NZBID === rawId);
+        if (currentIndex === -1) {
+            throw new UsenetNotFoundError('nzbget', 'queueJob', id);
+        }
+        if (!Number.isFinite(position)) {
+            throw new TypeError('Invalid queue position');
+        }
+        if (position <= 0) {
+            return this.editQueue('GroupMoveTop', '', id);
+        }
+        if (position >= queue.length - 1) {
+            return this.editQueue('GroupMoveBottom', '', id);
+        }
+        const offset = position - currentIndex;
+        if (offset === 0) {
+            return true;
+        }
+        return this.editQueue('GroupMoveOffset', offset, id);
+    }
+    async setCategory(id, category) {
+        return this.editQueue('GroupApplyCategory', category, id);
+    }
+    async setPriority(id, priority) {
+        return this.editQueue('GroupSetPriority', normalizedPriorityToNzbget(priority), id);
+    }
+    async addNzbFile(nzb, options = {}) {
+        const id = await this.append(options.name ?? 'upload.nzb', toBase64(nzb), {
+            category: options.category ?? '',
+            priority: normalizedPriorityToNzbget(options.priority),
+            addPaused: options.startPaused ?? false,
+        });
+        return `${id}`;
+    }
+    async addNzbUrl(url, options = {}) {
+        const id = await this.append(options.name ?? url, url, {
+            category: options.category ?? '',
+            priority: normalizedPriorityToNzbget(options.priority),
+            addPaused: options.startPaused ?? false,
+        });
+        return `${id}`;
+    }
+    async getQueue() {
+        const [status, groups] = await Promise.all([this.status(), this.listGroups()]);
+        return groups.map((item, index) => normalizeNzbgetJob(item, status, index));
+    }
+    async getHistory() {
+        const history = await this.history();
+        return history.map(normalizeNzbgetHistoryItem);
+    }
+    async getQueueJob(id) {
+        const rawId = Number.parseInt(id, 10);
+        const [status, groups] = await Promise.all([this.status(), this.listGroups()]);
+        const index = groups.findIndex(group => group.NZBID === rawId);
+        const group = index === -1 ? undefined : groups[index];
+        if (!group) {
+            throw new UsenetNotFoundError('nzbget', 'queueJob', id);
+        }
+        return normalizeNzbgetJob(group, status, index);
+    }
+    async getHistoryJob(id) {
+        const rawId = Number.parseInt(id, 10);
+        const history = await this.history();
+        const historyItem = history.find(item => item.ID === rawId);
+        if (!historyItem) {
+            throw new UsenetNotFoundError('nzbget', 'historyJob', id);
+        }
+        return normalizeNzbgetHistoryItem(historyItem);
+    }
+    async findJob(id) {
+        const rawId = Number.parseInt(id, 10);
+        const [status, groups] = await Promise.all([this.status(), this.listGroups()]);
+        const index = groups.findIndex(group => group.NZBID === rawId);
+        const group = index === -1 ? undefined : groups[index];
+        if (group) {
+            return {
+                source: 'queue',
+                job: normalizeNzbgetJob(group, status, index),
+            };
+        }
+        const history = await this.history();
+        const historyItem = history.find(item => item.ID === rawId);
+        if (historyItem) {
+            return {
+                source: 'history',
+                job: normalizeNzbgetHistoryItem(historyItem),
+            };
+        }
+        return null;
+    }
+    async getAllData() {
+        const [status, groups, history, categories, scripts] = await Promise.all([
+            this.status(),
+            this.listGroups(),
+            this.history(),
+            this.getCategories(),
+            this.getScripts(),
+        ]);
+        return {
+            categories,
+            scripts,
+            queue: groups.map((item, index) => normalizeNzbgetJob(item, status, index)),
+            history: history.map(normalizeNzbgetHistoryItem),
+            status: normalizeNzbgetStatus(status),
+            raw: {
+                status,
+                groups,
+                history,
+            },
+        };
+    }
+    async normalizedAddNzb(input, options = {}) {
+        const id = 'url' in input
+            ? await this.addNzbUrl(input.url, options)
+            : await this.addNzbFile(input.file, options);
+        const rawId = Number.parseInt(id, 10);
+        if (rawId <= 0) {
+            throw new Error('NZBGet did not return a queue id');
+        }
+        for (let attempt = 0; attempt < 10; attempt++) {
+            const [status, groups] = await Promise.all([this.status(), this.listGroups()]);
+            const index = groups.findIndex(group => group.NZBID === rawId);
+            const group = index === -1 ? undefined : groups[index];
+            if (group) {
+                return normalizeNzbgetJob(group, status, index);
+            }
+            await sleep(250);
+        }
+        throw new Error('Unable to load newly added NZBGet job');
+    }
+    async rpc(method, params = []) {
+        const url = joinURL(this.config.baseUrl, this.config.path ?? '/jsonrpc');
+        const username = this.config.username ?? '';
+        const password = this.config.password ?? '';
+        const headers = username || password
+            ? {
+                Authorization: `Basic ${encodeBasicAuth(username, password)}`,
+            }
+            : undefined;
+        const response = await ofetch(url, {
+            method: 'POST',
+            headers,
+            body: {
+                jsonrpc: '2.0',
+                method,
+                params,
+                id: Date.now(),
+            },
+            dispatcher: this.config.dispatcher,
+            timeout: this.config.timeout,
+        });
+        if (response.error) {
+            throw new Error(response.error.message);
+        }
+        return response.result;
+    }
+}