@cadriciel/module-sftp 0.2.0 → 0.3.2

package/package.json

@@ -1,23 +1,31 @@
 {
     "name": "@cadriciel/module-sftp",
-    "version": "0.2.0",
-    "description": "SFTPGo integration module",
+    "version": "0.3.2",
+    "description": "SFTPGo integration module for Cadriciel",
+    "type": "module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
     "scripts": {
-        "build": "tsc"
+        "build": "tsc",
+        "prepublishOnly": "npm run build"
     },
     "dependencies": {
-        "@cadriciel/kernel": "workspace:*",
+        "@cadriciel/kernel": "^0.3.2",
         "axios": "^1.7.0"
     },
     "peerDependencies": {
-        "@cadriciel/module-s3": "^1.0.0",
-        "typescript": "^5.0.0"
+        "@cadriciel/module-s3": "^0.3.2"
     },
     "peerDependenciesMeta": {
         "@cadriciel/module-s3": {
             "optional": true
         }
+    },
+    "devDependencies": {
+        "typescript": "^5.0.0",
+        "@types/node": "^20.11.0"
     }
-}
+}

package/.turbo/turbo-build.log

@@ -1,2 +0,0 @@
-
-$ tsc

package/src/index.ts

@@ -1,29 +0,0 @@
-import type { KernelModule, KernelContext } from '@cadriciel/kernel';
-import { SftpService } from './service.js';
-
-export default {
-    name: 'sftp',
-    dependsOn: ['s3'],
-    order: 8,
-
-    setup(ctx: KernelContext) {
-        ctx.logger?.log('📦 SFTP module loaded');
-
-        // Get S3Service if available
-        const s3Service = ctx.services?.get('s3') as any;
-
-        // Initialize service with config, logger, and optional S3Service
-        const service = new SftpService(ctx.env || process.env, ctx.logger, s3Service);
-
-        ctx.services?.set('sftp', service);
-    },
-    routes(ctx: KernelContext) {
-        const sftpService = ctx.services.get('sftp') as SftpService;
-        if (!sftpService) return;
-
-        ctx.app.use('*', async (c, next) => {
-            (c as any).set('sftp', sftpService);
-            await next();
-        });
-    }
-};

package/src/service.ts

