@payfit/audit-log 1.0.0-alpha8 → 1.0.0-rc.100

package/README.md

@@ -0,0 +1,92 @@
+# Audit logs SDK
+
+The SDK is an npm package that makes it easier to call the Audit Log API.
+
+## Using the SDK in your project
+
+First, install it :
+
+```sh
+npm i @payfit/audit-log
+```
+
+Then, you must instanciate a client :
+
+```ts
+import { AuditLogger } from '@payfit/audit-log'
+
+const logger = new AuditLogger({
+  apiUrl: 'http://localhost:8090',
+  environment: 'an-environment-name',
+  service: 'the-name-of-the-service',
+})
+```
+
+You can finally write an audit log:
+
+```ts
+logger.log({
+  namespace: 'payroll',
+  target: 'employee.bonus',
+  event: 'create',
+  payload: {
+    amount: 200,
+  },
+  account: {
+    internalId: 'an internal id',
+    individualId: 'an invidiaul id',
+    employeeId: 'an employee id',
+  },
+  scope: {
+    employeeId: 'another employee id',
+    companyId: 'a company id',
+  },
+})
+```
+
+## Contributing
+
+### Building the SDK
+
+In order to keep synced with the actual API, the API calls from the SDK are autogenerated by [openapi-generator](https://github.com/OpenAPITools/openapi-generator). It uses the [openapi.json](../pkg/broker/v1/swagger/openapi.json) file and builds an axios client that sends the correct requests accordingly to that file.
+
+To build it, simply run
+
+```sh
+npm run build
+```
+
+from the sdk folder (where the `package.json` is located).
+
+### Testing
+
+For now, no unit tests have been written, but it should arrive soon !
+
+### Playing around with he SDK
+
+Could it be for testing some changes you made, or just to discover how to use the SDK, there is a [playground](./playground) at your disposal.
+
+It uses the current code in the repository, not the published one, so you don't have to `npm publish` or `npm link` to make it work 🙂
+
+To run it, simply run from the `sdk` folder:
+
+```sh
+npm run start:playground
+```
+
+### Publishing
+
+For now, there is no automated publishing from CI, so you have to publish it manually.
+
+To do so, simply bump the `version` field in the `package.json` file, and run
+
+```
+npm publish
+```
+
+## Code organisation
+
+The code is mainly split into 2 parts:
+
+- The transport part, whose only goal is to tell how to communicate with the API, i.e it abstracts the communication layer.
+- The logic part, which tells how to build an audit log.

package/dist/index.d.ts

@@ -1,3 +1,15 @@
+/**
+ * The allowed Namespaces for the AuditLog
+ */
+export type AuditNamespaces = 'employee' | 'company' | 'permissions' | 'absence' | 'expense' | 'payments' | 'auth' | 'billing' | 'modules' | 'integrations' | 'partnerApi' | 'donation' | 'notificationSettings' | 'people' | 'subscriptions' | 'organization' | 'declarations' | 'pricing' | 'payroll' | 'jetlang' | 'files';
+/**
+ * The allowed targets for the AuditLog
+ */
+export type AuditTargets = 'reporting' | 'employee' | 'employee.settings' | 'employee-request' | 'company' | 'company.billings' | 'company.billing' | 'company.variables' | 'company.settings' | 'company.emails' | 'company.addons' | 'company.plans' | 'company.modules' | 'declaration.metadata' | 'user.role' | 'user.account' | 'user.primaryEmail' | 'user.secondaryEmail' | 'user.locale' | 'user.notificationSettings' | 'user.mfa' | '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.oneOne' | 'people.campaign' | 'people.assessment' | 'people.assessment.360details' | 'people.assessment.managerRequests' | 'people.assessment.manager' | 'people.assessment.answers' | 'people.assessment.feedbacks' | 'iban' | 'salary-payments.connect' | 'salary-payments.pay.url' | 'advance-salary-payments.pay.url' | 'variable' | 'jetlang-data' | 'access-logs' | 'event' | 'topic' | 'file' | 'file.presigned-url' | 'archive' | 'payslip.merge';
+/**
+ * The allowed Events for the AuditLog
+ */
+export type AuditEvents = 'create' | 'update' | 'share' | 'delete' | 'view' | 'sign' | 'signin' | 'signinFail' | 'signinAs' | 'logout' | 'updateCurrentAccount' | 'merge' | 'disable' | 'sendResetPasswordLink' | 'enable' | 'verify' | 'read' | 'write' | 'subscribe' | 'consume' | 'setup';
 /**
  * Data to audit log.
  */
@@ -6,17 +18,22 @@ 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;
+    payload?: Record<string, unknown>;
     /**
      * The buisness domain impacted.
      * e.g documents, authentication, ...
      */
-    namespace: string;
+    namespace: AuditNamespaces;
     /**
      * The name of the event.
-     * e.g. signIn, passwordUpdated, bonusAdded, ...
+     * e.g. signIn, passwordUpdated, ...
      */
-    event: string;
+    event: AuditEvents;
+    /**
+     * The target of event.
+     * e.g. user.settings, employee.bonuses, ...
+     */
+    target: AuditTargets | string;
     /**
      * The data that describes who did perform the logged action.
      */
@@ -29,7 +46,7 @@ export interface IAuditLogData {
 /**
  * Data used to indentify who performed an action
  */
-export declare type IAuditLogAuthData = {
+export type IAuditLogAuthData = {
     /**
      * The id of the payfiter that did the action if it has been made during a siginAs
      */
@@ -37,7 +54,7 @@ export declare type IAuditLogAuthData = {
     holdingId?: string;
     companyId?: string;
     employeeId?: string;
-    individualId: string;
+    individualId?: string;
     roleId?: string;
     /**
      *
@@ -58,11 +75,13 @@ export declare type IAuditLogAuthData = {
  * 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 = {
+export type IAuditLogScope = {
     holdingId: string;
 } | {
     companyId: string;
     employeeId?: string;
+} | {
+    individualId: string;
 } | null;
 export interface IAuditLogger {
     log: (data: IAuditLogData) => Promise<void>;
@@ -76,5 +95,5 @@ export declare class AuditLogger implements IAuditLogger {
     protected params: IAuditLoggerInitialization;
     private transport;
     constructor(params: IAuditLoggerInitialization);
-    log(data: IAuditLogData): Promise<void>;
+    log({ scope, account, ...data }: IAuditLogData): Promise<void>;
 }

package/dist/index.js

@@ -1,30 +1 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const uuid_1 = require("uuid");
-const implementation_1 = require("./transport/implementation");
-class AuditLogger {
-    constructor(params) {
-        this.params = params;
-        this.transport = new implementation_1.Transport(params.apiUrl);
-    }
-    log(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const uuid = uuid_1.v4();
-            const { environment, service } = this.params;
-            const timestamp = new Date().getTime();
-            const log = Object.assign({}, data, { service, id: uuid, environment,
-                timestamp });
-            yield this.transport.create(log);
-        });
-    }
-}
-exports.AuditLogger = AuditLogger;
-//# sourceMappingURL=index.js.map
+"use strict";var d=Object.defineProperty;var P=(s,e,t)=>e in s?d(s,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):s[e]=t;var n=(s,e,t)=>(P(s,typeof e!="symbol"?e+"":e,t),t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const m=require("uuid"),h=require("axios"),p="http://localhost:8090".replace(/\/+$/,"");class f{constructor(e,t=p,r=h){n(this,"basePath");n(this,"axios");n(this,"configuration");this.basePath=t,this.axios=r,e&&(this.configuration=e,this.basePath=e.basePath||this.basePath)}}class g extends Error{constructor(t,r){super(r);n(this,"field");n(this,"name","RequiredError");this.field=t}}const A="https://example.com",w=function(s,e,t){if(t==null)throw new g(e,`Required parameter ${e} was null or undefined when calling ${s}.`)},b=function(s,...e){const t=new URLSearchParams(s.search);for(const r of e)for(const o in r)if(Array.isArray(r[o])){t.delete(o);for(const a of r[o])t.append(o,a)}else t.set(o,r[o]);s.search=t.toString()},x=function(s,e,t){const r=typeof s!="string";return(r&&t&&t.isJsonMime?t.isJsonMime(e.headers["Content-Type"]):r)?JSON.stringify(s!==void 0?s:{}):s||""},y=function(s){return s.pathname+s.search+s.hash},L=function(s,e,t,r){return(o=e,a=t)=>{const i={...s.options,url:((r==null?void 0:r.basePath)||a)+s.url};return o.request(i)}},S=function(s){return{v1LogPost:async(e,t={})=>{w("v1LogPost","inlineObject",e);const r="/v1/log",o=new URL(r,A);let a;s&&(a=s.baseOptions);const i={method:"POST",...a,...t},c={},l={};c["Content-Type"]="application/json",b(o,l);let u=a&&a.headers?a.headers:{};return i.headers={...c,...u,...t.headers},i.data=x(e,i,s),{url:y(o),options:i}}}},E=function(s){const e=S(s);return{async v1LogPost(t,r){const o=await e.v1LogPost(t,r);return L(o,h,p,s)}}};class v extends f{v1LogPost(e,t){return E(this.configuration).v1LogPost(e,t).then(r=>r(this.axios,this.basePath))}}const R=s=>"isAxiosError"in s&&s.isAxiosError&&s instanceof Error;class j{constructor(e){n(this,"apiUrl");n(this,"api");this.apiUrl=e,this.api=new v({basePath:this.apiUrl,isJsonMime(t){const r=new RegExp("^(application/json|[^;/ 	]+/[^;/ 	]+[+]json)[ 	]*(;.*)?$","i");return t!==null&&(r.test(t)||t.toLowerCase()==="application/json-patch+json")}})}async create(e){var t;try{await this.api.v1LogPost(e,{timeout:5e3})}catch(r){if(!R(r))throw r;const o=((t=r.response)==null?void 0:t.data)||r.message;throw new Error(o)}}}class q{constructor(e){n(this,"params");n(this,"transport");this.params=e,this.transport=new j(e.apiUrl)}async log({scope:e,account:t,...r}){const o=m.v4(),{environment:a,service:i}=this.params,c=Math.floor(Date.now()/1e3),l={...r,...t,service:i,id:o,environment:a,timestamp:c,...e&&{scope:e}};await this.transport.create(l)}}exports.AuditLogger=q;

package/dist/index.mjs

@@ -0,0 +1,149 @@
+var u = Object.defineProperty;
+var P = (s, e, t) => e in s ? u(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
+var n = (s, e, t) => (P(s, typeof e != "symbol" ? e + "" : e, t), t);
+import { v4 as m } from "uuid";
+import l from "axios";
+const p = "http://localhost:8090".replace(/\/+$/, "");
+class f {
+  constructor(e, t = p, o = l) {
+    n(this, "basePath");
+    n(this, "axios");
+    n(this, "configuration");
+    this.basePath = t, this.axios = o, e && (this.configuration = e, this.basePath = e.basePath || this.basePath);
+  }
+}
+class A extends Error {
+  constructor(t, o) {
+    super(o);
+    n(this, "field");
+    n(this, "name", "RequiredError");
+    this.field = t;
+  }
+}
+const w = "https://example.com", x = function(s, e, t) {
+  if (t == null)
+    throw new A(e, `Required parameter ${e} was null or undefined when calling ${s}.`);
+}, g = function(s, ...e) {
+  const t = new URLSearchParams(s.search);
+  for (const o of e)
+    for (const r in o)
+      if (Array.isArray(o[r])) {
+        t.delete(r);
+        for (const a of o[r])
+          t.append(r, a);
+      } else
+        t.set(r, o[r]);
+  s.search = t.toString();
+}, b = function(s, e, t) {
+  const o = typeof s != "string";
+  return (o && t && t.isJsonMime ? t.isJsonMime(e.headers["Content-Type"]) : o) ? JSON.stringify(s !== void 0 ? s : {}) : s || "";
+}, y = function(s) {
+  return s.pathname + s.search + s.hash;
+}, E = function(s, e, t, o) {
+  return (r = e, a = t) => {
+    const i = { ...s.options, url: ((o == null ? void 0 : o.basePath) || a) + s.url };
+    return r.request(i);
+  };
+}, L = function(s) {
+  return {
+    /**
+     *
+     * @summary Creates Audit Log event
+     * @param {InlineObject} inlineObject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1LogPost: async (e, t = {}) => {
+      x("v1LogPost", "inlineObject", e);
+      const o = "/v1/log", r = new URL(o, w);
+      let a;
+      s && (a = s.baseOptions);
+      const i = { method: "POST", ...a, ...t }, c = {}, h = {};
+      c["Content-Type"] = "application/json", g(r, h);
+      let d = a && a.headers ? a.headers : {};
+      return i.headers = { ...c, ...d, ...t.headers }, i.data = b(e, i, s), {
+        url: y(r),
+        options: i
+      };
+    }
+  };
+}, S = function(s) {
+  const e = L(s);
+  return {
+    /**
+     *
+     * @summary Creates Audit Log event
+     * @param {InlineObject} inlineObject
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async v1LogPost(t, o) {
+      const r = await e.v1LogPost(t, o);
+      return E(r, l, p, s);
+    }
+  };
+};
+class v extends f {
+  /**
+   *
+   * @summary Creates Audit Log event
+   * @param {InlineObject} inlineObject
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof DefaultApi
+   */
+  v1LogPost(e, t) {
+    return S(this.configuration).v1LogPost(e, t).then((o) => o(this.axios, this.basePath));
+  }
+}
+const R = (s) => "isAxiosError" in s && s.isAxiosError && s instanceof Error;
+class U {
+  constructor(e) {
+    n(this, "apiUrl");
+    n(this, "api");
+    this.apiUrl = e, this.api = new v({
+      basePath: this.apiUrl,
+      isJsonMime(t) {
+        const o = new RegExp(
+          // eslint-disable-next-line no-control-regex
+          "^(application/json|[^;/ 	]+/[^;/ 	]+[+]json)[ 	]*(;.*)?$",
+          "i"
+        );
+        return t !== null && (o.test(t) || t.toLowerCase() === "application/json-patch+json");
+      }
+    });
+  }
+  async create(e) {
+    var t;
+    try {
+      await this.api.v1LogPost(e, { timeout: 5e3 });
+    } catch (o) {
+      if (!R(o))
+        throw o;
+      const r = ((t = o.response) == null ? void 0 : t.data) || o.message;
+      throw new Error(r);
+    }
+  }
+}
+class O {
+  constructor(e) {
+    n(this, "params");
+    n(this, "transport");
+    this.params = e, this.transport = new U(e.apiUrl);
+  }
+  async log({ scope: e, account: t, ...o }) {
+    const r = m(), { environment: a, service: i } = this.params, c = Math.floor(Date.now() / 1e3), h = {
+      ...o,
+      ...t,
+      service: i,
+      id: r,
+      environment: a,
+      timestamp: c,
+      ...e && { scope: e }
+    };
+    await this.transport.create(h);
+  }
+}
+export {
+  O as AuditLogger
+};

package/dist/playground.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/transport/generated/api/default-api.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { AxiosPromise, AxiosInstance } from 'axios';
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
 import { InlineObject } from '../model';
@@ -17,7 +17,7 @@ import { InlineObject } from '../model';
  * DefaultApi - axios parameter creator
  * @export
  */
-export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
      * @summary Creates Audit Log event
@@ -25,13 +25,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    v1LogPost(inlineObject: InlineObject, options?: any): RequestArgs;
+    v1LogPost: (inlineObject: InlineObject, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * DefaultApi - functional programming interface
  * @export
  */
-export declare const DefaultApiFp: (configuration?: Configuration | undefined) => {
+export declare const DefaultApiFp: (configuration?: Configuration) => {
     /**
      *
      * @summary Creates Audit Log event
@@ -39,13 +39,13 @@ export declare const DefaultApiFp: (configuration?: Configuration | undefined) =
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    v1LogPost(inlineObject: InlineObject, options?: any): (axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>;
+    v1LogPost(inlineObject: InlineObject, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * DefaultApi - factory interface
  * @export
  */
-export declare const DefaultApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
      * @summary Creates Audit Log event
@@ -70,5 +70,5 @@ export declare class DefaultApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    v1LogPost(inlineObject: InlineObject, options?: any): AxiosPromise<void>;
+    v1LogPost(inlineObject: InlineObject, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
 }

package/dist/transport/generated/base.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import { Configuration } from "./configuration";
-import { AxiosInstance } from 'axios';
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
 /**
  *
@@ -29,7 +29,7 @@ export declare const COLLECTION_FORMATS: {
  */
 export interface RequestArgs {
     url: string;
-    options: any;
+    options: AxiosRequestConfig;
 }
 /**
  *

package/dist/transport/generated/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { Configuration } from "./configuration";
+import { RequestArgs } from "./base";
+import { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/transport/generated/configuration.d.ts

@@ -10,12 +10,13 @@
  * Do not edit the class manually.
  */
 export interface ConfigurationParameters {
-    apiKey?: string | ((name: string) => string);
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
-    accessToken?: string | ((name?: string, scopes?: string[]) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     basePath?: string;
     baseOptions?: any;
+    formDataCtor?: new () => any;
 }
 export declare class Configuration {
     /**
@@ -23,7 +24,7 @@ export declare class Configuration {
      * @param name security name
      * @memberof Configuration
      */
-    apiKey?: string | ((name: string) => string);
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
      *
@@ -44,7 +45,7 @@ export declare class Configuration {
      * @param scopes oauth2 scope
      * @memberof Configuration
      */
-    accessToken?: string | ((name?: string, scopes?: string[]) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
      *
@@ -59,5 +60,24 @@ export declare class Configuration {
      * @memberof Configuration
      */
     baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
     constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
 }

package/dist/transport/generated/index.d.ts

@@ -11,3 +11,4 @@
  */
 export * from "./api";
 export * from "./configuration";
+export * from "./model";