@bgub/fig-server 0.0.1 → 0.1.0-alpha.1

package/dist/payload.d.ts

@@ -1,18 +1,26 @@
-import { a as ServerErrorPayload, i as ServerErrorInfo } from "./types-4X0JT0wt.js";
-import { DataResourceKeyInput, ElementType, FigAssetResource, FigAssetResourceList, FigDataHydrationEntry, FigDataStoreHandle, FigNode, FontResource, Key, ModulePreloadResource, PreconnectResource, PreloadResource, ScriptResource, StylesheetResource } from "@bgub/fig";
+import { n as ServerErrorInfo, r as ServerErrorPayload } from "./types-CimwEFsf.js";
+import { DataResourceKeyInput, FigAssetResourceList, FigNode, Props } from "@bgub/fig";
 //#region src/payload.d.ts
 interface PayloadRenderResult {
-  abort(reason?: unknown): void;
   allReady: Promise<void>;
   contentType: string;
   stream: ReadableStream<Uint8Array>;
 }
+type PayloadComponent = (props: Props & {
+  children?: FigNode;
+}) => FigNode;
 interface PayloadRenderOptions {
   clientReferenceAssets?: (metadata: {
     id: string;
   }) => FigAssetResourceList;
-  codec?: PayloadCodec;
+  componentAssets?: (type: PayloadComponent) => FigAssetResourceList | undefined;
   dataPartition?: DataResourceKeyInput;
+  /**
+   * Encoded bytes the result stream buffers before row flushing pauses until
+   * the consumer reads (rendering itself never pauses; encoded rows wait
+   * queued). Defaults to 65536; values below 1 are clamped to 1.
+   */
+  highWaterMark?: number;
   signal?: AbortSignal;
   /**
    * Decides what crosses the wire when a server render throws, mirroring the
@@ -21,238 +29,7 @@ interface PayloadRenderOptions {
    * an empty payload.
    */
   onError?: (error: unknown, info: ServerErrorInfo) => ServerErrorPayload | undefined;
-  refreshBoundary?: string;
-}
-interface PayloadRootLike {
-  data?: FigDataStoreHandle;
-  render(node: FigNode): void;
-}
-type SerializedAssetResource = {
-  crossOrigin?: StylesheetResource["crossOrigin"];
-  href: string;
-  kind: "stylesheet";
-  media?: string;
-  precedence?: string;
-} | {
-  as: string;
-  crossOrigin?: PreloadResource["crossOrigin"];
-  fetchPriority?: PreloadResource["fetchPriority"];
-  href: string;
-  kind: "preload";
-  type?: string;
-} | {
-  crossOrigin?: ModulePreloadResource["crossOrigin"];
-  fetchPriority?: ModulePreloadResource["fetchPriority"];
-  href: string;
-  kind: "modulepreload";
-} | {
-  async?: boolean;
-  crossOrigin?: ScriptResource["crossOrigin"];
-  defer?: boolean;
-  kind: "script";
-  module?: boolean;
-  src: string;
-} | {
-  crossOrigin?: FontResource["crossOrigin"];
-  fetchPriority?: FontResource["fetchPriority"];
-  href: string;
-  kind: "font";
-  type: string;
-} | {
-  crossOrigin?: PreconnectResource["crossOrigin"];
-  href: string;
-  kind: "preconnect";
-};
-/**
- * Semantic payload row before a PayloadCodec turns it into bytes. This row
- * model is the stable contract; a codec's byte layout is intentionally opaque.
- */
-type PayloadRow = {
-  tag: "assets";
-  value: SerializedAssetResource[];
-} | {
-  id: number;
-  tag: "client";
-  value: {
-    id: string;
-    assets?: SerializedAssetResource[];
-    exportName?: string;
-    ssr?: true;
-  };
-} | {
-  tag: "data";
-  value: PayloadDataHydrationEntry[];
-} | {
-  id: number;
-  tag: "error";
-  value: ServerErrorPayload;
-} | {
-  id: number;
-  tag: "model";
-  value: PayloadModel;
-} | {
-  boundary: string;
-  tag: "refresh-error";
-  value: ServerErrorPayload;
-} | {
-  boundary: string;
-  tag: "refresh";
-  value: PayloadModel;
-};
-/**
- * Transport-safe model value used inside payload rows. The shape is public so
- * custom codecs and framework integrations can encode/decode rows, but callers
- * should not treat the exact tagged representation as an app data format.
- */
-type PayloadModel = null | boolean | number | string | PayloadModel[] | {
-  [key: string]: PayloadModel;
-} | PayloadElementModel | PayloadSpecialModel;
-type PayloadElementModel = {
-  $fig: "element";
-  id?: number;
-  key: Key | null;
-  props: PayloadModel;
-  type: string | PayloadSpecialModel;
-};
-type PayloadSpecialModel = {
-  $fig: "array";
-  id: number;
-  value: PayloadModel[];
-} | {
-  $fig: "boundary";
-  child: PayloadModel;
-  id: string;
-} | {
-  $fig: "bigint";
-  value: string;
-} | {
-  $fig: "client";
-  id: number;
-} | {
-  $fig: "date";
-  value: string;
-} | {
-  $fig: "fragment";
-} | {
-  $fig: "lazy";
-  id: number;
-} | {
-  $fig: "map";
-  entries: Array<[PayloadModel, PayloadModel]>;
-  id: number;
-} | {
-  $fig: "number";
-  value: "Infinity" | "-Infinity" | "-0" | "NaN";
-} | {
-  $fig: "object";
-  id?: number;
-  value: Record<string, PayloadModel>;
-} | {
-  $fig: "promise";
-  id: number;
-} | {
-  $fig: "ref";
-  id: number;
-} | {
-  $fig: "set";
-  id: number;
-  values: PayloadModel[];
-} | {
-  $fig: "symbol";
-  key: string;
-} | {
-  $fig: "suspense";
-} | {
-  $fig: "undefined";
-} | {
-  $fig: "view-transition";
-};
-type PayloadDataHydrationEntry = Omit<FigDataHydrationEntry, "value"> & {
-  value: PayloadModel;
-};
-interface PayloadClientReferenceMetadata {
-  id: string;
-  exportName?: string;
-  ssr?: boolean;
-}
-interface PayloadClientReferenceRecord extends PayloadClientReferenceMetadata {
-  assets?: readonly FigAssetResource[];
-}
-interface PayloadResponseOptions {
-  codec?: PayloadCodec;
-  loadClientReference?: (metadata: PayloadClientReferenceMetadata) => Promise<unknown>;
-  resolveClientReference?: (metadata: PayloadClientReferenceMetadata) => ElementType<any> | undefined;
-}
-interface PayloadResponse {
-  bindRoot(root: PayloadRootLike): () => void;
-  readonly codec: PayloadCodec;
-  getAssetResources(): readonly FigAssetResource[];
-  getClientReferences(): readonly PayloadClientReferenceRecord[];
-  getRoot(): FigNode;
-  preloadClientReferences(): Promise<void>;
-  processBytesChunk(chunk: Uint8Array): void;
-  processStream(stream: ReadableStream<Uint8Array>, signal?: AbortSignal | null): Promise<void>;
-  processStringChunk(chunk: string): void;
-  readonly rootReady: Promise<void>;
-  subscribe(listener: () => void): () => void;
 }
-type PayloadFetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
-interface PayloadFetchOptions extends RequestInit {
-  fetch?: PayloadFetch;
-  refreshBoundary?: string;
-}
-interface PayloadCodec {
-  /**
-   * Opaque implementation id, e.g. "json" or "binary". Fig checks this id at
-   * transport boundaries; the encoded byte layout is not a public contract.
-   */
-  readonly id: string;
-  readonly contentType: string;
-  /**
-   * Creates a streaming row decoder. The decoder calls `onRow` for each
-   * complete semantic row. If `onRow` throws, the decoder must propagate that
-   * error; when it can already see more complete sibling rows in the same
-   * input chunk, it should process those siblings before rethrowing so
-   * notifications already implied by earlier rows are not lost.
-   */
-  createDecoder(onRow: (row: PayloadRow) => void): PayloadDecoder;
-  encodeRow(row: PayloadRow): Uint8Array;
-}
-interface PayloadDecoder {
-  decode(chunk: Uint8Array): void;
-  flush(): void;
-}
-declare const PAYLOAD_BOUNDARY_HEADER = "x-fig-payload-boundary";
-declare class PayloadFetchError extends Error {
-  readonly response: Response;
-  readonly status: number;
-  constructor(response: Response);
-}
-/**
- * Readable development-oriented codec: one JSON payload row per newline.
- */
-declare const jsonPayloadCodec: PayloadCodec;
-type PayloadBoundaryProps = {
-  children?: FigNode;
-  id: string;
-};
-declare const PayloadBoundary: {
-  (props: PayloadBoundaryProps): FigNode;
-  readonly $$typeof: symbol;
-};
 declare function renderToPayloadStream(node: FigNode, options?: PayloadRenderOptions): PayloadRenderResult;
-declare function createPayloadResponse(options?: PayloadResponseOptions): PayloadResponse;
-declare function isPayloadRequestCancelled(error: unknown): boolean;
-declare function fetchPayload(response: PayloadResponse, input: RequestInfo | URL, options?: PayloadFetchOptions): Promise<Response>;
-/**
- * Encode ordinary data values into PayloadModel. Server component references
- * such as Fig elements, promises, and client references are handled by the
- * payload renderer before ordinary values reach this helper.
- */
-declare function encodePayloadValue(value: unknown): PayloadModel;
-/** Decode values produced by encodePayloadValue. */
-declare function decodePayloadValue(model: PayloadModel): unknown;
-declare function encodePayloadDataEntries(entries: readonly FigDataHydrationEntry[]): PayloadDataHydrationEntry[];
-declare function decodePayloadDataEntries(entries: readonly PayloadDataHydrationEntry[]): FigDataHydrationEntry[];
 //#endregion
-export { PAYLOAD_BOUNDARY_HEADER, PayloadBoundary, PayloadClientReferenceMetadata, PayloadClientReferenceRecord, PayloadCodec, PayloadDataHydrationEntry, PayloadDecoder, PayloadFetch, PayloadFetchError, PayloadFetchOptions, PayloadModel, PayloadRenderOptions, PayloadRenderResult, PayloadResponse, PayloadResponseOptions, PayloadRootLike, PayloadRow, SerializedAssetResource, createPayloadResponse, decodePayloadDataEntries, decodePayloadValue, encodePayloadDataEntries, encodePayloadValue, fetchPayload, isPayloadRequestCancelled, jsonPayloadCodec, renderToPayloadStream };
+export { PayloadComponent, PayloadRenderOptions, PayloadRenderResult, renderToPayloadStream };