@bikefinder/sdk 0.1.4 → 0.1.6

package/README.md

@@ -50,9 +50,9 @@ The application owns subscription sharing, retained data and account scope. Subs
 
 The application's Auth0 SDK supplies tokens and handles refresh. Create a new client for a new account session. `dispose()` aborts HTTP requests and stops both connections. Requests use bearer authentication, omit cookies and reject redirects. Network/validation failures reject; HTTP Problem Details are available as `result.error` by default. Writes are never automatically retried; a `503 operation_unconfirmed` may already have committed.
 
-REST responses use generated Zod validation. Stream values have generated static types and use the native SignalR decoder; for runtime validation, import `zTrackerDocument` from `@bikefinder/sdk/schemas` and call `.parse(value)`. Both transports reference the same generated payload types. Firestore responses come from the actual C# DTOs in `Firestore/TrackerData.cs` and `Firestore/ResourceData.cs`. The API converts stored data before responding; `readIssues` identifies unusable stored fields. Additional metadata remains in explicit JSON extension fields. Server-serialized response fixtures are validated by both API and generated-client tests. IDs are exact Firestore IDs.
+REST calls return response JSON unchanged with generated static types. The API validates and converts stored data before responding; `readIssues` identifies unusable stored fields. Response validation is opt-in for both REST and SignalR: import `zTrackerDocument` from `@bikefinder/sdk/schemas` and call `.parse(value)` when the caller requires a runtime boundary check. Both transports reference the same generated payload types. Firestore responses come from the actual C# DTOs in `Firestore/TrackerData.cs` and `Firestore/ResourceData.cs`. Additional metadata remains in explicit JSON extension fields. Server-serialized response fixtures are validated by both API and generated-client tests. IDs are exact Firestore IDs.
 
-Other native resources expose their known fields through resource-specific document types. Their C# contracts expose only interpreted fields; unrelated stored fields stay inside the API. Tracker reports and statistics have concrete models, and access-code storage is omitted from responses. Observation values are generated unions: after `observation.definitionId === 5`, `observation.value.percent` is a number. Current readings expose the same discriminator; check `observationId !== null` before using a present reading. Device settings, the built-in workflow descriptor and command argument tuples are generated from the canonical protocol JSON contracts. Bike and preference patches expose supported properties and distinguish omission from explicit null. Response validators preserve additional API fields while checking known values, required properties and enums. Request models retain their declared constraints and closed objects reject unknown write fields. Shared payloads have generated read variants so a tolerant response never weakens a request schema.
+Other native resources expose their known fields through resource-specific document types. Their C# contracts expose only interpreted fields; unrelated stored fields stay inside the API. Tracker reports and statistics have concrete models, and access-code storage is omitted from responses. Observation values are generated unions: after `observation.definitionId === 5`, `observation.value.percent` is a number. Current readings expose the same discriminator; check `observationId !== null` before using a present reading. Device settings, the built-in workflow descriptor and command argument tuples are generated from the canonical protocol JSON contracts. Bike and preference patches expose supported properties and distinguish omission from explicit null. Optional response validators preserve additional API fields while checking known values and required properties. Workflow diagnostic states are extensible strings, including `idle` and `rest`; display or preserve unfamiliar states. Request models retain their declared constraints and closed objects reject unknown write fields. Shared payloads have generated read variants so a tolerant response never weakens a request schema.
 
 The handwritten entry point only configures clients, authentication and disposal. Hub methods, wire names and streaming signatures are generated. A generated type-only bridge reuses OpenAPI payload definitions instead of publishing a second set of models. There is no RxJS or MQTT dependency.
 
@@ -117,13 +117,17 @@ Command reads validate stored identity, catalog arguments, artifacts, and execut
 
 ## Supported API consumers
 
-SDK 2.0.0 is the supported baseline after the explicitly approved pre-launch mode
-alignment. It replaces the experimental `powerSaving`/`precision` mode names and
-their timing setting names with `standard`/`security`. Earlier clients require a
-one-time upgrade for these AWS resources. The tolerant response policy introduced
-in 1.0.27 remains in place. Mode availability is an ID list, and selected mode IDs
-are open strings validated against each tracker's cloud catalog. Adding or removing
-catalog choices does not require another SDK release.
+`@bikefinder/sdk@0.1.6` is the supported baseline for the 2026-11-07 minimum-rest
+and optional response-validation release. Earlier SDKs have closed workflow-state
+validators and should upgrade for the extensible diagnostic response contract.
+The preceding prelaunch cutover retired experimental `@bikefinder/api-client`
+releases and their older AWS contracts. The `/v1` route version is unchanged.
+Future breaking changes still require an explicit retirement decision or a
+separate API version.
+
+The tolerant response policy remains in place. Mode availability is an ID list,
+and selected mode IDs are open strings validated against each tracker's cloud
+catalog. Adding or removing catalog choices does not require another SDK release.
 
 API CI installs the oldest supported immutable npm release selected in
 `tools/check-api-compatibility.mjs`. It validates freshly server-serialized
@@ -140,7 +144,7 @@ version for breaking changes and retain the supported v1 routes. Raising the
 oldest supported SDK version is an explicit retirement decision, not a routine
 way to pass CI. Dev deployment and production promotion both require this job.
 
