astro-routify 1.0.0 → 1.2.0

package/dist/core/responseHelpers.js

@@ -1,16 +1,84 @@
+/**
+ * Internal helper to build a typed `ResultResponse`.
+ * @param status - HTTP status code
+ * @param body - Optional response body
+ * @param headers - Optional headers
+ */
 function createResponse(status, body, headers) {
     return { status, body, headers };
 }
+/**
+ * 200 OK
+ */
 export const ok = (body, headers) => createResponse(200, body, headers);
+/**
+ * 201 Created
+ */
 export const created = (body, headers) => createResponse(201, body, headers);
+/**
+ * 204 No Content
+ */
 export const noContent = (headers) => createResponse(204, undefined, headers);
+/**
+ * 304 Not Modified
+ */
 export const notModified = (headers) => createResponse(304, undefined, headers);
+/**
+ * 400 Bad Request
+ */
 export const badRequest = (body = 'Bad Request', headers) => createResponse(400, body, headers);
+/**
+ * 401 Unauthorized
+ */
 export const unauthorized = (body = 'Unauthorized', headers) => createResponse(401, body, headers);
+/**
+ * 403 Forbidden
+ */
 export const forbidden = (body = 'Forbidden', headers) => createResponse(403, body, headers);
+/**
+ * 404 Not Found
+ */
 export const notFound = (body = 'Not Found', headers) => createResponse(404, body, headers);
+/**
+ * 405 Method Not Allowed
+ */
 export const methodNotAllowed = (body = 'Method Not Allowed', headers) => createResponse(405, body, headers);
+/**
+ * 500 Internal Server Error
+ */
 export const internalError = (err, headers) => createResponse(500, err instanceof Error ? err.message : String(err), headers);
