@farm.js/plugin 0.1.0-beta.0

package/dist/context/index.d.ts

@@ -0,0 +1,61 @@
+interface RequestLike {
+    url?: string;
+    headers: Record<string, string | string[] | undefined>;
+}
+interface PluginContextLike {
+    req: {
+        set: (key: string, value: any, options?: {
+            exposeToPage?: boolean;
+        }) => void;
+        get: <T = any>(key: string) => T | undefined;
+    };
+}
+interface ContextPluginLike {
+    name: string;
+    enforce?: "pre" | "post";
+    beforeRequest?: (req: RequestLike, res: unknown, context: PluginContextLike) => void | Promise<void>;
+    afterResponse?: (req: RequestLike, res: {
+        statusCode?: number;
+    } | unknown, context: PluginContextLike) => void | Promise<void>;
+}
+export interface ContextPluginOptions {
+    requestIdHeader?: string;
+    localeHeader?: string;
+    exposePathname?: boolean;
+    beforeRequest?: (payload: {
+        requestId: string;
+        locale: string;
+        pathname: string;
+    }) => void;
+    afterResponse?: (payload: {
+        requestId: string;
+        locale: string;
+        pathname: string;
+        statusCode: number;
+        durationMs: number;
+    }) => void;
+}
+/**
+ * Demo plugin that exposes request context to server page props as `props.context`.
+ *
+ * @example
+ * ```ts
+ * import { contextPlugin } from "@farm.js/plugin/context";
+ *
+ * export default defineConfig({
+ *   plugins: [contextPlugin()],
+ * });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * export default function Page(props: any) {
+ *   const requestId = props.context?.data.get("requestId");
+ *   const locale = props.context?.data.get("locale");
+ *   return <div>{requestId} - {locale}</div>;
+ * }
+ * ```
+ */
+export declare function contextPlugin(options?: ContextPluginOptions): ContextPluginLike;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/context/index.ts"],"names":[],"mappings":"AAEA,UAAU,WAAW;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;CACxD;AAED,UAAU,iBAAiB;IACzB,GAAG,EAAE;QACH,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE;YAAE,YAAY,CAAC,EAAE,OAAO,CAAA;SAAE,KAAK,IAAI,CAAC;QAC7E,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC,GAAG,SAAS,CAAC;KAC9C,CAAC;CACH;AAED,UAAU,iBAAiB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,OAAO,EACZ,OAAO,EAAE,iBAAiB,KACvB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,EACtC,OAAO,EAAE,iBAAiB,KACvB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC3F,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,IAAI,CAAC;CACZ;AAeD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,iBAAiB,CA0CnF"}

package/dist/context/index.js

