@cloudflare/util-routes 5.2.6 → 5.2.7

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.2.7](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-routes@5.2.6...@cloudflare/util-routes@5.2.7) (2022-05-05)
+
+**Note:** Version bump only for package @cloudflare/util-routes
+
+
+
+
+
 ## [5.2.6](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-routes@5.2.5...@cloudflare/util-routes@5.2.6) (2022-05-04)
 
 **Note:** Version bump only for package @cloudflare/util-routes

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from './route';
+export * from './useRoute';

package/dist/route.d.ts

@@ -1,4 +1,4 @@
-import pathToRegExp from 'path-to-regexp';
+import pathToRegExp, { Key } from 'path-to-regexp';
 import { ValueOfArray, Tail, Prepend, Head } from '@cloudflare/types';
 export declare class RoutePatternResult<Param extends string> {
     readonly pattern: string;
@@ -8,13 +8,15 @@ export declare class RoutePatternResult<Param extends string> {
     readonly toUrl: (args: {
         [K in Param]: string;
     }, options?: pathToRegExp.PathFunctionOptions) => string;
+    readonly keys: Key[];
+    readonly expression: RegExp;
     constructor(pattern: string);
 }
 /**
  * Tag a template string with route data
  */
 export declare function route<Param extends string, ParamOrPatternResult extends Array<Param | RoutePatternResult<string>>>(strings: TemplateStringsArray, ...paramNames: ParamOrPatternResult): RoutePatternResultFromParams<ParamOrPatternResult>;
-declare type RoutePatternResultFromParams<Params extends Array<string | RoutePatternResult<string>>, Result extends string[] = []> = {
+export declare type RoutePatternResultFromParams<Params extends Array<string | RoutePatternResult<string>>, Result extends string[] = []> = {
     returnResult: RoutePatternResult<ValueOfArray<Result>>;
     recurse: RoutePatternResultFromParams<Tail<Params>, Prepend<ExtractParam<Head<Params>>, Result>>;
 }[Head<Params> extends never ? 'returnResult' : 'recurse'];
@@ -22,4 +24,3 @@ export declare type ExtractParam<T extends string | RoutePatternResult<string>>
 export declare type ExtractRouteParamsInterface<T extends string | RoutePatternResult<string>> = {
     [K in ExtractParam<T>]: string | undefined;
 };
-export {};

package/dist/useRoute.d.ts

@@ -0,0 +1,4 @@
+import { ExtractParam, RoutePatternResult } from './route';
+export declare function useRoute<T extends RoutePatternResult<any>>(route: T, useParams: () => any): {
+    [K in ExtractParam<T>]: string;
+};

package/es/index.js

@@ -1 +1,2 @@
-export * from './route';
+export * from './route';
+export * from './useRoute';

package/es/route.js

@@ -10,6 +10,11 @@ export class RoutePatternResult {
 
     _defineProperty(this, "toUrl", void 0);
 
+    _defineProperty(this, "keys", []);
+
+    _defineProperty(this, "expression", void 0);
+
+    this.expression = pathToRegExp(pattern, this.keys);
     this.pattern = pattern;
     this.toUrl = pathToRegExp.compile(this.pattern);
   }

package/es/useRoute.js

@@ -0,0 +1,16 @@
+export function useRoute(route, useParams) {
+  const result = {};
+  const params = useParams();
+
+  for (const _ref of route.keys) {
+    const name = _ref.name;
+
+    if (typeof params[name] !== 'string') {
+      throw new Error(`useRoute did not find the required parameters for this route: ${route.pattern}. Missing parameter: ${name}`);
+    }
+
+    result[name] = params[name];
+  }
+
+  return result;
+}

package/lib/index.js

@@ -14,4 +14,16 @@ Object.keys(_route).forEach(function (key) {
       return _route[key];
     }
   });
+});
+
+var _useRoute = require("./useRoute");
+
+Object.keys(_useRoute).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _useRoute[key];
+    }
+  });
 });

package/lib/route.js

@@ -25,6 +25,11 @@ function RoutePatternResult(pattern) {
 
   _defineProperty(this, "toUrl", void 0);
 
+  _defineProperty(this, "keys", []);
+
+  _defineProperty(this, "expression", void 0);
+
+  this.expression = (0, _pathToRegexp.default)(pattern, this.keys);
   this.pattern = pattern;
   this.toUrl = _pathToRegexp.default.compile(this.pattern);
 };

package/lib/useRoute.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRoute = useRoute;
+
+function useRoute(route, useParams) {
+  var result = {};
+  var params = useParams();
+  var _iteratorNormalCompletion = true;
+  var _didIteratorError = false;
+  var _iteratorError = undefined;
+
+  try {
+    for (var _iterator = route.keys[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+      var _ref2 = _step.value;
+      var name = _ref2.name;
+
+      if (typeof params[name] !== 'string') {
+        throw new Error("useRoute did not find the required parameters for this route: ".concat(route.pattern, ". Missing parameter: ").concat(name));
+      }
+
+      result[name] = params[name];
+    }
+  } catch (err) {
+    _didIteratorError = true;
+    _iteratorError = err;
+  } finally {
+    try {
+      if (!_iteratorNormalCompletion && _iterator.return != null) {
+        _iterator.return();
+      }
+    } finally {
+      if (_didIteratorError) {
+        throw _iteratorError;
+      }
+    }
+  }
+
+  return result;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudflare/util-routes",
   "description": "Wraps path-to-regexp with a convenient, type-safe tagged template function",
-  "version": "5.2.6",
+  "version": "5.2.7",
   "types": "./dist/index.d.ts",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -21,8 +21,8 @@
     "autoGeneratedReadme": false
   },
   "dependencies": {
-    "@cloudflare/types": "^6.14.16",
+    "@cloudflare/types": "^6.14.17",
     "path-to-regexp": "^3.0.0"
   },
-  "gitHead": "a3180c1ee69ed6fbe5943fd2a16fb2e9950becdc"
+  "gitHead": "810c5cdf263deb6f1996bdea357064221f82a1bd"
 }