@ddd-ts-kit/s3 0.0.0 → 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gary Bourgeat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,81 @@
-Placeholder of @ddd-ts-kit/s3. See https://github.com/gbourgeat/ddd-ts-kit.
+# @ddd-ts-kit/s3
+
+The kernel `FileStorage` on any provider of the S3 protocol: AWS S3, MinIO, OVHcloud Object
+Storage, Scaleway, Cloudflare R2, Garage. The content of a file streams to the bucket in parts,
+never whole in memory and never in the database; the aggregate keeps the `StoredFile` that `put`
+answers. Nothing in `domain/` or `application/` imports this package: handlers depend on the
+`FileStorage` port, and the platform binds this adapter.
+
+```
+npm i @ddd-ts-kit/s3 @aws-sdk/client-s3 @aws-sdk/lib-storage @aws-sdk/s3-request-presigner
+```
+
+The three packages of the official AWS SDK v3 are optional peers, written against 3.1150.
+
+## Composition root
+
+```ts
+import { S3FileStorage, s3ClientOf } from '@ddd-ts-kit/s3';
+
+const files = new S3FileStorage({
+  client: s3ClientOf({
+    endpoint: config.storage.endpoint, // left out for AWS; http://localhost:9000 for MinIO
+    region: config.storage.region, // 'auto' for R2
+    accessKeyId: config.storage.accessKeyId,
+    secretAccessKey: config.storage.secretAccessKey,
+  }),
+  bucket: config.storage.bucket, // created by the infrastructure code, never by the application
+  prefix: 'scheduling/', // optional: several applications in one bucket
+});
+```
+
+`s3ClientOf` sets path-style addressing when an endpoint is given (MinIO and most self-hosted
+servers need it) and computes checksums only when an operation requires one: the default of the
+SDK sends a checksum with every request, which several providers that are not AWS refuse, and
+which would bind a signed upload link to an empty body. A client built by hand works too.
+
+## What it does
+
+| Port method | On the bucket |
+|---|---|
+| `put(key, stream, { mediaType, maxBytes })` | a multipart upload of `partSize` parts (8 MiB by default, one in memory at a time); the content is counted and hashed on its way, and refused with `FILE_TOO_LARGE` beyond `maxBytes`, which aborts the upload and leaves the previous object |
+| `get`, `stat` | `GetObject` as a stream, `HeadObject`; `undefined` when the object does not exist, a rejection when the service cannot be reached |
+| `delete` | `DeleteObject`, idempotent |
+| `copy`, `move` | `CopyObject` done by the service (and `DeleteObject` for a move), up to 5 GiB per object |
+| `list(prefix)` | `ListObjectsV2`, page after page |
+| `signedDownloadUrl` | a presigned `GetObject` answered with `Content-Disposition: attachment`, with the file name when one is given |
+| `signedUploadUrl` | a presigned `PutObject` whose signature covers the `content-type`: another media type is refused by the service |
+
+The checksum (`sha256:<hex>`) is answered by `put`, computed while the content streams; the
+bucket does not keep it, so `stat` does not answer one. A file uploaded through a signed link
+is measured, checked and hashed by `FileStaging.confirm` of the kernel, which reads it back.
+
+## Limits
+
+- A signed upload link cannot cap the size of what is sent (only a presigned POST policy can):
+  its `maxBytes` is not enforced by the service, and `FileStaging.confirm` measures the file
+  against the cap of the grant the server kept and discards it beyond.
+- Copy and move go through `CopyObject`, limited to 5 GiB per object by the protocol.
+- Lifecycle rules, versioning, object lock and the encryption of the bucket are settings of the
+  bucket, made by the infrastructure code of the deployment, not by this adapter.
+
+## Tests
+
+The contract of the port is held against a real server: `fileStorageContract` of
+`@ddd-ts-kit/testing/contracts` (re-exported by `@ddd-ts-kit/s3/testing`) runs on MinIO in the
+integration job of the pipeline, with `DDD_TS_KIT_TEST_S3_ENDPOINT` set; without it the specs
+that need a server are skipped. The upstream MinIO project stopped publishing images in 2025:
+the pipeline runs `pgsty/minio`, built from the same sources, pinned by digest
+(`pipeline/github/scripts/start-minio.sh`).
+
+```
+docker run -d --name minio -p 127.0.0.1:9000:9000 -e MINIO_ROOT_USER=ddd-ts-kit -e MINIO_ROOT_PASSWORD=ddd-ts-kit-secret pgsty/minio:RELEASE.2026-08-04T00-00-00Z server /data
+DDD_TS_KIT_TEST_S3_ENDPOINT=http://localhost:9000 npx vitest run packages/s3
+```
+
+## Another provider
+
+Google Cloud Storage and Azure Blob Storage speak their own protocols. A connector for one of
+them is a class extending `FileStorage` of the kernel that passes `fileStorageContract` against
+the real service or its emulator (fake-gcs-server, Azurite): see
+[docs/tools/file-storage.md](../../docs/tools/file-storage.md).

