lit-ui-router-ssr 0.4.0 → 0.5.0

package/README.md

@@ -1,7 +1,7 @@
 # lit-ui-router-ssr
 
 [![npm version](https://img.shields.io/npm/v/lit-ui-router-ssr.svg)](https://npmx.dev/package/lit-ui-router-ssr)
-[![GitHub Release](https://img.shields.io/github/v/release/simshanith/lit-ui-router?filter=lit-ui-router-ssr@*)](https://github.com/simshanith/lit-ui-router/releases/?q=lit-ui-router-ssr)
+[![GitHub Release](https://img.shields.io/github/v/release/simshanith/lit-ui-router?filter=lit-ui-router-ssr@*)](https://lit-ui-router.dev/gh/releases/lit-ui-router-ssr/latest)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![Website](https://img.shields.io/website?url=https%3A%2F%2Flit-ui-router.dev)](https://lit-ui-router.dev/packages/ssr)
 [![codecov](https://codecov.io/gh/simshanith/lit-ui-router/graph/badge.svg?component=lit-ui-router-ssr)](https://app.codecov.io/gh/simshanith/lit-ui-router?components%5B0%5D=lit-ui-router-ssr)
@@ -100,11 +100,12 @@ first page's slashed spelling does not resolve to the same shell.
 ## Settling the router on each path
 
 A server render reads the router only once its transition has landed, resolves included.
-`settle(router, path)` sets the url, syncs the router to it, and resolves with the transition that
-landed, so the synchronous render after it reads every resolve. A `redirectTo` chain settles on its
-final state, and a path the router already stands on resolves at once.
+`settle(router, path)`, the `ui-router-server/ssr` step this package re-exports, sets the url, syncs
+the router to it, and resolves with the transition that landed, so the synchronous render after it
+reads every resolve. A `redirectTo` chain settles on its final state, and a path the router already
+stands on resolves at once.
 
-A page fails to land in three ways, and each rejects rather than hangs:
+A page fails to land in four ways, and each rejects rather than hangs:
 
 - **No rule matches.** A url no state claims, on a router with no `otherwise` rule, rejects with an
   `Error` naming it. An `otherwise` rule is itself a match and settles on its state.
@@ -112,6 +113,8 @@ A page fails to land in three ways, and each rejects rather than hangs:
   `Rejection`, the resolve's error in its `detail`. Core's `defaultErrorHandler` still logs it.
 - **Nothing lands in time.** `{ timeout }` bounds the wait, `10_000` ms by default; `0` waits without
   a limit.
+- **The url keeps rewriting.** `{ maxRewrites }` bounds a chain of url rules that rewrite the url to
+  another url, `10` by default.
 
 `settle()` never calls `router.start()`, which runs once per router: it drives `urlService`
 directly, so a page loop calls it once per path on the same router, started or not.

package/dist/development/index.js

@@ -1,4 +1,4 @@
 export { prerender } from "./prerender.js";
-export { settle } from "./settle.js";
+export { settle } from "ui-router-server/ssr";
 export { UiViewRenderer } from "./ui-view-renderer.js";
 //# sourceMappingURL=index.js.map

package/dist/development/signature.js

@@ -1,4 +1,4 @@
 export const signatureAttribute = "data-lit-ui-router-ssr";
 export const signatureSelector = `script[type="application/json"][${signatureAttribute}]`;
-export const packageVersion = "0.4.0";
+export const packageVersion = "0.5.0";
 //# sourceMappingURL=signature.js.map

package/dist/index.d.ts

@@ -5,6 +5,6 @@
 * @module
 */
 export { type EmittedPage, type FileWriter, prerender, type PrerenderOptions, type PrerenderResult, type PrerenderTally, type RedirectLine, type RenderContext } from "./prerender.js";
-export { settle, type SettleOptions } from "./settle.js";
+export { settle, type SettleOptions } from "ui-router-server/ssr";
 export { UiViewRenderer } from "./ui-view-renderer.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,4 @@
 export { prerender } from "./prerender.js";
-export { settle } from "./settle.js";
+export { settle } from "ui-router-server/ssr";
 export { UiViewRenderer } from "./ui-view-renderer.js";
 //# sourceMappingURL=index.js.map

package/dist/signature.js

@@ -1,4 +1,4 @@
 export const signatureAttribute = "data-lit-ui-router-ssr";
 export const signatureSelector = `script[type="application/json"][${signatureAttribute}]`;
-export const packageVersion = "0.4.0";
+export const packageVersion = "0.5.0";
 //# sourceMappingURL=signature.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lit-ui-router-ssr",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Static prerendering for lit-ui-router: mount verdicts in, an emitted site out",
   "homepage": "https://lit-ui-router.dev/packages/ssr",
   "bugs": {
@@ -72,7 +72,7 @@
     "@uirouter/core": "^6.0.8",
     "lit": "^3.1.2",
     "lit-ui-router": "^1.16.1",
-    "ui-router-server": "^0.2.0 || ^0.3.0 || ^0.4.0"
+    "ui-router-server": "^0.5.0"
   },
   "peerDependenciesMeta": {
     "@lit-labs/ssr-client": {

package/src/index.ts

@@ -15,6 +15,6 @@ export {
   type RenderContext,
 } from './prerender.js';
 
-export { settle, type SettleOptions } from './settle.js';
+export { settle, type SettleOptions } from 'ui-router-server/ssr';
 
 export { UiViewRenderer } from './ui-view-renderer.js';

package/dist/development/settle.js

@@ -1,48 +0,0 @@
-import { RejectType } from "@uirouter/core";
-const maxRewrites = 10;
-export const settle = (router, path, options = {}) => {
-	const { timeout = 1e4 } = options;
-	const { globals, stateService, transitionService, urlService } = router;
-	return new Promise((resolve, reject) => {
-		let timer;
-		const done = () => {
-			offSuccess();
-			offError();
-			clearTimeout(timer);
-		};
-		const land = (transition) => {
-			done();
-			resolve(transition);
-		};
-		const fail = (reason) => {
-			done();
-			reject(reason);
-		};
-		const offSuccess = transitionService.onSuccess({}, land);
-		const offError = transitionService.onError({}, (transition) => {
-			const rejection = transition.error();
-			if (rejection.type === RejectType.SUPERSEDED) return;
-			if (rejection.type === RejectType.IGNORED) {
-				if (!globals.transition && globals.successfulTransitions.size() > 0) land(globals.successfulTransitions.peekTail());
-				return;
-			}
-			fail(new Error(rejection.message, { cause: rejection }));
-		});
-		if (timeout > 0 && timeout !== Infinity) timer = setTimeout(() => fail(new Error(`settle: ${path} did not land within ${timeout}ms`)), timeout);
-		urlService.url(path);
-		for (let rewrites = 0; rewrites <= maxRewrites; rewrites++) {
-			const best = urlService.match({
-				path: urlService.path(),
-				search: urlService.search(),
-				hash: urlService.hash()
-			});
-			if (!best) return fail(new Error(`settle: no url rule matches ${urlService.url()} and the router declares no otherwise`));
-			if (best.rule.type === "STATE" && globals.successfulTransitions.size() > 0 && stateService.href(best.rule.state, best.match) === stateService.href(globals.current, globals.params)) return land(globals.successfulTransitions.peekTail());
-			const before = urlService.url();
-			urlService.sync();
-			if (urlService.url() === before) return;
-		}
-		fail(new Error(`settle: ${path} rewrote its url more than ${maxRewrites} times`));
-	});
-};
-//# sourceMappingURL=settle.js.map

package/dist/development/settle.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"settle.js","mappings":"AACA,SAAS,kBAAkB;AAkB3B,MAAM,cAAc;AAwCpB,OAAO,MAAM,UACX,QACA,MACA,UAAyB,CAAC,MACF;CACxB,MAAM,EAAE,UAAU,QAAW;CAC7B,MAAM,EAAE,SAAS,cAAc,mBAAmB,eAAe;CAEjE,OAAO,IAAI,SAAqB,SAAS,WAAW;EAClD,IAAI;EAEJ,MAAM,aAAmB;GACvB,WAAW;GACX,SAAS;GACT,aAAa,KAAK;EACpB;EAEA,MAAM,QAAQ,eAAiC;GAC7C,KAAK;GACL,QAAQ,UAAU;EACpB;EAEA,MAAM,QAAQ,WAAwB;GACpC,KAAK;GACL,OAAO,MAAM;EACf;EAGA,MAAM,aAAa,kBAAkB,UAAU,CAAC,GAAG,IAAI;EAGvD,MAAM,WAAW,kBAAkB,QAAQ,CAAC,IAAI,eAAe;GAC7D,MAAM,YAAY,WAAW,MAAM;GAEnC,IAAI,UAAU,SAAS,WAAW,YAAY;GAE9C,IAAI,UAAU,SAAS,WAAW,SAAS;IAEzC,IAAI,CAAC,QAAQ,cAAc,QAAQ,sBAAsB,KAAK,IAAI,GAChE,KAAK,QAAQ,sBAAsB,SAAS,CAAC;IAE/C;GACF;GAEA,KAAK,IAAI,MAAM,UAAU,SAAS,EAAE,OAAO,UAAU,CAAC,CAAC;EACzD,CAAC;EAED,IAAI,UAAU,KAAK,YAAY,UAC7B,QAAQ,iBAEJ,KAAK,IAAI,MAAM,WAAW,KAAK,uBAAuB,QAAQ,GAAG,CAAC,GACpE,OACF;EAEF,WAAW,IAAI,IAAI;EAEnB,KAAK,IAAI,WAAW,GAAG,YAAY,aAAa,YAAY;GAC1D,MAAM,OAAO,WAAW,MAAM;IAC5B,MAAM,WAAW,KAAK;IACtB,QAAQ,WAAW,OAAO;IAC1B,MAAM,WAAW,KAAK;GACxB,CAAC;GAED,IAAI,CAAC,MACH,OAAO,KACL,IAAI,MACF,+BAA+B,WAAW,IAAI,EAAE,sCAClD,CACF;GAIF,IACE,KAAK,KAAK,SAAS,WACnB,QAAQ,sBAAsB,KAAK,IAAI,KACvC,aAAa,KACV,KAAK,KAAmB,OACzB,KAAK,KACP,MAAM,aAAa,KAAK,QAAQ,SAAS,QAAQ,MAAM,GAEvD,OAAO,KAAK,QAAQ,sBAAsB,SAAS,CAAC;GACtD,MAAM,SAAS,WAAW,IAAI;GAC9B,WAAW,KAAK;GAGhB,IAAI,WAAW,IAAI,MAAM,QAAQ;EACnC;EAEA,KACE,IAAI,MACF,WAAW,KAAK,6BAA6B,YAAY,OAC3D,CACF;CACF,CAAC;AACH","names":[],"ignoreList":[],"sources":["../../src/settle.ts"]}

package/dist/settle.d.ts

@@ -1,49 +0,0 @@
-import type { Transition, UIRouter } from "@uirouter/core";
-/** Options for {@link settle | `settle`}. */
-export interface SettleOptions {
-	/**
-	* How long to wait for the transition to land, in milliseconds, before
-	* rejecting. Defaults to `10_000`; `0` or `Infinity` waits without a limit.
-	*/
-	timeout?: number;
-}
-/**
-* Moves `router` to `path` and resolves once the transition the url starts
-* has landed, resolves included, so a synchronous render reads the router
-* after it.
-*
-* It never calls `router.start()`, which runs once per router: it sets the
-* url and syncs the router to it, whether or not the router is listening.
-* A page loop calls it once per path on the same router. A `redirectTo`
-* chain settles on its final state, and a path the router already stands on
-* resolves with the transition that brought it there.
-*
-* A failed transition still reaches `stateService.defaultErrorHandler`,
-* which logs it unless replaced.
-*
-* @param router - the server router, its location installed with `installServerLocation`
-* @param path - the url to settle on, relative to the mount, query included
-* @param options - how long to wait
-* @returns the transition that landed
-* @throws an `Error` when no url rule matches `path` and the router declares no `otherwise`
-* @throws an `Error` whose `cause` is the transition's `Rejection` when it fails, a failed resolve's error in that rejection's `detail`
-* @throws an `Error` when nothing lands within {@link SettleOptions.timeout | `timeout`}
-*
-* @example
-* ```ts
-* import { prerender, settle } from 'lit-ui-router-ssr';
-*
-* await prerender({
-*   mounts,
-*   router,
-*   outDir: 'dist',
-*   paths: ['/', '/sheet/7B'],
-*   renderShell: async (verdict, { path }) => {
-*     await settle(router, path);
-*     return page();
-*   },
-* });
-* ```
-*/
-export declare const settle: (router: UIRouter, path: string, options?: SettleOptions) => Promise<Transition>;
-//# sourceMappingURL=settle.d.ts.map

package/dist/settle.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"settle.d.ts","mappings":"AAEA,cAGE,YACA,gBACK;;AAGP,iBAAiB,cAAc;;;;;CAK7B;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,OAAO,cAAM,SACX,QAAQ,UACR,cACA,UAAS,kBACR,QAAQ","names":[],"ignoreList":[],"sources":["../src/settle.ts"]}

package/dist/settle.js

@@ -1,48 +0,0 @@
-import { RejectType } from "@uirouter/core";
-const maxRewrites = 10;
-export const settle = (router, path, options = {}) => {
-	const { timeout = 1e4 } = options;
-	const { globals, stateService, transitionService, urlService } = router;
-	return new Promise((resolve, reject) => {
-		let timer;
-		const done = () => {
-			offSuccess();
-			offError();
-			clearTimeout(timer);
-		};
-		const land = (transition) => {
-			done();
-			resolve(transition);
-		};
-		const fail = (reason) => {
-			done();
-			reject(reason);
-		};
-		const offSuccess = transitionService.onSuccess({}, land);
-		const offError = transitionService.onError({}, (transition) => {
-			const rejection = transition.error();
-			if (rejection.type === RejectType.SUPERSEDED) return;
-			if (rejection.type === RejectType.IGNORED) {
-				if (!globals.transition && globals.successfulTransitions.size() > 0) land(globals.successfulTransitions.peekTail());
-				return;
-			}
-			fail(new Error(rejection.message, { cause: rejection }));
-		});
-		if (timeout > 0 && timeout !== Infinity) timer = setTimeout(() => fail(new Error(`settle: ${path} did not land within ${timeout}ms`)), timeout);
-		urlService.url(path);
-		for (let rewrites = 0; rewrites <= maxRewrites; rewrites++) {
-			const best = urlService.match({
-				path: urlService.path(),
-				search: urlService.search(),
-				hash: urlService.hash()
-			});
-			if (!best) return fail(new Error(`settle: no url rule matches ${urlService.url()} and the router declares no otherwise`));
-			if (best.rule.type === "STATE" && globals.successfulTransitions.size() > 0 && stateService.href(best.rule.state, best.match) === stateService.href(globals.current, globals.params)) return land(globals.successfulTransitions.peekTail());
-			const before = urlService.url();
-			urlService.sync();
-			if (urlService.url() === before) return;
-		}
-		fail(new Error(`settle: ${path} rewrote its url more than ${maxRewrites} times`));
-	});
-};
-//# sourceMappingURL=settle.js.map

package/dist/settle.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"settle.js","mappings":"AACA,SAAS,kBAAkB;AAkB3B,MAAM,cAAc;AAwCpB,OAAO,MAAM,UACX,QACA,MACA,UAAyB,CAAC,MACF;CACxB,MAAM,EAAE,UAAU,QAAW;CAC7B,MAAM,EAAE,SAAS,cAAc,mBAAmB,eAAe;CAEjE,OAAO,IAAI,SAAqB,SAAS,WAAW;EAClD,IAAI;EAEJ,MAAM,aAAmB;GACvB,WAAW;GACX,SAAS;GACT,aAAa,KAAK;EACpB;EAEA,MAAM,QAAQ,eAAiC;GAC7C,KAAK;GACL,QAAQ,UAAU;EACpB;EAEA,MAAM,QAAQ,WAAwB;GACpC,KAAK;GACL,OAAO,MAAM;EACf;EAGA,MAAM,aAAa,kBAAkB,UAAU,CAAC,GAAG,IAAI;EAGvD,MAAM,WAAW,kBAAkB,QAAQ,CAAC,IAAI,eAAe;GAC7D,MAAM,YAAY,WAAW,MAAM;GAEnC,IAAI,UAAU,SAAS,WAAW,YAAY;GAE9C,IAAI,UAAU,SAAS,WAAW,SAAS;IAEzC,IAAI,CAAC,QAAQ,cAAc,QAAQ,sBAAsB,KAAK,IAAI,GAChE,KAAK,QAAQ,sBAAsB,SAAS,CAAC;IAE/C;GACF;GAEA,KAAK,IAAI,MAAM,UAAU,SAAS,EAAE,OAAO,UAAU,CAAC,CAAC;EACzD,CAAC;EAED,IAAI,UAAU,KAAK,YAAY,UAC7B,QAAQ,iBAEJ,KAAK,IAAI,MAAM,WAAW,KAAK,uBAAuB,QAAQ,GAAG,CAAC,GACpE,OACF;EAEF,WAAW,IAAI,IAAI;EAEnB,KAAK,IAAI,WAAW,GAAG,YAAY,aAAa,YAAY;GAC1D,MAAM,OAAO,WAAW,MAAM;IAC5B,MAAM,WAAW,KAAK;IACtB,QAAQ,WAAW,OAAO;IAC1B,MAAM,WAAW,KAAK;GACxB,CAAC;GAED,IAAI,CAAC,MACH,OAAO,KACL,IAAI,MACF,+BAA+B,WAAW,IAAI,EAAE,sCAClD,CACF;GAIF,IACE,KAAK,KAAK,SAAS,WACnB,QAAQ,sBAAsB,KAAK,IAAI,KACvC,aAAa,KACV,KAAK,KAAmB,OACzB,KAAK,KACP,MAAM,aAAa,KAAK,QAAQ,SAAS,QAAQ,MAAM,GAEvD,OAAO,KAAK,QAAQ,sBAAsB,SAAS,CAAC;GACtD,MAAM,SAAS,WAAW,IAAI;GAC9B,WAAW,KAAK;GAGhB,IAAI,WAAW,IAAI,MAAM,QAAQ;EACnC;EAEA,KACE,IAAI,MACF,WAAW,KAAK,6BAA6B,YAAY,OAC3D,CACF;CACF,CAAC;AACH","names":[],"ignoreList":[],"sources":["../src/settle.ts"]}

package/src/settle.ts

@@ -1,154 +0,0 @@
-// Drives a server router's url sync to a landed transition, since `start()` and `urlService.sync()` drop the promise.
-import { RejectType } from '@uirouter/core';
-import type {
-  RawParams,
-  StateRule,
-  Transition,
-  UIRouter,
-} from '@uirouter/core';
-
-/** Options for {@link settle | `settle`}. */
-export interface SettleOptions {
-  /**
-   * How long to wait for the transition to land, in milliseconds, before
-   * rejecting. Defaults to `10_000`; `0` or `Infinity` waits without a limit.
-   */
-  timeout?: number;
-}
-
-// Bounds a chain of url rules that rewrite the url to another url.
-const maxRewrites = 10;
-
-/**
- * Moves `router` to `path` and resolves once the transition the url starts
- * has landed, resolves included, so a synchronous render reads the router
- * after it.
- *
- * It never calls `router.start()`, which runs once per router: it sets the
- * url and syncs the router to it, whether or not the router is listening.
- * A page loop calls it once per path on the same router. A `redirectTo`
- * chain settles on its final state, and a path the router already stands on
- * resolves with the transition that brought it there.
- *
- * A failed transition still reaches `stateService.defaultErrorHandler`,
- * which logs it unless replaced.
- *
- * @param router - the server router, its location installed with `installServerLocation`
- * @param path - the url to settle on, relative to the mount, query included
- * @param options - how long to wait
- * @returns the transition that landed
- * @throws an `Error` when no url rule matches `path` and the router declares no `otherwise`
- * @throws an `Error` whose `cause` is the transition's `Rejection` when it fails, a failed resolve's error in that rejection's `detail`
- * @throws an `Error` when nothing lands within {@link SettleOptions.timeout | `timeout`}
- *
- * @example
- * ```ts
- * import { prerender, settle } from 'lit-ui-router-ssr';
- *
- * await prerender({
- *   mounts,
- *   router,
- *   outDir: 'dist',
- *   paths: ['/', '/sheet/7B'],
- *   renderShell: async (verdict, { path }) => {
- *     await settle(router, path);
- *     return page();
- *   },
- * });
- * ```
- */
-export const settle = (
-  router: UIRouter,
-  path: string,
-  options: SettleOptions = {},
-): Promise<Transition> => {
-  const { timeout = 10_000 } = options;
-  const { globals, stateService, transitionService, urlService } = router;
-
-  return new Promise<Transition>((resolve, reject) => {
-    let timer: ReturnType<typeof setTimeout> | undefined;
-
-    const done = (): void => {
-      offSuccess();
-      offError();
-      clearTimeout(timer);
-    };
-
-    const land = (transition: Transition): void => {
-      done();
-      resolve(transition);
-    };
-
-    const fail = (reason: Error): void => {
-      done();
-      reject(reason);
-    };
-
-    // SAFETY: hook registration returns its deregistration function, typed only as `Function`.
-    const offSuccess = transitionService.onSuccess({}, land) as () => void;
-
-    // SAFETY: hook registration returns its deregistration function, typed only as `Function`.
-    const offError = transitionService.onError({}, (transition) => {
-      const rejection = transition.error();
-
-      if (rejection.type === RejectType.SUPERSEDED) return;
-
-      if (rejection.type === RejectType.IGNORED) {
-        // Ignored with nothing in flight: the router already stands where the url points.
-        if (!globals.transition && globals.successfulTransitions.size() > 0)
-          land(globals.successfulTransitions.peekTail());
-
-        return;
-      }
-
-      fail(new Error(rejection.message, { cause: rejection }));
-    }) as () => void;
-
-    if (timeout > 0 && timeout !== Infinity)
-      timer = setTimeout(
-        () =>
-          fail(new Error(`settle: ${path} did not land within ${timeout}ms`)),
-        timeout,
-      );
-
-    urlService.url(path);
-
-    for (let rewrites = 0; rewrites <= maxRewrites; rewrites++) {
-      const best = urlService.match({
-        path: urlService.path(),
-        search: urlService.search(),
-        hash: urlService.hash(),
-      });
-
-      if (!best)
-        return fail(
-          new Error(
-            `settle: no url rule matches ${urlService.url()} and the router declares no otherwise`,
-          ),
-        );
-
-      // Core's state rule starts nothing when the url's href is the current one.
-      // SAFETY: a `STATE` rule is core's `StateRule`, and its match is the url's param values.
-      if (
-        best.rule.type === 'STATE' &&
-        globals.successfulTransitions.size() > 0 &&
-        stateService.href(
-          (best.rule as StateRule).state,
-          best.match as RawParams,
-        ) === stateService.href(globals.current, globals.params)
-      )
-        return land(globals.successfulTransitions.peekTail());
-      const before = urlService.url();
-      urlService.sync();
-
-      // A rule that rewrote the url to another url needs its own sync when the router is not listening.
-      if (urlService.url() === before) return;
-    }
-
-    fail(
-      new Error(
-        `settle: ${path} rewrote its url more than ${maxRewrites} times`,
-      ),
-    );
-  });
-};