@payfit/audit-log 2.0.0 → 2.1.0

package/src/transport/generated/base.ts

@@ -1,70 +0,0 @@
-// 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:8090".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

@@ -1,75 +0,0 @@
-// 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 | Promise<string> | ((name: string) => string) | ((name: string) => Promise<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 | Promise<string> | ((name: string) => string) | ((name: string) => Promise<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

@@ -1,58 +0,0 @@
-#!/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

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

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

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

@@ -1,144 +0,0 @@
-// 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 target
-     * @type {string}
-     * @memberof InlineObject
-     */
-    target: string;
-    /**
-     * Audit log event environment, only required when in todd context
-     * @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;
-    /**
-     * Audit log event scope
-     * @type {object}
-     * @memberof InlineObject
-     */
-    scope?: object;
-    /**
-     * Audit log event timestamp unix format
-     * @type {number}
-     * @memberof InlineObject
-     */
-    timestamp: number;
-}
-
-

package/src/transport/implementation.ts

@@ -1,27 +0,0 @@
-import { DefaultApi } from './generated'
-import { InlineObject } from './generated/model'
-
-import { IAuditLogTransport } from './interface'
-
-export class Transport implements IAuditLogTransport {
-  api: DefaultApi
-
-  constructor(protected apiUrl: string) {
-    this.api = new DefaultApi({
-      basePath: this.apiUrl,
-    })
-  }
-
-  async create(auditLogData: InlineObject) {
-    try {
-      await this.api.v1LogPost(auditLogData)
-    } catch (err) {
-      if (!err.isAxiosError) {
-        throw err
-      }
-
-      const message = err.response?.data || err.message
-      throw new Error(message)
-    }
-  }
-}

package/src/transport/interface.ts

@@ -1,28 +0,0 @@
-import { IAuditLogData } from '..'
-
-export type IAuditLogCreationData = {
-  id: string
-  timestamp: number
-  environment: string
-  service: string
-  scope?: object
-  countryCode?: string
-  payload?: object
-  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/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "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

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