@_tc/template-core 0.0.1-bate.5 → 0.0.1-bate.50

package/.skills/tc-generator/reference/project-template/app/controller/product.js

@@ -0,0 +1,73 @@
+const { baseFn } = require("@_tc/template-core");
+
+const products = [
+  {
+    product_id: "1",
+    product_name: "Product A",
+    price: 100,
+    inventory: 30,
+    status: "enabled",
+    create_time: "2026-05-18 10:00:00",
+  },
+];
+
+module.exports = (app) => {
+  const BaseController = baseFn.baseControllerFn(app);
+
+  return class ProductController extends BaseController {
+    list = async (ctx) => {
+      const { product_name, status } = ctx.request.query;
+      const page = Number(ctx.request.query.page || 1);
+      const pageSize = Number(ctx.request.query.pageSize || 10);
+
+      const filtered = products.filter((item) => {
+        if (product_name && !item.product_name.includes(product_name)) return false;
+        if (status && item.status !== status) return false;
+        return true;
+      });
+
+      this.success(ctx, {
+        data: filtered.slice((page - 1) * pageSize, page * pageSize),
+        page,
+        pageSize,
+        total: filtered.length,
+      });
+    };
+
+    detail = async (ctx) => {
+      const item = products.find((product) => {
+        return product.product_id === ctx.request.query.product_id;
+      });
+
+      this.success(ctx, item || null);
+    };
+
+    create = async (ctx) => {
+      const item = {
+        ...ctx.request.body,
+        product_id: `${Date.now()}`,
+        create_time: new Date().toISOString(),
+      };
+
+      products.unshift(item);
+      this.success(ctx, item);
+    };
+
+    update = async (ctx) => {
+      const data = ctx.request.body;
+      const item = products.find((product) => product.product_id === data.product_id);
+
+      if (item) Object.assign(item, data);
+      this.success(ctx, item || data);
+    };
+
+    remove = async (ctx) => {
+      const index = products.findIndex((product) => {
+        return product.product_id === ctx.request.query.product_id;
+      });
+
+      if (index !== -1) products.splice(index, 1);
+      this.success(ctx, {});
+    };
+  };
+};

package/.skills/tc-generator/reference/project-template/app/router/product.js

@@ -0,0 +1,9 @@
+module.exports = (app, router) => {
+  const { product } = app.controller;
+
+  router.get("/api/product/list", product.list);
+  router.get("/api/product", product.detail);
+  router.post("/api/product", product.create);
+  router.put("/api/product", product.update);
+  router.delete("/api/product", product.remove);
+};

package/.skills/tc-generator/reference/project-template/config/config.default.js

@@ -0,0 +1,7 @@
+module.exports = {
+  port: 9000,
+  // Optional: override the default `.template-core/template-core.sqlite` path.
+  // db: {
+  //   path: "data/app.sqlite",
+  // },
+};

package/.skills/tc-generator/reference/project-template/index.js

