fix(js:types): handle + add tests when routes are imported from JSON file

Author: Kocal

Resources/js/router.ts

@@ -15,7 +15,7 @@ export interface QueryParamAddFunction {
 }
 
 export interface Route {
-  tokens: ([string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, boolean])[];
+  tokens: (string|boolean)[][];
   defaults: undefined[] | RouteDefaults;
   requirements: undefined[] | RouteRequirements;
   hosttokens: string[][];
@@ -33,7 +33,7 @@ export interface Context {
   host: string;
   port: string | null;
   scheme: string;
-  locale: string;
+  locale: string | null;
 }
 
 export interface RoutingData {
@@ -43,7 +43,7 @@ export interface RoutingData {
   host: string;
   port?: string | null;
   scheme?: string;
-  locale?: string;
+  locale?: string | null;
 }
 
 export class Router {
@@ -130,11 +130,11 @@ export class Router {
     return this.context_.port;
   };
 
-  setLocale(locale: string) {
+  setLocale(locale: string | null) {
     this.context_.locale = locale;
   }
 
-  getLocale(): string {
+  getLocale(): string | null {
     return this.context_.locale;
   };
 
@@ -194,22 +194,22 @@ export class Router {
     let port = (typeof this.getPort() == 'undefined' || this.getPort() === null) ? '' : this.getPort();
 
     route.tokens.forEach((token) => {
-      if ('text' === token[0]) {
+      if ('text' === token[0] && typeof token[1] === 'string') {
         url = Router.encodePathComponent(token[1]) + url;
         optional = false;
 
         return;
       }
 
       if ('variable' === token[0]) {
-        let hasDefault = route.defaults && !Array.isArray(route.defaults) && token[3] && (token[3] in route.defaults);
-        if (false === optional || !hasDefault || ((token[3] && token[3] in params) && !Array.isArray(route.defaults) && params[token[3]] != route.defaults[token[3]])) {
+        let hasDefault = route.defaults && !Array.isArray(route.defaults) && typeof token[3] === 'string' && (token[3] in route.defaults);
+        if (false === optional || !hasDefault || ((typeof token[3] === 'string' && token[3] in params) && !Array.isArray(route.defaults) && params[token[3]] != route.defaults[token[3]])) {
           let value;
 
-          if (token[3] && token[3] in params) {
+          if (typeof token[3] === 'string' && token[3] in params) {
             value = params[token[3]];
             delete unusedParams[token[3]];
-          } else if (token[3] && hasDefault && !Array.isArray(route.defaults)) {
+          } else if (typeof token[3] === 'string' && hasDefault && !Array.isArray(route.defaults)) {
             value = route.defaults[token[3]];
           } else if (optional) {
             return;
@@ -230,7 +230,7 @@ export class Router {
           }
 
           optional = false;
-        } else if (hasDefault && (token[3] && token[3] in unusedParams)) {
+        } else if (hasDefault && (typeof token[3] === 'string' && token[3] in unusedParams)) {
           delete unusedParams[token[3]];
         }
 

Resources/public/js/router.js

@@ -204,22 +204,22 @@ var Router = /*#__PURE__*/function () {
       var host = '';
       var port = typeof this.getPort() == 'undefined' || this.getPort() === null ? '' : this.getPort();
       route.tokens.forEach(function (token) {
-        if ('text' === token[0]) {
+        if ('text' === token[0] && typeof token[1] === 'string') {
           url = Router.encodePathComponent(token[1]) + url;
           optional = false;
           return;
         }
 
         if ('variable' === token[0]) {
-          var hasDefault = route.defaults && !Array.isArray(route.defaults) && token[3] && token[3] in route.defaults;
+          var hasDefault = route.defaults && !Array.isArray(route.defaults) && typeof token[3] === 'string' && token[3] in route.defaults;
 
-          if (false === optional || !hasDefault || token[3] && token[3] in params && !Array.isArray(route.defaults) && params[token[3]] != route.defaults[token[3]]) {
+          if (false === optional || !hasDefault || typeof token[3] === 'string' && token[3] in params && !Array.isArray(route.defaults) && params[token[3]] != route.defaults[token[3]]) {
             var value;
 
-            if (token[3] && token[3] in params) {
+            if (typeof token[3] === 'string' && token[3] in params) {
               value = params[token[3]];
               delete unusedParams[token[3]];
-            } else if (token[3] && hasDefault && !Array.isArray(route.defaults)) {
+            } else if (typeof token[3] === 'string' && hasDefault && !Array.isArray(route.defaults)) {
               value = route.defaults[token[3]];
             } else if (optional) {
               return;
@@ -240,7 +240,7 @@ var Router = /*#__PURE__*/function () {
             }
 
             optional = false;
-          } else if (hasDefault && token[3] && token[3] in unusedParams) {
+          } else if (hasDefault && typeof token[3] === 'string' && token[3] in unusedParams) {
             delete unusedParams[token[3]];
           }
 

Resources/public/js/router.min.js

@@ -11,7 +11,7 @@ export interface QueryParamAddFunction {
     (prefix: string, params: any): void;
 }
 export interface Route {
-    tokens: ([string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, boolean])[];
+    tokens: (string | boolean)[][];
     defaults: undefined[] | RouteDefaults;
     requirements: undefined[] | RouteRequirements;
     hosttokens: string[][];
@@ -27,7 +27,7 @@ export interface Context {
     host: string;
     port: string | null;
     scheme: string;
-    locale: string;
+    locale: string | null;
 }
 export interface RoutingData {
     base_url: string;
@@ -36,7 +36,7 @@ export interface RoutingData {
     host: string;
     port?: string | null;
     scheme?: string;
-    locale?: string;
+    locale?: string | null;
 }
 export declare class Router {
     private context_;
@@ -56,8 +56,8 @@ export declare class Router {
     getHost(): string;
     setPort(port: string | null): void;
     getPort(): string | null;
-    setLocale(locale: string): void;
-    getLocale(): string;
+    setLocale(locale: string | null): void;
+    getLocale(): string | null;
     /**
      * Builds query string params added to a URL.
      * Port of jQuery's $.param() function, so credit is due there.

Resources/ts/router.d.ts

@@ -1,6 +1,7 @@
 import { expectType } from 'tsd';
 import { RoutesMap } from '../js/router';
 import { Route, Router, Routing } from './router';
+import routes from './routes.json';
 
 expectType<Router>(Router.getInstance());
 expectType<Router>(Routing);
@@ -20,9 +21,10 @@ Routing.setHost('localhost');
 expectType<string | null>(Routing.getPort());
 Routing.setPort('1234');
 
-expectType<string>(Routing.getLocale());
+expectType<string | null>(Routing.getLocale());
 Routing.setLocale('en');
 
+Routing.setRoutingData(routes);
 Routing.setRoutingData({
   base_url: '',
   routes: {

Resources/ts/router.test-d.ts

@@ -0,0 +1,45 @@
+{
+  "base_url": "",
+  "routes": {
+    "bazinga_jstranslation_js": {
+      "tokens": [
+        [
+          "variable",
+          ".",
+          "js|json",
+          "_format",
+          true
+        ],
+        [
+          "variable",
+          "\/",
+          "[\\w]+",
+          "domain",
+          true
+        ],
+        [
+          "text",
+          "\/translations"
+        ]
+      ],
+      "defaults": {
+        "domain": "messages",
+        "_format": "js"
+      },
+      "requirements": {
+        "_format": "js|json",
+        "domain": "[\\w]+"
+      },
+      "hosttokens": [],
+      "methods": [
+        "GET"
+      ],
+      "schemes": []
+    }
+  },
+  "prefix": "",
+  "host": "localhost",
+  "port": "",
+  "scheme": "https",
+  "locale": null
+}

Resources/ts/routes.json

@@ -1,6 +1,8 @@
 {
   "compilerOptions": {
     "declaration": true,
-    "declarationDir": "ts"
+    "declarationDir": "ts",
+    "resolveJsonModule": true,
+    "esModuleInterop": true
   }
 }