@matthesketh/utopia-router 0.3.1 → 0.4.0

package/dist/index.cjs

@@ -31,9 +31,14 @@ __export(index_exports, {
   destroy: () => destroy,
   filePathToRoute: () => filePathToRoute,
   forward: () => forward,
+  getQueryParam: () => getQueryParam,
+  getRouteParam: () => getRouteParam,
   isNavigating: () => isNavigating,
   matchRoute: () => matchRoute,
-  navigate: () => navigate
+  navigate: () => navigate,
+  queryParams: () => queryParams,
+  setQueryParam: () => setQueryParam,
+  setQueryParams: () => setQueryParams
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -570,6 +575,54 @@ function clearContainer(container) {
 function escapeHtml(str) {
   return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#x27;");
 }
+
+// src/query.ts
+var import_utopia_core3 = require("@matthesketh/utopia-core");
+var queryParams = (0, import_utopia_core3.computed)(() => {
+  const match = currentRoute();
+  if (!match) return {};
+  const result = {};
+  match.url.searchParams.forEach((value, key) => {
+    result[key] = value;
+  });
+  return result;
+});
+function getQueryParam(name) {
+  return (0, import_utopia_core3.computed)(() => {
+    const match = currentRoute();
+    if (!match) return null;
+    return match.url.searchParams.get(name);
+  });
+}
+function setQueryParam(name, value) {
+  if (typeof window === "undefined") return;
+  const url = new URL(window.location.href);
+  if (value === null) {
+    url.searchParams.delete(name);
+  } else {
+    url.searchParams.set(name, value);
+  }
+  navigate(url.pathname + url.search + url.hash, { replace: true });
+}
+function setQueryParams(params) {
+  if (typeof window === "undefined") return;
+  const url = new URL(window.location.href);
+  for (const [key, value] of Object.entries(params)) {
+    if (value === null) {
+      url.searchParams.delete(key);
+    } else {
+      url.searchParams.set(key, value);
+    }
+  }
+  navigate(url.pathname + url.search + url.hash, { replace: true });
+}
+function getRouteParam(name) {
+  return (0, import_utopia_core3.computed)(() => {
+    const match = currentRoute();
+    if (!match) return null;
+    return match.params[name] ?? null;
+  });
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   back,
@@ -583,7 +636,12 @@ function escapeHtml(str) {
   destroy,
   filePathToRoute,
   forward,
+  getQueryParam,
+  getRouteParam,
   isNavigating,
   matchRoute,
-  navigate
+  navigate,
+  queryParams,
+  setQueryParam,
+  setQueryParams
 });

package/dist/index.d.cts

@@ -214,4 +214,29 @@ declare function createLink(props: {
     activeClass?: string;
 }): HTMLAnchorElement;
 
-export { type BeforeNavigateHook, type Route, type RouteMatch, type RouterState, back, beforeNavigate, buildRouteTable, compilePattern, createLink, createRouter, createRouterView, currentRoute, destroy, filePathToRoute, forward, isNavigating, matchRoute, navigate };
+/**
+ * Reactive computed signal returning all current query parameters as a plain object.
+ */
+declare const queryParams: _matthesketh_utopia_core.ReadonlySignal<Record<string, string>>;
+/**
+ * Returns a computed signal for a specific query parameter.
+ * Returns null if the parameter is not present.
+ */
+declare function getQueryParam(name: string): _matthesketh_utopia_core.ReadonlySignal<string | null>;
+/**
+ * Update a single query parameter and navigate (replace mode).
+ * Pass null to remove the parameter.
+ */
+declare function setQueryParam(name: string, value: string | null): void;
+/**
+ * Update multiple query parameters in a single navigation.
+ * Pass null for a value to remove that parameter.
+ */
+declare function setQueryParams(params: Record<string, string | null>): void;
+/**
+ * Returns a computed signal for a specific route path parameter.
+ * Returns null if the parameter is not present.
+ */
+declare function getRouteParam(name: string): _matthesketh_utopia_core.ReadonlySignal<string | null>;
+
+export { type BeforeNavigateHook, type Route, type RouteMatch, type RouterState, back, beforeNavigate, buildRouteTable, compilePattern, createLink, createRouter, createRouterView, currentRoute, destroy, filePathToRoute, forward, getQueryParam, getRouteParam, isNavigating, matchRoute, navigate, queryParams, setQueryParam, setQueryParams };

package/dist/index.d.ts

@@ -214,4 +214,29 @@ declare function createLink(props: {
     activeClass?: string;
 }): HTMLAnchorElement;
 
-export { type BeforeNavigateHook, type Route, type RouteMatch, type RouterState, back, beforeNavigate, buildRouteTable, compilePattern, createLink, createRouter, createRouterView, currentRoute, destroy, filePathToRoute, forward, isNavigating, matchRoute, navigate };
+/**
+ * Reactive computed signal returning all current query parameters as a plain object.
+ */
+declare const queryParams: _matthesketh_utopia_core.ReadonlySignal<Record<string, string>>;
+/**
+ * Returns a computed signal for a specific query parameter.
+ * Returns null if the parameter is not present.
+ */
+declare function getQueryParam(name: string): _matthesketh_utopia_core.ReadonlySignal<string | null>;
+/**
+ * Update a single query parameter and navigate (replace mode).
+ * Pass null to remove the parameter.
+ */
+declare function setQueryParam(name: string, value: string | null): void;
+/**
+ * Update multiple query parameters in a single navigation.
+ * Pass null for a value to remove that parameter.
+ */
+declare function setQueryParams(params: Record<string, string | null>): void;
+/**
+ * Returns a computed signal for a specific route path parameter.
+ * Returns null if the parameter is not present.
+ */
+declare function getRouteParam(name: string): _matthesketh_utopia_core.ReadonlySignal<string | null>;
+
+export { type BeforeNavigateHook, type Route, type RouteMatch, type RouterState, back, beforeNavigate, buildRouteTable, compilePattern, createLink, createRouter, createRouterView, currentRoute, destroy, filePathToRoute, forward, getQueryParam, getRouteParam, isNavigating, matchRoute, navigate, queryParams, setQueryParam, setQueryParams };

package/dist/index.js

@@ -531,6 +531,54 @@ function clearContainer(container) {
 function escapeHtml(str) {
   return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#x27;");
 }
+
+// src/query.ts
+import { computed } from "@matthesketh/utopia-core";
+var queryParams = computed(() => {
+  const match = currentRoute();
+  if (!match) return {};
+  const result = {};
+  match.url.searchParams.forEach((value, key) => {
+    result[key] = value;
+  });
+  return result;
+});
+function getQueryParam(name) {
+  return computed(() => {
+    const match = currentRoute();
+    if (!match) return null;
+    return match.url.searchParams.get(name);
+  });
+}
+function setQueryParam(name, value) {
+  if (typeof window === "undefined") return;
+  const url = new URL(window.location.href);
+  if (value === null) {
+    url.searchParams.delete(name);
+  } else {
+    url.searchParams.set(name, value);
+  }
+  navigate(url.pathname + url.search + url.hash, { replace: true });
+}
+function setQueryParams(params) {
+  if (typeof window === "undefined") return;
+  const url = new URL(window.location.href);
+  for (const [key, value] of Object.entries(params)) {
+    if (value === null) {
+      url.searchParams.delete(key);
+    } else {
+      url.searchParams.set(key, value);
+    }
+  }
+  navigate(url.pathname + url.search + url.hash, { replace: true });
+}
+function getRouteParam(name) {
+  return computed(() => {
+    const match = currentRoute();
+    if (!match) return null;
+    return match.params[name] ?? null;
+  });
+}
 export {
   back,
   beforeNavigate,
@@ -543,7 +591,12 @@ export {
   destroy,
   filePathToRoute,
   forward,
+  getQueryParam,
+  getRouteParam,
   isNavigating,
   matchRoute,
-  navigate
+  navigate,
+  queryParams,
+  setQueryParam,
+  setQueryParams
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matthesketh/utopia-router",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "File-based routing for UtopiaJS",
   "type": "module",
   "license": "MIT",
@@ -40,8 +40,8 @@
     "dist"
   ],
   "dependencies": {
-    "@matthesketh/utopia-core": "0.3.1",
-    "@matthesketh/utopia-runtime": "0.3.1"
+    "@matthesketh/utopia-core": "0.4.0",
+    "@matthesketh/utopia-runtime": "0.4.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",