@data-fair/catalog-sftp 0.3.0 → 0.3.2

package/index.ts

@@ -1,36 +1,15 @@
 import type { CatalogPlugin } from '@data-fair/types-catalogs'
 import { type SFTPConfig, configSchema, assertConfigValid } from '#types'
-import capabilities from './lib/capabilities.ts'
+import capabilities, { type SFTPCapabilities } 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
-    }
+const plugin: CatalogPlugin<SFTPConfig, SFTPCapabilities> = {
+  async prepare (context) {
+    const prepare = (await import('./lib/prepare.ts')).default
+    return prepare(context)
   },
 
   async list (context) {

package/lib/capabilities.ts

@@ -1,9 +1,13 @@
+import type { Capability } from '@data-fair/types-catalogs'
+
 /**
  * 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.
+ * The capabilities must satisfy the `Capability` type.
  */
-export default [
-  'import' as const,
-]
+export const capabilities = [
+  'import',
+] satisfies Capability[]
+
+export type SFTPCapabilities = typeof capabilities
+export default capabilities

package/lib/download.ts

@@ -21,7 +21,6 @@ export const getMetaData = async ({ catalogConfig, resourceId }: GetResourceCont
     id: resourceId,
     title: resourceId.substring(resourceId.lastIndexOf('/') + 1),
     format: (pointPos === -1) ? '' : (resourceId.substring(pointPos + 1)),
-    origin: catalogConfig.url + ':' + catalogConfig.port,
     filePath: ''
   }
 }

package/lib/imports.ts

@@ -1,28 +1,11 @@
 import type { SFTPConfig } from '#types'
-import type { FileEntryWithStats, SFTPWrapper } from 'ssh2'
+import type { FileEntryWithStats } from 'ssh2'
 import type capabilities from './capabilities.ts'
 import type { ListContext, Folder, CatalogPlugin } from '@data-fair/types-catalogs'
 import { type Config, NodeSSH } from 'node-ssh'
 
 type ResourceList = Awaited<ReturnType<CatalogPlugin['list']>>['results']
 
-/**
- * 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.
  *
@@ -48,7 +31,6 @@ const prepareFiles = (list: FileEntryWithStats[], path: string): (Folder[] | Res
         description: '',
         format: (pointPos === -1) ? '' : (file.filename.substring(pointPos + 1)),
         mimeType: '',
-        origin: path + '/' + file.filename,
         size: file.attrs.size,
         type: 'resource'
       } as ResourceList[number]
@@ -64,37 +46,33 @@ const prepareFiles = (list: FileEntryWithStats[], path: string): (Folder[] | Res
  * @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>): ReturnType<CatalogPlugin['list']> => {
-  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')
-    }
+  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 ssh = new NodeSSH()
+
+  try {
+    await ssh.connect(paramsConnection)
+  } catch (err) {
+    console.error(err)
+    throw new Error('Configuration invalide')
   }
+  const clientSFTP = await ssh.requestSFTP()
+
   const path = params.currentFolderId ?? '.'
   const files: FileEntryWithStats[] = await new Promise((resolve, reject) => {
     if (!clientSFTP) {
-      throw new Error('Configuration invalide')
+      throw new Error('Configuration invalide (clientSFTP manquant)')
     }
     clientSFTP.readdir(path, (err: any, list: any) => {
       if (err) {

package/lib/prepare.ts

@@ -0,0 +1,56 @@
+import type { SFTPConfig } from '#types'
+import type { PrepareContext } from '@data-fair/types-catalogs'
+import type { SFTPCapabilities } from './capabilities.ts'
+import { type Config, NodeSSH } from 'node-ssh'
+
+export default async ({ catalogConfig, secrets }: PrepareContext<SFTPConfig, SFTPCapabilities>) => {
+  switch (catalogConfig.connectionKey.key) {
+    case 'sshKey':
+      delete secrets.password
+      if (catalogConfig.connectionKey.sshKey === '') {
+        delete secrets.sshKey
+      } else if (catalogConfig.connectionKey.sshKey && catalogConfig.connectionKey.sshKey !== '********') {
+        secrets.sshKey = catalogConfig.connectionKey.sshKey
+        catalogConfig.connectionKey.sshKey = '********'
+      }
+      break
+    case 'password':
+      delete secrets.sshKey
+      if (catalogConfig.connectionKey.password === '') {
+        delete secrets.password
+      } else if (catalogConfig.connectionKey.password && catalogConfig.connectionKey.password !== '********') {
+        secrets.password = catalogConfig.connectionKey.password
+        catalogConfig.connectionKey.password = '********'
+      }
+      break
+    default: break
+  }
+
+  // try the SFTP connection
+  try {
+    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')
+    }
+
+    const ssh = new NodeSSH()
+    await ssh.connect(paramsConnection)
+    ssh.dispose()
+  } catch (error) {
+    console.error('Connection test failed:', error)
+    throw new Error('Connection test failed', { cause: error })
+  }
+
+  return {
+    catalogConfig,
+    secrets
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@data-fair/catalog-sftp",
   "description": "SFTP plugin for the Data Fair catalogs service.",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "main": "index.ts",
   "type": "module",
   "scripts": {

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

@@ -69,7 +69,7 @@ export const schema = {
       "title": "Mode de connexion",
       "description": "Le mode de connexion à utiliser (Mot de passe, clé SSH)",
       "oneOfLayout": {
-        "label": "Chosir un mode de connexion"
+        "label": "Choisir un mode de connexion"
       },
       "oneOf": [
         {
@@ -83,6 +83,12 @@ export const schema = {
               "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"
+              },
+              "layout": {
+                "props": {
+                  "type": "password",
+                  "autocomplete": "new-password"
+                }
               }
             },
             "key": {

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

@@ -4,7 +4,7 @@
 "use strict";
 export const validate = validate14;
 export default validate14;
-const schema16 = {"$id":"https://github.com/data-fair/catalog-sftp/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"}}}}]}}};
+const schema16 = {"$id":"https://github.com/data-fair/catalog-sftp/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":"Choisir 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"},"layout":{"props":{"type":"password","autocomplete":"new-password"}}},"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-sftp/catalog-config" */;

package/types/catalogConfig/schema.json

@@ -1,19 +1,10 @@
 {
   "$id": "https://github.com/data-fair/catalog-sftp/catalog-config",
-  "x-exports": [
-    "types",
-    "validate",
-    "schema"
-  ],
+  "x-exports": ["types", "validate", "schema"],
   "title": "SFTPConfig",
   "type": "object",
   "additionalProperties": false,
-  "required": [
-    "url",
-    "port",
-    "connectionKey",
-    "login"
-  ],
+  "required": ["url", "port", "connectionKey", "login"],
   "properties": {
     "url": {
       "type": "string",
@@ -22,9 +13,7 @@
       "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"
-      ]
+      "examples": ["exemple-d-hote.fr"]
     },
     "port": {
       "type": "integer",
@@ -48,20 +37,24 @@
       "title": "Mode de connexion",
       "description": "Le mode de connexion à utiliser (Mot de passe, clé SSH)",
       "oneOfLayout": {
-        "label": "Chosir un mode de connexion"
+        "label": "Choisir un mode de connexion"
       },
       "oneOf": [
         {
           "title": "Mot de Passe",
-          "required": [
-            "password"
-          ],
+          "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"
+              },
+              "layout": {
+                "props": {
+                  "type": "password",
+                  "autocomplete": "new-password"
+                }
               }
             },
             "key": {
@@ -71,9 +64,7 @@
         },
         {
           "title": "Clé SHH",
-          "required": [
-            "sshKey"
-          ],
+          "required": ["sshKey"],
           "properties": {
             "key": {
               "const": "sshKey"
@@ -91,4 +82,4 @@
       ]
     }
   }
-}
+}