@autofleet/shtinker 2.1.0 → 3.0.0

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,`__esModule`,{value:!0});var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));const c=s(require(`@autofleet/zehut`)),l=s(require(`lodash`)),u=s(require(`@autofleet/logger`)),d=s(require(`@autofleet/errors`)),f=s(require(`@autofleet/network`));let p=/* @__PURE__ */ function(e){return e.CREATE=`create`,e.BULK_CREATE=`bulk-create`,e.BULK_EDIT=`bulk-edit`,e.DELETE=`delete`,e.UPDATE=`update`,e.CANCEL=`cancel`,e.FAIL=`fail`,e.UNASSIGN=`unassign`,e.BULK_ASSIGN=`bulk-assign`,e.REASSIGN=`reassign`,e.DISPATCH=`dispatch`,e.BULK_DISPATCH=`bulk-dispatch`,e.BULK_UPSERT=`bulk-upsert`,e.UPSERT=`upsert`,e.JOIN=`join`,e.MOVE=`move`,e.REOPTIMIZATION=`reoptimization`,e}({}),m=/* @__PURE__ */ function(e){return e.RIDE=`Ride`,e.VEHICLE=`Vehicle`,e.DRIVER=`Driver`,e.PRICE_CALCULATION=`PriceCalculation`,e}({}),h=/* @__PURE__ */ function(e){return e.USER=`user`,e.AUTOMATION=`automation`,e}({});const g=`audit-log-context`,_=`audit-log-rows`,v=`auditLogContext`,y=`x-af-automation-id`,b=(0,u.default)(null);var x=b;const S=`customFields`,C=()=>{let e=(0,c.getCurrentPayload)(),t=e?.nonHeaderContext?.get(v);return t},w={[p.BULK_CREATE]:p.BULK_CREATE,[p.BULK_EDIT]:p.BULK_EDIT,[p.BULK_ASSIGN]:p.BULK_ASSIGN,[p.BULK_DISPATCH]:p.BULK_DISPATCH,[p.BULK_UPSERT]:p.BULK_UPSERT},T=e=>[null,void 0].includes(e)?!0:Array.isArray(e)?e.length===0:typeof e==`object`&&!(e instanceof Date)?Object.keys(e).length===0:!1,E=e=>!w[e],D=(e,t)=>e.filter(e=>!T(t.get(e))||!T(t.previous(e))),O=(e,t)=>{let n=t.returning?t.fields:e.changed(),r=D(n.filter(e=>e!==S),e);return r.map(t=>({property:t,previousValue:e.previous(t),newValue:e.get(t)}))},k=e=>{let t=e.changed(),n=t&&t.includes(S);if(!n)return[];let r=e.get(S),i=e.previous(S),a=Object.keys(r).filter(e=>{let t=r?.[e],n=i?.[e];return(!T(t)||!T(n))&&!(0,l.isEqual)(t,n)});return a.map(e=>({property:`${S}.${e}`,previousValue:i?.[e],newValue:r?.[e]}))};var A=class{constructor(e){this.rabbit=e.rabbit,this.sequelize=e.sequelize,this.logger=e.logger||x}registerHooks(){Object.entries(this.sequelize.models).forEach(([e,t])=>{t.addHook(`afterSave`,async(t,n)=>{try{let r=C();if(!r)return;r?.entityType?.toLowerCase()===e?.toLowerCase()&&E(r.action)&&(r.entityId=t.id);let i=O(t,n),a=k(t),o={entityType:e,entityId:t.id,rows:[...i,...a]};this.sendAuditLogRows(o)}catch(e){this.logger.error(`Failed to send audit log rows`,e)}})})}async sendAuditLogContext(e){try{await this.rabbit.sendToQueue(g,e)}catch(e){this.logger.error(`Failed to send audit log context`,e)}}async sendAuditLogRows(e){try{await this.rabbit.sendToQueue(_,e)}catch(e){this.logger.error(`Failed to send audit log rows`,e)}}},j=A;const M=new f.default({serviceName:`AUDIT_MS`,timeout:6e4,logger:x}),N=async e=>{let{data:t}=await M.get(`api/v1/audit-logs/${e}`);return t},P={getByEntityId:N};var F=P,I=async({router:e,logger:t,entityScopedModelMap:n})=>{!n||!e||Object.entries(n).forEach(([n,r])=>{e.get(`${n}/:id/audit`,async(e,i)=>{try{let{id:a}=e.params,o=await r.findByPk(a);if(!o)return(0,d.handleError)(new d.ResourceNotFoundError,i,{logger:t,message:`Entity ${n} with id ${a} not found`});let s=F.getByEntityId(a);return i.json(s)}catch(e){return(0,d.handleError)(new d.UnexpectedError(e),i,{logger:t})}})})};let L;const R=e=>{process.env.DISABLE_AUDIT_LOGS!==`true`&&(L=new j(e),I(e),L.registerHooks())},z=(e,t)=>async(n,r,i)=>{try{if(process.env.DISABLE_AUDIT_LOGS===`true`||!L)return i();let a=(0,c.getUser)(),o=n.headers[y],{performedBy:s,actionOrigin:l}=a?.id?{performedBy:a.id,actionOrigin:h.USER}:{performedBy:o??null,actionOrigin:o?h.AUTOMATION:null},u={entityType:e,action:t,endpoint:n.url,method:n.method,performedBy:s,actionOrigin:l},d=(0,c.getCurrentPayload)();d.nonHeaderContext.set(v,u);let f=async()=>{r.off(`finish`,f),r.off(`close`,f),r.off(`error`,f),await L.sendAuditLogContext(u)};E(t)?(r.once(`finish`,f),r.once(`close`,f),r.once(`error`,f)):await L.sendAuditLogContext(u)}catch(e){x.error(`coudln't set audit context`,e)}return i()},B=(e,t)=>async(n,{userId:r,automationId:i})=>{if(process.env.DISABLE_AUDIT_LOGS===`true`||!L)return;let a=(0,c.getCurrentPayload)();if(a?.context?.get){let{performedBy:o,actionOrigin:s}=r?{performedBy:r,actionOrigin:h.USER}:{performedBy:i??null,actionOrigin:i?h.AUTOMATION:null},c={entityType:e,action:t,endpoint:n,method:`rabbit`,performedBy:o,actionOrigin:s};a.nonHeaderContext.set(v,c),await L.sendAuditLogContext(c)}};var V=j;exports.AUDIT_LOG_CONTEXT_KEY=v,exports.AUDIT_LOG_CONTEXT_QUEUE=g,exports.AUDIT_LOG_ROWS_QUEUE=_,exports.AUTOMATION_ID_HEADER=y,exports.Action=p,exports.ActionOrigin=h,exports.EntityType=m,exports.default=V,exports.enableAuditing=R,exports.setAuditContext=z,exports.setRabbitAuditContext=B;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["logger: LoggerInstanceManager","action: string","fields: string[]","instance: Model","options: CreateOptions<any> | InstanceUpdateOptions<any>","changedFields: string[]","property: string","options: AuditLoggerOptions","payload: AuditLogPayload","context: AuditLogContext","entityId: string","exportObj: { getByEntityId: typeof getByEntityId }","auditLogger: AuditLogger | undefined","options: AuditLoggerOptions","entityType: string","action: string","req: Request","res: Response","next: NextFunction","auditLogContext: AuditLogContext","endpoint: string"],"sources":["../src/types.ts","../src/const.ts","../src/logger.ts","../src/audit-logger.ts","../src/audit-ms.ts","../src/audit-api.ts","../src/index.ts"],"sourcesContent":["/* eslint-disable no-shadow */\nimport type { ModelStatic, Model } from 'sequelize';\nimport type { Sequelize } from 'sequelize-typescript';\nimport type RabbitMq from '@autofleet/rabbit';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { IRouter } from 'express';\n\nexport type AuditLoggerOptions = {\n  rabbit: RabbitMq;\n  sequelize: Sequelize;\n  logger: LoggerInstanceManager;\n  router?: IRouter;\n  entityScopedModelMap?: { [modelName: string]: ModelStatic<Model> };\n};\n\nexport interface AuditLogContext {\n  entityType: string;\n  entityId?: string;\n  action: string;\n  performedBy: string;\n  endpoint: string;\n  method: string;\n  actionOrigin?: string;\n}\n\nexport interface AuditLogRow {\n  property: string;\n  previousValue: any;\n  newValue: any;\n}\n\nexport interface AuditLogPayload {\n  entityType: string;\n  entityId: string;\n  rows: AuditLogRow[];\n}\n\nexport enum Action {\n  CREATE = 'create',\n  BULK_CREATE = 'bulk-create',\n  BULK_EDIT = 'bulk-edit',\n  DELETE = 'delete',\n  UPDATE = 'update',\n  CANCEL = 'cancel',\n  FAIL = 'fail',\n  UNASSIGN = 'unassign',\n  BULK_ASSIGN = 'bulk-assign',\n  REASSIGN = 'reassign',\n  DISPATCH = 'dispatch',\n  BULK_DISPATCH = 'bulk-dispatch',\n  BULK_UPSERT = 'bulk-upsert',\n  UPSERT = 'upsert',\n  JOIN = 'join',\n  MOVE = 'move',\n  REOPTIMIZATION = 'reoptimization',\n}\n\nexport enum EntityType {\n  RIDE = 'Ride',\n  VEHICLE = 'Vehicle',\n  DRIVER = 'Driver',\n  PRICE_CALCULATION = 'PriceCalculation',\n}\n\nexport const enum ActionOrigin {\n  USER = 'user',\n  AUTOMATION = 'automation',\n}\n","export const AUDIT_LOG_CONTEXT_QUEUE = 'audit-log-context';\nexport const AUDIT_LOG_ROWS_QUEUE = 'audit-log-rows';\nexport const AUDIT_LOG_CONTEXT_KEY = 'auditLogContext';\nexport const AUTOMATION_ID_HEADER = 'x-af-automation-id';\n","import Logger, { type LoggerInstanceManager } from '@autofleet/logger';\n\nconst logger: LoggerInstanceManager = Logger(null);\nexport default logger;\n","import type RabbitMq from '@autofleet/rabbit';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';\nimport type {\n  CreateOptions, InstanceUpdateOptions, Model, Sequelize,\n} from 'sequelize';\nimport { isEqual } from 'lodash';\nimport {\n  type AuditLogPayload, type AuditLoggerOptions, type AuditLogContext, Action,\n} from './types';\nimport { AUDIT_LOG_CONTEXT_QUEUE, AUDIT_LOG_ROWS_QUEUE, AUDIT_LOG_CONTEXT_KEY } from './const';\nimport logger from './logger';\n\nconst CUSTOM_FIELDS_PROPERTY = 'customFields';\n\nconst getAuditContext = () => {\n  const currentTrace = getCurrentTrace();\n  const auditContext = currentTrace?.nonHeaderContext?.get(AUDIT_LOG_CONTEXT_KEY);\n  return auditContext as AuditLogContext;\n};\n\nconst ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT = {\n  [Action.BULK_CREATE]: Action.BULK_CREATE,\n  [Action.BULK_EDIT]: Action.BULK_EDIT,\n  [Action.BULK_ASSIGN]: Action.BULK_ASSIGN,\n  [Action.BULK_DISPATCH]: Action.BULK_DISPATCH,\n  [Action.BULK_UPSERT]: Action.BULK_UPSERT,\n};\n\nconst isEmpty = (field) => {\n  if ([null, undefined].includes(field)) {\n    return true;\n  }\n  if (Array.isArray(field)) {\n    return field.length === 0;\n  }\n  if (typeof field === 'object' && !(field instanceof Date)) {\n    return Object.keys(field).length === 0;\n  }\n  return false;\n};\n\nexport const isEntityIdRequired = (action: string): boolean => !ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT[action];\n\nconst filterOutEmptyFields = (fields: string[], instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));\n\nconst getChangedFieldsRows = (instance: Model, options: CreateOptions<any> | InstanceUpdateOptions<any>) => {\n  // When bulk updating in sequelize using the \"returning\" option, the instance.changed() stops working.\n  // It's a known issue with sequelize.\n  const changedFields: string[] = options.returning ? options.fields as string[] : instance.changed() as string[];\n  // Filter customFields - we'll handle them later\n  const filteredChangedFields = filterOutEmptyFields(changedFields.filter((field) => field !== CUSTOM_FIELDS_PROPERTY), instance);\n  return filteredChangedFields.map((property: string) => ({\n    property,\n    previousValue: instance.previous(property),\n    newValue: instance.get(property),\n  }));\n};\n\nconst getChangedCustomFieldsRows = (instance: Model) => {\n  const changed = instance.changed();\n  const customFieldsChanged = changed && changed.includes(CUSTOM_FIELDS_PROPERTY);\n  if (!customFieldsChanged) {\n    return [];\n  }\n\n  const customFields = instance.get(CUSTOM_FIELDS_PROPERTY);\n  const previousCustomFields = instance.previous(CUSTOM_FIELDS_PROPERTY);\n  const changedCustomFields = Object.keys(customFields).filter((field) => {\n    const newValue = customFields?.[field];\n    const oldValue = previousCustomFields?.[field];\n    return (!isEmpty(newValue) || !isEmpty(oldValue)) && !isEqual(newValue, oldValue);\n  });\n  return changedCustomFields.map((changedCustomField) => ({\n    property: `${CUSTOM_FIELDS_PROPERTY}.${changedCustomField}`,\n    previousValue: previousCustomFields?.[changedCustomField],\n    newValue: customFields?.[changedCustomField],\n  }));\n};\n\nclass AuditLogger {\n  private rabbit: RabbitMq;\n\n  private sequelize: Sequelize;\n\n  private logger: LoggerInstanceManager;\n\n  constructor(options: AuditLoggerOptions) {\n    this.rabbit = options.rabbit;\n    this.sequelize = options.sequelize;\n    this.logger = options.logger || logger;\n  }\n\n  public registerHooks(): void {\n    Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {\n      modelType.addHook('afterSave', async (instance, options) => {\n        try {\n          const auditContext = getAuditContext();\n          if (!auditContext) {\n            return;\n          }\n          if (auditContext?.entityType?.toLowerCase() === modelName?.toLowerCase() && isEntityIdRequired(auditContext.action)) {\n            auditContext.entityId = (instance as any).id;\n          }\n          const changedFieldsRows = getChangedFieldsRows(instance, options);\n          const changedCustomFieldsRows = getChangedCustomFieldsRows(instance);\n          const payload: AuditLogPayload = {\n            entityType: modelName,\n            entityId: (instance as any).id,\n            rows: [...changedFieldsRows, ...changedCustomFieldsRows],\n          };\n          this.sendAuditLogRows(payload);\n        } catch (error) {\n          this.logger.error('Failed to send audit log rows', error);\n        }\n      });\n    });\n  }\n\n  public async sendAuditLogContext(context: AuditLogContext): Promise<void> {\n    try {\n      await this.rabbit.sendToQueue(AUDIT_LOG_CONTEXT_QUEUE, context);\n    } catch (err) {\n      this.logger.error('Failed to send audit log context', err);\n    }\n  }\n\n  private async sendAuditLogRows(payload: AuditLogPayload): Promise<void> {\n    try {\n      await this.rabbit.sendToQueue(AUDIT_LOG_ROWS_QUEUE, payload);\n    } catch (err) {\n      this.logger.error('Failed to send audit log rows', err);\n    }\n  }\n}\n\nexport default AuditLogger;\n","import Network from '@autofleet/network';\nimport logger from './logger';\n\nconst auditMs = new Network({ serviceName: 'AUDIT_MS', timeout: 60_000, logger });\n\nconst getByEntityId = async (entityId: string): Promise<any> => {\n  const { data } = await auditMs.get(`api/v1/audit-logs/${entityId}`);\n  return data;\n};\n\nconst exportObj: { getByEntityId: typeof getByEntityId } = { getByEntityId };\n\nexport default exportObj;\n","import { handleError, ResourceNotFoundError, UnexpectedError } from '@autofleet/errors';\nimport auditMs from './audit-ms';\nimport { AuditLoggerOptions } from './types';\n\nexport default async ({\n  router,\n  logger,\n  entityScopedModelMap,\n}: AuditLoggerOptions): Promise<void> => {\n  if (!entityScopedModelMap || !router) {\n    return;\n  }\n  Object.entries(entityScopedModelMap).forEach(([entity, ScopedModel]) => {\n    router.get(`${entity}/:id/audit`, async (req, res) => {\n      try {\n        const { id } = req.params;\n        const entityData = await ScopedModel.findByPk(id);\n        if (!entityData) {\n          return handleError(new ResourceNotFoundError(), res, { logger, message: `Entity ${entity} with id ${id} not found` });\n        }\n        const auditData = auditMs.getByEntityId(id);\n        return res.json(auditData);\n      } catch (err) {\n        return handleError(new UnexpectedError(err as Error), res, { logger });\n      }\n    });\n  });\n};\n","import { getCurrentPayload as getCurrentTrace, getUser } from '@autofleet/zehut';\nimport type { Request, Response, NextFunction } from 'express';\nimport AuditLogger, { isEntityIdRequired } from './audit-logger';\nimport { ActionOrigin, type AuditLogContext, type AuditLoggerOptions } from './types';\nimport { AUDIT_LOG_CONTEXT_KEY, AUTOMATION_ID_HEADER } from './const';\nimport addAuditApi from './audit-api';\nimport logger from './logger';\n\nlet auditLogger: AuditLogger | undefined;\n\nexport const enableAuditing = (options: AuditLoggerOptions): void => {\n  if (process.env.DISABLE_AUDIT_LOGS === 'true') {\n    return;\n  }\n  auditLogger = new AuditLogger(options);\n  addAuditApi(options);\n  auditLogger.registerHooks();\n};\n\nexport const setAuditContext = (\n  entityType: string,\n  action: string,\n) => async (req: Request, res: Response, next: NextFunction): Promise<void> => {\n  try {\n    if (process.env.DISABLE_AUDIT_LOGS === 'true' || !auditLogger) {\n      return next();\n    }\n    const user = getUser();\n    const automationId = req.headers[AUTOMATION_ID_HEADER] as string | undefined;\n    const { performedBy, actionOrigin } = user?.id\n      ? { performedBy: user.id, actionOrigin: ActionOrigin.USER }\n      : { performedBy: automationId ?? null, actionOrigin: automationId ? ActionOrigin.AUTOMATION : null };\n    const auditLogContext: AuditLogContext = {\n      entityType,\n      action,\n      endpoint: req.url,\n      method: req.method,\n      performedBy,\n      actionOrigin,\n    };\n\n    const currentTrace = getCurrentTrace();\n    currentTrace.nonHeaderContext.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);\n\n    const sendAuditLogContextEvent = async () => {\n      res.off('finish', sendAuditLogContextEvent);\n      res.off('close', sendAuditLogContextEvent);\n      res.off('error', sendAuditLogContextEvent);\n      await auditLogger.sendAuditLogContext(auditLogContext);\n    };\n    if (!isEntityIdRequired(action)) { // if it's a bulk action, we don't want to wait for the response to add the entity id\n      await auditLogger.sendAuditLogContext(auditLogContext);\n    } else {\n      res.once('finish', sendAuditLogContextEvent);\n      res.once('close', sendAuditLogContextEvent);\n      res.once('error', sendAuditLogContextEvent);\n    }\n  } catch (err) {\n    logger.error('coudln\\'t set audit context', err);\n  }\n  return next();\n};\n\nexport const setRabbitAuditContext = (\n  entityType: string,\n  action: string,\n) => async (endpoint: string, { userId, automationId }: { userId:string; automationId:string; }): Promise<void> => {\n  if (process.env.DISABLE_AUDIT_LOGS === 'true' || !auditLogger) {\n    return;\n  }\n  const currentTrace = getCurrentTrace();\n  if (currentTrace?.context?.get) {\n    const { performedBy, actionOrigin } = userId\n      ? { performedBy: userId, actionOrigin: ActionOrigin.USER }\n      : { performedBy: automationId ?? null, actionOrigin: automationId ? ActionOrigin.AUTOMATION : null };\n    const auditLogContext: AuditLogContext = {\n      entityType,\n      action,\n      endpoint,\n      method: 'rabbit',\n      performedBy,\n      actionOrigin,\n    };\n    currentTrace.nonHeaderContext.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);\n    await auditLogger.sendAuditLogContext(auditLogContext);\n  }\n};\n\nexport * from './types';\nexport * from './const';\n\nexport default AuditLogger;\n"],"mappings":"usBAgEA,IA3BY,kBAAA,SAAA,EAAL,QACL,EAAA,OAAA,SACA,EAAA,YAAA,cACA,EAAA,UAAA,YACA,EAAA,OAAA,SACA,EAAA,OAAA,SACA,EAAA,OAAA,SACA,EAAA,KAAA,OACA,EAAA,SAAA,WACA,EAAA,YAAA,cACA,EAAA,SAAA,WACA,EAAA,SAAA,WACA,EAAA,cAAA,gBACA,EAAA,YAAA,cACA,EAAA,OAAA,SACA,EAAA,KAAA,OACA,EAAA,KAAA,OACA,EAAA,eAAA,kBACD,EAAA,CAAA,EAAA,CAEW,kBAAA,SAAA,EAAL,QACL,EAAA,KAAA,OACA,EAAA,QAAA,UACA,EAAA,OAAA,SACA,EAAA,kBAAA,oBACD,EAAA,CAAA,EAAA,CAEiB,kBAAA,SAAA,EAAX,QACL,EAAA,KAAA,OACA,EAAA,WAAA,cACD,EAAA,CAAA,EAAA,CEjED,MDFa,EAA0B,oBAC1B,EAAuB,iBACvB,EAAwB,kBACxB,EAAuB,qBCD9BA,EAAgC,CAAA,EAAA,EAAA,SAAO,KAAK,CAClD,IAAA,EAAe,ECwDf,MA9CM,EAAyB,eAEzB,EAAkB,IAAM,CAE5B,IADM,EAAe,CAAA,EAAA,EAAA,oBAAiB,CAChC,EAAe,GAAc,kBAAkB,IAAI,EAAsB,CAC/E,OAAO,CACR,EAEK,EAAyC,EAC5C,EAAO,aAAc,EAAO,aAC5B,EAAO,WAAY,EAAO,WAC1B,EAAO,aAAc,EAAO,aAC5B,EAAO,eAAgB,EAAO,eAC9B,EAAO,aAAc,EAAO,WAC9B,EAEK,EAAU,AAAC,GACX,CAAC,SAAA,EAAgB,EAAC,SAAS,EAAM,EAC5B,EAEL,MAAM,QAAQ,EAAM,CACf,EAAM,SAAW,SAEf,GAAU,YAAc,aAAiB,MAC3C,OAAO,KAAK,EAAM,CAAC,SAAW,GAEhC,EAGI,EAAqB,AAACe,IAA6B,EAAuC,GAEjG,EAAuB,CAACb,EAAkB,IAAa,EAAO,OAAO,AAAC,IAAW,EAAQ,EAAS,IAAI,EAAM,CAAC,GAAK,EAAQ,EAAS,SAAS,EAAM,CAAC,CAAC,CAEpJ,EAAuB,CAACC,EAAiBC,IAA6D,CAK1G,IAFMC,EAA0B,EAAQ,UAAY,EAAQ,OAAqB,EAAS,SAAS,CAE7F,EAAwB,EAAqB,EAAc,OAAO,AAAC,GAAU,IAAU,EAAuB,CAAE,EAAS,CAC/H,MAAO,GAAsB,IAAI,AAACC,IAAsB,CACtD,WACA,cAAe,EAAS,SAAS,EAAS,CAC1C,SAAU,EAAS,IAAI,EAAS,AACjC,GAAE,AACJ,EAEK,EAA6B,AAACH,GAAoB,CAEtD,IADM,EAAU,EAAS,SAAS,CAC5B,EAAsB,GAAW,EAAQ,SAAS,EAAuB,CAC/E,IAAK,EACH,MAAO,CAAE,EAKX,IAFM,EAAe,EAAS,IAAI,EAAuB,CACnD,EAAuB,EAAS,SAAS,EAAuB,CAChE,EAAsB,OAAO,KAAK,EAAa,CAAC,OAAO,AAAC,GAAU,CAEtE,IADM,EAAW,IAAe,GAC1B,EAAW,IAAuB,GACxC,QAAS,EAAQ,EAAS,GAAK,EAAQ,EAAS,IAAM,CAAA,EAAA,EAAA,SAAQ,EAAU,EAAS,AAClF,EAAC,CACF,MAAO,GAAoB,IAAI,AAAC,IAAwB,CACtD,UAAW,EAAE,EAAuB,GAAG,EAAmB,EAC1D,cAAe,IAAuB,GACtC,SAAU,IAAe,EAC1B,GAAE,AACJ,EA0DD,IAxDM,EAAN,KAAkB,CAOhB,YAAYU,EAA6B,CAGvC,AAFA,KAAK,OAAS,EAAQ,OACtB,KAAK,UAAY,EAAQ,UACzB,KAAK,OAAS,EAAQ,QAAU,CACjC,CAED,eAA6B,CAC3B,OAAO,QAAQ,KAAK,UAAU,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAW,EAAU,GAAK,CACxE,EAAU,QAAQ,YAAa,MAAO,EAAU,IAAY,CAC1D,GAAI,CACF,IAAM,EAAe,GAAiB,CACtC,IAAK,EACH,OAEF,AAAI,GAAc,YAAY,aAAa,GAAK,GAAW,aAAa,EAAI,EAAmB,EAAa,OAAO,GACjH,EAAa,SAAY,EAAiB,IAI5C,IAFM,EAAoB,EAAqB,EAAU,EAAQ,CAC3D,EAA0B,EAA2B,EAAS,CAC9DL,EAA2B,CAC/B,WAAY,EACZ,SAAW,EAAiB,GAC5B,KAAM,CAAC,GAAG,EAAmB,GAAG,CAAwB,CACzD,EACD,KAAK,iBAAiB,EAAQ,AAC/B,OAAQ,EAAO,CACd,KAAK,OAAO,MAAM,gCAAiC,EAAM,AAC1D,CACF,EAAC,AACH,EAAC,AACH,CAED,MAAa,oBAAoBC,EAAyC,CACxE,GAAI,CACF,KAAM,MAAK,OAAO,YAAY,EAAyB,EAAQ,AAChE,OAAQ,EAAK,CACZ,KAAK,OAAO,MAAM,mCAAoC,EAAI,AAC3D,CACF,CAED,MAAc,iBAAiBD,EAAyC,CACtE,GAAI,CACF,KAAM,MAAK,OAAO,YAAY,EAAsB,EAAQ,AAC7D,OAAQ,EAAK,CACZ,KAAK,OAAO,MAAM,gCAAiC,EAAI,AACxD,CACF,CACF,EAED,EAAe,EC9Hf,MAPM,EAAU,IAAI,EAAA,QAAQ,CAAE,YAAa,WAAY,QAAS,IAAQ,OAAA,CAAQ,GAE1E,EAAgB,MAAOE,GAAmC,CAC9D,GAAM,CAAE,OAAM,CAAG,KAAM,GAAQ,KAAK,oBAAoB,EAAS,EAAE,CACnE,OAAO,CACR,EAEKC,EAAqD,CAAE,eAAe,ECN5E,IDQA,EAAe,ECRf,EAAe,MAAO,CACpB,SACA,OAAA,EACA,uBACmB,GAAoB,CACvC,CAAK,IAAyB,GAG9B,OAAO,QAAQ,EAAqB,CAAC,QAAQ,CAAC,CAAC,EAAQ,EAAY,GAAK,CACtE,EAAO,KAAK,EAAE,EAAO,YAAa,MAAO,EAAK,IAAQ,CACpD,GAAI,CAEF,GADM,CAAE,KAAI,CAAG,EAAI,OACb,EAAa,KAAM,GAAY,SAAS,EAAG,CACjD,IAAK,EACH,MAAO,CAAA,EAAA,EAAA,aAAY,IAAI,EAAA,sBAAyB,EAAK,CAAE,OAAA,EAAQ,SAAU,SAAS,EAAO,WAAW,EAAG,WAAa,EAAC,CAEvH,IAAM,EAAY,EAAQ,cAAc,EAAG,CAC3C,MAAO,GAAI,KAAK,EAAU,AAC3B,OAAQ,EAAK,CACZ,MAAO,CAAA,EAAA,EAAA,aAAY,IAAI,EAAA,gBAAgB,GAAe,EAAK,CAAE,OAAA,CAAQ,EAAC,AACvE,CACF,EAAC,AACH,EAAC,AACH,ECnBD,IAAIC,EAuDJ,MArDa,EAAiB,AAACC,GAAsC,CAC/D,QAAQ,IAAI,qBAAuB,SAGvC,EAAc,IAAI,EAAY,GAC9B,EAAY,EAAQ,CACpB,EAAY,eAAe,CAC5B,EAEY,EAAkB,CAC7BC,EACAC,IACG,MAAOC,EAAcC,EAAeC,IAAsC,CAC7E,GAAI,CACF,GAAI,QAAQ,IAAI,qBAAuB,SAAW,EAChD,MAAO,IAAM,CAgBf,IAdM,EAAO,CAAA,EAAA,EAAA,UAAS,CAChB,EAAe,EAAI,QAAQ,GAC3B,CAAE,cAAa,eAAc,CAAG,GAAM,GACxC,CAAE,YAAa,EAAK,GAAI,aAAc,EAAa,IAAM,EACzD,CAAE,YAAa,GAAgB,KAAM,aAAc,EAAe,EAAa,WAAa,IAAM,EAChGC,EAAmC,CACvC,aACA,SACA,SAAU,EAAI,IACd,OAAQ,EAAI,OACZ,cACA,cACD,EAEK,EAAe,CAAA,EAAA,EAAA,oBAAiB,CACtC,EAAa,iBAAiB,IAAI,EAAuB,EAAgB,CAEzE,IAAM,EAA2B,SAAY,CAI3C,AAHA,EAAI,IAAI,SAAU,EAAyB,CAC3C,EAAI,IAAI,QAAS,EAAyB,CAC1C,EAAI,IAAI,QAAS,EAAyB,CAC1C,KAAM,GAAY,oBAAoB,EAAgB,AACvD,EACD,AAAK,EAAmB,EAAO,EAG7B,EAAI,KAAK,SAAU,EAAyB,CAC5C,EAAI,KAAK,QAAS,EAAyB,CAC3C,EAAI,KAAK,QAAS,EAAyB,EAJ3C,KAAM,GAAY,oBAAoB,EAAgB,AAMzD,OAAQ,EAAK,CACZ,EAAO,MAAM,6BAA+B,EAAI,AACjD,CACD,MAAO,IAAM,AACd,EAEY,EAAwB,CACnCL,EACAC,IACG,MAAOK,EAAkB,CAAE,SAAQ,eAAuD,GAAoB,CACjH,GAAI,QAAQ,IAAI,qBAAuB,SAAW,EAChD,OAEF,IAAM,EAAe,CAAA,EAAA,EAAA,oBAAiB,CACtC,GAAI,GAAc,SAAS,IAAK,CAI9B,GAHM,CAAE,cAAa,eAAc,CAAG,EAClC,CAAE,YAAa,EAAQ,aAAc,EAAa,IAAM,EACxD,CAAE,YAAa,GAAgB,KAAM,aAAc,EAAe,EAAa,WAAa,IAAM,EAChGD,EAAmC,CACvC,aACA,SACA,WACA,OAAQ,SACR,cACA,cACD,EAED,AADA,EAAa,iBAAiB,IAAI,EAAuB,EAAgB,CACzE,KAAM,GAAY,oBAAoB,EAAgB,AACvD,CACF,EAKD,IAAA,EAAe"}

