fix: type errors

Author: fratzinger

package-lock.json

@@ -65,6 +65,7 @@
     "@feathersjs/memory": "^5.0.33",
     "@tsconfig/node22": "^22.0.0",
     "@types/lodash": "^4.17.16",
+    "@typescript-eslint/parser": "^8.25.0",
     "eslint": "^9.21.0",
     "np": "^10.2.0",
     "shx": "^0.3.4",

package.json

@@ -14,6 +14,7 @@ export class GraphPopulateApplication {
   private _app: Application
 
   __hooks: any
+  // @ts-expect-error setup in 'enableHooks'
   hooks: (hooks: GraphPopulateHook | AnyData | unknown[]) => void
   options?: InitOptions
 

src/app/graph-populate.class.ts

@@ -1,16 +1,27 @@
-import _get from 'lodash/get.js'
 import _isEmpty from 'lodash/isEmpty.js'
-import _merge from 'lodash/merge.js'
 
 import { shallowPopulate as makeShallowPopulate } from './shallow-populate.hook'
 
-import type { HookContext, Query } from '@feathersjs/feathers'
+import type { HookContext, Params, Query } from '@feathersjs/feathers'
 
-import type { GraphPopulateHookOptions, Method } from '../types'
+import type {
+  Method,
+  PopulateObject,
+  Populates,
+  SingleGraphPopulateParams,
+} from '../types'
 import type { GraphPopulateApplication } from '../app/graph-populate.class'
 
 const FILTERS = ['$limit', '$select', '$skip', '$sort']
 
+export interface GraphPopulateHookOptions<S = string> {
+  populates: Populates<S>
+  /**
+   * @default: false
+   */
+  allowUnnamedQueryForExternal?: boolean
+}
+
 /**
  * Sets up the deepPopulate hook using the provided options.
  *  @param options
@@ -30,13 +41,9 @@ export function graphPopulate(
   }
   const { populates } = options
 
-  return async function deepPopulateHook(
-    context: HookContext,
-  ): Promise<HookContext> {
-    const populateQuery: Query | undefined = _get(
-      context,
-      'params.$populateParams.query',
-    )
+  return async (context: HookContext): Promise<HookContext> => {
+    const populateQuery: Query | undefined =
+      context.params?.$populateParams?.query
 
     if (!populateQuery) return context
 
@@ -50,12 +57,12 @@ export function graphPopulate(
     const currentPopulates = keys.reduce((currentPopulates, key) => {
       if (!populates[key]) return currentPopulates
 
-      const currentQuery = Object.assign({}, populateQuery[key])
+      const currentQuery = { ...populateQuery[key] }
 
       const populate = populates[key]
       const service = app.service(populate.service)
 
-      let params = []
+      let params: SingleGraphPopulateParams[] = []
       if (populate.params) {
         if (Array.isArray(populate.params)) {
           params.push(...populate.params)
@@ -65,23 +72,24 @@ export function graphPopulate(
       }
 
       if (!_isEmpty(currentQuery)) {
-        const customKeysForQuery: string[] | undefined = _get(
-          service,
-          'options.graphPopulate.whitelist',
-        )
+        const customKeysForQuery = (service as any).options?.graphPopulate
+          ?.whitelist as string[] | undefined
         const extractKeys = [...FILTERS]
+
         if (customKeysForQuery) {
           extractKeys.push(...customKeysForQuery)
         }
+
         const paramsToAdd = Object.keys(currentQuery).reduce(
           (paramsToAdd, key) => {
             if (!extractKeys.includes(key)) return paramsToAdd
             const { query } = paramsToAdd
-            _merge(query, { [key]: currentQuery[key] })
+            query[key] = currentQuery[key]
             delete currentQuery[key]
+
             return paramsToAdd
           },
-          { query: {} },
+          { query: {} } as { query: Query },
         )
         params.push(paramsToAdd)
       }
@@ -91,7 +99,7 @@ export function graphPopulate(
           $populateParams: {
             query: currentQuery,
           },
-        })
+        } as Params)
       }
 
       if (graphPopulateApp) {
@@ -108,9 +116,9 @@ export function graphPopulate(
       })
 
       return currentPopulates
-    }, [])
+    }, [] as PopulateObject[])
 
-    if (!currentPopulates || !currentPopulates.length) {
+    if (!currentPopulates?.length) {
       return context
     }
     const shallowPopulate = makeShallowPopulate({ include: currentPopulates })

src/hooks/graph-populate.hook.ts

@@ -1,11 +1,21 @@
-import _set from 'lodash/set.js'
-
 import { graphPopulate } from './graph-populate.hook'
-import { getQuery } from '../utils/get-query'
+import { GetPopulateQueryOptions, getQuery } from '../utils/get-query'
 
 import type { HookContext } from '@feathersjs/feathers'
 
-import type { PopulateHookOptions, GraphPopulateHookOptions } from '../types'
+import type { Populates } from '../types'
+
+export type PopulateHookOptions<S = string> = Pick<
+  GetPopulateQueryOptions,
+  'namedQueries' | 'defaultQueryName'
+> & {
+  populates: Populates<S>
+  /**
+   * @default: false
+   */
+  allowUnnamedQueryForExternal?: boolean
+}
+
 /**
  * $populateParams.name can be passed from the outside.
  * $populateParams.query can be directly used, internally.
@@ -23,25 +33,28 @@ export function populate(
   return async (context: HookContext): Promise<HookContext> => {
     // Skip this hook if there are no $populateParams or defaultQueryName
     if (!context.params.$populateParams && !defaultQueryName) {
-      return Promise.resolve(context)
+      return context
     }
     /**
      * The `getQuery` function sets up params.$populateParams.query.
      */
