@capsitech/react-utilities 0.1.2

package/lib/Utilities/MTDFraudPrevention.js

@@ -0,0 +1,157 @@
+import { getScreenColourDepth, getScreenHeight, getScreenScalingFactor, getScreenWidth, getTimezone, getWindowHeight, getWindowWidth } from './BrowserInfo';
+/**
+ * Enum object of keys for each header in the Map returned by getFraudPreventionHeaders().headers
+ */
+export const fraudPreventionHeadersEnum = {
+    TIMEZONE: 'Gov-Client-Timezone',
+    SCREENS_DETAILS: 'Gov-Client-Screens',
+    WINDOW_SIZE: 'Gov-Client-Window-Size',
+    //BROWSER_PLUGINS: 'Gov-Client-Browser-Plugins',
+    //BROWSER_DONOTTRACK: 'Gov-Client-Browser-Do-Not-Track',
+    //DEVICE_LOCAL_IPS: 'Gov-Client-Local-IPs',
+    //DEVICE_LOCAL_IPS_TIMESTAMP: 'Gov-Client-Local-IPs-Timestamp',
+    //DEVICE_ID: 'Gov-Client-Device-ID',
+    //BROWSER_USER_AGENT: 'Gov-Client-Browser-JS-User-Agent',
+};
+const getScreenData = () => {
+    const screenDetails = `width=${getScreenWidth()}&height=${getScreenHeight()}&scaling-factor=${getScreenScalingFactor()}&colour-depth=${getScreenColourDepth()}`;
+    return encodeURI(screenDetails);
+};
+export const getScreenDetails = () => {
+    return {
+        width: getScreenWidth(),
+        height: getScreenHeight(),
+        colorDepth: getScreenColourDepth(),
+        scalingFactor: getScreenScalingFactor(),
+    };
+};
+const getWindowSize = () => {
+    const windowSize = `width=${getWindowWidth()}&height=${getWindowHeight()}`;
+    return encodeURI(windowSize);
+};
+export const windowDetails = () => {
+    return {
+        width: getWindowWidth(),
+        height: getWindowHeight(),
+    };
+};
+/**
+ * Returns Map of HMRC Fraud prevention headers.
+ * @returns {Promise<IHeaderValues>} with two fields headers and errors - The headers are a Map object and the errors are an array. If there are no errors, the array is empty
+ */
+export const getFraudPreventionHeaders = async () => {
+    const headers = {};
+    const errors = [];
+    const headerFunctions = [
+        { header: fraudPreventionHeadersEnum.TIMEZONE, callback: getTimezone },
+        {
+            header: fraudPreventionHeadersEnum.SCREENS_DETAILS,
+            callback: getScreenData,
+        },
+        { header: fraudPreventionHeadersEnum.WINDOW_SIZE, callback: getWindowSize },
+        // {
+        //   header: fraudPreventionHeadersEnum.BROWSER_PLUGINS,
+        //   callback: () => encodeURI(getBrowserPluginsAsString()),
+        // },
+        // {
+        //   header: fraudPreventionHeadersEnum.BROWSER_DONOTTRACK,
+        //   callback: getBrowserDoNotTrackStatus,
+        // },
+        //{ header: fraudPreventionHeadersEnum.DEVICE_ID, callback: generateClientDeviceID},
+        //{ header: fraudPreventionHeadersEnum.BROWSER_USER_AGENT, callback: getUserAgent },
+    ];
+    for (let i = 0; i < headerFunctions.length; i++) {
+        try {
+            const { header, callback } = headerFunctions[i];
+            headers[header] = callback();
+        }
+        catch (error) {
+            errors.push({ header: headerFunctions[i], error });
+        }
+    }
+    // try {
+    //   const ipAddress = await getDeviceLocalIPAsString();
+    //   headers[fraudPreventionHeadersEnum.DEVICE_LOCAL_IPS] = encodeURI(ipAddress.deviceIpString);
+    //   headers[fraudPreventionHeadersEnum.DEVICE_LOCAL_IPS_TIMESTAMP] = ipAddress.deviceIpTimeStamp;
+    // } catch (error) {
+    //   errors.push({ header: 'IPs', error });
+    // }
+    return { headers, errors };
+};
+// /**
+//  * Returns "Gov-Client-Browser-JS-User-Agent" header.
+//  * @returns {IHeaderValue} which has headerValue key having the value of the header or error key if there is an error
+//  */
+// export const getGovClientBrowserJSUserAgentHeader = (): IHeaderValue => {
+//   try {
+//     return { headerValue: getUserAgent() };
+//   } catch (error) {
+//     return { error };
+//   }
+// };
+// /**
+//  * Returns the value for Gov-Client-Browser-Plugins HMRC Fraud prevention header.
+//  */
+// export const getGovClientBrowserPluginsHeader = (): IHeaderValue => {
+//   try {
+//     return { headerValue: encodeURI(getBrowserPluginsAsString()) };
+//   } catch (error) {
+//     return { error };
+//   }
+// };
+// /**
+//  * Returns the value for Gov-Client-Browser-Do-Not-Track HMRC Fraud prevention header.
+//  */
+// export const getGovClientBrowserDoNotTrackHeader = (): IHeaderValue => {
+//   try {
+//     return { headerValue: getBrowserDoNotTrackStatus() };
+//   } catch (error) {
+//     return { error };
+//   }
+// };
+// /**
+//  * Returns the value for Gov-Client-Timezone HMRC Fraud prevention header.
+//  * @returns {IHeaderValue} with headerValue field or error field in case of an exception
+//  */
+// export const getGovClientTimezoneHeader = (): IHeaderValue => {
+//   try {
+//     return { headerValue: getTimezone() };
+//   } catch (error) {
+//     return { error };
+//   }
+// };
+// /**
+//  * Returns Gov-Client-Local-IPs header value
+//  * @returns {Promise<IHeaderValue>} which has header key having the value of the header or error key if there is an error
+//  */
+// export const getGovClientLocalIPsHeader = async (): Promise<IHeaderValue> => {
+//   try {
+//     const ipAddress = await getDeviceLocalIPAsString();
+//     return {
+//       headerValue: encodeURI(ipAddress.deviceIpString),
+//     };
+//   } catch (error) {
+//     return { error };
+//   }
+// };
+// /**
+//  * Returns the value for Gov-Client-Window-Size HMRC Fraud prevention header.
+//  */
+// export const getGovClientWindowSizeHeader = () => {
+//   try {
+//     return { headerValue: getWindowSize() };
+//   } catch (error) {
+//     return { error };
+//   }
+// };
+// /**
+//  * Returns the value for Gov-Client-Screens HMRC Fraud prevention header.
+//  * @returns {object} with headerValue key having the value of the header or error key if there is an error
+//  */
+// export const getGovClientScreensHeader = () => {
+//   try {
+//     return { headerValue: getScreenData() };
+//   } catch (error) {
+//     return { error };
+//   }
+// };