package/dist/index.d.cts

@@ -0,0 +1,97 @@
+import { IRouter, NextFunction, Request, Response } from "express";
+import { Model, ModelStatic } from "sequelize";
+import { Sequelize } from "sequelize-typescript";
+import RabbitMq from "@autofleet/rabbit";
+import { LoggerInstanceManager } from "@autofleet/logger";
+
+//#region src/types.d.ts
+type AuditLoggerOptions = {
+  rabbit: RabbitMq;
+  sequelize: Sequelize;
+  logger: LoggerInstanceManager;
+  router?: IRouter;
+  entityScopedModelMap?: {
+    [modelName: string]: ModelStatic<Model>;
+  };
+};
+interface AuditLogContext {
+  entityType: string;
+  entityId?: string;
+  action: string;
+  performedBy: string;
+  endpoint: string;
+  method: string;
+  actionOrigin?: string;
+}
+interface AuditLogRow {
+  property: string;
+  previousValue: any;
+  newValue: any;
+}
+interface AuditLogPayload {
+  entityType: string;
+  entityId: string;
+  rows: AuditLogRow[];
+}
+declare enum Action {
+  CREATE = "create",
+  BULK_CREATE = "bulk-create",
+  BULK_EDIT = "bulk-edit",
+  DELETE = "delete",
+  UPDATE = "update",
+  CANCEL = "cancel",
+  FAIL = "fail",
+  UNASSIGN = "unassign",
+  BULK_ASSIGN = "bulk-assign",
+  REASSIGN = "reassign",
+  DISPATCH = "dispatch",
+  BULK_DISPATCH = "bulk-dispatch",
+  BULK_UPSERT = "bulk-upsert",
+  UPSERT = "upsert",
+  JOIN = "join",
+  MOVE = "move",
+  REOPTIMIZATION = "reoptimization",
+}
+declare enum EntityType {
+  RIDE = "Ride",
+  VEHICLE = "Vehicle",
+  DRIVER = "Driver",
+  PRICE_CALCULATION = "PriceCalculation",
+}
+declare const enum ActionOrigin {
+  USER = "user",
+  AUTOMATION = "automation",
+} //#endregion
+//#region src/audit-logger.d.ts
+declare class AuditLogger {
+  private rabbit;
+  private sequelize;
+  private logger;
+  constructor(options: AuditLoggerOptions);
+  registerHooks(): void;
+  sendAuditLogContext(context: AuditLogContext): Promise<void>;
+  private sendAuditLogRows;
+}
+
+//#endregion
+//#region src/const.d.ts
+declare const AUDIT_LOG_CONTEXT_QUEUE = "audit-log-context";
+declare const AUDIT_LOG_ROWS_QUEUE = "audit-log-rows";
+declare const AUDIT_LOG_CONTEXT_KEY = "auditLogContext";
+declare const AUTOMATION_ID_HEADER = "x-af-automation-id";
+
+//#endregion
+//#region src/index.d.ts
+declare const enableAuditing: (options: AuditLoggerOptions) => void;
+declare const setAuditContext: (entityType: string, action: string) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+declare const setRabbitAuditContext: (entityType: string, action: string) => (endpoint: string, {
+  userId,
+  automationId
+}: {
+  userId: string;
+  automationId: string;
+}) => Promise<void>;
+
+//#endregion
+export { AUDIT_LOG_CONTEXT_KEY, AUDIT_LOG_CONTEXT_QUEUE, AUDIT_LOG_ROWS_QUEUE, AUTOMATION_ID_HEADER, Action, ActionOrigin, AuditLogContext, AuditLogPayload, AuditLogRow, AuditLoggerOptions, EntityType, AuditLogger as default, enableAuditing, setAuditContext, setRabbitAuditContext };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,12 +1,97 @@
-import type { Request, Response, NextFunction } from 'express';
-import AuditLogger from './audit-logger';
-import { AuditLoggerOptions } from './types';
-export declare const enableAuditing: (options: AuditLoggerOptions) => void;
-export declare const setAuditContext: (entityType: string, action: string) => (req: Request, res: Response, next: NextFunction) => Promise<any>;
-export declare const setRabbitAuditContext: (entityType: string, action: string) => (endpoint: string, { userId, automationId }: {
-    userId: string;
-    automationId: string;
-}) => Promise<any>;
-export * from './types';
-export * from './const';
-export default AuditLogger;
+import { LoggerInstanceManager } from "@autofleet/logger";
+import { IRouter, NextFunction, Request, Response } from "express";
+import { Model, ModelStatic } from "sequelize";
+import { Sequelize } from "sequelize-typescript";
+import RabbitMq from "@autofleet/rabbit";
+
+//#region src/types.d.ts
+type AuditLoggerOptions = {
+  rabbit: RabbitMq;
+  sequelize: Sequelize;
+  logger: LoggerInstanceManager;
+  router?: IRouter;
+  entityScopedModelMap?: {
+    [modelName: string]: ModelStatic<Model>;
+  };
+};
+interface AuditLogContext {
+  entityType: string;
+  entityId?: string;
+  action: string;
+  performedBy: string;
+  endpoint: string;
+  method: string;
+  actionOrigin?: string;
+}
+interface AuditLogRow {
+  property: string;
+  previousValue: any;
+  newValue: any;
+}
+interface AuditLogPayload {
+  entityType: string;
+  entityId: string;
+  rows: AuditLogRow[];
+}
+declare enum Action {
+  CREATE = "create",
+  BULK_CREATE = "bulk-create",
+  BULK_EDIT = "bulk-edit",
+  DELETE = "delete",
+  UPDATE = "update",
+  CANCEL = "cancel",
+  FAIL = "fail",
+  UNASSIGN = "unassign",
+  BULK_ASSIGN = "bulk-assign",
+  REASSIGN = "reassign",
+  DISPATCH = "dispatch",
+  BULK_DISPATCH = "bulk-dispatch",
+  BULK_UPSERT = "bulk-upsert",
+  UPSERT = "upsert",
+  JOIN = "join",
+  MOVE = "move",
+  REOPTIMIZATION = "reoptimization",
+}
+declare enum EntityType {
+  RIDE = "Ride",
+  VEHICLE = "Vehicle",
+  DRIVER = "Driver",
+  PRICE_CALCULATION = "PriceCalculation",
+}
+declare const enum ActionOrigin {
+  USER = "user",
+  AUTOMATION = "automation",
+} //#endregion
+//#region src/audit-logger.d.ts
+declare class AuditLogger {
+  private rabbit;
+  private sequelize;
+  private logger;
+  constructor(options: AuditLoggerOptions);
+  registerHooks(): void;
+  sendAuditLogContext(context: AuditLogContext): Promise<void>;
+  private sendAuditLogRows;
+}
+
+//#endregion
+//#region src/const.d.ts
+declare const AUDIT_LOG_CONTEXT_QUEUE = "audit-log-context";
+declare const AUDIT_LOG_ROWS_QUEUE = "audit-log-rows";
+declare const AUDIT_LOG_CONTEXT_KEY = "auditLogContext";
+declare const AUTOMATION_ID_HEADER = "x-af-automation-id";
+
+//#endregion
+//#region src/index.d.ts
+declare const enableAuditing: (options: AuditLoggerOptions) => void;
+declare const setAuditContext: (entityType: string, action: string) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+declare const setRabbitAuditContext: (entityType: string, action: string) => (endpoint: string, {
+  userId,
+  automationId
+}: {
+  userId: string;
+  automationId: string;
+}) => Promise<void>;
+
+//#endregion
+export { AUDIT_LOG_CONTEXT_KEY, AUDIT_LOG_CONTEXT_QUEUE, AUDIT_LOG_ROWS_QUEUE, AUTOMATION_ID_HEADER, Action, ActionOrigin, AuditLogContext, AuditLogPayload, AuditLogRow, AuditLoggerOptions, EntityType, AuditLogger as default, enableAuditing, setAuditContext, setRabbitAuditContext };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,122 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setRabbitAuditContext = exports.setAuditContext = exports.enableAuditing = void 0;
-const zehut_1 = require("@autofleet/zehut");
-const audit_logger_1 = __importStar(require("./audit-logger"));
-const const_1 = require("./const");
-const audit_api_1 = __importDefault(require("./audit-api"));
-const logger_1 = __importDefault(require("./logger"));
-let auditLogger;
-const enableAuditing = (options) => {
-    if (process.env.DISABLE_AUDIT_LOGS !== 'true') {
-        auditLogger = new audit_logger_1.default(options);
-        (0, audit_api_1.default)(options);
-        auditLogger.registerHooks();
-    }
-};
-exports.enableAuditing = enableAuditing;
-const setAuditContext = (entityType, action) => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    try {
-        const currentTrace = (0, zehut_1.getCurrentPayload)();
-        if (process.env.DISABLE_AUDIT_LOGS === 'true' || !((_a = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _a === void 0 ? void 0 : _a.get)) {
-            return next();
-        }
-        const user = currentTrace.context.get(const_1.USER_CONTEXT_KEY);
-        const { performedBy, actionOrigin } = (user === null || user === void 0 ? void 0 : user.id)
-            ? { performedBy: user.id, actionOrigin: "user" /* ActionOrigin.USER */ }
-            : { performedBy: (_b = req.headers[const_1.AUTOMATION_ID_HEADER]) !== null && _b !== void 0 ? _b : null, actionOrigin: req.headers[const_1.AUTOMATION_ID_HEADER] ? "automation" /* ActionOrigin.AUTOMATION */ : null };
-        const auditLogContext = {
-            entityType,
-            action,
-            endpoint: req.url,
-            method: req.method,
-            performedBy,
-            actionOrigin,
-        };
-        currentTrace.context.set(const_1.AUDIT_LOG_CONTEXT_KEY, auditLogContext);
-        const sendAuditLogContextEvent = () => __awaiter(void 0, void 0, void 0, function* () {
-            res.off('finish', sendAuditLogContextEvent);
-            res.off('close', sendAuditLogContextEvent);
-            res.off('error', sendAuditLogContextEvent);
-            yield auditLogger.sendAuditLogContext(auditLogContext);
-        });
-        if (!(0, audit_logger_1.isEntityIdRequired)(action)) { // if it's a bulk action, we don't want to wait for the response to add the entity id
-            yield auditLogger.sendAuditLogContext(auditLogContext);
-        }
-        else {
-            res.once('finish', sendAuditLogContextEvent);
-            res.once('close', sendAuditLogContextEvent);
-            res.once('error', sendAuditLogContextEvent);
-        }
-    }
-    catch (err) {
-        logger_1.default.error('coudln\'t set audit context', err);
-    }
-    return next();
-});
-exports.setAuditContext = setAuditContext;
-const setRabbitAuditContext = (entityType, action) => (endpoint, { userId, automationId }) => __awaiter(void 0, void 0, void 0, function* () {
-    var _c;
-    if (process.env.DISABLE_AUDIT_LOGS === 'true') {
-        return;
-    }
-    const currentTrace = (0, zehut_1.getCurrentPayload)();
-    if ((_c = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _c === void 0 ? void 0 : _c.get) {
-        const { performedBy, actionOrigin } = userId
-            ? { performedBy: userId, actionOrigin: "user" /* ActionOrigin.USER */ }
-            : { performedBy: automationId !== null && automationId !== void 0 ? automationId : null, actionOrigin: automationId ? "automation" /* ActionOrigin.AUTOMATION */ : null };
-        const auditLogContext = {
-            entityType,
-            action,
-            endpoint,
-            method: 'rabbit',
-            performedBy,
-            actionOrigin,
-        };
-        currentTrace.context.set(const_1.AUDIT_LOG_CONTEXT_KEY, auditLogContext);
-        yield auditLogger.sendAuditLogContext(auditLogContext);
-    }
-});
-exports.setRabbitAuditContext = setRabbitAuditContext;
-__exportStar(require("./types"), exports);
-__exportStar(require("./const"), exports);
-exports.default = audit_logger_1.default;
+import{getCurrentPayload as e,getUser as t}from"@autofleet/zehut";import{isEqual as n}from"lodash";import r from"@autofleet/logger";import{ResourceNotFoundError as i,UnexpectedError as a,handleError as o}from"@autofleet/errors";import s from"@autofleet/network";let c=/* @__PURE__ */ function(e){return e.CREATE=`create`,e.BULK_CREATE=`bulk-create`,e.BULK_EDIT=`bulk-edit`,e.DELETE=`delete`,e.UPDATE=`update`,e.CANCEL=`cancel`,e.FAIL=`fail`,e.UNASSIGN=`unassign`,e.BULK_ASSIGN=`bulk-assign`,e.REASSIGN=`reassign`,e.DISPATCH=`dispatch`,e.BULK_DISPATCH=`bulk-dispatch`,e.BULK_UPSERT=`bulk-upsert`,e.UPSERT=`upsert`,e.JOIN=`join`,e.MOVE=`move`,e.REOPTIMIZATION=`reoptimization`,e}({}),l=/* @__PURE__ */ function(e){return e.RIDE=`Ride`,e.VEHICLE=`Vehicle`,e.DRIVER=`Driver`,e.PRICE_CALCULATION=`PriceCalculation`,e}({}),u=/* @__PURE__ */ function(e){return e.USER=`user`,e.AUTOMATION=`automation`,e}({});const d=`audit-log-context`,f=`audit-log-rows`,p=`auditLogContext`,m=`x-af-automation-id`,h=r(null);var g=h;const _=`customFields`,v=()=>{let t=e(),n=t?.nonHeaderContext?.get(p);return n},y={[c.BULK_CREATE]:c.BULK_CREATE,[c.BULK_EDIT]:c.BULK_EDIT,[c.BULK_ASSIGN]:c.BULK_ASSIGN,[c.BULK_DISPATCH]:c.BULK_DISPATCH,[c.BULK_UPSERT]:c.BULK_UPSERT},b=e=>[null,void 0].includes(e)?!0:Array.isArray(e)?e.length===0:typeof e==`object`&&!(e instanceof Date)?Object.keys(e).length===0:!1,x=e=>!y[e],S=(e,t)=>e.filter(e=>!b(t.get(e))||!b(t.previous(e))),C=(e,t)=>{let n=t.returning?t.fields:e.changed(),r=S(n.filter(e=>e!==_),e);return r.map(t=>({property:t,previousValue:e.previous(t),newValue:e.get(t)}))},w=e=>{let t=e.changed(),r=t&&t.includes(_);if(!r)return[];let i=e.get(_),a=e.previous(_),o=Object.keys(i).filter(e=>{let t=i?.[e],r=a?.[e];return(!b(t)||!b(r))&&!n(t,r)});return o.map(e=>({property:`${_}.${e}`,previousValue:a?.[e],newValue:i?.[e]}))};var T=class{constructor(e){this.rabbit=e.rabbit,this.sequelize=e.sequelize,this.logger=e.logger||g}registerHooks(){Object.entries(this.sequelize.models).forEach(([e,t])=>{t.addHook(`afterSave`,async(t,n)=>{try{let r=v();if(!r)return;r?.entityType?.toLowerCase()===e?.toLowerCase()&&x(r.action)&&(r.entityId=t.id);let i=C(t,n),a=w(t),o={entityType:e,entityId:t.id,rows:[...i,...a]};this.sendAuditLogRows(o)}catch(e){this.logger.error(`Failed to send audit log rows`,e)}})})}async sendAuditLogContext(e){try{await this.rabbit.sendToQueue(d,e)}catch(e){this.logger.error(`Failed to send audit log context`,e)}}async sendAuditLogRows(e){try{await this.rabbit.sendToQueue(f,e)}catch(e){this.logger.error(`Failed to send audit log rows`,e)}}},E=T;const D=new s({serviceName:`AUDIT_MS`,timeout:6e4,logger:g}),O=async e=>{let{data:t}=await D.get(`api/v1/audit-logs/${e}`);return t},k={getByEntityId:O};var A=k,j=async({router:e,logger:t,entityScopedModelMap:n})=>{!n||!e||Object.entries(n).forEach(([n,r])=>{e.get(`${n}/:id/audit`,async(e,s)=>{try{let{id:a}=e.params,c=await r.findByPk(a);if(!c)return o(new i,s,{logger:t,message:`Entity ${n} with id ${a} not found`});let l=A.getByEntityId(a);return s.json(l)}catch(e){return o(new a(e),s,{logger:t})}})})};let M;const N=e=>{process.env.DISABLE_AUDIT_LOGS!==`true`&&(M=new E(e),j(e),M.registerHooks())},P=(n,r)=>async(i,a,o)=>{try{if(process.env.DISABLE_AUDIT_LOGS===`true`||!M)return o();let s=t(),c=i.headers[m],{performedBy:l,actionOrigin:d}=s?.id?{performedBy:s.id,actionOrigin:u.USER}:{performedBy:c??null,actionOrigin:c?u.AUTOMATION:null},f={entityType:n,action:r,endpoint:i.url,method:i.method,performedBy:l,actionOrigin:d},h=e();h.nonHeaderContext.set(p,f);let g=async()=>{a.off(`finish`,g),a.off(`close`,g),a.off(`error`,g),await M.sendAuditLogContext(f)};x(r)?(a.once(`finish`,g),a.once(`close`,g),a.once(`error`,g)):await M.sendAuditLogContext(f)}catch(e){g.error(`coudln't set audit context`,e)}return o()},F=(t,n)=>async(r,{userId:i,automationId:a})=>{if(process.env.DISABLE_AUDIT_LOGS===`true`||!M)return;let o=e();if(o?.context?.get){let{performedBy:e,actionOrigin:s}=i?{performedBy:i,actionOrigin:u.USER}:{performedBy:a??null,actionOrigin:a?u.AUTOMATION:null},c={entityType:t,action:n,endpoint:r,method:`rabbit`,performedBy:e,actionOrigin:s};o.nonHeaderContext.set(p,c),await M.sendAuditLogContext(c)}};var I=E;export{p as AUDIT_LOG_CONTEXT_KEY,d as AUDIT_LOG_CONTEXT_QUEUE,f as AUDIT_LOG_ROWS_QUEUE,m as AUTOMATION_ID_HEADER,c as Action,u as ActionOrigin,l as EntityType,I as default,N as enableAuditing,P as setAuditContext,F as setRabbitAuditContext};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["logger: LoggerInstanceManager","action: string","fields: string[]","instance: Model","options: CreateOptions<any> | InstanceUpdateOptions<any>","changedFields: string[]","property: string","options: AuditLoggerOptions","payload: AuditLogPayload","context: AuditLogContext","entityId: string","exportObj: { getByEntityId: typeof getByEntityId }","auditLogger: AuditLogger | undefined","options: AuditLoggerOptions","entityType: string","action: string","req: Request","res: Response","next: NextFunction","auditLogContext: AuditLogContext","endpoint: string"],"sources":["../src/types.ts","../src/const.ts","../src/logger.ts","../src/audit-logger.ts","../src/audit-ms.ts","../src/audit-api.ts","../src/index.ts"],"sourcesContent":["/* eslint-disable no-shadow */\nimport type { ModelStatic, Model } from 'sequelize';\nimport type { Sequelize } from 'sequelize-typescript';\nimport type RabbitMq from '@autofleet/rabbit';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { IRouter } from 'express';\n\nexport type AuditLoggerOptions = {\n  rabbit: RabbitMq;\n  sequelize: Sequelize;\n  logger: LoggerInstanceManager;\n  router?: IRouter;\n  entityScopedModelMap?: { [modelName: string]: ModelStatic<Model> };\n};\n\nexport interface AuditLogContext {\n  entityType: string;\n  entityId?: string;\n  action: string;\n  performedBy: string;\n  endpoint: string;\n  method: string;\n  actionOrigin?: string;\n}\n\nexport interface AuditLogRow {\n  property: string;\n  previousValue: any;\n  newValue: any;\n}\n\nexport interface AuditLogPayload {\n  entityType: string;\n  entityId: string;\n  rows: AuditLogRow[];\n}\n\nexport enum Action {\n  CREATE = 'create',\n  BULK_CREATE = 'bulk-create',\n  BULK_EDIT = 'bulk-edit',\n  DELETE = 'delete',\n  UPDATE = 'update',\n  CANCEL = 'cancel',\n  FAIL = 'fail',\n  UNASSIGN = 'unassign',\n  BULK_ASSIGN = 'bulk-assign',\n  REASSIGN = 'reassign',\n  DISPATCH = 'dispatch',\n  BULK_DISPATCH = 'bulk-dispatch',\n  BULK_UPSERT = 'bulk-upsert',\n  UPSERT = 'upsert',\n  JOIN = 'join',\n  MOVE = 'move',\n  REOPTIMIZATION = 'reoptimization',\n}\n\nexport enum EntityType {\n  RIDE = 'Ride',\n  VEHICLE = 'Vehicle',\n  DRIVER = 'Driver',\n  PRICE_CALCULATION = 'PriceCalculation',\n}\n\nexport const enum ActionOrigin {\n  USER = 'user',\n  AUTOMATION = 'automation',\n}\n","export const AUDIT_LOG_CONTEXT_QUEUE = 'audit-log-context';\nexport const AUDIT_LOG_ROWS_QUEUE = 'audit-log-rows';\nexport const AUDIT_LOG_CONTEXT_KEY = 'auditLogContext';\nexport const AUTOMATION_ID_HEADER = 'x-af-automation-id';\n","import Logger, { type LoggerInstanceManager } from '@autofleet/logger';\n\nconst logger: LoggerInstanceManager = Logger(null);\nexport default logger;\n","import type RabbitMq from '@autofleet/rabbit';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';\nimport type {\n  CreateOptions, InstanceUpdateOptions, Model, Sequelize,\n} from 'sequelize';\nimport { isEqual } from 'lodash';\nimport {\n  type AuditLogPayload, type AuditLoggerOptions, type AuditLogContext, Action,\n} from './types';\nimport { AUDIT_LOG_CONTEXT_QUEUE, AUDIT_LOG_ROWS_QUEUE, AUDIT_LOG_CONTEXT_KEY } from './const';\nimport logger from './logger';\n\nconst CUSTOM_FIELDS_PROPERTY = 'customFields';\n\nconst getAuditContext = () => {\n  const currentTrace = getCurrentTrace();\n  const auditContext = currentTrace?.nonHeaderContext?.get(AUDIT_LOG_CONTEXT_KEY);\n  return auditContext as AuditLogContext;\n};\n\nconst ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT = {\n  [Action.BULK_CREATE]: Action.BULK_CREATE,\n  [Action.BULK_EDIT]: Action.BULK_EDIT,\n  [Action.BULK_ASSIGN]: Action.BULK_ASSIGN,\n  [Action.BULK_DISPATCH]: Action.BULK_DISPATCH,\n  [Action.BULK_UPSERT]: Action.BULK_UPSERT,\n};\n\nconst isEmpty = (field) => {\n  if ([null, undefined].includes(field)) {\n    return true;\n  }\n  if (Array.isArray(field)) {\n    return field.length === 0;\n  }\n  if (typeof field === 'object' && !(field instanceof Date)) {\n    return Object.keys(field).length === 0;\n  }\n  return false;\n};\n\nexport const isEntityIdRequired = (action: string): boolean => !ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT[action];\n\nconst filterOutEmptyFields = (fields: string[], instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));\n\nconst getChangedFieldsRows = (instance: Model, options: CreateOptions<any> | InstanceUpdateOptions<any>) => {\n  // When bulk updating in sequelize using the \"returning\" option, the instance.changed() stops working.\n  // It's a known issue with sequelize.\n  const changedFields: string[] = options.returning ? options.fields as string[] : instance.changed() as string[];\n  // Filter customFields - we'll handle them later\n  const filteredChangedFields = filterOutEmptyFields(changedFields.filter((field) => field !== CUSTOM_FIELDS_PROPERTY), instance);\n  return filteredChangedFields.map((property: string) => ({\n    property,\n    previousValue: instance.previous(property),\n    newValue: instance.get(property),\n  }));\n};\n\nconst getChangedCustomFieldsRows = (instance: Model) => {\n  const changed = instance.changed();\n  const customFieldsChanged = changed && changed.includes(CUSTOM_FIELDS_PROPERTY);\n  if (!customFieldsChanged) {\n    return [];\n  }\n\n  const customFields = instance.get(CUSTOM_FIELDS_PROPERTY);\n  const previousCustomFields = instance.previous(CUSTOM_FIELDS_PROPERTY);\n  const changedCustomFields = Object.keys(customFields).filter((field) => {\n    const newValue = customFields?.[field];\n    const oldValue = previousCustomFields?.[field];\n    return (!isEmpty(newValue) || !isEmpty(oldValue)) && !isEqual(newValue, oldValue);\n  });\n  return changedCustomFields.map((changedCustomField) => ({\n    property: `${CUSTOM_FIELDS_PROPERTY}.${changedCustomField}`,\n    previousValue: previousCustomFields?.[changedCustomField],\n    newValue: customFields?.[changedCustomField],\n  }));\n};\n\nclass AuditLogger {\n  private rabbit: RabbitMq;\n\n  private sequelize: Sequelize;\n\n  private logger: LoggerInstanceManager;\n\n  constructor(options: AuditLoggerOptions) {\n    this.rabbit = options.rabbit;\n    this.sequelize = options.sequelize;\n    this.logger = options.logger || logger;\n  }\n\n  public registerHooks(): void {\n    Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {\n      modelType.addHook('afterSave', async (instance, options) => {\n        try {\n          const auditContext = getAuditContext();\n          if (!auditContext) {\n            return;\n          }\n          if (auditContext?.entityType?.toLowerCase() === modelName?.toLowerCase() && isEntityIdRequired(auditContext.action)) {\n            auditContext.entityId = (instance as any).id;\n          }\n          const changedFieldsRows = getChangedFieldsRows(instance, options);\n          const changedCustomFieldsRows = getChangedCustomFieldsRows(instance);\n          const payload: AuditLogPayload = {\n            entityType: modelName,\n            entityId: (instance as any).id,\n            rows: [...changedFieldsRows, ...changedCustomFieldsRows],\n          };\n          this.sendAuditLogRows(payload);\n        } catch (error) {\n          this.logger.error('Failed to send audit log rows', error);\n        }\n      });\n    });\n  }\n\n  public async sendAuditLogContext(context: AuditLogContext): Promise<void> {\n    try {\n      await this.rabbit.sendToQueue(AUDIT_LOG_CONTEXT_QUEUE, context);\n    } catch (err) {\n      this.logger.error('Failed to send audit log context', err);\n    }\n  }\n\n  private async sendAuditLogRows(payload: AuditLogPayload): Promise<void> {\n    try {\n      await this.rabbit.sendToQueue(AUDIT_LOG_ROWS_QUEUE, payload);\n    } catch (err) {\n      this.logger.error('Failed to send audit log rows', err);\n    }\n  }\n}\n\nexport default AuditLogger;\n","import Network from '@autofleet/network';\nimport logger from './logger';\n\nconst auditMs = new Network({ serviceName: 'AUDIT_MS', timeout: 60_000, logger });\n\nconst getByEntityId = async (entityId: string): Promise<any> => {\n  const { data } = await auditMs.get(`api/v1/audit-logs/${entityId}`);\n  return data;\n};\n\nconst exportObj: { getByEntityId: typeof getByEntityId } = { getByEntityId };\n\nexport default exportObj;\n","import { handleError, ResourceNotFoundError, UnexpectedError } from '@autofleet/errors';\nimport auditMs from './audit-ms';\nimport { AuditLoggerOptions } from './types';\n\nexport default async ({\n  router,\n  logger,\n  entityScopedModelMap,\n}: AuditLoggerOptions): Promise<void> => {\n  if (!entityScopedModelMap || !router) {\n    return;\n  }\n  Object.entries(entityScopedModelMap).forEach(([entity, ScopedModel]) => {\n    router.get(`${entity}/:id/audit`, async (req, res) => {\n      try {\n        const { id } = req.params;\n        const entityData = await ScopedModel.findByPk(id);\n        if (!entityData) {\n          return handleError(new ResourceNotFoundError(), res, { logger, message: `Entity ${entity} with id ${id} not found` });\n        }\n        const auditData = auditMs.getByEntityId(id);\n        return res.json(auditData);\n      } catch (err) {\n        return handleError(new UnexpectedError(err as Error), res, { logger });\n      }\n    });\n  });\n};\n","import { getCurrentPayload as getCurrentTrace, getUser } from '@autofleet/zehut';\nimport type { Request, Response, NextFunction } from 'express';\nimport AuditLogger, { isEntityIdRequired } from './audit-logger';\nimport { ActionOrigin, type AuditLogContext, type AuditLoggerOptions } from './types';\nimport { AUDIT_LOG_CONTEXT_KEY, AUTOMATION_ID_HEADER } from './const';\nimport addAuditApi from './audit-api';\nimport logger from './logger';\n\nlet auditLogger: AuditLogger | undefined;\n\nexport const enableAuditing = (options: AuditLoggerOptions): void => {\n  if (process.env.DISABLE_AUDIT_LOGS === 'true') {\n    return;\n  }\n  auditLogger = new AuditLogger(options);\n  addAuditApi(options);\n  auditLogger.registerHooks();\n};\n\nexport const setAuditContext = (\n  entityType: string,\n  action: string,\n) => async (req: Request, res: Response, next: NextFunction): Promise<void> => {\n  try {\n    if (process.env.DISABLE_AUDIT_LOGS === 'true' || !auditLogger) {\n      return next();\n    }\n    const user = getUser();\n    const automationId = req.headers[AUTOMATION_ID_HEADER] as string | undefined;\n    const { performedBy, actionOrigin } = user?.id\n      ? { performedBy: user.id, actionOrigin: ActionOrigin.USER }\n      : { performedBy: automationId ?? null, actionOrigin: automationId ? ActionOrigin.AUTOMATION : null };\n    const auditLogContext: AuditLogContext = {\n      entityType,\n      action,\n      endpoint: req.url,\n      method: req.method,\n      performedBy,\n      actionOrigin,\n    };\n\n    const currentTrace = getCurrentTrace();\n    currentTrace.nonHeaderContext.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);\n\n    const sendAuditLogContextEvent = async () => {\n      res.off('finish', sendAuditLogContextEvent);\n      res.off('close', sendAuditLogContextEvent);\n      res.off('error', sendAuditLogContextEvent);\n      await auditLogger.sendAuditLogContext(auditLogContext);\n    };\n    if (!isEntityIdRequired(action)) { // if it's a bulk action, we don't want to wait for the response to add the entity id\n      await auditLogger.sendAuditLogContext(auditLogContext);\n    } else {\n      res.once('finish', sendAuditLogContextEvent);\n      res.once('close', sendAuditLogContextEvent);\n      res.once('error', sendAuditLogContextEvent);\n    }\n  } catch (err) {\n    logger.error('coudln\\'t set audit context', err);\n  }\n  return next();\n};\n\nexport const setRabbitAuditContext = (\n  entityType: string,\n  action: string,\n) => async (endpoint: string, { userId, automationId }: { userId:string; automationId:string; }): Promise<void> => {\n  if (process.env.DISABLE_AUDIT_LOGS === 'true' || !auditLogger) {\n    return;\n  }\n  const currentTrace = getCurrentTrace();\n  if (currentTrace?.context?.get) {\n    const { performedBy, actionOrigin } = userId\n      ? { performedBy: userId, actionOrigin: ActionOrigin.USER }\n      : { performedBy: automationId ?? null, actionOrigin: automationId ? ActionOrigin.AUTOMATION : null };\n    const auditLogContext: AuditLogContext = {\n      entityType,\n      action,\n      endpoint,\n      method: 'rabbit',\n      performedBy,\n      actionOrigin,\n    };\n    currentTrace.nonHeaderContext.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);\n    await auditLogger.sendAuditLogContext(auditLogContext);\n  }\n};\n\nexport * from './types';\nexport * from './const';\n\nexport default AuditLogger;\n"],"mappings":"sQAgEA,IA3BY,kBAAA,SAAA,EAAL,QACL,EAAA,OAAA,SACA,EAAA,YAAA,cACA,EAAA,UAAA,YACA,EAAA,OAAA,SACA,EAAA,OAAA,SACA,EAAA,OAAA,SACA,EAAA,KAAA,OACA,EAAA,SAAA,WACA,EAAA,YAAA,cACA,EAAA,SAAA,WACA,EAAA,SAAA,WACA,EAAA,cAAA,gBACA,EAAA,YAAA,cACA,EAAA,OAAA,SACA,EAAA,KAAA,OACA,EAAA,KAAA,OACA,EAAA,eAAA,kBACD,EAAA,CAAA,EAAA,CAEW,kBAAA,SAAA,EAAL,QACL,EAAA,KAAA,OACA,EAAA,QAAA,UACA,EAAA,OAAA,SACA,EAAA,kBAAA,oBACD,EAAA,CAAA,EAAA,CAEiB,kBAAA,SAAA,EAAX,QACL,EAAA,KAAA,OACA,EAAA,WAAA,cACD,EAAA,CAAA,EAAA,CEjED,MDFa,EAA0B,oBAC1B,EAAuB,iBACvB,EAAwB,kBACxB,EAAuB,qBCD9BA,EAAgC,EAAO,KAAK,CAClD,IAAA,EAAe,ECwDf,MA9CM,EAAyB,eAEzB,EAAkB,IAAM,CAE5B,IADM,EAAe,GAAiB,CAChC,EAAe,GAAc,kBAAkB,IAAI,EAAsB,CAC/E,OAAO,CACR,EAEK,EAAyC,EAC5C,EAAO,aAAc,EAAO,aAC5B,EAAO,WAAY,EAAO,WAC1B,EAAO,aAAc,EAAO,aAC5B,EAAO,eAAgB,EAAO,eAC9B,EAAO,aAAc,EAAO,WAC9B,EAEK,EAAU,AAAC,GACX,CAAC,SAAA,EAAgB,EAAC,SAAS,EAAM,EAC5B,EAEL,MAAM,QAAQ,EAAM,CACf,EAAM,SAAW,SAEf,GAAU,YAAc,aAAiB,MAC3C,OAAO,KAAK,EAAM,CAAC,SAAW,GAEhC,EAGI,EAAqB,AAACe,IAA6B,EAAuC,GAEjG,EAAuB,CAACb,EAAkB,IAAa,EAAO,OAAO,AAAC,IAAW,EAAQ,EAAS,IAAI,EAAM,CAAC,GAAK,EAAQ,EAAS,SAAS,EAAM,CAAC,CAAC,CAEpJ,EAAuB,CAACC,EAAiBC,IAA6D,CAK1G,IAFMC,EAA0B,EAAQ,UAAY,EAAQ,OAAqB,EAAS,SAAS,CAE7F,EAAwB,EAAqB,EAAc,OAAO,AAAC,GAAU,IAAU,EAAuB,CAAE,EAAS,CAC/H,MAAO,GAAsB,IAAI,AAACC,IAAsB,CACtD,WACA,cAAe,EAAS,SAAS,EAAS,CAC1C,SAAU,EAAS,IAAI,EAAS,AACjC,GAAE,AACJ,EAEK,EAA6B,AAACH,GAAoB,CAEtD,IADM,EAAU,EAAS,SAAS,CAC5B,EAAsB,GAAW,EAAQ,SAAS,EAAuB,CAC/E,IAAK,EACH,MAAO,CAAE,EAKX,IAFM,EAAe,EAAS,IAAI,EAAuB,CACnD,EAAuB,EAAS,SAAS,EAAuB,CAChE,EAAsB,OAAO,KAAK,EAAa,CAAC,OAAO,AAAC,GAAU,CAEtE,IADM,EAAW,IAAe,GAC1B,EAAW,IAAuB,GACxC,QAAS,EAAQ,EAAS,GAAK,EAAQ,EAAS,IAAM,EAAQ,EAAU,EAAS,AAClF,EAAC,CACF,MAAO,GAAoB,IAAI,AAAC,IAAwB,CACtD,UAAW,EAAE,EAAuB,GAAG,EAAmB,EAC1D,cAAe,IAAuB,GACtC,SAAU,IAAe,EAC1B,GAAE,AACJ,EA0DD,IAxDM,EAAN,KAAkB,CAOhB,YAAYU,EAA6B,CAGvC,AAFA,KAAK,OAAS,EAAQ,OACtB,KAAK,UAAY,EAAQ,UACzB,KAAK,OAAS,EAAQ,QAAU,CACjC,CAED,eAA6B,CAC3B,OAAO,QAAQ,KAAK,UAAU,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAW,EAAU,GAAK,CACxE,EAAU,QAAQ,YAAa,MAAO,EAAU,IAAY,CAC1D,GAAI,CACF,IAAM,EAAe,GAAiB,CACtC,IAAK,EACH,OAEF,AAAI,GAAc,YAAY,aAAa,GAAK,GAAW,aAAa,EAAI,EAAmB,EAAa,OAAO,GACjH,EAAa,SAAY,EAAiB,IAI5C,IAFM,EAAoB,EAAqB,EAAU,EAAQ,CAC3D,EAA0B,EAA2B,EAAS,CAC9DL,EAA2B,CAC/B,WAAY,EACZ,SAAW,EAAiB,GAC5B,KAAM,CAAC,GAAG,EAAmB,GAAG,CAAwB,CACzD,EACD,KAAK,iBAAiB,EAAQ,AAC/B,OAAQ,EAAO,CACd,KAAK,OAAO,MAAM,gCAAiC,EAAM,AAC1D,CACF,EAAC,AACH,EAAC,AACH,CAED,MAAa,oBAAoBC,EAAyC,CACxE,GAAI,CACF,KAAM,MAAK,OAAO,YAAY,EAAyB,EAAQ,AAChE,OAAQ,EAAK,CACZ,KAAK,OAAO,MAAM,mCAAoC,EAAI,AAC3D,CACF,CAED,MAAc,iBAAiBD,EAAyC,CACtE,GAAI,CACF,KAAM,MAAK,OAAO,YAAY,EAAsB,EAAQ,AAC7D,OAAQ,EAAK,CACZ,KAAK,OAAO,MAAM,gCAAiC,EAAI,AACxD,CACF,CACF,EAED,EAAe,EC9Hf,MAPM,EAAU,IAAI,EAAQ,CAAE,YAAa,WAAY,QAAS,IAAQ,OAAA,CAAQ,GAE1E,EAAgB,MAAOE,GAAmC,CAC9D,GAAM,CAAE,OAAM,CAAG,KAAM,GAAQ,KAAK,oBAAoB,EAAS,EAAE,CACnE,OAAO,CACR,EAEKC,EAAqD,CAAE,eAAe,ECN5E,IDQA,EAAe,ECRf,EAAe,MAAO,CACpB,SACA,OAAA,EACA,uBACmB,GAAoB,CACvC,CAAK,IAAyB,GAG9B,OAAO,QAAQ,EAAqB,CAAC,QAAQ,CAAC,CAAC,EAAQ,EAAY,GAAK,CACtE,EAAO,KAAK,EAAE,EAAO,YAAa,MAAO,EAAK,IAAQ,CACpD,GAAI,CAEF,GADM,CAAE,KAAI,CAAG,EAAI,OACb,EAAa,KAAM,GAAY,SAAS,EAAG,CACjD,IAAK,EACH,MAAO,GAAY,IAAI,EAAyB,EAAK,CAAE,OAAA,EAAQ,SAAU,SAAS,EAAO,WAAW,EAAG,WAAa,EAAC,CAEvH,IAAM,EAAY,EAAQ,cAAc,EAAG,CAC3C,MAAO,GAAI,KAAK,EAAU,AAC3B,OAAQ,EAAK,CACZ,MAAO,GAAY,IAAI,EAAgB,GAAe,EAAK,CAAE,OAAA,CAAQ,EAAC,AACvE,CACF,EAAC,AACH,EAAC,AACH,ECnBD,IAAIC,EAuDJ,MArDa,EAAiB,AAACC,GAAsC,CAC/D,QAAQ,IAAI,qBAAuB,SAGvC,EAAc,IAAI,EAAY,GAC9B,EAAY,EAAQ,CACpB,EAAY,eAAe,CAC5B,EAEY,EAAkB,CAC7BC,EACAC,IACG,MAAOC,EAAcC,EAAeC,IAAsC,CAC7E,GAAI,CACF,GAAI,QAAQ,IAAI,qBAAuB,SAAW,EAChD,MAAO,IAAM,CAgBf,IAdM,EAAO,GAAS,CAChB,EAAe,EAAI,QAAQ,GAC3B,CAAE,cAAa,eAAc,CAAG,GAAM,GACxC,CAAE,YAAa,EAAK,GAAI,aAAc,EAAa,IAAM,EACzD,CAAE,YAAa,GAAgB,KAAM,aAAc,EAAe,EAAa,WAAa,IAAM,EAChGC,EAAmC,CACvC,aACA,SACA,SAAU,EAAI,IACd,OAAQ,EAAI,OACZ,cACA,cACD,EAEK,EAAe,GAAiB,CACtC,EAAa,iBAAiB,IAAI,EAAuB,EAAgB,CAEzE,IAAM,EAA2B,SAAY,CAI3C,AAHA,EAAI,IAAI,SAAU,EAAyB,CAC3C,EAAI,IAAI,QAAS,EAAyB,CAC1C,EAAI,IAAI,QAAS,EAAyB,CAC1C,KAAM,GAAY,oBAAoB,EAAgB,AACvD,EACD,AAAK,EAAmB,EAAO,EAG7B,EAAI,KAAK,SAAU,EAAyB,CAC5C,EAAI,KAAK,QAAS,EAAyB,CAC3C,EAAI,KAAK,QAAS,EAAyB,EAJ3C,KAAM,GAAY,oBAAoB,EAAgB,AAMzD,OAAQ,EAAK,CACZ,EAAO,MAAM,6BAA+B,EAAI,AACjD,CACD,MAAO,IAAM,AACd,EAEY,EAAwB,CACnCL,EACAC,IACG,MAAOK,EAAkB,CAAE,SAAQ,eAAuD,GAAoB,CACjH,GAAI,QAAQ,IAAI,qBAAuB,SAAW,EAChD,OAEF,IAAM,EAAe,GAAiB,CACtC,GAAI,GAAc,SAAS,IAAK,CAI9B,GAHM,CAAE,cAAa,eAAc,CAAG,EAClC,CAAE,YAAa,EAAQ,aAAc,EAAa,IAAM,EACxD,CAAE,YAAa,GAAgB,KAAM,aAAc,EAAe,EAAa,WAAa,IAAM,EAChGD,EAAmC,CACvC,aACA,SACA,WACA,OAAQ,SACR,cACA,cACD,EAED,AADA,EAAa,iBAAiB,IAAI,EAAuB,EAAgB,CACzE,KAAM,GAAY,oBAAoB,EAAgB,AACvD,CACF,EAKD,IAAA,EAAe"}

