@payfit/audit-log 1.0.2 → 1.0.3

package/dist/index.d.ts

@@ -81,5 +81,5 @@ export declare class AuditLogger implements IAuditLogger {
     protected params: IAuditLoggerInitialization;
     private transport;
     constructor(params: IAuditLoggerInitialization);
-    log(data: IAuditLogData): Promise<void>;
+    log({ scope, account, ...data }: IAuditLogData): Promise<void>;
 }

package/dist/index.js

@@ -7,6 +7,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const uuid_1 = require("uuid");
 const implementation_1 = require("./transport/implementation");
@@ -15,13 +26,14 @@ class AuditLogger {
         this.params = params;
         this.transport = new implementation_1.Transport(params.apiUrl);
     }
-    log(data) {
+    log(_a) {
+        var { scope, account } = _a, data = __rest(_a, ["scope", "account"]);
         return __awaiter(this, void 0, void 0, function* () {
             const uuid = uuid_1.v4();
             const { environment, service } = this.params;
             const timestamp = new Date().getTime();
-            const log = Object.assign({}, data, { service, id: uuid, environment,
-                timestamp });
+            const log = Object.assign({}, data, account, { service, id: uuid, environment,
+                timestamp }, (scope && { scope }));
             yield this.transport.create(log);
         });
     }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,+BAAmC;AAEnC,+DAAsD;AAqGtD,MAAa,WAAW;IAGtB,YAAsB,MAAkC;QAAlC,WAAM,GAAN,MAAM,CAA4B;QACtD,IAAI,CAAC,SAAS,GAAG,IAAI,0BAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;IAEK,GAAG,CAAC,IAAmB;;YAC3B,MAAM,IAAI,GAAG,SAAM,EAAE,CAAA;YACrB,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;YAC5C,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;YAEtC,MAAM,GAAG,qBACJ,IAAI,IACP,OAAO,EACP,EAAE,EAAE,IAAI,EACR,WAAW;gBACX,SAAS,GACV,CAAA;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAClC,CAAC;KAAA;CACF;AAtBD,kCAsBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,+BAAmC;AAEnC,+DAAsD;AAqGtD,MAAa,WAAW;IAGtB,YAAsB,MAAkC;QAAlC,WAAM,GAAN,MAAM,CAA4B;QACtD,IAAI,CAAC,SAAS,GAAG,IAAI,0BAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;IAEK,GAAG,CAAC,EAA0C;YAA1C,EAAE,KAAK,EAAE,OAAO,OAA0B,EAAxB,uCAAO;;YACjC,MAAM,IAAI,GAAG,SAAM,EAAE,CAAA;YACrB,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;YAC5C,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;YAEtC,MAAM,GAAG,qBACJ,IAAI,EACJ,OAAO,IACV,OAAO,EACP,EAAE,EAAE,IAAI,EACR,WAAW;gBACX,SAAS,IACN,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,CAAC,CACxB,CAAA;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;;KACjC;CACF;AAxBD,kCAwBC"}

package/dist/transport/generated/model/inline-object.d.ts

@@ -123,4 +123,10 @@ export interface InlineObject {
      * @memberof InlineObject
      */
     email?: string;
+    /**
+     * Audit log event scope
+     * @type {object}
+     * @memberof InlineObject
+     */
+    scope?: object;
 }

package/dist/transport/implementation.d.ts

@@ -1,8 +1,9 @@
 import { DefaultApi } from './generated';
-import { IAuditLogTransport, IAuditLogCreationData } from './interface';
+import { InlineObject } from './generated/model';
+import { IAuditLogTransport } from './interface';
 export declare class Transport implements IAuditLogTransport {
     protected apiUrl: string;
     api: DefaultApi;
     constructor(apiUrl: string);
-    create(auditLogData: IAuditLogCreationData): Promise<void>;
+    create(auditLogData: InlineObject): Promise<void>;
 }

package/dist/transport/implementation.js

@@ -7,17 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const generated_1 = require("./generated");
 class Transport {
@@ -29,9 +18,7 @@ class Transport {
     }
     create(auditLogData) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { account } = auditLogData, logDataWithoutAccount = __rest(auditLogData, ["account"]);
-            const dataToSend = Object.assign({}, logDataWithoutAccount, account);
-            yield this.api.v1LogPost(dataToSend);
+            yield this.api.v1LogPost(auditLogData);
         });
     }
 }

package/dist/transport/implementation.js.map

