@nest-omni/core 1.0.2 → 1.0.5

package/src/decorators/transform.decorators.ts

@@ -0,0 +1,147 @@
+import { Transform, TransformationType } from 'class-transformer';
+import { castArray, isArray, isNil, map, trim } from 'lodash';
+
+import { GeneratorProvider } from '../providers';
+import { parsePhoneNumber } from 'libphonenumber-js';
+
+/**
+ * @description trim spaces from start and end, replace multiple spaces with one.
+ * @example
+ * @ApiProperty()
+ * @IsString()
+ * @Trim()
+ * name: string;
+ * @returns PropertyDecorator
+ * @constructor
+ */
+export function Trim(): PropertyDecorator {
+  return Transform((params) => {
+    const value = params.value as string[] | string;
+
+    if (isArray(value)) {
+      return map(value, (v) => trim(v).replace(/\s\s+/g, ' '));
+    }
+
+    return trim(value).replace(/\s\s+/g, ' ');
+  });
+}
+
+export function ToBoolean(): PropertyDecorator {
+  return Transform(
+    (params) => {
+      switch (params.value) {
+        case 'true':
+          return true;
+        case 'false':
+          return false;
+        default:
+          return params.value;
+      }
+    },
+    { toClassOnly: true },
+  );
+}
+
+/**
+ * @description convert string or number to integer
+ * @example
+ * @NumberField()
+ * @ToInt()
+ * name: number;
+ * @returns PropertyDecorator
+ * @constructor
+ */
+export function ToInt(): PropertyDecorator {
+  return Transform(
+    (params) => {
+      const value = params.value as string;
+
+      return Number.parseInt(value, 10);
+    },
+    { toClassOnly: true },
+  );
+}
+
+/**
+ * @description transforms to array, specially for query params
+ * @example
+ * @NumberField()
+ * @ToArray()
+ * name: number;
+ * @constructor
+ */
+export function ToArray(): PropertyDecorator {
+  return Transform(
+    (params) => {
+      const value = params.value;
+
+      if (isNil(value)) {
+        return [];
+      }
+
+      return castArray(value);
+    },
+    { toClassOnly: true },
+  );
+}
+
+export function ToLowerCase(): PropertyDecorator {
+  return Transform(
+    (params) => {
+      const value = params.value;
+
+      if (!value) {
+        return;
+      }
+
+      if (!Array.isArray(value)) {
+        return value.toLowerCase();
+      }
+
+      return value.map((v) => v.toLowerCase());
+    },
+    {
+      toClassOnly: true,
+    },
+  );
+}
+
+export function ToUpperCase(): PropertyDecorator {
+  return Transform(
+    (params) => {
+      const value = params.value;
+
+      if (!value) {
+        return;
+      }
+
+      if (!Array.isArray(value)) {
+        return value.toUpperCase();
+      }
+
+      return value.map((v) => v.toUpperCase());
+    },
+    {
+      toClassOnly: true,
+    },
+  );
+}
+
+export function S3UrlParser(): PropertyDecorator {
+  return Transform((params) => {
+    const key = params.value as string;
+
+    switch (params.type) {
+      case TransformationType.CLASS_TO_PLAIN:
+        return GeneratorProvider.getS3PublicUrl(key);
+      case TransformationType.PLAIN_TO_CLASS:
+        return GeneratorProvider.getS3Key(key);
+      default:
+        return key;
+    }
+  });
+}
+
+export function PhoneNumberSerializer(): PropertyDecorator {
+  return Transform((params) => parsePhoneNumber(params.value as string).number);
+}

package/{dist → src}/decorators/translate.decorator.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DynamicTranslate = exports.StaticTranslate = exports.DYNAMIC_TRANSLATION_DECORATOR_KEY = exports.STATIC_TRANSLATION_DECORATOR_KEY = void 0;
 exports.STATIC_TRANSLATION_DECORATOR_KEY = 'custom:static-translate';
 exports.DYNAMIC_TRANSLATION_DECORATOR_KEY = 'custom:dynamic-translate';
