@datagouv/components-next 0.0.1

package/src/locales/sr.json

@@ -0,0 +1,154 @@
+{
+  "Copy": "Copy",
+  "The identity of this public service is certified by {certifier}": "The identity of this public service is certified by {certifier}",
+  "Edit file": "Edit file",
+  "Nameless file": "Nameless file",
+  "schema:": "schema:",
+  "Invalid": "Invalid",
+  "Updated {date}": "Updated {date}",
+  "{n} downloads": "{n} downloads",
+  "From": "From",
+  "Unavailable": "Unavailable",
+  "Close details": "Close details",
+  "See data": "See data",
+  "See metadata": "See metadata",
+  "File link - opens a new window": "File link - opens a new window",
+  "Download file": "Download file",
+  "File menu": "File menu",
+  "Preview": "Preview",
+  "Data structure": "Data structure",
+  "Metadata": "Metadata",
+  "Data schema": "Data schema",
+  "This file is following a schema: ": "This file is following a schema: ",
+  "See validation report": "See validation report",
+  "URL": "URL",
+  "MIME Type": "MIME Type",
+  "Created on": "Created on",
+  "Modified on": "Modified on",
+  "Size": "Size",
+  "Explore data": "Explore data",
+  "B": "B",
+  "today": "today",
+  "on {date}": "on {date}",
+  "Informations": "Informations",
+  "License": "License",
+  "Temporality": "Temporality",
+  "Creation": "Creation",
+  "Frequency": "Frequency",
+  "Last update": "Last update",
+  "Spatial coverage": "Spatial coverage",
+  "Territorial coverage": "Territorial coverage",
+  "Granularity of territorial coverage": "Granularity of territorial coverage",
+  "Integrate on your website": "Integrate on your website",
+  "Extras": "Extras",
+  "See extras": "See extras",
+  "Harvest": "Harvest",
+  "See harvest": "See harvest",
+  "Pagination": "Pagination",
+  "First page": "First page",
+  "Previous page": "Previous page",
+  "Page {nb}": "Page {nb}",
+  "Next page": "Next page",
+  "Last page": "Last page",
+  "Metadata quality:": "Metadata quality:",
+  "Data description filled": "Data description filled",
+  "Data description empty": "Data description empty",
+  "Files documented": "Files documented",
+  "Files documentation missing": "Files documentation missing",
+  "License filled": "License filled",
+  "No license set": "No license set",
+  "Update frequency followed": "Update frequency followed",
+  "Update frequency not followed": "Update frequency not followed",
+  "Update frequency not set": "Update frequency not set",
+  "File formats are open": "File formats are open",
+  "File formats are closed": "File formats are closed",
+  "Temporal coverage filled": "Temporal coverage filled",
+  "Temporal coverage not set": "Temporal coverage not set",
+  "Spatial coverage filled": "Spatial coverage filled",
+  "Spatial coverage not set": "Spatial coverage not set",
+  "All files are available": "All files are available",
+  "Some files are unavailable": "Some files are unavailable",
+  "Learn more about this indicator - opens a new window": "Learn more about this indicator - opens a new window",
+  "Learn more about this indicator": "Learn more about this indicator",
+  "Read less": "Read less",
+  "Read more": "Read more",
+  "Archived": "Archived",
+  "Metadata :": "Metadata :",
+  "Availability :": "Availability :",
+  "Local authority": "Local authority",
+  "Association": "Association",
+  "Company": "Company",
+  "User": "User",
+  "The data structure of this file failed to load.": "The data structure of this file failed to load.",
+  "No data structure found for this file.": "No data structure found for this file.",
+  "The preview of this file failed to load.": "The preview of this file failed to load.",
+  "Explore data in detail": "Explore data in detail",
+  "Use our tool to get an overview of data, learn about different columns or perform filters and sorts.": "Use our tool to get an overview of data, learn about different columns or perform filters and sorts.",
+  "Preview updated on {date}": "Preview updated on {date}",
+  "Preview of {name}": "Preview of {name}",
+  "Sort ascending": "Sort ascending",
+  "Sort descending": "Sort descending",
+  "{count} columns": "{count} columns",
+  "{count} rows": "{count} rows",
+  "Resource Extras": "Resource Extras",
+  "Public service": "Public service",
+  "published {date}": "published {date}",
+  "{n}%": "{n}%",
+  "Restricted access": "Restricted access",
+  "Other": "Other",
+  "{n} views": "{n} views",
+  "{n} followers": "{n} followers",
+  "unknown": "unknown",
+  "Link copied!": "Link copied!",
+  "Copy link": "Copy link",
+  "Original format": "Original format",
+  "Format {format}": "Format {format}",
+  "Data": "Data",
+  "Description": "Description",
+  "Downloads": "Downloads",
+  "Schema:": "Schema",
+  "Copy embed": "Copy embed",
+  "Embed copied": "Embed copied",
+  "Stable URL": "Stable URL",
+  "Identifier": "Identifier",
+  "Copy ID": "Copy ID",
+  "ID copied!": "ID copied!",
+  "Copy checksum": "Copy checksum",
+  "Checksum copied!": "Checksum copied!",
+  "Type": "Type",
+  "Format": "Format",
+  "downloads": "downloads",
+  "Visit": "Visit",
+  "Original URL": "Original URL",
+  "File": "File",
+  "This file is valid for the shema:": "This file is valid for the shema:",
+  "But its compliance could be improved.": "But its compliance could be improved.",
+  "This file indicates to follow the schema:": "This file indicates to follow the schema:",
+  "But is not compliant.": "But is not compliant.",
+  "advices": "advices",
+  "structure errors": "structure errors",
+  "body errors": "body errors",
+  "Main file": "Main file",
+  "Documentation": "Documentation",
+  "Update": "Update",
+  "API": "API",
+  "Source code": "Source code",
+  "{n} resources downloads": "{n} resources downloads",
+  "{n} reuses": "{n} reuses",
+  "Close": "Close",
+  " in ": " in ",
+  "Auto-generated formats from {platform}": "Auto-generated formats from {platform}",
+  "Draft": "Draft",
+  "API documentation": "API documentation",
+  "Technical Documentation": "Technical Documentation",
+  "Business documentation": "Business documentation",
+  "Swagger": "Swagger",
+  "Swagger automatically generated by data.gouv.fr. This swagger allows you to query data by API by filtering it by column value.": "Swagger automatically generated by data.gouv.fr. This swagger allows you to query data by API by filtering it by column value.",
+  "Good": "Good",
+  "To improve": "To improve",
+  "Copy URL": "Copy URL",
+  "URL copied!": "URL copied!",
+  "Copy stable URL": "Copy stable URL",
+  "Stable URL copied!": "Stable URL copied!",
+  "Download file as ": "Download file as "
+}

