@ingissa/navcore-mapbox 1.0.9 → 1.0.10

package/LICENSE

@@ -1,3 +1,3 @@
-Copyright (c) 2026 Abdelnasser Aitabi. All rights reserved.
-
-No license is granted except by separate written agreement.
+Copyright (c) 2026 Abdelnasser Aitabi. All rights reserved.
+
+No license is granted except by separate written agreement.

package/README.md

@@ -0,0 +1,102 @@
+# @ingissa/navcore-mapbox
+
+[Official Website](https://navcore-web.vercel.app/)
+
+> Mapbox Directions provider adapter for the NavCore navigation engine.
+
+[![npm version](https://img.shields.io/npm/v/@ingissa/navcore-mapbox)](https://www.npmjs.com/package/@ingissa/navcore-mapbox)
+![License](https://img.shields.io/badge/license-Proprietary-red)
+[![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue)](https://www.typescriptlang.org/)
+
+---
+
+## Overview
+
+`@ingissa/navcore-mapbox` provides `MapboxDirectionsProvider`, an implementation of NavCore's `DirectionsProvider` interface targeting the Mapbox Directions API.
+
+### Key Capabilities
+- **Direct NavCore integration**: Directly compatible with `createNavigationSession` and `createRoutePlan`.
+- **Automatic waypoint chunking**: Transparently splits routes with more than 25 waypoints into chunks, querying each chunk and stitching geometry with the `OVERLAP_1` strategy.
+- **Configurable routing profiles**: Supports `driving`, `driving-traffic`, `cycling`, and `walking`.
+
+> [!NOTE]
+> `@ingissa/navcore-mapbox` is a routing directions provider only. It does not export a map renderer. For map rendering in React Native, use `@rnmapbox/maps` or `react-native-maps` directly in your application components by consuming state from `useNavSelector()`.
+
+---
+
+## Installation
+
+```bash
+npm install @ingissa/navcore-mapbox @ingissa/navcore-core
+```
+
+### Peer Dependencies
+- `@ingissa/navcore-core`: `^1.0.9` (required)
+- `@rnmapbox/maps`: `>=10.0.0` (optional, for React Native applications)
+
+---
+
+## Quickstart
+
+```typescript
+import { createNavigationSession } from '@ingissa/navcore-core';
+import { MapboxDirectionsProvider } from '@ingissa/navcore-mapbox';
+
+// Initialize Mapbox provider with your access token
+const provider = new MapboxDirectionsProvider({
+  accessToken: 'pk.eyJ1...',
+  profile: 'driving-traffic', // 'driving' | 'driving-traffic' | 'cycling' | 'walking'
+  maxWaypointsPerChunk: 25,   // Default: 25 (Mapbox API limit)
+});
+
+// Pass to a NavigationSession
+const nav = createNavigationSession({
+  provider,
+  providerName: 'mapbox',
+  engineOptions: { isDev: true },
+});
+
+// Fetch route and start navigation
+const plan = await nav.navigate({
+  origin: [2.3522, 48.8566],
+  destination: [2.3009, 48.8741],
+});
+
+console.log(`Route loaded: ${plan.distanceM}m, duration: ${plan.durationS}s`);
+```
+
+---
+
+## Standalone Usage
+
+```typescript
+import { MapboxDirectionsProvider } from '@ingissa/navcore-mapbox';
+
+const provider = new MapboxDirectionsProvider({
+  accessToken: process.env.MAPBOX_TOKEN!,
+});
+
+const result = await provider.getRoute([
+  [2.3522, 48.8566],
+  [2.3300, 48.8650],
+  [2.3009, 48.8741],
+]);
+
+console.log('Coordinates:', result.geometry.length);
+console.log('Distance in metres:', result.distance);
+console.log('Duration in seconds:', result.duration);
+```
+
+---
+
+## Documentation
+
+- [Directions Providers Guide](../../docs/directions-providers.md)
+- [API Reference](../../docs/api-reference/navcore-mapbox.md)
+- [Official Website](https://navcore-web.vercel.app/)
+
+---
+
+## Licensing
+
+Proprietary software. Copyright (c) 2026 Abdelnasser Aitabi. All rights reserved. No license is granted except by separate written agreement.

package/package.json

@@ -1,44 +1,44 @@
-{
-  "name": "@ingissa/navcore-mapbox",
-  "version": "1.0.9",
-  "description": "Mapbox GL adapter for NavCore — renderer and directions provider.",
-  "author": "Ingissa <8abnav@gmail.com>",
-  "license": "SEE LICENSE IN LICENSE",
-  "homepage": "https://navcore-web.vercel.app/",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "LICENSE"
-  ],
-  "sideEffects": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "scripts": {
-    "build": "tsup",
-    "lint": "tsc --noEmit",
-    "prepublishOnly": "npm run build --prefix ../.. && node ../../scripts/check-release.mjs"
-  },
-  "peerDependencies": {
-    "@ingissa/navcore-core": "^1.0.9",
-    "@rnmapbox/maps": ">=10.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@rnmapbox/maps": {
-      "optional": true
-    }
-  },
-  "dependencies": {}
-}
+{
+  "name": "@ingissa/navcore-mapbox",
+  "version": "1.0.10",
+  "description": "Mapbox GL adapter for NavCore — renderer and directions provider.",
+  "author": "Ingissa <8abnav@gmail.com>",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://navcore-web.vercel.app/",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "npm run build --prefix ../.. && node ../../scripts/check-release.mjs"
+  },
+  "peerDependencies": {
+    "@ingissa/navcore-core": "^1.0.10",
+    "@rnmapbox/maps": ">=10.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@rnmapbox/maps": {
+      "optional": true
+    }
+  },
+  "dependencies": {}
+}