Live tracking visuals for the Web

This open source repo helps you visualize live location and activity data of your users on a web app. The data is generated using the HyperTrack SDKs. See sample of these web visuals here.

Usage

Set up SDK in your user's app by signing up here, and then integrating the SDK into your app

Clone this repository

# Clone this repository
$ git clone https://github.com/hypertrack/js-sdk.git

Documentation

For detailed documentation of the APIs, customizations and what all you can build using HyperTrack, please visit the official docs.

Support

Join our Slack community for instant responses, or interact with our growing community. You can also email us at help@hypertrack.com.

Contribute

Feel free to clone, use, and contribute back via pull requests. We'd love to see your pull requests - send them in! Please use the issues tracker to raise bug reports and feature requests. We are excited to see what live location feature you build in your app using this project. Do ping us at help@hypertrack.io once you build one, and we would love to feature your app on our blog!

This is a mono-repo (repo containing multiple packages) managed with lerna and yarn workspaces.

Setup

yarn : Install lerna and other dependencies
lerna run lib : Builds all the packages
lerna link: Symlinks all internal packages

Adding dependency

Because the dependencies of the packages are managed by yarn workspaces, instead of using npm install package-x use yarn add package-x.

Index

Variables

COUNTRIES

COUNTRIES: string[] = ["Afghanistan","Albania","Algeria","American Samoa","Andorra","Angola","Anguilla","Antartica","Antigua and Barbuda","Argentina","Armenia","Aruba","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bermuda","Bhutan","Bolivia","Bosnia and Herzegowina","Botswana","Bouvet Island","Brazil","British Indian Ocean Territory","Brunei Darussalam","Bulgaria","Burkina Faso","Burundi","Cambodia","Cameroon","Canada","Cape Verde","Cayman Islands","Central African Republic","Chad","Chile","China","Christmas Island","Cocos Islands","Colombia","Comoros","Congo","Congo","Cook Islands","Costa Rica","Cota D'Ivoire","Croatia","Cuba","Cyprus","Czech Republic","Denmark","Djibouti","Dominica","Dominican Republic","East Timor","Ecuador","Egypt","El Salvador","Equatorial Guinea","Eritrea","Estonia","Ethiopia","Falkland Islands","Faroe Islands","Fiji","Finland","France","France Metropolitan","French Guiana","French Polynesia","French Southern Territories","Gabon","Gambia","Georgia","Germany","Ghana","Gibraltar","Greece","Greenland","Grenada","Guadeloupe","Guam","Guatemala","Guinea","Guinea-Bissau","Guyana","Haiti","Heard and McDonald Islands","Holy See","Honduras","Hong Kong","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","Democratic People's Republic of Korea","Korea","Kuwait","Kyrgyzstan","Lao","Latvia","Lebanon","Lesotho","Liberia","Libyan Arab Jamahiriya","Liechtenstein","Lithuania","Luxembourg","Macau","Macedonia","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","Marshall Islands","Martinique","Mauritania","Mauritius","Mayotte","Mexico","Micronesia","Moldova","Monaco","Mongolia","Montserrat","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","Netherlands Antilles","New Caledonia","New Zealand","Nicaragua","Niger","Nigeria","Niue","Norfolk Island","Northern Mariana Islands","Norway","Oman","Pakistan","Palau","Panama","Papua New Guinea","Paraguay","Peru","Philippines","Pitcairn","Poland","Portugal","Puerto Rico","Qatar","Reunion","Romania","Russia","Rwanda","Saint Kitts and Nevis","Saint LUCIA","Saint Vincent","Samoa","San Marino","Sao Tome and Principe","Saudi Arabia","Senegal","Seychelles","Sierra","Singapore","Slovakia","Slovenia","Solomon Islands","Somalia","South Africa","South Georgia","Span","SriLanka","St. Helena","St. Pierre and Miguelon","Sudan","Suriname","Svalbard","Swaziland","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Togo","Tokelau","Tonga","Trinidad and Tobago","Tunisia","Turkey","Turkmenistan","Turks and Caicos","Tuvalu","Uganda","Ukraine","United Arab Emirates","United Kingdom","United States","United States Minor Outlying Islands","Uruguay","Uzbekistan","Vanuatu","Venezuela","Vietnam","Virgin Islands (British)","Virgin Islands (U.S)","Wallis and Futana Islands","Western Sahara","Yemen","Yugoslavia","Zambia","Zimbabwe"]

