@axium/core 0.7.0 → 0.8.0

package/dist/api.d.ts

@@ -2,10 +2,12 @@ import type { PublicKeyCredentialCreationOptionsJSON, PublicKeyCredentialRequest
 import type z from 'zod';
 import type { AccessControl } 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 { RequestMethod } from './requests.js';
-import type { LogoutSessions, User, UserAuthOptions, UserChangeable, UserPublic, UserRegistration } from './user.js';
+import type { LogoutSessions, User, UserAuthOptions, UserChangeable, UserInternal, UserPublic, UserRegistration } from './user.js';
+import type { PluginInternal } from './plugins.js';
 /**
  * Types for all API endpoints
  * @internal
@@ -88,6 +90,40 @@ export interface $API {
             permission: number;
         }, AccessControl];
     };
+    'admin/summary': {
+        GET: {
+            users: number;
+            passkeys: number;
+            sessions: number;
+            auditEvents: Record<keyof typeof Severity, number>;
+            configFiles: number;
+            plugins: number;
+            version: string;
+        };
+    };
+    'admin/users/all': {
+        GET: UserInternal[];
+    };
+    'admin/users/:userId': {
+        GET: UserInternal & {
+            sessions: Session[];
+        };
+    };
+    'admin/config': {
+        GET: {
+            files: Record<string, object>;
+            config: Record<string, unknown>;
+        };
+    };
+    'admin/plugins': {
+        GET: PluginInternal[];
+    };
+    'admin/audit/events': {
+        GET: [filter: z.input<typeof AuditFilter>, result: AuditEvent[]];
+    };
+    'admin/audit/:eventId': {
+        GET: AuditEvent;
+    };
 }
 export type Endpoint = keyof $API;
 export type APIFunction<Method extends RequestMethod, E extends Endpoint> = Method extends keyof $API[E] ? $API[E][Method] extends [infer Body, infer Result] ? (body: Body) => Promise<Result> : () => $API[E][Method] : unknown;

package/dist/audit.d.ts

@@ -0,0 +1,43 @@
+import * as z from 'zod';
+import type { User } from './user.js';
+export declare enum Severity {
+    Emergency = 0,
+    Alert = 1,
+    Critical = 2,
+    Error = 3,
+    Warning = 4,
+    Notice = 5,
+    Info = 6,
+    Debug = 7
+}
+export declare const severityNames: Lowercase<keyof typeof Severity>[];
+export interface AuditEvent<T extends Record<string, unknown> = Record<string, unknown>> {
+    /** UUID of the event */
+    id: string;
+    /** UUID of the user that triggered the event. `null` for events triggered via the server CLI */
+    userId: string | null;
+    user?: (Pick<User, 'id' | 'name'> & Partial<User>) | null;
+    /** When the event happened */
+    timestamp: Date;
+    /** How severe the event is */
+    severity: Severity;
+    /** Snake case name for the event */
+    name: string;
+    /** The source of the event. This should be a package name */
+    source: string;
+    /** Tags for the event. For example, `auth` for authentication events */
+    tags: string[];
+    /** Additional event specific data. */
+    extra: T;
+}
+export declare const AuditFilter: z.ZodObject<{
+    since: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+    until: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodUUID, z.ZodPipe<z.ZodLiteral<"null">, z.ZodTransform<null, "null">>]>>>;
+    severity: z.ZodOptional<z.ZodPipe<z.ZodLiteral<"error" | "debug" | "emergency" | "alert" | "critical" | "warning" | "notice" | "info">, z.ZodTransform<Severity, "error" | "debug" | "emergency" | "alert" | "critical" | "warning" | "notice" | "info">>>;
+    source: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    event: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export interface AuditFilter extends z.infer<typeof AuditFilter> {
+}

package/dist/audit.js