package/lib/Utilities/Nationalities.d.ts

@@ -0,0 +1,5 @@
+export declare const AllNationalities: string[];
+export declare function getNationalityOptions(): {
+    key: string;
+    text: string;
+}[];

package/lib/Utilities/Nationalities.js

@@ -0,0 +1,245 @@
+export const AllNationalities = [
+    'Afghan',
+    'Albanian',
+    'Algerian',
+    'American Samoan',
+    'Andorran',
+    'Angolan',
+    'Anguillan',
+    'Antarctic',
+    'Antiguan or Barbudan',
+    'Argentine',
+    'Armenian',
+    'Aruban',
+    'Australian',
+    'Austrian',
+    'Azerbaijani',
+    'Bahamian',
+    'Bahraini',
+    'Bangladeshi',
+    'Barbadian',
+    'Belarusian',
+    'Belgian',
+    'Belizean',
+    'Bermudian',
+    'Bhutanese',
+    'Bolivian',
+    'Bosnian or Herzegovinian',
+    'Botswanan',
+    'Brazilian',
+    'British Indian Ocean Territory',
+    'British Virgin Islander',
+    'Bruneian',
+    'Bulgarian',
+    'Burkinabe',
+    'Burundian',
+    'Cambodian',
+    'Cameroonian',
+    'Canadian',
+    'Cape Verdean',
+    'Caymanian',
+    'Central African',
+    'Beninese',
+    'Chadian',
+    'Chilean',
+    'Chinese',
+    'Cocos Islander',
+    'Colombian',
+    'Comoran',
+    'Cook Islander',
+    'Costa Rican',
+    'Croatian',
+    'Cuban',
+    'Curacaoan',
+    'Cypriot',
+    'Czech',
+    'Congolese',
+    'Danish',
+    'Djiboutian',
+    'Dominican (Note: Different from Dominican Republic)',
+    'Dominican',
+    'Timorese or East Timorese',
+    'Ecuadorian',
+    'Egyptian',
+    'Christmas Islander',
+    'Salvadoran',
+    'Equatorial Guinean',
+    'Eritrean',
+    'Ethiopian',
+    'Falkland Islander',
+    'Faroese',
+    'Fijian',
+    'Finnish',
+    'French',
+    'French Polynesian',
+    'Gabonese',
+    'Gambian',
+    'Georgian',
+    'German',
+    'Ghanaian',
+    'Gibraltarian',
+    'Greek',
+    'Greenlandic',
+    'Grenadian',
+    'Guamanian',
+    'Guatemalan',
+    'Estonian',
+    'Guernsey (or Channel Islander)',
+    'Guinean',
+    'Bissau-Guinean',
+    'Haitian',
+    'Honduran',
+    'Hong Konger',
+    'Hungarian',
+    'Icelander',
+    'Indian',
+    'Indonesian',
+    'Iranian',
+    'Iraqi',
+    'Irish',
+    'Manx',
+    'Israeli',
+    'Italian',
+    'Ivorian',
+    'Jamaican',
+    'Japanese',
+    'Jersey (or Channel Islander)',
+    'Jordanian',
+    'Guyanese',
+    'Kazakhstani',
+    'Kenyan',
+    'I-Kiribati',
+    'Kuwaiti',
+    'Kyrgyzstani',
+    'Lao or Laotian',
+    'Latvian',
+    'Lebanese',
+    'Basotho or Lesothan',
+    'Liberian',
+    'Libyan',
+    'Liechtensteiner',
+    'Lithuanian',
+    'Luxembourger',
+    'Macanese',
+    'Macedonian',
+    'Malagasy',
+    'Malawian',
+    'Malaysian',
+    'Maldivian',
+    'Malian',
+    'Kosovar',
+    'Maltese',
+    'Marshallese',
+    'Mauritanian',
+    'Mahoran or Mayotte',
+    'Mexican',
+    'Micronesian',
+    'Moldovan',
+    'Monégasque',
+    'Mongolian',
+    'Montenegrin',
+    'Montserratian',
+    'Moroccan',
+    'Mozambican',
+    'Burmese or Myanmarese',
+    'Namibian',
+    'Nauruan',
+    'Nepali or Nepalese',
+    'Dutch',
+    'Netherlands Antillean',
+    'New Caledonian',
+    'New Zealander',
+    'Mauritian',
+    'Nicaraguan',
+    'Nigerien',
+    'Nigerian',
+    'North Korean',
+    'Northern Marianan',
+    'Norwegian',
+    'Omani',
+    'Pakistani',
+    'Palauan',
+    'Palestinian',
+    'Panamanian',
+    'Papua New Guinean',
+    'Paraguayan',
+    'Peruvian',
+    'Filipino',
+    'Pitcairn Islander',
+    'Polish',
+    'Portuguese',
+    'Puerto Rican',
+    'Qatari',
+    'Congolese',
+    'Niuean',
+    'Réunionese or Réunionnais',
+    'Romanian',
+    'Russian',
+    'Barthélemois or Saint Barthélemy Islander',
+    'Saint Helenian',
+    'Kittitian or Nevisian',
+    'Saint Lucian',
+    'Saint-Martinoise',
+    'Saint-Pierrais or Miquelonnais',
+    'Vincentian or Vincy',
+    'Samoan',
+    'Sammarinese',
+    'São Toméan',
+    'Saudi or Saudi Arabian',
+    'Senegalese',
+    'Serbian',
+    'Seychellois',
+    'Sierra Leonean',
+    'Singaporean',
+    'Sint Maartener or Sint Maartian',
+    'Slovak',
+    'Rwandan',
+    'Slovenian',
+    'Solomon Islander',
+    'Somali',
+    'South Korean',
+    'South Sudanese',
+    'Spanish',
+    'Sri Lankan',
+    'Sudanese',
+    'Surinamese',
+    'Svalbardian or Jan Mayenian',
+    'Swazi',
+    'Swedish',
+    'Swiss',
+    'Syrian',
+    'Taiwanese',
+    'Tajikistani',
+    'Tanzanian',
+    'Thai',
+    'Togolese',
+    'Tokelauan',
+    'Tongan',
+    'South African',
+    'Trinidadian or Tobagonian',
+    'Tunisian',
+    'Turkish',
+    'Turks and Caicos Islander',
+    'Tuvaluan',
+    'Virgin Islander',
+    'Ugandan',
+    'Ukrainian',
+    'Emirati or Emirian',
+    'British',
+    'American',
+    'Uruguayan',
+    'Uzbekistani',
+    'Vanuatuan',
+    'Vatican (or Vatican City)',
+    'Venezuelan',
+    'Vietnamese',
+    'Wallisian or Futunan',
+    'Sahrawi',
+    'Turkmen',
+    'Zambian',
+    'Zimbabwean',
+    'Yemeni',
+];
+export function getNationalityOptions() {
+    return AllNationalities.map((v) => ({ key: v, text: v }));
+}

