@golemio/audit-logs 1.0.0-dev.1590464100

package/LICENSE

@@ -0,0 +1,11 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Operátor ICT, a.s.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Source: http://opensource.org/licenses/MIT

package/README.md

@@ -0,0 +1,85 @@
+<div align="center">
+<p>
+    <a href="https://operatorict.cz">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/core/-/raw/development/.assets/oict_logo.png" alt="oict" width="100px" height="100px" />
+    </a>
+    <a href="https://golemio.cz">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/core/-/raw/development/.assets/golemio_logo.png" alt="golemio" width="100px" height="100px" />
+    </a>
+</p>
+
+<h1>@golemio/audit-logs</h1>
+
+<p>
+    <a href="https://gitlab.com/operator-ict/golemio/code/modules/audit-logs/commits/master">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/audit-logs/badges/master/pipeline.svg" alt="pipeline">
+    </a>
+    <a href="https://gitlab.com/operator-ict/golemio/code/modules/audit-logs/commits/master">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/audit-logs/badges/master/coverage.svg" alt="coverage">
+    </a>
+    <a href="./LICENSE">
+        <img src="https://img.shields.io/npm/l/@golemio/audit-logs" alt="license">
+    </a>
+</p>
+
+<p>
+    <a href="#installation">Installation</a> · <a href="./docs">Documentation</a> · <a href="https://operator-ict.gitlab.io/golemio/code/modules/audit-logs">TypeDoc</a>
+</p>
+</div>
+
+This module is intended for use with Golemio services. Refer [here](https://gitlab.com/operator-ict/golemio/code/modules/core/-/blob/master/README.md) for further information on usage, local development and more.
+
+## Installation
+
+The APIs may be unstable. Therefore, we recommend to install this module as an exact version.
+
+```bash
+# Latest version
+npm install --save-exact @golemio/audit-logs@latest
+
+# Development version
+npm install --save-exact @golemio/audit-logs@dev
+```
+
+## Setup
+
+For local integration tests, run database migrations with the `audit_logs` schema.
+
+```bash
+npx golemio migrate-db up --postgres --schema audit_logs
+```
+
+## Usage
+
+For information on how to use this module with default module schema migrations, see [golemio-cli docs](https://gitlab.com/operator-ict/golemio/code/golemio-cli/-/blob/release/docs/migrations.md?ref_type=heads#default-module-schema-migrations).
+
+Configuring the database schema to use for audit logging using dependency injection:
+```ts
+// Di.ts
+import { AuditLogsContainer, AuditLogsContainerToken, AuditLogger, IAuditLogsConfig } from "@golemio/audit-logs";
+
+const YourModuleContainer: DependencyContainer = SomeOtherContainer.createChildContainer();
+
+const config: IAuditLogsConfig = { schema: "your_module_schema" };
+const YourAuditLogsContainer: DependencyContainer = AuditLogsContainer.createChildContainer();
+YourAuditLogsContainer.register(AuditLogsContainerToken.AuditLogsConfig, { useValue: config });
+YourModuleContainer.registerInstance(
+    "your_audit_logs_token", YourAuditLogsContainer.resolve<AuditLogger>(AuditLogsContainerToken.AuditLogger)
+);
+```
+
+The audit logger can then be used as follows:
+```ts
+// YourClass.ts
+import { inject } from "@golemio/core/dist/shared/tsyringe";
+import { AuditLogger } from "@golemio/audit-logs";
+
+export class YourClass {
+    constructor(@inject("your_audit_logs_token") private auditLogger: AuditLogger) {}
+
+    someMethod() {
+        this.auditLogger.log({ action: "test-action", entity: "test-entity", userId: "test-user-id" /*, data: {...} */ });
+        // .then(...).catch(...)
+    }
+}
+```

package/dist/helpers/AuditLogger.d.ts

@@ -0,0 +1,9 @@
+import { IAuditLog } from "../interfaces/IAuditLog";
+import { AuditLogsRepository } from "../repositories/AuditLogsRepository";
+import { AuditLogTransformation } from "../transformations/AuditLogTransformation";
+export declare class AuditLogger {
+    private auditLogsRepository;
+    private auditLogTransformation;
+    constructor(auditLogsRepository: AuditLogsRepository, auditLogTransformation: AuditLogTransformation);
+    log(auditLog: IAuditLog): Promise<void>;
+}

package/dist/helpers/AuditLogger.js

@@ -0,0 +1,49 @@
+"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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogger = void 0;
+const tsyringe_1 = require("@golemio/core/dist/shared/tsyringe");
+const AuditLogsContainerToken_1 = require("../ioc/AuditLogsContainerToken");
+const AuditLogsRepository_1 = require("../repositories/AuditLogsRepository");
+const AuditLogTransformation_1 = require("../transformations/AuditLogTransformation");
+let AuditLogger = exports.AuditLogger = class AuditLogger {
+    constructor(auditLogsRepository, auditLogTransformation) {
+        this.auditLogsRepository = auditLogsRepository;
+        this.auditLogTransformation = auditLogTransformation;
+        // do nothing
+    }
+    log(auditLog) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const transformedAuditLog = this.auditLogTransformation.transformElement(auditLog);
+            yield this.auditLogsRepository.insert(transformedAuditLog);
+        });
+    }
+};
+exports.AuditLogger = AuditLogger = __decorate([
+    (0, tsyringe_1.injectable)(),
+    __param(0, (0, tsyringe_1.inject)(AuditLogsContainerToken_1.AuditLogsContainerToken.AuditLogsRepository)),
+    __param(1, (0, tsyringe_1.inject)(AuditLogsContainerToken_1.AuditLogsContainerToken.AuditLogTransformation)),
+    __metadata("design:paramtypes", [AuditLogsRepository_1.AuditLogsRepository,
+        AuditLogTransformation_1.AuditLogTransformation])
+], AuditLogger);
+//# sourceMappingURL=AuditLogger.js.map