@@ -1,223 +0,0 @@
-import axios, { AxiosInstance } from 'axios';
-
-// S3Service interface (matches @cadriciel/module-s3)
-export interface S3Service {
-    ensureBucket(bucket: string): Promise<void>;
-}
-
-export interface SftpServiceLogger {
-    log(message: string, ...args: any[]): void;
-    info(message: string, ...args: any[]): void;
-    warn(message: string, ...args: any[]): void;
-    error(message: string, ...args: any[]): void;
-}
-
-export interface SftpUserPayload {
-    username: string;
-    password?: string;
-    status?: number;
-    permissions?: any;
-    home_dir?: string;
-    uid?: number;
-    gid?: number;
-    filesystem?: {
-        provider: number;
-        s3config?: any;
-    };
-    id?: number;
-}
-
-export interface SftpS3Config {
-    url: string;
-    region: string;
-    accessKey: string;
-    secretKey: string;
-    bucket: string;
-}
-
-export class SftpService {
-    private client: AxiosInstance;
-    private baseURL: string;
-    private adminUser: string;
-    private adminPassword?: string;
-    private s3Config?: SftpS3Config;
-    private token?: string;
-    private tokenExpiresAt?: number;
-    private s3Service?: S3Service;
-    private logger?: SftpServiceLogger;
-
-    constructor(
-        env: any,
-        logger?: SftpServiceLogger,
-        s3Service?: S3Service
-    ) {
-        this.logger = logger;
-        this.s3Service = s3Service;
-        this.baseURL = env.CADRICIEL_SFTPGO_URL || '';
-        this.adminUser = env.CADRICIEL_SFTPGO_ADMIN_USER || '';
-        this.adminPassword = env.CADRICIEL_SFTPGO_ADMIN_PASSWORD;
-
-        // S3 config for SFTPGo users (may differ from main S3)
-        if (env.CADRICIEL_SFTPGO_S3_URL && env.CADRICIEL_SFTPGO_S3_ACCESS_KEY) {
-            this.s3Config = {
-                url: env.CADRICIEL_SFTPGO_S3_URL,
-                region: env.CADRICIEL_SFTPGO_S3_REGION || "us-east-1",
-                accessKey: env.CADRICIEL_SFTPGO_S3_ACCESS_KEY,
-                secretKey: env.CADRICIEL_SFTPGO_S3_SECRET_KEY,
-                bucket: env.CADRICIEL_SFTPGO_S3_BUCKET,
-            };
-        }
-
-        if (this.baseURL && this.adminUser && this.adminPassword) {
-            this.logger?.info(`SftpGoService initialized with URL: ${this.baseURL}`);
-        } else {
-            this.logger?.warn("SftpGo configuration missing (CADRICIEL_SFTPGO_URL, CADRICIEL_SFTPGO_ADMIN_USER, CADRICIEL_SFTPGO_ADMIN_PASSWORD)");
-        }
-
-        this.client = axios.create({
-            baseURL: this.baseURL,
-            timeout: 10000,
-        });
-
-        if (this.s3Config) {
-            this.logger?.info(`SFTP S3 backend configured for bucket: ${this.s3Config.bucket}`);
-        }
-    }
-
-    private async ensureBucketExists(): Promise<void> {
-        if (!this.s3Config) return;
-
-        // Use S3Service if available, otherwise skip (SFTPGo will handle it)
-        if (this.s3Service) {
-            try {
-                await this.s3Service.ensureBucket(this.s3Config.bucket);
-            } catch (error: any) {
-                this.logger?.error(`Error ensuring bucket ${this.s3Config.bucket}:`, error.message);
-            }
-        }
-    }
-
-    private async ensureAuth(): Promise<void> {
-        const now = Date.now();
-        const safetyMargin = 60 * 1000;
-
-        if (this.token && this.tokenExpiresAt && (this.tokenExpiresAt - now > safetyMargin)) {
-            return;
-        }
-
-        try {
-            const auth = Buffer.from(`${this.adminUser}:${this.adminPassword}`).toString('base64');
-            const response = await this.client.get("/api/v2/token", {
-                headers: {
-                    Authorization: `Basic ${auth}`
-                }
-            });
-
-            this.token = response.data.access_token;
-            this.tokenExpiresAt = new Date(response.data.expires_at).getTime();
-        } catch (error: any) {
-            this.logger?.error("SFTPGo Authentication Error:", error.message);
-            throw new Error(`Cannot authenticate with SFTPGo: ${error.message}`);
-        }
-    }
-
-    async createUser(username: string, password?: string): Promise<any> {
-        await this.ensureAuth();
-
-        let userPayload: SftpUserPayload = {
-            username: username,
-            password: password,
-            status: 1,
-            permissions: {
-                "/": ["*"]
-            }
-        };
-
-        if (this.s3Config) {
-            await this.ensureBucketExists();
-
-            // Replace localhost with minio for Docker networking
-            let sftpGoEndpoint = this.s3Config.url;
-            if (sftpGoEndpoint.includes("localhost")) {
-                sftpGoEndpoint = sftpGoEndpoint.replace("localhost", "minio");
-            }
-
-            userPayload.filesystem = {
-                provider: 1, // S3
-                s3config: {
-                    bucket: this.s3Config.bucket,
-                    region: this.s3Config.region,
-                    access_key: this.s3Config.accessKey,
-                    access_secret: {
-                        status: "Plain",
-                        payload: this.s3Config.secretKey
-                    },
-                    endpoint: sftpGoEndpoint,
-                    key_prefix: `${username}/`,
-                    force_path_style: true
-                }
-            };
-            userPayload.home_dir = `/srv/sftpgo/data/${username}`;
-        } else {
-            userPayload.home_dir = `/srv/sftpgo/data/${username}`;
-            userPayload.uid = 0;
-            userPayload.gid = 0;
-        }
-
-        try {
-            const response = await this.client.post("/api/v2/users", userPayload, {
-                headers: { Authorization: `Bearer ${this.token}` }
-            });
-            this.logger?.info(`SFTPGo user created: ${username}`);
-            return response.data;
-        } catch (error: any) {
-            if (error.response?.status === 409) {
-                this.logger?.info(`User ${username} already exists, updating...`);
-                return this.updateUser(username, userPayload);
-            }
-            throw error;
-        }
-    }
-
-    async updateUser(username: string, userPayload: SftpUserPayload): Promise<any> {
-        await this.ensureAuth();
-        const id = await this.getUserId(username);
-        if (id) userPayload.id = id;
-
-        try {
-            const response = await this.client.put(`/api/v2/users/${id || username}`, userPayload, {
-                headers: { Authorization: `Bearer ${this.token}` }
-            });
-            this.logger?.info(`SFTPGo user updated: ${username}`);
-            return response.data;
-        } catch (error: any) {
-            this.logger?.error(`Error updating SFTPGo user ${username}:`, error.message);
-            throw error;
-        }
-    }
-
-    async getUserId(username: string): Promise<number | null> {
-        try {
-            const response = await this.client.get(`/api/v2/users/${username}`, {
-                headers: { Authorization: `Bearer ${this.token}` }
-            });
-            return response.data.id;
-        } catch (e) {
-            return null;
-        }
-    }
-
-    async deleteUser(username: string): Promise<void> {
-        await this.ensureAuth();
-        try {
-            await this.client.delete(`/api/v2/users/${username}`, {
-                headers: { Authorization: `Bearer ${this.token}` }
-            });
-            this.logger?.info(`SFTPGo user deleted: ${username}`);
-        } catch (error: any) {
-            if (error.response?.status === 404) return;
-            this.logger?.error(`Error deleting SFTPGo user ${username}:`, error.message);
-            throw error;
-        }
-    }
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2022",
-        "module": "ESNext",
-        "moduleResolution": "Node",
-        "outDir": "./dist",
-        "rootDir": "./src",
-        "strict": true,
-        "declaration": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "forceConsistentCasingInFileNames": true
-    },
-    "include": [
-        "src/**/*"
-    ]
-}