@hybridly/core 0.4.1 → 0.4.2

package/dist/index.cjs

@@ -360,10 +360,59 @@ function createSerializer(options) {
   };
 }
 
+function getUrlRegexForRoute(name) {
+  const routing = getRouting();
+  const definition = getRouteDefinition(name);
+  const path = definition.uri.replaceAll("/", "\\/");
+  const domain = definition.domain;
+  const protocolPrefix = routing.url.match(/^\w+:\/\//)?.[0];
+  const origin = domain ? `${protocolPrefix}${domain}${routing.port ? `:${routing.port}` : ""}`.replaceAll("/", "\\/") : routing.url.replaceAll("/", "\\/");
+  const urlPathRegexPattern = path.length > 0 ? `\\/${path.replace(/\/$/g, "")}` : "";
+  let urlRegexPattern = `^${origin.replaceAll(".", "\\.")}${urlPathRegexPattern}\\/?(\\?.*)?$`;
+  urlRegexPattern = urlRegexPattern.replace(/(\\\/?){([^}?]+)(\??)}/g, (_, slash, parameterName, optional) => {
+    const where = definition.wheres?.[parameterName];
+    let regexTemplate = where?.replace(/(^\^)|(\$$)/g, "") || "[^/?]+";
+    regexTemplate = `(?<${parameterName}>${regexTemplate})`;
+    if (optional) {
+      return `(${slash ? "\\/?" : ""}${regexTemplate})?`;
+    }
+    return (slash ? "\\/" : "") + regexTemplate;
+  });
+  return RegExp(urlRegexPattern);
+}
+function urlMatchesRoute(url, name, routeParameters) {
+  const parameters = routeParameters || {};
+  const definition = getRouting().routes[name];
+  if (!definition) {
+    return false;
+  }
+  const matches = getUrlRegexForRoute(name).exec(url);
+  if (!matches) {
+    return false;
+  }
+  for (const k in matches.groups) {
+    matches.groups[k] = typeof matches.groups[k] === "string" ? decodeURIComponent(matches.groups[k]) : matches.groups[k];
+  }
+  return Object.keys(parameters).every((parameterName) => {
+    let value = parameters[parameterName];
+    const bindingProperty = definition.bindings?.[parameterName];
+    if (bindingProperty && typeof value === "object") {
+      value = value[bindingProperty];
+    }
+    return matches.groups?.[parameterName] === value.toString();
+  });
+}
 function generateRouteFromName(name, parameters, absolute, shouldThrow) {
   const url = getUrlFromName(name, parameters, shouldThrow);
   return absolute === false ? url.toString().replace(url.origin, "") : url.toString();
 }
+function getNameFromUrl(url, parameters) {
+  const routing = getRouting();
+  const routes = Object.values(routing.routes).map((x) => x.name);
+  return routes.find((routeName) => {
+    return urlMatchesRoute(url, routeName, parameters);
+  });
+}
 function getUrlFromName(name, parameters, shouldThrow) {
   const routing = getRouting();
   const definition = getRouteDefinition(name);
@@ -376,32 +425,39 @@ function getUrlFromName(name, parameters, shouldThrow) {
   }));
   return url;
 }