package/src/main.ts

@@ -0,0 +1,147 @@
+import type { App, Plugin } from 'vue'
+import type { Badge, Badges } from './types/badges'
+import type { Dataset, DatasetV2, NewDataset, Quality, Rel } from './types/datasets'
+import type { NewDataservice, Dataservice } from './types/dataservices'
+import type { Frequency, Frequencies } from './types/frequency'
+import type { Granularity, Granularities } from './types/granularity'
+import type { Harvest } from './types/harvest'
+import type { License } from './types/licenses'
+import type { Member, MemberRole, NewOrganization, Organization } from './types/organizations'
+import type { Owned, OwnedWithId } from './types/owned'
+import type { NewReuse, Reuse, ReuseTopic, ReuseType } from './types/reuses'
+import type { TopicV2 } from './types/topics'
+import type { CommunityResource, FileResourceFileType, RemoteResourceFileType, ResourceFileType, ResourceType, Resource } from './types/resources'
+import type { Site } from './types/site'
+import type { Weight, WellType } from './types/ui'
+import type { User } from './types/users'
+
+import Avatar from './components/Avatar.vue'
+import AvatarWithName from './components/AvatarWithName.vue'
+import BannerAction from './components/BannerAction.vue'
+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 DatasetInformationPanel from './components/DatasetInformationPanel.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 DatasetQualityTooltipContent from './components/DatasetQualityTooltipContent.vue'
+import OrganizationCard from './components/OrganizationCard.vue'
+import OrganizationNameWithCertificate from './components/OrganizationNameWithCertificate.vue'
+import OwnerType from './components/OwnerType.vue'
+import OwnerTypeIcon from './components/OwnerTypeIcon.vue'
+import Pagination from './components/Pagination.vue'
+import Placeholder from './components/Placeholder.vue'
+import ReadMore from './components/ReadMore.vue'
+import ResourceAccordion from './components/ResourceAccordion/ResourceAccordion.vue'
+import ResourceIcon from './components/ResourceAccordion/ResourceIcon.vue'
+import ReuseCard from './components/ReuseCard.vue'
+import SimpleBanner from './components/SimpleBanner.vue'
+import StatBox from './components/StatBox.vue'
+import type { UseFetchFunction } from './functions/api.types'
+import { configKey, useComponentsConfig, type PluginConfig } from './config.js'
+
+export * from './composables/useReuseType'
+
+export * from './functions/dates'
+export * from './functions/organizations'
+export * from './functions/resources'
+export * from './functions/users'
+export * from './functions/datasets'
+export * from './functions/owned'
+export * from './functions/helpers'
+export * from './functions/matomo'
+export * from './functions/schemas'
+export * from './functions/markdown'
+
+export type {
+  UseFetchFunction,
+  Badge,
+  Badges,
+  CommunityResource,
+  Dataset,
+  DatasetV2,
+  Dataservice,
+  NewDataservice,
+  FileResourceFileType,
+  Frequency,
+  Frequencies,
+  Granularity,
+  Granularities,
+  Harvest,
+  License,
+  Member,
+  MemberRole,
+  NewDataset,
+  NewOrganization,
+  NewReuse,
+  Organization,
+  Owned,
+  OwnedWithId,
+  Quality,
+  Rel,
+  RemoteResourceFileType,
+  Resource,
+  ResourceFileType,
+  ResourceType,
+  Reuse,
+  ReuseTopic,
+  ReuseType,
+  Site,
+  TopicV2,
+  User,
+  Weight,
+  WellType,
+}
+
+// Vue Plugin
+const datagouv: Plugin<PluginConfig> = {
+  async install(app: App, options) {
+    if (!options.textClamp) {
+      const textClamp = await import('vue3-text-clamp')
+      options.textClamp = textClamp.default
+    }
+
+    if (options.i18n) {
+      const frMessages = await import('../dist/locales/fr.js')
+      const enMessages = await import('../dist/locales/en.js')
+
+      options.i18n.global.mergeLocaleMessage('en', enMessages.default)
+      options.i18n.global.mergeLocaleMessage('fr', frMessages.default)
+    }
+
+    app.provide(configKey, options)
+  },
+}
+
+export {
+  datagouv,
+  useComponentsConfig,
+  Avatar,
+  AvatarWithName,
+  BannerAction,
+  BrandedButton,
+  CopyButton,
+  DataserviceCard,
+  DatasetCard,
+  DatasetInformationPanel,
+  DatasetQuality,
+  DatasetQualityInline,
+  DatasetQualityItem,
+  DatasetQualityScore,
+  DatasetQualityTooltipContent,
+  OrganizationCard,
+  OrganizationNameWithCertificate,
+  OwnerType,
+  OwnerTypeIcon,
+  Pagination,
+  Placeholder,
+  ReadMore,
+  ResourceAccordion,
+  ResourceIcon,
+  ReuseCard,
+  SimpleBanner,
+  StatBox,
+}