package/dist/helpers/AuditLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditLogger.js","sourceRoot":"","sources":["../../src/helpers/AuditLogger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAwE;AAExE,4EAAyE;AACzE,6EAA0E;AAC1E,sFAAmF;AAG5E,IAAM,WAAW,yBAAjB,MAAM,WAAW;IACpB,YACiE,mBAAwC,EACrC,sBAA8C;QADjD,wBAAmB,GAAnB,mBAAmB,CAAqB;QACrC,2BAAsB,GAAtB,sBAAsB,CAAwB;QAE9G,aAAa;IACjB,CAAC;IAEY,GAAG,CAAC,QAAmB;;YAChC,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACnF,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;QAC/D,CAAC;KAAA;CACJ,CAAA;sBAZY,WAAW;IADvB,IAAA,qBAAU,GAAE;IAGJ,WAAA,IAAA,iBAAM,EAAC,iDAAuB,CAAC,mBAAmB,CAAC,CAAA;IACnD,WAAA,IAAA,iBAAM,EAAC,iDAAuB,CAAC,sBAAsB,CAAC,CAAA;qCAD2B,yCAAmB;QACb,+CAAsB;GAHzG,WAAW,CAYvB"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { AuditLogger } from "./helpers/AuditLogger";
+export { IAuditLog } from "./interfaces/IAuditLog";
+export { IAuditLogsConfig } from "./interfaces/IAuditLogsConfig";
+export { AuditLogsContainerToken } from "./ioc/AuditLogsContainerToken";
+export { AuditLogsContainer } from "./ioc/Di";

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogsContainer = exports.AuditLogsContainerToken = exports.AuditLogger = void 0;
+var AuditLogger_1 = require("./helpers/AuditLogger");
+Object.defineProperty(exports, "AuditLogger", { enumerable: true, get: function () { return AuditLogger_1.AuditLogger; } });
+var AuditLogsContainerToken_1 = require("./ioc/AuditLogsContainerToken");
+Object.defineProperty(exports, "AuditLogsContainerToken", { enumerable: true, get: function () { return AuditLogsContainerToken_1.AuditLogsContainerToken; } });
+var Di_1 = require("./ioc/Di");
+Object.defineProperty(exports, "AuditLogsContainer", { enumerable: true, get: function () { return Di_1.AuditLogsContainer; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAA3C,0GAAA,WAAW,OAAA;AAGpB,yEAAwE;AAA/D,kIAAA,uBAAuB,OAAA;AAChC,+BAA8C;AAArC,wGAAA,kBAAkB,OAAA"}

package/dist/interfaces/IAuditLog.d.ts

@@ -0,0 +1,6 @@
+export interface IAuditLog {
+    action: string;
+    entity: string;
+    userId: string;
+    data?: object;
+}

package/dist/interfaces/IAuditLog.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAuditLog.js.map

package/dist/interfaces/IAuditLog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditLog.js","sourceRoot":"","sources":["../../src/interfaces/IAuditLog.ts"],"names":[],"mappings":""}

package/dist/interfaces/IAuditLogsConfig.d.ts

@@ -0,0 +1,3 @@
+export interface IAuditLogsConfig {
+    schema: string;
+}

package/dist/interfaces/IAuditLogsConfig.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAuditLogsConfig.js.map

package/dist/interfaces/IAuditLogsConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditLogsConfig.js","sourceRoot":"","sources":["../../src/interfaces/IAuditLogsConfig.ts"],"names":[],"mappings":""}

package/dist/ioc/AuditLogsContainerToken.d.ts

@@ -0,0 +1,7 @@
+declare const AuditLogsContainerToken: {
+    AuditLogsConfig: symbol;
+    AuditLogger: symbol;
+    AuditLogsRepository: symbol;
+    AuditLogTransformation: symbol;
+};
+export { AuditLogsContainerToken };

package/dist/ioc/AuditLogsContainerToken.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogsContainerToken = void 0;
+const AuditLogsContainerToken = {
+    /* Config */
+    AuditLogsConfig: Symbol("AuditLogsConfig"),
+    /* Helpers */
+    AuditLogger: Symbol("AuditLogger"),
+    /* Repositories */
+    AuditLogsRepository: Symbol("AuditLogsRepository"),
+    /* Transformations */
+    AuditLogTransformation: Symbol("AuditLogTransformation"),
+};
+exports.AuditLogsContainerToken = AuditLogsContainerToken;
+//# sourceMappingURL=AuditLogsContainerToken.js.map

package/dist/ioc/AuditLogsContainerToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditLogsContainerToken.js","sourceRoot":"","sources":["../../src/ioc/AuditLogsContainerToken.ts"],"names":[],"mappings":";;;AAAA,MAAM,uBAAuB,GAAG;IAC5B,YAAY;IACZ,eAAe,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAC1C,aAAa;IACb,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC;IAClC,kBAAkB;IAClB,mBAAmB,EAAE,MAAM,CAAC,qBAAqB,CAAC;IAClD,qBAAqB;IACrB,sBAAsB,EAAE,MAAM,CAAC,wBAAwB,CAAC;CAC3D,CAAC;AAEO,0DAAuB"}

package/dist/ioc/Di.d.ts

@@ -0,0 +1,3 @@
+import { DependencyContainer } from "@golemio/core/dist/shared/tsyringe";
+declare const AuditLogsContainer: DependencyContainer;
+export { AuditLogsContainer };

package/dist/ioc/Di.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogsContainer = void 0;
+const Di_1 = require("@golemio/core/dist/integration-engine/ioc/Di");
+const AuditLogger_1 = require("../helpers/AuditLogger");
+const AuditLogsRepository_1 = require("../repositories/AuditLogsRepository");
+const AuditLogTransformation_1 = require("../transformations/AuditLogTransformation");
+const AuditLogsContainerToken_1 = require("./AuditLogsContainerToken");
+//#region Initialization
+const AuditLogsContainer = Di_1.IntegrationEngineContainer.createChildContainer();
+exports.AuditLogsContainer = AuditLogsContainer;
+//#endregion
+//#region Config
+const config = { schema: "audit_logs" };
+AuditLogsContainer.register(AuditLogsContainerToken_1.AuditLogsContainerToken.AuditLogsConfig, { useValue: config });
+//#endregion
+//#region Helpers
+AuditLogsContainer.register(AuditLogsContainerToken_1.AuditLogsContainerToken.AuditLogger, AuditLogger_1.AuditLogger);
+//#endregion
+//#region Repositories
+AuditLogsContainer.register(AuditLogsContainerToken_1.AuditLogsContainerToken.AuditLogsRepository, AuditLogsRepository_1.AuditLogsRepository);
+//#endregion
+//#region Transformations
+AuditLogsContainer.register(AuditLogsContainerToken_1.AuditLogsContainerToken.AuditLogTransformation, AuditLogTransformation_1.AuditLogTransformation);
+//# sourceMappingURL=Di.js.map

package/dist/ioc/Di.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Di.js","sourceRoot":"","sources":["../../src/ioc/Di.ts"],"names":[],"mappings":";;;AAAA,qEAA0F;AAE1F,wDAAqD;AAErD,6EAA0E;AAC1E,sFAAmF;AACnF,uEAAoE;AAEpE,wBAAwB;AACxB,MAAM,kBAAkB,GAAwB,+BAA0B,CAAC,oBAAoB,EAAE,CAAC;AAoBzF,gDAAkB;AAnB3B,YAAY;AAEZ,gBAAgB;AAChB,MAAM,MAAM,GAAqB,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;AAC1D,kBAAkB,CAAC,QAAQ,CAAC,iDAAuB,CAAC,eAAe,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3F,YAAY;AAEZ,iBAAiB;AACjB,kBAAkB,CAAC,QAAQ,CAAC,iDAAuB,CAAC,WAAW,EAAE,yBAAW,CAAC,CAAC;AAC9E,YAAY;AAEZ,sBAAsB;AACtB,kBAAkB,CAAC,QAAQ,CAAC,iDAAuB,CAAC,mBAAmB,EAAE,yCAAmB,CAAC,CAAC;AAC9F,YAAY;AAEZ,yBAAyB;AACzB,kBAAkB,CAAC,QAAQ,CAAC,iDAAuB,CAAC,sBAAsB,EAAE,+CAAsB,CAAC,CAAC"}

package/dist/models/AuditLogsModel.d.ts

@@ -0,0 +1,14 @@
+import { JSONSchemaType } from "@golemio/core/dist/shared/ajv";
+import { CreationOptional, InferAttributes, InferCreationAttributes, Model, ModelAttributes } from "@golemio/core/dist/shared/sequelize";
+import { IAuditLog } from "./interfaces/IAuditLog";
+export declare class AuditLogsModel extends Model<InferAttributes<AuditLogsModel>, InferCreationAttributes<AuditLogsModel>> implements IAuditLog {
+    static tableName: string;
+    id: CreationOptional<string>;
+    action: string;
+    entity: string;
+    user_id: string;
+    data?: object | null;
+    created_at: CreationOptional<Date>;
+    static attributeModel: ModelAttributes<AuditLogsModel>;
+    static jsonSchema: JSONSchemaType<IAuditLog[]>;
+}

package/dist/models/AuditLogsModel.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogsModel = void 0;
+const sequelize_1 = require("@golemio/core/dist/shared/sequelize");
+class AuditLogsModel extends sequelize_1.Model {
+}
+exports.AuditLogsModel = AuditLogsModel;
+AuditLogsModel.tableName = "audit_logs";
+AuditLogsModel.attributeModel = {
+    id: {
+        primaryKey: true,
+        type: sequelize_1.DataTypes.UUID,
+        allowNull: false,
+        defaultValue: sequelize_1.DataTypes.UUIDV4,
+    },
+    action: {
+        type: sequelize_1.DataTypes.TEXT,
+        allowNull: false,
+    },
+    entity: {
+        type: sequelize_1.DataTypes.TEXT,
+        allowNull: false,
+    },
+    user_id: {
+        type: sequelize_1.DataTypes.TEXT,
+        allowNull: false,
+    },
+    data: {
+        type: sequelize_1.DataTypes.JSONB,
+        allowNull: true,
+    },
+    created_at: {
+        type: sequelize_1.DataTypes.DATE,
+        allowNull: false,
+        defaultValue: sequelize_1.DataTypes.NOW,
+    },
+};
+AuditLogsModel.jsonSchema = {
+    type: "array",
+    items: {
+        type: "object",
+        properties: {
+            action: { type: "string" },
+            entity: { type: "string" },
+            user_id: { type: "string" },
+            data: {
+                type: "object",
+                additionalProperties: true,
+                nullable: true,
+            },
+        },
+        additionalProperties: false,
+        required: ["action", "entity", "user_id"],
+    },
+};
+//# sourceMappingURL=AuditLogsModel.js.map

package/dist/models/AuditLogsModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditLogsModel.js","sourceRoot":"","sources":["../../src/models/AuditLogsModel.ts"],"names":[],"mappings":";;;AACA,mEAO6C;AAG7C,MAAa,cACT,SAAQ,iBAA+E;;AAD3F,wCA6DC;AAzDiB,wBAAS,GAAG,YAAY,CAAC;AASzB,6BAAc,GAAoC;IAC5D,EAAE,EAAE;QACA,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,qBAAS,CAAC,IAAI;QACpB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,qBAAS,CAAC,MAAM;KACjC;IACD,MAAM,EAAE;QACJ,IAAI,EAAE,qBAAS,CAAC,IAAI;QACpB,SAAS,EAAE,KAAK;KACnB;IACD,MAAM,EAAE;QACJ,IAAI,EAAE,qBAAS,CAAC,IAAI;QACpB,SAAS,EAAE,KAAK;KACnB;IACD,OAAO,EAAE;QACL,IAAI,EAAE,qBAAS,CAAC,IAAI;QACpB,SAAS,EAAE,KAAK;KACnB;IACD,IAAI,EAAE;QACF,IAAI,EAAE,qBAAS,CAAC,KAAK;QACrB,SAAS,EAAE,IAAI;KAClB;IACD,UAAU,EAAE;QACR,IAAI,EAAE,qBAAS,CAAC,IAAI;QACpB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,qBAAS,CAAC,GAAG;KAC9B;CACJ,CAAC;AAEY,yBAAU,GAAgC;IACpD,IAAI,EAAE,OAAO;IACb,KAAK,EAAE;QACH,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACR,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC3B,IAAI,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,IAAI;gBAC1B,QAAQ,EAAE,IAAI;aACjB;SACJ;QACD,oBAAoB,EAAE,KAAK;QAC3B,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC;KAC5C;CACJ,CAAC"}

package/dist/models/interfaces/IAuditLog.d.ts

@@ -0,0 +1,6 @@
+export interface IAuditLog {
+    action: string;
+    entity: string;
+    user_id: string;
+    data?: object | null;
+}

package/dist/models/interfaces/IAuditLog.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAuditLog.js.map

package/dist/models/interfaces/IAuditLog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditLog.js","sourceRoot":"","sources":["../../../src/models/interfaces/IAuditLog.ts"],"names":[],"mappings":""}

package/dist/repositories/AuditLogsRepository.d.ts

@@ -0,0 +1,18 @@
+import { ILogger } from "@golemio/core/dist/helpers";
+import { IDatabaseConnector } from "@golemio/core/dist/helpers/data-access/postgres/IDatabaseConnector";
+import { AbstractValidatableRepository } from "@golemio/core/dist/helpers/data-access/postgres/repositories/AbstractValidatableRepository";
+import { JSONSchemaValidator } from "@golemio/core/dist/shared/golemio-validator";
+import { ModelStatic } from "@golemio/core/dist/shared/sequelize";
+import { IAuditLogsConfig } from "../interfaces/IAuditLogsConfig";
+import { AuditLogsModel } from "../models/AuditLogsModel";
+import { IAuditLog } from "../models/interfaces/IAuditLog";
+export declare class AuditLogsRepository extends AbstractValidatableRepository {
+    private logger;
+    private config;
+    validator: JSONSchemaValidator;
+    tableName: string;
+    schema: string;
+    private sequelizeModel;
+    constructor(connector: IDatabaseConnector, logger: ILogger, config: IAuditLogsConfig);
+    insert(data: IAuditLog): Promise<ReturnType<ModelStatic<AuditLogsModel>["create"]>>;
+}

package/dist/repositories/AuditLogsRepository.js

@@ -0,0 +1,71 @@
+"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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogsRepository = void 0;
+const AbstractValidatableRepository_1 = require("@golemio/core/dist/helpers/data-access/postgres/repositories/AbstractValidatableRepository");
+const CoreToken_1 = require("@golemio/core/dist/helpers/ioc/CoreToken");
+const golemio_errors_1 = require("@golemio/core/dist/shared/golemio-errors");
+const golemio_validator_1 = require("@golemio/core/dist/shared/golemio-validator");
+const sequelize_1 = require("@golemio/core/dist/shared/sequelize");
+const tsyringe_1 = require("@golemio/core/dist/shared/tsyringe");
+const AuditLogsContainerToken_1 = require("../ioc/AuditLogsContainerToken");
+const AuditLogsModel_1 = require("../models/AuditLogsModel");
+let AuditLogsRepository = exports.AuditLogsRepository = class AuditLogsRepository extends AbstractValidatableRepository_1.AbstractValidatableRepository {
+    constructor(connector, logger, config) {
+        super(connector, logger);
+        this.logger = logger;
+        this.config = config;
+        this.tableName = AuditLogsModel_1.AuditLogsModel.tableName;
+        this.schema = this.config.schema;
+        this.validator = new golemio_validator_1.JSONSchemaValidator("AuditLogsRepository", AuditLogsModel_1.AuditLogsModel.jsonSchema);
+        this.sequelizeModel = connector
+            .getConnection()
+            .define(this.tableName, AuditLogsModel_1.AuditLogsModel.attributeModel, { schema: this.schema, updatedAt: false });
+    }
+    insert(data) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.sequelizeModel.create(data);
+            }
+            catch (err) {
+                if (err instanceof sequelize_1.ValidationError && ((_a = err.errors) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                    const mappedErrors = err.errors.map((e) => `${e.message} (${e.value})`).join(", ");
+                    throw new golemio_errors_1.ValidationError(`Validation error in insert: ${mappedErrors}`, this.constructor.name, err);
+                }
+                if (err instanceof sequelize_1.DatabaseError) {
+                    throw new golemio_errors_1.GeneralError(`Error in insert: ${err.parent}`, this.constructor.name, err);
+                }
+                throw new golemio_errors_1.GeneralError("Error in insert", this.constructor.name, err);
+            }
+        });
+    }
+};
+exports.AuditLogsRepository = AuditLogsRepository = __decorate([
+    (0, tsyringe_1.injectable)(),
+    __param(0, (0, tsyringe_1.inject)(CoreToken_1.CoreToken.PostgresConnector)),
+    __param(1, (0, tsyringe_1.inject)(CoreToken_1.CoreToken.Logger)),
+    __param(2, (0, tsyringe_1.inject)(AuditLogsContainerToken_1.AuditLogsContainerToken.AuditLogsConfig)),
+    __metadata("design:paramtypes", [Object, Object, Object])
+], AuditLogsRepository);
+//# sourceMappingURL=AuditLogsRepository.js.map

