@webpieces/core-meta 0.2.7 → 0.2.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpieces/core-meta",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "Core metadata interfaces for WebPieces framework",
   "type": "commonjs",
   "main": "./src/index.js",

package/src/WebAppMeta.d.ts

@@ -23,39 +23,55 @@ export interface RouteBuilder {
  * Generic type parameter TResult represents the return type of the route handler.
  * This provides type safety for the entire request/response cycle.
  */
-export interface RouteDefinition<TResult = unknown> {
+export declare class RouteDefinition<TResult = unknown> {
     method: string;
     path: string;
     handler: RouteHandler<TResult>;
+    controllerFilepath?: string;
+    constructor(method: string, path: string, handler: RouteHandler<TResult>, controllerFilepath?: string);
 }
 /**
  * Definition of a filter with priority.
+ *
+ * Use filepathPattern to scope filters to specific controllers:
+ *   - 'src/controllers/admin/**' + '/*.ts' - All admin controllers
+ *   - '**' + '/admin/**' - Any file in admin directories
+ *   - '**' + '/UserController.ts' - Specific controller file
+ *
+ * If filepathPattern is not specified, the filter matches all controllers.
  */
-export interface FilterDefinition {
+export declare class FilterDefinition {
     priority: number;
     filterClass: any;
-    packageRegex?: RegExp;
+    /**
+     * Glob pattern to match controller file paths.
+     * If not specified, defaults to matching all controllers.
+     */
+    filepathPattern: string;
+    constructor(priority: number, filterClass: any, filepathPattern: string);
 }
 /**
  * Request data passed to route handlers.
  */
-export interface RouteRequest {
+export declare class RouteRequest {
     body?: any;
     query?: Record<string, any>;
     params?: Record<string, any>;
     headers?: Record<string, any>;
+    constructor(body?: any, query?: Record<string, any>, params?: Record<string, any>, headers?: Record<string, any>);
 }
 /**
  * Context passed to route handlers.
  * Contains DI container, request data, and extracted parameters.
  */
-export interface RouteContext {
+export declare class RouteContext {
     /** DI container for resolving dependencies */
     container: Container;
     /** Extracted parameters (e.g., from request body, path params) */
     params: any[];
     /** Original request data */
     request?: RouteRequest;
+    constructor(container: Container, params: any[], request?: RouteRequest);
 }
 /**
  * Handler class for routes.

package/src/WebAppMeta.js

@@ -1,6 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteHandler = void 0;
+exports.RouteHandler = exports.RouteContext = exports.RouteRequest = exports.FilterDefinition = exports.RouteDefinition = void 0;
+/**
+ * Definition of a single route.
+ *
+ * Generic type parameter TResult represents the return type of the route handler.
+ * This provides type safety for the entire request/response cycle.
+ */
+class RouteDefinition {
+    constructor(method, path, handler, controllerFilepath) {
+        this.method = method;
+        this.path = path;
+        this.handler = handler;
+        this.controllerFilepath = controllerFilepath;
+    }
+}
+exports.RouteDefinition = RouteDefinition;
+/**
+ * Definition of a filter with priority.
+ *
+ * Use filepathPattern to scope filters to specific controllers:
+ *   - 'src/controllers/admin/**' + '/*.ts' - All admin controllers
+ *   - '**' + '/admin/**' - Any file in admin directories
+ *   - '**' + '/UserController.ts' - Specific controller file
+ *
+ * If filepathPattern is not specified, the filter matches all controllers.
+ */
+class FilterDefinition {
+    constructor(priority, filterClass, filepathPattern) {
+        this.priority = priority;
+        this.filterClass = filterClass;
+        this.filepathPattern = filepathPattern;
+    }
+}
+exports.FilterDefinition = FilterDefinition;
+/**
+ * Request data passed to route handlers.
+ */
+class RouteRequest {
+    constructor(body, query, params, headers) {
+        this.body = body;
+        this.query = query;
+        this.params = params;
+        this.headers = headers;
+    }
+}
+exports.RouteRequest = RouteRequest;
+/**
+ * Context passed to route handlers.
+ * Contains DI container, request data, and extracted parameters.
+ */
+class RouteContext {
+    constructor(container, params, request) {
+        this.container = container;
+        this.params = params;
+        this.request = request;
+    }
+}
+exports.RouteContext = RouteContext;
 /**
  * Handler class for routes.
  * Takes a RouteContext and returns the controller method result.

package/src/WebAppMeta.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebAppMeta.js","sourceRoot":"","sources":["../../../../../packages/core/core-meta/src/WebAppMeta.ts"],"names":[],"mappings":";;;AAkEA;;;;;;;;;;;;GAYG;AACH,MAAsB,YAAY;CAOjC;AAPD,oCAOC"}
+{"version":3,"file":"WebAppMeta.js","sourceRoot":"","sources":["../../../../../packages/core/core-meta/src/WebAppMeta.ts"],"names":[],"mappings":";;;AAsBA;;;;;GAKG;AACH,MAAa,eAAe;IAM1B,YACE,MAAc,EACd,IAAY,EACZ,OAA8B,EAC9B,kBAA2B;QAE3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAC/C,CAAC;CACF;AAjBD,0CAiBC;AAED;;;;;;;;;GASG;AACH,MAAa,gBAAgB;IAU3B,YACE,QAAgB,EAChB,WAAgB,EAChB,eAAuB;QAEvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;CACF;AAnBD,4CAmBC;AAED;;GAEG;AACH,MAAa,YAAY;IAMvB,YACE,IAAU,EACV,KAA2B,EAC3B,MAA4B,EAC5B,OAA6B;QAE7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAjBD,oCAiBC;AAED;;;GAGG;AACH,MAAa,YAAY;IAQvB,YACE,SAAoB,EACpB,MAAa,EACb,OAAsB;QAEtB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAjBD,oCAiBC;AAED;;;;;;;;;;;;GAYG;AACH,MAAsB,YAAY;CAOjC;AAPD,oCAOC","sourcesContent":["import { ContainerModule, Container } from 'inversify';\n\n/**\n * Represents a route configuration that can be registered with the router.\n * Similar to Java WebPieces Routes interface.\n */\nexport interface Routes {\n  /**\n   * Configure routes using the provided RouteBuilder.\n   */\n  configure(routeBuilder: RouteBuilder): void;\n}\n\n/**\n * Builder for registering routes.\n * Will be implemented in http-routing package.\n */\nexport interface RouteBuilder {\n  addRoute<TResult = unknown>(route: RouteDefinition<TResult>): void;\n  addFilter(filter: FilterDefinition): void;\n}\n\n/**\n * Definition of a single route.\n *\n * Generic type parameter TResult represents the return type of the route handler.\n * This provides type safety for the entire request/response cycle.\n */\nexport class RouteDefinition<TResult = unknown> {\n  method: string;\n  path: string;\n  handler: RouteHandler<TResult>;\n  controllerFilepath?: string;\n\n  constructor(\n    method: string,\n    path: string,\n    handler: RouteHandler<TResult>,\n    controllerFilepath?: string\n  ) {\n    this.method = method;\n    this.path = path;\n    this.handler = handler;\n    this.controllerFilepath = controllerFilepath;\n  }\n}\n\n/**\n * Definition of a filter with priority.\n *\n * Use filepathPattern to scope filters to specific controllers:\n *   - 'src/controllers/admin/**' + '/*.ts' - All admin controllers\n *   - '**' + '/admin/**' - Any file in admin directories\n *   - '**' + '/UserController.ts' - Specific controller file\n *\n * If filepathPattern is not specified, the filter matches all controllers.\n */\nexport class FilterDefinition {\n  priority: number;\n  filterClass: any;\n\n  /**\n   * Glob pattern to match controller file paths.\n   * If not specified, defaults to matching all controllers.\n   */\n  filepathPattern: string;\n\n  constructor(\n    priority: number,\n    filterClass: any,\n    filepathPattern: string,\n  ) {\n    this.priority = priority;\n    this.filterClass = filterClass;\n    this.filepathPattern = filepathPattern;\n  }\n}\n\n/**\n * Request data passed to route handlers.\n */\nexport class RouteRequest {\n  body?: any;\n  query?: Record<string, any>;\n  params?: Record<string, any>;\n  headers?: Record<string, any>;\n\n  constructor(\n    body?: any,\n    query?: Record<string, any>,\n    params?: Record<string, any>,\n    headers?: Record<string, any>\n  ) {\n    this.body = body;\n    this.query = query;\n    this.params = params;\n    this.headers = headers;\n  }\n}\n\n/**\n * Context passed to route handlers.\n * Contains DI container, request data, and extracted parameters.\n */\nexport class RouteContext {\n  /** DI container for resolving dependencies */\n  container: Container;\n  /** Extracted parameters (e.g., from request body, path params) */\n  params: any[];\n  /** Original request data */\n  request?: RouteRequest;\n\n  constructor(\n    container: Container,\n    params: any[],\n    request?: RouteRequest\n  ) {\n    this.container = container;\n    this.params = params;\n    this.request = request;\n  }\n}\n\n/**\n * Handler class for routes.\n * Takes a RouteContext and returns the controller method result.\n *\n * Generic type parameter TResult represents the return type of the controller method.\n * Example: RouteHandler<SaveResponse> for a method that returns Promise<SaveResponse>\n *\n * Using unknown as default instead of any forces type safety - consumers must\n * handle the result appropriately rather than assuming any type.\n *\n * This is a class instead of a function type to make it easier to trace\n * who is calling what in the debugger/IDE.\n */\nexport abstract class RouteHandler<TResult = unknown> {\n  /**\n   * Execute the route handler.\n   * @param context - The route context containing DI container, params, and request\n   * @returns Promise of the controller method result\n   */\n  abstract execute(context: RouteContext): Promise<TResult>;\n}\n\n/**\n * Main application metadata interface.\n * Similar to Java WebPieces WebAppMeta.\n *\n * This is the entry point that WebpiecesServer calls to configure your application.\n */\nexport interface WebAppMeta {\n  /**\n   * Returns the list of Inversify container modules for dependency injection.\n   * Similar to getGuiceModules() in Java.\n   */\n  getDIModules(): ContainerModule[];\n\n  /**\n   * Returns the list of route configurations.\n   * Similar to getRouteModules() in Java.\n   */\n  getRoutes(): Routes[];\n}\n"]}

package/src/index.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteHandler = void 0;
+exports.RouteRequest = exports.RouteContext = exports.RouteHandler = exports.FilterDefinition = exports.RouteDefinition = void 0;
 var WebAppMeta_1 = require("./WebAppMeta");
+Object.defineProperty(exports, "RouteDefinition", { enumerable: true, get: function () { return WebAppMeta_1.RouteDefinition; } });
+Object.defineProperty(exports, "FilterDefinition", { enumerable: true, get: function () { return WebAppMeta_1.FilterDefinition; } });
 Object.defineProperty(exports, "RouteHandler", { enumerable: true, get: function () { return WebAppMeta_1.RouteHandler; } });
+Object.defineProperty(exports, "RouteContext", { enumerable: true, get: function () { return WebAppMeta_1.RouteContext; } });
+Object.defineProperty(exports, "RouteRequest", { enumerable: true, get: function () { return WebAppMeta_1.RouteRequest; } });
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/core-meta/src/index.ts"],"names":[],"mappings":";;;AAAA,2CASsB;AAHpB,0GAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/core-meta/src/index.ts"],"names":[],"mappings":";;;AAAA,2CASsB;AALpB,6GAAA,eAAe,OAAA;AACf,8GAAA,gBAAgB,OAAA;AAChB,0GAAA,YAAY,OAAA;AACZ,0GAAA,YAAY,OAAA;AACZ,0GAAA,YAAY,OAAA","sourcesContent":["export {\n  WebAppMeta,\n  Routes,\n  RouteBuilder,\n  RouteDefinition,\n  FilterDefinition,\n  RouteHandler,\n  RouteContext,\n  RouteRequest,\n} from './WebAppMeta';\n"]}