Compare commits

...

98 Commits

Author SHA1 Message Date
LukeHagar
bc9335abcf Bump version to 0.0.21 2023-04-19 15:21:42 +00:00
GitHub Action Bot
792fedc759 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4744818290 2023-04-19 14:59:37 +00:00
GitHub Action Bot
e343455e77 Automated build 'added geoip, adjusted tags' typescript-axios sdk: 4744665738 2023-04-19 14:43:35 +00:00
GitHub Action Bot
7a7931b0d0 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4744587370 2023-04-19 14:35:42 +00:00
GitHub Action Bot
b3c26fd1a7 Automated build 'Added Photo, myPlex, and search endpoints' typescript-axios sdk: 4744497330 2023-04-19 14:27:18 +00:00
GitHub Action Bot
26fa0aef86 Automated build 'Added Schemas, Edited endpoint order in referenced spec' typescript-axios sdk: 4744017438 2023-04-19 13:40:37 +00:00
GitHub Action Bot
74ecefac8b Automated build 'Added new endpoints' typescript-axios sdk: 4738906190 2023-04-19 02:29:00 +00:00
Luke Hagar
8855195c09 Update readme.md 2023-04-18 20:27:16 -05:00
Luke Hagar
227636620e Update readme.md 2023-04-18 20:26:37 -05:00
Luke Hagar
5866739942 Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-18 20:24:40 -05:00
Luke Hagar
0eacb0e7c4 Improving examples and intellisense 2023-04-18 20:24:34 -05:00
Luke Hagar
c0efb9a732 Update readme.md 2023-04-18 20:19:53 -05:00
Luke Hagar
71484de76e Update readme.md 2023-04-18 20:19:28 -05:00
Luke Hagar
be73efff0b Update readme.md 2023-04-18 20:12:26 -05:00
Luke Hagar
a00c394526 Update readme.md 2023-04-18 20:11:06 -05:00
Luke Hagar
3d57b22b26 Update readme.md 2023-04-18 20:10:37 -05:00
Luke Hagar
995bbedbb6 Update readme.md 2023-04-18 20:09:24 -05:00
LukeHagar
d638acb5d2 Bump version to 0.0.20 2023-04-18 21:13:34 +00:00
Luke Hagar
f87006d3e8 Update configuration.mustache 2023-04-18 16:12:34 -05:00
Luke Hagar
fcab6f2532 Update configuration.mustache 2023-04-18 16:06:36 -05:00
Luke Hagar
4c552faaf5 Update bump_version.yml 2023-04-18 16:05:39 -05:00
Luke Hagar
7ea8776750 Updated Configuration 2023-04-18 16:04:31 -05:00
GitHub Action Bot
b9487a78df Automated build 'Update plex-api-spec.yaml' typescript-axios sdk: 4736816010 2023-04-18 20:46:54 +00:00
LukeHagar
4addcb43e0 Bump version to 0.0.19 2023-04-18 20:26:13 +00:00
Luke Hagar
05444f54ad Example overhaul 2023-04-18 15:25:10 -05:00
LukeHagar
a7139cc510 Bump version to 0.0.18 2023-04-18 20:05:38 +00:00
Luke Hagar
ddbf96d1d1 Working on exports 2023-04-18 15:04:41 -05:00
LukeHagar
a40e1f6ee9 Bump version to 0.0.17 2023-04-18 19:42:16 +00:00
Luke Hagar
b37ec6d21e working on imports and exports 2023-04-18 14:39:42 -05:00
LukeHagar
b868a95db1 Bump version to 0.0.16 2023-04-18 19:21:40 +00:00
Luke Hagar
7d18553ff0 Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-18 14:20:07 -05:00
Luke Hagar
e83d09070a examples and exports 2023-04-18 14:20:04 -05:00
LukeHagar
0794b8457e Bump version to 0.0.15 2023-04-18 18:41:24 +00:00
Luke Hagar
c6ba56222a Update bump_version.yml 2023-04-18 13:40:27 -05:00
Luke Hagar
e8f38b8d0a Update bump_version.yml 2023-04-18 13:37:21 -05:00
Luke Hagar
898fa0212d Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-18 13:36:06 -05:00
Luke Hagar
67a632bbc2 Update bump_version.yml 2023-04-18 13:35:57 -05:00
LukeHagar
19c72dd7d3 Bump version to 0.0.13 2023-04-18 18:32:10 +00:00
Luke Hagar
f4e18606ce Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-18 13:31:21 -05:00
Luke Hagar
dfb04b01ca Update bump_version.yml 2023-04-18 13:31:13 -05:00
LukeHagar
59185de71e Bump version to 0.0.12 2023-04-18 18:30:31 +00:00
Luke Hagar
ef52691a35 working on npm publish version 2023-04-18 13:29:02 -05:00
LukeHagar
5ae5c02dbf Bump version to 0.0.11 2023-04-18 18:24:35 +00:00
Luke Hagar
3da49e7178 Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-18 13:23:51 -05:00
Luke Hagar
e8658f4d85 all in one workflow 2023-04-18 13:23:45 -05:00
LukeHagar
db5f6e554a Bump version to 0.0.10 2023-04-18 18:21:16 +00:00
Luke Hagar
05e801ee19 Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-18 13:20:26 -05:00
Luke Hagar
b4e644b42b Update bump_version.yml 2023-04-18 13:20:20 -05:00
LukeHagar
6c27a91f07 Bump version to 0.0.9 2023-04-18 18:18:32 +00:00
Luke Hagar
abc76a4a13 Update index.mustache 2023-04-18 13:17:34 -05:00
Luke Hagar
1021fd9033 Update bump_version.yml 2023-04-18 13:16:21 -05:00
Luke Hagar
5cf4bcc6f6 Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-18 13:14:11 -05:00
Luke Hagar
7c7a7acbd9 Adding examples package 2023-04-18 13:14:05 -05:00
LukeHagar
ec6c29f064 Bump version to 0.0.7 2023-04-18 18:07:31 +00:00
Luke Hagar
caa2765c5f Update package.mustache 2023-04-18 13:06:36 -05:00
LukeHagar
1ec095ed56 Bump version to 0.0.6 2023-04-18 17:59:20 +00:00
Luke Hagar
aefb6027f3 Update bump_version.yml 2023-04-18 12:57:40 -05:00
GitHub Action Bot
dc44c91c24 Automated build '' typescript-axios sdk: 4735449858 2023-04-18 17:53:45 +00:00
Luke Hagar
d6277545f3 Update package.mustache 2023-04-17 20:03:35 -05:00
Luke Hagar
bebf4d93ae cleanup 2023-04-17 15:11:29 -05:00
Luke Hagar
2b8140dc54 Merge branch 'main' of https://github.com/LukeHagar/plexjs 2023-04-17 15:08:32 -05:00
Luke Hagar
7cb29166f7 Update .gitignore 2023-04-17 15:08:25 -05:00
GitHub Action Bot
ea30cd0cc5 Automated build 'Added resource parameters' typescript-axios sdk: 4725309673 2023-04-17 20:03:38 +00:00
Luke Hagar
1be0bd7858 Action and folder cleanup 2023-04-17 14:46:03 -05:00
Luke Hagar
ec8a3f7026 Update config.yaml 2023-04-17 14:09:46 -05:00
GitHub Action Bot
866ca99ca2 Automated build 'Security' typescript-axios sdk: 4723017542 2023-04-17 15:33:39 +00:00
Luke Hagar
01738e4720 adjusted project structure 2023-04-17 09:41:47 -05:00
GitHub Action Bot
d2c3838c84 Automated build 'Adjusting Headers and parameters' typescript-axios sdk: 4722224093 2023-04-17 14:14:51 +00:00
GitHub Action Bot
b57c6be086 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4695449944 2023-04-14 01:37:25 +00:00
GitHub Action Bot
747686ef12 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4695295998 2023-04-14 01:10:46 +00:00
GitHub Action Bot
7bc89004b3 Automated build 'Adjusted Required Parameters, Populated Global Parameters on all endpointss' typescript-axios sdk: 4695261283 2023-04-14 01:04:31 +00:00
GitHub Action Bot
b29457e4fb Automated build 'Update pins.yaml' typescript-axios sdk: 4682879987 2023-04-12 21:04:57 +00:00
GitHub Action Bot
8af9e78276 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4681414548 2023-04-12 18:01:00 +00:00
GitHub Action Bot
a9c96763c0 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4681161204 2023-04-12 17:27:24 +00:00
GitHub Action Bot
84942e4573 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4681041552 2023-04-12 17:13:57 +00:00
GitHub Action Bot
ab8210088d Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4680550303 2023-04-12 16:17:26 +00:00
GitHub Action Bot
49516f4698 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4680407435 2023-04-12 16:03:00 +00:00
GitHub Action Bot
0dd1acd733 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4680335894 2023-04-12 15:55:38 +00:00
GitHub Action Bot
d5d4cf625d Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4680304111 2023-04-12 15:51:52 +00:00
GitHub Action Bot
0acf65e505 Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4679704586 2023-04-12 14:51:28 +00:00
GitHub Action Bot
644d4d0e4a Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4679428838 2023-04-12 14:24:01 +00:00
GitHub Action Bot
632f8d111f Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4679363310 2023-04-12 14:18:12 +00:00
LukeHagar
f75d22cf6a Bump version to 0.0.5 2023-04-12 02:27:11 +00:00
GitHub Action Bot
705cd5f26b Automated build '' typescript-axios sdk: 4673951944 2023-04-12 02:25:36 +00:00
Luke Hagar
5162542903 removed paginator 2023-04-10 09:34:19 -05:00
LukeHagar
f412ddd4d5 Bump version to 0.0.4 2023-04-07 15:04:24 +00:00
Luke Hagar
3f4ea2071e Update package.json 2023-04-07 09:58:58 -05:00
Luke Hagar
76726427e2 Update bump_version.yml 2023-04-07 09:58:37 -05:00
LukeHagar
1536e4e888 Bump version to 0.0.3 2023-04-07 14:58:09 +00:00
Luke Hagar
0789f62dcf Fixed action 2023-04-07 09:55:54 -05:00
Luke Hagar
bcbd24903b removed node_modules 2023-04-07 09:36:04 -05:00
Luke Hagar
09ad25d937 gitignore and package name 2023-04-07 09:34:12 -05:00
LukeHagar
d39c0dd2e2 Bump version to 0.0.2 2023-04-07 14:22:39 +00:00
GitHub Action Bot
e7c4df7bab Automated build '' typescript-axios sdk: 4638889339 2023-04-07 14:21:19 +00:00
Luke Hagar
bc037dd491 Update configuration.mustache 2023-04-07 09:20:30 -05:00
Luke Hagar
55f0566e2f adjusted mustache files further 2023-04-07 09:12:37 -05:00
Luke Hagar
10fcbd2e6c mustache template adjustments 2023-04-07 08:48:09 -05:00
GitHub Action Bot
6367e344e7 Automated build '' typescript-axios sdk: 4638458958 2023-04-07 13:16:12 +00:00
42 changed files with 31770 additions and 515 deletions

