@autofleet/sadot 0.5.4-beta.23 → 0.5.4-beta.26

package/dist/hooks/create.js

@@ -27,6 +27,7 @@ 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");
@@ -45,12 +46,12 @@ exports.beforeBulkCreate = beforeBulkCreate;
  * TODO - cleanup if update fail
  */
 const beforeCreate = (scopeAttributes, modelOptions = {}) => async (instance, options) => {
+    logger_1.default.debug('sadot - before create hook');
     const { fields } = options;
     const modelType = instance.constructor.name;
-    const { scopeAttributeReplacer } = modelOptions;
-    const identifiers = await (0, scopeAttributes_1.default)(instance, scopeAttributes, scopeAttributeReplacer);
+    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) {
@@ -61,6 +62,7 @@ const beforeCreate = (scopeAttributes, modelOptions = {}) => async (instance, op
         }
         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.js

@@ -29,7 +29,6 @@ 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]}
@@ -46,7 +45,6 @@ const serializeCustomFields = (customFieldValues, customFieldDefinitionsHash) =>
  * A hook to attach the custom fields when fetching a model instances.
  */
 const enrichResults = (modelType, scopeAttributes, hookType, modelOptions = {}) => async (instancesOrInstance, options) => {
-    const { scopeAttributeReplacer } = modelOptions;
     if (options.originalAttributes?.length > 0
         && !options.originalAttributes?.includes?.('customFields')) {
         return;
@@ -56,20 +54,29 @@ const enrichResults = (modelType, scopeAttributes, hookType, modelOptions = {})
         ? instancesOrInstance
         : [instancesOrInstance];
     instances = instances.filter(Boolean);
-    const identifiers = await (0, scopeAttributes_1.default)(instances, scopeAttributes, scopeAttributeReplacer);
-    logger_1.default.info('enrichResults - sadot - indentifiers: ', identifiers);
+    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,
     }), {});
     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.js

@@ -46,13 +46,12 @@ exports.beforeBulkUpdate = beforeBulkUpdate;
 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 = await (0, scopeAttributes_1.default)(instance, scopeAttributes, scopeAttributeReplacer);
+    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.js

@@ -42,6 +42,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

