@dronedeploy/rocos-js-sdk 4.3.1 → 4.4.2

package/cjs/models/ConfigGroupResponse.d.ts

@@ -0,0 +1,20 @@
+/** One stored item in a config group, scoped by whatever the group's `type` represents (e.g. one gamepad, one command). */
+export interface ConfigGroupItem<T> {
+    id: string;
+    value: T;
+    /** Robot-scoped response only: whether this robot's config overrides its robot definition's. */
+    _isOverridden?: boolean;
+    /** Robot-scoped response only: the robot definition's item this one overrides, when it does. */
+    _globalItem?: ConfigGroupItem<T>;
+}
+/** Response shape shared by RobotService/ProfileService config-group endpoints (gamepads, commands-v2, ...). */
+export interface ConfigGroupResponse<T> {
+    version?: string;
+    type: string;
+    items: Array<ConfigGroupItem<T>>;
+    /** Robot-scoped response only. */
+    robotDefinitionId?: string;
+    username?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/cjs/models/ConfigGroupResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/models/command/CommandV2.d.ts

@@ -0,0 +1,28 @@
+import { ConfigGroupItem, ConfigGroupResponse } from '../ConfigGroupResponse';
+/** Declares one named parameter a command accepts. `default` is always a string, whatever `type` names. */
+export interface CommandV2ParameterDeclaration {
+    type: string;
+    default: string;
+}
+export interface CommandV2Settings {
+    target: string;
+    /** Stored as a number on newer configs, a numeric string on older ones. Absent on some legacy configs. */
+    timeoutMs?: number | string;
+    requiresClockSync: boolean;
+    payloadTemplate: string;
+    /** Should be an object, but a known editor round-trip bug can persist it as a raw JSON string. */
+    payloadMeta?: Record<string, unknown> | string | null;
+}
+export interface CommandV2 {
+    schemaVersion: number;
+    id: string;
+    name: string;
+    type: string;
+    /** Absent for commands declaring no parameters, not an empty object. */
+    parameters?: Record<string, CommandV2ParameterDeclaration>;
+    settings: CommandV2Settings;
+}
+/** One stored command, scoped to a specific command id (CommandV2.id). */
+export type CommandV2Item = ConfigGroupItem<CommandV2>;
+/** Response shape of RobotService/ProfileService getCommandsV2 — one item per declared command. */
+export type CommandV2Response = ConfigGroupResponse<CommandV2>;

package/cjs/models/command/CommandV2.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/models/command/index.d.ts

@@ -1,4 +1,5 @@
 export * from '../ResponseLevelEnum';
+export * from './CommandV2';
 export * from './IRocosCommandMessageHeartbeat';
 export * from './IRocosCommandMessageResponse';
 export * from './RocosCommandResultStatus';

package/cjs/models/command/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("../ResponseLevelEnum"), exports);
+__exportStar(require("./CommandV2"), exports);
 __exportStar(require("./IRocosCommandMessageHeartbeat"), exports);
 __exportStar(require("./IRocosCommandMessageResponse"), exports);
 __exportStar(require("./RocosCommandResultStatus"), exports);

package/cjs/models/gamepad/GamepadConfig.d.ts

