@tokamakdev/plugin-location 0.1.0-beta.127 → 0.1.0-beta.129

package/events/index.ts

@@ -1,18 +0,0 @@
-import { defineEvent } from "@tokamakdev/plugin/events";
-
-import "../src/types.js";
-
-/**
- * Receives the positions of continuous updates and significant changes in native builds: on
- * screen, off screen, or after the system launches the app for them.
- */
-export const onLocationUpdate = defineEvent("location.update");
-
-/** Receives each region entry or exit, including one that launches the app. */
-export const onRegionTransition = defineEvent("location.region");
-
-/** Apple only: receives each arrival at or departure from a place, including one that launches the app. */
-export const onVisit = defineEvent("location.visit");
-
-/** Receives failures of background location services, such as a region the system cannot monitor. */
-export const onLocationError = defineEvent("location.error");

package/src/android.ts

@@ -1,150 +0,0 @@
-import type { TokamakContext } from "@tokamakdev/plugin";
-import { applicationContext, release } from "@tokamakdev/plugin/bindings";
-
-import {
-  CancellationSignal,
-  Consumer,
-  Context,
-  Location,
-  LocationListener,
-  LocationManager,
-  LocationRequest,
-  LocationRequest$Builder,
-  SystemClock,
-  type Executor,
-} from "../android/bindings.js";
-import { permissionDenied, unavailable, within } from "./errors.js";
-import type { Position, PositionOptions } from "./types.js";
-
-/**
- * The device's position: the provider's last known when no older than `maximumAge`, or a new
- * high-accuracy fix within `timeout`. Null when Android finds none.
- */
-export async function currentPosition(ctx: TokamakContext, { maximumAge = 0, timeout }: PositionOptions): Promise<Position | null> {
-  const { context, manager } = await locationManager(ctx);
-  const name = await provider(manager);
-  const recent = await manager.getLastKnownLocation(name);
-  if (recent && await age(ctx, recent) <= maximumAge) return await position(recent);
-  const [request, signal, executor] = await Promise.all([highAccuracy(ctx, 0), CancellationSignal.new(ctx), mainExecutor(context)]);
-  let consumer: Consumer | undefined;
-  let finished = false;
-  const found = new Promise<Position | null>((resolve, reject) => {
-    Consumer.implement(ctx, {
-      accept(location) { resolve(location instanceof Location ? position(location) : null); },
-    }).then(async (created) => {
-      consumer = created;
-      if (finished) {
-        release(created);
-        return;
-      }
-      await manager.getCurrentLocation(name, request, signal, executor, created);
-    }).catch((failure: unknown) => { reject(locationError(failure as Error)); });
-  });
-  return within(found, timeout, () => {
-    finished = true;
-    void signal.cancel();
-    if (consumer) release(consumer);
-  });
-}
-
-/** Passes each position the provider reports to `next`, and its failures to `error`, until the returned function is called. */
-export async function watchPositions(
-  ctx: TokamakContext,
-  next: (position: Position) => void,
-  error: (error: unknown) => void,
-): Promise<() => void> {
-  const { context, manager } = await locationManager(ctx);
-  const [name, executor, request] = await Promise.all([provider(manager), mainExecutor(context), highAccuracy(ctx, 1000)]);
-  const listener = await LocationListener.implement(ctx, {
-    async onLocationChanged(location) {
-      next(await position(location));
-      release(location);
-    },
-    onProviderDisabled() { error(unavailable("Location provider is unavailable")); },
-  });
-  try {
-    await manager.requestLocationUpdates(name, request, executor, listener);
-  } catch (failure) {
-    release(listener);
-    throw locationError(failure as Error);
-  }
-  return () => {
-    void manager.removeUpdates(listener).finally(() => { release(listener); });
-  };
-}
-
-async function locationManager(ctx: TokamakContext): Promise<{ context: Context; manager: LocationManager }> {
-  const context = new Context(await applicationContext(ctx));
-  const manager = await context.getSystemService(Context.LOCATION_SERVICE);
-  if (!(manager instanceof LocationManager)) throw unavailable("The device has no location service");
-  return { context, manager };
-}
-
-async function mainExecutor(context: Context): Promise<Executor> {
-  const executor = await context.getMainExecutor();
-  if (!executor) throw unavailable("The app has no main executor");
-  return executor;
-}
-
-/**
- * The first enabled of the fused provider, which combines GPS with Wi-Fi and cell signals, GPS and
- * the network, or any other enabled provider.
- */
-async function provider(manager: LocationManager): Promise<string> {
-  for (const name of [LocationManager.FUSED_PROVIDER, LocationManager.GPS_PROVIDER, LocationManager.NETWORK_PROVIDER]) {
-    if (await manager.isProviderEnabled(name)) return name;
-  }
-  const [other] = await manager.getProviders(true);
-  if (!other) throw unavailable("No location provider is available");
-  return other;
-}
-
-/** A request for the most accurate fixes the provider can give, every `interval` milliseconds. */
-async function highAccuracy(ctx: TokamakContext, interval: number): Promise<LocationRequest> {
-  const builder = await LocationRequest$Builder.new(ctx, interval);
-  await builder.setQuality(LocationRequest.QUALITY_HIGH_ACCURACY);
-  return builder.build();
-}
-
-/** The milliseconds since Android took `location`. */
-async function age(ctx: TokamakContext, location: Location): Promise<number> {
-  const [now, taken] = await Promise.all([SystemClock.elapsedRealtimeNanos(ctx), location.getElapsedRealtimeNanos()]);
-  return (now - taken) / 1_000_000;
-}
-
-async function position(location: Location): Promise<Position> {
-  const [latitude, longitude, accuracy, hasAltitude, altitude, hasVertical, vertical, hasBearing, bearing, hasSpeed, speed, time] =
-    await Promise.all([
-      location.getLatitude(),
-      location.getLongitude(),
-      location.getAccuracy(),
-      location.hasAltitude(),
-      location.getAltitude(),
-      location.hasVerticalAccuracy(),
-      location.getVerticalAccuracyMeters(),
-      location.hasBearing(),
-      location.getBearing(),
-      location.hasSpeed(),
-      location.getSpeed(),
-      location.getTime(),
-    ]);
-  return {
-    coords: {
-      latitude,
-      longitude,
-      accuracy,
-      altitude: hasAltitude ? altitude : null,
-      altitudeAccuracy: hasVertical ? vertical : null,
-      heading: hasBearing ? bearing : null,
-      speed: hasSpeed ? speed : null,
-    },
-    timestamp: time,
-  };
-}
-
-/** The error a failed Android call rejected with, as location operations name it. */
-function locationError(failure: Error): Error {
-  if (!(failure instanceof DOMException)) return failure;
-  const exception = (failure.cause as { exception?: string } | undefined)?.exception;
-  return exception === "java.lang.SecurityException" ? permissionDenied() : unavailable(failure.message);
-}

