@autofleet/sadot 0.7.2 → 0.7.3-beta-4c642ed9.1

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

@@ -28,10 +28,16 @@ const ValidationSchema = joi_1.default.when('fieldType', {
     then: statusValidationObjectSchema,
     otherwise: joi_1.default.any(),
 });
+const DefaultValueSchema = joi_1.default.when('fieldType', {
+    is: constants_1.CustomFieldDefinitionType.BOOLEAN,
+    then: joi_1.default.boolean(),
+    otherwise: joi_1.default.any(),
+});
 const CustomFieldDefinitionCreationSchema = joi_1.default.object({
     name: joi_1.default.string().required(),
     displayName: joi_1.default.string().required(),
     validation: ValidationSchema,
+    defaultValue: DefaultValueSchema,
     fieldType: joi_1.default.string().valid(...Object.values(constants_1.CustomFieldDefinitionType)).required(),
     entityId: joi_1.default.string().guid().required(),
     entityType: joi_1.default.string().required(),
@@ -42,6 +48,7 @@ const CustomFieldDefinitionCreationSchema = joi_1.default.object({
 const CustomFieldDefinitionUpdateSchema = joi_1.default.object({
     displayName: joi_1.default.string(),
     validation: ValidationSchema,
+    defaultValue: DefaultValueSchema,
     fieldType: joi_1.default.string().valid(...Object.values(constants_1.CustomFieldDefinitionType)),
     description: joi_1.default.string().allow(null),
     required: joi_1.default.boolean(),

package/dist/models/CustomFieldDefinition.d.ts

@@ -13,6 +13,7 @@ declare class CustomFieldDefinition extends Model {
     description?: string;
     required?: boolean;
     disabled?: boolean;
+    defaultValue?: any;
     createdAt?: Date;
     updatedAt?: Date;
     deletedAt?: Date;

package/dist/models/CustomFieldDefinition.js

@@ -19,12 +19,19 @@ const _1 = require(".");
 const events_1 = require("../events");
 const errors_1 = require("../errors");
 const logger_1 = __importDefault(require("../utils/logger"));
+const validations_1 = require("../utils/validations");
 let CustomFieldDefinition = class CustomFieldDefinition extends sequelize_typescript_1.Model {
     static displayNameDefaultValue(instance) {
         if (!instance?.displayName) {
             // eslint-disable-next-line no-param-reassign
             instance.displayName = instance.name;
         }
+        if (![null, undefined].includes(instance.defaultValue)) {
+            const isValid = (0, validations_1.validateValue)(instance.defaultValue, instance.fieldType, instance.validation);
+            if (!isValid) {
+                throw new errors_1.InvalidValueError(instance.defaultValue, instance.fieldType);
+            }
+        }
     }
     static afterSaveHandler(instance, options) {
         if (options.transaction) {
@@ -116,6 +123,13 @@ __decorate([
     }),
     __metadata("design:type", Boolean)
 ], CustomFieldDefinition.prototype, "disabled", void 0);
+__decorate([
+    (0, sequelize_typescript_1.Column)({
+        type: sequelize_typescript_1.DataType.JSONB,
+        allowNull: true,
+    }),
+    __metadata("design:type", Object)
+], CustomFieldDefinition.prototype, "defaultValue", void 0);
 __decorate([
     sequelize_typescript_1.Column,
     __metadata("design:type", Date)

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 = 1;
+const SCHEMA_VERSION = 2;
 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');

package/dist/repository/value.js

@@ -117,7 +117,7 @@ const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, opt
         const formatFunction = formatFunctions[fieldDefinition.fieldType];
         return {
             modelId,
-            value: formatFunction ? formatFunction(valuesToUpdate[name]) : valuesToUpdate[name],
+            value: (formatFunction ? formatFunction(valuesToUpdate[name]) : valuesToUpdate[name]) ?? fieldDefinition.defaultValue,
             updatedAt: new Date(),
             customFieldDefinitionId: fieldDefinition.id,
         };

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

@@ -14,6 +14,7 @@ export declare const coolFieldDefinition2: {
     createdAt?: Date;
     updatedAt?: Date;
     deletedAt?: Date;
+    defaultValue?: any;
     displayName?: string;
     validation?: any;
     fieldType: string;
@@ -29,6 +30,7 @@ export declare const coolFieldDefinition3: {
     createdAt?: Date;
     updatedAt?: Date;
     deletedAt?: Date;
+    defaultValue?: any;
     displayName?: string;
     validation?: any;
     fieldType: string;

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

@@ -56,6 +56,7 @@ const createDefinition = (defaults) => ({
     fieldType: defaults?.fieldType || 'boolean',
     entityId: defaults?.entityId || (0, uuid_1.v4)(),
     entityType: defaults?.entityType || 'fleetId',
+    ...(defaults?.defaultValue && { defaultValue: defaults.defaultValue }),
 });
 exports.createDefinition = createDefinition;
 const createDefinitions = (defaults, length = 1) => (Array(length).fill({}).map((_) => ({

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

@@ -3,6 +3,7 @@ export interface CustomFieldDefinitionDTO {
     name: string;
     displayName?: string;
     validation?: any;
+    defaultValue?: any;
     fieldType: string;
     entityId: string;
     entityType: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.7.2",
+  "version": "0.7.3-beta-4c642ed9.1",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

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

@@ -26,10 +26,17 @@ const ValidationSchema = Joi.when('fieldType', {
   otherwise: Joi.any(),
 });
 
+const DefaultValueSchema = Joi.when('fieldType', {
+  is: CustomFieldDefinitionType.BOOLEAN,
+  then: Joi.boolean(),
+  otherwise: Joi.any(),
+});
+
 const CustomFieldDefinitionCreationSchema = Joi.object({
   name: Joi.string().required(),
   displayName: Joi.string().required(),
   validation: ValidationSchema,
+  defaultValue: DefaultValueSchema,
   fieldType: Joi.string().valid(...Object.values(CustomFieldDefinitionType)).required(),
   entityId: Joi.string().guid().required(),
   entityType: Joi.string().required(),
@@ -41,6 +48,7 @@ const CustomFieldDefinitionCreationSchema = Joi.object({
 const CustomFieldDefinitionUpdateSchema = Joi.object({
   displayName: Joi.string(),
   validation: ValidationSchema,
+  defaultValue: DefaultValueSchema,
   fieldType: Joi.string().valid(...Object.values(CustomFieldDefinitionType)),
   description: Joi.string().allow(null),
   required: Joi.boolean(),

package/src/models/CustomFieldDefinition.ts

@@ -14,8 +14,9 @@ import { CustomFieldDefinitionType } from '../utils/constants';
 import { CustomValidationTypes } from '../utils/validations/validators';
 import { CustomFieldValue } from '.';
 import { sendDimEvent } from '../events';
-import { UnsupportedCustomFieldTypeError, UnsupportedCustomValidationError } from '../errors';
+import { InvalidValueError, UnsupportedCustomFieldTypeError, UnsupportedCustomValidationError } from '../errors';
 import logger from '../utils/logger';
+import { validateValue } from '../utils/validations';
 
 @DefaultScope(() => ({ where: { disabled: false } }))
 @Table({
@@ -109,6 +110,12 @@ class CustomFieldDefinition extends Model {
   })
   disabled?: boolean;
 
+    @Column({
+      type: DataType.JSONB,
+      allowNull: true,
+    })
+      defaultValue?: any;
+
   @Column
   createdAt?: Date;
 
@@ -127,6 +134,12 @@ class CustomFieldDefinition extends Model {
       // eslint-disable-next-line no-param-reassign
       instance.displayName = instance.name;
     }
+    if (![null, undefined].includes(instance.defaultValue)) {
+      const isValid = validateValue(instance.defaultValue, instance.fieldType, instance.validation);
+      if (!isValid) {
+        throw new InvalidValueError(instance.defaultValue, instance.fieldType);
+      }
+    }
   }
 
   @AfterSave

package/src/models/index.ts

@@ -13,7 +13,7 @@ const productionModels = [CustomFieldDefinition, CustomFieldValue];
 const testModels = [TestModel, AssociatedTestModel, ContextAwareTestModel, ContextTestModel];
 
 const SADOT_MIGRATION_PREFIX = 'sadot-migration';
-const SCHEMA_VERSION = 1;
+const SCHEMA_VERSION = 2;
 const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
 
 const initTables = async (sequelize: Sequelize, getUser): Promise<void> => {

package/src/repository/value.ts

@@ -105,7 +105,7 @@ export const updateValues = async (
     const formatFunction = formatFunctions[fieldDefinition.fieldType];
     return {
       modelId,
-      value: formatFunction ? formatFunction(valuesToUpdate[name]) : valuesToUpdate[name],
+      value: (formatFunction ? formatFunction(valuesToUpdate[name]) : valuesToUpdate[name]) ?? fieldDefinition.defaultValue,
       updatedAt: new Date(),
       customFieldDefinitionId: fieldDefinition.id,
     };

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

@@ -59,6 +59,7 @@ export const createDefinition = (defaults: Partial<CustomFieldDefinitionDTO>): C
   fieldType: defaults?.fieldType || 'boolean',
   entityId: defaults?.entityId || uuidv4(),
   entityType: defaults?.entityType || 'fleetId',
+  ...(defaults?.defaultValue && { defaultValue: defaults.defaultValue }),
 });
 
 export const createDefinitions = (

package/src/types/definition/index.ts

@@ -3,6 +3,7 @@ export interface CustomFieldDefinitionDTO {
     name: string;
     displayName?: string;
     validation?: any;
+    defaultValue?: any;
     fieldType: string;
     entityId: string;
     entityType: string;