@koala-ts/framework 0.1.0 → 0.1.1

package/README.md

@@ -1,29 +1,14 @@
-# Framework
+# KoalaTs Framework 🐨
 
-## 🛤️ Roadmap
+KoalaTs is a NodeJs, TypeScript-first framework with expressive syntax. KoalaTS is crafted for the laziest backend
+developers because nothing pairs better with clean APIs than a good nap. The NodeJs ecosystem is vast and full of
+sparse solutions that doesn't always play well together. KoalaTs aims to provide a cohesive and opinionated solution
+that is easy to use and understand.
 
-- [ ] Routing & Middleware
-    + [x] Routing
-    + [ ] Middleware
-    + [ ] Request validation
-    + [ ] Guards and Authorization
-- [x] Handlers
-    + [x] Register handlers
-    + [x] Create responses from views
-    + [x] Access request data
-- [ ] Configuration
-- [ ] Database
-- [ ] Caching
-- [ ] Task scheduling
-- [ ] Queues
-- [ ] Logging
-- [ ] Events
-- [ ] Security
-    + [ ] Authentication
-    + [ ] Authorization
-    + [ ] Encryption and Hashing
-    + [ ] Helmet
-    + [ ] CORS
-    + [ ] Rate limiting
-- [ ] Console commands
-- [x] Testing
+## Documentation
+
+You can find the documentation [here](https://koala-ts.github.io/docs/)
+
+## License
+
+KoalaTs is [MIT licensed](/LICENSE).

package/dist/core/application.d.ts

@@ -1,4 +1,4 @@
 import { IApplication } from './types.js';
-import { IKoalaConfig } from '../config/types.js';
+import { IKoalaConfig } from '../config/index.js';
 export declare function create(_: IKoalaConfig): IApplication;
 //# sourceMappingURL=application.d.ts.map

package/dist/core/application.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/core/application.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAkB,MAAM,SAAS,CAAC;AAIvD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAG/C,wBAAgB,MAAM,CAAC,CAAC,EAAE,YAAY,GAAG,YAAY,CAmBpD"}
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/core/application.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAkB,MAAM,SAAS,CAAC;AAIvD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,wBAAgB,MAAM,CAAC,CAAC,EAAE,YAAY,GAAG,YAAY,CAcpD"}

package/dist/core/application.js

@@ -5,15 +5,12 @@ import { koaBody } from 'koa-body';
 export function create(_) {
     const app = new Koa();
     const router = new Router();
-    getRoutes().forEach((route) => {
-        const middlewareStack = [...route.middleware, route.handler];
-        for (const method of route.methods) {
-            if (route.parseBody) {
-                router[method](route.path, koaBody(), ...middlewareStack);
-                continue;
-            }
-            router[method](route.path, ...middlewareStack);
-        }
+    getRoutes().forEach(({ methods, path, middleware, handler, parseBody }) => {
+        const middlewareStack = [...middleware, handler];
+        methods.forEach(method => {
+            const routeMiddleware = parseBody ? [koaBody(), ...middlewareStack] : middlewareStack;
+            router[method](path, ...routeMiddleware);
+        });
     });
     app.use(router.routes());
     return app;

package/dist/core/application.js.map

@@ -1 +1 @@
-{"version":3,"file":"application.js","sourceRoot":"","sources":["../../src/core/application.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,MAAM,UAAU,MAAM,CAAC,CAAe;IAClC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;IAEtB,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;IAE5B,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,KAAqB,EAAE,EAAE;QAC1C,MAAM,eAAe,GAAG,CAAC,GAAG,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7D,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;gBAClB,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC;gBAC1D,SAAS;YACb,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,eAAe,CAAC,CAAC;QACnD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzB,OAAO,GAAG,CAAC;AACf,CAAC"}
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../../src/core/application.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,MAAM,UAAU,MAAM,CAAC,CAAe;IAClC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;IACtB,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;IAE5B,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAkB,EAAE,EAAE;QACtF,MAAM,eAAe,GAAG,CAAC,GAAG,UAAU,EAAE,OAAO,CAAC,CAAC;QACjD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACrB,MAAM,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC;YACtF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,eAAe,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACzB,OAAO,GAAG,CAAC;AACf,CAAC"}

package/dist/core/route.js

@@ -6,7 +6,7 @@ export function Route({ method, path, parseBody = true, middleware = [] }) {
         routes.push({
             path,
             methods: qualifyMethod(method),
-            handler: qualifyMiddleware(target, propertyKey),
+            handler: qualifyHandler(target, propertyKey),
             parseBody: parseBody,
             middleware: middleware
         });
@@ -14,16 +14,13 @@ export function Route({ method, path, parseBody = true, middleware = [] }) {
     };
 }
 export function getRoutes() {
-    return Reflect.getMetadata(key, Reflect) || [];
+    return Reflect.getMetadata(key, Reflect);
 }
 function qualifyMethod(method) {
-    const lowerMethod = method.toLowerCase();
-    if (lowerMethod === 'any') {
-        return ['get', 'post', 'put', 'patch', 'delete', 'options', 'head'];
-    }
-    return [lowerMethod];
+    const methods = Array.isArray(method) ? method : [method];
+    return methods.flatMap(m => ['any', 'all'].includes(m.toLowerCase()) ? ['all'] : [m.toLowerCase()]);
 }
-function qualifyMiddleware(target, propertyKey) {
+function qualifyHandler(target, propertyKey) {
     if (typeof target === 'function') {
         return target;
     }

package/dist/core/route.js.map

@@ -1 +1 @@
-{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/core/route.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAG1B,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE5B,MAAM,UAAU,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,EAAE,UAAU,GAAG,EAAE,EAAiB;IACpF,OAAO,UAAU,MAAc,EAAE,WAA4B;QACzD,MAAM,MAAM,GAAqB,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC;YACR,IAAI;YACJ,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC;YAC9B,OAAO,EAAE,iBAAiB,CAAC,MAAM,EAAE,WAAW,CAAC;YAC/C,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,UAAU;SACzB,CAAC,CAAC;QACH,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,SAAS;IACrB,OAAO,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;AACnD,CAAC;AAED,SAAS,aAAa,CAAC,MAAmB;IACtC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IAEzC,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,CAAC,WAA4B,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAe,EAAE,WAA4B;IACpE,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QAC/B,OAAO,MAAiB,CAAC;IAC7B,CAAC;IAED,OAAQ,MAAc,CAAC,WAAW,CAAY,CAAC;AACnD,CAAC"}
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/core/route.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAG1B,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AAE5B,MAAM,UAAU,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,EAAE,UAAU,GAAG,EAAE,EAAiB;IACpF,OAAO,UAAU,MAAc,EAAE,WAA4B;QACzD,MAAM,MAAM,GAAqB,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC;YACR,IAAI;YACJ,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC;YAC9B,OAAO,EAAE,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC;YAC5C,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,UAAU;SACzB,CAAC,CAAC;QACH,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,SAAS;IACrB,OAAO,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,aAAa,CAAC,MAAmC;IACtD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAmB,CAAC,CAAC,CAAC;AACzH,CAAC;AAED,SAAS,cAAc,CAAC,MAAe,EAAE,WAA4B;IACjE,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QAC/B,OAAO,MAAiB,CAAC;IAC7B,CAAC;IAED,OAAQ,MAAc,CAAC,WAAW,CAAY,CAAC;AACnD,CAAC"}

package/dist/core/types.d.ts

@@ -26,8 +26,8 @@ export interface INext extends Next {
 }
 export interface Handler extends Middleware {
 }
-export type THttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head' | 'any' | 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'ANY';
-export type TRouterMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head';
+export type THttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head' | 'any' | 'all' | 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'ANY' | 'ALL';
+export type TRouterMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head' | 'all';
 export interface IRouteMetadata {
     path: string;
     methods: TRouterMethod[];
@@ -37,7 +37,7 @@ export interface IRouteMetadata {
 }
 export interface IRouteOptions {
     path: string;
-    method: THttpMethod;
+    method: THttpMethod | THttpMethod[];
     parseBody?: boolean;
     middleware?: Middleware[];
 }

package/dist/core/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAG,MAAM,KAAK,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAEhE,MAAM,WAAW,YAAY;IACzB,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9B,QAAQ,IAAI,CAAC,GAAG,EAAE,eAAe,GAAG,kBAAkB,EAAE,GAAG,EAAE,cAAc,GAAG,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvH;AAED,MAAM,WAAW,QAAS,SAAQ,OAAO;IACrC,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACjC;AAED,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC1C,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CAChC;AAED,MAAM,WAAW,MAAO,SAAQ,OAAO;IACnC,OAAO,EAAE,QAAQ,GAAG,YAAY,CAAC;CACpC;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC3C,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,KAAM,SAAQ,IAAI;CAClC;AAGD,MAAM,WAAW,OAAQ,SAAQ,UAAU;CAC1C;AAED,MAAM,MAAM,WAAW,GACnB,KAAK,GACH,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,KAAK,CAAC;AAEZ,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAE7F,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,UAAU,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;CAC7B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAG,MAAM,KAAK,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAEhE,MAAM,WAAW,YAAY;IACzB,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9B,QAAQ,IAAI,CAAC,GAAG,EAAE,eAAe,GAAG,kBAAkB,EAAE,GAAG,EAAE,cAAc,GAAG,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvH;AAED,MAAM,WAAW,QAAS,SAAQ,OAAO;IACrC,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACjC;AAED,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC1C,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CAChC;AAED,MAAM,WAAW,MAAO,SAAQ,OAAO;IACnC,OAAO,EAAE,QAAQ,GAAG,YAAY,CAAC;CACpC;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC3C,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,KAAM,SAAQ,IAAI;CAClC;AAGD,MAAM,WAAW,OAAQ,SAAQ,UAAU;CAC1C;AAED,MAAM,MAAM,WAAW,GACnB,KAAK,GACH,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,KAAK,GACL,KAAK,CAAC;AAEZ,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC;AAErG,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,UAAU,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;CAC7B"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@koala-ts/framework",
   "main": "dist/index.js",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A NodeJS framework for lazy developers",
   "keywords": [
     "koala",