package/src/apple.ts

@@ -1,117 +0,0 @@
-import type { TokamakContext } from "@tokamakdev/plugin";
-import { release } from "@tokamakdev/plugin/bindings";
-
-import { CLLocationManager, CLLocationManagerDelegate, type CLLocation } from "../apple/bindings.js";
-import { permissionDenied, unavailable, within } from "./errors.js";
-import type { Position, PositionOptions } from "./types.js";
-
-/** The Core Location error codes the plugin tells apart. */
-const locationUnknown = 0;
-const denied = 1;
-
-/** The device's position: Core Location's latest when no older than `maximumAge`, or a new fix within `timeout`. */
-export async function currentPosition(ctx: TokamakContext, { maximumAge = 0, timeout }: PositionOptions): Promise<Position> {
-  const manager = await CLLocationManager.init(ctx);
-  try {
-    const recent = await manager.location();
-    if (recent && Date.now() - (await recent.timestamp()).getTime() <= maximumAge) return await position(recent);
-    return await nextFix(ctx, manager, timeout);
-  } finally {
-    release(manager);
-  }
-}
-
-/** The next fix `manager` takes, asking again while Core Location does not know the position yet. */
-function nextFix(ctx: TokamakContext, manager: CLLocationManager, timeout: number | undefined): Promise<Position> {
-  let delegate: CLLocationManagerDelegate | undefined;
-  let finished = false;
-  const found = new Promise<Position>((resolve, reject) => {
-    CLLocationManagerDelegate.implement(ctx, {
-      locationManagerDidUpdateLocations(_, locations) {
-        const latest = locations.at(-1);
-        if (latest) resolve(position(latest));
-      },
-      locationManagerDidFailWithError(_, error) {
-        if (code(error) === locationUnknown) manager.requestLocation().catch(reject);
-        else reject(locationError(error));
-      },
-    }).then(async (created) => {
-      delegate = created;
-      if (finished) {
-        release(created);
-        return;
-      }
-      await manager.setDelegate(created);
-      await manager.requestLocation();
-    }).catch(reject);
-  });
-  return within(found, timeout, () => {
-    finished = true;
-    if (delegate) release(delegate);
-  });
-}
-
-/** Passes each position Core Location reports to `next`, and its failures to `error`, until the returned function is called. */
-export async function watchPositions(
-  ctx: TokamakContext,
-  next: (position: Position) => void,
-  error: (error: unknown) => void,
-): Promise<() => void> {
-  const manager = await CLLocationManager.init(ctx);
-  const delegate = await CLLocationManagerDelegate.implement(ctx, {
-    async locationManagerDidUpdateLocations(updated, locations) {
-      release(updated);
-      for (const location of locations) {
-        next(await position(location));
-        release(location);
-      }
-    },
-    locationManagerDidFailWithError(updated, failure) {
-      release(updated);
-      if (code(failure) !== locationUnknown) error(locationError(failure));
-    },
-  });
-  await manager.setDelegate(delegate);
-  await manager.startUpdatingLocation();
-  return () => {
-    void manager.stopUpdatingLocation().finally(() => {
-      release(delegate);
-      release(manager);
-    });
-  };
-}
-
-async function position(location: CLLocation): Promise<Position> {
-  const [coordinate, accuracy, altitude, verticalAccuracy, course, speed, timestamp] = await Promise.all([
-    location.coordinate(),
-    location.horizontalAccuracy(),
-    location.altitude(),
-    location.verticalAccuracy(),
-    location.course(),
-    location.speed(),
-    location.timestamp(),
-  ]);
-  // Core Location reports a negative accuracy, course or speed when it has none.
-  return {
-    coords: {
-      latitude: coordinate.latitude,
-      longitude: coordinate.longitude,
-      accuracy,
-      altitude: verticalAccuracy >= 0 ? altitude : null,
-      altitudeAccuracy: verticalAccuracy >= 0 ? verticalAccuracy : null,
-      heading: course >= 0 ? course : null,
-      speed: speed >= 0 ? speed : null,
-    },
-    timestamp: timestamp.getTime(),
-  };
-}
-
-/** The code of a Core Location error. */
-function code(error: DOMException): number | undefined {
-  const cause = error.cause as { domain?: string; code?: number } | undefined;
-  return cause?.domain === "kCLErrorDomain" ? cause.code : undefined;
-}
-
-function locationError(error: DOMException): DOMException {
-  return code(error) === denied ? permissionDenied() : unavailable(error.message);
-}