@@ -0,0 +1,87 @@
+import { ConfigGroupItem, ConfigGroupResponse } from '../ConfigGroupResponse';
+export declare enum GamepadButtonType {
+    UNKNOWN = 0,
+    UP = 1,
+    DOWN = 2,
+    LEFT = 3,
+    RIGHT = 4,
+    LEFT_STICK_X = 5,
+    LEFT_STICK_Y = 6,
+    LEFT_STICK_BUTTON = 7,// Stick pressed
+    RIGHT_STICK_X = 8,
+    RIGHT_STICK_Y = 9,
+    RIGHT_STICK_BUTTON = 10,// Stick pressed
+    LEFT_BUMPER = 11,
+    RIGHT_BUMPER = 12,
+    LEFT_TRIGGER = 13,
+    RIGHT_TRIGGER = 14,
+    A = 15,// Xbox
+    B = 16,// Xbox
+    X = 17,// Xbox
+    Y = 18,// Xbox
+    BACK = 19,// Xbox
+    START = 20,// Xbox
+    GUIDE = 21,// Xbox
+    SHARE = 22,// PS4
+    OPTIONS = 23,// PS4
+    PS = 24,// PS4
+    CIRCLE = 25,// PS4
+    SQUARE = 26,// PS4
+    TRIANGLE = 27
+}
+/** Per-axis tuning keyed by GamepadButtonType. Absent entirely on configs saved before axis tuning existed. */
+export type GamepadAxisValueMap = Partial<Record<GamepadButtonType, number>>;
+export declare enum GamepadTriggerType {
+    ONCE = "once",
+    CONTINUOUSLY = "continuously"
+}
+export declare enum GamepadCommandVersion {
+    COMMANDS = "commands",
+    CONTROLS = "controls",
+    COMMANDS_V2 = "commands-v2",
+    RUN_JS = "run-js"
+}
+export interface GamepadButtonRef {
+    type: GamepadButtonType;
+    text: string;
+}
+export interface GamepadAction {
+    name: string;
+    source: GamepadButtonRef;
+    commandId: string;
+    /** Absent on configs saved before Commands V2 existed. */
+    commandVersion?: GamepadCommandVersion;
+    triggerType: GamepadTriggerType;
+    /** Milliseconds between repeats. Only meaningful for `continuously`. */
+    frequency: number;
+}
+export interface GamepadVariable {
+    name: string;
+    source: GamepadButtonRef;
+    /** Expression evaluated against the button value, with `$value` and `$msg` in scope. */
+    value: string;
+    /** Stored as a string by the console editor, and used when the source button is absent. */
+    defaultValue?: string;
+}
+export interface GamepadHardwareMapping {
+    buttons: GamepadButtonRef[];
+    axes: GamepadButtonRef[];
+}
+/** Identifies the physical controller model this config applies to, matched against the browser's Gamepad.id. */
+export interface GamepadHardware {
+    id: string;
+    type: string;
+    name: string;
+    mapping: GamepadHardwareMapping;
+}
+export interface GamepadConfig {
+    gamepad: GamepadHardware;
+    actions: GamepadAction[];
+    variables: GamepadVariable[];
+    axisDeadzones?: GamepadAxisValueMap;
+    axisExpos?: GamepadAxisValueMap;
+}
+/** One stored gamepad config, scoped to a specific physical controller model (GamepadConfig.gamepad). */
+export type GamepadConfigItem = ConfigGroupItem<GamepadConfig>;
+/** Response shape of RobotService/ProfileService getGamepads — one item per registered controller model. */
+export type GamepadConfigResponse = ConfigGroupResponse<GamepadConfig>;

package/cjs/models/gamepad/GamepadConfig.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GamepadCommandVersion = exports.GamepadTriggerType = exports.GamepadButtonType = void 0;
+// Ref: https://github.com/alaingilbert/GamepadJs
+var GamepadButtonType;
+(function (GamepadButtonType) {
+    GamepadButtonType[GamepadButtonType["UNKNOWN"] = 0] = "UNKNOWN";
+    GamepadButtonType[GamepadButtonType["UP"] = 1] = "UP";
+    GamepadButtonType[GamepadButtonType["DOWN"] = 2] = "DOWN";
+    GamepadButtonType[GamepadButtonType["LEFT"] = 3] = "LEFT";
+    GamepadButtonType[GamepadButtonType["RIGHT"] = 4] = "RIGHT";
+    GamepadButtonType[GamepadButtonType["LEFT_STICK_X"] = 5] = "LEFT_STICK_X";
+    GamepadButtonType[GamepadButtonType["LEFT_STICK_Y"] = 6] = "LEFT_STICK_Y";
+    GamepadButtonType[GamepadButtonType["LEFT_STICK_BUTTON"] = 7] = "LEFT_STICK_BUTTON";
+    GamepadButtonType[GamepadButtonType["RIGHT_STICK_X"] = 8] = "RIGHT_STICK_X";
+    GamepadButtonType[GamepadButtonType["RIGHT_STICK_Y"] = 9] = "RIGHT_STICK_Y";
+    GamepadButtonType[GamepadButtonType["RIGHT_STICK_BUTTON"] = 10] = "RIGHT_STICK_BUTTON";
+    GamepadButtonType[GamepadButtonType["LEFT_BUMPER"] = 11] = "LEFT_BUMPER";
+    GamepadButtonType[GamepadButtonType["RIGHT_BUMPER"] = 12] = "RIGHT_BUMPER";
+    GamepadButtonType[GamepadButtonType["LEFT_TRIGGER"] = 13] = "LEFT_TRIGGER";
+    GamepadButtonType[GamepadButtonType["RIGHT_TRIGGER"] = 14] = "RIGHT_TRIGGER";
+    GamepadButtonType[GamepadButtonType["A"] = 15] = "A";
+    GamepadButtonType[GamepadButtonType["B"] = 16] = "B";
+    GamepadButtonType[GamepadButtonType["X"] = 17] = "X";
+    GamepadButtonType[GamepadButtonType["Y"] = 18] = "Y";
+    GamepadButtonType[GamepadButtonType["BACK"] = 19] = "BACK";
+    GamepadButtonType[GamepadButtonType["START"] = 20] = "START";
+    GamepadButtonType[GamepadButtonType["GUIDE"] = 21] = "GUIDE";
+    GamepadButtonType[GamepadButtonType["SHARE"] = 22] = "SHARE";
+    GamepadButtonType[GamepadButtonType["OPTIONS"] = 23] = "OPTIONS";
+    GamepadButtonType[GamepadButtonType["PS"] = 24] = "PS";
+    GamepadButtonType[GamepadButtonType["CIRCLE"] = 25] = "CIRCLE";
+    GamepadButtonType[GamepadButtonType["SQUARE"] = 26] = "SQUARE";
+    GamepadButtonType[GamepadButtonType["TRIANGLE"] = 27] = "TRIANGLE";
+})(GamepadButtonType || (exports.GamepadButtonType = GamepadButtonType = {}));
+var GamepadTriggerType;
+(function (GamepadTriggerType) {
+    GamepadTriggerType["ONCE"] = "once";
+    GamepadTriggerType["CONTINUOUSLY"] = "continuously";
+})(GamepadTriggerType || (exports.GamepadTriggerType = GamepadTriggerType = {}));
+var GamepadCommandVersion;
+(function (GamepadCommandVersion) {
+    GamepadCommandVersion["COMMANDS"] = "commands";
+    GamepadCommandVersion["CONTROLS"] = "controls";
+    GamepadCommandVersion["COMMANDS_V2"] = "commands-v2";
+    GamepadCommandVersion["RUN_JS"] = "run-js";
+})(GamepadCommandVersion || (exports.GamepadCommandVersion = GamepadCommandVersion = {}));

