aurcare-plugin-sdk

Official SDK for building secure iframe-based plugins for the Aurcare healthcare platform.

Installation

npm install aurcare-plugin-sdk

Quick Start

For Plugin Developers

import { startPlugin } from 'aurcare-plugin-sdk';

const plugin = startPlugin({
  hostOrigin: 'https://app.aurcare.com',
  handlers: {
    async submitForm(params) {
      // Handle form submission
      return { success: true, formId: '123' };
    }
  },
  onInit: (payload) => {
    console.log('Initialized for clinic:', payload.clinicId);
  }
});

// Send events to host
plugin.sendEvent('form:loaded', { timestamp: Date.now() });

For Host Application

import { createIframeClient } from 'aurcare-plugin-sdk';

const client = createIframeClient({
  iframe: iframeElement,
  origin: 'https://plugins.example.com',
  clinicId: 'clinic-123',
  pluginId: 'respiratory.intake',
  initTokenMask: 'token-xyz',
  onError: (error) => console.error('Plugin error:', error)
});

// Call plugin methods
const result = await client.callRpc('submitForm', { data: {...} });

Features

• Secure Communication: PostMessage-based RPC with origin validation
• Type-Safe: Full TypeScript support with comprehensive types
• Scoped Permissions: Fine-grained scope system for data access control
• Error Handling: Built-in timeout and error management
• Event System: Bidirectional event communication
• Zero Dependencies: Lightweight with no external dependencies

Documentation

See the Developer Guide for complete documentation.

Security

This SDK implements security best practices for healthcare applications:

• Origin validation for all messages
• Sandbox attribute support
• Token-based authentication
• No direct PHI transmission
• Audit-friendly event logging

License

MIT