package/src/types/badges.ts

@@ -0,0 +1,5 @@
+export type Badge = {
+  kind: string;
+};
+
+export type Badges = Array<Badge>;

package/src/types/contact_point.ts

@@ -0,0 +1,7 @@
+export type ContactPoint = {
+  id: string;
+  name: string;
+  contact_form?: string;
+  email?: string;
+  role: string;
+}

package/src/types/dataservices.ts

@@ -0,0 +1,68 @@
+import type { Harvest } from './harvest'
+import type { Owned, OwnedWithId } from './owned'
+import type { ContactPoint } from './contact_point'
+
+export type BaseDataservice = Owned & {
+  acronym: string
+  authorization_request_url: string | null
+  availability: number | null
+  base_api_url: string | null
+  datasets: Array<{
+    class: string
+    id: string
+    acronym: string
+    page: string
+    title: string
+    uri: string
+  }>
+  description: string
+  machine_documentation_url: string | null
+  technical_documentation_url: string | null
+  business_documentation_url: string | null
+  access_type: 'open' | 'restricted' | 'open_with_account'
+  license: string | null
+  private: boolean
+  rate_limiting: string
+  title: string
+  contact_points: Array<ContactPoint>
+}
+
+export type NewDataservice = Omit<BaseDataservice, keyof OwnedWithId> & OwnedWithId
+
+export type Dataservice = Owned & {
+  acronym: string
+  archived_at: string | null
+  authorization_request_url: string | null
+  availability: number | null
+  base_api_url: string | null
+  contact_points: Array<ContactPoint>
+  created_at: string
+  datasets: Array<{
+    class: string
+    id: string
+    acronym: string
+    page: string
+    title: string
+    uri: string
+  }>
+  deleted_at: string | null
+  description: string
+  machine_documentation_url: string | null
+  technical_documentation_url: string | null
+  business_documentation_url: string | null
+  extras: Record<string, any>
+  format: string
+  harvest: Harvest
+  id: string
+  access_type: 'open' | 'restricted' | 'open_with_account'
+  license: string | null
+  metadata_modified_at: string
+  metrics: { discussions: number, followers: number, reuses: number, views: number }
+  private: boolean
+  rate_limiting: string
+  self_api_url: string
+  self_web_url: string
+  slug: string
+  tags: Array<string>
+  title: string
+}

