@maplibre/maplibre-react-native 10.0.0-alpha.25 → 10.0.0-alpha.26

package/docs/UserLocation.md

@@ -1,9 +1,9 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/components/UserLocation.tsx -->
-## <MapLibreGL.UserLocation />
-### 
+# `<MapLibreGL.UserLocation />`
 
-### props
+
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | animated | `boolean` | `true` | `false` | Whether location icon is animated between updates |
@@ -15,16 +15,16 @@
 | androidPreferredFramesPerSecond | `number` | `none` | `false` | Android only. Set max FPS at which location animators can output updates. Use this setting to limit animation rate of the location puck on higher zoom levels to decrease the stress on the device's CPU which can directly improve battery life, without sacrificing UX.<br/><br/>@platform android |
 | children | `ReactElement \| ReactElement[]` | `none` | `false` | Custom location icon of type mapbox-gl-native components<br/><br/>NOTE: Forking maintainer does not understand the above comment. |
 
-### methods
-#### setLocationManager({
+## Methods
+### `setLocationManager({
   running,
 }: {
   running: boolean;
-})
+})`
 
 Whether to start or stop listening to the locationManager<br/><br/>Notice, that listening will start automatically when<br/>either `onUpdate` or `visible` are set
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `{
@@ -34,14 +34,10 @@ Whether to start or stop listening to the locationManager<br/><br/>Notice, that
 }` | `{running:boolean;}` | `Yes` | undefined |
 
 
-#### needsLocationManagerRunning()
+### `needsLocationManagerRunning()`
 
 If locationManager should be running
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 

package/docs/VectorSource.md

@@ -1,9 +1,9 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/components/VectorSource.tsx -->
-## <MapLibreGL.VectorSource />
-### VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification.
+# `<MapLibreGL.VectorSource />`
+VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification.
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | id | `string` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
@@ -19,12 +19,12 @@
 | &nbsp;&nbsp;height | `number` | `none` | `true` | `height` of hitbox |
 | children | `React.ReactElement \| React.ReactElement[]` | `none` | `false` | FIX ME NO DESCRIPTION |
 
-### methods
-#### features([layerIDs], [filter])
+## Methods
+### `features([layerIDs], [filter])`
 
 Returns all features that match the query parameters regardless of whether or not the feature is<br/>currently rendered on the map. The domain of the query includes all currently-loaded vector tiles<br/>and GeoJSON source tiles. This function does not check tiles outside of the visible viewport.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `layerIDs` | `Array` | `No` | A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array. |
@@ -37,11 +37,11 @@ vectorSource.features(['id1', 'id2'])
 ```
 
 
-#### onPress(event)
+### `onPress(event)`
 
 
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `event` | `NativeSyntheticEvent` | `Yes` | undefined |

package/docs/coordinates.md

@@ -1,7 +1,7 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/modules/location/locationManager.ts -->
-## <MapLibreGL.coordinates />
-### Coorinates sent by locationManager
+# `<MapLibreGL.coordinates />`
+Coorinates sent by locationManager
 
 
 

package/docs/location.md

@@ -1,7 +1,7 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/modules/location/locationManager.ts -->
-## <MapLibreGL.location />
-### Location sent by locationManager
+# `<MapLibreGL.location />`
+Location sent by locationManager
 
 
 

package/docs/offlineManager.md

@@ -1,15 +1,15 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/modules/offline/offlineManager.ts -->
-## <MapLibreGL.offlineManager />
-### OfflineManager implements a singleton (shared object) that manages offline packs.<br/>All of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.<br/>The shared object maintains a canonical collection of offline packs.
+# `<MapLibreGL.offlineManager />`
+OfflineManager implements a singleton (shared object) that manages offline packs.<br/>All of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.<br/>The shared object maintains a canonical collection of offline packs.
 
 
-### methods
-#### createPack(options, [progressListener], [errorListener])
+## Methods
+### `createPack(options, [progressListener], [errorListener])`
 
 Creates and registers an offline pack that downloads the resources needed to use the given region offline.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `options` | `OfflineCreatePackOptions` | `Yes` | Create options for a offline pack that specifices zoom levels, style url, and the region to download. |