package/dist/bucket-keys.d.ts

@@ -0,0 +1,11 @@
+/** Turns the keys of the port into the keys of the bucket and back, under the prefix of the connector. */
+export declare class BucketKeys {
+    private readonly prefix;
+    constructor(prefix: string);
+    of(key: string): string;
+    /** The prefix of the bucket a listing of the port reads. */
+    under(prefix: string): string;
+    /** The key of the port of an object listed in the bucket. */
+    back(objectKey: string): string;
+}
+//# sourceMappingURL=bucket-keys.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bucket-keys.d.ts","sourceRoot":"","sources":["../src/bucket-keys.ts"],"names":[],"mappings":"AAEA,0GAA0G;AAC1G,qBAAa,UAAU;IACT,OAAO,CAAC,QAAQ,CAAC,MAAM;IAAnC,YAA6B,MAAM,EAAE,MAAM,EAI1C;IAED,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtB;IAED,4DAA4D;IAC5D,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE5B;IAED,6DAA6D;IAC7D,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAE9B;CACF"}

package/dist/bucket-keys.js

@@ -0,0 +1,23 @@
+import { assertFileKey, isFileKey } from '@ddd-ts-kit/kernel';
+/** Turns the keys of the port into the keys of the bucket and back, under the prefix of the connector. */
+export class BucketKeys {
+    prefix;
+    constructor(prefix) {
+        this.prefix = prefix;
+        if (prefix !== '' && !(prefix.endsWith('/') && isFileKey(prefix.slice(0, -1)))) {
+            throw new Error(`The prefix of an S3 file storage is a valid key ending with "/", not "${prefix}".`);
+        }
+    }
+    of(key) {
+        return `${this.prefix}${assertFileKey(key)}`;
+    }
+    /** The prefix of the bucket a listing of the port reads. */
+    under(prefix) {
+        return `${this.prefix}${prefix}`;
+    }
+    /** The key of the port of an object listed in the bucket. */
+    back(objectKey) {
+        return objectKey.slice(this.prefix.length);
+    }
+}
+//# sourceMappingURL=bucket-keys.js.map

package/dist/bucket-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bucket-keys.js","sourceRoot":"","sources":["../src/bucket-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE9D,0GAA0G;AAC1G,MAAM,OAAO,UAAU;IACQ,MAAM;IAAnC,YAA6B,MAAc;sBAAd,MAAM;QACjC,IAAI,MAAM,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yEAAyE,MAAM,IAAI,CAAC,CAAC;QACvG,CAAC;IACH,CAAC;IAED,EAAE,CAAC,GAAW;QACZ,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;IAC/C,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,MAAc;QAClB,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,6DAA6D;IAC7D,IAAI,CAAC,SAAiB;QACpB,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { s3ClientOf } from './s3-client-of.js';
+export { S3FileStorage } from './s3-file-storage.js';
+export type { S3FileStorageOptions } from './s3-file-storage-options.js';
+export type { S3Settings } from './s3-settings.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,YAAY,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACzE,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { s3ClientOf } from './s3-client-of.js';
+export { S3FileStorage } from './s3-file-storage.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/is-missing.d.ts

