dfs-adapter 1.0.1 → 1.0.3

package/README.md

@@ -1 +1 @@
-###
+###

package/lib/cos.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Dfs, CosConfig } from "./declare";
 import { VWebApplicationContext } from "vweb-core";
 export default class CosDfs extends Dfs<'cos'> {

package/lib/declare.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { VWebApplicationContext } from "vweb-core";
 export declare interface OssConfig {
     accessKeyId: string;
@@ -59,6 +57,14 @@ export declare interface CosConfig {
     bucket: string;
     access?: string;
 }
+export declare interface SftpConfig {
+    host: string;
+    port?: number;
+    username: string;
+    password: string;
+    saveDir?: string;
+    access: string;
+}
 export declare type ConfigOptionsMap = {
     oss: OssConfig;
     minio: MinioConfig;
@@ -67,6 +73,7 @@ export declare type ConfigOptionsMap = {
     fastdfs: FastdfsConfig;
     obs: ObsConfig;
     cos: CosConfig;
+    sftp: SftpConfig;
 };
 export declare type ConfigOptionsKey = keyof ConfigOptionsMap;
 type ConfigOptionsOptions<T> = T extends ConfigOptionsKey ? {

package/lib/fastdfs.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Dfs, FastdfsConfig } from "./declare";
 import { VWebApplicationContext } from "vweb-core";
 export default class HttpDfs extends Dfs<'fastdfs'> {

package/lib/http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Dfs, HttpConfig } from "./declare";
 import { VWebApplicationContext } from "vweb-core";
 export default class HttpDfs extends Dfs<'http'> {

package/lib/mdfs.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { VWebApplicationContext } from "vweb-core";
 import { ConfigOptionsKey, Dfs, DfsConfig } from "./declare";
 export default class Mdfs extends Dfs<ConfigOptionsKey> {

package/lib/minio.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Dfs, MinioConfig } from "./declare";
 import { VWebApplicationContext } from "vweb-core";
 export default class MinioDfs extends Dfs<'minio'> {

package/lib/minio.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const declare_1 = require("./declare");
 const minio = __importStar(require("minio"));

package/lib/native.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Dfs, NativeConfig } from "./declare";
 import { VWebApplicationContext } from "vweb-core";
 export default class NativeDfs extends Dfs<'native'> {

package/lib/native.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/lib/obs.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Dfs, ObsConfig } from "./declare";
 import { VWebApplicationContext } from "vweb-core";
 export default class ObsDfs extends Dfs<'obs'> {

package/lib/oss.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Dfs, OssConfig } from "./declare";
 import { VWebApplicationContext } from "vweb-core";
 export default class OssDfs extends Dfs<'oss'> {

package/lib/sftp.d.ts

@@ -0,0 +1,12 @@
+import { Dfs, SftpConfig } from "./declare";
+import { VWebApplicationContext } from "vweb-core";
+export default class SftpDfs extends Dfs<'sftp'> {
+    constructor(options: SftpConfig & {
+        type: 'sftp';
+    }, context: VWebApplicationContext);
+    private doSftp;
+    private getSavePath;
+    upload(remotePath: string, buffer: any): Promise<string>;
+    download(remotePath: string): Promise<Buffer>;
+    getAccess(path: string, ...args: any[]): Promise<string>;
+}

package/lib/sftp.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const declare_1 = require("./declare");
+const ssh2_sftp_client_1 = __importDefault(require("ssh2-sftp-client"));
+const path_1 = __importDefault(require("path"));
+class SftpDfs extends declare_1.Dfs {
+    constructor(options, context) {
+        super(options, context);
+        this.options.saveDir = this.options.saveDir || '/tmp';
+        if (this.options.saveDir.endsWith('/')) {
+            this.options.saveDir = this.options.saveDir.substring(0, this.options.saveDir.length - 1);
+        }
+    }
+    async doSftp(apply) {
+        const { host, port = 22, username, password } = this.options;
+        const client = new ssh2_sftp_client_1.default();
+        try {
+            this.timeBegin(`sftp execute`);
+            this.logger.info(`sftp connect ${host}:${port}`);
+            await client.connect({ host, port, username, password });
+            this.logger.info(`sftp connected do execute`);
+            const returnValue = await apply(client);
+            this.logger.info(`sftp execute done ${returnValue}`);
+            return returnValue;
+        }
+        catch (e) {
+            this.logger.error(e.messasge, e);
+        }
+        finally {
+            await client.end();
+            this.timeEnd(`sftp execute`);
+        }
+    }
+    getSavePath(savePath) {
+        if (!savePath.startsWith('/')) {
+            throw new Error('savePath must start with /');
+        }
+        return this.options.saveDir + savePath;
+    }
+    async upload(remotePath, buffer) {
+        return this.doSftp(async (client) => {
+            const savePath = this.getSavePath(remotePath);
+            const { dir } = path_1.default.parse(savePath);
+            if (!await client.exists(dir)) {
+                this.logger.info(`mkdir ${dir}`);
+                await client.mkdir(dir, true);
+            }
+            this.logger.info(`upload <<< ${savePath}`);
+            await client.put(buffer, savePath);
+            const link = await this.getAccess(remotePath);
+            this.logger.info(`upload ${remotePath} >>> ${link}`);
+            return link;
+        });
+    }
+    async download(remotePath) {
+        return this.doSftp(async (client) => {
+            this.logger.info(`download ${this.getSavePath(remotePath)}`);
+            const content = await client.get(this.getSavePath(remotePath));
+            return content;
+        });
+    }
+    async getAccess(path, ...args) {
+        const { access } = this.options;
+        return access ? access + path : path;
+    }
+}
+exports.default = SftpDfs;

package/lib/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/cos.ts","../src/declare.ts","../src/fastdfs.ts","../src/http.ts","../src/index.ts","../src/mdfs.ts","../src/minio.ts","../src/native.ts","../src/obs.ts","../src/oss.ts","../src/sftp.ts"],"version":"5.8.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dfs-adapter",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "oss minio fastdfs native",
   "main": "./lib/index",
   "files": [
@@ -26,18 +26,18 @@
     "@babel/runtime": "^7.16.3",
     "@types/ali-oss": "^6.16.3",
     "@types/node": "^16.11.12",
+    "@types/ssh2-sftp-client": "^9.0.5",
     "ali-oss": "^6.18.1",
     "axios": "^1.6.1",
     "babel-plugin-transform-decorators-legacy": "^1.3.5",
+    "cos-nodejs-sdk-v5": "^2.14.4",
     "esdk-obs-nodejs": "^3.24.3",
     "form-data": "^4.0.0",
     "minio": "^8.0.0",
+    "ssh2-sftp-client": "^12.0.1",
     "vweb-core": "^3.0.14",
     "vweb-mvc": "^1.2.18"
   },
   "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "cos-nodejs-sdk-v5": "^2.14.4"
-  }
+  "license": "ISC"
 }