@@ -0,0 +1,28 @@
+import { capitalize, uncapitalize } from 'utilium/string.js';
+import * as z from 'zod';
+export var Severity;
+(function (Severity) {
+    Severity[Severity["Emergency"] = 0] = "Emergency";
+    Severity[Severity["Alert"] = 1] = "Alert";
+    Severity[Severity["Critical"] = 2] = "Critical";
+    Severity[Severity["Error"] = 3] = "Error";
+    Severity[Severity["Warning"] = 4] = "Warning";
+    Severity[Severity["Notice"] = 5] = "Notice";
+    Severity[Severity["Info"] = 6] = "Info";
+    Severity[Severity["Debug"] = 7] = "Debug";
+})(Severity || (Severity = {}));
+export const severityNames = Object.keys(Severity)
+    .filter(k => isNaN(Number(k)))
+    .map(uncapitalize);
+export const AuditFilter = z.object({
+    since: z.coerce.date().optional(),
+    until: z.coerce.date().optional(),
+    user: z.union([z.uuid(), z.literal(['null']).transform(() => null)]).nullish(),
+    severity: z
+        .literal(severityNames)
+        .transform(v => Severity[capitalize(v)])
+        .optional(),
+    source: z.string().optional(),
+    tags: z.string().array().optional(),
+    event: z.string().optional(),
+});

package/dist/color.d.ts

@@ -0,0 +1 @@
+export declare function colorHash(input: string): `rgb(${number}, ${number}, ${number})`;

package/dist/color.js

@@ -0,0 +1,11 @@
+export function colorHash(input) {
+    let color = input.charCodeAt(0);
+    for (let i = 1; i < input.length; i++) {
+        color *= input.charCodeAt(i);
+    }
+    color &= 0xbfbfbf;
+    const r = (color >> 16) & 0xff;
+    const g = (color >> 8) & 0xff;
+    const b = color & 0xff;
+    return `rgb(${r}, ${g}, ${b})`;
+}

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 export * from './access.js';
 export * from './api.js';
 export * from './apps.js';
+export * from './audit.js';
 export * from './auth.js';
 export * as icons from './icons.js';
 export * from './passkeys.js';
+export * from './plugins.js';
 export * from './preferences.js';
 export * from './requests.js';
 export * from './schemas.js';

package/dist/index.js

@@ -1,9 +1,11 @@
 export * from './access.js';
 export * from './api.js';
 export * from './apps.js';
+export * from './audit.js';
 export * from './auth.js';
 export * as icons from './icons.js';
 export * from './passkeys.js';
+export * from './plugins.js';
 export * from './preferences.js';
 export * from './requests.js';
 export * from './schemas.js';

package/dist/plugins.d.ts

@@ -0,0 +1,49 @@
+import * as z from 'zod';
+export declare const Plugin: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    /** The path to the hooks script */
+    hooks: z.ZodOptional<z.ZodString>;
+    /** The path to the HTTP handler */
+    http_handler: z.ZodOptional<z.ZodString>;
+    apps: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        image: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    routes: z.ZodOptional<z.ZodString>;
+}, 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 _hooks?: Hooks;
+}
+export declare const PluginHooks: 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>>>;
+    db_init: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
+    remove: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
+    db_wipe: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
+    clean: z.ZodOptional<z.ZodCustom<(...args: any[]) => any, (...args: any[]) => any>>;
+}, z.core.$strip>;
+interface _InitOptions {
+    force?: boolean;
+    skip: boolean;
+    check: boolean;
+}
+export interface Hooks {
+    statusText?(): string | Promise<string>;
+    db_init?: (opt: _InitOptions) => void | Promise<void>;
+    remove?: (opt: {
+        force?: boolean;
+    }) => void | Promise<void>;
+    db_wipe?: (opt: {
+        force?: boolean;
+    }) => void | Promise<void>;
+    clean?: (opt: Partial<_InitOptions>) => void | Promise<void>;
+}
+export {};

package/dist/plugins.js

