tungsten 0.2.12 → 0.2.13

package/dist/Servers/routing.js

@@ -23,7 +23,7 @@ export async function routing(location, routes, serverDataLoading = null) {
       let data = undefined;
       if (route.data) {
         if (serverDataLoading) serverDataLoading.value = true;
-        data = await route.data(params, location);
+        data = await route.data(params, location, match.query);
         if (serverDataLoading) serverDataLoading.value = false;
       }
       //console.log('route data is', data)

package/dist/routing/Match.type.d.ts

@@ -1,8 +1,17 @@
 export type Match = {
     pattern: string;
+    /** The full request string as received, including any query string and hash. */
     request: string;
+    /** The path portion of the request only (query string and hash removed). */
+    pathname: string;
     params: {
         [key: string]: string;
     };
+    /** Parsed query string parameters (empty object when there is no query string). */
+    query: {
+        [key: string]: string;
+    };
+    /** The hash fragment without the leading '#' (empty string when there is none). */
+    hash: string;
 };
 //# sourceMappingURL=Match.type.d.ts.map

package/dist/routing/Match.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Match.type.d.ts","sourceRoot":"","sources":["../../src/routing/Match.type.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,KAAK,GAAG;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;CACpC,CAAA"}
+{"version":3,"file":"Match.type.d.ts","sourceRoot":"","sources":["../../src/routing/Match.type.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,KAAK,GAAG;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,gFAAgF;IAChF,OAAO,EAAE,MAAM,CAAA;IACf,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACjC,mFAAmF;IACnF,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAChC,mFAAmF;IACnF,IAAI,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/routing/RouteDataFunction.type.d.ts

@@ -1,4 +1,6 @@
 import { RoutingRedirect } from './RoutingRedirect.js';
 import { WebRedirect } from './WebRedirect.js';
-export type RouteDataFunction<Params extends object, DataType> = (params: Params, location: string) => Promise<DataType | RoutingRedirect | WebRedirect>;
+export type RouteDataFunction<Params extends object, DataType> = (params: Params, location: string, query: {
+    [key: string]: string;
+}) => Promise<DataType | RoutingRedirect | WebRedirect>;
 //# sourceMappingURL=RouteDataFunction.type.d.ts.map

package/dist/routing/RouteDataFunction.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RouteDataFunction.type.d.ts","sourceRoot":"","sources":["../../src/routing/RouteDataFunction.type.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,MAAM,EAAE,QAAQ,IACvD,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,GAAG,eAAe,GAAG,WAAW,CAAC,CAAA"}
+{"version":3,"file":"RouteDataFunction.type.d.ts","sourceRoot":"","sources":["../../src/routing/RouteDataFunction.type.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,MAAM,EAAE,QAAQ,IACvD,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,KAC9D,OAAO,CAAC,QAAQ,GAAG,eAAe,GAAG,WAAW,CAAC,CAAA"}

package/dist/routing/matchPath.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matchPath.d.ts","sourceRoot":"","sources":["../../src/routing/matchPath.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAK5C,wBAAgB,SAAS,CAAC,OAAO,EAAE,IAAI,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CA6D9E"}
+{"version":3,"file":"matchPath.d.ts","sourceRoot":"","sources":["../../src/routing/matchPath.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAM5C,wBAAgB,SAAS,CAAC,OAAO,EAAE,IAAI,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAqE9E"}

package/dist/routing/matchPath.js

@@ -1,10 +1,19 @@
 import { compareRequestToRegex } from "./compareRequestToRegex.js";
 import { patternToRegex } from "./patternToRegex.js";
+import { splitRequest } from "./splitRequest.js";
 export function matchPath(pattern, request) {
   // pathToRegexp(path, keys?, options?)
   // match(path)
   // parse(path)
   // compile(path)
+  // Match only the path portion of the request, like Express: strip the query
+  // string and hash fragment before testing against the anchored (^…$) regex.
+  // Otherwise a request like '/foo?bar=1' would never match the pattern '/foo'.
+  const {
+    pathname,
+    query,
+    hash
+  } = splitRequest(request);
   const {
     regex,
     keys
@@ -14,13 +23,16 @@ export function matchPath(pattern, request) {
   const {
     success,
     params
-  } = compareRequestToRegex(request, regex, keys);
+  } = compareRequestToRegex(pathname, regex, keys);
   //console.log('regex', regex, 'keys', keys, 'success', success)
   if (success) {
     return {
       pattern,
       request,
-      params
+      pathname,
+      params,
+      query,
+      hash
     };
   }
   return null;

package/dist/routing/matchPath.sxyt.js

@@ -15,4 +15,27 @@ describe('routing/matchPath()', ({
     const match = matchPath('/foo/', '/foo');
     expect(match).not.to.equal(null);
   });
+  it(`matches /foo when the request has a query string`, () => {
+    const match = matchPath('/foo', '/foo?bar=1');
+    expect(match).not.to.equal(null);
+    expect(match.query).to.deep.equal({
+      bar: '1'
+    });
+    expect(match.pathname).to.equal('/foo');
+  });
+  it(`matches /foo when the request has a hash fragment`, () => {
+    const match = matchPath('/foo', '/foo#section');
+    expect(match).not.to.equal(null);
+    expect(match.hash).to.equal('section');
+  });
+  it(`matches a dynamic route with a query string and captures the param`, () => {
+    const match = matchPath('/leads/:id/details', '/leads/5/details?queue=1');
+    expect(match).not.to.equal(null);
+    expect(match.params).to.deep.equal({
+      id: '5'
+    });
+    expect(match.query).to.deep.equal({
+      queue: '1'
+    });
+  });
 });

package/dist/routing/splitRequest.d.ts

@@ -0,0 +1,17 @@
+export type SplitRequest = {
+    pathname: string;
+    query: {
+        [key: string]: string;
+    };
+    hash: string;
+};
+/**
+ * Split an incoming request string into its path, query, and hash parts, the
+ * way a URL is structured: `/path?query#hash`. Only `pathname` should be used
+ * for route matching (query and hash are not part of the path).
+ *
+ * The hash is separated first because a URL's fragment can itself contain a
+ * '?' that is not a query delimiter (e.g. '/foo#a?b').
+ */
+export declare function splitRequest(request: string): SplitRequest;
+//# sourceMappingURL=splitRequest.d.ts.map

package/dist/routing/splitRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitRequest.d.ts","sourceRoot":"","sources":["../../src/routing/splitRequest.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAChC,IAAI,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,CAwB1D"}

package/dist/routing/splitRequest.js

@@ -0,0 +1,29 @@
+/**
+ * Split an incoming request string into its path, query, and hash parts, the
+ * way a URL is structured: `/path?query#hash`. Only `pathname` should be used
+ * for route matching (query and hash are not part of the path).
+ *
+ * The hash is separated first because a URL's fragment can itself contain a
+ * '?' that is not a query delimiter (e.g. '/foo#a?b').
+ */
+export function splitRequest(request) {
+  let rest = request;
+  let hash = '';
+  let query = {};
+  const hashIndex = rest.indexOf('#');
+  if (hashIndex !== -1) {
+    hash = rest.slice(hashIndex + 1);
+    rest = rest.slice(0, hashIndex);
+  }
+  const queryIndex = rest.indexOf('?');
+  if (queryIndex !== -1) {
+    const search = rest.slice(queryIndex + 1);
+    rest = rest.slice(0, queryIndex);
+    query = Object.fromEntries(new URLSearchParams(search));
+  }
+  return {
+    pathname: rest,
+    query,
+    hash
+  };
+}

package/dist/routing/splitRequest.sxyt.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=splitRequest.sxyt.d.ts.map

package/dist/routing/splitRequest.sxyt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitRequest.sxyt.d.ts","sourceRoot":"","sources":["../../src/routing/splitRequest.sxyt.ts"],"names":[],"mappings":""}

package/dist/routing/splitRequest.sxyt.js

@@ -0,0 +1,47 @@
+import { describe } from 'sxy-test-runner';
+import { expect } from 'chai';
+import { splitRequest } from "./splitRequest.js";
+describe('routing/splitRequest()', ({
+  it
+}) => {
+  it(`returns the path unchanged when there is no query or hash`, () => {
+    expect(splitRequest('/foo/bar')).to.deep.equal({
+      pathname: '/foo/bar',
+      query: {},
+      hash: ''
+    });
+  });
+  it(`splits off a query string and parses it`, () => {
+    expect(splitRequest('/foo?a=1&b=2')).to.deep.equal({
+      pathname: '/foo',
+      query: {
+        a: '1',
+        b: '2'
+      },
+      hash: ''
+    });
+  });
+  it(`splits off a hash fragment`, () => {
+    expect(splitRequest('/foo#section')).to.deep.equal({
+      pathname: '/foo',
+      query: {},
+      hash: 'section'
+    });
+  });
+  it(`splits off both query and hash`, () => {
+    expect(splitRequest('/foo?a=1#section')).to.deep.equal({
+      pathname: '/foo',
+      query: {
+        a: '1'
+      },
+      hash: 'section'
+    });
+  });
+  it(`does not treat a '?' inside the hash as a query delimiter`, () => {
+    expect(splitRequest('/foo#a?b')).to.deep.equal({
+      pathname: '/foo',
+      query: {},
+      hash: 'a?b'
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tungsten",
-  "version": "0.2.12",
+  "version": "0.2.13",
   "description": "",
   "type": "module",
   "bin": {