@datagouv/components-next 0.2.0 → 1.0.0

package/src/types/datasets.ts

@@ -23,9 +23,18 @@ export type Quality = {
   update_fulfilled_in_time: boolean
 }
 
-export type BaseDataset = Owned & WithAccessType & {
-  title: string
+export type DatasetReference = {
+  class: 'Dataset'
+  id: string
   acronym: string
+  page: string
+  title: string
+  uri: string
+}
+
+export type BaseDataset = Owned & WithAccessType & {
+  title: DatasetReference['title']
+  acronym: DatasetReference['acronym']
   archived: boolean
   description: string
   description_short: string
@@ -58,10 +67,10 @@ export type Rel = {
 }
 
 export type Dataset = BaseDataset & {
-  id: string
+  id: DatasetReference['id']
   badges: Badges
   deleted: string | null
-  page: string
+  page: DatasetReference['page']
   resources: Array<Resource>
   community_resources: Array<Resource>
   created_at: string
@@ -71,7 +80,7 @@ export type Dataset = BaseDataset & {
     created_at_internal: string
     last_modified_internal: string
   }
-  uri: string
+  uri: DatasetReference['uri']
   slug: string
   quality: Quality
   metrics: {
@@ -94,9 +103,13 @@ export type DatasetV2 = Owned & Omit<Dataset, 'resources' | 'community_resources
   community_resources: Rel
 }
 
+/**
+ * Dataset with fully populated nested objects (license, frequency, spatial).
+ * Retrieve this version by adding the header `X-Get-Datasets-Full-Objects: True` to the request: GET /api/2/datasets/{id}/
+ */
 export type DatasetV2WithFullObject = Owned & Omit<DatasetV2, 'license' | 'frequency' | 'spatial'> & {
-  license: License
-  frequency: Frequency
+  license: License | null
+  frequency: Frequency | null
   spatial: {
     zones?: Array<SpatialZone>
     granularity?: Granularity

package/src/types/discussions.ts

@@ -0,0 +1,20 @@
+import type { OrganizationReference } from './organizations'
+import type { UserReference } from './users'
+
+export type Comment = {
+  content: string
+  posted_by: UserReference
+  posted_on: string
+  posted_by_organization: OrganizationReference | null
+  last_modified_at?: string | null
+}
+
+export interface Thread {
+  id: string
+  title: string
+  user: UserReference
+  organization: OrganizationReference | null
+  created: string
+  discussion: Array<Comment>
+  self_web_url?: string
+}

package/src/types/licenses.ts

@@ -1,9 +1,9 @@
 export type License = {
-  alternate_titles: Array<string>
-  alternate_urls: Array<string>
+  alternate_titles: Array<string> | null
+  alternate_urls: Array<string> | null
   flags: Array<string>
   id: string
   maintainer: string | null
   title: string
-  url: string
+  url: string | null
 }

package/src/types/organizations.ts

@@ -24,6 +24,7 @@ export type NewOrganization = {
 }
 
 export type OrganizationReference = {
+  class: 'Organization'
   id: string
   name: string
   acronym: string | null
@@ -33,9 +34,20 @@ export type OrganizationReference = {
   logo: string
   logo_thumbnail: string
   badges: Badges
+  permissions: { delete: boolean, edit: boolean, harvest: boolean, members: boolean, private: boolean }
 }
 
-export type Organization = OrganizationReference & {
+export type Organization = {
+  id: OrganizationReference['id']
+  name: OrganizationReference['name']
+  acronym: OrganizationReference['acronym']
+  slug: OrganizationReference['slug']
+  uri: OrganizationReference['uri']
+  page: OrganizationReference['page']
+  logo: OrganizationReference['logo']
+  logo_thumbnail: OrganizationReference['logo_thumbnail']
+  badges: OrganizationReference['badges']
+  permissions: OrganizationReference['permissions']
   url: string // URL of the org website
   description: string
   business_number_id: string

package/src/types/owned.ts

@@ -1,5 +1,5 @@
-import type { OrganizationReference } from './organizations'
-import type { UserReference } from './users'
+import type { Organization, OrganizationReference } from './organizations'
+import type { User, UserReference } from './users'
 
 /**
  * A resource, dataset, reuse or any other object owned by an organization or a user.
@@ -7,3 +7,5 @@ import type { UserReference } from './users'
 export type Owned = { organization: OrganizationReference, owner: never | null } | { organization: never | null, owner: UserReference }
 
 export type OwnedWithId = { organization: string, owner: never | null } | { organization: never | null, owner: string }
+
+export type OwnedWithFullObject = { organization: Organization, owner: never | null } | { organization: never | null, owner: User }

package/src/types/pages.ts

@@ -0,0 +1,70 @@
+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
+}
+
+export type DatasetsListBloc = {
+  class: 'DatasetsListBloc'
+  datasets: Array<DatasetV2>
+} & BlocWithTitle & { id: string }
+export type DataservicesListBloc = {
+  class: 'DataservicesListBloc'
+  dataservices: Array<Dataservice>
+} & BlocWithTitle & { id: string }
+export type ReusesListBloc = {
+  class: 'ReusesListBloc'
+  reuses: Array<Reuse>
+} & BlocWithTitle & { id: string }
+
+export type LinkInBloc = {
+  title: string
+  url: string
+  color: string | null
+}
+
+export type LinksListBloc = {
+  class: 'LinksListBloc'
+  paragraph: string | null
+  main_link_title: string | null
+  main_link_url: string | null
+  links: Array<LinkInBloc>
+} & BlocWithTitle & { id: string }
+
+export type MarkdownBloc = {
+  class: 'MarkdownBloc'
+  content: string
+} & BlocWithTitle & { id: string }
+
+export type ContentBloc = DatasetsListBloc | DataservicesListBloc | ReusesListBloc | LinksListBloc | MarkdownBloc
+
+export type AccordionItemBloc = {
+  title: string
+  content: Array<ContentBloc>
+}
+
+export type AccordionListBloc = {
+  class: 'AccordionListBloc'
+  title: string | null
+  description: string | null
+  items: Array<AccordionItemBloc>
+} & { id: string }
+
+export type HeroBloc = {
+  class: 'HeroBloc'
+  title: string
+  description: string | null
+  color: 'primary' | 'green' | 'purple'
+  main_link_title: string | null
+  main_link_url: string | null
+} & { id: string }
+
+export type PageBloc = ContentBloc | AccordionListBloc | HeroBloc

package/src/types/posts.ts

@@ -0,0 +1,27 @@
+import type { Dataset } from './datasets'
+import type { Page } from './pages'
+import type { Reuse } from './reuses'
+import type { User } from './users'
+
+export type Post = {
+  body_type: 'markdown' | 'html' | 'blocs'
+  content: string
+  content_as_page: Page | null
+  created_at: string
+  credit_to: string
+  credit_url: string
+  datasets: Array<Pick<Dataset, 'acronym' | 'id' | 'page' | 'title' | 'uri'>>
+  headline: string
+  id: string
+  image: string | null
+  kind: 'news' | 'page'
+  last_modified: string
+  name: string
+  owner: User
+  page: string
+  published: string | null
+  reuses: Array<Pick<Reuse, 'id' | 'image' | 'image_thumbnail' | 'page' | 'title' | 'uri'>>
+  slug: string
+  tags: Array<string>
+  url: string
+}

package/src/types/resources.ts

@@ -35,3 +35,9 @@ export type Resource = {
 }
 
 export type CommunityResource = Owned & Resource & { dataset: Omit<Dataset, 'resources' | 'community_resources'>, permissions: { edit: boolean, delete: boolean } }
+
+export interface ResourceGroup {
+  type: ResourceType
+  total: number
+  items: Resource[]
+}

package/src/types/reuses.ts

@@ -3,8 +3,17 @@ import type { Dataset } from './datasets'
 import type { Badges } from './badges'
 import type { Dataservice } from './dataservices'
 
-export type BaseReuse = Owned & {
+export type ReuseReference = {
+  class: 'Reuse'
+  id: string
   title: string
+  image: string | null
+  uri: string
+  page: string
+}
+
+export type BaseReuse = Owned & {
+  title: ReuseReference['title']
   description: string
   tags: Array<string> | null
   datasets: Array<Dataset | string>
@@ -25,8 +34,8 @@ export type Reuse = BaseReuse & {
   deleted: string | null
   extras: Record<string, unknown>
   featured: boolean
-  id: string
-  image: string | null
+  id: ReuseReference['id']
+  image: ReuseReference['image']
   image_thumbnail: string | null
   last_modified: string
   metrics: {
@@ -37,8 +46,8 @@ export type Reuse = BaseReuse & {
     views: number
   }
   slug: string
-  page: string
-  uri: string
+  page: ReuseReference['page']
+  uri: ReuseReference['uri']
   permissions: { edit: boolean, delete: boolean }
 }
 

package/src/types/search.ts

@@ -0,0 +1,379 @@
+import type { PaginatedArray } from './api'
+import type { AccessType } from './access_types'
+import type {
+  CERTIFIED,
+  PUBLIC_SERVICE,
+  ASSOCIATION,
+  COMPANY,
+  LOCAL_AUTHORITY,
+  USER,
+  OrganizationTypes } from '../functions/organizations'
+
+// Common types
+
+export type LastUpdateRange = 'last_30_days' | 'last_12_months' | 'last_3_years'
+
+export type ProducerType = Exclude<OrganizationTypes, 'other'> | typeof USER | 'not-specified'
+
+export type OrganizationBadgeFilter = typeof CERTIFIED | typeof PUBLIC_SERVICE | typeof ASSOCIATION | typeof COMPANY | typeof LOCAL_AUTHORITY
+
+// Base query params (common to all searches)
+
+export type BaseSearchQueryParams<Sort extends string> = {
+  q?: string
+  sort?: Sort
+  page?: number
+  page_size?: number
+}
+
+// Facet types
+
+export type FacetItem = {
+  count: number
+  name: string
+}
+
+// Dataset Search
+
+export type DatasetBadgeFilter = 'pivotal-data' | 'spd' | 'inspire' | 'hvd' | 'sl' | 'sr'
+
+export type DatasetFormatFamily = 'tabular' | 'machine_readable' | 'geographical' | 'documents' | 'other'
+
+export type DatasetAccessTypeFilter = AccessType | 'all'
+
+export type DatasetGranularityFilter
+  = | 'other'
+    | 'country'
+    | 'country-group'
+    | 'country-subset'
+    | 'poi'
+    | 'fr:commune'
+    | 'fr:epci'
+    | 'fr:departement'
+    | 'fr:region'
+    | 'fr:canton'
+    | 'fr:collectivite'
+    | 'fr:iris'
+    | 'fr:arrondissement'
+
+export type DatasetLicenseFilter
+  = | 'lov2'
+    | 'notspecified'
+    | 'fr-lo'
+    | 'odc-odbl'
+    | 'other-at'
+    | 'other-pd'
+    | 'cc-by'
+    | 'other-open'
+    | 'cc-by-sa'
+    | 'odc-by'
+    | 'cc-zero'
+    | 'odc-pddl'
+
+export type DatasetSearchSort = 'created' | 'last_update' | 'reuses' | 'followers' | 'views' | '-created' | '-last_update' | '-reuses' | '-followers' | '-views'
+
+export type DatasetSearchFilters = {
+  tag?: string | string[]
+  badge?: DatasetBadgeFilter
+  organization?: string
+  organization_badge?: OrganizationBadgeFilter
+  license?: DatasetLicenseFilter | string
+  geozone?: string
+  granularity?: DatasetGranularityFilter | DatasetGranularityFilter[]
+  format?: string | string[]
+  schema?: string | string[]
+  temporal_coverage?: string
+  featured?: boolean
+  topic?: string
+  access_type?: DatasetAccessTypeFilter
+  format_family?: DatasetFormatFamily
+  producer_type?: ProducerType
+  last_update_range?: LastUpdateRange
+}
+
+export type DatasetSearchQueryParams = BaseSearchQueryParams<DatasetSearchSort> & DatasetSearchFilters
+
+export type DatasetSearchFacets = {
+  access_type: FacetItem[]
+  badge: FacetItem[]
+  format: FacetItem[]
+  format_family: FacetItem[]
+  geozone: FacetItem[]
+  granularity: FacetItem[]
+  last_update: FacetItem[]
+  license: FacetItem[]
+  organization_id_with_name: FacetItem[]
+  producer_type: FacetItem[]
+  schema: FacetItem[]
+  tag: FacetItem[]
+  topics: FacetItem[]
+}
+
+// Dataservice Search
+
+export type DataserviceAccessTypeFilter = AccessType | 'all'
+
+export type DataserviceSearchSort = 'created' | 'views' | 'followers' | '-created' | '-views' | '-followers'
+
+export type DataserviceSearchFilters = {
+  tag?: string | string[]
+  topic?: string
+  organization?: string
+  archived?: boolean
+  featured?: boolean
+  access_type?: DataserviceAccessTypeFilter
+  producer_type?: ProducerType
+  last_update_range?: LastUpdateRange
+  is_restricted?: boolean
+}
+
+export type DataserviceSearchQueryParams = BaseSearchQueryParams<DataserviceSearchSort> & DataserviceSearchFilters
+
+export type DataserviceSearchFacets = {
+  access_type: FacetItem[]
+  badge: FacetItem[]
+  last_update: FacetItem[]
+  organization_id_with_name: FacetItem[]
+  producer_type: FacetItem[]
+  tag: FacetItem[]
+}
+
+// Reuse Search
+
+export type ReuseTopicFilter
+  = | 'others'
+    | 'health'
+    | 'transport_and_mobility'
+    | 'politics_and_public_life'
+    | 'housing_and_development'
+    | 'environment_and_energy'
+    | 'culture_and_recreation'
+    | 'society_and_demography'
+    | 'economy_and_business'
+    | 'open_data_tools'
+    | 'education_and_research'
+    | 'food_and_agriculture'
+    | 'law_and_justice'
+    | 'safety_and_security'
+    | 'work_and_training'
+
+export type ReuseTypeFilter
+  = | 'visualization'
+    | 'application'
+    | 'post'
+    | 'news_article'
+    | 'api'
+    | 'paper'
+    | 'idea'
+    | 'hardware'
+
+export type ReuseSearchSort = 'created' | 'datasets' | 'followers' | 'views' | '-created' | '-datasets' | '-followers' | '-views'
+
+export type ReuseSearchFilters = {
+  tag?: string | string[]
+  organization?: string
+  organization_badge?: OrganizationBadgeFilter
+  owner?: string
+  type?: ReuseTypeFilter
+  badge?: string
+  featured?: boolean
+  topic?: ReuseTopicFilter
+  archived?: boolean
+  producer_type?: ProducerType
+  last_update_range?: LastUpdateRange
+}
+
+export type ReuseSearchQueryParams = BaseSearchQueryParams<ReuseSearchSort> & ReuseSearchFilters
+
+export type ReuseSearchFacets = {
+  badge: FacetItem[]
+  last_update: FacetItem[]
+  organization_id_with_name: FacetItem[]
+  producer_type: FacetItem[]
+  tag: FacetItem[]
+  topic: FacetItem[]
+  type: FacetItem[]
+}
+
+// Organization Search
+
+export type OrganizationSearchSort = 'reuses' | 'datasets' | 'followers' | 'views' | 'created' | '-reuses' | '-datasets' | '-followers' | '-views' | '-created'
+
+export type OrganizationSearchFilters = {
+  badge?: OrganizationBadgeFilter
+}
+
+export type OrganizationSearchQueryParams = BaseSearchQueryParams<OrganizationSearchSort> & OrganizationSearchFilters
+
+export type OrganizationSearchFacets = {
+  producer_type: FacetItem[]
+}
+
+// Post Search
+
+export type PostSearchSort = 'created' | 'last_modified' | 'published' | '-created' | '-last_modified' | '-published'
+
+export type PostSearchFilters = {
+  tag?: string | string[]
+  last_update_range?: LastUpdateRange
+}
+
+export type PostSearchQueryParams = BaseSearchQueryParams<PostSearchSort> & PostSearchFilters
+
+export type PostSearchFacets = {
+  last_update: FacetItem[]
+}
+
+// Discussion Search
+
+export type DiscussionObjectType = 'Dataset' | 'Dataservice'
+
+export type DiscussionSearchSort = 'created' | 'closed' | '-created' | '-closed'
+
+export type DiscussionSearchFilters = {
+  closed?: boolean
+  last_update_range?: LastUpdateRange
+}
+
+export type DiscussionSearchQueryParams = BaseSearchQueryParams<DiscussionSearchSort> & DiscussionSearchFilters
+
+export type DiscussionSearchFacets = {
+  last_update: FacetItem[]
+  object_type: FacetItem[]
+}
+
+// Topic Search
+
+export type TopicSearchSort = 'name' | 'created' | 'last_modified' | '-name' | '-created' | '-last_modified'
+
+export type TopicSearchFilters = {
+  tag?: string | string[]
+  featured?: boolean
+  last_update_range?: LastUpdateRange
+  organization?: string
+  producer_type?: ProducerType
+}
+
+export type TopicSearchQueryParams = BaseSearchQueryParams<TopicSearchSort> & TopicSearchFilters
+
+export type TopicSearchFacets = {
+  last_update: FacetItem[]
+  organization_id_with_name: FacetItem[]
+  producer_type: FacetItem[]
+  tag: FacetItem[]
+}
+
+// Search response with facets
+
+export type SearchResponseWithFacets<T, F> = PaginatedArray<T> & {
+  facets: F
+}
+
+export type DatasetSearchResponse<T> = SearchResponseWithFacets<T, DatasetSearchFacets>
+export type DataserviceSearchResponse<T> = SearchResponseWithFacets<T, DataserviceSearchFacets>
+export type ReuseSearchResponse<T> = SearchResponseWithFacets<T, ReuseSearchFacets>
+export type OrganizationSearchResponse<T> = SearchResponseWithFacets<T, OrganizationSearchFacets>
+export type PostSearchResponse<T> = SearchResponseWithFacets<T, PostSearchFacets>
+export type DiscussionSearchResponse<T> = SearchResponseWithFacets<T, DiscussionSearchFacets>
+export type TopicSearchResponse<T> = SearchResponseWithFacets<T, TopicSearchFacets>
+
+// GlobalSearch configuration types
+
+export type HiddenFilter<Filters> = {
+  [K in keyof Filters]: { key: K, value: Filters[K] }
+}[keyof Filters]
+
+export type SortOption<Sort extends string> = {
+  value: Sort
+  label: string
+}
+
+export type DatasetSearchConfig = {
+  class: 'datasets'
+  name?: string
+  hiddenFilters?: HiddenFilter<DatasetSearchFilters>[]
+  basicFilters?: (keyof DatasetSearchFilters)[]
+  advancedFilters?: (keyof DatasetSearchFilters)[]
+  sortOptions?: SortOption<DatasetSearchSort>[]
+}
+
+export type DataserviceSearchConfig = {
+  class: 'dataservices'
+  name?: string
+  hiddenFilters?: HiddenFilter<DataserviceSearchFilters>[]
+  basicFilters?: (keyof DataserviceSearchFilters)[]
+  advancedFilters?: (keyof DataserviceSearchFilters)[]
+  sortOptions?: SortOption<DataserviceSearchSort>[]
+}
+
+export type ReuseSearchConfig = {
+  class: 'reuses'
+  name?: string
+  hiddenFilters?: HiddenFilter<ReuseSearchFilters>[]
+  basicFilters?: (keyof ReuseSearchFilters)[]
+  advancedFilters?: (keyof ReuseSearchFilters)[]
+  sortOptions?: SortOption<ReuseSearchSort>[]
+}
+
+export type SearchTypeConfig = DatasetSearchConfig | DataserviceSearchConfig | ReuseSearchConfig
+
+export type SearchType = SearchTypeConfig['class']
+
+export type GlobalSearchConfig = SearchTypeConfig[]
+
+// Helper functions for default configs
+
+export const defaultDatasetSortOptions: SortOption<DatasetSearchSort>[] = [
+  { value: '-created', label: 'Date de création' },
+  { value: '-last_update', label: 'Dernière mise à jour' },
+  { value: '-followers', label: `Nombre d'abonnés` },
+  { value: '-reuses', label: 'Nombre de réutilisations' },
+]
+
+export const defaultDataserviceSortOptions: SortOption<DataserviceSearchSort>[] = [
+  { value: '-created', label: 'Date de création' },
+]
+
+export const defaultReuseSortOptions: SortOption<ReuseSearchSort>[] = [
+  { value: '-created', label: 'Date de création' },
+  { value: '-followers', label: `Nombre d'abonnés` },
+  { value: '-datasets', label: 'Nombre de jeux de données' },
+]
+
+export function getDefaultDatasetConfig(overrides?: Partial<Omit<DatasetSearchConfig, 'class'>>): DatasetSearchConfig {
+  return {
+    class: 'datasets',
+    basicFilters: ['format_family', 'access_type', 'last_update_range', 'producer_type', 'badge'],
+    advancedFilters: ['organization', 'organization_badge', 'tag', 'format', 'license', 'schema', 'geozone', 'granularity'],
+    sortOptions: defaultDatasetSortOptions,
+    ...overrides,
+  }
+}
+
+export function getDefaultDataserviceConfig(overrides?: Partial<Omit<DataserviceSearchConfig, 'class'>>): DataserviceSearchConfig {
+  return {
+    class: 'dataservices',
+    basicFilters: ['access_type', 'last_update_range', 'producer_type'],
+    advancedFilters: ['organization', 'tag'],
+    sortOptions: defaultDataserviceSortOptions,
+    ...overrides,
+  }
+}
+
+export function getDefaultReuseConfig(overrides?: Partial<Omit<ReuseSearchConfig, 'class'>>): ReuseSearchConfig {
+  return {
+    class: 'reuses',
+    basicFilters: ['type', 'topic', 'last_update_range', 'producer_type'],
+    advancedFilters: ['organization', 'organization_badge', 'tag'],
+    sortOptions: defaultReuseSortOptions,
+    ...overrides,
+  }
+}
+
+export function getDefaultGlobalSearchConfig(): GlobalSearchConfig {
+  return [
+    getDefaultDatasetConfig(),
+    getDefaultDataserviceConfig(),
+    getDefaultReuseConfig(),
+  ]
+}

package/src/types/users.ts

@@ -1,6 +1,7 @@
-import type { Organization } from './organizations'
+import type { OrganizationReference } from './organizations'
 
 export type UserReference = {
+  class: 'User'
   id: string
   first_name: string
   last_name: string
@@ -11,13 +12,21 @@ export type UserReference = {
   avatar_thumbnail: string
 }
 
-export type User = UserReference & {
+export type User = {
+  id: UserReference['id']
+  first_name: UserReference['first_name']
+  last_name: UserReference['last_name']
+  slug: UserReference['slug']
+  uri: UserReference['uri']
+  page: UserReference['page']
+  avatar: UserReference['avatar']
+  avatar_thumbnail: UserReference['avatar_thumbnail']
   apikey?: string
   email?: string
   about: string
   website?: string
   roles?: Array<string>
-  organizations: Array<Organization>
+  organizations: Array<OrganizationReference>
   last_login_at: string | null
   since: string | null
   metrics: {