@autofleet/sadot 0.5.2 → 0.5.4-beta.0

package/dist/index.d.ts

@@ -10,3 +10,4 @@ export * from './utils/constants';
 declare const useCustomFields: (app: Application | null, getModel: ModelFetcher, options: CustomFieldOptions) => Promise<Sequelize>;
 export default useCustomFields;
 export declare const disableCustomFields: (models: any, getModel: any) => void;
+export declare const getCustomFieldsSearchLiteral: (modelName: string, searchTerm: string) => string;

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.getCustomFieldsSearchLiteral = exports.disableCustomFields = void 0;
 const models_1 = require("./models");
 const api_1 = __importDefault(require("./api"));
 const db_1 = __importDefault(require("./utils/db"));
@@ -50,3 +50,5 @@ const disableCustomFields = (models, getModel) => {
     (0, init_1.removeHooks)(models, getModel);
 };
 exports.disableCustomFields = disableCustomFields;
+const getCustomFieldsSearchLiteral = (modelName, searchTerm) => `EXISTS (SELECT 1 FROM "custom_field_values" AS "cv" WHERE "cv"."deleted_at" IS NULL AND "cv"."model_id" = "${modelName}"."id" AND CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`;
+exports.getCustomFieldsSearchLiteral = getCustomFieldsSearchLiteral;

package/dist/scopes/filter.js

@@ -4,7 +4,8 @@ exports.scopeName = exports.customFieldsFilterScope = void 0;
 /* eslint-disable import/prefer-default-export */
 const sequelize_1 = require("sequelize");
 const sequelize_typescript_1 = require("sequelize-typescript");
-const constants_1 = require("../utils/constants");
+const common_types_1 = require("@autofleet/common-types");
+const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
 /**
  * A Sequelize scope for filtering models by custom fields.
  * This scope builds a WHERE clause to be applied on the main query.
@@ -51,4 +52,4 @@ const customFieldsFilterScope = (name) => (conditions) => {
     };
 };
 exports.customFieldsFilterScope = customFieldsFilterScope;
-exports.scopeName = constants_1.CUSTOM_FIELDS_FILTER_SCOPE;
+exports.scopeName = CUSTOM_FIELDS_FILTER_SCOPE;

package/dist/scopes/include.d.ts

@@ -0,0 +1,9 @@
+import { WhereOptions } from 'sequelize';
+export type CustomFieldSearchOptions = {
+    where?: WhereOptions;
+};
+export declare const customFieldsSearchScope: (name: string) => ({ searchTerm, queryWithSearchTerm }: {
+    searchTerm: any;
+    queryWithSearchTerm: any;
+}) => CustomFieldSearchOptions;
+export declare const scopeName = "searchByCustomFields";

package/dist/scopes/include.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scopeName = exports.customFieldsSearchScope = void 0;
+const sequelize_typescript_1 = require("sequelize-typescript");
+const customFieldsSearchScope = (name) => ({ searchTerm, queryWithSearchTerm }) => {
+    const subQuery = `${'EXISTS (SELECT 1 '
+        + 'FROM "custom_field_values" AS "cv" '
+        + 'WHERE '
+        + '"cv"."deleted_at" IS NULL AND '
+        + `"cv"."model_id" = "${name}"."id" AND `
+        + `CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`}`;
+    return {
+        where: {
+            $or: [
+                sequelize_typescript_1.Sequelize.literal(`(${subQuery})`),
+                ...queryWithSearchTerm.$and[0].$or,
+            ],
+        },
+    };
+};
+exports.customFieldsSearchScope = customFieldsSearchScope;
+exports.scopeName = 'searchByCustomFields';

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

@@ -1,2 +1,5 @@
+declare const CUSTOM_FIELDS_FILTER_SCOPE: string;
 export declare const supportedEntities: string[];
-export declare const CUSTOM_FIELDS_FILTER_SCOPE = "filterByCustomFields";
+export { 
+/** @deprecated Use the value from `@autofleet/common-types` instead */
+CUSTOM_FIELDS_FILTER_SCOPE, };

package/dist/utils/constants/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CUSTOM_FIELDS_FILTER_SCOPE = exports.supportedEntities = void 0;
+const common_types_1 = require("@autofleet/common-types");
+const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
+exports.CUSTOM_FIELDS_FILTER_SCOPE = CUSTOM_FIELDS_FILTER_SCOPE;
 // eslint-disable-next-line import/prefer-default-export
 exports.supportedEntities = ['businessModelId', 'fleetId', 'demandSourceId'];
-exports.CUSTOM_FIELDS_FILTER_SCOPE = 'filterByCustomFields';

package/dist/utils/init.js

@@ -5,11 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addScopes = exports.removeHooks = exports.addHooks = void 0;
 const sequelize_1 = require("sequelize");
+const common_types_1 = require("@autofleet/common-types");
 const models_1 = require("../models");
 const hooks_1 = require("../hooks");
 const scopes_1 = require("../scopes");
 const logger_1 = __importDefault(require("./logger"));
