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

package/dist/markdown.d.mts

@@ -0,0 +1,60 @@
+type FarmMarkdownRouteInput = string | {
+    route: string;
+    title?: string;
+    cache?: number | false;
+};
+interface FarmMarkdownUserConfig {
+    /**
+     * Enable generated markdown representations for React pages.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Routes that may expose generated markdown. Every page is exposed by default.
+     */
+    expose?: boolean | FarmMarkdownRouteInput[];
+    /** @deprecated Use `expose`. */
+    routes?: FarmMarkdownRouteInput[];
+    cache?: number | false;
+    includeMetadata?: boolean;
+}
+interface FarmMarkdownResolvedRoute {
+    route: string;
+    title?: string;
+    cache?: number | false;
+}
+interface FarmMarkdownResolvedConfig {
+    enabled: boolean;
+    expose: true | FarmMarkdownResolvedRoute[];
+    cache: number | false;
+    includeMetadata: boolean;
+}
+interface FarmMarkdownMirrorTarget {
+    pathname: string;
+    route: FarmMarkdownResolvedRoute | null;
+}
+interface ResolveMarkdownMirrorTargetOptions {
+    accept?: string | null;
+}
+interface CreateMarkdownMirrorResponseOptions {
+    request: Request;
+    config?: FarmMarkdownResolvedConfig;
+    routeExists?: (pathname: string) => boolean;
+    renderPage: (request: Request) => Response | Promise<Response>;
+}
+interface ApplyMarkdownNegotiationHeadersOptions {
+    config?: FarmMarkdownResolvedConfig;
+    pathname: string;
+}
+declare function resolveMarkdownConfig(config: FarmMarkdownUserConfig | boolean | undefined): FarmMarkdownResolvedConfig;
+declare function resolveMarkdownMirrorTarget(config: FarmMarkdownResolvedConfig | undefined, pathname: string, options?: ResolveMarkdownMirrorTargetOptions): FarmMarkdownMirrorTarget | null;
+declare function createMarkdownMirrorResponse(options: CreateMarkdownMirrorResponseOptions): Promise<Response | null>;
+declare function applyMarkdownNegotiationHeaders(response: Response, options: ApplyMarkdownNegotiationHeadersOptions): Response;
+declare function htmlToMarkdown(html: string, options?: {
+    title?: string;
+    sourcePath?: string;
+    includeMetadata?: boolean;
+}): string;
+declare function requestAcceptsMarkdown(accept: string | null | undefined): boolean;
+
+export { type ApplyMarkdownNegotiationHeadersOptions, type CreateMarkdownMirrorResponseOptions, type FarmMarkdownMirrorTarget, type FarmMarkdownResolvedConfig, type FarmMarkdownResolvedRoute, type FarmMarkdownRouteInput, type FarmMarkdownUserConfig, type ResolveMarkdownMirrorTargetOptions, applyMarkdownNegotiationHeaders, createMarkdownMirrorResponse, htmlToMarkdown, requestAcceptsMarkdown, resolveMarkdownConfig, resolveMarkdownMirrorTarget };

package/dist/markdown.d.ts

