@axium/core 0.12.0 → 0.13.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,14 @@
 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 { Passkey, PasskeyAuthenticationResponse, PasskeyChangeable, PasskeyRegistration } from './passkeys.js';
+import type { PluginInternal, PluginVersionInfo } 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;
@@ -115,7 +116,7 @@ export interface $API {
         };
     };
     'admin/plugins': {
-        GET: PluginInternal[];
+        GET: (Omit<PluginInternal, '_hooks' | '_client'> & PluginVersionInfo)[];
     };
     '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

@@ -19,9 +19,9 @@ 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) {
+function _locatePlugin(specifier, loadedBy) {
     if (specifier[0] == '/' || ['.', '..'].includes(specifier.split('/')[0])) {
-        const path = resolve(dirname(_loadedBy), specifier);
+        const path = resolve(dirname(loadedBy), specifier);
         const stats = fs.statSync(path);
         if (stats.isFile())
             return path;
@@ -34,10 +34,10 @@ function _locatePlugin(specifier, _loadedBy) {
         ;
     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 = _locatePlugin(specifier, loadedBy);
+        io.debug(`Loading plugin at ${path} (from ${loadedBy})`);
         let imported;
         try {
             imported = JSON.parse(fs.readFileSync(path, 'utf8'));
@@ -49,7 +49,7 @@ 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) {

package/dist/plugins.d.ts

@@ -12,28 +12,34 @@ export declare const Plugin: z.ZodObject<{
     client: z.ZodOptional<z.ZodObject<{
         cli: z.ZodOptional<z.ZodString>;
         hooks: z.ZodOptional<z.ZodString>;
+        integrations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>>;
     server: z.ZodOptional<z.ZodObject<{
+        cli: z.ZodOptional<z.ZodString>;
         hooks: z.ZodOptional<z.ZodString>;
+        integrations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         http_handler: z.ZodOptional<z.ZodString>;
         routes: z.ZodOptional<z.ZodString>;
-        cli: 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 PluginInternal extends Plugin {
-    readonly path: string;
-    readonly dirname: string;
-    readonly specifier: string;
-    readonly _loadedBy: string;
-    readonly cli?: string;
+export interface PluginInfo {
+    path: string;
+    dirname: string;
+    specifier: string;
+    loadedBy: string;
+    cli?: string;
     /** @internal */
-    readonly _hooks?: ServerHooks;
+    _hooks?: ServerHooks;
     /** @internal */
-    readonly _client?: ClientHooks;
-    readonly isServer: boolean;
-    readonly _db?: any;
+    _client?: ClientHooks;
+    isServer: boolean;
+    _db?: any;
+}
+export interface PluginInternal extends Plugin, Readonly<PluginInfo> {
 }
 export declare const plugins: Map<string, PluginInternal>;
 /**
@@ -60,4 +66,9 @@ export interface ServerHooks {
 export interface ClientHooks {
     run(): void | Promise<void>;
 }
+export declare function runIntegrations(): Promise<void>;
+export interface PluginVersionInfo {
+    latest: string | null;
+}
+export declare function getVersionInfo(plugin: PluginInternal): Promise<PluginVersionInfo>;
 export {};

package/dist/plugins.js

@@ -1,31 +1,30 @@
 import * as z from 'zod';
 import { zAsyncFunction } from './schemas.js';
 import { App } from './apps.js';
+import { debug, info, warn } from './io.js';
+import { lt as ltVersion } from 'semver';
+const PluginCommon = z.object({
+    /** CLI mixin path */
+    cli: z.string().optional(),
+    /** The path to the hooks script */
+    hooks: z.string().optional(),
+    /** A map of plugin names to paths */
+    integrations: z.record(z.string(), z.string()).optional(),
+});
 export const Plugin = z.looseObject({
     name: z.string(),
     version: z.string(),
     description: z.string().optional(),
     apps: z.array(App).optional(),
-    client: z
-        .object({
-        /** CLI mixin path */
-        cli: z.string().optional(),
-        /** The path to the hooks script */
-        hooks: z.string().optional(),
-    })
-        .optional(),
-    server: z
-        .object({
-        /** The path to the hooks script */
-        hooks: z.string().optional(),
+    client: PluginCommon.extend({}).optional(),
+    server: PluginCommon.extend({
         http_handler: z.string().optional(),
         /** The path to the HTTP handler used by the server */
         routes: z.string().optional(),
-        /** CLI mixin path */
-        cli: z.string().optional(),
         db: z.string().optional(),
-    })
-        .optional(),
+    }).optional(),
+    /** If set Axium can check the npm registry for updates */
+    update_checks: z.boolean().nullish(),
 });
 export const plugins = new Map();
 /**
@@ -43,3 +42,33 @@ export const PluginServerHooks = z.object({
     remove: fn.optional(),
     clean: fn.optional(),
 });
+export async function runIntegrations() {
+    for (const [pluginName, plugin] of plugins) {
+        const { integrations } = plugin[plugin.isServer ? 'server' : 'client'];
+        if (!integrations)
+            continue;
+        for (const [name, path] of Object.entries(integrations)) {
+            if (!plugins.has(name))
+                continue;
+            debug(`Running ${pluginName} integration with ${name}`);
+            await import(path).catch(e => {
+                const text = e instanceof Error ? e.stack : String(e);
+                warn(`Failed to load ${pluginName} integration with ${name}:\n\t${text}`);
+            });
+        }
+    }
+}
+export async function getVersionInfo(plugin) {
+    if (!plugin.update_checks)
+        return { latest: null };
+    try {
+        const res = await fetch('https://registry.npmjs.org/' + plugin.name);
+        const pkg = await res.json();
+        const latest = pkg['dist-tags']?.latest || Object.keys(pkg.versions).sort((a, b) => (ltVersion(a, b) ? 1 : -1))[0];
+        return { latest };
+    }
+    catch (e) {
+        warn(`Failed to fetch version info for plugin ${plugin.name}: ${e instanceof Error ? e.message : String(e)}`);
+        return { latest: null };
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/core",
-	"version": "0.12.0",
+	"version": "0.13.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"
 	}
 }