@edgestore/server 0.1.0 → 0.1.2

package/src/providers/edgestore/index.ts

@@ -1,11 +1,23 @@
 import { initEdgeStoreSdk } from '../../core/sdk';
 import EdgeStoreCredentialsError from '../../libs/errors/EdgeStoreCredentialsError';
-import { Provider, RequestUploadRes } from '../types';
+import { type Provider, type RequestUploadRes } from '../types';
 
 const DEFAULT_BASE_URL = 'https://files.edgestore.dev';
 
 export type EdgeStoreProviderOptions = {
+  /**
+   * Access key for your EdgeStore project.
+   * Can be found in the EdgeStore dashboard.
+   *
+   * This can be omitted if the `EDGE_STORE_ACCESS_KEY` environment variable is set.
+   */
   accessKey?: string;
+  /**
+   * Secret key for your EdgeStore project.
+   * Can be found in the EdgeStore dashboard.
+   *
+   * This can be omitted if the `EDGE_STORE_SECRET_KEY` environment variable is set.
+   */
   secretKey?: string;
 };
 
@@ -54,31 +66,29 @@ export function EdgeStoreProvider(
       bucketType,
       fileInfo,
     }): Promise<RequestUploadRes> {
-      // multiplart upload if file is bigger than a certain size
+      // multipart upload if file is bigger than a certain size
       const MULTIPART_THRESHOLD = 10 * 1024 * 1024; // 10MB
-      const CONCURRENCY = 3;
       let partSize = 5 * 1024 * 1024; // 5MB
       if (fileInfo.size > MULTIPART_THRESHOLD) {
         let totalParts = Math.ceil(fileInfo.size / partSize);
-        if (totalParts > 10000) {
-          // the maximum number of parts is 10000
-          totalParts = 10000;
+        if (totalParts > 1000) {
+          // the maximum number of parts is 1000
+          totalParts = 1000;
           partSize = Math.ceil(fileInfo.size / totalParts);
         }
-        const requestParts =
-          totalParts > CONCURRENCY ? CONCURRENCY : totalParts;
         const res = await edgeStoreSdk.requestUpload({
           bucketName,
           bucketType,
           fileInfo,
           multipart: {
-            parts: Array.from({ length: requestParts }).map(
+            parts: Array.from({ length: totalParts }).map(
               (_, index) => index + 1,
             ),
           },
         });
         const multipart = res.multipart
           ? {
+              key: res.multipart.key,
               uploadId: res.multipart.uploadId,
               parts: res.multipart.parts.map((part) => ({
                 partNumber: part.partNumber,
@@ -91,12 +101,14 @@ export function EdgeStoreProvider(
         if (multipart) {
           return {
             accessUrl: res.accessUrl,
+            thumbnailUrl: res.thumbnailUrl,
             multipart,
           };
         } else if (res.signedUrl) {
           return {
             accessUrl: res.accessUrl,
             uploadUrl: res.signedUrl,
+            thumbnailUrl: res.thumbnailUrl,
           };
         } else {
           throw new Error('Could not get upload url');
@@ -111,6 +123,7 @@ export function EdgeStoreProvider(
         return {
           accessUrl: res.accessUrl,
           uploadUrl: res.signedUrl,
+          thumbnailUrl: res.thumbnailUrl,
         };
       }
       throw new Error('Could not get upload url');
@@ -130,6 +143,18 @@ export function EdgeStoreProvider(
         },
       };
     },
+    completeMultipartUpload: async ({ uploadId, key, parts }) => {
+      return await edgeStoreSdk.completeMultipartUpload({
+        uploadId,
+        key,
+        parts,
+      });
+    },
+    confirmUpload: async ({ url }) => {
+      return await edgeStoreSdk.confirmUpload({
+        url,
+      });
+    },
     deleteFile: async ({ url }) => {
       return await edgeStoreSdk.deleteFile({
         url,

package/src/providers/index.ts

@@ -1,2 +1 @@
-export * from './aws';
-export * from './edgestore';
+export * from './types';

package/src/providers/types.ts

@@ -1,9 +1,9 @@
 import {
-  AnyBuilder,
-  AnyMetadata,
-  EdgeStoreRouter,
+  type AnyBuilder,
+  type AnyMetadata,
+  type EdgeStoreRouter,
 } from '../core/internals/bucketBuilder';
-import { MaybePromise } from '../types';
+import { type MaybePromise } from '../types';
 
 export type InitParams = {
   ctx: any;
@@ -47,6 +47,7 @@ export type RequestUploadParams = {
     }[];
     metadata: AnyMetadata;
     replaceTargetUrl?: string;
+    temporary: boolean;
   };
 };
 
@@ -68,13 +69,28 @@ export type RequestUploadPartsRes = {
   };
 };
 
+export type CompleteMultipartUploadParams = {
+  uploadId: string;
+  key: string;
+  parts: {
+    partNumber: number;
+    eTag: string;
+  }[];
+};
+
+export type CompleteMultipartUploadRes = {
+  success: boolean;
+};
+
 export type RequestUploadRes =
   | {
       uploadUrl: string;
       accessUrl: string;
+      thumbnailUrl?: string | null;
     }
   | {
       multipart: {
+        key: string;
         uploadId: string;
         partSize: number;
         totalParts: number;
@@ -84,8 +100,18 @@ export type RequestUploadRes =
         }[];
       };
       accessUrl: string;
+      thumbnailUrl?: string | null;
     };
 
+export type ConfirmUpload = {
+  bucket: AnyBuilder;
+  url: string;
+};
+
+export type ConfirmUploadRes = {
+  success: boolean;
+};
+
 export type DeleteFileParams = {
   bucket: AnyBuilder;
   url: string;
@@ -105,5 +131,9 @@ export type Provider = {
   requestUploadParts: (
     params: RequestUploadPartsParams,
   ) => MaybePromise<RequestUploadPartsRes>;
+  completeMultipartUpload: (
+    params: CompleteMultipartUploadParams,
+  ) => MaybePromise<CompleteMultipartUploadRes>;
+  confirmUpload: (params: ConfirmUpload) => MaybePromise<ConfirmUploadRes>;
   deleteFile: (params: DeleteFileParams) => MaybePromise<DeleteFileRes>;
 };