@autofleet/sadot 0.7.5 → 0.7.6-beta-0ecad376.1

package/dist/hooks/create.js

@@ -48,27 +48,38 @@ exports.beforeBulkCreate = beforeBulkCreate;
 const beforeCreate = (scopeAttributes, modelOptions = {}) => async (instance, options) => {
     logger_1.default.debug('sadot - before create hook');
     const { fields } = options;
+    const { include, useEntityIdFromInclude } = modelOptions;
     const modelType = instance.constructor.name;
     const identifiers = (0, scopeAttributes_1.default)(instance, scopeAttributes);
-    // get all model's required definitions
-    const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType, instance.id, identifiers, modelOptions);
+    const where = {
+        modelType,
+        ...(!useEntityIdFromInclude && { entityId: identifiers }),
+    };
+    const fieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: false, transaction: options.transaction, include: include?.(identifiers) });
+    const requiredFieldsNames = Array.from(new Set(fieldDefinitions.filter(({ required }) => required).map(({ name }) => name)));
     const customFieldsIdx = fields.indexOf('customFields');
+    if ((customFieldsIdx === -1 || !instance.customFields) && requiredFieldsNames?.length > 0) {
+        throw new errors_1.MissingRequiredCustomFieldError(requiredFieldsNames);
+    }
+    // eslint-disable-next-line no-param-reassign
+    instance.customFields || (instance.customFields = {});
     const { customFields } = instance;
-    if (customFieldsIdx > -1 && customFields) {
-        const fieldsNames = Object.keys(customFields);
-        const missingFields = requiredFieldsNames.filter((name) => !fieldsNames.includes(name));
-        if (missingFields?.length > 0) {
-            throw new errors_1.MissingRequiredCustomFieldError(missingFields);
-        }
-        await ValueRepo.updateValues(modelType, instance.id, identifiers, customFields, {
-            transaction: options.transaction,
-            modelOptions,
-        }, true);
-        // eslint-disable-next-line no-param-reassign
-        fields.splice(customFieldsIdx, 1);
+    fieldDefinitions.filter((def) => !(def.name in customFields) && ![null, undefined].includes(def.defaultValue)).forEach(({ name, defaultValue }) => {
+        customFields[name] = defaultValue;
+    });
+    if (customFieldsIdx === -1) {
+        return;
     }
-    else if (requiredFieldsNames?.length > 0) {
-        throw new errors_1.MissingRequiredCustomFieldError(requiredFieldsNames);
+    const fieldsNames = Object.keys(customFields);
+    const missingFields = requiredFieldsNames.filter((name) => !fieldsNames.includes(name));
+    if (missingFields?.length > 0) {
+        throw new errors_1.MissingRequiredCustomFieldError(missingFields);
     }
+    await ValueRepo.updateValues(modelType, instance.id, identifiers, customFields, {
+        transaction: options.transaction,
+        modelOptions,
+    });
+    // eslint-disable-next-line no-param-reassign
+    fields.splice(customFieldsIdx, 1);
 };
 exports.beforeCreate = beforeCreate;

package/dist/repository/definition.d.ts

@@ -1,20 +1,26 @@
-import { type FindOptions, type WhereOptions } from 'sequelize';
+import { type Includeable, type Transaction, type FindOptions, type WhereOptions } from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
 import type { ModelOptions } from '../types';
 export declare const create: (data: CreateCustomFieldDefinition) => Promise<CustomFieldDefinition>;
-export declare const findAll: (where: WhereOptions, options?: any) => Promise<CustomFieldDefinition[]>;
-export declare const findByIds: (ids: string[], options?: any) => Promise<CustomFieldDefinition[]>;
-export declare const findById: (id: string, options?: any) => Promise<CustomFieldDefinition | null>;
+interface SadotFindOptions {
+    withDisabled?: boolean;
+    transaction?: Transaction;
+    include?: Includeable | Includeable[];
+}
+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>;
 export declare const findByEntityIds: (modelType: string, entityIds: string[], options?: FindOptions & {
     modelOptions?: ModelOptions;
 }) => Promise<CustomFieldDefinition[]>;
 export declare const findByWhere: (where: any) => Promise<CustomFieldDefinition | null>;
 export declare const findDefinitionsByModels: (modelTypes: string[], options?: any) => Promise<CustomFieldDefinition[]>;
 export declare const update: (id: string, data: UpdateCustomFieldDefinition) => Promise<CustomFieldDefinition>;
-export declare const disable: (id: string) => Promise<any>;
-export declare const destroy: (id: string) => Promise<any>;
+export declare const disable: (id: string) => Promise<[affectedCount: number]>;
+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[]>;
+export {};

package/dist/repository/value.d.ts

@@ -24,5 +24,5 @@ export declare const findValuesByModelIds: (modelIds: string[], options?: any) =
  */
 export declare const updateValues: (modelType: string, modelId: string, identifiers: string[], valuesToUpdate: ValuesToUpdate, options?: FindOptions & {
     modelOptions?: ModelOptions;
-}, defineAllDefaults?: boolean) => Promise<CustomFieldValue[]>;
+}) => Promise<CustomFieldValue[]>;
 export declare const deleteValue: (id: string, options?: any) => Promise<any>;

