@oj-module/cli 0.2.50 → 0.2.53

package/templates/src/demo/api/manifest.yaml

@@ -1,5 +0,0 @@
-name: demo
-desc: 演示模块（todos 等，P3 接数据层）
-version: 0.1.0
-tables:
-  - todos

package/templates/src/demo/api/migrations/0001__create_todos.sql

@@ -1,9 +0,0 @@
--- demo 模块建表（P3-2）。todos 待办表，S007 要求序号连续且唯一，单文件 0001。
--- done 用 INTEGER(0/1) 承载布尔，handler 映射为 boolean。
-CREATE TABLE IF NOT EXISTS todos (
-  id INTEGER PRIMARY KEY AUTOINCREMENT,
-  title TEXT NOT NULL DEFAULT '',
-  done INTEGER NOT NULL DEFAULT 0,
-  create_time INTEGER NOT NULL DEFAULT 0,
-  update_time INTEGER NOT NULL DEFAULT 0
-);

package/templates/src/demo/api/migrations/0002__tenant.mysql.sql

@@ -1,2 +0,0 @@
--- 0002__tenant（mysql 方言）：demo.todos 租户化。TEXT 不能带字面默认值 → VARCHAR(255)。
-ALTER TABLE todos ADD COLUMN tenant_id VARCHAR(255) NOT NULL DEFAULT 'default';

package/templates/src/demo/api/migrations/0002__tenant.sql

@@ -1,2 +0,0 @@
--- 0002__tenant：demo.todos 租户化（企微代开发 v3 Phase 0 的 A 组）。
-ALTER TABLE todos ADD COLUMN tenant_id TEXT NOT NULL DEFAULT 'default';

package/templates/src/demo/api/schema.yaml

@@ -1,12 +0,0 @@
-# 声明式表结构（§4.2 / D1-C）：demo 模块自有表 todos。
-# 加表/加可空列由 reconcile 自动收敛；类型变更/改名走 migrations/。
-tables:
-  todos:
-    pk: id
-    columns:
-      id: {type: integer, autoincrement: true}
-      tenant_id: {type: text, null: false}
-      title: {type: text, null: false}
-      done: {type: integer, null: false}
-      create_time: {type: integer, null: false}
-      update_time: {type: integer, null: false}

package/templates/src/demo/api/seed.sql

@@ -1,5 +0,0 @@
--- demo 模块种子（P3-2）：示例待办，幂等 INSERT OR IGNORE，按分号朴素切分（S006）。
-INSERT OR IGNORE INTO todos (id, title, done, create_time, update_time) VALUES (1, '学习 uni-dev 契约机制', 1, 0, 0);
-INSERT OR IGNORE INTO todos (id, title, done, create_time, update_time) VALUES (2, '完成 playground-oj system 模块', 0, 0, 0);
-INSERT OR IGNORE INTO todos (id, title, done, create_time, update_time) VALUES (3, '编写 P3 教学文档', 0, 0, 0);
-INSERT OR IGNORE INTO todos (id, title, done, create_time, update_time) VALUES (4, '联调 demo 真实数据层', 0, 0, 0);

package/templates/src/demo/api/todos/api.ts

@@ -1,59 +0,0 @@
-// GET /api/demo/todos —— 演示待办列表（真实化 P3-2，AC-D9 apiPrefix=/demo）。
-// Bearer 守卫保护；keyword 模糊过滤 title；snake_case → camelCase，done 映射布尔。
-
-// 契约（v0.1.71「最新方式」）：动词挂 `.schema` 四通道（params/query/body/response），
-// oj 运行期据此校验入参、并供 `oj openapi` 生成 openapi.json → 前端 `ojm api` 生成 __client。
-const todos = {
-	async get() {
-		const kw = http.query.keyword;
-		const hasKw = typeof kw === "string" && kw.length > 0;
-		// 构造器：模糊过滤走语义 op（contains 自动转义 %/_/!），count 走聚合，方言无关。
-		const build = () => db.table("todos").whereIf(hasKw, { field: "title", op: "contains", value: kw });
-		try {
-			const total = Number((await build().select([{ fn: "count", as: "c" }]).all())[0]?.c ?? 0);
-			const rows = await build()
-				.select(["id", "title", "done", "create_time", "update_time"])
-				.orderBy([{ field: "id", dir: "asc" }])
-				.all();
-			const list = rows.map(r => ({
-				id: Number(r.id),
-				title: String(r.title),
-				done: Number(r.done) === 1,
-			}));
-			json.ok({ list, total });
-		}
-		catch (e) {
-			json.fail(500, String(e));
-		}
-	},
-};
-
-todos.get.schema = {
-	query: {
-		type: "object",
-		properties: { keyword: { type: "string" } },
-	},
-};
-
-// oj v0.1.72 起出参走平级 .response（.schema 只放入参）。
-todos.get.response = {
-	type: "object",
-	required: ["list", "total"],
-	properties: {
-		list: {
-			type: "array",
-			items: {
-				type: "object",
-				required: ["id", "title", "done"],
-				properties: {
-					id: { type: "number" },
-					title: { type: "string" },
-					done: { type: "boolean" },
-				},
-			},
-		},
-		total: { type: "number" },
-	},
-};
-
-export default todos;

