WIP

Author: fratzinger

README.md

@@ -1,6 +1,6 @@
 ## feathers-hooks-common
 
-### WIP Changes:
+#### hooks
 
 - added alterData, alterResult, deprecated alterItems
 - added discardData, discardResult, deprecated discard
@@ -10,23 +10,54 @@
 - added lowercaseData, lowercaseResult, deprecated lowercase
 - added setNowData, setNowResult, deprecated setNow
 
-- added getDataIsArray, getResultIsArray, deprecated getItems
-- added replaceData, replaceResult, deprecated replaceItems
-
 - removed several checks that are handled by typescript
 - removed check for `preventChanges(true, ...fieldNames)`
 
 - renamed 'keepQuery' to 'pickQuery', added alias
+- renamed 'required' to 'checkRequired', added alias
+
+- added throwIf
+- added throwIfIsProvider
+- added throwIfIsMulti
+- added paramsForServer2 & paramsForClient2
 
-- added utils from feathers-utils
+- added 'onDelete' & 'createRelated'
 
-  - getPaginate
-  - isMulti
-  - isPaginated
-  - setResultEmpty
+- rm support for spread argument
+
+#### predicates
+
+- renamed 'isNot' to 'not' (added alias for 'isNot')
+- added predicate isMulti
+- added predicate isPaginated
+- added predicate isContext
+
+#### utils
+
+- added getDataIsArray, getResultIsArray, deprecated getItems
+- added replaceData, replaceResult, deprecated replaceItems
+- added util getPaginate
+- added util setResultEmpty
+
+- add onDelete
 
 - stashBefore multi
 
+- new: createRelated
+- new: onDelete
+
+- softDelete: added 'transformParams' & added 'key' option
+
+### Hooks to discuss
+
+- cache
+- populate
+- dePopulate
+- fgraphql
+- fastJoin
+- sequelizeConvert
+- serialize
+
 <p align="center">
   <img src="https://hooks-common.feathersjs.com/feathers-hooks-common-logo.png" width="200">
 </p>

eslint.config.mjs

@@ -36,7 +36,7 @@ export default tseslint.config(
     },
     rules: {
       'import-x/no-dynamic-require': 'warn',
-      'import-x/no-nodejs-modules': 'off',
+      'import-x/no-nodejs-modules': 'error',
     },
   },
   {
@@ -45,6 +45,7 @@ export default tseslint.config(
       '@typescript-eslint/no-explicit-any': 'off',
       '@typescript-eslint/ban-ts-comment': 'off',
       '@typescript-eslint/no-unused-vars': 'off',
+      'import-x/no-nodejs-modules': 'off',
     },
   },
   eslintPluginPrettierRecommended,

package-lock.json

@@ -28,7 +28,8 @@
     "update-dependencies": "ncu -u -x ajv",
     "test:unit": "vitest run",
     "coverage": "vitest run --coverage",
