@simplysm/storage 13.0.12 → 13.0.13

package/README.md

@@ -45,10 +45,16 @@ interface StorageConnConfig {
   host: string;   // Server host
   port?: number;  // Port (FTP default: 21, SFTP default: 22)
   user?: string;  // Username
-  pass?: string;  // Password
+  pass?: string;  // Password (required for FTP/FTPS; optional for SFTP)
 }
 ```
 
+**SFTP SSH Key Authentication:**
+- If `pass` is omitted for SFTP connections, the client automatically attempts authentication using:
+  1. SSH key file at `~/.ssh/id_ed25519`
+  2. SSH agent (if `SSH_AUTH_SOCK` environment variable is set)
+  - Both methods are tried in order; if the key file authentication fails (e.g., encrypted keys), the client falls back to agent-only authentication.
+
 ### FileInfo
 
 File/directory information returned by `readdir()`.
@@ -134,7 +140,7 @@ await StorageFactory.connect("ftps", {
 ```
 
 ```typescript
-// SFTP connection
+// SFTP connection with password
 await StorageFactory.connect("sftp", {
   host: "sftp.example.com",
   port: 22,
@@ -152,6 +158,19 @@ await StorageFactory.connect("sftp", {
 });
 ```
 
+```typescript
+// SFTP connection with SSH key (if pass is omitted, uses ~/.ssh/id_ed25519 or SSH agent)
+await StorageFactory.connect("sftp", {
+  host: "sftp.example.com",
+  port: 22,
+  user: "username",
+  // No password provided - uses SSH key authentication
+}, async (client) => {
+  const files = await client.readdir("/remote/path");
+  await client.uploadDir("/local/dir", "/remote/dir");
+});
+```
+
 ### FtpStorageClient (Direct Usage)
 
 Client that uses FTP or FTPS protocol. The `secure` parameter in the constructor determines whether to use FTPS.
@@ -216,6 +235,7 @@ import { SftpStorageClient } from "@simplysm/storage";
 
 const client = new SftpStorageClient();
 
+// Connection with password
 await client.connect({
   host: "sftp.example.com",
   port: 22,
@@ -238,6 +258,25 @@ try {
 }
 ```
 
+```typescript
+// Connection with SSH key (password omitted)
+const client = new SftpStorageClient();
+
+await client.connect({
+  host: "sftp.example.com",
+  port: 22,
+  user: "username",
+  // Uses ~/.ssh/id_ed25519 or SSH agent for authentication
+});
+
+try {
+  await client.put("/local/path/file.txt", "/remote/path/file.txt");
+  // ... other operations
+} finally {
+  await client.close();
+}
+```
+
 ## Important Notes
 
 ### Connection Management

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simplysm/storage",
   "sideEffects": false,
-  "version": "13.0.12",
+  "version": "13.0.13",
   "description": "심플리즘 패키지 - 스토리지 모듈 (node)",
   "author": "김석래",
   "repository": {
@@ -20,7 +20,7 @@
   "dependencies": {
     "basic-ftp": "^5.1.0",
     "ssh2-sftp-client": "^12.0.1",
-    "@simplysm/core-common": "13.0.12"
+    "@simplysm/core-common": "13.0.13"
   },
   "devDependencies": {
     "@types/ssh2-sftp-client": "^9.0.6"