pavc 2.0.0 → 2.0.1
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.
- package/README.md +6 -6
- package/VersionChecker.d.ts +2 -2
- package/VersionChecker.js +5 -5
- package/examples/usage.js +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# PlexAddons Version Checker
|
|
2
2
|
|
|
3
|
-
A version checker library for addons registered on [addons.plexdev.
|
|
3
|
+
A version checker library for addons registered on [addons.plexdev.xyz](https://addons.plexdev.xyz).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -55,10 +55,10 @@ if (result.isOutdated) {
|
|
|
55
55
|
```javascript
|
|
56
56
|
const checker = new VersionChecker('AddonName', '1.0.0', {
|
|
57
57
|
// Base URL for the PlexAddons API
|
|
58
|
-
apiUrl: 'https://addons.plexdev.
|
|
58
|
+
apiUrl: 'https://addons.plexdev.xyz',
|
|
59
59
|
|
|
60
60
|
// Legacy versions.json URL (fallback)
|
|
61
|
-
repositoryUrl: 'https://addons.plexdev.
|
|
61
|
+
repositoryUrl: 'https://addons.plexdev.xyz/versions.json',
|
|
62
62
|
|
|
63
63
|
// Request timeout in milliseconds
|
|
64
64
|
timeout: 10000,
|
|
@@ -174,7 +174,7 @@ const checker = new VersionChecker('MyAddon', '1.0.0', {
|
|
|
174
174
|
|
|
175
175
|
## Publishing Your Addon
|
|
176
176
|
|
|
177
|
-
1. Create an account at [addons.plexdev.
|
|
177
|
+
1. Create an account at [addons.plexdev.xyz](https://addons.plexdev.xyz) using Discord OAuth
|
|
178
178
|
2. Register your addon in the dashboard
|
|
179
179
|
3. Add versions with changelogs
|
|
180
180
|
4. Integrate this version checker in your addon
|
|
@@ -186,7 +186,7 @@ AGPL-3.0 - See [LICENSE](LICENSE) for details.
|
|
|
186
186
|
|
|
187
187
|
## Links
|
|
188
188
|
|
|
189
|
-
- 🌐 **Website**: [addons.plexdev.
|
|
190
|
-
- 📚 **API Docs**: [addons.plexdev.
|
|
189
|
+
- 🌐 **Website**: [addons.plexdev.xyz](https://addons.plexdev.xyz)
|
|
190
|
+
- 📚 **API Docs**: [addons.plexdev.xyz/api/docs](https://addons.plexdev.xyz/api/docs)
|
|
191
191
|
- 🐛 **Issues**: [GitHub Issues](https://github.com/Bali0531-RC/pavc/issues)
|
|
192
192
|
- 📦 **NPM Package**: [npmjs.com/package/pavc](https://www.npmjs.com/package/pavc)
|
package/VersionChecker.d.ts
CHANGED
|
@@ -36,13 +36,13 @@ declare module 'pavc' {
|
|
|
36
36
|
export interface VersionCheckerOptions {
|
|
37
37
|
/**
|
|
38
38
|
* URL to fetch versions.json from (fallback)
|
|
39
|
-
* @default "https://addons.plexdev.
|
|
39
|
+
* @default "https://addons.plexdev.xyz/versions.json"
|
|
40
40
|
*/
|
|
41
41
|
repositoryUrl?: string;
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
44
|
* Base URL for the PlexAddons API
|
|
45
|
-
* @default "https://addons.plexdev.
|
|
45
|
+
* @default "https://addons.plexdev.xyz"
|
|
46
46
|
*/
|
|
47
47
|
apiUrl?: string;
|
|
48
48
|
|
package/VersionChecker.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* PlexAddons Version Checker
|
|
3
3
|
*
|
|
4
4
|
* A lightweight version checker for Plex addons that integrates with
|
|
5
|
-
* the PlexAddons API at addons.plexdev.
|
|
5
|
+
* the PlexAddons API at addons.plexdev.xyz
|
|
6
6
|
*
|
|
7
7
|
* @example
|
|
8
8
|
* const VersionChecker = require('./VersionChecker');
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* console.log(checker.formatVersionMessage(result));
|
|
12
12
|
*
|
|
13
13
|
* // Analytics are tracked automatically (version sent to API)
|
|
14
|
-
* // Addon owners can view analytics in their dashboard at addons.plexdev.
|
|
14
|
+
* // Addon owners can view analytics in their dashboard at addons.plexdev.xyz
|
|
15
15
|
*
|
|
16
16
|
* @author bali0531
|
|
17
17
|
* @license AGPL-3.0
|
|
@@ -25,7 +25,7 @@ class VersionChecker {
|
|
|
25
25
|
* @param {string} addonName - The name of your addon (must match registry)
|
|
26
26
|
* @param {string} currentVersion - Your addon's current version (e.g., "1.0.0")
|
|
27
27
|
* @param {Object} options - Configuration options
|
|
28
|
-
* @param {string} [options.apiUrl] - Custom API URL (default: addons.plexdev.
|
|
28
|
+
* @param {string} [options.apiUrl] - Custom API URL (default: addons.plexdev.xyz)
|
|
29
29
|
* @param {string} [options.repositoryUrl] - Legacy versions.json URL (fallback)
|
|
30
30
|
* @param {boolean} [options.checkOnStartup] - Auto-check on startup (default: true)
|
|
31
31
|
* @param {number} [options.timeout] - Request timeout in ms (default: 10000)
|
|
@@ -37,8 +37,8 @@ class VersionChecker {
|
|
|
37
37
|
this.addonName = addonName;
|
|
38
38
|
this.currentVersion = currentVersion;
|
|
39
39
|
this.options = {
|
|
40
|
-
apiUrl: options.apiUrl || 'https://addons.plexdev.
|
|
41
|
-
repositoryUrl: options.repositoryUrl || 'https://addons.plexdev.
|
|
40
|
+
apiUrl: options.apiUrl || 'https://addons.plexdev.xyz',
|
|
41
|
+
repositoryUrl: options.repositoryUrl || 'https://addons.plexdev.xyz/versions.json',
|
|
42
42
|
checkOnStartup: options.checkOnStartup !== false,
|
|
43
43
|
timeout: options.timeout || 10000,
|
|
44
44
|
retries: options.retries || 2,
|
package/examples/usage.js
CHANGED
|
@@ -36,7 +36,7 @@ async function analyticsExample() {
|
|
|
36
36
|
// Analytics tracking is ON by default
|
|
37
37
|
// When your users check for updates, their current version is sent to the API
|
|
38
38
|
// You (the addon owner) can view version distribution in your dashboard
|
|
39
|
-
// at addons.plexdev.
|
|
39
|
+
// at addons.plexdev.xyz - no API key needed in the VersionChecker!
|
|
40
40
|
|
|
41
41
|
const checker = new VersionChecker('MyAddon', '1.0.0');
|
|
42
42
|
const result = await checker.checkForUpdates();
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pavc",
|
|
3
|
-
"version": "2.0.
|
|
4
|
-
"description": "Version checker for PlexAddons - integrates with addons.plexdev.
|
|
3
|
+
"version": "2.0.1",
|
|
4
|
+
"description": "Version checker for PlexAddons - integrates with addons.plexdev.xyz API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"plex",
|
|
7
7
|
"plexdev",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"update-checker",
|
|
11
11
|
"discord-bot"
|
|
12
12
|
],
|
|
13
|
-
"homepage": "https://addons.plexdev.
|
|
13
|
+
"homepage": "https://addons.plexdev.xyz",
|
|
14
14
|
"bugs": {
|
|
15
15
|
"url": "https://github.com/Bali0531-RC/pavc/issues"
|
|
16
16
|
},
|