@webpieces/core-meta 0.1.0

package/README.md

@@ -0,0 +1,19 @@
+# @webpieces/core-meta
+
+> Core metadata interfaces for WebPieces framework
+
+Part of the [WebPieces TypeScript](https://github.com/deanhiller/webpieces-ts) framework.
+
+## Installation
+
+```bash
+npm install @webpieces/core-meta
+```
+
+## Documentation
+
+See the main [WebPieces README](https://github.com/deanhiller/webpieces-ts#readme) for complete documentation and examples.
+
+## License
+
+Apache-2.0

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@webpieces/core-meta",
+  "version": "0.1.0",
+  "description": "Core metadata interfaces for WebPieces framework",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "author": "Dean Hiller",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/deanhiller/webpieces-ts.git",
+    "directory": "packages/core/core-meta"
+  },
+  "keywords": [
+    "webpieces",
+    "framework",
+    "metadata"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/WebAppMeta.d.ts

@@ -0,0 +1,98 @@
+import { ContainerModule, Container } from 'inversify';
+/**
+ * Represents a route configuration that can be registered with the router.
+ * Similar to Java WebPieces Routes interface.
+ */
+export interface Routes {
+    /**
+     * Configure routes using the provided RouteBuilder.
+     */
+    configure(routeBuilder: RouteBuilder): void;
+}
+/**
+ * Builder for registering routes.
+ * Will be implemented in http-routing package.
+ */
+export interface RouteBuilder {
+    addRoute<TResult = unknown>(route: RouteDefinition<TResult>): void;
+    addFilter(filter: FilterDefinition): void;
+}
+/**
+ * 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.
+ */
+export interface RouteDefinition<TResult = unknown> {
+    method: string;
+    path: string;
+    handler: RouteHandler<TResult>;
+}
+/**
+ * Definition of a filter with priority.
+ */
+export interface FilterDefinition {
+    priority: number;
+    filterClass: any;
+    packageRegex?: RegExp;
+}
+/**
+ * Request data passed to route handlers.
+ */
+export interface RouteRequest {
+    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 {
+    /** DI container for resolving dependencies */
+    container: Container;
+    /** Extracted parameters (e.g., from request body, path params) */
+    params: any[];
+    /** Original request data */
+    request?: RouteRequest;
+}
+/**
+ * Handler class for routes.
+ * Takes a RouteContext and returns the controller method result.
+ *
+ * Generic type parameter TResult represents the return type of the controller method.
+ * Example: RouteHandler<SaveResponse> for a method that returns Promise<SaveResponse>
+ *
+ * Using unknown as default instead of any forces type safety - consumers must
+ * handle the result appropriately rather than assuming any type.
+ *
+ * This is a class instead of a function type to make it easier to trace
+ * who is calling what in the debugger/IDE.
+ */
+export declare abstract class RouteHandler<TResult = unknown> {
+    /**
+     * Execute the route handler.
+     * @param context - The route context containing DI container, params, and request
+     * @returns Promise of the controller method result
+     */
+    abstract execute(context: RouteContext): Promise<TResult>;
+}
+/**
+ * Main application metadata interface.
+ * Similar to Java WebPieces WebAppMeta.
+ *
+ * This is the entry point that WebpiecesServer calls to configure your application.
+ */
+export interface WebAppMeta {
+    /**
+     * Returns the list of Inversify container modules for dependency injection.
+     * Similar to getGuiceModules() in Java.
+     */
+    getDIModules(): ContainerModule[];
+    /**
+     * Returns the list of route configurations.
+     * Similar to getRouteModules() in Java.
+     */
+    getRoutes(): Routes[];
+}

package/src/WebAppMeta.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteHandler = void 0;
+/**
+ * Handler class for routes.
+ * Takes a RouteContext and returns the controller method result.
+ *
+ * Generic type parameter TResult represents the return type of the controller method.
+ * Example: RouteHandler<SaveResponse> for a method that returns Promise<SaveResponse>
+ *
+ * Using unknown as default instead of any forces type safety - consumers must
+ * handle the result appropriately rather than assuming any type.
+ *
+ * This is a class instead of a function type to make it easier to trace
+ * who is calling what in the debugger/IDE.
+ */
+class RouteHandler {
+}
+exports.RouteHandler = RouteHandler;
+//# sourceMappingURL=WebAppMeta.js.map

package/src/WebAppMeta.js.map

@@ -0,0 +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"}

package/src/index.d.ts

@@ -0,0 +1 @@
+export { WebAppMeta, Routes, RouteBuilder, RouteDefinition, FilterDefinition, RouteHandler, RouteContext, RouteRequest, } from './WebAppMeta';

package/src/index.js

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

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/core-meta/src/index.ts"],"names":[],"mappings":";;;AAAA,2CASsB;AAHpB,0GAAA,YAAY,OAAA"}