@edgestore/server 0.1.5-alpha.8 → 0.1.5

package/src/adapters/express/index.ts

@@ -0,0 +1,165 @@
+import {
+  EDGE_STORE_ERROR_CODES,
+  EdgeStoreError,
+  type EdgeStoreErrorCodeKey,
+  type EdgeStoreRouter,
+  type MaybePromise,
+  type Provider,
+} from '@edgestore/shared';
+import { type Request, type Response } from 'express';
+import Logger, { type LogLevel } from '../../libs/logger';
+import { EdgeStoreProvider } from '../../providers/edgestore';
+import {
+  completeMultipartUpload,
+  confirmUpload,
+  deleteFile,
+  init,
+  requestUpload,
+  requestUploadParts,
+  type CompleteMultipartUploadBody,
+  type ConfirmUploadBody,
+  type DeleteFileBody,
+  type RequestUploadBody,
+  type RequestUploadPartsParams,
+} from '../shared';
+
+export type CreateContextOptions = {
+  req: Request;
+  res: Response;
+};
+
+export type Config<TCtx> = {
+  provider?: Provider;
+  router: EdgeStoreRouter<TCtx>;
+  logLevel?: LogLevel;
+} & (TCtx extends Record<string, never>
+  ? object
+  : {
+      provider?: Provider;
+      router: EdgeStoreRouter<TCtx>;
+      createContext: (opts: CreateContextOptions) => MaybePromise<TCtx>;
+    });
+
+declare const globalThis: {
+  _EDGE_STORE_LOGGER: Logger;
+};
+
+export function createEdgeStoreExpressHandler<TCtx>(config: Config<TCtx>) {
+  const { provider = EdgeStoreProvider() } = config;
+  const log = new Logger(config.logLevel);
+  globalThis._EDGE_STORE_LOGGER = log;
+  log.debug('Creating Edge Store Express handler');
+
+  return async (req: Request, res: Response) => {
+    try {
+      if (req.url?.includes?.('/health')) {
+        res.send('OK');
+      } else if (req.url?.includes?.('/init')) {
+        let ctx = {} as TCtx;
+        try {
+          ctx =
+            'createContext' in config
+              ? await config.createContext({ req, res })
+              : ({} as TCtx);
+        } catch (err) {
+          throw new EdgeStoreError({
+            message: 'Error creating context',
+            code: 'CREATE_CONTEXT_ERROR',
+            cause: err instanceof Error ? err : undefined,
+          });
+        }
+        const { newCookies, token, baseUrl } = await init({
+          ctx,
+          provider,
+          router: config.router,
+        });
+        res.setHeader('Set-Cookie', newCookies);
+        res.json({
+          token,
+          baseUrl,
+        });
+      } else if (req.url?.includes?.('/request-upload')) {
+        res.json(
+          await requestUpload({
+            provider,
+            router: config.router,
+            body: req.body as RequestUploadBody,
+            ctxToken: req.cookies['edgestore-ctx'],
+          }),
+        );
+      } else if (req.url?.includes?.('/request-upload-parts')) {
+        res.json(
+          await requestUploadParts({
+            provider,
+            router: config.router,
+            body: req.body as RequestUploadPartsParams,
+            ctxToken: req.cookies['edgestore-ctx'],
+          }),
+        );
+      } else if (req.url?.includes?.('/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?.includes?.('/confirm-upload')) {
+        res.json(
+          await confirmUpload({
+            provider,
+            router: config.router,
+            body: req.body as ConfirmUploadBody,
+            ctxToken: req.cookies['edgestore-ctx'],
+          }),
+        );
+      } else if (req.url?.includes?.('/delete-file')) {
+        res.json(
+          await deleteFile({
+            provider,
+            router: config.router,
+            body: req.body as DeleteFileBody,
+            ctxToken: req.cookies['edgestore-ctx'],
+          }),
+        );
+      } else if (req.url?.includes?.('/proxy-file')) {
+        const { url } = req.query;
+        if (typeof url === 'string') {
+          const proxyRes = await fetch(url, {
+            headers: {
+              cookie: req.headers.cookie ?? '',
+            },
+          });
+
+          const data = await proxyRes.arrayBuffer();
+          res.setHeader(
+            'Content-Type',
+            proxyRes.headers.get('Content-Type') ?? 'application/octet-stream',
+          );
+
+          res.end(Buffer.from(data));
+        } else {
+          res.status(400).end();
+        }
+      } else {
+        res.status(404).end();
+      }
+    } catch (err) {
+      if (err instanceof EdgeStoreError) {
+        log[err.level](err.formattedMessage());
+        if (err.cause) log[err.level](err.cause);
+        res
+          .status(EDGE_STORE_ERROR_CODES[err.code as EdgeStoreErrorCodeKey])
+          .json(err.formattedJson());
+      } else {
+        log.error(err);
+        res.status(500).send(
+          new EdgeStoreError({
+            message: 'Internal Server Error',
+            code: 'SERVER_ERROR',
+          }).formattedJson(),
+        );
+      }
+    }
+  };
+}

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

@@ -1,13 +1,14 @@
-import { type NextRequest } from 'next/server';
-import { type EdgeStoreRouter } from '../../../core/internals/bucketBuilder';
-import EdgeStoreError, {
+import {
   EDGE_STORE_ERROR_CODES,
+  EdgeStoreError,
   type EdgeStoreErrorCodeKey,
-} from '../../../libs/errors/EdgeStoreError';
+  type EdgeStoreRouter,
+  type MaybePromise,
+  type Provider,
+} from '@edgestore/shared';
+import { type NextRequest } from 'next/server';
 import Logger, { type LogLevel } from '../../../libs/logger';
 import { EdgeStoreProvider } from '../../../providers/edgestore';
-import { type Provider } from '../../../providers/types';
-import { type MaybePromise } from '../../../types';
 import {
   completeMultipartUpload,
   confirmUpload,
@@ -56,7 +57,11 @@ export function createEdgeStoreNextHandler<TCtx>(config: Config<TCtx>) {
             'Error running the app adapter. Make sure you are importing the correct adapter in your router configuration',
           code: 'SERVER_ERROR',
         });
-      if (req.nextUrl.pathname.endsWith('/init')) {
+      if (req.nextUrl.pathname.endsWith('/health')) {
+        return new Response('OK', {
+          status: 200,
+        });
+      } else if (req.nextUrl.pathname.endsWith('/init')) {
         let ctx = {} as TCtx;
         try {
           ctx =

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

@@ -1,13 +1,14 @@
-import { type NextApiRequest, type NextApiResponse } from 'next/types';
-import { type EdgeStoreRouter } from '../../../core/internals/bucketBuilder';
-import EdgeStoreError, {
+import {
   EDGE_STORE_ERROR_CODES,
+  EdgeStoreError,
   type EdgeStoreErrorCodeKey,
-} from '../../../libs/errors/EdgeStoreError';
+  type EdgeStoreRouter,
+  type MaybePromise,
+  type Provider,
+} from '@edgestore/shared';
+import { type NextApiRequest, type NextApiResponse } from 'next/types';
 import Logger, { type LogLevel } from '../../../libs/logger';
 import { EdgeStoreProvider } from '../../../providers/edgestore';
-import { type Provider } from '../../../providers/types';
-import { type MaybePromise } from '../../../types';
 import {
   completeMultipartUpload,
   confirmUpload,
@@ -57,7 +58,9 @@ export function createEdgeStoreNextHandler<TCtx>(config: Config<TCtx>) {
             'Error running the pages adapter. Make sure you are importing the correct adapter in your router configuration',
           code: 'SERVER_ERROR',
         });
-      if (req.url?.includes?.('/init')) {
+      if (req.url?.includes?.('/health')) {
+        res.send('OK');
+      } else if (req.url?.includes?.('/init')) {
         let ctx = {} as TCtx;
         try {
           ctx =

package/src/adapters/shared.ts

@@ -1,14 +1,18 @@
+import {
+  EdgeStoreError,
+  type AnyBuilder,
+  type EdgeStoreRouter,
+  type Provider,
+  type SharedDeleteFileRes,
+  type SharedInitRes,
+  type SharedRequestUploadPartsRes,
+  type SharedRequestUploadRes,
+} from '@edgestore/shared';
 import { hkdf } from '@panva/hkdf';
 import { serialize } from 'cookie';
 import { EncryptJWT, jwtDecrypt } from 'jose';
 import { v4 as uuidv4 } from 'uuid';
-import {
-  type AnyBuilder,
-  type EdgeStoreRouter,
-} from '../core/internals/bucketBuilder';
-import EdgeStoreError from '../libs/errors/EdgeStoreError';
 import type Logger from '../libs/logger';
-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
@@ -22,7 +26,7 @@ export async function init<TCtx>(params: {
   provider: Provider;
   router: EdgeStoreRouter<TCtx>;
   ctx: TCtx;
-}) {
+}): Promise<SharedInitRes> {
   const log = globalThis._EDGE_STORE_LOGGER;
   const { ctx, provider, router } = params;
   log.debug('Running [init]', { ctx });
@@ -74,7 +78,7 @@ export async function requestUpload<TCtx>(params: {
   router: EdgeStoreRouter<TCtx>;
   ctxToken: string | undefined;
   body: RequestUploadBody;
-}) {
+}): Promise<SharedRequestUploadRes> {
   const {
     provider,
     router,
@@ -231,7 +235,7 @@ export async function requestUploadParts<TCtx>(params: {
   router: EdgeStoreRouter<TCtx>;
   ctxToken: string | undefined;
   body: RequestUploadPartsParams;
-}) {
+}): Promise<SharedRequestUploadPartsRes> {
   const {
     provider,
     ctxToken,
@@ -370,7 +374,7 @@ export async function deleteFile<TCtx>(params: {
   router: EdgeStoreRouter<TCtx>;
   ctxToken: string | undefined;
   body: DeleteFileBody;
-}) {
+}): Promise<SharedDeleteFileRes> {
   const {
     provider,
     router,
@@ -544,10 +548,3 @@ function unproxyUrl(url: string) {
   }
   return url;
 }
-
-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,14 +1,16 @@
 /* eslint-disable @typescript-eslint/ban-types */
-import { type z, type ZodNever } from 'zod';
-import { type AnyRouter, type Comparison } from '..';
-import { buildPath, parsePath } from '../../adapters/shared';
-import { type Prettify, type Simplify } from '../../types';
 import {
   type AnyBuilder,
+  type AnyRouter,
   type InferBucketPathKeys,
   type InferBucketPathObject,
   type InferMetadataObject,
-} from '../internals/bucketBuilder';
+  type Prettify,
+  type Simplify,
+} from '@edgestore/shared';
+import { type z, type ZodNever } from 'zod';
+import { type Comparison } from '..';
+import { buildPath, parsePath } from '../../adapters/shared';
 import { initEdgeStoreSdk } from '../sdk';
 
 export type GetFileRes<TBucket extends AnyBuilder> = {
@@ -79,27 +81,22 @@ export type UploadFileRequest<TBucket extends AnyBuilder> = {
    * If it's a string, it will be converted to a blob with the type `text/plain`.
    *
    * @example
-   * ```ts
    * // string
    * content: "some text"
-   * ```
    *
    * @example
-   * ```ts
    * // blob
    * content: {
    *   blob: new Blob([text], { type: "text/csv" }),
    *   extension: "csv",
    * }
-   * ```
    *
    * @example
-   * ```ts
    * // url
    * content: {
-   *  url: "https://example.com/my-file.csv",
+   *   url: "https://example.com/my-file.csv",
+   *   extension: "csv",
    * }
-   * ```
    */
   content: TextContent | BlobContent | UrlContent;
   options?: UploadOptions;

package/src/core/index.ts

@@ -1,17 +1,2 @@
-import { type EdgeStoreRouter } from './internals/bucketBuilder';
-
 export * from './client';
 export * from './sdk';
-export type {
-  InferBucketPathKeys,
-  InferBucketPathObject,
-  InferMetadataObject,
-} from './internals/bucketBuilder';
-export type {
-  EdgeStoreErrorCodeKey,
-  EdgeStoreErrorDetails,
-  EdgeStoreJsonResponse,
-} from '../libs/errors/EdgeStoreError';
-export { EdgeStoreApiClientError } from '../libs/errors/EdgeStoreApiClientError';
-
-export type AnyRouter = EdgeStoreRouter<any>;

package/src/core/sdk/index.ts

@@ -1,7 +1,10 @@
-import { type AnyRouter } from '..';
+import {
+  EdgeStoreError,
+  type AnyContext,
+  type AnyMetadata,
+  type AnyRouter,
+} from '@edgestore/shared';
 import EdgeStoreCredentialsError from '../../libs/errors/EdgeStoreCredentialsError';
-import EdgeStoreError from '../../libs/errors/EdgeStoreError';
-import { type AnyContext, type AnyMetadata } from '../internals/bucketBuilder';
 
 const API_ENDPOINT =
   process.env.EDGE_STORE_API_ENDPOINT ?? 'https://api.edgestore.dev';

package/src/index.ts

@@ -1 +1 @@
-export { initEdgeStore } from './core/internals/bucketBuilder';
+export { initEdgeStore } from '@edgestore/shared';

package/src/libs/errors/EdgeStoreCredentialsError.ts

@@ -1,6 +1,5 @@
 const DEFAULT_MESSAGE = `Missing EDGE_STORE_ACCESS_KEY or EDGE_STORE_SECRET_KEY. 
-This can happen if you are trying to use the vanilla client in your frontend.
-The vanilla client should only be used in the backend.`;
+This can happen if you are trying to import something related to the backend of Edge Store in a client component.`;
 
 class EdgeStoreCredentialsError extends Error {
   constructor(message = DEFAULT_MESSAGE) {

package/src/providers/aws/index.ts

@@ -5,8 +5,8 @@ import {
   S3Client,
 } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+import { type Provider } from '@edgestore/shared';
 import { v4 as uuidv4 } from 'uuid';
-import { type Provider } from '../types';
 
 export type AWSProviderOptions = {
   /**

package/src/providers/azure/index.ts

@@ -1,6 +1,6 @@
 import { BlobServiceClient } from '@azure/storage-blob';
+import { type Provider } from '@edgestore/shared';
 import { v4 as uuidv4 } from 'uuid';
-import { type Provider } from '../types';
 
 export type AzureProviderOptions = {
   /**

package/src/providers/edgestore/index.ts

@@ -1,7 +1,10 @@
+import {
+  EdgeStoreError,
+  type Provider,
+  type RequestUploadRes,
+} from '@edgestore/shared';
 import { initEdgeStoreSdk } from '../../core/sdk';
 import EdgeStoreCredentialsError from '../../libs/errors/EdgeStoreCredentialsError';
-import EdgeStoreError from '../../libs/errors/EdgeStoreError';
-import { type Provider, type RequestUploadRes } from '../types';
 
 const DEFAULT_BASE_URL = 'https://files.edgestore.dev';
 

package/dist/adapters/index.d.ts

@@ -1,2 +0,0 @@
-export type { InitRes, RequestUploadRes, RequestUploadPartsRes, DeleteFileRes, } from './shared';
-//# sourceMappingURL=index.d.ts.map

package/dist/adapters/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/adapters/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,OAAO,EACP,gBAAgB,EAChB,qBAAqB,EACrB,aAAa,GACd,MAAM,UAAU,CAAC"}

package/dist/adapters/index.js

@@ -1,2 +0,0 @@
-'use strict';
-

package/dist/adapters/index.mjs

@@ -1 +0,0 @@
-