feature(storage-sftp): add sftp (ssh) storage adapter

deepkit · Oct 10, 2023 · ea98b7e · ea98b7e
1 parent 926fe59
commit ea98b7e
Show file tree

Hide file tree

Showing 14 changed files with 474 additions and 11 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -19,6 +19,11 @@ jobs:
             ports:
                 - "20-21:20-21"
                 - "40000-40009:40000-40009"
+        storage-sftp:
+            image: atmoz/sftp:alpine
+            ports:
+                - "22:22"
+            options: user:123:::upload
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

diff --git a/packages/storage-ftp/src/ftp-adapter.ts b/packages/storage-ftp/src/ftp-adapter.ts
@@ -275,7 +275,6 @@ export class StorageFtpAdapter implements StorageAdapter {
 
         await this.chmodRecursive(path, permission);
     }
-
 }
 
 /**

diff --git a/packages/storage-ftp/tests/storage.spec.ts b/packages/storage-ftp/tests/storage.spec.ts
@@ -9,7 +9,8 @@ setAdapterFactory(async () => {
         host: 'localhost',
         user: 'user',
         password: '123',
-    });;
+    });
+
     if (platform() === 'darwin') {
         // docker run -d --name storage-ftp -p 20-21:20-21 -p 40000-40009:40000-40009 --env FTP_USER=user --env FTP_PASS=123 garethflowers/ftp-server
         adapter = new StorageFtpAdapter({

diff --git a/packages/storage-sftp/.npmignore b/packages/storage-sftp/.npmignore
@@ -0,0 +1 @@
+tests
diff --git a/packages/storage-sftp/README.md b/packages/storage-sftp/README.md
@@ -0,0 +1 @@
+# Deepkit SFTP (SSH) Storage adapter
diff --git a/packages/storage-sftp/dist/.gitkeep b/packages/storage-sftp/dist/.gitkeep
diff --git a/packages/storage-sftp/index.ts b/packages/storage-sftp/index.ts
@@ -0,0 +1 @@
+export * from './src/ftp-adapter.js';
diff --git a/packages/storage-sftp/package.json b/packages/storage-sftp/package.json
@@ -0,0 +1,51 @@
+{
+  "name": "@deepkit/storage-fstp",
+  "version": "1.0.1-alpha.13",
+  "description": "Deepkit storage adapter for sFTP (via SSH)",
+  "private": true,
+  "type": "commonjs",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/cjs/index.d.ts",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    }
+  },
+  "repository": "https://github.com/deepkit/deepkit-framework",
+  "author": "Marc J. Schmidt <[email protected]>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "echo '{\"type\": \"module\"}' > ./dist/esm/package.json"
+  },
+  "dependencies": {
+    "ssh2-sftp-client": "^9.1.0"
+  },
+  "devDependencies": {
+    "@deepkit/storage": "^1.0.1-alpha.13",
+    "@types/ssh2-sftp-client": "^9.0.1"
+  },
+  "jest": {
+    "runner": "../../jest-serial-runner.js",
+    "testEnvironment": "node",
+    "transform": {
+      "^.+\\.(ts|tsx)$": [
+        "ts-jest",
+        {
+          "tsconfig": "<rootDir>/tsconfig.json"
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "(.+)\\.js": "$1"
+    },
+    "testMatch": [
+      "**/tests/**/*.spec.ts"
+    ]
+  }
+}