Functions

ArrayHumanize

ArrayHumanize(array: string[]): string

- Defined in array-humanize.ts:1
Parameters
- array: string[]
Returns string

AuthLessReqOptions

AuthLessReqOptions(): object

- Defined in api-helper.ts:1
Returns object
- headers: object
  - Authorization: null
  - Content-Type: string

DateHumanize

DateHumanize(value: string, arg?: boolean): string

- Defined in date-humanize.ts:3
Parameters
- value: string
- Default value arg: boolean = false
Returns string

DateString

DateString(item: string, args?: any): string

- Defined in date-string.ts:3
Parameters
- item: string
- Optional args: any
Returns string

DistanceLocale

DistanceLocale(meters: any, timezone?: any): any

- Defined in distance-locale.ts:3
Parameters
- meters: any
- Optional timezone: any
Returns any

DotString

DotString(value: any, dot?: any): string

- Defined in dot-string.ts:1
Parameters
- value: any
- Default value dot: any = "--"
Returns string

GetDateRangeQuery

GetDateRangeQuery(query: any, param?: string): any

- Defined in date-range.ts:24
Parameters
- query: any
- Default value param: string = "created_at"
Returns any

GetMinute

GetMinute(time: string): number

- Defined in time-utils.ts:11
Parameters
- time: string
Returns number

GetUrlParam

GetUrlParam(name: string): string
GetUrlParam(name: string, url?: any): string

- Defined in getUrlParam.ts:1
Parameters
- name: string
Returns string
- Defined in url-helps.ts:11
Parameters
- name: string
- Optional url: any
Returns string

HMString

HMString(timeMinutes: number, scale?: number): string | null

- Defined in hm-string.ts:1
Parameters
- timeMinutes: number
- Default value scale: number = 1
Returns string | null

HasSameMinute

HasSameMinute(time1: string, time2: string): boolean

- Defined in time-utils.ts:16
Parameters
- time1: string
- time2: string
Returns boolean

HtQuerySerialize

HtQuerySerialize(obj: any): string
HtQuerySerialize(obj: any): string

- Defined in url-helps.ts:1
Parameters
- obj: any
Returns string
- Defined in query-serializer.ts:1
Parameters
- obj: any
Returns string

HtShow

HtShow(toShow: boolean, className?: string): string

- Defined in html-helpers.ts:1
Parameters
- toShow: boolean
- Default value className: string = "flex"
Returns string

IsRangeADay

IsRangeADay(range: any): boolean

- Defined in date-range.ts:36
Parameters
- range: any
Returns boolean

IsRangeToday

IsRangeToday(range: any): boolean

- Defined in date-range.ts:14
Parameters
- range: any
Returns boolean

IsValidUrl

IsValidUrl(url: string): boolean

- Defined in validations.ts:1
Parameters
- url: string
Returns boolean

NameCase

NameCase(name: string, split?: string): string

- Defined in name-case.ts:2
Parameters
- name: string
- Default value split: string = " "
Returns string

OffsetIsoTime

OffsetIsoTime(time: string, offset?: number): string

- Defined in time-utils.ts:7
Parameters
- time: string
- Default value offset: number = 10
Returns string

RangeHasToday

RangeHasToday(query: any): boolean

- Defined in date-range.ts:47
Parameters
- query: any
Returns boolean

TimeString

TimeString(item: string, args?: any): string

- Defined in time-string.ts:11
Parameters
- item: string
- Optional args: any
Returns string

