Home

Core Documentation

Welcome to the Core documentation. Below is the directory of all available packages grouped by their ecosystem family.

Architecture Overview

flowchart TD
    classDef data fill:#e8f5e9,stroke:#1b5e20,stroke-width:2px,color:#000
    classDef queue fill:#fff3e0,stroke:#e65100,stroke-width:2px,color:#000
    classDef cloud fill:#f3e5f5,stroke:#4a148c,stroke-width:2px,color:#000
    classDef api fill:#e0f7fa,stroke:#006064,stroke-width:2px,color:#000
    classDef ai fill:#fffde7,stroke:#f57f17,stroke-width:2px,color:#000
    classDef ui fill:#f1f8e9,stroke:#33691e,stroke-width:2px,color:#000
    classDef abstraction fill:#fff,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5,color:#000
    classDef foundation fill:#eceff1,stroke:#37474f,stroke-width:2px,color:#000

    subgraph AI_Ecosystem ["🧠 AI & Intelligent Agents"]
        ai([🧩 ai]):::abstraction
        ai_gemini[✨ ai-gemini]:::ai
        ai --- ai_gemini
    end

    subgraph UI_Ecosystem ["🎨 User Interface (UI)"]
        ui_pkg([🧩 ui]):::abstraction
        ui_form[📝 ui-form]:::ui
        ui_form_react[⚛️ ui-form-react]:::ui
        ui_list[📊 ui-list]:::ui
        ui_list_react[⚛️ ui-list-react]:::ui
        
        ui_pkg --- ui_form & ui_list
        ui_form --- ui_form_react
        ui_list --- ui_list_react
    end

    subgraph API_Ecosystem ["🌐 APIs & Web Servers"]
        api_pkg([🧩 api]):::abstraction
        api_client[📡 api-client]:::api
        api_server[🖥️ api-server]:::api
        api_server_express[🚀 api-server-express]:::api
        backend_rest[🔌 backend-restapi]:::api
        gateway_upstream[🔀 gateway-upstream-express]:::api
        
        api_pkg --- api_client & api_server & backend_rest
        api_server --- api_server_express
        api_server --- gateway_upstream
    end

    subgraph Cloud_Ecosystem ["☁️ Auth & Cloud"]
        cloudwrapper([🧩 cloudwrapper]):::abstraction
        auth([🧩 auth]):::abstraction
        cloudwrapper_fb[🔥 cloudwrapper-firebase]:::cloud
        cloudwrapper_sb[⚡ cloudwrapper-supabase]:::cloud
        auth_fb[🔥 auth-firebase]:::cloud
        auth_sb[⚡ auth-supabase]:::cloud
        auth_basic[🔑 auth-basic]:::cloud
        auth_oidc[🆔 auth-oidc]:::cloud
        auth_pocket[📦 auth-pocketbase]:::cloud
        
        cloudwrapper --- cloudwrapper_fb & cloudwrapper_sb
        auth --- auth_fb & auth_sb & auth_basic & auth_oidc & auth_pocket
    end

    subgraph Messaging_Ecosystem ["📨 Queue & Messaging"]
        queue([🧩 queue]):::abstraction
        messaging([🧩 messaging]):::abstraction
        queue_amqp[🐇 queue-amqp]:::queue
        queue_aws[☁️ queue-aws]:::queue
        queue_gcp[🌐 queue-gcp]:::queue
        messaging_fb[🔥 messaging-firebase]:::queue
        
        queue --- queue_amqp & queue_aws & queue_gcp
        messaging --- messaging_fb
    end

    subgraph Data_Ecosystem ["🗄️ Storage, Data & Cache"]
        backend([🧩 backend]):::abstraction
        storage([🧩 storage]):::abstraction
        cache([🧩 cache]):::abstraction
        
        backend_fs[🔥 backend-firestore]:::data
        backend_pg[🐘 backend-postgres]:::data
        backend_sq[🗃️ backend-sqlite]:::data
        backend_mig[📦 backend-migrations]:::data
        storage_fb[🔥 storage-firebase]:::data
        storage_s3[☁️ storage-s3]:::data
        storage_sb[⚡ storage-supabase]:::data
        storage_loc[📁 storage-local]:::data
        cache_redis[❤️ cache-redis]:::data
        
        backend --- backend_fs & backend_pg & backend_sq & backend_mig
        storage --- storage_fb & storage_s3 & storage_sb & storage_loc
        cache --- cache_redis
    end

    subgraph Foundations_Ecosystem ["🏗️ Foundations"]
        core([⚙️ core]):::foundation
        types([⚙️ types]):::foundation
        log([⚙️ log]):::foundation
        worker([⚙️ worker]):::foundation
        i18n([⚙️ i18n]):::foundation
        testing([⚙️ testing]):::foundation
    end

    worker -. "polls" .-> queue
    backend -. "maps" .-> core
    api_client -. "requests" .-> api_server
    cloudwrapper -. "bootstraps" .-> backend & storage & auth
    ui_form_react -. "renders" .-> core

