@payfit/audit-log 1.0.0-rc.99 → 1.0.1-alpha

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

@@ -20,119 +20,107 @@ 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
+     * Audit log event environment
      * @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;
-    /**
-     * Audit log event scope
-     * @type {object}
-     * @memberof InlineObject
-     */
-    'scope'?: object;
-    /**
-     * Audit log event timestamp unix format
-     * @type {number}
-     * @memberof InlineObject
-     */
-    'timestamp': number;
+    email?: string;
 }

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

package/dist/transport/implementation.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    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) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        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 {
+    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 { account } = auditLogData, logDataWithoutAccount = __rest(auditLogData, ["account"]);
+            const dataToSend = Object.assign({}, logDataWithoutAccount, account);
+            yield this.api.v1LogPost(dataToSend);
+        });
+    }
+}
+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;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

@@ -1,25 +1,10 @@
-export interface IAuditLogCreationData {
+import { IAuditLogData } from '..';
+export declare type IAuditLogCreationData = IAuditLogData & {
     id: string;
     timestamp: number;
     environment: string;
     service: string;
-    scope?: Record<string, unknown>;
-    countryCode?: string;
-    payload?: Record<string, unknown>;
-    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/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/package.json

@@ -1,58 +1,31 @@
 {
   "name": "@payfit/audit-log",
-  "version": "1.0.0-rc.99",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/PayFit/audit-logs.git",
-    "directory": "sdk"
-  },
+  "version": "1.0.1-alpha",
   "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",
+    "build": "rimraf dist && tsc",
+    "prepublish": "npm run build",
+    "start:playground": "ts-node playground/index.ts"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "axios": "^1.0.0",
-    "lodash": "^4.17.20",
-    "uuid": "^9.0.0"
+    "axios": "0.19.2",
+    "lodash": "4.17.15",
+    "uuid": "7.0.0"
   },
   "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.11.0",
-    "@rollup/plugin-typescript": "11.1.3",
-    "@tsconfig/node18": "18.2.2",
-    "@tsconfig/strictest": "2.0.2",
-    "@types/lodash": "4.14.198",
-    "@types/node": "18.17.15",
-    "@types/uuid": "9.0.4",
-    "@typescript-eslint/eslint-plugin": "6.7.0",
-    "builtin-modules": "3.3.0",
-    "eslint": "8.49.0",
-    "prettier": "3.0.3",
-    "rimraf": "5.0.1",
-    "semantic-release": "20.1.3",
-    "ts-node": "10.9.1",
-    "typescript": "5.2.2",
-    "vite": "4.4.9"
-  },
-  "peerDependencies": {},
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "files": [
-    "dist"
-  ]
+    "@types/lodash": "4.14.149",
+    "@types/uuid": "3.4.7",
+    "prettier": "1.18.2",
+    "rimraf": "2.6.3",
+    "ts-node": "8.3.0",
+    "ts-node-dev": "1.0.0-pre.40",
+    "tslint": "5.18.0",
+    "tslint-config-prettier": "1.18.0",
+    "typescript": "3.5.3"
+  }
 }

package/playground/index.ts

@@ -0,0 +1,30 @@
+import { AuditLogger } from '../src'
+
+const logger = new AuditLogger({
+  apiUrl: 'http://localhost:8090',
+  environment: 'TEST-env',
+  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 invidiaul id',
+    },
+    scope: {
+      employeeId: 'an employee id',
+      companyId: 'a company id',
+    },
+  })
+}
+
+main().catch(err => {
+  console.log('Error:', err)
+})

package/src/index.ts

@@ -0,0 +1,126 @@
+import { v4 as uuidV4 } from 'uuid'
+import { IAuditLogTransport } from './transport/interface'
+import { Transport } from './transport/implementation'
+
+/**
+ * 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: string
+
+  /**
+   * The name of the event.
+   * 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.
+   */
+  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
+    }
+  | 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(data: IAuditLogData) {
+    const uuid = uuidV4()
+    const { environment, service } = this.params
+    const timestamp = new Date().getTime()
+
+    const log = {
+      ...data,
+      service,
+      id: uuid,
+      environment,
+      timestamp,
+    }
+
+    await this.transport.create(log)
+  }
+}

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

@@ -0,0 +1 @@
+4.2.3

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

package/src/transport/generated/api/default-api.ts

@@ -0,0 +1,131 @@
+// 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.
+ */
+
+
+import * as globalImportUrl from 'url';
+import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+
+import { InlineObject } from '../model';
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Creates Audit Log event
+         * @param {InlineObject} inlineObject 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1LogPost(inlineObject: InlineObject, options: any = {}): RequestArgs {
+            // verify required parameter 'inlineObject' is not null or undefined
+            if (inlineObject === null || inlineObject === undefined) {
+                throw new RequiredError('inlineObject','Required parameter inlineObject was null or undefined when calling v1LogPost.');
+            }
+            const localVarPath = `/v1/log`;
+            const localVarUrlObj = globalImportUrl.parse(localVarPath, true);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query};
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers};
+            const needsSerialization = (typeof inlineObject !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.data =  needsSerialization ? JSON.stringify(inlineObject !== undefined ? inlineObject : {}) : (inlineObject || "");
+
+            return {
+                url: globalImportUrl.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export const DefaultApiFp = function(configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Creates Audit Log event
+         * @param {InlineObject} inlineObject 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1LogPost(inlineObject: InlineObject, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void> {
+            const localVarAxiosArgs = DefaultApiAxiosParamCreator(configuration).v1LogPost(inlineObject, options);
+            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+                const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
+                return axios.request(axiosRequestArgs);
+            };
+        },
+    }
+};
+
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    return {
+        /**
+         * 
+         * @summary Creates Audit Log event
+         * @param {InlineObject} inlineObject 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1LogPost(inlineObject: InlineObject, options?: any): AxiosPromise<void> {
+            return DefaultApiFp(configuration).v1LogPost(inlineObject, options)(axios, basePath);
+        },
+    };
+};
+
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export class DefaultApi extends BaseAPI {
+    /**
+     * 
+     * @summary Creates Audit Log event
+     * @param {InlineObject} inlineObject 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1LogPost(inlineObject: InlineObject, options?: any) {
+        return DefaultApiFp(this.configuration).v1LogPost(inlineObject, options)(this.axios, this.basePath);
+    }
+
+}

package/src/transport/generated/api.ts

@@ -0,0 +1,17 @@
+// 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.
+ */
+
+
+
+export * from './api/default-api';
+