Merge pull request #11 from wintondeshong/master

Frontend localization actors

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,140 @@
+const Rfc4646LanguageCodes = {
+    AF_ZA: "af-ZA", // Afrikaans - South Africa
+    SQ_AL: "sq-AL", // Albanian - Albania
+    AR_DZ: "ar-DZ", // Arabic - Algeria
+    AR_BH: "ar-BH", // Arabic - Bahrain
+    AR_EG: "ar-EG", // Arabic - Egypt
+    AR_IQ: "ar-IQ", // Arabic - Iraq
+    AR_JO: "ar-JO", // Arabic - Jordan
+    AR_KW: "ar-KW", // Arabic - Kuwait
+    AR_LB: "ar-LB", // Arabic - Lebanon
+    AR_LY: "ar-LY", // Arabic - Libya
+    AR_MA: "ar-MA", // Arabic - Morocco
+    AR_OM: "ar-OM", // Arabic - Oman
+    AR_QA: "ar-QA", // Arabic - Qatar
+    AR_SA: "ar-SA", // Arabic - Saudi Arabia
+    AR_SY: "ar-SY", // Arabic - Syria
+    AR_TN: "ar-TN", // Arabic - Tunisia
+    AR_AE: "ar-AE", // Arabic - United Arab Emirates
+    AR_YE: "ar-YE", // Arabic - Yemen
+    HY_AM: "hy-AM", // Armenian - Armenia
+    CY_AZ_AZ: "Cy-az-AZ", // Azeri (Cyrillic) - Azerbaijan
+    LT_AZ_AZ: "Lt-az-AZ", // Azeri (Latin) - Azerbaijan
+    EU_ES: "eu-ES", // Basque - Basque
+    BE_BY: "be-BY", // Belarusian - Belarus
+    BG_BG: "bg-BG", // Bulgarian - Bulgaria
+    CA_ES: "ca-ES", // Catalan - Catalan
+    ZH_CN: "zh-CN", // Chinese - China
+    ZH_HK: "zh-HK", // Chinese - Hong Kong SAR
+    ZH_MO: "zh-MO", // Chinese - Macau SAR
+    ZH_SG: "zh-SG", // Chinese - Singapore
+    ZH_TW: "zh-TW", // Chinese - Taiwan
+    ZH_CHS: "zh-CHS", // Chinese (Simplified)
+    ZH_CHT: "zh-CHT", // Chinese (Traditional)
+    HR_HR: "hr-HR", // Croatian - Croatia
+    CS_CZ: "cs-CZ", // Czech - Czech Republic
+    DA_DK: "da-DK", // Danish - Denmark
+    DIV_MV: "div-MV", // Dhivehi - Maldives
+    NL_BE: "nl-BE", // Dutch - Belgium
+    NL_NL: "nl-NL", // Dutch - The Netherlands
+    EN_AU: "en-AU", // English - Australia
+    EN_BZ: "en-BZ", // English - Belize
+    EN_CA: "en-CA", // English - Canada
+    EN_CB: "en-CB", // English - Caribbean
+    EN_IE: "en-IE", // English - Ireland
+    EN_JM: "en-JM", // English - Jamaica
+    EN_NZ: "en-NZ", // English - New Zealand
+    EN_PH: "en-PH", // English - Philippines
+    EN_ZA: "en-ZA", // English - South Africa
+    EN_TT: "en-TT", // English - Trinidad and Tobago
+    EN_GB: "en-GB", // English - United Kingdom
+    EN_US: "en-US", // English - United States
+    EN_ZW: "en-ZW", // English - Zimbabwe
+    ET_EE: "et-EE", // Estonian - Estonia
+    FO_FO: "fo-FO", // Faroese - Faroe Islands
+    FA_IR: "fa-IR", // Farsi - Iran
+    FI_FI: "fi-FI", // Finnish - Finland
+    FR_BE: "fr-BE", // French - Belgium
+    FR_CA: "fr-CA", // French - Canada
+    FR_FR: "fr-FR", // French - France
+    FR_LU: "fr-LU", // French - Luxembourg
+    FR_MC: "fr-MC", // French - Monaco
+    FR_CH: "fr-CH", // French - Switzerland
+    GL_ES: "gl-ES", // Galician - Galician
+    KA_GE: "ka-GE", // Georgian - Georgia
+    DE_AT: "de-AT", // German - Austria
+    DE_DE: "de-DE", // German - Germany
+    DE_LI: "de-LI", // German - Liechtenstein
+    DE_LU: "de-LU", // German - Luxembourg
+    DE_CH: "de-CH", // German - Switzerland
+    EL_GR: "el-GR", // Greek - Greece
+    GU_IN: "gu-IN", // Gujarati - India
+    HE_IL: "he-IL", // Hebrew - Israel
+    HI_IN: "hi-IN", // Hindi - India
+    HU_HU: "hu-HU", // Hungarian - Hungary
+    IS_IS: "is-IS", // Icelandic - Iceland
+    ID_ID: "id-ID", // Indonesian - Indonesia
+    IT_IT: "it-IT", // Italian - Italy
+    IT_CH: "it-CH", // Italian - Switzerland
+    JA_JP: "ja-JP", // Japanese - Japan
+    KN_IN: "kn-IN", // Kannada - India
+    KK_KZ: "kk-KZ", // Kazakh - Kazakhstan
+    KOK_IN: "kok-IN", // Konkani - India
+    KO_KR: "ko-KR", // Korean - Korea
+    KY_KZ: "ky-KZ", // Kyrgyz - Kazakhstan
+    LV_LV: "lv-LV", // Latvian - Latvia
+    LT_LT: "lt-LT", // Lithuanian - Lithuania
+    MK_MK: "mk-MK", // Macedonian (FYROM)
+    MS_BN: "ms-BN", // Malay - Brunei
+    MS_MY: "ms-MY", // Malay - Malaysia
+    MR_IN: "mr-IN", // Marathi - India
+    MN_MN: "mn-MN", // Mongolian - Mongolia
+    NB_NO: "nb-NO", // Norwegian (Bokmål) - Norway
+    NN_NO: "nn-NO", // Norwegian (Nynorsk) - Norway
+    PL_PL: "pl-PL", // Polish - Poland
+    PT_BR: "pt-BR", // Portuguese - Brazil
+    PT_PT: "pt-PT", // Portuguese - Portugal
+    PA_IN: "pa-IN", // Punjabi - India
+    RO_RO: "ro-RO", // Romanian - Romania
+    RU_RU: "ru-RU", // Russian - Russia
+    SA_IN: "sa-IN", // Sanskrit - India
+    CY_SR_SP: "Cy-sr-SP", // Serbian (Cyrillic) - Serbia
+    LT_SR_SP: "Lt-sr-SP", // Serbian (Latin) - Serbia
+    SK_SK: "sk-SK", // Slovak - Slovakia
+    SL_SI: "sl-SI", // Slovenian - Slovenia
+    ES_AR: "es-AR", // Spanish - Argentina
+    ES_BO: "es-BO", // Spanish - Bolivia
+    ES_CL: "es-CL", // Spanish - Chile
+    ES_CO: "es-CO", // Spanish - Colombia
+    ES_CR: "es-CR", // Spanish - Costa Rica
+    ES_DO: "es-DO", // Spanish - Dominican Republic
+    ES_EC: "es-EC", // Spanish - Ecuador
+    ES_SV: "es-SV", // Spanish - El Salvador
+    ES_GT: "es-GT", // Spanish - Guatemala
+    ES_HN: "es-HN", // Spanish - Honduras
+    ES_MX: "es-MX", // Spanish - Mexico
+    ES_NI: "es-NI", // Spanish - Nicaragua
+    ES_PA: "es-PA", // Spanish - Panama
+    ES_PY: "es-PY", // Spanish - Paraguay
+    ES_PE: "es-PE", // Spanish - Peru
+    ES_PR: "es-PR", // Spanish - Puerto Rico
+    ES_ES: "es-ES", // Spanish - Spain
+    ES_UY: "es-UY", // Spanish - Uruguay
+    ES_VE: "es-VE", // Spanish - Venezuela
+    SW_KE: "sw-KE", // Swahili - Kenya
+    SV_FI: "sv-FI", // Swedish - Finland
+    SV_SE: "sv-SE", // Swedish - Sweden
+    SYR_SY: "syr-SY", // Syriac - Syria
+    TA_IN: "ta-IN", // Tamil - India
+    TT_RU: "tt-RU", // Tatar - Russia
+    TE_IN: "te-IN", // Telugu - India
+    TH_TH: "th-TH", // Thai - Thailand
+    TR_TR: "tr-TR", // Turkish - Turkey
+    UK_UA: "uk-UA", // Ukrainian - Ukraine
+    UR_PK: "ur-PK", // Urdu - Pakistan
+    CY_UZ_UZ: "Cy-uz-UZ", // Uzbek (Cyrillic) - Uzbekistan
+    LT_UZ_UZ: "Lt-uz-UZ", // Uzbek (Latin) - Uzbekistan
+    VI_VN: "vi-VN", // Vietnamese - Vietnam
+};
+
+export { Rfc4646LanguageCodes };

