@autofleet/sadot 0.5.5-beta.7 → 0.5.5-beta.8

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

@@ -1,10 +1,22 @@
-import { WhereOptions } from 'sequelize';
+import { WhereOptions, BindOrReplacements } from 'sequelize';
 import { ModelStatic } from 'sequelize-typescript';
 /**
- * This function builds a WHERE clause to be added to the main query.
- * The WHERE clause enable free term search by custom fields.
+ * Builds a WHERE clause and replacements for free-text search by custom fields.
  *
- * @param {string} name - The model type name to be search for.
- * @returns {WhereOptions} - A where clause to be added to the main query.
+ * 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.
  */
-export declare const buildCustomFieldsSearchWhereClause: (model: ModelStatic, entityId: string) => WhereOptions;
+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,17 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildCustomFieldsSearchWhereClause = void 0;
+exports.buildCustomFieldsSearchPayload = void 0;
 /* eslint-disable import/prefer-default-export */
 const sequelize_1 = require("sequelize");
 const sequelize_typescript_1 = require("sequelize-typescript");
-/**
- * This function builds a WHERE clause to be added to the main query.
- * The WHERE clause enable free term search by custom fields.
- *
- * @param {string} name - The model type name to be search for.
- * @returns {WhereOptions} - A where clause to be added to the main query.
- */
-const buildCustomFieldsSearchWhereClause = (model, entityId) => {
+const buildCustomFieldsSearchPayload = (searchTerm, model, entityId) => {
     const subQuery = 'EXISTS ('
         + ' SELECT 1'
         + ' FROM "custom_field_values" AS "cv"'
@@ -24,9 +17,12 @@ const buildCustomFieldsSearchWhereClause = (model, entityId) => {
         + ` AND "cv"."model_id" = "${model.name}"."id"`
         + ' AND CAST("cv"."value" AS TEXT) ILIKE :searchTerm)';
     return {
-        [sequelize_1.Op.or]: [
-            sequelize_typescript_1.Sequelize.where(sequelize_typescript_1.Sequelize.literal(subQuery), true),
-        ],
+        where: {
+            [sequelize_1.Op.or]: [
+                sequelize_typescript_1.Sequelize.where(sequelize_typescript_1.Sequelize.literal(subQuery), true),
+            ],
+        },
+        replacements: { searchTerm: `%${searchTerm}%` },
     };
 };
-exports.buildCustomFieldsSearchWhereClause = buildCustomFieldsSearchWhereClause;
+exports.buildCustomFieldsSearchPayload = buildCustomFieldsSearchPayload;

package/package.json

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

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

@@ -1,5 +1,4 @@
-import { Op } from 'sequelize';
-import { buildCustomFieldsSearchWhereClause } from '../../../index';
+import { generateCustomFieldSearchQueryPayload } from '../../../index';
 import * as DefinitionRepo from '../../../repository/definition';
 import { createDefinition } from '../../mocks/definition.mock';
 import { createTestModels } from '../../mocks/testModel';
@@ -24,8 +23,11 @@ const customFieldsSearchTestFlow = async ({
   await testModel1.update({ customFields: { [definition.name]: fieldValue } });
   const models = await TestModel.findAndCountAll(
     {
-      where: { [Op.or]: [buildCustomFieldsSearchWhereClause(TestModel, definition.entityId)] },
-      replacements: { searchTerm: `%${searchTerm}%` },
+      ...generateCustomFieldSearchQueryPayload(
+        searchTerm,
+        TestModel,
+        definition.entityId,
+      ),
     },
   );
   expect(models.count).toBe(expectedNumberOfQueryResults);

package/src/utils/helpers/index.ts

@@ -1,19 +1,32 @@
 /* eslint-disable import/prefer-default-export */
-import { WhereOptions, Op } from 'sequelize';
+import { WhereOptions, Op, BindOrReplacements } from 'sequelize';
 import { ModelStatic, Sequelize } from 'sequelize-typescript';
 
 /**
- * This function builds a WHERE clause to be added to the main query.
- * The WHERE clause enable free term search by custom fields.
+ * Builds a WHERE clause and replacements for free-text search by custom fields.
  *
- * @param {string} name - The model type name to be search for.
- * @returns {WhereOptions} - A where clause to be added to the main query.
+ * 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.
  */
 
-export const buildCustomFieldsSearchWhereClause = (
+interface CustomFieldsSearchPayload {
+  where: WhereOptions;
+  replacements: BindOrReplacements;
+}
+
+export const generateCustomFieldSearchQueryPayload = (
+  searchTerm: string,
   model: ModelStatic,
   entityId : string,
-): WhereOptions => {
+): CustomFieldsSearchPayload => {
   const subQuery = 'EXISTS ('
       + ' SELECT 1'
       + ' FROM "custom_field_values" AS "cv"'
@@ -25,9 +38,13 @@ export const buildCustomFieldsSearchWhereClause = (
         + ' "cv"."deleted_at" IS NULL'
         + ` AND "cv"."model_id" = "${model.name}"."id"`
         + ' AND CAST("cv"."value" AS TEXT) ILIKE :searchTerm)';
+
   return {
-    [Op.or]: [
-      Sequelize.where(Sequelize.literal(subQuery), true),
-    ],
+    where: {
+      [Op.or]: [
+        Sequelize.where(Sequelize.literal(subQuery), true),
+      ],
+    },
+    replacements: { searchTerm: `%${searchTerm}%` },
   };
 };