@hapiboo/server 2.1.0 → 3.0.0

package/dist/server.js

@@ -182,7 +182,12 @@ var server;
             verboseResponseError(reason);
         });
         response.status(202);
-        response.send();
+        if (operation) {
+            response.send({ status: 'OK', operation });
+        }
+        else {
+            response.send({ status: 'OK' });
+        }
     }
     server.prepareAcceptedResponsewithVerboseOutput = prepareAcceptedResponsewithVerboseOutput;
     function prepareFailedResponse(response, fail) {

package/package.json

@@ -1,30 +1,29 @@
 {
   "name": "@hapiboo/server",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "MK13 Studio Hapiboo - API server services",
   "author": "MK13 Studio",
   "license": "ISC",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "dependencies": {
-    "@hapiboo/core": "^2.0.0",
-    "express": "^5.1.0"
+    "@hapiboo/core": "^3.0.1",
+    "express": "^5.2.1"
   },
   "devDependencies": {
-    "@types/express": "^5.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.38.0",
-    "@typescript-eslint/parser": "^8.38.0",
-    "eslint": "^9.32.0",
-    "typescript": "5.8.3",
-    "typescript-eslint": "^8.38.0"
+    "@types/express": "^5.0.6",
+    "@typescript-eslint/eslint-plugin": "^8.51.0",
+    "@typescript-eslint/parser": "^8.51.0",
+    "eslint": "^9.39.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.51.0"
   },
   "scripts": {
-    "s_public": "cp package.public.json package.json",
-    "s_dev": "cp package.dev.json package.json",
-    "s_clean": "rm -f pnpm-lock.yaml && rm -rf node_modules dist",
-    "s_build": "tsc --project tsconfig.public.json",
-    "s_lint": "eslint 'src/*.ts'",
-    "s_check": "bash ../../scripts/publish.sh ./",
-    "s_publish": "pnpm s_clean && pnpm i -w=false && pnpm s_lint && pnpm s_build && pnpm s_check && pnpm s_dev"
+    "publish-check": "bash ../../scripts/publish.sh ./",
+    "ci:publish-prepare": "rm -f pnpm-lock.yaml && rm -rf node_modules dist && pnpm install --ignore-workspace --no-frozen-lockfile && eslint 'src/*.ts' && echo \"Linter OK\" && tsc && echo \"Build OK\"",
+    "ci:publish": "pnpm ci:publish-prepare && pnpm publish-check"
   }
 }

package/eslint.config.mjs

@@ -1,16 +0,0 @@
-import tseslint from "typescript-eslint";
-import { defineConfig } from "eslint/config";
-
-export default defineConfig([
-    ...tseslint.configs.recommended,
-    {
-        files: ["**/*.{ts,mts,cts}"],
-        rules: {
-            "@typescript-eslint/no-namespace": "off",
-            indent: ['error', 4],
-            'linebreak-style': ['error', 'unix'],
-            quotes: ['error', 'single'],
-            semi: ['error', 'always'],
-        },
-    },
-]);

package/package.dev.json

@@ -1,31 +0,0 @@
-{
-    "name": "@hapiboo/server",
-    "version": "2.1.1-dev",
-    "description": "MK13 Studio Hapiboo - API server services",
-    "author": "MK13 Studio",
-    "license": "ISC",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "s_public": "cp package.public.json package.json",
-        "s_dev": "cp package.dev.json package.json",
-        "s_clean": "rm -f pnpm-lock.yaml && rm -rf node_modules dist",
-        "s_dependency": "cd .. && cd __core && pnpm s_build",
-        "s_build": "tsc --project tsconfig.dev.json",
-        "s_lint": "eslint 'src/*.ts'",
-        "s_lint_fix": "eslint 'src/*.ts' --fix",
-        "s_prepare": "pnpm s_clean && pnpm i && pnpm s_lint && pnpm s_build"
-    },
-    "dependencies": {
-        "@hapiboo/core": "workspace:*",
-        "express": "^5.1.0"
-    },
-    "devDependencies": {
-        "@types/express": "^5.0.3",
-        "@typescript-eslint/eslint-plugin": "^8.38.0",
-        "@typescript-eslint/parser": "^8.38.0",
-        "eslint": "^9.32.0",
-        "typescript": "5.8.3",
-        "typescript-eslint": "^8.38.0"
-    }
-}

package/package.public.json

