@autofleet/sadot 0.6.0 → 0.6.1-beta.1

package/dist/index.d.ts

@@ -3,6 +3,8 @@ import { Sequelize } from 'sequelize-typescript';
 import type { CustomFieldOptions, ModelFetcher } from './types';
 export * from './utils/validations/custom-fields';
 export * from './utils/constants';
+export * from './utils/helpers';
+export { CustomFieldDefinitionType } from './utils/validations/type';
 /**
  * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
  * @see {@link 'custom-fields/config'} for configurations

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.disableCustomFields = void 0;
+exports.disableCustomFields = exports.CustomFieldDefinitionType = void 0;
 const models_1 = require("./models");
 const api_1 = __importDefault(require("./api"));
 const db_1 = __importDefault(require("./utils/db"));
@@ -25,6 +25,9 @@ const logger_1 = __importDefault(require("./utils/logger"));
 const init_1 = require("./utils/init");
 __exportStar(require("./utils/validations/custom-fields"), exports);
 __exportStar(require("./utils/constants"), exports);
+__exportStar(require("./utils/helpers"), exports);
+var type_1 = require("./utils/validations/type");
+Object.defineProperty(exports, "CustomFieldDefinitionType", { enumerable: true, get: function () { return type_1.CustomFieldDefinitionType; } });
 /**
  * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
  * @see {@link 'custom-fields/config'} for configurations

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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,44 @@
+"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 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({
+        ...(0, index_1.generateCustomFieldSearchQueryPayload)(searchTerm, models_1.TestModel, definition.entityId),
+    });
+    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

@@ -0,0 +1,25 @@
+import { WhereOptions, BindOrReplacements } from 'sequelize';
+import { ModelStatic } from 'sequelize-typescript';
+import { CustomFieldDefinitionType } from '../validations/type';
+/**
+ * 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.
+ * @param {CustomFieldDefinitionType[]} excludedCustomFieldsTypes - An array of custom field types
+ * to exclude from the search
+ *
+ * @returns {CustomFieldsSearchPayload} - An object containing the WHERE clause and replacements
+ * for Sequelize.
+ */
+interface CustomFieldsSearchPayload {
+    where: WhereOptions;
+    replacements: BindOrReplacements;
+}
+export declare const generateCustomFieldSearchQueryPayload: (searchTerm: string, model: ModelStatic, entityId: string, customFieldsTypesToExclude?: CustomFieldDefinitionType[]) => CustomFieldsSearchPayload;
+export {};

package/dist/utils/helpers/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateCustomFieldSearchQueryPayload = void 0;
+/* eslint-disable import/prefer-default-export */
+const sequelize_1 = require("sequelize");
+const sequelize_typescript_1 = require("sequelize-typescript");
+const type_1 = require("../validations/type");
+const generateCustomFieldSearchQueryPayload = (searchTerm, model, entityId, customFieldsTypesToExclude = [
+    type_1.CustomFieldDefinitionType.DATETIME,
+    type_1.CustomFieldDefinitionType.DATE,
+]) => {
+    const excludedTypesString = customFieldsTypesToExclude.map((type) => `'${type}'`).join(',');
+    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}'`
+        + ` ${excludedTypesString ? `AND cd.field_type NOT IN (${excludedTypesString})` : ''}`
+        + ' 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.generateCustomFieldSearchQueryPayload = generateCustomFieldSearchQueryPayload;

package/package.json

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

package/src/index.ts

@@ -15,6 +15,9 @@ export * from './utils/validations/custom-fields';
 
 export * from './utils/constants';
 
+export * from './utils/helpers';
+
+export { CustomFieldDefinitionType } from './utils/validations/type';
 /**
  * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
  * @see {@link 'custom-fields/config'} for configurations

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

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1,60 @@
+/* eslint-disable import/prefer-default-export */
+import { WhereOptions, Op, BindOrReplacements } from 'sequelize';
+import { ModelStatic, Sequelize } from 'sequelize-typescript';
+import { CustomFieldDefinitionType } from '../validations/type';
+
+/**
+ * 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.
+ * @param {CustomFieldDefinitionType[]} excludedCustomFieldsTypes - An array of custom field types
+ * to exclude from the search
+ *
+ * @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,
+  customFieldsTypesToExclude : CustomFieldDefinitionType[] = [
+    CustomFieldDefinitionType.DATETIME,
+    CustomFieldDefinitionType.DATE,
+  ],
+): CustomFieldsSearchPayload => {
+  const excludedTypesString = customFieldsTypesToExclude.map((type) => `'${type}'`).join(',');
+
+  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}'`
+        + ` ${excludedTypesString ? `AND cd.field_type NOT IN (${excludedTypesString})` : ''}`
+      + ' 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}%` },
+  };
+};