@autofleet/sadot 0.7.10-beta.9 → 0.8.0

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

@@ -75,15 +75,14 @@ router.get('/:customFieldDefinitionId', async (req, res) => {
  * Get all
  */
 router.get('/', async (req, res) => {
-    const { modelName } = req.params;
-    const { entityIds } = req.query;
+    const { params: { modelName }, query: { entityIds } } = req;
     const modelType = toPascalCase(modelName);
     try {
-        const where = { modelType };
-        if (entityIds?.length > 0) {
-            where.entityId = entityIds;
-        }
-        const customFieldDefinitions = await DefinitionRepo.findAll({ ...where }, { withDisabled: true });
+        const where = {
+            modelType,
+            ...(entityIds?.length > 0 && { entityId: entityIds }),
+        };
+        const customFieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true });
         return res.json(customFieldDefinitions);
     }
     catch (err) {
@@ -98,7 +97,6 @@ router.patch('/:customFieldDefinitionId', async (req, res) => {
     const { customFieldDefinitionId, modelName } = req.params;
     const modelType = toPascalCase(modelName);
     try {
-        // eslint-disable-next-line max-len
         const validatedPayload = await (0, validations_1.validateCustomFieldDefinitionUpdate)(req.body);
         const customFieldDefinition = await DefinitionRepo.findByWhere({
             id: customFieldDefinitionId,

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

@@ -40,11 +40,11 @@ const DefaultValueSchema = joi_1.default.when('fieldType', {
         { is: constants_1.CustomFieldDefinitionType.BOOLEAN, then: joi_1.default.boolean().allow(null) },
         { is: constants_1.CustomFieldDefinitionType.DATE, then: joi_1.default.date().allow(null) },
         { is: constants_1.CustomFieldDefinitionType.DATETIME, then: joi_1.default.date().allow(null) },
-        { is: constants_1.CustomFieldDefinitionType.FILE, then: joi_1.default.array().items(FileValidationSchema).allow(null) },
-        { is: constants_1.CustomFieldDefinitionType.IMAGE, then: joi_1.default.array().items(joi_1.default.string().uri()).allow(null) },
+        { is: constants_1.CustomFieldDefinitionType.FILE, then: FileValidationSchema },
+        { is: constants_1.CustomFieldDefinitionType.IMAGE, then: joi_1.default.string().uri().allow(null) },
         { is: constants_1.CustomFieldDefinitionType.NUMBER, then: joi_1.default.number().allow(null) },
         { is: constants_1.CustomFieldDefinitionType.SELECT, then: joi_1.default.string().allow(null) },
-        { is: constants_1.CustomFieldDefinitionType.STATUS, then: joi_1.default.string().allow(null) },
+        { is: constants_1.CustomFieldDefinitionType.STATUS, then: statusValidationObject.allow(null) },
         { is: constants_1.CustomFieldDefinitionType.TEXT, then: joi_1.default.string().allow(null) },
     ],
 });
@@ -59,6 +59,7 @@ const CustomFieldDefinitionCreationSchema = joi_1.default.object({
     description: joi_1.default.string(),
     required: joi_1.default.boolean(),
     disabled: joi_1.default.boolean(),
+    blockEditingFromUI: joi_1.default.boolean(),
 });
 const CustomFieldDefinitionUpdateSchema = joi_1.default.object({
     displayName: joi_1.default.string(),
@@ -68,6 +69,7 @@ const CustomFieldDefinitionUpdateSchema = joi_1.default.object({
     description: joi_1.default.string().allow(null),
     required: joi_1.default.boolean(),
     disabled: joi_1.default.boolean(),
+    blockEditingFromUI: joi_1.default.boolean(),
 });
 const validateCustomFieldDefinitionCreation = (payload) => CustomFieldDefinitionCreationSchema.validateAsync(payload, { abortEarly: false });
 exports.validateCustomFieldDefinitionCreation = validateCustomFieldDefinitionCreation;

package/dist/errors/index.d.ts

@@ -1,5 +1,4 @@
 import { BadRequest } from '@autofleet/errors';
-import type { ValidationError } from 'joi';
 export declare class MissingRequiredCustomFieldError extends BadRequest {
     constructor(missingFields: string[]);
 }
@@ -9,11 +8,8 @@ export declare class UnsupportedCustomFieldTypeError extends BadRequest {
 export declare class UnsupportedCustomValidationError extends BadRequest {
     constructor(fieldType: string);
 }
-export declare class InvalidFieldTypeError extends BadRequest {
-    constructor(fieldType: string);
-}
 export declare class InvalidValueError extends BadRequest {
-    constructor(value: any, fieldDefinitionName: string, joiValidationError: ValidationError);
+    constructor(value: any, fieldType: string);
 }
 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.InvalidValueError = 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 {
@@ -27,24 +27,11 @@ class UnsupportedCustomValidationError extends errors_1.BadRequest {
     }
 }
 exports.UnsupportedCustomValidationError = UnsupportedCustomValidationError;
-class InvalidFieldTypeError extends errors_1.BadRequest {
-    constructor(fieldType) {
-        const err = new Error(`Invalid field type ${fieldType}`);
-        super([err], null, null);
-        this.message = 'INVALID_FIELD_TYPE';
-    }
-}
-exports.InvalidFieldTypeError = InvalidFieldTypeError;
 class InvalidValueError extends errors_1.BadRequest {
-    constructor(value, fieldDefinitionName, joiValidationError) {
-        const formattedErrorMessage = joiValidationError.message
-            .replace(/"/g, '')
-            .replace('value', `'${fieldDefinitionName}'`);
-        const formattedValue = typeof value === 'object' ? JSON.stringify(value) : value;
-        const invalidValueMessage = `Invalid Value on field '${fieldDefinitionName}'. ${formattedErrorMessage}. received: '${formattedValue}'`;
-        const err = new Error(invalidValueMessage);
+    constructor(value, fieldType) {
+        const err = new Error(`Invalid "${fieldType}" value ${JSON.stringify(value)}`);
         super([err], null, null);
-        this.message = invalidValueMessage;
+        this.message = 'INVALID_VALUE';
     }
 }
 exports.InvalidValueError = InvalidValueError;

package/dist/models/CustomFieldDefinition.d.ts

@@ -17,6 +17,7 @@ declare class CustomFieldDefinition extends Model {
     createdAt?: Date;
     updatedAt?: Date;
     deletedAt?: Date;
+    blockEditingFromUI: boolean;
     values: CustomFieldValue[];
     static displayNameDefaultValue(instance: CustomFieldDefinition): void;
     static afterSaveHandler(instance: CustomFieldDefinition, options: any): void;

package/dist/models/CustomFieldDefinition.js

@@ -28,8 +28,8 @@ let CustomFieldDefinition = class CustomFieldDefinition extends sequelize_typesc
         }
         if (![null, undefined].includes(instance.defaultValue)) {
             const isValid = (0, validations_1.validateValue)(instance.defaultValue, instance.fieldType, instance.validation);
-            if (isValid.error) {
-                throw new errors_1.InvalidValueError(instance.defaultValue, instance.name, isValid.error);
+            if (!isValid) {
+                throw new errors_1.InvalidValueError(instance.defaultValue, instance.fieldType);
             }
         }
     }
@@ -142,6 +142,14 @@ __decorate([
     sequelize_typescript_1.Column,
     __metadata("design:type", Date)
 ], CustomFieldDefinition.prototype, "deletedAt", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.BOOLEAN,
+        defaultValue: false,
+        allowNull: false,
+    }),
+    __metadata("design:type", Boolean)
+], CustomFieldDefinition.prototype, "blockEditingFromUI", void 0);
 __decorate([
     (0, sequelize_typescript_1.HasMany)(() => _1.CustomFieldValue),
     __metadata("design:type", Array)

package/dist/models/CustomFieldValue.d.ts

@@ -8,9 +8,8 @@ declare class CustomFieldValue extends Model {
     updatedAt?: Date;
     deletedAt?: Date;
     customFieldDefinition: CustomFieldDefinition;
-    private static validateValueAgainstDefinition;
-    static validateCustomFieldValues(instances: CustomFieldValue[]): Promise<void>;
-    static validateCustomFieldValue(instance: CustomFieldValue): Promise<void>;
+    static validateValues(instances: CustomFieldValue[]): Promise<void>;
+    static validateValue(instance: CustomFieldValue): Promise<void>;
     static afterSaveHandler(instance: CustomFieldValue, options: any): void;
 }
 export default CustomFieldValue;

package/dist/models/CustomFieldValue.js

@@ -39,21 +39,7 @@ const validations_1 = require("../utils/validations");
 const CustomFieldDefinitionRepo = __importStar(require("../repository/definition"));
 const errors_1 = require("../errors");
 let CustomFieldValue = class CustomFieldValue extends sequelize_typescript_1.Model {
-    static validateValueAgainstDefinition(instance, definition) {
-        const { validation, fieldType, name } = definition;
-        const isValidFieldType = (0, validations_1.validateFieldType)(fieldType);
-        if (!isValidFieldType) {
-            throw new errors_1.InvalidFieldTypeError(fieldType);
-        }
-        // Always allow null values
-        if (instance.value === null)
-            return;
-        const validateValueResponse = (0, validations_1.validateValue)(instance.value, fieldType, validation);
-        if (validateValueResponse.error) {
-            throw new errors_1.InvalidValueError(instance.value, name, validateValueResponse.error);
-        }
-    }
-    static async validateCustomFieldValues(instances) {
+    static async validateValues(instances) {
         const ids = instances.map((instance) => instance.customFieldDefinitionId);
         const uniqueIds = [...new Set(ids)];
         const definitions = await CustomFieldDefinitionRepo.findByIds(uniqueIds, { withDisabled: true });
@@ -61,17 +47,23 @@ let CustomFieldValue = class CustomFieldValue extends sequelize_typescript_1.Mod
             throw new Error('Definitions not found');
         }
         instances.forEach((instance) => {
-            const definition = definitions.find((d) => d.id === instance.customFieldDefinitionId);
-            if (definition) {
-                this.validateValueAgainstDefinition(instance, definition);
+            const { validation, fieldType, } = definitions
+                .find((definition) => definition.id === instance.customFieldDefinitionId);
+            const isValid = (0, validations_1.validateValue)(instance.value, fieldType, validation);
+            if (!isValid) {
+                throw new errors_1.InvalidValueError(instance.value, fieldType);
             }
         });
     }
-    static async validateCustomFieldValue(instance) {
+    static async validateValue(instance) {
         const { customFieldDefinitionId } = instance;
         // eslint-disable-next-line max-len
         const cfd = await CustomFieldDefinitionRepo.findById(customFieldDefinitionId, { withDisabled: true });
-        this.validateValueAgainstDefinition(instance, cfd);
+        const { validation, fieldType } = cfd;
+        const isValid = (0, validations_1.validateValue)(instance.value, fieldType, validation);
+        if (!isValid) {
+            throw new errors_1.InvalidValueError(instance.value, fieldType);
+        }
     }
     static afterSaveHandler(instance, options) {
         if (options.transaction) {
@@ -128,7 +120,7 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Array]),
     __metadata("design:returntype", Promise)
-], CustomFieldValue, "validateCustomFieldValues", null);
+], CustomFieldValue, "validateValues", null);
 __decorate([
     sequelize_typescript_1.BeforeUpdate,
     sequelize_typescript_1.BeforeCreate,
@@ -136,7 +128,7 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [CustomFieldValue]),
     __metadata("design:returntype", Promise)
-], CustomFieldValue, "validateCustomFieldValue", null);
+], CustomFieldValue, "validateValue", null);
 __decorate([
     sequelize_typescript_1.AfterUpsert,
     __metadata("design:type", Function),

package/dist/models/index.d.ts

@@ -5,6 +5,7 @@ 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>;
+import type { CustomFieldOptions } from '../types';
+declare const initTables: (sequelize: Sequelize, getUser: CustomFieldOptions['getUser']) => Promise<void>;
 declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
 export { CustomFieldValue, CustomFieldDefinition, TestModel, AssociatedTestModel, ContextAwareTestModel, ContextTestModel, initTables, initTestModels, };

package/dist/models/index.js

@@ -22,7 +22,7 @@ exports.AssociatedTestModel = AssociatedTestModel_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 = 2;
+const SCHEMA_VERSION = 'fb0fa867-1241-4816-b08d-5ed9060c7ae5';
 const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
 const initTables = async (sequelize, getUser) => {
     logger_1.default.info('custom-fields: initialize custom-fields tables');
@@ -34,18 +34,18 @@ const initTables = async (sequelize, getUser) => {
     sequelize.addModels(productionModels);
     CustomFieldDefinition_1.default.addScope('userScope', () => {
         const user = getUser();
-        if (user?.permissions) {
-            return {
-                where: {
-                    entityId: [
-                        ...Object.keys(user.permissions.fleets),
-                        ...Object.keys(user.permissions.businessModels),
-                        ...Object.keys(user.permissions.demandSources),
-                    ],
-                },
-            };
+        if (!user?.permissions) {
+            return {};
         }
-        return {};
+        return {
+            where: {
+                entityId: [
+                    ...Object.keys(user.permissions.fleets),
+                    ...Object.keys(user.permissions.businessModels),
+                    ...Object.keys(user.permissions.demandSources),
+                ],
+            },
+        };
     });
     logger_1.default.info('custom-fields: models added');
     const SequelizeMeta = sequelize.define('SequelizeMeta', {
@@ -62,8 +62,7 @@ const initTables = async (sequelize, getUser) => {
         schema: 'public',
     });
     const migrations = await SequelizeMeta.findAll({ raw: true });
-    const currentSadotSchemaVersion = migrations
-        .reverse().find((m) => m.name.includes(SADOT_MIGRATION_PREFIX));
+    const currentSadotSchemaVersion = migrations.reverse().find((m) => m.name.includes(SADOT_MIGRATION_PREFIX));
     if (!currentSadotSchemaVersion
         || currentSadotSchemaVersion.name !== CUSTOM_FIELDS_SCHEMA_VERSION) {
         await CustomFieldDefinition_1.default.sync({ alter: true });

package/dist/repository/definition.js

@@ -31,10 +31,8 @@ const findByEntityIds = async (modelType, entityIds, options = {}) => {
     const { include, useEntityIdFromInclude } = options.modelOptions;
     const where = {
         modelType,
+        ...(!useEntityIdFromInclude && { entityId: { [sequelize_1.Op.in]: entityIds } }),
     };
-    if (!useEntityIdFromInclude) {
-        where.entityId = entityIds;
-    }
     return models_1.CustomFieldDefinition.findAll({
         where,
         transaction: options.transaction,
@@ -77,10 +75,8 @@ const getRequiredFields = async (modelType, modelId, entityId, modelOptions = {}
     const where = {
         modelType,
         required: true,
+        ...(!useEntityIdFromInclude && { entityId: { [sequelize_1.Op.in]: entityIds } }),
     };
-    if (!useEntityIdFromInclude) {
-        where.entityId = entityIds;
-    }
     const requiredFields = await models_1.CustomFieldDefinition.findAll({
         where,
         include: include?.(entityIds),

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

@@ -21,6 +21,7 @@ export declare const coolFieldDefinition2: {
     entityId: string;
     entityType: string;
     modelType: string;
+    blockEditingFromUI?: boolean;
 };
 export declare const coolFieldDefinition3: {
     name: string;
@@ -37,10 +38,10 @@ export declare const coolFieldDefinition3: {
     entityId: string;
     entityType: string;
     modelType: string;
+    blockEditingFromUI?: boolean;
 };
 export declare const booleanField: (modelType: string) => CreateCustomFieldDefinition;
 export declare const selectField: (modelType: string, options: any) => CreateCustomFieldDefinition;
 export declare const statusField: (modelType: string, options: any) => CreateCustomFieldDefinition;
-export declare const fileField: (modelType: string) => CreateCustomFieldDefinition;
 export declare const createDefinition: (defaults: Partial<CustomFieldDefinitionDTO>) => CreateCustomFieldDefinition;
 export declare const createDefinitions: (defaults: Partial<CustomFieldDefinitionDTO>, length?: number) => CreateCustomFieldDefinition[];

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDefinitions = exports.createDefinition = exports.fileField = exports.statusField = exports.selectField = exports.booleanField = exports.coolFieldDefinition3 = exports.coolFieldDefinition2 = exports.coolFieldDefinition = exports.contextAwareFieldDefinition = void 0;
+exports.createDefinitions = exports.createDefinition = exports.statusField = exports.selectField = exports.booleanField = exports.coolFieldDefinition3 = exports.coolFieldDefinition2 = exports.coolFieldDefinition = exports.contextAwareFieldDefinition = void 0;
 const node_crypto_1 = require("node:crypto");
 exports.contextAwareFieldDefinition = {
     name: 'cool field',
@@ -49,14 +49,6 @@ const statusField = (modelType, options) => ({
     entityType: 'fleetId',
 });
 exports.statusField = statusField;
-const fileField = (modelType) => ({
-    name: 'file',
-    modelType,
-    fieldType: 'file',
-    entityId: (0, node_crypto_1.randomUUID)(),
-    entityType: 'fleetId',
-});
-exports.fileField = fileField;
 // eslint-disable-next-line max-len
 const createDefinition = (defaults) => ({
     name: defaults?.name || `def_${(0, node_crypto_1.randomUUID)()}`,

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

@@ -14,6 +14,7 @@ export interface CustomFieldDefinitionDTO {
     createdAt?: Date;
     updatedAt?: Date;
     deletedAt?: Date;
+    blockEditingFromUI?: boolean;
 }
 export type CreateCustomFieldDefinition = Omit<CustomFieldDefinitionDTO, 'id'>;
 export type UpdateCustomFieldDefinition = Partial<CreateCustomFieldDefinition>;

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 import type { IncludeOptions } from 'sequelize';
 import type { ModelCtor } from 'sequelize-typescript';
+import type { getUser as GetUserType } from '@autofleet/zehut';
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
     /**
@@ -27,5 +28,5 @@ export type Models = {
 export type CustomFieldOptions = {
     models: Models[];
     databaseConfig: any;
-    getUser: () => any;
+    getUser: typeof GetUserType;
 };

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

@@ -1,3 +1,2 @@
 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 validateValue: (value: unknown, valueType: CustomFieldDefinitionType, validation?: unknown) => boolean;

package/dist/utils/validations/index.js

@@ -1,12 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateValue = exports.validateFieldType = void 0;
+exports.validateValue = void 0;
 const validators_1 = require("./validators");
-const validateFieldType = (type) => Object.keys(validators_1.validators).includes(type);
-exports.validateFieldType = validateFieldType;
 const validateValue = (value, valueType, validation) => {
     const validator = validators_1.validators[valueType];
-    return validator(value, validation);
+    if (!validator) {
+        // Unsupported field type
+        return false;
+    }
+    // Always allow null values
+    return value === null || validator(value, validation);
     /** TODO: Add validation for required fields
      * @example
      * if (validations.required && !value) {

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

@@ -1,11 +1,10 @@
-import type { ValidationResult } from 'joi';
 import type { CustomFieldDefinitionType } from '../constants';
 /**
  * Validator is a function that validates a custom-field `value`,
  * against a custom-field definition `validation object`.
  * @returns `true` if the value is valid, `false` otherwise.
  */
-export type Validator<Value, DefinitionValidationObject> = (value: Value, validation?: DefinitionValidationObject) => ValidationResult;
+export type Validator<Value, DefinitionValidationObject> = (value: Value, validation?: DefinitionValidationObject) => boolean;
 /**
  * Validators is a map of custom-field types to their respective validators.
  * The key is the custom-field type, and the value is the validator function.

package/dist/utils/validations/validators/index.js

@@ -22,19 +22,19 @@ exports.CustomValidationTypes = {
 exports.validators = {
     [constants_1.CustomFieldDefinitionType.SELECT]: select_validator_1.validateSelect,
     [constants_1.CustomFieldDefinitionType.STATUS]: status_validator_1.validateStatus,
-    [constants_1.CustomFieldDefinitionType.TEXT]: (value) => joi_1.default.string().min(0).validate(value),
-    [constants_1.CustomFieldDefinitionType.NUMBER]: (value) => joi_1.default.number().strict(true).validate(value),
-    [constants_1.CustomFieldDefinitionType.BOOLEAN]: (value) => joi_1.default.boolean().strict().validate(value),
-    [constants_1.CustomFieldDefinitionType.DATE]: (value) => joi_1.default.date().validate(value),
-    [constants_1.CustomFieldDefinitionType.DATETIME]: (value) => joi_1.default.date().validate(value),
-    [constants_1.CustomFieldDefinitionType.IMAGE]: (value) => joi_1.default.array().min(1).unique()
+    [constants_1.CustomFieldDefinitionType.TEXT]: (value) => (typeof value === 'string'),
+    [constants_1.CustomFieldDefinitionType.NUMBER]: (value) => (typeof value === 'number'),
+    [constants_1.CustomFieldDefinitionType.BOOLEAN]: (value) => (typeof value === 'boolean'),
+    [constants_1.CustomFieldDefinitionType.DATE]: (value) => (!joi_1.default.date().validate(value).error),
+    [constants_1.CustomFieldDefinitionType.DATETIME]: (value) => (!joi_1.default.date().validate(value).error),
+    [constants_1.CustomFieldDefinitionType.IMAGE]: (value) => (!joi_1.default.array().min(1).unique()
         .items(joi_1.default.string().uri())
-        .validate(value),
-    [constants_1.CustomFieldDefinitionType.FILE]: (value) => joi_1.default.array().min(1).unique().items(joi_1.default.object({
+        .validate(value).error),
+    [constants_1.CustomFieldDefinitionType.FILE]: (value) => (!joi_1.default.array().min(1).unique().items(joi_1.default.object({
         name: joi_1.default.string().required(),
         type: joi_1.default.string(),
         size: joi_1.default.string(),
         addedBy: joi_1.default.string().uuid(),
     }))
-        .validate(value),
+        .validate(value).error),
 };

package/dist/utils/validations/validators/select.validator.js

@@ -1,12 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateSelect = void 0;
-const joi_1 = __importDefault(require("joi"));
 /**
  * Validate that the value is one of the select values
  */
-const validateSelect = (value, selectValues) => (joi_1.default.string().allow(null).valid(...selectValues).validate(value));
+const validateSelect = (value, selectValues) => (Array.isArray(selectValues)
+    && selectValues.includes(value));
 exports.validateSelect = validateSelect;

package/dist/utils/validations/validators/status.validator.js

@@ -1,15 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateStatus = void 0;
-const joi_1 = __importDefault(require("joi"));
 /**
 * Validate that the value is one of the status values
 */
-const validateStatus = (value, statusValues) => (joi_1.default.string()
-    .allow(null)
-    .valid(...statusValues.map((statusValue) => statusValue.value))
-    .validate(value));
+const validateStatus = (value, statusValues) => (Array.isArray(statusValues)
+    && statusValues.some((status) => status.value === value));
 exports.validateStatus = validateStatus;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.7.10-beta.9",
+  "version": "0.8.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

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

@@ -56,16 +56,15 @@ router.get('/:customFieldDefinitionId', async (req, res) => {
  * Get all
  */
 router.get('/', async (req, res) => {
-  const { modelName } = req.params as any;
-  const { entityIds } = req.query as any;
+  const { params: { modelName }, query: { entityIds } } = req as any;
 
   const modelType = toPascalCase(modelName);
   try {
-    const where: any = { modelType };
-    if (entityIds?.length > 0) {
-      where.entityId = entityIds;
-    }
-    const customFieldDefinitions = await DefinitionRepo.findAll({ ...where }, { withDisabled: true });
+    const where = {
+      modelType,
+      ...(entityIds?.length > 0 && { entityId: entityIds }),
+    };
+    const customFieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true });
     return res.json(customFieldDefinitions);
   } catch (err) {
     logger.error('Failed to fetch custom field definitions', err);
@@ -80,7 +79,6 @@ router.patch('/:customFieldDefinitionId', async (req, res) => {
   const { customFieldDefinitionId, modelName } = req.params as any;
   const modelType = toPascalCase(modelName);
   try {
-    // eslint-disable-next-line max-len
     const validatedPayload: UpdateCustomFieldDefinition = await validateCustomFieldDefinitionUpdate(req.body);
 
     const customFieldDefinition = await DefinitionRepo.findByWhere({

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

@@ -36,11 +36,11 @@ const DefaultValueSchema = Joi.when('fieldType', {
     { is: CustomFieldDefinitionType.BOOLEAN, then: Joi.boolean().allow(null) },
     { is: CustomFieldDefinitionType.DATE, then: Joi.date().allow(null) },
     { is: CustomFieldDefinitionType.DATETIME, then: Joi.date().allow(null) },
-    { is: CustomFieldDefinitionType.FILE, then: Joi.array().items(FileValidationSchema).allow(null) },
-    { is: CustomFieldDefinitionType.IMAGE, then: Joi.array().items(Joi.string().uri()).allow(null) },
+    { is: CustomFieldDefinitionType.FILE, then: FileValidationSchema },
+    { is: CustomFieldDefinitionType.IMAGE, then: Joi.string().uri().allow(null) },
     { is: CustomFieldDefinitionType.NUMBER, then: Joi.number().allow(null) },
     { is: CustomFieldDefinitionType.SELECT, then: Joi.string().allow(null) },
-    { is: CustomFieldDefinitionType.STATUS, then: Joi.string().allow(null) },
+    { is: CustomFieldDefinitionType.STATUS, then: statusValidationObject.allow(null) },
     { is: CustomFieldDefinitionType.TEXT, then: Joi.string().allow(null) },
   ],
 });
@@ -56,6 +56,7 @@ const CustomFieldDefinitionCreationSchema = Joi.object({
   description: Joi.string(),
   required: Joi.boolean(),
   disabled: Joi.boolean(),
+  blockEditingFromUI: Joi.boolean(),
 });
 
 const CustomFieldDefinitionUpdateSchema = Joi.object({
@@ -66,6 +67,7 @@ const CustomFieldDefinitionUpdateSchema = Joi.object({
   description: Joi.string().allow(null),
   required: Joi.boolean(),
   disabled: Joi.boolean(),
+  blockEditingFromUI: Joi.boolean(),
 });
 
 export const validateCustomFieldDefinitionCreation = (payload) =>

package/src/errors/index.ts

@@ -1,6 +1,5 @@
 /* eslint-disable max-classes-per-file */
 import { BadRequest } from '@autofleet/errors';
-import type { ValidationError } from 'joi';
 
 export class MissingRequiredCustomFieldError extends BadRequest {
   constructor(missingFields: string[]) {
@@ -26,27 +25,11 @@ export class UnsupportedCustomValidationError extends BadRequest {
   }
 }
 
-export class InvalidFieldTypeError extends BadRequest {
-  constructor(fieldType: string) {
-    const err = new Error(`Invalid field type ${fieldType}`);
-    super([err], null, null);
-    this.message = 'INVALID_FIELD_TYPE';
-  }
-}
-
 export class InvalidValueError extends BadRequest {
-  constructor(value: any, fieldDefinitionName: string, joiValidationError: ValidationError) {
-    const formattedErrorMessage = joiValidationError.message
-      .replace(/"/g, '')
-      .replace('value', `'${fieldDefinitionName}'`);
-
-    const formattedValue = typeof value === 'object' ? JSON.stringify(value) : value;
-
-    const invalidValueMessage = `Invalid Value on field '${fieldDefinitionName}'. ${formattedErrorMessage}. received: '${formattedValue}'`;
-
-    const err = new Error(invalidValueMessage);
+  constructor(value: any, fieldType: string) {
+    const err = new Error(`Invalid "${fieldType}" value ${JSON.stringify(value)}`);
     super([err], null, null);
-    this.message = invalidValueMessage;
+    this.message = 'INVALID_VALUE';
   }
 }
 

package/src/models/CustomFieldDefinition.ts

@@ -125,6 +125,13 @@ class CustomFieldDefinition extends Model {
   @Column
     deletedAt?: Date;
 
+    @Column({
+      type: DataType.BOOLEAN,
+      defaultValue: false,
+      allowNull: false,
+    })
+      blockEditingFromUI!: boolean;
+
   @HasMany(() => CustomFieldValue)
     values: CustomFieldValue[];
 
@@ -136,8 +143,8 @@ class CustomFieldDefinition extends Model {
     }
     if (![null, undefined].includes(instance.defaultValue)) {
       const isValid = validateValue(instance.defaultValue, instance.fieldType, instance.validation);
-      if (isValid.error) {
-        throw new InvalidValueError(instance.defaultValue, instance.name, isValid.error);
+      if (!isValid) {
+        throw new InvalidValueError(instance.defaultValue, instance.fieldType);
       }
     }
   }

package/src/models/CustomFieldValue.ts

@@ -15,9 +15,9 @@ import {
 } from 'sequelize-typescript';
 import { sendDimEvent } from '../events';
 import { CustomFieldDefinition } from '.';
-import { validateFieldType, validateValue } from '../utils/validations';
+import { validateValue } from '../utils/validations';
 import * as CustomFieldDefinitionRepo from '../repository/definition';
-import { InvalidFieldTypeError, InvalidValueError } from '../errors';
+import { InvalidValueError } from '../errors';
 
 @Table({
   timestamps: true,
@@ -56,26 +56,9 @@ class CustomFieldValue extends Model {
   @BelongsTo(() => CustomFieldDefinition, { scope: { disabled: false } })
     customFieldDefinition: CustomFieldDefinition;
 
-  private static validateValueAgainstDefinition(
-    instance: CustomFieldValue,
-    definition: CustomFieldDefinition,
-  ): void {
-    const { validation, fieldType, name } = definition;
-    const isValidFieldType = validateFieldType(fieldType);
-    if (!isValidFieldType) {
-      throw new InvalidFieldTypeError(fieldType);
-    }
-    // Always allow null values
-    if (instance.value === null) return;
-    const validateValueResponse = validateValue(instance.value, fieldType, validation);
-    if (validateValueResponse.error) {
-      throw new InvalidValueError(instance.value, name, validateValueResponse.error);
-    }
-  }
-
   @BeforeBulkCreate
   @BeforeBulkUpdate
-  static async validateCustomFieldValues(instances: CustomFieldValue[]): Promise<void> {
+  static async validateValues(instances: CustomFieldValue[]): Promise<void> {
     const ids = instances.map((instance) => instance.customFieldDefinitionId);
     const uniqueIds = [...new Set(ids)];
     const definitions = await CustomFieldDefinitionRepo.findByIds(
@@ -88,9 +71,14 @@ class CustomFieldValue extends Model {
     }
 
     instances.forEach((instance) => {
-      const definition = definitions.find((d) => d.id === instance.customFieldDefinitionId);
-      if (definition) {
-        this.validateValueAgainstDefinition(instance, definition);
+      const {
+        validation,
+        fieldType,
+      } = definitions
+        .find((definition) => definition.id === instance.customFieldDefinitionId);
+      const isValid = validateValue(instance.value, fieldType, validation);
+      if (!isValid) {
+        throw new InvalidValueError(instance.value, fieldType);
       }
     });
   }
@@ -98,11 +86,15 @@ class CustomFieldValue extends Model {
   @BeforeUpdate
   @BeforeCreate
   @BeforeUpsert
-  static async validateCustomFieldValue(instance: CustomFieldValue): Promise<void> {
+  static async validateValue(instance: CustomFieldValue): Promise<void> {
     const { customFieldDefinitionId } = instance;
     // eslint-disable-next-line max-len
     const cfd = await CustomFieldDefinitionRepo.findById(customFieldDefinitionId, { withDisabled: true });
-    this.validateValueAgainstDefinition(instance, cfd);
+    const { validation, fieldType } = cfd;
+    const isValid = validateValue(instance.value, fieldType, validation);
+    if (!isValid) {
+      throw new InvalidValueError(instance.value, fieldType);
+    }
   }
 
   @AfterUpsert

package/src/models/index.ts

@@ -8,15 +8,16 @@ import TestModel from './tests/TestModel';
 import ContextAwareTestModel from './tests/contextAwareModels/ContextAwareTestModel';
 import ContextTestModel from './tests/contextAwareModels/ContextTestModel';
 import AssociatedTestModel from './tests/AssociatedTestModel';
+import type { CustomFieldOptions } from '../types';
 
 const productionModels = [CustomFieldDefinition, CustomFieldValue];
 const testModels = [TestModel, AssociatedTestModel, ContextAwareTestModel, ContextTestModel];
 
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
-const SCHEMA_VERSION = 2;
+const SCHEMA_VERSION = 'fb0fa867-1241-4816-b08d-5ed9060c7ae5';
 const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
 
-const initTables = async (sequelize: Sequelize, getUser): Promise<void> => {
+const initTables = async (sequelize: Sequelize, getUser: CustomFieldOptions['getUser']): Promise<void> => {
   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
@@ -27,18 +28,18 @@ const initTables = async (sequelize: Sequelize, getUser): Promise<void> => {
 
   CustomFieldDefinition.addScope('userScope', () => {
     const user = getUser();
-    if (user?.permissions) {
-      return {
-        where: {
-          entityId: [
-            ...Object.keys(user.permissions.fleets),
-            ...Object.keys(user.permissions.businessModels),
-            ...Object.keys(user.permissions.demandSources),
-          ],
-        },
-      };
+    if (!user?.permissions) {
+      return {};
     }
-    return {};
+    return {
+      where: {
+        entityId: [
+          ...Object.keys(user.permissions.fleets),
+          ...Object.keys(user.permissions.businessModels),
+          ...Object.keys(user.permissions.demandSources),
+        ],
+      },
+    };
   });
 
   logger.info('custom-fields: models added');
@@ -61,8 +62,7 @@ const initTables = async (sequelize: Sequelize, getUser): Promise<void> => {
     },
   );
   const migrations = await SequelizeMeta.findAll({ raw: true });
-  const currentSadotSchemaVersion = migrations
-    .reverse().find((m: any) => m.name.includes(SADOT_MIGRATION_PREFIX));
+  const currentSadotSchemaVersion = migrations.reverse().find((m: any) => m.name.includes(SADOT_MIGRATION_PREFIX));
 
   if (
     !currentSadotSchemaVersion

package/src/repository/definition.ts

@@ -55,11 +55,9 @@ export const findByEntityIds = async (
   const { include, useEntityIdFromInclude } = options.modelOptions;
   const where: WhereOptions = {
     modelType,
+    ...(!useEntityIdFromInclude && { entityId: { [Op.in]: entityIds } }),
   };
 
-  if (!useEntityIdFromInclude) {
-    where.entityId = entityIds;
-  }
   return CustomFieldDefinition.findAll({
     where,
     transaction: options.transaction,
@@ -120,12 +118,9 @@ export const getRequiredFields = async (
   const where: WhereOptions = {
     modelType,
     required: true,
+    ...(!useEntityIdFromInclude && { entityId: { [Op.in]: entityIds } }),
   };
 
-  if (!useEntityIdFromInclude) {
-    where.entityId = entityIds;
-  }
-
   const requiredFields = await CustomFieldDefinition.findAll({
     where,
     include: include?.(entityIds),

package/src/repository/value.ts

@@ -1,4 +1,3 @@
-/* eslint-disable max-len */
 import type { FindOptions, WhereOptions } from 'sequelize';
 import { CustomFieldValue, CustomFieldDefinition } from '../models';
 import * as DefinitionRepo from './definition';

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

@@ -52,14 +52,6 @@ export const statusField = (modelType: string, options): CreateCustomFieldDefini
   entityType: 'fleetId',
 });
 
-export const fileField = (modelType: string): CreateCustomFieldDefinition => ({
-  name: 'file',
-  modelType,
-  fieldType: 'file',
-  entityId: uuidv4(),
-  entityType: 'fleetId',
-});
-
 // eslint-disable-next-line max-len
 export const createDefinition = (defaults: Partial<CustomFieldDefinitionDTO>): CreateCustomFieldDefinition => ({
   name: defaults?.name || `def_${uuidv4()}`,

package/src/types/definition/index.ts

@@ -14,6 +14,7 @@ export interface CustomFieldDefinitionDTO {
     createdAt?: Date;
     updatedAt?: Date;
     deletedAt?: Date;
+    blockEditingFromUI?: boolean;
   }
 export type CreateCustomFieldDefinition = Omit<CustomFieldDefinitionDTO, 'id'>;
 export type UpdateCustomFieldDefinition = Partial<CreateCustomFieldDefinition>;

package/src/types/index.ts

@@ -1,5 +1,6 @@
 import type { IncludeOptions } from 'sequelize';
 import type { ModelCtor } from 'sequelize-typescript';
+import type { getUser as GetUserType } from '@autofleet/zehut';
 
 export type ModelFetcher = (name: string) => any;
 
@@ -31,5 +32,5 @@ export type Models = {
 export type CustomFieldOptions = {
   models: Models[];
   databaseConfig: any;
-  getUser: () => any;
+  getUser: typeof GetUserType;
 };

package/src/utils/validations/index.ts

@@ -1,15 +1,18 @@
 import type { CustomFieldDefinitionType } from '../constants';
 import { validators } from './validators';
 
-export const validateFieldType = (type: CustomFieldDefinitionType): boolean => Object.keys(validators).includes(type);
-
 export const validateValue = (
   value: unknown,
   valueType: CustomFieldDefinitionType,
   validation?: unknown,
 ) => {
   const validator = validators[valueType];
-  return validator(value, validation);
+  if (!validator) {
+    // Unsupported field type
+    return false;
+  }
+  // Always allow null values
+  return value === null || validator(value, validation);
   /** TODO: Add validation for required fields
    * @example
    * if (validations.required && !value) {

package/src/utils/validations/type.ts

@@ -1,4 +1,3 @@
-import type { ValidationResult } from 'joi';
 import type { CustomFieldDefinitionType } from '../constants';
 
 /**
@@ -9,7 +8,7 @@ import type { CustomFieldDefinitionType } from '../constants';
 export type Validator<Value, DefinitionValidationObject> = (
    value: Value,
    validation?: DefinitionValidationObject
-  ) => ValidationResult;
+  ) => boolean;
 
 /**
  * Validators is a map of custom-field types to their respective validators.

package/src/utils/validations/validators/index.ts

@@ -20,19 +20,19 @@ export const CustomValidationTypes = {
 export const validators: Validators = {
   [CustomFieldDefinitionType.SELECT]: validateSelect,
   [CustomFieldDefinitionType.STATUS]: validateStatus,
-  [CustomFieldDefinitionType.TEXT]: (value) => Joi.string().min(0).validate(value),
-  [CustomFieldDefinitionType.NUMBER]: (value) => Joi.number().strict(true).validate(value),
-  [CustomFieldDefinitionType.BOOLEAN]: (value) => Joi.boolean().strict().validate(value),
-  [CustomFieldDefinitionType.DATE]: (value) => Joi.date().validate(value),
-  [CustomFieldDefinitionType.DATETIME]: (value) => Joi.date().validate(value),
-  [CustomFieldDefinitionType.IMAGE]: (value) => Joi.array().min(1).unique()
+  [CustomFieldDefinitionType.TEXT]: (value) => (typeof value === 'string'),
+  [CustomFieldDefinitionType.NUMBER]: (value) => (typeof value === 'number'),
+  [CustomFieldDefinitionType.BOOLEAN]: (value) => (typeof value === 'boolean'),
+  [CustomFieldDefinitionType.DATE]: (value) => (!Joi.date().validate(value).error),
+  [CustomFieldDefinitionType.DATETIME]: (value) => (!Joi.date().validate(value).error),
+  [CustomFieldDefinitionType.IMAGE]: (value) => (!Joi.array().min(1).unique()
     .items(Joi.string().uri())
-    .validate(value),
-  [CustomFieldDefinitionType.FILE]: (value) => Joi.array().min(1).unique().items(Joi.object({
+    .validate(value).error),
+  [CustomFieldDefinitionType.FILE]: (value) => (!Joi.array().min(1).unique().items(Joi.object({
     name: Joi.string().required(),
     type: Joi.string(),
     size: Joi.string(),
     addedBy: Joi.string().uuid(),
   }))
-    .validate(value),
+    .validate(value).error),
 };

package/src/utils/validations/validators/select.validator.ts

@@ -1,4 +1,3 @@
-import Joi from 'joi';
 import type { Validator } from '../type';
 
 /**
@@ -7,6 +6,6 @@ import type { Validator } from '../type';
 export const validateSelect: Validator<string, string[]> = (
   value,
   selectValues,
-) => (
-  Joi.string().allow(null).valid(...selectValues).validate(value)
+) => (Array.isArray(selectValues)
+      && selectValues.includes(value)
 );

package/src/utils/validations/validators/status.validator.ts

@@ -1,4 +1,3 @@
-import Joi from 'joi';
 import type { Validator } from '../type';
 
 type StatusColor = string | null; // TODO: Takes from @autofleet/colors ?
@@ -14,9 +13,6 @@ type StatusOption = {
 export const validateStatus: Validator<StatusValue, StatusOption[]> = (
   value,
   statusValues,
-) => (
-  Joi.string()
-    .allow(null)
-    .valid(...statusValues.map((statusValue) => statusValue.value))
-    .validate(value)
+) => (Array.isArray(statusValues)
+   && statusValues.some((status) => status.value === value)
 );

package/.env

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