fluxion-ts 0.0.6 → 0.0.8

package/dist/index.d.ts

@@ -0,0 +1,126 @@
+import http from 'node:http';
+
+type LogLevel = 'INFO' | 'WARN' | 'ERROR' | 'SUCC';
+interface LogEntry {
+    timestamp: string;
+    level: LogLevel;
+    event: string;
+    message?: string;
+    [key: string]: unknown;
+}
+type LoggerMode = 'one-line' | 'json-line';
+type LoggerSink = (entry: LogEntry) => void;
+type LoggerOption = LoggerMode | LoggerSink;
+
+/**
+ * Worker runtime tuning options.
+ */
+interface ExecutorOptions {
+    /**
+     * Request timeout in milliseconds.
+     */
+    requestTimeoutMs: number;
+    /**
+     * Maximum concurrent requests allowed in the pool.
+     */
+    maxInflight: number;
+    /**
+     * Soft heap threshold in MB. Idle worker may restart after crossing it.
+     */
+    memorySoftLimitMb: number;
+    /**
+     * ! Hard heap threshold in MB. Worker is restarted once reached.
+     */
+    memoryHardLimitMb: number;
+    /**
+     * Memory telemetry interval in milliseconds.
+     */
+    memorySampleIntervalMs: number;
+    /**
+     * ! V8 old-generation limit per worker in MB.
+     */
+    maxOldGenerationSizeMb: number;
+    /**
+     * ! V8 young-generation limit per worker in MB.
+     */
+    maxYoungGenerationSizeMb: number;
+    /**
+     * Worker stack size in MB.
+     */
+    stackSizeMb: number;
+    /**
+     * ! Maximum response payload bytes allowed from worker to main thread.
+     */
+    maxResponseBytes: number;
+}
+/**
+ * Custom worker item used by `workerStrategy`.
+ */
+interface WorkerStrategyCustomItem extends Partial<ExecutorOptions> {
+    /**
+     * Stable worker id.
+     */
+    id: string;
+    /**
+     * Database names this worker can access.
+     */
+    db: string[];
+}
+/**
+ * Worker strategy selector.
+ */
+type WorkerStrategy = 'all' | WorkerStrategyCustomItem[];
+
+/**
+ * Database config item accepted by server options.
+ */
+interface FluxionDatabaseConfig {
+    /**
+     * Stable database name.
+     */
+    name: string;
+}
+/**
+ * User-provided database config input.
+ */
+type FluxionDatabaseInput = string | FluxionDatabaseConfig;
+interface FluxionOptions {
+    /**
+     * The directory where dynamic files (e.g. uploaded files) will be stored. It will be created if it doesn't exist.
+     * It is recommended to use an empty directory that is not used for any other purpose, to avoid potential conflicts or security issues.
+     */
+    dir: string;
+    host: string;
+    port: number;
+    /**
+     * Declared database names used by worker strategy routing.
+     */
+    databases?: FluxionDatabaseInput[];
+    /**
+     * Optional path to private db config file.
+     * Defaults to `./.fluxion-private/db.config.cjs`.
+     */
+    dbConfigPath?: string;
+    /**
+     * Worker routing strategy.
+     */
+    workerStrategy?: WorkerStrategy;
+    /**
+     * Base worker runtime option overrides.
+     */
+    workerOptions?: Partial<ExecutorOptions>;
+    /**
+     * Maximum request body bytes accepted by dynamic handlers.
+     * Requests larger than this limit will return 413.
+     */
+    maxRequestBytes?: number;
+    /**
+     * Logger output mode or custom logger sink.
+     * Defaults to `one-line`.
+     */
+    logger?: LoggerOption;
+}
+declare function fluxion(options: FluxionOptions): http.Server;
+
+export { fluxion };
+export type { FluxionOptions };