;
+export type TransformParamsFn = (params: P) => P | void;
+
+export type DispatchOption = boolean | 'both';
diff --git a/src/utils/calling-params/calling-params.ts b/src/utils/calling-params/calling-params.ts
index 08ee037e..8a1e08b8 100755
--- a/src/utils/calling-params/calling-params.ts
+++ b/src/utils/calling-params/calling-params.ts
@@ -58,14 +58,15 @@ export function callingParamsDefaults(propNames: string[], newProps?: any): void
* Build params for a service call. (Utility function.)
* @see https://hooks-common.feathersjs.com/utilities.html#callingparams
*/
-export function callingParams({
- query,
- propNames = [],
- newProps = {},
- hooksToDisable = [],
- ignoreDefaults,
-}: CallingParamsOptions = {}) {
- return (context: H) => {
+export const callingParams =
+ ({
+ query,
+ propNames = [],
+ newProps = {},
+ hooksToDisable = [],
+ ignoreDefaults,
+ }: CallingParamsOptions = {}) =>
+ (context: H) => {
propNames = Array.isArray(propNames) ? propNames : [propNames];
hooksToDisable = Array.isArray(hooksToDisable) ? hooksToDisable : [hooksToDisable];
@@ -113,7 +114,6 @@ export function callingParams({
return newParams;
};
-}
/**
* You should prefer using the callingParams utility to makeCallingParams.
diff --git a/src/utils/check-context/check-context.test.ts b/src/utils/check-context/check-context.test.ts
index aaa50cdc..52388ba3 100755
--- a/src/utils/check-context/check-context.test.ts
+++ b/src/utils/check-context/check-context.test.ts
@@ -1,101 +1,77 @@
-import { assert } from 'vitest';
+import { assert, expect } from 'vitest';
import { checkContext } from './check-context';
+import { HookContext } from '@feathersjs/feathers';
-describe('util checkContext', () => {
- var hook: any; // eslint-disable-line no-var
-
- beforeEach(() => {
- hook = { type: 'before', method: 'create' };
- });
+const make = (type: any, method: any) => ({ type, method }) as HookContext;
+describe('util checkContext', () => {
it('handles "any" type and method', () => {
- assert.equal(checkContext(hook), undefined);
+ expect(() => checkContext(make('before', 'create'))).not.toThrow();
});
it('handles expected type', () => {
- hook.type = 'before';
- assert.equal(checkContext(hook, 'before'), undefined);
+ expect(() => checkContext(make('before', 'create'), 'before')).not.toThrow();
});
it('handles unexpected type', () => {
- hook.type = 'after';
- assert.throws(() => {
- checkContext(hook, 'before');
- });
+ expect(() => checkContext(make('after', 'create'), 'before')).toThrow();
});
it('handles undefined type', () => {
- hook.type = 'after';
- assert.equal(checkContext(hook), undefined);
+ expect(() => checkContext(make('after', 'create'), undefined, 'create')).not.toThrow();
});
it('handles null type', () => {
- hook.type = 'after';
- assert.equal(checkContext(hook, null), undefined);
+ expect(() => checkContext(make('after', 'create'), null, 'create')).not.toThrow();
});
it('handles expected type as array', () => {
- hook.type = 'before';
- assert.equal(checkContext(hook, ['before', 'after']), undefined);
+ expect(() => checkContext(make('before', 'create'), ['before', 'after'])).not.toThrow();
});
it('handles unexpected type as array', () => {
- hook.type = 'error';
- assert.throws(() => {
- checkContext(hook, ['before', 'after']);
- });
+ expect(() => checkContext(make('error', 'create'), ['before', 'after'])).toThrow();
});
it('handles expected method as string', () => {
- hook.method = 'create';
- assert.equal(checkContext(hook, null, 'create'), undefined);
+ expect(() => checkContext(make('before', 'create'), null, 'create')).not.toThrow();
});
it('handles unexpected method as string', () => {
- hook.method = 'patch';
- assert.throws(() => {
- checkContext(hook, null, 'create');
- });
+ expect(() => checkContext(make('before', 'patch'), null, 'create')).toThrow();
});
it('handles expected method as array', () => {
- hook.method = 'create';
- assert.equal(checkContext(hook, null, ['create']), undefined);
- assert.equal(checkContext(hook, null, ['create', 'update', 'remove']), undefined);
+ expect(() =>
+ checkContext(make('before', 'create'), null, ['create', 'update', 'remove']),
+ ).not.toThrow();
});
it('handles unexpected method as array', () => {
- hook.method = 'patch';
- assert.throws(() => {
- checkContext(hook, null, ['create']);
- });
- assert.throws(() => {
- checkContext(hook, null, ['create', 'update', 'remove']);
- });
+ expect(() =>
+ checkContext(make('before', 'patch'), null, ['create', 'update', 'remove']),
+ ).toThrow();
});
it('handles undefined method', () => {
- hook.method = 'patch';
- assert.equal(checkContext(hook, null), undefined);
+ expect(() => checkContext(make('before', 'patch'), null, undefined)).not.toThrow();
});
it('handles null method', () => {
- hook.method = 'patch';
- assert.equal(checkContext(hook, null, null), undefined);
+ expect(() => checkContext(make('before', 'patch'), null, null)).not.toThrow();
});
it('handles expected type and method as array', () => {
- hook.type = 'before';
- hook.method = 'create';
- assert.equal(checkContext(hook, 'before', ['create']), undefined);
- assert.equal(checkContext(hook, 'before', ['create', 'update', 'remove']), undefined);
+ expect(() =>
+ checkContext(make('before', 'create'), ['before', 'after'], ['create', 'update', 'remove']),
+ ).not.toThrow();
});
it('allows custom methods', () => {
- hook.type = 'before';
- hook.method = 'custom';
- assert.equal(checkContext(hook, 'before', ['create']), undefined);
- assert.equal(checkContext(hook, 'before', ['create', 'update', 'remove']), undefined);
+ expect(() => checkContext(make('before', 'custom'), 'before', 'create')).toThrow();
+ expect(() =>
+ checkContext(make('before', 'custom'), 'before', ['create', 'custom']),
+ ).not.toThrow();
});
});
diff --git a/src/utils/check-context/check-context.ts b/src/utils/check-context/check-context.ts
index 26df7c5f..4dbe6b14 100755
--- a/src/utils/check-context/check-context.ts
+++ b/src/utils/check-context/check-context.ts
@@ -1,6 +1,6 @@
import type { HookContext } from '@feathersjs/feathers';
-import { methodNames } from '../../types';
import type { HookType, MethodName } from '../../types';
+import { isContext } from '../../predicates/is-context/is-context';
/**
* Restrict a hook to run for certain methods and method types. (Utility function.)
@@ -12,24 +12,12 @@ export function checkContext(
methods?: MethodName | MethodName[] | null,
label = 'anonymous',
): void {
- if (type) {
- const types = Array.isArray(type) ? type : [type]; // safe enough for allowed values
- if (!types.includes(context.type)) {
- throw new Error(`The '${label}' hook can only be used as a '${type}' hook.`);
- }
- }
-
- if (!methods) {
- return;
- }
- if (!methodNames.includes(context.method as any)) {
- return;
- } // allow custom methods
-
- const methodsArr = Array.isArray(methods) ? methods : [methods]; // safe enough for allowed values
-
- if (methodsArr.length > 0 && !methodsArr.includes(context.method as any)) {
- const msg = JSON.stringify(methodsArr);
- throw new Error(`The '${label}' hook can only be used on the '${msg}' service method(s).`);
+ if (
+ !isContext({
+ method: methods ?? undefined,
+ type: type ?? undefined,
+ })(context)
+ ) {
+ throw new Error(`The '${label}' hook has invalid context.`);
}
}
diff --git a/src/utils/combine/combine.ts b/src/utils/combine/combine.ts
index 5b2d3fc6..8a75aca4 100755
--- a/src/utils/combine/combine.ts
+++ b/src/utils/combine/combine.ts
@@ -2,7 +2,7 @@ import type { HookContext } from '@feathersjs/feathers';
import type { HookFunction } from '../../types';
/**
- * Sequentially execute multiple sync or async hooks.
+ * Sequentially execute multiple hooks.
* @see https://hooks-common.feathersjs.com/utilities.html#combine
*/
export function combine(...serviceHooks: HookFunction[]) {
diff --git a/src/utils/every/every.ts b/src/utils/every/every.ts
deleted file mode 100755
index ef46016a..00000000
--- a/src/utils/every/every.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import type { HookContext } from '@feathersjs/feathers';
-import type { AsyncPredicateFn, PredicateFn } from '../../types';
-
-/**
- * Return the and of a series of sync or async predicate functions.
- * @see https://hooks-common.feathersjs.com/utilities.html#every
- */
-export function every(
- ...predicates: PredicateFn[]
-): AsyncPredicateFn {
- return async function (this: any, ...fnArgs: any[]) {
- // @ts-expect-error TODO
- const promises = predicates.map(fn => fn.apply(this, fnArgs));
-
- const results = await Promise.all(promises);
- return await Promise.resolve(results.every(result => !!result));
- };
-}
diff --git a/src/utils/get-result-is-array/get-result-is-array.test.ts b/src/utils/get-result-is-array/get-result-is-array.test.ts
index 41f890c0..01cf0c7d 100644
--- a/src/utils/get-result-is-array/get-result-is-array.test.ts
+++ b/src/utils/get-result-is-array/get-result-is-array.test.ts
@@ -56,4 +56,84 @@ describe('getResultIsArray', () => {
key: 'result',
});
});
+
+ it('dispatch', () => {
+ const result = { a: 1, b: 2 };
+ const dispatch = { c: 3, d: 4 };
+ expect(getResultIsArray({ result, dispatch } as any, { dispatch: true })).toEqual({
+ isArray: false,
+ result: [dispatch],
+ key: 'dispatch',
+ });
+
+ expect(
+ getResultIsArray({ method: 'find', result, dispatch } as any, { dispatch: true }),
+ ).toEqual({
+ isArray: false,
+ result: [dispatch],
+ key: 'dispatch',
+ });
+
+ expect(
+ getResultIsArray({ method: 'find', result: { data: result }, dispatch } as any, {
+ dispatch: true,
+ }),
+ ).toEqual({
+ isArray: false,
+ result: [dispatch],
+ key: 'dispatch',
+ });
+ });
+
+ it('returns dispatch if is missing with single result', () => {
+ const result = { a: 1, b: 2 };
+ const context = { result } as any;
+ expect(getResultIsArray(context, { dispatch: true })).toEqual({
+ isArray: false,
+ result: [result],
+ key: 'result',
+ });
+ expect(context.dispatch).toEqual(undefined);
+ });
+
+ it("doesn't set dispatch if is missing with array result", () => {
+ const result = [{ a: 1, b: 2 }];
+ const context = { method: 'create', result } as any;
+
+ expect(getResultIsArray(context, { dispatch: true })).toEqual({
+ isArray: true,
+ result: result,
+ key: 'result',
+ });
+ expect(context.dispatch).toEqual(undefined);
+ });
+
+ it("doesn't set dispatch if is missing with find array", () => {
+ const result = [{ a: 1, b: 2 }];
+ const dispatch = undefined;
+ const context = { method: 'find', result, dispatch } as any;
+
+ expect(getResultIsArray(context, { dispatch: true })).toEqual({
+ isArray: true,
+ result,
+ key: 'result',
+ });
+ });
+
+ it('sets dispatch if is missing with paginated result', () => {
+ const result = [{ a: 1, b: 2 }];
+ const dispatch = undefined;
+ const context = { method: 'find', result: { data: result, total: 3 }, dispatch } as any;
+
+ expect(
+ getResultIsArray(context, {
+ dispatch: true,
+ }),
+ ).toEqual({
+ isArray: true,
+ result,
+ key: 'result',
+ });
+ expect(context.dispatch).toEqual(undefined);
+ });
});
diff --git a/src/utils/get-result-is-array/get-result-is-array.ts b/src/utils/get-result-is-array/get-result-is-array.ts
index dc44570e..1c2b261d 100644
--- a/src/utils/get-result-is-array/get-result-is-array.ts
+++ b/src/utils/get-result-is-array/get-result-is-array.ts
@@ -1,16 +1,25 @@
import { HookContext } from '@feathersjs/feathers';
+import copy from 'fast-copy';
+
+type GetResultIsArrayOptions = {
+ dispatch?: boolean;
+};
export function getResultIsArray(
context: H,
- dispatch?: boolean,
+ options?: GetResultIsArrayOptions,
): { isArray: boolean; result: any[]; key: 'dispatch' | 'result' } {
- const result = dispatch ? context.dispatch : context.result;
+ const { dispatch = false } = options || {};
+
+ const isDispatch: boolean = dispatch && context.dispatch !== undefined;
+
+ const result = dispatch ? (isDispatch ? context.dispatch : copy(context.result)) : context.result;
if (!result) {
return {
isArray: false,
result: [],
- key: dispatch ? 'dispatch' : 'result',
+ key: isDispatch ? 'dispatch' : 'result',
};
}
@@ -21,6 +30,6 @@ export function getResultIsArray(
return {
isArray,
result: isArray ? items : items ? [items] : [],
- key: dispatch ? 'dispatch' : 'result',
+ key: isDispatch ? 'dispatch' : 'result',
};
}
diff --git a/src/utils/index.ts b/src/utils/index.ts
index 23fa7083..0008a25e 100644
--- a/src/utils/index.ts
+++ b/src/utils/index.ts
@@ -2,24 +2,20 @@ export * from './calling-params/calling-params';
export * from './check-context/check-context';
export * from './check-context-if';
export * from './combine/combine';
-export * from './every/every';
export * from './get-items/get-items';
export * from './get-data-is-array/get-data-is-array';
export * from './get-result-is-array/get-result-is-array';
-export * from './is-not/is-not';
-export * from './is-provider/is-provider';
export * from './params-for-server/params-for-server';
export * from './replace-items/replace-items';
export * from './replace-items/replace-data';
export * from './replace-items/replace-result';
-export * from './some/some';
export * from './run-hook/run-hook';
export * from './get-paginate/get-paginate';
-export * from './is-multi/is-multi';
-export * from './is-paginated/is-paginated';
+export * from '../predicates/is-multi/is-multi';
+export * from '../predicates/is-paginated/is-paginated';
export * from './skip-result/skip-result';
diff --git a/src/utils/params-for-server/params-for-server.ts b/src/utils/params-for-server/params-for-server.ts
index eeec4eb1..db86fdcb 100755
--- a/src/utils/params-for-server/params-for-server.ts
+++ b/src/utils/params-for-server/params-for-server.ts
@@ -4,6 +4,8 @@ import type { Params } from '@feathersjs/feathers';
* Pass an explicit context.params from client to server. Client-side. (Utility function.)
*
* @see https://hooks-common.feathersjs.com/utilities.html#paramsforserver
+ *
+ * @deprecated use the hook `paramsForServer2` instead
*/
export function paramsForServer(params?: Params, ...whitelist: string[]): Params {
const ifWhitelist = !!whitelist.length;
diff --git a/src/utils/replace-items/replace-data.ts b/src/utils/replace-items/replace-data.ts
index a6155de4..881164e2 100644
--- a/src/utils/replace-items/replace-data.ts
+++ b/src/utils/replace-items/replace-data.ts
@@ -1,7 +1,7 @@
import { HookContext } from '@feathersjs/feathers';
import { getDataIsArray } from '../get-data-is-array/get-data-is-array';
import { isPromise } from '../../common';
-import { Promisable } from '../../types';
+import { Promisable } from '../../internal.utils';
export function replaceData(
context: H,
diff --git a/src/utils/replace-items/replace-result.test.ts b/src/utils/replace-items/replace-result.test.ts
new file mode 100644
index 00000000..30fbf894
--- /dev/null
+++ b/src/utils/replace-items/replace-result.test.ts
@@ -0,0 +1,169 @@
+import { expect } from 'vitest';
+import { replaceResult } from './replace-result';
+
+// Tests when context.params._actOn === 'dispatch' are in act-on.test.ts
+describe('replaceResult', () => {
+ it("replaces context.result on paginated 'find'", async () => {
+ const context = {
+ method: 'find',
+ result: { total: 2, data: [{ id: 1 }, { id: 2 }] },
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual({ total: 2, data: [{ id: 2 }, { id: 3 }] });
+ });
+
+ it("replaces context.result on array 'find'", async () => {
+ const context = {
+ method: 'find',
+ result: [{ id: 1 }, { id: 2 }],
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual([{ id: 2 }, { id: 3 }]);
+ });
+
+ it("replaces context.result on 'get'", async () => {
+ const context = {
+ method: 'find',
+ id: 1,
+ result: { id: 1 },
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual({ id: 2 });
+ });
+
+ it("replaces context.result on 'create'", async () => {
+ const context = {
+ method: 'create',
+ result: { id: 1 },
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual({ id: 2 });
+ });
+
+ it("replaces context.result on multi:'create'", async () => {
+ const context = {
+ method: 'create',
+ result: [{ id: 1 }, { id: 2 }],
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual([{ id: 2 }, { id: 3 }]);
+ });
+
+ it('replaces context.result on update', async () => {
+ const context = {
+ method: 'update',
+ id: 1,
+ result: { id: 1 },
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual({ id: 2 });
+ });
+
+ it('replaces context.result on patch', async () => {
+ const context = {
+ method: 'patch',
+ id: 1,
+ result: { id: 1 },
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual({ id: 2 });
+ });
+
+ it('replaces context.result on multi patch', async () => {
+ const context = {
+ method: 'patch',
+ id: null,
+ result: [{ id: 1 }, { id: 2 }],
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual([{ id: 2 }, { id: 3 }]);
+ });
+
+ it('replaces context.result on remove', async () => {
+ const context = {
+ method: 'remove',
+ id: 1,
+ result: { id: 1 },
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual({ id: 2 });
+ });
+
+ it('replaces context.result on multi remove', async () => {
+ const context = {
+ method: 'remove',
+ id: null,
+ result: [{ id: 1 }, { id: 2 }],
+ };
+
+ await replaceResult(context as any, item => ({ id: item.id + 1 }));
+
+ expect(context.result).toStrictEqual([{ id: 2 }, { id: 3 }]);
+ });
+
+ it("replaces context.dispatch on 'get'", async () => {
+ const context = {
+ method: 'find',
+ id: 1,
+ result: { result: true },
+ dispatch: { dispatch: true },
+ };
+
+ await replaceResult(context as any, item => ({ ...item, test: true }), { dispatch: true });
+
+ expect(context.result).toStrictEqual({ result: true });
+ expect(context.dispatch).toStrictEqual({ dispatch: true, test: true });
+ });
+
+ it("replaces both context.result & context.dispatch on 'get'", async () => {
+ const context = {
+ method: 'find',
+ id: 1,
+ result: { result: true },
+ dispatch: { dispatch: true },
+ };
+
+ await replaceResult(context as any, item => ({ ...item, test: true }), { dispatch: 'both' });
+
+ expect(context.result).toStrictEqual({ result: true, test: true });
+ expect(context.dispatch).toStrictEqual({ dispatch: true, test: true });
+ });
+
+ it("replaces context.dispatch even though it was not there before on 'get'", async () => {
+ const context = {
+ method: 'find',
+ id: 1,
+ result: { result: true },
+ } as any;
+
+ await replaceResult(
+ context as any,
+ item => {
+ item.test = true;
+ return item;
+ },
+ { dispatch: true },
+ );
+
+ expect(context.result).toStrictEqual({ result: true });
+ expect(context.dispatch).toStrictEqual({ result: true, test: true });
+ });
+});
diff --git a/src/utils/replace-items/replace-result.ts b/src/utils/replace-items/replace-result.ts
index 43a8fa2c..2c4478e0 100644
--- a/src/utils/replace-items/replace-result.ts
+++ b/src/utils/replace-items/replace-result.ts
@@ -1,60 +1,74 @@
import { HookContext, NextFunction } from '@feathersjs/feathers';
import { getResultIsArray } from '../get-result-is-array/get-result-is-array';
import { isPromise } from '../../common';
+import copy from 'fast-copy';
+import { DispatchOption } from '../../types';
+
+export type ReplaceResultOptions = {
+ next?: NextFunction;
+ transform?: (items: any[]) => any[];
+ dispatch?: DispatchOption;
+};
export async function replaceResult(
context: H,
cb: (item: any) => any,
- options?: {
- next?: NextFunction;
- transform?: (items: any[]) => any[];
- },
+ options?: ReplaceResultOptions,
): Promise {
if (options?.next) {
await options.next();
}
- if (!context.result) {
- return context;
+ if (!!options?.dispatch && !context.dispatch) {
+ context.dispatch = copy(context.result);
}
- const { result, isArray, key } = getResultIsArray(context);
+ async function forResult(dispatch: boolean) {
+ const { result, isArray, key } = getResultIsArray(context, { dispatch });
- if (!result.length) {
- return context;
- }
+ if (!result.length) {
+ return context;
+ }
- let hasPromises = false;
+ let hasPromises = false;
- const results = result.map(item => {
- const result = cb(item);
+ const results = result.map(item => {
+ const result = cb(item);
- if (!hasPromises && isPromise(result)) {
- hasPromises = true;
- }
+ if (!hasPromises && isPromise(result)) {
+ hasPromises = true;
+ }
+
+ return result;
+ });
+
+ function replace(r: any) {
+ if (options?.transform) {
+ r = options.transform(r);
+ }
- return result;
- });
+ if (!isArray) {
+ context[key] = r[0];
+ } else if (isArray && !Array.isArray(context[key]) && context[key].data) {
+ context[key].data = r;
+ } else {
+ context[key] = r;
+ }
- function replace(r: any) {
- if (options?.transform) {
- r = options.transform(r);
+ return context;
}
- if (!isArray) {
- context[key] = r[0];
- } else if (isArray && !Array.isArray(context[key]) && context[key].data) {
- context[key].data = r;
+ if (hasPromises) {
+ return await Promise.all(results).then(replace);
} else {
- context[key] = r;
+ return replace(results);
}
+ }
+ if (options?.dispatch === 'both') {
+ await Promise.all([forResult(true), forResult(false)]);
return context;
}
- if (hasPromises) {
- return await Promise.all(results).then(replace);
- } else {
- return replace(results);
- }
+ return await forResult(options?.dispatch ?? false);
}
diff --git a/src/utils/skip-result/skip-result.ts b/src/utils/skip-result/skip-result.ts
index 7fee1476..afdc8565 100644
--- a/src/utils/skip-result/skip-result.ts
+++ b/src/utils/skip-result/skip-result.ts
@@ -1,6 +1,5 @@
import type { HookContext } from '@feathersjs/feathers';
-import { isMulti } from '../is-multi/is-multi';
-import { isPaginated } from '../is-paginated/is-paginated';
+import { isMulti, isPaginated } from '../../predicates';
/**
* util to set `context.result` to an empty array or object, depending on the hook type
diff --git a/src/utils/some/some.test.ts b/src/utils/some/some.test.ts
deleted file mode 100755
index 2abfeb80..00000000
--- a/src/utils/some/some.test.ts
+++ /dev/null
@@ -1,138 +0,0 @@
-import { assert } from 'vitest';
-import { feathers } from '@feathersjs/feathers';
-import { MemoryService } from '@feathersjs/memory';
-import { some } from './some';
-import { iff } from '../../hooks/iff/iff';
-import { isNot } from '../is-not/is-not';
-
-describe('util some', () => {
- let app: any;
-
- beforeEach(() => {
- app = feathers().use('/users', new MemoryService());
- });
-
- describe('when at least 1 hook is truthy', () => {
- beforeEach(() => {
- app.service('users').hooks({
- before: {
- all: [
- iff(
- some(
- (_hook: any) => false,
- (_hook: any) => Promise.resolve(false),
- (_hook: any) => Promise.resolve(true),
- (_hook: any) => true,
- // @ts-ignore
- (_hook: any) => 1,
- (_hook: any) => {},
- ),
- (hook: any) => Promise.resolve(hook),
- ),
- ],
- },
- });
- });
-
- it('returns true', () => {
- return app
- .service('users')
- .find()
- .then((result: any) => {
- assert.deepEqual(result, []);
- });
- });
- });
-
- describe('when a hook throws an error', () => {
- beforeEach(() => {
- app.service('users').hooks({
- before: {
- all: [
- iff(
- some(
- (_hook: any) => true,
- (_hook: any) => {
- throw new Error('Hook 2 errored');
- },
- (_hook: any) => true,
- ),
- (hook: any) => Promise.resolve(hook),
- ),
- ],
- },
- });
- });
-
- it('rejects with the error', () => {
- return app
- .service('users')
- .find()
- .catch((error: any) => {
- assert.equal(error.message, 'Hook 2 errored');
- });
- });
- });
-
- describe('when a hook rejects with an error', () => {
- beforeEach(() => {
- app.service('users').hooks({
- before: {
- all: [
- iff(
- some(
- (_hook: any) => true,
- (_hook: any) => Promise.reject(Error('Hook 2 errored')),
- (_hook: any) => true,
- ),
- (hook: any) => Promise.resolve(hook),
- ),
- ],
- },
- });
- });
-
- it('rejects with the error', () => {
- return app
- .service('users')
- .find()
- .catch((error: any) => {
- assert.equal(error.message, 'Hook 2 errored');
- });
- });
- });
-
- describe('when all hooks are falsey', () => {
- beforeEach(() => {
- app.service('users').hooks({
- before: {
- all: [
- iff(
- isNot(
- some(
- (_hook: any) => false,
- (_hook: any) => Promise.resolve(false),
- // @ts-ignore
- (_hook: any) => null,
- (_hook: any) => undefined,
- // @ts-ignore
- (_hook: any) => 0,
- ),
- ),
- () => Promise.reject(new Error('All hooks returned false')),
- ),
- ],
- },
- });
- });
-
- it('returns false', () => {
- return app
- .service('users')
- .find()
- .catch((error: any) => {
- assert.equal(error.message, 'All hooks returned false');
- });
- });
- });
-});
diff --git a/src/utils/some/some.ts b/src/utils/some/some.ts
deleted file mode 100755
index 2d4d3404..00000000
--- a/src/utils/some/some.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-import type { HookContext } from '@feathersjs/feathers';
-import type { AsyncPredicateFn, PredicateFn } from '../../types';
-
-/**
- * Return the or of a series of sync or async predicate functions.
- * @see https://hooks-common.feathersjs.com/utilities.html#some
- */
-export function some(
- ...predicates: PredicateFn[]
-): AsyncPredicateFn {
- return async function (this: any, context: H) {
- const promises = predicates.map(fn => fn.apply(this, [context]));
-
- const results = await Promise.all(promises);
- return await Promise.resolve(results.some((result: any) => !!result));
- };
-}
diff --git a/src/utils/transform-params/transform-params.ts b/src/utils/transform-params/transform-params.ts
new file mode 100644
index 00000000..17d17ebe
--- /dev/null
+++ b/src/utils/transform-params/transform-params.ts
@@ -0,0 +1,18 @@
+import { Params } from '@feathersjs/feathers';
+import { TransformParamsFn } from '../../types';
+
+/**
+ * Safely use a transformParams function to modify params.
+ */
+export const transformParams = (
+ params: P,
+ fn: TransformParamsFn
| undefined,
+): P => {
+ if (!fn) {
+ return params;
+ }
+
+ const result = fn({ ...params });
+
+ return result ?? params;
+};
diff --git a/test/index.test.ts b/test/index.test.ts
index de9f42a6..67d80b94 100755
--- a/test/index.test.ts
+++ b/test/index.test.ts
@@ -72,6 +72,7 @@ const members = [
'replaceData',
'replaceResult',
+ 'checkRequired',
'required',
'runHook',
'runParallel',
@@ -96,13 +97,17 @@ const members = [
'iff',
'when',
'unless',
+
+ // predicates
'some',
'every',
'isNot',
-
- 'getPaginate',
+ 'not',
'isMulti',
'isPaginated',
+ 'isContext',
+
+ 'getPaginate',
'skipResult',
].sort();
From e6bb8c02d5ca1b22da936506dee17c2df9820d8c Mon Sep 17 00:00:00 2001
From: fratzinger <22286818+fratzinger@users.noreply.github.com>
Date: Tue, 18 Feb 2025 23:07:36 +0100
Subject: [PATCH 05/15] WIP
---
README.md | 15 +++++----------
src/predicates/not/not.ts | 1 -
src/utils/index.ts | 2 --
3 files changed, 5 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index b9035ba5..07226b81 100755
--- a/README.md
+++ b/README.md
@@ -23,6 +23,10 @@
- added 'onDelete' & 'createRelated'
+- stashBefore multi
+
+- softDelete: added 'transformParams' & added 'key' option
+
- rm support for spread argument
#### predicates
@@ -37,16 +41,7 @@
- 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
+- added util skipResult
### Hooks to discuss
diff --git a/src/predicates/not/not.ts b/src/predicates/not/not.ts
index 14709db2..6de6a03f 100755
--- a/src/predicates/not/not.ts
+++ b/src/predicates/not/not.ts
@@ -1,4 +1,3 @@
-import { MethodNotAllowed } from '@feathersjs/errors';
import type { HookContext } from '@feathersjs/feathers';
import { isPromise } from '../../common';
import type { PredicateFn } from '../../types';
diff --git a/src/utils/index.ts b/src/utils/index.ts
index 0008a25e..7d39e7f6 100644
--- a/src/utils/index.ts
+++ b/src/utils/index.ts
@@ -16,6 +16,4 @@ export * from './replace-items/replace-result';
export * from './run-hook/run-hook';
export * from './get-paginate/get-paginate';
-export * from '../predicates/is-multi/is-multi';
-export * from '../predicates/is-paginated/is-paginated';
export * from './skip-result/skip-result';
From 36090bbf8a0c479555cbc31f4449cf44d2696010 Mon Sep 17 00:00:00 2001
From: fratzinger <22286818+fratzinger@users.noreply.github.com>
Date: Tue, 13 May 2025 10:29:10 +0200
Subject: [PATCH 06/15] WIP
---
README.md | 16 +-
package.json | 4 +-
.../act-on-dispatch/act-on-dispatch.test.ts | 108 ---
src/hooks/act-on-dispatch/act-on-dispatch.ts | 28 -
src/hooks/alter-items/alter-data.ts | 11 +-
src/hooks/alter-items/alter-items.test.ts | 248 ------
src/hooks/alter-items/alter-items.ts | 56 --
src/hooks/cache/cache.ts | 2 +
src/hooks/check-required/check-required.ts | 10 +-
src/hooks/de-populate/de-populate.test.ts | 284 -------
src/hooks/de-populate/de-populate.ts | 28 -
src/hooks/debug/debug.ts | 12 +-
.../disable-pagination/disable-pagination.ts | 10 +-
src/hooks/disallow/disallow.ts | 18 +-
src/hooks/fast-join/fast-join-cache.test.ts | 375 ---------
src/hooks/fast-join/fast-join.test.ts | 753 -----------------
src/hooks/fast-join/fast-join.ts | 124 ---
src/hooks/fast-join/test/make-services.ts | 98 ---
src/hooks/fgraphql/fgraphql.test.ts | 760 ------------------
src/hooks/fgraphql/fgraphql.ts | 410 ----------
src/hooks/keep-in-array/keep-in-array.test.ts | 274 -------
src/hooks/keep-in-array/keep-in-array.ts | 57 --
.../keep-query-in-array.test.ts | 179 -----
.../keep-query-in-array.ts | 53 --
src/hooks/lowercase/lowercase-data.ts | 11 +-
src/hooks/lowercase/lowercase.test.ts | 140 ----
src/hooks/lowercase/lowercase.ts | 35 -
src/hooks/mongo-keys/mongo-keys.test.ts | 74 --
src/hooks/mongo-keys/mongo-keys.ts | 67 --
src/hooks/omit-query/omit-query.ts | 7 +-
src/hooks/omit/omit-1.test.ts | 134 ---
src/hooks/omit/omit-2.test.ts | 187 -----
src/hooks/omit/omit-data.ts | 8 +-
src/hooks/omit/omit-result.ts | 7 +-
src/hooks/omit/omit.test.ts | 191 -----
src/hooks/omit/omit.ts | 27 -
.../params-for-server.test.ts} | 8 +-
.../params-for-server.ts} | 6 +-
.../params-from-client.test.ts | 203 +----
.../params-from-client/params-from-client.ts | 69 +-
.../params-from-client2.test.ts | 54 --
.../params-from-client2.ts | 53 --
src/hooks/pick-query/pick-query.ts | 15 +-
src/hooks/pick/pick-data.ts | 13 +-
src/hooks/pick/pick-result.ts | 11 +-
src/hooks/pick/pick.test.ts | 220 -----
src/hooks/pick/pick.ts | 36 -
.../populate/populate-1deep-1child.test.ts | 668 ---------------
src/hooks/populate/populate-basics.test.ts | 128 ---
src/hooks/populate/populate-misc.test.ts | 294 -------
src/hooks/populate/populate-relations.test.ts | 326 --------
.../populate/populate-scaffolding.test.ts | 33 -
src/hooks/populate/populate.ts | 350 --------
src/hooks/populate/test/config-app.ts | 38 -
src/hooks/populate/test/get-init-db.ts | 111 ---
src/hooks/prevent-changes/prevent-changes.ts | 33 +-
src/hooks/resolvers/resolve-data.ts | 28 +
src/hooks/resolvers/resolve-query.ts | 18 +
src/hooks/resolvers/resolve-result.ts | 43 +
src/hooks/resolvers/resolver.test.ts | 108 +++
src/hooks/resolvers/resolvers.internal.ts | 135 ++++
.../sequelize-convert.test.ts | 428 ----------
.../sequelize-convert/sequelize-convert.ts | 74 --
src/hooks/serialize/serialize.test.ts | 210 -----
src/hooks/serialize/serialize.ts | 84 --
src/hooks/set-field/set-field.ts | 12 +-
src/hooks/set-now/set-now.test.ts | 182 -----
src/hooks/set-now/set-now.ts | 22 -
src/hooks/set-slug/set-slug.ts | 8 +-
src/hooks/sifter/sifter.ts | 9 +-
src/hooks/soft-delete/soft-delete.ts | 8 +-
src/hooks/stash-before/stash-before.ts | 12 +-
src/hooks/throw-if/throw-if-is-multi.ts | 15 +-
src/hooks/throw-if/throw-if.ts | 10 +-
.../validate-schema/validate-schema.test.ts | 292 -------
src/hooks/validate-schema/validate-schema.ts | 93 ---
src/hooks/validate/validate.test.ts | 92 ---
src/hooks/validate/validate.ts | 67 --
src/predicates/not/not.ts | 3 -
.../get-exposed-methods.ts | 11 +
80 files changed, 590 insertions(+), 8849 deletions(-)
delete mode 100755 src/hooks/act-on-dispatch/act-on-dispatch.test.ts
delete mode 100755 src/hooks/act-on-dispatch/act-on-dispatch.ts
delete mode 100755 src/hooks/alter-items/alter-items.test.ts
delete mode 100755 src/hooks/alter-items/alter-items.ts
delete mode 100755 src/hooks/de-populate/de-populate.test.ts
delete mode 100755 src/hooks/de-populate/de-populate.ts
delete mode 100755 src/hooks/fast-join/fast-join-cache.test.ts
delete mode 100755 src/hooks/fast-join/fast-join.test.ts
delete mode 100755 src/hooks/fast-join/fast-join.ts
delete mode 100755 src/hooks/fast-join/test/make-services.ts
delete mode 100755 src/hooks/fgraphql/fgraphql.test.ts
delete mode 100755 src/hooks/fgraphql/fgraphql.ts
delete mode 100755 src/hooks/keep-in-array/keep-in-array.test.ts
delete mode 100755 src/hooks/keep-in-array/keep-in-array.ts
delete mode 100755 src/hooks/keep-query-in-array/keep-query-in-array.test.ts
delete mode 100644 src/hooks/keep-query-in-array/keep-query-in-array.ts
delete mode 100755 src/hooks/lowercase/lowercase.test.ts
delete mode 100755 src/hooks/lowercase/lowercase.ts
delete mode 100755 src/hooks/mongo-keys/mongo-keys.test.ts
delete mode 100755 src/hooks/mongo-keys/mongo-keys.ts
delete mode 100755 src/hooks/omit/omit-1.test.ts
delete mode 100755 src/hooks/omit/omit-2.test.ts
delete mode 100755 src/hooks/omit/omit.test.ts
delete mode 100755 src/hooks/omit/omit.ts
rename src/hooks/{params-for-server2/params-for-server2.test.ts => params-for-server/params-for-server.test.ts} (81%)
rename src/hooks/{params-for-server2/params-for-server2.ts => params-for-server/params-for-server.ts} (92%)
mode change 100755 => 100644 src/hooks/params-from-client/params-from-client.test.ts
mode change 100755 => 100644 src/hooks/params-from-client/params-from-client.ts
delete mode 100644 src/hooks/params-from-client2/params-from-client2.test.ts
delete mode 100644 src/hooks/params-from-client2/params-from-client2.ts
delete mode 100755 src/hooks/pick/pick.test.ts
delete mode 100755 src/hooks/pick/pick.ts
delete mode 100755 src/hooks/populate/populate-1deep-1child.test.ts
delete mode 100755 src/hooks/populate/populate-basics.test.ts
delete mode 100755 src/hooks/populate/populate-misc.test.ts
delete mode 100755 src/hooks/populate/populate-relations.test.ts
delete mode 100755 src/hooks/populate/populate-scaffolding.test.ts
delete mode 100755 src/hooks/populate/populate.ts
delete mode 100755 src/hooks/populate/test/config-app.ts
delete mode 100755 src/hooks/populate/test/get-init-db.ts
create mode 100644 src/hooks/resolvers/resolve-data.ts
create mode 100644 src/hooks/resolvers/resolve-query.ts
create mode 100644 src/hooks/resolvers/resolve-result.ts
create mode 100644 src/hooks/resolvers/resolver.test.ts
create mode 100644 src/hooks/resolvers/resolvers.internal.ts
delete mode 100755 src/hooks/sequelize-convert/sequelize-convert.test.ts
delete mode 100755 src/hooks/sequelize-convert/sequelize-convert.ts
delete mode 100755 src/hooks/serialize/serialize.test.ts
delete mode 100755 src/hooks/serialize/serialize.ts
delete mode 100755 src/hooks/set-now/set-now.test.ts
delete mode 100755 src/hooks/set-now/set-now.ts
delete mode 100755 src/hooks/validate-schema/validate-schema.test.ts
delete mode 100755 src/hooks/validate-schema/validate-schema.ts
delete mode 100755 src/hooks/validate/validate.test.ts
delete mode 100755 src/hooks/validate/validate.ts
create mode 100644 src/utils/get-exposed-methods/get-exposed-methods.ts
diff --git a/README.md b/README.md
index 07226b81..df2ff069 100755
--- a/README.md
+++ b/README.md
@@ -2,13 +2,13 @@
#### hooks
-- added alterData, alterResult, deprecated alterItems
-- added discardData, discardResult, deprecated discard
- - moved to omitData, omitResult, deprecated omit
-- added keepData, keepResult, deprecated keep
- - moved to pickData, pickResult, deprecated pick
-- added lowercaseData, lowercaseResult, deprecated lowercase
-- added setNowData, setNowResult, deprecated setNow
+- added alterData, alterResult, rm alterItems
+- added discardData, discardResult, rm discard
+ - moved to omitData, omitResult, rm omit
+- added keepData, keepResult, rm keep
+ - moved to pickData, pickResult, rm pick
+- added lowercaseData, lowercaseResult, rm lowercase
+- added setNowData, setNowResult, rm setNow
- removed several checks that are handled by typescript
- removed check for `preventChanges(true, ...fieldNames)`
@@ -29,6 +29,8 @@
- rm support for spread argument
+- rm 'actOnDispatch' & 'actOnDefault'
+
#### predicates
- renamed 'isNot' to 'not' (added alias for 'isNot')
diff --git a/package.json b/package.json
index 1756b4a0..d142d735 100644
--- a/package.json
+++ b/package.json
@@ -25,7 +25,7 @@
"release:major": "npm version major && npm publish",
"changelog": "github_changelog_generator --max-issues 200 -u feathersjs-ecosystem -p feathers-hooks-common && git add CHANGELOG.md && git commit -am \"Updating changelog\"",
"lint": "eslint .",
- "update-dependencies": "ncu -u -x ajv",
+ "update-dependencies": "ncu -u",
"test:unit": "vitest run",
"coverage": "vitest run --coverage",
"test": "npm run lint && npm run coverage",
@@ -64,9 +64,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"
},
diff --git a/src/hooks/act-on-dispatch/act-on-dispatch.test.ts b/src/hooks/act-on-dispatch/act-on-dispatch.test.ts
deleted file mode 100755
index 7ef45a36..00000000
--- a/src/hooks/act-on-dispatch/act-on-dispatch.test.ts
+++ /dev/null
@@ -1,108 +0,0 @@
-import type { HookContext } from '@feathersjs/feathers';
-import { assert } from 'vitest';
-import { actOnDefault, actOnDispatch } from './act-on-dispatch';
-import { combine, getItems, replaceItems } from '../../utils';
-
-let hookBefore: any;
-
-function testHook(what: any, code: any) {
- return (context: HookContext) => {
- if (context.params._actOn !== what) {
- throw new Error(`Hook code ${code} expected ${what} found ${context.params._actOn}`);
- }
-
- context.params._actOnCodes.push(code);
- };
-}
-
-describe('services actOn', () => {
- describe('Call hooks which do not call other hooks', () => {
- beforeEach(() => {
- hookBefore = {
- type: 'before',
- method: 'get',
- params: { _actOnCodes: [] },
- };
- });
-
- it('actOnDefault', async () => {
- const result: any = await actOnDefault(
- testHook(undefined, 1),
- testHook(undefined, 2),
- testHook(undefined, 3),
- )(hookBefore);
-
- assert.deepEqual(result.params._actOnCodes, [1, 2, 3]);
- });
-
- it('actOnDispatch', async () => {
- const result: any = await actOnDispatch(
- testHook('dispatch', 10),
- testHook('dispatch', 20),
- testHook('dispatch', 30),
- )(hookBefore);
-
- assert.deepEqual(result.params._actOnCodes, [10, 20, 30]);
- });
- });
-
- describe('Call hooks calling others same actOn', () => {
- beforeEach(() => {
- hookBefore = {
- type: 'before',
- method: 'get',
- params: { _actOnCodes: [] },
- };
- });
-
- it('actOnDefault calling actOnDefault', async () => {
- const result: any = await actOnDefault(
- combine(testHook(undefined, 11), testHook(undefined, 12)),
- combine(testHook(undefined, 21), testHook(undefined, 22)),
- )(hookBefore);
-
- assert.deepEqual(result.params._actOnCodes, [11, 12, 21, 22]);
- });
-
- it('actOnDefault calling actOnDispatch', async () => {
- const result: any = await actOnDefault(
- actOnDispatch(combine(testHook('dispatch', 11), testHook('dispatch', 12))),
- combine(testHook(undefined, 21), testHook(undefined, 22)),
- )(hookBefore);
-
- assert.deepEqual(result.params._actOnCodes, [11, 12, 21, 22]);
- });
-
- it('actOnDispatch calling actOnDefault', async () => {
- const result: any = await actOnDispatch(
- actOnDefault(combine(testHook(undefined, 11), testHook(undefined, 12))),
- combine(testHook('dispatch', 21), testHook('dispatch', 22)),
- )(hookBefore);
-
- assert.deepEqual(result.params._actOnCodes, [11, 12, 21, 22]);
- });
- });
-
- describe('getItems & replaceItems', () => {
- beforeEach(() => {
- hookBefore = {
- type: 'before',
- method: 'get',
- data: { a: 1 },
- result: { b: 2 },
- dispatch: { c: 3 },
- params: { _actOn: 'dispatch' },
- };
- });
-
- it('Gets dispatch data', () => {
- assert.deepEqual(getItems(hookBefore), hookBefore.dispatch);
- });
-
- it('Returns dispatch data', () => {
- replaceItems(hookBefore, { foo: 'bar' });
-
- assert.deepEqual(hookBefore.dispatch, { foo: 'bar' });
- });
- });
-});
diff --git a/src/hooks/act-on-dispatch/act-on-dispatch.ts b/src/hooks/act-on-dispatch/act-on-dispatch.ts
deleted file mode 100755
index 5954eaf7..00000000
--- a/src/hooks/act-on-dispatch/act-on-dispatch.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-import type { HookContext } from '@feathersjs/feathers';
-import type { HookFunction } from '../../types';
-import { combine } from '../../utils';
-
-/**
- * Runs a series of hooks which mutate context.data or context.result (the Feathers default).
- * @see https://hooks-common.feathersjs.com/hooks.html#actondefault
- */
-export const actOnDefault = (...hooks: HookFunction[]) =>
- actOn(undefined, ...hooks);
-
-/**
- * Runs a series of hooks which mutate context.dispatch.
- * @see https://hooks-common.feathersjs.com/hooks.html#actondispatch
- */
-export const actOnDispatch = (...hooks: HookFunction[]) =>
- actOn('dispatch', ...hooks);
-
-function actOn(what: any, ...hooks: HookFunction[]) {
- return async (context: H) => {
- const currActOn = context.params._actOn;
- context.params._actOn = what;
-
- const newContext = await combine(...hooks)(context);
- newContext.params._actOn = currActOn;
- return newContext;
- };
-}
diff --git a/src/hooks/alter-items/alter-data.ts b/src/hooks/alter-items/alter-data.ts
index 35fdc768..0f944af1 100755
--- a/src/hooks/alter-items/alter-data.ts
+++ b/src/hooks/alter-items/alter-data.ts
@@ -1,4 +1,4 @@
-import type { HookContext } from '@feathersjs/feathers';
+import type { HookContext, NextFunction } from '@feathersjs/feathers';
import { replaceData } from '../../utils/replace-items/replace-data';
import { isPromise } from '../../common';
@@ -8,8 +8,8 @@ import { isPromise } from '../../common';
*/
export const alterData =
(cb: (record: T, context: H) => any) =>
- (context: H) =>
- replaceData(context, (item: any) => {
+ async (context: H, next?: NextFunction) => {
+ await replaceData(context, (item: any) => {
const result = cb(item, context);
if (isPromise(result)) {
@@ -18,3 +18,8 @@ export const alterData =
return result ?? item;
}
});
+
+ if (next) {
+ return next();
+ }
+ };
diff --git a/src/hooks/alter-items/alter-items.test.ts b/src/hooks/alter-items/alter-items.test.ts
deleted file mode 100755
index 6e024805..00000000
--- a/src/hooks/alter-items/alter-items.test.ts
+++ /dev/null
@@ -1,248 +0,0 @@
-import { assert } from 'vitest';
-import { alterItems } from './alter-items';
-
-let hookBefore: any;
-let hookAfter: any;
-let hookFindPaginate: any;
-let hookCreateMulti: any;
-let hookFind: any;
-
-describe('services alterItems', () => {
- beforeEach(() => {
- hookBefore = {
- type: 'before',
- method: 'create',
- params: { provider: 'rest' },
- data: { first: 'John', last: 'Doe' },
- };
- hookAfter = {
- type: 'after',
- method: 'create',
- params: { provider: 'rest' },
- result: { first: 'Jane', last: 'Doe' },
- };
- hookFindPaginate = {
- type: 'after',
- method: 'find',
- params: { provider: 'rest' },
- result: {
- total: 2,
- data: [
- { first: 'John', last: 'Doe' },
- { first: 'Jane', last: 'Doe' },
- ],
- },
- };
- hookFind = {
- type: 'after',
- method: 'find',
- params: { provider: 'rest' },
- result: [
- { first: 'John', last: 'Doe' },
- { first: 'Jane', last: 'Doe' },
- ],
- };
- hookCreateMulti = {
- type: 'before',
- method: 'create',
- params: { provider: 'rest' },
- data: [
- { first: 'John', last: 'Doe' },
- { first: 'Jane', last: 'Doe' },
- ],
- };
- });
-
- it('default func is a no-op', () => {
- // @ts-expect-error test case
- alterItems()(hookBefore);
- assert.deepEqual(hookBefore.data, { first: 'John', last: 'Doe' });
- });
-
- it('context is 2nd param', () => {
- let contextParam;
- alterItems((_rec: any, context: any) => {
- contextParam = context;
- })(hookBefore);
- assert.deepEqual(contextParam, hookBefore);
- });
-
- it('throws if 1st param is not a func', () => {
- try {
- // @ts-expect-error test case
- alterItems('no-func');
- } catch (error: any) {
- assert.equal(error.message, 'Function required. (alter)');
- return;
- }
- throw new Error('alterItems does not throw an error if 1st param is not a function');
- });
-
- it('updates hook before::create', () => {
- alterItems((rec: any) => {
- rec.state = 'UT';
- })(hookBefore);
- assert.deepEqual(hookBefore.data, { first: 'John', last: 'Doe', state: 'UT' });
- });
-
- it('updates hook before::create::multi', () => {
- alterItems((rec: any) => {
- rec.state = 'UT';
- })(hookCreateMulti);
- assert.deepEqual(hookCreateMulti.data, [
- { first: 'John', last: 'Doe', state: 'UT' },
- { first: 'Jane', last: 'Doe', state: 'UT' },
- ]);
- });
-
- it('updates hook after::find with pagination', () => {
- alterItems((rec: any) => {
- delete rec.last;
- })(hookFindPaginate);
- assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
- });
-
- it('updates hook after::find with no pagination', () => {
- alterItems((rec: any) => {
- rec.new = rec.first;
- })(hookFind);
- assert.deepEqual(hookFind.result, [
- { first: 'John', last: 'Doe', new: 'John' },
- { first: 'Jane', last: 'Doe', new: 'Jane' },
- ]);
- });
-
- it('updates hook after', () => {
- alterItems((rec: any) => {
- rec.new = rec.first;
- })(hookAfter);
- assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
- });
-
- it('updates hook before::create with new item returned', () => {
- alterItems((rec: any) => Object.assign({}, rec, { state: 'UT' }))(hookBefore);
- assert.deepEqual(hookBefore.data, { first: 'John', last: 'Doe', state: 'UT' });
- });
-
- it('updates hook after::find with pagination with new item returned', () => {
- alterItems((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', () => {
- alterItems((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' },
- ]);
- });
-
- it('updates hook after with new item returned', () => {
- alterItems((rec: any) => Object.assign({}, rec, { new: rec.first }))(hookAfter);
- assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
- });
-
- it('returns a promise that contains context', async () => {
- const promise = alterItems((rec: any) => {
- rec.state = 'UT';
- return Promise.resolve();
- })(hookBefore);
-
- assert.ok(promise instanceof Promise);
-
- const result = await promise;
-
- assert.deepEqual(result, hookBefore);
- });
-
- it('updates hook before::create with new item returned', () => {
- // @ts-ignore
- return alterItems((rec: any) => Promise.resolve(Object.assign({}, rec, { state: 'UT' })))(
- hookBefore,
- ).then(() => {
- assert.deepEqual(hookBefore.data, { first: 'John', last: 'Doe', state: 'UT' });
- });
- });
-
- it('updates hook before::create async', () => {
- const alterFunc = (rec: any) => {
- rec.state = 'UT';
- return Promise.resolve();
- };
- // @ts-ignore
- return alterItems(alterFunc)(hookBefore).then(() => {
- assert.deepEqual(hookBefore.data, { first: 'John', last: 'Doe', state: 'UT' });
- });
- });
-
- it('updates hook before::create async with new item returned', () => {
- const alterFunc = (rec: any) => Promise.resolve(Object.assign({}, rec, { state: 'UT' }));
- // @ts-ignore
- return alterItems(alterFunc)(hookBefore).then(() => {
- assert.deepEqual(hookBefore.data, { first: 'John', last: 'Doe', state: 'UT' });
- });
- });
-
- it('updates hook after::create', () => {
- return alterItems((rec: any) => {
- rec.new = rec.first;
- return Promise.resolve();
- // @ts-ignore
- })(hookAfter).then(() => {
- assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
- });
- });
-
- it('updates hook after::create with new item returned', () => {
- // @ts-ignore
- return alterItems((rec: any) => Promise.resolve(Object.assign({}, rec, { new: rec.first })))(
- hookAfter,
- ).then(() => {
- assert.deepEqual(hookAfter.result, { first: 'Jane', last: 'Doe', new: 'Jane' });
- });
- });
-
- it('updates hook after::find with pagination', () => {
- return alterItems((rec: any) => {
- delete rec.last;
- return Promise.resolve();
- // @ts-ignore
- })(hookFindPaginate).then(() => {
- assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
- });
- });
-
- it('updates hook after::find with no pagination', () => {
- return alterItems((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' },
- ]);
- });
- });
-
- it('updates hook after::find with pagination with new item returned', () => {
- // @ts-ignore
- return alterItems((rec: any) => Promise.resolve(Object.assign({}, { first: rec.first })))(
- hookFindPaginate,
- ).then(() => {
- assert.deepEqual(hookFindPaginate.result.data, [{ first: 'John' }, { first: 'Jane' }]);
- });
- });
-
- it('updates hook after::find with no pagination with new item returned', () => {
- // @ts-ignore
- return alterItems((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' },
- ]);
- });
- });
-});
diff --git a/src/hooks/alter-items/alter-items.ts b/src/hooks/alter-items/alter-items.ts
deleted file mode 100755
index 06b29cc2..00000000
--- a/src/hooks/alter-items/alter-items.ts
+++ /dev/null
@@ -1,56 +0,0 @@
-import { BadRequest } from '@feathersjs/errors';
-
-import type { HookContext } from '@feathersjs/feathers';
-import { isPromise } from '../../common';
-import { getItems, replaceItems } from '../../utils';
-
-/**
- * Make changes to data or result items. Very flexible.
- * @see https://hooks-common.feathersjs.com/hooks.html#alteritems
- *
- * @deprecated Use the explicit 'alterData' or 'alterResult' hooks instead.
- */
-export function alterItems(
- cb: (record: T, context: H) => any,
-) {
- if (!cb) {
- cb = () => {};
- }
-
- if (typeof cb !== 'function') {
- throw new BadRequest('Function required. (alter)');
- }
-
- return (context: H) => {
- let items = getItems(context);
- const isArray = Array.isArray(items);
-
- const results: any[] = (isArray ? items : [items]).map((item: any) => cb(item, context));
-
- const hasPromises = results.some((result: any) => isPromise(result));
-
- const setItem = (value: any, index: any) => {
- if (typeof value === 'object' && value !== null) {
- if (isArray) {
- items[index] = value;
- } else {
- items = value;
- }
- }
- };
-
- if (hasPromises) {
- return Promise.all(results).then(values => {
- values.forEach(setItem);
-
- replaceItems(context, items);
- return context;
- });
- } else {
- results.forEach(setItem);
-
- replaceItems(context, items);
- return context;
- }
- };
-}
diff --git a/src/hooks/cache/cache.ts b/src/hooks/cache/cache.ts
index c9b56055..8b895735 100755
--- a/src/hooks/cache/cache.ts
+++ b/src/hooks/cache/cache.ts
@@ -12,6 +12,8 @@ export interface CacheOptions {
const defaultMakeCacheKey = (key: any) => key;
/**
+ * TODO: rm 'getItems' & migrate to around hook
+ *
* Persistent, most-recently-used record cache for services.
*
* @see https://hooks-common.feathersjs.com/hooks.html#cache
diff --git a/src/hooks/check-required/check-required.ts b/src/hooks/check-required/check-required.ts
index 0e61d286..60f4aeb3 100755
--- a/src/hooks/check-required/check-required.ts
+++ b/src/hooks/check-required/check-required.ts
@@ -3,7 +3,7 @@ import _has from 'lodash/has.js';
import { BadRequest } from '@feathersjs/errors';
import { checkContext, getDataIsArray } from '../../utils';
-import type { HookContext } from '@feathersjs/feathers';
+import type { HookContext, NextFunction } from '@feathersjs/feathers';
import { MaybeArray, toArray } from '../../internal.utils';
/**
@@ -12,8 +12,8 @@ import { MaybeArray, toArray } from '../../internal.utils';
*/
export function checkRequired(fieldNames: MaybeArray