package/templates/src/demo/web/__client/api.schemas.ts

@@ -1,20 +0,0 @@
-/* eslint-disable */
-// 生成物：ojm api 从契约生成，勿手改（改动请改契约文件后重跑 ojm api）
-// AC-D15：仅供 DEV 校验动态 import，生产构建不进产物
-import { z } from "@oj-module/runtime";
-
-export const schemas = {
-	"demoTodosGet": {
-		query: z.object({
-	"keyword": z.string().optional()
-}),
-		data: z.object({
-	"list": z.array(z.object({
-	"id": z.number(),
-	"title": z.string(),
-	"done": z.boolean()
-})),
-	"total": z.number()
-}),
-	},
-};

package/templates/src/demo/web/__client/api.ts

@@ -1,89 +0,0 @@
-/* eslint-disable */
-// 生成物：ojm api 从契约生成，勿手改（改动请改契约文件后重跑 ojm api）
-import { ContractApiError } from "@oj-module/runtime/contract/errors";
-import type { ScopedRequestLike } from "@oj-module/runtime/contract/errors";
-import type { ModuleContext } from "@oj-module/runtime";
-import type { z } from "@oj-module/runtime";
-import type { schemas } from "./api.schemas";
-
-/** oj 信封（AC-D16）：code=0 成功；非 0 时 HTTP status=code，由 toApiError 归一为 ContractApiError */
-interface OjEnvelope<T> { code: number, msg?: string, data?: T }
-
-let req: ScopedRequestLike | undefined;
-
-/** 线上 API 前缀（ojm api 从契约抽取，唯一真源，勿手改）：请求基址 + 前缀登记用 */
-export const API_PREFIX = "/demo";
-
-/** 认领身份前缀（契约 apiPrefix，字面等于模块目录名）：跨模块认领护栏对比基准 */
-export const MODULE_PREFIX = "/demo";
-
-/**
- * 模块 entry 的 onInit 里一行创建（构造即 install）：完成 apiPrefix 登记 +
- * scoped request 绑定，返回绑好前缀的端点函数集合。一模块一 client；
- * 重复构造幂等安全（前缀重复登记同值、request 重绑同值）。
- */
-export function createDemoClient(ctx: ModuleContext) {
-	// 跨模块认领护栏（DEV）：工厂知道自己该属于谁（MODULE_PREFIX = 契约 apiPrefix），
-	// ctx 又带 module.name——名实不符说明别的模块在替本模块创建 client，会共享 request
-	// 单槽、卸载互相耦合；跨模块需求应由本模块创建后经 provider 暴露。
-	// 注意对比基准是 MODULE_PREFIX（目录名）而非 API_PREFIX——D-M8 映射时线上前缀
-	// 属于别的命名空间，认领身份仍按目录名。
-	if (import.meta.env.DEV && ctx.module.name !== MODULE_PREFIX.slice(1)) {
-		console.warn(`[ojm-api] 模块 "${ctx.module.name}" 正在认领 ${MODULE_PREFIX} 的 client——跨模块认领会共享 request 单槽、卸载互相耦合；应由 "${MODULE_PREFIX.slice(1)}" 模块在自身 onInit 创建，跨模块需求经 provider 暴露。`);
-	}
-	ctx.register.apiPrefix(API_PREFIX);
-	bindRequest(ctx.utils.request);
-	return { demoTodosGet };
-}
-
-/**
- * @deprecated 请改用 createDemoClient(ctx)——工厂构造即完成
- * 前缀登记 + request 绑定，不会出现「登记了前缀没绑 request」的半接线状态。
- */
-export function bindRequest(r: ScopedRequestLike): void {
-	req = r;
-}
-
-function ensureReq(): ScopedRequestLike {
-	if (!req)
-		throw new ContractApiError(-1, "[ojm-api] 请求未绑定——请在模块 entry.ts 的 onInit 里调用 createDemoClient(ctx)（或 bindRequest(ctx.utils.request)）。");
-	return req;
-}
-
-/** ky HTTPError → ContractApiError（错误体为信封时取 code/msg）；契约违例与原错误原样透传 */
-async function toApiError(e: unknown): Promise<unknown> {
-	if (e instanceof ContractApiError)
-		return e;
-	// ky 2.x 构造 HTTPError 时已用 getReader() 消费掉原 response 体（res.clone().json() 按规范抛 TypeError，
-	// 体方法一律失效），解析好的错误体在公开字段 error.data——故读 error.data，勿改回 clone().json()。
-	const err = e as { data?: { code?: unknown, msg?: string }, response?: Response } | null;
-	const res = err?.response;
-	const d = err?.data;
-	if (res instanceof Response && d && typeof d.code === "number")
-		return new ContractApiError(d.code, d.msg ?? res.statusText);
-	return e;
-}
-
-export type DemoTodosGetQuery = z.input<(typeof schemas)["demoTodosGet"]["query"]>;
-export type DemoTodosGetData = z.infer<(typeof schemas)["demoTodosGet"]["data"]>;
-
-export async function demoTodosGet(query: DemoTodosGetQuery): Promise<DemoTodosGetData> {
-	const client = ensureReq();
-	try {
-		const env = await client.get(`demo/todos`, { searchParams: query as Record<string, string | number | boolean> }).json<OjEnvelope<DemoTodosGetData>>();
-		// 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 DemoTodosGetData;
-		if (import.meta.env.DEV) {
-			const { schemas } = await import("./api.schemas");
-			const r = schemas["demoTodosGet"].data.safeParse(data);
-			if (!r.success)
-				throw new ContractApiError(-1, `[契约违例] demoTodosGet 响应与契约不符：${r.error.issues.map(i => `${i.path.join(".") || "(root)"}: ${i.message}`).join("; ")}`);
-		}
-		return data;
-	}
-	catch (e) {
-		throw await toApiError(e);
-	}
-}

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

