@askrjs/askr 0.0.2 → 0.0.4

package/dist/ssr/index.d.cts

@@ -0,0 +1,123 @@
+import { P as Props, J as JSXElement } from '../jsx-AzPM8gMS.cjs';
+import { b as RouteHandler } from '../router-DaGtH1Sq.cjs';
+
+/**
+ * Common call contracts: SSR error types
+ */
+declare class SSRDataMissingError extends Error {
+    readonly code = "SSR_DATA_MISSING";
+    constructor(message?: string);
+}
+
+/**
+ * Common call contracts: SSR types
+ */
+type SSRData = Record<string, unknown>;
+/** Lightweight context for synchronous render passes */
+type RenderContext = {
+    seed: number;
+};
+
+/**
+ * Shared SSR types
+ */
+
+/** VNode representation for SSR rendering */
+type VNode = {
+    type: string | SSRComponent;
+    props?: Props;
+    children?: unknown[];
+};
+/**
+ * Component function signature for SSR.
+ * Components receive props and an optional context with signal and SSR context.
+ */
+type SSRComponent = (props: Props, context?: {
+    signal?: AbortSignal;
+    ssr?: RenderContext;
+}) => VNode | JSXElement | string | number | boolean | null;
+
+/**
+ * SSR Data Management
+ *
+ * Manages render-phase keying for deterministic SSR data lookup.
+ * Note: SSR collection/prepass APIs have been removed — SSR is strictly synchronous.
+ */
+
+type ResourceDescriptor = {
+    key: string;
+    fn: (opts: {
+        signal?: AbortSignal;
+    }) => Promise<unknown> | unknown;
+    deps: unknown[];
+    index: number;
+};
+type ResourcePlan = {
+    resources: ResourceDescriptor[];
+};
+/** @deprecated SSR prepass has been removed */
+declare function resolvePlan(_plan: ResourcePlan): Promise<Record<string, unknown>>;
+/** @deprecated SSR prepass has been removed */
+declare function collectResources(_opts: {
+    url: string;
+    routes: SSRRoute[];
+}): ResourcePlan;
+/** @deprecated Alias for resolvePlan */
+declare const resolveResources: typeof resolvePlan;
+
+/**
+ * SSR - Server-Side Rendering
+ *
+ * Renders Askr components to static HTML strings for server-side rendering.
+ * SSR is synchronous: async components are not supported; async work should use
+ * `resource()` which is rejected during synchronous SSR. This module throws
+ * when an async component or async resource is encountered during sync SSR.
+ */
+
+type Component = SSRComponent;
+declare function pushSSRStrictPurityGuard(): void;
+declare function popSSRStrictPurityGuard(): void;
+/**
+ * Single synchronous SSR entrypoint: render a component to an HTML string.
+ * This is strictly synchronous and deterministic. Optionally provide a seed
+ * for deterministic randomness via `options.seed`.
+ */
+declare function renderToStringSync(component: (props?: Record<string, unknown>) => VNode | JSXElement | string | number | null, props?: Record<string, unknown>, options?: {
+    seed?: number;
+    data?: SSRData;
+}): string;
+declare function renderToStringSyncForUrl(opts: {
+    url: string;
+    routes: Array<{
+        path: string;
+        handler: RouteHandler;
+        namespace?: string;
+    }>;
+    options?: {
+        seed?: number;
+        data?: SSRData;
+    };
+}): string;
+
+type SSRRoute = {
+    path: string;
+    handler: RouteHandler;
+    namespace?: string;
+};
+declare function renderToString(component: (props?: Record<string, unknown>) => VNode | JSXElement | string | number | null): string;
+declare function renderToString(opts: {
+    url: string;
+    routes: SSRRoute[];
+    seed?: number;
+    data?: SSRData;
+}): string;
+declare function renderToStream(opts: {
+    url: string;
+    routes: SSRRoute[];
+    seed?: number;
+    data?: SSRData;
+    onChunk(html: string): void;
+    onComplete(): void;
+}): void;
+
+export { type Component, type ResourcePlan, type SSRComponent, SSRDataMissingError, type SSRRoute, type VNode, collectResources, popSSRStrictPurityGuard, pushSSRStrictPurityGuard, renderToStream, renderToString, renderToStringSync, renderToStringSyncForUrl, resolvePlan, resolveResources };

