vorma 0.0.0-pre.0 → 0.82.0

package/kit/_typescript/matcher/register.ts

@@ -0,0 +1,271 @@
+import { parseSegments } from "./parse_segments.ts";
+
+export type Params = Record<string, string>;
+export type SegType = "splat" | "static" | "dynamic" | "index";
+
+export type Segment = {
+	normalizedVal: string;
+	segType: SegType;
+};
+
+export type RegisteredPattern = {
+	originalPattern: string;
+	normalizedPattern: string;
+	normalizedSegments: Segment[];
+	lastSegType: SegType;
+	lastSegIsNonRootSplat: boolean;
+	lastSegIsIndex: boolean;
+	numberOfDynamicParamSegs: number;
+};
+
+export type SegmentNode = {
+	pattern: string;
+	nodeType: number;
+	children: Map<string, SegmentNode> | null;
+	dynChildren: SegmentNode[];
+	paramName: string;
+	finalScore: number;
+};
+
+export type RegistrationOptions = {
+	dynamicParamPrefixRune?: string;
+	splatSegmentRune?: string;
+	explicitIndexSegment?: string;
+};
+
+export type PatternRegistry = {
+	staticPatterns: Map<string, RegisteredPattern>;
+	dynamicPatterns: Map<string, RegisteredPattern>;
+	rootNode: SegmentNode;
+	config: {
+		dynamicParamPrefixRune: string;
+		splatSegmentRune: string;
+		explicitIndexSegment: string;
+		slashIndexSegment: string;
+		usingExplicitIndexSegment: boolean;
+	};
+};
+
+/////////////////////////////////////////////////////////////////////
+/////// CONSTANTS
+/////////////////////////////////////////////////////////////////////
+
+export const NODE_STATIC = 0;
+export const NODE_DYNAMIC = 1;
+export const NODE_SPLAT = 2;
+export const SCORE_STATIC_MATCH = 2;
+export const SCORE_DYNAMIC = 1;
+
+export const SEG_TYPES = {
+	splat: "splat" as SegType,
+	static: "static" as SegType,
+	dynamic: "dynamic" as SegType,
+	index: "index" as SegType,
+};
+
+/////////////////////////////////////////////////////////////////////
+/////// REGISTRATION
+/////////////////////////////////////////////////////////////////////
+
+function createSegmentNode(): SegmentNode {
+	return {
+		pattern: "",
+		nodeType: NODE_STATIC,
+		children: null,
+		dynChildren: [],
+		paramName: "",
+		finalScore: 0,
+	};
+}
+
+function findOrCreateChild(node: SegmentNode, segment: string): SegmentNode {
+	if (segment === "*" || (segment.length > 0 && segment[0] === ":")) {
+		for (const child of node.dynChildren) {
+			if (child.paramName === segment.substring(1)) return child;
+		}
+		return addDynamicChild(node, segment);
+	}
+
+	if (node.children === null) node.children = new Map<string, SegmentNode>();
+
+	let child = node.children.get(segment);
+	if (child) return child;
+
+	child = createSegmentNode();
+	child.nodeType = NODE_STATIC;
+	node.children.set(segment, child);
+	return child;
+}
+
+function addDynamicChild(node: SegmentNode, segment: string): SegmentNode {
+	const child = createSegmentNode();
+	if (segment === "*") {
+		child.nodeType = NODE_SPLAT;
+	} else {
+		child.nodeType = NODE_DYNAMIC;
+		child.paramName = segment.substring(1);
+	}
+	node.dynChildren.push(child);
+	return child;
+}
+
+function getSegmentType(
+	segment: string,
+	dynamicPrefix: string,
+	splatRune: string,
+): SegType {
+	if (segment === "") return SEG_TYPES.index;
+	if (segment.length === 1 && segment === splatRune) return SEG_TYPES.splat;
+	if (segment.length > 0 && segment[0] === dynamicPrefix)
+		return SEG_TYPES.dynamic;
+	return SEG_TYPES.static;
+}
+
+function isStatic(segments: Segment[]): boolean {
+	for (const segment of segments) {
+		if (
+			segment.segType === SEG_TYPES.splat ||
+			segment.segType === SEG_TYPES.dynamic
+		) {
+			return false;
+		}
+	}
+	return true;
+}
+
+function normalizePattern(
+	originalPattern: string,
+	config: PatternRegistry["config"],
+): RegisteredPattern {
+	let normalizedPattern = originalPattern;
+
+	if (config.usingExplicitIndexSegment) {
+		if (normalizedPattern.endsWith("/")) {
+			if (normalizedPattern !== "/") {
+				throw new Error(`bad trailing slash: ${originalPattern}`);
+			}
+			normalizedPattern = normalizedPattern.replace(/\/+$/, "");
+		}
+		if (normalizedPattern.endsWith(config.slashIndexSegment)) {
+			normalizedPattern = normalizedPattern.slice(
+				0,
+				-config.explicitIndexSegment.length,
+			);
+		}
+	}
+
+	const rawSegments = parseSegments(normalizedPattern);
+	const segments: Segment[] = [];
+	let numberOfDynamicParamSegs = 0;
+
+	for (const seg of rawSegments) {
+		let normalizedVal = seg;
+		const segType = getSegmentType(
+			seg,
+			config.dynamicParamPrefixRune,
+			config.splatSegmentRune,
+		);
+
+		if (segType === SEG_TYPES.dynamic) {
+			numberOfDynamicParamSegs++;
+			normalizedVal = ":" + seg.substring(1);
+		}
+		if (segType === SEG_TYPES.splat) {
+			normalizedVal = "*";
+		}
+
+		segments.push({ normalizedVal, segType });
+	}
+
+	const segLen = segments.length;
+	let lastType: SegType =
+		segLen > 0 ? segments[segLen - 1]!.segType : SEG_TYPES.static;
+
+	let finalNormalizedPattern = "/";
+	for (let i = 0; i < segments.length; i++) {
+		finalNormalizedPattern += segments[i]!.normalizedVal;
+		if (i < segLen - 1) finalNormalizedPattern += "/";
+	}
+
+	if (finalNormalizedPattern.endsWith("/") && lastType !== SEG_TYPES.index) {
+		finalNormalizedPattern = finalNormalizedPattern.replace(/\/+$/, "");
+	}
+
+	return {
+		originalPattern,
+		normalizedPattern: finalNormalizedPattern,
+		normalizedSegments: segments,
+		lastSegType: lastType,
+		lastSegIsNonRootSplat: lastType === SEG_TYPES.splat && segLen > 1,
+		lastSegIsIndex: lastType === SEG_TYPES.index,
+		numberOfDynamicParamSegs,
+	};
+}
+
+export function createPatternRegistry(
+	opts?: RegistrationOptions,
+): PatternRegistry {
+	const config = {
+		dynamicParamPrefixRune: opts?.dynamicParamPrefixRune ?? ":",
+		splatSegmentRune: opts?.splatSegmentRune ?? "*",
+		explicitIndexSegment: opts?.explicitIndexSegment ?? "",
+		slashIndexSegment: "/" + (opts?.explicitIndexSegment ?? ""),
+		usingExplicitIndexSegment: (opts?.explicitIndexSegment ?? "") !== "",
+	};
+
+	if (config.explicitIndexSegment.includes("/")) {
+		throw new Error("explicit index segment cannot contain /");
+	}
+
+	return {
+		staticPatterns: new Map(),
+		dynamicPatterns: new Map(),
+		rootNode: createSegmentNode(),
+		config,
+	};
+}
+
+export function registerPattern(
+	registry: PatternRegistry,
+	originalPattern: string,
+): RegisteredPattern {
+	const normalized = normalizePattern(originalPattern, registry.config);
+
+	if (
+		!(globalThis.window && globalThis.document) &&
+		(registry.staticPatterns.has(normalized.normalizedPattern) ||
+			registry.dynamicPatterns.has(normalized.normalizedPattern))
+	) {
+		console.warn(`already registered: ${originalPattern}`);
+	}
+
+	if (isStatic(normalized.normalizedSegments)) {
+		registry.staticPatterns.set(normalized.normalizedPattern, normalized);
+		return normalized;
+	}
+
+	registry.dynamicPatterns.set(normalized.normalizedPattern, normalized);
+
+	let current = registry.rootNode;
+	let nodeScore = 0;
+
+	for (let i = 0; i < normalized.normalizedSegments.length; i++) {
+		const segment = normalized.normalizedSegments[i]!;
+		const child = findOrCreateChild(current, segment.normalizedVal);
+
+		if (segment.segType === SEG_TYPES.dynamic) {
+			nodeScore += SCORE_DYNAMIC;
+		} else if (segment.segType !== SEG_TYPES.splat) {
+			nodeScore += SCORE_STATIC_MATCH;
+		}
+
+		if (i === normalized.normalizedSegments.length - 1) {
+			child.finalScore = nodeScore;
+			child.pattern = normalized.normalizedPattern;
+		}
+
+		current = child;
+	}
+
+	return normalized;
+}