@@ -0,0 +1,3 @@
+/** Whether the service answered that the object does not exist: `NoSuchKey` on a read, `NotFound` on a head. */
+export declare function isMissing(error: unknown): boolean;
+//# sourceMappingURL=is-missing.d.ts.map

package/dist/is-missing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-missing.d.ts","sourceRoot":"","sources":["../src/is-missing.ts"],"names":[],"mappings":"AAEA,gHAAgH;AAChH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAKjD"}

package/dist/is-missing.js

@@ -0,0 +1,7 @@
+import { S3ServiceException } from '@aws-sdk/client-s3';
+/** Whether the service answered that the object does not exist: `NoSuchKey` on a read, `NotFound` on a head. */
+export function isMissing(error) {
+    return (error instanceof S3ServiceException &&
+        (error.name === 'NoSuchKey' || error.name === 'NotFound' || error.$metadata.httpStatusCode === 404));
+}
+//# sourceMappingURL=is-missing.js.map

package/dist/is-missing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-missing.js","sourceRoot":"","sources":["../src/is-missing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,gHAAgH;AAChH,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,CACL,KAAK,YAAY,kBAAkB;QACnC,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,SAAS,CAAC,cAAc,KAAK,GAAG,CAAC,CACpG,CAAC;AACJ,CAAC"}

package/dist/list-objects.d.ts

@@ -0,0 +1,5 @@
+import { type S3Client } from '@aws-sdk/client-s3';
+import type { ListedFile } from '@ddd-ts-kit/kernel';
+/** Every object under the prefix, page after page, with the key of the bucket. */
+export declare function listObjects(client: S3Client, bucket: string, prefix: string): AsyncIterable<ListedFile>;
+//# sourceMappingURL=list-objects.d.ts.map

package/dist/list-objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-objects.d.ts","sourceRoot":"","sources":["../src/list-objects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,kFAAkF;AAClF,wBAAuB,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,CAkB9G"}

package/dist/list-objects.js

@@ -0,0 +1,17 @@
+import { ListObjectsV2Command } from '@aws-sdk/client-s3';
+/** Every object under the prefix, page after page, with the key of the bucket. */
+export async function* listObjects(client, bucket, prefix) {
+    let token;
+    do {
+        const page = await client.send(new ListObjectsV2Command({
+            Bucket: bucket,
+            Prefix: prefix,
+            ...(token === undefined ? {} : { ContinuationToken: token }),
+        }));
+        for (const object of page.Contents ?? []) {
+            yield { key: object.Key ?? '', size: object.Size ?? 0, lastModified: object.LastModified ?? new Date(0) };
+        }
+        token = page.IsTruncated === true ? page.NextContinuationToken : undefined;
+    } while (token !== undefined);
+}
+//# sourceMappingURL=list-objects.js.map

package/dist/list-objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-objects.js","sourceRoot":"","sources":["../src/list-objects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAiB,MAAM,oBAAoB,CAAC;AAGzE,kFAAkF;AAClF,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,WAAW,CAAC,MAAgB,EAAE,MAAc,EAAE,MAAc;IACjF,IAAI,KAAyB,CAAC;IAE9B,GAAG,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAC5B,IAAI,oBAAoB,CAAC;YACvB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,MAAM;YACd,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC;SAC7D,CAAC,CACH,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACzC,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5G,CAAC;QAED,KAAK,GAAG,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,CAAC,QAAQ,KAAK,KAAK,SAAS,EAAE;AAChC,CAAC"}

package/dist/s3-client-of.d.ts

