@viamrobotics/test-widgets 0.6.1 → 0.8.0

package/dist/resource-triplet.js

@@ -0,0 +1,37 @@
+/** The canonical set of Viam resource API triplets. */
+export const ResourceTriplets = {
+    // components
+    Arm: 'rdk:component:arm',
+    AudioInput: 'rdk:component:audio_in',
+    AudioOutput: 'rdk:component:audio_out',
+    Base: 'rdk:component:base',
+    Board: 'rdk:component:board',
+    Button: 'rdk:component:button',
+    Camera: 'rdk:component:camera',
+    Encoder: 'rdk:component:encoder',
+    Gantry: 'rdk:component:gantry',
+    GenericComponent: 'rdk:component:generic',
+    Gripper: 'rdk:component:gripper',
+    InputController: 'rdk:component:input_controller',
+    Motor: 'rdk:component:motor',
+    MovementSensor: 'rdk:component:movement_sensor',
+    PoseTracker: 'rdk:component:pose_tracker',
+    PowerSensor: 'rdk:component:power_sensor',
+    Sensor: 'rdk:component:sensor',
+    Servo: 'rdk:component:servo',
+    Switch: 'rdk:component:switch',
+    // services
+    BaseRemoteControl: 'rdk:service:base_remote_control',
+    DataManager: 'rdk:service:data_manager',
+    Discovery: 'rdk:service:discovery',
+    GenericService: 'rdk:service:generic',
+    MLModel: 'rdk:service:mlmodel',
+    Motion: 'rdk:service:motion',
+    Navigation: 'rdk:service:navigation',
+    Slam: 'rdk:service:slam',
+    Sensors: 'rdk:service:sensors',
+    Shell: 'rdk:service:shell',
+    Video: 'rdk:service:video',
+    Vision: 'rdk:service:vision',
+    WorldStateStore: 'rdk:service:world_state_store',
+};

package/dist/resource-widget.js

