@zero-transfer/core

Provider-neutral contracts, transfer engine, queue, profiles, and errors.

Install

npm install @zero-transfer/core

Overview

The provider-neutral foundation: TransferClient, createTransferClient, the provider registry, capability sets, transfer engine, queue, planning primitives, profile resolution, secret redaction, structured logging, and typed errors. Every other scoped package builds on this surface.

Usage

import { createLocalProviderFactory } from "@zero-transfer/core";

Public surface

This package publishes a narrowed surface of 92 exports. These symbols are also available from @zero-transfer/sdk; the table below links into the full API reference:

| Symbol | Kind | Notes | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ | | TransferClient | Class | See API reference. | | TransferClientOptions | Interface | See API reference. | | createTransferClient | Function | See API reference. | | ProviderRegistry | Class | See API reference. | | TransferSession | Interface | See API reference. | | TransferProvider | Interface | See API reference. | | ProviderFactory | Interface | See API reference. | | ProviderTransferOperations | Interface | See API reference. | | RemoteFileSystem | Interface | See API reference. | | CapabilitySet | Interface | See API reference. | | AuthenticationCapability | Type | See API reference. | | ChecksumCapability | Type | See API reference. | | MetadataCapability | Type | See API reference. | | BuiltInProviderId | Type | See API reference. | | ProviderId | Type | See API reference. | | ProviderSelection | Interface | See API reference. | | TransferEngine | Class | See API reference. | | TransferQueue | Class | See API reference. | | TransferJob | Interface | See API reference. | | TransferPlan | Interface | See API reference. | | TransferReceipt | Interface | See API reference. | | TransferEndpoint | Interface | See API reference. | | TransferOperation | Type | See API reference. | | TransferAttempt | Interface | See API reference. | | TransferRetryPolicy | Interface | See API reference. | | TransferTimeoutPolicy | Interface | See API reference. | | TransferBandwidthLimit | Interface | See API reference. | | TransferVerificationResult | Interface | See API reference. | | ProviderTransferSessionResolver | Type | See API reference. | | ProviderTransferSessionResolverInput | Interface | See API reference. | | createBandwidthThrottle | Function | See API reference. | | createProviderTransferExecutor | Function | See API reference. | | createTransferJobsFromPlan | Function | See API reference. | | createTransferPlan | Function | See API reference. | | summarizeTransferPlan | Function | See API reference. | | throttleByteIterable | Function | See API reference. | | copyBetween | Function | See API reference. | | uploadFile | Function | See API reference. | | downloadFile | Function | See API reference. | | CopyBetweenOptions | Interface | See API reference. | | UploadFileOptions | Interface | See API reference. | | DownloadFileOptions | Interface | See API reference. | | FriendlyTransferOptions | Type | See API reference. | | RemoteFileEndpoint | Interface | See API reference. | | runConnectionDiagnostics | Function | See API reference. | | summarizeClientDiagnostics | Function | See API reference. | | ClientDiagnostics | Interface | See API reference. | | ConnectionDiagnosticsResult | Interface | See API reference. | | ConnectionDiagnosticTimings | Interface | See API reference. | | RunConnectionDiagnosticsOptions | Interface | See API reference. | | createLocalProviderFactory | Function | See API reference. | | LocalProviderOptions | Interface | See API reference. | | createMemoryProviderFactory | Function | See API reference. | | MemoryProviderOptions | Interface | See API reference. | | MemoryProviderEntry | Interface | See API reference. | | createSyncPlan | Function | See API reference. | | CreateSyncPlanOptions | Interface | See API reference. | | diffRemoteTrees | Function | See API reference. | | DiffRemoteTreesOptions | Interface | See API reference. | | RemoteTreeDiff | Interface | See API reference. | | RemoteTreeDiffEntry | Interface | See API reference. | | RemoteTreeDiffSummary | Interface | See API reference. | | createAtomicDeployPlan | Function | See API reference. | | AtomicDeployPlan | Interface | See API reference. | | AtomicDeployActivateStep | Interface | See API reference. | | AtomicDeployActivateOperation | Type | See API reference. | | AtomicDeployPruneStep | Interface | See API reference. | | AtomicDeployStrategy | Type | See API reference. | | CreateAtomicDeployPlanOptions | Interface | See API reference. | | walkRemoteTree | Function | See API reference. | | WalkRemoteTreeOptions | Interface | See API reference. | | createRemoteBrowser | Function | See API reference. | | RemoteBrowser | Interface | See API reference. | | RemoteBrowserSnapshot | Interface | See API reference. | | ConnectionProfile | Interface | See API reference. | | RemoteEntry | Interface | See API reference. | | RemoteEntryType | Type | See API reference. | | RemoteProtocol | Type | See API reference. | | ListOptions | Interface | See API reference. | | validateConnectionProfile | Function | See API reference. | | resolveConnectionProfileSecrets | Function | See API reference. | | redactConnectionProfile | Function | See API reference. | | redactSecretSource | Function | See API reference. | | resolveSecret | Function | See API reference. | | createOAuthTokenSecretSource | Function | See API reference. | | ResolvedConnectionProfile | Interface | See API reference. | | SecretSource | Type | See API reference. | | ZeroTransferError | Class | See API reference. | | ZeroTransferLogger | Interface | See API reference. | | noopLogger | Variable | See API reference. | | emitLog | Function | See API reference. | | isMainModule | Function | See API reference. |

Examples

| Example | What it shows | | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | examples/local-copy-file.ts | Local-to-local file copy example. | | examples/ftp-basic.ts | Basic FTP upload + download example. | | examples/transfer-queue.ts | Transfer queue with concurrency, progress, and per-job receipts. | | examples/dry-run-sync.ts | Dry-run sync planner. | | examples/diagnose-connection.ts | Diagnose a connection without exposing secrets. |

Documentation

• Scope page
• Top-level README
• Full API reference
• Capability matrix
• Examples

License

MIT © Tony Wiedman