package/package.json

@@ -1,42 +1,61 @@
 {
   "name": "@autofleet/shtinker",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "",
+  "type": "module",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.cjs.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
   "scripts": {
     "start": "ts-node src/index.ts",
-    "build": "rm -rf dist && tsc",
-    "linter": "./node_modules/.bin/eslint .",
-    "test": "jest --forceExit",
-    "coverage": "jest --coverage --forceExit && rm -rf ./coverage",
-    "dev": "nodemon"
+    "build": "tsdown",
+    "linter": "eslint .",
+    "test": "vitest",
+    "coverage": "vitest --coverage"
+  },
+  "engines": {
+    "node": ">=18"
   },
   "dependencies": {
-    "@autofleet/errors": "^1.2.2",
-    "@autofleet/logger": "^4.0.6",
-    "@autofleet/network": "^1.4.7",
-    "@autofleet/rabbit": "^4.0.0",
-    "lodash": "^4.17.21",
-    "sequelize-typescript": "^2.1.5"
+    "@autofleet/network": "^1.7.5",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@autofleet/zehut": "^3.1.2",
+    "@autofleet/zehut": "^4.0.1",
     "@types/express": "^4.17.17",
-    "@types/jest": "^27.0.9",
     "@types/node": "^18.11.19",
-    "@types/sequelize": "^4.28.14",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
+    "@vitest/coverage-v8": "^3.1.3",
     "eslint": "^7.13.0",
     "eslint-config-airbnb-typescript": "^12.0.0",
     "eslint-plugin-import": "^2.22.1",
-    "jest": "^27.0.5",
-    "ts-jest": "^27.0.3",
+    "sequelize": "^6.37.6",
+    "sequelize-typescript": "^2.1.6",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "tsdown": "^0.11.3",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.3"
   },
   "peerDependencies": {
-    "@autofleet/zehut": "^3.x"
+    "@autofleet/errors": "^3",
+    "@autofleet/logger": "^4.2.1",
+    "@autofleet/rabbit": ">=3.2.25",
+    "@autofleet/zehut": "^4"
   },
   "author": "Autofleet",
-  "license": "ISC"
+  "license": "Proprietary",
+  "files": [
+    "dist/"
+  ]
 }

