@zero-transfer/webdav 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 +29 -15
  2. package/dist/index.cjs +4 -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/webdav
2
2
 
3
- WebDAV 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
+ > WebDAV provider with PROPFIND listings and ranged downloads.
12
4
 
13
5
  ## Install
14
6
 
@@ -16,17 +8,39 @@ WebDAV provider for ZeroTransfer.
16
8
  npm install @zero-transfer/webdav
17
9
  ```
18
10
 
11
+ ## Overview
12
+
13
+ WebDAV provider — PROPFIND-based `list`/`stat`, ranged GET, PUT uploads, Basic auth, and ETag preservation. Speaks remote filesystem semantics over HTTP.
14
+
19
15
  ## Usage
20
16
 
21
17
  ```ts
22
- import { createTransferClient } from "@zero-transfer/webdav";
23
-
24
- const client = createTransferClient();
18
+ import { createWebDavProviderFactory } from "@zero-transfer/webdav";
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 **2** 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
+ | [`createWebDavProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createWebDavProviderFactory.md) | Function | See API reference. |
28
+ | [`WebDavProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/WebDavProviderOptions.md) | Interface | See API reference. |
29
+
30
+ ## Examples
31
+
32
+ | Example | What it shows |
33
+ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------- |
34
+ | [`examples/webdav-sync.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/webdav-sync.ts) | WebDAV bidirectional sync example. |
35
+
36
+ ## Documentation
37
+
38
+ - [Scope page](https://github.com/tonywied17/zero-transfer/blob/main/docs/scopes/webdav.md)
39
+ - [Top-level README](https://github.com/tonywied17/zero-transfer/blob/main/README.md)
40
+ - [Full API reference](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/README.md)
41
+ - [Capability matrix](https://github.com/tonywied17/zero-transfer/blob/main/README.md#capability-matrix)
42
+ - [Examples](https://github.com/tonywied17/zero-transfer/tree/main/examples)
29
43
 
30
44
  ## License
31
45
 
32
- MIT © Tony Wiedman
46
+ MIT © [Tony Wiedman](https://github.com/tonywied17)
package/dist/index.cjs CHANGED
@@ -1,3 +1,5 @@
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, "createWebDavProviderFactory", { enumerable: true, get: () => sdk["createWebDavProviderFactory"] });
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 { createWebDavProviderFactory } from "@zero-transfer/sdk";
3
+ export type { WebDavProviderOptions } 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 { createWebDavProviderFactory } from "@zero-transfer/sdk";
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "@zero-transfer/webdav",
3
- "version": "0.1.0-alpha.0",
4
- "description": "WebDAV provider for ZeroTransfer.",
3
+ "version": "0.1.2",
4
+ "description": "WebDAV provider with PROPFIND listings and ranged downloads.",
5
5
  "keywords": [
6
6
  "zero-transfer",
7
+ "webdav",
7
8
  "webdav"
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/webdav#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.2"
47
48
  }
48
49
  }