@oj-module/cli 0.2.18 → 0.2.20

package/templates/{api/tests → tests}/rbac-settings.spec.ts

@@ -2,8 +2,8 @@
 /* eslint-disable test/prefer-lowercase-title -- AC 编号是验收锚点，保留大写 */
 import { afterEach, beforeAll, describe, expect, it } from "vitest";
 
-import { listLoginMethods, listSettings, updateSetting } from "../src/_platform/_shared/service/domain/settings";
-import { searchOplog } from "../src/_platform/_shared/service/infra/oplog";
+import { listLoginMethods, listSettings, updateSetting } from "../src/_platform/api/_shared/service/domain/settings";
+import { searchOplog } from "../src/_platform/api/_shared/service/infra/oplog";
 import { installDb } from "./fixture";
 
 let dbo: ReturnType<typeof installDb>;

package/templates/{api/tests → tests}/rbac-solution-perms.spec.ts

@@ -4,7 +4,7 @@
 /* eslint-disable test/prefer-lowercase-title -- AC 编号是验收锚点，保留大写 */
 import { afterEach, beforeAll, describe, expect, it } from "vitest";
 
-import { uninstallSolution, upsertSolutionPerms } from "../src/_platform/_shared/service/domain/solution-perms";
+import { uninstallSolution, upsertSolutionPerms } from "../src/_platform/api/_shared/service/domain/solution-perms";
 import { installDb } from "./fixture";
 
 let dbo: ReturnType<typeof installDb>;

package/templates/{api/tests → tests}/rbac-users.spec.ts

@@ -3,11 +3,11 @@
 // 禁止操作自己（AC1-10 注）；roles 写 sys_user_role 唯一权威源 + 写时失效（AC1-7/D10）；
 // 禁用/重置口令级联删 refresh（§3.1 吊销联动）。
 /* eslint-disable test/prefer-lowercase-title -- AC 编号是验收锚点，保留大写 */
-import type { SessionDeps } from "../src/auth/_shared/session";
+import type { SessionDeps } from "../src/auth/api/_shared/session";
 
 import { afterEach, beforeAll, describe, expect, it } from "vitest";
-import { changePasswordByAdmin, createUser, listUsers, setForbidden, updateUserRoles } from "../src/_platform/_shared/service/domain/users";
-import { createSession } from "../src/auth/_shared/session";
+import { changePasswordByAdmin, createUser, listUsers, setForbidden, updateUserRoles } from "../src/_platform/api/_shared/service/domain/users";
+import { createSession } from "../src/auth/api/_shared/session";
 import { installDb } from "./fixture";
 
 let dbo: ReturnType<typeof installDb>;

package/templates/tsconfig.json

@@ -15,9 +15,13 @@
 		"skipLibCheck": true
 	},
 	"include": [
-		"web",
+		"src",
 		"web.config.ts",
 		"global.d.ts",
 		"env.d.ts"
+	],
+	"exclude": [
+		"src/*/api",
+		"src/*/api/**"
 	]
 }

package/templates/tsconfig.paths.json

@@ -0,0 +1,19 @@
+// 由 ojm 生成：ojm init / ojm build / ojm dev 会按 src/*/api/manifest.yaml 重写本文件，请勿手改。
+//
+// oj 别名 `#/<模块名>/…` 锚在目标模块根（本布局下即 src/<模块名>/api）。tsconfig 的
+// paths 只能静态全局映射，且每条规则的替换值只允许一个 `*`（`./src/*/api/*` 会被 TS
+// 以 TS5062 拒掉），故按模块逐条枚举。
+{
+	"compilerOptions": {
+		"paths": {
+			"#/_platform/*": ["./src/_platform/api/*"],
+			"#/auth/*": ["./src/auth/api/*"],
+			"#/demo/*": ["./src/demo/api/*"],
+			"#/home/*": ["./src/home/api/*"],
+			"#/notification/*": ["./src/notification/api/*"],
+			"#/personal-center/*": ["./src/personal-center/api/*"],
+			"#/system/*": ["./src/system/api/*"],
+			"#/web/*": ["./src/web/api/*"]
+		}
+	}
+}

package/templates/types/oj-modules.d.ts

