expensify-common 1.0.1 → 2.0.2

package/dist/Cookie.d.ts

@@ -0,0 +1,68 @@
+declare namespace _default {
+    export let NAME_LAST_PAGE: string;
+    export let NAME_LAST_REPORTS_PAGE: string;
+    export let NAME_STASHED_SUPPORT: string;
+    export let NAME_WEB_COOKIE: string;
+    export let NAME_EXPENSES_VIEW_MODE: string;
+    export let MOBILE_APP_VERSION: string;
+    export let TWO_FACTOR_DEVICE_TOKEN: string;
+    export { enabled };
+    export { remove };
+    export { get };
+    export { getJSON };
+    export { has };
+    export { getHelpLink };
+    export { set };
+}
+export default _default;
+/**
+ * Detects if cookies are currently enabled in the browser
+ * by trying to create a cookie, see if it exists, and delete it afterwards again.
+ *
+ * @return {Boolean} True if cookies are enabled, otherwise false.
+ */
+declare function enabled(): boolean;
+/**
+ * Deletes a cookie.
+ *
+ * @param {String} name The name of the cookie to delete.
+ */
+declare function remove(name: string): void;
+/**
+ * Fetches the value of a cookie.
+ *
+ * @param  {String} name The name of the cookie to fetch.
+ * @return {String|null} The value of the cookie.
+ */
+declare function get(name: string): string | null;
+/**
+ * Parses a cookie value to JSON.
+ * Returns a default value specified by param or null.
+ *
+ * @param {String} name
+ * @param {Any|null} defaultValue
+ *
+ * @return {Any|null}
+ */
+declare function getJSON(name: string, defaultValue?: Any | null): Any | null;
+/**
+ * Find a cookie that has been set.
+ *
+ * @param {String} name Name of the cookie to find
+ * @return {Boolean} Whether or not the cookie is set
+ */
+declare function has(name: string): boolean;
+/**
+ * Returns help link when cookies are enabled or null.
+ *
+ * @return {(String|null)}
+ */
+declare function getHelpLink(): (string | null);
+/**
+ * Sets the value of a cookie and when it will expire.
+ *
+ * @param {String} name The name of the cookie.
+ * @param {String} value The value of the cookie.
+ * @param {Number} [expiredays] The number of days until the cookie expires.
+ */
+declare function set(name: string, value: string, expiredays?: number | undefined): void;

package/{lib/Cookie.jsx → dist/Cookie.js}

@@ -1,42 +1,39 @@
-import BrowserDetect from './BrowserDetect';
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BrowserDetect_1 = __importDefault(require("./BrowserDetect"));
 const CONST = {
     /**
      * Cookie storing the the name of the page we visited the last time
      */
     NAME_LAST_PAGE: 'lastPage',
-
     /**
      * Cookie storing the name of the reports page we visited the last time (e.g. reports, inbox)
      */
     NAME_LAST_REPORTS_PAGE: 'lastReportsPage',
-
     /**
      * Cookie storing a user's restricted-access support token
      */
     NAME_STASHED_SUPPORT: '_stashedSupportLogin',
-
     /**
      * Cookie set by expensify web that's used to identify a request as coming from web.
      */
     NAME_WEB_COOKIE: 'expensifyWeb',
-
     /**
      * Cookie storing the mode the user wants to use when viewing the expenses page.
      */
     NAME_EXPENSES_VIEW_MODE: 'expensesPageViewMode',
-
     /**
      * Cookie set that denotes a mobile request
      */
     MOBILE_APP_VERSION: 'appversion',
-
     /**
      * Two-Factor Auth device token
      */
     TWO_FACTOR_DEVICE_TOKEN: 'stashedTwoFactorLogin',
 };
