@gravito/ripple 3.0.1 → 4.0.0

package/dist/photon/src/index.d.ts

@@ -1,20 +1,84 @@
 /**
- * @gravito/photon - High-performance web framework based on Hono.
+ * @gravito/photon - High-performance web engine for the Gravito Galaxy Architecture.
  *
- * Photon is the primary web engine for Gravito, providing a fast,
- * flexible, and standard-compliant API for building web applications.
- * It re-exports Hono while adding enterprise-grade middleware and utilities.
+ * Photon serves as the foundational HTTP layer for Gravito, providing an ultra-fast,
+ * type-safe routing system based on Hono. It is designed to be the "light" that
+ * connects Satellites (domain plugins) and Orbits (infrastructure) within the ecosystem.
+ *
+ * Key features:
+ * - Zero-overhead routing and middleware.
+ * - Full TypeScript inference for request parameters and body.
+ * - Built-in support for HTMX and binary (CBOR) protocols.
  *
  * @example
  * ```typescript
  * import { Photon } from '@gravito/photon'
+ *
  * const app = new Photon()
- * app.get('/', (c) => c.text('Hello!'))
+ *
+ * app.get('/welcome', (c) => c.text('Welcome to the Galaxy!'))
+ *
+ * export default app
  * ```
+ * @packageDocumentation
  */
 export * from 'hono';
+/**
+ * The primary application class for Photon.
+ *
+ * An alias for `Hono`, providing the core routing and middleware capabilities.
+ * Use this to define your API structure and mount domain-specific Satellites.
+ *
+ * @remarks
+ * Photon extends Hono's capabilities with Gravito-specific optimizations.
+ * It serves as the entry point for defining routes, applying middleware,
+ * and handling the request-response lifecycle.
+ *
+ * @example
+ * ```typescript
+ * const app = new Photon()
+ *
+ * // Basic routing
+ * app.get('/api/health', (c) => c.json({ status: 'ok' }))
+ *
+ * // Middleware integration
+ * app.use('/api/*', myMiddleware)
+ *
+ * // Mounting sub-routers
+ * app.route('/v1', v1Router)
+ * ```
+ * @public
+ */
 export { Hono as Photon } from 'hono';
 /**
  * Binary-related middleware for Photon.
+ *
+ * Provides utilities for handling binary data formats like CBOR,
+ * optimizing payload size and serialization speed for high-performance APIs.
+ *
+ * @public
  */
 export * from './middleware/binary';
+/**
+ * HTMX-related middleware for Photon.
+ *
+ * Enhances Photon with first-class support for HTMX, including
+ * automatic request detection and simplified header access for hypermedia-driven UIs.
+ *
+ * @public
+ */
+export * from './middleware/htmx';
+/**
+ * Rate limiting middleware for Photon.
+ *
+ * Provides built-in rate limiting with token bucket and sliding window strategies.
+ * Supports both memory-based and custom storage backends.
+ *
+ * @public
+ */
+export * from './middleware/ratelimit';
+/**
+ * OpenAPI utilities
+ * @public
+ */
+export * from './openapi';

package/dist/photon/src/middleware/binary.d.ts

@@ -1,10 +1,17 @@
 import type { MiddlewareHandler } from 'hono';
 /**
- * Binary Middleware for Photon
+ * Binary Middleware for Photon.
  *
  * Automatically detects 'Accept: application/cbor' and encodes
  * JSON responses using the CBOR binary format for high-performance communication.
  *
+ * @remarks
+ * This middleware is essential for high-frequency API calls where payload size
+ * and serialization speed are critical. It leverages the `cborg` library for
+ * efficient binary encoding.
+ *
+ * @returns A Hono middleware handler that intercepts JSON responses.
+ *
  * @example
  * ```typescript
  * import { Photon } from '@gravito/photon'
@@ -13,22 +20,12 @@ import type { MiddlewareHandler } from 'hono';
  * const app = new Photon()
  * app.use(binaryMiddleware())
  *
- * app.get('/api/data', (c) => c.json({ items: [...] }))
+ * app.get('/api/data', (c) => c.json({ items: [1, 2, 3] }))
  * ```
  *
  * @performance
- * - CBOR encoding is ~2-3x faster than JSON.stringify for large objects
- * - Binary format reduces payload size by 20-40% on average
- * - Recommended for high-frequency API calls with large datasets
- *
- * @client_usage
- * ```typescript
- * import { decode } from 'cborg'
- *
- * const res = await fetch('/api/data', {
- *   headers: { Accept: 'application/cbor' }
- * })
- * const data = decode(new Uint8Array(await res.arrayBuffer()))
- * ```
+ * - CBOR encoding is ~2-3x faster than JSON.stringify for large objects.
+ * - Binary format reduces payload size by 20-40% on average.
+ * - Optimized to read body directly without clone(), saving ~30% overhead.
  */
 export declare const binaryMiddleware: () => MiddlewareHandler;

package/dist/photon/src/middleware/htmx.d.ts

@@ -0,0 +1,39 @@
+import type { MiddlewareHandler } from 'hono';
+/**
+ * HTMX Middleware for Photon.
+ *
+ * Automatically detects HTMX requests and populates the context with
+ * HTMX-specific headers and state.
+ *
+ * @remarks
+ * This middleware enables hypermedia-driven UIs by providing first-class
+ * support for HTMX. It allows handlers to easily distinguish between
+ * full-page loads and partial updates.
+ *
+ * @returns A Hono middleware handler that populates HTMX context variables.
+ *
+ * @example
+ * ```typescript
+ * import { Photon } from '@gravito/photon'
+ * import { htmxMiddleware } from '@gravito/photon/middleware/htmx'
+ *
+ * const app = new Photon()
+ * app.use(htmxMiddleware())
+ *
+ * app.get('/search', async (c) => {
+ *   // Check if request is from HTMX
+ *   if (c.get('htmx')) {
+ *     return c.html('<div>Search results...</div>')
+ *   }
+ *
+ *   return c.html('<html>...</html>')
+ * })
+ * ```
+ *
+ * @context_variables
+ * - `htmx`: Boolean indicating if the request is an HTMX request.
+ * - `htmx.boosted`: Boolean indicating if the request was boosted.
+ * - `htmx.target`: The ID of the target element.
+ * - `htmx.trigger`: The ID of the trigger element.
+ */
+export declare const htmxMiddleware: () => MiddlewareHandler;

package/dist/photon/src/middleware/ratelimit.d.ts

@@ -0,0 +1,157 @@
+/**
+ * @fileoverview Rate Limiting Middleware for Photon
+ *
+ * Provides token bucket and sliding window rate limiting strategies.
+ * Supports memory-based and Redis-based storage backends.
+ *
+ * @module @gravito/photon/middleware/ratelimit
+ * @since 1.0.0
+ */
+import type { Context, MiddlewareHandler } from '@gravito/photon';
+export interface RateLimitConfig {
+    /**
+     * Maximum number of requests allowed within the time window
+     * @default 100
+     */
+    maxRequests: number;
+    /**
+     * Time window in milliseconds
+     * @default 60000 (1 minute)
+     */
+    windowMs: number;
+    /**
+     * Strategy for rate limiting
+     * - 'token-bucket': Smooth rate limiting with token refill
+     * - 'sliding-window': Time-based window that slides continuously
+     * @default 'token-bucket'
+     */
+    strategy?: 'token-bucket' | 'sliding-window';
+    /**
+     * Custom key generator function
+     * @default (c) => c.req.header('x-forwarded-for') || c.req.header('x-real-ip') || 'unknown'
+     */
+    keyGenerator?: (c: Context) => string | Promise<string>;
+    /**
+     * Storage backend for rate limit state
+     * @default new MemoryStore()
+     */
+    store?: RateLimitStore;
+    /**
+     * Custom handler for rate-limited requests
+     * @default (c) => c.json({ error: 'Too Many Requests', retryAfter: <seconds> }, 429)
+     */
+    onRateLimitExceeded?: (c: Context, retryAfter: number) => Response | Promise<Response>;
+    /**
+     * Skip rate limiting for certain requests
+     * @default undefined
+     */
+    skip?: (c: Context) => boolean | Promise<boolean>;
+    /**
+     * Custom headers to include in responses
+     * @default true
+     */
+    standardHeaders?: boolean;
+    /**
+     * Include draft RateLimit headers (RateLimit-*)
+     * @default false
+     */
+    draftHeaders?: boolean;
+}
+export interface RateLimitStore {
+    /**
+     * Increment request count and return current state
+     */
+    increment(key: string): Promise<RateLimitState>;
+    /**
+     * Reset the rate limit for a key
+     */
+    reset(key: string): Promise<void>;
+    /**
+     * Get current state without incrementing
+     */
+    get(key: string): Promise<RateLimitState | null>;
+}
+export interface RateLimitState {
+    /**
+     * Number of requests made in current window
+     */
+    count: number;
+    /**
+     * Timestamp when the window expires (ms)
+     */
+    resetTime: number;
+    /**
+     * Remaining requests allowed
+     */
+    remaining: number;
+}
+export declare class MemoryStore implements RateLimitStore {
+    private config;
+    private store;
+    private cleanupInterval;
+    constructor(config: {
+        maxRequests: number;
+        windowMs: number;
+    }, cleanupIntervalMs?: number);
+    increment(key: string): Promise<RateLimitState>;
+    reset(key: string): Promise<void>;
+    get(key: string): Promise<RateLimitState | null>;
+    /**
+     * Cleanup resources
+     */
+    destroy(): void;
+}
+/**
+ * Create a rate limiting middleware
+ *
+ * @example
+ * ```typescript
+ * import { Photon } from '@gravito/photon'
+ * import { rateLimit } from '@gravito/photon/middleware'
+ *
+ * const app = new Photon()
+ *
+ * // Basic usage: 100 requests per minute
+ * app.use('*', rateLimit({ maxRequests: 100, windowMs: 60000 }))
+ *
+ * // Per-user rate limiting
+ * app.use('/api/*', rateLimit({
+ *   maxRequests: 50,
+ *   windowMs: 60000,
+ *   keyGenerator: (c) => {
+ *     const userId = c.get('userId')
+ *     return userId || c.req.header('x-forwarded-for') || 'anonymous'
+ *   }
+ * }))
+ * ```
+ */
+export declare function rateLimit(config: RateLimitConfig): MiddlewareHandler;
+/**
+ * Convenience factory: Create rate limiter with common presets
+ */
+export declare const createRateLimiter: {
+    /**
+     * Strict: 10 requests per minute
+     */
+    strict: (overrides?: Partial<RateLimitConfig>) => MiddlewareHandler;
+    /**
+     * Moderate: 60 requests per minute
+     */
+    moderate: (overrides?: Partial<RateLimitConfig>) => MiddlewareHandler;
+    /**
+     * Lenient: 100 requests per minute
+     */
+    lenient: (overrides?: Partial<RateLimitConfig>) => MiddlewareHandler;
+    /**
+     * API: 1000 requests per hour
+     */
+    api: (overrides?: Partial<RateLimitConfig>) => MiddlewareHandler;
+    /**
+     * Auth: 5 attempts per 15 minutes (for login endpoints)
+     */
+    auth: (overrides?: Partial<RateLimitConfig>) => MiddlewareHandler;
+};
+/**
+ * Export convenience preset
+ */
+export { createRateLimiter as rateLimiter };

package/dist/photon/src/openapi.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @file packages/photon/src/openapi.ts
+ * @module @gravito/photon/openapi
+ * @description OpenAPI (Swagger) integration for Photon
+ */
+import type { RouteConfig } from '@hono/zod-openapi';
+import { createRoute, OpenAPIHono } from '@hono/zod-openapi';
+import { z } from 'zod';
+/**
+ * Photon Open API Class
+ * Extends OpenAPIHono to provide a seamless OpenAPI integration.
+ */
+export declare class PhotonOpenAPI extends OpenAPIHono {
+    /**
+     * Helper to create a fully typed route definition.
+     */
+    static route(config: RouteConfig): RouteConfig;
+}
+export { createRoute, z };

package/dist/proto/ripple.proto

@@ -0,0 +1,120 @@
+syntax = "proto3";
+
+package ripple;
+
+// -------------------------------------------------------------------
+// Client -> Server Messages
+// -------------------------------------------------------------------
+
+message ClientMessage {
+  string req_id = 1; // Optional request ID for troubleshooting
+
+  oneof payload {
+    SubscribeRequest subscribe = 10;
+    UnsubscribeRequest unsubscribe = 11;
+    WhisperRequest whisper = 12;
+    PingRequest ping = 13;
+    BinaryRequest binary = 14;
+    AckRequest ack = 15;
+  }
+}
+
+message SubscribeRequest {
+  string channel = 1;
+  optional AuthData auth = 2;
+}
+
+message UnsubscribeRequest {
+  string channel = 1;
+}
+
+message WhisperRequest {
+  string channel = 1;
+  string event = 2;
+  // Payload is generic bytes, application needs to decode based on event
+  bytes data = 3; 
+}
+
+message PingRequest {}
+
+message BinaryRequest {
+  string channel = 1;
+  string event = 2;
+  bytes data = 3;
+}
+
+message AckRequest {
+  int32 seq = 1;
+}
+
+message AuthData {
+  string socket_id = 1;
+  string signature = 2;
+}
+
+// -------------------------------------------------------------------
+// Server -> Client Messages
+// -------------------------------------------------------------------
+
+message ServerMessage {
+  oneof payload {
+    ConnectedResponse connected = 10;
+    SubscribedResponse subscribed = 11;
+    UnsubscribedResponse unsubscribed = 12;
+    ErrorResponse error = 13;
+    EventMessage event = 14;
+    PresenceMessage presence = 15;
+    PongResponse pong = 16;
+    BinaryMessage binary = 17;
+    AckReceivedResponse ack_received = 18;
+    ReconnectionTokenMessage reconnection_token = 19;
+  }
+}
+
+message ConnectedResponse {
+  string socket_id = 1;
+}
+
+message SubscribedResponse {
+  string channel = 1;
+}
+
+message UnsubscribedResponse {
+  string channel = 1;
+}
+
+message ErrorResponse {
+  string code = 1;
+  string message = 2;
+  optional string channel = 3;
+}
+
+message EventMessage {
+  string channel = 1;
+  string event = 2;
+  bytes data = 3; // JSON encoded string or raw bytes
+  optional int32 seq = 4;
+  optional bool need_ack = 5;
+}
+
+message PresenceMessage {
+  string channel = 1;
+  string event = 2; // "join", "leave", "members"
+  bytes data = 3;   // JSON encoded user info
+}
+
+message PongResponse {}
+
+message BinaryMessage {
+  string channel = 1;
+  string event = 2;
+  bytes data = 3;
+}
+
+message AckReceivedResponse {
+  int32 seq = 1;
+}
+
+message ReconnectionTokenMessage {
+  string token = 1;
+}

package/dist/ripple/src/OrbitRipple.d.ts

@@ -1,42 +1,64 @@
 import type { GravitoOrbit, PlanetCore } from '@gravito/core';
+import { BroadcastManager } from './events/BroadcastManager';
 import { RippleServer } from './RippleServer';
 import type { RippleConfig } from './types';
 /**
- * OrbitRipple provides native WebSocket support for Gravito.
- * it manages the RippleServer lifecycle, integrates with the core event system,
- * and provides a request-scoped server instance.
+ * OrbitRipple integrates the Ripple WebSocket module into the Gravito framework.
+ *
+ * It handles the registration of the RippleServer in the IoC container,
+ * adds middleware for context access, and manages the server lifecycle.
  *
  * @example
  * ```typescript
- * const ripple = new OrbitRipple({ path: '/realtime' });
- * core.addOrbit(ripple);
+ * import { PlanetCore } from '@gravito/core'
+ * import { OrbitRipple } from '@gravito/ripple'
+ *
+ * const core = new PlanetCore()
+ *
+ * // Install Ripple as an Orbit
+ * core.install(new OrbitRipple({
+ *   path: '/ws',
+ *   authorizer: async (channel, userId) => userId !== undefined
+ * }))
  * ```
- * @public
  */
 export declare class OrbitRipple implements GravitoOrbit {
     private server;
     private config;
     /**
-     * Create a new OrbitRipple instance.
-     * @param config - Configuration options for the WebSocket server.
+     * Create a new OrbitRipple.
+     *
+     * @param config - Ripple configuration options
      */
     constructor(config?: RippleConfig);
     /**
-     * Install the module into PlanetCore
+     * Install the orbit into the Gravito core.
+     *
+     * - Registers 'ripple' (RippleServer) and 'broadcast' (BroadcastManager) in the container.
+     * - Adds middleware to inject 'ripple' and 'broadcast' into GravitoContext.
+     * - Initializes the server and registers shutdown hooks.
+     *
+     * @param core - The PlanetCore instance
      */
     install(core: PlanetCore): void;
     /**
-     * Get the underlying RippleServer instance
+     * Get the underlying RippleServer instance.
+     *
+     * @returns The RippleServer instance
      */
     getServer(): RippleServer;
     /**
-     * Get WebSocket handler for Bun.serve integration
+     * Get the WebSocket handler for Bun.serve.
+     *
+     * @returns The WebSocket handler object
      */
     getHandler(): import("./types").WebSocketHandlerConfig;
 }
 declare module '@gravito/core' {
     interface GravitoVariables {
-        /** Ripple WebSocket server */
+        /** RippleServer instance available in context */
         ripple?: RippleServer;
+        /** BroadcastManager instance available in context */
+        broadcast?: BroadcastManager;
     }
 }