View File

@@ -30,13 +30,13 @@ jobs:
- name: Build TS SDK - name: Build TS SDK
id: buildTS id: buildTS
run: | run: |
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.0.jar -O openapi-generator-cli.jar rm -rf plexjs/
rm -rf sdk-output/ java -jar openapi-generator-cli.jar generate -i api-specs/referenced/plex-api-spec.yaml -g typescript-axios -o plexjs/ --global-property skipFormModel=false --config config.yaml
java -jar openapi-generator-cli.jar generate -i api-specs/referenced/plex-api-spec.yaml -g typescript-axios -o sdk-output/ --global-property skipFormModel=false --config config.yaml
- name: Run npm install and build Typescript SDK - name: Run npm install and build Typescript SDK
id: buildSDK id: buildSDK
if: steps.buildTS.outcome == 'success' if: steps.buildTS.outcome == 'success'
run: | run: |
cd plexjs
npm install npm install
npm run build npm run build

View File

@@ -19,7 +19,6 @@ jobs:
ref: ${{ github.ref }} ref: ${{ github.ref }}
fetch-depth: 0 fetch-depth: 0
- name: Checkout API Specs Repo - name: Checkout API Specs Repo
uses: actions/checkout@v3 uses: actions/checkout@v3
with: with:
@@ -56,32 +55,41 @@ jobs:
run: | run: |
yq -i '.npmVersion = "${{ github.event.inputs.version }}"' config.yaml yq -i '.npmVersion = "${{ github.event.inputs.version }}"' config.yaml
## Update package.json file with new version
- name: Update package.json version
id: updatePackageJsonVersion
if: steps.updateVersion.outcome == 'success'
run: |
LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
cd sdk-output
jq '.version = "${{ github.event.inputs.version }}"' package.json > package.json.tmp && mv package.json.tmp package.json
- name: Build TS SDK - name: Build TS SDK
id: buildTS id: buildTS
run: | run: |
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.0.jar -O openapi-generator-cli.jar rm -rf plexjs/
rm -rf sdk-output/ java -jar openapi-generator-cli.jar generate -i api-specs/referenced/plex-api-spec.yaml -g typescript-axios -o plexjs/ --global-property skipFormModel=false --config config.yaml
java -jar openapi-generator-cli.jar generate -i api-specs/referenced/plex-api-spec.yaml -g typescript-axios -o sdk-output/ --global-property skipFormModel=false --config config.yaml
- name: After SDK Build - name: After SDK Build
id: buildSDK id: buildSDK
if: steps.buildTS.outcome == 'success' if: steps.buildTS.outcome == 'success'
run: | run: |
cd plexjs
npm install npm install
npm run build npm run build
- name: Publish to NPM
id: publish
uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_TOKEN }}
package: ./plexjs/package.json
- name: Commit changes and create new version tag - name: Commit changes and create new version tag
if: steps.buildSDK.outcome == 'success' if: steps.buildSDK.outcome == 'success'
uses: stefanzweifel/git-auto-commit-action@v4 uses: stefanzweifel/git-auto-commit-action@v4
with: with:
commit_message: Bump version to ${{ github.event.inputs.version }} commit_message: Bump version to ${{ github.event.inputs.version }}
tagging_message: ${{ github.event.inputs.version }} tagging_message: ${{ github.event.inputs.version }}
- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
with:
tag_name: ${{ github.event.inputs.version }}
release_name: ${{ github.event.inputs.version }}
draft: false
prerelease: false

View File

@@ -1,20 +0,0 @@
name: Publish SDK package to npmjs
on:
release:
types: [created]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v3
with:
node-version: 12
- run: |
npm ci
- id: publish
uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_TOKEN }}
package: ./sdk-output/package.json

5
.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
node_modules
build
dist
api-specs
.env

View File

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

View File

@@ -1,217 +0,0 @@
import axios from "axios";
import * as os from 'os';
import * as path from 'path';
import * as yaml from "js-yaml";
import * as fs from "fs";
import { IAxiosRetryConfig } from "axios-retry";
export interface ConfigurationParameters {
baseurl?: string;
clientId?: string;
clientSecret?: string;
accessToken?: string;
tokenUrl?: string;
}
export interface Configuration {
activeenvironment?: string;
authtype?: string;
customexporttemplatespath?: string;
customsearchtemplatespath?: string;
debug?: boolean;
environments?: {[key: string]: Environment};
}
export interface Environment {
baseurl: string;
pat: Pat;
tenanturl: string;
}
export interface Pat {
clientid: string;
clientsecret: string;
}
export class Configuration {
/**
* parameter for apiKey security
* @param name security name
* @memberof Configuration
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for clientId
*
* @type {string}
* @memberof Configuration
*/
clientId?: string;
/**
* parameter for clientSecret
*
* @type {string}
* @memberof Configuration
*/
clientSecret?: string;
/**
* parameter for clientSecret
*
* @type {string}
* @memberof Configuration
*/
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
* @memberof Configuration
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* parameter for clientId
*
* @type {string}
* @memberof Configuration
*/
tokenUrl?: string;
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
username?: string;
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
password?: string;
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePathBeta?: string;
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePathV3?: string;
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePathV2?: string;
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePathCC?: string;
/**
* base options for axios calls
*
* @type {any}
* @memberof Configuration
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
/**
* axios retry configuration
*
* @type {IAxiosRetryConfig}
* @memberof Configuration
*/
retriesConfig?: IAxiosRetryConfig
constructor(param?: ConfigurationParameters) {
if (!param) {
param = this.getParams()
}
this.basePathBeta = param.baseurl + `/beta`
this.basePathV3 = param.baseurl + `/v3`
this.basePathV2 = param.baseurl + `/v2`
this.basePathCC = param.baseurl
this.tokenUrl = param.tokenUrl
this.clientId = param.clientId;
this.clientSecret = param.clientSecret;
const url = `${this.tokenUrl}?grant_type=client_credentials&client_id=${this.clientId}&client_secret=${this.clientSecret}`;
if (!this.accessToken) {
this.accessToken = this.getAccessToken(url);
}
}
private getParams(): ConfigurationParameters {
const config: ConfigurationParameters = {}
try {
const homeDir = os.homedir()
const configPath = path.join(homeDir, '.sailpoint','config.yaml')
const doc = yaml.load(fs.readFileSync(configPath, 'utf8')) as Configuration
if (doc.authtype && doc.authtype.toLowerCase() === 'pat') {
config.baseurl = doc.environments[doc.activeenvironment].baseurl
config.clientId = doc.environments[doc.activeenvironment].pat.clientid
config.clientSecret = doc.environments[doc.activeenvironment].pat.clientsecret
}
} catch (error) {
console.log('unable to find config file')
}
config.baseurl = process.env["SAIL_BASE_URL"] ? process.env["BASE_URL"] : config.baseurl
config.clientId = process.env["SAIL_CLIENT_ID"] ? process.env["CLIENT_ID"] : config.clientId
config.clientSecret = process.env["SAIL_CLIENT_SECRET"] ? process.env["CLIENT_SECRET"] : config.clientSecret
config.tokenUrl = config.baseurl + '/oauth/token'
return config
}
private async getAccessToken(url: string): Promise<string> {
try {
const {data, status} = await axios.post(url)
if (status === 200) {
return data.access_token;
} else {
throw new Error("Unauthorized")
}
} catch (error) {
console.error("Unable to fetch access token. Aborting.");
throw new Error(error);
}
}
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
public isJsonMime(mime: string): boolean {
const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
}
}

6
examples/.eslintignore Normal file
View File

@@ -0,0 +1,6 @@
# don't ever lint node_modules
node_modules
# don't lint build output (make sure it's set to your correct build folder name)
build
# don't lint nyc coverage output
coverage

