chore: re-export hooks utils to predicates & transformers (#17)

fratzinger · web-flow · commit caeead2c9f8c · 2026-01-27T08:53:10.000+01:00
* chore: re-export hooks utils to predicates &amp; transformers

* chore: rm predicates from main export &amp; add see url
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v22.19.0
+v24.13.0
diff --git a/package.json b/package.json
@@ -96,7 +96,7 @@
     "@feathersjs/socketio-client": "^5.0.37",
     "@shikijs/vitepress-twoslash": "^3.21.0",
     "@tailwindcss/vite": "^4.1.18",
-    "@tsconfig/node22": "^22.0.5",
+    "@tsconfig/node24": "^24.0.4",
     "@types/lodash": "^4.17.23",
     "@types/markdown-it": "^14.1.2",
     "@types/node": "^25.0.10",
@@ -107,7 +107,7 @@
     "gray-matter": "^4.0.3",
     "lru-cache": "^11.2.5",
     "markdown-it": "^14.1.0",
-    "npm-check-updates": "^19.3.1",
+    "npm-check-updates": "^19.3.2",
     "prettier": "^3.8.1",
     "shx": "^0.4.0",
     "sift": "^17.1.3",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/hooks/cache/cache.hook.ts b/src/hooks/cache/cache.hook.ts
@@ -31,6 +31,11 @@ export type CacheOptions = {
   transformParams: (params: Params) => Params
 }
 
+/**
+ * A hook to cache `get` and `find` method results based on `params`.
+ *
+ * @see https://utils.feathersjs.com/hooks/cache.html
+ */
 export const cache = <H extends HookContext = HookContext>(
   options: CacheOptions,
 ) => {
diff --git a/src/hooks/index.ts b/src/hooks/index.ts
@@ -16,7 +16,7 @@ export * from './set-data/set-data.hook.js'
 export * from './set-field/set-field.hook.js'
 export * from './set-result/set-result.hook.js'
 export * from './set-slug/set-slug.hook.js'
-export * from './skippable/skippable.js'
+export * from './skippable/skippable.hook.js'
 export * from './soft-delete/soft-delete.hook.js'
 export * from './stash-before/stash-before.hook.js'
 export * from './throw-if-is-multi/throw-if-is-multi.hook.js'
diff --git a/src/hooks/skippable/skippable.hook.md b/src/hooks/skippable/skippable.hook.md
diff --git a/src/hooks/skippable/skippable.hook.test.ts b/src/hooks/skippable/skippable.hook.test.ts
@@ -1,5 +1,5 @@
 import { shouldSkip } from '../../predicates/should-skip/should-skip.predicate.js'
-import { skippable } from './skippable.js'
+import { skippable } from './skippable.hook.js'
 
 describe('skippable', () => {
   it('runs hook when not skipped', async () => {
diff --git a/src/hooks/skippable/skippable.hook.ts b/src/hooks/skippable/skippable.hook.ts
@@ -3,6 +3,8 @@ import type { HookFunction, PredicateFn } from '../../types.js'
 
 /**
  * Wrap a hook to make it skippable
+ *
+ * @see https://utils.feathersjs.com/hooks/skippable.html
  */
 export const skippable =
   <H extends HookContext = HookContext>(
diff --git a/src/hooks/transform-query/transform-query.hook.ts b/src/hooks/transform-query/transform-query.hook.ts
@@ -3,6 +3,8 @@ import type { TransformerFn } from '../../types.js'
 
 /**
  * Transforms the query object.
+ *
+ * @see https://utils.feathersjs.com/hooks/transform-query.html
  */
 export const transformQuery = <
   Q extends Query,
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,5 @@
 export * from './hooks/index.js'
 export * from './utils/index.js'
-export * from './predicates/index.js'
 
 export * from './types.js'
 export * from './utility-types/index.js'
diff --git a/src/predicates/index.ts b/src/predicates/index.ts
@@ -6,3 +6,10 @@ export * from './is-provider/is-provider.predicate.js'
 export * from './not/not.predicate.js'
 export * from './should-skip/should-skip.predicate.js'
 export * from './some/some.predicate.js'
+
+// re-export hooks
+export * from '../hooks/iff/iff.hook.js'
+export * from '../hooks/iff-else/iff-else.hook.js'
+export * from '../hooks/unless/unless.hook.js'
+export * from '../hooks/skippable/skippable.hook.js'
+export * from '../hooks/throw-if/throw-if.hook.js'
diff --git a/src/predicates/should-skip/should-skip.predicate.ts b/src/predicates/should-skip/should-skip.predicate.ts
@@ -7,6 +7,8 @@ import type { SkipHookName } from '../../utils/index.js'
  * Util to detect if a hook should be skipped
  *
  * Checks the `params.skipHooks` array for the hook name, type, or 'all'.
+ *
+ * @see https://utils.feathersjs.com/predicates/should-skip.html
  */
 export const shouldSkip = <H extends HookContext = HookContext>(
   hookName: SkipHookName,
diff --git a/src/transformers/index.ts b/src/transformers/index.ts
@@ -10,4 +10,8 @@ export * from '../hooks/transform-data/transform-data.hook.js'
 export * from '../hooks/transform-query/transform-query.hook.js'
 export * from '../hooks/transform-result/transform-result.hook.js'
 
+// re-export utils
+export * from '../utils/mutate-data/mutate-data.util.js'
+export * from '../utils/mutate-result/mutate-result.util.js'
+
 export type { TransformerFn } from '../types.js'
diff --git a/src/transformers/lowercase/lowercase.transformer.ts b/src/transformers/lowercase/lowercase.transformer.ts
@@ -18,6 +18,8 @@ import type { TransformerFn } from '../../types.js'
  *   }
  * }
  * ```
+ *
+ * @see https://utils.feathersjs.com/transformers/lowercase.html
  */
 export const lowercase = (fieldNames: MaybeArray<string>): TransformerFn => {
   const fieldNamesArr = toArray(fieldNames)
diff --git a/src/transformers/omit/omit.transformer.ts b/src/transformers/omit/omit.transformer.ts
@@ -16,6 +16,8 @@ import type { TransformerFn } from '../../types.js'
  *   }
  * }
  * ```
+ *
+ * @see https://utils.feathersjs.com/transformers/omit.html
  */
 export const omit = (fieldNames: MaybeArray<string>): TransformerFn => {
   const fieldNamesArr = toArray(fieldNames)
diff --git a/src/transformers/parse-date/parse-date.transformer.ts b/src/transformers/parse-date/parse-date.transformer.ts
@@ -18,6 +18,8 @@ import type { TransformerFn } from '../../types.js'
  *   }
  * }
  * ```
+ *
+ * @see https://utils.feathersjs.com/transformers/parse-date.html
  */
 export const parseDate = (fieldNames: MaybeArray<string>): TransformerFn => {
   const fieldNamesArr = toArray(fieldNames)
diff --git a/src/transformers/pick/pick.transformer.ts b/src/transformers/pick/pick.transformer.ts
@@ -16,6 +16,8 @@ import type { TransformerFn } from '../../types.js'
  *   }
  * }
  * ```
+ *
+ * @see https://utils.feathersjs.com/transformers/pick.html
  */
 export const pick = (fieldNames: MaybeArray<string>): TransformerFn => {
   const fieldNamesArr = toArray(fieldNames)
diff --git a/src/transformers/set-now/set-now.transformer.ts b/src/transformers/set-now/set-now.transformer.ts
@@ -18,6 +18,8 @@ import type { TransformerFn } from '../../types.js'
  *   }
  * }
  * ```
+ *
+ * @see https://utils.feathersjs.com/transformers/set-now.html
  */
 export const setNow = (fieldNames: MaybeArray<string>): TransformerFn => {
   const fieldNamesArr = toArray(fieldNames)
diff --git a/src/transformers/trim/trim.transformer.ts b/src/transformers/trim/trim.transformer.ts
@@ -18,6 +18,8 @@ import type { TransformerFn } from '../../types.js'
  *   }
  * }
  * ```
+ *
+ * @see https://utils.feathersjs.com/transformers/trim.html
  */
 export const trim = (fieldNames: MaybeArray<string>): TransformerFn => {
   const fieldNamesArr = toArray(fieldNames)
diff --git a/src/utils/add-skip/add-skip.util.ts b/src/utils/add-skip/add-skip.util.ts
@@ -9,6 +9,8 @@ export type SkipHookName =
 
 /**
  * Add names to `context.params.skipHooks` for `skippable` hooks.
+ *
+ * @see https://utils.feathersjs.com/utils/add-skip.html
  */
 export const addSkip = <H extends HookContext>(
   context: H,
diff --git a/src/utils/add-to-query/add-to-query.util.ts b/src/utils/add-to-query/add-to-query.util.ts
@@ -4,6 +4,8 @@ import { dequal as deepEqual } from 'dequal'
 /**
  * Safely adds a property to a query object. If the property already exists, it adds it to the `$and` array.
  * If the exact same property-value pair already exists, it does nothing.
+ *
+ * @see https://utils.feathersjs.com/utils/add-to-query.html
  */
 export function addToQuery<Q extends Query>(targetQuery: Q, query: Q): Q {
   targetQuery ??= {} as Q
diff --git a/src/utils/get-paginate/get-paginate.util.ts b/src/utils/get-paginate/get-paginate.util.ts
@@ -7,6 +7,8 @@ import { hasOwnProperty } from '../../internal.utils.js'
  * 1. it uses `context.params.paginate` if it exists
  * 2. it uses `service.options.paginate` if it exists
  * 3. it uses `context.params.adapter` if it exists
+ *
+ * @see https://utils.feathersjs.com/utils/get-paginate.html
  */
 export const getPaginate = <H extends HookContext = HookContext>(
   context: H,
diff --git a/src/utils/get-result-is-array/get-result-is-array.util.ts b/src/utils/get-result-is-array/get-result-is-array.util.ts
@@ -5,6 +5,11 @@ type GetResultIsArrayOptions = {
   dispatch?: boolean
 }
 
+/**
+ * Always returns the `context.result` or `context.dispatch` as an array.
+ *
+ * @see https://utils.feathersjs.com/utils/get-result-is-array.html
+ */
 export function getResultIsArray<H extends HookContext = HookContext>(
   context: H,
   options?: GetResultIsArrayOptions,
diff --git a/src/utils/iterate-find/iterate-find.util.ts b/src/utils/iterate-find/iterate-find.util.ts
@@ -14,6 +14,8 @@ type IterateFindOptions<P extends Params = Params> = {
  *
  * This function is useful for iterating over large datasets without loading everything into memory at once.
  * It uses pagination to fetch results in chunks, allowing you to process each item as it is retrieved.
+ *
+ * @see https://utils.feathersjs.com/utils/iterate-find.html
  */
 export async function* iterateFind<
   Services,
diff --git a/src/utils/mutate-data/mutate-data.util.ts b/src/utils/mutate-data/mutate-data.util.ts
@@ -4,6 +4,11 @@ import { isPromise } from '../../common/index.js'
 import type { Promisable } from '../../internal.utils.js'
 import type { TransformerFn } from '../../types.js'
 
+/**
+ * Mutates `context.data` using the provided transformer function.
+ *
+ * @see https://utils.feathersjs.com/utils/mutate-data.html
+ */
 export function mutateData<H extends HookContext = HookContext>(
   context: H,
   transformer: TransformerFn<any, H>,
diff --git a/src/utils/mutate-result/mutate-result.util.ts b/src/utils/mutate-result/mutate-result.util.ts
@@ -10,6 +10,11 @@ export type MutateResultOptions = {
   dispatch?: DispatchOption
 }
 
+/**
+ * Mutates `context.result` and/or `context.dispatch` using the provided transformer function.
+ *
+ * @see https://utils.feathersjs.com/utils/mutate-result.html
+ */
 export async function mutateResult<H extends HookContext = HookContext>(
   context: H,
   transformer: TransformerFn<any, H>,
diff --git a/src/utils/patch-batch/patch-batch.util.ts b/src/utils/patch-batch/patch-batch.util.ts
@@ -35,6 +35,8 @@ export type PatchBatchResultItem<T = Record<string, unknown>, P = Params> = [
  *
  * await Promise.all(batched.map(args => service.patch(...args)));
  * ```
+ *
+ * @see https://utils.feathersjs.com/utils/patch-batch.html
  */
 export function patchBatch<
   T extends Record<string, any>,
diff --git a/src/utils/skip-result/skip-result.util.ts b/src/utils/skip-result/skip-result.util.ts
@@ -3,6 +3,8 @@ import { isMulti, isPaginated } from '../../predicates/index.js'
 
 /**
  * Set `context.result` to an empty array or object, depending on the hook type
+ *
+ * @see https://utils.feathersjs.com/utils/skip-result.html
  */
 export const skipResult = <H extends HookContext = HookContext>(context: H) => {
   if (context.result) {
diff --git a/src/utils/to-paginated/to-paginated.util.ts b/src/utils/to-paginated/to-paginated.util.ts
@@ -2,6 +2,8 @@ import type { Paginated } from '@feathersjs/feathers'
 
 /**
  * Ensure the result is in paginated format
+ *
+ * @see https://utils.feathersjs.com/utils/to-paginated.html
  */
 export function toPaginated<R>(result: R[] | Paginated<R>): Paginated<R> {
   if (Array.isArray(result)) {
diff --git a/src/utils/transform-params/transform-params.util.ts b/src/utils/transform-params/transform-params.util.ts
@@ -3,6 +3,8 @@ import type { TransformParamsFn } from '../../types.js'
 
 /**
  * Safely use a transformParams function to modify params.
+ *
+ * @see https://utils.feathersjs.com/utils/transform-params.html
  */
 export const transformParams = <P extends Params = Params>(
   params: P,
diff --git a/src/utils/walk-query/walk-query.util.ts b/src/utils/walk-query/walk-query.util.ts
@@ -125,6 +125,8 @@ const _walkQueryUtil = <Q extends Query>(
  * Walks the given Feathers query and calls the `walker` function for each property. The
  * `walker` function can return a new value which will replace the original value in the
  * returned query. If no changes were made the original query will be returned.
+ *
+ * @see https://utils.feathersjs.com/utils/walk-query.html
  */
 export const walkQuery = <Q extends Query>(
   query: Q,
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -66,6 +66,13 @@ const predicates = [
   'isContext',
   'isPaginated',
   'shouldSkip',
+  // re-export hooks
+  'iff',
+  'iffElse',
+  'unless',
+  'skippable',
+  'throwIf',
+  'when',
 ] satisfies (keyof typeof exportedPredicates)[]
 
 const transformers = [
@@ -75,9 +82,13 @@ const transformers = [
   'parseDate',
   'pick',
   'omit',
+  // re-export hooks
   'transformData',
   'transformQuery',
   'transformResult',
+  // re-export utils
+  'mutateData',
+  'mutateResult',
 ] satisfies (keyof typeof exportedTransformers)[]
 
 describe('expose', () => {
@@ -102,9 +113,8 @@ describe('expose', () => {
       [
         ...Object.keys(exportedHooks).sort(),
         ...Object.keys(exportedUtils).sort(),
-        ...Object.keys(exportedPredicates).sort(),
       ].sort(),
-      [...hooks, ...utils, ...predicates].sort(),
+      [...hooks, ...utils].sort(),
     )
   })
 })
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "@tsconfig/node22/tsconfig.json",
+  "extends": "@tsconfig/node24/tsconfig.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src",
