@payfit/audit-log 3.16.2 → 3.16.4

package/README.md

@@ -1,6 +1,6 @@
 # Audit logs SDK
 
-The SDK is an npm package that makes it easier to call the Audit Log API.
+The SDK is an npm package that sends audit-log records to the durable SQS ingest queue.
 
 ## Using the SDK in your project
 
@@ -47,7 +47,7 @@ logger.log({
 
 ### 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.
+The SDK's transport is maintained TypeScript code. It publishes records to SQS and retains the public `AuditLogger` contract while the consumer persists records directly to Aurora.
 
 To build it, simply run
 
@@ -87,5 +87,5 @@ npm publish
 
 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 transport part, whose only goal is to tell how to communicate with SQS, i.e. it abstracts the delivery layer.
 - The logic part, which tells how to build an audit log.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payfit/audit-log",
-  "version": "3.16.2",
+  "version": "3.16.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/PayFit/audit-logs.git",
@@ -11,7 +11,6 @@
   "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 .",
@@ -26,14 +25,12 @@
   "license": "ISC",
   "dependencies": {
     "@aws-sdk/client-sqs": "^3.600.0",
-    "axios": "^1.0.0",
     "hot-shots": "^11.0.0",
     "lodash": "^4.17.20",
     "uuid": "^9.0.0",
     "winston": "^3.13.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.13.0",

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

@@ -1,74 +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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
-import { RequestArgs, BaseAPI } from '../base';
-import { InlineObject } from '../model';
-/**
- * DefaultApi - axios parameter creator
- * @export
- */
-export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Creates Audit Log event
-     * @param {InlineObject} inlineObject
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    v1LogPost: (inlineObject: InlineObject, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * DefaultApi - functional programming interface
- * @export
- */
-export declare const DefaultApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Creates Audit Log event
-     * @param {InlineObject} inlineObject
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    v1LogPost(inlineObject: InlineObject, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-};
-/**
- * DefaultApi - factory interface
- * @export
- */
-export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Creates Audit Log event
-     * @param {InlineObject} inlineObject
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    v1LogPost(inlineObject: InlineObject, options?: any): AxiosPromise<void>;
-};
-/**
- * DefaultApi - object-oriented interface
- * @export
- * @class DefaultApi
- * @extends {BaseAPI}
- */
-export declare class DefaultApi extends BaseAPI {
-    /**
-     *
-     * @summary Creates Audit Log event
-     * @param {InlineObject} inlineObject
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DefaultApi
-     */
-    v1LogPost(inlineObject: InlineObject, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
-}

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

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

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

@@ -1,55 +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 { AxiosInstance, AxiosRequestConfig } from 'axios';
-export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: AxiosRequestConfig;
-}
-/**
- *
- * @export
- * @class BaseAPI
- */
-export declare class BaseAPI {
-    protected basePath: string;
-    protected axios: AxiosInstance;
-    protected configuration: Configuration | undefined;
-    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
-}
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export declare class RequiredError extends Error {
-    field: string;
-    name: "RequiredError";
-    constructor(field: string, msg?: string);
-}

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>;

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

@@ -1,83 +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 ConfigurationParameters {
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    username?: string;
-    password?: 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 {
-    /**
-     * 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 | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @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

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

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

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

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

@@ -1,144 +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;
-    /**
-     * Datadog payload
-     * @type {object}
-     * @memberof InlineObject
-     */
-    'datadogPayload'?: 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;
-}