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,104 @@
|
||||
// The Ombi API client — ombi's own code, living in the module (novox/hq ADR 0044). Ombi is the
|
||||
// request front-end: viewers ask for movies and shows, and an operator approves them. This client
|
||||
// talks its /api/v1 REST API (keyed by an ApiKey header); ombi's tools and events import it.
|
||||
|
||||
export interface OmbiRequest {
|
||||
kind: "movie" | "tv";
|
||||
id: number;
|
||||
title: string;
|
||||
requestedBy?: string;
|
||||
requestedDate?: string;
|
||||
approved: boolean;
|
||||
available: boolean;
|
||||
denied: boolean;
|
||||
tmdbId?: number;
|
||||
}
|
||||
|
||||
export interface RequestCounts {
|
||||
pending: number;
|
||||
approved: number;
|
||||
available: number;
|
||||
}
|
||||
|
||||
export class OmbiClient {
|
||||
readonly baseUrl: string;
|
||||
|
||||
constructor(
|
||||
url: string,
|
||||
private readonly apiKey: string,
|
||||
) {
|
||||
this.baseUrl = url.replace(/\/$/, "");
|
||||
}
|
||||
|
||||
/** Build from the module's resolved environment. Ombi's API is keyed; without URL and key there
|
||||
* is nothing to talk to, so this throws rather than run half-configured. */
|
||||
static fromEnv(env: NodeJS.ProcessEnv = process.env): OmbiClient {
|
||||
const url = env.MESH_OMBI_URL;
|
||||
const apiKey = env.MESH_OMBI_API_KEY;
|
||||
if (!url) throw new Error("no Ombi URL — set MESH_OMBI_URL");
|
||||
if (!apiKey) throw new Error("no Ombi API key — set MESH_OMBI_API_KEY");
|
||||
return new OmbiClient(url, apiKey);
|
||||
}
|
||||
|
||||
private async request(method: string, path: string, body?: unknown): Promise<any> {
|
||||
const res = await fetch(`${this.baseUrl}/api/v1${path}`, {
|
||||
method,
|
||||
headers: {
|
||||
ApiKey: this.apiKey,
|
||||
Accept: "application/json",
|
||||
...(body !== undefined ? { "Content-Type": "application/json" } : {}),
|
||||
},
|
||||
body: body !== undefined ? JSON.stringify(body) : undefined,
|
||||
});
|
||||
if (!res.ok) throw new Error(`Ombi API ${method} ${path}: ${res.status} ${await res.text()}`);
|
||||
const text = await res.text();
|
||||
return text ? JSON.parse(text) : {};
|
||||
}
|
||||
|
||||
/** All requests, movies and TV together — who asked for what, and where each stands. */
|
||||
async getRequests(): Promise<OmbiRequest[]> {
|
||||
const [movies, tv] = await Promise.all([
|
||||
this.request("GET", "/Request/movie"),
|
||||
this.request("GET", "/Request/tv"),
|
||||
]);
|
||||
const films: OmbiRequest[] = (Array.isArray(movies) ? movies : []).map((r: any) => ({
|
||||
kind: "movie" as const,
|
||||
id: r.id,
|
||||
title: r.title ?? "Unknown",
|
||||
requestedBy: r.requestedUser?.userName ?? r.requestedUser?.userAlias,
|
||||
requestedDate: r.requestedDate,
|
||||
approved: Boolean(r.approved),
|
||||
available: Boolean(r.available),
|
||||
denied: Boolean(r.denied),
|
||||
tmdbId: r.theMovieDbId,
|
||||
}));
|
||||
// TV requests carry per-season child requests; the top-level record is approved when all its
|
||||
// children are, which is the grain an operator acts on.
|
||||
const shows: OmbiRequest[] = (Array.isArray(tv) ? tv : []).map((r: any) => {
|
||||
const children: any[] = r.childRequests ?? [];
|
||||
return {
|
||||
kind: "tv" as const,
|
||||
id: r.id,
|
||||
title: r.title ?? "Unknown",
|
||||
requestedBy: children[0]?.requestedUser?.userName,
|
||||
requestedDate: children[0]?.requestedDate,
|
||||
approved: children.length > 0 && children.every((c) => c.approved),
|
||||
available: children.length > 0 && children.every((c) => c.available),
|
||||
denied: children.some((c) => c.denied),
|
||||
tmdbId: r.theMovieDbId,
|
||||
};
|
||||
});
|
||||
return [...films, ...shows];
|
||||
}
|
||||
|
||||
/** Live pending/approved/available counts — a one-line health read without listing everything. */
|
||||
async getCounts(): Promise<RequestCounts> {
|
||||
const c = await this.request("GET", "/Request/count");
|
||||
return { pending: c.pending ?? 0, approved: c.approved ?? 0, available: c.available ?? 0 };
|
||||
}
|
||||
|
||||
/** Approve a request. TV approval fans out to the request's child (per-season) requests. */
|
||||
async approve(kind: "movie" | "tv", id: number): Promise<void> {
|
||||
await this.request("POST", `/Request/${kind}/approve`, { id });
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
// ombi's events. The tool runtime imports this once the broker is bound. Ombi's timeline is the
|
||||
// request lifecycle: a viewer files a request, and later an operator approves it. Both transitions
|
||||
// are worth announcing — the mesh can notify on a new request, and act on an approval (that is when
|
||||
// a downloader should start looking).
|
||||
//
|
||||
// Emits (novox/hq ADR 0046/0047):
|
||||
// module.ombi.request.created — a viewer filed a new request
|
||||
// module.ombi.request.approved — a request was approved
|
||||
//
|
||||
// Ombi is the origin of these decisions, not a reactor to the mesh, so it consumes nothing.
|
||||
//
|
||||
// Both events are observation-based: poll the request list and diff. Creation is diffed on the set
|
||||
// of request ids; approval on each request's approved flag flipping true. Primed silently on the
|
||||
// first look, or a restart would re-announce every existing request and approval.
|
||||
|
||||
import { emit } from "@novox/mesh-sdk/events";
|
||||
import { OmbiClient, type OmbiRequest } from "./client.js";
|
||||
|
||||
const ombi = OmbiClient.fromEnv();
|
||||
|
||||
// Remember each seen request and whether it was approved last time, keyed by kind+id (ids are only
|
||||
// unique within a kind).
|
||||
const approvedState = new Map<string, boolean>();
|
||||
let primed = false;
|
||||
|
||||
const keyOf = (r: OmbiRequest): string => `${r.kind}:${r.id}`;
|
||||
|
||||
async function pollRequests(): Promise<void> {
|
||||
const requests = await ombi.getRequests();
|
||||
for (const r of requests) {
|
||||
const key = keyOf(r);
|
||||
const known = approvedState.has(key);
|
||||
if (primed && !known) {
|
||||
await emit("module.ombi.request.created", {
|
||||
kind: r.kind,
|
||||
id: r.id,
|
||||
title: r.title,
|
||||
requestedBy: r.requestedBy,
|
||||
tmdbId: r.tmdbId,
|
||||
});
|
||||
}
|
||||
// Approval: the flag went from false to true for a request we already knew about.
|
||||
if (primed && known && r.approved && approvedState.get(key) === false) {
|
||||
await emit("module.ombi.request.approved", { kind: r.kind, id: r.id, title: r.title, tmdbId: r.tmdbId });
|
||||
}
|
||||
approvedState.set(key, r.approved);
|
||||
}
|
||||
primed = true;
|
||||
}
|
||||
|
||||
const tick = (fn: () => Promise<void>, everyMs: number): void => {
|
||||
const run = (): void => void fn().catch((err) => console.error(`[ombi] ${err}`));
|
||||
setInterval(run, everyMs);
|
||||
run();
|
||||
};
|
||||
tick(pollRequests, 30_000);
|
||||
|
||||
console.log("[ombi] watching requests for new filings and approvals");
|
||||
@@ -4,6 +4,13 @@
|
||||
"capabilities": [
|
||||
"container-runtime"
|
||||
],
|
||||
"emits": [
|
||||
"module.ombi.request.created",
|
||||
"module.ombi.request.approved"
|
||||
],
|
||||
"own-secrets": {
|
||||
"broker": "/var/lib/ombi/broker"
|
||||
},
|
||||
"listens": [
|
||||
{
|
||||
"port": 3579,
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "@novox/module-ombi",
|
||||
"version": "0.1.0",
|
||||
"description": "ombi — media requests. Its API client, tools and events 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,46 @@
|
||||
// ombi's tools — its own code (novox/hq ADR 0044), importing ombi's client. They return structured
|
||||
// data; the mesh serves them through the sdk's tool harness.
|
||||
|
||||
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
||||
import { OmbiClient } from "../client.js";
|
||||
|
||||
export function getOmbiTools(ombi: OmbiClient): ToolDefinition[] {
|
||||
return [
|
||||
{
|
||||
name: "ombi_requests",
|
||||
description: "List media requests — movies and shows — with who asked and whether each is approved or available.",
|
||||
input: { pending: { type: "boolean", description: "only requests not yet approved (default false)" } },
|
||||
run: async (args) => {
|
||||
let requests = await ombi.getRequests();
|
||||
if (args.pending) requests = requests.filter((r) => !r.approved && !r.denied);
|
||||
const counts = await ombi.getCounts();
|
||||
return { counts, count: requests.length, requests };
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "ombi_approve",
|
||||
description: "Approve a media request by its kind and id (from ombi_requests).",
|
||||
input: {
|
||||
kind: { type: "string", description: '"movie" or "tv"' },
|
||||
id: { type: "number", description: "the request id" },
|
||||
},
|
||||
run: async (args) => {
|
||||
const kind = String(args.kind);
|
||||
if (kind !== "movie" && kind !== "tv") throw new Error('kind must be "movie" or "tv"');
|
||||
const id = Number(args.id);
|
||||
await ombi.approve(kind, id);
|
||||
return { approved: { kind, id } };
|
||||
},
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
// Exposed only when Ombi is configured; otherwise ombi contributes no tools rather than failing the
|
||||
// whole runtime.
|
||||
registerModuleTools("ombi", (env) => {
|
||||
try {
|
||||
return getOmbiTools(OmbiClient.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", "index.ts", "tools/index.ts"]
|
||||
}
|
||||
Reference in New Issue
Block a user