exisjs 0.7.5 → 0.7.7

package/dist/router/route-builder.js

@@ -1,30 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.route = void 0;
+exports.defineMiddleware = defineMiddleware;
 exports.controller = controller;
 exports.createRouter = createRouter;
 const logger_1 = require("../logger");
 /**
- * Defines a new HTTP route with schema validation and a supercharged execution context.
+ * Creates a strongly typed middleware that injects context into downstream routes or boundaries.
+ *
+ * @template TContext The custom request context type produced by this middleware
+ * @param fn Middleware function receiving `(req, res, next)`
+ * @returns Strongly typed middleware handler
+ *
+ * @example
+ * ```ts
+ * interface AuthContext {
+ *   user: { id: string; role: string }
+ * }
+ *
+ * const authenticate = defineMiddleware<AuthContext>(async (req, res, next) => {
+ *   req.user = { id: '123', role: 'admin' }
+ *   next()
+ * })
+ * ```
+ */
+function defineMiddleware(fn) {
+    return fn;
+}
+/**
+ * Declarative route builder with schema validation, typed parameters, and supercharged context.
  */
 exports.route = {
     /**
-     * Defines a GET route.
+     * Defines an HTTP GET route definition.
      *
-     * Example:
+     * @param path The route URL path (e.g. `'/'` or `'/:id'`)
+     * @param config Route configuration with query/params schemas, middleware, and handler
+     * @returns Strongly typed `RouteDefinition`
      *
-     *     route.get('/users', {
-     *       // Validate the query string
-     *       query: tex.object({ search: tex.string() }),
+     * @example
+     * ```ts
+     * import { controller, route } from 'exisjs/router'
+     * import { tex } from 'exisjs/validator'
      *
-     *       async handle(ctx) {
-     *         // ctx.query is typed as { search: string }
-     *       }
-     *     })
-     *
-     * @param {string} path
-     * @param {RouteConfig} config
-     * @public
+     * export default controller({
+     *   getUser: route.get('/:id', {
+     *     params: { id: tex.string() },
+     *     async handle({ params }) {
+     *       return { id: params.id, name: 'Alice' }
+     *     }
+     *   })
+     * })
+     * ```
      */
     get: (path, config) => {
         if ('body' in config && config.body) {
@@ -32,30 +59,157 @@ exports.route = {
         }
         return { method: 'get', path, ...config };
     },
+    /**
+     * Defines an HTTP POST route definition.
+     *
+     * @param path The route URL path (e.g. `'/'` or `'/submit'`)
+     * @param config Route configuration with body schema, middleware, and handler
+     * @returns Strongly typed `RouteDefinition`
+     *
+     * @example
+     * ```ts
+     * import { controller, route } from 'exisjs/router'
+     * import { tex } from 'exisjs/validator'
+     *
+     * export default controller({
+     *   createUser: route.post('/', {
+     *     body: tex.object({
+     *       email: tex.email(),
+     *       password: tex.password({ min: 8 })
+     *     }),
+     *     async handle({ body, res }) {
+     *       res.status(201)
+     *       return { email: body.email, created: true }
+     *     }
+     *   })
+     * })
+     * ```
+     */
     post: (path, config) => ({ method: 'post', path, ...config }),
+    /**
+     * Defines an HTTP PUT route definition.
+     *
+     * @param path The route URL path (e.g. `'/:id'`)
+     * @param config Route configuration with body/params schemas and handler
+     * @returns Strongly typed `RouteDefinition`
+     *
+     * @example
+     * ```ts
+     * import { controller, route } from 'exisjs/router'
+     * import { tex } from 'exisjs/validator'
+     *
+     * export default controller({
+     *   updateUser: route.put('/:id', {
+     *     body: tex.object({ name: tex.string() }),
+     *     async handle({ params, body }) {
+     *       return { id: params.id, name: body.name }
+     *     }
+     *   })
+     * })
+     * ```
+     */
     put: (path, config) => ({ method: 'put', path, ...config }),
+    /**
+     * Defines an HTTP DELETE route definition.
+     *
+     * @param path The route URL path (e.g. `'/:id'`)
+     * @param config Route configuration with params schema and handler
+     * @returns Strongly typed `RouteDefinition`
+     *
+     * @example
+     * ```ts
+     * import { controller, route } from 'exisjs/router'
+     *
+     * export default controller({
+     *   deleteUser: route.delete('/:id', {
+     *     async handle({ params }) {
+     *       return { deleted: params.id }
+     *     }
+     *   })
+     * })
+     * ```
+     */
     delete: (path, config) => ({ method: 'delete', path, ...config }),
+    /**
+     * Defines an HTTP PATCH route definition.
+     *
+     * @param path The route URL path (e.g. `'/:id'`)
+     * @param config Route configuration with partial body schema and handler
+     * @returns Strongly typed `RouteDefinition`
+     *
+     * @example
+     * ```ts
+     * import { controller, route } from 'exisjs/router'
+     * import { tex } from 'exisjs/validator'
+     *
+     * export default controller({
+     *   patchUser: route.patch('/:id', {
+     *     body: tex.object({ status: tex.enum(['active', 'disabled']) }),
+     *     async handle({ params, body }) {
+     *       return { id: params.id, status: body.status }
+     *     }
+     *   })
+     * })
+     * ```
+     */
     patch: (path, config) => ({ method: 'patch', path, ...config }),
+    /**
+     * Defines an HTTP OPTIONS route definition.
+     */
     options: (path, config) => ({ method: 'options', path, ...config }),
+    /**
+     * Defines an HTTP HEAD route definition.
+     */
     head: (path, config) => ({ method: 'head', path, ...config }),
+    /**
+     * Defines an HTTP CONNECT route definition.
+     */
     connect: (path, config) => ({ method: 'connect', path, ...config }),
+    /**
+     * Defines an HTTP TRACE route definition.
+     */
     trace: (path, config) => ({ method: 'trace', path, ...config }),
+    /**
+     * Defines a QUERY route definition.
+     */
     query: (path, config) => ({ method: 'query', path, ...config }),
+    /**
+     * Defines a route matching any HTTP method (GET, POST, PUT, DELETE, PATCH, etc.).
+     *
+     * @param path The route URL path (e.g. `'*'` or `'/api/*'`)
+     * @param config Route configuration and handler
+     * @returns Strongly typed `RouteDefinition`
+     */
     all: (path, config) => ({ method: 'all', path, ...config }),
 };
 /**
- * Creates a route controller. This elegantly binds multiple routes together,
- * sharing middleware and error handling, while drastically reducing boilerplate.
+ * Creates a route controller in a `route.ts` file. Binds multiple routes together, sharing middleware,
+ * lifecycle hooks, and error handling with zero boilerplate.
+ *
+ * @param config Controller configuration containing route definitions and shared settings
+ * @returns Fully compiled functional controller
  *
  * @example
+ * ```ts
+ * // src/http/users/route.ts
+ * import { controller, route } from 'exisjs/router'
+ * import { tex } from 'exisjs/validator'
+ *
  * export default controller({
  *   cors: true,
- *   getUsers: route.get('/', {
- *     handle({ req, res }) {
+ *   listUsers: route.get('/', {
+ *     async handle() {
  *       return { users: [] }
  *     }
+ *   }),
+ *   createUser: route.post('/', {
+ *     body: tex.object({ name: tex.string() }),
+ *     async handle({ body }) {
+ *       return { created: body.name }
+ *     }
  *   })
  * })
+ * ```
  */
 function controller(config) {
     return Object.defineProperty(config, '__isController', {
@@ -64,15 +218,19 @@ function controller(config) {
     });
 }
 /**
- * Creates a strongly-typed router and controller factory.
- * This is the recommended way to type your context globally across an app.
+ * Creates a strongly-typed router and controller factory with pre-bound context.
+ *
+ * @template TContext Global request context type for the router instance
+ * @returns Object with typed `route` and `controller` factories
  *
  * @example
+ * ```ts
  * interface MyContext {
- *   user: User;
- *   workspace: Workspace;
+ *   user: { id: string; role: string }
  * }
- * export const { route, controller } = createRouter<MyContext>();
+ *
+ * export const { route, controller } = createRouter<MyContext>()
+ * ```
  */
 function createRouter() {
     return {

package/dist/router/route-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"route-builder.js","sourceRoot":"","sources":["../../src/router/route-builder.ts"],"names":[],"mappings":";;;AAkTA,gCAOC;AAaD,oCA8DC;AA1XD,sCAAkC;AAkGlC;;GAEG;AACU,QAAA,KAAK,GAAG;IACnB;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,EAAE,CAOH,IAAW,EACX,MAAsC,EACF,EAAE;QACtC,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YACpC,eAAM,CAAC,IAAI,CACT,cAAc,IAAI,+DAA+D,CAClF,CAAA;QACH,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAS,CAAA;IAClD,CAAC;IAED,IAAI,EAAE,CAOJ,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE9C,GAAG,EAAE,CAOH,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE7C,MAAM,EAAE,CAON,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAEhD,KAAK,EAAE,CAOL,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE/C,OAAO,EAAE,CAOP,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAEjD,IAAI,EAAE,CAOJ,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE9C,OAAO,EAAE,CAOP,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAEjD,KAAK,EAAE,CAOL,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE/C,KAAK,EAAE,CAOL,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE/C,GAAG,EAAE,CAOH,IAAW,EACX,MAAsC,EACF,EAAE,CACtC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;CAC9C,CAAA;AAyBD;;;;;;;;;;;;;GAaG;AACH,SAAgB,UAAU,CACxB,MAAS;IAET,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,gBAAgB,EAAE;QACrD,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,KAAK,EAAE,sBAAsB;KAC1C,CAAiC,CAAA;AACpC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,YAAY;IAC1B,OAAO;QACL,KAAK,EAAE,aAuDN;QACD,UAAU,EAAE,CACV,MAAS,EACqB,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;KACtD,CAAA;AACH,CAAC"}
+{"version":3,"file":"route-builder.js","sourceRoot":"","sources":["../../src/router/route-builder.ts"],"names":[],"mappings":";;;AAgCA,4CAQC;AAkgBD,gCAOC;AAiBD,oCAoEC;AA3nBD,sCAAkC;AAElC;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,gBAAgB,CAC9B,EAIuB;IAEvB,OAAO,EAA2C,CAAA;AACpD,CAAC;AAoGD;;GAEG;AACU,QAAA,KAAK,GAAG;IACnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG,EAAE,CAWH,IAAW,EACX,MAGC,EAC4C,EAAE;QAC/C,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YACpC,eAAM,CAAC,IAAI,CACT,cAAc,IAAI,+DAA+D,CAClF,CAAA;QACH,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAS,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,IAAI,EAAE,CAWJ,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG,EAAE,CAWH,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE7C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,EAAE,CAWN,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAEhD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,EAAE,CAWL,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE/C;;OAEG;IACH,OAAO,EAAE,CAWP,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAEjD;;OAEG;IACH,IAAI,EAAE,CAWJ,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE9C;;OAEG;IACH,OAAO,EAAE,CAWP,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAEjD;;OAEG;IACH,KAAK,EAAE,CAWL,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE/C;;OAEG;IACH,KAAK,EAAE,CAWL,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;IAE/C;;;;;;OAMG;IACH,GAAG,EAAE,CAWH,IAAW,EACX,MAGC,EAC4C,EAAE,CAC/C,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAQ;CAC9C,CAAA;AAiCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,UAAU,CACxB,MAAS;IAET,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,gBAAgB,EAAE;QACrD,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,KAAK,EAAE,sBAAsB;KAC1C,CAAiC,CAAA;AACpC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,YAAY;IAC1B,OAAO;QACL,KAAK,EAAE,aA6DN;QACD,UAAU,EAAE,CACV,MAAS,EACqB,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;KACtD,CAAA;AACH,CAAC"}

package/dist/router/route-scanner.d.ts

@@ -16,7 +16,13 @@ export declare class RouteScanner {
     mountRouteFile(filePath: string, routePath: string): Promise<void>;
     private compileFunctionalController;
     private mountRouteWithSource;
+    mountErrorHandlerFromModule(mod: any, errorFile?: string): void;
     private mountErrorHandler;
     private scanDirectory;
+    mountCronJobs(root: string): Promise<void>;
+    mountCronJobsFromEntries(entries: {
+        filePath: string;
+        module: any;
+    }[]): void;
 }
 //# sourceMappingURL=route-scanner.d.ts.map

package/dist/router/route-scanner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"route-scanner.d.ts","sourceRoot":"","sources":["../../src/router/route-scanner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AASxC,qBAAa,YAAY;IAQJ,GAAG,EAAE,GAAG;IAPpB,UAAU;kBAA+B,MAAM;gBAAU,OAAO;OAAK;IACrE,QAAQ,sBAA4B;IACpC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAO;IAC5B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,aAAa,UAAQ;IACrB,cAAc,EAAE,KAAK,GAAG,YAAY,GAAG,IAAI,CAAO;gBAEtC,GAAG,EAAE,GAAG;IAErB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBvB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAwRnD,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAusBxE,OAAO,CAAC,2BAA2B;IA4PnC,OAAO,CAAC,oBAAoB;YA2Bd,iBAAiB;YA4EjB,aAAa;CAqC5B"}
+{"version":3,"file":"route-scanner.d.ts","sourceRoot":"","sources":["../../src/router/route-scanner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AAmBxC,qBAAa,YAAY;IAQJ,GAAG,EAAE,GAAG;IAPpB,UAAU;kBAA+B,MAAM;gBAAU,OAAO;OAAK;IACrE,QAAQ,sBAA4B;IACpC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAO;IAC5B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,aAAa,UAAQ;IACrB,cAAc,EAAE,KAAK,GAAG,YAAY,GAAG,IAAI,CAAO;gBAEtC,GAAG,EAAE,GAAG;IAErB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBvB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoTnD,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoOxE,OAAO,CAAC,2BAA2B;IAInC,OAAO,CAAC,oBAAoB;IA2BrB,2BAA2B,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,SAAa,GAAG,IAAI;YAI5D,iBAAiB;YAIjB,aAAa;IAOd,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD,wBAAwB,CAC7B,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,EAAE,GAC3C,IAAI;CAGR"}