@highnoteplatform/document-upload

> Note: This library is in a pre-release phase. Prior to the release of
> version 1.0.0, breaking changes may be introduced.

Document Upload SDK simplifies our Subscriber’s integration.

It minimizes impact for Subscriber to changes in Highnote’s manual reviews.

It expands the secured document upload capability.

Requirements

1. A Highnote Account

2. A server-side integration using an API Key

3. Document Upload Session ID

4. A HTML selector for injecting a DOM Element

Installation

With npm:

``sh
npm i @highnoteplatform/document-upload
`

With yarn:

`sh
yarn add @highnoteplatform/document-upload
`

With pnpm:

`sh
pnpm add @highnoteplatform/document-upload
`

This package ships with TypeScript definitions installed.

via CDN

You can install the Document Upload SDK for use on your page directly from a CDN such as JSDelivr. This is helpful when exploring the SDK or for use in tools such as CodeSandbox.

It is recommended you select a specific version of the library to use. You can replace @latest with your chosen version, for example, @1.0.0.

`html



`

The library will append a HTMLDivElement into this element to render the appropriate widget. You can style the content inside of each iframe by passing any combination of allowed styles.

You can initialize the Document Upload by calling initializeDocumentUploadSdk. This will return a Promise that, will contain a reference to the HTMLDivElement instance.

Error Handling

| Error | Description |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- |
| _InvalidCredentialError_
This error occurs when the provided Client Token is invalid or expired.The payload will contain the requestId which can be used for support and debugging. | name: "InvalidCredential"
context: object
requestId: string |
| _DocumentUploadRequestError_
This error represents errors encountered when communicating with the Highnote GraphQL API.The payload will contain the requestId which can be used for support and debugging. | name: "DocumentUploadRequestError"
message: string
context: object
requestId: string |
| _DocumentUploadConfigError_
This error is raised when an invalid configuration is provided at runtime. | name: "DocumentUploadConfigError"
message: string |

$3

`typescript
import { initializeDocumentUploadSDK } from "@highnoteplatform/document-upload";

const handleError = (error: Error) => {
switch (error.name) {
case "InvalidCredential":
// Handle invalid/expired credential
// Unmount fields, fetch new client token, re-initialize
console.error(error.context.requestId); // "some-request-id"
break;

case "DoumentUploadRequestError":
console.error(error.context.requestId); // some-request-id
break;

case "DocumentUploadConfigError":
console.error(error.message); // "Invalid Session ID"
break;

default:
console.error(error);
}
};

const handleOnLoad = (component: Element) => {
console.log([Integrator log]: ${component.id} value appended to selector!);
};

const handleOnSuccess = (onSuccess: boolean) => {
if (onSuccess) {
console.log([Integrator log]: All documents uploaded and session closed.);
}
};

await initializeDocumentUploadSdk({
clientToken: "client-token",
documentUploadSessionId: "document-upload-session-id",
environment: "test",
documentUploadComponent: { selector: "#document-upload-component" },
onLoad: handleOnLoad,
onSuccess: handleOnSuccess,
onError: handleError,
});
``