@@ -0,0 +1,9 @@
+import { S3Client } from '@aws-sdk/client-s3';
+import type { S3Settings } from './s3-settings.js';
+/**
+ * A client for any provider of the S3 protocol. Checksums are computed only when an operation
+ * requires one: the default of the SDK (a checksum on every request) is refused by several
+ * providers that are not AWS, and would bind a signed upload link to an empty body.
+ */
+export declare function s3ClientOf(settings: S3Settings): S3Client;
+//# sourceMappingURL=s3-client-of.d.ts.map

package/dist/s3-client-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-client-of.d.ts","sourceRoot":"","sources":["../src/s3-client-of.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,UAAU,GAAG,QAAQ,CAWzD"}

package/dist/s3-client-of.js

@@ -0,0 +1,18 @@
+import { S3Client } from '@aws-sdk/client-s3';
+/**
+ * A client for any provider of the S3 protocol. Checksums are computed only when an operation
+ * requires one: the default of the SDK (a checksum on every request) is refused by several
+ * providers that are not AWS, and would bind a signed upload link to an empty body.
+ */
+export function s3ClientOf(settings) {
+    const { endpoint, region, accessKeyId, secretAccessKey } = settings;
+    return new S3Client({
+        region,
+        credentials: { accessKeyId, secretAccessKey },
+        ...(endpoint === undefined ? {} : { endpoint }),
+        forcePathStyle: settings.forcePathStyle ?? endpoint !== undefined,
+        requestChecksumCalculation: 'WHEN_REQUIRED',
+        responseChecksumValidation: 'WHEN_REQUIRED',
+    });
+}
+//# sourceMappingURL=s3-client-of.js.map

package/dist/s3-client-of.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-client-of.js","sourceRoot":"","sources":["../src/s3-client-of.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG9C;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,QAAoB;IAC7C,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,GAAG,QAAQ,CAAC;IAEpE,OAAO,IAAI,QAAQ,CAAC;QAClB,MAAM;QACN,WAAW,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE;QAC7C,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC/C,cAAc,EAAE,QAAQ,CAAC,cAAc,IAAI,QAAQ,KAAK,SAAS;QACjE,0BAA0B,EAAE,eAAe;QAC3C,0BAA0B,EAAE,eAAe;KAC5C,CAAC,CAAC;AACL,CAAC"}

package/dist/s3-file-storage-options.d.ts

@@ -0,0 +1,15 @@
+import type { S3Client } from '@aws-sdk/client-s3';
+import type { Clock } from '@ddd-ts-kit/kernel';
+export interface S3FileStorageOptions {
+    /** `s3ClientOf(settings)` builds one for AWS, MinIO, OVHcloud, Scaleway or Cloudflare R2. */
+    readonly client: S3Client;
+    /** Created beforehand, by the infrastructure code of the deployment: the connector never creates one. */
+    readonly bucket: string;
+    /** Put before every key, ending with `/`: several applications or test runs then share a bucket. Default: none. */
+    readonly prefix?: string;
+    /** The size of each part of a multipart upload, at least 5 MiB, the most held in memory per upload. Default 8 MiB. */
+    readonly partSize?: number;
+    /** Reads the expiry the signed links answer. Default: the system clock. */
+    readonly clock?: Clock;
+}
+//# sourceMappingURL=s3-file-storage-options.d.ts.map

package/dist/s3-file-storage-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file-storage-options.d.ts","sourceRoot":"","sources":["../src/s3-file-storage-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAEhD,MAAM,WAAW,oBAAoB;IACnC,6FAA6F;IAC7F,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,yGAAyG;IACzG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,mHAAmH;IACnH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;CACxB"}

package/dist/s3-file-storage-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=s3-file-storage-options.js.map

package/dist/s3-file-storage-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file-storage-options.js","sourceRoot":"","sources":["../src/s3-file-storage-options.ts"],"names":[],"mappings":""}

package/dist/s3-file-storage.d.ts