getMergedParams

getMergedParams(params: any, currentParams?: object): object

- Defined in url-helps.ts:21
Parameters
- params: any
- Default value currentParams: object = {}
Returns object

getNearestMinute

getNearestMinute(date: any): Date

- Defined in time-string.ts:3
Parameters
- date: any
Returns Date

getTimezone

getTimezone(): string

- Defined in timezone.ts:3
Returns string

humanizeDuration

humanizeDuration(second: any, scale: any): string

- Defined in time-utils.ts:20
Parameters
- second: any
- scale: any
Returns string

indexBy

indexBy(array: any[], key?: string): any

- Defined in array-helpers.ts:6
Works similar to underscore indexBy, converts array to object

Parameters
- array: any[]
  
  : this is convereted to object
- Default value key: string = "id"
Returns any

isSameRange

isSameRange(range1: any, range2: any): boolean

- Defined in date-range.ts:8
Parameters
- range1: any
- range2: any
Returns boolean

objectToStringArray

objectToStringArray(obj: object, separator?: string): [string, string][]

- Defined in object-helpers.ts:9
e.g. {current_time: abc, is_late: true} => [[Current time, abc]]

Parameters
- obj: object
  
  : object which is converted to string
- Optional separator: string
  
  : used to stringify the key of object currently only included string/number/boolean values to depth 1
Returns [string, string][]

propToString

propToString(prop: string, separator?: string): string

- Defined in string-helpers.ts:6
current_time => Current time

Parameters
- prop: string
  
  : string which is humanized
- Default value separator: string = "_"
  
  : to split the prop string
Returns string

valuesOfObject

valuesOfObject(obj: any): any[]

- Defined in object-helpers.ts:24
e.g. {current_time: abc, is_late: true} => [abc, true]

Parameters
- obj: any
  
  : object whole values as array is returned
Returns any[]

Object literals

Color

Color: object

black

black: string = "#000000"

blue

blue: string = "#5496F8"

blueDark

blueDark: string = "#497cd0"

blueLight

blueLight: string = "#77b1f8"

green

green: string = "#85C487"

greenDark

greenDark: string = "#6bb564"

greenLight

greenLight: string = "#94dc96"

grey2

grey2: string = "#C9D6DE"

grey3

grey3: string = "#A9BAC4"

grey4

grey4: string = "#798E9B"

grey5

grey5: string = "#52616A"

mapBg

mapBg: string = "#d7d5d5"

red

red: string = "#E6413E"

redDark

redDark: string = "#ac3532"

redLight

redLight: string = "#f06f49"

stop

stop: string = "#FFBB44"

stopDark

stopDark: string = "#ef9040"

Generated using TypeDoc

Live tracking visuals for the Web

Usage

Documentation

Support

Contribute

Setup

Adding dependency

Index

Classes

Interfaces

Variables

Functions

Object literals

Variables

COUNTRIES

Functions

ArrayHumanize

Parameters

array: string[]

Returns string

AuthLessReqOptions

Returns object

headers: object

Authorization: null

Content-Type: string

DateHumanize

Parameters

value: string

Default value arg: boolean = false

Returns string

DateString

Parameters

item: string

Optional args: any

Returns string

DistanceLocale

Parameters

meters: any

Optional timezone: any

Returns any

DotString

Parameters

value: any

Default value dot: any = "--"

Returns string

GetDateRangeQuery

Parameters

query: any

Default value param: string = "created_at"

Returns any

GetMinute

Parameters

time: string

Returns number

GetUrlParam

Parameters

name: string

Returns string

Parameters

name: string

Optional url: any

Returns string

HMString

Parameters

timeMinutes: number

Default value scale: number = 1

Returns string | null

HasSameMinute

Parameters

time1: string

time2: string

Returns boolean

HtQuerySerialize

Parameters

obj: any

Returns string

Parameters

obj: any

Returns string

HtShow