-const constants_1 = require("./constants");
+const include_1 = require("../scopes/include");
+const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
 const addHooks = (models, getModel) => {
     models.forEach(async ({ name, scopeAttributes }) => {
         try {
@@ -89,7 +91,8 @@ const addScopes = (models, getModel) => {
             // Necessary associations for the filtering scope
             addAssociations(model, name);
             // Add filter scope
-            model.addScope(constants_1.CUSTOM_FIELDS_FILTER_SCOPE, (0, scopes_1.customFieldsFilterScope)(name));
+            model.addScope(CUSTOM_FIELDS_FILTER_SCOPE, (0, scopes_1.customFieldsFilterScope)(name));
+            model.addScope('searchByCustomFields', (0, include_1.customFieldsSearchScope)(name));
         }
         catch (e) {
             logger_1.default.error(`Could not add custom fields scopes to model ${name}. `, e);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.5.2",
+  "version": "0.5.4-beta.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -12,6 +12,7 @@
     "dev": "nodemon"
   },
   "dependencies": {
+    "@autofleet/common-types": "^1.7.29",
     "@autofleet/errors": "^1.0.10",
     "@autofleet/events": "^2.0.0",
     "@autofleet/logger": "^2.0.5",

package/src/index.ts

@@ -43,3 +43,8 @@ export default useCustomFields;
 export const disableCustomFields = (models, getModel): void => {
   removeHooks(models, getModel);
 };
+
+export const getCustomFieldsSearchLiteral = (
+  modelName: string,
+  searchTerm: string,
+) : string => `EXISTS (SELECT 1 FROM "custom_field_values" AS "cv" WHERE "cv"."deleted_at" IS NULL AND "cv"."model_id" = "${modelName}"."id" AND CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`;

package/src/scopes/filter.ts

@@ -1,7 +1,9 @@
 /* eslint-disable import/prefer-default-export */
 import { Op, WhereOptions } from 'sequelize';
 import { Sequelize } from 'sequelize-typescript';
-import { CUSTOM_FIELDS_FILTER_SCOPE } from '../utils/constants';
+import { customFields } from '@autofleet/common-types';
+
+const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
 
 /**
  * Type representing possible condition values.

package/src/scopes/include.ts

@@ -0,0 +1,30 @@
+/* eslint-disable import/prefer-default-export */
+import { WhereOptions } from 'sequelize';
+import { Sequelize } from 'sequelize-typescript';
+
+export type CustomFieldSearchOptions = {
+  where?: WhereOptions;
+}
+
+export const customFieldsSearchScope = (
+  name: string,
+) => ({ searchTerm, queryWithSearchTerm }) : CustomFieldSearchOptions => {
+  const subQuery = `${
+    'EXISTS (SELECT 1 '
+    + 'FROM "custom_field_values" AS "cv" '
+    + 'WHERE '
+    + '"cv"."deleted_at" IS NULL AND '
+    + `"cv"."model_id" = "${name}"."id" AND `
+    + `CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`}`;
+
+  return {
+    where: {
+      $or: [
+        Sequelize.literal(`(${subQuery})`),
+        ...queryWithSearchTerm.$and[0].$or,
+      ],
+    },
+  };
+};
+
+export const scopeName = 'searchByCustomFields';

package/src/utils/constants/index.ts

@@ -1,4 +1,11 @@
+import { customFields } from '@autofleet/common-types';
+
+const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
+
 // eslint-disable-next-line import/prefer-default-export
 export const supportedEntities = ['businessModelId', 'fleetId', 'demandSourceId'];
 
-export const CUSTOM_FIELDS_FILTER_SCOPE = 'filterByCustomFields';
+export {
+  /** @deprecated Use the value from `@autofleet/common-types` instead */
+  CUSTOM_FIELDS_FILTER_SCOPE,
+};

package/src/utils/init.ts

@@ -1,5 +1,6 @@
 import { DataTypes } from 'sequelize';
 import { ModelCtor } from 'sequelize-typescript';
+import { customFields } from '@autofleet/common-types';
 import {
   CustomFieldValue,
 } from '../models';
@@ -14,7 +15,9 @@ import {
 import { customFieldsFilterScope } from '../scopes';
 import logger from './logger';
 import type { ModelFetcher, ModelOptions } from '../types';
-import { CUSTOM_FIELDS_FILTER_SCOPE } from './constants';
+import { customFieldsSearchScope } from '../scopes/include';
+
+const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
 
 export const addHooks = (models: ModelOptions[], getModel: ModelFetcher): void => {
   models.forEach(async ({ name, scopeAttributes }) => {
@@ -94,6 +97,7 @@ export const addScopes = (models: ModelOptions[], getModel: ModelFetcher): void
       addAssociations(model, name);
       // Add filter scope
       model.addScope(CUSTOM_FIELDS_FILTER_SCOPE, customFieldsFilterScope(name));
+      model.addScope('searchByCustomFields', customFieldsSearchScope(name));
     } catch (e) {
       logger.error(`Could not add custom fields scopes to model ${name}. `, e);
     }