Skip to content

Latest commit

 

History

History
executable file
·
356 lines (258 loc) · 10.6 KB

README.md

File metadata and controls

executable file
·
356 lines (258 loc) · 10.6 KB
Raw

feathers-hooks-common

Useful hooks for use with Feathersjs services.

The next version of feathers-hooks (1.6.0) will export feathers-hooks-common instead of the previous bundled hooks. This will provide backward compatibility. Feathers-hooks in Feathers 3.0 will become part of core and you will have to import feathers-hooks-common separately.

dr;tl Start using feathers-hooks-common now.

Build Status Code Climate Coverage Status Dependency Status Download Status Slack Status

Code Examples

Data Items

(1) Join a related item to result (after hook).

  • Supports multiple result items, including paginated find.
  • Supports key field with an array of keys.
  • Supports multiple joins.
const hooks = require('feathers-hooks-common');
module.exports.after = {
  // add prop 'user' containing the user item who's key is in 'senderId'.
  all: [ hooks.populate('user', { field: 'senderId', service: '/users' }) ]
};

(2) Remove fields from data.

  • Field names support dot notation e.g. 'name.address.city'
  • Supports multiple data items, including paginated find.
  • May be dynamically disabled, using either a sync or Promise based function.
module.exports.after = {
  all: [ hooks.remove('verifyToken', 'verifyExpires', (hook) => true) ]
};

(3) Retain only selected fields in data.

  • Field names support dot notation
  • Supports multiple data items, including paginated find.
  • May be dynamically disabled, using either a sync or Promise based function.
module.exports.after = {
  all: [ hooks.pluck('employee.name', 'employee.email',
           (hook) => new Promise(resolve => setTimeout(() => resolve(true), 100)) ]
};

(4) Convert fields to lower case.

  • Field names support dot notation
  • Supports multiple data items, including paginated find.
  • May be dynamically disabled, using either a sync or Promise based function.
module.exports.after = {
  all: [ hooks.lowerCase('email') ]
};

(5) Add created at timestamp.

  • Field names support dot notation
  • Supports multiple data items, including paginated find.
  • May be dynamically disabled, using either a sync or Promise based function.
module.exports.before = {
  create: [ hooks.setCreatedAt('createdAt') ]
};

(6) Add or update the updated at timestamp.

  • Field names support dot notation
  • Supports multiple data items, including paginated find.
  • May be dynamically disabled, using either a sync or Promise based function.
module.exports.before = {
  create: [ hooks.setUpdatedAt('updatedAt') ]
};

Query Params

(1) Remove criteria from query (before hook).

  • Field names support dot notation
  • Supports multiple data items, including paginated find.
  • May be dynamically disabled, using either a sync or Promise based function.
module.exports.before = {
  all: [ hooks.removeQuery('sex') ]
};

(2) Retain only selected criteria in query (before hook).

  • Field names support dot notation.
  • Supports multiple data items, including paginated find.
  • May be dynamically disabled, using either a sync or Promise based function.
module.exports.before = {
  all: [ hooks.pluckQuery('employee.dept') ]
};

Authorization

(1) Disable hook

  • Disable service completely, from all external providers, or from certain providers.
  • Service be dynamically disabled, using either a sync or Promise based function.
module.exports.before = {
  patch: [ hooks.disable('socketio', 'rest') ],
  create: [ hooks.disable((hook) => new Promise(resolve => resolve(true) )) ]
};

(2) Authorize access by role. Convenience wrapper for feathers-authentication.hooks.restrictToRoles.

DEPRECATED. Use hooks provided by feathers-authentication v2.

  • Clean, clear and DRY.
const authorizer = hooks.restrictToRoles(['inv', 'ship'], 'userAuthorizedRoles', false, 'userId');

module.exports.before = {
  all: [ authorizer() ]
  create: [ authorizer(['purch']) ]
};

Database

(1) Mark items as deleted rather than removing them from the database. (ALPHA)

export.before = {
  remove: [ softDelete() ], // update item flagging it as deleted
  find: [ softDelete() ] // ignore deleted items
};

Utilities

(1) Normalize the URL slug (before).

Copy the slug from raw HTTP requests, e.g. https://.../stores/:storeid/... to where other providers typically store it. Dot notation is supported.

module.exports.before = {
  create: [ hooks.setSlug('storeid') ]
};

(2) Display current info about the hook to console.

module.exports.after = {
  create: [ hooks.debug('step 1') ]
};
//step 1
// type: before, method: create
// data: { name: 'Joe Doe' }
// query: { sex: 'm' }
// result: { assigned: true }

Utilities to wrap functions

(3) Wrap a function calling a callback into one that returns a Promise.

  • Promise is rejected if the function throws.
import { callbackToPromise } from 'feathers-hooks-common/promisify';

function tester(data, a, b, cb) {
  if (data === 3) { throw new Error('error thrown'); }
  cb(data === 1 ? null : 'bad', data);
} 
const wrappedTester = callbackToPromise(tester, 3); // because func call requires 3 params

wrappedTester(1, 2, 3); // tester(1, 2, 3, wrapperCb)
wrappedTester(1, 2); // tester(1, 2, undefined, wrapperCb)
wrappedTester(); // tester(undefined, undefined undefined, wrapperCb)
wrappedTester(1, 2, 3, 4, 5); // tester(1, 2, 3, wrapperCb)

wrappedTester(1, 2, 3).then( ... )
  .catch(err => { console.log(err instanceof Error ? err.message : err); });

You may specify the number of params in the function signature, this count does not include the callback param itself. The wrapped function will always be called with that many params, preventing potential bugs.

Running hooks conditionally

There are times when you may want to run a hook conditionally, perhaps depending on the provider, the user authorization, if the user created the record, etc.

A custom service may be designed to always be called with the create method, with a data value specifying the action the service is to perform. Certain actions may require authentication or authorization, while others do not.

(1) Conditionally run a hook (before, after).

Run a predicate function, which returns either a boolean, or a Promise which evaluates to a boolean. Run the hook if the result is truesy.

// sync predicate and hook
const isNotAdmin = adminRole => hook => hook.params.user.roles.indexOf(adminRole || 'admin') === -1;
hooks.iff(isNotAdmin(), hooks.remove('securityKey'))
);
// async predicate and hook
hooks.iff(
  () => new Promise((resolve, reject) => { ... }),
  hooks.populate('user', { field: 'senderId', service: '/users' })
);

