README

plex-sdk

Typescript SDK for Plex and Plex Media Server APIs

Installation

NPM

npm install plex-sdk

Yarn

yarn add plex-sdk

Usage

Plex API

The Plex SDK provides an interface with the Plex official API.

import { Plex, User, Resource } from 'plex-sdk'

const plex = new Plex(
    'c2877b28-1806-42c1-eeea-ac4bc2b9a93d', // uuid.v4
    {
        device: 'Chrome',
        product: 'Your product name',
        version: '1.0.0'
    }
)

plex.users.signIn(username, password).then((user: User) => {
    if (!user.authToken) {
        return Promise.reject(new Error('Login request didn\'t carry a valid token'))
    }

    plex.setAuthorization(user.authToken)

    return plex.resources.all()
}).then((resources: Resource[]) => {
    // do something with the resources
})

Plex Media Server API (PMS)

The Plex Media Server SDK (PMS) provides an interface with your own server where you installed Plex Media Server.

import { PMS, Section } from 'plex-sdk'

const pms = new PMS(
    'https://your-plex-media-server.com:32400',
    'tokenObtainedFromPlexClient'
)

// If the token was not set in the constructor
pms.setAuthorization('tokenObtainedFromPlexClient')

pms.library.allSections().then((response: AllSectionsResponse) => {
    // Do something with the Sections

    return pms.library.allSectionItems(response.MediaContainer.Directory[0].key)
}).then((response: AllSectionItemsResponse) => {
    // list section items (movies, tv shows...)
    console.log(response.MediaContainer.Metadata)
})

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Changelog

See CHANGELOG file for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details

Authors

Ignacio Velazquez

Usage no npm install needed!