lutaml-jsonschema 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a480735cb35e5d992a010e0f3f51d030a53041d67be3e04b748dfca2b79e2cf2
-  data.tar.gz: cf7332baaff5e9ceda9171e8baf56a40443f8946527542c8a18d40141899d68e
+  metadata.gz: 7489a2b5deaa74c751691afdf57939c046e29d6a853774462ce5587e05dcbcf3
+  data.tar.gz: fca882189c10df105bc30df80c5fe34cc0108ca82b87420e638170ec7a62d1e3
 SHA512:
-  metadata.gz: 8511a93b9362c07dbd1403f65a00c2bfeccd0f23b50b35c52ec257a4c22d4911f3578e67bfc7ae01c49f37ee2ed927257995d8ebfb7ec505484cfee61b0d8de2
-  data.tar.gz: d5f8b8b703ae21083dfd3b566825be66efc3901f94711d7188a78e3967754d4f6ef185067e967426dd69dfdedc617baee17ff69752ad7faf4ee0d11c8f55b5a6
+  metadata.gz: b27dd39b382a08e4fc1aa58ae1b9803ffbeee75fc3db6e3df0261871ce43d3aabfbe7cc863207b190c5a88e52212fca6f43acd40506d4f82088094a0ffd57ebf
+  data.tar.gz: d3af571ef80959e85a9c3e7ccaebb0a5e721d94348616a873edd25f6c488c596542ca0a8a836b94917a34bfdbc675cc2dc50f844995d7c5a055fc44348987926

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-05-07 03:03:38 UTC using RuboCop version 1.86.1.
+# on 2026-05-07 10:44:46 UTC using RuboCop version 1.86.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,15 +11,7 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'lutaml-jsonschema.gemspec'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: with_first_argument, with_fixed_indentation
-Layout/ArgumentAlignment:
-  Exclude:
-    - 'lib/lutaml/jsonschema/spa/spa_builder.rb'
-
-# Offense count: 2
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleAlignWith.
 # SupportedStylesAlignWith: either, start_of_block, start_of_line
@@ -27,21 +19,7 @@ Layout/BlockAlignment:
   Exclude:
     - 'lib/lutaml/jsonschema/spa/spa_builder.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/BlockEndNewline:
-  Exclude:
-    - 'lib/lutaml/jsonschema/spa/spa_builder.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
-# SupportedStylesAlignWith: start_of_line, relative_to_receiver
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/lutaml/jsonschema/spa/spa_builder.rb'
-
-# Offense count: 31
+# Offense count: 28
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -61,13 +39,6 @@ Layout/LineLength:
     - 'spec/lutaml/schema_set_resolution_spec.rb'
     - 'spec/lutaml/spa_builder_spec.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/lutaml/jsonschema/spa/spa_builder.rb'
-
 # Offense count: 2
 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
 Lint/DuplicateBranch:
@@ -136,25 +107,8 @@ Naming/PredicateMethod:
   Exclude:
     - 'lib/lutaml/jsonschema/schema_set.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# AllowedMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'lib/lutaml/jsonschema/spa/spa_builder.rb'
-
 # Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/IdenticalConditionalBranches:
   Exclude:
     - 'spec/lutaml/spa_builder_spec.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/MapIntoArray:
-  Exclude:
-    - 'lib/lutaml/jsonschema/spa/spa_builder.rb'

data/frontend/src/__tests__/useMarkdownLite.test.ts

