@data-fair/catalog-sftp 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+# <img alt="Data FAIR logo" src="https://cdn.jsdelivr.net/gh/data-fair/data-fair@master/ui/public/assets/logo.svg" width="40"> @data-fair/catalog-sftp
+
+SFTP plugin for the Data Fair catalogs service.

package/index.ts

@@ -0,0 +1,59 @@
+import type { CatalogPlugin } from '@data-fair/lib-common-types/catalog/index.js'
+import { type SFTPConfig, configSchema, assertConfigValid } from '#types'
+import capabilities from './lib/capabilities.ts'
+
+// Since the plugin is very frequently imported, each function is imported on demand,
+// instead of loading the entire plugin.
+// This file should not contain any code, but only constants and dynamic imports of functions.
+
+const plugin: CatalogPlugin<SFTPConfig, typeof capabilities> = {
+  async prepare ({ catalogConfig, secrets }: { catalogConfig: SFTPConfig, secrets: Record<string, string> }) {
+    switch (catalogConfig.connectionKey.key) {
+      case 'sshKey':
+        if (secrets?.sshKey && catalogConfig.connectionKey.sshKey === '') {
+          delete secrets.sshKey
+        } else {
+          secrets.sshKey = catalogConfig.connectionKey.sshKey
+          catalogConfig.connectionKey.sshKey = '********'
+        }
+        break
+      case 'password':
+        if (secrets?.password && catalogConfig.connectionKey.password === '') {
+          delete secrets.password
+        } else {
+          secrets.password = catalogConfig.connectionKey.password
+          catalogConfig.connectionKey.password = '********'
+        }
+        break
+      default: break
+    }
+    return {
+      catalogConfig,
+      secrets
+    }
+  },
+
+  async list (context) {
+    const { list } = await import('./lib/imports.ts')
+    return list(context)
+  },
+
+  async getResource (context) {
+    const { getResource } = await import('./lib/imports.ts')
+    return getResource(context)
+  },
+
+  async downloadResource (context) {
+    const { downloadResource } = await import('./lib/download.ts')
+    return downloadResource(context)
+  },
+
+  metadata: {
+    title: 'Catalog SFTP',
+    description: 'SFTP plugin for Data Fair Catalog',
+    capabilities
+  },
+  configSchema,
+  assertConfigValid
+}
+export default plugin

package/lib/capabilities.ts

@@ -0,0 +1,9 @@
+/**
+ * The list of capabilities of the plugin.
+ * These capabilities define the actions that can be performed with the plugin.
+ * We add "as const" to ensure the type is a list of literal type, not a list of strings.
+ * This allows TypeScript to check if the plugin has the required funcitons for each capability.
+ */
+export default [
+  'import' as const,
+]

package/lib/download.ts

@@ -0,0 +1,48 @@
+import type { DownloadResourceContext } from '@data-fair/lib-common-types/catalog/index.js'
+import type { SFTPConfig } from '#types'
+import { type Config, NodeSSH } from 'node-ssh'
+
+/**
+ * Downloads a resource (file) from the SFTP server to a temporary directory.
+ *
+ * @param context - The context containing catalog configuration, resource ID, import configuration, and temporary directory path.
+ * @returns The local path to the downloaded file, or `undefined` if the download fails.
+ * @throws Will throw an error if the connection configuration is invalid or not supported.
+ */
+export const downloadResource = async ({ catalogConfig, resourceId, secrets, tmpDir }: DownloadResourceContext<SFTPConfig>) => {
+  const ssh = new NodeSSH()
+
+  const paramsConnection: Config = {
+    host: catalogConfig.url,
+    username: catalogConfig.login,
+    port: catalogConfig.port
+  }
+  if (catalogConfig.connectionKey.key === 'sshKey') {
+    paramsConnection.privateKey = secrets.sshKey
+  } else if (catalogConfig.connectionKey.key === 'password') {
+    paramsConnection.password = secrets.password
+  } else {
+    throw new Error('format non pris en charge')
+  }
+
+  try {
+    await ssh.connect(paramsConnection)
+  } catch (err) {
+    throw new Error('Configuration invalide')
+  }
+
+  const fs = await import('node:fs/promises')
+  resourceId = resourceId.substring(resourceId.indexOf('./') + 2)
+  const destinationPath = tmpDir + '/' + resourceId
+
+  // creation du dossier pour stocker le fichier distant
+  await fs.mkdir(destinationPath.substring(0, destinationPath.lastIndexOf('/')), { recursive: true })
+
+  try {
+    await ssh.getFile(destinationPath, resourceId)
+    return destinationPath
+  } catch (error) {
+    console.error('Error downloading file:', error)
+    throw error
+  }
+}

