@zero-transfer/sftp 0.1.6 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +18 -17
  2. package/dist/index.cjs +4063 -990
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.mts +540 -54
  5. package/dist/index.d.ts +540 -54
  6. package/dist/index.mjs +4077 -999
  7. package/dist/index.mjs.map +1 -1
  8. package/package.json +3 -6
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @zero-transfer/sftp
2
2
 
3
- > SFTP with SSH key auth, known_hosts, and jump-host support.
3
+ > Zero-dependency SFTP over SSH with a first-party SSH transport stack.
4
4
 
5
5
  ## Install
6
6
 
@@ -10,30 +10,31 @@ npm install @zero-transfer/sftp
10
10
 
11
11
  ## Overview
12
12
 
13
- SFTP over SSH with password / private-key / agent / keyboard-interactive authentication, SSH algorithm overrides, OpenSSH `known_hosts` parsing, SHA-256 host-key pinning, custom socket factories, and a first-class jump-host helper for bastion-mediated connections.
13
+ Zero-dependency SFTP over SSH built on a first-party SSH transport stack: Ed25519 / RSA-SHA2-256/512 / ECDSA P-256/384/521 host keys, password / keyboard-interactive / public-key (Ed25519 + RSA) auth, host-key pinning, OpenSSH `known_hosts` (hashed/plain, `[host]:port`, `@revoked`), handshake timeout, and idle NAT keepalive. `createSftpProviderFactory` is kept as an alias of `createNativeSftpProviderFactory` for backward compatibility.
14
14
 
15
15
  ## Usage
16
16
 
17
17
  ```ts
18
- import { createSftpProviderFactory } from "@zero-transfer/sftp";
18
+ import { createNativeSftpProviderFactory } from "@zero-transfer/sftp";
19
19
  ```
20
20
 
21
21
  ## Public surface
22
22
 
23
- This package narrows [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk) to **10** exports. Every symbol is re-exported from the SDK; the table below links into the full API reference:
24
-
25
- | Symbol | Kind | Notes |
26
- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ |
27
- | [`createSftpProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createSftpProviderFactory.md) | Function | See API reference. |
28
- | [`createSftpJumpHostSocketFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createSftpJumpHostSocketFactory.md) | Function | See API reference. |
29
- | [`SftpProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/SftpProviderOptions.md) | Interface | See API reference. |
30
- | [`SftpJumpHostOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/SftpJumpHostOptions.md) | Interface | See API reference. |
31
- | [`SftpRawSession`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/SftpRawSession.md) | Interface | See API reference. |
32
- | [`matchKnownHosts`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/matchKnownHosts.md) | Function | See API reference. |
33
- | [`matchKnownHostsEntry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/matchKnownHostsEntry.md) | Function | See API reference. |
34
- | [`parseKnownHosts`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseKnownHosts.md) | Function | See API reference. |
35
- | [`KnownHostsEntry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/KnownHostsEntry.md) | Interface | See API reference. |
36
- | [`KnownHostsMarker`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/KnownHostsMarker.md) | Type | See API reference. |
23
+ This package publishes a narrowed surface of **11** exports. These symbols are also available from [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk); the table below links into the full API reference:
24
+
25
+ | Symbol | Kind | Notes |
26
+ | --------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------ |
27
+ | `createNativeSftpProviderFactory` | _unresolved_ | — |
28
+ | `NativeSftpProviderOptions` | _unresolved_ | — |
29
+ | `NativeSftpRawSession` | _unresolved_ | — |
30
+ | [`createSftpProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createSftpProviderFactory.md) | Function | See API reference. |
31
+ | [`SftpProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/SftpProviderOptions.md) | Interface | See API reference. |
32
+ | [`SftpRawSession`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/SftpRawSession.md) | Interface | See API reference. |
33
+ | [`matchKnownHosts`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/matchKnownHosts.md) | Function | See API reference. |
34
+ | [`matchKnownHostsEntry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/matchKnownHostsEntry.md) | Function | See API reference. |
35
+ | [`parseKnownHosts`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseKnownHosts.md) | Function | See API reference. |
36
+ | [`KnownHostsEntry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/KnownHostsEntry.md) | Interface | See API reference. |
37
+ | [`KnownHostsMarker`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/KnownHostsMarker.md) | Type | See API reference. |
37
38
 
38
39
  ## Examples
39
40