src/constants/rfc4646-language-codes.ts

@@ -2,60 +2,63 @@
 // #region Constants
 // -----------------------------------------------------------------------------------------
 
-export * from "./constants/video-resolutions";
+export { Rfc4646LanguageCodes } from "./constants/rfc4646-language-codes";
+export { VideoResolutions } from "./constants/video-resolutions";
 
 //#endregion Constants
 
 // -----------------------------------------------------------------------------------------
 // #region Enumerations
 // -----------------------------------------------------------------------------------------
 
-export * from "./enumerations/content-type";
-export * from "./enumerations/error-type";
-export * from "./enumerations/http-header";
-export * from "./enumerations/http-verb";
+export { ContentType } from "./enumerations/content-type";
+export { ErrorType } from "./enumerations/error-type";
+export { HttpHeader } from "./enumerations/http-header";
+export { HttpVerb } from "./enumerations/http-verb";
 
 //#endregion Enumerations
 
 // -----------------------------------------------------------------------------------------
 // #region Interfaces
 // -----------------------------------------------------------------------------------------
 
-export * from "./interfaces/key-value-pair";
-export * from "./interfaces/paged-result";
-export * from "./interfaces/result";
-export * from "./interfaces/result-error";
-export * from "./interfaces/service-response";
+export { Culture } from "./interfaces/culture";
+export { CultureParams } from "./interfaces/culture-params";
+export { KeyValuePair } from "./interfaces/key-value-pair";
+export { PagedResult } from "./interfaces/paged-result";
+export { Result } from "./interfaces/result";
+export { ResultError } from "./interfaces/result-error";
+export { ServiceResponse } from "./interfaces/service-response";
 
 //#endregion Interfaces
 
 // -----------------------------------------------------------------------------------------
 // #region Types
 // -----------------------------------------------------------------------------------------
 
