@autofleet/sadot 0.5.5-beta.9 → 0.6.1-beta.0

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

@@ -31,6 +31,7 @@ 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,13 +45,13 @@ 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) => {
+const beforeCreate = (scopeAttributes, modelOptions = {}) => async (instance, options) => {
     logger_1.default.debug('sadot - before create hook');
     const { fields } = options;
     const modelType = instance.constructor.name;
-    const identifiers = scopeAttributes.map((attribute) => instance[attribute]);
+    const identifiers = (0, scopeAttributes_1.default)(instance, scopeAttributes);
     // get all model's required definitions
-    const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType, instance.id, identifiers);
+    const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType, instance.id, identifiers, modelOptions);
     const customFieldsIdx = fields.indexOf('customFields');
     const { customFields } = instance;
     if (customFieldsIdx > -1 && customFields) {
@@ -59,7 +60,10 @@ 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,
+            modelOptions,
+        });
         // 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[], hookType?: SupportedHookTypes, modelOptions?: ModelOptions) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
 export default enrichResults;

package/dist/hooks/enrich.js

@@ -22,10 +22,14 @@ 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 scopeAttributes_1 = __importDefault(require("../utils/scopeAttributes"));
 /**
  * Serialize custom fields value into the format of {[name] -> [fieldData]}
  */
@@ -40,7 +44,7 @@ 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, hookType, modelOptions = {}) => async (instancesOrInstance, options) => {
     if (options.originalAttributes?.length > 0
         && !options.originalAttributes?.includes?.('customFields')) {
         return;
@@ -50,14 +54,23 @@ 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 = (0, scopeAttributes_1.default)(instances, scopeAttributes);
     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, modelOptions });
