jackett, bazarr, ombi: full nox modules (ADR 0044/0046)
Ported their real HTTP APIs (hal carried no client for these). jackett: an indexer proxy — tools only (list indexers, search), no events, no broker account, because it answers queries and has no timeline to observe. bazarr: subtitle tools + emits module.bazarr.subtitle.downloaded (poll history, diff). ombi: request tools + emits request.created/.approved. All pure emitters (their decisions originate here). Typecheck; manifests parse.
This commit is contained in:
@@ -0,0 +1,89 @@
|
||||
// The Jackett API client — jackett's own code, living in the module (novox/hq ADR 0044). Jackett is
|
||||
// an indexer proxy: it normalises many torrent trackers behind one Torznab surface. This client
|
||||
// talks its /api/v2.0 REST API, and only jackett's tools import it.
|
||||
|
||||
export interface JackettIndexer {
|
||||
id: string;
|
||||
name: string;
|
||||
type: string; // "public" | "private" | "semi-public"
|
||||
configured: boolean;
|
||||
siteLink?: string;
|
||||
lastError?: string;
|
||||
}
|
||||
|
||||
export interface JackettResult {
|
||||
title: string;
|
||||
tracker: string;
|
||||
category?: string;
|
||||
size: number;
|
||||
seeders?: number;
|
||||
peers?: number;
|
||||
publishDate?: string;
|
||||
link?: string;
|
||||
}
|
||||
|
||||
export class JackettClient {
|
||||
readonly baseUrl: string;
|
||||
|
||||
constructor(
|
||||
url: string,
|
||||
private readonly apiKey: string,
|
||||
) {
|
||||
this.baseUrl = url.replace(/\/$/, "");
|
||||
}
|
||||
|
||||
/**
|
||||
* Build from the module's resolved environment. Jackett's REST API is keyed, so both the URL and
|
||||
* the key must be present — without them there is nothing to talk to, so this throws and the
|
||||
* module contributes no tools rather than failing half-configured.
|
||||
*/
|
||||
static fromEnv(env: NodeJS.ProcessEnv = process.env): JackettClient {
|
||||
const url = env.MESH_JACKETT_URL;
|
||||
const apiKey = env.MESH_JACKETT_API_KEY;
|
||||
if (!url) throw new Error("no Jackett URL — set MESH_JACKETT_URL");
|
||||
if (!apiKey) throw new Error("no Jackett API key — set MESH_JACKETT_API_KEY");
|
||||
return new JackettClient(url, apiKey);
|
||||
}
|
||||
|
||||
private async get(path: string, params: Record<string, string> = {}): Promise<any> {
|
||||
const url = new URL(`${this.baseUrl}${path}`);
|
||||
url.searchParams.set("apikey", this.apiKey);
|
||||
for (const [k, v] of Object.entries(params)) url.searchParams.set(k, v);
|
||||
const res = await fetch(url.toString(), { headers: { Accept: "application/json" } });
|
||||
if (!res.ok) throw new Error(`Jackett API ${path}: ${res.status} ${await res.text()}`);
|
||||
return res.json();
|
||||
}
|
||||
|
||||
/** The configured indexers Jackett proxies. `configured=false` also lists the ones not set up. */
|
||||
async getIndexers(configuredOnly = true): Promise<JackettIndexer[]> {
|
||||
const raw = await this.get("/api/v2.0/indexers", { configured: configuredOnly ? "true" : "false" });
|
||||
const list = Array.isArray(raw) ? raw : [];
|
||||
return list.map((i: any) => ({
|
||||
id: i.id,
|
||||
name: i.name,
|
||||
type: i.type,
|
||||
configured: i.configured ?? false,
|
||||
siteLink: i.site_link,
|
||||
lastError: i.last_error || undefined,
|
||||
}));
|
||||
}
|
||||
|
||||
/**
|
||||
* A Torznab search across one indexer, or the "all" aggregate. Jackett returns a normalised JSON
|
||||
* result set regardless of the underlying tracker, which is the whole point of the proxy.
|
||||
*/
|
||||
async search(query: string, indexer = "all", limit = 25): Promise<JackettResult[]> {
|
||||
const raw = await this.get(`/api/v2.0/indexers/${encodeURIComponent(indexer)}/results`, { Query: query });
|
||||
const results = Array.isArray(raw?.Results) ? raw.Results : [];
|
||||
return results.slice(0, limit).map((r: any) => ({
|
||||
title: r.Title,
|
||||
tracker: r.Tracker ?? r.TrackerId ?? "unknown",
|
||||
category: Array.isArray(r.CategoryDesc) ? r.CategoryDesc.join(", ") : r.CategoryDesc,
|
||||
size: r.Size ?? 0,
|
||||
seeders: r.Seeders,
|
||||
peers: r.Peers,
|
||||
publishDate: r.PublishDate,
|
||||
link: r.Link ?? r.Details,
|
||||
}));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "@novox/module-jackett",
|
||||
"version": "0.1.0",
|
||||
"description": "jackett — indexer proxy. Its API client and tools live here (novox/hq ADR 0044).",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"@novox/mesh-sdk": "^0.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.0.0",
|
||||
"typescript": "^5.6.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
// jackett's tools — its own code (novox/hq ADR 0044), importing jackett's client. Jackett has
|
||||
// nothing worth watching (an indexer proxy answers queries; it has no timeline of its own), so it
|
||||
// is a tools-only module: no events entrypoint, no broker. What is useful is asking it things.
|
||||
|
||||
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
||||
import { JackettClient } from "../client.js";
|
||||
|
||||
export function getJackettTools(jackett: JackettClient): ToolDefinition[] {
|
||||
return [
|
||||
{
|
||||
name: "jackett_indexers",
|
||||
description: "List the indexers Jackett proxies, with their type and any last error.",
|
||||
input: { all: { type: "boolean", description: "include indexers not yet configured (default false)" } },
|
||||
run: async (args) => {
|
||||
const indexers = await jackett.getIndexers(!args.all);
|
||||
return { count: indexers.length, indexers };
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "jackett_search",
|
||||
description: "Torznab search across Jackett's indexers, returning normalised torrent results.",
|
||||
input: {
|
||||
query: { type: "string", description: "the search query" },
|
||||
indexer: { type: "string", description: 'an indexer id, or "all" to aggregate (default "all")' },
|
||||
limit: { type: "number", description: "max results (default 25)" },
|
||||
},
|
||||
run: async (args) => {
|
||||
const query = String(args.query);
|
||||
const results = await jackett.search(
|
||||
query,
|
||||
args.indexer ? String(args.indexer) : "all",
|
||||
args.limit ? Number(args.limit) : 25,
|
||||
);
|
||||
return { query, count: results.length, results };
|
||||
},
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
// Only exposed when Jackett is configured; otherwise jackett contributes no tools rather than
|
||||
// failing the whole runtime.
|
||||
registerModuleTools("jackett", (env) => {
|
||||
try {
|
||||
return getJackettTools(JackettClient.fromEnv(env));
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"noEmit": true
|
||||
},
|
||||
"include": ["client.ts", "tools/index.ts"]
|
||||
}
|
||||
Reference in New Issue
Block a user