@@ -0,0 +1,22 @@
+import * as z from 'zod';
+import { zAsyncFunction } from './schemas.js';
+import { App } from './apps.js';
+export const Plugin = z.looseObject({
+    name: z.string(),
+    version: z.string(),
+    description: z.string().optional(),
+    /** The path to the hooks script */
+    hooks: z.string().optional(),
+    /** The path to the HTTP handler */
+    http_handler: z.string().optional(),
+    apps: z.array(App).optional(),
+    routes: z.string().optional(),
+});
+const fn = z.custom(data => typeof data === 'function');
+export const PluginHooks = z.object({
+    statusText: zAsyncFunction(z.function({ input: [], output: z.string() })).optional(),
+    db_init: fn.optional(),
+    remove: fn.optional(),
+    db_wipe: fn.optional(),
+    clean: fn.optional(),
+});

package/dist/user.d.ts

@@ -9,15 +9,21 @@ export declare const User: z.ZodObject<{
     preferences: z.ZodRecord<z.ZodString, z.ZodAny>;
     roles: z.ZodArray<z.ZodString>;
     registeredAt: z.ZodDate;
+    isAdmin: z.ZodBoolean;
 }, z.core.$strip>;
 export interface User extends z.infer<typeof User> {
     preferences: Preferences;
 }
+export interface UserInternal extends User {
+    isSuspended: boolean;
+    /** Tags are internal, roles are public */
+    tags: string[];
+}
 export declare const userPublicFields: ["id", "image", "name", "registeredAt", "roles"];
 type UserPublicField = (typeof userPublicFields)[number];
 export interface UserPublic extends Pick<User, UserPublicField> {
 }
-export declare const userProtectedFields: ["email", "emailVerified", "preferences"];
+export declare const userProtectedFields: ["email", "emailVerified", "preferences", "isAdmin"];
 export declare const UserChangeable: z.ZodObject<{
     email: z.ZodOptional<z.ZodEmail>;
     name: z.ZodOptional<z.ZodString>;

package/dist/user.js

@@ -1,5 +1,6 @@
 import * as z from 'zod';
 import { PasskeyRegistration } from './passkeys.js';
+import { colorHash } from './color.js';
 export const User = z.object({
     id: z.uuid(),
     name: z.string().min(1, 'Name is required').max(255, 'Name is too long'),
@@ -9,9 +10,10 @@ export const User = z.object({
     preferences: z.record(z.string(), z.any()),
     roles: z.array(z.string()),
     registeredAt: z.date(),
+    isAdmin: z.boolean(),
 });
 export const userPublicFields = ['id', 'image', 'name', 'registeredAt', 'roles'];
-export const userProtectedFields = ['email', 'emailVerified', 'preferences'];
+export const userProtectedFields = ['email', 'emailVerified', 'preferences', 'isAdmin'];
 export const UserChangeable = User.pick({
     name: true,
     email: true,
@@ -21,17 +23,9 @@ export const UserChangeable = User.pick({
 export function getUserImage(user) {
     if (user.image)
         return user.image;
-    user.name ??= '\0';
-    let color = user.name.charCodeAt(0);
-    for (let i = 1; i < user.name.length; i++) {
-        color *= user.name.charCodeAt(i);
-    }
-    color &= 0xbfbfbf;
-    const r = (color >> 16) & 0xff;
-    const g = (color >> 8) & 0xff;
-    const b = color & 0xff;
-    return `data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" style="background-color:rgb(${r},${g},${b});display:flex;align-items:center;justify-content:center;">
-		<text x="23" y="28" style="font-family:sans-serif;font-weight:bold;" fill="white">${user.name.replaceAll(/\W/g, '')[0]}</text>
+    const color = colorHash(user.name ?? '\0');
+    return `data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" style="background-color:${color};display:flex;align-items:center;justify-content:center;">
+		<text x="23" y="28" style="font-family:sans-serif;font-weight:bold;" fill="white">${(user.name ?? '?').replaceAll(/\W/g, '')[0]}</text>
 	</svg>`.replaceAll(/[\t\n]/g, '');
 }
 export const UserRegistration = z.object({

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@axium/core",
-	"version": "0.7.0",
-	"author": "James Prevett <axium@jamespre.dev> (https://jamespre.dev)",
+	"version": "0.8.0",
+	"author": "James Prevett <axium@jamespre.dev>",
 	"funding": {
 		"type": "individual",
 		"url": "https://github.com/sponsors/james-pre"