@rarify/js-sdk

@rarify/js-sdk

Overview

Rarify JS SDK is a client-side Javascript library for Rarify platform.

Documentation can be found here: https://rarifytech.gitlab.io/js-sdk

Changelog

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

Usage

Install

Install via npm

yarn add @rarify/js-sdk

Install via script tag

<script type="text/javascript" src="https://unpkg.com/@rarify/js-sdk@[version]/lib/rarify.js-sdk.min.js"></script>

Build bundles

@rarify/js-sdk compiles into the es-modules and also there is distributive for "in-script-tag" usage that compiles into the ./lib/rarify.js-sdk.min.js output file, which will accessible in the Window object with property name .rarifySdk

Before developing or building library distributive you'll need to install node_modules, use npm install or yarn install.

To build library distributives you can execute yarn build that will compile the type definitions, es-module bundle and browser bundle, or you can do each step manually:

Remove all compiled distributions from ./lib directory:

yarn clean

Build type definitions with TypeScript compiler:

yarn build:types

This command emits all type definitions from library without JavaScript compiling, also we use tsc-alias tool to replace all alias-ed type definitions paths to the relative one.

Compile and minify library into the es-modules with Babel.js:

yarn build:js

It will remove all comments, whitespaces, transpile and minify output JavaScript code.

Build browser compatible bundle with esbuild:

yarn build:browser

Documentation

We use Typedoc tool to compile docs from the source code, you can build it for the local usage like this, output will be located in ./docs:

yarn docs

Development

For the development environment we use:

• Eslint plus Prettier for the linting and formatting code.
• Jest for unit tests.

There are some npm scripts that will help during development:

Run tests:

yarn test

Serve tests during development or fixing:

yarn test:watch

Check types with TypeScript compiler:

yarn type-check

Lint source code:

yarn lint

Check out CHANGELOG.md and package.json files for release version changes:

yarn rsc %release-version%

Example: yarn rsc 1.0.0-rc.0

Built and tested on node v14.18.1.