package/lib/imports.ts

@@ -0,0 +1,129 @@
+import type { SFTPConfig } from '#types'
+import type { SFTPWrapper } from 'ssh2'
+import type capabilities from './capabilities.ts'
+import type { ListContext, Folder, Resource, GetResourceContext } from '@data-fair/lib-common-types/catalog/index.js'
+import { type Config, NodeSSH } from 'node-ssh'
+
+/**
+ * Stores the most recently used SFTP configuration.
+ * This variable holds the last SFTPConfig object that was used,
+ * allowing for reuse or reference in subsequent SFTP operations.
+ */
+let lastConfig: SFTPConfig | undefined
+let lastSecrets: Record<string, string>
+
+/**
+ * Store the ssh instance for SFTP operations.
+ */
+const ssh = new NodeSSH()
+/**
+ * SFTP client instance used for managing SFTP operations.
+ */
+let clientSFTP: SFTPWrapper
+
+/**
+ * Prepares a list of files and folders from the SFTP directory listing.
+ *
+ * @param list - The array of file objects returned by the SFTP `readdir` method.
+ * @param path - The current directory path.
+ * @returns An array of `Folder` or `Resource` objects representing the files and folders.
+ */
+const prepareFiles = (list: any[], path: string): (Folder | Resource)[] => {
+  return list.map((file) => {
+    const pointPos = file.filename.lastIndexOf('.')
+    return {
+      id: path + '/' + file.filename,
+      title: file.filename,
+      type: (file.longname.charAt(0) === 'd') ? 'folder' : 'resource',
+      url: path + '/' + file.filename,
+      format: (pointPos === -1) ? '' : (file.filename.substring(pointPos + 1))
+    }
+  })
+}
+
+/**
+ * Lists the contents of a folder on an SFTP server.
+ *
+ * @param context - The context containing catalog configuration and parameters.
+ * @returns An object containing the count of items, the list of results (folders and resources), and the path as an array of folders.
+ * @throws Will throw an error if the connection configuration is invalid or not supported.
+ */
+export const list = async ({ catalogConfig, secrets, params }: ListContext<SFTPConfig, typeof capabilities>): Promise<{ count: number; results: (Folder | Resource)[]; path: Folder[] }> => {
+  if (!(lastConfig && ssh && clientSFTP) ||
+    JSON.stringify(lastConfig) !== JSON.stringify(catalogConfig) ||
+    JSON.stringify(lastSecrets) !== JSON.stringify(secrets)) {
+    lastConfig = catalogConfig
+    lastSecrets = secrets
+    const paramsConnection: Config = {
+      host: catalogConfig.url,
+      username: catalogConfig.login,
+      port: catalogConfig.port
+    }
+    if (catalogConfig.connectionKey.key === 'sshKey') {
+      paramsConnection.privateKey = secrets.sshKey
+    } else if (catalogConfig.connectionKey.key === 'password') {
+      paramsConnection.password = secrets.password
+    } else {
+      throw new Error('format non pris en charge')
+    }
+
+    try {
+      await ssh.connect(paramsConnection)
+    } catch (err) {
+      console.error(err)
+      lastConfig = undefined
+      throw new Error('Configuration invalide')
+    }
+    clientSFTP = await ssh.requestSFTP()
+  }
+  const path = params.currentFolderId ?? '.'
+  const files: any[] = await new Promise((resolve, reject) => {
+    if (!clientSFTP) {
+      throw new Error('Configuration invalide')
+    }
+    clientSFTP.readdir(path, (err: any, list: any) => {
+      if (err) {
+        console.error('Error reading directory:', err)
+        return reject(err)
+      }
+      resolve(list)
+    })
+  })
+
+  const results = prepareFiles(files, path)
+
+  const pathFolder: Folder[] = []
+  let parentId: string | undefined = (params.currentFolderId?.indexOf('./')) === -1 ? params.currentFolderId : params.currentFolderId?.substring(params.currentFolderId.indexOf('./') + 2)
+  while (parentId && parentId !== '') {
+    pathFolder.unshift({
+      id: parentId,
+      title: parentId.substring(parentId.lastIndexOf('/') + 1),
+      type: 'folder'
+    })
+    parentId = parentId.substring(0, parentId.lastIndexOf('/'))
+  }
+
+  return {
+    count: results.length,
+    results,
+    path: pathFolder
+  }
+}
+
+/**
+ * Retrieves metadata for a specific resource (file) on the SFTP server.
+ *
+ * @param catalogConfig - The SFTP configuration object.
+ * @param resourceId - The identifier (path) of the resource.
+ * @returns A `Resource` object representing the file.
+ */
+export const getResource = async ({ catalogConfig, secrets, resourceId }: GetResourceContext<SFTPConfig>): Promise<Resource> => {
+  const pointPos = resourceId.lastIndexOf('.')
+  return {
+    id: resourceId,
+    title: resourceId.substring(resourceId.lastIndexOf('/') + 1),
+    type: 'resource',
+    format: (pointPos === -1) ? '' : (resourceId.substring(pointPos + 1)),
+    url: resourceId
+  }
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@data-fair/catalog-sftp",
+  "description": "SFTP plugin for the Data Fair catalogs service.",
+  "version": "0.1.0",
+  "main": "index.ts",
+  "type": "module",
+  "scripts": {
+    "build-types": "df-build-types ./",
+    "check-types": "tsc",
+    "lint": "eslint .",
+    "prepare": "husky || true",
+    "test-base": "NODE_ENV=test EVENTS_LOG_LEVEL=alert node --disable-warning=ExperimentalWarning --test-force-exit --test-concurrency=1 --test",
+    "test-only": "npm run test-base -- --test-only test-it/*.ts",
+    "test": "npm run test-base test-it/*.ts",
+    "quality": "npm run lint && npm run build-types && npm run check-types && npm run test && npm audit --omit=dev --audit-level=critical",
+    "prepublishOnly": "npm run build-types"
+  },
+  "files": [
+    "./lib/**",
+    "./types/**",
+    "index.ts"
+  ],
+  "imports": {
+    "#types": "./types/index.ts",
+    "#type/*": "./types/*"
+  },
+  "keywords": [
+    "data-fair-catalogs-plugin"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@data-fair/lib-node": "^2.8.1",
+    "@data-fair/lib-utils": "^1.6.0",
+    "debug": "^4.4.1",
+    "fs-extra": "^11.3.0",
+    "prom-client": "^15.1.3"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.0",
+    "@commitlint/config-conventional": "^19.8.0",
+    "@data-fair/lib-common-types": "^1.11.0",
+    "@data-fair/lib-types-builder": "^1.8.0",
+    "@types/debug": "^4.1.12",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^24.0.3",
+    "@types/ssh2": "^1.15.5",
+    "eslint": "^9.25.1",
+    "husky": "^9.1.7",
+    "neostandard": "^0.12.1",
+    "node-ssh": "^13.2.1",
+    "typescript": "^5.8.3"
+  },
+  "relativeDependencies": {
+    "@data-fair/lib-common-types": "../../lib/packages/common-types"
+  }
+}

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

@@ -0,0 +1,51 @@
+
+export const schemaExports: string[]
+
+// see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
+/**
+ * The host adress
+ */
+export type AdresseDeLHote = string;
+/**
+ * The port of the catalog
+ */
+export type Port = number;
+/**
+ * The user login
+ */
+export type Identifiant = string;
+/**
+ * Le mode de connexion à utiliser (Mot de passe, clé SSH)
+ */
+export type ModeDeConnexion = MotDePasse | CleSHH;
+
+export type SFTPConfig = {
+  url: AdresseDeLHote;
+  port: Port;
+  login: Identifiant;
+  connectionKey: ModeDeConnexion;
+}
+export type MotDePasse = {
+  /**
+   * Enter your account password for the remote server
+   */
+  password: string;
+  key?: "password";
+  [k: string]: unknown;
+}
+export type CleSHH = {
+  key?: "sshKey";
+  /**
+   * Enter your ssh key
+   */
+  sshKey: string;
+  [k: string]: unknown;
+}
+
+
+export declare function validate(data: any): data is SftpConfig
+export declare function assertValid(data: any, options?: import('@data-fair/lib-validation').AssertValidOptions): asserts data is SftpConfig
+export declare function returnValid(data: any, options?: import('@data-fair/lib-validation').AssertValidOptions): SftpConfig
+      
+export declare const schema: any
+        

