@darraghor/eslint-plugin-nestjs-typed 3.18.0 → 3.19.0

package/README.md

@@ -44,6 +44,7 @@ Preventing bugs
 Security
 
 -   should-specify-forbid-unknown-values
+-   api-methods-should-be-guarded
 
 ## Why use this package?
 
@@ -738,3 +739,72 @@ class TestClass {
     thisIsAProp!: string;
 }
 ```
+
+### Rule: api-methods-should-be-guarded
+
+If you require authentication, and don't use a global guard, you should be explicit about how each controller or endpoint is protected, and a UseGuards annotation should cover each.
+
+NOTE: This rule is context-dependent (i.e. it'll generate useless noise if you've got a global guard) and so is OFF by default. It will need manually enabling in the rules section of your eslint config with `"@darraghor/nestjs-typed/api-methods-should-be-guarded": "error"`.
+
+This PASSES - endpoint is protected by an AuthGuard
+
+```ts
+class TestClass {
+    @Get()
+    @UseGuards(AuthGuard('jwt'))
+    public getAll(): Promise<string[]> {
+        return [];
+    }
+}`
+```
+
+This PASSES - entire controller is protected by an AuthGuard
+
+```ts
+@UseGuards(AuthGuard('jwt'))
+class TestClass {
+
+    @Get()
+    public getAll(): Promise<string[]> {
+        return [];
+    }
+
+    @Get()
+    public getOne(): Promise<string> {
+        return "1";
+    }
+}
+```
+
+This PASSES - endpoint is protected by a custom Guard
+
+```ts
+class TestClass {
+    @Post()
+    @UseGuards(MyCustomGuard('hand-gestures'))
+    public getAll(): Promise<string[]> {
+        return [];
+    }
+}
+```
+
+This PASSES - it isn't a controller or an endpoint
+
+```ts
+class TestClass {
+    public getAll(): Promise<string[]> {
+        return [];
+    }
+}
+```
+
+This FAILS - neither the controller nor the endpoint is protected with a guard
+
+```ts
+class TestClass {
+    @Get()
+    public getAll(): Promise<string[]> {
+        return [];
+    }
+}
+```

package/dist/configs/index.d.ts

@@ -21,6 +21,7 @@ declare const allConfigs: {
             "@darraghor/nestjs-typed/validate-nested-of-array-should-set-each": string;
             "@darraghor/nestjs-typed/all-properties-are-whitelisted": string;
             "@darraghor/nestjs-typed/all-properties-have-explicit-defined": string;
+            "@darraghor/nestjs-typed/api-methods-should-be-guarded": string;
         };
     };
     "no-swagger": {

package/dist/configs/recommended.d.ts

@@ -20,6 +20,7 @@ declare const _default: {
         "@darraghor/nestjs-typed/validate-nested-of-array-should-set-each": string;
         "@darraghor/nestjs-typed/all-properties-are-whitelisted": string;
         "@darraghor/nestjs-typed/all-properties-have-explicit-defined": string;
+        "@darraghor/nestjs-typed/api-methods-should-be-guarded": string;
     };
 };
 export = _default;

package/dist/configs/recommended.js

