@wbce-d9/update-check 9.26.3

package/dist/index.js

@@ -0,0 +1,28 @@
+import { URL } from 'node:url';
+import { gte } from 'semver';
+import { fetch } from 'undici';
+/**
+ * Check if a given package version is the most up to date release of that package. Returns the
+ * latest version string if package is not up to date, returns null if package is up to date.
+ */
+export const isUpToDate = async (name, version) => {
+    const url = new URL(name, 'https://registry.npmjs.org');
+    const response = await fetch(url, {
+        headers: {
+            accept: 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*',
+        },
+    });
+    if (!response.ok) {
+        throw new Error(`Couldn't find latest version for package "${name}": ${response.status} ${response.statusText}`);
+    }
+    const packageInformation = (await response.json());
+    const latest = packageInformation?.['dist-tags']?.['latest'];
+    if (!latest) {
+        throw new Error(`Couldn't find latest version for package "${name}"`);
+    }
+    const upToDate = gte(version, latest);
+    if (upToDate === false) {
+        return latest;
+    }
+    return null;
+};

package/dist/index.test.js

@@ -0,0 +1,72 @@
+import { randNumber, randSemver, randSentence, randWord } from '@ngneat/falso';
+import { URL } from 'node:url';
+import { gte } from 'semver';
+import { fetch } from 'undici';
+import { afterEach, beforeEach, expect, test, vi } from 'vitest';
+import { isUpToDate } from './index.js';
+vi.mock('semver');
+vi.mock('undici');
+vi.mock('node:url');
+let sample;
+let mockResponse;
+let mockResponseJson;
+beforeEach(() => {
+    sample = {
+        name: randWord(),
+        version: randSemver(),
+        latest: randSemver(),
+    };
+    mockResponseJson = { 'dist-tags': { latest: sample.latest } };
+    mockResponse = { ok: true, json: vi.fn().mockResolvedValue(mockResponseJson) };
+    vi.mocked(fetch).mockResolvedValue(mockResponse);
+});
+afterEach(() => {
+    vi.resetAllMocks();
+});
+test('Creates URL for given package name', async () => {
+    await isUpToDate(sample.name, sample.version);
+    expect(URL).toHaveBeenCalledWith(sample.name, 'https://registry.npmjs.org');
+});
+test('Throws error if response is not ok', async () => {
+    mockResponse.ok = false;
+    mockResponse.status = randNumber({ min: 400, max: 599 });
+    mockResponse.statusText = randSentence();
+    try {
+        await isUpToDate(sample.name, sample.version);
+    }
+    catch (err) {
+        expect(err).toBeInstanceOf(Error);
+        expect(err.message).toBe(`Couldn't find latest version for package "${sample.name}": ${mockResponse.status} ${mockResponse.statusText}`);
+    }
+});
+test('Extracts latest version from package information', async () => {
+    await isUpToDate(sample.name, sample.version);
+    expect(mockResponse.json).toHaveBeenCalledOnce();
+});
+test('Throws error if latest version does not exist in json response', async () => {
+    mockResponseJson['dist-tags'] = {};
+    try {
+        await isUpToDate(sample.name, sample.version);
+    }
+    catch (err) {
+        expect(err).toBeInstanceOf(Error);
+        expect(err.message).toBe(`Couldn't find latest version for package "${sample.name}"`);
+    }
+});
+test('Uses semver.gte to check if passed version is bigger than latest', async () => {
+    sample.latest = '9.23.4';
+    sample.version = '10.0.0';
+    mockResponseJson['dist-tags'].latest = sample.latest;
+    await isUpToDate(sample.name, sample.version);
+    expect(gte).toHaveBeenCalledWith(sample.version, sample.latest);
+});
+test('Returns latest version if gte is false', async () => {
+    vi.mocked(gte).mockReturnValue(false);
+    const result = await isUpToDate(sample.name, sample.version);
+    expect(result).toBe(sample.latest);
+});
+test('Returns null if gte is true', async () => {
+    vi.mocked(gte).mockReturnValue(true);
+    const result = await isUpToDate(sample.name, sample.version);
+    expect(result).toBeNull();
+});

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@wbce-d9/update-check",
+  "version": "9.26.3",
+  "type": "module",
+  "description": "Check if an update is available for a given package",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LaWebcapsule/directus9.git",
+    "directory": "packages/update-check"
+  },
+  "funding": "https://github.com/LaWebcapsule/directus9?sponsor=1",
+  "license": "GPL-3.0",
+  "author": "Rijk van Zanten <rijkvanzanten@me.com>",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "!**/*.d.ts?(.map)"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "semver": "7.5.0",
+    "undici": "5.22.0"
+  },
+  "devDependencies": {
+    "@wbce-d9/tsconfig": "0.0.7",
+    "@ngneat/falso": "6.4.0",
+    "@types/semver": "7.3.13",
+    "@vitest/coverage-c8": "0.30.1",
+    "typescript": "5.0.4",
+    "vitest": "0.30.1"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "dev": "tsc --watch",
+    "test": "vitest --watch=false"
+  }
+}