ripple 0.4.2 → 0.4.3

package/tests/server/track-async-serialization.test.tsrx

@@ -1,5 +1,5 @@
 import { DEV } from 'esm-env';
-import { setTransport, track, trackAsync } from 'ripple';
+import { setTransport, track, trackAsync, trackReadOnly } from 'ripple';
 import * as devalue from 'devalue';
 
 const TRACK_ASYNC_PUBLIC_ERROR_MESSAGE = 'An error occurred during async rendering';
@@ -147,7 +147,7 @@ describe('trackAsync serialization (server)', () => {
 		async function deps_for(read: 'direct' | 'view') {
 			function App() @{
 				const count = track(3);
-				const view = count.readOnly();
+				const view = trackReadOnly(count);
 				@try {
 					const data = trackAsync(
 						() => Promise.resolve(`count-${read === 'view' ? view.value : count.value}`),
@@ -160,7 +160,7 @@ describe('trackAsync serialization (server)', () => {
 
 			const { body } = await render(App);
 			const match = body.match(
-				/<script id="__ripple_ta_[a-f0-9]+" type="application\/json">(.*?)<\/script>/s,
+				/<script id="__ripple_ta_[a-z0-9]+" type="application\/json">(.*?)<\/script>/s,
 			);
 			expect(match).not.toBeNull();
 			return JSON.parse(/** @type {RegExpMatchArray} */ (match)[1]).deps;
@@ -170,7 +170,7 @@ describe('trackAsync serialization (server)', () => {
 			expect(await deps_for('direct')).toHaveLength(1);
 		});
 
-		it('records the tracked behind a readOnly() view a trackAsync read', async () => {
+		it('records the tracked behind a trackReadOnly() view a trackAsync read', async () => {
 			// The view itself has no hash; the client must still re-subscribe to
 			// the source after hydration, so its hash is what gets recorded.
 			expect(await deps_for('view')).toEqual(await deps_for('direct'));
@@ -190,7 +190,7 @@ describe('trackAsync serialization (server)', () => {
 
 			const { body } = await render(App);
 			const match = body.match(
-				/<script id="__ripple_ta_[a-f0-9]+" type="application\/json">(.*?)<\/script>/s,
+				/<script id="__ripple_ta_[a-z0-9]+" type="application\/json">(.*?)<\/script>/s,
 			);
 			expect(match).not.toBeNull();
 			const text = /** @type {RegExpMatchArray} */ (match)[1];
@@ -362,7 +362,7 @@ describe('trackAsync serialization (server)', () => {
 
 		const { body } = await render(App);
 		// Find all script tag IDs
-		const matches = [...body.matchAll(/id="(__ripple_ta_[a-f0-9]+)"/g)];
+		const matches = [...body.matchAll(/id="(__ripple_ta_[a-z0-9]+)"/g)];
 		expect(matches.length).toBe(2);
 		// Hashes should be different
 		expect(matches[0][1]).not.toBe(matches[1][1]);

package/tests/utils/tracked-types.test.js

@@ -44,7 +44,7 @@ function create_service(source) {
 describe('Ripple tracked types', () => {
 	it('shows public names in value property hovers', () => {
 		const source = `
-			import { track } from 'ripple';
+			import { track, trackReadOnly } from 'ripple';
 			const count = track(0);
 			const derived = track(() => count.value * 2);
 			const writable = track(() => count.value, undefined, true);
@@ -75,12 +75,12 @@ describe('Ripple tracked types', () => {
 
 	it('preserves writes, read-only views, and tracked component props', () => {
 		const source = `
-			import { track, type Component, type Derived, type Tracked } from 'ripple';
+			import { track, type Component, type Derived, type Tracked, trackReadOnly } from 'ripple';
 			const count = track(0);
 			count.value = 1;
 			const tracked: Tracked<number> = track(count);
 			const derived: Derived<number> = tracked;
-			const view = count.readOnly();
+			const view = trackReadOnly(count);
 			// @ts-expect-error Read-only views reject writes.
 			view.value = 2;
 			const computed = track(() => count.value * 2);

package/types/index.d.ts

@@ -225,12 +225,6 @@ export const SUSPENSE_REJECTED: unique symbol;
 export interface Tracked<V> extends TrackedCallable<V> {
 	'#v': V;
 	value: V;
-	/**
-	 * A read-only view of this value: a `Derived<V>` that follows it, for a
-	 * receiver that should read but not write it. Equivalent to
-	 * `track(() => tracked.value)`.
-	 */
-	readOnly(): Derived<V>;
 }
 // Augment Tracked to be callable when V is a Component.
 // This allows tracked component values to continue flowing through JSX checks.
@@ -242,8 +236,6 @@ interface TrackedCallable<V> {
 export interface Derived<V> extends TrackedCallable<V> {
 	'#v': V;
 	readonly value: V;
-	/** A derived is already read-only: returns itself. */
-	readOnly(): Derived<V>;
 }
 // A computed value created with a setter (`track(fn, get, set)`) or with
 // `true` in the setter position: writes land as a temporary value until the
@@ -284,6 +276,14 @@ export function track<V>(
 // Overload for non-function values
 export function track<V>(value?: V, get?: (v: V) => V, set?: (next: V, prev: V) => V): Tracked<V>;
 
+/**
+ * A read-only view of a tracked or derived value, for a receiver that should
+ * read but not write it: a `Derived<V>` that follows a `Tracked<V>` or a
+ * writable derived (equivalent to `track(() => value.value)`), or a read-only
+ * derived as it is.
+ */
+export function trackReadOnly<V>(value: Tracked<V> | Derived<V>): Derived<V>;
+
 export function trackAsync<V>(
 	value: () => PromiseLike<V> | { promise: PromiseLike<V>; abortController: AbortController },
 ): Tracked<V>;

package/types/server.d.ts

@@ -94,3 +94,20 @@ export declare function render(
 	component: Component,
 	options: StreamingRenderOptions,
 ): Promise<RenderStreamResult>;
+
+export interface PrerenderResult {
+	head: string;
+	body: string;
+	/** the scoped CSS text — emit it in a `<style data-ripple-ssr>` tag */
+	css: string;
+	topLevelError: Error | null;
+}
+
+/**
+ * Renders a component to static HTML: buffered, every boundary settled, the
+ * scoped CSS as text. The static-generation counterpart of `render()`.
+ */
+export declare function prerender(
+	component: Component,
+	options?: { rootBoundary?: RootBoundaryOptions },
+): Promise<PrerenderResult>;