package/readme.md

@@ -3,3 +3,12 @@
 ## Breaking Changes in V2
 - No code changes are required for services using this package.
 - Fixed a bug where the context entity ID was incorrectly set to the ID of the last entity saved to the database under the same context. Now, the entity ID will only change when the entity type of the context matches the model name during the save operation to the database.
+
+# V3 migration
+
+The breaking change in this version is the removal of `zehut` from dependencies and usage as a peer-dependency.
+The required version of zehut is now `^4.0.0`.
+
+This was moved to being a peer-dependency in order to ensure that the version of `zehut` used here is the same as used in the MS, and not risk the package using v4 while the service is using v3, which would cause `zehut` to have multiple traces, which will not all hold the correct data.
+
+Additionally, the minimum node version is now 18, due to the minimum version of node defined in `zehut`.

package/dist/audit-api.d.ts

@@ -1,6 +0,0 @@
-import { Router } from 'express';
-declare const _default: ({ router, entiyScopedModelMap, }: {
-    router: Router;
-    entiyScopedModelMap: Array<any>;
-}) => Promise<void>;
-export default _default;

package/dist/audit-api.js

@@ -1,36 +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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_1 = require("@autofleet/errors");
-const audit_ms_1 = __importDefault(require("./audit-ms"));
-exports.default = ({ router, entiyScopedModelMap, }) => __awaiter(void 0, void 0, void 0, function* () {
-    if (entiyScopedModelMap) {
-        Object.entries(entiyScopedModelMap).forEach(([entity, ScopedModel]) => {
-            router.get(`${entity}/:id/audit`, (req, res) => __awaiter(void 0, void 0, void 0, function* () {
-                try {
-                    const { id } = req.params;
-                    const entityData = yield ScopedModel.findByPk(id);
-                    if (!entityData) {
-                        return (0, errors_1.handleError)(new errors_1.ResourceNotFoundError(), res);
-                    }
-                    const auditData = audit_ms_1.default.getByEntityId(id);
-                    return res.json(auditData);
-                }
-                catch (err) {
-                    return (0, errors_1.handleError)(new errors_1.UnexpectedError(err), res);
-                }
-            }));
-        });
-    }
-});

