@datagouv/components-next 1.0.2-dev.19 → 1.0.2-dev.190

package/src/types/organizations.ts

@@ -1,5 +1,6 @@
 import type { User } from './users'
 import type { Badges } from './badges'
+import type { PageBloc } from './pages'
 
 export type MemberRole = 'admin' | 'editor' | 'partial_editor'
 
@@ -68,4 +69,13 @@ export type Organization = {
     reuses_by_months: Record<string, number>
     views: number
   }
+  // Editorial blocs powering the organization "Présentation" tab. Excluded from
+  // the default API read mask, so only present when requested with X-Fields.
+  // Read through the API's `public_presentation_blocs`: hidden from the public until
+  // published, but always returned to organization administrators.
+  presentation_blocs?: Array<PageBloc>
+  // Publication date of the blocs. `null` means draft (never public); a set date
+  // means published. Like `presentation_blocs`, only present when requested with
+  // X-Fields.
+  presentation_blocs_published_at?: string | null
 }

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

@@ -1,7 +1,7 @@
 import type { User } from './users'
 
 export type ReportSubject = {
-  class: 'Discussion' | 'Dataservice' | 'Dataset' | 'Organization' | 'Reuse'
+  class: 'Discussion' | 'Dataservice' | 'Dataset' | 'Organization' | 'Reuse' | 'User'
   id: string
 }
 
@@ -16,11 +16,15 @@ 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
+  callbacks_count: number
 }

package/src/types/resources.ts

@@ -46,7 +46,6 @@ export type OgcLayerInfo = { name: string, default_crs: string | null }
 
 export type WfsMetadata = {
   format: string
-  layers: Array<OgcLayerInfo>
   version: string
   detected_layer: OgcLayerInfo | null
   output_formats: Array<string>

package/src/types/reuses.ts

@@ -1,5 +1,5 @@
 import type { Owned, OwnedWithId } from './owned'
-import type { Dataset } from './datasets'
+import type { Dataset, Rel } from './datasets'
 import type { Badges } from './badges'
 import type { Dataservice } from './dataservices'
 
@@ -51,6 +51,17 @@ export type Reuse = BaseReuse & {
   permissions: { edit: boolean, delete: boolean }
 }
 
+/**
+ * Lightweight reuse returned by the listing endpoints (`/api/2/reuses/` and
+ * `/api/2/reuses/search/`): the `datasets` and `dataservices` reference lists
+ * are replaced by links to their respective listing endpoints filtered on this
+ * reuse, so that listing reuses does not dereference every linked dataset.
+ */
+export type ReuseV2 = Owned & Omit<Reuse, 'datasets' | 'dataservices'> & {
+  datasets: Rel
+  dataservices: Rel
+}
+
 export type ReuseType = {
   id: string
   label: string

package/src/types/search.ts

@@ -1,5 +1,11 @@
+import type { Component } from 'vue'
 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 { ReuseV2 } from './reuses'
+import type { TopicV2 } from './topics'
 import type {
   CERTIFIED,
   PUBLIC_SERVICE,
@@ -291,46 +297,86 @@ export type SortOption<Sort extends string> = {
 
 export type DatasetSearchConfig = {
   class: 'datasets'
+  key?: string
   name?: string
+  icon?: Component | string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<DatasetSearchFilters>[]
   basicFilters?: (keyof DatasetSearchFilters)[]
   advancedFilters?: (keyof DatasetSearchFilters)[]
   sortOptions?: SortOption<DatasetSearchSort>[]
+  defaultSort?: DatasetSearchSort
 }
 
 export type DataserviceSearchConfig = {
   class: 'dataservices'
+  key?: string
   name?: string
+  icon?: Component | string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<DataserviceSearchFilters>[]
   basicFilters?: (keyof DataserviceSearchFilters)[]
   advancedFilters?: (keyof DataserviceSearchFilters)[]
   sortOptions?: SortOption<DataserviceSearchSort>[]
+  defaultSort?: DataserviceSearchSort
 }
 
 export type ReuseSearchConfig = {
   class: 'reuses'
+  key?: string
   name?: string
+  icon?: Component | string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<ReuseSearchFilters>[]
   basicFilters?: (keyof ReuseSearchFilters)[]
   advancedFilters?: (keyof ReuseSearchFilters)[]
   sortOptions?: SortOption<ReuseSearchSort>[]
+  defaultSort?: ReuseSearchSort
 }
 
 export type OrganizationSearchConfig = {
   class: 'organizations'
+  key?: string
   name?: string
+  icon?: Component | string
+  placeholder?: string | null
   hiddenFilters?: HiddenFilter<OrganizationSearchFilters>[]
   basicFilters?: (keyof OrganizationSearchFilters)[]
   advancedFilters?: (keyof OrganizationSearchFilters)[]
   sortOptions?: SortOption<OrganizationSearchSort>[]
+  defaultSort?: OrganizationSearchSort
 }
 
-export type SearchTypeConfig = DatasetSearchConfig | DataserviceSearchConfig | ReuseSearchConfig | OrganizationSearchConfig
+export type TopicSearchConfig = {
+  class: 'topics'
+  key?: string
+  name?: string
+  icon?: Component | string
+  placeholder?: string | null
+  hiddenFilters?: HiddenFilter<TopicSearchFilters>[]
+  basicFilters?: (keyof TopicSearchFilters)[]
+  advancedFilters?: (keyof TopicSearchFilters)[]
+  sortOptions?: SortOption<TopicSearchSort>[]
+  defaultSort?: 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<ReuseV2>
+  organizations: OrganizationSearchResponse<Organization>
+  topics: TopicSearchResponse<TopicV2>
+}
+
 // Helper functions for default configs
 
 export const defaultDatasetSortOptions: SortOption<DatasetSearchSort>[] = [
@@ -397,11 +443,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/ui.ts

@@ -1,3 +1,5 @@
 export type WellType = 'primary' | 'secondary'
 
 export type Weight = 'light' | 'regular' | 'semi-bold' | 'bold' | 'heavy'
+
+export type TitleTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p'

package/src/types/users.ts

@@ -21,13 +21,14 @@ export type User = {
   page: UserReference['page']
   avatar: UserReference['avatar']
   avatar_thumbnail: UserReference['avatar_thumbnail']
-  apikey?: string
   email?: string
   about: string
   website?: string
   roles?: Array<string>
   organizations: Array<OrganizationReference>
   last_login_at: string | null
+  password_rotation_demanded: string | null
+  password_rotation_performed: string | null
   since: string | null
   metrics: {
     datasets: number

package/src/types/visualizations.ts

@@ -0,0 +1,93 @@
+import type { TabularAggregateType } from '../functions/tabularApi'
+import type { Owned, OwnedWithId } from './owned'
+import type { ColumnType } from '../components/TabularExplorer/types'
+
+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
+}
+
+export type ColumnDefinition = { name: string, type: ColumnType, min?: number, max?: number }
+export type ColumnsDefinition = Record<string, Array<ColumnDefinition>>