Added common localization actors and routing function

Author: wintondeshong

package-lock.json

@@ -24,6 +24,7 @@
         "jest": "25.5.4",
         "jest-extended": "0.11.5",
         "prettier": "1.19.1",
+        "query-string": "6.13.1",
         "rimraf": "2.6.2",
         "rosie": "2.0.1",
         "ts-jest": "25.5.1",

package.json

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for digesting localization related culture information
+ */
+export default interface CultureParams {
+    /**
+     * RFC-4646 language code
+     */
+    culture: string;
+}

src/interfaces/culture-params.ts

@@ -0,0 +1,14 @@
+/**
+ * Localization culture information and related nested resources
+ */
+export default interface Culture<TResources> {
+    /**
+     * RFC-4646 language code
+     */
+    code: string;
+
+    /**
+     * Key/value pairs of translations
+     */
+    resources: TResources;
+}

src/interfaces/culture.ts

@@ -210,6 +210,78 @@ describe("RouteUtils", () => {
 
     //#endregion isAbsoluteUrl
 
+    // -----------------------------------------------------------------------------------------
+    // #region queryStringToObject
+    // -----------------------------------------------------------------------------------------
+
+    describe("queryStringToObject", () => {
+        test.each`
+            inputString
+            ${null}
+            ${undefined}
+            ${""}
+            ${" "}
+        `(
+            "given queryString is $inputString, returns empty object",
+            ({ inputString }) => {
+                // Arrange & Act
+                const result = RouteUtils.queryStringToObject<any>(inputString);
+
+                // Assert
+                expect(result).not.toBeNull();
+                expect(typeof result).toBe("object");
+            }
+        );
+
+        test("given queryString contains matching properties, returns typed object", () => {
+            // Arrange
+            interface TestStub {
+                testProp1: string;
+                testProp2: string;
+            }
+            const expectedValue1 = "testValue1";
+            const expectedValue2 = "testValue2";
+
+            const queryString = `testProp1=${expectedValue1}&testProp2=${expectedValue2}`;
+
+            // Act
+            const result = RouteUtils.queryStringToObject<TestStub>(
+                queryString
+            );
+
+            // Assert
+            expect(result).not.toBeNull();
+            expect(result.testProp1).toBe(expectedValue1);
+            expect(result.testProp2).toBe(expectedValue2);
+        });
+
+        test("given queryString contains unmatching properties, returns typed object with unmatched properties", () => {
+            // Arrange
+            interface TestStub {
+                testProp1: string;
+            }
+            const expectedTypedValue1 = "testValue1";
+            const expectedUntypedProperty2 = "testProp2";
+            const expectedUntypedValue2 = "testValue2";
+
+            const queryString = `testProp1=${expectedTypedValue1}&${expectedUntypedProperty2}=${expectedUntypedValue2}`;
+
+            // Act
+            const result = RouteUtils.queryStringToObject<TestStub>(
+                queryString
+            );
+
+            // Assert
+            expect(result).not.toBeNull();
+            expect(result.testProp1).toBe(expectedTypedValue1);
+            expect(result[expectedUntypedProperty2]).toBe(
+                expectedUntypedValue2
+            );
+        });
+    });
+
+    //#endregion queryStringToObject
+
     // -----------------------------------------------------------------------------------------
     // #region replacePathParams
     // -----------------------------------------------------------------------------------------

src/utilities/route-utils.test.ts

@@ -1,3 +1,5 @@
+import QueryString from "query-string";
+
 // -----------------------------------------------------------------------------------------
 // #region Constants
 // -----------------------------------------------------------------------------------------
@@ -72,6 +74,25 @@ const getUrlFromPath = (path: string, pathParams?: any, queryParams?: any) => {
 const isAbsoluteUrl = (url: string): boolean =>
     new RegExp("^(?:[a-z]+:)?//", "i").test(url);
 
+/**
+ * Parse a query string and return an object of type T
+ * @param queryString current query string
+ * @param arrayFormat format to parse arrays from
+ * @param parseNumbers convert numbers to number type from string
+ * @param parseBooleans convert booleans to boolean type from string
+ */
+const queryStringToObject = <T>(
+    queryString: string,
+    arrayFormat: "bracket" | "index" | "comma" = "index",
+    parseNumbers: boolean = true,
+    parseBooleans: boolean = true
+): T =>
+    (QueryString.parse(queryString, {
+        arrayFormat,
+        parseNumbers,
+        parseBooleans,
+    }) as any) as T;
+
 /**
  * Replace routing components in supplied path with keys and values
  * of supplied pathParams.
@@ -110,6 +131,7 @@ export const RouteUtils = {
     getUrl,
     getUrlFromPath,
     isAbsoluteUrl,
+    queryStringToObject,
     replacePathParams,
 };