@capgo/capacitor-launch-navigator 8.0.20 → 8.0.21

package/android/src/main/java/app/capgo/plugin/launch_navigator/LaunchNavigatorPlugin.java

@@ -10,13 +10,13 @@ import com.getcapacitor.annotation.CapacitorPlugin;
 @CapacitorPlugin(name = "LaunchNavigator")
 public class LaunchNavigatorPlugin extends Plugin {
 
-    private final String pluginVersion = "8.0.20";
+    private final String pluginVersion = "8.0.21";
 
     private LaunchNavigator implementation;
 
     @Override
     public void load() {
-        implementation = new LaunchNavigator(getContext());
+        implementation = new LaunchNavigator(getContext(), getBridge());
     }
 
     @PluginMethod
@@ -104,6 +104,66 @@ public class LaunchNavigatorPlugin extends Plugin {
         call.resolve(ret);
     }
 
+    @PluginMethod
+    public void getAppIcons(PluginCall call) {
+        JSObject options = new JSObject();
+        try {
+            options = new JSObject(call.getData().toString());
+        } catch (Exception e) {
+            call.reject("Invalid icon options: " + e.getMessage());
+            return;
+        }
+
+        JSObject finalOptions = options;
+        execute(() -> {
+            try {
+                call.resolve(implementation.getAppIcons(finalOptions));
+            } catch (Exception e) {
+                call.reject("Could not get app icons: " + e.getMessage(), e);
+            }
+        });
+    }
+
+    @PluginMethod
+    public void refreshAppIcons(PluginCall call) {
+        JSObject options = new JSObject();
+        try {
+            options = new JSObject(call.getData().toString());
+        } catch (Exception e) {
+            call.reject("Invalid icon options: " + e.getMessage());
+            return;
+        }
+
+        JSObject finalOptions = options;
+        execute(() -> {
+            try {
+                call.resolve(implementation.refreshAppIcons(finalOptions));
+            } catch (Exception e) {
+                call.reject("Could not refresh app icons: " + e.getMessage(), e);
+            }
+        });
+    }
+
+    @PluginMethod
+    public void clearIconCache(PluginCall call) {
+        JSObject options = new JSObject();
+        try {
+            options = new JSObject(call.getData().toString());
+        } catch (Exception e) {
+            call.reject("Invalid icon cache options: " + e.getMessage());
+            return;
+        }
+
+        JSObject finalOptions = options;
+        execute(() -> {
+            try {
+                call.resolve(implementation.clearIconCache(finalOptions));
+            } catch (Exception e) {
+                call.reject("Could not clear icon cache: " + e.getMessage(), e);
+            }
+        });
+    }
+
     @PluginMethod
     public void getPluginVersion(final PluginCall call) {
         try {

package/dist/docs.json

@@ -84,6 +84,62 @@
         "complexTypes": [],
         "slug": "getdefaultapp"
       },
+      {
+        "name": "getAppIcons",
+        "signature": "(options?: GetAppIconsOptions | undefined) => Promise<ProviderIconsResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetAppIconsOptions | undefined"
+          }
+        ],
+        "returns": "Promise<ProviderIconsResult>",
+        "tags": [],
+        "docs": "Fetch provider icons and cache them locally.\n\nThe native implementations revalidate cached icons after 24 hours by default.\nPass `forceRefresh: true` to bypass the cache when an icon must be repaired.",
+        "complexTypes": [
+          "ProviderIconsResult",
+          "GetAppIconsOptions"
+        ],
+        "slug": "getappicons"
+      },
+      {
+        "name": "refreshAppIcons",
+        "signature": "(options?: GetAppIconsOptions | undefined) => Promise<ProviderIconsResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetAppIconsOptions | undefined"
+          }
+        ],
+        "returns": "Promise<ProviderIconsResult>",
+        "tags": [],
+        "docs": "Refresh provider icons, ignoring the cache age.",
+        "complexTypes": [
+          "ProviderIconsResult",
+          "GetAppIconsOptions"
+        ],
+        "slug": "refreshappicons"
+      },
+      {
+        "name": "clearIconCache",
+        "signature": "(options?: ClearIconCacheOptions | undefined) => Promise<{ cleared: number; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ClearIconCacheOptions | undefined"
+          }
+        ],
+        "returns": "Promise<{ cleared: number; }>",
+        "tags": [],
+        "docs": "Clear cached provider icons.",
+        "complexTypes": [
+          "ClearIconCacheOptions"
+        ],
+        "slug": "cleariconcache"
+      },
       {
         "name": "getPluginVersion",
         "signature": "() => Promise<{ version: string; }>",
@@ -210,6 +266,236 @@
           "type": "boolean"
         }
       ]
