@edgestore/server 0.1.0 → 0.1.2

package/dist/{shared-ae739a04.js → shared-a5b84d0b.js}

@@ -82,7 +82,8 @@ async function requestUpload(params) {
                 type: fileInfo.type,
                 fileName: fileInfo.fileName,
                 extension: fileInfo.extension,
-                replaceTargetUrl: fileInfo.replaceTargetUrl
+                replaceTargetUrl: fileInfo.replaceTargetUrl,
+                temporary: fileInfo.temporary
             }
         });
         if (!canUpload) {
@@ -176,6 +177,43 @@ async function requestUploadParts(params) {
         path
     });
 }
+async function completeMultipartUpload(params) {
+    const { provider, router, ctxToken, body: { bucketName, uploadId, key, parts } } = params;
+    if (!ctxToken) {
+        throw new EdgeStoreError({
+            message: 'Missing edgestore-ctx cookie',
+            code: 'UNAUTHORIZED'
+        });
+    }
+    await getContext(ctxToken); // just to check if the token is valid
+    const bucket = router.buckets[bucketName];
+    if (!bucket) {
+        throw new Error(`Bucket ${bucketName} not found`);
+    }
+    return await provider.completeMultipartUpload({
+        uploadId,
+        key,
+        parts
+    });
+}
+async function confirmUpload(params) {
+    const { provider, router, ctxToken, body: { bucketName, url } } = params;
+    if (!ctxToken) {
+        throw new EdgeStoreError({
+            message: 'Missing edgestore-ctx cookie',
+            code: 'UNAUTHORIZED'
+        });
+    }
+    await getContext(ctxToken); // just to check if the token is valid
+    const bucket = router.buckets[bucketName];
+    if (!bucket) {
+        throw new Error(`Bucket ${bucketName} not found`);
+    }
+    await provider.confirmUpload({
+        bucket,
+        url
+    });
+}
 async function deleteFile(params) {
     const { provider, router, ctxToken, body: { bucketName, url } } = params;
     if (!ctxToken) {
@@ -264,6 +302,8 @@ async function getContext(token) {
 
 exports.EDGE_STORE_ERROR_CODES = EDGE_STORE_ERROR_CODES;
 exports.EdgeStoreError = EdgeStoreError;
+exports.completeMultipartUpload = completeMultipartUpload;
+exports.confirmUpload = confirmUpload;
 exports.deleteFile = deleteFile;
 exports.init = init;
 exports.requestUpload = requestUpload;

package/dist/{shared-fac1b0a0.js → shared-a86ccc68.js}

@@ -78,6 +78,7 @@ async function requestUpload(params) {
                 fileName: fileInfo.fileName,
                 extension: fileInfo.extension,
                 replaceTargetUrl: fileInfo.replaceTargetUrl,
+                temporary: fileInfo.temporary,
             },
         });
         if (!canUpload) {
@@ -166,6 +167,43 @@ async function requestUploadParts(params) {
         path,
     });
 }
