@symbiote-native/sensors 0.3.0 → 0.4.0

package/src/solid/primitives/create-pedometer.ts

@@ -0,0 +1,31 @@
+// Solid lifecycle wiring over the framework-agnostic watchStepCount free function (core/) — the
+// Solid twin of react/hooks/use-pedometer, vue/composables/use-pedometer and
+// svelte/runes/use-pedometer.svelte.ts. Pedometer is the one sensor here that is not a
+// DeviceSensor subclass (core/pedometer.ts's header), so it has no setUpdateInterval and takes no
+// interval argument — hence its own body instead of ./device-sensor-accessor.
+//
+// `primitives/` and `create*`, and an ACCESSOR rather than a snapshot, for the reasons recorded in
+// adapters/solid/src/primitives/create-color-scheme.ts.
+
+import { createSignal, onCleanup, type Accessor } from 'solid-js';
+import {
+  watchStepCount,
+  type EventSubscription,
+  type IPedometerResult,
+} from '../../core';
+
+export function createPedometer(): Accessor<IPedometerResult | null> {
+  const [result, setResult] = createSignal<IPedometerResult | null>(null);
+
+  // Subscribed from the primitive body, not from an effect: React/Vue/Svelte start listening a
+  // tick after their seed runs, so a step count landing in that window is lost.
+  const subscription: EventSubscription = watchStepCount(next => {
+    setResult(next);
+  });
+
+  onCleanup(() => {
+    subscription.remove();
+  });
+
+  return result;
+}

package/src/solid/primitives/device-sensor-accessor.ts

@@ -0,0 +1,105 @@
+// The one lifecycle body every DeviceSensor-shaped primitive in this folder delegates to
+// (Accelerometer, Barometer, DeviceMotion, Gyroscope, LightSensor, Magnetometer,
+// MagnetometerUncalibrated). Internal — not re-exported from ../index.ts, whose surface stays at
+// parity with the react/vue/svelte entries.
+//
+// `primitives/` and `create*`, never `hooks/` + `use*`: Solid's ecosystem calls a composable
+// reactive function a PRIMITIVE and reserves `use*` for consuming something that already exists.
+// Full rationale in adapters/solid/src/primitives/create-color-scheme.ts.
+//
+// Returns an ACCESSOR, never a snapshot: a Solid component body runs ONCE, so a returned
+// measurement would pin the caller to `null` forever.
+//
+// ## Why the interval is `number | Accessor<number | undefined>`
+//
+// React re-reads `updateIntervalMs` on every render and re-runs its effect when it changes; Vue
+// and Svelte read it once at subscribe time. Neither shape ports: a Solid body runs once, so a
+// plain parameter freezes the sample rate at whatever the caller passed at mount, and nothing
+// reports it — the caller's `intervalMs` state moves and the native rate does not. So the
+// parameter accepts EITHER form (solid-primitives' `MaybeAccessor` convention): a literal for the
+// common static case, keeping the call site identical to the other adapters, or an accessor when
+// the rate is derived from state. The accessor form is the reactive one and is the only one that
+// creates an effect.
+//
+// Applying it splits in two on purpose. The mount-time value is applied SYNCHRONOUSLY, before
+// `addListener`, so the very first native sample already arrives at the requested rate; the
+// tracking effect is then `defer`red so it fires only on a LATER change. Without the defer the
+// interval would be set twice at mount, and the second call would land a tick after the first
+// samples.
+//
+// Outside a component or `createRoot` there is no owner for `onCleanup` — Solid warns and the
+// native listener lives for the process. The accessor still tracks; only the teardown is lost.
+
+import {
+  createEffect,
+  createSignal,
+  on,
+  onCleanup,
+  untrack,
+  type Accessor,
+} from 'solid-js';
+import type { EventSubscription, IListener } from '../../core';
+
+export type IUpdateIntervalMs =
+  number | Accessor<number | undefined> | undefined;
+
+// Structural, not `DeviceSensor<Measurement>`: this needs exactly two methods, and every test in
+// this folder passes a plain object in place of the singleton.
+type ISensorHandle<Measurement> = {
+  addListener(listener: IListener<Measurement>): EventSubscription;
+  setUpdateInterval(intervalMs: number): void;
+};
+
+export function createDeviceSensorAccessor<Measurement>(
+  sensor: ISensorHandle<Measurement>,
+  updateIntervalMs?: IUpdateIntervalMs,
+): Accessor<Measurement | null> {
+  const [measurement, setMeasurement] = createSignal<Measurement | null>(null);
+
+  function applyInterval(intervalMs: number | undefined): void {
+    // `!== undefined`, not truthiness: 0 is a legitimate "as fast as possible" rate, and an
+    // unconditional call would stomp the rate another consumer of this shared singleton set.
+    if (intervalMs !== undefined) {
+      sensor.setUpdateInterval(intervalMs);
+    }
+  }
+
+  // untracked: a primitive built inside a tracked scope must not re-run — and re-subscribe —
+  // just because it read the caller's interval accessor once.
+  applyInterval(
+    untrack(() =>
+      typeof updateIntervalMs === 'function'
+        ? updateIntervalMs()
+        : updateIntervalMs,
+    ),
+  );
+
+  // Subscribed from the primitive body, not from an effect: React/Vue/Svelte start listening a
+  // tick after their seed runs, so an event landing in that window is lost. Both statements here
+  // run in one synchronous tick and nothing can interleave.
+  const subscription: EventSubscription = sensor.addListener(next => {
+    // The updater form, because `Measurement` is unconstrained — a bare value would be read as a
+    // reducer for any measurement type that could itself be callable.
+    setMeasurement(() => next);
+  });
+
+  onCleanup(() => {
+    subscription.remove();
+  });
+
+  if (typeof updateIntervalMs === 'function') {
+    // Only the rate changes — the native listener is per-sensor and unaffected, so re-subscribing
+    // (as React's interval-keyed effect does) would drop events for nothing.
+    createEffect(
+      on(
+        updateIntervalMs,
+        intervalMs => {
+          applyInterval(intervalMs);
+        },
+        { defer: true },
+      ),
+    );
+  }
+
+  return measurement;
+}