-
 /**
  * Deletes a cookie.
  *
@@ -46,7 +43,6 @@ function remove(name) {
     const date = new Date();
     document.cookie = `${name}=; expires=${date.toUTCString()}`;
 }
-
 /**
  * Sets the value of a cookie and when it will expire.
  *
@@ -58,10 +54,8 @@ function set(name, value, expiredays) {
     // Get expiry date, set
     const exdate = new Date();
     exdate.setDate(exdate.getDate() + expiredays);
-    document.cookie = `${name}=${encodeURIComponent(value)}`
-        + `${((expiredays === null) ? '' : `;expires=${exdate.toUTCString()}`)}`;
+    document.cookie = `${name}=${encodeURIComponent(value)}${expiredays === null ? '' : `;expires=${exdate.toUTCString()}`}`;
 }
-
 /**
  * Detects if cookies are currently enabled in the browser
  * by trying to create a cookie, see if it exists, and delete it afterwards again.
@@ -79,7 +73,6 @@ function enabled() {
     }
     return result;
 }
-
 /**
  * Fetches the value of a cookie.
  *
@@ -87,7 +80,7 @@ function enabled() {
  * @return {String|null} The value of the cookie.
  */
 function get(name) {
-    if (!name || (document.cookie.length <= 0)) {
+    if (!name || document.cookie.length <= 0) {
         return null;
     }
     let start;
@@ -103,8 +96,6 @@ function get(name) {
     }
     return null;
 }
-
-
 /**
  * Parses a cookie value to JSON.
  * Returns a default value specified by param or null.
@@ -116,16 +107,14 @@ function get(name) {
  */
 function getJSON(name, defaultValue = null) {
     let data;
-
     try {
         data = JSON.parse(get(name));
-    } catch (err) {
+    }
+    catch (err) {
         data = defaultValue;
     }
-
     return data;
 }
-
 /**
  * Find a cookie that has been set.
  *
@@ -135,7 +124,6 @@ function getJSON(name, defaultValue = null) {
 function has(name) {
     return get(name) !== null;
 }
-
 /**
  * Returns help link when cookies are enabled or null.
  *
@@ -145,33 +133,32 @@ function getHelpLink() {
     if (enabled()) {
         return null;
     }
-
     let helpLink = 'http://www.google.com/search?q=enable+cookies';
-
     // Set up help link according to browser
-    if (BrowserDetect.browser === BrowserDetect.BROWSERS.EXPLORER) {
+    if (BrowserDetect_1.default.browser === BrowserDetect_1.default.BROWSERS.EXPLORER) {
         helpLink = 'https://support.microsoft.com/en-us/help/17442/windows-internet-explorer-delete-manage-cookies';
-    } else if (BrowserDetect.browser === BrowserDetect.BROWSERS.SAFARI) {
+    }
+    else if (BrowserDetect_1.default.browser === BrowserDetect_1.default.BROWSERS.SAFARI) {
         helpLink = 'https://support.apple.com/guide/safari/manage-cookies-and-website-data-sfri11471/mac';
-    } else if (BrowserDetect.browser === BrowserDetect.BROWSERS.MOZILLA) {
+    }
+    else if (BrowserDetect_1.default.browser === BrowserDetect_1.default.BROWSERS.MOZILLA) {
         helpLink = 'http://support.mozilla.com/en-US/kb/Enabling%20and%20disabling%20cookies';
-    } else if (BrowserDetect.browser === BrowserDetect.BROWSERS.OPERA) {
+    }
+    else if (BrowserDetect_1.default.browser === BrowserDetect_1.default.BROWSERS.OPERA) {
         helpLink = 'http://www.opera.com/help/tutorials/security/privacy/';
-    } else if (BrowserDetect.browser === BrowserDetect.BROWSERS.CHROME) {
+    }
+    else if (BrowserDetect_1.default.browser === BrowserDetect_1.default.BROWSERS.CHROME) {
         helpLink = 'http://www.google.com/support/chrome/bin/answer.py?answer=95647';
-    } else if (BrowserDetect.browser === BrowserDetect.BROWSERS.EDGE) {
+    }
+    else if (BrowserDetect_1.default.browser === BrowserDetect_1.default.BROWSERS.EDGE) {
         helpLink = 'https://privacy.microsoft.com/en-us/windows-10-microsoft-edge-and-privacy';
     }
     return helpLink;
 }
-
-export default {
-    enabled,
+exports.default = Object.assign({ enabled,
     remove,
     get,
     getJSON,
     has,
     getHelpLink,
-    set,
-    ...CONST
-};
+    set }, CONST);

package/dist/CredentialsWrapper.d.ts

@@ -0,0 +1,32 @@
+export default CredentialWrapper;
+declare namespace CredentialWrapper {
+    /**
+     * @returns {Promise} Promise resolves to an object containing partnerUserID and partnerUserSecret
+     */
+    function getCredentials(): Promise<any>;
+    /**
+     * @returns {Object} Object contains randomly generated partnerUserID and partnerUserSecret
+     */
+    function generateCredentials(): Object;
+    /**
+     * @param {Object} credentials
+     * @param {String} credentials.partnerUserID
+     * @param {String} credentials.partnerUserSecret
+     *
+     * @returns {Promise} Promise resolves to an object containing partnerUserID and partnerUserSecret
+     */
+    function setCredentials(credentials: {
+        partnerUserID: string;
+        partnerUserSecret: string;
+    }): Promise<any>;
+    /**
+     * @returns {Promise}
+     */
+    function clearCredentials(): Promise<any>;
+}
+export namespace LOGIN_PARTNER_DETAILS {
+    let CREDENTIALS_KEY: string;
+    let EXPENSIFY_PARTNER_PREFIX: string;
+    let PARTNER_NAME: string;
+    let PARTNER_PASSWORD: string;
+}