@@ -1 +1 @@
-{"version":3,"file":"implementation.js","sourceRoot":"","sources":["../../src/transport/implementation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,2CAAwC;AAGxC,MAAa,SAAS;IAGpB,YAAsB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAClC,IAAI,CAAC,GAAG,GAAG,IAAI,sBAAU,CAAC;YACxB,QAAQ,EAAE,IAAI,CAAC,MAAM;SACtB,CAAC,CAAA;IACJ,CAAC;IAEK,MAAM,CAAC,YAAmC;;YAC9C,MAAM,EAAE,OAAO,KAA+B,YAAY,EAAzC,yDAAyC,CAAA;YAE1D,MAAM,UAAU,qBACX,qBAAqB,EACrB,OAAO,CACX,CAAA;YAED,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACtC,CAAC;KAAA;CACF;AAnBD,8BAmBC"}
+{"version":3,"file":"implementation.js","sourceRoot":"","sources":["../../src/transport/implementation.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAwC;AAKxC,MAAa,SAAS;IAGpB,YAAsB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAClC,IAAI,CAAC,GAAG,GAAG,IAAI,sBAAU,CAAC;YACxB,QAAQ,EAAE,IAAI,CAAC,MAAM;SACtB,CAAC,CAAA;IACJ,CAAC;IAEK,MAAM,CAAC,YAA0B;;YACrC,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;QACxC,CAAC;KAAA;CACF;AAZD,8BAYC"}

package/dist/transport/interface.d.ts

@@ -1,9 +1,24 @@
-import { IAuditLogData } from '..';
-export declare type IAuditLogCreationData = IAuditLogData & {
+export declare type IAuditLogCreationData = {
     id: string;
     timestamp: number;
     environment: string;
     service: string;
+    scope?: object;
+    countryCode?: string;
+    payload?: object;
+    internalId?: string;
+    isSystem?: boolean;
+    namespace: string;
+    event: string;
+    target: string;
+    holdingId?: string;
+    companyId?: string;
+    employeeId?: string;
+    individualId?: string;
+    roleId?: string;
+    userIp?: string;
+    specialRole?: string;
+    email?: string;
 };
 export interface IAuditLogTransport {
     create: (data: IAuditLogCreationData) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payfit/audit-log",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Library to handle audit logs at Payfit",
   "main": "dist/index.js",
   "scripts": {

package/src/index.ts

@@ -108,17 +108,19 @@ export class AuditLogger implements IAuditLogger {
     this.transport = new Transport(params.apiUrl)
   }
 
-  async log(data: IAuditLogData) {
+  async log({ scope, account, ...data }: IAuditLogData) {
     const uuid = uuidV4()
     const { environment, service } = this.params
     const timestamp = new Date().getTime()
 
     const log = {
       ...data,
+      ...account,
       service,
       id: uuid,
       environment,
       timestamp,
+      ...(scope && { scope }),
     }
 
     await this.transport.create(log)

package/src/transport/generated/model/inline-object.ts

@@ -127,6 +127,12 @@ export interface InlineObject {
      * @memberof InlineObject
      */
     email?: string;
+    /**
+     * Audit log event scope
+     * @type {object}
+     * @memberof InlineObject
+     */
+    scope?: object;
 }
 
 

package/src/transport/implementation.ts

@@ -1,5 +1,7 @@
 import { DefaultApi } from './generated'
-import { IAuditLogTransport, IAuditLogCreationData } from './interface'
+import { InlineObject } from './generated/model'
+
+import { IAuditLogTransport } from './interface'
 
 export class Transport implements IAuditLogTransport {
   api: DefaultApi
@@ -10,14 +12,7 @@ export class Transport implements IAuditLogTransport {
     })
   }
 
-  async create(auditLogData: IAuditLogCreationData) {
-    const { account, ...logDataWithoutAccount } = auditLogData
-
-    const dataToSend = {
-      ...logDataWithoutAccount,
-      ...account,
-    }
-
-    await this.api.v1LogPost(dataToSend)
+  async create(auditLogData: InlineObject) {
+    await this.api.v1LogPost(auditLogData)
   }
 }

package/src/transport/interface.ts

@@ -1,10 +1,26 @@
 import { IAuditLogData } from '..'
 
-export type IAuditLogCreationData = IAuditLogData & {
+export type IAuditLogCreationData = {
   id: string
   timestamp: number
   environment: string
   service: string
+  scope?: object
+  countryCode?: string
+  payload?: object
+  internalId?: string
+  isSystem?: boolean
+  namespace: string
+  event: string
+  target: string
+  holdingId?: string
+  companyId?: string
+  employeeId?: string
+  individualId?: string
+  roleId?: string
+  userIp?: string
+  specialRole?: string
+  email?: string
 }
 
 export interface IAuditLogTransport {