@autofleet/sadot 0.11.0 → 0.12.0

package/dist/api/index.d.ts

@@ -1,2 +1,3 @@
-declare const router: any;
+/// <reference types="express" />
+declare const router: import("express").Router;
 export default router;

package/dist/api/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // export the api object
 const node_common_1 = require("@autofleet/node-common");
 const v1_1 = __importDefault(require("./v1"));
-const router = (0, node_common_1.Router)({ mergeParams: true });
+const logger_1 = __importDefault(require("../utils/logger"));
+const router = (0, node_common_1.Router)({ logger: logger_1.default });
 router.use('/v1', v1_1.default);
 exports.default = router;

package/dist/api/v1/definition/index.d.ts

@@ -1,2 +1,3 @@
-declare const router: any;
+/// <reference types="express" />
+declare const router: import("express").Router;
 export default router;

package/dist/api/v1/definition/index.js

@@ -32,7 +32,7 @@ const errors_2 = __importDefault(require("../errors"));
 const DefinitionRepo = __importStar(require("../../../repository/definition"));
 const validations_1 = require("./validations");
 const logger_1 = __importDefault(require("../../../utils/logger"));
-const router = (0, node_common_1.Router)({ mergeParams: true });
+const router = (0, node_common_1.Router)({ logger: logger_1.default });
 const ENTITY = 'CustomFieldDefinition';
 const toPascalCase = (str) => str.replace(/(^\w|-\w)/g, (subStr) => subStr.replace(/-/, '').toUpperCase());
 /**

package/dist/api/v1/errors.d.ts

@@ -1,4 +1,4 @@
 import type { Response } from 'express';
 import { type LogPayload } from '@autofleet/errors';
-declare const _default: (err: any, res: Response, additionalData?: LogPayload) => Promise<any>;
+declare const _default: (err: any, res: Response, additionalData?: LogPayload) => void;
 export default _default;

package/dist/api/v1/index.d.ts

@@ -1,2 +1,3 @@
-declare const router: any;
+/// <reference types="express" />
+declare const router: import("express").Router;
 export default router;

package/dist/api/v1/index.js

@@ -4,7 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_common_1 = require("@autofleet/node-common");
+const logger_1 = __importDefault(require("../../utils/logger"));
 const definition_1 = __importDefault(require("./definition"));
-const router = (0, node_common_1.Router)({ mergeParams: true });
+const router = (0, node_common_1.Router)({ logger: logger_1.default });
 router.use('/custom-field-definitions/:modelName', definition_1.default);
 exports.default = router;

package/dist/events/index.js

@@ -44,7 +44,7 @@ const sendDimEvent = (instance) => {
     catch (err) {
         logger_1.default.error('Failed to convert booleans in dim event payload', err);
     }
-    events.sendObject(mapping.tableName, mapping.eventVersion, objectToSend);
+    events.sendObject(mapping.tableName, mapping.eventVersion, objectToSend).catch(() => null);
 };
 exports.sendDimEvent = sendDimEvent;
 exports.default = events;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import type { Application } from 'express';
 import type { Sequelize } from 'sequelize-typescript';
-import type { CustomFieldOptions, ModelFetcher } from './types';
+import type { CustomFieldOptions, ModelFetcher, Models } from './types';
 export * from './utils/validations/schema/custom-fields';
 export * from './utils/constants';
 export * from './utils/helpers';
@@ -10,4 +10,4 @@ export * from './utils/helpers';
  */
 declare const useCustomFields: (app: Application | null, getModel: ModelFetcher, options: CustomFieldOptions) => Promise<Sequelize>;
 export default useCustomFields;
-export declare const disableCustomFields: (models: any, getModel: any) => void;
+export declare const disableCustomFields: (models: Models[], getModel: ModelFetcher) => void;

package/dist/index.js

@@ -10,6 +10,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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);
 };
@@ -21,7 +33,7 @@ exports.disableCustomFields = void 0;
 const models_1 = require("./models");
 const api_1 = __importDefault(require("./api"));
 const db_1 = __importDefault(require("./utils/db"));
-const logger_1 = __importDefault(require("./utils/logger"));
+const logger_1 = __importStar(require("./utils/logger"));
 const init_1 = require("./utils/init");
 __exportStar(require("./utils/validations/schema/custom-fields"), exports);
 __exportStar(require("./utils/constants"), exports);