-    "test": "npm run lint && npm run coverage"
+    "test": "npm run lint && npm run coverage",
+    "vitest": "vitest"
   },
   "repository": {
     "type": "git",
@@ -64,6 +65,7 @@
   "dependencies": {
     "@feathersjs/errors": "^5.0.31",
     "ajv": "^6.12.6",
+    "fast-copy": "^3.0.2",
     "graphql": "^16.10.0",
     "lodash": "^4.17.21",
     "neotraverse": "^0.6.18"
@@ -87,8 +89,8 @@
     "@typescript-eslint/parser": "^8.21.0",
     "@vitest/coverage-v8": "^3.0.3",
     "eslint": "^9.18.0",
-    "eslint-import-resolver-typescript": "^3.7.0",
     "eslint-config-prettier": "^10.0.1",
+    "eslint-import-resolver-typescript": "^3.7.0",
     "eslint-plugin-import-x": "^4.6.1",
     "eslint-plugin-prettier": "^5.2.3",
     "mongodb": "^5.9.2",

package.json

@@ -1,5 +1,5 @@
 export function isPromise(p: any): p is Promise<any> {
-  return !!p && (typeof p === 'object' || typeof p === 'function') && typeof p.then === 'function';
+  return p instanceof Promise;
 }
 
 export { setFields } from './set-fields';

src/common/index.ts

@@ -1,6 +1,6 @@
 import type { HookContext } from '@feathersjs/feathers';
 import { replaceData } from '../../utils/replace-items/replace-data';
-import { isPromise } from 'util/types';
+import { isPromise } from '../../common';
 
 /**
  * Make changes to data items. Very flexible.

src/hooks/alter-items/alter-data.ts

@@ -1,5 +1,6 @@
 import { assert } from 'vitest';
 import { alterResult } from './alter-result';
+import { HookContext } from '@feathersjs/feathers';
 
 let hookAfter: any;
 let hookFindPaginate: any;
@@ -40,13 +41,15 @@ describe('alterResult', () => {
     alterResult((rec: any) => {
       delete rec.last;
     })(hookFindPaginate);
+
     assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
   });
 
   it('updates hook after::find with no pagination', () => {
     alterResult((rec: any) => {
       rec.new = rec.first;
     })(hookFind);
+
     assert.deepEqual(hookFind.result, [
       { first: 'John', last: 'Doe', new: 'John' },
       { first: 'Jane', last: 'Doe', new: 'Jane' },
@@ -57,16 +60,19 @@ describe('alterResult', () => {
     alterResult((rec: any) => {
       rec.new = rec.first;
     })(hookAfter);
+
     assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
   });
 
   it('updates hook after::find with pagination with new item returned', () => {
     alterResult((rec: any) => Object.assign({}, { first: rec.first }))(hookFindPaginate);
+
     assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
   });
 
   it('updates hook after::find with pagination with new item returned', () => {
     alterResult((rec: any) => Object.assign({}, rec, { new: rec.first }))(hookFind);
+
     assert.deepEqual(hookFind.result, [
       { first: 'John', last: 'Doe', new: 'John' },
       { first: 'Jane', last: 'Doe', new: 'Jane' },
@@ -75,69 +81,124 @@ describe('alterResult', () => {
 
   it('updates hook after with new item returned', () => {
     alterResult((rec: any) => Object.assign({}, rec, { new: rec.first }))(hookAfter);
+
     assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
   });
 
-  it('updates hook after::create', () => {
-    return alterResult((rec: any) => {
+  it('updates hook after::create', async () => {
+    await alterResult((rec: any) => {
       rec.new = rec.first;
       return Promise.resolve();
-      // @ts-ignore
-    })(hookAfter).then(() => {
-      assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
-    });
+    })(hookAfter);
+
+    assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
   });
 
-  it('updates hook after::create with new item returned', () => {
-    // @ts-ignore
-    return alterResult((rec: any) => Promise.resolve(Object.assign({}, rec, { new: rec.first })))(
+  it('updates hook after::create with new item returned', async () => {
+    await alterResult((rec: any) => Promise.resolve(Object.assign({}, rec, { new: rec.first })))(
       hookAfter,
-    ).then(() => {
-      assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
-    });
+    );
+
+    assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
   });
 
-  it('updates hook after::find with pagination', () => {
-    return alterResult((rec: any) => {
+  it('updates hook after::find with pagination', async () => {
+    await alterResult((rec: any) => {
       delete rec.last;
       return Promise.resolve();
-      // @ts-ignore
-    })(hookFindPaginate).then(() => {
-      assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
-    });
+    })(hookFindPaginate);
+
+    assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
   });
 
-  it('updates hook after::find with no pagination', () => {
-    return alterResult((rec: any) => {
+  it('updates hook after::find with no pagination', async () => {
+    await alterResult((rec: any) => {
       rec.new = rec.first;
       return Promise.resolve();
-      // @ts-ignore
-    })(hookFind).then(() => {
-      assert.deepEqual(hookFind.result, [
-        { first: 'John', last: 'Doe', new: 'John' },
-        { first: 'Jane', last: 'Doe', new: 'Jane' },
-      ]);
-    });
+    })(hookFind);
+
+    assert.deepEqual(hookFind.result, [
+      { first: 'John', last: 'Doe', new: 'John' },
+      { first: 'Jane', last: 'Doe', new: 'Jane' },
+    ]);
   });
 
-  it('updates hook after::find with pagination with new item returned', () => {
-    // @ts-ignore
-    return alterResult((rec: any) => Promise.resolve(Object.assign({}, { first: rec.first })))(
+  it('updates hook after::find with pagination with new item returned', async () => {
+    await alterResult((rec: any) => Promise.resolve(Object.assign({}, { first: rec.first })))(
       hookFindPaginate,
-    ).then(() => {
-      assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
-    });
+    );
+
+    assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
   });
 
-  it('updates hook after::find with no pagination with new item returned', () => {
-    // @ts-ignore
-    return alterResult((rec: any) => Promise.resolve(Object.assign({}, rec, { new: rec.first })))(
+  it('updates hook after::find with no pagination with new item returned', async () => {
+    await alterResult((rec: any) => Promise.resolve(Object.assign({}, rec, { new: rec.first })))(
       hookFind,
-    ).then(() => {
-      assert.deepEqual(hookFind.result, [
-        { first: 'John', last: 'Doe', new: 'John' },
-        { first: 'Jane', last: 'Doe', new: 'Jane' },
-      ]);
-    });
+    );
+
+    assert.deepEqual(hookFind.result, [
+      { first: 'John', last: 'Doe', new: 'John' },
+      { first: 'Jane', last: 'Doe', new: 'Jane' },
+    ]);
+  });
+
+  it('updates dispatch', () => {
+    const context = {
+      type: 'after',
+      method: 'create',
+      params: { provider: 'rest' },
+      result: { first: 'Jane', last: 'Doe' },
+      dispatch: { first: 'Jack', last: 'Doe' },
+    } as HookContext;
+
+    alterResult(
+      (rec: any) => {
+        rec.new = rec.first;
+      },
+      { dispatch: true },
+    )(context);
+
+    assert.deepEqual(context.result, { first: 'Jane', last: 'Doe' });
+    assert.deepEqual(context.dispatch, { first: 'Jack', last: 'Doe', new: 'Jack' });
+  });
+
+  it('updates dispatch even though it is not defined', () => {
+    const context = {
+      type: 'after',
+      method: 'create',
+      params: { provider: 'rest' },
+      result: { first: 'Jane', last: 'Doe' },
+      dispatch: undefined,
+    } as HookContext;
+
+    alterResult(
+      (rec: any) => {
+        rec.new = rec.first;
+      },
+      { dispatch: true },
+    )(context);
+
+    assert.deepEqual(context.result, { first: 'Jane', last: 'Doe' });
+    assert.deepEqual(context.dispatch, { first: 'Jane', last: 'Doe', new: 'Jane' });
+  });
+
+  it('updates dispatch and result', () => {
+    const context = {
+      type: 'after',
+      method: 'create',
+      params: { provider: 'rest' },
+      result: { first: 'Jane', last: 'Doe' },
+      dispatch: { first: 'Jack', last: 'Doe' },
+    } as HookContext;
+
+    alterResult(
+      (rec: any) => {
+        rec.new = rec.first;
+      },
+      { dispatch: 'both' },
+    )(context);
+
+    assert.deepEqual(context.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
+    assert.deepEqual(context.dispatch, { first: 'Jack', last: 'Doe', new: 'Jack' });
   });
 });

src/hooks/alter-items/alter-result.test.ts

@@ -1,13 +1,21 @@
 import type { HookContext, NextFunction } from '@feathersjs/feathers';
 import { isPromise } from '../../common';
 import { replaceResult } from '../../utils/replace-items/replace-result';
+import { DispatchOption } from '../../types';
+
+export type AlterResultOptions = {
+  dispatch?: DispatchOption;
+};
 
 /**
  * Make changes to result items. Very flexible.
  * @see https://hooks-common.feathersjs.com/hooks.html#alteritems
  */
 export const alterResult =
-  <T = any, H extends HookContext = HookContext>(cb: (record: T, context: H) => any) =>
+  <T = any, H extends HookContext = HookContext>(
+    cb: (record: T, context: H) => any,
+    options?: AlterResultOptions,
+  ) =>
   (context: H, next?: NextFunction) =>
     replaceResult(
       context,
@@ -22,5 +30,6 @@ export const alterResult =
       },
       {
         next,
+        dispatch: options?.dispatch,
       },
     );