@datagouv/components-next 1.0.2-dev.7 → 1.0.2-dev.71

package/src/main.ts

@@ -13,7 +13,7 @@ import type { License } from './types/licenses'
 import type { Member, MemberRole, NewOrganization, Organization, OrganizationOrSuggest, OrganizationReference, OrganizationSuggest } from './types/organizations'
 import type { Owned, OwnedWithFullObject, OwnedWithId } from './types/owned'
 import type { Comment, Thread } from './types/discussions'
-import type { Page, PageBloc, ContentBloc, BlocWithTitle, DatasetsListBloc, DataservicesListBloc, ReusesListBloc, LinkInBloc, LinksListBloc, MarkdownBloc, AccordionItemBloc, AccordionListBloc, HeroBloc } from './types/pages'
+import type { PageBloc, ContentBloc, BlocWithTitle, DatasetsListBloc, DataservicesListBloc, ReusesListBloc, LinkInBloc, LinksListBloc, MarkdownBloc, AccordionItemBloc, AccordionListBloc, HeroBloc } from './types/pages'
 import type { Post } from './types/posts'
 import type { ReuseReference, NewReuse, Reuse, ReuseTopic, ReuseType } from './types/reuses'
 import type { RegisteredSchema, Schema, SchemaDetails, SchemaField, SchemaPath, SchemaPublicationMode, SchemaResponseData, SchemaVersion, ValidataError } from './types/schemas'
@@ -23,8 +23,11 @@ import type { Site } from './types/site'
 import type { Weight, WellType } from './types/ui'
 import type { User, UserReference } from './types/users'
 import type { Report, ReportSubject, ReportReason } from './types/reports'
-import type { GlobalSearchConfig, SearchType, SortOption } from './types/search'
-import { getDefaultDatasetConfig, getDefaultDataserviceConfig, getDefaultReuseConfig, getDefaultOrganizationConfig, getDefaultGlobalSearchConfig, defaultDatasetSortOptions, defaultDataserviceSortOptions, defaultReuseSortOptions, defaultOrganizationSortOptions } from './types/search'
+import type { Chart, ChartForm, ChartForApi, FilterCondition, Filter, AndFilters, GenericFilter, XAxisType, XAxisSortBy, SortDirection, XAxis, XAxisForm, UnitPosition, YAxis, DataSeriesType, DataSeries, DataSeriesForm } from './types/visualizations'
+import type { GlobalSearchConfig, SearchType, SearchTypeConfig, SortOption, HiddenFilter, BuiltInFilterKey, DatasetSearchConfig, DatasetSearchFilters, DataserviceSearchConfig, DataserviceSearchFilters, ReuseSearchConfig, ReuseSearchFilters, OrganizationSearchConfig, OrganizationSearchFilters, TopicSearchConfig, TopicSearchFilters } from './types/search'
+import { getDefaultDatasetConfig, getDefaultDataserviceConfig, getDefaultReuseConfig, getDefaultOrganizationConfig, getDefaultTopicConfig, getDefaultGlobalSearchConfig, defaultDatasetSortOptions, defaultDataserviceSortOptions, defaultReuseSortOptions, defaultOrganizationSortOptions } from './types/search'
+import { useSearchFilter } from './composables/useSearchFilter'
+import type { UseSearchFilterOptions } from './composables/useSearchFilter'
 
 import ActivityList from './components/ActivityList/ActivityList.vue'
 import UserActivityList from './components/ActivityList/UserActivityList.vue'
@@ -73,13 +76,15 @@ import ResourceIcon from './components/ResourceAccordion/ResourceIcon.vue'
 import ResourceExplorer from './components/ResourceExplorer/ResourceExplorer.vue'
 import ResourceExplorerSidebar from './components/ResourceExplorer/ResourceExplorerSidebar.vue'
 import ResourceExplorerViewer from './components/ResourceExplorer/ResourceExplorerViewer.vue'
-import Swagger from './components/ResourceAccordion/Swagger.client.vue'
+import OpenApiViewer from './components/OpenApiViewer/OpenApiViewer.vue'
 import ReuseCard from './components/ReuseCard.vue'
 import ReuseHorizontalCard from './components/ReuseHorizontalCard.vue'
 import ReuseDetails from './components/ReuseDetails.vue'
 import SchemaCard from './components/SchemaCard.vue'
 import SimpleBanner from './components/SimpleBanner.vue'
 import SmallChart from './components/SmallChart.vue'
+import ChartViewer from './components/Chart/ChartViewer.vue'
+import ChartViewerWrapper from './components/Chart/ChartViewerWrapper.vue'
 import StatBox from './components/StatBox.vue'
 import Tab from './components/Tabs/Tab.vue'
 import TabGroup from './components/Tabs/TabGroup.vue'
