aYOUne Interfaces

A comprehensive TypeScript interfaces library for the aYOUne platform - a modular business as a Service platform.

Overview

This library provides TypeScript type definitions and data exports for the aYOUne platform, which includes modules for:

• AI - Artificial Intelligence services
• CRM - Customer Relationship Management
• CMS - Content Management System
• Marketing - Marketing automation and campaigns
• Automation - Business process automation
• PM - Project Management
• E-commerce - Online store management
• And many more specialized modules

Installation

npm install @tolinax/ayoune-interfaces

Usage

Importing Interfaces

import { IAPI, ITicket, IaYOUneUser } from '@tolinax/ayoune-interfaces';

// Use interfaces for type safety
const api: IAPI = {
  _customerID: "customer123",
  _clientID: [],
  _subID: [],
  _user: "user456",
  name: "My API",
  callback_url: "https://example.com/callback",
  access_token: "token123",
  access_token_key: "key456",
  active: true,
  scopes: [{ key: "read" }],
  limit: false,
  rateLimit: 1000
};

Importing Data and Enums

import { aYOUneServices, aYOUneModules, aMN } from '@tolinax/ayoune-interfaces';

// Access service definitions
console.log(aYOUneServices); // Array of all aYOUne services with hosts

// Access module definitions  
console.log(aYOUneModules); // Array of platform modules

// Use model names enum
const collectionName = aMN.AIConversations; // "AIConversations"

API Reference

Core Interfaces

All interfaces extend IDefaultFields which provides common MongoDB document fields:

• _id: ObjectId
• created: Date
• updated: Date
• Other standard database fields

Data Exports

Services (aYOUneServices)

Array of service definitions with:

• label: Human-readable service name
• module: Associated platform module
• host: Service hostname

Modules (aYOUneModules)

Array of platform modules with:

• label: Module display name
• module: Module identifier
• host: Module hostname

Model Names (aMN)

Enum containing all MongoDB collection names used across the platform.

Development

Building

npm run build

Release

This project uses conventional commits and automated releases:

npm run release

Platform Architecture

The aYOUne platform consists of multiple specialized services:

• Global Services: Middleware, Datatables, Barcodes, Scripts
• AI Services: Text/Image/Video Generation, Text-to-Speech
• CMS Services: Media, Content Snippets, Dynamic Content
• Business Services: CRM, PM, Marketing, Automation
• Analytics: Statistics, Monitoring, Reporting
• E-commerce: Sales, Purchase, Accounting

Each service is independently deployable and communicates through well-defined interfaces provided by this library.

Contributing

1. Follow conventional commit format (feat:, fix:, docs:, etc.)
2. All interfaces should extend IDefaultFields when appropriate
3. Use consistent naming: interfaces start with I, data exports use descriptive names
4. Update CHANGELOG.md entries are generated automatically

License

LGPL-3.0 © tolinax