@ctrl/plex 1.5.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/README.md +3 -2
  2. package/dist/src/alert.d.ts +12 -0
  3. package/dist/src/alert.js +29 -0
  4. package/dist/src/alert.types.d.ts +59 -0
  5. package/dist/src/alert.types.js +1 -0
  6. package/dist/{base → src/base}/partialPlexObject.d.ts +18 -12
  7. package/dist/{base → src/base}/partialPlexObject.js +32 -23
  8. package/dist/{base → src/base}/playable.d.ts +2 -2
  9. package/dist/src/base/playable.js +8 -0
  10. package/dist/{base → src/base}/plexObject.d.ts +8 -1
  11. package/dist/{base → src/base}/plexObject.js +21 -18
  12. package/dist/{baseFunctionality.d.ts → src/baseFunctionality.d.ts} +17 -1
  13. package/dist/{baseFunctionality.js → src/baseFunctionality.js} +7 -15
  14. package/dist/{client.d.ts → src/client.d.ts} +2 -2
  15. package/dist/{client.js → src/client.js} +12 -20
  16. package/dist/src/client.types.js +1 -0
  17. package/dist/src/config.js +35 -0
  18. package/dist/src/exceptions.d.ts +20 -0
  19. package/dist/src/exceptions.js +40 -0
  20. package/dist/src/index.d.ts +12 -0
  21. package/dist/src/index.js +11 -0
  22. package/dist/{library.d.ts → src/library.d.ts} +207 -21
  23. package/dist/{library.js → src/library.js} +349 -133
  24. package/dist/{library.types.d.ts → src/library.types.d.ts} +71 -1
  25. package/dist/src/library.types.js +1 -0
  26. package/dist/{media.d.ts → src/media.d.ts} +16 -4
  27. package/dist/{media.js → src/media.js} +42 -49
  28. package/dist/src/media.types.d.ts +7 -0
  29. package/dist/src/media.types.js +1 -0
  30. package/dist/{myplex.d.ts → src/myplex.d.ts} +16 -6
  31. package/dist/{myplex.js → src/myplex.js} +71 -57
  32. package/dist/src/myplex.types.js +10 -0
  33. package/dist/src/playlist.d.ts +75 -0
  34. package/dist/src/playlist.js +142 -0
  35. package/dist/src/playlist.types.d.ts +17 -0
  36. package/dist/src/playlist.types.js +1 -0
  37. package/dist/{search.d.ts → src/search.d.ts} +5 -4
  38. package/dist/{search.js → src/search.js} +16 -20
  39. package/dist/src/search.types.js +1 -0
  40. package/dist/{server.d.ts → src/server.d.ts} +22 -10
  41. package/dist/{server.js → src/server.js} +65 -50
  42. package/dist/src/server.types.js +1 -0
  43. package/dist/src/settings.d.ts +79 -0
  44. package/dist/src/settings.js +160 -0
  45. package/dist/{util.d.ts → src/util.d.ts} +2 -1
  46. package/dist/{util.js → src/util.js} +8 -12
  47. package/dist/{video.d.ts → src/video.d.ts} +39 -61
  48. package/dist/{video.js → src/video.js} +110 -93
  49. package/dist/{video.types.d.ts → src/video.types.d.ts} +1 -1
  50. package/dist/src/video.types.js +6 -0
  51. package/package.json +46 -44
  52. package/dist/base/playable.js +0 -12
  53. package/dist/client.types.js +0 -2
  54. package/dist/config.js +0 -41
  55. package/dist/index.d.ts +0 -8
  56. package/dist/index.js +0 -23
  57. package/dist/library.types.js +0 -2
  58. package/dist/myplex.types.js +0 -13
  59. package/dist/playlist.d.ts +0 -7
  60. package/dist/playlist.js +0 -19
  61. package/dist/search.types.js +0 -2
  62. package/dist/server.types.js +0 -2
  63. package/dist/video.types.js +0 -9
  64. /package/dist/{client.types.d.ts → src/client.types.d.ts} +0 -0
  65. /package/dist/{config.d.ts → src/config.d.ts} +0 -0
  66. /package/dist/{myplex.types.d.ts → src/myplex.types.d.ts} +0 -0
  67. /package/dist/{search.types.d.ts → src/search.types.d.ts} +0 -0
  68. /package/dist/{server.types.d.ts → src/server.types.d.ts} +0 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ctrl/plex",
