@oj-module/cli 0.1.15 → 0.1.17

package/templates/web/src/notification/client/api.schemas.ts

@@ -4,19 +4,47 @@
 import { z } from "@oj-module/runtime";
 
 export const schemas = {
+	del: {
+		body: z.object({
+	id: z.string(),
+	userId: z.union([z.string(), z.number()]).optional(),
+}),
+	},
 	fetchNotifications: {
 		data: z.array(z.object({
-	id: z.number(),
+	id: z.string(),
+	scope: z.enum(["user","broadcast"]),
 	avatar: z.string(),
 	date: z.string(),
 	isRead: z.boolean().optional(),
 	message: z.string(),
 	title: z.string(),
+	link: z.string().nullable().optional(),
+	category: z.enum(["notice","pm","mention"]).optional(),
 })),
 	},
 	markRead: {
 		body: z.object({
-	id: z.number(),
+	id: z.string(),
+}),
+	},
+	push: {
+		body: z.object({
+	userId: z.union([z.string(), z.number()]).optional(),
+	title: z.string(),
+	message: z.string(),
+	link: z.string().optional(),
+	avatar: z.string().optional(),
+	category: z.enum(["notice","pm","mention"]).optional(),
+}),
+	},
+	pushBroadcast: {
+		body: z.object({
+	title: z.string(),
+	message: z.string(),
+	link: z.string().optional(),
+	avatar: z.string().optional(),
+	category: z.enum(["notice","pm","mention"]).optional(),
 }),
 	},
 };

package/templates/web/src/notification/client/api.ts

@@ -33,7 +33,7 @@ export function createNotificationClient(ctx: ModuleContext) {
 	}
 	ctx.register.apiPrefix(API_PREFIX);
 	bindRequest(ctx.utils.request);
