nestjs-backend-common 0.0.7 → 0.1.0

package/.github/README.md

@@ -11,3 +11,9 @@ All the utility functions and common modules I usually use in my NestJS applicat
 ```bash
 npm version patch --no-git-tag-version
 ```
+
+## Why `nestjs-cls` Is Peer Dependency?
+
+This is because we wanna share the same storage between our App and this library. Thus we have to define it as peer dependency;
+
+> **Peer Dependencies**: These are dependencies that your project hooks into or modifies in the parent project, usually a plugin for some other library or tool. Peer dependencies are not automatically installed by npm. Instead, they are only checked for, ensuring that the parent project (the project that will depend on your project) has a dependency on the project you hook into. For example, if you create a plugin for a library like Chai, you would specify Chai as a peer dependency. This ensures that the user of your plugin has the correct version of Chai installed.

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run format
+npm run lint:fix

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run build

package/.husky/pre-version

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run build

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "always"
+  }
+}

package/dist/src/decorators/any-of/any-of.decorator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @description
+ * Do not annotate the fields with `@IsOptional` since it will not validate them at all.
+ */
+export declare function AnyOf(properties: string[]): (target: any) => void;
+//# sourceMappingURL=any-of.decorator.d.ts.map

package/dist/src/decorators/any-of/any-of.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"any-of.decorator.d.ts","sourceRoot":"","sources":["../../../../src/decorators/any-of/any-of.decorator.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAgB,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,IACvB,QAAQ,GAAG,UAoC7B"}

package/dist/src/decorators/any-of/any-of.decorator.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnyOf = AnyOf;
+const common_1 = require("@nestjs/common");
+const class_validator_1 = require("class-validator");
+/**
+ * @description
+ * Do not annotate the fields with `@IsOptional` since it will not validate them at all.
+ */
+function AnyOf(properties) {
+    return function (target) {
+        for (const property of properties) {
+            const otherProps = properties.filter((prop) => prop !== property);
+            const decorators = [
+                (0, class_validator_1.ValidateIf)((obj) => {
+                    const isCurrentPropDefined = obj[property] !== undefined;
+                    const areOtherPropsUndefined = otherProps.reduce((acc, prop) => acc && obj[prop] === undefined, true);
+                    return isCurrentPropDefined || areOtherPropsUndefined;
+                }),
+            ];
+            // For properties that have validators that don't fail on undefined (like @ValidateNested), we need to add IsDefined when all properties are undefined.
+            const areAllPropsUndefinedValidator = (0, class_validator_1.ValidateIf)((obj) => {
+                const areAllPropsUndefined = properties.every((prop) => obj[prop] === undefined);
+                return areAllPropsUndefined;
+            });
+            decorators.push(areAllPropsUndefinedValidator);
+            decorators.push((0, class_validator_1.IsDefined)());
+            for (const decorator of decorators) {
+                (0, common_1.applyDecorators)(decorator)(target.prototype, property);
+            }
+        }
+    };
+}
+//# sourceMappingURL=any-of.decorator.js.map

package/dist/src/decorators/any-of/any-of.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"any-of.decorator.js","sourceRoot":"","sources":["../../../../src/decorators/any-of/any-of.decorator.ts"],"names":[],"mappings":";;AAOA,sBAqCC;AA5CD,2CAAiD;AACjD,qDAAwD;AAExD;;;GAGG;AACH,SAAgB,KAAK,CAAC,UAAoB;IACxC,OAAO,UAAU,MAAW;QAC1B,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAClC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,QAAQ,CAC5B,CAAC;YACF,MAAM,UAAU,GAAG;gBACjB,IAAA,4BAAU,EAAC,CAAC,GAA4B,EAAE,EAAE;oBAC1C,MAAM,oBAAoB,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC;oBACzD,MAAM,sBAAsB,GAAG,UAAU,CAAC,MAAM,CAC9C,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,EAC7C,IAAI,CACL,CAAC;oBAEF,OAAO,oBAAoB,IAAI,sBAAsB,CAAC;gBACxD,CAAC,CAAC;aACH,CAAC;YAEF,uJAAuJ;YACvJ,MAAM,6BAA6B,GAAG,IAAA,4BAAU,EAC9C,CAAC,GAA4B,EAAE,EAAE;gBAC/B,MAAM,oBAAoB,GAAG,UAAU,CAAC,KAAK,CAC3C,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,CAClC,CAAC;gBAEF,OAAO,oBAAoB,CAAC;YAC9B,CAAC,CACF,CAAC;YAEF,UAAU,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;YAC/C,UAAU,CAAC,IAAI,CAAC,IAAA,2BAAS,GAAE,CAAC,CAAC;YAE7B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;gBACnC,IAAA,wBAAe,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/src/decorators/get-ip/get-ip.decorator.d.ts