@@ -0,0 +1,60 @@
+type FarmMarkdownRouteInput = string | {
+    route: string;
+    title?: string;
+    cache?: number | false;
+};
+interface FarmMarkdownUserConfig {
+    /**
+     * Enable generated markdown representations for React pages.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Routes that may expose generated markdown. Every page is exposed by default.
+     */
+    expose?: boolean | FarmMarkdownRouteInput[];
+    /** @deprecated Use `expose`. */
+    routes?: FarmMarkdownRouteInput[];
+    cache?: number | false;
+    includeMetadata?: boolean;
+}
+interface FarmMarkdownResolvedRoute {
+    route: string;
+    title?: string;
+    cache?: number | false;
+}
+interface FarmMarkdownResolvedConfig {
+    enabled: boolean;
+    expose: true | FarmMarkdownResolvedRoute[];
+    cache: number | false;
+    includeMetadata: boolean;
+}
+interface FarmMarkdownMirrorTarget {
+    pathname: string;
+    route: FarmMarkdownResolvedRoute | null;
+}
+interface ResolveMarkdownMirrorTargetOptions {
+    accept?: string | null;
+}
+interface CreateMarkdownMirrorResponseOptions {
+    request: Request;
+    config?: FarmMarkdownResolvedConfig;
+    routeExists?: (pathname: string) => boolean;
+    renderPage: (request: Request) => Response | Promise<Response>;
+}
+interface ApplyMarkdownNegotiationHeadersOptions {
+    config?: FarmMarkdownResolvedConfig;
+    pathname: string;
+}
+declare function resolveMarkdownConfig(config: FarmMarkdownUserConfig | boolean | undefined): FarmMarkdownResolvedConfig;
+declare function resolveMarkdownMirrorTarget(config: FarmMarkdownResolvedConfig | undefined, pathname: string, options?: ResolveMarkdownMirrorTargetOptions): FarmMarkdownMirrorTarget | null;
+declare function createMarkdownMirrorResponse(options: CreateMarkdownMirrorResponseOptions): Promise<Response | null>;
+declare function applyMarkdownNegotiationHeaders(response: Response, options: ApplyMarkdownNegotiationHeadersOptions): Response;
+declare function htmlToMarkdown(html: string, options?: {
+    title?: string;
+    sourcePath?: string;
+    includeMetadata?: boolean;
+}): string;
+declare function requestAcceptsMarkdown(accept: string | null | undefined): boolean;
+
+export { type ApplyMarkdownNegotiationHeadersOptions, type CreateMarkdownMirrorResponseOptions, type FarmMarkdownMirrorTarget, type FarmMarkdownResolvedConfig, type FarmMarkdownResolvedRoute, type FarmMarkdownRouteInput, type FarmMarkdownUserConfig, type ResolveMarkdownMirrorTargetOptions, applyMarkdownNegotiationHeaders, createMarkdownMirrorResponse, htmlToMarkdown, requestAcceptsMarkdown, resolveMarkdownConfig, resolveMarkdownMirrorTarget };

package/dist/markdown.mjs

@@ -0,0 +1,18 @@
+import {
+  applyMarkdownNegotiationHeaders,
+  createMarkdownMirrorResponse,
+  htmlToMarkdown,
+  requestAcceptsMarkdown,
+  resolveMarkdownConfig,
+  resolveMarkdownMirrorTarget
+} from "./chunk-7FBJLMQH.mjs";
+import "./chunk-CGILA3WO.mjs";
+export {
+  applyMarkdownNegotiationHeaders,
+  createMarkdownMirrorResponse,
+  htmlToMarkdown,
+  requestAcceptsMarkdown,
+  resolveMarkdownConfig,
+  resolveMarkdownMirrorTarget
+};
+//# sourceMappingURL=markdown.mjs.map

package/dist/markdown.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/metadata-Cm9ujH4I.d.ts

@@ -0,0 +1,22 @@
+import { s as Metadata } from './client-plugins-DU9oMspX.js';
+
+type MetadataImageKind = "opengraph" | "twitter";
+interface FarmMetadataImageReference {
+    kind: MetadataImageKind;
+    href: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+    contentType?: string;
+}
+interface RenderedMetadataHead {
+    title: string;
+    tags: string;
+    hasFavicon: boolean;
+}
+type MetadataRecord = Metadata & Record<string, any>;
+declare function mergeMetadata(base: MetadataRecord | undefined, next: MetadataRecord | undefined): MetadataRecord;
+declare function addMetadataImageReference(metadata: MetadataRecord, reference: FarmMetadataImageReference): MetadataRecord;
+declare function renderMetadataHead(metadata: MetadataRecord | undefined): RenderedMetadataHead;
+
+export { type MetadataImageKind as M, addMetadataImageReference as a, mergeMetadata as m, renderMetadataHead as r };

package/dist/metadata-DacXbnLA.d.mts

@@ -0,0 +1,22 @@
+import { s as Metadata } from './client-plugins-BI2R6Eae.mjs';
+
+type MetadataImageKind = "opengraph" | "twitter";
+interface FarmMetadataImageReference {
+    kind: MetadataImageKind;
+    href: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+    contentType?: string;
+}
+interface RenderedMetadataHead {
+    title: string;
+    tags: string;
+    hasFavicon: boolean;
+}
+type MetadataRecord = Metadata & Record<string, any>;
+declare function mergeMetadata(base: MetadataRecord | undefined, next: MetadataRecord | undefined): MetadataRecord;
+declare function addMetadataImageReference(metadata: MetadataRecord, reference: FarmMetadataImageReference): MetadataRecord;
+declare function renderMetadataHead(metadata: MetadataRecord | undefined): RenderedMetadataHead;
+
+export { type MetadataImageKind as M, addMetadataImageReference as a, mergeMetadata as m, renderMetadataHead as r };