@mappedin/blue-dot 6.0.1-beta.55 → 6.0.1-beta.57

package/lib/rn/types.d.ts

@@ -0,0 +1,194 @@
+import type { Coordinate, Floor } from '@mappedin/mappedin-js';
+import type { EasingCurve } from '../../packages/common';
+export type FollowMode = 
+/** Camera position follows the Blue Dot's position. */
+'position-only'
+/** Camera position follows the Blue Dot's position. Camera bearing matches the Blue Dot's heading. */
+ | 'position-and-heading'
+/** Camera position follows the Blue Dot's position. Camera bearing is calculated based on the Navigation path. */
+ | 'position-and-path-direction'
+/** Disables follow mode */
+ | false;
+export type FollowCameraOptions = {
+    /**
+     * @default 21
+     */
+    zoomLevel?: number;
+    /**
+     * @default 45
+     */
+    pitch?: number;
+    /**
+     * Camera bearing in degrees clockwise from North. 0 is North, 90 is East, 180 is South, 270 is West.
+     * This option is only available in 'position-only' mode. In all other modes, the bearing will be calculated automatically.
+     * @default undefined
+     */
+    bearing?: number;
+    /**
+     * @default undefined
+     */
+    elevation?: number;
+    /**
+     * @default 1000
+     */
+    duration?: number;
+    /**
+     * @default 'ease-in-out'
+     */
+    easing?: EasingCurve;
+};
+export type BlueDotEventPayloads = {
+    /**
+     * Emitted when the Blue Dot's position is updated.
+     */
+    'position-update': {
+        floor: Floor | undefined;
+        heading: GeolocationPosition['coords']['heading'] | undefined;
+        accuracy: GeolocationPosition['coords']['accuracy'] | undefined;
+        coordinate: Coordinate;
+    };
+    /**
+     * Emitted when the Blue Dot's state changes.
+     */
+    'state-change': {
+        /**
+         * The new state of the Blue Dot.
+         */
+        state: BlueDotState;
+        /**
+         * The action that caused the state change.
+         */
+        action: BlueDotAction;
+    };
+    /**
+     * Emitted when the Blue Dot encounters an error.
+     */
+    error: GeolocationPositionError;
+    /**
+     * Emitted when the Blue Dot's following state changes.
+     */
+    'follow-change': {
+        /**
+         * Whether the Blue Dot is following the user.
+         */
+        following: boolean;
+        /**
+         * The mode the Blue Dot is following the user in.
+         */
+        mode?: FollowMode;
+    };
+    /**
+     * Emitted when the user clicks on the Blue Dot.
+     */
+    click: {
+        coordinate: Coordinate;
+    };
+    /**
+     * Emitted when the user hovers over the Blue Dot.
+     */
+    hover: undefined;
+};
+export type BlueDotEvents = keyof BlueDotEventPayloads;
+export type BlueDotState = 'hidden' | 'active' | 'inactive' | 'disabled';
+export type BlueDotAction = 'timeout' | 'error' | 'position-update' | 'enable' | 'disable' | 'initialize';
+export type BlueDotOptions = {
+    /**
+     * The radius of the BlueDot in pixels. The BlueDot will maintain this size clamped to a minimum of 0.35 metres.
+     * @default 10
+     */
+    radius?: number;
+    /**
+     * The color of the BlueDot core element.
+     * @default #2266ff
+     */
+    color?: string;
+    /**
+     * The color of the BlueDot when it has timed out and gone inactive.
+     * @default #808080
+     */
+    inactiveColor?: string;
+    /**
+     * Options for the accuracy ring around the BlueDot.
+     */
+    accuracyRing?: {
+        /**
+         * The color of the accuracy ring.
+         * @default #2266ff
+         */
+        color?: string;
+        /**
+         * The opacity of the accuracy ring.
+         * @default 0.3
+         */
+        opacity?: number;
+    };
+    /**
+     * Options for the heading directional indicator.
+     */
+    heading?: {
+        /**
+         * The color of the heading cone.
+         * @default #2266ff
+         */
+        color?: string;
+        /**
+         * The opacity of the heading cone.
+         * @default 0.7
+         */
+        opacity?: number;
+    };
+    /**
+     * The duration of the timeout in milliseconds.
+     * If the BlueDot does not receive a position update within this time, it will grey out until a position is received.
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Whether to watch the device's position.
+     * @default true
+     */
+    watchDevicePosition?: boolean;
+    /**
+     * Whether to log debug messages.
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * The maximum acceptable accuracy in meters. Position updates with accuracy exceeding this value will be dropped.
+     * @default 50
+     */
+    accuracyThreshold?: number;
+};
+/**
+ * Position update options for the {@link BlueDot.update} method.
+ */
+export type BlueDotPositionUpdate = {
+    /**
+     * Latitude to override.
+     * Set to `'device'` to reset to the device's latitude.
+     */
+    latitude?: GeolocationPosition['coords']['latitude'] | 'device' | undefined;
+    /**
+     * Longitude to override.
+     * Set to `'device'` to reset to the device's longitude.
+     */
+    longitude?: GeolocationPosition['coords']['longitude'] | 'device' | undefined;
+    /**
+     * Accuracy to override.
+     * Set to `'device'` to reset to the device's accuracy.
+     * Set to `undefined` to disable the accuracy ring.
+     */
+    accuracy?: GeolocationPosition['coords']['accuracy'] | 'device' | undefined;
+    /**
+     * Heading to override.
+     * Set to `'device'` to reset to the device's heading.
+     * Set to `undefined` to disable the heading indicator.
+     */
+    heading?: GeolocationPosition['coords']['heading'] | 'device' | undefined;
+    /**
+     * Floor or floorId to override.
+     * Set to `'device'` to reset to the device's floor level.
+     * Set to `undefined` to disable floor level and show the BlueDot on all floors.
+     */
+    floorOrFloorId?: Floor | string | 'device' | undefined;
+};