package/dist/audit-logger.d.ts

@@ -1,12 +0,0 @@
-import { AuditLogPayload, AuditLoggerOptions, AuditLogContext } from './types';
-export declare const isEntityIdRequired: (action: string) => boolean;
-declare class AuditLogger {
-    private rabbit;
-    private sequelize;
-    private logger;
-    constructor(options: AuditLoggerOptions);
-    registerHooks(): void;
-    sendAuditLogContext(context: AuditLogContext): Promise<void>;
-    sendAuditLogRows(payload: AuditLogPayload): Promise<void>;
-}
-export default AuditLogger;

package/dist/audit-logger.js

@@ -1,133 +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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEntityIdRequired = void 0;
-const zehut_1 = require("@autofleet/zehut");
-const lodash_1 = require("lodash");
-const types_1 = require("./types");
-const const_1 = require("./const");
-const logger_1 = __importDefault(require("./logger"));
-const CUSTOM_FIELDS_PROPERTY = 'customFields';
-const getAuditContext = () => {
-    var _a;
-    const currentTrace = (0, zehut_1.getCurrentPayload)();
-    const auditContext = (_a = currentTrace === null || currentTrace === void 0 ? void 0 : currentTrace.context) === null || _a === void 0 ? void 0 : _a.get(const_1.AUDIT_LOG_CONTEXT_KEY);
-    return auditContext;
-};
-const ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT = {
-    [types_1.Action.BULK_CREATE]: types_1.Action.BULK_CREATE,
-    [types_1.Action.BULK_EDIT]: types_1.Action.BULK_EDIT,
-    [types_1.Action.BULK_ASSIGN]: types_1.Action.BULK_ASSIGN,
-    [types_1.Action.BULK_DISPATCH]: types_1.Action.BULK_DISPATCH,
-    [types_1.Action.BULK_UPSERT]: types_1.Action.BULK_UPSERT,
-};
-const isEmpty = (field) => {
-    if ([null, undefined].includes(field)) {
-        return true;
-    }
-    if (Array.isArray(field)) {
-        return field.length === 0;
-    }
-    if (typeof field === 'object' && !(field instanceof Date)) {
-        return Object.keys(field).length === 0;
-    }
-    return false;
-};
-const isEntityIdRequired = (action) => !ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT[action];
-exports.isEntityIdRequired = isEntityIdRequired;
-const filterOutEmptyFields = (fields, instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));
-const getChangedFieldsRows = (instance, options) => {
-    // When bulk updating in sequelize using the "returning" option, the instance.changed() stops working.
-    // It's a known issue with sequelize.
-    const changedFields = options.returning ? options.fields : instance.changed();
-    // Filter customFields - we'll handle them later
-    const filteredChangedFields = filterOutEmptyFields(changedFields.filter((field) => field !== CUSTOM_FIELDS_PROPERTY), instance);
-    return filteredChangedFields.map((property) => ({
-        property,
-        previousValue: instance.previous(property),
-        newValue: instance.get(property),
-    }));
-};
-const getChangedCustomFieldsRows = (instance) => {
-    const customFieldsChanged = instance.changed().includes(CUSTOM_FIELDS_PROPERTY);
-    if (!customFieldsChanged) {
-        return [];
-    }
-    const customFields = instance.get(CUSTOM_FIELDS_PROPERTY);
-    const previousCustomFields = instance.previous(CUSTOM_FIELDS_PROPERTY);
-    const changedCustomFields = Object.keys(customFields).filter((field) => {
-        const newValue = customFields === null || customFields === void 0 ? void 0 : customFields[field];
-        const oldValue = previousCustomFields === null || previousCustomFields === void 0 ? void 0 : previousCustomFields[field];
-        return (!isEmpty(newValue) || !isEmpty(oldValue)) && !(0, lodash_1.isEqual)(newValue, oldValue);
-    });
-    return changedCustomFields.map((changedCustomField) => ({
-        property: `customFields.${changedCustomField}`,
-        previousValue: previousCustomFields === null || previousCustomFields === void 0 ? void 0 : previousCustomFields[changedCustomField],
-        newValue: customFields === null || customFields === void 0 ? void 0 : customFields[changedCustomField],
-    }));
-};
-class AuditLogger {
-    constructor(options) {
-        this.rabbit = options.rabbit;
-        this.sequelize = options.sequelize;
-        this.logger = options.logger || logger_1.default;
-    }
-    registerHooks() {
-        Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {
-            modelType.addHook('afterSave', (instance, options) => __awaiter(this, void 0, void 0, function* () {
-                var _a;
-                try {
-                    const auditContext = getAuditContext();
-                    if (auditContext) {
-                        if (((_a = auditContext === null || auditContext === void 0 ? void 0 : auditContext.entityType) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === (modelName === null || modelName === void 0 ? void 0 : modelName.toLowerCase()) && (0, exports.isEntityIdRequired)(auditContext.action)) {
-                            auditContext.entityId = instance.id;
-                        }
-                        const changedFieldsRows = getChangedFieldsRows(instance, options);
-                        const changedCustomFieldsRows = getChangedCustomFieldsRows(instance);
-                        const payload = {
-                            entityType: modelName,
-                            entityId: instance.id,
-                            rows: [...changedFieldsRows, ...changedCustomFieldsRows],
-                        };
-                        this.sendAuditLogRows(payload);
-                    }
-                }
-                catch (error) {
-                    this.logger.error('Failed to send audit log rows', error);
-                }
-            }));
-        });
-    }
-    sendAuditLogContext(context) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.rabbit.sendToQueue(const_1.AUDIT_LOG_CONTEXT_QUEUE, context);
-            }
-            catch (err) {
-                this.logger.error('Failed to send audit log context', err);
-            }
-        });
-    }
-    sendAuditLogRows(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.rabbit.sendToQueue(const_1.AUDIT_LOG_ROWS_QUEUE, payload);
-            }
-            catch (err) {
-                this.logger.error('Failed to send audit log rows', err);
-            }
-        });
-    }
-}
-exports.default = AuditLogger;