package/kit/_typescript/theme/theme.ts

@@ -0,0 +1,166 @@
+import { getClientCookie, setClientCookie } from "vorma/kit/cookies";
+
+/////////////////////////////////////////////////////////////////////
+/////// SETUP
+/////////////////////////////////////////////////////////////////////
+
+export const THEMES = {
+	Dark: "dark",
+	Light: "light",
+	System: "system",
+} as const;
+
+const THEME_VALUES = Object.values(THEMES);
+const THEME_KEY = "kit_theme";
+const RESOLVED_THEME_KEY = "kit_resolved_theme";
+const PREFERS_DARK_QUERY = window.matchMedia("(prefers-color-scheme: dark)");
+const CLASSLIST = window.document.documentElement.classList;
+const THEME_CHANGE_EVENT_KEY = "theme_change";
+
+export type Theme = (typeof THEME_VALUES)[number];
+export type ResolvedTheme = Exclude<Theme, typeof THEMES.System>;
+type ThemeChangeEventDetail = {
+	theme: Theme;
+	resolvedTheme: ResolvedTheme;
+};
+
+/////////////////////////////////////////////////////////////////////
+///////// BROADCAST CHANNEL
+/////////////////////////////////////////////////////////////////////
+
+let bc = __newBC();
+__setBCOnMessage(bc);
+
+// bfcache stuff
+window.addEventListener("pagehide", () => bc.close());
+window.addEventListener("pageshow", () => {
+	bc = __newBC();
+	__setBCOnMessage(bc);
+});
+
+function __newBC(): BroadcastChannel {
+	return new BroadcastChannel("kit_theme_channel");
+}
+
+function __setBCOnMessage(bc: BroadcastChannel) {
+	bc.onmessage = (e) => {
+		const detail = e.data as ThemeChangeEventDetail;
+		const theme = detail.theme;
+		const resolvedTheme = __getResolvedThemeFromTheme(theme);
+		__setClassesAndDispatchEvent({ theme, resolvedTheme });
+	};
+}
+
+/////////////////////////////////////////////////////////////////////
+/////// PREFERS COLOR SCHEME EVENT LISTENER
+/////////////////////////////////////////////////////////////////////
+
+PREFERS_DARK_QUERY.addEventListener("change", () => {
+	if (CLASSLIST.contains(THEMES.System)) {
+		setTheme(THEMES.System);
+	}
+});
+
+/////////////////////////////////////////////////////////////////////
+/////// PUBLIC HELPER FUNCTIONS
+/////////////////////////////////////////////////////////////////////
+
+export function getTheme(): Theme {
+	const theme = getClientCookie(THEME_KEY);
+	return __isTheme(theme) ? theme : THEMES.System;
+}
+
+export function getThemeLocal(): Theme {
+	const theme = localStorage.getItem(THEME_KEY);
+	return __isTheme(theme) ? theme : THEMES.System;
+}
+
+export function getResolvedTheme(): ResolvedTheme {
+	const resolvedTheme = getClientCookie(RESOLVED_THEME_KEY);
+	return __isResolvedTheme(resolvedTheme) ? resolvedTheme : THEMES.Light;
+}
+
+export function getResolvedThemeLocal(): ResolvedTheme {
+	const resolvedTheme = localStorage.getItem(RESOLVED_THEME_KEY);
+	return __isResolvedTheme(resolvedTheme) ? resolvedTheme : THEMES.Light;
+}
+
+export function setTheme(theme: Theme) {
+	const resolvedTheme = __getResolvedThemeFromTheme(theme);
+	setClientCookie(THEME_KEY, theme);
+	setClientCookie(RESOLVED_THEME_KEY, resolvedTheme);
+	const detail: ThemeChangeEventDetail = { theme, resolvedTheme };
+	__setClassesAndDispatchEvent(detail);
+	bc.postMessage(detail);
+}
+
+export function setThemeLocal(theme: Theme) {
+	const resolvedTheme = __getResolvedThemeFromTheme(theme);
+	localStorage.setItem(THEME_KEY, theme);
+	localStorage.setItem(RESOLVED_THEME_KEY, resolvedTheme);
+	const detail: ThemeChangeEventDetail = { theme, resolvedTheme };
+	__setClassesAndDispatchEvent(detail);
+	bc.postMessage(detail);
+}
+
+export function addThemeChangeListener(
+	listener: (e: CustomEvent<ThemeChangeEventDetail>) => void,
+): CleanupFunction {
+	window.addEventListener(THEME_CHANGE_EVENT_KEY, listener as EventListener);
+	return () => {
+		window.removeEventListener(
+			THEME_CHANGE_EVENT_KEY,
+			listener as EventListener,
+		);
+	};
+}
+
+type CleanupFunction = () => void;
+
+export function initLocal() {
+	const theme = localStorage.getItem(THEME_KEY) || THEMES.System;
+	const resolvedTheme = __getResolvedThemeFromTheme(
+		__isTheme(theme) ? theme : THEMES.System,
+	);
+	CLASSLIST.add(theme);
+	if (theme === THEMES.System) {
+		CLASSLIST.add(resolvedTheme);
+	}
+	localStorage.setItem(THEME_KEY, theme);
+	localStorage.setItem(RESOLVED_THEME_KEY, resolvedTheme);
+}
+
+/////////////////////////////////////////////////////////////////////
+/////// INTERNAL UTILS
+/////////////////////////////////////////////////////////////////////
+
+function __getResolvedThemeFromTheme(theme: Theme): ResolvedTheme {
+	let resolvedTheme = theme;
+	if (resolvedTheme === THEMES.System) {
+		resolvedTheme = PREFERS_DARK_QUERY.matches ? THEMES.Dark : THEMES.Light;
+	}
+	return resolvedTheme;
+}
+
+function __setClassesAndDispatchEvent(detail: ThemeChangeEventDetail) {
+	CLASSLIST.remove(...THEME_VALUES);
+	CLASSLIST.add(detail.theme);
+	if (detail.theme === THEMES.System) {
+		CLASSLIST.add(detail.resolvedTheme);
+	}
+	window.dispatchEvent(new CustomEvent(THEME_CHANGE_EVENT_KEY, { detail }));
+}
+
+/////////////////////////////////////////////////////////////////////
+/////// TYPE GUARDS
+/////////////////////////////////////////////////////////////////////
+
+function __isTheme(theme: string | undefined | null): theme is Theme {
+	return THEME_VALUES.includes(theme as Theme);
+}
+
+function __isResolvedTheme(
+	theme: string | undefined | null,
+): theme is ResolvedTheme {
+	return theme === THEMES.Dark || theme === THEMES.Light;
+}

package/kit/_typescript/tsconfig.json

@@ -0,0 +1,3 @@
+{
+	"extends": "../../tsconfig.base.json"
+}

package/kit/_typescript/url/url.ts

@@ -0,0 +1,132 @@
+export function getIsErrorRes(response: Response) {
+	return (
+		String(response.status).startsWith("4") || String(response.status).startsWith("5")
+	);
+}
+
+export function getIsGETRequest(requestInit?: RequestInit) {
+	return (
+		!requestInit?.method ||
+		requestInit.method.toLowerCase() === "get" ||
+		requestInit.method.toLowerCase() === "head"
+	);
+}
+
+export function getAnchorDetailsFromEvent(event: MouseEvent) {
+	if (!event || !event.target || !(event.target as HTMLElement).closest) {
+		return null;
+	}
+
+	const anchor = (event.target as HTMLElement).closest("a");
+
+	if (!anchor) {
+		return null;
+	}
+
+	const isEligibleForDefaultPrevention =
+		anchor.target !== "_blank" && // ignore new tabs
+		event.button !== 1 && // middle mouse button click
+		!anchor.href.startsWith("#") && // ignore hash links
+		!anchor.hasAttribute("download") && // ignore downloads
+		!event.ctrlKey && // ignore ctrl+click
+		!event.shiftKey && // ignore shift+click
+		!event.metaKey && // ignore cmd+click
+		!event.altKey; // ignore alt+click
+
+	const hrefDetails = getHrefDetails(anchor.href);
+	const isInternal = hrefDetails.isHTTP && hrefDetails.isInternal;
+
+	return { anchor, isEligibleForDefaultPrevention, isInternal };
+}
+
+export type HrefDetails =
+	| {
+			url: URL;
+			isHTTP: true;
+			absoluteURL: string;
+			relativeURL: string;
+			isExternal: boolean;
+			isInternal: boolean;
+	  }
+	| {
+			isHTTP: false;
+	  };
+
+export function getHrefDetails(href: string): HrefDetails {
+	if (!href) {
+		return { isHTTP: false };
+	}
+
+	let url: URL;
+
+	try {
+		url = new URL(href, window.location.href);
+	} catch {
+		return { isHTTP: false };
+	}
+
+	const isExternal = url.origin !== window.location.origin;
+	const isInternal = !isExternal;
+
+	// Filter out things like "#", "tel:", "mailto:", etc.
+	const isHTTP = url.protocol.startsWith("http");
+	if (!isHTTP) {
+		return { isHTTP: false };
+	}
+
+	if (isExternal) {
+		return {
+			url,
+			isHTTP: true,
+			absoluteURL: url.href,
+			relativeURL: "",
+			isExternal,
+			isInternal,
+		};
+	}
+
+	return {
+		url,
+		isHTTP: true,
+		absoluteURL: url.href,
+		relativeURL: url.href.replace(url.origin, ""),
+		isExternal,
+		isInternal,
+	};
+}
+
+export function getPrefetchHandlers(href: string, timeout = 50) {
+	const hrefDetails = getHrefDetails(href);
+	if (!hrefDetails.isHTTP) {
+		return;
+	}
+
+	const { relativeURL, isExternal } = hrefDetails;
+	if (!relativeURL || isExternal) {
+		return;
+	}
+
+	let timer: number | undefined;
+
+	return {
+		...hrefDetails,
+		start() {
+			timer = window.setTimeout(() => prefetch(relativeURL), timeout);
+		},
+		stop() {
+			document.querySelector(`link[href="${relativeURL}"]`)?.remove();
+			clearTimeout(timer);
+		},
+	};
+}
+
+export function prefetch(relativeURL: string) {
+	document.querySelector(`link[href="${relativeURL}"]`)?.remove();
+
+	const link = document.createElement("link");
+	link.rel = "prefetch";
+	link.href = relativeURL;
+	link.id = relativeURL;
+
+	document.head.appendChild(link);
+}