package/lib/Utilities/RouteUtils.d.ts

@@ -0,0 +1,120 @@
+import React from "react";
+import { RouteProps } from "react-router-dom";
+export declare enum FeatureStatus {
+    placeholder = 0,
+    alpha = 1,
+    beta = 2,
+    release = 3
+}
+export interface IRouteProps extends RouteProps {
+    name?: string;
+    path?: string;
+    url?: string;
+    key?: string | number;
+    icon?: string;
+    isCategory?: boolean;
+    children?: React.ReactNode;
+    /**
+     * The component to render for this route's content (or a loading placeholder if `getComponent` is provided).
+     */
+    component?: any;
+    /**
+     * Function that loads the component asynchronously.
+     * Notify when loading has finished using `cb`.
+     * If `component` is provided, it will be rendered while waiting for the callback.
+     */
+    getComponent?: (cb: (component: any) => void) => void;
+    /**
+     * User roles to check for route rendering
+     */
+    roles?: string[];
+    /**
+     * Practice features to check for route rendering
+     */
+    features?: number[];
+    /**
+     * Business types to check for route rendering
+     */
+    businessTypes?: number[];
+    /**
+     * User config/tags to check for route rendering
+     */
+    userConfig?: string[];
+    /**
+     * User params to check for route rendering
+     */
+    userParams?: string[];
+    /**
+     * Other tags to check for route rendering
+     */
+    tags?: string[];
+    /**
+     * Sub/inner links
+     */
+    links?: IRouteProps[];
+    /**
+     * Other URL to show this link as active
+     */
+    activeUrl?: string;
+    /**
+     * Other URLs to show this link as active
+     */
+    activeUrls?: string[];
+    /**
+     * Default expanded or collapsed
+     */
+    isExpanded?: boolean;
+    /**
+     * Feature status (to show bedge on link)
+     */
+    status?: FeatureStatus;
+}
+export interface IRouteGroupProps {
+    /**
+     * Links to render within this group
+     */
+    links: IRouteProps[];
+    /**
+     * User roles to check for route rendering
+     */
+    roles?: string[];
+    /**
+     * Practice features to check for route rendering
+     */
+    features?: number[];
+    /**
+     * User config/tags to check for route rendering
+     */
+    userConfig?: string[];
+    /**
+     * Other tags to check for route rendering
+     */
+    tags?: string[];
+    /**
+     * Other URL to show this link as active
+     */
+    activeUrls?: string[];
+    /**
+     * Default expanded or collapsed
+     */
+    isExpanded?: boolean;
+}
+declare class RouteUtilsBase {
+    private hasValidRole;
+    private hasValidFeatures;
+    private hasValidBusinessType;
+    private hasValidUserConfig;
+    private hasValidUserParam;
+    private hasValidTags;
+    private isValidLink;
+    private getPath;
+    getRoutesFromGroups: (groups: IRouteGroupProps[], SecureRoute: any, roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
+    getRoutesFromGroup: (links: IRouteProps[], SecureRoute: any, roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
+    getLinksFromGroups: (links: IRouteGroupProps[], roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteGroupProps[];
+    getLinksFromGroup: (links: IRouteProps[], roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteProps[];
+    getRoutesFromLinks: (links: IRouteProps[], SecureRoute: any, roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
+    getLinksFromLinks: (links: IRouteProps[], roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteProps[];
+    getSelectedNavKey: (pagesGroup: IRouteGroupProps[], currentPath: string) => string | number | undefined;
+}
+export declare const RouteUtils: RouteUtilsBase;
+export {};