LukeParke/Prowlarr-TS-SDK
1
0
Fork 0
mirror of https://github.com/LukeHagar/Prowlarr-TS-SDK.git synced 2025-12-06 04:21:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
aff78fa081acc6bd665fd9ea0bd8afd20253c638
Prowlarr-TS-SDK/README.md

37 KiB
Raw Blame History

Prowlarr-TS-SDK

Prowlarr-TS-SDK

Summary

Prowlarr: Prowlarr API docs

Table of Contents

SDK Installation

Tip

To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add https://github.com/LukeHagar/Prowlarr-TS-SDK

PNPM

pnpm add https://github.com/LukeHagar/Prowlarr-TS-SDK

Bun

bun add https://github.com/LukeHagar/Prowlarr-TS-SDK

Yarn

yarn add https://github.com/LukeHagar/Prowlarr-TS-SDK zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Note

This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Prowlarr": {
      "command": "npx",
      "args": [
        "-y", "--package", "prowlarr",
        "--",
        "mcp", "start",
        "--x-api-key", "...",
        "--apikey", "..."
      ]
    }
  }
}
Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Prowlarr": {
      "command": "npx",
      "args": [
        "-y", "--package", "prowlarr",
        "--",
        "mcp", "start",
        "--x-api-key", "...",
        "--apikey", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package prowlarr -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const result = await prowlarr.apiInfo.getApi();

  // Handle the result
  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme Environment Variable
xApiKey apiKey API key PROWLARR_X_API_KEY
apikey apiKey API key PROWLARR_APIKEY

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const result = await prowlarr.apiInfo.getApi();

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

apiInfo

application

appProfile

authentication

backup

command

customFilter

developmentConfig

downloadClient

downloadClientConfig

fileSystem

health

history

hostConfig

indexer

indexerDefaultCategories

indexerProxy

indexerStats

indexerStatus

localization

log

logFile

newznab

notification

ping

search

staticResource

system

tag

tagDetails

task

uiConfig

update

updateLogFile

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const result = await prowlarr.apiInfo.getApi({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const result = await prowlarr.apiInfo.getApi();

  // Handle the result
  console.log(result);
}

run();

Error Handling

If the request fails due to, for example 4XX or 5XX status codes, it will throw a APIError.

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */* 
import { Prowlarr } from "prowlarr";
import { SDKValidationError } from "prowlarr/models/errors";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  let result;
  try {
    result = await prowlarr.apiInfo.getApi();

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError):
        {
          // Pretty-print will provide a human-readable multi-line error message
          console.error(err.pretty());
          // Raw value may also be inspected
          console.error(err.rawValue);
          return;
        }
        apierror.js;
      // Server returned an error status code or an unknown content type
      case (err instanceof APIError): {
        console.error(err.statusCode);
        console.error(err.rawResponse.body);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client Error Description
RequestAbortedError HTTP request was aborted by the client
RequestTimeoutError HTTP request timed out due to an AbortSignal signal
ConnectionError HTTP client was unable to make a request to a server
InvalidRequestError Any input used to create a request is invalid
UnexpectedClientError Unrecognised or unexpected error

Server Selection

Server Variables

The default server {protocol}://{hostpath} contains variables and is set to http://localhost:9696 by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable Parameter Supported Values Default Description
protocol protocol: models.ServerProtocol - "http"
- "https"		 "http"
hostpath hostpath: string string "localhost:9696"

Example

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  protocol: "https",
  hostpath: "<value>",
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const result = await prowlarr.apiInfo.getApi();

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  serverURL: "http://localhost:9696",
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const result = await prowlarr.apiInfo.getApi();

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Prowlarr } from "prowlarr";
import { HTTPClient } from "prowlarr/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Prowlarr({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Prowlarr } from "prowlarr";

const sdk = new Prowlarr({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable PROWLARR_DEBUG to true.