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.
npm install @ironcorelabs/ironweb
yarn add @ironcorelabs/ironweb
You can also view the source of the SDK via its GitHub repository.
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.
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.
The IronWeb SDK methods are grouped into namespaces to separate functionality.
|SDK Initialization and Unauthenticated User Management||Initialize the IronWeb SDK as a authenticated user or manage unauthenticated users.|
|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.
The IronWeb SDK works on the latest versions of Chrome, Firefox, Safari, Edge, and IE.