Plugin SDK Reference

The Vivified platform provides SDKs in multiple languages to simplify plugin development. Each SDK handles authentication, communication protocols, and provides helper utilities for common tasks.

Installation

pip install vivified-plugin-sdk

npm install @vivified/plugin-sdk
# or
yarn add @vivified/plugin-sdk

# Coming Soon - Q1 2025
go get github.com/vivified/plugin-sdk-go

Quick Start

Python SDK Example

from vivified_sdk import Plugin, PluginManifest
from vivified_sdk.traits import Traits
from vivified_sdk.contracts import StoragePlugin

class MyPlugin(Plugin, StoragePlugin):
    def __init__(self):
        manifest = PluginManifest(
            id="my-plugin",
            name="My Storage Plugin",
            version="1.0.0",
            contracts=["StoragePlugin"],
            traits=[Traits.HANDLES_PII, Traits.AUDIT_REQUIRED]
        )
        super().__init__(manifest)

    async def store(self, key: str, data: bytes) -> bool:
        """Implement storage interface"""
        # Your implementation here
        return True

    async def retrieve(self, key: str) -> bytes:
        """Implement retrieval interface"""
        # Your implementation here
        return b""

# Run the plugin
if __name__ == "__main__":
    plugin = MyPlugin()
    plugin.run()

Node.js SDK Example

const { Plugin, PluginManifest, Traits } = require('@vivified/plugin-sdk');

class MyPlugin extends Plugin {
    constructor() {
        const manifest = new PluginManifest({
            id: 'my-plugin',
            name: 'My Storage Plugin',
            version: '1.0.0',
            contracts: ['StoragePlugin'],
            traits: [Traits.HANDLES_PII, Traits.AUDIT_REQUIRED]
        });
        super(manifest);
    }

    async store(key, data) {
        // Your implementation here
        return true;
    }

    async retrieve(key) {
        // Your implementation here
        return Buffer.from('');
    }
}

// Run the plugin
const plugin = new MyPlugin();
plugin.run();

Go SDK (Coming Soon)

// Coming Q1 2025 - Full Go SDK with complete feature parity
package main

import (
    "github.com/vivified/plugin-sdk-go"
)

type MyPlugin struct {
    plugin.Base
}

func main() {
    manifest := plugin.NewManifest(
        "my-plugin",
        "My Storage Plugin",
        "1.0.0",
    )
    p := &MyPlugin{}
    plugin.Run(p, manifest)
}

Core Components

Plugin Manifest

The manifest declares your plugin's capabilities and requirements:

Communication APIs

Event Bus (Canonical Lane)

# Emit an event
await plugin.emit_event("user.created", {
    "user_id": "123",
    "email": "user@example.com"
})

# Listen for events
@plugin.on_event("document.processed")
async def handle_document(event):
    print(f"Document {event.document_id} processed")

// Emit an event
await plugin.emitEvent('user.created', {
    userId: '123',
    email: 'user@example.com'
});

// Listen for events
plugin.onEvent('document.processed', async (event) => {
    console.log(`Document ${event.documentId} processed`);
});

// Coming Soon - Q1 2025
// Full event bus integration

SDK Features

All SDKs Provide:

• ✅ Authentication - Automatic token management
• ✅ Health Checks - Built-in health monitoring
• ✅ Configuration - Dynamic configuration updates
• ✅ Storage Integration - Encrypted storage service access
• ✅ Event Bus - Canonical event publishing/subscription
• ✅ Operator API - Inter-plugin communication
• ✅ Proxy Service - Filtered external API access
• ✅ Audit Logging - Automatic audit trail generation
• ✅ Error Handling - Standardized error types
• ✅ Testing Utilities - Unit and integration test helpers

SDK Version Compatibility

Resources

• API Documentation: Full SDK API reference for each language
• Example Plugins: Plugin Examples
• Development Guide: Plugin Development
• GitHub: github.com/vivified/plugin-sdk