IronWeb SDK

The IronWeb SDK is a browser-based JavaScript library that integrates IronCore's privacy, security, and data control solution into your app.

Installation

The IronWeb SDK is available on NPM under the package name @ironcorelabs/ironweb. This module includes the SDK in both ES6 Module and CommonJS format as well as a single minified ironweb.min.js. It can be installed via either NPM or Yarn via

npm install @ironcorelabs/ironweb

or

yarn add @ironcorelabs/ironweb

Use as a standalone script

Use the IronWeb SDK as a standalone script that creates a global ironweb variable upon that contains all functionality. To import IronWeb as a standalone script use a resource such as Unpkg.

Promises

Most IronWeb SDK methods utilize Promises as most operations are asynchronous in nature. In order to support browsers which don't have native Promise support (IE 11 only at this point) a Promise polyfill must be provided. As there are many Promise polyfill libraries that exist and your app might already be using one, a polyfill is NOT provided as part of the SDK. We declare a peer dependency on the es6-promise package, however any valid Promise polyfill library can be used.

SDK Methods

The IronWeb SDK methods are grouped into namespaces to separate functionality.

Document Create, update, and manage access to your encrypted content.
Group Create and manage members and admins of your cryptographic groups.
User Manage the currently authenticated user of the SDK.
Codec Utility methods to handle data conversion between different formats.

SDK Error and Error Codes

Most IronWeb SDK methods return a Promise. If an SDK operation fails the Promise that was created will reject with a SDKError that provides additional information about the error that occurred. Each SDKError has a specific error code that exposes information about the error that occurred.

Platform Support

The IronWeb SDK works on the latest versions of Chrome, Firefox, Safari, Edge, and IE.