@simplysm/storage 13.0.77 → 13.0.80

package/README.md

@@ -1,265 +1,160 @@
 # @simplysm/storage
 
-Simplysm Package - Storage Module (node)
+> Simplysm Package - Storage Module (node)
 
-Provides FTP, FTPS, and SFTP storage clients with a unified interface, plus a factory for connection management.
+A unified storage client library for Node.js that provides a consistent API for FTP, FTPS, and SFTP file operations. The factory pattern with automatic connection management makes it easy to perform remote file operations without worrying about connection lifecycle. Internally uses [basic-ftp](https://www.npmjs.com/package/basic-ftp) for FTP/FTPS and [ssh2-sftp-client](https://www.npmjs.com/package/ssh2-sftp-client) for SFTP.
 
-## Installation
+## API Reference
 
-```bash
-pnpm add @simplysm/storage
-```
-
-## Main Modules
-
-### Types
-
-#### `StorageConnConfig`
+### StorageProtocol
 
-Connection configuration shared by all storage clients.
-
-```ts
-import { StorageConnConfig } from "@simplysm/storage";
-
-const config: StorageConnConfig = {
-  host: "storage.example.com",
-  port: 22,        // optional — defaults to the protocol default
-  user: "admin",   // optional
-  pass: "secret",  // optional
-};
+```typescript
+type StorageProtocol = "ftp" | "ftps" | "sftp";
 ```
 
-| Property | Type     | Required | Description                              |
-| -------- | -------- | -------- | ---------------------------------------- |
-| `host`   | `string` | yes      | Hostname or IP address of the server     |
-| `port`   | `number` | no       | Port number (defaults to protocol default) |
-| `user`   | `string` | no       | Username for authentication              |
-| `pass`   | `string` | no       | Password for authentication              |
+Union type representing the supported storage protocols.
 
 ---
 
-#### `FileInfo`
-
-Describes a single entry returned by `readdir`.
+### StorageConnConfig
 
-```ts
-import { FileInfo } from "@simplysm/storage";
-
-// Example entry
-const entry: FileInfo = { name: "report.pdf", isFile: true };
+```typescript
+interface StorageConnConfig {
+  host: string;
+  port?: number;
+  user?: string;
+  password?: string;
+}
 ```
 
-| Property | Type      | Description                                  |
-| -------- | --------- | -------------------------------------------- |
-| `name`   | `string`  | File or directory name (not the full path)   |
-| `isFile` | `boolean` | `true` if it is a file, `false` if directory |
+Connection configuration shared across all protocols. When `password` is omitted for SFTP, authentication falls back to SSH agent and `~/.ssh/id_ed25519` key file.
 
 ---
 
-#### `Storage`
-
-The unified storage interface implemented by all client classes. Use this type when writing code that is protocol-agnostic.
-
-```ts
-import { Storage } from "@simplysm/storage";
+### FileInfo
 
-async function uploadFile(storage: Storage, localPath: string, remotePath: string) {
-  await storage.put(localPath, remotePath);
+```typescript
+interface FileInfo {
+  name: string;
+  isFile: boolean;
 }
 ```
 
-| Method                                                        | Returns               | Description                                                   |
-| ------------------------------------------------------------- | --------------------- | ------------------------------------------------------------- |
-| `connect(config: StorageConnConfig)`                          | `Promise<void>`       | Open a connection to the server                               |
-| `mkdir(dirPath: string)`                                      | `Promise<void>`       | Create a directory (including parents)                        |
-| `rename(fromPath: string, toPath: string)`                    | `Promise<void>`       | Rename or move a remote path                                  |
-| `readdir(dirPath: string)`                                    | `Promise<FileInfo[]>` | List entries in a directory                                   |
-| `readFile(filePath: string)`                                  | `Promise<Bytes>`      | Download a file as raw bytes                                  |
-| `exists(filePath: string)`                                    | `Promise<boolean>`    | Check whether a path exists                                   |
-| `put(localPathOrBuffer: string \| Bytes, storageFilePath: string)` | `Promise<void>` | Upload a local file path or byte buffer to the remote path    |
-| `uploadDir(fromPath: string, toPath: string)`                 | `Promise<void>`       | Upload an entire local directory to a remote path             |
-| `remove(filePath: string)`                                    | `Promise<void>`       | Delete a remote file                                          |
-| `close()`                                                     | `Promise<void>`       | Close the connection                                          |
+Represents a file or directory entry returned by `list()`.
 
 ---
 
-#### `StorageType`
-
-Union type that identifies the storage protocol.
-
-```ts
-import { StorageType } from "@simplysm/storage";
-
-const type: StorageType = "sftp"; // "ftp" | "ftps" | "sftp"
+### StorageClient
+
+```typescript
+interface StorageClient {
+  connect(config: StorageConnConfig): Promise<void>;
+  mkdir(dirPath: string): Promise<void>;
+  rename(fromPath: string, toPath: string): Promise<void>;
+  list(dirPath: string): Promise<FileInfo[]>;
+  readFile(filePath: string): Promise<Bytes>;
+  exists(filePath: string): Promise<boolean>;
+  put(localPathOrBuffer: string | Bytes, storageFilePath: string): Promise<void>;
+  uploadDir(fromPath: string, toPath: string): Promise<void>;
+  remove(filePath: string): Promise<void>;
+  close(): Promise<void>;
+}
 ```
 
-| Value    | Protocol                        |
-| -------- | ------------------------------- |
-| `"ftp"`  | Plain FTP                       |
-| `"ftps"` | FTP with TLS/SSL (explicit)     |
-| `"sftp"` | SSH File Transfer Protocol      |
+Common interface implemented by all storage clients. Using `StorageFactory.connect()` is recommended over calling these methods directly, as it manages the connection lifecycle automatically.
+
+| Method | Description |
+|--------|-------------|
+| `connect` | Open a connection to the remote server. |
+| `mkdir` | Create a directory, including parent directories. |
+| `rename` | Rename or move a remote file/directory. |
+| `list` | List entries in a remote directory. |
+| `readFile` | Read the contents of a remote file as `Bytes`. |
+| `exists` | Check whether a remote file or directory exists. |
+| `put` | Upload a local file path or byte data to a remote path. |
+| `uploadDir` | Upload an entire local directory to a remote path. |
+| `remove` | Delete a remote file. |
+| `close` | Close the connection. Safe to call when already closed. |
 
 ---
 
-### Clients
+### StorageFactory
 
-#### `FtpStorageClient`
+```typescript
+class StorageFactory {
+  static connect<R>(
+    type: StorageProtocol,
+    config: StorageConnConfig,
+    fn: (storage: StorageClient) => R | Promise<R>,
+  ): Promise<R>;
+}
+```
 
-Storage client for FTP and FTPS. Implements `Storage`.
+Factory class that creates protocol-specific clients and manages the connection lifecycle. The `connect` method opens a connection, passes the client to the callback, and guarantees the connection is closed afterwards (even if the callback throws).
 
-The constructor accepts a `secure` boolean that selects FTPS when `true` (default `false`).
-Using `StorageFactory.connect` is recommended over direct instantiation.
+---
 
-```ts
-import { FtpStorageClient } from "@simplysm/storage";
+### FtpStorageClient
 
-// Plain FTP
-const client = new FtpStorageClient();
+```typescript
+class FtpStorageClient implements StorageClient {
+  constructor(secure?: boolean);
+}
+```
 
-// FTPS
-const secureClient = new FtpStorageClient(true);
+FTP/FTPS storage client built on [basic-ftp](https://www.npmjs.com/package/basic-ftp). Pass `true` for the `secure` parameter to use FTPS. Using `StorageFactory.connect()` is recommended over direct instantiation.
 
-await client.connect({ host: "ftp.example.com", user: "user", pass: "pass" });
+---
 
-try {
-  const entries = await client.readdir("/uploads");
-  console.log(entries);
+### SftpStorageClient
 
-  await client.put("/local/file.txt", "/uploads/file.txt");
-  const exists = await client.exists("/uploads/file.txt");
-  console.log(exists); // true
-} finally {
-  await client.close();
+```typescript
+class SftpStorageClient implements StorageClient {
 }
 ```
 
-**Constructor**
+SFTP storage client built on [ssh2-sftp-client](https://www.npmjs.com/package/ssh2-sftp-client). When no password is provided, authenticates via SSH agent or `~/.ssh/id_ed25519` key file. Using `StorageFactory.connect()` is recommended over direct instantiation.
 
-```ts
-new FtpStorageClient(secure?: boolean)
-```
+---
 
-| Parameter | Type      | Default | Description                              |
-| --------- | --------- | ------- | ---------------------------------------- |
-| `secure`  | `boolean` | `false` | `true` to use FTPS (TLS), `false` for FTP |
-
-**Methods** — all defined by the `Storage` interface.
-
-| Method         | Notes                                                                                               |
-| -------------- | --------------------------------------------------------------------------------------------------- |
-| `connect`      | Throws if already connected. Use `StorageFactory.connect` to avoid manual lifecycle management.     |
-| `mkdir`        | Creates parent directories automatically.                                                           |
-| `rename`       | Renames or moves a remote path.                                                                     |
-| `readdir`      | Returns a list of `FileInfo` entries for the given directory.                                       |
-| `readFile`     | Downloads and returns file content as `Bytes`.                                                      |
-| `exists`       | Uses `size()` for files (O(1)) and `list()` for directories. Returns `false` on any error.          |
-| `put`          | Accepts a local file path string or a `Bytes` buffer.                                               |
-| `uploadDir`    | Recursively uploads a local directory.                                                              |
-| `remove`       | Deletes a remote file.                                                                              |
-| `close`        | Safe to call when already closed. Can reconnect on the same instance after closing.                 |
+## Usage Examples
 
----
+### Recommended: Using StorageFactory (auto-managed connection)
 
-#### `SftpStorageClient`
+```typescript
+import { StorageFactory } from "@simplysm/storage";
 
-Storage client for SFTP (SSH File Transfer Protocol). Implements `Storage`.
+// Upload a file via SFTP
+await StorageFactory.connect("sftp", { host: "example.com", user: "deploy" }, async (storage) => {
+  await storage.mkdir("/uploads/2024");
+  await storage.put("/local/path/file.txt", "/uploads/2024/file.txt");
+});
+
+// List files via FTP
+const files = await StorageFactory.connect("ftp", { host: "ftp.example.com", user: "admin", password: "secret" }, async (storage) => {
+  return await storage.list("/data");
+});
+
+// Upload a directory via FTPS
+await StorageFactory.connect("ftps", { host: "secure.example.com", user: "admin", password: "secret" }, async (storage) => {
+  await storage.uploadDir("/local/dist", "/remote/dist");
+});
+```
 
-When `pass` is omitted from the config, authentication falls back to SSH agent and the key file at `~/.ssh/id_ed25519`.
-Using `StorageFactory.connect` is recommended over direct instantiation.
+### Direct client usage
 
-```ts
+```typescript
 import { SftpStorageClient } from "@simplysm/storage";
 
 const client = new SftpStorageClient();
-
-// Password authentication
-await client.connect({ host: "sftp.example.com", port: 22, user: "user", pass: "pass" });
-
-// Key-based authentication (omit pass)
-await client.connect({ host: "sftp.example.com", user: "user" });
-
+await client.connect({ host: "example.com", user: "deploy", password: "secret" });
 try {
-  await client.mkdir("/uploads/2024");
-  await client.put("/local/report.csv", "/uploads/2024/report.csv");
-  const entries = await client.readdir("/uploads/2024");
-  console.log(entries);
+  const exists = await client.exists("/remote/file.txt");
+  if (exists) {
+    const data = await client.readFile("/remote/file.txt");
+  }
+  await client.put(Buffer.from("hello"), "/remote/hello.txt");
 } finally {
   await client.close();
 }
 ```
-
-**Constructor**
-
-```ts
-new SftpStorageClient()
-```
-
-No constructor parameters.
-
-**Methods** — all defined by the `Storage` interface.
-
-| Method         | Notes                                                                                                   |
-| -------------- | ------------------------------------------------------------------------------------------------------- |
-| `connect`      | Throws if already connected. When `pass` is absent, authenticates via SSH agent / `~/.ssh/id_ed25519`.  |
-| `mkdir`        | Creates parent directories automatically.                                                               |
-| `rename`       | Renames or moves a remote path.                                                                         |
-| `readdir`      | Returns a list of `FileInfo` entries for the given directory.                                           |
-| `readFile`     | Downloads and returns file content as `Bytes`.                                                          |
-| `exists`       | Returns `false` even when the parent directory does not exist, or on any error.                         |
-| `put`          | Accepts a local file path string (uses `fastPut`) or a `Bytes` buffer.                                  |
-| `uploadDir`    | Recursively uploads a local directory.                                                                  |
-| `remove`       | Deletes a remote file.                                                                                  |
-| `close`        | Safe to call when already closed. Can reconnect on the same instance after closing.                     |
-
----
-
-### Factory
-
-#### `StorageFactory`
-
-Creates and manages storage client connections. Preferred over constructing clients directly.
-
-**`StorageFactory.connect`** (static)
-
-Connects to storage, executes the callback, and closes the connection automatically — even if the callback throws.
-
-```ts
-import { StorageFactory } from "@simplysm/storage";
-
-const result = await StorageFactory.connect(
-  "sftp",
-  { host: "sftp.example.com", user: "deploy", pass: "secret" },
-  async (storage) => {
-    await storage.mkdir("/var/www/releases/v2");
-    await storage.uploadDir("/local/build", "/var/www/releases/v2");
-    return await storage.readdir("/var/www/releases/v2");
-  },
-);
-
-console.log(result); // FileInfo[]
-```
-
-```ts
-static connect<R>(
-  type: StorageType,
-  config: StorageConnConfig,
-  fn: (storage: Storage) => R | Promise<R>,
-): Promise<R>
-```
-
-| Parameter | Type                              | Description                                          |
-| --------- | --------------------------------- | ---------------------------------------------------- |
-| `type`    | `StorageType`                     | Protocol: `"ftp"`, `"ftps"`, or `"sftp"`            |
-| `config`  | `StorageConnConfig`               | Connection parameters (host, port, user, pass)       |
-| `fn`      | `(storage: Storage) => R \| Promise<R>` | Callback that receives the connected client    |
-
-Returns a `Promise<R>` that resolves to the value returned by `fn`.
-
-## Types
-
-| Name                | Kind        | Description                                         |
-| ------------------- | ----------- | --------------------------------------------------- |
-| `StorageConnConfig` | `interface` | Connection configuration (host, port, user, pass)   |
-| `FileInfo`          | `interface` | File/directory entry returned by `readdir`          |
-| `Storage`           | `interface` | Unified interface implemented by all storage clients |
-| `StorageType`       | `type`      | Protocol discriminant: `"ftp" \| "ftps" \| "sftp"` |

package/dist/clients/ftp-storage-client.d.ts

@@ -1,5 +1,5 @@
 import type { Bytes } from "@simplysm/core-common";
-import type { Storage, FileInfo } from "../types/storage";
+import type { StorageClient, FileInfo } from "../types/storage";
 import type { StorageConnConfig } from "../types/storage-conn-config";
 /**
  * Storage client using FTP/FTPS protocol.
@@ -8,7 +8,7 @@ import type { StorageConnConfig } from "../types/storage-conn-config";
  * The `secure` constructor parameter configures whether to use FTPS.
  * Using {@link StorageFactory.connect} is recommended over direct usage.
  */
-export declare class FtpStorageClient implements Storage {
+export declare class FtpStorageClient implements StorageClient {
     private readonly _secure;
     private _client;
     constructor(_secure?: boolean);
@@ -25,7 +25,7 @@ export declare class FtpStorageClient implements Storage {
     /** Create a directory. Creates parent directories if they do not exist. */
     mkdir(dirPath: string): Promise<void>;
     rename(fromPath: string, toPath: string): Promise<void>;
-    readdir(dirPath: string): Promise<FileInfo[]>;
+    list(dirPath: string): Promise<FileInfo[]>;
     readFile(filePath: string): Promise<Bytes>;
     /**
      * Check whether a file or directory exists.

package/dist/clients/ftp-storage-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ftp-storage-client.d.ts","sourceRoot":"","sources":["..\\..\\src\\clients\\ftp-storage-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAInD,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEtE;;;;;;GAMG;AACH,qBAAa,gBAAiB,YAAW,OAAO;IAGlC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,OAAO,CAAC,OAAO,CAAyB;gBAEX,OAAO,GAAE,OAAe;IAErD;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBvD,OAAO,CAAC,cAAc;IAOtB,2EAA2E;IACrE,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAK7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAWhD;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB1C,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,gEAAgE;IAC1D,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9E,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE;;;;;;OAMG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CASvB"}
+{"version":3,"file":"ftp-storage-client.d.ts","sourceRoot":"","sources":["..\\..\\src\\clients\\ftp-storage-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAInD,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEtE;;;;;;GAMG;AACH,qBAAa,gBAAiB,YAAW,aAAa;IAGxC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,OAAO,CAAC,OAAO,CAAyB;gBAEX,OAAO,GAAE,OAAe;IAErD;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBvD,OAAO,CAAC,cAAc;IAOtB,2EAA2E;IACrE,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAK1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAWhD;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB1C,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,gEAAgE;IAC1D,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9E,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE;;;;;;OAMG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CASvB"}

package/dist/clients/ftp-storage-client.js

@@ -24,7 +24,7 @@ class FtpStorageClient {
         host: config.host,
         port: config.port,
         user: config.user,
-        password: config.pass,
+        password: config.password,
         secure: this._secure
       });
       this._client = client;
@@ -46,7 +46,7 @@ class FtpStorageClient {
   async rename(fromPath, toPath) {
     await this._requireClient().rename(fromPath, toPath);
   }
-  async readdir(dirPath) {
+  async list(dirPath) {
     const fileInfos = await this._requireClient().list(dirPath);
     return fileInfos.map((item) => ({ name: item.name, isFile: item.isFile }));
   }

package/dist/clients/ftp-storage-client.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../src/clients/ftp-storage-client.ts"],
-  "mappings": "AACA,SAAS,OAAO,eAAe;AAC/B,OAAO,SAAS;AAChB,SAAS,aAAa,gBAAgB;AAW/B,MAAM,iBAAoC;AAAA,EAG/C,YAA6B,UAAmB,OAAO;AAA1B;AAAA,EAA2B;AAAA,EAFhD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYR,MAAM,QAAQ,QAA0C;AACtD,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,6DAA6D;AAAA,IACjF;AACA,UAAM,SAAS,IAAI,IAAI,OAAO;AAC9B,QAAI;AACF,YAAM,OAAO,OAAO;AAAA,QAClB,MAAM,OAAO;AAAA,QACb,MAAM,OAAO;AAAA,QACb,MAAM,OAAO;AAAA,QACb,UAAU,OAAO;AAAA,QACjB,QAAQ,KAAK;AAAA,MACf,CAAC;AACD,WAAK,UAAU;AAAA,IACjB,SAAS,KAAK;AACZ,aAAO,MAAM;AACb,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,iBAA6B;AACnC,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,8BAA8B;AAAA,IAClD;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,MAAM,SAAgC;AAC1C,UAAM,KAAK,eAAe,EAAE,UAAU,OAAO;AAAA,EAC/C;AAAA,EAEA,MAAM,OAAO,UAAkB,QAA+B;AAC5D,UAAM,KAAK,eAAe,EAAE,OAAO,UAAU,MAAM;AAAA,EACrD;AAAA,EAEA,MAAM,QAAQ,SAAsC;AAClD,UAAM,YAAY,MAAM,KAAK,eAAe,EAAE,KAAK,OAAO;AAC1D,WAAO,UAAU,IAAI,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,QAAQ,KAAK,OAAO,EAAE;AAAA,EAC3E;AAAA,EAEA,MAAM,SAAS,UAAkC;AAC/C,UAAM,SAAS,KAAK,eAAe;AACnC,UAAM,SAAkB,CAAC;AACzB,UAAM,WAAW,IAAI,YAAY;AACjC,aAAS,GAAG,QAAQ,CAAC,UAAsB;AACzC,aAAO,KAAK,KAAK;AAAA,IACnB,CAAC;AACD,UAAM,OAAO,WAAW,UAAU,QAAQ;AAC1C,WAAO,MAAM,OAAO,MAAM;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,OAAO,UAAoC;AAC/C,QAAI;AAEF,YAAM,KAAK,eAAe,EAAE,KAAK,QAAQ;AACzC,aAAO;AAAA,IACT,QAAQ;AAEN,UAAI;AACF,cAAM,YAAY,SAAS,YAAY,GAAG;AAC1C,cAAM,UAAU,YAAY,IAAI,SAAS,UAAU,GAAG,SAAS,IAAI;AACnE,cAAM,WAAW,SAAS,UAAU,YAAY,CAAC;AACjD,cAAM,OAAO,MAAM,KAAK,eAAe,EAAE,KAAK,OAAO;AACrD,eAAO,KAAK,KAAK,CAAC,SAAS,KAAK,SAAS,QAAQ;AAAA,MACnD,QAAQ;AACN,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,UAAiC;AAC5C,UAAM,KAAK,eAAe,EAAE,OAAO,QAAQ;AAAA,EAC7C;AAAA;AAAA,EAGA,MAAM,IAAI,mBAAmC,iBAAwC;AACnF,QAAI;AACJ,QAAI,OAAO,sBAAsB,UAAU;AACzC,cAAQ;AAAA,IACV,OAAO;AACL,cAAQ,SAAS,KAAK,iBAAiB;AAAA,IACzC;AACA,UAAM,KAAK,eAAe,EAAE,WAAW,OAAO,eAAe;AAAA,EAC/D;AAAA,EAEA,MAAM,UAAU,UAAkB,QAA+B;AAC/D,UAAM,KAAK,eAAe,EAAE,cAAc,UAAU,MAAM;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,QAAuB;AACrB,QAAI,KAAK,YAAY,QAAW;AAC9B,aAAO,QAAQ,QAAQ;AAAA,IACzB;AAEA,SAAK,QAAQ,MAAM;AACnB,SAAK,UAAU;AACf,WAAO,QAAQ,QAAQ;AAAA,EACzB;AACF;",
+  "mappings": "AACA,SAAS,OAAO,eAAe;AAC/B,OAAO,SAAS;AAChB,SAAS,aAAa,gBAAgB;AAW/B,MAAM,iBAA0C;AAAA,EAGrD,YAA6B,UAAmB,OAAO;AAA1B;AAAA,EAA2B;AAAA,EAFhD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYR,MAAM,QAAQ,QAA0C;AACtD,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,6DAA6D;AAAA,IACjF;AACA,UAAM,SAAS,IAAI,IAAI,OAAO;AAC9B,QAAI;AACF,YAAM,OAAO,OAAO;AAAA,QAClB,MAAM,OAAO;AAAA,QACb,MAAM,OAAO;AAAA,QACb,MAAM,OAAO;AAAA,QACb,UAAU,OAAO;AAAA,QACjB,QAAQ,KAAK;AAAA,MACf,CAAC;AACD,WAAK,UAAU;AAAA,IACjB,SAAS,KAAK;AACZ,aAAO,MAAM;AACb,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,iBAA6B;AACnC,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,8BAA8B;AAAA,IAClD;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,MAAM,SAAgC;AAC1C,UAAM,KAAK,eAAe,EAAE,UAAU,OAAO;AAAA,EAC/C;AAAA,EAEA,MAAM,OAAO,UAAkB,QAA+B;AAC5D,UAAM,KAAK,eAAe,EAAE,OAAO,UAAU,MAAM;AAAA,EACrD;AAAA,EAEA,MAAM,KAAK,SAAsC;AAC/C,UAAM,YAAY,MAAM,KAAK,eAAe,EAAE,KAAK,OAAO;AAC1D,WAAO,UAAU,IAAI,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,QAAQ,KAAK,OAAO,EAAE;AAAA,EAC3E;AAAA,EAEA,MAAM,SAAS,UAAkC;AAC/C,UAAM,SAAS,KAAK,eAAe;AACnC,UAAM,SAAkB,CAAC;AACzB,UAAM,WAAW,IAAI,YAAY;AACjC,aAAS,GAAG,QAAQ,CAAC,UAAsB;AACzC,aAAO,KAAK,KAAK;AAAA,IACnB,CAAC;AACD,UAAM,OAAO,WAAW,UAAU,QAAQ;AAC1C,WAAO,MAAM,OAAO,MAAM;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,OAAO,UAAoC;AAC/C,QAAI;AAEF,YAAM,KAAK,eAAe,EAAE,KAAK,QAAQ;AACzC,aAAO;AAAA,IACT,QAAQ;AAEN,UAAI;AACF,cAAM,YAAY,SAAS,YAAY,GAAG;AAC1C,cAAM,UAAU,YAAY,IAAI,SAAS,UAAU,GAAG,SAAS,IAAI;AACnE,cAAM,WAAW,SAAS,UAAU,YAAY,CAAC;AACjD,cAAM,OAAO,MAAM,KAAK,eAAe,EAAE,KAAK,OAAO;AACrD,eAAO,KAAK,KAAK,CAAC,SAAS,KAAK,SAAS,QAAQ;AAAA,MACnD,QAAQ;AACN,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,UAAiC;AAC5C,UAAM,KAAK,eAAe,EAAE,OAAO,QAAQ;AAAA,EAC7C;AAAA;AAAA,EAGA,MAAM,IAAI,mBAAmC,iBAAwC;AACnF,QAAI;AACJ,QAAI,OAAO,sBAAsB,UAAU;AACzC,cAAQ;AAAA,IACV,OAAO;AACL,cAAQ,SAAS,KAAK,iBAAiB;AAAA,IACzC;AACA,UAAM,KAAK,eAAe,EAAE,WAAW,OAAO,eAAe;AAAA,EAC/D;AAAA,EAEA,MAAM,UAAU,UAAkB,QAA+B;AAC/D,UAAM,KAAK,eAAe,EAAE,cAAc,UAAU,MAAM;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,QAAuB;AACrB,QAAI,KAAK,YAAY,QAAW;AAC9B,aAAO,QAAQ,QAAQ;AAAA,IACzB;AAEA,SAAK,QAAQ,MAAM;AACnB,SAAK,UAAU;AACf,WAAO,QAAQ,QAAQ;AAAA,EACzB;AACF;",
   "names": []
 }

package/dist/clients/sftp-storage-client.d.ts

@@ -1,5 +1,5 @@
 import type { Bytes } from "@simplysm/core-common";
-import type { Storage, FileInfo } from "../types/storage";
+import type { StorageClient, FileInfo } from "../types/storage";
 import type { StorageConnConfig } from "../types/storage-conn-config";
 /**
  * Storage client using SFTP protocol.
@@ -7,7 +7,7 @@ import type { StorageConnConfig } from "../types/storage-conn-config";
  * @remarks
  * Using {@link StorageFactory.connect} is recommended over direct usage.
  */
-export declare class SftpStorageClient implements Storage {
+export declare class SftpStorageClient implements StorageClient {
     private _client;
     /**
      * Connect to the SFTP server.
@@ -30,7 +30,7 @@ export declare class SftpStorageClient implements Storage {
      * Returns false for all exceptions including network errors and permission errors.
      */
     exists(filePath: string): Promise<boolean>;
-    readdir(dirPath: string): Promise<FileInfo[]>;
+    list(dirPath: string): Promise<FileInfo[]>;
     readFile(filePath: string): Promise<Bytes>;
     remove(filePath: string): Promise<void>;
     /** Upload a local file path or byte data to the remote path. */

package/dist/clients/sftp-storage-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sftp-storage-client.d.ts","sourceRoot":"","sources":["..\\..\\src\\clients\\sftp-storage-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKtE;;;;;GAKG;AACH,qBAAa,iBAAkB,YAAW,OAAO;IAC/C,OAAO,CAAC,OAAO,CAAyB;IAExC;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6CvD,OAAO,CAAC,cAAc;IAOtB,2EAA2E;IACrE,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D;;;;;;OAMG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAW1C,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAQ7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAc1C,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,gEAAgE;IAC1D,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS9E,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE;;;;;;OAMG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAO7B"}
+{"version":3,"file":"sftp-storage-client.d.ts","sourceRoot":"","sources":["..\\..\\src\\clients\\sftp-storage-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKtE;;;;;GAKG;AACH,qBAAa,iBAAkB,YAAW,aAAa;IACrD,OAAO,CAAC,OAAO,CAAyB;IAExC;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6CvD,OAAO,CAAC,cAAc;IAOtB,2EAA2E;IACrE,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D;;;;;;OAMG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAW1C,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAQ1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAc1C,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,gEAAgE;IAC1D,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS9E,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE;;;;;;OAMG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAO7B"}

package/dist/clients/sftp-storage-client.js

@@ -16,12 +16,12 @@ class SftpStorageClient {
     }
     const client = new SftpClient();
     try {
-      if (config.pass != null) {
+      if (config.password != null) {
         await client.connect({
           host: config.host,
           port: config.port,
           username: config.user,
-          password: config.pass
+          password: config.password
         });
       } else {
         const fsP = await import("fs/promises");
@@ -77,7 +77,7 @@ class SftpStorageClient {
       return false;
     }
   }
-  async readdir(dirPath) {
+  async list(dirPath) {
     const list = await this._requireClient().list(dirPath);
     return list.map((item) => ({
       name: item.name,

package/dist/clients/sftp-storage-client.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../src/clients/sftp-storage-client.ts"],
-  "mappings": "AACA,SAAS,eAAe;AACxB,OAAO,gBAAgB;AAahB,MAAM,kBAAqC;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUR,MAAM,QAAQ,QAA0C;AACtD,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,8DAA8D;AAAA,IAClF;AAEA,UAAM,SAAS,IAAI,WAAW;AAC9B,QAAI;AACF,UAAI,OAAO,QAAQ,MAAM;AACvB,cAAM,OAAO,QAAQ;AAAA,UACnB,MAAM,OAAO;AAAA,UACb,MAAM,OAAO;AAAA,UACb,UAAU,OAAO;AAAA,UACjB,UAAU,OAAO;AAAA,QACnB,CAAC;AAAA,MACH,OAAO;AAEL,cAAM,MAAM,MAAM,OAAO,aAAa;AACtC,cAAM,KAAK,MAAM,OAAO,IAAI;AAC5B,cAAM,UAAU,MAAM,OAAO,MAAM;AACnC,cAAM,UAAU,QAAQ,KAAK,GAAG,QAAQ,GAAG,QAAQ,YAAY;AAE/D,cAAM,cAAc;AAAA,UAClB,MAAM,OAAO;AAAA,UACb,MAAM,OAAO;AAAA,UACb,UAAU,OAAO;AAAA,UACjB,GAAI,QAAQ,IAAI,eAAe,KAAK,OAAO,EAAE,OAAO,QAAQ,IAAI,eAAe,EAAE,IAAI,CAAC;AAAA,QACxF;AAEA,YAAI;AACF,gBAAM,OAAO,QAAQ;AAAA,YACnB,GAAG;AAAA,YACH,YAAY,MAAM,IAAI,SAAS,OAAO;AAAA,UACxC,CAAC;AAAA,QACH,QAAQ;AAEN,gBAAM,OAAO,QAAQ,WAAW;AAAA,QAClC;AAAA,MACF;AACA,WAAK,UAAU;AAAA,IACjB,SAAS,KAAK;AACZ,YAAM,OAAO,IAAI;AACjB,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,iBAA6B;AACnC,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,+BAA+B;AAAA,IACnD;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,MAAM,SAAgC;AAC1C,UAAM,KAAK,eAAe,EAAE,MAAM,SAAS,IAAI;AAAA,EACjD;AAAA,EAEA,MAAM,OAAO,UAAkB,QAA+B;AAC5D,UAAM,KAAK,eAAe,EAAE,OAAO,UAAU,MAAM;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OAAO,UAAoC;AAC/C,QAAI;AAGF,YAAM,SAAS,MAAM,KAAK,eAAe,EAAE,OAAO,QAAQ;AAC1D,aAAO,OAAO,WAAW;AAAA,IAC3B,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,QAAQ,SAAsC;AAClD,UAAM,OAAO,MAAM,KAAK,eAAe,EAAE,KAAK,OAAO;AACrD,WAAO,KAAK,IAAI,CAAC,UAAU;AAAA,MACzB,MAAM,KAAK;AAAA,MACX,QAAQ,KAAK,SAAS;AAAA,IACxB,EAAE;AAAA,EACJ;AAAA,EAEA,MAAM,SAAS,UAAkC;AAG/C,UAAM,SAAU,MAAM,KAAK,eAAe,EAAE,IAAI,QAAQ;AACxD,QAAI,kBAAkB,YAAY;AAChC,aAAO;AAAA,IACT;AAEA,QAAI,OAAO,WAAW,UAAU;AAC9B,aAAO,IAAI,YAAY,EAAE,OAAO,MAAM;AAAA,IACxC;AACA,UAAM,IAAI,QAAQ,2BAA2B;AAAA,EAC/C;AAAA,EAEA,MAAM,OAAO,UAAiC;AAC5C,UAAM,KAAK,eAAe,EAAE,OAAO,QAAQ;AAAA,EAC7C;AAAA;AAAA,EAGA,MAAM,IAAI,mBAAmC,iBAAwC;AACnF,QAAI,OAAO,sBAAsB,UAAU;AACzC,YAAM,KAAK,eAAe,EAAE,QAAQ,mBAAmB,eAAe;AAAA,IACxE,OAAO;AAEL,YAAM,KAAK,eAAe,EAAE,IAAI,OAAO,KAAK,iBAAiB,GAAG,eAAe;AAAA,IACjF;AAAA,EACF;AAAA,EAEA,MAAM,UAAU,UAAkB,QAA+B;AAC/D,UAAM,KAAK,eAAe,EAAE,UAAU,UAAU,MAAM;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,QAAuB;AAC3B,QAAI,KAAK,YAAY,QAAW;AAC9B;AAAA,IACF;AACA,UAAM,KAAK,QAAQ,IAAI;AACvB,SAAK,UAAU;AAAA,EACjB;AACF;",
+  "mappings": "AACA,SAAS,eAAe;AACxB,OAAO,gBAAgB;AAahB,MAAM,kBAA2C;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUR,MAAM,QAAQ,QAA0C;AACtD,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,8DAA8D;AAAA,IAClF;AAEA,UAAM,SAAS,IAAI,WAAW;AAC9B,QAAI;AACF,UAAI,OAAO,YAAY,MAAM;AAC3B,cAAM,OAAO,QAAQ;AAAA,UACnB,MAAM,OAAO;AAAA,UACb,MAAM,OAAO;AAAA,UACb,UAAU,OAAO;AAAA,UACjB,UAAU,OAAO;AAAA,QACnB,CAAC;AAAA,MACH,OAAO;AAEL,cAAM,MAAM,MAAM,OAAO,aAAa;AACtC,cAAM,KAAK,MAAM,OAAO,IAAI;AAC5B,cAAM,UAAU,MAAM,OAAO,MAAM;AACnC,cAAM,UAAU,QAAQ,KAAK,GAAG,QAAQ,GAAG,QAAQ,YAAY;AAE/D,cAAM,cAAc;AAAA,UAClB,MAAM,OAAO;AAAA,UACb,MAAM,OAAO;AAAA,UACb,UAAU,OAAO;AAAA,UACjB,GAAI,QAAQ,IAAI,eAAe,KAAK,OAAO,EAAE,OAAO,QAAQ,IAAI,eAAe,EAAE,IAAI,CAAC;AAAA,QACxF;AAEA,YAAI;AACF,gBAAM,OAAO,QAAQ;AAAA,YACnB,GAAG;AAAA,YACH,YAAY,MAAM,IAAI,SAAS,OAAO;AAAA,UACxC,CAAC;AAAA,QACH,QAAQ;AAEN,gBAAM,OAAO,QAAQ,WAAW;AAAA,QAClC;AAAA,MACF;AACA,WAAK,UAAU;AAAA,IACjB,SAAS,KAAK;AACZ,YAAM,OAAO,IAAI;AACjB,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,iBAA6B;AACnC,QAAI,KAAK,YAAY,QAAW;AAC9B,YAAM,IAAI,QAAQ,+BAA+B;AAAA,IACnD;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,MAAM,SAAgC;AAC1C,UAAM,KAAK,eAAe,EAAE,MAAM,SAAS,IAAI;AAAA,EACjD;AAAA,EAEA,MAAM,OAAO,UAAkB,QAA+B;AAC5D,UAAM,KAAK,eAAe,EAAE,OAAO,UAAU,MAAM;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OAAO,UAAoC;AAC/C,QAAI;AAGF,YAAM,SAAS,MAAM,KAAK,eAAe,EAAE,OAAO,QAAQ;AAC1D,aAAO,OAAO,WAAW;AAAA,IAC3B,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,KAAK,SAAsC;AAC/C,UAAM,OAAO,MAAM,KAAK,eAAe,EAAE,KAAK,OAAO;AACrD,WAAO,KAAK,IAAI,CAAC,UAAU;AAAA,MACzB,MAAM,KAAK;AAAA,MACX,QAAQ,KAAK,SAAS;AAAA,IACxB,EAAE;AAAA,EACJ;AAAA,EAEA,MAAM,SAAS,UAAkC;AAG/C,UAAM,SAAU,MAAM,KAAK,eAAe,EAAE,IAAI,QAAQ;AACxD,QAAI,kBAAkB,YAAY;AAChC,aAAO;AAAA,IACT;AAEA,QAAI,OAAO,WAAW,UAAU;AAC9B,aAAO,IAAI,YAAY,EAAE,OAAO,MAAM;AAAA,IACxC;AACA,UAAM,IAAI,QAAQ,2BAA2B;AAAA,EAC/C;AAAA,EAEA,MAAM,OAAO,UAAiC;AAC5C,UAAM,KAAK,eAAe,EAAE,OAAO,QAAQ;AAAA,EAC7C;AAAA;AAAA,EAGA,MAAM,IAAI,mBAAmC,iBAAwC;AACnF,QAAI,OAAO,sBAAsB,UAAU;AACzC,YAAM,KAAK,eAAe,EAAE,QAAQ,mBAAmB,eAAe;AAAA,IACxE,OAAO;AAEL,YAAM,KAAK,eAAe,EAAE,IAAI,OAAO,KAAK,iBAAiB,GAAG,eAAe;AAAA,IACjF;AAAA,EACF;AAAA,EAEA,MAAM,UAAU,UAAkB,QAA+B;AAC/D,UAAM,KAAK,eAAe,EAAE,UAAU,UAAU,MAAM;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,QAAuB;AAC3B,QAAI,KAAK,YAAY,QAAW;AAC9B;AAAA,IACF;AACA,UAAM,KAAK,QAAQ,IAAI;AACvB,SAAK,UAAU;AAAA,EACjB;AACF;",
   "names": []
 }

package/dist/storage-factory.d.ts

@@ -1,6 +1,6 @@
 import type { StorageConnConfig } from "./types/storage-conn-config";
-import type { Storage } from "./types/storage";
-import type { StorageType } from "./types/storage-type";
+import type { StorageClient } from "./types/storage";
+import type { StorageProtocol } from "./types/storage-type";
 /**
  * Storage client factory
  *
@@ -14,7 +14,7 @@ export declare class StorageFactory {
      * The callback pattern auto-manages connection/close, so this is preferred over direct client usage.
      * The connection is automatically closed even if the callback throws an exception.
      */
-    static connect<R>(type: StorageType, config: StorageConnConfig, fn: (storage: Storage) => R | Promise<R>): Promise<R>;
+    static connect<R>(type: StorageProtocol, config: StorageConnConfig, fn: (storage: StorageClient) => R | Promise<R>): Promise<R>;
     private static _createClient;
 }
 //# sourceMappingURL=storage-factory.d.ts.map

package/dist/storage-factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-factory.d.ts","sourceRoot":"","sources":["..\\src\\storage-factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAIxD;;;;GAIG;AACH,qBAAa,cAAc;IACzB;;;;;;OAMG;WACU,OAAO,CAAC,CAAC,EACpB,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,iBAAiB,EACzB,EAAE,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACvC,OAAO,CAAC,CAAC,CAAC;IAab,OAAO,CAAC,MAAM,CAAC,aAAa;CAU7B"}
+{"version":3,"file":"storage-factory.d.ts","sourceRoot":"","sources":["..\\src\\storage-factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAI5D;;;;GAIG;AACH,qBAAa,cAAc;IACzB;;;;;;OAMG;WACU,OAAO,CAAC,CAAC,EACpB,IAAI,EAAE,eAAe,EACrB,MAAM,EAAE,iBAAiB,EACzB,EAAE,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAC7C,OAAO,CAAC,CAAC,CAAC;IAab,OAAO,CAAC,MAAM,CAAC,aAAa;CAU7B"}

package/dist/storage-factory.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/storage-factory.ts"],
-  "mappings": "AAGA,SAAS,wBAAwB;AACjC,SAAS,yBAAyB;AAO3B,MAAM,eAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ1B,aAAa,QACX,MACA,QACA,IACY;AACZ,UAAM,SAAS,eAAe,cAAc,IAAI;AAEhD,UAAM,OAAO,QAAQ,MAAM;AAC3B,QAAI;AACF,aAAO,MAAM,GAAG,MAAM;AAAA,IACxB,UAAE;AACA,YAAM,OAAO,MAAM,EAAE,MAAM,MAAM;AAAA,MAEjC,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAe,cAAc,MAA4B;AACvD,YAAQ,MAAM;AAAA,MACZ,KAAK;AACH,eAAO,IAAI,kBAAkB;AAAA,MAC/B,KAAK;AACH,eAAO,IAAI,iBAAiB,IAAI;AAAA,MAClC,KAAK;AACH,eAAO,IAAI,iBAAiB,KAAK;AAAA,IACrC;AAAA,EACF;AACF;",
+  "mappings": "AAGA,SAAS,wBAAwB;AACjC,SAAS,yBAAyB;AAO3B,MAAM,eAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ1B,aAAa,QACX,MACA,QACA,IACY;AACZ,UAAM,SAAS,eAAe,cAAc,IAAI;AAEhD,UAAM,OAAO,QAAQ,MAAM;AAC3B,QAAI;AACF,aAAO,MAAM,GAAG,MAAM;AAAA,IACxB,UAAE;AACA,YAAM,OAAO,MAAM,EAAE,MAAM,MAAM;AAAA,MAEjC,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAe,cAAc,MAAsC;AACjE,YAAQ,MAAM;AAAA,MACZ,KAAK;AACH,eAAO,IAAI,kBAAkB;AAAA,MAC/B,KAAK;AACH,eAAO,IAAI,iBAAiB,IAAI;AAAA,MAClC,KAAK;AACH,eAAO,IAAI,iBAAiB,KAAK;AAAA,IACrC;AAAA,EACF;AACF;",
   "names": []
 }

package/dist/types/storage-conn-config.d.ts

@@ -2,6 +2,6 @@ export interface StorageConnConfig {
     host: string;
     port?: number;
     user?: string;
-    pass?: string;
+    password?: string;
 }
 //# sourceMappingURL=storage-conn-config.d.ts.map

package/dist/types/storage-conn-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-conn-config.d.ts","sourceRoot":"","sources":["..\\..\\src\\types\\storage-conn-config.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"storage-conn-config.d.ts","sourceRoot":"","sources":["..\\..\\src\\types\\storage-conn-config.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/types/storage-type.d.ts

@@ -1,2 +1,2 @@
-export type StorageType = "ftp" | "ftps" | "sftp";
+export type StorageProtocol = "ftp" | "ftps" | "sftp";
 //# sourceMappingURL=storage-type.d.ts.map

package/dist/types/storage-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-type.d.ts","sourceRoot":"","sources":["..\\..\\src\\types\\storage-type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"storage-type.d.ts","sourceRoot":"","sources":["..\\..\\src\\types\\storage-type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dist/types/storage.d.ts

@@ -4,11 +4,11 @@ export interface FileInfo {
     name: string;
     isFile: boolean;
 }
-export interface Storage {
+export interface StorageClient {
     connect(config: StorageConnConfig): Promise<void>;
     mkdir(dirPath: string): Promise<void>;
     rename(fromPath: string, toPath: string): Promise<void>;
-    readdir(dirPath: string): Promise<FileInfo[]>;
+    list(dirPath: string): Promise<FileInfo[]>;
     readFile(filePath: string): Promise<Bytes>;
     exists(filePath: string): Promise<boolean>;
     put(localPathOrBuffer: string | Bytes, storageFilePath: string): Promise<void>;

package/dist/types/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["..\\..\\src\\types\\storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3C,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/E,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["..\\..\\src\\types\\storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3C,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,KAAK,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/E,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/storage",
-  "version": "13.0.77",
+  "version": "13.0.80",
   "description": "Simplysm Package - Storage Module (node)",
   "author": "simplysm",
   "license": "Apache-2.0",
@@ -14,14 +14,15 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
+    "docs",
     "src",
     "tests"
   ],
   "sideEffects": false,
   "dependencies": {
     "basic-ftp": "^5.2.0",
-    "ssh2-sftp-client": "^12.0.1",
-    "@simplysm/core-common": "13.0.77"
+    "ssh2-sftp-client": "^12.1.0",
+    "@simplysm/core-common": "13.0.80"
   },
   "devDependencies": {
     "@types/ssh2-sftp-client": "^9.0.6"

package/src/clients/ftp-storage-client.ts

@@ -2,7 +2,7 @@ import type { Bytes } from "@simplysm/core-common";
 import { bytes, SdError } from "@simplysm/core-common";
 import ftp from "basic-ftp";
 import { PassThrough, Readable } from "stream";
-import type { Storage, FileInfo } from "../types/storage";
+import type { StorageClient, FileInfo } from "../types/storage";
 import type { StorageConnConfig } from "../types/storage-conn-config";
 
 /**
@@ -12,7 +12,7 @@ import type { StorageConnConfig } from "../types/storage-conn-config";
  * The `secure` constructor parameter configures whether to use FTPS.
  * Using {@link StorageFactory.connect} is recommended over direct usage.
  */
-export class FtpStorageClient implements Storage {
+export class FtpStorageClient implements StorageClient {
   private _client: ftp.Client | undefined;
 
   constructor(private readonly _secure: boolean = false) {}
@@ -35,7 +35,7 @@ export class FtpStorageClient implements Storage {
         host: config.host,
         port: config.port,
         user: config.user,
-        password: config.pass,
+        password: config.password,
         secure: this._secure,
       });
       this._client = client;
@@ -61,7 +61,7 @@ export class FtpStorageClient implements Storage {
     await this._requireClient().rename(fromPath, toPath);
   }
 
-  async readdir(dirPath: string): Promise<FileInfo[]> {
+  async list(dirPath: string): Promise<FileInfo[]> {
     const fileInfos = await this._requireClient().list(dirPath);
     return fileInfos.map((item) => ({ name: item.name, isFile: item.isFile }));
   }

package/src/clients/sftp-storage-client.ts

@@ -1,7 +1,7 @@
 import type { Bytes } from "@simplysm/core-common";
 import { SdError } from "@simplysm/core-common";
 import SftpClient from "ssh2-sftp-client";
-import type { Storage, FileInfo } from "../types/storage";
+import type { StorageClient, FileInfo } from "../types/storage";
 import type { StorageConnConfig } from "../types/storage-conn-config";
 
 // Buffer usage from ssh2-sftp-client library type definitions
@@ -13,7 +13,7 @@ type SftpGetResult = string | NodeJS.WritableStream | Bytes;
  * @remarks
  * Using {@link StorageFactory.connect} is recommended over direct usage.
  */
-export class SftpStorageClient implements Storage {
+export class SftpStorageClient implements StorageClient {
   private _client: SftpClient | undefined;
 
   /**
@@ -31,12 +31,12 @@ export class SftpStorageClient implements Storage {
 
     const client = new SftpClient();
     try {
-      if (config.pass != null) {
+      if (config.password != null) {
         await client.connect({
           host: config.host,
           port: config.port,
           username: config.user,
-          password: config.pass,
+          password: config.password,
         });
       } else {
         // Authenticate with SSH agent + key file
@@ -103,7 +103,7 @@ export class SftpStorageClient implements Storage {
     }
   }
 
-  async readdir(dirPath: string): Promise<FileInfo[]> {
+  async list(dirPath: string): Promise<FileInfo[]> {
     const list = await this._requireClient().list(dirPath);
     return list.map((item) => ({
       name: item.name,

package/src/storage-factory.ts

@@ -1,6 +1,6 @@
 import type { StorageConnConfig } from "./types/storage-conn-config";
-import type { Storage } from "./types/storage";
-import type { StorageType } from "./types/storage-type";
+import type { StorageClient } from "./types/storage";
+import type { StorageProtocol } from "./types/storage-type";
 import { FtpStorageClient } from "./clients/ftp-storage-client";
 import { SftpStorageClient } from "./clients/sftp-storage-client";
 
@@ -18,9 +18,9 @@ export class StorageFactory {
    * The connection is automatically closed even if the callback throws an exception.
    */
   static async connect<R>(
-    type: StorageType,
+    type: StorageProtocol,
     config: StorageConnConfig,
-    fn: (storage: Storage) => R | Promise<R>,
+    fn: (storage: StorageClient) => R | Promise<R>,
   ): Promise<R> {
     const client = StorageFactory._createClient(type);
 
@@ -34,7 +34,7 @@ export class StorageFactory {
     }
   }
 
-  private static _createClient(type: StorageType): Storage {
+  private static _createClient(type: StorageProtocol): StorageClient {
     switch (type) {
       case "sftp":
         return new SftpStorageClient();

package/src/types/storage-conn-config.ts

@@ -2,5 +2,5 @@ export interface StorageConnConfig {
   host: string;
   port?: number;
   user?: string;
-  pass?: string;
+  password?: string;
 }

package/src/types/storage-type.ts

@@ -1 +1 @@
-export type StorageType = "ftp" | "ftps" | "sftp";
+export type StorageProtocol = "ftp" | "ftps" | "sftp";

package/src/types/storage.ts

@@ -6,11 +6,11 @@ export interface FileInfo {
   isFile: boolean;
 }
 
-export interface Storage {
+export interface StorageClient {
   connect(config: StorageConnConfig): Promise<void>;
   mkdir(dirPath: string): Promise<void>;
   rename(fromPath: string, toPath: string): Promise<void>;
-  readdir(dirPath: string): Promise<FileInfo[]>;
+  list(dirPath: string): Promise<FileInfo[]>;
   readFile(filePath: string): Promise<Bytes>;
   exists(filePath: string): Promise<boolean>;
   put(localPathOrBuffer: string | Bytes, storageFilePath: string): Promise<void>;

package/tests/ftp-storage-client.spec.ts

@@ -52,7 +52,7 @@ describe("FtpStorageClient", () => {
         host: "ftp.example.com",
         port: 21,
         user: "user",
-        pass: "pass",
+        password: "pass",
       });
 
       expect(mockAccess).toHaveBeenCalledWith({
@@ -96,8 +96,8 @@ describe("FtpStorageClient", () => {
       );
     });
 
-    it("Should throw error when readdir is called before connection", async () => {
-      await expect(client.readdir("/")).rejects.toThrow("Not connected to FTP server.");
+    it("Should throw error when list is called before connection", async () => {
+      await expect(client.list("/")).rejects.toThrow("Not connected to FTP server.");
     });
   });
 
@@ -119,10 +119,10 @@ describe("FtpStorageClient", () => {
     });
   });
 
-  describe("readdir", () => {
+  describe("list", () => {
     it("Should return directory list as FileInfo array", async () => {
       await client.connect({ host: "test" });
-      const result = await client.readdir("/");
+      const result = await client.list("/");
 
       expect(result).toEqual([
         { name: "file.txt", isFile: true },

package/tests/sftp-storage-client.spec.ts

@@ -49,7 +49,7 @@ describe("SftpStorageClient", () => {
         host: "sftp.example.com",
         port: 22,
         user: "user",
-        pass: "pass",
+        password: "pass",
       });
 
       expect(mockConnect).toHaveBeenCalledWith({
@@ -69,7 +69,7 @@ describe("SftpStorageClient", () => {
 
     it("Should clean up client on connection failure", async () => {
       mockConnect.mockRejectedValueOnce(new Error("Auth failed"));
-      await expect(client.connect({ host: "test", pass: "wrong" })).rejects.toThrow("Auth failed");
+      await expect(client.connect({ host: "test", password: "wrong" })).rejects.toThrow("Auth failed");
       expect(mockEnd).toHaveBeenCalled();
     });
   });
@@ -85,8 +85,8 @@ describe("SftpStorageClient", () => {
       );
     });
 
-    it("Should throw error when readdir is called before connection", async () => {
-      await expect(client.readdir("/")).rejects.toThrow("Not connected to SFTP server.");
+    it("Should throw error when list is called before connection", async () => {
+      await expect(client.list("/")).rejects.toThrow("Not connected to SFTP server.");
     });
   });
 
@@ -149,10 +149,10 @@ describe("SftpStorageClient", () => {
     });
   });
 
-  describe("readdir", () => {
+  describe("list", () => {
     it("Should return directory list as FileInfo array", async () => {
       await client.connect({ host: "test" });
-      const result = await client.readdir("/");
+      const result = await client.list("/");
 
       expect(result).toEqual([
         { name: "file.txt", isFile: true },