@zero-transfer/classic 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 +36 -15
  2. package/dist/index.cjs +7 -2
  3. package/dist/index.d.ts +3 -2
  4. package/dist/index.mjs +2 -2
  5. package/package.json +7 -7
package/README.md CHANGED
@@ -1,14 +1,6 @@
1
1
  # @zero-transfer/classic
2
2
 
3
- Classic transfer providers (FTP, FTPS, SFTP) 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
+ > FTP, FTPS, and SFTP providers in one install.
12
4
 
13
5
  ## Install
14
6
 
@@ -16,17 +8,46 @@ Classic transfer providers (FTP, FTPS, SFTP) for ZeroTransfer.
16
8
  npm install @zero-transfer/classic
17
9
  ```
18
10
 
11
+ ## Overview
12
+
13
+ Bundle of the three classic providers: FTP, FTPS, and SFTP. Wire `createFtpProviderFactory()`, `createFtpsProviderFactory()`, and `createSftpProviderFactory()` into a single `TransferClient` to talk to traditional file servers.
14
+
19
15
  ## Usage
20
16
 
21
17
  ```ts
22
- import { createTransferClient } from "@zero-transfer/classic";
23
-
24
- const client = createTransferClient();
18
+ import { createFtpProviderFactory } from "@zero-transfer/classic";
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 **8** 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
+ | [`createFtpProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createFtpProviderFactory.md) | Function | See API reference. |
28
+ | [`createFtpsProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createFtpsProviderFactory.md) | Function | See API reference. |
29
+ | [`createSftpProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createSftpProviderFactory.md) | Function | See API reference. |
30
+ | [`createSftpJumpHostSocketFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createSftpJumpHostSocketFactory.md) | Function | See API reference. |
31
+ | [`FtpProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/FtpProviderOptions.md) | Interface | See API reference. |
32
+ | [`FtpsProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/FtpsProviderOptions.md) | Interface | See API reference. |
33
+ | [`SftpProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/SftpProviderOptions.md) | Interface | See API reference. |
34
+ | [`SftpJumpHostOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/SftpJumpHostOptions.md) | Interface | See API reference. |
35
+
36
+ ## Examples
37
+
38
+ | Example | What it shows |
39
+ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
40
+ | [`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. |
41
+ | [`examples/ftps-client-certificate.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/ftps-client-certificate.ts) | FTPS client-certificate (mutual TLS) example with certificate pinning. |
42
+
43
+ ## Documentation
44
+
45
+ - [Scope page](https://github.com/tonywied17/zero-transfer/blob/main/docs/scopes/classic.md)
46
+ - [Top-level README](https://github.com/tonywied17/zero-transfer/blob/main/README.md)
47
+ - [Full API reference](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/README.md)
48
+ - [Capability matrix](https://github.com/tonywied17/zero-transfer/blob/main/README.md#capability-matrix)
49
+ - [Examples](https://github.com/tonywied17/zero-transfer/tree/main/examples)
29
50
 
30
51
  ## License
31
52
 
32
- MIT © Tony Wiedman
53
+ MIT © [Tony Wiedman](https://github.com/tonywied17)
package/dist/index.cjs CHANGED
@@ -1,3 +1,8 @@
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, "createFtpProviderFactory", { enumerable: true, get: () => sdk["createFtpProviderFactory"] });
6
+ Object.defineProperty(exports, "createFtpsProviderFactory", { enumerable: true, get: () => sdk["createFtpsProviderFactory"] });
7
+ Object.defineProperty(exports, "createSftpProviderFactory", { enumerable: true, get: () => sdk["createSftpProviderFactory"] });
8
+ Object.defineProperty(exports, "createSftpJumpHostSocketFactory", { enumerable: true, get: () => sdk["createSftpJumpHostSocketFactory"] });
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 { createFtpProviderFactory, createFtpsProviderFactory, createSftpProviderFactory, createSftpJumpHostSocketFactory } from "@zero-transfer/sdk";
3
+ export type { FtpProviderOptions, FtpsProviderOptions, SftpProviderOptions, SftpJumpHostOptions } 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 { createFtpProviderFactory, createFtpsProviderFactory, createSftpProviderFactory, createSftpJumpHostSocketFactory } from "@zero-transfer/sdk";
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@zero-transfer/classic",
3
- "version": "0.1.0-alpha.0",
4
- "description": "Classic transfer providers (FTP, FTPS, SFTP) for ZeroTransfer.",
3
+ "version": "0.1.2",
4
+ "description": "FTP, FTPS, and SFTP providers in one install.",
5
5
  "keywords": [
6
6
  "zero-transfer",
7
+ "classic",
7
8
  "ftp",
8
9
  "ftps",
9
- "sftp",
10
- "classic"
10
+ "sftp"
11
11
  ],
12
12
  "author": "Tony Wiedman",
13
13
  "license": "MIT",
@@ -35,7 +35,7 @@
35
35
  "bugs": {
36
36
  "url": "https://github.com/tonywied17/zero-transfer/issues"
37
37
  },
38
- "homepage": "https://github.com/tonywied17/zero-transfer#readme",
38
+ "homepage": "https://github.com/tonywied17/zero-transfer/tree/main/packages/classic#readme",
39
39
  "engines": {
40
40
  "node": ">=20.0.0"
41
41
  },
@@ -45,7 +45,7 @@
45
45
  "access": "public"
46
46
  },
47
47
  "sideEffects": false,
48
- "dependencies": {
49
- "@zero-transfer/sdk": "0.1.0-alpha.0"
48
+ "peerDependencies": {
49
+ "@zero-transfer/sdk": "0.1.2"
50
50
  }
51
51
  }