npm

Need private packages and team management tools?Check out npm Orgs. »

@hmcts/draft-store-client

1.2.1 • Public • Published

@hmcts/draft-store-client

Greenkeeper badge

Standard - JavaScript Style Guide

This is a client library for interacting with the draft store api

To configure the draft store client you need to:

  • Implement the ServiceAuthTokenFactory interface.
export interface ServiceAuthTokenFactory {
     get (): Promise<ServiceAuthToken>
   }
  • Sample implementation:
let token: ServiceAuthToken

export class ServiceAuthTokenFactoryImpl implements ServiceAuthTokenFactory{
  async get (): Promise<ServiceAuthToken> {
    if (token === undefined || token.hasExpired()) {
      token = await IdamClient.retrieveServiceToken()
    }
    return token
  }
}

API available with clients

  • DraftService provides wrapper around creating DraftStoreClientFactory to save and delete draft documents
  • DraftStoreClientFactory is responsible for creating DraftStoreClients
  • DraftStoreClient is responsible for search, save and delete of draft store data
  • DraftMiddleware manages number of draft store client can be configured and is available if user is logged in

To add library

yarn add @hmcts/draft-store-client

Getting Started

Prerequisites

Running the application

Install dependencies by executing the following command:

$ yarn install

Developing

Code style

We use TSLint with StandardJS rules

Running the linting: yarn lint

Running the tests

Mocha is used for writing tests.

Run them with:

$ yarn test

For test coverage:

$ yarn test:coverage

License

This project is licensed under the MIT License - see the LICENSE file for details

Keywords

none

install

npm i @hmcts/draft-store-client

Downloadsweekly downloads

811

version

1.2.1

license

MIT

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability