@ohos-ports/mapbox-gl-directions 0.0.0-stage → 4.3.3-beta.1

package/.babelrc

@@ -0,0 +1,6 @@
+{
+    "presets": [
+        "@babel/preset-env"
+    ],
+    "plugins": ["transform-inline-environment-variables"]
+}

package/.claude/settings.local.json

@@ -0,0 +1,26 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npx eslint *)",
+      "Bash(node *)",
+      "Bash(echo \"exit:$?\")",
+      "Bash(npm install *)",
+      "Bash(npm run *)",
+      "Bash(MapboxAccessToken=dummy npx browserify test/index.js -o /dev/null)",
+      "Bash(MapboxAccessToken=dummy npx browserify test/index.js -o /private/tmp/claude-501/-Users-isaacbesora-Documents-workspace-mapbox-gl-directions/707869d0-e6de-468f-8e51-20683fa291a1/scratchpad/bundle.js)",
+      "Bash(git check-ignore *)",
+      "Bash(git checkout *)",
+      "Read(//Users/isaacbesora/Documents/workspace/mapbox-sdk/.github/workflows/**)",
+      "Read(//Users/isaacbesora/Documents/workspace/mapbox-sdk/**)",
+      "Bash(python3 -c \"import yaml; yaml.safe_load\\(open\\('.circleci/config.yml'\\)\\)\")",
+      "Bash(python3 -c \"import yaml; yaml.safe_load\\(open\\('.github/workflows/ci.yml'\\)\\)\")",
+      "Bash(pip3 install *)",
+      "Bash(python3 -c \"import yaml; print\\('circleci', bool\\(yaml.safe_load\\(open\\('.circleci/config.yml'\\)\\)\\)\\); print\\('gha', bool\\(yaml.safe_load\\(open\\('.github/workflows/ci.yml'\\)\\)\\)\\)\")",
+      "Bash(npx tape *)",
+      "Bash(export MapboxAccessToken=pk.eyJ1IjoiaWJlc29yYS1tYXBib3giLCJhIjoiY202aHc2c2pkMDF4OTJqcXd4NnJodmdxMiJ9.ZnNRSmVKpZ67wZ7_nDhhGg)",
+      "Bash(npm test *)",
+      "Bash(timeout 30 npx browserify test/index.js -o /tmp/bundle.js)",
+      "Bash(echo \"EXIT:$?\")"
+    ]
+  }
+}

package/.eslintrc

@@ -0,0 +1,30 @@
+{
+  "parser": "@babel/eslint-parser",
+  "env": {
+    "node": true,
+    "browser": true
+  },
+  "globals": {
+    "mapboxgl": true,
+    "fs": true
+  },
+  "rules": {
+    "strict": [0],
+    "curly": [0],
+    "no-new": [0],
+    "no-alert": [0],
+    "no-extra-bind": [0],
+    "no-redeclare": [1],
+    "new-cap": [0],
+    "quotes": [2, "single"],
+    "eol-last": [0],
+    "no-mixed-requires": [0],
+    "no-path-concat": [0],
+    "camelcase": [0],
+    "consistent-return": [0],
+    "no-underscore-dangle": [0],
+    "comma-spacing": [0],
+    "key-spacing": [0],
+    "no-use-before-define": [0]
+  }
+}

package/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - run: npm ci
+
+      - run: npm run build
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist
+          retention-days: 7
+
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - run: npm ci
+
+      - run: npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - run: npm ci
+
+      - name: Install Firefox
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y firefox
+
+      - name: Run tests with Smokestack and Firefox
+        env:
+          MapboxAccessToken: ${{ secrets.MAPBOX_ACCESS_TOKEN }}
+        run: |
+          export DISPLAY=:99
+          Xvfb :99 -screen 0 1024x768x24 2> /dev/null &
+          npm test

package/.nvmrc

@@ -0,0 +1 @@
+24

package/API.md

@@ -0,0 +1,276 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+*   [MapboxDirections][1]
+    *   [Parameters][2]
+    *   [Examples][3]
+    *   [onRemove][4]
+        *   [Parameters][5]
+    *   [interactive][6]
+        *   [Parameters][7]
+    *   [getOrigin][8]
+    *   [setOrigin][9]
+        *   [Parameters][10]
+    *   [getDestination][11]
+    *   [setDestination][12]
+        *   [Parameters][13]
+    *   [reverse][14]
+    *   [addWaypoint][15]
+        *   [Parameters][16]
+    *   [setWaypoint][17]
+        *   [Parameters][18]
+    *   [removeWaypoint][19]
+        *   [Parameters][20]
+    *   [getWaypoints][21]
+    *   [removeRoutes][22]
+    *   [on][23]
+        *   [Parameters][24]
+
+## MapboxDirections
+
+The Directions control
+
+### Parameters
+
+*   `options` **[Object][25]**&#x20;
+
+    *   `options.styles` **[Array][26]?** Override default layer properties of the [directions source][27]. Documentation for each property are specified in the [Mapbox GL Style Reference][28].
+    *   `options.accessToken` **[String][29]** Required unless `mapboxgl.accessToken` is set globally (optional, default `null`)
+    *   `options.api` **[String][29]** Override default routing endpoint url (optional, default `"https://api.mapbox.com/directions/v5/"`)
+    *   `options.interactive` **[Boolean][30]** Enable/Disable mouse or touch interactivity from the plugin (optional, default `true`)
+    *   `options.profile` **[String][29]** Routing profile to use. Options: `mapbox/driving-traffic`, `mapbox/driving`, `mapbox/walking`, `mapbox/cycling` (optional, default `"mapbox/driving-traffic"`)
+    *   `options.alternatives` **[Boolean][30]** Whether to enable alternatives. (optional, default `false`)
+    *   `options.congestion` **[Boolean][30]** Whether to enable congestion along the route line. (optional, default `false`)
+    *   `options.unit` **[String][29]** Measurement system to be used in navigation instructions. Options: `imperial`, `metric` (optional, default `"imperial"`)
+    *   `options.compile` **[Function][31]** Provide a custom function for generating instruction, compatible with osrm-text-instructions. (optional, default `null`)
+    *   `options.geocoder` **[Object][25]?** Accepts an object containing the query parameters as [documented here][32].
+    *   `options.controls` **[Object][25]?**&#x20;
+
+        *   `options.controls.inputs` **[Boolean][30]** Hide or display the inputs control. (optional, default `true`)
+        *   `options.controls.instructions` **[Boolean][30]** Hide or display the instructions control. (optional, default `true`)
+        *   `options.controls.profileSwitcher` **[Boolean][30]** Hide or display the default profile switch with options for traffic, driving, walking and cycling. (optional, default `true`)
+    *   `options.instructions` **[Object][25]?**&#x20;
+
+        *   `options.instructions.showWaypointInstructions` **[Boolean][30]** Hide or display instructions for waypoints in the route (optional, default `true`)
+    *   `options.zoom` **[Number][33]** If no bbox exists from the geocoder result, the zoom you set here will be used in the flyTo. (optional, default `16`)
+    *   `options.language` **[String][29]** The language of returned turn-by-turn text instructions. See supported languages : [https://docs.mapbox.com/api/navigation/#instructions-languages][34] (optional, default `"en"`)
+    *   `options.placeholderOrigin` **[String][29]** If set, this text will appear as the placeholder attribute for the origin input element. (optional, default `"Choose a starting place"`)
+    *   `options.placeholderDestination` **[String][29]** If set, this text will appear as the placeholder attribute for the destination input element. (optional, default `"Choose destination"`)
+    *   `options.flyTo` **[Boolean][30]** If false, animating the map to a selected result is disabled. (optional, default `true`)
+    *   `options.exclude` **[String][29]** Exclude certain road types from routing. The default is to not exclude anything. Search for `exclude` in `optional parameters`: [https://docs.mapbox.com/api/navigation/#retrieve-directions][35] (optional, default `null`)
+    *   `options.routePadding` **([number][33] | PaddingOptions)** Specify padding surrounding route. A single number of pixels or a [PaddingOptions][36] object. (optional, default `80`)
+
+### Examples
+
+```javascript
+var MapboxDirections = require('../src/index');
+var directions = new MapboxDirections({
+  accessToken: 'YOUR-MAPBOX-ACCESS-TOKEN',
+  unit: 'metric',
+  profile: 'mapbox/cycling'
+});
+// add to your mapboxgl map
+map.addControl(directions);
+```
+
+Returns **[MapboxDirections][1]** `this`
+
+### onRemove
+
+Removes the control from the map it has been added to. This is called by `map.removeControl`,
+which is the recommended method to remove controls.
+
+#### Parameters
+
+*   `map` &#x20;
+
+Returns **Control** `this`
+
+### interactive
+
+Turn on or off interactivity
+
+#### Parameters
+
+*   `state` **[Boolean][30]** sets interactivity based on a state of `true` or `false`.
+
+Returns **[MapboxDirections][1]** this
+
+### getOrigin
+
+Returns the origin of the current route.
+
+Returns **[Object][25]** origin
+
+### setOrigin
+
+Sets origin. *Note:* calling this method requires the [map load event][37]
+to have run.
+
+#### Parameters
+
+*   `query` **([Array][26]<[number][33]> | [String][29])** An array of coordinates \[lng, lat] or location name as a string.
+
+Returns **[MapboxDirections][1]** this
+
+### getDestination
+
+Returns the destination of the current route.
+
+Returns **[Object][25]** destination
+
+### setDestination
+
+Sets destination. *Note:* calling this method requires the [map load event][37]
+to have run.
+
+#### Parameters
+
+*   `query` **([Array][26]<[number][33]> | [String][29])** An array of coordinates \[lng, lat] or location name as a string.
+
+Returns **[MapboxDirections][1]** this
+
+### reverse
+
+Swap the origin and destination.
+
+Returns **[MapboxDirections][1]** this
+
+### addWaypoint
+
+Add a waypoint to the route. *Note:* calling this method requires the
+[map load event][37] to have run.
+
+#### Parameters
+
+*   `index` **[Number][33]** position waypoint should be placed in the waypoint array
+*   `waypoint` **([Array][26]<[number][33]> | Point)** can be a GeoJSON Point Feature or \[lng, lat] coordinates.
+
+Returns **[MapboxDirections][1]** this;
+
+### setWaypoint
+
+Change the waypoint at a given index in the route. *Note:* calling this
+method requires the [map load event][37]
+to have run.
+
+#### Parameters
+
+*   `index` **[Number][33]** indexed position of the waypoint to update
+*   `waypoint` **([Array][26]<[number][33]> | Point)** can be a GeoJSON Point Feature or \[lng, lat] coordinates.
+
+Returns **[MapboxDirections][1]** this;
+
+### removeWaypoint
+
+Remove a waypoint from the route.
+
+#### Parameters
+
+*   `index` **[Number][33]** position in the waypoints array.
+
+Returns **[MapboxDirections][1]** this;
+
+### getWaypoints
+
+Fetch all current waypoints in a route.
+
+Returns **[Array][26]** waypoints
+
+### removeRoutes
+
+Removes all routes and waypoints from the map.
+
+Returns **[MapboxDirections][1]** this;
+
+### on
+
+Subscribe to events that happen within the plugin.
+
+#### Parameters
+
+*   `type` **[String][29]** name of event. Available events and the data passed into their respective event objects are:*   **clear** `{ type: } Type is one of 'origin' or 'destination'`
+    *   **loading** `{ type: } Type is one of 'origin' or 'destination'`
+    *   **profile** `{ profile } Profile is one of 'driving', 'walking', or 'cycling'`
+    *   **origin** `{ feature } Fired when origin is set`
+    *   **destination** `{ feature } Fired when destination is set`
+    *   **route** `{ route } Fired when a route is updated`
+    *   **error** `{ error } Error as string`
+*   `fn` **[Function][31]** function that's called when the event is emitted.
+
+Returns **[MapboxDirections][1]** this;
+
+[1]: #mapboxdirections
+
+[2]: #parameters
+
+[3]: #examples
+
+[4]: #onremove
+
+[5]: #parameters-1
+
+[6]: #interactive
+
+[7]: #parameters-2
+
+[8]: #getorigin
+
+[9]: #setorigin
+
+[10]: #parameters-3
+
+[11]: #getdestination
+
+[12]: #setdestination
+
+[13]: #parameters-4
+
+[14]: #reverse
+
+[15]: #addwaypoint
+
+[16]: #parameters-5
+
+[17]: #setwaypoint
+
+[18]: #parameters-6
+
+[19]: #removewaypoint
+
+[20]: #parameters-7
+
+[21]: #getwaypoints
+
+[22]: #removeroutes
+
+[23]: #on
+
+[24]: #parameters-8
+
+[25]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[26]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[27]: https://github.com/mapbox/mapbox-gl-directions/blob/main/src/directions_style.js
+
+[28]: https://www.mapbox.com/mapbox-gl-style-spec/
+
+[29]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[30]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[31]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[32]: https://www.mapbox.com/api-documentation/#search-for-places
+
+[33]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[34]: https://docs.mapbox.com/api/navigation/#instructions-languages
+
+[35]: https://docs.mapbox.com/api/navigation/#retrieve-directions
+
+[36]: https://docs.mapbox.com/mapbox-gl-js/api/#paddingoptions
+
+[37]: https://www.mapbox.com/mapbox-gl-js/api/#Map.load

package/CHANGELOG.md

@@ -0,0 +1,128 @@
+## 4.3.3
+- [bug] Fix unsanitized `place_name` rendering
+
+## 4.3.2
+- [bug] Fix lodash vulnerabilities
+
+## 4.3.1
+
+- [internal] Improve performance of marker dragging [#316](https://github.com/mapbox/mapbox-gl-directions/pull/316)
+
+## 4.3.0
+
+- [feature] Added option `instructions.showWaypointInstructions` to control displaying of waypoint instructions [#313](https://github.com/mapbox/mapbox-gl-directions/pull/313)
+
+## 4.2.0
+
+- [feature] Display waypoints-related instructions [#310](https://github.com/mapbox/mapbox-gl-directions/pull/310)
+- [chore] Update mapbox-gl peer dependency to support version 3 [#310](https://github.com/mapbox/mapbox-gl-directions/pull/310)
+- [chore] Fixed launching of tests [#310](https://github.com/mapbox/mapbox-gl-directions/pull/310)
+
+## 4.1.2
+
+- [chore] Update mapbox-gl peer dependency version [#298](https://github.com/mapbox/mapbox-gl-directions/pull/298)
+
+## 4.1.1
+
+- [bug] Exclude `options.api` from query params [#266](https://github.com/mapbox/mapbox-gl-directions/pull/266)
+- [bug] Catch 'No Route found' response [#278](https://github.com/mapbox/mapbox-gl-directions/pull/278)
+* [bug] Abort request after `removeRoutes()` is called [#285](https://github.com/mapbox/mapbox-gl-directions/pull/285)
+* [bug] Fix mixed duration and distance values [#271](https://github.com/mapbox/mapbox-gl-directions/pull/271)
+
+## 4.1.0
+- Adds routePadding option to MapboxDirections object [#243](https://github.com/mapbox/mapbox-gl-directions/pull/243)
+- Fixes bug that showed dropdown suggestions when reversing route [#246](https://github.com/mapbox/mapbox-gl-directions/pull/246)
+
+## 4.0.3
+- Adds exclude parameter [#233](https://github.com/mapbox/mapbox-gl-directions/pull/233)
+
+## 4.0.2
+- Adds language parameter to allow turn-by-turn instructions in other [supported languages](https://docs.mapbox.com/api/navigation/#instructions-languages)
+
+## 4.0.1
+- Update packages to resolve polyline dependency
+- Update peerDependency for Mapbox-GL-JS to support v1.0 release
+- Switch to `yarn` to workaround `sockjs-client` dependency issue
+
+## 4.0.0
+- [Refactor] options passed to internal Geocoder class
+  - Made options.geocoder dynamic, accepting only query parameters from the Geocoding API
+  - Removed placeholder option in favor of placeholderOrigin and placeholderDestination
+  - Added top level options flyTo, zoom, placeholderOrigin and placeholderDestination
+- [Chore] Update packages to resolve vulnerabilities in smokestack
+
+## 3.1.3
+- [bug] Bump package `suggestions` to support autocompletion on quick keypress.[#179](https://github.com/mapbox/mapbox-gl-directions/pull/179)
+
+## 3.1.2
+- [workaround] Include `/dist` directory in published NPM package
+
+## 3.1.1
+
+- [bug] Fixes css for turn instruction icons
+
+## 3.1.0
+
+- [internal] upgrade to v5 of the Mapbox Directions API
+- [feature] add traffic aware driving directions profile
+
+## 3.0.3
+
+- [bug] re-enable hiding instructions panel [#101](https://github.com/mapbox/mapbox-gl-directions/issues/101)
+
+## 3.0.2
+
+- [bug] Fixing a fix for `3.0.1`. Missed a single space.
+
+## 3.0.1
+
+- [bug] CSS fix for departure/arrival icons that were not center aligned because of global line-height properties
+
+## 3.0.0
+
+Support for the Mapbox GL JS 0.27.0 API. This is compatible with 0.27.0 and later, and not compatible with earlier versions.
+
+- [breaking] `container` option removed - attaching the control outside of the map is no longer supported
+- [breaking] `position` option removed - the `addControl` method now specifies the position
+- [breaking] Now exports `MapboxDirections` rather than attaches to `mapbox.Directions`
+- [internal] no longer creates a new map control for each of the two geocoders, instead creates two internal geocoders
+- [feature] `removeRoutes` method that removes all route lines, waypoints, and instructions
+
+## 2.2.0
+- [feature] Defer mapboxgl dependency til runtime to support webpack async loading #86 https://github.com/mapbox/mapbox-gl-directions/pull/86
+- [bug] Fix mapboxgl.GeoJSONSource deprecation in gl-js v.22 and map.load race condition
+
+## 2.1.0
+
+- [bug] Warn if mapboxgl is not present [#66](https://github.com/mapbox/mapbox-gl-directions/issues/66)
+- [bug] Point `main` in `package.json` to transpiled result [#63](https://github.com/mapbox/mapbox-gl-directions/issues/63)
+- [feature] Wrap coordinates outside of -180, 180 [#54]((https://github.com/mapbox/mapbox-gl-directions/issues/54)
+- [feature] Basic support for touch handling [#61](https://github.com/mapbox/mapbox-gl-directions/issues/61)
+- [feature] Allow interaction to be toggled on or off [#65](https://github.com/mapbox/mapbox-gl-directions/issues/65)
+- [feature] Allow controls to be removed on initialization.
+- [internal] Refactor out native DOM and use registered mapbox-gl-js ones.
+- [internal] Remove custom implementation of a geocoder and use mapbox-gl-geocoder.
+- [internal] Use plain XMLHttpRequest for direction queries.
+
+## 2.0.0
+
+- [breaking] Drop `directions` prefix from event names [#59](https://github.com/mapbox/mapbox-gl-directions/issues/59)
+- [bug] Fix loading UI state and clearing past geocoded results [#58](https://github.com/mapbox/mapbox-gl-directions/pull/58)
+- [breaking] Update `peerDependencies` to use mapbox-gl-js@v0.16.0 [#56](https://github.com/mapbox/mapbox-gl-directions/issues/56)
+- [feature] Zoom to bounds if exist on origin or destination geocode [#46](https://github.com/mapbox/mapbox-gl-directions/issues/46)
+- [feature] Pass custom styles in options argument [#45](https://github.com/mapbox/mapbox-gl-directions/issues/45)
+- [bug] Fix points where a geocoded request is not found. Pass coordinates in request [#43](https://github.com/mapbox/mapbox-gl-directions/issues/43)
+
+## 1.0.0
+
+- [bug] Infer container if no element is passed [#30](https://github.com/mapbox/mapbox-gl-directions/issues/30)
+- [feature] Pass `container` as an options param [#30](https://github.com/mapbox/mapbox-gl-directions/issues/30)
+- [breaking] Change `proximity` option to [lng, lat] format [#29](https://github.com/mapbox/mapbox-gl-directions/issues/29)
+- [feature] Toggle routes from sidebar listing [#28](https://github.com/mapbox/mapbox-gl-directions/issues/28)
+- [ui] Target mobile devices with media queries [#26](https://github.com/mapbox/mapbox-gl-directions/issues/26)
+- [ui] Add loading state to input queries [#25](https://github.com/mapbox/mapbox-gl-directions/issues/25)
+- [ui] Display routing errors in the instructions panel [#24](https://github.com/mapbox/mapbox-gl-directions/issues/24)
+
+## 0.0.0
+
+- Initial commit

package/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+### Developing
+
+    npm install & npm start & open http://localhost:9966/
+
+You'll need a [Mapbox access token](https://www.mapbox.com/help/create-api-access-token/) stored in localstorage. Set it via
+
+    localStorage.setItem('MapboxAccessToken', '<YOUR ACCESS TOKEN>');
+
+### Testing
+
+Tests require an MapboxAccessToken env variable to be set.
+
+    export MapboxAccessToken=<YOUR ACCESS TOKEN> && npm test
+
+### Release process
+
+1. `git checkout main`
+1. `git pull --rebase --autostash` to ensure you have the latest changes.
+1. `export MapboxAccessToken=<YOUR ACCESS TOKEN> && npm test`
+1. Update [`CHANGELOG.md`](https://github.com/mapbox/mapbox-gl-directions/blob/main/CHANGELOG.md)
+1. `npm version {major|minor|patch}`
+1. Create a release branch off of master that updates `CHANGELOG.md` and increments `package.json`.
+1. `git push --follow-tags`
+1. `mbx npm publish`
+1. Update version number on [GL JS example page](https://github.com/mapbox/mapbox-gl-js/blob/mb-pages/docs/_posts/examples/3400-01-11-mapbox-gl-directions.html)

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2015, Mapbox
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,3 +1,57 @@
-# Temporary Holding Version
+Mapbox GL Directions
+---
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A full featured directions plugin for [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) using the [Mapbox Directions API](https://www.mapbox.com/directions/). Quickly add UI to display driving, cycling, or walking directions on the map.
+
+For directions functionality in native mobile and desktop applications, see [Mapbox Android Services](https://github.com/mapbox/mapbox-java/), [MapboxDirections.swift](https://github.com/mapbox/MapboxDirections.swift/), and [MapboxNavigation.swift](https://github.com/mapbox/MapboxNavigation.swift/).
+
+### Usage
+
+```javascript
+var mapboxgl = require('@ohos-ports/mapbox-gl');
+var MapboxDirections = require('@ohos-ports/mapbox-gl-directions');
+
+var directions = new MapboxDirections({
+  accessToken: 'YOUR-MAPBOX-ACCESS-TOKEN',
+  unit: 'metric',
+  profile: 'mapbox/cycling'
+});
+
+var map = new mapboxgl.Map({
+  container: 'map'
+});
+
+map.addControl(directions, 'top-left');
+```
+
+Live example: https://www.mapbox.com/mapbox-gl-js/example/mapbox-gl-directions/
+
+### Deeper dive
+
+See [API.md](https://github.com/mapbox/mapbox-gl-directions/blob/master/API.md) for complete reference.
+
+### Contributing
+
+See [CONTRIBUTING.md](https://github.com/mapbox/mapbox-gl-directions/blob/master/CONTRIBUTING.md).
+
+## Publishing
+To GitHub and NPM:
+
+```
+npm version (major|minor|patch)
+git push --tags
+git push
+npm publish
+```
+
+To CDN:
+
+```
+# make sure you are authenticated for AWS
+git checkout v{x.y.z}
+npm ci
+npm run prepublish
+aws s3 cp --recursive --acl public-read dist s3://mapbox-gl-js/plugins/mapbox-gl-directions/v{x.y.z}
+```
+
+Update the version number in the [GL JS example](https://docs.mapbox.com/mapbox-gl-js/example/mapbox-gl-directions/).