Dotsha Web Components

Ready to deploy web components for Dotsha resources.

Installation

Using npm

npm install @dotsha/web-components

Using yarn

yarn add @dotsha/web-components

unpkg

https://unpkg.com/@dotsha/web-components/dist/dotsha-components.js

Usage

HTML

<script type="module" src='https://js.dotsha.com/v0/dotsha-components.js' async></script>

<!-- Available components -->
<dotsha-contact-summary></dotsha-contact-summary>
<dotsha-credit-note-table></dotsha-credit-note-table>
<dotsha-invoice-table></dotsha-invoice-table>
<dotsha-offer-summary-list></<dotsha-offer-summary-list>
<dotsha-subscription-table></<dotsha-subscription-table>
<dotsha-subscription-summary-list></<dotsha-subscription-summary-list>
<dotsha-quote-list></dotsha-quote-list>

<dotsha-offers-to-quote></<dotsha-offers-to-quote>
<dotsha-offers-to-subscription></<dotsha-offers-to-subscription>

<!-- Parameters example -->
<dotsha-offers-to-subscription
  api-url='https://api.dotsha.com/'
  client-id='XXX'
  client-secret='XXX'
  currency-code='EUR'
  label='Select this'
  offer-ids='638f13b55cc034628023f681,63f645eadf8c8ba5a1bffbab'
></<dotsha-offers-to-subscription>

Contribute

Before contributing, please read the Contributing Guide.

Quick Start

This project is a web components collection, built with Lit.

Run:

yarn install --frozen-lockfile

yarn start

Setup environment

You will need to install Node.js 16.17.0 with npm@7and yarn@1

Login

Retrieving token

Web components will need a valid token to call the Dotsha API.

Using Postman

1. Go to the active environment (ex: DEV) and retrieve the access_token for self portal credentials: you now have a token with a userId linked to it

Using the browser developper tools

You can start the self-portal to grab an access_token from there, either after login or with each call.

Linting and formatting

To scan the project for linting and formatting errors, run

yarn lint

Testing with Web Test Runner

To execute a single test run:

yarn test

Demoing with Storybook

To run a local instance of Storybook for your component, run

yarn storybook

To build a production version of Storybook, run

yarn storybook:build

Demoing locally with web-dev-server

yarn start

To run a local development server that serves the basic demo located in demo/index.html.
Take care of hot reloading, sometimes it does not trigger after saving a change.