@payfit/audit-log 1.0.0-rc.98 → 1.0.0

package/src/transport/generated/base.ts

@@ -0,0 +1,70 @@
+// 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 { Configuration } from "./configuration";
+// Some imports not used depending on template conditions
+// @ts-ignore
+import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
+
+export const BASE_PATH = "http://localhost:8081/v1".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: any;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath || this.basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    name: "RequiredError" = "RequiredError";
+    constructor(public field: string, msg?: string) {
+        super(msg);
+    }
+}

package/src/transport/generated/configuration.ts

@@ -0,0 +1,75 @@
+// 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 interface ConfigurationParameters {
+    apiKey?: string | ((name: string) => string);
+    username?: string;
+    password?: string;
+    accessToken?: string | ((name?: string, scopes?: string[]) => string);
+    basePath?: string;
+    baseOptions?: any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | ((name: string) => string);
+    /**
+     * parameter for basic security
+     * 
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     * 
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | ((name?: string, scopes?: string[]) => string);
+    /**
+     * override base path
+     * 
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.baseOptions = param.baseOptions;
+    }
+}

package/src/transport/generated/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

package/src/transport/generated/index.ts

@@ -0,0 +1,16 @@
+// 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";
+export * from "./configuration";

package/src/transport/generated/model/index.ts

@@ -0,0 +1 @@
+export * from './inline-object';

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

@@ -0,0 +1,126 @@
+// 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
+ * @interface InlineObject
+ */
+export interface InlineObject {
+    /**
+     * Audit log event unique identifier
+     * @type {string}
+     * @memberof InlineObject
+     */
+    id: string;
+    /**
+     * Audit log event country code
+     * @type {string}
+     * @memberof InlineObject
+     */
+    countryCode?: string;
+    /**
+     * Audit log event payload
+     * @type {object}
+     * @memberof InlineObject
+     */
+    payload?: object;
+    /**
+     * id of the payfiter who performed the audit log action, if signed as.
+     * @type {string}
+     * @memberof InlineObject
+     */
+    internalId?: string;
+    /**
+     * Tells whether the logged action has been made by the system
+     * @type {boolean}
+     * @memberof InlineObject
+     */
+    isSystem?: boolean;
+    /**
+     * Audit log event namespace (business related)
+     * @type {string}
+     * @memberof InlineObject
+     */
+    namespace: string;
+    /**
+     * Audit log event namespace (technical related)
+     * @type {string}
+     * @memberof InlineObject
+     */
+    service: string;
+    /**
+     * Audit log event type
+     * @type {string}
+     * @memberof InlineObject
+     */
+    event?: string;
+    /**
+     * Audit log event environment
+     * @type {string}
+     * @memberof InlineObject
+     */
+    environment?: string;
+    /**
+     * holdingId of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    holdingId?: string;
+    /**
+     * companyId of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    companyId?: string;
+    /**
+     * employeeId of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    employeeId?: string;
+    /**
+     * individualId of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    individualId?: string;
+    /**
+     * roleId of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    roleId?: string;
+    /**
+     * userIp of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    userIp?: string;
+    /**
+     * specialRole of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    specialRole?: string;
+    /**
+     * email of the account performing the event
+     * @type {string}
+     * @memberof InlineObject
+     */
+    email?: string;
+}
+
+

package/src/transport/implementation.ts

@@ -0,0 +1,23 @@
+import { DefaultApi } from './generated'
+import { IAuditLogTransport, IAuditLogCreationData } from './interface'
+
+export class Transport implements IAuditLogTransport {
+  api: DefaultApi
+
+  constructor(protected apiUrl: string) {
+    this.api = new DefaultApi({
+      basePath: this.apiUrl,
+    })
+  }
+
+  async create(auditLogData: IAuditLogCreationData) {
+    const { account, ...logDataWithoutAccount } = auditLogData
+
+    const dataToSend = {
+      ...logDataWithoutAccount,
+      ...account,
+    }
+
+    await this.api.v1LogPost(dataToSend)
+  }
+}

package/src/transport/interface.ts

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

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "es6",
+    "module": "commonjs",
+    "lib": ["es7", "esnext.asynciterable", "es2017"],
+    "sourceMap": true,
+    "outDir": "./dist",
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "moduleResolution": "node",
+    "baseUrl": "src",
+    "paths": {
+      "*": ["*"]
+    },
+    "esModuleInterop": true
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["node_modules", "./src/__tests__/**/*"]
+}

package/tslint.json

@@ -0,0 +1,12 @@
+{
+  "defaultSeverity": "error",
+  "extends": ["tslint:recommended", "tslint-config-prettier"],
+  "jsRules": {
+    "object-literal-sort-keys": false
+  },
+  "rules": {
+    "one-variable-per-declaration": false,
+    "interface-name": false
+  },
+  "rulesDirectory": []
+}

package/dist/index.mjs

@@ -1,149 +0,0 @@
-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

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

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

@@ -1,65 +0,0 @@
-/**
- * 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>;