@datagouv/components-next 1.0.2-dev.11 → 1.0.2-dev.111

package/src/components/DatasetCard.vue

@@ -36,6 +36,7 @@
       :icon="RiDatabase2Line"
       :url="datasetUrl || dataset.page"
       :target="datasetUrlInNewTab ? '_blank' : undefined"
+      :title-tag="titleTag"
     >
       {{ dataset.title }}
       <template
@@ -106,10 +107,12 @@
         </p>
       </div>
     </div>
-    <ObjectCardShortDescription
-      v-if="showDescriptionShort"
-      :text="getDescriptionShort(props.dataset)"
-    />
+    <slot>
+      <ObjectCardShortDescription
+        v-if="showDescriptionShort"
+        :text="getDescriptionShort(props.dataset)"
+      />
+    </slot>
   </ObjectCard>
 </template>
 
@@ -117,6 +120,7 @@
 import type { RouteLocationRaw } from 'vue-router'
 import { RiArchiveLine, RiDatabase2Line, RiDownloadLine, RiEyeLine, RiLineChartLine, RiLockLine, RiStarLine, RiSubtractLine } from '@remixicon/vue'
 import type { Dataset, DatasetV2 } from '../types/datasets'
+import type { TitleTag } from '../types/ui'
 import { summarize } from '../functions/helpers'
 import { useFormatDate } from '../functions/dates'
 import { getDescriptionShort } from '../functions/description'
