MIMS SDK
Get Started

Changelog

All notable changes to the MIMS SDK are documented here.

Versioning

This project follows Semantic Versioning. Major versions may include breaking changes.

v1.0.0

LatestJanuary 15, 2025

Initial stable release of the MIMS SDK for React applications.

Features

  • MIMSProvider - Context provider for SDK initialization and API key validation
  • PDFViewer - Full-featured PDF viewer with zoom, navigation, and field overlay
  • SignaturePad - Signature capture component with draw, type, and upload modes
  • Document Store - Zustand-based state management for document and field state
  • Field Types - Support for text, signature, checkbox, date, and initials fields
  • Type Safety - Full TypeScript support with exported type definitions

Hooks

  • useSDK - Access SDK context and make authenticated API requests
  • useSDKReady - Simple boolean check for SDK initialization
  • useDocument - Read-only document state access
  • useDocumentStore - Full store access with actions
  • useCurrentPageFields - Get fields for current page
  • useSelectedField - Get currently selected field

API Endpoints

  • POST /sdk/validate-key - Validate API key and get organization info
  • GET /sdk/documents/:id - Retrieve document with fields
  • POST /sdk/documents/submit - Submit completed document

v0.9.0

BetaDecember 1, 2024

Public beta release for early adopters.

Features

  • Initial PDFViewer implementation
  • Basic signature capture
  • Field rendering and value capture
  • API key authentication

Known Issues

  • Large PDFs may cause performance issues
  • Signature smoothing not optimized
  • Limited field validation

v0.1.0

AlphaOctober 15, 2024

Internal alpha release for testing.

Features

  • Proof of concept PDF rendering
  • Basic provider setup
  • Initial type definitions

Upgrade Guide

When upgrading between major versions, follow these guidelines:

From 0.x to 1.0

  • Provider Props - The baseUrl prop was renamed to apiBaseUrl
  • Store API - getFields() was replaced with direct fields Map access
  • Types - Field types are now more strictly typed with discriminated unions
Migration Exampletsx
// Before (0.x)
<MIMSProvider baseUrl="https://api..." apiKey="pk_...">

// After (1.0)
<MIMSProvider apiBaseUrl="https://api..." apiKey="pk_...">

// Before (0.x)
const fields = store.getFields();

// After (1.0)
const fields = store.fields; // Map<string, FieldState>

Stay Updated