sim-node-lib 0.4.13 → 0.4.15

package/dist/Eslint/index.d.ts

@@ -1,7 +1 @@
-declare const simEslint: any;
-declare const eslintPluginPrettierRecommended: any;
-declare const FlatCompat: any;
-declare const compat: any;
-declare function basic(dirname: string): any[];
-declare function recommendedBasic(dirname: string): any[];
-declare function recommendedTypeChecked(dirname: string): any[];
+export {};

package/dist/Eslint/index.js

@@ -1,7 +1,39 @@
-const simEslint = require('./plugin/sim-eslint');
-const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sim_eslint_1 = require("./plugin/sim-eslint");
+const recommended_1 = __importDefault(require("eslint-plugin-prettier/recommended"));
 const { FlatCompat } = require('@eslint/eslintrc');
 const compat = new FlatCompat({ resolvePluginsRelativeTo: __dirname });
+const simRules = [
+    {
+        files: ['**/*.ts'],
+        ignores: ['/database/**/*.ts'],
+        languageOptions: {
+            sourceType: 'module',
+            ecmaVersion: 'latest',
+        },
+        plugins: { 'sim-eslint': sim_eslint_1.simEslint },
+        rules: {
+            'sim-eslint/ensure-bindings': 'error',
+            'sim-eslint/use-pubsub-v2': 'error',
+        },
+    },
+    {
+        files: ['start/routes/**/*.ts'],
+        ignores: ['/database/**/*.ts'],
+        languageOptions: {
+            sourceType: 'module',
+            ecmaVersion: 'latest',
+        },
+        plugins: { 'sim-eslint': sim_eslint_1.simEslint },
+        rules: {
+            'sim-eslint/ensure-active-middlewares': 'error',
+        },
+    },
+];
 function basic(dirname) {
     return [
         ...compat.config({
@@ -13,20 +45,8 @@ function basic(dirname) {
             },
             ignorePatterns: ['database/**', 'build/**'],
         }),
-        {
-            files: ['**/*.ts'],
-            ignores: ['/database/**/*.ts'],
-            languageOptions: {
-                sourceType: 'module',
-                ecmaVersion: 'latest',
-            },
-            plugins: { 'sim-eslint': simEslint },
-            rules: {
-                'sim-eslint/ensure-bindings': 'error',
-                'sim-eslint/pub-sub': 'error'
-            },
-        },
-        eslintPluginPrettierRecommended,
+        ...simRules,
+        recommended_1.default,
     ];
 }
 function recommendedBasic(dirname) {
@@ -41,20 +61,8 @@ function recommendedBasic(dirname) {
             },
             ignorePatterns: ['database/**', 'build/**'],
         }),
-        {
-            files: ['**/*.ts'],
-            ignores: ['/database/**/*.ts'],
-            languageOptions: {
-                sourceType: 'module',
-                ecmaVersion: 'latest',
-            },
-            plugins: { 'sim-eslint': simEslint },
-            rules: {
-                'sim-eslint/ensure-bindings': 'error',
-                'sim-eslint/pub-sub': 'error'
-            },
-        },
-        eslintPluginPrettierRecommended,
+        ...simRules,
+        recommended_1.default,
     ];
 }
 function recommendedTypeChecked(dirname) {
@@ -69,20 +77,8 @@ function recommendedTypeChecked(dirname) {
             },
             ignorePatterns: ['database/**', 'build/**'],
         }),
-        {
-            files: ['**/*.ts'],
-            ignores: ['/database/**/*.ts'],
-            languageOptions: {
-                sourceType: 'module',
-                ecmaVersion: 'latest',
-            },
-            plugins: { 'sim-eslint': simEslint },
-            rules: {
-                'sim-eslint/ensure-bindings': 'error',
-                'sim-eslint/pub-sub': 'error'
-            },
-        },
-        eslintPluginPrettierRecommended,
+        ...simRules,
+        recommended_1.default,
     ];
 }
 module.exports.basic = basic;

package/dist/Eslint/plugin/rules/ensure-active-middlewares.d.ts

@@ -0,0 +1,16 @@
+export declare const ensureActiveMiddlewares: {
+    defaultOptions: never[];
+    meta: {
+        type: string;
+        docs: {
+            description: string;
+        };
+        messages: {
+            'ensure-active-middlewares': string;
+        };
+        schema: never[];
+    };
+    create: (context: any) => {
+        Program: () => void;
+    };
+};