@@ -0,0 +1,4 @@
+import { ExecutionContext } from '@nestjs/common';
+export declare function getIpFactory(data: unknown, ctx: ExecutionContext): string | undefined;
+export declare const GetIp: (...dataOrPipes: unknown[]) => ParameterDecorator;
+//# sourceMappingURL=get-ip.decorator.d.ts.map

package/dist/src/decorators/get-ip/get-ip.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-ip.decorator.d.ts","sourceRoot":"","sources":["../../../../src/decorators/get-ip/get-ip.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,EACjB,MAAM,gBAAgB,CAAC;AAGxB,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,EACb,GAAG,EAAE,gBAAgB,GACpB,MAAM,GAAG,SAAS,CAUpB;AAED,eAAO,MAAM,KAAK,mDAAqC,CAAC"}

package/dist/src/decorators/get-ip/get-ip.decorator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetIp = void 0;
+exports.getIpFactory = getIpFactory;
+const common_1 = require("@nestjs/common");
+const class_validator_1 = require("class-validator");
+function getIpFactory(data, ctx) {
+    const request = ctx.switchToHttp().getRequest();
+    const ip = request.ip ??
+        request.headers['x-forwarded-for'] ??
+        request.headers['X-Real-IP'];
+    if ((0, class_validator_1.isIP)(ip)) {
+        return ip;
+    }
+}
+exports.GetIp = (0, common_1.createParamDecorator)(getIpFactory);
+//# sourceMappingURL=get-ip.decorator.js.map

package/dist/src/decorators/get-ip/get-ip.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-ip.decorator.js","sourceRoot":"","sources":["../../../../src/decorators/get-ip/get-ip.decorator.ts"],"names":[],"mappings":";;;AAMA,oCAaC;AAnBD,2CAGwB;AACxB,qDAAuC;AAEvC,SAAgB,YAAY,CAC1B,IAAa,EACb,GAAqB;IAErB,MAAM,OAAO,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IAChD,MAAM,EAAE,GACN,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;QAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE/B,IAAI,IAAA,sBAAI,EAAC,EAAE,CAAC,EAAE,CAAC;QACb,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAEY,QAAA,KAAK,GAAG,IAAA,6BAAoB,EAAC,YAAY,CAAC,CAAC"}

package/dist/src/decorators/index.d.ts

@@ -0,0 +1,3 @@
+export * from './any-of/any-of.decorator';
+export * from './one-of/one-of.decorator';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/decorators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC"}

package/dist/src/decorators/index.js

