- Updated all soulcraftlabs.com references to soulcraft.com - Updated all soulcraft-research.com references to soulcraft.com - Updated CLI and documentation to use new domain |
||
|---|---|---|
| .. | ||
| interfaces | ||
| README.md | ||
🧠 Brainy Connectors - Open Source Interface
Standard connector interface for the Brainy ecosystem
📋 Overview
This directory contains the open source interface that all Brainy connectors implement. These interfaces provide a standardized way to connect external data sources to your Brainy database.
🔧 Interface Definition
The IConnector.ts file defines the standard interface that all connectors must implement:
import { IConnector, ConnectorConfig, SyncResult } from './interfaces/IConnector'
export class MyCustomConnector implements IConnector {
readonly id = 'my-custom-connector'
readonly name = 'My Custom Integration'
readonly version = '1.0.0'
readonly supportedTypes = ['documents', 'users']
async initialize(config: ConnectorConfig): Promise<void> {
// Your implementation here
}
async startSync(): Promise<SyncResult> {
// Your sync logic here
}
// ... implement other required methods
}
🚀 Building Custom Connectors
You can build your own connectors using these interfaces:
- Implement IConnector - Follow the interface contract
- Handle Authentication - Manage your service credentials
- Sync Data - Pull data from your source
- Transform - Convert to Brainy's format
- Store - Save to your Brainy database
📦 Premium Connectors
For production-ready connectors with enterprise features, check out Brain Cloud:
- Notion - Sync pages and databases
- Salesforce - CRM integration
- Slack - Team communication data
- And more - Coming soon
Learn more at soulcraft.com/brain-cloud
📚 Documentation
Part of the Brainy ecosystem by Soulcraft Labs