@@ -0,0 +1,41 @@
+import { describe, it, expect } from 'vitest'
+import { renderInlineMarkdown } from '../composables/useMarkdownLite'
+
+describe('renderInlineMarkdown', () => {
+  it('returns empty for empty string', () => {
+    expect(renderInlineMarkdown('')).toBe('')
+  })
+
+  it('renders bold text', () => {
+    expect(renderInlineMarkdown('**bold**')).toBe('<strong>bold</strong>')
+  })
+
+  it('renders italic text', () => {
+    expect(renderInlineMarkdown('*italic*')).toBe('<em>italic</em>')
+  })
+
+  it('renders inline code', () => {
+    expect(renderInlineMarkdown('`code`')).toBe('<code class="md-code">code</code>')
+  })
+
+  it('renders links', () => {
+    const result = renderInlineMarkdown('[click](https://example.com)')
+    expect(result).toContain('<a href="https://example.com"')
+    expect(result).toContain('class="md-link"')
+    expect(result).toContain('>click</a>')
+  })
+
+  it('escapes HTML', () => {
+    expect(renderInlineMarkdown('<b>no</b>')).toBe('&lt;b&gt;no&lt;/b&gt;')
+  })
+
+  it('returns plain text unchanged', () => {
+    expect(renderInlineMarkdown('hello world')).toBe('hello world')
+  })
+
+  it('handles mixed formatting', () => {
+    const result = renderInlineMarkdown('Use `method` for **special** cases.')
+    expect(result).toContain('<code class="md-code">method</code>')
+    expect(result).toContain('<strong>special</strong>')
+  })
+})

data/frontend/src/__tests__/useSchemaTypes.test.ts