package/dist/ssr/index.d.ts

@@ -0,0 +1,123 @@
+import { P as Props, J as JSXElement } from '../jsx-AzPM8gMS.js';
+import { b as RouteHandler } from '../router-DaGtH1Sq.js';
+
+/**
+ * Common call contracts: SSR error types
+ */
+declare class SSRDataMissingError extends Error {
+    readonly code = "SSR_DATA_MISSING";
+    constructor(message?: string);
+}
+
+/**
+ * Common call contracts: SSR types
+ */
+type SSRData = Record<string, unknown>;
+/** Lightweight context for synchronous render passes */
+type RenderContext = {
+    seed: number;
+};
+
+/**
+ * Shared SSR types
+ */
+
+/** VNode representation for SSR rendering */
+type VNode = {
+    type: string | SSRComponent;
+    props?: Props;
+    children?: unknown[];
+};
+/**
+ * Component function signature for SSR.
+ * Components receive props and an optional context with signal and SSR context.
+ */
+type SSRComponent = (props: Props, context?: {
+    signal?: AbortSignal;
+    ssr?: RenderContext;
+}) => VNode | JSXElement | string | number | boolean | null;
+
+/**
+ * SSR Data Management
+ *
+ * Manages render-phase keying for deterministic SSR data lookup.
+ * Note: SSR collection/prepass APIs have been removed — SSR is strictly synchronous.
+ */
+
+type ResourceDescriptor = {
+    key: string;
+    fn: (opts: {
+        signal?: AbortSignal;
+    }) => Promise<unknown> | unknown;
+    deps: unknown[];
+    index: number;
+};
+type ResourcePlan = {
+    resources: ResourceDescriptor[];
+};
+/** @deprecated SSR prepass has been removed */
+declare function resolvePlan(_plan: ResourcePlan): Promise<Record<string, unknown>>;
+/** @deprecated SSR prepass has been removed */
+declare function collectResources(_opts: {
+    url: string;
+    routes: SSRRoute[];
+}): ResourcePlan;
+/** @deprecated Alias for resolvePlan */
+declare const resolveResources: typeof resolvePlan;
+
+/**
+ * SSR - Server-Side Rendering
+ *
+ * Renders Askr components to static HTML strings for server-side rendering.
+ * SSR is synchronous: async components are not supported; async work should use
+ * `resource()` which is rejected during synchronous SSR. This module throws
+ * when an async component or async resource is encountered during sync SSR.
+ */
+
+type Component = SSRComponent;
+declare function pushSSRStrictPurityGuard(): void;
+declare function popSSRStrictPurityGuard(): void;
+/**
+ * Single synchronous SSR entrypoint: render a component to an HTML string.
+ * This is strictly synchronous and deterministic. Optionally provide a seed
+ * for deterministic randomness via `options.seed`.
+ */
+declare function renderToStringSync(component: (props?: Record<string, unknown>) => VNode | JSXElement | string | number | null, props?: Record<string, unknown>, options?: {
+    seed?: number;
+    data?: SSRData;
+}): string;
+declare function renderToStringSyncForUrl(opts: {
+    url: string;
+    routes: Array<{
+        path: string;
+        handler: RouteHandler;
+        namespace?: string;
+    }>;
+    options?: {
+        seed?: number;
+        data?: SSRData;
+    };
+}): string;
+
+type SSRRoute = {
+    path: string;
+    handler: RouteHandler;
+    namespace?: string;
+};
+declare function renderToString(component: (props?: Record<string, unknown>) => VNode | JSXElement | string | number | null): string;
+declare function renderToString(opts: {
+    url: string;
+    routes: SSRRoute[];
+    seed?: number;
+    data?: SSRData;
+}): string;
+declare function renderToStream(opts: {
+    url: string;
+    routes: SSRRoute[];
+    seed?: number;
+    data?: SSRData;
+    onChunk(html: string): void;
+    onComplete(): void;
+}): void;
+
+export { type Component, type ResourcePlan, type SSRComponent, SSRDataMissingError, type SSRRoute, type VNode, collectResources, popSSRStrictPurityGuard, pushSSRStrictPurityGuard, renderToStream, renderToString, renderToStringSync, renderToStringSyncForUrl, resolvePlan, resolveResources };