@lunora/storage 1.0.0-alpha.4 → 1.0.0-alpha.40

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/LICENSE.md CHANGED
@@ -103,3 +103,9 @@ Unless required by applicable law or agreed to in writing, software distributed
103
103
  under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
104
104
  CONDITIONS OF ANY KIND, either express or implied. See the License for the
105
105
  specific language governing permissions and limitations under the License.
106
+
107
+ <!-- DEPENDENCIES -->
108
+ <!-- /DEPENDENCIES -->
109
+
110
+ <!-- TYPE_DEPENDENCIES -->
111
+ <!-- /TYPE_DEPENDENCIES -->
package/README.md CHANGED
@@ -34,7 +34,7 @@
34
34
 
35
35
  ---
36
36
 
37
- R2-backed file storage for Lunora. Wraps a Cloudflare `R2Bucket` binding with a typed API (`upload`/`store`, `download`, `delete`, `list`, `getMetadata`, multipart), worker-signed URLs for app-gated access, and native S3 presigned URLs for direct-to-R2 transfer.
37
+ R2-backed file storage for Lunora. Wraps a Cloudflare `R2Bucket` binding with a typed API (`upload`/`store`, `download`, `head`, `delete`, `list`, `getMetadata`, multipart), worker-signed URLs for app-gated access, and native S3 presigned URLs for direct-to-R2 transfer.
38
38
 
