@farm.js/core 0.1.0-beta.16 → 0.1.0-beta.17

package/dist/vite.d.mts

@@ -0,0 +1,24 @@
+import 'vite';
+export { d as defineConfig, ds as farmI18nClientBridgePlugin, f as farmPlugin, dt as rewriteEarlySsrRelativeImports } from './client-plugins-278AvYHE.mjs';
+import './plugin-BJDf43dc.mjs';
+import 'react';
+import 'http';
+import './types-D1A6-XvH.mjs';
+import 'db0';
+import 'unstorage';
+import './integration-api-CHT2OKAf.mjs';
+import '@farming-labs/orm';
+import './types-DTzm4TCl.mjs';
+import '@farming-labs/docs';
+import './markdown.mjs';
+import './observability.mjs';
+import './workflows.mjs';
+import './cron.mjs';
+import './env.mjs';
+import './server-action-security.mjs';
+import './server-fn-error-DDh14a0V.mjs';
+import './image-config-Duob7wER.mjs';
+import './types-BMxWr97v.mjs';
+import './cache.mjs';
+import './route-runtime-DoOHzCAD.mjs';
+import './font.mjs';

package/dist/vite.d.ts

@@ -0,0 +1,24 @@
+import 'vite';
+export { d as defineConfig, ds as farmI18nClientBridgePlugin, f as farmPlugin, dt as rewriteEarlySsrRelativeImports } from './client-plugins-CTQAkr7R.js';
+import './plugin-BJDf43dc.js';
+import 'react';
+import 'http';
+import './types-D1A6-XvH.js';
+import 'db0';
+import 'unstorage';
+import './integration-api-CHT2OKAf.js';
+import '@farming-labs/orm';
+import './types-DTzm4TCl.js';
+import '@farming-labs/docs';
+import './markdown.js';
+import './observability.js';
+import './workflows.js';
+import './cron.js';
+import './env.js';
+import './server-action-security.js';
+import './server-fn-error-DDh14a0V.js';
+import './image-config-Duob7wER.js';
+import './types-BMxWr97v.js';
+import './cache.js';
+import './route-runtime-DoOHzCAD.js';
+import './font.js';

package/dist/vite.mjs

@@ -3,7 +3,7 @@ import {
   farmI18nClientBridgePlugin,
   farmPlugin,
   rewriteEarlySsrRelativeImports
-} from "./chunk-OSWV5IJB.mjs";
+} from "./chunk-T2M5QANG.mjs";
 import "./chunk-LGHEOHBU.mjs";
 import "./chunk-FRPWCMMG.mjs";
 import "./chunk-53MVSX3R.mjs";
@@ -15,7 +15,7 @@ import "./chunk-USWZZUEH.mjs";
 import "./chunk-XMFTIVJH.mjs";
 import "./chunk-7HO6AEOP.mjs";
 import "./chunk-USLFXFFH.mjs";
-import "./chunk-I4CUBGVF.mjs";
+import "./chunk-E257KFBU.mjs";
 import "./chunk-7MABZJIM.mjs";
 import "./chunk-YW7OBE6Q.mjs";
 import "./chunk-74YTBPTY.mjs";
@@ -27,9 +27,9 @@ import "./chunk-7FBJLMQH.mjs";
 import "./chunk-XIVV5IWN.mjs";
 import "./chunk-GXASWWJU.mjs";
 import "./chunk-K4667E2Q.mjs";
+import "./chunk-T4QJQK76.mjs";
 import "./chunk-MIUW47JX.mjs";
 import "./chunk-P7QDS5AT.mjs";
-import "./chunk-T4QJQK76.mjs";
 import "./chunk-E6EPN5BT.mjs";
 import "./chunk-QGOHVJ6J.mjs";
 import "./chunk-ARRYKOI5.mjs";
@@ -43,7 +43,7 @@ import "./chunk-J4FNJ5IU.mjs";
 import "./chunk-HMRFYJK6.mjs";
 import "./chunk-RHIFZZUI.mjs";
 import "./chunk-LM2YNO4U.mjs";
-import "./chunk-BWJC5ZOD.mjs";
+import "./chunk-VFDBC3W7.mjs";
 import "./chunk-B3FFOIWS.mjs";
 import "./chunk-ITN462YM.mjs";
 import "./chunk-3HIVDX7J.mjs";

package/dist/workflows.d.mts

@@ -0,0 +1,110 @@
+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;
+}
+interface FarmWorkflowsResolvedConfig {
+    enabled: boolean;
+    dirs: string[];
+    route: string;
+    secretEnv: string;
+    secret?: string;
+}
+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>>;
+}
+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;
+}): 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 { DEFAULT_FARM_WORKFLOW_DIRS, DEFAULT_FARM_WORKFLOW_ROUTE, DEFAULT_FARM_WORKFLOW_SECRET_ENV, type FarmCronDefinition, type FarmDiscoveredWorkflow, type FarmWorkflowDefinition, type FarmWorkflowHTTPHandlerOptions, type FarmWorkflowLogger, type FarmWorkflowRunContext, type FarmWorkflowSchedule, type FarmWorkflowsResolvedConfig, type FarmWorkflowsUserConfig, type PreparedFarmWorkflows, applyFarmWorkflowVercelCrons, createFarmWorkflowRequestHandler, createFarmWorkflowVercelCrons, defineCron, defineTask, defineWorkflow, discoverFarmWorkflows, prepareFarmWorkflowsForNitro, resolveWorkflowsConfig, runFarmWorkflowModule };

package/dist/workflows.d.ts

@@ -0,0 +1,110 @@
+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;
+}
+interface FarmWorkflowsResolvedConfig {
+    enabled: boolean;
+    dirs: string[];
+    route: string;
+    secretEnv: string;
+    secret?: string;
+}
+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>>;
+}
+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;
+}): 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 { DEFAULT_FARM_WORKFLOW_DIRS, DEFAULT_FARM_WORKFLOW_ROUTE, DEFAULT_FARM_WORKFLOW_SECRET_ENV, type FarmCronDefinition, type FarmDiscoveredWorkflow, type FarmWorkflowDefinition, type FarmWorkflowHTTPHandlerOptions, type FarmWorkflowLogger, type FarmWorkflowRunContext, type FarmWorkflowSchedule, type FarmWorkflowsResolvedConfig, type FarmWorkflowsUserConfig, type PreparedFarmWorkflows, applyFarmWorkflowVercelCrons, createFarmWorkflowRequestHandler, createFarmWorkflowVercelCrons, defineCron, defineTask, defineWorkflow, discoverFarmWorkflows, prepareFarmWorkflowsForNitro, resolveWorkflowsConfig, runFarmWorkflowModule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farm.js/core",
-  "version": "0.1.0-beta.16",
+  "version": "0.1.0-beta.17",
   "description": "Core Farm.js framework for modern integrated apps",
   "keywords": [
     "@farm.js/core",

package/types/middleware.d.ts

@@ -136,11 +136,13 @@ declare module "@farm.js/core/middleware" {
    */
   export interface RateLimitConfig {
     /** Maximum number of requests */
-    max: number;
-    /** Time window in milliseconds */
-    windowMs: number;
+    requests: number;
+    /** Fixed window such as `500ms`, `10s`, `1m`, or `1h`. */
+    window: string;
     /** Optional custom key generator */
     keyGenerator?: (ctx: MiddlewareContext) => string;
+    /** Optional response customization when the limit is exceeded. */
+    onLimit?: (ctx: MiddlewareContext) => void | Response | Promise<void | Response>;
     /** Optional custom storage */
     storage?: RateLimitStorage;
   }
@@ -148,19 +150,33 @@ declare module "@farm.js/core/middleware" {
   /**
    * Rate limit storage interface
    */
+  export interface RateLimitIncrementResult {
+    count: number;
+    resetAt: number;
+  }
+
   export interface RateLimitStorage {
-    get(key: string): Promise<number | undefined>;
-    set(key: string, value: number, ttlMs: number): Promise<void>;
-    increment(key: string): Promise<number>;
+    increment(
+      key: string,
+      windowMs: number,
+    ): RateLimitIncrementResult | Promise<RateLimitIncrementResult>;
+    get?(key: string): RateLimitIncrementResult | null | Promise<RateLimitIncrementResult | null>;
+  }
+
+  export interface MemoryRateLimitStorageOptions {
+    maxEntries?: number;
   }
 
   /**
    * Rate limit status
    */
   export interface RateLimitStatus {
+    requests: number;
+    limit: number;
     remaining: number;
-    reset: number;
-    total: number;
+    resetIn: number | null;
+    resetAt: Date | null;
+    isLimited: boolean;
   }
 
   /**
@@ -206,12 +222,21 @@ declare module "@farm.js/core/middleware" {
   /**
    * Create a new middleware chain
    */
-  export function middleware(config?: MiddlewareConfig): MiddlewareChain;
+  export function middleware(basePath?: string): MiddlewareChain;
 
   /**
-   * Get rate limit status for current request
+   * Get rate limit status for a key
    */
-  export function getRateLimitStatus(ctx: MiddlewareContext): RateLimitStatus | undefined;
+  export function getRateLimitStatus(
+    key: string,
+    limit: number,
+    storage?: RateLimitStorage,
+  ): Promise<RateLimitStatus>;
+
+  /** Create an atomic, process-local fixed-window rate-limit store. */
+  export function memoryRateLimitStorage(options?: MemoryRateLimitStorageOptions): RateLimitStorage;
+
+  export class UnsupportedRateLimitStorageError extends TypeError {}
 
   /**
    * Create a middleware context from request/response