🚀 Introducing @alyvro/api-service

A minimal yet powerful service for managing HTTP requests on the client and handling them gracefully on the server.
No complicated setup. Just plug in your keys — and you’re ready to go. ⚡

✨ Why @alyvro/api-service?

🔗 Built on top of Axios
⚡ Express middleware support for centralized request handling
🤖 Automatic error reporting to Telegram
🧩 Flexible Plugin System (Cache, Compressor, Retry, AbortController, …)
🛡️ Global Error Handling (like interceptors, but unified)
🔒 Secure payload encryption and gzip compression for optimization

📦 Installation

        
          bash
          
        
      pnpm add @alyvro/api-service
# or
npm install @alyvro/api-service
# or
yarn add @alyvro/api-service

🖥 Client Usage

        
          ts
          
        
      import { ApiService } from "@alyvro/api-service";
import { cache } from "@alyvro/api-service/plugins";

const api = new ApiService({
  api_url: "https://your-backend.com/api",
});

api.client.request.post(
  "/user",
  { username: "alyvro" },
  {
    secret: {
      body: true,
    },
    plugins: {
      cache,
      compressor: true,
      retry: { retries: 3, retryDelay: 1000, backoff: true },
    },
  }
);

✅ cache → stores and reuses previous responses
✅ compressor → sends requests in gzip format
✅ retry → automatically retries requests with delay & backoff
✅ createAbortController → cancel requests when needed

🌐 Server Usage (Express Middleware)

        
          ts
          
        
      import express from "express";
import { ApiService } from "@alyvro/api-service";

const app = express();

const api = new ApiService({
  api_url: "https://your-backend.com/api",
  settings: {
    telegram: true, // enable Telegram error reporting
  },
});

app.use((req, res, next) =>
  api.server.middleware(req, res, next, {
    skip_routers: ["/health", "/metrics"], // exclude routes from middleware
  })
);

app.get("/", (req, res) => {
  res.json({ message: "Hello Alyvro 🚀" });
});

🧩 Plugin System

Plugin	Description
Cache	Prevents duplicate requests by caching responses
Compressor	Compresses requests and responses with gzip
Retry	Retries failed requests with delay/backoff options
AbortController	Allows cancellation of ongoing requests

📡 Telegram Error Reporting

Just set TELEGRAM_TOKEN and TELEGRAM_CHAT_ID in your environment.
From now on, every server error will be sent straight to your Telegram DM (or group). 🤯