feathers-utils 3.1.3 → 4.1.0

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 import * as _feathersjs_feathers from '@feathersjs/feathers';
-import { HookContext, Application, Id, Query, Params } from '@feathersjs/feathers';
+import { HookContext, Application, Id, HookOptions, Query, Params } from '@feathersjs/feathers';
 import { HookContext as HookContext$1, Application as Application$1 } from '@feathersjs/feathers/lib';
 import { PropertyPath, DebouncedFunc } from 'lodash';
-import { AdapterBase, FilterQueryOptions as FilterQueryOptions$1, PaginationOptions } from '@feathersjs/adapter-commons';
+import { PaginationOptions, FilterQueryOptions } from '@feathersjs/adapter-commons';
 import { HookType } from 'feathers-hooks-common';
 
 /**
@@ -125,35 +125,29 @@ declare class DebouncedStore {
 
 declare function debounceMixin(options?: Partial<InitDebounceMixinOptions>): (app: Application$1) => void;
 
-interface FilterQueryOptions<T> {
-    service?: AdapterBase<T>;
-    operators?: FilterQueryOptions$1["operators"];
-    filters?: FilterQueryOptions$1["filters"];
-}
-declare function filterQuery<T>(query: Query, _options?: FilterQueryOptions<T>): any;
-
-type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-type FirstLast = "first" | "last";
-type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
-interface MergeQueryOptions<T> extends FilterQueryOptions<T> {
-    defaultHandle: Handle;
-    actionOnEmptyIntersect: ActionOnEmptyIntersect;
-    useLogicalConjunction: boolean;
-    handle?: {
-        [key: string]: Handle;
-    };
-}
-
-declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
-
+declare function defineHooks<A extends Application = Application, S = {
+    find: any;
+    get: any;
+    create: any;
+    update: any;
+    patch: any;
+    remove: any;
+}, Options = HookOptions<A, S>>(hooks: Options): Options;
+
+type FilterQueryResult<Q extends Query> = {
+    $select: Q["$select"] extends any ? Q["$select"] : never;
+    $limit: Q["$limit"] extends any ? Q["$limit"] : never;
+    $skip: Q["$skip"] extends any ? Q["$skip"] : never;
+    $sort: Q["$sort"] extends any ? Q["$sort"] : never;
+    query: Omit<Q, "$select" | "$limit" | "$skip" | "$sort">;
+};
 /**
- * Merges two queries into one.
- * @param target Query to be merged into
- * @param source Query to be merged from
- * @param _options
- * @returns Query
+ * Extracts $select, $limit, $skip, $sort from a query and returns the rest as a query object.
+ *
+ * @param providedQuery
+ * @returns
  */
-declare function mergeQuery<T = any>(target: Query, source: Query, _options?: Partial<MergeQueryOptions<T>>): Query;
+declare function filterQuery<Q extends Query>(providedQuery?: Q): FilterQueryResult<Q>;
 
 /**
  * util to get paginate options from context
@@ -184,6 +178,29 @@ declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Applicati
  */
 declare function markHookForSkip<H extends HookContext = HookContext>(hookName: string, type: "all" | MaybeArray<HookType>, context?: H): H;
 
+type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
+type FirstLast = "first" | "last";
+type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
+interface MergeQueryOptions {
+    defaultHandle: Handle;
+    actionOnEmptyIntersect: ActionOnEmptyIntersect;
+    useLogicalConjunction: boolean;
+    handle?: {
+        [key: string]: Handle;
+    };
+}
+
+declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
+
+/**
+ * Merges two queries into one.
+ * @param target Query to be merged into
+ * @param source Query to be merged from
+ * @param _options
+ * @returns Query
+ */
+declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+
 interface PushSetOptions {
     unique?: boolean;
 }
@@ -192,6 +209,11 @@ interface PushSetOptions {
  */
 declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val: unknown, options?: PushSetOptions) => unknown[];
 