package/src/svelte/index.ts

@@ -8,7 +8,11 @@ export type { IAccelerometerMeasurement } from '../core';
 export { useBarometer } from './runes/use-barometer.svelte';
 export type { IBarometerMeasurement } from '../core';
 export { useDeviceMotion } from './runes/use-device-motion.svelte';
-export { DeviceMotionOrientation, gravity, type IDeviceMotionMeasurement } from '../core';
+export {
+  DeviceMotionOrientation,
+  gravity,
+  type IDeviceMotionMeasurement,
+} from '../core';
 export { useGyroscope } from './runes/use-gyroscope.svelte';
 export type { IGyroscopeMeasurement } from '../core';
 export { useLightSensor } from './runes/use-light-sensor.svelte';

package/src/svelte/runes/use-accelerometer.svelte.ts

@@ -9,7 +9,11 @@
 //
 // `updateIntervalMs` is a plain number, not a getter: it applies once at subscribe time and
 // never reacts to a later change, matching the Vue/React twins.
-import { Accelerometer, type EventSubscription, type IAccelerometerMeasurement } from '../../core';
+import {
+  Accelerometer,
+  type EventSubscription,
+  type IAccelerometerMeasurement,
+} from '../../core';
 
 export function useAccelerometer(updateIntervalMs?: number): {
   readonly current: IAccelerometerMeasurement | null;

package/src/svelte/runes/use-barometer.svelte.ts

@@ -2,7 +2,11 @@
 // use-accelerometer.svelte.ts's shape exactly. See its header for why this lives in `runes/` with
 // a `.svelte.ts` extension, returns a boxed getter object, and takes a plain `updateIntervalMs`
 // rather than a getter.
-import { Barometer, type EventSubscription, type IBarometerMeasurement } from '../../core';
+import {
+  Barometer,
+  type EventSubscription,
+  type IBarometerMeasurement,
+} from '../../core';
 
 export function useBarometer(updateIntervalMs?: number): {
   readonly current: IBarometerMeasurement | null;

package/src/svelte/runes/use-device-motion.svelte.ts

@@ -2,7 +2,11 @@
 // use-accelerometer.svelte.ts's shape exactly. See its header for why this lives in `runes/` with
 // a `.svelte.ts` extension, returns a boxed getter object, and takes a plain `updateIntervalMs`
 // rather than a getter.
-import { DeviceMotion, type EventSubscription, type IDeviceMotionMeasurement } from '../../core';
+import {
+  DeviceMotion,
+  type EventSubscription,
+  type IDeviceMotionMeasurement,
+} from '../../core';
 
 export function useDeviceMotion(updateIntervalMs?: number): {
   readonly current: IDeviceMotionMeasurement | null;

package/src/svelte/runes/use-gyroscope.svelte.ts

@@ -2,7 +2,11 @@
 // use-accelerometer.svelte.ts's shape exactly. See its header for why this lives in `runes/` with
 // a `.svelte.ts` extension, returns a boxed getter object, and takes a plain `updateIntervalMs`
 // rather than a getter.
-import { Gyroscope, type EventSubscription, type IGyroscopeMeasurement } from '../../core';
+import {
+  Gyroscope,
+  type EventSubscription,
+  type IGyroscopeMeasurement,
+} from '../../core';
 
 export function useGyroscope(updateIntervalMs?: number): {
   readonly current: IGyroscopeMeasurement | null;

package/src/svelte/runes/use-light-sensor.svelte.ts

@@ -2,7 +2,11 @@
 // use-accelerometer.svelte.ts's shape exactly. See its header for why this lives in `runes/` with
 // a `.svelte.ts` extension, returns a boxed getter object, and takes a plain `updateIntervalMs`
 // rather than a getter.
-import { LightSensor, type EventSubscription, type ILightSensorMeasurement } from '../../core';
+import {
+  LightSensor,
+  type EventSubscription,
+  type ILightSensorMeasurement,
+} from '../../core';
 
 export function useLightSensor(updateIntervalMs?: number): {
   readonly current: ILightSensorMeasurement | null;

package/src/svelte/runes/use-magnetometer-uncalibrated.svelte.ts

@@ -17,9 +17,10 @@ export function useMagnetometerUncalibrated(updateIntervalMs?: number): {
     if (updateIntervalMs !== undefined) {
       MagnetometerUncalibrated.setUpdateInterval(updateIntervalMs);
     }
-    const subscription: EventSubscription = MagnetometerUncalibrated.addListener(next => {
-      measurement = next;
-    });
+    const subscription: EventSubscription =
+      MagnetometerUncalibrated.addListener(next => {
+        measurement = next;
+      });
     return () => subscription.remove();
   });
 

package/src/svelte/runes/use-magnetometer.svelte.ts

@@ -2,7 +2,11 @@
 // use-accelerometer.svelte.ts's shape exactly. See its header for why this lives in `runes/` with
 // a `.svelte.ts` extension, returns a boxed getter object, and takes a plain `updateIntervalMs`
 // rather than a getter.
-import { Magnetometer, type EventSubscription, type IMagnetometerMeasurement } from '../../core';
+import {
+  Magnetometer,
+  type EventSubscription,
+  type IMagnetometerMeasurement,
+} from '../../core';
 
 export function useMagnetometer(updateIntervalMs?: number): {
   readonly current: IMagnetometerMeasurement | null;

package/src/svelte/runes/use-pedometer.svelte.ts

@@ -3,7 +3,11 @@
 // useAccelerometer there is no interval param to apply at subscribe time. See
 // use-accelerometer.svelte.ts's header for why this lives in `runes/` with a `.svelte.ts`
 // extension and returns a boxed getter object.
-import { watchStepCount, type EventSubscription, type IPedometerResult } from '../../core';
+import {
+  watchStepCount,
+  type EventSubscription,
+  type IPedometerResult,
+} from '../../core';
 
 export function usePedometer(): { readonly current: IPedometerResult | null } {
   let result = $state<IPedometerResult | null>(null);

package/src/vue/composables/use-accelerometer/index.ts

@@ -12,7 +12,9 @@ import {
   type IAccelerometerMeasurement,
 } from '../../../core';
 
-export function useAccelerometer(updateIntervalMs?: number): Ref<IAccelerometerMeasurement | null> {
+export function useAccelerometer(
+  updateIntervalMs?: number,
+): Ref<IAccelerometerMeasurement | null> {
   // A plain ref: the value is a POJO measurement, not an engine node, so no shallowRef needed.
   const measurement = ref<IAccelerometerMeasurement | null>(null);
   let subscription: EventSubscription | undefined;

package/src/vue/composables/use-barometer/index.ts

@@ -6,9 +6,15 @@
 // a later change of updateIntervalMs, so a plain numeric param is enough.
 
 import { onMounted, onUnmounted, ref, type Ref } from '@vue/runtime-core';
-import { Barometer, type EventSubscription, type IBarometerMeasurement } from '../../../core';
+import {
+  Barometer,
+  type EventSubscription,
+  type IBarometerMeasurement,
+} from '../../../core';
 
-export function useBarometer(updateIntervalMs?: number): Ref<IBarometerMeasurement | null> {
+export function useBarometer(
+  updateIntervalMs?: number,
+): Ref<IBarometerMeasurement | null> {
   // A plain ref: the value is a POJO measurement, not an engine node, so no shallowRef needed.
   const measurement = ref<IBarometerMeasurement | null>(null);
   let subscription: EventSubscription | undefined;

package/src/vue/composables/use-device-motion/index.ts

@@ -6,9 +6,15 @@
 // a later change of updateIntervalMs, so a plain numeric param is enough.
 
 import { onMounted, onUnmounted, ref, type Ref } from '@vue/runtime-core';
-import { DeviceMotion, type EventSubscription, type IDeviceMotionMeasurement } from '../../../core';
+import {
+  DeviceMotion,
+  type EventSubscription,
+  type IDeviceMotionMeasurement,
+} from '../../../core';
 
-export function useDeviceMotion(updateIntervalMs?: number): Ref<IDeviceMotionMeasurement | null> {
+export function useDeviceMotion(
+  updateIntervalMs?: number,
+): Ref<IDeviceMotionMeasurement | null> {
   // A plain ref: the value is a POJO measurement, not an engine node, so no shallowRef needed.
   const measurement = ref<IDeviceMotionMeasurement | null>(null);
   let subscription: EventSubscription | undefined;

package/src/vue/composables/use-gyroscope/index.ts

@@ -6,9 +6,15 @@
 // a later change of updateIntervalMs, so a plain numeric param is enough.
 
 import { onMounted, onUnmounted, ref, type Ref } from '@vue/runtime-core';
-import { Gyroscope, type EventSubscription, type IGyroscopeMeasurement } from '../../../core';
+import {
+  Gyroscope,
+  type EventSubscription,
+  type IGyroscopeMeasurement,
+} from '../../../core';
 
-export function useGyroscope(updateIntervalMs?: number): Ref<IGyroscopeMeasurement | null> {
+export function useGyroscope(
+  updateIntervalMs?: number,
+): Ref<IGyroscopeMeasurement | null> {
   // A plain ref: the value is a POJO measurement, not an engine node, so no shallowRef needed.
   const measurement = ref<IGyroscopeMeasurement | null>(null);
   let subscription: EventSubscription | undefined;

package/src/vue/composables/use-light-sensor/index.ts

@@ -6,9 +6,15 @@
 // a later change of updateIntervalMs, so a plain numeric param is enough.
 
 import { onMounted, onUnmounted, ref, type Ref } from '@vue/runtime-core';
-import { LightSensor, type EventSubscription, type ILightSensorMeasurement } from '../../../core';
+import {
+  LightSensor,
+  type EventSubscription,
+  type ILightSensorMeasurement,
+} from '../../../core';
 
-export function useLightSensor(updateIntervalMs?: number): Ref<ILightSensorMeasurement | null> {
+export function useLightSensor(
+  updateIntervalMs?: number,
+): Ref<ILightSensorMeasurement | null> {
   // A plain ref: the value is a POJO measurement, not an engine node, so no shallowRef needed.
   const measurement = ref<ILightSensorMeasurement | null>(null);
   let subscription: EventSubscription | undefined;

package/src/vue/composables/use-magnetometer/index.ts

@@ -6,9 +6,15 @@
 // a later change of updateIntervalMs, so a plain numeric param is enough.
 
 import { onMounted, onUnmounted, ref, type Ref } from '@vue/runtime-core';
-import { Magnetometer, type EventSubscription, type IMagnetometerMeasurement } from '../../../core';
+import {
+  Magnetometer,
+  type EventSubscription,
+  type IMagnetometerMeasurement,
+} from '../../../core';
 
-export function useMagnetometer(updateIntervalMs?: number): Ref<IMagnetometerMeasurement | null> {
+export function useMagnetometer(
+  updateIntervalMs?: number,
+): Ref<IMagnetometerMeasurement | null> {
   // A plain ref: the value is a POJO measurement, not an engine node, so no shallowRef needed.
   const measurement = ref<IMagnetometerMeasurement | null>(null);
   let subscription: EventSubscription | undefined;

package/src/vue/composables/use-pedometer/index.ts

@@ -4,7 +4,11 @@
 // unlike useAccelerometer there is no interval param to apply at subscribe time.
 
 import { onMounted, onUnmounted, ref, type Ref } from '@vue/runtime-core';
-import { watchStepCount, type EventSubscription, type IPedometerResult } from '../../../core';
+import {
+  watchStepCount,
+  type EventSubscription,
+  type IPedometerResult,
+} from '../../../core';
 
 export function usePedometer(): Ref<IPedometerResult | null> {
   // A plain ref: the value is a POJO result, not an engine node, so no shallowRef needed.

package/src/vue/index.ts

@@ -8,7 +8,11 @@ export type { IAccelerometerMeasurement } from '../core';
 export { useBarometer } from './composables/use-barometer';
 export type { IBarometerMeasurement } from '../core';
 export { useDeviceMotion } from './composables/use-device-motion';
-export { DeviceMotionOrientation, gravity, type IDeviceMotionMeasurement } from '../core';
+export {
+  DeviceMotionOrientation,
+  gravity,
+  type IDeviceMotionMeasurement,
+} from '../core';
 export { useGyroscope } from './composables/use-gyroscope';
 export type { IGyroscopeMeasurement } from '../core';
 export { useLightSensor } from './composables/use-light-sensor';