@xfe-repo/bff-validation 1.0.0

package/dist/validation.pipe.spec.mjs

@@ -0,0 +1,158 @@
+import {
+  IsBooleanOptional,
+  IsIntRequired,
+  IsStringOptional
+} from "./chunk-7NGBVWVT.mjs";
+import {
+  ValidationPipe,
+  createValidationPipe
+} from "./chunk-DSV7LKIC.mjs";
+import {
+  __name,
+  __publicField
+} from "./chunk-GF5IOLXS.mjs";
+
+// src/validation.pipe.spec.ts
+import { BadRequestException } from "@nestjs/common";
+import { Test } from "@nestjs/testing";
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+function _ts_metadata(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata, "_ts_metadata");
+var _User = class _User {
+  constructor() {
+    __publicField(this, "userId");
+    __publicField(this, "userName");
+    __publicField(this, "isStudent");
+  }
+};
+__name(_User, "User");
+var User = _User;
+_ts_decorate([
+  IsIntRequired({
+    description: "\u7528\u6237Id"
+  }),
+  _ts_metadata("design:type", Number)
+], User.prototype, "userId", void 0);
+_ts_decorate([
+  IsStringOptional({
+    description: "\u7528\u6237\u540D"
+  }),
+  _ts_metadata("design:type", String)
+], User.prototype, "userName", void 0);
+_ts_decorate([
+  IsBooleanOptional({
+    description: "\u662F\u5426\u5B66\u751F"
+  }),
+  _ts_metadata("design:type", Boolean)
+], User.prototype, "isStudent", void 0);
+describe("In ValidationPipe", () => {
+  let pipe;
+  const transformType = "body";
+  beforeEach(async () => {
+    const module = await Test.createTestingModule({
+      providers: [
+        ValidationPipe
+      ]
+    }).compile();
+    pipe = module.get(ValidationPipe);
+  });
+  it("should valid IsNotEmpty, \u9A8C\u8BC1 Dto \u4E2D\u5FC5\u4F20\u5C5E\u6027 \u5FC5\u987B\u8981\u4F20", async () => {
+    const input = {
+      userName: "felixpan"
+    };
+    const transformedFn = pipe.transform(input, {
+      type: transformType,
+      metatype: User
+    });
+    await expect(transformedFn).rejects.toThrow("\u7528\u6237Id \u4E0D\u80FD\u4E3A\u7A7A");
+  });
+  it("should valid Dto \u4E2D\u672A\u5B9A\u4E49\u7684\u5C5E\u6027 \u5FC5\u987B\u8981\u6392\u9664", async () => {
+    const input = {
+      userId: 1,
+      userName: "felixpan",
+      extraField: "extraValue"
+    };
+    const data = pipe.transform(input, {
+      type: transformType,
+      metatype: User
+    });
+    await expect(data).resolves.toEqual({
+      userId: 1,
+      userName: "felixpan"
+    });
+  });
+  it("should valid \u6392\u9664 Dto \u4E2D undefined \u7684\u5C5E\u6027\u5B57\u6BB5", async () => {
+    const input = {
+      userId: 1,
+      userName: void 0
+    };
+    const data = pipe.transform(input, {
+      type: transformType,
+      metatype: User
+    });
+    await expect(data).resolves.toEqual({
+      userId: 1
+    });
+  });
+});
+describe("Out ValidationPipe", () => {
+  const pipe = createValidationPipe({
+    // 配合配置 validationPipe.transform({ type: 'custom' }) 时使用
+    validateCustomDecorators: true
+  });
+  const transformType = "custom";
+  beforeEach(async () => {
+    await Test.createTestingModule({
+      providers: []
+    }).compile();
+  });
+  it("should valid IsNotEmpty, \u9A8C\u8BC1 Dto \u4E2D\u5FC5\u4F20\u5C5E\u6027 \u5FC5\u987B\u8981\u4F20", async () => {
+    const input = {
+      userName: "felixpan"
+    };
+    const transformedFn = pipe.transform(input, {
+      type: transformType,
+      metatype: User
+    });
+    await expect(transformedFn).rejects.toThrow(BadRequestException);
+  });
+  it("should valid Dto \u4E2D\u672A\u5B9A\u4E49\u7684\u5C5E\u6027 \u5FC5\u987B\u8981\u6392\u9664", async () => {
+    const input = {
+      userId: 1,
+      userName: "felixpan",
+      extraField: "extraValue"
+    };
+    const data = pipe.transform(input, {
+      type: transformType,
+      metatype: User
+    });
+    await expect(data).resolves.toEqual({
+      userId: 1,
+      userName: "felixpan"
+    });
+  });
+  it("should valid \u6392\u9664 Dto \u4E2D undefined \u7684\u5C5E\u6027\u5B57\u6BB5", async () => {
+    const input = {
+      userId: 1,
+      userName: void 0
+    };
+    const data = pipe.transform(input, {
+      type: transformType,
+      metatype: User
+    });
+    await expect(data).resolves.toEqual({
+      userId: 1
+    });
+  });
+});
+export {
+  User
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@xfe-repo/bff-validation",
+  "version": "1.0.0",
+  "sideEffects": false,
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.3",
+    "@xfe-repo/bff-core": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.10",
+    "@xfe-repo/typescript-config": "0.0.6",
+    "@xfe-repo/eslint-config": "0.0.5"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.1.12",
+    "@nestjs/testing": "^11.1.12",
+    "@types/jest": "^30.0.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint \"src/**/*.ts*\"",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
+  }
+}