@mapvina-com/mapvina-react-native 1.0.0

package/lib/typescript/commonjs/modules/offline/OfflineManager.d.ts

@@ -0,0 +1,238 @@
+import { OfflinePack, type OfflinePackStatus } from "./OfflinePack";
+import type { LngLatBounds } from "../../types/LngLatBounds";
+export interface OfflinePackCreateOptions {
+    mapStyle: string;
+    bounds: LngLatBounds;
+    minZoom?: number;
+    maxZoom?: number;
+    /**
+     * User-provided metadata object.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Represents the offline pack download state
+ */
+export type OfflinePackDownloadState = "inactive" | "active" | "complete";
+export type OfflinePackError = {
+    id: string;
+    message: string;
+};
+export type OfflinePackProgressListener = (offlinePack: OfflinePack, status: OfflinePackStatus) => void;
+export type OfflinePackErrorListener = (offlinePack: OfflinePack, error: OfflinePackError) => 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.
+ */
+declare class OfflineManager {
+    private initialized;
+    private readonly offlinePacks;
+    private readonly progressListeners;
+    private readonly errorListeners;
+    private subscriptionProgress;
+    private subscriptionError;
+    constructor();
+    /**
+     * Creates and registers an offline pack that downloads the resources needed to
+     * use the given region offline.
+     *
+     * @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.
+     *
+     * @example
+     * ```ts
+     * const progressListener = (offlineRegion, status) =>
+     *   console.log(offlineRegion, status);
+     * const errorListener = (offlineRegion, error) =>
+     *   console.log(offlineRegion, error);
+     *
+     * const offlinePack = await OfflineManager.createPack(
+     *   {
+     *     mapStyle: "https://demotiles.mapvina.com/tiles/tiles.json",
+     *     minZoom: 14,
+     *     maxZoom: 20,
+     *     bounds: [west, south, east, north],
+     *     metadata: { customValue: "myValue" },
+     *   },
+     *   progressListener,
+     *   errorListener,
+     * );
+     * ```
+     */
+    createPack(options: OfflinePackCreateOptions, progressListener: OfflinePackProgressListener, errorListener: OfflinePackErrorListener): Promise<OfflinePack>;
+    /**
+     * 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.
+     *
+     * @param id - ID of the OfflinePack.
+     *
+     * @example
+     * ```ts
+     * await OfflineManager.invalidatePack(pack.id);
+     * ```
+     */
+    invalidatePack(id: string): Promise<void>;
+    /**
+     * Unregisters the given OfflinePack and allows resources that are no longer
+     * required by any remaining packs to be potentially freed.
+     *
+     * @param id - ID of the OfflinePack.
+     *
+     * @example
+     * ```ts
+     * await OfflineManager.deletePack(pack.id);
+     * ```
+     */
+    deletePack(id: string): Promise<void>;
+    /**
+     * 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();
+     * ```
+     */
+    invalidateAmbientCache(): Promise<void>;
+    /**
+     * 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();
+     * ```
+     */
+    clearAmbientCache(): Promise<void>;
+    /**
+     * 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);
+     */
+    setMaximumAmbientCacheSize(size: number): Promise<void>;
+    /**
+     * Deletes the existing database, which includes both the ambient cache and
+     * offline packs, then reinitializes it.
+     *
+     * @example
+     * ```ts
+     * await OfflineManager.resetDatabase();
+     * ```
+     */
+    resetDatabase(): Promise<void>;
+    /**
+     * Retrieves all the current offline packs that are stored in the database.
+     *
+     * @example
+     * const offlinePacks = await OfflineManager.getPacks();
+     */
+    getPacks(): Promise<OfflinePack[]>;
+    /**
+     * Retrieves an offline pack that is stored in the database by ID.
+     *
+     * @example
+     * ```ts
+     * const offlinePack = await OfflineManager.getPack(offlinePack.id);
+     * ```
+     */
+    getPack(id: string): Promise<OfflinePack>;
+    /**
+     * Sideloads offline db
+     *
+     * @param path - Path to offline tile db on file system.
+     *
+     * @example
+     * ```ts
+     * await OfflineManager.mergeOfflineRegions(path);
+     * ```
+     */
+    mergeOfflineRegions(path: string): Promise<void>;
+    /**
+     * 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);
+     * ```
+     */
+    setTileCountLimit(limit: number): void;
+    /**
+     * 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);
+     * ```
+     */
+    setProgressEventThrottle(throttleValue: number): void;
+    /**
+     * Subscribe to download status/error events for the requested offline pack.
+     * Note that createPack calls this internally if listeners are provided.
+     *
+     * @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);
+     * ```
+     */
+    addListener(id: string, progressListener: OfflinePackProgressListener, errorListener: OfflinePackErrorListener): Promise<void>;
+    /**
+     * 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);
+     *   };
+     * }, []);
+     * ```
+     */
+    removeListener(packId: string): void;
+    private initialize;
+    private handleProgress;
+    private onError;
+}
+declare const offlineManager: OfflineManager;
+export { offlineManager as OfflineManager };
+//# sourceMappingURL=OfflineManager.d.ts.map

package/lib/typescript/commonjs/modules/offline/OfflineManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OfflineManager.d.ts","sourceRoot":"","sources":["../../../../../src/modules/offline/OfflineManager.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE1E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,CACxC,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,iBAAiB,KACtB,IAAI,CAAC;AACV,MAAM,MAAM,wBAAwB,GAAG,CACrC,WAAW,EAAE,WAAW,EACxB,KAAK,EAAE,gBAAgB,KACpB,IAAI,CAAC;AAEV;;;;;GAKG;AACH,cAAM,cAAc;IAClB,OAAO,CAAC,WAAW,CAAU;IAE7B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA8B;IAE3D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAGhC;IACF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA2C;IAE1E,OAAO,CAAC,oBAAoB,CAA2B;IACvD,OAAO,CAAC,iBAAiB,CAA2B;;IAiBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,UAAU,CACd,OAAO,EAAE,wBAAwB,EACjC,gBAAgB,EAAE,2BAA2B,EAC7C,aAAa,EAAE,wBAAwB,GACtC,OAAO,CAAC,WAAW,CAAC;IAqBvB;;;;;;;;;;;;;;;OAeG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO/C;;;;;;;;;;OAUG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3C;;;;;;;;;;;;;OAaG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAK7C;;;;;;;;OAQG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxC;;;;;;;;;OASG;IACG,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK7D;;;;;;;;OAQG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAKpC;;;;;OAKG;IACG,QAAQ,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAMxC;;;;;;;OAOG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAW/C;;;;;;;;;OASG;IACG,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtD;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAItC;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAIrD;;;;;;;;;;;;;;;;;OAiBG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,gBAAgB,EAAE,2BAA2B,EAC7C,aAAa,EAAE,wBAAwB,GACtC,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;YAmBtB,UAAU;IAiBxB,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,OAAO;CAQhB;AAED,QAAA,MAAM,cAAc,gBAAuB,CAAC;AAC5C,OAAO,EAAE,cAAc,IAAI,cAAc,EAAE,CAAC"}

package/lib/typescript/commonjs/modules/offline/OfflinePack.d.ts

@@ -0,0 +1,25 @@
+import { type NativeOfflinePack } from "./NativeOfflineModule";
+import type { OfflinePackDownloadState } from "./OfflineManager";
+import type { LngLatBounds } from "../../types/LngLatBounds";
+export type OfflinePackStatus = {
+    id: string;
+    state: OfflinePackDownloadState;
+    percentage: number;
+    completedResourceCount: number;
+    completedResourceSize: number;
+    completedTileCount: number;
+    completedTileSize: number;
+    requiredResourceCount: number;
+};
+export declare class OfflinePack {
+    /** Unique Identifier (UUID), auto-generated natively during creation. */
+    id: string;
+    /** User-provided metadata object. */
+    metadata: Record<string, unknown>;
+    bounds: LngLatBounds;
+    constructor(pack: NativeOfflinePack);
+    status(): Promise<OfflinePackStatus>;
+    resume(): Promise<void>;
+    pause(): Promise<void>;
+}
+//# sourceMappingURL=OfflinePack.d.ts.map

package/lib/typescript/commonjs/modules/offline/OfflinePack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OfflinePack.d.ts","sourceRoot":"","sources":["../../../../../src/modules/offline/OfflinePack.ts"],"names":[],"mappings":"AAAA,OAA4B,EAC1B,KAAK,iBAAiB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,wBAAwB,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,qBAAa,WAAW;IACtB,yEAAyE;IAClE,EAAE,EAAE,MAAM,CAAC;IAElB,qCAAqC;IAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC,MAAM,EAAE,YAAY,CAAC;gBAEhB,IAAI,EAAE,iBAAiB;IAM7B,MAAM,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAIpC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B"}

package/lib/typescript/commonjs/modules/static-map/NativeStaticMapModule.d.ts

@@ -0,0 +1,19 @@
+import type { CodegenTypes, TurboModule } from "react-native";
+interface NativeStaticMapCreateOptions {
+    center?: CodegenTypes.Double[];
+    zoom?: CodegenTypes.Double;
+    bearing?: CodegenTypes.WithDefault<CodegenTypes.Double, 0>;
+    pitch?: CodegenTypes.WithDefault<CodegenTypes.Double, 0>;
+    bounds?: CodegenTypes.Double[];
+    mapStyle: string;
+    width: CodegenTypes.Int32;
+    height: CodegenTypes.Int32;
+    output: "base64" | "file";
+    logo?: boolean;
+}
+export interface Spec extends TurboModule {
+    createImage(options: NativeStaticMapCreateOptions): Promise<string>;
+}
+declare const _default: Spec;
+export default _default;
+//# sourceMappingURL=NativeStaticMapModule.d.ts.map

package/lib/typescript/commonjs/modules/static-map/NativeStaticMapModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeStaticMapModule.d.ts","sourceRoot":"","sources":["../../../../../src/modules/static-map/NativeStaticMapModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG9D,UAAU,4BAA4B;IACpC,MAAM,CAAC,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC;IAC/B,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3D,KAAK,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEzD,MAAM,CAAC,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC;IAE/B,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC;IAC1B,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC;IAE3B,MAAM,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE1B,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,WAAW,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACrE;;AAED,wBAA6E"}

package/lib/typescript/commonjs/modules/static-map/StaticMapManager.d.ts

@@ -0,0 +1,105 @@
+import type { LngLat } from "../../types/LngLat";
+import type { LngLatBounds } from "../../types/LngLatBounds";
+export interface StaticMapOptions {
+    /**
+     * Mapvina style - either a URL or a Style JSON.
+     *
+     * @see {@link https://mapvina.io/github/mapvina-style-spec/}
+     */
+    mapStyle: string | object;
+    /**
+     * Width of the image in pixels.
+     */
+    width: number;
+    /**
+     * Height of the image in pixels.
+     */
+    height: number;
+    /**
+     * Defines the way the image is returned.
+     *
+     * - "base64": base64 encoded string of the image
+     * - "file": URI to a temporary file image
+     */
+    output: "base64" | "file";
+    /**
+     * Toggle the MapVina logo on the image.
+     *
+     * MapVina doesn't require you to display the logo.
+     */
+    logo?: boolean;
+}
+export type StaticMapCenterOptions = StaticMapOptions & {
+    /**
+     * The center coordinate of the map.
+     */
+    center: LngLat;
+    /**
+     * The zoom level of the map.
+     */
+    zoom?: number;
+    /**
+     * The bearing (rotation) of the map.
+     */
+    bearing?: number;
+    /**
+     * The pitch of the map.
+     */
+    pitch?: number;
+};
+export type StaticMapBoundsOptions = StaticMapOptions & {
+    /**
+     * The corners of a box around which the map should bound.
+     */
+    bounds: LngLatBounds;
+};
+export type StaticMapCreateOptions = (StaticMapCenterOptions & {
+    bounds?: never;
+}) | (StaticMapBoundsOptions & {
+    center?: never;
+    zoom?: never;
+    bearing?: never;
+    pitch?: never;
+});
+/**
+ * The StaticMapManager creates static images of a map.
+ */
+declare class StaticMapManager {
+    /**
+     * Creates a static image of a map. Images are always in PNG format.
+     *
+     * @param options -
+     *
+     * @example Create static map with center, returning the URI to the temporary PNG file
+     * ```ts
+     * const uri = await StaticMapManager.createImage({
+     *   center: [-74.12641, 40.797968],
+     *   zoom: 12,
+     *   bearing: 20,
+     *   pitch: 30,
+     *   mapStyle: "https://maps.mapvina.com/styles/v2/streets.json?key=public_key",
+     *   width: 128,
+     *   height: 64,
+     *   output: "file",
+     * });
+     * ```
+     *
+     * @example Create a static map with bounds, returning a base64 encoded PNG
+     * ```ts
+     * const uri = await StaticMapManager.createImage({
+     *   bounds: [
+     *     [-74.12641, 40.797968],
+     *     [-74.143727, 40.772177],
+     *   ],
+     *   mapStyle: "https://maps.mapvina.com/styles/v2/streets.json?key=public_key",
+     *   width: 128,
+     *   height: 64,
+     *   output: "base64",
+     * });
+     * ```
+     */
+    createImage({ mapStyle, ...options }: StaticMapCreateOptions): Promise<string>;
+}
+declare const staticMapImageManager: StaticMapManager;
+export { staticMapImageManager as StaticMapImageManager };
+//# sourceMappingURL=StaticMapManager.d.ts.map

package/lib/typescript/commonjs/modules/static-map/StaticMapManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StaticMapManager.d.ts","sourceRoot":"","sources":["../../../../../src/modules/static-map/StaticMapManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAG7D,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,MAAM,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG;IACtD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG;IACtD;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAC9B,CAAC,sBAAsB,GAAG;IAAE,MAAM,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,GAC7C,CAAC,sBAAsB,GAAG;IAC1B,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC,CAAC;AAEL;;GAEG;AACH,cAAM,gBAAgB;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,WAAW,CAAC,EAChB,QAAQ,EACR,GAAG,OAAO,EACX,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;CAO5C;AAED,QAAA,MAAM,qBAAqB,kBAAyB,CAAC;AACrD,OAAO,EAAE,qBAAqB,IAAI,qBAAqB,EAAE,CAAC"}

package/lib/typescript/commonjs/modules/transform-request/NativeTransformRequestModule.d.ts

@@ -0,0 +1,15 @@
+import type { TurboModule } 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;
+}
+declare const _default: Spec;
+export default _default;
+//# sourceMappingURL=NativeTransformRequestModule.d.ts.map

