refactor(transformers): reexport transform hooks (#16)

* refactor(transformers): reexport transform hooks

* docs: update readme

Author: fratzinger

README.md

@@ -1,102 +1,18 @@
 ## feathers-utils
 
-#### hooks
-
-- added transformData, transformResult, rm alterItems
-- added discardData, discardResult, rm discard
-  - moved to omitData, omitResult, rm omit
-  - MaybeArray
-- added keepData, keepResult, rm keep
-  - moved to pickData, pickResult, rm pick
-  - MaybeArray
-- added lowercaseData, lowercaseResult, rm lowercase
-  - MaybeArray
-- added setNowData, setNowResult, rm setNow
-
-- removed several checks that are handled by typescript
-- removed check for `preventChanges(true, ...fieldNames)`
-  - switch `true` to second argument options
-  - async
-
-- renamed 'keepQuery' to 'pickQuery', added alias
-- renamed 'required' to 'checkRequired', added alias
-
-- removed 'runParallel'
-
-- removed 'actOn', 'actOnDefault', 'actOnDispatch'
-
-- added throwIf
-- added throwIfIsProvider
-- added throwIfIsMulti
-
-- removed old paramsForServer & changed to hook
-
-- removed 'callingParams'
-
-- removed 'checkContextIf'
-
-- added 'onDelete' & 'createRelated'
-- added 'checkMulti'
-- added 'shouldSkip' & 'skippable'
-
-- stashBefore multi
-
-- softDelete: added 'transformParams' & added 'key' option
-
-- disallow: MaybeArray
-
-- rm support for spread argument
-
-- rm 'actOnDispatch' & 'actOnDefault'
-
-- rm 'validate', 'validateSchema', 'setNow', 'sequelizeConvert', 'serialize', 'required', 'runHook', 'populate', 'pick', 'omit', 'mongoKeys', 'lowercase', 'lowerCase', 'keepQuery', 'keepQueryInArray', 'isNot', fgraphql', 'fastJoin', 'discard...', 'dePopulate', 'actOnDefault', 'actOnDispatch', 'sifter'
-
-- softDelete: need to pass 'deletedQuery' and 'removeData'
-
-- traverse options object & getObject explicitly required
-
-- cache changed
-
-#### predicates
-
-- renamed 'isNot' to 'not' (added alias for 'isNot')
-- added predicate isMulti
-- added predicate isPaginated
-- added predicate isContext
-
-#### utils
-
-- added getDataIsArray, getResultIsArray, rm getItems
-- added mutateData, mutateResult, rm replaceItems
-- added util getPaginate
-- added util skipResult
-- rm 'runHook'
-
-### Hooks to discuss
-
-- cache
-- populate
-- dePopulate
-- fgraphql
-- fastJoin
-- sequelizeConvert
-- serialize
-
 <p align="center">
   <img src="https://utils.feathersjs.com/feathers-utils-logo.png" width="200">
 </p>
 
 [![npm](https://img.shields.io/npm/v/feathers-utils)](https://www.npmjs.com/package/feathers-utils)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/feathersjs/feathers-utils/CI/master)](https://github.com/feathersjs/feathers-utils/actions/workflows/nodejs.yml?query=branch%3Amaster)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/feathersjs/feathers-utils/nodejs.yml)](https://github.com/feathersjs/feathers-utils/actions/workflows/nodejs.yml)
 [![libraries.io](https://img.shields.io/librariesio/release/npm/feathers-utils)](https://libraries.io/npm/feathers-utils)
 [![npm](https://img.shields.io/npm/dm/feathers-utils)](https://www.npmjs.com/package/feathers-utils)
 [![GitHub license](https://img.shields.io/github/license/feathersjs/feathers-utils)](https://github.com/feathersjs/feathers-utils/blob/master/LICENSE)
 [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
 A collection of useful hooks and utils to use with Feathers services.
 
-> NOTE: This is the version for Feathers v5. For Feathers v4 use [feathers-utils v6](https://github.com/feathersjs/feathers-utils/tree/crow)
-
 ```
 npm install feathers-utils --save
 ```

src/transformers/index.ts

@@ -4,3 +4,10 @@ export * from './parse-date/parse-date.transformer.js'
 export * from './pick/pick.transformer.js'
 export * from './set-now/set-now.transformer.js'
 export * from './trim/trim.transformer.js'
+
+// re-export hooks
+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'
+
+export type { TransformerFn } from '../types.js'

src/transformers/lowercase/lowercase.transformer.ts

@@ -10,8 +10,7 @@ import type { TransformerFn } from '../../types.js'
  *
  * @example
  * ```ts
- * import { transformData, transformResult } from 'feathers-utils/hooks'
- * import { lowercase } from 'feathers-utils/transformers'
+ * import { transformData, transformResult, lowercase } from 'feathers-utils/transformers'
  *
  * {
  *   before: {

src/transformers/omit/omit.transformer.ts

@@ -8,8 +8,7 @@ import type { TransformerFn } from '../../types.js'
  *
  * @example
  * ```ts
- * import { transformData, transformResult } from 'feathers-utils/hooks'
- * import { omit } from 'feathers-utils/transformers'
+ * import { transformData, transformResult, omit } from 'feathers-utils/transformers'
  *
  * {
  *   before: {

src/transformers/parse-date/parse-date.transformer.ts

@@ -3,6 +3,22 @@ import _get from 'lodash/get.js'
 import _set from 'lodash/set.js'
 import type { TransformerFn } from '../../types.js'
 
+/**
+ * Parses the specified fields of an item into Date objects.
+ *
+ * @example
+ * ```ts
+ * import { transformData, transformResult, transformQuery, parseDate } from 'feathers-utils/transformers'
+ *
+ * {
+ *   before: {
+ *     create: [transformData(parseDate(['startDate', 'endDate']))],
+ *     update: [transformData(parseDate(['startDate', 'endDate']))],
+ *     patch: [transformData(parseDate(['startDate', 'endDate']))],
+ *   }
+ * }
+ * ```
+ */
 export const parseDate = (fieldNames: MaybeArray<string>): TransformerFn => {
   const fieldNamesArr = toArray(fieldNames)
 

src/transformers/pick/pick.transformer.ts

@@ -8,8 +8,7 @@ import type { TransformerFn } from '../../types.js'
  *
  * @example
  * ```ts
- * import { transformData, transformResult } from 'feathers-utils/hooks'
- * import { pick } from 'feathers-utils/transformers'
+ * import { transformData, transformResult, pick } from 'feathers-utils/transformers'
  *
  * {
  *   before: {

src/transformers/set-now/set-now.transformer.ts

@@ -8,8 +8,7 @@ import type { TransformerFn } from '../../types.js'
  *
  * @example
  * ```ts
- * import { transformData, transformResult, transformQuery } from 'feathers-utils/hooks'
- * import { lowercase } from 'feathers-utils/transformers'
+ * import { transformData, transformResult, transformQuery, setNow } from 'feathers-utils/transformers'
  *
  * {
  *   before: {

src/transformers/trim/trim.transformer.ts

@@ -10,8 +10,7 @@ import type { TransformerFn } from '../../types.js'
  *
  * @example
  * ```ts
- * import { transformData, transformResult } from 'feathers-utils/hooks'
- * import { trim } from 'feathers-utils/transformers'
+ * import { transformData, transformResult, trim } from 'feathers-utils/transformers'
  *
  * {
  *   before: {

test/index.test.ts

@@ -75,6 +75,9 @@ const transformers = [
   'parseDate',
   'pick',
   'omit',
+  'transformData',
+  'transformQuery',
+  'transformResult',
 ] satisfies (keyof typeof exportedTransformers)[]
 
 describe('expose', () => {