@autofleet/sadot 1.1.7-beta → 1.1.8

package/src/hooks/enrich.ts

@@ -1,255 +0,0 @@
-/* eslint-disable no-param-reassign */
-import * as ValueRepo from '../repository/value';
-import * as DefinitionRepo from '../repository/definition';
-import * as EntriesRepo from '../repository/entries';
-import type CustomFieldValue from '../models/CustomFieldValue';
-import type CustomFieldDefinition from '../models/CustomFieldDefinition';
-import type { SerializedCustomFields } from '../types/definition';
-import type { CustomFieldOptions, ModelOptions, TransactionOptions } from '../types';
-import applyScopeToInstance from '../utils/scopeAttributes';
-
-// Include all required fields for proper functioning
-const CUSTOM_FIELD_DEFINITION_ATTRIBUTES_TO_PULL = [
-  'id',
-  'name',
-  'entityId',
-  'fieldType',
-  'displayName',
-  'validation',
-  'entityType',
-  'modelType',
-  'required',
-  'disabled',
-  'defaultValue',
-];
-
-type SupportedHookTypes = 'afterFind' | 'afterCreate' | 'afterUpdate';
-
-type CustomFieldEntries = Record<string, any>;
-
-interface GetValuesGroupByInstanceResponse {
-  [modelId: string]: CustomFieldValue[];
-}
-
-interface GetCustomFieldEntriesByInstanceIdResponse {
-  [modelId: string]: CustomFieldEntries;
-}
-
-export const getCustomFieldEntriesByInstanceId = async ({
-  instancesIds,
-  options,
-  sadotOptions,
-}: {
-  instancesIds: string[],
-  options?: TransactionOptions,
-  sadotOptions: Pick<CustomFieldOptions, 'useCustomFieldsEntries'>,
-}): Promise<GetCustomFieldEntriesByInstanceIdResponse> => {
-  if (!sadotOptions.useCustomFieldsEntries) {
-    return {};
-  }
-
-  const customFieldEntries = await EntriesRepo.findEntriesByModelIds(
-    instancesIds,
-    options ?? {},
-  );
-
-  const customFieldEntriesByInstanceId = Object.fromEntries(customFieldEntries.map((instanceEntries) => {
-    const { modelId, customFields } = instanceEntries?.dataValues ?? {};
-    if (!modelId) {
-      return undefined;
-    }
-    return [modelId, customFields];
-  }).filter(Boolean));
-
-  instancesIds.forEach((instanceId) => {
-    customFieldEntriesByInstanceId[instanceId] ??= {};
-  });
-
-  return customFieldEntriesByInstanceId;
-};
-
-export const getValuesGroupByInstance = async ({
-  instancesIds,
-  options,
-  sadotOptions,
-}: {
-  instancesIds: string[],
-  options?: TransactionOptions,
-  sadotOptions: Pick<CustomFieldOptions, 'useCustomFieldsEntries'>,
-}): Promise<GetValuesGroupByInstanceResponse> => {
-  if (sadotOptions.useCustomFieldsEntries) {
-    return {};
-  }
-
-  const customFieldValues = await ValueRepo.findValuesByModelIds(
-    instancesIds,
-    options ?? {},
-  );
-
-  // Group fields by modelId
-  return customFieldValues.reduce((acc, v) => {
-    const { modelId } = v;
-    acc[modelId] ??= [];
-    acc[modelId].push(v);
-    return acc;
-  }, {});
-};
-
-/**
- * Serialize custom fields value into the format of {[name] -> [fieldData]}
- */
-const serializeCustomFields = (
-  customFieldValues: CustomFieldValue[],
-  customFieldDefinitionsHash: Record<string, CustomFieldDefinition>,
-): SerializedCustomFields => {
-  const customFields = customFieldValues.reduce((acc, cfv) => ({
-    ...acc,
-    ...(
-      customFieldDefinitionsHash[cfv.customFieldDefinitionId]
-      && { [customFieldDefinitionsHash[cfv.customFieldDefinitionId].name]: cfv.value }
-    ),
-  }), {});
-  return customFields;
-};
-/**
- * A hook to attach the custom fields when fetching a model instances.
- */
-const enrichResults = (
-  modelType: string,
-  scopeAttributes: string[],
-  hookType?: SupportedHookTypes,
-  modelOptions: ModelOptions = {},
-  sadotOptions: Pick<CustomFieldOptions, 'useCustomFieldsEntries'> = { useCustomFieldsEntries: false },
-) => async (
-  instancesOrInstance: any | any[],
-  options: TransactionOptions,
-): Promise<void> => {
-  if (
-    options.originalAttributes?.length > 0
-      && !options.originalAttributes?.includes?.('customFields')
-  ) {
-    return;
-  }
-
-  const primaryKey = 'id';
-  let instances = Array.isArray(instancesOrInstance)
-    ? instancesOrInstance
-    : [instancesOrInstance];
-
-  instances = instances.filter(Boolean);
-
-  const identifiers = applyScopeToInstance(instances, scopeAttributes);
-
-  const uniqueIdentifiers = [...new Set(identifiers)].filter(Boolean);
-
-  const identifierCustomFieldDefinitionsMapping = uniqueIdentifiers.reduce((map, identifier) => ({
-    ...map,
-    [identifier]: [],
-  }), {});
-
-  // Cache for definitions by model type and transaction to avoid redundant DB queries
-  let customFieldDefinitionsPromise;
-  let cacheKey;
-
-  if (options.transaction) {
-    // Initialize definition cache Map if not already present directly on the transaction object
-    options.transaction.definitionCache ||= new Map();
-    cacheKey = `${modelType}:${uniqueIdentifiers.slice().sort().join(',')}`;
-    customFieldDefinitionsPromise = options.transaction.definitionCache.get(cacheKey);
-  }
-
-  if (!customFieldDefinitionsPromise) {
-    // Fetch from database (either first time in this transaction or no transaction)
-    customFieldDefinitionsPromise = DefinitionRepo.findByEntityIds(
-      modelType,
-      uniqueIdentifiers,
-      { transaction: options.transaction, modelOptions, attributes: CUSTOM_FIELD_DEFINITION_ATTRIBUTES_TO_PULL },
-    );
-
-    options.transaction?.definitionCache?.set(cacheKey, customFieldDefinitionsPromise);
-  }
-  const customFieldDefinitions = await customFieldDefinitionsPromise;
-
-  if (customFieldDefinitions.length === 0) {
-    // if no custom fields, we can return
-    instances.forEach((instance) => {
-      instance.customFields = {};
-    });
-    return;
-  }
-
-  if (modelOptions?.include && modelOptions.useEntityIdFromInclude) {
-    // if we pass useEntityIdFromInclude,
-    //  map the entity from the options to the identifierCustomFieldDefinitionsMapping
-    modelOptions.include(identifiers).forEach(({ model }) => {
-      customFieldDefinitions.forEach((cfd) => {
-        const entityId = cfd[`${model.name}.entityId`];
-        identifierCustomFieldDefinitionsMapping[entityId] = [];
-      });
-    });
-  }
-
-  const definitionsMap = customFieldDefinitions.reduce((map, definition) => ({
-    ...map,
-    [definition.id]: definition,
-  }), {});
-
-  customFieldDefinitions.forEach((cfd) => {
-    identifierCustomFieldDefinitionsMapping[cfd.entityId].push(cfd);
-  });
-
-  // Get the values per instates ids:
-  const instancesIds = instances.map((i) => i[primaryKey]);
-
-  // Group fields by modelId
-  const [valuesGroupByInstance, customFieldEntriesByInstanceId] = await Promise.all([
-    getValuesGroupByInstance({
-      instancesIds,
-      options,
-      sadotOptions,
-    }),
-    getCustomFieldEntriesByInstanceId({
-      instancesIds,
-      options,
-      sadotOptions,
-    }),
-  ]);
-
-  // Attach custom fields to the instances
-  instances.forEach((instance) => {
-    const { id } = instance;
-
-    const instanceValues = valuesGroupByInstance[id];
-    const serializedCustomFieldsValues = instanceValues ? serializeCustomFields(instanceValues, definitionsMap) : {};
-
-    const customFields = sadotOptions.useCustomFieldsEntries
-      ? customFieldEntriesByInstanceId[id]
-      : serializedCustomFieldsValues;
-
-    scopeAttributes.forEach((attribute) => {
-      const identifier = instance[attribute];
-
-      const entityCustomFieldDefinitions = identifierCustomFieldDefinitionsMapping[identifier];
-      if (entityCustomFieldDefinitions?.length > 0) {
-        entityCustomFieldDefinitions.forEach((customFieldDefinition) => {
-          if (customFields[customFieldDefinition.name] === undefined) {
-            customFields[customFieldDefinition.name] = null;
-          }
-        });
-      }
-    });
-    instance.customFields = customFields;
-    options.attributesToRemove?.forEach?.((attribute) => {
-      delete instance.dataValues?.[attribute];
-      // 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);
-    }
-  });
-};
-
-export default enrichResults;

package/src/hooks/find.ts

@@ -1,27 +0,0 @@
-/* eslint-disable no-param-reassign */
-import logger from '../utils/logger';
-
-const doScopeAttributesMissing = (
-  scopeAttributes: string[],
-  queryAttributes: (string | string[])[],
-): string[] => {
-  const attributes = scopeAttributes
-    .filter((attribute) => !queryAttributes.includes(attribute));
-  if (!queryAttributes.includes?.('id')) {
-    attributes.push('id');
-  }
-  return attributes;
-};
-
-// eslint-disable-next-line import/prefer-default-export
-export const beforeFind = (scopeAttributes: string[]) => (options): void => {
-  const { attributes: queryAttributes } = options;
-  if (queryAttributes?.includes?.('customFields')) {
-    const missingScopeAttributes = doScopeAttributesMissing(scopeAttributes, queryAttributes);
-    logger.debug('sadot - before find hook');
-    if (missingScopeAttributes?.length > 0) {
-      queryAttributes.push(...missingScopeAttributes);
-      options.attributesToRemove = missingScopeAttributes;
-    }
-  }
-};