@fleetless/sdk 3.1.0 → 3.1.1

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to `@fleetless/sdk`. The format follows Keep a Changelog; th
 
 ## [Unreleased]
 
+## [3.1.1] — 2026-09-17
+
+### Fixed
+
+- Every field of `JobHistoryOptions` carries its description, and `McpExposure` and `McpCapabilities` are documented aliases rather than bare re-exports, so the generated reference describes them. No behaviour changes.
+
 ## [3.1.0] — 2026-09-17
 
 ### Added

package/dist/index.d.cts

@@ -26,13 +26,13 @@ declare const mcpExposure: z.ZodObject<{
     decimals: z.ZodNullable<z.ZodNumber>;
     input_schema: z.ZodNullable<z.ZodUnknown>;
 }, z.core.$strip>;
-type McpExposure = z.infer<typeof mcpExposure>;
+type McpExposure$1 = z.infer<typeof mcpExposure>;
 /** The two role capabilities a robot tool can need beyond a slug grant. `presence` is a stream and has no tool. */
 declare const mcpCapabilities: z.ZodObject<{
     action_history: z.ZodBoolean;
     assets: z.ZodBoolean;
 }, z.core.$strip>;
-type McpCapabilities = z.infer<typeof mcpCapabilities>;
+type McpCapabilities$1 = z.infer<typeof mcpCapabilities>;
 /**
  * What one caller may do on one robot — the answer to `robot_describe`, and
  * since 1.1.0 to `GET /api/robots/:id/datasheet` as well. One schema for both
@@ -2049,13 +2049,19 @@ interface DatapointsApi {
  * `validation_error`, not quietly reduced.
  */
 interface JobHistoryOptions {
+    /** Only runs of this action or service. */
     slug?: string;
+    /** Only runs in this state: `running`, `succeeded`, `failed`, `cancelled` or `lost`. */
     state?: JobState;
+    /** Only `action` runs, or only `service` runs. */
     kind?: 'action' | 'service';
+    /** How many runs to return, 1 to 200; absent means 100. Above the cap the platform refuses with `validation_error` rather than trimming. */
     limit?: number;
     /** The previous page's `next_cursor`. Send it back rather than computing one. */
     beforeSeq?: number;
+    /** Only runs that started at or after this unix timestamp in milliseconds; with `toMs` the window is half-open, `[from, to)`. */
     fromMs?: number;
+    /** Only runs that started before this unix timestamp in milliseconds. */
     toMs?: number;
 }
 /**
@@ -2139,6 +2145,20 @@ interface PublishersApi {
     publish(robotId: string, slug: string, message: Record<string, unknown>, options?: SendCommandOptions): Promise<void>;
 }
 
+/**
+ * One row of a datasheet's `exposures`: a granted datapoint, action, service,
+ * publisher or camera, with its `slug`, `kind`, `description` (or `null`),
+ * a datapoint's `unit` and `decimals`, and for anything that takes
+ * parameters the JSON Schema under `input_schema`. The wire shape is
+ * contracts' `mcpExposure`; the alias exists so the reference can describe it.
+ */
+type McpExposure = McpExposure$1;
+/**
+ * The two role capabilities a datasheet names beyond slugs: `action_history`
+ * (may `jobs.history` be read) and `assets` (may the URDF and meshes be read).
+ * The wire shape is contracts' `mcpCapabilities`.
+ */
+type McpCapabilities = McpCapabilities$1;
 /**
  * Discovery, reachable as `client.robots`: which robots may I name at all,
  * and what may I do on one. The two calls every app screen starts from;

package/dist/index.d.ts

@@ -26,13 +26,13 @@ declare const mcpExposure: z.ZodObject<{
     decimals: z.ZodNullable<z.ZodNumber>;
     input_schema: z.ZodNullable<z.ZodUnknown>;
 }, z.core.$strip>;
-type McpExposure = z.infer<typeof mcpExposure>;
+type McpExposure$1 = z.infer<typeof mcpExposure>;
 /** The two role capabilities a robot tool can need beyond a slug grant. `presence` is a stream and has no tool. */
 declare const mcpCapabilities: z.ZodObject<{
     action_history: z.ZodBoolean;
     assets: z.ZodBoolean;
 }, z.core.$strip>;
-type McpCapabilities = z.infer<typeof mcpCapabilities>;
+type McpCapabilities$1 = z.infer<typeof mcpCapabilities>;
 /**
  * What one caller may do on one robot — the answer to `robot_describe`, and
  * since 1.1.0 to `GET /api/robots/:id/datasheet` as well. One schema for both
@@ -2049,13 +2049,19 @@ interface DatapointsApi {
  * `validation_error`, not quietly reduced.
  */
 interface JobHistoryOptions {
+    /** Only runs of this action or service. */
     slug?: string;
+    /** Only runs in this state: `running`, `succeeded`, `failed`, `cancelled` or `lost`. */
     state?: JobState;
+    /** Only `action` runs, or only `service` runs. */
     kind?: 'action' | 'service';
+    /** How many runs to return, 1 to 200; absent means 100. Above the cap the platform refuses with `validation_error` rather than trimming. */
     limit?: number;
     /** The previous page's `next_cursor`. Send it back rather than computing one. */
     beforeSeq?: number;
+    /** Only runs that started at or after this unix timestamp in milliseconds; with `toMs` the window is half-open, `[from, to)`. */
     fromMs?: number;
+    /** Only runs that started before this unix timestamp in milliseconds. */
     toMs?: number;
 }
 /**
@@ -2139,6 +2145,20 @@ interface PublishersApi {
     publish(robotId: string, slug: string, message: Record<string, unknown>, options?: SendCommandOptions): Promise<void>;
 }
 
+/**
+ * One row of a datasheet's `exposures`: a granted datapoint, action, service,
+ * publisher or camera, with its `slug`, `kind`, `description` (or `null`),
+ * a datapoint's `unit` and `decimals`, and for anything that takes
+ * parameters the JSON Schema under `input_schema`. The wire shape is
+ * contracts' `mcpExposure`; the alias exists so the reference can describe it.
+ */
+type McpExposure = McpExposure$1;
+/**
+ * The two role capabilities a datasheet names beyond slugs: `action_history`
+ * (may `jobs.history` be read) and `assets` (may the URDF and meshes be read).
+ * The wire shape is contracts' `mcpCapabilities`.
+ */
+type McpCapabilities = McpCapabilities$1;
 /**
  * Discovery, reachable as `client.robots`: which robots may I name at all,
  * and what may I do on one. The two calls every app screen starts from;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fleetless/sdk",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "The official TypeScript SDK for Fleetless client apps — a ROS 2 robot as a REST and realtime API, cameras, jobs, and the app's own user accounts, federated sign-in and MCP consent.",
   "license": "MIT",
   "author": {