@@ -137,6 +141,7 @@ type Props = {
   datasetUrlInNewTab?: boolean
   organizationUrl?: RouteLocationRaw
   showDescriptionShort?: boolean
+  titleTag?: TitleTag
 }
 
 const props = withDefaults(defineProps<Props>(), {

package/src/components/Form/Listbox.vue

@@ -0,0 +1,101 @@
+<template>
+  <Listbox v-model="model">
+    <div class="relative min-w-0">
+      <div
+        ref="floatingReference"
+        class="relative w-full cursor-default overflow-hidden bg-white text-left shadow-md focus:outline-none focus-visible:ring-2 focus-visible:ring-white/75 focus-visible:ring-offset-2 focus-visible:ring-offset-teal-300 sm:text-sm"
+      >
+        <ListboxButton class="input shadow-input text-sm flex items-center gap-2">
+          <slot name="button">
+            <div class="w-full flex items-center justify-between gap-2">
+              <div
+                class="truncate"
+                :class="{ 'text-new-disabled-text': isDisabled(model) }"
+              >
+                {{ displayValue(model) }}
+              </div>
+              <RiArrowDownSLine class="flex-none size-4 justify-self-end" />
+            </div>
+          </slot>
+        </ListboxButton>
+      </div>
+
+      <ListboxOptions
+        ref="popover"
+        :style="floatingStyles"
+        class="z-10 mt-1 absolute max-h-60 min-w-80 w-full overflow-auto rounded-md bg-white text-base shadow-lg ring-1 ring-black/5 focus:outline-none sm:text-sm pl-0"
+      >
+        <ListboxOption
+          v-for="option in options"
+          :key="getOptionId(toValue(option))"
+          v-slot="{ active, selected }"
+          as="template"
+          :value="option"
+        >
+          <li
+            class="relative cursor-default select-none py-2 pr-4 list-none flex items-center gap-2 text-gray-900"
+            :class="{
+              'bg-gray-lower': active && !isDisabled(toValue(option)),
+              'text-new-disabled-text': isDisabled(toValue(option)),
+              'pl-2': selected,
+              'pl-6': !selected,
+            }"
+          >
+            <div class="flex items-center justify-center aspect-square">
+              <RiCheckLine
+                v-if="selected"
+                class="size-4"
+                :class="isDisabled(toValue(option)) ?' text-new-disabled-text' : 'text-new-primary'"
+              />
+            </div>
+            <slot
+              name="option"
+              v-bind="{ option, active }"
+            >
+              {{ displayValue(option) }}
+            </slot>
+          </li>
+        </ListboxOption>
+      </ListboxOptions>
+    </div>
+  </Listbox>
+</template>
+
+<script setup lang="ts" generic="T extends string | number | object">
+import { Listbox, ListboxButton, ListboxOption, ListboxOptions } from '@headlessui/vue'
+import { useFloating, autoUpdate, autoPlacement } from '@floating-ui/vue'
+import { toValue, useTemplateRef } from 'vue'
+import { RiArrowDownSLine, RiCheckLine } from '@remixicon/vue'
+
+withDefaults(defineProps<{
+  options?: Array<T>
+  getOptionId?: (option: T) => string | number
+  displayValue: (option: T | null) => string
+  isDisabled?: (option: T | null) => boolean
+}>(), {
+  getOptionId: (option: T): string | number => {
+    if (typeof option === 'string') return option
+    if (typeof option === 'number') return option
+    if (typeof option === 'object' && 'id' in option) return option.id as string
+
+    throw new Error('Please set getOptionId()')
+  },
+  isDisabled: (option: T | null): boolean => {
+    if (option && typeof option === 'object' && 'disabled' in option) return option.disabled as boolean
+
+    return false
+  },
+})
+
+const model = defineModel<T | null>({ required: true })
+
+const referenceRef = useTemplateRef('floatingReference')
+const floatingRef = useTemplateRef<InstanceType<typeof ListboxOptions>>('popover')
+const { floatingStyles } = useFloating(referenceRef, floatingRef, {
+  middleware: [autoPlacement({
+    allowedPlacements: ['bottom-start', 'bottom', 'bottom-end'],
+    crossAxis: true,
+  })],
+  whileElementsMounted: autoUpdate,
+})
+</script>

package/src/components/Form/SearchableSelect.vue

@@ -10,8 +10,9 @@
       :class="{ 'sr-only': hideLabel }"
     >
       {{ label }}
+      <!-- $props needed: in generic components, vue-tsc resolves `required` to the Nuxt auto-imported function instead of the prop -->
       <span
-        v-if="required"
+        v-if="$props.required"
         class="text-new-primary"
       >*</span>
       <span

package/src/components/InfiniteLoader.vue

@@ -0,0 +1,53 @@
+<template>
+  <div ref="sentinel">
+    <slot>
+      <div class="flex items-center justify-center p-4">
+        <span class="inline-flex items-center gap-2 text-xs text-gray-medium">
+          <RiLoader4Line
+            class="size-4 animate-spin"
+            aria-hidden="true"
+          />
+          {{ t('Chargement…') }}
+        </span>
+      </div>
+    </slot>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { onMounted, onUnmounted, useTemplateRef, watch } from 'vue'
+import { RiLoader4Line } from '@remixicon/vue'
+import { useTranslation } from '../composables/useTranslation'
+
+const props = defineProps<{
+  root?: HTMLElement | null
+}>()
+
+const emit = defineEmits<{
+  intersect: []
+}>()
+
+const { t } = useTranslation()
+
+const sentinelRef = useTemplateRef<HTMLElement>('sentinel')
+let observer: IntersectionObserver | null = null
+
+function setupObserver() {
+  observer?.disconnect()
+  const el = sentinelRef.value
+  if (!el) return
+  observer = new IntersectionObserver(
+    (entries) => {
+      if (entries[0]?.isIntersecting) {
+        emit('intersect')
+      }
+    },
+    { root: props.root ?? null, rootMargin: '200px' },
+  )
+  observer.observe(el)
+}
+
+onMounted(setupObserver)
+watch([sentinelRef, () => props.root], setupObserver)
+onUnmounted(() => observer?.disconnect())
+</script>

package/src/components/ObjectCardHeader.vue

@@ -1,5 +1,8 @@
 <template>
-  <h3 class="w-full text-base flex">
+  <component
+    :is="titleTag"
+    class="w-full text-base font-bold flex"
+  >
     <AppLink
       :to="url"
       class="text-gray-title text-base bg-none flex items-center w-full truncate gap-1"
@@ -19,17 +22,21 @@
       <slot name="extra" />
       <span class="absolute inset-0" />
     </AppLink>
-  </h3>
+  </component>
 </template>
 
 <script setup lang="ts">
 import type { Component } from 'vue'
 import type { RouteLocationRaw } from 'vue-router'
+import type { TitleTag } from '../types/ui'
 import AppLink from './AppLink.vue'
 
-defineProps<{
+withDefaults(defineProps<{
   icon: Component
   url: RouteLocationRaw
   target?: string
-}>()
+  titleTag?: TitleTag
+}>(), {
+  titleTag: 'h3',
+})
 </script>

package/src/components/OpenApiViewer/ContentTypeSelect.vue

@@ -0,0 +1,48 @@
+<template>
+  <Tooltip v-if="contentTypes.length > 1">
+    <div class="relative shrink-0">
+      <select
+        :value="modelValue"
+        class="appearance-none text-xs font-mono bg-white border border-gray-default rounded pl-2 pr-6 py-1 text-gray-medium cursor-pointer hover:border-gray-400 transition-colors"
+        @change="$emit('update:modelValue', ($event.target as HTMLSelectElement).value)"
+      >
+        <option
+          v-for="ct in contentTypes"
+          :key="ct"
+          :value="ct"
+        >
+          {{ contentTypeLabel(ct) }}
+        </option>
+      </select>
+      <RiArrowDownSLine class="pointer-events-none absolute right-1 top-1/2 -translate-y-1/2 size-3.5 text-gray-medium" />
+    </div>
+    <template #tooltip>
+      {{ modelValue }}
+    </template>
+  </Tooltip>
+  <Tooltip v-else-if="contentTypes.length === 1">
+    <span
+      class="text-xs font-mono bg-white border border-gray-default rounded px-2 py-1 text-gray-medium shrink-0"
+    >
+      {{ contentTypeLabel(contentTypes[0]!) }}
+    </span>
+    <template #tooltip>
+      {{ contentTypes[0] }}
+    </template>
+  </Tooltip>
+</template>
+
+<script setup lang="ts">
+import { RiArrowDownSLine } from '@remixicon/vue'
+import Tooltip from '../Tooltip.vue'
+import { contentTypeLabel } from './openapi'
+
+defineProps<{
+  contentTypes: string[]
+  modelValue: string
+}>()
+
+defineEmits<{
+  'update:modelValue': [value: string]
+}>()
+</script>

package/src/components/OpenApiViewer/EndpointRequest.vue

@@ -0,0 +1,164 @@
+<template>
+  <div class="border border-gray-default rounded">
+    <div
+      v-if="!tabs.length"
+      class="p-3 text-xs text-gray-medium"
+    >
+      {{ t("Aucun paramètre de requête") }}
+    </div>
+    <TabGroup
+      v-else
+      size="sm"
+      @change="onTabChange"
+    >
+      <div class="bg-gray-100 px-3 py-2 border-b border-gray-default flex items-center justify-between gap-2">
+        <TabList>
+          <Tab
+            v-for="tab in tabs"
+            :key="tab.key"
+          >
+            {{ tab.label }}
+          </Tab>
+        </TabList>
+        <ContentTypeSelect
+          v-if="activeTab === 'body' && bodyContentTypes.length"
+          :content-types="bodyContentTypes"
+          :model-value="selectedBodyContentType"
+          @update:model-value="selectedBodyContentType = $event"
+        />
+      </div>
+      <TabPanels>
+        <TabPanel
+          v-for="tab in tabs"
+          :key="tab.key"
+        >
+          <div
+            v-if="tab.key === 'query'"
+            class="p-3"
+          >
+            <div class="space-y-0 divide-y divide-gray-100">
+              <div
+                v-for="param in queryParams"
+                :key="param.name"
+                class="py-2"
+              >
+                <div class="flex items-baseline gap-2">
+                  <span class="font-mono text-xs text-gray-title">
+                    {{ param.name }}
+                    <span
+                      v-if="param.required"
+                      class="text-red-600"
+                    >*</span>
+                  </span>
+                  <span class="font-mono text-xs text-gray-medium">{{ getSchemaType(endpoint.spec, param.schema) }}</span>
+                </div>
+                <p
+                  v-if="param.description"
+                  class="text-xs text-gray-medium mt-0.5 mb-0"
+                >
+                  {{ param.description }}
+                </p>
+              </div>
+            </div>
+          </div>
+          <div
+            v-if="tab.key === 'path'"
+            class="p-3"
+          >
+            <div class="space-y-0 divide-y divide-gray-100">
+              <div
+                v-for="param in pathParams"
+                :key="param.name"
+                class="py-2"
+              >
+                <div class="flex items-baseline gap-2">
+                  <span class="font-mono text-xs text-gray-title">
+                    {{ param.name }}
+                    <span class="text-red-600">*</span>
+                  </span>
+                  <span class="font-mono text-xs text-gray-medium">{{ getSchemaType(endpoint.spec, param.schema) }}</span>
+                </div>
+                <p
+                  v-if="param.description"
+                  class="text-xs text-gray-medium mt-0.5 mb-0"
+                >
+                  {{ param.description }}
+                </p>
+              </div>
+            </div>
+          </div>
+          <div
+            v-if="tab.key === 'body'"
+            class="p-3"
+          >
+            <SchemaPanel
+              v-if="currentBodyMediaType?.schema"
+              :spec="endpoint.spec"
+              :schema="currentBodyMediaType.schema"
+            />
+          </div>
+        </TabPanel>
+      </TabPanels>
+    </TabGroup>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { computed, ref, watch } from 'vue'
+import TabGroup from '../Tabs/TabGroup.vue'
+import TabList from '../Tabs/TabList.vue'
+import Tab from '../Tabs/Tab.vue'
+import TabPanels from '../Tabs/TabPanels.vue'
+import TabPanel from '../Tabs/TabPanel.vue'
+import ContentTypeSelect from './ContentTypeSelect.vue'
+import { useTranslation } from '../../composables/useTranslation'
+import SchemaPanel from './SchemaPanel.vue'
+import { getSchemaType, type Endpoint } from './openapi'
+
+const props = defineProps<{
+  endpoint: Endpoint
+}>()
+
+const { t } = useTranslation()
+
+const queryParams = computed(() => props.endpoint.parameters.filter(p => p.in === 'query'))
+const pathParams = computed(() => props.endpoint.parameters.filter(p => p.in === 'path'))
+
+const tabs = computed(() => {
+  const result: { key: string, label: string }[] = []
+  if (pathParams.value.length) {
+    result.push({ key: 'path', label: t('Path') })
+  }
+  if (queryParams.value.length) {
+    result.push({ key: 'query', label: t('Query') })
+  }
+  if (props.endpoint.requestBody) {
+    result.push({ key: 'body', label: t('Body') })
+  }
+  return result
+})
+
+const activeTabIndex = ref(0)
+const activeTab = computed(() => tabs.value[activeTabIndex.value]?.key || '')
+const selectedBodyContentType = ref('')
+
+const bodyContentTypes = computed(() => {
+  if (!props.endpoint.requestBody?.content) return []
+  return Object.keys(props.endpoint.requestBody.content)
+})
+
+const currentBodyMediaType = computed(() => {
+  if (!props.endpoint.requestBody?.content) return null
+  const ct = selectedBodyContentType.value || bodyContentTypes.value[0]
+  if (!ct) return null
+  return props.endpoint.requestBody.content[ct] || null
+})
+
+watch(bodyContentTypes, (types) => {
+  selectedBodyContentType.value = types[0] || ''
+}, { immediate: true })
+
+function onTabChange(index: number) {
+  activeTabIndex.value = index
+}
+</script>

package/src/components/OpenApiViewer/EndpointResponses.vue

@@ -0,0 +1,149 @@
+<template>
+  <div class="border border-gray-default rounded">
+    <TabGroup
+      size="sm"
+      @change="onTabChange"
+    >
+      <div class="bg-gray-100 px-3 py-2 border-b border-gray-default flex items-center gap-4">
+        <div
+          ref="tabListContainer"
+          class="overflow-x-auto flex-1 min-w-0"
+          :class="{ 'scroll-fade': canScrollRight }"
+          @scroll="onScroll"
+        >
+          <TabList>
+            <Tab
+              v-for="tab in tabs"
+              :key="tab.code"
+            >
+              <span
+                class="inline-block w-2 h-2 rounded-full mr-1.5"
+                :class="statusDotColor(tab.code)"
+              />
+              {{ tab.code }}
+            </Tab>
+          </TabList>
+        </div>
+        <ContentTypeSelect
+          v-if="currentContentTypes.length"
+          :content-types="currentContentTypes"
+          :model-value="selectedContentType"
+          @update:model-value="selectedContentType = $event"
+        />
+      </div>
+      <TabPanels>
+        <TabPanel
+          v-for="tab in tabs"
+          :key="tab.code"
+        >
+          <div class="p-3 space-y-3">
+            <p
+              v-if="tab.response.description"
+              class="text-xs text-gray-medium mb-0 pb-3 border-b border-gray-100"
+            >
+              {{ tab.response.description }}
+            </p>
+            <template v-if="currentMediaType?.schema">
+              <SchemaPanel
+                :spec="spec"
+                :schema="currentMediaType.schema"
+              />
+            </template>
+            <p
+              v-else-if="!tab.response.content"
+              class="text-xs text-gray-medium mb-0"
+            >
+              {{ t("Pas de contenu") }}
+            </p>
+          </div>
+        </TabPanel>
+      </TabPanels>
+    </TabGroup>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { computed, ref, watch, useTemplateRef, onMounted, nextTick } from 'vue'
+import TabGroup from '../Tabs/TabGroup.vue'
+import TabList from '../Tabs/TabList.vue'
+import Tab from '../Tabs/Tab.vue'
+import TabPanels from '../Tabs/TabPanels.vue'
+import TabPanel from '../Tabs/TabPanel.vue'
+import ContentTypeSelect from './ContentTypeSelect.vue'
+import { useTranslation } from '../../composables/useTranslation'
+import SchemaPanel from './SchemaPanel.vue'
+import type { OpenAPIV3 } from 'openapi-types'
+
+const props = defineProps<{
+  responses: Record<string, OpenAPIV3.ResponseObject>
+  spec: OpenAPIV3.Document
+}>()
+
+const { t } = useTranslation()
+
+const tabListContainer = useTemplateRef('tabListContainer')
+const canScrollRight = ref(false)
+
+function checkOverflow() {
+  const el = tabListContainer.value
+  if (!el) return
+  canScrollRight.value = el.scrollLeft + el.clientWidth < el.scrollWidth - 1
+}
+
+function onScroll() {
+  checkOverflow()
+}
+
+onMounted(checkOverflow)
+
+const tabs = computed(() =>
+  Object.entries(props.responses).map(([code, response]) => ({ code, response })),
+)
+
+watch(tabs, () => {
+  nextTick(checkOverflow)
+})
+
+const activeTabIndex = ref(0)
+const selectedContentType = ref('')
+
+const currentContentTypes = computed(() => {
+  const tab = tabs.value[activeTabIndex.value]
+  if (!tab?.response.content) return []
+  return Object.keys(tab.response.content)
+})
+
+const currentMediaType = computed(() => {
+  const tab = tabs.value[activeTabIndex.value]
+  if (!tab?.response.content) return null
+  const ct = selectedContentType.value || currentContentTypes.value[0]
+  if (!ct) return null
+  return tab.response.content[ct] || null
+})
+
+watch(currentContentTypes, (types) => {
+  selectedContentType.value = types[0] || ''
+}, { immediate: true })
+
+function onTabChange(index: number) {
+  activeTabIndex.value = index
+}
+
+function statusDotColor(code: string): string {
+  if (code.startsWith('2')) return 'bg-green-600'
+  if (code.startsWith('3')) return 'bg-blue-600'
+  if (code.startsWith('4')) return 'bg-orange-500'
+  if (code.startsWith('5')) return 'bg-red-600'
+  return 'bg-gray-400'
+}
+</script>
+
+<style scoped>
+.scroll-fade {
+  mask-image: linear-gradient(to right, black calc(100% - 60px), transparent);
+  mask-size: 100% 100%;
+  mask-position: center;
+  padding-block: 4px;
+  margin-block: -4px;
+}
+</style>