@@ -0,0 +1,187 @@
+import { ArmGetJointPositionsWidget, ArmIsMovingWidget, ArmMoveToJointPositionsWidget, ArmMoveToPositionWidget, ArmQuickMoveWidget, ArmWidget, AudioInputGetPropertiesWidget, AudioInputWidget, AudioOutputGetPropertiesWidget, AudioOutputWidget, BaseIsMovingWidget, BaseMoveStraightWidget, BaseQuickMoveWidget, BaseSetPowerWidget, BaseSetVelocityWidget, BaseSpinWidget, BaseWidget, BoardWidget, ButtonWidget, CameraWidget, DiscoveryWidget, EncoderGetPositionWidget, EncoderWidget, GantryGetPositionWidget, GantryHomeWidget, GantryIsMovingWidget, GantryMoveToPositionWidget, GantryQuickMoveWidget, GantryWidget, GripperGrabWidget, GripperIsHoldingSomethingWidget, GripperIsMovingWidget, GripperOpenWidget, GripperWidget, InputControllerWidget, MLModelServiceWidget, MotorGoForWidget, MotorGoToWidget, MotorIsMovingWidget, MotorQuickMoveWidget, MotorSetPowerWidget, MotorSetRPMWidget, MotorWidget, MovementSensorGetAccuracyWidget, MovementSensorGetCompassHeadingWidget, MovementSensorGetOrientationWidget, MovementSensorGetPositionWidget, MovementSensorWidget, NavigationServiceWidget, PowerSensorGetCurrentWidget, PowerSensorGetPowerWidget, PowerSensorGetVoltageWidget, PowerSensorWidget, SensorWidget, ServoIsMovingWidget, ServoMoveWidget, ServoQuickMoveWidget, ServoWidget, SlamGetPositionWidget, SlamWidget, SwitchWidget, VisionServiceWidget, } from "./components/index.js";
+import { getResourceAPI } from "./get-resource-api.js";
+import { ResourceTriplets } from "./resource-triplet.js";
+const resourceWidgetRegistry = {
+    // components
+    [ResourceTriplets.Arm]: {
+        widget: ArmWidget,
+        apis: [
+            {
+                id: 'move-to-joint-positions',
+                label: 'MoveToJointPositions',
+                widgets: [ArmMoveToJointPositionsWidget],
+            },
+            { id: 'move-to-position', label: 'MoveToPosition', widgets: [ArmMoveToPositionWidget] },
+            { id: 'quick-move', label: 'Quick move', widgets: [ArmQuickMoveWidget] },
+            {
+                id: 'get-joint-positions',
+                label: 'GetJointPositions',
+                widgets: [ArmGetJointPositionsWidget],
+            },
+            { id: 'is-moving', label: 'IsMoving', widgets: [ArmIsMovingWidget] },
+        ],
+    },
+    [ResourceTriplets.AudioInput]: {
+        widget: AudioInputWidget,
+        apis: [
+            { id: 'get-properties', label: 'GetProperties', widgets: [AudioInputGetPropertiesWidget] },
+        ],
+    },
+    [ResourceTriplets.AudioOutput]: {
+        widget: AudioOutputWidget,
+        apis: [
+            {
+                id: 'get-properties',
+                label: 'GetProperties',
+                widgets: [AudioOutputGetPropertiesWidget],
+            },
+        ],
+    },
+    [ResourceTriplets.Base]: {
+        widget: BaseWidget,
+        apis: [
+            { id: 'quick-move', label: 'Quick move', widgets: [BaseQuickMoveWidget] },
+            { id: 'move-straight', label: 'MoveStraight', widgets: [BaseMoveStraightWidget] },
+            { id: 'spin', label: 'Spin', widgets: [BaseSpinWidget] },
+            { id: 'set-power', label: 'SetPower', widgets: [BaseSetPowerWidget] },
+            { id: 'set-velocity', label: 'SetVelocity', widgets: [BaseSetVelocityWidget] },
+            { id: 'is-moving', label: 'IsMoving', widgets: [BaseIsMovingWidget] },
+        ],
+    },
+    [ResourceTriplets.Board]: { widget: BoardWidget, apis: [] },
+    [ResourceTriplets.Button]: { widget: ButtonWidget, apis: [] },
+    [ResourceTriplets.Camera]: { widget: CameraWidget, apis: [] },
+    [ResourceTriplets.Encoder]: {
+        widget: EncoderWidget,
+        apis: [{ id: 'get-position', label: 'GetPosition', widgets: [EncoderGetPositionWidget] }],
+    },
+    [ResourceTriplets.Gantry]: {
+        widget: GantryWidget,
+        apis: [
+            { id: 'home', label: 'Home', widgets: [GantryHomeWidget] },
+            { id: 'move-to-position', label: 'MoveToPosition', widgets: [GantryMoveToPositionWidget] },
+            { id: 'quick-move', label: 'Quick move', widgets: [GantryQuickMoveWidget] },
+            { id: 'get-position', label: 'GetPosition', widgets: [GantryGetPositionWidget] },
+            { id: 'is-moving', label: 'IsMoving', widgets: [GantryIsMovingWidget] },
+        ],
+    },
+    [ResourceTriplets.Gripper]: {
+        widget: GripperWidget,
+        apis: [
+            { id: 'open-grab', label: 'Open / Grab', widgets: [GripperOpenWidget, GripperGrabWidget] },
+            {
+                id: 'is-holding-something',
+                label: 'IsHoldingSomething',
+                widgets: [GripperIsHoldingSomethingWidget],
+            },
+            { id: 'is-moving', label: 'IsMoving', widgets: [GripperIsMovingWidget] },
+        ],
+    },
+    [ResourceTriplets.InputController]: { widget: InputControllerWidget, apis: [] },
+    [ResourceTriplets.Motor]: {
+        widget: MotorWidget,
+        apis: [
+            { id: 'quick-move', label: 'Quick move', widgets: [MotorQuickMoveWidget] },
+            { id: 'set-power', label: 'SetPower', widgets: [MotorSetPowerWidget] },
+            { id: 'set-rpm', label: 'SetRPM', widgets: [MotorSetRPMWidget] },
+            { id: 'go-for', label: 'GoFor', widgets: [MotorGoForWidget] },
+            { id: 'go-to', label: 'GoTo', widgets: [MotorGoToWidget] },
+            { id: 'is-moving', label: 'IsMoving', widgets: [MotorIsMovingWidget] },
+        ],
+    },
+    [ResourceTriplets.MovementSensor]: {
+        widget: MovementSensorWidget,
+        apis: [
+            { id: 'get-position', label: 'GetPosition', widgets: [MovementSensorGetPositionWidget] },
+            {
+                id: 'get-orientation',
+                label: 'GetOrientation',
+                widgets: [MovementSensorGetOrientationWidget],
+            },
+            {
+                id: 'get-compass-heading',
+                label: 'GetCompassHeading',
+                widgets: [MovementSensorGetCompassHeadingWidget],
+            },
+            { id: 'get-accuracy', label: 'GetAccuracy', widgets: [MovementSensorGetAccuracyWidget] },
+        ],
+    },
+    [ResourceTriplets.PowerSensor]: {
+        widget: PowerSensorWidget,
+        apis: [
+            { id: 'get-voltage', label: 'GetVoltage', widgets: [PowerSensorGetVoltageWidget] },
+            { id: 'get-current', label: 'GetCurrent', widgets: [PowerSensorGetCurrentWidget] },
+            { id: 'get-power', label: 'GetPower', widgets: [PowerSensorGetPowerWidget] },
+        ],
+    },
+    [ResourceTriplets.Sensor]: { widget: SensorWidget, apis: [] },
+    [ResourceTriplets.Servo]: {
+        widget: ServoWidget,
+        apis: [
+            { id: 'move', label: 'Move', widgets: [ServoMoveWidget] },
+            { id: 'quick-move', label: 'Quick move', widgets: [ServoQuickMoveWidget] },
+            { id: 'is-moving', label: 'IsMoving', widgets: [ServoIsMovingWidget] },
+        ],
+    },
+    [ResourceTriplets.Switch]: { widget: SwitchWidget, apis: [] },
+    // services
+    [ResourceTriplets.Discovery]: { widget: DiscoveryWidget, apis: [] },
+    [ResourceTriplets.MLModel]: { widget: MLModelServiceWidget, apis: [] },
+    [ResourceTriplets.Navigation]: { widget: NavigationServiceWidget, apis: [] },
+    [ResourceTriplets.Slam]: {
+        widget: SlamWidget,
+        apis: [{ id: 'get-position', label: 'GetPosition', widgets: [SlamGetPositionWidget] }],
+    },
+    [ResourceTriplets.Vision]: { widget: VisionServiceWidget, apis: [] },
+};
+/**
+ * Returns a resource's individual API widgets. Each entry carries a stable `id`, a
+ * display `label`, and the `widgets` to render with `{ partID, resourceName }`.
+ *
+ * Returns `[]` for a resource with a card but no standalone API widgets, and for
+ * unrecognized resources.
+ *
+ * @example
+ * apiWidgetsForResource(gripperResourceName)
+ * // [{ id: 'open-grab', label: 'Open / Grab', widgets: [GripperOpenWidget, GripperGrabWidget] }, ...]
+ */
+export const apiWidgetsForResource = (resource) => {
+    const api = getResourceAPI(resource);
+    return api in resourceWidgetRegistry
+        ? resourceWidgetRegistry[api].apis
+        : [];
+};
+/**
+ * Returns every resource triplet that has a test card, mapped to its API widgets.
+ * Use this to enumerate the full catalog, e.g. a menu spanning every resource type;
+ * for a single resource, prefer `apiWidgetsForResource`.
+ *
+ * @example
+ * availableAPIWidgets()[ResourceTriplets.Gripper]
+ * // [{ id: 'open-grab', label: 'Open / Grab', widgets: [GripperOpenWidget, GripperGrabWidget] }, ...]
+ */
+export const availableAPIWidgets = () => {
+    const result = {};
+    for (const triplet of Object.keys(resourceWidgetRegistry)) {
+        result[triplet] = resourceWidgetRegistry[triplet].apis;
+    }
+    return result;
+};
+/** Returns the full composite test card for a resource, or `undefined` if none exists. */
+export const widgetForResource = (resource) => {
+    const api = getResourceAPI(resource);
+    return api in resourceWidgetRegistry
+        ? resourceWidgetRegistry[api].widget
+        : undefined;
+};
+const knownResources = new Set(Object.values(ResourceTriplets));
+/** Whether a resource's API is a recognized Viam resource triplet. */
+export const isKnownResource = (resource) => knownResources.has(getResourceAPI(resource));
+const hiddenResources = new Set([
+    ResourceTriplets.DataManager,
+    ResourceTriplets.Motion,
+    ResourceTriplets.Sensors,
+    ResourceTriplets.Shell,
+]);
+/** Whether the control view should surface a card for this resource. */
+export const showResourceWidget = (resource) => resource.namespace !== 'rdk-internal' && !hiddenResources.has(getResourceAPI(resource));