+async function completeMultipartUpload(params) {
+    const { provider, router, ctxToken, body: { bucketName, uploadId, key, parts }, } = params;
+    if (!ctxToken) {
+        throw new EdgeStoreError({
+            message: 'Missing edgestore-ctx cookie',
+            code: 'UNAUTHORIZED',
+        });
+    }
+    await getContext(ctxToken); // just to check if the token is valid
+    const bucket = router.buckets[bucketName];
+    if (!bucket) {
+        throw new Error(`Bucket ${bucketName} not found`);
+    }
+    return await provider.completeMultipartUpload({
+        uploadId,
+        key,
+        parts,
+    });
+}
+async function confirmUpload(params) {
+    const { provider, router, ctxToken, body: { bucketName, url }, } = params;
+    if (!ctxToken) {
+        throw new EdgeStoreError({
+            message: 'Missing edgestore-ctx cookie',
+            code: 'UNAUTHORIZED',
+        });
+    }
+    await getContext(ctxToken); // just to check if the token is valid
+    const bucket = router.buckets[bucketName];
+    if (!bucket) {
+        throw new Error(`Bucket ${bucketName} not found`);
+    }
+    await provider.confirmUpload({
+        bucket,
+        url,
+    });
+}
 async function deleteFile(params) {
     const { provider, router, ctxToken, body: { bucketName, url }, } = params;
     if (!ctxToken) {
@@ -256,4 +294,4 @@ async function getContext(token) {
     return await decryptJWT(token);
 }
 
-export { EdgeStoreError as E, requestUploadParts as a, EDGE_STORE_ERROR_CODES as b, deleteFile as d, init as i, requestUpload as r };
+export { EdgeStoreError as E, requestUploadParts as a, confirmUpload as b, completeMultipartUpload as c, deleteFile as d, EDGE_STORE_ERROR_CODES as e, init as i, requestUpload as r };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@edgestore/server",
-  "version": "0.1.0",
-  "description": "The best DX for uploading files from your Next.js app",
+  "version": "0.1.2",
+  "description": "Upload files with ease from React/Next.js",
   "homepage": "https://edgestore.dev",
   "repository": "https://github.com/edgestorejs/edgestore.git",
   "author": "Ravi <me@ravi.com>",
@@ -37,6 +37,11 @@
       "require": "./dist/core/index.js",
       "default": "./dist/core/index.js"
     },
+    "./adapters": {
+      "import": "./dist/adapters/index.mjs",
+      "require": "./dist/adapters/index.js",
+      "default": "./dist/adapters/index.js"
+    },
     "./adapters/next/pages": {
       "import": "./dist/adapters/next/pages/index.mjs",
       "require": "./dist/adapters/next/pages/index.js",
@@ -56,6 +61,11 @@
       "import": "./dist/providers/edgestore/index.mjs",
       "require": "./dist/providers/edgestore/index.js",
       "default": "./dist/providers/edgestore/index.js"
+    },
+    "./providers": {
+      "import": "./dist/providers/index.mjs",
+      "require": "./dist/providers/index.js",
+      "default": "./dist/providers/index.js"
     }
   },
   "files": [
@@ -94,5 +104,5 @@
     "typescript": "^5.1.6",
     "zod": "^3.21.4"
   },
-  "gitHead": "02d8fe7865f94c75d0b09f6725f3ff3471abb549"
+  "gitHead": "99519b57aa7a5cbbe5cab16b85a70d437cb87435"
 }

package/providers/index.d.ts

@@ -0,0 +1 @@
+export * from '../dist/providers';

package/providers/index.js

@@ -0,0 +1 @@
+module.exports = require('../dist/providers');

package/src/adapters/index.ts

@@ -0,0 +1,6 @@
+export type {
+  InitRes,
+  RequestUploadRes,
+  RequestUploadPartsRes,
+  DeleteFileRes,
+} from './shared';

package/src/adapters/next/app/index.ts

@@ -1,19 +1,23 @@
-import { NextRequest } from 'next/server';
-import { EdgeStoreRouter } from '../../../core/internals/bucketBuilder';
+import { type NextRequest } from 'next/server';
+import { type EdgeStoreRouter } from '../../../core/internals/bucketBuilder';
 import EdgeStoreError, {
   EDGE_STORE_ERROR_CODES,
 } from '../../../libs/errors/EdgeStoreError';
 import { EdgeStoreProvider } from '../../../providers/edgestore';
-import { Provider } from '../../../providers/types';
-import { MaybePromise } from '../../../types';
+import { type Provider } from '../../../providers/types';
+import { type MaybePromise } from '../../../types';
 import {
+  completeMultipartUpload,
+  confirmUpload,
   deleteFile,
-  DeleteFileBody,
   init,
   requestUpload,
-  RequestUploadBody,
   requestUploadParts,
-  RequestUploadPartsParams,
+  type CompleteMultipartUploadBody,
+  type ConfirmUploadBody,
+  type DeleteFileBody,
+  type RequestUploadBody,
+  type RequestUploadPartsParams,
 } from '../../shared';
 
 export type CreateContextOptions = {
@@ -86,6 +90,28 @@ export function createEdgeStoreNextHandler<TCtx>(config: Config<TCtx>) {
             'Content-Type': 'application/json',
           },
         });
