rwsdk 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/lib/e2e/constants.d.mts

@@ -0,0 +1,12 @@
+export declare const SETUP_PLAYGROUND_ENV_TIMEOUT: number;
+export declare const DEPLOYMENT_TIMEOUT: number;
+export declare const DEPLOYMENT_MIN_TRIES: number;
+export declare const DEPLOYMENT_CHECK_TIMEOUT: number;
+export declare const PUPPETEER_TIMEOUT: number;
+export declare const HYDRATION_TIMEOUT: number;
+export declare const DEV_SERVER_TIMEOUT: number;
+export declare const DEV_SERVER_MIN_TRIES: number;
+export declare const SETUP_WAIT_TIMEOUT: number;
+export declare const TEST_MAX_RETRIES: number;
+export declare const TEST_MAX_RETRIES_PER_CODE: number;
+export declare const INSTALL_DEPENDENCIES_RETRIES: number;

package/dist/lib/e2e/constants.mjs

@@ -0,0 +1,40 @@
+export const SETUP_PLAYGROUND_ENV_TIMEOUT = process.env
+    .RWSDK_SETUP_PLAYGROUND_ENV_TIMEOUT
+    ? parseInt(process.env.RWSDK_SETUP_PLAYGROUND_ENV_TIMEOUT, 10)
+    : 15 * 60 * 1000;
+export const DEPLOYMENT_TIMEOUT = process.env.RWSDK_DEPLOYMENT_TIMEOUT
+    ? parseInt(process.env.RWSDK_DEPLOYMENT_TIMEOUT, 10)
+    : 5 * 60 * 1000;
+export const DEPLOYMENT_MIN_TRIES = process.env.RWSDK_DEPLOYMENT_MIN_TRIES
+    ? parseInt(process.env.RWSDK_DEPLOYMENT_MIN_TRIES, 10)
+    : 5;
+export const DEPLOYMENT_CHECK_TIMEOUT = process.env
+    .RWSDK_DEPLOYMENT_CHECK_TIMEOUT
+    ? parseInt(process.env.RWSDK_DEPLOYMENT_CHECK_TIMEOUT, 10)
+    : 5 * 60 * 1000;
+export const PUPPETEER_TIMEOUT = process.env.RWSDK_PUPPETEER_TIMEOUT
+    ? parseInt(process.env.RWSDK_PUPPETEER_TIMEOUT, 10)
+    : 60 * 1000 * 2;
+export const HYDRATION_TIMEOUT = process.env.RWSDK_HYDRATION_TIMEOUT
+    ? parseInt(process.env.RWSDK_HYDRATION_TIMEOUT, 10)
+    : 5000;
+export const DEV_SERVER_TIMEOUT = process.env.RWSDK_DEV_SERVER_TIMEOUT
+    ? parseInt(process.env.RWSDK_DEV_SERVER_TIMEOUT, 10)
+    : 5 * 60 * 1000;
+export const DEV_SERVER_MIN_TRIES = process.env.RWSDK_DEV_SERVER_MIN_TRIES
+    ? parseInt(process.env.RWSDK_DEV_SERVER_MIN_TRIES, 10)
+    : 5;
+export const SETUP_WAIT_TIMEOUT = process.env.RWSDK_SETUP_WAIT_TIMEOUT
+    ? parseInt(process.env.RWSDK_SETUP_WAIT_TIMEOUT, 10)
+    : 10 * 60 * 1000;
+export const TEST_MAX_RETRIES = process.env.RWSDK_TEST_MAX_RETRIES
+    ? parseInt(process.env.RWSDK_TEST_MAX_RETRIES, 10)
+    : 10;
+export const TEST_MAX_RETRIES_PER_CODE = process.env
+    .RWSDK_TEST_MAX_RETRIES_PER_CODE
+    ? parseInt(process.env.RWSDK_TEST_MAX_RETRIES_PER_CODE, 10)
+    : 6;
+export const INSTALL_DEPENDENCIES_RETRIES = process.env
+    .RWSDK_INSTALL_DEPENDENCIES_RETRIES
+    ? parseInt(process.env.RWSDK_INSTALL_DEPENDENCIES_RETRIES, 10)
+    : 10;

package/dist/lib/e2e/environment.mjs

