(envObj).reduce((prev, [key, value]) => {
+ return `${prev}
+ ${key}: '${value}';`
+}, '').trim()
+
+fs.writeFile(path.join(directoryPath, 'types/env.d.ts'), `
+// generate by ./scripts/generateEnvTypes.ts
+declare global {
+ namespace NodeJS {
+ interface ProcessEnv {
+ ${envType}
+ }
+ }
+}
+export {};
+ `, (err) => {
+ if (err)
+ console.log('生成 env.d.ts 文件失败')
+ else
+ console.log('成功生成 env.d.ts 文件')
+})
+
+// console.log('envObj:', envObj)
+
+function formatValue(value) {
+ let _value
+ try {
+ const res = JSON.parse(value)
+ _value = typeof res === 'object' ? value : res
+ }
+ catch (error) {
+ _value = `'${value}'`
+ }
+ return _value
+}
diff --git a/scripts/resetScheduler.ts b/scripts/resetScheduler.ts
new file mode 100644
index 0000000..2a85291
--- /dev/null
+++ b/scripts/resetScheduler.ts
@@ -0,0 +1,26 @@
+import { exec } from 'node:child_process'
+
+import { CronJob } from 'cron'
+
+/** 此文件仅供演示时使用 */
+
+const runMigrationGenerate = async function () {
+ exec('npm run migration:revert && npm run migration:run', (error, stdout, stderr) => {
+ if (!error)
+ console.log('操作成功', error)
+
+ else
+ console.log('操作失败', error)
+ })
+}
+
+const job = CronJob.from({
+ /** 每天凌晨 4.30 恢复初始数据 */
+ cronTime: '30 4 * * *',
+ timeZone: 'Asia/Shanghai',
+ start: true,
+ onTick() {
+ runMigrationGenerate()
+ console.log('Task executed daily at 4.30 AM:', new Date().toLocaleTimeString())
+ },
+})
diff --git a/src/app.module.ts b/src/app.module.ts
new file mode 100644
index 0000000..53348e8
--- /dev/null
+++ b/src/app.module.ts
@@ -0,0 +1,98 @@
+import { ClassSerializerInterceptor, Module } from '@nestjs/common';
+
+import { ConfigModule } from '@nestjs/config';
+import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR } from '@nestjs/core';
+
+import config from '~/config';
+import { SharedModule } from '~/shared/shared.module';
+
+import { AllExceptionsFilter } from './common/filters/any-exception.filter';
+
+import { IdempotenceInterceptor } from './common/interceptors/idempotence.interceptor';
+import { TimeoutInterceptor } from './common/interceptors/timeout.interceptor';
+import { TransformInterceptor } from './common/interceptors/transform.interceptor';
+import { AuthModule } from './modules/auth/auth.module';
+import { JwtAuthGuard } from './modules/auth/guards/jwt-auth.guard';
+import { RbacGuard } from './modules/auth/guards/rbac.guard';
+import { HealthModule } from './modules/health/health.module';
+import { NetdiskModule } from './modules/netdisk/netdisk.module';
+import { SseModule } from './modules/sse/sse.module';
+import { SystemModule } from './modules/system/system.module';
+import { TasksModule } from './modules/tasks/tasks.module';
+import { TodoModule } from './modules/todo/todo.module';
+import { ToolsModule } from './modules/tools/tools.module';
+import { DatabaseModule } from './shared/database/database.module';
+
+import { SocketModule } from './socket/socket.module';
+import { ContractModule } from './modules/contract/contract.module';
+import { MaterialsInventoryModule } from './modules/materials_inventory/materials_inventory.module';
+import { CompanyModule } from './modules/company/company.module';
+import { ProductModule } from './modules/product/product.module';
+import { ProjectModule } from './modules/project/project.module';
+import { VehicleUsageModule } from './modules/vehicle_usage/vehicle_usage.module';
+import { SaleQuotationModule } from './modules/sale_quotation/sale_quotation.module';
+import { DomainModule } from './modules/domian/domain.module';
+
+@Module({
+ imports: [
+ ConfigModule.forRoot({
+ isGlobal: true,
+ expandVariables: true,
+ // 指定多个 env 文件时，第一个优先级最高
+ envFilePath: ['.env.local', `.env.${process.env.NODE_ENV}`, '.env'],
+ load: [...Object.values(config)]
+ }),
+ SharedModule,
+ DatabaseModule,
+
+ AuthModule,
+ SystemModule,
+ TasksModule.forRoot(),
+ ToolsModule,
+ SocketModule,
+ HealthModule,
+ SseModule,
+ NetdiskModule,
+
+ // biz
+
+ // end biz
+
+ TodoModule,
+ // 合同模块
+ ContractModule,
+
+ // 原材料库存
+ MaterialsInventoryModule,
+
+ // 公司管理
+ CompanyModule,
+
+ // 产品管理
+ ProductModule,
+
+ // 项目管理
+ ProjectModule,
+
+ // 车辆管理
+ VehicleUsageModule,
+
+ //报价管理
+ SaleQuotationModule,
+ //域
+ DomainModule
+ ],
+ providers: [
+ { provide: APP_FILTER, useClass: AllExceptionsFilter },
+
+ { provide: APP_INTERCEPTOR, useClass: ClassSerializerInterceptor },
+ { provide: APP_INTERCEPTOR, useClass: TransformInterceptor },
+ { provide: APP_INTERCEPTOR, useFactory: () => new TimeoutInterceptor(15 * 1000) },
+ { provide: APP_INTERCEPTOR, useClass: IdempotenceInterceptor },
+
+ { provide: APP_GUARD, useClass: JwtAuthGuard },
+ { provide: APP_GUARD, useClass: RbacGuard }
+ ],
+ controllers: []
+})
+export class AppModule {}
diff --git a/src/assets/templates/verification-code-zh.hbs b/src/assets/templates/verification-code-zh.hbs
new file mode 100644
index 0000000..df3702a
--- /dev/null
+++ b/src/assets/templates/verification-code-zh.hbs
@@ -0,0 +1,4 @@
+你的验证码是：
+{{code}}
+该验证码 10 分钟内有效，请勿将验证码告知给他人！
+本邮件由系统自动发出，请勿回复。
\ No newline at end of file
diff --git a/src/assets/templates/verification-code.hbs b/src/assets/templates/verification-code.hbs
new file mode 100644
index 0000000..6545c27
--- /dev/null
+++ b/src/assets/templates/verification-code.hbs
@@ -0,0 +1,5 @@
+Your verification code is:
+{{verificationCode}}
+This code will expire in 10 minutes.
+This email is sent automatically by the system, please do not
+ reply.
\ No newline at end of file
diff --git a/src/common/adapters/fastify.adapter.ts b/src/common/adapters/fastify.adapter.ts
new file mode 100644
index 0000000..25ff8c2
--- /dev/null
+++ b/src/common/adapters/fastify.adapter.ts
@@ -0,0 +1,45 @@
+import FastifyCookie from '@fastify/cookie';
+import FastifyMultipart from '@fastify/multipart';
+import { FastifyAdapter } from '@nestjs/platform-fastify';
+
+const app: FastifyAdapter = new FastifyAdapter({
+ trustProxy: true,
+ logger: false
+ // forceCloseConnections: true,
+});
+export { app as fastifyApp };
+
+app.register(FastifyMultipart, {
+ attachFieldsToBody:true,
+ limits: {
+ fields: 10, // Max number of non-file fields
+ fileSize: 1024 * 1024 * 50, // limit size 50M
+ files: 5 // Max number of file fields
+ }
+});
+
+app.register(FastifyCookie, {
+ secret: 'cookie-secret' // 这个 secret 不太重要，不存鉴权相关，无关紧要
+});
+
+app.getInstance().addHook('onRequest', (request, reply, done) => {
+ // set undefined origin
+ const { origin } = request.headers;
+ if (!origin) request.headers.origin = request.headers.host;
+
+ // forbidden php
+
+ const { url } = request;
+
+ if (url.endsWith('.php')) {
+ reply.raw.statusMessage =
+ 'Eh. PHP is not support on this machine. Yep, I also think PHP is bestest programming language. But for me it is beyond my reach.';
+
+ return reply.code(418).send();
+ }
+
+ // skip favicon request
+ if (url.match(/favicon.ico$/) || url.match(/manifest.json$/)) return reply.code(204).send();
+
+ done();
+});
diff --git a/src/common/adapters/socket.adapter.ts b/src/common/adapters/socket.adapter.ts
new file mode 100644
index 0000000..ae18518
--- /dev/null
+++ b/src/common/adapters/socket.adapter.ts
@@ -0,0 +1,26 @@
+import { INestApplication } from '@nestjs/common';
+import { IoAdapter } from '@nestjs/platform-socket.io';
+import { createAdapter } from '@socket.io/redis-adapter';
+
+import { REDIS_PUBSUB } from '~/shared/redis/redis.constant';
+
+export const RedisIoAdapterKey = 'm-shop-socket';
+
+export class RedisIoAdapter extends IoAdapter {
+ constructor(private readonly app: INestApplication) {
+ super(app);
+ }
+
+ createIOServer(port: number, options?: any) {
+ const server = super.createIOServer(port, options);
+
+ const { pubClient, subClient } = this.app.get(REDIS_PUBSUB);
+
+ const redisAdapter = createAdapter(pubClient, subClient, {
+ key: RedisIoAdapterKey,
+ requestsTimeout: 10000
+ });
+ server.adapter(redisAdapter);
+ return server;
+ }
+}
diff --git a/src/common/decorators/api-result.decorator.ts b/src/common/decorators/api-result.decorator.ts
new file mode 100644
index 0000000..dc54efe
--- /dev/null
+++ b/src/common/decorators/api-result.decorator.ts
@@ -0,0 +1,78 @@
+import { HttpStatus, Type, applyDecorators } from '@nestjs/common';
+import { ApiExtraModels, ApiResponse, getSchemaPath } from '@nestjs/swagger';
+
+import { ResOp } from '~/common/model/response.model';
+
+const baseTypeNames = ['String', 'Number', 'Boolean'];
+
+function genBaseProp(type: Type) {
+ if (baseTypeNames.includes(type.name)) return { type: type.name.toLocaleLowerCase() };
+ else return { $ref: getSchemaPath(type) };
+}
+
+/**
+ * @description: 生成返回结果装饰器
+ */
+export function ApiResult>({
+ type,
+ isPage,
+ status
+}: {
+ type?: TModel | TModel[];
+ isPage?: boolean;
+ status?: HttpStatus;
+}) {
+ let prop = null;
+
+ if (Array.isArray(type)) {
+ if (isPage) {
+ prop = {
+ type: 'object',
+ properties: {
+ items: {
+ type: 'array',
+ items: { $ref: getSchemaPath(type[0]) }
+ },
+ meta: {
+ type: 'object',
+ properties: {
+ itemCount: { type: 'number', default: 0 },
+ totalItems: { type: 'number', default: 0 },
+ itemsPerPage: { type: 'number', default: 0 },
+ totalPages: { type: 'number', default: 0 },
+ currentPage: { type: 'number', default: 0 }
+ }
+ }
+ }
+ };
+ } else {
+ prop = {
+ type: 'array',
+ items: genBaseProp(type[0])
+ };
+ }
+ } else if (type) {
+ prop = genBaseProp(type);
+ } else {
+ prop = { type: 'null', default: null };
+ }
+
+ const model = Array.isArray(type) ? type[0] : type;
+
+ return applyDecorators(
+ ApiExtraModels(model),
+ ApiResponse({
+ status,
+ schema: {
+ allOf: [
+ { $ref: getSchemaPath(ResOp) },
+ {
+ properties: {
+ data: prop
+ }
+ }
+ ]
+ }
+ })
+ );
+}
diff --git a/src/common/decorators/bypass.decorator.ts b/src/common/decorators/bypass.decorator.ts
new file mode 100644
index 0000000..eb66876
--- /dev/null
+++ b/src/common/decorators/bypass.decorator.ts
@@ -0,0 +1,10 @@
+import { SetMetadata } from '@nestjs/common';
+
+export const BYPASS_KEY = '__bypass_key__';
+
+/**
+ * 当不需要转换成基础返回格式时添加该装饰器
+ */
+export function Bypass() {
+ return SetMetadata(BYPASS_KEY, true);
+}
diff --git a/src/common/decorators/cookie.decorator.ts b/src/common/decorators/cookie.decorator.ts
new file mode 100644
index 0000000..9b91ba5
--- /dev/null
+++ b/src/common/decorators/cookie.decorator.ts
@@ -0,0 +1,8 @@
+import type { ExecutionContext } from '@nestjs/common';
+import { createParamDecorator } from '@nestjs/common';
+import type { FastifyRequest } from 'fastify';
+
+export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
+ const request = ctx.switchToHttp().getRequest();
+ return data ? request.cookies?.[data] : request.cookies;
+});
diff --git a/src/common/decorators/cron-once.decorator.ts b/src/common/decorators/cron-once.decorator.ts
new file mode 100644
index 0000000..36267e9
--- /dev/null
+++ b/src/common/decorators/cron-once.decorator.ts
@@ -0,0 +1,19 @@
+import cluster from 'node:cluster';
+
+import { Cron } from '@nestjs/schedule';
+
+import { isMainProcess } from '~/global/env';
+
+export const CronOnce: typeof Cron = (...rest): MethodDecorator => {
+ // If not in cluster mode, and PM2 main worker
+ if (isMainProcess)
+ // eslint-disable-next-line no-useless-call
+ return Cron.call(null, ...rest);
+
+ if (cluster.isWorker && cluster.worker?.id === 1)
+ // eslint-disable-next-line no-useless-call
+ return Cron.call(null, ...rest);
+
+ const returnNothing: MethodDecorator = () => {};
+ return returnNothing;
+};
diff --git a/src/common/decorators/domain.decorator.ts b/src/common/decorators/domain.decorator.ts
new file mode 100644
index 0000000..1ecb045
--- /dev/null
+++ b/src/common/decorators/domain.decorator.ts
@@ -0,0 +1,18 @@
+import { ExecutionContext, createParamDecorator } from '@nestjs/common';
+import { ApiProperty } from '@nestjs/swagger';
+import { IsOptional } from 'class-validator';
+import type { FastifyRequest } from 'fastify';
+/**
+ * 当前域
+ */
+export const Domain = createParamDecorator((_, context: ExecutionContext) => {
+ const request = context.switchToHttp().getRequest();
+ return request.headers['sk-domain'] ?? 1;
+});
+
+export type SkDomain = number;
+export class DomainType {
+ @ApiProperty({ description: '所属域' })
+ @IsOptional()
+ domain: SkDomain;
+}
diff --git a/src/common/decorators/field.decorator.ts b/src/common/decorators/field.decorator.ts
new file mode 100644
index 0000000..3423135
--- /dev/null
+++ b/src/common/decorators/field.decorator.ts
@@ -0,0 +1,108 @@
+import { applyDecorators } from '@nestjs/common';
+import {
+ IsBoolean,
+ IsDate,
+ IsInt,
+ IsNotEmpty,
+ IsNumber,
+ IsOptional,
+ IsPositive,
+ IsString,
+ Max,
+ MaxLength,
+ Min,
+ MinLength
+} from 'class-validator';
+import { isNumber } from 'lodash';
+
+import {
+ ToArray,
+ ToBoolean,
+ ToDate,
+ ToLowerCase,
+ ToNumber,
+ ToTrim,
+ ToUpperCase
+} from './transform.decorator';
+
+interface IOptionalOptions {
+ required?: boolean;
+}
+
+interface INumberFieldOptions extends IOptionalOptions {
+ each?: boolean;
+ int?: boolean;
+ min?: number;
+ max?: number;
+ positive?: boolean;
+}
+
+interface IStringFieldOptions extends IOptionalOptions {
+ each?: boolean;
+ minLength?: number;
+ maxLength?: number;
+ lowerCase?: boolean;
+ upperCase?: boolean;
+}
+
+export function NumberField(options: INumberFieldOptions = {}): PropertyDecorator {
+ const { each, min, max, int, positive, required = true } = options;
+
+ const decorators = [ToNumber()];
+
+ if (each) decorators.push(ToArray());
+
+ if (int) decorators.push(IsInt({ each }));
+ else decorators.push(IsNumber({}, { each }));
+
+ if (isNumber(min)) decorators.push(Min(min, { each }));
+
+ if (isNumber(max)) decorators.push(Max(max, { each }));
+
+ if (positive) decorators.push(IsPositive({ each }));
+
+ if (!required) decorators.push(IsOptional());
+
+ return applyDecorators(...decorators);
+}
+
+export function StringField(options: IStringFieldOptions = {}): PropertyDecorator {
+ const { each, minLength, maxLength, lowerCase, upperCase, required = true } = options;
+
+ const decorators = [IsString({ each }), ToTrim()];
+
+ if (each) decorators.push(ToArray());
+
+ if (isNumber(minLength)) decorators.push(MinLength(minLength, { each }));
+
+ if (isNumber(maxLength)) decorators.push(MaxLength(maxLength, { each }));
+
+ if (lowerCase) decorators.push(ToLowerCase());
+
+ if (upperCase) decorators.push(ToUpperCase());
+
+ if (!required) decorators.push(IsOptional());
+ else decorators.push(IsNotEmpty({ each }));
+
+ return applyDecorators(...decorators);
+}
+
+export function BooleanField(options: IOptionalOptions = {}): PropertyDecorator {
+ const decorators = [ToBoolean(), IsBoolean()];
+
+ const { required = true } = options;
+
+ if (!required) decorators.push(IsOptional());
+
+ return applyDecorators(...decorators);
+}
+
+export function DateField(options: IOptionalOptions = {}): PropertyDecorator {
+ const decorators = [ToDate(), IsDate()];
+
+ const { required = true } = options;
+
+ if (!required) decorators.push(IsOptional());
+
+ return applyDecorators(...decorators);
+}
diff --git a/src/common/decorators/http.decorator.ts b/src/common/decorators/http.decorator.ts
new file mode 100644
index 0000000..c94d366
--- /dev/null
+++ b/src/common/decorators/http.decorator.ts
@@ -0,0 +1,31 @@
+import type { ExecutionContext } from '@nestjs/common';
+
+import { createParamDecorator } from '@nestjs/common';
+import type { FastifyRequest } from 'fastify';
+
+import { getIp, getIsMobile } from '~/utils/ip.util';
+
+
+/**
+ * 快速获取IP
+ */
+export const IsMobile = createParamDecorator((_, context: ExecutionContext) => {
+ const request = context.switchToHttp().getRequest();
+ return getIsMobile(request);
+});
+
+/**
+ * 快速获取IP
+ */
+export const Ip = createParamDecorator((_, context: ExecutionContext) => {
+ const request = context.switchToHttp().getRequest();
+ return getIp(request);
+});
+
+/**
+ * 快速获取request path，并不包括url params
+ */
+export const Uri = createParamDecorator((_, context: ExecutionContext) => {
+ const request = context.switchToHttp().getRequest();
+ return request.routerPath;
+});
diff --git a/src/common/decorators/id-param.decorator.ts b/src/common/decorators/id-param.decorator.ts
new file mode 100644
index 0000000..eb41a79
--- /dev/null
+++ b/src/common/decorators/id-param.decorator.ts
@@ -0,0 +1,13 @@
+import { HttpStatus, NotAcceptableException, Param, ParseIntPipe } from '@nestjs/common';
+
+export function IdParam() {
+ return Param(
+ 'id',
+ new ParseIntPipe({
+ errorHttpStatusCode: HttpStatus.NOT_ACCEPTABLE,
+ exceptionFactory: _error => {
+ throw new NotAcceptableException('id 格式不正确');
+ }
+ })
+ );
+}
diff --git a/src/common/decorators/idempotence.decorator.ts b/src/common/decorators/idempotence.decorator.ts
new file mode 100644
index 0000000..949b321
--- /dev/null
+++ b/src/common/decorators/idempotence.decorator.ts
@@ -0,0 +1,15 @@
+import { SetMetadata } from '@nestjs/common';
+
+import { IdempotenceOption } from '../interceptors/idempotence.interceptor';
+
+export const HTTP_IDEMPOTENCE_KEY = '__idempotence_key__';
+export const HTTP_IDEMPOTENCE_OPTIONS = '__idempotence_options__';
+
+/**
+ * 幂等
+ */
+export function Idempotence(options?: IdempotenceOption): MethodDecorator {
+ return function (target, key, descriptor: PropertyDescriptor) {
+ SetMetadata(HTTP_IDEMPOTENCE_OPTIONS, options || {})(descriptor.value);
+ };
+}
diff --git a/src/common/decorators/swagger.decorator.ts b/src/common/decorators/swagger.decorator.ts
new file mode 100644
index 0000000..92744d8
--- /dev/null
+++ b/src/common/decorators/swagger.decorator.ts
@@ -0,0 +1,11 @@
+import { applyDecorators } from '@nestjs/common';
+import { ApiSecurity } from '@nestjs/swagger';
+
+export const API_SECURITY_AUTH = 'auth';
+
+/**
+ * like to @ApiSecurity('auth')
+ */
+export function ApiSecurityAuth(): ClassDecorator & MethodDecorator {
+ return applyDecorators(ApiSecurity(API_SECURITY_AUTH));
+}
diff --git a/src/common/decorators/transform.decorator.ts b/src/common/decorators/transform.decorator.ts
new file mode 100644
index 0000000..f69dc98
--- /dev/null
+++ b/src/common/decorators/transform.decorator.ts
@@ -0,0 +1,137 @@
+import { Transform } from 'class-transformer';
+import { castArray, isArray, isNil, trim } from 'lodash';
+
+/**
+ * convert string to number
+ */
+export function ToNumber(): PropertyDecorator {
+ return Transform(
+ params => {
+ const value = params.value as string[] | string;
+
+ if (isArray(value)) return value.map(v => Number(v));
+
+ return Number(value);
+ },
+ { toClassOnly: true }
+ );
+}
+
+/**
+ * convert string to int
+ */
+export function ToInt(): PropertyDecorator {
+ return Transform(
+ params => {
+ const value = params.value as string[] | string;
+
+ if (isArray(value)) return value.map(v => Number.parseInt(v));
+
+ return Number.parseInt(value);
+ },
+ { toClassOnly: true }
+ );
+}
+
+/**
+ * convert string to boolean
+ */
+export function ToBoolean(): PropertyDecorator {
+ return Transform(
+ params => {
+ switch (params.value) {
+ case 'true':
+ return true;
+ case 'false':
+ return false;
+ default:
+ return params.value;
+ }
+ },
+ { toClassOnly: true }
+ );
+}
+
+/**
+ * convert string to Date
+ */
+export function ToDate(): PropertyDecorator {
+ return Transform(
+ params => {
+ const { value } = params;
+
+ if (!value) return;
+
+ return new Date(value);
+ },
+ { toClassOnly: true }
+ );
+}
+
+/**
+ * transforms to array, specially for query params
+ */
+export function ToArray(): PropertyDecorator {
+ return Transform(
+ params => {
+ const { value } = params;
+
+ if (isNil(value)) return [];
+
+ return castArray(value);
+ },
+ { toClassOnly: true }
+ );
+}
+
+/**
+ * trim spaces from start and end, replace multiple spaces with one.
+ */
+export function ToTrim(): PropertyDecorator {
+ return Transform(
+ params => {
+ const value = params.value as string[] | string;
+
+ if (isArray(value)) return value.map(v => trim(v));
+
+ return trim(value);
+ },
+ { toClassOnly: true }
+ );
+}
+
+/**
+ * lowercase value
+ */
+export function ToLowerCase(): PropertyDecorator {
+ return Transform(
+ params => {
+ const value = params.value as string[] | string;
+
+ if (!value) return;
+
+ if (isArray(value)) return value.map(v => v.toLowerCase());
+
+ return value.toLowerCase();
+ },
+ { toClassOnly: true }
+ );
+}
+
+/**
+ * uppercase value
+ */
+export function ToUpperCase(): PropertyDecorator {
+ return Transform(
+ params => {
+ const value = params.value as string[] | string;
+
+ if (!value) return;
+
+ if (isArray(value)) return value.map(v => v.toUpperCase());
+
+ return value.toUpperCase();
+ },
+ { toClassOnly: true }
+ );
+}
diff --git a/src/common/dto/cursor.dto.ts b/src/common/dto/cursor.dto.ts
new file mode 100644
index 0000000..b3b0305
--- /dev/null
+++ b/src/common/dto/cursor.dto.ts
@@ -0,0 +1,26 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Expose, Transform } from 'class-transformer';
+import { IsInt, IsOptional, Max, Min } from 'class-validator';
+
+export class CursorDto {
+ @ApiProperty({ minimum: 0, default: 0 })
+ @Min(0)
+ @IsInt()
+ @Expose()
+ @IsOptional({ always: true })
+ @Transform(({ value: val }) => (val ? Number.parseInt(val) : 0), {
+ toClassOnly: true
+ })
+ cursor?: number;
+
+ @ApiProperty({ minimum: 1, maximum: 100, default: 10 })
+ @Min(1)
+ @Max(100)
+ @IsInt()
+ @IsOptional({ always: true })
+ @Expose()
+ @Transform(({ value: val }) => (val ? Number.parseInt(val) : 10), {
+ toClassOnly: true
+ })
+ limit?: number;
+}
diff --git a/src/common/dto/delete.dto.ts b/src/common/dto/delete.dto.ts
new file mode 100644
index 0000000..6f87b9e
--- /dev/null
+++ b/src/common/dto/delete.dto.ts
@@ -0,0 +1,8 @@
+import { IsDefined, IsNotEmpty, IsNumber } from 'class-validator';
+
+export class BatchDeleteDto {
+ @IsDefined()
+ @IsNotEmpty()
+ @IsNumber({}, { each: true })
+ ids: number[];
+}
diff --git a/src/common/dto/id.dto.ts b/src/common/dto/id.dto.ts
new file mode 100644
index 0000000..271bece
--- /dev/null
+++ b/src/common/dto/id.dto.ts
@@ -0,0 +1,6 @@
+import { IsNumber } from 'class-validator';
+
+export class IdDto {
+ @IsNumber()
+ id: number;
+}
diff --git a/src/common/dto/pager.dto.ts b/src/common/dto/pager.dto.ts
new file mode 100644
index 0000000..11f9348
--- /dev/null
+++ b/src/common/dto/pager.dto.ts
@@ -0,0 +1,45 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Expose, Transform } from 'class-transformer';
+import { Allow, IsEnum, IsInt, IsOptional, IsString, Max, Min } from 'class-validator';
+
+export enum Order {
+ ASC = 'ASC',
+ DESC = 'DESC'
+}
+
+export class PagerDto {
+ @ApiProperty({ minimum: 1, default: 1 })
+ @Min(1)
+ @IsInt()
+ @Expose()
+ @IsOptional({ always: true })
+ @Transform(({ value: val }) => (val ? Number.parseInt(val) : 1), {
+ toClassOnly: true
+ })
+ page?: number;
+
+ @ApiProperty({ minimum: 1, maximum: 100, default: 10 })
+ @Min(1)
+ @Max(100)
+ @IsInt()
+ @IsOptional({ always: true })
+ @Expose()
+ @Transform(({ value: val }) => (val ? Number.parseInt(val) : 10), {
+ toClassOnly: true
+ })
+ pageSize?: number;
+
+ @ApiProperty()
+ @IsString()
+ @IsOptional()
+ field?: string; // | keyof T
+
+ @ApiProperty({ enum: Order })
+ @IsEnum(Order)
+ @IsOptional()
+ @Transform(({ value }) => (value === 'asc' ? Order.ASC : Order.DESC))
+ order?: Order;
+
+ @Allow()
+ _t?: number;
+}
diff --git a/src/common/entity/common.entity.ts b/src/common/entity/common.entity.ts
new file mode 100644
index 0000000..1c9ad3f
--- /dev/null
+++ b/src/common/entity/common.entity.ts
@@ -0,0 +1,56 @@
+import { ApiHideProperty, ApiProperty } from '@nestjs/swagger';
+import { Exclude } from 'class-transformer';
+import {
+ BaseEntity,
+ Column,
+ CreateDateColumn,
+ PrimaryGeneratedColumn,
+ UpdateDateColumn,
+ VirtualColumn
+} from 'typeorm';
+
+// 如果觉得前端转换时间太麻烦，并且不考虑通用性的话，可以在服务端进行转换，eg: @UpdateDateColumn({ name: 'updated_at', transformer })
+// const transformer: ValueTransformer = {
+// to(value) {
+// return value
+// },
+// from(value) {
+// return dayjs(value).format('YYYY-MM-DD HH:mm:ss')
+// },
+// }
+
+export abstract class CommonEntity extends BaseEntity {
+ @PrimaryGeneratedColumn()
+ id: number;
+
+ @CreateDateColumn({ name: 'created_at' })
+ createdAt: Date;
+
+ @UpdateDateColumn({ name: 'updated_at' })
+ updatedAt: Date;
+
+}
+
+export abstract class CompleteEntity extends CommonEntity {
+ @ApiHideProperty()
+ @Exclude()
+ @Column({ name: 'create_by', update: false, comment: '创建者' })
+ createBy: number;
+
+ @ApiHideProperty()
+ @Exclude()
+ @Column({ name: 'update_by', comment: '更新者' })
+ updateBy: number;
+
+ /**
+ * 不会保存到数据库中的虚拟列，数据量大时可能会有性能问题，有性能要求请考虑在 service 层手动实现
+ * @see https://typeorm.io/decorator-reference#virtualcolumn
+ */
+ @ApiProperty({ description: '创建者' })
+ @VirtualColumn({ query: alias => `SELECT username FROM sys_user WHERE id = ${alias}.create_by` })
+ creator: string;
+
+ @ApiProperty({ description: '更新者' })
+ @VirtualColumn({ query: alias => `SELECT username FROM sys_user WHERE id = ${alias}.update_by` })
+ updater: string;
+}
diff --git a/src/common/exceptions/biz.exception.ts b/src/common/exceptions/biz.exception.ts
new file mode 100644
index 0000000..7b00f13
--- /dev/null
+++ b/src/common/exceptions/biz.exception.ts
@@ -0,0 +1,40 @@
+import { HttpException, HttpStatus } from '@nestjs/common';
+
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { RESPONSE_SUCCESS_CODE } from '~/constants/response.constant';
+
+export class BusinessException extends HttpException {
+ private errorCode: number;
+
+ constructor(error: ErrorEnum | string) {
+ // 如果是非 ErrorEnum
+ if (!error.includes(':')) {
+ super(
+ HttpException.createBody({
+ code: RESPONSE_SUCCESS_CODE,
+ message: error
+ }),
+ HttpStatus.OK
+ );
+ this.errorCode = RESPONSE_SUCCESS_CODE;
+ return;
+ }
+
+ const [code, message] = error.split(':');
+ super(
+ HttpException.createBody({
+ code,
+ message
+ }),
+ HttpStatus.BAD_REQUEST
+ );
+
+ this.errorCode = Number(code);
+ }
+
+ getErrorCode(): number {
+ return this.errorCode;
+ }
+}
+
+export { BusinessException as BizException };
diff --git a/src/common/exceptions/not-found.exception.ts b/src/common/exceptions/not-found.exception.ts
new file mode 100644
index 0000000..95b034d
--- /dev/null
+++ b/src/common/exceptions/not-found.exception.ts
@@ -0,0 +1,10 @@
+import { NotFoundException } from '@nestjs/common';
+import { sample } from 'lodash';
+
+export const NotFoundMessage = ['404, Not Found'];
+
+export class CannotFindException extends NotFoundException {
+ constructor() {
+ super(sample(NotFoundMessage));
+ }
+}
diff --git a/src/common/exceptions/socket.exception.ts b/src/common/exceptions/socket.exception.ts
new file mode 100644
index 0000000..ca0cde3
--- /dev/null
+++ b/src/common/exceptions/socket.exception.ts
@@ -0,0 +1,38 @@
+import { HttpException } from '@nestjs/common';
+import { WsException } from '@nestjs/websockets';
+
+import { ErrorEnum } from '~/constants/error-code.constant';
+
+export class SocketException extends WsException {
+ private errorCode: number;
+
+ constructor(message: string);
+ constructor(error: ErrorEnum);
+ constructor(...args: any) {
+ const error = args[0];
+ if (typeof error === 'string') {
+ super(
+ HttpException.createBody({
+ code: 0,
+ message: error
+ })
+ );
+ this.errorCode = 0;
+ return;
+ }
+
+ const [code, message] = error.split(':');
+ super(
+ HttpException.createBody({
+ code,
+ message
+ })
+ );
+
+ this.errorCode = Number(code);
+ }
+
+ getErrorCode(): number {
+ return this.errorCode;
+ }
+}
diff --git a/src/common/filters/any-exception.filter.ts b/src/common/filters/any-exception.filter.ts
new file mode 100644
index 0000000..aee7fd5
--- /dev/null
+++ b/src/common/filters/any-exception.filter.ts
@@ -0,0 +1,80 @@
+import {
+ ArgumentsHost,
+ Catch,
+ ExceptionFilter,
+ HttpException,
+ HttpStatus,
+ Logger
+} from '@nestjs/common';
+import { FastifyReply, FastifyRequest } from 'fastify';
+
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+
+import { isDev } from '~/global/env';
+
+interface myError {
+ readonly status: number;
+ readonly statusCode?: number;
+
+ readonly message?: string;
+}
+
+@Catch()
+export class AllExceptionsFilter implements ExceptionFilter {
+ private readonly logger = new Logger(AllExceptionsFilter.name);
+
+ constructor() {
+ this.registerCatchAllExceptionsHook();
+ }
+
+ catch(exception: unknown, host: ArgumentsHost) {
+ const ctx = host.switchToHttp();
+ const request = ctx.getRequest();
+ const response = ctx.getResponse();
+
+ const url = request.raw.url!;
+
+ const status =
+ exception instanceof HttpException
+ ? exception.getStatus()
+ : (exception as myError)?.status ||
+ (exception as myError)?.statusCode ||
+ HttpStatus.INTERNAL_SERVER_ERROR;
+
+ let message =
+ (exception as any)?.response?.message || (exception as myError)?.message || `${exception}`;
+
+ // 系统内部错误时
+ if (status === HttpStatus.INTERNAL_SERVER_ERROR && !(exception instanceof BusinessException)) {
+ Logger.error(exception, undefined, 'Catch');
+
+ // 生产环境下隐藏错误信息
+ if (!isDev) message = ErrorEnum.SERVER_ERROR?.split(':')[1];
+ } else {
+ this.logger.warn(`错误信息：(${status}) ${message} Path: ${decodeURI(url)}`);
+ }
+
+ const apiErrorCode: number =
+ exception instanceof BusinessException ? exception.getErrorCode() : status;
+
+ // 返回基础响应结果
+ const resBody: IBaseResponse = {
+ code: apiErrorCode,
+ message,
+ data: null
+ };
+
+ response.status(status).send(resBody);
+ }
+
+ registerCatchAllExceptionsHook() {
+ process.on('unhandledRejection', reason => {
+ console.error('unhandledRejection: ', reason);
+ });
+
+ process.on('uncaughtException', err => {
+ console.error('uncaughtException: ', err);
+ });
+ }
+}
diff --git a/src/common/interceptors/idempotence.interceptor.ts b/src/common/interceptors/idempotence.interceptor.ts
new file mode 100644
index 0000000..0569aa6
--- /dev/null
+++ b/src/common/interceptors/idempotence.interceptor.ts
@@ -0,0 +1,134 @@
+import type { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
+
+import { ConflictException, Injectable, SetMetadata } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import type { FastifyRequest } from 'fastify';
+import { catchError, tap } from 'rxjs';
+
+import { CacheService } from '~/shared/redis/cache.service';
+import { hashString } from '~/utils';
+import { getIp } from '~/utils/ip.util';
+import { getRedisKey } from '~/utils/redis.util';
+
+import {
+ HTTP_IDEMPOTENCE_KEY,
+ HTTP_IDEMPOTENCE_OPTIONS
+} from '../decorators/idempotence.decorator';
+
+const IdempotenceHeaderKey = 'x-idempotence';
+
+export interface IdempotenceOption {
+ errorMessage?: string;
+ pendingMessage?: string;
+
+ /**
+ * 如果重复请求的话，手动处理异常
+ */
+ handler?: (req: FastifyRequest) => any;
+
+ /**
+ * 记录重复请求的时间
+ * @default 60
+ */
+ expired?: number;
+
+ /**
+ * 如果 header 没有幂等 key，根据 request 生成 key，如何生成这个 key 的方法
+ */
+ generateKey?: (req: FastifyRequest) => string;
+
+ /**
+ * 仅读取 header 的 key，不自动生成
+ * @default false
+ */
+ disableGenerateKey?: boolean;
+}
+
+@Injectable()
+export class IdempotenceInterceptor implements NestInterceptor {
+ constructor(
+ private readonly reflector: Reflector,
+ private readonly cacheService: CacheService
+ ) {}
+
+ async intercept(context: ExecutionContext, next: CallHandler) {
+ const request = context.switchToHttp().getRequest();
+
+ // skip Get 请求
+ if (request.method.toUpperCase() === 'GET') return next.handle();
+
+ const handler = context.getHandler();
+ const options: IdempotenceOption | undefined = this.reflector.get(
+ HTTP_IDEMPOTENCE_OPTIONS,
+ handler
+ );
+
+ if (!options) return next.handle();
+
+ const {
+ errorMessage = '相同请求成功后在 60 秒内只能发送一次',
+ pendingMessage = '相同请求正在处理中...',
+ handler: errorHandler,
+ expired = 60,
+ disableGenerateKey = false
+ } = options;
+ const redis = this.cacheService.getClient();
+
+ const idempotence = request.headers[IdempotenceHeaderKey] as string;
+ const key = disableGenerateKey
+ ? undefined
+ : options.generateKey
+ ? options.generateKey(request)
+ : this.generateKey(request);
+
+ const idempotenceKey =
+ !!(idempotence || key) && getRedisKey(`idempotence:${idempotence || key}`);
+
+ SetMetadata(HTTP_IDEMPOTENCE_KEY, idempotenceKey)(handler);
+
+ if (idempotenceKey) {
+ const resultValue: '0' | '1' | null = (await redis.get(idempotenceKey)) as any;
+ if (resultValue !== null) {
+ if (errorHandler) return await errorHandler(request);
+
+ const message = {
+ 1: errorMessage,
+ 0: pendingMessage
+ }[resultValue];
+ throw new ConflictException(message);
+ } else {
+ await redis.set(idempotenceKey, '0', 'EX', expired);
+ }
+ }
+ return next.handle().pipe(
+ tap(async () => {
+ idempotenceKey && (await redis.set(idempotenceKey, '1', 'KEEPTTL'));
+ }),
+ catchError(async err => {
+ if (idempotenceKey) await redis.del(idempotenceKey);
+
+ throw err;
+ })
+ );
+ }
+
+ private generateKey(req: FastifyRequest) {
+ const { body, params, query = {}, headers, url } = req;
+
+ const obj = { body, url, params, query } as any;
+
+ const uuid = headers['x-uuid'];
+ if (uuid) {
+ obj.uuid = uuid;
+ } else {
+ const ua = headers['user-agent'];
+ const ip = getIp(req);
+
+ if (!ua && !ip) return undefined;
+
+ Object.assign(obj, { ua, ip });
+ }
+
+ return hashString(JSON.stringify(obj));
+ }
+}
diff --git a/src/common/interceptors/logging.interceptor.ts b/src/common/interceptors/logging.interceptor.ts
new file mode 100644
index 0000000..d9595f7
--- /dev/null
+++ b/src/common/interceptors/logging.interceptor.ts
@@ -0,0 +1,24 @@
+import { CallHandler, ExecutionContext, Injectable, Logger, NestInterceptor } from '@nestjs/common';
+import { Observable, tap } from 'rxjs';
+
+@Injectable()
+export class LoggingInterceptor implements NestInterceptor {
+ private logger = new Logger(LoggingInterceptor.name, { timestamp: false });
+
+ intercept(context: ExecutionContext, next: CallHandler): Observable {
+ const call$ = next.handle();
+ const request = context.switchToHttp().getRequest();
+ const content = `${request.method} -> ${request.url}`;
+ const isSse = request.headers.accept === 'text/event-stream';
+ this.logger.debug(`+++ 请求：${content}`);
+ const now = Date.now();
+
+ return call$.pipe(
+ tap(() => {
+ if (isSse) return;
+
+ this.logger.debug(`--- 响应：${content}${` +${Date.now() - now}ms`}`);
+ })
+ );
+ }
+}
diff --git a/src/common/interceptors/timeout.interceptor.ts b/src/common/interceptors/timeout.interceptor.ts
new file mode 100644
index 0000000..7a1382b
--- /dev/null
+++ b/src/common/interceptors/timeout.interceptor.ts
@@ -0,0 +1,25 @@
+import {
+ CallHandler,
+ ExecutionContext,
+ Injectable,
+ NestInterceptor,
+ RequestTimeoutException
+} from '@nestjs/common';
+import { Observable, TimeoutError, throwError } from 'rxjs';
+import { catchError, timeout } from 'rxjs/operators';
+
+@Injectable()
+export class TimeoutInterceptor implements NestInterceptor {
+ constructor(private readonly time: number = 10000) {}
+
+ intercept(context: ExecutionContext, next: CallHandler): Observable {
+ return next.handle().pipe(
+ timeout(this.time),
+ catchError(err => {
+ if (err instanceof TimeoutError) return throwError(new RequestTimeoutException('请求超时'));
+
+ return throwError(err);
+ })
+ );
+ }
+}
diff --git a/src/common/interceptors/transform.interceptor.ts b/src/common/interceptors/transform.interceptor.ts
new file mode 100644
index 0000000..f52f8b9
--- /dev/null
+++ b/src/common/interceptors/transform.interceptor.ts
@@ -0,0 +1,39 @@
+import {
+ CallHandler,
+ ExecutionContext,
+ HttpStatus,
+ Injectable,
+ NestInterceptor
+} from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+
+import { ResOp } from '~/common/model/response.model';
+
+import { BYPASS_KEY } from '../decorators/bypass.decorator';
+
+/**
+ * 统一处理返回接口结果，如果不需要则添加 @Bypass 装饰器
+ */
+@Injectable()
+export class TransformInterceptor implements NestInterceptor {
+ constructor(private readonly reflector: Reflector) {}
+
+ intercept(context: ExecutionContext, next: CallHandler): Observable {
+ const bypass = this.reflector.get(BYPASS_KEY, context.getHandler());
+
+ if (bypass) return next.handle();
+
+ return next.handle().pipe(
+ map(data => {
+ // if (typeof data === 'undefined') {
+ // context.switchToHttp().getResponse().status(HttpStatus.NO_CONTENT);
+ // return data;
+ // }
+
+ return new ResOp(HttpStatus.OK, data ?? null);
+ })
+ );
+ }
+}
diff --git a/src/common/model/response.model.ts b/src/common/model/response.model.ts
new file mode 100644
index 0000000..b3f6330
--- /dev/null
+++ b/src/common/model/response.model.ts
@@ -0,0 +1,39 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+import { RESPONSE_SUCCESS_CODE, RESPONSE_SUCCESS_MSG } from '~/constants/response.constant';
+
+export class ResOp {
+ @ApiProperty({ type: 'object' })
+ data?: T;
+
+ @ApiProperty({ type: 'number', default: RESPONSE_SUCCESS_CODE })
+ code: number;
+
+ @ApiProperty({ type: 'string', default: RESPONSE_SUCCESS_MSG })
+ message: string;
+
+ constructor(code: number, data: T, message = RESPONSE_SUCCESS_MSG) {
+ this.code = code;
+ this.data = data;
+ this.message = message;
+ }
+
+ static success(data?: T, message?: string) {
+ return new ResOp(RESPONSE_SUCCESS_CODE, data, message);
+ }
+
+ static error(code: number, message) {
+ return new ResOp(code, {}, message);
+ }
+}
+
+export class TreeResult {
+ @ApiProperty()
+ id: number;
+
+ @ApiProperty()
+ parentId: number;
+
+ @ApiProperty()
+ children?: TreeResult[];
+}
diff --git a/src/common/pipes/parse-int.pipe.ts b/src/common/pipes/parse-int.pipe.ts
new file mode 100644
index 0000000..c6d7227
--- /dev/null
+++ b/src/common/pipes/parse-int.pipe.ts
@@ -0,0 +1,12 @@
+import { ArgumentMetadata, BadRequestException, Injectable, PipeTransform } from '@nestjs/common';
+
+@Injectable()
+export class ParseIntPipe implements PipeTransform {
+ transform(value: string, metadata: ArgumentMetadata): number {
+ const val = Number.parseInt(value, 10);
+
+ if (Number.isNaN(val)) throw new BadRequestException('id validation failed');
+
+ return val;
+ }
+}
diff --git a/src/config/app.config.ts b/src/config/app.config.ts
new file mode 100644
index 0000000..079e0ce
--- /dev/null
+++ b/src/config/app.config.ts
@@ -0,0 +1,20 @@
+import { ConfigType, registerAs } from '@nestjs/config';
+
+import { env, envNumber } from '~/global/env';
+
+export const appRegToken = 'app';
+
+export const AppConfig = registerAs(appRegToken, () => ({
+ name: env('APP_NAME'),
+ port: envNumber('APP_PORT', 3000),
+ baseUrl: env('APP_BASE_URL'),
+ globalPrefix: env('GLOBAL_PREFIX', 'api'),
+ locale: env('APP_LOCALE', 'zh-CN'),
+
+ logger: {
+ level: env('LOGGER_LEVEL'),
+ maxFiles: envNumber('LOGGER_MAX_FILES')
+ }
+}));
+
+export type IAppConfig = ConfigType;
diff --git a/src/config/database.config.ts b/src/config/database.config.ts
new file mode 100644
index 0000000..02df861
--- /dev/null
+++ b/src/config/database.config.ts
@@ -0,0 +1,37 @@
+import { ConfigType, registerAs } from '@nestjs/config';
+
+import { DataSource, DataSourceOptions } from 'typeorm';
+
+import { env, envBoolean, envNumber } from '~/global/env';
+
+// eslint-disable-next-line import/order
+import dotenv from 'dotenv';
+
+dotenv.config({ path: `.env.${process.env.NODE_ENV}` });
+
+// 当前通过 npm scripts 执行的命令
+const currentScript = process.env.npm_lifecycle_event;
+
+const dataSourceOptions: DataSourceOptions = {
+ type: 'mysql',
+ host: env('DB_HOST', '127.0.0.1'),
+ port: envNumber('DB_PORT', 3306),
+ username: env('DB_USERNAME'),
+ password: env('DB_PASSWORD'),
+ database: env('DB_DATABASE'),
+ synchronize: envBoolean('DB_SYNCHRONIZE', false),
+ // 解决通过 pnpm migration:run 初始化数据时，遇到的 SET FOREIGN_KEY_CHECKS = 0; 等语句报错问题, 仅在执行数据迁移操作时设为 true
+ multipleStatements: currentScript === 'typeorm',
+ entities: ['dist/modules/**/*.entity{.ts,.js}'],
+ migrations: ['dist/migrations/*{.ts,.js}'],
+ subscribers: ['dist/modules/**/*.subscriber{.ts,.js}']
+};
+export const dbRegToken = 'database';
+
+export const DatabaseConfig = registerAs(dbRegToken, (): DataSourceOptions => dataSourceOptions);
+
+export type IDatabaseConfig = ConfigType;
+
+const dataSource = new DataSource(dataSourceOptions);
+
+export default dataSource;
diff --git a/src/config/index.ts b/src/config/index.ts
new file mode 100644
index 0000000..57bae35
--- /dev/null
+++ b/src/config/index.ts
@@ -0,0 +1,37 @@
+import { AppConfig, IAppConfig, appRegToken } from './app.config';
+import { DatabaseConfig, IDatabaseConfig, dbRegToken } from './database.config';
+import { IMailerConfig, MailerConfig, mailerRegToken } from './mailer.config';
+import { IOssConfig, OssConfig, ossRegToken } from './oss.config';
+import { IRedisConfig, RedisConfig, redisRegToken } from './redis.config';
+import { ISecurityConfig, SecurityConfig, securityRegToken } from './security.config';
+import { ISwaggerConfig, SwaggerConfig, swaggerRegToken } from './swagger.config';
+
+export * from './app.config';
+export * from './redis.config';
+export * from './database.config';
+export * from './swagger.config';
+export * from './security.config';
+export * from './mailer.config';
+export * from './oss.config';
+
+export interface AllConfigType {
+ [appRegToken]: IAppConfig;
+ [dbRegToken]: IDatabaseConfig;
+ [mailerRegToken]: IMailerConfig;
+ [redisRegToken]: IRedisConfig;
+ [securityRegToken]: ISecurityConfig;
+ [swaggerRegToken]: ISwaggerConfig;
+ [ossRegToken]: IOssConfig;
+}
+
+export type ConfigKeyPaths = RecordNamePaths;
+
+export default {
+ AppConfig,
+ DatabaseConfig,
+ MailerConfig,
+ OssConfig,
+ RedisConfig,
+ SecurityConfig,
+ SwaggerConfig
+};
diff --git a/src/config/mailer.config.ts b/src/config/mailer.config.ts
new file mode 100644
index 0000000..6e17271
--- /dev/null
+++ b/src/config/mailer.config.ts
@@ -0,0 +1,18 @@
+import { ConfigType, registerAs } from '@nestjs/config';
+
+import { env, envNumber } from '~/global/env';
+
+export const mailerRegToken = 'mailer';
+
+export const MailerConfig = registerAs(mailerRegToken, () => ({
+ host: env('SMTP_HOST'),
+ port: envNumber('SMTP_PORT'),
+ ignoreTLS: true,
+ secure: true,
+ auth: {
+ user: env('SMTP_USER'),
+ pass: env('SMTP_PASS')
+ }
+}));
+
+export type IMailerConfig = ConfigType;
diff --git a/src/config/oss.config.ts b/src/config/oss.config.ts
new file mode 100644
index 0000000..42f46c0
--- /dev/null
+++ b/src/config/oss.config.ts
@@ -0,0 +1,34 @@
+import { ConfigType, registerAs } from '@nestjs/config';
+import * as qiniu from 'qiniu';
+
+import { env, envBoolean, envNumber } from '~/global/env';
+
+function parseZone(zone: string) {
+ switch (zone) {
+ case 'Zone_as0':
+ return qiniu.zone.Zone_as0;
+ case 'Zone_na0':
+ return qiniu.zone.Zone_na0;
+ case 'Zone_z0':
+ return qiniu.zone.Zone_z0;
+ case 'Zone_z1':
+ return qiniu.zone.Zone_z1;
+ case 'Zone_z2':
+ return qiniu.zone.Zone_z2;
+ }
+}
+
+export const ossRegToken = 'oss';
+
+export const OssConfig = registerAs(ossRegToken, () => ({
+ accessKey: env('OSS_ACCESSKEY'),
+ secretKey: env('OSS_SECRETKEY'),
+ domain: env('OSS_DOMAIN'),
+ port: envNumber('OSS_PORT'),
+ useSSL: envBoolean('OSS_USE_SSL'),
+ bucket: env('OSS_BUCKET'),
+ zone: parseZone(env('OSS_ZONE') || 'Zone_z2'),
+ access: (env('OSS_ACCESS_TYPE') as any) || 'public'
+}));
+
+export type IOssConfig = ConfigType;
diff --git a/src/config/redis.config.ts b/src/config/redis.config.ts
new file mode 100644
index 0000000..3260bc4
--- /dev/null
+++ b/src/config/redis.config.ts
@@ -0,0 +1,14 @@
+import { ConfigType, registerAs } from '@nestjs/config';
+
+import { env, envNumber } from '~/global/env';
+
+export const redisRegToken = 'redis';
+
+export const RedisConfig = registerAs(redisRegToken, () => ({
+ host: env('REDIS_HOST', '127.0.0.1'),
+ port: envNumber('REDIS_PORT', 6379),
+ password: env('REDIS_PASSWORD'),
+ db: envNumber('REDIS_DB')
+}));
+
+export type IRedisConfig = ConfigType;
diff --git a/src/config/security.config.ts b/src/config/security.config.ts
new file mode 100644
index 0000000..fb2f1b1
--- /dev/null
+++ b/src/config/security.config.ts
@@ -0,0 +1,14 @@
+import { ConfigType, registerAs } from '@nestjs/config';
+
+import { env, envNumber } from '~/global/env';
+
+export const securityRegToken = 'security';
+
+export const SecurityConfig = registerAs(securityRegToken, () => ({
+ jwtSecret: env('JWT_SECRET'),
+ jwtExprire: envNumber('JWT_EXPIRE'),
+ refreshSecret: env('REFRESH_TOKEN_SECRET'),
+ refreshExpire: envNumber('REFRESH_TOKEN_EXPIRE')
+}));
+
+export type ISecurityConfig = ConfigType;
diff --git a/src/config/swagger.config.ts b/src/config/swagger.config.ts
new file mode 100644
index 0000000..efbbb1a
--- /dev/null
+++ b/src/config/swagger.config.ts
@@ -0,0 +1,12 @@
+import { ConfigType, registerAs } from '@nestjs/config';
+
+import { env, envBoolean } from '~/global/env';
+
+export const swaggerRegToken = 'swagger';
+
+export const SwaggerConfig = registerAs(swaggerRegToken, () => ({
+ enable: envBoolean('SWAGGER_ENABLE'),
+ path: env('SWAGGER_PATH')
+}));
+
+export type ISwaggerConfig = ConfigType;
diff --git a/src/constants/cache.constant.ts b/src/constants/cache.constant.ts
new file mode 100644
index 0000000..858bf7f
--- /dev/null
+++ b/src/constants/cache.constant.ts
@@ -0,0 +1,8 @@
+export enum RedisKeys {
+ AccessIp = 'access_ip',
+ CAPTCHA_IMG_PREFIX = 'captcha:img:',
+ AUTH_TOKEN_PREFIX = 'auth:token:',
+ AUTH_PERM_PREFIX = 'auth:permission:',
+ AUTH_PASSWORD_V_PREFIX = 'auth:passwordVersion:'
+}
+export const API_CACHE_PREFIX = 'api-cache:';
diff --git a/src/constants/enum/index.ts b/src/constants/enum/index.ts
new file mode 100644
index 0000000..f150c1c
--- /dev/null
+++ b/src/constants/enum/index.ts
@@ -0,0 +1,48 @@
+// 字典项status
+export enum DictTypeStatusEnum {
+ /** 启用 */
+ ENABLE = 1,
+ /** 禁用 */
+ DISABLE = 0
+}
+
+// 业务模块枚举
+export enum BusinessModuleEnum {
+ CONTRACT = 1,
+ MATERIALS_INVENTORY = 2,
+ COMPANY = 3
+}
+
+// 原材料出库或者入库
+export enum MaterialsInOrOutEnum {
+ In,
+ Out
+}
+
+// 系统参数key
+export enum ParamConfigEnum {
+ InventoryNumberPrefix = 'inventory_number_prefix',
+ InventoryInOutNumberPrefixIn = 'inventory_inout_number_prefix_in',
+ InventoryInOutNumberPrefixOut = 'inventory_inout_number_prefix_out',
+ ProductNumberPrefix = 'product_number_prefix'
+}
+
+// 合同审核状态
+export enum ContractStatusEnum {
+ Pending = 0, // 待审核
+ Approved = 1, // 已通过
+ Rejected = 2 // 已拒绝
+}
+
+// 库存查询剩余咋黄台
+export enum HasInventoryStatusEnum {
+ All = 0, // 全部
+ Yes = 1, // 有库存
+ No = 2 // 无库存
+}
+
+// 权限资源设备类型
+export enum ResourceDeviceEnum {
+ APP = 0,
+ PC = 1
+}
diff --git a/src/constants/error-code.constant.ts b/src/constants/error-code.constant.ts
new file mode 100644
index 0000000..61b5117
--- /dev/null
+++ b/src/constants/error-code.constant.ts
@@ -0,0 +1,72 @@
+export enum ErrorEnum {
+ DEFAULT = '0:未知错误',
+ SERVER_ERROR = '500:服务繁忙，请稍后再试',
+
+ SYSTEM_USER_EXISTS = '1001:系统用户已存在',
+ INVALID_VERIFICATION_CODE = '1002:验证码填写有误',
+ INVALID_USERNAME_PASSWORD = '1003:用户名密码有误',
+ NODE_ROUTE_EXISTS = '1004:节点路由已存在',
+ PERMISSION_REQUIRES_PARENT = '1005:权限必须包含父节点',
+ ILLEGAL_OPERATION_DIRECTORY_PARENT = '1006:非法操作：该节点仅支持目录类型父节点',
+ ILLEGAL_OPERATION_CANNOT_CONVERT_NODE_TYPE = '1007:非法操作：节点类型无法直接转换',
+ ROLE_HAS_ASSOCIATED_USERS = '1008:该角色存在关联用户，请先删除关联用户',
+ DEPARTMENT_HAS_ASSOCIATED_USERS = '1009:该部门存在关联用户，请先删除关联用户',
+ DEPARTMENT_HAS_ASSOCIATED_ROLES = '1010:该部门存在关联角色，请先删除关联角色',
+ PASSWORD_MISMATCH = '1011:旧密码与原密码不一致',
+ LOGOUT_OWN_SESSION = '1012:如想下线自身可右上角退出',
+ NOT_ALLOWED_TO_LOGOUT_USER = '1013:不允许下线该用户',
+ PARENT_MENU_NOT_FOUND = '1014:父级菜单不存在',
+ DEPARTMENT_HAS_CHILD_DEPARTMENTS = '1015:该部门存在子部门，请先删除子部门',
+ SYSTEM_BUILTIN_FUNCTION_NOT_ALLOWED = '1016:系统内置功能不允许操作',
+ USER_NOT_FOUND = '1017:用户不存在',
+ UNABLE_TO_FIND_DEPARTMENT_FOR_USER = '1018:无法查找当前用户所属部门',
+ DEPARTMENT_NOT_FOUND = '1019:部门不存在',
+ DICT_NAME_EXISTS = '1020: 已存在相同名称的字典',
+ PARAMETER_CONFIG_KEY_EXISTS = '1021:参数配置键值对已存在',
+ DEFAULT_ROLE_NOT_FOUND = '1022:所分配的默认角色不存在',
+
+ INVALID_LOGIN = '1101:登录无效，请重新登录',
+ NO_PERMISSION = '1102:无权限访问',
+ ONLY_ADMIN_CAN_LOGIN = '1103:不是管理员，无法登录',
+ REQUEST_INVALIDATED = '1104:当前请求已失效',
+ ACCOUNT_LOGGED_IN_ELSEWHERE = '1105:您的账号已在其他地方登录',
+ GUEST_ACCOUNT_RESTRICTED_OPERATION = '1106:游客账号不允许操作',
+ REQUESTED_RESOURCE_NOT_FOUND = '1107:所请求的资源不存在',
+
+ TOO_MANY_REQUESTS = '1201:请求频率过快，请一分钟后再试',
+ MAXIMUM_FIVE_VERIFICATION_CODES_PER_DAY = '1202:一天最多发送5条验证码',
+ VERIFICATION_CODE_SEND_FAILED = '1203:验证码发送失败',
+
+ INSECURE_MISSION = '1301:不安全的任务，确保执行的加入@Mission注解',
+ EXECUTED_MISSION_NOT_FOUND = '1302:所执行的任务不存在',
+ MISSION_EXECUTION_FAILED = '1303:任务执行失败',
+ MISSION_NOT_FOUND = '1304:任务不存在',
+
+ // OSS相关
+ OSS_FILE_OR_DIR_EXIST = '1401:当前创建的文件或目录已存在',
+ OSS_NO_OPERATION_REQUIRED = '1402:无需操作',
+ OSS_EXCEE_MAXIMUM_QUANTITY = '1403:已超出支持的最大处理数量',
+
+ // Storage相关
+ STORAGE_NOT_FOUND = '1404:文件不存在,请重试',
+ STORAGE_REFRENCE_EXISTS = '1405:文件存在关联,无法删除,请先找到该文件关联的业务解除关联。',
+
+ // Product
+ PRODUCT_EXIST = '1406:产品已存在',
+
+ // Contract
+ CONTRACT_NUMBER_EXIST = '1407:存在相同的合同编号',
+
+ // Inventory
+ INVENTORY_INSUFFICIENT = '1408:库存数量不足。请检查库存或重新操作',
+ MATERIALS_IN_OUT_NOT_FOUND = '1409:出入库信息不存在',
+ MATERIALS_IN_OUT_UNIT_PRICE_CANNOT_BE_MODIFIED = '1410:该价格的产品已经出库，单价不允许修改。若有疑问，请联系管理员',
+ MATERIALS_IN_OUT_UNIT_PRICE_MUST_ZERO_WHEN_MODIFIED = '1411:只能修改初始单价为0的入库记录。 若有疑问，请联系管理员',
+
+ // SaleQuotation
+ SALE_QUOTATION_COMPONENT_DUPLICATED = '1412:存在名称，价格，规格都相同的配件，请检查是否重复录入',
+ SALE_QUOTATION_TEMPLATE_NAME_DUPLICATE = '1413:模板名已存在',
+
+ //domain
+ DOMAIN_TITLE_DUPLICATE = '1414:域标题已存在'
+}
diff --git a/src/constants/event-bus.constant.ts b/src/constants/event-bus.constant.ts
new file mode 100644
index 0000000..ad5e7e7
--- /dev/null
+++ b/src/constants/event-bus.constant.ts
@@ -0,0 +1,4 @@
+export enum EventBusEvents {
+ TokenExpired = 'token.expired',
+ SystemException = 'system.exception'
+}
diff --git a/src/constants/oss.constant.ts b/src/constants/oss.constant.ts
new file mode 100644
index 0000000..ceecb80
--- /dev/null
+++ b/src/constants/oss.constant.ts
@@ -0,0 +1,8 @@
+export const OSS_CONFIG = 'admin_module:qiniu_config';
+export const OSS_API = 'http://api.qiniu.com';
+
+// 目录分隔符
+export const NETDISK_DELIMITER = '/';
+export const NETDISK_LIMIT = 100;
+export const NETDISK_HANDLE_MAX_ITEM = 1000;
+export const NETDISK_COPY_SUFFIX = '的副本';
diff --git a/src/constants/response.constant.ts b/src/constants/response.constant.ts
new file mode 100644
index 0000000..a34fb9b
--- /dev/null
+++ b/src/constants/response.constant.ts
@@ -0,0 +1,15 @@
+export const RESPONSE_SUCCESS_CODE = 200;
+
+export const RESPONSE_SUCCESS_MSG = 'success';
+
+/**
+ * @description: contentType
+ */
+export enum ContentTypeEnum {
+ // json
+ JSON = 'application/json;charset=UTF-8',
+ // form-data qs
+ FORM_URLENCODED = 'application/x-www-form-urlencoded;charset=UTF-8',
+ // form-data upload
+ FORM_DATA = 'multipart/form-data;charset=UTF-8'
+}
diff --git a/src/constants/system.constant.ts b/src/constants/system.constant.ts
new file mode 100644
index 0000000..d1e191c
--- /dev/null
+++ b/src/constants/system.constant.ts
@@ -0,0 +1,6 @@
+export const SYS_USER_INITPASSWORD = 'sys_user_initPassword';
+export const SYS_API_TOKEN = 'sys_api_token';
+/** 超级管理员用户 id */
+export const ROOT_USER_ID = 1;
+/** 超级管理员角色 id */
+export const ROOT_ROLE_ID = 1;
diff --git a/src/global/env.ts b/src/global/env.ts
new file mode 100644
index 0000000..4e283c0
--- /dev/null
+++ b/src/global/env.ts
@@ -0,0 +1,62 @@
+import cluster from 'node:cluster';
+
+export const isMainCluster =
+ process.env.NODE_APP_INSTANCE && Number.parseInt(process.env.NODE_APP_INSTANCE) === 0;
+export const isMainProcess = cluster.isPrimary || isMainCluster;
+
+export const isDev = process.env.NODE_ENV === 'development';
+
+export const isTest = !!process.env.TEST;
+export const cwd = process.cwd();
+
+/**
+ * 基础类型接口
+ */
+export type BaseType = boolean | number | string | undefined | null;
+
+/**
+ * 格式化环境变量
+ * @param key 环境变量的键值
+ * @param defaultValue 默认值
+ * @param callback 格式化函数
+ */
+function fromatValue(
+ key: string,
+ defaultValue: T,
+ callback?: (value: string) => T
+): T {
+ const value: string | undefined = process.env[key];
+ if (typeof value === 'undefined') return defaultValue;
+
+ if (!callback) return value as unknown as T;
+
+ return callback(value);
+}
+
+export function env(key: string, defaultValue: string = '') {
+ return fromatValue(key, defaultValue);
+}
+
+export function envString(key: string, defaultValue: string = '') {
+ return fromatValue(key, defaultValue);
+}
+
+export function envNumber(key: string, defaultValue: number = 0) {
+ return fromatValue(key, defaultValue, value => {
+ try {
+ return Number(value);
+ } catch {
+ throw new Error(`${key} environment variable is not a number`);
+ }
+ });
+}
+
+export function envBoolean(key: string, defaultValue: boolean = false) {
+ return fromatValue(key, defaultValue, value => {
+ try {
+ return Boolean(JSON.parse(value));
+ } catch {
+ throw new Error(`${key} environment variable is not a boolean`);
+ }
+ });
+}
diff --git a/src/helper/catchError.ts b/src/helper/catchError.ts
new file mode 100644
index 0000000..78b8502
--- /dev/null
+++ b/src/helper/catchError.ts
@@ -0,0 +1,5 @@
+export function catchError() {
+ process.on('unhandledRejection', (reason, p) => {
+ console.log('Promise: ', p, 'Reason: ', reason);
+ });
+}
diff --git a/src/helper/crud/base.service.ts b/src/helper/crud/base.service.ts
new file mode 100644
index 0000000..41c526b
--- /dev/null
+++ b/src/helper/crud/base.service.ts
@@ -0,0 +1,35 @@
+import { NotFoundException } from '@nestjs/common';
+import { ObjectLiteral, Repository } from 'typeorm';
+
+import { PagerDto } from '~/common/dto/pager.dto';
+
+import { paginate } from '../paginate';
+import { Pagination } from '../paginate/pagination';
+
+export class BaseService = Repository> {
+ constructor(private repository: R) {}
+
+ async list({ page, pageSize }: PagerDto): Promise> {
+ return paginate(this.repository, { page, pageSize });
+ }
+
+ async findOne(id: number): Promise {
+ const item = await this.repository.createQueryBuilder().where({ id }).getOne();
+ if (!item) throw new NotFoundException('未找到该记录');
+
+ return item;
+ }
+
+ async create(dto: any): Promise {
+ return await this.repository.save(dto);
+ }
+
+ async update(id: number, dto: any): Promise {
+ await this.repository.update(id, dto);
+ }
+
+ async delete(id: number): Promise {
+ const item = await this.findOne(id);
+ await this.repository.remove(item);
+ }
+}
diff --git a/src/helper/crud/crud.factory.ts b/src/helper/crud/crud.factory.ts
new file mode 100644
index 0000000..af72c80
--- /dev/null
+++ b/src/helper/crud/crud.factory.ts
@@ -0,0 +1,80 @@
+import type { Type } from '@nestjs/common';
+
+import { Body, Controller, Delete, Get, Patch, Post, Put, Query } from '@nestjs/common';
+import { ApiBody, IntersectionType, PartialType } from '@nestjs/swagger';
+import pluralize from 'pluralize';
+
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { IdParam } from '~/common/decorators/id-param.decorator';
+import { PagerDto } from '~/common/dto/pager.dto';
+
+import { BaseService } from './base.service';
+
+export function BaseCrudFactory any>({
+ entity,
+ dto,
+ permissions
+}: {
+ entity: E;
+ dto?: Type;
+ permissions?: Record;
+}): Type {
+ const prefix = entity.name.toLowerCase().replace(/entity$/, '');
+ const pluralizeName = pluralize(prefix) as string;
+
+ dto = dto ?? class extends entity {};
+
+ class Dto extends dto {}
+ class UpdateDto extends PartialType(Dto) {}
+ class QueryDto extends IntersectionType(PagerDto, PartialType(Dto)) {}
+
+ permissions =
+ permissions ??
+ ({
+ LIST: `${prefix}:list`,
+ CREATE: `${prefix}:create`,
+ READ: `${prefix}:read`,
+ UPDATE: `${prefix}:update`,
+ DELETE: `${prefix}:delete`
+ } as const);
+
+ @Controller(pluralizeName)
+ class BaseController> {
+ constructor(private service: S) {}
+
+ @Get()
+ @ApiResult({ type: [entity], isPage: true })
+ async list(@Query() pager: QueryDto) {
+ return await this.service.list(pager);
+ }
+
+ @Get(':id')
+ @ApiResult({ type: entity })
+ async get(@IdParam() id: number) {
+ return await this.service.findOne(id);
+ }
+
+ @Post()
+ @ApiBody({ type: dto })
+ async create(@Body() dto: Dto) {
+ return await this.service.create(dto);
+ }
+
+ @Put(':id')
+ async update(@IdParam() id: number, @Body() dto: UpdateDto) {
+ return await this.service.update(id, dto);
+ }
+
+ @Patch(':id')
+ async patch(@IdParam() id: number, @Body() dto: UpdateDto) {
+ await this.service.update(id, dto);
+ }
+
+ @Delete(':id')
+ async delete(@IdParam() id: number) {
+ await this.service.delete(id);
+ }
+ }
+
+ return BaseController;
+}
diff --git a/src/helper/genRedisKey.ts b/src/helper/genRedisKey.ts
new file mode 100644
index 0000000..4cbe485
--- /dev/null
+++ b/src/helper/genRedisKey.ts
@@ -0,0 +1,19 @@
+import { RedisKeys } from '~/constants/cache.constant';
+
+/** 生成验证码 redis key */
+export function genCaptchaImgKey(val: string | number) {
+ return `${RedisKeys.CAPTCHA_IMG_PREFIX}${String(val)}` as const;
+}
+
+/** 生成 auth token redis key */
+export function genAuthTokenKey(val: string | number) {
+ return `${RedisKeys.AUTH_TOKEN_PREFIX}${String(val)}` as const;
+}
+/** 生成 auth permission redis key */
+export function genAuthPermKey(val: string | number) {
+ return `${RedisKeys.AUTH_PERM_PREFIX}${String(val)}` as const;
+}
+/** 生成 auth passwordVersion redis key */
+export function genAuthPVKey(val: string | number) {
+ return `${RedisKeys.AUTH_PASSWORD_V_PREFIX}${String(val)}` as const;
+}
diff --git a/src/helper/paginate/create-pagination.ts b/src/helper/paginate/create-pagination.ts
new file mode 100644
index 0000000..2adfa11
--- /dev/null
+++ b/src/helper/paginate/create-pagination.ts
@@ -0,0 +1,26 @@
+import { IPaginationMeta } from './interface';
+import { Pagination } from './pagination';
+
+export function createPaginationObject({
+ items,
+ totalItems,
+ currentPage,
+ limit
+}: {
+ items: T[];
+ totalItems?: number;
+ currentPage: number;
+ limit: number;
+}): Pagination {
+ const totalPages = totalItems !== undefined ? Math.ceil(totalItems / limit) : undefined;
+
+ const meta: IPaginationMeta = {
+ totalItems,
+ itemCount: items.length,
+ itemsPerPage: limit,
+ totalPages,
+ currentPage
+ };
+
+ return new Pagination(items, meta);
+}
diff --git a/src/helper/paginate/index.ts b/src/helper/paginate/index.ts
new file mode 100644
index 0000000..181243d
--- /dev/null
+++ b/src/helper/paginate/index.ts
@@ -0,0 +1,141 @@
+import {
+ FindManyOptions,
+ FindOptionsWhere,
+ ObjectLiteral,
+ Repository,
+ SelectQueryBuilder
+} from 'typeorm';
+
+import { createPaginationObject } from './create-pagination';
+import { IPaginationOptions, PaginationTypeEnum } from './interface';
+import { Pagination } from './pagination';
+
+const DEFAULT_LIMIT = 10;
+const DEFAULT_PAGE = 1;
+
+function resolveOptions(options: IPaginationOptions): [number, number, PaginationTypeEnum] {
+ const { page, pageSize, paginationType } = options;
+
+ return [
+ page || DEFAULT_PAGE,
+ pageSize || DEFAULT_LIMIT,
+ paginationType || PaginationTypeEnum.TAKE_AND_SKIP
+ ];
+}
+
+async function paginateRepository(
+ repository: Repository,
+ options: IPaginationOptions,
+ searchOptions?: FindOptionsWhere | FindManyOptions
+): Promise> {
+ const [page, limit] = resolveOptions(options);
+
+ const promises: [Promise, Promise | undefined] = [
+ repository.find({
+ skip: limit * (page - 1),
+ take: limit,
+ ...searchOptions
+ }),
+ undefined
+ ];
+
+ const [items, total] = await Promise.all(promises);
+
+ return createPaginationObject({
+ items,
+ totalItems: total,
+ currentPage: page,
+ limit
+ });
+}
+
+async function paginateQueryBuilder(
+ queryBuilder: SelectQueryBuilder,
+ options: IPaginationOptions
+): Promise> {
+ const [page, limit, paginationType] = resolveOptions(options);
+
+ if (paginationType === PaginationTypeEnum.TAKE_AND_SKIP)
+ queryBuilder.take(limit).skip((page - 1) * limit);
+ else queryBuilder.limit(limit).offset((page - 1) * limit);
+
+ const [items, total] = await queryBuilder.getManyAndCount();
+
+ return createPaginationObject({
+ items,
+ totalItems: total,
+ currentPage: page,
+ limit
+ });
+}
+
+export async function paginateRaw(
+ queryBuilder: SelectQueryBuilder,
+ options: IPaginationOptions
+): Promise> {
+ const [page, limit, paginationType] = resolveOptions(options);
+
+ const promises: [Promise, Promise | undefined] = [
+ (paginationType === PaginationTypeEnum.LIMIT_AND_OFFSET
+ ? queryBuilder.limit(limit).offset((page - 1) * limit)
+ : queryBuilder.take(limit).skip((page - 1) * limit)
+ ).getRawMany(),
+ queryBuilder.getCount()
+ ];
+
+ const [items, total] = await Promise.all(promises);
+
+ return createPaginationObject({
+ items,
+ totalItems: total,
+ currentPage: page,
+ limit
+ });
+}
+
+export async function paginateRawAndEntities(
+ queryBuilder: SelectQueryBuilder,
+ options: IPaginationOptions
+): Promise<[Pagination, Partial[]]> {
+ const [page, limit, paginationType] = resolveOptions(options);
+
+ const promises: [Promise<{ entities: T[]; raw: T[] }>, Promise | undefined] = [
+ (paginationType === PaginationTypeEnum.LIMIT_AND_OFFSET
+ ? queryBuilder.limit(limit).offset((page - 1) * limit)
+ : queryBuilder.take(limit).skip((page - 1) * limit)
+ ).getRawAndEntities(),
+ queryBuilder.getCount()
+ ];
+
+ const [itemObject, total] = await Promise.all(promises);
+
+ return [
+ createPaginationObject({
+ items: itemObject.entities,
+ totalItems: total,
+ currentPage: page,
+ limit
+ }),
+ itemObject.raw
+ ];
+}
+
+export async function paginate(
+ repository: Repository,
+ options: IPaginationOptions,
+ searchOptions?: FindOptionsWhere | FindManyOptions
+): Promise>;
+export async function paginate(
+ queryBuilder: SelectQueryBuilder,
+ options: IPaginationOptions
+): Promise>;
+
+export async function paginate(
+ repositoryOrQueryBuilder: Repository | SelectQueryBuilder,
+ options: IPaginationOptions,
+ searchOptions?: FindOptionsWhere | FindManyOptions
+) {
+ return repositoryOrQueryBuilder instanceof Repository
+ ? paginateRepository(repositoryOrQueryBuilder, options, searchOptions)
+ : paginateQueryBuilder(repositoryOrQueryBuilder, options);
+}
diff --git a/src/helper/paginate/interface.ts b/src/helper/paginate/interface.ts
new file mode 100644
index 0000000..c7d3062
--- /dev/null
+++ b/src/helper/paginate/interface.ts
@@ -0,0 +1,27 @@
+import { ObjectLiteral } from 'typeorm';
+
+export enum PaginationTypeEnum {
+ LIMIT_AND_OFFSET = 'limit',
+ TAKE_AND_SKIP = 'take'
+}
+
+export interface IPaginationOptions {
+ page: number;
+ pageSize: number;
+ paginationType?: PaginationTypeEnum;
+}
+
+export interface IPaginationMeta extends ObjectLiteral {
+ itemCount: number;
+ totalItems?: number;
+ itemsPerPage: number;
+ totalPages?: number;
+ currentPage: number;
+}
+
+export interface IPaginationLinks {
+ first?: string;
+ previous?: string;
+ next?: string;
+ last?: string;
+}
diff --git a/src/helper/paginate/pagination.ts b/src/helper/paginate/pagination.ts
new file mode 100644
index 0000000..02d97c2
--- /dev/null
+++ b/src/helper/paginate/pagination.ts
@@ -0,0 +1,11 @@
+import { ObjectLiteral } from 'typeorm';
+
+import { IPaginationMeta } from './interface';
+
+export class Pagination {
+ constructor(
+ public items: PaginationObject[],
+
+ public readonly meta: T
+ ) {}
+}
diff --git a/src/main.ts b/src/main.ts
new file mode 100644
index 0000000..51a2048
--- /dev/null
+++ b/src/main.ts
@@ -0,0 +1,88 @@
+import cluster from 'node:cluster';
+import path from 'node:path';
+
+import { HttpStatus, Logger, UnprocessableEntityException, ValidationPipe } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { NestFactory } from '@nestjs/core';
+import { NestFastifyApplication } from '@nestjs/platform-fastify';
+
+import { useContainer } from 'class-validator';
+
+import { AppModule } from './app.module';
+
+import { fastifyApp } from './common/adapters/fastify.adapter';
+import { RedisIoAdapter } from './common/adapters/socket.adapter';
+import { LoggingInterceptor } from './common/interceptors/logging.interceptor';
+import type { ConfigKeyPaths } from './config';
+import { isDev, isMainProcess } from './global/env';
+import { setupSwagger } from './setup-swagger';
+import { LoggerService } from './shared/logger/logger.service';
+
+declare const module: any;
+
+async function bootstrap() {
+ const app = await NestFactory.create(AppModule, fastifyApp, {
+ bufferLogs: true,
+ snapshot: true
+ // forceCloseConnections: true,
+ });
+
+ const configService = app.get(ConfigService);
+
+ const { port, globalPrefix } = configService.get('app', { infer: true });
+
+ // class-validator 的 DTO 类中注入 nest 容器的依赖 (用于自定义验证器)
+ useContainer(app.select(AppModule), { fallbackOnErrors: true });
+ app.enableCors({ origin: '*', credentials: true });
+ app.setGlobalPrefix(globalPrefix);
+ app.useStaticAssets({ root: path.join(__dirname, '..', 'public') });
+ // Starts listening for shutdown hooks
+ !isDev && app.enableShutdownHooks();
+
+ if (isDev) app.useGlobalInterceptors(new LoggingInterceptor());
+
+ app.useGlobalPipes(
+ new ValidationPipe({
+ transform: true,
+ whitelist: true,
+ transformOptions: { enableImplicitConversion: true },
+ // forbidNonWhitelisted: true, // 禁止 无装饰器验证的数据通过
+ errorHttpStatusCode: HttpStatus.UNPROCESSABLE_ENTITY,
+ stopAtFirstError: true,
+ exceptionFactory: errors =>
+ new UnprocessableEntityException(
+ errors.map(e => {
+ const rule = Object.keys(e.constraints!)[0];
+ const msg = e.constraints![rule];
+ return msg;
+ })[0]
+ )
+ })
+ );
+
+ app.useWebSocketAdapter(new RedisIoAdapter(app));
+
+ setupSwagger(app, configService);
+
+ await app.listen(port, '0.0.0.0', async () => {
+ app.useLogger(app.get(LoggerService));
+ const url = await app.getUrl();
+ const { pid } = process;
+ const env = cluster.isPrimary;
+ const prefix = env ? 'P' : 'W';
+
+ if (!isMainProcess) return;
+
+ const logger = new Logger('NestApplication');
+ logger.log(`[${prefix + pid}] Server running on ${url}`);
+
+ if (isDev) logger.log(`[${prefix + pid}] OpenAPI: ${url}/api-docs`);
+ });
+
+ if (module.hot) {
+ module.hot.accept();
+ module.hot.dispose(() => app.close());
+ }
+}
+
+bootstrap();
diff --git a/src/migrations/1707996695540-initData.ts b/src/migrations/1707996695540-initData.ts
new file mode 100644
index 0000000..8434099
--- /dev/null
+++ b/src/migrations/1707996695540-initData.ts
@@ -0,0 +1,14 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+const sql = fs.readFileSync(path.join(__dirname, '../../init_data/sql/hxoa.sql'), 'utf8');
+
+export class InitData1707996695540 implements MigrationInterface {
+ public async up(queryRunner: QueryRunner): Promise {
+ await queryRunner.query(sql);
+ }
+
+ public async down(queryRunner: QueryRunner): Promise {}
+}
diff --git a/src/modules/auth/auth.constant.ts b/src/modules/auth/auth.constant.ts
new file mode 100644
index 0000000..0815718
--- /dev/null
+++ b/src/modules/auth/auth.constant.ts
@@ -0,0 +1,26 @@
+export const PUBLIC_KEY = '__public_key__';
+
+export const PERMISSION_KEY = '__permission_key__';
+
+export const RESOURCE_KEY = '__resource_key__';
+
+export const ALLOW_ANON_KEY = '__allow_anon_permission_key__';
+
+export const AuthStrategy = {
+ LOCAL: 'local',
+ LOCAL_EMAIL: 'local_email',
+ LOCAL_PHONE: 'local_phone',
+
+ JWT: 'jwt',
+
+ GITHUB: 'github',
+ GOOGLE: 'google'
+} as const;
+
+export const Roles = {
+ ADMIN: 'admin',
+ USER: 'user'
+ // GUEST: 'guest',
+} as const;
+
+export type Role = (typeof Roles)[keyof typeof Roles];
diff --git a/src/modules/auth/auth.controller.ts b/src/modules/auth/auth.controller.ts
new file mode 100644
index 0000000..66b5b59
--- /dev/null
+++ b/src/modules/auth/auth.controller.ts
@@ -0,0 +1,60 @@
+import { Body, Controller, Headers, Post, UseGuards } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { Ip, IsMobile } from '~/common/decorators/http.decorator';
+
+import { UserService } from '../user/user.service';
+
+import { AuthService } from './auth.service';
+import { Public } from './decorators/public.decorator';
+import { LoginDto, RegisterDto } from './dto/auth.dto';
+import { LocalGuard } from './guards/local.guard';
+import { LoginToken } from './models/auth.model';
+import { CaptchaService } from './services/captcha.service';
+import { AuthUser } from './decorators/auth-user.decorator';
+import { ApiSecurityAuth } from '~/common/decorators/swagger.decorator';
+import { Domain, SkDomain } from '~/common/decorators/domain.decorator';
+
+@ApiTags('Auth - 认证模块')
+@UseGuards(LocalGuard)
+@Public()
+@Controller('auth')
+export class AuthController {
+ constructor(
+ private authService: AuthService,
+ private userService: UserService,
+ private captchaService: CaptchaService
+ ) {}
+
+ @Post('login')
+ @ApiOperation({ summary: '登录' })
+ @ApiResult({ type: LoginToken })
+ async login(
+ @Body() dto: LoginDto,
+ @Ip() ip: string,
+ @IsMobile() isMobile: boolean,
+ @Headers('user-agent') ua: string
+ ): Promise {
+ if (!isMobile) {
+ await this.captchaService.checkImgCaptcha(dto.captchaId, dto.verifyCode);
+ }
+ const token = await this.authService.login(dto.username, dto.password, ip, ua);
+ return { token };
+ }
+
+ @Post('unlock')
+ @ApiSecurityAuth()
+ @ApiOperation({ summary: '屏幕解锁，使用密码和token' })
+ @ApiResult({ type: LoginToken })
+ async unlock(@Body() dto: LoginDto, @AuthUser() user: IAuthUser): Promise {
+ await this.authService.unlock(user.uid, dto.password);
+ return true;
+ }
+
+ @Post('register')
+ @ApiOperation({ summary: '注册' })
+ async register(@Domain() domain: SkDomain, @Body() dto: RegisterDto): Promise {
+ await this.userService.register(dto, domain);
+ }
+}
diff --git a/src/modules/auth/auth.module.ts b/src/modules/auth/auth.module.ts
new file mode 100644
index 0000000..e0c54d6
--- /dev/null
+++ b/src/modules/auth/auth.module.ts
@@ -0,0 +1,58 @@
+import { Module } from '@nestjs/common';
+
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { JwtModule } from '@nestjs/jwt';
+import { PassportModule } from '@nestjs/passport';
+import { TypeOrmModule } from '@nestjs/typeorm';
+
+import { ConfigKeyPaths, ISecurityConfig } from '~/config';
+import { isDev } from '~/global/env';
+
+import { LogModule } from '../system/log/log.module';
+import { MenuModule } from '../system/menu/menu.module';
+import { RoleModule } from '../system/role/role.module';
+import { UserModule } from '../user/user.module';
+
+import { AuthController } from './auth.controller';
+import { AuthService } from './auth.service';
+import { AccountController } from './controllers/account.controller';
+import { CaptchaController } from './controllers/captcha.controller';
+import { EmailController } from './controllers/email.controller';
+import { AccessTokenEntity } from './entities/access-token.entity';
+import { RefreshTokenEntity } from './entities/refresh-token.entity';
+import { CaptchaService } from './services/captcha.service';
+import { TokenService } from './services/token.service';
+import { JwtStrategy } from './strategies/jwt.strategy';
+import { LocalStrategy } from './strategies/local.strategy';
+
+const controllers = [AuthController, AccountController, CaptchaController, EmailController];
+const providers = [AuthService, TokenService, CaptchaService];
+const strategies = [LocalStrategy, JwtStrategy];
+
+@Module({
+ imports: [
+ TypeOrmModule.forFeature([AccessTokenEntity, RefreshTokenEntity]),
+ PassportModule,
+ JwtModule.registerAsync({
+ imports: [ConfigModule],
+ useFactory: (configService: ConfigService) => {
+ const { jwtSecret, jwtExprire } = configService.get('security');
+
+ return {
+ secret: jwtSecret,
+ expires: jwtExprire,
+ ignoreExpiration: isDev
+ };
+ },
+ inject: [ConfigService]
+ }),
+ UserModule,
+ RoleModule,
+ MenuModule,
+ LogModule
+ ],
+ controllers: [...controllers],
+ providers: [...providers, ...strategies],
+ exports: [TypeOrmModule, JwtModule, ...providers]
+})
+export class AuthModule {}
diff --git a/src/modules/auth/auth.service.ts b/src/modules/auth/auth.service.ts
new file mode 100644
index 0000000..ab152f8
--- /dev/null
+++ b/src/modules/auth/auth.service.ts
@@ -0,0 +1,162 @@
+import { InjectRedis } from '@liaoliaots/nestjs-redis';
+import { Injectable } from '@nestjs/common';
+
+import Redis from 'ioredis';
+import { isEmpty } from 'lodash';
+
+import { BusinessException } from '~/common/exceptions/biz.exception';
+
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { genAuthPVKey, genAuthPermKey, genAuthTokenKey } from '~/helper/genRedisKey';
+
+import { UserService } from '~/modules/user/user.service';
+
+import { md5 } from '~/utils';
+
+import { LoginLogService } from '../system/log/services/login-log.service';
+import { MenuService } from '../system/menu/menu.service';
+import { RoleService } from '../system/role/role.service';
+
+import { TokenService } from './services/token.service';
+
+@Injectable()
+export class AuthService {
+ constructor(
+ @InjectRedis() private readonly redis: Redis,
+ private menuService: MenuService,
+ private roleService: RoleService,
+ private userService: UserService,
+ private loginLogService: LoginLogService,
+ private tokenService: TokenService
+ ) {}
+
+ async validateUser(credential: string, password: string): Promise {
+ const user = await this.userService.findUserByUserName(credential);
+
+ if (isEmpty(user)) throw new BusinessException(ErrorEnum.USER_NOT_FOUND);
+
+ const comparePassword = md5(`${password}${user.psalt}`);
+ if (user.password !== comparePassword)
+ throw new BusinessException(ErrorEnum.INVALID_USERNAME_PASSWORD);
+
+ if (user) {
+ const { password, ...result } = user;
+ return result;
+ }
+
+ return null;
+ }
+
+ /**
+ * 获取登录JWT
+ * 返回null则账号密码有误，不存在该用户
+ */
+ async login(username: string, password: string, ip: string, ua: string): Promise {
+ const user = await this.userService.findUserByUserName(username);
+ if (isEmpty(user)) throw new BusinessException(ErrorEnum.INVALID_USERNAME_PASSWORD);
+
+ const comparePassword = md5(`${password}${user.psalt}`);
+ if (user.password !== comparePassword)
+ throw new BusinessException(ErrorEnum.INVALID_USERNAME_PASSWORD);
+
+ const roleIds = await this.roleService.getRoleIdsByUser(user.id);
+
+ const roles = await this.roleService.getRoleValues(roleIds);
+
+ // 包含access_token和refresh_token
+ const token = await this.tokenService.generateAccessToken(user.id, roles);
+
+ await this.redis.set(genAuthTokenKey(user.id), token.accessToken);
+
+ // 设置密码版本号 当密码修改时，版本号+1
+ await this.redis.set(genAuthPVKey(user.id), 1);
+
+ // 设置菜单权限
+ const permissions = await this.menuService.getPermissions(user.id);
+ await this.setPermissionsCache(user.id, permissions);
+
+ await this.loginLogService.create(user.id, ip, ua);
+
+ return token.accessToken;
+ }
+
+ /**
+ * 解锁屏幕
+ * 返回null则账号密码有误，不存在该用户
+ */
+ async unlock(uid: number, password: string): Promise {
+ const user = await this.userService.findUserById(uid);
+ if (isEmpty(user)) throw new BusinessException(ErrorEnum.INVALID_USERNAME_PASSWORD);
+
+ const comparePassword = md5(`${password}${user.psalt}`);
+ if (user.password !== comparePassword)
+ throw new BusinessException(ErrorEnum.INVALID_USERNAME_PASSWORD);
+ }
+
+ /**
+ * 效验账号密码
+ */
+ async checkPassword(username: string, password: string) {
+ const user = await this.userService.findUserByUserName(username);
+
+ const comparePassword = md5(`${password}${user.psalt}`);
+ if (user.password !== comparePassword)
+ throw new BusinessException(ErrorEnum.INVALID_USERNAME_PASSWORD);
+ }
+
+ async loginLog(uid: number, ip: string, ua: string) {
+ await this.loginLogService.create(uid, ip, ua);
+ }
+
+ async logout(uid: number) {
+ // 删除token
+ await this.userService.forbidden(uid);
+ }
+
+ /**
+ * 重置密码
+ */
+ async resetPassword(username: string, password: string) {
+ const user = await this.userService.findUserByUserName(username);
+
+ await this.userService.forceUpdatePassword(user.id, password);
+ }
+
+ /**
+ * 清除登录状态信息
+ */
+ async clearLoginStatus(uid: number): Promise {
+ await this.userService.forbidden(uid);
+ }
+
+ /**
+ * 获取菜单列表
+ */
+ async getMenus(uid: number, isApp: number): Promise {
+ return this.menuService.getMenus(uid,isApp);
+ }
+
+ /**
+ * 获取权限列表
+ */
+ async getPermissions(uid: number): Promise {
+ return this.menuService.getPermissions(uid);
+ }
+
+ async getPermissionsCache(uid: number): Promise {
+ const permissionString = await this.redis.get(genAuthPermKey(uid));
+ return permissionString ? JSON.parse(permissionString) : [];
+ }
+
+ async setPermissionsCache(uid: number, permissions: string[]): Promise {
+ await this.redis.set(genAuthPermKey(uid), JSON.stringify(permissions));
+ }
+
+ async getPasswordVersionByUid(uid: number): Promise {
+ return this.redis.get(genAuthPVKey(uid));
+ }
+
+ async getTokenByUid(uid: number): Promise {
+ return this.redis.get(genAuthTokenKey(uid));
+ }
+}
diff --git a/src/modules/auth/controllers/account.controller.ts b/src/modules/auth/controllers/account.controller.ts
new file mode 100644
index 0000000..65c0661
--- /dev/null
+++ b/src/modules/auth/controllers/account.controller.ts
@@ -0,0 +1,79 @@
+import { Body, Controller, Get, Post, Put, UseGuards } from '@nestjs/common';
+import { ApiExtraModels, ApiOperation, ApiTags } from '@nestjs/swagger';
+
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+
+import { ApiSecurityAuth } from '~/common/decorators/swagger.decorator';
+import { AllowAnon } from '~/modules/auth/decorators/allow-anon.decorator';
+import { AuthUser } from '~/modules/auth/decorators/auth-user.decorator';
+
+import { PasswordUpdateDto } from '~/modules/user/dto/password.dto';
+
+import { AccountInfo } from '../../user/user.model';
+import { UserService } from '../../user/user.service';
+import { AuthService } from '../auth.service';
+import { AccountMenus, AccountUpdateDto } from '../dto/account.dto';
+import { JwtAuthGuard } from '../guards/jwt-auth.guard';
+import { IsMobile } from '~/common/decorators/http.decorator';
+import { ResourceDeviceEnum } from '~/constants/enum';
+import { Domain } from '~/common/decorators/domain.decorator';
+
+@ApiTags('Account - 账户模块')
+@ApiSecurityAuth()
+@ApiExtraModels(AccountInfo)
+@UseGuards(JwtAuthGuard)
+@Controller('account')
+export class AccountController {
+ constructor(
+ private userService: UserService,
+ private authService: AuthService
+ ) {}
+
+ @Get('profile')
+ @ApiOperation({ summary: '获取账户资料' })
+ @ApiResult({ type: AccountInfo })
+ @AllowAnon()
+ async profile(@AuthUser() user: IAuthUser): Promise {
+ return this.userService.getAccountInfo(user.uid);
+ }
+
+ @Get('logout')
+ @ApiOperation({ summary: '账户登出' })
+ @AllowAnon()
+ async logout(@AuthUser() user: IAuthUser): Promise {
+ await this.authService.clearLoginStatus(user.uid);
+ }
+
+ @Get('menus')
+ @ApiOperation({ summary: '获取菜单列表' })
+ @ApiResult({ type: [AccountMenus] })
+ @AllowAnon()
+ async menu(@AuthUser() user: IAuthUser, @IsMobile() isApp: boolean): Promise {
+ return this.authService.getMenus(
+ user.uid,
+ isApp ? ResourceDeviceEnum.APP : ResourceDeviceEnum.PC
+ );
+ }
+
+ @Get('permissions')
+ @ApiOperation({ summary: '获取权限列表' })
+ @ApiResult({ type: [String] })
+ @AllowAnon()
+ async permissions(@AuthUser() user: IAuthUser): Promise {
+ return this.authService.getPermissions(user.uid);
+ }
+
+ @Put('update')
+ @ApiOperation({ summary: '更改账户资料' })
+ @AllowAnon()
+ async update(@AuthUser() user: IAuthUser, @Body() dto: AccountUpdateDto): Promise {
+ await this.userService.updateAccountInfo(user.uid, dto);
+ }
+
+ @Post('password')
+ @ApiOperation({ summary: '更改账户密码' })
+ @AllowAnon()
+ async password(@AuthUser() user: IAuthUser, @Body() dto: PasswordUpdateDto): Promise {
+ await this.userService.updatePassword(user.uid, dto);
+ }
+}
diff --git a/src/modules/auth/controllers/captcha.controller.ts b/src/modules/auth/controllers/captcha.controller.ts
new file mode 100644
index 0000000..41b0591
--- /dev/null
+++ b/src/modules/auth/controllers/captcha.controller.ts
@@ -0,0 +1,48 @@
+import { InjectRedis } from '@liaoliaots/nestjs-redis';
+import { Controller, Get, Query } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+
+import Redis from 'ioredis';
+import { isEmpty } from 'lodash';
+import * as svgCaptcha from 'svg-captcha';
+
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { genCaptchaImgKey } from '~/helper/genRedisKey';
+import { generateUUID } from '~/utils';
+
+import { Public } from '../decorators/public.decorator';
+
+import { ImageCaptchaDto } from '../dto/captcha.dto';
+import { ImageCaptcha } from '../models/auth.model';
+
+@ApiTags('Captcha - 验证码模块')
+// @UseGuards(ThrottlerGuard)
+@Controller('auth/captcha')
+export class CaptchaController {
+ constructor(@InjectRedis() private redis: Redis) {}
+
+ @Get('img')
+ @ApiOperation({ summary: '获取登录图片验证码' })
+ @ApiResult({ type: ImageCaptcha })
+ @Public()
+ // @Throttle({ default: { limit: 2, ttl: 600000 } })
+ async captchaByImg(@Query() dto: ImageCaptchaDto): Promise {
+ const { width, height } = dto;
+
+ const svg = svgCaptcha.create({
+ size: 4,
+ color: true,
+ noise: 4,
+ width: isEmpty(width) ? 100 : width,
+ height: isEmpty(height) ? 50 : height,
+ charPreset: '1234567890'
+ });
+ const result = {
+ img: `data:image/svg+xml;base64,${Buffer.from(svg.data).toString('base64')}`,
+ id: generateUUID()
+ };
+ // 5分钟过期时间
+ await this.redis.set(genCaptchaImgKey(result.id), svg.text, 'EX', 60 * 5);
+ return result;
+ }
+}
diff --git a/src/modules/auth/controllers/email.controller.ts b/src/modules/auth/controllers/email.controller.ts
new file mode 100644
index 0000000..f0fb6c4
--- /dev/null
+++ b/src/modules/auth/controllers/email.controller.ts
@@ -0,0 +1,38 @@
+import { Body, Controller, Post, UseGuards } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+
+import { Throttle, ThrottlerGuard } from '@nestjs/throttler';
+
+import { Ip } from '~/common/decorators/http.decorator';
+
+import { MailerService } from '~/shared/mailer/mailer.service';
+
+import { Public } from '../decorators/public.decorator';
+
+import { SendEmailCodeDto } from '../dto/captcha.dto';
+
+@ApiTags('Auth - 认证模块')
+@UseGuards(ThrottlerGuard)
+@Controller('auth/email')
+export class EmailController {
+ constructor(private mailerService: MailerService) {}
+
+ @Post('send')
+ @ApiOperation({ summary: '发送邮箱验证码' })
+ @Public()
+ @Throttle({ default: { limit: 2, ttl: 600000 } })
+ async sendEmailCode(@Body() dto: SendEmailCodeDto, @Ip() ip: string): Promise {
+ // await this.authService.checkImgCaptcha(dto.captchaId, dto.verifyCode);
+ const { email } = dto;
+
+ await this.mailerService.checkLimit(email, ip);
+ const { code } = await this.mailerService.sendVerificationCode(email);
+
+ await this.mailerService.log(email, code, ip);
+ }
+
+ // @Post()
+ // async authWithEmail(@AuthUser() user: IAuthUser) {
+ // // TODO:
+ // }
+}
diff --git a/src/modules/auth/decorators/allow-anon.decorator.ts b/src/modules/auth/decorators/allow-anon.decorator.ts
new file mode 100644
index 0000000..b70dfac
--- /dev/null
+++ b/src/modules/auth/decorators/allow-anon.decorator.ts
@@ -0,0 +1,8 @@
+import { SetMetadata } from '@nestjs/common';
+
+import { ALLOW_ANON_KEY } from '../auth.constant';
+
+/**
+ * 当接口不需要检测用户是否具有操作权限时添加该装饰器
+ */
+export const AllowAnon = () => SetMetadata(ALLOW_ANON_KEY, true);
diff --git a/src/modules/auth/decorators/auth-user.decorator.ts b/src/modules/auth/decorators/auth-user.decorator.ts
new file mode 100644
index 0000000..bac65da
--- /dev/null
+++ b/src/modules/auth/decorators/auth-user.decorator.ts
@@ -0,0 +1,15 @@
+import { ExecutionContext, createParamDecorator } from '@nestjs/common';
+import { FastifyRequest } from 'fastify';
+
+type Payload = keyof IAuthUser;
+
+/**
+ * @description 获取当前登录用户信息, 并挂载到request上
+ */
+export const AuthUser = createParamDecorator((data: Payload, ctx: ExecutionContext) => {
+ const request = ctx.switchToHttp().getRequest();
+ // auth guard will mount this
+ const user = request.user as IAuthUser;
+
+ return data ? user?.[data] : user;
+});
diff --git a/src/modules/auth/decorators/permission.decorator.ts b/src/modules/auth/decorators/permission.decorator.ts
new file mode 100644
index 0000000..e88096c
--- /dev/null
+++ b/src/modules/auth/decorators/permission.decorator.ts
@@ -0,0 +1,63 @@
+import { SetMetadata, applyDecorators } from '@nestjs/common';
+
+import { isPlainObject } from 'lodash';
+
+import { PERMISSION_KEY } from '../auth.constant';
+
+type TupleToObject> = {
+ [K in Uppercase]: `${T}:${Lowercase}`;
+};
+type AddPrefixToObjectValue> = {
+ [K in keyof P]: K extends string ? `${T}:${P[K]}` : never;
+};
+
+/** 资源操作需要特定的权限 */
+export function Perm(permission: string | string[]) {
+ return applyDecorators(SetMetadata(PERMISSION_KEY, permission));
+}
+
+/** (此举非必需)保存通过 definePermission 定义的所有权限，可用于前端开发人员开发阶段的 ts 类型提示，避免前端权限定义与后端定义不匹配 */
+let permissions: string[] = [];
+/**
+ * 定义权限，同时收集所有被定义的权限
+ *
+ * - 通过对象形式定义, eg:
+ * ```ts
+ * definePermission('app:health', {
+ * NETWORK: 'network'
+ * };
+ * ```
+ *
+ * - 通过字符串数组形式定义, eg:
+ * ```ts
+ * definePermission('app:health', ['network']);
+ * ```
+ */
+export function definePermission>(
+ modulePrefix: T,
+ actionMap: U
+): AddPrefixToObjectValue;
+export function definePermission>(
+ modulePrefix: T,
+ actions: U
+): TupleToObject;
+export function definePermission(modulePrefix: string, actions) {
+ if (isPlainObject(actions)) {
+ Object.entries(actions).forEach(([key, action]) => {
+ actions[key] = `${modulePrefix}:${action}`;
+ });
+ permissions = [...new Set([...permissions, ...Object.values(actions)])];
+ return actions;
+ } else if (Array.isArray(actions)) {
+ const permissionFormats = actions.map(action => `${modulePrefix}:${action}`);
+ permissions = [...new Set([...permissions, ...permissionFormats])];
+
+ return actions.reduce((prev, action) => {
+ prev[action.toUpperCase()] = `${modulePrefix}:${action}`;
+ return prev;
+ }, {});
+ }
+}
+
+/** 获取所有通过 definePermission 定义的权限 */
+export const getDefinePermissions = () => permissions;
diff --git a/src/modules/auth/decorators/public.decorator.ts b/src/modules/auth/decorators/public.decorator.ts
new file mode 100644
index 0000000..b9592f2
--- /dev/null
+++ b/src/modules/auth/decorators/public.decorator.ts
@@ -0,0 +1,8 @@
+import { SetMetadata } from '@nestjs/common';
+
+import { PUBLIC_KEY } from '../auth.constant';
+
+/**
+ * 当接口不需要检测用户登录时添加该装饰器
+ */
+export const Public = () => SetMetadata(PUBLIC_KEY, true);
diff --git a/src/modules/auth/decorators/resource.decorator.ts b/src/modules/auth/decorators/resource.decorator.ts
new file mode 100644
index 0000000..6734598
--- /dev/null
+++ b/src/modules/auth/decorators/resource.decorator.ts
@@ -0,0 +1,22 @@
+import { SetMetadata, applyDecorators } from '@nestjs/common';
+
+import { ObjectLiteral, ObjectType, Repository } from 'typeorm';
+
+import { RESOURCE_KEY } from '../auth.constant';
+
+export type Condition = (
+ Repository: Repository,
+ items: number[],
+ user: IAuthUser
+) => Promise;
+
+export interface ResourceObject {
+ entity: ObjectType;
+ condition: Condition;
+}
+export function Resource(
+ entity: ObjectType,
+ condition?: Condition
+) {
+ return applyDecorators(SetMetadata(RESOURCE_KEY, { entity, condition }));
+}
diff --git a/src/modules/auth/dto/account.dto.ts b/src/modules/auth/dto/account.dto.ts
new file mode 100644
index 0000000..cf87459
--- /dev/null
+++ b/src/modules/auth/dto/account.dto.ts
@@ -0,0 +1,72 @@
+import { ApiProperty, OmitType, PartialType, PickType } from '@nestjs/swagger';
+import { IsEmail, IsOptional, IsString, Matches, MaxLength, MinLength } from 'class-validator';
+
+import { MenuEntity } from '~/modules/system/menu/menu.entity';
+
+export class AccountUpdateDto {
+ @ApiProperty({ description: '用户呢称' })
+ @IsString()
+ @IsOptional()
+ nickname: string;
+
+ @ApiProperty({ description: '用户邮箱' })
+ @IsEmail()
+ email: string;
+
+ @ApiProperty({ description: '用户QQ' })
+ @IsOptional()
+ @IsString()
+ @Matches(/^[0-9]+$/)
+ @MinLength(5)
+ @MaxLength(11)
+ qq: string;
+
+ @ApiProperty({ description: '用户手机号' })
+ @IsOptional()
+ @IsString()
+ phone: string;
+
+ @ApiProperty({ description: '用户头像' })
+ @IsOptional()
+ @IsString()
+ avatar: string;
+
+ @ApiProperty({ description: '用户备注' })
+ @IsOptional()
+ @IsString()
+ remark: string;
+}
+
+export class ResetPasswordDto {
+ @ApiProperty({ description: '临时token', example: 'uuid' })
+ @IsString()
+ accessToken: string;
+
+ @ApiProperty({ description: '密码', example: 'a123456' })
+ @IsString()
+ @Matches(/^\S*(?=\S{6,})(?=\S*\d)(?=\S*[A-Za-z])\S*$/)
+ @MinLength(6)
+ password: string;
+}
+
+export class MenuMeta extends PartialType(
+ OmitType(MenuEntity, [
+ 'parentId',
+ 'createdAt',
+ 'updatedAt',
+ 'id',
+ 'roles',
+ 'path',
+ 'name'
+ ] as const)
+) {
+ title: string;
+}
+export class AccountMenus extends PickType(MenuEntity, [
+ 'id',
+ 'path',
+ 'name',
+ 'component'
+] as const) {
+ meta: MenuMeta;
+}
diff --git a/src/modules/auth/dto/auth.dto.ts b/src/modules/auth/dto/auth.dto.ts
new file mode 100644
index 0000000..f6ec215
--- /dev/null
+++ b/src/modules/auth/dto/auth.dto.ts
@@ -0,0 +1,42 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+import { IsOptional, IsString, Matches, MaxLength, MinLength } from 'class-validator';
+
+export class LoginDto {
+ @ApiProperty({ description: '手机号/邮箱' })
+ @IsOptional()
+ username: string;
+
+ @ApiProperty({ description: '密码', example: 'a123456' })
+ @IsString()
+ @Matches(/^\S*(?=\S{6,})(?=\S*\d)(?=\S*[A-Za-z])\S*$/, { message: '密码错误' })
+ @MinLength(6)
+ password: string;
+
+ @ApiProperty({ description: '验证码标识，手机端不需要' })
+ @IsOptional()
+ captchaId: string;
+
+ @ApiProperty({ description: '用户输入的验证码' })
+ @IsOptional()
+ @MinLength(4)
+ @MaxLength(4)
+ verifyCode: string;
+}
+
+export class RegisterDto {
+ @ApiProperty({ description: '账号' })
+ @IsString()
+ username: string;
+
+ @ApiProperty({ description: '密码' })
+ @IsString()
+ @Matches(/^\S*(?=\S{6,})(?=\S*\d)(?=\S*[A-Za-z])\S*$/)
+ @MinLength(6)
+ @MaxLength(16)
+ password: string;
+
+ @ApiProperty({ description: '语言', examples: ['EN', 'ZH'] })
+ @IsString()
+ lang: string;
+}
diff --git a/src/modules/auth/dto/captcha.dto.ts b/src/modules/auth/dto/captcha.dto.ts
new file mode 100644
index 0000000..fdff06c
--- /dev/null
+++ b/src/modules/auth/dto/captcha.dto.ts
@@ -0,0 +1,47 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { IsEmail, IsInt, IsMobilePhone, IsOptional, IsString } from 'class-validator';
+
+export class ImageCaptchaDto {
+ @ApiProperty({
+ required: false,
+ default: 100,
+ description: '验证码宽度'
+ })
+ @Type(() => Number)
+ @IsInt()
+ @IsOptional()
+ readonly width: number = 100;
+
+ @ApiProperty({
+ required: false,
+ default: 50,
+ description: '验证码宽度'
+ })
+ @Type(() => Number)
+ @IsInt()
+ @IsOptional()
+ readonly height: number = 50;
+}
+
+export class SendEmailCodeDto {
+ @ApiProperty({ description: '邮箱' })
+ @IsEmail({}, { message: '邮箱格式不正确' })
+ email: string;
+}
+
+export class SendSmsCodeDto {
+ @ApiProperty({ description: '手机号' })
+ @IsMobilePhone('zh-CN', {}, { message: '手机号格式不正确' })
+ phone: string;
+}
+
+export class CheckCodeDto {
+ @ApiProperty({ description: '手机号/邮箱' })
+ @IsString()
+ account: string;
+
+ @ApiProperty({ description: '验证码' })
+ @IsString()
+ code: string;
+}
diff --git a/src/modules/auth/entities/access-token.entity.ts b/src/modules/auth/entities/access-token.entity.ts
new file mode 100644
index 0000000..fbbdc0c
--- /dev/null
+++ b/src/modules/auth/entities/access-token.entity.ts
@@ -0,0 +1,40 @@
+import {
+ BaseEntity,
+ Column,
+ CreateDateColumn,
+ Entity,
+ JoinColumn,
+ ManyToOne,
+ OneToOne,
+ PrimaryGeneratedColumn
+} from 'typeorm';
+
+import { UserEntity } from '~/modules/user/user.entity';
+
+import { RefreshTokenEntity } from './refresh-token.entity';
+
+@Entity('user_access_tokens')
+export class AccessTokenEntity extends BaseEntity {
+ @PrimaryGeneratedColumn('uuid')
+ id!: string;
+
+ @Column({ length: 500 })
+ value!: string;
+
+ @Column({ comment: '令牌过期时间' })
+ expired_at!: Date;
+
+ @CreateDateColumn({ comment: '令牌创建时间' })
+ created_at!: Date;
+
+ @OneToOne(() => RefreshTokenEntity, refreshToken => refreshToken.accessToken, {
+ cascade: true
+ })
+ refreshToken!: RefreshTokenEntity;
+
+ @ManyToOne(() => UserEntity, user => user.accessTokens, {
+ onDelete: 'CASCADE'
+ })
+ @JoinColumn({ name: 'user_id' })
+ user!: UserEntity;
+}
diff --git a/src/modules/auth/entities/refresh-token.entity.ts b/src/modules/auth/entities/refresh-token.entity.ts
new file mode 100644
index 0000000..4df36ce
--- /dev/null
+++ b/src/modules/auth/entities/refresh-token.entity.ts
@@ -0,0 +1,32 @@
+import {
+ BaseEntity,
+ Column,
+ CreateDateColumn,
+ Entity,
+ JoinColumn,
+ OneToOne,
+ PrimaryGeneratedColumn
+} from 'typeorm';
+
+import { AccessTokenEntity } from './access-token.entity';
+
+@Entity('user_refresh_tokens')
+export class RefreshTokenEntity extends BaseEntity {
+ @PrimaryGeneratedColumn('uuid')
+ id!: string;
+
+ @Column({ length: 500 })
+ value!: string;
+
+ @Column({ comment: '令牌过期时间' })
+ expired_at!: Date;
+
+ @CreateDateColumn({ comment: '令牌创建时间' })
+ created_at!: Date;
+
+ @OneToOne(() => AccessTokenEntity, accessToken => accessToken.refreshToken, {
+ onDelete: 'CASCADE'
+ })
+ @JoinColumn()
+ accessToken!: AccessTokenEntity;
+}
diff --git a/src/modules/auth/guards/jwt-auth.guard.ts b/src/modules/auth/guards/jwt-auth.guard.ts
new file mode 100644
index 0000000..4349a13
--- /dev/null
+++ b/src/modules/auth/guards/jwt-auth.guard.ts
@@ -0,0 +1,94 @@
+import { ExecutionContext, HttpException, HttpStatus, Injectable, UnauthorizedException } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { AuthGuard } from '@nestjs/passport';
+import { FastifyRequest } from 'fastify';
+import { isEmpty, isNil } from 'lodash';
+
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { AuthService } from '~/modules/auth/auth.service';
+
+import { checkIsDemoMode } from '~/utils';
+
+import { AuthStrategy, PUBLIC_KEY } from '../auth.constant';
+import { TokenService } from '../services/token.service';
+
+// https://docs.nestjs.com/recipes/passport#implement-protected-route-and-jwt-strategy-guards
+@Injectable()
+export class JwtAuthGuard extends AuthGuard(AuthStrategy.JWT) {
+ constructor(
+ private reflector: Reflector,
+ private authService: AuthService,
+ private tokenService: TokenService
+ ) {
+ super();
+ }
+
+ async canActivate(context: ExecutionContext): Promise {
+ const isPublic = this.reflector.getAllAndOverride(PUBLIC_KEY, [
+ context.getHandler(),
+ context.getClass()
+ ]);
+ const request = context.switchToHttp().getRequest();
+ // const response = context.switchToHttp().getResponse()
+
+ // TODO 此处代码的作用是判断如果在演示环境下，则拒绝用户的增删改操作，去掉此代码不影响正常的业务逻辑
+ if (request.method !== 'GET' && !request.url.includes('/auth/login')) checkIsDemoMode();
+
+ const isSse = request.headers.accept === 'text/event-stream';
+
+ if (isSse && !request.headers.authorization?.startsWith('Bearer')) {
+ const { token } = request.query as Record;
+ if (token) request.headers.authorization = `Bearer ${token}`;
+ }
+
+ const Authorization = request.headers.authorization;
+
+ let result: any = false;
+ try {
+ result = await super.canActivate(context);
+ } catch (e) {
+ // 需要后置判断 这样携带了 token 的用户就能够解析到 request.user
+ if (isPublic) return true;
+
+ if (isEmpty(Authorization)) throw new UnauthorizedException('未登录');
+
+ // 判断 token 是否存在, 如果不存在则认证失败
+ const accessToken = isNil(Authorization)
+ ? undefined
+ : await this.tokenService.checkAccessToken(Authorization!);
+
+ if (!accessToken) throw new UnauthorizedException('令牌无效');
+ }
+
+ // SSE 请求
+ if (isSse) {
+ const { uid } = request.params as Record;
+
+ if (Number(uid) !== request.user.uid)
+ throw new UnauthorizedException('路径参数 uid 与当前 token 登录的用户 uid 不一致');
+ }
+
+ const pv = await this.authService.getPasswordVersionByUid(request.user.uid);
+ if (pv !== `${request.user.pv}`) {
+ // 密码版本不一致，登录期间已更改过密码
+ throw new HttpException(ErrorEnum.INVALID_LOGIN,HttpStatus.UNAUTHORIZED);
+ }
+
+ // 不允许多端登录
+ // const cacheToken = await this.authService.getTokenByUid(request.user.uid);
+ // if (Authorization !== cacheToken) {
+ // // 与redis保存不一致 即二次登录
+ // throw new ApiException(ErrorEnum.CODE_1106);
+ // }
+
+ return result;
+ }
+
+ handleRequest(err, user, info) {
+ // You can throw an exception based on either "info" or "err" arguments
+ if (err || !user) throw err || new UnauthorizedException();
+
+ return user;
+ }
+}
diff --git a/src/modules/auth/guards/local.guard.ts b/src/modules/auth/guards/local.guard.ts
new file mode 100644
index 0000000..2bcaca9
--- /dev/null
+++ b/src/modules/auth/guards/local.guard.ts
@@ -0,0 +1,11 @@
+import { ExecutionContext, Injectable } from '@nestjs/common';
+import { AuthGuard } from '@nestjs/passport';
+
+import { AuthStrategy } from '../auth.constant';
+
+@Injectable()
+export class LocalGuard extends AuthGuard(AuthStrategy.LOCAL) {
+ async canActivate(context: ExecutionContext) {
+ return true;
+ }
+}
diff --git a/src/modules/auth/guards/rbac.guard.ts b/src/modules/auth/guards/rbac.guard.ts
new file mode 100644
index 0000000..3cf7239
--- /dev/null
+++ b/src/modules/auth/guards/rbac.guard.ts
@@ -0,0 +1,64 @@
+import { CanActivate, ExecutionContext, Injectable, UnauthorizedException } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { FastifyRequest } from 'fastify';
+
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { AuthService } from '~/modules/auth/auth.service';
+
+import { ALLOW_ANON_KEY, PERMISSION_KEY, PUBLIC_KEY, Roles } from '../auth.constant';
+
+@Injectable()
+export class RbacGuard implements CanActivate {
+ constructor(
+ private reflector: Reflector,
+ private authService: AuthService
+ ) {}
+
+ async canActivate(context: ExecutionContext): Promise {
+ const isPublic = this.reflector.getAllAndOverride(PUBLIC_KEY, [
+ context.getHandler(),
+ context.getClass()
+ ]);
+
+ if (isPublic) return true;
+
+ const request = context.switchToHttp().getRequest();
+
+ const { user } = request;
+ if (!user) throw new UnauthorizedException('登录无效');
+
+ // allowAnon 是需要登录后可访问(无需权限), Public 则是无需登录也可访问.
+ const allowAnon = this.reflector.get(ALLOW_ANON_KEY, context.getHandler());
+ if (allowAnon) return true;
+
+ const payloadPermission = this.reflector.getAllAndOverride(PERMISSION_KEY, [
+ context.getHandler(),
+ context.getClass()
+ ]);
+
+ // 控制器没有设置接口权限，则默认通过
+ if (!payloadPermission) return true;
+
+ // 管理员放开所有权限
+ if (user.roles.includes(Roles.ADMIN)) return true;
+
+ const allPermissions =
+ (await this.authService.getPermissionsCache(user.uid)) ??
+ (await this.authService.getPermissions(user.uid));
+ // console.log(allPermissions)
+ let canNext = false;
+
+ // handle permission strings
+ if (Array.isArray(payloadPermission)) {
+ // 只要有一个权限满足即可
+ canNext = payloadPermission.every(i => allPermissions.includes(i));
+ }
+
+ if (typeof payloadPermission === 'string') canNext = allPermissions.includes(payloadPermission);
+
+ if (!canNext) throw new BusinessException(ErrorEnum.NO_PERMISSION);
+
+ return true;
+ }
+}
diff --git a/src/modules/auth/guards/resource.guard.ts b/src/modules/auth/guards/resource.guard.ts
new file mode 100644
index 0000000..301181f
--- /dev/null
+++ b/src/modules/auth/guards/resource.guard.ts
@@ -0,0 +1,81 @@
+import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { FastifyRequest } from 'fastify';
+
+import { isArray, isEmpty, isNil } from 'lodash';
+
+import { DataSource, In, Repository } from 'typeorm';
+
+import { BusinessException } from '~/common/exceptions/biz.exception';
+
+import { ErrorEnum } from '~/constants/error-code.constant';
+
+import { PUBLIC_KEY, RESOURCE_KEY, Roles } from '../auth.constant';
+import { ResourceObject } from '../decorators/resource.decorator';
+
+@Injectable()
+export class ResourceGuard implements CanActivate {
+ constructor(
+ private reflector: Reflector,
+ private dataSource: DataSource
+ ) {}
+
+ async canActivate(context: ExecutionContext): Promise {
+ const isPublic = this.reflector.getAllAndOverride(PUBLIC_KEY, [
+ context.getHandler(),
+ context.getClass()
+ ]);
+
+ const request = context.switchToHttp().getRequest();
+ const isSse = request.headers.accept === 'text/event-stream';
+ // 忽略 sse 请求
+ if (isPublic || isSse) return true;
+
+ const { user } = request;
+
+ if (!user) return false;
+
+ // 如果是检查资源所属，且不是超级管理员，还需要进一步判断是否是自己的数据
+ const { entity, condition } = this.reflector.get(
+ RESOURCE_KEY,
+ context.getHandler()
+ ) ?? { entity: null, condition: null };
+
+ if (entity && !user.roles.includes(Roles.ADMIN)) {
+ const repo: Repository = this.dataSource.getRepository(entity);
+
+ /**
+ * 获取请求中的 items (ids) 验证数据拥有者
+ * @param request
+ */
+ const getRequestItems = (request?: FastifyRequest): number[] => {
+ const { params = {}, body = {}, query = {} } = (request ?? {}) as any;
+ const id = params.id ?? body.id ?? query.id;
+
+ if (id) return [id];
+
+ const { items } = body;
+ return !isNil(items) && isArray(items) ? items : [];
+ };
+
+ const items = getRequestItems(request);
+ if (isEmpty(items)) throw new BusinessException(ErrorEnum.REQUESTED_RESOURCE_NOT_FOUND);
+
+ if (condition) return condition(repo, items, user);
+
+ const recordQuery = {
+ where: {
+ id: In(items),
+ user: { id: user.uid }
+ },
+ relations: ['user']
+ };
+
+ const records = await repo.find(recordQuery);
+
+ if (isEmpty(records)) throw new BusinessException(ErrorEnum.REQUESTED_RESOURCE_NOT_FOUND);
+ }
+
+ return true;
+ }
+}
diff --git a/src/modules/auth/models/auth.model.ts b/src/modules/auth/models/auth.model.ts
new file mode 100644
index 0000000..01a5e08
--- /dev/null
+++ b/src/modules/auth/models/auth.model.ts
@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ImageCaptcha {
+ @ApiProperty({ description: 'base64格式的svg图片' })
+ img: string;
+
+ @ApiProperty({ description: '验证码对应的唯一ID' })
+ id: string;
+}
+
+export class LoginToken {
+ @ApiProperty({ description: 'JWT身份Token' })
+ token: string;
+}
diff --git a/src/modules/auth/services/captcha.service.ts b/src/modules/auth/services/captcha.service.ts
new file mode 100644
index 0000000..f7ddfc0
--- /dev/null
+++ b/src/modules/auth/services/captcha.service.ts
@@ -0,0 +1,35 @@
+import { InjectRedis } from '@liaoliaots/nestjs-redis';
+import { Injectable } from '@nestjs/common';
+
+import Redis from 'ioredis';
+import { isEmpty } from 'lodash';
+
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { genCaptchaImgKey } from '~/helper/genRedisKey';
+import { CaptchaLogService } from '~/modules/system/log/services/captcha-log.service';
+
+@Injectable()
+export class CaptchaService {
+ constructor(
+ @InjectRedis() private redis: Redis,
+
+ private captchaLogService: CaptchaLogService
+ ) {}
+
+ /**
+ * 校验图片验证码
+ */
+ async checkImgCaptcha(id: string, code: string): Promise {
+ const result = await this.redis.get(genCaptchaImgKey(id));
+ if (isEmpty(result) || code.toLowerCase() !== result.toLowerCase())
+ throw new BusinessException(ErrorEnum.INVALID_VERIFICATION_CODE);
+
+ // 校验成功后移除验证码
+ await this.redis.del(genCaptchaImgKey(id));
+ }
+
+ async log(account: string, code: string, provider: 'sms' | 'email', uid?: number): Promise {
+ await this.captchaLogService.create(account, code, provider, uid);
+ }
+}
diff --git a/src/modules/auth/services/token.service.ts b/src/modules/auth/services/token.service.ts
new file mode 100644
index 0000000..2e552cd
--- /dev/null
+++ b/src/modules/auth/services/token.service.ts
@@ -0,0 +1,150 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { JwtService } from '@nestjs/jwt';
+import dayjs from 'dayjs';
+
+import { ISecurityConfig, SecurityConfig } from '~/config';
+import { RoleService } from '~/modules/system/role/role.service';
+import { UserEntity } from '~/modules/user/user.entity';
+import { generateUUID } from '~/utils';
+
+import { AccessTokenEntity } from '../entities/access-token.entity';
+import { RefreshTokenEntity } from '../entities/refresh-token.entity';
+
+/**
+ * 令牌服务
+ */
+@Injectable()
+export class TokenService {
+ constructor(
+ private jwtService: JwtService,
+ private roleService: RoleService,
+ @Inject(SecurityConfig.KEY) private securityConfig: ISecurityConfig
+ ) {}
+
+ /**
+ * 根据accessToken刷新AccessToken与RefreshToken
+ * @param accessTokenSign
+ * @param response
+ */
+ async refreshToken(accessToken: AccessTokenEntity) {
+ const { user, refreshToken } = accessToken;
+
+ if (refreshToken) {
+ const now = dayjs();
+ // 判断refreshToken是否过期
+ if (now.isAfter(refreshToken.expired_at)) return null;
+
+ const roleIds = await this.roleService.getRoleIdsByUser(user.id);
+ const roleValues = await this.roleService.getRoleValues(roleIds);
+
+ // 如果没过期则生成新的access_token和refresh_token
+ const token = await this.generateAccessToken(user.id, roleValues);
+
+ await accessToken.remove();
+ return token;
+ }
+ return null;
+ }
+
+ generateJwtSign(payload: any) {
+ const jwtSign = this.jwtService.sign(payload);
+
+ return jwtSign;
+ }
+
+ async generateAccessToken(uid: number, roles: string[] = []) {
+ const payload: IAuthUser = {
+ uid,
+ pv: 1,
+ roles
+ };
+
+ const jwtSign = this.jwtService.sign(payload);
+
+ // 生成accessToken
+ const accessToken = new AccessTokenEntity();
+ accessToken.value = jwtSign;
+ accessToken.user = { id: uid } as UserEntity;
+ accessToken.expired_at = dayjs().add(this.securityConfig.jwtExprire, 'second').toDate();
+
+ await accessToken.save();
+
+ // 生成refreshToken
+ const refreshToken = await this.generateRefreshToken(accessToken, dayjs());
+
+ return {
+ accessToken: jwtSign,
+ refreshToken
+ };
+ }
+
+ /**
+ * 生成新的RefreshToken并存入数据库
+ * @param accessToken
+ * @param now
+ */
+ async generateRefreshToken(accessToken: AccessTokenEntity, now: dayjs.Dayjs): Promise {
+ const refreshTokenPayload = {
+ uuid: generateUUID()
+ };
+
+ const refreshTokenSign = this.jwtService.sign(refreshTokenPayload, {
+ secret: this.securityConfig.refreshSecret
+ });
+
+ const refreshToken = new RefreshTokenEntity();
+ refreshToken.value = refreshTokenSign;
+ refreshToken.expired_at = now.add(this.securityConfig.refreshExpire, 'second').toDate();
+ refreshToken.accessToken = accessToken;
+
+ await refreshToken.save();
+
+ return refreshTokenSign;
+ }
+
+ /**
+ * 检查accessToken是否存在
+ * @param value
+ */
+ async checkAccessToken(value: string) {
+ return AccessTokenEntity.findOne({
+ where: { value },
+ relations: ['user', 'refreshToken'],
+ cache: true
+ });
+ }
+
+ /**
+ * 移除AccessToken且自动移除关联的RefreshToken
+ * @param value
+ */
+ async removeAccessToken(value: string) {
+ const accessToken = await AccessTokenEntity.findOne({
+ where: { value }
+ });
+ if (accessToken) await accessToken.remove();
+ }
+
+ /**
+ * 移除RefreshToken
+ * @param value
+ */
+ async removeRefreshToken(value: string) {
+ const refreshToken = await RefreshTokenEntity.findOne({
+ where: { value },
+ relations: ['accessToken']
+ });
+ if (refreshToken) {
+ if (refreshToken.accessToken) await refreshToken.accessToken.remove();
+ await refreshToken.remove();
+ }
+ }
+
+ /**
+ * 验证Token是否正确,如果正确则返回所属用户对象
+ * @param token
+ */
+ async verifyAccessToken(token: string): Promise {
+ return this.jwtService.verify(token);
+ }
+}
diff --git a/src/modules/auth/strategies/jwt.strategy.ts b/src/modules/auth/strategies/jwt.strategy.ts
new file mode 100644
index 0000000..a5175e7
--- /dev/null
+++ b/src/modules/auth/strategies/jwt.strategy.ts
@@ -0,0 +1,22 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { PassportStrategy } from '@nestjs/passport';
+import { ExtractJwt, Strategy } from 'passport-jwt';
+
+import { ISecurityConfig, SecurityConfig } from '~/config';
+
+import { AuthStrategy } from '../auth.constant';
+
+@Injectable()
+export class JwtStrategy extends PassportStrategy(Strategy, AuthStrategy.JWT) {
+ constructor(@Inject(SecurityConfig.KEY) private securityConfig: ISecurityConfig) {
+ super({
+ jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
+ ignoreExpiration: false,
+ secretOrKey: securityConfig.jwtSecret
+ });
+ }
+
+ async validate(payload: IAuthUser) {
+ return payload;
+ }
+}
diff --git a/src/modules/auth/strategies/local.strategy.ts b/src/modules/auth/strategies/local.strategy.ts
new file mode 100644
index 0000000..da2d9d2
--- /dev/null
+++ b/src/modules/auth/strategies/local.strategy.ts
@@ -0,0 +1,21 @@
+import { Injectable } from '@nestjs/common';
+import { PassportStrategy } from '@nestjs/passport';
+import { Strategy } from 'passport-local';
+
+import { AuthStrategy } from '../auth.constant';
+import { AuthService } from '../auth.service';
+
+@Injectable()
+export class LocalStrategy extends PassportStrategy(Strategy, AuthStrategy.LOCAL) {
+ constructor(private authService: AuthService) {
+ super({
+ usernameField: 'credential',
+ passwordField: 'password'
+ });
+ }
+
+ async validate(username: string, password: string): Promise {
+ const user = await this.authService.validateUser(username, password);
+ return user;
+ }
+}
diff --git a/src/modules/common/base.service.ts b/src/modules/common/base.service.ts
new file mode 100644
index 0000000..7cb472d
--- /dev/null
+++ b/src/modules/common/base.service.ts
@@ -0,0 +1,11 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class BaseService {
+ generateInventoryInOutNumber(): string {
+ // Generate a random inventory number
+ return Math.floor(Math.random() * 1000000).toString();
+ }
+
+ // Add more common methods here
+}
diff --git a/src/modules/company/company.controller.ts b/src/modules/company/company.controller.ts
new file mode 100644
index 0000000..1ad2602
--- /dev/null
+++ b/src/modules/company/company.controller.ts
@@ -0,0 +1,80 @@
+import {
+ Body,
+ Controller,
+ Get,
+ Query,
+ Put,
+ Delete,
+ Post,
+ BadRequestException
+} from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { Perm, definePermission } from '../auth/decorators/permission.decorator';
+import { ApiSecurityAuth } from '~/common/decorators/swagger.decorator';
+import { CompanyService } from './company.service';
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { CompanyEntity } from './company.entity';
+import { CompanyDto, CompanyQueryDto, CompanyUpdateDto } from './company.dto';
+import { IdParam } from '~/common/decorators/id-param.decorator';
+import { Domain, SkDomain } from '~/common/decorators/domain.decorator';
+export const permissions = definePermission('app:company', {
+ LIST: 'list',
+ CREATE: 'create',
+ READ: 'read',
+ UPDATE: 'update',
+ DELETE: 'delete'
+} as const);
+
+@ApiTags('Company - 公司')
+@ApiSecurityAuth()
+@Controller('company')
+export class CompanyController {
+ constructor(private companyService: CompanyService) {}
+
+ @Get()
+ @ApiOperation({ summary: '获取公司列表' })
+ @ApiResult({ type: [CompanyEntity], isPage: true })
+ @Perm(permissions.LIST)
+ async list(@Domain() domain: SkDomain, @Query() dto: CompanyQueryDto) {
+ return this.companyService.findAll({ ...dto, domain });
+ }
+
+ @Get(':id')
+ @ApiOperation({ summary: '获取公司信息' })
+ @ApiResult({ type: CompanyDto })
+ @Perm(permissions.READ)
+ async info(@IdParam() id: number) {
+ return this.companyService.info(id);
+ }
+
+ @Post()
+ @ApiOperation({ summary: '新增公司' })
+ @Perm(permissions.CREATE)
+ async create(@Domain() domain: SkDomain, @Body() dto: CompanyDto): Promise {
+ await this.companyService.create({ ...dto, domain });
+ }
+
+ @Put(':id')
+ @ApiOperation({ summary: '更新公司' })
+ @Perm(permissions.UPDATE)
+ async update(@IdParam() id: number, @Body() dto: CompanyUpdateDto): Promise {
+ await this.companyService.update(id, dto);
+ }
+
+ @Delete(':id')
+ @ApiOperation({ summary: '删除公司' })
+ @Perm(permissions.DELETE)
+ async delete(@IdParam() id: number): Promise {
+ await this.companyService.delete(id);
+ }
+
+ @Put('unlink-attachments/:id')
+ @ApiOperation({ summary: '附件解除关联' })
+ @Perm(permissions.UPDATE)
+ async unlinkAttachments(
+ @IdParam() id: number,
+ @Body() { fileIds }: CompanyUpdateDto
+ ): Promise {
+ await this.companyService.unlinkAttachments(id, fileIds);
+ }
+}
diff --git a/src/modules/company/company.dto.ts b/src/modules/company/company.dto.ts
new file mode 100644
index 0000000..6a9f350
--- /dev/null
+++ b/src/modules/company/company.dto.ts
@@ -0,0 +1,53 @@
+import { ApiProperty, IntersectionType, PartialType } from '@nestjs/swagger';
+import {
+ IsArray,
+ IsDate,
+ IsDateString,
+ IsIn,
+ IsInt,
+ IsNumber,
+ IsOptional,
+ IsString,
+ Matches,
+ MinLength
+} from 'class-validator';
+import { PagerDto } from '~/common/dto/pager.dto';
+import { Storage } from '../tools/storage/storage.entity';
+import { IsUnique } from '~/shared/database/constraints/unique.constraint';
+import { CompanyEntity } from './company.entity';
+import { DomainType, SkDomain } from '~/common/decorators/domain.decorator';
+
+export class CompanyDto extends DomainType {
+ @ApiProperty({ description: '公司名称' })
+ @IsUnique(CompanyEntity, { message: '已存在同名公司' })
+ @IsString()
+ name: string;
+
+ @ApiProperty({ description: '附件' })
+ files: Storage[];
+}
+
+export class CompanyUpdateDto extends PartialType(CompanyDto) {
+ @ApiProperty({ description: '附件' })
+ @IsOptional()
+ @IsArray()
+ fileIds: number[];
+}
+
+export class ComapnyCreateDto extends PartialType(CompanyDto) {
+ @ApiProperty({ description: '附件' })
+ @IsOptional()
+ @IsArray()
+ fileIds: number[];
+}
+
+export class CompanyQueryDto extends IntersectionType(
+ PagerDto,
+ PartialType(CompanyDto),
+ DomainType
+) {
+ @ApiProperty({ description: '公司名称' })
+ @IsOptional()
+ @IsString()
+ name: string;
+}
diff --git a/src/modules/company/company.entity.ts b/src/modules/company/company.entity.ts
new file mode 100644
index 0000000..2f75103
--- /dev/null
+++ b/src/modules/company/company.entity.ts
@@ -0,0 +1,39 @@
+import { ApiHideProperty, ApiProperty } from '@nestjs/swagger';
+import { Column, Entity, JoinTable, ManyToMany, OneToMany, Relation } from 'typeorm';
+import { CommonEntity } from '~/common/entity/common.entity';
+import { Storage } from '../tools/storage/storage.entity';
+import { ProductEntity } from '../product/product.entity';
+import { SkDomain } from '~/common/decorators/domain.decorator';
+
+@Entity({ name: 'company' })
+export class CompanyEntity extends CommonEntity {
+ @Column({
+ name: 'name',
+ type: 'varchar',
+ unique: true,
+ length: 255,
+ comment: '公司名称'
+ })
+ @ApiProperty({ description: '公司名称' })
+ name: string;
+
+ @Column({ name: 'is_delete', type: 'tinyint', default: 0, comment: '是否删除' })
+ @ApiProperty({ description: '删除状态：0未删除，1已删除' })
+ isDelete: number;
+
+ @Column({ type: 'int', default: 1, comment: '所属域' })
+ @ApiProperty({ description: '所属域' })
+ domain: SkDomain;
+
+ @ApiHideProperty()
+ @OneToMany(() => ProductEntity, product => product.company)
+ products: Relation;
+
+ @ManyToMany(() => Storage, storage => storage.companys)
+ @JoinTable({
+ name: 'company_storage',
+ joinColumn: { name: 'company_id', referencedColumnName: 'id' },
+ inverseJoinColumn: { name: 'file_id', referencedColumnName: 'id' }
+ })
+ files: Relation;
+}
diff --git a/src/modules/company/company.module.ts b/src/modules/company/company.module.ts
new file mode 100644
index 0000000..5fba5b1
--- /dev/null
+++ b/src/modules/company/company.module.ts
@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { CompanyController } from './company.controller';
+import { CompanyService } from './company.service';
+import { CompanyEntity } from './company.entity';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { StorageModule } from '../tools/storage/storage.module';
+import { DatabaseModule } from '~/shared/database/database.module';
+
+@Module({
+ imports: [TypeOrmModule.forFeature([CompanyEntity]), StorageModule, DatabaseModule],
+ controllers: [CompanyController],
+ providers: [CompanyService]
+})
+export class CompanyModule {}
diff --git a/src/modules/company/company.service.ts b/src/modules/company/company.service.ts
new file mode 100644
index 0000000..8cb1fdd
--- /dev/null
+++ b/src/modules/company/company.service.ts
@@ -0,0 +1,124 @@
+import { Injectable } from '@nestjs/common';
+import { InjectEntityManager, InjectRepository } from '@nestjs/typeorm';
+import { CompanyEntity } from './company.entity';
+import { EntityManager, Like, Repository } from 'typeorm';
+import { CompanyDto, CompanyQueryDto, CompanyUpdateDto } from './company.dto';
+import { Pagination } from '~/helper/paginate/pagination';
+import { paginate } from '~/helper/paginate';
+import { Storage } from '../tools/storage/storage.entity';
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { fieldSearch } from '~/shared/database/field-search';
+import { SkDomain } from '~/common/decorators/domain.decorator';
+
+@Injectable()
+export class CompanyService {
+ constructor(
+ @InjectEntityManager() private entityManager: EntityManager,
+ @InjectRepository(CompanyEntity)
+ private companyRepository: Repository,
+ @InjectRepository(Storage)
+ private storageRepository: Repository
+ ) {}
+
+ /**
+ * 查询所有公司
+ */
+ async findAll({
+ page,
+ pageSize,
+ ...fields
+ }: CompanyQueryDto): Promise> {
+ const queryBuilder = this.companyRepository
+ .createQueryBuilder('company')
+ .leftJoin('company.files', 'files')
+ .addSelect(['files.id', 'files.path'])
+ .where(fieldSearch(fields))
+ .andWhere('company.isDelete = 0');
+
+ return paginate(queryBuilder, {
+ page,
+ pageSize
+ });
+ }
+
+ /**
+ * 新增
+ */
+ async create(dto: CompanyDto): Promise {
+ await this.companyRepository.insert(dto);
+ }
+
+ /**
+ * 更新
+ */
+ async update(id: number, { fileIds, ...data }: Partial): Promise {
+ await this.entityManager.transaction(async manager => {
+ await manager.update(CompanyEntity, id, {
+ ...data
+ });
+ const company = await this.companyRepository
+ .createQueryBuilder('company')
+ .leftJoinAndSelect('company.files', 'files')
+ .where('company.id = :id', { id })
+ .getOne();
+ if (fileIds?.length) {
+ const count = await this.storageRepository
+ .createQueryBuilder('storage')
+ .where('storage.id in(:fileIds)', { fileIds })
+ .getCount();
+ if (count !== fileIds?.length) {
+ throw new BusinessException(ErrorEnum.STORAGE_NOT_FOUND);
+ }
+ // 附件要批量插入
+ await manager.createQueryBuilder().relation(CompanyEntity, 'files').of(id).add(fileIds);
+ }
+ });
+ }
+
+ /**
+ * 删除
+ */
+ async delete(id: number): Promise {
+ // 合同比较重要，做逻辑删除
+ await this.companyRepository.update(id, { isDelete: 1 });
+ }
+
+ /**
+ * 获取单个合同信息
+ */
+ async info(id: number) {
+ const info = await this.companyRepository
+ .createQueryBuilder('company')
+ .where({
+ id
+ })
+ .andWhere('company.isDelete = 0')
+ .getOne();
+ return info;
+ }
+
+ /**
+ * 解除附件关联
+ * @param id 合同ID
+ * @param fileIds 附件ID
+ */
+ async unlinkAttachments(id: number, fileIds: number[]) {
+ await this.entityManager.transaction(async manager => {
+ const company = await this.companyRepository
+ .createQueryBuilder('company')
+ .leftJoinAndSelect('company.files', 'files')
+ .where('company.id = :id', { id })
+ .getOne();
+ const linkedFiles = company.files
+ .map(item => item.id)
+ .filter(item => !fileIds.includes(item));
+ // 附件要批量更新
+ await manager
+ .createQueryBuilder()
+ .relation(CompanyEntity, 'files')
+ .of(id)
+ .addAndRemove(linkedFiles, company.files);
+ });
+ }
+}
diff --git a/src/modules/contract/contract.controller.ts b/src/modules/contract/contract.controller.ts
new file mode 100644
index 0000000..d21578b
--- /dev/null
+++ b/src/modules/contract/contract.controller.ts
@@ -0,0 +1,80 @@
+import {
+ Body,
+ Controller,
+ Get,
+ Query,
+ Put,
+ Delete,
+ Post,
+ BadRequestException
+} from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { Perm, definePermission } from '../auth/decorators/permission.decorator';
+import { ApiSecurityAuth } from '~/common/decorators/swagger.decorator';
+import { ContractService } from './contract.service';
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { ContractEntity } from './contract.entity';
+import { ContractDto, ContractQueryDto, ContractUpdateDto } from './contract.dto';
+import { IdParam } from '~/common/decorators/id-param.decorator';
+import { Domain, SkDomain } from '~/common/decorators/domain.decorator';
+export const permissions = definePermission('app:contract', {
+ LIST: 'list',
+ CREATE: 'create',
+ READ: 'read',
+ UPDATE: 'update',
+ DELETE: 'delete'
+} as const);
+
+@ApiTags('Contract - 合同')
+@ApiSecurityAuth()
+@Controller('contract')
+export class ContractController {
+ constructor(private contractService: ContractService) {}
+
+ @Get()
+ @ApiOperation({ summary: '获取合同列表' })
+ @ApiResult({ type: [ContractEntity], isPage: true })
+ @Perm(permissions.LIST)
+ async list(@Domain() domain: SkDomain, @Query() dto: ContractQueryDto) {
+ return this.contractService.findAll({ ...dto, domain });
+ }
+
+ @Get(':id')
+ @ApiOperation({ summary: '获取合同信息' })
+ @ApiResult({ type: ContractDto })
+ @Perm(permissions.READ)
+ async info(@IdParam() id: number) {
+ return this.contractService.info(id);
+ }
+
+ @Post()
+ @ApiOperation({ summary: '新增合同' })
+ @Perm(permissions.CREATE)
+ async create(@Domain() domain: SkDomain, @Body() dto: ContractDto): Promise {
+ await this.contractService.create({ ...dto, domain });
+ }
+
+ @Put(':id')
+ @ApiOperation({ summary: '更新合同' })
+ @Perm(permissions.UPDATE)
+ async update(@IdParam() id: number, @Body() dto: ContractUpdateDto): Promise {
+ await this.contractService.update(id, dto);
+ }
+
+ @Delete(':id')
+ @ApiOperation({ summary: '删除合同' })
+ @Perm(permissions.DELETE)
+ async delete(@IdParam() id: number): Promise {
+ await this.contractService.delete(id);
+ }
+
+ @Put('unlink-attachments/:id')
+ @ApiOperation({ summary: '附件解除关联' })
+ @Perm(permissions.UPDATE)
+ async unlinkAttachments(
+ @IdParam() id: number,
+ @Body() { fileIds }: ContractUpdateDto
+ ): Promise {
+ await this.contractService.unlinkAttachments(id, fileIds);
+ }
+}
diff --git a/src/modules/contract/contract.dto.ts b/src/modules/contract/contract.dto.ts
new file mode 100644
index 0000000..46e6e85
--- /dev/null
+++ b/src/modules/contract/contract.dto.ts
@@ -0,0 +1,72 @@
+import { ApiProperty, IntersectionType, PartialType } from '@nestjs/swagger';
+import {
+ IsArray,
+ IsDate,
+ IsDateString,
+ IsEnum,
+ IsIn,
+ IsInt,
+ IsNumber,
+ IsOptional,
+ IsString,
+ Matches,
+ MinLength
+} from 'class-validator';
+import { PagerDto } from '~/common/dto/pager.dto';
+import { Storage } from '../tools/storage/storage.entity';
+import { ContractStatusEnum } from '~/constants/enum';
+import { DomainType, SkDomain } from '~/common/decorators/domain.decorator';
+
+export class ContractDto extends DomainType {
+ @ApiProperty({ description: '合同编号' })
+ @Matches(/^[a-z0-9A-Z]+$/, { message: '合同编号只能包含字母和数字' })
+ @IsString()
+ contractNumber: string;
+
+ @ApiProperty({ description: '合同标题' })
+ @IsString()
+ title: string;
+
+ @ApiProperty({ description: '合同类型' })
+ @IsNumber()
+ type: number;
+
+ @ApiProperty({ description: '甲方' })
+ @IsString()
+ partyA: string;
+
+ @ApiProperty({ description: '乙方' })
+ @IsString()
+ partyB: string;
+
+ @ApiProperty({ description: '签订日期' })
+ @IsOptional()
+ @IsDateString()
+ signingDate?: string;
+
+ @ApiProperty({ description: '交付期限' })
+ @IsOptional()
+ @IsDateString()
+ deliveryDeadline?: string;
+
+ @ApiProperty({ description: '审核状态(字典)' })
+ @IsOptional()
+ @IsEnum(ContractStatusEnum)
+ status: number;
+
+ @ApiProperty({ description: '附件' })
+ files: Storage[];
+}
+
+export class ContractUpdateDto extends PartialType(ContractDto) {
+ @ApiProperty({ description: '附件' })
+ @IsOptional()
+ @IsArray()
+ fileIds: number[];
+}
+export class ContractQueryDto extends IntersectionType(
+ PagerDto,
+ PartialType(ContractDto),
+ DomainType
+) {}
+
diff --git a/src/modules/contract/contract.entity.ts b/src/modules/contract/contract.entity.ts
new file mode 100644
index 0000000..40856b7
--- /dev/null
+++ b/src/modules/contract/contract.entity.ts
@@ -0,0 +1,62 @@
+import { ApiHideProperty, ApiProperty } from '@nestjs/swagger';
+import { Column, Entity, JoinTable, ManyToMany, Relation } from 'typeorm';
+import { CommonEntity } from '~/common/entity/common.entity';
+import { Storage } from '../tools/storage/storage.entity';
+import { SkDomain } from '~/common/decorators/domain.decorator';
+
+@Entity({ name: 'contract' })
+export class ContractEntity extends CommonEntity {
+ @Column({
+ name: 'contract_number',
+ type: 'varchar',
+ length: 255,
+ unique: true,
+ comment: '合同编号'
+ })
+ @ApiProperty({ description: '合同编号' })
+ contractNumber: string;
+
+ @Column({ name: 'title', type: 'varchar', length: 255, comment: '合同标题' })
+ @ApiProperty({ description: '合同标题' })
+ title: string;
+
+ @Column({ type: 'int', comment: '合同类型(字典)' })
+ @ApiProperty({ description: '合同类型(字典)' })
+ type: number;
+
+ @Column({ name: 'party_a', length: 255, type: 'varchar', comment: '甲方' })
+ @ApiProperty({ description: '甲方' })
+ partyA: string;
+
+ @Column({ name: 'party_b', length: 255, type: 'varchar', comment: '乙方' })
+ @ApiProperty({ description: '乙方' })
+ partyB: string;
+
+ @Column({ name: 'signing_date', type: 'date', nullable: true })
+ @ApiProperty({ description: '签订日期' })
+ signingDate: Date;
+
+ @Column({ name: 'delivery_deadline', type: 'date', nullable: true })
+ @ApiProperty({ description: '交付期限' })
+ deliveryDeadline: Date;
+
+ @Column({ name: 'status', type: 'tinyint', default: 0, comment: '审核状态(字典)' })
+ @ApiProperty({ description: '审核状态：0待审核，1同意，2.不同意(字典)' })
+ status: number;
+
+ @Column({ name: 'is_delete', type: 'tinyint', default: 0, comment: '是否删除' })
+ @ApiProperty({ description: '删除状态：0未删除，1已删除' })
+ isDelete: number;
+
+ @Column({ type: 'int', default: 1, comment: '所属域' })
+ @ApiProperty({ description: '所属域' })
+ domain: SkDomain;
+
+ @ManyToMany(() => Storage, storage => storage.contracts)
+ @JoinTable({
+ name: 'contract_storage',
+ joinColumn: { name: 'contract_id', referencedColumnName: 'id' },
+ inverseJoinColumn: { name: 'file_id', referencedColumnName: 'id' }
+ })
+ files: Relation;
+}
diff --git a/src/modules/contract/contract.module.ts b/src/modules/contract/contract.module.ts
new file mode 100644
index 0000000..d5eabe8
--- /dev/null
+++ b/src/modules/contract/contract.module.ts
@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common';
+import { ContractController } from './contract.controller';
+import { ContractService } from './contract.service';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { ContractEntity } from './contract.entity';
+import { StorageModule } from '../tools/storage/storage.module';
+
+@Module({
+ imports: [TypeOrmModule.forFeature([ContractEntity]), StorageModule],
+ controllers: [ContractController],
+ providers: [ContractService]
+})
+export class ContractModule {}
diff --git a/src/modules/contract/contract.service.ts b/src/modules/contract/contract.service.ts
new file mode 100644
index 0000000..267ef0b
--- /dev/null
+++ b/src/modules/contract/contract.service.ts
@@ -0,0 +1,145 @@
+import { Injectable } from '@nestjs/common';
+import { InjectEntityManager, InjectRepository } from '@nestjs/typeorm';
+import { ContractEntity } from './contract.entity';
+import { EntityManager, Like, Not, Repository } from 'typeorm';
+import { ContractDto, ContractQueryDto, ContractUpdateDto } from './contract.dto';
+import { Pagination } from '~/helper/paginate/pagination';
+import { isNumber } from 'lodash';
+import { paginate } from '~/helper/paginate';
+import { Storage } from '../tools/storage/storage.entity';
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { fieldSearch } from '~/shared/database/field-search';
+import { SkDomain } from '~/common/decorators/domain.decorator';
+
+@Injectable()
+export class ContractService {
+ constructor(
+ @InjectEntityManager() private entityManager: EntityManager,
+ @InjectRepository(ContractEntity)
+ private contractRepository: Repository,
+ @InjectRepository(Storage)
+ private storageRepository: Repository
+ ) {}
+
+ /**
+ * 查找所有合同
+ */
+ async findAll({
+ page,
+ pageSize,
+ ...fields
+ }: ContractQueryDto): Promise> {
+ const queryBuilder = this.contractRepository
+ .createQueryBuilder('contract')
+ .leftJoin('contract.files', 'files')
+ .addSelect(['files.id', 'files.path'])
+ .where(fieldSearch(fields))
+ .andWhere('contract.isDelete = 0');
+
+ return paginate(queryBuilder, {
+ page,
+ pageSize
+ });
+ }
+
+ /**
+ * 新增
+ */
+ async create({ contractNumber, ...ext }: ContractDto): Promise {
+ if (await this.checkIsContractNumberExsit(contractNumber)) {
+ throw new BusinessException(ErrorEnum.CONTRACT_NUMBER_EXIST);
+ }
+ await this.contractRepository.insert(
+ this.contractRepository.create({ contractNumber, ...ext })
+ );
+ }
+
+ /**
+ * 更新
+ */
+ async update(
+ id: number,
+ { fileIds, contractNumber, ...ext }: Partial
+ ): Promise {
+ await this.entityManager.transaction(async manager => {
+ if (contractNumber && (await this.checkIsContractNumberExsit(contractNumber, id))) {
+ throw new BusinessException(ErrorEnum.CONTRACT_NUMBER_EXIST);
+ }
+ await manager.update(ContractEntity, id, {
+ ...ext,
+ contractNumber
+ });
+
+ if (fileIds?.length) {
+ const count = await this.storageRepository
+ .createQueryBuilder('storage')
+ .where('storage.id in(:fileIds)', { fileIds })
+ .getCount();
+ if (count !== fileIds?.length) {
+ throw new BusinessException(ErrorEnum.STORAGE_NOT_FOUND);
+ }
+ // 附件要批量插入
+ await manager.createQueryBuilder().relation(ContractEntity, 'files').of(id).add(fileIds);
+ }
+ });
+ }
+
+ /**
+ * 是否存在相同编号的合同
+ * @param contractNumber 合同编号
+ */
+ async checkIsContractNumberExsit(contractNumber: string, id?: number): Promise {
+ return !!(await this.contractRepository.findOne({
+ where: {
+ contractNumber: contractNumber,
+ id: Not(id)
+ }
+ }));
+ }
+ /**
+ * 删除
+ */
+ async delete(id: number): Promise {
+ // 合同比较重要，做逻辑删除
+ await this.contractRepository.update(id, { isDelete: 1 });
+ }
+
+ /**
+ * 获取单个合同信息
+ */
+ async info(id: number) {
+ const info = await this.contractRepository
+ .createQueryBuilder('contract')
+ .where({
+ id
+ })
+ .andWhere('contract.isDelete = 0')
+ .getOne();
+ return info;
+ }
+
+ /**
+ * 解除附件关联
+ * @param id 合同ID
+ * @param fileIds 附件ID
+ */
+ async unlinkAttachments(id: number, fileIds: number[]) {
+ await this.entityManager.transaction(async manager => {
+ const contract = await this.contractRepository
+ .createQueryBuilder('contract')
+ .leftJoinAndSelect('contract.files', 'files')
+ .where('contract.id = :id', { id })
+ .getOne();
+ const linkedFiles = contract.files
+ .map(item => item.id)
+ .filter(item => !fileIds.includes(item));
+ // 附件要批量更新
+ await manager
+ .createQueryBuilder()
+ .relation(ContractEntity, 'files')
+ .of(id)
+ .addAndRemove(linkedFiles, contract.files);
+ });
+ }
+}
diff --git a/src/modules/domian/domain.controller.ts b/src/modules/domian/domain.controller.ts
new file mode 100644
index 0000000..0bd02a3
--- /dev/null
+++ b/src/modules/domian/domain.controller.ts
@@ -0,0 +1,67 @@
+import {
+ Body,
+ Controller,
+ Get,
+ Query,
+ Put,
+ Delete,
+ Post,
+ BadRequestException
+} from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { Perm, definePermission } from '../auth/decorators/permission.decorator';
+import { ApiSecurityAuth } from '~/common/decorators/swagger.decorator';
+import { DomainService } from './domain.service';
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { DomainEntity } from './domain.entity';
+import { DomainDto, DomainQueryDto, DomainUpdateDto } from './domain.dto';
+import { IdParam } from '~/common/decorators/id-param.decorator';
+export const permissions = definePermission('app:domain', {
+ CREATE: 'create',
+ READ: 'read',
+ UPDATE: 'update',
+ DELETE: 'delete'
+} as const);
+
+@ApiTags('Domain - 域')
+@ApiSecurityAuth()
+@Controller('domain')
+export class DomainController {
+ constructor(private domainService: DomainService) {}
+
+ @Get()
+ @ApiOperation({ summary: '获取域列表' })
+ @ApiResult({ type: [DomainEntity], isPage: true })
+ async list(@Query() dto: DomainQueryDto) {
+ return this.domainService.findAll(dto);
+ }
+
+ @Get(':id')
+ @ApiOperation({ summary: '获取域信息' })
+ @ApiResult({ type: DomainDto })
+ @Perm(permissions.READ)
+ async info(@IdParam() id: number) {
+ return this.domainService.info(id);
+ }
+
+ @Post()
+ @ApiOperation({ summary: '新增域' })
+ @Perm(permissions.CREATE)
+ async create(@Body() dto: DomainDto): Promise {
+ await this.domainService.create(dto);
+ }
+
+ @Put(':id')
+ @ApiOperation({ summary: '更新域' })
+ @Perm(permissions.UPDATE)
+ async update(@IdParam() id: number, @Body() dto: DomainUpdateDto): Promise {
+ await this.domainService.update(id, dto);
+ }
+
+ @Delete(':id')
+ @ApiOperation({ summary: '删除域' })
+ @Perm(permissions.DELETE)
+ async delete(@IdParam() id: number): Promise {
+ await this.domainService.delete(id);
+ }
+}
diff --git a/src/modules/domian/domain.dto.ts b/src/modules/domian/domain.dto.ts
new file mode 100644
index 0000000..61d94fb
--- /dev/null
+++ b/src/modules/domian/domain.dto.ts
@@ -0,0 +1,12 @@
+import { ApiProperty, IntersectionType, PartialType } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { PagerDto } from '~/common/dto/pager.dto';
+
+export class DomainDto {
+ @ApiProperty({ description: '域标题' })
+ @IsString()
+ title: string;
+}
+
+export class DomainUpdateDto extends PartialType(DomainDto) {}
+export class DomainQueryDto extends IntersectionType(PagerDto, PartialType(DomainDto)) {}
diff --git a/src/modules/domian/domain.entity.ts b/src/modules/domian/domain.entity.ts
new file mode 100644
index 0000000..8ed3c48
--- /dev/null
+++ b/src/modules/domian/domain.entity.ts
@@ -0,0 +1,15 @@
+import { ApiHideProperty, ApiProperty } from '@nestjs/swagger';
+import { Column, Entity, JoinTable, ManyToMany, Relation } from 'typeorm';
+import { CommonEntity } from '~/common/entity/common.entity';
+import { Storage } from '../tools/storage/storage.entity';
+
+@Entity({ name: 'domain' })
+export class DomainEntity extends CommonEntity {
+ @Column({ name: 'title', type: 'varchar', length: 255, comment: '域标题' })
+ @ApiProperty({ description: '域标题' })
+ title: string;
+
+ @Column({ name: 'is_delete', type: 'tinyint', default: 0, comment: '是否删除' })
+ @ApiProperty({ description: '删除状态：0未删除，1已删除' })
+ isDelete: number;
+}
diff --git a/src/modules/domian/domain.module.ts b/src/modules/domian/domain.module.ts
new file mode 100644
index 0000000..9aaa16f
--- /dev/null
+++ b/src/modules/domian/domain.module.ts
@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { DomainController } from './domain.controller';
+import { DomainService } from './domain.service';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { DomainEntity } from './domain.entity';
+
+@Module({
+ imports: [TypeOrmModule.forFeature([DomainEntity])],
+ controllers: [DomainController],
+ providers: [DomainService]
+})
+export class DomainModule {}
diff --git a/src/modules/domian/domain.service.ts b/src/modules/domian/domain.service.ts
new file mode 100644
index 0000000..7fdfecd
--- /dev/null
+++ b/src/modules/domian/domain.service.ts
@@ -0,0 +1,95 @@
+import { Injectable } from '@nestjs/common';
+import { InjectEntityManager, InjectRepository } from '@nestjs/typeorm';
+import { DomainEntity } from './domain.entity';
+import { EntityManager, Like, Not, Repository } from 'typeorm';
+import { DomainDto, DomainQueryDto, DomainUpdateDto } from './domain.dto';
+import { Pagination } from '~/helper/paginate/pagination';
+import { isNumber } from 'lodash';
+import { paginate } from '~/helper/paginate';
+import { Storage } from '../tools/storage/storage.entity';
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { fieldSearch } from '~/shared/database/field-search';
+
+@Injectable()
+export class DomainService {
+ constructor(
+ @InjectEntityManager() private entityManager: EntityManager,
+ @InjectRepository(DomainEntity)
+ private domainRepository: Repository
+ ) {}
+
+ /**
+ * 查找所有域
+ */
+ async findAll({ page, pageSize, ...fields }: DomainQueryDto): Promise> {
+ const queryBuilder = this.domainRepository
+ .createQueryBuilder('domain')
+ .where(fieldSearch(fields))
+ .andWhere('domain.isDelete = 0');
+
+ return paginate(queryBuilder, {
+ page,
+ pageSize
+ });
+ }
+
+ /**
+ * 新增
+ */
+ async create({ title, ...ext }: DomainDto): Promise {
+ if (await this.checkIsDomainExsit(title)) {
+ throw new BusinessException(ErrorEnum.DOMAIN_TITLE_DUPLICATE);
+ }
+ await this.domainRepository.insert(this.domainRepository.create({ title, ...ext }));
+ }
+
+ /**
+ * 更新
+ */
+ async update(id: number, { title, ...ext }: Partial): Promise {
+ await this.entityManager.transaction(async manager => {
+ if (title && (await this.checkIsDomainExsit(title, id))) {
+ throw new BusinessException(ErrorEnum.CONTRACT_NUMBER_EXIST);
+ }
+ await manager.update(DomainEntity, id, {
+ ...ext,
+ title
+ });
+ });
+ }
+
+ /**
+ * 是否存在相同的域
+ * @param title 域编号
+ */
+ async checkIsDomainExsit(title: string, id?: number): Promise {
+ return !!(await this.domainRepository.findOne({
+ where: {
+ title: title,
+ id: Not(id)
+ }
+ }));
+ }
+ /**
+ * 删除
+ */
+ async delete(id: number): Promise {
+ // 域比较重要，做逻辑删除
+ await this.domainRepository.update(id, { isDelete: 1 });
+ }
+
+ /**
+ * 获取单个域信息
+ */
+ async info(id: number) {
+ const info = await this.domainRepository
+ .createQueryBuilder('domain')
+ .where({
+ id
+ })
+ .andWhere('domain.isDelete = 0')
+ .getOne();
+ return info;
+ }
+}
diff --git a/src/modules/health/health.controller.ts b/src/modules/health/health.controller.ts
new file mode 100644
index 0000000..6927b4c
--- /dev/null
+++ b/src/modules/health/health.controller.ts
@@ -0,0 +1,71 @@
+import { Controller, Get } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+import {
+ DiskHealthIndicator,
+ HealthCheck,
+ HttpHealthIndicator,
+ MemoryHealthIndicator,
+ TypeOrmHealthIndicator
+} from '@nestjs/terminus';
+
+import { Perm, definePermission } from '../auth/decorators/permission.decorator';
+
+export const PermissionHealth = definePermission('app:health', {
+ NETWORK: 'network',
+ DB: 'database',
+ MH: 'memory-heap',
+ MR: 'memory-rss',
+ DISK: 'disk'
+} as const);
+
+@ApiTags('Health - 健康检查')
+@Controller('health')
+export class HealthController {
+ constructor(
+ private http: HttpHealthIndicator,
+ private db: TypeOrmHealthIndicator,
+ private memory: MemoryHealthIndicator,
+ private disk: DiskHealthIndicator
+ ) {}
+
+ @Get('network')
+ @HealthCheck()
+ @Perm(PermissionHealth.NETWORK)
+ async checkNetwork() {
+ return this.http.pingCheck('louis', 'https://gitee.com/lu-zixun');
+ }
+
+ @Get('database')
+ @HealthCheck()
+ @Perm(PermissionHealth.DB)
+ async checkDatabase() {
+ return this.db.pingCheck('database');
+ }
+
+ @Get('memory-heap')
+ @HealthCheck()
+ @Perm(PermissionHealth.MH)
+ async checkMemoryHeap() {
+ // the process should not use more than 200MB memory
+ return this.memory.checkHeap('memory-heap', 200 * 1024 * 1024);
+ }
+
+ @Get('memory-rss')
+ @HealthCheck()
+ @Perm(PermissionHealth.MR)
+ async checkMemoryRSS() {
+ // the process should not have more than 200MB RSS memory allocated
+ return this.memory.checkRSS('memory-rss', 200 * 1024 * 1024);
+ }
+
+ @Get('disk')
+ @HealthCheck()
+ @Perm(PermissionHealth.DISK)
+ async checkDisk() {
+ return this.disk.checkStorage('disk', {
+ // The used disk storage should not exceed 75% of the full disk size
+ thresholdPercent: 0.75,
+ path: '/'
+ });
+ }
+}
diff --git a/src/modules/health/health.module.ts b/src/modules/health/health.module.ts
new file mode 100644
index 0000000..674c072
--- /dev/null
+++ b/src/modules/health/health.module.ts
@@ -0,0 +1,11 @@
+import { HttpModule } from '@nestjs/axios';
+import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+
+import { HealthController } from './health.controller';
+
+@Module({
+ imports: [TerminusModule, HttpModule],
+ controllers: [HealthController]
+})
+export class HealthModule {}
diff --git a/src/modules/materials_inventory/in_out/materials_in_out.controller.ts b/src/modules/materials_inventory/in_out/materials_in_out.controller.ts
new file mode 100644
index 0000000..c41a04d
--- /dev/null
+++ b/src/modules/materials_inventory/in_out/materials_in_out.controller.ts
@@ -0,0 +1,90 @@
+import { Body, Controller, Delete, Get, Post, Put, Query, Res } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { IdParam } from '~/common/decorators/id-param.decorator';
+import { MaterialsInOutService } from './materials_in_out.service';
+import { MaterialsInOutEntity } from './materials_in_out.entity';
+import { ApiSecurityAuth } from '~/common/decorators/swagger.decorator';
+import { definePermission, Perm } from '~/modules/auth/decorators/permission.decorator';
+import {
+ MaterialsInOutQueryDto,
+ MaterialsInOutDto,
+ MaterialsInOutUpdateDto,
+ MaterialsInOutExportDto
+} from './materials_in_out.dto';
+import { Domain, DomainType, SkDomain } from '~/common/decorators/domain.decorator';
+import { FastifyReply } from 'fastify';
+export const permissions = definePermission('materials_inventory:history_in_out', {
+ LIST: 'list',
+ CREATE: 'create',
+ READ: 'read',
+ UPDATE: 'update',
+ DELETE: 'delete',
+ EXPORT: 'export'
+} as const);
+
+@ApiTags('Materials In Out History - 原材料出入库记录')
+@ApiSecurityAuth()
+@Controller('materials-in-out')
+export class MaterialsInOutController {
+ constructor(private materialsInOutService: MaterialsInOutService) { }
+
+ @Get('export')
+ @ApiOperation({ summary: '导出原材料盘点表' })
+ @Perm(permissions.EXPORT)
+ async exportMaterialsInventoryCheck(
+ @Domain() domain: SkDomain,
+ @Query() dto: MaterialsInOutExportDto,
+ @Res() res: FastifyReply
+ ): Promise {
+ await this.materialsInOutService.exportMaterialsInventoryCheck({ ...dto, domain }, res);
+ }
+
+
+ @Get()
+ @ApiOperation({ summary: '获取原材料出入库记录列表' })
+ @ApiResult({ type: [MaterialsInOutEntity], isPage: true })
+ @Perm(permissions.LIST)
+ async list(@Domain() domain: SkDomain, @Query() dto: MaterialsInOutQueryDto) {
+ return this.materialsInOutService.findAll({ ...dto, domain });
+ }
+
+ @Get(':id')
+ @ApiOperation({ summary: '获取原材料出入库记录信息' })
+ @ApiResult({ type: MaterialsInOutDto })
+ @Perm(permissions.READ)
+ async info(@IdParam() id: number) {
+ return this.materialsInOutService.info(id);
+ }
+
+ @Post()
+ @ApiOperation({ summary: '新增原材料出入库记录' })
+ @Perm(permissions.CREATE)
+ async create(@Domain() domain: SkDomain, @Body() dto: MaterialsInOutDto): Promise {
+ return this.materialsInOutService.create({ ...dto, domain });
+ }
+
+ @Put(':id')
+ @ApiOperation({ summary: '更新原材料出入库记录' })
+ @Perm(permissions.UPDATE)
+ async update(@IdParam() id: number, @Body() dto: MaterialsInOutUpdateDto): Promise {
+ await this.materialsInOutService.update(id, dto);
+ }
+
+ @Delete(':id')
+ @ApiOperation({ summary: '删除原材料出入库记录' })
+ @Perm(permissions.DELETE)
+ async delete(@IdParam() id: number): Promise {
+ await this.materialsInOutService.delete(id);
+ }
+
+ @Put('unlink-attachments/:id')
+ @ApiOperation({ summary: '附件解除关联' })
+ @Perm(permissions.UPDATE)
+ async unlinkAttachments(
+ @IdParam() id: number,
+ @Body() { fileIds }: MaterialsInOutUpdateDto
+ ): Promise {
+ await this.materialsInOutService.unlinkAttachments(id, fileIds);
+ }
+}
diff --git a/src/modules/materials_inventory/in_out/materials_in_out.dto.ts b/src/modules/materials_inventory/in_out/materials_in_out.dto.ts
new file mode 100644
index 0000000..f4faab5
--- /dev/null
+++ b/src/modules/materials_inventory/in_out/materials_in_out.dto.ts
@@ -0,0 +1,199 @@
+import { ApiProperty, IntersectionType, PartialType } from '@nestjs/swagger';
+import { Transform } from 'class-transformer';
+import {
+ IsArray,
+ IsBoolean,
+ IsDate,
+ IsDateString,
+ IsEnum,
+ IsIn,
+ IsInt,
+ IsNumber,
+ IsOptional,
+ IsString,
+ Matches,
+ MinLength,
+ ValidateIf,
+ isNumber
+} from 'class-validator';
+import dayjs from 'dayjs';
+import { DomainType } from '~/common/decorators/domain.decorator';
+import { PagerDto } from '~/common/dto/pager.dto';
+import { MaterialsInOrOutEnum } from '~/constants/enum';
+import { Storage } from '~/modules/tools/storage/storage.entity';
+import { formatToDate } from '~/utils';
+
+export class MaterialsInOutDto extends DomainType {
+ @IsOptional()
+ @IsNumber()
+ @ApiProperty({ description: '项目Id' })
+ projectId?: number;
+
+ @ApiProperty({ description: '产品Id' })
+ @ValidateIf(o => !o.inventoryInOutNumber)
+ @IsNumber()
+ productId: number;
+
+ @ApiProperty({ description: '原材料库存编号' })
+ @IsOptional()
+ @IsString()
+ inventoryInOutNumber: string;
+
+ @ApiProperty({ description: '库存id(产品和单价双主键决定一条库存)' })
+ @IsOptional()
+ @IsNumber()
+ inventoryId: number;
+
+ @ApiProperty({ description: '单位(字典)' })
+ @IsNumber()
+ @IsOptional()
+ unitId: number;
+
+ @ApiProperty({ description: '入库或出库 0:入库 1:出库' })
+ @IsEnum(MaterialsInOrOutEnum)
+ inOrOut: MaterialsInOrOutEnum;
+
+ @ApiProperty({ description: '时间' })
+ @Transform(params => {
+ return params.value ? new Date(params.value) : null;
+ })
+ @IsOptional()
+ time: Date;
+
+ @ApiProperty({ description: '数量' })
+ @IsNumber()
+ quantity: number;
+
+ @ApiProperty({ description: '单价' })
+ @IsOptional()
+ @IsNumber()
+ unitPrice: number;
+
+ @ApiProperty({ description: '金额' })
+ @IsOptional()
+ @IsNumber()
+ amount: number;
+
+ @ApiProperty({ description: '经办人' })
+ @IsOptional()
+ @IsString()
+ agent: string;
+
+ @ApiProperty({ description: '领料单号' })
+ @IsOptional()
+ @IsString()
+ issuanceNumber: string;
+
+ @ApiProperty({ description: '库存位置' })
+ @IsOptional()
+ @IsString()
+ position: string;
+
+ @IsOptional()
+ @IsString()
+ @ApiProperty({ description: '备注' })
+ remark: string;
+}
+
+export class MaterialsInOutUpdateDto extends PartialType(MaterialsInOutDto) {
+ @ApiProperty({ description: '附件' })
+ @IsOptional()
+ @IsArray()
+ fileIds: number[];
+}
+export class MaterialsInOutQueryDto extends IntersectionType(
+ PagerDto,
+ DomainType
+) {
+ @ApiProperty({ description: '出入库时间YYYY-MM-DD' })
+ @IsOptional()
+ // @IsString()
+ @Transform(params => {
+ // 开始和结束时间用的是一天的开始和一天的结束的时分秒
+ return params.value
+ ? [
+ params.value[0] ? `${formatToDate(params.value[0], 'YYYY-MM-DD')} 00:00:00` : null,
+ params.value[1] ? `${formatToDate(params.value[1], 'YYYY-MM-DD')} 23:59:59` : null
+ ]
+ : [];
+ })
+ time?: string[];
+
+ @ApiProperty({ description: '入库或出库 0:入库 1:出库' })
+ @IsOptional()
+ @IsEnum(MaterialsInOrOutEnum)
+ inOrOut?: MaterialsInOrOutEnum;
+
+ @ApiProperty({ description: '产品名称' })
+ @IsOptional()
+ @IsString()
+ product?: string;
+
+ @ApiProperty({ description: '经办人' })
+ @IsOptional()
+ @IsString()
+ agent?: string;
+
+ @ApiProperty({ description: '领料单号' })
+ @IsOptional()
+ @IsString()
+ issuanceNumber?: string;
+
+ @ApiProperty({ description: '原材料库存编号' })
+ @IsOptional()
+ @IsString()
+ inventoryInOutNumber?: string;
+
+ @IsOptional()
+ @IsString()
+ @ApiProperty({ description: '备注' })
+ remark?: string;
+
+ @IsOptional()
+ @IsNumber()
+ @ApiProperty({ description: '项目Id' })
+ projectId?: number;
+
+ @IsOptional()
+ @IsBoolean()
+ @ApiProperty({ description: '是否是用于创建出库记录' })
+ isCreateOut?: boolean;
+}
+export class MaterialsInOutExportDto extends IntersectionType(
+
+ DomainType
+) {
+
+ @ApiProperty({ description: '导出时间YYYY-MM-DD' })
+ @IsOptional()
+ @IsArray()
+ @Transform(params => {
+ // 开始和结束时间用的是一月的开始和一月的结束的时分秒
+ const date = params.value;
+ return [
+ date ? `${date[0]} 00:00:00` : null,
+ date ? `${date[1]} 23:59:59` : null
+ ];
+ })
+ time?: string[];
+
+ @ApiProperty({ description: '导出文件名' })
+ @IsOptional()
+ @IsString()
+ filename?: string
+
+ @ApiProperty({ description: '入库或出库 0:入库 1:出库' })
+ @IsOptional()
+ @IsEnum(MaterialsInOrOutEnum)
+ inOrOut?: MaterialsInOrOutEnum;
+
+ @ApiProperty({ description: '产品名称' })
+ @IsOptional()
+ @IsString()
+ product?: string;
+
+ @ApiProperty({ description: '经办人' })
+ @IsOptional()
+ @IsString()
+ agent?: string;
+}
\ No newline at end of file
diff --git a/src/modules/materials_inventory/in_out/materials_in_out.entity.ts b/src/modules/materials_inventory/in_out/materials_in_out.entity.ts
new file mode 100644
index 0000000..b8e36b0
--- /dev/null
+++ b/src/modules/materials_inventory/in_out/materials_in_out.entity.ts
@@ -0,0 +1,148 @@
+import { ApiHideProperty, ApiProperty } from '@nestjs/swagger';
+import { InjectRepository } from '@nestjs/typeorm';
+import { Expose } from 'class-transformer';
+import pinyin from 'pinyin';
+import {
+ BeforeInsert,
+ Column,
+ Entity,
+ JoinColumn,
+ JoinTable,
+ ManyToMany,
+ ManyToOne,
+ Relation,
+ Repository
+} from 'typeorm';
+import { CommonEntity } from '~/common/entity/common.entity';
+import { MaterialsInOrOutEnum, ParamConfigEnum } from '~/constants/enum';
+import { ProductEntity } from '~/modules/product/product.entity';
+import { ProjectEntity } from '~/modules/project/project.entity';
+import { ParamConfigEntity } from '~/modules/system/param-config/param-config.entity';
+import { Storage } from '~/modules/tools/storage/storage.entity';
+import { MaterialsInventoryEntity } from '../materials_inventory.entity';
+import { SkDomain } from '~/common/decorators/domain.decorator';
+@Entity({ name: 'materials_in_out' })
+export class MaterialsInOutEntity extends CommonEntity {
+ @Column({
+ name: 'inventory_inout_number',
+ type: 'varchar',
+ length: 50,
+ comment: '原材料出入库编号'
+ })
+ @ApiProperty({ description: '原材料出入库编号' })
+ inventoryInOutNumber: string;
+
+ @Column({
+ name: 'product_id',
+ type: 'int',
+ comment: '产品'
+ })
+ @ApiProperty({ description: '产品' })
+ productId: number;
+
+ @Column({
+ name: 'inventory_id',
+ type: 'int',
+ comment: '库存'
+ })
+ @ApiProperty({ description: '库存' })
+ inventoryId: number;
+
+ @Column({
+ name: 'in_or_out',
+ type: 'tinyint',
+ comment: '入库或出库'
+ })
+ @ApiProperty({ description: '入库或出库 0:入库 1:出库' })
+ inOrOut: MaterialsInOrOutEnum;
+
+ @Column({
+ name: 'time',
+ type: 'datetime',
+ nullable: true,
+ comment: '时间'
+ })
+ @ApiProperty({ description: '时间' })
+ time: Date;
+
+ @Column({
+ name: 'quantity',
+ type: 'int',
+ default: 0,
+ comment: '数量'
+ })
+ @ApiProperty({ description: '数量' })
+ quantity: number;
+
+ @Column({
+ name: 'unit_price',
+ type: 'decimal',
+ precision: 15,
+ default: 0,
+ scale: 10,
+ comment: '单价'
+ })
+ @ApiProperty({ description: '单价' })
+ unitPrice: number;
+
+ @Column({
+ name: 'amount',
+ type: 'decimal',
+ precision: 15,
+ default: 0,
+ scale: 10,
+ comment: '金额'
+ })
+ @ApiProperty({ description: '金额' })
+ amount: number;
+
+ @Column({ name: 'agent', type: 'varchar', length: 50, comment: '经办人', nullable: true })
+ @ApiProperty({ description: '经办人' })
+ agent: string;
+
+ @Column({
+ name: 'issuance_number',
+ type: 'varchar',
+ length: 100,
+ nullable: true,
+ comment: '领料单号'
+ })
+ @ApiProperty({ description: '领料单号' })
+ issuanceNumber: string;
+
+ @Column({ name: 'remark', type: 'varchar', length: 255, comment: '备注', nullable: true })
+ @ApiProperty({ description: '备注' })
+ remark: string;
+
+ @Column({ name: 'project_id', type: 'int', comment: '项目', nullable: true })
+ @ApiProperty({ description: '项目Id' })
+ projectId: number;
+
+ @Column({ name: 'is_delete', type: 'tinyint', default: 0, comment: '是否删除' })
+ @ApiProperty({ description: '删除状态：0未删除，1已删除' })
+ isDelete: number;
+
+ @ManyToOne(() => ProjectEntity)
+ @JoinColumn({ name: 'project_id' })
+ project: ProjectEntity;
+
+ @ManyToOne(() => ProductEntity)
+ @JoinColumn({ name: 'product_id' })
+ product: ProductEntity;
+
+ @Column({ type: 'int', default: 1, comment: '所属域' })
+ @ApiProperty({ description: '所属域' })
+ domain: SkDomain;
+
+ @ManyToMany(() => Storage, storage => storage.materialsInOuts)
+ @JoinTable({
+ name: 'materials_in_out_storage',
+ joinColumn: { name: 'materials_in_out_id', referencedColumnName: 'id' },
+ inverseJoinColumn: { name: 'file_id', referencedColumnName: 'id' }
+ })
+ files: Relation;
+
+ @ManyToOne(() => MaterialsInventoryEntity)
+ @JoinColumn({ name: 'inventory_id' })
+ inventory: MaterialsInventoryEntity;
+}
diff --git a/src/modules/materials_inventory/in_out/materials_in_out.service.ts b/src/modules/materials_inventory/in_out/materials_in_out.service.ts
new file mode 100644
index 0000000..5cc4ef6
--- /dev/null
+++ b/src/modules/materials_inventory/in_out/materials_in_out.service.ts
@@ -0,0 +1,465 @@
+import { Injectable } from '@nestjs/common';
+import { InjectEntityManager, InjectRepository } from '@nestjs/typeorm';
+
+import { Between, EntityManager, In, Repository } from 'typeorm';
+import { Pagination } from '~/helper/paginate/pagination';
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { paginate } from '~/helper/paginate';
+import { Storage } from '~/modules/tools/storage/storage.entity';
+import {
+ MaterialsInOutQueryDto,
+ MaterialsInOutDto,
+ MaterialsInOutUpdateDto,
+ MaterialsInOutExportDto
+} from './materials_in_out.dto';
+import { MaterialsInOutEntity } from './materials_in_out.entity';
+import { fieldSearch } from '~/shared/database/field-search';
+import { ParamConfigEntity } from '~/modules/system/param-config/param-config.entity';
+import { MaterialsInOrOutEnum, ParamConfigEnum } from '~/constants/enum';
+import { MaterialsInventoryEntity } from '../materials_inventory.entity';
+import { MaterialsInventoryService } from '../materials_inventory.service';
+import { isDefined } from 'class-validator';
+import { FastifyReply } from 'fastify';
+import * as ExcelJS from 'exceljs';
+import dayjs from 'dayjs';
+@Injectable()
+export class MaterialsInOutService {
+ constructor(
+ @InjectEntityManager() private entityManager: EntityManager,
+ @InjectRepository(MaterialsInOutEntity)
+ private materialsInOutRepository: Repository,
+ @InjectRepository(Storage)
+ private storageRepository: Repository,
+ @InjectRepository(ParamConfigEntity)
+ private paramConfigRepository: Repository,
+ private materialsInventoryService: MaterialsInventoryService
+ ) { }
+
+
+ /**
+ * 导出出入库记录表
+ */
+ async exportMaterialsInventoryCheck(
+ { time, domain, filename, ...ext }: MaterialsInOutExportDto,
+ res: FastifyReply
+ ): Promise {
+ const ROW_HEIGHT = 20;
+ const HEADER_FONT_SIZE = 18;
+
+ // 生成数据
+ const sqb = this.buildSearchQuery()
+ .where(fieldSearch(ext))
+ .andWhere({
+ time: Between(time[0], time[1])
+ })
+ .andWhere('materialsInOut.isDelete = 0');
+ const data = await sqb.addOrderBy('materialsInOut.time', 'DESC').getMany();
+ const workbook = new ExcelJS.Workbook();
+ const sheet = workbook.addWorksheet('出入库记录');
+ sheet.mergeCells('A1:T1');
+ // 设置标题
+ sheet.getCell('A1').value = '山东矿机华信智能科技有限公司出入库记录表';
+ // 设置日期
+ sheet.mergeCells('A2:C2');
+ sheet.getCell('A2').value = `日期：${dayjs(time[0]).format('YYYY年M月D日')}-${dayjs(time[1]).format('YYYY年M月D日')}`;
+ // 设置表头
+ const headers = [
+ '出入库单号',
+ '出入库',
+ '项目',
+ '公司名称',
+ '产品名称',
+ '规格型号',
+ '时间',
+ '单位',
+ '数量',
+ '单价',
+ '金额',
+ '经办人',
+ '领料单号',
+ '备注'
+ ];
+ sheet.addRow(headers);
+ for (let index = 0; index < data.length; index++) {
+ const record = data[index];
+ sheet.addRow([
+ `${record.inventoryInOutNumber}`,
+ record.project?.name || '',
+ record.inOrOut === MaterialsInOrOutEnum.In ? '入库' : "出库",
+ record.product?.company?.name || '',
+ record.product?.name || '',
+ record.product?.productSpecification || '',
+ `${dayjs(record.time).format('YYYY-MM-DD HH:mm')}`,
+ record.product.unit.label || '',
+ record.quantity,
+ parseFloat(`${record.unitPrice || 0}`),
+ parseFloat(`${record.amount || 0}`),
+ `${record?.agent || ''}`,
+ record?.issuanceNumber || '',
+ record?.remark || ''
+ ]);
+ }
+ // 固定信息样式设定
+ sheet.eachRow((row, index) => {
+ if (index >= 3) {
+ row.alignment = { vertical: 'middle', horizontal: 'center' };
+ row.height = ROW_HEIGHT;
+ row.eachCell(cell => {
+ cell.border = {
+ top: { style: 'thin' },
+ left: { style: 'thin' },
+ bottom: { style: 'thin' },
+ right: { style: 'thin' }
+ };
+ });
+ }
+ });
+
+ sheet.columns.forEach((column, index: number) => {
+ let maxColumnLength = 0;
+ const autoWidth = ['B', 'C', 'S', 'U'];
+ if (String.fromCharCode(65 + index) === 'B') maxColumnLength = 20;
+ if (autoWidth.includes(String.fromCharCode(65 + index))) {
+ column.eachCell({ includeEmpty: true }, (cell, rowIndex) => {
+ if (rowIndex >= 5) {
+ const columnLength = `${cell.value || ''}`.length;
+ if (columnLength > maxColumnLength) {
+ maxColumnLength = columnLength;
+ }
+ }
+ });
+ column.width = maxColumnLength < 12 ? 12 : maxColumnLength; // Minimum width of 10
+ } else {
+ column.width = 12;
+ }
+ });
+ //读取buffer进行传输
+ const buffer = await workbook.xlsx.writeBuffer();
+ res
+ .header('Content-Type', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+ .header(
+ 'Content-Disposition',
+ `attachment; filename="${filename}.xls"`
+ )
+ .send(buffer);
+ }
+
+
+
+ /**
+ * 查询所有出入库记录
+ */
+ async findAll({
+ page,
+ pageSize,
+ product: productName,
+ projectId,
+ isCreateOut,
+ ...ext
+ }: MaterialsInOutQueryDto): Promise> {
+ const sqb = this.buildSearchQuery()
+ .where(fieldSearch(ext))
+ .andWhere('materialsInOut.isDelete = 0')
+ .addOrderBy('materialsInOut.createdAt', 'DESC');
+
+ if (productName) {
+ sqb.andWhere('product.name like :productName', { productName: `%${productName}%` });
+ }
+
+ if (projectId) {
+ sqb.andWhere('project.id = :projectId', { projectId });
+ }
+
+ if (isCreateOut) {
+ sqb.andWhere('materialsInOut.inOrOut = 0');
+ }
+ const pageData = await paginate(sqb, {
+ page,
+ pageSize
+ });
+ return pageData;
+ }
+
+ buildSearchQuery() {
+ return this.materialsInOutRepository
+ .createQueryBuilder('materialsInOut')
+ .leftJoin('materialsInOut.files', 'files')
+ .leftJoin('materialsInOut.project', 'project')
+ .leftJoin('materialsInOut.product', 'product')
+ .leftJoin('materialsInOut.inventory', 'inventory')
+ .leftJoin('product.unit', 'unit')
+ .leftJoin('product.files', 'productFiles')
+ .leftJoin('product.company', 'company')
+ .addSelect([
+ 'inventory.id',
+ 'inventory.position',
+ 'inventory.inventoryNumber',
+ 'files.id',
+ 'files.path',
+ 'project.name',
+ 'product.name',
+ 'product.productSpecification',
+ 'product.productNumber',
+ 'productFiles.id',
+ 'productFiles.path',
+ 'unit.label',
+ 'company.name'
+ ]);
+ }
+ /**
+ * 新增
+ */
+ async create(dto: MaterialsInOutDto): Promise {
+ let {
+ inOrOut,
+ inventoryInOutNumber,
+ projectId,
+ inventoryId,
+ position,
+ unitPrice,
+ quantity,
+ productId,
+ domain
+ } = dto;
+ inventoryInOutNumber = await this.generateInventoryInOutNumber(inOrOut);
+ let newRecordId;
+ await this.entityManager.transaction(async manager => {
+ delete dto.position;
+ // 1.更新增减库存
+ const inventoryEntity = await (
+ Object.is(inOrOut, MaterialsInOrOutEnum.In)
+ ? this.materialsInventoryService.inInventory.bind(this.materialsInventoryService)
+ : this.materialsInventoryService.outInventory.bind(this.materialsInventoryService)
+ )({ productId, quantity, unitPrice, projectId, inventoryId, position }, manager, domain);
+ // 2.生成出入库记录
+ const { id } = await manager.save(MaterialsInOutEntity, {
+ ...this.materialsInOutRepository.create({ ...dto, inventoryId: inventoryEntity?.id }),
+ inventoryInOutNumber
+ });
+ newRecordId = id;
+ });
+ return newRecordId;
+ }
+
+ /**
+ * 更新
+ */
+ async update(id: number, { fileIds, ...data }: Partial): Promise {
+ await this.entityManager.transaction(async manager => {
+ /* 暂时不允许更改金额和数量，以及不能影响库存变化， */
+ const entity = await manager.findOne(MaterialsInOutEntity, {
+ where: {
+ id
+ },
+ lock: { mode: 'pessimistic_write' }
+ });
+
+ // 修改入库记录的价格
+ // 1.会直接更改库存实际价格.(仅仅只能之前价格为0时可以修改)
+ // 2.会同步库存所有的出库记录，修改其单价和金额.
+ if (
+ Object.is(data.inOrOut, MaterialsInOrOutEnum.In) &&
+ isDefined(data.unitPrice) &&
+ Math.abs(Number(data.unitPrice) - Number(entity.unitPrice)) !== 0
+ ) {
+ if (entity.unitPrice != 0) {
+ throw new BusinessException(
+ ErrorEnum.MATERIALS_IN_OUT_UNIT_PRICE_MUST_ZERO_WHEN_MODIFIED
+ );
+ }
+ const outEntities = await manager.find(MaterialsInOutEntity, {
+ where: {
+ inventoryId: entity.inventoryId,
+ inOrOut: MaterialsInOrOutEnum.Out
+ }
+ });
+ if (outEntities?.length > 0) {
+ await manager.update(
+ MaterialsInOutEntity,
+ {
+ id: In(outEntities.map(item => item.id))
+ },
+ {
+ unitPrice: data.unitPrice,
+ amount: () => `quantity * ${data.unitPrice}`
+ }
+ );
+ }
+ await manager.update(MaterialsInventoryEntity, entity.inventoryId, {
+ unitPrice: data.unitPrice
+ });
+ }
+ // 修改入库时的项目，必须同步到库存项目中
+ if (
+ Object.is(data.inOrOut, MaterialsInOrOutEnum.In) &&
+ isDefined(data.projectId) &&
+ data.projectId != entity.projectId
+ ) {
+ await manager.update(MaterialsInventoryEntity, entity.inventoryId, {
+ projectId: data.projectId
+ });
+ }
+
+ // 暂时不允许修改数量
+ // let changedQuantity = 0;
+ // if (isDefined(data.quantity) && entity.quantity !== data.quantity) {
+ // if (entity.inOrOut === MaterialsInOrOutEnum.In) {
+ // // 入库减少等于出库
+ // if (data.quantity - entity.quantity < 0) {
+ // data.inOrOut = MaterialsInOrOutEnum.Out;
+ // } else {
+ // // 入库增多等于入库
+ // data.inOrOut = MaterialsInOrOutEnum.In;
+ // }
+ // } else {
+ // // 出库减少等于入库
+ // if (data.quantity - entity.quantity < 0) {
+ // data.inOrOut = MaterialsInOrOutEnum.In;
+ // } else {
+ // // 出库增多等于出库
+ // data.inOrOut = MaterialsInOrOutEnum.Out;
+ // }
+ // }
+ // changedQuantity = Math.abs(data.quantity - entity.quantity);
+ // }
+ // // 2.更新增减库存
+ // if (changedQuantity !== 0) {
+ // await (
+ // Object.is(data.inOrOut, MaterialsInOrOutEnum.In)
+ // ? this.materialsInventoryService.inInventory
+ // : this.materialsInventoryService.outInventory
+ // )(
+ // {
+ // productId: entity.productId,
+ // quantity: Math.abs(changedQuantity),
+ // unitPrice: undefined,
+ // projectId: entity.projectId
+ // },
+ // manager
+ // );
+ // }
+ // 完成所有业务逻辑后，更新出入库记录
+ await manager.update(MaterialsInOutEntity, id, {
+ ...data
+ });
+
+ if (fileIds?.length) {
+ const count = await this.storageRepository
+ .createQueryBuilder('storage')
+ .where('storage.id in(:fileIds)', { fileIds })
+ .getCount();
+ if (count !== fileIds?.length) {
+ throw new BusinessException(ErrorEnum.STORAGE_NOT_FOUND);
+ }
+ // 附件要批量插入
+ await manager
+ .createQueryBuilder()
+ .relation(MaterialsInOutEntity, 'files')
+ .of(id)
+ .add(fileIds);
+ }
+ });
+ }
+
+ /**
+ * 删除
+ */
+ async delete(id: number): Promise {
+ await this.entityManager.transaction(async manager => {
+ const entity = await manager.findOne(MaterialsInOutEntity, {
+ where: {
+ id,
+ isDelete: 0
+ },
+ lock: { mode: 'pessimistic_write' }
+ });
+ if (!entity) {
+ throw new BusinessException(ErrorEnum.MATERIALS_IN_OUT_NOT_FOUND);
+ }
+
+ // 更新库存
+ await (
+ Object.is(entity.inOrOut, MaterialsInOrOutEnum.In)
+ ? this.materialsInventoryService.outInventory.bind(this.materialsInventoryService)
+ : this.materialsInventoryService.inInventory.bind(this.materialsInventoryService)
+ )(
+ {
+ quantity: entity.quantity,
+ inventoryId: entity.inventoryId
+ },
+ manager
+ );
+ });
+
+ // 出入库比较重要，做逻辑删除
+ await this.materialsInOutRepository.update(id, { isDelete: 1 });
+ }
+
+ /**
+ * 获取单个出入库信息
+ */
+ async info(id: number) {
+ const info = await this.buildSearchQuery()
+ .where({
+ id
+ })
+ .andWhere('materialsInOut.isDelete = 0')
+ .getOne();
+ return info;
+ }
+
+ /**
+ * 解除附件关联
+ * @param id 出入库ID
+ * @param fileIds 附件ID
+ */
+ async unlinkAttachments(id: number, fileIds: number[]) {
+ await this.entityManager.transaction(async manager => {
+ const materialsInOut = await this.materialsInOutRepository
+ .createQueryBuilder('materialsInOut')
+ .leftJoinAndSelect('materialsInOut.files', 'files')
+ .where('materialsInOut.id = :id', { id })
+ .getOne();
+ const linkedFiles = materialsInOut.files
+ .map(item => item.id)
+ .filter(item => !fileIds.includes(item));
+ // 附件要批量更新
+ await manager
+ .createQueryBuilder()
+ .relation(MaterialsInOutEntity, 'files')
+ .of(id)
+ .addAndRemove(linkedFiles, materialsInOut.files);
+ });
+ }
+
+ /**
+ * 生成库存出入库单号
+ * @returns 库存出入库单号
+ */
+ async generateInventoryInOutNumber(inOrOut: MaterialsInOrOutEnum = MaterialsInOrOutEnum.In) {
+ const prefix =
+ (
+ await this.paramConfigRepository.findOne({
+ where: {
+ key: inOrOut
+ ? ParamConfigEnum.InventoryInOutNumberPrefixOut
+ : ParamConfigEnum.InventoryInOutNumberPrefixIn
+ }
+ })
+ )?.value || '';
+ const lastMaterial = await this.materialsInOutRepository
+ .createQueryBuilder('materialsInOut')
+ .select(
+ `MAX(CAST(REPLACE(materialsInOut.inventoryInOutNumber, '${prefix}', '') AS UNSIGNED))`,
+ 'maxInventoryInOutNumber'
+ )
+ .where('materialsInOut.inOrOut = :inOrOut', { inOrOut })
+ .getRawOne();
+ const lastNumber = lastMaterial.maxInventoryInOutNumber
+ ? parseInt(lastMaterial.maxInventoryInOutNumber.replace(prefix, ''))
+ : 0;
+ const newNumber = lastNumber + 1 < 1000 ? 1000 : lastNumber + 1;
+ return `${prefix}${newNumber}`;
+ }
+}
diff --git a/src/modules/materials_inventory/materials_inventory.controller.ts b/src/modules/materials_inventory/materials_inventory.controller.ts
new file mode 100644
index 0000000..8e53f13
--- /dev/null
+++ b/src/modules/materials_inventory/materials_inventory.controller.ts
@@ -0,0 +1,80 @@
+import { Body, Controller, Delete, Get, Param, Post, Put, Query, Res } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiResult } from '~/common/decorators/api-result.decorator';
+import { IdParam } from '~/common/decorators/id-param.decorator';
+import { Perm, definePermission } from '../auth/decorators/permission.decorator';
+import {
+ MaterialsInventoryQueryDto,
+ MaterialsInventoryDto,
+ MaterialsInventoryUpdateDto,
+ MaterialsInventoryExportDto
+} from '../materials_inventory/materials_inventory.dto';
+import { MaterialsInventoryService } from './materials_inventory.service';
+import { MaterialsInventoryEntity } from './materials_inventory.entity';
+import { ApiSecurityAuth } from '~/common/decorators/swagger.decorator';
+import { FastifyReply } from 'fastify';
+import { Domain, DomainType, SkDomain } from '~/common/decorators/domain.decorator';
+
+export const permissions = definePermission('app:materials_inventory', {
+ LIST: 'list',
+ CREATE: 'create',
+ READ: 'read',
+ UPDATE: 'update',
+ DELETE: 'delete',
+ EXPORT: 'export'
+} as const);
+
+@ApiTags('MaterialsI Inventory - 原材料库存')
+@ApiSecurityAuth()
+@Controller('materials-inventory')
+export class MaterialsInventoryController {
+ constructor(private miService: MaterialsInventoryService) {}
+
+ @Get('export')
+ @ApiOperation({ summary: '导出原材料盘点表' })
+ @Perm(permissions.EXPORT)
+ async exportMaterialsInventoryCheck(
+ @Domain() domain: SkDomain,
+ @Query() dto: MaterialsInventoryExportDto,
+ @Res() res: FastifyReply
+ ): Promise {
+ await this.miService.exportMaterialsInventoryCheck({ ...dto, domain }, res);
+ }
+
+ @Get()
+ @ApiOperation({ summary: '获取原材料库存列表' })
+ @ApiResult({ type: [MaterialsInventoryEntity], isPage: true })
+ @Perm(permissions.LIST)
+ async list(@Domain() domain: SkDomain, @Query() dto: MaterialsInventoryQueryDto) {
+ return this.miService.findAll({ ...dto, domain });
+ }
+
+ @Get(':id')
+ @ApiOperation({ summary: '获取原材料库存信息' })
+ @ApiResult({ type: MaterialsInventoryDto })
+ @Perm(permissions.READ)
+ async info(@IdParam() id: number) {
+ return this.miService.info(id);
+ }
+
+ @Post()
+ @ApiOperation({ summary: '新增原材料库存' })
+ @Perm(permissions.CREATE)
+ async create(@Body() dto: MaterialsInventoryDto): Promise {
+ await this.miService.create(dto);
+ }
+
+ @Put(':id')
+ @ApiOperation({ summary: '更新原材料库存' })
+ @Perm(permissions.UPDATE)
+ async update(@IdParam() id: number, @Body() dto: MaterialsInventoryUpdateDto): Promise {
+ await this.miService.update(id, dto);
+ }
+
+ @Delete(':id')
+ @ApiOperation({ summary: '删除原材料库存' })
+ @Perm(permissions.DELETE)
+ async delete(@IdParam() id: number): Promise {
+ await this.miService.delete(id);
+ }
+}
diff --git a/src/modules/materials_inventory/materials_inventory.dto.ts b/src/modules/materials_inventory/materials_inventory.dto.ts
new file mode 100644
index 0000000..b05e466
--- /dev/null
+++ b/src/modules/materials_inventory/materials_inventory.dto.ts
@@ -0,0 +1,74 @@
+import { ApiProperty, IntersectionType, PartialType } from '@nestjs/swagger';
+import {
+ IsArray,
+ IsDate,
+ IsDateString,
+ IsEnum,
+ IsIn,
+ IsInt,
+ IsNumber,
+ IsOptional,
+ IsString,
+ Matches,
+ MinLength
+} from 'class-validator';
+import { PagerDto } from '~/common/dto/pager.dto';
+import { Storage } from '../tools/storage/storage.entity';
+import { Transform } from 'class-transformer';
+import dayjs from 'dayjs';
+import { formatToDate } from '~/utils';
+import { HasInventoryStatusEnum } from '~/constants/enum';
+import { DomainType } from '~/common/decorators/domain.decorator';
+
+export class MaterialsInventoryDto extends DomainType {}
+
+export class MaterialsInventoryUpdateDto extends PartialType(MaterialsInventoryDto) {}
+export class MaterialsInventoryQueryDto extends IntersectionType(
+ PagerDto,
+ PartialType(MaterialsInventoryDto),
+ DomainType
+) {
+ @ApiProperty({ description: '产品名' })
+ @IsOptional()
+ @IsString()
+ product: string;
+
+ @ApiProperty({ description: '关键字' })
+ @IsOptional()
+ @IsString()
+ keyword: string;
+
+ @ApiProperty({ description: '产品名' })
+ @IsOptional()
+ @IsEnum(HasInventoryStatusEnum)
+ isHasInventory: HasInventoryStatusEnum;
+
+ @ApiProperty({ description: '项目Id' })
+ @IsOptional()
+ @IsNumber()
+ projectId: number;
+}
+export class MaterialsInventoryExportDto extends DomainType {
+ @ApiProperty({ description: '项目' })
+ @IsOptional()
+ @IsNumber()
+ projectId: number;
+
+ @ApiProperty({ description: '导出时间YYYY-MM-DD' })
+ @IsOptional()
+ @IsArray()
+ @Transform(params => {
+ // 开始和结束时间用的是一月的开始和一月的结束的时分秒
+ const date = params.value;
+ return [
+ date ? `${date[0]} 00:00:00` : null,
+ date ? `${date[1]} 23:59:59` : null
+ ];
+ })
+ time?: string[];
+
+ @ApiProperty({ description: '文件名' })
+ @IsOptional()
+ @IsString()
+ filename: string;
+}
diff --git a/src/modules/materials_inventory/materials_inventory.entity.ts b/src/modules/materials_inventory/materials_inventory.entity.ts
new file mode 100644
index 0000000..0625be9
--- /dev/null
+++ b/src/modules/materials_inventory/materials_inventory.entity.ts
@@ -0,0 +1,98 @@
+import { ApiHideProperty, ApiProperty } from '@nestjs/swagger';
+import {
+ Column,
+ Entity,
+ JoinColumn,
+ JoinTable,
+ ManyToMany,
+ ManyToOne,
+ OneToMany,
+ Relation
+} from 'typeorm';
+import { CommonEntity } from '~/common/entity/common.entity';
+import { ProductEntity } from '../product/product.entity';
+import { ProjectEntity } from '../project/project.entity';
+import { MaterialsInOutEntity } from './in_out/materials_in_out.entity';
+import { SkDomain } from '~/common/decorators/domain.decorator';
+
+@Entity({ name: 'materials_inventory' })
+export class MaterialsInventoryEntity extends CommonEntity {
+ @Column({
+ name: 'project_id',
+ type: 'int',
+ comment: '项目'
+ })
+ @ApiProperty({ description: '项目' })
+ projectId: number;
+
+ @Column({
+ name: 'product_id',
+ type: 'int',
+ comment: '产品'
+ })
+ @ApiProperty({ description: '产品' })
+ productId: number;
+
+ @Column({
+ name: 'position',
+ type: 'varchar',
+ length: 255,
+ nullable: true,
+ comment: '库存位置'
+ })
+ @ApiProperty({ description: '库存位置' })
+ position: string;
+
+ @Column({
+ name: 'quantity',
+ type: 'int',
+ default: 0,
+ comment: '库存产品数量'
+ })
+ @ApiProperty({ description: '库存产品数量' })
+ quantity: number;
+
+ @Column({
+ name: 'unit_price',
+ type: 'decimal',
+ precision: 15,
+ default: 0,
+ scale: 10,
+ comment: '库存产品单价'
+ })
+ @ApiProperty({ description: '库存产品单价' })
+ unitPrice: number;
+
+ @Column({ name: 'remark', type: 'varchar', length: 255, comment: '备注', nullable: true })
+ @ApiProperty({ description: '备注' })
+ remark: string;
+
+ @Column({ name: 'is_delete', type: 'tinyint', default: 0, comment: '是否删除' })
+ @ApiProperty({ description: '删除状态：0未删除，1已删除' })
+ isDelete: number;
+
+ @Column({ type: 'int', default: 1, comment: '所属域' })
+ @ApiProperty({ description: '所属域' })
+ domain: SkDomain;
+
+ @ManyToOne(() => ProjectEntity)
+ @JoinColumn({ name: 'project_id' })
+ project: ProjectEntity;
+
+ @ManyToOne(() => ProductEntity)
+ @JoinColumn({ name: 'product_id' })
+ product: ProductEntity;
+
+ @Column({
+ name: 'inventory_number',
+ type: 'varchar',
+ length: 50,
+ comment: '库存编号'
+ })
+ @ApiProperty({ description: '库存编号' })
+ inventoryNumber: string;
+
+ @ApiHideProperty()
+ @OneToMany(() => MaterialsInOutEntity, inout => inout.inventory)
+ materialsInOuts: Relation;
+}
diff --git a/src/modules/materials_inventory/materials_inventory.module.ts b/src/modules/materials_inventory/materials_inventory.module.ts
new file mode 100644
index 0000000..4e9aee3
--- /dev/null
+++ b/src/modules/materials_inventory/materials_inventory.module.ts
@@ -0,0 +1,24 @@
+import { Module } from '@nestjs/common';
+import { MaterialsInventoryController } from './materials_inventory.controller';
+import { MaterialsInventoryService } from './materials_inventory.service';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { MaterialsInventoryEntity } from './materials_inventory.entity';
+import { StorageModule } from '../tools/storage/storage.module';
+import { MaterialsInOutController } from './in_out/materials_in_out.controller';
+import { MaterialsInOutService } from './in_out/materials_in_out.service';
+import { MaterialsInOutEntity } from './in_out/materials_in_out.entity';
+import { ParamConfigModule } from '../system/param-config/param-config.module';
+import { ProjectModule } from '../project/project.module';
+import { ProjectEntity } from '../project/project.entity';
+
+@Module({
+ imports: [
+ TypeOrmModule.forFeature([MaterialsInventoryEntity, MaterialsInOutEntity,ProjectEntity]),
+ ParamConfigModule,
+ StorageModule,
+ ProjectModule
+ ],
+ controllers: [MaterialsInventoryController, MaterialsInOutController],
+ providers: [MaterialsInventoryService, MaterialsInOutService]
+})
+export class MaterialsInventoryModule {}
diff --git a/src/modules/materials_inventory/materials_inventory.service.ts b/src/modules/materials_inventory/materials_inventory.service.ts
new file mode 100644
index 0000000..a8b0516
--- /dev/null
+++ b/src/modules/materials_inventory/materials_inventory.service.ts
@@ -0,0 +1,571 @@
+import { Injectable } from '@nestjs/common';
+import { InjectEntityManager, InjectRepository } from '@nestjs/typeorm';
+import { MaterialsInventoryEntity } from './materials_inventory.entity';
+import { EntityManager, In, MoreThan, Repository } from 'typeorm';
+import {
+ MaterialsInventoryDto,
+ MaterialsInventoryExportDto,
+ MaterialsInventoryQueryDto,
+ MaterialsInventoryUpdateDto
+} from './materials_inventory.dto';
+import { Pagination } from '~/helper/paginate/pagination';
+import { FastifyReply } from 'fastify';
+import { paginate } from '~/helper/paginate';
+import * as ExcelJS from 'exceljs';
+import dayjs from 'dayjs';
+import { MaterialsInOutEntity } from './in_out/materials_in_out.entity';
+import { fieldSearch } from '~/shared/database/field-search';
+import { groupBy, sum, uniqBy } from 'lodash';
+import { HasInventoryStatusEnum, MaterialsInOrOutEnum, ParamConfigEnum } from '~/constants/enum';
+import { ProjectEntity } from '../project/project.entity';
+import { calcNumber } from '~/utils';
+import { BusinessException } from '~/common/exceptions/biz.exception';
+import { ErrorEnum } from '~/constants/error-code.constant';
+import { ParamConfigEntity } from '../system/param-config/param-config.entity';
+import { isDefined } from 'class-validator';
+import { DomainType } from '~/common/decorators/domain.decorator';
+@Injectable()
+export class MaterialsInventoryService {
+ constructor(
+ @InjectEntityManager() private entityManager: EntityManager,
+ @InjectRepository(MaterialsInventoryEntity)
+ private materialsInventoryRepository: Repository,
+ @InjectRepository(MaterialsInOutEntity)
+ private materialsInOutRepository: Repository,
+ @InjectRepository(ProjectEntity)
+ private projectRepository: Repository,
+ @InjectRepository(ParamConfigEntity)
+ private paramConfigRepository: Repository
+ ) { }
+
+ /**
+ * 导出原材料盘点表
+ */
+ async exportMaterialsInventoryCheck(
+ { time, projectId, domain }: MaterialsInventoryExportDto,
+ res: FastifyReply
+ ): Promise {
+ const ROW_HEIGHT = 20;
+ const HEADER_FONT_SIZE = 18;
+ const workbook = new ExcelJS.Workbook();
+ let projects: ProjectEntity[] = [];
+ if (projectId) {
+ projects = [await this.projectRepository.findOneBy({ id: projectId })];
+ }
+ // 查询出项目产品所属的当前库存
+ const inventoriesInProjects = await this.materialsInventoryRepository.find({
+ where: {
+ ...(projects?.length ? { projectId: In(projects.map(item => item.id)) } : null)
+ },
+ relations: ['product', 'product.company', 'product.unit']
+ });
+
+ // 生成数据
+ const sqb = this.materialsInOutRepository
+ .createQueryBuilder('mio')
+ .leftJoin('mio.project', 'project')
+ .leftJoin('mio.product', 'product')
+ .leftJoin('product.unit', 'unit')
+ .leftJoin('product.company', 'company')
+ .addSelect([
+ 'project.id',
+ 'project.name',
+ 'unit.label',
+ 'company.name',
+ 'product.name',
+ 'product.productSpecification',
+ 'product.productNumber'
+ ])
+ .where({
+ time: MoreThan(time[0])
+ })
+ .andWhere('mio.isDelete = 0');
+
+ if (projectId) {
+ sqb.andWhere('project.id = :projectId', { projectId });
+ }
+
+ const data = await sqb.addOrderBy('mio.time', 'DESC').getMany();
+ if (!projectId) {
+ projects = uniqBy(
+ data.filter(item => item.inOrOut === MaterialsInOrOutEnum.Out).map(item => item.project),
+ 'id'
+ );
+ }
+
+ for (const project of projects) {
+ const currentProjectInventories = inventoriesInProjects.filter(({ projectId }) =>
+ Object.is(projectId, project.id)
+ );
+ const currentProjectData = data.filter(
+ item => item.projectId === project.id || item.inOrOut === MaterialsInOrOutEnum.Out
+ );
+ const currentMonthProjectData = currentProjectData.filter(item => {
+ return (
+ dayjs(item.time).isAfter(dayjs(time[0])) && dayjs(item.time).isBefore(dayjs(time[1]))
+ );
+ });
+ const sheet = workbook.addWorksheet(project.name);
+ sheet.mergeCells('A1:T1');
+ // 设置标题
+ sheet.getCell('A1').value = '山东矿机华信智能科技有限公司原材料盘点表';
+ // 设置日期
+ sheet.mergeCells('A2:B2');
+ sheet.getCell('A2').value = `日期：${dayjs(time[0]).format('YYYY年M月')}`;
+ // 设置表头
+ const headers = [
+ '序号',
+ '公司名称',
+ '产品名称',
+ '单位',
+ '库存数量',
+ '单价',
+ '金额',
+ '',
+ '',
+ '',
+ '',
+ '',
+ '',
+ '',
+ '',
+ '结存数量',
+ '单价',
+ '金额',
+ '备注'
+ ];
+ sheet.addRow(headers);
+ sheet.addRow([
+ '',
+ '',
+ '',
+ '',
+ '',
+ '',
+ '',
+ '入库时间',
+ '数量',
+ '单价',
+ '金额',
+ '出库时间',
+ '数量',
+ '单价',
+ '金额',
+ '',
+ '',
+ '',
+ ''
+ ]);
+ for (let i = 1; i <= 7; i++) {
+ sheet.mergeCells(`${String.fromCharCode(64 + i)}3:${String.fromCharCode(64 + i)}4`);
+ }
+ // 入库
+ sheet.mergeCells('H3:K3');
+ sheet.getCell('H3').value = '入库';
+
+ // 出库
+ sheet.mergeCells('L3:O3');
+ sheet.getCell('L3').value = '出库';
+
+ for (let i = 8; i <= 15; i++) {
+ sheet.getCell(`${String.fromCharCode(64 + i)}4`).style.fill = {
+ type: 'pattern',
+ pattern: 'solid',
+ fgColor: { argb: 'FFFFC000' }
+ };
+ }
+
+ for (let i = 16; i <= 19; i++) {
+ sheet.mergeCells(`${String.fromCharCode(64 + i)}3:${String.fromCharCode(64 + i)}4`);
+ }
+
+ // 固定信息样式设定
+ sheet.eachRow((row, index) => {
+ row.alignment = { vertical: 'middle', horizontal: 'center' };
+ row.font = { bold: true };
+ row.height = ROW_HEIGHT;
+ if (index >= 3) {
+ row.eachCell(cell => {
+ cell.border = {
+ top: { style: 'thin' },
+ left: { style: 'thin' },
+ bottom: { style: 'thin' },
+ right: { style: 'thin' }
+ };
+ });
+ }
+ });
+
+ // 根据库存Id分组
+ const groupedData = groupBy(
+ currentMonthProjectData,
+ record => record.inventoryId
+ );
+ let number = 0;
+ const groupedInventories = groupBy(currentProjectInventories, item => item.id);
+ let orderNo = 0;
+
+ for (const key in groupedInventories) {
+ orderNo++;
+ // 目前暂定逻辑出库只有一次或者没有出库。不会对一个入库的记录多次出库,故而用find。---废弃
+ // 2024.04.16 改成
+ const inventory = groupedInventories[key][0];
+ const outRecords = groupedData[key].filter(
+ item => item.inOrOut === MaterialsInOrOutEnum.Out
+ );
+ const inRecords = groupedData[key].filter(item => item.inOrOut === MaterialsInOrOutEnum.In);
+ const outRecordQuantity = outRecords
+ .map(item => item.quantity)
+ .reduce((acc, cur) => {
+ return calcNumber(acc, cur, 'add');
+ }, 0);
+
+ const inRecordQuantity = inRecords
+ .map(item => item.quantity)
+ .reduce((acc, cur) => {
+ return calcNumber(acc, cur, 'add');
+ }, 0);
+ // 这里的单价默认入库价格和出库价格一致，所以直接用总数量*入库单价
+ const outRecordAmount = calcNumber(outRecordQuantity, inventory.unitPrice || 0, 'multiply');
+ const inRecordAmount = calcNumber(inRecordQuantity, inventory.unitPrice || 0, 'multiply');
+ const currInventories = groupedInventories[key]?.shift();
+ const allDataFromMonth = data.filter(res => res.inventoryId == Number(key));
+ let currentQuantity = 0;
+ let balanceQuantity = 0;
+ // 月初库存数量
+ if (currInventories) {
+ const sumIn = sum(
+ allDataFromMonth
+ .filter(res => Object.is(res.inOrOut, MaterialsInOrOutEnum.In))
+ .map(item => item.quantity)
+ );
+ const sumOut = sum(
+ allDataFromMonth
+ .filter(res => Object.is(res.inOrOut, MaterialsInOrOutEnum.Out))
+ .map(item => item.quantity)
+ );
+ const sumDistance = calcNumber(sumIn, sumOut, 'subtract');
+ currentQuantity = calcNumber(currInventories.quantity, sumDistance, 'subtract');
+ }
+ // 结存库存数量
+ balanceQuantity = calcNumber(
+ currentQuantity,
+ calcNumber(inRecordQuantity, outRecordQuantity, 'subtract'),
+ 'add'
+ );
+ number++;
+ sheet.addRow([
+ `${orderNo}`,
+ inventory.product?.company?.name || '',
+ inventory.product?.name || '',
+ inventory.product.unit.label || '',
+ currentQuantity,
+ parseFloat(`${inventory.unitPrice || 0}`),
+ calcNumber(currentQuantity, inventory.unitPrice || 0, 'multiply'),
+ // inRecord.time,
+ '',
+ inRecordQuantity,
+ parseFloat(`${inventory.unitPrice || 0}`),
+ parseFloat(`${inRecordAmount}`),
+ // outRecord?.time || '',
+ '',
+ outRecordQuantity,
+ parseFloat(`${inventory?.unitPrice || 0}`),
+ parseFloat(`${outRecordAmount}`),
+ balanceQuantity,
+ parseFloat(`${inventory?.unitPrice || 0}`),
+ calcNumber(balanceQuantity, inventory?.unitPrice || 0, 'multiply'),
+ // `${inRecord?.agent || ''}/${outRecord?.agent || ''}`,
+ ''
+ ]);
+ }
+ sheet.getCell('A1').font = { size: HEADER_FONT_SIZE };
+
+ // 固定信息样式设定
+ sheet.eachRow((row, index) => {
+ if (index >= 5) {
+ row.alignment = { vertical: 'middle', horizontal: 'center' };
+ row.height = ROW_HEIGHT;
+ row.eachCell(cell => {
+ cell.border = {
+ top: { style: 'thin' },
+ left: { style: 'thin' },
+ bottom: { style: 'thin' },
+ right: { style: 'thin' }
+ };
+ });
+ }
+ });
+
+ sheet.columns.forEach((column, index: number) => {
+ let maxColumnLength = 0;
+ const autoWidth = ['B', 'C', 'S', 'U'];
+ if (String.fromCharCode(65 + index) === 'B') maxColumnLength = 20;
+ if (autoWidth.includes(String.fromCharCode(65 + index))) {
+ column.eachCell({ includeEmpty: true }, (cell, rowIndex) => {
+ if (rowIndex >= 5) {
+ const columnLength = `${cell.value || ''}`.length;
+ if (columnLength > maxColumnLength) {
+ maxColumnLength = columnLength;
+ }
+ }
+ });
+ column.width = maxColumnLength < 12 ? 12 : maxColumnLength; // Minimum width of 10
+ } else {
+ column.width = 12;
+ }
+ });
+ }
+ //读取buffer进行传输
+ const buffer = await workbook.xlsx.writeBuffer();
+ res
+ .header('Content-Type', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+ .header(
+ 'Content-Disposition',
+ `attachment; filename="${encodeURIComponent('导出_excel' + new Date().getTime() + '.xls')}"`
+ )
+ .send(buffer);
+ }
+
+ /**
+ * 查询所有盘点信息
+ */
+ async findAll({
+ page,
+ pageSize,
+ product,
+ keyword,
+ projectId,
+ isHasInventory,
+ domain
+ }: MaterialsInventoryQueryDto): Promise> {
+ const queryBuilder = this.materialsInventoryRepository
+ .createQueryBuilder('materialsInventory')
+ .leftJoin('materialsInventory.project', 'project')
+ .leftJoin('materialsInventory.product', 'product')
+ .leftJoin('product.unit', 'unit')
+ .leftJoin('product.company', 'company')
+ .addSelect([
+ 'project.name',
+ 'project.id',
+ 'unit.id',
+ 'unit.label',
+ 'company.id',
+ 'company.name',
+ 'product.id',
+ 'product.name',
+ 'product.productSpecification',
+ 'product.productNumber'
+ ])
+ .where(fieldSearch({ domain }))
+ .andWhere('materialsInventory.isDelete = 0');
+ if (product) {
+ queryBuilder.andWhere('product.name like :product', { product: `%${product}%` });
+ }
+
+ if (projectId) {
+ queryBuilder.andWhere('project.id = :projectId', { projectId });
+ }
+
+ if (keyword) {
+ queryBuilder.andWhere(
+ '(materialsInventory.inventoryNumber like :keyword or product.name like :keyword or product.productNumber like :keyword or product.productSpecification like :keyword)',
+ {
+ keyword: `%${keyword}%`
+ }
+ );
+ }
+ if (isHasInventory == HasInventoryStatusEnum.Yes) {
+ queryBuilder.andWhere('materialsInventory.quantity > 0');
+ }
+ if (isHasInventory == HasInventoryStatusEnum.No) {
+ queryBuilder.andWhere('materialsInventory.quantity = 0');
+ }
+ return paginate(queryBuilder, {
+ page,
+ pageSize
+ });
+ }
+
+ /**
+ * 新增库存
+ */
+ async create(dto: MaterialsInventoryDto): Promise {
+ await this.materialsInventoryRepository.insert(dto);
+ }
+
+ /**
+ * 更新库存
+ */
+ async update(id: number, data: Partial): Promise {
+ await this.entityManager.transaction(async manager => {
+ await manager.update(MaterialsInventoryEntity, id, {
+ ...data
+ });
+ });
+ }
+
+ /**
+ * 产品入库后计算最新库存
+ * 请注意。产品库存需要根据产品id和价格双主键存储。因为产品价格会变化，需要分开统计。
+ * @param data 传入项目ID,产品ID和入库数量和单价
+ * @param manager 传入事务对象防止开启多重事务
+ */
+ async inInventory(
+ data: {
+ position?: string;
+ projectId: number;
+ productId: number;
+ quantity: number;
+ inventoryId?: number;
+ unitPrice?: number;
+ changedUnitPrice?: number;
+ },
+ manager: EntityManager,
+ domain?: DomainType
+ ): Promise {
+ const {
+ projectId,
+ productId,
+ quantity: inQuantity,
+ unitPrice,
+ changedUnitPrice,
+ position,
+ inventoryId
+ } = data;
+ let searchPayload: any = {};
+ if (isDefined(inventoryId)) {
+ searchPayload = { id: inventoryId, domain };
+ } else {
+ searchPayload = { projectId, productId, unitPrice, domain };
+ }
+ const exsitedInventory = await manager.findOne(MaterialsInventoryEntity, {
+ where: searchPayload, // 根据项目，产品，价格查出之前的实时库存情况
+ lock: { mode: 'pessimistic_write' } // 开启悲观行锁，防止脏读和修改
+ });
+
+ // 若不存在库存，直接新增库存
+ if (!exsitedInventory) {
+ const inventoryNumber = await this.generateInventoryNumber();
+ const { raw } = await manager.insert(MaterialsInventoryEntity, {
+ projectId,
+ productId,
+ unitPrice,
+ inventoryNumber,
+ position,
+ quantity: inQuantity
+ });
+ return manager.findOne(MaterialsInventoryEntity, { where: { id: raw.insertId } });
+ }
+ // 若该项目存在库存，则该项目该产品的库存增加
+ let { quantity, id } = exsitedInventory;
+ const newQuantity = calcNumber(quantity || 0, inQuantity || 0, 'add');
+ if (isNaN(newQuantity)) {
+ throw new Error('库存数量不合法');
+ }
+ await manager.update(MaterialsInventoryEntity, id, {
+ quantity: newQuantity,
+ unitPrice: changedUnitPrice || undefined
+ });
+
+ return manager.findOne(MaterialsInventoryEntity, { where: { id } });
+ }
+
+ /**
+ * 产品出库
+ * @param data 传入库存ID(一定存在。)
+ * @param manager 传入事务对象防止开启多重事务
+ */
+ async outInventory(
+ data: {
+ quantity: number;
+ inventoryId?: number;
+ },
+ manager: EntityManager,
+ ): Promise {
+ const { quantity: outQuantity, inventoryId } = data;
+ // 开启悲观行锁，防止脏读和修改
+ const inventory = await manager.findOne(MaterialsInventoryEntity, {
+ where: { id: inventoryId },
+ lock: { mode: 'pessimistic_write' }
+ });
+ // 检查库存剩余
+ if (inventory.quantity < outQuantity) {
+ throw new BusinessException(ErrorEnum.INVENTORY_INSUFFICIENT);
+ }
+ // 若该项目的该产品库存充足，则该项目该产品的库存减少
+ let { quantity, id } = inventory;
+ const newQuantity = calcNumber(quantity || 0, outQuantity || 0, 'subtract');
+ if (isNaN(newQuantity)) {
+ throw new BusinessException(ErrorEnum.INVENTORY_INSUFFICIENT);
+ }
+ await manager.update(MaterialsInventoryEntity, id, {
+ quantity: newQuantity
+ });
+
+ return manager.findOne(MaterialsInventoryEntity, { where: { id } });
+ }
+
+ /**
+ * 删除
+ */
+ async delete(id: number): Promise {
+ // 比较重要，做逻辑删除
+ await this.materialsInventoryRepository.update(id, { isDelete: 1 });
+ }
+
+ /**
+ * 获取某个价格的某个商品库存信息
+ */
+ async info(id: number) {
+ const info = await this.materialsInventoryRepository
+ .createQueryBuilder('materialsInventory')
+ .leftJoin('materialsInventory.project', 'project')
+ .leftJoin('materialsInventory.product', 'product')
+ .leftJoin('product.unit', 'unit')
+ .leftJoin('product.company', 'company')
+ .addSelect([
+ 'project.name',
+ 'project.id',
+ 'product.id',
+ 'product.name',
+ 'unit.label',
+ 'company.name',
+ 'product.productSpecification',
+ 'product.productNumber'
+ ])
+ .where({
+ id
+ })
+ .andWhere('materialsInventory.isDelete = 0')
+ .getOne();
+ return info;
+ }
+
+ /**
+ * 生成库存编号
+ * @returns 库存编号
+ */
+ async generateInventoryNumber() {
+ const prefix =
+ (
+ await this.paramConfigRepository.findOne({
+ where: {
+ key: ParamConfigEnum.InventoryNumberPrefix
+ }
+ })
+ )?.value || '';
+ const lastInventory = await this.materialsInventoryRepository
+ .createQueryBuilder('materials_inventory')
+ .select(
+ `MAX(CAST(REPLACE(materials_inventory.inventoryNumber, '${prefix}', '') AS UNSIGNED))`,
+ 'maxInventoryNumber'
+ )
+ .getRawOne();
+ const lastNumber = lastInventory.maxInventoryNumber
+ ? parseInt(lastInventory.maxInventoryNumber.replace(prefix, ''))
+ : 0;
+ const newNumber = lastNumber + 1 < 1000 ? 1000 : lastNumber + 1;
+ return `${prefix}${newNumber}`;
+ }
+}
diff --git a/src/modules/netdisk/manager/manage-qiniu.service.ts b/src/modules/netdisk/manager/manage-qiniu.service.ts
new file mode 100644
index 0000000..3554b7b
--- /dev/null
+++ b/src/modules/netdisk/manager/manage-qiniu.service.ts
@@ -0,0 +1,836 @@
+import { basename, extname } from 'node:path';
+
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { isEmpty } from 'lodash';
+import * as qiniu from 'qiniu';
+import { auth, conf, rs } from 'qiniu';
+
+import { ConfigKeyPaths } from '~/config';
+import {
+ NETDISK_COPY_SUFFIX,
+ NETDISK_DELIMITER,
+ NETDISK_HANDLE_MAX_ITEM,
+ NETDISK_LIMIT
+} from '~/constants/oss.constant';
+
+import { AccountInfo } from '~/modules/user/user.model';
+import { UserService } from '~/modules/user/user.service';
+
+import { generateRandomValue } from '~/utils';
+
+import { SFileInfo, SFileInfoDetail, SFileList } from './manage.class';
+import { FileOpItem } from './manage.dto';
+
+@Injectable()
+export class QiNiuNetDiskManageService {
+ private config: conf.ConfigOptions;
+ private mac: auth.digest.Mac;
+ private bucketManager: rs.BucketManager;
+
+ private get qiniuConfig() {
+ return this.configService.get('oss', { infer: true });
+ }
+
+ constructor(
+ private configService: ConfigService,
+ private userService: UserService
+ ) {
+ this.mac = new qiniu.auth.digest.Mac(this.qiniuConfig.accessKey, this.qiniuConfig.secretKey);
+ this.config = new qiniu.conf.Config({
+ zone: this.qiniuConfig.zone
+ });
+ // bucket manager
+ this.bucketManager = new qiniu.rs.BucketManager(this.mac, this.config);
+ }
+
+ /**
+ * 获取文件列表
+ * @param prefix 当前文件夹路径，搜索模式下会被忽略
+ * @param marker 下一页标识
+ * @returns iFileListResult
+ */
+ async getFileList(prefix = '', marker = '', skey = ''): Promise {
+ // 是否需要搜索
+ const searching = !isEmpty(skey);
+ return new Promise((resolve, reject) => {
+ this.bucketManager.listPrefix(
+ this.qiniuConfig.bucket,
+ {
+ prefix: searching ? '' : prefix,
+ limit: NETDISK_LIMIT,
+ delimiter: searching ? '' : NETDISK_DELIMITER,
+ marker
+ },
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ // 如果这个nextMarker不为空，那么还有未列举完毕的文件列表，下次调用listPrefix的时候，
+ // 指定options里面的marker为这个值
+ const fileList: SFileInfo[] = [];
+ // 处理目录，但只有非搜索模式下可用
+ if (!searching && !isEmpty(respBody.commonPrefixes)) {
+ // dir
+ for (const dirPath of respBody.commonPrefixes) {
+ const name = (dirPath as string).substr(0, dirPath.length - 1).replace(prefix, '');
+ if (isEmpty(skey) || name.includes(skey)) {
+ fileList.push({
+ name: (dirPath as string).substr(0, dirPath.length - 1).replace(prefix, ''),
+ type: 'dir',
+ id: generateRandomValue(10)
+ });
+ }
+ }
+ }
+ // handle items
+ if (!isEmpty(respBody.items)) {
+ // file
+ for (const item of respBody.items) {
+ // 搜索模式下处理
+ if (searching) {
+ const pathList: string[] = item.key.split(NETDISK_DELIMITER);
+ // dir is empty stirng, file is key string
+ const name = pathList.pop();
+ if (
+ item.key.endsWith(NETDISK_DELIMITER) &&
+ pathList[pathList.length - 1].includes(skey)
+ ) {
+ // 结果是目录
+ const ditName = pathList.pop();
+ fileList.push({
+ id: generateRandomValue(10),
+ name: ditName,
+ type: 'dir',
+ belongTo: pathList.join(NETDISK_DELIMITER)
+ });
+ } else if (name.includes(skey)) {
+ // 文件
+ fileList.push({
+ id: generateRandomValue(10),
+ name,
+ type: 'file',
+ fsize: item.fsize,
+ mimeType: item.mimeType,
+ putTime: new Date(Number.parseInt(item.putTime) / 10000),
+ belongTo: pathList.join(NETDISK_DELIMITER)
+ });
+ }
+ } else {
+ // 正常获取列表
+ const fileKey = item.key.replace(prefix, '') as string;
+ if (!isEmpty(fileKey)) {
+ fileList.push({
+ id: generateRandomValue(10),
+ name: fileKey,
+ type: 'file',
+ fsize: item.fsize,
+ mimeType: item.mimeType,
+ putTime: new Date(Number.parseInt(item.putTime) / 10000)
+ });
+ }
+ }
+ }
+ }
+ resolve({
+ list: fileList,
+ marker: respBody.marker || null
+ });
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 获取文件信息
+ */
+ async getFileInfo(name: string, path: string): Promise {
+ return new Promise((resolve, reject) => {
+ this.bucketManager.stat(
+ this.qiniuConfig.bucket,
+ `${path}${name}`,
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ const detailInfo: SFileInfoDetail = {
+ fsize: respBody.fsize,
+ hash: respBody.hash,
+ md5: respBody.md5,
+ mimeType: respBody.mimeType.split('/x-qn-meta')[0],
+ putTime: new Date(Number.parseInt(respBody.putTime) / 10000),
+ type: respBody.type,
+ uploader: '',
+ mark: respBody?.['x-qn-meta']?.['!mark'] ?? ''
+ };
+ if (!respBody.endUser) {
+ resolve(detailInfo);
+ } else {
+ this.userService
+ .getAccountInfo(Number.parseInt(respBody.endUser))
+ .then((user: AccountInfo) => {
+ if (isEmpty(user)) {
+ resolve(detailInfo);
+ } else {
+ detailInfo.uploader = user.username;
+ resolve(detailInfo);
+ }
+ });
+ }
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 修改文件MimeType
+ */
+ async changeFileHeaders(
+ name: string,
+ path: string,
+ headers: { [k: string]: string }
+ ): Promise {
+ return new Promise((resolve, reject) => {
+ this.bucketManager.changeHeaders(
+ this.qiniuConfig.bucket,
+ `${path}${name}`,
+ headers,
+ (err, _, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 创建文件夹
+ * @returns true创建成功
+ */
+ async createDir(dirName: string): Promise {
+ const safeDirName = dirName.endsWith('/') ? dirName : `${dirName}/`;
+ return new Promise((resolve, reject) => {
+ // 上传一个空文件以用于显示文件夹效果
+ const formUploader = new qiniu.form_up.FormUploader(this.config);
+ const putExtra = new qiniu.form_up.PutExtra();
+ formUploader.put(
+ this.createUploadToken(''),
+ safeDirName,
+ ' ',
+ putExtra,
+ (respErr, respBody, respInfo) => {
+ if (respErr) {
+ reject(respErr);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 检查文件是否存在，同可检查目录
+ */
+ async checkFileExist(filePath: string): Promise {
+ return new Promise((resolve, reject) => {
+ // fix path end must a /
+
+ // 检测文件夹是否存在
+ this.bucketManager.stat(this.qiniuConfig.bucket, filePath, (respErr, respBody, respInfo) => {
+ if (respErr) {
+ reject(respErr);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ // 文件夹存在
+ resolve(true);
+ } else if (respInfo.statusCode === 612) {
+ // 文件夹不存在
+ resolve(false);
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ });
+ });
+ }
+
+ /**
+ * 创建Upload Token, 默认过期时间一小时
+ * @returns upload token
+ */
+ createUploadToken(endUser: string): string {
+ const policy = new qiniu.rs.PutPolicy({
+ scope: this.qiniuConfig.bucket,
+ insertOnly: 1,
+ fsizeLimit: 1024 ** 2 * 10,
+ endUser
+ });
+ const uploadToken = policy.uploadToken(this.mac);
+ return uploadToken;
+ }
+
+ /**
+ * 重命名文件
+ * @param dir 文件路径
+ * @param name 文件名称
+ */
+ async renameFile(dir: string, name: string, toName: string): Promise {
+ const fileName = `${dir}${name}`;
+ const toFileName = `${dir}${toName}`;
+ const op = {
+ force: true
+ };
+ return new Promise((resolve, reject) => {
+ this.bucketManager.move(
+ this.qiniuConfig.bucket,
+ fileName,
+ this.qiniuConfig.bucket,
+ toFileName,
+ op,
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ } else {
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`
+ )
+ );
+ }
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 移动文件
+ */
+ async moveFile(dir: string, toDir: string, name: string): Promise {
+ const fileName = `${dir}${name}`;
+ const toFileName = `${toDir}${name}`;
+ const op = {
+ force: true
+ };
+ return new Promise((resolve, reject) => {
+ this.bucketManager.move(
+ this.qiniuConfig.bucket,
+ fileName,
+ this.qiniuConfig.bucket,
+ toFileName,
+ op,
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ } else {
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`
+ )
+ );
+ }
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 复制文件
+ */
+ async copyFile(dir: string, toDir: string, name: string): Promise {
+ const fileName = `${dir}${name}`;
+ // 拼接文件名
+ const ext = extname(name);
+ const bn = basename(name, ext);
+ const toFileName = `${toDir}${bn}${NETDISK_COPY_SUFFIX}${ext}`;
+ const op = {
+ force: true
+ };
+ return new Promise((resolve, reject) => {
+ this.bucketManager.copy(
+ this.qiniuConfig.bucket,
+ fileName,
+ this.qiniuConfig.bucket,
+ toFileName,
+ op,
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ } else {
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`
+ )
+ );
+ }
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 重命名文件夹
+ */
+ async renameDir(path: string, name: string, toName: string): Promise {
+ const dirName = `${path}${name}`;
+ const toDirName = `${path}${toName}`;
+ let hasFile = true;
+ let marker = '';
+ const op = {
+ force: true
+ };
+ const bucketName = this.qiniuConfig.bucket;
+ while (hasFile) {
+ await new Promise((resolve, reject) => {
+ // 列举当前目录下的所有文件
+ this.bucketManager.listPrefix(
+ this.qiniuConfig.bucket,
+ {
+ prefix: dirName,
+ limit: NETDISK_HANDLE_MAX_ITEM,
+ marker
+ },
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ const moveOperations = respBody.items.map(item => {
+ const { key } = item;
+ const destKey = key.replace(dirName, toDirName);
+ return qiniu.rs.moveOp(bucketName, key, bucketName, destKey, op);
+ });
+ this.bucketManager.batch(moveOperations, (err2, respBody2, respInfo2) => {
+ if (err2) {
+ reject(err2);
+ return;
+ }
+ if (respInfo2.statusCode === 200) {
+ if (isEmpty(respBody.marker)) hasFile = false;
+ else marker = respBody.marker;
+
+ resolve();
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo2.statusCode}, Info: ${respInfo2.statusMessage}`
+ )
+ );
+ }
+ });
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`
+ )
+ );
+ }
+ }
+ );
+ });
+ }
+ }
+
+ /**
+ * 获取七牛下载的文件url链接
+ * @param key 文件路径
+ * @returns 连接
+ */
+ getDownloadLink(key: string): string {
+ if (this.qiniuConfig.access === 'public') {
+ return this.bucketManager.publicDownloadUrl(this.qiniuConfig.domain, key);
+ } else if (this.qiniuConfig.access === 'private') {
+ return this.bucketManager.privateDownloadUrl(
+ this.qiniuConfig.domain,
+ key,
+ Date.now() / 1000 + 36000
+ );
+ }
+ throw new Error('qiniu config access type not support');
+ }
+
+ /**
+ * 删除文件
+ * @param dir 删除的文件夹目录
+ * @param name 文件名
+ */
+ async deleteFile(dir: string, name: string): Promise {
+ return new Promise((resolve, reject) => {
+ this.bucketManager.delete(
+ this.qiniuConfig.bucket,
+ `${dir}${name}`,
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ }
+ );
+ });
+ }
+
+ /**
+ * 删除文件夹
+ * @param dir 文件夹所在的上级目录
+ * @param name 文件目录名称
+ */
+ async deleteMultiFileOrDir(fileList: FileOpItem[], dir: string): Promise {
+ const files = fileList.filter(item => item.type === 'file');
+ if (files.length > 0) {
+ // 批处理文件
+ const copyOperations = files.map(item => {
+ const fileName = `${dir}${item.name}`;
+ return qiniu.rs.deleteOp(this.qiniuConfig.bucket, fileName);
+ });
+ await new Promise((resolve, reject) => {
+ this.bucketManager.batch(copyOperations, (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else if (respInfo.statusCode === 298) {
+ reject(new Error('操作异常，但部分文件夹删除成功'));
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ });
+ });
+ }
+ // 处理文件夹
+ const dirs = fileList.filter(item => item.type === 'dir');
+ if (dirs.length > 0) {
+ // 处理文件夹的复制
+ for (let i = 0; i < dirs.length; i++) {
+ const dirName = `${dir}${dirs[i].name}/`;
+ let hasFile = true;
+ let marker = '';
+ while (hasFile) {
+ await new Promise((resolve, reject) => {
+ // 列举当前目录下的所有文件
+ this.bucketManager.listPrefix(
+ this.qiniuConfig.bucket,
+ {
+ prefix: dirName,
+ limit: NETDISK_HANDLE_MAX_ITEM,
+ marker
+ },
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ const moveOperations = respBody.items.map(item => {
+ const { key } = item;
+ return qiniu.rs.deleteOp(this.qiniuConfig.bucket, key);
+ });
+ this.bucketManager.batch(moveOperations, (err2, respBody2, respInfo2) => {
+ if (err2) {
+ reject(err2);
+ return;
+ }
+ if (respInfo2.statusCode === 200) {
+ if (isEmpty(respBody.marker)) hasFile = false;
+ else marker = respBody.marker;
+
+ resolve();
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo2.statusCode}, Info: ${respInfo2.statusMessage}`
+ )
+ );
+ }
+ });
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`
+ )
+ );
+ }
+ }
+ );
+ });
+ }
+ }
+ }
+ }
+
+ /**
+ * 复制文件，含文件夹
+ */
+ async copyMultiFileOrDir(fileList: FileOpItem[], dir: string, toDir: string): Promise {
+ const files = fileList.filter(item => item.type === 'file');
+ const op = {
+ force: true
+ };
+ if (files.length > 0) {
+ // 批处理文件
+ const copyOperations = files.map(item => {
+ const fileName = `${dir}${item.name}`;
+ // 拼接文件名
+ const ext = extname(item.name);
+ const bn = basename(item.name, ext);
+ const toFileName = `${toDir}${bn}${NETDISK_COPY_SUFFIX}${ext}`;
+ return qiniu.rs.copyOp(
+ this.qiniuConfig.bucket,
+ fileName,
+ this.qiniuConfig.bucket,
+ toFileName,
+ op
+ );
+ });
+ await new Promise((resolve, reject) => {
+ this.bucketManager.batch(copyOperations, (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ resolve();
+ } else if (respInfo.statusCode === 298) {
+ reject(new Error('操作异常，但部分文件夹删除成功'));
+ } else {
+ reject(
+ new Error(`Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`)
+ );
+ }
+ });
+ });
+ }
+ // 处理文件夹
+ const dirs = fileList.filter(item => item.type === 'dir');
+ if (dirs.length > 0) {
+ // 处理文件夹的复制
+ for (let i = 0; i < dirs.length; i++) {
+ const dirName = `${dir}${dirs[i].name}/`;
+ const copyDirName = `${toDir}${dirs[i].name}${NETDISK_COPY_SUFFIX}/`;
+ let hasFile = true;
+ let marker = '';
+ while (hasFile) {
+ await new Promise((resolve, reject) => {
+ // 列举当前目录下的所有文件
+ this.bucketManager.listPrefix(
+ this.qiniuConfig.bucket,
+ {
+ prefix: dirName,
+ limit: NETDISK_HANDLE_MAX_ITEM,
+ marker
+ },
+ (err, respBody, respInfo) => {
+ if (err) {
+ reject(err);
+ return;
+ }
+ if (respInfo.statusCode === 200) {
+ const moveOperations = respBody.items.map(item => {
+ const { key } = item;
+ const destKey = key.replace(dirName, copyDirName);
+ return qiniu.rs.copyOp(
+ this.qiniuConfig.bucket,
+ key,
+ this.qiniuConfig.bucket,
+ destKey,
+ op
+ );
+ });
+ this.bucketManager.batch(moveOperations, (err2, respBody2, respInfo2) => {
+ if (err2) {
+ reject(err2);
+ return;
+ }
+ if (respInfo2.statusCode === 200) {
+ if (isEmpty(respBody.marker)) hasFile = false;
+ else marker = respBody.marker;
+
+ resolve();
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo2.statusCode}, Info: ${respInfo2.statusMessage}`
+ )
+ );
+ }
+ });
+ } else {
+ reject(
+ new Error(
+ `Qiniu Error Code: ${respInfo.statusCode}, Info: ${respInfo.statusMessage}`
+ )
+ );
+ }
+ }
+ );
+ });
+ }
+ }
+ }
+ }
+
+ /**
+ * 移动文件，含文件夹
+ */
+ async moveMultiFileOrDir(fileList: FileOpItem[], dir: string, toDir: string): Promise