@voltro/plugin-moderation 0.33.0 → 0.34.0

package/dist/index.d.ts

@@ -54,7 +54,8 @@ export declare interface FlaggedItem {
     status: 'pending' | 'confirmed' | 'dismissed';
 }
 
-/** Zero-dep denylist matcher. Case-insensitive whole-word match. */
+/** Zero-dep denylist matcher. Case-insensitive; whole-word where the term has
+ *  word edges (see {@link termMatcher}). */
 export declare const keywordProvider: (deny: ReadonlyArray<string>) => ModerationProvider;
 
 /** Moderate arbitrary text in a handler (e.g. to redact before writing) — the
@@ -72,6 +73,24 @@ export declare interface ModerationPluginOptions {
         tag: string;
         verdict: ModerationVerdict;
     }) => void;
+    /**
+     * Namespace for this plugin's inspect endpoints. Default `moderation`.
+     *
+     * Set it when your app already publishes under that name — an exact tag
+     * collision is fatal at codegen, and this is the way out. Orthogonal to
+     * `name` below: `alias` REPLACES the namespace, `name` distinguishes two
+     * installations within it.
+     *
+     * The cost, stated because nothing else states it: the local and cloud
+     * dashboards fetch this plugin's panel at the DEFAULT slug, so an aliased
+     * install keeps working while its dashboard panel 404s. Alias to escape a
+     * collision, not for taste.
+     */
+    readonly alias?: string;
+    /**
+     * Discriminator for a SECOND installation of this plugin, when one app runs
+     * two (`@voltro/plugin-moderation#analytics`). Not a rename — for that use `alias`.
+     */
     readonly name?: string;
 }
 

package/dist/index.js

@@ -1,19 +1,25 @@
 import { ContentRejected as e } from "./errors.js";
 import { Context as t, Effect as n, Layer as r } from "effect";
-import { definePlugin as i } from "@voltro/protocol";
-import { createLogger as a } from "@voltro/logger";
+import { definePlugin as i, pluginInstanceName as a } from "@voltro/protocol";
+import { createLogger as o } from "@voltro/logger";
 //#region src/providers.ts
-var o = a({ scope: "@voltro/plugin-moderation" }), s = { flagged: !1 }, c = (e) => {
-	let t = e.map((e) => e.toLowerCase());
+var s = o({ scope: "@voltro/plugin-moderation" }), c = { flagged: !1 }, l = /[.*+?^${}()|[\]\\]/g, u = (e) => {
+	let t = (e) => e !== void 0 && /[\p{L}\p{N}_]/u.test(e), n = t(e[0]) ? "\\b" : "", r = t(e[e.length - 1]) ? "\\b" : "";
+	return RegExp(`${n}${e.replace(l, "\\$&")}${r}`, "u");
+}, d = (e) => {
+	let t = e.filter((e) => e.length > 0).map((e) => ({
+		term: e.toLowerCase(),
+		re: u(e.toLowerCase())
+	}));
 	return (e) => n.sync(() => {
-		let n = e.toLowerCase(), r = t.filter((e) => RegExp(`\\b${e.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`).test(n));
+		let n = e.toLowerCase(), r = t.filter((e) => e.re.test(n)).map((e) => e.term);
 		return r.length > 0 ? {
 			flagged: !0,
 			categories: r,
 			reason: `matched denied term(s): ${r.join(", ")}`
-		} : s;
+		} : c;
 	});
-}, l = (e = {}) => {
+}, f = (e = {}) => {
 	let t = e.threshold ?? .7, r = e.categories ?? [
 		"hate",
 		"harassment",
@@ -23,80 +29,89 @@ var o = a({ scope: "@voltro/plugin-moderation" }), s = { flagged: !1 }, c = (e)
 		"illicit"
 	], i = e.load ?? (() => import("@voltro/ai")), a = !1;
 	return (e) => n.gen(function* () {
-		let c = yield* n.tryPromise(i).pipe(n.catchAll(() => n.succeed(null)));
-		return c === null ? (a || (a = !0, o.warn("aiProvider configured but @voltro/ai could not be loaded — content is NOT being moderated; install @voltro/ai")), s) : yield* n.tryPromise(async () => {
+		let o = yield* n.tryPromise(i).pipe(n.catchAll(() => n.succeed(null)));
+		return o === null ? (a || (a = !0, s.warn("aiProvider configured but @voltro/ai could not be loaded — content is NOT being moderated; install @voltro/ai")), c) : yield* n.tryPromise(async () => {
 			let { Schema: i } = await import("effect"), a = i.Struct({
 				flagged: i.Boolean,
 				topCategory: i.NullOr(i.String),
 				score: i.Number
-			}), { object: o } = await n.runPromise(c.generateObject({
+			}), { object: s } = await n.runPromise(o.generateObject({
 				schema: a,
 				system: `You are a content moderator. Categories: ${r.join(", ")}. Return whether the content violates policy, the worst category, and a 0..1 severity score.`,
 				prompt: e
-			})), s = o.flagged || o.score >= t;
+			})), c = s.flagged || s.score >= t;
 			return {
-				flagged: s,
-				score: o.score,
-				...o.topCategory ? { categories: [o.topCategory] } : {},
-				...s ? { reason: `ai moderation: ${o.topCategory ?? "policy"} (${o.score.toFixed(2)})` } : {}
+				flagged: c,
+				score: s.score,
+				...s.topCategory ? { categories: [s.topCategory] } : {},
+				...c ? { reason: `ai moderation: ${s.topCategory ?? "policy"} (${s.score.toFixed(2)})` } : {}
 			};
-		}).pipe(n.catchAll(() => n.succeed(s)));
+		}).pipe(n.catchAll(() => n.succeed(c)));
 	});
-}, u = class extends t.Tag("@voltro/plugin-moderation/ModerationService")() {}, d = (e) => n.flatMap(u, (t) => t.moderate(e)), f = (e, t) => {
+}, p = class extends t.Tag("@voltro/plugin-moderation/ModerationService")() {}, m = (e) => n.flatMap(p, (t) => t.moderate(e)), h = (e, t) => {
 	if (typeof e != "object" || !e) return "";
 	let n = e;
 	return t.map((e) => n[e]).filter((e) => typeof e == "string").join("\n");
-}, p = (t) => {
-	let a = t.name ? `@voltro/plugin-moderation#${t.name}` : "@voltro/plugin-moderation", o = (e) => t.rules.filter((t) => typeof t.match == "string" ? t.match === e : t.match.test(e)), s = t.onFlag, c = () => void 0, l = [], d = 0, p = 0, m = 0, h = (e, t, n) => {
-		l.unshift({
-			id: `mod_${Date.now().toString(36)}_${d++}`,
+}, g = "@voltro/plugin-moderation", _ = (t) => {
+	let o = a({
+		base: g,
+		alias: t.alias,
+		instance: t.name
+	}), s = t.rules.map((e) => {
+		let t = e.match;
+		if (typeof t == "string") return (e) => t === e;
+		let n = t.global || t.sticky ? new RegExp(t.source, t.flags.replace(/[gy]/g, "")) : t;
+		return (e) => n.test(e);
+	}), c = (e) => t.rules.filter((t, n) => s[n](e)), l = t.onFlag, u = () => void 0, d = [], f = 0, m = 0, _ = 0, v = (e, t, n) => {
+		d.unshift({
+			id: `mod_${Date.now().toString(36)}_${f++}`,
 			tag: e,
 			categories: n.categories ?? [],
 			reason: n.reason ?? "content policy violation",
 			subjectId: t,
 			at: (/* @__PURE__ */ new Date()).toISOString(),
 			status: "pending"
-		}), l.length > 200 && (l.length = 200);
-	}, g = (r, i) => {
-		let a = o(i.tag);
+		}), d.length > 200 && (d.length = 200);
+	}, y = (r, i) => {
+		let a = c(i.tag);
 		if (a.length === 0) return r;
-		let l = i.subject?.id ?? null;
+		let o = i.subject?.id ?? null;
 		return n.gen(function* () {
 			for (let r of a) {
-				let a = f(i.input, r.fields);
+				let a = h(i.input, r.fields);
 				if (a.length === 0) continue;
-				let o = yield* t.provider(a);
-				if (!o.flagged) continue;
-				let u = o.categories ?? [], d = o.reason ?? "content policy violation";
-				if ((r.action ?? "block") === "block") return p++, h(i.tag, l, o), yield* n.fail(new e({
+				let s = yield* t.provider(a);
+				if (!s.flagged) continue;
+				let c = s.categories ?? [], d = s.reason ?? "content policy violation";
+				if ((r.action ?? "block") === "block") return m++, v(i.tag, o, s), yield* n.fail(new e({
 					tag: i.tag,
-					categories: u,
+					categories: c,
 					reason: d
 				}));
-				m++, h(i.tag, l, o), c(i.tag, o), s?.({
+				_++, v(i.tag, o, s), u(i.tag, s), l?.({
 					tag: i.tag,
-					verdict: o
+					verdict: s
 				});
 			}
 			return yield* r;
 		});
-	}, _ = (e) => ({
+	}, b = (e) => ({
 		kind: "json",
 		data: e
-	}), v = (e, t) => ({
+	}), x = (e, t) => ({
 		kind: "json",
 		status: e,
 		data: { error: t }
-	}), y = [{
+	}), S = [{
 		method: "GET",
 		path: "/flagged",
 		description: "The content-moderation review queue (newest first).",
-		handler: () => n.succeed(_({
-			items: l.slice(0, 100),
+		handler: () => n.succeed(b({
+			items: d.slice(0, 100),
 			stats: {
-				blocked: p,
-				flagged: m,
-				pending: l.filter((e) => e.status === "pending").length
+				blocked: m,
+				flagged: _,
+				pending: d.filter((e) => e.status === "pending").length
 			}
 		}))
 	}, {
@@ -108,25 +123,26 @@ var o = a({ scope: "@voltro/plugin-moderation" }), s = { flagged: !1 }, c = (e)
 			try {
 				t = JSON.parse(e.body || "{}");
 			} catch {
-				return v(400, "invalid JSON body");
+				return x(400, "invalid JSON body");
 			}
-			if (!t.id || t.action !== "confirm" && t.action !== "dismiss") return v(400, "id + action (confirm|dismiss) required");
-			let n = l.find((e) => e.id === t.id);
-			return n ? (n.status = t.action === "confirm" ? "confirmed" : "dismissed", _({
+			if (!t.id || t.action !== "confirm" && t.action !== "dismiss") return x(400, "id + action (confirm|dismiss) required");
+			let n = d.find((e) => e.id === t.id);
+			return n ? (n.status = t.action === "confirm" ? "confirmed" : "dismissed", b({
 				ok: !0,
 				item: n
-			})) : v(404, `unknown item "${t.id}"`);
+			})) : x(404, `unknown item "${t.id}"`);
 		})
-	}], b = [
+	}], C = [
 		"rpc:intercept:mutation",
 		"rpc:intercept:action",
 		"inspect:read",
 		"inspect:write"
-	], x = r.succeed(u, { moderate: (e) => t.provider(e) });
+	], w = r.succeed(p, { moderate: (e) => t.provider(e) });
 	return i({
-		name: a,
+		name: o,
+		baseName: g,
 		description: "Content moderation — block or flag user-content writes via an AI / keyword / custom check.",
-		permissions: b,
+		permissions: C,
 		errorSchemas: [{
 			schema: e,
 			import: {
@@ -134,18 +150,18 @@ var o = a({ scope: "@voltro/plugin-moderation" }), s = { flagged: !1 }, c = (e)
 				name: "ContentRejected"
 			}
 		}],
-		interceptMutation: g,
-		interceptAction: g,
-		inspectEndpoints: y,
-		services: x,
+		interceptMutation: y,
+		interceptAction: y,
+		inspectEndpoints: S,
+		services: w,
 		onActivate: (e) => n.sync(() => {
-			c = (t, n) => e.logger.warn("content flagged", {
+			u = (t, n) => e.logger.warn("content flagged", {
 				tag: t,
 				categories: n.categories,
 				score: n.score
-			}), s = t.onFlag, e.logger.info("moderation active", { rules: t.rules.length });
+			}), l = t.onFlag, e.logger.info("moderation active", { rules: t.rules.length });
 		})
 	});
 };
 //#endregion
-export { e as ContentRejected, u as ModerationService, l as aiProvider, c as keywordProvider, d as moderate, p as moderationPlugin };
+export { e as ContentRejected, p as ModerationService, f as aiProvider, d as keywordProvider, m as moderate, _ as moderationPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voltro/plugin-moderation",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "Content moderation — run an AI / keyword / custom check on user-content fields and block or flag a write before it commits. Declarative per-rpc rules + an in-handler moderate() helper for redact/inline control.",
   "keywords": [
     "voltro",
@@ -38,11 +38,11 @@
     "node": ">=24.0.0"
   },
   "dependencies": {
-    "@voltro/logger": "0.33.0",
-    "@voltro/protocol": "0.33.0"
+    "@voltro/logger": "0.34.0",
+    "@voltro/protocol": "0.34.0"
   },
   "optionalDependencies": {
-    "@voltro/ai": "0.33.0"
+    "@voltro/ai": "0.34.0"
   },
   "peerDependencies": {
     "effect": "^3.22.0"