@maxio-com/self-service 1.9.4 → 1.9.6

package/README.md

@@ -13,39 +13,40 @@ yarn add @maxio-com/self-service
 ```
 
 ### 2. Import components
+
 Import components from `@maxio-com/self-service` package as ES6 modules or include them in your HTML file.
 
 ```js
-import {Components} from '@maxio-com/self-service';
+import { Components } from '@maxio-com/self-service';
 ```
+
 ### 3. Use components
 
 ```js
 const componentsFactory = new Components({
-    theme: componentsTheme,
-    i18nSettings: {
-        loadPath: 'loadPath-url',
-        language: locale,
-    },
-    accessTokenUrl:
-        'accessTokenUrl-url',
+  theme: componentsTheme,
+  i18nSettings: {
+    loadPath: 'loadPath-url',
+    language: locale,
+  },
+  accessTokenUrl: 'accessTokenUrl-url',
 });
 ```
 
 ### 4. Examples
 
- Vue.js example is available in [vue-self-service-example](https://github.com/maxio-com/vue-self-service-example) directory.
+Vue.js example is available in [vue-self-service-example](https://github.com/maxio-com/vue-self-service-example) directory.
 
- React.js example is available in [react-self-service-example](https://github.com/maxio-com/react-self-service) directory.
+React.js example is available in [react-self-service-example](https://github.com/maxio-com/react-self-service) directory.
 
-##  Installation
+## Installation
 
 Please follow the steps described below to correctly setup mono-repository.
 
 #### Required system dependencies
 
--   [NodeJS](https://nodejs.org/en/) -  JavaScript runtime environment.
--   [pnpm](https://pnpm.io/) - package manager used to maintain project dependencies
+- [NodeJS](https://nodejs.org/en/) - JavaScript runtime environment.
+- [pnpm](https://pnpm.io/) - package manager used to maintain project dependencies
 
 ### a. NodeJS
 
@@ -81,7 +82,7 @@ Execute `npx husky install` command in terminal to setup GIT `pre-commit` and `c
 
 For development purposes this project could use `api-adapter-mock` server. To run server make sure that required system dependencies are installed:
 
--   [Docker Desktop](https://www.docker.com/products/docker-desktop) -  Docker containers environment.
+- [Docker Desktop](https://www.docker.com/products/docker-desktop) - Docker containers environment.
 
 Run command defined below in the command-line interface:
 
@@ -123,6 +124,7 @@ This repository builds multiple artifacts to address different integration use c
 | `Types Definitions` | types declarations for applications implemented in `TypeScript` environment.        |
 
 ### translations
+
 Some translations are allowed to have basic HTML tags inside like `<strong>` or `<i>`.
 However, this only works for elements without additional attributes (like className), having none or a single text children and provided that we use them in places that allow by design for text formatting.
 
@@ -150,18 +152,23 @@ AIO Test Cycle and automatically update execution results.
 ### How to perform End to End Testing using Playwright locally
 
 #### 1. Build RUC package using command:
+
 ```sh
 pnpm build:browser
 ```
-As a result ``maxio-components.umd.js`` will be created inside ```dist``` folder
 
-#### 2. Copy assets into ``e2e_pages`` folder using command:
+As a result `maxio-components.umd.js` will be created inside `dist` folder
+
+#### 2. Copy assets into `e2e_pages` folder using command:
+
 ```sh
 pnpm copy:e2e-assets
 ```
-Note: You can use ``pnpm clean:e2e-assets`` to clean old assets first if needed
+
+Note: You can use `pnpm clean:e2e-assets` to clean old assets first if needed
 
 #### 3. Serve pages and assets so playwright can load it properly on specified port:
+
 ```sh
 pnpm serve:e2e-assets
 ```
@@ -169,14 +176,15 @@ pnpm serve:e2e-assets
 #### 4. Provide required env variables (you can refer to .env.example)
 
 #### 5. Run playwright tests:
+
 ```sh
 npx playwright test
 ```
 
 #### Additional information:
 
-- ``playwright.config.ts``: Is playwright configuration file. Anything related to browser, hosts, timeouts, and parallelism can be configured there.
+- `playwright.config.ts`: Is playwright configuration file. Anything related to browser, hosts, timeouts, and parallelism can be configured there.
 
-- ``--headed`` flag added to ``npx playwright test`` allows to open browser during tests
+- `--headed` flag added to `npx playwright test` allows to open browser during tests
 
-- ``page.pause()`` allows to pause the test execution and do some debugging
+- `page.pause()` allows to pause the test execution and do some debugging