@datagouv/components-next 1.0.2-dev.68 → 1.0.2-dev.69

package/src/functions/tabularApi.ts

@@ -1,18 +1,147 @@
 import { ofetch } from 'ofetch'
 import { useComponentsConfig, type PluginConfig } from '../config'
+import type { GenericFilter } from '../types/visualizations'
 import type { SortConfig } from '../components/TabularExplorer/types'
 
 export type { SortConfig }
 
+export type TabularDataResponse = {
+  data: Array<Record<string, unknown>>
+  links: {
+    profile: string
+    swagger: string
+    next: string
+  }
+  meta: { total: number }
+}
+
+export type TabularAggregateType = 'avg' | 'sum' | 'count' | 'min' | 'max'
+
+export type FetchTabularDataOptions = {
+  resourceId: string
+  page?: number
+  pageSize?: number
+  columns?: Array<string> | undefined
+  sort?: SortConfig
+  groupBy?: string | undefined
+  aggregation?: {
+    column: string
+    type: TabularAggregateType
+  } | undefined
+  filters?: GenericFilter | undefined
+}
+
+export type TabularProfileResponse = {
+  profile: {
+    header: Array<string>
+    columns: Record<string, {
+      score: number
+      format: string
+      python_type: string
+    }>
+    formats: Record<string, Array<string>>
+    profile: Record<string, {
+      tops: Array<{ count: number, value: string }>
+      nb_distinct: number
+      nb_missing_values: number
+      min?: number
+      max?: number
+      std?: number
+      mean?: number
+    }>
+    encoding: string
+    separator: string
+    categorical: Array<string>
+    total_lines: number
+    nb_duplicates: number
+    columns_fields: Record<string, {
+      score: number
+      format: string
+      python_type: string
+    }>
+    columns_labels: Record<string, {
+      score: number
+      format: string
+      python_type: string
+    }>
+    header_row_idx: number
+    heading_columns: number
+    trailing_columns: number
+  }
+  deleted_at: string | null
+  dataset_id: string
+  indexes: null
+}
+
 /**
- * Call Tabular-api to get table content
+ * Call Tabular-api to get table content with options object
  */
-export async function getData(config: PluginConfig, id: string, page: number, sortConfig?: SortConfig | null) {
-  let url = `${config.tabularApiUrl}/api/resources/${id}/data/?page=${page}&page_size=${config.tabularApiPageSize || 15}`
-  if (sortConfig) {
-    url = url + `&${sortConfig.column}__sort=${sortConfig.direction}`
+export async function fetchTabularData(config: PluginConfig, options: FetchTabularDataOptions): Promise<TabularDataResponse> {
+  const page = options.page ?? 1
+  const pageSize = options.pageSize ?? config.tabularApiPageSize ?? 15
+  let url = `${config.tabularApiUrl}/api/resources/${options.resourceId}/data/?page=${page}&page_size=${pageSize}`
+  if (options.columns) {
+    url += `&columns=${options.columns.map(col => encodeURIComponent(col)).join(',')}`
+  }
+  if (options.sort) {
+    url += `&${encodeURIComponent(options.sort.column)}__sort=${encodeURIComponent(options.sort.direction)}`
   }
-  return await ofetch(url)
+  if (options.groupBy && options.aggregation?.type) {
+    url += `&${encodeURIComponent(options.groupBy)}__groupby&${encodeURIComponent(options.aggregation.column)}__${encodeURIComponent(options.aggregation.type)}`
+  }
+  if (options.filters) {
+    const filterQuery = buildFilterQuery(options.filters)
+    if (filterQuery) {
+      url += `&${filterQuery}`
+    }
+  }
+  return await ofetch<TabularDataResponse>(url)
+}
+
+function buildFilterQuery(filters: GenericFilter): string {
+  const params: Array<string> = []
+  if ('filters' in filters) {
+    for (const filter of filters.filters) {
+      if ('filters' in filter) {
+        params.push(buildFilterQuery(filter))
+      }
+      else {
+        if (filter.condition === 'is_null') {
+          params.push(`${encodeURIComponent(filter.column)}__isnull`)
+        }
+        else if (filter.condition === 'is_not_null') {
+          params.push(`${encodeURIComponent(filter.column)}__isnotnull`)
+        }
+        else if (filter.value !== null && filter.value !== undefined && filter.value !== '') {
+          params.push(`${encodeURIComponent(filter.column)}__${encodeURIComponent(filter.condition)}=${encodeURIComponent(filter.value)}`)
+        }
+      }
+    }
+  }
+  else {
+    const filter = filters
+    if (filter.condition === 'is_null') {
+      params.push(`${encodeURIComponent(filter.column)}__isnull`)
+    }
+    else if (filter.condition === 'is_not_null') {
+      params.push(`${encodeURIComponent(filter.column)}__isnotnull`)
+    }
+    else if (filter.value !== null && filter.value !== undefined && filter.value !== '') {
+      params.push(`${encodeURIComponent(filter.column)}__${encodeURIComponent(filter.condition)}=${encodeURIComponent(filter.value)}`)
+    }
+  }
+  return params.join('&')
+}
+
+/**
+ * Call Tabular-api to get table content
+ */
+export async function getData(config: PluginConfig, id: string, page: number, sortConfig?: SortConfig | null): Promise<TabularDataResponse> {
+  return fetchTabularData(config, {
+    resourceId: id,
+    page,
+    sort: sortConfig ?? undefined,
+  })
 }
 
 /**
@@ -20,5 +149,5 @@ export async function getData(config: PluginConfig, id: string, page: number, so
  */
 export function useGetProfile() {
   const config = useComponentsConfig()
-  return (id: string) => ofetch(`${config.tabularApiUrl}/api/resources/${id}/profile/`)
+  return (id: string) => ofetch<TabularProfileResponse>(`${config.tabularApiUrl}/api/resources/${id}/profile/`)
 }

package/src/main.ts

@@ -23,6 +23,7 @@ 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 { 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'
@@ -82,6 +83,8 @@ 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'
@@ -96,6 +99,7 @@ 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'
@@ -104,6 +108,7 @@ 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'
@@ -125,6 +130,8 @@ 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 {
@@ -235,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 {
@@ -321,6 +345,8 @@ export {
   SchemaCard,
   SimpleBanner,
   SmallChart,
+  ChartViewer,
+  ChartViewerWrapper,
   StatBox,
   OpenApiViewer,
   Tab,
@@ -337,6 +363,7 @@ export {
   SearchInput,
   SearchableSelect,
   SelectGroup,
+  Listbox,
   InfiniteLoader,
   TabularExplorer,
 }

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
+}