@payfit/audit-log 1.0.0-alpha7 → 1.0.0-alpha8

package/dist/index.d.ts

@@ -12,11 +12,6 @@ export interface IAuditLogData {
      * e.g documents, authentication, ...
      */
     namespace: string;
-    /**
-     * The service name (tech).
-     * e.g files, payroll-api-v2, auth, ...
-     */
-    service: string;
     /**
      * The name of the event.
      * e.g. signIn, passwordUpdated, bonusAdded, ...
@@ -36,9 +31,9 @@ export interface IAuditLogData {
  */
 export declare type IAuditLogAuthData = {
     /**
-     * Tells if the action has been made during a siginAs
+     * The id of the payfiter that did the action if it has been made during a siginAs
      */
-    isImpersonated?: boolean;
+    internalId?: string;
     holdingId?: string;
     companyId?: string;
     employeeId?: string;
@@ -75,10 +70,11 @@ export interface IAuditLogger {
 export interface IAuditLoggerInitialization {
     apiUrl: string;
     environment: string;
+    service: string;
 }
 export declare class AuditLogger implements IAuditLogger {
     protected params: IAuditLoggerInitialization;
     private transport;
     constructor(params: IAuditLoggerInitialization);
-    log(params: IAuditLogData): Promise<void>;
+    log(data: IAuditLogData): Promise<void>;
 }

package/dist/index.js

@@ -15,12 +15,12 @@ class AuditLogger {
         this.params = params;
         this.transport = new implementation_1.Transport(params.apiUrl);
     }
-    log(params) {
+    log(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const uuid = uuid_1.v4();
-            const environment = this.params.environment;
+            const { environment, service } = this.params;
             const timestamp = new Date().getTime();
-            const log = Object.assign({}, params, { id: uuid, environment,
+            const log = Object.assign({}, data, { service, id: uuid, environment,
                 timestamp });
             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;AAoGtD,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,MAAqB;;YAC7B,MAAM,IAAI,GAAG,SAAM,EAAE,CAAA;YACrB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAA;YAC3C,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;YAEtC,MAAM,GAAG,qBACJ,MAAM,IACT,EAAE,EAAE,IAAI,EACR,WAAW;gBACX,SAAS,GACV,CAAA;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAClC,CAAC;KAAA;CACF;AArBD,kCAqBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,+BAAmC;AAEnC,+DAAsD;AA+FtD,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"}

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

@@ -34,13 +34,13 @@ export interface InlineObject {
      */
     payload?: object;
     /**
-     *
-     * @type {boolean}
+     * id of the payfiter who performed the audit log action, if signed as.
+     * @type {string}
      * @memberof InlineObject
      */
-    isImpersonated?: boolean;
+    internalId?: string;
     /**
-     *
+     * Tells whether the logged action has been made by the system
      * @type {boolean}
      * @memberof InlineObject
      */
@@ -70,49 +70,49 @@ export interface InlineObject {
      */
     environment?: string;
     /**
-     * Audit log event holdingId
+     * holdingId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     holdingId?: string;
     /**
-     * Audit log event companyId
+     * companyId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     companyId?: string;
     /**
-     * Audit log event employeeId
+     * employeeId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     employeeId?: string;
     /**
-     * Audit log event individualId
+     * individualId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     individualId?: string;
     /**
-     * Audit log event roleId
+     * roleId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     roleId?: string;
     /**
-     * Audit log event userIp
+     * userIp of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     userIp?: string;
     /**
-     * Audit log event specialRole
+     * specialRole of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     specialRole?: string;
     /**
-     * Audit log event email
+     * email of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */

package/dist/transport/implementation.js

@@ -31,7 +31,6 @@ class Transport {
         return __awaiter(this, void 0, void 0, function* () {
             const { account } = auditLogData, logDataWithoutAccount = __rest(auditLogData, ["account"]);
             const dataToSend = Object.assign({}, logDataWithoutAccount, account);
-            console.log(dataToSend);
             yield this.api.v1LogPost(dataToSend);
         });
     }

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,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YAEvB,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACtC,CAAC;KAAA;CACF;AArBD,8BAqBC"}
+{"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"}

package/dist/transport/interface.d.ts

@@ -3,6 +3,7 @@ export declare type IAuditLogCreationData = IAuditLogData & {
     id: string;
     timestamp: number;
     environment: string;
+    service: string;
 };
 export interface IAuditLogTransport {
     create: (data: IAuditLogCreationData) => Promise<void>;

package/package.json

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

package/playground/index.ts

@@ -3,18 +3,19 @@ import { AuditLogger } from '../src'
 const logger = new AuditLogger({
   apiUrl: 'http://localhost:8090',
   environment: 'TEST-env',
+  service: 'auth',
 })
 
 async function main() {
   await logger.log({
     event: 'signin',
     namespace: 'auth',
-    service: 'auth',
     payload: {
       isTest: true,
     },
     account: {
-      isSystem: true,
+      internalId: 'an internal id',
+      individualId: 'an invidiaul id',
     },
     scope: null,
   })

package/src/index.ts

@@ -18,12 +18,6 @@ export interface IAuditLogData {
    */
   namespace: string
 
-  /**
-   * The service name (tech).
-   * e.g files, payroll-api-v2, auth, ...
-   */
-  service: string
-
   /**
    * The name of the event.
    * e.g. signIn, passwordUpdated, bonusAdded, ...
@@ -47,9 +41,9 @@ export interface IAuditLogData {
 export type IAuditLogAuthData =
   | {
       /**
-       * Tells if the action has been made during a siginAs
+       * The id of the payfiter that did the action if it has been made during a siginAs
        */
-      isImpersonated?: boolean
+      internalId?: string
 
       // the "account" infos
       holdingId?: string
@@ -98,6 +92,7 @@ export interface IAuditLogger {
 export interface IAuditLoggerInitialization {
   apiUrl: string
   environment: string
+  service: string
 }
 
 export class AuditLogger implements IAuditLogger {
@@ -107,13 +102,14 @@ export class AuditLogger implements IAuditLogger {
     this.transport = new Transport(params.apiUrl)
   }
 
-  async log(params: IAuditLogData) {
+  async log(data: IAuditLogData) {
     const uuid = uuidV4()
-    const environment = this.params.environment
+    const { environment, service } = this.params
     const timestamp = new Date().getTime()
 
     const log = {
-      ...params,
+      ...data,
+      service,
       id: uuid,
       environment,
       timestamp,

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

@@ -38,13 +38,13 @@ export interface InlineObject {
      */
     payload?: object;
     /**
-     * 
-     * @type {boolean}
+     * id of the payfiter who performed the audit log action, if signed as.
+     * @type {string}
      * @memberof InlineObject
      */
-    isImpersonated?: boolean;
+    internalId?: string;
     /**
-     * 
+     * Tells whether the logged action has been made by the system
      * @type {boolean}
      * @memberof InlineObject
      */
@@ -74,49 +74,49 @@ export interface InlineObject {
      */
     environment?: string;
     /**
-     * Audit log event holdingId
+     * holdingId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     holdingId?: string;
     /**
-     * Audit log event companyId
+     * companyId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     companyId?: string;
     /**
-     * Audit log event employeeId
+     * employeeId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     employeeId?: string;
     /**
-     * Audit log event individualId
+     * individualId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     individualId?: string;
     /**
-     * Audit log event roleId
+     * roleId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     roleId?: string;
     /**
-     * Audit log event userIp
+     * userIp of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     userIp?: string;
     /**
-     * Audit log event specialRole
+     * specialRole of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
     specialRole?: string;
     /**
-     * Audit log event email
+     * email of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */

package/src/transport/implementation.ts

@@ -18,8 +18,6 @@ export class Transport implements IAuditLogTransport {
       ...account,
     }
 
-    console.log(dataToSend)
-
     await this.api.v1LogPost(dataToSend)
   }
 }

package/src/transport/interface.ts

@@ -4,6 +4,7 @@ export type IAuditLogCreationData = IAuditLogData & {
   id: string
   timestamp: number
   environment: string
+  service: string
 }
 
 export interface IAuditLogTransport {