-function getRouteTransformable(routeName, routeParameters, shouldThrow) {
+function getRouteParameterValue(routeName, parameterName, routeParameters) {
   const routing = getRouting();
+  const definition = getRouteDefinition(routeName);
+  const parameters = routeParameters || {};
+  const value = (() => {
+    const value2 = parameters[parameterName];
+    const bindingProperty = definition.bindings?.[parameterName];
+    if (bindingProperty && value2 != null && typeof value2 === "object") {
+      return value2[bindingProperty];
+    }
+    return value2;
+  })();
+  if (value) {
+    const where = definition.wheres?.[parameterName];
+    if (where && !new RegExp(where).test(value)) {
+      console.warn(`[hybridly:routing] Parameter [${parameterName}] does not match the required format [${where}] for route [${routeName}].`);
+    }
+    return value;
+  }
+  if (routing.defaults?.[parameterName]) {
+    return routing.defaults?.[parameterName];
+  }
+}
+function getRouteTransformable(routeName, routeParameters, shouldThrow) {
   const definition = getRouteDefinition(routeName);
   const parameters = routeParameters || {};
   const missing = Object.keys(parameters);
-  const replaceParameter = (match, parameterName) => {
-    const optional = /\?}$/.test(match);
-    const value = (() => {
-      const value2 = parameters[parameterName];
-      const bindingProperty = definition.bindings?.[parameterName];
-      if (bindingProperty && typeof value2 === "object") {
-        return value2[bindingProperty];
-      }
-      return value2;
-    })();
+  const replaceParameter = (match, parameterName, optional) => {
+    const value = getRouteParameterValue(routeName, parameterName, parameters);
     missing.splice(missing.indexOf(parameterName), 1);
     if (value) {
-      const where = definition.wheres?.[parameterName];
-      if (where && !new RegExp(where).test(value)) {
-        console.warn(`[hybridly:routing] Parameter [${parameterName}] does not match the required format [${where}] for route [${routeName}].`);
-      }
       return value;
     }
-    if (routing.defaults?.[parameterName]) {
-      return routing.defaults?.[parameterName];
-    }
     if (optional) {
       return "";
     }
@@ -410,8 +466,8 @@ function getRouteTransformable(routeName, routeParameters, shouldThrow) {
     }
     throw new MissingRouteParameter(parameterName, routeName);
   };
-  const path = definition.uri.replace(/{([^}?]+)\??}/g, replaceParameter);
-  const domain = definition.domain?.replace(/{([^}?]+)\??}/g, replaceParameter);
+  const path = definition.uri.replace(/{([^}?]+)(\??)}/g, replaceParameter);
+  const domain = definition.domain?.replace(/{([^}?]+)(\??)}/g, replaceParameter);
   const remaining = Object.keys(parameters).filter((key) => missing.includes(key)).reduce((obj, key) => ({
     ...obj,
     [key]: parameters[key]
@@ -441,30 +497,28 @@ function getRouting() {
   }
   return routing;
 }
-
-function isCurrentFromName(name, parameters, mode = "loose") {
-  const location = window.location;
-  const matchee = (() => {
-    try {
-      return makeUrl(generateRouteFromName(name, parameters, true, false));
-    } catch (error) {
-    }
-  })();
-  if (!matchee) {
-    return false;
-  }
-  if (mode === "strict") {
-    return location.href === matchee.href;
-  }
-  return location.href.startsWith(matchee.href);
-}
-
 function route(name, parameters, absolute) {
   return generateRouteFromName(name, parameters, absolute);
 }
-function current(name, parameters, mode = "loose") {
-  return isCurrentFromName(name, parameters, mode);
+
+function getCurrentUrl() {
+  if (typeof window === "undefined") {
+    return getInternalRouterContext().url;
+  }
+  return window.location.toString();
+}
+function currentRouteMatches(name, parameters) {
+  const namePattern = name.replaceAll(".", "\\.").replaceAll("*", ".*");
+  const possibleRoutes = Object.values(getRouting().routes).filter((x) => x.method.includes("GET") && RegExp(namePattern).test(x.name)).map((x) => x.name);
+  const currentUrl = getCurrentUrl();
+  return possibleRoutes.some((routeName) => {
+    return urlMatchesRoute(currentUrl, routeName, parameters);
+  });
 }
+function getCurrentRouteName() {
+  return getNameFromUrl(getCurrentUrl());
+}
+
 function updateRoutingConfiguration(routing) {
   if (!routing) {
     return;
@@ -655,6 +709,8 @@ const router = {
     const method = getRouteDefinition(name).method.at(0);
     return await performHybridNavigation({ url, ...options, method });
   },
+  matches: (name, parameters) => currentRouteMatches(name, parameters),
+  current: () => getCurrentRouteName(),
   dialog: {
     close: (options) => closeDialog(options)
   },
@@ -956,7 +1012,6 @@ function can(resource, action) {
 exports.can = can;
 exports.constants = constants;
 exports.createRouter = createRouter;
-exports.current = current;
 exports.definePlugin = definePlugin;
 exports.getRouterContext = getRouterContext;
 exports.makeUrl = makeUrl;

package/dist/index.d.ts

@@ -234,6 +234,10 @@ interface Router {
     local: (url: UrlResolvable, options: ComponentNavigationOptions) => Promise<void>;
     /** Preloads the given URL. The next time this URL is navigated to, it will be loaded from the cache. */
     preload: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<boolean>;
+    /** Determines if the given route name and parameters matches the current route. */
+    matches: <T extends RouteName>(name: T, parameters?: RouteParameters<T>) => boolean;
+    /** Gets the current route name. Returns `undefined` is unknown. */
+    current: () => string | undefined;
     /** Access the dialog router. */
     dialog: DialogRouter;
     /** Access the history state. */
@@ -434,10 +438,6 @@ declare function can<Authorizations extends Record<string, boolean>, Data extend
  * Generates a route from the given route name.
  */
 declare function route<T extends RouteName>(name: T, parameters?: RouteParameters<T>, absolute?: boolean): string;
-/**
- * Determines if the current route correspond to the given route name and parameters.
- */
-declare function current<T extends RouteName>(name: T, parameters?: RouteParameters<T>, mode?: 'loose' | 'strict'): boolean;
 
 interface DynamicConfiguration {
     architecture: {
@@ -500,4 +500,4 @@ declare namespace constants {
   };
 }
 
-export { Authorizable, DynamicConfiguration, GlobalRouteCollection, HybridPayload, HybridRequestOptions, MaybePromise, Method, NavigationResponse, Plugin, Progress, ResolveComponent, RouteDefinition, RouteName, RouteParameters, Router, RouterContext, RouterContextOptions, RoutingConfiguration, UrlResolvable, can, constants, createRouter, current, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };
+export { Authorizable, DynamicConfiguration, GlobalRouteCollection, HybridPayload, HybridRequestOptions, MaybePromise, Method, NavigationResponse, Plugin, Progress, ResolveComponent, RouteDefinition, RouteName, RouteParameters, Router, RouterContext, RouterContextOptions, RoutingConfiguration, UrlResolvable, can, constants, createRouter, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };

package/dist/index.mjs

@@ -351,10 +351,59 @@ function createSerializer(options) {
   };
 }
 
+function getUrlRegexForRoute(name) {
+  const routing = getRouting();
+  const definition = getRouteDefinition(name);
+  const path = definition.uri.replaceAll("/", "\\/");
+  const domain = definition.domain;
+  const protocolPrefix = routing.url.match(/^\w+:\/\//)?.[0];
+  const origin = domain ? `${protocolPrefix}${domain}${routing.port ? `:${routing.port}` : ""}`.replaceAll("/", "\\/") : routing.url.replaceAll("/", "\\/");
+  const urlPathRegexPattern = path.length > 0 ? `\\/${path.replace(/\/$/g, "")}` : "";
+  let urlRegexPattern = `^${origin.replaceAll(".", "\\.")}${urlPathRegexPattern}\\/?(\\?.*)?$`;
+  urlRegexPattern = urlRegexPattern.replace(/(\\\/?){([^}?]+)(\??)}/g, (_, slash, parameterName, optional) => {
+    const where = definition.wheres?.[parameterName];
+    let regexTemplate = where?.replace(/(^\^)|(\$$)/g, "") || "[^/?]+";
+    regexTemplate = `(?<${parameterName}>${regexTemplate})`;
+    if (optional) {
+      return `(${slash ? "\\/?" : ""}${regexTemplate})?`;
+    }
+    return (slash ? "\\/" : "") + regexTemplate;
+  });
+  return RegExp(urlRegexPattern);
+}
+function urlMatchesRoute(url, name, routeParameters) {
+  const parameters = routeParameters || {};
+  const definition = getRouting().routes[name];
+  if (!definition) {
+    return false;
+  }
+  const matches = getUrlRegexForRoute(name).exec(url);
+  if (!matches) {
+    return false;
+  }
+  for (const k in matches.groups) {
+    matches.groups[k] = typeof matches.groups[k] === "string" ? decodeURIComponent(matches.groups[k]) : matches.groups[k];
+  }
+  return Object.keys(parameters).every((parameterName) => {
+    let value = parameters[parameterName];
+    const bindingProperty = definition.bindings?.[parameterName];
+    if (bindingProperty && typeof value === "object") {
+      value = value[bindingProperty];
+    }
+    return matches.groups?.[parameterName] === value.toString();
+  });
+}
 function generateRouteFromName(name, parameters, absolute, shouldThrow) {
   const url = getUrlFromName(name, parameters, shouldThrow);
   return absolute === false ? url.toString().replace(url.origin, "") : url.toString();
 }
+function getNameFromUrl(url, parameters) {
+  const routing = getRouting();
+  const routes = Object.values(routing.routes).map((x) => x.name);
+  return routes.find((routeName) => {
+    return urlMatchesRoute(url, routeName, parameters);
+  });
+}
 function getUrlFromName(name, parameters, shouldThrow) {
   const routing = getRouting();
   const definition = getRouteDefinition(name);
@@ -367,32 +416,39 @@ function getUrlFromName(name, parameters, shouldThrow) {
   }));
   return url;
 }
-function getRouteTransformable(routeName, routeParameters, shouldThrow) {
+function getRouteParameterValue(routeName, parameterName, routeParameters) {
   const routing = getRouting();
+  const definition = getRouteDefinition(routeName);
+  const parameters = routeParameters || {};
+  const value = (() => {
+    const value2 = parameters[parameterName];
+    const bindingProperty = definition.bindings?.[parameterName];
+    if (bindingProperty && value2 != null && typeof value2 === "object") {
+      return value2[bindingProperty];
+    }
+    return value2;
+  })();
+  if (value) {
+    const where = definition.wheres?.[parameterName];
+    if (where && !new RegExp(where).test(value)) {
+      console.warn(`[hybridly:routing] Parameter [${parameterName}] does not match the required format [${where}] for route [${routeName}].`);
+    }
+    return value;
+  }
+  if (routing.defaults?.[parameterName]) {
+    return routing.defaults?.[parameterName];
+  }
+}
+function getRouteTransformable(routeName, routeParameters, shouldThrow) {
   const definition = getRouteDefinition(routeName);
   const parameters = routeParameters || {};
   const missing = Object.keys(parameters);
-  const replaceParameter = (match, parameterName) => {
-    const optional = /\?}$/.test(match);
-    const value = (() => {
-      const value2 = parameters[parameterName];
-      const bindingProperty = definition.bindings?.[parameterName];
-      if (bindingProperty && typeof value2 === "object") {
-        return value2[bindingProperty];
-      }
-      return value2;
-    })();
+  const replaceParameter = (match, parameterName, optional) => {
+    const value = getRouteParameterValue(routeName, parameterName, parameters);
     missing.splice(missing.indexOf(parameterName), 1);
     if (value) {
-      const where = definition.wheres?.[parameterName];
-      if (where && !new RegExp(where).test(value)) {
-        console.warn(`[hybridly:routing] Parameter [${parameterName}] does not match the required format [${where}] for route [${routeName}].`);
-      }
       return value;
     }
-    if (routing.defaults?.[parameterName]) {
-      return routing.defaults?.[parameterName];
-    }
     if (optional) {
       return "";
     }
@@ -401,8 +457,8 @@ function getRouteTransformable(routeName, routeParameters, shouldThrow) {
     }
     throw new MissingRouteParameter(parameterName, routeName);
   };
-  const path = definition.uri.replace(/{([^}?]+)\??}/g, replaceParameter);
-  const domain = definition.domain?.replace(/{([^}?]+)\??}/g, replaceParameter);
+  const path = definition.uri.replace(/{([^}?]+)(\??)}/g, replaceParameter);
+  const domain = definition.domain?.replace(/{([^}?]+)(\??)}/g, replaceParameter);
   const remaining = Object.keys(parameters).filter((key) => missing.includes(key)).reduce((obj, key) => ({
     ...obj,
     [key]: parameters[key]
@@ -432,30 +488,28 @@ function getRouting() {
   }
   return routing;
 }
-
-function isCurrentFromName(name, parameters, mode = "loose") {
-  const location = window.location;
-  const matchee = (() => {
-    try {
-      return makeUrl(generateRouteFromName(name, parameters, true, false));
-    } catch (error) {
-    }
-  })();
-  if (!matchee) {
-    return false;
-  }
-  if (mode === "strict") {
-    return location.href === matchee.href;
-  }
-  return location.href.startsWith(matchee.href);
-}
-
 function route(name, parameters, absolute) {
   return generateRouteFromName(name, parameters, absolute);
 }
-function current(name, parameters, mode = "loose") {
-  return isCurrentFromName(name, parameters, mode);
+
+function getCurrentUrl() {
+  if (typeof window === "undefined") {
+    return getInternalRouterContext().url;
+  }
+  return window.location.toString();
+}
+function currentRouteMatches(name, parameters) {
+  const namePattern = name.replaceAll(".", "\\.").replaceAll("*", ".*");
+  const possibleRoutes = Object.values(getRouting().routes).filter((x) => x.method.includes("GET") && RegExp(namePattern).test(x.name)).map((x) => x.name);
+  const currentUrl = getCurrentUrl();
+  return possibleRoutes.some((routeName) => {
+    return urlMatchesRoute(currentUrl, routeName, parameters);
+  });
 }
+function getCurrentRouteName() {
+  return getNameFromUrl(getCurrentUrl());
+}
+
 function updateRoutingConfiguration(routing) {
   if (!routing) {
     return;
@@ -646,6 +700,8 @@ const router = {
     const method = getRouteDefinition(name).method.at(0);
     return await performHybridNavigation({ url, ...options, method });
   },
+  matches: (name, parameters) => currentRouteMatches(name, parameters),
+  current: () => getCurrentRouteName(),
   dialog: {
     close: (options) => closeDialog(options)
   },
@@ -944,4 +1000,4 @@ function can(resource, action) {
   return resource.authorization?.[action] ?? false;
 }
 
-export { can, constants, createRouter, current, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };
+export { can, constants, createRouter, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hybridly/core",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Core functionality of Hybridly",
   "keywords": [
     "hybridly",
@@ -37,8 +37,8 @@
   },
   "dependencies": {
     "qs": "^6.11.2",
-    "superjson": "^1.12.3",
-    "@hybridly/utils": "0.4.1"
+    "superjson": "^1.12.4",
+    "@hybridly/utils": "0.4.2"
   },
   "devDependencies": {
     "defu": "^6.1.2"