fix: add generic argument for parse-query function

tada5hi · Oct 21, 2022 · ac0e89f · ac0e89f
1 parent e38de51
commit ac0e89f
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 15 deletions.
diff --git a/src/build/module.ts b/src/build/module.ts
@@ -5,6 +5,7 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
+import { ObjectLiteral } from '../type';
 import { BuildInput } from './type';
 import {
     buildQueryFields,
@@ -22,7 +23,7 @@ import {
     buildURLQueryString,
 } from '../utils';
 
-export function buildQuery<T extends Record<string, any>>(
+export function buildQuery<T extends ObjectLiteral = ObjectLiteral>(
     input?: BuildInput<T>,
 ) : string {
     if (

diff --git a/src/parse/module.ts b/src/parse/module.ts
@@ -13,12 +13,13 @@ import {
     SortParseOutput,
 } from '../parameter';
 import { Parameter, URLParameter } from '../constants';
+import { ObjectLiteral } from '../type';
 import { parseQueryParameter } from './parameter';
 import { ParseInput, ParseOptions, ParseOutput } from './type';
 
-export function parseQuery(
+export function parseQuery<T extends ObjectLiteral = ObjectLiteral>(
     input: ParseInput,
-    options?: ParseOptions,
+    options?: ParseOptions<T extends unknown ? ObjectLiteral : T>,
 ) : ParseOutput {
     options ??= {};
 

diff --git a/src/parse/parameter/module.ts b/src/parse/parameter/module.ts
@@ -11,14 +11,18 @@ import {
 import {
     Parameter, URLParameter,
 } from '../../constants';
+import { ObjectLiteral } from '../../type';
 import { ParseParameterOptions, ParseParameterOutput } from './type';
 
-export function parseQueryParameter<K extends `${Parameter}` | `${URLParameter}`>(
-    key: K,
+export function parseQueryParameter<
+    P extends `${Parameter}` | `${URLParameter}`,
+    T extends ObjectLiteral = ObjectLiteral,
+    >(
+    key: P,
     data: unknown,
-    options?: ParseParameterOptions<K>,
+    options?: ParseParameterOptions<P, T extends unknown ? ObjectLiteral : T>,
     relations?: RelationsParseOutput,
-): ParseParameterOutput<K> {
+): ParseParameterOutput<P> {
     switch (key) {
         case Parameter.FIELDS:
         case URLParameter.FIELDS:
@@ -28,7 +32,7 @@ export function parseQueryParameter<K extends `${Parameter}` | `${URLParameter}`
                     ...(invalidToEmptyObject(options)) as ParseParameterOptions<Parameter.FIELDS>,
                     ...(relations ? { relations } : {}),
                 },
-            ) as ParseParameterOutput<K>);
+            ) as ParseParameterOutput<P>);
         case Parameter.FILTERS:
         case URLParameter.FILTERS:
             return (parseQueryFilters(
@@ -37,31 +41,31 @@ export function parseQueryParameter<K extends `${Parameter}` | `${URLParameter}`
                     ...(invalidToEmptyObject(options)) as ParseParameterOptions<Parameter.FILTERS>,
                     ...(relations ? { relations } : {}),
                 },
-            ) as ParseParameterOutput<K>);
+            ) as ParseParameterOutput<P>);
         case Parameter.PAGINATION:
         case URLParameter.PAGINATION:
             return (parseQueryPagination(
                 data,
                 {
                     ...(invalidToEmptyObject(options)) as ParseParameterOptions<Parameter.PAGINATION>,
                 },
-            ) as ParseParameterOutput<K>);
+            ) as ParseParameterOutput<P>);
         case Parameter.RELATIONS:
         case URLParameter.RELATIONS:
             return (parseQueryRelations(
                 data,
                 {
                     ...(invalidToEmptyObject(options)) as ParseParameterOptions<Parameter.RELATIONS>,
                 },
-            ) as ParseParameterOutput<K>);
+            ) as ParseParameterOutput<P>);
         default:
             return (parseQuerySort(
                 data,
                 {
                     ...(invalidToEmptyObject(options)) as ParseParameterOptions<Parameter.SORT>,
                     ...(relations ? { relations } : {}),
                 },
-            ) as ParseParameterOutput<K>);
+            ) as ParseParameterOutput<P>);
     }
 }
 

diff --git a/src/parse/parameter/type.ts b/src/parse/parameter/type.ts
@@ -19,10 +19,11 @@ import {
 } from '../../parameter';
 
 import { Parameter, URLParameter } from '../../constants';
+import { ObjectLiteral } from '../../type';
 
 export type ParseParameterOptions<
     P extends `${Parameter}` | `${URLParameter}`,
-    T extends Record<string, any> = Record<string, any>,
+    T extends ObjectLiteral = ObjectLiteral,
     > =
     P extends `${Parameter.FIELDS}` | `${URLParameter.FIELDS}` ?
         FieldsParseOptions<T> :

diff --git a/src/parse/type.ts b/src/parse/type.ts
@@ -6,6 +6,7 @@
  */
 
 import { Parameter, URLParameter } from '../constants';
+import { ObjectLiteral } from '../type';
 
 import { ParseParameterOptions, ParseParameterOutput } from './parameter';
 
@@ -17,11 +18,11 @@ export type ParseInput = {
 
 //------------------------------------------------
 
-export type ParseOptions = {
+export type ParseOptions<T extends ObjectLiteral = ObjectLiteral> = {
     /**
      * On default all query keys are enabled.
      */
-    [K in `${Parameter}`]?: ParseParameterOptions<K>
+    [P in `${Parameter}`]?: ParseParameterOptions<P, T>
 } & {
     defaultPath?: string
 };