19
examples/.eslintrc Normal file
View File

@@ -0,0 +1,19 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint", "prettier", "jest"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"prettier"
],
"rules": {
"no-console": 1,
"prettier/prettier": 2
},
"env": {
"browser": true,
"node": true,
"jest/globals": true
}
}

107
examples/.gitignore vendored Normal file
View File

@@ -0,0 +1,107 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# TypeScript v1 declaration files
typings/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
.env.test
# parcel-bundler cache (https://parceljs.org/)
.cache
# Next.js build output
.next
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test

43
examples/README.md Normal file
View File

@@ -0,0 +1,43 @@
# 🧰 Simple TypeScript Starter | 2022
> We talk about a lot of **advanced Node.js and TypeScript** concepts on [the blog](https://khalilstemmler.com), particularly focused around Domain-Driven Design and large-scale enterprise application patterns. However, I received a few emails from readers that were interested in seeing what a basic TypeScript starter project looks like. So I've put together just that.
### Features
- Minimal
- TypeScript v4
- Testing with Jest
- Linting with Eslint and Prettier
- Pre-commit hooks with Husky
- VS Code debugger scripts
- Local development with Nodemon
### Scripts
#### `npm run start:dev`
Starts the application in development using `nodemon` and `ts-node` to do hot reloading.
#### `npm run start`
Starts the app in production by first building the project with `npm run build`, and then executing the compiled JavaScript at `build/index.js`.
#### `npm run build`
Builds the app at `build`, cleaning the folder first.
#### `npm run test`
Runs the `jest` tests once.
#### `npm run test:dev`
Run the `jest` tests in watch mode, waiting for file changes.
#### `npm run prettier-format`
Format your code.
#### `npm run prettier-watch`
Format your code in watch mode, waiting for file changes.

6
examples/nodemon.json Normal file
View File

@@ -0,0 +1,6 @@
{
"watch": ["src"],
"ext": ".ts,.js",
"ignore": [],
"exec": "npx ts-node ./src/index.ts"
}

17904
examples/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

31
examples/package.json Normal file
View File

@@ -0,0 +1,31 @@
{
"name": "typescript-starter",
"version": "1.0.0",
"description": "A basic typescript app starter for 2023.",
"main": "index.js",
"scripts": {
"build": "rimraf ./build && tsc",
"dev": "npx nodemon",
"start": "npm run build && node build/index.js"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@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",
"dotenv": "^16.0.3",
"nodemon": "^2.0.19",
"onchange": "^7.1.0",
"rimraf": "^5.0.0",
"run-script-os": "^1.1.6",
"ts-node": "^10.9.1",
"typescript": "^5.0.4"
},
"dependencies": {
"jest-cucumber": "^3.0.1"
}
}

19
examples/src/index.ts Normal file
View File

@@ -0,0 +1,19 @@
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));

16
examples/tsconfig.json Normal file
View File

@@ -0,0 +1,16 @@
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"lib": ["es6"],
"allowJs": true,
"outDir": "build",
"rootDir": "src",
"strict": true,
"esModuleInterop": true,
"types": ["node", "jest"],
"skipLibCheck": true
},
"include": ["src/**/*"],
"exclude": ["src/**/*.spec.ts"]
}

4412
examples/yarn.lock Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -1,24 +0,0 @@
/* tslint:disable */
/* eslint-disable */
/**
* IdentityNow V3 API
* Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.
*
* The version of the OpenAPI document: 3.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export * from "./sdk-output/api";
export {Configuration as ConfigurationBeta, ConfigurationParameters as ConfigurationParameter} from "./sdk-output/configuration";
export {Configuration, ConfigurationParameters} from "./configuration";
export * from "./paginator";
export * as axiosRetry from "axios-retry"

BIN
openapi-generator-cli.jar Normal file

Binary file not shown.

View File

@@ -1,63 +0,0 @@
export interface PaginationParams {
/**
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
* @type {number}
* @memberof AccountsApiListAccounts
*/
limit?: number;
/**
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
* @type {number}
* @memberof AccountsApiListAccounts
*/
offset?: number;
/**
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
* @type {boolean}
* @memberof AccountsApiListAccounts
*/
count?: boolean;
/**
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **identityId**: *eq* **name**: *eq, in* **nativeIdentity**: *eq, in* **sourceId**: *eq, in* **uncorrelated**: *eq*
* @type {string}
* @memberof AccountsApiListAccounts
*/
filters?: string;
}
export interface AxiosResponse<T = any, D = any> {
data: T;
status: number;
statusText: string;
request?: any;
headers: AxiosResponseHeaders;
}
export type AxiosResponseHeaders = Record<string, string> & {
"set-cookie"?: string[]
};
export class Paginator {
public static async paginate<T, TResult, A extends PaginationParams>(thisArg: T, callbackFn: (this: T, args: A) => Promise<AxiosResponse<TResult[], any>>, args?: A, increment?: number): Promise<AxiosResponse<TResult[], any>> {
let params: PaginationParams = args ? args : {limit: 0, offset: 0}
const maxLimit = params && params.limit ? params.limit : 0
if (!params.offset) {
params.offset = 0
}
if (!increment) {
increment = 250
}
params.limit = increment
let modified: TResult[] = []
while (true) {
console.log(`Paginating call, offset = ${params.offset}`)
let results = await callbackFn.call(thisArg, params)
modified.push.apply(modified, results.data)
if (results.data.length < increment || (params.offset >= maxLimit && maxLimit > 0)) {
results.data = modified
return results
}
params.offset += increment
}
}
}

4
plexjs/.gitignore vendored Normal file
View File