@@ -1,42 +0,0 @@
-import { HomeOutlined } from "@ant-design/icons";
-import { defineModule } from "@oj-module/runtime";
-import { createElement } from "react";
-
-import DemoPage from "./pages/index";
-
-/**
- * demo 前端模块：本文件是模块元数据唯一来源（name/version/routes/i18n）。
- * 只允许 import 三类东西：runtime、共享依赖（宿主 importmap 提供）、自身相对路径。
- */
-export default defineModule({
-	name: "demo",
-	description: "uni-dev 演示模块",
-	version: "0.1.0",
-	peerRuntime: ">=0.0.0",
-	routes: [
-		{
-			path: "/demo",
-			handle: {
-				layout: "container",
-				order: 100,
-				title: "demo:menu.demo",
-				icon: createElement(HomeOutlined),
-			},
-			children: [
-				{
-					index: true,
-					Component: DemoPage,
-					handle: {
-						title: "demo:menu.demo",
-						icon: createElement(HomeOutlined),
-						keepAlive: true,
-					},
-				},
-			],
-		},
-	],
-	i18n: {
-		"zh-CN": () => import("./locales/zh-CN.json"),
-		"en-US": () => import("./locales/en-US.json"),
-	},
-});

package/templates/src/demo/web/locales/en-US.json

@@ -1,10 +0,0 @@
-{
-	"menu": {
-		"demo": "Demo"
-	},
-	"page": {
-		"title": "uni-dev Demo",
-		"loaded": "Module loaded",
-		"hello": "Backend says"
-	}
-}

package/templates/src/demo/web/locales/zh-CN.json

@@ -1,10 +0,0 @@
-{
-	"menu": {
-		"demo": "演示模块"
-	},
-	"page": {
-		"title": "uni-dev 演示",
-		"loaded": "模块加载成功",
-		"hello": "后端响应"
-	}
-}

package/templates/src/demo/web/pages/index.tsx

@@ -1,45 +0,0 @@
-import { BasicContent, useAuthStore } from "@oj-module/runtime";
-import { Card, Tag, Typography } from "antd";
-import { useEffect, useState } from "react";
-import { useTranslation } from "react-i18next";
-
-/**
- * 演示页：调后端 /api/web/hello（oj dev/ts 热更，改 api/src 保存即生效）。
- * 业务侧直接消费 oj 原生信封 {code:0,data}；登录链信封由 runtime 适配（D10）。
- *
- * 注意（集中审阅 F6 评估结论）：这里用裸 fetch 是有意的 demo 简化——
- * runtime 不向页面组件暴露请求客户端（scoped client `ctx.utils.request`
- * 只在模块生命周期钩子可用），真实业务模块请把请求收敛到模块自己的
- * api/ 层再封装，不要在页面里散落 fetch。
- */
-export default function DemoPage() {
-	const { t } = useTranslation();
-	const token = useAuthStore(state => state.token);
-	const [hello, setHello] = useState<string>("");
-
-	useEffect(() => {
-		const controller = new AbortController();
-		fetch("/api/web/hello", { headers: { Authorization: `Bearer ${token}` }, signal: controller.signal })
-			.then(res => res.json())
-			.then((body: { data?: { message?: string } }) => setHello(body?.data?.message ?? ""))
-			.catch(() => setHello(""));
-		return () => controller.abort();
-	}, [token]);
-
-	return (
-		<BasicContent>
-			<Card title={t("demo:page.title")}>
-				<Tag color="success">{t("demo:page.loaded")}</Tag>
-				{hello
-					? (
-						<Typography.Paragraph>
-							{t("demo:page.hello")}
-							{": "}
-							<Typography.Text code>{hello}</Typography.Text>
-						</Typography.Paragraph>
-					)
-					: null}
-			</Card>
-		</BasicContent>
-	);
-}