Installation

To run service locally you have to perform following steps:

1. Install NodeJS 16.x or later in you operating system
2. Run npm install in terminal in project root
3. Run npm run sandbox in terminal in project root

Sandbox

Sandbox is examplary react implementation of package which allows for quick debugging and testing how it behaves in real browser environment.

To open sandbox environment, please follow installation steps above.

Implementation

To implement package into your application, please install it through npm command:

npm install @sagiton/opportunity-js

and then import package functions or hooks (in case you have React application) to request opportunity service:

import {getConsents, getConsentsByType, sendOpportunity, healthCheck} from '@sagiton/opportunity-js'

import {useHealthCheck, useGetConsents, useGetConsentsByType, useSendOpportunity} from '@sagiton/opportunity-js'

Please inspect sandbox file src/index.tsx to see exemplary implementation.

Package is built with typescript, so it's fully typed and your IDE should hint you all required parameters and returned types of all exposed functions.

All functions requesting Opportunity are promised based and all hooks returns flags like isSubmitting, isSubmitted, isError and error for your convenience.

Deployment to NPM and CDN

To deploy new package version to sagiton npm, you have to:

1. Run npm login command in terminal to login to sagiton npm account using credentials in bitwarden
2. Upgrade package version in package.json file
3. Run npm run build to rebuild lib folder which will be uploaded to npm
4. Run npm run build-cdn to rebuild cdn folder with cdn file which will be uploaded to npm
5. Run npm publish to publish latest changes to npm
6. Your CDN file will be available under url: https://cdn.jsdelivr.net/npm/@sagiton/opportunity-js@{{PACKAGE_VERSION}}/cdn/opportunity-js.min.js