@@ -0,0 +1,4 @@
wwwroot/*.js
node_modules
typings
dist

1
plexjs/.npmignore Normal file
View File

@@ -0,0 +1 @@
# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

View File

@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.
# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

View File

@@ -0,0 +1,12 @@
.gitignore
.npmignore
.openapi-generator-ignore
README.md
api.ts
base.ts
common.ts
configuration.ts
git_push.sh
index.ts
package.json
tsconfig.json

View File

@@ -0,0 +1 @@
6.3.0

45
plexjs/README.md Normal file
View File

@@ -0,0 +1,45 @@
## 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:
Environment
* Node.js
* Webpack
* Browserify
Language level
* ES5 - you must have a Promises/A+ library installed
* ES6
Module system
* CommonJS
* ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
### Building
To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```
### Publishing
First build the package then run ```npm publish```
### Consuming
navigate to the folder of your consuming project and run one of the following commands.
_published:_
```
npm install plexjs@0.0.21 --save
```
_unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save

8433
plexjs/api.ts Normal file

File diff suppressed because it is too large Load Diff

71
plexjs/base.ts Normal file
View File

@@ -0,0 +1,71 @@
/* tslint:disable */
/* eslint-disable */
/**
* Plex-API
* An Open API Spec for interacting with Plex.tv and Plex Servers
*
* The version of the OpenAPI document: 0.0.3
* Contact: Lukeslakemail@gmail.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Configuration } from "./configuration";
// Some imports not used depending on template conditions
// @ts-ignore
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
export const BASE_PATH = "http://10.10.10.47:32400".replace(/\/+$/, "");
/**
*
* @export
*/
export const COLLECTION_FORMATS = {
csv: ",",
ssv: " ",
tsv: "\t",
pipes: "|",
};
/**
*
* @export
* @interface RequestArgs
*/
export interface RequestArgs {
url: string;
axiosOptions: AxiosRequestConfig;
}
/**
*
* @export
* @class BaseAPI
*/
export class BaseAPI {
protected configuration: Configuration | undefined;
constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
if (configuration) {
this.configuration = configuration;
this.basePath = configuration.basePath || this.basePath;
}
}
};
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
export class RequiredError extends Error {
name: "RequiredError" = "RequiredError";
constructor(public field: string, msg?: string) {
super(msg);
}
}

105
plexjs/common.ts Normal file
View File

@@ -0,0 +1,105 @@
/* tslint:disable */
/* eslint-disable */
/**
* Plex-API
* An Open API Spec for interacting with Plex.tv and Plex Servers
*
* The version of the OpenAPI document: 0.0.3
* Contact: Lukeslakemail@gmail.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Configuration } from "./configuration";
import { RequiredError, RequestArgs } from "./base";
import { AxiosInstance, AxiosResponse } from 'axios';
import axiosRetry from "axios-retry";
/**
*
* @export
*/
export const DUMMY_BASE_URL = 'https://example.com'
/**
*
* @throws {RequiredError}
* @export
*/
export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
if (paramValue === null || paramValue === undefined) {
throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
}
}
/**
*
* @export
*/
export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
if (configuration && configuration.apiKey) {
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
? await configuration.apiKey(keyParamName)
: await configuration.apiKey;
object[keyParamName] = localVarApiKeyValue;
}
}
/**
*
* @export
*/
export const setSearchParams = function (url: URL, ...objects: any[]) {
const searchParams = new URLSearchParams(url.search);
for (const object of objects) {
for (const key in object) {
if (Array.isArray(object[key])) {
searchParams.delete(key);
for (const item of object[key]) {
searchParams.append(key, item);
}
} else {
searchParams.set(key, object[key]);
}
}
}
url.search = searchParams.toString();
}
/**
*
* @export
*/
export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
const nonString = typeof value !== 'string';
const needsSerialization = nonString && configuration && configuration.isJsonMime
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
: nonString;
return needsSerialization
? JSON.stringify(value !== undefined ? value : {})
: (value || "");
}
/**
*
* @export
*/
export const toPathString = function (url: URL) {
return url.pathname + url.search + url.hash
}
/**
*
* @export
*/
export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
axiosRetry(globalAxios, configuration.retriesConfig)
const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath || basePath) + axiosArgs.url};
return axios.request<T, R>(axiosRequestArgs);
};
}

187
plexjs/configuration.ts Normal file
View File

@@ -0,0 +1,187 @@
/* tslint:disable */
/* eslint-disable */
/**
* Plex-API
* An Open API Spec for interacting with Plex.tv and Plex Servers
*
* The version of the OpenAPI document: 0.0.3
* Contact: Lukeslakemail@gmail.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { IAxiosRetryConfig } from "axios-retry";
export type ConfigurationParameters = {
plexToken?: string;
clientIdentifier?: string;
device?: string;
deviceName?: string;
platform?: string;
platformVersion?: string;
product?: string;
version?: string;
basePath?: string;
}
export class Configuration {
/**
* Plex Media Server or Plex.TV Authentication token
*
* @type {string}
* @memberof Configuration
*/
plexToken?: string;
/**
* UUID, serial number, or other number unique per device
*
* @type {string}
* @memberof Configuration
*/
clientIdentifier?: string;
/**
* Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV
*
* @type {string}
* @memberof Configuration
*/
device?: string;
/**
* Customized Device Name
*
* @type {string}
* @memberof Configuration
*/
deviceName?: string;
/**
* Platform name, eg iOS, MacOSX, Android, LG, etc
*
* @type {string}
* @memberof Configuration
*/
platform?: string;
/**
* Operating system version, eg 4.3.1, 10.6.7, 3.2
*
* @type {string}
* @memberof Configuration
*/
platformVersion?: string;
/**
* Plex application name, eg Laika, Plex Media Server, Media Link
*
* @type {string}
* @memberof Configuration
*/
product?: string;
/**
* Plex application version number
*
* @type {string}
* @memberof Configuration
*/
version?: string;
/**
* parameter for apiKey security
* @param name security name
* @memberof Configuration
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePath?: string;
/**
* base options for axios calls
*
* @type {any}
* @memberof Configuration
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
/**
* axios retry configuration
*
* @type {IAxiosRetryConfig}
* @memberof Configuration
*/
retriesConfig?: IAxiosRetryConfig
constructor(param: ConfigurationParameters = {}) {
this.plexToken = param.plexToken;
this.clientIdentifier = param.clientIdentifier || "Plexjs";
this.device = param.device;
this.deviceName = param.deviceName;
this.platform = param.platform || "Plexjs";
this.platformVersion = param.platformVersion;
this.product = param.product;
this.version = param.version;
this.apiKey = (header: string) => {
switch (header) {
case "X-Plex-Token":
return this.plexToken
case "X-Plex-Client-Identifier":
return this.clientIdentifier
case "X-Plex-Device-Name":
return this.deviceName
case "X-Plex-Device":
return this.device
case "X-Plex-Platform-Version":
return this.platformVersion
case "X-Plex-Platform":
return this.platform
case "X-Plex-Product":
return this.product
case "X-Plex-Version":
return this.version
default:
return "";
}
}
this.basePath = param.basePath;
}
public setAuthToken(token: string) {
this.plexToken = token
}
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
public isJsonMime(mime: string): boolean {
const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
}
}

