@payfit/audit-log 3.6.1 → 3.7.0

package/README.md

@@ -16,8 +16,7 @@ Then, you must instanciate a client :
 import { AuditLogger } from '@payfit/audit-log'
 
 const logger = new AuditLogger({
-  apiUrl: 'http://localhost:8090',
-  environment: 'an-environment-name',
+  environment: 'dev', // must be one of: dev, staging, prod
   service: 'the-name-of-the-service',
 })
 ```

package/dist/index.d.ts

@@ -92,7 +92,8 @@ export interface IAuditLogger {
     log: (data: IAuditLogData) => Promise<void>;
 }
 export interface IAuditLoggerInitialization {
-    apiUrl: string;
+    /** @deprecated No longer used. The library routes via SQS based on `environment`. Kept for backward compatibility. */
+    apiUrl?: string;
     environment: string;
     service: string;
 }

package/dist/index.js

@@ -1 +1 @@
-"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;
+"use strict";var d=Object.defineProperty;var m=(r,e,t)=>e in r?d(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t;var n=(r,e,t)=>(m(r,typeof e!="symbol"?e+"":e,t),t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const w=require("uuid"),i=require("@aws-sdk/client-sqs"),h="eu-west-3",p={dev:"https://sqs.eu-west-3.amazonaws.com/533547282673/audit-logs-ingest",staging:"https://sqs.eu-west-3.amazonaws.com/589883667243/audit-logs-ingest",prod:"https://sqs.eu-west-3.amazonaws.com/614948436281/audit-logs-ingest"};class S{constructor(e){n(this,"environment");n(this,"client");n(this,"queueUrl");this.environment=e;const t=p[e];if(!t)throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${e}"`);this.queueUrl=t,this.client=new i.SQSClient({region:h})}async create(e){await this.client.send(new i.SendMessageCommand({QueueUrl:this.queueUrl,MessageBody:JSON.stringify(e)}))}}class v{constructor(e){n(this,"params");n(this,"transport");this.params=e,this.transport=new S(e.environment)}async log({scope:e,account:t,...o}){const u=w.v4(),{environment:c,service:g}=this.params,s={...o,...t,service:g,id:u,environment:c,...e&&{scope:e}};try{await this.transport.create(s)}catch(l){const a=l.message;try{console.error(JSON.stringify({status:"error",namespace:"audit-logs",message:"audit-log write failed",audit_log:s,error:a}))}catch{console.error(JSON.stringify({status:"error",namespace:"audit-logs",message:"audit-log write failed (serialization failed)",audit_log_meta:{id:s.id,service:s.service,environment:s.environment,namespace:s.namespace,event:s.event,target:s.target},error:a}))}}}}exports.AuditLogger=v;

package/dist/index.mjs

@@ -1,149 +1,77 @@
-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);
-    }
-  };
+var l = Object.defineProperty;
+var m = (r, e, t) => e in r ? l(r, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[e] = t;
+var a = (r, e, t) => (m(r, typeof e != "symbol" ? e + "" : e, t), t);
+import { v4 as d } from "uuid";
+import { SQSClient as p, SendMessageCommand as w } from "@aws-sdk/client-sqs";
+const h = "eu-west-3", v = {
+  dev: "https://sqs.eu-west-3.amazonaws.com/533547282673/audit-logs-ingest",
+  staging: "https://sqs.eu-west-3.amazonaws.com/589883667243/audit-logs-ingest",
+  prod: "https://sqs.eu-west-3.amazonaws.com/614948436281/audit-logs-ingest"
 };
-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 {
+class f {
   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");
-      }
-    });
+    a(this, "environment");
+    a(this, "client");
+    a(this, "queueUrl");
+    this.environment = e;
+    const t = v[e];
+    if (!t)
+      throw new Error(`audit-logs SDK: no SQS queue URL configured for environment "${e}"`);
+    this.queueUrl = t, this.client = new p({ region: h });
   }
   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);
