@payfit/audit-log 2.0.0 → 2.1.0

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

@@ -1,138 +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.
- */
-/**
- *
- * @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/dist/transport/generated/model/inline-object.js

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

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

package/dist/transport/implementation.js

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

@@ -1 +0,0 @@
-{"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,25 +0,0 @@
-export declare 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/dist/transport/interface.js

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

package/dist/transport/interface.js.map

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

package/openapi-codegen-config.yml

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

package/openapitools.json

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

package/playground/index.ts

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

@@ -1,205 +0,0 @@
-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 enum AuditEvents {
-  create = 'create',
-  update = 'update',
-  delete = 'delete',
-  view = 'view',
-  merge = '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

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

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

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

@@ -1,132 +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 * 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';
-// @ts-ignore
-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: async (inlineObject: InlineObject, options: any = {}): Promise<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;
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...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}
-         */
-        async v1LogPost(inlineObject: InlineObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await 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).then((request) => request(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).then((request) => request(this.axios, this.basePath));
-    }
-
-}

package/src/transport/generated/api.ts

@@ -1,17 +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/default-api';
-