@payfit/audit-log 1.0.0-alpha4 → 1.0.0-alpha6

package/dist/index.d.ts

@@ -1,18 +1,84 @@
-export interface AuditLogData {
-    countryCode: string;
+/**
+ * Data to audit log.
+ */
+export interface IAuditLogData {
+    /**
+     * The data specific to the audit log.
+     * For example, if we add a bonus to an employee, it could contain the amount, the impacted employeeId, etc...
+     */
     payload?: object;
-    isImpersonated?: boolean;
-    isSystem?: boolean;
+    /**
+     * The buisness domain impacted.
+     * 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, ...
+     */
     event: string;
+    /**
+     * The data that describes who did perform the logged action.
+     */
+    account: IAuditLogAuthData;
+    /**
+     * The scope of the audit log
+     */
+    scope: IAuditLogScope;
+}
+/**
+ * Data used to indentify who performed an action
+ */
+export declare type IAuditLogAuthData = {
+    /**
+     * Tells if the action has been made during a siginAs
+     */
+    isImpersonated?: boolean;
     holdingId?: string;
     companyId?: string;
     employeeId?: string;
-    individualId?: string;
+    individualId: string;
     roleId?: string;
+    /**
+     *
+     */
+    countryCode?: string;
+    /**
+     * The IP address of the user
+     */
     userIp?: string;
-    specialRole?: string;
+    /**
+     * The email address of the user
+     */
     email?: string;
+} | {
+    isSystem: true;
+};
+/**
+ * Data used to "scope" the audit log.
+ * Might be useful to retrieve all actions performed in a holding, a company, or on an employee.
+ */
+export declare type IAuditLogScope = {
+    holdingId: string;
+} | {
+    companyId: string;
+    employeeId?: string;
+} | null;
+export interface IAuditLogger {
+    log: (data: IAuditLogData) => Promise<void>;
+}
+export interface IAuditLoggerInitialization {
+    apiUrl: string;
+    environment: string;
+}
+export declare class AuditLogger implements IAuditLogger {
+    protected params: IAuditLoggerInitialization;
+    private transport;
+    constructor(params: IAuditLoggerInitialization);
+    log(params: IAuditLogData): Promise<void>;
 }
-export declare function auditLog(params: AuditLogData): Promise<void>;

package/dist/index.js

@@ -7,25 +7,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const uuid_1 = require("uuid");
-const transport = __importStar(require("./transport/implementation"));
-function auditLog(params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const uuid = uuid_1.v4();
-        const environment = process.env.ENVIRONMENT;
-        const timestamp = new Date().getTime();
-        const log = Object.assign({}, params, { id: uuid, environment,
-            timestamp });
-        yield transport.auditLog(log);
-    });
+const implementation_1 = require("./transport/implementation");
+class AuditLogger {
+    constructor(params) {
+        this.params = params;
+        this.transport = new implementation_1.Transport(params.apiUrl);
+    }
+    log(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const uuid = uuid_1.v4();
+            const environment = this.params.environment;
+            const timestamp = new Date().getTime();
+            const log = Object.assign({}, params, { id: uuid, environment,
+                timestamp });
+            yield this.transport.create(log);
+        });
+    }
 }
-exports.auditLog = auditLog;
+exports.AuditLogger = AuditLogger;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+BAAmC;AACnC,sEAAuD;AAoBvD,SAAsB,QAAQ,CAAC,MAAoB;;QACjD,MAAM,IAAI,GAAG,SAAM,EAAE,CAAA;QACrB,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAA;QAC3C,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QAEtC,MAAM,GAAG,qBACJ,MAAM,IACT,EAAE,EAAE,IAAI,EACR,WAAW;YACX,SAAS,GACV,CAAA;QAED,MAAM,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC/B,CAAC;CAAA;AAbD,4BAaC"}
+{"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"}

package/dist/transport/generated/model/index.js

