@nmp-trust/all v1.9.7

nmp-trust web components

Central components that talk with the nmp-trust backend service. Example application: https://trust-demo.finn.no

NB: You need to log into schibsted vpn (appgate) to access the application.

Using the package - setup

Install

npm i @nmp-trust/all

Note: you need to have a daily user token that your server needs to ask the nmp-trust server for before you can use any of the components that view or post data that are behind login

Wrap your application with the settings component and import the web components. The import will make the components available for the rest of the code base - so you only need to import them once :D

// React

import {setupTracker} from "@nmp-trust/all";

...

React.useEffect(() => {
    setupTracker((e) => {)
}, []);

...
render () {
...
    <trust-settings settings={ JSON.stringify({ ...settings })} >
        <App />
    </trust-settings>
...
}

// Next

React.useEffect(() => import("@nmp-trust/all"), []);

...

<trust-settings settings={ JSON.stringify({ ...settings })}>
    <App />
</trust-settings>

...

// Settings object
export type ISettings = {
  apiUrl: string,
  accessToken: string,
  lan?: string,
};

// might remove apiUrl in the future if we split the packages for the different markedplaces

Use - components

Anywhere that is inside of <trust-settings>

...restOfComponent
<trust-nameOfComponent properties="values">
    //children if the component supports it
</trust-nameOfComponent>
...more components

To see the components just click on them here: https://pages.github.schibsted.io/finn/trust-feedback-web-components/?path=/story/translation--page

Development

1. Install dependencies - npm i
2. Run - npm run start

Publish

You need to be added to the organization in npm. Talk with someone in the team.

To run a release locally you need to set up environment variables in your shell:

# Semantic release
## You need to generate some tokens
export GH_TOKEN='' // Generate a token in github - it's under developer settings. Needs write:packaes and repo access.
export NPM_TOKEN='' // Generate a new publish token in npm

## Keep these as they are
export GITHUB_URL='https://api.github.schibsted.io'
export GITHUB_PREFIX=''

Check your git commit log - feat messages will bump minor, fix messages will bump patch and breaking changes will bump major version of this package. Commit your code changes and then run:

npm run release

git

write about semantic commits.