Typescript SDK for
Plex
andPlex Media Server
APIs
Add the library to your package.json
:
"dependencies": {
"plex-sdk": "^2.0.1"
}
Or download the repo itself in case you wanna take a deeper look:
git clone git@github.com:nass600/plex-sdk
cd plex-sdk
npm install
This SDK provides an interface to interact with two services: plex.tv
(Plex API) and your own plex media server
(generally hosted at https://your-host.com:32400
) (PMS API).
Both are secured APIs and, in order to interact with your PMS
you need to request an authToken
provided by the
plex.tv
upon username/password login.
The Plex
SDK provides an interface with the Plex service (https://www.plex.tv/
).
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
})
The Plex Media Server
SDK (PMS) provides an interface with your own server where you installed the Plex Media Server.
You can download the lates version of the Plex Media Server for the official page
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)
})
const results = await pms.hubs.search({ query: 'Avengers'})
// Do something with the search results
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.
We use SemVer for versioning. For the versions available, see the tags on this repository.
See CHANGELOG file for more details.
This project is licensed under the MIT License - see the LICENSE file for details