@platformatic/sqlite-js-stream-s3 0.2.1 → 0.4.0

package/dist/util.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Helpers shared by the S3 replica client and leaser: body reading and the
+ * classification of S3 errors (404, 412, 409).
+ */
+/** Reads all bytes from an S3 body (stream or Buffer). */
+export declare function readBody(body: any): Promise<Uint8Array>;
+export declare function isPreconditionFailed(err: unknown): boolean;
+export declare function isNotFound(err: unknown): boolean;
+/**
+ * A concurrent conditional write to the same key (`409 ConditionalRequestConflict`).
+ * S3 asks the caller to retry the request.
+ */
+export declare function isConditionalConflict(err: unknown): boolean;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,0DAA0D;AAC1D,wBAAsB,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,CAuC7D;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAI1D;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAIhD;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAI3D"}

package/dist/util.js

@@ -0,0 +1,68 @@
+/**
+ * Helpers shared by the S3 replica client and leaser: body reading and the
+ * classification of S3 errors (404, 412, 409).
+ */
+/** Reads all bytes from an S3 body (stream or Buffer). */
+export async function readBody(body) {
+    // AWS SDK v3 returns a mix; normalize to a Uint8Array.
+    if (body instanceof Uint8Array)
+        return body;
+    if (typeof body?.on === 'function') {
+        // Node stream.
+        const chunks = [];
+        for await (const chunk of body) {
+            chunks.push(typeof chunk === 'string' ? new TextEncoder().encode(chunk) : chunk);
+        }
+        let total = 0;
+        for (const c of chunks)
+            total += c.length;
+        const out = new Uint8Array(total);
+        let o = 0;
+        for (const c of chunks) {
+            out.set(c, o);
+            o += c.length;
+        }
+        return out;
+    }
+    // Web ReadableStream or Buffer.
+    if (typeof body?.getReader === 'function') {
+        const reader = body.getReader();
+        const chunks = [];
+        for (;;) {
+            const { done, value } = await reader.read();
+            if (done)
+                break;
+            chunks.push(value);
+        }
+        let total = 0;
+        for (const c of chunks)
+            total += c.length;
+        const out = new Uint8Array(total);
+        let o = 0;
+        for (const c of chunks) {
+            out.set(c, o);
+            o += c.length;
+        }
+        return out;
+    }
+    return new Uint8Array(body);
+}
+export function isPreconditionFailed(err) {
+    const code = err?.$metadata?.httpStatusCode;
+    const name = err?.name ?? '';
+    return code === 412 || name === 'PreconditionFailed';
+}
+export function isNotFound(err) {
+    const code = err?.$metadata?.httpStatusCode;
+    const name = err?.name ?? '';
+    return code === 404 || name === 'NoSuchKey' || name === 'NotFound';
+}
+/**
+ * A concurrent conditional write to the same key (`409 ConditionalRequestConflict`).
+ * S3 asks the caller to retry the request.
+ */
+export function isConditionalConflict(err) {
+    const code = err?.$metadata?.httpStatusCode;
+    const name = err?.name ?? '';
+    return code === 409 || name === 'ConditionalRequestConflict';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sqlite-js-stream-s3",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Amazon S3 upload strategy (replica client) for @platformatic/sqlite-js-stream",
   "type": "module",
   "engines": {
@@ -37,10 +37,10 @@
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.1135.0",
-    "@platformatic/sqlite-js-stream": "0.2.1"
+    "@platformatic/sqlite-js-stream": "0.4.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.0",
+    "@types/node": "^26.0.0",
     "typescript": "^5.7.0"
   },
   "scripts": {

package/src/index.ts

@@ -9,8 +9,14 @@
 export {
   S3ReplicaClient,
   newReplicaClientFromURL,
+  isFenced,
+  GenerationMetadataKey,
+  GenerationObjectName,
   ReplicaClientType,
+  type GenerationFence,
+  type GenerationState,
   type S3ClientLike,
+  type S3DeletePrefixOptions,
   type S3ReplicaClientOptions,
 } from './replica-client.ts';
 

package/src/leaser.ts

@@ -22,60 +22,7 @@ import {
 } from '@platformatic/sqlite-js-stream';
 
 import type { S3ClientLike } from './replica-client.ts';
-
-/** Reads all bytes from an S3 body (stream or Buffer). */
-async function readBody(body: any): Promise<Uint8Array> {
-  // AWS SDK v3 returns a mix; normalize to a Uint8Array.
-  if (body instanceof Uint8Array) return body;
-  if (typeof body?.on === 'function') {
-    // Node stream.
-    const chunks: Uint8Array[] = [];
-    for await (const chunk of body as AsyncIterable<Uint8Array | string>) {
-      chunks.push(typeof chunk === 'string' ? new TextEncoder().encode(chunk) : chunk);
-    }
-    let total = 0;
-    for (const c of chunks) total += c.length;
-    const out = new Uint8Array(total);
-    let o = 0;
-    for (const c of chunks) {
-      out.set(c, o);
-      o += c.length;
-    }
-    return out;
-  }
-  // Web ReadableStream or Buffer.
-  if (typeof body?.getReader === 'function') {
-    const reader = (body as ReadableStream<Uint8Array>).getReader();
-    const chunks: Uint8Array[] = [];
-    for (;;) {
-      const { done, value } = await reader.read();
-      if (done) break;
-      chunks.push(value);
-    }
-    let total = 0;
-    for (const c of chunks) total += c.length;
-    const out = new Uint8Array(total);
-    let o = 0;
-    for (const c of chunks) {
-      out.set(c, o);
-      o += c.length;
-    }
-    return out;
-  }
-  return new Uint8Array(body as Uint8Array);
-}
-
-function isPreconditionFailed(err: unknown): boolean {
-  const code = (err as { $metadata?: { httpStatusCode?: number } })?.$metadata?.httpStatusCode;
-  const name = (err as { name?: string })?.name ?? '';
-  return code === 412 || name === 'PreconditionFailed';
-}
-
-function isNotFound(err: unknown): boolean {
-  const code = (err as { $metadata?: { httpStatusCode?: number } })?.$metadata?.httpStatusCode;
-  const name = (err as { name?: string })?.name ?? '';
-  return code === 404 || name === 'NoSuchKey' || name === 'NotFound';
-}
+import { isNotFound, isPreconditionFailed, readBody } from './util.ts';
 
 /** S3Leaser acquires/renews/releases a lease object in an S3 bucket. */
 export class S3Leaser implements Leaser {