@zero-transfer/webdav 0.4.7 → 0.4.8
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.
- package/dist/index.cjs +396 -123
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +245 -35
- package/dist/index.d.ts +245 -35
- package/dist/index.mjs +393 -123
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -398,6 +398,10 @@ interface TlsProfile {
|
|
|
398
398
|
* trust via `rejectUnauthorized`. Pinning is **recommended for production** when you control
|
|
399
399
|
* the server and want defence-in-depth against rogue certificates issued by trusted CAs.
|
|
400
400
|
*
|
|
401
|
+
* Cannot be combined with `rejectUnauthorized: false`: pin verification runs after the TLS
|
|
402
|
+
* handshake is accepted, so chain validation must stay enabled. Use `ca` for self-signed
|
|
403
|
+
* certificates.
|
|
404
|
+
*
|
|
401
405
|
* @example "AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99"
|
|
402
406
|
*/
|
|
403
407
|
pinnedFingerprint256?: string | readonly string[];
|
|
@@ -675,10 +679,42 @@ interface TransferBandwidthLimit {
|
|
|
675
679
|
/** Optional burst allowance in bytes for token-bucket-style implementations. */
|
|
676
680
|
burstBytes?: number;
|
|
677
681
|
}
|
|
678
|
-
/**
|
|
682
|
+
/**
|
|
683
|
+
* Timeout policy applied by the transfer engine.
|
|
684
|
+
*
|
|
685
|
+
* Two timeout scopes exist with deliberately different failure semantics:
|
|
686
|
+
*
|
|
687
|
+
* - **Job scope** ({@link timeoutMs}): covers the full engine execution
|
|
688
|
+
* including retries. When it fires, the engine rethrows the
|
|
689
|
+
* {@link TimeoutError} immediately - the retry policy is never consulted.
|
|
690
|
+
* - **Attempt scope** ({@link attemptTimeoutMs} and {@link stallTimeoutMs}):
|
|
691
|
+
* covers a single attempt. When either fires, the per-attempt abort
|
|
692
|
+
* controller cancels the attempt and the resulting {@link TimeoutError}
|
|
693
|
+
* flows into the retry policy like any other attempt failure, so retryable
|
|
694
|
+
* timeouts are retried (with backoff) instead of failing the job.
|
|
695
|
+
*
|
|
696
|
+
* @example Retry stalled attempts, but never run longer than 10 minutes total
|
|
697
|
+
* ```ts
|
|
698
|
+
* await engine.execute(job, executor, {
|
|
699
|
+
* retry: createDefaultRetryPolicy(),
|
|
700
|
+
* timeout: { timeoutMs: 600_000, attemptTimeoutMs: 120_000, stallTimeoutMs: 30_000 },
|
|
701
|
+
* });
|
|
702
|
+
* ```
|
|
703
|
+
*/
|
|
679
704
|
interface TransferTimeoutPolicy {
|
|
680
705
|
/** Maximum duration for the full engine execution, including retries, in milliseconds. */
|
|
681
706
|
timeoutMs?: number;
|
|
707
|
+
/**
|
|
708
|
+
* Maximum duration for a single attempt in milliseconds. Expiry aborts only
|
|
709
|
+
* the active attempt; the failure flows into the retry policy.
|
|
710
|
+
*/
|
|
711
|
+
attemptTimeoutMs?: number;
|
|
712
|
+
/**
|
|
713
|
+
* Maximum time without progress before an attempt is considered stalled, in
|
|
714
|
+
* milliseconds. The watchdog resets on every progress report; expiry aborts
|
|
715
|
+
* only the active attempt and the failure flows into the retry policy.
|
|
716
|
+
*/
|
|
717
|
+
stallTimeoutMs?: number;
|
|
682
718
|
/** Whether timeout failures are retryable. Defaults to `true`. */
|
|
683
719
|
retryable?: boolean;
|
|
684
720
|
}
|
|
@@ -803,15 +839,31 @@ interface TransferRetryDecisionInput {
|
|
|
803
839
|
error: unknown;
|
|
804
840
|
/** One-based attempt number that failed. */
|
|
805
841
|
attempt: number;
|
|
842
|
+
/** Milliseconds elapsed since the engine execution started, including prior attempts and delays. */
|
|
843
|
+
elapsedMs: number;
|
|
806
844
|
/** Job being executed. */
|
|
807
845
|
job: TransferJob;
|
|
808
846
|
}
|
|
809
|
-
/**
|
|
847
|
+
/**
|
|
848
|
+
* Retry policy for transfer execution.
|
|
849
|
+
*
|
|
850
|
+
* Use {@link createDefaultRetryPolicy} for a production-ready policy with
|
|
851
|
+
* exponential backoff, full jitter, and `Retry-After` support, or implement
|
|
852
|
+
* the hooks directly for full control.
|
|
853
|
+
*/
|
|
810
854
|
interface TransferRetryPolicy {
|
|
811
855
|
/** Maximum total attempts, including the first attempt. Defaults to `1`. */
|
|
812
856
|
maxAttempts?: number;
|
|
813
857
|
/** Decides whether a failed attempt should be retried. Defaults to SDK retryability metadata. */
|
|
814
858
|
shouldRetry?(input: TransferRetryDecisionInput): boolean;
|
|
859
|
+
/**
|
|
860
|
+
* Computes the delay before the next attempt in milliseconds.
|
|
861
|
+
*
|
|
862
|
+
* The engine sleeps for the returned duration with an abort-aware timer:
|
|
863
|
+
* cancelling the job during the delay rejects immediately instead of
|
|
864
|
+
* waiting out the backoff. Non-positive or missing values retry at once.
|
|
865
|
+
*/
|
|
866
|
+
getDelayMs?(input: TransferRetryDecisionInput): number;
|
|
815
867
|
/** Observes retry decisions before the next attempt starts. */
|
|
816
868
|
onRetry?(input: TransferRetryDecisionInput): void;
|
|
817
869
|
}
|
|
@@ -845,7 +897,12 @@ interface TransferEngineOptions {
|
|
|
845
897
|
*
|
|
846
898
|
* @example Execute a single job with a custom executor
|
|
847
899
|
* ```ts
|
|
848
|
-
* import {
|
|
900
|
+
* import {
|
|
901
|
+
* TransferEngine,
|
|
902
|
+
* createDefaultRetryPolicy,
|
|
903
|
+
* type TransferExecutor,
|
|
904
|
+
* type TransferJob,
|
|
905
|
+
* } from "@zero-transfer/sdk";
|
|
849
906
|
*
|
|
850
907
|
* const engine = new TransferEngine();
|
|
851
908
|
*
|
|
@@ -863,7 +920,8 @@ interface TransferEngineOptions {
|
|
|
863
920
|
* };
|
|
864
921
|
*
|
|
865
922
|
* const receipt = await engine.execute(job, executor, {
|
|
866
|
-
* retry:
|
|
923
|
+
* retry: createDefaultRetryPolicy(),
|
|
924
|
+
* timeout: { stallTimeoutMs: 30_000 },
|
|
867
925
|
* });
|
|
868
926
|
* console.log(receipt.attempts.length); // 1 on success
|
|
869
927
|
* ```
|
|
@@ -1085,6 +1143,40 @@ declare class ProviderRegistry {
|
|
|
1085
1143
|
listCapabilities(): CapabilitySet[];
|
|
1086
1144
|
}
|
|
1087
1145
|
|
|
1146
|
+
/**
|
|
1147
|
+
* Client-level execution defaults applied when a call site does not supply
|
|
1148
|
+
* its own value.
|
|
1149
|
+
*
|
|
1150
|
+
* Defaults are consumed by {@link runRoute}, the one-shot helpers
|
|
1151
|
+
* ({@link uploadFile}, {@link downloadFile}, {@link copyBetween}),
|
|
1152
|
+
* {@link TransferQueue} (via its `client` option), and scheduled routes fired
|
|
1153
|
+
* through {@link MftScheduler}. The {@link TransferEngine} primitive stays
|
|
1154
|
+
* fully explicit: defaults never reach `engine.execute()` directly.
|
|
1155
|
+
*
|
|
1156
|
+
* Per-call options always win over client defaults.
|
|
1157
|
+
*
|
|
1158
|
+
* Additional default slots (`verify`, `resume`, `compression`, `policy`) land
|
|
1159
|
+
* here as their features ship in later releases; the shape is additive.
|
|
1160
|
+
*
|
|
1161
|
+
* @example Resilient defaults for every transfer in an application
|
|
1162
|
+
* ```ts
|
|
1163
|
+
* import { createDefaultRetryPolicy, createTransferClient } from "@zero-transfer/sdk";
|
|
1164
|
+
*
|
|
1165
|
+
* const client = createTransferClient({
|
|
1166
|
+
* providers: [createSftpProviderFactory(), createS3ProviderFactory()],
|
|
1167
|
+
* defaults: {
|
|
1168
|
+
* retry: createDefaultRetryPolicy(),
|
|
1169
|
+
* timeout: { stallTimeoutMs: 30_000 },
|
|
1170
|
+
* },
|
|
1171
|
+
* });
|
|
1172
|
+
* ```
|
|
1173
|
+
*/
|
|
1174
|
+
interface TransferClientDefaults {
|
|
1175
|
+
/** Default retry policy for transfers executed through this client. */
|
|
1176
|
+
retry?: TransferRetryPolicy;
|
|
1177
|
+
/** Default timeout policy for transfers executed through this client. */
|
|
1178
|
+
timeout?: TransferTimeoutPolicy;
|
|
1179
|
+
}
|
|
1088
1180
|
/** Options used to create a provider-neutral transfer client. */
|
|
1089
1181
|
interface TransferClientOptions {
|
|
1090
1182
|
/** Existing registry to reuse. When omitted, a fresh empty registry is created. */
|
|
@@ -1093,16 +1185,20 @@ interface TransferClientOptions {
|
|
|
1093
1185
|
providers?: ProviderFactory[];
|
|
1094
1186
|
/** Structured logger used for client lifecycle records. */
|
|
1095
1187
|
logger?: ZeroTransferLogger;
|
|
1188
|
+
/** Execution defaults applied when call sites omit their own values. */
|
|
1189
|
+
defaults?: TransferClientDefaults;
|
|
1096
1190
|
}
|
|
1097
1191
|
/** Small provider-neutral client that owns provider lookup and connection setup. */
|
|
1098
1192
|
declare class TransferClient {
|
|
1099
1193
|
/** Provider registry used by this client. */
|
|
1100
1194
|
readonly registry: ProviderRegistry;
|
|
1195
|
+
/** Execution defaults applied when call sites omit their own values. */
|
|
1196
|
+
readonly defaults?: TransferClientDefaults;
|
|
1101
1197
|
private readonly logger;
|
|
1102
1198
|
/**
|
|
1103
1199
|
* Creates a transfer client without opening any provider connections.
|
|
1104
1200
|
*
|
|
1105
|
-
* @param options - Optional registry, provider factories, and
|
|
1201
|
+
* @param options - Optional registry, provider factories, logger, and execution defaults.
|
|
1106
1202
|
*/
|
|
1107
1203
|
constructor(options?: TransferClientOptions);
|
|
1108
1204
|
/**
|
|
@@ -1436,11 +1532,11 @@ interface RunRouteOptions {
|
|
|
1436
1532
|
now?: () => Date;
|
|
1437
1533
|
/** Abort signal used to cancel the route execution. */
|
|
1438
1534
|
signal?: AbortSignal;
|
|
1439
|
-
/** Retry policy forwarded to the engine. */
|
|
1535
|
+
/** Retry policy forwarded to the engine. Falls back to `client.defaults.retry`. */
|
|
1440
1536
|
retry?: TransferRetryPolicy;
|
|
1441
1537
|
/** Progress observer forwarded to the engine. */
|
|
1442
1538
|
onProgress?: (event: TransferProgressEvent) => void;
|
|
1443
|
-
/** Timeout policy forwarded to the engine. */
|
|
1539
|
+
/** Timeout policy forwarded to the engine. Falls back to `client.defaults.timeout`. */
|
|
1444
1540
|
timeout?: TransferTimeoutPolicy;
|
|
1445
1541
|
/** Optional bandwidth limit forwarded to the engine. */
|
|
1446
1542
|
bandwidthLimit?: TransferBandwidthLimit;
|
|
@@ -2083,8 +2179,13 @@ interface FileZillaSite {
|
|
|
2083
2179
|
folder: readonly string[];
|
|
2084
2180
|
/** Generated connection profile. */
|
|
2085
2181
|
profile: ConnectionProfile;
|
|
2086
|
-
/**
|
|
2087
|
-
|
|
2182
|
+
/**
|
|
2183
|
+
* Whether the FileZilla entry stored a password. The importer never decodes
|
|
2184
|
+
* or returns stored passwords; supply the credential via a
|
|
2185
|
+
* {@link ConnectionProfile.password | SecretSource} (for example
|
|
2186
|
+
* `{ env: "SITE_PASSWORD" }` or `{ path: "./secret" }`) before connecting.
|
|
2187
|
+
*/
|
|
2188
|
+
hasStoredPassword: boolean;
|
|
2088
2189
|
/** Logon type code preserved from the file (`0`=anonymous, `1`=normal, etc.). */
|
|
2089
2190
|
logonType?: number;
|
|
2090
2191
|
}
|
|
@@ -2141,16 +2242,6 @@ interface ImportWinScpSessionsResult {
|
|
|
2141
2242
|
*/
|
|
2142
2243
|
declare function importWinScpSessions(ini: string): ImportWinScpSessionsResult;
|
|
2143
2244
|
|
|
2144
|
-
/**
|
|
2145
|
-
* Structured ZeroTransfer error hierarchy.
|
|
2146
|
-
*
|
|
2147
|
-
* The classes in this module preserve protocol details, retryability, command/path
|
|
2148
|
-
* context, and machine-readable codes so application code does not need to parse
|
|
2149
|
-
* human error messages.
|
|
2150
|
-
*
|
|
2151
|
-
* @module errors/ZeroTransferError
|
|
2152
|
-
*/
|
|
2153
|
-
|
|
2154
2245
|
/**
|
|
2155
2246
|
* Complete set of fields required to create a ZeroTransfer error.
|
|
2156
2247
|
*/
|
|
@@ -2216,6 +2307,11 @@ declare class ZeroTransferError extends Error {
|
|
|
2216
2307
|
/**
|
|
2217
2308
|
* Serializes the error into a plain object suitable for logs or API responses.
|
|
2218
2309
|
*
|
|
2310
|
+
* `details` and `command` are passed through secret redaction so serialized
|
|
2311
|
+
* errors never leak credentials, signed URLs, or raw protocol commands. The
|
|
2312
|
+
* live {@link ZeroTransferError.details | details} property stays unredacted
|
|
2313
|
+
* for programmatic consumers.
|
|
2314
|
+
*
|
|
2219
2315
|
* @returns A JSON-safe object containing public structured error fields.
|
|
2220
2316
|
*/
|
|
2221
2317
|
toJSON(): Record<string, unknown>;
|
|
@@ -2419,6 +2515,32 @@ declare function redactValue(value: unknown): unknown;
|
|
|
2419
2515
|
* @returns A shallow object copy with sensitive fields and nested secrets redacted.
|
|
2420
2516
|
*/
|
|
2421
2517
|
declare function redactObject(input: Record<string, unknown>): Record<string, unknown>;
|
|
2518
|
+
/**
|
|
2519
|
+
* Strips credentials and query/fragment content from a URL before logging.
|
|
2520
|
+
*
|
|
2521
|
+
* Query strings routinely carry bearer material - SigV4 `X-Amz-Signature`
|
|
2522
|
+
* values, SAS tokens, signed-URL parameters - so the entire search and hash
|
|
2523
|
+
* segments are replaced rather than filtered key-by-key. Embedded
|
|
2524
|
+
* `user:password@` userinfo is removed. Origin and pathname are preserved
|
|
2525
|
+
* because they are what operators need to correlate a failing request.
|
|
2526
|
+
*
|
|
2527
|
+
* @param url - Absolute URL string or `URL` instance to sanitize.
|
|
2528
|
+
* @returns A loggable URL string, or {@link REDACTED} when the value cannot be
|
|
2529
|
+
* parsed as a URL (an unparsable value may still embed credentials).
|
|
2530
|
+
*/
|
|
2531
|
+
declare function redactUrlForLogging(url: string | URL): string;
|
|
2532
|
+
/**
|
|
2533
|
+
* Converts an arbitrary thrown value into a JSON-safe, secret-free record.
|
|
2534
|
+
*
|
|
2535
|
+
* Structured SDK errors are serialized through their `toJSON()` (which already
|
|
2536
|
+
* redacts details); plain errors contribute name/message/stack-free context;
|
|
2537
|
+
* other values are stringified. Use this at every internal log site that
|
|
2538
|
+
* records a caught error.
|
|
2539
|
+
*
|
|
2540
|
+
* @param error - Caught value of unknown shape.
|
|
2541
|
+
* @returns A redacted, JSON-safe object describing the error.
|
|
2542
|
+
*/
|
|
2543
|
+
declare function redactErrorForLogging(error: unknown): Record<string, unknown>;
|
|
2422
2544
|
|
|
2423
2545
|
/** Sleep helper signature used by {@link createBandwidthThrottle}. */
|
|
2424
2546
|
type BandwidthSleep = (delayMs: number, signal?: AbortSignal) => Promise<void>;
|
|
@@ -2470,6 +2592,73 @@ declare function createBandwidthThrottle(limit: TransferBandwidthLimit | undefin
|
|
|
2470
2592
|
*/
|
|
2471
2593
|
declare function throttleByteIterable(source: AsyncIterable<Uint8Array>, throttle: BandwidthThrottle | undefined, signal?: AbortSignal): AsyncIterable<Uint8Array>;
|
|
2472
2594
|
|
|
2595
|
+
/** Options for {@link createDefaultRetryPolicy}. */
|
|
2596
|
+
interface DefaultRetryPolicyOptions {
|
|
2597
|
+
/** Maximum total attempts, including the first attempt. Defaults to `4`. */
|
|
2598
|
+
maxAttempts?: number;
|
|
2599
|
+
/** Base backoff delay before jitter in milliseconds. Defaults to `250`. */
|
|
2600
|
+
baseDelayMs?: number;
|
|
2601
|
+
/** Upper bound for a single computed backoff delay in milliseconds. Defaults to `30_000`. */
|
|
2602
|
+
maxDelayMs?: number;
|
|
2603
|
+
/**
|
|
2604
|
+
* Total elapsed-time budget across all attempts and delays in milliseconds.
|
|
2605
|
+
* Once exceeded, no further retries are attempted. Defaults to `300_000` (5 minutes).
|
|
2606
|
+
*/
|
|
2607
|
+
maxElapsedMs?: number;
|
|
2608
|
+
/**
|
|
2609
|
+
* Random source in `[0, 1)` used for jitter. Defaults to `Math.random`.
|
|
2610
|
+
* Inject a deterministic source in tests.
|
|
2611
|
+
*/
|
|
2612
|
+
random?: () => number;
|
|
2613
|
+
}
|
|
2614
|
+
/**
|
|
2615
|
+
* Creates the SDK's recommended retry policy for transfer execution.
|
|
2616
|
+
*
|
|
2617
|
+
* The policy retries only failures the SDK has marked as safe to retry
|
|
2618
|
+
* (`error.retryable === true` on a {@link ZeroTransferError}), backing off
|
|
2619
|
+
* exponentially with full jitter: each delay is drawn uniformly from
|
|
2620
|
+
* `[0, min(maxDelayMs, baseDelayMs * 2^(attempt - 1)))`, the schedule that
|
|
2621
|
+
* minimizes contention when many clients retry against the same server.
|
|
2622
|
+
*
|
|
2623
|
+
* Server pacing hints are honored: when the failed attempt carries
|
|
2624
|
+
* `details.retryAfterMs` (parsed from an HTTP `Retry-After` header on 429/503
|
|
2625
|
+
* responses by the web-family providers), the next delay is exactly that
|
|
2626
|
+
* value rather than the jittered backoff. A hint that does not fit in the
|
|
2627
|
+
* remaining `maxElapsedMs` budget stops retrying instead of retrying early.
|
|
2628
|
+
*
|
|
2629
|
+
* Retries also stop once `maxElapsedMs` has elapsed since execution started,
|
|
2630
|
+
* regardless of how many attempts remain.
|
|
2631
|
+
*
|
|
2632
|
+
* @param options - Optional overrides for attempts, delays, and the elapsed budget.
|
|
2633
|
+
* @returns A {@link TransferRetryPolicy} for {@link TransferEngine.execute},
|
|
2634
|
+
* {@link runRoute}, {@link TransferQueue}, or client-level defaults.
|
|
2635
|
+
*
|
|
2636
|
+
* @example Default policy on a one-shot helper
|
|
2637
|
+
* ```ts
|
|
2638
|
+
* import { createDefaultRetryPolicy, uploadFile } from "@zero-transfer/sdk";
|
|
2639
|
+
*
|
|
2640
|
+
* await uploadFile({
|
|
2641
|
+
* client,
|
|
2642
|
+
* destination: { path: "/uploads/report.csv", profile },
|
|
2643
|
+
* localPath: "./out/report.csv",
|
|
2644
|
+
* retry: createDefaultRetryPolicy(),
|
|
2645
|
+
* });
|
|
2646
|
+
* ```
|
|
2647
|
+
*
|
|
2648
|
+
* @example Tighter schedule for latency-sensitive work
|
|
2649
|
+
* ```ts
|
|
2650
|
+
* const retry = createDefaultRetryPolicy({
|
|
2651
|
+
* maxAttempts: 3,
|
|
2652
|
+
* baseDelayMs: 100,
|
|
2653
|
+
* maxDelayMs: 2_000,
|
|
2654
|
+
* maxElapsedMs: 15_000,
|
|
2655
|
+
* });
|
|
2656
|
+
* ```
|
|
2657
|
+
*
|
|
2658
|
+
* @see {@link TransferRetryPolicy} for the underlying hook contract.
|
|
2659
|
+
*/
|
|
2660
|
+
declare function createDefaultRetryPolicy(options?: DefaultRetryPolicyOptions): TransferRetryPolicy;
|
|
2661
|
+
|
|
2473
2662
|
/**
|
|
2474
2663
|
* Transfer executor bridge for provider-backed read/write sessions.
|
|
2475
2664
|
*
|
|
@@ -2625,6 +2814,12 @@ declare function summarizeTransferPlan(plan: TransferPlan): TransferPlanSummary;
|
|
|
2625
2814
|
/** Converts executable plan steps into transfer jobs while preserving order. */
|
|
2626
2815
|
declare function createTransferJobsFromPlan(plan: TransferPlan): TransferJob[];
|
|
2627
2816
|
|
|
2817
|
+
/**
|
|
2818
|
+
* Transfer queue primitives built on top of {@link TransferEngine}.
|
|
2819
|
+
*
|
|
2820
|
+
* @module transfers/TransferQueue
|
|
2821
|
+
*/
|
|
2822
|
+
|
|
2628
2823
|
/** Queue item lifecycle state. */
|
|
2629
2824
|
type TransferQueueItemStatus = "queued" | "running" | "completed" | "failed" | "canceled";
|
|
2630
2825
|
/** Resolver used when jobs do not provide an executor at enqueue time. */
|
|
@@ -2633,15 +2828,20 @@ type TransferQueueExecutorResolver = (job: TransferJob) => TransferExecutor;
|
|
|
2633
2828
|
interface TransferQueueOptions {
|
|
2634
2829
|
/** Transfer engine used to execute queued jobs. Defaults to a new engine. */
|
|
2635
2830
|
engine?: TransferEngine;
|
|
2831
|
+
/**
|
|
2832
|
+
* Transfer client whose {@link TransferClientDefaults | defaults} seed the
|
|
2833
|
+
* queue's retry and timeout policies when not set here or per drain.
|
|
2834
|
+
*/
|
|
2835
|
+
client?: TransferClient;
|
|
2636
2836
|
/** Maximum jobs to execute at the same time. Defaults to `1`. */
|
|
2637
2837
|
concurrency?: number;
|
|
2638
2838
|
/** Default executor used for jobs that do not provide one directly. */
|
|
2639
2839
|
executor?: TransferExecutor;
|
|
2640
2840
|
/** Dynamic executor resolver used when no per-job executor or default executor exists. */
|
|
2641
2841
|
resolveExecutor?: TransferQueueExecutorResolver;
|
|
2642
|
-
/** Retry policy passed to engine executions. */
|
|
2842
|
+
/** Retry policy passed to engine executions. Falls back to `client.defaults.retry`. */
|
|
2643
2843
|
retry?: TransferRetryPolicy;
|
|
2644
|
-
/** Timeout policy passed to engine executions. */
|
|
2844
|
+
/** Timeout policy passed to engine executions. Falls back to `client.defaults.timeout`. */
|
|
2645
2845
|
timeout?: TransferTimeoutPolicy;
|
|
2646
2846
|
/** Optional throughput limit shape passed to transfer executors. */
|
|
2647
2847
|
bandwidthLimit?: TransferBandwidthLimit;
|
|
@@ -3436,10 +3636,14 @@ declare function createProgressEvent(input: ProgressEventInput): TransferProgres
|
|
|
3436
3636
|
/**
|
|
3437
3637
|
* Validates that an FTP command argument cannot inject additional command lines.
|
|
3438
3638
|
*
|
|
3639
|
+
* NUL bytes are rejected alongside CR/LF: C-string-based servers and filesystem
|
|
3640
|
+
* APIs truncate at the first NUL, which lets a crafted path smuggle a different
|
|
3641
|
+
* effective target past validation.
|
|
3642
|
+
*
|
|
3439
3643
|
* @param value - Argument value to validate.
|
|
3440
3644
|
* @param label - Human-readable argument label used in error messages.
|
|
3441
3645
|
* @returns The original value when it is safe.
|
|
3442
|
-
* @throws {@link ConfigurationError} When the value contains CR or
|
|
3646
|
+
* @throws {@link ConfigurationError} When the value contains CR, LF, or NUL characters.
|
|
3443
3647
|
*/
|
|
3444
3648
|
declare function assertSafeFtpArgument(value: string, label?: string): string;
|
|
3445
3649
|
/**
|
|
@@ -3447,7 +3651,7 @@ declare function assertSafeFtpArgument(value: string, label?: string): string;
|
|
|
3447
3651
|
*
|
|
3448
3652
|
* @param input - Remote path that may contain duplicate separators or dot segments.
|
|
3449
3653
|
* @returns A normalized remote path, `/` for absolute root, or `.` for an empty relative path.
|
|
3450
|
-
* @throws {@link ConfigurationError} When the input contains unsafe CR or
|
|
3654
|
+
* @throws {@link ConfigurationError} When the input contains unsafe CR, LF, or NUL characters.
|
|
3451
3655
|
*/
|
|
3452
3656
|
declare function normalizeRemotePath(input: string): string;
|
|
3453
3657
|
/**
|
|
@@ -3488,20 +3692,26 @@ interface WebDavProviderOptions {
|
|
|
3488
3692
|
fetch?: HttpFetch;
|
|
3489
3693
|
/** Default headers applied to every request. */
|
|
3490
3694
|
defaultHeaders?: Record<string, string>;
|
|
3695
|
+
/**
|
|
3696
|
+
* Rejects factory creation when the transport is cleartext `http`. Defaults
|
|
3697
|
+
* to `false`, where connecting with credentials over cleartext emits a
|
|
3698
|
+
* process `SecurityWarning` instead of failing.
|
|
3699
|
+
*/
|
|
3700
|
+
enforceHttps?: boolean;
|
|
3491
3701
|
/**
|
|
3492
3702
|
* Streaming policy for `PUT` request bodies.
|
|
3493
3703
|
*
|
|
3494
|
-
* - `"
|
|
3495
|
-
*
|
|
3496
|
-
*
|
|
3497
|
-
*
|
|
3498
|
-
*
|
|
3499
|
-
*
|
|
3500
|
-
*
|
|
3501
|
-
*
|
|
3502
|
-
*
|
|
3503
|
-
*
|
|
3504
|
-
*
|
|
3704
|
+
* - `"always"` (default since 0.5) - always stream the body so memory use
|
|
3705
|
+
* stays bounded regardless of payload size. When the caller declares
|
|
3706
|
+
* `request.totalBytes` an explicit `Content-Length` is still sent (no
|
|
3707
|
+
* chunked encoding); only unknown-size uploads fall back to HTTP/1.1
|
|
3708
|
+
* chunked transfer-encoding. Some legacy WebDAV servers reject
|
|
3709
|
+
* `Transfer-Encoding: chunked` and respond `411 Length Required` or
|
|
3710
|
+
* `501 Not Implemented`; point those at `"when-known-size"`.
|
|
3711
|
+
* - `"when-known-size"` (default before 0.5) - stream only when
|
|
3712
|
+
* `request.totalBytes` is known; unknown-size bodies are buffered
|
|
3713
|
+
* entirely in memory so a `Content-Length` can always be sent. Use for
|
|
3714
|
+
* servers that require a declared length on every upload.
|
|
3505
3715
|
* - `"never"` - always buffer (legacy behaviour pre-0.4.0). Use for
|
|
3506
3716
|
* maximum compatibility at the cost of memory.
|
|
3507
3717
|
*/
|
|
@@ -3546,4 +3756,4 @@ interface WebDavProviderOptions {
|
|
|
3546
3756
|
*/
|
|
3547
3757
|
declare function createWebDavProviderFactory(options?: WebDavProviderOptions): ProviderFactory;
|
|
3548
3758
|
|
|
3549
|
-
export { AbortError, type AtomicDeployActivateOperation, type AtomicDeployActivateStep, type AtomicDeployPlan, type AtomicDeployPruneStep, type AtomicDeployStrategy, type AuthenticationCapability, AuthenticationError, AuthorizationError, type BandwidthSleep, type BandwidthThrottle, type BandwidthThrottleOptions, type Base64EnvSecretSource, type BuiltInProviderId, CLASSIC_PROVIDER_IDS, type CapabilitySet, type ChecksumCapability, type ClassicProviderId, type ClientDiagnostics, type CompareRemoteManifestsOptions, ConfigurationError, type ConnectionDiagnosticTimings, type ConnectionDiagnosticsResult, ConnectionError, type ConnectionPoolOptions, type ConnectionProfile, type CopyBetweenOptions, type CreateAtomicDeployPlanOptions, type CreateRemoteBrowserOptions, type CreateRemoteManifestOptions, type CreateSyncPlanOptions, type DiffRemoteTreesOptions, type DownloadFileOptions, type EnvSecretSource, type FileSecretSource, type FileZillaSite, type FriendlyTransferOptions, type FtpReplyErrorInput, type ImportFileZillaSitesResult, type ImportOpenSshConfigOptions, type ImportOpenSshConfigResult, type ImportWinScpSessionsResult, type KnownHostsEntry, type KnownHostsMarker, type ListOptions, type LocalProviderOptions, type LogLevel, type LogRecord, type LogRecordInput, type LoggerMethod, type MemoryProviderEntry, type MemoryProviderOptions, type MetadataCapability, type MkdirOptions, type OAuthAccessToken, type OAuthRefreshCallback, type OAuthTokenSecretSourceOptions, type OpenSshConfigEntry, ParseError, PathAlreadyExistsError, PathNotFoundError, PermissionDeniedError, type PooledTransferClient, type ProgressEventInput, ProtocolError, type ProviderFactory, type ProviderId, ProviderRegistry, type ProviderSelection, type ProviderTransferEndpointRole, type ProviderTransferExecutorOptions, type ProviderTransferOperations, type ProviderTransferReadRequest, type ProviderTransferReadResult, type ProviderTransferRequest, type ProviderTransferSessionResolver, type ProviderTransferSessionResolverInput, type ProviderTransferWriteRequest, type ProviderTransferWriteResult, REDACTED, REMOTE_MANIFEST_FORMAT_VERSION, type RemoteBreadcrumb, type RemoteBrowser, type RemoteBrowserFilter, type RemoteBrowserSnapshot, type RemoteEntry, type RemoteEntrySortKey, type RemoteEntrySortOrder, type RemoteEntryType, type RemoteFileAdapter, type RemoteFileEndpoint, type RemoteFileSystem, type RemoteManifest, type RemoteManifestEntry, type RemotePermissions, type RemoteProtocol, type RemoteStat, type RemoteTreeDiff, type RemoteTreeDiffEntry, type RemoteTreeDiffReason, type RemoteTreeDiffStatus, type RemoteTreeDiffSummary, type RemoteTreeEntry, type RemoteTreeFilter, type RemoveOptions, type RenameOptions, type ResolveSecretOptions, type ResolvedConnectionProfile, type ResolvedOpenSshHost, type ResolvedSshProfile, type ResolvedTlsProfile, type RmdirOptions, type RunConnectionDiagnosticsOptions, type SecretProvider, type SecretSource, type SecretValue, type SpecializedErrorDetails, type SshAgentSource, type SshAlgorithms, type SshKeyboardInteractiveChallenge, type SshKeyboardInteractiveHandler, type SshKeyboardInteractivePrompt, type SshKnownHostsSource, type SshProfile, type SshSocketFactory, type SshSocketFactoryContext, type StatOptions, type SyncConflictPolicy, type SyncDeletePolicy, type SyncDirection, type SyncEndpointInput, TimeoutError, type TlsProfile, type TlsSecretSource, type TransferAttempt, type TransferAttemptError, type TransferBandwidthLimit, type TransferByteRange, TransferClient, type TransferClientOptions, type TransferDataChunk, type TransferDataSource, type TransferEndpoint, TransferEngine, type TransferEngineExecuteOptions, type TransferEngineOptions, TransferError, type TransferExecutionContext, type TransferExecutionResult, type TransferExecutor, type TransferJob, type TransferOperation, type TransferPlan, type TransferPlanAction, type TransferPlanInput, type TransferPlanStep, type TransferPlanSummary, type TransferProgressEvent, type TransferProvider, TransferQueue, type TransferQueueExecutorResolver, type TransferQueueItem, type TransferQueueItemStatus, type TransferQueueOptions, type TransferQueueRunOptions, type TransferQueueSummary, type TransferReceipt, type TransferResult, type TransferResultInput, type TransferRetryDecisionInput, type TransferRetryPolicy, type TransferSession, type TransferTimeoutPolicy, type TransferVerificationResult, UnsupportedFeatureError, type UploadFileOptions, type ValueSecretSource, VerificationError, type WalkRemoteTreeOptions, type WebDavProviderOptions, type WinScpSession, ZeroTransfer, type ZeroTransferCapabilities, ZeroTransferError, type ZeroTransferErrorDetails, type ZeroTransferLogger, type ZeroTransferOptions, assertSafeFtpArgument, basenameRemotePath, buildRemoteBreadcrumbs, compareRemoteManifests, copyBetween, createAtomicDeployPlan, createBandwidthThrottle, createLocalProviderFactory, createMemoryProviderFactory, createOAuthTokenSecretSource, createPooledTransferClient, createProgressEvent, createProviderTransferExecutor, createRemoteBrowser, createRemoteManifest, createSyncPlan, createTransferClient, createTransferJobsFromPlan, createTransferPlan, createTransferResult, createWebDavProviderFactory, diffRemoteTrees, downloadFile, emitLog, errorFromFtpReply, filterRemoteEntries, importFileZillaSites, importOpenSshConfig, importWinScpSessions, isClassicProviderId, isMainModule, isSensitiveKey, joinRemotePath, matchKnownHosts, matchKnownHostsEntry, noopLogger, normalizeRemotePath, parentRemotePath, parseKnownHosts, parseOpenSshConfig, parseRemoteManifest, redactCommand, redactConnectionProfile, redactObject, redactSecretSource, redactValue, resolveConnectionProfileSecrets, resolveOpenSshHost, resolveProviderId, resolveSecret, runConnectionDiagnostics, serializeRemoteManifest, sortRemoteEntries, summarizeClientDiagnostics, summarizeTransferPlan, throttleByteIterable, uploadFile, validateConnectionProfile, walkRemoteTree };
|
|
3759
|
+
export { AbortError, type AtomicDeployActivateOperation, type AtomicDeployActivateStep, type AtomicDeployPlan, type AtomicDeployPruneStep, type AtomicDeployStrategy, type AuthenticationCapability, AuthenticationError, AuthorizationError, type BandwidthSleep, type BandwidthThrottle, type BandwidthThrottleOptions, type Base64EnvSecretSource, type BuiltInProviderId, CLASSIC_PROVIDER_IDS, type CapabilitySet, type ChecksumCapability, type ClassicProviderId, type ClientDiagnostics, type CompareRemoteManifestsOptions, ConfigurationError, type ConnectionDiagnosticTimings, type ConnectionDiagnosticsResult, ConnectionError, type ConnectionPoolOptions, type ConnectionProfile, type CopyBetweenOptions, type CreateAtomicDeployPlanOptions, type CreateRemoteBrowserOptions, type CreateRemoteManifestOptions, type CreateSyncPlanOptions, type DefaultRetryPolicyOptions, type DiffRemoteTreesOptions, type DownloadFileOptions, type EnvSecretSource, type FileSecretSource, type FileZillaSite, type FriendlyTransferOptions, type FtpReplyErrorInput, type ImportFileZillaSitesResult, type ImportOpenSshConfigOptions, type ImportOpenSshConfigResult, type ImportWinScpSessionsResult, type KnownHostsEntry, type KnownHostsMarker, type ListOptions, type LocalProviderOptions, type LogLevel, type LogRecord, type LogRecordInput, type LoggerMethod, type MemoryProviderEntry, type MemoryProviderOptions, type MetadataCapability, type MkdirOptions, type OAuthAccessToken, type OAuthRefreshCallback, type OAuthTokenSecretSourceOptions, type OpenSshConfigEntry, ParseError, PathAlreadyExistsError, PathNotFoundError, PermissionDeniedError, type PooledTransferClient, type ProgressEventInput, ProtocolError, type ProviderFactory, type ProviderId, ProviderRegistry, type ProviderSelection, type ProviderTransferEndpointRole, type ProviderTransferExecutorOptions, type ProviderTransferOperations, type ProviderTransferReadRequest, type ProviderTransferReadResult, type ProviderTransferRequest, type ProviderTransferSessionResolver, type ProviderTransferSessionResolverInput, type ProviderTransferWriteRequest, type ProviderTransferWriteResult, REDACTED, REMOTE_MANIFEST_FORMAT_VERSION, type RemoteBreadcrumb, type RemoteBrowser, type RemoteBrowserFilter, type RemoteBrowserSnapshot, type RemoteEntry, type RemoteEntrySortKey, type RemoteEntrySortOrder, type RemoteEntryType, type RemoteFileAdapter, type RemoteFileEndpoint, type RemoteFileSystem, type RemoteManifest, type RemoteManifestEntry, type RemotePermissions, type RemoteProtocol, type RemoteStat, type RemoteTreeDiff, type RemoteTreeDiffEntry, type RemoteTreeDiffReason, type RemoteTreeDiffStatus, type RemoteTreeDiffSummary, type RemoteTreeEntry, type RemoteTreeFilter, type RemoveOptions, type RenameOptions, type ResolveSecretOptions, type ResolvedConnectionProfile, type ResolvedOpenSshHost, type ResolvedSshProfile, type ResolvedTlsProfile, type RmdirOptions, type RunConnectionDiagnosticsOptions, type SecretProvider, type SecretSource, type SecretValue, type SpecializedErrorDetails, type SshAgentSource, type SshAlgorithms, type SshKeyboardInteractiveChallenge, type SshKeyboardInteractiveHandler, type SshKeyboardInteractivePrompt, type SshKnownHostsSource, type SshProfile, type SshSocketFactory, type SshSocketFactoryContext, type StatOptions, type SyncConflictPolicy, type SyncDeletePolicy, type SyncDirection, type SyncEndpointInput, TimeoutError, type TlsProfile, type TlsSecretSource, type TransferAttempt, type TransferAttemptError, type TransferBandwidthLimit, type TransferByteRange, TransferClient, type TransferClientDefaults, type TransferClientOptions, type TransferDataChunk, type TransferDataSource, type TransferEndpoint, TransferEngine, type TransferEngineExecuteOptions, type TransferEngineOptions, TransferError, type TransferExecutionContext, type TransferExecutionResult, type TransferExecutor, type TransferJob, type TransferOperation, type TransferPlan, type TransferPlanAction, type TransferPlanInput, type TransferPlanStep, type TransferPlanSummary, type TransferProgressEvent, type TransferProvider, TransferQueue, type TransferQueueExecutorResolver, type TransferQueueItem, type TransferQueueItemStatus, type TransferQueueOptions, type TransferQueueRunOptions, type TransferQueueSummary, type TransferReceipt, type TransferResult, type TransferResultInput, type TransferRetryDecisionInput, type TransferRetryPolicy, type TransferSession, type TransferTimeoutPolicy, type TransferVerificationResult, UnsupportedFeatureError, type UploadFileOptions, type ValueSecretSource, VerificationError, type WalkRemoteTreeOptions, type WebDavProviderOptions, type WinScpSession, ZeroTransfer, type ZeroTransferCapabilities, ZeroTransferError, type ZeroTransferErrorDetails, type ZeroTransferLogger, type ZeroTransferOptions, assertSafeFtpArgument, basenameRemotePath, buildRemoteBreadcrumbs, compareRemoteManifests, copyBetween, createAtomicDeployPlan, createBandwidthThrottle, createDefaultRetryPolicy, createLocalProviderFactory, createMemoryProviderFactory, createOAuthTokenSecretSource, createPooledTransferClient, createProgressEvent, createProviderTransferExecutor, createRemoteBrowser, createRemoteManifest, createSyncPlan, createTransferClient, createTransferJobsFromPlan, createTransferPlan, createTransferResult, createWebDavProviderFactory, diffRemoteTrees, downloadFile, emitLog, errorFromFtpReply, filterRemoteEntries, importFileZillaSites, importOpenSshConfig, importWinScpSessions, isClassicProviderId, isMainModule, isSensitiveKey, joinRemotePath, matchKnownHosts, matchKnownHostsEntry, noopLogger, normalizeRemotePath, parentRemotePath, parseKnownHosts, parseOpenSshConfig, parseRemoteManifest, redactCommand, redactConnectionProfile, redactErrorForLogging, redactObject, redactSecretSource, redactUrlForLogging, redactValue, resolveConnectionProfileSecrets, resolveOpenSshHost, resolveProviderId, resolveSecret, runConnectionDiagnostics, serializeRemoteManifest, sortRemoteEntries, summarizeClientDiagnostics, summarizeTransferPlan, throttleByteIterable, uploadFile, validateConnectionProfile, walkRemoteTree };
|