@payfit/audit-log 2.0.0-rc.4 → 2.0.1

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

@@ -20,119 +20,119 @@ export interface InlineObject {
      * @type {string}
      * @memberof InlineObject
      */
-    'id': string;
+    id: string;
     /**
      * Audit log event country code
      * @type {string}
      * @memberof InlineObject
      */
-    'countryCode'?: string;
+    countryCode?: string;
     /**
      * Audit log event payload
      * @type {object}
      * @memberof InlineObject
      */
-    'payload'?: object;
+    payload?: object;
     /**
      * id of the payfiter who performed the audit log action, if signed as.
      * @type {string}
      * @memberof InlineObject
      */
-    'internalId'?: string;
+    internalId?: string;
     /**
      * Tells whether the logged action has been made by the system
      * @type {boolean}
      * @memberof InlineObject
      */
-    'isSystem'?: boolean;
+    isSystem?: boolean;
     /**
      * Audit log event namespace (business related)
      * @type {string}
      * @memberof InlineObject
      */
-    'namespace': string;
+    namespace: string;
     /**
      * Audit log event namespace (technical related)
      * @type {string}
      * @memberof InlineObject
      */
-    'service': string;
+    service: string;
     /**
      * Audit log event type
      * @type {string}
      * @memberof InlineObject
      */
-    'event': string;
+    event: string;
     /**
      * Audit log target
      * @type {string}
      * @memberof InlineObject
      */
-    'target': string;
+    target: string;
     /**
      * Audit log event environment, only required when in todd context
      * @type {string}
      * @memberof InlineObject
      */
-    'environment'?: string;
+    environment?: string;
     /**
      * holdingId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'holdingId'?: string;
+    holdingId?: string;
     /**
      * companyId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'companyId'?: string;
+    companyId?: string;
     /**
      * employeeId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'employeeId'?: string;
+    employeeId?: string;
     /**
      * individualId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'individualId'?: string;
+    individualId?: string;
     /**
      * roleId of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'roleId'?: string;
+    roleId?: string;
     /**
      * userIp of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'userIp'?: string;
+    userIp?: string;
     /**
      * specialRole of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'specialRole'?: string;
+    specialRole?: string;
     /**
      * email of the account performing the event
      * @type {string}
      * @memberof InlineObject
      */
-    'email'?: string;
+    email?: string;
     /**
      * Audit log event scope
      * @type {object}
      * @memberof InlineObject
      */
-    'scope'?: object;
+    scope?: object;
     /**
      * Audit log event timestamp unix format
      * @type {number}
      * @memberof InlineObject
      */
-    'timestamp': number;
+    timestamp: number;
 }

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

