@lark-apaas/coding-template-nestjs-react-fullstack 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,13 @@
+MIT License
+
+Copyright (c) 2024 Lark Technologies Pte. Ltd. and/or its affiliates
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,provided that the above copyright notice and this permission notice appear in all copies.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# @lark-apaas/coding-template-nestjs-react-fullstack
+
+妙搭 (Miaoda) NestJS + React 全栈应用模板。`archType: 3`（application scene）。
+
+## 用法
+
+通过 `miaoda app init` 渲染：
+
+```bash
+MIAODA_APP_TYPE=3 npx @lark-apaas/miaoda-cli@<latest> app init \
+  --template nestjs-react-fullstack \
+  --app-id app_xxx
+```
+
+## 本地开发（`npm run dev:local`）
+
+依赖 SDK 自带的 dotenv 加载（`@lark-apaas/fullstack-{vite-preset,nestjs-core}` ≥ 对应 alpha 版本）。在新生成的应用目录里：
+
+1. 填 `.env.local`（从 `_env.local` 模板渲染而来，注释里写了每个 env 的获取方式）
+2. `npm run dev:local`
+
+关键 env：
+
+- `MIAODA_LOCAL_DEV=1` —— 由 `scripts/dev-local.sh` 自动 export
+- `FORCE_AUTHN_PREVIEW_SESSION_ID` —— 后端下发的 session id（替代浏览器手抠 cookie）
+- `SUDA_WEBUSER` —— webuser JSON
+- `SANDBOX_PUBLIC_URL` —— 沙箱公网域
+- `CLIENT_BASE_PATH=/app/<app_id>/` —— React Router basename + Vite base
+
+## 包结构
+
+```
+.
+├── package.json          ← 本模板包的发包元数据
+├── hooks/                ← miaoda-cli 在 init 阶段调用的 hook（v0.1 全 no-op）
+└── template/             ← 渲染到用户应用目录的内容
+```
+
+`template/` 内以下划线开头的占位文件（`_gitignore` / `_npmrc` / `_env.local`）在 `miaoda app init`
+渲染时会按 RENAME 映射改回正常名（npm pack 会特殊处理 `.gitignore`、且 `.npmrc` 直接放
+在包里会污染用户 `npm install` 行为，所以都要 underscore 前缀）。

package/hooks/after-install.mjs

@@ -0,0 +1,3 @@
+export default async function afterInstall(ctx) {
+  // no-op for v0.1
+}

package/hooks/after-render.mjs

@@ -0,0 +1,3 @@
+export default async function afterRender(ctx) {
+  // no-op for v0.1
+}

package/hooks/before-render.mjs

@@ -0,0 +1,3 @@
+export default async function beforeRender(ctx) {
+  // no-op for v0.1
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@lark-apaas/coding-template-nestjs-react-fullstack",
+  "version": "0.1.0-alpha.1",
+  "description": "NestJS + React fullstack template for miaoda coding",
+  "type": "module",
+  "files": [
+    "template",
+    "hooks"
+  ],
+  "scripts": {
+    "validate-manifest": "node ../../../scripts/validate-template.mjs .",
+    "smoke": "echo 'smoke skipped: template build.sh prompts interactively for plugin scaffolding (fullstack-cli action-plugin add). Re-enable once build.sh supports non-interactive mode or smoke runs typecheck-only.' && exit 0",
+    "prepublishOnly": "pnpm validate-manifest"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "keywords": [
+    "miaoda",
+    "coding-template",
+    "nestjs",
+    "react",
+    "fullstack"
+  ],
+  "license": "MIT",
+  "miaodaTemplate": {
+    "schemaVersion": 1,
+    "archType": 3,
+    "hooks": {
+      "beforeRender": "hooks/before-render.mjs",
+      "afterRender": "hooks/after-render.mjs",
+      "afterInstall": "hooks/after-install.mjs"
+    }
+  }
+}

package/template/.codebase/pipelines/ci.yaml

@@ -0,0 +1,34 @@
+name: CI
+trigger:
+  manual:
+  change:
+    types: [create, push, restore]
+    notification:
+      when: failure
+jobs:
+  run_all:
+    runs-on:
+      env: online
+      spec: m1.2xlarge
+    name: CI Check
+    timeout: 30
+    image: hub.byted.org/compile/toutiao.compile_nodejs.v24:226b14276e1aa1db07ccc1e6d6055e8c
+    envs:
+      CI: 'true'
+      NODE_OPTIONS: '--max-old-space-size=8192'
+    steps:
+      - id: Checkout
+        uses: actions/checkout
+        inputs:
+          depth: 1
+      - name: Install dependencies
+        commands:
+          - npm config set registry=https://registry.npmmirror.com
+          - npm install --no-package-lock
+      - name: ESLint (应用模式)
+        parallel-with-next-step: true
+        commands:
+          - npm run eslint
+      - name: TypeScript Check
+        commands:
+          - npm run type:check

package/template/.codebase/pipelines/coco-code-review.yaml

@@ -0,0 +1,21 @@
+name: Code Review
+trigger:
+  manual:
+  change:
+    branches: ['master']
+    types: [create, push]
+jobs:
+  run_cr:
+    runs-on:
+      env: online
+    name: Coco Code Review
+    if: '${{ Event.Change.IsPreSubmit == false }}'
+    image: hub.byted.org/base/lbpe-code-review:latest
+    timeout: 30
+    envs:
+      MR_SOURCE_BRANCH: ${{Event.Change.Source.Branch}}
+      MR_TARGET_BRANCH: ${{Event.Change.Target.Branch}}
+    steps:
+      - name: Code Review
+        commands:
+          - mr-review ${{Event.Change.URL}}

package/template/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false
+}

