Arcananex Flux

Arcananex Flux is a modular TypeScript framework designed to facilitate seamless integration and orchestration of various data sources and services. It provides a flexible architecture for building applications that require command processing, service registration, and adapter-based data access (e.g., databases, REST APIs, OpenSearch, etc.).

Features

• Command Processor: Centralized command handling and execution.
• Service Registry: Register and manage services for dependency injection and discovery.
• Adapter Pattern: Easily extend support for new data sources (database, REST API, OpenSearch, etc.).
• Extensible Core: Add or modify core logic without disrupting existing functionality.
• Comprehensive Logging: Built-in utilities for structured logging and debugging.

Design

Prerequisites

• Node.js (v16 or higher recommended)
• npm or yarn

Setup

1. Clone the repository:

   git clone https://github.com/yourusername/arcananex-flux.git
   cd arcananex-flux

2. Install dependencies:

   npm install
   # or
   yarn install

3. Build the project:

   npm run build
   # or
   yarn build

4. Run tests (optional):

   npm test
   # or
   yarn test

Usage

Importing Core Components

import { CommandProcessor, ServiceRegistry } from './src/core';
import { DatabaseQueryAdapter, RestApiAdapter, OpenSearchAdapter } from './src/adapters';

Registering Services

const registry = new ServiceRegistry();
registry.register('db', new DatabaseQueryAdapter(/* config */));
registry.register('api', new RestApiAdapter(/* config */));
registry.register('search', new OpenSearchAdapter(/* config */));

Processing Commands

const processor = new CommandProcessor(registry);
const result = await processor.process({
  type: 'QUERY',
  payload: { /* ... */ }
});
console.log(result);

Logging

import { logger } from './src/utils/logger';
logger.info('Application started');

Project Structure

├── src/
│   ├── adapters/           # Data source adapters (database, REST API, OpenSearch)
│   ├── core/               # Core framework logic (command processor, service registry)
│   ├── utils/              # Utility modules (logger, helpers)
│   └── index.ts            # Entry point
├── tests/                  # Test files
├── package.json            # Project metadata and scripts
├── tsconfig.json           # TypeScript configuration
└── README.md               # Project documentation

Example: Adding a Custom Adapter

import { AdapterInterface } from './src/core/interfaces';

class CustomAdapter implements AdapterInterface {
  async query(params: any) {
    // Implement custom query logic
    return { data: 'custom result' };
  }
}

const registry = new ServiceRegistry();
registry.register('custom', new CustomAdapter());

Contributing

Contributions are welcome! Please open issues or submit pull requests for improvements and bug fixes.

License

This project is licensed under the MIT License.