3
- "version": "1.5.2",
3
+ "version": "2.0.0",
4
4
  "description": "plex api client in typescript",
5
5
  "author": "Scott Cooper <scttcper@gmail.com>",
6
6
  "publishConfig": {
@@ -8,10 +8,11 @@
8
8
  },
9
9
  "license": "MIT",
10
10
  "repository": "scttcper/plex",
11
- "main": "dist/index.js",
12
- "typings": "dist/index.d.ts",
11
+ "type": "module",
12
+ "main": "./dist/src/index.js",
13
+ "typings": "./dist/src/index.d.ts",
13
14
  "files": [
14
- "dist"
15
+ "dist/src"
15
16
  ],
16
17
  "sideEffects": false,
17
18
  "keywords": [
@@ -19,56 +20,57 @@
19
20
  "typescript"
20
21
  ],
21
22
  "scripts": {
22
- "lint": "eslint --ext .js,.ts",
23
- "lint:fix": "eslint --fix --ext .js,.ts",
23
+ "lint": "eslint --ext .ts .",
24
+ "lint:fix": "eslint --fix --ext .ts .",
24
25
  "prepare": "npm run build",
25
- "build": "tsc -p tsconfig.build.json",
26
+ "build": "tsc",
26
27
  "build:docs": "typedoc",
27
- "test": "jest --runInBand",
28
- "test:ci": "jest --ci --runInBand --reporters=default --reporters=jest-junit --coverage",
29
- "claim-server": "ts-node scripts/claim-server.ts",
30
- "add-media": "ts-node scripts/add-media.ts",
31
- "test-cleanup": "ts-node scripts/test-cleanup.ts"
28
+ "test": "vitest run",
29
+ "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml",
30
+ "bootstraptest": "node --loader ts-node/esm scripts/bootstraptest.ts",
31
+ "teardowntest": "node --loader ts-node/esm scripts/teardowntest.ts",
32
+ "claim-server": "node --loader ts-node/esm scripts/claim-server.ts",
33
+ "add-media": "node --loader ts-node/esm scripts/add-media.ts",
34
+ "test-cleanup": "node --loader ts-node/esm scripts/test-cleanup.ts"
32
35
  },
33
36
  "dependencies": {
34
- "@ctrl/mac-address": "^2.1.2",
35
- "got": "^11.8.2",
36
- "p-any": "^3.0.0",
37
- "type-fest": "^0.21.3",
38
- "xml2js": "^0.4.23"
37
+ "@ctrl/mac-address": "^3.0.3",
38
+ "got": "^13.0.0",
39
+ "p-any": "^4.0.0",
40
+ "type-fest": "^4.15.0",
41
+ "ws": "^8.16.0",
42
+ "xml2js": "^0.6.2"
39
43
  },
