@starklabs/forge 1.3.23 → 1.3.24-beta.0

package/dist/js/utils/validationKeyError.js

@@ -1,11 +1,12 @@
 import AppError from "./AppError.js";
 import getErrorDetail from "./getErrorDetail.js";
-const getValidationKey = (routeObj, validationsObj) => {
-    const key = routeObj.validationKey;
+const getValidationKey = (routeObj, validations) => {
+    const key = routeObj.validation;
+    // if false
     if (typeof key === "boolean")
         if (key) {
             throw new AppError({
-                message: "validationKey as boolean can only be 'false'",
+                message: "validation as boolean can only be 'false'",
                 statusCode: 400,
                 hint: "Make it false without ('', \"\" or ``)",
                 details: getErrorDetail(routeObj),
@@ -14,28 +15,32 @@ const getValidationKey = (routeObj, validationsObj) => {
         else {
             if (routeObj.method !== "get")
                 throw new AppError({
-                    message: "validationKey is missing",
+                    message: "validation is missing",
                     statusCode: 400,
                     hint: `body is required for method: '${routeObj.method}'`,
                     details: getErrorDetail(routeObj),
                 });
             return;
         }
+    // if validation not provided
     if (key == null)
         throw new AppError({
-            message: "validationKey is required",
+            message: "validation is required",
             statusCode: 400,
             hint: "Provide it or make it 'false' as boolean if this routeObj doesn't need validation",
             details: getErrorDetail(routeObj),
         });
-    const validateObject = validationsObj[key];
+    // validationObject
+    const validateObject = validations[key];
+    // if validation not provided
     if (!validateObject)
         throw new AppError({
-            message: `validationKey: '${key}' is missing in validationsObj`,
+            message: `validation: '${key}' is missing in validations`,
             statusCode: 400,
-            hint: `In validationsObj, use the '${key}' as key for validation`,
+            hint: `In validations, use the '${key}' as key for validation`,
             details: getErrorDetail(routeObj),
         });
+    // validate object
     return validateObject;
 };
 export default getValidationKey;

package/dist/js/utils/validationKeyError.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationKeyError.js","sourceRoot":"","sources":["../../../src/js/utils/validationKeyError.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAEjD,MAAM,gBAAgB,GAAG,CAAC,QAAe,EAAE,cAA8B,EAAE,EAAE;IAC3E,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC;IAGnC,IAAI,OAAO,GAAG,KAAK,SAAS;QAC1B,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,IAAI,QAAQ,CAAC;gBACjB,OAAO,EAAE,8CAA8C;gBACvD,UAAU,EAAE,GAAG;gBACf,IAAI,EAAE,wCAAwC;gBAC9C,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;aAClC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,CAAC,MAAM,KAAK,KAAK;gBAC3B,MAAM,IAAI,QAAQ,CAAC;oBACjB,OAAO,EAAE,0BAA0B;oBACnC,UAAU,EAAE,GAAG;oBACf,IAAI,EAAE,iCAAiC,QAAQ,CAAC,MAAM,GAAG;oBACzD,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;iBAClC,CAAC,CAAC;YAEL,OAAO;QACT,CAAC;IAGH,IAAI,GAAG,IAAI,IAAI;QACb,MAAM,IAAI,QAAQ,CAAC;YACjB,OAAO,EAAE,2BAA2B;YACpC,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,mFAAmF;YACzF,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;SAClC,CAAC,CAAC;IAGL,MAAM,cAAc,GAAG,cAAc,CAAC,GAAa,CAAC,CAAC;IAGrD,IAAI,CAAC,cAAc;QACjB,MAAM,IAAI,QAAQ,CAAC;YACjB,OAAO,EAAE,mBAAmB,GAAG,gCAAgC;YAC/D,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,+BAA+B,GAAG,yBAAyB;YACjE,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;SAClC,CAAC,CAAC;IAGL,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"validationKeyError.js","sourceRoot":"","sources":["../../../src/js/utils/validationKeyError.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAEjD,MAAM,gBAAgB,GAAG,CAAC,QAAe,EAAE,WAA2B,EAAE,EAAE;IACxE,MAAM,GAAG,GAAG,QAAQ,CAAC,UAAU,CAAC;IAEhC,WAAW;IACX,IAAI,OAAO,GAAG,KAAK,SAAS;QAC1B,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,IAAI,QAAQ,CAAC;gBACjB,OAAO,EAAE,2CAA2C;gBACpD,UAAU,EAAE,GAAG;gBACf,IAAI,EAAE,wCAAwC;gBAC9C,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;aAClC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,CAAC,MAAM,KAAK,KAAK;gBAC3B,MAAM,IAAI,QAAQ,CAAC;oBACjB,OAAO,EAAE,uBAAuB;oBAChC,UAAU,EAAE,GAAG;oBACf,IAAI,EAAE,iCAAiC,QAAQ,CAAC,MAAM,GAAG;oBACzD,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;iBAClC,CAAC,CAAC;YAEL,OAAO;QACT,CAAC;IAEH,6BAA6B;IAC7B,IAAI,GAAG,IAAI,IAAI;QACb,MAAM,IAAI,QAAQ,CAAC;YACjB,OAAO,EAAE,wBAAwB;YACjC,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,mFAAmF;YACzF,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;SAClC,CAAC,CAAC;IAEL,mBAAmB;IACnB,MAAM,cAAc,GAAG,WAAW,CAAC,GAAa,CAAC,CAAC;IAElD,6BAA6B;IAC7B,IAAI,CAAC,cAAc;QACjB,MAAM,IAAI,QAAQ,CAAC;YACjB,OAAO,EAAE,gBAAgB,GAAG,6BAA6B;YACzD,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,4BAA4B,GAAG,yBAAyB;YAC9D,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC;SAClC,CAAC,CAAC;IAEL,kBAAkB;IAClB,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@starklabs/forge",
-  "version": "1.3.23",
+  "version": "1.3.24-beta.0",
   "description": "A TypeScript-first Express framework for building production-ready APIs with zero boilerplate.",
   "type": "module",
   "main": "./dist/js/index.js",

package/readme.md

@@ -183,12 +183,12 @@ Forge lets you define your backend like this:
 
 ```ts
 collection({
-    reqType: "crud",
-    routeName: "expenses",
-    modelName: "Expense",
-    routesArray: routes,
-    mongooseSchemaObj: schema,
-    validationsObj: validation,
+    type: "crud",
+    route: "expenses",
+    model: "Expense",
+    routes: routes,
+    schema: schema,
+    validations: validation,
 });
 ```
 
@@ -517,12 +517,12 @@ Every resource starts with a collection.
 
 ```ts
 collection({
-    reqType: "crud",
-    routeName: "expenses",
-    modelName: "Expense",
-    routesArray: routes,
-    mongooseSchemaObj: schema,
-    validationsObj: validation,
+    type: "crud",
+    route: "expenses",
+    model: "Expense",
+    routes: routes,
+    schema: schema,
+    validations: validation,
 });
 ```
 
@@ -606,11 +606,11 @@ You simply describe the routeObj.
 
 ```ts
 {
-    authRole: "authenticated",
+    auth: "authenticated",
     handler: "create",
     method: "post",
     path: "/",
-    validationKey: "create"
+    validation: "create"
 }
 ```
 
@@ -624,43 +624,43 @@ Example:
 const routes = [
 
 {
-    authRole: "authenticated",
+    auth: "authenticated",
     handler: "create",
     method: "post",
     path: "/",
-    validationKey: "create"
+    validation: "create"
 },
 
 {
-    authRole: "public",
+    auth: "public",
     handler: "readAll",
     method: "get",
     path: "/",
-    validationKey: false
+    validation: false
 },
 
 {
-    authRole: "public",
+    auth: "public",
     handler: "read",
     method: "get",
     path: "/:id",
-    validationKey: false
+    validation: false
 },
 
 {
-    authRole: "adminOrOwner",
+    auth: "admin-or-owner",
     handler: "update",
     method: "patch",
     path: "/:id",
-    validationKey: "update"
+    validation: "update"
 },
 
 {
-    authRole: "adminOrOwner",
+    auth: "admin-or-owner",
     handler: "remove",
     method: "delete",
     path: "/:id",
-    validationKey: false
+    validation: false
 }
 
 ];
@@ -729,19 +729,19 @@ Simply reference the handler name inside your routeObj.
 Authorization is intentionally simple.
 
 ```ts
-authRole: "public"
+auth: "public"
 ```
 
 ```ts
-authRole: "authenticated"
+auth: "authenticated"
 ```
 
 ```ts
-authRole: "admin"
+auth: "admin"
 ```
 
 ```ts
-authRole: "adminOrOwner"
+auth: "admin-or-owner"
 ```
 
 Forge applies the appropriate middleware automatically.
@@ -767,7 +767,7 @@ This keeps the framework lightweight while allowing complete flexibility.
     uploadArray: [
 
         {
-            fieldName: "avatar",
+            paramField: "avatar",
 
             provider: "cloudinary",