package/dist/CredentialsWrapper.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOGIN_PARTNER_DETAILS = void 0;
+const localforage_1 = __importDefault(require("localforage"));
+const LOGIN_PARTNER_DETAILS = {
+    CREDENTIALS_KEY: 'DEVICE_SESSION_CREDENTIALS',
+    EXPENSIFY_PARTNER_PREFIX: 'expensify.',
+    PARTNER_NAME: 'chat-expensify-com',
+    PARTNER_PASSWORD: 'e21965746fd75f82bb66',
+};
+exports.LOGIN_PARTNER_DETAILS = LOGIN_PARTNER_DETAILS;
+const CredentialWrapper = {
+    /**
+     * @returns {Promise} Promise resolves to an object containing partnerUserID and partnerUserSecret
+     */
+    getCredentials() {
+        return localforage_1.default.getItem(LOGIN_PARTNER_DETAILS.CREDENTIALS_KEY);
+    },
+    /**
+     * @returns {Object} Object contains randomly generated partnerUserID and partnerUserSecret
+     */
+    generateCredentials() {
+        return {
+            partnerUserID: LOGIN_PARTNER_DETAILS.EXPENSIFY_PARTNER_PREFIX + crypto.randomUUID(),
+            partnerUserSecret: crypto.randomUUID(),
+        };
+    },
+    /**
+     * @param {Object} credentials
+     * @param {String} credentials.partnerUserID
+     * @param {String} credentials.partnerUserSecret
+     *
+     * @returns {Promise} Promise resolves to an object containing partnerUserID and partnerUserSecret
+     */
+    setCredentials(credentials) {
+        if (!credentials.partnerUserID || !credentials.partnerUserSecret) {
+            // eslint-disable-next-line prefer-promise-reject-errors
+            return Promise.reject('Invalid credential pair');
+        }
+        return localforage_1.default.setItem(LOGIN_PARTNER_DETAILS.CREDENTIALS_KEY, credentials);
+    },
+    /**
+     * @returns {Promise}
+     */
+    clearCredentials() {
+        return localforage_1.default.removeItem(LOGIN_PARTNER_DETAILS.CREDENTIALS_KEY);
+    },
+};
+exports.default = CredentialWrapper;

package/dist/Device.d.ts

@@ -0,0 +1,8 @@
+type DeviceInfo = {
+    os: string | undefined;
+    osVersion: string | undefined;
+    deviceName: string | undefined;
+    deviceVersion: string | undefined;
+};
+declare function getOSAndName(): DeviceInfo;
+export { getOSAndName, };

package/dist/Device.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOSAndName = void 0;
+const ua_parser_js_1 = require("ua-parser-js");
+function getOSAndName() {
+    const parser = new ua_parser_js_1.UAParser();
+    const result = parser.getResult();
+    return {
+        os: result.os.name,
+        osVersion: result.os.version,
+        deviceName: result.browser.name,
+        deviceVersion: result.browser.version,
+    };
+}
+exports.getOSAndName = getOSAndName;

