@datagouv/components-next 0.0.1

package/src/functions/resources.ts

@@ -0,0 +1,99 @@
+import { readonly, type Component } from 'vue'
+
+import { useI18n } from 'vue-i18n'
+import Archive from '../components/Icons/Archive.vue'
+import Code from '../components/Icons/Code.vue'
+import Documentation from '../components/Icons/Documentation.vue'
+import Image from '../components/Icons/Image.vue'
+import Link from '../components/Icons/Link.vue'
+import Table from '../components/Icons/Table.vue'
+import type { Resource } from '../types/resources'
+
+export function getResourceFormatIcon(format: string): Component | null {
+  switch (format?.trim()?.toLowerCase()) {
+    case 'txt':
+    case 'pdf':
+    case 'rtf':
+    case 'odt':
+    case 'doc':
+    case 'docx':
+    case 'epub':
+      return Documentation
+    case 'json':
+    case 'sql':
+    case 'xml':
+    case 'xsd':
+    case 'shp':
+    case 'kml':
+    case 'kmz':
+    case 'gpx':
+    case 'shx':
+    case 'ovr':
+    case 'geojson':
+    case 'gpkg':
+    case 'grib2':
+    case 'dbf':
+    case 'prj':
+    case 'sqlite':
+    case 'db':
+    case 'sbn':
+    case 'sbx':
+    case 'cpg':
+    case 'lyr':
+    case 'owl':
+    case 'dxf':
+    case 'ics':
+    case 'rdf':
+    case 'ttl':
+    case 'n3':
+      return Code
+    case 'tar':
+    case 'gz':
+    case 'tgz':
+    case 'rar':
+    case 'zip':
+    case '7z':
+    case 'xz':
+    case 'bz2':
+      return Archive
+    case 'url':
+      return Link
+    case 'csv':
+    case 'ods':
+    case 'xls':
+    case 'xlsx':
+    case 'parquet':
+      return Table
+    case 'png':
+    case 'jpg':
+    case 'jpeg':
+      return Image
+    default:
+      return null
+  }
+}
+
+export function getResourceTitleId(resource: Resource) {
+  return 'resource-' + resource.id + '-title'
+}
+
+export const RESOURCE_TYPE = readonly(['main', 'documentation', 'update', 'api', 'code', 'other'] as const)
+export type ResourceType = typeof RESOURCE_TYPE[number]
+
+export const getResourceLabel = (type: ResourceType) => {
+  const { t } = useI18n()
+  switch (type) {
+    case 'main':
+      return t('Main file')
+    case 'documentation':
+      return t('Documentation')
+    case 'update':
+      return t('Update')
+    case 'api':
+      return t('API')
+    case 'code':
+      return t('Source code')
+    case 'other':
+      return t('Other')
+  }
+}

package/src/functions/reuses.ts

@@ -0,0 +1,28 @@
+import { ofetch } from 'ofetch'
+import { useI18n } from 'vue-i18n'
+import { useComponentsConfig } from '../config'
+import type { ReuseTopic, ReuseType } from '../types/reuses'
+
+let reuseTypesRequest: Promise<Array<ReuseType>> | null = null
+
+export async function fetchReuseTypes() {
+  if (!reuseTypesRequest) {
+    const config = useComponentsConfig()
+    const { locale } = useI18n()
+    reuseTypesRequest = ofetch<Array<ReuseType>>('api/1/reuses/types/', {
+      baseURL: config.apiBase,
+      query: { lang: locale.value },
+    })
+  }
+  return await reuseTypesRequest
+}
+
+export function getType(types: Array<ReuseType>, id: string): string {
+  const type = types.find(t => t.id === id)
+  return type ? type.label : ''
+}
+
+export function getTopic(topics: Array<ReuseTopic>, id: string): string {
+  const topic = topics.find(t => t.id === id)
+  return topic ? topic.label : ''
+}

package/src/functions/schemas.ts

