@webiny/api-audit-logs 0.0.0-unstable.06b2ede40f

package/utils/getAuditConfig.js

@@ -0,0 +1,149 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAuditConfig = void 0;
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _utils = require("@webiny/utils");
+const createAuditLog = async params => {
+  const {
+    app,
+    payload
+  } = params;
+  const compressor = app.context.compressor;
+  const payloadData = JSON.stringify(payload.data);
+  try {
+    const entry = {
+      id: (0, _utils.mdbid)(),
+      title: payload.message,
+      content: payload.message,
+      tags: [],
+      type: "AuditLogs",
+      location: {
+        folderId: "root"
+      },
+      data: {
+        ...payload,
+        data: payloadData
+      }
+    };
+    const data = await compressor.compress(entry.data.data);
+    await app.search.create({
+      ...entry,
+      data: {
+        ...entry.data,
+        data: JSON.stringify(data)
+      }
+    });
+    return entry;
+  } catch (error) {
+    throw _error.default.from(error, {
+      message: "Error while creating new audit log",
+      code: "CREATE_AUDIT_LOG"
+    });
+  }
+};
+const createOrMergeAuditLog = async params => {
+  const {
+    app,
+    payload,
+    delay
+  } = params;
+  const compressor = app.context.compressor;
+  // Get the latest audit log of this entry.
+  const [records] = await app.search.list({
+    where: {
+      type: "AuditLogs",
+      data: {
+        entityId: payload.entityId,
+        initiator: payload.initiator
+      }
+    },
+    limit: 1
+  });
+  const existingLog = records?.[0];
+  if (existingLog) {
+    const existingLogDate = Date.parse(existingLog.savedOn);
+    const newLogDate = payload.timestamp.getTime();
+
+    // Check if the latest audit log is saved within delay range.
+    if (newLogDate - existingLogDate < delay * 1000) {
+      const existingLogData = await compressor.decompress(existingLog.data);
+      // Update latest audit log with new "after" payload.
+      const beforePayloadData = JSON.parse(existingLogData?.data.data)?.before;
+      const afterPayloadData = payload.data?.after;
+      const updatedPayloadData = beforePayloadData ? JSON.stringify({
+        before: beforePayloadData,
+        after: afterPayloadData
+      }) : JSON.stringify(payload.data);
+      const data = await compressor.compress(updatedPayloadData);
+      try {
+        await app.search.update(existingLog.id, {
+          data: {
+            ...payload,
+            data
+          }
+        });
+        return {
+          ...existingLog,
+          data: updatedPayloadData
+        };
+      } catch (error) {
+        throw _error.default.from(error, {
+          message: "Error while updating audit log",
+          code: "UPDATE_AUDIT_LOG"
+        });
+      }
+    }
+  }
+  return createAuditLog(params);
+};
+const getAuditConfig = audit => {
+  return async (message, data, entityId, context) => {
+    const {
+      aco,
+      security
+    } = context;
+    if (!aco) {
+      console.log("No ACO defined.");
+      return;
+    }
+    const identity = security.getIdentity();
+    const auditLogPayload = {
+      message,
+      app: audit.app.app,
+      entity: audit.entity.type,
+      entityId,
+      action: audit.action.type,
+      data,
+      timestamp: new Date(),
+      initiator: identity?.id
+    };
+    const app = aco.getApp("AuditLogs");
+    const delay = audit.action.newEntryDelay;
+
+    // Check if there is delay on audit log creation for this action.
+    if (delay) {
+      try {
+        return await createOrMergeAuditLog({
+          app,
+          payload: auditLogPayload,
+          delay
+        });
+      } catch {
+        // Don't care at this point!
+      } finally {
+        return JSON.stringify({});
+      }
+    }
+    return await createAuditLog({
+      app,
+      payload: auditLogPayload
+    });
+  };
+};
+exports.getAuditConfig = getAuditConfig;
+
+//# sourceMappingURL=getAuditConfig.js.map

