@questpie/admin 1.1.1 → 3.0.0

package/dist/server/modules/audit/config/app.mjs

@@ -0,0 +1,262 @@
+import { AUDIT_LOG_COLLECTION } from "../collections/audit-log.mjs";
+import { appConfig, tryGetContext } from "questpie";
+
+//#region src/server/modules/audit/config/app.ts
+/**
+* Check if a collection/global has `audit: false` in its `.admin()` config.
+*/
+function isAuditDisabled(type, name) {
+	try {
+		const app = tryGetContext()?.app;
+		if (!app) return false;
+		if (type === "collection") return (app.getCollectionConfig?.(name))?.state?.admin?.audit === false;
+		return ((app.getGlobals?.())?.[name])?.state?.admin?.audit === false;
+	} catch {
+		return false;
+	}
+}
+/**
+* Compute field-level changes between original and current data.
+* Returns an object of `{ field: { from, to } }` or null if no meaningful changes.
+*/
+function computeChanges(original, current) {
+	if (!original) return null;
+	const changes = {};
+	const skipFields = new Set([
+		"updatedAt",
+		"createdAt",
+		"id"
+	]);
+	for (const key of Object.keys(current)) {
+		if (skipFields.has(key) || key.startsWith("_")) continue;
+		const fromVal = original[key];
+		const toVal = current[key];
+		if (fromVal == null && toVal == null) continue;
+		if (JSON.stringify(fromVal) !== JSON.stringify(toVal)) changes[key] = {
+			from: fromVal ?? null,
+			to: toVal ?? null
+		};
+	}
+	return Object.keys(changes).length > 0 ? changes : null;
+}
+/**
+* Extract a display label from data, trying common field names.
+*/
+function extractLabel(data) {
+	if (!data) return null;
+	for (const field$1 of [
+		"_title",
+		"title",
+		"name",
+		"label",
+		"slug",
+		"id"
+	]) {
+		const val = data[field$1];
+		if (val != null && typeof val === "string" && val.length > 0) return val.length > 200 ? `${val.slice(0, 200)}...` : val;
+	}
+	return null;
+}
+/**
+* Get the display label for a resource type (collection or global).
+* Falls back to the slug if no label is configured.
+*/
+function getResourceTypeLabel(type, name) {
+	try {
+		const app = tryGetContext()?.app;
+		if (!app) return name;
+		if (type === "collection") {
+			const config$1 = app.getCollectionConfig?.(name);
+			const label$1 = config$1?.state?.admin?.label;
+			if (typeof label$1 === "string") return label$1;
+			if (label$1?.key) return name;
+			return config$1?.state?.label || name;
+		}
+		const config = (app.getGlobals?.())?.[name];
+		const label = config?.state?.admin?.label;
+		if (typeof label === "string") return label;
+		if (label?.key) return name;
+		return config?.state?.label || name;
+	} catch {
+		return name;
+	}
+}
+/**
+* Generate a human-readable title for the audit log entry.
+*/
+function generateTitle(action, _resourceType, resourceTypeLabel, resourceLabel, userName) {
+	const user = userName || "Unknown";
+	const resource = resourceLabel || "(unnamed)";
+	return `${user} ${{
+		create: "created",
+		update: "updated",
+		delete: "deleted",
+		transition: "changed status of"
+	}[action] || action} ${resourceTypeLabel} '${resource}'`;
+}
+async function collectionAfterChange(ctx) {
+	try {
+		const collections = ctx.collections ?? ctx.app?.collections;
+		if (isAuditDisabled("collection", ctx.collection)) return;
+		const action = ctx.operation === "create" ? "create" : "update";
+		const changes = ctx.operation === "update" ? computeChanges(ctx.original, ctx.data) : null;
+		if (ctx.operation === "update" && !changes) return;
+		const resourceLabel = extractLabel(ctx.data);
+		const userName = ctx.session?.user?.name || ctx.session?.user?.email || null;
+		const resourceTypeLabel = getResourceTypeLabel("collection", ctx.collection);
+		await collections[AUDIT_LOG_COLLECTION].create({
+			action,
+			resourceType: "collection",
+			resource: ctx.collection,
+			resourceId: ctx.data?.id ? String(ctx.data.id) : null,
+			resourceLabel,
+			userId: ctx.session?.user?.id ? String(ctx.session.user.id) : null,
+			userName,
+			locale: ctx.locale || null,
+			changes,
+			metadata: null,
+			title: generateTitle(action, "collection", resourceTypeLabel, resourceLabel, userName)
+		}, {
+			accessMode: "system",
+			db: ctx.db
+		});
+	} catch (err) {
+		console.error(`[Audit] Failed to log ${ctx.operation} for collection "${ctx.collection}":`, err);
+	}
+}
+async function collectionAfterDelete(ctx) {
+	try {
+		const collections = ctx.collections ?? ctx.app?.collections;
+		if (isAuditDisabled("collection", ctx.collection)) return;
+		const resourceLabel = extractLabel(ctx.data);
+		const userName = ctx.session?.user?.name || ctx.session?.user?.email || null;
+		const resourceTypeLabel = getResourceTypeLabel("collection", ctx.collection);
+		await collections[AUDIT_LOG_COLLECTION].create({
+			action: "delete",
+			resourceType: "collection",
+			resource: ctx.collection,
+			resourceId: ctx.data?.id ? String(ctx.data.id) : null,
+			resourceLabel,
+			userId: ctx.session?.user?.id ? String(ctx.session.user.id) : null,
+			userName,
+			locale: ctx.locale || null,
+			changes: null,
+			metadata: null,
+			title: generateTitle("delete", "collection", resourceTypeLabel, resourceLabel, userName)
+		}, {
+			accessMode: "system",
+			db: ctx.db
+		});
+	} catch (err) {
+		console.error(`[Audit] Failed to log delete for collection "${ctx.collection}":`, err);
+	}
+}
+async function collectionAfterTransition(ctx) {
+	try {
+		const collections = ctx.collections ?? ctx.app?.collections;
+		if (isAuditDisabled("collection", ctx.collection)) return;
+		const resourceLabel = extractLabel(ctx.data);
+		const userName = ctx.session?.user?.name || ctx.session?.user?.email || null;
+		const resourceTypeLabel = getResourceTypeLabel("collection", ctx.collection);
+		await collections[AUDIT_LOG_COLLECTION].create({
+			action: "transition",
+			resourceType: "collection",
+			resource: ctx.collection,
+			resourceId: ctx.data?.id ? String(ctx.data.id) : null,
+			resourceLabel,
+			userId: ctx.session?.user?.id ? String(ctx.session.user.id) : null,
+			userName,
+			locale: ctx.locale || null,
+			changes: { stage: {
+				from: ctx.fromStage,
+				to: ctx.toStage
+			} },
+			metadata: {
+				fromStage: ctx.fromStage,
+				toStage: ctx.toStage
+			},
+			title: generateTitle("transition", "collection", resourceTypeLabel, resourceLabel, userName)
+		}, {
+			accessMode: "system",
+			db: ctx.db
+		});
+	} catch (err) {
+		console.error(`[Audit] Failed to log transition for collection "${ctx.collection}":`, err);
+	}
+}
+async function globalAfterChange(ctx) {
+	try {
+		const collections = ctx.collections ?? ctx.app?.collections;
+		if (isAuditDisabled("global", ctx.global)) return;
+		const userName = ctx.session?.user?.name || ctx.session?.user?.email || null;
+		const resourceTypeLabel = getResourceTypeLabel("global", ctx.global);
+		await collections[AUDIT_LOG_COLLECTION].create({
+			action: "update",
+			resourceType: "global",
+			resource: ctx.global,
+			resourceId: null,
+			resourceLabel: ctx.global,
+			userId: ctx.session?.user?.id ? String(ctx.session.user.id) : null,
+			userName,
+			locale: ctx.locale || null,
+			changes: null,
+			metadata: null,
+			title: generateTitle("update", "global", resourceTypeLabel, ctx.global, userName)
+		}, {
+			accessMode: "system",
+			db: ctx.db
+		});
+	} catch (err) {
+		console.error(`[Audit] Failed to log update for global "${ctx.global}":`, err);
+	}
+}
+async function globalAfterTransition(ctx) {
+	try {
+		const collections = ctx.collections ?? ctx.app?.collections;
+		if (isAuditDisabled("global", ctx.global)) return;
+		const userName = ctx.session?.user?.name || ctx.session?.user?.email || null;
+		const resourceTypeLabel = getResourceTypeLabel("global", ctx.global);
+		await collections[AUDIT_LOG_COLLECTION].create({
+			action: "transition",
+			resourceType: "global",
+			resource: ctx.global,
+			resourceId: null,
+			resourceLabel: ctx.global,
+			userId: ctx.session?.user?.id ? String(ctx.session.user.id) : null,
+			userName,
+			locale: ctx.locale || null,
+			changes: { stage: {
+				from: ctx.fromStage,
+				to: ctx.toStage
+			} },
+			metadata: {
+				fromStage: ctx.fromStage,
+				toStage: ctx.toStage
+			},
+			title: generateTitle("transition", "global", resourceTypeLabel, ctx.global, userName)
+		}, {
+			accessMode: "system",
+			db: ctx.db
+		});
+	} catch (err) {
+		console.error(`[Audit] Failed to log transition for global "${ctx.global}":`, err);
+	}
+}
+/**
+* Audit hooks contributed by the audit module.
+* Intercepts all collection and global mutations to create audit log entries.
+*/
+var app_default = appConfig({ hooks: {
+	collections: {
+		afterChange: collectionAfterChange,
+		afterDelete: collectionAfterDelete,
+		afterTransition: collectionAfterTransition
+	},
+	globals: {
+		afterChange: globalAfterChange,
+		afterTransition: globalAfterTransition
+	}
+} });
+
+//#endregion
+export { app_default as default };