+// FIXME: This is a temporary solution to get the translation decorator working.
 function StaticTranslate(data = {}) {
     return (target, key) => {
         Reflect.defineMetadata(exports.STATIC_TRANSLATION_DECORATOR_KEY, data, target, key);
@@ -15,4 +16,3 @@ function DynamicTranslate() {
     };
 }
 exports.DynamicTranslate = DynamicTranslate;
-//# sourceMappingURL=translate.decorator.js.map

package/src/decorators/translate.decorator.ts

@@ -0,0 +1,19 @@
+import type { ITranslationDecoratorInterface } from '../interfaces';
+
+export const STATIC_TRANSLATION_DECORATOR_KEY = 'custom:static-translate';
+export const DYNAMIC_TRANSLATION_DECORATOR_KEY = 'custom:dynamic-translate';
+
+// FIXME: This is a temporary solution to get the translation decorator working.
+export function StaticTranslate(
+  data: ITranslationDecoratorInterface = {},
+): PropertyDecorator {
+  return (target, key) => {
+    Reflect.defineMetadata(STATIC_TRANSLATION_DECORATOR_KEY, data, target, key);
+  };
+}
+
+export function DynamicTranslate(): PropertyDecorator {
+  return (target, key) => {
+    Reflect.defineMetadata(DYNAMIC_TRANSLATION_DECORATOR_KEY, {}, target, key);
+  };
+}

package/{dist → src}/decorators/use-dto.decorator.js

@@ -7,4 +7,3 @@ function UseDto(dtoClass) {
     };
 }
 exports.UseDto = UseDto;
-//# sourceMappingURL=use-dto.decorator.js.map

package/src/decorators/use-dto.decorator.ts

@@ -0,0 +1,11 @@
+import type { AbstractEntity } from '../common/abstract.entity';
+import type { AbstractDto } from '../common/dto/abstract.dto';
+import type { Constructor } from '../types';
+
+export function UseDto(
+  dtoClass: Constructor<AbstractDto, [AbstractEntity, unknown]>,
+): ClassDecorator {
+  return (ctor) => {
+    ctor.prototype.dtoClass = dtoClass;
+  };
+}

package/src/decorators/user-check.decorator.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserData = exports.User = void 0;
+const common_1 = require("@nestjs/common");
+const lodash = __importStar(require("lodash"));
+exports.User = (0, common_1.createParamDecorator)((data, ctx) => {
+    return getUserData(ctx.switchToHttp().getRequest(), data);
+});
+function getUserData(req, data) {
+    const headers = req.headers;
+    if (lodash.isEmpty(headers['x-userid']) ||
+        lodash.isEmpty(headers['x-username'])) {
+        return null;
+    }
+    const user = {
+        uid: headers['x-userid'],
+        username: headers['x-username'],
+    };
+    return data ? user[data] : user;
+}
+exports.getUserData = getUserData;

package/src/decorators/user-check.decorator.ts

@@ -0,0 +1,30 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import * as lodash from 'lodash';
+
+export interface IUser {
+  uid: number;
+  username: string;
+}
+
+export const User = createParamDecorator(
+  (data: string, ctx: ExecutionContext): IUser => {
+    return getUserData(ctx.switchToHttp().getRequest(), data);
+  },
+);
+
+export function getUserData(req, data?: string): IUser | null {
+  const headers = req.headers;
+  if (
+    lodash.isEmpty(headers['x-userid']) ||
+    lodash.isEmpty(headers['x-username'])
+  ) {
+    return null;
+  }
+
+  const user = {
+    uid: headers['x-userid'],
+    username: headers['x-username'],
+  };
+
+  return data ? user[data] : user;
+}

package/{dist → src}/decorators/user.decorator.js

@@ -1,8 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserData = exports.User = void 0;
 const common_1 = require("@nestjs/common");
-const lodash = require("lodash");
+const lodash = __importStar(require("lodash"));
 const config_1 = require("@nestjs/config");
 exports.User = (0, common_1.createParamDecorator)((data, ctx) => {
     return getUserData(ctx.switchToHttp().getRequest(), data);
@@ -14,6 +37,7 @@ function getUserData(req, data) {
         username: '',
     };
     const configService = new config_1.ConfigService(req);
+    // 未通过网关透传用户信息且处于local开发环境，则从配置获取用户信息
     if (lodash.isEmpty(headers['x-userid']) ||
         lodash.isEmpty(headers['x-username'])) {
         if (process.env.NODE_ENV === 'dev') {
@@ -36,4 +60,3 @@ function getUserData(req, data) {
     }
 }
 exports.getUserData = getUserData;
-//# sourceMappingURL=user.decorator.js.map

package/src/decorators/user.decorator.ts

@@ -0,0 +1,48 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import * as lodash from 'lodash';
+import { ConfigService } from '@nestjs/config';
+
+export interface IUser {
+  uid: number;
+  username: string;
+  tenantId?: string;
+  appId?: string;
+}
+
+export const User = createParamDecorator(
+  (data: string, ctx: ExecutionContext): IUser => {
+    return getUserData(ctx.switchToHttp().getRequest(), data);
+  },
+);
+
+export function getUserData(req, data?: string): IUser {
+  const headers = req.headers;
+  let user: IUser = {
+    uid: 0,
+    username: '',
+  };
+  const configService = new ConfigService(req);
+  // 未通过网关透传用户信息且处于local开发环境，则从配置获取用户信息
+  if (
+    lodash.isEmpty(headers['x-userid']) ||
+    lodash.isEmpty(headers['x-username'])
+  ) {
+    if (process.env.NODE_ENV === 'dev') {
+      user = {
+        uid: configService.get('MOCK_UID'),
+        username: configService.get('MOCK_USERNAME'),
+        appId: configService.get('MOCK_APP_ID'),
+        tenantId: configService.get('MOCK_TENANT_ID'),
+      };
+    }
+  } else {
+    user = {
+      uid: headers['x-userid'],
+      username: headers['x-username'],
+      appId: headers['x-appid'],
+      tenantId: headers['x-tenantid'],
+    };
+
+    return data ? user[data] : user;
+  }
+}

package/{dist → src}/decorators/user_auth.decorator.js

@@ -14,4 +14,3 @@ function UserFilter(field) {
     }));
 }
 exports.UserFilter = UserFilter;