@@ -0,0 +1,17 @@
+// oj 导入别名（`#` 开头）的类型兜底。
+//
+// 背景：oj 的 `#x`（**本模块根**，本布局下即 `src/<name>/api`）/ `#/<模块名>/x`
+// （**目标模块根**）是「引用方所在模块」相对的，而 tsconfig 的 `paths` 只能做**静态
+// 全局映射**。`tsconfig.paths.json` 因此按模块枚举了 `"#/<模块名>/*"`，仅能命中
+// **已存在**的文件；跨模块别名的模块名写错、或用了尚未创建的 `#_shared/view` 这类
+// 模块内别名，编辑器会报 TS2307「Cannot find module」。
+//
+// 本文件是**非模块**（无顶层 import/export），其中的 `declare module` 才是真正的
+// ambient 声明——放在模块化的 `global.d.ts` 里会被当作 module augmentation 而不生效。
+// 通配 ambient 作为 `paths` 解析失败后的兜底：无法静态定位的 `#` 导入降级为 `any`
+// 且不再报错；**已存在、能被 `paths` 命中的别名仍走其真实文件类型**（解析优先）。
+//
+// 运行时始终由 oj 的 loader（`module_loader.rs::resolve_alias`）解析，本文件只影响
+// 编辑器 / tsc。模块名写错这类事故由 `oj build` 的 S008（别名无法解析）在构建期拦下，
+// 不会拖到运行期。业务项目若自定义了全局或别名，可仿此在源码根另建 `.d.ts`。
+declare module "#*";

package/templates/vitest.config.ts