@@ -0,0 +1,96 @@
+import type { AxiosResponse } from 'axios'
+import { ofetch } from 'ofetch'
+import type { Resource } from '../types/resources'
+import { useComponentsConfig } from '../config'
+
+/**
+ * A schema version.
+ */
+export type SchemaVersion = {
+  version_name: string
+  schema_url: string
+}
+
+/**
+ * A schema from the schema catalog
+ */
+export type RegisteredSchema = {
+  name: string
+  schema_type: string
+  versions: Array<SchemaVersion>
+}
+
+/**
+ * A schema associated with a resource.
+ */
+export type Schema = {
+  name?: string | null
+  url?: string | null
+  version?: string | null
+} | null
+
+export interface ValidataError {
+  code: string
+  description: string
+  fieldName: string
+  fieldNumber: number
+  fieldPosition: number
+  message: string
+  name: string
+  note: string
+  rowNumber: number
+  rowPosition: number
+  tags: Array<string>
+}
+export type SchemaResponseData = Array<RegisteredSchema>
+export type SchemaResponse = AxiosResponse<SchemaResponseData>
+
+type SchemaPath = { schema_name: string } | { schema_url: string }
+
+const catalogRequest: Promise<Array<RegisteredSchema>> | null = null
+
+/**
+ * Get Schema Catalog
+ */
+export async function getCatalog(): Promise<SchemaResponseData> {
+  const config = useComponentsConfig()
+  if (catalogRequest) {
+    return catalogRequest
+  }
+
+  return await ofetch('api/1/datasets/schemas/', {
+    baseURL: config.apiBase,
+  })
+}
+
+export function findSchemaInCatalog(catalog: Array<RegisteredSchema>, schema: Schema): RegisteredSchema | null {
+  return catalog.find(registeredSchema => schema?.name === registeredSchema.name) || null
+}
+
+export function getSchemaDocumentation(name: string): string {
+  const config = useComponentsConfig()
+  return `${config.schemaDocumentationUrl}${name}/`
+}
+
+export function getSchemaValidationUrl(resource: Resource, registeredSchema: RegisteredSchema): string | null {
+  const config = useComponentsConfig()
+  if (!resource.schema || !resource.schema.name) {
+    return null
+  }
+
+  let schemaPath: SchemaPath = { schema_name: `schema-datagouvfr.${resource.schema.name}` }
+  if (resource.schema && resource.schema.version) {
+    const schemaVersion = resource.schema.version
+    const versionUrl = registeredSchema.versions.find(version => version.version_name === schemaVersion)?.schema_url
+    if (versionUrl) {
+      schemaPath = { schema_url: versionUrl }
+    }
+  }
+  const query = new URLSearchParams({
+    'input': 'url',
+    'url': resource.url,
+    'header-case': 'on',
+    ...schemaPath,
+  }).toString()
+  return `${config.schemaValidataUrl}/table-schema?${query}`
+}

package/src/functions/tabularApi.ts

@@ -0,0 +1,27 @@
+import axios from 'axios'
+import { useComponentsConfig, type PluginConfig } from '../config'
+
+export type SortConfig = {
+  column: string
+  type: string
+} | null
+
+/**
+ * Call Tabular-api to get table content
+ */
+export function getData(config: PluginConfig, id: string, page: number, sortConfig?: SortConfig) {
+  let url = `${config.tabularApiUrl}/api/resources/${id}/data/?page=${page}&page_size=${config.tabularApiPageSize || 20}`
+  if (sortConfig) {
+    url = url + `&${sortConfig.column}__sort=${sortConfig.type}`
+  }
+  return axios.get(url)
+}
+
+/**
+ * Call Tabular-api to get table profile
+ */
+export function getProfile(id: string) {
+  const config = useComponentsConfig()
+
+  return axios.get(`${config.tabularApiUrl}/api/resources/${id}/profile/`)
+}

package/src/functions/users.ts

@@ -0,0 +1,7 @@
+import type { User } from '../types/users'
+import { useComponentsConfig } from '../config'
+
+export function getUserAvatar(user: User, size: number) {
+  const config = useComponentsConfig()
+  return user.avatar_thumbnail || `${config.apiBase}/api/1/avatars/${user.id}/${size}`
+}

package/src/locales/de.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/locales/en.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 "
+}