@zero-transfer/http 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.
- package/README.md +30 -15
- package/dist/index.cjs +4 -2
- package/dist/index.d.ts +3 -2
- package/dist/index.mjs +2 -2
- package/package.json +6 -5
package/README.md
CHANGED
|
@@ -1,14 +1,6 @@
|
|
|
1
1
|
# @zero-transfer/http
|
|
2
2
|
|
|
3
|
-
HTTP(S)
|
|
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
|
+
> HTTP(S) and signed-URL provider with ranged downloads.
|
|
12
4
|
|
|
13
5
|
## Install
|
|
14
6
|
|
|
@@ -16,17 +8,40 @@ HTTP(S) provider with signed URL support for ZeroTransfer.
|
|
|
16
8
|
npm install @zero-transfer/http
|
|
17
9
|
```
|
|
18
10
|
|
|
11
|
+
## Overview
|
|
12
|
+
|
|
13
|
+
Read-only HTTP(S) provider with HEAD-based metadata, ranged GET resume, Basic auth, Bearer-token auth via secret sources, and ETag exposed as both `uniqueId` and read-result `checksum`. Useful for signed-URL downloads and CDN ingest.
|
|
14
|
+
|
|
19
15
|
## Usage
|
|
20
16
|
|
|
21
17
|
```ts
|
|
22
|
-
import {
|
|
23
|
-
|
|
24
|
-
const client = createTransferClient();
|
|
18
|
+
import { createHttpProviderFactory } from "@zero-transfer/http";
|
|
25
19
|
```
|
|
26
20
|
|
|
27
|
-
|
|
28
|
-
|
|
21
|
+
## Public surface
|
|
22
|
+
|
|
23
|
+
This package narrows [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk) to **3** 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
|
+
| [`createHttpProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createHttpProviderFactory.md) | Function | See API reference. |
|
|
28
|
+
| [`HttpProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/HttpProviderOptions.md) | Interface | See API reference. |
|
|
29
|
+
| [`HttpFetch`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/HttpFetch.md) | Type | See API reference. |
|
|
30
|
+
|
|
31
|
+
## Examples
|
|
32
|
+
|
|
33
|
+
| Example | What it shows |
|
|
34
|
+
| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
|
|
35
|
+
| [`examples/signed-url-download.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/signed-url-download.ts) | Signed-URL HTTP download example. |
|
|
36
|
+
|
|
37
|
+
## Documentation
|
|
38
|
+
|
|
39
|
+
- [Scope page](https://github.com/tonywied17/zero-transfer/blob/main/docs/scopes/http.md)
|
|
40
|
+
- [Top-level README](https://github.com/tonywied17/zero-transfer/blob/main/README.md)
|
|
41
|
+
- [Full API reference](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/README.md)
|
|
42
|
+
- [Capability matrix](https://github.com/tonywied17/zero-transfer/blob/main/README.md#capability-matrix)
|
|
43
|
+
- [Examples](https://github.com/tonywied17/zero-transfer/tree/main/examples)
|
|
29
44
|
|
|
30
45
|
## License
|
|
31
46
|
|
|
32
|
-
MIT © Tony Wiedman
|
|
47
|
+
MIT © [Tony Wiedman](https://github.com/tonywied17)
|
package/dist/index.cjs
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
// AUTO-GENERATED
|
|
1
|
+
// AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
|
|
2
2
|
"use strict";
|
|
3
|
-
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
const sdk = require("@zero-transfer/sdk");
|
|
5
|
+
Object.defineProperty(exports, "createHttpProviderFactory", { enumerable: true, get: () => sdk["createHttpProviderFactory"] });
|
package/dist/index.d.ts
CHANGED
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
// AUTO-GENERATED
|
|
2
|
-
export
|
|
1
|
+
// AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
|
|
2
|
+
export { createHttpProviderFactory } from "@zero-transfer/sdk";
|
|
3
|
+
export type { HttpProviderOptions, HttpFetch } from "@zero-transfer/sdk";
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
// AUTO-GENERATED
|
|
2
|
-
export
|
|
1
|
+
// AUTO-GENERATED. Edit scripts/scope-manifest.mjs and re-run packages:generate.
|
|
2
|
+
export { createHttpProviderFactory } from "@zero-transfer/sdk";
|
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zero-transfer/http",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "HTTP(S)
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "HTTP(S) and signed-URL provider with ranged downloads.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"zero-transfer",
|
|
7
7
|
"http",
|
|
8
|
+
"http",
|
|
8
9
|
"https",
|
|
9
10
|
"signed-url"
|
|
10
11
|
],
|
|
@@ -34,7 +35,7 @@
|
|
|
34
35
|
"bugs": {
|
|
35
36
|
"url": "https://github.com/tonywied17/zero-transfer/issues"
|
|
36
37
|
},
|
|
37
|
-
"homepage": "https://github.com/tonywied17/zero-transfer#readme",
|
|
38
|
+
"homepage": "https://github.com/tonywied17/zero-transfer/tree/main/packages/http#readme",
|
|
38
39
|
"engines": {
|
|
39
40
|
"node": ">=20.0.0"
|
|
40
41
|
},
|
|
@@ -44,7 +45,7 @@
|
|
|
44
45
|
"access": "public"
|
|
45
46
|
},
|
|
46
47
|
"sideEffects": false,
|
|
47
|
-
"
|
|
48
|
-
"@zero-transfer/sdk": "0.1.
|
|
48
|
+
"peerDependencies": {
|
|
49
|
+
"@zero-transfer/sdk": "0.1.1"
|
|
49
50
|
}
|
|
50
51
|
}
|