@autofleet/sadot 0.4.3 → 0.5.1-beta

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

@@ -26,7 +26,7 @@ const CustomFieldDefinitionUpdateSchema = joi_1.default.object({
     displayName: joi_1.default.string(),
     validation: ValidationSchema,
     fieldType: joi_1.default.string().valid(...Object.values(type_1.CustomFieldDefinitionType)),
-    description: joi_1.default.string(),
+    description: joi_1.default.string().allow(null),
     required: joi_1.default.boolean(),
     disabled: joi_1.default.boolean(),
 });

package/dist/hooks/enrich.d.ts

@@ -1,5 +1,6 @@
+type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-declare const enrichResults: (modelType: string, scopeAttributes: string[]) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
+declare const enrichResults: (modelType: string, scopeAttributes: string[], hookType?: SupportedHookTypes) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
 export default enrichResults;

package/dist/hooks/enrich.js

@@ -40,7 +40,7 @@ const serializeCustomFields = (customFieldValues, customFieldDefinitionsHash) =>
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-const enrichResults = (modelType, scopeAttributes) => async (instancesOrInstance, options) => {
+const enrichResults = (modelType, scopeAttributes, hookType) => async (instancesOrInstance, options) => {
     if (options.originalAttributes?.length > 0
         && !options.originalAttributes?.includes?.('customFields')) {
         return;
@@ -103,6 +103,11 @@ const enrichResults = (modelType, scopeAttributes) => async (instancesOrInstance
             // if raw:
             delete instance?.[attribute];
         });
+        // sequelize will think customFields changed also in 'find', so we need to mark it as unchanged
+        if (hookType === 'afterFind') {
+            // changed() could be undefined, i.e in raw: true
+            instance?.changed?.('customFields', false);
+        }
     });
 };
 exports.default = enrichResults;

package/dist/tests/mocks/testModel.d.ts

@@ -3,7 +3,7 @@ export declare const createTestModel: (payload?: {}) => Promise<TestModel>;
 export declare const createTestModels: (fleetId: any, total: number) => Promise<TestModel[]>;
 export declare const upsertTestModel: (payload: any) => Promise<[TestModel, boolean]>;
 export declare const destroyTestModels: () => Promise<number>;
-export declare const getTestModel: (id: string, options?: {}) => Promise<TestModel>;
+export declare const getTestModel: (id: string, options?: {}) => Promise<TestModel | null>;
 export declare const getSomeTestModels: (options?: {
     limit: number;
 }) => Promise<TestModel[]>;

package/dist/utils/init.js

@@ -32,7 +32,7 @@ const addHooks = (models, getModel) => {
             model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', hooks_1.beforeBulkUpdate);
             model.addHook('beforeCreate', 'sadot-beforeCreate', (0, hooks_1.beforeCreate)(scopeAttributes));
             model.addHook('beforeUpdate', 'sadot-beforeUpdate', (0, hooks_1.beforeUpdate)(scopeAttributes));
-            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes));
+            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes, 'afterFind'));
             model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes));
             model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes));
         }

package/package.json

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

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

@@ -23,7 +23,7 @@ const CustomFieldDefinitionUpdateSchema = Joi.object({
   displayName: Joi.string(),
   validation: ValidationSchema,
   fieldType: Joi.string().valid(...Object.values(CustomFieldDefinitionType)),
-  description: Joi.string(),
+  description: Joi.string().allow(null),
   required: Joi.boolean(),
   disabled: Joi.boolean(),
 });

package/src/hooks/enrich.ts

@@ -5,6 +5,8 @@ import CustomFieldValue from '../models/CustomFieldValue';
 import CustomFieldDefinition from '../models/CustomFieldDefinition';
 import { SerializedCustomFields } from '../types/definition';
 
+type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
+
 /**
  * Serialize custom fields value into the format of {[name] -> [fieldData]}
  */
@@ -24,7 +26,11 @@ const serializeCustomFields = (
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-const enrichResults = (modelType: string, scopeAttributes: string[]) => async (
+const enrichResults = (
+  modelType: string,
+  scopeAttributes: string[],
+  hookType?: SupportedHookTypes,
+) => async (
   instancesOrInstance: any | any[],
   options,
 ): Promise<void> => {
@@ -113,6 +119,11 @@ const enrichResults = (modelType: string, scopeAttributes: string[]) => async (
       // if raw:
       delete instance?.[attribute];
     });
+    // sequelize will think customFields changed also in 'find', so we need to mark it as unchanged
+    if (hookType === 'afterFind') {
+      // changed() could be undefined, i.e in raw: true
+      instance?.changed?.('customFields', false);
+    }
   });
 };
 

package/src/tests/mocks/testModel.ts

@@ -3,7 +3,7 @@ import { TestModel, AssociatedTestModel } from '../../models';
 export const createTestModel = (payload = {}) => TestModel.create(payload);
 
 export const createTestModels = (fleetId, total: number) => {
-  const models = [];
+  const models: Promise<TestModel>[] = [];
   for (let i = 0; i < total; i += 1) {
     models.push(createTestModel({ fleetId }));
   }
@@ -17,7 +17,7 @@ export const destroyTestModels = () => TestModel.destroy({ truncate: true });
 export const getTestModel = (
   id: string,
   options = {},
-): Promise<TestModel> => TestModel.findByPk(id, options);
+): Promise<TestModel | null> => TestModel.findByPk(id, options);
 
 export const getSomeTestModels = (
   options = { limit: 1 },

package/src/utils/init.ts

@@ -38,7 +38,7 @@ export const addHooks = (models: ModelOptions[], getModel: ModelFetcher): void =
       model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', beforeBulkUpdate);
       model.addHook('beforeCreate', 'sadot-beforeCreate', beforeCreate(scopeAttributes));
       model.addHook('beforeUpdate', 'sadot-beforeUpdate', beforeUpdate(scopeAttributes));
-      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes));
+      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes, 'afterFind'));
       model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes));
       model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes));
     } catch (e) {