@@ -22,6 +22,7 @@ module.exports = {
         "@darraghor/nestjs-typed/validate-nested-of-array-should-set-each": "error",
         "@darraghor/nestjs-typed/all-properties-are-whitelisted": "error",
         "@darraghor/nestjs-typed/all-properties-have-explicit-defined": "error",
+        "@darraghor/nestjs-typed/api-methods-should-be-guarded": "off",
     },
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVjb21tZW5kZWQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uZmlncy9yZWNvbW1lbmRlZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsaUJBQVM7SUFDTCxNQUFNLEVBQUUsMkJBQTJCO0lBQ25DLGFBQWEsRUFBRSxFQUFDLFVBQVUsRUFBRSxRQUFRLEVBQUM7SUFDckMsS0FBSyxFQUFFO1FBQ0gsMkVBQTJFLEVBQ3ZFLE9BQU87UUFDWCx1REFBdUQsRUFBRTtZQUNyRCxPQUFPO1lBQ1A7Z0JBQ0ksR0FBRyxFQUFFLENBQUMsYUFBYSxDQUFDO2dCQUNwQixlQUFlLEVBQUUsQ0FBQyxjQUFjLEVBQUUsUUFBUSxFQUFFLFFBQVEsQ0FBQzthQUN4RDtTQUNKO1FBQ0QsbUVBQW1FLEVBQy9ELE9BQU87UUFDWCxnRUFBZ0UsRUFDNUQsT0FBTztRQUNYLDREQUE0RCxFQUFFLE9BQU87UUFDckUsMERBQTBELEVBQUUsT0FBTztRQUNuRSx1RUFBdUUsRUFDbkUsT0FBTztRQUNYLDhEQUE4RCxFQUFFLE9BQU87UUFDdkUsa0VBQWtFLEVBQzlELE9BQU87UUFDWCwrRUFBK0UsRUFDM0UsT0FBTztRQUNYLGtFQUFrRSxFQUM5RCxPQUFPO1FBQ1gsd0RBQXdELEVBQUUsT0FBTztRQUNqRSw4REFBOEQsRUFBRSxPQUFPO0tBQzFFO0NBQ0osQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVjb21tZW5kZWQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uZmlncy9yZWNvbW1lbmRlZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsaUJBQVM7SUFDTCxNQUFNLEVBQUUsMkJBQTJCO0lBQ25DLGFBQWEsRUFBRSxFQUFDLFVBQVUsRUFBRSxRQUFRLEVBQUM7SUFDckMsS0FBSyxFQUFFO1FBQ0gsMkVBQTJFLEVBQ3ZFLE9BQU87UUFDWCx1REFBdUQsRUFBRTtZQUNyRCxPQUFPO1lBQ1A7Z0JBQ0ksR0FBRyxFQUFFLENBQUMsYUFBYSxDQUFDO2dCQUNwQixlQUFlLEVBQUUsQ0FBQyxjQUFjLEVBQUUsUUFBUSxFQUFFLFFBQVEsQ0FBQzthQUN4RDtTQUNKO1FBQ0QsbUVBQW1FLEVBQy9ELE9BQU87UUFDWCxnRUFBZ0UsRUFDNUQsT0FBTztRQUNYLDREQUE0RCxFQUFFLE9BQU87UUFDckUsMERBQTBELEVBQUUsT0FBTztRQUNuRSx1RUFBdUUsRUFDbkUsT0FBTztRQUNYLDhEQUE4RCxFQUFFLE9BQU87UUFDdkUsa0VBQWtFLEVBQzlELE9BQU87UUFDWCwrRUFBK0UsRUFDM0UsT0FBTztRQUNYLGtFQUFrRSxFQUM5RCxPQUFPO1FBQ1gsd0RBQXdELEVBQUUsT0FBTztRQUNqRSw4REFBOEQsRUFBRSxPQUFPO1FBQ3ZFLHVEQUF1RCxFQUFFLEtBQUs7S0FDakU7Q0FDSixDQUFDIn0=

package/dist/index.d.ts

@@ -44,6 +44,9 @@ declare const configuration: {
         "all-properties-are-whitelisted": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing-property-decorator", never[], {
             ClassDeclaration(node: import("@typescript-eslint/types/dist/generated/ast-spec").ClassDeclaration): void;
         }>;
