@modularizer/plat 0.1.0

package/dist/server/server.d.ts

@@ -0,0 +1,143 @@
+import { Express } from "express";
+import { PLATServerOptions } from "./config";
+import type { PLATServerTransportRuntime } from './protocol-plugin';
+export declare class PLATServer {
+    private app;
+    private options;
+    private logger;
+    private routes;
+    private registeredMethodNames;
+    private registeredControllerNames;
+    private tools;
+    private operationRegistry;
+    private core;
+    constructor(options?: PLATServerOptions, ...ControllerClasses: (new () => any)[]);
+    /**
+     * Setup Express middleware
+     */
+    private setupMiddleware;
+    /**
+     * Setup Swagger UI and ReDoc
+     */
+    private setupDocumentation;
+    /**
+     * Mount Swagger UI and ReDoc based on current options.
+     */
+    private mountDocUI;
+    /**
+     * Setup docs UI after auto-generating the OpenAPI spec.
+     * Mounts Swagger UI at /docs and ReDoc at /redoc by default.
+     */
+    private setupAutoDocumentation;
+    /**
+     * Reserved method names that conflict with plat system features
+     */
+    private static readonly RESERVED_METHOD_NAMES;
+    private matchesToolQuery;
+    /**
+     * Extract the prefix from a method name (e.g., 'get' from 'getUser')
+     * Finds the longest known prefix or the first camelCase word
+     */
+    private extractMethodPrefix;
+    /**
+     * Validate that a method name follows plat style conventions
+     *
+     * Rules (ENFORCED):
+     * - Must start with a lowercase letter
+     * - Cannot contain underscores
+     * - Must be valid camelCase
+     * - Cannot be a reserved name (tools, routes, endpoints, help, openapi)
+     * - Cannot match a controller name
+     * - Must respect allowedMethodPrefixes/disAllowedMethodPrefixes config
+     *
+     * Recommendations (NOT enforced):
+     * - Use standard prefixes for CRUD: get, list, find, create, update, delete
+     * - Use send/do for external I/O operations
+     * - Use natural names for action commands (e.g., addToCart, checkout, importFile)
+     */
+    private validateMethodName;
+    /**
+     * Register a controller class
+     *
+     * Extracts all @GET, @POST, etc. decorated methods and sets up routing.
+     * In plat, routes are 100% flat: method names become routes at the root level.
+     * No path parameters in decorators - all routing is done by method names.
+     */
+    register(...ControllerClasses: (new () => any)[]): PLATServer;
+    /**
+     * Add Express middleware
+     */
+    use(...args: any[]): PLATServer;
+    /**
+     * Create CORS middleware
+     */
+    private createCORSMiddleware;
+    /**
+     * Extract path parameters from a path string
+     * e.g., "/users/:id/posts/:postId" -> ["id", "postId"]
+     */
+    private extractPathParams;
+    /**
+     * Apply basic JQ-like filtering to JSON
+     * Supports: .key, .key.nested, .[index], .*, .[]
+     */
+    private applyJsonFilter;
+    /**
+     * Format a single route for display
+     * e.g., "GET /users/{id} - list user posts"
+     */
+    private formatRoute;
+    /**
+     * Filter routes based on query parameters
+     */
+    private filterRoutes;
+    private setupCallRoutes;
+    /**
+     * Build error response based on exposure level
+     */
+    private buildErrorResponse;
+    private isDeferredExecutionRequested;
+    private attachCallContext;
+    private applyResponseHeaders;
+    private applyRetryAfterHeaders;
+    private executeOperation;
+    private resolveOperation;
+    private dispatchTransportCall;
+    createTransportRuntime(): PLATServerTransportRuntime;
+    private serializeRpcValue;
+    /**
+     * Get the underlying Express app
+     */
+    getApp(): Express;
+    /**
+     * Listen on a port
+     * Convenience method that starts the server
+     */
+    /**
+     * Auto-generate an OpenAPI 3.1.0 spec from registered tool definitions.
+     * Called by listen() when no explicit openapi option was provided.
+     */
+    private generateOpenAPISpec;
+    listen(port?: number, hostOrCallback?: string | (() => void), callbackIfHost?: () => void): PLATServer;
+    /**
+     * Print startup message with routes and documentation info
+     */
+    private printStartupMessage;
+}
+/**
+ * Create a new plat server
+ *
+ * @example
+ * ```typescript
+ * const server = createServer({
+ *   errorExposure: 'message',
+ *   cors: true,
+ *   onRequest: (req, res, path, method) => console.log(`${method} ${path}`)
+ * })
+ * server.register(ProductsApi)
+ * server.register(OrdersApi)
+ * server.listen(3000, () => console.log('Server running'))
+ * ```
+ */
+export declare function createServer(options?: PLATServerOptions, ...ControllerClasses: (new () => any)[]): PLATServer;
+//# sourceMappingURL=server.d.ts.map

package/dist/server/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/server/server.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAC,OAAO,EAAkC,MAAM,SAAS,CAAC;AAgB1E,OAAO,EAAsD,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAIjG,OAAO,KAAK,EAAyB,0BAA0B,EAAE,MAAM,mBAAmB,CAAA;AAa1F,qBAAa,UAAU;IACnB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAmE;IACjF,OAAO,CAAC,qBAAqB,CAAoB;IACjD,OAAO,CAAC,yBAAyB,CAAoB;IACrD,OAAO,CAAC,KAAK,CAA8B;IAC3C,OAAO,CAAC,iBAAiB,CAA8B;IACvD,OAAO,CAAC,IAAI,CAAgB;gBAEhB,OAAO,GAAE,iBAAsB,EAAE,GAAG,iBAAiB,EAAE,CAAC,UAAU,GAAG,CAAC,EAAE;IAqDpF;;OAEG;IACH,OAAO,CAAC,eAAe;IAqDvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAyI1B;;OAEG;IACH,OAAO,CAAC,UAAU;IAoBlB;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAU9B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAsD;IAEnG,OAAO,CAAC,gBAAgB;IAmBxB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA2B3B;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,kBAAkB;IA4D1B;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,iBAAiB,EAAE,CAAC,UAAU,GAAG,CAAC,EAAE,GAAG,UAAU;IAoJ7D;;OAEG;IACH,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,UAAU;IAK/B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IA+C5B;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAMzB;;;OAGG;IACH,OAAO,CAAC,eAAe;IA8BvB;;;OAGG;IACH,OAAO,CAAC,WAAW;IAOnB;;OAEG;IACH,OAAO,CAAC,YAAY;IA8BpB,OAAO,CAAC,eAAe;IA6EvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,4BAA4B;IAKpC,OAAO,CAAC,iBAAiB;IAuBzB,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,sBAAsB;YAoBhB,gBAAgB;IA+M9B,OAAO,CAAC,gBAAgB;YAIV,qBAAqB;IAqBnC,sBAAsB,IAAI,0BAA0B;IAiCpD,OAAO,CAAC,iBAAiB;IAgBzB;;OAEG;IACH,MAAM,IAAI,OAAO;IAIjB;;;OAGG;IACH;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAuD3B,MAAM,CACF,IAAI,CAAC,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,EACtC,cAAc,CAAC,EAAE,MAAM,IAAI,GAC5B,UAAU;IA2Db;;OAEG;IACH,OAAO,CAAC,mBAAmB;CAgD9B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB,EAAE,GAAG,iBAAiB,EAAE,CAAC,UAAU,GAAG,CAAC,EAAE,GAAG,UAAU,CAE7G"}