@omirion/orbit-sdk 0.4.0 → 0.5.0

package/README.md

@@ -38,7 +38,8 @@ import { InsufficientScopeError, DeviceRpcError } from '@omirion/orbit-sdk'
 try {
   // Commands are declared per device type, a name plus typed key/value args, no shell.
   // `orbit.commands.manifest(deviceId)` lists what this device accepts.
-  const result = await orbit.commands.exec(deviceId, { name: 'state-request', timeoutMs: 10_000 })
+  const requestId = crypto.randomUUID() // Save before sending; reuse for retries of this command.
+  const result = await orbit.commands.exec(deviceId, { name: 'state-request', requestId, timeoutMs: 10_000 })
   if (result.queued) {
     // Store-and-forward device: poll orbit.commands.get(deviceId, result.invocationId)
   }
@@ -49,6 +50,8 @@ try {
 }
 ```
 
+Command submissions require a caller-generated `requestId` UUID. Persist it before sending when recovery must survive a restart. Reuse it with the same device, issuing user and command body for retries; generate a new ID for a new intended action. HTTP retries within one SDK call preserve the body. `commands.getByRequestId(deviceId, requestId)` recovers an accepted command without resubmitting it.
+
 ### Surface
 
 Every collection has a cursor-paginated `list(params?)` and a lazy `iterate(params?)` async-generator twin that walks all pages.

package/dist/index.cjs

@@ -976,6 +976,11 @@ var getDeviceCommandInvocation = (options) => (options.client ?? client).get({
   url: "/api/v1/devices/{id}/commands/{invocationId}",
   ...options
 });
+var getDeviceCommandByRequestId = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/api/v1/devices/{id}/commands/by-request/{requestId}",
+  ...options
+});
 var getDeviceCommands = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/api/v1/devices/{id}/commands",
@@ -1578,6 +1583,9 @@ var OrbitClient = class {
           throwOnError: false
         })
       ).then((result) => result.data),
+      getByRequestId: (deviceId, requestId) => run(
+        () => getDeviceCommandByRequestId({ client: client2, path: { id: deviceId, requestId }, throwOnError: false })
+      ).then((result) => result.data),
       manifest: (deviceId) => run(
         () => getDeviceCommands({
           client: client2,
@@ -1788,6 +1796,7 @@ __export(generated_exports, {
   getAdmission: () => getAdmission,
   getCommandManifest: () => getCommandManifest,
   getDevice: () => getDevice,
+  getDeviceCommandByRequestId: () => getDeviceCommandByRequestId,
   getDeviceCommandInvocation: () => getDeviceCommandInvocation,
   getDeviceCommands: () => getDeviceCommands,
   getDeviceType: () => getDeviceType,