@tauri-apps/plugin-geolocation 2.0.0-rc.1 → 2.0.0

package/README.md

@@ -2,9 +2,17 @@
 
 This plugin provides APIs for getting and tracking the device's current position, including information about altitude, heading, and speed (if available).
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | x         |
+| Windows  | x         |
+| macOS    | x         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
-_This plugin requires a Rust version of at least **1.75**_
+_This plugin requires a Rust version of at least **1.78**_
 
 There are three general methods of installation that we can recommend.
 
@@ -18,7 +26,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
 
 ```toml
 [dependencies]
-tauri-plugin-geolocation = "2.0.0-rc"
+tauri-plugin-geolocation = "2.0.0"
 # alternatively with Git:
 tauri-plugin-geolocation = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
 ```
@@ -87,16 +95,31 @@ fn main() {
 Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
 
 ```javascript
-import { getCurrentPosition, watchPosition } from "@tauri-apps/plugin-log";
+import {
+  checkPermissions,
+  requestPermissions,
+  getCurrentPosition,
+  watchPosition
+} from '@tauri-apps/plugin-log'
+
+let permissions = await checkPermissions()
+if (
+  permissions.location === 'prompt' ||
+  permissions.location === 'prompt-with-rationale'
+) {
+  permissions = await requestPermissions(['location'])
+}
 
-const pos = await getCurrentPosition();
+if (permissions.location === 'granted') {
+  const pos = await getCurrentPosition()
 
-await watchPosition(
-  { enableHighAccuracy: true, timeout: 10000, maximumAge: 0 },
-  (pos) => {
-    console.log(pos);
-  }
-);
+  await watchPosition(
+    { enableHighAccuracy: true, timeout: 10000, maximumAge: 0 },
+    (pos) => {
+      console.log(pos)
+    }
+  )
+}
 ```
 
 ## Contributing

package/dist-js/index.cjs

@@ -1,110 +1,44 @@
 'use strict';
 
 var core = require('@tauri-apps/api/core');
-require('@tauri-apps/api/event');
 
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
-// @ts-nocheck
-// This file was generated by [tauri-specta](https://github.com/oscartbeaumont/tauri-specta). Do not edit this file manually.
-/** user-defined commands **/
-const commands = {
-    async getCurrentPosition(options) {
-        try {
-            return {
-                status: "ok",
-                data: await core.invoke("plugin:geolocation|get_current_position", {
-                    options,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async watchPosition(options, channel) {
-        try {
-            return {
-                status: "ok",
-                data: await core.invoke("plugin:geolocation|watch_position", {
-                    options,
-                    channel,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async clearWatch(channelId) {
-        try {
-            return {
-                status: "ok",
-                data: await core.invoke("plugin:geolocation|clear_watch", {
-                    channelId,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async checkPermissions() {
-        try {
-            return {
-                status: "ok",
-                data: await core.invoke("plugin:geolocation|check_permissions"),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async requestPermissions(permissions) {
-        try {
-            return {
-                status: "ok",
-                data: await core.invoke("plugin:geolocation|request_permissions", {
-                    permissions,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-};
-
-// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-License-Identifier: MIT
-/* eslint-disable @typescript-eslint/unbound-method */
-async function watchPosition(options, 
-// TODO: This can receive errors too
-cb) {
+async function watchPosition(options, cb) {
     const channel = new core.Channel();
-    channel.onmessage = cb;
-    await commands.watchPosition(options, channel);
+    channel.onmessage = (message) => {
+        if (typeof message === 'string') {
+            cb(null, message);
+        }
+        else {
+            cb(message);
+        }
+    };
+    await core.invoke('plugin:geolocation|watch_position', {
+        options,
+        channel
+    });
     return channel.id;
 }
-const { getCurrentPosition, clearWatch, checkPermissions, requestPermissions, } = commands;
-// export { events };
+async function getCurrentPosition(options) {
+    return await core.invoke('plugin:geolocation|get_current_position', {
+        options
+    });
+}
+async function clearWatch(channelId) {
+    await core.invoke('plugin:geolocation|clear_watch', {
+        channelId
+    });
+}
+async function checkPermissions() {
+    return await core.checkPermissions('geolocation');
+}
+async function requestPermissions(permissions) {
+    return await core.invoke('plugin:geolocation|request_permissions', {
+        permissions
+    });
+}
 
 exports.checkPermissions = checkPermissions;
 exports.clearWatch = clearWatch;

package/dist-js/index.d.ts

@@ -1,4 +1,84 @@
-import { type PositionOptions, type Position } from "./bindings";
-export declare function watchPosition(options: PositionOptions, cb: (location: Position | string) => void): Promise<number>;
-export declare const getCurrentPosition: (options: PositionOptions | null) => Promise<import("./bindings").Result<Position, import("./bindings").Error>>, clearWatch: (channelId: number) => Promise<import("./bindings").Result<null, import("./bindings").Error>>, checkPermissions: () => Promise<import("./bindings").Result<import("./bindings").PermissionStatus, import("./bindings").Error>>, requestPermissions: (permissions: import("./bindings").PermissionType[] | null) => Promise<import("./bindings").Result<import("./bindings").PermissionStatus, import("./bindings").Error>>;
-export type { PermissionState, PermissionStatus, PermissionType, Position, PositionOptions, Coordinates, } from "./bindings";
+import { PermissionState } from '@tauri-apps/api/core';
+export type Coordinates = {
+    /**
+     * Latitude in decimal degrees.
+     */
+    latitude: number;
+    /**
+     * Longitude in decimal degrees.
+     */
+    longitude: number;
+    /**
+     * Accuracy level of the latitude and longitude coordinates in meters.
+     */
+    accuracy: number;
+    /**
+     * Accuracy level of the altitude coordinate in meters, if available.
+     * Available on all iOS versions and on Android 8 and above.
+     */
+    altitudeAccuracy: number | null;
+    /**
+     * The altitude the user is at, if available.
+     */
+    altitude: number | null;
+    speed: number | null;
+    /**
+     * The heading the user is facing, if available.
+     */
+    heading: number | null;
+};
+export type PermissionStatus = {
+    /**
+     * Permission state for the location alias.
+     *
+     * On Android it requests/checks both ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION permissions.
+     *
+     * On iOS it requests/checks location permissions.
+     */
+    location: PermissionState;
+    /**
+     * Permissions state for the coarseLoaction alias.
+     *
+     * On Android it requests/checks ACCESS_COARSE_LOCATION.
+     *
+     * On Android 12+, users can choose between Approximate location (ACCESS_COARSE_LOCATION) and Precise location (ACCESS_FINE_LOCATION).
+     *
+     * On iOS it will have the same value as the `location` alias.
+     */
+    coarseLocation: PermissionState;
+};
+export type PermissionType = 'location' | 'coarseLocation';
+export type Position = {
+    /**
+     * Creation time for these coordinates.
+     */
+    timestamp: number;
+    /**
+     * The GPD coordinates along with the accuracy of the data.
+     */
+    coords: Coordinates;
+};
+export type PositionOptions = {
+    /**
+     * High accuracy mode (such as GPS, if available)
+     * Will be ignored on Android 12+ if users didn't grant the ACCESS_FINE_LOCATION permission (`coarseLocation` permission).
+     */
+    enableHighAccuracy: boolean;
+    /**
+     * The maximum wait time in milliseconds for location updates.
+     * On Android the timeout gets ignored for getCurrentPosition.
+     * Ignored on iOS
+     */
+    timeout: number;
+    /**
+     * The maximum age in milliseconds of a possible cached position that is acceptable to return.
+     * Default: 0
+     * Ignored on iOS
+     */
+    maximumAge: number;
+};
+export declare function watchPosition(options: PositionOptions, cb: (location: Position | null, error?: string) => void): Promise<number>;
+export declare function getCurrentPosition(options?: PositionOptions): Promise<Position>;
+export declare function clearWatch(channelId: number): Promise<void>;
+export declare function checkPermissions(): Promise<PermissionStatus>;
+export declare function requestPermissions(permissions: PermissionType[] | null): Promise<PermissionStatus>;

package/dist-js/index.js

@@ -1,107 +1,41 @@
-import { invoke, Channel } from '@tauri-apps/api/core';
-import '@tauri-apps/api/event';
+import { Channel, invoke, checkPermissions as checkPermissions$1 } from '@tauri-apps/api/core';
 
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
-// @ts-nocheck
-// This file was generated by [tauri-specta](https://github.com/oscartbeaumont/tauri-specta). Do not edit this file manually.
-/** user-defined commands **/
-const commands = {
-    async getCurrentPosition(options) {
-        try {
-            return {
-                status: "ok",
-                data: await invoke("plugin:geolocation|get_current_position", {
-                    options,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async watchPosition(options, channel) {
-        try {
-            return {
-                status: "ok",
-                data: await invoke("plugin:geolocation|watch_position", {
-                    options,
-                    channel,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async clearWatch(channelId) {
-        try {
-            return {
-                status: "ok",
-                data: await invoke("plugin:geolocation|clear_watch", {
-                    channelId,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async checkPermissions() {
-        try {
-            return {
-                status: "ok",
-                data: await invoke("plugin:geolocation|check_permissions"),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-    async requestPermissions(permissions) {
-        try {
-            return {
-                status: "ok",
-                data: await invoke("plugin:geolocation|request_permissions", {
-                    permissions,
-                }),
-            };
-        }
-        catch (e) {
-            if (e instanceof Error)
-                throw e;
-            else
-                return { status: "error", error: e };
-        }
-    },
-};
-
-// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-License-Identifier: MIT
-/* eslint-disable @typescript-eslint/unbound-method */
-async function watchPosition(options, 
-// TODO: This can receive errors too
-cb) {
+async function watchPosition(options, cb) {
     const channel = new Channel();
-    channel.onmessage = cb;
-    await commands.watchPosition(options, channel);
+    channel.onmessage = (message) => {
+        if (typeof message === 'string') {
+            cb(null, message);
+        }
+        else {
+            cb(message);
+        }
+    };
+    await invoke('plugin:geolocation|watch_position', {
+        options,
+        channel
+    });
     return channel.id;
 }
-const { getCurrentPosition, clearWatch, checkPermissions, requestPermissions, } = commands;
-// export { events };
+async function getCurrentPosition(options) {
+    return await invoke('plugin:geolocation|get_current_position', {
+        options
+    });
+}
+async function clearWatch(channelId) {
+    await invoke('plugin:geolocation|clear_watch', {
+        channelId
+    });
+}
+async function checkPermissions() {
+    return await checkPermissions$1('geolocation');
+}
+async function requestPermissions(permissions) {
+    return await invoke('plugin:geolocation|request_permissions', {
+        permissions
+    });
+}
 
 export { checkPermissions, clearWatch, getCurrentPosition, requestPermissions, watchPosition };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tauri-apps/plugin-geolocation",
-  "version": "2.0.0-rc.1",
-  "license": "MIT or APACHE-2.0",
+  "version": "2.0.0",
+  "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
   ],
@@ -24,6 +24,6 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "^2.0.0-rc.4"
+    "@tauri-apps/api": "^2.0.0"
   }
 }

package/dist-js/bindings.d.ts

@@ -1,113 +0,0 @@
-/** user-defined commands **/
-export declare const commands: {
-    getCurrentPosition(options: PositionOptions | null): Promise<Result<Position, Error>>;
-    watchPosition(options: PositionOptions, channel: any): Promise<Result<null, Error>>;
-    clearWatch(channelId: number): Promise<Result<null, Error>>;
-    checkPermissions(): Promise<Result<PermissionStatus, Error>>;
-    requestPermissions(permissions: PermissionType[] | null): Promise<Result<PermissionStatus, Error>>;
-};
-/** user-defined events **/
-/** user-defined statics **/
-/** user-defined types **/
-export type Coordinates = {
-    /**
-     * Latitude in decimal degrees.
-     */
-    latitude: number;
-    /**
-     * Longitude in decimal degrees.
-     */
-    longitude: number;
-    /**
-     * Accuracy level of the latitude and longitude coordinates in meters.
-     */
-    accuracy: number;
-    /**
-     * Accuracy level of the altitude coordinate in meters, if available.
-     * Available on all iOS versions and on Android 8 and above.
-     */
-    altitudeAccuracy: number | null;
-    /**
-     * The altitude the user is at, if available.
-     */
-    altitude: number | null;
-    speed: number | null;
-    /**
-     * The heading the user is facing, if available.
-     */
-    heading: number | null;
-};
-export type Error = never;
-/**
- * Permission state.
- */
-export type PermissionState = 
-/**
- * Permission access has been granted.
- */
-"granted"
-/**
- * Permission access has been denied.
- */
- | "denied"
-/**
- * The end user should be prompted for permission.
- */
- | "prompt";
-export type PermissionStatus = {
-    /**
-     * Permission state for the location alias.
-     *
-     * On Android it requests/checks both ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION permissions.
-     *
-     * On iOS it requests/checks location permissions.
-     */
-    location: PermissionState;
-    /**
-     * Permissions state for the coarseLoaction alias.
-     *
-     * On Android it requests/checks ACCESS_COARSE_LOCATION.
-     *
-     * On Android 12+, users can choose between Approximate location (ACCESS_COARSE_LOCATION) and Precise location (ACCESS_FINE_LOCATION).
-     *
-     * On iOS it will have the same value as the `location` alias.
-     */
-    coarseLocation: PermissionState;
-};
-export type PermissionType = "location" | "coarseLocation";
-export type Position = {
-    /**
-     * Creation time for these coordinates.
-     */
-    timestamp: number;
-    /**
-     * The GPD coordinates along with the accuracy of the data.
-     */
-    coords: Coordinates;
-};
-export type PositionOptions = {
-    /**
-     * High accuracy mode (such as GPS, if available)
-     * Will be ignored on Android 12+ if users didn't grant the ACCESS_FINE_LOCATION permission.
-     */
-    enableHighAccuracy: boolean;
-    /**
-     * The maximum wait time in milliseconds for location updates.
-     * On Android the timeout gets ignored for getCurrentPosition.
-     * Ignored on iOS
-     */
-    timeout: number;
-    /**
-     * The maximum age in milliseconds of a possible cached position that is acceptable to return.
-     * Default: 0
-     * Ignored on iOS
-     */
-    maximumAge: number;
-};
-export type Result<T, E> = {
-    status: "ok";
-    data: T;
-} | {
-    status: "error";
-    error: E;
-};