@autofleet/sadot 0.6.2-beta.0 → 0.6.2-beta.1

package/dist/scopes/filter.d.ts

@@ -1,14 +1,11 @@
 import { WhereOptions } from 'sequelize';
+import { Sequelize } from 'sequelize-typescript';
 /**
  * Type representing possible condition values.
  * Currently supporting strings and arrays of strings.
  * More types to be added (TBA).
  */
-type ConditionWithOperator = {
-    operator: string;
-    value: string;
-};
-export type ConditionValue = ConditionWithOperator | ConditionWithOperator[] | string | string[];
+export type ConditionValue = string | string[];
 export type CustomFieldSort = {
     field: string;
     direction: 'ASC' | 'DESC';
@@ -16,6 +13,9 @@ export type CustomFieldSort = {
 export type CustomFieldFilterOptions = {
     where?: WhereOptions;
 };
+export type CustomFieldSortOptions = {
+    order?: [Sequelize['literal']];
+};
 /**
  * A Sequelize scope for filtering models by custom fields.
  * This scope builds a WHERE clause to be applied on the main query.
@@ -24,5 +24,12 @@ export type CustomFieldFilterOptions = {
  * @returns {Function} - A function that takes conditions and returns the Sequelize options object.
  */
 export declare const customFieldsFilterScope: (name: string) => (conditions: Record<string, ConditionValue>) => CustomFieldFilterOptions;
-export declare const scopeName = "filterByCustomFields";
-export {};
+/**
+ * A Sequelize scope for sorting models by custom fields.
+ * This scope builds a order clause to be applied on the main query.
+ */
+export declare const customFieldsSortScope: (name: string) => (sorts: CustomFieldSort[]) => {
+    order?: undefined;
+} | {
+    order: import("sequelize/types/utils").Literal[];
+};

package/dist/scopes/filter.js

@@ -1,18 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scopeName = exports.customFieldsFilterScope = void 0;
+exports.customFieldsSortScope = exports.customFieldsFilterScope = void 0;
 /* eslint-disable import/prefer-default-export */
 const sequelize_1 = require("sequelize");
 const sequelize_typescript_1 = require("sequelize-typescript");
-const common_types_1 = require("@autofleet/common-types");
-const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
-const castIfNeeded = (conditionValue) => {
-    if (!Number.isNaN(Date.parse(conditionValue))) {
-        return '::timestamp';
-    }
-    return '';
-};
-const AND_DELIMETER = ' AND ';
 /**
  * A Sequelize scope for filtering models by custom fields.
  * This scope builds a WHERE clause to be applied on the main query.
@@ -26,39 +17,30 @@ const customFieldsFilterScope = (name) => (conditions) => {
     }
     // Build the WHERE clause for custom field filtering
     const conditionsStrings = Object.entries(conditions)
-        .map(([key, condition]) => {
-        if (Array.isArray(condition)) {
-            if (condition.length === 0) {
+        .map(([key, value]) => {
+        if (Array.isArray(value)) {
+            if (value.length === 0) {
                 // if empty array, the condition is ignored
                 return false;
             }
-            if (typeof condition[0] === 'string') {
-                const values = condition.map((v) => `'${v}'`).join(',');
-                return `(custom_fields->>'${key}') IN (${values})`;
-            }
-            return condition
-                .map((c) => `(custom_fields->>'${key}')${castIfNeeded(c.value)} ${c.operator} '${c.value}'`).join(AND_DELIMETER);
-        }
-        if (typeof condition === 'string') {
-            return `(custom_fields->>'${key}')${castIfNeeded(condition)} = '${condition}'`;
-        }
-        if (condition?.operator) {
-            return `(custom_fields->>'${key}')${castIfNeeded(condition.value)} ${condition.operator} '${condition.value}'`;
+            const values = value.map((v) => `'${v}'`).join(',');
+            return `custom_fields->>'${key}' IN (${values})`;
         }
-        return false;
+        return `custom_fields->>'${key}' = '${value}'`;
     })
         .filter(Boolean);
     if (conditionsStrings.length === 0) {
         return {};
     }
-    const customFieldConditions = conditionsStrings.join(AND_DELIMETER);
+    const customFieldConditions = conditionsStrings.join(' AND ');
     const subQuery = `${'SELECT model_id FROM ('
         + 'SELECT cv.model_id, jsonb_object_agg(cd.name, cv.value) AS custom_fields '
         + 'FROM custom_field_values AS cv '
         + 'INNER JOIN custom_field_definitions AS cd ON cv.custom_field_definition_id = cd.id '
         + `AND cd.model_type = '${name}' `
         + 'GROUP BY cv.model_id'
-        + ') AS CustomFieldAggregation WHERE '}${customFieldConditions}`;
+        + ') AS CustomFieldAggregation '
+        + 'WHERE '}${customFieldConditions}`;
     return {
         where: {
             id: {
@@ -68,4 +50,25 @@ const customFieldsFilterScope = (name) => (conditions) => {
     };
 };
 exports.customFieldsFilterScope = customFieldsFilterScope;
-exports.scopeName = CUSTOM_FIELDS_FILTER_SCOPE;
+/**
+ * A Sequelize scope for sorting models by custom fields.
+ * This scope builds a order clause to be applied on the main query.
+ */
+const customFieldsSortScope = (name) => (sorts) => {
+    if (!sorts || sorts.length === 0) {
+        return {};
+    }
+    const sortStrings = sorts.map(({ field, direction }) => `custom_fields->>'${field}' ${direction}`);
+    const subQuery = `${'SELECT model_id FROM ('
+        + 'SELECT cv.model_id, jsonb_object_agg(cd.name, cv.value) AS custom_fields '
+        + 'FROM custom_field_values AS cv '
+        + 'INNER JOIN custom_field_definitions AS cd ON cv.custom_field_definition_id = cd.id '
+        + `AND cd.model_type = '${name}' `
+        + 'GROUP BY cv.model_id'
+        + ') AS CustomFieldAggregation '
+        + 'ORDER BY '}${sortStrings.join(', ')}`;
+    return {
+        order: [sequelize_typescript_1.Sequelize.literal(`(${subQuery})`)],
+    };
+};
+exports.customFieldsSortScope = customFieldsSortScope;

package/dist/scopes/index.d.ts

@@ -1,2 +1,2 @@
-import { customFieldsFilterScope } from './filter';
-export { customFieldsFilterScope, };
+import { customFieldsFilterScope, customFieldsSortScope } from './filter';
+export { customFieldsFilterScope, customFieldsSortScope, };

package/dist/scopes/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customFieldsFilterScope = void 0;
+exports.customFieldsSortScope = exports.customFieldsFilterScope = void 0;
 /* eslint-disable import/prefer-default-export */
 const filter_1 = require("./filter");
 Object.defineProperty(exports, "customFieldsFilterScope", { enumerable: true, get: function () { return filter_1.customFieldsFilterScope; } });
+Object.defineProperty(exports, "customFieldsSortScope", { enumerable: true, get: function () { return filter_1.customFieldsSortScope; } });

package/dist/utils/init.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyCustomAssociation = exports.addScopes = exports.removeHooks = exports.addHooks = void 0;
 const sequelize_1 = require("sequelize");
 const common_types_1 = require("@autofleet/common-types");
+const custom_fields_1 = require("@autofleet/common-types/lib/custom-fields");
 const models_1 = require("../models");
 const hooks_1 = require("../hooks");
 const scopes_1 = require("../scopes");
@@ -91,6 +92,7 @@ const addScopes = (models, getModel) => {
             addAssociations(model, name);
             // Add filter scope
             model.addScope(CUSTOM_FIELDS_FILTER_SCOPE, (0, scopes_1.customFieldsFilterScope)(name));
+            model.addScope(custom_fields_1.CUSTOM_FIELDS_SORT_SCOPE, (0, scopes_1.customFieldsSortScope)(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.6.2-beta.0",
+  "version": "0.6.2-beta.1",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -29,7 +29,7 @@
     }
   },
   "dependencies": {
-    "@autofleet/common-types": "^1.7.29",
+    "@autofleet/common-types": "^1.7.41-beta.1",
     "@autofleet/errors": "^1.0.10",
     "@autofleet/events": "^2.0.0",
     "@autofleet/logger": "^2.0.5",

package/src/scopes/filter.ts

@@ -1,20 +1,13 @@
 /* eslint-disable import/prefer-default-export */
 import { Op, WhereOptions } from 'sequelize';
 import { Sequelize } from 'sequelize-typescript';
-import { customFields } from '@autofleet/common-types';
-
-const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
 
 /**
  * Type representing possible condition values.
  * Currently supporting strings and arrays of strings.
  * More types to be added (TBA).
  */
-type ConditionWithOperator = {
-    operator: string;
-    value: string;
-};
-export type ConditionValue = ConditionWithOperator | ConditionWithOperator[] | string | string[];
+export type ConditionValue = string | string[];
 
 export type CustomFieldSort = {
     field: string;
@@ -25,13 +18,10 @@ export type CustomFieldFilterOptions = {
   where?: WhereOptions;
 }
 
-const castIfNeeded = (conditionValue: string): string => {
-  if (!Number.isNaN(Date.parse(conditionValue))) {
-    return '::timestamp';
-  }
-  return '';
-};
-const AND_DELIMETER = ' AND ';
+export type CustomFieldSortOptions = {
+    order?: [Sequelize['literal']];
+}
+
 /**
  * A Sequelize scope for filtering models by custom fields.
  * This scope builds a WHERE clause to be applied on the main query.
@@ -48,33 +38,24 @@ export const customFieldsFilterScope = (
   // Build the WHERE clause for custom field filtering
   const conditionsStrings = Object.entries(conditions)
     .map(
-      ([key, condition]) => {
-        if (Array.isArray(condition)) {
-          if (condition.length === 0) {
+      ([key, value]) => {
+        if (Array.isArray(value)) {
+          if (value.length === 0) {
             // if empty array, the condition is ignored
             return false;
           }
-          if (typeof condition[0] === 'string') {
-            const values = condition.map((v) => `'${v}'`).join(',');
-            return `(custom_fields->>'${key}') IN (${values})`;
-          }
-          return condition
-            .map((c) => `(custom_fields->>'${key}')${castIfNeeded(c.value)} ${c.operator} '${c.value}'`).join(AND_DELIMETER);
-        }
-        if (typeof condition === 'string') {
-          return `(custom_fields->>'${key}')${castIfNeeded(condition)} = '${condition}'`;
-        }
-        if (condition?.operator) {
-          return `(custom_fields->>'${key}')${castIfNeeded(condition.value)} ${condition.operator} '${condition.value}'`;
+          const values = value.map((v) => `'${v}'`).join(',');
+          return `custom_fields->>'${key}' IN (${values})`;
         }
-        return false;
+        return `custom_fields->>'${key}' = '${value}'`;
       },
     )
     .filter(Boolean);
+
   if (conditionsStrings.length === 0) {
     return {};
   }
-  const customFieldConditions = conditionsStrings.join(AND_DELIMETER);
+  const customFieldConditions = conditionsStrings.join(' AND ');
 
   const subQuery = `${'SELECT model_id FROM ('
     + 'SELECT cv.model_id, jsonb_object_agg(cd.name, cv.value) AS custom_fields '
@@ -82,7 +63,8 @@ export const customFieldsFilterScope = (
     + 'INNER JOIN custom_field_definitions AS cd ON cv.custom_field_definition_id = cd.id '
     + `AND cd.model_type = '${name}' `
     + 'GROUP BY cv.model_id'
-    + ') AS CustomFieldAggregation WHERE '}${customFieldConditions}`;
+    + ') AS CustomFieldAggregation '
+    + 'WHERE '}${customFieldConditions}`;
 
   return {
     where: {
@@ -93,4 +75,29 @@ export const customFieldsFilterScope = (
   };
 };
 
-export const scopeName = CUSTOM_FIELDS_FILTER_SCOPE;
+/**
+ * A Sequelize scope for sorting models by custom fields.
+ * This scope builds a order clause to be applied on the main query.
+ */
+export const customFieldsSortScope = (
+  name: string,
+) => (sorts: CustomFieldSort[]) => {
+  if (!sorts || sorts.length === 0) {
+    return {};
+  }
+
+  const sortStrings = sorts.map(({ field, direction }) => `custom_fields->>'${field}' ${direction}`);
+
+  const subQuery = `${'SELECT model_id FROM ('
+        + 'SELECT cv.model_id, jsonb_object_agg(cd.name, cv.value) AS custom_fields '
+        + 'FROM custom_field_values AS cv '
+        + 'INNER JOIN custom_field_definitions AS cd ON cv.custom_field_definition_id = cd.id '
+        + `AND cd.model_type = '${name}' `
+        + 'GROUP BY cv.model_id'
+        + ') AS CustomFieldAggregation '
+        + 'ORDER BY '}${sortStrings.join(', ')}`;
+
+  return {
+    order: [Sequelize.literal(`(${subQuery})`)],
+  };
+};

package/src/scopes/index.ts

@@ -1,6 +1,7 @@
 /* eslint-disable import/prefer-default-export */
-import { customFieldsFilterScope } from './filter';
+import { customFieldsFilterScope, customFieldsSortScope } from './filter';
 
 export {
   customFieldsFilterScope,
+  customFieldsSortScope,
 };

package/src/utils/init.ts

@@ -1,6 +1,7 @@
 import { DataTypes } from 'sequelize';
 import { ModelCtor } from 'sequelize-typescript';
 import { customFields } from '@autofleet/common-types';
+import { CUSTOM_FIELDS_SORT_SCOPE } from '@autofleet/common-types/lib/custom-fields';
 import {
   CustomFieldDefinition,
   CustomFieldValue,
@@ -13,7 +14,7 @@ import {
   beforeCreate,
   beforeBulkCreate,
 } from '../hooks';
-import { customFieldsFilterScope } from '../scopes';
+import { customFieldsFilterScope, customFieldsSortScope } from '../scopes';
 import logger from './logger';
 import type { ModelFetcher, Models } from '../types';
 
@@ -99,6 +100,7 @@ export const addScopes = (models: Models[], getModel: ModelFetcher): void => {
       addAssociations(model, name);
       // Add filter scope
       model.addScope(CUSTOM_FIELDS_FILTER_SCOPE, customFieldsFilterScope(name));
+      model.addScope(CUSTOM_FIELDS_SORT_SCOPE, customFieldsSortScope(name));
     } catch (e) {
       logger.error(`Could not add custom fields scopes to model ${name}. `, e);
     }