@data-fair/catalog-sftp 0.2.0 → 0.3.1

package/index.ts

@@ -1,4 +1,4 @@
-import type { CatalogPlugin } from '@data-fair/lib-common-types/catalog/index.js'
+import type { CatalogPlugin } from '@data-fair/types-catalogs'
 import { type SFTPConfig, configSchema, assertConfigValid } from '#types'
 import capabilities from './lib/capabilities.ts'
 
@@ -39,15 +39,10 @@ const plugin: CatalogPlugin<SFTPConfig, typeof capabilities> = {
   },
 
   async getResource (context) {
-    const { getResource } = await import('./lib/imports.ts')
+    const { getResource } = await import('./lib/download.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',

package/lib/download.ts

@@ -1,7 +1,31 @@
-import type { DownloadResourceContext } from '@data-fair/lib-common-types/catalog/index.js'
 import type { SFTPConfig } from '#types'
+import type { CatalogPlugin, GetResourceContext, Resource } from '@data-fair/types-catalogs'
 import { type Config, NodeSSH } from 'node-ssh'
 
+/**
+ * Download localy a specific resource from a SFTP server, and retrieves the metadata with the filepath of the downloaded file.
+ *
+ * @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 (context: GetResourceContext<SFTPConfig>): ReturnType<CatalogPlugin['getResource']> => {
+  const resource = await getMetaData(context)
+  resource.filePath = await downloadResource(context)
+  return resource
+}
+
+export const getMetaData = async ({ catalogConfig, resourceId }: GetResourceContext<SFTPConfig>): Promise<Resource> => {
+  const pointPos = resourceId.lastIndexOf('.')
+  return {
+    id: resourceId,
+    title: resourceId.substring(resourceId.lastIndexOf('/') + 1),
+    format: (pointPos === -1) ? '' : (resourceId.substring(pointPos + 1)),
+    origin: catalogConfig.url + ':' + catalogConfig.port,
+    filePath: ''
+  }
+}
+
 /**
  * Downloads a resource (file) from the SFTP server to a temporary directory.
  *
@@ -9,7 +33,7 @@ import { type Config, NodeSSH } from 'node-ssh'
  * @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 downloadResource = async ({ catalogConfig, resourceId, secrets, tmpDir }:GetResourceContext<SFTPConfig>) => {
   const ssh = new NodeSSH()
 
   const paramsConnection: Config = {
@@ -31,12 +55,12 @@ export const downloadResource = async ({ catalogConfig, resourceId, secrets, tmp
     throw new Error('Configuration invalide')
   }
 
-  const fs = await import('node:fs/promises')
+  // const fs = await import('node:fs/promises')
   resourceId = resourceId.substring(resourceId.indexOf('./') + 2)
-  const destinationPath = tmpDir + '/' + resourceId
+  const destinationPath = tmpDir + '/' + resourceId.substring(resourceId.lastIndexOf('/') + 1)
 
   // creation du dossier pour stocker le fichier distant
-  await fs.mkdir(destinationPath.substring(0, destinationPath.lastIndexOf('/')), { recursive: true })
+  // await fs.mkdir(destinationPath.substring(0, destinationPath.lastIndexOf('/')), { recursive: true })
 
   try {
     await ssh.getFile(destinationPath, resourceId)

package/lib/imports.ts

@@ -1,9 +1,11 @@
 import type { SFTPConfig } from '#types'
 import type { FileEntryWithStats, 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 { 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,
@@ -26,18 +28,30 @@ let clientSFTP: SFTPWrapper
  *
  * @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.
+ * @returns An array of `Folder` or `ResourceList` objects representing the files and folders.
  */
-const prepareFiles = (list: FileEntryWithStats[], path: string): (Folder | Resource)[] => {
-  return list.map((file : FileEntryWithStats) => {
+const prepareFiles = (list: FileEntryWithStats[], path: string): (Folder[] | ResourceList) => {
+  return list.map((file: FileEntryWithStats) => {
     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)),
-      size: file.attrs.size
+    if (file.longname.charAt(0) === 'd') {
+      // Folder
+      return {
+        id: path + '/' + file.filename,
+        title: file.filename,
+        type: 'folder'
+      } as Folder
+    } else {
+      // ResourceList
+      return {
+        id: path + '/' + file.filename,
+        title: file.filename,
+        description: '',
+        format: (pointPos === -1) ? '' : (file.filename.substring(pointPos + 1)),
+        mimeType: '',
+        origin: path + '/' + file.filename,
+        size: file.attrs.size,
+        type: 'resource'
+      } as ResourceList[number]
     }
   })
 }
@@ -49,7 +63,7 @@ const prepareFiles = (list: FileEntryWithStats[], path: string): (Folder | Resou
  * @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[] }> => {
+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)) {
@@ -110,21 +124,3 @@ export const list = async ({ catalogConfig, secrets, params }: ListContext<SFTPC
     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

@@ -1,7 +1,7 @@
 {
   "name": "@data-fair/catalog-sftp",
   "description": "SFTP plugin for the Data Fair catalogs service.",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "main": "index.ts",
   "type": "module",
   "scripts": {
@@ -39,7 +39,7 @@
   "devDependencies": {
     "@commitlint/cli": "^19.8.0",
     "@commitlint/config-conventional": "^19.8.0",
-    "@data-fair/lib-common-types": "^1.11.0",
+    "@data-fair/types-catalogs": "^0.1.0",
     "@data-fair/lib-types-builder": "^1.8.0",
     "@types/debug": "^4.1.12",
     "@types/fs-extra": "^11.0.4",
@@ -49,8 +49,5 @@
     "husky": "^9.1.7",
     "neostandard": "^0.12.1",
     "typescript": "^5.8.3"
-  },
-  "relativeDependencies": {
-    "@data-fair/lib-common-types": "../../lib/packages/common-types"
   }
 }

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

@@ -20,7 +20,7 @@ export function returnValid(data, options) {
 }
 
 export const schema = {
-  "$id": "https://github.com/data-fair/catalog-udata/catalog-config",
+  "$id": "https://github.com/data-fair/catalog-sftp/catalog-config",
   "x-exports": [
     "types",
     "validate",
@@ -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,10 +4,10 @@
 "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"}}}}]}}};
+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-udata/catalog-config" */;
+/*# sourceURL="https://github.com/data-fair/catalog-sftp/catalog-config" */;
 let vErrors = null;
 let errors = 0;
 if(data && typeof data == "object" && !Array.isArray(data)){

package/types/catalogConfig/schema.json

@@ -1,19 +1,10 @@
 {
-  "$id": "https://github.com/data-fair/catalog-udata/catalog-config",
-  "x-exports": [
-    "types",
-    "validate",
-    "schema"
-  ],
+  "$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"
-  ],
+  "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 @@
       ]
     }
   }
-}
+}