bootpress 4.1.1 → 5.0.1

package/README.md

@@ -8,12 +8,11 @@
 #### Basic usage:
 ```ts
 import express from "express";
-import bodyparser from "body-parser";
 import { HttpError, PassParams, RestService } from "bootpress";
 import { asInteger, getOrThrow } from "bootpress/helpers";
 
 const app = express();
-app.use(bodyparser.json());
+app.use(express.json());
 
 const UserServiceImpl = {
     users: [1, 2, 3, 4],

package/helpers/index.d.ts

@@ -2,22 +2,37 @@ import { HttpError } from "..";
 
 type TypeMap = {
     "string": string,
-    "string?": string | null,
+    "string[]": string[],
     "boolean": boolean,
-    "boolean?": boolean | null,
+    "boolean[]": boolean[],
     "number": number,
-    "number?": number | null,
+    "number[]": number[],
 }
 
+type ValidTypeKeys = keyof TypeMap;
+type ValOf<T extends keyof TypeMap> = TypeMap[T]
+
+type StringEndsWithQm = `${string}?`;
+
 type JsSchema = {
-    [key: string]: keyof TypeMap | JsSchema
+    [key: PropertyKey]: ValidTypeKeys | JsSchema | ArraySchema
 }
 
-type SchemadRecord<T> = { [E in keyof T]: T[E] extends string ? TypeMap[T[E]] : SchemadRecord<T[E]> };
+type ArraySchema = [JsSchema]
+
+type RemoveQuestionMark<T extends string> = T extends `${infer Prefix}?` ? Prefix : T;
+
+type TypedSchema<T> = {
+    [key in keyof T as `${RemoveQuestionMark<string & key>}`]:
+    key extends StringEndsWithQm ? T[key] extends ValidTypeKeys ? ValOf<T[key]> | null : T[key] extends ArraySchema ? TypedSchema<T[key][0]>[] | null : TypedSchema<T[key]> | null
+    : (T[key] extends ValidTypeKeys ? ValOf<T[key]> : T[key] extends ArraySchema ? TypedSchema<T[key][0]>[] : TypedSchema<T[key]>)
+}
 
 export function getOrThrow<T, E extends HttpError>(data: T, error: E): T;
 export function getOrElse<T, E>(data: T, defaultValue: E): T | E;
 export function asBoolean(o: any): boolean;
 export function asNumber(o: any): number;
 export function asInteger(o: any): number;
-export function asSchema<T extends JsSchema>(o: any, jsSchema: T): SchemadRecord<T>
+export function asString(o: any): string;
+export function asSchema<T extends JsSchema>(o: any, jsSchema: T): TypedSchema<T>;
+export function schema<T extends JsSchema>(schema: T): T;

package/helpers/index.js

@@ -17,7 +17,7 @@ function getOrElse(data, defaultValue) {
 }
 
 function asBoolean(o, errorMessage = undefined, errorStatus = 400) {
-    errorMessage = errorMessage ?? `Value ${o} should have been a boolean but it's not`;
+    errorMessage = errorMessage ?? `Value ${o} should have been a boolean but it's ${typeof o}`;
     if (typeof o === "string") {
         const lowercased = o.toLowerCase();
         const validBooleanStrings = new Map(Object.entries({
@@ -39,7 +39,7 @@ function asBoolean(o, errorMessage = undefined, errorStatus = 400) {
 }
 
 function asNumber(o, errorMessage = undefined, errorStatus = 400) {
-    errorMessage = errorMessage ?? `Value ${o} should have been a number but it's not`
+    errorMessage = errorMessage ?? `Value ${o} should have been a number but it's ${typeof o}`
     if (typeof o === "number") {
         return o;
     }
@@ -53,7 +53,7 @@ function asNumber(o, errorMessage = undefined, errorStatus = 400) {
 }
 
 function asInteger(o, errorMessage = undefined, errorStatus = 400) {
-    errorMessage = errorMessage ?? `Value ${o} should have been a integer but it's not`;
+    errorMessage = errorMessage ?? `Value ${o} should have been a integer but it's ${typeof o}`;
     let value = o;
     if (typeof o === "string") {
         value = Number(o);
@@ -64,22 +64,54 @@ function asInteger(o, errorMessage = undefined, errorStatus = 400) {
     return value;
 }
 
-function asSchema(o, schema){
+function asString(o, errorMessage = undefined, errorStatus = 400) {
+    errorMessage = errorMessage ?? `Value ${o} should have been a string but it's not`;
+    const validTypes = ["string", "number"];
+    if (validTypes.includes(typeof o)) {
+        return '' + o;
+    } else {
+        throw new HttpError(errorStatus, errorMessage);
+    }
+}
+
+function asSchema(o, schema) {
     const schemaKeyValues = Object.entries(schema);
-    for(let i = 0; i < schemaKeyValues.length; i ++){
-        const key = schemaKeyValues[i][0];
+    let result = {};
+    for (let i = 0; i < schemaKeyValues.length; i++) {
+        let key = schemaKeyValues[i][0];
+        if (key.endsWith("?")) {
+            key = key.substring(0, key.length - 1);
+            if (o[key] == null) {
+                result[key] = null;
+                continue;
+            }
+        }
         const expectedType = schemaKeyValues[i][1];
-        const errorMessage = `Value of ${key} should have been a ${expectedType} but it's a ${typeof o[key]}`;
+        const errorMessage = o[key] == null ? `Value of ${key} should have been a ${expectedType} but it's null` : `Value of ${key} should have been a ${expectedType} but it's a ${typeof o[key]}`;
 
-        if(typeof expectedType === "object"){
-            asSchema(o[key], expectedType);
+        if (typeof expectedType === "object") {
+            if (Array.isArray(expectedType)) {
+                result[key] = [];
+                for (let j = 0; j < o[key].length; j++) {
+                    result[key][j] = asSchema(o[key][j], expectedType[0])
+                }
+            } else {
+                result[key] = asSchema(o[key], expectedType);
+            }
         }
-        else if(typeof expectedType === "string"){
-            if(expectedType.endsWith("?") && o[key] == null){
-                continue;
+        else if (typeof expectedType === "string") {
+            if (expectedType.endsWith("[]")) {
+                const elementType = expectedType.replace("[]", "");
+                for (let j = 0; j < o[key].length; j++){
+                    if(typeof o[key][j] !== elementType){
+                        throw new HttpError(400, `Each element of ${key} should have been a ${elementType} but a ${typeof o[key][j]} is present (${o[key][j]})`);
+                    }
+                }
+                result[key] = o[key];
             }
-            expectedType.replace("?", "");
-            if(typeof o[key] !== expectedType){
+            else if (typeof o[key] === expectedType) {
+                result[key] = o[key];
+            } else {
                 throw new HttpError(400, errorMessage);
             }
         }
@@ -87,7 +119,12 @@ function asSchema(o, schema){
             throw new HttpError(500, `Type of a schema key should be a primitive type or another schema`);
         }
     }
-    return o;
+    return result;
+}
+
+
+function schema(schema) {
+    return schema;
 }
 
 module.exports = {
@@ -96,5 +133,7 @@ module.exports = {
     asBoolean,
     asNumber,
     asInteger,
-    asSchema
+    asString,
+    asSchema,
+    schema
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bootpress",
-  "version": "4.1.1",
+  "version": "5.0.1",
   "description": "REST service methods for express",
   "main": "index.js",
   "scripts": {},
@@ -25,9 +25,10 @@
   },
   "homepage": "https://github.com/ufukbakan/bootpress#readme",
   "dependencies": {
-    "@types/body-parser": "^1.19.2",
-    "@types/express": "^4.17.17",
-    "body-parser": "^1.20.2",
     "express": "^4.18.2"
+  },
+  "devDependencies": {
+    "@types/body-parser": "^1.19.2",
+    "@types/express": "^4.17.17"
   }
 }