39
39
  Part of the [Lunora](https://github.com/anolilab/lunora) framework — a type-safe, real-time backend on Cloudflare Workers + Durable Objects with a Vite-first DX.
40
40
 
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,7 +20,7 @@ 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";
@@ -159,10 +30,10 @@ interface LunoraStorageOptions {
159
30
  /** Public base URL used by `getSignedUrl()`. Required for signed URLs. */
160
31
  publicBaseUrl?: string;
161
32
  /**
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
- */
33
+ * R2 S3-API credentials enabling {@link Storage.getPresignedUrl} (native S3
34
+ * presigned URLs that hit R2 directly, bypassing the Worker). Omit to use
35
+ * only the worker-signed URL path.
36
+ */
166
37
  s3?: R2S3Credentials;
167
38
  /** HMAC secret used by the worker-signed URL helper. Required for signed URLs. */
168
39
  signingSecret?: string;
@@ -173,14 +44,23 @@ interface UploadOptions {
173
44
  contentType?: string;
174
45
  customMetadata?: Record<string, string>;
175
46
  /**
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
- */
47
+ * Maximum body size in bytes. For `ArrayBuffer`/`Blob` sources the length is
48
+ * known up front and rejected before the upload starts. For a
49
+ * `ReadableStream` the length isn't known synchronously, so the stream is
50
+ * piped through a byte counter that aborts the upload once the limit is
51
+ * exceeded — this also guards against R2 silently accepting/truncating an
52
+ * unbounded stream.
53
+ */
183
54
  maxSize?: number;
55
+ /**
56
+ * SHA-256 of the body (hex or a 32-byte buffer), recorded with the object.
57
+ *
58
+ * R2 only reports a checksum it was given: without this, `list()`/`head()`
59
+ * return no `sha256` and any later integrity check degrades to comparing
60
+ * sizes. R2 also verifies the digest itself on write, so supplying it turns
61
+ * the upload into a checked one.
62
+ */
63
+ sha256?: ArrayBuffer | string;
184
64
  }
185
65
  interface ListOptions {
186
66
  cursor?: string;
@@ -191,20 +71,20 @@ interface ListOptions {
191
71
  }
192
72
  interface SignedUrlOptions {
193
73
  /**
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
- */
74
+ * Pin the `Content-Type` an uploader must send on a `method: "PUT"` URL.
75
+ * Baked into the HMAC canonical so the signature only authorizes a PUT with
76
+ * exactly this content-type; mirrored on the URL as `&ct=...`. Ignored for
77
+ * `GET` URLs (a download has no request body content-type to pin).
78
+ */
199
79
  contentType?: string;
200
80
  expiresInSeconds?: number;
201
81
  method?: "GET" | "PUT";
202
82
  }
203
83
  /**
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
- */
84
+ * Per-object metadata returned by {@link Storage.getMetadata} — a flat,
85
+ * body-free projection of {@link R2ObjectLike}. Mirrors the shape Convex
86
+ * surfaces for `ctx.storage.getMetadata` / the `_storage` system table.
87
+ */
208
88
  interface ObjectMetadata {
209
89
  /** The object's `Content-Type` (R2 `httpMetadata.contentType`), if recorded. */
210
90
  contentType?: string;
@@ -221,68 +101,81 @@ interface ObjectMetadata {
221
101
  }
222
102
  interface Storage {
223
103
  /**
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
- */
104
+ * Begin a native R2 **multipart upload** for very large objects — upload
105
+ * parts (each uniform in size except the last), then `complete` with the
106
+ * returned parts (or `abort`). Wraps R2's `createMultipartUpload`; throws if
107
+ * the bound bucket doesn't support it. For ordinary uploads use
108
+ * {@link Storage.upload} / {@link Storage.store}.
109
+ */
230
110
  createMultipartUpload: (key: string, options?: {
231
111
  contentType?: string;
232
112
  customMetadata?: Record<string, string>;
233
113
  }) => Promise<R2MultipartUploadLike>;
234
114
  delete: (key: string) => Promise<void>;
235
115
  /**
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
- */
116
+ * Fetch a stored object's metadata + body. Pass `options.range` to stream
117
+ * only a byte window (R2 resolves the range server-side, so the unwanted
118
+ * bytes never reach the Worker) — `download(key)` reads the whole object.
119
+ */
240
120
  download: (key: string, options?: {
241
121
  range?: R2RangeLike;
242
122
  }) => Promise<R2ObjectBodyLike | null>;
243
123
  /**
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
- */
124
+ * Mint a short-lived signed `PUT` URL a client can upload directly to,
125
+ * optionally pinning the request `Content-Type`. Convex-compatible alias
126
+ * built on {@link Storage.getSignedUrl} with `method: "PUT"`.
127
+ */
248
128
  generateUploadUrl: (key: string, options?: {
249
129
  contentType?: string;
250
130
  expiresInSeconds?: number;
251
131
  }) => Promise<string>;
252
132
  /**
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
- */
133
+ * Read a stored object's metadata (size, content-type, sha256, upload time,
134
+ * custom metadata) without fetching its body, as a flat serializable shape.
135
+ * Returns `null` when the object is absent. A projection of
136
+ * {@link Storage.head}, so it makes the same single body-free read. Mirrors
137
+ * Convex's `ctx.storage.getMetadata`.
138
+ */
259
139
  getMetadata: (key: string) => Promise<ObjectMetadata | null>;
260
140
  /**
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
- */
141
+ * Mint a native S3 **presigned URL** (SigV4) that hits R2 directly, bypassing
142
+ * the Worker. Use for large downloads/uploads where you don't need per-request
143
+ * app gating and want the bytes off the Worker's CPU/bandwidth budget. Requires
144
+ * {@link LunoraStorageOptions.s3} credentials; throws if they're absent. For
145
+ * app-gated access (auth/policy/rate-limit) prefer {@link Storage.getSignedUrl}.
146
+ */
267
147
  getPresignedUrl: (key: string, options?: PresignedUrlOptions) => Promise<string>;
268
148
  getSignedUrl: (key: string, options?: SignedUrlOptions) => Promise<string>;
269
149
  getUrl: (key: string) => string;
150
+ /**
151
+ * Read an object's R2 metadata WITHOUT its body — `size` (the full object
152
+ * size), `etag`, `httpMetadata`, `checksums`, plus the `sha256`/`sha256Base64`
153
+ * projection `download()` adds. Returns `null` when the object is absent.
154
+ *
155
+ * Backed by an R2 HEAD when the binding exposes one, falling back to a
156
+ * 0-length ranged `get()` otherwise. Prefer this over `download()` whenever
157
+ * only the metadata is wanted — notably to resolve a `Range` header, where a
158
+ * plain `download()` starts a full-object body transfer that is then thrown
159
+ * away. {@link Storage.getMetadata} is the flat, serializable projection of
160
+ * the same read.
161
+ */
162
+ head: (key: string) => Promise<R2ObjectLike | null>;
270
163
  list: (prefix?: string, options?: ListOptions) => Promise<{
271
164
  cursor?: string;
272
165
  objects: R2ObjectLike[];
273
166
  truncated?: boolean;
274
167
  }>;
275
168
  /**
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
- */
169
+ * Resume an in-progress multipart upload by its `uploadId` (e.g. across
170
+ * requests). Wraps R2's `resumeMultipartUpload`; the id is not validated by
171
+ * R2, so a stale id surfaces as an error on the first `uploadPart`/`complete`.
172
+ */
280
173
  resumeMultipartUpload: (key: string, uploadId: string) => R2MultipartUploadLike;
281
174
  /**
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
- */
175
+ * Upload `body` to `key`, returning the stored key + etag. Convex-compatible
176
+ * alias for {@link Storage.upload} — it accepts the same {@link UploadOptions}
177
+ * so the `maxSize` / `allowedContentTypes` guards aren't lost behind the alias.
178
+ */
286
179
  store: (key: string, body: ReadableStream | ArrayBuffer | Blob, options?: UploadOptions) => Promise<{
287
180
  etag: string;
288
181
  httpEtag: string;
@@ -295,11 +188,11 @@ interface Storage {
295
188
  }>;
296
189
  }
297
190
  /**
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
- */
191
+ * A bucket-aware {@link Storage}: the methods target a default bucket, and
192
+ * `bucket(name)` selects a different named bucket (declared via
193
+ * `v.storage("name")`). `bucketName` is the bucket the current accessor targets
194
+ * — the storage-rules middleware reads it to scope `(bucket, operation)` rules.
195
+ */
303
196
  interface BucketStorage extends Storage {
304
197
  /** Select a named bucket. Unknown names throw with the list of registered buckets. */
305
198
  bucket: (name: string) => BucketStorage;
@@ -307,43 +200,37 @@ interface BucketStorage extends Storage {
307
200
  readonly bucketName: string;
308
201
  }
309
202
  /**
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
- */
203
+ * Compose several per-bucket {@link Storage} instances into one bucket-aware
204
+ * accessor. The bare methods (`download` / `store` / …) target the default
205
+ * bucket; `bucket(name)` switches to another. Each accessor is tagged with its
206
+ * `bucketName` so `storageRules(...)` can enforce per-bucket.
207
+ *
208
+ * ```ts
209
+ * storage: (env) => createBucketStorage({
210
+ * default: createStorage({ bucket: env.FILES }),
211
+ * avatars: createStorage({ bucket: env.AVATARS }),
212
+ * }),
213
+ * // → ctx.storage.download(key) // default bucket
214
+ * // → ctx.storage.bucket("avatars").store() // the avatars bucket
215
+ * ```
216
+ *
217
+ * The bare accessor is tagged `"default"` — the canonical name a
218
+ * `defineStorageRule({ bucket: "default" })` rule and the generated
219
+ * `StorageBucketName` union both use — unless `options.default` names another
220
+ * bucket (then the bare accessor takes that name). The binding it delegates to is
221
+ * `options.default`, else the `"default"` key when present, else the first
222
+ * registered bucket. Named buckets are reached with `bucket(name)`.
223
+ */
331
224
  declare const createBucketStorage: (buckets: Record<string, Storage>, options?: {
332
225
  default?: string;
333
226
  }) => 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
227
  declare const scopeKey: (prefix: string, key: string) => string;
341
228
  declare const createStorage: (options: LunoraStorageOptions) => Storage;
342
229
  /** Parameters accepted by {@link buildPresignedUrl}. */
343
230
  interface PresignedUrlParams {
344
231
  /** R2 S3 API credentials + bucket/account. */
345
232
  credentials: R2S3Credentials;
346
- /** Seconds the URL stays valid; clamped to [1, 604800]. Default 900. */
233
+ /** Seconds the URL stays valid: 1 to 604800 (7 days); an out-of-range value throws. Default 900. */
347
234
  expiresInSeconds?: number;
348
235
  /** Object key (path-style; not URL-encoded by the caller). */
349
236
  key: string;
@@ -353,25 +240,28 @@ interface PresignedUrlParams {
353
240
  now?: () => number;
354
241
  }
355
242
  /**
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
- */
243
+ * Build a native S3 presigned URL for an R2 object using SigV4 query-string
244
+ * auth. The returned URL points at R2's S3 endpoint and carries the full
245
+ * signature, so it authorizes a single `GET`/`PUT` on `key` until it expires —
246
+ * no Worker round-trip.
247
+ */
361
248
  declare const buildPresignedUrl: (parameters: PresignedUrlParams) => Promise<string>;
362
249
  /**
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
- */
250
+ * Worker-signed URL: the `publicBaseUrl` joined to the object `key`, plus a query
251
+ * string carrying `exp` (unix seconds), `method` (`GET` or `PUT`) and `sig`
252
+ * (a base64url HMAC).
253
+ *
254
+ * The HMAC canonical includes the URL host so a signature minted for one bucket
255
+ * cannot be replayed against another host on the same signing secret. Even so,
256
+ * the signing secret MUST NOT be shared across buckets/tenants — host binding
257
+ * narrows replay surface but is not a substitute for per-tenant key isolation.
258
+ *
259
+ * The Worker route handling the signed download/upload (mounted at
260
+ * `publicBaseUrl`'s origin, e.g. `GET /:key`) should call
261
+ * {@link verifySignedUrl} to validate the signature + expiry before streaming
262
+ * the R2 body. `baseUrl` must be a bare origin (no path) — see the module
263
+ * docstring.
264
+ */
375
265
  declare const buildSignedUrl: (args: SignedUrlOptions & {
376
266
  baseUrl: string;
377
267
  key: string;
@@ -383,24 +273,24 @@ interface VerifyResult {
383
273
  key?: string;
384
274
  method?: "GET" | "PUT";
385
275
  /**
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
- */
276
+ * Internal-only failure reason for server logs/diagnostics. **Do not echo
277
+ * to clients** — a precise reason ("expired" vs "bad_signature") is a
278
+ * signing oracle. Public responses should expose only `valid`.
279
+ */
390
280
  reason?: "bad_signature" | "expired" | "malformed";
391
281
  valid: boolean;
392
282
  }
393
283
  /**
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
- */
284
+ * Verify a {@link buildSignedUrl} output. By default the signature is
285
+ * canonicalized against the inbound `url.host`, which matches the build-side
286
+ * host whenever the URL being verified is the URL that was minted. In a
287
+ * topology where the host the Worker sees differs from the configured
288
+ * `publicBaseUrl` host (e.g. a CDN host vs a Worker route that rewrites
289
+ * `Host`), pass `expectedHost` (the `publicBaseUrl` host) so verification
290
+ * canonicalizes against the same host the signature was minted for instead of
291
+ * failing every request as `bad_signature`.
292
+ */
403
293
  declare const verifySignedUrl: (input: string | URL, secret: string, options?: {
404
294
  expectedHost?: string;
405
295
  }) => 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 };
296
+ 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 };