@farm.js/core 0.1.0-beta.6 → 0.1.0-beta.8

package/dist/vite.d.mts

@@ -0,0 +1,22 @@
+import 'vite';
+export { d as defineConfig, d3 as farmI18nClientBridgePlugin, f as farmPlugin, d4 as rewriteEarlySsrRelativeImports } from './client-plugins-BI2R6Eae.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-C9N-nk5R.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 './image-config-Duob7wER.mjs';
+import './types-BMxWr97v.mjs';
+import './cache.mjs';
+import './route-runtime-DoOHzCAD.mjs';

package/dist/vite.d.ts

@@ -0,0 +1,22 @@
+import 'vite';
+export { d as defineConfig, d3 as farmI18nClientBridgePlugin, f as farmPlugin, d4 as rewriteEarlySsrRelativeImports } from './client-plugins-DU9oMspX.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-C9N-nk5R.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 './image-config-Duob7wER.js';
+import './types-BMxWr97v.js';
+import './cache.js';
+import './route-runtime-DoOHzCAD.js';

package/dist/vite.mjs

@@ -3,22 +3,23 @@ import {
   farmI18nClientBridgePlugin,
   farmPlugin,
   rewriteEarlySsrRelativeImports
-} from "./chunk-A2LUXHD2.mjs";
+} from "./chunk-4MGVSBRP.mjs";
 import "./chunk-LGHEOHBU.mjs";
 import "./chunk-FRPWCMMG.mjs";
 import "./chunk-V6WE6JSZ.mjs";
 import "./chunk-3XNTL3FQ.mjs";
-import "./chunk-BHG3LVHH.mjs";
+import "./chunk-CGIXMLSY.mjs";
 import "./chunk-USWZZUEH.mjs";
 import "./chunk-7N62DNSO.mjs";
 import "./chunk-7HO6AEOP.mjs";
+import "./chunk-I4CUBGVF.mjs";
 import "./chunk-74YTBPTY.mjs";
 import "./chunk-7MABZJIM.mjs";
 import "./chunk-YW7OBE6Q.mjs";
 import "./chunk-GY2STC2S.mjs";
 import "./chunk-UB5UOSHB.mjs";
-import "./chunk-LLC7BNXW.mjs";
-import "./chunk-QGQX7SFC.mjs";
+import "./chunk-ZVWA4ZQ3.mjs";
+import "./chunk-7FBJLMQH.mjs";
 import "./chunk-XIVV5IWN.mjs";
 import "./chunk-GXASWWJU.mjs";
 import "./chunk-K4667E2Q.mjs";
@@ -38,7 +39,7 @@ import "./chunk-J4FNJ5IU.mjs";
 import "./chunk-PFE6GMNE.mjs";
 import "./chunk-RHIFZZUI.mjs";
 import "./chunk-LM2YNO4U.mjs";
-import "./chunk-EEABSBKK.mjs";
+import "./chunk-SSA7THPX.mjs";
 import "./chunk-QTZZ2ISQ.mjs";
 import "./chunk-ITN462YM.mjs";
 import "./chunk-B232I2GP.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.6",
+  "version": "0.1.0-beta.8",
   "description": "Core Farm.js framework for modern integrated apps",
   "keywords": [
     "@farm.js/core",
@@ -109,6 +109,7 @@
         "./dist/agent-runtime.d.ts"
       ],
       "image": [
+        "./types/image.d.ts",
         "./dist/image.d.ts"
       ],
       "image/server": [
@@ -406,7 +407,7 @@
       "require": "./dist/agent-runtime.cjs"
     },
     "./image": {
-      "types": "./dist/image.d.ts",
+      "types": "./types/image.d.ts",
       "import": "./dist/image.mjs",
       "require": "./dist/image.cjs"
     },

package/types/client.d.ts

@@ -3,7 +3,7 @@
  *
  * Provides stable exports for Link, useRouter, and API client so TypeScript
  * and IDEs resolve them even when the build output omits them. The generated
- * farm-routes.d.ts in your app augments LinkDefaultRoute for typed href.
+ * farm.d.ts in your app augments LinkDefaultRoute for typed href.
  */
 
 import type {

package/types/image.d.ts

@@ -0,0 +1,4 @@
+/// <reference path="./images.d.ts" />
+
+export * from "../dist/image";
+export { default } from "../dist/image";

package/types/images.d.ts

@@ -0,0 +1,59 @@
+/** Static image imports available to every Farm application. */
+declare module "*.avif" {
+  const image: import("@farm.js/core/image").StaticImageData;
+  export const src: string;
+  export const width: number;
+  export const height: number;
+  export const blurDataURL: string | undefined;
+  export default image;
+}
+
+declare module "*.gif" {
+  const image: import("@farm.js/core/image").StaticImageData;
+  export const src: string;
+  export const width: number;
+  export const height: number;
+  export const blurDataURL: string | undefined;
+  export default image;
+}
+
+declare module "*.jpeg" {
+  const image: import("@farm.js/core/image").StaticImageData;
+  export const src: string;
+  export const width: number;
+  export const height: number;
+  export const blurDataURL: string | undefined;
+  export default image;
+}
+
+declare module "*.jpg" {
+  const image: import("@farm.js/core/image").StaticImageData;
+  export const src: string;
+  export const width: number;
+  export const height: number;
+  export const blurDataURL: string | undefined;
+  export default image;
+}
+
+declare module "*.png" {
+  const image: import("@farm.js/core/image").StaticImageData;
+  export const src: string;
+  export const width: number;
+  export const height: number;
+  export const blurDataURL: string | undefined;
+  export default image;
+}
+
+declare module "*.webp" {
+  const image: import("@farm.js/core/image").StaticImageData;
+  export const src: string;
+  export const width: number;
+  export const height: number;
+  export const blurDataURL: string | undefined;
+  export default image;
+}
+
+declare module "*?url" {
+  const src: string;
+  export default src;
+}