package/template/.spark_project

@@ -0,0 +1,16 @@
+run = ["npm", "run", "dev"] # 默认 spark-cli dev
+hidden = [".config", ".git", "scripts", "node_modules", "dist", ".spark", ".agent", ".agents", "tmp", ".spark_project", ".playwright-cli"]
+lint = ["npm", "run", "lint"]
+test = ["npm", "run", "test"]
+genDbSchema = ["npm", "run", "gen:db-schema"]
+genOpenApiClient = ["echo", "'SKIP GEN API CLIENT, WRITE CODE BY YOURSELF'"]
+
+[deployment]
+build = ["npm", "run", "build"]
+run = ["npm", "run", "start"]
+
+[files]
+[files.restrict]
+pathPatterns = ["client/src/api/gen", "package.json", ".spark_project"]
+[files.hidden]
+pathPatterns = [".config", ".git", "scripts", "node_modules", "dist", ".spark", ".agent", ".agents", "tmp", ".spark_project", ".playwright-cli"]

package/template/.stylelintrc.js

@@ -0,0 +1,12 @@
+const { stylelintPresetsOfSimple } = require('@lark-apaas/fullstack-presets');
+
+module.exports = {
+  extends: [ stylelintPresetsOfSimple ],
+  ignoreFiles: [
+    'node_modules/**',
+    'dist/**',
+    'build/**',
+    'coverage/**',
+    '*.min.css',
+  ],
+};

package/template/_env.local

@@ -0,0 +1,38 @@
+# =================================================
+# 妙搭本地开发 — .env.local
+# 优先级：shell env > .env.local > .env
+# SDK（fullstack-vite-preset / fullstack-nestjs-core）在 module init 通过 dotenv 自动加载
+# =================================================
+
+# ───── 应用上下文 ─────
+# app_id=app_xxx
+# CLIENT_BASE_PATH=/app/app_xxx/                              # React Router basename + Vite base
+# FORCE_FRAMEWORK_DOMAIN_MAIN=https://miaoda.feishu-boe.cn
+# FORCE_FRAMEWORK_ENVIRONMENT=boe
+
+# ───── 端口（缺省即使用 SDK 默认 8080 / 3000，本地推荐 8001 / 3000）─────
+# CLIENT_DEV_PORT=8001
+# SERVER_PORT=3000
+# SERVER_HOST=localhost
+# CLIENT_DEV_HOST=0.0.0.0
+
+# ───── 业务 DB（BOE PG 公网 endpoint，本地可直连）─────
+# SUDA_DATABASE_URL=postgresql://<user>:<pass>@<host>.miaoda-pg-staging.aiforce.cloud:5432/<db>?sslmode=require&schema=workspace_<id>
+
+# ───── 沙箱反代（本地 dev 兜底；MIAODA_LOCAL_DEV=1 由 scripts/dev-local.sh 自动 export）─────
+# SANDBOX_PUBLIC_URL=https://ai-tenant-<app_id>-<sandbox_id>.aiforce-boe-preview.bytedance.net
+
+# 后端下发的单值 session id（新流，推荐）
+# FORCE_AUTHN_PREVIEW_SESSION_ID=<后端给的 session 值>
+
+# webuser 身份（JSON，必须单行无空格）
+# SUDA_WEBUSER={"user_id":"...","tenant_id":...,"app_id":"app_xxx","env":"preview","login_url":"","roles":null,"user_type":"_employee","user_name":{"zh_cn":"..."}}
+
+# ───── 日志 ─────
+LOG_DIR=./logs
+LOG_REQUEST_BODY=true
+LOG_RESPONSE_BODY=true
+
+# ───── 构建期 ─────
+FORCE_FRAMEWORK_BUILD_LOOSE_MODE=false
+FORCE_FRAMEWORK_LINT_LOOSE_MODE=false

