@zero-transfer/sftp 0.1.0-alpha.0 → 0.1.2

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 (5) hide show
  1. package/README.md +37 -15
  2. package/dist/index.cjs +8 -2
  3. package/dist/index.d.ts +3 -2
  4. package/dist/index.mjs +2 -2
  5. package/package.json +6 -5
package/README.md CHANGED
@@ -1,14 +1,6 @@
1
1
  # @zero-transfer/sftp
2
2
 
3
- SFTP provider with jump-host support for ZeroTransfer.
4
-
5
- > **Alpha umbrella package.** This package currently re-exports the entire
6
- > [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk)
7
- > public surface. Future releases will narrow this package to only its
8
- > dedicated subset (see the
9
- > [ZeroTransfer remake plan](https://github.com/tonywied17/zero-transfer/blob/main/zero-transfer-remake.md#future-monorepo-shape)).
10
- > If you want every provider in one install today, depend on
11
- > `@zero-transfer/sdk` directly.
3
+ > SFTP with SSH key auth, known_hosts, and jump-host support.
12
4
 
13
5
  ## Install
14
6
 
@@ -16,17 +8,47 @@ SFTP provider with jump-host support for ZeroTransfer.
16
8
  npm install @zero-transfer/sftp
17
9
  ```
18
10
 
11
+ ## Overview
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.
14
+
19
15
  ## Usage
20
16
 
21
17
  ```ts
22
- import { createTransferClient } from "@zero-transfer/sftp";
23
-
24
- const client = createTransferClient();
18
+ import { createSftpProviderFactory } from "@zero-transfer/sftp";
25
19
  ```
26
20
 
27
- See the [main README](https://github.com/tonywied17/zero-transfer#readme) for
28
- full documentation.
21
+ ## Public surface
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. |
37
+
38
+ ## Examples
39
+
40
+ | Example | What it shows |
41
+ | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
42
+ | [`examples/sftp-private-key.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/sftp-private-key.ts) | SFTP private-key authentication example with host-key pinning. |
43
+
44
+ ## Documentation
45
+
46
+ - [Scope page](https://github.com/tonywied17/zero-transfer/blob/main/docs/scopes/sftp.md)
47
+ - [Top-level README](https://github.com/tonywied17/zero-transfer/blob/main/README.md)
48
+ - [Full API reference](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/README.md)
49
+ - [Capability matrix](https://github.com/tonywied17/zero-transfer/blob/main/README.md#capability-matrix)
50
+ - [Examples](https://github.com/tonywied17/zero-transfer/tree/main/examples)
29
51
 
30
52
  ## License
31
53
 
32
- MIT © Tony Wiedman
54
+ MIT © [Tony Wiedman](https://github.com/tonywied17)
package/dist/index.cjs CHANGED
@@ -1,3 +1,9 @@
1
- // AUTO-GENERATED stub. See packages/README.md.
1
+ // AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
2
2
  "use strict";
3
- module.exports = require("@zero-transfer/sdk");
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ const sdk = require("@zero-transfer/sdk");
5
+ Object.defineProperty(exports, "createSftpProviderFactory", { enumerable: true, get: () => sdk["createSftpProviderFactory"] });
6
+ Object.defineProperty(exports, "createSftpJumpHostSocketFactory", { enumerable: true, get: () => sdk["createSftpJumpHostSocketFactory"] });
7
+ Object.defineProperty(exports, "matchKnownHosts", { enumerable: true, get: () => sdk["matchKnownHosts"] });
8
+ Object.defineProperty(exports, "matchKnownHostsEntry", { enumerable: true, get: () => sdk["matchKnownHostsEntry"] });
9
+ Object.defineProperty(exports, "parseKnownHosts", { enumerable: true, get: () => sdk["parseKnownHosts"] });
package/dist/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
- // AUTO-GENERATED stub. See packages/README.md.
2
- export * from "@zero-transfer/sdk";
1
+ // AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
2
+ export { createSftpProviderFactory, createSftpJumpHostSocketFactory, matchKnownHosts, matchKnownHostsEntry, parseKnownHosts } from "@zero-transfer/sdk";
3
+ export type { SftpProviderOptions, SftpJumpHostOptions, SftpRawSession, KnownHostsEntry, KnownHostsMarker } from "@zero-transfer/sdk";
package/dist/index.mjs CHANGED
@@ -1,2 +1,2 @@
1
- // AUTO-GENERATED stub. See packages/README.md.
2
- export * from "@zero-transfer/sdk";
1
+ // AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
2
+ export { createSftpProviderFactory, createSftpJumpHostSocketFactory, matchKnownHosts, matchKnownHostsEntry, parseKnownHosts } from "@zero-transfer/sdk";
package/package.json CHANGED
@@ -1,10 +1,11 @@
1
1
  {
2
2
  "name": "@zero-transfer/sftp",
3
- "version": "0.1.0-alpha.0",
4
- "description": "SFTP provider with jump-host support for ZeroTransfer.",
3
+ "version": "0.1.2",
4
+ "description": "SFTP with SSH key auth, known_hosts, and jump-host support.",
5
5
  "keywords": [
6
6
  "zero-transfer",
7
7
  "sftp",
8
+ "sftp",
8
9
  "ssh"
9
10
  ],
10
11
  "author": "Tony Wiedman",
@@ -33,7 +34,7 @@
33
34
  "bugs": {
34
35
  "url": "https://github.com/tonywied17/zero-transfer/issues"
35
36
  },
36
- "homepage": "https://github.com/tonywied17/zero-transfer#readme",
37
+ "homepage": "https://github.com/tonywied17/zero-transfer/tree/main/packages/sftp#readme",
37
38
  "engines": {
38
39
  "node": ">=20.0.0"
39
40
  },
@@ -43,7 +44,7 @@
43
44
  "access": "public"
44
45
  },
45
46
  "sideEffects": false,
46
- "dependencies": {
47
- "@zero-transfer/sdk": "0.1.0-alpha.0"
47
+ "peerDependencies": {
48
+ "@zero-transfer/sdk": "0.1.2"
48
49
  }
49
50
  }