@bymax-one/nest-storage 1.0.2 → 1.0.3
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/CHANGELOG.md +20 -1
- package/README.md +33 -23
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,24 @@ The format follows [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/
|
|
|
8
8
|
|
|
9
9
|
## [Unreleased]
|
|
10
10
|
|
|
11
|
+
## [1.0.3] - 2026-08-04
|
|
12
|
+
|
|
13
|
+
Documentation only. `dist/` is byte-identical to the one 1.0.2 published — verified by
|
|
14
|
+
unpacking `@bymax-one/nest-storage@1.0.2` from the registry and diffing it against a
|
|
15
|
+
fresh build (`diff -r`, no output), not asserted. 1.0.0 and 1.0.1 shipped the same
|
|
16
|
+
`dist/`, so the artifact has not changed since the first release.
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
|
|
20
|
+
- **The architecture diagram is drawn rather than listed.** Every published
|
|
21
|
+
`@bymax-one` library draws this section with box-drawing characters, laid out so the
|
|
22
|
+
picture shows what flows into what. This one had an indented tree of bullets with a
|
|
23
|
+
description beside each entry, which says what exists but not how a request moves
|
|
24
|
+
through it, which step feeds which, or where the decision is made. The redrawn
|
|
25
|
+
diagram carries what the prose underneath was saying alone: the single chokepoint
|
|
26
|
+
every caller-supplied key passes before it reaches S3, and the escape hatch beside
|
|
27
|
+
the two services rather than buried under them.
|
|
28
|
+
|
|
11
29
|
## [1.0.2] - 2026-08-04
|
|
12
30
|
|
|
13
31
|
Documentation only, again — and for the same reason 1.0.1 existed: the README ships
|
|
@@ -169,4 +187,5 @@ have regressed from. They are kept because the reasoning is worth having.
|
|
|
169
187
|
[1.0.0]: https://github.com/bymaxone/nest-storage/releases/tag/v1.0.0
|
|
170
188
|
[1.0.1]: https://github.com/bymaxone/nest-storage/compare/v1.0.0...v1.0.1
|
|
171
189
|
[1.0.2]: https://github.com/bymaxone/nest-storage/compare/v1.0.1...v1.0.2
|
|
172
|
-
[
|
|
190
|
+
[1.0.3]: https://github.com/bymaxone/nest-storage/compare/v1.0.2...v1.0.3
|
|
191
|
+
[Unreleased]: https://github.com/bymaxone/nest-storage/compare/v1.0.3...HEAD
|
package/README.md
CHANGED
|
@@ -677,29 +677,39 @@ supply through it first: the guard below, then `keyPrefix`. The key you read bac
|
|
|
677
677
|
## 🏗️ Architecture
|
|
678
678
|
|
|
679
679
|
```
|
|
680
|
-
BymaxStorageModule
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
│
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
680
|
+
BymaxStorageModule.forRoot / forRootAsync
|
|
681
|
+
│
|
|
682
|
+
validateOptions (fail fast)
|
|
683
|
+
credentials tolerated empty on purpose
|
|
684
|
+
│
|
|
685
|
+
┌───────────────┴────────────────┐
|
|
686
|
+
│ S3ClientProvider │
|
|
687
|
+
│ one @aws-sdk/client-s3 client │
|
|
688
|
+
│ built from a provider recipe │
|
|
689
|
+
└───────────────┬────────────────┘
|
|
690
|
+
│
|
|
691
|
+
BYMAX_STORAGE_S3_CLIENT
|
|
692
|
+
(escape hatch — the raw S3Client)
|
|
693
|
+
│
|
|
694
|
+
┌─────────────────────────┴─────────────────────────┐
|
|
695
|
+
│ │
|
|
696
|
+
StorageService SignedUrlService
|
|
697
|
+
upload · download GET · PUT · multipart
|
|
698
|
+
head · exists · list TTL-clamped
|
|
699
|
+
copy · delete · deleteMany SigV4 ceiling 7 days
|
|
700
|
+
│ │
|
|
701
|
+
└──────────────┬────────────────────────────────────┘
|
|
702
|
+
│
|
|
703
|
+
KeyResolverService
|
|
704
|
+
every caller key passes here before S3:
|
|
705
|
+
refuse `..`, leading `/`, NUL, empty → then keyPrefix
|
|
706
|
+
│
|
|
707
|
+
┌────────────────────┼────────────────────┐
|
|
708
|
+
│ │ │
|
|
709
|
+
IUploadValidator[] IFileScanner IdempotencyCache
|
|
710
|
+
MIME + size, then pre- and/or LRU, in-process,
|
|
711
|
+
yours post-upload collapses a retry
|
|
712
|
+
(yours) (yours) within one instance
|
|
703
713
|
```
|
|
704
714
|
|
|
705
715
|
One engine, six recipes. `providerRecipes` differ only in endpoint, region and the
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bymax-one/nest-storage",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Provider-agnostic S3-compatible object storage for NestJS. Works with AWS S3, DigitalOcean Spaces, Cloudflare R2, Backblaze B2, MinIO, Wasabi.",
|
|
5
5
|
"author": "Bymax One <support@bymax.one>",
|
|
6
6
|
"license": "MIT",
|