@mandujs/core 0.53.3 → 0.54.0
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 +654 -654
- package/package.json +2 -2
- package/src/a11y/__tests__/run-audit.test.ts +333 -333
- package/src/a11y/fix-hints.ts +76 -76
- package/src/a11y/index.ts +18 -18
- package/src/a11y/run-audit.ts +394 -394
- package/src/a11y/types.ts +125 -125
- package/src/auth/__tests__/login.test.ts +1 -1
- package/src/auth/__tests__/password.test.ts +122 -122
- package/src/auth/__tests__/tokens.test.ts +274 -274
- package/src/auth/__tests__/verification.test.ts +274 -274
- package/src/auth/index.ts +76 -76
- package/src/auth/login.ts +225 -225
- package/src/auth/password.ts +120 -120
- package/src/auth/reset.ts +243 -243
- package/src/auth/tokens.ts +612 -612
- package/src/auth/verification.ts +253 -253
- package/src/brain/__tests__/redactor.test.ts +94 -94
- package/src/brain/adapters/__tests__/_helpers.ts +83 -83
- package/src/brain/adapters/__tests__/anthropic-oauth.test.ts +196 -196
- package/src/brain/adapters/__tests__/chatgpt-auth.test.ts +193 -193
- package/src/brain/adapters/__tests__/openai-oauth.test.ts +209 -209
- package/src/brain/adapters/__tests__/resolver.test.ts +143 -143
- package/src/brain/adapters/anthropic-oauth.ts +1 -1
- package/src/brain/adapters/chatgpt-auth.ts +300 -300
- package/src/brain/adapters/index.ts +319 -319
- package/src/brain/adapters/oauth-flow.ts +439 -439
- package/src/brain/consent.ts +240 -240
- package/src/brain/credentials.ts +396 -396
- package/src/bundler/__tests__/build-runner.ts +113 -113
- package/src/bundler/__tests__/dev-reliability.test.ts +619 -619
- package/src/bundler/__tests__/extended-watch.test.ts +711 -711
- package/src/bundler/__tests__/fast-refresh.test.ts +10 -10
- package/src/bundler/__tests__/hdr.test.ts +353 -353
- package/src/bundler/__tests__/hmr-client.test.ts +532 -532
- package/src/bundler/__tests__/manifest-schema.test.ts +266 -266
- package/src/bundler/__tests__/prod-smoke.test.ts +138 -138
- package/src/bundler/__tests__/reverse-import-graph.test.ts +519 -519
- package/src/bundler/__tests__/slot-dispatch.test.ts +573 -573
- package/src/bundler/__tests__/url-cap-and-slot-regex.test.ts +286 -286
- package/src/bundler/__tests__/vendor-cache.test.ts +455 -455
- package/src/bundler/budget.ts +404 -404
- package/src/bundler/build.test.ts +179 -179
- package/src/bundler/build.ts +55 -55
- package/src/bundler/dev.ts +42 -42
- package/src/bundler/manifest-schema.ts +301 -301
- package/src/bundler/plugins/__tests__/block-generated-imports.test.ts +263 -263
- package/src/bundler/plugins/__tests__/react-compiler-config.test.ts +83 -83
- package/src/bundler/plugins/__tests__/react-compiler-lint.test.ts +110 -110
- package/src/bundler/plugins/block-generated-imports.ts +155 -155
- package/src/bundler/plugins/index.ts +83 -83
- package/src/bundler/plugins/react-compiler-config.ts +108 -108
- package/src/bundler/plugins/react-compiler-lint.ts +253 -253
- package/src/bundler/plugins/react-compiler.ts +162 -162
- package/src/bundler/reverse-import-graph.ts +339 -339
- package/src/bundler/safe-build.test.ts +201 -201
- package/src/bundler/safe-build.ts +103 -103
- package/src/bundler/scenario-matrix.ts +229 -229
- package/src/bundler/types.ts +10 -10
- package/src/bundler/vendor-cache-types.ts +130 -130
- package/src/bundler/vendor-cache.ts +526 -526
- package/src/change/snapshot.ts +18 -18
- package/src/client/Form.tsx +105 -105
- package/src/client/Link.tsx +9 -9
- package/src/client/__tests__/use-sse.test.ts +153 -153
- package/src/client/globals.ts +1 -1
- package/src/client/hooks.ts +362 -362
- package/src/client/hydrate.ts +340 -340
- package/src/client/prefetch-helper.ts +55 -55
- package/src/client/router.ts +11 -11
- package/src/client/runtime.ts +47 -47
- package/src/client/serialize.ts +404 -404
- package/src/client/use-fetch.ts +6 -6
- package/src/client/use-head.ts +197 -197
- package/src/client/use-sse.ts +378 -378
- package/src/client/window-state.ts +101 -101
- package/src/components/Image.tsx +162 -162
- package/src/config/validate.ts +3 -3
- package/src/config/watcher.ts +311 -311
- package/src/constants.ts +40 -40
- package/src/content/collection.ts +8 -8
- package/src/content/content-layer.ts +7 -7
- package/src/content/data-store.ts +245 -245
- package/src/content/frontmatter.ts +189 -189
- package/src/content/loader-context.ts +171 -171
- package/src/content/loaders/api.ts +216 -216
- package/src/content/loaders/file.ts +172 -172
- package/src/content/loaders/glob.ts +253 -253
- package/src/content/loaders/index.ts +34 -34
- package/src/content/loaders/types.ts +137 -137
- package/src/content/meta-store.ts +209 -209
- package/src/content/prebuild.test.ts +571 -571
- package/src/content/prebuild.ts +636 -636
- package/src/content/schema.ts +20 -20
- package/src/content/sidebar.ts +630 -630
- package/src/content/slug.ts +110 -110
- package/src/content/types.ts +282 -282
- package/src/content/watcher.ts +135 -135
- package/src/contract/client-safe.test.ts +42 -42
- package/src/contract/client-safe.ts +114 -114
- package/src/contract/define.ts +11 -11
- package/src/contract/index.ts +1 -1
- package/src/contract/normalize.test.ts +276 -276
- package/src/contract/normalize.ts +410 -410
- package/src/contract/registry.test.ts +206 -206
- package/src/contract/route-helpers.ts +1 -1
- package/src/contract/rpc.ts +443 -443
- package/src/contract/schema.ts +48 -48
- package/src/contract/types.ts +58 -58
- package/src/db/__tests__/db.test.ts +482 -482
- package/src/db/index.ts +138 -138
- package/src/db/migrations/history-table.ts +345 -345
- package/src/db/migrations/index.ts +3 -3
- package/src/db/migrations/lock.ts +324 -324
- package/src/db/migrations/runner.ts +650 -650
- package/src/deploy/cache.ts +140 -140
- package/src/deploy/compile/vercel.ts +344 -344
- package/src/deploy/index.ts +87 -87
- package/src/deploy/inference/brain.ts +268 -268
- package/src/deploy/inference/context.ts +182 -182
- package/src/deploy/inference/filling-extract.ts +245 -245
- package/src/deploy/inference/heuristic.ts +182 -182
- package/src/deploy/intent.ts +173 -173
- package/src/deploy/plan.ts +178 -178
- package/src/design/__tests__/agents-link.test.ts +109 -109
- package/src/design/__tests__/extract-patch-diff.test.ts +265 -265
- package/src/design/__tests__/lint.test.ts +110 -110
- package/src/design/__tests__/parser.test.ts +195 -195
- package/src/design/__tests__/tailwind-theme.test.ts +229 -229
- package/src/design/agents-link.ts +165 -165
- package/src/design/diff.ts +138 -138
- package/src/design/extract.ts +285 -285
- package/src/design/index.ts +102 -102
- package/src/design/lint.ts +209 -209
- package/src/design/parser.ts +555 -555
- package/src/design/patch.ts +241 -241
- package/src/design/scaffold.ts +147 -147
- package/src/design/tailwind-theme.ts +441 -441
- package/src/design/types.ts +210 -210
- package/src/desktop/__tests__/webview-fallback.test.ts +254 -254
- package/src/desktop/__tests__/window.test.ts +248 -248
- package/src/desktop/__tests__/worker.test.ts +266 -266
- package/src/desktop/index.ts +43 -43
- package/src/desktop/types.ts +158 -158
- package/src/desktop/worker.ts +180 -180
- package/src/dev-error-overlay/__tests__/overlay-injector.test.ts +241 -241
- package/src/dev-error-overlay/index.ts +30 -30
- package/src/dev-error-overlay/overlay-injector.ts +243 -243
- package/src/dev-error-overlay/overlay-styles.ts +52 -52
- package/src/dev-error-overlay/types.ts +66 -66
- package/src/devtools/ai/context-builder.ts +375 -375
- package/src/devtools/ai/index.ts +25 -25
- package/src/devtools/ai/mcp-connector.ts +25 -25
- package/src/devtools/client/catchers/error-catcher.ts +344 -344
- package/src/devtools/client/catchers/index.ts +18 -18
- package/src/devtools/client/components/index.ts +39 -39
- package/src/devtools/client/components/mandu-character.tsx +331 -331
- package/src/devtools/client/components/overlay.tsx +368 -368
- package/src/devtools/client/components/panel/errors-panel.tsx +259 -259
- package/src/devtools/client/components/panel/guard-panel.tsx +30 -30
- package/src/devtools/client/components/panel/islands-panel.tsx +320 -320
- package/src/devtools/client/components/panel/network-panel.tsx +291 -291
- package/src/devtools/client/components/panel/panel-container.tsx +500 -500
- package/src/devtools/client/components/panel/preview-panel.tsx +46 -46
- package/src/devtools/client/filters/context-filters.ts +282 -282
- package/src/devtools/client/filters/index.ts +16 -16
- package/src/devtools/client/index.ts +63 -63
- package/src/devtools/client/persistence.ts +335 -335
- package/src/devtools/hook/create-hook.ts +207 -207
- package/src/devtools/hook/index.ts +13 -13
- package/src/devtools/index.ts +439 -439
- package/src/devtools/init.ts +265 -265
- package/src/devtools/protocol.ts +237 -237
- package/src/devtools/server/index.ts +17 -17
- package/src/devtools/server/source-context.ts +450 -450
- package/src/devtools/types.ts +35 -35
- package/src/devtools/worker/index.ts +25 -25
- package/src/devtools/worker/redaction-worker.ts +233 -233
- package/src/devtools/worker/worker-manager.ts +410 -410
- package/src/diagnose/__tests__/checks.test.ts +451 -451
- package/src/diagnose/checks.ts +832 -832
- package/src/diagnose/index.ts +17 -17
- package/src/diagnose/run.ts +93 -93
- package/src/diagnose/types.ts +53 -53
- package/src/email/__tests__/email.test.ts +355 -355
- package/src/email/index.ts +282 -282
- package/src/email/smtp.ts +64 -64
- package/src/error/domains.ts +265 -265
- package/src/error/result.ts +60 -60
- package/src/error/types.ts +6 -6
- package/src/errors/extractor.ts +409 -409
- package/src/errors/index.ts +19 -19
- package/src/filling/__tests__/session-sqlite.test.ts +454 -454
- package/src/filling/auth.ts +308 -308
- package/src/filling/cookie-codec.ts +299 -299
- package/src/filling/deps.ts +265 -265
- package/src/filling/session-sqlite.ts +617 -617
- package/src/filling/sse.ts +5 -5
- package/src/filling/ws.ts +78 -78
- package/src/generator/index.ts +3 -3
- package/src/guard/__tests__/design-inline-class.test.ts +219 -219
- package/src/guard/__tests__/tsgolint-bridge.test.ts +347 -347
- package/src/guard/analyzer.ts +360 -360
- package/src/guard/auto-correct.ts +1 -1
- package/src/guard/contract-guard.ts +9 -9
- package/src/guard/define-rule.ts +243 -243
- package/src/guard/design-inline-class.ts +393 -393
- package/src/guard/file-type.test.ts +24 -24
- package/src/guard/graph.ts +1 -1
- package/src/guard/healing.ts +36 -36
- package/src/guard/presets/atomic.ts +70 -70
- package/src/guard/presets/clean.ts +77 -77
- package/src/guard/presets/fsd.ts +79 -79
- package/src/guard/presets/hexagonal.ts +68 -68
- package/src/guard/reporter.ts +442 -442
- package/src/guard/rule-presets.ts +379 -379
- package/src/guard/semantic-slots.ts +1 -1
- package/src/guard/suggestions.ts +358 -358
- package/src/guard/tsgolint-bridge.ts +512 -512
- package/src/guard/types.ts +348 -348
- package/src/guard/watcher.ts +405 -405
- package/src/i18n/define.ts +126 -126
- package/src/i18n/index.ts +52 -52
- package/src/i18n/message-registry.ts +173 -173
- package/src/i18n/types.ts +112 -112
- package/src/id/index.ts +105 -105
- package/src/index.ts +2 -2
- package/src/kitchen/api/agent-devtools-api.ts +779 -544
- package/src/kitchen/api/errors-grouping.ts +126 -0
- package/src/kitchen/kitchen-handler.ts +192 -63
- package/src/kitchen/kitchen-ui.ts +842 -464
- package/src/logging/index.ts +22 -22
- package/src/logging/transports.ts +365 -365
- package/src/middleware/bridge.ts +147 -147
- package/src/middleware/compose.ts +134 -134
- package/src/middleware/compress.ts +62 -62
- package/src/middleware/cors.ts +47 -47
- package/src/middleware/csrf.ts +328 -328
- package/src/middleware/define.ts +132 -132
- package/src/middleware/jwt.ts +134 -134
- package/src/middleware/logger.ts +58 -58
- package/src/middleware/oauth/__tests__/oauth.test.ts +1 -1
- package/src/middleware/oauth/index.ts +505 -505
- package/src/middleware/oauth/providers.ts +115 -115
- package/src/middleware/rate-limit/index.ts +522 -522
- package/src/middleware/rate-limit/sqlite-store.ts +382 -382
- package/src/middleware/scheduler-cron.ts +96 -96
- package/src/middleware/secure/__tests__/secure.test.ts +360 -360
- package/src/middleware/secure/csp.ts +193 -193
- package/src/middleware/session.ts +174 -174
- package/src/middleware/timeout.ts +55 -55
- package/src/observability/logger-adapter.ts +36 -36
- package/src/observability/sqlite-store.ts +254 -254
- package/src/openapi/generator.ts +1 -1
- package/src/openapi/openapi.test.ts +43 -43
- package/src/perf/__tests__/user-marks.test.ts +354 -354
- package/src/perf/index.ts +133 -133
- package/src/plugins/__tests__/lifecycle-integration.test.ts +272 -272
- package/src/plugins/__tests__/runner.test.ts +409 -409
- package/src/plugins/define.ts +124 -124
- package/src/plugins/examples/dep-check-plugin.ts +80 -80
- package/src/plugins/examples/prerender-cache-plugin.ts +111 -111
- package/src/plugins/examples/sitemap-plugin.ts +65 -65
- package/src/plugins/runner.ts +361 -361
- package/src/plugins/types.ts +368 -368
- package/src/report/index.ts +1 -1
- package/src/resource/__tests__/generator.test.ts +32 -32
- package/src/resource/ddl/__tests__/diff.test.ts +639 -639
- package/src/resource/ddl/__tests__/emit.test.ts +823 -823
- package/src/resource/ddl/__tests__/snapshot.test.ts +499 -499
- package/src/resource/ddl/emit.ts +559 -559
- package/src/resource/ddl/persistence-types.ts +218 -218
- package/src/resource/ddl/type-map.ts +223 -223
- package/src/resource/ddl/types.ts +232 -232
- package/src/resource/generator-repo.ts +630 -630
- package/src/resource/schema.ts +1 -1
- package/src/router/fs-patterns.test.ts +96 -96
- package/src/router/fs-routes.ts +6 -6
- package/src/routes/index.ts +74 -74
- package/src/routes/metadata-routes.ts +427 -427
- package/src/routes/types.ts +341 -341
- package/src/runtime/__tests__/error-boundary-redaction.test.ts +141 -141
- package/src/runtime/__tests__/hdr-client.test.ts +223 -223
- package/src/runtime/__tests__/http-errors.test.ts +117 -117
- package/src/runtime/__tests__/not-found.test.ts +152 -152
- package/src/runtime/adapter.ts +47 -47
- package/src/runtime/boundary.tsx +252 -252
- package/src/runtime/cache.ts +494 -494
- package/src/runtime/compose.ts +222 -222
- package/src/runtime/fast-refresh-runtime.ts +322 -322
- package/src/runtime/handler.ts +65 -65
- package/src/runtime/handlers.ts +300 -300
- package/src/runtime/http-errors.ts +113 -113
- package/src/runtime/image-handler.ts +1 -1
- package/src/runtime/lifecycle.ts +381 -381
- package/src/runtime/logger.test.ts +345 -345
- package/src/runtime/middleware.ts +264 -264
- package/src/runtime/not-found.ts +93 -93
- package/src/runtime/openapi-endpoint.ts +236 -236
- package/src/runtime/ppr.ts +74 -74
- package/src/runtime/registry.ts +171 -171
- package/src/runtime/router.ts +105 -105
- package/src/runtime/server.ts +67 -67
- package/src/runtime/shims.ts +48 -48
- package/src/runtime/trace.ts +144 -144
- package/src/scheduler/validate.ts +169 -169
- package/src/seo/index.ts +219 -219
- package/src/seo/integration/ssr.ts +306 -306
- package/src/seo/render/basic.ts +435 -435
- package/src/seo/render/index.ts +143 -143
- package/src/seo/render/jsonld.ts +539 -539
- package/src/seo/render/opengraph.ts +197 -197
- package/src/seo/render/robots.ts +116 -116
- package/src/seo/render/sitemap.ts +137 -137
- package/src/seo/render/twitter.ts +127 -127
- package/src/seo/resolve/opengraph.ts +143 -143
- package/src/seo/resolve/robots.ts +73 -73
- package/src/seo/resolve/title.ts +94 -94
- package/src/seo/resolve/twitter.ts +73 -73
- package/src/seo/resolve/url.ts +104 -104
- package/src/seo/routes/index.ts +290 -290
- package/src/seo/types.ts +588 -588
- package/src/slot/validator.ts +39 -39
- package/src/storage/s3/__tests__/s3.test.ts +479 -479
- package/src/storage/s3/index.ts +412 -412
- package/src/testing/__tests__/assertions.test.ts +632 -632
- package/src/testing/__tests__/reporter.test.ts +454 -454
- package/src/testing/assertions.ts +986 -986
- package/src/testing/db.ts +157 -157
- package/src/testing/mocks.ts +203 -203
- package/src/testing/session.ts +190 -190
- package/src/types/branded.ts +56 -56
- package/src/types/index.ts +1 -1
- package/src/utils/safe-io.ts +188 -188
- package/src/utils/string-safe.ts +298 -298
- package/src/watcher/watcher.ts +18 -18
package/src/storage/s3/index.ts
CHANGED
|
@@ -1,412 +1,412 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @mandujs/core/storage/s3
|
|
3
|
-
*
|
|
4
|
-
* Thin, S3-compatible object storage helper backed by **native `Bun.S3Client`**
|
|
5
|
-
* (no AWS SDK, no external deps). The same client works against AWS S3,
|
|
6
|
-
* Cloudflare R2, MinIO, DigitalOcean Spaces, and any other S3-compatible
|
|
7
|
-
* service — the only thing that changes is the `endpoint` URL.
|
|
8
|
-
*
|
|
9
|
-
* ## Credentials
|
|
10
|
-
*
|
|
11
|
-
* Bun reads `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` (and optionally
|
|
12
|
-
* `AWS_SESSION_TOKEN`) — plus the `S3_*` variants — from the environment at
|
|
13
|
-
* initialization time. You can also pass them explicitly to the underlying
|
|
14
|
-
* `Bun.S3Client`, but this helper intentionally does **not** surface that
|
|
15
|
-
* option: routing secrets through env vars (or a `.env` file loaded by Bun)
|
|
16
|
-
* keeps credentials out of application code. See
|
|
17
|
-
* https://bun.com/docs/runtime/s3#credentials for the full matrix.
|
|
18
|
-
*
|
|
19
|
-
* ## Endpoint
|
|
20
|
-
*
|
|
21
|
-
* Pass `endpoint` on the client config for R2/MinIO/GCS/Supabase/etc. Omit it
|
|
22
|
-
* for AWS (Bun infers the endpoint from `region` + `bucket`).
|
|
23
|
-
*
|
|
24
|
-
* @example
|
|
25
|
-
* ```ts
|
|
26
|
-
* import { createS3Client } from "@mandujs/core/storage/s3";
|
|
27
|
-
*
|
|
28
|
-
* const storage = createS3Client({
|
|
29
|
-
* bucket: "uploads",
|
|
30
|
-
* endpoint: "https://<account>.r2.cloudflarestorage.com",
|
|
31
|
-
* region: "auto",
|
|
32
|
-
* });
|
|
33
|
-
*
|
|
34
|
-
* const url = await storage.upload(file, { key: `u/${id}.png` });
|
|
35
|
-
* const presigned = await storage.presign({ key: "u/next.png", method: "PUT", contentType: "image/png" });
|
|
36
|
-
* ```
|
|
37
|
-
*
|
|
38
|
-
* @module storage/s3
|
|
39
|
-
*/
|
|
40
|
-
|
|
41
|
-
// ─── Public types ───────────────────────────────────────────────────────────
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* S3 client configuration. Credentials are **not** part of this interface —
|
|
45
|
-
* they come from `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` env vars that
|
|
46
|
-
* Bun auto-reads. See module docs.
|
|
47
|
-
*/
|
|
48
|
-
export interface S3Config {
|
|
49
|
-
/** Bucket name. Required. */
|
|
50
|
-
bucket: string;
|
|
51
|
-
/**
|
|
52
|
-
* Custom endpoint URL. Required for R2/MinIO/GCS/etc.; omit for AWS (Bun
|
|
53
|
-
* infers from `region`).
|
|
54
|
-
*/
|
|
55
|
-
endpoint?: string;
|
|
56
|
-
/**
|
|
57
|
-
* Force path-style URLs (`endpoint/bucket/key`) instead of virtual-hosted
|
|
58
|
-
* (`bucket.endpoint/key`). MinIO usually needs this set to `true`. AWS and
|
|
59
|
-
* R2 work with either but default to virtual-hosted. Default: `false`.
|
|
60
|
-
*/
|
|
61
|
-
forcePathStyle?: boolean;
|
|
62
|
-
/**
|
|
63
|
-
* Region. Bun defaults to `us-east-1` for AWS; set `"auto"` for Cloudflare
|
|
64
|
-
* R2. No default applied here — we pass through as-is so Bun's own
|
|
65
|
-
* defaulting logic stays authoritative.
|
|
66
|
-
*/
|
|
67
|
-
region?: string;
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
/** Options for uploading a single object. */
|
|
71
|
-
export interface S3UploadOptions {
|
|
72
|
-
/** Target object key (path inside the bucket). Required. */
|
|
73
|
-
key: string;
|
|
74
|
-
/**
|
|
75
|
-
* Content-Type header. Inferred from the key's file extension when omitted
|
|
76
|
-
* — see `getContentType` below for the covered extensions.
|
|
77
|
-
*/
|
|
78
|
-
contentType?: string;
|
|
79
|
-
/**
|
|
80
|
-
* User metadata. Keys are lowercased and prefixed with `x-amz-meta-` by S3.
|
|
81
|
-
* Values must be ASCII — non-ASCII characters will be rejected by most
|
|
82
|
-
* providers; we do not validate here.
|
|
83
|
-
*/
|
|
84
|
-
metadata?: Record<string, string>;
|
|
85
|
-
/**
|
|
86
|
-
* Canned ACL. Applied to this upload only. Omit to inherit the bucket
|
|
87
|
-
* default (recommended for private buckets).
|
|
88
|
-
*/
|
|
89
|
-
acl?: "private" | "public-read";
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
/** Options for generating a presigned URL. */
|
|
93
|
-
export interface S3PresignOptions {
|
|
94
|
-
/** Object key. Required. */
|
|
95
|
-
key: string;
|
|
96
|
-
/** HTTP method. Default: `"PUT"` (client-direct upload is the common case). */
|
|
97
|
-
method?: "GET" | "PUT";
|
|
98
|
-
/** URL lifetime in **seconds**. Default: 900 (15 minutes). */
|
|
99
|
-
expiresIn?: number;
|
|
100
|
-
/**
|
|
101
|
-
* `Content-Type` baked into the signature. Only meaningful for `PUT`; the
|
|
102
|
-
* uploading client MUST send a matching header or the signature will fail.
|
|
103
|
-
*/
|
|
104
|
-
contentType?: string;
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
/** Opaque client instance. */
|
|
108
|
-
export interface S3Client {
|
|
109
|
-
/**
|
|
110
|
-
* Uploads a blob/buffer and resolves to the canonical object URL
|
|
111
|
-
* (endpoint + bucket + key).
|
|
112
|
-
*/
|
|
113
|
-
upload(
|
|
114
|
-
body: Blob | ArrayBuffer | Uint8Array,
|
|
115
|
-
options: S3UploadOptions,
|
|
116
|
-
): Promise<string>;
|
|
117
|
-
|
|
118
|
-
/** Generates a presigned URL for client-direct upload (PUT) or download (GET). */
|
|
119
|
-
presign(options: S3PresignOptions): Promise<string>;
|
|
120
|
-
|
|
121
|
-
/** Deletes an object. Resolves silently if the object does not exist. */
|
|
122
|
-
delete(key: string): Promise<void>;
|
|
123
|
-
|
|
124
|
-
/** Returns a readable stream for the object body. Throws if not found. */
|
|
125
|
-
getReadable(key: string): Promise<ReadableStream>;
|
|
126
|
-
|
|
127
|
-
/**
|
|
128
|
-
* Head check — `true` if the object exists, `false` on 404. Any other error
|
|
129
|
-
* (network failure, 403, malformed response) is re-thrown.
|
|
130
|
-
*/
|
|
131
|
-
exists(key: string): Promise<boolean>;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
// ─── Bun runtime surface (structural; no `any`) ─────────────────────────────
|
|
135
|
-
|
|
136
|
-
/** Options accepted by `S3File.write`. Mirrors Bun's BlobPropertyBag extensions. */
|
|
137
|
-
interface BunS3WriteOptions {
|
|
138
|
-
type?: string;
|
|
139
|
-
acl?: "private" | "public-read";
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
/** Options accepted by `S3File.presign`. */
|
|
143
|
-
interface BunS3PresignOptions {
|
|
144
|
-
method?: "GET" | "PUT";
|
|
145
|
-
expiresIn?: number;
|
|
146
|
-
type?: string;
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
/** Minimal shape of the `S3File` handle returned by `client.file(key)`. */
|
|
150
|
-
interface BunS3File {
|
|
151
|
-
write(
|
|
152
|
-
body: Blob | ArrayBuffer | Uint8Array,
|
|
153
|
-
options?: BunS3WriteOptions,
|
|
154
|
-
): Promise<number>;
|
|
155
|
-
presign(options?: BunS3PresignOptions): string;
|
|
156
|
-
delete(): Promise<void>;
|
|
157
|
-
exists(): Promise<boolean>;
|
|
158
|
-
stream(): ReadableStream;
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
/** Options accepted by the `Bun.S3Client` constructor. */
|
|
162
|
-
interface BunS3ClientConfig {
|
|
163
|
-
bucket: string;
|
|
164
|
-
endpoint?: string;
|
|
165
|
-
region?: string;
|
|
166
|
-
virtualHostedStyle?: boolean;
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
/** Minimal `Bun.S3Client` instance shape used by this module. */
|
|
170
|
-
export interface BunS3ClientInstance {
|
|
171
|
-
file(key: string): BunS3File;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
/**
|
|
175
|
-
* Constructor surface — `Bun.S3Client` is a class. We only need the `new`
|
|
176
|
-
* signature structurally, so we type it as a callable returning an instance.
|
|
177
|
-
*/
|
|
178
|
-
export type BunS3ClientCtor = new (config: BunS3ClientConfig) => BunS3ClientInstance;
|
|
179
|
-
|
|
180
|
-
// ─── Content-type inference ─────────────────────────────────────────────────
|
|
181
|
-
|
|
182
|
-
const EXTENSION_MAP: ReadonlyMap<string, string> = new Map([
|
|
183
|
-
["jpg", "image/jpeg"],
|
|
184
|
-
["jpeg", "image/jpeg"],
|
|
185
|
-
["png", "image/png"],
|
|
186
|
-
["webp", "image/webp"],
|
|
187
|
-
["gif", "image/gif"],
|
|
188
|
-
["pdf", "application/pdf"],
|
|
189
|
-
["txt", "text/plain"],
|
|
190
|
-
["json", "application/json"],
|
|
191
|
-
["csv", "text/csv"],
|
|
192
|
-
["zip", "application/zip"],
|
|
193
|
-
["mp4", "video/mp4"],
|
|
194
|
-
["webm", "video/webm"],
|
|
195
|
-
]);
|
|
196
|
-
|
|
197
|
-
/**
|
|
198
|
-
* Maps a key's trailing file extension to a MIME type. Returns
|
|
199
|
-
* `application/octet-stream` for unknown/missing extensions.
|
|
200
|
-
*
|
|
201
|
-
* Exported for tests and for callers that want to inspect the mapping without
|
|
202
|
-
* uploading (e.g., for building a `Content-Type` header on a presigned PUT).
|
|
203
|
-
*/
|
|
204
|
-
export function getContentType(key: string): string {
|
|
205
|
-
const lastDot = key.lastIndexOf(".");
|
|
206
|
-
if (lastDot === -1 || lastDot === key.length - 1) {
|
|
207
|
-
return "application/octet-stream";
|
|
208
|
-
}
|
|
209
|
-
const ext = key.slice(lastDot + 1).toLowerCase();
|
|
210
|
-
return EXTENSION_MAP.get(ext) ?? "application/octet-stream";
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
// ─── URL construction ───────────────────────────────────────────────────────
|
|
214
|
-
|
|
215
|
-
/**
|
|
216
|
-
* Builds the canonical object URL that `upload()` returns. Uses the same
|
|
217
|
-
* path-vs-virtual-host logic Bun itself applies, so the URL matches what
|
|
218
|
-
* `fetch()` would resolve.
|
|
219
|
-
*
|
|
220
|
-
* For AWS (no endpoint set), we return an `s3://<bucket>/<key>` URI — the
|
|
221
|
-
* caller may not know the region and we don't want to guess at a public URL.
|
|
222
|
-
*/
|
|
223
|
-
function buildObjectUrl(
|
|
224
|
-
config: S3Config,
|
|
225
|
-
key: string,
|
|
226
|
-
): string {
|
|
227
|
-
const encodedKey = encodeKey(key);
|
|
228
|
-
|
|
229
|
-
if (!config.endpoint) {
|
|
230
|
-
// Bun infers the AWS endpoint; returning s3:// keeps this provider-agnostic
|
|
231
|
-
// without pretending to know if the bucket is public-read.
|
|
232
|
-
return `s3://${config.bucket}/${encodedKey}`;
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
const base = config.endpoint.replace(/\/+$/, "");
|
|
236
|
-
if (config.forcePathStyle) {
|
|
237
|
-
return `${base}/${config.bucket}/${encodedKey}`;
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
// Virtual-hosted style: splice bucket into the hostname.
|
|
241
|
-
try {
|
|
242
|
-
const url = new URL(base);
|
|
243
|
-
url.hostname = `${config.bucket}.${url.hostname}`;
|
|
244
|
-
return `${url.toString().replace(/\/+$/, "")}/${encodedKey}`;
|
|
245
|
-
} catch {
|
|
246
|
-
// Malformed endpoint — fall back to path style so we still return a
|
|
247
|
-
// deterministic, debuggable URL.
|
|
248
|
-
return `${base}/${config.bucket}/${encodedKey}`;
|
|
249
|
-
}
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
/** URL-encodes every path segment of an S3 key while preserving `/` separators. */
|
|
253
|
-
function encodeKey(key: string): string {
|
|
254
|
-
return key
|
|
255
|
-
.split("/")
|
|
256
|
-
.map((segment) => encodeURIComponent(segment))
|
|
257
|
-
.join("/");
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
// ─── Bun runtime probe ──────────────────────────────────────────────────────
|
|
261
|
-
|
|
262
|
-
function getBunS3ClientCtor(): BunS3ClientCtor {
|
|
263
|
-
const g = globalThis as unknown as { Bun?: { S3Client?: BunS3ClientCtor } };
|
|
264
|
-
if (!g.Bun || !g.Bun.S3Client) {
|
|
265
|
-
throw new Error(
|
|
266
|
-
"[@mandujs/core/storage/s3] Bun.S3Client is unavailable — this module requires the Bun runtime (>= 1.3).",
|
|
267
|
-
);
|
|
268
|
-
}
|
|
269
|
-
return g.Bun.S3Client;
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
// ─── Factory ────────────────────────────────────────────────────────────────
|
|
273
|
-
|
|
274
|
-
/**
|
|
275
|
-
* Internal factory accepting an injectable `S3Client` constructor — used by
|
|
276
|
-
* unit tests to swap in a fake implementation. Production callers use
|
|
277
|
-
* {@link createS3Client}, which binds this to `Bun.S3Client`.
|
|
278
|
-
*/
|
|
279
|
-
export function _createS3ClientWith(
|
|
280
|
-
Ctor: BunS3ClientCtor,
|
|
281
|
-
config: S3Config,
|
|
282
|
-
): S3Client {
|
|
283
|
-
if (!config.bucket || typeof config.bucket !== "string") {
|
|
284
|
-
throw new TypeError(
|
|
285
|
-
"[@mandujs/core/storage/s3] createS3Client: 'bucket' is required.",
|
|
286
|
-
);
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
const bunClient = new Ctor({
|
|
290
|
-
bucket: config.bucket,
|
|
291
|
-
endpoint: config.endpoint,
|
|
292
|
-
region: config.region,
|
|
293
|
-
// forcePathStyle === true ⇒ virtualHostedStyle: false (the Bun default).
|
|
294
|
-
// forcePathStyle === false ⇒ leave Bun's default untouched.
|
|
295
|
-
// Only set virtualHostedStyle explicitly if the user *opts out* of path
|
|
296
|
-
// style for a service that normally defaults to it. The map here is 1:1.
|
|
297
|
-
virtualHostedStyle: config.forcePathStyle === true ? false : undefined,
|
|
298
|
-
});
|
|
299
|
-
|
|
300
|
-
async function upload(
|
|
301
|
-
body: Blob | ArrayBuffer | Uint8Array,
|
|
302
|
-
options: S3UploadOptions,
|
|
303
|
-
): Promise<string> {
|
|
304
|
-
if (!options.key) {
|
|
305
|
-
throw new TypeError(
|
|
306
|
-
"[@mandujs/core/storage/s3] upload: 'key' is required.",
|
|
307
|
-
);
|
|
308
|
-
}
|
|
309
|
-
const file = bunClient.file(options.key);
|
|
310
|
-
const contentType = options.contentType ?? getContentType(options.key);
|
|
311
|
-
|
|
312
|
-
await file.write(body, {
|
|
313
|
-
type: contentType,
|
|
314
|
-
...(options.acl !== undefined ? { acl: options.acl } : {}),
|
|
315
|
-
});
|
|
316
|
-
|
|
317
|
-
// NOTE: metadata is accepted in our public type for forward-compat, but
|
|
318
|
-
// Bun 1.3's `S3File.write` does not surface a `metadata` option. Dropping
|
|
319
|
-
// it silently would be a bug waiting to happen, so we throw at call time.
|
|
320
|
-
if (options.metadata && Object.keys(options.metadata).length > 0) {
|
|
321
|
-
throw new Error(
|
|
322
|
-
"[@mandujs/core/storage/s3] upload: 'metadata' is not yet supported by Bun.S3Client.write. Use a presigned URL with custom headers, or file an issue upstream.",
|
|
323
|
-
);
|
|
324
|
-
}
|
|
325
|
-
|
|
326
|
-
return buildObjectUrl(config, options.key);
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
async function presign(options: S3PresignOptions): Promise<string> {
|
|
330
|
-
if (!options.key) {
|
|
331
|
-
throw new TypeError(
|
|
332
|
-
"[@mandujs/core/storage/s3] presign: 'key' is required.",
|
|
333
|
-
);
|
|
334
|
-
}
|
|
335
|
-
const method = options.method ?? "PUT";
|
|
336
|
-
const expiresIn = options.expiresIn ?? 900;
|
|
337
|
-
const file = bunClient.file(options.key);
|
|
338
|
-
|
|
339
|
-
// Bun.S3File.presign is synchronous; we wrap in a Promise so the public
|
|
340
|
-
// API stays consistent with the rest of the helper surface.
|
|
341
|
-
const url = file.presign({
|
|
342
|
-
method,
|
|
343
|
-
expiresIn,
|
|
344
|
-
...(options.contentType !== undefined ? { type: options.contentType } : {}),
|
|
345
|
-
});
|
|
346
|
-
return url;
|
|
347
|
-
}
|
|
348
|
-
|
|
349
|
-
async function deleteObject(key: string): Promise<void> {
|
|
350
|
-
const file = bunClient.file(key);
|
|
351
|
-
try {
|
|
352
|
-
await file.delete();
|
|
353
|
-
} catch (err) {
|
|
354
|
-
// S3 returns success for delete-of-missing-key; but some S3-compatible
|
|
355
|
-
// providers (and network hiccups) can surface a 404-shaped error. We
|
|
356
|
-
// swallow "not found" and re-throw everything else.
|
|
357
|
-
if (isNotFoundError(err)) return;
|
|
358
|
-
throw err;
|
|
359
|
-
}
|
|
360
|
-
}
|
|
361
|
-
|
|
362
|
-
async function getReadable(key: string): Promise<ReadableStream> {
|
|
363
|
-
const file = bunClient.file(key);
|
|
364
|
-
// `file.stream()` is synchronous and returns a ReadableStream that lazily
|
|
365
|
-
// issues the GET when you start consuming. We preserve that laziness and
|
|
366
|
-
// let errors surface on first read rather than proactively HEAD-ing here.
|
|
367
|
-
return file.stream();
|
|
368
|
-
}
|
|
369
|
-
|
|
370
|
-
async function exists(key: string): Promise<boolean> {
|
|
371
|
-
const file = bunClient.file(key);
|
|
372
|
-
try {
|
|
373
|
-
return await file.exists();
|
|
374
|
-
} catch (err) {
|
|
375
|
-
if (isNotFoundError(err)) return false;
|
|
376
|
-
throw err;
|
|
377
|
-
}
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
return {
|
|
381
|
-
upload,
|
|
382
|
-
presign,
|
|
383
|
-
delete: deleteObject,
|
|
384
|
-
getReadable,
|
|
385
|
-
exists,
|
|
386
|
-
};
|
|
387
|
-
}
|
|
388
|
-
|
|
389
|
-
/**
|
|
390
|
-
* Creates an S3-compatible storage client.
|
|
391
|
-
*
|
|
392
|
-
* @throws if `config.bucket` is missing, or if called outside the Bun runtime.
|
|
393
|
-
*/
|
|
394
|
-
export function createS3Client(config: S3Config): S3Client {
|
|
395
|
-
return _createS3ClientWith(getBunS3ClientCtor(), config);
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
// ─── Error helpers ──────────────────────────────────────────────────────────
|
|
399
|
-
|
|
400
|
-
/**
|
|
401
|
-
* Structural check for "object not found" errors raised by Bun's S3 layer.
|
|
402
|
-
* Bun emits an `S3Error` instance with `code` set; we also handle the
|
|
403
|
-
* HTTP-status-bearing variants some providers surface.
|
|
404
|
-
*/
|
|
405
|
-
function isNotFoundError(err: unknown): boolean {
|
|
406
|
-
if (!err || typeof err !== "object") return false;
|
|
407
|
-
const e = err as { name?: unknown; code?: unknown; status?: unknown };
|
|
408
|
-
if (e.code === "NoSuchKey") return true;
|
|
409
|
-
if (e.code === "NotFound") return true;
|
|
410
|
-
if (e.status === 404) return true;
|
|
411
|
-
return false;
|
|
412
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* @mandujs/core/storage/s3
|
|
3
|
+
*
|
|
4
|
+
* Thin, S3-compatible object storage helper backed by **native `Bun.S3Client`**
|
|
5
|
+
* (no AWS SDK, no external deps). The same client works against AWS S3,
|
|
6
|
+
* Cloudflare R2, MinIO, DigitalOcean Spaces, and any other S3-compatible
|
|
7
|
+
* service — the only thing that changes is the `endpoint` URL.
|
|
8
|
+
*
|
|
9
|
+
* ## Credentials
|
|
10
|
+
*
|
|
11
|
+
* Bun reads `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` (and optionally
|
|
12
|
+
* `AWS_SESSION_TOKEN`) — plus the `S3_*` variants — from the environment at
|
|
13
|
+
* initialization time. You can also pass them explicitly to the underlying
|
|
14
|
+
* `Bun.S3Client`, but this helper intentionally does **not** surface that
|
|
15
|
+
* option: routing secrets through env vars (or a `.env` file loaded by Bun)
|
|
16
|
+
* keeps credentials out of application code. See
|
|
17
|
+
* https://bun.com/docs/runtime/s3#credentials for the full matrix.
|
|
18
|
+
*
|
|
19
|
+
* ## Endpoint
|
|
20
|
+
*
|
|
21
|
+
* Pass `endpoint` on the client config for R2/MinIO/GCS/Supabase/etc. Omit it
|
|
22
|
+
* for AWS (Bun infers the endpoint from `region` + `bucket`).
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* import { createS3Client } from "@mandujs/core/storage/s3";
|
|
27
|
+
*
|
|
28
|
+
* const storage = createS3Client({
|
|
29
|
+
* bucket: "uploads",
|
|
30
|
+
* endpoint: "https://<account>.r2.cloudflarestorage.com",
|
|
31
|
+
* region: "auto",
|
|
32
|
+
* });
|
|
33
|
+
*
|
|
34
|
+
* const url = await storage.upload(file, { key: `u/${id}.png` });
|
|
35
|
+
* const presigned = await storage.presign({ key: "u/next.png", method: "PUT", contentType: "image/png" });
|
|
36
|
+
* ```
|
|
37
|
+
*
|
|
38
|
+
* @module storage/s3
|
|
39
|
+
*/
|
|
40
|
+
|
|
41
|
+
// ─── Public types ───────────────────────────────────────────────────────────
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* S3 client configuration. Credentials are **not** part of this interface —
|
|
45
|
+
* they come from `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` env vars that
|
|
46
|
+
* Bun auto-reads. See module docs.
|
|
47
|
+
*/
|
|
48
|
+
export interface S3Config {
|
|
49
|
+
/** Bucket name. Required. */
|
|
50
|
+
bucket: string;
|
|
51
|
+
/**
|
|
52
|
+
* Custom endpoint URL. Required for R2/MinIO/GCS/etc.; omit for AWS (Bun
|
|
53
|
+
* infers from `region`).
|
|
54
|
+
*/
|
|
55
|
+
endpoint?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Force path-style URLs (`endpoint/bucket/key`) instead of virtual-hosted
|
|
58
|
+
* (`bucket.endpoint/key`). MinIO usually needs this set to `true`. AWS and
|
|
59
|
+
* R2 work with either but default to virtual-hosted. Default: `false`.
|
|
60
|
+
*/
|
|
61
|
+
forcePathStyle?: boolean;
|
|
62
|
+
/**
|
|
63
|
+
* Region. Bun defaults to `us-east-1` for AWS; set `"auto"` for Cloudflare
|
|
64
|
+
* R2. No default applied here — we pass through as-is so Bun's own
|
|
65
|
+
* defaulting logic stays authoritative.
|
|
66
|
+
*/
|
|
67
|
+
region?: string;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/** Options for uploading a single object. */
|
|
71
|
+
export interface S3UploadOptions {
|
|
72
|
+
/** Target object key (path inside the bucket). Required. */
|
|
73
|
+
key: string;
|
|
74
|
+
/**
|
|
75
|
+
* Content-Type header. Inferred from the key's file extension when omitted
|
|
76
|
+
* — see `getContentType` below for the covered extensions.
|
|
77
|
+
*/
|
|
78
|
+
contentType?: string;
|
|
79
|
+
/**
|
|
80
|
+
* User metadata. Keys are lowercased and prefixed with `x-amz-meta-` by S3.
|
|
81
|
+
* Values must be ASCII — non-ASCII characters will be rejected by most
|
|
82
|
+
* providers; we do not validate here.
|
|
83
|
+
*/
|
|
84
|
+
metadata?: Record<string, string>;
|
|
85
|
+
/**
|
|
86
|
+
* Canned ACL. Applied to this upload only. Omit to inherit the bucket
|
|
87
|
+
* default (recommended for private buckets).
|
|
88
|
+
*/
|
|
89
|
+
acl?: "private" | "public-read";
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/** Options for generating a presigned URL. */
|
|
93
|
+
export interface S3PresignOptions {
|
|
94
|
+
/** Object key. Required. */
|
|
95
|
+
key: string;
|
|
96
|
+
/** HTTP method. Default: `"PUT"` (client-direct upload is the common case). */
|
|
97
|
+
method?: "GET" | "PUT";
|
|
98
|
+
/** URL lifetime in **seconds**. Default: 900 (15 minutes). */
|
|
99
|
+
expiresIn?: number;
|
|
100
|
+
/**
|
|
101
|
+
* `Content-Type` baked into the signature. Only meaningful for `PUT`; the
|
|
102
|
+
* uploading client MUST send a matching header or the signature will fail.
|
|
103
|
+
*/
|
|
104
|
+
contentType?: string;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/** Opaque client instance. */
|
|
108
|
+
export interface S3Client {
|
|
109
|
+
/**
|
|
110
|
+
* Uploads a blob/buffer and resolves to the canonical object URL
|
|
111
|
+
* (endpoint + bucket + key).
|
|
112
|
+
*/
|
|
113
|
+
upload(
|
|
114
|
+
body: Blob | ArrayBuffer | Uint8Array,
|
|
115
|
+
options: S3UploadOptions,
|
|
116
|
+
): Promise<string>;
|
|
117
|
+
|
|
118
|
+
/** Generates a presigned URL for client-direct upload (PUT) or download (GET). */
|
|
119
|
+
presign(options: S3PresignOptions): Promise<string>;
|
|
120
|
+
|
|
121
|
+
/** Deletes an object. Resolves silently if the object does not exist. */
|
|
122
|
+
delete(key: string): Promise<void>;
|
|
123
|
+
|
|
124
|
+
/** Returns a readable stream for the object body. Throws if not found. */
|
|
125
|
+
getReadable(key: string): Promise<ReadableStream>;
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Head check — `true` if the object exists, `false` on 404. Any other error
|
|
129
|
+
* (network failure, 403, malformed response) is re-thrown.
|
|
130
|
+
*/
|
|
131
|
+
exists(key: string): Promise<boolean>;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
// ─── Bun runtime surface (structural; no `any`) ─────────────────────────────
|
|
135
|
+
|
|
136
|
+
/** Options accepted by `S3File.write`. Mirrors Bun's BlobPropertyBag extensions. */
|
|
137
|
+
interface BunS3WriteOptions {
|
|
138
|
+
type?: string;
|
|
139
|
+
acl?: "private" | "public-read";
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/** Options accepted by `S3File.presign`. */
|
|
143
|
+
interface BunS3PresignOptions {
|
|
144
|
+
method?: "GET" | "PUT";
|
|
145
|
+
expiresIn?: number;
|
|
146
|
+
type?: string;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
/** Minimal shape of the `S3File` handle returned by `client.file(key)`. */
|
|
150
|
+
interface BunS3File {
|
|
151
|
+
write(
|
|
152
|
+
body: Blob | ArrayBuffer | Uint8Array,
|
|
153
|
+
options?: BunS3WriteOptions,
|
|
154
|
+
): Promise<number>;
|
|
155
|
+
presign(options?: BunS3PresignOptions): string;
|
|
156
|
+
delete(): Promise<void>;
|
|
157
|
+
exists(): Promise<boolean>;
|
|
158
|
+
stream(): ReadableStream;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/** Options accepted by the `Bun.S3Client` constructor. */
|
|
162
|
+
interface BunS3ClientConfig {
|
|
163
|
+
bucket: string;
|
|
164
|
+
endpoint?: string;
|
|
165
|
+
region?: string;
|
|
166
|
+
virtualHostedStyle?: boolean;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/** Minimal `Bun.S3Client` instance shape used by this module. */
|
|
170
|
+
export interface BunS3ClientInstance {
|
|
171
|
+
file(key: string): BunS3File;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* Constructor surface — `Bun.S3Client` is a class. We only need the `new`
|
|
176
|
+
* signature structurally, so we type it as a callable returning an instance.
|
|
177
|
+
*/
|
|
178
|
+
export type BunS3ClientCtor = new (config: BunS3ClientConfig) => BunS3ClientInstance;
|
|
179
|
+
|
|
180
|
+
// ─── Content-type inference ─────────────────────────────────────────────────
|
|
181
|
+
|
|
182
|
+
const EXTENSION_MAP: ReadonlyMap<string, string> = new Map([
|
|
183
|
+
["jpg", "image/jpeg"],
|
|
184
|
+
["jpeg", "image/jpeg"],
|
|
185
|
+
["png", "image/png"],
|
|
186
|
+
["webp", "image/webp"],
|
|
187
|
+
["gif", "image/gif"],
|
|
188
|
+
["pdf", "application/pdf"],
|
|
189
|
+
["txt", "text/plain"],
|
|
190
|
+
["json", "application/json"],
|
|
191
|
+
["csv", "text/csv"],
|
|
192
|
+
["zip", "application/zip"],
|
|
193
|
+
["mp4", "video/mp4"],
|
|
194
|
+
["webm", "video/webm"],
|
|
195
|
+
]);
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Maps a key's trailing file extension to a MIME type. Returns
|
|
199
|
+
* `application/octet-stream` for unknown/missing extensions.
|
|
200
|
+
*
|
|
201
|
+
* Exported for tests and for callers that want to inspect the mapping without
|
|
202
|
+
* uploading (e.g., for building a `Content-Type` header on a presigned PUT).
|
|
203
|
+
*/
|
|
204
|
+
export function getContentType(key: string): string {
|
|
205
|
+
const lastDot = key.lastIndexOf(".");
|
|
206
|
+
if (lastDot === -1 || lastDot === key.length - 1) {
|
|
207
|
+
return "application/octet-stream";
|
|
208
|
+
}
|
|
209
|
+
const ext = key.slice(lastDot + 1).toLowerCase();
|
|
210
|
+
return EXTENSION_MAP.get(ext) ?? "application/octet-stream";
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
// ─── URL construction ───────────────────────────────────────────────────────
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* Builds the canonical object URL that `upload()` returns. Uses the same
|
|
217
|
+
* path-vs-virtual-host logic Bun itself applies, so the URL matches what
|
|
218
|
+
* `fetch()` would resolve.
|
|
219
|
+
*
|
|
220
|
+
* For AWS (no endpoint set), we return an `s3://<bucket>/<key>` URI — the
|
|
221
|
+
* caller may not know the region and we don't want to guess at a public URL.
|
|
222
|
+
*/
|
|
223
|
+
function buildObjectUrl(
|
|
224
|
+
config: S3Config,
|
|
225
|
+
key: string,
|
|
226
|
+
): string {
|
|
227
|
+
const encodedKey = encodeKey(key);
|
|
228
|
+
|
|
229
|
+
if (!config.endpoint) {
|
|
230
|
+
// Bun infers the AWS endpoint; returning s3:// keeps this provider-agnostic
|
|
231
|
+
// without pretending to know if the bucket is public-read.
|
|
232
|
+
return `s3://${config.bucket}/${encodedKey}`;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
const base = config.endpoint.replace(/\/+$/, "");
|
|
236
|
+
if (config.forcePathStyle) {
|
|
237
|
+
return `${base}/${config.bucket}/${encodedKey}`;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
// Virtual-hosted style: splice bucket into the hostname.
|
|
241
|
+
try {
|
|
242
|
+
const url = new URL(base);
|
|
243
|
+
url.hostname = `${config.bucket}.${url.hostname}`;
|
|
244
|
+
return `${url.toString().replace(/\/+$/, "")}/${encodedKey}`;
|
|
245
|
+
} catch {
|
|
246
|
+
// Malformed endpoint — fall back to path style so we still return a
|
|
247
|
+
// deterministic, debuggable URL.
|
|
248
|
+
return `${base}/${config.bucket}/${encodedKey}`;
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
/** URL-encodes every path segment of an S3 key while preserving `/` separators. */
|
|
253
|
+
function encodeKey(key: string): string {
|
|
254
|
+
return key
|
|
255
|
+
.split("/")
|
|
256
|
+
.map((segment) => encodeURIComponent(segment))
|
|
257
|
+
.join("/");
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
// ─── Bun runtime probe ──────────────────────────────────────────────────────
|
|
261
|
+
|
|
262
|
+
function getBunS3ClientCtor(): BunS3ClientCtor {
|
|
263
|
+
const g = globalThis as unknown as { Bun?: { S3Client?: BunS3ClientCtor } };
|
|
264
|
+
if (!g.Bun || !g.Bun.S3Client) {
|
|
265
|
+
throw new Error(
|
|
266
|
+
"[@mandujs/core/storage/s3] Bun.S3Client is unavailable — this module requires the Bun runtime (>= 1.3).",
|
|
267
|
+
);
|
|
268
|
+
}
|
|
269
|
+
return g.Bun.S3Client;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
// ─── Factory ────────────────────────────────────────────────────────────────
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* Internal factory accepting an injectable `S3Client` constructor — used by
|
|
276
|
+
* unit tests to swap in a fake implementation. Production callers use
|
|
277
|
+
* {@link createS3Client}, which binds this to `Bun.S3Client`.
|
|
278
|
+
*/
|
|
279
|
+
export function _createS3ClientWith(
|
|
280
|
+
Ctor: BunS3ClientCtor,
|
|
281
|
+
config: S3Config,
|
|
282
|
+
): S3Client {
|
|
283
|
+
if (!config.bucket || typeof config.bucket !== "string") {
|
|
284
|
+
throw new TypeError(
|
|
285
|
+
"[@mandujs/core/storage/s3] createS3Client: 'bucket' is required.",
|
|
286
|
+
);
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
const bunClient = new Ctor({
|
|
290
|
+
bucket: config.bucket,
|
|
291
|
+
endpoint: config.endpoint,
|
|
292
|
+
region: config.region,
|
|
293
|
+
// forcePathStyle === true ⇒ virtualHostedStyle: false (the Bun default).
|
|
294
|
+
// forcePathStyle === false ⇒ leave Bun's default untouched.
|
|
295
|
+
// Only set virtualHostedStyle explicitly if the user *opts out* of path
|
|
296
|
+
// style for a service that normally defaults to it. The map here is 1:1.
|
|
297
|
+
virtualHostedStyle: config.forcePathStyle === true ? false : undefined,
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
async function upload(
|
|
301
|
+
body: Blob | ArrayBuffer | Uint8Array,
|
|
302
|
+
options: S3UploadOptions,
|
|
303
|
+
): Promise<string> {
|
|
304
|
+
if (!options.key) {
|
|
305
|
+
throw new TypeError(
|
|
306
|
+
"[@mandujs/core/storage/s3] upload: 'key' is required.",
|
|
307
|
+
);
|
|
308
|
+
}
|
|
309
|
+
const file = bunClient.file(options.key);
|
|
310
|
+
const contentType = options.contentType ?? getContentType(options.key);
|
|
311
|
+
|
|
312
|
+
await file.write(body, {
|
|
313
|
+
type: contentType,
|
|
314
|
+
...(options.acl !== undefined ? { acl: options.acl } : {}),
|
|
315
|
+
});
|
|
316
|
+
|
|
317
|
+
// NOTE: metadata is accepted in our public type for forward-compat, but
|
|
318
|
+
// Bun 1.3's `S3File.write` does not surface a `metadata` option. Dropping
|
|
319
|
+
// it silently would be a bug waiting to happen, so we throw at call time.
|
|
320
|
+
if (options.metadata && Object.keys(options.metadata).length > 0) {
|
|
321
|
+
throw new Error(
|
|
322
|
+
"[@mandujs/core/storage/s3] upload: 'metadata' is not yet supported by Bun.S3Client.write. Use a presigned URL with custom headers, or file an issue upstream.",
|
|
323
|
+
);
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
return buildObjectUrl(config, options.key);
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
async function presign(options: S3PresignOptions): Promise<string> {
|
|
330
|
+
if (!options.key) {
|
|
331
|
+
throw new TypeError(
|
|
332
|
+
"[@mandujs/core/storage/s3] presign: 'key' is required.",
|
|
333
|
+
);
|
|
334
|
+
}
|
|
335
|
+
const method = options.method ?? "PUT";
|
|
336
|
+
const expiresIn = options.expiresIn ?? 900;
|
|
337
|
+
const file = bunClient.file(options.key);
|
|
338
|
+
|
|
339
|
+
// Bun.S3File.presign is synchronous; we wrap in a Promise so the public
|
|
340
|
+
// API stays consistent with the rest of the helper surface.
|
|
341
|
+
const url = file.presign({
|
|
342
|
+
method,
|
|
343
|
+
expiresIn,
|
|
344
|
+
...(options.contentType !== undefined ? { type: options.contentType } : {}),
|
|
345
|
+
});
|
|
346
|
+
return url;
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
async function deleteObject(key: string): Promise<void> {
|
|
350
|
+
const file = bunClient.file(key);
|
|
351
|
+
try {
|
|
352
|
+
await file.delete();
|
|
353
|
+
} catch (err) {
|
|
354
|
+
// S3 returns success for delete-of-missing-key; but some S3-compatible
|
|
355
|
+
// providers (and network hiccups) can surface a 404-shaped error. We
|
|
356
|
+
// swallow "not found" and re-throw everything else.
|
|
357
|
+
if (isNotFoundError(err)) return;
|
|
358
|
+
throw err;
|
|
359
|
+
}
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
async function getReadable(key: string): Promise<ReadableStream> {
|
|
363
|
+
const file = bunClient.file(key);
|
|
364
|
+
// `file.stream()` is synchronous and returns a ReadableStream that lazily
|
|
365
|
+
// issues the GET when you start consuming. We preserve that laziness and
|
|
366
|
+
// let errors surface on first read rather than proactively HEAD-ing here.
|
|
367
|
+
return file.stream();
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
async function exists(key: string): Promise<boolean> {
|
|
371
|
+
const file = bunClient.file(key);
|
|
372
|
+
try {
|
|
373
|
+
return await file.exists();
|
|
374
|
+
} catch (err) {
|
|
375
|
+
if (isNotFoundError(err)) return false;
|
|
376
|
+
throw err;
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
return {
|
|
381
|
+
upload,
|
|
382
|
+
presign,
|
|
383
|
+
delete: deleteObject,
|
|
384
|
+
getReadable,
|
|
385
|
+
exists,
|
|
386
|
+
};
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
/**
|
|
390
|
+
* Creates an S3-compatible storage client.
|
|
391
|
+
*
|
|
392
|
+
* @throws if `config.bucket` is missing, or if called outside the Bun runtime.
|
|
393
|
+
*/
|
|
394
|
+
export function createS3Client(config: S3Config): S3Client {
|
|
395
|
+
return _createS3ClientWith(getBunS3ClientCtor(), config);
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
// ─── Error helpers ──────────────────────────────────────────────────────────
|
|
399
|
+
|
|
400
|
+
/**
|
|
401
|
+
* Structural check for "object not found" errors raised by Bun's S3 layer.
|
|
402
|
+
* Bun emits an `S3Error` instance with `code` set; we also handle the
|
|
403
|
+
* HTTP-status-bearing variants some providers surface.
|
|
404
|
+
*/
|
|
405
|
+
function isNotFoundError(err: unknown): boolean {
|
|
406
|
+
if (!err || typeof err !== "object") return false;
|
|
407
|
+
const e = err as { name?: unknown; code?: unknown; status?: unknown };
|
|
408
|
+
if (e.code === "NoSuchKey") return true;
|
|
409
|
+
if (e.code === "NotFound") return true;
|
|
410
|
+
if (e.status === 404) return true;
|
|
411
|
+
return false;
|
|
412
|
+
}
|