@@ -0,0 +1,29 @@
+import { FileStorage, type DownloadUrlOptions, type FileContent, type FileMetadata, type FileSource, type ListedFile, type PutOptions, type SignedUpload, type SignedUrl, type StoredFile, type UploadUrlOptions } from '@ddd-ts-kit/kernel';
+import type { S3FileStorageOptions } from './s3-file-storage-options.js';
+/**
+ * The `FileStorage` of a deployment: one bucket of any provider of the S3 protocol. An upload
+ * streams in parts of `partSize`, so at most one part is held in memory; a content refused on
+ * its way (`FILE_TOO_LARGE`) aborts the upload and leaves the previous object. The checksum is
+ * computed while the content streams and answered by `put`, not kept by the bucket: `stat` does
+ * not know it. Copy and move are done by the service, up to 5 GiB per object.
+ */
+export declare class S3FileStorage extends FileStorage {
+    private readonly client;
+    private readonly bucket;
+    private readonly keys;
+    private readonly partSize;
+    private readonly clock;
+    constructor(options: S3FileStorageOptions);
+    put(key: string, content: FileSource, options: PutOptions): Promise<StoredFile>;
+    get(key: string): Promise<FileContent | undefined>;
+    stat(key: string): Promise<FileMetadata | undefined>;
+    delete(key: string): Promise<void>;
+    copy(from: string, to: string): Promise<void>;
+    move(from: string, to: string): Promise<void>;
+    list(prefix: string): AsyncIterable<ListedFile>;
+    signedDownloadUrl(key: string, options: DownloadUrlOptions): Promise<SignedUrl>;
+    signedUploadUrl(key: string, options: UploadUrlOptions): Promise<SignedUpload>;
+    private expiry;
+    private missing;
+}
+//# sourceMappingURL=s3-file-storage.d.ts.map

package/dist/s3-file-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file-storage.d.ts","sourceRoot":"","sources":["../src/s3-file-storage.ts"],"names":[],"mappings":"AAYA,OAAO,EAGL,WAAW,EAMX,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,gBAAgB,EACtB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAKzE;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAElC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;IAElC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAE9B,YAAY,OAAO,EAAE,oBAAoB,EAOxC;IAEK,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAgBpF;IAEK,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAavD;IAEK,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAKzD;IAEK,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvC;IAEK,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAOlD;IAEK,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASlD;IAEM,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,CAIrD;IAEK,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC,CAUpF;IAEK,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAOnF;IAED,OAAO,CAAC,MAAM;YAIA,OAAO;CAKtB"}

package/dist/s3-file-storage.js