package/dist/resource.d.ts

@@ -1,13 +1,8 @@
 import type { ResourceStatus } from '@viamrobotics/svelte-sdk';
-import type { Component } from 'svelte';
 import { type ResourceName } from '@viamrobotics/sdk';
 export type NamedResourceStatus = ResourceStatus & {
     name: ResourceName;
 };
-interface ResourceWidget {
-    partID: string;
-    resourceName: string;
-}
 export declare const ResourceStatusText: {
     0: string;
     3: string;
@@ -17,7 +12,3 @@ export declare const ResourceStatusText: {
     4: string;
 };
 export declare const sortResourceNames: (names: ResourceName[]) => ResourceName[];
-export declare const hasWidget: (resource: ResourceName) => boolean;
-export declare const widgetForResource: (resource: ResourceName) => Component<ResourceWidget> | undefined;
-export declare const showResourceWidget: (resource: ResourceName) => boolean;
-export {};

package/dist/resource.js

@@ -1,7 +1,4 @@
 import { robotApi } from '@viamrobotics/sdk';
-import { clientMap } from "./client-map.js";
-import { ArmWidget, AudioInputWidget, AudioOutputWidget, BaseWidget, BoardWidget, ButtonWidget, CameraWidget, DiscoveryWidget, EncoderWidget, GantryWidget, GripperWidget, InputControllerWidget, MLModelServiceWidget, MotorWidget, MovementSensorWidget, NavigationServiceWidget, PowerSensorWidget, SensorWidget, ServoWidget, SlamWidget, SwitchWidget, VisionServiceWidget, } from './components';
-import { getResourceAPI } from "./get-resource-api.js";
 export const ResourceStatusText = {
     [robotApi.ResourceStatus_State.UNSPECIFIED]: 'unspecified',
     [robotApi.ResourceStatus_State.READY]: 'ready',
@@ -10,60 +7,6 @@ export const ResourceStatusText = {
     [robotApi.ResourceStatus_State.UNCONFIGURED]: 'unconfigured',
     [robotApi.ResourceStatus_State.REMOVING]: 'removing',
 };
-// The types are nicer to work with as arrays (as opposed to a record of objects) because TS will infer the types.
-// try not to expose this map so that we can easily refactor it.
-const resourceMap = 
-// api: [client, testView, showResourceInControlView]
-// list created via `cat rdkbuiltins/viam-server-stable.json | rg "api" | sort | uniq`
-{
-    'rdk:component:arm': [clientMap['rdk:component:arm'], ArmWidget, true],
-    'rdk:component:audio_in': [clientMap['rdk:component:audio_in'], AudioInputWidget, true],
-    'rdk:component:audio_out': [clientMap['rdk:component:audio_out'], AudioOutputWidget, true],
-    'rdk:component:base': [clientMap['rdk:component:base'], BaseWidget, true],
-    'rdk:component:board': [clientMap['rdk:component:board'], BoardWidget, true],
-    'rdk:component:button': [clientMap['rdk:component:button'], ButtonWidget, true],
-    'rdk:component:camera': [clientMap['rdk:component:camera'], CameraWidget, true],
-    'rdk:component:encoder': [clientMap['rdk:component:encoder'], EncoderWidget, true],
-    'rdk:component:gantry': [clientMap['rdk:component:gantry'], GantryWidget, true],
-    'rdk:component:generic': [clientMap['rdk:component:generic'], undefined, true],
-    'rdk:component:gripper': [clientMap['rdk:component:gripper'], GripperWidget, true],
-    'rdk:component:input_controller': [
-        clientMap['rdk:component:input_controller'],
-        InputControllerWidget,
-        true,
-    ],
-    'rdk:component:motor': [clientMap['rdk:component:motor'], MotorWidget, true],
-    'rdk:component:movement_sensor': [
-        clientMap['rdk:component:movement_sensor'],
-        MovementSensorWidget,
-        true,
-    ],
-    'rdk:component:pose_tracker': [clientMap['rdk:component:pose_tracker'], undefined, true],
-    'rdk:component:power_sensor': [
-        clientMap['rdk:component:power_sensor'],
-        PowerSensorWidget,
-        true,
-    ],
-    'rdk:component:sensor': [clientMap['rdk:component:sensor'], SensorWidget, true],
-    'rdk:component:servo': [clientMap['rdk:component:servo'], ServoWidget, true],
-    'rdk:component:switch': [clientMap['rdk:component:switch'], SwitchWidget, true],
-    'rdk:service:base_remote_control': [undefined, undefined, true],
-    // dont show -- confusing to users
-    'rdk:service:data_manager': [clientMap['rdk:service:data_manager'], undefined, false],
-    'rdk:service:discovery': [clientMap['rdk:service:discovery'], DiscoveryWidget, true],
-    'rdk:service:generic': [clientMap['rdk:service:generic'], undefined, true],
-    'rdk:service:mlmodel': [clientMap['rdk:service:mlmodel'], MLModelServiceWidget, true],
-    // dont show -- confusing to users
-    'rdk:service:motion': [clientMap['rdk:service:motion'], undefined, false],
-    'rdk:service:navigation': [clientMap['rdk:service:navigation'], NavigationServiceWidget, true],
-    // dont show -- confusing to users
-    'rdk:service:sensors': [undefined, undefined, false],
-    'rdk:service:shell': [undefined, undefined, false],
-    'rdk:service:slam': [clientMap['rdk:service:slam'], SlamWidget, true],
-    'rdk:service:vision': [clientMap['rdk:service:vision'], VisionServiceWidget, true],
-    'rdk:service:world_state_store': [clientMap['rdk:service:world_state_store'], undefined, true],
-    'rdk:service:video': [clientMap['rdk:service:video'], undefined, true],
-};
 // sorts resource names by local/remote -> type -> name (alphabetical) to produce a list like
 // component a
 // component z
@@ -79,18 +22,3 @@ export const sortResourceNames = (names) => names.toSorted(({ type, name }, { ty
     // sort components before services
     return type === otherType ? name.localeCompare(otherName) : type.localeCompare(otherType);
 });
-export const hasWidget = (resource) => getResourceAPI(resource) in resourceMap;
-export const widgetForResource = (resource) => {
-    const resAPI = getResourceAPI(resource);
-    return resAPI in resourceMap
-        ? resourceMap[resAPI][1]
-        : undefined;
-};
-export const showResourceWidget = (resource) => {
-    if (resource.namespace === 'rdk-internal') {
-        return false;
-    }
-    const resAPI = getResourceAPI(resource);
-    // unknown apis should still get cards & show up in the sidebar
-    return resAPI in resourceMap ? resourceMap[resAPI][2] : true;
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viamrobotics/test-widgets",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "license": "Apache-2.0",
   "type": "module",
   "files": [
@@ -72,7 +72,7 @@
     "@viamrobotics/svelte-sdk": "^1.2.1",
     "@viamrobotics/tailwind-config": "^1.0.0",
     "@viamrobotics/three": "^0.0.9",
-    "@vitest/browser": "^4.1.6",
+    "@vitest/browser": "^4.1.8",
     "@vitest/browser-playwright": "^4.1.5",
     "@vitest/coverage-v8": "^4.1.5",
     "eslint": "^10.2.1",
@@ -90,7 +90,7 @@
     "prettier-plugin-tailwindcss": "^0.7.4",
     "publint": "^0.3.18",
     "runed": "^0.37.1",
-    "svelte": "^5.55.7",
+    "svelte": "^5.56.3",
     "svelte-check": "^4.4.6",
     "svelte-splitpanes": "^8.0.12",
     "tailwind-merge": "^3.5.0",
@@ -100,7 +100,7 @@
     "type-fest": "^5.6.0",
     "typescript": "^6.0.3",
     "typescript-eslint": "^8.59.1",
-    "vite": "^8.0.10",
+    "vite": "^8.0.16",
     "vite-plugin-devtools-json": "^1.0.0",
     "vite-plugin-glsl": "^1.6.0",
     "vitest": "^4.1.5",
@@ -109,6 +109,9 @@
   "engines": {
     "node": ">=22.12.0"
   },
+  "dependencies": {
+    "svelte-tweakpane-ui": "^1.5.17"
+  },
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && pnpm prepack",