-    _set(
+    const query = getQuery({
       context,
-      'params.$populateParams.query',
-      getQuery({
-        context,
-        defaultQueryName,
-        namedQueries,
-        allowUnnamedQueryForExternal,
-      }),
-    )
+      namedQueries,
+      defaultQueryName,
+      allowUnnamedQueryForExternal,
+    })
+
+    if (!query) return context
+
+    // Set the query at params.$populateParams.query
+    if (!context.params.$populateParams) context.params.$populateParams = {}
+
+    context.params.$populateParams.query = query
 
     /**
      * The graphPopulate hook expects to find a query at params.$populateParams.query
      */
-    return graphPopulate({ populates } as GraphPopulateHookOptions)(context)
+    return graphPopulate({ populates })(context)
   }
 }

src/hooks/populate.hook.ts

@@ -24,8 +24,7 @@ import type {
 import { toArray } from '../utils/to-array'
 
 export function shallowPopulate(
-  opts: Partial<ShallowPopulateOptions> &
-    Pick<ShallowPopulateOptions, 'include'>,
+  opts: ShallowPopulateOptions,
 ): (context: HookContext) => Promise<HookContext> {
   const options = {
     catchOnError: false,

src/hooks/shallow-populate.hook.ts

@@ -1,6 +1,6 @@
-export { graphPopulate } from './hooks/graph-populate.hook'
-export { populate } from './hooks/populate.hook'
-export { getQuery } from './utils/get-query'
+export * from './hooks/graph-populate.hook'
+export * from './hooks/populate.hook'
+export * from './utils/get-query'
 export { populateUtil } from './utils/util.populate'
 export { shallowPopulate } from './hooks/shallow-populate.hook'
 

src/index.ts

@@ -36,34 +36,6 @@ export type NestedQuery = Record<string, AnyData>
 
 export type Populates<S = string> = Record<string, PopulateObject<S>>
 
-export interface GraphPopulateHookOptions<S = string> {
-  populates: Populates<S>
-  /**
-   * @default: false
-   */
-  allowUnnamedQueryForExternal?: boolean
-}
-
-export interface PopulateHookOptions<S = string> {
-  populates: Populates<S>
-  namedQueries?: AnyData
-  defaultQueryName?: string
-  /**
-   * @default: false
-   */
-  allowUnnamedQueryForExternal?: boolean
-}
-
-export interface GetPopulateQueryOptions {
-  context: HookContext
-  namedQueries: AnyData
-  defaultQueryName: string
-  /**
-   * @default: false
-   */
-  allowUnnamedQueryForExternal?: boolean
-}
-
 export interface PopulateUtilOptions<S = string> {
   app: Application
   params: Params