@lunora/storage 1.0.0-alpha.7 → 1.0.0-alpha.71

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/dist/index.d.mts CHANGED
@@ -1,140 +1,11 @@
1
+ import { R2MultipartUploadLike, R2RangeLike, R2ObjectBodyLike, R2ObjectLike, R2BucketLike } from '@lunora/platform';
2
+ export type { R2BucketLike, R2MultipartUploadLike, R2ObjectBodyLike, R2ObjectLike, R2RangeLike, R2UploadedPartLike } from '@lunora/platform';
1
3
  /**
2
- * A single-range read against R2: an `{ offset, length }` window (at least one
3
- * bound required, mirroring R2's own `R2Range`) or a `{ suffix }` tail. The
4
- * subset of `R2Range` that {@link Storage.download} forwards so a caller can
5
- * stream just the bytes it needs instead of the whole object.
6
- */
7
- type R2RangeLike = {
8
- length: number;
9
- offset?: number;
10
- } | {
11
- length?: number;
12
- offset: number;
13
- } | {
14
- suffix: number;
15
- };
16
- /**
17
- * Minimal projection of `R2Bucket`. Declared structurally so unit tests can
18
- * pass a plain object double; the real binding satisfies the same shape.
19
- */
20
- interface R2BucketLike {
21
- /**
22
- * Begin a multipart upload (R2 `createMultipartUpload`). Optional so existing
23
- * test doubles still satisfy the type; {@link Storage.createMultipartUpload}
24
- * throws a clear error when the binding lacks it.
25
- */
26
- createMultipartUpload?: (key: string, options?: {
27
- customMetadata?: Record<string, string>;
28
- httpMetadata?: {
29
- contentType?: string;
30
- };
31
- }) => Promise<R2MultipartUploadLike>;
32
- delete: (key: string) => Promise<void>;
33
- get: (key: string, options?: {
34
- range?: R2RangeLike;
35
- }) => Promise<R2ObjectBodyLike | null>;
36
- /**
37
- * Fetch an object's metadata without its body (R2 HEAD). Returns `null` when
38
- * the object is absent. Declared optional so existing test doubles that only
39
- * implement `get`/`put`/`list`/`delete` still satisfy the type; callers that
40
- * need metadata fall back to a 0-length ranged `get()` when `head` is absent.
41
- */
42
- head?: (key: string) => Promise<R2ObjectLike | null>;
43
- list: (options?: {
44
- cursor?: string;
45
- delimiter?: string;
46
- limit?: number;
47
- prefix?: string;
48
- }) => Promise<{
49
- cursor?: string;
50
- objects: R2ObjectLike[];
51
- truncated?: boolean;
52
- }>;
53
- put: (key: string, body: ReadableStream | ArrayBuffer | Blob | string | null, options?: {
54
- customMetadata?: Record<string, string>;
55
- httpMetadata?: {
56
- contentType?: string;
57
- };
58
- }) => Promise<R2ObjectLike>;
59
- /** Resume an in-progress multipart upload by id (R2 `resumeMultipartUpload`). Optional; see {@link Storage.resumeMultipartUpload}. */
60
- resumeMultipartUpload?: (key: string, uploadId: string) => R2MultipartUploadLike;
61
- }
62
- /** One uploaded multipart part — returned by `uploadPart`, required to `complete`. Mirrors R2's `R2UploadedPart`. */
63
- interface R2UploadedPartLike {
64
- etag: string;
65
- partNumber: number;
66
- }
67
- /**
68
- * An in-progress multipart upload, mirroring R2's `R2MultipartUpload`. Each part
69
- * (except the last) must be uniform in size. The object does not guarantee the
70
- * underlying upload still exists — a parallel `complete`/`abort` can invalidate
71
- * it — so wrap each call in error handling.
72
- */
73
- interface R2MultipartUploadLike {
74
- /** Abort the upload, discarding any uploaded parts. */
75
- abort: () => Promise<void>;
76
- /** Finish the upload from the collected parts; resolves to the stored object. */
77
- complete: (uploadedParts: R2UploadedPartLike[]) => Promise<R2ObjectLike>;
78
- /** The object key being assembled. */
79
- readonly key: string;
80
- /** The R2 upload id (persist it to resume across requests). */
81
- readonly uploadId: string;
82
- /** Upload one part (1-indexed); returns the `{ partNumber, etag }` to pass to `complete`. */
83
- uploadPart: (partNumber: number, value: ArrayBuffer | ArrayBufferView | Blob | ReadableStream | string) => Promise<R2UploadedPartLike>;
84
- }
85
- interface R2ObjectLike {
86
- /**
87
- * R2-computed checksums. The real binding exposes `sha256` as an
88
- * `ArrayBuffer` (present only when R2 stored a SHA-256 for the object);
89
- * declared optional so fakes and non-checksummed objects type-check.
90
- */
91
- checksums?: {
92
- sha256?: ArrayBuffer;
93
- };
94
- customMetadata?: Record<string, string>;
95
- etag: string;
96
- /**
97
- * The quoted form of {@link R2ObjectLike.etag} (e.g. `"abc123"`), suitable
98
- * for emitting directly as an HTTP `ETag` header. The real binding always
99
- * provides it; declared optional so existing doubles that only set `etag`
100
- * still type-check (callers fall back to quoting `etag`).
101
- */
102
- httpEtag?: string;
103
- httpMetadata?: {
104
- contentType?: string;
105
- };
106
- key: string;
107
- /**
108
- * Hex-encoded SHA-256 of the object body, surfaced by `download()`/`list()`
109
- * when R2 carries a checksum (derived from {@link R2ObjectLike.checksums}).
110
- */
111
- sha256?: string;
112
- /**
113
- * Base64-encoded SHA-256 of the object body, surfaced alongside
114
- * {@link R2ObjectLike.sha256} from the same checksum. Base64 is the encoding
115
- * RFC 9530 digest headers (`Repr-Digest`/`Content-Digest`) require, so HTTP
116
- * layers can emit a spec-compliant digest without re-deriving it.
117
- */
118
- sha256Base64?: string;
119
- size: number;
120
- /**
121
- * When the object was written. The real binding exposes this as a `Date`;
122
- * declared optional so fakes that omit it still type-check.
123
- * {@link Storage.getMetadata} normalises it to epoch ms.
124
- */
125
- uploaded?: Date;
126
- }
127
- interface R2ObjectBodyLike extends R2ObjectLike {
128
- arrayBuffer: () => Promise<ArrayBuffer>;
129
- body: ReadableStream | null;
130
- text: () => Promise<string>;
131
- }
132
- /**
133
- * R2 S3-API credentials for {@link Storage.getPresignedUrl}. These are an R2 API
134
- * token's Access Key ID / Secret Access Key (NOT a Cloudflare API token), plus
135
- * the account id and bucket name. Required only if you call `getPresignedUrl`;
136
- * the worker-signed URL path (`getSignedUrl`) needs none of this.
137
- */
4
+ * R2 S3-API credentials for {@link Storage.getPresignedUrl}. These are an R2 API
5
+ * token's Access Key ID / Secret Access Key (NOT a Cloudflare API token), plus
6
+ * the account id and bucket name. Required only if you call `getPresignedUrl`;
7
+ * the worker-signed URL path (`getSignedUrl`) needs none of this.
8
+ */
138
9
  interface R2S3Credentials {
139
10
  /** R2 S3 Access Key ID. */
140
11
  accessKeyId: string;
@@ -149,20 +20,34 @@ interface R2S3Credentials {
149
20
  }
150
21
  /** Options for {@link Storage.getPresignedUrl}. */
151
22
  interface PresignedUrlOptions {
152
- /** Seconds the URL stays valid; clamped to [1, 604800]. Default 900. */
23
+ /** Seconds the URL stays valid: 1 to 604800 (7 days); an out-of-range value throws. Default 900. */
153
24
  expiresInSeconds?: number;
154
25
  /** HTTP method the URL authorizes. Default `GET`. */
155
26
  method?: "GET" | "PUT";
156
27
  }
157
28
  interface LunoraStorageOptions {
158
29
  bucket: R2BucketLike;
30
+ /**
31
+ * The name this bucket is registered under — the same string a
32
+ * `defineStorageRule({ bucket })` rule and the generated `StorageBucketName`
33
+ * union use. Bound into every signed URL's HMAC and mirrored on it as
34
+ * `&bucket=`, so a URL minted for one bucket can't be replayed against
35
+ * another sharing the signing secret, and the serving route can resolve
36
+ * which bucket to read.
37
+ *
38
+ * Required, and deliberately without a default: a defaulted name is how
39
+ * every bucket ended up signing as `"default"` and cross-verifying against
40
+ * each other. Pass `"default"` for a single-bucket app's `ctx.storage`, and
41
+ * the registered name for any bucket reached through `createBucketStorage`.
42
+ */
43
+ bucketName: string;
159
44
  /** Public base URL used by `getSignedUrl()`. Required for signed URLs. */
160
45
  publicBaseUrl?: string;
161
46
  /**
162
- * R2 S3-API credentials enabling {@link Storage.getPresignedUrl} (native S3
163
- * presigned URLs that hit R2 directly, bypassing the Worker). Omit to use
164
- * only the worker-signed URL path.
165
- */
47
+ * R2 S3-API credentials enabling {@link Storage.getPresignedUrl} (native S3
48
+ * presigned URLs that hit R2 directly, bypassing the Worker). Omit to use
49
+ * only the worker-signed URL path.
50
+ */
166
51
  s3?: R2S3Credentials;
167
52
  /** HMAC secret used by the worker-signed URL helper. Required for signed URLs. */
168
53
  signingSecret?: string;
@@ -173,38 +58,62 @@ interface UploadOptions {
173
58
  contentType?: string;
174
59
  customMetadata?: Record<string, string>;
175
60
  /**
176
- * Maximum body size in bytes. For `ArrayBuffer`/`Blob` sources the length is
177
- * known up front and rejected before the upload starts. For a
178
- * `ReadableStream` the length isn't known synchronously, so the stream is
179
- * piped through a byte counter that aborts the upload once the limit is
180
- * exceeded — this also guards against R2 silently accepting/truncating an
181
- * unbounded stream.
182
- */
61
+ * Maximum body size in bytes. For `ArrayBuffer`/`Blob` sources the length is
62
+ * known up front and rejected before the upload starts.
63
+ *
64
+ * A `ReadableStream` has no length to check, and R2 refuses any stream whose
65
+ * length it cannot read — so a capped stream is READ INTO MEMORY under the
66
+ * cap and uploaded as a sized body. Nothing reaches the bucket if the body
67
+ * crosses the limit.
68
+ *
69
+ * `maxSize` is therefore also the memory ceiling for a streamed upload, and
70
+ * the isolate's ~128 MB is shared by every concurrent request — so on the
71
+ * stream path `maxSize` is itself capped at 16 MiB and rejected above it.
72
+ * For objects larger than that use `createMultipartUpload` /
73
+ * `createUploadHandler`, which upload without ever holding the whole object.
74
+ * Must be a finite, non-negative number; anything else (`Number(undefined)`
75
+ * is the usual source) is rejected as a `VALIDATION_ERROR`.
76
+ */
183
77
  maxSize?: number;
78
+ /**
79
+ * SHA-256 of the body (hex or a 32-byte buffer), recorded with the object.
80
+ *
81
+ * R2 only reports a checksum it was given: without this, `list()`/`head()`
82
+ * return no `sha256` and any later integrity check degrades to comparing
83
+ * sizes. R2 also verifies the digest itself on write, so supplying it turns
84
+ * the upload into a checked one.
85
+ */
86
+ sha256?: ArrayBuffer | string;
184
87
  }
185
88
  interface ListOptions {
186
89
  cursor?: string;
187
90
  /** R2 list delimiter — when set, common prefixes group instead of listing. */
188
91
  delimiter?: string;
189
- /** Defaults to 100, capped at 1000 (R2 limit). */
92
+ /**
93
+ * Defaults to 100, capped at 1000 (R2 limit). A ceiling, not a promise: R2
94
+ * may return fewer per page to fit the entry metadata.
95
+ *
96
+ * Must be a positive integer when given — `0`, `12.5` and `NaN` throw rather
97
+ * than being coerced into a page size the caller never asked for.
98
+ */
190
99
  limit?: number;
191
100
  }
192
101
  interface SignedUrlOptions {
193
102
  /**
194
- * Pin the `Content-Type` an uploader must send on a `method: "PUT"` URL.
195
- * Baked into the HMAC canonical so the signature only authorizes a PUT with
196
- * exactly this content-type; mirrored on the URL as `&amp;ct=...`. Ignored for
197
- * `GET` URLs (a download has no request body content-type to pin).
198
- */
103
+ * Pin the `Content-Type` an uploader must send on a `method: "PUT"` URL.
104
+ * Baked into the HMAC canonical so the signature only authorizes a PUT with
105
+ * exactly this content-type; mirrored on the URL as `&ct=...`. Ignored for
106
+ * `GET` URLs (a download has no request body content-type to pin).
107
+ */
199
108
  contentType?: string;
200
109
  expiresInSeconds?: number;
201
110
  method?: "GET" | "PUT";
202
111
  }
203
112
  /**
204
- * Per-object metadata returned by {@link Storage.getMetadata} — a flat,
205
- * body-free projection of {@link R2ObjectLike}. Mirrors the shape Convex
206
- * surfaces for `ctx.storage.getMetadata` / the `_storage` system table.
207
- */
113
+ * Per-object metadata returned by {@link Storage.getMetadata} — a flat,
114
+ * body-free projection of {@link R2ObjectLike}. Mirrors the shape Convex
115
+ * surfaces for `ctx.storage.getMetadata` / the `_storage` system table.
116
+ */
208
117
  interface ObjectMetadata {
209
118
  /** The object's `Content-Type` (R2 `httpMetadata.contentType`), if recorded. */
210
119
  contentType?: string;
@@ -221,85 +130,128 @@ interface ObjectMetadata {
221
130
  }
222
131
  interface Storage {
223
132
  /**
224
- * Begin a native R2 **multipart upload** for very large objects — upload
225
- * parts (each uniform in size except the last), then `complete` with the
226
- * returned parts (or `abort`). Wraps R2's `createMultipartUpload`; throws if
227
- * the bound bucket doesn't support it. For ordinary uploads use
228
- * {@link Storage.upload} / {@link Storage.store}.
229
- */
133
+ * The bucket name this accessor operates under — the same value
134
+ * {@link Storage.getSignedUrl} puts into the HMAC canonical.
135
+ *
136
+ * Exposed so everything downstream agrees on one name: `asBucketStorage`
137
+ * tags a single-bucket storage with it, and `storageRules(...)` matches
138
+ * `(bucket, operation)` rules against that tag. Without it a
139
+ * `createStorage({ bucketName: "avatars" })` signed URLs as `avatars` while
140
+ * the rules engine only ever saw `"default"`.
141
+ */
142
+ readonly bucketName: string;
143
+ /**
144
+ * Begin a native R2 **multipart upload** for very large objects — upload
145
+ * parts (each uniform in size except the last), then `complete` with the
146
+ * returned parts (or `abort`). Wraps R2's `createMultipartUpload`; throws if
147
+ * the bound bucket doesn't support it. For ordinary uploads use
148
+ * {@link Storage.upload} / {@link Storage.store}.
149
+ */
230
150
  createMultipartUpload: (key: string, options?: {
231
151
  contentType?: string;
232
152
  customMetadata?: Record<string, string>;
233
153
  }) => Promise<R2MultipartUploadLike>;
234
154
  delete: (key: string) => Promise<void>;
235
155
  /**
236
- * Fetch a stored object's metadata + body. Pass `options.range` to stream
237
- * only a byte window (R2 resolves the range server-side, so the unwanted
238
- * bytes never reach the Worker) — `download(key)` reads the whole object.
239
- */
156
+ * Fetch a stored object's metadata + body. Pass `options.range` to stream
157
+ * only a byte window (R2 resolves the range server-side, so the unwanted
158
+ * bytes never reach the Worker) — `download(key)` reads the whole object.
159
+ */
240
160
  download: (key: string, options?: {
241
161
  range?: R2RangeLike;
242
162
  }) => Promise<R2ObjectBodyLike | null>;
243
163
  /**
244
- * Mint a short-lived signed `PUT` URL a client can upload directly to,
245
- * optionally pinning the request `Content-Type`. Convex-compatible alias
246
- * built on {@link Storage.getSignedUrl} with `method: "PUT"`.
247
- */
164
+ * Mint a short-lived signed `PUT` URL a client can upload directly to,
165
+ * optionally pinning the request `Content-Type`. Convex-compatible alias
166
+ * built on {@link Storage.getSignedUrl} with `method: "PUT"`.
167
+ */
248
168
  generateUploadUrl: (key: string, options?: {
249
169
  contentType?: string;
250
170
  expiresInSeconds?: number;
251
171
  }) => Promise<string>;
252
172
  /**
253
- * Read a stored object's metadata (size, content-type, sha256, upload time,
254
- * custom metadata) without fetching its body. Returns `null` when the object
255
- * is absent. Backed by an R2 HEAD (`bucket.head`) when available, falling
256
- * back to a 0-length ranged `get()` otherwise. Mirrors Convex's
257
- * `ctx.storage.getMetadata`.
258
- */
173
+ * Read a stored object's metadata (size, content-type, sha256, upload time,
174
+ * custom metadata) without fetching its body, as a flat serializable shape.
175
+ * Returns `null` when the object is absent. A projection of
176
+ * {@link Storage.head}, so it makes the same single body-free read. Mirrors
177
+ * Convex's `ctx.storage.getMetadata`.
178
+ */
259
179
  getMetadata: (key: string) => Promise<ObjectMetadata | null>;
260
180
  /**
261
- * Mint a native S3 **presigned URL** (SigV4) that hits R2 directly, bypassing
262
- * the Worker. Use for large downloads/uploads where you don't need per-request
263
- * app gating and want the bytes off the Worker's CPU/bandwidth budget. Requires
264
- * {@link LunoraStorageOptions.s3} credentials; throws if they're absent. For
265
- * app-gated access (auth/policy/rate-limit) prefer {@link Storage.getSignedUrl}.
266
- */
181
+ * Mint a native S3 **presigned URL** (SigV4) that hits R2 directly, bypassing
182
+ * the Worker. Use for large downloads/uploads where you don't need per-request
183
+ * app gating and want the bytes off the Worker's CPU/bandwidth budget. Requires
184
+ * {@link LunoraStorageOptions.s3} credentials; throws if they're absent. For
185
+ * app-gated access (auth/policy/rate-limit) prefer {@link Storage.getSignedUrl}.
186
+ */
267
187
  getPresignedUrl: (key: string, options?: PresignedUrlOptions) => Promise<string>;
268
188
  getSignedUrl: (key: string, options?: SignedUrlOptions) => Promise<string>;
269
189
  getUrl: (key: string) => string;
190
+ /**
191
+ * Read an object's R2 metadata WITHOUT its body — `size` (the full object
192
+ * size), `etag`, `httpMetadata`, `checksums`, plus the `sha256`/`sha256Base64`
193
+ * projection `download()` adds. Returns `null` when the object is absent.
194
+ *
195
+ * Backed by an R2 HEAD when the binding exposes one, falling back to a
196
+ * 0-length ranged `get()` otherwise. Prefer this over `download()` whenever
197
+ * only the metadata is wanted — notably to resolve a `Range` header, where a
198
+ * plain `download()` starts a full-object body transfer that is then thrown
199
+ * away. {@link Storage.getMetadata} is the flat, serializable projection of
200
+ * the same read.
201
+ */
202
+ head: (key: string) => Promise<R2ObjectLike | null>;
203
+ /**
204
+ * List objects under `prefix`. With `options.delimiter` set, keys sharing a
205
+ * segment are rolled up into `delimitedPrefixes` (the "folders") and are NOT
206
+ * in `objects` — a folder browser needs both, so a listing whose `objects` is
207
+ * empty is not an empty directory.
208
+ *
209
+ * A page may hold FEWER objects than `options.limit`: R2 shrinks a page to
210
+ * fit the per-entry metadata this call asks for. Paginate on `truncated` /
211
+ * `cursor`, never on `objects.length === limit`.
212
+ */
270
213
  list: (prefix?: string, options?: ListOptions) => Promise<{
271
214
  cursor?: string;
215
+ delimitedPrefixes?: string[];
272
216
  objects: R2ObjectLike[];
273
217
  truncated?: boolean;
274
218
  }>;
275
219
  /**
276
- * Resume an in-progress multipart upload by its `uploadId` (e.g. across
277
- * requests). Wraps R2's `resumeMultipartUpload`; the id is not validated by
278
- * R2, so a stale id surfaces as an error on the first `uploadPart`/`complete`.
279
- */
220
+ * Resume an in-progress multipart upload by its `uploadId` (e.g. across
221
+ * requests). Wraps R2's `resumeMultipartUpload`; the id is not validated by
222
+ * R2, so a stale id surfaces as an error on the first `uploadPart`/`complete`.
223
+ */
280
224
  resumeMultipartUpload: (key: string, uploadId: string) => R2MultipartUploadLike;
281
225
  /**
282
- * Upload `body` to `key`, returning the stored key + etag. Convex-compatible
283
- * alias for {@link Storage.upload} — it accepts the same {@link UploadOptions}
284
- * so the `maxSize` / `allowedContentTypes` guards aren't lost behind the alias.
285
- */
286
- store: (key: string, body: ReadableStream | ArrayBuffer | Blob, options?: UploadOptions) => Promise<{
226
+ * Upload `body` to `key`, returning the stored key + etag. Convex-compatible
227
+ * alias for {@link Storage.upload} — it accepts the same {@link UploadOptions}
228
+ * so the `maxSize` / `allowedContentTypes` guards aren't lost behind the alias.
229
+ */
230
+ store: (key: string, body: ReadableStream | ArrayBuffer | ArrayBufferView | Blob | string, options?: UploadOptions) => Promise<{
287
231
  etag: string;
288
232
  httpEtag: string;
289
233
  key: string;
290
234
  }>;
291
- upload: (key: string, body: ReadableStream | ArrayBuffer | Blob, options?: UploadOptions) => Promise<{
235
+ /**
236
+ * Upload `body` to `key`, returning the stored key + etag.
237
+ *
238
+ * The accepted shapes mirror what R2's `put` stores bytes from — a view
239
+ * (`Uint8Array`) and a `string` included. They are listed here because
240
+ * `maxSize` measures every one of them; a shape the cap cannot measure is
241
+ * refused rather than uploaded uncapped.
242
+ */
243
+ upload: (key: string, body: ReadableStream | ArrayBuffer | ArrayBufferView | Blob | string, options?: UploadOptions) => Promise<{
292
244
  etag: string;
293
245
  httpEtag: string;
294
246
  key: string;
295
247
  }>;
296
248
  }
297
249
  /**
298
- * A bucket-aware {@link Storage}: the methods target a default bucket, and
299
- * `bucket(name)` selects a different named bucket (declared via
300
- * `v.storage("name")`). `bucketName` is the bucket the current accessor targets
301
- * — the storage-rules middleware reads it to scope `(bucket, operation)` rules.
302
- */
250
+ * A bucket-aware {@link Storage}: the methods target a default bucket, and
251
+ * `bucket(name)` selects a different named bucket (declared via
252
+ * `v.storage("name")`). `bucketName` is the bucket the current accessor targets
253
+ * — the storage-rules middleware reads it to scope `(bucket, operation)` rules.
254
+ */
303
255
  interface BucketStorage extends Storage {
304
256
  /** Select a named bucket. Unknown names throw with the list of registered buckets. */
305
257
  bucket: (name: string) => BucketStorage;
@@ -307,43 +259,39 @@ interface BucketStorage extends Storage {
307
259
  readonly bucketName: string;
308
260
  }
309
261
  /**
310
- * Compose several per-bucket {@link Storage} instances into one bucket-aware
311
- * accessor. The bare methods (`download` / `store` / …) target the default
312
- * bucket; `bucket(name)` switches to another. Each accessor is tagged with its
313
- * `bucketName` so `storageRules(...)` can enforce per-bucket.
314
- *
315
- * ```ts
316
- * storage: (env) => createBucketStorage({
317
- * default: createStorage({ bucket: env.FILES }),
318
- * avatars: createStorage({ bucket: env.AVATARS }),
319
- * }),
320
- * // → ctx.storage.download(key) // default bucket
321
- * // → ctx.storage.bucket("avatars").store() // the avatars bucket
322
- * ```
323
- *
324
- * The bare accessor is tagged `"default"` — the canonical name a
325
- * `defineStorageRule({ bucket: "default" })` rule and the generated
326
- * `StorageBucketName` union both use — unless `options.default` names another
327
- * bucket (then the bare accessor takes that name). The binding it delegates to is
328
- * `options.default`, else the `"default"` key when present, else the first
329
- * registered bucket. Named buckets are reached with `bucket(name)`.
330
- */
262
+ * Compose several per-bucket {@link Storage} instances into one bucket-aware
263
+ * accessor. The bare methods (`download` / `store` / …) target the default
264
+ * bucket; `bucket(name)` switches to another. Each accessor is tagged with its
265
+ * `bucketName` so `storageRules(...)` can enforce per-bucket.
266
+ *
267
+ * ```ts
268
+ * storage: (env) => createBucketStorage({
269
+ * default: createStorage({ bucket: env.FILES, bucketName: "default" }),
270
+ * avatars: createStorage({ bucket: env.AVATARS, bucketName: "avatars" }),
271
+ * }),
272
+ * // → ctx.storage.download(key) // default bucket
273
+ * // → ctx.storage.bucket("avatars").store() // the avatars bucket
274
+ * ```
275
+ *
276
+ * The bare accessor is tagged with the name of the binding it actually
277
+ * delegates to: `options.default` when given, else `"default"` when that key
278
+ * exists (the canonical name a `defineStorageRule({ bucket: "default" })` rule
279
+ * and the generated `StorageBucketName` union use), else the first registered
280
+ * bucket. Tag and binding must agree or a `{ bucket: "avatars" }` rule would
281
+ * gate `bucket("avatars").download()` and not the identical bare
282
+ * `ctx.storage.download()` reaching the same R2 bucket. Named buckets are
283
+ * reached with `bucket(name)`.
284
+ */
331
285
  declare const createBucketStorage: (buckets: Record<string, Storage>, options?: {
332
286
  default?: string;
333
287
  }) => BucketStorage;
334
- /**
335
- * Compose a per-tenant key from a scope prefix and a caller-supplied key.
336
- * Both halves are validated — the prefix may not contain `..` or NUL either,
337
- * and the resulting key must stay under R2's length ceiling. Recommended for
338
- * any multi-tenant deployment so client-supplied keys can't address peer data.
339
- */
340
288
  declare const scopeKey: (prefix: string, key: string) => string;
341
289
  declare const createStorage: (options: LunoraStorageOptions) => Storage;
342
290
  /** Parameters accepted by {@link buildPresignedUrl}. */
343
291
  interface PresignedUrlParams {
344
292
  /** R2 S3 API credentials + bucket/account. */
345
293
  credentials: R2S3Credentials;
346
- /** Seconds the URL stays valid; clamped to [1, 604800]. Default 900. */
294
+ /** Seconds the URL stays valid: 1 to 604800 (7 days); an out-of-range value throws. Default 900. */
347
295
  expiresInSeconds?: number;
348
296
  /** Object key (path-style; not URL-encoded by the caller). */
349
297
  key: string;
@@ -353,54 +301,67 @@ interface PresignedUrlParams {
353
301
  now?: () => number;
354
302
  }
355
303
  /**
356
- * Build a native S3 presigned URL for an R2 object using SigV4 query-string
357
- * auth. The returned URL points at R2's S3 endpoint and carries the full
358
- * signature, so it authorizes a single `GET`/`PUT` on `key` until it expires —
359
- * no Worker round-trip.
360
- */
304
+ * Build a native S3 presigned URL for an R2 object using SigV4 query-string
305
+ * auth. The returned URL points at R2's S3 endpoint and carries the full
306
+ * signature, so it authorizes a single `GET`/`PUT` on `key` until it expires —
307
+ * no Worker round-trip.
308
+ */
361
309
  declare const buildPresignedUrl: (parameters: PresignedUrlParams) => Promise<string>;
362
310
  /**
363
- * Worker-signed URL: the `publicBaseUrl` joined to the object `key`, plus a query
364
- * string carrying `exp` (unix seconds), `method` (`GET` or `PUT`) and `sig`
365
- * (a base64url HMAC).
366
- *
367
- * The HMAC canonical includes the URL host so a signature minted for one bucket
368
- * cannot be replayed against another host on the same signing secret. Even so,
369
- * the signing secret MUST NOT be shared across buckets/tenants — host binding
370
- * narrows replay surface but is not a substitute for per-tenant key isolation.
371
- *
372
- * The Worker handling `GET /storage/:key` should call {@link verifySignedUrl}
373
- * to validate the signature + expiry before streaming the R2 body.
374
- */
375
- declare const buildSignedUrl: (args: SignedUrlOptions & {
311
+ * Worker-signed URL: the `publicBaseUrl` joined to the object `key`, plus a query
312
+ * string carrying `exp` (unix seconds), `method` (`GET` or `PUT`) and `sig`
313
+ * (a base64url HMAC).
314
+ *
315
+ * The HMAC canonical includes the URL host AND the `bucketName`, so a signature
316
+ * minted for one bucket cannot be replayed against another bucket (all buckets
317
+ * of one `.storage()` declaration share a base URL and signing secret) or
318
+ * another host. Even so, the signing secret MUST NOT be shared across
319
+ * tenants — this binding narrows replay surface but is not a substitute for
320
+ * per-tenant key isolation.
321
+ *
322
+ * The Worker route handling the signed download/upload (mounted at
323
+ * `publicBaseUrl`'s origin, e.g. `GET /:key`) should call
324
+ * {@link verifySignedUrl} to validate the signature + expiry before streaming
325
+ * the R2 body. `baseUrl` must be a bare origin (no path) — see the module
326
+ * docstring.
327
+ */
328
+ declare const buildSignedUrl: (args: {
376
329
  baseUrl: string;
330
+ /** The bucket the URL addresses — bound into the HMAC and mirrored as `&bucket=`. */
331
+ bucketName: string;
377
332
  key: string;
378
333
  secret: string;
379
- }) => Promise<string>;
334
+ } & SignedUrlOptions) => Promise<string>;
380
335
  interface VerifyResult {
336
+ /**
337
+ * The bucket the URL was minted for. The serving route MUST resolve its R2
338
+ * binding from this (never from a caller-supplied bucket), since one signing
339
+ * secret covers every bucket of a `.storage()` declaration.
340
+ */
341
+ bucketName?: string;
381
342
  /** The pinned upload `Content-Type` carried by a PUT URL, when present. */
382
343
  contentType?: string;
383
344
  key?: string;
384
345
  method?: "GET" | "PUT";
385
346
  /**
386
- * Internal-only failure reason for server logs/diagnostics. **Do not echo
387
- * to clients** — a precise reason ("expired" vs "bad_signature") is a
388
- * signing oracle. Public responses should expose only `valid`.
389
- */
347
+ * Internal-only failure reason for server logs/diagnostics. **Do not echo
348
+ * to clients** — a precise reason ("expired" vs "bad_signature") is a
349
+ * signing oracle. Public responses should expose only `valid`.
350
+ */
390
351
  reason?: "bad_signature" | "expired" | "malformed";
391
352
  valid: boolean;
392
353
  }
393
354
  /**
394
- * Verify a {@link buildSignedUrl} output. By default the signature is
395
- * canonicalized against the inbound `url.host`, which matches the build-side
396
- * host whenever the URL being verified is the URL that was minted. In a
397
- * topology where the host the Worker sees differs from the configured
398
- * `publicBaseUrl` host (e.g. a CDN host vs a Worker route that rewrites
399
- * `Host`), pass `expectedHost` (the `publicBaseUrl` host) so verification
400
- * canonicalizes against the same host the signature was minted for instead of
401
- * failing every request as `bad_signature`.
402
- */
355
+ * Verify a {@link buildSignedUrl} output. By default the signature is
356
+ * canonicalized against the inbound `url.host`, which matches the build-side
357
+ * host whenever the URL being verified is the URL that was minted. In a
358
+ * topology where the host the Worker sees differs from the configured
359
+ * `publicBaseUrl` host (e.g. a CDN host vs a Worker route that rewrites
360
+ * `Host`), pass `expectedHost` (the `publicBaseUrl` host) so verification
361
+ * canonicalizes against the same host the signature was minted for instead of
362
+ * failing every request as `bad_signature`.
363
+ */
403
364
  declare const verifySignedUrl: (input: string | URL, secret: string, options?: {
404
365
  expectedHost?: string;
405
366
  }) => Promise<VerifyResult>;
406
- export { type BucketStorage, type ListOptions, type LunoraStorageOptions, type ObjectMetadata, type PresignedUrlOptions, type PresignedUrlParams, type R2BucketLike, type R2MultipartUploadLike, type R2ObjectBodyLike, type R2ObjectLike, type R2RangeLike, type R2S3Credentials, type R2UploadedPartLike, type SignedUrlOptions, type Storage, type UploadOptions, type VerifyResult, buildPresignedUrl, buildSignedUrl, createBucketStorage, createStorage, scopeKey, verifySignedUrl };
367
+ export { type BucketStorage, type ListOptions, type LunoraStorageOptions, type ObjectMetadata, type PresignedUrlOptions, type PresignedUrlParams, type R2S3Credentials, type SignedUrlOptions, type Storage, type UploadOptions, type VerifyResult, buildPresignedUrl, buildSignedUrl, createBucketStorage, createStorage, scopeKey, verifySignedUrl };