@@ -8,8 +8,8 @@ import { basename, join, relative, resolve } from "path";
 import tmp from "tmp-promise";
 import { $ } from "../../lib/$.mjs";
 import { ROOT_DIR } from "../constants.mjs";
+import { INSTALL_DEPENDENCIES_RETRIES } from "./constants.mjs";
 import { retry } from "./retry.mjs";
-import { INSTALL_DEPENDENCIES_RETRIES } from "./testHarness.mjs";
 const log = debug("rwsdk:e2e:environment");
 const getTempDir = async () => {
     return tmp.dir({ unsafeCleanup: true });

package/dist/lib/e2e/testHarness.d.mts

@@ -1,7 +1,8 @@
 import { type Browser, type Page } from "puppeteer-core";
 import { test } from "vitest";
+import { DEPLOYMENT_CHECK_TIMEOUT, DEPLOYMENT_MIN_TRIES, DEPLOYMENT_TIMEOUT, DEV_SERVER_MIN_TRIES, DEV_SERVER_TIMEOUT, HYDRATION_TIMEOUT, INSTALL_DEPENDENCIES_RETRIES, PUPPETEER_TIMEOUT, SETUP_PLAYGROUND_ENV_TIMEOUT, SETUP_WAIT_TIMEOUT, TEST_MAX_RETRIES, TEST_MAX_RETRIES_PER_CODE } from "./constants.mjs";
 export type { Browser, Page } from "puppeteer-core";
-export declare const INSTALL_DEPENDENCIES_RETRIES: number;
+export { DEPLOYMENT_CHECK_TIMEOUT, DEPLOYMENT_MIN_TRIES, DEPLOYMENT_TIMEOUT, DEV_SERVER_MIN_TRIES, DEV_SERVER_TIMEOUT, HYDRATION_TIMEOUT, INSTALL_DEPENDENCIES_RETRIES, PUPPETEER_TIMEOUT, SETUP_PLAYGROUND_ENV_TIMEOUT, SETUP_WAIT_TIMEOUT, TEST_MAX_RETRIES, TEST_MAX_RETRIES_PER_CODE, };
 interface DevServerInstance {
     url: string;
     stopDev: () => Promise<void>;

package/dist/lib/e2e/testHarness.mjs

@@ -4,48 +4,12 @@ import path, { basename, dirname, join as pathJoin } from "path";
 import puppeteer from "puppeteer-core";
 import { afterAll, afterEach, beforeAll, beforeEach, describe, test, } from "vitest";
 import { launchBrowser } from "./browser.mjs";
+import { DEPLOYMENT_CHECK_TIMEOUT, DEPLOYMENT_MIN_TRIES, DEPLOYMENT_TIMEOUT, DEV_SERVER_MIN_TRIES, DEV_SERVER_TIMEOUT, HYDRATION_TIMEOUT, INSTALL_DEPENDENCIES_RETRIES, PUPPETEER_TIMEOUT, SETUP_PLAYGROUND_ENV_TIMEOUT, SETUP_WAIT_TIMEOUT, TEST_MAX_RETRIES, TEST_MAX_RETRIES_PER_CODE, } from "./constants.mjs";
 import { runDevServer } from "./dev.mjs";
 import { poll, pollValue } from "./poll.mjs";
 import { deleteD1Database, deleteWorker, isRelatedToTest, runRelease, } from "./release.mjs";
 import { setupTarballEnvironment } from "./tarball.mjs";
-const SETUP_PLAYGROUND_ENV_TIMEOUT = process.env
-    .RWSDK_SETUP_PLAYGROUND_ENV_TIMEOUT
-    ? parseInt(process.env.RWSDK_SETUP_PLAYGROUND_ENV_TIMEOUT, 10)
-    : 15 * 60 * 1000;
-const DEPLOYMENT_TIMEOUT = process.env.RWSDK_DEPLOYMENT_TIMEOUT
-    ? parseInt(process.env.RWSDK_DEPLOYMENT_TIMEOUT, 10)
-    : 5 * 60 * 1000;
-const DEPLOYMENT_MIN_TRIES = process.env.RWSDK_DEPLOYMENT_MIN_TRIES
-    ? parseInt(process.env.RWSDK_DEPLOYMENT_MIN_TRIES, 10)
-    : 5;
-const DEPLOYMENT_CHECK_TIMEOUT = process.env.RWSDK_DEPLOYMENT_CHECK_TIMEOUT
-    ? parseInt(process.env.RWSDK_DEPLOYMENT_CHECK_TIMEOUT, 10)
-    : 5 * 60 * 1000;
-const PUPPETEER_TIMEOUT = process.env.RWSDK_PUPPETEER_TIMEOUT
-    ? parseInt(process.env.RWSDK_PUPPETEER_TIMEOUT, 10)
-    : 60 * 1000 * 2;
-const HYDRATION_TIMEOUT = process.env.RWSDK_HYDRATION_TIMEOUT
-    ? parseInt(process.env.RWSDK_HYDRATION_TIMEOUT, 10)
-    : 5000;
-const DEV_SERVER_TIMEOUT = process.env.RWSDK_DEV_SERVER_TIMEOUT
-    ? parseInt(process.env.RWSDK_DEV_SERVER_TIMEOUT, 10)
-    : 5 * 60 * 1000;
-const DEV_SERVER_MIN_TRIES = process.env.RWSDK_DEV_SERVER_MIN_TRIES
-    ? parseInt(process.env.RWSDK_DEV_SERVER_MIN_TRIES, 10)
-    : 5;
-const SETUP_WAIT_TIMEOUT = process.env.RWSDK_SETUP_WAIT_TIMEOUT
-    ? parseInt(process.env.RWSDK_SETUP_WAIT_TIMEOUT, 10)
-    : 10 * 60 * 1000;
-const TEST_MAX_RETRIES = process.env.RWSDK_TEST_MAX_RETRIES
-    ? parseInt(process.env.RWSDK_TEST_MAX_RETRIES, 10)
-    : 10;
-const TEST_MAX_RETRIES_PER_CODE = process.env.RWSDK_TEST_MAX_RETRIES_PER_CODE
-    ? parseInt(process.env.RWSDK_TEST_MAX_RETRIES_PER_CODE, 10)
-    : 6;
-export const INSTALL_DEPENDENCIES_RETRIES = process.env
-    .RWSDK_INSTALL_DEPENDENCIES_RETRIES
-    ? parseInt(process.env.RWSDK_INSTALL_DEPENDENCIES_RETRIES, 10)
-    : 10;
+export { DEPLOYMENT_CHECK_TIMEOUT, DEPLOYMENT_MIN_TRIES, DEPLOYMENT_TIMEOUT, DEV_SERVER_MIN_TRIES, DEV_SERVER_TIMEOUT, HYDRATION_TIMEOUT, INSTALL_DEPENDENCIES_RETRIES, PUPPETEER_TIMEOUT, SETUP_PLAYGROUND_ENV_TIMEOUT, SETUP_WAIT_TIMEOUT, TEST_MAX_RETRIES, TEST_MAX_RETRIES_PER_CODE, };
 // Environment variable flags for skipping tests
 const SKIP_DEV_SERVER_TESTS = process.env.RWSDK_SKIP_DEV === "1";
 const SKIP_DEPLOYMENT_TESTS = process.env.RWSDK_SKIP_DEPLOY === "1";

package/dist/runtime/client/client.d.ts

@@ -1,6 +1,7 @@
 import "./setWebpackRequire";
 export { default as React } from "react";
 export { ClientOnly } from "./ClientOnly.js";
+export { initClientNavigation, navigate } from "./navigation.js";
 import type { HydrationOptions, Transport } from "./types";
 export declare const fetchTransport: Transport;
 export declare const initClient: ({ transport, hydrateRootOptions, handleResponse, }?: {

package/dist/runtime/client/client.js

@@ -11,6 +11,7 @@ import { createFromFetch, createFromReadableStream, encodeReply, } from "react-s
 import { rscStream } from "rsc-html-stream/client";
 export { default as React } from "react";
 export { ClientOnly } from "./ClientOnly.js";
+export { initClientNavigation, navigate } from "./navigation.js";
 export const fetchTransport = (transportContext) => {
     const fetchCallServer = async (id, args) => {
         const url = new URL(window.location.href);

package/dist/runtime/client/navigation.d.ts

@@ -4,6 +4,14 @@ export interface ClientNavigationOptions {
     scrollBehavior?: "auto" | "smooth" | "instant";
 }
 export declare function validateClickEvent(event: MouseEvent, target: HTMLElement): boolean;
+export interface NavigateOptions {
+    history?: "push" | "replace";
+    info?: {
+        scrollToTop?: boolean;
+        scrollBehavior?: "auto" | "smooth" | "instant";
+    };
+}
+export declare function navigate(href: string, options?: NavigateOptions): Promise<void>;
 export declare function initClientNavigation(opts?: ClientNavigationOptions): {
     handleResponse: (response: Response) => boolean;
 };

package/dist/runtime/client/navigation.js

@@ -1,10 +1,3 @@
-function saveScrollPosition(x, y) {
-    window.history.replaceState({
-        ...window.history.state,
-        scrollX: x,
-        scrollY: y,
-    }, "", window.location.href);
-}
 export function validateClickEvent(event, target) {
     // should this only work for left click?
     if (event.button !== 0) {
@@ -37,19 +30,43 @@ export function validateClickEvent(event, target) {
     }
     return true;
 }
+let IS_CLIENT_NAVIGATION = false;
+export async function navigate(href, options = { history: "push" }) {
+    if (!IS_CLIENT_NAVIGATION) {
+        window.location.href = href;
+        return;
+    }
+    saveScrollPosition(window.scrollX, window.scrollY);
+    const url = window.location.origin + href;
+    if (options.history === "push") {
+        window.history.pushState({ path: href }, "", url);
+    }
+    else {
+        window.history.replaceState({ path: href }, "", url);
+    }
+    await globalThis.__rsc_callServer;
+    const scrollToTop = options.info?.scrollToTop ?? true;
+    const scrollBehavior = options.info?.scrollBehavior ?? "instant";
+    if (scrollToTop && history.scrollRestoration === "auto") {
+        window.scrollTo({
+            top: 0,
+            left: 0,
+            behavior: scrollBehavior,
+        });
+        saveScrollPosition(0, 0);
+    }
+}
+function saveScrollPosition(x, y) {
+    window.history.replaceState({
+        ...window.history.state,
+        scrollX: x,
+        scrollY: y,
+    }, "", window.location.href);
+}
 export function initClientNavigation(opts = {}) {
-    const options = {
-        onNavigate: async function onNavigate() {
-            // @ts-expect-error
-            await globalThis.__rsc_callServer();
-        },
-        scrollToTop: true,
-        scrollBehavior: "instant",
-        ...opts,
-    };
+    IS_CLIENT_NAVIGATION = true;
     history.scrollRestoration = "auto";
     document.addEventListener("click", async function handleClickEvent(event) {
-        // Prevent default navigation
         if (!validateClickEvent(event, event.target)) {
             return;
         }
@@ -57,28 +74,18 @@ export function initClientNavigation(opts = {}) {
         const el = event.target;
         const a = el.closest("a");
         const href = a?.getAttribute("href");
-        saveScrollPosition(window.scrollX, window.scrollY);
-        window.history.pushState({ path: href }, "", window.location.origin + href);
-        await options.onNavigate();
-        if (options.scrollToTop && history.scrollRestoration === "auto") {
-            window.scrollTo({
-                top: 0,
-                left: 0,
-                behavior: options.scrollBehavior,
-            });
-            saveScrollPosition(0, 0);
-        }
-        history.scrollRestoration = "auto";
+        navigate(href);
     }, true);
     window.addEventListener("popstate", async function handlePopState() {
-        saveScrollPosition(window.scrollX, window.scrollY);
-        await options.onNavigate();
+        // @ts-expect-error
+        await globalThis.__rsc_callServer();
     });
     // Return a handleResponse function for use with initClient
     return {
         handleResponse: function handleResponse(response) {
             if (!response.ok) {
                 // Redirect to the current page (window.location) to show the error
+                // This means the page that produced the error is called twice.
                 window.location.href = window.location.href;
                 return false;
             }

package/dist/runtime/entries/clientSSR.d.ts

@@ -1,2 +1,3 @@
 import "./types/ssr";
 export * from "../lib/streams/consumeEventStream";
+export declare const navigate: () => void;

package/dist/runtime/entries/clientSSR.js

@@ -1,2 +1,5 @@
 import "./types/ssr";
 export * from "../lib/streams/consumeEventStream";
+export const navigate = () => {
+    /* stub */
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rwsdk",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.5",
   "description": "Build fast, server-driven webapps on Cloudflare with SSR, RSC, and realtime",
   "type": "module",
   "bin": {