@axium/core 0.12.1 → 0.14.0

package/dist/access.d.ts

@@ -1,5 +1,6 @@
 import * as z from 'zod';
 import type { User } from './user.js';
+import { type Omit } from 'utilium';
 export interface AccessControl {
     itemId: string;
     userId?: string | null;

package/dist/api.d.ts

@@ -1,13 +1,15 @@
 import type { PublicKeyCredentialCreationOptionsJSON, PublicKeyCredentialRequestOptionsJSON } from '@simplewebauthn/types';
+import type { Omit } from 'utilium';
 import type z from 'zod';
 import type { AccessControl, AccessMap } from './access.js';
 import type { App } from './apps.js';
 import type { AuditEvent, AuditFilter, Severity } from './audit.js';
 import type { NewSessionResponse, Session, Verification } from './auth.js';
+import type { PackageVersionInfo } from './packages.js';
 import type { Passkey, PasskeyAuthenticationResponse, PasskeyChangeable, PasskeyRegistration } from './passkeys.js';
+import type { PluginInternal } from './plugins.js';
 import type { RequestMethod } from './requests.js';
 import type { LogoutSessions, User, UserAuthOptions, UserChangeable, UserInternal, UserPublic, UserRegistration } from './user.js';
-import type { PluginInternal } from './plugins.js';
 export interface AdminSummary {
     users: number;
     passkeys: number;
@@ -15,7 +17,7 @@ export interface AdminSummary {
     auditEvents: Record<keyof typeof Severity, number>;
     configFiles: number;
     plugins: number;
-    version: string;
+    versions: Record<'core' | 'server' | 'client', PackageVersionInfo>;
 }
 /**
  * Types for all API endpoints
@@ -24,12 +26,11 @@ export interface AdminSummary {
 export interface $API {
     metadata: {
         GET: {
-            version: string;
+            versions: PackageVersionInfo[];
             routes: Record<string, {
                 params: Record<string, string | null>;
                 methods: string[];
             }>;
-            plugins: Record<string, string>;
         };
     };
     apps: {
@@ -115,7 +116,7 @@ export interface $API {
         };
     };
     'admin/plugins': {
-        GET: PluginInternal[];
+        GET: (Omit<PluginInternal, '_hooks' | '_client'> & PackageVersionInfo)[];
     };
     'admin/audit/events': {
         OPTIONS: {

package/dist/node/plugins.d.ts

@@ -1,3 +1,3 @@
 import { type PluginInternal } from '@axium/core/plugins';
 export declare function pluginText(plugin: PluginInternal): Generator<string>;
-export declare function loadPlugin<const T extends 'client' | 'server'>(mode: T, specifier: string, _loadedBy: string, safeMode?: boolean): Promise<PluginInternal | void>;
+export declare function loadPlugin<const T extends 'client' | 'server'>(mode: T, specifier: string, loadedBy: string, safeMode?: boolean): Promise<PluginInternal | void>;

package/dist/node/plugins.js

@@ -1,11 +1,11 @@
 import * as io from '@axium/core/node/io';
 import { Plugin, plugins } from '@axium/core/plugins';
 import * as fs from 'node:fs';
-import { dirname, join, resolve } from 'node:path/posix';
-import { fileURLToPath } from 'node:url';
+import { dirname, resolve } from 'node:path/posix';
 import { styleText } from 'node:util';
 import * as z from 'zod';
 import { apps } from '../apps.js';
+import { locatePackage } from '../packages.js';
 export function* pluginText(plugin) {
     yield styleText('whiteBright', plugin.name);
     yield `Version: ${plugin.version}`;
@@ -19,25 +19,10 @@ export function* pluginText(plugin) {
         yield `Hooks: ${plugin._client ? styleText(['dim', 'bold'], `(${Object.keys(plugin._client).length}) `) + Object.keys(plugin._client).join(', ') : plugin.client.hooks || styleText('dim', '(none)')}`;
     }
 }
-function _locatePlugin(specifier, _loadedBy) {
-    if (specifier[0] == '/' || ['.', '..'].includes(specifier.split('/')[0])) {
-        const path = resolve(dirname(_loadedBy), specifier);
-        const stats = fs.statSync(path);
-        if (stats.isFile())
-            return path;
-        if (!stats.isDirectory())
-            throw new Error('Can not resolve plugin path: ' + path);
-        return join(path, 'package.json');
-    }
-    let packageDir = dirname(fileURLToPath(import.meta.resolve(specifier)));
-    for (; !fs.existsSync(join(packageDir, 'package.json')); packageDir = dirname(packageDir))
-        ;
-    return join(packageDir, 'package.json');
-}
-export async function loadPlugin(mode, specifier, _loadedBy, safeMode = false) {
+export async function loadPlugin(mode, specifier, loadedBy, safeMode = false) {
     try {
-        const path = _locatePlugin(specifier, _loadedBy);
-        io.debug(`Loading plugin at ${path} (from ${_loadedBy})`);
+        const path = locatePackage(specifier, loadedBy);
+        io.debug(`Loading plugin at ${path} (from ${loadedBy})`);
         let imported;
         try {
             imported = JSON.parse(fs.readFileSync(path, 'utf8'));
@@ -49,12 +34,12 @@ export async function loadPlugin(mode, specifier, _loadedBy, safeMode = false) {
             Object.assign(imported, imported.axium); // support axium field in package.json
         const plugin = Object.assign(await Plugin.parseAsync(imported).catch(e => {
             throw e instanceof z.core.$ZodError ? z.prettifyError(e) : e;
-        }), { path, specifier, _loadedBy, dirname: dirname(path), cli: imported[mode]?.cli, isServer: mode === 'server' });
+        }), { path, specifier, loadedBy, dirname: dirname(path), cli: imported[mode]?.cli, isServer: mode === 'server' });
         if (!plugin[mode])
             throw `Plugin does not support running ${mode}-side`;
         if (!safeMode) {
-            if (plugin[mode].cli)
-                await import(resolve(plugin.dirname, plugin[mode].cli));
+            if (plugin.cli)
+                await import(resolve(plugin.dirname, plugin.cli));
             if (mode == 'client') {
                 if (plugin.client.hooks)
                     Object.assign(plugin, { _client: await import(resolve(plugin.dirname, plugin.client.hooks)) });

package/dist/packages.d.ts

@@ -0,0 +1,12 @@
+export declare function locatePackage(specifier: string, loadedBy: string): string;
+export interface PackageVersionInfo {
+    name: string;
+    version: string;
+    latest: string | null;
+}
+export declare function setPackageCacheTTL(seconds: number): void;
+/**
+ * @param name Package name
+ * @param version The current/installed version
+ */
+export declare function getVersionInfo(specifier: string, from?: string): Promise<PackageVersionInfo>;

package/dist/packages.js

@@ -0,0 +1,51 @@
+import * as fs from 'node:fs';
+import { dirname, join, resolve } from 'node:path/posix';
+import { fileURLToPath } from 'node:url';
+import { lt as ltVersion } from 'semver';
+import { warn } from './io.js';
+function isRelative(specifier) {
+    return specifier[0] == '/' || ['.', '..'].includes(specifier.split('/')[0]);
+}
+export function locatePackage(specifier, loadedBy) {
+    if (isRelative(specifier)) {
+        const path = resolve(dirname(loadedBy), specifier);
+        const stats = fs.statSync(path);
+        if (stats.isFile())
+            return path;
+        if (!stats.isDirectory())
+            throw new Error('Can not resolve package path: ' + path);
+        return join(path, 'package.json');
+    }
+    let packageDir = dirname(fileURLToPath(import.meta.resolve(specifier)));
+    for (; !fs.existsSync(join(packageDir, 'package.json')); packageDir = dirname(packageDir))
+        ;
+    return join(packageDir, 'package.json');
+}
+let cacheTTL = 1000 * 60 * 60;
+export function setPackageCacheTTL(seconds) {
+    cacheTTL = seconds * 1000;
+}
+const cache = new Map();
+/**
+ * @param name Package name
+ * @param version The current/installed version
+ */
+export async function getVersionInfo(specifier, from = import.meta.filename) {
+    const path = locatePackage(specifier, from);
+    const { version, name } = JSON.parse(fs.readFileSync(path, 'utf8'));
+    const info = { name, version, latest: null };
+    if (isRelative(specifier))
+        return info;
+    const cached = cache.get(specifier);
+    const useCache = cached && Date.now() - cached.timestamp < cacheTTL;
+    try {
+        const pkg = useCache ? cached.data : await fetch('https://registry.npmjs.org/' + specifier).then(res => res.json());
+        if (!useCache)
+            cache.set(specifier, { timestamp: Date.now(), data: pkg });
+        info.latest = pkg['dist-tags']?.latest || Object.keys(pkg.versions).sort((a, b) => (ltVersion(a, b) ? 1 : -1))[0];
+    }
+    catch (e) {
+        warn(`Failed to fetch version info for package ${name}: ${e instanceof Error ? e.message : String(e)}`);
+    }
+    return info;
+}

package/dist/plugins.d.ts

@@ -22,13 +22,15 @@ export declare const Plugin: z.ZodObject<{
         routes: z.ZodOptional<z.ZodString>;
         db: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
+    /** If set Axium can check the npm registry for updates */
+    update_checks: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$loose>;
 export type Plugin = z.infer<typeof Plugin>;
 export interface PluginInfo {
     path: string;
     dirname: string;
     specifier: string;
-    _loadedBy: string;
+    loadedBy: string;
     cli?: string;
     /** @internal */
     _hooks?: ServerHooks;

package/dist/plugins.js

@@ -1,7 +1,7 @@
 import * as z from 'zod';
-import { zAsyncFunction } from './schemas.js';
 import { App } from './apps.js';
 import { debug, warn } from './io.js';
+import { zAsyncFunction } from './schemas.js';
 const PluginCommon = z.object({
     /** CLI mixin path */
     cli: z.string().optional(),
@@ -22,6 +22,8 @@ export const Plugin = z.looseObject({
         routes: z.string().optional(),
         db: z.string().optional(),
     }).optional(),
+    /** If set Axium can check the npm registry for updates */
+    update_checks: z.boolean().nullish(),
 });
 export const plugins = new Map();
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/core",
-	"version": "0.12.1",
+	"version": "0.14.0",
 	"author": "James Prevett <axium@jamespre.dev>",
 	"funding": {
 		"type": "individual",
@@ -35,6 +35,8 @@
 	},
 	"dependencies": {
 		"@simplewebauthn/types": "^12.0.0",
-		"mime": "^4.0.7"
+		"@types/semver": "^7.7.1",
+		"mime": "^4.0.7",
+		"semver": "^7.7.3"
 	}
 }