@autofleet/sadot 0.5.4-beta.2 → 0.5.4-beta.21

package/.env

@@ -0,0 +1,3 @@
+DB_USERNAME=emiltayeb
+DB_PASSWORD=123456
+NODE_ENV=test

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

@@ -83,7 +83,7 @@ router.get('/', async (req, res) => {
         if (entityIds?.length > 0) {
             where.entityId = entityIds;
         }
-        const customFieldDefinitions = await DefinitionRepo.findAll({ ...where }, { withDisabled: true });
+        const customFieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true });
         return res.json(customFieldDefinitions);
     }
     catch (err) {

package/dist/hooks/create.d.ts

@@ -1,3 +1,4 @@
+import { ModelOptions } from '../types';
 /**
  * A hook to create the custom fields when updating a model (more then one instance).
  */
@@ -6,4 +7,4 @@ export declare const beforeBulkCreate: (options: any) => void;
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export declare const beforeCreate: (scopeAttributes: string[]) => (instance: any, options: any) => Promise<void>;
+export declare const beforeCreate: (scopeAttributes: string[], modelOptions?: ModelOptions) => (instance: any, options: any) => Promise<void>;

package/dist/hooks/create.js

@@ -27,10 +27,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.beforeCreate = exports.beforeBulkCreate = void 0;
-const logger_1 = __importDefault(require("../utils/logger"));
 const ValueRepo = __importStar(require("../repository/value"));
 const DefinitionRepo = __importStar(require("../repository/definition"));
 const errors_1 = require("../errors");
+const scopeAttributes_1 = __importDefault(require("../utils/scopeAttributes"));
 /**
  * A hook to create the custom fields when updating a model (more then one instance).
  */
@@ -44,11 +44,11 @@ exports.beforeBulkCreate = beforeBulkCreate;
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-const beforeCreate = (scopeAttributes) => async (instance, options) => {
-    logger_1.default.debug('sadot - before create hook');
+const beforeCreate = (scopeAttributes, modelOptions = {}) => async (instance, options) => {
     const { fields } = options;
     const modelType = instance.constructor.name;
-    const identifiers = scopeAttributes.map((attribute) => instance[attribute]);
+    const { scopeAttributeReplacer } = modelOptions;
+    const identifiers = await (0, scopeAttributes_1.default)(instance, scopeAttributes, scopeAttributeReplacer);
     // get all model's required definitions
     const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType, instance.id, identifiers);
     const customFieldsIdx = fields.indexOf('customFields');
@@ -59,7 +59,9 @@ const beforeCreate = (scopeAttributes) => async (instance, options) => {
         if (missingFields?.length > 0) {
             throw new errors_1.MissingRequiredCustomFieldError(missingFields);
         }
-        await ValueRepo.updateValues(modelType, instance.id, identifiers, customFields, { transaction: options.transaction });
+        await ValueRepo.updateValues(modelType, instance.id, identifiers, customFields, {
+            transaction: options.transaction,
+        });
         // eslint-disable-next-line no-param-reassign
         fields.splice(customFieldsIdx, 1);
     }

package/dist/hooks/enrich.d.ts

@@ -1,6 +1,7 @@
+import { ModelOptions } from '../types';
 type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-declare const enrichResults: (modelType: string, scopeAttributes: string[], hookType?: SupportedHookTypes) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
+declare const enrichResults: (modelType: string, scopeAttributes: string[], getScope: any, hookType?: SupportedHookTypes, modelOptions?: ModelOptions) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
 export default enrichResults;

package/dist/hooks/enrich.js

@@ -22,10 +22,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __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 });
 /* eslint-disable no-param-reassign */
 const ValueRepo = __importStar(require("../repository/value"));
 const DefinitionRepo = __importStar(require("../repository/definition"));
+const logger_1 = __importDefault(require("../utils/logger"));
+const scopeAttributes_1 = __importDefault(require("../utils/scopeAttributes"));
 /**
  * Serialize custom fields value into the format of {[name] -> [fieldData]}
  */
