@edgestore/server 0.5.0 → 0.5.2

package/dist/providers/aws/index.d.ts

@@ -1,4 +1,11 @@
-import { type Provider } from '@edgestore/shared';
+import { type MaybePromise, type Provider, type RequestUploadParams } from '@edgestore/shared';
+type ProviderUploadedFileInfo = RequestUploadParams['fileInfo'];
+export type AWSOverwritePathFnArgs = {
+    esBucketName: string;
+    fileInfo: ProviderUploadedFileInfo;
+    defaultAccessPath: string;
+};
+export type AWSOverwritePathFn = (args: AWSOverwritePathFnArgs) => MaybePromise<string>;
 export type AWSProviderOptions = {
     /**
      * Access key for AWS credentials.
@@ -49,6 +56,13 @@ export type AWSProviderOptions = {
      * It can also be set via the `EDGE_STORE_JWT_SECRET` environment variable.
      */
     jwtSecret?: string;
+    /**
+     * Optional function to overwrite the S3 key (object path) for uploads.
+     * This function receives the EdgeStore bucket name, fileInfo and the default S3 key
+     * and should return the desired S3 key string.
+     */
+    overwritePath?: AWSOverwritePathFn;
 };
 export declare function AWSProvider(options?: AWSProviderOptions): Provider;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/providers/aws/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/aws/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAIlD,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,QAAQ,CA8GlE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/aws/index.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,mBAAmB,EACzB,MAAM,mBAAmB,CAAC;AAK3B,KAAK,wBAAwB,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;AAEhE,MAAM,MAAM,sBAAsB,GAAG;IAEnC,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,wBAAwB,CAAC;IAEnC,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAC/B,IAAI,EAAE,sBAAsB,KACzB,YAAY,CAAC,MAAM,CAAC,CAAC;AAE1B,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC,CAAC;AAEF,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,QAAQ,CAuIlE"}

package/dist/providers/aws/index.js

