shokupan 0.13.0 → 0.14.0

package/dist/decorators/mcp.d.ts

@@ -0,0 +1,48 @@
+export * from './di';
+/**
+ * MCP tool configuration
+ */
+export interface ToolConfig {
+    name?: string;
+    description?: string;
+    inputSchema?: any;
+}
+/**
+ * Decorator for MCP tools
+ * @param config
+ * @returns
+ */
+export declare function Tool(config?: ToolConfig): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * MCP prompt configuration
+ */
+export interface PromptConfig {
+    name?: string;
+    description?: string;
+    arguments?: {
+        name: string;
+        description?: string;
+        required?: boolean;
+    }[];
+}
+/**
+ * Decorator for MCP prompts
+ * @param config
+ * @returns
+ */
+export declare function Prompt(config?: PromptConfig): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/**
+ * MCP resource configuration
+ */
+export interface ResourceConfig {
+    name?: string;
+    description?: string;
+    mimeType?: string;
+}
+/**
+ * Decorator for MCP resources
+ * @param uri
+ * @param config
+ * @returns
+ */
+export declare function Resource(uri: string, config?: ResourceConfig): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/decorators/util/container.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Simple Dependency Injection Container
+ */
+export declare class Container {
+    private static services;
+    private static cache;
+    private static resolvingStack;
+    /**
+     * Register a service instance in the container.
+     * @param target The constructor function of the service.
+     * @param instance The instance of the service to register.
+     */
+    static register<T>(target: new (...args: any[]) => T, instance: T): void;
+    /**
+     * Get a service instance from the container.
+     * @param target The constructor function of the service.
+     * @returns The instance of the service, or undefined if not found.
+     */
+    static get<T>(target: new (...args: any[]) => T): T | undefined;
+    /**
+     * Check if a service is registered in the container.
+     * @param target The constructor function of the service.
+     * @returns True if the service is registered, false otherwise.
+     */
+    static has(target: any): boolean;
+    /**
+     * Resolve a service instance from the container.
+     * @param target The constructor function of the service.
+     * @returns The instance of the service, or undefined if not found.
+     */
+    static resolve<T>(target: new (...args: any[]) => T): T;
+    /**
+     * Teardown the container, destroying all singletons and clearing the cache.
+     */
+    static teardown(): Promise<void>;
+}

package/dist/decorators/websocket.d.ts

@@ -0,0 +1,172 @@
+/**
+ * WebSocket controller metadata
+ * @internal
+ */
+export interface WebSocketMetadata {
+    isWebSocketController: boolean;
+    path?: string;
+}
+/**
+ * Event metadata
+ * @internal
+ */
+export interface EventMetadata {
+    event: string;
+    methodName: string;
+}
+/**
+ * Marks a class as a WebSocket controller.
+ *
+ * @param path Optional base path for the WebSocket endpoint
+ *
+ * @example
+ * ```ts
+ * @WebsocketController()
+ * class ChatController {
+ *   @OnOpen()
+ *   handleOpen(ctx: ShokupanContext, ws: WebSocket) {
+ *     return { userId: "123" };
+ *   }
+ * }
+ *
+ * app.mount('/chat', ChatController);
+ * ```
+ */
+export declare function WebsocketController(path?: string): ClassDecorator;
+/**
+ * Decorator for WebSocket upgrade validation handler.
+ * Return false to reject the upgrade.
+ *
+ * @example
+ * ```ts
+ * @OnUpgrade()
+ * handleUpgrade(ctx: ShokupanContext) {
+ *   if (!ctx.get("authorization")) return false;
+ *   return true;
+ * }
+ * ```
+ */
+export declare function OnUpgrade(): MethodDecorator;
+/**
+ * Decorator for WebSocket open handler.
+ * Return value is automatically set to ws.data and ctx.state.
+ *
+ * @example
+ * ```ts
+ * @OnOpen()
+ * handleOpen(ctx: ShokupanContext, ws: WebSocket) {
+ *   return { userId: getUserId(ctx) };
+ * }
+ * ```
+ */
+export declare function OnOpen(): MethodDecorator;
+/**
+ * Decorator for event middleware handler.
+ * Runs before routing to specific event handlers.
+ * Return false or throw to prevent event routing.
+ *
+ * @example
+ * ```ts
+ * @OnEvent()
+ * handleEvent(ctx: ShokupanContext, ws: WebSocket, event: string, data: any) {
+ *   if (event.startsWith("_")) return false; // Block private events
+ * }
+ * ```
+ */
+export declare function OnEvent(): MethodDecorator;
+/**
+ * Decorator for raw message handler.
+ * Called for every message before event parsing/routing.
+ *
+ * @example
+ * ```ts
+ * @OnMessage()
+ * handleMessage(ctx: ShokupanContext, ws: WebSocket, msg: string) {
+ *   console.log("Received:", msg);
+ * }
+ * ```
+ */
+export declare function OnMessage(): MethodDecorator;
+/**
+ * Decorator for WebSocket close handler.
+ *
+ * @example
+ * ```ts
+ * @OnClose()
+ * handleClose(ctx: ShokupanContext, ws: WebSocket) {
+ *   console.log("Client disconnected");
+ * }
+ * ```
+ */
+export declare function OnClose(): MethodDecorator;
+/**
+ * Decorator for WebSocket error handler.
+ *
+ * @example
+ * ```ts
+ * @OnError()
+ * handleError(ctx: ShokupanContext, ws: WebSocket, error: Error) {
+ *   console.error("WebSocket error:", error);
+ * }
+ * ```
+ */
+export declare function OnError(): MethodDecorator;
+/**
+ * Decorator for event-specific handlers.
+ *
+ * @param event Event name to handle
+ *
+ * @example
+ * ```ts
+ * @Event("chat.message")
+ * handleChatMessage(ctx: ShokupanContext, data: any) {
+ *   ctx.broadcast("chat.message", data);
+ * }
+ * ```
+ */
+export declare function Event(event: string): MethodDecorator;
+/**
+ * Check if a class is a WebSocket controller.
+ * @internal
+ */
+export declare function isWebSocketController(target: any): boolean;
+/**
+ * Get WebSocket controller metadata.
+ * @internal
+ */
+export declare function getWebSocketMetadata(target: any): WebSocketMetadata | undefined;
+/**
+ * Get the onUpgrade handler method name.
+ * @internal
+ */
+export declare function getUpgradeHandler(target: any): string | symbol | undefined;
+/**
+ * Get the onOpen handler method name.
+ * @internal
+ */
+export declare function getOpenHandler(target: any): string | symbol | undefined;
+/**
+ * Get the onEvent handler method name.
+ * @internal
+ */
+export declare function getEventMiddlewareHandler(target: any): string | symbol | undefined;
+/**
+ * Get the onMessage handler method name.
+ * @internal
+ */
+export declare function getMessageHandler(target: any): string | symbol | undefined;
+/**
+ * Get the onClose handler method name.
+ * @internal
+ */
+export declare function getCloseHandler(target: any): string | symbol | undefined;
+/**
+ * Get the onError handler method name.
+ * @internal
+ */
+export declare function getErrorHandler(target: any): string | symbol | undefined;
+/**
+ * Get all event handlers.
+ * @internal
+ */
+export declare function getEventHandlers(target: any): EventMetadata[];