add CommandTemplate type (#217)

Author: AaronGBoswell

packages/data-sdk/src/devices/Device.ts

@@ -32,8 +32,8 @@ import { TelemetryResult } from "../model/TelemetryResult";
 import { isRtcPeer } from "../utils/isRtcPeer";
 import { BaseDevice } from "./BaseDevice";
 import {
-  Command,
   ConfigurationDocument,
+  ICommandTemplate,
   IStartRealtimeConnectionOptions,
   TelemetryStream,
 } from "./device.types";
@@ -362,7 +362,9 @@ export class Device extends BaseDevice {
     return false;
   }
 
-  async getAvailableCommands(includeDisabled = true): Promise<Command[]> {
+  async getAvailableCommands(
+    includeDisabled = true
+  ): Promise<ICommandTemplate[]> {
     const result = await fetch(
       `${FORMANT_API_URL}/v1/admin/command-templates/`,
       {
@@ -374,24 +376,12 @@ export class Device extends BaseDevice {
       }
     );
     const commands = await result.json();
-    return commands.items
-      .map((i: any) => ({
-        name: i.name,
-        id: i.id,
-        command: i.command,
-        description: i.description,
-        parameterEnabled: i.parameterEnabled,
-        parameterValue: i.parameterValue,
-        parameterMeta: i.parameterMeta,
-        enabled: i.enabled,
-        tags: i.tags,
-      }))
-      .filter((i: any) => {
-        if (includeDisabled) {
-          return true;
-        }
-        return i.enabled;
-      });
+    return commands.items.filter((i: ICommandTemplate) => {
+      if (includeDisabled) {
+        return true;
+      }
+      return i.enabled;
+    });
   }
 
   async sendCommand(

packages/data-sdk/src/devices/device.types.ts

@@ -1,7 +1,11 @@
 import { IRtcStreamPayload, RtcStreamType } from "@formant/realtime-sdk";
+import { IDictionary } from "../model/IDictionary";
+import { IFilter } from "../model/IFilter";
+import { IScopeFilter } from "../model/IScopeFilter";
+import { ITaggedEntity } from "../model/ITaggedEntity";
 import { ITags } from "../model/ITags";
-import { Uuid } from "../model/Uuid";
 import { SessionType } from "../model/SessionType";
+import { Uuid } from "../model/Uuid";
 
 export interface ConfigurationDocument {
   tags: ITags;
@@ -27,6 +31,36 @@ export interface ConfigurationDocument {
   adapters?: IAdapterConfiguration[];
   application?: { configurationMap: { [key: string]: string } };
 }
+export interface ICommandDeliverySettings {
+  // command is dropped after it expires (defaults to defaultCommandTtlMs)
+  ttlMs?: number;
+  // `false` (default) for fire-and-forget (at most once delivery)
+  // `true` for at least once delivery
+  retryable?: boolean;
+
+  // TODO?
+  // maxRetries?: number;
+  // retryDelayMs?: number;
+  // parallelExecution?: boolean;
+  // maxPendingCommands?: number;
+}
+
+export interface ICommandTemplate extends ITaggedEntity {
+  organizationId?: Uuid;
+  name: string;
+  command: string;
+  description?: string;
+  parameterEnabled: boolean;
+  allowParameterOverride?: boolean;
+  parameterValue?: string | null;
+  parameterMeta?: IDictionary;
+  deviceScope?: IScopeFilter;
+  enabled?: boolean;
+  deviceFilter: IFilter | null;
+  lambdaUri?: string | null;
+  deliverySettings?: ICommandDeliverySettings;
+  schema?: string | null;
+}
 
 export interface Command {
   id: string;

packages/data-sdk/src/main.ts

@@ -31,6 +31,7 @@ export type {
   Command,
   ConfigurationDocument,
   IAdapterConfiguration,
+  ICommandTemplate,
   IJointState,
   IStartRealtimeConnectionOptions,
   RealtimeAudioStream,