Integration SDK JS

The JavaScript Integration SDK serves as a bridge for our integrating partners to communicate with the extension in the frontend. It offers a collection of methods that allow for hooking into listeners or sending messages to the extension.

Installation

npm i --save @honorlock/integration-sdk-js

Usage

import { Honorlock } from '@honorlock/integration-sdk-js';

CDN

Using CDN with the lastest version

<script type="module" src="https://unpkg.com/@honorlock/integration-sdk-js"></script>

Using CDN with a specific version

<script type="module" src="https://unpkg.com/@honorlock/integration-sdk-js/@x.x.x"></script>

Build Instructions

npm run build

Available Scripts

The following scripts are available for use:

npm run build

Compiles the TypeScript source code using the TypeScript compiler (tsc) and builds the project using Vite.

npm run prepublish

This script runs npm run build before publishing the package to npm.

npm run lint

Lints the TypeScript and HTML files in the project using ESLint and checks the code formatting using Prettier.

npm run format

Lints and formats the TypeScript and HTML files in the project using ESLint and Prettier.

npm run test

Runs the tests in your project using Jest, with the environment variable NODE_ENV set to test.

npm run test:ci

Runs the tests in your project using Jest with the environment variable NODE_ENV set to test, and generates a coverage report and JUnit test results suitable for continuous integration environments.