Star Insure - SDK

The SDK for Star Insure client apps with shared helper functions and TypeScript definitions.

Installation

npm install @star-insure/sdk

Development

npm start

Testing

npm run test

Making changes to this package locally

Updating project dependency

Update the package.json file in your consuming project to reference the relative path to this package. e.g.

"@star-insure/sdk": "file:../starinsure-sdk",

npm link

From this package root:

npm link

From the project you're making changes in (e.g. star-insure/portal):

npm link @star-insure/sdk

To unlink, run this from the project you're making changes in (e.g. star-insure/portal):

npm uninstall --no-save @star-insure/sdk && npm install

If you run into weird caching issues, run the below from your project to force Vite to re-cache dependencies

npm run vite

[Optional] You can remove the global symlink created for this package by from this package root. However you don't need to do this, as you'll likely be doing this again in future.

npm uninstall

Publishing to NPM

Suggest that you use np for publishing.

From the command line just run (you'll need Node version 18+ running):

npm run release

Usage

This library provides the following functions:

Date and Time

1. formatDate - Returns a string in format dd/mm/yyyy

import { formatDate } from '@star-insure/sdk';

formatDate(new Date());
formatDate('2024-03-23T20:00:00.000Z');
formatDate('Sat, 23 Mar 2024 20:00:00 GMT');

2. formatDateTime - Returns a string in format dd/mm/yyyy hh:mm (24-hour clock)

import { formatDateTime } from '@star-insure/sdk';

formatDateTime(new Date());
formatDateTime('2024-03-23T20:00:00.000Z');
formatDateTime('Sat, 23 Mar 2024 20:00:00 GMT');

Money

1. formatMoney - Returns a string in format $x,xxx.xx

import { formatMoney } from '@star-insure/sdk';

formatMoney(1234567.89);
formatMoney('1234567.89');