@@ -1,30 +0,0 @@
-{
-    "name": "@hapiboo/server",
-    "version": "2.1.0",
-    "description": "MK13 Studio Hapiboo - API server services",
-    "author": "MK13 Studio",
-    "license": "ISC",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "s_public": "cp package.public.json package.json",
-        "s_dev": "cp package.dev.json package.json",
-        "s_clean": "rm -f pnpm-lock.yaml && rm -rf node_modules dist",
-        "s_build": "tsc --project tsconfig.public.json",
-        "s_lint": "eslint 'src/*.ts'",
-        "s_check": "bash ../../scripts/publish.sh ./",
-        "s_publish": "pnpm s_clean && pnpm i -w=false && pnpm s_lint && pnpm s_build && pnpm s_check && pnpm s_dev"
-    },
-    "dependencies": {
-        "@hapiboo/core": "^2.0.0",
-        "express": "^5.1.0"
-    },
-    "devDependencies": {
-        "@types/express": "^5.0.3",
-        "@typescript-eslint/eslint-plugin": "^8.38.0",
-        "@typescript-eslint/parser": "^8.38.0",
-        "eslint": "^9.32.0",
-        "typescript": "5.8.3",
-        "typescript-eslint": "^8.38.0"
-    }
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-import { IRoutingItem, routingProvider } from './routing';
-import { server } from './server';
-import { validator } from './validator';
-
-export { IRoutingItem, routingProvider, server, validator };

package/src/routing.ts

@@ -1,77 +0,0 @@
-import { Application, Router, IRouter } from 'express';
-
-interface IRouteDetails{
-    method: string;
-    url: string;
-}
-
-function parseItem(path: string, item: IRoutingItem): IRouteDetails[]{
-    if (item.children.length === 0) {
-        return parseRouter(`${path}${item.mount ?? ''}`, item.router);
-    } else {
-        const ret: IRouteDetails[] = [];
-        item.children.forEach((child) => {
-            ret.push(...parseItem(`${path}${item.mount ?? ''}`, child));
-        });
-
-        return ret;
-    }
-}
-function parseRouter(path: string, item: IRouter): IRouteDetails[]{
-    const ret: IRouteDetails[] = [];
-    item.stack.forEach((layer) => {
-        if (layer.route && layer.name === 'handle') {
-            layer.route.stack.forEach((details) => {
-                if (details.name === '<anonymous>'){
-                    ret.push({ method: details.method, url: `${path}${layer.route?.path }` });
-                }
-            });
-        }
-    });
-
-    return ret;
-}
-
-export interface IRoutingItem{
-    mount: string | undefined;
-    children: IRoutingItem[];
-    router: Router;
-}
-
-export namespace routingProvider{
-    export function printMap(routes: IRoutingItem[]){
-        console.info('Method     Routes:');
-        console.info('------------------');
-
-        routes.forEach((route) => {
-            parseItem('', route).forEach((detail) => {
-                console.info(`${detail.method.toUpperCase().padEnd(10)} ${detail.url}`);
-            });
-        });
-    }
-    export function createRoutingItem(mount: string | undefined, router: Router): IRoutingItem{
-        return { mount: mount, children: [], router: router };
-    }
-    export function createRouter(mount: string | undefined, routes: IRoutingItem[]): IRoutingItem{
-        const router = Router({ mergeParams: true });
-
-        routes.forEach((item) => {
-            if (item.mount && item.mount !== ''){
-                router.use(item.mount, item.router);
-            } else {
-                router.use(item.router);
-            }
-        });
-
-        return { mount: mount, children: routes, router: router };
-    }
-    export function processApp(expressApp: Application, routers: IRoutingItem[]){
-        routers.forEach((item) => {
-            if (item.mount && item.mount !== ''){
-                expressApp.use(item.mount, item.router);
-            } else {
-                expressApp.use(item.router);
-            }
-        });
-    }
-}

package/src/server.ts