-    }
+    await this.client.send(new w({
+      QueueUrl: this.queueUrl,
+      MessageBody: JSON.stringify(e)
+    }));
   }
 }
-class O {
+class y {
   constructor(e) {
-    n(this, "params");
-    n(this, "transport");
-    this.params = e, this.transport = new U(e.apiUrl);
+    a(this, "params");
+    a(this, "transport");
+    this.params = e, this.transport = new f(e.environment);
   }
-  async log({ scope: e, account: t, ...o }) {
-    const r = m(), { environment: a, service: i } = this.params, c = Math.floor(Date.now() / 1e3), h = {
-      ...o,
+  async log({ scope: e, account: t, ...n }) {
+    const i = d(), { environment: c, service: u } = this.params, s = {
+      ...n,
       ...t,
-      service: i,
-      id: r,
-      environment: a,
-      timestamp: c,
+      service: u,
+      id: i,
+      environment: c,
       ...e && { scope: e }
     };
-    await this.transport.create(h);
+    try {
+      await this.transport.create(s);
+    } catch (g) {
+      const o = g.message;
+      try {
+        console.error(JSON.stringify({
+          status: "error",
+          namespace: "audit-logs",
+          message: "audit-log write failed",
+          audit_log: s,
+          error: o
+        }));
+      } catch {
+        console.error(JSON.stringify({
+          status: "error",
+          namespace: "audit-logs",
+          message: "audit-log write failed (serialization failed)",
+          audit_log_meta: {
+            id: s.id,
+            service: s.service,
+            environment: s.environment,
+            namespace: s.namespace,
+            event: s.event,
+            target: s.target
+          },
+          error: o
+        }));
+      }
+    }
   }
 }
 export {
-  O as AuditLogger
+  y as AuditLogger
 };

package/dist/index.test.d.ts

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

package/dist/transport/implementation.d.ts

@@ -1,8 +1,8 @@
-import { InlineObject } from './generated/model';
-import { IAuditLogTransport } from './interface';
+import { IAuditLogCreationData, IAuditLogTransport } from './interface';
 export declare class Transport implements IAuditLogTransport {
-    protected apiUrl: string;
-    private api;
-    constructor(apiUrl: string);
-    create(auditLogData: InlineObject): Promise<void>;
+    protected environment: string;
+    private client;
+    private queueUrl;
+    constructor(environment: string);
+    create(auditLogData: IAuditLogCreationData): Promise<void>;
 }

package/dist/transport/interface.d.ts

@@ -1,6 +1,5 @@
 export interface IAuditLogCreationData {
     id: string;
-    timestamp: number;
     environment: string;
     service: string;
     scope?: Record<string, unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payfit/audit-log",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/PayFit/audit-logs.git",
@@ -15,6 +15,8 @@
     "build": "rimraf dist && vite build",
     "prepack": "npm run build",
     "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "start:playground": "ts-node src/playground.ts",
     "format:check": "prettier --check .",
     "format:fix": "prettier --write .",
@@ -23,6 +25,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@aws-sdk/client-sqs": "^3.600.0",
     "axios": "^1.0.0",
     "lodash": "^4.17.20",
     "uuid": "^9.0.0"
@@ -46,13 +49,14 @@
     "semantic-release": "22.0.12",
     "ts-node": "10.9.2",
     "typescript": "5.3.3",
-    "vite": "4.5.1"
+    "vite": "4.5.1",
+    "vitest": "4.1.4"
   },
-  "peerDependencies": {},
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "files": [
     "dist"
-  ]
+  ],
+  "packageManager": "yarn@4.14.1+sha512.64df448055b2d37ba269d7db535a469b8da93f8ef1140c25fd7a83c00a8fbaacb214ca0e02553b92a2c54cef78bb67d0b4817fab02001df0e24fac0faccc3b42"
 }