@zero-transfer/ftp 0.1.0-alpha.0 → 0.1.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 (5) hide show
  1. package/README.md +42 -15
  2. package/dist/index.cjs +12 -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/ftp
2
2
 
3
- FTP provider 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
+ > Classic FTP provider with EPSV/PASV streaming and REST resume.
12
4
 
13
5
  ## Install
14
6
 
@@ -16,17 +8,52 @@ FTP provider for ZeroTransfer.
16
8
  npm install @zero-transfer/ftp
17
9
  ```
18
10
 
11
+ ## Overview
12
+
13
+ Plain FTP with EPSV/PASV streaming, REST-resume, MLST/MLSD listings, Unix LIST fallback, and full profile timeout enforcement. Use `createFtpProviderFactory()`.
14
+
19
15
  ## Usage
20
16
 
21
17
  ```ts
22
- import { createTransferClient } from "@zero-transfer/ftp";
23
-
24
- const client = createTransferClient();
18
+ import { createFtpProviderFactory } from "@zero-transfer/ftp";
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 **14** 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
+ | [`FtpProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/FtpProviderOptions.md) | Interface | See API reference. |
29
+ | [`FtpPassiveHostStrategy`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/FtpPassiveHostStrategy.md) | Type | See API reference. |
30
+ | [`FtpResponse`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/FtpResponse.md) | Interface | See API reference. |
31
+ | [`FtpResponseStatus`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/FtpResponseStatus.md) | Type | See API reference. |
32
+ | [`FtpFeatures`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/FtpFeatures.md) | Interface | See API reference. |
33
+ | [`FtpResponseParser`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/FtpResponseParser.md) | Class | See API reference. |
34
+ | [`parseFtpFeatures`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseFtpFeatures.md) | Function | See API reference. |
35
+ | [`parseFtpResponseLines`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseFtpResponseLines.md) | Function | See API reference. |
36
+ | [`parseMlsdLine`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseMlsdLine.md) | Function | See API reference. |
37
+ | [`parseMlsdList`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseMlsdList.md) | Function | See API reference. |
38
+ | [`parseMlstTimestamp`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseMlstTimestamp.md) | Function | See API reference. |
39
+ | [`parseUnixList`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseUnixList.md) | Function | See API reference. |
40
+ | [`parseUnixListLine`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/parseUnixListLine.md) | Function | See API reference. |
41
+
42
+ ## Examples
43
+
44
+ | Example | What it shows |
45
+ | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
46
+ | [`examples/ftp-basic.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/ftp-basic.ts) | Basic FTP upload + download example. |
47
+ | [`examples/transfer-queue.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/transfer-queue.ts) | Transfer queue with concurrency, progress, and per-job receipts. |
48
+
49
+ ## Documentation
50
+
51
+ - [Scope page](https://github.com/tonywied17/zero-transfer/blob/main/docs/scopes/ftp.md)
52
+ - [Top-level README](https://github.com/tonywied17/zero-transfer/blob/main/README.md)
53
+ - [Full API reference](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/README.md)
54
+ - [Capability matrix](https://github.com/tonywied17/zero-transfer/blob/main/README.md#capability-matrix)
55
+ - [Examples](https://github.com/tonywied17/zero-transfer/tree/main/examples)
29
56
 
30
57
  ## License
31
58
 
32
- MIT © Tony Wiedman
59
+ MIT © [Tony Wiedman](https://github.com/tonywied17)
package/dist/index.cjs CHANGED
@@ -1,3 +1,13 @@
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, "FtpResponseParser", { enumerable: true, get: () => sdk["FtpResponseParser"] });
7
+ Object.defineProperty(exports, "parseFtpFeatures", { enumerable: true, get: () => sdk["parseFtpFeatures"] });
8
+ Object.defineProperty(exports, "parseFtpResponseLines", { enumerable: true, get: () => sdk["parseFtpResponseLines"] });
9
+ Object.defineProperty(exports, "parseMlsdLine", { enumerable: true, get: () => sdk["parseMlsdLine"] });
10
+ Object.defineProperty(exports, "parseMlsdList", { enumerable: true, get: () => sdk["parseMlsdList"] });
11
+ Object.defineProperty(exports, "parseMlstTimestamp", { enumerable: true, get: () => sdk["parseMlstTimestamp"] });
12
+ Object.defineProperty(exports, "parseUnixList", { enumerable: true, get: () => sdk["parseUnixList"] });
13
+ Object.defineProperty(exports, "parseUnixListLine", { enumerable: true, get: () => sdk["parseUnixListLine"] });
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, FtpResponseParser, parseFtpFeatures, parseFtpResponseLines, parseMlsdLine, parseMlsdList, parseMlstTimestamp, parseUnixList, parseUnixListLine } from "@zero-transfer/sdk";
3
+ export type { FtpProviderOptions, FtpPassiveHostStrategy, FtpResponse, FtpResponseStatus, FtpFeatures } 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, FtpResponseParser, parseFtpFeatures, parseFtpResponseLines, parseMlsdLine, parseMlsdList, parseMlstTimestamp, parseUnixList, parseUnixListLine } from "@zero-transfer/sdk";
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "@zero-transfer/ftp",
3
- "version": "0.1.0-alpha.0",
4
- "description": "FTP provider for ZeroTransfer.",
3
+ "version": "0.1.1",
4
+ "description": "Classic FTP provider with EPSV/PASV streaming and REST resume.",
5
5
  "keywords": [
6
6
  "zero-transfer",
7
+ "ftp",
7
8
  "ftp"
8
9
  ],
9
10
  "author": "Tony Wiedman",
@@ -32,7 +33,7 @@
32
33
  "bugs": {
33
34
  "url": "https://github.com/tonywied17/zero-transfer/issues"
34
35
  },
35
- "homepage": "https://github.com/tonywied17/zero-transfer#readme",
36
+ "homepage": "https://github.com/tonywied17/zero-transfer/tree/main/packages/ftp#readme",
36
37
  "engines": {
37
38
  "node": ">=20.0.0"
38
39
  },
@@ -42,7 +43,7 @@
42
43
  "access": "public"
43
44
  },
44
45
  "sideEffects": false,
45
- "dependencies": {
46
- "@zero-transfer/sdk": "0.1.0-alpha.0"
46
+ "peerDependencies": {
47
+ "@zero-transfer/sdk": "0.1.1"
47
48
  }
48
49
  }