@autofleet/sadot 0.8.6 → 0.9.0

package/dist/errors/index.d.ts

@@ -1,5 +1,6 @@
 import { BadRequest } from '@autofleet/errors';
 import type { ValidationError } from 'joi';
+import type { EntriesValidationError } from '../types/entries';
 export declare class MissingRequiredCustomFieldError extends BadRequest {
     constructor(missingFields: string[]);
 }
@@ -15,6 +16,9 @@ export declare class InvalidFieldTypeError extends BadRequest {
 export declare class InvalidValueError extends BadRequest {
     constructor(value: any, fieldDefinitionName: string, joiValidationError: ValidationError);
 }
+export declare class InvalidEntriesError extends BadRequest {
+    constructor(modelId: string, validationErrors: EntriesValidationError[]);
+}
 export declare class MissingDefinitionError extends BadRequest {
     constructor(fieldNames: string[]);
 }

package/dist/errors/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MissingDefinitionError = exports.InvalidValueError = exports.InvalidFieldTypeError = exports.UnsupportedCustomValidationError = exports.UnsupportedCustomFieldTypeError = exports.MissingRequiredCustomFieldError = void 0;
+exports.MissingDefinitionError = exports.InvalidEntriesError = exports.InvalidValueError = exports.InvalidFieldTypeError = exports.UnsupportedCustomValidationError = exports.UnsupportedCustomFieldTypeError = exports.MissingRequiredCustomFieldError = void 0;
 /* eslint-disable max-classes-per-file */
 const errors_1 = require("@autofleet/errors");
 class MissingRequiredCustomFieldError extends errors_1.BadRequest {
@@ -48,6 +48,14 @@ class InvalidValueError extends errors_1.BadRequest {
     }
 }
 exports.InvalidValueError = InvalidValueError;
+class InvalidEntriesError extends errors_1.BadRequest {
+    constructor(modelId, validationErrors) {
+        const errors = validationErrors.map((validationError) => new InvalidValueError(validationError.value, validationError.fieldDefinitionName, validationError.joiValidationError));
+        super(errors, null, null);
+        this.message = `Invalid entries on ${modelId}`;
+    }
+}
+exports.InvalidEntriesError = InvalidEntriesError;
 class MissingDefinitionError extends errors_1.BadRequest {
     constructor(fieldNames) {
         const err = new Error(`Missing custom field definition for field ${fieldNames.join(',')}`);

package/dist/events/index.js

@@ -27,6 +27,10 @@ const modelTableMapping = {
         tableName: 'dim_custom_field_value',
         eventVersion: '1',
     },
+    CustomFieldEntries: {
+        tableName: 'dim_custom_field_entries',
+        eventVersion: '1',
+    },
 };
 const sendDimEvent = (instance) => {
     const mapping = modelTableMapping[instance.constructor.name];

package/dist/index.js

@@ -31,7 +31,7 @@ __exportStar(require("./utils/helpers"), exports);
  * @see {@link 'custom-fields/config'} for configurations
  */
 const useCustomFields = async (app, getModel, options) => {
-    const { models } = options;
+    const { models, useCustomFieldsEntries } = options;
     if (app) {
         app.use('/api', api_1.default);
     }
@@ -41,7 +41,7 @@ const useCustomFields = async (app, getModel, options) => {
     }
     // The order is important
     (0, init_1.addHooks)(models, getModel);
-    await (0, models_1.initTables)(sequelize, options.getUser);
+    await (0, models_1.initTables)(sequelize, options.getUser, { useCustomFieldsEntries });
     (0, init_1.addScopes)(models, getModel);
     (0, init_1.applyCustomAssociation)(models);
     logger_1.default.debug('sadot - custom fields finished initializing with models', models);

package/dist/models/CustomFieldEntries.d.ts

@@ -0,0 +1,15 @@
+import { Model } from 'sequelize-typescript';
+declare class CustomFieldEntries extends Model {
+    /** The ID of the model of which this row hold the custom field entries of, e.g. vehicleId / stopPointId / etc.  */
+    modelId: string;
+    /** The ID of the entity of which this row hold the custom field entries of, e.g. fleetId / etc.  */
+    entityId: string;
+    /** A dictionary of customFields and values with the following structure: `{ customFieldName: 'CustomFieldValue' }` */
+    customFields: Record<string, any>;
+    /** The type of model which this custom field entry represents. e.g. Vehicle / StopPoint / etc. */
+    modelType: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    static afterSaveHandler(instance: CustomFieldEntries, options: any): void;
+}
+export default CustomFieldEntries;

package/dist/models/CustomFieldEntries.js

@@ -0,0 +1,123 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __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 __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __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 });
+const sequelize_typescript_1 = require("sequelize-typescript");
+const events_1 = require("../events");
+const CustomFieldDefinitionRepo = __importStar(require("../repository/definition"));
+const validations_1 = require("../utils/validations");
+let CustomFieldEntries = class CustomFieldEntries extends sequelize_typescript_1.Model {
+    static afterSaveHandler(instance, options) {
+        if (options.transaction) {
+            options.transaction.afterCommit(() => (0, events_1.sendDimEvent)(instance[0]));
+        }
+        else {
+            (0, events_1.sendDimEvent)(instance[0]);
+        }
+    }
+};
+__decorate([
+    sequelize_typescript_1.PrimaryKey,
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.UUID,
+        allowNull: false,
+    })
+    /** The ID of the model of which this row hold the custom field entries of, e.g. vehicleId / stopPointId / etc.  */
+    ,
+    __metadata("design:type", String)
+], CustomFieldEntries.prototype, "modelId", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.UUID,
+        allowNull: false,
+    })
+    /** The ID of the entity of which this row hold the custom field entries of, e.g. fleetId / etc.  */
+    ,
+    __metadata("design:type", String)
+], CustomFieldEntries.prototype, "entityId", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.JSONB,
+        allowNull: false,
+        defaultValue: {},
+    })
+    /** A dictionary of customFields and values with the following structure: `{ customFieldName: 'CustomFieldValue' }` */
+    ,
+    __metadata("design:type", Object)
+], CustomFieldEntries.prototype, "customFields", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.STRING,
+        allowNull: false,
+    })
+    /** The type of model which this custom field entry represents. e.g. Vehicle / StopPoint / etc. */
+    ,
+    __metadata("design:type", String)
+], CustomFieldEntries.prototype, "modelType", void 0);
+__decorate([
+    sequelize_typescript_1.Column,
+    __metadata("design:type", Date)
+], CustomFieldEntries.prototype, "createdAt", void 0);
+__decorate([
+    sequelize_typescript_1.Column,
+    __metadata("design:type", Date)
+], CustomFieldEntries.prototype, "updatedAt", void 0);
+__decorate([
+    sequelize_typescript_1.AfterUpsert,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [CustomFieldEntries, Object]),
+    __metadata("design:returntype", void 0)
+], CustomFieldEntries, "afterSaveHandler", null);
+CustomFieldEntries = __decorate([
+    (0, sequelize_typescript_1.Table)({
+        timestamps: true,
+        indexes: [
+            {
+                name: 'idx_cfe_custom_fields',
+                using: 'gin',
+                operator: 'jsonb_path_ops',
+                fields: ['custom_fields'],
+            },
+        ],
+        validate: {
+            async validationByType() {
+                if (!Object.keys(this.customFields ?? {}).length) {
+                    return;
+                }
+                const definitionsByName = await CustomFieldDefinitionRepo.getCustomFieldDefinitionsDictionary([this]);
+                (0, validations_1.validateInstanceCustomFieldEntries)(this, definitionsByName);
+            },
+        },
+    })
+], CustomFieldEntries);
+exports.default = CustomFieldEntries;