-//# sourceMappingURL=user_auth.decorator.js.map

package/src/decorators/user_auth.decorator.ts

@@ -0,0 +1,15 @@
+import { applyDecorators } from '@nestjs/common';
+import { CrudAuth } from '@dataui/crud';
+import { getUserData } from './user.decorator';
+
+export function UserFilter(field: string) {
+  const obj = {};
+  return applyDecorators(
+    CrudAuth({
+      filter: (req) => {
+        obj[field] = getUserData(req, 'uid');
+        return obj;
+      },
+    }),
+  );
+}

package/{dist → src}/decorators/validator.decorators.js

@@ -21,10 +21,7 @@ function IsPassword(validationOptions) {
 }
 exports.IsPassword = IsPassword;
 function IsPhoneNumber(validationOptions) {
-    return (0, class_validator_1.IsPhoneNumber)(validationOptions?.region, {
-        message: 'error.phoneNumber',
-        ...validationOptions,
-    });
+    return (0, class_validator_1.IsPhoneNumber)(validationOptions === null || validationOptions === void 0 ? void 0 : validationOptions.region, Object.assign({ message: 'error.phoneNumber' }, validationOptions));
 }
 exports.IsPhoneNumber = IsPhoneNumber;
 function IsTmpKey(validationOptions) {
@@ -60,4 +57,3 @@ function IsNullable(options) {
     return (0, class_validator_1.ValidateIf)((obj, value) => value !== null, options);
 }
 exports.IsNullable = IsNullable;
-//# sourceMappingURL=validator.decorators.js.map

package/src/decorators/validator.decorators.ts

@@ -0,0 +1,78 @@
+import type { ValidationOptions } from 'class-validator';
+import {
+  IsPhoneNumber as isPhoneNumber,
+  registerDecorator,
+  ValidateIf,
+} from 'class-validator';
+import { isString } from 'lodash';
+
+export function IsPassword(
+  validationOptions?: ValidationOptions,
+): PropertyDecorator {
+  return (object, propertyName: string) => {
+    registerDecorator({
+      propertyName,
+      name: 'isPassword',
+      target: object.constructor,
+      constraints: [],
+      options: validationOptions,
+      validator: {
+        validate(value: string) {
+          return /^[\d!#$%&*@A-Z^a-z]*$/.test(value);
+        },
+      },
+    });
+  };
+}
+
+export function IsPhoneNumber(
+  validationOptions?: ValidationOptions & {
+    region?: Parameters<typeof isPhoneNumber>[0];
+  },
+): PropertyDecorator {
+  return isPhoneNumber(validationOptions?.region, {
+    message: 'error.phoneNumber',
+    ...validationOptions,
+  });
+}
+
+export function IsTmpKey(
+  validationOptions?: ValidationOptions,
+): PropertyDecorator {
+  return (object, propertyName: string) => {
+    registerDecorator({
+      propertyName,
+      name: 'tmpKey',
+      target: object.constructor,
+      options: validationOptions,
+      validator: {
+        validate(value: string): boolean {
+          return isString(value) && /^tmp\//.test(value);
+        },
+        defaultMessage(): string {
+          return 'error.invalidTmpKey';
+        },
+      },
+    });
+  };
+}
+
+export function IsUndefinable(options?: ValidationOptions): PropertyDecorator {
+  return ValidateIf((obj, value) => value !== undefined, options);
+}
+
+export function IsEmptyable(options?: ValidationOptions): PropertyDecorator {
+  return ValidateIf(
+    (obj, value) =>
+      !(
+        value === null ||
+        value === undefined ||
+        (isString(value) && value.trim() === '')
+      ),
+    options,
+  );
+}
+
+export function IsNullable(options?: ValidationOptions): PropertyDecorator {
+  return ValidateIf((obj, value) => value !== null, options);
+}

package/{dist → src}/exceptions/file-not-image.exception.js

@@ -8,4 +8,3 @@ class FileNotImageException extends common_1.BadRequestException {
     }
 }
 exports.FileNotImageException = FileNotImageException;
-//# sourceMappingURL=file-not-image.exception.js.map

package/src/exceptions/file-not-image.exception.ts

@@ -0,0 +1,7 @@
+import { BadRequestException } from '@nestjs/common';
+
+export class FileNotImageException extends BadRequestException {
+  constructor(error?: string) {
+    super('error.fileNotImage', error);
+  }
+}

package/{dist → src}/exceptions/index.js

@@ -16,4 +16,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./file-not-image.exception"), exports);
 __exportStar(require("./user-not-found.exception"), exports);
-//# sourceMappingURL=index.js.map

package/src/exceptions/index.ts

@@ -0,0 +1,2 @@
+export * from './file-not-image.exception';
+export * from './user-not-found.exception';

package/{dist → src}/exceptions/page-type.exception.js

@@ -8,4 +8,3 @@ class PageTypeException extends common_1.BadRequestException {
     }
 }
 exports.PageTypeException = PageTypeException;
-//# sourceMappingURL=page-type.exception.js.map

package/src/exceptions/page-type.exception.ts

@@ -0,0 +1,7 @@
+import { BadRequestException } from '@nestjs/common';
+
+export class PageTypeException extends BadRequestException {
+  constructor() {
+    super('error.pageType');
+  }
+}

package/{dist → src}/exceptions/user-not-found.exception.js

@@ -8,4 +8,3 @@ class UserNotFoundException extends common_1.NotFoundException {
     }
 }
 exports.UserNotFoundException = UserNotFoundException;
-//# sourceMappingURL=user-not-found.exception.js.map

package/src/exceptions/user-not-found.exception.ts

@@ -0,0 +1,7 @@
+import { NotFoundException } from '@nestjs/common';
+
+export class UserNotFoundException extends NotFoundException {
+  constructor(error?: string) {
+    super('error.userNotFound', error);
+  }
+}

package/src/filters/bad-request.filter.js

@@ -0,0 +1,104 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpExceptionFilter = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("typeorm");
+const nestjs_i18n_1 = require("nestjs-i18n");
+let HttpExceptionFilter = (() => {
+    let _classDecorators = [(0, common_1.Catch)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var HttpExceptionFilter = _classThis = class {
+        catch(exception, host) {
+            const i18n = nestjs_i18n_1.I18nContext.current(host);
+            const ctx = host.switchToHttp();
+            const response = ctx.getResponse();
+            const request = ctx.getRequest();
+            let statusCode = exception instanceof common_1.HttpException ? exception.getStatus() : 500;
+            let error = exception instanceof common_1.HttpException
+                ? exception.message
+                : 'Internal server error';
+            if (exception instanceof typeorm_1.EntityNotFoundError) {
+                statusCode = 404;
+                error = 'Entity not found';
+            }
+            if (statusCode === 500) {
+                console.error(exception);
+            }
+            const getFirstError = (error, property = '') => {
+                var _a;
+                if (((_a = error === null || error === void 0 ? void 0 : error.children) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                    const firstError = error.children[0];
+                    firstError['property'] = `${property}.${firstError['property']}`;
+                    return getFirstError(firstError, firstError.property);
+                }
+                return error;
+            };
+            if (exception instanceof nestjs_i18n_1.I18nValidationException) {
+                const firstErros = getFirstError(exception.errors[0], exception.errors[0].property);
+                const constraint = Object.values(firstErros.constraints)[0];
+                const [translationKey, argsString] = constraint.split('|');
+                const args = !!argsString ? JSON.parse(argsString) : {};
+                error = i18n.translate(translationKey, {
+                    args: Object.assign({ property: firstErros.property, value: firstErros.value, constraints: firstErros.constraints }, args),
+                });
+            }
+            const parseJson = {
+                code: statusCode,
+                msg: error,
+                requestId: request.id,
+                timestamp: new Date().toISOString(),
+            };
+            return response.status(200).json(parseJson);
+        }
+    };
+    __setFunctionName(_classThis, "HttpExceptionFilter");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        HttpExceptionFilter = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return HttpExceptionFilter = _classThis;
+})();
+exports.HttpExceptionFilter = HttpExceptionFilter;