@cloudflare/util-routes 5.0.45 → 5.0.47

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.47](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-routes@5.0.46...@cloudflare/util-routes@5.0.47) (2020-02-12)
+
+**Note:** Version bump only for package @cloudflare/util-routes
+
+
+
+
+
+## [5.0.46](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-routes@5.0.45...@cloudflare/util-routes@5.0.46) (2020-02-10)
+
+**Note:** Version bump only for package @cloudflare/util-routes
+
+
+
+
+
 ## [5.0.45](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-routes@5.0.44...@cloudflare/util-routes@5.0.45) (2020-02-10)
 
 **Note:** Version bump only for package @cloudflare/util-routes

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@cloudflare/util-routes",
   "description": "Wraps path-to-regexp with a convenient, type-safe tagged template function",
-  "version": "5.0.45",
+  "version": "5.0.47",
   "types": "./dist/index.d.ts",
-  "main": "lib/index.js",
+  "main": "src/index.ts",
   "module": "es/index.js",
   "jsnext:main": "es/index.js",
   "author": "Frontend Team <frontend@cloudflare.com>",
@@ -13,6 +13,7 @@
   ],
   "license": "UNLICENSED",
   "publishConfig": {
+    "main": "lib/index.js",
     "registry": "http://registry.npmjs.org/",
     "access": "restricted"
   },
@@ -25,7 +26,7 @@
     "path-to-regexp": "^3.0.0"
   },
   "devDependencies": {
-    "@cloudflare/types": "^6.4.16"
+    "@cloudflare/types": "^6.4.18"
   },
-  "gitHead": "5b7ec7be1d1939506d2d08b2d1c2c77a393b536b"
+  "gitHead": "88916f170a5a79963b140a5eb6158ed2277f3ac6"
 }

package/src/index.d.ts

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

package/src/index.ts

@@ -0,0 +1 @@
+export * from './route'

package/src/route.d.ts

@@ -0,0 +1,22 @@
+import pathToRegExp from 'path-to-regexp';
+import { ValueOfArray, Tail, Prepend, Head } from '@cloudflare/types';
+export declare class RoutePatternResult<Param extends string> {
+    readonly pattern: string;
+    /**
+     * Interperolate arguments into the route pattern
+     */
+    readonly toUrl: (args: {
+        [K in Param]: string;
+    }, options?: pathToRegExp.PathFunctionOptions) => string;
+    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[] = []> = {
+    returnResult: RoutePatternResult<ValueOfArray<Result>>;
+    recurse: RoutePatternResultFromParams<Tail<Params>, Prepend<ExtractParam<Head<Params>>, Result>>;
+}[Head<Params> extends never ? 'returnResult' : 'recurse'];
+declare type ExtractParam<T extends string | RoutePatternResult<string>> = T extends RoutePatternResult<infer S> ? S : T;
+export {};

package/src/route.ts

@@ -0,0 +1,62 @@
+import pathToRegExp from 'path-to-regexp'
+import { ValueOfArray, Tail, Prepend, Head } from '@cloudflare/types'
+
+export class RoutePatternResult<Param extends string> {
+  public readonly pattern: string
+
+  /**
+   * Interperolate arguments into the route pattern
+   */
+  readonly toUrl: (
+    args: { [K in Param]: string },
+    options?: pathToRegExp.PathFunctionOptions,
+  ) => string
+
+  constructor(pattern: string) {
+    this.pattern = pattern
+    this.toUrl = pathToRegExp.compile(this.pattern)
+  }
+}
+
+/**
+ * Tag a template string with route data
+ */
+export function route<
+  Param extends string,
+  ParamOrPatternResult extends Array<Param | RoutePatternResult<string>>
+>(
+  strings: TemplateStringsArray,
+  ...paramNames: ParamOrPatternResult
+): RoutePatternResultFromParams<ParamOrPatternResult> {
+  const pattern = strings.reduce((accum, str, i) => {
+    let result = accum + str
+    const paramName = paramNames[i]
+
+    if (paramName instanceof RoutePatternResult) {
+      result += paramName.pattern
+    } else if (typeof paramName === 'string') {
+      result += ':' + paramName
+    }
+
+    return result
+  }, '')
+
+  // Without casting to any, we get the following error:
+  // > Type instantiation is excessively deep and possibly infinite.
+  return new RoutePatternResult<Param>(pattern) as any
+}
+
+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']
+
+type ExtractParam<
+  T extends string | RoutePatternResult<string>
+> = T extends RoutePatternResult<infer S> ? S : T

package/es/index.d.js

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

package/es/route.d.js

@@ -1,3 +0,0 @@
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-export {};

package/lib/index.d.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-var _route = require("./route");
-
-Object.keys(_route).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _route[key];
-    }
-  });
-});

package/lib/route.d.js

@@ -1,3 +0,0 @@
-"use strict";
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }