@michaelthielemann/kestrel-blobstore-s3 5.2.0 → 5.4.0

package/README.md

@@ -19,3 +19,21 @@ is missing. Once the SDK's own `maxAttempts` are spent, `put`/`get`/`remove`/`mo
 `TimeoutError`/`NetworkingError`/`AbortError`, or a Node `code` of
 `ECONNRESET`/`ECONNREFUSED`/`ETIMEDOUT`/`EPIPE`/`EAI_AGAIN`. Everything else (an invalid key,
 `AccessDenied`, a misconfigured bucket) throws — it is a wiring bug, not an expected failure.
+
+<!-- kestrel-docs:start -->
+## Generated from the manifest
+`@michaelthielemann/kestrel-blobstore-s3` – module `blobstore/s3`: provides `blobstore@1`.
+
+| Config | Type | Required | Default |
+|---|---|---|---|
+| `bucket` | string | yes | – |
+| `prefix` | string | no | `""` |
+| `region` | string | no | – |
+| `endpoint` | string | no | – |
+| `forcePathStyle` | boolean | no | – |
+| `accessKeyId` | string | no | *(secret)* |
+| `secretAccessKey` | string | no | *(secret)* |
+| `timeoutMs` | integer | no | `10000` |
+| `maxAttempts` | integer | no | `3` |
+
+<!-- kestrel-docs:end -->

package/dist/impl.js

@@ -1,4 +1,5 @@
 import { CopyObjectCommand, DeleteObjectCommand, GetObjectCommand, ListObjectsV2Command, NoSuchKey, PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+import { boundaryCast } from "@michaelthielemann/kestrel/cast";
 import { failure } from "@michaelthielemann/kestrel/errors";
 import { err, ok } from "@michaelthielemann/kestrel/result";
 export const DEFAULT_TIMEOUT_MS = 10000;
@@ -27,7 +28,7 @@ const TRANSIENT_NAMES = new Set(["TimeoutError", "NetworkingError", "AbortError"
 const TRANSIENT_CODES = new Set(["ECONNRESET", "ECONNREFUSED", "ETIMEDOUT", "EPIPE", "EAI_AGAIN"]);
 /** After the SDK's own `maxAttempts` are spent, this is the only line separating "retry the caller" from "the operation is broken". */
 function isTransient(cause) {
-    const e = cause;
+    const e = boundaryCast(cause, "host");
     const status = e.$metadata?.httpStatusCode;
     if (status !== undefined && (status >= 500 || status === 429))
         return true;
@@ -63,13 +64,13 @@ export function createBlobstoreS3(config, client = createClient(config)) {
         },
         async get(key) {
             try {
-                const out = (await client.send(new GetObjectCommand({ Bucket: config.bucket, Key: fullKey(key) })));
+                const out = boundaryCast(await client.send(new GetObjectCommand({ Bucket: config.bucket, Key: fullKey(key) })), "host");
                 if (!out.Body)
                     return ok(null);
                 return ok(await out.Body.transformToByteArray());
             }
             catch (cause) {
-                if (cause instanceof NoSuchKey || cause.name === "NoSuchKey")
+                if (cause instanceof NoSuchKey || boundaryCast(cause, "host").name === "NoSuchKey")
                     return ok(null);
                 if (isTransient(cause))
                     return err(failure("TRANSIENT", `blobstore/s3: get ${JSON.stringify(key)} failed`, { cause }));
@@ -95,7 +96,7 @@ export function createBlobstoreS3(config, client = createClient(config)) {
                 await client.send(new CopyObjectCommand({ Bucket: config.bucket, Key: fullKey(to), CopySource: copySource, MetadataDirective: "COPY" }));
             }
             catch (cause) {
-                const info = cause;
+                const info = boundaryCast(cause, "host");
                 if (info.name === "NoSuchKey" || info.$metadata?.httpStatusCode === 404)
                     return err(failure("NOT_FOUND", `blobstore/s3: ${JSON.stringify(from)} not found`, { cause }));
                 if (isTransient(cause))
@@ -117,7 +118,7 @@ export function createBlobstoreS3(config, client = createClient(config)) {
             let token;
             try {
                 do {
-                    const page = (await client.send(new ListObjectsV2Command({ Bucket: config.bucket, Prefix: config.prefix + prefix, ContinuationToken: token })));
+                    const page = boundaryCast(await client.send(new ListObjectsV2Command({ Bucket: config.bucket, Prefix: config.prefix + prefix, ContinuationToken: token })), "host");
                     for (const item of page.Contents ?? []) {
                         if (item.Key === undefined)
                             continue;

package/dist/module.js

@@ -9,8 +9,8 @@ export const configSchema = z
     region: z.string().min(1).optional(),
     endpoint: z.string().url().optional(),
     forcePathStyle: z.boolean().optional(),
-    accessKeyId: z.string().min(1).optional(),
-    secretAccessKey: z.string().min(1).optional(),
+    accessKeyId: z.string().min(1).describe("secret").optional(),
+    secretAccessKey: z.string().min(1).describe("secret").optional(),
     timeoutMs: z.number().int().positive().default(DEFAULT_TIMEOUT_MS),
     maxAttempts: z.number().int().min(1).default(DEFAULT_MAX_ATTEMPTS),
 })