package/dist/audit-ms.d.ts

@@ -1,4 +0,0 @@
-declare const _default: {
-    getByEntityId: (entityId: string) => any;
-};
-export default _default;

package/dist/audit-ms.js

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const network_1 = __importDefault(require("@autofleet/network"));
-const auditMs = new network_1.default({ serviceName: 'AUDIT_MS', timeout: 1000 * 60 });
-const getByEntityId = (entityId) => {
-    const { data } = auditMs.get(`api/v1/audit-logs/${entityId}`);
-    return data;
-};
-exports.default = {
-    getByEntityId,
-};

package/dist/const.d.ts

@@ -1,5 +0,0 @@
-export declare const AUDIT_LOG_CONTEXT_QUEUE = "audit-log-context";
-export declare const AUDIT_LOG_ROWS_QUEUE = "audit-log-rows";
-export declare const AUDIT_LOG_CONTEXT_KEY = "auditLogContext";
-export declare const USER_CONTEXT_KEY = "userObject";
-export declare const AUTOMATION_ID_HEADER = "x-af-automation-id";

package/dist/const.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AUTOMATION_ID_HEADER = exports.USER_CONTEXT_KEY = exports.AUDIT_LOG_CONTEXT_KEY = exports.AUDIT_LOG_ROWS_QUEUE = exports.AUDIT_LOG_CONTEXT_QUEUE = void 0;
-exports.AUDIT_LOG_CONTEXT_QUEUE = 'audit-log-context';
-exports.AUDIT_LOG_ROWS_QUEUE = 'audit-log-rows';
-exports.AUDIT_LOG_CONTEXT_KEY = 'auditLogContext';
-exports.USER_CONTEXT_KEY = 'userObject';
-exports.AUTOMATION_ID_HEADER = 'x-af-automation-id';