package/cjs/models/gamepad/index.d.ts

@@ -0,0 +1 @@
+export * from './GamepadConfig';

package/cjs/models/gamepad/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./GamepadConfig"), exports);

package/cjs/models/index.d.ts

@@ -6,11 +6,13 @@ export * from './callsigns/CallsignsLookup';
 export * from './callsigns/CallsignsQuery';
 export * from './callsigns/CallsignsQueryPredicate';
 export * from './command';
+export * from './ConfigGroupResponse';
 export * from './device-credentials/DeviceCredentials';
 export * from './Dashboard';
 export * from './ExportDataQuery';
 export * from './EventDefinition';
 export * from './file/FileEnums';
+export * from './gamepad';
 export * from './graph';
 export * from './HttpError';
 export * from './IBaseService';

package/cjs/models/index.js

@@ -22,11 +22,13 @@ __exportStar(require("./callsigns/CallsignsLookup"), exports);
 __exportStar(require("./callsigns/CallsignsQuery"), exports);
 __exportStar(require("./callsigns/CallsignsQueryPredicate"), exports);
 __exportStar(require("./command"), exports);
+__exportStar(require("./ConfigGroupResponse"), exports);
 __exportStar(require("./device-credentials/DeviceCredentials"), exports);
 __exportStar(require("./Dashboard"), exports);
 __exportStar(require("./ExportDataQuery"), exports);
 __exportStar(require("./EventDefinition"), exports);
 __exportStar(require("./file/FileEnums"), exports);
+__exportStar(require("./gamepad"), exports);
 __exportStar(require("./graph"), exports);
 __exportStar(require("./HttpError"), exports);
 __exportStar(require("./IBaseService"), exports);

package/cjs/services/ProfileService.d.ts

@@ -1,5 +1,7 @@
 import { AgentSettingsRequestItem, AgentSettingsResponse } from '../models/IRobotSettings';
+import { CommandV2Item, CommandV2Response } from '../models/command/CommandV2';
 import { CreateRobotDefinitionRequest, RobotProfile } from '../models/RobotProfile';
+import { GamepadConfigItem, GamepadConfigResponse } from '../models/gamepad/GamepadConfig';
 import { RocosError } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { Dashboard } from '../models/Dashboard';
@@ -167,7 +169,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetCommandsV2
      */
-    getCommandsV2(projectId: string, definitionId: string): Promise<any>;
+    getCommandsV2(projectId: string, definitionId: string): Promise<CommandV2Response>;
     /**
      * Update command V2 for a robot definition
      *
@@ -176,7 +178,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param model - Payload
      * @description - Renamed from robotDefUpdateCommandsV2
      */
-    updateCommandsV2(projectId: string, definitionId: string, model: any): Promise<any>;
+    updateCommandsV2(projectId: string, definitionId: string, model: CommandV2Item[]): Promise<void>;
     /**
      * Get command actions for a robot definition
      *
@@ -226,7 +228,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetGamepads
      */
-    getGamepads(projectId: string, definitionId: string): Promise<any>;
+    getGamepads(projectId: string, definitionId: string): Promise<GamepadConfigResponse>;
     /** Export robot definition into JSON format
      *
      * Can be used to import robot definition into another project
@@ -265,5 +267,5 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param model - \payload
      * @description - Renamed from robotDefUpdateGamepads
      */
