@zero-transfer/s3 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 +36 -15
  2. package/dist/index.cjs +5 -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/s3
2
2
 
3
- S3-compatible object storage provider with multipart resume 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
+ > S3-compatible storage with SigV4, multipart upload, and resume.
12
4
 
13
5
  ## Install
14
6
 
@@ -16,17 +8,46 @@ S3-compatible object storage provider with multipart resume for ZeroTransfer.
16
8
  npm install @zero-transfer/s3
17
9
  ```
18
10
 
11
+ ## Overview
12
+
13
+ S3-compatible object storage provider with SigV4 signing, multipart upload, and cross-process multipart resume. Supports AWS S3, MinIO, R2, Wasabi, Backblaze B2 S3, DigitalOcean Spaces, and any custom endpoint that speaks the S3 API. Includes the in-memory resume store; persistent stores can be swapped in.
14
+
19
15
  ## Usage
20
16
 
21
17
  ```ts
22
- import { createTransferClient } from "@zero-transfer/s3";
23
-
24
- const client = createTransferClient();
18
+ import { createS3ProviderFactory } from "@zero-transfer/s3";
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 **8** 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
+ | [`createS3ProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createS3ProviderFactory.md) | Function | See API reference. |
28
+ | [`createMemoryS3MultipartResumeStore`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createMemoryS3MultipartResumeStore.md) | Function | See API reference. |
29
+ | [`S3ProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/S3ProviderOptions.md) | Interface | See API reference. |
30
+ | [`S3MultipartOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/S3MultipartOptions.md) | Interface | See API reference. |
31
+ | [`S3MultipartResumeStore`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/S3MultipartResumeStore.md) | Interface | See API reference. |
32
+ | [`S3MultipartResumeKey`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/S3MultipartResumeKey.md) | Interface | See API reference. |
33
+ | [`S3MultipartCheckpoint`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/S3MultipartCheckpoint.md) | Interface | See API reference. |
34
+ | [`S3MultipartPart`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/S3MultipartPart.md) | Interface | See API reference. |
35
+
36
+ ## Examples
37
+
38
+ | Example | What it shows |
39
+ | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
40
+ | [`examples/s3-compatible-upload.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/s3-compatible-upload.ts) | S3-compatible multipart upload example. |
41
+ | [`examples/multi-cloud-orchestration.ts`](https://github.com/tonywied17/zero-transfer/blob/main/examples/multi-cloud-orchestration.ts) | Multi-cloud orchestration showcase. |
42
+
43
+ ## Documentation
44
+
45
+ - [Scope page](https://github.com/tonywied17/zero-transfer/blob/main/docs/scopes/s3.md)
46
+ - [Top-level README](https://github.com/tonywied17/zero-transfer/blob/main/README.md)
47
+ - [Full API reference](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/README.md)
48
+ - [Capability matrix](https://github.com/tonywied17/zero-transfer/blob/main/README.md#capability-matrix)
49
+ - [Examples](https://github.com/tonywied17/zero-transfer/tree/main/examples)
29
50
 
30
51
  ## License
31
52
 
32
- MIT © Tony Wiedman
53
+ MIT © [Tony Wiedman](https://github.com/tonywied17)
package/dist/index.cjs CHANGED
@@ -1,3 +1,6 @@
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, "createS3ProviderFactory", { enumerable: true, get: () => sdk["createS3ProviderFactory"] });
6
+ Object.defineProperty(exports, "createMemoryS3MultipartResumeStore", { enumerable: true, get: () => sdk["createMemoryS3MultipartResumeStore"] });
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 { createS3ProviderFactory, createMemoryS3MultipartResumeStore } from "@zero-transfer/sdk";
3
+ export type { S3ProviderOptions, S3MultipartOptions, S3MultipartResumeStore, S3MultipartResumeKey, S3MultipartCheckpoint, S3MultipartPart } 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 { createS3ProviderFactory, createMemoryS3MultipartResumeStore } from "@zero-transfer/sdk";
package/package.json CHANGED
@@ -1,10 +1,11 @@
1
1
  {
2
2
  "name": "@zero-transfer/s3",
3
- "version": "0.1.0-alpha.0",
4
- "description": "S3-compatible object storage provider with multipart resume for ZeroTransfer.",
3
+ "version": "0.1.2",
4
+ "description": "S3-compatible storage with SigV4, multipart upload, and resume.",
5
5
  "keywords": [
6
6
  "zero-transfer",
7
7
  "s3",
8
+ "s3",
8
9
  "object-storage",
9
10
  "multipart"
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/s3#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
- "dependencies": {
48
- "@zero-transfer/sdk": "0.1.0-alpha.0"
48
+ "peerDependencies": {
49
+ "@zero-transfer/sdk": "0.1.2"
49
50
  }
50
51
  }