@@ -12,7 +12,7 @@ require('cookie');
 require('jose');
 
 function AWSProvider(options) {
-    const { accessKeyId = shared.getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = shared.getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = shared.getEnv('ES_AWS_REGION'), bucketName = shared.getEnv('ES_AWS_BUCKET_NAME'), endpoint = shared.getEnv('ES_AWS_ENDPOINT'), forcePathStyle = shared.getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true' } = options ?? {};
+    const { accessKeyId = shared.getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = shared.getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = shared.getEnv('ES_AWS_REGION'), bucketName = shared.getEnv('ES_AWS_BUCKET_NAME'), endpoint = shared.getEnv('ES_AWS_ENDPOINT'), forcePathStyle = shared.getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true', overwritePath } = options ?? {};
     const baseUrl = options?.baseUrl ?? shared.getEnv('EDGE_STORE_BASE_URL') ?? (endpoint ? `${endpoint}/${bucketName}` : `https://${bucketName}.s3.${region}.amazonaws.com`);
     const credentials = accessKeyId && secretAccessKey ? {
         accessKeyId,
@@ -48,15 +48,27 @@ function AWSProvider(options) {
                 uploadedAt: LastModified
             };
         },
-        async requestUpload ({ bucketName: esBucketName, fileInfo }) {
+        async requestUpload (params) {
+            const { bucketName: esBucketName, fileInfo } = params;
+            if (!bucketName) {
+                throw new Error('S3 bucketName is not configured in AWSProviderOptions.');
+            }
+            // Default S3 key (accessPath) construction logic
             const pathPrefix = `${esBucketName}${fileInfo.isPublic ? '/_public' : ''}`;
             const nameId = uuid.v4();
             const extension = fileInfo.extension ? `.${fileInfo.extension.replace('.', '')}` : '';
-            const fileName = fileInfo.fileName ?? `${nameId}${extension}`;
-            const filePath = fileInfo.path.reduce((acc, item)=>{
+            const defaultResolvedFileName = fileInfo.fileName ?? `${nameId}${extension}`;
+            const defaultFilePathFromMetadata = fileInfo.path.reduce((acc, item)=>{
                 return `${acc}/${item.value}`;
             }, '');
-            const accessPath = `${pathPrefix}${filePath}/${fileName}`;
+            let accessPath = `${pathPrefix}${defaultFilePathFromMetadata}/${defaultResolvedFileName}`;
+            if (overwritePath) {
+                accessPath = await overwritePath({
+                    esBucketName,
+                    fileInfo,
+                    defaultAccessPath: accessPath
+                });
+            }
             const command = new clientS3.PutObjectCommand({
                 Bucket: bucketName,
                 Key: accessPath
@@ -64,10 +76,10 @@ function AWSProvider(options) {
             const signedUrl = await s3RequestPresigner.getSignedUrl(s3Client, command, {
                 expiresIn: 60 * 60
             });
-            const url = `${baseUrl}/${accessPath}`;
+            const finalAccessUrl = `${baseUrl}/${accessPath.startsWith('/') ? accessPath.substring(1) : accessPath}`;
             return {
                 uploadUrl: signedUrl,
-                accessUrl: url
+                accessUrl: finalAccessUrl
             };
         },
         async requestUploadParts () {
@@ -80,6 +92,9 @@ function AWSProvider(options) {
             throw new Error('Not implemented');
         },
         async deleteFile ({ url }) {
+            if (!bucketName) {
+                throw new Error('S3 bucketName is not configured in AWSProviderOptions for deleteFile.');
+            }
             const path = url.replace(`${baseUrl}/`, '');
             await s3Client.send(new clientS3.DeleteObjectCommand({
                 Bucket: bucketName,

package/dist/providers/aws/index.mjs

@@ -8,7 +8,7 @@ import 'cookie';
 import 'jose';
 
 function AWSProvider(options) {
-    const { accessKeyId = getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = getEnv('ES_AWS_REGION'), bucketName = getEnv('ES_AWS_BUCKET_NAME'), endpoint = getEnv('ES_AWS_ENDPOINT'), forcePathStyle = getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true' } = options ?? {};
+    const { accessKeyId = getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = getEnv('ES_AWS_REGION'), bucketName = getEnv('ES_AWS_BUCKET_NAME'), endpoint = getEnv('ES_AWS_ENDPOINT'), forcePathStyle = getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true', overwritePath } = options ?? {};
     const baseUrl = options?.baseUrl ?? getEnv('EDGE_STORE_BASE_URL') ?? (endpoint ? `${endpoint}/${bucketName}` : `https://${bucketName}.s3.${region}.amazonaws.com`);
     const credentials = accessKeyId && secretAccessKey ? {
         accessKeyId,
@@ -44,15 +44,27 @@ function AWSProvider(options) {
                 uploadedAt: LastModified
             };
         },
-        async requestUpload ({ bucketName: esBucketName, fileInfo }) {
+        async requestUpload (params) {
+            const { bucketName: esBucketName, fileInfo } = params;
+            if (!bucketName) {
+                throw new Error('S3 bucketName is not configured in AWSProviderOptions.');
+            }
+            // Default S3 key (accessPath) construction logic
             const pathPrefix = `${esBucketName}${fileInfo.isPublic ? '/_public' : ''}`;
             const nameId = v4();
             const extension = fileInfo.extension ? `.${fileInfo.extension.replace('.', '')}` : '';
-            const fileName = fileInfo.fileName ?? `${nameId}${extension}`;
-            const filePath = fileInfo.path.reduce((acc, item)=>{
+            const defaultResolvedFileName = fileInfo.fileName ?? `${nameId}${extension}`;
+            const defaultFilePathFromMetadata = fileInfo.path.reduce((acc, item)=>{
                 return `${acc}/${item.value}`;
             }, '');
-            const accessPath = `${pathPrefix}${filePath}/${fileName}`;
+            let accessPath = `${pathPrefix}${defaultFilePathFromMetadata}/${defaultResolvedFileName}`;
+            if (overwritePath) {
+                accessPath = await overwritePath({
+                    esBucketName,
+                    fileInfo,
+                    defaultAccessPath: accessPath
+                });
+            }
             const command = new PutObjectCommand({
                 Bucket: bucketName,
                 Key: accessPath
@@ -60,10 +72,10 @@ function AWSProvider(options) {
             const signedUrl = await getSignedUrl(s3Client, command, {
                 expiresIn: 60 * 60
             });
-            const url = `${baseUrl}/${accessPath}`;
+            const finalAccessUrl = `${baseUrl}/${accessPath.startsWith('/') ? accessPath.substring(1) : accessPath}`;
             return {
                 uploadUrl: signedUrl,
-                accessUrl: url
+                accessUrl: finalAccessUrl
             };
         },
         async requestUploadParts () {
@@ -76,6 +88,9 @@ function AWSProvider(options) {
             throw new Error('Not implemented');
         },
         async deleteFile ({ url }) {
+            if (!bucketName) {
+                throw new Error('S3 bucketName is not configured in AWSProviderOptions for deleteFile.');
+            }
             const path = url.replace(`${baseUrl}/`, '');
             await s3Client.send(new DeleteObjectCommand({
                 Bucket: bucketName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edgestore/server",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Upload files with ease from React/Next.js",
   "homepage": "https://edgestore.dev",
   "repository": "https://github.com/edgestorejs/edgestore.git",
@@ -109,7 +109,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@edgestore/shared": "0.5.0",
+    "@edgestore/shared": "0.5.2",
     "@panva/hkdf": "^1.0.4",
     "cookie": "^0.5.0",
     "jose": "^4.13.1",
@@ -151,5 +151,5 @@
     "typescript": "^5",
     "zod": "3.21.4"
   },
-  "gitHead": "1bc997b2797e026d6661b9964e74c6e117dba352"
+  "gitHead": "97cb861d3f56e4e04c83acc6808d56771433df29"
 }

package/src/providers/aws/index.ts

@@ -5,10 +5,30 @@ import {
   S3Client,
 } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-import { type Provider } from '@edgestore/shared';
+import {
+  type MaybePromise,
+  type Provider,
+  type RequestUploadParams,
+} from '@edgestore/shared';
 import { v4 as uuidv4 } from 'uuid';
 import { getEnv } from '../../adapters/shared';
 
+// FileInfo type as received by the provider's requestUpload, part of RequestUploadParams
+type ProviderUploadedFileInfo = RequestUploadParams['fileInfo'];
+
+export type AWSOverwritePathFnArgs = {
+  /* EdgeStore bucket name */
+  esBucketName: string;
+  /* File info after path generation and metadata by EdgeStore */
+  fileInfo: ProviderUploadedFileInfo;
+  /* The S3 key that would be generated by default by this provider */
+  defaultAccessPath: string;
+};
+
+export type AWSOverwritePathFn = (
+  args: AWSOverwritePathFnArgs,
+) => MaybePromise<string>;
+
 export type AWSProviderOptions = {
   /**
    * Access key for AWS credentials.
@@ -59,6 +79,12 @@ export type AWSProviderOptions = {
    * It can also be set via the `EDGE_STORE_JWT_SECRET` environment variable.
    */
   jwtSecret?: string;
+  /**
+   * Optional function to overwrite the S3 key (object path) for uploads.
+   * This function receives the EdgeStore bucket name, fileInfo and the default S3 key
+   * and should return the desired S3 key string.
+   */
+  overwritePath?: AWSOverwritePathFn;
 };
 
 export function AWSProvider(options?: AWSProviderOptions): Provider {
@@ -69,6 +95,7 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
     bucketName = getEnv('ES_AWS_BUCKET_NAME'),
     endpoint = getEnv('ES_AWS_ENDPOINT'),
     forcePathStyle = getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true',
+    overwritePath,
   } = options ?? {};
 
   const baseUrl =
@@ -120,7 +147,16 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
         uploadedAt: LastModified,
       };
     },
-    async requestUpload({ bucketName: esBucketName, fileInfo }) {
+    async requestUpload(params: RequestUploadParams) {
+      const { bucketName: esBucketName, fileInfo } = params;
+
+      if (!bucketName) {
+        throw new Error(
+          'S3 bucketName is not configured in AWSProviderOptions.',
+        );
+      }
+
+      // Default S3 key (accessPath) construction logic
       const pathPrefix = `${esBucketName}${
         fileInfo.isPublic ? '/_public' : ''
       }`;
@@ -128,11 +164,21 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
       const extension = fileInfo.extension
         ? `.${fileInfo.extension.replace('.', '')}`
         : '';
-      const fileName = fileInfo.fileName ?? `${nameId}${extension}`;
-      const filePath = fileInfo.path.reduce((acc, item) => {
+      const defaultResolvedFileName =
+        fileInfo.fileName ?? `${nameId}${extension}`;
+      const defaultFilePathFromMetadata = fileInfo.path.reduce((acc, item) => {
         return `${acc}/${item.value}`;
       }, '');
-      const accessPath = `${pathPrefix}${filePath}/${fileName}`;
+
+      let accessPath = `${pathPrefix}${defaultFilePathFromMetadata}/${defaultResolvedFileName}`;
+
+      if (overwritePath) {
+        accessPath = await overwritePath({
+          esBucketName,
+          fileInfo,
+          defaultAccessPath: accessPath,
+        });
+      }
 
       const command = new PutObjectCommand({
         Bucket: bucketName,
@@ -143,10 +189,10 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
         expiresIn: 60 * 60, // 1 hour
       });
 
-      const url = `${baseUrl}/${accessPath}`;
+      const finalAccessUrl = `${baseUrl}/${accessPath.startsWith('/') ? accessPath.substring(1) : accessPath}`;
       return {
         uploadUrl: signedUrl,
-        accessUrl: url,
+        accessUrl: finalAccessUrl,
       };
     },
     async requestUploadParts() {
@@ -159,6 +205,11 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
       throw new Error('Not implemented');
     },
     async deleteFile({ url }) {
+      if (!bucketName) {
+        throw new Error(
+          'S3 bucketName is not configured in AWSProviderOptions for deleteFile.',
+        );
+      }
       const path = url.replace(`${baseUrl}/`, '');
       await s3Client.send(
         new DeleteObjectCommand({