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

package/dist/plugin-BJDf43dc.d.mts

@@ -0,0 +1,165 @@
+type MaybePromise<T> = T | Promise<T>;
+type FarmClientPluginEnforce = "pre" | "post";
+type FarmClientNavigationAction = "push" | "replace" | "pop";
+type FarmClientHydrationMode = "hydrate" | "render";
+interface FarmClientLocation {
+    href: string;
+    pathname: string;
+    search: string;
+    hash: string;
+}
+interface FarmClientPluginRouter {
+    navigate(href: string, options?: Record<string, unknown>): MaybePromise<void>;
+    prefetch?(href: string): MaybePromise<void>;
+    getNavigationState?(): unknown;
+}
+interface FarmClientPluginMetadata {
+    name: string;
+    version?: string;
+}
+interface FarmClientPluginSetupEvent<TPublic = undefined> {
+    plugin: FarmClientPluginMetadata;
+    public: Readonly<TPublic>;
+    router: FarmClientPluginRouter;
+    isDev: boolean;
+    isProd: boolean;
+    deploymentId?: string;
+}
+interface FarmClientPluginStateEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginSetupEvent<TPublic> {
+    state: TState;
+}
+interface FarmClientHydrationSession {
+    container: Element;
+    location: FarmClientLocation;
+    mode: FarmClientHydrationMode;
+    startedAt: number;
+}
+interface FarmClientHydrationEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic>, FarmClientHydrationSession {
+}
+interface FarmClientHydrationCompleteEvent<TState = unknown, TPublic = undefined> extends FarmClientHydrationEvent<TState, TPublic> {
+    durationMs: number;
+    recovered: boolean;
+}
+interface FarmClientNavigationSession {
+    id: string;
+    from: FarmClientLocation | null;
+    to: FarmClientLocation;
+    action: FarmClientNavigationAction;
+    signal: AbortSignal;
+    startedAt: number;
+    route?: {
+        pattern?: string | null;
+        params?: Record<string, string>;
+    };
+}
+interface FarmClientNavigationEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic>, FarmClientNavigationSession {
+}
+interface FarmClientNavigationLoadedEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationEvent<TState, TPublic> {
+    durationMs: number;
+    data?: unknown;
+}
+interface FarmClientNavigationResolvedEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationEvent<TState, TPublic> {
+    durationMs: number;
+}
+interface FarmClientNavigationErrorEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationResolvedEvent<TState, TPublic> {
+    error: unknown;
+}
+type FarmClientPluginErrorPhase = "setup" | "hydration" | "navigation" | "window" | "unhandled-rejection" | "performance" | `plugin:${string}` | (string & {});
+interface FarmClientPluginErrorEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    error: unknown;
+    phase: FarmClientPluginErrorPhase;
+    location: FarmClientLocation;
+    navigation?: FarmClientNavigationSession;
+}
+interface FarmClientPerformanceEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    entry: PerformanceEntry;
+    location: FarmClientLocation;
+}
+interface FarmClientPluginCloseEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    reason: "pagehide" | "hmr" | "manual" | (string & {});
+}
+interface FarmClientPlugin<TState = unknown, TPublic = undefined> {
+    setup?(event: FarmClientPluginSetupEvent<TPublic>): MaybePromise<TState>;
+    hydration?: {
+        before?(event: FarmClientHydrationEvent<TState, TPublic>): MaybePromise<void>;
+        after?(event: FarmClientHydrationCompleteEvent<TState, TPublic>): MaybePromise<void>;
+    };
+    navigation?: {
+        before?(event: FarmClientNavigationEvent<TState, TPublic>): MaybePromise<void>;
+        loaded?(event: FarmClientNavigationLoadedEvent<TState, TPublic>): MaybePromise<void>;
+        resolved?(event: FarmClientNavigationResolvedEvent<TState, TPublic>): MaybePromise<void>;
+        rendered?(event: FarmClientNavigationResolvedEvent<TState, TPublic>): MaybePromise<void>;
+        error?(event: FarmClientNavigationErrorEvent<TState, TPublic>): MaybePromise<void>;
+    };
+    error?(event: FarmClientPluginErrorEvent<TState, TPublic>): MaybePromise<void>;
+    performance?(event: FarmClientPerformanceEvent<TState, TPublic>): MaybePromise<void>;
+    close?(event: FarmClientPluginCloseEvent<TState, TPublic>): MaybePromise<void>;
+}
+interface FarmClientPluginRegistration<TPublic = undefined> {
+    name: string;
+    version?: string;
+    enforce?: FarmClientPluginEnforce;
+    definition: FarmClientPlugin<any, TPublic>;
+    public?: TPublic;
+}
+interface FarmClientPluginManagerOptions {
+    router: FarmClientPluginRouter;
+    isDev?: boolean;
+    isProd?: boolean;
+    deploymentId?: string;
+    window?: Window;
+}
+declare class FarmClientPluginManager {
+    private readonly registrations;
+    private readonly options;
+    private readonly instances;
+    private readonly performanceObservers;
+    private startPromise?;
+    private closePromise?;
+    private currentNavigation?;
+    private navigationSequence;
+    private starting;
+    private started;
+    private closed;
+    private readonly reportedErrors;
+    private readonly handleWindowError;
+    private readonly handleUnhandledRejection;
+    private readonly handlePageHide;
+    constructor(registrations: readonly FarmClientPluginRegistration[], options: FarmClientPluginManagerOptions);
+    start(): Promise<void>;
+    beginHydration(input: {
+        container: Element;
+        mode: FarmClientHydrationMode;
+    }): Promise<FarmClientHydrationSession>;
+    completeHydration(session: FarmClientHydrationSession, options?: {
+        recovered?: boolean;
+    }): Promise<void>;
+    failHydration(session: FarmClientHydrationSession, error: unknown): Promise<void>;
+    beginNavigation(input: {
+        from?: string | URL | FarmClientLocation | null;
+        to: string | URL | FarmClientLocation;
+        action: FarmClientNavigationAction;
+        route?: FarmClientNavigationSession["route"];
+    }): Promise<FarmClientNavigationSession>;
+    markNavigationLoaded(session: FarmClientNavigationSession, data?: unknown): Promise<void>;
+    resolveNavigation(session: FarmClientNavigationSession): Promise<void>;
+    scheduleNavigationRendered(session: FarmClientNavigationSession): Promise<void>;
+    failNavigation(session: FarmClientNavigationSession, error: unknown): Promise<void>;
+    reportError(error: unknown, phase: FarmClientPluginErrorPhase, navigation?: FarmClientNavigationSession, location?: FarmClientLocation): Promise<void>;
+    close(reason?: FarmClientPluginCloseEvent["reason"]): Promise<void>;
+    getPlugins(): readonly FarmClientPluginMetadata[];
+    private startInternal;
+    private installBrowserListeners;
+    private installPerformanceObservers;
+    private closeInternal;
+    private runHook;
+    private runErrorHooks;
+    private createSetupEvent;
+    private createStateEvent;
+    private getLocation;
+    private getBaseUrl;
+    private logHookError;
+}
+declare function createClientPluginManager(registrations: readonly FarmClientPluginRegistration[], options: FarmClientPluginManagerOptions): FarmClientPluginManager;
+
+export { FarmClientPluginManager as F, type FarmClientHydrationCompleteEvent as a, type FarmClientHydrationEvent as b, createClientPluginManager as c, type FarmClientHydrationMode as d, type FarmClientHydrationSession as e, type FarmClientLocation as f, type FarmClientNavigationAction as g, type FarmClientNavigationErrorEvent as h, type FarmClientNavigationEvent as i, type FarmClientNavigationLoadedEvent as j, type FarmClientNavigationResolvedEvent as k, type FarmClientNavigationSession as l, type FarmClientPerformanceEvent as m, type FarmClientPlugin as n, type FarmClientPluginCloseEvent as o, type FarmClientPluginEnforce as p, type FarmClientPluginErrorEvent as q, type FarmClientPluginErrorPhase as r, type FarmClientPluginManagerOptions as s, type FarmClientPluginMetadata as t, type FarmClientPluginRegistration as u, type FarmClientPluginRouter as v, type FarmClientPluginSetupEvent as w, type FarmClientPluginStateEvent as x };