package/utils/getAuditConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_error","_interopRequireDefault","require","_utils","createAuditLog","params","app","payload","compressor","context","payloadData","JSON","stringify","data","entry","id","mdbid","title","message","content","tags","type","location","folderId","compress","search","create","error","WebinyError","from","code","createOrMergeAuditLog","delay","records","list","where","entityId","initiator","limit","existingLog","existingLogDate","Date","parse","savedOn","newLogDate","timestamp","getTime","existingLogData","decompress","beforePayloadData","before","afterPayloadData","after","updatedPayloadData","update","getAuditConfig","audit","aco","security","console","log","identity","getIdentity","auditLogPayload","entity","action","getApp","newEntryDelay","exports"],"sources":["getAuditConfig.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { mdbid } from \"@webiny/utils\";\nimport type { IAcoApp } from \"@webiny/api-aco/types\";\nimport type { AuditAction, AuditLog, AuditLogsContext } from \"~/types\";\nimport type { GenericRecord } from \"@webiny/api/types\";\n\ninterface AuditLogPayload extends Omit<AuditLog, \"id\" | \"data\"> {\n    data: Record<string, any>;\n}\n\ninterface CreateAuditLogParams {\n    app: IAcoApp;\n    payload: AuditLogPayload;\n}\n\nconst createAuditLog = async (params: CreateAuditLogParams) => {\n    const { app, payload } = params;\n\n    const compressor = app.context.compressor;\n\n    const payloadData = JSON.stringify(payload.data);\n\n    try {\n        const entry = {\n            id: mdbid(),\n            title: payload.message,\n            content: payload.message,\n            tags: [],\n            type: \"AuditLogs\",\n            location: { folderId: \"root\" },\n            data: {\n                ...payload,\n                data: payloadData\n            }\n        };\n        const data = await compressor.compress(entry.data.data);\n        await app.search.create({\n            ...entry,\n            data: {\n                ...entry.data,\n                data: JSON.stringify(data)\n            }\n        });\n        return entry;\n    } catch (error) {\n        throw WebinyError.from(error, {\n            message: \"Error while creating new audit log\",\n            code: \"CREATE_AUDIT_LOG\"\n        });\n    }\n};\n\ninterface CreateOrMergeAuditLogParams {\n    app: IAcoApp;\n    payload: AuditLogPayload;\n    delay: number;\n}\n\nconst createOrMergeAuditLog = async (params: CreateOrMergeAuditLogParams) => {\n    const { app, payload, delay } = params;\n\n    const compressor = app.context.compressor;\n    // Get the latest audit log of this entry.\n    const [records] = await app.search.list({\n        where: {\n            type: \"AuditLogs\",\n            data: {\n                entityId: payload.entityId,\n                initiator: payload.initiator\n            }\n        },\n        limit: 1\n    });\n    const existingLog = records?.[0];\n\n    if (existingLog) {\n        const existingLogDate = Date.parse(existingLog.savedOn);\n        const newLogDate = payload.timestamp.getTime();\n\n        // Check if the latest audit log is saved within delay range.\n        if (newLogDate - existingLogDate < delay * 1000) {\n            const existingLogData = (await compressor.decompress(\n                existingLog.data\n            )) as unknown as GenericRecord;\n            // Update latest audit log with new \"after\" payload.\n            const beforePayloadData = JSON.parse(existingLogData?.data.data)?.before;\n            const afterPayloadData = payload.data?.after;\n            const updatedPayloadData = beforePayloadData\n                ? JSON.stringify({ before: beforePayloadData, after: afterPayloadData })\n                : JSON.stringify(payload.data);\n\n            const data = await compressor.compress(updatedPayloadData);\n            try {\n                await app.search.update(existingLog.id, {\n                    data: {\n                        ...payload,\n                        data\n                    }\n                });\n\n                return {\n                    ...existingLog,\n                    data: updatedPayloadData\n                };\n            } catch (error) {\n                throw WebinyError.from(error, {\n                    message: \"Error while updating audit log\",\n                    code: \"UPDATE_AUDIT_LOG\"\n                });\n            }\n        }\n    }\n\n    return createAuditLog(params);\n};\n\nexport const getAuditConfig = (audit: AuditAction) => {\n    return async (\n        message: string,\n        data: Record<string, any>,\n        entityId: string,\n        context: AuditLogsContext\n    ) => {\n        const { aco, security } = context;\n\n        if (!aco) {\n            console.log(\"No ACO defined.\");\n            return;\n        }\n\n        const identity = security.getIdentity();\n\n        const auditLogPayload = {\n            message,\n            app: audit.app.app,\n            entity: audit.entity.type,\n            entityId,\n            action: audit.action.type,\n            data,\n            timestamp: new Date(),\n            initiator: identity?.id\n        };\n\n        const app = aco.getApp(\"AuditLogs\");\n        const delay = audit.action.newEntryDelay;\n\n        // Check if there is delay on audit log creation for this action.\n        if (delay) {\n            try {\n                return await createOrMergeAuditLog({\n                    app,\n                    payload: auditLogPayload,\n                    delay\n                });\n            } catch {\n                // Don't care at this point!\n            } finally {\n                return JSON.stringify({});\n            }\n        }\n        return await createAuditLog({\n            app,\n            payload: auditLogPayload\n        });\n    };\n};\n"],"mappings":";;;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AAcA,MAAME,cAAc,GAAG,MAAOC,MAA4B,IAAK;EAC3D,MAAM;IAAEC,GAAG;IAAEC;EAAQ,CAAC,GAAGF,MAAM;EAE/B,MAAMG,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACD,UAAU;EAEzC,MAAME,WAAW,GAAGC,IAAI,CAACC,SAAS,CAACL,OAAO,CAACM,IAAI,CAAC;EAEhD,IAAI;IACA,MAAMC,KAAK,GAAG;MACVC,EAAE,EAAE,IAAAC,YAAK,EAAC,CAAC;MACXC,KAAK,EAAEV,OAAO,CAACW,OAAO;MACtBC,OAAO,EAAEZ,OAAO,CAACW,OAAO;MACxBE,IAAI,EAAE,EAAE;MACRC,IAAI,EAAE,WAAW;MACjBC,QAAQ,EAAE;QAAEC,QAAQ,EAAE;MAAO,CAAC;MAC9BV,IAAI,EAAE;QACF,GAAGN,OAAO;QACVM,IAAI,EAAEH;MACV;IACJ,CAAC;IACD,MAAMG,IAAI,GAAG,MAAML,UAAU,CAACgB,QAAQ,CAACV,KAAK,CAACD,IAAI,CAACA,IAAI,CAAC;IACvD,MAAMP,GAAG,CAACmB,MAAM,CAACC,MAAM,CAAC;MACpB,GAAGZ,KAAK;MACRD,IAAI,EAAE;QACF,GAAGC,KAAK,CAACD,IAAI;QACbA,IAAI,EAAEF,IAAI,CAACC,SAAS,CAACC,IAAI;MAC7B;IACJ,CAAC,CAAC;IACF,OAAOC,KAAK;EAChB,CAAC,CAAC,OAAOa,KAAK,EAAE;IACZ,MAAMC,cAAW,CAACC,IAAI,CAACF,KAAK,EAAE;MAC1BT,OAAO,EAAE,oCAAoC;MAC7CY,IAAI,EAAE;IACV,CAAC,CAAC;EACN;AACJ,CAAC;AAQD,MAAMC,qBAAqB,GAAG,MAAO1B,MAAmC,IAAK;EACzE,MAAM;IAAEC,GAAG;IAAEC,OAAO;IAAEyB;EAAM,CAAC,GAAG3B,MAAM;EAEtC,MAAMG,UAAU,GAAGF,GAAG,CAACG,OAAO,CAACD,UAAU;EACzC;EACA,MAAM,CAACyB,OAAO,CAAC,GAAG,MAAM3B,GAAG,CAACmB,MAAM,CAACS,IAAI,CAAC;IACpCC,KAAK,EAAE;MACHd,IAAI,EAAE,WAAW;MACjBR,IAAI,EAAE;QACFuB,QAAQ,EAAE7B,OAAO,CAAC6B,QAAQ;QAC1BC,SAAS,EAAE9B,OAAO,CAAC8B;MACvB;IACJ,CAAC;IACDC,KAAK,EAAE;EACX,CAAC,CAAC;EACF,MAAMC,WAAW,GAAGN,OAAO,GAAG,CAAC,CAAC;EAEhC,IAAIM,WAAW,EAAE;IACb,MAAMC,eAAe,GAAGC,IAAI,CAACC,KAAK,CAACH,WAAW,CAACI,OAAO,CAAC;IACvD,MAAMC,UAAU,GAAGrC,OAAO,CAACsC,SAAS,CAACC,OAAO,CAAC,CAAC;;IAE9C;IACA,IAAIF,UAAU,GAAGJ,eAAe,GAAGR,KAAK,GAAG,IAAI,EAAE;MAC7C,MAAMe,eAAe,GAAI,MAAMvC,UAAU,CAACwC,UAAU,CAChDT,WAAW,CAAC1B,IAChB,CAA8B;MAC9B;MACA,MAAMoC,iBAAiB,GAAGtC,IAAI,CAAC+B,KAAK,CAACK,eAAe,EAAElC,IAAI,CAACA,IAAI,CAAC,EAAEqC,MAAM;MACxE,MAAMC,gBAAgB,GAAG5C,OAAO,CAACM,IAAI,EAAEuC,KAAK;MAC5C,MAAMC,kBAAkB,GAAGJ,iBAAiB,GACtCtC,IAAI,CAACC,SAAS,CAAC;QAAEsC,MAAM,EAAED,iBAAiB;QAAEG,KAAK,EAAED;MAAiB,CAAC,CAAC,GACtExC,IAAI,CAACC,SAAS,CAACL,OAAO,CAACM,IAAI,CAAC;MAElC,MAAMA,IAAI,GAAG,MAAML,UAAU,CAACgB,QAAQ,CAAC6B,kBAAkB,CAAC;MAC1D,IAAI;QACA,MAAM/C,GAAG,CAACmB,MAAM,CAAC6B,MAAM,CAACf,WAAW,CAACxB,EAAE,EAAE;UACpCF,IAAI,EAAE;YACF,GAAGN,OAAO;YACVM;UACJ;QACJ,CAAC,CAAC;QAEF,OAAO;UACH,GAAG0B,WAAW;UACd1B,IAAI,EAAEwC;QACV,CAAC;MACL,CAAC,CAAC,OAAO1B,KAAK,EAAE;QACZ,MAAMC,cAAW,CAACC,IAAI,CAACF,KAAK,EAAE;UAC1BT,OAAO,EAAE,gCAAgC;UACzCY,IAAI,EAAE;QACV,CAAC,CAAC;MACN;IACJ;EACJ;EAEA,OAAO1B,cAAc,CAACC,MAAM,CAAC;AACjC,CAAC;AAEM,MAAMkD,cAAc,GAAIC,KAAkB,IAAK;EAClD,OAAO,OACHtC,OAAe,EACfL,IAAyB,EACzBuB,QAAgB,EAChB3B,OAAyB,KACxB;IACD,MAAM;MAAEgD,GAAG;MAAEC;IAAS,CAAC,GAAGjD,OAAO;IAEjC,IAAI,CAACgD,GAAG,EAAE;MACNE,OAAO,CAACC,GAAG,CAAC,iBAAiB,CAAC;MAC9B;IACJ;IAEA,MAAMC,QAAQ,GAAGH,QAAQ,CAACI,WAAW,CAAC,CAAC;IAEvC,MAAMC,eAAe,GAAG;MACpB7C,OAAO;MACPZ,GAAG,EAAEkD,KAAK,CAAClD,GAAG,CAACA,GAAG;MAClB0D,MAAM,EAAER,KAAK,CAACQ,MAAM,CAAC3C,IAAI;MACzBe,QAAQ;MACR6B,MAAM,EAAET,KAAK,CAACS,MAAM,CAAC5C,IAAI;MACzBR,IAAI;MACJgC,SAAS,EAAE,IAAIJ,IAAI,CAAC,CAAC;MACrBJ,SAAS,EAAEwB,QAAQ,EAAE9C;IACzB,CAAC;IAED,MAAMT,GAAG,GAAGmD,GAAG,CAACS,MAAM,CAAC,WAAW,CAAC;IACnC,MAAMlC,KAAK,GAAGwB,KAAK,CAACS,MAAM,CAACE,aAAa;;IAExC;IACA,IAAInC,KAAK,EAAE;MACP,IAAI;QACA,OAAO,MAAMD,qBAAqB,CAAC;UAC/BzB,GAAG;UACHC,OAAO,EAAEwD,eAAe;UACxB/B;QACJ,CAAC,CAAC;MACN,CAAC,CAAC,MAAM;QACJ;MAAA,CACH,SAAS;QACN,OAAOrB,IAAI,CAACC,SAAS,CAAC,CAAC,CAAC,CAAC;MAC7B;IACJ;IACA,OAAO,MAAMR,cAAc,CAAC;MACxBE,GAAG;MACHC,OAAO,EAAEwD;IACb,CAAC,CAAC;EACN,CAAC;AACL,CAAC;AAACK,OAAA,CAAAb,cAAA,GAAAA,cAAA","ignoreList":[]}

