Skip to main content

A Typescript SDK for interacting with Plex Media Server

Works with
This package works with Bun
It is unknown whether this package works with Cloudflare Workers
This package works with Node.js
It is unknown whether this package works with Deno
This package works with Browsers
JSR Score
88%
Published
a month ago (0.13.2)

@lukehagar/plexjs

SDK Installation

NPM

npm add @lukehagar/plexjs

Yarn

yarn add @lukehagar/plexjs

SDK Example Usage

Example

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman",
});

async function run() {
    const result = await plexAPI.server.getServerCapabilities();

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

run();

Available Resources and Operations

server

media

video

activities

butler

hubs

library

log

plex

playlists

authentication

statistics

sessions

updater

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object Status Code Content Type
errors.GetServerCapabilitiesResponseBody 401 application/json
errors.SDKError 4xx-5xx /

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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { PlexAPI } from "@lukehagar/plexjs";
import * as errors from "@lukehagar/plexjs/models/errors";

const plexAPI = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman",
});

async function run() {
    let result;
    try {
        result = await plexAPI.server.getServerCapabilities();
    } catch (err) {
        switch (true) {
            case err instanceof errors.SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof errors.GetServerCapabilitiesResponseBody: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

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

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 {protocol}://{ip}:{port} protocol (default is http), ip (default is 10.10.10.47), port (default is 32400)
import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
    serverIdx: 0,
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman",
});

async function run() {
    const result = await plexAPI.server.getServerCapabilities();

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

run();

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:

  • protocol: models.ServerProtocol
  • ip: string
  • port: string

Override Server URL Per-Client

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

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
    serverURL: "{protocol}://{ip}:{port}",
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman",
});

async function run() {
    const result = await plexAPI.server.getServerCapabilities();

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

run();

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
    xPlexClientIdentifier: "Postman",
});

async function run() {
    const strong = false;
    const xPlexClientIdentifier = "Postman";

    const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier, {
        serverURL: "https://plex.tv/api/v2",
    });

    // 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 { PlexAPI } from "@lukehagar/plexjs";
import { HTTPClient } from "@lukehagar/plexjs/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 PlexAPI({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
accessToken apiKey API key

To authenticate with the API the accessToken parameter must be set when initializing the SDK client instance. For example:

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman",
});

async function run() {
    const result = await plexAPI.server.getServerCapabilities();

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

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Global Parameters

A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set X-Plex-Client-Identifier to "Postman" at SDK initialization and then you do not have to pass the same value on calls to operations like getPin. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available. The required parameter must be set when you initialize the SDK client.

Name Type Required Description
xPlexClientIdentifier string ✔️ The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)

|

Example

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
    xPlexClientIdentifier: "Postman",
});

async function run() {
    const strong = false;
    const xPlexClientIdentifier = "Postman";

    const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier);

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

run();

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Built and signed on
GitHub Actions
View transparency log

Add Package

deno add @lukehagar/plexjs

Import symbol

import * as mod from "@lukehagar/plexjs";

Add Package

npx jsr add @lukehagar/plexjs

Import symbol

import * as mod from "@lukehagar/plexjs";

Add Package

yarn dlx jsr add @lukehagar/plexjs

Import symbol

import * as mod from "@lukehagar/plexjs";

Add Package

pnpm dlx jsr add @lukehagar/plexjs

Import symbol

import * as mod from "@lukehagar/plexjs";

Add Package

bunx jsr add @lukehagar/plexjs

Import symbol

import * as mod from "@lukehagar/plexjs";