Auth and User services for Angular v2 and up
This library requires a server side component to perform the authentication. The one we using is located here and it uses keycloak. You can see how it is used in the front-end here.
The system we build is composed of several components existing in separate repos but still needing access to common information, like who is logged. These services were extracted to provide a shared set of services.
This library does not run on it's own. It must be imported.
npm install ngx-login-client
There are several services and a couple of models used by them available.
AuthenticationService
BroadcasterService
UserService
User
Profile
LoggerService
You must provide the URL to API to do the login. To do this, you must provide
a string with an OpaqueToken AUTH_API_URL from ngx-login-client. We suggest using a
factory provider for this. For example:
import { ApiLocatorService } from './api-locator.service';
import { AUTH_API_URL } from 'ngx-login-client';
let authApiUrlFactory = (api: ApiLocatorService) => {
return api.witApiUrl;
};
export let authApiUrlProvider = {
provide: AUTH_API_URL,
useFactory: authApiUrlFactory,
deps: [ApiLocatorService]
};
NOTE: ApiLocatorService is a service that we use to construct API URLs using patterns determined
by our application architecture, you can implement this part however you like.
Finally you need to register authApiUrlProvider with a module or a component.
npm install
npm run reinstall
npm test
npm run build
To build ngx-login-client as a npm library, use:
Whilst the standalone build uses webpack the library build uses gulp.
The created library is located in dist. You shouldn't ever publish the
build manually, instead you should let the CD pipeline do a semantic release.
To build ngx-login-client as an npm library and embed it into a webapp such as fabric8-ui, you should:
- Run
npm run watch:libraryin this directory. This will build ngx-login-client as a library and then set up a watch task to rebuild any ts, html and scss files you change. - In the webapp into which you are embedding, run
npm link <path to ngx-login-client>/dist-watch. This will create a symlink fromnode_modules/ngx-login-clientto thedist-watchdirectory and install that symlinked node module into your webapp. - Run your webapp in development mode, making sure you have a watch on
node_modules/ngx-login-clientenabled. To do this using a typical Angular Webpack setup, such as the one based on Angular Class, just run `npm start. You will have access to both JS sourcemaps and SASS sourcemaps if your webapp is properly setup.
Note that fabric8-ui is setup to do reloading and sourcemaps automatically when you
run npm start.
In ngx-login-client we use the semantic-release plugin. That means that all you have to do is use the AngularJS Commit Message Conventions (documented below). Once the PR is merged, a new release will be automatically published to npmjs.com and a release tag created on github. The version will be updated following semantic versionning rules.
A commit message consists of a header, body and footer. The header has a type, scope and subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
If the prefix is feat, fix or perf, it will always appear in the changelog.
Other prefixes are up to your discretion. Suggested prefixes are docs, chore, style, refactor, and test for non-changelog related tasks.
The scope could be anything specifying place of the commit change. For example $location,
$browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
A detailed explanation can be found in this document.
Based on https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit
Appears under "Features" header, pencil subheader:
feat(pencil): add 'graphiteWidth' option
Appears under "Bug Fixes" header, graphite subheader, with a link to issue #28:
fix(graphite): stop graphite breaking when width < 0.1
Closes #28
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
perf(pencil): remove graphiteWidth option
BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
The following commit and commit 667ecc1 do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Commitizen helps you craft correct commit messages. Install it using npm install commitizen -g. Then run git cz rather than git commit.
The validate-commit-msg githook checks for invalid commit messages.