package/dist/models/index.d.ts

@@ -6,9 +6,12 @@ import ContextAwareTestModel from './tests/contextAwareModels/ContextAwareTestMo
 import ContextTestModel from './tests/contextAwareModels/ContextTestModel';
 import AssociatedTestModel from './tests/AssociatedTestModel';
 import type { CustomFieldOptions } from '../types';
-declare const initTables: (sequelize: Sequelize, getUser: CustomFieldOptions['getUser'], { schemaPrefix, schemaVersion }?: {
-    schemaPrefix: string;
-    schemaVersion: string;
-}) => Promise<void>;
+import CustomFieldEntries from './CustomFieldEntries';
+interface InitTablesOptions {
+    schemaPrefix?: string;
+    schemaVersion?: string;
+    useCustomFieldsEntries?: boolean;
+}
+declare const initTables: (sequelize: Sequelize, getUser: CustomFieldOptions['getUser'], { schemaPrefix, schemaVersion, useCustomFieldsEntries, }?: InitTablesOptions) => Promise<void>;
 declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
-export { CustomFieldValue, CustomFieldDefinition, TestModel, AssociatedTestModel, ContextAwareTestModel, ContextTestModel, initTables, initTestModels, };
+export { CustomFieldValue, CustomFieldDefinition, CustomFieldEntries, 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.ContextTestModel = 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.CustomFieldEntries = exports.CustomFieldDefinition = exports.CustomFieldValue = void 0;
 /* eslint-disable no-param-reassign */
 const sequelize_1 = require("sequelize");
 const logger_1 = __importDefault(require("../utils/logger"));
@@ -19,18 +19,27 @@ const ContextTestModel_1 = __importDefault(require("./tests/contextAwareModels/C
 exports.ContextTestModel = ContextTestModel_1.default;
 const AssociatedTestModel_1 = __importDefault(require("./tests/AssociatedTestModel"));
 exports.AssociatedTestModel = AssociatedTestModel_1.default;
+const CustomFieldEntries_1 = __importDefault(require("./CustomFieldEntries"));
+exports.CustomFieldEntries = CustomFieldEntries_1.default;
 const productionModels = [CustomFieldDefinition_1.default, CustomFieldValue_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 = 'fb0fa867-1241-4816-b08d-5ed9060c7ae5';
-const initTables = async (sequelize, getUser, { schemaPrefix, schemaVersion } = { schemaPrefix: SADOT_MIGRATION_PREFIX, schemaVersion: SCHEMA_VERSION }) => {
-    const CUSTOM_FIELDS_SCHEMA_VERSION = `${schemaPrefix}_${schemaVersion}`;
+const initTables = async (sequelize, getUser, { schemaPrefix, schemaVersion, useCustomFieldsEntries, } = {
+    schemaPrefix: SADOT_MIGRATION_PREFIX,
+    schemaVersion: SCHEMA_VERSION,
+    useCustomFieldsEntries: false,
+}) => {
+    const CUSTOM_FIELDS_SCHEMA_VERSION = `${schemaPrefix}_${schemaVersion}${useCustomFieldsEntries ? '_withEntries' : ''}`;
     logger_1.default.info('custom-fields: initialize custom-fields tables');
     // Detect models and import them to the orm
     // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
     if (!sequelize.addModels) {
         throw new Error('sequelize instance must have addModels function');
     }
+    if (useCustomFieldsEntries) {
+        productionModels.push(CustomFieldEntries_1.default);
+    }
     sequelize.addModels(productionModels);
     CustomFieldDefinition_1.default.addScope('userScope', () => {
         const user = getUser();
@@ -67,6 +76,10 @@ const initTables = async (sequelize, getUser, { schemaPrefix, schemaVersion } =
     if (!currentSadotSchemaVersion || currentSadotSchemaVersion.name !== CUSTOM_FIELDS_SCHEMA_VERSION) {
         await CustomFieldDefinition_1.default.sync({ alter: true });
         await CustomFieldValue_1.default.sync({ alter: true });
+        // T.Y TODO: Remove the if statement once we're ready to add the new entries table for all MS
+        if (useCustomFieldsEntries) {
+            await CustomFieldEntries_1.default.sync({ alter: true });
+        }
         if (expectedSchemaVersionIndex === -1) {
             await SequelizeMeta.create({ name: CUSTOM_FIELDS_SCHEMA_VERSION });
         }

package/dist/repository/definition.d.ts

@@ -1,5 +1,5 @@
 import { type Includeable, type Transaction, type FindOptions, type WhereOptions } from 'sequelize';
-import { CustomFieldDefinition } from '../models';
+import { CustomFieldDefinition, type CustomFieldEntries } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
 import type { ModelOptions } from '../types';
 export declare const create: (data: CreateCustomFieldDefinition) => Promise<CustomFieldDefinition>;
@@ -8,6 +8,9 @@ interface SadotFindOptions {
     transaction?: Transaction;
     include?: Includeable | Includeable[];
 }
+type SadotGetDefinitionsByEntityIdsOptions = FindOptions & {
+    modelOptions?: ModelOptions;
+} & Pick<SadotFindOptions, 'withDisabled'>;
 export declare const findAll: (where: WhereOptions, options?: SadotFindOptions) => Promise<CustomFieldDefinition[]>;
 export declare const findByIds: (ids: string[], options?: SadotFindOptions) => Promise<CustomFieldDefinition[]>;
 export declare const findById: (id: string, options?: Pick<SadotFindOptions, 'withDisabled'>) => Promise<CustomFieldDefinition | null>;
@@ -23,4 +26,11 @@ export declare const destroy: (id: string) => Promise<number>;
  * Return the names of the required fields for a given model
  */
 export declare const getRequiredFields: (modelType: string, modelId: string | string[], entityId: string | string[], modelOptions?: ModelOptions) => Promise<string[]>;
+/**
+ * @returns A promise resolving with a dictionary of custom field definitions by name.
+ * @throws A {@link MissingDefinitionError} if any of the custom fields doesn't have a definition.
+ */
+export declare const getCustomFieldDefinitionsDictionary: (instances: CustomFieldEntries[], options?: SadotGetDefinitionsByEntityIdsOptions) => Promise<{
+    [definitionName: string]: CustomFieldDefinition;
+}>;
 export {};

package/dist/repository/definition.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRequiredFields = exports.destroy = exports.disable = exports.update = exports.findDefinitionsByModels = exports.findByWhere = exports.findByEntityIds = exports.findById = exports.findByIds = exports.findAll = exports.create = void 0;
+exports.getCustomFieldDefinitionsDictionary = 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 errors_1 = require("../errors");
 const create = (data) => models_1.CustomFieldDefinition.create(data);
 exports.create = create;
 const findAll = (where, options = { withDisabled: false }) => {
@@ -86,3 +87,30 @@ const getRequiredFields = async (modelType, modelId, entityId, modelOptions = {}
     return [...new Set(requiredFieldsNames)];
 };
 exports.getRequiredFields = getRequiredFields;
+/**
+ * @returns A promise resolving with a dictionary of custom field definitions by name.
+ * @throws A {@link MissingDefinitionError} if any of the custom fields doesn't have a definition.
+ */
+const getCustomFieldDefinitionsDictionary = async (instances, options = { withDisabled: false, modelOptions: {} }) => {
+    const { modelType } = instances[0]?.dataValues ?? {};
+    const customFields = new Set();
+    const modelIds = [];
+    const entityIds = new Set();
+    instances.forEach((instance) => {
+        const { dataValues: { modelId, entityId, customFields: instanceCustomFields } } = instance;
+        modelIds.push(modelId);
+        entityIds.add(entityId);
+        Object.keys(instanceCustomFields ?? {}).forEach((fieldName) => {
+            customFields.add(fieldName);
+        });
+    });
+    const definitions = await (0, exports.findByEntityIds)(modelType, Array.from(entityIds), { ...options });
+    const matchedDefinitions = definitions.filter((def) => customFields.has(def.name));
+    const matchedDefinitionsByName = Object.fromEntries(matchedDefinitions.map((definition) => [definition.name, definition]));
+    if (!definitions?.length || matchedDefinitions.length !== customFields.size) {
+        const unmatchedCustomFields = Array.from(customFields).filter((customField) => !matchedDefinitionsByName[customField]);
+        throw new errors_1.MissingDefinitionError(unmatchedCustomFields);
+    }
+    return matchedDefinitionsByName;
+};
+exports.getCustomFieldDefinitionsDictionary = getCustomFieldDefinitionsDictionary;

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

@@ -16,9 +16,9 @@ export declare const coolFieldDefinition2: {
     deletedAt?: Date;
     defaultValue?: any;
     blockEditingFromUI?: boolean;
-    displayName?: string;
     validation?: any;
     fieldType: string;
+    displayName?: string;
     entityId: string;
     entityType: string;
     modelType: string;
@@ -33,9 +33,9 @@ export declare const coolFieldDefinition3: {
     deletedAt?: Date;
     defaultValue?: any;
     blockEditingFromUI?: boolean;
-    displayName?: string;
     validation?: any;
     fieldType: string;
+    displayName?: string;
     entityId: string;
     entityType: string;
     modelType: string;

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

@@ -1,3 +1,4 @@
 export declare const mockEvent: (events: any, eventName: any, numberOfEvents: any) => any[];
 export declare const mockDimCustomFieldDefinitionEvent: (events: any, numberOfEvents: any) => any[];
 export declare const mockDimCustomFieldValueEvent: (events: any, numberOfEvents: any) => any[];
+export declare const mockDimCustomFieldEntriesEvent: (events: any, numberOfEvents: any) => any[];

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

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable no-param-reassign */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mockDimCustomFieldValueEvent = exports.mockDimCustomFieldDefinitionEvent = exports.mockEvent = void 0;
+exports.mockDimCustomFieldEntriesEvent = exports.mockDimCustomFieldValueEvent = exports.mockDimCustomFieldDefinitionEvent = exports.mockEvent = void 0;
 const mockEvent = (events, eventName, numberOfEvents) => {
     events.sendObject = jest.fn();
     return [
@@ -17,3 +17,5 @@ const mockDimCustomFieldDefinitionEvent = (events, numberOfEvents) => (0, export
 exports.mockDimCustomFieldDefinitionEvent = mockDimCustomFieldDefinitionEvent;
 const mockDimCustomFieldValueEvent = (events, numberOfEvents) => (0, exports.mockEvent)(events, 'dim_custom_field_value', numberOfEvents);
 exports.mockDimCustomFieldValueEvent = mockDimCustomFieldValueEvent;
+const mockDimCustomFieldEntriesEvent = (events, numberOfEvents) => (0, exports.mockEvent)(events, 'dim_custom_field_entries', numberOfEvents);
+exports.mockDimCustomFieldEntriesEvent = mockDimCustomFieldEntriesEvent;

package/dist/types/entries/index.d.ts

@@ -0,0 +1,25 @@
+import type { ValidationError } from 'joi';
+export interface CustomFieldEntriesDTO {
+    modelId: string;
+    entityId: string;
+    modelType: string;
+    /**
+     * A collection of custom fields where each key is the name of a CustomFieldDefinition and
+     * each value is the value of that custom field for this specific `modelId`.
+     *
+     * Example:
+     * {
+     *   "vehicleColor": "Red",
+     *   "vehicleType": "premium",
+     *   "isActive": true
+     * }
+     */
+    customFields: Record<string, any>;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface EntriesValidationError {
+    value: any;
+    fieldDefinitionName: string;
+    joiValidationError: ValidationError;
+}

package/dist/types/entries/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -30,4 +30,5 @@ export type CustomFieldOptions = {
     databaseConfig: any;
     getUser: typeof GetUserType;
     sequelize?: Sequelize;
+    useCustomFieldsEntries?: boolean;
 };

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

@@ -1,3 +1,8 @@
+import type { CustomFieldDefinition } from '../../models';
+import type { CustomFieldEntriesDTO } from '../../types/entries';
 import type { CustomFieldDefinitionType } from '../constants';
 export declare const validateFieldType: (type: CustomFieldDefinitionType) => boolean;
 export declare const validateValue: (value: unknown, valueType: CustomFieldDefinitionType, validation?: unknown) => import("joi").ValidationResult;
+export declare const validateInstanceCustomFieldEntries: (instance: CustomFieldEntriesDTO, definitionsByName: {
+    [defName: string]: CustomFieldDefinition;
+}) => void;

package/dist/utils/validations/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateValue = exports.validateFieldType = void 0;
+exports.validateInstanceCustomFieldEntries = exports.validateValue = exports.validateFieldType = void 0;
+const errors_1 = require("../../errors");
 const validators_1 = require("./validators");
 const validateFieldType = (type) => Object.keys(validators_1.validators).includes(type);
 exports.validateFieldType = validateFieldType;
@@ -15,3 +16,23 @@ const validateValue = (value, valueType, validation) => {
      */
 };
 exports.validateValue = validateValue;
+const validateInstanceCustomFieldEntries = (instance, definitionsByName) => {
+    const validationErrors = Object.entries(instance.customFields)
+        .map(([customFieldName, value]) => {
+        const { validation, fieldType } = definitionsByName[customFieldName];
+        const result = (0, exports.validateValue)(value, fieldType, validation);
+        if (result?.error) {
+            return {
+                joiValidationError: result.error,
+                fieldDefinitionName: customFieldName,
+                value,
+            };
+        }
+        return null;
+    })
+        .filter((result) => !!result);
+    if (validationErrors?.length) {
+        throw new errors_1.InvalidEntriesError(instance.modelId, validationErrors);
+    }
+};
+exports.validateInstanceCustomFieldEntries = validateInstanceCustomFieldEntries;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.8.6",
+  "version": "0.9.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/src/errors/index.ts

@@ -1,6 +1,7 @@
 /* eslint-disable max-classes-per-file */
 import { BadRequest } from '@autofleet/errors';
 import type { ValidationError } from 'joi';
+import type { EntriesValidationError } from '../types/entries';
 
 export class MissingRequiredCustomFieldError extends BadRequest {
   constructor(missingFields: string[]) {
@@ -50,6 +51,14 @@ export class InvalidValueError extends BadRequest {
   }
 }
 
+export class InvalidEntriesError extends BadRequest {
+  constructor(modelId: string, validationErrors: EntriesValidationError[]) {
+    const errors = validationErrors.map((validationError) => new InvalidValueError(validationError.value, validationError.fieldDefinitionName, validationError.joiValidationError));
+    super(errors, null, null);
+    this.message = `Invalid entries on ${modelId}`;
+  }
+}
+
 export class MissingDefinitionError extends BadRequest {
   constructor(fieldNames: string[]) {
     const err = new Error(`Missing custom field definition for field ${fieldNames.join(',')}`);

package/src/events/index.ts

@@ -25,6 +25,10 @@ const modelTableMapping = {
     tableName: 'dim_custom_field_value',
     eventVersion: '1',
   },
+  CustomFieldEntries: {
+    tableName: 'dim_custom_field_entries',
+    eventVersion: '1',
+  },
 };
 
 export const sendDimEvent = (instance): void => {

package/src/index.ts

@@ -26,7 +26,7 @@ const useCustomFields = async (
   getModel: ModelFetcher,
   options: CustomFieldOptions,
 ): Promise<Sequelize> => {
-  const { models } = options;
+  const { models, useCustomFieldsEntries } = options;
   if (app) {
     app.use('/api', api);
   }
@@ -36,7 +36,7 @@ const useCustomFields = async (
   }
   // The order is important
   addHooks(models, getModel);
-  await initTables(sequelize, options.getUser);
+  await initTables(sequelize, options.getUser, { useCustomFieldsEntries });
   addScopes(models, getModel);
   applyCustomAssociation(models);
   logger.debug('sadot - custom fields finished initializing with models', models);

package/src/models/CustomFieldEntries.ts

@@ -0,0 +1,81 @@
+import {
+  Table,
+  Column,
+  Model,
+  PrimaryKey,
+  DataType,
+  AfterUpsert,
+} from 'sequelize-typescript';
+import { sendDimEvent } from '../events';
+import * as CustomFieldDefinitionRepo from '../repository/definition';
+import { validateInstanceCustomFieldEntries } from '../utils/validations';
+
+@Table({
+  timestamps: true,
+  indexes: [
+    {
+      name: 'idx_cfe_custom_fields',
+      using: 'gin',
+      operator: 'jsonb_path_ops',
+      fields: ['custom_fields'],
+    },
+  ],
+  validate: {
+    async validationByType(this: CustomFieldEntries) {
+      if (!Object.keys(this.customFields ?? {}).length) {
+        return;
+      }
+
+      const definitionsByName = await CustomFieldDefinitionRepo.getCustomFieldDefinitionsDictionary([this]);
+      validateInstanceCustomFieldEntries(this, definitionsByName);
+    },
+  },
+})
+class CustomFieldEntries extends Model {
+  @PrimaryKey
+  @Column({
+    type: DataType.UUID,
+    allowNull: false,
+  })
+    /** The ID of the model of which this row hold the custom field entries of, e.g. vehicleId / stopPointId / etc.  */
+    modelId!: string;
+
+  @Column({
+    type: DataType.UUID,
+    allowNull: false,
+  })
+    /** The ID of the entity of which this row hold the custom field entries of, e.g. fleetId / etc.  */
+    entityId!: string;
+
+  @Column({
+    type: DataType.JSONB,
+    allowNull: false,
+    defaultValue: {},
+  })
+    /** A dictionary of customFields and values with the following structure: `{ customFieldName: 'CustomFieldValue' }` */
+    customFields!: Record<string, any>;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false,
+  })
+    /** The type of model which this custom field entry represents. e.g. Vehicle / StopPoint / etc. */
+    modelType!: string;
+
+  @Column
+    createdAt?: Date;
+
+  @Column
+    updatedAt?: Date;
+
+  @AfterUpsert
+  static afterSaveHandler(instance: CustomFieldEntries, options): void {
+    if (options.transaction) {
+      options.transaction.afterCommit(() => sendDimEvent(instance[0]));
+    } else {
+      sendDimEvent(instance[0]);
+    }
+  }
+}
+
+export default CustomFieldEntries;

package/src/models/index.ts

@@ -9,8 +9,16 @@ import ContextAwareTestModel from './tests/contextAwareModels/ContextAwareTestMo
 import ContextTestModel from './tests/contextAwareModels/ContextTestModel';
 import AssociatedTestModel from './tests/AssociatedTestModel';
 import type { CustomFieldOptions } from '../types';
+import CustomFieldEntries from './CustomFieldEntries';
 
-const productionModels = [CustomFieldDefinition, CustomFieldValue];
+type ProductionModel = typeof CustomFieldDefinition | typeof CustomFieldValue | typeof CustomFieldEntries
+interface InitTablesOptions {
+  schemaPrefix?: string
+  schemaVersion?: string
+  useCustomFieldsEntries?: boolean
+}
+
+const productionModels: ProductionModel[] = [CustomFieldDefinition, CustomFieldValue];
 const testModels = [TestModel, AssociatedTestModel, ContextAwareTestModel, ContextTestModel];
 
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
@@ -19,15 +27,28 @@ const SCHEMA_VERSION = 'fb0fa867-1241-4816-b08d-5ed9060c7ae5';
 const initTables = async (
   sequelize: Sequelize,
   getUser: CustomFieldOptions['getUser'],
-  { schemaPrefix, schemaVersion } = { schemaPrefix: SADOT_MIGRATION_PREFIX, schemaVersion: SCHEMA_VERSION },
+  {
+    schemaPrefix,
+    schemaVersion,
+    useCustomFieldsEntries,
+  }: InitTablesOptions = {
+    schemaPrefix: SADOT_MIGRATION_PREFIX,
+    schemaVersion: SCHEMA_VERSION,
+    useCustomFieldsEntries: false,
+  },
 ): Promise<void> => {
-  const CUSTOM_FIELDS_SCHEMA_VERSION = `${schemaPrefix}_${schemaVersion}`;
+  const CUSTOM_FIELDS_SCHEMA_VERSION = `${schemaPrefix}_${schemaVersion}${useCustomFieldsEntries ? '_withEntries' : ''}`;
   logger.info('custom-fields: initialize custom-fields tables');
   // Detect models and import them to the orm
   // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
   if (!sequelize.addModels) {
     throw new Error('sequelize instance must have addModels function');
   }
+
+  if (useCustomFieldsEntries) {
+    productionModels.push(CustomFieldEntries);
+  }
+
   sequelize.addModels(productionModels);
 
   CustomFieldDefinition.addScope('userScope', () => {
@@ -73,6 +94,11 @@ const initTables = async (
   if (!currentSadotSchemaVersion || (currentSadotSchemaVersion as any).name !== CUSTOM_FIELDS_SCHEMA_VERSION) {
     await CustomFieldDefinition.sync({ alter: true });
     await CustomFieldValue.sync({ alter: true });
+    // T.Y TODO: Remove the if statement once we're ready to add the new entries table for all MS
+    if (useCustomFieldsEntries) {
+      await CustomFieldEntries.sync({ alter: true });
+    }
+
     if (expectedSchemaVersionIndex === -1) {
       await SequelizeMeta.create({ name: CUSTOM_FIELDS_SCHEMA_VERSION });
     }
@@ -109,6 +135,7 @@ const initTestModels = async (sequelize: Sequelize): Promise<void> => {
 export {
   CustomFieldValue,
   CustomFieldDefinition,
+  CustomFieldEntries,
   TestModel,
   AssociatedTestModel,
   ContextAwareTestModel,

package/src/repository/definition.ts

@@ -2,9 +2,10 @@ import {
   Op,
   type Includeable, type Transaction, type FindOptions, type WhereOptions,
 } from 'sequelize';
-import { CustomFieldDefinition } from '../models';
+import { CustomFieldDefinition, type CustomFieldEntries } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
 import type { ModelOptions } from '../types';
+import { MissingDefinitionError } from '../errors';
 
 export const create = (data: CreateCustomFieldDefinition): Promise<CustomFieldDefinition> =>
   CustomFieldDefinition.create(data);
@@ -15,6 +16,8 @@ interface SadotFindOptions {
   include?: Includeable | Includeable[];
 }
 
+type SadotGetDefinitionsByEntityIdsOptions = FindOptions & { modelOptions?: ModelOptions } & Pick<SadotFindOptions, 'withDisabled'>;
+
 export const findAll = (
   where: WhereOptions,
   options: SadotFindOptions = { withDisabled: false },
@@ -129,3 +132,38 @@ export const getRequiredFields = async (
   const requiredFieldsNames = requiredFields.map((definition) => definition.name);
   return [...new Set(requiredFieldsNames)];
 };
+
+/**
+ * @returns A promise resolving with a dictionary of custom field definitions by name.
+ * @throws A {@link MissingDefinitionError} if any of the custom fields doesn't have a definition.
+ */
+export const getCustomFieldDefinitionsDictionary = async (
+  instances: CustomFieldEntries[],
+  options: SadotGetDefinitionsByEntityIdsOptions = { withDisabled: false, modelOptions: {} },
+): Promise<{ [definitionName: string]: CustomFieldDefinition }> => {
+  const { modelType } = instances[0]?.dataValues ?? {};
+  const customFields = new Set<string>();
+  const modelIds = [];
+  const entityIds = new Set<string>();
+  instances.forEach((instance) => {
+    const { dataValues: { modelId, entityId, customFields: instanceCustomFields } } = instance;
+    modelIds.push(modelId);
+    entityIds.add(entityId);
+
+    Object.keys(instanceCustomFields ?? {}).forEach((fieldName) => {
+      customFields.add(fieldName);
+    });
+  });
+
+  const definitions = await findByEntityIds(modelType, Array.from(entityIds), { ...options });
+
+  const matchedDefinitions = definitions.filter((def) => customFields.has(def.name));
+  const matchedDefinitionsByName = Object.fromEntries(matchedDefinitions.map((definition) => [definition.name, definition]));
+
+  if (!definitions?.length || matchedDefinitions.length !== customFields.size) {
+    const unmatchedCustomFields = Array.from(customFields).filter((customField) => !matchedDefinitionsByName[customField]);
+    throw new MissingDefinitionError(unmatchedCustomFields);
+  }
+
+  return matchedDefinitionsByName;
+};

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

@@ -16,3 +16,6 @@ export const mockDimCustomFieldDefinitionEvent = (events, numberOfEvents) =>
 
 export const mockDimCustomFieldValueEvent = (events, numberOfEvents) =>
   mockEvent(events, 'dim_custom_field_value', numberOfEvents);
+
+export const mockDimCustomFieldEntriesEvent = (events, numberOfEvents) =>
+  mockEvent(events, 'dim_custom_field_entries', numberOfEvents);

package/src/types/entries/index.ts

@@ -0,0 +1,27 @@
+import type { ValidationError } from 'joi';
+
+export interface CustomFieldEntriesDTO {
+  modelId: string;
+  entityId: string;
+  modelType: string;
+  /**
+   * A collection of custom fields where each key is the name of a CustomFieldDefinition and
+   * each value is the value of that custom field for this specific `modelId`.
+   *
+   * Example:
+   * {
+   *   "vehicleColor": "Red",
+   *   "vehicleType": "premium",
+   *   "isActive": true
+   * }
+   */
+  customFields: Record<string, any>;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface EntriesValidationError {
+  value: any,
+  fieldDefinitionName: string,
+  joiValidationError: ValidationError
+}

package/src/types/index.ts

@@ -34,4 +34,5 @@ export type CustomFieldOptions = {
   databaseConfig: any;
   getUser: typeof GetUserType;
   sequelize?: Sequelize;
+  useCustomFieldsEntries?: boolean;
 };

package/src/utils/validations/index.ts

@@ -1,3 +1,6 @@
+import { InvalidEntriesError } from '../../errors';
+import type { CustomFieldDefinition } from '../../models';
+import type { CustomFieldEntriesDTO } from '../../types/entries';
 import type { CustomFieldDefinitionType } from '../constants';
 import { validators } from './validators';
 
@@ -17,3 +20,24 @@ export const validateValue = (
    * }
    */
 };
+
+export const validateInstanceCustomFieldEntries = (instance: CustomFieldEntriesDTO, definitionsByName: { [defName: string]: CustomFieldDefinition; }) => {
+  const validationErrors = Object.entries(instance.customFields)
+    .map(([customFieldName, value]) => {
+      const { validation, fieldType } = definitionsByName[customFieldName];
+      const result = validateValue(value, fieldType, validation);
+      if (result?.error) {
+        return {
+          joiValidationError: result.error,
+          fieldDefinitionName: customFieldName,
+          value,
+        };
+      }
+      return null;
+    })
+    .filter((result) => !!result);
+
+  if (validationErrors?.length) {
+    throw new InvalidEntriesError(instance.modelId, validationErrors);
+  }
+};