package/dist/repositories/AuditLogsRepository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditLogsRepository.js","sourceRoot":"","sources":["../../src/repositories/AuditLogsRepository.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAEA,8IAA2I;AAC3I,wEAAqE;AACrE,6EAAyF;AACzF,mFAAkF;AAClF,mEAI6C;AAC7C,iEAAwE;AAExE,4EAAyE;AACzE,6DAA0D;AAInD,IAAM,mBAAmB,iCAAzB,MAAM,mBAAoB,SAAQ,6DAA6B;IAOlE,YACyC,SAA6B,EACxC,MAAuB,EACA,MAAgC;QAEjF,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAHS,WAAM,GAAN,MAAM,CAAS;QACQ,WAAM,GAAN,MAAM,CAAkB;QAR9E,cAAS,GAAG,+BAAc,CAAC,SAAS,CAAC;QAWxC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,uCAAmB,CAAC,qBAAqB,EAAE,+BAAc,CAAC,UAAU,CAAC,CAAC;QAC3F,IAAI,CAAC,cAAc,GAAG,SAAS;aAC1B,aAAa,EAAE;aACf,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,+BAAc,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1G,CAAC;IAEY,MAAM,CAAC,IAAe;;;YAC/B,IAAI;gBACA,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aACjD;YAAC,OAAO,GAAG,EAAE;gBACV,IAAI,GAAG,YAAY,2BAAwB,IAAI,CAAA,MAAA,GAAG,CAAC,MAAM,0CAAE,MAAM,IAAG,CAAC,EAAE;oBACnE,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACnF,MAAM,IAAI,gCAAe,CAAC,+BAA+B,YAAY,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;iBACxG;gBACD,IAAI,GAAG,YAAY,yBAAsB,EAAE;oBACvC,MAAM,IAAI,6BAAY,CAAC,oBAAoB,GAAG,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;iBACxF;gBACD,MAAM,IAAI,6BAAY,CAAC,iBAAiB,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;aACzE;;KACJ;CACJ,CAAA;8BAlCY,mBAAmB;IAD/B,IAAA,qBAAU,GAAE;IASJ,WAAA,IAAA,iBAAM,EAAC,qBAAS,CAAC,iBAAiB,CAAC,CAAA;IACnC,WAAA,IAAA,iBAAM,EAAC,qBAAS,CAAC,MAAM,CAAC,CAAA;IACxB,WAAA,IAAA,iBAAM,EAAC,iDAAuB,CAAC,eAAe,CAAC,CAAA;;GAV3C,mBAAmB,CAkC/B"}

