@exulu/backend 0.3.12 → 1.2.0

package/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+on:
+  push:
+    branches:
+      - main # or main
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Build
+        run: npm run build
+      # - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+      #   run: npm audit signatures
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: HUSKY=0 npm run semantic-release

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

package/CHANGELOG.md

@@ -0,0 +1,45 @@
+# [1.2.0](https://github.com/Qventu/exulu-backend/compare/v1.1.0...v1.2.0) (2025-07-30)
+
+
+### Bug Fixes
+
+* removed release.rc ([32d581f](https://github.com/Qventu/exulu-backend/commit/32d581fb642b3e829bb47224006ffc6afc3f5d36))
+
+
+### Features
+
+* add npm plugin for semantic release ([a4168d0](https://github.com/Qventu/exulu-backend/commit/a4168d0e6dfe36b10986cc6d11c01b69b1dc13e3))
+* running semantic release via npm ([3ce05e7](https://github.com/Qventu/exulu-backend/commit/3ce05e791290c9ce6451a8855983907b41eb0aeb))
+
+# [1.1.0](https://github.com/Qventu/exulu-backend/compare/v1.0.1...v1.1.0) (2025-07-30)
+
+
+### Features
+
+* add npm plugin for semantic release ([efcdc77](https://github.com/Qventu/exulu-backend/commit/efcdc779e6864f87eb4f6ae021dc03b00408d014))
+
+## [1.0.1](https://github.com/Qventu/exulu-backend/compare/v1.0.0...v1.0.1) (2025-07-30)
+
+
+### Bug Fixes
+
+* add npm plugin for semantic release ([92cb0b2](https://github.com/Qventu/exulu-backend/commit/92cb0b2f00f125d429b94fef19e58caf5f2c41ab))
+
+# 1.0.0 (2025-07-30)
+
+
+### Bug Fixes
+
+* added missing semantic release changelog dependency ([9001711](https://github.com/Qventu/exulu-backend/commit/9001711c6cc83de6750f3cf2c6e50c559a649ae5))
+* added missing semantic release changelog dependency ([0ea5923](https://github.com/Qventu/exulu-backend/commit/0ea592374c59d099be61dd30773b4e8ae0076470))
+* disable npm audit signatures ([fa4554b](https://github.com/Qventu/exulu-backend/commit/fa4554b75e18321c71a3ce1f0ea47ee0bd7f5b56))
+* remove @panva/hkdf dependency as it is no longer used ([b952625](https://github.com/Qventu/exulu-backend/commit/b952625e25317136fcfcad2b83cd4684a1017edc))
+* skip husky hook when running semantic release ([952b055](https://github.com/Qventu/exulu-backend/commit/952b0550c2f7efd23d6d14ce29a17000a5b1cee8))
+* skip husky hook when running semantic release ([d57af11](https://github.com/Qventu/exulu-backend/commit/d57af115ca95c1d5e0a8d8b59d2f2861fd6e4aa6))
+* skip husky hook when running semantic release ([22d970c](https://github.com/Qventu/exulu-backend/commit/22d970c86e6e63b4848b69accd8dc74eb77a9829))
+
+
+### Features
+
+* automated npm publish ([d7d533f](https://github.com/Qventu/exulu-backend/commit/d7d533fbdc147d97d8059214db8deb5762fb4400))
+* automated npm publish ([8fa0d66](https://github.com/Qventu/exulu-backend/commit/8fa0d668635640ce044554a3d90aef8138b06a6d))

package/README.md

@@ -1,71 +1,176 @@
-# Exulu
+# Exulu - AI Agent Management Platform
 
-A comprehensive TypeScript package providing integrations and utilities for modern web applications.
+<div align="center">
 
-## Features
+![Exulu Logo](frontend/public/exulu_logo.svg)
 
-- 🔐 Authentication and Authorization
-- 🗄️ Database Integrations (PostgreSQL with pgvector support)
-- 🔄 Redis Integration
-- 📊 BullMQ Queue Management
-- 🤖 AI and RAG (Retrieval-Augmented Generation) Capabilities
-- 📝 GraphQL Support with Apollo Server
-- 🔄 Express Integration
-- 📦 AWS S3 Integration
-- 🔒 JWT and NextAuth Support
+**A powerful platform for creating, managing, and orchestrating AI agents with enterprise-grade features**
 
-## Installation
+[![Node.js](https://img.shields.io/badge/Node.js-20.10.0-green.svg)](https://nodejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.8.3-blue.svg)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/badge/License-Private-red.svg)](LICENSE)
 
-```bash
-npm install exulu
-```
+</div>
 
-## Quick Start
+## 🚀 Overview
 
-```typescript
-import { /* your imports */ } from 'exulu';
+Exulu is a comprehensive AI agent management platform that enables you to create, deploy, and orchestrate intelligent agents with enterprise-grade features. Built with TypeScript, it provides a robust backend infrastructure and modern frontend interface for seamless agent management and interaction.
 
-// Your implementation here
-```
+### Key Features
 
-## Dependencies
+- 🤖 **AI Agent Management**: Create and manage multiple AI agents with different capabilities
+- 🔧 **Tool Integration**: Extend agent capabilities with custom tools and workflows
+- 🗄️ **Vector Database**: PostgreSQL with pgvector for semantic search and RAG
+- 📊 **Queue Management**: BullMQ for background job processing
+- 🔐 **Authentication**: JWT and NextAuth support with role-based access
+- 📝 **GraphQL API**: Flexible API with Apollo Server integration
+- 🎯 **Agent Evaluation**: Built-in evaluation framework for agent performance
+- 🔄 **Workflow Orchestration**: Create complex multi-agent workflows
+- 📦 **File Management**: S3-compatible storage with Uppy integration
+- 🎨 **Modern UI**: Next.js frontend.
 
-This package requires the following peer dependencies:
-- TypeScript ^5.8.3
+## 🏗️ Architecture
 
-## Development
+The overall project is organized into 5 main repositories:
 
-1. Clone the repository
-2. Install dependencies:
-```bash
-npm install
+
+1. Backend: Express.js server with endpoints for agents, contexts, jobs, users, roles and workflows.
+2. Frontend: Next.js application.
+3. Example: example Exulu implementation with example agents, contexts and tools.
+4. CLI: command-line interface tools.
+5. Tools: catalogue of ExuluTools that can be installed and added to agents.
+6. Agents: catalogue of template agents you can install and add to your Exulu instance.
+
+### Core Components
+
+- **ExuluApp**: Main application class that initializes the platform
+- **Agents**: AI agent definitions with configurable capabilities
+- **Tools**: Available actions and utilities for agents
+- **Contexts**: Vectorized knowledge sources agents can search through and use in their reasoning and response
+- **Workflows**: Predefined agent interaction patterns
+- **Embedders**: Text embedding models for semantic search
+
+## 🛠️ Prerequisites
+
+- **Node.js** (v20.10.0 or higher)
+- **PostgreSQL** with pgvector extension
+- **Redis** (optional, for BullMQ workers)
+- **Docker** (optional, for containerized deployment)
+
+## 📚 Usage Examples
+
+### Creating an Agent
+
+```typescript
+import { ExuluApp, ExuluAgent } from "@exulu/backend";
+
+const exulu = new ExuluApp();
+
+const myAgent = new ExuluAgent({
+  id: "my-custom-agent",
+  name: "My Custom Agent",
+  description: "A custom AI agent for specific tasks",
+  type: "agent",
+  capabilities: {
+    tools: true,
+    images: [],
+    files: [],
+    audio: [],
+    video: []
+  },
+  config: {
+    model: "gpt-4",
+    // ... other configuration
+  }
+});
+
+const server = await exulu.create({
+  config: {
+    workers: { enabled: false },
+    MCP: { enabled: true }
+  },
+  contexts: [],
+  tools: [],
+  agents: [myAgent],
+  workflows: []
+});
 ```
 
-3. Build the package:
+### Using the CLI
+
 ```bash
-npm run build
+# Install CLI globally
+npm install -g @exulu/cli
+
+# Run CLI
+exulu
+
+# Available commands:
+# - Start Claude Code
+# - List agents
+# - List contexts
 ```
 
-## Project Structure
+## 🔧 Configuration
+
+### Environment Variables
+
+Create `.env` files in both `frontend/` and `backend/` directories. Use the `.env.preview` files for reference.
+
+#### Backend Environment Variables
 
+```env
+# Database
+DATABASE_URL=postgresql://username:password@localhost:5432/exulu
+REDIS_URL=redis://localhost:6379
+
+# Authentication
+JWT_SECRET=your-jwt-secret
+NEXTAUTH_SECRET=your-nextauth-secret
+
+# AI Providers
+OPENAI_API_KEY=your-openai-key
+ANTHROPIC_API_KEY=your-anthropic-key
+
+# File Storage
+S3_BUCKET=your-s3-bucket
+S3_REGION=your-s3-region
+AWS_ACCESS_KEY_ID=your-aws-key
+AWS_SECRET_ACCESS_KEY=your-aws-secret
 ```
-src/
-├── auth.ts           # Authentication utilities
-├── core-schema.ts    # Core GraphQL schema definitions
-├── types/           # TypeScript type definitions
-├── registry/        # Registry related functionality
-├── postgres/        # PostgreSQL database integrations
-├── redis/           # Redis client and utilities
-├── bullmq/          # Queue management
-├── mcp/             # MCP related functionality
-├── chunking/        # Data chunking utilities
-└── evals/           # Evaluation utilities
+
+#### Frontend Environment Variables
+
+```env
+# API Configuration
+NEXT_PUBLIC_API_URL=http://localhost:9001
+NEXT_PUBLIC_GRAPHQL_URL=http://localhost:9001/graphql
+
+# Authentication
+NEXTAUTH_URL=http://localhost:3020
+NEXTAUTH_SECRET=your-nextauth-secret
 ```
 
-## License
+### Development Guidelines
+
+- Follow TypeScript best practices
+- Use conventional commits
+- Write comprehensive tests
+- Update documentation
+- Follow the existing code style
+
+## 📄 License
+
+This project is licensed under a private license - see the [LICENSE](LICENSE) file for details.
+
+## 👥 Authors
+
+- **Qventu Bv.** - *Initial work*
+
+---
 
-Private - Qventu Bv.
+<div align="center">
 
-## Author
+**Exulu** - Intelligence Management Platform
 
-Qventu Bv.
+</div>

package/commitlint.config.js

@@ -0,0 +1,4 @@
+export default {
+    extends: ['@commitlint/config-conventional'],
+    parserPreset: "conventional-changelog-atom"
+};