(2) isProvider: predicate to check which provider called the service method.

import hooks, { iff, isProvider } from 'feathers-hooks-common';
iff(isProvider('external'), hooks.remove( ... )) // also external, socketio, rest, primus

(3) isNot: negates a sync or async predicate.

import hooks, { iff, isNot, isProvider } from 'feathers-hooks-common';
iff(isNot(isProvider('server')), hooks.remove( ... )) // also external, socketio, rest, primus

Utilities for Writing Hooks

These utilities may be useful when you are writing your own hooks. You can import them from feathers-hooks-common/lib/utils.

(1) Get and replace the items in the hook.

  • Handles before and after types.
  • Handles paginated and non-paginated results from find.
import { getItems, replaceItems } from 'feathers-hooks-common/lib/utils';
export.before = { create: [ (hook) => {
  ...
  const items = getItems(hook);
  Array.isArray(items) ? items[0].code = 'a' : items.code = 'a';
  replaceItems(hook, items);
  ...
}]};

(2) Throw if a hook is used wrongly.

import { checkContext } from 'feathers-hooks-common/lib/utils';
function myHook(hook) {
  checkContext(hook, 'before', ['create', 'remove']);
  ...
}
export.after = { create: [ myHook ]}; // throws

(3) Support dot notation in field access.

  • Optionally deletes properties in object.
import { getByDot, setByDot } from 'feathers-hooks-common/lib/utils';
export.before = { create: [ (hook) => {
  ...
  const city = getByDot(hook.data, 'person.address.city');
  setByDot(hook, 'data.person.address.city', 'London');
  ...
}]};

Motivation

Feathers services can be developed faster if the hooks you need are at hand.

This package provides some commonly needed hooks.

Installation

Install Nodejs.

Run npm install feathers-hooks-common --save in your project folder.

/src on GitHub contains the ES6 source. It will run on Node 6+ without transpiling.

API Reference

Each file in /src fully documents its exports.

See also the Featherjs docs.

Tests

npm test to run tests.

npm run cover to run tests plus coverage.

Contributing

Contribute to this repo.

Guide to ideomatic contributing.

Change Log

List of notable changes.

License

MIT. See LICENSE.