@farm.js/core 0.1.51-beta.3 → 0.1.61

package/dist/workflows.d-CRMzQZ3k.d.ts

@@ -1,188 +0,0 @@
-interface FarmNodeAbortRequest {
-    aborted?: boolean;
-    once(event: "aborted", listener: () => void): unknown;
-    off(event: "aborted", listener: () => void): unknown;
-}
-interface FarmNodeAbortResponse {
-    writableEnded: boolean;
-    once(event: "close" | "finish", listener: () => void): unknown;
-    off(event: "close" | "finish", listener: () => void): unknown;
-}
-/** Share disconnect semantics between development and production Node requests. */
-declare function createFarmNodeRequestAbortSignal(req: FarmNodeAbortRequest, res: FarmNodeAbortResponse): AbortSignal;
-type FarmServerDuration = number | `${number}${"ms" | "s" | "m" | "h"}`;
-interface FarmServerHealthConfig {
-    /** Liveness endpoint. It remains healthy while a production process drains. */
-    livenessPath?: string;
-    /** Readiness endpoint. It returns 503 until startup completes and while draining. */
-    readinessPath?: string;
-}
-interface ResolvedFarmServerHealthConfig {
-    enabled: boolean;
-    livenessPath: string;
-    readinessPath: string;
-}
-interface FarmServerConfig {
-    /** Maximum request body size for API routes, integrations, workflows, and uploads. */
-    bodySizeLimit?: number | string;
-    /**
-     * Trust proxy-provided client address and request authority headers. Enable only behind a trusted proxy.
-     * The client address is the last `X-Forwarded-For` hop, the one the closest proxy appended.
-     */
-    trustProxy?: boolean;
-    /** Maximum time for a Node client to send complete request headers. */
-    headersTimeout?: FarmServerDuration;
-    /** Maximum time for a Node client to send the complete request. */
-    requestTimeout?: FarmServerDuration;
-    /** How long an idle Node keep-alive connection remains open after a response. */
-    keepAliveTimeout?: FarmServerDuration;
-    /** Maximum time the Node adapter drains traffic before forcing shutdown. */
-    gracefulShutdownTimeout?: FarmServerDuration;
-    /** Production liveness and readiness endpoints. Set to false to disable them. */
-    health?: false | FarmServerHealthConfig;
-}
-interface ResolvedFarmServerConfig {
-    bodySizeLimit: number;
-    trustProxy: boolean;
-    headersTimeout: number;
-    requestTimeout: number;
-    keepAliveTimeout: number;
-    gracefulShutdownTimeout: number;
-    health: ResolvedFarmServerHealthConfig;
-}
-/** Apply the weak entity-tag comparison required by If-None-Match. */
-declare function matchesFarmIfNoneMatch(value: string | readonly string[] | null | undefined, etag: string): boolean;
-declare function resolveFarmServerConfig(config: FarmServerConfig | ResolvedFarmServerConfig | undefined): ResolvedFarmServerConfig;
-declare function cloneFarmRequestWithContext(request: Request): Request;
-declare function bufferFarmRequestBody(request: Request, limit: number): Promise<Request>;
-declare function readFarmRequestBody(request: Request, limit: number): Promise<Uint8Array>;
-declare function readNodeRequestBody(request: Parameters<typeof readNodeRequestBodyOnce>[0], limit: number): Promise<Buffer>;
-declare function readNodeRequestBodyOnce(request: {
-    headers: Record<string, string | string[] | undefined>;
-    on(event: "data", listener: (chunk: unknown) => void): unknown;
-    on(event: "end", listener: () => void): unknown;
-    on(event: "error", listener: (error: Error) => void): unknown;
-    removeListener?(event: string, listener: (...args: any[]) => void): unknown;
-    resume?(): unknown;
-}, limit: number): Promise<Buffer>;
-declare function createFarmRequestBodyErrorResponse(error: unknown): Response | null;
-
-type FarmWorkflowSchedule = string | string[];
-interface FarmWorkflowsUserConfig {
-    /** Enable or disable Farm workflow discovery. Enabled by default. */
-    enabled?: boolean;
-    /** Directory or directories to scan for workflow modules. */
-    dir?: string | string[];
-    /** Alias for dir. */
-    dirs?: string[];
-    /** HTTP route used for manual and URL-based cron invocation. */
-    route?: string;
-    /** Environment variable that stores the optional runner secret. */
-    secretEnv?: string;
-    /** Inline runner secret. Prefer secretEnv for deployed apps. */
-    secret?: string;
-    /**
-     * Serve the workflow route without a secret in a deployed runtime.
-     * Defaults to false: without a secret the route is public, so production
-     * requests are rejected unless this is explicitly enabled.
-     */
-    allowUnsecured?: boolean;
-}
-interface FarmWorkflowsResolvedConfig {
-    enabled: boolean;
-    dirs: string[];
-    route: string;
-    secretEnv: string;
-    secret?: string;
-    allowUnsecured?: boolean;
-}
-interface FarmWorkflowLogger {
-    info: (...args: unknown[]) => void;
-    warn: (...args: unknown[]) => void;
-    error: (...args: unknown[]) => void;
-}
-interface FarmWorkflowRunContext<TPayload = unknown> {
-    id: string;
-    name: string;
-    payload: TPayload;
-    scheduledTime?: number | string;
-    request?: Request;
-    event?: unknown;
-    env: Record<string, string | undefined>;
-    data: Map<string, unknown>;
-    log: FarmWorkflowLogger;
-}
-interface FarmWorkflowDefinition<TPayload = unknown, TResult = unknown> {
-    kind?: "farm-workflow";
-    id?: string;
-    description?: string;
-    schedule?: FarmWorkflowSchedule;
-    timezone?: string;
-    run: (ctx: FarmWorkflowRunContext<TPayload>) => TResult | Promise<TResult>;
-}
-interface FarmCronDefinition<TPayload = unknown, TResult = unknown> extends FarmWorkflowDefinition<TPayload, TResult> {
-    schedule: FarmWorkflowSchedule;
-}
-interface FarmDiscoveredWorkflow {
-    id: string;
-    filePath: string;
-    description?: string;
-    schedule: string[];
-    timezone?: string;
-    routePath: string;
-}
-interface PreparedFarmWorkflows {
-    workflows: FarmDiscoveredWorkflow[];
-    tasks: Record<string, {
-        handler: string;
-        description: string;
-    }>;
-    scheduledTasks: Record<string, string | string[]>;
-    handlerPath?: string;
-    manifestPath?: string;
-}
-interface FarmWorkflowHTTPHandlerOptions {
-    workflows: FarmDiscoveredWorkflow[];
-    config: FarmWorkflowsResolvedConfig;
-    loadModule: (workflow: FarmDiscoveredWorkflow) => Promise<Record<string, any>>;
-    server?: FarmServerConfig | ResolvedFarmServerConfig;
-}
-declare const DEFAULT_FARM_WORKFLOW_DIRS: string[];
-declare const DEFAULT_FARM_WORKFLOW_ROUTE = "/api/_farm/workflows";
-declare const DEFAULT_FARM_WORKFLOW_SECRET_ENV = "CRON_SECRET";
-declare function defineWorkflow<const TPayload = unknown, TResult = unknown>(definition: FarmWorkflowDefinition<TPayload, TResult>): FarmWorkflowDefinition<TPayload, TResult>;
-declare function defineTask<const TPayload = unknown, TResult = unknown>(definition: FarmWorkflowDefinition<TPayload, TResult>): FarmWorkflowDefinition<TPayload, TResult>;
-/**
- * @deprecated Configure `cron` in `farm.config.ts` and point it at an API route.
- */
-declare function defineCron<const TPayload = unknown, TResult = unknown>(definition: FarmCronDefinition<TPayload, TResult>): FarmCronDefinition<TPayload, TResult>;
-declare function resolveWorkflowsConfig(workflows: FarmWorkflowsUserConfig | boolean | undefined): FarmWorkflowsResolvedConfig;
-declare function discoverFarmWorkflows(config: {
-    root?: string;
-    workflows?: FarmWorkflowsResolvedConfig | FarmWorkflowsUserConfig | boolean;
-}, options?: {
-    loadModule?: (filePath: string) => Promise<Record<string, any>>;
-}): Promise<FarmDiscoveredWorkflow[]>;
-declare function createFarmWorkflowRequestHandler(options: FarmWorkflowHTTPHandlerOptions): (request: Request) => Promise<Response | null>;
-declare function runFarmWorkflowModule(module: Record<string, any>, context: {
-    id: string;
-    name?: string;
-    payload?: unknown;
-    scheduledTime?: number | string;
-    request?: Request;
-    event?: unknown;
-    env?: Record<string, string | undefined>;
-}): Promise<unknown>;
-declare function prepareFarmWorkflowsForNitro(config: {
-    root?: string;
-    distDir?: string;
-    workflows?: FarmWorkflowsResolvedConfig | FarmWorkflowsUserConfig | boolean;
-    server?: FarmServerConfig | ResolvedFarmServerConfig;
-}): Promise<PreparedFarmWorkflows>;
-declare function createFarmWorkflowVercelCrons(workflows: FarmDiscoveredWorkflow[]): Array<{
-    path: string;
-    schedule: string;
-}>;
-declare function applyFarmWorkflowVercelCrons(vercelConfig: Record<string, any>, workflows: FarmDiscoveredWorkflow[]): Record<string, any>;
-
-export { cloneFarmRequestWithContext as A, createFarmRequestBodyErrorResponse as B, matchesFarmIfNoneMatch as C, DEFAULT_FARM_WORKFLOW_DIRS as D, readFarmRequestBody as E, type FarmWorkflowsResolvedConfig as F, readNodeRequestBody as G, resolveFarmServerConfig as H, type PreparedFarmWorkflows as P, type ResolvedFarmServerConfig as R, DEFAULT_FARM_WORKFLOW_ROUTE as a, DEFAULT_FARM_WORKFLOW_SECRET_ENV as b, createFarmNodeRequestAbortSignal as c, type FarmCronDefinition as d, type FarmDiscoveredWorkflow as e, type FarmServerConfig as f, type FarmServerDuration as g, type FarmServerHealthConfig as h, type FarmWorkflowDefinition as i, type FarmWorkflowHTTPHandlerOptions as j, type FarmWorkflowLogger as k, type FarmWorkflowRunContext as l, type FarmWorkflowSchedule as m, type FarmWorkflowsUserConfig as n, type ResolvedFarmServerHealthConfig as o, applyFarmWorkflowVercelCrons as p, createFarmWorkflowRequestHandler as q, createFarmWorkflowVercelCrons as r, defineCron as s, defineTask as t, defineWorkflow as u, discoverFarmWorkflows as v, prepareFarmWorkflowsForNitro as w, resolveWorkflowsConfig as x, runFarmWorkflowModule as y, bufferFarmRequestBody as z };