@@ -94,12 +99,16 @@ import GlobalSearch from './components/Search/GlobalSearch.vue'
 import SearchInput from './components/Search/SearchInput.vue'
 import SearchableSelect from './components/Form/SearchableSelect.vue'
 import SelectGroup from './components/Form/SelectGroup.vue'
+import Listbox from './components/Form/Listbox.vue'
+import InfiniteLoader from './components/InfiniteLoader.vue'
+import TabularExplorer from './components/TabularExplorer/TabularExplorer.vue'
 import type { UseFetchFunction } from './functions/api.types'
 import { configKey, useComponentsConfig, type PluginConfig } from './config.js'
 
 export { Toaster, toast } from 'vue-sonner'
 
 export * from './composables/useActiveDescendant'
+export * from './composables/useDebouncedRef'
 export * from './composables/useMetrics'
 export * from './composables/useReuseType'
 export * from './composables/useTranslation'
@@ -116,17 +125,33 @@ export * from './functions/metrics'
 export * from './functions/never'
 export * from './functions/organizations'
 export * from './functions/owned'
-export * from './functions/pagination'
 export * from './functions/resources'
 export * from './functions/reuses'
 export * from './functions/schemas'
+export * from './functions/tabular'
 export * from './functions/users'
+export * from './functions/tabularApi'
+export * from './functions/charts'
 export * from './types/access_types'
 
 export type {
   GlobalSearchConfig,
   SearchType,
+  SearchTypeConfig,
   SortOption,
+  HiddenFilter,
+  BuiltInFilterKey,
+  DatasetSearchConfig,
+  DatasetSearchFilters,
+  DataserviceSearchConfig,
+  DataserviceSearchFilters,
+  ReuseSearchConfig,
+  ReuseSearchFilters,
+  OrganizationSearchConfig,
+  OrganizationSearchFilters,
+  TopicSearchConfig,
+  TopicSearchFilters,
+  UseSearchFilterOptions,
   UseFetchFunction,
   AccessType,
   AccessAudience,
@@ -168,7 +193,6 @@ export type {
   Owned,
   OwnedWithFullObject,
   OwnedWithId,
-  Page,
   PageBloc,
   ContentBloc,
   BlocWithTitle,
@@ -218,6 +242,23 @@ export type {
   ValidataError,
   Weight,
   WellType,
+  Chart,
+  ChartForm,
+  ChartForApi,
+  FilterCondition,
+  Filter,
+  AndFilters,
+  GenericFilter,
+  XAxisType,
+  XAxisSortBy,
+  SortDirection,
+  XAxis,
+  XAxisForm,
+  UnitPosition,
+  YAxis,
+  DataSeriesType,
+  DataSeries,
+  DataSeriesForm,
 }
 
 export {
@@ -225,11 +266,13 @@ export {
   getDefaultDataserviceConfig,
   getDefaultReuseConfig,
   getDefaultOrganizationConfig,
+  getDefaultTopicConfig,
   getDefaultGlobalSearchConfig,
   defaultDatasetSortOptions,
   defaultDataserviceSortOptions,
   defaultReuseSortOptions,
   defaultOrganizationSortOptions,
+  useSearchFilter,
 }
 
 // Vue Plugin
@@ -302,8 +345,10 @@ export {
   SchemaCard,
   SimpleBanner,
   SmallChart,
+  ChartViewer,
+  ChartViewerWrapper,
   StatBox,
-  Swagger,
+  OpenApiViewer,
   Tab,
   TabGroup,
   TabList,
@@ -318,4 +363,7 @@ export {
   SearchInput,
   SearchableSelect,
   SelectGroup,
+  Listbox,
+  InfiniteLoader,
+  TabularExplorer,
 }

package/src/types/dataservices.ts

@@ -24,6 +24,7 @@ export type BaseDataservice = Owned & WithAccessType & {
   license: string | null
   private: boolean
   rate_limiting: string
+  rate_limiting_url: string | null
   title: DataserviceReference['title']
   contact_points: Array<ContactPoint>
 }
@@ -65,6 +66,7 @@ export type Dataservice = Owned & WithAccessType & {
   permissions: { edit: boolean, delete: boolean }
   private: boolean
   rate_limiting: string
+  rate_limiting_url: string | null
   self_api_url: DataserviceReference['self_api_url']
   self_web_url: DataserviceReference['self_web_url']
   slug: string

package/src/types/pages.ts

@@ -2,11 +2,6 @@ import type { DatasetV2 } from './datasets'
 import type { Dataservice } from './dataservices'
 import type { Reuse } from './reuses'
 
-export type Page = {
-  id: string
-  blocs: Array<PageBloc>
-}
-
 export type BlocWithTitle = {
   title: string
   subtitle: string | null

package/src/types/posts.ts

@@ -1,12 +1,12 @@
 import type { Dataset } from './datasets'
-import type { Page } from './pages'
+import type { PageBloc } from './pages'
 import type { Reuse } from './reuses'
 import type { User } from './users'
 
 export type Post = {
   body_type: 'markdown' | 'html' | 'blocs'
+  blocs: Array<PageBloc>
   content: string
-  content_as_page: Page | null
   created_at: string
   credit_to: string
   credit_url: string

package/src/types/reports.ts

@@ -16,11 +16,14 @@ export type Report = {
   id: string
   by: User | null
   subject: ReportSubject | null
+  subject_embed_id: string | null
   reason: ReportReasonValue
   message: string
   reported_at: string
   self_api_url: string
   subject_deleted_at: string | null
+  subject_deleted_by: User | null
+  subject_label: string | null
   dismissed_at: string | null
   dismissed_by: User | null
 }

package/src/types/search.ts

@@ -1,5 +1,10 @@
 import type { PaginatedArray } from './api'
 import type { AccessType } from './access_types'
+import type { Dataset } from './datasets'
+import type { Dataservice } from './dataservices'
+import type { Organization } from './organizations'
+import type { Reuse } from './reuses'
+import type { TopicV2 } from './topics'
 import type {
   CERTIFIED,
   PUBLIC_SERVICE,
@@ -291,7 +296,9 @@ export type SortOption<Sort extends string> = {
 
 export type DatasetSearchConfig = {
   class: 'datasets'
+  key?: string
   name?: string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<DatasetSearchFilters>[]
   basicFilters?: (keyof DatasetSearchFilters)[]
   advancedFilters?: (keyof DatasetSearchFilters)[]
@@ -300,7 +307,9 @@ export type DatasetSearchConfig = {
 
 export type DataserviceSearchConfig = {
   class: 'dataservices'
+  key?: string
   name?: string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<DataserviceSearchFilters>[]
   basicFilters?: (keyof DataserviceSearchFilters)[]
   advancedFilters?: (keyof DataserviceSearchFilters)[]
@@ -309,7 +318,9 @@ export type DataserviceSearchConfig = {
 
 export type ReuseSearchConfig = {
   class: 'reuses'
+  key?: string
   name?: string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<ReuseSearchFilters>[]
   basicFilters?: (keyof ReuseSearchFilters)[]
   advancedFilters?: (keyof ReuseSearchFilters)[]
@@ -318,19 +329,43 @@ export type ReuseSearchConfig = {
 
 export type OrganizationSearchConfig = {
   class: 'organizations'
+  key?: string
   name?: string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<OrganizationSearchFilters>[]
   basicFilters?: (keyof OrganizationSearchFilters)[]
   advancedFilters?: (keyof OrganizationSearchFilters)[]
   sortOptions?: SortOption<OrganizationSearchSort>[]
 }
 
-export type SearchTypeConfig = DatasetSearchConfig | DataserviceSearchConfig | ReuseSearchConfig | OrganizationSearchConfig
+export type TopicSearchConfig = {
+  class: 'topics'
+  key?: string
+  name?: string
+  placeholder?: string | null
+  hiddenFilters?: HiddenFilter<TopicSearchFilters>[]
+  basicFilters?: (keyof TopicSearchFilters)[]
+  advancedFilters?: (keyof TopicSearchFilters)[]
+  sortOptions?: SortOption<TopicSearchSort>[]
+}
+
+export type SearchTypeConfig = DatasetSearchConfig | DataserviceSearchConfig | ReuseSearchConfig | OrganizationSearchConfig | TopicSearchConfig
+
+export type BuiltInFilterKey = keyof DatasetSearchFilters | keyof DataserviceSearchFilters | keyof ReuseSearchFilters | keyof OrganizationSearchFilters | keyof TopicSearchFilters
 
 export type SearchType = SearchTypeConfig['class']
 
 export type GlobalSearchConfig = SearchTypeConfig[]
 
+// Maps each search class to its concrete response shape.
+export type SearchResponseByClass = {
+  datasets: DatasetSearchResponse<Dataset>
+  dataservices: DataserviceSearchResponse<Dataservice>
+  reuses: ReuseSearchResponse<Reuse>
+  organizations: OrganizationSearchResponse<Organization>
+  topics: TopicSearchResponse<TopicV2>
+}
+
 // Helper functions for default configs
 
 export const defaultDatasetSortOptions: SortOption<DatasetSearchSort>[] = [
@@ -397,11 +432,27 @@ export function getDefaultOrganizationConfig(overrides?: Partial<Omit<Organizati
   }
 }
 
+export const defaultTopicSortOptions: SortOption<TopicSearchSort>[] = [
+  { value: '-created', label: 'Date de création' },
+  { value: '-last_modified', label: 'Dernière mise à jour' },
+]
+
+export function getDefaultTopicConfig(overrides?: Partial<Omit<TopicSearchConfig, 'class'>>): TopicSearchConfig {
+  return {
+    class: 'topics',
+    basicFilters: ['last_update_range', 'producer_type'],
+    advancedFilters: ['organization', 'tag'],
+    sortOptions: defaultTopicSortOptions,
+    ...overrides,
+  }
+}
+
 export function getDefaultGlobalSearchConfig(): GlobalSearchConfig {
   return [
     getDefaultDatasetConfig(),
     getDefaultDataserviceConfig(),
     getDefaultReuseConfig(),
     getDefaultOrganizationConfig(),
+    getDefaultTopicConfig(),
   ]
 }

package/src/types/site.ts

@@ -1,9 +1,11 @@
+import type { PageBloc } from './pages'
+
 export type Site = {
   id: string
   title: string
-  datasets_page: string | null
-  reuses_page: string | null
-  dataservices_page: string | null
+  datasets_blocs: Array<PageBloc>
+  reuses_blocs: Array<PageBloc>
+  dataservices_blocs: Array<PageBloc>
   version: string
   metrics: {
     'dataservices': number

package/src/types/users.ts

@@ -21,7 +21,6 @@ export type User = {
   page: UserReference['page']
   avatar: UserReference['avatar']
   avatar_thumbnail: UserReference['avatar_thumbnail']
-  apikey?: string
   email?: string
   about: string
   website?: string

package/src/types/visualizations.ts

@@ -0,0 +1,89 @@
+import type { TabularAggregateType } from '../functions/tabularApi'
+import type { Owned, OwnedWithId } from './owned'
+
+export type FilterCondition = 'exact' | 'differs' | 'is_null' | 'is_not_null' | 'greater' | 'less' | 'strictly_greater' | 'strictly_less'
+export type Filter = {
+  _cls: 'Filter'
+  column: string
+  condition: FilterCondition
+  value: string | null
+}
+
+export type AndFilters = {
+  _cls: 'AndFilters'
+  filters: Array<Filter | AndFilters>
+}
+
+export type GenericFilter = Filter | AndFilters
+
+export type XAxisType = 'discrete' | 'continuous'
+
+export type XAxisSortBy = 'axis_x' | 'axis_y'
+
+export type SortDirection = 'asc' | 'desc'
+
+export type XAxis = {
+  column_x: string
+  sort_x_by: XAxisSortBy | null
+  sort_x_direction: SortDirection | null
+  type: XAxisType
+}
+
+export type CombinedSort = '' | 'axis_x-asc' | 'axis_x-desc' | 'axis_y-asc' | 'axis_y-desc'
+
+export type XAxisForm = Omit<XAxis, 'sort_x_by' | 'sort_x_direction'> & { sort_combined: CombinedSort }
+
+export type UnitPosition = 'prefix' | 'suffix'
+
+export type YAxis = {
+  min: number | null
+  max: number | null
+  label: string | null
+  unit: string | null
+  unit_position: UnitPosition | null
+}
+
+export type DataSeriesType = 'line' | 'histogram'
+
+export type DataSeries = {
+  type: DataSeriesType
+  column_y: string
+  aggregate_y: TabularAggregateType | null
+  resource_id: string
+  column_x_name_override: string | null
+  filters: GenericFilter | null
+}
+
+// Type for form where aggregate_y can be empty string for select binding
+export type DataSeriesForm = Omit<DataSeries, 'aggregate_y'> & { aggregate_y: TabularAggregateType | '' | null }
+
+export type Chart = Owned & {
+  id: string
+  title: string
+  slug: string
+  description: string
+  private: boolean
+  created_at: string
+  last_modified: string
+  deleted_at: string | null
+  uri: string
+  page: string
+  x_axis: XAxis
+  y_axis: YAxis
+  series: Array<DataSeries>
+  extras: Record<string, unknown>
+  permissions: { delete: boolean, edit: boolean, read: boolean }
+  metrics: {
+    views: number
+  }
+}
+
+export type ChartForApi = OwnedWithId & Pick<Chart, 'title' | 'description' | 'private' | 'x_axis' | 'y_axis' | 'series' | 'extras'>
+
+export type ChartForm = Omit<ChartForApi, 'x_axis' | 'series' | 'owner' | 'organization'> & {
+  owned: OwnedWithId
+  x_axis: XAxisForm
+  series: Array<DataSeriesForm>
+  chart_type?: DataSeriesType | null
+  filter: GenericFilter | null
+}