@payfit/audit-log 1.0.0 → 1.0.1-alpha

package/dist/index.d.ts

@@ -14,9 +14,14 @@ export interface IAuditLogData {
     namespace: string;
     /**
      * The name of the event.
-     * e.g. signIn, passwordUpdated, bonusAdded, ...
+     * e.g. signIn, passwordUpdated, ...
      */
     event: string;
+    /**
+     * The target of event.
+     * e.g. user.settings, employee.bonuses, ...
+     */
+    target: string;
     /**
      * The data that describes who did perform the logged action.
      */

package/dist/index.js.map

@@ -1 +1 @@
-{"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"}
+{"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"}

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

@@ -62,7 +62,13 @@ export interface InlineObject {
      * @type {string}
      * @memberof InlineObject
      */
-    event?: string;
+    event: string;
+    /**
+     * Audit log target
+     * @type {string}
+     * @memberof InlineObject
+     */
+    target: string;
     /**
      * Audit log event environment
      * @type {string}

package/package.json

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

package/playground/index.ts

@@ -8,7 +8,8 @@ const logger = new AuditLogger({
 
 async function main() {
   await logger.log({
-    event: 'signin',
+    event: 'update',
+    target: 'user_settings',
     namespace: 'auth',
     payload: {
       isTest: true,

package/src/index.ts

@@ -20,10 +20,16 @@ export interface IAuditLogData {
 
   /**
    * The name of the event.
-   * e.g. signIn, passwordUpdated, bonusAdded, ...
+   * e.g. signIn, passwordUpdated, ...
    */
   event: string
 
+  /**
+   * The target of event.
+   * e.g. user.settings, employee.bonuses, ...
+   */
+  target: string
+
   /**
    * The data that describes who did perform the logged action.
    */

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

@@ -66,7 +66,13 @@ export interface InlineObject {
      * @type {string}
      * @memberof InlineObject
      */
-    event?: string;
+    event: string;
+    /**
+     * Audit log target
+     * @type {string}
+     * @memberof InlineObject
+     */
+    target: string;
     /**
      * Audit log event environment
      * @type {string}