@_tc/template-core 0.0.3 → 0.1.0

package/.skills/tc-generator/SKILL.md

@@ -0,0 +1,62 @@
+---
+name: tc-generator
+description: Generate TemplateCore business projects, modules, model configurations, Schema CRUD pages, controllers, routers, and project overrides that follow this repository's Koa + React + model-driven conventions. Use when the user asks to create or modify TC/TemplateCore projects, admin modules, model/mode.js files, schemaConfig CRUD pages, menu structures, or app/controller and app/router files.
+---
+
+# TC Generator
+
+Use this skill to generate or update TemplateCore business code.
+
+## Quick Workflow
+
+1. Identify the target business root. In this repository, a generated project usually uses:
+   - `index.js`
+   - `config/config.default.js`
+   - `app/controller/*.js`
+   - `app/router/*.js`
+   - `model/{modelKey}/mode.js`
+   - optional `model/{modelKey}/project/{projectKey}.js`
+2. Read only the reference needed:
+   - Model/menu/schema rules: `reference/model-schema.md`
+   - Runnable skeleton: `reference/project-template/`
+   - Complete product CRUD example: `reference/example.md`
+3. Generate the smallest working slice first: config, entry, controller, router, model.
+4. Keep keys stable. Array merge and project overrides depend on `key`.
+5. Prefer CommonJS `.js` for generated business examples unless the existing business project already uses TypeScript.
+
+## TemplateCore Conventions
+
+- Start the app with `serverStart({ name, baseDir })` from `@_tc/template-core`.
+- Start the built-in frontend with `buildFE("dev")` from `@_tc/template-core/bundler` when the user needs the admin UI.
+- Business code lives under the user's `baseDir`, not inside TemplateCore framework folders.
+- Backend loaders map filenames to camelCase fields:
+  - `app/controller/product.js` -> `app.controller.product`
+  - `app/service/user-profile.js` -> `app.service.userProfile`
+- Controller and service files export a factory: `module.exports = (app) => class Xxx {}`.
+- Router files export a function: `module.exports = (app, router) => { ... }`.
+- Schema pages expect REST-like endpoints:
+  - `GET {api}/list` for table data
+  - `GET {api}` for detail/edit fetch
+  - `POST {api}` for create
+  - `PUT {api}` for update
+  - `DELETE {api}` for remove
+
+## Output Rules
+
+- Make generated code directly runnable.
+- Include realistic in-memory data only for demos or scaffolds.
+- Use `$i18n::...` only when also adding or pointing to language resources; otherwise write plain labels.
+- For Schema CRUD, include `tableOption`, `createFormOption`, `editFormOption`, and `detailPanelOption` only where the field should appear.
+- For edit/detail components, set `fetchKey` to the primary key field.
+- For remove buttons, use `$schema::{field}` to pull values from the current row.
+
+## Validation
+
+When editing an existing project, verify with the closest available command:
+
+```bash
+pnpm type-check
+pnpm dev
+```
+
+For generated standalone CommonJS examples, at minimum inspect paths and imports against the current package name.

package/.skills/tc-generator/reference/example.md

@@ -0,0 +1,357 @@
+# Complete Product CRUD Example
+
+This example creates a minimal TemplateCore business project with a product Schema CRUD page.
+
+## Structure
+
+```text
+my-admin/
+├── app/
+│   ├── controller/
+│   │   └── product.js
+│   └── router/
+│       └── product.js
+├── config/
+│   └── config.default.js
+├── model/
+│   └── product/
+│       ├── mode.js
+│       └── project/
+│           └── default.js
+└── index.js
+```
+
+## index.js
+
+```js
+const { join } = require("path");
+const { serverStart } = require("@_tc/template-core");
+const { buildFE } = require("@_tc/template-core/bundler");
+
+async function main() {
+  await serverStart({
+    name: "my-admin",
+    baseDir: join(__dirname, "."),
+  });
+
+  await buildFE("dev");
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});
+```
+
+## config/config.default.js
+
+```js
+module.exports = {
+  port: 9000,
+};
+```
+
+## app/controller/product.js
+
+```js
+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",
+  },
+  {
+    product_id: "2",
+    product_name: "Product B",
+    price: 199,
+    inventory: 12,
+    status: "disabled",
+    create_time: "2026-05-18 11: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, {});
+    };
+  };
+};
+```
+
+## app/router/product.js
+
+```js
+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);
+};
+```
+
+## model/product/mode.js
+
+```js
+module.exports = {
+  mode: "MB",
+  name: "Product Admin",
+  desc: "Product management example",
+  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",
+                },
+              },
+            },
+          ],
+        },
+      },
+    },
+  ],
+};
+```
+
+## model/product/project/default.js
+
+```js
+module.exports = {
+  name: "Default Product Project",
+  desc: "Project-level overrides can be added here.",
+};
+```
+
+## Run
+
+```bash
+node index.js
+```
+
+Open:
+
+```text
+http://localhost:9000/dash?projk=default
+```