package/dist/ExpenseRule.d.ts

@@ -0,0 +1,39 @@
+export default class ExpenseRule {
+    /**
+     * Creates a new instance of this class.
+     *
+     * @param {Array} ruleArray
+     */
+    constructor(ruleArray: any[]);
+    /**
+     * Returns the applyWhen array associated with the passed field
+     * i.e. field == category returns [field: 'category', condition: 'matches', value: 'car']
+     *
+     * @param {string} field
+     *
+     * @return {Object}
+     */
+    getApplyWhenByField(field: string): Object;
+    /**
+     * Get the externalID saved deep in the tax field
+     *
+     * @returns {String}
+     */
+    getExternalTaxID(): string;
+    /**
+     * Checks if the passed expense matches this expense rule
+     *
+     * @param {SExpense3} expense
+     * @returns {boolean}
+     */
+    isMatch(expense: SExpense3): boolean;
+    /**
+     * Checks the passed value against the actual based on what the condition (matches, greater, less than, etc.)
+     *
+     * @param {string} condition
+     * @param {Mixed} ruleValue
+     * @param {Mixed} transactionValue
+     * @returns {boolean}
+     */
+    checkCondition(condition: string, ruleValue: Mixed, transactionValue: Mixed): boolean;
+}

package/{lib/ExpenseRule.jsx → dist/ExpenseRule.js}

