@nest-omni/core 1.0.2 → 1.0.5

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

@@ -6,4 +6,3 @@ function UUIDParam(property, ...pipes) {
     return (0, common_1.Param)(property, new common_1.ParseUUIDPipe({ version: '4' }), ...pipes);
 }
 exports.UUIDParam = UUIDParam;
-//# sourceMappingURL=http.decorators.js.map

package/src/decorators/http.decorators.ts

@@ -0,0 +1,10 @@
+import type { PipeTransform } from '@nestjs/common';
+import { Param, ParseUUIDPipe } from '@nestjs/common';
+import type { Type } from '@nestjs/common/interfaces';
+
+export function UUIDParam(
+  property: string,
+  ...pipes: Array<Type<PipeTransform> | PipeTransform>
+): ParameterDecorator {
+  return Param(property, new ParseUUIDPipe({ version: '4' }), ...pipes);
+}

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

@@ -26,4 +26,3 @@ __exportStar(require("./translate.decorator"), exports);
 __exportStar(require("./use-dto.decorator"), exports);
 __exportStar(require("./validator.decorators"), exports);
 __exportStar(require("./controller.decorator"), exports);
-//# sourceMappingURL=index.js.map

package/src/decorators/index.ts

@@ -0,0 +1,12 @@
+export * from './api-page-ok-response.decorator';
+export * from './auth-user.decorator';
+export * from './field.decorators';
+export * from './http.decorators';
+export * from './property.decorators';
+export * from './public-route.decorator';
+export * from './swagger.schema';
+export * from './transform.decorators';
+export * from './translate.decorator';
+export * from './use-dto.decorator';
+export * from './validator.decorators';
+export * from './controller.decorator';

package/{dist → src}/decorators/omni-auth.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.getOmniAuthData = exports.OmniAuth = void 0;
 const common_1 = require("@nestjs/common");