+    },
+    {
+      "name": "ProviderIconsResult",
+      "slug": "providericonsresult",
+      "docs": "Result of fetching provider icons.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "icons",
+          "tags": [],
+          "docs": "Icons available from cache or freshly downloaded",
+          "complexTypes": [
+            "ProviderIcon"
+          ],
+          "type": "ProviderIcon[]"
+        },
+        {
+          "name": "failures",
+          "tags": [],
+          "docs": "Providers that could not be fetched and had no cached fallback",
+          "complexTypes": [
+            "ProviderIconFailure"
+          ],
+          "type": "ProviderIconFailure[]"
+        }
+      ]
+    },
+    {
+      "name": "ProviderIcon",
+      "slug": "providericon",
+      "docs": "Cached icon for a navigation provider.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "app",
+          "tags": [],
+          "docs": "Navigation app identifier",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "Display name for the provider",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "localUrl",
+          "tags": [],
+          "docs": "URL that can be used directly in an image element inside the WebView.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "sourceUrl",
+          "tags": [],
+          "docs": "Web URL used to download the cached image",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "mimeType",
+          "tags": [],
+          "docs": "MIME type reported for the cached image, when known",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fetchedAt",
+          "tags": [],
+          "docs": "Unix timestamp in milliseconds when the icon was last fetched",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "fromCache",
+          "tags": [],
+          "docs": "Whether the icon came from the local cache without a network refresh",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "stale",
+          "tags": [],
+          "docs": "Whether a stale cached icon was returned because refresh failed",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "ProviderIconFailure",
+      "slug": "providericonfailure",
+      "docs": "Icon fetch failure for a provider.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "app",
+          "tags": [],
+          "docs": "Navigation app identifier",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "Display name for the provider",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "sourceUrl",
+          "tags": [],
+          "docs": "Web URL that failed, when known",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "Failure message",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetAppIconsOptions",
+      "slug": "getappiconsoptions",
+      "docs": "Options for fetching navigation provider icons.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "apps",
+          "tags": [],
+          "docs": "App identifiers to fetch. Defaults to all built-in providers for the current platform.",
+          "complexTypes": [
+            "IOSNavigationApp",
+            "AndroidNavigationApp"
+          ],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "providers",
+          "tags": [],
+          "docs": "Provider definitions to fetch or override built-in provider websites.",
+          "complexTypes": [
+            "IconProvider"
+          ],
+          "type": "IconProvider[] | undefined"
+        },
+        {
+          "name": "maxAgeMs",
+          "tags": [],
+          "docs": "Cache revalidation interval in milliseconds. Defaults to 24 hours.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "forceRefresh",
+          "tags": [],
+          "docs": "Ignore the current cache and fetch icons again.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "IconProvider",
+      "slug": "iconprovider",
+      "docs": "Web source used to discover or download a provider icon.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "app",
+          "tags": [],
+          "docs": "Navigation app identifier",
+          "complexTypes": [
+            "IOSNavigationApp",
+            "AndroidNavigationApp"
+          ],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "Display name for the provider",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "Provider website used to discover favicon metadata",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "iconUrl",
+          "tags": [],
+          "docs": "Direct image URL. When provided, the plugin downloads this URL instead of discovering a favicon from `url`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ClearIconCacheOptions",
+      "slug": "cleariconcacheoptions",
+      "docs": "Options for clearing cached provider icons.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "apps",
+          "tags": [],
+          "docs": "App identifiers to clear. Defaults to all cached icons.",
+          "complexTypes": [
+            "IOSNavigationApp",
+            "AndroidNavigationApp"
+          ],
+          "type": "string[] | undefined"
+        }
+      ]
     }
   ],
   "enums": [
@@ -331,6 +617,30 @@
           "tags": [],
           "docs": ""
         },
