@turnai/turn-shared 1.0.3

package/README.md

@@ -0,0 +1,536 @@
+# Turn Shared
+
+Library used to share code between mobile and web apps.
+
+## Getting Started
+
+This package depends on the private npm package `@turnai/validate-us-drivers-license`. You must be authenticated to npm (same registry as this package) to install:
+
+```bash
+npm login
+# or set NODE_AUTH_TOKEN when installing in CI
+npm install --save @turnai/turn-shared
+```
+
+## Building
+
+Node 10 or higher is required for development and building. Use `nvm use` if you use nvm (see `.nvmrc`).
+
+Make your changes in the src files, when you're ready to push your changes run `yarn build`.
+
+## Services included
+### BaseAPI
+API with turn endpoints, created with apisauce.
+
+
+## Styles included
+### constants
+Includes the main palette used in apps.
+
+
+## Utils included
+### formatDate 
+Takes a unix timestamp and returns a string with format MM/DD/YYYY.
+
+**Arguments**
+
+date (number): The unix timestamp to format.
+
+**Returns**
+
+(string): Returns string with format MM/DD/YYYY if `date` is valid, else "N/A".
+
+
+
+_________
+
+### formatEmail
+Replaces each contiguous string of space characters with an empty string.
+
+**Arguments**
+
+email(string): The email to format.
+
+**Returns**
+
+(string): Returns string without spaces if email is a string, else an empty string.
+
+
+
+_________
+
+### formatName
+Replaces each contiguous string of tabs, spaces and line breaks with a space.
+
+**Arguments**
+
+name(string): The name to format.
+
+**Returns**
+
+(string): Returns string without tabs spaces or line breaks if `name` is a string, else an empty string.
+
+
+
+_________
+
+### formatPhone
+Formats a number to a valid US phone number.
+
+**Arguments**
+
+phone(string): The phone number to format.
+[ encrypted=false ] (boolean): Indicates wether the phone should be encrypted.
+
+**Returns**
+
+(string): Returns string spaced every three digits, if encrypted adds a '-' in between the 6th and 7th character if `phone` is a string, else "N/A".
+
+
+
+_________
+
+### formatSSN
+Replaces all non-numeric charactes for empty strings.
+
+**Arguments**
+
+ssn(string): The ssn to format.
+
+**Returns**
+
+(string): Returns a stirng spaced with a '-' every three and five characters if `ssn` is a string, else "N\A".
+
+
+
+_________
+
+### formatZipcode
+Replaces all non-numeric characters for empty strings.
+
+**Arguments**
+
+zipcode(string): The zipcode to format.
+
+**Returns**
+
+(string): Returns string without non-numeric characters and only the first 5 characters if `zipcode` is a string, else an empty string.
+
+
+
+_________
+
+### getRejectMessage
+Returns the reject message of the specified partner.
+
+**Arguments**
+
+partner_type(string): The partner to check.
+
+**Returns**
+
+(string): Reject message of specified partner.
+
+
+
+_________
+
+### getStatus
+Translates the specified status.
+
+**Arguments**
+
+status(string): The status to translate.
+
+**Returns**
+
+(string): Returns translated status.
+
+
+
+_________
+
+### isDate
+Checks if value is a valid date.
+
+**Arguments**
+
+value(*): Value to check.
+
+**Returns**
+
+(boolean): Returns true if `value` can be transformed to a valid date, else false.
+
+
+
+_________
+
+### isObject
+Checks if value is type Object.
+
+**Arguments**
+
+value(*): The value to check.
+
+**Returns**
+
+(boolean): Returns true if `value` is an object, else false.
+
+
+
+_________
+
+### isUrl
+Checks if value is valid url.
+
+**Arguments**
+
+urlString(string): The value to check.
+
+**Returns**
+
+(boolean): Returns true if `urlString` is a valid url, else false.
+
+
+
+_________
+
+### legalReplace
+Replaces matches in string `original` with `replacement`.
+
+**Arguments**
+
+[ original="" ] (string): The string to modify.
+[ replacement="" ] (string): The match to replace.
+
+**Returns**
+
+(string): Returns the modified string with matches replaced with `replacement` if `original` is a string, else an empty string.
+
+
+
+_________
+
+### maskName
+Creates a slice of a given string.
+
+**Arguments**
+
+name(string): The string to modify.
+
+**Returns**
+
+(string): Returns a string containing the first character. 
+
+
+
+_________
+
+### objectToQuery
+Converts an object to a query using its keys as name and values as values.
+
+**Arguments**
+
+query(object): The object to transform.
+
+**Returns**
+
+(string): Returns a query composed of the keys used as names and values as values.
+
+
+
+_________
+
+### parsePythonDate
+Transforms a python date to regular Date.
+
+**Arguments**
+
+date(): The date to transform.
+
+**Returns**
+
+(Date): Returns a valid date if `date` is a valid date, else null.
+
+
+
+_________
+
+### parseQuery
+Transforms a query to an object using the names as keys and values as values.
+
+**Arguments**
+
+query(string): The query to transform.
+
+**Returns**
+
+(string): Returns an object using the names of the query as keys and its values as values.
+
+
+
+_________
+
+### pickColor
+Localizes the color of a given status.
+
+**Arguments**
+
+status(string): The status to find the color of.
+
+**Returns**
+
+(string): Returns the hex color of the given `status`.
+
+
+
+_________
+
+### pickScoreColor
+Localizes the color of a given score.
+
+**Arguments**
+
+status(number): The score to find the color of.
+
+**Returns**
+
+(string): Returns the hex color of the given `status`.
+
+
+
+_________
+
+### prettifyDate
+Transforms a regular date string (YYYY/MM/DD) to a pretty date.
+
+**Arguments**
+
+dateString(string): The date to transform.
+
+**Returns**
+
+(string): Returns a string with format MM DD, YYYY.
+
+
+
+_________
+
+### renderDetailValue
+Transforms an object to a string using the values separated by a slash.
+
+**Arguments**
+
+value(*): The value to be transformed.
+[ deep=false ] (boolean): Indicates wether to use use the values of nested values.
+
+**Returns**
+
+Returns a string formed by values of `value` separated by a slash if `value` is an object, else returns `value`.
+
+
+
+_________
+
+### selectMasterKey
+Looks for a key in an object.
+
+**Arguments**
+
+data(*): The object or array from which to get the master key.
+property(string): The property name with which to search master key.
+
+**Returns**
+
+(string): The name of the masterkey.
+
+
+
+_________
+
+### Setter
+Class with factory properties. More details in file.
+
+**Factories included**
+* setStringFactory
+* setNumberFactory
+* setBoolFactory
+* setTruthyFactory
+* setFalsyFactory
+* setOptionFactory
+* toggleBoolFactory
+
+
+
+_________
+
+### storageMock
+Object with simulated properties as storage.
+
+**Properties simulated**
+* setItem.
+* getItem.
+* removeItem.
+* length.
+* key.
+
+
+
+_________
+
+### toBoolean
+Checks if `value` can be classified as a boolean.
+
+**Arguments**
+
+value(*): Value to be checked.
+
+**Returns**
+
+(boolean): Returns true if `value` is truthy based on its type.
+
+
+
+_________
+
+### toRelativeDate
+Formats a regular date to a formatted string.
+
+**Arguments**
+
+date(number): The date to be formatted.
+
+**Returns**
+
+(string): Returns a formatted date with M/DD/YYYY format if date is a string, else "N/A".
+
+
+
+_________
+
+### toRelativeFromISO
+Formats a regular date to a formatted string.
+
+**Arguments**
+
+date(string): The date to be formatted.
+
+**Returns**
+
+(string): Returns a formatted date with M/DD/YYYY format if `date` is a string, else "N/A".
+
+
+
+_________
+
+### toSentenceCase
+Formats a string to upper first every start, period, exclamation and question mark.
+
+**Arguments**
+
+str(string): The string to be formatted.
+
+**Returns**
+
+(string): Returns the formatted string.
+
+
+
+
+_________
+
+### toTitleCase
+Transforms a string first letters of every word to upper case.
+
+**Arguments**
+
+str(string): The string to transform.
+
+**Returns**
+
+(string): Returns the string upper cased.
+
+
+
+_________
+
+### translateStatus
+Translates a given status
+
+**Arguments**
+
+status(string): The status to translate.
+adverse_action(string): Indicates whether there's adverse action.
+
+**Returns**
+
+(string): Returns the translated status.
+
+
+
+_________
+
+### validateDriversLicense
+Checks if license is valid based on its state.
+
+**Arguments**
+
+license(string): The license to check.
+[ state="" ] (string): The state to check the licenese with.
+
+**Returns**
+
+(object): Object containing wether the license is valid and resons why.
+
+
+
+_________
+
+### validateSSN
+Checks if `ssn` is a valid ssn.
+
+**Arguments**
+
+ssn(string): The ssn to check.
+
+**Returns**
+
+(boolean): Returns true if `ssn` is valid, else false.
+
+
+
+_________
+
+### validators
+Each validator checks if value is valid. 
+
+**Validators included**
+* validateEmail
+* validatePhone
+* validateSSN
+* validateCheck
+* containsAtSymbol
+* containsNumber
+* validateName
+* validateCustomInput
+* validateZipcode
+* isArray
+* validateMVRCheck
+* validatePhoneVerification
+* disable_check
+* validateEmailId
+* validateTurnId
+
+
+_________
+
+### valueExists
+Checks if `value` exists.
+
+**Arguments**
+
+value(string): The value to be check.
+
+**Returns**
+
+(boolean): Returns true if `value` exists, else false.