@datagouv/components-next 0.2.0 → 1.0.1

package/src/main.ts

@@ -3,23 +3,28 @@ import type { Activity, ActivityKey } from './types/activity.js'
 import type { PaginatedArray } from './types/api.js'
 import type { ContactPoint, ContactPointRole } from './types/contact_point.js'
 import type { Badge, Badges, TranslatedBadge } from './types/badges'
-import type { Dataset, DatasetV2, DatasetV2WithFullObject, NewDataset, Quality, Rel } from './types/datasets'
-import type { NewDataservice, Dataservice } from './types/dataservices'
+import type { DatasetReference, Dataset, DatasetV2, DatasetV2WithFullObject, NewDataset, Quality, Rel } from './types/datasets'
+import type { DataserviceReference, NewDataservice, Dataservice } from './types/dataservices'
 import type { AccessType, AccessAudience, AccessAudienceCondition, AccessAudienceType, WithAccessType, AccessTypeForm } from './types/access_types'
 import type { Frequency, Frequencies } from './types/frequency'
 import type { Granularity, Granularities, SpatialZone } from './types/granularity'
 import type { Harvest } from './types/harvest'
 import type { License } from './types/licenses'
 import type { Member, MemberRole, NewOrganization, Organization, OrganizationOrSuggest, OrganizationReference, OrganizationSuggest } from './types/organizations'