-export * from "./types/cancellable-promise";
+export { CancellablePromise } from "./types/cancellable-promise";
 
 //#endregion Types
 
 // -----------------------------------------------------------------------------------------
 // #region Utilities
 // -----------------------------------------------------------------------------------------
 
-export * from "./utilities/collection-utils";
-export * from "./utilities/core-utils";
-export * from "./utilities/environment-utils";
-export * from "./utilities/promise-factory";
-export * from "./utilities/route-utils";
-export * from "./utilities/service-utils";
-export * from "./utilities/string-utils";
+export { CollectionUtils } from "./utilities/collection-utils";
+export { CoreUtils } from "./utilities/core-utils";
+export { EnvironmentUtils } from "./utilities/environment-utils";
+export { PromiseFactory } from "./utilities/promise-factory";
+export { RouteUtils } from "./utilities/route-utils";
+export { ServiceUtils } from "./utilities/service-utils";
+export { StringUtils } from "./utilities/string-utils";
 
 //#endregion Utilities
 
 // -----------------------------------------------------------------------------------------
 // #region View Models
 // -----------------------------------------------------------------------------------------
 
-export * from "./view-models/result-record";
-export * from "./view-models/result-error-record";
+export { ResultRecord } from "./view-models/result-record";
+export { ResultErrorRecord } from "./view-models/result-error-record";
 
 //#endregion View Models

src/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for digesting localization related culture information
+ */
+export 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 interface Culture<TResources> {
+    /**
+     * RFC-4646 language code
+     */
+    code: string;
+
+    /**
+     * Key/value pairs of translations
+     */
+    resources: TResources;
+}

src/interfaces/culture.ts

@@ -210,6 +210,77 @@ 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).toEqual({});
+            }
+        );
+
+        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
     // -----------------------------------------------------------------------------------------