@@ -0,0 +1,22 @@
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "vitest/config";
+
+// 后端模块测试（BDD）：node:sqlite 内存库 + 真实迁移建表（见 tests/fixture.ts）。
+// root 锚定本目录，保证从工程根跑 vitest 时 include 相对本目录解析。
+const srcDir = fileURLToPath(new URL("./src", import.meta.url));
+
+export default defineConfig({
+	root: fileURLToPath(new URL(".", import.meta.url)),
+	// `#/<模块名>/…` 是 oj 的模块别名（锚在目标模块根，本布局下即 `src/<模块名>/api`）。
+	// oj build / ojm dev 在打包器里解析它，vitest 走 vite 的 resolve，必须在此显式映射，
+	// 否则跨模块 import 的后端 spec 会以「Cannot find module」整文件跳过。
+	// 形如 `#x`（锚本模块根）与导入方相对，静态 alias 表达不了——模板后端不用这种形态，
+	// 一旦引入需先补 vitest 侧解析（或改写成 `#/<模块名>/…`）。
+	resolve: {
+		alias: [{ find: /^#\/([^/]+)\/(.*)$/, replacement: `${srcDir}/$1/api/$2` }],
+	},
+	test: {
+		include: ["tests/**/*.spec.ts"],
+		environment: "node",
+	},
+});

package/templates/web.config.ts

@@ -2,6 +2,13 @@
  * 模块工程配置：共享依赖一律不进 dependencies（宿主 importmap 提供），
  * 这里只登记模块清单（entry 相对本工程根）。
  *
+ * 布局：`src/<name>/{api,web}`——模块的前后端同处一个目录，`web/entry.ts` 是前端入口、
+ * `api/manifest.yaml` 是后端模块标记（两者其一即可成模块；纯共享库目录两边都没有）。
+ *
+ * 新布局下本清单退化为**可选覆盖**：`ojm build/dev` 以 `src/<name>/web/entry.ts` 扫描结果
+ * 为真源（字典序），这里登记的条目按声明顺序排前、其余按扫描顺序追加——忘登记不会漏构建。
+ * 登记了不存在的前端入口才报错。
+ *
  * 注意：这里的登记顺序只影响模块加载顺序，**不决定侧边栏导航顺序**——
  * 菜单顺序由各模块 entry 路由的 handle.order 决定（≥0 主菜单区升序；
  * <0 底部固定区，pin 在侧边栏底部；同 order 按根 path 字母序）。
@@ -9,30 +16,33 @@
  */
 const allModules = [
 	// /home 必须是首个模块：shell 的 "/" → VITE_BASE_HOME_PATH（=/home）重定向
-	{ name: "home", entry: "web/src/home/entry.ts" },
-	// { name: "demo", entry: "web/src/demo/entry.ts" },
+	{ name: "home", entry: "src/home/web/entry.ts" },
 	// /login 路由由模块提供：shell 宿主不挂 runtime 内置 baseRoutes
-	{ name: "login", entry: "web/src/login/entry.ts" },
+	{ name: "login", entry: "src/login/web/entry.ts" },
 	// 个人中心：runtime 用户菜单固定导航 /personal-center/my-profile，缺则点击落空
-	{ name: "personal-center", entry: "web/src/personal-center/entry.ts" },
+	{ name: "personal-center", entry: "src/personal-center/web/entry.ts" },
 	// 通知：onInit 注册 notificationsApi provider（四方法全必填），
 	// 通知铃的互动（单条已读/全部已读/清空）由此生效；未登记则永远回落内置只读兜底
-	{ name: "notification", entry: "web/src/notification/entry.ts" },
+	{ name: "notification", entry: "src/notification/web/entry.ts" },
 	// 系统管理：用户/成员资格/角色权限/操作日志/站点设置/登录方式（oj 后端 /api/system/*）
-	{ name: "system", entry: "web/src/system/entry.ts" },
+	{ name: "system", entry: "src/system/web/entry.ts" },
 	// 解决方案市场：第一方能力（消费 _platform 编排面 /api/_platform/market/*，
 	// R29：第三方方案不得仿照此调用面），默认随脚手架下发
-	{ name: "oj-market", entry: "web/src/oj-market/entry.ts" },
+	{ name: "oj-market", entry: "src/oj-market/web/entry.ts" },
 	// #region demo-only
-	// 以下为模板内置的演示模块（about/access/exception/outside/route-nest），
+	// 以下为模板内置的演示模块（demo/about/access/exception/outside/route-nest），
 	// 用于把 templates 当可运行 demo 直接跑；其文件不在 `ojm init` 的
 	// init.include.yaml 白名单里，不拷入新工程，故本区间连同这些条目会被
 	// init 一并剥离，脚手架产出的配置不会残留指向缺失文件的死条目。
-	// { name: "about", entry: "web/src/about/entry.ts" },
-	// { name: "access", entry: "web/src/access/entry.ts" },
-	// { name: "exception", entry: "web/src/exception/entry.ts" },
-	// { name: "outside", entry: "web/src/outside/entry.ts" },
-	// { name: "route-nest", entry: "web/src/route-nest/entry.ts" },
+	//
+	// 注意：新布局的清单是「扫描 + 覆盖」并集——注释掉不会让它们消失，
+	// 扫描仍会捡到 `src/<name>/web/entry.ts`。要「不构建」必须写 `enabled: false`。
+	{ name: "demo", entry: "src/demo/web/entry.ts", enabled: false },
+	{ name: "about", entry: "src/about/web/entry.ts", enabled: false },
+	{ name: "access", entry: "src/access/web/entry.ts", enabled: false },
+	{ name: "exception", entry: "src/exception/web/entry.ts", enabled: false },
+	{ name: "outside", entry: "src/outside/web/entry.ts", enabled: false },
+	{ name: "route-nest", entry: "src/route-nest/web/entry.ts", enabled: false },
 	// #endregion demo-only
 ];
 

package/vendor/host-versions.json

@@ -8,9 +8,9 @@
 		"react-router": "7.18.2",
 		"react-router/dom": "7.18.2",
 		"@tanstack/react-query": "5.102.8",
-		"@oj-module/runtime": "0.2.18",
-		"@oj-module/runtime/contract": "0.2.18",
-		"@oj-module/runtime/contract/errors": "0.2.18",
+		"@oj-module/runtime": "0.2.20",
+		"@oj-module/runtime/contract": "0.2.20",
+		"@oj-module/runtime/contract/errors": "0.2.20",
 		"@plane/kit": "0.1.20",
 		"@plane/editor": "0.1.20",
 		"antd": "6.6.1",

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

@@ -1,5 +0,0 @@
-name: auth
-desc: JWT 鉴权端点（业务路由）：login/refresh/logout；Bearer 守卫由 oj-auth 提供
-version: 0.1.0
-deps: # login/refresh 读 _platform.users（ownership_guard: deny 下必须声明，§3）
-  _platform: ^0.1.0

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

@@ -1,5 +0,0 @@
-name: system
-desc: 框架管理域端点（/api/system/*）：角色/权限点管理（assertSystemAdmin 判权，H2）
-version: 0.1.0
-deps: # roles/bindings/permissions 读写 _platform 的 sys_* 表（ownership_guard: deny 下必须声明）
-  _platform: ^0.1.0

package/templates/api/tests/fixture.ts

@@ -1,58 +0,0 @@
-// 后端 BDD 夹具：node:sqlite 内存库 + **真实迁移文件**建表，装到 globalThis.db——
-// 与 oj 运行时注入的全局同名同面（query/exec/tx/dialect），service 代码不改一行即可被测。
-// 夹具直接读 api/src/<模块>/migrations/*.sql，与迁移不可能漂移（沿用 oj-wiki 先例）。
-//
-// **构造器边界（架构定论，勿在此夹具里补 table()）**：db.table()/listTables() 等构造器是
-// oj 二进制内的纯 Rust 实现，无 JS 模块可导出，Node 侧垫不出来——本夹具刻意只给
-// {query, exec, tx, dialect}。两层测试的分工因此定型：
-//   · L2（本目录 *.spec.ts）：构造器面用**记录型假 builder**（记 where/orderBy/limit 调用
-//     序列做编排断言）；真 SQL 执行断言走 db.query 直查。
-//   · L1（同目录 *.test.ts，`oj test` 收集）：真 v8 + 真构造器闭环，守 SQL 渲染/过滤/转义
-//     的真执行面（样板见 tests/l1-builder.test.ts；方法论见 devkit oj-test-guide.md）。
-import { createRequire } from "node:module";
-
-const req = createRequire(import.meta.url);
-const { DatabaseSync } = req("node:sqlite");
-const { readdirSync, readFileSync, existsSync } = req("node:fs");
-const { join, dirname } = req("node:path");
-const { fileURLToPath } = req("node:url");
-
-const SRC = join(dirname(fileURLToPath(import.meta.url)), "..", "src");
-
-export const ADMIN = 1;
-
-/** 建内存库 + 注入全局；返回 DatabaseSync 供用例直插数据/断言。 */
-export function installDb(): any {
-	const dbo = new DatabaseSync(":memory:");
-	// 重放 src 下全部模块的迁移（方言专属文件除外）
-	for (const mod of readdirSync(SRC)) {
-		const dir = join(SRC, mod, "migrations");
-		if (!existsSync(dir))
-			continue;
-		for (const f of readdirSync(dir).filter((f: string) => f.endsWith(".sql") && !/\.(?:mysql|pg)\.sql$/.test(f)).sort())
-			dbo.exec(readFileSync(join(dir, f), "utf8"));
-	}
-
-	dbo.prepare("INSERT INTO users (id, username, password_hash) VALUES (?, ?, 'x')").run(ADMIN, "admin");
-
-	const query = async (sql: string, params: unknown[] = []) => dbo.prepare(sql).all(...(params as never[]));
-	const exec = async (sql: string, params: unknown[] = []) => Number(dbo.prepare(sql).run(...(params as never[])).changes);
-	const txInstance = { query, exec, isTx: true };
-	// db.tx 镜像运行时面：BEGIN/COMMIT/ROLLBACK 包裹回调（versions.ts 注释同语义）
-	const tx = async (fn: (t: typeof txInstance) => unknown) => {
-		dbo.exec("BEGIN");
-		try {
-			const r = await fn(txInstance);
-			dbo.exec("COMMIT");
-			return r;
-		}
-		catch (e) {
-			dbo.exec("ROLLBACK");
-			throw e;
-		}
-	};
-
-	const g = globalThis as any;
-	g.db = { query, exec, tx, dialect: () => "sqlite" };
-	return dbo;
-}

package/templates/api/tsconfig.json

@@ -1,8 +0,0 @@
-{
-	"extends": "../tsconfig.json",
-	"include": [
-		"src",
-		"../global.d.ts",
-		"../env.d.ts"
-	]
-}

package/templates/api/vitest.config.ts

@@ -1,12 +0,0 @@
-import { fileURLToPath } from "node:url";
-import { defineConfig } from "vitest/config";
-
-// 后端模块测试（BDD）：node:sqlite 内存库 + 真实迁移建表（见 tests/fixture.ts）。
-// root 锚定本目录，保证从工程根跑 vitest 时 include 相对本目录解析。
-export default defineConfig({
-	root: fileURLToPath(new URL(".", import.meta.url)),
-	test: {
-		include: ["tests/**/*.spec.ts"],
-		environment: "node",
-	},
-});