57
plexjs/git_push.sh Normal file
View File

@@ -0,0 +1,57 @@
#!/bin/sh
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
#
# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
git_user_id=$1
git_repo_id=$2
release_note=$3
git_host=$4
if [ "$git_host" = "" ]; then
git_host="github.com"
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
fi
if [ "$git_user_id" = "" ]; then
git_user_id="GIT_USER_ID"
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
fi
if [ "$git_repo_id" = "" ]; then
git_repo_id="GIT_REPO_ID"
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
fi
if [ "$release_note" = "" ]; then
release_note="Minor update"
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
fi
# Initialize the local directory as a Git repository
git init
# Adds the files in the local repository and stages them for commit.
git add .
# Commits the tracked changes and prepares them to be pushed to a remote repository.
git commit -m "$release_note"
# Sets the new remote
git_remote=$(git remote)
if [ "$git_remote" = "" ]; then # git remote not defined
if [ "$GIT_TOKEN" = "" ]; then
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
else
git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
fi
fi
git pull origin master
# Pushes (Forces) the changes in the local repository up to the remote repository
echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
git push origin master 2>&1 | grep -v 'To https'

18
plexjs/index.ts Normal file
View File

@@ -0,0 +1,18 @@
/* tslint:disable */
/* eslint-disable */
/**
* Plex-API
* An Open API Spec for interacting with Plex.tv and Plex Servers
*
* The version of the OpenAPI document: 0.0.3
* Contact: Lukeslakemail@gmail.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export * from "./api";
export {Configuration, ConfigurationParameters} from "./configuration";

View File

@@ -1,28 +1,26 @@
{ {
"name": "plexjs", "name": "@lukehagar/plexjs",
"version": "0.0.1", "version": "0.0.21",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "plexjs", "name": "@lukehagar/plexjs",
"version": "0.0.1", "version": "0.0.21",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"axios": "^0.26.1", "axios": "^0.26.1",
"axios-retry": "^3.4.0", "axios-retry": "^3.4.0"
"js-yaml": "^4.1.0"
}, },
"devDependencies": { "devDependencies": {
"@types/js-yaml": "^4.0.5",
"@types/node": "^12.11.5", "@types/node": "^12.11.5",
"typescript": "^4.0" "typescript": "^4.0"
} }
}, },
"node_modules/@babel/runtime": { "node_modules/@babel/runtime": {
"version": "7.20.13", "version": "7.21.0",
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.20.13.tgz", "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.21.0.tgz",
"integrity": "sha512-gt3PKXs0DBoL9xCvOIIZ2NEqAGZqHjAnmVbfQtB620V0uReIQutpel14KcneZuer7UioY8ALKZ7iocavvzTNFA==", "integrity": "sha512-xwII0//EObnq89Ji5AKYQaRYiW/nZ3llSv29d49IuxPhKbtJoLP+9QUUZ4nVragQVtaVGeZrpB+ZtG/Pdy/POw==",
"dependencies": { "dependencies": {
"regenerator-runtime": "^0.13.11" "regenerator-runtime": "^0.13.11"
}, },
@@ -30,23 +28,12 @@
"node": ">=6.9.0" "node": ">=6.9.0"
} }
}, },
"node_modules/@types/js-yaml": {
"version": "4.0.5",
"resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-4.0.5.tgz",
"integrity": "sha512-FhpRzf927MNQdRZP0J5DLIdTXhjLYzeUTmLAu69mnVksLH9CJY3IuSeEgbKUki7GQZm0WqDkGzyxju2EZGD2wA==",
"dev": true
},
"node_modules/@types/node": { "node_modules/@types/node": {
"version": "12.20.55", "version": "12.20.55",
"resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.55.tgz", "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.55.tgz",
"integrity": "sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==", "integrity": "sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==",
"dev": true "dev": true
}, },
"node_modules/argparse": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
"integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
},
"node_modules/axios": { "node_modules/axios": {
"version": "0.26.1", "version": "0.26.1",
"resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz", "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz",
@@ -94,26 +81,15 @@
"url": "https://github.com/sponsors/sindresorhus" "url": "https://github.com/sponsors/sindresorhus"
} }
}, },
"node_modules/js-yaml": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
"integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
"dependencies": {
"argparse": "^2.0.1"
},
"bin": {
"js-yaml": "bin/js-yaml.js"
}
},
"node_modules/regenerator-runtime": { "node_modules/regenerator-runtime": {
"version": "0.13.11", "version": "0.13.11",
"resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz", "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz",
"integrity": "sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg==" "integrity": "sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg=="
}, },
"node_modules/typescript": { "node_modules/typescript": {
"version": "4.8.4", "version": "4.9.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
"integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==", "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
"dev": true, "dev": true,
"bin": { "bin": {
"tsc": "bin/tsc", "tsc": "bin/tsc",
@@ -126,30 +102,19 @@
}, },
"dependencies": { "dependencies": {
"@babel/runtime": { "@babel/runtime": {
"version": "7.20.13", "version": "7.21.0",
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.20.13.tgz", "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.21.0.tgz",
"integrity": "sha512-gt3PKXs0DBoL9xCvOIIZ2NEqAGZqHjAnmVbfQtB620V0uReIQutpel14KcneZuer7UioY8ALKZ7iocavvzTNFA==", "integrity": "sha512-xwII0//EObnq89Ji5AKYQaRYiW/nZ3llSv29d49IuxPhKbtJoLP+9QUUZ4nVragQVtaVGeZrpB+ZtG/Pdy/POw==",
"requires": { "requires": {
"regenerator-runtime": "^0.13.11" "regenerator-runtime": "^0.13.11"
} }
}, },
"@types/js-yaml": {
"version": "4.0.5",
"resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-4.0.5.tgz",
"integrity": "sha512-FhpRzf927MNQdRZP0J5DLIdTXhjLYzeUTmLAu69mnVksLH9CJY3IuSeEgbKUki7GQZm0WqDkGzyxju2EZGD2wA==",
"dev": true
},
"@types/node": { "@types/node": {
"version": "12.20.55", "version": "12.20.55",
"resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.55.tgz", "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.55.tgz",
"integrity": "sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==", "integrity": "sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==",
"dev": true "dev": true
}, },
"argparse": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
"integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
},
"axios": { "axios": {
"version": "0.26.1", "version": "0.26.1",
"resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz", "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz",
@@ -177,23 +142,15 @@
"resolved": "https://registry.npmjs.org/is-retry-allowed/-/is-retry-allowed-2.2.0.tgz", "resolved": "https://registry.npmjs.org/is-retry-allowed/-/is-retry-allowed-2.2.0.tgz",
"integrity": "sha512-XVm7LOeLpTW4jV19QSH38vkswxoLud8sQ57YwJVTPWdiaI9I8keEhGFpBlslyVsgdQy4Opg8QOLb8YRgsyZiQg==" "integrity": "sha512-XVm7LOeLpTW4jV19QSH38vkswxoLud8sQ57YwJVTPWdiaI9I8keEhGFpBlslyVsgdQy4Opg8QOLb8YRgsyZiQg=="
}, },
"js-yaml": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
"integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
"requires": {
"argparse": "^2.0.1"
}
},
"regenerator-runtime": { "regenerator-runtime": {
"version": "0.13.11", "version": "0.13.11",
"resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz", "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz",
"integrity": "sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg==" "integrity": "sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg=="
}, },
"typescript": { "typescript": {
"version": "4.8.4", "version": "4.9.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
"integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==", "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
"dev": true "dev": true
} }
} }

View File

@@ -1,38 +1,37 @@
{ {
"name": "plexjs", "name": "@lukehagar/plexjs",
"version": "0.0.1", "version": "0.0.21",
"description": "Community Made Plex JS/TS Module", "description": "Community Made Plex JS/TS Module",
"author": "Luke Hagar", "author": "Luke Hagar",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/lukehagar/plexjs.git" "url": "https://github.com/LukeHagar/plexjs.git"
}, },
"keywords": [ "keywords": [
"axios", "axios",
"typescript", "typescript",
"sdk", "openapi",
"plex" "api",
"plex",
"plex media server",
"pms",
"plexjs"
], ],
"license": "MIT", "license": "MIT",
"publishConfig": {
"access": "public"
},
"bugs": { "bugs": {
"url": "https://github.com/lukehagar/plexjs/issues" "url": "https://github.com/LukeHagar/plexjs/issues"
}, },
"main": "./dist/index.js", "main": "./dist/index.js",
"typings": "./dist/index.d.ts", "typings": "./dist/index.d.ts",
"scripts": { "scripts": {
"build": "tsc --outDir dist/", "build": "tsc --outDir ./dist",
"prepare": "npm run build" "prepare": "npm run build"
}, },
"dependencies": { "dependencies": {
"axios": "^0.26.1", "axios": "^0.26.1",
"axios-retry": "^3.4.0", "axios-retry": "^3.4.0"
"js-yaml": "^4.1.0"
}, },
"devDependencies": { "devDependencies": {
"@types/js-yaml": "^4.0.5",
"@types/node": "^12.11.5", "@types/node": "^12.11.5",
"typescript": "^4.0" "typescript": "^4.0"
} }

View File

@@ -17,6 +17,7 @@
}, },
"exclude": [ "exclude": [
"dist", "dist",
"node_modules" "node_modules",
"./dist/**/*"
] ]
} }