@@ -0,0 +1,19 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./any-of/any-of.decorator"), exports);
+__exportStar(require("./one-of/one-of.decorator"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/decorators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/decorators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,4DAA0C"}

package/dist/src/decorators/one-of/one-of.decorator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @description
+ * Throws an error if more than one of the properties are present in the request body/querystring.
+ */
+export declare function OneOf(properties: string[]): (target: any) => void;
+//# sourceMappingURL=one-of.decorator.d.ts.map

package/dist/src/decorators/one-of/one-of.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"one-of.decorator.d.ts","sourceRoot":"","sources":["../../../../src/decorators/one-of/one-of.decorator.ts"],"names":[],"mappings":"AASA;;;GAGG;AACH,wBAAgB,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,IACvB,QAAQ,GAAG,UAoB7B"}

package/dist/src/decorators/one-of/one-of.decorator.js

@@ -0,0 +1,75 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneOf = OneOf;
+const common_1 = require("@nestjs/common");
+const class_validator_1 = require("class-validator");
+/**
+ * @description
+ * Throws an error if more than one of the properties are present in the request body/querystring.
+ */
+function OneOf(properties) {
+    return function (target) {
+        for (const property of properties) {
+            const otherProps = properties.filter((prop) => prop !== property);
+            (0, common_1.applyDecorators)((0, class_validator_1.ValidateIf)((obj) => {
+                const areOtherPropsUndefined = otherProps.reduce((acc, prop) => acc && obj[prop] === undefined, true);
+                const isCurrentPropDefined = obj[property] !== undefined;
+                return isCurrentPropDefined || areOtherPropsUndefined;
+            }), OneOfChecker(properties))(target.prototype, property);
+        }
+    };
+}
+function OneOfChecker(properties) {
+    return function (object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            name: 'OneOfChecker',
+            constraints: [properties],
+            target: object.constructor,
+            propertyName: String(propertyName),
+            validator: OneOfCheckerConstraint,
+        });
+    };
+}
+let OneOfCheckerConstraint = class OneOfCheckerConstraint {
+    validate(value, validationArguments) {
+        let [properties] = validationArguments.constraints;
+        properties = properties.filter((property) => property !== validationArguments.property);
+        const data = validationArguments.object;
+        for (const property of properties) {
+            const propertyValue = data[property];
+            if (!isNil(value) && !isNil(propertyValue)) {
+                return false;
+            }
+        }
+        return true;
+    }
+    defaultMessage(validationArguments) {
+        const [properties] = validationArguments.constraints;
+        const props = properties.reduce((accumulator, current, index) => {
+            if (index === properties.length - 2) {
+                accumulator += current + ', and ';
+            }
+            else if (index === properties.length - 1) {
+                accumulator += current;
+            }
+            else {
+                accumulator += current + ', ';
+            }
+            return accumulator;
+        }, '');
+        return `Do not send ${props} at the same time!`;
+    }
+};
+OneOfCheckerConstraint = __decorate([
+    (0, class_validator_1.ValidatorConstraint)({ name: 'OneOfChecker' })
+], OneOfCheckerConstraint);
+function isNil(value) {
+    return value === null || value === undefined;
+}
+//# sourceMappingURL=one-of.decorator.js.map

package/dist/src/decorators/one-of/one-of.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"one-of.decorator.js","sourceRoot":"","sources":["../../../../src/decorators/one-of/one-of.decorator.ts"],"names":[],"mappings":";;;;;;;;AAaA,sBAqBC;AAlCD,2CAAiD;AACjD,qDAMyB;AAEzB;;;GAGG;AACH,SAAgB,KAAK,CAAC,UAAoB;IACxC,OAAO,UAAU,MAAW;QAC1B,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAClC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,QAAQ,CAC5B,CAAC;YAEF,IAAA,wBAAe,EACb,IAAA,4BAAU,EAAC,CAAC,GAA4B,EAAE,EAAE;gBAC1C,MAAM,sBAAsB,GAAG,UAAU,CAAC,MAAM,CAC9C,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,EAC7C,IAAI,CACL,CAAC;gBACF,MAAM,oBAAoB,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC;gBAEzD,OAAO,oBAAoB,IAAI,sBAAsB,CAAC;YACxD,CAAC,CAAC,EACF,YAAY,CAAC,UAAU,CAAC,CACzB,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAChC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,UAAoB;IACxC,OAAO,UACL,MAAc,EACd,YAA6B;QAE7B,IAAA,mCAAiB,EAAC;YAChB,IAAI,EAAE,cAAc;YACpB,WAAW,EAAE,CAAC,UAAU,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC,WAAW;YAC1B,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;YAClC,SAAS,EAAE,sBAAsB;SAClC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAGD,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAC1B,QAAQ,CACN,KAAc,EACd,mBAAwC;QAExC,IAAI,CAAC,UAAU,CAAC,GAAG,mBAAmB,CAAC,WAAyB,CAAC;QACjE,UAAU,GAAG,UAAU,CAAC,MAAM,CAC5B,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,KAAK,mBAAmB,CAAC,QAAQ,CACxD,CAAC;QACF,MAAM,IAAI,GAAG,mBAAmB,CAAC,MAGhC,CAAC;QAEF,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YAErC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC3C,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,mBAAwC;QACrD,MAAM,CAAC,UAAU,CAAC,GAAG,mBAAmB,CAAC,WAExC,CAAC;QACF,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAC9D,IAAI,KAAK,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,WAAW,IAAI,OAAO,GAAG,QAAQ,CAAC;YACpC,CAAC;iBAAM,IAAI,KAAK,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3C,WAAW,IAAI,OAAO,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACN,WAAW,IAAI,OAAO,GAAG,IAAI,CAAC;YAChC,CAAC;YAED,OAAO,WAAW,CAAC;QACrB,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO,eAAe,KAAK,oBAAoB,CAAC;IAClD,CAAC;CACF,CAAA;AA1CK,sBAAsB;IAD3B,IAAA,qCAAmB,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;GACxC,sBAAsB,CA0C3B;AAED,SAAS,KAAK,CAAC,KAAc;IAC3B,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC"}

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from './correlation-id';
+export * from './decorators';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