package/src/types/datasets.ts

@@ -0,0 +1,80 @@
+import type { Badges } from './badges'
+import type { Harvest } from './harvest'
+import type { Owned, OwnedWithId } from './owned'
+import type { Resource } from './resources'
+import type { ContactPoint } from './contact_point'
+
+export type Quality = {
+  all_resources_available: boolean
+  dataset_description_quality: boolean
+  has_open_format: boolean
+  has_resources: boolean
+  license: boolean
+  resources_documentation: boolean
+  score: number
+  spatial: boolean
+  temporal_coverage: boolean
+  update_frequency: boolean
+  update_fulfilled_in_time: boolean
+}
+
+export type BaseDataset = Owned & {
+  title: string
+  acronym: string
+  archived: boolean
+  description: string
+  tags: Array<string> | null
+  license: string
+  frequency: string
+  temporal_coverage: {
+    start: string
+    end: string
+  } | null
+  frequency_date: string | null
+  page: string
+  private: boolean
+  quality?: Quality
+  spatial: {
+    zones?: Array<string>
+    granularity?: string
+  } | null
+  contact_points: Array<ContactPoint>
+}
+
+export type NewDataset = Omit<BaseDataset, keyof OwnedWithId> & OwnedWithId
+
+export type Rel = {
+  rel: string
+  href: string
+  total: number
+  type: string
+}
+
+export type Dataset = BaseDataset & {
+  id: string
+  badges: Badges
+  deleted: string | null
+  page: string
+  resources: Array<Resource>
+  community_resources: Array<Resource>
+  created_at: string
+  last_modified: string
+  last_update: string
+  uri: string
+  slug: string
+  quality: Quality
+  metrics: {
+    discussions: number
+    followers: number
+    resources_downloads: number
+    reuses: number
+    views: number
+  }
+  harvest: Harvest
+  extras: Record<string, any>
+}
+
+export type DatasetV2 = Owned & Omit<Dataset, 'resources' | 'community_resources'> & {
+  resources: Rel
+  community_resources: Rel
+}

package/src/types/frequency.ts

@@ -0,0 +1,6 @@
+export type Frequency = {
+  id: string;
+  label: string;
+};
+  
+export type Frequencies = Array<Frequency>;

package/src/types/granularity.ts

@@ -0,0 +1,6 @@
+export type Granularity = {
+  id: string;
+  name: string;
+};
+
+export type Granularities = Array<Granularity>;

package/src/types/harvest.ts

@@ -0,0 +1,3 @@
+export type Harvest = Record<string, any> & {
+  backend?: string;
+} | null;

package/src/types/keyboard.ts

@@ -0,0 +1 @@
+export type CommonKeyboardKeys = 'Alt' | 'Control' | 'Shift' | 'CapsLock' | 'Tab' | 'Escape' | 'End' | 'Home' | 'ArrowLeft' | 'ArrowUp' | 'ArrowRight' | 'ArrowDown'

package/src/types/licenses.ts

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

package/src/types/organizations.ts

