hypertrack-sdk-react-native 8.2.2 → 9.0.0

package/lib/typescript/HyperTrack/HyperTrack.d.ts

@@ -1,110 +1,75 @@
-export declare enum SDKError {
-    /**
-     * An error that we couldn't recognize.
-     */
-    GENERAL = 0,
-    /**
-     * Publishable key is invalid. Check your key on hypertrack dashboard setup.
-     */
-    INVALID_PUBLISHABLE_KEY = 1,
-    /**
-     * Your free trial ended or account was not renewed. Check your account on hypertrack dashboard.
-     */
-    AUTHORIZATION_FAILED = 2,
-    /**
-     * Tracking won't start due to denied (or absent) permission.
-     */
-    PERMISSION_DENIED = 3
-}
-/**
- * A base interface for errors in SDK.
- */
-export declare type Error = {
-    code: SDKError;
-    message?: string;
-};
-/**
- * Interface for accessing adding geotag result.
- */
-export declare enum GeotagError {
-    /** Expected location is not supported on this platform */
-    PLATFORM_NOT_SUPPORTED = 0,
-    /** Expected vs actual location difference is greater then required */
-    LOCATION_MISMATCH = 1,
-    /** SDK can't get actual location from OS sensors */
-    LOCATION_NOT_AVAILABLE = 2,
-    /** Invalid arguments  */
-    INVALID_ARGUMENTS = 3
-}
-export interface Location {
-    location: {
-        latitude: number;
-        longitude: number;
-    };
-}
-export declare enum LocationError {
-    LOCATION_PERMISSIONS_NOT_DETERMINED = "location_permissions_not_determined",
-    LOCATION_PERMISSIONS_CANT_BE_ASKED_IN_BACKGROUND = "location_permissions_cant_be_asked_in_background",
-    LOCATION_PERMISSIONS_INSUFFICIENT_FOR_BACKGROUND = "location_permissions_insufficient_for_background",
-    LOCATION_PERMISSIONS_RESTRICTED = "location_permissions_restricted",
-    LOCATION_PERMISSIONS_REDUCED_ACCURACY = "location_permissions_reduced_accuracy",
-    LOCATION_PERMISSIONS_DENIED = "location_permissions_denied",
-    LOCATION_SERVICES_DISABLED = "location_services_disabled",
-    MOTION_ACTIVITY_PERMISSIONS_NOT_DETERMINED = "motion_activity_permissions_not_determined",
-    MOTION_ACTIVITY_PERMISSIONS_CANT_BE_ASKED_IN_BACKGROUND = "motion_activity_permissions_cant_be_asked_in_background",
-    MOTION_ACTIVITY_PERMISSIONS_DENIED = "motion_activity_permissions_denied",
-    MOTION_ACTIVITY_SERVICES_DISABLED = "motion_activity_services_disabled",
-    NOT_RUNNING = "not_running",
-    GPS_SIGNAL_LOST = "gps_signal_lost",
-    STARTING = "starting",
-    LOCATION_MOCKED = "location_mocked"
-}
+import { HyperTrackError } from './data_types/HyperTrackError';
+import type { Location } from './data_types/Location';
+import type { LocationError } from './data_types/LocationError';
+import type { SdkInitParams } from './data_types/SdkInitParams';
 export default class HyperTrack {
-    constructor();
-    static createInstance(publishableKey: string, automaticallyRequestPermissions?: boolean): Promise<HyperTrack>;
+    private constructor();
     /**
-     * Enables debug log output. This is very verbose, so you shouldn't use this for
-     * production build.
+     * Creates an SDK instance
+     *
+     * @param publishableKey publishable key provided in HyperTrack’s dashboard setup page
+     * @param sdkInitParams
+     * @returns HyperTrack instance
      */
-    static enableDebugLogging(enable: boolean): void;
+    static initialize(publishableKey: string, sdkInitParams?: SdkInitParams): Promise<HyperTrack>;
     /**
-     * Returns a string which is used by HyperTrack to uniquely identify the user.
+     * Returns a string that is used to uniquely identify the device
      */
-    getDeviceID(): Promise<string>;
+    getDeviceId(): Promise<string>;
     /**
-     * Device's availability for nearby search
+     * Reflects availability of the device for the Nearby search
      *
      * @returns true when is available or false when unavailable
      */
     isAvailable(): Promise<boolean>;
     /**
-     * Allows you to set device availability for nearby search
+     * Sets the availability of the device for the Nearby search
      *
      * @param availability true when is available or false when unavailable
      */
-    setAvailability(availability: Boolean): Promise<void>;
+    setAvailability(isAvailable: boolean): void;
     /**
-     * Determine whether the SDK is tracking the movement of the user.
+     * Reflects the tracking intent for the device
+     *
      * @return {boolean} Whether the user's movement data is getting tracked or not.
      */
     isTracking(): Promise<boolean>;
     /**
-     * Update device state from server.
+     * Syncs the device state with the HyperTrack servers
      */
-    syncDeviceSettings(): void;
+    sync(): void;
     /**
-     * Start or resume tracking location and activity events.
+     * Expresses an intent to start location tracking for the device
      */
     startTracking(): void;
     /**
-     * Stops the SDK from listening to the user's movement updates and recording any data.
+     * Stops location tracking immediately
      */
     stopTracking(): void;
+    /**
+     * Reflects the current location of the user or an outage reason
+     */
     getLocation(): Promise<LocationError | Location>;
     /**
-     * Listen for errors.
+     * Sets the name for the device
+     * @param {string} name
+     */
+    setName(name: string): void;
+    /**
+     * Sets the metadata for the device
+     * @param {Object} data - Metadata JSON
+     */
+    setMetadata(data: Object): void;
+    /**
+     * Adds a new geotag
+     * @param {Object} data - Geotad data JSON
+     * @returns current location if success or LocationError if failure
+     */
+    addGeotag(data: Object): Promise<LocationError | Location>;
+    /**
+     * Subscribe to tracking errors
      *
-     * @param listener (errors: {code, message}) => void
+     * @param listener
      * @returns EmitterSubscription
      * @example
      * ```js
@@ -118,11 +83,11 @@ export default class HyperTrack {
      * subscription.remove()
      * ```
      */
-    subscribeToErrors(listener: (errors: Error) => void): import("react-native").EmitterSubscription;
+    subscribeToErrors(listener: (errors: HyperTrackError[]) => void): import("react-native").EmitterSubscription;
     /**
-     * Listen for tracking changes.
+     * Subscribe to tracking intent changes
      *
-     * @param listener (isTracking: boolean) => void
+     * @param listener
      * @returns EmitterSubscription
      * @example
      * ```js
@@ -138,24 +103,25 @@ export default class HyperTrack {
      */
     subscribeToTracking(listener: (isTracking: boolean) => void): import("react-native").EmitterSubscription;
     /**
-     * Send device name to HyperTrack
-     * @param {string} name - Device name you want to see in the Dashboard.
-     */
-    setDeviceName(name: string): void;
-    /**
-     * Send metadata details to HyperTrack
-     * @param {Object} data - Send extra device information.
-     */
-    setMetadata(data: Object): void;
-    /**
-     * @deprecated
-     * Set a trip marker
-     * @param {Object} _data - Include anything that can be parsed into JSON.
-     */
-    setTripMarker(_data: Object): void;
-    /**
-     * Add geotag
-     * @param {Object} data - Include anything that can be parsed into JSON.
+     * Subscribe to availability changes
+     *
+     * @param listener
+     * @returns EmitterSubscription
+     * @example
+     * ```js
+     * const subscription = HyperTrack.subscribeToAvailability(isAvailable => {
+     *   if (isAvailable) {
+     *     // ... ready to go
+     *   }
+     * })
+     *
+     * // later, to stop listening
+     * subscription.remove()
+     * ```
      */
-    addGeotag(data: Object): Promise<LocationError | Location>;
+    subscribeToAvailability(listener: (isAvailable: boolean) => void): import("react-native").EmitterSubscription;
+    /** @ignore */
+    private deserializeHyperTrackErrors;
+    /** @ignore */
+    private deserializeLocationResponse;
 }

