@sigx/server-renderer 0.1.5 → 0.1.7

package/dist/server/streaming.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Core streaming utilities for async SSR
+ *
+ * Provides the client-side `$SIGX_REPLACE` function and replacement script
+ * generation used by core async streaming. These are strategy-agnostic —
+ * any async component with `ssr.load()` gets streamed without needing a plugin.
+ *
+ * Plugins (e.g., islands) can augment replacements via `onAsyncComponentResolved`.
+ */
+/**
+ * Escape a JSON string for safe embedding inside <script> tags.
+ * Prevents XSS by replacing characters that could break out of the script context.
+ */
+export declare function escapeJsonForScript(json: string): string;
+/**
+ * Generate the streaming bootstrap script (injected once before any replacements).
+ * Defines `window.$SIGX_REPLACE` which swaps async placeholders with rendered HTML.
+ */
+export declare function generateStreamingScript(): string;
+/**
+ * Generate a replacement script for a resolved async component.
+ */
+export declare function generateReplacementScript(id: number, html: string, extraScript?: string): string;
+//# sourceMappingURL=streaming.d.ts.map

package/dist/server/streaming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["../../src/server/streaming.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMxD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,CAgBhD;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAQhG"}

package/dist/server/types.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Shared types for server rendering APIs.
+ *
+ * Kept separate to avoid circular imports between ssr.ts and render-api.ts.
+ */
+import type { Signal, PrimitiveSignal, Primitive } from 'sigx';
+/**
+ * SSR-enhanced signal function type.
+ * Extends the base signal() with an optional `name` parameter used as the
+ * serialization key for hydration state transfer.
+ *
+ * Both `createTrackingSignal` (server/islands) and `createRestoringSignal` (client/hydration)
+ * use this type and share the same key-generation contract via `generateSignalKey`.
+ */
+export type SSRSignalFn = {
+    <T extends Primitive>(initial: T, name?: string): PrimitiveSignal<T>;
+    <T extends object>(initial: T, name?: string): Signal<T>;
+};
+/**
+ * Generate a stable key for a signal during SSR state tracking/restoration.
+ *
+ * Named signals use the provided name; unnamed signals use a positional key (`$0`, `$1`, ...).
+ * Both server-side tracking (`createTrackingSignal`) and client-side restoration
+ * (`createRestoringSignal`) MUST use this function to guarantee key parity.
+ */
+export declare function generateSignalKey(name: string | undefined, index: number): string;
+/**
+ * Streaming callbacks interface
+ */
+export interface StreamCallbacks {
+    /** Called when the initial shell (synchronous content) is ready */
+    onShellReady: (html: string) => void;
+    /** Called for each async chunk (replacement scripts, hydration data) */
+    onAsyncChunk: (chunk: string) => void;
+    /** Called when all streaming is complete */
+    onComplete: () => void;
+    /** Called on error */
+    onError: (error: Error) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/server/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/server/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEjF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,mEAAmE;IACnE,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,wEAAwE;IACxE,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,4CAA4C;IAC5C,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,sBAAsB;IACtB,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CACnC"}