40
44
  "devDependencies": {
41
- "@babel/plugin-transform-modules-commonjs": "7.13.8",
42
- "@babel/preset-typescript": "7.13.0",
43
- "@ctrl/eslint-config": "1.3.1",
44
- "@types/lodash": "4.14.168",
45
- "@types/node": "14.14.34",
46
- "@types/puppeteer": "5.4.3",
47
- "@types/xml2js": "0.4.8",
48
- "@jest/globals": "26.6.2",
49
- "jest": "26.6.3",
50
- "jest-junit": "12.0.0",
45
+ "@ctrl/eslint-config": "4.0.14",
46
+ "@sindresorhus/tsconfig": "5.0.0",
47
+ "@types/lodash": "4.17.0",
48
+ "@types/micromatch": "4.0.7",
49
+ "@types/node": "20.12.7",
50
+ "@types/ws": "8.5.10",
51
+ "@types/xml2js": "0.4.14",
52
+ "@types/yargs": "17.0.32",
53
+ "@vitest/coverage-v8": "^1.5.0",
54
+ "delay": "6.0.0",
55
+ "execa": "8.0.1",
56
+ "glob": "10.3.12",
57
+ "globby": "14.0.1",
51
58
  "lodash": "4.17.21",
52
- "puppeteer": "8.0.0",
53
- "ts-node": "9.1.1",
54
- "typedoc": "0.20.30",
55
- "typescript": "4.2.3"
56
- },
57
- "jest": {
58
- "testEnvironment": "node"
59
- },
60
- "babel": {
61
- "presets": [
62
- "@babel/preset-typescript"
63
- ],
64
- "plugins": [
65
- "@babel/plugin-transform-modules-commonjs"
66
- ]
59
+ "make-dir": "4.0.0",
60
+ "ora": "8.0.1",
61
+ "p-retry": "6.2.0",
62
+ "ts-node": "10.9.2",
63
+ "typedoc": "0.25.13",
64
+ "typescript": "5.4.5",
65
+ "vitest": "1.5.0",
66
+ "yargs": "17.7.2"
67
67
  },
68
68
  "release": {
69
- "branch": "master"
69
+ "branches": [
70
+ "master"
71
+ ]
70
72
  },
71
73
  "engines": {
72
- "node": ">=10"
74
+ "node": ">=16.10"
73
75
  }
74
76
  }