-    updateGamepads(projectId: string, definitionId: string, model: any): Promise<any>;
+    updateGamepads(projectId: string, definitionId: string, model: GamepadConfigItem[]): Promise<void>;
 }

package/cjs/services/ProfileService.js

@@ -238,7 +238,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetCommandsV2
      */
-    // TODO: map the response object
     async getCommandsV2(projectId, definitionId) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_COMMAND2_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), `Failed to get command list for ${projectId}, definitionId  ${definitionId}.`);
     }
@@ -250,9 +249,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param model - Payload
      * @description - Renamed from robotDefUpdateCommandsV2
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateCommandsV2(projectId, definitionId, model) {
         return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_COMMAND2_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), model, `Failed to update command list for ${projectId}, definitionId  ${definitionId}.`);
     }
@@ -324,7 +320,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetGamepads
      */
-    // TODO: map the response object
     async getGamepads(projectId, definitionId) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_GAMEPAD_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), `Failed to get gamepads for ${projectId}, definitionId  ${definitionId}.`);
     }
@@ -380,9 +375,6 @@ class ProfileService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param model - \payload
      * @description - Renamed from robotDefUpdateGamepads
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateGamepads(projectId, definitionId, model) {
         return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_DEFINITION_GAMEPAD_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), model, `Failed to update gamepads for ${projectId}, definitionId  ${definitionId}.`);
     }

package/cjs/services/RobotService.d.ts

@@ -1,4 +1,4 @@
-import { AgentSettingsResponse, IBaseService, IConnectedCallsign, IRobot, IRobotListItem, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
+import { AgentSettingsResponse, CommandV2Item, CommandV2Response, GamepadConfigItem, GamepadConfigResponse, IBaseService, IConnectedCallsign, IRobot, IRobotListItem, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 export declare class RobotService extends BaseServiceAbstract implements IBaseService {
     constructor(config: IRocosSDKConfig);
@@ -227,7 +227,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    getCommandsV2(projectId: string, callsign: string): Promise<any>;
+    getCommandsV2(projectId: string, callsign: string): Promise<CommandV2Response>;
     /**
      * Update command V2 for a robot
      *
@@ -235,7 +235,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param callsign - Robot callsign
      * @param model - Payload
      */
-    updateCommandsV2(projectId: string, callsign: string, model: any): Promise<any>;
+    updateCommandsV2(projectId: string, callsign: string, model: CommandV2Item[]): Promise<void>;
     /**
      * Get buttons for a robot
      *
@@ -272,7 +272,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    getGamepads(projectId: string, callsign: string): Promise<any>;
+    getGamepads(projectId: string, callsign: string): Promise<GamepadConfigResponse>;
     /**
      * Update gamepads for a robot
      *
@@ -280,7 +280,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param callsign - Robot callsign
      * @param model - \payload
      */
-    updateGamepads(projectId: string, callsign: string, model: any): Promise<any>;
+    updateGamepads(projectId: string, callsign: string, model: GamepadConfigItem[]): Promise<void>;
     getConnectedCallsigns(projectId: string): Promise<Map<string, IConnectedCallsign>>;
     getConnectedCallsign(projectId: string, callsign: string): Promise<IConnectedCallsign>;
 }

package/cjs/services/RobotService.js

@@ -380,7 +380,6 @@ class RobotService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    // TODO: map the response object
     async getCommandsV2(projectId, callsign) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ROBOT_COMMAND2_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get command list for ${projectId}, callsign  ${callsign}.`);
     }
@@ -391,9 +390,6 @@ class RobotService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param callsign - Robot callsign
      * @param model - Payload
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateCommandsV2(projectId, callsign, model) {
         return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ROBOT_COMMAND2_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update commands for ${projectId}, callsign  ${callsign}.`);
     }