package/lib/typescript/commonjs/modules/transform-request/NativeTransformRequestModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeTransformRequestModule.d.ts","sourceRoot":"","sources":["../../../../../src/modules/transform-request/NativeTransformRequestModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,eAAe,CACb,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GACd,IAAI,CAAC;IAER,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,kBAAkB,IAAI,IAAI,CAAC;IAE3B,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,IAAI,CAAC;IAER,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC,oBAAoB,IAAI,IAAI,CAAC;IAE7B,SAAS,CACP,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,IAAI,CAAC;IAER,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,YAAY,IAAI,IAAI,CAAC;CACtB;;AAED,wBAEE"}

package/lib/typescript/commonjs/modules/transform-request/TransformRequestManager.d.ts

@@ -0,0 +1,213 @@
+export interface TransformOptions {
+    /**
+     * The id is used to identify a transform. Can be used to remove or update it.
+     * When omitted it will be auto-generated.
+     */
+    id?: string;
+    /**
+     * Optional regex to be used as the condition, if the transform should be
+     * applied. When omitted the transform will always be applied.
+     *
+     * Global flags are (like `/i` ) are not supported. Supports only inline flags,
+     * e.g. `(?i)` for case-insensitive matching.
+     */
+    match?: RegExp | string;
+}
+/**
+ * A serializable transform for rewriting MapVina request URLs.
+ *
+ * Transforms are applied as a pipeline in the order they were added: transform
+ * N+1 sees the URL *after* transform N has possibly changed it.
+ */
+export interface UrlTransformOptions extends TransformOptions {
+    /**
+     * Regex to find the portion of the URL to replace. Supports capture groups that
+     * can be back-referenced in `replace` as `$1` , `$2` , …
+     *
+     * Global flags are (like `/i` ) are not supported. Supports only inline flags,
+     * e.g. `(?i)` for case-insensitive matching.
+     */
+    find: RegExp | string;
+    /**
+     * Replacement string. Reference capture groups from `find` with `$1`, `$2`, …
+     */
+    replace: string;
+}
+/**
+ * A URL query parameter to append to matching map resource requests.
+ */
+export interface UrlSearchParamOptions extends TransformOptions {
+    /** The query parameter name (e.g., `"apiKey"`). */
+    name: string;
+    /** The query parameter value (e.g., your API key). */
+    value: string;
+}
+/**
+ * A HTTP header to send with matching map resource requests.
+ */
+export interface HeaderOptions extends TransformOptions {
+    /** The header name (e.g., `"Authorization"`). */
+    name: string;
+    /** The header value (e.g., `"Bearer token123"`). */
+    value: string;
+}
+/**
+ * TransformRequestManager provides methods for managing HTTP requests made by
+ * MapVina.
+ *
+ * Transformations are possible in three ways:
+ *
+ * - Transforming the URL with search and replace
+ * - Adding URL search params
+ * - Adding HTTP headers
+ *
+ * Transforms are applied in this order. The `match` conditions are applied to
+ * possibly already transformed URLs.
+ *
+ * To gain insight into which transforms are applied set the log level to
+ * `"debug"` via {@link LogManager}:
+ *
+ * ```ts
+ * LogManager.setLogLevel("debug");
+ * ```
+ */
+declare class TransformRequestManager {
+    /**
+     * Adds or updates a URL transform identified by `id`.
+     *
+     * Transforms execute in insertion order. Therefore `match` and `find` regexes
+     * are matched against possibly already modified URL by previous transforms.
+     *
+     * Re-adding an existing `id` updates the transform **in-place**, preserving its
+     * position in the pipeline. This makes it safe to refresh tokens or swap
+     * domains without disrupting the order of other transforms.
+     *
+     * URL transforms are applied before `addUrlSearchParam` and `addHeader`.
+     *
+     * @param options - The transform. Set {@link TransformOptions.id} to a stable string to enable
+     *   in-place updates; if omitted an id is auto-generated and returned.
+     * @returns The id of the transform (the value of `transform.id` when provided, otherwise the auto-generated one). Pass it to {@link removeUrlTransform} to remove it later.
+     *
+     * @example Upgrade all requests to HTTPS
+     * ```ts
+     * TransformRequestManager.addUrlTransform({
+     *   id: "force-https",
+     *   find: "^http://",
+     *   replace: "https://",
+     * });
+     * ```
+     *
+     * @example Redirect a specific domain through a proxy
+     * ```ts
+     * TransformRequestManager.addUrlTransform({
+     *   id: "proxy",
+     *   match: "tiles\\.example\\.com",
+     *   find: "tiles\\.example\\.com",
+     *   replace: "proxy.example.com",
+     * });
+     * ```
+     *
+     * @example Inject an API key into the path using a capture group
+     * ```ts
+     * TransformRequestManager.addUrlTransform({
+     *   id: "api-key",
+     *   match: "api\\.example\\.com",
+     *   find: "(https://api\\.example\\.com/)(.*)",
+     *   replace: "$1mySecretKey/$2",
+     * });
+     * ```
+     */
+    addUrlTransform(options: UrlTransformOptions): string;
+    /**
+     * Removes the URL transform with the given `id` . No-op if the id is not
+     * registered.
+     *
+     * @param id - The identifier passed to/returned from {@link addUrlTransform}.
+     */
+    removeUrlTransform(id: string): void;
+    /**
+     * Removes all registered URL transforms
+     */
+    clearUrlTransforms(): void;
+    /**
+     * Adds or updates a URL query parameter identified by `id` that will be
+     * appended to all matching map resource requests. Re-adding an existing `id`
+     *  updates the param in-place.
+     *
+     * @param options - The options. Set {@link TransformOptions.id} to a stable string to enable
+     *   in-place updates; if omitted an id is auto-generated and returned.
+     * @returns The id of the options. Pass it to {@link removeUrlSearchParam} to remove it later.
+     *
+     * @example Add apiKey to for a specific domain
+     * ```ts
+     * TransformRequestManager.addUrlSearchParam({
+     *   match: /tiles\.example\.com/,
+     *   name: "apiKey",
+     *   value: "your-api-key",
+     * });
+     * ```
+     *
+     * @example Add apiKey to all requests (no match = applies to all)
+     * ```ts
+     * TransformRequestManager.addUrlSearchParam({
+     *   name: "apiKey",
+     *   value: "your-api-key",
+     * });
+     * ```
+     */
+    addUrlSearchParam(options: UrlSearchParamOptions): string;
+    /**
+     * Removes a previously added URL query parameter by its `id`.
+     *
+     * @param id - The identifier passed to/returned from {@link addUrlSearchParam}.
+     */
+    removeUrlSearchParam(id: string): void;
+    /**
+     * Adds or updates an HTTP header identified by `id` that will be sent with all
+     * matching map resource requests. Re-adding an existing `id` updates the header
+     * in-place.
+     *
+     * @param options - The options. Set {@link TransformOptions.id} to a stable string to enable
+     *   in-place updates; if omitted an id is auto-generated and returned.
+     * @returns The id of the options. Pass it to {@link removeHeader} to remove it later.
+     *
+     * @example Add header to all requests
+     * ```
+     * TransformRequestManager.addHeader({ name: "Authorization", value: "Bearer token123" });
+     * ```
+     *
+     * @example Add header only to requests matching a pattern
+     * ```ts
+     * TransformRequestManager.addHeader({
+     *   name: "X-API-Key",
+     *   value: "key123",
+     *   match: /https:\/\/api\.example\.com\/tiles\//,
+     * });
+     * ```
+     */
+    addHeader(options: HeaderOptions): string;
+    /**
+     * Removes all registered URL search params.
+     */
+    clearUrlSearchParams(): void;
+    /**
+     * Removes a previously added HTTP header by its `id`.
+     *
+     * @param id - The identifier passed to/returned from {@link addHeader}.
+     */
+    removeHeader(id: string): void;
+    /**
+     * Removes all registered HTTP headers.
+     */
+    clearHeaders(): void;
+    /**
+     * Removes all registered URL transforms, URL search params and HTTP headers.
+     */
+    clear(): void;
+    private lastId;
+    private getId;
+    private static toRegexString;
+}
+declare const transformRequestManager: TransformRequestManager;
+export { transformRequestManager as TransformRequestManager };
+//# sourceMappingURL=TransformRequestManager.d.ts.map

package/lib/typescript/commonjs/modules/transform-request/TransformRequestManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransformRequestManager.d.ts","sourceRoot":"","sources":["../../../../../src/modules/transform-request/TransformRequestManager.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IAEb,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IAEb,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,cAAM,uBAAuB;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM;IAarD;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,GAAG,MAAM;IAazD;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAItC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM;IAazC;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAI5B;;;;OAIG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAI9B;;OAEG;IACH,YAAY,IAAI,IAAI;IAIpB;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb,OAAO,CAAC,MAAM,CAAc;IAE5B,OAAO,CAAC,KAAK;IAMb,OAAO,CAAC,MAAM,CAAC,aAAa;CAgB7B;AAED,QAAA,MAAM,uBAAuB,yBAAgC,CAAC;AAE9D,OAAO,EAAE,uBAAuB,IAAI,uBAAuB,EAAE,CAAC"}

package/lib/typescript/commonjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}