@clairejs/server 3.16.18 → 3.17.0

package/README.md

@@ -1,7 +1,12 @@
 ## Change Log
 
-#### 3.16.18:
+#### 3.17.0:
 
+-   add putFile in AbstractFileService
+
+#### 3.16.19:
+
+-   fix dependency
 -   allow file service to resolve empty uri to empty string
 -   fix job param type from any[] to any
 -   fix CRUD order

package/dist/services/AbstractFileService.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { FileOperation } from "../common/FileOperation";
 import { GetUploadUrlResponseBody } from "../controllers/dto/upload";
 export declare abstract class AbstractFileService {
@@ -13,5 +14,6 @@ export declare abstract class AbstractFileService {
         toURI: string;
     }[]): Promise<void>;
     abstract removeObject(uris: string[]): Promise<void>;
+    abstract putFile(uri: string, data: Buffer, headers?: Record<string, string>): Promise<void>;
     getUploadUrlForTempUri(temporaryUri: string): Promise<GetUploadUrlResponseBody>;
 }

package/dist/services/implementations/LocalFileService.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { FileOperation } from "../../common/FileOperation";
 import { AbstractFileService } from "../AbstractFileService";
 export declare class LocalFileService extends AbstractFileService {
@@ -6,6 +7,7 @@ export declare class LocalFileService extends AbstractFileService {
     getFileSize(objectKeys: string[]): Promise<number[]>;
     getAccessUrls(uris: (string | undefined)[], _isPublic: boolean): Promise<string[]>;
     getPresignedUrl(operation: FileOperation, uris: string[]): Promise<string[]>;
+    putFile(uri: string, data: Buffer, headers?: Record<string, string>): Promise<void>;
     moveObject(uris: {
         fromURI: string;
         toURI: string;

package/dist/services/implementations/LocalFileService.js

@@ -23,6 +23,15 @@ export class LocalFileService extends AbstractFileService {
         }
         return uris.map((uri) => `${this.fileServerUrl}/?objectKey="/${uri}"`);
     }
+    async putFile(uri, data, headers) {
+        const [url] = await this.getPresignedUrl(FileOperation.PUT, [uri]);
+        await axios({
+            method: 'PUT',
+            url,
+            data,
+            headers,
+        });
+    }
     async moveObject(uris) {
         await Promise.all(uris.map((uri) => axios.post(`${this.fileServerUrl}/`, {
             from: uri.fromURI,

package/dist/services/implementations/S3FileService.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { AbstractLogger } from "@clairejs/core";
 import { FileOperation } from "../../common/FileOperation";
 import { AbstractFileService } from "../AbstractFileService";
@@ -13,8 +14,9 @@ export declare class S3FileService extends AbstractFileService {
     protected readonly config: S3FileServiceConfig;
     protected readonly logger: AbstractLogger;
     private readonly s3Client;
-    private readonly cloudfrontSigner;
+    private readonly cloudfrontSigner?;
     constructor(config: S3FileServiceConfig, logger: AbstractLogger);
+    putFile(uri: string, data: Buffer, headers?: Record<string, string>): Promise<void>;
     getFileSize(objectKeys: string[]): Promise<number[]>;
     getAccessUrls(uris: (string | undefined)[], isPublic: boolean): Promise<string[]>;
     getPresignedUrl(operation: FileOperation, uris: string[]): Promise<string[]>;

package/dist/services/implementations/S3FileService.js

@@ -24,7 +24,17 @@ let S3FileService = class S3FileService extends AbstractFileService {
             signatureVersion: "v4",
             region: this.config.S3_BUCKET_REGION,
         });
-        this.cloudfrontSigner = new aws.CloudFront.Signer(this.config.CLOUD_FRONT_PUBLIC_KEY_ID, this.config.CLOUD_FRONT_PRIVATE_KEY);
+        if (this.config.CLOUD_FRONT_PUBLIC_DOMAIN && this.config.CLOUD_FRONT_PRIVATE_KEY && this.config.CLOUD_FRONT_PUBLIC_KEY_ID) {
+            this.cloudfrontSigner = new aws.CloudFront.Signer(this.config.CLOUD_FRONT_PUBLIC_KEY_ID, this.config.CLOUD_FRONT_PRIVATE_KEY);
+        }
+    }
+    async putFile(uri, data, headers) {
+        await this.s3Client.putObject({
+            Key: uri,
+            Bucket: this.config.S3_BUCKET_NAME,
+            Body: data,
+            Metadata: headers,
+        }).promise();
     }
     async getFileSize(objectKeys) {
         return await Promise.all(objectKeys.map((uri) => this.getSingleFileSize(uri)));
@@ -51,10 +61,17 @@ let S3FileService = class S3FileService extends AbstractFileService {
             .then((res) => res.ContentLength);
         return size || 0;
     }
-    getSinglePresignedUrl(_operation, objectKey) {
-        return this.cloudfrontSigner.getSignedUrl({
-            url: `${this.config.CLOUD_FRONT_PUBLIC_DOMAIN}/${objectKey}`,
-            expires: Date.now() + this.config.PRESIGNED_URL_EXPIRATION_S * 1000,
+    getSinglePresignedUrl(operation, objectKey) {
+        if (this.cloudfrontSigner) {
+            return this.cloudfrontSigner.getSignedUrl({
+                url: `${this.config.CLOUD_FRONT_PUBLIC_DOMAIN}/${objectKey}`,
+                expires: Date.now() + this.config.PRESIGNED_URL_EXPIRATION_S * 1000,
+            });
+        }
+        return this.s3Client.getSignedUrl(operation, {
+            Bucket: this.config.S3_BUCKET_NAME,
+            Key: objectKey,
+            Expires: this.config.PRESIGNED_URL_EXPIRATION_S
         });
     }
     async copySingleObject(fromObjectKey, toObjectKey) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@clairejs/server",
-    "version": "3.16.18",
+    "version": "3.17.0",
     "description": "Claire server NodeJs framework written in Typescript.",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",
@@ -28,12 +28,13 @@
         "randomstring": "^1.2.2",
         "redlock": "^5.0.0-beta.2",
         "reflect-metadata": "^0.1.13",
-        "ws": "^7.5.5"
+        "ws": "^7.5.5",
+        "ioredis": "^5.2.0",
+        "axios": "^0.21.4"
     },
     "peerDependencies": {
         "@clairejs/core": "^3.6.1",
-        "@clairejs/orm": "^3.11.0",
-        "ioredis": "^5.2.0"
+        "@clairejs/orm": "^3.11.0"
     },
     "devDependencies": {
         "@types/cookie-parser": "^1.4.3",
@@ -47,7 +48,6 @@
         "@types/randomstring": "^1.1.8",
         "@types/uuid": "^9.0.0",
         "@types/ws": "^7.4.0",
-        "axios": "^0.21.1",
         "mocha": "^10.2.0",
         "ts-node": "^10.9.1",
         "typescript": "^5.0.4",