dyo-tools 0.1.0-rc2 → 0.2.0

package/test/libs/DYOFinder.spec.ts

@@ -0,0 +1,194 @@
+import {
+  afterEach, beforeEach, describe, expect, jest, test,
+} from '@jest/globals';
+import { DTBunchStub, IDTest } from '../core/DTBunch.double';
+import DYOFinderTest, { DefaultConfiguration, generateComponent } from './DYOFinder.double';
+import { FilterOperatorType } from '../../src/types';
+
+/** *********************** TESTS SUITES ****************************** */
+describe('class DYOFinder', () => {
+  let bunchStubToFind: DTBunchStub;
+  let finder: DYOFinderTest;
+
+  beforeEach(() => {
+    bunchStubToFind = generateComponent();
+    finder = new DYOFinderTest(bunchStubToFind, DefaultConfiguration);
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  describe('constructor()', () => {
+    test('simple initialisation', () => {
+      const newFinder = new DYOFinderTest(bunchStubToFind, DefaultConfiguration);
+
+      expect(newFinder.th_get_component().getId()).toBe(IDTest);
+      expect(newFinder.th_get_configuration()).toStrictEqual(DefaultConfiguration);
+    });
+  });
+
+  describe('execute()', () => {
+    const finderExecutionTestValue = (results: any): [number, []] => [
+      results.length,
+      results.map((result) => result.parentIndex),
+    ];
+
+    test('find items - $eq operator case', () => {
+      // String prop
+      expect(finderExecutionTestValue(finder.execute({ propString: { $eq: 'item_prime' } }))).toStrictEqual([2, [0, 1]]);
+      expect(finderExecutionTestValue(finder.execute({ propString: { $eq: 'invalid' } }))).toStrictEqual([0, []]);
+      // Number prop
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $eq: 17 } }))).toStrictEqual([2, [0, 3]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $eq: 24 } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $eq: '17' } }))).toStrictEqual([0, []]);
+      // Array prop
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $eq: 'tag1' } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $eq: undefined } }))).toStrictEqual([1, [3]]);
+      // Boolean prop
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $eq: true } }))).toStrictEqual([3, [0, 2, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $eq: false } }))).toStrictEqual([2, [1, 3]]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $eq: 'false' } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $eq: null } }))).toStrictEqual([0, []]);
+      // Object prop
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $eq: 'value' } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $eq: "{ data: 'value' }" } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $eq: null } }))).toStrictEqual([2, [3, 4]]);
+    });
+
+    test('find items - $ne operator case', () => {
+      // String prop
+      expect(finderExecutionTestValue(finder.execute({ propString: { $ne: 'item_prime' } }))).toStrictEqual([3, [2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propString: { $ne: 'invalid' } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      // Number prop
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $ne: 17 } }))).toStrictEqual([3, [1, 2, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $ne: 24 } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $ne: '17' } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      // Array prop
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $ne: 'tag1' } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $ne: undefined } }))).toStrictEqual([4, [0, 1, 2, 4]]);
+      // Boolean prop
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $ne: true } }))).toStrictEqual([2, [1, 3]]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $ne: false } }))).toStrictEqual([3, [0, 2, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $ne: 'false' } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $ne: null } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      // Object prop
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $ne: 'value' } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $ne: "{ data: 'value' }" } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $ne: null } }))).toStrictEqual([3, [0, 1, 2]]);
+    });
+
+    test('find items - $in operator case', () => {
+      // String prop
+      expect(finderExecutionTestValue(finder.execute({ propString: { $in: ['item_prime', 'item_second'] } }))).toStrictEqual([4, [0, 1, 2, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propString: { $in: ['item_third', 'invalid', false] } }))).toStrictEqual([1, [3]]);
+      // Number prop
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $in: [17, 19] } }))).toStrictEqual([3, [0, 1, 3]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $in: ['17', 24, false] } }))).toStrictEqual([0, []]);
+      // Array prop
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $in: ['tag1'] } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $in: ['tag1', 'tag2', undefined] } }))).toStrictEqual([1, [3]]);
+      // Boolean prop
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $in: [true, false] } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $in: ['true', 'false', null] } }))).toStrictEqual([0, []]);
+      // Object prop
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $in: ['value'] } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $in: null } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $in: [null] } }))).toStrictEqual([2, [3, 4]]);
+    });
+
+    test('find items - $nin operator case', () => {
+      // String prop
+      expect(finderExecutionTestValue(finder.execute({ propString: { $nin: ['item_prime', 'item_second'] } }))).toStrictEqual([1, [3]]);
+      expect(finderExecutionTestValue(finder.execute({ propString: { $nin: ['item_third', 'invalid', false] } }))).toStrictEqual([4, [0, 1, 2, 4]]);
+      // Number prop
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $nin: [17, 19] } }))).toStrictEqual([2, [2, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $nin: ['17', 24, false] } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      // Array prop
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $nin: ['tag1'] } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $nin: ['tag1', 'tag2', undefined] } }))).toStrictEqual([4, [0, 1, 2, 4]]);
+      // Boolean prop
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $nin: [true, false] } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propBoolean: { $nin: ['true', 'false', null] } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      // Object prop
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $nin: ['value'] } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $nin: null } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propObject: { $nin: [null] } }))).toStrictEqual([3, [0, 1, 2]]);
+    });
+
+    test('find items - $lte operator case', () => {
+      // Number prop
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $lte: 23 } }))).toStrictEqual([4, [0, 1, 2, 3]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $lte: 1000 } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $lte: null } }))).toStrictEqual([0, []]);
+    });
+
+    test('find items - $gte operator case', () => {
+      // Number prop
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $gte: 23 } }))).toStrictEqual([2, [2, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $gte: -1000 } }))).toStrictEqual([5, [0, 1, 2, 3, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propNumber: { $gte: null } }))).toStrictEqual([0, []]);
+    });
+
+    test('find items - $contains operator case', () => {
+      // Array prop
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $contains: 'tag1' } }))).toStrictEqual([3, [0, 1, 2]]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $contains: undefined } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $contains: 'invalid_tag' } }))).toStrictEqual([0, []]);
+    });
+
+    test('find items - $ncontains operator case', () => {
+      // Array prop
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $ncontains: 'tag1' } }))).toStrictEqual([1, [4]]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $ncontains: undefined } }))).toStrictEqual([4, [0, 1, 2, 4]]);
+      expect(finderExecutionTestValue(finder.execute({ propArray: { $ncontains: 'invalid_tag' } }))).toStrictEqual([4, [0, 1, 2, 4]]);
+    });
+
+    test('disable filters by configuration', () => {
+      finder.th_set_configuration({
+        propString: {
+          operators: [FilterOperatorType.NE],
+          getValue: (item: any) => item.getPropString(),
+          objectSearch: false,
+        },
+      });
+
+      expect(finderExecutionTestValue(finder.execute({ propString: { $eq: 'item_prime' } }))).toStrictEqual([0, []]);
+      expect(finderExecutionTestValue(finder.execute({ propString: { $in: ['item_prime', 'item_second'] } }))).toStrictEqual([0, []]);
+    });
+
+    test('returns no items when no filter passed', () => {
+      expect(finderExecutionTestValue(finder.execute({}))).toStrictEqual([0, []]);
+    });
+
+    test('find items with object search property', () => {
+      expect(finderExecutionTestValue(finder.execute(
+        { propMeta: { meta1: { $eq: 'value1' } } },
+      ))).toStrictEqual([2, [0, 1]]);
+      expect(finderExecutionTestValue(finder.execute(
+        { propMeta: { meta2: { $in: ['value2', 'value1'] } } },
+      ))).toStrictEqual([2, [1, 2]]);
+      expect(finderExecutionTestValue(finder.execute(
+        { propMeta: { meta1: { $ne: 'value1' } } },
+      ))).toStrictEqual([2, [2, 4]]);
+      expect(finderExecutionTestValue(finder.execute(
+        { propMeta: { meta1: { } } },
+      ))).toStrictEqual([0, []]);
+    });
+
+    test('find items with complex and multiple filters', () => {
+      // Multiple filters
+      expect(finderExecutionTestValue(finder.execute(
+        { propString: { $eq: 'item_prime' }, propNumber: { $lte: 18 } },
+      ))).toStrictEqual([1, [0]]);
+      // Multiple operators
+      expect(finderExecutionTestValue(finder.execute(
+        { propNumber: { $lte: 25, $gte: 15, $ne: 19 } },
+      ))).toStrictEqual([3, [0, 2, 3]]);
+      // Multiple filters and Object search
+      expect(finderExecutionTestValue(finder.execute(
+        { propString: { $in: ['item_prime', 'item_third'] }, propArray: { $ne: undefined }, propMeta: { meta2: { $ne: undefined } } },
+      ))).toStrictEqual([1, [1]]);
+    });
+  });
+});

