@tstdl/base 0.90.62 → 0.90.63

package/api/server/api-controller.d.ts

@@ -1,4 +1,4 @@
-import type { InjectableOptionsWithoutLifecycle } from '../../injector/decorators.js';
+import { type InjectableOptionsWithoutLifecycle } from '../../injector/decorators.js';
 import type { Constructor, Type } from '../../types.js';
 import type { ApiController, ApiDefinition } from '../types.js';
 type ApiDefinitionProvider = () => ApiDefinition;

package/api/server/api-controller.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-classes-per-file */
 import { Singleton } from '../../injector/decorators.js';
 import { objectEntries } from '../../utils/object/object.js';
 import { isFunction } from '../../utils/type-guards.js';

package/object-storage/object-storage.d.ts

@@ -1,74 +1,75 @@
-import type { Resolvable } from '../injector/interfaces.js';
-import { resolveArgumentType } from '../injector/interfaces.js';
+import { resolveArgumentType, type Resolvable } from '../injector/interfaces.js';
 import type { ObjectMetadata, ObjectStorageObject } from './object.js';
 export type UploadObjectOptions = {
     metadata?: ObjectMetadata;
 };
 export type ObjectStorageArgument = string;
 export declare abstract class ObjectStorage implements Resolvable<ObjectStorageArgument> {
-    /** object storage module */
+    /** Object storage module */
     readonly module: string;
     readonly [resolveArgumentType]: ObjectStorageArgument;
     constructor(module: string);
     /**
-     * checks if an object exists
+     * Checks if an object exists
      * @param key object key
      */
     abstract exists(key: string): Promise<boolean>;
     /**
-     * uploads an object
+     * Uploads an object
      * @param key object key
      * @param content content of object
      */
-    abstract uploadObject(key: string, content: Uint8Array, options?: UploadObjectOptions): Promise<void>;
+    abstract uploadObject(key: string, content: Uint8Array | ReadableStream<Uint8Array>, options?: UploadObjectOptions): Promise<void>;
     /**
-     * uploads an object stream
+     * Uploads an object stream
      * @param key object key
      * @param stream stream of object
+     * @deprecated use {@link uploadObject} instead
      */
     abstract uploadObjectStream(key: string, stream: ReadableStream<Uint8Array>, options?: UploadObjectOptions): Promise<void>;
     /**
-     * get an url which can be used to upload the object without further authorization
+     * Get an url which can be used to upload the object without further authorization
      * @param key object key
      * @param expirationTimestamp timestamp when the url expires and can no longer be used
      */
     abstract getUploadUrl(key: string, expirationTimestamp: number): Promise<string>;
     /**
-     * get all objects
+     * Get all objects
      */
     abstract getObjects(): Promise<ObjectStorageObject[]>;
     /**
-     * get all objects
+     * Get all objects
      */
     abstract getObjectsCursor(): AsyncIterable<ObjectStorageObject>;
     /**
-     * get object
+     * Get object
      * @param key object key
      */
     abstract getObject(key: string): Promise<ObjectStorageObject>;
     /**
-     * get object resource uri
+     * Get object resource uri
      * @param key object key
      */
     abstract getResourceUri(key: string): Promise<string>;
     /**
-     * get stream of object content
+     * Get stream of object content
      * @param key object key
      */
     abstract getContentStream(key: string): ReadableStream<Uint8Array>;
     /**
-     * get an url which can be used to download the object without further authorization
+     * Get an url which can be used to download the object without further authorization
      * @param key object key
      * @param expirationTimestamp timestamp when the url expires and can no longer be used
+     * @param responseHeaders headers used for download response
      */
-    abstract getDownloadUrl(key: string, expirationTimestamp: number): Promise<string>;
+    abstract getDownloadUrl(key: string, expirationTimestamp: number, responseHeaders?: Record<string, string>): Promise<string>;
     /**
-     * deletes an object
+     * Deletes an object
      * @param key object key
      */
     abstract deleteObject(key: string): Promise<void>;
     /**
-     * deletes objects
+     * Deletes objects
      * @param keys object key
      */
     abstract deleteObjects(keys: string[]): Promise<void>;

package/object-storage/object-storage.js

@@ -1,6 +1,6 @@
 import { resolveArgumentType } from '../injector/interfaces.js';
 export class ObjectStorage {
-    /** object storage module */
+    /** Object storage module */
     module;
     constructor(module) {
         this.module = module;

package/object-storage/s3/s3.object-storage.d.ts

@@ -1,7 +1,5 @@
-import type { BucketItemStat } from 'minio';
-import { Client } from 'minio';
-import type { UploadObjectOptions } from '../../object-storage/index.js';
-import { ObjectStorage } from '../../object-storage/index.js';
+import type { BucketItemStat, Client } from 'minio';
+import { ObjectStorage, type UploadObjectOptions } from '../../object-storage/index.js';
 import { S3Object } from './s3.object.js';
 export declare class S3ObjectStorage extends ObjectStorage {
     private readonly client;
@@ -13,7 +11,7 @@ export declare class S3ObjectStorage extends ObjectStorage {
     }): Promise<void>;
     exists(key: string): Promise<boolean>;
     statObject(key: string): Promise<BucketItemStat>;
-    uploadObject(key: string, content: Uint8Array, options?: UploadObjectOptions): Promise<void>;
+    uploadObject(key: string, content: Uint8Array | ReadableStream<Uint8Array>, options?: UploadObjectOptions): Promise<void>;
     uploadObjectStream(key: string, stream: ReadableStream<Uint8Array>, options?: UploadObjectOptions): Promise<void>;
     getContent(key: string): Promise<Uint8Array>;
     getContentStream(key: string): ReadableStream<Uint8Array>;
@@ -21,7 +19,7 @@ export declare class S3ObjectStorage extends ObjectStorage {
     getObjectsCursor(): AsyncIterable<S3Object>;
     getObject(key: string): Promise<S3Object>;
     getResourceUri(key: string): Promise<string>;
-    getDownloadUrl(key: string, expirationTimestamp: number): Promise<string>;
+    getDownloadUrl(key: string, expirationTimestamp: number, responseHeaders?: Record<string, string>): Promise<string>;
     getUploadUrl(key: string, expirationTimestamp: number): Promise<string>;
     deleteObject(key: string): Promise<void>;
     deleteObjects(keys: string[]): Promise<void>;

package/object-storage/s3/s3.object-storage.js

@@ -8,7 +8,6 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import { Readable } from 'node:stream';
-import { Client } from 'minio';
 import { Singleton } from '../../injector/decorators.js';
 import { ObjectStorage } from '../../object-storage/index.js';
 import { mapAsync } from '../../utils/async-iterable-helpers/map.js';
@@ -16,7 +15,7 @@ import { toArrayAsync } from '../../utils/async-iterable-helpers/to-array.js';
 import { now } from '../../utils/date-time.js';
 import { readableStreamFromPromise } from '../../utils/stream/index.js';
 import { readBinaryStream } from '../../utils/stream/stream-reader.js';
-import { assertStringPass, isObject } from '../../utils/type-guards.js';
+import { assertStringPass, isObject, isUint8Array } from '../../utils/type-guards.js';
 import { S3ObjectStorageProvider } from './s3.object-storage-provider.js';
 import { S3Object } from './s3.object.js';
 let S3ObjectStorage = class S3ObjectStorage extends ObjectStorage {
@@ -55,16 +54,20 @@ let S3ObjectStorage = class S3ObjectStorage extends ObjectStorage {
     }
     async uploadObject(key, content, options) {
         const bucketKey = this.getBucketKey(key);
-        await this.client.putObject(this.bucket, bucketKey, Buffer.from(content), options?.metadata);
+        if (isUint8Array(content)) {
+            await this.client.putObject(this.bucket, bucketKey, Buffer.from(content), options?.metadata);
+        }
+        else {
+            const readable = Readable.fromWeb(content);
+            const errorPromise = new Promise((_, reject) => readable.on('error', reject));
+            await Promise.race([
+                this.client.putObject(this.bucket, bucketKey, readable, options?.metadata),
+                errorPromise
+            ]);
+        }
     }
     async uploadObjectStream(key, stream, options) {
-        const bucketKey = this.getBucketKey(key);
-        const readable = Readable.fromWeb(stream);
-        const errorPromise = new Promise((_, reject) => readable.on('error', reject));
-        await Promise.race([
-            this.client.putObject(this.bucket, bucketKey, readable, options?.metadata),
-            errorPromise
-        ]);
+        return this.uploadObject(key, stream, options);
     }
     async getContent(key) {
         const bucketKey = this.getBucketKey(key);
@@ -93,10 +96,10 @@ let S3ObjectStorage = class S3ObjectStorage extends ObjectStorage {
     async getResourceUri(key) {
         return this.getResourceUriSync(key);
     }
-    async getDownloadUrl(key, expirationTimestamp) {
+    async getDownloadUrl(key, expirationTimestamp, responseHeaders) {
         const bucketKey = this.getBucketKey(key);
         const { date, expiration } = getDateAndExpiration(expirationTimestamp);
-        return this.client.presignedGetObject(this.bucket, bucketKey, expiration, {}, date);
+        return this.client.presignedGetObject(this.bucket, bucketKey, expiration, responseHeaders, date);
     }
     async getUploadUrl(key, expirationTimestamp) {
         const bucketKey = this.getBucketKey(key);
@@ -131,7 +134,7 @@ S3ObjectStorage = __decorate([
             }
         }
     }),
-    __metadata("design:paramtypes", [Client, String, String, String])
+    __metadata("design:paramtypes", [Function, String, String, String])
 ], S3ObjectStorage);
 export { S3ObjectStorage };
 function getDateAndExpiration(expirationTimestamp) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.90.62",
+  "version": "0.90.63",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"
@@ -130,7 +130,7 @@
     "typedoc": "0.25",
     "typedoc-plugin-missing-exports": "2.2",
     "typescript": "5.4",
-    "typescript-eslint": "7.5"
+    "typescript-eslint": "7.7"
   },
   "peerDependencies": {
     "@elastic/elasticsearch": "^8.13",
@@ -147,10 +147,10 @@
     "mjml": "^4.15",
     "mongodb": "^6.5",
     "nodemailer": "^6.9",
-    "playwright": "^1.42",
+    "playwright": "^1.43",
     "preact": "^10.20",
     "preact-render-to-string": "^6.4",
-    "undici": "^6.11",
+    "undici": "^6.13",
     "urlpattern-polyfill": "^10.0"
   },
   "peerDependenciesMeta": {