+/**
+ * Sends a binary or stream-based file response with optional content-disposition.
+ *
+ * @param content - The file data (Blob, ArrayBuffer, or stream)
+ * @param contentType - MIME type of the file
+ * @param fileName - Optional download filename
+ * @param headers - Optional extra headers
+ * @returns A ResultResponse for download-ready content
+ */
+export const fileResponse = (content, contentType, fileName, headers) => {
+    const disposition = fileName
+        ? { 'Content-Disposition': `attachment; filename="${fileName}"` }
+        : {};
+    return {
+        status: 200,
+        body: content,
+        headers: {
+            'Content-Type': contentType,
+            ...disposition,
+            ...headers,
+        },
+    };
+};
+/**
+ * Converts an internal `ResultResponse` into a native `Response` object
+ * for use inside Astro API routes.
+ *
+ * Automatically applies `Content-Type: application/json` for object bodies.
+ *
+ * @param result - A ResultResponse returned from route handler
+ * @returns A native Response
+ */
 export function toAstroResponse(result) {
     if (!result)
         return new Response(null, { status: 204 });

package/dist/core/stream.d.ts

@@ -0,0 +1,75 @@
+import type { APIContext } from 'astro';
+import { type Route } from './defineRoute';
+import { HttpMethod } from './HttpMethod';
+import { HeadersInit } from 'undici';
+/**
+ * A writer for streaming raw data to the response body.
+ *
+ * This is used inside the `stream()` route handler to emit bytes
+ * or strings directly to the client with backpressure awareness.
+ */
+export interface StreamWriter {
+    /**
+     * Write a string or Uint8Array chunk to the response stream.
+     * @param chunk - Text or byte chunk to emit
+     */
+    write: (chunk: string | Uint8Array) => void;
+    /**
+     * Close the stream and signal end-of-response to the client.
+     */
+    close: () => void;
+    /**
+     * Dynamically change the Content-Type header.
+     * Should be called before the first `write()` to take effect.
+     * @param type - MIME type (e.g., `text/html`, `application/json`)
+     */
+    setContentType: (type: string) => void;
+}
+/**
+ * Configuration options for the `stream()` route helper.
+ */
+export interface StreamOptions {
+    /**
+     * HTTP method (defaults to GET).
+     */
+    method?: HttpMethod;
+    /**
+     * Content-Type header (defaults to `text/event-stream`).
+     */
+    contentType?: string;
+    /**
+     * Additional custom headers.
+     */
+    headers?: HeadersInit;
+    /**
+     * Enable SSE keep-alive headers (defaults to true for SSE).
+     */
+    keepAlive?: boolean;
+}
+/**
+ * Defines a generic streaming route that can write raw chunks of data
+ * to the response in real time using a `ReadableStream`.
+ *
+ * Suitable for Server-Sent Events (SSE), long-polling, streamed HTML,
+ * logs, LLM output, or NDJSON responses.
+ *
+ * @example
+ * stream('/clock', async ({ response }) => {
+ *   const timer = setInterval(() => {
+ *     response.write(`data: ${new Date().toISOString()}\n\n`);
+ *   }, 1000);
+ *
+ *   setTimeout(() => {
+ *     clearInterval(timer);
+ *     response.close();
+ *   }, 5000);
+ * });
+ *
+ * @param path - The route path (e.g. `/clock`)
+ * @param handler - Handler that receives the API context and response writer
+ * @param options - Optional stream configuration
+ * @returns A Route object ready to be used in `defineRouter()`
+ */
+export declare function stream(path: string, handler: (ctx: APIContext & {
+    response: StreamWriter;
+}) => void | Promise<void>, options?: StreamOptions): Route;

package/dist/core/stream.js

@@ -0,0 +1,91 @@
+import { defineRoute } from './defineRoute';
+import { HttpMethod } from './HttpMethod';
+/**
+ * Defines a generic streaming route that can write raw chunks of data
+ * to the response in real time using a `ReadableStream`.
+ *
+ * Suitable for Server-Sent Events (SSE), long-polling, streamed HTML,
+ * logs, LLM output, or NDJSON responses.
+ *
+ * @example
+ * stream('/clock', async ({ response }) => {
+ *   const timer = setInterval(() => {
+ *     response.write(`data: ${new Date().toISOString()}\n\n`);
+ *   }, 1000);
+ *
+ *   setTimeout(() => {
+ *     clearInterval(timer);
+ *     response.close();
+ *   }, 5000);
+ * });
+ *
+ * @param path - The route path (e.g. `/clock`)
+ * @param handler - Handler that receives the API context and response writer
+ * @param options - Optional stream configuration
+ * @returns A Route object ready to be used in `defineRouter()`
+ */
+export function stream(path, handler, options) {
+    const method = options?.method ?? HttpMethod.GET;
+    return defineRoute(method, path, async (ctx) => {
+        let contentType = options?.contentType ?? 'text/event-stream';
+        const encoder = new TextEncoder();
+        let controllerRef = null;
+        let closed = false;
+        const writer = {
+            write: (chunk) => {
+                if (closed || !controllerRef)
+                    return;
+                const bytes = typeof chunk === 'string' ? encoder.encode(chunk) : chunk;
+                controllerRef.enqueue(bytes);
+            },
+            close: () => {
+                if (closed)
+                    return;
+                closed = true;
+                try {
+                    controllerRef?.close();
+                }
+                catch { /* noop */ }
+            },
+            setContentType: (type) => {
+                contentType = type;
+            },
+        };
+        const body = new ReadableStream({
+            start(controller) {
+                controllerRef = controller;
+                Promise.resolve(handler({ ...ctx, response: writer }))
+                    .catch((err) => {
+                    try {
+                        controller.error(err);
+                    }
+                    catch { /* noop */ }
+                });
+                ctx.request.signal.addEventListener('abort', () => {
+                    closed = true;
+                    controller.close();
+                    console.debug('Request aborted — streaming stopped.');
+                });
+            },
+            cancel() {
+                closed = true;
+                console.debug('Stream cancelled explicitly.');
+            },
+        });
+        const defaultSseHeaders = contentType === 'text/event-stream' && options?.keepAlive !== false
+            ? {
+                'Cache-Control': 'no-cache',
+                'Connection': 'keep-alive',
+                'X-Accel-Buffering': 'no',
+            }
+            : {};
+        return new Response(body, {
+            status: 200,
+            headers: {
+                'Content-Type': contentType,
+                ...defaultSseHeaders,
+                ...(options?.headers ?? {}),
+            },
+        });
+    });
+}

package/dist/core/streamJsonArray.d.ts

@@ -0,0 +1,31 @@
+import type { APIContext } from 'astro';
+import { HttpMethod } from './HttpMethod';
+import { Route } from './defineRoute';
+import { JsonStreamWriter } from './internal/createJsonStreamRoute';
+/**
+ * Defines a JSON streaming route that emits a valid JSON array.
+ *
+ * This helper returns a valid `application/json` response containing
+ * a streamable array of JSON values. Useful for large data exports
+ * or APIs where the full array can be streamed as it's generated.
+ *
+ * Unlike `streamJsonND()`, this wraps all values in `[` and `]`
+ * and separates them with commas.
+ *
+ * @example
+ * streamJsonArray('/users', async ({ response }) => {
+ *   response.send({ id: 1 });
+ *   response.send({ id: 2 });
+ *   response.close();
+ * });
+ *
+ * @param path - The route path (e.g. `/users`)
+ * @param handler - A function that receives `ctx` and a JSON stream writer
+ * @param options - Optional HTTP method override (default is GET)
+ * @returns A Route object ready to be registered with `defineRouter`
+ */
+export declare function streamJsonArray(path: string, handler: (ctx: APIContext & {
+    response: JsonStreamWriter;
+}) => void | Promise<void>, options?: {
+    method?: HttpMethod;
+}): Route;

package/dist/core/streamJsonArray.js

@@ -0,0 +1,30 @@
+import { HttpMethod } from './HttpMethod';
+import { createJsonStreamRoute } from './internal/createJsonStreamRoute';
+/**
+ * Defines a JSON streaming route that emits a valid JSON array.
+ *
+ * This helper returns a valid `application/json` response containing
+ * a streamable array of JSON values. Useful for large data exports
+ * or APIs where the full array can be streamed as it's generated.
+ *
+ * Unlike `streamJsonND()`, this wraps all values in `[` and `]`
+ * and separates them with commas.
+ *
+ * @example
+ * streamJsonArray('/users', async ({ response }) => {
+ *   response.send({ id: 1 });
+ *   response.send({ id: 2 });
+ *   response.close();
+ * });
+ *
+ * @param path - The route path (e.g. `/users`)
+ * @param handler - A function that receives `ctx` and a JSON stream writer
+ * @param options - Optional HTTP method override (default is GET)
+ * @returns A Route object ready to be registered with `defineRouter`
+ */
+export function streamJsonArray(path, handler, options) {
+    return createJsonStreamRoute(path, handler, {
+        mode: 'array',
+        method: options?.method ?? HttpMethod.GET,
+    });
+}

package/dist/core/streamJsonND.d.ts

@@ -0,0 +1,34 @@
+import type { APIContext } from 'astro';
+import { HttpMethod } from './HttpMethod';
+import { Route } from './defineRoute';
+import { JsonStreamWriter } from './internal/createJsonStreamRoute';
+/**
+ * Defines a JSON streaming route using NDJSON (Newline Delimited JSON) format.
+ *
+ * This helper streams individual JSON objects separated by newlines (`\n`)
+ * instead of a single JSON array. It sets the `Content-Type` to
+ * `application/x-ndjson` and disables buffering to allow low-latency
+ * delivery of each item.
+ *
+ * Ideal for real-time updates, event logs, progressive loading, or
+ * integrations with LLMs or dashboards where each object can be processed
+ * as soon as it's received.
+ *
+ * @example
+ * streamJsonND('/events', async ({ response }) => {
+ *   response.send({ type: 'start' });
+ *   await delay(100);
+ *   response.send({ type: 'progress', percent: 25 });
+ *   response.close();
+ * });
+ *
+ * @param path - The route path (e.g. `/events`)
+ * @param handler - A function that receives `ctx` and a JSON stream writer
+ * @param options - Optional HTTP method override (default is GET)
+ * @returns A Route object ready to be registered with `defineRouter`
+ */
+export declare function streamJsonND(path: string, handler: (ctx: APIContext & {
+    response: JsonStreamWriter;
+}) => void | Promise<void>, options?: {
+    method?: HttpMethod;
+}): Route;

package/dist/core/streamJsonND.js

@@ -0,0 +1,33 @@
+import { HttpMethod } from './HttpMethod';
+import { createJsonStreamRoute } from './internal/createJsonStreamRoute';
+/**
+ * Defines a JSON streaming route using NDJSON (Newline Delimited JSON) format.
+ *
+ * This helper streams individual JSON objects separated by newlines (`\n`)
+ * instead of a single JSON array. It sets the `Content-Type` to
+ * `application/x-ndjson` and disables buffering to allow low-latency
+ * delivery of each item.
+ *
+ * Ideal for real-time updates, event logs, progressive loading, or
+ * integrations with LLMs or dashboards where each object can be processed
+ * as soon as it's received.
+ *
+ * @example
+ * streamJsonND('/events', async ({ response }) => {
+ *   response.send({ type: 'start' });
+ *   await delay(100);
+ *   response.send({ type: 'progress', percent: 25 });
+ *   response.close();
+ * });
+ *
+ * @param path - The route path (e.g. `/events`)
+ * @param handler - A function that receives `ctx` and a JSON stream writer
+ * @param options - Optional HTTP method override (default is GET)
+ * @returns A Route object ready to be registered with `defineRouter`
+ */
+export function streamJsonND(path, handler, options) {
+    return createJsonStreamRoute(path, handler, {
+        mode: 'ndjson',
+        method: options?.method ?? HttpMethod.GET,
+    });
+}