package/tsconfig.dev.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2015",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true
+  },
+  "include": [
+    "src/**/*.ts",
+    "test/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2015",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/dist/utils/filters.d.ts

@@ -1,6 +0,0 @@
-import { FilterOperatorType, StandardPrimitiveType } from '../types';
-export declare function validFiltersForItem(itemProp: StandardPrimitiveType, filter: StandardPrimitiveType, operator: FilterOperatorType.EQ): boolean;
-export declare function validFiltersForItem(itemProp: StandardPrimitiveType, filter: StandardPrimitiveType[], operator: FilterOperatorType.IN | FilterOperatorType.NIN): boolean;
-export declare function validFiltersForItem(itemProp: StandardPrimitiveType, filter: StandardPrimitiveType, operator: FilterOperatorType.NE): boolean;
-export declare function validFiltersForItem(itemProp: number, filter: number, operator: FilterOperatorType.LTE | FilterOperatorType.GTE): boolean;
-export declare function validFiltersForItem(itemProp: StandardPrimitiveType[], filter: StandardPrimitiveType, operator: FilterOperatorType.CONTAINS | FilterOperatorType.NCONTAINS): boolean;

package/dist/utils/filters.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validFiltersForItem = void 0;
-const types_1 = require("../types");
-function validFiltersForItem(itemProp, filter, operator = types_1.FilterOperatorType.EQ) {
-    if (operator === types_1.FilterOperatorType.EQ) {
-        return itemProp === filter;
-    }
-    if (operator === types_1.FilterOperatorType.IN) {
-        return filter ? filter.includes(itemProp) : false;
-    }
-    if (operator === types_1.FilterOperatorType.NIN) {
-        return filter ? !filter.includes(itemProp) : false;
-    }
-    if (operator === types_1.FilterOperatorType.NE) {
-        return itemProp !== filter;
-    }
-    if (operator === types_1.FilterOperatorType.LTE) {
-        if (typeof itemProp === 'number' && typeof filter === 'number') {
-            return itemProp <= filter;
-        }
-        return false;
-    }
-    if (operator === types_1.FilterOperatorType.GTE) {
-        if (typeof itemProp === 'number' && typeof filter === 'number') {
-            return itemProp >= filter;
-        }
-        return false;
-    }
-    if (operator === types_1.FilterOperatorType.CONTAINS) {
-        return itemProp ? itemProp.includes(filter) : false;
-    }
-    if (operator === types_1.FilterOperatorType.NCONTAINS) {
-        return itemProp ? !itemProp.includes(filter) : false;
-    }
-    return false;
-}
-exports.validFiltersForItem = validFiltersForItem;
-//# sourceMappingURL=filters.js.map

package/dist/utils/filters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"filters.js","sourceRoot":"","sources":["../../src/utils/filters.ts"],"names":[],"mappings":";;;AAAA,oCAAqE;AAiBrE,SAAgB,mBAAmB,CACjC,QAAyD,EACzD,MAAuD,EACvD,WAA+B,0BAAkB,CAAC,EAAE;IAGpD,IAAI,QAAQ,KAAK,0BAAkB,CAAC,EAAE,EAAE;QACtC,OAAO,QAAQ,KAAK,MAAM,CAAC;KAC5B;IAED,IAAI,QAAQ,KAAK,0BAAkB,CAAC,EAAE,EAAE;QACtC,OAAO,MAAM,CAAC,CAAC,CAAE,MAAkC,CAAC,QAAQ,CAAC,QAAiC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;KACzG;IAED,IAAI,QAAQ,KAAK,0BAAkB,CAAC,GAAG,EAAE;QACvC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAE,MAAkC,CAAC,QAAQ,CAAC,QAAiC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;KAC1G;IAGD,IAAI,QAAQ,KAAK,0BAAkB,CAAC,EAAE,EAAE;QACtC,OAAO,QAAQ,KAAK,MAAM,CAAC;KAC5B;IAED,IAAI,QAAQ,KAAK,0BAAkB,CAAC,GAAG,EAAE;QACvC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9D,OAAO,QAAQ,IAAI,MAAM,CAAC;SAC3B;QACD,OAAO,KAAK,CAAC;KACd;IAED,IAAI,QAAQ,KAAK,0BAAkB,CAAC,GAAG,EAAE;QACvC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9D,OAAO,QAAQ,IAAI,MAAM,CAAC;SAC3B;QACD,OAAO,KAAK,CAAC;KACd;IAED,IAAI,QAAQ,KAAK,0BAAkB,CAAC,QAAQ,EAAE;QAC5C,OAAO,QAAQ,CAAC,CAAC,CAAE,QAAoC,CAAC,QAAQ,CAAC,MAA+B,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;KAC3G;IAED,IAAI,QAAQ,KAAK,0BAAkB,CAAC,SAAS,EAAE;QAC7C,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAE,QAAoC,CAAC,QAAQ,CAAC,MAA+B,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;KAC5G;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AA9CD,kDA8CC"}