@domain-group/fe-co-auth-ui-core NPM

fe-co-auth-ui-core

Domani auth ui core components and helpers

Usage

yarn add @domain-group/fe-co-auth-ui-core

For more details, see src/js/auth-ui-core.js

Code Architecture

The repo was generated using fe-boilerplate-generator but uses typescript to generate the javascript bits. To understand the API architechture go to docs.

Typescript

All javascript source files inside the src folder (fixtures,js and style) are generated from src-ts folder. So basically the source is divided into two folders src and src-ts.

Changes and history

See CHANGELOG.md.

Props

The component takes the following props besides the base props

PropName	Type	Default	Description
customLayout	function?	undefined	Custom layout to override the system layout.
customScreens	object?	{}	Custom screens overriding the system screens.
additionalScreens	object?	{}	Additional screens to auth ui.
customComponents	object?	{}	Custom components overriding the system components.
events	object?	{}	Hook onto system events and provide event handlers.

Get an Overview of the system.

How to extend this package for my brand?

Read here to extend this package. fe-co-auth-ui-domain can also be used as a reference.

To run locally, run the following commands sequentially

yarn : Install all package dependencies.
yarn watch:ts : Runs the typescript transpiler in watch mode.

After the above command does the first transpilation and starts watching file for changes, run the next command.

yarn start : Runs the normal fe-build command on watch mode.

This also runs the lint:fix to fix any linting issues caused during typescript -> javascript transpilation.

Publishing to NPM

Same as for any other fe-co-* component. See the docs on releasing a component in the docs repo

Few things to keep in mind

NPM Publish must be done from a linux machine. Fe build does not support windows. It may look like its working but its actually not. So if you are on windows, do it from WSL.
You will need a valid aws cli session to domain production, as it involves saving fe-dora demo bundles and assets to S3 buckets. So something like saml2aws login --profile fe-build. Check the default region is correct as well.

Testing changes to core via a team component

You may need to test changes in fe-co-auth-ui-core via a team component for example via fe-co-auth-ui-domain. To facilitate this process, use below tips

You can test the changes locally without having to publish a new fe-co-auth-ui-core npm package which can be time consuming. To do this, you need to link fe-co-auth-ui-core code on your box from the team component code. Use yarn link functionality to achieve this. Check https://yarnpkg.com/lang/en/docs/cli/link Please note to use yarn build:module before linking so that lib folder is available.
If for some reason, you need to or want to check a published version, you don't have to merge your changes to master to publish it. You may rather set the version as beta (e.g. 1.1.4-beta) and publish from a branch by specifying --any-branch option when publishing the package. You can then install the beta version in the team component to test it.