package/dist/plugin-BJDf43dc.d.ts

@@ -0,0 +1,165 @@
+type MaybePromise<T> = T | Promise<T>;
+type FarmClientPluginEnforce = "pre" | "post";
+type FarmClientNavigationAction = "push" | "replace" | "pop";
+type FarmClientHydrationMode = "hydrate" | "render";
+interface FarmClientLocation {
+    href: string;
+    pathname: string;
+    search: string;
+    hash: string;
+}
+interface FarmClientPluginRouter {
+    navigate(href: string, options?: Record<string, unknown>): MaybePromise<void>;
+    prefetch?(href: string): MaybePromise<void>;
+    getNavigationState?(): unknown;
+}
+interface FarmClientPluginMetadata {
+    name: string;
+    version?: string;
+}
+interface FarmClientPluginSetupEvent<TPublic = undefined> {
+    plugin: FarmClientPluginMetadata;
+    public: Readonly<TPublic>;
+    router: FarmClientPluginRouter;
+    isDev: boolean;
+    isProd: boolean;
+    deploymentId?: string;
+}
+interface FarmClientPluginStateEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginSetupEvent<TPublic> {
+    state: TState;
+}
+interface FarmClientHydrationSession {
+    container: Element;
+    location: FarmClientLocation;
+    mode: FarmClientHydrationMode;
+    startedAt: number;
+}
+interface FarmClientHydrationEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic>, FarmClientHydrationSession {
+}
+interface FarmClientHydrationCompleteEvent<TState = unknown, TPublic = undefined> extends FarmClientHydrationEvent<TState, TPublic> {
+    durationMs: number;
+    recovered: boolean;
+}
+interface FarmClientNavigationSession {
+    id: string;
+    from: FarmClientLocation | null;
+    to: FarmClientLocation;
+    action: FarmClientNavigationAction;
+    signal: AbortSignal;
+    startedAt: number;
+    route?: {
+        pattern?: string | null;
+        params?: Record<string, string>;
+    };
+}
+interface FarmClientNavigationEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic>, FarmClientNavigationSession {
+}
+interface FarmClientNavigationLoadedEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationEvent<TState, TPublic> {
+    durationMs: number;
+    data?: unknown;
+}
+interface FarmClientNavigationResolvedEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationEvent<TState, TPublic> {
+    durationMs: number;
+}
+interface FarmClientNavigationErrorEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationResolvedEvent<TState, TPublic> {
+    error: unknown;
+}
+type FarmClientPluginErrorPhase = "setup" | "hydration" | "navigation" | "window" | "unhandled-rejection" | "performance" | `plugin:${string}` | (string & {});
+interface FarmClientPluginErrorEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    error: unknown;
+    phase: FarmClientPluginErrorPhase;
+    location: FarmClientLocation;
+    navigation?: FarmClientNavigationSession;
+}
+interface FarmClientPerformanceEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    entry: PerformanceEntry;
+    location: FarmClientLocation;
+}
+interface FarmClientPluginCloseEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    reason: "pagehide" | "hmr" | "manual" | (string & {});
+}
+interface FarmClientPlugin<TState = unknown, TPublic = undefined> {
+    setup?(event: FarmClientPluginSetupEvent<TPublic>): MaybePromise<TState>;
+    hydration?: {
+        before?(event: FarmClientHydrationEvent<TState, TPublic>): MaybePromise<void>;
+        after?(event: FarmClientHydrationCompleteEvent<TState, TPublic>): MaybePromise<void>;
+    };
+    navigation?: {
+        before?(event: FarmClientNavigationEvent<TState, TPublic>): MaybePromise<void>;
+        loaded?(event: FarmClientNavigationLoadedEvent<TState, TPublic>): MaybePromise<void>;
+        resolved?(event: FarmClientNavigationResolvedEvent<TState, TPublic>): MaybePromise<void>;
+        rendered?(event: FarmClientNavigationResolvedEvent<TState, TPublic>): MaybePromise<void>;
+        error?(event: FarmClientNavigationErrorEvent<TState, TPublic>): MaybePromise<void>;
+    };
+    error?(event: FarmClientPluginErrorEvent<TState, TPublic>): MaybePromise<void>;
+    performance?(event: FarmClientPerformanceEvent<TState, TPublic>): MaybePromise<void>;
+    close?(event: FarmClientPluginCloseEvent<TState, TPublic>): MaybePromise<void>;
+}
+interface FarmClientPluginRegistration<TPublic = undefined> {
+    name: string;
+    version?: string;
+    enforce?: FarmClientPluginEnforce;
+    definition: FarmClientPlugin<any, TPublic>;
+    public?: TPublic;
+}
+interface FarmClientPluginManagerOptions {
+    router: FarmClientPluginRouter;
+    isDev?: boolean;
+    isProd?: boolean;
+    deploymentId?: string;
+    window?: Window;
+}
+declare class FarmClientPluginManager {
+    private readonly registrations;
+    private readonly options;
+    private readonly instances;
+    private readonly performanceObservers;
+    private startPromise?;
+    private closePromise?;
+    private currentNavigation?;
+    private navigationSequence;
+    private starting;
+    private started;
+    private closed;
+    private readonly reportedErrors;
+    private readonly handleWindowError;
+    private readonly handleUnhandledRejection;
+    private readonly handlePageHide;
+    constructor(registrations: readonly FarmClientPluginRegistration[], options: FarmClientPluginManagerOptions);
+    start(): Promise<void>;
+    beginHydration(input: {
+        container: Element;
+        mode: FarmClientHydrationMode;
+    }): Promise<FarmClientHydrationSession>;
+    completeHydration(session: FarmClientHydrationSession, options?: {
+        recovered?: boolean;
+    }): Promise<void>;
+    failHydration(session: FarmClientHydrationSession, error: unknown): Promise<void>;
+    beginNavigation(input: {
+        from?: string | URL | FarmClientLocation | null;
+        to: string | URL | FarmClientLocation;
+        action: FarmClientNavigationAction;
+        route?: FarmClientNavigationSession["route"];
+    }): Promise<FarmClientNavigationSession>;
+    markNavigationLoaded(session: FarmClientNavigationSession, data?: unknown): Promise<void>;
+    resolveNavigation(session: FarmClientNavigationSession): Promise<void>;
+    scheduleNavigationRendered(session: FarmClientNavigationSession): Promise<void>;
+    failNavigation(session: FarmClientNavigationSession, error: unknown): Promise<void>;
+    reportError(error: unknown, phase: FarmClientPluginErrorPhase, navigation?: FarmClientNavigationSession, location?: FarmClientLocation): Promise<void>;
+    close(reason?: FarmClientPluginCloseEvent["reason"]): Promise<void>;
+    getPlugins(): readonly FarmClientPluginMetadata[];
+    private startInternal;
+    private installBrowserListeners;
+    private installPerformanceObservers;
+    private closeInternal;
+    private runHook;
+    private runErrorHooks;
+    private createSetupEvent;
+    private createStateEvent;
+    private getLocation;
+    private getBaseUrl;
+    private logHookError;
+}
+declare function createClientPluginManager(registrations: readonly FarmClientPluginRegistration[], options: FarmClientPluginManagerOptions): FarmClientPluginManager;
+
+export { FarmClientPluginManager as F, type FarmClientHydrationCompleteEvent as a, type FarmClientHydrationEvent as b, createClientPluginManager as c, type FarmClientHydrationMode as d, type FarmClientHydrationSession as e, type FarmClientLocation as f, type FarmClientNavigationAction as g, type FarmClientNavigationErrorEvent as h, type FarmClientNavigationEvent as i, type FarmClientNavigationLoadedEvent as j, type FarmClientNavigationResolvedEvent as k, type FarmClientNavigationSession as l, type FarmClientPerformanceEvent as m, type FarmClientPlugin as n, type FarmClientPluginCloseEvent as o, type FarmClientPluginEnforce as p, type FarmClientPluginErrorEvent as q, type FarmClientPluginErrorPhase as r, type FarmClientPluginManagerOptions as s, type FarmClientPluginMetadata as t, type FarmClientPluginRegistration as u, type FarmClientPluginRouter as v, type FarmClientPluginSetupEvent as w, type FarmClientPluginStateEvent as x };

