@aws-blocks/bb-file-bucket 0.1.0

package/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

package/README.md

@@ -0,0 +1,197 @@
+# FileBucket
+
+File storage backed by Amazon S3.
+
+**When to use:** You need to store, retrieve, or serve binary files — user uploads, generated reports, images, videos, or static assets.
+
+**When NOT to use:** If you need structured key-value data with conditional writes, use `KVStore`. If you need queryable records with indexes, use `DistributedTable`.
+
+## API
+
+```typescript
+const bucket = new FileBucket(scope, id, options?)
+```
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `put(path, body, options?)` | `Promise<void>` | Upload a file. Overwrites any existing file at the path. |
+| `get(path, options?)` | `Promise<FileContent \| null>` | Download a file. Returns `null` if absent. Pass `{ versionId }` on versioned buckets. |
+| `delete(path, options?)` | `Promise<void>` | Delete a file. No-op if absent. Pass `{ versionId }` on versioned buckets to permanently delete a version. |
+| `deleteBatch(paths)` | `Promise<void>` | Delete multiple files. Chunks internally at 1,000 keys. |
+| `getUrl(path, options?)` | `Promise<string>` | Generate a presigned download URL. Accepts `versionId` on versioned buckets. |
+| `putUrl(path, options?)` | `Promise<string>` | Generate a presigned upload URL. |
+| `getFileHandle(path, options?)` | `Promise<FileDownloadClient>` | Get a download handle for browser-side use. Accepts `versionId` on versioned buckets. |
+| `createUploadHandle(path, options?)` | `Promise<FileUploadClient>` | Get an upload handle for browser-side use. |
+| `scan(options?)` | `AsyncIterable<FileInfo>` | List files. Use `prefix` to scope. |
+| `listVersions(path)` | `Promise<FileVersionInfo[]>` | List all versions of a file (versioned buckets only). Newest first. |
+| `restoreVersion(path, versionId)` | `Promise<void>` | Restore a previous version as the current version. |
+| `FileBucket.fromExisting(bucketName)` | `ExternalBucketRef` | Wrap a pre-existing S3 bucket. |
+
+### Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `versioned` | `boolean` | Enable S3 object versioning. Default: `false`. |
+| `corsRules` | `CorsRule[]` | CORS rules for browser-based access. |
+| `lifecycleRules` | `LifecycleRule[]` | Lifecycle rules for automatic expiration or storage class transitions. |
+| `bucket` | `ExternalBucketRef` | Wrap an existing S3 bucket instead of creating one. |
+
+### PutOptions
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `contentType` | `string` | MIME type (e.g., `image/png`). Default: `application/octet-stream`. |
+| `metadata` | `Record<string, string>` | Custom metadata key-value pairs. |
+| `cacheControl` | `string` | Cache-Control header value. |
+
+### Error Handling
+
+`get()` returns `null` for a missing file — it does **not** throw `FileNotFound`. Check for null:
+
+```typescript
+const file = await bucket.get('missing.txt');
+if (!file) {
+  // file does not exist
+}
+```
+
+`FileBucketErrors` are thrown by other operations and matched with `isBlocksError`:
+
+| Constant | `error.name` | Thrown when |
+|----------|--------------|-------------|
+| `FileBucketErrors.FileNotFound` | `NoSuchKey` | Surfaced by presigned-URL 404s etc. **Not** thrown by `get()`, which returns `null`. |
+| `FileBucketErrors.FileTooLarge` | `EntityTooLarge` | File exceeds size limits. |
+
+```typescript
+import { isBlocksError } from '@aws-blocks/core';
+import { FileBucketErrors } from '@aws-blocks/bb-file-bucket';
+
+try {
+  await bucket.restoreVersion('report.pdf', 'non-existent-version');
+} catch (e: unknown) {
+  if (isBlocksError(e, FileBucketErrors.FileNotFound)) {
+    // source version does not exist
+  }
+  throw e;
+}
+```
+
+## Examples
+
+### Basic Put/Get
+
+```typescript
+const bucket = new FileBucket(scope, 'uploads');
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async uploadFile(name: string, content: string) {
+    await bucket.put(name, content, { contentType: 'text/plain' });
+  },
+  async getFile(name: string) {
+    const file = await bucket.get(name);
+    if (!file) return null;
+    return { contentType: file.contentType, size: file.size };
+  },
+}));
+```
+
+### Presigned Upload URL
+
+```typescript
+const bucket = new FileBucket(scope, 'media');
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async getUploadUrl(path: string) {
+    const url = await bucket.putUrl(path, {
+      expiresIn: 600,
+      contentType: 'image/jpeg',
+    });
+    return { uploadUrl: url };
+  },
+}));
+```
+
+### Listing Files with Scan
+
+```typescript
+const bucket = new FileBucket(scope, 'reports');
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async listReports(yearMonth: string) {
+    const files: FileInfo[] = [];
+    for await (const file of bucket.scan({ prefix: `reports/${yearMonth}/` })) {
+      files.push(file);
+    }
+    return files;
+  },
+}));
+```
+
+### Batch Delete
+
+```typescript
+const bucket = new FileBucket(scope, 'tmp');
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async cleanupTemp(paths: string[]) {
+    await bucket.deleteBatch(paths);
+  },
+}));
+```
+
+### Wrapping an Existing Bucket
+
+```typescript
+const bucket = new FileBucket(scope, 'legacy', {
+  bucket: FileBucket.fromExisting('my-existing-bucket'),
+});
+```
+
+### Versioned Bucket
+
+```typescript
+const bucket = new FileBucket(scope, 'docs', { versioned: true });
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async upload(name: string, content: string) {
+    await bucket.put(name, content);
+  },
+  async getVersion(name: string, versionId?: string) {
+    return await bucket.get(name, versionId ? { versionId } : undefined);
+  },
+  async listVersions(name: string) {
+    return await bucket.listVersions(name);
+  },
+  async restore(name: string, versionId: string) {
+    await bucket.restoreVersion(name, versionId);
+  },
+}));
+```
+
+## Best Practices
+
+- Use path prefixes to organize files (e.g., `uploads/{userId}/`, `reports/`). If a segment can contain URL-shaped or special characters (e.g. an OIDC `userId` of `${iss}:${sub}` like `https://issuer:sub`), wrap it in `encodeURIComponent()` first — the local mock normalizes `//` in keys via the filesystem, so an un-encoded `//` makes `scan({ prefix })` miss the file locally even though it works against S3.
+- Set `contentType` on `put()` to ensure correct MIME handling on download
+- Use presigned URLs (`getUrl` / `putUrl`) for direct browser upload/download
+- Prefer `scan({ prefix })` over unscoped `scan()` to limit enumeration cost
+- For browser uploads/downloads returned from API methods, prefer `createUploadHandle`/`getFileHandle` over raw presigned URLs — they encode the fetch protocol into typed methods so the client can't misuse them
+- Use `deleteBatch()` instead of looping `delete()` for bulk operations
+
+## Scaling & Cost (AWS)
+
+- **Billing:** Per-request plus storage — no provisioned throughput
+- **Latency:** First-byte latency typically 100–200 ms
+- **Throughput:** Scales automatically, 5,500 GET and 3,500 PUT requests/second per prefix
+- **Object size limit:** 5 TB per object
+- **Cost:** ~$0.005 per 1,000 PUT requests, ~$0.0004 per 1,000 GET requests, ~$0.023/GB/month storage
+- **Durability:** 99.999999999% (11 nines) across 3+ AZs
+
+## Local Development
+
+Mock data persists to disk at `.bb-data/{fullId}/` across dev server restarts. Internal data is segregated into sibling roots so it never collides with your keys: file bodies live under `content/`, metadata under `meta/`, and version history under `versions/`. Wipe with `rm -rf .bb-data`. Presigned URLs are served by the dev server at `/.bb-file-bucket/{fullId}/{path}?token=...`. Versioning is fully supported locally. Lifecycle rules and CORS have no effect locally.
+
+
+
+## See Also
+
+- [DESIGN.md](./DESIGN.md) — Infrastructure details, mock parity gaps, and interface decisions