@@ -1,7 +1,3 @@
 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./inline-object"));
 //# sourceMappingURL=index.js.map

package/dist/transport/generated/model/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/transport/generated/model/index.ts"],"names":[],"mappings":";;;;;AAAA,qCAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/transport/generated/model/index.ts"],"names":[],"mappings":""}

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

@@ -26,7 +26,7 @@ export interface InlineObject {
      * @type {string}
      * @memberof InlineObject
      */
-    countryCode: CountryCodeEnum;
+    countryCode?: string;
     /**
      * Audit log event payload
      * @type {object}
@@ -118,14 +118,3 @@ export interface InlineObject {
      */
     email?: string;
 }
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum CountryCodeEnum {
-    FR = "fr",
-    DE = "de",
-    IT = "it",
-    ES = "es",
-    GB = "gb"
-}

package/dist/transport/generated/model/inline-object.js

@@ -12,16 +12,4 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-/**
-    * @export
-    * @enum {string}
-    */
-var CountryCodeEnum;
-(function (CountryCodeEnum) {
-    CountryCodeEnum["FR"] = "fr";
-    CountryCodeEnum["DE"] = "de";
-    CountryCodeEnum["IT"] = "it";
-    CountryCodeEnum["ES"] = "es";
-    CountryCodeEnum["GB"] = "gb";
-})(CountryCodeEnum = exports.CountryCodeEnum || (exports.CountryCodeEnum = {}));
 //# sourceMappingURL=inline-object.js.map

package/dist/transport/generated/model/inline-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"inline-object.js","sourceRoot":"","sources":["../../../../src/transport/generated/model/inline-object.ts"],"names":[],"mappings":";AAAA,iBAAiB;AACjB;;;;;;;;;;GAUG;;AAkHH;;;MAGM;AACN,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;AACb,CAAC,EANW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAM1B"}
+{"version":3,"file":"inline-object.js","sourceRoot":"","sources":["../../../../src/transport/generated/model/inline-object.ts"],"names":[],"mappings":";AAAA,iBAAiB;AACjB;;;;;;;;;;GAUG"}

package/dist/transport/implementation.d.ts

@@ -1,2 +1,8 @@
-import { AuditLogCreationData } from './interface';
-export declare function auditLog(auditLogData: AuditLogCreationData): Promise<import("axios").AxiosResponse<void>>;
+import { DefaultApi } from './generated';
+import { IAuditLogTransport, IAuditLogCreationData } from './interface';
+export declare class Transport implements IAuditLogTransport {
+    protected apiUrl: string;
+    api: DefaultApi;
+    constructor(apiUrl: string);
+    create(auditLogData: IAuditLogCreationData): Promise<void>;
+}

package/dist/transport/implementation.js

@@ -20,15 +20,20 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const generated_1 = require("./generated");
-const api = new generated_1.DefaultApi({
-    basePath: process.env.AUDIT_LOG_API_URL,
-});
-function auditLog(auditLogData) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { countryCode, payload } = auditLogData, data = __rest(auditLogData, ["countryCode", "payload"]);
-        const dataToSend = Object.assign({}, data, { countryCode: countryCode, payload });
-        return api.v1LogPost(dataToSend);
-    });
+class Transport {
+    constructor(apiUrl) {
+        this.apiUrl = apiUrl;
+        this.api = new generated_1.DefaultApi({
+            basePath: this.apiUrl,
+        });
+    }
+    create(auditLogData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { payload } = auditLogData, data = __rest(auditLogData, ["payload"]);
+            const dataToSend = Object.assign({}, data, { payload });
+            yield this.api.v1LogPost(dataToSend);
+        });
+    }
 }
-exports.auditLog = auditLog;
+exports.Transport = Transport;
 //# sourceMappingURL=implementation.js.map

package/dist/transport/implementation.js.map