Loading

Foundations

Base packages handling memory objects, logging, localization, testing, and background worker structures.

Package	Description	Links
core	The foundation of the framework providing in-memory business objects.	Overview How-To
log	Centralized, flexible logging system with custom adapters.	Overview How-To
worker	Toolkit for building daemon processes and reporting progress.	Overview How-To
i18n	Multi-language internationalization registry.	Overview How-To
i18n-en	English language definitions and dictionary pack.	Overview How-To
i18n-fr	French language definitions and dictionary pack.	Overview How-To
testing	Comprehensive test suite helpers and object mocking utilities.	Overview How-To
types	Shared contracts, types, interfaces, and exceptions for Core.	Overview How-To

Storage, Data & Cache

Adapters for relational databases, NoSQL databases, distributed cache, and blob storage.

Package	Description	Links
backend	Persistence layer abstracting database operations.	Overview How-To
backend-firestore	Google Cloud Firestore database adapter.	Overview How-To
backend-postgres	PostgreSQL database adapter (Supabase & RDS).	Overview How-To
backend-sqlite	Local SQLite database adapter for testing.	Overview How-To
backend-migrations	Database schema version control and migration runner.	Overview How-To
storage	Unified file and blob storage abstraction.	Overview How-To
storage-firebase	Firebase Cloud Storage adapter.	Overview How-To
storage-s3	AWS S3 and S3-compatible storage adapter.	Overview How-To
storage-supabase	Supabase Storage adapter.	Overview How-To
storage-local	Local filesystem storage adapter.	Overview How-To
cache	Centralized interface for high-performance memory caching.	Overview How-To
cache-redis	Redis adapter for shared memory caching.	Overview How-To

Queue & Messaging

Asynchronous message queuing, broker integrations, and multi-channel notifications.

Package	Description	Links
queue	Central queue and message broker abstraction.	Overview How-To
queue-amqp	AMQP 0-9-1 adapter for RabbitMQ integration.	Overview How-To
queue-aws	Amazon SQS adapter for serverless queueing.	Overview How-To
queue-gcp	Google Cloud Pub/Sub adapter for global messaging.	Overview How-To
messaging	Unified abstraction for sending emails, SMS, and pushes.	Overview How-To
messaging-firebase	Firebase Cloud Messaging adapter.	Overview How-To

Auth & Cloud

Centralized identity management, authentication systems, and cloud ecosystem bootstrapping wrappers.

Package	Description	Links
auth	Centralized identity and authentication abstraction.	Overview How-To
auth-basic	Basic and API-key identity adapter.	Overview How-To
auth-firebase	Firebase Authentication adapter.	Overview How-To
auth-supabase	Supabase Authentication adapter.	Overview How-To
auth-oidc	OpenID Connect (OIDC) identity provider adapter.	Overview How-To
auth-pocketbase	PocketBase authentication and database adapter.	Overview How-To
cloudwrapper	Unified entry point to initialize multiple cloud adapters.	Overview How-To
cloudwrapper-firebase	Firebase ecosystem wrapper.	Overview How-To
cloudwrapper-supabase	Supabase ecosystem wrapper.	Overview How-To

APIs & Web Servers

Framework for developing RESTful APIs, HTTP controllers, and web routing gateways.

Package	Description	Links
api	Modern API request/response structures and standard handlers.	Overview How-To
api-client	Centralized HTTP API client for consuming Core services.	Overview How-To
api-server	Abstract web server controller and router engine.	Overview How-To
api-server-express	Express.js adapter for Core API servers.	Overview How-To
gateway-upstream-express	Express middleware routing to upstream service instances.	Overview How-To
backend-restapi	REST API-backed data persistence adapter.	Overview How-To
backend-restapi-recipes	Reusable pre-packaged backend endpoints and logic recipes.	Overview How-To

AI & Intelligent Agents

Natural language processing interface supporting generative AI models and embeddings.

Package	Description	Links
ai	Unified AI abstraction for text generation, embeddings, and chat.	Overview How-To
ai-gemini	Google Gemini adapter for the Core AI system.	Overview How-To

Developer Tools & Studio

Toolkits for local command line execution, live modeling environments, and GitHub automation.

Package	Description	Links
app	Unified application container and startup lifecycle runner.	Overview How-To
core-cli	Developer command-line tool suite for project management.	Overview How-To
studio	Local developer visual environment and modeling dashboard.	Overview How-To
code	Dynamic code compilation and script execution engine.	Overview How-To
code-github	GitHub API adapter for workspace integration.	Overview How-To

User Interface (UI)

Reusable component architectures, dynamic validation layouts, and React list components.

Package	Description	Links