package/dist/bucket-name.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Validate an auto-derived S3 bucket name. Throws a `ValidationFailed` error
+ * with an actionable message when the name violates an S3 naming rule.
+ *
+ * @param name - The bucket name (the scope's `fullId`).
+ * @throws {Error} With name `ValidationFailed` if the name is invalid.
+ */
+export declare function validateBucketName(name: string): void;
+//# sourceMappingURL=bucket-name.d.ts.map

package/dist/bucket-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bucket-name.d.ts","sourceRoot":"","sources":["../src/bucket-name.ts"],"names":[],"mappings":"AAiCA;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CA0CrD"}

package/dist/bucket-name.js

@@ -0,0 +1,62 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * S3 bucket-name validation, shared by the CDK (synth) and mock (local dev)
+ * entry points so a name that would be rejected by CloudFormation fails the
+ * same way during `bb dev` — long before a deploy is attempted.
+ *
+ * Bucket names are derived from the scope chain (`scope.fullId`). Because S3
+ * bucket names are globally unique and immutable, we deliberately error rather
+ * than silently truncate/hash: a truncated name could collide, and a name that
+ * shifts between deploys would orphan or replace the customer's data. The fix
+ * belongs in the developer's hands — shorten a scope id once and the name is
+ * stable forever.
+ *
+ * Rules enforced (AWS general-purpose bucket naming):
+ * - 3–63 characters
+ * - lowercase letters, numbers, dots (`.`), and hyphens (`-`) only
+ * - must begin and end with a letter or number
+ * - must not contain two adjacent dots
+ *
+ * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
+ */
+const MIN_LEN = 3;
+const MAX_LEN = 63;
+function blocksError(name, message) {
+    const err = new Error(`${name}: ${message}`);
+    err.name = name;
+    return err;
+}
+/**
+ * Validate an auto-derived S3 bucket name. Throws a `ValidationFailed` error
+ * with an actionable message when the name violates an S3 naming rule.
+ *
+ * @param name - The bucket name (the scope's `fullId`).
+ * @throws {Error} With name `ValidationFailed` if the name is invalid.
+ */
+export function validateBucketName(name) {
+    const hint = `FileBucket names are derived from the scope chain (id of the bucket ` +
+        `plus its parent scopes, joined with "-"). Shorten the FileBucket id ` +
+        `or a parent scope id, or pass an existing bucket via ` +
+        `FileBucket.fromExisting(...).`;
+    if (name.length > MAX_LEN) {
+        throw blocksError('ValidationFailed', `Derived bucket name "${name}" is ${name.length} characters, ` +
+            `exceeding S3's ${MAX_LEN}-character limit. ${hint}`);
+    }
+    if (name.length < MIN_LEN) {
+        throw blocksError('ValidationFailed', `Derived bucket name "${name}" is ${name.length} characters; ` +
+            `S3 requires at least ${MIN_LEN}. ${hint}`);
+    }
+    if (!/^[a-z0-9.-]+$/.test(name)) {
+        throw blocksError('ValidationFailed', `Derived bucket name "${name}" contains characters that are invalid ` +
+            `for an S3 bucket. Use only lowercase letters, numbers, dots (.), ` +
+            `and hyphens (-). ${hint}`);
+    }
+    if (!/^[a-z0-9]/.test(name) || !/[a-z0-9]$/.test(name)) {
+        throw blocksError('ValidationFailed', `Derived bucket name "${name}" must begin and end with a lowercase ` +
+            `letter or number. ${hint}`);
+    }
+    if (name.includes('..')) {
+        throw blocksError('ValidationFailed', `Derived bucket name "${name}" must not contain two adjacent dots. ${hint}`);
+    }
+}

package/dist/bucket-name.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=bucket-name.test.d.ts.map

package/dist/bucket-name.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bucket-name.test.d.ts","sourceRoot":"","sources":["../src/bucket-name.test.ts"],"names":[],"mappings":""}

package/dist/bucket-name.test.js

@@ -0,0 +1,61 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Tests for the shared S3 bucket-name validator and its enforcement in the
+ * mock entry point. The CDK side is covered in index.cdk.test.ts; this file
+ * pins the validator rules and the local-dev (mock) parity behavior.
+ */
+import { test } from 'node:test';
+import assert from 'node:assert';
+import { Scope, isBlocksError } from '@aws-blocks/core';
+import { validateBucketName } from './bucket-name.js';
+import { FileBucket } from './index.mock.js';
+// ── Validator unit tests ─────────────────────────────────────────────────────
+test('accepts a valid lowercase hyphenated name', () => {
+    assert.doesNotThrow(() => validateBucketName('myapp-uploads'));
+});
+test('accepts a name at exactly 63 characters', () => {
+    const name = 'a'.repeat(63);
+    assert.doesNotThrow(() => validateBucketName(name));
+});
+test('rejects a name over 63 characters with an actionable message', () => {
+    const name = 'a'.repeat(64);
+    assert.throws(() => validateBucketName(name), (err) => isBlocksError(err, 'ValidationFailed') &&
+        /64 characters/.test(err.message) &&
+        /63-character limit/.test(err.message) &&
+        /Shorten/.test(err.message));
+});
+test('rejects a name under 3 characters', () => {
+    assert.throws(() => validateBucketName('ab'), (err) => isBlocksError(err, 'ValidationFailed') && /at least 3/.test(err.message));
+});
+test('rejects uppercase characters', () => {
+    assert.throws(() => validateBucketName('MyApp-Uploads'), (err) => isBlocksError(err, 'ValidationFailed') && /lowercase/.test(err.message));
+});
+test('rejects underscores', () => {
+    assert.throws(() => validateBucketName('my_app_uploads'), (err) => isBlocksError(err, 'ValidationFailed'));
+});
+test('rejects a name not starting with a letter or number', () => {
+    assert.throws(() => validateBucketName('-myapp'), (err) => isBlocksError(err, 'ValidationFailed') && /begin and end/.test(err.message));
+});
+test('rejects a name not ending with a letter or number', () => {
+    assert.throws(() => validateBucketName('myapp-'), (err) => isBlocksError(err, 'ValidationFailed') && /begin and end/.test(err.message));
+});
+test('rejects adjacent dots', () => {
+    assert.throws(() => validateBucketName('my..app'), (err) => isBlocksError(err, 'ValidationFailed') && /adjacent dots/.test(err.message));
+});
+// ── Mock parity: construction enforces the same rules ────────────────────────
+test('mock: constructing a FileBucket with a too-long derived name throws', () => {
+    // Parent id + child id joined with "-" must exceed 63 chars.
+    const longParent = new Scope('p'.repeat(60));
+    assert.throws(() => new FileBucket(longParent, 'uploads'), (err) => isBlocksError(err, 'ValidationFailed') && /63-character limit/.test(err.message));
+});
+test('mock: constructing a FileBucket with a valid derived name succeeds', () => {
+    const parent = new Scope('shortapp');
+    assert.doesNotThrow(() => new FileBucket(parent, 'uploads'));
+});
+test('mock: fromExisting bypasses derived-name validation', () => {
+    // An over-long scope chain would normally fail, but fromExisting wraps an
+    // externally-named bucket so the derived name is not used.
+    const longParent = new Scope('p'.repeat(60));
+    assert.doesNotThrow(() => new FileBucket(longParent, 'uploads', { bucket: FileBucket.fromExisting('preexisting-bucket-123') }));
+});

package/dist/errors.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Typed error constants for FileBucket. Use with `isBlocksError()` in catch blocks.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const file = await bucket.get('missing.txt');
+ * } catch (e: unknown) {
+ *   if (isBlocksError(e, FileBucketErrors.FileNotFound)) {
+ *     // file does not exist
+ *   }
+ *   throw e;
+ * }
+ * ```
+ */
+export declare const FileBucketErrors: {
+    readonly FileNotFound: "NoSuchKey";
+    readonly FileTooLarge: "EntityTooLarge";
+};
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB;;;CAGnB,CAAC"}

package/dist/errors.js

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Typed error constants for FileBucket. Use with `isBlocksError()` in catch blocks.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const file = await bucket.get('missing.txt');
+ * } catch (e: unknown) {
+ *   if (isBlocksError(e, FileBucketErrors.FileNotFound)) {
+ *     // file does not exist
+ *   }
+ *   throw e;
+ * }
+ * ```
+ */
+export const FileBucketErrors = {
+    FileNotFound: 'NoSuchKey',
+    FileTooLarge: 'EntityTooLarge',
+};

package/dist/file-server.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Dev server attachment for FileBucket.
+ * Serves token-gated GET/PUT requests at /.bb-file-bucket/{fullId}/{path}?token=...
+ * Mirrors S3 presigned URL behavior: method-scoped, time-limited, path-specific.
+ *
+ * Storage layout mirrors `index.mock.ts` via the shared `paths.ts` helpers, so
+ * user content (under `content/`) is never confused with internal metadata or
+ * version bookkeeping. PUT always delegates to the registered FileBucket
+ * instance so uploads get versioning, key validation, and metadata handling —
+ * there is no direct-write fallback.
+ */
+import type { Server } from 'node:http';
+export declare function attach(httpServer: Server): void;
+//# sourceMappingURL=file-server.d.ts.map

package/dist/file-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-server.d.ts","sourceRoot":"","sources":["../src/file-server.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAmC,MAAM,WAAW,CAAC;AAyCzE,wBAAgB,MAAM,CAAC,UAAU,EAAE,MAAM,QAkJxC"}