@autofleet/sadot 0.5.4-beta.18 → 0.5.4-beta.19

package/dist/hooks/create.d.ts

@@ -1,3 +1,4 @@
+import { ModelOptions } from '../types';
 /**
  * A hook to create the custom fields when updating a model (more then one instance).
  */
@@ -6,4 +7,4 @@ export declare const beforeBulkCreate: (options: any) => void;
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export declare const beforeCreate: (scopeAttributes: string[], identifiersReplacer: any) => (instance: any, options: any) => Promise<void>;
+export declare const beforeCreate: (scopeAttributes: string[], modelOptions: ModelOptions) => (instance: any, options: any) => Promise<void>;

package/dist/hooks/create.js

@@ -31,7 +31,6 @@ const errors_1 = require("../errors");
  * A hook to create the custom fields when updating a model (more then one instance).
  */
 const beforeBulkCreate = (options) => {
-    console.log('hooks - before bulk  create');
     // This will activate the beforeCreate hook on each updating instance.
     // eslint-disable-next-line no-param-reassign
     options.individualHooks = true;
@@ -41,13 +40,13 @@ exports.beforeBulkCreate = beforeBulkCreate;
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-const beforeCreate = (scopeAttributes, identifiersReplacer) => async (instance, options) => {
+const beforeCreate = (scopeAttributes, modelOptions) => async (instance, options) => {
     const { fields } = options;
     const modelType = instance.constructor.name;
-    console.log('hooks - before   create');
+    const { scopeAttributeReplacer } = modelOptions;
     let identifiers = scopeAttributes.map((attribute) => instance[attribute]);
-    if (identifiersReplacer) {
-        identifiers = await identifiersReplacer(identifiers);
+    if (scopeAttributeReplacer) {
+        identifiers = await scopeAttributeReplacer(identifiers);
     }
     // get all model's required definitions
     const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType, instance.id, identifiers);

package/dist/hooks/enrich.d.ts

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

package/dist/hooks/enrich.js

@@ -44,8 +44,8 @@ const serializeCustomFields = (customFieldValues, customFieldDefinitionsHash) =>
 /**
  * A hook to attach the custom fields when fetching a model instances.
  */
-const enrichResults = (modelType, scopeAttributes, getScope, hookType, identifiersReplacer) => async (instancesOrInstance, options) => {
-    console.log('hooks - enrichResults', modelType);
+const enrichResults = (modelType, scopeAttributes, getScope, hookType, modelOptions) => async (instancesOrInstance, options) => {
+    const { scopeAttributeReplacer } = modelOptions;
     if (options.originalAttributes?.length > 0
         && !options.originalAttributes?.includes?.('customFields')) {
         return;
@@ -57,8 +57,8 @@ const enrichResults = (modelType, scopeAttributes, getScope, hookType, identifie
     instances = instances.filter(Boolean);
     let identifiers = instances.map((instance) => scopeAttributes
         .map((attr) => instance[attr])).flat();
-    if (identifiersReplacer) {
-        identifiers = await identifiersReplacer(identifiers);
+    if (scopeAttributeReplacer) {
+        identifiers = await scopeAttributeReplacer(identifiers);
     }
     logger_1.default.info('enrichResults - sadot - indentifiers: ', identifiers);
     const uniqueIdentifiers = [...new Set(identifiers)].filter(Boolean);
@@ -66,7 +66,6 @@ const enrichResults = (modelType, scopeAttributes, getScope, hookType, identifie
         ...map,
         [identifier]: [],
     }), {});
-    console.log({ identifierCustomFieldDefinitionsMapping });
     const customFieldDefinitions = await DefinitionRepo.findByEntityIds(modelType, uniqueIdentifiers, { transaction: options.transaction, getScope });
     const definitionsMap = customFieldDefinitions.reduce((map, definition) => ({
         ...map,
@@ -98,9 +97,6 @@ const enrichResults = (modelType, scopeAttributes, getScope, hookType, identifie
         }
         scopeAttributes.forEach((attribute) => {
             const identifier = instance[attribute];
-            console.log({
-                identifier, attribute, instance, identifierCustomFieldDefinitionsMapping,
-            });
             const entityCustomFieldDefinitions = identifierCustomFieldDefinitionsMapping[identifier];
             if (entityCustomFieldDefinitions?.length > 0) {
                 entityCustomFieldDefinitions.forEach((customFieldDefinition) => {

package/dist/hooks/update.d.ts

@@ -1,3 +1,4 @@
+import { ModelOptions } from '../types';
 /**
  * A hook to update the custom fields when updating a model (more then one instance).
  */
@@ -6,4 +7,4 @@ export declare const beforeBulkUpdate: (options: any) => void;
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export declare const beforeUpdate: (scopeAttributes: string[], identifiersReplacer: any) => (instance: any, options: any) => Promise<void>;
+export declare const beforeUpdate: (scopeAttributes: string[], modelOptions: ModelOptions) => (instance: any, options: any) => Promise<void>;

package/dist/hooks/update.js

@@ -33,7 +33,6 @@ const ValueRepo = __importStar(require("../repository/value"));
  * A hook to update the custom fields when updating a model (more then one instance).
  */
 const beforeBulkUpdate = (options) => {
-    console.log('hooks - beforeBulkUpdate');
     // This will activate the beforeUpdate hook on each updating instance.
     // eslint-disable-next-line no-param-reassign
     options.individualHooks = true;
@@ -43,14 +42,14 @@ exports.beforeBulkUpdate = beforeBulkUpdate;
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-const beforeUpdate = (scopeAttributes, identifiersReplacer) => async (instance, options) => {
+const beforeUpdate = (scopeAttributes, modelOptions) => async (instance, options) => {
     logger_1.default.debug('sadot - before update hook');
-    console.log('hooks - beforeUpdate');
     const { fields } = options;
+    const { scopeAttributeReplacer } = modelOptions;
     const modelType = instance.constructor.name;
     let identifiers = scopeAttributes.map((attribute) => instance[attribute]);
-    if (identifiersReplacer) {
-        identifiers = await identifiersReplacer(identifiers);
+    if (scopeAttributeReplacer) {
+        identifiers = await scopeAttributeReplacer(identifiers);
     }
     const customFieldsIdx = fields.indexOf('customFields');
     if (customFieldsIdx > -1) {

package/dist/repository/definition.d.ts

@@ -1,12 +1,11 @@
 import { WhereOptions } from 'sequelize';
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
-import { 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>;
-export declare const findByEntityIds: (modelType: string, entityIds: string[], options?: any, modelOptions?: ModelOptions) => Promise<CustomFieldDefinition[]>;
+export declare const findByEntityIds: (modelType: string, entityIds: string[], options?: any) => 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>;
@@ -15,4 +14,4 @@ export declare const destroy: (id: string) => Promise<any>;
 /**
  * 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 declare const getRequiredFields: (modelType: string, modelId: string | string[], entityId: string | string[]) => Promise<string[]>;

package/dist/repository/definition.js

@@ -17,8 +17,7 @@ const findAll = (where, options = { withDisabled: false }) => {
     return queryModel.scope('userScope').findAll({
         where,
         raw: true,
-        logging: console.log,
-        include: options.include,
+        logging: true,
     });
 };
 exports.findAll = findAll;
@@ -32,11 +31,10 @@ const findById = (id, options = { withDisabled: false }) => {
     return models_1.CustomFieldDefinition.scope('userScope').findByPk(id);
 };
 exports.findById = findById;
-const findByEntityIds = async (modelType, entityIds, options = {}, modelOptions = {}) => models_1.CustomFieldDefinition.findAll({
+const findByEntityIds = async (modelType, entityIds, options = {}) => models_1.CustomFieldDefinition.findAll({
     where: {
         modelType,
         entityId: entityIds,
-        ...modelOptions?.customEntityMapper?.(entityIds),
     },
     transaction: options.transaction,
     include: options.include,
@@ -71,14 +69,13 @@ exports.destroy = destroy;
 /**
  * Return the names of the required fields for a given model
  */
-const getRequiredFields = async (modelType, modelId, entityId, modelOptions = {}) => {
+const getRequiredFields = async (modelType, modelId, entityId) => {
     const entityIds = Array.isArray(entityId) ? entityId : [entityId];
     const requiredFields = await models_1.CustomFieldDefinition.findAll({
         where: {
             required: true,
             modelType,
             entityId: { [sequelize_1.Op.in]: entityIds },
-            ...modelOptions?.customEntityMapper?.(entityIds),
         },
         logging: true,
     });

package/dist/repository/value.js

@@ -102,7 +102,6 @@ const updateValues = async (modelType, modelId, identifiers, valuesToUpdate, opt
     return Promise.all(values.map(async (value) => {
         const [cfv] = await models_1.CustomFieldValue.upsert(value, {
             transaction: options.transaction,
-            logging: console.log,
         });
         return cfv;
     }));

package/dist/types/index.d.ts

@@ -1,8 +1,6 @@
-import { Includeable } from 'sequelize';
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
-    include?: Includeable[];
-    customEntityMapper?: (identifiers: string[]) => any;
+    scopeAttributeReplacer?: (attributes?: string[]) => Promise<any>;
 };
 export type Models = {
     name: string;
@@ -11,7 +9,6 @@ export type Models = {
     creationWebhookHandler?: (instance: any) => any;
     updateWebhookHandler?: (instance: any) => any;
     deletionWebhookHandler?: (instance: any) => any;
-    identifiersReplacer?: (...args: any[]) => Promise<any>;
 };
 export type CustomFieldOptions = {
     models: Models[];

package/dist/utils/init.js

@@ -12,7 +12,7 @@ const scopes_1 = require("../scopes");
 const logger_1 = __importDefault(require("./logger"));
 const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
 const addHooks = (models, getModel) => {
-    models.forEach(async ({ name, scopeAttributes, identifiersReplacer, }) => {
+    models.forEach(async ({ name, scopeAttributes, modelOptions, }) => {
         try {
             const model = getModel(name);
             if (!model) {
@@ -31,11 +31,11 @@ const addHooks = (models, getModel) => {
             model.addHook('beforeFind', 'sadot-beforeFind', (0, hooks_1.beforeFind)(scopeAttributes));
             model.addHook('beforeBulkCreate', 'sadot-beforeBulkCreate', hooks_1.beforeBulkCreate);
             model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', hooks_1.beforeBulkUpdate);
-            model.addHook('beforeCreate', 'sadot-beforeCreate', (0, hooks_1.beforeCreate)(scopeAttributes, identifiersReplacer));
-            model.addHook('beforeUpdate', 'sadot-beforeUpdate', (0, hooks_1.beforeUpdate)(scopeAttributes, identifiersReplacer));
-            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes, 'afterFind', null, identifiersReplacer));
-            model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, identifiersReplacer));
-            model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, identifiersReplacer));
+            model.addHook('beforeCreate', 'sadot-beforeCreate', (0, hooks_1.beforeCreate)(scopeAttributes, modelOptions));
+            model.addHook('beforeUpdate', 'sadot-beforeUpdate', (0, hooks_1.beforeUpdate)(scopeAttributes, modelOptions));
+            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes, 'afterFind', null, modelOptions));
+            model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, modelOptions));
+            model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes, null, null, modelOptions));
         }
         catch (e) {
             logger_1.default.error(`Could not add custom fields hook to model ${name}. `, e);

package/package.json

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

package/src/hooks/create.ts

@@ -1,13 +1,12 @@
 import * as ValueRepo from '../repository/value';
 import * as DefinitionRepo from '../repository/definition';
 import { MissingRequiredCustomFieldError } from '../errors';
+import { ModelOptions } from '../types';
 
 /**
  * A hook to create the custom fields when updating a model (more then one instance).
  */
 export const beforeBulkCreate = (options): void => {
-  console.log('hooks - before bulk  create');
-
   // This will activate the beforeCreate hook on each updating instance.
   // eslint-disable-next-line no-param-reassign
   options.individualHooks = true;
@@ -16,18 +15,17 @@ export const beforeBulkCreate = (options): void => {
  * A hook to create the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export const beforeCreate = (scopeAttributes: string[], identifiersReplacer: any) => async (
+export const beforeCreate = (scopeAttributes: string[], modelOptions: ModelOptions) => async (
   instance,
   options,
 ): Promise<void> => {
   const { fields } = options;
   const modelType = instance.constructor.name;
-
-  console.log('hooks - before   create');
+  const { scopeAttributeReplacer } = modelOptions;
 
   let identifiers = scopeAttributes.map((attribute) => instance[attribute]);
-  if (identifiersReplacer) {
-    identifiers = await identifiersReplacer(identifiers);
+  if (scopeAttributeReplacer) {
+    identifiers = await scopeAttributeReplacer(identifiers);
   }
   // get all model's required definitions
   const requiredFieldsNames = await DefinitionRepo.getRequiredFields(modelType,

package/src/hooks/enrich.ts

@@ -5,6 +5,7 @@ import CustomFieldValue from '../models/CustomFieldValue';
 import CustomFieldDefinition from '../models/CustomFieldDefinition';
 import { SerializedCustomFields } from '../types/definition';
 import logger from '../utils/logger';
+import { ModelOptions } from '../types';
 
 type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
 
@@ -32,13 +33,12 @@ const enrichResults = (
   scopeAttributes: string[],
   getScope,
   hookType?: SupportedHookTypes,
-  identifiersReplacer?: any,
+  modelOptions?: ModelOptions,
 ) => async (
   instancesOrInstance: any | any[],
   options,
 ): Promise<void> => {
-  console.log('hooks - enrichResults', modelType);
-
+  const { scopeAttributeReplacer } = modelOptions;
   if (
     options.originalAttributes?.length > 0
       && !options.originalAttributes?.includes?.('customFields')
@@ -57,8 +57,8 @@ const enrichResults = (
     scopeAttributes
       .map((attr) => instance[attr])).flat();
 
-  if (identifiersReplacer) {
-    identifiers = await identifiersReplacer(identifiers);
+  if (scopeAttributeReplacer) {
+    identifiers = await scopeAttributeReplacer(identifiers);
   }
   logger.info('enrichResults - sadot - indentifiers: ', identifiers);
 
@@ -69,7 +69,6 @@ const enrichResults = (
     [identifier]: [],
 
   }), {});
-  console.log({ identifierCustomFieldDefinitionsMapping });
 
   const customFieldDefinitions = await DefinitionRepo.findByEntityIds(
     modelType,
@@ -118,9 +117,6 @@ const enrichResults = (
 
     scopeAttributes.forEach((attribute) => {
       const identifier = instance[attribute];
-      console.log({
-        identifier, attribute, instance, identifierCustomFieldDefinitionsMapping,
-      });
 
       const entityCustomFieldDefinitions = identifierCustomFieldDefinitionsMapping[identifier];
       if (entityCustomFieldDefinitions?.length > 0) {

package/src/hooks/update.ts

@@ -6,8 +6,6 @@ import { ModelOptions } from '../types';
  * A hook to update the custom fields when updating a model (more then one instance).
  */
 export const beforeBulkUpdate = (options): void => {
-  console.log('hooks - beforeBulkUpdate');
-
   // This will activate the beforeUpdate hook on each updating instance.
   // eslint-disable-next-line no-param-reassign
   options.individualHooks = true;
@@ -17,18 +15,17 @@ export const beforeBulkUpdate = (options): void => {
  * A hook to update the custom fields when updating a model instance.
  * TODO - cleanup if update fail
  */
-export const beforeUpdate = (scopeAttributes: string[], identifiersReplacer: any) => async (
+export const beforeUpdate = (scopeAttributes: string[], modelOptions: ModelOptions) => async (
   instance,
   options,
 ): Promise<void> => {
   logger.debug('sadot - before update hook');
-  console.log('hooks - beforeUpdate');
-
   const { fields } = options;
+  const { scopeAttributeReplacer } = modelOptions;
   const modelType = instance.constructor.name;
   let identifiers = scopeAttributes.map((attribute) => instance[attribute]);
-  if (identifiersReplacer) {
-    identifiers = await identifiersReplacer(identifiers);
+  if (scopeAttributeReplacer) {
+    identifiers = await scopeAttributeReplacer(identifiers);
   }
   const customFieldsIdx = fields.indexOf('customFields');
   if (customFieldsIdx > -1) {

package/src/repository/definition.ts

@@ -4,7 +4,6 @@ import {
 import { CustomFieldDefinition } from '../models';
 import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
 import logger from '../utils/logger';
-import { ModelOptions } from '../types';
 
 export const create = (data: CreateCustomFieldDefinition): Promise<CustomFieldDefinition> =>
   CustomFieldDefinition.create(data);
@@ -21,9 +20,7 @@ export const findAll = (
   return queryModel.scope('userScope').findAll({
     where,
     raw: true,
-    logging: console.log,
-    include: options.include,
-
+    logging: true,
   });
 };
 
@@ -47,12 +44,10 @@ export const findByEntityIds = async (
   modelType: string,
   entityIds: string[],
   options: any = {},
-  modelOptions: ModelOptions = {},
 ): Promise<CustomFieldDefinition[]> => CustomFieldDefinition.findAll({
   where: {
     modelType,
     entityId: entityIds,
-    ...modelOptions?.customEntityMapper?.(entityIds),
   },
   transaction: options.transaction,
   include: options.include,
@@ -103,7 +98,6 @@ export const getRequiredFields = async (
   modelType: string,
   modelId: string | string[],
   entityId: string | string[],
-  modelOptions: ModelOptions = {},
 ): Promise<string[]> => {
   const entityIds = Array.isArray(entityId) ? entityId : [entityId];
   const requiredFields = await CustomFieldDefinition.findAll({
@@ -111,7 +105,6 @@ export const getRequiredFields = async (
       required: true,
       modelType,
       entityId: { [Op.in]: entityIds },
-      ...modelOptions?.customEntityMapper?.(entityIds),
     },
     logging: true,
   });

package/src/repository/value.ts

@@ -89,7 +89,6 @@ export const updateValues = async (
   return Promise.all(values.map(async (value) => {
     const [cfv] = await CustomFieldValue.upsert(value, {
       transaction: options.transaction,
-      logging: console.log,
     });
     return cfv;
   }));

package/src/types/index.ts

@@ -1,11 +1,7 @@
-import { Includeable } from 'sequelize';
-import { ModelCtor } from 'sequelize-typescript';
-
 export type ModelFetcher = (name: string) => any;
 
 export type ModelOptions = {
-  include?: Includeable[];
-  customEntityMapper?: (identifiers: string[]) => any;
+  scopeAttributeReplacer?: (attributes?: string[]) => Promise<any>;
 }
 export type Models = {
   name: string;
@@ -14,7 +10,6 @@ export type Models = {
   creationWebhookHandler?: (instance: any) => any;
   updateWebhookHandler?: (instance: any) => any;
   deletionWebhookHandler?: (instance: any) => any;
-  identifiersReplacer?: (...args) => Promise<any>;
 }
 
 export type CustomFieldOptions = {

package/src/utils/init.ts

@@ -20,7 +20,7 @@ const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
 
 export const addHooks = (models: Models[], getModel: ModelFetcher): void => {
   models.forEach(async ({
-    name, scopeAttributes, identifiersReplacer,
+    name, scopeAttributes, modelOptions,
   }) => {
     try {
       const model = getModel(name);
@@ -40,11 +40,11 @@ export const addHooks = (models: Models[], getModel: ModelFetcher): void => {
       model.addHook('beforeFind', 'sadot-beforeFind', beforeFind(scopeAttributes));
       model.addHook('beforeBulkCreate', 'sadot-beforeBulkCreate', beforeBulkCreate);
       model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', beforeBulkUpdate);
-      model.addHook('beforeCreate', 'sadot-beforeCreate', beforeCreate(scopeAttributes, identifiersReplacer));
-      model.addHook('beforeUpdate', 'sadot-beforeUpdate', beforeUpdate(scopeAttributes, identifiersReplacer));
-      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes, 'afterFind', null, identifiersReplacer));
-      model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes, null, null, identifiersReplacer));
-      model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes, null, null, identifiersReplacer));
+      model.addHook('beforeCreate', 'sadot-beforeCreate', beforeCreate(scopeAttributes, modelOptions));
+      model.addHook('beforeUpdate', 'sadot-beforeUpdate', beforeUpdate(scopeAttributes, modelOptions));
+      model.addHook('afterFind', 'sadot-afterFind', enrichResults(name, scopeAttributes, 'afterFind', null, modelOptions));
+      model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes, null, null, modelOptions));
+      model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes, null, null, modelOptions));
     } catch (e) {
       logger.error(`Could not add custom fields hook to model ${name}. `, e);
     }