package/lib/typescript/HyperTrack/data_types/HyperTrackError.d.ts

@@ -0,0 +1,20 @@
+export declare enum HyperTrackError {
+    gpsSignalLost = "gpsSignalLost",
+    locationMocked = "locationMocked",
+    locationPermissionsDenied = "locationPermissionsDenied",
+    locationPermissionsInsufficientForBackground = "locationPermissionsInsufficientForBackground",
+    locationPermissionsNotDetermined = "locationPermissionsNotDetermined",
+    locationPermissionsReducedAccuracy = "locationPermissionsReducedAccuracy",
+    locationPermissionsProvisional = "locationPermissionsProvisional",
+    locationPermissionsRestricted = "locationPermissionsRestricted",
+    locationServicesDisabled = "locationServicesDisabled",
+    locationServicesUnavailable = "locationServicesUnavailable",
+    motionActivityPermissionsNotDetermined = "motionActivityPermissionsNotDetermined",
+    motionActivityPermissionsDenied = "motionActivityPermissionsDenied",
+    motionActivityServicesDisabled = "motionActivityServicesDisabled",
+    motionActivityServicesUnavailable = "motionActivityServicesUnavailable",
+    motionActivityPermissionsRestricted = "motionActivityPermissionsRestricted",
+    networkConnectionUnavailable = "networkConnectionUnavailable",
+    invalidPublishableKey = "invalidPublishableKey",
+    blockedFromRunning = "blockedFromRunning"
+}

