NexusEvent

🌍 Read this in other languages: 中文

A cross-platform messaging SDK that supports sending notification messages to multiple platforms like Discord, Slack, Telegram, and more.

🎯 Project Goals

• Unified API: Provide a consistent interface for different messaging platforms
• Multi-language Support: Support Flutter, JavaScript, Python, Go, and other programming languages
• Easily Extensible: Simple plugin architecture for adding new platform support
• Developer Friendly: Clear documentation and examples for quick integration

🏗️ Project Structure

NexusEvent/
├── packages/                    # SDK packages for different languages
│   ├── nexusevent-core/         # Core type definitions
│   ├── nexusevent_flutter/      # Flutter/Dart SDK
│   └── nexusevent-js/           # JavaScript/TypeScript SDK
├── examples/                    # Usage examples
│   ├── flutter_demo/            # Flutter demo app
│   └── js-demo/                 # JavaScript demo script
└── README.md                    # Project documentation

🚀 Quick Start

Flutter SDK

import 'package:nexusevent_flutter/nexusevent.dart';

// Add Discord sender
NexusEvent.instance.addDiscordSender(
  'main_discord', 
  'https://discord.com/api/webhooks/YOUR_WEBHOOK_URL'
);

// Send message
final message = EventMessage(
  title: 'New Video Liked',
  content: 'Flutter Development Guide',
  url: 'https://example.com/video/123',
  author: 'Channel Name',
);

await NexusEvent.instance.send('main_discord', message);

JavaScript SDK

import { NexusEvent, Platform } from '@i-vox/nexusevent-js';

// Get SDK instance
const nexus = NexusEvent.getInstance();

// Add Discord sender
nexus.addDiscordSender('main_discord', 'https://discord.com/api/webhooks/YOUR_WEBHOOK_URL');

// Send message
const message = {
  title: 'New Video Liked',
  content: 'JavaScript Development Guide',
  url: 'https://example.com/video/123',
  author: 'Channel Name',
  timestamp: new Date(),
};

await nexus.send('main_discord', message);

📦 Supported Platforms

Platform	Status	Flutter	JavaScript	Python	Go
Discord	✅ Supported	✅	✅	🚧	🚧
Slack	🚧 In Development	🚧	🚧	🚧	🚧
Telegram	📋 Planned	📋	📋	📋	📋
Teams	📋 Planned	📋	📋	📋	📋
Custom Webhook	📋 Planned	📋	📋	📋	📋

🛠️ Development Status

• ✅ Core architecture design completed
• ✅ Flutter SDK Discord support
• ✅ JavaScript SDK Discord support
• ✅ Basic demo applications
• 🚧 JavaScript SDK in development
• 📋 Other language SDKs planned

📖 Documentation

• Flutter Demo
• JavaScript Demo
• Security Policy

🚀 Installation

Flutter

Add to your pubspec.yaml:

dependencies:
  nexusevent_flutter: ^0.1.3

JavaScript/TypeScript

First configure npm to use GitHub Packages:

npm config set @i-vox:registry https://npm.pkg.github.com

Then install:

npm install @i-vox/nexusevent-js

🔧 Features

Core Features

• 🎯 Unified API Design: Consistent interface across different languages
• 🛡️ Error Handling: Comprehensive exception handling mechanism
• 🔍 Configuration Validation: Automatic validation of webhook URLs and configurations
• 📤 Broadcast Functionality: Send messages to multiple platforms simultaneously
• 🎨 Rich Messages: Support for embedded messages, colors, authors, etc.

Flutter SDK Features

• 📱 Native Flutter Integration: Built specifically for Flutter/Dart
• 🔄 Backward Compatibility: Maintains compatibility with existing APIs
• 🧪 Comprehensive Testing: Unit tests with 80%+ coverage

JavaScript SDK Features

• 📦 TypeScript Support: Complete type definitions
• 🌐 Multiple Module Formats: Supports both CommonJS and ES Modules
• 🎯 Singleton Pattern: Convenient SDK instance management

💡 Usage Examples

Video Like Notification

// Flutter
Future<void> sendLikeNotification({
  required String videoTitle,
  required String videoUrl, 
  required String author,
}) async {
  final message = EventMessage(
    title: 'New Video Liked 👍',
    content: '「$videoTitle」',
    url: videoUrl,
    author: author,
    color: 0x33ccff,
    timestamp: DateTime.now(),
  );

  await NexusEvent.instance.send('discord_main', message);
}

// JavaScript
async function sendLikeNotification({ videoTitle, videoUrl, author }) {
  const message = {
    title: 'New Video Liked 👍',
    content: `「${videoTitle}」`,
    url: videoUrl,
    author: author,
    color: 0x33ccff,
    timestamp: new Date(),
  };

  await nexus.send('discord_main', message);
}

Error Handling

// Flutter
try {
  await NexusEvent.instance.send('discord_main', message);
  print('Message sent successfully');
} catch (e) {
  print('Failed to send: $e');
  // Handle error, e.g., retry or use backup sender
}

// JavaScript
try {
  await nexus.send('discord_main', message);
  console.log('Message sent successfully');
} catch (error) {
  console.error('Failed to send:', error);
  // Handle error, e.g., retry or use backup sender
}

🤝 Contributing

We welcome all forms of contributions! Please see our Issue Templates for bug reports and feature requests.

Development Setup

1. Clone the repository

git clone https://github.com/your-org/NexusEvent.git
cd NexusEvent

2. Flutter SDK Development

cd packages/nexusevent_flutter
flutter pub get
flutter analyze
flutter test

3. JavaScript SDK Development

cd packages/nexusevent-js
npm install
npm run build
npm test

📄 License

This project is licensed under the Apache License 2.0.

Apache 2.0 is more restrictive than MIT and includes patent protection clauses, providing better legal protection for both contributors and users.

🌟 Star History

If you find this project useful, please consider giving it a star! ⭐

🔗 Links

• Documentation: Full Documentation
• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Flutter Package: pub.dev
• JavaScript Package: npm