@forklaunch/hyper-express 0.1.33 → 0.2.1

package/lib/src/middleware/swagger.middleware.js

@@ -1,75 +0,0 @@
-import LiveDirectory from 'live-directory';
-import getAbsoluteSwaggerFsPath from 'swagger-ui-dist/absolute-path';
-import swaggerUi from 'swagger-ui-express';
-/**
- * Middleware to redirect requests to the Swagger UI base path.
- *
- * @param {string} path - The base path for the Swagger UI.
- * @returns {MiddlewareHandler} - The middleware handler for redirecting requests.
- */
-export function swaggerRedirect(path) {
-    return (req, res, next) => {
-        if (req.path === path) {
-            res.redirect(`${path}/`);
-        }
-        return next?.();
-    };
-}
-/**
- * Sets up the Swagger UI middleware for serving API documentation.
- *
- * @param {string} path - The base path for the Swagger UI.
- * @param {OpenAPIObject} document - The OpenAPI document to display.
- * @param {swaggerUi.SwaggerUiOptions} [opts] - Optional Swagger UI options.
- * @param {swaggerUi.SwaggerOptions} [options] - Optional Swagger options.
- * @param {string} [customCss] - Custom CSS to apply to the Swagger UI.
- * @param {string} [customfavIcon] - Custom favicon to use in the Swagger UI.
- * @param {string} [swaggerUrl] - Custom Swagger URL.
- * @param {string} [customSiteTitle] - Custom site title for the Swagger UI.
- * @returns {MiddlewareHandler[]} - An array of middleware handlers for serving the Swagger UI.
- */
-export function swagger(path, document, opts, options, customCss, customfavIcon, swaggerUrl, customSiteTitle) {
-    const LiveAssets = new LiveDirectory(getAbsoluteSwaggerFsPath(), {
-        filter: {
-            keep: {
-                names: [
-                    'swagger-ui-bundle.js',
-                    'swagger-ui-standalone-preset.js',
-                    'swagger-ui-init.js',
-                    'swagger-ui.css',
-                    'favicon-32x32.png',
-                    'favicon-16x16.png'
-                ]
-            }
-        },
-        cache: {
-            max_file_count: 10,
-            max_file_size: 1024 * 1024 * 1.5
-        }
-    });
-    const serve = swaggerUi.serve[0];
-    /**
-     * Middleware to serve static assets for the Swagger UI.
-     *
-     * @param {Request} req - The request object.
-     * @param {Response} res - The response object.
-     * @param {MiddlewareNext} [next] - The next middleware function.
-     * @returns {void}
-     */
-    const staticAssets = (req, res, next) => {
-        const filePath = req.path.replace(path, '');
-        const file = LiveAssets.get(filePath);
-        if (file === undefined) {
-            if (next) {
-                return next();
-            }
-            return res.status(404).send();
-        }
-        const fileParts = file.path.split('.');
-        const extension = fileParts[fileParts.length - 1];
-        const content = file.content;
-        return res.type(extension).send(content);
-    };
-    const ui = swaggerUi.setup(document, opts, options, customCss, customfavIcon, swaggerUrl, customSiteTitle);
-    return [serve, staticAssets, ui];
-}

package/lib/src/types/hyperExpress.types.d.ts

@@ -1,42 +0,0 @@
-import { ForklaunchRequest, ForklaunchResponse, ForklaunchSendableData, ForklaunchStatusResponse, ParamsDictionary } from '@forklaunch/core/http';
-import { AnySchemaValidator } from '@forklaunch/validator';
-import { Request as ExpressRequest, Response as ExpressResponse } from 'hyper-express';
-import { ParsedQs } from 'qs';
-/**
- * Extends the Forklaunch request interface with properties from Hyper-Express's request interface.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @template P - A type for request parameters, defaulting to ParamsDictionary.
- * @template _ResBody - A type for the response body, defaulting to unknown.
- * @template ReqBody - A type for the request body, defaulting to unknown.
- * @template ReqQuery - A type for the request query, defaulting to ParsedQs.
- * @template LocalsObj - A type for local variables, defaulting to an empty object.
- */
-export interface Request<SV extends AnySchemaValidator, P extends ParamsDictionary, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>> extends ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, Omit<ExpressRequest<LocalsObj>, 'method' | 'params' | 'query' | 'headers'> {
-    /** The request body */
-    body: ReqBody;
-    /** The request query parameters */
-    query: ReqQuery;
-    /** The request parameters */
-    params: P;
-}
-/**
- * Extends the Forklaunch response interface with properties from Hyper-Express's response interface.
- *
- * @template ResBody - A type for the response body, defaulting to unknown.
- * @template LocalsObj - A type for local variables, defaulting to an empty object.
- * @template StatusCode - A type for the status code, defaulting to number.
- */
-export interface Response<ResBodyMap extends Record<number, unknown>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>> extends ForklaunchResponse<ResBodyMap, ResHeaders, LocalsObj>, Omit<ExpressResponse<LocalsObj>, 'getHeaders' | 'setHeader' | 'headersSent' | 'send' | 'status' | 'statusCode' | 'json' | 'jsonp' | 'end'>, ForklaunchStatusResponse<ForklaunchSendableData> {
-    /** The body data of the response */
-    bodyData: unknown;
-    /** If cors are applied to the response */
-    cors: boolean;
-    /** The status code of the response */
-    _status_code: number;
-    /** Whether the response is corked */
-    _cork: boolean;
-    /** Whether the response is currently corked */
-    _corked: boolean;
-}
-//# sourceMappingURL=hyperExpress.types.d.ts.map

package/lib/src/types/hyperExpress.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hyperExpress.types.d.ts","sourceRoot":"","sources":["../../../src/types/hyperExpress.types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,OAAO,IAAI,cAAc,EACzB,QAAQ,IAAI,eAAe,EAC5B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAE9B;;;;;;;;;GASG;AACH,MAAM,WAAW,OAAO,CACtB,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACzC,SAAQ,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC7D,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IAC5E,uBAAuB;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,mCAAmC;IACnC,KAAK,EAAE,QAAQ,CAAC;IAChB,6BAA6B;IAC7B,MAAM,EAAE,CAAC,CAAC;CACX;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ,CACvB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACzC,SAAQ,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,CAAC,EAC3D,IAAI,CACF,eAAe,CAAC,SAAS,CAAC,EACxB,YAAY,GACZ,WAAW,GACX,aAAa,GACb,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,MAAM,GACN,OAAO,GACP,KAAK,CACR,EACD,wBAAwB,CAAC,sBAAsB,CAAC;IAClD,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,0CAA0C;IAC1C,IAAI,EAAE,OAAO,CAAC;IACd,sCAAsC;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,qCAAqC;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/lib/src/types/hyperExpress.types.js

@@ -1 +0,0 @@
-export {};

package/lib/tests/typebox.forklaunch.hyperExpress.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=typebox.forklaunch.hyperExpress.test.d.ts.map

package/lib/tests/typebox.forklaunch.hyperExpress.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typebox.forklaunch.hyperExpress.test.d.ts","sourceRoot":"","sources":["../../tests/typebox.forklaunch.hyperExpress.test.ts"],"names":[],"mappings":""}

package/lib/tests/typebox.forklaunch.hyperExpress.test.js

@@ -1,111 +0,0 @@
-import { SchemaValidator, string } from '@forklaunch/validator/typebox';
-import { forklaunchExpress, forklaunchRouter } from '../index';
-const typeboxSchemaValidator = SchemaValidator();
-const forklaunchApplication = forklaunchExpress(typeboxSchemaValidator);
-const forklaunchRouterInstance = forklaunchRouter('/testpath', typeboxSchemaValidator);
-describe('Forklaunch Hyper-Express Tests', () => {
-    beforeAll(async () => {
-        forklaunchRouterInstance.get('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            responses: {
-                200: string
-            }
-        }, (_req, res) => {
-            res.status(200).send('Hello World');
-        });
-        forklaunchRouterInstance.post('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            body: {
-                test: string
-            },
-            responses: {
-                200: string
-            }
-        }, (req, res) => {
-            res.status(200).send(req.body.test);
-        });
-        forklaunchRouterInstance.put('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            body: {
-                test: string
-            },
-            responses: {
-                200: string
-            }
-        }, (req, res) => {
-            res.status(200).send(req.body.test);
-        });
-        forklaunchRouterInstance.patch('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            body: {
-                test: string
-            },
-            responses: {
-                200: string
-            }
-        }, (req, res) => {
-            res.status(200).send(req.body.test);
-        });
-        forklaunchRouterInstance.delete('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            responses: {
-                200: string
-            }
-        }, (_req, res) => {
-            res.status(200).send('Hello World');
-        });
-        forklaunchApplication.use(forklaunchRouterInstance);
-        await forklaunchApplication.listen(6936, () => {
-            console.log('server started on 6936');
-        });
-    });
-    test('Get', async () => {
-        const testGet = await fetch('http://localhost:6936/testpath/test', {
-            method: 'GET'
-        });
-        expect(testGet.status).toBe(200);
-        expect(await testGet.text()).toBe('Hello World');
-    });
-    test('Post', async () => {
-        const testPost = await fetch('http://localhost:6936/testpath/test', {
-            method: 'POST',
-            body: JSON.stringify({ test: 'Hello World' }),
-            headers: { 'Content-Type': 'application/json' }
-        });
-        expect(testPost.status).toBe(200);
-        expect(await testPost.text()).toBe('Hello World');
-    });
-    test('Put', async () => {
-        const testPut = await fetch('http://localhost:6936/testpath/test', {
-            method: 'PUT',
-            body: JSON.stringify({ test: 'Hello World' }),
-            headers: { 'Content-Type': 'application/json' }
-        });
-        expect(testPut.status).toBe(200);
-        expect(await testPut.text()).toBe('Hello World');
-    });
-    test('Patch', async () => {
-        const testPatch = await fetch('http://localhost:6936/testpath/test', {
-            method: 'PATCH',
-            body: JSON.stringify({ test: 'Hello World' }),
-            headers: { 'Content-Type': 'application/json' }
-        });
-        expect(testPatch.status).toBe(200);
-        expect(await testPatch.text()).toBe('Hello World');
-    });
-    test('Delete', async () => {
-        const testDelete = await fetch('http://localhost:6936/testpath/test', {
-            method: 'DELETE'
-        });
-        expect(testDelete.status).toBe(200);
-        expect(await testDelete.text()).toBe('Hello World');
-    });
-    afterAll(async () => {
-        forklaunchApplication.internal.shutdown();
-    });
-});

package/lib/tests/zod.forklaunch.hyperExpress.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=zod.forklaunch.hyperExpress.test.d.ts.map

package/lib/tests/zod.forklaunch.hyperExpress.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"zod.forklaunch.hyperExpress.test.d.ts","sourceRoot":"","sources":["../../tests/zod.forklaunch.hyperExpress.test.ts"],"names":[],"mappings":""}

package/lib/tests/zod.forklaunch.hyperExpress.test.js

@@ -1,109 +0,0 @@
-import { SchemaValidator, string } from '@forklaunch/validator/zod';
-import { forklaunchExpress, forklaunchRouter } from '../index';
-const zodSchemaValidator = SchemaValidator();
-const forklaunchApplication = forklaunchExpress(zodSchemaValidator);
-const forklaunchRouterInstance = forklaunchRouter('/testpath', zodSchemaValidator);
-describe('Forklaunch Hyper-Express Tests', () => {
-    beforeAll(async () => {
-        forklaunchRouterInstance.get('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            responses: {
-                200: string
-            }
-        }, (_req, res) => {
-            res.status(200).send('Hello World');
-        });
-        forklaunchRouterInstance.post('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            body: {
-                test: string
-            },
-            responses: {
-                200: string
-            }
-        }, (req, res) => {
-            res.status(200).send(req.body.test);
-        });
-        forklaunchRouterInstance.put('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            body: {
-                test: string
-            },
-            responses: {
-                200: string
-            }
-        }, (req, res) => {
-            res.status(200).send(req.body.test);
-        });
-        forklaunchRouterInstance.patch('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            body: {
-                test: string
-            },
-            responses: {
-                200: string
-            }
-        }, (req, res) => {
-            res.status(200).send(req.body.test);
-        });
-        forklaunchRouterInstance.delete('/test', {
-            name: 'Test',
-            summary: 'Test Summary',
-            responses: {
-                200: string
-            }
-        }, (_req, res) => {
-            res.status(200).send('Hello World');
-        });
-        forklaunchApplication.use(forklaunchRouterInstance);
-        await forklaunchApplication.listen(6937, () => { });
-    });
-    test('Get', async () => {
-        const testGet = await fetch('http://localhost:6937/testpath/test', {
-            method: 'GET'
-        });
-        expect(testGet.status).toBe(200);
-        expect(await testGet.text()).toBe('Hello World');
-    });
-    test('Post', async () => {
-        const testPost = await fetch('http://localhost:6937/testpath/test', {
-            method: 'POST',
-            body: JSON.stringify({ test: 'Hello World' }),
-            headers: { 'Content-Type': 'application/json' }
-        });
-        expect(testPost.status).toBe(200);
-        expect(await testPost.text()).toBe('Hello World');
-    });
-    test('Put', async () => {
-        const testPut = await fetch('http://localhost:6937/testpath/test', {
-            method: 'PUT',
-            body: JSON.stringify({ test: 'Hello World' }),
-            headers: { 'Content-Type': 'application/json' }
-        });
-        expect(testPut.status).toBe(200);
-        expect(await testPut.text()).toBe('Hello World');
-    });
-    test('Patch', async () => {
-        const testPatch = await fetch('http://localhost:6937/testpath/test', {
-            method: 'PATCH',
-            body: JSON.stringify({ test: 'Hello World' }),
-            headers: { 'Content-Type': 'application/json' }
-        });
-        expect(testPatch.status).toBe(200);
-        expect(await testPatch.text()).toBe('Hello World');
-    });
-    test('Delete', async () => {
-        const testDelete = await fetch('http://localhost:6937/testpath/test', {
-            method: 'DELETE'
-        });
-        expect(testDelete.status).toBe(200);
-        expect(await testDelete.text()).toBe('Hello World');
-    });
-    afterAll(async () => {
-        forklaunchApplication.internal.shutdown();
-    });
-});

package/lib/vitest.config.d.ts

@@ -1,3 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;
-//# sourceMappingURL=vitest.config.d.ts.map

package/lib/vitest.config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"vitest.config.d.ts","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":";AAEA,wBAKG"}

package/lib/vitest.config.js

@@ -1,7 +0,0 @@
-import { defineConfig } from 'vitest/config';
-export default defineConfig({
-    test: {
-        globals: true,
-        exclude: ['**/lib/**', '**/dist/**', '**/node_modules/**']
-    }
-});