package/dist/repository/value.js

@@ -84,7 +84,7 @@ const formatFunctions = {
  * Create new value record if not exists, but fails if value's definition not exist.
  * Return the updated values
  */
-const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, options = {}, defineAllDefaults = false) => {
+const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, options = {}) => {
     const names = Object.keys(valuesToUpdate);
     logger_1.default.debug(`custom-fields: updating values for ${modelType} ${modelId}`, {
         names,
@@ -96,11 +96,9 @@ const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, opt
     const where = {
         modelType,
         name: names,
+        ...(!options.modelOptions?.useEntityIdFromInclude && { entityId: identifiers }),
     };
-    if (!options.modelOptions?.useEntityIdFromInclude) {
-        where.entityId = identifiers;
-    }
-    const fieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true, transaction, include: modelOptions.include?.(identifiers) }) || [];
+    const fieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true, transaction, include: modelOptions.include?.(identifiers) }) ?? [];
     const disabledDefinitions = fieldDefinitions.filter((def) => def.disabled);
     if (fieldDefinitions.length !== names.length) {
         logger_1.default.warn(`custom-fields: missing definitions for ${modelType} ${modelId}`, { names, fieldDefinitions });
@@ -112,10 +110,8 @@ const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, opt
     if (valuesWithDisabledDefinitions?.length > 0) {
         logger_1.default.warn(`custom-fields: trying to update disabled values: ${valuesWithDisabledDefinitions.join(', ')}`);
     }
-    const visitedFields = new Set();
     const values = names.map((name) => {
         const fieldDefinition = fieldDefinitions.find((def) => def.name === name);
-        visitedFields.add(fieldDefinition);
         const formatFunction = formatFunctions[fieldDefinition.fieldType];
         return {
             modelId,
@@ -124,16 +120,6 @@ const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, opt
             customFieldDefinitionId: fieldDefinition.id,
         };
     });
-    if (defineAllDefaults) {
-        fieldDefinitions.filter((def) => !visitedFields.has(def) && ![null, undefined].includes(def.defaultValue)).forEach(({ id, defaultValue }) => {
-            values.push({
-                modelId,
-                value: defaultValue,
-                updatedAt: new Date(),
-                customFieldDefinitionId: id,
-            });
-        });
-    }
     return Promise.all(values.map(async (value) => {
         const [cfv] = await models_1.CustomFieldValue.upsert(value, {
             transaction: options.transaction,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.7.5",
+  "version": "0.7.6-beta-0ecad376.1",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/src/hooks/create.ts

@@ -1,3 +1,4 @@
+import type { WhereOptions } from 'sequelize';
 import logger from '../utils/logger';
 import * as ValueRepo from '../repository/value';
 import * as DefinitionRepo from '../repository/definition';
@@ -23,37 +24,49 @@ export const beforeCreate = (scopeAttributes: string[], modelOptions: ModelOptio
 ): Promise<void> => {
   logger.debug('sadot - before create hook');
   const { fields } = options;
+  const { include, useEntityIdFromInclude } = modelOptions;
   const modelType = instance.constructor.name;
 
   const identifiers = applyScopeToInstance(instance, scopeAttributes);
 
-  // get all model's required definitions
-  const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType, instance.id, identifiers, modelOptions);
+  const where: WhereOptions = {
+    modelType,
+    ...(!useEntityIdFromInclude && { entityId: identifiers }),
+  };
+  const fieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: false, transaction: options.transaction, include: include?.(identifiers) });
+  const requiredFieldsNames = Array.from(new Set(fieldDefinitions.filter(({ required }) => required).map(({ name }) => name)));
 
   const customFieldsIdx = fields.indexOf('customFields');
-  const { customFields } = instance;
-  if (customFieldsIdx > -1 && customFields) {
-    const fieldsNames = Object.keys(customFields);
-    const missingFields = requiredFieldsNames.filter((name) => !fieldsNames.includes(name));
-    if (missingFields?.length > 0) {
-      throw new MissingRequiredCustomFieldError(missingFields);
-    }
-
-    await ValueRepo.updateValues(
-      modelType,
-      instance.id,
-      identifiers,
-      customFields,
-      {
-        transaction: options.transaction,
-        modelOptions,
-      },
-      true,
-    );
 
-    // eslint-disable-next-line no-param-reassign
-    fields.splice(customFieldsIdx, 1);
-  } else if (requiredFieldsNames?.length > 0) {
+  if ((customFieldsIdx === -1 || !instance.customFields) && requiredFieldsNames?.length > 0) {
     throw new MissingRequiredCustomFieldError(requiredFieldsNames);
   }
+  // eslint-disable-next-line no-param-reassign
+  instance.customFields ||= {};
+  const { customFields } = instance;
+  fieldDefinitions.filter((def) => !(def.name in customFields) && ![null, undefined].includes(def.defaultValue)).forEach(({ name, defaultValue }) => {
+    customFields[name] = defaultValue;
+  });
+  if (customFieldsIdx === -1) {
+    return;
+  }
+  const fieldsNames = Object.keys(customFields);
+  const missingFields = requiredFieldsNames.filter((name) => !fieldsNames.includes(name));
+  if (missingFields?.length > 0) {
+    throw new MissingRequiredCustomFieldError(missingFields);
+  }
+
+  await ValueRepo.updateValues(
+    modelType,
+    instance.id,
+    identifiers,
+    customFields,
+    {
+      transaction: options.transaction,
+      modelOptions,
+    },
+  );
+
+  // eslint-disable-next-line no-param-reassign
+  fields.splice(customFieldsIdx, 1);
 };

package/src/repository/definition.ts

@@ -1,4 +1,7 @@
-import { Op, type FindOptions, type WhereOptions } from 'sequelize';
+import {
+  Op,
+  type Includeable, type Transaction, type FindOptions, type WhereOptions,
+} from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
 import type { ModelOptions } from '../types';
@@ -6,9 +9,15 @@ import type { ModelOptions } from '../types';
 export const create = (data: CreateCustomFieldDefinition): Promise<CustomFieldDefinition> =>
   CustomFieldDefinition.create(data);
 
+interface SadotFindOptions {
+  withDisabled?: boolean;
+  transaction?: Transaction;
+  include?: Includeable | Includeable[];
+}
+
 export const findAll = (
   where: WhereOptions,
-  options: any = { withDisabled: false },
+  options: SadotFindOptions = { withDisabled: false },
 ): Promise<CustomFieldDefinition[]> => {
   const queryModel = options.withDisabled
     ? CustomFieldDefinition.unscoped()
@@ -24,12 +33,12 @@ export const findAll = (
 
 export const findByIds = (
   ids: string[],
-  options: any = { withDisabled: false },
+  options: SadotFindOptions = { withDisabled: false },
 ): Promise<CustomFieldDefinition[]> => findAll({ id: { [Op.in]: ids } }, options);
 
 export const findById = (
   id: string,
-  options: any = { withDisabled: false },
+  options: Pick<SadotFindOptions, 'withDisabled'> = { withDisabled: false },
 ): Promise<CustomFieldDefinition | null> => {
   const { withDisabled } = options;
   if (withDisabled) {
@@ -87,13 +96,13 @@ export const update = async (
   return updatedDefinition;
 };
 
-export const disable = (id: string): Promise<any> =>
+export const disable = (id: string): Promise<[affectedCount: number]> =>
   CustomFieldDefinition.update(
     { disabled: true },
     { where: { id } },
   );
 
-export const destroy = (id: string): Promise<any> =>
+export const destroy = (id: string): Promise<number> =>
   CustomFieldDefinition.destroy({ where: { id } });
 
 /**

package/src/repository/value.ts

@@ -67,7 +67,6 @@ export const updateValues = async (
   identifiers: string[],
   valuesToUpdate: ValuesToUpdate,
   options: FindOptions & { modelOptions?: ModelOptions } = {},
-  defineAllDefaults = false,
 ): Promise<CustomFieldValue[]> => {
   const names = Object.keys(valuesToUpdate);
   logger.debug(`custom-fields: updating values for ${modelType} ${modelId}`, {
@@ -81,12 +80,10 @@ export const updateValues = async (
   const where: WhereOptions = {
     modelType,
     name: names,
+    ...(!options.modelOptions?.useEntityIdFromInclude && { entityId: identifiers }),
   };
 
-  if (!options.modelOptions?.useEntityIdFromInclude) {
-    where.entityId = identifiers;
-  }
-  const fieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true, transaction, include: modelOptions.include?.(identifiers) }) || [];
+  const fieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true, transaction, include: modelOptions.include?.(identifiers) }) ?? [];
 
   const disabledDefinitions = fieldDefinitions.filter((def) => def.disabled);
   if (fieldDefinitions.length !== names.length) {
@@ -101,11 +98,8 @@ export const updateValues = async (
     logger.warn(`custom-fields: trying to update disabled values: ${valuesWithDisabledDefinitions.join(', ')}`);
   }
 
-  const visitedFields = new Set<CustomFieldDefinition>();
-
   const values: CreateCustomFieldValue[] = names.map((name) => {
     const fieldDefinition = fieldDefinitions.find((def) => def.name === name);
-    visitedFields.add(fieldDefinition);
     const formatFunction = formatFunctions[fieldDefinition.fieldType];
     return {
       modelId,
@@ -115,17 +109,6 @@ export const updateValues = async (
     };
   });
 
-  if (defineAllDefaults) {
-    fieldDefinitions.filter((def) => !visitedFields.has(def) && ![null, undefined].includes(def.defaultValue)).forEach(({ id, defaultValue }) => {
-      values.push({
-        modelId,
-        value: defaultValue,
-        updatedAt: new Date(),
-        customFieldDefinitionId: id,
-      });
-    });
-  }
-
   return Promise.all(values.map(async (value) => {
     const [cfv] = await CustomFieldValue.upsert(value, {
       transaction: options.transaction,