package/package.json

@@ -1,12 +1,31 @@
 {
   "name": "@mappedin/blue-dot",
-  "version": "6.0.1-beta.55",
+  "version": "6.0.1-beta.57",
   "homepage": "https://developer.mappedin.com/",
   "private": false,
   "main": "lib/esm/index.js",
   "module": "lib/esm/index.js",
   "browser": "lib/esm/index.js",
   "types": "lib/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/esm/index.js",
+      "types": "./lib/esm/index.d.ts"
+    },
+    "./rn": {
+      "import": "./lib/rn/index-rn.js",
+      "require": "./lib/rn/index-rn.js",
+      "types": "./lib/rn/index-rn.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "rn": [
+        "lib/rn/index-rn.d.ts"
+      ]
+    }
+  },
   "files": [
     "lib",
     "README.md",
@@ -14,21 +33,35 @@
     "THIRD_PARTY_LICENSES.txt"
   ],
   "license": "SEE LICENSE IN LICENSE.txt",
+  "dependencies": {},
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "@mappedin/mappedin-js": "^6.0.0-rc.4",
+    "@mappedin/react-native-sdk": "^6.0.0-beta.1"
+  },
+  "peerDependenciesMeta": {
+    "@mappedin/react-native-sdk": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {},
+  "volta": {
+    "extends": "../../package.json"
+  },
   "scripts": {
     "start": "pnpm build && concurrently \"node scripts/build.mjs --watchChanges\" \"node scripts/start.mjs\"",
+    "build:deps": "RN_BUILD=true npx turbo build --filter=@mappedin/blue-dot --ui stream",
     "build": "pnpm clean && tsc -b && node scripts/build.mjs",
-    "build:prod": "cross-env NODE_ENV=production pnpm build",
+    "build:prod": "cross-env NODE_ENV=production pnpm build && pnpm build:rn",
+    "build:rn": "cross-env RN_BUILD=true pnpm build",
     "types": "tsc -b",
-    "test": "NODE_ENV=test jest",
+    "version:ci": "pnpm version --no-commit-hooks --no-git-tag-version",
+    "test": "pnpm -w test blue-dot",
     "test:cov": "NODE_ENV=test jest --coverage",
     "clean": "rm -rf lib/** && rm -rf examples/dist/**",
     "docs": "pnpm build && typedoc"
-  },
-  "peerDependencies": {
-    "@mappedin/mappedin-js": "^6.0.1-beta.42"
-  },
-  "volta": {
-    "extends": "../../package.json"
-  },
-  "gitHead": "6f653df01e872470753a4ddfeb213b6e28c50f93"
-}
+  }
+}