package/dist/plugin.cjs

@@ -3955,6 +3955,135 @@ var init_preload = __esm({
   }
 });
 
+// src/security.ts
+function resolveFarmSecurityConfig(input) {
+  if (input === void 0) return { csp: false };
+  if (!isPlainRecord(input)) {
+    throw new TypeError("security must be an object containing the csp option.");
+  }
+  if (Object.prototype.hasOwnProperty.call(input, "contentSecurityPolicy")) {
+    throw new TypeError(
+      "security.contentSecurityPolicy is not supported. Use security.csp instead."
+    );
+  }
+  const csp = input.csp;
+  if (csp === void 0 || csp === false) return { csp: false };
+  if (typeof csp === "string") {
+    return {
+      csp: {
+        value: validateSerializedCsp(csp),
+        reportOnly: false
+      }
+    };
+  }
+  if (!isPlainRecord(csp)) {
+    throw new TypeError("security.csp must be a policy string, false, or an options object.");
+  }
+  const reportOnly = validateReportOnly(csp.reportOnly);
+  if (Object.prototype.hasOwnProperty.call(csp, "value")) {
+    if (Object.prototype.hasOwnProperty.call(csp, "policy") || Object.prototype.hasOwnProperty.call(csp, "directives")) {
+      throw new TypeError(
+        "Resolved security.csp values cannot include policy or directives options."
+      );
+    }
+    return {
+      csp: {
+        value: validateSerializedCsp(csp.value),
+        reportOnly
+      }
+    };
+  }
+  const { policy, directives } = csp;
+  if (policy !== void 0 && directives !== void 0) {
+    throw new TypeError("security.csp accepts either policy or directives, not both.");
+  }
+  if (policy === void 0 && directives === void 0) {
+    throw new TypeError("security.csp requires a policy string or directives object.");
+  }
+  return {
+    csp: {
+      value: policy !== void 0 ? validateSerializedCsp(policy) : serializeFarmCspDirectives(directives),
+      reportOnly
+    }
+  };
+}
+function serializeFarmCspDirectives(directives) {
+  if (!isPlainRecord(directives)) {
+    throw new TypeError("security.csp.directives must be an object.");
+  }
+  const serialized = [];
+  const normalizedNames = /* @__PURE__ */ new Set();
+  for (const [configuredName, configuredValue] of Object.entries(directives)) {
+    if (configuredValue === false || configuredValue === null || configuredValue === void 0) {
+      continue;
+    }
+    const name = normalizeDirectiveName(configuredName);
+    if (normalizedNames.has(name)) {
+      throw new TypeError(`security.csp contains the duplicate directive ${JSON.stringify(name)}.`);
+    }
+    normalizedNames.add(name);
+    const values = configuredValue === true ? [] : (Array.isArray(configuredValue) ? configuredValue : [configuredValue]).map(
+      validateDirectiveValue
+    );
+    serialized.push(values.length > 0 ? `${name} ${values.join(" ")}` : name);
+  }
+  if (serialized.length === 0) {
+    throw new TypeError("security.csp.directives must contain at least one enabled directive.");
+  }
+  return serialized.join("; ");
+}
+function normalizeDirectiveName(value) {
+  const name = value.trim().replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+  if (!/^[a-z][a-z0-9-]*$/.test(name)) {
+    throw new TypeError(`Invalid security.csp directive name: ${JSON.stringify(value)}.`);
+  }
+  return name;
+}
+function validateDirectiveValue(value) {
+  if (typeof value !== "string") {
+    throw new TypeError("security.csp directive values must be strings or booleans.");
+  }
+  const normalized = value.trim();
+  if (!normalized || /[;\r\n]/.test(normalized) || normalized.includes("\0")) {
+    throw new TypeError(`Invalid security.csp directive value: ${JSON.stringify(value)}.`);
+  }
+  return normalized;
+}
+function validateSerializedCsp(value) {
+  if (typeof value !== "string") {
+    throw new TypeError("security.csp policy must be a non-empty single-line string.");
+  }
+  const normalized = value.trim().replace(/;+$/g, "").trim();
+  if (!normalized || /[\r\n]/.test(normalized) || normalized.includes("\0")) {
+    throw new TypeError("security.csp policy must be a non-empty single-line string.");
+  }
+  return normalized;
+}
+function validateReportOnly(value) {
+  if (value === void 0) return false;
+  if (typeof value !== "boolean") {
+    throw new TypeError("security.csp.reportOnly must be a boolean.");
+  }
+  return value;
+}
+function isPlainRecord(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return false;
+  const prototype = Object.getPrototypeOf(value);
+  return prototype === Object.prototype || prototype === null;
+}
+var init_security = __esm({
+  "src/security.ts"() {
+    "use strict";
+    __name(resolveFarmSecurityConfig, "resolveFarmSecurityConfig");
+    __name(serializeFarmCspDirectives, "serializeFarmCspDirectives");
+    __name(normalizeDirectiveName, "normalizeDirectiveName");
+    __name(validateDirectiveValue, "validateDirectiveValue");
+    __name(validateSerializedCsp, "validateSerializedCsp");
+    __name(validateReportOnly, "validateReportOnly");
+    __name(isPlainRecord, "isPlainRecord");
+  }
+});
+
 // src/write-file-if-changed.ts
 function writeFileIfChanged(filePath, content) {
   try {
@@ -8513,6 +8642,7 @@ var init_config2 = __esm({
     init_config();
     init_auth_config();
     init_preload();
+    init_security();
     init_config_entry();
     __name(getDeployTargetForPreset, "getDeployTargetForPreset");
     DOCS_CONFIG_FILENAMES = [
@@ -19110,6 +19240,7 @@ init_devtools_config();
 init_config();
 init_auth_config();
 init_preload();
+init_security();
 var defaultDocsConfig = {
   enabled: false,
   entry: "/docs",
@@ -19177,6 +19308,7 @@ var _FarmApp = class _FarmApp {
       routeRules: normalizeRouteRules(config.routeRules),
       context: config.context || (() => void 0),
       serverActions: resolveServerActionsConfig(config.serverActions),
+      security: resolveFarmSecurityConfig(config.security),
       images: resolveFarmImageConfig(config.images),
       performance: resolveFarmPerformanceConfig(config.performance),
       i18n: isResolvedI18nConfig(config.i18n) ? config.i18n : resolveFarmI18nConfig(config.i18n, {