@@ -1,12 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Playable = void 0;
4
- const partialPlexObject_1 = require("./partialPlexObject");
5
- /**
6
- * This is a general place to store functions specific to media that is Playable.
7
- * Things were getting mixed up a bit when dealing with Shows, Season, Artists,
8
- * Albums which are all not playable.
9
- */
10
- class Playable extends partialPlexObject_1.PartialPlexObject {
11
- }
12
- exports.Playable = Playable;
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
package/dist/config.js DELETED
@@ -1,41 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.BASE_HEADERS = exports.X_PLEX_IDENTIFIER = exports.X_PLEX_DEVICE_NAME = exports.X_PLEX_DEVICE = exports.X_PLEX_VERSION = exports.X_PLEX_PRODUCT = exports.X_PLEX_PLATFORM_VERSION = exports.X_PLEX_PLATFORM = exports.X_PLEX_PROVIDES = exports.X_PLEX_ENABLE_FAST_CONNECT = exports.X_PLEX_CONTAINER_SIZE = exports.TIMEOUT = exports.VERSION = exports.PROJECT = void 0;
7
- const os_1 = __importDefault(require("os"));
8
- const mac_address_1 = require("@ctrl/mac-address");
9
- // TODO: Load User Defined Config
10
- // const DEFAULT_CONFIG_PATH = os.path.expanduser('~/.config/plexapi/config.ini');
11
- // const CONFIG_PATH = os.environ.get('PLEXAPI_CONFIG_PATH', DEFAULT_CONFIG_PATH);
12
- // const CONFIG = PlexConfig(CONFIG_PATH);
13
- // PlexAPI Settings
14
- exports.PROJECT = 'PlexAPI';
15
- exports.VERSION = '3.3.0';
16
- exports.TIMEOUT = 30000;
17
- exports.X_PLEX_CONTAINER_SIZE = 100;
18
- exports.X_PLEX_ENABLE_FAST_CONNECT = false;
19
- // Plex Header Configuation
20
- exports.X_PLEX_PROVIDES = 'controller';
21
- exports.X_PLEX_PLATFORM = os_1.default.type();
22
- exports.X_PLEX_PLATFORM_VERSION = os_1.default.release();
23
- exports.X_PLEX_PRODUCT = exports.PROJECT;
24
- exports.X_PLEX_VERSION = exports.VERSION;
25
- exports.X_PLEX_DEVICE = exports.X_PLEX_PLATFORM;
26
- exports.X_PLEX_DEVICE_NAME = os_1.default.hostname();
27
- const mac = mac_address_1.getMAC();
28
- const base16Mac = mac_address_1.parseMAC(mac).toLong().toString(16);
29
- exports.X_PLEX_IDENTIFIER = `0x${base16Mac}`;
30
- exports.BASE_HEADERS = {
31
- 'X-Plex-Platform': exports.X_PLEX_PLATFORM,
32
- 'X-Plex-Platform-Version': exports.X_PLEX_PLATFORM_VERSION,
33
- 'X-Plex-Provides': exports.X_PLEX_PROVIDES,
34
- 'X-Plex-Product': exports.X_PLEX_PRODUCT,
35
- 'X-Plex-Version': exports.X_PLEX_VERSION,
36
- 'X-Plex-Device': exports.X_PLEX_DEVICE,
37
- 'X-Plex-Device-Name': exports.X_PLEX_DEVICE_NAME,
38
- 'X-Plex-Client-Identifier': exports.X_PLEX_IDENTIFIER,
39
- 'X-Plex-Sync-Version': '2',
40
- 'X-Plex-Language': 'en',
41
- };
package/dist/index.d.ts DELETED
@@ -1,8 +0,0 @@
1
- export * from './client';
2
- export * from './server';
3
- export * from './myplex';
4
- export * from './library';
5
- export * from './video';
6
- export * from './media';
7
- export * from './playlist';
8
- export { SearchResult, Agent } from './search';
package/dist/index.js DELETED
@@ -1,23 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
- }) : (function(o, m, k, k2) {
6
- if (k2 === undefined) k2 = k;
7
- o[k2] = m[k];
8
- }));
9
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
10
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11
- };
12
- Object.defineProperty(exports, "__esModule", { value: true });
13
- exports.Agent = exports.SearchResult = void 0;
14
- __exportStar(require("./client"), exports);
15
- __exportStar(require("./server"), exports);
16
- __exportStar(require("./myplex"), exports);
17
- __exportStar(require("./library"), exports);
18
- __exportStar(require("./video"), exports);
19
- __exportStar(require("./media"), exports);
20
- __exportStar(require("./playlist"), exports);
21
- var search_1 = require("./search");
22
- Object.defineProperty(exports, "SearchResult", { enumerable: true, get: function () { return search_1.SearchResult; } });
23
- Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return search_1.Agent; } });
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,13 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Protocol = exports.Status = void 0;
4
- var Status;
5
- (function (Status) {
6
- Status["Online"] = "online";
7
- Status["Offline"] = "offline";
8
- })(Status = exports.Status || (exports.Status = {}));
9
- var Protocol;
10
- (function (Protocol) {
11
- Protocol["HTTP"] = "http";
12
- Protocol["HTTPS"] = "https";
13
- })(Protocol = exports.Protocol || (exports.Protocol = {}));
@@ -1,7 +0,0 @@
1
- import { Playable } from './base/playable';
2
- export declare class Playlist extends Playable {
3
- static TAG: string;
4
- TYPE: string;
5
- protected _loadData(data: any): void;
6
- protected _loadFullData(data: any): void;
7
- }
package/dist/playlist.js DELETED
@@ -1,19 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Playlist = void 0;
4
- const playable_1 = require("./base/playable");
5
- class Playlist extends playable_1.Playable {
6
- constructor() {
7
- super(...arguments);
8
- this.TYPE = 'playlist';
9
- }
10
- _loadData(data) {
11
- // console.log(JSON.stringify(data));
12
- // TODO
13
- }
14
- _loadFullData(data) {
15
- this._loadData(data);
16
- }
17
- }
18
- exports.Playlist = Playlist;
19
- Playlist.TAG = 'Playlist';
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ChapterSource = void 0;
4
- var ChapterSource;
5
- (function (ChapterSource) {
6
- ChapterSource["Agent"] = "agent";
7
- ChapterSource["Media"] = "media";
8
- ChapterSource["Mixed"] = "mixed";
9
- })(ChapterSource = exports.ChapterSource || (exports.ChapterSource = {}));
File without changes