+      } else if (
+        req.nextUrl.pathname === '/api/edgestore/complete-multipart-upload'
+      ) {
+        await completeMultipartUpload({
+          provider,
+          router: config.router,
+          body: (await req.json()) as CompleteMultipartUploadBody,
+          ctxToken: req.cookies.get('edgestore-ctx')?.value,
+        });
+        return new Response(null, {
+          status: 200,
+        });
+      } else if (req.nextUrl.pathname === '/api/edgestore/confirm-upload') {
+        await confirmUpload({
+          provider,
+          router: config.router,
+          body: (await req.json()) as ConfirmUploadBody,
+          ctxToken: req.cookies.get('edgestore-ctx')?.value,
+        });
+        return new Response(null, {
+          status: 200,
+        });
       } else if (req.nextUrl.pathname === '/api/edgestore/delete-file') {
         await deleteFile({
           provider,

package/src/adapters/next/pages/index.ts

@@ -1,19 +1,23 @@
-import { NextApiRequest, NextApiResponse } from 'next/types';
-import { EdgeStoreRouter } from '../../../core/internals/bucketBuilder';
+import { type NextApiRequest, type NextApiResponse } from 'next/types';
+import { type EdgeStoreRouter } from '../../../core/internals/bucketBuilder';
 import EdgeStoreError, {
   EDGE_STORE_ERROR_CODES,
 } from '../../../libs/errors/EdgeStoreError';
 import { EdgeStoreProvider } from '../../../providers/edgestore';
-import { Provider } from '../../../providers/types';
-import { MaybePromise } from '../../../types';
+import { type Provider } from '../../../providers/types';
+import { type MaybePromise } from '../../../types';
 import {
+  completeMultipartUpload,
+  confirmUpload,
   deleteFile,
-  DeleteFileBody,
   init,
   requestUpload,
-  RequestUploadBody,
   requestUploadParts,
-  RequestUploadPartsParams,
+  type CompleteMultipartUploadBody,
+  type ConfirmUploadBody,
+  type DeleteFileBody,
+  type RequestUploadBody,
+  type RequestUploadPartsParams,
 } from '../../shared';
 
 export type CreateContextOptions = {
@@ -69,6 +73,22 @@ export function createEdgeStoreNextHandler<TCtx>(config: Config<TCtx>) {
             ctxToken: req.cookies['edgestore-ctx'],
           }),
         );
+      } else if (req.url === '/api/edgestore/complete-multipart-upload') {
+        await completeMultipartUpload({
+          provider,
+          router: config.router,
+          body: req.body as CompleteMultipartUploadBody,
+          ctxToken: req.cookies['edgestore-ctx'],
+        });
+        res.status(200).end();
+      } else if (req.url === '/api/edgestore/confirm-upload') {
+        await confirmUpload({
+          provider,
+          router: config.router,
+          body: req.body as ConfirmUploadBody,
+          ctxToken: req.cookies['edgestore-ctx'],
+        });
+        res.status(200).end();
       } else if (req.url === '/api/edgestore/delete-file') {
         await deleteFile({
           provider,

package/src/adapters/shared.ts

@@ -2,9 +2,12 @@ import { hkdf } from '@panva/hkdf';
 import { serialize } from 'cookie';
 import { EncryptJWT, jwtDecrypt } from 'jose';
 import { v4 as uuidv4 } from 'uuid';
-import { AnyBuilder, EdgeStoreRouter } from '../core/internals/bucketBuilder';
+import {
+  type AnyBuilder,
+  type EdgeStoreRouter,
+} from '../core/internals/bucketBuilder';
 import EdgeStoreError from '../libs/errors/EdgeStoreError';
-import { Provider } from '../providers/types';
+import { type Provider } from '../providers/types';
 import { IMAGE_MIME_TYPES } from './imageTypes';
 
 // TODO: change it to 1 hour when we have a way to refresh the token
@@ -53,6 +56,7 @@ export type RequestUploadBody = {
     extension: string;
     fileName?: string;
     replaceTargetUrl?: string;
+    temporary: boolean;
   };
 };
 
@@ -90,6 +94,7 @@ export async function requestUpload<TCtx>(params: {
         fileName: fileInfo.fileName,
         extension: fileInfo.extension,
         replaceTargetUrl: fileInfo.replaceTargetUrl,
+        temporary: fileInfo.temporary,
       },
     });
     if (!canUpload) {
@@ -203,6 +208,82 @@ export async function requestUploadParts<TCtx>(params: {
   });
 }
 
+export type CompleteMultipartUploadBody = {
+  bucketName: string;
+  uploadId: string;
+  key: string;
+  parts: {
+    partNumber: number;
+    eTag: string;
+  }[];
+};
+
+export async function completeMultipartUpload<TCtx>(params: {
+  provider: Provider;
+  router: EdgeStoreRouter<TCtx>;
+  ctxToken: string | undefined;
+  body: CompleteMultipartUploadBody;
+}) {
+  const {
+    provider,
+    router,
+    ctxToken,
+    body: { bucketName, uploadId, key, parts },
+  } = params;
+  if (!ctxToken) {
+    throw new EdgeStoreError({
+      message: 'Missing edgestore-ctx cookie',
+      code: 'UNAUTHORIZED',
+    });
+  }
+  await getContext(ctxToken); // just to check if the token is valid
+  const bucket = router.buckets[bucketName];
+  if (!bucket) {
+    throw new Error(`Bucket ${bucketName} not found`);
+  }
+  return await provider.completeMultipartUpload({
+    uploadId,
+    key,
+    parts,
+  });
+}
+
+export type ConfirmUploadBody = {
+  bucketName: string;
+  url: string;
+};
+
+export async function confirmUpload<TCtx>(params: {
+  provider: Provider;
+  router: EdgeStoreRouter<TCtx>;
+  ctxToken: string | undefined;
+  body: ConfirmUploadBody;
+}) {
+  const {
+    provider,
+    router,
+    ctxToken,
+    body: { bucketName, url },
+  } = params;
+
+  if (!ctxToken) {
+    throw new EdgeStoreError({
+      message: 'Missing edgestore-ctx cookie',
+      code: 'UNAUTHORIZED',
+    });
+  }
+  await getContext(ctxToken); // just to check if the token is valid
+  const bucket = router.buckets[bucketName];
+  if (!bucket) {
+    throw new Error(`Bucket ${bucketName} not found`);
+  }
+
+  await provider.confirmUpload({
+    bucket,
+    url,
+  });
+}
+
 export type DeleteFileBody = {
   bucketName: string;
   url: string;
@@ -336,3 +417,10 @@ async function getContext(token?: string) {
   }
   return await decryptJWT(token);
 }
+
+export type InitRes = Awaited<ReturnType<typeof init>>;
+export type RequestUploadRes = Awaited<ReturnType<typeof requestUpload>>;
+export type RequestUploadPartsRes = Awaited<
+  ReturnType<typeof requestUploadParts>
+>;
+export type DeleteFileRes = Awaited<ReturnType<typeof deleteFile>>;

package/src/core/client/index.ts

@@ -1,10 +1,10 @@
-import { AnyRouter, Comparison } from '..';
-import { Simplify } from '../../types';
+import { type AnyRouter, type Comparison } from '..';
+import { type Simplify } from '../../types';
 import {
-  AnyBuilder,
-  InferBucketPathKeys,
-  InferBucketPathObject,
-  InferMetadataObject,
+  type AnyBuilder,
+  type InferBucketPathKeys,
+  type InferBucketPathObject,
+  type InferMetadataObject,
 } from '../internals/bucketBuilder';
 import { initEdgeStoreSdk } from '../sdk';
 
@@ -77,6 +77,10 @@ type EdgeStoreClient<TRouter extends AnyRouter> = {
     //   uploadUrl: string;
     //   accessUrl: string;
     // }>;
+    /**
+     * Confirm a temporary file upload.
+     */
+    confirmUpload: (params: { url: string }) => Promise<{ success: boolean }>;
     /**
      * Programmatically delete a file.
      */
@@ -168,10 +172,12 @@ export function initEdgeStoreClient<TRouter extends AnyRouter>(config: {
         //   });
         // },
 
+        async confirmUpload(params) {
+          return await sdk.confirmUpload(params);
+        },
+
         async deleteFile(params) {
-          return await sdk.deleteFile({
-            ...params,
-          });
+          return await sdk.deleteFile(params);
         },
 
         async listFiles(params) {

package/src/core/index.ts

@@ -1,4 +1,4 @@
-import { EdgeStoreRouter } from './internals/bucketBuilder';
+import { type EdgeStoreRouter } from './internals/bucketBuilder';
 
 export * from './client';
 export * from './sdk';

package/src/core/internals/bucketBuilder.ts

@@ -1,5 +1,9 @@
 import { z } from 'zod';
-import { KeysOfUnion, MaybePromise, Simplify } from '../../types';
+import {
+  type KeysOfUnion,
+  type MaybePromise,
+  type Simplify,
+} from '../../types';
 import { createPathParamProxy } from './createPathParamProxy';
 
 type Merge<TType, TWith> = {
@@ -113,6 +117,7 @@ type FileInfo = {
   extension: string;
   fileName?: string;
   replaceTargetUrl?: string;
+  temporary: boolean;
 };
 
 type BeforeUploadFn<TCtx, TDef extends AnyDef> = (params: {

package/src/core/sdk/index.ts

@@ -1,6 +1,6 @@
-import { AnyRouter } from '..';
+import { type AnyRouter } from '..';
 import EdgeStoreCredentialsError from '../../libs/errors/EdgeStoreCredentialsError';
-import { AnyContext, AnyMetadata } from '../internals/bucketBuilder';
+import { type AnyContext, type AnyMetadata } from '../internals/bucketBuilder';
 
 const API_ENDPOINT =
   process.env.EDGE_STORE_API_ENDPOINT ?? 'https://api.edgestore.dev';
@@ -17,6 +17,7 @@ type FileInfoForUpload = {
   metadata: AnyMetadata;
   fileName?: string;
   replaceTargetUrl?: string;
+  temporary: boolean;
 };
 
 export type SimpleOperator =
@@ -162,6 +163,7 @@ export const edgeStoreRawSdk = {
   }) {
     const res = await makeRequest<{
       multipart?: {
+        key: string;
         uploadId: string;
         parts: {
           partNumber: number;
@@ -170,6 +172,8 @@ export const edgeStoreRawSdk = {
       };
       signedUrl?: string;
       url: string;
+      path: string;
+      thumbnailUrl: string | null;
     }>({
       path: '/request-upload',
       accessKey,
@@ -186,12 +190,15 @@ export const edgeStoreRawSdk = {
         metadata: fileInfo.metadata,
         fileName: fileInfo.fileName,
         replaceTargetUrl: fileInfo.replaceTargetUrl,
+        isTemporary: fileInfo.temporary,
       },
     });
     return {
       multipart: res.multipart,
       signedUrl: res.signedUrl,
       accessUrl: res.url,
+      path: res.path,
+      thumbnailUrl: res.thumbnailUrl,
     };
   },
 
@@ -231,6 +238,53 @@ export const edgeStoreRawSdk = {
     };
   },
 
+  async completeMultipartUpload({
+    accessKey,
+    secretKey,
+    uploadId,
+    key,
+    parts,
+  }: {
+    accessKey: string;
+    secretKey: string;
+    uploadId: string;
+    key: string;
+    parts: {
+      partNumber: number;
+      eTag: string;
+    }[];
+  }) {
+    return await makeRequest<{ success: boolean }>({
+      path: '/complete-multipart-upload',
+      accessKey,
+      secretKey,
+      body: {
+        uploadId,
+        key,
+        parts,
+      },
+    });
+  },
+
+  async confirmUpload({
+    accessKey,
+    secretKey,
+    url,
+  }: {
+    accessKey: string;
+    secretKey: string;
+    url: string;
+  }) {
+    return await makeRequest<{ success: boolean }>({
+      path: '/confirm-upload',
+      accessKey,
+      secretKey,
+      body: {
+        url,
+      },
+    });
+  },
+
   async deleteFile({
     accessKey,
     secretKey,
@@ -359,6 +413,33 @@ export function initEdgeStoreSdk(params: {
         multipart,
       });
     },
+    async completeMultipartUpload({
+      uploadId,
+      key,
+      parts,
+    }: {
+      uploadId: string;
+      key: string;
+      parts: {
+        partNumber: number;
+        eTag: string;
+      }[];
+    }) {
+      return await edgeStoreRawSdk.completeMultipartUpload({
+        accessKey,
+        secretKey,
+        uploadId,
+        key,
+        parts,
+      });
+    },
+    async confirmUpload({ url }: { url: string }) {
+      return await edgeStoreRawSdk.confirmUpload({
+        accessKey,
+        secretKey,
+        url,
+      });
+    },
     async deleteFile({ url }: { url: string }) {
       return await edgeStoreRawSdk.deleteFile({
         accessKey,

package/src/providers/aws/index.ts

@@ -6,13 +6,40 @@ import {
 } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
 import { v4 as uuidv4 } from 'uuid';
-import { Provider } from '../types';
+import { type Provider } from '../types';
 
 export type AWSProviderOptions = {
+  /**
+   * Access key for AWS credentials.
+   * Can also be set via the `ES_AWS_ACCESS_KEY_ID` environment variable.
+   *
+   * If unset, the SDK will attempt to use the default credentials provider chain.
+   */
   accessKeyId?: string;
+  /**
+   * Secret access key for AWS credentials.
+   * Can also be set via the `ES_AWS_SECRET_ACCESS_KEY` environment variable.
+   *
+   * If unset, the SDK will attempt to use the default credentials provider chain.
+   */
   secretAccessKey?: string;
+  /**
+   * AWS region to use.
+   * Can also be set via the `ES_AWS_REGION` environment variable.
+   */
   region?: string;
+  /**
+   * Name of the S3 bucket to use.
+   * Can also be set via the `ES_AWS_BUCKET_NAME` environment variable.
+   */
   bucketName?: string;
+  /**
+   * Base URL to use for accessing files.
+   * Only needed if you are using a custom domain or cloudfront.
+   *
+   * Can also be set via the `EDGE_STORE_BASE_URL` environment variable.
+   */
+  baseUrl?: string;
 };
 
 export function AWSProvider(options?: AWSProviderOptions): Provider {
@@ -23,6 +50,11 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
     bucketName = process.env.ES_AWS_BUCKET_NAME,
   } = options ?? {};
 
+  const baseUrl =
+    options?.baseUrl ??
+    process.env.EDGE_STORE_BASE_URL ??
+    `https://${bucketName}.s3.${region}.amazonaws.com`;
+
   const credentials =
     accessKeyId && secretAccessKey
       ? {
@@ -32,10 +64,6 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
       : undefined;
   const s3Client = new S3Client({ region, credentials });
 
-  const baseUrl =
-    process.env.EDGE_STORE_BASE_URL ??
-    `https://${bucketName}.s3.${region}.amazonaws.com`;
-
   return {
     async init() {
       return {};
@@ -93,6 +121,12 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
     async requestUploadParts() {
       throw new Error('Not implemented');
     },
+    async completeMultipartUpload() {
+      throw new Error('Not implemented');
+    },
+    async confirmUpload() {
+      throw new Error('Not implemented');
+    },
     async deleteFile({ url }) {
       const path = url.replace(`${baseUrl}/`, '');
       await s3Client.send(