-Runtime validation still rejects malformed known data. Applications should retain
-last valid stream messages and isolate failures per resource. When patching
+Explicit runtime validation still rejects malformed known data. Callers choosing
+it should retain last valid stream messages and isolate failures per resource. When patching
 settings, send only changed supported fields; preserve unfamiliar response fields
 and do not copy a full response into a write payload.

package/dist/device-schema.d.ts

@@ -5432,7 +5432,7 @@ export declare const observationValueSchema: {
                 };
                 readonly state: {
                     readonly type: "string";
-                    readonly enum: readonly ["idle", "battery", "connect", "cell", "wifi", "publish", "listen", "gps", "gpsPublish"];
+                    readonly enum: readonly ["idle", "battery", "connect", "cell", "wifi", "publish", "listen", "gps", "gpsPublish", "rest"];
                 };
                 readonly owner: {
                     readonly type: "string";
@@ -6354,11 +6354,16 @@ export declare const settingsValueSchema: {
             readonly title: "Charging status maximum age";
             readonly description: "Maximum age of charger readback used for the reported charging status. Independent of charging-control safety deadlines; does not authorize charging or schedule extra hardware reads. Confirmed input loss still reports not charging immediately.";
         };
+        readonly workReportingEnabled: {
+            readonly type: "boolean";
+            readonly title: "Automatic work reporting";
+            readonly description: "Upload work.completed cycle outcomes and interval accounting on existing connections. Off by default. automaticDiagnosticsPower controls eligible power sources. Cached on-demand observations remain available when off; workflowDebugEnabled independently controls detailed step traces.";
+        };
     };
     readonly "x-bf": {
         readonly domain: "settings";
         readonly version: 1;
-        readonly settingsSchemaVersion: 27;
+        readonly settingsSchemaVersion: 28;
     };
 };
 export declare const observationDefinitions: readonly [{
@@ -9719,7 +9724,7 @@ export interface RecoveryCounts {
 export interface WorkflowExecution {
     workflowVersion: number;
     mode: string;
-    state: "idle" | "battery" | "connect" | "cell" | "wifi" | "publish" | "listen" | "gps" | "gpsPublish";
+    state: "idle" | "battery" | "connect" | "cell" | "wifi" | "publish" | "listen" | "gps" | "gpsPublish" | "rest";
     owner: "workflow" | "command" | "update" | "recovery" | "shutdown" | "fault" | "settings" | "charging" | "ble" | "network";
     phase: "entered" | "completed" | "cancelled" | "ownerChanged" | "snapshot";
     outcome: ("done" | "unavailable" | "failed" | "timeout" | "cancelled") | null;
@@ -10075,6 +10080,10 @@ export type WiFiScanType = "active" | "passive";
  * Maximum age of charger readback used for the reported charging status. Independent of charging-control safety deadlines; does not authorize charging or schedule extra hardware reads. Confirmed input loss still reports not charging immediately.
  */
 export type ChargingStatusMaximumAge = number;
+/**
+ * Upload work.completed cycle outcomes and interval accounting on existing connections. Off by default. automaticDiagnosticsPower controls eligible power sources. Cached on-demand observations remain available when off; workflowDebugEnabled independently controls detailed step traces.
+ */
+export type AutomaticWorkReporting = boolean;
 export interface DeviceSettings {
     batteryIntervalSeconds?: BatteryMeasurementInterval;
     accTapSensitivity?: AccelerometerTapSensitivity;
@@ -10142,6 +10151,7 @@ export interface DeviceSettings {
     wifiScanBudgetMs?: WiFiScanBudget;
     wifiScanType?: WiFiScanType;
     chargingStatusMaxAgeSeconds?: ChargingStatusMaximumAge;
+    workReportingEnabled?: AutomaticWorkReporting;
 }
 type Definition = (typeof observationDefinitions)[number];
 export type MetricName = Definition["name"];

package/dist/device-schema.js

@@ -6511,7 +6511,8 @@ export const observationValueSchema = {
                         "publish",
                         "listen",
                         "gps",
-                        "gpsPublish"
+                        "gpsPublish",
+                        "rest"
                     ]
                 },
                 "owner": {
@@ -7647,12 +7648,17 @@ export const settingsValueSchema = {
             "maximum": 86400,
             "title": "Charging status maximum age",
             "description": "Maximum age of charger readback used for the reported charging status. Independent of charging-control safety deadlines; does not authorize charging or schedule extra hardware reads. Confirmed input loss still reports not charging immediately."
+        },
+        "workReportingEnabled": {
+            "type": "boolean",
+            "title": "Automatic work reporting",
+            "description": "Upload work.completed cycle outcomes and interval accounting on existing connections. Off by default. automaticDiagnosticsPower controls eligible power sources. Cached on-demand observations remain available when off; workflowDebugEnabled independently controls detailed step traces."
         }
     },
     "x-bf": {
         "domain": "settings",
         "version": 1,
-        "settingsSchemaVersion": 27
+        "settingsSchemaVersion": 28
     }
 };
 export const observationDefinitions = [