@@ -0,0 +1,17 @@
+const { join } = require("path");
+const { serverStart } = require("@_tc/template-core");
+const { buildFE } = require("@_tc/template-core/bundler");
+
+async function main() {
+  await serverStart({
+    name: "tc-business-project",
+    baseDir: join(__dirname, "."),
+  });
+
+  buildFE("dev");
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

package/.skills/tc-generator/reference/project-template/model/product/mode.js

@@ -0,0 +1,179 @@
+module.exports = {
+  mode: "MB",
+  name: "Product Admin",
+  desc: "Product management scaffold",
+  icon: "",
+  homePage: "/_sidebar_/product",
+  menu: [
+    {
+      key: "product",
+      name: "Products",
+      menuType: "module",
+      moduleType: "schema",
+      schemaConfig: {
+        api: "/api/product",
+        schema: {
+          type: "object",
+          properties: {
+            product_id: {
+              type: "string",
+              label: "Product ID",
+              tableOption: {
+                width: "180",
+              },
+              editFormOption: {
+                comType: "input",
+                disabled: true,
+              },
+              detailPanelOption: {},
+            },
+            product_name: {
+              type: "string",
+              label: "Product Name",
+              minLength: 2,
+              tableOption: {
+                width: "220",
+              },
+              searchOption: {
+                comType: "input",
+              },
+              createFormOption: {
+                comType: "input",
+              },
+              editFormOption: {
+                comType: "input",
+              },
+              detailPanelOption: {},
+            },
+            price: {
+              type: "number",
+              label: "Price",
+              tableOption: {
+                width: "120",
+                toFixed: 2,
+              },
+              createFormOption: {
+                comType: "inputNumber",
+              },
+              editFormOption: {
+                comType: "inputNumber",
+              },
+              detailPanelOption: {},
+            },
+            inventory: {
+              type: "number",
+              label: "Inventory",
+              tableOption: {
+                width: "120",
+              },
+              createFormOption: {
+                comType: "inputNumber",
+                default: 0,
+              },
+              editFormOption: {
+                comType: "inputNumber",
+              },
+              detailPanelOption: {},
+            },
+            status: {
+              type: "string",
+              label: "Status",
+              tableOption: {
+                width: "120",
+              },
+              searchOption: {
+                comType: "select",
+                options: [
+                  { label: "Enabled", value: "enabled" },
+                  { label: "Disabled", value: "disabled" },
+                ],
+              },
+              createFormOption: {
+                comType: "select",
+                default: "enabled",
+                options: [
+                  { label: "Enabled", value: "enabled" },
+                  { label: "Disabled", value: "disabled" },
+                ],
+              },
+              editFormOption: {
+                comType: "select",
+                options: [
+                  { label: "Enabled", value: "enabled" },
+                  { label: "Disabled", value: "disabled" },
+                ],
+              },
+              detailPanelOption: {
+                options: [
+                  { label: "Enabled", value: "enabled" },
+                  { label: "Disabled", value: "disabled" },
+                ],
+              },
+            },
+            create_time: {
+              type: "string",
+              label: "Created At",
+              tableOption: {
+                width: "180",
+              },
+              detailPanelOption: {},
+            },
+          },
+          required: ["product_name", "price"],
+        },
+        componentConfig: {
+          createForm: {
+            title: "Create Product",
+            saveBtnText: "Create",
+          },
+          editForm: {
+            title: "Edit Product",
+            saveBtnText: "Save",
+            fetchKey: "product_id",
+          },
+          detailPanel: {
+            title: "Product Detail",
+            fetchKey: "product_id",
+          },
+        },
+        tableConfig: {
+          headerButtons: [
+            {
+              label: "Create Product",
+              eventKey: "callComponent",
+              variant: "primary",
+              eventOption: {
+                comName: "createForm",
+              },
+            },
+          ],
+          rowButtons: [
+            {
+              label: "Edit",
+              eventKey: "callComponent",
+              eventOption: {
+                comName: "editForm",
+              },
+            },
+            {
+              label: "Detail",
+              eventKey: "callComponent",
+              eventOption: {
+                comName: "detailPanel",
+              },
+            },
+            {
+              label: "Delete",
+              eventKey: "remove",
+              eventOption: {
+                params: {
+                  product_id: "$schema::product_id",
+                },
+              },
+            },
+          ],
+        },
+      },
+    },
+  ],
+};

package/.skills/tc-generator/reference/project-template/model/product/project/default.js

@@ -0,0 +1,5 @@
+module.exports = {
+  name: "Default Product Project",
+  desc: "Project-level overrides can be added here.",
+  homePage: "/_sidebar_/product?projk=default",
+};

package/.skills/tc-generator/reference/project-template/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "tc-business-project",
+  "private": true,
+  "scripts": {
+    "dev": "node index.js"
+  },
+  "dependencies": {
+    "@_tc/template-core": "latest",
+    "@vitejs/plugin-react": "6.0.1",
+    "clsx": "^2.1.0",
+    "date-fns": "^3.6.0",
+    "koa": "^2.15.0",
+    "koa-router": "^12.0.1",
+    "lodash": "^4.17.21",
+    "lucide-react": "^0.468.0",
+    "rc-field-form": "^1.44.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-router-dom": "^6.28.0",
+    "tailwind-merge": "^2.4.0",
+    "vite": "8.0.10",
+    "xlsx": "^0.18.5",
+    "zustand": "^5.0.0"
+  }
+}

package/.skills/tc-generator/reference/runtime-extensions.md

