@dataquiver/cognito-middleware
v3.0.0
Published
Middleware for DQ
Downloads
112
Keywords
Readme
cognito-middleware
This contains the middlewares for our client socket and http connections.
See CHANGELOG.md for recent changes.
Table of Contents
Required Technologies
- Node / NPM: Node version 12 or greater is recommended.
Installation
To install, run:
npm install @dataquiver/cognito-middleware --save
Useage
The intent of this package is to make using a middleware which will add the cognito user to your request easy.
- While all classes are exported individually in this package, the easiest way to use this package is through the getMiddlewares function.
const { websocketMiddleware, expressMiddleware } = await getMiddlewares({
cognitoPoolRegion: 'TODO',
cognitoPoolId: 'TODO' ,
cognitoClientId: 'TODO',
cognitoIdentityServiceProvider,
db,
portalApi,
isPortalApi: false
});
The db
, portalApi
, and isPortalApi
parameters are only used when you are using this class on the server which manages users.
returns { websocketMiddleware, expressMiddleware }
Contributing
- Clone this repo
- Run
npm install
to download dependencies - Run
npm run build
to compile typescript into javascript for distribution - Run
npm run lint
to run lint checks. This is also in a pre-commit hook.
Testing
We're using jest to write tests for core functionality. To run tests, run npm test
.
You can also use jest in watch mode with npm run test:watch
. This will monitor your files and rerun the
tests when the code changes
Publishing
- Update
CHANGELOG.md
with important changes for the new version - Bump the version in
package.json
- Run
npm run prepublish
- Run
npm publish
to publish to npm. You'll need to be authorized.
Testing in an app
- In this repo, run
npm link
to register it for overriding - In the app, run
npm link @dataquiver/cognito-middleware
to override the package from NPM with a symlink to this local copy - Run your app
If you make changes, you'll need to run npm run build
in this repo and likely restart your app to pick them up.
When you're done, in the app, run npm unlink @dataquiver/cognito-middleware --no-save
to remove the symlink and go back to using the NPM package. Use npm install
then to
redownload from the internet.
Logging
This package supports logging. Call setLoggerFactory
with a winston-compatible logger.