package/lib/typescript/HyperTrack/data_types/Location.d.ts

@@ -0,0 +1,7 @@
+export type Location = {
+    type: 'location';
+    value: {
+        latitude: number;
+        longitude: number;
+    };
+};

package/lib/typescript/HyperTrack/data_types/LocationError.d.ts

@@ -0,0 +1,8 @@
+import type { HyperTrackError } from './HyperTrackError';
+import type { NotRunning, Starting } from './internal/LocationErrorInternal';
+export { NotRunning, Starting };
+export type Errors = {
+    type: 'errors';
+    value: HyperTrackError[];
+};
+export type LocationError = NotRunning | Starting | Errors;

package/lib/typescript/HyperTrack/data_types/SdkInitParams.d.ts

@@ -0,0 +1,5 @@
+export type SdkInitParams = {
+    loggingEnabled?: boolean;
+    allowMockLocations?: boolean;
+    requireBackgroundTrackingPermission?: boolean;
+};

package/lib/typescript/HyperTrack/data_types/internal/DeviceId.d.ts

@@ -0,0 +1,4 @@
+export type DeviceId = {
+    type: 'deviceID';
+    value: string;
+};

package/lib/typescript/HyperTrack/data_types/internal/DeviceName.d.ts

@@ -0,0 +1,4 @@
+export type DeviceName = {
+    type: 'deviceName';
+    value: string;
+};

package/lib/typescript/HyperTrack/data_types/internal/Geotag.d.ts

@@ -0,0 +1,3 @@
+export type Geotag = {
+    data: Object;
+};

package/lib/typescript/HyperTrack/data_types/internal/HyperTrackErrorInternal.d.ts

@@ -0,0 +1,4 @@
+export type HyperTrackErrorInternal = {
+    type: "hyperTrackError";
+    value: string;
+};

package/lib/typescript/HyperTrack/data_types/internal/IsAvailable.d.ts

@@ -0,0 +1,4 @@
+export type IsAvailable = {
+    type: 'isAvailable';
+    value: boolean;
+};

package/lib/typescript/HyperTrack/data_types/internal/IsTracking.d.ts

@@ -0,0 +1,4 @@
+export type IsTracking = {
+    type: 'isTracking';
+    value: boolean;
+};

package/lib/typescript/HyperTrack/data_types/internal/LocationErrorInternal.d.ts

@@ -0,0 +1,12 @@
+import type { HyperTrackErrorInternal } from './HyperTrackErrorInternal';
+export type NotRunning = {
+    type: 'notRunning';
+};
+export type Starting = {
+    type: 'starting';
+};
+export type ErrorsInternal = {
+    type: 'errors';
+    value: HyperTrackErrorInternal[];
+};
+export type LocationErrorInternal = NotRunning | Starting | ErrorsInternal;

package/lib/typescript/HyperTrack/data_types/internal/LocationResponse.d.ts

@@ -0,0 +1,11 @@
+import type { Location } from '../Location';
+import type { LocationErrorInternal } from './LocationErrorInternal';
+export type LocationSuccess = {
+    type: 'success';
+    value: Location;
+};
+export type LocationFailure = {
+    type: 'failure';
+    value: LocationErrorInternal;
+};
+export type LocationResponse = LocationSuccess | LocationFailure;

package/lib/typescript/index.d.ts

@@ -1,4 +1,7 @@
 import HyperTrack from './HyperTrack/HyperTrack';
 export default HyperTrack;
 export { HyperTrack };
-export { Location, Error, SDKError, GeotagError, LocationError, } from './HyperTrack/HyperTrack';
+export { HyperTrackError } from './HyperTrack/data_types/HyperTrackError';
+export { LocationError, NotRunning, Starting, Errors } from './HyperTrack/data_types/LocationError';
+export { Location } from './HyperTrack/data_types/Location';
+export { SdkInitParams } from './HyperTrack/data_types/SdkInitParams';