@@ -40,7 +45,8 @@ const serializeCustomFields = (customFieldValues, customFieldDefinitionsHash) =>
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-const enrichResults = (modelType, scopeAttributes, hookType) => async (instancesOrInstance, options) => {
+const enrichResults = (modelType, scopeAttributes, getScope, hookType, modelOptions = {}) => async (instancesOrInstance, options) => {
+    const { scopeAttributeReplacer } = modelOptions;
     if (options.originalAttributes?.length > 0
         && !options.originalAttributes?.includes?.('customFields')) {
         return;
@@ -50,20 +56,20 @@ const enrichResults = (modelType, scopeAttributes, hookType) => async (instances
         ? instancesOrInstance
         : [instancesOrInstance];
     instances = instances.filter(Boolean);
-    const identifiers = instances.map((instance) => scopeAttributes
-        .map((attr) => instance[attr])).flat();
+    const identifiers = await (0, scopeAttributes_1.default)(instances, scopeAttributes, scopeAttributeReplacer);
+    logger_1.default.info('enrichResults - sadot - indentifiers: ', identifiers);
     const uniqueIdentifiers = [...new Set(identifiers)].filter(Boolean);
     const identifierCustomFieldDefinitionsMapping = uniqueIdentifiers.reduce((map, identifier) => ({
         ...map,
         [identifier]: [],
     }), {});
-    const customFieldDefinitions = await DefinitionRepo.findByEntityIds(modelType, uniqueIdentifiers, { transaction: options.transaction });
+    const customFieldDefinitions = await DefinitionRepo.findByEntityIds(modelType, uniqueIdentifiers, { transaction: options.transaction, getScope });
     const definitionsMap = customFieldDefinitions.reduce((map, definition) => ({
         ...map,
         [definition.id]: definition,
     }), {});
     customFieldDefinitions.forEach((cfd) => {
-        identifierCustomFieldDefinitionsMapping[cfd.entityId].push(cfd);
+        identifierCustomFieldDefinitionsMapping[cfd.entityId]?.push(cfd);
     });
     // Get the values per instates ids:
     const instancesIds = instances.map((i) => i[primaryKey]);

package/dist/hooks/update.d.ts

@@ -1,3 +1,4 @@
+import { ModelOptions } from '../types';
 /**
  * A hook to update the custom fields when updating a model (more then one instance).
  */
@@ -6,4 +7,4 @@ export declare const beforeBulkUpdate: (options: any) => void;
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export declare const beforeUpdate: (scopeAttributes: string[]) => (instance: any, options: any) => Promise<void>;
+export declare const beforeUpdate: (scopeAttributes: string[], modelOptions?: ModelOptions) => (instance: any, options: any) => Promise<void>;

package/dist/hooks/update.js

@@ -29,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.beforeUpdate = exports.beforeBulkUpdate = void 0;
 const logger_1 = __importDefault(require("../utils/logger"));
 const ValueRepo = __importStar(require("../repository/value"));
+const scopeAttributes_1 = __importDefault(require("../utils/scopeAttributes"));
 /**
  * A hook to update the custom fields when updating a model (more then one instance).
  */
@@ -42,11 +43,12 @@ exports.beforeBulkUpdate = beforeBulkUpdate;
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-const beforeUpdate = (scopeAttributes) => async (instance, options) => {
+const beforeUpdate = (scopeAttributes, modelOptions = {}) => async (instance, options) => {
     logger_1.default.debug('sadot - before update hook');
     const { fields } = options;
+    const { scopeAttributeReplacer } = modelOptions;
     const modelType = instance.constructor.name;
-    const identifiers = scopeAttributes.map((attribute) => instance[attribute]);
+    const identifiers = await (0, scopeAttributes_1.default)(instance, scopeAttributes, scopeAttributeReplacer);
     const customFieldsIdx = fields.indexOf('customFields');
     if (customFieldsIdx > -1) {
         const { customFields } = instance;

package/dist/models/index.d.ts

@@ -2,7 +2,9 @@ import type { Sequelize } from 'sequelize-typescript';
 import CustomFieldDefinition from './CustomFieldDefinition';
 import CustomFieldValue from './CustomFieldValue';
 import TestModel from './tests/TestModel';
+import ContextAwareTestModel from './tests/contextAwareModels/ContextAwareTestModel';
+import ContextModel from './tests/contextAwareModels/ContextModel';
 import AssociatedTestModel from './tests/AssociatedTestModel';
 declare const initTables: (sequelize: Sequelize, getUser: any) => Promise<void>;
 declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
-export { CustomFieldValue, CustomFieldDefinition, TestModel, AssociatedTestModel, initTables, initTestModels, };
+export { CustomFieldValue, CustomFieldDefinition, TestModel, AssociatedTestModel, ContextAwareTestModel, ContextModel, initTables, initTestModels, };

package/dist/models/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initTestModels = exports.initTables = exports.AssociatedTestModel = exports.TestModel = exports.CustomFieldDefinition = exports.CustomFieldValue = void 0;
+exports.initTestModels = exports.initTables = exports.ContextModel = exports.ContextAwareTestModel = exports.AssociatedTestModel = exports.TestModel = exports.CustomFieldDefinition = exports.CustomFieldValue = void 0;
 /* eslint-disable no-param-reassign */
 const sequelize_1 = require("sequelize");
 const logger_1 = __importDefault(require("../utils/logger"));
@@ -13,10 +13,14 @@ const CustomFieldValue_1 = __importDefault(require("./CustomFieldValue"));
 exports.CustomFieldValue = CustomFieldValue_1.default;
 const TestModel_1 = __importDefault(require("./tests/TestModel"));
 exports.TestModel = TestModel_1.default;
+const ContextAwareTestModel_1 = __importDefault(require("./tests/contextAwareModels/ContextAwareTestModel"));
+exports.ContextAwareTestModel = ContextAwareTestModel_1.default;
+const ContextModel_1 = __importDefault(require("./tests/contextAwareModels/ContextModel"));
+exports.ContextModel = ContextModel_1.default;
 const AssociatedTestModel_1 = __importDefault(require("./tests/AssociatedTestModel"));
 exports.AssociatedTestModel = AssociatedTestModel_1.default;
 const productionModels = [CustomFieldDefinition_1.default, CustomFieldValue_1.default];
-const testModels = [TestModel_1.default, AssociatedTestModel_1.default];
+const testModels = [TestModel_1.default, AssociatedTestModel_1.default, ContextAwareTestModel_1.default, ContextModel_1.default];
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
 const SCHEMA_VERSION = 1;
 const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
@@ -82,6 +86,8 @@ const initTestModels = async (sequelize) => {
     logger_1.default.info('custom-fields: test models added');
     await TestModel_1.default.sync({ alter: true });
     await AssociatedTestModel_1.default.sync({ alter: true });
+    await ContextModel_1.default.sync({ alter: true });
+    await ContextAwareTestModel_1.default.sync({ alter: true });
     logger_1.default.info('custom-fields: test models synced');
 };
 exports.initTestModels = initTestModels;

package/dist/models/tests/contextAwareModels/ContextAwareTestModel.d.ts

@@ -0,0 +1,10 @@
+import { Model } from 'sequelize-typescript';
+import ContextModel from './ContextModel';
+declare class ContextAwareTestModel extends Model {
+    id: string;
+    contextId: string;
+    coolAttribute?: boolean;
+    customFields?: any;
+    context: ContextModel;
+}
+export default ContextAwareTestModel;

package/dist/models/tests/contextAwareModels/ContextAwareTestModel.js

@@ -0,0 +1,55 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const sequelize_typescript_1 = require("sequelize-typescript");
+const ContextModel_1 = __importDefault(require("./ContextModel"));
+let ContextAwareTestModel = class ContextAwareTestModel extends sequelize_typescript_1.Model {
+};
+__decorate([
+    sequelize_typescript_1.PrimaryKey,
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.UUID,
+        defaultValue: sequelize_typescript_1.DataType.UUIDV4,
+        allowNull: false,
+    }),
+    __metadata("design:type", String)
+], ContextAwareTestModel.prototype, "id", void 0);
+__decorate([
+    (0, sequelize_typescript_1.ForeignKey)(() => ContextModel_1.default),
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.UUID,
+    }),
+    __metadata("design:type", String)
+], ContextAwareTestModel.prototype, "contextId", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.BOOLEAN,
+    }),
+    __metadata("design:type", Boolean)
+], ContextAwareTestModel.prototype, "coolAttribute", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.VIRTUAL,
+    }),
+    __metadata("design:type", Object)
+], ContextAwareTestModel.prototype, "customFields", void 0);
+__decorate([
+    (0, sequelize_typescript_1.BelongsTo)(() => ContextModel_1.default),
+    __metadata("design:type", ContextModel_1.default)
+], ContextAwareTestModel.prototype, "context", void 0);
+ContextAwareTestModel = __decorate([
+    (0, sequelize_typescript_1.Table)({ createdAt: false, updatedAt: false })
+], ContextAwareTestModel);
+exports.default = ContextAwareTestModel;