package/dist/transformations/AuditLogTransformation.d.ts

@@ -0,0 +1,10 @@
+import { AbstractTransformation } from "@golemio/core/dist/helpers/transformation/AbstractTransformation";
+import { IAuditLog } from "../interfaces/IAuditLog";
+import { IAuditLog as IAuditLogModel } from "../models/interfaces/IAuditLog";
+type TransformIn = IAuditLog;
+type TransformOut = IAuditLogModel;
+export declare class AuditLogTransformation extends AbstractTransformation<TransformIn, TransformOut> {
+    name: string;
+    protected transformInternal: (auditLog: TransformIn) => TransformOut;
+}
+export {};

package/dist/transformations/AuditLogTransformation.js

@@ -0,0 +1,22 @@
+"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.AuditLogTransformation = void 0;
+const AbstractTransformation_1 = require("@golemio/core/dist/helpers/transformation/AbstractTransformation");
+const tsyringe_1 = require("@golemio/core/dist/shared/tsyringe");
+let AuditLogTransformation = exports.AuditLogTransformation = class AuditLogTransformation extends AbstractTransformation_1.AbstractTransformation {
+    constructor() {
+        super(...arguments);
+        this.name = "AuditLogTransformation";
+        this.transformInternal = (auditLog) => (Object.assign({ action: auditLog.action, entity: auditLog.entity, user_id: auditLog.userId }, (auditLog.data ? { data: auditLog.data } : {})));
+    }
+};
+exports.AuditLogTransformation = AuditLogTransformation = __decorate([
+    (0, tsyringe_1.injectable)()
+], AuditLogTransformation);
+//# sourceMappingURL=AuditLogTransformation.js.map

