Feathers is a full-stack framework for creating web APIs and real-time applications with TypeScript or JavaScript.

Feathers can interact with any backend technology, supports many databases out of the box and works with any frontend like React, VueJS, Angular, React Native, Android or iOS.

Getting started

Get started with just three commands:

$ npm create feathers my-new-app
$ cd my-new-app
$ npm run dev

To learn more about Feathers visit the website at feathersjs.com or jump right into the Feathers guides.

Contributing

To start developing, clone this repository, then run:

cd feathers
npm install

To run all tests run

npm test

Individual tests can be run in the module you are working on:

cd packages/feathers
npm test

License

Copyright (c) 2024 Feathers contributors

Licensed under the MIT license.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.34 (2025-05-03)

Bug Fixes

• Update dependencies (#3584) (119fa4e)

5.0.33 (2025-02-24)

Bug Fixes

• dependencies: Update dependencies (#3571) (ad611cb)

5.0.32 (2025-02-01)

Note: Version bump only for package @feathersjs/authentication-local

5.0.31 (2024-10-31)

Bug Fixes

• dependencies: Update all dependencies (#3545) (221b92b)

5.0.30 (2024-09-02)

Note: Version bump only for package @feathersjs/authentication-local

5.0.29 (2024-07-10)

Note: Version bump only for package @feathersjs/authentication-local

5.0.28 (2024-07-10)

Note: Version bump only for package @feathersjs/authentication-local

5.0.27 (2024-06-18)

Note: Version bump only for package @feathersjs/authentication-local

5.0.26 (2024-06-09)

Note: Version bump only for package @feathersjs/authentication-local

5.0.25 (2024-05-03)

Bug Fixes

• Reduce usage of lodash (#3455) (8ce807a)

5.0.24 (2024-03-13)

Note: Version bump only for package @feathersjs/authentication-local

5.0.23 (2024-02-25)

Bug Fixes

• core: Update to latest feathersjs/hooks (#3434) (1499ccc)

5.0.22 (2024-02-15)

Note: Version bump only for package @feathersjs/authentication-local

5.0.21 (2024-01-25)

Note: Version bump only for package @feathersjs/authentication-local

5.0.20 (2024-01-24)

Note: Version bump only for package @feathersjs/authentication-local

5.0.19 (2024-01-23)

Note: Version bump only for package @feathersjs/authentication-local

5.0.18 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-local

5.0.17 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-local

5.0.16 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-local

5.0.15 (2024-01-22)

Note: Version bump only for package @feathersjs/authentication-local

5.0.14 (2024-01-05)

Note: Version bump only for package @feathersjs/authentication-local

5.0.13 (2023-12-29)

Note: Version bump only for package @feathersjs/authentication-local

5.0.12 (2023-11-28)

Note: Version bump only for package @feathersjs/authentication-local

5.0.11 (2023-10-11)

Bug Fixes

• knex: Update all dependencies and Knex peer (#3308) (d2f9860)

5.0.10 (2023-10-03)

Note: Version bump only for package @feathersjs/authentication-local

5.0.9 (2023-09-27)

Note: Version bump only for package @feathersjs/authentication-local

5.0.8 (2023-07-19)

Note: Version bump only for package @feathersjs/authentication-local

5.0.7 (2023-07-14)

Note: Version bump only for package @feathersjs/authentication-local

5.0.6 (2023-06-15)

Bug Fixes

• authentication-local: Local Auth - Nested username & Password fields (#3091) (d135526)

5.0.5 (2023-04-28)

Note: Version bump only for package @feathersjs/authentication-local

5.0.4 (2023-04-12)

Bug Fixes

• Make sure all Readme files are up to date (#3154) (a5f0b38)

5.0.3 (2023-04-05)

Bug Fixes

• dependencies: Update all dependencies (#3139) (f24276e)

5.0.1 (2023-03-15)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0 (2023-02-24)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.38 (2023-02-17)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.37 (2023-02-09)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.36 (2023-01-29)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.35 (2023-01-12)

Features

• generators: Move core code generators to shared generators package (#2982) (0328d22)

5.0.0-pre.34 (2022-12-14)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.33 (2022-11-08)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.32 (2022-10-26)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.31 (2022-10-12)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.30 (2022-10-07)

Features

• core: Allow to unregister services at runtime (#2756) (d16601f)

5.0.0-pre.29 (2022-09-16)

Features

• authentication-oauth: Koa and transport independent oAuth authentication (#2737) (9231525)

5.0.0-pre.28 (2022-08-03)

Bug Fixes

• cli: Improve generated application and client (#2701) (bd55ffb)

5.0.0-pre.27 (2022-07-13)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.26 (2022-06-22)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.25 (2022-06-22)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.24 (2022-06-21)

Features

• authentication-local: Add passwordHash property resolver (#2660) (b41279b)

5.0.0-pre.23 (2022-06-06)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.22 (2022-05-24)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.21 (2022-05-23)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.20 (2022-05-04)

Bug Fixes

• dependencies: Lock monorepo package version numbers (#2623) (5640c10)

5.0.0-pre.19 (2022-05-01)

Features

• typescript: Improve adapter typings (#2605) (3b2ca0a)

5.0.0-pre.18 (2022-04-11)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.17 (2022-02-15)

Bug Fixes

• hooks: Allow all built-in hooks to be used the async and regular way (#2559) (8f9f631)

5.0.0-pre.16 (2022-01-12)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.15 (2021-11-27)

Bug Fixes

• typescript: Overall typing improvements (#2478) (b8eb804)

5.0.0-pre.14 (2021-10-13)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.13 (2021-10-13)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.12 (2021-10-12)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.11 (2021-10-06)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.10 (2021-09-19)

Bug Fixes

• authentication-local: adds error handling for undefined/null password field (#2444) (4323f98)

5.0.0-pre.9 (2021-08-09)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.8 (2021-08-09)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.7 (2021-08-09)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.6 (2021-08-08)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.5 (2021-06-23)

Bug Fixes

• hooks: Migrate built-in hooks and allow backwards compatibility (#2358) (759c5a1)
• koa: Use extended query parser for compatibility (#2397) (b2944ba)

Features

• adapter-commons: Add support for params.adapter option and move memory adapter to @feathersjs/memory (#2367) (a43e7da)

5.0.0-pre.4 (2021-05-13)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.3 (2021-04-21)

Bug Fixes

• typescript: Improve TypeScript backwards compatibility (#2310) (f33be73)

Features

• dependencies: Remove direct debug dependency (#2296) (501d416)

5.0.0-pre.2 (2021-04-06)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-beta.1 (2021-04-03)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-beta.0 (2021-03-28)

Bug Fixes

• Update Grant usage and other dependencies (#2264) (7b0f8fa)

Features

• Feathers v5 core refactoring and features (#2255) (2dafb7c)

5.0.0-pre.1 (2020-12-17)

5.0.0-pre.0 (2020-05-19)

Note: Version bump only for package @feathersjs/authentication-local

5.0.0-pre.0 (2020-05-19)

Note: Version bump only for package @feathersjs/authentication-local

4.5.8 (2020-08-12)

Note: Version bump only for package @feathersjs/authentication-local

4.5.7 (2020-07-24)

Bug Fixes

• authentication: Add JWT getEntityQuery (#2013) (e0e7fb5)

4.5.6 (2020-07-12)

Note: Version bump only for package @feathersjs/authentication-local

4.5.5 (2020-07-11)

Note: Version bump only for package @feathersjs/authentication-local

4.5.4 (2020-04-29)

Bug Fixes

• authentication-local: Allow to hash passwords in array data (#1936) (64705f5)

4.5.3 (2020-04-17)

Note: Version bump only for package @feathersjs/authentication-local

4.5.2 (2020-03-04)

Bug Fixes

• test: typo in password (#1797) (dfba6ec)

4.5.1 (2020-01-24)

Note: Version bump only for package @feathersjs/authentication-local

4.5.0 (2020-01-18)

Note: Version bump only for package @feathersjs/authentication-local

4.4.3 (2019-12-06)

Note: Version bump only for package @feathersjs/authentication-local

4.4.1 (2019-11-27)

Note: Version bump only for package @feathersjs/authentication-local

4.4.0 (2019-11-27)

Features

• authentication: Add parseStrategies to allow separate strategies for creating JWTs and parsing headers (#1708) (5e65629)

4.3.11 (2019-11-11)

Note: Version bump only for package @feathersjs/authentication-local

4.3.10 (2019-10-26)

Note: Version bump only for package @feathersjs/authentication-local

4.3.9 (2019-10-26)

Note: Version bump only for package @feathersjs/authentication-local

4.3.7 (2019-10-14)

Note: Version bump only for package @feathersjs/authentication-local

4.3.5 (2019-10-07)

Note: Version bump only for package @feathersjs/authentication-local

4.3.4 (2019-10-03)

Note: Version bump only for package @feathersjs/authentication-local

4.3.3 (2019-09-21)

Bug Fixes

• Small improvements in dependencies and code sturcture (#1562) (42c13e2)

4.3.2 (2019-09-16)

Bug Fixes

• LocalStrategy authenticates without username (#1560) (2b258fd), closes #1559

4.3.1 (2019-09-09)

Note: Version bump only for package @feathersjs/authentication-local

4.3.0 (2019-08-27)

Note: Version bump only for package @feathersjs/authentication-local

4.3.0-pre.4 (2019-08-22)

Note: Version bump only for package @feathersjs/authentication-local

4.3.0-pre.3 (2019-08-19)

Bug Fixes

• Update all dependencies (7d53a00)

4.3.0-pre.2 (2019-08-02)

Bug Fixes

• Add method to reliably get default authentication service (#1470) (e542cb3)

4.3.0-pre.1 (2019-07-11)

Note: Version bump only for package @feathersjs/authentication-local

4.0.0-pre.5 (2019-07-10)

Note: Version bump only for package @feathersjs/authentication-local

4.0.0-pre.4 (2019-07-05)

Note: Version bump only for package @feathersjs/authentication-local

4.0.0-pre.3 (2019-06-01)

Bug Fixes

• Update dependencies and fix tests (#1373) (d743a7f)

4.0.0-pre.2 (2019-05-15)

Note: Version bump only for package @feathersjs/authentication-local

4.0.0-pre.1 (2019-05-08)

Bug Fixes

• Always require strategy parameter in authentication (#1327) (d4a8021)
• Improve authentication parameter handling (#1333) (6e77204)
• Merge httpStrategies and authStrategies option (#1308) (afa4d55)
• Rename jwtStrategies option to authStrategies (#1305) (4aee151)

Features

• Change and *JWT methods to *accessToken (#1304) (5ac826b)

4.0.0-pre.0 (2019-04-21)

Bug Fixes

• Authentication core improvements (#1260) (c5dc7a2)
• Make Mocha a proper devDependency for every repository (#1053) (9974803)
• Update adapter common tests (#1135) (8166dda)
• Update all dependencies to latest (#1206) (e51e0f6)
• package: update debug to version 3.0.0 (#31) (f23d617)

Features

• @feathersjs/authentication-oauth (#1299) (656bae7)
• Add AuthenticationBaseStrategy and make authentication option handling more explicit (#1284) (2667d92)
• Add TypeScript definitions (#1275) (9dd6713)
• Authentication v3 core server implementation (#1205) (1bd7591)
• Authentication v3 local authentication (#1211) (0fa5f7c)

BREAKING CHANGES

• Update authentication strategies for @feathersjs/authentication v3

1.2.9 (2019-01-02)

Bug Fixes

• Update adapter common tests (#1135) (8166dda)

1.2.8 (2018-12-16)

Note: Version bump only for package @feathersjs/authentication-local

1.2.7 (2018-10-26)

Note: Version bump only for package @feathersjs/authentication-local

1.2.6 (2018-10-25)

Bug Fixes

• Make Mocha a proper devDependency for every repository (#1053) (9974803)

1.2.5 (2018-09-21)

Note: Version bump only for package @feathersjs/authentication-local

1.2.4 (2018-09-17)

Note: Version bump only for package @feathersjs/authentication-local

1.2.3 (2018-09-02)

Note: Version bump only for package @feathersjs/authentication-local

1.2.2

• Migrate to Monorepo (feathers#462)

v1.2.1 (2018-05-02)

Full Changelog

Merged pull requests:

• Make sure the original object is not modified #65 (daffl)

v1.2.0 (2018-05-02)

Full Changelog

Merged pull requests:

• added support for nested password fields option in hash password hook #64 (ThePesta)

v1.1.3 (2018-04-20)

Full Changelog

Merged pull requests:

• Adding tests and calling to hasOwnProperty on Object.prototype instead of assuming valid prototype #63 (pmabres)

v1.1.2 (2018-04-15)

Full Changelog

Closed issues:

• Protect hooks does not support dot notation #61

Merged pull requests:

• Use latest version of Lodash #62 (daffl)

v1.1.1 (2018-03-25)

Full Changelog

Closed issues:

• hash-password hook will skip users if they are missing password #58
• User service create method gets called upon each validation #56

Merged pull requests:

• Do not skip users that have no password #60 (daffl)
• Update sinon to the latest version 🚀 #59 (greenkeeper[bot])
• Update sinon-chai to the latest version 🚀 #57 (greenkeeper[bot])

v1.1.0 (2018-01-23)

Full Changelog

Closed issues:

• protect hook attempts to map through 'result.data' on all service methods. #53
• Protect hook should check for toJSON #48

Merged pull requests:

• Use .toJSON if available #55 (daffl)
• Only map data for find method #54 (daffl)
• Update @feathersjs/authentication-jwt to the latest version 🚀 #52 (greenkeeper[bot])
• Update mocha to the latest version 🚀 #51 (greenkeeper[bot])

v1.0.4 (2018-01-03)

Full Changelog

v1.0.3 (2018-01-03)

Full Changelog

Closed issues:

• local authentication bug with users as sequelize service #47

Merged pull requests:

• Update documentation to correspond with latest release #50 (daffl)
• Update semistandard to the latest version 🚀 #49 (greenkeeper[bot])

v1.0.2 (2017-12-06)

Full Changelog

Closed issues:

• why is the password send as plain text instead of encrypting it on client side? #44

Merged pull requests:

• Update hook.result if an external provider is set #46 (daffl)
• Update feathers-memory to the latest version 🚀 #45 (greenkeeper[bot])

v1.0.1 (2017-11-16)

Full Changelog

Merged pull requests:

• Add default export for better ES module (TypeScript) compatibility #43 (daffl)
• Update @feathersjs/authentication to the latest version 🚀 #42 (greenkeeper[bot])

v1.0.0 (2017-11-01)

Full Changelog

Merged pull requests:

• Update dependencies for release #41 (daffl)

v1.0.0-pre.2 (2017-10-27)

Full Changelog

Merged pull requests:

• Safely dispatch without password #40 (daffl)

v1.0.0-pre.1 (2017-10-25)

Full Changelog

Closed issues:

• How configure local strategy to feathers-authentication? #36
• An in-range update of feathers is breaking the build 🚨 #32

Merged pull requests:

• Update to Feathers v3 #39 (daffl)
• Rename repository and use npm scope #38 (daffl)
• Update to new plugin infrastructure #37 (daffl)
• Update mocha to the latest version 🚀 #35 (greenkeeper[bot])
• Update sinon to the latest version 🚀 #34 (greenkeeper[bot])
• Add babel-polyfill and package-lock.json #33 (daffl)
• Update sinon to the latest version 🚀 #29 (greenkeeper[bot])

v0.4.4 (2017-08-11)

Full Changelog

Closed issues:

• i18n support #28
• Couldn't store jwt token in cookies #17
• Strategy for subapp #9

Merged pull requests:

• Update debug to the latest version 🚀 #31 (greenkeeper[bot])
• Increase bcrypt cost factor, add future cost factor auto-optimization #30 (micaksica2)

v0.4.3 (2017-06-22)

Full Changelog

Closed issues:

• Log a warning if service.id is undefined or null #19

Merged pull requests:

• throw error if service.id is missing #27 (marshallswain)

v0.4.2 (2017-06-22)

Full Changelog

v0.4.1 (2017-06-22)

Full Changelog

Merged pull requests:

• Resolves #14 - Passes Feathers params to service hooks #15 (thomas-p-wilson)

v0.4.0 (2017-06-22)

Full Changelog

Closed issues:

• Module is using the wrong default config key #21
• Feathers params not available to user service hooks #14
• Bad error message is returned for invalid credentials #10

Merged pull requests:

• Greenkeeper/chai 4.0.2 #26 (daffl)
• Return Invalid login message when user doesn’t exist #25 (marshallswain)
• Adding separate entity username and password fields #23 (adamvr)
• use the correct default config key. Closes #21 #22 (ekryski)
• Update feathers-socketio to the latest version 🚀 #20 (greenkeeper[bot])
• Update semistandard to the latest version 🚀 #18 (greenkeeper[bot])
• Update feathers-hooks to the latest version 🚀 #16 (greenkeeper[bot])
• Update dependencies to enable Greenkeeper 🌴 #13 (greenkeeper[bot])

v0.3.4 (2017-03-28)

Full Changelog

Closed issues:

• Shouldn't it be authentication instead of the old auth there? #11

Merged pull requests:

• Fix default authentication config name #12 (marshallswain)

v0.3.3 (2017-01-27)

Full Changelog

Closed issues:

• Support dot notation #7
• Automatically register the authenticate hook with 'local' #4

Merged pull requests:

• Add support for dot notation, fix some whitespace #8 (elfey)

v0.3.2 (2016-12-14)

Full Changelog

v0.3.1 (2016-12-14)

Full Changelog

Closed issues:

• Add docs section on expected request params. #5

Merged pull requests:

• Document expected request data #6 (marshallswain)

v0.3.0 (2016-11-23)

Full Changelog

Closed issues:

• Doesn't pull configuration from auth.local by default #2
• Does not pull from global auth config when strategy has a custom name #1

Merged pull requests:

• Payload support #3 (ekryski)

v0.2.0 (2016-11-16)

Full Changelog

v0.1.0 (2016-11-09)

* This Change Log was automatically generated by [githubchangelog_generator](https://github.com/skywinder/Github-Changelog-Generator)_