package/dist/Eslint/plugin/rules/ensure-active-middlewares.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureActiveMiddlewares = void 0;
+exports.ensureActiveMiddlewares = {
+    defaultOptions: [],
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Enforce not letting commented middlewares in route files.',
+        },
+        messages: {
+            'ensure-active-middlewares': 'Do not leave commented middleware calls in route files.',
+        },
+        schema: [],
+    },
+    create: function (context) {
+        return {
+            Program: () => {
+                const comments = context.sourceCode.getAllComments();
+                for (const comment of comments) {
+                    const commentText = comment.value.trim();
+                    if (commentText.includes('middleware'))
+                        context.report({
+                            loc: comment.loc,
+                            messageId: 'ensure-active-middlewares',
+                        });
+                }
+            },
+        };
+    },
+};

package/dist/Eslint/plugin/rules/ensure-bindings.d.ts

@@ -0,0 +1,11 @@
+export declare const ensureBindingsRule: {
+    meta: {
+        type: string;
+        docs: {
+            description: string;
+        };
+    };
+    create: (context: any) => {
+        CallExpression(node: any): void;
+    };
+};

package/dist/Eslint/plugin/rules/ensure-bindings.js

@@ -1,8 +1,11 @@
-module.exports = {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureBindingsRule = void 0;
+exports.ensureBindingsRule = {
     meta: {
         type: 'problem',
         docs: {
-            description: 'Enforce passing both query and bindings parameters to whereRaw() or rawQuery() method',
+            description: 'Enforce passing both query and bindings parameters to whereRaw(), rawQuery() or other raw DB methods',
         },
     },
     create: function (context) {

package/dist/Eslint/plugin/rules/use-pubsub-v2.d.ts

@@ -0,0 +1,22 @@
+import { TSESTree } from '@typescript-eslint/types/dist';
+export declare const usePubSubV2Rule: {
+    defaultOptions: never[];
+    meta: {
+        type: string;
+        docs: {
+            description: string;
+            url: string;
+        };
+        messages: {
+            'use-pubsub-v2': string;
+        };
+        schema: never[];
+    };
+    create: (context: any) => {
+        CallExpression?: undefined;
+        Program?: undefined;
+    } | {
+        CallExpression: (node: TSESTree.CallExpression) => void;
+        Program: () => void;
+    };
+};

package/dist/Eslint/plugin/rules/use-pubsub-v2.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePubSubV2Rule = void 0;
+exports.usePubSubV2Rule = {
+    defaultOptions: [],
+    meta: {
+        type: 'problem',
+        docs: {
+            description: "Enforce using our lib's V2 PubSub version on API",
+            url: 'https://simlabs.atlassian.net/wiki/x/BwDyEQ',
+        },
+        messages: {
+            'use-pubsub-v2': "Missing our lib's PubSub V2 implementation.",
+        },
+        schema: [],
+    },
+    create: function (context) {
+        const curFilename = context.getFilename();
+        const appProvider = 'AppProvider.ts';
+        const isAppProvider = curFilename.includes(appProvider);
+        if (!isAppProvider) {
+            return {};
+        }
+        return {
+            CallExpression: (node) => {
+                const { callee } = node;
+                if (callee.type === 'MemberExpression' &&
+                    callee.property.type === 'Identifier' &&
+                    callee.property.name === 'listenMessages') {
+                    context.report({
+                        node,
+                        messageId: 'use-pubsub-v2',
+                    });
+                }
+            },
+            Program: () => {
+                const comments = context.sourceCode.getAllComments();
+                for (const comment of comments) {
+                    const commentText = comment.value.trim();
+                    if (commentText.includes('listenMessages') || commentText.includes('listenMessagesV2'))
+                        context.report({
+                            loc: comment.loc,
+                            messageId: 'use-pubsub-v2',
+                        });
+                }
+            },
+        };
+    },
+};

package/dist/Eslint/plugin/sim-eslint.d.ts

@@ -1,12 +1,59 @@
-declare const ensureBindingsRule: any;
-declare const pubSubRule: any;
-declare const plugin: {
+export declare const simEslint: {
     meta: {
         name: string;
         version: string;
     };
     rules: {
-        'ensure-bindings': any;
-        'pub-sub': any;
+        'ensure-active-middlewares': {
+            defaultOptions: never[];
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    'ensure-active-middlewares': string;
+                };
+                schema: never[];
+            };
+            create: (context: any) => {
+                Program: () => void;
+            };
+        };
+        'ensure-bindings': {
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+            };
+            create: (context: any) => {
+                CallExpression(node: any): void;
+            };
+        };
+        'use-pubsub-v2': {
+            defaultOptions: never[];
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                messages: {
+                    'use-pubsub-v2': string;
+                };
+                schema: never[];
+            };
+            create: (context: any) => {
+                CallExpression?: undefined;
+                Program?: undefined;
+            } | {
+                CallExpression: (node: import("@typescript-eslint/types/dist/generated/ast-spec").CallExpression) => void;
+                Program: () => void;
+            };
+        };
+    };
+    languageOptions: {
+        parser: string;
     };
 };

