|
| 1 | +// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +import { describe, it, expect } from 'vitest'; |
| 4 | +import { |
| 5 | + validateSemanticRoles, |
| 6 | + FIELD_GROUP_UNDECLARED, |
| 7 | + FIELD_GROUP_EMPTY, |
| 8 | + SEMANTIC_ROLE_FIELD_UNKNOWN, |
| 9 | +} from './validate-semantic-roles'; |
| 10 | + |
| 11 | +const stack = (objects: unknown) => ({ objects }); |
| 12 | + |
| 13 | +describe('validateSemanticRoles (ADR-0085)', () => { |
| 14 | + it('passes a clean object', () => { |
| 15 | + const findings = validateSemanticRoles(stack([{ |
| 16 | + name: 'account', |
| 17 | + stageField: 'status', |
| 18 | + highlightFields: ['name', 'status'], |
| 19 | + fieldGroups: [{ key: 'basic', label: 'Basic' }], |
| 20 | + fields: { |
| 21 | + name: { type: 'text', group: 'basic' }, |
| 22 | + status: { type: 'select' }, |
| 23 | + }, |
| 24 | + }])); |
| 25 | + expect(findings).toEqual([]); |
| 26 | + }); |
| 27 | + |
| 28 | + it('flags a Field.group referencing an undeclared group', () => { |
| 29 | + const findings = validateSemanticRoles(stack([{ |
| 30 | + name: 'account', |
| 31 | + fieldGroups: [{ key: 'basic', label: 'Basic' }], |
| 32 | + fields: { |
| 33 | + name: { type: 'text', group: 'basic' }, |
| 34 | + vat: { type: 'text', group: 'billling' }, // typo |
| 35 | + }, |
| 36 | + }])); |
| 37 | + expect(findings).toHaveLength(1); |
| 38 | + expect(findings[0]).toMatchObject({ |
| 39 | + severity: 'warning', |
| 40 | + rule: FIELD_GROUP_UNDECLARED, |
| 41 | + path: 'objects[0].fields.vat.group', |
| 42 | + }); |
| 43 | + expect(findings[0].message).toContain('billling'); |
| 44 | + }); |
| 45 | + |
| 46 | + it('flags a declared group no field references', () => { |
| 47 | + const findings = validateSemanticRoles(stack([{ |
| 48 | + name: 'account', |
| 49 | + fieldGroups: [ |
| 50 | + { key: 'basic', label: 'Basic' }, |
| 51 | + { key: 'unused', label: 'Unused' }, |
| 52 | + ], |
| 53 | + fields: { name: { type: 'text', group: 'basic' } }, |
| 54 | + }])); |
| 55 | + expect(findings).toHaveLength(1); |
| 56 | + expect(findings[0]).toMatchObject({ rule: FIELD_GROUP_EMPTY }); |
| 57 | + expect(findings[0].message).toContain('unused'); |
| 58 | + }); |
| 59 | + |
| 60 | + it('flags stageField pointing at a missing field; false is fine', () => { |
| 61 | + const bad = validateSemanticRoles(stack([{ |
| 62 | + name: 'lead', stageField: 'pipeline', fields: { status: {} }, |
| 63 | + }])); |
| 64 | + expect(bad).toHaveLength(1); |
| 65 | + expect(bad[0]).toMatchObject({ rule: SEMANTIC_ROLE_FIELD_UNKNOWN, path: 'objects[0].stageField' }); |
| 66 | + |
| 67 | + const optedOut = validateSemanticRoles(stack([{ |
| 68 | + name: 'lead', stageField: false, fields: { status: {} }, |
| 69 | + }])); |
| 70 | + expect(optedOut).toEqual([]); |
| 71 | + }); |
| 72 | + |
| 73 | + it('flags unknown highlightFields entries, including via the compactLayout alias', () => { |
| 74 | + const findings = validateSemanticRoles(stack([{ |
| 75 | + name: 'account', |
| 76 | + highlightFields: ['name', 'industy'], // typo |
| 77 | + fields: { name: {}, industry: {} }, |
| 78 | + }])); |
| 79 | + expect(findings).toHaveLength(1); |
| 80 | + expect(findings[0].message).toContain('industy'); |
| 81 | + |
| 82 | + const aliased = validateSemanticRoles(stack([{ |
| 83 | + name: 'account', |
| 84 | + compactLayout: ['ghost'], |
| 85 | + fields: { name: {} }, |
| 86 | + }])); |
| 87 | + expect(aliased).toHaveLength(1); |
| 88 | + expect(aliased[0]).toMatchObject({ rule: SEMANTIC_ROLE_FIELD_UNKNOWN }); |
| 89 | + }); |
| 90 | + |
| 91 | + it('accepts objects as a name-keyed map and tolerates junk shapes', () => { |
| 92 | + const findings = validateSemanticRoles(stack({ |
| 93 | + account: { stageField: 'nope', fields: {} }, |
| 94 | + })); |
| 95 | + expect(findings).toHaveLength(1); |
| 96 | + expect(validateSemanticRoles({})).toEqual([]); |
| 97 | + expect(validateSemanticRoles(stack(null))).toEqual([]); |
| 98 | + expect(validateSemanticRoles(stack([null, 'junk', 42]))).toEqual([]); |
| 99 | + }); |
| 100 | +}); |
0 commit comments