package/dist/models/tests/contextAwareModels/ContextModel.d.ts

@@ -0,0 +1,13 @@
+import { Model } from 'sequelize-typescript';
+declare enum EEntityTypes {
+    BUSINESS_MODEL = "businessModel",
+    CONTEXT = "context",
+    DEMAND_SOURCE = "demandSource",
+    FLEET = "fleet"
+}
+declare class ContextModel extends Model {
+    id: string;
+    entityId: string;
+    entityType: EEntityTypes;
+}
+export default ContextModel;

package/dist/models/tests/contextAwareModels/ContextModel.js

@@ -0,0 +1,47 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const sequelize_typescript_1 = require("sequelize-typescript");
+// eslint-disable-next-line no-shadow
+var EEntityTypes;
+(function (EEntityTypes) {
+    EEntityTypes["BUSINESS_MODEL"] = "businessModel";
+    EEntityTypes["CONTEXT"] = "context";
+    EEntityTypes["DEMAND_SOURCE"] = "demandSource";
+    EEntityTypes["FLEET"] = "fleet";
+})(EEntityTypes || (EEntityTypes = {}));
+let ContextModel = class ContextModel extends sequelize_typescript_1.Model {
+};
+__decorate([
+    sequelize_typescript_1.PrimaryKey,
+    (0, sequelize_typescript_1.Column)({
+        defaultValue: sequelize_typescript_1.DataType.UUIDV4,
+        type: sequelize_typescript_1.DataType.UUID,
+    }),
+    __metadata("design:type", String)
+], ContextModel.prototype, "id", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.UUID,
+    }),
+    __metadata("design:type", String)
+], ContextModel.prototype, "entityId", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.ENUM(...Object.values(EEntityTypes)),
+    }),
+    __metadata("design:type", String)
+], ContextModel.prototype, "entityType", void 0);
+ContextModel = __decorate([
+    (0, sequelize_typescript_1.Table)({ createdAt: false, updatedAt: false })
+], ContextModel);
+exports.default = ContextModel;

package/dist/repository/definition.d.ts

@@ -1,10 +1,10 @@
+import { WhereOptions } from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
 export declare const create: (data: CreateCustomFieldDefinition) => Promise<CustomFieldDefinition>;
-export declare const findAll: (where: any, options?: any) => Promise<CustomFieldDefinition[]>;
+export declare const findAll: (where: WhereOptions, options?: any) => Promise<CustomFieldDefinition[]>;
 export declare const findByIds: (ids: string[], options?: any) => Promise<CustomFieldDefinition[]>;
 export declare const findById: (id: string, options?: any) => Promise<CustomFieldDefinition | null>;
-export declare const findByEntityId: (entityId: string, options?: any) => Promise<CustomFieldDefinition[]>;
 export declare const findByEntityIds: (modelType: string, entityIds: string[], options?: any) => Promise<CustomFieldDefinition[]>;
 export declare const findByWhere: (where: any) => Promise<CustomFieldDefinition | null>;
 export declare const findDefinitionsByModels: (modelTypes: string[], options?: any) => Promise<CustomFieldDefinition[]>;

package/dist/repository/definition.js

@@ -1,18 +1,23 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRequiredFields = exports.destroy = exports.disable = exports.update = exports.findDefinitionsByModels = exports.findByWhere = exports.findByEntityIds = exports.findByEntityId = exports.findById = exports.findByIds = exports.findAll = exports.create = void 0;
+exports.getRequiredFields = exports.destroy = exports.disable = exports.update = exports.findDefinitionsByModels = exports.findByWhere = exports.findByEntityIds = exports.findById = exports.findByIds = exports.findAll = exports.create = void 0;
 const sequelize_1 = require("sequelize");
 const models_1 = require("../models");
+const logger_1 = __importDefault(require("../utils/logger"));
 const create = (data) => models_1.CustomFieldDefinition.create(data);
 exports.create = create;
 const findAll = (where, options = { withDisabled: false }) => {
     const queryModel = options.withDisabled
         ? models_1.CustomFieldDefinition.unscoped()
         : models_1.CustomFieldDefinition;
+    logger_1.default.info('sadot - whereQuery', { options });
     return queryModel.scope('userScope').findAll({
         where,
-        transaction: options.transaction,
         raw: true,
+        logging: true,
     });
 };
 exports.findAll = findAll;
@@ -26,17 +31,13 @@ const findById = (id, options = { withDisabled: false }) => {
     return models_1.CustomFieldDefinition.scope('userScope').findByPk(id);
 };
 exports.findById = findById;
-const findByEntityId = async (entityId, options = {}) => models_1.CustomFieldDefinition.findAll({
-    where: { entityId },
-    transaction: options.transaction,
-});
-exports.findByEntityId = findByEntityId;
 const findByEntityIds = async (modelType, entityIds, options = {}) => models_1.CustomFieldDefinition.findAll({
     where: {
         modelType,
         entityId: entityIds,
     },
     transaction: options.transaction,
+    include: options.include,
     raw: true,
 });
 exports.findByEntityIds = findByEntityIds;