package/dist/Eslint/plugin/sim-eslint.js

@@ -1,10 +1,18 @@
-const ensureBindingsRule = require('./rules/ensure-bindings');
-const pubSubRule = require('./rules/pub-sub');
-const plugin = {
-    meta: { name: 'sim-eslint', version: '1.0.1' },
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simEslint = void 0;
+const ensure_bindings_1 = require("./rules/ensure-bindings");
+const use_pubsub_v2_1 = require("./rules/use-pubsub-v2");
+const ensure_active_middlewares_1 = require("./rules/ensure-active-middlewares");
+const typescriptParser = require.resolve('@typescript-eslint/parser');
+exports.simEslint = {
+    meta: { name: 'sim-eslint', version: '1.0.2' },
     rules: {
-        'ensure-bindings': ensureBindingsRule,
-        'pub-sub': pubSubRule
+        'ensure-active-middlewares': ensure_active_middlewares_1.ensureActiveMiddlewares,
+        'ensure-bindings': ensure_bindings_1.ensureBindingsRule,
+        'use-pubsub-v2': use_pubsub_v2_1.usePubSubV2Rule,
+    },
+    languageOptions: {
+        parser: typescriptParser,
     },
 };
-module.exports = plugin;

package/dist/Helpers/ExceptionHelper.d.ts

@@ -0,0 +1,3 @@
+export default class ExceptionHelper {
+    static findMessage(obj: any): any;
+}

package/dist/Helpers/ExceptionHelper.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ExceptionHelper {
+    static findMessage(obj) {
+        for (const key in obj) {
+            if (obj.hasOwnProperty(key)) {
+                if (key === 'message') {
+                    return obj[key];
+                }
+                else if (typeof obj[key] === 'object') {
+                    const nestedResult = ExceptionHelper.findMessage(obj[key]);
+                    if (nestedResult !== undefined) {
+                        return nestedResult;
+                    }
+                }
+            }
+        }
+        return 'Não foi encontrada uma mensagem nesse objeto.';
+    }
+}
+exports.default = ExceptionHelper;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sim-node-lib",
-  "version": "0.4.13",
+  "version": "0.4.15",
   "description": "Library from SIMLabs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,11 +31,13 @@
     "@adonisjs/mrm-preset": "^5.0.3",
     "@adonisjs/require-ts": "^2.0.13",
     "@eslint/eslintrc": "^2.1.4",
+    "@types/eslint": "^8.56.2",
     "@types/node": "^17.0.41",
     "@types/pino-std-serializers": "^4.0.0",
     "@types/uuid": "^9.0.2",
     "@typescript-eslint/eslint-plugin": "^6.17.0",
     "@typescript-eslint/parser": "^6.17.0",
+    "@typescript-eslint/types": "^6.21.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^5.1.2",

package/dist/Eslint/plugin/rules/pub-sub.d.ts

@@ -1,2 +0,0 @@
-declare let existsPubSubV2: boolean;
-declare let auxAppProvider: boolean;

package/dist/Eslint/plugin/rules/pub-sub.js

@@ -1,37 +0,0 @@
-let existsPubSubV2 = false;
-let auxAppProvider = false;
-module.exports = {
-    meta: {
-        type: 'problem',
-        docs: {
-            description: 'Enforce the use of the v2 of pubsub',
-        },
-    },
-    create: function (context) {
-        const curFilename = context.getFilename();
-        const appProvider = 'AppProvider.ts';
-        const isAppProvider = curFilename.includes(appProvider);
-        return {
-            CallExpression(node) {
-                const callee = node.callee;
-                if (isAppProvider) {
-                    auxAppProvider = true;
-                    if (callee.type === 'MemberExpression' && callee.property.type === 'Identifier' && callee.property.name === 'listenMessagesV2') {
-                        existsPubSubV2 = true;
-                    }
-                }
-                else {
-                    if (auxAppProvider) {
-                        auxAppProvider = false;
-                        if (!existsPubSubV2) {
-                            context.report({
-                                node,
-                                message: '"AppProvider.ts" must contain the v2 of pubsub.',
-                            });
-                        }
-                    }
-                }
-            },
-        };
-    },
-};