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.

Setup

npm install : Install lerna and other dependencies
lerna bootstrap: Install dependencies of all the packages and symlinks packages existing in this repo. As the packages in the repo are not yet build this will install all from npm. Run this after any dependency is added in any of the packages
lerna run lib : Builds all the packages
lerna link: Symlinks all internal packages

Adding dependency

Because the dependencies of the packages are managed by lerna, instead of using npm install package-x use lerna add package-x --scope=internal-package-name, where internal-package-name is the internal package name. Use --dev flag to install as dev-dependencies. Remove --scope=internal-package-name to install on all the packages

Index

Classes

HtCustomEvent

Interfaces

IEventSub

Variables

Object literals

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"]

DateMapService

DateMapService: object = (() => {let instance;return {getInstance() {if(!instance) {instance = {today_end: endOfToday().toISOString(),today_start: startOfToday().toISOString(),yesterday_start: startOfYesterday().toISOString(),yesterday_end: endOfYesterday().toISOString(),day_7_start: startOfDay(addDays(new Date(), -6)).toISOString(),month_start: startOfMonth(new Date()).toISOString(),day_30_start: startOfDay(addDays(new Date(), -29)).toISOString(),};}return instance;}}})()

Type declaration

getInstance: function
- getInstance(): any
- - Defined in date-range.ts:11
  Returns any

DateRangeLabelMap

DateRangeLabelMap: object[] = [{label: "Today",range: DateRangeMap.today,isSingleDay: true,hasToday: true},{label: "Yesterday",range: DateRangeMap.yesterday,isSingleDay: true,hasToday: false},{label: "Last 7 days",range: DateRangeMap.last_7_days,isSingleDay: false,hasToday: true},{label: "This month",range: DateRangeMap.this_month,isSingleDay: false,hasToday: true},{label: "Last 30 days",range: DateRangeMap.last_30_days,isSingleDay: false,hasToday: true}]

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: Headers

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): string

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

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:101
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

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

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:113
Parameters
- range: any
Returns boolean

IsRangeToday

IsRangeToday(range: any): boolean

- Defined in date-range.ts:91
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:124
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

dateRangeDisplay

dateRangeDisplay(range: IDateRange): string

- Defined in date-range.ts:133
Parameters
- range: IDateRange
Returns string

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

isSameDateRange

isSameDateRange(range1: IDateRange, range2: IDateRange): boolean

- Defined in date-range.ts:160
Parameters
- range1: IDateRange
- range2: IDateRange
Returns boolean

isSameRange

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

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

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"

DateRangeMap

DateRangeMap: object

last_30_days

last_30_days: object

end

end: any = DateMapService.getInstance().today_end

start

start: any = DateMapService.getInstance().day_30_start

last_7_days

last_7_days: object

end

end: any = DateMapService.getInstance().today_end

start

start: any = DateMapService.getInstance().day_7_start

this_month

this_month: object

end

end: any = DateMapService.getInstance().today_end

start

start: any = DateMapService.getInstance().month_start

today

today: object

end

end: any = DateMapService.getInstance().today_end

start

start: any = DateMapService.getInstance().today_start

yesterday

yesterday: object

end

end: any = DateMapService.getInstance().yesterday_end

start

start: any = DateMapService.getInstance().yesterday_start

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

DateMapService

Type declaration

getInstance: function

Returns any

DateRangeLabelMap

Functions

ArrayHumanize

Parameters

array: string[]

Returns string

AuthLessReqOptions

Returns object

headers: Headers

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 string

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

HasSameMinute

Parameters

time1: string

time2: string

Returns boolean

HtQuerySerialize

Parameters

obj: any

Returns string

Parameters