@@ -71,7 +72,11 @@ exports.destroy = destroy;
 const getRequiredFields = async (modelType, modelId, entityId) => {
     const entityIds = Array.isArray(entityId) ? entityId : [entityId];
     const requiredFields = await models_1.CustomFieldDefinition.findAll({
-        where: { required: true, modelType, entityId: { [sequelize_1.Op.in]: entityIds } },
+        where: {
+            required: true,
+            modelType,
+            entityId: { [sequelize_1.Op.in]: entityIds },
+        },
         logging: true,
     });
     const requiredFieldsNames = requiredFields.map((definition) => definition.name);

package/dist/repository/value.js

@@ -73,9 +73,15 @@ exports.findValuesByModelIds = findValuesByModelIds;
  * Return the updated values
  */
 const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, options = {}) => {
-    logger_1.default.info(`custom-fields: updating values for ${modelType} ${modelId}`, { valuesToUpdate });
     const names = Object.keys(valuesToUpdate);
-    const fieldDefinitions = await DefinitionRepo.findAll({ modelType, name: names, entityId: identifiers }, { withDisabled: true, transaction: options.transaction }) || [];
+    logger_1.default.info(`custom-fields: updating values for ${modelType} ${modelId}`, {
+        names, options, valuesToUpdate, entityId: identifiers,
+    });
+    const fieldDefinitions = (await DefinitionRepo.findAll({
+        modelType,
+        name: names,
+        entityId: identifiers,
+    }, { withDisabled: true, transaction: options.transaction })) || [];
     const disabledDefinitions = fieldDefinitions.filter((def) => def.disabled);
     if (fieldDefinitions.length !== names.length) {
         logger_1.default.info(`custom-fields: missing definitions for ${modelType} ${modelId}`, { names, fieldDefinitions });

package/dist/tests/helpers/database-config.d.ts

@@ -4,6 +4,7 @@ declare const _default: {
         password: string;
         database: string;
         host: string;
+        port: string | number;
         dialect: string;
         define: {
             underscored: boolean;

package/dist/tests/helpers/database-config.js

@@ -6,6 +6,7 @@ exports.default = {
         password: process.env.DB_PASSWORD || null,
         database: process.env.DB_NAME || 'sadot_package_test',
         host: process.env.DB_HOST || '127.0.0.1',
+        port: process.env.DB_PORT || 5432,
         dialect: process.env.DB_TYPE || 'postgres',
         define: {
             underscored: true,

package/dist/tests/helpers/index.js

@@ -7,6 +7,8 @@ const cleanup = async () => {
     if (process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'development') {
         await models_1.CustomFieldDefinition.unscoped().destroy({ where: {} });
         await models_1.TestModel.destroy({ where: {} });
+        await models_1.ContextAwareTestModel.destroy({ where: {} });
+        await models_1.ContextModel.destroy({ where: {} });
     }
 };
 exports.cleanup = cleanup;

package/dist/tests/mocks/definition.mock.d.ts

@@ -1,4 +1,10 @@
 import { CreateCustomFieldDefinition, CustomFieldDefinitionDTO } from '../../types/definition';
+export declare const contextAwareFieldDefinition: {
+    name: string;
+    modelType: string;
+    fieldType: string;
+    entityType: string;
+};
 export declare const coolFieldDefinition: CreateCustomFieldDefinition;
 export declare const coolFieldDefinition2: {
     name: string;

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

@@ -1,7 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDefinitions = exports.createDefinition = exports.rangeField = exports.enumField = exports.booleanField = exports.coolFieldDefinition3 = exports.coolFieldDefinition2 = exports.coolFieldDefinition = void 0;
+exports.createDefinitions = exports.createDefinition = exports.rangeField = exports.enumField = exports.booleanField = exports.coolFieldDefinition3 = exports.coolFieldDefinition2 = exports.coolFieldDefinition = exports.contextAwareFieldDefinition = void 0;
 const uuid_1 = require("uuid");
+exports.contextAwareFieldDefinition = {
+    name: 'cool field',
+    modelType: 'ContextAwareTestModel',
+    fieldType: 'number',
+    entityType: 'fleetId',
+};
 exports.coolFieldDefinition = {
     name: 'cool field',
     modelType: 'TestModel',

package/dist/tests/mocks/testModel.d.ts

@@ -1,5 +1,5 @@
 import { TestModel } from '../../models';
-export declare const createTestModel: (payload?: {}) => Promise<TestModel>;
+export declare const createTestModel: (payload?: {}, model?: any) => any;
 export declare const createTestModels: (fleetId: any, total: number) => Promise<TestModel[]>;
 export declare const upsertTestModel: (payload: any) => Promise<[TestModel, boolean]>;
 export declare const destroyTestModels: () => Promise<number>;

package/dist/tests/mocks/testModel.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTestModelWithAssociation = exports.createTestModelWithAssociation = exports.updateTestModel = exports.getSomeTestModels = exports.getTestModel = exports.destroyTestModels = exports.upsertTestModel = exports.createTestModels = exports.createTestModel = void 0;
 const models_1 = require("../../models");
-const createTestModel = (payload = {}) => models_1.TestModel.create(payload);
+const createTestModel = (payload = {}, model = models_1.TestModel) => model.create(payload);
 exports.createTestModel = createTestModel;
 const createTestModels = (fleetId, total) => {
     const models = [];

package/dist/types/index.d.ts

@@ -1,13 +1,17 @@
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
+    scopeAttributeReplacer?: (attributes?: string[]) => Promise<any>;
+};
+export type Models = {
     name: string;
     scopeAttributes: string[];
+    modelOptions?: ModelOptions;
     creationWebhookHandler?: (instance: any) => any;
     updateWebhookHandler?: (instance: any) => any;
     deletionWebhookHandler?: (instance: any) => any;
 };
 export type CustomFieldOptions = {
-    models: ModelOptions[];
+    models: Models[];
     databaseConfig: any;
     getUser: () => any;
 };

package/dist/utils/init.d.ts

@@ -1,4 +1,4 @@
-import type { ModelFetcher, ModelOptions } from '../types';
-export declare const addHooks: (models: ModelOptions[], getModel: ModelFetcher) => void;
-export declare const removeHooks: (models: ModelOptions[], getModel: ModelFetcher) => void;
-export declare const addScopes: (models: ModelOptions[], getModel: ModelFetcher) => void;
+import type { ModelFetcher, Models } from '../types';
+export declare const addHooks: (models: Models[], getModel: ModelFetcher) => void;
+export declare const removeHooks: (models: Models[], getModel: ModelFetcher) => void;
+export declare const addScopes: (models: Models[], getModel: ModelFetcher) => void;

package/dist/utils/init.js

@@ -12,7 +12,7 @@ const scopes_1 = require("../scopes");
 const logger_1 = __importDefault(require("./logger"));
 const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
 const addHooks = (models, getModel) => {
-    models.forEach(async ({ name, scopeAttributes }) => {
+    models.forEach(async ({ name, scopeAttributes, modelOptions, }) => {
         try {
             const model = getModel(name);
             if (!model) {
@@ -31,11 +31,11 @@ const addHooks = (models, getModel) => {
             model.addHook('beforeFind', 'sadot-beforeFind', (0, hooks_1.beforeFind)(scopeAttributes));
             model.addHook('beforeBulkCreate', 'sadot-beforeBulkCreate', hooks_1.beforeBulkCreate);
             model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', hooks_1.beforeBulkUpdate);
-            model.addHook('beforeCreate', 'sadot-beforeCreate', (0, hooks_1.beforeCreate)(scopeAttributes));
-            model.addHook('beforeUpdate', 'sadot-beforeUpdate', (0, hooks_1.beforeUpdate)(scopeAttributes));
-            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes, 'afterFind'));
-            model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes));
-            model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes));
+            model.addHook('beforeCreate', 'sadot-beforeCreate', (0, hooks_1.beforeCreate)(scopeAttributes, modelOptions));
+            model.addHook('beforeUpdate', 'sadot-beforeUpdate', (0, hooks_1.beforeUpdate)(scopeAttributes, modelOptions));
+            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes, 'afterFind', null, modelOptions));
+            model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, modelOptions));
+            model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, modelOptions));
         }
         catch (e) {
             logger_1.default.error(`Could not add custom fields hook to model ${name}. `, e);

package/dist/utils/scopeAttributes.d.ts

@@ -0,0 +1,3 @@
+import { ModelOptions } from '../types';
+declare const getScopeAttributes: (instance: any, scopeAttributes: string[], scopeAttributeReplacer?: ModelOptions['scopeAttributeReplacer']) => Promise<any[]>;
+export default getScopeAttributes;

package/dist/utils/scopeAttributes.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getIdentifiers = (instance, scopeAttributes) => {
+    if (Array.isArray(instance)) {
+        return instance.map((ins) => scopeAttributes.map((attr) => ins[attr])).flat();
+    }
+    return scopeAttributes.map((attribute) => instance[attribute]);
+};
+const getScopeAttributes = async (instance, scopeAttributes, scopeAttributeReplacer) => {
+    let identifiers = getIdentifiers(instance, scopeAttributes);
+    if (scopeAttributeReplacer) {
+        identifiers = await scopeAttributeReplacer(identifiers);
+    }
+    return identifiers;
+};
+exports.default = getScopeAttributes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.5.4-beta.2",
+  "version": "0.5.4-beta.21",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -9,7 +9,24 @@
     "linter": "./node_modules/.bin/eslint .",
     "test": "jest --forceExit --runInBand",
     "coverage": "jest --coverage --forceExit --runInBand && rm -rf ./coverage",
-    "dev": "nodemon"
+    "build-to-local-repo": "npm run build && cp -r dist/* ../$REPO/node_modules/$npm_package_name/dist",
+    "dev": "nodemon",
+    "watch": "npm-watch build-to-local-repo"
+  },
+  "watch": {
+    "build-to-local-repo": {
+      "extensions": [
+        "js",
+        "jsx",
+        "ts",
+        "tsx",
+        "css"
+      ],
+      "patterns": [
+        "src"
+      ],
+      "quiet": false
+    }
   },
   "dependencies": {
     "@autofleet/common-types": "^1.7.29",
@@ -18,6 +35,7 @@
     "@autofleet/logger": "^2.0.5",
     "express": "^4.18.2",
     "joi": "^17.7.0",
+    "npm-watch": "^0.11.0",
     "pg": "^8.10.0",
     "reflect-metadata": "^0.1.13",
     "sequelize": "^6.31.1",
@@ -41,4 +59,4 @@
   },
   "author": "Autofleet",
   "license": "ISC"
-}
+}

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

@@ -65,10 +65,8 @@ router.get('/', async (req, res) => {
     if (entityIds?.length > 0) {
       where.entityId = entityIds;
     }
-    const customFieldDefinitions = await DefinitionRepo.findAll(
-      { ...where },
-      { withDisabled: true },
-    );
+    const customFieldDefinitions = await DefinitionRepo.findAll(where,
+      { withDisabled: true });
     return res.json(customFieldDefinitions);
   } catch (err) {
     logger.error('Failed to fetch custom field definitions', err);

package/src/hooks/create.ts

@@ -1,7 +1,8 @@
-import logger from '../utils/logger';
 import * as ValueRepo from '../repository/value';
 import * as DefinitionRepo from '../repository/definition';
 import { MissingRequiredCustomFieldError } from '../errors';
+import { ModelOptions } from '../types';
+import getScopeAttributes from '../utils/scopeAttributes';
 
 /**
  * A hook to create the custom fields when updating a model (more then one instance).
@@ -15,14 +16,15 @@ export const beforeBulkCreate = (options): void => {
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export const beforeCreate = (scopeAttributes: string[]) => async (
+export const beforeCreate = (scopeAttributes: string[], modelOptions: ModelOptions = {}) => async (
   instance,
   options,
 ): Promise<void> => {
-  logger.debug('sadot - before create hook');
   const { fields } = options;
   const modelType = instance.constructor.name;
-  const identifiers = scopeAttributes.map((attribute) => instance[attribute]);
+  const { scopeAttributeReplacer } = modelOptions;
+
+  const identifiers = await getScopeAttributes(instance, scopeAttributes, scopeAttributeReplacer);
   // get all model's required definitions
   const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType,
     instance.id,
@@ -41,8 +43,11 @@ export const beforeCreate = (scopeAttributes: string[]) => async (
       instance.id,
       identifiers,
       customFields,
-      { transaction: options.transaction },
+      {
+        transaction: options.transaction,
+      },
     );
+
     // eslint-disable-next-line no-param-reassign
     fields.splice(customFieldsIdx, 1);
   } else if (requiredFieldsNames?.length > 0) {

package/src/hooks/enrich.ts

@@ -4,6 +4,9 @@ import * as DefinitionRepo from '../repository/definition';
 import CustomFieldValue from '../models/CustomFieldValue';
 import CustomFieldDefinition from '../models/CustomFieldDefinition';
 import { SerializedCustomFields } from '../types/definition';
+import logger from '../utils/logger';
+import { ModelOptions } from '../types';
+import getScopeAttributes from '../utils/scopeAttributes';
 
 type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
 
@@ -29,11 +32,14 @@ const serializeCustomFields = (
 const enrichResults = (
   modelType: string,
   scopeAttributes: string[],
+  getScope,
   hookType?: SupportedHookTypes,
+  modelOptions: ModelOptions = {},
 ) => async (
   instancesOrInstance: any | any[],
   options,
 ): Promise<void> => {
+  const { scopeAttributeReplacer } = modelOptions;
   if (
     options.originalAttributes?.length > 0
       && !options.originalAttributes?.includes?.('customFields')
@@ -48,19 +54,21 @@ const enrichResults = (
 
   instances = instances.filter(Boolean);
 
-  const identifiers = instances.map((instance) =>
-    scopeAttributes
-      .map((attr) => instance[attr])).flat();
+  const identifiers = await getScopeAttributes(instances, scopeAttributes, scopeAttributeReplacer);
+  logger.info('enrichResults - sadot - indentifiers: ', identifiers);
 
   const uniqueIdentifiers = [...new Set(identifiers)].filter(Boolean);
+
   const identifierCustomFieldDefinitionsMapping = uniqueIdentifiers.reduce((map, identifier) => ({
     ...map,
     [identifier]: [],
+
   }), {});
+
   const customFieldDefinitions = await DefinitionRepo.findByEntityIds(
     modelType,
     uniqueIdentifiers,
-    { transaction: options.transaction },
+    { transaction: options.transaction, getScope },
   );
 
   const definitionsMap = customFieldDefinitions.reduce((map, definition) => ({
@@ -69,7 +77,7 @@ const enrichResults = (
   }), {});
 
   customFieldDefinitions.forEach((cfd) => {
-    identifierCustomFieldDefinitionsMapping[cfd.entityId].push(cfd);
+    identifierCustomFieldDefinitionsMapping[cfd.entityId]?.push(cfd);
   });
 
   // Get the values per instates ids:
@@ -104,6 +112,7 @@ const enrichResults = (
 
     scopeAttributes.forEach((attribute) => {
       const identifier = instance[attribute];
+
       const entityCustomFieldDefinitions = identifierCustomFieldDefinitionsMapping[identifier];
       if (entityCustomFieldDefinitions?.length > 0) {
         entityCustomFieldDefinitions.forEach((customFieldDefinition) => {

package/src/hooks/find.ts

@@ -16,6 +16,7 @@ const doScopeAttributesMissing = (
 // eslint-disable-next-line import/prefer-default-export
 export const beforeFind = (scopeAttributes: string[]) => (options): void => {
   const { attributes: queryAttributes } = options;
+
   if (queryAttributes?.includes?.('customFields')) {
     const missingScopeAttributes = doScopeAttributesMissing(scopeAttributes, queryAttributes);
     logger.debug('sadot - before find hook');

package/src/hooks/update.ts

@@ -1,5 +1,7 @@
 import logger from '../utils/logger';
 import * as ValueRepo from '../repository/value';
+import { ModelOptions } from '../types';
+import getScopeAttributes from '../utils/scopeAttributes';
 
 /**
  * A hook to update the custom fields when updating a model (more then one instance).
@@ -14,14 +16,15 @@ export const beforeBulkUpdate = (options): void => {
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export const beforeUpdate = (scopeAttributes: string[]) => async (
+export const beforeUpdate = (scopeAttributes: string[], modelOptions: ModelOptions = {}) => async (
   instance,
   options,
 ): Promise<void> => {
   logger.debug('sadot - before update hook');
   const { fields } = options;
+  const { scopeAttributeReplacer } = modelOptions;
   const modelType = instance.constructor.name;
-  const identifiers = scopeAttributes.map((attribute) => instance[attribute]);
+  const identifiers = await getScopeAttributes(instance, scopeAttributes, scopeAttributeReplacer);
 
   const customFieldsIdx = fields.indexOf('customFields');
   if (customFieldsIdx > -1) {
@@ -32,6 +35,7 @@ export const beforeUpdate = (scopeAttributes: string[]) => async (
       identifiers,
       customFields,
       { transaction: options.transaction },
+
     );
     // eslint-disable-next-line no-param-reassign
     fields.splice(customFieldsIdx, 1);

package/src/models/index.ts

@@ -5,10 +5,12 @@ import logger from '../utils/logger';
 import CustomFieldDefinition from './CustomFieldDefinition';
 import CustomFieldValue from './CustomFieldValue';
 import TestModel from './tests/TestModel';
+import ContextAwareTestModel from './tests/contextAwareModels/ContextAwareTestModel';
+import ContextModel from './tests/contextAwareModels/ContextModel';
 import AssociatedTestModel from './tests/AssociatedTestModel';
 
 const productionModels = [CustomFieldDefinition, CustomFieldValue];
-const testModels = [TestModel, AssociatedTestModel];
+const testModels = [TestModel, AssociatedTestModel, ContextAwareTestModel, ContextModel];
 
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
 const SCHEMA_VERSION = 1;
@@ -88,6 +90,8 @@ const initTestModels = async (sequelize: Sequelize): Promise<void> => {
   logger.info('custom-fields: test models added');
   await TestModel.sync({ alter: true });
   await AssociatedTestModel.sync({ alter: true });
+  await ContextModel.sync({ alter: true });
+  await ContextAwareTestModel.sync({ alter: true });
   logger.info('custom-fields: test models synced');
 };
 
@@ -96,6 +100,8 @@ export {
   CustomFieldDefinition,
   TestModel,
   AssociatedTestModel,
+  ContextAwareTestModel,
+  ContextModel,
   initTables,
   initTestModels,
 };

package/src/models/tests/contextAwareModels/ContextAwareTestModel.ts

@@ -0,0 +1,45 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  Table,
+  Column,
+  Model,
+  PrimaryKey,
+  DataType,
+  HasMany,
+  BelongsTo,
+  ForeignKey,
+} from 'sequelize-typescript';
+import AssociatedTestModel from '../AssociatedTestModel';
+import ContextModel from './ContextModel';
+
+@Table({ createdAt: false, updatedAt: false })
+class ContextAwareTestModel extends Model {
+    @PrimaryKey
+    @Column({
+      type: DataType.UUID,
+      defaultValue: DataType.UUIDV4,
+      allowNull: false,
+    })
+    id!: string;
+
+    @ForeignKey(() => ContextModel)
+    @Column({
+      type: DataType.UUID,
+    })
+      contextId: string;
+
+    @Column({
+      type: DataType.BOOLEAN,
+    })
+    coolAttribute?: boolean;
+
+    @Column({
+      type: DataType.VIRTUAL,
+    })
+    customFields?: any;
+
+    @BelongsTo(() => ContextModel)
+    context: ContextModel;
+}
+
+export default ContextAwareTestModel;

package/src/models/tests/contextAwareModels/ContextModel.ts

@@ -0,0 +1,38 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  Table,
+  Column,
+  Model,
+  PrimaryKey,
+  DataType,
+} from 'sequelize-typescript';
+
+// eslint-disable-next-line no-shadow
+ enum EEntityTypes {
+  BUSINESS_MODEL = 'businessModel',
+  CONTEXT = 'context',
+  DEMAND_SOURCE = 'demandSource',
+  FLEET = 'fleet',
+}
+
+@Table({ createdAt: false, updatedAt: false })
+class ContextModel extends Model {
+  @PrimaryKey
+  @Column({
+    defaultValue: DataType.UUIDV4,
+    type: DataType.UUID,
+  })
+    id: string;
+
+  @Column({
+    type: DataType.UUID,
+  })
+    entityId: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(EEntityTypes)),
+  })
+    entityType: EEntityTypes;
+}
+
+export default ContextModel;

package/src/repository/definition.ts

@@ -1,21 +1,26 @@
-import { Op, WhereOptions } from 'sequelize';
+import {
+  Op, WhereOptions,
+} from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
+import logger from '../utils/logger';
 
 export const create = (data: CreateCustomFieldDefinition): Promise<CustomFieldDefinition> =>
   CustomFieldDefinition.create(data);
 
 export const findAll = (
-  where: any,
+  where: WhereOptions,
   options: any = { withDisabled: false },
 ): Promise<CustomFieldDefinition[]> => {
   const queryModel = options.withDisabled
     ? CustomFieldDefinition.unscoped()
     : CustomFieldDefinition;
+
+  logger.info('sadot - whereQuery', { options });
   return queryModel.scope('userScope').findAll({
     where,
-    transaction: options.transaction,
     raw: true,
+    logging: true,
   });
 };
 
@@ -35,14 +40,6 @@ export const findById = (
   return CustomFieldDefinition.scope('userScope').findByPk(id);
 };
 
-export const findByEntityId = async (
-  entityId: string,
-  options: any = {},
-): Promise<CustomFieldDefinition[]> => CustomFieldDefinition.findAll({
-  where: { entityId },
-  transaction: options.transaction,
-});
-
 export const findByEntityIds = async (
   modelType: string,
   entityIds: string[],
@@ -53,6 +50,7 @@ export const findByEntityIds = async (
     entityId: entityIds,
   },
   transaction: options.transaction,
+  include: options.include,
   raw: true,
 });
 
@@ -103,9 +101,13 @@ export const getRequiredFields = async (
 ): Promise<string[]> => {
   const entityIds = Array.isArray(entityId) ? entityId : [entityId];
   const requiredFields = await CustomFieldDefinition.findAll({
-    where: { required: true, modelType, entityId: { [Op.in]: entityIds } },
+    where: {
+      required: true,
+      modelType,
+      entityId: { [Op.in]: entityIds },
+    },
     logging: true,
   });
-  const requiredFieldsNames = requiredFields.map((definition) => definition.name);
+  const requiredFieldsNames = requiredFields.map((definition:any) => definition.name);
   return [...new Set(requiredFieldsNames)];
 };

package/src/repository/value.ts

@@ -52,13 +52,19 @@ export const updateValues = async (
   valuesToUpdate: ValuesToUpdate,
   options: any = {},
 ): Promise<CustomFieldValue[]> => {
-  logger.info(`custom-fields: updating values for ${modelType} ${modelId}`, { valuesToUpdate });
-
   const names = Object.keys(valuesToUpdate);
-  const fieldDefinitions = await DefinitionRepo.findAll(
-    { modelType, name: names, entityId: identifiers },
+  logger.info(`custom-fields: updating values for ${modelType} ${modelId}`, {
+    names, options, valuesToUpdate, entityId: identifiers,
+  });
+
+  const fieldDefinitions = (await DefinitionRepo.findAll(
+    {
+      modelType,
+      name: names,
+      entityId: identifiers,
+    },
     { withDisabled: true, transaction: options.transaction },
-  ) || [];
+  )) || [];
 
   const disabledDefinitions = fieldDefinitions.filter((def) => def.disabled);
   if (fieldDefinitions.length !== names.length) {

package/src/tests/helpers/database-config.ts

@@ -4,6 +4,7 @@ export default {
     password: process.env.DB_PASSWORD || null,
     database: process.env.DB_NAME || 'sadot_package_test',
     host: process.env.DB_HOST || '127.0.0.1',
+    port: process.env.DB_PORT || 5432,
     dialect: process.env.DB_TYPE || 'postgres',
     define: {
       underscored: true,

package/src/tests/helpers/index.ts

@@ -1,10 +1,14 @@
-import { CustomFieldDefinition, TestModel } from '../../models';
+import {
+  ContextAwareTestModel, ContextModel, CustomFieldDefinition, TestModel,
+} from '../../models';
 
 // eslint-disable-next-line import/prefer-default-export
 export const cleanup = async (): Promise<void> => {
   if (process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'development') {
     await CustomFieldDefinition.unscoped().destroy({ where: {} });
     await TestModel.destroy({ where: {} });
+    await ContextAwareTestModel.destroy({ where: {} });
+    await ContextModel.destroy({ where: {} });
   }
 };
 

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

@@ -1,6 +1,13 @@
 import { v4 as uuidv4 } from 'uuid';
 import { CreateCustomFieldDefinition, CustomFieldDefinitionDTO } from '../../types/definition';
 
+export const contextAwareFieldDefinition = {
+  name: 'cool field',
+  modelType: 'ContextAwareTestModel',
+  fieldType: 'number',
+  entityType: 'fleetId',
+};
+
 export const coolFieldDefinition: CreateCustomFieldDefinition = {
   name: 'cool field',
   modelType: 'TestModel',

package/src/tests/mocks/testModel.ts

@@ -1,6 +1,6 @@
 import { TestModel, AssociatedTestModel } from '../../models';
 
-export const createTestModel = (payload = {}) => TestModel.create(payload);
+export const createTestModel = (payload = {}, model:any = TestModel) => model.create(payload);
 
 export const createTestModels = (fleetId, total: number) => {
   const models: Promise<TestModel>[] = [];

package/src/types/index.ts

@@ -1,15 +1,19 @@
 export type ModelFetcher = (name: string) => any;
 
 export type ModelOptions = {
+  scopeAttributeReplacer?: (attributes?: string[]) => Promise<any>;
+}
+export type Models = {
   name: string;
   scopeAttributes: string[];
+  modelOptions?: ModelOptions;
   creationWebhookHandler?: (instance: any) => any;
   updateWebhookHandler?: (instance: any) => any;
   deletionWebhookHandler?: (instance: any) => any;
 }
 
-export type CustomFieldOptions= {
-  models: ModelOptions[];
+export type CustomFieldOptions = {
+  models: Models[];
   databaseConfig: any;
   getUser: () => any;
 };

package/src/utils/init.ts

@@ -14,12 +14,14 @@ import {
 } from '../hooks';
 import { customFieldsFilterScope } from '../scopes';
 import logger from './logger';
-import type { ModelFetcher, ModelOptions } from '../types';
+import type { ModelFetcher, Models } from '../types';
 
 const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
 
-export const addHooks = (models: ModelOptions[], getModel: ModelFetcher): void => {
-  models.forEach(async ({ name, scopeAttributes }) => {
+export const addHooks = (models: Models[], getModel: ModelFetcher): void => {
+  models.forEach(async ({
+    name, scopeAttributes, modelOptions,
+  }) => {
     try {
       const model = getModel(name);
       if (!model) {
@@ -38,18 +40,18 @@ export const addHooks = (models: ModelOptions[], getModel: ModelFetcher): void =
       model.addHook('beforeFind', 'sadot-beforeFind', beforeFind(scopeAttributes));
       model.addHook('beforeBulkCreate', 'sadot-beforeBulkCreate', beforeBulkCreate);
       model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', beforeBulkUpdate);
-      model.addHook('beforeCreate', 'sadot-beforeCreate', beforeCreate(scopeAttributes));
-      model.addHook('beforeUpdate', 'sadot-beforeUpdate', beforeUpdate(scopeAttributes));
-      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes, 'afterFind'));
-      model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes));
-      model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes));
+      model.addHook('beforeCreate', 'sadot-beforeCreate', beforeCreate(scopeAttributes, modelOptions));
+      model.addHook('beforeUpdate', 'sadot-beforeUpdate', beforeUpdate(scopeAttributes, modelOptions));
+      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes, 'afterFind', null, modelOptions));
+      model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes, null, null, modelOptions));
+      model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes, null, null, modelOptions));
     } catch (e) {
       logger.error(`Could not add custom fields hook to model ${name}. `, e);
     }
   });
 };
 
-export const removeHooks = (models: ModelOptions[], getModel: ModelFetcher): void => {
+export const removeHooks = (models: Models[], getModel: ModelFetcher): void => {
   models.forEach(async ({ name }) => {
     try {
       const model = getModel(name);
@@ -81,7 +83,7 @@ const addAssociations = (model: ModelCtor, modelName: string): void => {
   CustomFieldValue.belongsTo(model, { foreignKey: 'modelId', as: modelName });
 };
 
-export const addScopes = (models: ModelOptions[], getModel: ModelFetcher): void => {
+export const addScopes = (models: Models[], getModel: ModelFetcher): void => {
   models.forEach(async ({ name, scopeAttributes }) => {
     try {
       const model = getModel(name);

package/src/utils/scopeAttributes.ts

@@ -0,0 +1,18 @@
+import { ModelOptions } from '../types';
+
+const getIdentifiers = (instance: any, scopeAttributes: string[]) => {
+  if (Array.isArray(instance)) {
+    return instance.map((ins) =>
+      scopeAttributes.map((attr) => ins[attr])).flat();
+  }
+  return scopeAttributes.map((attribute) => instance[attribute]);
+};
+const getScopeAttributes = async (instance: any, scopeAttributes: string[], scopeAttributeReplacer?: ModelOptions['scopeAttributeReplacer']) => {
+  let identifiers = getIdentifiers(instance, scopeAttributes);
+  if (scopeAttributeReplacer) {
+    identifiers = await scopeAttributeReplacer(identifiers);
+  }
+  return identifiers;
+};
+
+export default getScopeAttributes;