View File

@@ -2,10 +2,42 @@
## Description ## 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 ## Installation
npm
```bash ```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));
``` ```

View File

@@ -3,7 +3,7 @@
{{>licenseInfo}} {{>licenseInfo}}
{{^withSeparateModelsAndApi}} {{^withSeparateModelsAndApi}}
import { Configuration } from '../configuration'; import { Configuration } from './configuration';
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
{{#withNodeImports}} {{#withNodeImports}}
// URLSearchParams not necessarily used // URLSearchParams not necessarily used

View File

@@ -2,7 +2,7 @@
/* eslint-disable */ /* eslint-disable */
{{>licenseInfo}} {{>licenseInfo}}
import { Configuration } from "../configuration"; import { Configuration } from "./configuration";
// Some imports not used depending on template conditions // Some imports not used depending on template conditions
// @ts-ignore // @ts-ignore
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
@@ -41,7 +41,7 @@ export class BaseAPI {
constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
if (configuration) { if (configuration) {
this.configuration = configuration; this.configuration = configuration;
this.basePath = configuration.basePathV3 || this.basePath; this.basePath = configuration.basePath || this.basePath;
} }
} }
}; };

View File

@@ -2,7 +2,7 @@
/* eslint-disable */ /* eslint-disable */
{{>licenseInfo}} {{>licenseInfo}}
import { Configuration } from "../configuration"; import { Configuration } from "./configuration";
import { RequiredError, RequestArgs } from "./base"; import { RequiredError, RequestArgs } from "./base";
import { AxiosInstance, AxiosResponse } from 'axios'; import { AxiosInstance, AxiosResponse } from 'axios';
import axiosRetry from "axios-retry"; import axiosRetry from "axios-retry";
@@ -40,41 +40,6 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri
} }
} }
/**
*
* @export
*/
export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
if (configuration && (configuration.username || configuration.password)) {
object["auth"] = { username: configuration.username, password: configuration.password };
}
}
/**
*
* @export
*/
export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
object["Authorization"] = "Bearer " + accessToken;
}
}
/**
*
* @export
*/
export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
if (configuration && configuration.accessToken) {
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
? await configuration.accessToken(name, scopes)
: await configuration.accessToken;
object["Authorization"] = "Bearer " + localVarAccessTokenValue;
}
}
/** /**
* *
@@ -126,8 +91,7 @@ export const toPathString = function (url: URL) {
export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
axiosRetry(globalAxios, configuration.retriesConfig) axiosRetry(globalAxios, configuration.retriesConfig)
axiosArgs.axiosOptions.headers['X-SailPoint-SDK'] = 'typescript-{{npmVersion}}' const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath || basePath) + axiosArgs.url};
const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePathV3 || basePath) + axiosArgs.url};
return axios.request<T, R>(axiosRequestArgs); return axios.request<T, R>(axiosRequestArgs);
}; };
} }

View File

@@ -1,45 +1,92 @@
/* tslint:disable */ /* tslint:disable */
/* eslint-disable */ /* eslint-disable */
{{>licenseInfo}} {{>licenseInfo}}
import { IAxiosRetryConfig } from "axios-retry";
export interface ConfigurationParameters { export type ConfigurationParameters = {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>); plexToken?: string;
username?: string; clientIdentifier?: string;
password?: string; device?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>); deviceName?: string;
platform?: string;
platformVersion?: string;
product?: string;
version?: string;
basePath?: string; basePath?: string;
baseOptions?: any;
formDataCtor?: new () => any;
} }
export class Configuration { export class Configuration {
/**
* Plex Media Server or Plex.TV Authentication token
*
* @type {string}
* @memberof Configuration
*/
plexToken?: string;
/**
* UUID, serial number, or other number unique per device
*
* @type {string}
* @memberof Configuration
*/
clientIdentifier?: string;
/**
* Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV
*
* @type {string}
* @memberof Configuration
*/
device?: string;
/**
* Customized Device Name
*
* @type {string}
* @memberof Configuration
*/
deviceName?: string;
/**
* Platform name, eg iOS, MacOSX, Android, LG, etc
*
* @type {string}
* @memberof Configuration
*/
platform?: string;
/**
* Operating system version, eg 4.3.1, 10.6.7, 3.2
*
* @type {string}
* @memberof Configuration
*/
platformVersion?: string;
/**
* Plex application name, eg Laika, Plex Media Server, Media Link
*
* @type {string}
* @memberof Configuration
*/
product?: string;
/**
* Plex application version number
*
* @type {string}
* @memberof Configuration
*/
version?: string;
/** /**
* parameter for apiKey security * parameter for apiKey security
* @param name security name * @param name security name
* @memberof Configuration * @memberof Configuration
*/ */
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>); apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
username?: string;
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
* @memberof Configuration
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/** /**
* override base path * override base path
* *
@@ -47,6 +94,7 @@ export class Configuration {
* @memberof Configuration * @memberof Configuration
*/ */
basePath?: string; basePath?: string;
/** /**
* base options for axios calls * base options for axios calls
* *
@@ -54,6 +102,7 @@ export class Configuration {
* @memberof Configuration * @memberof Configuration
*/ */
baseOptions?: any; baseOptions?: any;
/** /**
* The FormData constructor that will be used to create multipart form data * The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that * requests. You can inject this here so that execution environments that
@@ -63,14 +112,51 @@ export class Configuration {
*/ */
formDataCtor?: new () => any; formDataCtor?: new () => any;
/**
* axios retry configuration
*
* @type {IAxiosRetryConfig}
* @memberof Configuration
*/
retriesConfig?: IAxiosRetryConfig
constructor(param: ConfigurationParameters = {}) { constructor(param: ConfigurationParameters = {}) {
this.apiKey = param.apiKey; this.plexToken = param.plexToken;
this.username = param.username; this.clientIdentifier = param.clientIdentifier || "Plexjs";
this.password = param.password; this.device = param.device;
this.accessToken = param.accessToken; this.deviceName = param.deviceName;
this.platform = param.platform || "Plexjs";
this.platformVersion = param.platformVersion;
this.product = param.product;
this.version = param.version;
this.apiKey = (header: string) => {
switch (header) {
case "X-Plex-Token":
return this.plexToken
case "X-Plex-Client-Identifier":
return this.clientIdentifier
case "X-Plex-Device-Name":
return this.deviceName
case "X-Plex-Device":
return this.device
case "X-Plex-Platform-Version":
return this.platformVersion
case "X-Plex-Platform":
return this.platform
case "X-Plex-Product":
return this.product
case "X-Plex-Version":
return this.version
default:
return "";
}
}
this.basePath = param.basePath; this.basePath = param.basePath;
this.baseOptions = param.baseOptions; }
this.formDataCtor = param.formDataCtor;
public setAuthToken(token: string) {
this.plexToken = token
} }
/** /**

View File

@@ -3,4 +3,5 @@
{{>licenseInfo}} {{>licenseInfo}}
export * from "./api"; export * from "./api";
export {Configuration, ConfigurationParameters} from "./configuration";
{{#withSeparateModelsAndApi}}export * from "./{{tsModelPackage}}";{{/withSeparateModelsAndApi}} {{#withSeparateModelsAndApi}}export * from "./{{tsModelPackage}}";{{/withSeparateModelsAndApi}}

View File

@@ -1,24 +1,30 @@
{ {
"name": "{{npmName}}", "name": "@lukehagar/plexjs",
"version": "{{npmVersion}}", "version": "{{npmVersion}}",
"description": "OpenAPI client for {{npmName}}", "description": "Community Made Plex JS/TS Module",
"author": "OpenAPI-Generator Contributors", "author": "Luke Hagar",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}}.git" "url": "https://github.com/LukeHagar/plexjs.git"
}, },
"keywords": [ "keywords": [
"axios", "axios",
"typescript", "typescript",
"openapi-client", "openapi",
"openapi-generator", "api",
"plex",
"plex media server",
"pms",
"{{npmName}}" "{{npmName}}"
], ],
"license": "Unlicense", "license": "MIT",
"bugs": {
"url": "https://github.com/LukeHagar/plexjs/issues"
},
"main": "./dist/index.js", "main": "./dist/index.js",
"typings": "./dist/index.d.ts", "typings": "./dist/index.d.ts",
"scripts": { "scripts": {
"build": "tsc --outDir dist/", "build": "tsc --outDir ./dist",
"prepare": "npm run build" "prepare": "npm run build"
}, },
"dependencies": { "dependencies": {
@@ -28,10 +34,5 @@
"devDependencies": { "devDependencies": {
"@types/node": "^12.11.5", "@types/node": "^12.11.5",
"typescript": "^4.0" "typescript": "^4.0"
}{{#npmRepository}},{{/npmRepository}}
{{#npmRepository}}
"publishConfig": {
"registry": "{{npmRepository}}"
} }
{{/npmRepository}}
} }

View File

@@ -14,10 +14,12 @@
{{/supportsES6}} {{/supportsES6}}
"typeRoots": [ "typeRoots": [
"node_modules/@types" "node_modules/@types"
] ],
"sourceMap": true
}, },
"exclude": [ "exclude": [
"dist", "dist",
"node_modules" "node_modules",
"./dist/**/*"
] ]
} }