Options
All
  • Public
  • Public/Protected
  • All
Menu

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

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

  2. 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

  1. npm install : Install lerna and other dependencies
  2. 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
  3. lerna run lib : Builds all the packages
  4. 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

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

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

AuthLessReqOptions

  • AuthLessReqOptions(): object

DateHumanize

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

    • value: string
    • Default value arg: boolean = false

    Returns string

DateString

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

    • item: string
    • Optional args: any

    Returns string

DistanceLocale

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

DotString

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

    • value: any
    • Default value dot: any = "--"

    Returns string

GetDateRangeQuery

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

    • query: any
    • Default value param: string = "created_at"

    Returns any

GetMinute

  • GetMinute(time: string): number

GetUrlParam

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

HMString

  • HMString(timeMinutes: number, scale?: number): string
  • Parameters

    • timeMinutes: number
    • Default value scale: number = 1

    Returns string

HasSameMinute

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

    • time1: string
    • time2: string

    Returns boolean

HtQuerySerialize

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

HtShow

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

    • toShow: boolean
    • Default value className: string = "flex"

    Returns string

IsRangeADay

  • IsRangeADay(range: any): boolean

IsRangeToday

  • IsRangeToday(range: any): boolean

IsValidUrl

  • IsValidUrl(url: string): boolean

NameCase

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

    • name: string
    • Default value split: string = " "

    Returns string

OffsetIsoTime

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

    • time: string
    • Default value offset: number = 10

    Returns string

RangeHasToday

  • RangeHasToday(query: any): boolean

TimeString

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

    • item: string
    • Optional args: any

    Returns string

dateRangeDisplay

  • dateRangeDisplay(range: IDateRange): string

getNearestMinute

  • getNearestMinute(date: any): Date

getTimezone

  • getTimezone(): string

isSameDateRange

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

    • range1: IDateRange
    • range2: IDateRange

    Returns boolean

isSameRange

  • isSameRange(range1: any, range2: any): boolean
  • 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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc