@data-fair/catalog-data-fair 0.2.1 → 0.2.3

package/index.ts

@@ -12,7 +12,7 @@ const plugin: CatalogPlugin<DataFairConfig, DataFairCapabilities> = {
     return prepare(context)
   },
 
-  async listResources (context) {
+  async list (context) {
     const { listResources } = await import('./lib/imports.ts')
     return listResources(context)
   },

package/lib/download.ts

@@ -71,6 +71,8 @@ const getMetaData = async ({ catalogConfig, resourceId, log, secrets }: GetResou
     frequency: dataset.frequency,
     image: dataset.image,
     keywords: dataset.keywords,
+    analysis: dataset.analysis,
+    projection: dataset.projection,
     size,
     schema: dataset.schema,
     filePath: '',
@@ -181,7 +183,7 @@ const downloadResourceFile = async (filePath: string, { catalogConfig, resourceI
  * @throws If there is an error writing the file or fetching the dataset.
  */
 const downloadResourceLines = async (destFile: string, { catalogConfig, resourceId, importConfig, secrets, log }: GetResourceContext<DataFairConfig> & { importConfig: ImportConfig }): Promise<void> => {
-  let url: string | null = `${catalogConfig.url}/data-fair/api/v1/datasets/${resourceId}/lines?format=csv&size=5000`
+  let url: string | null = `${catalogConfig.url}/data-fair/api/v1/datasets/${resourceId}/lines?format=csv&size=10000`
 
   if (importConfig.fields) {
     url += '&select=' + importConfig.fields.map(field => field.key).join(',')

package/lib/imports.ts

@@ -1,12 +1,11 @@
 import type { DataFairCatalog, DataFairDataset, DataFairConfig } from '#types'
 import axios from '@data-fair/lib-node/axios.js'
-import type { CatalogPlugin, ListResourcesContext } from '@data-fair/types-catalogs'
+import type { CatalogPlugin, ListContext } from '@data-fair/types-catalogs'
 import type { DataFairCapabilities } from './capabilities.ts'
 
-type ResourceList = Awaited<ReturnType<CatalogPlugin['listResources']>>['results']
+type ResourceList = Awaited<ReturnType<CatalogPlugin['list']>>['results']
 
 /**
- * Transform an ODS catalog into a Data Fair catalog
  * @param dataFairDataset the dataset to transform
  * @returns an object containing the count of resources, the transformed resources, and an empty path array
  */
@@ -36,8 +35,8 @@ const prepareCatalog = (dataFairDatasets: DataFairDataset[]): ResourceList => {
  * @param config the Data Fair configuration
  * @returns the list of Resources available on this catalog
  */
-export const listResources = async (config: ListResourcesContext<DataFairConfig, DataFairCapabilities>): ReturnType<CatalogPlugin<DataFairConfig>['listResources']> => {
-  const dataFairParams: Record<string, any> = {}
+export const listResources = async (config: ListContext<DataFairConfig, DataFairCapabilities>): ReturnType<CatalogPlugin<DataFairConfig>['list']> => {
+  const dataFairParams: Record<string, any> = { sort: 'title' }
   if (config.params?.q) dataFairParams.q = config.params.q
   if (config.params?.size) dataFairParams.size = config.params.size
   if (config.params?.page) dataFairParams.page = config.params.page

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@data-fair/catalog-data-fair",
   "description": "A simple Data Fair plugin for the Data Fair catalogs service.",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "main": "index.ts",
   "type": "module",
   "scripts": {
@@ -38,7 +38,7 @@
     "@commitlint/cli": "^19.8.0",
     "@commitlint/config-conventional": "^19.8.0",
     "@data-fair/lib-types-builder": "^1.8.0",
-    "@data-fair/types-catalogs": "^0.3.0",
+    "@data-fair/types-catalogs": "^0.5.1",
     "@types/nock": "^10.0.3",
     "chalk": "^5.4.1",
     "dayjs": "^1.11.13",

package/types/datafairSchemas/.type/index.d.ts

@@ -101,6 +101,15 @@ export type DataFairDataset = {
     | "daily"
     | "continuous"
     | "irregular";
+  analysis?: {
+    escapeKeyAlgorithm?: "compat-ods";
+    [k: string]: unknown;
+  };
+  projection?: {
+    code?: string;
+    title?: string;
+    [k: string]: unknown;
+  };
   file?: {
     /**
      * Size of the file on disk

package/types/datafairSchemas/schema.json

@@ -81,6 +81,22 @@
             "irregular"
           ]
         },
+        "analysis": {
+          "type": "object",
+          "properties": {
+            "escapeKeyAlgorithm": {
+              "type": "string",
+                "enum": ["compat-ods"]
+            }
+          }
+        },
+        "projection": {
+          "type": "object",
+          "properties": {
+            "code": { "type": "string" },
+            "title": { "type": "string" }
+          }
+        },
         "file": {
           "type": "object",
           "required": [