+        "api-methods-should-be-guarded": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"apiMethodsShouldBeGuarded", never[], {
+            MethodDefinition(node: import("@typescript-eslint/types/dist/generated/ast-spec").MethodDefinition): void;
+        }>;
     };
     configs: {
         recommended: {
@@ -68,6 +71,7 @@ declare const configuration: {
                 "@darraghor/nestjs-typed/validate-nested-of-array-should-set-each": string;
                 "@darraghor/nestjs-typed/all-properties-are-whitelisted": string;
                 "@darraghor/nestjs-typed/all-properties-have-explicit-defined": string;
+                "@darraghor/nestjs-typed/api-methods-should-be-guarded": string;
             };
         };
         "no-swagger": {

package/dist/rules/apiMethodsShouldBeGuarded/apiMethodsShouldBeGuarded.d.ts

@@ -0,0 +1,6 @@
+import { TSESTree, TSESLint } from "@typescript-eslint/utils";
+export declare const apiMethodsShouldBeGuarded: (node: TSESTree.MethodDefinition) => boolean;
+declare const rule: TSESLint.RuleModule<"apiMethodsShouldBeGuarded", never[], {
+    MethodDefinition(node: TSESTree.MethodDefinition): void;
+}>;
+export default rule;

package/dist/rules/apiMethodsShouldBeGuarded/apiMethodsShouldBeGuarded.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiMethodsShouldBeGuarded = void 0;
+const createRule_1 = require("../../utils/createRule");
+const typedTokenHelpers_1 = require("../../utils/typedTokenHelpers");
+const apiMethodsShouldBeGuarded = (node) => {
+    const hasApiMethodDecorator = typedTokenHelpers_1.typedTokenHelpers.nodeHasDecoratorsNamed(node, ["Get", "Post", "Put", "Delete", "Patch", "Options", "Head", "All"]);
+    const hasUseGuardsDecorator = typedTokenHelpers_1.typedTokenHelpers.nodeHasDecoratorsNamed(node, ["UseGuards"]);
+    function findClassDeclaration(node) {
+        if (node.type === "ClassDeclaration") {
+            return node;
+        }
+        if (node.parent) {
+            return findClassDeclaration(node.parent);
+        }
+        return null;
+    }
+    const classNode = findClassDeclaration(node);
+    const hasUseGuardsDecoratorOnController = classNode
+        ? typedTokenHelpers_1.typedTokenHelpers.nodeHasDecoratorsNamed(classNode, ["UseGuards"])
+        : false;
+    return (hasApiMethodDecorator &&
+        !hasUseGuardsDecorator &&
+        !hasUseGuardsDecoratorOnController);
+};
+exports.apiMethodsShouldBeGuarded = apiMethodsShouldBeGuarded;
+const rule = (0, createRule_1.createRule)({
+    name: "api-methods-should-be-guarded",
+    meta: {
+        docs: {
+            description: "Endpoints should have authentication guards to maintain our security model.",
+            recommended: false,
+            requiresTypeChecking: false,
+        },
+        messages: {
+            apiMethodsShouldBeGuarded: "All controller endpoints should have @UseGuards decorators, or one decorating the root of the Controller.",
+        },
+        schema: [],
+        hasSuggestions: false,
+        type: "suggestion",
+    },
+    defaultOptions: [],
+    create(context) {
+        return {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            MethodDefinition(node) {
+                if ((0, exports.apiMethodsShouldBeGuarded)(node)) {
+                    context.report({
+                        node: node,
+                        messageId: "apiMethodsShouldBeGuarded",
+                    });
+                }
+            },
+        };
+    },
+});
+exports.default = rule;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpTWV0aG9kc1Nob3VsZEJlR3VhcmRlZC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ydWxlcy9hcGlNZXRob2RzU2hvdWxkQmVHdWFyZGVkL2FwaU1ldGhvZHNTaG91bGRCZUd1YXJkZWQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsdURBQWtEO0FBQ2xELHFFQUFnRTtBQUV6RCxNQUFNLHlCQUF5QixHQUFHLENBQUMsSUFBK0IsRUFBRSxFQUFFO0lBQ3pFLE1BQU0scUJBQXFCLEdBQUcscUNBQWlCLENBQUMsc0JBQXNCLENBQ2xFLElBQUksRUFDSixDQUFDLEtBQUssRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sRUFBRSxLQUFLLENBQUMsQ0FDdEUsQ0FBQztJQUVGLE1BQU0scUJBQXFCLEdBQUcscUNBQWlCLENBQUMsc0JBQXNCLENBQ2xFLElBQUksRUFDSixDQUFDLFdBQVcsQ0FBQyxDQUNoQixDQUFDO0lBRUYsU0FBUyxvQkFBb0IsQ0FDekIsSUFBbUI7UUFFbkIsSUFBSSxJQUFJLENBQUMsSUFBSSxLQUFLLGtCQUFrQixFQUFFO1lBQ2xDLE9BQU8sSUFBSSxDQUFDO1NBQ2Y7UUFDRCxJQUFJLElBQUksQ0FBQyxNQUFNLEVBQUU7WUFDYixPQUFPLG9CQUFvQixDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztTQUM1QztRQUNELE9BQU8sSUFBSSxDQUFDO0lBQ2hCLENBQUM7SUFFRCxNQUFNLFNBQVMsR0FBRyxvQkFBb0IsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUU3QyxNQUFNLGlDQUFpQyxHQUFHLFNBQVM7UUFDL0MsQ0FBQyxDQUFDLHFDQUFpQixDQUFDLHNCQUFzQixDQUFDLFNBQVMsRUFBRSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ3BFLENBQUMsQ0FBQyxLQUFLLENBQUM7SUFFWixPQUFPLENBQ0gscUJBQXFCO1FBQ3JCLENBQUMscUJBQXFCO1FBQ3RCLENBQUMsaUNBQWlDLENBQ3JDLENBQUM7QUFDTixDQUFDLENBQUM7QUFsQ1csUUFBQSx5QkFBeUIsNkJBa0NwQztBQUVGLE1BQU0sSUFBSSxHQUFHLElBQUEsdUJBQVUsRUFBQztJQUNwQixJQUFJLEVBQUUsK0JBQStCO0lBQ3JDLElBQUksRUFBRTtRQUNGLElBQUksRUFBRTtZQUNGLFdBQVcsRUFDUCw2RUFBNkU7WUFDakYsV0FBVyxFQUFFLEtBQUs7WUFDbEIsb0JBQW9CLEVBQUUsS0FBSztTQUM5QjtRQUNELFFBQVEsRUFBRTtZQUNOLHlCQUF5QixFQUNyQiwyR0FBMkc7U0FDbEg7UUFDRCxNQUFNLEVBQUUsRUFBRTtRQUNWLGNBQWMsRUFBRSxLQUFLO1FBQ3JCLElBQUksRUFBRSxZQUFZO0tBQ3JCO0lBQ0QsY0FBYyxFQUFFLEVBQUU7SUFDbEIsTUFBTSxDQUNGLE9BRUM7UUFFRCxPQUFPO1lBQ0gsZ0VBQWdFO1lBQ2hFLGdCQUFnQixDQUFDLElBQStCO2dCQUM1QyxJQUFJLElBQUEsaUNBQXlCLEVBQUMsSUFBSSxDQUFDLEVBQUU7b0JBQ2pDLE9BQU8sQ0FBQyxNQUFNLENBQUM7d0JBQ1gsSUFBSSxFQUFFLElBQUk7d0JBQ1YsU0FBUyxFQUFFLDJCQUEyQjtxQkFDekMsQ0FBQyxDQUFDO2lCQUNOO1lBQ0wsQ0FBQztTQUNKLENBQUM7SUFDTixDQUFDO0NBQ0osQ0FBQyxDQUFDO0FBRUgsa0JBQWUsSUFBSSxDQUFDIn0=

package/dist/rules/index.d.ts

@@ -43,5 +43,8 @@ declare const allRules: {
     "all-properties-are-whitelisted": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"missing-property-decorator", never[], {
         ClassDeclaration(node: import("@typescript-eslint/types/dist/generated/ast-spec").ClassDeclaration): void;
     }>;
+    "api-methods-should-be-guarded": import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"apiMethodsShouldBeGuarded", never[], {
+        MethodDefinition(node: import("@typescript-eslint/types/dist/generated/ast-spec").MethodDefinition): void;
+    }>;
 };
 export default allRules;

package/dist/rules/index.js

@@ -16,6 +16,7 @@ const validateNonPrimitiveNeedsDecorators_1 = __importDefault(require("./validat
 const validateNestedOfArrayShouldSetEach_1 = __importDefault(require("./validateNestedOfArrayShouldSetEach/validateNestedOfArrayShouldSetEach"));
 const allPropertiesAreWhitelisted_1 = __importDefault(require("./allPropertiesAreWhitelisted/allPropertiesAreWhitelisted"));
 const allPropertiesHaveExplicitDefined_1 = __importDefault(require("./allPropertiesHaveExplicitDefined/allPropertiesHaveExplicitDefined"));
+const apiMethodsShouldBeGuarded_1 = __importDefault(require("./apiMethodsShouldBeGuarded/apiMethodsShouldBeGuarded"));
 const allRules = {
     "all-properties-have-explicit-defined": allPropertiesHaveExplicitDefined_1.default,
     "api-property-matches-property-optionality": apiPropertyMatchesPropertyOptionality_1.default,
@@ -30,6 +31,7 @@ const allRules = {
     "validated-non-primitive-property-needs-type-decorator": validateNonPrimitiveNeedsDecorators_1.default,
     "validate-nested-of-array-should-set-each": validateNestedOfArrayShouldSetEach_1.default,
     "all-properties-are-whitelisted": allPropertiesAreWhitelisted_1.default,
+    "api-methods-should-be-guarded": apiMethodsShouldBeGuarded_1.default,
 };
 exports.default = allRules;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcnVsZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSwwSEFBa0c7QUFDbEcsaUpBQW1JO0FBQ25JLDBKQUFrSTtBQUNsSSxrSUFBMEc7QUFDMUcsaUpBQXlIO0FBQ3pILCtIQUF1RztBQUN2RyxnS0FBd0k7QUFDeEksbUpBQXVIO0FBQ3ZILG9KQUFnSTtBQUNoSSx1SkFBK0g7QUFDL0gsaUpBQXlIO0FBQ3pILDRIQUFvRztBQUNwRywySUFBbUg7QUFFbkgsTUFBTSxRQUFRLEdBQUc7SUFDYixzQ0FBc0MsRUFBRSwwQ0FBZ0M7SUFDeEUsMkNBQTJDLEVBQ3ZDLCtDQUFxQztJQUN6QywrQkFBK0IsRUFBRSxvQ0FBMEI7SUFDM0QsbURBQW1ELEVBQy9DLDRDQUE0QztJQUNoRCxvQ0FBb0MsRUFBRSx1Q0FBNkI7SUFDbkUsd0NBQXdDLEVBQ3BDLDRDQUFrQztJQUN0QyxrQ0FBa0MsRUFBRSxzQ0FBNEI7SUFDaEUsK0NBQStDLEVBQzNDLGlEQUF1QztJQUMzQyxzQ0FBc0MsRUFBRSw4Q0FBZ0M7SUFDeEUsMENBQTBDLEVBQ3RDLDZDQUF1QztJQUMzQyx1REFBdUQsRUFDbkQsNkNBQW1DO0lBQ3ZDLDBDQUEwQyxFQUN0Qyw0Q0FBa0M7SUFDdEMsZ0NBQWdDLEVBQUUscUNBQTJCO0NBQ2hFLENBQUM7QUFFRixrQkFBZSxRQUFRLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcnVsZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSwwSEFBa0c7QUFDbEcsaUpBQW1JO0FBQ25JLDBKQUFrSTtBQUNsSSxrSUFBMEc7QUFDMUcsaUpBQXlIO0FBQ3pILCtIQUF1RztBQUN2RyxnS0FBd0k7QUFDeEksbUpBQXVIO0FBQ3ZILG9KQUFnSTtBQUNoSSx1SkFBK0g7QUFDL0gsaUpBQXlIO0FBQ3pILDRIQUFvRztBQUNwRywySUFBbUg7QUFDbkgsc0hBQThGO0FBRTlGLE1BQU0sUUFBUSxHQUFHO0lBQ2Isc0NBQXNDLEVBQUUsMENBQWdDO0lBQ3hFLDJDQUEyQyxFQUN2QywrQ0FBcUM7SUFDekMsK0JBQStCLEVBQUUsb0NBQTBCO0lBQzNELG1EQUFtRCxFQUMvQyw0Q0FBNEM7SUFDaEQsb0NBQW9DLEVBQUUsdUNBQTZCO0lBQ25FLHdDQUF3QyxFQUNwQyw0Q0FBa0M7SUFDdEMsa0NBQWtDLEVBQUUsc0NBQTRCO0lBQ2hFLCtDQUErQyxFQUMzQyxpREFBdUM7SUFDM0Msc0NBQXNDLEVBQUUsOENBQWdDO0lBQ3hFLDBDQUEwQyxFQUN0Qyw2Q0FBdUM7SUFDM0MsdURBQXVELEVBQ25ELDZDQUFtQztJQUN2QywwQ0FBMEMsRUFDdEMsNENBQWtDO0lBQ3RDLGdDQUFnQyxFQUFFLHFDQUEyQjtJQUM3RCwrQkFBK0IsRUFBRSxtQ0FBeUI7Q0FDN0QsQ0FBQztBQUVGLGtCQUFlLFFBQVEsQ0FBQyJ9

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "@darraghor/eslint-plugin-nestjs-typed",
-    "version": "3.18.0",
+    "version": "3.19.0",
     "description": "Eslint rules for nestjs projects",
     "scripts": {
         "clean": "rm -Rf ./dist/",
         "build:ci": "npm run build",
         "build": "npm run clean && mkdir ./dist && tsc --project tsconfig.build.json",
         "lint": "npx eslint -c .eslintrc.js --ext .ts './src/**/*.ts' './tests/**/*.ts' --no-error-on-unmatched-pattern",
-        "test": "export NODE_OPTIONS=\"--max-old-space-size=8192\" && npx jest --runInBand --color --reporters=default --no-cache --coverage=false --silent=false -c jest.config.ts",
+        "test": "export NODE_OPTIONS=\"--max-old-space-size=8192\" && npx jest --runInBand --colors --reporters=default --no-cache --coverage=false --silent=false -c jest.config.ts",
         "pre-commit": "npx lint-staged",
         "prettier": "prettier --write src/*",
         "prepare": "husky install",