@_tc/template-core 0.1.1 → 0.1.3

package/README.md

@@ -16,7 +16,7 @@ pnpm add @_tc/template-core
 
 ## 可选：AI Agent Skill
 
-包内附带 `tc-generator` skill，本质是一份可复用的 Agent 指令包，用来按 TemplateCore 约定生成业务项目、model 配置、Schema CRUD、controller 和 router。
+包内附带 `tc-generator` skill，本质是一份可复用的 Agent 指令包，用来按 TemplateCore 约定生成项目、model 配置、Schema CRUD、controller 和 router。
 
 如果你的 Agent 支持本地 skills 目录，可以从已安装的 npm 包复制安装。以 Codex 为例：
 
@@ -92,11 +92,11 @@ main().catch((error) => {
 | `pageBasePage` | `string` | 否 | `'/'` | 页面访问前缀，所有前端页面路由的基础路径 |
 | `homePage` | `string` | 否 | - | 应用首页路径 |
 | `frameBaseDir` | `string` | 否 | - | 框架根目录，通常不需要手动设置 |
-| `additionalPublicPaths` | `string | string[]` | 否 | - | 追加静态资源目录，必须传绝对路径 |
+| `additionalPublicPaths` | `string | string[]` | 否 | - | 追加静态资源目录和 Nunjucks 模板查找目录，必须传绝对路径 |
 
 框架会自动读取 `config/config.default.ts` 中的配置（如 `port`、`env` 等）。
 
-静态资源挂载顺序为：框架 `app/public`、业务 `app/public`、`additionalPublicPaths`。当 `buildFE` 输出到自定义目录时，可以用 `additionalPublicPaths` 把该目录交给 Koa 提供访问。
+静态资源挂载和 Nunjucks 模板查找顺序均为：框架 `app/public`、项目 `app/public`、`additionalPublicPaths`。当 `buildFE` 输出到自定义目录时，可以用 `additionalPublicPaths` 把该目录交给 Koa 提供静态资源访问和模板渲染。
 
 ### buildFE 参数说明
 
@@ -278,9 +278,9 @@ import type {
 
 ### 前端多语言
 
-TemplateCore 前端复用 `@tc/ui-react/i18n`。框架内置中文、英文资源，业务项目可以继续追加自己的资源。
+TemplateCore 前端复用 `@tc/ui-react/i18n`。框架内置中文、英文资源，项目可以继续追加自己的资源。
 
-**追加业务语言资源**：
+**追加自定义语言资源**：
 
 ```ts
 import { i18nStore } from '@tc/ui-react/i18n'

package/cjs/app/controller/view.js

@@ -1 +1 @@
-var e=e=>JSON.stringify(e).replace(/</g,`\\u003c`).replace(/>/g,`\\u003e`).replace(/&/g,`\\u0026`).replace(/\u2028/g,`\\u2028`).replace(/\u2029/g,`\\u2029`),t=(t=>class{async renderPage(n){t.extends.logger.log(` - render page: `+n.params.page);try{t.extends.renderView(`dist/${n.params.page}.entry.tpl`,n,{projKey:n.query.projk,name:t.options?.name,env:t.envs.get(),basePath:e(`${t.options.pageBasePage}${n.params.page}`),projKeyJson:e(String(n.query.projk??``)),signKey:e(t.config.signKey),options:e(t.options)})}catch{t.extends.generateErrorMessage(`template not found`,{status:404,showError:!0,code:0})}}});module.exports=t;
+var e=e=>JSON.stringify(e).replace(/</g,`\\u003c`).replace(/>/g,`\\u003e`).replace(/&/g,`\\u0026`).replace(/\u2028/g,`\\u2028`).replace(/\u2029/g,`\\u2029`),t=(t=>class{async renderPage(n){t.extends.logger.log(` - render page: `+n.params.page);try{t.extends.renderView(`dist/${n.params.page}.entry.tpl`,n,{projKey:n.query.projk,name:t.options?.name,env:t.envs.get(),basePath:e(`${t.options.pageBasePage}${n.params.page}`),projKeyJson:e(String(n.query.projk??``)),signKey:e(t.config.signKey),options:e(t.options)})}catch(e){console.log(`-------------- render view error --------------`),console.log(e),t.extends.generateErrorMessage(`template not found`,{status:404,showError:!0,code:0})}}});module.exports=t;

package/cjs/app/extend/render-view.js

@@ -1 +1 @@
-const e=require(`../../_virtual/_rolldown/runtime.js`),t=require(`../../packages/core/paths.js`);let n=require(`nunjucks`);n=e.__toESM(n);let r=require(`path`);r=e.__toESM(r);var i=e=>{let i=r.default.join(t.getAppPath(e,`frame`),`./public`),a=n.default.configure(i,{autoescape:!0,throwOnUndefined:!1,trimBlocks:!1,lstripBlocks:!1,noCache:e.envs.get()===`local`,...typeof e.config.nunjucks==`object`?e.config.nunjucks:{}});return e.extends.nunjucksEnv=a,(e,t,n)=>{t.body=a.render(e,Object.assign({},t.state,n))}};module.exports=i;
+const e=require(`../../_virtual/_rolldown/runtime.js`),t=require(`../../packages/core/paths.js`);let n=require(`node:path`);n=e.__toESM(n);let r=require(`nunjucks`);r=e.__toESM(r);var i=e=>{let i=[n.default.resolve(t.getAppPath(e,`frame`),`./public`),n.default.resolve(t.getAppPath(e,`business`),`./public`),...e.options.additionalPublicPaths??[]],a=r.default.configure(i,{autoescape:!0,throwOnUndefined:!1,trimBlocks:!1,lstripBlocks:!1,noCache:e.envs.get()===`local`,...typeof e.config.nunjucks==`object`?e.config.nunjucks:{}});return e.extends.nunjucksEnv=a,(e,t,n)=>{t.body=a.render(e,Object.assign({},t.state,n))}};module.exports=i;

package/cjs/app/middleware.js

@@ -1 +1 @@
-const e=require(`../_virtual/_rolldown/runtime.js`);let t=require(`path`),n=require(`koa-compress`);n=e.__toESM(n);let r=require(`koa-bodyparser`);r=e.__toESM(r);let i=require(`koa-static`);i=e.__toESM(i);var a=(0,r.default)({formLimit:`1000mb`,enableTypes:[`form`,`json`,`text`]}),o=e=>{let r={...e.envs.isLocal()?{maxage:60*1e3}:{maxage:365*24*60*60*1e3}},o=(0,t.resolve)(e.baseDir,`./app/public`),s=(0,t.resolve)(e.frameBaseDir,`./app/public`),c=e.options.additionalPublicPaths??[];c=Array.isArray(c)?c:[c],e.use(e.middlewares.errorHandle),e.use((0,n.default)({threshold:2048})),e.use((0,i.default)(s,r)),e.use((0,i.default)(o,r)),c.forEach(t=>e.use((0,i.default)(t,r))),e.use(a),e.use(e.middlewares.projectHandler),!e.envs.isLocal()&&e.use(e.middlewares.apiSignVerify),e.use(e.middlewares.apiParamsVerify)};module.exports=o;
+const e=require(`../_virtual/_rolldown/runtime.js`),t=require(`../packages/core/paths.js`);let n=require(`koa-compress`);n=e.__toESM(n);let r=require(`path`),i=require(`koa-bodyparser`);i=e.__toESM(i);let a=require(`koa-static`);a=e.__toESM(a);var o=(0,i.default)({formLimit:`1000mb`,enableTypes:[`form`,`json`,`text`]}),s=e=>{let i={...e.envs.isLocal()?{maxage:60*1e3}:{maxage:365*24*60*60*1e3}};e.use(e.middlewares.errorHandle),e.use((0,n.default)({threshold:2048}));let s=(0,r.resolve)(t.getAppPath(e,`business`),`./public`),c=(0,r.resolve)(t.getAppPath(e,`frame`),`./public`),l=e.options.additionalPublicPaths??[];l=Array.isArray(l)?l:[l],e.use((0,a.default)(c,i)),e.use((0,a.default)(s,i)),l.forEach(t=>e.use((0,a.default)(t,i))),e.use(o),e.use(e.middlewares.projectHandler),!e.envs.isLocal()&&e.use(e.middlewares.apiSignVerify),e.use(e.middlewares.apiParamsVerify)};module.exports=s;

package/esm/app/controller/view.js

@@ -12,8 +12,8 @@ var e = (e) => JSON.stringify(e).replace(/</g, "\\u003c").replace(/>/g, "\\u003e
 				signKey: e(t.config.signKey),
 				options: e(t.options)
 			});
-		} catch {
-			t.extends.generateErrorMessage("template not found", {
+		} catch (e) {
+			console.log("-------------- render view error --------------"), console.log(e), t.extends.generateErrorMessage("template not found", {
 				status: 404,
 				showError: !0,
 				code: 0

package/esm/app/extend/render-view.js

@@ -1,9 +1,13 @@
 import { getAppPath as e } from "../../packages/core/paths.js";
-import t from "nunjucks";
-import n from "path";
+import t from "node:path";
+import n from "nunjucks";
 //#region app/extend/render-view.ts
 var r = (r) => {
-	let i = n.join(e(r, "frame"), "./public"), a = t.configure(i, {
+	let i = [
+		t.resolve(e(r, "frame"), "./public"),
+		t.resolve(e(r, "business"), "./public"),
+		...r.options.additionalPublicPaths ?? []
+	], a = n.configure(i, {
 		autoescape: !0,
 		throwOnUndefined: !1,
 		trimBlocks: !1,

package/esm/app/middleware.js

@@ -1,18 +1,21 @@
-import { resolve as e } from "path";
+import { getAppPath as e } from "../packages/core/paths.js";
 import t from "koa-compress";
-import n from "koa-bodyparser";
-import r from "koa-static";
+import { resolve as n } from "path";
+import r from "koa-bodyparser";
+import i from "koa-static";
 //#region app/middleware.ts
-var i = n({
+var a = r({
 	formLimit: "1000mb",
 	enableTypes: [
 		"form",
 		"json",
 		"text"
 	]
-}), a = (n) => {
-	let a = { ...n.envs.isLocal() ? { maxage: 60 * 1e3 } : { maxage: 365 * 24 * 60 * 60 * 1e3 } }, o = e(n.baseDir, "./app/public"), s = e(n.frameBaseDir, "./app/public"), c = n.options.additionalPublicPaths ?? [];
-	c = Array.isArray(c) ? c : [c], n.use(n.middlewares.errorHandle), n.use(t({ threshold: 2048 })), n.use(r(s, a)), n.use(r(o, a)), c.forEach((e) => n.use(r(e, a))), n.use(i), n.use(n.middlewares.projectHandler), !n.envs.isLocal() && n.use(n.middlewares.apiSignVerify), n.use(n.middlewares.apiParamsVerify);
+}), o = (r) => {
+	let o = { ...r.envs.isLocal() ? { maxage: 60 * 1e3 } : { maxage: 365 * 24 * 60 * 60 * 1e3 } };
+	r.use(r.middlewares.errorHandle), r.use(t({ threshold: 2048 }));
+	let s = n(e(r, "business"), "./public"), c = n(e(r, "frame"), "./public"), l = r.options.additionalPublicPaths ?? [];
+	l = Array.isArray(l) ? l : [l], r.use(i(c, o)), r.use(i(s, o)), l.forEach((e) => r.use(i(e, o))), r.use(a), r.use(r.middlewares.projectHandler), !r.envs.isLocal() && r.use(r.middlewares.apiSignVerify), r.use(r.middlewares.apiParamsVerify);
 };
 //#endregion
-export { a as default };
+export { o as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@_tc/template-core",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A full-stack TypeScript admin framework powered by Koa, React, and Vite - monorepo root",
   "types": "./types/index.d.ts",
   "exports": {

package/types/app/extend/render-view.d.ts

@@ -1,3 +1,6 @@
 import type { Ctx, KoaApp } from "../type";
+/**
+ * 挂载模板资源地址 也就是 publish 的地址
+ */
 declare const _default: (app: KoaApp) => (view: string, ctx: Ctx, context?: Record<string, unknown>) => void;
 export default _default;

package/types/packages/core/paths.d.ts

@@ -4,5 +4,11 @@ export interface AppPathInfo {
     type: AppPathType;
     path: string;
 }
+/**
+ * 获取制定类型的app目录
+ */
 export declare function getAppPath(app: KoaApp, type: AppPathType): string | undefined;
+/**
+ * 获取所有app目录
+ */
 export declare function getAppPaths(app: KoaApp): string[];