+        {
+          "name": "GURU_MAPS",
+          "value": "'guru_maps'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "ORGANIC_MAPS",
+          "value": "'organic_maps'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "YANDEX_MAPS",
+          "value": "'yandex_maps'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "TWO_GIS",
+          "value": "'2gis'",
+          "tags": [],
+          "docs": ""
+        },
         {
           "name": "CABIFY",
           "value": "'cabify'",
@@ -349,6 +659,12 @@
           "tags": [],
           "docs": ""
         },
+        {
+          "name": "TESLA",
+          "value": "'tesla'",
+          "tags": [],
+          "docs": ""
+        },
         {
           "name": "TAXI_99",
           "value": "'99taxi'",
@@ -421,6 +737,42 @@
           "tags": [],
           "docs": ""
         },
+        {
+          "name": "TOMTOM",
+          "value": "'tomtom'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "GURU_MAPS",
+          "value": "'guru_maps'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "ORGANIC_MAPS",
+          "value": "'organic_maps'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "YANDEX_MAPS",
+          "value": "'yandex_maps'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "MAPY",
+          "value": "'mapy'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "TWO_GIS",
+          "value": "'2gis'",
+          "tags": [],
+          "docs": ""
+        },
         {
           "name": "CABIFY",
           "value": "'cabify'",
@@ -438,6 +790,12 @@
           "value": "'gaode'",
           "tags": [],
           "docs": ""
+        },
+        {
+          "name": "TESLA",
+          "value": "'tesla'",
+          "tags": [],
+          "docs": ""
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -16,9 +16,14 @@ export declare enum IOSNavigationApp {
     MOOVIT = "moovit",
     LYFT = "lyft",
     MAPS_ME = "mapsme",
+    GURU_MAPS = "guru_maps",
+    ORGANIC_MAPS = "organic_maps",
+    YANDEX_MAPS = "yandex_maps",
+    TWO_GIS = "2gis",
     CABIFY = "cabify",
     BAIDU = "baidu",
     GAODE = "gaode",
+    TESLA = "tesla",
     TAXI_99 = "99taxi"
 }
 /**
@@ -35,9 +40,16 @@ export declare enum AndroidNavigationApp {
     MOOVIT = "moovit",
     LYFT = "lyft",
     MAPS_ME = "mapsme",
+    TOMTOM = "tomtom",
+    GURU_MAPS = "guru_maps",
+    ORGANIC_MAPS = "organic_maps",
+    YANDEX_MAPS = "yandex_maps",
+    MAPY = "mapy",
+    TWO_GIS = "2gis",
     CABIFY = "cabify",
     BAIDU = "baidu",
-    GAODE = "gaode"
+    GAODE = "gaode",
+    TESLA = "tesla"
 }
 /**
  * Transport modes
@@ -110,6 +122,128 @@ export interface AvailableApp {
      */
     available: boolean;
 }