+    if (modelOptions?.include && modelOptions.useEntityIdFromInclude) {
+        // if we pass useEntityIdFromInclude,
+        //  map the entity from the options to the identifierCustomFieldDefinitionsMapping
+        modelOptions.include(identifiers).forEach(({ model }) => {
+            customFieldDefinitions.forEach((cfd) => {
+                const entityId = cfd[`${model.name}.entityId`];
+                identifierCustomFieldDefinitionsMapping[entityId] = [];
+            });
+        });
+    }
     const definitionsMap = customFieldDefinitions.reduce((map, definition) => ({
         ...map,
         [definition.id]: definition,

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,15 +43,15 @@ 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 modelType = instance.constructor.name;
-    const identifiers = scopeAttributes.map((attribute) => instance[attribute]);
+    const identifiers = (0, scopeAttributes_1.default)(instance, scopeAttributes);
     const customFieldsIdx = fields.indexOf('customFields');
     if (customFieldsIdx > -1) {
         const { customFields } = instance;
-        await ValueRepo.updateValues(modelType, instance.id, identifiers, customFields, { transaction: options.transaction });
+        await ValueRepo.updateValues(modelType, instance.id, identifiers, customFields, { transaction: options.transaction, modelOptions });
         // eslint-disable-next-line no-param-reassign
         fields.splice(customFieldsIdx, 1);
     }

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import type { CustomFieldOptions, ModelFetcher } from './types';
 export * from './utils/validations/custom-fields';
 export * from './utils/constants';
 export * from './utils/helpers';
+export { CustomFieldDefinitionType } from './utils/validations/type';
 /**
  * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
  * @see {@link 'custom-fields/config'} for configurations

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.disableCustomFields = void 0;
+exports.disableCustomFields = exports.CustomFieldDefinitionType = void 0;
 const models_1 = require("./models");
 const api_1 = __importDefault(require("./api"));
 const db_1 = __importDefault(require("./utils/db"));
@@ -26,6 +26,8 @@ const init_1 = require("./utils/init");
 __exportStar(require("./utils/validations/custom-fields"), exports);
 __exportStar(require("./utils/constants"), exports);
 __exportStar(require("./utils/helpers"), exports);
+var type_1 = require("./utils/validations/type");
+Object.defineProperty(exports, "CustomFieldDefinitionType", { enumerable: true, get: function () { return type_1.CustomFieldDefinitionType; } });
 /**
  * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
  * @see {@link 'custom-fields/config'} for configurations
@@ -43,6 +45,7 @@ const useCustomFields = async (app, getModel, options) => {
     (0, init_1.addHooks)(models, getModel);
     await (0, models_1.initTables)(sequelize, options.getUser);
     (0, init_1.addScopes)(models, getModel);
+    (0, init_1.applyCustomAssociation)(models);
     logger_1.default.debug('sadot - custom fields finished initializing with models', models);
     return sequelize;
 };

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 ContextTestModel from './tests/contextAwareModels/ContextTestModel';
 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, ContextTestModel, 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.ContextTestModel = 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 ContextTestModel_1 = __importDefault(require("./tests/contextAwareModels/ContextTestModel"));
+exports.ContextTestModel = ContextTestModel_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, ContextTestModel_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 ContextTestModel_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 ContextTestModel from './ContextTestModel';
+declare class ContextAwareTestModel extends Model {
+    id: string;
+    contextId: string;
+    coolAttribute?: boolean;
+    customFields?: any;
+    context: ContextTestModel;
+}
+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 ContextTestModel_1 = __importDefault(require("./ContextTestModel"));
+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)(() => ContextTestModel_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)(() => ContextTestModel_1.default),
+    __metadata("design:type", ContextTestModel_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/ContextTestModel.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 ContextTestModel extends Model {
+    id: string;
+    entityId: string;
+    entityType: EEntityTypes;
+}
+export default ContextTestModel;

package/dist/models/tests/contextAwareModels/ContextTestModel.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 ContextTestModel = class ContextTestModel 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)
+], ContextTestModel.prototype, "id", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.UUID,
+    }),
+    __metadata("design:type", String)
+], ContextTestModel.prototype, "entityId", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.ENUM(...Object.values(EEntityTypes)),
+    }),
+    __metadata("design:type", String)
+], ContextTestModel.prototype, "entityType", void 0);
+ContextTestModel = __decorate([
+    (0, sequelize_typescript_1.Table)({ createdAt: false, updatedAt: false })
+], ContextTestModel);
+exports.default = ContextTestModel;

package/dist/repository/definition.d.ts

@@ -1,11 +1,14 @@
+import { FindOptions, WhereOptions } from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
+import { ModelOptions } from '../types';
 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 findByEntityIds: (modelType: string, entityIds: string[], options?: FindOptions & {
+    modelOptions?: ModelOptions;
+}) => Promise<CustomFieldDefinition[]>;
 export declare const findByWhere: (where: any) => Promise<CustomFieldDefinition | null>;
 export declare const findDefinitionsByModels: (modelTypes: string[], options?: any) => Promise<CustomFieldDefinition[]>;
 export declare const update: (id: string, data: UpdateCustomFieldDefinition) => Promise<CustomFieldDefinition>;
@@ -14,4 +17,4 @@ export declare const destroy: (id: string) => Promise<any>;
 /**
  * Return the names of the required fields for a given model
  */
-export declare const getRequiredFields: (modelType: string, modelId: string | string[], entityId: string | string[]) => Promise<string[]>;
+export declare const getRequiredFields: (modelType: string, modelId: string | string[], entityId: string | string[], modelOptions?: ModelOptions) => Promise<string[]>;

package/dist/repository/definition.js

@@ -1,6 +1,6 @@
 "use strict";
 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 create = (data) => models_1.CustomFieldDefinition.create(data);
@@ -13,6 +13,7 @@ const findAll = (where, options = { withDisabled: false }) => {
         where,
         transaction: options.transaction,
         raw: true,
+        include: options.include,
     });
 };
 exports.findAll = findAll;
@@ -26,19 +27,21 @@ 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: {
+const findByEntityIds = async (modelType, entityIds, options = {}) => {
+    const { include, useEntityIdFromInclude } = options.modelOptions;
+    const where = {
         modelType,
-        entityId: entityIds,
-    },
-    transaction: options.transaction,
-    raw: true,
-});
+    };
+    if (!useEntityIdFromInclude) {
+        where.entityId = entityIds;
+    }
+    return models_1.CustomFieldDefinition.findAll({
+        where,
+        transaction: options.transaction,
+        include: include?.(entityIds),
+        raw: true,
+    });
+};
 exports.findByEntityIds = findByEntityIds;
 const findByWhere = (where) => models_1.CustomFieldDefinition.scope('userScope').findOne({
     where,
@@ -68,10 +71,19 @@ exports.destroy = destroy;
 /**
  * Return the names of the required fields for a given model
  */
-const getRequiredFields = async (modelType, modelId, entityId) => {
+const getRequiredFields = async (modelType, modelId, entityId, modelOptions = {}) => {
     const entityIds = Array.isArray(entityId) ? entityId : [entityId];
+    const { include, useEntityIdFromInclude } = modelOptions;
+    const where = {
+        modelType,
+        required: true,
+    };
+    if (!useEntityIdFromInclude) {
+        where.entityId = entityIds;
+    }
     const requiredFields = await models_1.CustomFieldDefinition.findAll({
-        where: { required: true, modelType, entityId: { [sequelize_1.Op.in]: entityIds } },
+        where,
+        include: include?.(entityIds),
         logging: true,
     });
     const requiredFieldsNames = requiredFields.map((definition) => definition.name);

package/dist/repository/value.d.ts

@@ -1,5 +1,7 @@
+import type { FindOptions } from 'sequelize';
 import { CustomFieldValue } from '../models';
 import { CreateCustomFieldValue, ValuesToUpdate } from '../types/value';
+import { ModelOptions } from '../types';
 export declare const findByModelIdAndDefinition: (modelId: string, customFieldDefinitionId: string) => Promise<CustomFieldValue[]>;
 export declare const create: (data: CreateCustomFieldValue, withAssociations?: boolean) => Promise<CustomFieldValue>;
 export declare const findAllValues: () => Promise<CustomFieldValue[]>;
@@ -20,5 +22,7 @@ export declare const findValuesByModelIds: (modelIds: string[], options?: any) =
  * Create new value record if not exists, but fails if value's definition not exist.
  * Return the updated values
  */
-export declare const updateValues: (modelType: string, modelId: string, identifiers: string[], valuesToUpdate: ValuesToUpdate, options?: any) => Promise<CustomFieldValue[]>;
+export declare const updateValues: (modelType: string, modelId: string, identifiers: string[], valuesToUpdate: ValuesToUpdate, options?: FindOptions & {
+    modelOptions?: ModelOptions;
+}) => Promise<CustomFieldValue[]>;
 export declare const deleteValue: (id: string, options?: any) => Promise<any>;

package/dist/repository/value.js

@@ -27,7 +27,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteValue = exports.updateValues = exports.findValuesByModelIds = exports.findValuesByModelId = exports.findAllValues = exports.create = exports.findByModelIdAndDefinition = void 0;
-/* eslint-disable max-len */
 const models_1 = require("../models");
 const DefinitionRepo = __importStar(require("./definition"));
 const logger_1 = __importDefault(require("../utils/logger"));
@@ -73,11 +72,22 @@ 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, identifiers,
+    });
+    const { modelOptions, transaction } = options;
+    const where = {
+        modelType,
+        name: names,
+    };
+    if (!options.modelOptions?.useEntityIdFromInclude) {
+        where.entityId = identifiers;
+    }
+    const fieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true, transaction, include: modelOptions.include?.(identifiers) }) || [];
     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 });
         const missingDefinitions = names.filter((name) => !fieldDefinitions.some((def) => def.name === name));
         throw new errors_1.MissingDefinitionError(missingDefinitions);
     }

