Bump version to 0.0.21

config.yaml

@@ -5,7 +5,7 @@ files:
     destinationFilename: package.json
 npmName: plexjs
 npmRepository: lukehagar
-npmVersion: 0.0.20
+npmVersion: 0.0.21
 useSingleRequestParameter: true
 sortParamsByRequiredFlag: true
 gitUserID: lukehagar

examples/.prettierrc

@@ -1,5 +0,0 @@
-{
-  "trailingComma": "all",
-  "singleQuote": true,
-  "printWidth": 80
-}

examples/package.json

@@ -5,25 +5,21 @@
   "main": "index.js",
   "scripts": {
     "build": "rimraf ./build && tsc",
-    "start:dev": "npx nodemon",
+    "dev": "npx nodemon",
     "start": "npm run build && node build/index.js"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@lukehagar/plexjs": "^0.0.19",
+    "@lukehagar/plexjs": "^0.0.20",
     "@types/jest": "^29.5.0",
     "@types/node": "^18.6.1",
     "@typescript-eslint/eslint-plugin": "^5.31.0",
     "@typescript-eslint/parser": "^5.31.0",
-    "eslint": "^8.20.0",
+    "dotenv": "^16.0.3",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-prettier": "^4.2.1",
     "nodemon": "^2.0.19",
     "onchange": "^7.1.0",
-    "prettier": "^2.7.1",
     "rimraf": "^5.0.0",
     "run-script-os": "^1.1.6",
     "ts-node": "^10.9.1",

examples/src/index.ts

@@ -1,9 +1,19 @@
-// eslint-disable-next-line no-console
+import {
-import { Configuration, ServerApi } from '@lukehagar/plexjs';
+  Configuration,
+  ServerApi,
+  DevicesApi,
+  UserApi,
+} from "@lukehagar/plexjs";
+import dotenv from "dotenv";
+dotenv.config();
 
-const config = new Configuration({ basePath: 'http://10.10.10.47:32400' });
+const config = new Configuration({
-const api = new ServerApi(config);
+  basePath: process.env.BASE_PATH,
+  plexToken: process.env.PLEX_TOKEN,
+});
 
-api.getServerCapabilities();
+new ServerApi(config).getServerCapabilities().then((resp) => console.log(resp));
 
-console.log('Hello world!');
+new DevicesApi(config).getDevices().then((resp) => console.log(resp));
+
+new UserApi(config).getUserDetails().then((resp) => console.log(resp));

plexjs/README.md

@@ -1,4 +1,4 @@
-## plexjs@0.0.20
+## plexjs@0.0.21
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install plexjs@0.0.20 --save
+npm install plexjs@0.0.21 --save
 ```
 
 _unPublished (not recommended):_

plexjs/configuration.ts

@@ -14,7 +14,7 @@
 
 import { IAxiosRetryConfig } from "axios-retry";
 
-export interface ConfigurationParameters {
+export type ConfigurationParameters = {
     plexToken?: string;
     clientIdentifier?: string;
     device?: string;
@@ -90,7 +90,7 @@ export class Configuration {
     * @memberof Configuration
     */
     version?: string;
-    
+
     /**
      * parameter for apiKey security
      * @param name security name
@@ -134,12 +134,12 @@ export class Configuration {
     constructor(param: ConfigurationParameters = {}) {
         this.plexToken = param.plexToken;
         this.clientIdentifier = param.clientIdentifier || "Plexjs";
-        this.device = param.device || "Unspecified";
+        this.device = param.device;
-        this.deviceName = param.deviceName || "Unspecified";
+        this.deviceName = param.deviceName;
         this.platform = param.platform || "Plexjs";
-        this.platformVersion = param.platformVersion || process.env.npm_package_version;
+        this.platformVersion = param.platformVersion;
-        this.product = param.product || "Plexjs";
+        this.product = param.product;
-        this.version = param.version || process.env.npm_package_version;
+        this.version = param.version;
 
         this.apiKey = (header: string) => {
             switch (header) {

plexjs/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@lukehagar/plexjs",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@lukehagar/plexjs",
-      "version": "0.0.20",
+      "version": "0.0.21",
       "license": "MIT",
       "dependencies": {
         "axios": "^0.26.1",

plexjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lukehagar/plexjs",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "description": "Community Made Plex JS/TS Module",
   "author": "Luke Hagar",
   "repository": {

readme.md

@@ -2,10 +2,42 @@
 
 ## Description
 
-A typescript sdk for accessing the Plex.tv and Plex Media Server REST API's.
+A typescript sdk for interacting with Plex.tv and Plex Media Server REST API's.
+
+Documentation for all of the available endpoints [can be found here](https://plexapi.dev/docs/plex)
 
 ## Installation
 
+npm
 ```bash
-npm install plexjs
+npm install @lukehagar/plexjs
+```
+
+yarn
+```bash
+yarn add @lukehagar/plexjs
+```
+
+## Usage
+
+```javascript
+import {
+  Configuration,
+  ServerApi,
+  DevicesApi,
+  UserApi,
+} from "@lukehagar/plexjs";
+import dotenv from "dotenv";
+dotenv.config();
+
+const config = new Configuration({
+  basePath: process.env.BASE_PATH,
+  plexToken: process.env.PLEX_TOKEN,
+});
+
+new ServerApi(config).getServerCapabilities().then((resp) => console.log(resp));
+
+new DevicesApi(config).getDevices().then((resp) => console.log(resp));
+
+new UserApi(config).getUserDetails().then((resp) => console.log(resp));
 ```

sdk-resources/configuration.mustache

@@ -3,7 +3,7 @@
 {{>licenseInfo}}
 import { IAxiosRetryConfig } from "axios-retry";
 
-export interface ConfigurationParameters {
+export type ConfigurationParameters = {
     plexToken?: string;
     clientIdentifier?: string;
     device?: string;
@@ -79,7 +79,7 @@ export class Configuration {
     * @memberof Configuration
     */
     version?: string;
-    
+
     /**
      * parameter for apiKey security
      * @param name security name
@@ -123,12 +123,12 @@ export class Configuration {
     constructor(param: ConfigurationParameters = {}) {
         this.plexToken = param.plexToken;
         this.clientIdentifier = param.clientIdentifier || "Plexjs";
-        this.device = param.device || "Unspecified";
+        this.device = param.device;
-        this.deviceName = param.deviceName || "Unspecified";
+        this.deviceName = param.deviceName;
         this.platform = param.platform || "Plexjs";
-        this.platformVersion = param.platformVersion || process.env.npm_package_version;
+        this.platformVersion = param.platformVersion;
-        this.product = param.product || "Plexjs";
+        this.product = param.product;
-        this.version = param.version || process.env.npm_package_version;
+        this.version = param.version;
 
         this.apiKey = (header: string) => {
             switch (header) {