fix(lib): support Vector/DataArray/Matrix/DataChoice/Geometry in DataRecord fields

Sam-Bolling · Sam-Bolling · commit 5ec3df70e94a · 2026-02-20T07:24:44.000-05:00
DataRecord's parseField() only handled simple scalars and nested
DataRecords. Complex types (Vector, DataArray, Matrix, DataChoice,
Geometry) threw 'unsupported component type'. This broke control stream
schema display for OSH FCU payloads containing Vector fields.

Fix: parseDataRecord() now accepts an optional componentParser callback.
parser.ts passes parseSWEComponent as the callback, breaking the circular
dependency cleanly. When provided, any SWE component type can appear as
a DataRecord field.

Also fixes schema parse error display in SweSchemaDisplay.vue - errors
were silently swallowed when raw schema was available but parsing failed.

Adds test: control stream schema with Vector field (real OSH FCU pattern).
diff --git a/demo/src/components/SweSchemaDisplay.vue b/demo/src/components/SweSchemaDisplay.vue
@@ -269,8 +269,8 @@ function shortenUri(uri: string): string {
       {{ error }}
     </Message>
 
-    <!-- Parse warning -->
-    <div v-if="error && schemaFields.length" class="schema-parse-warn">
+    <!-- Parse warning (raw data available but parsing had issues) -->
+    <div v-if="error && rawSchema" class="schema-parse-warn">
       <i class="pi pi-exclamation-triangle"></i>
       <span>{{ error }}</span>
     </div>
diff --git a/src/ogc-api/csapi/formats/schema-response.spec.ts b/src/ogc-api/csapi/formats/schema-response.spec.ts
@@ -12,6 +12,7 @@ import type {
   SweBoolean,
   SweCount,
   SweCategory,
+  Vector,
 } from './swecommon/types.js';
 
 describe('parseDatastreamSchemaResponse', () => {
@@ -368,7 +369,65 @@ describe('parseControlStreamSchemaResponse', () => {
   });
 
   // ========================================
-  // Test 4: Non-object input
+  // Test 4: DataRecord with Vector field (real OSH payload)
+  // ========================================
+
+  it('parses a control stream schema with Vector fields (OSH FCU pattern)', () => {
+    const raw = {
+      commandFormat: 'application/json',
+      parametersSchema: {
+        type: 'DataRecord',
+        name: 'mavControl',
+        label: 'Location Control',
+        description: 'Interfaces with MAVLINK and OSH to effectuate control over the platform',
+        fields: [
+          {
+            type: 'Vector',
+            name: 'locationVectorLLA',
+            referenceFrame: '',
+            coordinates: [
+              { type: 'Quantity', name: 'Latitude', uom: { code: 'deg' } },
+              { type: 'Quantity', name: 'Longitude', uom: { code: 'deg' } },
+              { type: 'Quantity', name: 'AltitudeAGL', uom: { code: 'm' } },
+            ],
+          },
+          { type: 'Boolean', name: 'returnToStart' },
+          { type: 'Count', name: 'hoverSeconds' },
+        ],
+      },
+    };
+    const schema = parseControlStreamSchemaResponse(raw);
+    expect(schema.commandFormat).toBe('application/json');
+    expect(schema.parametersSchema).toBeDefined();
+
+    const dr = schema.parametersSchema as DataRecord;
+    expect(dr.type).toBe('DataRecord');
+    expect(dr.fields).toHaveLength(3);
+
+    // Field 0: Vector with 3 coordinates
+    const vf = dr.fields[0] as TypedDataField;
+    expect(vf.name).toBe('locationVectorLLA');
+    const vec = vf.component as Vector;
+    expect(vec.type).toBe('Vector');
+    expect(vec.coordinates).toHaveLength(3);
+    expect(vec.coordinates[0].name).toBe('Latitude');
+    expect(((vec.coordinates[0] as TypedDataField).component as SweQuantity).uom).toEqual({ code: 'deg' });
+    expect(vec.coordinates[2].name).toBe('AltitudeAGL');
+    expect(((vec.coordinates[2] as TypedDataField).component as SweQuantity).uom).toEqual({ code: 'm' });
+
+    // Field 1: Boolean
+    const bf = dr.fields[1] as TypedDataField;
+    expect(bf.name).toBe('returnToStart');
+    expect((bf.component as SweBoolean).type).toBe('Boolean');
+
+    // Field 2: Count
+    const cf = dr.fields[2] as TypedDataField;
+    expect(cf.name).toBe('hoverSeconds');
+    expect((cf.component as SweCount).type).toBe('Count');
+  });
+
+  // ========================================
+  // Test 5: Non-object input
   // ========================================
 
   it('throws on non-object input', () => {
diff --git a/src/ogc-api/csapi/formats/swecommon/data-record.ts b/src/ogc-api/csapi/formats/swecommon/data-record.ts
@@ -38,11 +38,20 @@ import type {
   DataRecord,
   DataField,
   TypedDataField,
+  AnyComponent,
 } from './types.js';
 
 import { parseSimpleComponent, SweCommonParseError } from './components.js';
 import { isRecord, parseBaseProperties } from './_helpers.js';
 
+/**
+ * Callback type for parsing any SWE component.
+ * Used to break the circular dependency between data-record.ts and parser.ts.
+ * When provided, enables DataRecord fields to contain complex types like
+ * Vector, DataArray, Matrix, DataChoice, and Geometry.
+ */
+export type ComponentParser = (json: unknown) => AnyComponent;
+
 // ========================================
 // Internal Helpers
 // ========================================
@@ -86,7 +95,7 @@ function isLinkReference(json: Record<string, unknown>): boolean {
  *
  * @see https://docs.ogc.org/is/24-014/24-014.html — SoftNamedProperty
  */
-function parseField(json: unknown, index: number): DataField | TypedDataField {
+function parseField(json: unknown, index: number, componentParser?: ComponentParser): DataField | TypedDataField {
   if (!isRecord(json)) {
     throw new SweCommonParseError(
       `DataRecord field at index ${index} must be a non-null object`,
@@ -122,11 +131,11 @@ function parseField(json: unknown, index: number): DataField | TypedDataField {
     );
   }
 
-  // Recursive DataRecord
+  // Recursive DataRecord — pass componentParser through for nested records
   if (type === 'DataRecord') {
     return {
       name,
-      component: parseDataRecord(json),
+      component: parseDataRecord(json, componentParser),
     } as TypedDataField;
   }
 
@@ -138,10 +147,21 @@ function parseField(json: unknown, index: number): DataField | TypedDataField {
     } as TypedDataField;
   }
 
-  // Future complex types (DataArray, Vector, Matrix, DataChoice, Geometry)
-  // are not yet implemented — throw with field context
+  // Complex types (Vector, DataArray, Matrix, DataChoice, Geometry)
+  // Delegate to the injected componentParser when available.
+  // This breaks the circular dependency: parser.ts provides parseSWEComponent
+  // as the callback, enabling DataRecord fields to contain any SWE component.
+  if (componentParser) {
+    return {
+      name,
+      component: componentParser(json),
+    } as TypedDataField;
+  }
+
   throw new SweCommonParseError(
-    `DataRecord field "${name}" has unsupported component type: "${type}"`,
+    `DataRecord field "${name}" has unsupported component type: "${type}". ` +
+      `Complex types (Vector, DataArray, Matrix, DataChoice, Geometry) require ` +
+      `a componentParser callback — use parseSWEComponent from parser.ts.`,
     `fields[${index}].type`
   );
 }
@@ -180,7 +200,7 @@ function parseField(json: unknown, index: number): DataField | TypedDataField {
  * @see https://docs.ogc.org/is/24-014/24-014.html — DataRecord
  * @see OAS: DataRecord (L7593), fields array (L531-L544)
  */
-export function parseDataRecord(json: unknown): DataRecord {
+export function parseDataRecord(json: unknown, componentParser?: ComponentParser): DataRecord {
   if (!isRecord(json)) {
     throw new SweCommonParseError(
       'DataRecord input must be a non-null object'
@@ -202,7 +222,7 @@ export function parseDataRecord(json: unknown): DataRecord {
   }
 
   const fields: DataField[] = (json.fields as unknown[]).map(
-    (fieldJson, index) => parseField(fieldJson, index)
+    (fieldJson, index) => parseField(fieldJson, index, componentParser)
   );
 
   const result: DataRecord = {
diff --git a/src/ogc-api/csapi/formats/swecommon/parser.ts b/src/ogc-api/csapi/formats/swecommon/parser.ts
@@ -741,7 +741,7 @@ export function parseSWEComponent(json: unknown): AnyComponent {
 
     // Complex components — delegate to dedicated parsers
     case 'DataRecord':
-      return parseDataRecord(json);
+      return parseDataRecord(json, parseSWEComponent);
 
     case 'DataArray':
       return parseDataArray(json);
