diff --git a/README.md b/README.md index f0490b6..8775d2b 100644 --- a/README.md +++ b/README.md @@ -131,14 +131,9 @@ export default class Audits extends BaseSchema { table.increments('id') // User id from ctx auth obj - table - .integer('user_id') - .unsigned() - .nullable() - .defaultTo(null) - .references('id') - .inTable('users') - .onDelete('SET NULL') + table.integer('user_id').unsigned().nullable() + // User Model Name + table.string('user_entity_name').defaultTo('users') // Entity Id table.string('auditable_id').nullable() // Entity Name diff --git a/package-lock.json b/package-lock.json index f1e3c85..a6d1b4b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,19 +1,21 @@ { "name": "adonis5-audit", - "version": "3.1.1", + "version": "4.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "adonis5-audit", - "version": "3.1.1", + "version": "4.0.1", "license": "MIT", "dependencies": { "@types/lodash": "^4.14.191", + "change-case": "^4.1.2", "debug": "^4.3.4", "lodash": "^4.17.21", "luxon": "^3.2.1", - "node-exceptions": "^4.0.1" + "node-exceptions": "^4.0.1", + "pluralize": "^8.0.0" }, "devDependencies": { "@adonisjs/auth": "^8.2.3", @@ -34,6 +36,7 @@ "@release-it/bumper": "^4.0.0", "@types/debug": "^4.1.7", "@types/node": "^14.18.36", + "@types/pluralize": "^0.0.33", "@types/ramda": "^0.27.62", "adonis-provider-tester": "^1.2.0", "chai": "^4.3.4", @@ -2689,6 +2692,12 @@ "@types/node": "*" } }, + "node_modules/@types/pluralize": { + "version": "0.0.33", + "resolved": "https://registry.npmjs.org/@types/pluralize/-/pluralize-0.0.33.tgz", + "integrity": "sha512-JOqsl+ZoCpP4e8TDke9W79FDcSgPAR0l6pixx2JHkhnRjvShyYiAYw2LVsnA7K08Y6DeOnaU6ujmENO4os/cYg==", + "dev": true + }, "node_modules/@types/ramda": { "version": "0.27.62", "resolved": "https://registry.npmjs.org/@types/ramda/-/ramda-0.27.62.tgz", @@ -4000,7 +4009,6 @@ "version": "4.1.2", "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", - "dev": true, "dependencies": { "pascal-case": "^3.1.2", "tslib": "^2.0.3" @@ -4045,7 +4053,6 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz", "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==", - "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -4099,7 +4106,6 @@ "version": "4.1.2", "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz", "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==", - "dev": true, "dependencies": { "camel-case": "^4.1.2", "capital-case": "^1.0.4", @@ -5049,7 +5055,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz", "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==", - "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -6410,7 +6415,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", - "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3" @@ -8927,7 +8931,6 @@ "version": "2.0.4", "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz", "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==", - "dev": true, "dependencies": { "capital-case": "^1.0.4", "tslib": "^2.0.3" @@ -12739,7 +12742,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", - "dev": true, "dependencies": { "tslib": "^2.0.3" } @@ -13529,7 +13531,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", - "dev": true, "dependencies": { "lower-case": "^2.0.2", "tslib": "^2.0.3" @@ -14980,7 +14981,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", - "dev": true, "dependencies": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -15112,7 +15112,6 @@ "version": "3.1.2", "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", - "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3" @@ -15122,7 +15121,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz", "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==", - "dev": true, "dependencies": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -15311,7 +15309,6 @@ "version": "8.0.0", "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", - "dev": true, "engines": { "node": ">=4" } @@ -17453,7 +17450,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz", "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==", - "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -17651,7 +17647,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", - "dev": true, "dependencies": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -18538,8 +18533,7 @@ "node_modules/tslib": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.2.0.tgz", - "integrity": "sha512-gS9GVHRU+RGn5KQM2rllAlR3dU6m7AcpJKdtH8gFvQiC4Otgk98XnmMU+nZenHt/+VhnBPWwgrJsyrdcw6i23w==", - "dev": true + "integrity": "sha512-gS9GVHRU+RGn5KQM2rllAlR3dU6m7AcpJKdtH8gFvQiC4Otgk98XnmMU+nZenHt/+VhnBPWwgrJsyrdcw6i23w==" }, "node_modules/tsutils": { "version": "3.21.0", @@ -18906,7 +18900,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz", "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==", - "dev": true, "dependencies": { "tslib": "^2.0.3" } @@ -18915,7 +18908,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz", "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==", - "dev": true, "dependencies": { "tslib": "^2.0.3" } @@ -21711,6 +21703,12 @@ "@types/node": "*" } }, + "@types/pluralize": { + "version": "0.0.33", + "resolved": "https://registry.npmjs.org/@types/pluralize/-/pluralize-0.0.33.tgz", + "integrity": "sha512-JOqsl+ZoCpP4e8TDke9W79FDcSgPAR0l6pixx2JHkhnRjvShyYiAYw2LVsnA7K08Y6DeOnaU6ujmENO4os/cYg==", + "dev": true + }, "@types/ramda": { "version": "0.27.62", "resolved": "https://registry.npmjs.org/@types/ramda/-/ramda-0.27.62.tgz", @@ -22691,7 +22689,6 @@ "version": "4.1.2", "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", - "dev": true, "requires": { "pascal-case": "^3.1.2", "tslib": "^2.0.3" @@ -22726,7 +22723,6 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz", "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==", - "dev": true, "requires": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -22768,7 +22764,6 @@ "version": "4.1.2", "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz", "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==", - "dev": true, "requires": { "camel-case": "^4.1.2", "capital-case": "^1.0.4", @@ -23503,7 +23498,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz", "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==", - "dev": true, "requires": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -24530,7 +24524,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", - "dev": true, "requires": { "no-case": "^3.0.4", "tslib": "^2.0.3" @@ -26468,7 +26461,6 @@ "version": "2.0.4", "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz", "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==", - "dev": true, "requires": { "capital-case": "^1.0.4", "tslib": "^2.0.3" @@ -29428,7 +29420,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", - "dev": true, "requires": { "tslib": "^2.0.3" } @@ -30042,7 +30033,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", - "dev": true, "requires": { "lower-case": "^2.0.2", "tslib": "^2.0.3" @@ -31116,7 +31106,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", - "dev": true, "requires": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -31221,7 +31210,6 @@ "version": "3.1.2", "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", - "dev": true, "requires": { "no-case": "^3.0.4", "tslib": "^2.0.3" @@ -31231,7 +31219,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz", "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==", - "dev": true, "requires": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -31360,8 +31347,7 @@ "pluralize": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", - "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", - "dev": true + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==" }, "prelude-ls": { "version": "1.2.1", @@ -32875,7 +32861,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz", "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==", - "dev": true, "requires": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -33029,7 +33014,6 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", - "dev": true, "requires": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -33707,8 +33691,7 @@ "tslib": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.2.0.tgz", - "integrity": "sha512-gS9GVHRU+RGn5KQM2rllAlR3dU6m7AcpJKdtH8gFvQiC4Otgk98XnmMU+nZenHt/+VhnBPWwgrJsyrdcw6i23w==", - "dev": true + "integrity": "sha512-gS9GVHRU+RGn5KQM2rllAlR3dU6m7AcpJKdtH8gFvQiC4Otgk98XnmMU+nZenHt/+VhnBPWwgrJsyrdcw6i23w==" }, "tsutils": { "version": "3.21.0", @@ -34000,7 +33983,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz", "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==", - "dev": true, "requires": { "tslib": "^2.0.3" } @@ -34009,7 +33991,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz", "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==", - "dev": true, "requires": { "tslib": "^2.0.3" } diff --git a/package.json b/package.json index 506d528..97a10f0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "adonis5-audit", - "version": "3.1.1", + "version": "4.0.0", "description": "Audit provider for AdonisJS 5", "scripts": { "mrm": "mrm --preset=@adonisjs/mrm-preset", @@ -97,10 +97,12 @@ }, "dependencies": { "@types/lodash": "^4.14.191", + "change-case": "^4.1.2", "debug": "^4.3.4", "lodash": "^4.17.21", "luxon": "^3.2.1", - "node-exceptions": "^4.0.1" + "node-exceptions": "^4.0.1", + "pluralize": "^8.0.0" }, "peerDependencies": { "@adonisjs/events": "^7.1.2" @@ -124,6 +126,7 @@ "@release-it/bumper": "^4.0.0", "@types/debug": "^4.1.7", "@types/node": "^14.18.36", + "@types/pluralize": "^0.0.33", "@types/ramda": "^0.27.62", "adonis-provider-tester": "^1.2.0", "chai": "^4.3.4", diff --git a/src/Functional/createAudit.ts b/src/Functional/createAudit.ts index 9856cb8..3248d69 100644 --- a/src/Functional/createAudit.ts +++ b/src/Functional/createAudit.ts @@ -1,6 +1,7 @@ import { get, isNil, omit } from 'lodash' import { RuntimeException } from 'node-exceptions' import resolveAuditModel from '../helpers/resolveAuditModel' +import getUserEntityName from '../helpers/getUserEntityName' /** * Run the audit @@ -34,12 +35,17 @@ export default async function ({ ip = request?.ip() ?? null } + // Pluralize and snackCase user entityName + + console.error('=====', getUserEntityName(auth.user)) + // get user data to store const userId = get(auth, 'user.id', null) // save audit // @ts-ignore return await auditClass.create({ userId, + userEntityName: getUserEntityName(auth.user), auditableId: auditable_id, auditable, event, diff --git a/src/helpers/getUserEntityName.ts b/src/helpers/getUserEntityName.ts new file mode 100644 index 0000000..7daf88c --- /dev/null +++ b/src/helpers/getUserEntityName.ts @@ -0,0 +1,9 @@ +import pluralize from 'pluralize' +import { snakeCase } from 'change-case' + +export default function (userModel: any) { + let userEntityName = Object.getPrototypeOf(userModel).constructor.name + const userEntityNamePlural = pluralize.plural(userEntityName) + const userEntityNamePluralSnackCase = snakeCase(userEntityNamePlural) + return userEntityNamePluralSnackCase +} diff --git a/templates/00000000000_audits.txt b/templates/00000000000_audits.txt index 71de18c..45c6ce7 100644 --- a/templates/00000000000_audits.txt +++ b/templates/00000000000_audits.txt @@ -7,14 +7,9 @@ export default class Audits extends BaseSchema { table.increments('id') // User id from Auth in ctx - table - .integer('user_id') - .unsigned() - .nullable() - .defaultTo(null) - .references('id') - .inTable('users') - .onDelete('SET NULL') + table.integer('user_id').unsigned().nullable() + // User Model Name + table.string('user_entity_name').defaultTo('users') // Entity Id table.string('auditable_id').nullable() // Entity Name diff --git a/templates/Audit.txt b/templates/Audit.txt index 37ba3db..0bf29c3 100644 --- a/templates/Audit.txt +++ b/templates/Audit.txt @@ -9,6 +9,9 @@ export default class Audit extends BaseModel { /** User Id */ + @column() + public userEntityName: string + @column() public userId: number | null = null @belongsTo(() => User, { diff --git a/test/helpers/config.ts b/test/helpers/config.ts index 5d41d6b..861dbcf 100644 --- a/test/helpers/config.ts +++ b/test/helpers/config.ts @@ -51,6 +51,9 @@ export default class Audit extends BaseModel { /** User Id */ + @column() + public userEntityName: string + @column() public userId: number | null = null diff --git a/test/helpers/database.ts b/test/helpers/database.ts index e7e49c6..e3a8417 100644 --- a/test/helpers/database.ts +++ b/test/helpers/database.ts @@ -15,14 +15,9 @@ export async function createAuditsTable(Database: DatabaseContract) { await Database.connection().schema.createTable('audits', (table) => { table.increments('id') // User id from Auth in ctx - table - .integer('user_id') - .unsigned() - .nullable() - .defaultTo(null) - .references('id') - .inTable('users') - .onDelete('SET NULL') + table.integer('user_id').unsigned().notNullable() + // User id from Auth in ctx + table.string('user_entity_name').defaultTo('users') // Entity Id table.string('auditable_id').nullable() // Entity Name