@autofleet/sadot 0.5.5-beta.9 → 0.6.0

package/src/utils/init.ts

@@ -2,6 +2,7 @@ import { DataTypes } from 'sequelize';
 import { ModelCtor } from 'sequelize-typescript';
 import { customFields } from '@autofleet/common-types';
 import {
+  CustomFieldDefinition,
   CustomFieldValue,
 } from '../models';
 import {
@@ -14,12 +15,14 @@ import {
 } from '../hooks';
 import { customFieldsFilterScope } from '../scopes';
 import logger from './logger';
-import type { ModelFetcher, ModelOptions } from '../types';
+import type { ModelFetcher, Models } from '../types';
 
 const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
 
-export const addHooks = (models: ModelOptions[], getModel: ModelFetcher): void => {
-  models.forEach(async ({ name, scopeAttributes }) => {
+export const addHooks = (models: Models[], getModel: ModelFetcher): void => {
+  models.forEach(async ({
+    name, scopeAttributes, modelOptions,
+  }) => {
     try {
       const model = getModel(name);
       if (!model) {
@@ -38,18 +41,18 @@ export const addHooks = (models: ModelOptions[], 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));
-      model.addHook('beforeUpdate', 'sadot-beforeUpdate', beforeUpdate(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));
+      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', modelOptions));
+      model.addHook('afterUpdate', 'sadot-afterUpdate', enrichResults(name, scopeAttributes, null, modelOptions));
+      model.addHook('afterCreate', 'sadot-afterCreate', enrichResults(name, scopeAttributes, null, modelOptions));
     } catch (e) {
       logger.error(`Could not add custom fields hook to model ${name}. `, e);
     }
   });
 };
 
-export const removeHooks = (models: ModelOptions[], getModel: ModelFetcher): void => {
+export const removeHooks = (models: Models[], getModel: ModelFetcher): void => {
   models.forEach(async ({ name }) => {
     try {
       const model = getModel(name);
@@ -81,7 +84,7 @@ const addAssociations = (model: ModelCtor, modelName: string): void => {
   CustomFieldValue.belongsTo(model, { foreignKey: 'modelId', as: modelName });
 };
 
-export const addScopes = (models: ModelOptions[], getModel: ModelFetcher): void => {
+export const addScopes = (models: Models[], getModel: ModelFetcher): void => {
   models.forEach(async ({ name, scopeAttributes }) => {
     try {
       const model = getModel(name);
@@ -101,3 +104,9 @@ export const addScopes = (models: ModelOptions[], getModel: ModelFetcher): void
     }
   });
 };
+
+export const applyCustomAssociation = (models: Models[]): void => {
+  models.forEach(({ modelOptions }) => {
+    modelOptions?.customAssociation?.(CustomFieldDefinition);
+  });
+};

package/src/utils/scopeAttributes.ts

@@ -0,0 +1,12 @@
+const mapAttributeToInstance = (scopeAttributes: string[], instance: any) =>
+  scopeAttributes.map((attr) => instance[attr]);
+
+const applyScopeToInstance = (instance: any, scopeAttributes: string[]) => {
+  const uniqueAttributes = Array.from(new Set(scopeAttributes));
+  if (Array.isArray(instance)) {
+    return instance.flatMap((ins) => mapAttributeToInstance(uniqueAttributes, ins));
+  }
+  return mapAttributeToInstance(uniqueAttributes, instance);
+};
+
+export default applyScopeToInstance;

package/dist/tests/functional/searching/index.d.ts

@@ -1,8 +0,0 @@
-interface CustomFieldsSearchTestFlowInput {
-    fieldType: string;
-    fieldValue: string | number;
-    searchTerm: string;
-    expectedNumberOfQueryResults: number;
-}
-declare const customFieldsSearchTestFlow: ({ fieldType, fieldValue, searchTerm, expectedNumberOfQueryResults, }: CustomFieldsSearchTestFlowInput) => Promise<void>;
-export default customFieldsSearchTestFlow;

package/dist/tests/functional/searching/index.js

@@ -1,46 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const sequelize_1 = require("sequelize");
-const index_1 = require("../../../index");
-const DefinitionRepo = __importStar(require("../../../repository/definition"));
-const definition_mock_1 = require("../../mocks/definition.mock");
-const testModel_1 = require("../../mocks/testModel");
-const models_1 = require("../../../models");
-const customFieldsSearchTestFlow = async ({ fieldType, fieldValue, searchTerm, expectedNumberOfQueryResults, }) => {
-    const definition = (0, definition_mock_1.createDefinition)({ fieldType, name: 'coolDefinition' });
-    await DefinitionRepo.create({ ...definition });
-    const [testModel1] = await (0, testModel_1.createTestModels)(definition.entityId, 2);
-    await testModel1.update({ customFields: { [definition.name]: fieldValue } });
-    const models = await models_1.TestModel.findAndCountAll({
-        where: { [sequelize_1.Op.or]: [(0, index_1.buildCustomFieldsSearchWhereClause)(models_1.TestModel, definition.entityId)] },
-        replacements: { searchTerm: `%${searchTerm}%` },
-    });
-    expect(models.count).toBe(expectedNumberOfQueryResults);
-    if (expectedNumberOfQueryResults > 0) {
-        expect(models.rows[0].dataValues.id).toBe(testModel1.id);
-    }
-};
-exports.default = customFieldsSearchTestFlow;

package/dist/utils/helpers/index.d.ts

@@ -1,22 +0,0 @@
-import { WhereOptions, BindOrReplacements } from 'sequelize';
-import { ModelStatic } from 'sequelize-typescript';
-/**
- * Builds a WHERE clause and replacements for free-text search by custom fields.
- *
- * This function constructs a WHERE clause and replacement bindings that allow searching
- * for a given term within custom fields associated with a specific model type and entity ID.
- * The WHERE clause and replacements are designed to be added to the main query.
- *
- * @param {string} searchTerm - The term to search for within custom fields.
- * @param {ModelStatic} model - The Sequelize model representing the entity type to search for.
- * @param {string} entityId - The entity ID to filter the custom fields by.
- *
- * @returns {CustomFieldsSearchPayload} - An object containing the WHERE clause and replacements
- * for Sequelize.
- */
-interface CustomFieldsSearchPayload {
-    where: WhereOptions;
-    replacements: BindOrReplacements;
-}
-export declare const buildCustomFieldsSearchPayload: (searchTerm: string, model: ModelStatic, entityId: string) => CustomFieldsSearchPayload;
-export {};

package/dist/utils/helpers/index.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildCustomFieldsSearchPayload = void 0;
-/* eslint-disable import/prefer-default-export */
-const sequelize_1 = require("sequelize");
-const sequelize_typescript_1 = require("sequelize-typescript");
-const buildCustomFieldsSearchPayload = (searchTerm, model, entityId) => {
-    const subQuery = 'EXISTS ('
-        + ' SELECT 1'
-        + ' FROM "custom_field_values" AS "cv"'
-        + ' INNER JOIN custom_field_definitions AS cd '
-        + ` ON cd.entity_id = '${entityId}'`
-        + ' AND cv.custom_field_definition_id = cd.id '
-        + `   AND cd.model_type = '${model.name}' `
-        + ' WHERE'
-        + ' "cv"."deleted_at" IS NULL'
-        + ` AND "cv"."model_id" = "${model.name}"."id"`
-        + ' AND CAST("cv"."value" AS TEXT) ILIKE :searchTerm)';
-    return {
-        where: {
-            [sequelize_1.Op.or]: [
-                sequelize_typescript_1.Sequelize.where(sequelize_typescript_1.Sequelize.literal(subQuery), true),
-            ],
-        },
-        replacements: { searchTerm: `%${searchTerm}%` },
-    };
-};
-exports.buildCustomFieldsSearchPayload = buildCustomFieldsSearchPayload;

package/src/tests/functional/searching/index.ts

@@ -1,39 +0,0 @@
-import { generateCustomFieldSearchQueryPayload } from '../../../index';
-import * as DefinitionRepo from '../../../repository/definition';
-import { createDefinition } from '../../mocks/definition.mock';
-import { createTestModels } from '../../mocks/testModel';
-import { TestModel } from '../../../models';
-
-interface CustomFieldsSearchTestFlowInput {
-  fieldType: string;
-  fieldValue: string | number;
-  searchTerm: string;
-  expectedNumberOfQueryResults: number;
-}
-
-const customFieldsSearchTestFlow = async ({
-  fieldType,
-  fieldValue,
-  searchTerm,
-  expectedNumberOfQueryResults,
-}: CustomFieldsSearchTestFlowInput) : Promise<void> => {
-  const definition = createDefinition({ fieldType, name: 'coolDefinition' });
-  await DefinitionRepo.create({ ...definition });
-  const [testModel1] = await createTestModels(definition.entityId, 2);
-  await testModel1.update({ customFields: { [definition.name]: fieldValue } });
-  const models = await TestModel.findAndCountAll(
-    {
-      ...generateCustomFieldSearchQueryPayload(
-        searchTerm,
-        TestModel,
-        definition.entityId,
-      ),
-    },
-  );
-  expect(models.count).toBe(expectedNumberOfQueryResults);
-  if (expectedNumberOfQueryResults > 0) {
-    expect(models.rows[0].dataValues.id).toBe(testModel1.id);
-  }
-};
-
-export default customFieldsSearchTestFlow;

package/src/utils/helpers/index.ts

@@ -1,50 +0,0 @@
-/* eslint-disable import/prefer-default-export */
-import { WhereOptions, Op, BindOrReplacements } from 'sequelize';
-import { ModelStatic, Sequelize } from 'sequelize-typescript';
-
-/**
- * Builds a WHERE clause and replacements for free-text search by custom fields.
- *
- * This function constructs a WHERE clause and replacement bindings that allow searching
- * for a given term within custom fields associated with a specific model type and entity ID.
- * The WHERE clause and replacements are designed to be added to the main query.
- *
- * @param {string} searchTerm - The term to search for within custom fields.
- * @param {ModelStatic} model - The Sequelize model representing the entity type to search for.
- * @param {string} entityId - The entity ID to filter the custom fields by.
- *
- * @returns {CustomFieldsSearchPayload} - An object containing the WHERE clause and replacements
- * for Sequelize.
- */
-
-interface CustomFieldsSearchPayload {
-  where: WhereOptions;
-  replacements: BindOrReplacements;
-}
-
-export const generateCustomFieldSearchQueryPayload = (
-  searchTerm: string,
-  model: ModelStatic,
-  entityId : string,
-): CustomFieldsSearchPayload => {
-  const subQuery = 'EXISTS ('
-      + ' SELECT 1'
-      + ' FROM "custom_field_values" AS "cv"'
-      + ' INNER JOIN custom_field_definitions AS cd '
-        + ` ON cd.entity_id = '${entityId}'`
-        + ' AND cv.custom_field_definition_id = cd.id '
-      + `   AND cd.model_type = '${model.name}' `
-      + ' WHERE'
-        + ' "cv"."deleted_at" IS NULL'
-        + ` AND "cv"."model_id" = "${model.name}"."id"`
-        + ' AND CAST("cv"."value" AS TEXT) ILIKE :searchTerm)';
-
-  return {
-    where: {
-      [Op.or]: [
-        Sequelize.where(Sequelize.literal(subQuery), true),
-      ],
-    },
-    replacements: { searchTerm: `%${searchTerm}%` },
-  };
-};