package/dist/server/modules/audit/index.d.mts

@@ -0,0 +1,2 @@
+import { auditLogCollection } from "./collections/audit-log.mjs";
+import { AuditModule, _module } from "./.generated/module.mjs";

package/dist/server/modules/audit/jobs/audit-cleanup.d.mts

@@ -0,0 +1,13 @@
+import * as questpie120 from "questpie";
+
+//#region src/server/modules/audit/jobs/audit-cleanup.d.ts
+
+/**
+ * Audit log cleanup job.
+ * Runs daily (via cron) to delete entries older than the configured retention period.
+ */
+declare const auditCleanupJob: questpie120.JobDefinition<{
+  retentionDays: number;
+}, void, "audit-cleanup">;
+//#endregion
+export { auditCleanupJob };

package/dist/server/modules/audit/jobs/audit-cleanup.mjs

@@ -0,0 +1,28 @@
+import { AUDIT_LOG_COLLECTION } from "../collections/audit-log.mjs";
+import { z } from "zod";
+import { job } from "questpie";
+import { sql as sql$1 } from "drizzle-orm";
+
+//#region src/server/modules/audit/jobs/audit-cleanup.ts
+/**
+* Audit log cleanup job.
+* Runs daily (via cron) to delete entries older than the configured retention period.
+*/
+const auditCleanupJob = job({
+	name: "audit-cleanup",
+	schema: z.object({ retentionDays: z.number().int().positive().default(90) }),
+	handler: async (ctx) => {
+		const { payload } = ctx;
+		const app = ctx.app;
+		const db = ctx.db;
+		const cutoff = /* @__PURE__ */ new Date();
+		cutoff.setDate(cutoff.getDate() - payload.retentionDays);
+		const result = await db.execute(sql$1`DELETE FROM ${sql$1.identifier(AUDIT_LOG_COLLECTION)} WHERE created_at < ${cutoff}`);
+		const deletedCount = typeof result?.rowCount === "number" ? result.rowCount : 0;
+		if (deletedCount > 0) app?.logger?.info?.(`[Audit] Cleaned up ${deletedCount} audit log entries older than ${payload.retentionDays} days`);
+	},
+	options: { cron: "0 3 * * *" }
+});
+
+//#endregion
+export { auditCleanupJob };

package/dist/server/plugin.d.mts

@@ -0,0 +1,26 @@
+import { CodegenPlugin } from "questpie";
+
+//#region src/server/plugin.d.ts
+
+/**
+ * Admin codegen plugin.
+ *
+ * Discovers admin-specific file conventions:
+ * - `views/*.ts` — custom view definitions (list, form, etc.)
+ * - `components/*.ts` — component definitions with typed props
+ * - `blocks/*.ts` — visual block editor blocks
+ * - `sidebar.ts` — sidebar contribution
+ * - `dashboard.ts` — dashboard contribution
+ * - `branding.ts` — admin branding config
+ * - `admin-locale.ts` — admin UI locale config
+ *
+ * Extends collection/global builders with:
+ * - `.admin()` — admin config (label, icon, group, etc.)
+ * - `.list()` — list view config (columns, sort, filter, etc.)
+ * - `.form()` — form view config (fields, sidebar, tabs, etc.)
+ * - `.preview()` — live preview config
+ * - `.actions()` — custom actions config
+ */
+declare function adminPlugin(): CodegenPlugin;
+//#endregion
+export { adminPlugin };