@@ -449,7 +445,6 @@ class RobotService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    // TODO: map the response object
     async getGamepads(projectId, callsign) {
         return this.callGet((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ROBOT_GAMEPAD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get gamepads for ${projectId}, callsign  ${callsign}.`);
     }
@@ -460,9 +455,6 @@ class RobotService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param callsign - Robot callsign
      * @param model - \payload
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateGamepads(projectId, callsign, model) {
         return this.callPost((0, formatServiceUrl_1.formatServiceUrl)(api_1.API_PROJECT_ROBOT_GAMEPAD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update gamepads for ${projectId}, callsign  ${callsign}.`);
     }

package/esm/models/ConfigGroupResponse.d.ts

@@ -0,0 +1,20 @@
+/** One stored item in a config group, scoped by whatever the group's `type` represents (e.g. one gamepad, one command). */
+export interface ConfigGroupItem<T> {
+    id: string;
+    value: T;
+    /** Robot-scoped response only: whether this robot's config overrides its robot definition's. */
+    _isOverridden?: boolean;
+    /** Robot-scoped response only: the robot definition's item this one overrides, when it does. */
+    _globalItem?: ConfigGroupItem<T>;
+}
+/** Response shape shared by RobotService/ProfileService config-group endpoints (gamepads, commands-v2, ...). */
+export interface ConfigGroupResponse<T> {
+    version?: string;
+    type: string;
+    items: Array<ConfigGroupItem<T>>;
+    /** Robot-scoped response only. */
+    robotDefinitionId?: string;
+    username?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/esm/models/ConfigGroupResponse.js

@@ -0,0 +1 @@
+export {};

package/esm/models/command/CommandV2.d.ts

@@ -0,0 +1,28 @@
+import { ConfigGroupItem, ConfigGroupResponse } from '../ConfigGroupResponse';
+/** Declares one named parameter a command accepts. `default` is always a string, whatever `type` names. */
+export interface CommandV2ParameterDeclaration {
+    type: string;
+    default: string;
+}
+export interface CommandV2Settings {
+    target: string;
+    /** Stored as a number on newer configs, a numeric string on older ones. Absent on some legacy configs. */
+    timeoutMs?: number | string;
+    requiresClockSync: boolean;
+    payloadTemplate: string;
+    /** Should be an object, but a known editor round-trip bug can persist it as a raw JSON string. */
+    payloadMeta?: Record<string, unknown> | string | null;
+}
+export interface CommandV2 {
+    schemaVersion: number;
+    id: string;
+    name: string;
+    type: string;
+    /** Absent for commands declaring no parameters, not an empty object. */
+    parameters?: Record<string, CommandV2ParameterDeclaration>;
+    settings: CommandV2Settings;
+}
+/** One stored command, scoped to a specific command id (CommandV2.id). */
+export type CommandV2Item = ConfigGroupItem<CommandV2>;
+/** Response shape of RobotService/ProfileService getCommandsV2 — one item per declared command. */
+export type CommandV2Response = ConfigGroupResponse<CommandV2>;

package/esm/models/command/CommandV2.js

@@ -0,0 +1 @@
+export {};

package/esm/models/command/index.d.ts

@@ -1,4 +1,5 @@
 export * from '../ResponseLevelEnum';
+export * from './CommandV2';
 export * from './IRocosCommandMessageHeartbeat';
 export * from './IRocosCommandMessageResponse';
 export * from './RocosCommandResultStatus';

package/esm/models/command/index.js

@@ -1,4 +1,5 @@
 export * from '../ResponseLevelEnum';
+export * from './CommandV2';
 export * from './IRocosCommandMessageHeartbeat';
 export * from './IRocosCommandMessageResponse';
 export * from './RocosCommandResultStatus';

package/esm/models/gamepad/GamepadConfig.d.ts

@@ -0,0 +1,87 @@
+import { ConfigGroupItem, ConfigGroupResponse } from '../ConfigGroupResponse';
+export declare enum GamepadButtonType {
+    UNKNOWN = 0,
+    UP = 1,
+    DOWN = 2,
+    LEFT = 3,
+    RIGHT = 4,
+    LEFT_STICK_X = 5,
+    LEFT_STICK_Y = 6,
+    LEFT_STICK_BUTTON = 7,// Stick pressed
+    RIGHT_STICK_X = 8,
+    RIGHT_STICK_Y = 9,
+    RIGHT_STICK_BUTTON = 10,// Stick pressed
+    LEFT_BUMPER = 11,
+    RIGHT_BUMPER = 12,
+    LEFT_TRIGGER = 13,
+    RIGHT_TRIGGER = 14,
+    A = 15,// Xbox
+    B = 16,// Xbox
+    X = 17,// Xbox
+    Y = 18,// Xbox
+    BACK = 19,// Xbox
+    START = 20,// Xbox
+    GUIDE = 21,// Xbox
+    SHARE = 22,// PS4
+    OPTIONS = 23,// PS4
+    PS = 24,// PS4
+    CIRCLE = 25,// PS4
+    SQUARE = 26,// PS4
+    TRIANGLE = 27
+}
+/** Per-axis tuning keyed by GamepadButtonType. Absent entirely on configs saved before axis tuning existed. */
+export type GamepadAxisValueMap = Partial<Record<GamepadButtonType, number>>;
+export declare enum GamepadTriggerType {
+    ONCE = "once",
+    CONTINUOUSLY = "continuously"
+}
+export declare enum GamepadCommandVersion {
+    COMMANDS = "commands",
+    CONTROLS = "controls",
+    COMMANDS_V2 = "commands-v2",
+    RUN_JS = "run-js"
+}
+export interface GamepadButtonRef {
+    type: GamepadButtonType;
+    text: string;
+}
+export interface GamepadAction {
+    name: string;
+    source: GamepadButtonRef;
+    commandId: string;
+    /** Absent on configs saved before Commands V2 existed. */
+    commandVersion?: GamepadCommandVersion;
+    triggerType: GamepadTriggerType;
+    /** Milliseconds between repeats. Only meaningful for `continuously`. */
+    frequency: number;
+}
+export interface GamepadVariable {
+    name: string;
+    source: GamepadButtonRef;
+    /** Expression evaluated against the button value, with `$value` and `$msg` in scope. */
+    value: string;
+    /** Stored as a string by the console editor, and used when the source button is absent. */
+    defaultValue?: string;
+}
+export interface GamepadHardwareMapping {
+    buttons: GamepadButtonRef[];
+    axes: GamepadButtonRef[];
+}
+/** Identifies the physical controller model this config applies to, matched against the browser's Gamepad.id. */
+export interface GamepadHardware {
+    id: string;
+    type: string;
+    name: string;
+    mapping: GamepadHardwareMapping;
+}
+export interface GamepadConfig {
+    gamepad: GamepadHardware;
+    actions: GamepadAction[];
+    variables: GamepadVariable[];
+    axisDeadzones?: GamepadAxisValueMap;
+    axisExpos?: GamepadAxisValueMap;
+}
+/** One stored gamepad config, scoped to a specific physical controller model (GamepadConfig.gamepad). */
+export type GamepadConfigItem = ConfigGroupItem<GamepadConfig>;
+/** Response shape of RobotService/ProfileService getGamepads — one item per registered controller model. */
+export type GamepadConfigResponse = ConfigGroupResponse<GamepadConfig>;

package/esm/models/gamepad/GamepadConfig.js

@@ -0,0 +1,44 @@
+// Ref: https://github.com/alaingilbert/GamepadJs
+export var GamepadButtonType;
+(function (GamepadButtonType) {
+    GamepadButtonType[GamepadButtonType["UNKNOWN"] = 0] = "UNKNOWN";
+    GamepadButtonType[GamepadButtonType["UP"] = 1] = "UP";
+    GamepadButtonType[GamepadButtonType["DOWN"] = 2] = "DOWN";
+    GamepadButtonType[GamepadButtonType["LEFT"] = 3] = "LEFT";
+    GamepadButtonType[GamepadButtonType["RIGHT"] = 4] = "RIGHT";
+    GamepadButtonType[GamepadButtonType["LEFT_STICK_X"] = 5] = "LEFT_STICK_X";
+    GamepadButtonType[GamepadButtonType["LEFT_STICK_Y"] = 6] = "LEFT_STICK_Y";
+    GamepadButtonType[GamepadButtonType["LEFT_STICK_BUTTON"] = 7] = "LEFT_STICK_BUTTON";
+    GamepadButtonType[GamepadButtonType["RIGHT_STICK_X"] = 8] = "RIGHT_STICK_X";
+    GamepadButtonType[GamepadButtonType["RIGHT_STICK_Y"] = 9] = "RIGHT_STICK_Y";
+    GamepadButtonType[GamepadButtonType["RIGHT_STICK_BUTTON"] = 10] = "RIGHT_STICK_BUTTON";
+    GamepadButtonType[GamepadButtonType["LEFT_BUMPER"] = 11] = "LEFT_BUMPER";
+    GamepadButtonType[GamepadButtonType["RIGHT_BUMPER"] = 12] = "RIGHT_BUMPER";
+    GamepadButtonType[GamepadButtonType["LEFT_TRIGGER"] = 13] = "LEFT_TRIGGER";
+    GamepadButtonType[GamepadButtonType["RIGHT_TRIGGER"] = 14] = "RIGHT_TRIGGER";
+    GamepadButtonType[GamepadButtonType["A"] = 15] = "A";
+    GamepadButtonType[GamepadButtonType["B"] = 16] = "B";
+    GamepadButtonType[GamepadButtonType["X"] = 17] = "X";
+    GamepadButtonType[GamepadButtonType["Y"] = 18] = "Y";
+    GamepadButtonType[GamepadButtonType["BACK"] = 19] = "BACK";
+    GamepadButtonType[GamepadButtonType["START"] = 20] = "START";
+    GamepadButtonType[GamepadButtonType["GUIDE"] = 21] = "GUIDE";
+    GamepadButtonType[GamepadButtonType["SHARE"] = 22] = "SHARE";
+    GamepadButtonType[GamepadButtonType["OPTIONS"] = 23] = "OPTIONS";
+    GamepadButtonType[GamepadButtonType["PS"] = 24] = "PS";
+    GamepadButtonType[GamepadButtonType["CIRCLE"] = 25] = "CIRCLE";
+    GamepadButtonType[GamepadButtonType["SQUARE"] = 26] = "SQUARE";
+    GamepadButtonType[GamepadButtonType["TRIANGLE"] = 27] = "TRIANGLE";
+})(GamepadButtonType || (GamepadButtonType = {}));
+export var GamepadTriggerType;
+(function (GamepadTriggerType) {
+    GamepadTriggerType["ONCE"] = "once";
+    GamepadTriggerType["CONTINUOUSLY"] = "continuously";
+})(GamepadTriggerType || (GamepadTriggerType = {}));
+export var GamepadCommandVersion;
+(function (GamepadCommandVersion) {
+    GamepadCommandVersion["COMMANDS"] = "commands";
+    GamepadCommandVersion["CONTROLS"] = "controls";
+    GamepadCommandVersion["COMMANDS_V2"] = "commands-v2";
+    GamepadCommandVersion["RUN_JS"] = "run-js";
+})(GamepadCommandVersion || (GamepadCommandVersion = {}));

package/esm/models/gamepad/index.d.ts

@@ -0,0 +1 @@
+export * from './GamepadConfig';

package/esm/models/gamepad/index.js

@@ -0,0 +1 @@
+export * from './GamepadConfig';

package/esm/models/index.d.ts

@@ -6,11 +6,13 @@ export * from './callsigns/CallsignsLookup';
 export * from './callsigns/CallsignsQuery';
 export * from './callsigns/CallsignsQueryPredicate';
 export * from './command';
+export * from './ConfigGroupResponse';
 export * from './device-credentials/DeviceCredentials';
 export * from './Dashboard';
 export * from './ExportDataQuery';
 export * from './EventDefinition';
 export * from './file/FileEnums';
+export * from './gamepad';
 export * from './graph';
 export * from './HttpError';
 export * from './IBaseService';

package/esm/models/index.js

@@ -6,11 +6,13 @@ export * from './callsigns/CallsignsLookup';
 export * from './callsigns/CallsignsQuery';
 export * from './callsigns/CallsignsQueryPredicate';
 export * from './command';
+export * from './ConfigGroupResponse';
 export * from './device-credentials/DeviceCredentials';
 export * from './Dashboard';
 export * from './ExportDataQuery';
 export * from './EventDefinition';
 export * from './file/FileEnums';
+export * from './gamepad';
 export * from './graph';
 export * from './HttpError';
 export * from './IBaseService';

package/esm/services/ProfileService.d.ts

@@ -1,5 +1,7 @@
 import { AgentSettingsRequestItem, AgentSettingsResponse } from '../models/IRobotSettings';
+import { CommandV2Item, CommandV2Response } from '../models/command/CommandV2';
 import { CreateRobotDefinitionRequest, RobotProfile } from '../models/RobotProfile';
+import { GamepadConfigItem, GamepadConfigResponse } from '../models/gamepad/GamepadConfig';
 import { RocosError } from '../models/RocosError';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { Dashboard } from '../models/Dashboard';
@@ -167,7 +169,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetCommandsV2
      */
-    getCommandsV2(projectId: string, definitionId: string): Promise<any>;
+    getCommandsV2(projectId: string, definitionId: string): Promise<CommandV2Response>;
     /**
      * Update command V2 for a robot definition
      *
@@ -176,7 +178,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param model - Payload
      * @description - Renamed from robotDefUpdateCommandsV2
      */
-    updateCommandsV2(projectId: string, definitionId: string, model: any): Promise<any>;
+    updateCommandsV2(projectId: string, definitionId: string, model: CommandV2Item[]): Promise<void>;
     /**
      * Get command actions for a robot definition
      *
@@ -226,7 +228,7 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetGamepads
      */
-    getGamepads(projectId: string, definitionId: string): Promise<any>;
+    getGamepads(projectId: string, definitionId: string): Promise<GamepadConfigResponse>;
     /** Export robot definition into JSON format
      *
      * Can be used to import robot definition into another project
@@ -265,5 +267,5 @@ export declare class ProfileService extends BaseServiceAbstract implements IBase
      * @param model - \payload
      * @description - Renamed from robotDefUpdateGamepads
      */
-    updateGamepads(projectId: string, definitionId: string, model: any): Promise<any>;
+    updateGamepads(projectId: string, definitionId: string, model: GamepadConfigItem[]): Promise<void>;
 }

package/esm/services/ProfileService.js

@@ -235,7 +235,6 @@ export class ProfileService extends BaseServiceAbstract {
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetCommandsV2
      */
-    // TODO: map the response object
     async getCommandsV2(projectId, definitionId) {
         return this.callGet(formatServiceUrl(API_PROJECT_DEFINITION_COMMAND2_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), `Failed to get command list for ${projectId}, definitionId  ${definitionId}.`);
     }
@@ -247,9 +246,6 @@ export class ProfileService extends BaseServiceAbstract {
      * @param model - Payload
      * @description - Renamed from robotDefUpdateCommandsV2
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateCommandsV2(projectId, definitionId, model) {
         return this.callPost(formatServiceUrl(API_PROJECT_DEFINITION_COMMAND2_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), model, `Failed to update command list for ${projectId}, definitionId  ${definitionId}.`);
     }
@@ -321,7 +317,6 @@ export class ProfileService extends BaseServiceAbstract {
      * @param definitionId - Robot definition Id
      * @description - Renamed from robotDefGetGamepads
      */
-    // TODO: map the response object
     async getGamepads(projectId, definitionId) {
         return this.callGet(formatServiceUrl(API_PROJECT_DEFINITION_GAMEPAD_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), `Failed to get gamepads for ${projectId}, definitionId  ${definitionId}.`);
     }
@@ -377,9 +372,6 @@ export class ProfileService extends BaseServiceAbstract {
      * @param model - \payload
      * @description - Renamed from robotDefUpdateGamepads
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateGamepads(projectId, definitionId, model) {
         return this.callPost(formatServiceUrl(API_PROJECT_DEFINITION_GAMEPAD_URL, { url: this.config.url, projectId, definitionId }, this.config.insecure), model, `Failed to update gamepads for ${projectId}, definitionId  ${definitionId}.`);
     }

package/esm/services/RobotService.d.ts

@@ -1,4 +1,4 @@
-import { AgentSettingsResponse, IBaseService, IConnectedCallsign, IRobot, IRobotListItem, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
+import { AgentSettingsResponse, CommandV2Item, CommandV2Response, GamepadConfigItem, GamepadConfigResponse, IBaseService, IConnectedCallsign, IRobot, IRobotListItem, IRobotSettings, IRobotTemplate, IRocosSDKConfig, RocosError } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 export declare class RobotService extends BaseServiceAbstract implements IBaseService {
     constructor(config: IRocosSDKConfig);
@@ -227,7 +227,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    getCommandsV2(projectId: string, callsign: string): Promise<any>;
+    getCommandsV2(projectId: string, callsign: string): Promise<CommandV2Response>;
     /**
      * Update command V2 for a robot
      *
@@ -235,7 +235,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param callsign - Robot callsign
      * @param model - Payload
      */
-    updateCommandsV2(projectId: string, callsign: string, model: any): Promise<any>;
+    updateCommandsV2(projectId: string, callsign: string, model: CommandV2Item[]): Promise<void>;
     /**
      * Get buttons for a robot
      *
@@ -272,7 +272,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    getGamepads(projectId: string, callsign: string): Promise<any>;
+    getGamepads(projectId: string, callsign: string): Promise<GamepadConfigResponse>;
     /**
      * Update gamepads for a robot
      *
@@ -280,7 +280,7 @@ export declare class RobotService extends BaseServiceAbstract implements IBaseSe
      * @param callsign - Robot callsign
      * @param model - \payload
      */
-    updateGamepads(projectId: string, callsign: string, model: any): Promise<any>;
+    updateGamepads(projectId: string, callsign: string, model: GamepadConfigItem[]): Promise<void>;
     getConnectedCallsigns(projectId: string): Promise<Map<string, IConnectedCallsign>>;
     getConnectedCallsign(projectId: string, callsign: string): Promise<IConnectedCallsign>;
 }

package/esm/services/RobotService.js

@@ -377,7 +377,6 @@ export class RobotService extends BaseServiceAbstract {
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    // TODO: map the response object
     async getCommandsV2(projectId, callsign) {
         return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_COMMAND2_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get command list for ${projectId}, callsign  ${callsign}.`);
     }
@@ -388,9 +387,6 @@ export class RobotService extends BaseServiceAbstract {
      * @param callsign - Robot callsign
      * @param model - Payload
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateCommandsV2(projectId, callsign, model) {
         return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_COMMAND2_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update commands for ${projectId}, callsign  ${callsign}.`);
     }
@@ -446,7 +442,6 @@ export class RobotService extends BaseServiceAbstract {
      * @param projectId - Project Id
      * @param callsign - Robot callsign
      */
-    // TODO: map the response object
     async getGamepads(projectId, callsign) {
         return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_GAMEPAD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get gamepads for ${projectId}, callsign  ${callsign}.`);
     }
@@ -457,9 +452,6 @@ export class RobotService extends BaseServiceAbstract {
      * @param callsign - Robot callsign
      * @param model - \payload
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     async updateGamepads(projectId, callsign, model) {
         return this.callPost(formatServiceUrl(API_PROJECT_ROBOT_GAMEPAD_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update gamepads for ${projectId}, callsign  ${callsign}.`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "4.3.1",
+  "version": "4.4.2",
   "description": "Javascript SDK for rocos",
   "main": "cjs/index.js",
   "module": "esm/index.js",