@voltro/plugin-notifications 0.1.0

package/dist/rpc.d.ts

@@ -0,0 +1,60 @@
+import { MutationProcedureDescriptor } from '@voltro/protocol';
+import { PluginRpcClientDescriptor } from '@voltro/protocol';
+import { QueryProcedureDescriptor } from '@voltro/protocol';
+import { Schema } from 'effect';
+
+export declare const clearQuietHoursDescriptor: MutationProcedureDescriptor<"notifications.clearQuietHours", Schema.Struct<{}>, Schema.Struct<{
+    ok: typeof Schema.Boolean;
+}>, typeof Schema.Never>;
+
+export declare const inboxDescriptor: QueryProcedureDescriptor<"notifications.inbox", Schema.Struct<{
+    unreadOnly: Schema.optional<typeof Schema.Boolean>;
+    limit: Schema.optional<typeof Schema.Number>;
+}>, Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>, typeof Schema.Never>;
+
+export declare const markReadDescriptor: MutationProcedureDescriptor<"notifications.markRead", Schema.Struct<{
+    id: typeof Schema.String;
+}>, Schema.Struct<{
+    ok: typeof Schema.Boolean;
+}>, typeof Schema.Never>;
+
+/** Declared for the codegen (`VoltroPlugin.rpcClientDescriptors`) so each tag is
+ *  emitted into the generated client group. Kept in lockstep with the exports. */
+export declare const notificationsRpcClientImports: ReadonlyArray<PluginRpcClientDescriptor>;
+
+export declare const preferencesDescriptor: QueryProcedureDescriptor<"notifications.preferences", Schema.Struct<{}>, Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>, typeof Schema.Never>;
+
+export declare const setPreferenceDescriptor: MutationProcedureDescriptor<"notifications.setPreference", Schema.Struct<{
+    category: typeof Schema.String;
+    channel: typeof Schema.String;
+    enabled: typeof Schema.Boolean;
+}>, Schema.Struct<{
+    ok: typeof Schema.Boolean;
+}>, typeof Schema.Never>;
+
+export declare const setQuietHoursDescriptor: MutationProcedureDescriptor<"notifications.setQuietHours", Schema.Struct<{
+    startMinute: typeof Schema.Number;
+    endMinute: typeof Schema.Number;
+    tz: Schema.optional<typeof Schema.String>;
+    policy: Schema.optional<Schema.Literal<["hold", "drop"]>>;
+}>, Schema.Struct<{
+    ok: typeof Schema.Boolean;
+}>, typeof Schema.Never>;
+
+export declare const subscribeDescriptor: MutationProcedureDescriptor<"notifications.subscribe", Schema.Struct<{
+    topic: typeof Schema.String;
+}>, Schema.Struct<{
+    ok: typeof Schema.Boolean;
+}>, typeof Schema.Never>;
+
+export declare const unreadCountDescriptor: QueryProcedureDescriptor<"notifications.unreadCount", Schema.Struct<{}>, Schema.Struct<{
+    count: typeof Schema.Number;
+}>, typeof Schema.Never>;
+
+export declare const unsubscribeDescriptor: MutationProcedureDescriptor<"notifications.unsubscribe", Schema.Struct<{
+    topic: typeof Schema.String;
+}>, Schema.Struct<{
+    ok: typeof Schema.Boolean;
+}>, typeof Schema.Never>;
+
+export { }

package/dist/rpc.js