@@ -0,0 +1,190 @@
+# TemplateCore Runtime Extensions
+
+Use this reference when generating business code that needs persistence, Dashboard customization, or frontend helper components.
+
+## Default DB
+
+`app.extends.db` is available by default. It stores framework/business data in SQLite at:
+
+```text
+.template-core/template-core.sqlite
+```
+
+The default path is relative to the business project `baseDir`. Configure it in `config/config.default.js`:
+
+```js
+module.exports = {
+  port: 9000,
+  db: {
+    path: "data/app.sqlite",
+  },
+};
+```
+
+Prefer `db.path` for new projects. The current runtime also accepts `db` as a string and object aliases `filename`, `sqlitePath`, or `sqlite: string | { path, filename }` for compatibility.
+
+Common methods:
+
+```ts
+app.extends.db.dbPath
+app.extends.db.getDBConnection()
+app.extends.db.execDB(sql)
+app.extends.db.getDBData(key, { namespace })
+app.extends.db.getDBDataRecord(key, { namespace })
+app.extends.db.setDBData(key, value, { namespace })
+app.extends.db.hasDBData(key, { namespace })
+app.extends.db.deleteDBData(key, { namespace })
+app.extends.db.listDBData({ namespace, limit, offset })
+app.extends.db.countDBData({ namespace })
+app.extends.db.clearDBData({ namespace })
+app.extends.db.queryDB(sql, params)
+app.extends.db.runDB(sql, params)
+app.extends.db.getDBFirst(sql, params)
+app.extends.db.transactionDB((db) => ...)
+app.extends.db.closeDB()
+```
+
+SQL safety rule: put user input in `params`; do not concatenate it into SQL strings. `execDB(sql)` is only for fixed SQL such as migrations.
+
+Example controller storage:
+
+```js
+const { baseFn } = require("@_tc/template-core");
+
+module.exports = (app) => {
+  const BaseController = baseFn.baseControllerFn(app);
+
+  return class SettingController extends BaseController {
+    get = async (ctx) => {
+      const data = app.extends.db.getDBData("site-setting", {
+        namespace: "settings",
+      });
+
+      this.success(ctx, data || {});
+    };
+
+    save = async (ctx) => {
+      app.extends.db.setDBData("site-setting", ctx.request.body, {
+        namespace: "settings",
+      });
+
+      this.success(ctx, {});
+    };
+  };
+};
+```
+
+If the runtime does not support the built-in SQLite module or the project needs another store, generate `app/extend/db.js` or `app/extend/db.ts` and preserve the same method names so existing controllers keep working.
+
+## Dashboard Component Slot
+
+Use `frontend/extended/dash/components.tsx` to fill supported Dashboard slots. The current slot is:
+
+```text
+HeaderView.userArea
+```
+
+Example:
+
+```tsx
+import { LanguageSwitch, ThemeSwitch } from '@_tc/template-core/fe'
+import type { DashComponentsMap } from '@_tc/template-core/fe'
+
+const components = {
+  'HeaderView.userArea': ({ projectInfo }) => {
+    return (
+      <div className="flex items-center gap-2">
+        <span className="max-w-32 truncate text-xs text-muted-foreground">
+          {projectInfo?.name}
+        </span>
+        <LanguageSwitch />
+        <ThemeSwitch />
+      </div>
+    )
+  },
+} satisfies DashComponentsMap
+
+export default components
+```
+
+Keep header content compact; the default header already owns brand, title, and menu layout.
+
+## Dashboard Custom Routes
+
+Use `frontend/extended/dash/customRoutes.tsx` when a `custom` menu item needs a route inside the built-in Dashboard.
+
+```tsx
+import type { DashRoutesExtender } from '@_tc/template-core/fe'
+
+const extendDashRoutes: DashRoutesExtender = ({ topRoutes, sidebarRoutes }) => {
+  topRoutes.push({
+    path: '/custom-page',
+    component: <div>Custom Page</div>,
+  })
+
+  sidebarRoutes.push({
+    path: 'custom-sidebar-page',
+    component: <div>Custom Sidebar Page</div>,
+  })
+}
+
+export default extendDashRoutes
+```
+
+`topRoutes` are appended under `/dash`. `sidebarRoutes` are appended inside the default sidebar containers.
+
+## Frontend Helpers
+
+Import TemplateCore frontend helpers from `@_tc/template-core/fe`:
+
+```tsx
+import { AsyncSelect, LanguageSwitch, ThemeSwitch } from '@_tc/template-core/fe'
+```
+
+Import UI components from the published UI re-export:
+
+```tsx
+import { Button, DataTable, TableSearch } from '@_tc/template-core/fe/rc'
+```
+
+`LanguageSwitch` updates the shared i18n language and persists through `tc_language`. `ThemeSwitch` toggles the root `dark` class and persists through `tc_theme`. `AsyncSelect` loads options from a `fetchConfig` endpoint returning `{ label, value, searchText? }[]`.
+
+## SchemaForm Extensions
+
+TemplateCore already registers a framework SchemaForm type named `asyncSelect`. Use it in Schema CRUD model config when a field should fetch options from an API:
+
+```js
+owner_id: {
+  type: "string",
+  label: "Owner",
+  createFormOption: {
+    comType: "asyncSelect",
+    fetchConfig: {
+      url: "/user/options",
+      method: "get",
+    },
+  },
+  editFormOption: {
+    comType: "asyncSelect",
+    fetchConfig: {
+      url: "/user/options",
+      method: "get",
+    },
+  },
+}
+```
+
+The options controller should return the normal TemplateCore response wrapper:
+
+```js
+this.success(ctx, [
+  { label: "Alice", value: "u1" },
+  { label: "Bob", value: "u2" },
+]);
+```
+
+For project-specific field types, create `frontend/extended/SchemaForm/data.ts` and default-export a component map keyed by field type.
+
+## SchemaPage CallCom Extensions
+
+Use `frontend/extended/SchemaPage/CallCom/data.ts` when model `componentConfig` should open a custom runtime component instead of built-in create/edit/detail components. Custom components can import `schemaEventBus`, `eventsInfo`, and `merge` from `@_tc/template-core/fe` to close panels or refresh Schema tables.