@@ -0,0 +1,125 @@
+import { Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
+import { CopyObjectCommand, DeleteObjectCommand, GetObjectCommand, HeadObjectCommand, PutObjectCommand, } from '@aws-sdk/client-s3';
+import { Upload } from '@aws-sdk/lib-storage';
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+import { FileError, FileInspection, FileStorage, SystemClock, assertExpiry, contentDisposition, mediaTypeOf, } from '@ddd-ts-kit/kernel';
+import { BucketKeys } from './bucket-keys.js';
+import { isMissing } from './is-missing.js';
+import { listObjects } from './list-objects.js';
+import { settledFirst } from './settled-first.js';
+const MEBIBYTE = 1_024 * 1_024;
+/**
+ * The `FileStorage` of a deployment: one bucket of any provider of the S3 protocol. An upload
+ * streams in parts of `partSize`, so at most one part is held in memory; a content refused on
+ * its way (`FILE_TOO_LARGE`) aborts the upload and leaves the previous object. The checksum is
+ * computed while the content streams and answered by `put`, not kept by the bucket: `stat` does
+ * not know it. Copy and move are done by the service, up to 5 GiB per object.
+ */
+export class S3FileStorage extends FileStorage {
+    client;
+    bucket;
+    keys;
+    partSize;
+    clock;
+    constructor(options) {
+        super();
+        this.client = options.client;
+        this.bucket = options.bucket;
+        this.keys = new BucketKeys(options.prefix ?? '');
+        this.partSize = Math.max(5 * MEBIBYTE, options.partSize ?? 8 * MEBIBYTE);
+        this.clock = options.clock ?? new SystemClock();
+    }
+    async put(key, content, options) {
+        const objectKey = this.keys.of(key);
+        const mediaType = mediaTypeOf(options.mediaType);
+        const inspection = new FileInspection(options.maxBytes === undefined ? {} : { maxBytes: options.maxBytes });
+        const upload = new Upload({
+            client: this.client,
+            params: { Bucket: this.bucket, Key: objectKey, Body: inspection, ContentType: mediaType },
+            partSize: this.partSize,
+            queueSize: 1,
+            leavePartsOnError: false,
+        });
+        await settledFirst(pipeline(content, inspection), upload.done());
+        return { key, size: inspection.size, mediaType, checksum: inspection.checksum };
+    }
+    async get(key) {
+        const command = new GetObjectCommand({ Bucket: this.bucket, Key: this.keys.of(key) });
+        const response = await this.client.send(command).catch(absentAsUndefined);
+        if (response === undefined) {
+            return undefined;
+        }
+        if (!(response.Body instanceof Readable)) {
+            throw new Error('The S3 client answered a body that is not a Node.js stream: use the Node.js build of the SDK.');
+        }
+        return { metadata: metadataOf(key, response), stream: response.Body };
+    }
+    async stat(key) {
+        const command = new HeadObjectCommand({ Bucket: this.bucket, Key: this.keys.of(key) });
+        const response = await this.client.send(command).catch(absentAsUndefined);
+        return response === undefined ? undefined : metadataOf(key, response);
+    }
+    async delete(key) {
+        await this.client.send(new DeleteObjectCommand({ Bucket: this.bucket, Key: this.keys.of(key) }));
+    }
+    async copy(from, to) {
+        const source = `${this.bucket}/${this.keys.of(from)}`;
+        const command = new CopyObjectCommand({ Bucket: this.bucket, Key: this.keys.of(to), CopySource: source });
+        await this.client.send(command).catch((error) => {
+            throw isMissing(error) ? FileError.notFound(from) : error;
+        });
+    }
+    async move(from, to) {
+        if (from === to) {
+            await this.missing(from);
+            return;
+        }
+        await this.copy(from, to);
+        await this.delete(from);
+    }
+    async *list(prefix) {
+        for await (const object of listObjects(this.client, this.bucket, this.keys.under(prefix))) {
+            yield { ...object, key: this.keys.back(object.key) };
+        }
+    }
+    async signedDownloadUrl(key, options) {
+        const expiresIn = assertExpiry(options.expiresInSeconds);
+        const command = new GetObjectCommand({
+            Bucket: this.bucket,
+            Key: this.keys.of(key),
+            ResponseContentDisposition: contentDisposition(options.fileName),
+        });
+        return { url: await getSignedUrl(this.client, command, { expiresIn }), expiresAt: this.expiry(expiresIn) };
+    }
+    async signedUploadUrl(key, options) {
+        const expiresIn = assertExpiry(options.expiresInSeconds);
+        const mediaType = mediaTypeOf(options.mediaType);
+        const command = new PutObjectCommand({ Bucket: this.bucket, Key: this.keys.of(key), ContentType: mediaType });
+        const url = await getSignedUrl(this.client, command, { expiresIn, signableHeaders: new Set(['content-type']) });
+        return { url, method: 'PUT', headers: { 'content-type': mediaType }, expiresAt: this.expiry(expiresIn) };
+    }
+    expiry(seconds) {
+        return new Date(this.clock.now().getTime() + seconds * 1_000);
+    }
+    async missing(key) {
+        if ((await this.stat(key)) === undefined) {
+            throw FileError.notFound(key);
+        }
+    }
+}
+function absentAsUndefined(error) {
+    if (isMissing(error)) {
+        return undefined;
+    }
+    throw error;
+}
+function metadataOf(key, head) {
+    return {
+        key,
+        size: head.ContentLength ?? 0,
+        mediaType: mediaTypeOf(head.ContentType ?? 'application/octet-stream'),
+        lastModified: head.LastModified ?? new Date(0),
+    };
+}
+//# sourceMappingURL=s3-file-storage.js.map

package/dist/s3-file-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file-storage.js","sourceRoot":"","sources":["../src/s3-file-storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,GAEjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EACL,SAAS,EACT,cAAc,EACd,WAAW,EACX,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,WAAW,GAYZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC3B,MAAM,CAAW;IAEjB,MAAM,CAAS;IAEf,IAAI,CAAa;IAEjB,QAAQ,CAAS;IAEjB,KAAK,CAAQ;IAE9B,YAAY,OAA6B;QACvC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,WAAW,EAAE,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,OAAmB,EAAE,OAAmB;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE5G,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;YACxB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE;YACzF,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,CAAC;YACZ,iBAAiB,EAAE,KAAK;SACzB,CAAC,CAAC;QAEH,MAAM,YAAY,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAEjE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC;IAClF,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAE1E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,YAAY,QAAQ,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;QACnH,CAAC;QAED,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAW;QACpB,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACvF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAE1E,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACnG,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,EAAU;QACjC,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;QAE1G,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACvD,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,EAAU;QACjC,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEzB,OAAO;QACT,CAAC;QAED,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1B,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,CAAC,IAAI,CAAC,MAAc;QACxB,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YAC1F,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,GAAW,EAAE,OAA2B;QAC9D,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAEzD,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;YACnC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC;YACtB,0BAA0B,EAAE,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC;SACjE,CAAC,CAAC;QAEH,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;IAC7G,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAW,EAAE,OAAyB;QAC1D,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACzD,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9G,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC;QAEhH,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;IAC3G,CAAC;IAEO,MAAM,CAAC,OAAe;QAC5B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC;IAChE,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,GAAW;QAC/B,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;CACF;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,CAAC;AACd,CAAC;AAQD,SAAS,UAAU,CAAC,GAAW,EAAE,IAAgB;IAC/C,OAAO;QACL,GAAG;QACH,IAAI,EAAE,IAAI,CAAC,aAAa,IAAI,CAAC;QAC7B,SAAS,EAAE,WAAW,CAAC,IAAI,CAAC,WAAW,IAAI,0BAA0B,CAAC;QACtE,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC;KAC/C,CAAC;AACJ,CAAC"}

package/dist/s3-settings.d.ts

@@ -0,0 +1,12 @@
+/** What reaches a bucket: the same five values for every provider of the S3 protocol. */
+export interface S3Settings {
+    /** Left out for AWS. MinIO `http://localhost:9000`, OVHcloud `https://s3.gra.io.cloud.ovh.net`, R2 `https://<account>.r2.cloudflarestorage.com`. */
+    readonly endpoint?: string;
+    /** `auto` for R2; the region of the bucket elsewhere. */
+    readonly region: string;
+    readonly accessKeyId: string;
+    readonly secretAccessKey: string;
+    /** `bucket` in the path instead of the host name: MinIO and most self-hosted servers need it. Default: true with an endpoint. */
+    readonly forcePathStyle?: boolean;
+}
+//# sourceMappingURL=s3-settings.d.ts.map

package/dist/s3-settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-settings.d.ts","sourceRoot":"","sources":["../src/s3-settings.ts"],"names":[],"mappings":"AAAA,yFAAyF;AACzF,MAAM,WAAW,UAAU;IACzB,oJAAoJ;IACpJ,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,iIAAiI;IACjI,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC"}

package/dist/s3-settings.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=s3-settings.js.map

package/dist/s3-settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-settings.js","sourceRoot":"","sources":["../src/s3-settings.ts"],"names":[],"mappings":""}

package/dist/settled-first.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Waits for the stream that feeds an upload and for the upload, and rejects with the failure of
+ * the stream first: when the content was refused on its way, the upload only says it was cut.
+ */
+export declare function settledFirst(feeding: Promise<void>, uploading: Promise<unknown>): Promise<void>;
+//# sourceMappingURL=settled-first.d.ts.map

package/dist/settled-first.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settled-first.d.ts","sourceRoot":"","sources":["../src/settled-first.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAUrG"}

package/dist/settled-first.js

@@ -0,0 +1,14 @@
+/**
+ * Waits for the stream that feeds an upload and for the upload, and rejects with the failure of
+ * the stream first: when the content was refused on its way, the upload only says it was cut.
+ */
+export async function settledFirst(feeding, uploading) {
+    const [fed, uploaded] = await Promise.allSettled([feeding, uploading]);
+    if (fed.status === 'rejected') {
+        throw fed.reason;
+    }
+    if (uploaded.status === 'rejected') {
+        throw uploaded.reason;
+    }
+}
+//# sourceMappingURL=settled-first.js.map

package/dist/settled-first.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settled-first.js","sourceRoot":"","sources":["../src/settled-first.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAsB,EAAE,SAA2B;IACpF,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;IAEvE,IAAI,GAAG,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAC9B,MAAM,GAAG,CAAC,MAAM,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACnC,MAAM,QAAQ,CAAC,MAAM,CAAC;IACxB,CAAC;AACH,CAAC"}

package/dist/testing.d.ts

@@ -0,0 +1,2 @@
+export { fileStorageContract, followWithFetch, type FileStorageContractOptions, type FollowedResponse, type SignedRequest, } from '@ddd-ts-kit/testing/contracts';
+//# sourceMappingURL=testing.d.ts.map

package/dist/testing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,KAAK,0BAA0B,EAC/B,KAAK,gBAAgB,EACrB,KAAK,aAAa,GACnB,MAAM,+BAA+B,CAAC"}

package/dist/testing.js

@@ -0,0 +1,2 @@
+export { fileStorageContract, followWithFetch, } from '@ddd-ts-kit/testing/contracts';
+//# sourceMappingURL=testing.js.map

package/dist/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,eAAe,GAIhB,MAAM,+BAA+B,CAAC"}

package/package.json

@@ -1,7 +1,61 @@
 {
   "name": "@ddd-ts-kit/s3",
-  "version": "0.0.0",
-  "description": "Placeholder that reserves the name; the real versions are published by the release workflow of gbourgeat/ddd-ts-kit.",
+  "version": "0.9.0",
+  "description": "Adapter of the kernel FileStorage port on the S3 protocol (AWS S3, MinIO, OVHcloud, Scaleway, Cloudflare R2): streamed uploads, signed links, copy, move, listing.",
   "license": "MIT",
-  "repository": { "type": "git", "url": "git+https://github.com/gbourgeat/ddd-ts-kit.git" }
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gbourgeat/ddd-ts-kit.git",
+    "directory": "packages/s3"
+  },
+  "homepage": "https://github.com/gbourgeat/ddd-ts-kit/tree/main/packages/s3#readme",
+  "bugs": "https://github.com/gbourgeat/ddd-ts-kit/issues",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing.d.ts",
+      "default": "./dist/testing.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@ddd-ts-kit/kernel": "0.9.0"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-s3": "^3.1150.0",
+    "@aws-sdk/lib-storage": "^3.1150.0",
+    "@aws-sdk/s3-request-presigner": "^3.1150.0",
+    "@ddd-ts-kit/testing": "0.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@aws-sdk/client-s3": {
+      "optional": true
+    },
+    "@aws-sdk/lib-storage": {
+      "optional": true
+    },
+    "@aws-sdk/s3-request-presigner": {
+      "optional": true
+    },
+    "@ddd-ts-kit/testing": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@aws-sdk/client-s3": "3.1150.0",
+    "@aws-sdk/lib-storage": "3.1150.0",
+    "@aws-sdk/s3-request-presigner": "3.1150.0",
+    "@ddd-ts-kit/testing": "0.9.0"
+  }
 }