feat: second generic for resolvers/transformer hooks for explicit type (#26)

* feat: second generic for resolvers/transformer hooks for explicit type

* feat: checkContext with options object

Author: fratzinger

docs/.vitepress/config.mts

@@ -41,8 +41,10 @@ export default defineConfig({
     )
     if (utility) {
       pageData.lastUpdated = utility.lastModified.getTime()
-      pageData.filePath = utility.docsUrl
-        .replace(`https://github.com/${repository}/blob/${mainBranch}/`, '')
+      pageData.filePath = utility.docsUrl.replace(
+        `https://github.com/${repository}/blob/${mainBranch}/`,
+        '',
+      )
     } else {
       pageData.filePath = `docs/${pageData.relativePath}`
     }
@@ -71,9 +73,18 @@ export default defineConfig({
         text: 'Migrating',
         collapsed: false,
         items: [
-          { text: 'from feathers-hooks-common', link: '/migrating-from-feathers-hooks-common' },
-          { text: 'from @feathersjs/schema', link: '/migrating-from-feathers-schema' },
-          { text: 'from feathers-fletching', link: '/migrating-from-feathers-fletching' },
+          {
+            text: 'from feathers-hooks-common',
+            link: '/migrating-from-feathers-hooks-common',
+          },
+          {
+            text: 'from @feathersjs/schema',
+            link: '/migrating-from-feathers-schema',
+          },
+          {
+            text: 'from feathers-fletching',
+            link: '/migrating-from-feathers-fletching',
+          },
         ],
       },
       {
@@ -118,8 +129,7 @@ export default defineConfig({
             items: utilities
               .filter(
                 (x) =>
-                  x.category === 'resolvers' &&
-                  x.frontmatter.kind === 'helper',
+                  x.category === 'resolvers' && x.frontmatter.kind === 'helper',
               )
               .map((x) => ({
                 text: x.title,

docs/.vitepress/plugins/utility.ts

@@ -40,6 +40,12 @@ export default (utility: Utility, utilities: Utility[]) => {
     }
   })()
 
+  if (utility.aliases?.length) {
+    code.push(
+      `_Aliases_: ${utility.aliases.map((a: string) => `\`${a}\``).join(', ')}`,
+    )
+  }
+
   code.push(`${utility.description}
 
 \`\`\`ts twoslash

docs/.vitepress/utilities.ts

@@ -38,6 +38,7 @@ export type Utility = {
   predicates?: boolean
   dts: string
   examples?: string[]
+  aliases?: string[]
   args?: {
     name: string
     type: string
@@ -197,7 +198,7 @@ export async function discoverUtilities() {
       const fileName = path.basename(filePath, '.md')
       const { data: frontmatter, content: body } = matter(content)
 
-      const { title = '', category, hook } = frontmatter
+      const { title = '', category, hook, aliases } = frontmatter
 
       if (
         !title ||
@@ -260,6 +261,7 @@ export async function discoverUtilities() {
         hook,
         transformers: !!frontmatter.transformers,
         predicates: !!frontmatter.predicates,
+        aliases: aliases?.length ? aliases : undefined,
         dts: dtsByMdFile[filePath] ?? undefined,
         lastModified: (await fs.stat(filePath)).mtime,
         examples: examples.length > 0 ? examples : undefined,

docs/migrating-from-feathers-hooks-common.md

@@ -139,6 +139,20 @@ It is now replaced by the new utilities [`getDataIsArray`](#new-util-getdataisar
 
 Also see [#replace-items](#replace-items).
 
+## `every`
+
+The `every` predicate has been renamed to [`and`](/predicates/and.html). `every` is still available as an alias.
+
+```ts
+// old
+import { every } from "feathers-hooks-common";
+
+// new
+import { and } from "feathers-utils/predicates";
+// or use the alias
+import { every } from "feathers-utils/predicates";
+```
+
 ## `isNot`
 
 The `isNot` predicate has been renamed to [`not`](/predicates/not.html).
@@ -294,6 +308,20 @@ The `sifter` hook has been removed. If you need it please reach out to us in thi
 
 The `softDelete` hook has been updated to require a `deletedQuery` and `removeData` option. This change improves clarity and consistency in how soft deletion is handled in your application.
 
+## `some`
+
+The `some` predicate has been renamed to [`or`](/predicates/or.html). `some` is still available as an alias.
+
+```ts
+// old
+import { some } from "feathers-hooks-common";
+
+// new
+import { or } from "feathers-utils/predicates";
+// or use the alias
+import { some } from "feathers-utils/predicates";
+```
+
 ## `stashBefore`
 
 The `stashBefore` hook has been renamed to [`stashable`](/hooks/stashable.html). Instead of eagerly fetching and storing the result directly on `context.params.before`, it now exposes a memoized function that returns a promise. The fetch starts immediately but multiple calls to `stashed()` only hit the database once.

src/guards/has-query/has-query.guard.test-d.ts

@@ -0,0 +1,24 @@
+import type { Params } from '@feathersjs/feathers'
+import { expectTypeOf } from 'vitest'
+import { hasQuery } from './has-query.guard.js'
+
+it('narrows query from optional to required', () => {
+  const params: Params = {}
+
+  if (hasQuery(params)) {
+    expectTypeOf(params.query).toEqualTypeOf<Record<string, any>>()
+  }
+})
+
+it('query is optional before guard', () => {
+  const params: Params = {}
+  expectTypeOf(params.query).toEqualTypeOf<Record<string, any> | undefined>()
+})
+
+it('preserves custom query type', () => {
+  const params: Params<{ name: string }> = { query: { name: 'Dave' } }
+
+  if (hasQuery(params)) {
+    expectTypeOf(params.query).toEqualTypeOf<{ name: string }>()
+  }
+})

src/guards/has-query/has-query.guard.test.ts

@@ -0,0 +1,24 @@
+import type { Params } from '@feathersjs/feathers'
+import { hasQuery } from './has-query.guard.js'
+
+describe('guards/has-query', () => {
+  it('returns true when query is present', () => {
+    const params: Params = { query: { name: 'Dave' } }
+    expect(hasQuery(params)).toBe(true)
+  })
+
+  it('returns false when query is undefined', () => {
+    const params: Params = {}
+    expect(hasQuery(params)).toBe(false)
+  })
+
+  it('returns false when query is null', () => {
+    const params = { query: null } as unknown as Params
+    expect(hasQuery(params)).toBe(false)
+  })
+
+  it('returns true for empty query object', () => {
+    const params: Params = { query: {} }
+    expect(hasQuery(params)).toBe(true)
+  })
+})

src/hooks/check-required/check-required.hook.ts

@@ -28,12 +28,11 @@ export function checkRequired<H extends HookContext = HookContext>(
 ) {
   const fieldNamesArray = toArray(fieldNames)
   return (context: H, next?: NextFunction) => {
-    checkContext(
-      context,
-      ['before', 'around'],
-      ['create', 'update', 'patch'],
-      'checkRequired',
-    )
+    checkContext(context, {
+      type: ['before', 'around'],
+      method: ['create', 'update', 'patch'],
+      label: 'checkRequired',
+    })
 
     const { data } = getDataIsArray(context)
 

src/hooks/create-related/create-related.hook.ts

@@ -55,7 +55,11 @@ export function createRelated<H extends HookContext = HookContext>(
   options: MaybeArray<CreateRelatedOptions<H>>,
 ) {
   return async (context: H, next?: NextFunction) => {
-    checkContext(context, ['after', 'around'], ['create'], 'createRelated')
+    checkContext(context, {
+      type: ['after', 'around'],
+      method: ['create'],
+      label: 'createRelated',
+    })
 
     if (next) {
       await next()

src/hooks/disable-pagination/disable-pagination.hook.ts

@@ -21,7 +21,11 @@ import { checkContext } from '../../utils/index.js'
 export const disablePagination =
   <H extends HookContext = HookContext>() =>
   (context: H, next?: NextFunction) => {
-    checkContext(context, ['before', 'around'], ['find'], 'disablePagination')
+    checkContext(context, {
+      type: ['before', 'around'],
+      method: ['find'],
+      label: 'disablePagination',
+    })
     const $limit = context.params?.query?.$limit
 
     if ($limit === '-1' || $limit === -1) {

src/hooks/iff-else/iff-else.hook.test.ts

@@ -2,8 +2,8 @@
 import type { HookContext } from '@feathersjs/feathers'
 import { assert } from 'vitest'
 import { iffElse } from './iff-else.hook.js'
-import { some } from '../../predicates/some/some.predicate.js'
-import { every } from '../../predicates/every/every.predicate.js'
+import { or } from '../../predicates/or/or.predicate.js'
+import { and } from '../../predicates/and/and.predicate.js'
 import { clone } from '../../common/index.js'
 
 let hook: any
@@ -158,10 +158,10 @@ describe('services iffElse', () => {
       })
     })
 
-    it('every passes on correct params', () => {
+    it('and passes on correct params', () => {
       return iffElse(
         // @ts-expect-error TODO
-        every(predicateTrue),
+        and(predicateTrue),
         [hookFcnSync, hookFcnAsync, hookFcn],
         [],
       )(hook).then(() => {
@@ -172,10 +172,10 @@ describe('services iffElse', () => {
       })
     })
 
-    it('some passes on correct params', () => {
+    it('or passes on correct params', () => {
       return iffElse(
         // @ts-expect-error TODO
-        some(predicateTrue),
+        or(predicateTrue),
         [hookFcnSync, hookFcnAsync, hookFcn],
         [],
       )(hook).then(() => {