@@ -0,0 +1,133 @@
+import { Schema as e } from "effect";
+import { defineMutation as t, defineQuery as n } from "@voltro/protocol";
+//#region src/rpc.ts
+var r = n({
+	name: "notifications.inbox",
+	input: e.Struct({
+		unreadOnly: e.optional(e.Boolean),
+		limit: e.optional(e.Number)
+	}),
+	output: e.Array(e.Record({
+		key: e.String,
+		value: e.Unknown
+	}))
+}), i = n({
+	name: "notifications.unreadCount",
+	input: e.Struct({}),
+	output: e.Struct({ count: e.Number })
+}), a = t({
+	name: "notifications.markRead",
+	input: e.Struct({ id: e.String }),
+	output: e.Struct({ ok: e.Boolean })
+}), o = n({
+	name: "notifications.preferences",
+	input: e.Struct({}),
+	output: e.Array(e.Record({
+		key: e.String,
+		value: e.Unknown
+	}))
+}), s = t({
+	name: "notifications.setPreference",
+	input: e.Struct({
+		category: e.String,
+		channel: e.String,
+		enabled: e.Boolean
+	}),
+	output: e.Struct({ ok: e.Boolean })
+}), c = t({
+	name: "notifications.subscribe",
+	input: e.Struct({ topic: e.String }),
+	output: e.Struct({ ok: e.Boolean })
+}), l = t({
+	name: "notifications.unsubscribe",
+	input: e.Struct({ topic: e.String }),
+	output: e.Struct({ ok: e.Boolean })
+}), u = t({
+	name: "notifications.setQuietHours",
+	input: e.Struct({
+		startMinute: e.Number,
+		endMinute: e.Number,
+		tz: e.optional(e.String),
+		policy: e.optional(e.Literal("hold", "drop"))
+	}),
+	output: e.Struct({ ok: e.Boolean })
+}), d = t({
+	name: "notifications.clearQuietHours",
+	input: e.Struct({}),
+	output: e.Struct({ ok: e.Boolean })
+}), f = [
+	{
+		tag: "notifications.inbox",
+		kind: "query",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "inboxDescriptor"
+		}
+	},
+	{
+		tag: "notifications.unreadCount",
+		kind: "query",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "unreadCountDescriptor"
+		}
+	},
+	{
+		tag: "notifications.markRead",
+		kind: "mutation",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "markReadDescriptor"
+		}
+	},
+	{
+		tag: "notifications.preferences",
+		kind: "query",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "preferencesDescriptor"
+		}
+	},
+	{
+		tag: "notifications.setPreference",
+		kind: "mutation",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "setPreferenceDescriptor"
+		}
+	},
+	{
+		tag: "notifications.subscribe",
+		kind: "mutation",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "subscribeDescriptor"
+		}
+	},
+	{
+		tag: "notifications.unsubscribe",
+		kind: "mutation",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "unsubscribeDescriptor"
+		}
+	},
+	{
+		tag: "notifications.setQuietHours",
+		kind: "mutation",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "setQuietHoursDescriptor"
+		}
+	},
+	{
+		tag: "notifications.clearQuietHours",
+		kind: "mutation",
+		import: {
+			module: "@voltro/plugin-notifications/rpc",
+			name: "clearQuietHoursDescriptor"
+		}
+	}
+];
+//#endregion
+export { d as clearQuietHoursDescriptor, r as inboxDescriptor, a as markReadDescriptor, f as notificationsRpcClientImports, o as preferencesDescriptor, s as setPreferenceDescriptor, u as setQuietHoursDescriptor, c as subscribeDescriptor, i as unreadCountDescriptor, l as unsubscribeDescriptor };

package/dist/web.d.ts

@@ -0,0 +1,46 @@
+/** An in-app inbox item. */
+declare interface InboxItem {
+    readonly id: string;
+    readonly subjectId: string;
+    readonly category: string;
+    readonly title: string;
+    readonly body: string;
+    readonly data: Record<string, unknown>;
+    readonly readAt: string | null;
+    readonly createdAt: string;
+    readonly tenantId: string | null;
+}
+
+/** The caller's in-app inbox. (Plugin query route — re-reads on reconnect; for
+ *  a fully live feed, mirror the inbox into a `source`-backed app query.) */
+export declare const useInbox: (opts?: {
+    unreadOnly?: boolean;
+    limit?: number;
+}, apiName?: string) => ReadonlyArray<InboxItem>;
+
+/** Mark-read action. */
+export declare const useMarkRead: (apiName?: string) => (id: string) => Promise<unknown>;
+
+/** Set / clear the caller's quiet-hours (DND) window. Minutes are minutes past
+ *  local midnight in `tz` (default UTC); `policy` is `hold` (default) or `drop`. */
+export declare const useQuietHours: (apiName?: string) => {
+    set: (startMinute: number, endMinute: number, opts?: {
+        tz?: string;
+        policy?: "hold" | "drop";
+    }) => Promise<unknown>;
+    clear: () => Promise<unknown>;
+};
+
+/** Toggle a channel preference for a category. */
+export declare const useSetNotificationPreference: (apiName?: string) => (category: string, channel: string, enabled: boolean) => Promise<unknown>;
+
+/** Subscribe / unsubscribe the caller to a broadcast topic. */
+export declare const useTopicSubscription: (apiName?: string) => {
+    subscribe: (topic: string) => Promise<unknown>;
+    unsubscribe: (topic: string) => Promise<unknown>;
+};
+
+/** The caller's unread count. */
+export declare const useUnreadCount: (apiName?: string) => number;
+
+export { }

package/dist/web.js

@@ -0,0 +1,38 @@
+import { useMutation as e, useSubscription as t } from "@voltro/client";
+//#region src/web.ts
+var n = (e = {}, n = "app") => {
+	let { data: r } = t(n, "notifications.inbox", e);
+	return r ?? [];
+}, r = (e = "app") => {
+	let { data: n } = t(e, "notifications.unreadCount", {});
+	return n?.count ?? 0;
+}, i = (t = "app") => {
+	let n = e(t, "notifications.markRead");
+	return (e) => n.mutate({ id: e });
+}, a = (t = "app") => {
+	let n = e(t, "notifications.setPreference");
+	return (e, t, r) => n.mutate({
+		category: e,
+		channel: t,
+		enabled: r
+	});
+}, o = (t = "app") => {
+	let n = e(t, "notifications.subscribe"), r = e(t, "notifications.unsubscribe");
+	return {
+		subscribe: (e) => n.mutate({ topic: e }),
+		unsubscribe: (e) => r.mutate({ topic: e })
+	};
+}, s = (t = "app") => {
+	let n = e(t, "notifications.setQuietHours"), r = e(t, "notifications.clearQuietHours");
+	return {
+		set: (e, t, r) => n.mutate({
+			startMinute: e,
+			endMinute: t,
+			...r?.tz ? { tz: r.tz } : {},
+			...r?.policy ? { policy: r.policy } : {}
+		}),
+		clear: () => r.mutate({})
+	};
+};
+//#endregion
+export { n as useInbox, i as useMarkRead, s as useQuietHours, a as useSetNotificationPreference, o as useTopicSubscription, r as useUnreadCount };

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@voltro/plugin-notifications",
+  "version": "0.1.0",
+  "description": "One unified notification surface — email, Slack/webhook, SMS, push, in-app — with per-subject preference routing, an in-app inbox, and a delivery log. NotificationService + typed routes + useInbox/useUnreadCount hooks.",
+  "keywords": [
+    "voltro",
+    "typescript",
+    "framework"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://voltro.dev",
+  "bugs": {
+    "email": "support@voltro.dev"
+  },
+  "author": {
+    "name": "Voltro UG",
+    "url": "https://voltro.dev"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./web": {
+      "types": "./dist/web.d.ts",
+      "import": "./dist/web.js",
+      "default": "./dist/web.js"
+    },
+    "./rpc": {
+      "types": "./dist/rpc.d.ts",
+      "import": "./dist/rpc.js",
+      "default": "./dist/rpc.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "dependencies": {
+    "@voltro/client": "0.1.0",
+    "@voltro/database": "0.1.0",
+    "@voltro/protocol": "0.1.0"
+  },
+  "peerDependencies": {
+    "effect": "^3.21.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}