@axium/core 0.17.1 → 0.18.0

package/dist/api.d.ts

@@ -497,6 +497,7 @@ declare const _API: {
     };
     readonly 'admin/plugins': {
         readonly GET: z.ZodArray<z.ZodObject<{
+            config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
             name: z.ZodString;
             version: z.ZodString;
             latest: z.ZodNullable<z.ZodString>;
@@ -520,6 +521,7 @@ declare const _API: {
                 http_handler: z.ZodOptional<z.ZodString>;
                 routes: z.ZodOptional<z.ZodString>;
                 db: z.ZodOptional<z.ZodString>;
+                web_client_hooks: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>;
             update_checks: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
             path: z.ZodString;
@@ -528,7 +530,12 @@ declare const _API: {
             loadedBy: z.ZodString;
             isServer: z.ZodBoolean;
             _db: z.ZodOptional<z.ZodAny>;
-        }, z.core.$strip>>;
+            _configPath: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
+        readonly POST: [z.ZodObject<{
+            plugin: z.ZodString;
+            config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        }, z.core.$strip>, z.ZodObject<{}, z.core.$strip>];
     };
     readonly 'admin/audit/events': {
         readonly OPTIONS: z.ZodUnion<[z.ZodObject<{

package/dist/api.js

@@ -5,7 +5,7 @@ import { AuditEvent, AuditFilter, Severity } from './audit.js';
 import { NewSessionResponse, Session, Verification, VerificationInternal } from './auth.js';
 import { PackageVersionInfo } from './packages.js';
 import { Passkey, PasskeyAuthOptions, PasskeyAuthResponse, PasskeyChangeable, PasskeyCreationOptions, PasskeyRegistration, } from './passkeys.js';
-import { PluginInternal } from './plugins.js';
+import { PluginInternal, PluginUpdate } from './plugins.js';
 import { LogoutSessions, User, UserAuthOptions, UserChangeable, UserPublic, UserRegistration, UserRegistrationInit } from './user.js';
 export const AdminSummary = z.object({
     users: z.number(),
@@ -93,7 +93,14 @@ const _API = {
         }),
     },
     'admin/plugins': {
-        GET: z.object({ ...PluginInternal.omit({ _hooks: true, _client: true }).shape, ...PackageVersionInfo.shape }).array(),
+        GET: z
+            .looseObject({
+            ...PluginInternal.omit({ _hooks: true, _client: true }).shape,
+            ...PackageVersionInfo.shape,
+            config: z.record(z.string(), z.any()).optional(),
+        })
+            .array(),
+        POST: [PluginUpdate, z.object({})],
     },
     'admin/audit/events': {
         OPTIONS: z.object({ name: z.string().array(), source: z.string().array(), tags: z.string().array() }).or(z.literal(false)),

package/dist/node/plugins.js

@@ -59,7 +59,6 @@ export async function loadPlugin(mode, specifier, loadedBy, safeMode = false) {
                 }
             }
         }
-        Object.freeze(plugin);
         if (plugins.has(plugin.name))
             throw 'Plugin already loaded';
         if (plugin.name.startsWith('#') || plugin.name.includes(' ')) {

package/dist/plugins.d.ts

@@ -3,6 +3,7 @@ export declare const PluginServerHooks: z.ZodObject<{
     statusText: z.ZodOptional<z.ZodCustom<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [], null>, z.ZodString>, z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [], null>, z.ZodString>>>;
     remove: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
     clean: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
+    load: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
 }, z.core.$strip>;
 interface _InitOptions {
     force?: boolean;
@@ -15,6 +16,7 @@ export interface ServerHooks {
         force?: boolean;
     }) => void | Promise<void>;
     clean?: (opt: Partial<_InitOptions>) => void | Promise<void>;
+    load?(): void | Promise<void>;
 }
 export interface ClientHooks {
     run(): void | Promise<void>;
@@ -41,9 +43,12 @@ export declare const Plugin: z.ZodObject<{
         http_handler: z.ZodOptional<z.ZodString>;
         routes: z.ZodOptional<z.ZodString>;
         db: z.ZodOptional<z.ZodString>;
+        web_client_hooks: 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>>;
+    /** In plugin's packages, this is the default. At runtime this is the loaded config */
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, z.core.$loose>;
 export interface Plugin extends z.infer<typeof Plugin> {
 }
@@ -57,10 +62,12 @@ export declare const PluginInfo: z.ZodObject<{
         statusText: z.ZodOptional<z.ZodCustom<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [], null>, z.ZodString>, z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [], null>, z.ZodString>>>;
         remove: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
         clean: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
+        load: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
     }, z.core.$strip>>;
     _client: z.ZodOptional<z.ZodAny>;
     isServer: z.ZodBoolean;
     _db: z.ZodOptional<z.ZodAny>;
+    _configPath: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export interface PluginInfo extends z.infer<typeof PluginInfo> {
 }
@@ -74,10 +81,12 @@ export declare const PluginInternal: z.ZodObject<{
         statusText: z.ZodOptional<z.ZodCustom<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [], null>, z.ZodString>, z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [], null>, z.ZodString>>>;
         remove: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
         clean: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
+        load: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
     }, z.core.$strip>>;
     _client: z.ZodOptional<z.ZodAny>;
     isServer: z.ZodBoolean;
     _db: z.ZodOptional<z.ZodAny>;
+    _configPath: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     version: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
@@ -99,11 +108,14 @@ export declare const PluginInternal: z.ZodObject<{
         http_handler: z.ZodOptional<z.ZodString>;
         routes: z.ZodOptional<z.ZodString>;
         db: z.ZodOptional<z.ZodString>;
+        web_client_hooks: 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>>;
+    /** In plugin's packages, this is the default. At runtime this is the loaded config */
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, z.core.$loose>;
-export interface PluginInternal extends Plugin, Readonly<PluginInfo> {
+export interface PluginInternal extends Plugin, PluginInfo {
 }
 export declare const plugins: Map<string, PluginInternal>;
 /**
@@ -111,4 +123,21 @@ export declare const plugins: Map<string, PluginInternal>;
  */
 export declare function _findPlugin(search: string): PluginInternal;
 export declare function runIntegrations(): Promise<void>;
+export interface $PluginConfigs {
+}
+interface PluginConfigData {
+    schema: z.ZodObject;
+    labels: Record<string, string>;
+}
+export declare const serverConfigs: Map<string, PluginConfigData>;
+export declare function setServerConfig(pluginName: string, schema: z.ZodObject, labels?: Record<string, string>): void;
+export declare function getConfig<T extends string>(pluginName: T): T extends keyof $PluginConfigs ? $PluginConfigs[T] : Record<string, unknown>;
+export declare const PluginUpdate: z.ZodObject<{
+    plugin: z.ZodString;
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * Transforms a plugin name into a string suitable for use with file systems.
+ */
+export declare function toBaseName(pluginName: string): string;
 export {};

package/dist/plugins.js

@@ -7,6 +7,7 @@ export const PluginServerHooks = z.object({
     statusText: zAsyncFunction(z.function({ input: [], output: z.string() })).optional(),
     remove: fn.optional(),
     clean: fn.optional(),
+    load: fn.optional(),
 });
 const PluginCommon = z.object({
     /** CLI mixin path */
@@ -27,9 +28,12 @@ export const Plugin = z.looseObject({
         /** The path to the HTTP handler used by the server */
         routes: z.string().optional(),
         db: z.string().optional(),
+        web_client_hooks: z.string().optional(),
     }).optional(),
     /** If set Axium can check the npm registry for updates */
     update_checks: z.boolean().nullish(),
+    /** In plugin's packages, this is the default. At runtime this is the loaded config */
+    config: z.record(z.string(), z.any()).optional(),
 });
 export const PluginInfo = z.object({
     path: z.string(),
@@ -43,6 +47,7 @@ export const PluginInfo = z.object({
     _client: z.any().optional(),
     isServer: z.boolean(),
     _db: z.any().optional(),
+    _configPath: z.string().optional(),
 });
 export const PluginInternal = z.looseObject({ ...Plugin.shape, ...PluginInfo.shape });
 export const plugins = new Map();
@@ -71,3 +76,23 @@ export async function runIntegrations() {
         }
     }
 }
+export const serverConfigs = new Map();
+export function setServerConfig(pluginName, schema, labels = {}) {
+    serverConfigs.set(pluginName, { schema, labels });
+}
+export function getConfig(pluginName) {
+    const plugin = _findPlugin(pluginName);
+    return plugin.config;
+}
+export const PluginUpdate = z.object({
+    plugin: z.string(),
+    config: z.record(z.string(), z.any()).optional(),
+});
+/**
+ * Transforms a plugin name into a string suitable for use with file systems.
+ */
+export function toBaseName(pluginName) {
+    if (pluginName[0] == '@')
+        pluginName = pluginName.slice(1);
+    return pluginName.replaceAll('/', '_');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/core",
-	"version": "0.17.1",
+	"version": "0.18.0",
 	"author": "James Prevett <axium@jamespre.dev>",
 	"funding": {
 		"type": "individual",