package/dist/transformations/AuditLogTransformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditLogTransformation.js","sourceRoot":"","sources":["../../src/transformations/AuditLogTransformation.ts"],"names":[],"mappings":";;;;;;;;;AAAA,6GAA0G;AAC1G,iEAAgE;AAQzD,IAAM,sBAAsB,oCAA5B,MAAM,sBAAuB,SAAQ,+CAAiD;IAAtF;;QACI,SAAI,GAAG,wBAAwB,CAAC;QAE7B,sBAAiB,GAAG,CAAC,QAAqB,EAAgB,EAAE,CAAC,iBACnE,MAAM,EAAE,QAAQ,CAAC,MAAM,EACvB,MAAM,EAAE,QAAQ,CAAC,MAAM,EACvB,OAAO,EAAE,QAAQ,CAAC,MAAM,IACrB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACnD,CAAC;IACP,CAAC;CAAA,CAAA;iCATY,sBAAsB;IADlC,IAAA,qBAAU,GAAE;GACA,sBAAsB,CASlC"}

package/package.json

@@ -0,0 +1,75 @@
+{
+    "name": "@golemio/audit-logs",
+    "version": "1.0.0-dev.1590464100",
+    "description": "Golemio Audit Logs Module",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "directories": {
+        "doc": "docs"
+    },
+    "scripts": {
+        "build": "rimraf ./dist && tspc -p ./tsconfig.build.json",
+        "build-minimal": "run-s 'build -- --sourceMap false --declaration false'",
+        "build-watch": "run-s 'build -- --watch --preserveWatchOutput'",
+        "pretest": "golemio import-db-data",
+        "test": "cross-env NODE_ENV='test' TZ='UTC' mocha --exit --check-leaks --timeout 120000 --reporter-option maxDiffSize=0 -r ts-node/register -r tsconfig-paths/register --file 'test/setup.ts' -r dotenv/config 'test/**/*.test.ts'",
+        "test-debug": "run-s 'test -- --inspect-brk=9230'",
+        "code-coverage": "nyc run-s 'test -- -r source-map-support/register'",
+        "generate-docs": "typedoc --out docs/typedoc src",
+        "lint": "eslint --cache \"{src,test}/**/*.ts\""
+    },
+    "keywords": [
+        "golemio"
+    ],
+    "author": "Operator ICT, a.s.",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://gitlab.com/operator-ict/golemio/code/modules/audit-logs"
+    },
+    "engines": {
+        "node": ">=20.0.0",
+        "npm": ">=8.0.0"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "^11.0.0",
+        "@commitlint/config-conventional": "^11.0.0",
+        "@golemio/cli": "1.7.4-dev.1586271916",
+        "@golemio/core": "1.17.1",
+        "@golemio/eslint-config": "1.1.2",
+        "@types/amqplib": "^0.5.17",
+        "@types/chai": "4.2.3",
+        "@types/chai-as-promised": "7.1.2",
+        "@types/mocha": "^9.1.1",
+        "@types/node": "^20.12.7",
+        "@types/pg-copy-streams": "^1.2.1",
+        "@types/sinon": "^9.0.10",
+        "@types/supertest": "^2.0.10",
+        "body-parser": "^1.19.0",
+        "body-parser-xml": "^2.0.0",
+        "chai": "4.2.0",
+        "chai-as-promised": "7.1.1",
+        "cross-env": "^7.0.3",
+        "dotenv": "^8.2.0",
+        "eslint": "^8.1.1",
+        "husky": "^4.3.7",
+        "mocha": "^10.0.0",
+        "npm-run-all": "^4.1.5",
+        "nyc": "^15.1.0",
+        "prettier": "^2.5.1",
+        "pretty-quick": "^3.1.0",
+        "rimraf": "^3.0.2",
+        "sinon": "^9.2.3",
+        "source-map-support": "0.5.21",
+        "supertest": "^6.0.1",
+        "ts-node": "^10.9.1",
+        "ts-patch": "3.0.0-beta3",
+        "tsconfig-paths": "^4.2.0",
+        "typedoc": "^0.24.8",
+        "typescript": "5.1.3",
+        "typescript-transform-paths": "^3.4.6"
+    },
+    "peerDependencies": {
+        "@golemio/core": ">=1.17.0"
+    }
+}