package/dist/tests/functional/searching/index.js

@@ -23,7 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const sequelize_1 = require("sequelize");
 const index_1 = require("../../../index");
 const DefinitionRepo = __importStar(require("../../../repository/definition"));
 const definition_mock_1 = require("../../mocks/definition.mock");
@@ -35,8 +34,7 @@ const customFieldsSearchTestFlow = async ({ fieldType, fieldValue, searchTerm, e
     const [testModel1] = await (0, testModel_1.createTestModels)(definition.entityId, 2);
     await testModel1.update({ customFields: { [definition.name]: fieldValue } });
     const models = await models_1.TestModel.findAndCountAll({
-        where: { [sequelize_1.Op.or]: [(0, index_1.buildCustomFieldsSearchWhereClause)(models_1.TestModel, definition.entityId)] },
-        replacements: { searchTerm: `%${searchTerm}%` },
+        ...(0, index_1.generateCustomFieldSearchQueryPayload)(searchTerm, models_1.TestModel, definition.entityId),
     });
     expect(models.count).toBe(expectedNumberOfQueryResults);
     if (expectedNumberOfQueryResults > 0) {

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.ContextTestModel.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/types/index.d.ts

@@ -1,13 +1,31 @@
+import { IncludeOptions } from 'sequelize';
+import { ModelCtor } from 'sequelize-typescript';
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
+    /**
+     * Include options for the model
+     */
+    include?: (entityIds: string[]) => IncludeOptions[];
+    /**
+      * Custom association for the model
+      * @param model - The model to associate with
+     */
+    customAssociation?: (model: ModelCtor) => void;
+    /**
+     * Whether to use the entity id  from the instance per scope attribute
+     */
+    useEntityIdFromInclude?: boolean;
+};
+export type Models = {
     name: string;
-    scopeAttributes: string[];
+    scopeAttributes: any[];
+    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;
 };