package/dist/workflows.d.mts

@@ -1 +0,0 @@
-export { D as DEFAULT_FARM_WORKFLOW_DIRS, a as DEFAULT_FARM_WORKFLOW_ROUTE, b as DEFAULT_FARM_WORKFLOW_SECRET_ENV, d as FarmCronDefinition, e as FarmDiscoveredWorkflow, i as FarmWorkflowDefinition, j as FarmWorkflowHTTPHandlerOptions, k as FarmWorkflowLogger, l as FarmWorkflowRunContext, m as FarmWorkflowSchedule, F as FarmWorkflowsResolvedConfig, n as FarmWorkflowsUserConfig, P as PreparedFarmWorkflows, p as applyFarmWorkflowVercelCrons, q as createFarmWorkflowRequestHandler, r as createFarmWorkflowVercelCrons, s as defineCron, t as defineTask, u as defineWorkflow, v as discoverFarmWorkflows, w as prepareFarmWorkflowsForNitro, x as resolveWorkflowsConfig, y as runFarmWorkflowModule } from './workflows.d-CRMzQZ3k.mjs';

package/dist/workflows.d.ts

@@ -1 +0,0 @@
-export { D as DEFAULT_FARM_WORKFLOW_DIRS, a as DEFAULT_FARM_WORKFLOW_ROUTE, b as DEFAULT_FARM_WORKFLOW_SECRET_ENV, d as FarmCronDefinition, e as FarmDiscoveredWorkflow, i as FarmWorkflowDefinition, j as FarmWorkflowHTTPHandlerOptions, k as FarmWorkflowLogger, l as FarmWorkflowRunContext, m as FarmWorkflowSchedule, F as FarmWorkflowsResolvedConfig, n as FarmWorkflowsUserConfig, P as PreparedFarmWorkflows, p as applyFarmWorkflowVercelCrons, q as createFarmWorkflowRequestHandler, r as createFarmWorkflowVercelCrons, s as defineCron, t as defineTask, u as defineWorkflow, v as discoverFarmWorkflows, w as prepareFarmWorkflowsForNitro, x as resolveWorkflowsConfig, y as runFarmWorkflowModule } from './workflows.d-CRMzQZ3k.js';