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

package/template/server/database/schema.ts

@@ -0,0 +1,90 @@
+/** auto generated, do not edit */
+import { pgTable, pgPolicy, uuid, varchar, text, customType } from "drizzle-orm/pg-core"
+import { sql } from "drizzle-orm"
+
+export const userProfile = customType<{
+  data: string;
+  driverData: string;
+}>({
+  dataType() {
+    return 'user_profile';
+  },
+  toDriver(value: string) {
+    return sql`ROW(${value})::user_profile`;
+  },
+  fromDriver(value: string) {
+    const [userId] = value.slice(1, -1).split(',');
+    return userId.trim();
+  },
+});
+
+export type FileAttachment = {
+  bucket_id: string;
+  file_path: string;
+};
+
+export const fileAttachment = customType<{
+  data: FileAttachment;
+  driverData: string;
+}>({
+  dataType() {
+    return 'file_attachment';
+  },
+  toDriver(value: FileAttachment) {
+    return sql`ROW(${value.bucket_id},${value.file_path})::file_attachment`;
+  },
+  fromDriver(value: string): FileAttachment {
+    const [bucketId, filePath] = value.slice(1, -1).split(',');
+    return { bucket_id: bucketId.trim(), file_path: filePath.trim() };
+  },
+});
+
+export const customTimestamptz = customType<{
+  data: Date;
+  driverData: string;
+  config: { precision?: number};
+}>({
+  dataType(config) {
+    const precision = typeof config?.precision !== 'undefined'
+      ? ` (${config.precision})`
+      : '';
+    return `timestamptz${precision}`;
+  },
+  toDriver(value: Date | string | number){
+    if(value == null) return value as any;
+    if (typeof value === 'number') {
+      return new Date(value).toISOString();
+    }
+    if(typeof value === 'string') {
+      return value;
+    }
+    if (value instanceof Date) {
+      return value.toISOString();
+    }
+    throw new Error('Invalid timestamp value');
+  },
+  fromDriver(value: string | Date): Date {
+    if(value instanceof Date) return value;
+    return new Date(value);
+  },
+});
+
+/**
+ * 以下是模板代码，仅作示例
+ */
+// export const record = pgTable("record", {
+// 	id: uuid().defaultRandom().notNull(),
+// 	title: varchar({ length: 255 }).notNull(),
+// 	type: varchar({ length: 255 }).notNull(),
+// 	creator: varchar({ length: 255 }).notNull(),
+// 	speakDate: customTimestamptz("speakDate").notNull(),
+// 	userProfile: userProfile("user_profile").notNull(),
+// 	// System field: Creation time (auto-filled, do not modify)
+// 	createdAt: customTimestamptz("_created_at").default(sql`CURRENT_TIMESTAMP`).notNull(),
+// 	// System field: Creator (auto-filled, do not modify)
+// 	createdBy: userProfile("_created_by"),
+// 	// System field: Update time (auto-filled, do not modify)
+// 	updatedAt: customTimestamptz("_updated_at").default(sql`CURRENT_TIMESTAMP`).notNull(),
+// 	// System field: Updater (auto-filled, do not modify)
+// 	updatedBy: userProfile("_updated_by"),
+// });

package/template/server/main.ts

@@ -0,0 +1,31 @@
+import { NestFactory } from '@nestjs/core';
+import { Logger } from '@nestjs/common';
+import { configureApp } from '@lark-apaas/fullstack-nestjs-core';
+import { join } from 'path';
+import { __express as hbsExpressEngine } from 'hbs';
+
+import type { NestExpressApplication } from '@nestjs/platform-express';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create<NestExpressApplication>(AppModule, {
+    abortOnError: process.env.NODE_ENV !== 'development',
+  });
+  await configureApp(app, { 
+    disableSwagger: true,
+  });
+  const logger = new Logger('Bootstrap');
+  const host = process.env.SERVER_HOST || 'localhost';
+  const port = Number(process.env.SERVER_PORT || '3000');
+
+  // 注册视图引擎, 渲染 client 目录下的 html 文件
+  app.setBaseViewsDir(join(process.cwd(), 'dist/client'));
+  app.setViewEngine('html');
+  app.engine('html', hbsExpressEngine);
+
+  await app.listen(port, host);
+  logger.log(`Server running on ${host}:${port}`);
+  logger.log(`API endpoints ready at http://${host}:${port}/api`);
+}
+
+bootstrap();

package/template/server/modules/hello/hello.controller.ts

@@ -0,0 +1,16 @@
+// /* 模板代码 仅作示例 */
+// import { Controller, Get, Post, Put, Delete, Body, Param, Query, Req, ParseIntPipe } from '@nestjs/common';
+// import type { Request } from 'express';
+// import { HelloService } from './hello.service';
+
+// @Controller('api/hello')
+// export class HelloController {
+//   constructor(private readonly helloService: HelloService) {}
+
+//   @Get('test')
+//   async test(@Req() req: Request, @Query('limit') limit?: string) {
+//     const { userId } = req.userContext;
+//     const limitNum = limit ? parseInt(limit) : 5;
+//     return this.helloService.test(userId, limitNum);
+//   }
+// }

package/template/server/modules/hello/hello.module.ts

@@ -0,0 +1,10 @@
+/* 模板代码 仅作示例 */
+// import { Module } from '@nestjs/common';
+// import { HelloController } from './hello.controller';
+// import { HelloService } from './hello.service';
+
+// @Module({
+//   controllers: [HelloController],
+//   providers: [HelloService],
+// })
+// export class HelloModule{}

package/template/server/modules/hello/hello.service.ts

@@ -0,0 +1,28 @@
+// /* 模板代码 仅作示例 */
+// import { Injectable, Inject, Logger } from '@nestjs/common';
+// import { DRIZZLE_DATABASE, type PostgresJsDatabase } from '@lark-apaas/fullstack-nestjs-core';
+// import { record } from '@server/database/schema';
+// import { eq, and, count, desc, sql, gte, lte, or } from 'drizzle-orm';
+
+// @Injectable()
+// export class HelloService {
+//   private readonly logger = new Logger(HelloService.name);
+
+//   constructor(@Inject(DRIZZLE_DATABASE) private readonly db: PostgresJsDatabase) {}
+
+//   async test(userId: string, limit: number = 5) {
+//     try {
+//       const results = await this.db
+//         .select()
+//         .from(record)
+//         .where(eq(record.userProfile, userId))
+//         .orderBy(desc(record.speakDate))
+//         .limit(limit);
+  
+//       return results;
+//     } catch (error) {
+//       this.logger.error('获取最近记录失败', error);
+//       throw error;
+//     }
+//   }
+// }

package/template/server/modules/view/view.controller.ts

@@ -0,0 +1,17 @@
+import { Controller, Get, Render, Req } from '@nestjs/common';
+import type { Request } from 'express';
+
+@Controller()
+export class ViewController {
+
+  @Get(['/', '*'])
+  @Render('index')
+  async render(@Req() req: Request): Promise<{ __platform__: string }>  {
+    // you can add custom render params here
+    const platformData = req.__platform_data__ ?? {};
+    return {
+      // don't delete this line, it's used by client to get platform info
+      __platform__: JSON.stringify(platformData),
+    };
+  }
+}

package/template/server/modules/view/view.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { ViewController } from './view.controller';
+
+@Module({
+  controllers: [ViewController],
+  providers: [],
+})
+export class ViewModule{}

package/template/shared/api.interface.ts

@@ -0,0 +1 @@
+/* 前后端共享的类型写在这里 */

package/template/tailwind.config.ts

@@ -0,0 +1,9 @@
+import { createTailwindPresetOfSimple } from '@lark-apaas/fullstack-presets';
+
+export default {
+  presets: [createTailwindPresetOfSimple()],
+  content: [
+    './client/src/**/*.{ts,tsx,css}',
+  ],
+  plugins: [],
+}

package/template/tsconfig.app.json

@@ -0,0 +1,23 @@
+{
+  "extends": "@lark-apaas/fullstack-presets/lib/simple/tsconfig/tsconfig.app.json",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "paths": {
+      "@client/*": ["client/*"],
+      "@shared/*": ["shared/*"],
+      "@/*": ["./client/src/*"],
+      "@lark-apaas/client-toolkit/tools/*": ["node_modules/@lark-apaas/client-toolkit/lib/apis/tools/*"]
+    },
+    "incremental": true,
+  },
+  "include": [
+    "client/**/*",
+    "shared/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "public",
+    "client/src/api/gen"
+  ]
+}

package/template/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.app.json",
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    }
+  ]
+}

package/template/tsconfig.node.json

@@ -0,0 +1,16 @@
+{
+  "extends": "@lark-apaas/fullstack-presets/lib/simple/tsconfig/tsconfig.node.json",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "outDir": "./dist",
+    "paths": {
+      "@server/*": ["server/*"],
+      "@shared/*": ["shared/*"],
+    }
+  },
+  "watchOptions": {
+    "excludeDirectories": ["node_modules/**"]
+  },
+  "include": ["server/**/*", "shared/**/*.ts"],
+  "exclude": ["node_modules", "dist", "client", "**/*.spec.ts", "**/*.e2e-spec.ts"],
+}

package/template/vite.config.ts

@@ -0,0 +1,10 @@
+import path from 'path';
+import { defineConfig } from '@lark-apaas/fullstack-vite-preset';
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      '@': path.resolve(__dirname, 'client/src'),
+    },
+  },
+});