package/types/catalogConfig/.type/index.js

@@ -0,0 +1,115 @@
+/* eslint-disable */
+
+
+import validate from './validate.js'
+import { assertValid as assertValidGeneric } from '@data-fair/lib-validation'
+
+export const schemaExports = [
+  "types",
+  "validate",
+  "schema"
+]
+
+export { validate } from './validate.js'
+export function assertValid(data, options) {
+  assertValidGeneric(validate, data, options)
+}
+export function returnValid(data, options) {
+  assertValid(data, options)
+  return data
+}
+
+export const schema = {
+  "$id": "https://github.com/data-fair/catalog-udata/catalog-config",
+  "x-exports": [
+    "types",
+    "validate",
+    "schema"
+  ],
+  "title": "SFTPConfig",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "url",
+    "port",
+    "connectionKey",
+    "login"
+  ],
+  "properties": {
+    "url": {
+      "type": "string",
+      "title": "Adresse de l'hôte",
+      "description": "The host adress",
+      "x-i18n-description": {
+        "fr": "L'adresse de l'hôte du catalogue (veuillez vous référez à la documentation technique du catalogue)"
+      },
+      "examples": [
+        "exemple-d-hote.fr"
+      ]
+    },
+    "port": {
+      "type": "integer",
+      "title": "port",
+      "description": "The port of the catalog",
+      "x-i18n-description": {
+        "fr": "Le port de l'API du catalogue (veuillez vous référez à la documentation technique du catalogue)"
+      },
+      "default": 22
+    },
+    "login": {
+      "type": "string",
+      "title": "Identifiant",
+      "description": "The user login",
+      "x-i18n-description": {
+        "fr": "L'identifiant (login) utilisé pour accéder au catalogue"
+      }
+    },
+    "connectionKey": {
+      "type": "object",
+      "title": "Mode de connexion",
+      "description": "Le mode de connexion à utiliser (Mot de passe, clé SSH)",
+      "oneOfLayout": {
+        "label": "Chosir un mode de connexion"
+      },
+      "oneOf": [
+        {
+          "title": "Mot de Passe",
+          "required": [
+            "password"
+          ],
+          "properties": {
+            "password": {
+              "type": "string",
+              "description": "Enter your account password for the remote server",
+              "x-i18n-description": {
+                "fr": "Renseigner le mot de passe associé à votre compte sur le serveur distant"
+              }
+            },
+            "key": {
+              "const": "password"
+            }
+          }
+        },
+        {
+          "title": "Clé SHH",
+          "required": [
+            "sshKey"
+          ],
+          "properties": {
+            "key": {
+              "const": "sshKey"
+            },
+            "sshKey": {
+              "type": "string",
+              "layout": "textarea",
+              "description": "Enter your ssh key",
+              "x-i18n-description": {
+                "fr": "Renseigner le votre clé SSH privée"
+              }
+            }
+          }
+        }
+      ]
+    }
+  }
+}