package/dist/logger.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("@autofleet/logger").LoggerInstanceManager;
-export default _default;

package/dist/logger.js

@@ -1,7 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = __importDefault(require("@autofleet/logger"));
-exports.default = (0, logger_1.default)(null);

package/dist/types.d.ts

@@ -1,55 +0,0 @@
-import { Sequelize } from 'sequelize-typescript';
-import RabbitMq from '@autofleet/rabbit';
-export type AuditLoggerOptions = {
-    rabbit: RabbitMq;
-    sequelize: Sequelize;
-    logger: any;
-};
-export interface AuditLogContext {
-    entityType: string;
-    entityId?: string;
-    action: string;
-    performedBy: string;
-    endpoint: string;
-    method: string;
-    actionOrigin?: string;
-}
-export interface AuditLogRow {
-    property: string;
-    previousValue: any;
-    newValue: any;
-}
-export interface AuditLogPayload {
-    entityType: string;
-    entityId: string;
-    rows: AuditLogRow[];
-}
-export declare enum Action {
-    CREATE = "create",
-    BULK_CREATE = "bulk-create",
-    BULK_EDIT = "bulk-edit",
-    DELETE = "delete",
-    UPDATE = "update",
-    CANCEL = "cancel",
-    FAIL = "fail",
-    UNASSIGN = "unassign",
-    BULK_ASSIGN = "bulk-assign",
-    REASSIGN = "reassign",
-    DISPATCH = "dispatch",
-    BULK_DISPATCH = "bulk-dispatch",
-    BULK_UPSERT = "bulk-upsert",
-    UPSERT = "upsert",
-    JOIN = "join",
-    MOVE = "move",
-    REOPTIMIZATION = "reoptimization"
-}
-export declare enum EntityType {
-    RIDE = "Ride",
-    VEHICLE = "Vehicle",
-    DRIVER = "Driver",
-    PRICE_CALCULATION = "PriceCalculation"
-}
-export declare const enum ActionOrigin {
-    USER = "user",
-    AUTOMATION = "automation"
-}

package/dist/types.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityType = exports.Action = void 0;
-var Action;
-(function (Action) {
-    Action["CREATE"] = "create";
-    Action["BULK_CREATE"] = "bulk-create";
-    Action["BULK_EDIT"] = "bulk-edit";
-    Action["DELETE"] = "delete";
-    Action["UPDATE"] = "update";
-    Action["CANCEL"] = "cancel";
-    Action["FAIL"] = "fail";
-    Action["UNASSIGN"] = "unassign";
-    Action["BULK_ASSIGN"] = "bulk-assign";
-    Action["REASSIGN"] = "reassign";
-    Action["DISPATCH"] = "dispatch";
-    Action["BULK_DISPATCH"] = "bulk-dispatch";
-    Action["BULK_UPSERT"] = "bulk-upsert";
-    Action["UPSERT"] = "upsert";
-    Action["JOIN"] = "join";
-    Action["MOVE"] = "move";
-    Action["REOPTIMIZATION"] = "reoptimization";
-})(Action = exports.Action || (exports.Action = {}));
-var EntityType;
-(function (EntityType) {
-    EntityType["RIDE"] = "Ride";
-    EntityType["VEHICLE"] = "Vehicle";
-    EntityType["DRIVER"] = "Driver";
-    EntityType["PRICE_CALCULATION"] = "PriceCalculation";
-})(EntityType = exports.EntityType || (exports.EntityType = {}));

package/src/audit-api.ts