@@ -0,0 +1,41 @@
+import type { User } from './users'
+import type { Badges } from './badges'
+
+export type MemberRole = 'admin' | 'editor'
+
+export type Member = {
+  role: MemberRole
+  user: User
+}
+
+export type NewOrganization = {
+  acronym: string | null
+  name: string
+  business_number_id: string | null
+  description: string
+  url: string | null
+  logo: string
+}
+
+export type Organization = NewOrganization & {
+  id: string
+  created_at: string
+  last_modified: string
+  last_update: string
+  deleted: string | null
+  extras: Record<string, any>
+  logo_thumbnail: string
+  members: Array<Member>
+  metrics: {
+    dataservices: number
+    datasets: number
+    followers: number
+    members: number
+    reuses: number
+    views: number
+  }
+  page: string
+  slug: string
+  uri: string
+  badges: Badges
+}

package/src/types/owned.ts

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

package/src/types/resources.ts

@@ -0,0 +1,37 @@
+import type { Schema } from '../functions/schemas'
+import type { RESOURCE_TYPE } from '../functions/resources'
+import type { Dataset } from './datasets'
+import type { Harvest } from './harvest'
+import type { Owned } from './owned'
+
+export type ResourceType = typeof RESOURCE_TYPE[number]
+
+export type RemoteResourceFileType = 'remote'
+
+export type FileResourceFileType = 'file'
+
+export type ResourceFileType = RemoteResourceFileType | FileResourceFileType
+
+export type Resource = {
+  id: string
+  title: string
+  type: ResourceType
+  checksum: { type: string, value: string } | null
+  created_at: string
+  description: string | null
+  extras: Record<string, unknown>
+  metrics: { views: number }
+  harvest: Harvest
+  filesize: number | null
+  filetype: ResourceFileType
+  format: string
+  mime: string
+  internal: Record<string, unknown>
+  last_modified: string
+  latest: string
+  preview_url: string
+  schema: Schema
+  url: string
+}
+
+export type CommunityResource = Owned & Resource & { dataset: Omit<Dataset, 'resources' | 'community_resources'> }

package/src/types/reuses.ts

@@ -0,0 +1,49 @@
+import type { Owned, OwnedWithId } from './owned'
+import type { Dataset } from './datasets'
+import type { Badges } from './badges'
+
+export type BaseReuse = Owned & {
+  title: string
+  description: string
+  tags: Array<string> | null
+  datasets: Array<Dataset | string>
+  topic: string
+  type: string
+  url: string
+  private: boolean
+}
+
+export type NewReuse = Omit<BaseReuse, keyof OwnedWithId> & OwnedWithId
+
+export type Reuse = BaseReuse & {
+  badges: Badges
+  created_at: string
+  datasets: Array<Dataset>
+  archived: string | null
+  deleted: string | null
+  extras: Record<string, any>
+  featured: boolean
+  id: string
+  image: string | null
+  image_thumbnail: string | null
+  last_modified: string
+  metrics: {
+    datasets: number
+    discussions: number
+    followers: number
+    views: number
+  }
+  slug: string
+  page: string
+  uri: string
+}
+
+export type ReuseType = {
+  id: string
+  label: string
+}
+
+export type ReuseTopic = {
+  id: string
+  label: string
+}

package/src/types/site.ts

@@ -0,0 +1,23 @@
+export type Site = {
+  id: string
+  title: string
+  metrics: {
+    'dataservices': number
+    'datasets': number
+    'discussions': number
+    'followers': number
+    'harvesters': number
+    'max_dataset_followers': number
+    'max_dataset_reuses': number
+    'max_org_datasets': number
+    'max_org_followers': number
+    'max_org_reuses': number
+    'max_reuse_datasets': number
+    'max_reuse_followers': number
+    'organizations': number
+    'public-service': number
+    'resources': number
+    'reuses': number
+    'users': number
+  }
+}

package/src/types/topics.ts

@@ -0,0 +1,20 @@
+import type { Rel } from './datasets'
+import type { Owned } from './owned'
+
+export type TopicV2 = Owned & {
+  id: string
+  name: string
+  slug: string
+  description: string
+  tags: Array<string>
+  datasets: Rel
+  reuses: Rel
+  featured: boolean
+  private: boolean
+  created_at: string
+  last_modified: string
+
+  uri: string
+  page: string
+  extras: Record<string, unknown>
+}