@zero-transfer/ftps 0.1.0-alpha.0 → 0.1.1

package/README.md

@@ -1,14 +1,6 @@
 # @zero-transfer/ftps
 
-FTPS (explicit + implicit TLS) provider for ZeroTransfer.
-
-> **Alpha umbrella package.** This package currently re-exports the entire
-> [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk)
-> public surface. Future releases will narrow this package to only its
-> dedicated subset (see the
-> [ZeroTransfer remake plan](https://github.com/tonywied17/zero-transfer/blob/main/zero-transfer-remake.md#future-monorepo-shape)).
-> If you want every provider in one install today, depend on
-> `@zero-transfer/sdk` directly.
+> Explicit and implicit FTPS with full TLS profile support.
 
 ## Install
 
@@ -16,17 +8,41 @@ FTPS (explicit + implicit TLS) provider for ZeroTransfer.
 npm install @zero-transfer/ftps
 ```
 
+## Overview
+
+FTPS over explicit `AUTH TLS` or implicit TLS, with PEM/PFX/P12 certificate sources, encrypted passive data channels, certificate fingerprint pinning, SNI/servername controls, and TLS min/max version configuration.
+
 ## Usage
 
 ```ts
-import { createTransferClient } from "@zero-transfer/ftps";
-
-const client = createTransferClient();
+import { createFtpsProviderFactory } from "@zero-transfer/ftps";
 ```
 
-See the [main README](https://github.com/tonywied17/zero-transfer#readme) for
-full documentation.
+## Public surface
+
+This package narrows [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk) to **4** exports. Every symbol is re-exported from the SDK; the table below links into the full API reference:
+
+| Symbol                                                                                                                                  | Kind      | Notes              |
+| --------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ |
+| [`createFtpsProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createFtpsProviderFactory.md) | Function  | See API reference. |
+| [`FtpsProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/FtpsProviderOptions.md)            | Interface | See API reference. |
+| [`FtpsMode`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/FtpsMode.md)                                | Type      | See API reference. |
+| [`FtpsDataProtection`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/FtpsDataProtection.md)            | Type      | See API reference. |
+
+## Examples
+
+| Example                                                                                                                            | What it shows                                                          |
+| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| [`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. |
+
+## Documentation
+
+- [Scope page](https://github.com/tonywied17/zero-transfer/blob/main/docs/scopes/ftps.md)
+- [Top-level README](https://github.com/tonywied17/zero-transfer/blob/main/README.md)
+- [Full API reference](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/README.md)
+- [Capability matrix](https://github.com/tonywied17/zero-transfer/blob/main/README.md#capability-matrix)
+- [Examples](https://github.com/tonywied17/zero-transfer/tree/main/examples)
 
 ## License
 
-MIT © Tony Wiedman
+MIT © [Tony Wiedman](https://github.com/tonywied17)

package/dist/index.cjs

@@ -1,3 +1,5 @@
-// AUTO-GENERATED stub. See packages/README.md.
+// AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
 "use strict";
-module.exports = require("@zero-transfer/sdk");
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk = require("@zero-transfer/sdk");
+Object.defineProperty(exports, "createFtpsProviderFactory", { enumerable: true, get: () => sdk["createFtpsProviderFactory"] });

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-// AUTO-GENERATED stub. See packages/README.md.
-export * from "@zero-transfer/sdk";
+// AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
+export { createFtpsProviderFactory } from "@zero-transfer/sdk";
+export type { FtpsProviderOptions, FtpsMode, FtpsDataProtection } from "@zero-transfer/sdk";

package/dist/index.mjs

@@ -1,2 +1,2 @@
-// AUTO-GENERATED stub. See packages/README.md.
-export * from "@zero-transfer/sdk";
+// AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
+export { createFtpsProviderFactory } from "@zero-transfer/sdk";

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@zero-transfer/ftps",
-  "version": "0.1.0-alpha.0",
-  "description": "FTPS (explicit + implicit TLS) provider for ZeroTransfer.",
+  "version": "0.1.1",
+  "description": "Explicit and implicit FTPS with full TLS profile support.",
   "keywords": [
     "zero-transfer",
     "ftps",
-    "ftp",
+    "ftps",
     "tls"
   ],
   "author": "Tony Wiedman",
@@ -34,7 +34,7 @@
   "bugs": {
     "url": "https://github.com/tonywied17/zero-transfer/issues"
   },
-  "homepage": "https://github.com/tonywied17/zero-transfer#readme",
+  "homepage": "https://github.com/tonywied17/zero-transfer/tree/main/packages/ftps#readme",
   "engines": {
     "node": ">=20.0.0"
   },
@@ -44,7 +44,7 @@
     "access": "public"
   },
   "sideEffects": false,
-  "dependencies": {
-    "@zero-transfer/sdk": "0.1.0-alpha.0"
+  "peerDependencies": {
+    "@zero-transfer/sdk": "0.1.1"
   }
 }