@@ -0,0 +1,15 @@
+"use strict";
+// tslint:disable
+/**
+ * Audit Logs
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: damian.bursztyn@payfit.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=inline-object.js.map

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

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

package/dist/transport/implementation.js

@@ -0,0 +1,38 @@
+"use strict";
+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.Transport = void 0;
+const generated_1 = require("./generated");
+class Transport {
+    constructor(apiUrl) {
+        this.apiUrl = apiUrl;
+        this.api = new generated_1.DefaultApi({
+            basePath: this.apiUrl,
+        });
+    }
+    create(auditLogData) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.api.v1LogPost(auditLogData);
+            }
+            catch (err) {
+                if (!err.isAxiosError) {
+                    throw err;
+                }
+                const message = ((_a = err.response) === null || _a === void 0 ? void 0 : _a.data) || err.message;
+                throw new Error(message);
+            }
+        });
+    }
+}
+exports.Transport = Transport;
+//# sourceMappingURL=implementation.js.map

package/dist/transport/implementation.js.map

@@ -0,0 +1 @@
+{"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,IAAI;gBACF,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;aACvC;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE;oBACrB,MAAM,GAAG,CAAA;iBACV;gBAED,MAAM,OAAO,GAAG,OAAA,GAAG,CAAC,QAAQ,0CAAE,IAAI,KAAI,GAAG,CAAC,OAAO,CAAA;gBACjD,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAA;aACzB;;KACF;CACF;AArBD,8BAqBC"}

package/dist/transport/interface.d.ts

@@ -1,11 +1,11 @@
-export interface IAuditLogCreationData {
+export declare type IAuditLogCreationData = {
     id: string;
     timestamp: number;
     environment: string;
     service: string;
-    scope?: Record<string, unknown>;
+    scope?: object;
     countryCode?: string;
-    payload?: Record<string, unknown>;
+    payload?: object;
     internalId?: string;
     isSystem?: boolean;
     namespace: string;
@@ -19,7 +19,7 @@ export interface IAuditLogCreationData {
     userIp?: string;
     specialRole?: string;
     email?: string;
-}
+};
 export interface IAuditLogTransport {
     create: (data: IAuditLogCreationData) => Promise<void>;
 }

package/dist/transport/interface.js

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

package/dist/transport/interface.js.map

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

package/openapi-codegen-config.yml

@@ -0,0 +1,6 @@
+withSeparateModelsAndApi: true
+apiPackage: 'api'
+modelPackage: 'model'
+enumPropertyNaming: UPPERCASE
+modelPropertyNaming: camelCase
+withoutPrefixEnums: true

package/openapitools.json

@@ -0,0 +1,6 @@
+{
+  "spaces": 2,
+  "generator-cli": {
+    "version": "4.3.1"
+  }
+}

package/package.json

@@ -1,58 +1,34 @@
 {
   "name": "@payfit/audit-log",
-  "version": "2.0.0-rc.4",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/PayFit/audit-logs.git",
-    "directory": "sdk"
-  },
+  "version": "2.0.1",
   "description": "Library to handle audit logs at Payfit",
   "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
   "scripts": {
-    "generate": "openapi-generator-cli generate -i ../pkg/broker/v1/swagger/openapi.json -g typescript-axios -o src/transport/generated -c openapi-codegen-config.yml",
-    "build": "rimraf dist && vite build",
-    "prepack": "npm run build",
-    "lint": "eslint .",
-    "start:playground": "ts-node src/playground.ts",
-    "format:check": "prettier --check .",
-    "format:fix": "prettier --write .",
-    "release": "semantic-release --noCi"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "type:check": "tsc --noEmit",
+    "codegen:sdk": "openapi-generator-cli generate -i ../pkg/broker/v1/swagger/openapi.json -g typescript-axios -o src/transport/generated -c openapi-codegen-config.yml",
+    "build": "npm run codegen:sdk && rimraf dist && tsc",
+    "prepublishOnly": "npm run build",
+    "start:playground": "ts-node playground/index.ts"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "axios": "^1.0.0",
+    "axios": "0.24.0",
     "lodash": "^4.17.20",
-    "uuid": "^9.0.0"
+    "uuid": "^7.0.3"
   },
   "devDependencies": {
-    "@openapitools/openapi-generator-cli": "2.7.0",
-    "@payfit/browserslist-config": "1.1.1",
-    "@payfit/eslint-config-node": "1.1.0",
-    "@payfit/semantic-release-package-config": "6.13.0",
-    "@rollup/plugin-typescript": "11.1.5",
-    "@tsconfig/node18": "18.2.2",
-    "@tsconfig/strictest": "2.0.2",
-    "@types/lodash": "4.14.202",
-    "@types/node": "20.10.6",
-    "@types/uuid": "9.0.7",
-    "@typescript-eslint/eslint-plugin": "6.17.0",
-    "builtin-modules": "3.3.0",
-    "eslint": "8.56.0",
-    "prettier": "3.1.1",
-    "rimraf": "5.0.5",
-    "semantic-release": "22.0.12",
-    "ts-node": "10.9.2",
-    "typescript": "5.3.3",
-    "vite": "4.5.1"
-  },
-  "peerDependencies": {},
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "files": [
-    "dist"
-  ]
+    "@openapitools/openapi-generator-cli": "2.4.18",
+    "@types/lodash": "4.14.177",
+    "@types/node": "16.11.12",
+    "@types/uuid": "3.4.10",
+    "prettier": "2.5.1",
+    "rimraf": "3.0.2",
+    "ts-node": "10.4.0",
+    "ts-node-dev": "1.1.8",
+    "tslint": "5.20.1",
+    "tslint-config-prettier": "1.18.0",
+    "typescript": "3.9.10"
+  }
 }

package/playground/index.ts

@@ -0,0 +1,37 @@
+import { AuditLogger } from '../src'
+
+const logger = new AuditLogger({
+  apiUrl: 'http://localhost:8090',
+  environment: 't-hello-audit',
+  service: 'auth',
+})
+
+async function main() {
+  await logger.log({
+    event: 'update',
+    target: 'user_settings',
+    namespace: 'auth',
+    payload: {
+      isTest: true,
+    },
+    account: {
+      internalId: 'an internal id',
+      individualId: 'an individual id',
+      employeeId: 'an employee id',
+      holdingId: 'a holding id',
+      companyId: 'a company id',
+      roleId: 'a role id',
+      userIp: '127.0.0.1',
+      countryCode: 'FR',
+      email: 'truc@ok.fr',
+    },
+    scope: {
+      employeeId: 'an employee id',
+      companyId: 'a company id',
+    },
+  })
+}
+
+main().catch((err) => {
+  console.log('Error:', err)
+})

package/src/index.ts

@@ -0,0 +1,199 @@
+import { v4 as uuidV4 } from 'uuid'
+import { IAuditLogTransport } from './transport/interface'
+import { Transport } from './transport/implementation'
+
+/**
+ * The allowed Namespaces for the AuditLog
+ */
+export type AuditNamespaces =
+  | 'employee'
+  | 'company'
+  | 'permissions'
+  | 'absence'
+  | 'expense'
+  | 'advancePayment'
+  | 'auth'
+  | 'billing'
+  | 'modules'
+  | 'integrations'
+  | 'partnerApi'
+  | 'donation'
+  | 'notificationSettings'
+  | 'people'
+  | 'subscriptions'
+
+/**
+ * The allowed targets for the AuditLog
+ */
+export type AuditTargets =
+  | 'reporting'
+  | 'employee'
+  | 'employee.settings'
+  | 'employee-request'
+  | 'company.billings'
+  | 'company.variables'
+  | 'company.settings'
+  | 'company.emails'
+  | 'company.addons'
+  | 'company.plans'
+  | 'user.role'
+  | 'user.account'
+  | 'user.primaryEmail'
+  | 'user.secondaryEmail'
+  | 'user.locale'
+  | 'user.notificationSettings'
+  | 'role'
+  | 'team'
+  | 'department'
+  | 'workflow'
+  | 'integration'
+  | 'apiAccess'
+  | 'individual'
+  | 'association'
+  | 'association.archived'
+  | 'donation'
+  | 'donation.amount'
+  | 'donation.auth.partner.portal'
+  | 'donation.company.onboarding'
+  | 'donation.taxReceipt'
+  | 'donationPayment.status'
+  | 'people.document.comments'
+  | 'people.document.notifications'
+  | 'people.document.reactions'
+  | 'people.document.status'
+  | 'people.document.answers'
+  | 'people.settings'
+  | 'people.relation'
+
+/**
+ * The allowed Events for the AuditLog
+ */
+export type AuditEvents = 'create' | 'update' | 'delete' | 'view' | 'merge'
+
+/**
+ * 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
+
+  /**
+   * The buisness domain impacted.
+   * e.g documents, authentication, ...
+   */
+  namespace: AuditNamespaces
+
+  /**
+   * The name of the event.
+   * e.g. signIn, passwordUpdated, ...
+   */
+  event: AuditEvents
+
+  /**
+   * The target of event.
+   * e.g. user.settings, employee.bonuses, ...
+   */
+  target: AuditTargets
+
+  /**
+   * 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 =
+  | {
+      /**
+       * The id of the payfiter that did the action if it has been made during a siginAs
+       */
+      internalId?: string
+
+      // 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
+    }
+  | {
+      individualId: 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
+  service: string
+}
+
+export class AuditLogger implements IAuditLogger {
+  private transport: IAuditLogTransport
+
+  constructor(protected params: IAuditLoggerInitialization) {
+    this.transport = new Transport(params.apiUrl)
+  }
+
+  async log({ scope, account, ...data }: IAuditLogData) {
+    const uuid = uuidV4()
+    const { environment, service } = this.params
+    const timestamp = Math.floor(Date.now() / 1000)
+
+    const log = {
+      ...data,
+      ...account,
+      service,
+      id: uuid,
+      environment,
+      timestamp,
+      ...(scope && { scope }),
+    }
+
+    await this.transport.create(log)
+  }
+}

package/src/transport/generated/.openapi-generator/VERSION

@@ -0,0 +1 @@
+4.3.1

package/src/transport/generated/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md