package/types/catalogConfig/.type/validate.js

@@ -0,0 +1,243 @@
+/* eslint-disable */
+// @ts-nocheck
+
+"use strict";
+export const validate = validate14;
+export default validate14;
+const schema16 = {"$id":"https://github.com/data-fair/catalog-udata/catalog-config","x-exports":["types","validate","schema"],"title":"SFTPConfig","type":"object","additionalProperties":false,"required":["url","port","connectionKey","login"],"properties":{"url":{"type":"string","title":"Adresse de l'hôte","description":"The host adress","x-i18n-description":{"fr":"L'adresse de l'hôte du catalogue (veuillez vous référez à la documentation technique du catalogue)"},"examples":["exemple-d-hote.fr"]},"port":{"type":"integer","title":"port","description":"The port of the catalog","x-i18n-description":{"fr":"Le port de l'API du catalogue (veuillez vous référez à la documentation technique du catalogue)"},"default":22},"login":{"type":"string","title":"Identifiant","description":"The user login","x-i18n-description":{"fr":"L'identifiant (login) utilisé pour accéder au catalogue"}},"connectionKey":{"type":"object","title":"Mode de connexion","description":"Le mode de connexion à utiliser (Mot de passe, clé SSH)","oneOfLayout":{"label":"Chosir un mode de connexion"},"oneOf":[{"title":"Mot de Passe","required":["password"],"properties":{"password":{"type":"string","description":"Enter your account password for the remote server","x-i18n-description":{"fr":"Renseigner le mot de passe associé à votre compte sur le serveur distant"}},"key":{"const":"password"}}},{"title":"Clé SHH","required":["sshKey"],"properties":{"key":{"const":"sshKey"},"sshKey":{"type":"string","layout":"textarea","description":"Enter your ssh key","x-i18n-description":{"fr":"Renseigner le votre clé SSH privée"}}}}]}}};
+
+function validate14(data, {instancePath="", parentData, parentDataProperty, rootData=data}={}){
+/*# sourceURL="https://github.com/data-fair/catalog-udata/catalog-config" */;
+let vErrors = null;
+let errors = 0;
+if(data && typeof data == "object" && !Array.isArray(data)){
+if(data.url === undefined){
+const err0 = {instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: "url"},message:"must have required property '"+"url"+"'"};
+if(vErrors === null){
+vErrors = [err0];
+}
+else {
+vErrors.push(err0);
+}
+errors++;
+}
+if(data.port === undefined){
+const err1 = {instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: "port"},message:"must have required property '"+"port"+"'"};
+if(vErrors === null){
+vErrors = [err1];
+}
+else {
+vErrors.push(err1);
+}
+errors++;
+}
+if(data.connectionKey === undefined){
+const err2 = {instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: "connectionKey"},message:"must have required property '"+"connectionKey"+"'"};
+if(vErrors === null){
+vErrors = [err2];
+}
+else {
+vErrors.push(err2);
+}
+errors++;
+}
+if(data.login === undefined){
+const err3 = {instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: "login"},message:"must have required property '"+"login"+"'"};
+if(vErrors === null){
+vErrors = [err3];
+}
+else {
+vErrors.push(err3);
+}
+errors++;
+}
+for(const key0 in data){
+if(!((((key0 === "url") || (key0 === "port")) || (key0 === "login")) || (key0 === "connectionKey"))){
+const err4 = {instancePath,schemaPath:"#/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key0},message:"must NOT have additional properties"};
+if(vErrors === null){
+vErrors = [err4];
+}
+else {
+vErrors.push(err4);
+}
+errors++;
+}
+}
+if(data.url !== undefined){
+if(typeof data.url !== "string"){
+const err5 = {instancePath:instancePath+"/url",schemaPath:"#/properties/url/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err5];
+}
+else {
+vErrors.push(err5);
+}
+errors++;
+}
+}
+if(data.port !== undefined){
+let data1 = data.port;
+if(!((typeof data1 == "number") && (!(data1 % 1) && !isNaN(data1)))){
+const err6 = {instancePath:instancePath+"/port",schemaPath:"#/properties/port/type",keyword:"type",params:{type: "integer"},message:"must be integer"};
+if(vErrors === null){
+vErrors = [err6];
+}
+else {
+vErrors.push(err6);
+}
+errors++;
+}
+}
+if(data.login !== undefined){
+if(typeof data.login !== "string"){
+const err7 = {instancePath:instancePath+"/login",schemaPath:"#/properties/login/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err7];
+}
+else {
+vErrors.push(err7);
+}
+errors++;
+}
+}
+if(data.connectionKey !== undefined){
+let data3 = data.connectionKey;
+if(!(data3 && typeof data3 == "object" && !Array.isArray(data3))){
+const err8 = {instancePath:instancePath+"/connectionKey",schemaPath:"#/properties/connectionKey/type",keyword:"type",params:{type: "object"},message:"must be object"};
+if(vErrors === null){
+vErrors = [err8];
+}
+else {
+vErrors.push(err8);
+}
+errors++;
+}
+const _errs10 = errors;
+let valid1 = false;
+let passing0 = null;
+const _errs11 = errors;
+if(data3 && typeof data3 == "object" && !Array.isArray(data3)){
+if(data3.password === undefined){
+const err9 = {instancePath:instancePath+"/connectionKey",schemaPath:"#/properties/connectionKey/oneOf/0/required",keyword:"required",params:{missingProperty: "password"},message:"must have required property '"+"password"+"'"};
+if(vErrors === null){
+vErrors = [err9];
+}
+else {
+vErrors.push(err9);
+}
+errors++;
+}
+if(data3.password !== undefined){
+if(typeof data3.password !== "string"){
+const err10 = {instancePath:instancePath+"/connectionKey/password",schemaPath:"#/properties/connectionKey/oneOf/0/properties/password/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err10];
+}
+else {
+vErrors.push(err10);
+}
+errors++;
+}
+}
+if(data3.key !== undefined){
+if("password" !== data3.key){
+const err11 = {instancePath:instancePath+"/connectionKey/key",schemaPath:"#/properties/connectionKey/oneOf/0/properties/key/const",keyword:"const",params:{allowedValue: "password"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err11];
+}
+else {
+vErrors.push(err11);
+}
+errors++;
+}
+}
+}
+var _valid0 = _errs11 === errors;
+if(_valid0){
+valid1 = true;
+passing0 = 0;
+}
+const _errs15 = errors;
+if(data3 && typeof data3 == "object" && !Array.isArray(data3)){
+if(data3.sshKey === undefined){
+const err12 = {instancePath:instancePath+"/connectionKey",schemaPath:"#/properties/connectionKey/oneOf/1/required",keyword:"required",params:{missingProperty: "sshKey"},message:"must have required property '"+"sshKey"+"'"};
+if(vErrors === null){
+vErrors = [err12];
+}
+else {
+vErrors.push(err12);
+}
+errors++;
+}
+if(data3.key !== undefined){
+if("sshKey" !== data3.key){
+const err13 = {instancePath:instancePath+"/connectionKey/key",schemaPath:"#/properties/connectionKey/oneOf/1/properties/key/const",keyword:"const",params:{allowedValue: "sshKey"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err13];
+}
+else {
+vErrors.push(err13);
+}
+errors++;
+}
+}
+if(data3.sshKey !== undefined){
+if(typeof data3.sshKey !== "string"){
+const err14 = {instancePath:instancePath+"/connectionKey/sshKey",schemaPath:"#/properties/connectionKey/oneOf/1/properties/sshKey/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err14];
+}
+else {
+vErrors.push(err14);
+}
+errors++;
+}
+}
+}
+var _valid0 = _errs15 === errors;
+if(_valid0 && valid1){
+valid1 = false;
+passing0 = [passing0, 1];
+}
+else {
+if(_valid0){
+valid1 = true;
+passing0 = 1;
+}
+}
+if(!valid1){
+const err15 = {instancePath:instancePath+"/connectionKey",schemaPath:"#/properties/connectionKey/oneOf",keyword:"oneOf",params:{passingSchemas: passing0},message:"must match exactly one schema in oneOf"};
+if(vErrors === null){
+vErrors = [err15];
+}
+else {
+vErrors.push(err15);
+}
+errors++;
+}
+else {
+errors = _errs10;
+if(vErrors !== null){
+if(_errs10){
+vErrors.length = _errs10;
+}
+else {
+vErrors = null;
+}
+}
+}
+}
+}
+else {
+const err16 = {instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"};
+if(vErrors === null){
+vErrors = [err16];
+}
+else {
+vErrors.push(err16);
+}
+errors++;
+}
+validate14.errors = vErrors;
+return errors === 0;
+}