+type SetQueryKeySafelyOptions = {
+    mutate?: boolean;
+};
+declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
@@ -205,21 +227,16 @@ type ShouldSkipOptions = {
  */
 declare const shouldSkip: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
 
+declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
+
 /**
  * util to validate a query for operators
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
-
-type SetQueryKeySafelyOptions = {
-    mutate?: boolean;
-};
-declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
-
-declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions$1) => any; };
+declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
-declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions$1) => any; };
+declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
 type Single<T> = T extends Array<infer U> ? U : T;
 type AsArray<T> = T extends any[] ? T : [T];
@@ -267,4 +284,4 @@ type InferRemoveResultFromPath<App extends Application, Path extends string, IdO
 type InferDataFromPath<App extends Application, Path extends string, Method extends "create" | "update" | "patch"> = Method extends "create" ? InferCreateDataFromPath<App, Path> : Method extends "update" ? InferUpdateDataFromPath<App, Path> : Method extends "patch" ? InferPatchDataFromPath<App, Path> : never;
 type InferResultFromPath<App extends Application, Path extends string, Method extends "get" | "find" | "create" | "update" | "patch" | "remove"> = Method extends "get" ? InferGetResultFromPath<App, Path> : Method extends "find" ? InferFindResultFromPath<App, Path> : Method extends "create" ? InferCreateResultFromPath<App, Path> : Method extends "update" ? InferUpdateResultFromPath<App, Path> : Method extends "patch" ? InferPatchResultFromPath<App, Path> : Method extends "remove" ? InferRemoveResultFromPath<App, Path> : never;
 
-export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FilterQueryOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, defineHooks, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as _feathersjs_feathers from '@feathersjs/feathers';
-import { HookContext, Application, Id, Query, Params } from '@feathersjs/feathers';
+import { HookContext, Application, Id, HookOptions, Query, Params } from '@feathersjs/feathers';
 import { HookContext as HookContext$1, Application as Application$1 } from '@feathersjs/feathers/lib';
 import { PropertyPath, DebouncedFunc } from 'lodash';
-import { AdapterBase, FilterQueryOptions as FilterQueryOptions$1, PaginationOptions } from '@feathersjs/adapter-commons';
+import { PaginationOptions, FilterQueryOptions } from '@feathersjs/adapter-commons';
 import { HookType } from 'feathers-hooks-common';
 
 /**
@@ -125,35 +125,29 @@ declare class DebouncedStore {
 
 declare function debounceMixin(options?: Partial<InitDebounceMixinOptions>): (app: Application$1) => void;
 
-interface FilterQueryOptions<T> {
-    service?: AdapterBase<T>;
-    operators?: FilterQueryOptions$1["operators"];
-    filters?: FilterQueryOptions$1["filters"];
-}
-declare function filterQuery<T>(query: Query, _options?: FilterQueryOptions<T>): any;
-
-type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-type FirstLast = "first" | "last";
-type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
-interface MergeQueryOptions<T> extends FilterQueryOptions<T> {
-    defaultHandle: Handle;
-    actionOnEmptyIntersect: ActionOnEmptyIntersect;
-    useLogicalConjunction: boolean;
-    handle?: {
-        [key: string]: Handle;
-    };
-}
-
-declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
-
+declare function defineHooks<A extends Application = Application, S = {
+    find: any;
+    get: any;
+    create: any;
+    update: any;
+    patch: any;
+    remove: any;
+}, Options = HookOptions<A, S>>(hooks: Options): Options;
+
+type FilterQueryResult<Q extends Query> = {
+    $select: Q["$select"] extends any ? Q["$select"] : never;
+    $limit: Q["$limit"] extends any ? Q["$limit"] : never;
+    $skip: Q["$skip"] extends any ? Q["$skip"] : never;
+    $sort: Q["$sort"] extends any ? Q["$sort"] : never;
+    query: Omit<Q, "$select" | "$limit" | "$skip" | "$sort">;
+};
 /**
- * Merges two queries into one.
- * @param target Query to be merged into
- * @param source Query to be merged from
- * @param _options
- * @returns Query
+ * Extracts $select, $limit, $skip, $sort from a query and returns the rest as a query object.
+ *
+ * @param providedQuery
+ * @returns
  */
-declare function mergeQuery<T = any>(target: Query, source: Query, _options?: Partial<MergeQueryOptions<T>>): Query;
+declare function filterQuery<Q extends Query>(providedQuery?: Q): FilterQueryResult<Q>;
 
 /**
  * util to get paginate options from context
@@ -184,6 +178,29 @@ declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Applicati
  */
 declare function markHookForSkip<H extends HookContext = HookContext>(hookName: string, type: "all" | MaybeArray<HookType>, context?: H): H;
 
+type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
+type FirstLast = "first" | "last";
+type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
+interface MergeQueryOptions {
+    defaultHandle: Handle;
+    actionOnEmptyIntersect: ActionOnEmptyIntersect;
+    useLogicalConjunction: boolean;
+    handle?: {
+        [key: string]: Handle;
+    };
+}
+
+declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
+
+/**
+ * Merges two queries into one.
+ * @param target Query to be merged into
+ * @param source Query to be merged from
+ * @param _options
+ * @returns Query
+ */
+declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+
 interface PushSetOptions {
     unique?: boolean;
 }
@@ -192,6 +209,11 @@ interface PushSetOptions {
  */
 declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val: unknown, options?: PushSetOptions) => unknown[];
 
+type SetQueryKeySafelyOptions = {
+    mutate?: boolean;
+};
+declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
@@ -205,21 +227,16 @@ type ShouldSkipOptions = {
  */
 declare const shouldSkip: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
 
+declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
+
 /**
  * util to validate a query for operators
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
-
-type SetQueryKeySafelyOptions = {
-    mutate?: boolean;
-};
-declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
-
-declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions$1) => any; };
+declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
-declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions$1) => any; };
+declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
 type Single<T> = T extends Array<infer U> ? U : T;
 type AsArray<T> = T extends any[] ? T : [T];
@@ -267,4 +284,4 @@ type InferRemoveResultFromPath<App extends Application, Path extends string, IdO
 type InferDataFromPath<App extends Application, Path extends string, Method extends "create" | "update" | "patch"> = Method extends "create" ? InferCreateDataFromPath<App, Path> : Method extends "update" ? InferUpdateDataFromPath<App, Path> : Method extends "patch" ? InferPatchDataFromPath<App, Path> : never;
 type InferResultFromPath<App extends Application, Path extends string, Method extends "get" | "find" | "create" | "update" | "patch" | "remove"> = Method extends "get" ? InferGetResultFromPath<App, Path> : Method extends "find" ? InferFindResultFromPath<App, Path> : Method extends "create" ? InferCreateResultFromPath<App, Path> : Method extends "update" ? InferUpdateResultFromPath<App, Path> : Method extends "patch" ? InferPatchResultFromPath<App, Path> : Method extends "remove" ? InferRemoveResultFromPath<App, Path> : never;
 
-export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FilterQueryOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, defineHooks, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };