@edgestore/server 0.0.0-alpha.12

package/dist/index.js

@@ -0,0 +1,213 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var zod = require('zod');
+
+/**
+ * Creates a Proxy that prints the path to the property when called.
+ *
+ * Example:
+ *
+ * ```ts
+ * const pathParamProxy = createPathParamProxy();
+ * console.log(pathParamProxy.ctx.user.id());
+ * // Logs: "ctx.user.id"
+ * console.log(pathParamProxy.input.type());
+ * // Logs: "input.type"
+ * ```
+ */ function createPathParamProxy() {
+    const getPath = (target, _prop)=>{
+        const proxyFunction = ()=>target;
+        return new Proxy(proxyFunction, {
+            get: (_target, propChild)=>{
+                return getPath(`${target}.${String(propChild)}`);
+            }
+        });
+    };
+    return new Proxy(()=>'', {
+        get: (_target, prop)=>{
+            return getPath(String(prop));
+        }
+    });
+}
+
+const createNewBuilder = (initDef, newDef)=>{
+    const mergedDef = {
+        ...initDef,
+        ...newDef
+    };
+    return createBuilder({
+        type: mergedDef.type
+    }, mergedDef);
+};
+function createBuilder(opts, initDef) {
+    const _def = {
+        type: opts.type,
+        input: zod.z.never(),
+        path: [],
+        ...initDef
+    };
+    return {
+        $config: {
+            ctx: undefined
+        },
+        _def,
+        input (input) {
+            return createNewBuilder(_def, {
+                input
+            });
+        },
+        path (pathResolver) {
+            // TODO: Should throw a runtime error in the followin cases:
+            // 1. in case of multiple keys in one object
+            // 2. in case of duplicate keys
+            const pathParamProxy = createPathParamProxy();
+            const params = pathResolver(pathParamProxy);
+            return createNewBuilder(_def, {
+                path: params
+            });
+        },
+        metadata (metadata) {
+            return createNewBuilder(_def, {
+                metadata
+            });
+        },
+        accessControl (accessControl) {
+            return createNewBuilder(_def, {
+                accessControl: accessControl
+            });
+        },
+        beforeUpload (beforeUpload) {
+            return createNewBuilder(_def, {
+                beforeUpload
+            });
+        },
+        beforeDelete (beforeDelete) {
+            return createNewBuilder(_def, {
+                beforeDelete
+            });
+        }
+    };
+}
+class EdgeStoreBuilder {
+    context() {
+        return new EdgeStoreBuilder();
+    }
+    create() {
+        return createEdgeStoreInner()();
+    }
+}
+function createRouterFactory() {
+    return function createRouterInner(buckets) {
+        return {
+            $config: {
+                ctx: undefined
+            },
+            buckets
+        };
+    };
+}
+function createEdgeStoreInner() {
+    return function initEdgeStoreInner() {
+        return {
+            /**
+       * Builder object for creating an image bucket
+       */ imageBucket: createBuilder({
+                type: 'IMAGE'
+            }),
+            /**
+       * Builder object for creating a file bucket
+       */ fileBucket: createBuilder({
+                type: 'FILE'
+            }),
+            /**
+       * Create a router
+       */ router: createRouterFactory()
+        };
+    };
+}
+/**
+ * Initialize EdgeStore - be done exactly once per backend
+ */ const initEdgeStore = new EdgeStoreBuilder(); // ↓↓↓ TYPE TESTS ↓↓↓
+ // type Context = {
+ //   userId: string;
+ //   userRole: 'admin' | 'visitor';
+ // };
+ // const es = initEdgeStore.context<Context>().create();
+ // const imagesBucket = es.imageBucket
+ //   .input(
+ //     z.object({
+ //       type: z.enum(['profile', 'post']),
+ //       extension: z.string().optional(),
+ //     }),
+ //   )
+ //   .path(({ ctx, input }) => [{ author: ctx.userId }, { type: input.type }])
+ //   .metadata(({ ctx, input }) => ({
+ //     extension: input.extension,
+ //     role: ctx.userRole,
+ //   }))
+ //   .beforeUpload(() => {
+ //     return true;
+ //   });
+ // const a = es.imageBucket
+ //   .input(z.object({ type: z.string(), someMeta: z.string().optional() }))
+ //   .path(({ ctx, input }) => [{ author: ctx.userId }, { type: input.type }])
+ //   .metadata(({ ctx, input }) => ({
+ //     role: ctx.userRole,
+ //     someMeta: input.someMeta,
+ //   }))
+ //   .accessControl({
+ //     OR: [
+ //       {
+ //         userId: { path: 'author' }, // this will check if the userId is the same as the author in the path parameter
+ //       },
+ //       {
+ //         userRole: 'admin', // this is the same as { userRole: { eq: "admin" } }
+ //       },
+ //     ],
+ //   })
+ //   .beforeUpload(({ ctx, input }) => {
+ //     return true;
+ //   })
+ //   .beforeDelete(({ ctx, file }) => {
+ //     return true;
+ //   });
+ // const b = es.imageBucket.path(({ ctx }) => [{ author: ctx.userId }]);
+ // const router = es.router({
+ //   original: imagesBucket,
+ //   imageBucket: a,
+ //   imageBucket2: b,
+ // });
+ // export { router };
+ // type ListFilesResponse<TBucket extends AnyRouter['buckets'][string]> = {
+ //   data: {
+ //     // url: string;
+ //     // size: number;
+ //     // uploadedAt: Date;
+ //     // metadata: InferMetadataObject<TBucket>;
+ //     path: InferBucketPathKeys<TBucket> extends string ? {
+ //       [key: string]: string;
+ //     } :{
+ //       [TKey in InferBucketPathKeys<TBucket>]: string;
+ //     };
+ //   }[];
+ //   pagination: {
+ //     currentPage: number;
+ //     totalPages: number;
+ //     totalCount: number;
+ //   };
+ // };
+ // type TPathKeys = 'author' | 'type';
+ // type TPathKeys2 = InferBucketPathKeys<AnyBuilder>;
+ // type ObjectWithKeys<TKeys extends string> = {
+ //   [TKey in TKeys]: string;
+ // };
+ // type Test1 = ObjectWithKeys<TPathKeys>;
+ // type Test2 = ObjectWithKeys<TPathKeys2>;
+ // type PathKeys = InferBucketPathKeys<typeof router.buckets.imageBucket>;
+ // type MetadataKeys = InferMetadataObject<typeof router.buckets.imageBucket>;
+ // type MyEdgeStoreRouter = typeof router;
+ // type MyAccessControl = AccessControlSchema<Context, AnyDef>;
+
+exports.initEdgeStore = initEdgeStore;

package/dist/index.mjs

@@ -0,0 +1,209 @@
+import { z } from 'zod';
+
+/**
+ * Creates a Proxy that prints the path to the property when called.
+ *
+ * Example:
+ *
+ * ```ts
+ * const pathParamProxy = createPathParamProxy();
+ * console.log(pathParamProxy.ctx.user.id());
+ * // Logs: "ctx.user.id"
+ * console.log(pathParamProxy.input.type());
+ * // Logs: "input.type"
+ * ```
+ */ function createPathParamProxy() {
+    const getPath = (target, _prop)=>{
+        const proxyFunction = ()=>target;
+        return new Proxy(proxyFunction, {
+            get: (_target, propChild)=>{
+                return getPath(`${target}.${String(propChild)}`);
+            }
+        });
+    };
+    return new Proxy(()=>'', {
+        get: (_target, prop)=>{
+            return getPath(String(prop));
+        }
+    });
+}
+
+const createNewBuilder = (initDef, newDef)=>{
+    const mergedDef = {
+        ...initDef,
+        ...newDef
+    };
+    return createBuilder({
+        type: mergedDef.type
+    }, mergedDef);
+};
+function createBuilder(opts, initDef) {
+    const _def = {
+        type: opts.type,
+        input: z.never(),
+        path: [],
+        ...initDef
+    };
+    return {
+        $config: {
+            ctx: undefined
+        },
+        _def,
+        input (input) {
+            return createNewBuilder(_def, {
+                input
+            });
+        },
+        path (pathResolver) {
+            // TODO: Should throw a runtime error in the followin cases:
+            // 1. in case of multiple keys in one object
+            // 2. in case of duplicate keys
+            const pathParamProxy = createPathParamProxy();
+            const params = pathResolver(pathParamProxy);
+            return createNewBuilder(_def, {
+                path: params
+            });
+        },
+        metadata (metadata) {
+            return createNewBuilder(_def, {
+                metadata
+            });
+        },
+        accessControl (accessControl) {
+            return createNewBuilder(_def, {
+                accessControl: accessControl
+            });
+        },
+        beforeUpload (beforeUpload) {
+            return createNewBuilder(_def, {
+                beforeUpload
+            });
+        },
+        beforeDelete (beforeDelete) {
+            return createNewBuilder(_def, {
+                beforeDelete
+            });
+        }
+    };
+}
+class EdgeStoreBuilder {
+    context() {
+        return new EdgeStoreBuilder();
+    }
+    create() {
+        return createEdgeStoreInner()();
+    }
+}
+function createRouterFactory() {
+    return function createRouterInner(buckets) {
+        return {
+            $config: {
+                ctx: undefined
+            },
+            buckets
+        };
+    };
+}
+function createEdgeStoreInner() {
+    return function initEdgeStoreInner() {
+        return {
+            /**
+       * Builder object for creating an image bucket
+       */ imageBucket: createBuilder({
+                type: 'IMAGE'
+            }),
+            /**
+       * Builder object for creating a file bucket
+       */ fileBucket: createBuilder({
+                type: 'FILE'
+            }),
+            /**
+       * Create a router
+       */ router: createRouterFactory()
+        };
+    };
+}
+/**
+ * Initialize EdgeStore - be done exactly once per backend
+ */ const initEdgeStore = new EdgeStoreBuilder(); // ↓↓↓ TYPE TESTS ↓↓↓
+ // type Context = {
+ //   userId: string;
+ //   userRole: 'admin' | 'visitor';
+ // };
+ // const es = initEdgeStore.context<Context>().create();
+ // const imagesBucket = es.imageBucket
+ //   .input(
+ //     z.object({
+ //       type: z.enum(['profile', 'post']),
+ //       extension: z.string().optional(),
+ //     }),
+ //   )
+ //   .path(({ ctx, input }) => [{ author: ctx.userId }, { type: input.type }])
+ //   .metadata(({ ctx, input }) => ({
+ //     extension: input.extension,
+ //     role: ctx.userRole,
+ //   }))
+ //   .beforeUpload(() => {
+ //     return true;
+ //   });
+ // const a = es.imageBucket
+ //   .input(z.object({ type: z.string(), someMeta: z.string().optional() }))
+ //   .path(({ ctx, input }) => [{ author: ctx.userId }, { type: input.type }])
+ //   .metadata(({ ctx, input }) => ({
+ //     role: ctx.userRole,
+ //     someMeta: input.someMeta,
+ //   }))
+ //   .accessControl({
+ //     OR: [
+ //       {
+ //         userId: { path: 'author' }, // this will check if the userId is the same as the author in the path parameter
+ //       },
+ //       {
+ //         userRole: 'admin', // this is the same as { userRole: { eq: "admin" } }
+ //       },
+ //     ],
+ //   })
+ //   .beforeUpload(({ ctx, input }) => {
+ //     return true;
+ //   })
+ //   .beforeDelete(({ ctx, file }) => {
+ //     return true;
+ //   });
+ // const b = es.imageBucket.path(({ ctx }) => [{ author: ctx.userId }]);
+ // const router = es.router({
+ //   original: imagesBucket,
+ //   imageBucket: a,
+ //   imageBucket2: b,
+ // });
+ // export { router };
+ // type ListFilesResponse<TBucket extends AnyRouter['buckets'][string]> = {
+ //   data: {
+ //     // url: string;
+ //     // size: number;
+ //     // uploadedAt: Date;
+ //     // metadata: InferMetadataObject<TBucket>;
+ //     path: InferBucketPathKeys<TBucket> extends string ? {
+ //       [key: string]: string;
+ //     } :{
+ //       [TKey in InferBucketPathKeys<TBucket>]: string;
+ //     };
+ //   }[];
+ //   pagination: {
+ //     currentPage: number;
+ //     totalPages: number;
+ //     totalCount: number;
+ //   };
+ // };
+ // type TPathKeys = 'author' | 'type';
+ // type TPathKeys2 = InferBucketPathKeys<AnyBuilder>;
+ // type ObjectWithKeys<TKeys extends string> = {
+ //   [TKey in TKeys]: string;
+ // };
+ // type Test1 = ObjectWithKeys<TPathKeys>;
+ // type Test2 = ObjectWithKeys<TPathKeys2>;
+ // type PathKeys = InferBucketPathKeys<typeof router.buckets.imageBucket>;
+ // type MetadataKeys = InferMetadataObject<typeof router.buckets.imageBucket>;
+ // type MyEdgeStoreRouter = typeof router;
+ // type MyAccessControl = AccessControlSchema<Context, AnyDef>;
+
+export { initEdgeStore };

package/dist/libs/errors/EdgeStoreCredentialsError.d.ts

@@ -0,0 +1,5 @@
+declare class EdgeStoreCredentialsError extends Error {
+    constructor(message?: string);
+}
+export default EdgeStoreCredentialsError;
+//# sourceMappingURL=EdgeStoreCredentialsError.d.ts.map

package/dist/libs/errors/EdgeStoreCredentialsError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EdgeStoreCredentialsError.d.ts","sourceRoot":"","sources":["../../../src/libs/errors/EdgeStoreCredentialsError.ts"],"names":[],"mappings":"AAIA,cAAM,yBAA0B,SAAQ,KAAK;gBAC/B,OAAO,SAAkB;CAItC;AAED,eAAe,yBAAyB,CAAC"}

package/dist/libs/errors/EdgeStoreError.d.ts

@@ -0,0 +1,16 @@
+export declare const EDGE_STORE_ERROR_CODES: {
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+};
+export type EdgeStoreErrorCodeKey = keyof typeof EDGE_STORE_ERROR_CODES;
+declare class EdgeStoreError extends Error {
+    readonly cause?: Error;
+    readonly code: EdgeStoreErrorCodeKey;
+    constructor(opts: {
+        message: string;
+        code: EdgeStoreErrorCodeKey;
+        cause?: Error;
+    });
+}
+export default EdgeStoreError;
+//# sourceMappingURL=EdgeStoreError.d.ts.map

package/dist/libs/errors/EdgeStoreError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EdgeStoreError.d.ts","sourceRoot":"","sources":["../../../src/libs/errors/EdgeStoreError.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB;;;CAGzB,CAAC;AAEX,MAAM,MAAM,qBAAqB,GAAG,MAAM,OAAO,sBAAsB,CAAC;AAExE,cAAM,cAAe,SAAQ,KAAK;IAChC,SAAgB,KAAK,CAAC,EAAE,KAAK,CAAC;IAC9B,SAAgB,IAAI,EAAE,qBAAqB,CAAC;gBAEhC,IAAI,EAAE;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,qBAAqB,CAAC;QAC5B,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;CAOF;AAED,eAAe,cAAc,CAAC"}

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

@@ -0,0 +1,9 @@
+import { Provider } from '../types';
+export type AWSProviderOptions = {
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    region?: string;
+    bucketName?: string;
+};
+export declare function AWSProvider(options?: AWSProviderOptions): Provider;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/aws/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,QAAQ,CA2FlE"}

package/dist/providers/aws/index.js

@@ -0,0 +1,81 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var clientS3 = require('@aws-sdk/client-s3');
+var s3RequestPresigner = require('@aws-sdk/s3-request-presigner');
+var uuid = require('uuid');
+
+function AWSProvider(options) {
+    const { accessKeyId = process.env.ES_AWS_ACCESS_KEY_ID, secretAccessKey = process.env.ES_AWS_SECRET_ACCESS_KEY, region = process.env.ES_AWS_REGION, bucketName = process.env.ES_AWS_BUCKET_NAME } = options ?? {};
+    const credentials = accessKeyId && secretAccessKey ? {
+        accessKeyId,
+        secretAccessKey
+    } : undefined;
+    const s3Client = new clientS3.S3Client({
+        region,
+        credentials
+    });
+    const baseUrl = process.env.EDGE_STORE_BASE_URL ?? `https://${bucketName}.s3.${region}.amazonaws.com`;
+    return {
+        async init () {
+            return {};
+        },
+        getBaseUrl () {
+            return baseUrl;
+        },
+        async getFile ({ url }) {
+            const path = url.replace(`${baseUrl}/`, '');
+            const { ContentLength, LastModified } = await s3Client.send(new clientS3.HeadObjectCommand({
+                Bucket: bucketName,
+                Key: path
+            }));
+            if (!ContentLength || !LastModified) {
+                throw new Error('File not found');
+            }
+            return {
+                url,
+                metadata: {},
+                path: {},
+                size: ContentLength,
+                uploadedAt: LastModified
+            };
+        },
+        async requestUpload ({ bucketName, fileInfo }) {
+            const pathPrefix = `${bucketName}${fileInfo.isPublic ? '/_public' : ''}`;
+            const nameId = uuid.v4();
+            const extension = fileInfo.extension ? `.${fileInfo.extension.replace('.', '')}` : '';
+            const fileName = `${nameId}${extension}`;
+            const filePath = fileInfo.path.reduce((acc, item)=>{
+                return `${acc}/${item.value}`;
+            }, '');
+            const command = new clientS3.PutObjectCommand({
+                Bucket: bucketName,
+                Key: `${pathPrefix}/${filePath}/${fileName}`
+            });
+            const signedUrl = await s3RequestPresigner.getSignedUrl(s3Client, command, {
+                expiresIn: 60 * 60
+            });
+            const url = `${baseUrl}/${fileInfo.path}`;
+            return {
+                uploadUrl: signedUrl,
+                accessUrl: url
+            };
+        },
+        async requestUploadParts () {
+            throw new Error('Not implemented');
+        },
+        async deleteFile ({ url }) {
+            const path = url.replace(`${baseUrl}/`, '');
+            await s3Client.send(new clientS3.DeleteObjectCommand({
+                Bucket: bucketName,
+                Key: path
+            }));
+            return {
+                success: true
+            };
+        }
+    };
+}
+
+exports.AWSProvider = AWSProvider;

package/dist/providers/aws/index.mjs

@@ -0,0 +1,77 @@
+import { S3Client, HeadObjectCommand, PutObjectCommand, DeleteObjectCommand } from '@aws-sdk/client-s3';
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+import { v4 } from 'uuid';
+
+function AWSProvider(options) {
+    const { accessKeyId = process.env.ES_AWS_ACCESS_KEY_ID, secretAccessKey = process.env.ES_AWS_SECRET_ACCESS_KEY, region = process.env.ES_AWS_REGION, bucketName = process.env.ES_AWS_BUCKET_NAME } = options ?? {};
+    const credentials = accessKeyId && secretAccessKey ? {
+        accessKeyId,
+        secretAccessKey
+    } : 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 {};
+        },
+        getBaseUrl () {
+            return baseUrl;
+        },
+        async getFile ({ url }) {
+            const path = url.replace(`${baseUrl}/`, '');
+            const { ContentLength, LastModified } = await s3Client.send(new HeadObjectCommand({
+                Bucket: bucketName,
+                Key: path
+            }));
+            if (!ContentLength || !LastModified) {
+                throw new Error('File not found');
+            }
+            return {
+                url,
+                metadata: {},
+                path: {},
+                size: ContentLength,
+                uploadedAt: LastModified
+            };
+        },
+        async requestUpload ({ bucketName, fileInfo }) {
+            const pathPrefix = `${bucketName}${fileInfo.isPublic ? '/_public' : ''}`;
+            const nameId = v4();
+            const extension = fileInfo.extension ? `.${fileInfo.extension.replace('.', '')}` : '';
+            const fileName = `${nameId}${extension}`;
+            const filePath = fileInfo.path.reduce((acc, item)=>{
+                return `${acc}/${item.value}`;
+            }, '');
+            const command = new PutObjectCommand({
+                Bucket: bucketName,
+                Key: `${pathPrefix}/${filePath}/${fileName}`
+            });
+            const signedUrl = await getSignedUrl(s3Client, command, {
+                expiresIn: 60 * 60
+            });
+            const url = `${baseUrl}/${fileInfo.path}`;
+            return {
+                uploadUrl: signedUrl,
+                accessUrl: url
+            };
+        },
+        async requestUploadParts () {
+            throw new Error('Not implemented');
+        },
+        async deleteFile ({ url }) {
+            const path = url.replace(`${baseUrl}/`, '');
+            await s3Client.send(new DeleteObjectCommand({
+                Bucket: bucketName,
+                Key: path
+            }));
+            return {
+                success: true
+            };
+        }
+    };
+}
+
+export { AWSProvider };

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

@@ -0,0 +1,8 @@
+import { Provider } from '../types';
+export type EdgeStoreProviderOptions = {
+    accessKey?: string;
+    secretKey?: string;
+    baseUrl?: string;
+};
+export declare function EdgeStoreProvider(options?: EdgeStoreProviderOptions): Provider;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/edgestore/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAoB,MAAM,UAAU,CAAC;AAKtD,MAAM,MAAM,wBAAwB,GAAG;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,iBAAiB,CAC/B,OAAO,CAAC,EAAE,wBAAwB,GACjC,QAAQ,CA4HV"}