-const lodash = require("lodash");
+const lodash = __importStar(require("lodash"));
 const config_1 = require("@nestjs/config");
 exports.OmniAuth = (0, common_1.createParamDecorator)((field, ctx) => {
     return getOmniAuthData(ctx.switchToHttp().getRequest(), field);
@@ -11,8 +34,10 @@ function getOmniAuthData(req, data) {
     const headers = req.headers;
     let user;
     const configService = new config_1.ConfigService(req);
+    // 未通过网关透传用户信息且处于local开发环境，则从配置获取用户信息
     if (lodash.isEmpty(headers['x-userid']) ||
         lodash.isEmpty(headers['x-username'])) {
+        //todo 需要删除
         if (process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'uat') {
             user = {
                 uid: configService.get('MOCK_UID'),
@@ -33,4 +58,3 @@ function getOmniAuthData(req, data) {
     return data ? user[data] : user;
 }
 exports.getOmniAuthData = getOmniAuthData;
-//# sourceMappingURL=omni-auth.decorator.js.map

package/src/decorators/omni-auth.decorator.ts

@@ -0,0 +1,46 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+import * as lodash from 'lodash';
+import { ConfigService } from '@nestjs/config';
+
+export interface IOmniAuth {
+  uid: number;
+  username: string;
+  tenantId: string;
+  appId: string;
+}
+
+export const OmniAuth = createParamDecorator(
+  (field: string, ctx: ExecutionContext): IOmniAuth => {
+    return getOmniAuthData(ctx.switchToHttp().getRequest(), field);
+  },
+);
+
+export function getOmniAuthData(req, data?: string): IOmniAuth {
+  const headers = req.headers;
+  let user: IOmniAuth;
+  const configService = new ConfigService(req);
+  // 未通过网关透传用户信息且处于local开发环境，则从配置获取用户信息
+  if (
+    lodash.isEmpty(headers['x-userid']) ||
+    lodash.isEmpty(headers['x-username'])
+  ) {
+    //todo 需要删除
+    if (process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'uat') {
+      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/operation.decorator.js

@@ -4,4 +4,3 @@ exports.OperationLog = void 0;
 const common_1 = require("@nestjs/common");
 const OperationLog = (operation) => (0, common_1.SetMetadata)('operation-log', operation);
 exports.OperationLog = OperationLog;
-//# sourceMappingURL=operation.decorator.js.map

package/src/decorators/operation.decorator.ts

@@ -0,0 +1,4 @@
+import { SetMetadata } from '@nestjs/common';
+
+export const OperationLog = (operation: string) =>
+  SetMetadata('operation-log', operation);

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

@@ -5,39 +5,32 @@ const swagger_1 = require("@nestjs/swagger");
 const utils_1 = require("../common/utils");
 const field_decorators_1 = require("../decorators/field.decorators");
 function ApiBooleanProperty(options = {}) {
-    return (0, swagger_1.ApiProperty)({ type: Boolean, ...options });
+    return (0, swagger_1.ApiProperty)(Object.assign({ type: Boolean }, options));
 }
 exports.ApiBooleanProperty = ApiBooleanProperty;
 function ApiBooleanPropertyOptional(options = {}) {
-    return ApiBooleanProperty({ required: false, ...options });
+    return ApiBooleanProperty(Object.assign({ required: false }, options));
 }
 exports.ApiBooleanPropertyOptional = ApiBooleanPropertyOptional;
 function ApiUUIDProperty(options = {}) {
-    return (0, swagger_1.ApiProperty)({
-        type: options.each ? [String] : String,
-        format: 'uuid',
-        isArray: options.each,
-        ...options,
-    });
+    return (0, swagger_1.ApiProperty)(Object.assign({ type: options.each ? [String] : String, format: 'uuid', isArray: options.each }, options));
 }
 exports.ApiUUIDProperty = ApiUUIDProperty;
 function ApiUUIDPropertyOptional(options = {}) {
-    return ApiUUIDProperty({ required: false, ...options });
+    return ApiUUIDProperty(Object.assign({ required: false }, options));
 }
 exports.ApiUUIDPropertyOptional = ApiUUIDPropertyOptional;
 function ApiEnumProperty(getEnum, options = {}) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const enumValue = getEnum();
     options.description = (0, field_decorators_1.getEnumDescription)(enumValue);
-    return (0, swagger_1.ApiProperty)({
-        type: 'enum',
-        enum: enumValue,
-        enumName: (0, utils_1.getVariableName)(getEnum),
-        ...options,
-    });
+    return (0, swagger_1.ApiProperty)(Object.assign({ type: 'enum', 
+        // throw error during the compilation of swagger
+        // isArray: options.each,
+        enum: enumValue, enumName: (0, utils_1.getVariableName)(getEnum) }, options));
 }
 exports.ApiEnumProperty = ApiEnumProperty;
 function ApiEnumPropertyOptional(getEnum, options = {}) {
-    return ApiEnumProperty(getEnum, { required: false, ...options });
+    return ApiEnumProperty(getEnum, Object.assign({ required: false }, options));
 }
 exports.ApiEnumPropertyOptional = ApiEnumPropertyOptional;
-//# sourceMappingURL=property.decorators.js.map

package/src/decorators/property.decorators.ts

@@ -0,0 +1,62 @@
+import type { ApiPropertyOptions } from '@nestjs/swagger';
+import { ApiProperty } from '@nestjs/swagger';
+
+import { getVariableName } from '../common/utils';
+import { getEnumDescription } from '../decorators/field.decorators';
+
+export function ApiBooleanProperty(
+  options: Omit<ApiPropertyOptions, 'type'> = {},
+): PropertyDecorator {
+  return ApiProperty({ type: Boolean, ...options });
+}
+
+export function ApiBooleanPropertyOptional(
+  options: Omit<ApiPropertyOptions, 'type' | 'required'> = {},
+): PropertyDecorator {
+  return ApiBooleanProperty({ required: false, ...options });
+}
+
+export function ApiUUIDProperty(
+  options: Omit<ApiPropertyOptions, 'type' | 'format'> &
+    Partial<{ each: boolean }> = {},
+): PropertyDecorator {
+  return ApiProperty({
+    type: options.each ? [String] : String,
+    format: 'uuid',
+    isArray: options.each,
+    ...options,
+  });
+}
+
+export function ApiUUIDPropertyOptional(
+  options: Omit<ApiPropertyOptions, 'type' | 'format' | 'required'> &
+    Partial<{ each: boolean }> = {},
+): PropertyDecorator {
+  return ApiUUIDProperty({ required: false, ...options });
+}
+
+export function ApiEnumProperty<TEnum>(
+  getEnum: () => TEnum,
+  options: Omit<ApiPropertyOptions, 'type'> & { each?: boolean } = {},
+): PropertyDecorator {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const enumValue = getEnum() as any;
+  options.description = getEnumDescription(enumValue);
+  return ApiProperty({
+    type: 'enum',
+    // throw error during the compilation of swagger
+    // isArray: options.each,
+    enum: enumValue,
+    enumName: getVariableName(getEnum),
+    ...options,
+  });
+}
+
+export function ApiEnumPropertyOptional<TEnum>(
+  getEnum: () => TEnum,
+  options: Omit<ApiPropertyOptions, 'type' | 'required'> & {
+    each?: boolean;
+  } = {},
+): PropertyDecorator {
+  return ApiEnumProperty(getEnum, { required: false, ...options });
+}

package/{dist → src}/decorators/public-route.decorator.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PublicRoute = exports.PUBLIC_ROUTE_KEY = void 0;
 const common_1 = require("@nestjs/common");
 exports.PUBLIC_ROUTE_KEY = 'public_route';
+// eslint-disable-next-line @typescript-eslint/naming-convention
 const PublicRoute = (isPublic = false) => (0, common_1.SetMetadata)(exports.PUBLIC_ROUTE_KEY, isPublic);
 exports.PublicRoute = PublicRoute;
-//# sourceMappingURL=public-route.decorator.js.map

package/src/decorators/public-route.decorator.ts

@@ -0,0 +1,8 @@
+import type { CustomDecorator } from '@nestjs/common';
+import { SetMetadata } from '@nestjs/common';
+
+export const PUBLIC_ROUTE_KEY = 'public_route';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const PublicRoute = (isPublic = false): CustomDecorator =>
+  SetMetadata(PUBLIC_ROUTE_KEY, isPublic);

package/{dist → src}/decorators/swagger.schema.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiFile = void 0;
 const common_1 = require("@nestjs/common");
@@ -7,7 +10,7 @@ const route_paramtypes_enum_1 = require("@nestjs/common/enums/route-paramtypes.e
 const platform_express_1 = require("@nestjs/platform-express");
 const swagger_1 = require("@nestjs/swagger");
 const reverse_object_keys_util_1 = require("@nestjs/swagger/dist/utils/reverse-object-keys.util");
-const lodash_1 = require("lodash");
+const lodash_1 = __importDefault(require("lodash"));
 function explore(instance, propertyKey) {
     const types = Reflect.getMetadata(constants_1.PARAMTYPES_METADATA, instance, propertyKey);
     const routeArgsMetadata = Reflect.getMetadata(constants_1.ROUTE_ARGS_METADATA, instance.constructor, propertyKey) || {};
@@ -77,4 +80,3 @@ function ApiFile(files, options = {}) {
     return (0, common_1.applyDecorators)(RegisterModels(), (0, swagger_1.ApiConsumes)('multipart/form-data'), ApiFileDecorator(filesArray, options), ...apiFileInterceptors);
 }
 exports.ApiFile = ApiFile;
-//# sourceMappingURL=swagger.schema.js.map

package/src/decorators/swagger.schema.ts

@@ -0,0 +1,117 @@
+/* eslint-disable @typescript-eslint/ban-types,@typescript-eslint/no-unsafe-argument */
+import type { Type } from '@nestjs/common';
+import { applyDecorators, UseInterceptors } from '@nestjs/common';
+import { PARAMTYPES_METADATA, ROUTE_ARGS_METADATA } from '@nestjs/common/constants';
+import { RouteParamtypes } from '@nestjs/common/enums/route-paramtypes.enum';
+import { FileInterceptor, FilesInterceptor } from '@nestjs/platform-express';
+import { ApiBody, ApiConsumes, ApiExtraModels, getSchemaPath } from '@nestjs/swagger';
+import type { ReferenceObject, SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
+import { reverseObjectKeys } from '@nestjs/swagger/dist/utils/reverse-object-keys.util';
+import _ from 'lodash';
+
+import type { IApiFile } from '../interfaces';
+
+function explore(instance: Object, propertyKey: string | symbol) {
+  const types: Array<Type<unknown>> = Reflect.getMetadata(
+    PARAMTYPES_METADATA,
+    instance,
+    propertyKey,
+  );
+  const routeArgsMetadata =
+    Reflect.getMetadata(
+      ROUTE_ARGS_METADATA,
+      instance.constructor,
+      propertyKey,
+    ) || {};
+
+  const parametersWithType = _.mapValues(
+    reverseObjectKeys(routeArgsMetadata),
+    (param) => ({
+      type: types[param.index],
+      name: param.data,
+      required: true,
+    }),
+  );
+
+  for (const [key, value] of Object.entries(parametersWithType)) {
+    const keyPair = key.split(':');
+
+    if (Number(keyPair[0]) === RouteParamtypes.BODY) {
+      return value.type;
+    }
+  }
+}
+
+function RegisterModels(): MethodDecorator {
+  return (target, propertyKey, descriptor: PropertyDescriptor) => {
+    const body = explore(target, propertyKey);
+
+    return body && ApiExtraModels(body)(target, propertyKey, descriptor);
+  };
+}
+
+function ApiFileDecorator(
+  files: IApiFile[] = [],
+  options: Partial<{ isRequired: boolean }> = {},
+): MethodDecorator {
+  return (target, propertyKey, descriptor: PropertyDescriptor) => {
+    const { isRequired = false } = options;
+    const fileSchema: SchemaObject = {
+      type: 'string',
+      format: 'binary',
+    };
+    const properties: Record<string, SchemaObject | ReferenceObject> = {};
+
+    for (const file of files) {
+      if (file.isArray) {
+        properties[file.name] = {
+          type: 'array',
+          items: fileSchema,
+        };
+      } else {
+        properties[file.name] = fileSchema;
+      }
+    }
+
+    let schema: SchemaObject = {
+      properties,
+      type: 'object',
+    };
+    const body = explore(target, propertyKey);
+
+    if (body) {
+      schema = {
+        allOf: [
+          {
+            $ref: getSchemaPath(body),
+          },
+          { properties, type: 'object' },
+        ],
+      };
+    }
+
+    return ApiBody({
+      schema,
+      required: isRequired,
+    })(target, propertyKey, descriptor);
+  };
+}
+
+export function ApiFile(
+  files: _.Many<IApiFile>,
+  options: Partial<{ isRequired: boolean }> = {},
+): MethodDecorator {
+  const filesArray = _.castArray(files);
+  const apiFileInterceptors = filesArray.map((file) =>
+    file.isArray
+      ? UseInterceptors(FilesInterceptor(file.name))
+      : UseInterceptors(FileInterceptor(file.name)),
+  );
+
+  return applyDecorators(
+    RegisterModels(),
+    ApiConsumes('multipart/form-data'),
+    ApiFileDecorator(filesArray, options),
+    ...apiFileInterceptors,
+  );
+}

package/{dist → src}/decorators/timestamp-column.decorator.js

@@ -4,7 +4,7 @@ exports.TimestampColumn = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const typeorm_1 = require("typeorm");
-const helpers_1 = require("../helpers");
+const helpers_1 = require("./helpers");
 function TimestampColumn(name, description) {
     return (0, common_1.applyDecorators)((0, swagger_1.ApiProperty)({
         required: false,
@@ -26,4 +26,3 @@ function TimestampColumn(name, description) {
     }));
 }
 exports.TimestampColumn = TimestampColumn;
-//# sourceMappingURL=timestamp-column.decorator.js.map

package/src/decorators/timestamp-column.decorator.ts

@@ -0,0 +1,29 @@
+import { applyDecorators } from '@nestjs/common';
+import { ApiProperty } from '@nestjs/swagger';
+import { Column } from 'typeorm';
+import { formatDateTime, strToTimeStamp } from '../helpers';
+
+export function TimestampColumn(name: string, description?: string) {
+  return applyDecorators(
+    ApiProperty({
+      required: false,
+      type: 'string',
+      format: 'date-time',
+      example: '2018-10-01 12:18:48',
+      description,
+    }),
+    Column({
+      type: 'int',
+      name,
+      nullable: false,
+      unsigned: true,
+      default: 0,
+      comment: description,
+      transformer: {
+        to: (value) =>
+          value === 0 || /\d{10}/.test(value) ? value : strToTimeStamp(value),
+        from: (value) => formatDateTime(value),
+      },
+    }),
+  );
+}

package/src/decorators/transform.decorators.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @description trim spaces from start and end, replace multiple spaces with one.
+ * @example
+ * @ApiProperty()
+ * @IsString()
+ * @Trim()
+ * name: string;
+ * @returns PropertyDecorator
+ * @constructor
+ */
+export declare function Trim(): PropertyDecorator;
+export declare function ToBoolean(): PropertyDecorator;
+/**
+ * @description convert string or number to integer
+ * @example
+ * @NumberField()
+ * @ToInt()
+ * name: number;
+ * @returns PropertyDecorator
+ * @constructor
+ */
+export declare function ToInt(): PropertyDecorator;
+/**
+ * @description transforms to array, specially for query params
+ * @example
+ * @NumberField()
+ * @ToArray()
+ * name: number;
+ * @constructor
+ */
+export declare function ToArray(): PropertyDecorator;
+export declare function ToLowerCase(): PropertyDecorator;
+export declare function ToUpperCase(): PropertyDecorator;
+export declare function S3UrlParser(): PropertyDecorator;
+export declare function PhoneNumberSerializer(): PropertyDecorator;

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

@@ -5,6 +5,16 @@ 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;
@@ -28,6 +38,15 @@ function ToBoolean() {
     }, { 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;
@@ -35,6 +54,14 @@ function ToInt() {
     }, { 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;
@@ -93,4 +120,3 @@ function PhoneNumberSerializer() {
     return (0, class_transformer_1.Transform)((params) => (0, libphonenumber_js_1.parsePhoneNumber)(params.value).number);
 }
 exports.PhoneNumberSerializer = PhoneNumberSerializer;
-//# sourceMappingURL=transform.decorators.js.map