zibri 2.3.0 → 2.4.1

package/src/data-source/models/where/date-where-filter.model.ts

@@ -1,21 +1,9 @@
-import { BaseWhereFilter } from './base-where-filter.model';
+import { BaseWhereFilter, BaseWhereFilterObject } from './base-where-filter.model';
 
 /**
- * A filter for a date where property.
+ * The date where filter object.
  */
-export type DateWhereFilter = BaseWhereFilter<Date> | {
-    /**
-     * The property needs to be not this value.
-     */
-    not?: Date,
-    /**
-     * The property needs to be one of the values in the array.
-     */
-    oneOf?: Date[],
-    /**
-     * The property needs to be NOT one of the values in the array.
-     */
-    notOneOf?: Date[],
+type DateFilterWhereObject = BaseWhereFilterObject<Date> & {
     /**
      * The property needs to be after the value.
      */
@@ -24,4 +12,9 @@ export type DateWhereFilter = BaseWhereFilter<Date> | {
      * The property needs to be before the value.
      */
     before?: Date
-};
+};
+
+/**
+ * A filter for a date where property.
+ */
+export type DateWhereFilter = BaseWhereFilter<Date, DateFilterWhereObject>;

package/src/data-source/models/where/number-where-filter.model.ts

@@ -1,35 +1,28 @@
-import { BaseWhereFilter } from './base-where-filter.model';
+import { BaseWhereFilter, BaseWhereFilterObject } from './base-where-filter.model';
 
 /**
- * A filter for a number where property.
+ * The number where filter object.
  */
-export type NumberWhereFilter = BaseWhereFilter<number> | {
-    /**
-     * The property needs to be not this value.
-     */
-    not?: number,
-    /**
-     * The property needs to be one of the values in the array.
-     */
-    oneOf?: number[],
-    /**
-     * The property needs to be NOT one of the values in the array.
-     */
-    notOneOf?: number[],
+type NumberWhereFilterObject<T extends number | bigint> = BaseWhereFilterObject<T> & {
     /**
      * The property needs to be greater than the provided value.
      */
-    greaterThan?: number,
+    greaterThan?: T,
     /**
      * The property needs to be greater than or equal to the provided value.
      */
-    greaterThanEquals?: number,
+    greaterThanEquals?: T,
     /**
      * The property needs to be lesser than the provided value.
      */
-    lesserThan?: number,
+    lesserThan?: T,
     /**
      * The property needs to be lesser than or equal to the provided value.
      */
-    lesserThanEquals?: number
-};
+    lesserThanEquals?: T
+};
+
+/**
+ * A filter for a number where property.
+ */
+export type NumberWhereFilter<T extends number | bigint> = BaseWhereFilter<T, NumberWhereFilterObject<T>>;

package/src/data-source/models/where/object-where-filter.model.ts

@@ -3,10 +3,69 @@ import { Where } from './where-filter.model';
 /**
  * A filter for a object where property.
  */
-export type ObjectWhereFilter<T extends Object> = null
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    | { equals: T, where?: never, not?: never, oneOf?: never, notOneOf?: never }
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    | { equals?: never, where: Where<T>, not?: never, oneOf?: never, notOneOf?: never }
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    | { equals?: never, where?: never, not?: T, oneOf?: T[], notOneOf?: T[] };
+export type ObjectWhereFilter<T extends Object> = {
+    /**
+     * The property needs to equal the value.
+     */
+    is: T | null,
+    /**
+     * A where condition that the property needs to match.
+     */
+    where?: never,
+    /**
+     * The property needs to be not this value.
+     */
+    not?: never,
+    /**
+     * The property should be one of the provided values.
+     */
+    oneOf?: never,
+    /**
+     * The property should NOT be one of the provided values.
+     */
+    notOneOf?: never
+}
+| {
+    /**
+     * The property needs to equal the value.
+     */
+    is?: never,
+    /**
+     * A where condition that the property needs to match.
+     */
+    where: Where<T>,
+    /**
+     * The property needs to be not this value.
+     */
+    not?: never,
+    /**
+     * The property should be one of the provided values.
+     */
+    oneOf?: never,
+    /**
+     * The property should NOT be one of the provided values.
+     */
+    notOneOf?: never
+}
+| {
+    /**
+     * The property needs to equal the value.
+     */
+    is?: never,
+    /**
+     * A where condition that the property needs to match.
+     */
+    where?: never,
+    /**
+     * The property needs to be not this value.
+     */
+    not?: T | null,
+    /**
+     * The property should be one of the provided values.
+     */
+    oneOf?: (T | null)[],
+    /**
+     * The property should NOT be one of the provided values.
+     */
+    notOneOf?: (T | null)[]
+};

package/src/data-source/models/where/string-where-filter.model.ts

@@ -1,21 +1,9 @@
-import { BaseWhereFilter } from './base-where-filter.model';
+import { BaseWhereFilter, BaseWhereFilterObject } from './base-where-filter.model';
 
 /**
- * A filter for a string where property.
+ * The string where filter object.
  */
-export type StringWhereFilter = BaseWhereFilter<string> | {
-    /**
-     * The property needs to be not this value.
-     */
-    not?: string,
-    /**
-     * The property needs to be one of the values in the array.
-     */
-    oneOf?: string[],
-    /**
-     * The property needs to be NOT one of the values in the array.
-     */
-    notOneOf?: string[],
+type StringWhereFilterObject = BaseWhereFilterObject<string> & {
     /**
      * The property needs to be like the provided string.
      * @example '%.com'
@@ -26,4 +14,9 @@ export type StringWhereFilter = BaseWhereFilter<string> | {
      * @example '%.cOm'
      */
     iLike?: string
-};
+};
+
+/**
+ * A filter for a string where property.
+ */
+export type StringWhereFilter = BaseWhereFilter<string, StringWhereFilterObject>;

package/src/data-source/models/where/where-filter-keys.model.ts

@@ -0,0 +1,88 @@
+
+import { ArrayWhereFilter, ObjectArrayWhereFilter } from './array-where-filter.model';
+import { BooleanWhereFilter } from './boolean-where-filter.model';
+import { DateWhereFilter } from './date-where-filter.model';
+import { NumberWhereFilter } from './number-where-filter.model';
+import { ObjectWhereFilter } from './object-where-filter.model';
+import { StringWhereFilter } from './string-where-filter.model';
+import { ExcludeStrict } from '../../../types/exclude-strict.type';
+import { ObjectUtilities } from '../../../utilities/object.utilities';
+
+/**
+ * Where filter keys of object properties.
+ */
+type ObjectWhereFilterKeys = keyof ObjectWhereFilter<object>;
+
+/**
+ * Where filter keys of array properties.
+ */
+type ArrayWhereFilterKeys = keyof ExcludeStrict<ArrayWhereFilter<object>, null | object[]>;
+
+/**
+ * Where filter keys of object array properties.
+ */
+type ObjectArrayWhereFilterKeys = keyof ExcludeStrict<ObjectArrayWhereFilter<object>, null | object[]>;
+
+/**
+ * Where filter keys of boolean properties.
+ */
+type BooleanWhereFilterKeys = keyof BooleanWhereFilter;
+
+/**
+ * Where filter keys of date properties.
+ */
+type DateWhereFilterKeys = keyof ExcludeStrict<DateWhereFilter, null | Date>;
+
+/**
+ * Where filter keys of number properties.
+ */
+type NumberWhereFilterKeys = keyof ExcludeStrict<NumberWhereFilter<number | bigint>, null | (number | bigint)>;
+
+/**
+ * Where filter keys of string properties.
+ */
+type StringWhereFilterKeys = keyof ExcludeStrict<StringWhereFilter, null | string>;
+
+/**
+ * All where filter keys.
+ */
+export type WhereFilterKeys = ArrayWhereFilterKeys
+    | ObjectArrayWhereFilterKeys
+    | BooleanWhereFilterKeys
+    | DateWhereFilterKeys
+    | NumberWhereFilterKeys
+    | ObjectWhereFilterKeys
+    | StringWhereFilterKeys;
+
+const whereFilterKeysRecord: Record<WhereFilterKeys, WhereFilterKeys> = {
+    not: 'not',
+    like: 'like',
+    oneOf: 'oneOf',
+    notOneOf: 'notOneOf',
+    after: 'after',
+    before: 'before',
+    greaterThan: 'greaterThan',
+    greaterThanEquals: 'greaterThanEquals',
+    lesserThan: 'lesserThan',
+    lesserThanEquals: 'lesserThanEquals',
+    iLike: 'iLike',
+    is: 'is',
+    where: 'where',
+    includes: 'includes',
+    isIncludedIn: 'isIncludedIn',
+    length: 'length',
+    lengthGreaterThan: 'lengthGreaterThan',
+    lengthLesserThanEquals: 'lengthLesserThanEquals',
+    lengthGreaterThanEquals: 'lengthGreaterThanEquals',
+    lengthLesserThan: 'lengthLesserThan'
+};
+const whereFilterKeySet: Set<WhereFilterKeys> = new Set<WhereFilterKeys>(ObjectUtilities.values(whereFilterKeysRecord));
+
+// eslint-disable-next-line jsdoc/require-returns
+/**
+ * Checks if the given key is a where filter key.
+ * @param key - The key to check.
+ */
+export function isWhereFilterKey(key: unknown): key is WhereFilterKeys {
+    return whereFilterKeySet.has(key as WhereFilterKeys);
+}

package/src/data-source/models/where/where-filter-to-find-options-where-function.test.ts

@@ -1,11 +1,35 @@
 /* eslint-disable unicorn/no-null */
-import { describe, expect, it } from '@jest/globals';
-import { EqualOperator, FindOptionsWhere, FindOperator, Equal, Raw } from 'typeorm';
+import { afterAll, beforeAll, describe, expect, it } from '@jest/globals';
+import { EqualOperator, FindOptionsWhere, FindOperator, Equal, FindOptionsWhere as ToFindOptionsWhere } from 'typeorm';
 
-import { whereFilterToFindOptionsWhere } from './where-filter-to-find-options-where.function';
-import { Where } from './where-filter.model';
+import { Where, WhereFilter } from './where-filter.model';
 import { Address } from '../../../__testing__/mocks/entities/address.model';
 import { User } from '../../../__testing__/mocks/entities/user.entity';
+import { createTestDataSource } from '../../../__testing__/test-server/create-test-data-source.function';
+import { StartedTestServer, startTestServer } from '../../../__testing__/test-server/start-test-server.function';
+import { inject } from '../../../di/inject.function';
+import { Newable } from '../../../types/newable.type';
+import { DataSource } from '../../decorators/data-source.decorator';
+
+@DataSource()
+class DbDataSource extends createTestDataSource() {}
+
+function whereFilterToFindOptionsWhere<T extends object>(
+    filter: Where<T>,
+    entityClass: Newable<T>
+): Where<T> extends WhereFilter<T>[] ? ToFindOptionsWhere<T>[] : ToFindOptionsWhere<T> {
+    return inject(DbDataSource).whereFilterToFindOptionsWhere(filter, entityClass);
+}
+
+let server: StartedTestServer;
+
+beforeAll(async () => {
+    server = await startTestServer({ dataSources: [DbDataSource] });
+}, 15000);
+
+afterAll(async () => {
+    await server.shutdown();
+});
 
 describe('whereFilterToFindOptionsWhere - primitive filters', () => {
     it('string equality', () => {
@@ -79,16 +103,15 @@ describe('whereFilterToFindOptionsWhere - date filters', () => {
 });
 
 describe('whereFilterToFindOptionsWhere - object filters', () => {
-    it('nested where on json fields yields Raw operator', () => {
+    it('nested where on json fields yields Raw operator with inline SQL', () => {
         const filter: Where<User> = { address: { where: { street: 'Main St' } } };
         const result: FindOptionsWhere<User> = whereFilterToFindOptionsWhere(filter, User);
-        const expectedResult: FindOptionsWhere<User> = {
-            address: Raw<Address>(
-                alias => `${alias} @> :json`,
-                { json: { street: Equal('Main St') } }
-            )
-        };
-        expect(JSON.stringify(result)).toEqual(JSON.stringify(expectedResult));
+
+        expect(result.address).toBeInstanceOf(FindOperator);
+        const raw: FindOperator<Address> = result.address as FindOperator<Address>;
+
+        const sql: string | undefined = raw.getSql?.('"TestAlias"."address"');
+        expect(sql).toEqual('("TestAlias"."address"->>\'street\') = \'Main St\'');
     });
     it('nested where on relation fields yields nested filter', () => {
         const filter: Where<User> = { company: { where: { id: '42' } } };

package/src/data-source/models/where/where-filter.model.ts

@@ -1,4 +1,4 @@
-import { ArrayWhereFilter } from './array-where-filter.model';
+import { ArrayWhereFilter, ObjectArrayWhereFilter } from './array-where-filter.model';
 import { BooleanWhereFilter } from './boolean-where-filter.model';
 import { DateWhereFilter } from './date-where-filter.model';
 import { NumberWhereFilter } from './number-where-filter.model';
@@ -20,17 +20,22 @@ export type WhereFilter<T extends Object> = {
 /**
  * The definition for a single where filter property.
  */
-export type WhereFilterProperty<T> = T extends string
-    ? StringWhereFilter
-    : T extends number
-        ? NumberWhereFilter
-        : T extends boolean
-            ? BooleanWhereFilter
-            // eslint-disable-next-line typescript/no-explicit-any
-            : T extends any[]
-                ? ArrayWhereFilter<T[number]>
-                : T extends Date
-                    ? DateWhereFilter
-                    : T extends object
-                        ? ObjectWhereFilter<T>
-                        : never;
+export type WhereFilterProperty<T> = T extends bigint
+    ? NumberWhereFilter<bigint>
+    : T extends string
+        ? StringWhereFilter
+        : T extends number
+            ? NumberWhereFilter<number>
+            : T extends boolean
+                ? BooleanWhereFilter
+                : T extends (infer ItemType)[]
+                    ? ItemType extends Date
+                        ? ArrayWhereFilter<ItemType>
+                        : ItemType extends object
+                            ? ObjectArrayWhereFilter<ItemType>
+                            : ArrayWhereFilter<ItemType>
+                    : T extends Date
+                        ? DateWhereFilter
+                        : T extends object
+                            ? ObjectWhereFilter<T>
+                            : never;