package/package.json

@@ -1,163 +1,163 @@
 {
-  "name": "hypertrack-sdk-react-native",
-  "version": "8.2.2",
-  "description": "test",
-  "main": "lib/commonjs/index",
-  "module": "lib/module/index",
-  "types": "lib/typescript/index.d.ts",
-  "react-native": "src/index",
-  "source": "src/index",
-  "files": [
-    "src",
-    "lib",
-    "android",
-    "ios",
-    "cpp",
-    "hypertrack-sdk-react-native.podspec",
-    "LICENSE.txt",
-    "README.md",
-    "CHANGELOG.md",
-    "CONTRIBUTING.md",
-    "!lib/typescript/example",
-    "!android/build",
-    "!ios/build",
-    "!**/__tests__",
-    "!**/__fixtures__",
-    "!**/__mocks__"
-  ],
-  "scripts": {
-    "test": "jest",
-    "typescript": "tsc --noEmit",
-    "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "prepare": "bob build",
-    "release": "release-it",
-    "docs": "typedoc --options typedoc.json",
-    "bootstrap": "yarn && yarn docs"
-  },
-  "keywords": [
-    "react-native",
-    "ios",
-    "android",
-    "hypertrack",
-    "location",
-    "tracking"
-  ],
-  "repository": "https://github.com/hypertrack/sdk-react-native",
-  "author": "HyperTrack <help@hypertrack.com> (https://hypertrack.com)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/hypertrack/sdk-react-native/issues"
-  },
-  "homepage": "https://github.com/hypertrack/sdk-react-native#readme",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "devDependencies": {
-    "@babel/eslint-parser": "^7.18.2",
-    "@commitlint/config-conventional": "^17.0.2",
-    "@react-native-community/eslint-config": "^3.0.2",
-    "@release-it/bumper": "^4.0.0",
-    "@release-it/conventional-changelog": "^5.1.0",
-    "@types/jest": "^28.1.2",
-    "@types/react": "~17.0.21",
-    "@types/react-native": "0.68.0",
-    "@typescript-eslint/parser": "^5.30.5",
-    "auto-changelog": "^2.4.0",
-    "commitlint": "^17.0.2",
-    "eslint": "^8.4.1",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^28.1.1",
-    "pod-install": "^0.1.0",
-    "prettier": "^2.0.5",
-    "react": "18.0.0",
-    "react-native": "0.70.0",
-    "react-native-builder-bob": "^0.18.3",
-    "release-it": "^15.4.1",
-    "typedoc": "^0.23.14",
-    "typedoc-plugin-merge-modules": "^3.1.0",
-    "typedoc-plugin-rename-defaults": "^0.6.1",
-    "typescript": "^4.5.2"
-  },
-  "resolutions": {
-    "@types/react": "17.0.21"
-  },
-  "peerDependencies": {
-    "react": "*",
-    "react-native": "*"
-  },
-  "jest": {
-    "preset": "react-native",
-    "modulePathIgnorePatterns": [
-      "<rootDir>/lib/"
-    ]
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
-  "release-it": {
-    "git": {
-      "changelog": "auto-changelog --stdout --commit-limit false --unreleased --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs",
-      "commitMessage": "Release ${version}",
-      "requireCleanWorkingDir": false,
-      "tagName": "${version}",
-      "requireCommits": true
+    "name": "hypertrack-sdk-react-native",
+    "version": "9.0.0",
+    "description": "React Native HyperTrack SDK is a wrapper around native iOS and Android SDKs that allows to integrate HyperTrack into React Native apps.",
+    "main": "lib/commonjs/index",
+    "module": "lib/module/index",
+    "types": "lib/typescript/index.d.ts",
+    "react-native": "src/index",
+    "source": "src/index",
+    "files": [
+        "src",
+        "lib",
+        "android",
+        "ios",
+        "cpp",
+        "hypertrack-sdk-react-native.podspec",
+        "LICENSE.txt",
+        "README.md",
+        "CHANGELOG.md",
+        "CONTRIBUTING.md",
+        "!lib/typescript/example",
+        "!android/build",
+        "!ios/build",
+        "!**/__tests__",
+        "!**/__fixtures__",
+        "!**/__mocks__"
+    ],
+    "scripts": {
+        "test": "jest",
+        "typescript": "tsc --noEmit",
+        "lint": "eslint \"**/*.{js,ts,tsx}\"",
+        "prepare": "bob build",
+        "release": "release-it",
+        "docs": "typedoc --options typedoc.json",
+        "bootstrap": "yarn && yarn docs"
     },
-    "github": {
-      "release": true
+    "keywords": [
+        "react-native",
+        "ios",
+        "android",
+        "hypertrack",
+        "location",
+        "tracking"
+    ],
+    "repository": "https://github.com/hypertrack/sdk-react-native",
+    "author": "HyperTrack <help@hypertrack.com> (https://hypertrack.com)",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/hypertrack/sdk-react-native/issues"
     },
-    "hooks": {
-      "after:bump": "auto-changelog --package --commit-limit false --template https://raw.githubusercontent.com/release-it/release-it/master/templates/keepachangelog.hbs"
+    "homepage": "https://github.com/hypertrack/sdk-react-native#readme",
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
     },
-    "npm": {
-      "publish": true
-    }
-  },
-  "eslintConfig": {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "extends": [
-      "@react-native-community",
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
+    "devDependencies": {
+        "@babel/eslint-parser": "^7.18.2",
+        "@commitlint/config-conventional": "^17.0.2",
+        "@react-native-community/eslint-config": "^3.0.2",
+        "@release-it/bumper": "^4.0.0",
+        "@release-it/conventional-changelog": "^5.1.0",
+        "@types/jest": "^28.1.2",
+        "@types/react": "~17.0.21",
+        "@types/react-native": "0.68.0",
+        "@typescript-eslint/parser": "^5.30.5",
+        "auto-changelog": "^2.4.0",
+        "commitlint": "^17.0.2",
+        "eslint": "^8.4.1",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-prettier": "^4.0.0",
+        "jest": "^28.1.1",
+        "pod-install": "^0.1.0",
+        "prettier": "^2.0.5",
+        "react": "^18.0.0",
+        "react-native": "^0.70.0",
+        "react-native-builder-bob": "^0.18.3",
+        "release-it": "^15.4.1",
+        "typedoc": "^0.23.14",
+        "typedoc-plugin-merge-modules": "^4.0.0",
+        "typedoc-plugin-rename-defaults": "^0.6.1",
+        "typescript": "^4.5.2"
+    },
+    "resolutions": {
+        "@types/react": "17.0.21"
+    },
+    "peerDependencies": {
+        "react": "*",
+        "react-native": "*"
+    },
+    "jest": {
+        "preset": "react-native",
+        "modulePathIgnorePatterns": [
+            "<rootDir>/lib/"
+        ]
+    },
+    "commitlint": {
+        "extends": [
+            "@commitlint/config-conventional"
+        ]
+    },
+    "release-it": {
+        "git": {
+            "changelog": "auto-changelog --stdout --commit-limit false --unreleased --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs",
+            "commitMessage": "Release ${version}",
+            "requireCleanWorkingDir": false,
+            "tagName": "${version}",
+            "requireCommits": true
+        },
+        "github": {
+            "release": true
+        },
+        "hooks": {
+            "after:bump": "auto-changelog --package --commit-limit false --template https://raw.githubusercontent.com/release-it/release-it/master/templates/keepachangelog.hbs"
+        },
+        "npm": {
+            "publish": true
         }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "node_modules/",
-    "lib/"
-  ],
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
-  },
-  "react-native-builder-bob": {
-    "source": "src",
-    "output": "lib",
-    "targets": [
-      "commonjs",
-      "module",
-      [
-        "typescript",
-        {
-          "project": "tsconfig.build.json"
+    },
+    "eslintConfig": {
+        "root": true,
+        "parser": "@typescript-eslint/parser",
+        "extends": [
+            "@react-native-community",
+            "prettier"
+        ],
+        "rules": {
+            "prettier/prettier": [
+                "error",
+                {
+                    "quoteProps": "consistent",
+                    "singleQuote": true,
+                    "tabWidth": 2,
+                    "trailingComma": "es5",
+                    "useTabs": false
+                }
+            ]
         }
-      ]
-    ]
-  }
+    },
+    "eslintIgnore": [
+        "node_modules/",
+        "lib/"
+    ],
+    "prettier": {
+        "quoteProps": "consistent",
+        "singleQuote": true,
+        "tabWidth": 2,
+        "trailingComma": "es5",
+        "useTabs": false
+    },
+    "react-native-builder-bob": {
+        "source": "src",
+        "output": "lib",
+        "targets": [
+            "commonjs",
+            "module",
+            [
+                "typescript",
+                {
+                    "project": "tsconfig.build.json"
+                }
+            ]
+        ]
+    }
 }