@maplibre/maplibre-react-native 11.0.0-beta.3 → 11.0.0-beta.31

package/src/modules/offline/OfflineManager.ts

@@ -36,9 +36,10 @@ export type OfflinePackErrorListener = (
 ) => void;
 
 /**
- * OfflineManager implements a singleton (shared object) that manages offline packs.
- * All of this class's instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.
- * The shared object maintains a canonical collection of offline packs.
+ * OfflineManager implements a singleton (shared object) that manages offline
+ * packs. All of this class's instance methods are asynchronous, reflecting the
+ * fact that offline resources are stored in a database. The shared object
+ * maintains a canonical collection of offline packs.
  */
 class OfflineManager {
   private initialized: boolean;
@@ -70,26 +71,36 @@ class OfflineManager {
   }
 
   /**
-   * Creates and registers an offline pack that downloads the resources needed to use the given region offline.
+   * Creates and registers an offline pack that downloads the resources needed to
+   * use the given region offline.
    *
-   * @example
-   *
-   * const progressListener = (offlineRegion, status) => console.log(offlineRegion, status);
-   * const errorListener = (offlineRegion, error) => console.log(offlineRegion, error);
-   *
-   * const offlinePack = await OfflineManager.createPack({
-   *   mapStyle: 'https://demotiles.maplibre.org/tiles/tiles.json',
-   *   minZoom: 14,
-   *   maxZoom: 20,
-   *   bounds: [west, south, east, north],
-   *   metadata: { customValue: 'myValue' }
-   * }, progressListener, errorListener)
+   * @param options - Create options for offline pack that specifies zoom levels, style url, and
+   *   the region to download.
+   * @param progressListener - Callback that listens for status events while downloading the offline
+   *   resource.
+   * @param errorListener - Callback that listens for status events while downloading the offline
+   *   resource.
+   * @returns The created offline pack with its generated ID.
    *
-   * @param options Create options for offline pack that specifies zoom levels, style url, and the region to download.
-   * @param  progressListener Callback that listens for status events while downloading the offline resource.
-   * @param  errorListener Callback that listens for status events while downloading the offline resource.
+   * @example
+   * ```ts
+   * const progressListener = (offlineRegion, status) =>
+   *   console.log(offlineRegion, status);
+   * const errorListener = (offlineRegion, error) =>
+   *   console.log(offlineRegion, error);
    *
-   * @return The created offline pack with its generated ID.
+   * const offlinePack = await OfflineManager.createPack(
+   *   {
+   *     mapStyle: "https://demotiles.maplibre.org/tiles/tiles.json",
+   *     minZoom: 14,
+   *     maxZoom: 20,
+   *     bounds: [west, south, east, north],
+   *     metadata: { customValue: "myValue" },
+   *   },
+   *   progressListener,
+   *   errorListener,
+   * );
+   * ```
    */
   async createPack(
     options: OfflinePackCreateOptions,
@@ -117,14 +128,20 @@ class OfflineManager {
   }
 
   /**
-   * 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.
+   * 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.
+   * 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.
    *
-   * @example
-   * await OfflineManager.invalidatePack(pack.id)
+   * @param id - ID of the OfflinePack.
    *
-   * @param id ID of the OfflinePack.
+   * @example
+   * ```ts
+   * await OfflineManager.invalidatePack(pack.id);
+   * ```
    */
   async invalidatePack(id: string): Promise<void> {
     await this.initialize();
@@ -134,12 +151,15 @@ class OfflineManager {
   }
 
   /**
-   * Unregisters the given OfflinePack and allows resources that are no longer required by any remaining packs to be potentially freed.
+   * Unregisters the given OfflinePack and allows resources that are no longer
+   * required by any remaining packs to be potentially freed.
    *
-   * @example
-   * await OfflineManager.deletePack(pack.id)
+   * @param id - ID of the OfflinePack.
    *
-   * @param id  ID of the OfflinePack.
+   * @example
+   * ```ts
+   * await OfflineManager.deletePack(pack.id);
+   * ```
    */
   async deletePack(id: string): Promise<void> {
     await this.initialize();
@@ -150,13 +170,18 @@ class OfflineManager {
   }
 
   /**
-   * Forces a revalidation of the tiles in the ambient cache and downloads a fresh version of the tiles from the tile server.
-   * This is the recommend method for clearing the cache.
-   * This is the most efficient method because tiles in the ambient cache are re-downloaded to remove outdated data from a device.
-   * 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.
+   * Forces a revalidation of the tiles in the ambient cache and downloads a fresh
+   * version of the tiles from the tile server. This is the recommend method for
+   * clearing the cache. This is the most efficient method because tiles in the
+   * ambient cache are re-downloaded to remove outdated data from a device. 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.
    *
    * @example
+   * ```ts
    * await OfflineManager.invalidateAmbientCache();
+   * ```
    */
   async invalidateAmbientCache(): Promise<void> {
     await this.initialize();
@@ -164,11 +189,13 @@ class OfflineManager {
   }
 
   /**
-   * Erases resources from the ambient cache.
-   * This method clears the cache and decreases the amount of space that map resources take up on the device.
+   * Erases resources from the ambient cache. This method clears the cache and
+   * decreases the amount of space that map resources take up on the device.
    *
    * @example
+   * ```ts
    * await OfflineManager.clearAmbientCache();
+   * ```
    */
   async clearAmbientCache(): Promise<void> {
     await this.initialize();
@@ -176,13 +203,14 @@ class OfflineManager {
   }
 
   /**
-   * Sets the maximum size of the ambient cache in bytes. Disables the ambient cache if set to 0.
-   * This method may be computationally expensive because it will erase resources from the ambient cache if its size is decreased.
+   * Sets the maximum size of the ambient cache in bytes. Disables the ambient
+   * cache if set to 0. This method may be computationally expensive because it
+   * will erase resources from the ambient cache if its size is decreased.
+   *
+   * @param size - Size of ambient cache.
    *
    * @example
    * await OfflineManager.setMaximumAmbientCacheSize(5000000);
-   *
-   * @param    size  Size of ambient cache.
    */
   async setMaximumAmbientCacheSize(size: number): Promise<void> {
     await this.initialize();
@@ -190,10 +218,13 @@ class OfflineManager {
   }
 
   /**
-   * Deletes the existing database, which includes both the ambient cache and offline packs, then reinitializes it.
+   * Deletes the existing database, which includes both the ambient cache and
+   * offline packs, then reinitializes it.
    *
    * @example
+   * ```ts
    * await OfflineManager.resetDatabase();
+   * ```
    */
   async resetDatabase(): Promise<void> {
     await this.initialize();
@@ -216,7 +247,9 @@ class OfflineManager {
    * Retrieves an offline pack that is stored in the database by ID.
    *
    * @example
+   * ```ts
    * const offlinePack = await OfflineManager.getPack(offlinePack.id);
+   * ```
    */
   async getPack(id: string): Promise<OfflinePack> {
     await this.initialize();
@@ -232,10 +265,12 @@ class OfflineManager {
   /**
    * Sideloads offline db
    *
+   * @param path - Path to offline tile db on file system.
+   *
    * @example
+   * ```ts
    * await OfflineManager.mergeOfflineRegions(path);
-   *
-   * @param path Path to offline tile db on file system.
+   * ```
    */
   async mergeOfflineRegions(path: string): Promise<void> {
     await this.initialize();
@@ -243,26 +278,31 @@ class OfflineManager {
   }
 
   /**
-   * Sets the maximum number of tiles that may be downloaded and stored on the current device.
-   * Consult the Terms of Service for your map tile host before changing this value.
+   * Sets the maximum number of tiles that may be downloaded and stored on the
+   * current device. Consult the Terms of Service for your map tile host before
+   * changing this value.
+   *
+   * @param limit - Map tile limit count.
    *
    * @example
+   * ```ts
    * OfflineManager.setTileCountLimit(1000);
-   *
-   * @param limit Map tile limit count.
+   * ```
    */
   setTileCountLimit(limit: number): void {
     NativeOfflineModule.setTileCountLimit(limit);
   }
 
   /**
-   * Sets the period at which download status events will be sent over the React Native bridge.
-   * The default is 500ms.
+   * Sets the period at which download status events will be sent over the React
+   * Native bridge. The default is 500ms.
+   *
+   * @param throttleValue - Event throttle value in ms.
    *
    * @example
+   * ```ts
    * OfflineManager.setProgressEventThrottle(500);
-   *
-   * @param throttleValue Event throttle value in ms.
+   * ```
    */
   setProgressEventThrottle(throttleValue: number): void {
     NativeOfflineModule.setProgressEventThrottle(throttleValue);
@@ -272,14 +312,19 @@ class OfflineManager {
    * Subscribe to download status/error events for the requested offline pack.
    * Note that createPack calls this internally if listeners are provided.
    *
-   * @example
-   * const progressListener = (offlinePack, status) => console.log(offlinePack, status)
-   * const errorListener = (offlinePack, error) => console.log(offlinePack, error)
-   * OfflineManager.addListener(pack.id, progressListener, errorListener)
+   * @param id - ID of the offline pack.
+   * @param progressListener - Callback that listens for status events while downloading the offline
+   *   resource.
+   * @param errorListener - Callback that listens for status events while downloading the offline
+   *   resource.
    *
-   * @param  id           ID of the offline pack.
-   * @param  progressListener Callback that listens for status events while downloading the offline resource.
-   * @param  errorListener      Callback that listens for status events while downloading the offline resource.
+   * @example
+   * ```ts
+   * const progressListener = (offlinePack, status) =>
+   *   console.log(offlinePack, status);
+   * const errorListener = (offlinePack, error) => console.log(offlinePack, error);
+   * OfflineManager.addListener(pack.id, progressListener, errorListener);
+   * ```
    */
   async addListener(
     id: string,
@@ -306,17 +351,19 @@ class OfflineManager {
   }
 
   /**
-   * Unsubscribes any listeners associated with the offline pack.
-   * Should be called when the component unmounts.
+   * Unsubscribes any listeners associated with the offline pack. Should be called
+   * when the component unmounts.
+   *
+   * @param packId - ID of the offline pack.
    *
    * @example
+   * ```ts
    * useEffect(() => {
    *   return () => {
    *     OfflineManager.removeListener(pack.id);
-   *   }
+   *   };
    * }, []);
-   *
-   * @param packId ID of the offline pack.
+   * ```
    */
   removeListener(packId: string): void {
     delete this.progressListeners[packId];

package/src/modules/static-map/StaticMapManager.ts

@@ -6,7 +6,7 @@ export interface StaticMapOptions {
   /**
    * Maplibre style - either a URL or a Style JSON.
    *
-   * @see https://maplibre.org/maplibre-style-spec/
+   * @see {@link https://maplibre.org/maplibre-style-spec/}
    */
   mapStyle: string | object;
 
@@ -48,7 +48,7 @@ export type StaticMapCenterOptions = StaticMapOptions & {
   zoom?: number;
 
   /**
-   *  The bearing (rotation) of the map.
+   * The bearing (rotation) of the map.
    */
   bearing?: number;
 
@@ -81,10 +81,12 @@ class StaticMapManager {
   /**
    * Creates a static image of a map. Images are always in PNG format.
    *
-   * @example
-   * // Create static map with center, returning the URI to the temporary PNG file
+   * @param options -
+   *
+   * @example Create static map with center, returning the URI to the temporary PNG file
+   * ```ts
    * const uri = await StaticMapManager.createImage({
-   *   center: [-74.126410, 40.797968 ],
+   *   center: [-74.12641, 40.797968],
    *   zoom: 12,
    *   bearing: 20,
    *   pitch: 30,
@@ -93,15 +95,21 @@ class StaticMapManager {
    *   height: 64,
    *   output: "file",
    * });
+   * ```
    *
-   * // Create a static map with bounds, returning a base64 encoded PNG
+   * @example Create a static map with bounds, returning a base64 encoded PNG
+   * ```ts
    * const uri = await StaticMapManager.createImage({
-   *   bounds: [[-74.126410, 40.797968], [-74.143727, 40.772177]],
+   *   bounds: [
+   *     [-74.12641, 40.797968],
+   *     [-74.143727, 40.772177],
+   *   ],
    *   mapStyle: "https://demotiles.maplibre.org/style.json",
    *   width: 128,
    *   height: 64,
    *   output: "base64",
    * });
+   * ```
    */
   async createImage({
     mapStyle,

package/src/modules/transform-request/NativeTransformRequestModule.ts

@@ -0,0 +1,41 @@
+import type { TurboModule } from "react-native";
+import { TurboModuleRegistry } from "react-native";
+
+export interface Spec extends TurboModule {
+  addUrlTransform(
+    id: string,
+    match: string | null,
+    find: string,
+    replace: string,
+  ): void;
+
+  removeUrlTransform(id: string): void;
+
+  clearUrlTransforms(): void;
+
+  addUrlSearchParam(
+    id: string,
+    match: string | null,
+    name: string,
+    value: string,
+  ): void;
+
+  removeUrlSearchParam(id: string): void;
+
+  clearUrlSearchParams(): void;
+
+  addHeader(
+    id: string,
+    match: string | null,
+    name: string,
+    value: string,
+  ): void;
+
+  removeHeader(id: string): void;
+
+  clearHeaders(): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>(
+  "MLRNTransformRequestModule",
+);