-	return { clearAll, fetchNotifications, markAllRead, markRead };
+	return { clearAll, del, fetchNotifications, markAllRead, markRead, push, pushBroadcast };
 }
 
 /**
@@ -79,6 +79,23 @@ export async function clearAll(): Promise<unknown> {
 	}
 }
 
+export type DelBody = z.input<(typeof schemas)["del"]["body"]>;
+
+export async function del(body: DelBody): Promise<unknown> {
+	const client = ensureReq();
+	try {
+		const env = await client.post(`notification/del`, { json: body }).json<OjEnvelope<unknown>>();
+		// 2xx + code!==0 也是业务错误（§6.2 通道 a）：oj 不会这么发，但契约机制的价值恰是防漂移
+		if (typeof env.code === "number" && env.code !== 0)
+			throw new ContractApiError(env.code, env.msg ?? "业务错误（信封 code 非 0）");
+		const data = env.data as unknown;
+		return data;
+	}
+	catch (e) {
+		throw await toApiError(e);
+	}
+}
+
 export type FetchNotificationsData = z.infer<(typeof schemas)["fetchNotifications"]["data"]>;
 
 export async function fetchNotifications(): Promise<FetchNotificationsData> {
@@ -133,3 +150,37 @@ export async function markRead(body: MarkReadBody): Promise<unknown> {
 		throw await toApiError(e);
 	}
 }
+
+export type PushBody = z.input<(typeof schemas)["push"]["body"]>;
+
+export async function push(body: PushBody): Promise<unknown> {
+	const client = ensureReq();
+	try {
+		const env = await client.post(`notification/push`, { json: body }).json<OjEnvelope<unknown>>();
+		// 2xx + code!==0 也是业务错误（§6.2 通道 a）：oj 不会这么发，但契约机制的价值恰是防漂移
+		if (typeof env.code === "number" && env.code !== 0)
+			throw new ContractApiError(env.code, env.msg ?? "业务错误（信封 code 非 0）");
+		const data = env.data as unknown;
+		return data;
+	}
+	catch (e) {
+		throw await toApiError(e);
+	}
+}
+
+export type PushBroadcastBody = z.input<(typeof schemas)["pushBroadcast"]["body"]>;
+
+export async function pushBroadcast(body: PushBroadcastBody): Promise<unknown> {
+	const client = ensureReq();
+	try {
+		const env = await client.post(`notification/push-broadcast`, { json: body }).json<OjEnvelope<unknown>>();
+		// 2xx + code!==0 也是业务错误（§6.2 通道 a）：oj 不会这么发，但契约机制的价值恰是防漂移
+		if (typeof env.code === "number" && env.code !== 0)
+			throw new ContractApiError(env.code, env.msg ?? "业务错误（信封 code 非 0）");
+		const data = env.data as unknown;
+		return data;
+	}
+	catch (e) {
+		throw await toApiError(e);
+	}
+}

package/templates/web/src/notification/entry.ts

@@ -7,9 +7,10 @@ import { createNotificationClient } from "./client/api";
 /**
  * notification 模块（G5 模板形态，对齐 apps/playground-oj/web/src/notification）。
  *
- * 无页面路由；仅通过 onInit 全量接管通知 API（D9 + G4，四方法全必填）：
- * 把内置 root 级通知读/写收敛到本模块 `/notification` 前缀下的 oj 后端，
- * 通知铃的互动（单条已读/全部已读/清空）由此生效。
+ * 无页面路由；仅通过 onInit 全量接管通知 API（D9 + G4）：把内置 root 级通知读/写
+ * 收敛到本模块 `/notification` 前缀下的 oj 后端，通知铃的互动（单条已读/全部已读/
+ * 清空）由此生效；发射端三方法（push/pushBroadcast/del）使本模块同时作为跨模块
+ * 通知原语的接收端（前端 facade 委托至此）。
  */
 export default defineModule({
 	name: "notification",
@@ -26,9 +27,17 @@ export default defineModule({
 			const notificationClient = createNotificationClient(ctx);
 			const provider: NotificationsApiProvider = {
 				fetchNotifications: () => notificationClient.fetchNotifications(),
-				markRead: id => notificationClient.markRead({ id: Number(id) }).then(() => {}),
+				// id 为命名空间串（"u:<id>" / "b:<id>"），原样透传
+				markRead: id => notificationClient.markRead({ id: String(id) }).then(() => {}),
 				markAllRead: () => notificationClient.markAllRead().then(() => {}),
 				clearAll: () => notificationClient.clearAll().then(() => {}),
+				push: input => notificationClient
+					.push({ userId: input.userId, title: input.title, message: input.message, link: input.link, avatar: input.avatar, category: input.category })
+					.then(r => String((r as { id: string }).id)),
+				pushBroadcast: input => notificationClient
+					.pushBroadcast({ title: input.title, message: input.message, link: input.link, avatar: input.avatar, category: input.category })
+					.then(r => String((r as { id: string }).id)),
+				del: (id, userId) => notificationClient.del({ id: String(id), userId }).then(() => {}),
 			};
 			ctx.register.notificationsApi(provider);
 		},

package/vendor/host-versions.json

@@ -8,11 +8,11 @@
 		"react-router": "7.18.2",
 		"react-router/dom": "7.18.2",
 		"@tanstack/react-query": "5.102.8",
-		"@oj-module/runtime": "0.1.15",
-		"@oj-module/runtime/contract": "0.1.15",
-		"@oj-module/runtime/contract/errors": "0.1.15",
-		"@plane/kit": "0.1.15",
-		"@plane/editor": "0.1.15",
+		"@oj-module/runtime": "0.1.17",
+		"@oj-module/runtime/contract": "0.1.17",
+		"@oj-module/runtime/contract/errors": "0.1.17",
+		"@plane/kit": "0.1.17",
+		"@plane/editor": "0.1.17",
 		"antd": "6.6.1",
 		"antd/locale/en_US": "6.6.1",
 		"antd/locale/zh_CN": "6.6.1",
@@ -64,6 +64,8 @@
 		"simplebar-react": "3.3.2",
 		"spin-delay": "2.0.1",
 		"tailwind-merge": "3.6.0",
+		"vditor": "4.0.0",
+		"vditor/dist/index.css": "4.0.0",
 		"typescript": "6.0.3",
 		"@types/react": "19.2.18"
 	}