package/dist/src/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./correlation-id"), exports);
+__exportStar(require("./decorators"), exports);
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,+CAA6B;AAC7B,0CAAwB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-backend-common",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "main": "dist/src/index",
   "types": "dist/src/index",
   "repository": {
@@ -23,13 +23,15 @@
   "homepage": "https://github.com/kasir-barati/nestjs-backend-common#readme",
   "description": "All the utility functions and common modules I usually use in my NestJS applications will be published and maintained here.",
   "peerDependencies": {
-    "@nestjs/core": "^11.0.20",
     "@nestjs/common": "^11.0.20",
+    "@nestjs/core": "^11.0.20",
     "nestjs-cls": "^5.4.3",
     "reflect-metadata": "^0.2.2"
   },
   "dependencies": {
     "@nestjs/graphql": "^13.1.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.2",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {
@@ -42,6 +44,7 @@
     "eslint-plugin-perfectionist": "^4.11.0",
     "eslint-plugin-prettier": "^5.2.6",
     "globals": "^16.0.0",
+    "husky": "^9.1.7",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "prettier": "^3.5.3",
@@ -55,6 +58,7 @@
     "build": "rm -rf dist && tsc --project tsconfig.build.json",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
     "lint:fix": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "format": "prettier -w -u .",
     "prepublish": "npm run build"
   }
 }

package/src/decorators/any-of/any-of.decorator.spec.ts

@@ -0,0 +1,144 @@
+import { plainToInstance, Type } from 'class-transformer';
+import {
+  ArrayNotEmpty,
+  IsArray,
+  IsEmail,
+  IsString,
+  validate,
+  ValidateNested,
+} from 'class-validator';
+
+import { AnyOf } from './any-of.decorator';
+
+@AnyOf(['email', 'phone'])
+class CreateUserDto {
+  @IsString()
+  email: string;
+
+  @IsString()
+  phone: string;
+}
+
+class NestedExampleDto {
+  @ValidateNested()
+  @Type(() => CreateUserDto)
+  user: CreateUserDto;
+}
+
+export class AdminUserInput {
+  @IsEmail()
+  email: string;
+}
+
+export class ModeratorUserInput {
+  @IsEmail()
+  email: string;
+
+  @IsArray()
+  @ArrayNotEmpty()
+  @IsString({ each: true })
+  accessRights: string[];
+}
+
+@AnyOf(['admin', 'moderator'])
+export class DefineUserInput {
+  @ValidateNested()
+  @Type(() => AdminUserInput)
+  admin?: AdminUserInput;
+
+  @ValidateNested()
+  @Type(() => ModeratorUserInput)
+  moderator?: ModeratorUserInput;
+}
+
+describe('AnyOf', () => {
+  it.each([{ email: 'email@em.cc' }, { phone: '0123456789' }])(
+    'should pass when email or phone is provided',
+    async (data) => {
+      const user = plainToInstance(CreateUserDto, data);
+
+      const errors = await validate(user);
+
+      expect(errors).toHaveLength(0);
+    },
+  );
+
+  it('should throw an error when nor email or phone is provided', async () => {
+    const user = plainToInstance(CreateUserDto, {});
+
+    const errors = await validate(user);
+
+    expect(errors).toHaveLength(2);
+    expect(errors[0].constraints).toStrictEqual({
+      isDefined: 'email should not be null or undefined',
+      isString: 'email must be a string',
+    });
+    expect(errors[1].constraints).toStrictEqual({
+      isDefined: 'phone should not be null or undefined',
+      isString: 'phone must be a string',
+    });
+  });
+
+  it.each([
+    { user: { email: 'email@em.cc' } },
+    { user: { phone: '0123456789' } },
+  ])(
+    'should pass when email or phone is provided in the nested object',
+    async (data) => {
+      const user = plainToInstance(NestedExampleDto, data);
+
+      const errors = await validate(user);
+
+      expect(errors).toHaveLength(0);
+    },
+  );
+
+  it('should throw an error when nor email or phone is provided in the nested object', async () => {
+    const user = plainToInstance(NestedExampleDto, { user: {} });
+
+    const errors = await validate(user);
+
+    expect(errors).toHaveLength(1);
+    expect(errors[0].children![0].constraints).toEqual({
+      isDefined: 'email should not be null or undefined',
+      isString: 'email must be a string',
+    });
+    expect(errors[0].children![1].constraints).toEqual({
+      isDefined: 'phone should not be null or undefined',
+      isString: 'phone must be a string',
+    });
+  });
+
+  it.each([
+    { admin: { email: 'admin@em.cc' } },
+    {
+      moderator: {
+        email: 'moderator@em.cc',
+        accessRights: ['read', 'write'],
+      },
+    },
+  ])(
+    'should pass when either "admin" or "moderator" is provided',
+    async (data) => {
+      const res = plainToInstance(DefineUserInput, data);
+
+      const errors = await validate(res);
+
+      expect(errors).toHaveLength(0);
+    },
+  );
+
+  it('should throw an error when neither "admin" nor "moderator" is provided', async () => {
+    const res = plainToInstance(DefineUserInput, {});
+
+    const errors = await validate(res);
+
+    expect(errors).toHaveLength(2);
+    expect(errors[0].constraints).toEqual({
+      isDefined: 'admin should not be null or undefined',
+    });
+    expect(errors[1].constraints).toEqual({
+      isDefined: 'moderator should not be null or undefined',
+    });
+  });
+});

package/src/decorators/any-of/any-of.decorator.ts

@@ -0,0 +1,45 @@
+import { applyDecorators } from '@nestjs/common';
+import { IsDefined, ValidateIf } from 'class-validator';
+
+/**
+ * @description
+ * Do not annotate the fields with `@IsOptional` since it will not validate them at all.
+ */
+export function AnyOf(properties: string[]) {
+  return function (target: any) {
+    for (const property of properties) {
+      const otherProps = properties.filter(
+        (prop) => prop !== property,
+      );
+      const decorators = [
+        ValidateIf((obj: Record<string, unknown>) => {
+          const isCurrentPropDefined = obj[property] !== undefined;
+          const areOtherPropsUndefined = otherProps.reduce(
+            (acc, prop) => acc && obj[prop] === undefined,
+            true,
+          );
+
+          return isCurrentPropDefined || areOtherPropsUndefined;
+        }),
+      ];
+
+      // For properties that have validators that don't fail on undefined (like @ValidateNested), we need to add IsDefined when all properties are undefined.
+      const areAllPropsUndefinedValidator = ValidateIf(
+        (obj: Record<string, unknown>) => {
+          const areAllPropsUndefined = properties.every(
+            (prop) => obj[prop] === undefined,
+          );
+
+          return areAllPropsUndefined;
+        },
+      );
+
+      decorators.push(areAllPropsUndefinedValidator);
+      decorators.push(IsDefined());
+
+      for (const decorator of decorators) {
+        applyDecorators(decorator)(target.prototype, property);
+      }
+    }
+  };
+}

package/src/decorators/get-ip/get-ip.decorator.spec.ts

@@ -0,0 +1,79 @@
+import { getIpFactory } from './get-ip.decorator';
+
+describe('getIpFactory', () => {
+  it('should return request.ip if valid', () => {
+    const expectedIp = '127.0.0.1';
+    const mockCtx = {
+      switchToHttp: jest.fn().mockReturnValue({
+        getRequest: jest.fn().mockReturnValue({ ip: expectedIp }),
+      }),
+    } as any;
+
+    const result = getIpFactory(undefined, mockCtx);
+
+    expect(result).toBe(expectedIp);
+  });
+
+  it('should return x-forwarded-for if request.ip is invalid but x-forwarded-for is valid', () => {
+    const mockCtx = {
+      switchToHttp: jest.fn().mockReturnValue({
+        getRequest: jest.fn().mockReturnValue({
+          ip: undefined,
+          headers: {
+            'x-forwarded-for': '8.8.8.8',
+          },
+        }),
+      }),
+    } as any;
+
+    const result = getIpFactory(undefined, mockCtx);
+
+    expect(result).toBe('8.8.8.8');
+  });
+
+  it('should return X-Real-IP if others are missing', () => {
+    const mockCtx = {
+      switchToHttp: jest.fn().mockReturnValue({
+        getRequest: jest.fn().mockReturnValue({
+          ip: undefined,
+          headers: {
+            'X-Real-IP': '10.0.0.1',
+          },
+        }),
+      }),
+    } as any;
+
+    const result = getIpFactory(undefined, mockCtx);
+
+    expect(result).toBe('10.0.0.1');
+  });
+
+  it('should return undefined if no IP available', () => {
+    const mockCtx = {
+      switchToHttp: jest.fn().mockReturnValue({
+        getRequest: jest
+          .fn()
+          .mockReturnValue({ ip: undefined, headers: {} }),
+      }),
+    } as any;
+
+    const result = getIpFactory(undefined, mockCtx);
+
+    expect(result).toBeUndefined();
+  });
+
+  it('should return undefined if found IP is not valid', () => {
+    const mockCtx = {
+      switchToHttp: jest.fn().mockReturnValue({
+        getRequest: jest.fn().mockReturnValue({
+          ip: 'invalid-ip',
+          headers: {},
+        }),
+      }),
+    } as any;
+
+    const result = getIpFactory(undefined, mockCtx);
+
+    expect(result).toBeUndefined();
+  });
+});

package/src/decorators/get-ip/get-ip.decorator.ts

@@ -0,0 +1,22 @@
+import {
+  createParamDecorator,
+  ExecutionContext,
+} from '@nestjs/common';
+import { isIP } from 'class-validator';
+
+export function getIpFactory(
+  data: unknown,
+  ctx: ExecutionContext,
+): string | undefined {
+  const request = ctx.switchToHttp().getRequest();
+  const ip: string =
+    request.ip ??
+    request.headers['x-forwarded-for'] ??
+    request.headers['X-Real-IP'];
+
+  if (isIP(ip)) {
+    return ip;
+  }
+}
+
+export const GetIp = createParamDecorator(getIpFactory);

package/src/decorators/index.ts

@@ -0,0 +1,2 @@
+export * from './any-of/any-of.decorator';
+export * from './one-of/one-of.decorator';

package/src/decorators/one-of/one-of.decorator.spec.ts

@@ -0,0 +1,87 @@
+import { plainToInstance } from 'class-transformer';
+import {
+  IsEmail,
+  IsNumber,
+  IsOptional,
+  IsString,
+  validate,
+} from 'class-validator';
+
+import { OneOf } from './one-of.decorator';
+
+@OneOf(['email', 'phone'])
+class CreateUserDto {
+  @IsEmail()
+  email: string;
+
+  @IsNumber()
+  phone: number;
+
+  @IsOptional()
+  @IsString()
+  name?: string;
+}
+
+describe('OneOf', () => {
+  it.each<Record<string, string | number>>([
+    { phone: 123456789 },
+    { email: 'some@mail.jp' },
+  ])(
+    'should not throw an error when only email/phone is present',
+    async (plain) => {
+      const user = plainToInstance(CreateUserDto, plain);
+
+      const errors = await validate(user);
+
+      expect(errors).toHaveLength(0);
+    },
+  );
+
+  it.each<Record<string, unknown>>([
+    { email: 123 },
+    { email: 'some junk mail' },
+  ])('should validate email', async (plain) => {
+    const user = plainToInstance(CreateUserDto, plain);
+
+    const errors = await validate(user);
+
+    expect(errors).toHaveLength(1);
+    expect(errors[0].constraints).toStrictEqual({
+      isEmail: 'email must be an email',
+    });
+  });
+
+  it.each<Record<string, unknown>>([
+    { phone: false },
+    { phone: 'junk phone number' },
+  ])('should validate phone', async (plain) => {
+    const user = plainToInstance(CreateUserDto, plain);
+
+    const errors = await validate(user);
+
+    expect(errors).toHaveLength(1);
+    expect(errors[0].constraints).toStrictEqual({
+      isNumber:
+        'phone must be a number conforming to the specified constraints',
+    });
+  });
+
+  it('should not throw an error when both phone and email is present', async () => {
+    const plain = { email: 'gg@pp.cc', phone: 1122334455 };
+    const user = plainToInstance(CreateUserDto, plain);
+
+    const errors = await validate(user);
+
+    expect(errors).toHaveLength(2);
+    expect(errors).toContainEqual({
+      children: [],
+      constraints: {
+        OneOfChecker:
+          'Do not send email, and phone at the same time!',
+      },
+      property: 'email',
+      target: { email: 'gg@pp.cc', phone: 1122334455 },
+      value: 'gg@pp.cc',
+    });
+  });
+});

package/src/decorators/one-of/one-of.decorator.ts

@@ -0,0 +1,99 @@
+import { applyDecorators } from '@nestjs/common';
+import {
+  registerDecorator,
+  ValidateIf,
+  ValidationArguments,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
+
+/**
+ * @description
+ * Throws an error if more than one of the properties are present in the request body/querystring.
+ */
+export function OneOf(properties: string[]) {
+  return function (target: any) {
+    for (const property of properties) {
+      const otherProps = properties.filter(
+        (prop) => prop !== property,
+      );
+
+      applyDecorators(
+        ValidateIf((obj: Record<string, unknown>) => {
+          const areOtherPropsUndefined = otherProps.reduce(
+            (acc, prop) => acc && obj[prop] === undefined,
+            true,
+          );
+          const isCurrentPropDefined = obj[property] !== undefined;
+
+          return isCurrentPropDefined || areOtherPropsUndefined;
+        }),
+        OneOfChecker(properties),
+      )(target.prototype, property);
+    }
+  };
+}
+
+function OneOfChecker(properties: string[]): PropertyDecorator {
+  return function (
+    object: object,
+    propertyName: string | symbol,
+  ): void {
+    registerDecorator({
+      name: 'OneOfChecker',
+      constraints: [properties],
+      target: object.constructor,
+      propertyName: String(propertyName),
+      validator: OneOfCheckerConstraint,
+    });
+  };
+}
+
+@ValidatorConstraint({ name: 'OneOfChecker' })
+class OneOfCheckerConstraint implements ValidatorConstraintInterface {
+  validate(
+    value: unknown,
+    validationArguments: ValidationArguments,
+  ): boolean | Promise<boolean> {
+    let [properties] = validationArguments.constraints as [string[]];
+    properties = properties.filter(
+      (property) => property !== validationArguments.property,
+    );
+    const data = validationArguments.object as Record<
+      string,
+      unknown
+    >;
+
+    for (const property of properties) {
+      const propertyValue = data[property];
+
+      if (!isNil(value) && !isNil(propertyValue)) {
+        return false;
+      }
+    }
+    return true;
+  }
+
+  defaultMessage(validationArguments: ValidationArguments): string {
+    const [properties] = validationArguments.constraints as [
+      string[],
+    ];
+    const props = properties.reduce((accumulator, current, index) => {
+      if (index === properties.length - 2) {
+        accumulator += current + ', and ';
+      } else if (index === properties.length - 1) {
+        accumulator += current;
+      } else {
+        accumulator += current + ', ';
+      }
+
+      return accumulator;
+    }, '');
+
+    return `Do not send ${props} at the same time!`;
+  }
+}
+
+function isNil(value: unknown) {
+  return value === null || value === undefined;
+}

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './correlation-id';
+export * from './decorators';
 export * from './types';