Home

Quatrain Core Documentation

Welcome to the Quatrain 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 abstraction fill:#fff,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5,color:#000

    subgraph Cloud ["☁️ 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
        
        cloudwrapper --- cloudwrapper_fb
        cloudwrapper --- cloudwrapper_sb
        cloudwrapper_fb ~~~ cloudwrapper_sb
        
        auth --- auth_fb
        auth --- auth_sb
        auth_fb ~~~ auth_sb
    end

    subgraph Messaging ["📨 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 --- queue_aws
        queue --- queue_gcp
        queue_amqp ~~~ queue_aws
        queue_aws ~~~ queue_gcp
        
        messaging --- messaging_fb
    end

    subgraph Data ["🗄️ Storage & Data"]
        backend([🧩 backend]):::abstraction
        storage([🧩 storage]):::abstraction
        backend_fs[🔥 backend-firestore]:::data
        backend_pg[🐘 backend-postgres]:::data
        backend_sq[🗃️ backend-sqlite]:::data
        storage_fb[🔥 storage-firebase]:::data
        storage_s3[☁️ storage-s3]:::data
        storage_sb[⚡ storage-supabase]:::data
        
        backend --- backend_fs
        backend --- backend_pg
        backend --- backend_sq
        backend_fs ~~~ backend_pg
        backend_pg ~~~ backend_sq
        
        storage --- storage_fb
        storage --- storage_s3
        storage --- storage_sb
        storage_fb ~~~ storage_s3
        storage_s3 ~~~ storage_sb
    end

    subgraph Foundations ["🏗️ Foundations"]
        core([⚙️ core]):::abstraction
        log([⚙️ log]):::abstraction
        worker([⚙️ worker]):::abstraction
        
        core ~~~ log
        log ~~~ worker
    end

    worker -. "listens to" .-> queue
    backend -. "persists" .-> core
    cloudwrapper -. "initializes" .-> backend & storage & auth

Loading

Foundations

Base packages handling memory objects, logging, 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

Storage & Data

Tools to interact with databases and blob storage seamlessly.

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
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

Queue & Messaging

Asynchronous communication packages to dispatch jobs and 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

Authentication and wrappers to initialize entire ecosystems easily.

Package	Description	Links
auth	Centralized identity and authentication abstraction.	Overview How-To
auth-firebase	Firebase Authentication adapter.	Overview How-To
auth-supabase	Supabase Authentication 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