package/types/catalogConfig/index.ts

@@ -0,0 +1 @@
+export * from './.type/index.js'

package/types/catalogConfig/schema.json

@@ -0,0 +1,94 @@
+{
+  "$id": "https://github.com/data-fair/catalog-udata/catalog-config",
+  "x-exports": [
+    "types",
+    "validate",
+    "schema"
+  ],
+  "title": "SFTPConfig",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "url",
+    "port",
+    "connectionKey",
+    "login"
+  ],
+  "properties": {
+    "url": {
+      "type": "string",
+      "title": "Adresse de l'hôte",
+      "description": "The host adress",
+      "x-i18n-description": {
+        "fr": "L'adresse de l'hôte du catalogue (veuillez vous référez à la documentation technique du catalogue)"
+      },
+      "examples": [
+        "exemple-d-hote.fr"
+      ]
+    },
+    "port": {
+      "type": "integer",
+      "title": "port",
+      "description": "The port of the catalog",
+      "x-i18n-description": {
+        "fr": "Le port de l'API du catalogue (veuillez vous référez à la documentation technique du catalogue)"
+      },
+      "default": 22
+    },
+    "login": {
+      "type": "string",
+      "title": "Identifiant",
+      "description": "The user login",
+      "x-i18n-description": {
+        "fr": "L'identifiant (login) utilisé pour accéder au catalogue"
+      }
+    },
+    "connectionKey": {
+      "type": "object",
+      "title": "Mode de connexion",
+      "description": "Le mode de connexion à utiliser (Mot de passe, clé SSH)",
+      "oneOfLayout": {
+        "label": "Chosir un mode de connexion"
+      },
+      "oneOf": [
+        {
+          "title": "Mot de Passe",
+          "required": [
+            "password"
+          ],
+          "properties": {
+            "password": {
+              "type": "string",
+              "description": "Enter your account password for the remote server",
+              "x-i18n-description": {
+                "fr": "Renseigner le mot de passe associé à votre compte sur le serveur distant"
+              }
+            },
+            "key": {
+              "const": "password"
+            }
+          }
+        },
+        {
+          "title": "Clé SHH",
+          "required": [
+            "sshKey"
+          ],
+          "properties": {
+            "key": {
+              "const": "sshKey"
+            },
+            "sshKey": {
+              "type": "string",
+              "layout": "textarea",
+              "description": "Enter your ssh key",
+              "x-i18n-description": {
+                "fr": "Renseigner le votre clé SSH privée"
+              }
+            }
+          }
+        }
+      ]
+    }
+  }
+}

package/types/index.ts

@@ -0,0 +1 @@
+export { schema as configSchema, assertValid as assertConfigValid, type SFTPConfig } from './catalogConfig/index.ts'