vorma 0.0.0-pre.0 → 0.82.0

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright 2023 Samuel J. Cook
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,48 @@
+# Vorma Framework
+
+<img src="internal/site/frontend/assets/vorma-banner.webp" alt="Vorma banner">
+
+---
+
+The Next.js of Golang, powered by Vite.
+
+## Links
+
+[vorma.dev](https://vorma.dev) | [github.com](https://github.com/vormadev/vorma)
+| [pkg.go.dev](https://pkg.go.dev/github.com/vormadev/vorma) |
+[npmjs.com](https://www.npmjs.com/package/vorma) |
+[x.com](https://x.com/vormadev)
+
+## Quick Start
+
+```sh
+npm create vorma@latest
+```
+
+## What is Vorma?
+
+Vorma is a lot like Next.js, Remix, or TanStack Start, but it uses Go on the
+backend, with your choice of **_React_**, **_Solid_**, or **_Preact_** on the
+frontend.
+
+It has **_nested routing_**, effortless **_end-to-end type safety_** (including
+Link components!), **_parallel-executed route loaders_**, and much, much more.
+
+It's deeply integrated with **_Vite_** to give you full **_hot module
+reloading_** at dev-time.
+
+## Get Started
+
+If you want to dive right in, just open a terminal and run
+`npm create vorma@latest` and follow the prompts.
+
+If you'd prefer to read more first, take a peek at
+[our docs](https://vorma.dev/docs).
+
+## Status
+
+Vorma's underlying tech has reached a good degree of stability, but its APIs are
+still evolving. Sub-1.0 releases may contain breaking changes. If you ever need
+help upgrading to the latest version, feel free to
+[file an issue on GitHub](https://github.com/vormadev/vorma) or
+[reach out on X](https://x.com/vormadev).

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

@@ -0,0 +1,64 @@
+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";

package/internal/framework/_typescript/client/src/asset_manager.ts

@@ -0,0 +1,67 @@
+import { resolvePublicHref } from "./resolve_public_href.ts";
+import { __vormaClientGlobal } from "./vorma_ctx/vorma_ctx.ts";
+
+export class AssetManager {
+	static preloadModule(url: string): void {
+		const href = resolvePublicHref(url);
+		if (
+			document.querySelector(
+				`link[rel="modulepreload"][href="${CSS.escape(href)}"]`,
+			)
+		) {
+			return;
+		}
+
+		const link = document.createElement("link");
+		link.rel = "modulepreload";
+		link.href = href;
+		document.head.appendChild(link);
+	}
+
+	static preloadCSS(url: string): Promise<void> {
+		const href = resolvePublicHref(url);
+
+		if (
+			document.querySelector(
+				`link[rel="preload"][href="${CSS.escape(href)}"]`,
+			)
+		) {
+			return Promise.resolve();
+		}
+
+		const link = document.createElement("link");
+		link.rel = "preload";
+		link.setAttribute("as", "style");
+		link.href = href;
+
+		document.head.appendChild(link);
+
+		return new Promise((resolve, reject) => {
+			link.onload = () => resolve();
+			link.onerror = reject;
+		});
+	}
+
+	static applyCSS(bundles: string[]): void {
+		window.requestAnimationFrame(() => {
+			const prefix = __vormaClientGlobal.get("publicPathPrefix");
+
+			for (const bundle of bundles) {
+				// Check using the data attribute without escaping
+				if (
+					document.querySelector(
+						`link[data-vorma-css-bundle="${bundle}"]`,
+					)
+				) {
+					continue;
+				}
+
+				const link = document.createElement("link");
+				link.rel = "stylesheet";
+				link.href = prefix + bundle;
+				link.setAttribute("data-vorma-css-bundle", bundle);
+				document.head.appendChild(link);
+			}
+		});
+	}
+}