dogstack-agents

dogstack plugin to provide core user functionality

• agents (people, groups, or bots)
• credentials
• profiles
• TODO relationships
• authentication
• authorization

example

for an example using dogstack-agents, see dogstack-example

install

npm install --save dogstack-agents

post{,un}install script

after install, this module should link migrations in ./db/migrations to your app migrations in the same relative directory.

after uninstall, this module should unlink these linked migrations.

usage

{ config, service, actions, updater, epic, ...getters, ...components, ...hoc, ...hooks } = require('dogstack-agents')

config

default config to merge in with config/default.js.

service

feathers service to plug in to dogstack server.js

combines

• ./agents/service.js
• ./credentials/service.js
• ./profiles/service.js
• ./authentication/service.js

actions

redux actions creators

exports { agents, credentials, authentication } action creators from

• ./agents/index.js actions from feathers-action
• ./credentials/index.js actions from feathers-action
• ./profiles/index.js actions from feathers-action
• ./authentication/actions.js

updater

redux-fp updater

concats

• ./agents/index.js updater from feathers-action
• ./credentials/index.js updater from feathers-action
• ./profiles/index.js updater from feathers-action
• ./authentication/updater.js

epic

redux-observable epic

combines

• ./agents/index.js epic from feathers-action
• ./credentials/index.js epic from feathers-action
• ./profiles/index.js epic from feathers-action
• ./authentication/epic.js

getters

reselect getters (selectors)

exports the following getters

• getAgents
• getCurrentAgent
• getCredentials
• getCredentialByAgent
• getProfiles
• getProfileByAgent
• getAuthentication
• getAuthenticationConfig
• getCredentialId
• getAccessToken
• getSigningIn
• getIsAuthenticated
• getIsNotAuthenticated
• getRegisterError
• getRegisterProps
• getSignInError
• getSignInProps

components

TODO React components to use in your app

exports the following components

• Register
• SignIn
• LogOut

hoc

higher-order React components to use in your app

exports the following higher-order components:

• UserIsAuthenticated
• UserIsNotAuthenticated

hooks

feathers service hooks

exports the following hooks

• addCurrentAgent
• addCurrentProfile

license

The Apache License

Copyright © 2017 Michael Williams

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.