package/template/_gitignore

@@ -0,0 +1,64 @@
+# Dependencies
+node_modules/
+*/node_modules/
+
+# Production builds
+dist/
+*/dist/
+build/
+*/build/
+
+# Environment files
+.env.local
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+/logs/
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage/
+*.lcov
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Temporary folders
+tmp/
+temp/
+.playwright-cli/
+
+# Lock files (keep package-lock.json for consistent installs)
+yarn.lock
+pnpm-lock.yaml
+
+# Cache files
+.eslintcache
+*.tsbuildinfo
+
+# swc wasm
+.swc
+
+# Agent files
+.agent/

package/template/_npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmmirror.com/

package/template/client/index.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="zh">
+
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <link rel="icon" href="/favicon.svg">
+  <title>妙搭</title>
+  <script>
+    try {
+      window.__platform__ = JSON.parse('{{{__platform__}}}');
+    } catch (e) {
+      console.error('Failed to parse __platform__', e);
+    }
+  </script>
+</head>
+
+<body>
+  <div id="root"></div>
+  <script type="module" src="/client/src/index.tsx"></script>
+</body>
+
+</html>

package/template/client/public/favicon.svg

@@ -0,0 +1,40 @@
+<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M14.2129 25.336V19.653C14.2129 16.5158 16.756 13.9727 19.8932 13.9727H24.8207V14.178C24.8207 14.8678 24.5661 15.5358 24.1062 16.0504L15.4037 25.7904C14.9849 26.2585 14.2129 25.9629 14.2129 25.336Z" fill="url(#paint0_linear_8585_129329)"/>
+<path d="M14.2129 25.336V19.653C14.2129 16.5158 16.756 13.9727 19.8932 13.9727H24.8207V14.178C24.8207 14.8678 24.5661 15.5358 24.1062 16.0504L15.4037 25.7904C14.9849 26.2585 14.2129 25.9629 14.2129 25.336Z" fill="url(#paint1_linear_8585_129329)"/>
+<path d="M20.0485 7.85156H14.683C14.4229 7.85156 14.2148 8.06235 14.2148 8.31967C14.2148 11.4568 16.758 14 19.8952 14H23.8043C24.2341 14.1232 24.5544 14.5584 24.5544 15.0813C24.5544 15.2592 24.516 15.4235 24.4531 15.5713C24.694 15.1497 24.8226 14.6542 24.8226 14.1478V12.6258C24.8226 9.98955 22.6847 7.85156 20.0485 7.85156Z" fill="url(#paint2_linear_8585_129329)"/>
+<path d="M13.7875 2.6645V8.34754C13.7875 11.4847 11.2444 14.0278 8.10718 14.0278H3.17969V13.8225C3.17969 13.1327 3.43427 12.4647 3.89417 11.9501L12.5967 2.21007C13.0155 1.74196 13.7875 2.03761 13.7875 2.6645Z" fill="url(#paint3_linear_8585_129329)"/>
+<path d="M13.7875 2.6645V8.34754C13.7875 11.4847 11.2444 14.0278 8.10718 14.0278H3.17969V13.8225C3.17969 13.1327 3.43427 12.4647 3.89417 11.9501L12.5967 2.21007C13.0155 1.74196 13.7875 2.03761 13.7875 2.6645Z" fill="url(#paint4_linear_8585_129329)"/>
+<path d="M13.7875 2.6645V8.34754C13.7875 11.4847 11.2444 14.0278 8.10718 14.0278H3.17969V13.8225C3.17969 13.1327 3.43427 12.4647 3.89417 11.9501L12.5967 2.21007C13.0155 1.74196 13.7875 2.03761 13.7875 2.6645Z" fill="url(#paint5_linear_8585_129329)"/>
+<path d="M7.95388 20.1485H13.3194C13.5794 20.1485 13.7875 19.9377 13.7875 19.6803C13.7875 16.5432 11.2444 14 8.10718 14H4.19804C3.76825 13.8768 3.44796 13.4416 3.44796 12.9187C3.44796 12.7408 3.48629 12.5765 3.54925 12.4287C3.30835 12.8503 3.17969 13.3458 3.17969 13.8522V15.3743C3.17969 18.0105 5.31767 20.1485 7.95388 20.1485Z" fill="url(#paint6_linear_8585_129329)"/>
+<defs>
+<linearGradient id="paint0_linear_8585_129329" x1="23.7284" y1="12.519" x2="14.1922" y2="21.9925" gradientUnits="userSpaceOnUse">
+<stop offset="0.196503" stop-color="#2C68FF"/>
+<stop offset="1" stop-color="#9CB5FF"/>
+</linearGradient>
+<linearGradient id="paint1_linear_8585_129329" x1="23.7453" y1="13.9669" x2="21.0235" y2="27.7848" gradientUnits="userSpaceOnUse">
+<stop offset="0.0917703" stop-color="#1E7DFF"/>
+<stop offset="0.82106" stop-color="#91AEFD"/>
+</linearGradient>
+<linearGradient id="paint2_linear_8585_129329" x1="13.3286" y1="7.4164" x2="26.5839" y2="15.5456" gradientUnits="userSpaceOnUse">
+<stop stop-color="#2880FF"/>
+<stop offset="0.602642" stop-color="#AA93FE"/>
+<stop offset="0.925066" stop-color="#D0C0FF"/>
+</linearGradient>
+<linearGradient id="paint3_linear_8585_129329" x1="-2.17936" y1="16.9699" x2="16.1938" y2="3.20926" gradientUnits="userSpaceOnUse">
+<stop offset="0.293542" stop-color="#FFEDDC"/>
+<stop offset="0.848516" stop-color="#50AAFF"/>
+</linearGradient>
+<linearGradient id="paint4_linear_8585_129329" x1="5.25082" y1="14.0444" x2="7.59094" y2="-1.34504" gradientUnits="userSpaceOnUse">
+<stop stop-color="#2075FF"/>
+<stop offset="0.837223" stop-color="#A892FE"/>
+</linearGradient>
+<linearGradient id="paint5_linear_8585_129329" x1="5.71682" y1="13.4748" x2="8.41257" y2="0.832496" gradientUnits="userSpaceOnUse">
+<stop offset="0.0917703" stop-color="#1E7DFF"/>
+<stop offset="0.82106" stop-color="#91AEFD"/>
+</linearGradient>
+<linearGradient id="paint6_linear_8585_129329" x1="14.5191" y1="20.827" x2="2.32534" y2="13.3709" gradientUnits="userSpaceOnUse">
+<stop offset="0.085229" stop-color="#1683FC"/>
+<stop offset="0.721235" stop-color="#ADA8FF"/>
+</linearGradient>
+</defs>
+</svg>

package/template/client/src/api/index.ts

@@ -0,0 +1,19 @@
+import { logger } from '@lark-apaas/client-toolkit/logger';
+import { axiosForBackend } from '@lark-apaas/client-toolkit/utils/getAxiosForBackend';
+
+
+// Add more API functions here, use axios instance (`axiosForBackend`) to make requests.
+// 
+// 使用示例：
+// export async function getUserData(userId: string) {
+//   try {
+//     const response = await axiosForBackend({
+//       url: `/api/users/${userId}`,
+//       method: 'GET'
+//     });
+//     return response.data;
+//   } catch (error) {
+//     logger.error('获取用户数据失败', error);
+//     throw error;
+//   }
+// }

package/template/client/src/app.tsx

@@ -0,0 +1,22 @@
+import React from 'react';
+import { Route, Routes } from 'react-router-dom';
+
+// This is a temporary placeholder component from spark-framework
+import { Welcome } from '@lark-apaas/client-toolkit/components/Welcome';
+
+import Layout from './components/Layout';
+import NotFound from './pages/NotFound/NotFound';
+
+const RoutesComponent = () => {
+  return (
+    <Routes>
+      <Route element={<Layout />}>
+        {/* This Welcome component should be replaced with the actual home page content */}
+        <Route index element={<Welcome />} />
+      </Route>
+      <Route path="*" element={<NotFound />} />
+    </Routes>
+  );
+};
+
+export default RoutesComponent;

package/template/client/src/components/Layout.tsx

@@ -0,0 +1,11 @@
+import { Outlet } from "react-router-dom";
+
+const Layout = () => {
+  return (
+    <div className="w-screen h-screen">
+      <Outlet />
+    </div>
+  );
+};
+
+export default Layout;