@@ -0,0 +1,75 @@
+import { randomUUID } from "crypto";
+function normalizeHeaderValue(value) {
+    if (!value)
+        return undefined;
+    if (Array.isArray(value))
+        return value[0];
+    return value;
+}
+function getHeader(req, name) {
+    const direct = normalizeHeaderValue(req.headers[name.toLowerCase()]);
+    if (direct)
+        return direct;
+    const fromRaw = normalizeHeaderValue(req.headers[name]);
+    return fromRaw;
+}
+/**
+ * Demo plugin that exposes request context to server page props as `props.context`.
+ *
+ * @example
+ * ```ts
+ * import { contextPlugin } from "@farm.js/plugin/context";
+ *
+ * export default defineConfig({
+ *   plugins: [contextPlugin()],
+ * });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * export default function Page(props: any) {
+ *   const requestId = props.context?.data.get("requestId");
+ *   const locale = props.context?.data.get("locale");
+ *   return <div>{requestId} - {locale}</div>;
+ * }
+ * ```
+ */
+export function contextPlugin(options = {}) {
+    const requestIdHeader = (options.requestIdHeader || "x-request-id").toLowerCase();
+    const localeHeader = (options.localeHeader || "x-locale").toLowerCase();
+    const exposePathname = options.exposePathname ?? true;
+    const beforeRequestCb = options.beforeRequest;
+    const afterResponseCb = options.afterResponse;
+    return {
+        name: "@farm.js/plugin-context",
+        enforce: "pre",
+        beforeRequest(req, _res, context) {
+            const pathname = req.url || "/";
+            const requestId = getHeader(req, requestIdHeader) || randomUUID();
+            const locale = getHeader(req, localeHeader) || "en";
+            context.req.set("requestId", requestId, { exposeToPage: true });
+            context.req.set("locale", locale, { exposeToPage: true });
+            if (exposePathname) {
+                context.req.set("pathname", pathname, { exposeToPage: true });
+            }
+            // Private value stays available only to plugin hooks.
+            context.req.set("internal:requestStart", Date.now());
+            if (beforeRequestCb) {
+                beforeRequestCb({ requestId, locale, pathname });
+            }
+        },
+        afterResponse(req, res, context) {
+            if (!afterResponseCb)
+                return;
+            const requestId = context.req.get("requestId") || "unknown";
+            const locale = context.req.get("locale") || "en";
+            const started = context.req.get("internal:requestStart");
+            const pathname = req.url || "/";
+            const durationMs = typeof started === "number" ? Date.now() - started : 0;
+            const statusCode = typeof res === "object" && res !== null && "statusCode" in res
+                ? Number(res.statusCode || 200)
+                : 200;
+            afterResponseCb({ requestId, locale, pathname, statusCode, durationMs });
+        },
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @farm.js/plugin - Official plugins for Farm.js framework
+ *
+ * This package provides official plugins that extend Farm.js functionality.
+ *
+ * Available plugins:
+ * - @farm.js/plugin/rsc - React Server Components support
+ * - @farm.js/plugin/middleware - Standalone middleware support
+ * - @farm.js/plugin/api - Standalone API routes support
+ * - @farm.js/plugin/observability - request/render/build observability lifecycle hooks
+ * - @farm.js/plugin/context - example request context exposure plugin
+ *
+ * @example
+ * ```ts
+ * // Using RSC (includes middleware and API support)
+ * import { defineConfig } from '@farm.js/plugin/rsc'
+ *
+ * export default defineConfig({
+ *   srcDir: 'src',
+ *   experimental: {
+ *     serverComponents: true,
+ *     serverActions: true,
+ *   },
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Using standalone plugins (without RSC)
+ * import { defineConfig } from 'vite'
+ * import { farmMiddleware } from '@farm.js/plugin/middleware'
+ * import { farmApi } from '@farm.js/plugin/api'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     farmMiddleware({ srcDir: 'src', debug: true }),
+ *     farmApi({ srcDir: 'src', debug: true }),
+ *   ],
+ * })
+ * ```
+ */
+export declare const version = "0.0.1";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,49 @@
+/**
+ * @farm.js/plugin - Official plugins for Farm.js framework
+ *
+ * This package provides official plugins that extend Farm.js functionality.
+ *
+ * Available plugins:
+ * - @farm.js/plugin/rsc - React Server Components support
+ * - @farm.js/plugin/middleware - Standalone middleware support
+ * - @farm.js/plugin/api - Standalone API routes support
+ * - @farm.js/plugin/observability - request/render/build observability lifecycle hooks
+ * - @farm.js/plugin/context - example request context exposure plugin
+ *
+ * @example
+ * ```ts
+ * // Using RSC (includes middleware and API support)
+ * import { defineConfig } from '@farm.js/plugin/rsc'
+ *
+ * export default defineConfig({
+ *   srcDir: 'src',
+ *   experimental: {
+ *     serverComponents: true,
+ *     serverActions: true,
+ *   },
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Using standalone plugins (without RSC)
+ * import { defineConfig } from 'vite'
+ * import { farmMiddleware } from '@farm.js/plugin/middleware'
+ * import { farmApi } from '@farm.js/plugin/api'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     farmMiddleware({ srcDir: 'src', debug: true }),
+ *     farmApi({ srcDir: 'src', debug: true }),
+ *   ],
+ * })
+ * ```
+ */
+export const version = "0.0.1";
+// Note: Import plugins from their respective subpaths:
+// - @farm.js/plugin/rsc
+// - @farm.js/plugin/middleware
+// - @farm.js/plugin/api
+// - @farm.js/plugin/observability
+// - @farm.js/plugin/context
+// This avoids bundling unused code

package/dist/middleware/index.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Farm.js Middleware Plugin
+ *
+ * Standalone middleware support that works with or without RSC.
+ * Discovers and executes middleware.ts files in the source directory.
+ *
+ * @example
+ * ```ts
+ * import { farmMiddleware } from '@farm.js/plugin/middleware'
+ *
+ * export default defineConfig({
+ *   plugins: [farmMiddleware({ srcDir: 'src' })],
+ * })
+ * ```
+ */
+import type { Plugin, ViteDevServer } from "vite";
+import type { IncomingMessage, ServerResponse } from "http";
+export interface FarmMiddlewareOptions {
+    /** Source directory containing middleware files (default: 'src') */
+    srcDir?: string;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Cookie options
+ */
+export interface CookieOptions {
+    maxAge?: number;
+    expires?: Date;
+    path?: string;
+    domain?: string;
+    secure?: boolean;
+    httpOnly?: boolean;
+    sameSite?: "strict" | "lax" | "none";
+}
+/**
+ * Cookie management interface
+ */
+export interface CookieJar {
+    get(name: string): string | undefined;
+    set(name: string, value: string, options?: CookieOptions): void;
+    delete(name: string): void;
+    getAll(): Record<string, string>;
+}
+/**
+ * Full middleware context - compatible with @farm.js/core/middleware
+ */
+export interface MiddlewareContext {
+    request: IncomingMessage;
+    response: ServerResponse;
+    url: URL;
+    pathname: string;
+    searchParams: URLSearchParams;
+    method: string;
+    params: Record<string, string>;
+    route: string;
+    parent?: {
+        data: Map<string, any>;
+        headers: Record<string, string>;
+    };
+    vite: {
+        isDev: boolean;
+        hmr: boolean;
+        server?: ViteDevServer;
+    };
+    data: Map<string, any>;
+    headers: Map<string, string>;
+    cookies: CookieJar;
+    _handled: boolean;
+    _redirectUrl?: string;
+    _rewriteUrl?: string;
+    redirect(url: string, status?: number): void;
+    rewrite(url: string): void;
+    json(data: any, status?: number): void;
+    text(content: string, status?: number): void;
+    html(content: string, status?: number): void;
+}
+export type MiddlewareHandler = (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void> | void;
+export interface DiscoveredMiddleware {
+    path: string;
+    filePath: string;
+    module: MiddlewareHandler | {
+        build: () => {
+            handlers: MiddlewareHandler[];
+        };
+        setBasePath?: (path: string) => void;
+    };
+    config?: {
+        matcher?: string[];
+    };
+}
+/**
+ * Farm.js Middleware Plugin
+ */
+export default function farmMiddleware(options?: FarmMiddlewareOptions): Plugin;
+export { farmMiddleware };
+//# sourceMappingURL=index.d.ts.map

package/dist/middleware/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/middleware/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,MAAM,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AA+B5D,MAAM,WAAW,qBAAqB;IACpC,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACtC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAChE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAEhC,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;IACzB,GAAG,EAAE,GAAG,CAAC;IACT,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,eAAe,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IAGf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IAGd,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACjC,CAAC;IAGF,IAAI,EAAE;QACJ,KAAK,EAAE,OAAO,CAAC;QACf,GAAG,EAAE,OAAO,CAAC;QACb,MAAM,CAAC,EAAE,aAAa,CAAC;KACxB,CAAC;IAGF,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAGvB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,EAAE,SAAS,CAAC;IAGnB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,MAAM,iBAAiB,GAAG,CAC9B,GAAG,EAAE,iBAAiB,EACtB,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KACtB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAE1B,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EACF,iBAAiB,GACjB;QAAE,KAAK,EAAE,MAAM;YAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAA;SAAE,CAAC;QAAC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,CAAC;IAC7F,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACjC;AA8MD;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,OAAO,GAAE,qBAA0B,GAAG,MAAM,CAsSlF;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}