Add v9.1.1: Device registry and remote blocking system

- Implement DeviceRegistry for remote device management
- Add dashboard for device tracking and blocking
- Remote device blocking capability with admin control
- Support for device aliasing and notes
- Enhanced device management interface
- Dashboard with real-time device status
- Configurable registry URL in build config

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
renato97
2025-11-23 21:37:11 +01:00
parent cf11aa04bc
commit 8fc8991efa
925 changed files with 97082 additions and 2 deletions

21
dashboard/node_modules/simple-update-notifier/LICENSE generated vendored Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 Alex Brazier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,82 @@
# simple-update-notifier [![GitHub stars](https://img.shields.io/github/stars/alexbrazier/simple-update-notifier?label=Star%20Project&style=social)](https://github.com/alexbrazier/simple-update-notifier/stargazers)
[![CI](https://github.com/alexbrazier/simple-update-notifier/workflows/Build%20and%20Deploy/badge.svg)](https://github.com/alexbrazier/simple-update-notifier/actions)
[![Dependencies](https://img.shields.io/librariesio/release/npm/simple-update-notifier)](https://www.npmjs.com/package/simple-update-notifier?activeTab=dependencies)
[![npm](https://img.shields.io/npm/v/simple-update-notifier)](https://www.npmjs.com/package/simple-update-notifier)
[![npm bundle size](https://img.shields.io/bundlephobia/min/simple-update-notifier)](https://bundlephobia.com/result?p=simple-update-notifier)
[![npm downloads](https://img.shields.io/npm/dw/simple-update-notifier)](https://www.npmjs.com/package/simple-update-notifier)
[![License](https://img.shields.io/npm/l/simple-update-notifier)](./LICENSE)
Simple update notifier to check for npm updates for cli applications.
<img src="./.github/demo.png" alt="Demo in terminal showing an update is required">
Checks for updates for an npm module and outputs to the command line if there is one available. The result is cached for the specified time so it doesn't check every time the app runs.
## Install
```bash
npm install simple-update-notifier
OR
yarn add simple-update-notifier
```
## Usage
```js
import updateNotifier from 'simple-update-notifier';
import packageJson from './package.json' assert { type: 'json' };
updateNotifier({ pkg: packageJson });
```
### Options
#### pkg
Type: `object`
##### name
_Required_\
Type: `string`
##### version
_Required_\
Type: `string`
#### updateCheckInterval
Type: `number`\
Default: `1000 * 60 * 60 * 24` _(1 day)_
How often to check for updates.
#### shouldNotifyInNpmScript
Type: `boolean`\
Default: `false`
Allows notification to be shown when running as an npm script.
#### distTag
Type: `string`\
Default: `'latest'`
Which [dist-tag](https://docs.npmjs.com/adding-dist-tags-to-packages) to use to find the latest version.
#### alwaysRun
Type: `boolean`\
Default: `false`
When set, `updateCheckInterval` will not be respected and a check for an update will always be performed.
#### debug
Type: `boolean`\
Default: `false`
When set, logs explaining the decision will be output to `stderr` whenever the module opts to not print an update notification

View File

@@ -0,0 +1,100 @@
{
"name": "simple-update-notifier",
"version": "2.0.0",
"description": "Simple update notifier to check for npm updates for cli applications",
"main": "build/index.js",
"types": "build/index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/alexbrazier/simple-update-notifier.git"
},
"homepage": "https://github.com/alexbrazier/simple-update-notifier.git",
"author": "alexbrazier",
"license": "MIT",
"engines": {
"node": ">=10"
},
"scripts": {
"test": "jest src --noStackTrace",
"build": "rollup -c rollup.config.js --bundleConfigAsCjs",
"prettier:check": "prettier --check src/**/*.ts",
"prettier": "prettier --write src/**/*.ts",
"eslint": "eslint src/**/*.ts",
"lint": "yarn prettier:check && yarn eslint",
"prepare": "yarn lint && yarn build",
"release": "release-it"
},
"dependencies": {
"semver": "^7.5.3"
},
"devDependencies": {
"@babel/preset-env": "^7.22.5",
"@babel/preset-typescript": "^7.22.5",
"@release-it/conventional-changelog": "^5.1.1",
"@types/jest": "^29.5.2",
"@types/node": "^20.3.1",
"@typescript-eslint/eslint-plugin": "^5.60.0",
"@typescript-eslint/parser": "^5.60.0",
"eslint": "^8.43.0",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-prettier": "^4.0.0",
"jest": "^29.5.0",
"prettier": "^2.8.8",
"release-it": "^15.11.0",
"rollup": "^3.25.2",
"rollup-plugin-ts": "^3.2.0",
"typescript": "^5.1.3"
},
"resolutions": {
"semver": "^7.5.3"
},
"publishConfig": {
"registry": "https://registry.npmjs.org/"
},
"files": [
"build",
"src"
],
"release-it": {
"git": {
"commitMessage": "chore: release ${version}",
"tagName": "v${version}"
},
"npm": {
"publish": true
},
"github": {
"release": true
},
"plugins": {
"@release-it/conventional-changelog": {
"preset": "angular",
"infile": "CHANGELOG.md"
}
}
},
"eslintConfig": {
"plugins": [
"@typescript-eslint",
"prettier"
],
"extends": [
"prettier",
"eslint:recommended",
"plugin:@typescript-eslint/recommended"
],
"parser": "@typescript-eslint/parser",
"rules": {
"prettier/prettier": [
"error",
{
"quoteProps": "consistent",
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": false
}
]
}
}
}

View File

@@ -0,0 +1,12 @@
const borderedText = (text: string) => {
const lines = text.split('\n');
const width = Math.max(...lines.map((l) => l.length));
const res = [`${'─'.repeat(width + 2)}`];
for (const line of lines) {
res.push(`${line.padEnd(width)}`);
}
res.push(`${'─'.repeat(width + 2)}`);
return res.join('\n');
};
export default borderedText;

View File

@@ -0,0 +1,17 @@
import { createConfigDir, getLastUpdate, saveLastUpdate } from './cache';
createConfigDir();
jest.useFakeTimers().setSystemTime(new Date('2022-01-01'));
const fakeTime = new Date('2022-01-01').getTime();
test('can save update then get the update details', () => {
saveLastUpdate('test');
expect(getLastUpdate('test')).toBe(fakeTime);
});
test('prefixed module can save update then get the update details', () => {
saveLastUpdate('@alexbrazier/test');
expect(getLastUpdate('@alexbrazier/test')).toBe(fakeTime);
});

View File

@@ -0,0 +1,44 @@
import os from 'os';
import path from 'path';
import fs from 'fs';
const homeDirectory = os.homedir();
const configDir =
process.env.XDG_CONFIG_HOME ||
path.join(homeDirectory, '.config', 'simple-update-notifier');
const getConfigFile = (packageName: string) => {
return path.join(
configDir,
`${packageName.replace('@', '').replace('/', '__')}.json`
);
};
export const createConfigDir = () => {
if (!fs.existsSync(configDir)) {
fs.mkdirSync(configDir, { recursive: true });
}
};
export const getLastUpdate = (packageName: string) => {
const configFile = getConfigFile(packageName);
try {
if (!fs.existsSync(configFile)) {
return undefined;
}
const file = JSON.parse(fs.readFileSync(configFile, 'utf8'));
return file.lastUpdateCheck as number;
} catch {
return undefined;
}
};
export const saveLastUpdate = (packageName: string) => {
const configFile = getConfigFile(packageName);
fs.writeFileSync(
configFile,
JSON.stringify({ lastUpdateCheck: new Date().getTime() })
);
};

View File

@@ -0,0 +1,35 @@
import Stream from 'stream';
import https from 'https';
import getDistVersion from './getDistVersion';
jest.mock('https', () => ({
get: jest.fn(),
}));
test('Valid response returns version', async () => {
const st = new Stream();
(https.get as jest.Mock).mockImplementation((url, cb) => {
cb(st);
st.emit('data', '{"latest":"1.0.0"}');
st.emit('end');
});
const version = await getDistVersion('test', 'latest');
expect(version).toEqual('1.0.0');
});
test('Invalid response throws error', async () => {
const st = new Stream();
(https.get as jest.Mock).mockImplementation((url, cb) => {
cb(st);
st.emit('data', 'some invalid json');
st.emit('end');
});
expect(getDistVersion('test', 'latest')).rejects.toThrow(
'Could not parse version response'
);
});

View File

@@ -0,0 +1,29 @@
import https from 'https';
const getDistVersion = async (packageName: string, distTag: string) => {
const url = `https://registry.npmjs.org/-/package/${packageName}/dist-tags`;
return new Promise<string>((resolve, reject) => {
https
.get(url, (res) => {
let body = '';
res.on('data', (chunk) => (body += chunk));
res.on('end', () => {
try {
const json = JSON.parse(body);
const version = json[distTag];
if (!version) {
reject(new Error('Error getting version'));
}
resolve(version);
} catch {
reject(new Error('Could not parse version response'));
}
});
})
.on('error', (err) => reject(err));
});
};
export default getDistVersion;

View File

@@ -0,0 +1,82 @@
import hasNewVersion from './hasNewVersion';
import { getLastUpdate } from './cache';
import getDistVersion from './getDistVersion';
jest.mock('./getDistVersion', () => jest.fn().mockReturnValue('1.0.0'));
jest.mock('./cache', () => ({
getLastUpdate: jest.fn().mockReturnValue(undefined),
createConfigDir: jest.fn(),
saveLastUpdate: jest.fn(),
}));
const pkg = { name: 'test', version: '1.0.0' };
afterEach(() => jest.clearAllMocks());
const defaultArgs = {
pkg,
shouldNotifyInNpmScript: true,
alwaysRun: true,
};
test('it should not trigger update for same version', async () => {
const newVersion = await hasNewVersion(defaultArgs);
expect(newVersion).toBe(false);
});
test('it should trigger update for patch version bump', async () => {
(getDistVersion as jest.Mock).mockReturnValue('1.0.1');
const newVersion = await hasNewVersion(defaultArgs);
expect(newVersion).toBe('1.0.1');
});
test('it should trigger update for minor version bump', async () => {
(getDistVersion as jest.Mock).mockReturnValue('1.1.0');
const newVersion = await hasNewVersion(defaultArgs);
expect(newVersion).toBe('1.1.0');
});
test('it should trigger update for major version bump', async () => {
(getDistVersion as jest.Mock).mockReturnValue('2.0.0');
const newVersion = await hasNewVersion(defaultArgs);
expect(newVersion).toBe('2.0.0');
});
test('it should not trigger update if version is lower', async () => {
(getDistVersion as jest.Mock).mockReturnValue('0.0.9');
const newVersion = await hasNewVersion(defaultArgs);
expect(newVersion).toBe(false);
});
it('should trigger update check if last update older than config', async () => {
const TWO_WEEKS = new Date().getTime() - 1000 * 60 * 60 * 24 * 14;
(getLastUpdate as jest.Mock).mockReturnValue(TWO_WEEKS);
const newVersion = await hasNewVersion({
pkg,
shouldNotifyInNpmScript: true,
});
expect(newVersion).toBe(false);
expect(getDistVersion).toHaveBeenCalled();
});
it('should not trigger update check if last update is too recent', async () => {
const TWELVE_HOURS = new Date().getTime() - 1000 * 60 * 60 * 12;
(getLastUpdate as jest.Mock).mockReturnValue(TWELVE_HOURS);
const newVersion = await hasNewVersion({
pkg,
shouldNotifyInNpmScript: true,
});
expect(newVersion).toBe(false);
expect(getDistVersion).not.toHaveBeenCalled();
});

View File

@@ -0,0 +1,40 @@
import semver from 'semver';
import { createConfigDir, getLastUpdate, saveLastUpdate } from './cache';
import getDistVersion from './getDistVersion';
import { IUpdate } from './types';
const hasNewVersion = async ({
pkg,
updateCheckInterval = 1000 * 60 * 60 * 24,
distTag = 'latest',
alwaysRun,
debug,
}: IUpdate) => {
createConfigDir();
const lastUpdateCheck = getLastUpdate(pkg.name);
if (
alwaysRun ||
!lastUpdateCheck ||
lastUpdateCheck < new Date().getTime() - updateCheckInterval
) {
const latestVersion = await getDistVersion(pkg.name, distTag);
saveLastUpdate(pkg.name);
if (semver.gt(latestVersion, pkg.version)) {
return latestVersion;
} else if (debug) {
console.error(
`Latest version (${latestVersion}) not newer than current version (${pkg.version})`
);
}
} else if (debug) {
console.error(
`Too recent to check for a new update. simpleUpdateNotifier() interval set to ${updateCheckInterval}ms but only ${
new Date().getTime() - lastUpdateCheck
}ms since last check.`
);
}
return false;
};
export default hasNewVersion;

View File

@@ -0,0 +1,27 @@
import simpleUpdateNotifier from '.';
import hasNewVersion from './hasNewVersion';
const consoleSpy = jest.spyOn(console, 'error');
jest.mock('./hasNewVersion', () => jest.fn().mockResolvedValue('2.0.0'));
beforeEach(jest.clearAllMocks);
test('it logs message if update is available', async () => {
await simpleUpdateNotifier({
pkg: { name: 'test', version: '1.0.0' },
alwaysRun: true,
});
expect(consoleSpy).toHaveBeenCalledTimes(1);
});
test('it does not log message if update is not available', async () => {
(hasNewVersion as jest.Mock).mockResolvedValue(false);
await simpleUpdateNotifier({
pkg: { name: 'test', version: '2.0.0' },
alwaysRun: true,
});
expect(consoleSpy).toHaveBeenCalledTimes(0);
});

View File

@@ -0,0 +1,34 @@
import isNpmOrYarn from './isNpmOrYarn';
import hasNewVersion from './hasNewVersion';
import { IUpdate } from './types';
import borderedText from './borderedText';
const simpleUpdateNotifier = async (args: IUpdate) => {
if (
!args.alwaysRun &&
(!process.stdout.isTTY || (isNpmOrYarn && !args.shouldNotifyInNpmScript))
) {
if (args.debug) {
console.error('Opting out of running simpleUpdateNotifier()');
}
return;
}
try {
const latestVersion = await hasNewVersion(args);
if (latestVersion) {
console.error(
borderedText(`New version of ${args.pkg.name} available!
Current Version: ${args.pkg.version}
Latest Version: ${latestVersion}`)
);
}
} catch (err) {
// Catch any network errors or cache writing errors so module doesn't cause a crash
if (args.debug && err instanceof Error) {
console.error('Unexpected error in simpleUpdateNotifier():', err);
}
}
};
export default simpleUpdateNotifier;

View File

@@ -0,0 +1,12 @@
import process from 'process';
const packageJson = process.env.npm_package_json;
const userAgent = process.env.npm_config_user_agent;
const isNpm6 = Boolean(userAgent && userAgent.startsWith('npm'));
const isNpm7 = Boolean(packageJson && packageJson.endsWith('package.json'));
const isNpm = isNpm6 || isNpm7;
const isYarn = Boolean(userAgent && userAgent.startsWith('yarn'));
const isNpmOrYarn = isNpm || isYarn;
export default isNpmOrYarn;

View File

@@ -0,0 +1,8 @@
export interface IUpdate {
pkg: { name: string; version: string };
updateCheckInterval?: number;
shouldNotifyInNpmScript?: boolean;
distTag?: string;
alwaysRun?: boolean;
debug?: boolean;
}