package/npm_dist/internal/framework/_typescript/client/index.d.ts

@@ -0,0 +1,17 @@
+export { getBuildID, getHistoryInstance, getLocation, getRootEl, getStatus, revalidate, submit, vormaNavigate, type SubmitOptions, } from "./src/client.ts";
+export { __registerClientLoaderPattern } from "./src/client_loaders.ts";
+export { defaultErrorBoundary } from "./src/error_boundary.ts";
+export { addBuildIDListener, addLocationListener, addRouteChangeListener, addStatusListener, type RouteChangeEvent, type StatusEvent, } from "./src/events.ts";
+export { setupGlobalLoadingIndicator } from "./src/global_loading_indicator/global_loading_indicator.ts";
+export { __runClientLoadersAfterHMRUpdate } from "./src/hmr/hmr.ts";
+export { initClient } from "./src/init_client.ts";
+export { __getPrefetchHandlers, __makeLinkOnClickFn } from "./src/links.ts";
+export { __applyScrollState } from "./src/scroll_state_manager.ts";
+export { route } from "./src/static_route_defs/route_def_helpers.ts";
+export { __makeFinalLinkProps, type VormaLinkPropsBase, } from "./src/ui_lib_impl_helpers/link_components.ts";
+export { type ParamsForPattern, type UseRouterDataFunction, type VormaRouteGeneric, } from "./src/ui_lib_impl_helpers/route_components.ts";
+export { makeTypedNavigate } from "./src/ui_lib_impl_helpers/typed_navigate.ts";
+export { __resolvePath, buildMutationURL, buildQueryURL, resolveBody, type ExtractApp, type PermissivePatternBasedProps, type VormaAppBase, type VormaAppConfig, type VormaLoaderOutput, type VormaLoaderPattern, type VormaMutationInput, type VormaMutationOutput, type VormaMutationPattern, type VormaMutationProps, type VormaQueryInput, type VormaQueryOutput, type VormaQueryPattern, type VormaQueryProps, type VormaRoutePropsGeneric, } from "./src/vorma_app_helpers/vorma_app_helpers.ts";
+export { __vormaClientGlobal, getRouterData, type ClientLoaderAwaitedServerData, } from "./src/vorma_ctx/vorma_ctx.ts";
+export { revalidateOnWindowFocus } from "./src/window_focus_revalidation/window_focus_revalidation.ts";
+//# sourceMappingURL=index.d.ts.map

package/npm_dist/internal/framework/_typescript/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../internal/framework/_typescript/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,UAAU,EACV,kBAAkB,EAClB,WAAW,EACX,SAAS,EACT,SAAS,EACT,UAAU,EACV,MAAM,EACN,aAAa,EACb,KAAK,aAAa,GAClB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EACN,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,KAAK,gBAAgB,EACrB,KAAK,WAAW,GAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,2BAA2B,EAAE,MAAM,4DAA4D,CAAC;AACzG,OAAO,EAAE,gCAAgC,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,KAAK,EAAE,MAAM,8CAA8C,CAAC;AACrE,OAAO,EACN,oBAAoB,EACpB,KAAK,kBAAkB,GACvB,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACN,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,GACtB,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EACN,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,KAAK,UAAU,EACf,KAAK,2BAA2B,EAChC,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,sBAAsB,GAC3B,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,KAAK,6BAA6B,GAClC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8DAA8D,CAAC"}