@@ -1 +1 @@
-{"version":3,"file":"implementation.js","sourceRoot":"","sources":["../../src/transport/implementation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,2CAAwC;AAIxC,MAAM,GAAG,GAAG,IAAI,sBAAU,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;CACxC,CAAC,CAAA;AAEF,SAAsB,QAAQ,CAAC,YAAkC;;QAC/D,MAAM,EAAE,WAAW,EAAE,OAAO,KAAc,YAAY,EAAxB,uDAAwB,CAAA;QAEtD,MAAM,UAAU,qBACX,IAAI,IACP,WAAW,EAAE,WAA8B,EAC3C,OAAO,GACR,CAAA;QAED,OAAO,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;IAClC,CAAC;CAAA;AAVD,4BAUC"}
+{"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,KAAc,YAAY,EAAxB,wCAAwB,CAAA;YAEzC,MAAM,UAAU,qBACX,IAAI,IACP,OAAO,GACR,CAAA;YAED,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QACtC,CAAC;KAAA;CACF;AAnBD,8BAmBC"}

package/dist/transport/interface.d.ts

@@ -1,5 +1,8 @@
-import { AuditLogData } from '..';
-export declare type AuditLogCreationData = AuditLogData & {
+import { IAuditLogData } from '..';
+export declare type IAuditLogCreationData = IAuditLogData & {
     id: string;
     timestamp: number;
 };
+export interface IAuditLogTransport {
+    create: (data: IAuditLogCreationData) => Promise<void>;
+}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@payfit/audit-log",
-  "version": "1.0.0-alpha4",
+  "version": "1.0.0-alpha6",
   "description": "Library to handle audit logs at Payfit",
   "main": "dist/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "type:check": "tsc --noEmit",
     "build": "rimraf dist && tsc",
     "prepublish": "npm run build"
   },

package/playground/index.ts

@@ -0,0 +1,22 @@
+import { AuditLogger } from '../src'
+
+const logger = new AuditLogger({
+  apiUrl: 'http://localhost:8090',
+  environment: 'TEST-env',
+})
+
+async function main() {
+  await logger.log({
+    countryCode: 'fr',
+    event: 'signin',
+    namespace: 'auth',
+    service: 'auth',
+    payload: {
+      isTest: true,
+    },
+  })
+}
+
+main().catch(err => {
+  console.log('Error:', err)
+})

package/src/index.ts

@@ -1,35 +1,124 @@
 import { v4 as uuidV4 } from 'uuid'
-import * as transport from './transport/implementation'
+import { IAuditLogTransport } from './transport/interface'
+import { Transport } from './transport/implementation'
 
-export interface AuditLogData {
-  countryCode: string
+/**
+ * Data to audit log.
+ */
+export interface IAuditLogData {
+  /**
+   * The data specific to the audit log.
+   * For example, if we add a bonus to an employee, it could contain the amount, the impacted employeeId, etc...
+   */
   payload?: object
-  isImpersonated?: boolean
-  isSystem?: boolean
+
+  /**
+   * The buisness domain impacted.
+   * 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, ...
+   */
   event: string
-  holdingId?: string
-  companyId?: string
-  employeeId?: string
-  individualId?: string
-  roleId?: string
-  userIp?: string
-  specialRole?: string
-  email?: string
+
+  /**
+   * The data that describes who did perform the logged action.
+   */
+  account: IAuditLogAuthData
+
+  /**
+   * The scope of the audit log
+   */
+  scope: IAuditLogScope
+}
+
+/**
+ * Data used to indentify who performed an action
+ */
+export type IAuditLogAuthData =
+  | {
+      /**
+       * Tells if the action has been made during a siginAs
+       */
+      isImpersonated?: boolean
+
+      // the "account" infos
+      holdingId?: string
+      companyId?: string
+      employeeId?: string
+      individualId: string
+      roleId?: string
+
+      /**
+       *
+       */
+      countryCode?: string
+      /**
+       * The IP address of the user
+       */
+      userIp?: string
+      /**
+       * The email address of the user
+       */
+      email?: string
+    }
+  | {
+      /* Indicates that the action has been performed by the system */
+      isSystem: true
+    }
+
+/**
+ * Data used to "scope" the audit log. 
+ * Might be useful to retrieve all actions performed in a holding, a company, or on an employee.
+ */
+export type IAuditLogScope =
+  | {
+      holdingId: string
+    }
+  | {
+      companyId: string
+      employeeId?: string
+    }
+  | null
+
+// warning: modifying this interface means probably make a breaking change to the SDK
+export interface IAuditLogger {
+  log: (data: IAuditLogData) => Promise<void>
+}
+
+export interface IAuditLoggerInitialization {
+  apiUrl: string
+  environment: string
 }
 
-export async function auditLog(params: AuditLogData): Promise<void> {
-  const uuid = uuidV4()
-  const environment = process.env.ENVIRONMENT
-  const timestamp = new Date().getTime()
+export class AuditLogger implements IAuditLogger {
+  private transport: IAuditLogTransport
 
-  const log = {
-    ...params,
-    id: uuid,
-    environment,
-    timestamp,
+  constructor(protected params: IAuditLoggerInitialization) {
+    this.transport = new Transport(params.apiUrl)
   }
 
-  await transport.auditLog(log)
+  async log(params: IAuditLogData) {
+    const uuid = uuidV4()
+    const environment = this.params.environment
+    const timestamp = new Date().getTime()
+
+    const log = {
+      ...params,
+      id: uuid,
+      environment,
+      timestamp,
+    }
+
+    await this.transport.create(log)
+  }
 }

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

@@ -30,7 +30,7 @@ export interface InlineObject {
      * @type {string}
      * @memberof InlineObject
      */
-    countryCode: CountryCodeEnum;
+    countryCode?: string;
     /**
      * Audit log event payload
      * @type {object}
@@ -123,17 +123,4 @@ export interface InlineObject {
     email?: string;
 }
 
-/**
-    * @export
-    * @enum {string}
-    */
-export enum CountryCodeEnum {
-    FR = 'fr',
-    DE = 'de',
-    IT = 'it',
-    ES = 'es',
-    GB = 'gb'
-}
-
-
 

package/src/transport/implementation.ts

@@ -1,19 +1,23 @@
 import { DefaultApi } from './generated'
-import { CountryCodeEnum } from './generated/model'
-import { AuditLogCreationData } from './interface'
+import { IAuditLogTransport, IAuditLogCreationData } from './interface'
 
-const api = new DefaultApi({
-  basePath: process.env.AUDIT_LOG_API_URL,
-})
+export class Transport implements IAuditLogTransport {
+  api: DefaultApi
 
-export async function auditLog(auditLogData: AuditLogCreationData) {
-  const { countryCode, payload, ...data } = auditLogData
-
-  const dataToSend = {
-    ...data,
-    countryCode: countryCode as CountryCodeEnum,
-    payload,
+  constructor(protected apiUrl: string) {
+    this.api = new DefaultApi({
+      basePath: this.apiUrl,
+    })
   }
 
-  return api.v1LogPost(dataToSend)
+  async create(auditLogData: IAuditLogCreationData) {
+    const { payload, ...data } = auditLogData
+
+    const dataToSend = {
+      ...data,
+      payload,
+    }
+
+    await this.api.v1LogPost(dataToSend)
+  }
 }

package/src/transport/interface.ts

@@ -1,6 +1,10 @@
-import { AuditLogData } from '..'
+import { IAuditLogData } from '..'
 
-export type AuditLogCreationData = AuditLogData & {
+export type IAuditLogCreationData = IAuditLogData & {
   id: string
   timestamp: number
 }
+
+export interface IAuditLogTransport {
+  create: (data: IAuditLogCreationData) => Promise<void>
+}