@@ -1,17 +1,20 @@
-import _ from 'underscore';
-
-export default class ExpenseRule {
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const underscore_1 = __importDefault(require("underscore"));
+class ExpenseRule {
     /**
      * Creates a new instance of this class.
      *
      * @param {Array} ruleArray
      */
     constructor(ruleArray) {
-        _.each(ruleArray, (value, key) => {
+        underscore_1.default.each(ruleArray, (value, key) => {
             this[key] = value;
         });
     }
-
     /**
      * Returns the applyWhen array associated with the passed field
      * i.e. field == category returns [field: 'category', condition: 'matches', value: 'car']
@@ -21,11 +24,8 @@ export default class ExpenseRule {
      * @return {Object}
      */
     getApplyWhenByField(field) {
-        return _.find(this.applyWhen, (conditions) => {
-            return conditions.field === field;
-        }) || {};
+        return underscore_1.default.find(this.applyWhen, (conditions) => conditions.field === field) || {};
     }
-
     /**
      * Get the externalID saved deep in the tax field
      *
@@ -34,7 +34,6 @@ export default class ExpenseRule {
     getExternalTaxID() {
         return this.tax.field_id_TAX.externalID || '';
     }
-
     /**
      * Checks if the passed expense matches this expense rule
      *
@@ -43,7 +42,7 @@ export default class ExpenseRule {
      */
     isMatch(expense) {
         let isMatch = true;
-        _.each(this.applyWhen, (conditions) => {
+        underscore_1.default.each(this.applyWhen, (conditions) => {
             switch (conditions.field) {
                 case 'category':
                     if (!this.checkCondition(conditions.condition, conditions.value, expense.getCategory())) {
@@ -54,10 +53,8 @@ export default class ExpenseRule {
                     break;
             }
         });
-
         return isMatch;
     }
-
     /**
      * Checks the passed value against the actual based on what the condition (matches, greater, less than, etc.)
      *
@@ -75,4 +72,5 @@ export default class ExpenseRule {
                 return false;
         }
     }
-};
+}
+exports.default = ExpenseRule;

package/dist/ExpensiMark.d.ts

@@ -0,0 +1,142 @@
+declare type Replacement = (...args: string[], extras?: ExtrasObject) => string;
+declare type Name =
+    | 'codeFence'
+    | 'inlineCodeBlock'
+    | 'email'
+    | 'link'
+    | 'hereMentions'
+    | 'userMentions'
+    | 'reportMentions'
+    | 'autoEmail'
+    | 'autolink'
+    | 'quote'
+    | 'italic'
+    | 'bold'
+    | 'strikethrough'
+    | 'heading1'
+    | 'newline'
+    | 'replacepre'
+    | 'listItem'
+    | 'exclude'
+    | 'anchor'
+    | 'breakline'
+    | 'blockquoteWrapHeadingOpen'
+    | 'blockquoteWrapHeadingClose'
+    | 'blockElementOpen'
+    | 'blockElementClose'
+    | 'stripTag';
+declare type Rule = {
+    name: Name;
+    process?: (textToProcess: string, replacement: Replacement) => string;
+    regex?: RegExp;
+    replacement: Replacement | string;
+    pre?: (input: string) => string;
+    post?: (input: string) => string;
+};
+
+declare type ExtrasObject = {
+    reportIdToName?: Record<string, string>;
+    accountIDToName?: Record<string, string>;
+};
+export default class ExpensiMark {
+    rules: Rule[];
+    htmlToMarkdownRules: Rule[];
+    htmlToTextRules: Rule[];
+    constructor();
+    /**
+     * Replaces markdown with html elements
+     *
+     * @param text - Text to parse as markdown
+     * @param options - Options to customize the markdown parser
+     * @param options.filterRules=[] - An array of name of rules as defined in this class.
+     * If not provided, all available rules will be applied. If provided, only the rules in the array will be applied.
+     * @param options.disabledRules=[] - An array of name of rules as defined in this class.
+     * If not provided, all available rules will be applied. If provided, the rules in the array will be skipped.
+     * @param options.shouldEscapeText=true - Whether or not the text should be escaped
+     * @param options.shouldKeepRawInput=false - Whether or not the raw input should be kept and returned
+     */
+    replace(
+        text: string,
+        {
+            filterRules,
+            shouldEscapeText,
+            shouldKeepRawInput,
+        }?: {
+            filterRules?: Name[];
+            disabledRules?: Name[];
+            shouldEscapeText?: boolean;
+            shouldKeepRawInput?: boolean;
+        },
+    ): string;
+    /**
+     * Checks matched URLs for validity and replace valid links with html elements
+     *
+     * @param regex
+     * @param textToCheck
+     * @param replacement
+     */
+    modifyTextForUrlLinks(regex: RegExp, textToCheck: string, replacement: Replacement): string;
+    /**
+     * Checks matched Emails for validity and replace valid links with html elements
+     *
+     * @param regex
+     * @param textToCheck
+     * @param replacement
+     */
+    modifyTextForEmailLinks(regex: RegExp, textToCheck: string, replacement: Replacement): string;
+    /**
+     * replace block element with '\n' if :
+     * 1. We have text within the element.
+     * 2. The text does not end with a new line.
+     * 3. The text does not have quote mark '>' .
+     * 4. It's not the last element in the string.
+     *
+     * @param htmlString
+     */
+    replaceBlockElementWithNewLine(htmlString: string): string;
+    /**
+     * Replaces HTML with markdown
+     *
+     * @param htmlString
+     * @param extras
+     */
+    htmlToMarkdown(htmlString: string, extras?: ExtrasObject): string;
+    /**
+     * Convert HTML to text
+     *
+     * @param htmlString
+     * @param extras
+     */
+    htmlToText(htmlString: string, extras?: ExtrasObject): string;
+    /**
+     * Modify text for Quotes replacing chevrons with html elements
+     *
+     * @param regex
+     * @param textToCheck
+     * @param replacement
+     */
+    modifyTextForQuote(regex: RegExp, textToCheck: string, replacement: Replacement): string;
+    /**
+     * Format the content of blockquote if the text matches the regex or else just return the original text
+     *
+     * @param regex
+     * @param textToCheck
+     * @param replacement
+     */
+    formatTextForQuote(regex: RegExp, textToCheck: string, replacement: Replacement): string;
+    /**
+     * Check if the input text includes only the open or the close tag of an element.
+     *
+     * @param textToCheck - Text to check
+     */
+    containsNonPairTag(textToCheck: string): boolean;
+    extractLinksInMarkdownComment(comment: string): string[] | undefined;
+    /**
+     * Compares two markdown comments and returns a list of the links removed in a new comment.
+     *
+     * @param oldComment
+     * @param newComment
+     */
+    getRemovedMarkdownLinks(oldComment: string, newComment: string): string[];
+}
+export {};