@@ -1,172 +0,0 @@
-import { Response, Request } from 'express';
-import { promise, ResponseError, IResponsePromise, IResponsePromiseVoid } from '@hapiboo/core';
-
-function prepareResponse(response: Response, responseSender?: () => void, err?: ResponseError, non200Status?: number) {
-    if (err) {
-        response.status(err.status);
-        if (err.code) {
-            if (err.error) {
-                response.json({ code: err.code, error: err.message, original: err.error.name, stack: err.error.stack });
-            } else {
-                response.json({ code: err.code, error: err.message});
-            }
-        } else {
-            if (err.error) {
-                response.json({ error: err.message, original: err.error.name, stack: err.error.stack });
-            } else {
-                response.json({ error: err.message});
-            }    
-        }
-    } else {
-        if (responseSender) {
-            response.status(non200Status ?? 200);
-            responseSender();
-        } else {
-            response.status(non200Status ?? 204);
-            response.send();
-        }
-    }
-}
-function verboseResponseError(reason: ResponseError){
-    if (reason.code) {
-        console.error(`${reason.status}: [${reason.code}] ${reason.message}`);
-    } else {
-        console.error(`${reason.status}: ${reason.message}`);
-    }
-    if (reason.error) {
-        console.error(`${reason.error.name}: ${reason.error.message}`);
-        console.error(`stack: ${reason.error.stack}`);
-    }
-    if (reason.dataError) {
-        console.error(`[${reason.dataError.collection}] - ${reason.dataError.operation}:${reason.dataError.id}`);
-    }
-    if (reason.collection){
-        reason.collection.forEach((error) => {
-            verboseResponseError(error);
-        });
-    }
-}
-
-export namespace server {
-    export function prepareJsonResponse<T>(response: Response, data: T, err?: ResponseError, non200Status?: number) {
-        prepareResponse(response, () => {
-            response.json(data);
-        }, err, non200Status);
-    }
-    export function prepareStringResponse(response: Response, data: string, err?: ResponseError) {
-        prepareResponse(response, () => {
-            response.send(data);
-        }, err);
-    }
-    export function prepareBinaryResponse(response: Response, data: Buffer, err?: ResponseError) {
-        prepareResponse(response, () => {
-            response.send(data);
-        }, err);
-    }
-    export function prepareMimeResponse(response: Response, data: Buffer, mime: string, err?: ResponseError, non200Status?: number) {
-        prepareResponse(response, () => {
-            if (mime != undefined && data != undefined) {
-                response.contentType(mime);
-                response.send(data);    
-            } else {
-                response.json({});
-            }
-        }, err, non200Status);
-    }
-
-    export function prepareJsonPromiseResponse<T>(response: Response, promise: IResponsePromise<T>, non200Status?: number) {
-        promise
-            .then((data) => {
-                prepareResponse(response, () => {
-                    response.json(data);
-                }, undefined, non200Status);        
-            })
-            .catch((error) => {
-                prepareResponse(response, undefined, error, non200Status);
-            });
-    }
-    export function prepareStringPromiseResponse(response: Response, promise: IResponsePromise<string>, non200Status?: number) {
-        promise
-            .then((value) => {
-                prepareStringResponse(response, value);
-            })
-            .catch((error) => {
-                prepareResponse(response, undefined, error, non200Status);
-            });
-    }
-    export function prepareEmptyPromiseResponse(response: Response, promise: IResponsePromiseVoid, non200Status?: number) {
-        promise
-            .then(() => {
-                prepareResponse(response, undefined, undefined, non200Status);
-            })
-            .catch((error) => {
-                prepareResponse(response, undefined, error, non200Status);
-            });
-    }
-    export function prepareMimePromiseResponse(response: Response, mime: string, promise: IResponsePromise<Buffer>, non200Status?: number) {
-        promise
-            .then((data) => {
-                prepareMimeResponse(response, data, mime, undefined, non200Status);
-            })
-            .catch((error) => {
-                prepareResponse(response, undefined, error, non200Status);
-            });
-    }
-    export function prepareMimeBinaryPromiseResponse(response: Response, promise: IResponsePromise<{mime: string, binary: Buffer}>, non200Status?: number) {
-        promise
-            .then((data) => {
-                prepareMimeResponse(response, data.binary, data.mime, undefined, non200Status);
-            })
-            .catch((error) => {
-                prepareResponse(response, undefined, error, non200Status);
-            });
-    }
-    export function prepareCustomPromiseResponse<T>(response: Response, promise: IResponsePromiseVoid, successContent: T, non200Status?: number) {
-        promise
-            .then(() => {
-                prepareResponse(response, () => { response.send(successContent); }, undefined, non200Status);
-            })
-            .catch((error) => {
-                prepareResponse(response, undefined, error, non200Status);
-            });
-    }
-
-    export function createValidatedPromise<T>(request: Request, validator: (request: Request) => boolean, delayedPromise: IResponsePromise<T>): IResponsePromise<T> {
-        if (validator(request)) {
-            return delayedPromise.start();
-        } else {
-            return promise.createFailedPromise(ResponseError.getMessageResponse(400, 'malformed request'));
-        }
-    }
-    export function createValidatedVoidPromise(request: Request, validator: (request: Request) => boolean, delayedPromise: IResponsePromiseVoid): IResponsePromiseVoid {
-        if (validator(request)) {
-            return delayedPromise.start();
-        } else {
-            return promise.createFailedVoidPromise(ResponseError.getMessageResponse(400, 'malformed request'));
-        }
-    }
-
-    export function prepareAcceptedResponsewithVerboseOutput(response: Response, promise: IResponsePromiseVoid, operation: string | undefined){
-        promise
-            .then(() => {
-                if (operation) {
-                    console.info(`${operation} completed succesfully`);
-                }
-            })
-            .catch((reason) => {
-                if (operation) {
-                    console.info(`${operation} completed with problem:`);
-                } else {
-                    console.info('Operation completed with problem:');
-                }
-                verboseResponseError(reason);
-            });
-        
-        response.status(202);
-        response.send();
-    }
-
-    export function prepareFailedResponse(response: Response, fail: ResponseError){
-        prepareResponse(response, undefined, fail, undefined);
-    }
-}

package/src/validator.ts

@@ -1,63 +0,0 @@
-import { Request } from 'express';
-import { promise, ResponseError, IResponsePromise, IResponsePromiseVoid } from '@hapiboo/core';
-
-export namespace validator {
-
-    export function createValidatedPromise<T>(validator: () => boolean, delayedPromise: IResponsePromise<T>): IResponsePromise<T> {
-        if (validator()) {
-            return delayedPromise.start();
-        } else {
-            return promise.createFailedPromise(ResponseError.getMessageResponse(400, 'malformed request'));
-        }
-    }
-    export function createValidatedVoidPromise(validator: () => boolean, delayedPromise: IResponsePromiseVoid): IResponsePromiseVoid {
-        if (validator()) {
-            return delayedPromise.start();
-        } else {
-            return promise.createFailedVoidPromise(ResponseError.getMessageResponse(400, 'malformed request'));
-        }
-    }
-
-    export function validateString(toValidate: string | undefined): boolean {
-        return toValidate !== undefined && toValidate !== '';
-    }
-    export function validatePattern(toValidate: string, pattern: string[]): boolean {
-        return validateString(toValidate) &&
-            pattern.some((val) => {
-                return val == toValidate;
-            });
-    }
-    export function validateStringArray(toValidate: string[]): boolean {
-        return toValidate != undefined;
-    }
-    export function validateNotEmptyStringArray(toValidate: string[]): boolean {
-        return toValidate != undefined && toValidate.length > 0 && toValidate.every((item) => { return validateString(item); });
-    }
-    export function validateInteger(toValidate: number): boolean {
-        return toValidate != undefined && (Math.floor(toValidate) == toValidate);
-    }
-
-    export function validateBody(request: Request): boolean{
-        return request.body !== undefined;
-    }
-
-    export function validateHeader(request: Request, headerKey: string): { isValid: boolean, value: string }{
-        const headerValue = request.headers[headerKey.toLowerCase()];
-
-        if (headerValue && typeof(headerValue) === 'string' && headerValue.trim() !== '') {
-            return { isValid: true, value: headerValue };
-        } else {
-            return { isValid: false, value: '' };
-        }
-    }
-
-    export function validateQuery(request: Request, queryKey: string): { isValid: boolean, value: string }{
-        const queryValue = request.query[queryKey];
-
-        if (queryValue && typeof(queryValue) === 'string' && queryValue.trim() !== '') {
-            return { isValid: true, value: queryValue };
-        } else {
-            return { isValid: false, value: '' };
-        }
-    }
-}

package/tsconfig.base.json

@@ -1,18 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2020",
-        "module": "commonjs",
-        "lib": ["ES2020"],
-        "outDir": "./dist",
-        "rootDir": "./src",
-        "strict": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "forceConsistentCasingInFileNames": true,
-        "moduleResolution": "node",
-        "resolveJsonModule": true,
-        "declaration": true,
-        },
-    "include": ["src/**/*"],
-    "exclude": ["node_modules", "dist"]
-} 

package/tsconfig.dev.json

@@ -1,7 +0,0 @@
-{
-    "extends": "./tsconfig.base.json",
-    "compilerOptions": {
-        "sourceMap": true,
-        "declarationMap": true
-    } 
-}

package/tsconfig.public.json

@@ -1,7 +0,0 @@
-{
-    "extends": "./tsconfig.base.json",
-    "compilerOptions": {
-        "sourceMap": false,
-        "declarationMap": false
-    }
-}