-import type { Owned, OwnedWithId } from './types/owned'
-import type { NewReuse, Reuse, ReuseTopic, ReuseType } from './types/reuses'
+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 { 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'
 import type { TopicV2, TopicElement, TopicElementClass, TopicElementRel } from './types/topics'
-import type { CommunityResource, FileResourceFileType, RemoteResourceFileType, ResourceFileType, ResourceType, Resource } from './types/resources'
+import type { CommunityResource, FileResourceFileType, RemoteResourceFileType, ResourceFileType, ResourceGroup, ResourceType, Resource } from './types/resources'
 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 ActivityList from './components/ActivityList/ActivityList.vue'
 import UserActivityList from './components/ActivityList/UserActivityList.vue'
@@ -32,18 +37,26 @@ import BrandedButton from './components/BrandedButton.vue'
 import CopyButton from './components/CopyButton.vue'
 import DataserviceCard from './components/DataserviceCard.vue'
 import DatasetCard from './components/DatasetCard.vue'
+import DescriptionListTerm from './components/DescriptionListTerm.vue'
+import DescriptionListDetails from './components/DescriptionListDetails.vue'
+import DiscussionMessageCard from './components/DiscussionMessageCard.vue'
 import DateRangeDetails from './components/DateRangeDetails.vue'
-import DatasetInformationPanel from './components/DatasetInformationPanel.vue'
+import { DatasetInformationSection, DatasetTemporalitySection, DatasetSpatialSection, DatasetSchemaSection, DatasetEmbedSection } from './components/DatasetInformation'
+import LeafletMap from './components/LeafletMap.vue'
+import LicenseBadge from './components/LicenseBadge.vue'
+import Tag from './components/Tag.vue'
 import DatasetQuality from './components/DatasetQuality.vue'
 import DatasetQualityInline from './components/DatasetQualityInline.vue'
 import DatasetQualityItem from './components/DatasetQualityItem.vue'
 import DatasetQualityScore from './components/DatasetQualityScore.vue'
+import ProgressBar from './components/ProgressBar.vue'
 import DatasetQualityTooltipContent from './components/DatasetQualityTooltipContent.vue'
 import ExtraAccordion from './components/ExtraAccordion.vue'
 import LabelTag from './components/DatasetLabelTag.vue'
 import LoadingBlock from './components/LoadingBlock.vue'
 import MarkdownViewer from './components/MarkdownViewer.vue'
 import OrganizationCard from './components/OrganizationCard.vue'
+import OrganizationHorizontalCard from './components/OrganizationHorizontalCard.vue'
 import OrganizationLogo from './components/OrganizationLogo.vue'
 import OrganizationNameWithCertificate from './components/OrganizationNameWithCertificate.vue'
 import OwnerType from './components/OwnerType.vue'
@@ -51,11 +64,18 @@ import OwnerTypeIcon from './components/OwnerTypeIcon.vue'
 import PaddedContainer from './components/PaddedContainer.vue'
 import Pagination from './components/Pagination.vue'
 import Placeholder from './components/Placeholder.vue'
+import RadioGroup from './components/RadioGroup.vue'
+import RadioInput from './components/RadioInput.vue'
+import PostCard from './components/PostCard.vue'
 import ReadMore from './components/ReadMore.vue'
 import ResourceAccordion from './components/ResourceAccordion/ResourceAccordion.vue'
 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 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'
@@ -68,18 +88,27 @@ import TabPanel from './components/Tabs/TabPanel.vue'
 import TabPanels from './components/Tabs/TabPanels.vue'
 import Tooltip from './components/Tooltip.vue'
 import Toggletip from './components/Toggletip.vue'
+import TopicCard from './components/TopicCard.vue'
 import TranslationT from './components/TranslationT.vue'
+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 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/useMetrics'
 export * from './composables/useReuseType'
 export * from './composables/useTranslation'
+export * from './composables/useHasTabularData'
 
 export * from './functions/activities'
 export * from './functions/datasets'
 export * from './functions/dates'
+export * from './functions/description'
 export * from './functions/helpers'
 export * from './functions/markdown'
 export * from './functions/matomo'
@@ -95,6 +124,9 @@ export * from './functions/users'
 export * from './types/access_types'
 
 export type {
+  GlobalSearchConfig,
+  SearchType,
+  SortOption,
   UseFetchFunction,
   AccessType,
   AccessAudience,
@@ -109,10 +141,13 @@ export type {
   CommunityResource,
   ContactPoint,
   ContactPointRole,
+  DatasetReference,
   Dataset,
   DatasetV2,
   DatasetV2WithFullObject,
+  DataserviceReference,
   Dataservice,
+  Comment,
   NewDataservice,
   FileResourceFileType,
   Frequency,
@@ -131,8 +166,24 @@ export type {
   OrganizationSuggest,
   OrganizationOrSuggest,
   Owned,
+  OwnedWithFullObject,
   OwnedWithId,
+  Page,
+  PageBloc,
+  ContentBloc,
+  BlocWithTitle,
+  DatasetsListBloc,
+  DataservicesListBloc,
+  ReusesListBloc,
+  LinkInBloc,
+  LinksListBloc,
+  MarkdownBloc,
+  AccordionItemBloc,
+  AccordionListBloc,
+  HeroBloc,
   PaginatedArray,
+  Post,
+  Thread,
   Quality,
   RegisteredSchema,
   Rel,
@@ -142,7 +193,9 @@ export type {
   ReportReason,
   Resource,
   ResourceFileType,
+  ResourceGroup,
   ResourceType,
+  ReuseReference,
   Reuse,
   ReuseTopic,
   ReuseType,
@@ -167,6 +220,18 @@ export type {
   WellType,
 }
 
+export {
+  getDefaultDatasetConfig,
+  getDefaultDataserviceConfig,
+  getDefaultReuseConfig,
+  getDefaultOrganizationConfig,
+  getDefaultGlobalSearchConfig,
+  defaultDatasetSortOptions,
+  defaultDataserviceSortOptions,
+  defaultReuseSortOptions,
+  defaultOrganizationSortOptions,
+}
+
 // Vue Plugin
 const datagouv: Plugin<PluginConfig> = {
   async install(app: App, options) {
@@ -191,7 +256,14 @@ export {
   CopyButton,
   DataserviceCard,
   DatasetCard,
-  DatasetInformationPanel,
+  DatasetInformationSection,
+  DatasetTemporalitySection,
+  DatasetSpatialSection,
+  DatasetSchemaSection,
+  DatasetEmbedSection,
+  DescriptionListTerm,
+  DescriptionListDetails,
+  DiscussionMessageCard,
   DatasetQuality,
   DatasetQualityInline,
   DatasetQualityItem,
@@ -200,9 +272,13 @@ export {
   DateRangeDetails,
   ExtraAccordion,
   LabelTag,
+  LeafletMap,
+  LicenseBadge,
   LoadingBlock,
+  Tag,
   MarkdownViewer,
   OrganizationCard,
+  OrganizationHorizontalCard,
   OrganizationLogo,
   OrganizationNameWithCertificate,
   OwnerType,
@@ -210,11 +286,19 @@ export {
   PaddedContainer,
   Pagination,
   Placeholder,
+  ProgressBar,
+  PostCard,
+  RadioGroup,
+  RadioInput,
   ReadMore,
   ResourceAccordion,
+  ResourceExplorer,
+  ResourceExplorerSidebar,
+  ResourceExplorerViewer,
   ResourceIcon,
   ReuseCard,
   ReuseDetails,
+  ReuseHorizontalCard,
   SchemaCard,
   SimpleBanner,
   SmallChart,
@@ -227,6 +311,11 @@ export {
   TabPanels,
   Tooltip,
   Toggletip,
+  TopicCard,
   TranslationT,
   UserActivityList,
+  GlobalSearch,
+  SearchInput,
+  SearchableSelect,
+  SelectGroup,
 }

package/src/types/dataservices.ts

@@ -2,19 +2,21 @@ import type { Harvest } from './harvest'
 import type { Owned, OwnedWithId } from './owned'
 import type { ContactPoint } from './contact_point'
 import type { WithAccessType } from './access_types'
+import type { DatasetReference } from './datasets'
+
+export type DataserviceReference = {
+  class: 'Dataservice'
+  id: string
+  title: string
+  self_api_url: string
+  self_web_url: string
+}
 
 export type BaseDataservice = Owned & WithAccessType & {
   acronym: string
   availability: number | null
   base_api_url: string | null
-  datasets: Array<{
-    class: string
-    id: string
-    acronym: string
-    page: string
-    title: string
-    uri: string
-  }>
+  datasets: Array<DatasetReference>
   description: string
   machine_documentation_url: string | null
   technical_documentation_url: string | null
@@ -22,7 +24,7 @@ export type BaseDataservice = Owned & WithAccessType & {
   license: string | null
   private: boolean
   rate_limiting: string
-  title: string
+  title: DataserviceReference['title']
   contact_points: Array<ContactPoint>
 }
 
@@ -50,7 +52,7 @@ export type Dataservice = Owned & WithAccessType & {
   extras: Record<string, unknown>
   format: string
   harvest: Harvest
-  id: string
+  id: DataserviceReference['id']
   license: string | null
   metadata_modified_at: string
   metrics: {
@@ -63,8 +65,8 @@ export type Dataservice = Owned & WithAccessType & {
   permissions: { edit: boolean, delete: boolean }
   private: boolean
   rate_limiting: string
-  self_api_url: string
-  self_web_url: string
+  self_api_url: DataserviceReference['self_api_url']
+  self_web_url: DataserviceReference['self_web_url']
   slug: string
   tags: Array<string>
   title: string

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,19 @@ 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[]
+}
+
+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

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