@@ -3,8 +3,8 @@ 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 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, ContextAwareTestModel, ContextModel, 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.ContextModel = exports.ContextAwareTestModel = 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"));
@@ -15,12 +15,12 @@ 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 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, ContextAwareTestModel_1.default, ContextModel_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}`;
@@ -86,7 +86,7 @@ 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 ContextTestModel_1.default.sync({ alter: true });
     await ContextAwareTestModel_1.default.sync({ alter: true });
     logger_1.default.info('custom-fields: test models synced');
 };

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

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

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

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (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"));
+const ContextTestModel_1 = __importDefault(require("./ContextTestModel"));
 let ContextAwareTestModel = class ContextAwareTestModel extends sequelize_typescript_1.Model {
 };
 __decorate([
@@ -27,7 +27,7 @@ __decorate([
     __metadata("design:type", String)
 ], ContextAwareTestModel.prototype, "id", void 0);
 __decorate([
-    (0, sequelize_typescript_1.ForeignKey)(() => ContextModel_1.default),
+    (0, sequelize_typescript_1.ForeignKey)(() => ContextTestModel_1.default),
     (0, sequelize_typescript_1.Column)({
         type: sequelize_typescript_1.DataType.UUID,
     }),
@@ -46,8 +46,8 @@ __decorate([
     __metadata("design:type", Object)
 ], ContextAwareTestModel.prototype, "customFields", void 0);
 __decorate([
-    (0, sequelize_typescript_1.BelongsTo)(() => ContextModel_1.default),
-    __metadata("design:type", ContextModel_1.default)
+    (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 })

package/dist/models/tests/contextAwareModels/{ContextModel.d.ts → ContextTestModel.d.ts}

@@ -5,9 +5,9 @@ declare enum EEntityTypes {
     DEMAND_SOURCE = "demandSource",
     FLEET = "fleet"
 }
-declare class ContextModel extends Model {
+declare class ContextTestModel extends Model {
     id: string;
     entityId: string;
     entityType: EEntityTypes;
 }
-export default ContextModel;
+export default ContextTestModel;

package/dist/models/tests/contextAwareModels/{ContextModel.js → ContextTestModel.js}

@@ -19,7 +19,7 @@ var EEntityTypes;
     EEntityTypes["DEMAND_SOURCE"] = "demandSource";
     EEntityTypes["FLEET"] = "fleet";
 })(EEntityTypes || (EEntityTypes = {}));
-let ContextModel = class ContextModel extends sequelize_typescript_1.Model {
+let ContextTestModel = class ContextTestModel extends sequelize_typescript_1.Model {
 };
 __decorate([
     sequelize_typescript_1.PrimaryKey,
@@ -28,20 +28,20 @@ __decorate([
         type: sequelize_typescript_1.DataType.UUID,
     }),
     __metadata("design:type", String)
-], ContextModel.prototype, "id", void 0);
+], ContextTestModel.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);
+], ContextTestModel.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([
+], ContextTestModel.prototype, "entityType", void 0);
+ContextTestModel = __decorate([
     (0, sequelize_typescript_1.Table)({ createdAt: false, updatedAt: false })
-], ContextModel);
-exports.default = ContextModel;
+], ContextTestModel);
+exports.default = ContextTestModel;

package/dist/repository/definition.d.ts

@@ -1,11 +1,14 @@
-import { WhereOptions } from 'sequelize';
+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: 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 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

@@ -13,6 +13,7 @@ const findAll = (where, options = { withDisabled: false }) => {
         where,
         transaction: options.transaction,
         raw: true,
+        include: options.include,
     });
 };
 exports.findAll = findAll;
@@ -26,14 +27,21 @@ const findById = (id, options = { withDisabled: false }) => {
     return models_1.CustomFieldDefinition.scope('userScope').findByPk(id);
 };
 exports.findById = findById;
-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,
@@ -63,14 +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"));
@@ -75,13 +74,17 @@ exports.findValuesByModelIds = findValuesByModelIds;
 const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, options = {}) => {
     const names = Object.keys(valuesToUpdate);
     logger_1.default.info(`custom-fields: updating values for ${modelType} ${modelId}`, {
-        names, options, valuesToUpdate, entityId: identifiers,
+        names, options, valuesToUpdate, identifiers,
     });
-    const fieldDefinitions = await DefinitionRepo.findAll({
+    const { modelOptions, transaction } = options;
+    const where = {
         modelType,
         name: names,
-        entityId: identifiers,
-    }, { withDisabled: true, transaction: options.transaction }) || [];
+    };
+    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 });

package/dist/tests/helpers/index.js

@@ -8,7 +8,7 @@ const cleanup = async () => {
         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: {} });
+        await models_1.ContextTestModel.destroy({ where: {} });
     }
 };
 exports.cleanup = cleanup;

package/dist/types/index.d.ts

@@ -1,10 +1,24 @@
+import { IncludeOptions } from 'sequelize';
+import { ModelCtor } from 'sequelize-typescript';
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
-    scopeAttributeReplacer?: (attributes?: string[]) => Promise<(string | undefined)[]>;
+    /**
+     * 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;

package/dist/utils/init.d.ts

@@ -2,3 +2,4 @@ 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;
+export declare const applyCustomAssociation: (models: Models[]) => void;

package/dist/utils/init.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.addScopes = exports.removeHooks = exports.addHooks = void 0;
+exports.applyCustomAssociation = exports.addScopes = exports.removeHooks = exports.addHooks = void 0;
 const sequelize_1 = require("sequelize");
 const common_types_1 = require("@autofleet/common-types");
 const models_1 = require("../models");
@@ -98,3 +98,9 @@ const addScopes = (models, getModel) => {
     });
 };
 exports.addScopes = addScopes;
+const applyCustomAssociation = (models) => {
+    models.forEach(({ modelOptions }) => {
+        modelOptions?.customAssociation?.(models_1.CustomFieldDefinition);
+    });
+};
+exports.applyCustomAssociation = applyCustomAssociation;

package/dist/utils/scopeAttributes.d.ts

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

package/dist/utils/scopeAttributes.js

@@ -1,29 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = __importDefault(require("./logger"));
-const attributeCache = new Map();
 const mapAttributeToInstance = (scopeAttributes, instance) => scopeAttributes.map((attr) => instance[attr]);
-const buildAttributesByInstance = (instance, scopeAttributes) => {
+const applyScopeToInstance = (instance, scopeAttributes) => {
+    const uniqueAttributes = Array.from(new Set(scopeAttributes));
     if (Array.isArray(instance)) {
-        return instance.flatMap((ins) => mapAttributeToInstance(scopeAttributes, ins));
-    }
-    return mapAttributeToInstance(scopeAttributes, instance);
-};
-const getScopeAttributes = async (instance, scopeAttributes, scopeAttributeReplacer) => {
-    logger_1.default.info('Getting scope attributes', { instance, scopeAttributes });
-    const attributes = buildAttributesByInstance(instance, scopeAttributes);
-    const attributeCacheKey = attributes.join();
-    const cachedAttributes = attributeCache.get(attributeCacheKey);
-    if (cachedAttributes) {
-        logger_1.default.info('Using cached attributes', { cachedAttributes });
-        return cachedAttributes;
+        return instance.flatMap((ins) => mapAttributeToInstance(uniqueAttributes, ins));
     }
-    const attributeResult = (scopeAttributeReplacer
-        ? await scopeAttributeReplacer(attributes) : attributes);
-    attributeCache.set(attributeCacheKey, attributeResult);
-    return attributeResult;
+    return mapAttributeToInstance(uniqueAttributes, instance);
 };
-exports.default = getScopeAttributes;
+exports.default = applyScopeToInstance;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.5.4-beta.23",
+  "version": "0.5.4-beta.26",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/src/hooks/create.ts

@@ -1,8 +1,9 @@
+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';
+import applyScopeToInstance from '../utils/scopeAttributes';
 
 /**
  * A hook to create the custom fields when updating a model (more then one instance).
@@ -20,15 +21,16 @@ export const beforeCreate = (scopeAttributes: string[], modelOptions: ModelOptio
   instance,
   options,
 ): Promise<void> => {
+  logger.debug('sadot - before create hook');
   const { fields } = options;
   const modelType = instance.constructor.name;
-  const { scopeAttributeReplacer } = modelOptions;
 
-  const identifiers = await getScopeAttributes(instance, scopeAttributes, scopeAttributeReplacer);
+  const identifiers = applyScopeToInstance(instance, scopeAttributes);
+
   // get all model's required definitions
   const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType,
-    instance.id,
-    identifiers);
+    instance.id, identifiers, modelOptions);
+
   const customFieldsIdx = fields.indexOf('customFields');
   const { customFields } = instance;
   if (customFieldsIdx > -1 && customFields) {
@@ -45,6 +47,7 @@ export const beforeCreate = (scopeAttributes: string[], modelOptions: ModelOptio
       customFields,
       {
         transaction: options.transaction,
+        modelOptions,
       },
     );
 

package/src/hooks/enrich.ts

@@ -4,9 +4,8 @@ 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';
+import applyScopeToInstance from '../utils/scopeAttributes';
 
 type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
 
@@ -38,7 +37,6 @@ const enrichResults = (
   instancesOrInstance: any | any[],
   options,
 ): Promise<void> => {
-  const { scopeAttributeReplacer } = modelOptions;
   if (
     options.originalAttributes?.length > 0
       && !options.originalAttributes?.includes?.('customFields')
@@ -53,8 +51,7 @@ const enrichResults = (
 
   instances = instances.filter(Boolean);
 
-  const identifiers = await getScopeAttributes(instances, scopeAttributes, scopeAttributeReplacer);
-  logger.info('enrichResults - sadot - indentifiers: ', identifiers);
+  const identifiers = applyScopeToInstance(instances, scopeAttributes);
 
   const uniqueIdentifiers = [...new Set(identifiers)].filter(Boolean);
 
@@ -67,16 +64,27 @@ const enrichResults = (
   const customFieldDefinitions = await DefinitionRepo.findByEntityIds(
     modelType,
     uniqueIdentifiers,
-    { transaction: options.transaction },
+    { 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,
   }), {});
 
   customFieldDefinitions.forEach((cfd) => {
-    identifierCustomFieldDefinitionsMapping[cfd.entityId]?.push(cfd);
+    identifierCustomFieldDefinitionsMapping[cfd.entityId].push(cfd);
   });
 
   // Get the values per instates ids:

package/src/hooks/find.ts

@@ -16,7 +16,6 @@ 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,7 +1,7 @@
 import logger from '../utils/logger';
 import * as ValueRepo from '../repository/value';
 import { ModelOptions } from '../types';
-import getScopeAttributes from '../utils/scopeAttributes';
+import applyScopeToInstance from '../utils/scopeAttributes';
 
 /**
  * A hook to update the custom fields when updating a model (more then one instance).
@@ -22,9 +22,8 @@ export const beforeUpdate = (scopeAttributes: string[], modelOptions: ModelOptio
 ): Promise<void> => {
   logger.debug('sadot - before update hook');
   const { fields } = options;
-  const { scopeAttributeReplacer } = modelOptions;
   const modelType = instance.constructor.name;
-  const identifiers = await getScopeAttributes(instance, scopeAttributes, scopeAttributeReplacer);
+  const identifiers = applyScopeToInstance(instance, scopeAttributes);
 
   const customFieldsIdx = fields.indexOf('customFields');
   if (customFieldsIdx > -1) {
@@ -34,7 +33,7 @@ export const beforeUpdate = (scopeAttributes: string[], modelOptions: ModelOptio
       instance.id,
       identifiers,
       customFields,
-      { transaction: options.transaction },
+      { transaction: options.transaction, modelOptions },
 
     );
     // eslint-disable-next-line no-param-reassign

package/src/index.ts

@@ -7,7 +7,9 @@ import api from './api';
 import initDB from './utils/db';
 import logger from './utils/logger';
 import type { CustomFieldOptions, ModelFetcher } from './types';
-import { addHooks, addScopes, removeHooks } from './utils/init';
+import {
+  addHooks, addScopes, applyCustomAssociation, removeHooks,
+} from './utils/init';
 
 export * from './utils/validations/custom-fields';
 
@@ -34,6 +36,7 @@ const useCustomFields = async (
   addHooks(models, getModel);
   await initTables(sequelize, options.getUser);
   addScopes(models, getModel);
+  applyCustomAssociation(models);
   logger.debug('sadot - custom fields finished initializing with models', models);
   return sequelize;
 };

package/src/models/index.ts

@@ -6,11 +6,11 @@ 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 ContextTestModel from './tests/contextAwareModels/ContextTestModel';
 import AssociatedTestModel from './tests/AssociatedTestModel';
 
 const productionModels = [CustomFieldDefinition, CustomFieldValue];
-const testModels = [TestModel, AssociatedTestModel, ContextAwareTestModel, ContextModel];
+const testModels = [TestModel, AssociatedTestModel, ContextAwareTestModel, ContextTestModel];
 
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
 const SCHEMA_VERSION = 1;
@@ -90,7 +90,7 @@ 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 ContextTestModel.sync({ alter: true });
   await ContextAwareTestModel.sync({ alter: true });
   logger.info('custom-fields: test models synced');
 };
@@ -101,7 +101,7 @@ export {
   TestModel,
   AssociatedTestModel,
   ContextAwareTestModel,
-  ContextModel,
+  ContextTestModel,
   initTables,
   initTestModels,
 };

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

@@ -10,7 +10,7 @@ import {
   ForeignKey,
 } from 'sequelize-typescript';
 import AssociatedTestModel from '../AssociatedTestModel';
-import ContextModel from './ContextModel';
+import ContextTestModel from './ContextTestModel';
 
 @Table({ createdAt: false, updatedAt: false })
 class ContextAwareTestModel extends Model {
@@ -22,7 +22,7 @@ class ContextAwareTestModel extends Model {
     })
     id!: string;
 
-    @ForeignKey(() => ContextModel)
+  @ForeignKey(() => ContextTestModel)
     @Column({
       type: DataType.UUID,
     })
@@ -38,8 +38,8 @@ class ContextAwareTestModel extends Model {
     })
     customFields?: any;
 
-    @BelongsTo(() => ContextModel)
-    context: ContextModel;
+  @BelongsTo(() => ContextTestModel)
+  context: ContextTestModel;
 }
 
 export default ContextAwareTestModel;

package/src/models/tests/contextAwareModels/{ContextModel.ts → ContextTestModel.ts}

@@ -16,7 +16,7 @@ import {
 }
 
 @Table({ createdAt: false, updatedAt: false })
-class ContextModel extends Model {
+class ContextTestModel extends Model {
   @PrimaryKey
   @Column({
     defaultValue: DataType.UUIDV4,
@@ -35,4 +35,4 @@ class ContextModel extends Model {
     entityType: EEntityTypes;
 }
 
-export default ContextModel;
+export default ContextTestModel;

package/src/repository/definition.ts

@@ -1,8 +1,10 @@
 import {
+  FindOptions,
   Op, WhereOptions,
 } from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
+import { ModelOptions } from '../types';
 
 export const create = (data: CreateCustomFieldDefinition): Promise<CustomFieldDefinition> =>
   CustomFieldDefinition.create(data);
@@ -19,6 +21,7 @@ export const findAll = (
     where,
     transaction: options.transaction,
     raw: true,
+    include: options.include,
   });
 };
 
@@ -41,15 +44,23 @@ export const findById = (
 export const findByEntityIds = async (
   modelType: string,
   entityIds: string[],
-  options: any = {},
-): Promise<CustomFieldDefinition[]> => CustomFieldDefinition.findAll({
-  where: {
+  options: FindOptions & { modelOptions?: ModelOptions } = {},
+): Promise<CustomFieldDefinition[]> => {
+  const { include, useEntityIdFromInclude } = options.modelOptions;
+  const where: WhereOptions = {
     modelType,
-    entityId: entityIds,
-  },
-  transaction: options.transaction,
-  raw: true,
-});
+  };
+
+  if (!useEntityIdFromInclude) {
+    where.entityId = entityIds;
+  }
+  return CustomFieldDefinition.findAll({
+    where,
+    transaction: options.transaction,
+    include: include?.(entityIds),
+    raw: true,
+  });
+};
 
 export const findByWhere = (where): Promise<CustomFieldDefinition | null> =>
   CustomFieldDefinition.scope('userScope').findOne({
@@ -95,14 +106,23 @@ export const getRequiredFields = async (
   modelType: string,
   modelId: string | string[],
   entityId: string | string[],
+  modelOptions: ModelOptions = {},
 ): Promise<string[]> => {
   const entityIds = Array.isArray(entityId) ? entityId : [entityId];
+  const { include, useEntityIdFromInclude } = modelOptions;
+
+  const where: WhereOptions = {
+    modelType,
+    required: true,
+  };
+
+  if (!useEntityIdFromInclude) {
+    where.entityId = entityIds;
+  }
+
   const requiredFields = await CustomFieldDefinition.findAll({
-    where: {
-      required: true,
-      modelType,
-      entityId: { [Op.in]: entityIds },
-    },
+    where,
+    include: include?.(entityIds),
     logging: true,
   });
   const requiredFieldsNames = requiredFields.map((definition) => definition.name);

package/src/repository/value.ts

@@ -1,9 +1,11 @@
 /* eslint-disable max-len */
+import type { FindOptions, WhereOptions } from 'sequelize';
 import { CustomFieldValue, CustomFieldDefinition } from '../models';
 import * as DefinitionRepo from './definition';
 import { CreateCustomFieldValue, ValuesToUpdate } from '../types/value';
 import logger from '../utils/logger';
 import { MissingDefinitionError } from '../errors';
+import { ModelOptions } from '../types';
 
 export const findByModelIdAndDefinition = async (modelId: string, customFieldDefinitionId: string) =>
   CustomFieldValue.findAll({ where: { modelId, customFieldDefinitionId }, include: [CustomFieldDefinition] });
@@ -50,21 +52,23 @@ export const updateValues = async (
   modelId: string,
   identifiers: string[],
   valuesToUpdate: ValuesToUpdate,
-  options: any = {},
+  options: FindOptions & { modelOptions?: ModelOptions } = {},
 ): Promise<CustomFieldValue[]> => {
   const names = Object.keys(valuesToUpdate);
   logger.info(`custom-fields: updating values for ${modelType} ${modelId}`, {
-    names, options, valuesToUpdate, entityId: identifiers,
+    names, options, valuesToUpdate, identifiers,
   });
+  const { modelOptions, transaction } = options;
+
+  const where: WhereOptions = {
+    modelType,
+    name: names,
+  };
 
-  const fieldDefinitions = await DefinitionRepo.findAll(
-    {
-      modelType,
-      name: names,
-      entityId: identifiers,
-    },
-    { withDisabled: true, transaction: options.transaction },
-  ) || [];
+  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) {

package/src/tests/helpers/index.ts

@@ -1,5 +1,5 @@
 import {
-  ContextAwareTestModel, ContextModel, CustomFieldDefinition, TestModel,
+  ContextAwareTestModel, ContextTestModel, CustomFieldDefinition, TestModel,
 } from '../../models';
 
 // eslint-disable-next-line import/prefer-default-export
@@ -8,7 +8,7 @@ export const cleanup = async (): Promise<void> => {
     await CustomFieldDefinition.unscoped().destroy({ where: {} });
     await TestModel.destroy({ where: {} });
     await ContextAwareTestModel.destroy({ where: {} });
-    await ContextModel.destroy({ where: {} });
+    await ContextTestModel.destroy({ where: {} });
   }
 };
 

package/src/types/index.ts

@@ -1,11 +1,27 @@
+import { IncludeOptions } from 'sequelize';
+import { ModelCtor } from 'sequelize-typescript';
+
 export type ModelFetcher = (name: string) => any;
 
 export type ModelOptions = {
-  scopeAttributeReplacer?: (attributes?: string[]) => Promise<(string | undefined)[]>;
+  /**
+   * 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;

package/src/utils/init.ts

@@ -2,6 +2,7 @@ import { DataTypes } from 'sequelize';
 import { ModelCtor } from 'sequelize-typescript';
 import { customFields } from '@autofleet/common-types';
 import {
+  CustomFieldDefinition,
   CustomFieldValue,
 } from '../models';
 import {
@@ -103,3 +104,9 @@ export const addScopes = (models: Models[], getModel: ModelFetcher): void => {
     }
   });
 };
+
+export const applyCustomAssociation = (models: Models[]): void => {
+  models.forEach(({ modelOptions }) => {
+    modelOptions?.customAssociation?.(CustomFieldDefinition);
+  });
+};

package/src/utils/scopeAttributes.ts

@@ -1,32 +1,12 @@
-import { ModelOptions } from '../types';
-import logger from './logger';
-
-const attributeCache = new Map<string, string[]>();
-
 const mapAttributeToInstance = (scopeAttributes: string[], instance: any) =>
   scopeAttributes.map((attr) => instance[attr]);
 
-const buildAttributesByInstance = (instance: any, scopeAttributes: string[]) => {
+const applyScopeToInstance = (instance: any, scopeAttributes: string[]) => {
+  const uniqueAttributes = Array.from(new Set(scopeAttributes));
   if (Array.isArray(instance)) {
-    return instance.flatMap((ins) => mapAttributeToInstance(scopeAttributes, ins));
-  }
-  return mapAttributeToInstance(scopeAttributes, instance);
-};
-
-const getScopeAttributes = async (instance: any, scopeAttributes: string[],
-  scopeAttributeReplacer?: ModelOptions['scopeAttributeReplacer']): Promise<string[]> => {
-  logger.info('Getting scope attributes', { instance, scopeAttributes });
-  const attributes = buildAttributesByInstance(instance, scopeAttributes);
-  const attributeCacheKey = attributes.join();
-  const cachedAttributes = attributeCache.get(attributeCacheKey);
-  if (cachedAttributes) {
-    logger.info('Using cached attributes', { cachedAttributes });
-    return cachedAttributes;
+    return instance.flatMap((ins) => mapAttributeToInstance(uniqueAttributes, ins));
   }
-  const attributeResult = (scopeAttributeReplacer
-    ? await scopeAttributeReplacer(attributes) : attributes);
-  attributeCache.set(attributeCacheKey, attributeResult);
-  return attributeResult;
+  return mapAttributeToInstance(uniqueAttributes, instance);
 };
 
-export default getScopeAttributes;
+export default applyScopeToInstance;