@@ -32,11 +32,11 @@ await MapLibreGL.offlineManager.createPack({
 ```
 
 
-#### invalidatePack(name)
+### `invalidatePack(name)`
 
 Invalidates the specified offline pack. This method checks that the tiles in the specified offline pack match those from the server. Local tiles that do not match the latest version on the server are updated.This is more efficient than deleting the offline pack and downloading it again. If the data stored locally matches that on the server, new data will not be downloaded.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `name` | `String` | `Yes` | Name of the offline pack. |
@@ -48,11 +48,11 @@ await MapLibreGL.offlineManager.invalidatePack('packName')
 ```
 
 
-#### deletePack(name)
+### `deletePack(name)`
 
 Unregisters the given offline pack and allows resources that are no longer required by any remaining packs to be potentially freed.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `name` | `String` | `Yes` | Name of the offline pack. |
@@ -64,14 +64,10 @@ await MapLibreGL.offlineManager.deletePack('packName')
 ```
 
 
-#### invalidateAmbientCache()
+### `invalidateAmbientCache()`
 
 Forces a revalidation of the tiles in the ambient cache and downloads a fresh version of the tiles from the tile server.<br/>This is the recommend method for clearing the cache.<br/>This is the most efficient method because tiles in the ambient cache are re-downloaded to remove outdated data from a device.<br/>It does not erase resources from the ambient cache or delete the database, which can be computationally expensive operations that may carry unintended side effects.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 
@@ -80,14 +76,10 @@ await MapLibreGL.offlineManager.invalidateAmbientCache();
 ```
 
 
-#### clearAmbientCache()
+### `clearAmbientCache()`
 
 Erases resources from the ambient cache.<br/>This method clears the cache and decreases the amount of space that map resources take up on the device.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 
@@ -96,11 +88,11 @@ await MapLibreGL.offlineManager.clearAmbientCache();
 ```
 
 
-#### setMaximumAmbientCacheSize(size)
+### `setMaximumAmbientCacheSize(size)`
 
 Sets the maximum size of the ambient cache in bytes. Disables the ambient cache if set to 0.<br/>This method may be computationally expensive because it will erase resources from the ambient cache if its size is decreased.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `size` | `Number` | `Yes` | Size of ambient cache. |
@@ -112,14 +104,10 @@ await MapLibreGL.offlineManager.setMaximumAmbientCacheSize(5000000);
 ```
 
 
-#### resetDatabase()
+### `resetDatabase()`
 
 Deletes the existing database, which includes both the ambient cache and offline packs, then reinitializes it.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 
@@ -128,14 +116,10 @@ await MapLibreGL.offlineManager.resetDatabase();
 ```
 
 
-#### getPacks()
+### `getPacks()`
 
 Retrieves all the current offline packs that are stored in the database.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 
@@ -144,11 +128,11 @@ const offlinePacks = await MapLibreGL.offlineManager.getPacks();
 ```
 
 
-#### getPack(name)
+### `getPack(name)`
 
 Retrieves an offline pack that is stored in the database by name.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `name` | `String` | `Yes` | Name of the offline pack. |
@@ -160,11 +144,11 @@ const offlinePack = await MapLibreGL.offlineManager.getPack();
 ```
 
 
-#### mergeOfflineRegions(path)
+### `mergeOfflineRegions(path)`
 
 Sideloads offline db
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `path` | `String` | `Yes` | Path to offline tile db on file system. |
@@ -176,11 +160,11 @@ await MapLibreGL.offlineManager.mergeOfflineRegions(path);
 ```
 
 
-#### setTileCountLimit(limit)
+### `setTileCountLimit(limit)`
 
 Sets the maximum number of tiles that may be downloaded and stored on the current device.<br/>Consult the Terms of Service for your map tile host before changing this value.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `limit` | `Number` | `Yes` | Map tile limit count. |
@@ -192,11 +176,11 @@ MapLibreGL.offlineManager.setTileCountLimit(1000);
 ```
 
 
-#### setProgressEventThrottle(throttleValue)
+### `setProgressEventThrottle(throttleValue)`
 
 Sets the period at which download status events will be sent over the React Native bridge.<br/>The default is 500ms.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `throttleValue` | `Number` | `Yes` | event throttle value in ms. |
@@ -208,11 +192,11 @@ MapLibreGL.offlineManager.setProgressEventThrottle(500);
 ```
 
 
-#### subscribe(packName, progressListener, errorListener)
+### `subscribe(packName, progressListener, errorListener)`
 
 Subscribe to download status/error events for the requested offline pack.<br/>Note that createPack calls this internally if listeners are provided.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `packName` | `String` | `Yes` | Name of the offline pack. |
@@ -228,11 +212,11 @@ MapLibreGL.offlineManager.subscribe('packName', progressListener, errorListener)
 ```
 
 
-#### unsubscribe(packName)
+### `unsubscribe(packName)`
 
 Unsubscribes any listeners associated with the offline pack.<br/>It's a good idea to call this on componentWillUnmount.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `packName` | `String` | `Yes` | Name of the offline pack. |

package/docs/snapshotManager.md

@@ -1,15 +1,15 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/modules/snapshot/snapshotManager.ts -->
-## <MapLibreGL.snapshotManager />
-### The snapshotManager generates static raster images of the map.<br/>Each snapshot image depicts a portion of a map defined by an SnapshotOptions object you provide.<br/>The snapshotter generates the snapshot asynchronous.
+# `<MapLibreGL.snapshotManager />`
+The snapshotManager generates static raster images of the map.<br/>Each snapshot image depicts a portion of a map defined by an SnapshotOptions object you provide.<br/>The snapshotter generates the snapshot asynchronous.
 
 
-### methods
-#### takeSnap(options)
+## Methods
+### `takeSnap(options)`
 
 Takes a snapshot of the base map using the provided Snapshot options. NOTE pitch, heading, zoomLevel only works when centerCoordinate is set!
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `options` | `SnapshotOptions` | `Yes` | Snapshot options for create a static image of the base map |

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maplibre/maplibre-react-native",
   "description": "React Native library for creating maps with MapLibre Native for Android & iOS",
-  "version": "10.0.0-alpha.25",
+  "version": "10.0.0-alpha.26",
   "publishConfig": {
     "access": "public"
   },
@@ -30,9 +30,13 @@
     "plugin:build": "tsc --build plugin",
     "plugin:lint": "eslint plugin/src/*",
     "plugin:test": "jest plugin",
-    "prepack": "pinst --disable && yarn plugin:build",
-    "postpack": "pinst --enable"
+    "prepack": "yarn plugin:build"
   },
+  "workspaces": [
+    "apps/*",
+    "packages/*"
+  ],
+  "packageManager": "yarn@4.1.0",
   "peerDependenciesMeta": {
     "@expo/config-plugins": {
       "optional": true
@@ -61,7 +65,7 @@
     "@babel/eslint-parser": "^7.22.9",
     "@babel/plugin-proposal-class-properties": "7.18.6",
     "@babel/runtime": "7.17.2",
-    "@expo/config-plugins": "^8.0.10",
+    "@expo/config-plugins": "^9.0.9",
     "@maplibre/maplibre-gl-style-spec": "21.1.0",
     "@react-native/babel-preset": "^0.74.88",
     "@react-native/metro-config": "^0.74.88",
@@ -76,12 +80,9 @@
     "ejs-lint": "^2.0.0",
     "eslint": "^8.57.1",
     "eslint-config-universe": "13.0.0",
-    "expo-module-scripts": "^3.1.0",
-    "husky": "^9.0.10",
+    "expo-module-scripts": "^4.0.2",
     "jest": "^29.7.0",
     "jest-cli": "^29.7.0",
-    "lint-staged": "^15.2.2",
-    "pinst": "^3.0.0",
     "prettier": "3.3.3",
     "react": "18.2.0",
     "react-docgen": "^7.1.0",
@@ -92,13 +93,5 @@
   },
   "resolutions": {
     "typescript": "5.5.3"
-  },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx}": "yarn lint"
-  },
-  "packageManager": "yarn@4.1.0",
-  "workspaces": [
-    "apps/*",
-    "packages/*"
-  ]
+  }
 }

package/scripts/codegen.ts

@@ -22,7 +22,6 @@ const ANDROID_OUTPUT_PATH = path.join(
   __dirname,
   "..",
   "android",
-  "rctmln",
   "src",
   "main",
   "java",

package/scripts/templates/component.md.ejs

@@ -4,121 +4,122 @@
 -%>
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from <%- component.filePath %> -->
-## <MapLibreGL.<%- component.name %> />
-### <%- helpers.replaceNewLine(component.description) %>
+# `<MapLibreGL.<%- component.name %> />`
+<%- helpers.replaceNewLine(component.description) %>
 
 <%_ if (component.props && component.props.length) { _%>
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 <%- helpers.propMarkdownTableRows(component) %>
 <%_ } _%>
 
 <%_ if (component.methods && component.methods.length) { _%>
-### methods
+## Methods
 <%_ for (let method of component.methods) { _%>
-#### <%- helpers.getMarkdownMethodSignature(method) %>
+### <%- helpers.getMarkdownMethodSignature(method) %>
 
 <%- helpers.replaceNewLine(method.description) %>
 
-##### arguments
+<%_ if (method.params && method.params.length) { _%>
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 <%- helpers.methodMarkdownTableRow(method) %>
+<%_ } _%>
 
 <%- helpers.getMarkdownMethodExamples(method) %>
 <%_ } _%>
 <%_ } _%>
 
 <%_ if (component.styles && component.styles.length) { _%>
-### styles
+## Styles
 
 <%_ for (let i = 0; i < component.styles.length; i++) { _%>
 <%
 const style = component.styles[i];
 -%>
-* <a href="#name<%- i > 0 ? '-' + i : '' -%>"><%- style.name %></a><br/>
+* <a href="#name<%- i > 0 ? '-' + i : '' -%>">`<%- style.name %>`</a><br/>
 <%_ } _%>
 
 <%_ for (let style of component.styles) { _%>
-___
 
-#### Name
-`<%- style.name %>`
+### `<%- style.name %>`
 
-#### Description
 <%- style.description %>
 
-#### Type
-`<%- style.type %>`
-<%_ if (helpers.exists(style.default)) { _%>
-#### Default Value
-`<%= helpers.getStyleDefaultValue(style) %>`
-<%_ } _%>
-
-<%_ if (style.type === 'enum') { _%>
-#### Supported Values
-<%_ for (var i = 0; i < style.values.length; i++) { _%>
-**<%- style.values[i].value %>** - <%- style.values[i].doc %><br />
-<%_ } _%>
-
-<%_ } _%>
-<%_ if (helpers.exists(style.units)) { _%>
-#### Units
-`<%- style.units %>`
-
-<%_ } _%>
-<%_ if (helpers.exists(style.minimum)) { _%>
-#### Minimum
-`<%- style.minimum %>`
-
-<%_ } _%>
-
-<%_ if (helpers.exists(style.maximum)) { _%>
-#### Maximum
-`<%- style.maximum %>`
-
-<%_ } _%>
-<%_ if (style.requires.length) { _%>
-#### Requires
-`<%- style.requires.join(', ') %>`
-
-<%_ } _%>
-<%_ if (style.disabledBy.length) { _%>
-#### Disabled By
-`<%- style.disabledBy.join(', ') %>`
-
-<%_ } _%>
-<%_ if (style.allowedFunctionTypes.length) { _%>
-#### Supported Style Functions
-`<%- style.allowedFunctionTypes.join(', ') %>`
-<%_ } _%>
-<%_ if (style.expression) { _%>
-#### Expression
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code><%- style.type %></code>
+    </dd>
+    <%_ if (helpers.exists(style.default)) { _%>
+        <dt>Default Value</dt>
+        <dd><code><%= helpers.getStyleDefaultValue(style) %></code></dd>
+    <%_ } _%>
+    <%_ if (style.type === 'enum') { _%>
+    <dt>Supported Values</dt>
+    <dd>
+        <ul>
+            <%_ for (var i = 0; i < style.values.length; i++) { _%>
+                <li>
+                    <code><%- style.values[i].value %></code>: <%- style.values[i].doc %>
+                </li>
+            <%_ } _%>
+            <%_ } _%>
+        </ul>
+    </dd>
+    <%_ if (helpers.exists(style.units)) { _%>
+        <dt>Units</dt>
+        <dd><code><%- style.units %></code></dd>
+    <%_ } _%>
+    <%_ if (helpers.exists(style.minimum)) { _%>
+        <dt>Minimum</dt>
+        <dd><code><%- style.minimum %></code></dd>
+    <%_ } _%>
+    <%_ if (helpers.exists(style.maximum)) { _%>
+        <dt>Maximum</dt>
+        <dd><code><%- style.maximum %></code></dd>
+    <%_ } _%>
+    <%_ if (style.requires.length) { _%>
+        <dt>Requires</dt>
+        <dd><code><%- style.requires.join(', ') %></code></dd>
+    <%_ } _%>
+    <%_ if (style.disabledBy.length) { _%>
+        <dt>Disabled By</dt>
+        <dd><code><%- style.disabledBy.join(', ') %></code></dd>
+    <%_ } _%>
+    <%_ if (style.allowedFunctionTypes.length) { _%>
+        <dt>Supported Style Functions</dt>
+        <dd><code><%- style.allowedFunctionTypes.join(', ') %></code></dd>
+    <%_ } _%>
+    <%_ if (style.expression) { _%>
+        <dt>Expression Parameters</dt>
+        <dd><code><%- (style.expression.parameters || []).join(', ') %></code></dd>
+    <%_ } _%>
+</dl>
 
-Parameters: `<%- (style.expression.parameters || []).join(', ') %>`
-<%_ } _%>
 <%_ if (style.transition) { _%>
-___
-
-#### Name
-
-`<%- style.name %>Transition`
-
-#### Description
-
-The transition affecting any changes to this layer’s <%- style.name %> propery.
-
-#### Type
-
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
+### `<%- style.name %>Transition`
+
+The transition affecting any changes to this layer’s <%- style.name %> property.
+
+<dl>
+  <dt>Type</dt>
+  <dd>
+    <code>{ duration, delay }</code>
+  </dd>
+
+  <dt>Units</dt>
+  <dd>
+    <code>milliseconds</code>
+  </dd>
+
+  <dt>Default Value</dt>
+  <dd>
+    <code>{duration: 300, delay: 0}</code>
+  </dd>
+</dl>
 <%_ } %>
 <%_ } _%>
 <%_ } _%>

package/scripts/utils/TemplateHelpers.ts

@@ -461,7 +461,7 @@ export function getMarkdownMethodSignature(method: {
     .map((param) => (param.optional ? `[${param.name}]` : param.name))
     .join(", ");
 
-  return `${method.name}(${params})`;
+  return `\`${method.name}(${params})\``;
 }
 
 export function getMarkdownMethodExamples(method: any) {

package/scripts/utils/getNativeVersion.ts

@@ -20,7 +20,7 @@ let cachedIosVersion: string;
 export const getAndroidVersion = async () => {
   if (!cachedAndroidVersion) {
     cachedAndroidVersion = await getNativeVersion(
-      ["android", "rctmln", "build.gradle"],
+      ["android", "build.gradle"],
       /^\s+implementation\s+"org.maplibre.gl:android-sdk:(\d+\.\d+\.\d+)"$/,
     );
   }

package/.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-yarn lint-staged
-yarn codegen

package/android/rctmln/.settings/org.eclipse.buildship.core.prefs

@@ -1,2 +0,0 @@
-connection.project.dir=../../packages/react-native-app/android
-eclipse.preferences.version=1