@nest-omni/core 1.0.0

package/src/decorators/transform.decorators.js

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

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/src/decorators/translate.decorator.d.ts

@@ -0,0 +1,5 @@
+import type { ITranslationDecoratorInterface } from '../interfaces';
+export declare const STATIC_TRANSLATION_DECORATOR_KEY = "custom:static-translate";
+export declare const DYNAMIC_TRANSLATION_DECORATOR_KEY = "custom:dynamic-translate";
+export declare function StaticTranslate(data?: ITranslationDecoratorInterface): PropertyDecorator;
+export declare function DynamicTranslate(): PropertyDecorator;

package/src/decorators/translate.decorator.js

@@ -0,0 +1,18 @@
+"use strict";
+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);
+    };
+}
+exports.StaticTranslate = StaticTranslate;
+function DynamicTranslate() {
+    return (target, key) => {
+        Reflect.defineMetadata(exports.DYNAMIC_TRANSLATION_DECORATOR_KEY, {}, target, key);
+    };
+}
+exports.DynamicTranslate = DynamicTranslate;

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/src/decorators/use-dto.decorator.d.ts

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

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseDto = void 0;
+function UseDto(dtoClass) {
+    return (ctor) => {
+        ctor.prototype.dtoClass = dtoClass;
+    };
+}
+exports.UseDto = UseDto;

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.d.ts

@@ -0,0 +1,6 @@
+export interface IUser {
+    uid: number;
+    username: string;
+}
+export declare const User: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
+export declare function getUserData(req: any, data?: string): IUser | null;

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/src/decorators/user.decorator.d.ts

@@ -0,0 +1,8 @@
+export interface IUser {
+    uid: number;
+    username: string;
+    tenantId?: string;
+    appId?: string;
+}
+export declare const User: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
+export declare function getUserData(req: any, data?: string): IUser;

package/src/decorators/user.decorator.js

@@ -0,0 +1,62 @@
+"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"));
+const config_1 = require("@nestjs/config");
+exports.User = (0, common_1.createParamDecorator)((data, ctx) => {
+    return getUserData(ctx.switchToHttp().getRequest(), data);
+});
+function getUserData(req, data) {
+    const headers = req.headers;
+    let user = {
+        uid: 0,
+        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') {
+            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;
+    }
+}
+exports.getUserData = getUserData;

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/src/decorators/user_auth.decorator.d.ts

@@ -0,0 +1 @@
+export declare function UserFilter(field: string): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/decorators/user_auth.decorator.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserFilter = void 0;
+const common_1 = require("@nestjs/common");
+const crud_1 = require("@dataui/crud");
+const user_decorator_1 = require("./user.decorator");
+function UserFilter(field) {
+    const obj = {};
+    return (0, common_1.applyDecorators)((0, crud_1.CrudAuth)({
+        filter: (req) => {
+            obj[field] = (0, user_decorator_1.getUserData)(req, 'uid');
+            return obj;
+        },
+    }));
+}
+exports.UserFilter = UserFilter;

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/src/decorators/validator.decorators.d.ts

@@ -0,0 +1,10 @@
+import type { ValidationOptions } from 'class-validator';
+import { IsPhoneNumber as isPhoneNumber } from 'class-validator';
+export declare function IsPassword(validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function IsPhoneNumber(validationOptions?: ValidationOptions & {
+    region?: Parameters<typeof isPhoneNumber>[0];
+}): PropertyDecorator;
+export declare function IsTmpKey(validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function IsUndefinable(options?: ValidationOptions): PropertyDecorator;
+export declare function IsEmptyable(options?: ValidationOptions): PropertyDecorator;
+export declare function IsNullable(options?: ValidationOptions): PropertyDecorator;

package/src/decorators/validator.decorators.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IsNullable = exports.IsEmptyable = exports.IsUndefinable = exports.IsTmpKey = exports.IsPhoneNumber = exports.IsPassword = void 0;
+const class_validator_1 = require("class-validator");
+const lodash_1 = require("lodash");
+function IsPassword(validationOptions) {
+    return (object, propertyName) => {
+        (0, class_validator_1.registerDecorator)({
+            propertyName,
+            name: 'isPassword',
+            target: object.constructor,
+            constraints: [],
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    return /^[\d!#$%&*@A-Z^a-z]*$/.test(value);
+                },
+            },
+        });
+    };
+}
+exports.IsPassword = IsPassword;
+function IsPhoneNumber(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) {
+    return (object, propertyName) => {
+        (0, class_validator_1.registerDecorator)({
+            propertyName,
+            name: 'tmpKey',
+            target: object.constructor,
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    return (0, lodash_1.isString)(value) && /^tmp\//.test(value);
+                },
+                defaultMessage() {
+                    return 'error.invalidTmpKey';
+                },
+            },
+        });
+    };
+}
+exports.IsTmpKey = IsTmpKey;
+function IsUndefinable(options) {
+    return (0, class_validator_1.ValidateIf)((obj, value) => value !== undefined, options);
+}
+exports.IsUndefinable = IsUndefinable;
+function IsEmptyable(options) {
+    return (0, class_validator_1.ValidateIf)((obj, value) => !(value === null ||
+        value === undefined ||
+        ((0, lodash_1.isString)(value) && value.trim() === '')), options);
+}
+exports.IsEmptyable = IsEmptyable;
+function IsNullable(options) {
+    return (0, class_validator_1.ValidateIf)((obj, value) => value !== null, options);
+}
+exports.IsNullable = IsNullable;