@@ -31,6 +43,7 @@ __exportStar(require("./utils/helpers"), exports);
  * @see {@link 'custom-fields/config'} for configurations
  */
 const useCustomFields = async (app, getModel, options) => {
+    (0, logger_1.tryAddingTraceIdMiddleware)().catch(() => null);
     const { models, useCustomFieldsEntries } = options;
     if (app) {
         app.use('/api', api_1.default);

package/dist/scopes/filter.d.ts

@@ -12,7 +12,7 @@ type customFieldsFilterScopeParams = {
  * @returns A function that takes conditions and returns the Sequelize options object.
  */
 export declare const customFieldsFilterScope: (name: string, options?: Pick<CustomFieldOptions, 'useCustomFieldsEntries'>) => ({ replacementsMap: replacements, scopeValue: conditions }: customFieldsFilterScopeParams) => CustomFieldFilterOptions;
-export declare const scopeName = "filterByCustomFields";
+export declare const scopeName: "filterByCustomFields";
 export declare const customFieldsSortScope: (name: string, options?: Pick<CustomFieldOptions, 'useCustomFieldsEntries'>) => ({ replacementsMap, scopeValue: sort }: {
     replacementsMap: any;
     scopeValue: any;

package/dist/tests/api/test-api.js

@@ -5,10 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const express_1 = __importDefault(require("express"));
 const node_common_1 = require("@autofleet/node-common");
+const logger_1 = __importDefault(require("../../utils/logger"));
 const models_1 = require("../../models");
 const app = (0, express_1.default)();
 app.use(express_1.default.json());
-const api = (0, node_common_1.Router)();
+const api = (0, node_common_1.Router)({ logger: logger_1.default });
 api.get('/v1/test-models', async (req, res) => {
     const testModels = await models_1.TestModel.findAll();
     return res.json(testModels);

package/dist/tests/helpers/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getReplacementMapWithScopeValue = exports.getModel = exports.cleanup = void 0;
-const formatter_1 = require("@autofleet/sheilta/lib/formatter");
+const sheilta_1 = require("@autofleet/sheilta");
 const models_1 = require("../../models");
 // eslint-disable-next-line import/prefer-default-export
 const cleanup = async (options) => {
@@ -23,7 +23,7 @@ const getModel = (name) => {
 };
 exports.getModel = getModel;
 const getReplacementMapWithScopeValue = (conditions) => ({
-    replacementsMap: (0, formatter_1.generateFilterReplacements)(Object.fromEntries(Object.entries(conditions).map(([key, value]) => [`customFields.${key}`, value]))),
+    replacementsMap: (0, sheilta_1.generateFilterReplacements)(Object.fromEntries(Object.entries(conditions).map(([key, value]) => [`customFields.${key}`, value]))),
     scopeValue: conditions,
 });
 exports.getReplacementMapWithScopeValue = getReplacementMapWithScopeValue;

package/dist/tests/mocks/events.mock.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mockDimCustomFieldEntriesEvent = exports.mockDimCustomFieldValueEvent = exports.mockDimCustomFieldDefinitionEvent = exports.mockEvent = void 0;
 const mockEvent = (events, eventName, numberOfEvents) => {
-    events.sendObject = jest.fn();
+    events.sendObject = jest.fn().mockResolvedValue(true);
     return [
         events.sendObject,
         () => {

package/dist/utils/constants/index.d.ts

@@ -1,4 +1,4 @@
-declare const CUSTOM_FIELDS_FILTER_SCOPE: string;
+declare const CUSTOM_FIELDS_FILTER_SCOPE: "filterByCustomFields";
 export declare const supportedEntities: string[];
 /**
  * Supported custom field types

package/dist/utils/logger/index.d.ts

@@ -1,2 +1,3 @@
 declare const logger: import("@autofleet/logger").LoggerInstanceManager;
+export declare function tryAddingTraceIdMiddleware(): Promise<void>;
 export default logger;

package/dist/utils/logger/index.js

@@ -1,8 +1,42 @@
 "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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.tryAddingTraceIdMiddleware = void 0;
 const logger_1 = __importDefault(require("@autofleet/logger"));
 const logger = (0, logger_1.default)();
+async function tryAddingTraceIdMiddleware() {
+    try {
+        const { outbreak } = await Promise.resolve().then(() => __importStar(require('@autofleet/zehut')));
+        logger.addContextMiddleware(() => ({ traceId: outbreak.getCurrentContext().context?.get('x-trace-id') }));
+    }
+    catch (err) {
+        logger.error('Failed to add traceId middleware', { err });
+    }
+}
+exports.tryAddingTraceIdMiddleware = tryAddingTraceIdMiddleware;
 exports.default = logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -27,12 +27,8 @@
     }
   },
   "dependencies": {
-    "@autofleet/common-types": "^1.7.58",
-    "@autofleet/errors": "^1.2.3",
-    "@autofleet/events": "^2.0.0",
-    "@autofleet/logger": "^4.1.0",
-    "@autofleet/node-common": "^3.0.0",
-    "express": "^4.18.2",
+    "@autofleet/common-types": "^4.4.0",
+    "@autofleet/events": "^4.0.0",
     "joi": "^17.7.0",
     "pg": "^8.10.0",
     "reflect-metadata": "^0.1.13",
@@ -40,6 +36,10 @@
     "sequelize-typescript": "^2.1.5"
   },
   "devDependencies": {
+    "@autofleet/errors": "^3.0.1",
+    "@autofleet/logger": "^4.2.1",
+    "@autofleet/node-common": "^4.0.2",
+    "@autofleet/zehut": "^3.2.0",
     "@types/express": "^4.17.17",
     "@types/jest": "^29.5.13",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
@@ -47,14 +47,25 @@
     "eslint": "^8.57.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.22.1",
+    "express": "^4.21.2",
     "jest": "^29.7.0",
     "npm-watch": "^0.11.0",
+    "supertest": "^7.0.0",
     "ts-jest": "^29.1.2",
     "ts-node": "^8.6.2",
     "typescript": "^5.3.3"
   },
   "peerDependencies": {
-    "@autofleet/sheilta": ">=1.4.0"
+    "@autofleet/errors": "^3",
+    "@autofleet/logger": "^4",
+    "@autofleet/node-common": "^4",
+    "@autofleet/sheilta": "^2",
+    "@autofleet/zehut": "^3"
+  },
+  "peerDependenciesMeta": {
+    "@autofleet/zehut": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">=16.0.0"

package/src/api/index.ts

@@ -1,8 +1,9 @@
 // export the api object
 import { Router } from '@autofleet/node-common';
 import v1 from './v1';
+import logger from '../utils/logger';
 
-const router = Router({ mergeParams: true });
+const router = Router({ logger });
 
 router.use('/v1', v1);
 

package/src/api/v1/definition/index.ts

@@ -7,7 +7,7 @@ import { validateCustomFieldDefinitionCreation, validateCustomFieldDefinitionUpd
 import logger from '../../../utils/logger';
 import type { CustomFieldDefinition } from '../../../models';
 
-const router = Router({ mergeParams: true });
+const router = Router({ logger });
 const ENTITY = 'CustomFieldDefinition';
 
 const toPascalCase = (str: string): string => str.replace(/(^\w|-\w)/g, (subStr) => subStr.replace(/-/, '').toUpperCase());

package/src/api/v1/index.ts

@@ -1,8 +1,8 @@
 import { Router } from '@autofleet/node-common';
-
+import logger from '../../utils/logger';
 import definitionRouter from './definition';
 
-const router = Router({ mergeParams: true });
+const router = Router({ logger });
 
 router.use('/custom-field-definitions/:modelName', definitionRouter);
 

package/src/events/index.ts

@@ -47,7 +47,7 @@ export const sendDimEvent = (instance): void => {
     mapping.tableName,
     mapping.eventVersion,
     objectToSend,
-  );
+  ).catch(() => null);
 };
 
 export default events;

package/src/index.ts

@@ -5,8 +5,8 @@ import {
 } from './models';
 import api from './api';
 import initDB from './utils/db';
-import logger from './utils/logger';
-import type { CustomFieldOptions, ModelFetcher } from './types';
+import logger, { tryAddingTraceIdMiddleware } from './utils/logger';
+import type { CustomFieldOptions, ModelFetcher, Models } from './types';
 import {
   addHooks, addScopes, applyCustomAssociation, removeHooks,
 } from './utils/init';
@@ -26,6 +26,7 @@ const useCustomFields = async (
   getModel: ModelFetcher,
   options: CustomFieldOptions,
 ): Promise<Sequelize> => {
+  tryAddingTraceIdMiddleware().catch(() => null);
   const { models, useCustomFieldsEntries } = options;
   if (app) {
     app.use('/api', api);
@@ -45,6 +46,6 @@ const useCustomFields = async (
 
 export default useCustomFields;
 
-export const disableCustomFields = (models, getModel): void => {
+export const disableCustomFields = (models: Models[], getModel: ModelFetcher): void => {
   removeHooks(models, getModel);
 };

package/src/tests/api/test-api.ts

@@ -1,10 +1,11 @@
 import express from 'express';
 import { Router } from '@autofleet/node-common';
+import logger from '../../utils/logger';
 import { TestModel } from '../../models';
 
 const app = express();
 app.use(express.json());
-const api = Router();
+const api = Router({ logger });
 
 api.get('/v1/test-models', async (req, res) => {
   const testModels = await TestModel.findAll();

package/src/tests/helpers/index.ts

@@ -1,4 +1,4 @@
-import { generateFilterReplacements } from '@autofleet/sheilta/lib/formatter';
+import { generateFilterReplacements } from '@autofleet/sheilta';
 import {
   ContextAwareTestModel, ContextTestModel, CustomFieldDefinition, CustomFieldEntries, TestModel,
 } from '../../models';

package/src/tests/mocks/events.mock.ts

@@ -1,7 +1,7 @@
 /* eslint-disable no-param-reassign */
 
 export const mockEvent = (events: any, eventName, numberOfEvents) => {
-  events.sendObject = jest.fn();
+  events.sendObject = jest.fn().mockResolvedValue(true);
   return [
     events.sendObject,
     (): void => {

package/src/utils/logger/index.ts

@@ -2,4 +2,13 @@ import Logger from '@autofleet/logger';
 
 const logger = Logger();
 
+export async function tryAddingTraceIdMiddleware() {
+  try {
+    const { outbreak } = await import('@autofleet/zehut');
+    logger.addContextMiddleware(() => ({ traceId: outbreak.getCurrentContext().context?.get('x-trace-id') }));
+  } catch (err) {
+    logger.error('Failed to add traceId middleware', { err });
+  }
+}
+
 export default logger;