@tokamakdev/plugin-location 0.1.0-beta.107 → 0.1.0-beta.114

package/web/client.ts

@@ -0,0 +1,11 @@
+import { valueStream, type JsonStream } from "@tokamakdev/plugin/streams";
+import * as web from "./index.js";
+import type { Position, PositionOptions } from "../src/types.js";
+
+export const location = {
+  getCurrentPosition: (options: PositionOptions = {}) => web.getCurrentPosition(options),
+  permission: web.permission,
+  watchPosition(): Promise<JsonStream<Position>> {
+    return Promise.resolve(valueStream<Position>((next, error) => web.watchPosition(next, error), "dropOldest"));
+  },
+};

package/src/checks.ts

@@ -1,65 +0,0 @@
-/** Checks of the values the plugin's methods take, which throw `TypeError` naming the value. */
-export type Check = (value: unknown, path: string) => void;
-
-/** Checks that `value` is an object, then each field `checks` names that it has or `required` lists. */
-export function object(checks: Readonly<Record<string, Check>>, required: readonly string[] = []): Check {
-  return (value, path) => {
-    if (typeof value !== "object" || value === null || Array.isArray(value)) {
-      throw new TypeError(`${path} must be an object`);
-    }
-    for (const [key, check] of Object.entries(checks)) {
-      const field = (value as Record<string, unknown>)[key];
-      if (field !== undefined || required.includes(key)) check(field, `${path}.${key}`);
-    }
-  };
-}
-
-export function flag(value: unknown, path: string): void {
-  if (typeof value !== "boolean") throw new TypeError(`${path} must be a boolean`);
-}
-
-export function text(value: unknown, path: string): void {
-  if (typeof value !== "string") throw new TypeError(`${path} must be a string`);
-}
-
-export function nonEmptyText(value: unknown, path: string): void {
-  if (typeof value !== "string" || value === "") throw new TypeError(`${path} must be a non-empty string`);
-}
-
-export function oneOf(...allowed: readonly string[]): Check {
-  return (value, path) => {
-    if (!allowed.includes(value as string)) {
-      throw new TypeError(`${path} must be one of ${allowed.map((name) => `"${name}"`).join(", ")}`);
-    }
-  };
-}
-
-/** A finite number of at least 0. */
-export function atLeastZero(value: unknown, path: string): void {
-  if (!(typeof value === "number" && Number.isFinite(value) && value >= 0)) {
-    throw new TypeError(`${path} must be a finite number of at least 0`);
-  }
-}
-
-/** A whole number of at least 0. */
-export function wholeAtLeastZero(value: unknown, path: string): void {
-  if (!(Number.isSafeInteger(value) && (value as number) >= 0)) {
-    throw new TypeError(`${path} must be a whole number of at least 0`);
-  }
-}
-
-/** A number from `min` to `max`. */
-export function between(min: number, max: number): Check {
-  return (value, path) => {
-    if (!(typeof value === "number" && value >= min && value <= max)) {
-      throw new TypeError(`${path} must be a number from ${String(min)} to ${String(max)}`);
-    }
-  };
-}
-
-/** A finite number greater than 0. */
-export function positive(value: unknown, path: string): void {
-  if (!(typeof value === "number" && Number.isFinite(value) && value > 0)) {
-    throw new TypeError(`${path} must be a finite number greater than 0`);
-  }
-}

package/src/options.ts

@@ -1,54 +0,0 @@
-import {
-  atLeastZero,
-  between,
-  flag,
-  nonEmptyText,
-  object,
-  oneOf,
-  positive,
-  text,
-  wholeAtLeastZero,
-} from "./checks.js";
-import type { Region } from "./types.js";
-
-/** Throws `TypeError` unless `config` is a configuration `setup` takes. */
-export const validateSetup = object({ significantChanges: flag, visits: flag });
-
-/** Throws `TypeError` unless `options` are options `requestPermission` takes. */
-export const validatePermissionRequest = object({
-  background: flag,
-  precision: oneOf("precise", "approximate"),
-  purpose: nonEmptyText,
-});
-
-/** Throws `TypeError` unless `options` are options `startUpdates` takes. */
-export const validateUpdateOptions = object({
-  activity: oneOf("default", "automotiveNavigation", "otherNavigation", "fitness", "airborne", "maritime"),
-  accuracy: oneOf("high", "balanced", "low"),
-  distance: atLeastZero,
-  interval: wholeAtLeastZero,
-  foregroundService: object(
-    { title: nonEmptyText, body: text, channel: nonEmptyText },
-    ["title", "body", "channel"],
-  ),
-});
-
-const REGION = object(
-  {
-    id: nonEmptyText,
-    latitude: between(-90, 90),
-    longitude: between(-180, 180),
-    radius: positive,
-    onEntry: flag,
-    onExit: flag,
-  },
-  ["id", "latitude", "longitude", "radius"],
-);
-
-/** `region`, with `onEntry` and `onExit` given. Throws `TypeError` unless it is a region to monitor. */
-export function monitoredRegion(region: Region): Required<Region> {
-  REGION(region, "region");
-  const { id, latitude, longitude, radius, onEntry = true, onExit = true } = region;
-  if (!onEntry && !onExit) throw new TypeError("region must report entry, exit or both");
-  return { id, latitude, longitude, radius, onEntry, onExit };
-}