@@ -1,30 +0,0 @@
-import { Router } from 'express';
-import { handleError, ResourceNotFoundError, UnexpectedError } from '@autofleet/errors';
-
-import auditMs from './audit-ms';
-
-export default async ({
-  router,
-  entiyScopedModelMap,
-} : {
-  router: Router,
-  entiyScopedModelMap: Array<any>,
-}): Promise<void> => {
-  if (entiyScopedModelMap) {
-    Object.entries(entiyScopedModelMap).forEach(([entity, ScopedModel]) => {
-      router.get(`${entity}/:id/audit`, async (req, res) => {
-        try {
-          const { id } = req.params;
-          const entityData = await ScopedModel.findByPk(id);
-          if (!entityData) {
-            return handleError(new ResourceNotFoundError(), res);
-          }
-          const auditData = auditMs.getByEntityId(id);
-          return res.json(auditData);
-        } catch (err) {
-          return handleError(new UnexpectedError(err as Error), res);
-        }
-      });
-    });
-  }
-};

package/src/audit-logger.ts

@@ -1,131 +0,0 @@
-import { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';
-import { Sequelize } from 'sequelize';
-import { isEqual } from 'lodash';
-import {
-  AuditLogPayload, AuditLoggerOptions, AuditLogContext, Action,
-} from './types';
-import { AUDIT_LOG_CONTEXT_QUEUE, AUDIT_LOG_ROWS_QUEUE, AUDIT_LOG_CONTEXT_KEY } from './const';
-import logger from './logger';
-
-const CUSTOM_FIELDS_PROPERTY = 'customFields';
-
-const getAuditContext = () => {
-  const currentTrace = getCurrentTrace();
-  const auditContext = currentTrace?.context?.get(AUDIT_LOG_CONTEXT_KEY);
-  return auditContext;
-};
-
-const ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT = {
-  [Action.BULK_CREATE]: Action.BULK_CREATE,
-  [Action.BULK_EDIT]: Action.BULK_EDIT,
-  [Action.BULK_ASSIGN]: Action.BULK_ASSIGN,
-  [Action.BULK_DISPATCH]: Action.BULK_DISPATCH,
-  [Action.BULK_UPSERT]: Action.BULK_UPSERT,
-};
-
-const isEmpty = (field) => {
-  if ([null, undefined].includes(field)) {
-    return true;
-  }
-  if (Array.isArray(field)) {
-    return field.length === 0;
-  }
-  if (typeof field === 'object' && !(field instanceof Date)) {
-    return Object.keys(field).length === 0;
-  }
-  return false;
-};
-
-export const isEntityIdRequired = (action: string): boolean => !ACTIONS_TO_OMIT_ENTITY_ID_FROM_CONTEXT[action];
-
-const filterOutEmptyFields = (fields: string[], instance) => fields.filter((field) => !isEmpty(instance.get(field)) || !isEmpty(instance.previous(field)));
-
-const getChangedFieldsRows = (instance, options) => {
-  // When bulk updating in sequelize using the "returning" option, the instance.changed() stops working.
-  // It's a known issue with sequelize.
-  const changedFields: string[] = options.returning ? options.fields : instance.changed();
-  // Filter customFields - we'll handle them later
-  const filteredChangedFields = filterOutEmptyFields(changedFields.filter((field) => field !== CUSTOM_FIELDS_PROPERTY), instance);
-  return filteredChangedFields.map((property: string) => ({
-    property,
-    previousValue: instance.previous(property),
-    newValue: instance.get(property),
-  }));
-};
-
-const getChangedCustomFieldsRows = (instance) => {
-  const customFieldsChanged = instance.changed().includes(CUSTOM_FIELDS_PROPERTY);
-  if (!customFieldsChanged) {
-    return [];
-  }
-
-  const customFields = instance.get(CUSTOM_FIELDS_PROPERTY);
-  const previousCustomFields = instance.previous(CUSTOM_FIELDS_PROPERTY);
-  const changedCustomFields = Object.keys(customFields).filter((field) => {
-    const newValue = customFields?.[field];
-    const oldValue = previousCustomFields?.[field];
-    return (!isEmpty(newValue) || !isEmpty(oldValue)) && !isEqual(newValue, oldValue);
-  });
-  return changedCustomFields.map((changedCustomField) => ({
-    property: `customFields.${changedCustomField}`,
-    previousValue: previousCustomFields?.[changedCustomField],
-    newValue: customFields?.[changedCustomField],
-  }));
-};
-
-class AuditLogger {
-  private rabbit;
-
-  private sequelize: Sequelize;
-
-  private logger;
-
-  constructor(options: AuditLoggerOptions) {
-    this.rabbit = options.rabbit;
-    this.sequelize = options.sequelize;
-    this.logger = options.logger || logger;
-  }
-
-  registerHooks(): void {
-    Object.entries(this.sequelize.models).forEach(([modelName, modelType]) => {
-      modelType.addHook('afterSave', async (instance: any, options: any) => {
-        try {
-          const auditContext = getAuditContext();
-          if (auditContext) {
-            if (auditContext?.entityType?.toLowerCase() === modelName?.toLowerCase() && isEntityIdRequired(auditContext.action)) {
-              auditContext.entityId = instance.id;
-            }
-            const changedFieldsRows = getChangedFieldsRows(instance, options);
-            const changedCustomFieldsRows = getChangedCustomFieldsRows(instance);
-            const payload: AuditLogPayload = {
-              entityType: modelName,
-              entityId: instance.id,
-              rows: [...changedFieldsRows, ...changedCustomFieldsRows],
-            };
-            this.sendAuditLogRows(payload);
-          }
-        } catch (error) {
-          this.logger.error('Failed to send audit log rows', error);
-        }
-      });
-    });
-  }
-
-  async sendAuditLogContext(context: AuditLogContext): Promise<void> {
-    try {
-      await this.rabbit.sendToQueue(AUDIT_LOG_CONTEXT_QUEUE, context);
-    } catch (err) {
-      this.logger.error('Failed to send audit log context', err);
-    }
-  }
-
-  async sendAuditLogRows(payload: AuditLogPayload): Promise<void> {
-    try {
-      await this.rabbit.sendToQueue(AUDIT_LOG_ROWS_QUEUE, payload);
-    } catch (err) {
-      this.logger.error('Failed to send audit log rows', err);
-    }
-  }
-}
-
-export default AuditLogger;

package/src/audit-ms.ts

@@ -1,12 +0,0 @@
-import Network from '@autofleet/network';
-
-const auditMs = new Network({ serviceName: 'AUDIT_MS', timeout: 1000 * 60 });
-
-const getByEntityId = (entityId: string): any => {
-  const { data } = auditMs.get(`api/v1/audit-logs/${entityId}`);
-  return data;
-};
-
-export default {
-  getByEntityId,
-};

package/src/const.ts

@@ -1,5 +0,0 @@
-export const AUDIT_LOG_CONTEXT_QUEUE = 'audit-log-context';
-export const AUDIT_LOG_ROWS_QUEUE = 'audit-log-rows';
-export const AUDIT_LOG_CONTEXT_KEY = 'auditLogContext';
-export const USER_CONTEXT_KEY = 'userObject';
-export const AUTOMATION_ID_HEADER = 'x-af-automation-id';

package/src/index.ts

@@ -1,90 +0,0 @@
-import { getCurrentPayload as getCurrentTrace } from '@autofleet/zehut';
-import type { Request, Response, NextFunction } from 'express';
-import AuditLogger, { isEntityIdRequired } from './audit-logger';
-import { ActionOrigin, AuditLogContext, AuditLoggerOptions } from './types';
-import { AUDIT_LOG_CONTEXT_KEY, AUTOMATION_ID_HEADER, USER_CONTEXT_KEY } from './const';
-import addAuditApi from './audit-api';
-import logger from './logger';
-
-let auditLogger: AuditLogger;
-
-export const enableAuditing = (options: AuditLoggerOptions) => {
-  if (process.env.DISABLE_AUDIT_LOGS !== 'true') {
-    auditLogger = new AuditLogger(options);
-    addAuditApi(options as any);
-    auditLogger.registerHooks();
-  }
-};
-
-export const setAuditContext = (
-  entityType: string,
-  action: string,
-) => async (req: Request, res: Response, next: NextFunction): Promise<any> => {
-  try {
-    const currentTrace = getCurrentTrace();
-    if (process.env.DISABLE_AUDIT_LOGS === 'true' || !currentTrace?.context?.get) {
-      return next();
-    }
-    const user = currentTrace.context.get(USER_CONTEXT_KEY);
-    const { performedBy, actionOrigin } = user?.id
-      ? { performedBy: user.id, actionOrigin: ActionOrigin.USER }
-      : { performedBy: req.headers[AUTOMATION_ID_HEADER] ?? null, actionOrigin: req.headers[AUTOMATION_ID_HEADER] ? ActionOrigin.AUTOMATION : null };
-    const auditLogContext: AuditLogContext = {
-      entityType,
-      action,
-      endpoint: req.url,
-      method: req.method,
-      performedBy,
-      actionOrigin,
-    };
-
-    currentTrace.context.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);
-
-    const sendAuditLogContextEvent = async () => {
-      res.off('finish', sendAuditLogContextEvent);
-      res.off('close', sendAuditLogContextEvent);
-      res.off('error', sendAuditLogContextEvent);
-      await auditLogger.sendAuditLogContext(auditLogContext);
-    };
-    if (!isEntityIdRequired(action)) { // if it's a bulk action, we don't want to wait for the response to add the entity id
-      await auditLogger.sendAuditLogContext(auditLogContext);
-    } else {
-      res.once('finish', sendAuditLogContextEvent);
-      res.once('close', sendAuditLogContextEvent);
-      res.once('error', sendAuditLogContextEvent);
-    }
-  } catch (err) {
-    logger.error('coudln\'t set audit context', err);
-  }
-  return next();
-};
-
-export const setRabbitAuditContext = (
-  entityType: string,
-  action: string,
-) => async (endpoint: string, { userId, automationId }:{ userId:string; automationId:string; }): Promise<any> => {
-  if (process.env.DISABLE_AUDIT_LOGS === 'true') {
-    return;
-  }
-  const currentTrace = getCurrentTrace();
-  if (currentTrace?.context?.get) {
-    const { performedBy, actionOrigin } = userId
-      ? { performedBy: userId, actionOrigin: ActionOrigin.USER }
-      : { performedBy: automationId ?? null, actionOrigin: automationId ? ActionOrigin.AUTOMATION : null };
-    const auditLogContext: AuditLogContext = {
-      entityType,
-      action,
-      endpoint,
-      method: 'rabbit',
-      performedBy,
-      actionOrigin,
-    };
-    currentTrace.context.set(AUDIT_LOG_CONTEXT_KEY, auditLogContext);
-    await auditLogger.sendAuditLogContext(auditLogContext);
-  }
-};
-
-export * from './types';
-export * from './const';
-
-export default AuditLogger;

package/src/logger.ts

@@ -1,3 +0,0 @@
-import Logger from '@autofleet/logger';
-
-export default Logger(null);

package/src/types.ts

@@ -1,63 +0,0 @@
-/* eslint-disable no-shadow */
-import { Sequelize } from 'sequelize-typescript';
-import RabbitMq from '@autofleet/rabbit';
-
-export type AuditLoggerOptions = {
-  rabbit: RabbitMq;
-  sequelize: Sequelize;
-  logger: any;
-};
-
-export interface AuditLogContext {
-  entityType: string;
-  entityId?: string;
-  action: string;
-  performedBy: string;
-  endpoint: string;
-  method: string;
-  actionOrigin?: string;
-}
-
-export interface AuditLogRow {
-  property: string;
-  previousValue: any;
-  newValue: any;
-}
-
-export interface AuditLogPayload {
-  entityType: string;
-  entityId: string;
-  rows: AuditLogRow[];
-}
-
-export enum Action {
-  CREATE = 'create',
-  BULK_CREATE = 'bulk-create',
-  BULK_EDIT = 'bulk-edit',
-  DELETE = 'delete',
-  UPDATE = 'update',
-  CANCEL = 'cancel',
-  FAIL = 'fail',
-  UNASSIGN = 'unassign',
-  BULK_ASSIGN = 'bulk-assign',
-  REASSIGN = 'reassign',
-  DISPATCH = 'dispatch',
-  BULK_DISPATCH = 'bulk-dispatch',
-  BULK_UPSERT = 'bulk-upsert',
-  UPSERT = 'upsert',
-  JOIN = 'join',
-  MOVE = 'move',
-  REOPTIMIZATION = 'reoptimization',
-}
-
-export enum EntityType {
-  RIDE = 'Ride',
-  VEHICLE = 'Vehicle',
-  DRIVER = 'Driver',
-  PRICE_CALCULATION = 'PriceCalculation',
-}
-
-export const enum ActionOrigin {
-  USER = 'user',
-  AUTOMATION = 'automation',
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "skipLibCheck": true,
-  },
-  "exclude": ["node_modules", "**/*.test.ts", "dist"]
-}