package/utils/getAuditObject.d.ts

@@ -0,0 +1,2 @@
+import type { App, AuditObject } from "../types";
+export declare const getAuditObject: (apps: App[]) => AuditObject;

package/utils/getAuditObject.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAuditObject = void 0;
+const getAuditObject = apps => {
+  return apps.reduce((result, app) => {
+    result[app.app] = app.entities.reduce((entities, entity) => {
+      entities[entity.type] = entity.actions.reduce((actions, action) => {
+        actions[action.type] = {
+          app,
+          entity,
+          action
+        };
+        return actions;
+      }, {});
+      return entities;
+    }, {});
+    return result;
+  }, {});
+};
+exports.getAuditObject = getAuditObject;
+
+//# sourceMappingURL=getAuditObject.js.map

package/utils/getAuditObject.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["getAuditObject","apps","reduce","result","app","entities","entity","type","actions","action","exports"],"sources":["getAuditObject.ts"],"sourcesContent":["import type { ActionObject, App, AuditObject, EntityObject } from \"~/types\";\n\nexport const getAuditObject = (apps: App[]) => {\n    return apps.reduce<AuditObject>((result, app) => {\n        result[app.app] = app.entities.reduce<EntityObject>((entities, entity) => {\n            entities[entity.type] = entity.actions.reduce<ActionObject>((actions, action) => {\n                actions[action.type] = {\n                    app,\n                    entity,\n                    action\n                };\n\n                return actions;\n            }, {});\n\n            return entities;\n        }, {});\n\n        return result;\n    }, {});\n};\n"],"mappings":";;;;;;AAEO,MAAMA,cAAc,GAAIC,IAAW,IAAK;EAC3C,OAAOA,IAAI,CAACC,MAAM,CAAc,CAACC,MAAM,EAAEC,GAAG,KAAK;IAC7CD,MAAM,CAACC,GAAG,CAACA,GAAG,CAAC,GAAGA,GAAG,CAACC,QAAQ,CAACH,MAAM,CAAe,CAACG,QAAQ,EAAEC,MAAM,KAAK;MACtED,QAAQ,CAACC,MAAM,CAACC,IAAI,CAAC,GAAGD,MAAM,CAACE,OAAO,CAACN,MAAM,CAAe,CAACM,OAAO,EAAEC,MAAM,KAAK;QAC7ED,OAAO,CAACC,MAAM,CAACF,IAAI,CAAC,GAAG;UACnBH,GAAG;UACHE,MAAM;UACNG;QACJ,CAAC;QAED,OAAOD,OAAO;MAClB,CAAC,EAAE,CAAC,CAAC,CAAC;MAEN,OAAOH,QAAQ;IACnB,CAAC,EAAE,CAAC,CAAC,CAAC;IAEN,OAAOF,MAAM;EACjB,CAAC,EAAE,CAAC,CAAC,CAAC;AACV,CAAC;AAACO,OAAA,CAAAV,cAAA,GAAAA,cAAA","ignoreList":[]}