+/**
+ * Web source used to discover or download a provider icon.
+ */
+export interface IconProvider {
+    /**
+     * Navigation app identifier
+     */
+    app: IOSNavigationApp | AndroidNavigationApp | string;
+    /**
+     * Display name for the provider
+     */
+    name?: string;
+    /**
+     * Provider website used to discover favicon metadata
+     */
+    url?: string;
+    /**
+     * Direct image URL. When provided, the plugin downloads this URL instead of discovering a favicon from `url`.
+     */
+    iconUrl?: string;
+}
+/**
+ * Options for fetching navigation provider icons.
+ */
+export interface GetAppIconsOptions {
+    /**
+     * App identifiers to fetch. Defaults to all built-in providers for the current platform.
+     */
+    apps?: (IOSNavigationApp | AndroidNavigationApp | string)[];
+    /**
+     * Provider definitions to fetch or override built-in provider websites.
+     */
+    providers?: IconProvider[];
+    /**
+     * Cache revalidation interval in milliseconds. Defaults to 24 hours.
+     */
+    maxAgeMs?: number;
+    /**
+     * Ignore the current cache and fetch icons again.
+     */
+    forceRefresh?: boolean;
+}
+/**
+ * Cached icon for a navigation provider.
+ */
+export interface ProviderIcon {
+    /**
+     * Navigation app identifier
+     */
+    app: string;
+    /**
+     * Display name for the provider
+     */
+    name?: string;
+    /**
+     * URL that can be used directly in an image element inside the WebView.
+     */
+    localUrl: string;
+    /**
+     * Web URL used to download the cached image
+     */
+    sourceUrl: string;
+    /**
+     * MIME type reported for the cached image, when known
+     */
+    mimeType?: string;
+    /**
+     * Unix timestamp in milliseconds when the icon was last fetched
+     */
+    fetchedAt: number;
+    /**
+     * Whether the icon came from the local cache without a network refresh
+     */
+    fromCache: boolean;
+    /**
+     * Whether a stale cached icon was returned because refresh failed
+     */
+    stale: boolean;
+}
+/**
+ * Icon fetch failure for a provider.
+ */
+export interface ProviderIconFailure {
+    /**
+     * Navigation app identifier
+     */
+    app: string;
+    /**
+     * Display name for the provider
+     */
+    name?: string;
+    /**
+     * Web URL that failed, when known
+     */
+    sourceUrl?: string;
+    /**
+     * Failure message
+     */
+    message: string;
+}
+/**
+ * Result of fetching provider icons.
+ */
+export interface ProviderIconsResult {
+    /**
+     * Icons available from cache or freshly downloaded
+     */
+    icons: ProviderIcon[];
+    /**
+     * Providers that could not be fetched and had no cached fallback
+     */
+    failures: ProviderIconFailure[];
+}
+/**
+ * Options for clearing cached provider icons.
+ */
+export interface ClearIconCacheOptions {
+    /**
+     * App identifiers to clear. Defaults to all cached icons.
+     */
+    apps?: (IOSNavigationApp | AndroidNavigationApp | string)[];
+}
 /**
  * Main plugin interface
  */
@@ -170,6 +304,26 @@ export interface LaunchNavigatorPlugin {
          */
         app: string;
     }>;
+    /**
+     * Fetch provider icons and cache them locally.
+     *
+     * The native implementations revalidate cached icons after 24 hours by default.
+     * Pass `forceRefresh: true` to bypass the cache when an icon must be repaired.
+     */
+    getAppIcons?(options?: GetAppIconsOptions): Promise<ProviderIconsResult>;
+    /**
+     * Refresh provider icons, ignoring the cache age.
+     */
+    refreshAppIcons?(options?: GetAppIconsOptions): Promise<ProviderIconsResult>;
+    /**
+     * Clear cached provider icons.
+     */
+    clearIconCache?(options?: ClearIconCacheOptions): Promise<{
+        /**
+         * Number of cached icon files removed
+         */
+        cleared: number;
+    }>;
     /**
      * Get the native Capacitor plugin version
      *
@@ -180,3 +334,28 @@ export interface LaunchNavigatorPlugin {
         version: string;
     }>;
 }
+/**
+ * Required icon cache helpers exposed by the bundled plugin export.
+ */
+export interface LaunchNavigatorPluginIcons {
+    /**
+     * Fetch provider icons and cache them locally.
+     *
+     * The native implementations revalidate cached icons after 24 hours by default.
+     * Pass `forceRefresh: true` to bypass the cache when an icon must be repaired.
+     */
+    getAppIcons(options?: GetAppIconsOptions): Promise<ProviderIconsResult>;
+    /**
+     * Refresh provider icons, ignoring the cache age.
+     */
+    refreshAppIcons(options?: GetAppIconsOptions): Promise<ProviderIconsResult>;
+    /**
+     * Clear cached provider icons.
+     */
+    clearIconCache(options?: ClearIconCacheOptions): Promise<{
+        /**
+         * Number of cached icon files removed
+         */
+        cleared: number;
+    }>;
+}