@@ -38,8 +38,16 @@ describe('primaryType', () => {
 })
 
 describe('displayType', () => {
-  it('shows array<itemsType> for arrays', () => {
-    expect(displayType(prop({ type: 'array', itemsType: 'string' }))).toBe('array<string>')
+  it('shows "array of X" for arrays', () => {
+    expect(displayType(prop({ type: 'array', itemsType: 'string' }))).toBe('array of string')
+  })
+
+  it('shows resolved title for $ref props', () => {
+    expect(displayType(prop({ type: 'object', ref: '#/definitions/Addr' }), 'Address')).toBe('Address')
+  })
+
+  it('ignores resolved title when no ref', () => {
+    expect(displayType(prop({ type: 'object' }), 'Address')).toBe('object')
   })
 
   it('shows type (format) when format is set', () => {
@@ -225,24 +233,34 @@ describe('hasConstraints', () => {
 })
 
 describe('humanizeConstraints', () => {
-  it('returns string range constraint', () => {
+  it('returns string range constraint with bracket notation', () => {
     const chips = humanizeConstraints(prop({ type: 'string', minLength: 1, maxLength: 100 }))
-    expect(chips).toEqual([{ label: '1..100 characters' }])
+    expect(chips).toEqual([{ label: '[ 1 .. 100 ] characters' }])
   })
 
-  it('returns numeric >= and <= constraints', () => {
+  it('returns non-empty for minLength === 1', () => {
+    const chips = humanizeConstraints(prop({ type: 'string', minLength: 1 }))
+    expect(chips).toEqual([{ label: 'non-empty' }])
+  })
+
+  it('returns numeric range constraint with bracket notation', () => {
     const chips = humanizeConstraints(prop({ type: 'integer', minimum: 0, maximum: 100 }))
-    expect(chips.map(c => c.label)).toEqual(['>= 0', '<= 100'])
+    expect(chips.map(c => c.label)).toEqual(['[ 0 .. 100 ]'])
   })
 
-  it('returns exclusive bounds with > and <', () => {
+  it('returns exclusive bounds combined as range', () => {
     const chips = humanizeConstraints(prop({ type: 'number', exclusiveMinimum: 0, exclusiveMaximum: 100 }))
-    expect(chips.map(c => c.label)).toEqual(['> 0', '< 100'])
+    expect(chips.map(c => c.label)).toEqual(['( 0 .. 100 )'])
+  })
+
+  it('returns inclusive range combined with exclusive modifier', () => {
+    const chips = humanizeConstraints(prop({ type: 'integer', minimum: 0, maximum: 100, exclusiveMinimum: 0 }))
+    expect(chips.map(c => c.label)).toEqual(['( 0 .. 100 ]'])
   })
 
-  it('returns array range constraint', () => {
+  it('returns array range constraint with bracket notation', () => {
     const chips = humanizeConstraints(prop({ type: 'array', minItems: 1, maxItems: 10 }))
-    expect(chips).toEqual([{ label: '1..10 items' }])
+    expect(chips).toEqual([{ label: '[ 1 .. 10 ] items' }])
   })
 
   it('returns unique for uniqueItems', () => {
@@ -275,6 +293,26 @@ describe('humanizeConstraints', () => {
     expect(chips).toEqual([])
   })
 
+  it('returns "non-empty" for minLength 1', () => {
+    const chips = humanizeConstraints(prop({ type: 'string', minLength: 1 }))
+    expect(chips.map(c => c.label)).toEqual(['non-empty'])
+  })
+
+  it('returns "= N characters" when min equals max', () => {
+    const chips = humanizeConstraints(prop({ type: 'string', minLength: 10, maxLength: 10 }))
+    expect(chips.map(c => c.label)).toEqual(['= 10 characters'])
+  })
+
+  it('returns "= N items" when minItems equals maxItems', () => {
+    const chips = humanizeConstraints(prop({ type: 'array', minItems: 3, maxItems: 3 }))
+    expect(chips.map(c => c.label)).toEqual(['= 3 items'])
+  })
+
+  it('returns decimal places for small multipleOf', () => {
+    const chips = humanizeConstraints(prop({ type: 'number', multipleOf: 0.01 }))
+    expect(chips.map(c => c.label)).toEqual(['decimal places <= 2'])
+  })
+
   it('returns contentMediaType and contentEncoding', () => {
     const chips = humanizeConstraints(prop({ contentMediaType: 'text/html', contentEncoding: 'base64' }))
     expect(chips.map(c => c.label)).toEqual(['content-type: text/html', 'encoding: base64'])

data/frontend/src/components/AppSidebar.vue

@@ -1,5 +1,5 @@
 <template>
-  <aside class="sidebar" :class="{ collapsed: uiStore.sidebarCollapsed }">
+  <aside class="sidebar" :class="{ collapsed: uiStore.sidebarCollapsed }" :aria-label="`${schemaStore.metadata?.title || 'JSON Schema Docs'} navigation`">
     <div class="sidebar-content">
       <!-- Branding -->
       <div class="sidebar-branding">
@@ -44,18 +44,21 @@
             type="text"
             class="search-input"
             placeholder="Search schemas, definitions..."
+            aria-label="Search schemas and definitions"
+            @keydown="handleSearchKey"
           />
-          <button v-if="searchQuery" class="search-clear" @click="searchQuery = ''">
+          <button v-if="searchQuery" class="search-clear" aria-label="Clear search" @click="searchQuery = ''">
             <svg width="12" height="12" viewBox="0 0 12 12" fill="none">
               <path d="M3 3l6 6M9 3l-6 6" stroke="currentColor" stroke-width="1.2" stroke-linecap="round"/>
             </svg>
           </button>
         </div>
-        <div v-if="searchQuery && searchResults.length" class="search-results">
+        <div v-if="debouncedQuery && searchResults.length" class="search-results">
           <button
-            v-for="result in searchResults"
+            v-for="(result, idx) in searchResults"
             :key="`${result.type}:${result.name}@${result.schemaName}`"
             class="search-result-item"
+            :class="{ active: idx === activeResultIdx }"
             @click="goToSearchResult(result)"
           >
             <span class="badge" :class="resultBadgeClass(result.type)">{{ resultTypeLabel(result.type) }}</span>
@@ -63,6 +66,9 @@
             <span class="search-result-schema text-muted">{{ result.schemaName }}</span>
           </button>
         </div>
+        <div v-else-if="debouncedQuery && !searchResults.length && searchQuery" class="search-no-results text-muted">
+          No results found
+        </div>
         <div v-else class="schema-tree">
           <div
             v-for="schema in schemaStore.schemas"
@@ -72,7 +78,12 @@
             <div
               class="schema-node-header"
               :class="{ active: schema.name === schemaStore.selectedSchemaName }"
+              role="treeitem"
+              :aria-expanded="uiStore.isSchemaExpanded(schema.name)"
+              tabindex="0"
               @click="toggleAndSelect(schema.name)"
+              @keydown.enter="toggleAndSelect(schema.name)"
+              @keydown.space.prevent="toggleAndSelect(schema.name)"
             >
               <svg width="12" height="12" viewBox="0 0 12 12" fill="none" :class="{ expanded: uiStore.isSchemaExpanded(schema.name) }">
                 <path d="M4 3l3 3-3 3" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
@@ -139,7 +150,7 @@
 </template>
 
 <script setup lang="ts">
-import { ref, computed } from 'vue'
+import { ref, computed, watch } from 'vue'
 import { useSchemaStore } from '../stores/schemaStore'
 import { useUiStore } from '../stores/uiStore'
 import type { SpaSearchEntry } from '../types'
@@ -148,9 +159,23 @@ const schemaStore = useSchemaStore()
 const uiStore = useUiStore()
 
 const searchQuery = ref('')
+const debouncedQuery = ref('')
+const activeResultIdx = ref(-1)
+
+let debounceTimer: ReturnType<typeof setTimeout> | null = null
+
+watch(searchQuery, (q) => {
+  if (debounceTimer) clearTimeout(debounceTimer)
+  if (!q.trim()) {
+    debouncedQuery.value = ''
+    activeResultIdx.value = -1
+    return
+  }
+  debounceTimer = setTimeout(() => { debouncedQuery.value = q }, 300)
+})
 
 const searchResults = computed(() => {
-  const q = searchQuery.value.trim().toLowerCase()
+  const q = debouncedQuery.value.trim().toLowerCase()
   if (!q) return []
   return schemaStore.searchIndex.filter(entry =>
     entry.name.toLowerCase().includes(q) ||
@@ -159,6 +184,25 @@ const searchResults = computed(() => {
   ).slice(0, 15)
 })
 
+watch(searchResults, () => { activeResultIdx.value = -1 })
+
+function handleSearchKey(event: KeyboardEvent) {
+  if (event.key === 'ArrowDown') {
+    activeResultIdx.value = Math.min(activeResultIdx.value + 1, searchResults.value.length - 1)
+    event.preventDefault()
+  } else if (event.key === 'ArrowUp') {
+    activeResultIdx.value = Math.max(0, activeResultIdx.value - 1)
+    event.preventDefault()
+  } else if (event.key === 'Enter') {
+    const result = searchResults.value[activeResultIdx.value]
+    if (result) goToSearchResult(result)
+    activeResultIdx.value = -1
+  } else if (event.key === 'Escape') {
+    searchQuery.value = ''
+    activeResultIdx.value = -1
+  }
+}
+
 function goToSearchResult(result: SpaSearchEntry) {
   schemaStore.selectSchema(result.schemaName)
   if (result.type === 'definition') {
@@ -167,6 +211,7 @@ function goToSearchResult(result: SpaSearchEntry) {
     schemaStore.selectProperty(result.name)
   }
   searchQuery.value = ''
+  debouncedQuery.value = ''
   uiStore.closeDetailPanel()
 }
 
@@ -544,10 +589,17 @@ function selectDefinition(schemaName: string, defName: string) {
   transition: background var(--transition-fast);
 }
 
-.search-result-item:hover {
+.search-result-item:hover,
+.search-result-item.active {
   background: var(--bg-hover);
 }
 
+.search-no-results {
+  padding: var(--space-3) var(--space-2);
+  font-size: var(--text-xs);
+  text-align: center;
+}
+
 .search-result-name {
   flex: 1;
   color: var(--text-primary);
@@ -629,4 +681,19 @@ function selectDefinition(schemaName: string, defName: string) {
 .footer-text a:hover {
   text-decoration: underline;
 }
+
+@media (max-width: 768px) {
+  .sidebar {
+    position: fixed;
+    top: 0;
+    left: 0;
+    bottom: 0;
+    z-index: 40;
+    box-shadow: var(--shadow-lg);
+  }
+  .sidebar.collapsed {
+    transform: translateX(-100%);
+    width: 280px;
+  }
+}
 </style>