@enonic-types/core 8.0.0 → 8.0.1

package/index.d.ts

@@ -358,6 +358,8 @@ export interface MappedResponse {
 export interface ResponseInterface
     extends Partial<MappedResponse> {
     redirect?: string;
+    webSocket?: WebSocketResponse;
+    sse?: SseResponse;
 }
 
 export interface DefaultResponse
@@ -384,6 +386,31 @@ export type HttpFilterNext<
     ResponseToJava extends ResponseInterface = DefaultResponse
 > = (request: RequestToJava) => ResponseToJava;
 
+export interface WebSocketResponse {
+    data?: Record<string, string>;
+    subProtocols?: string | string[];
+    checkOrigin?: (origin: string) => boolean;
+
+    /**
+     * When `true` (default), the WebSocket is closed with code 1008 when its HTTP session ends — either
+     * through logout (invalidation) or idle-timeout expiry. Set to `false` to let the socket outlive the
+     * session.
+     */
+    terminateOnSessionExit?: boolean;
+
+    /**
+     * When `true`, inbound WebSocket messages refresh (access) the HTTP session, keeping it alive.
+     * Server-to-client messages never count. Defaults to `false`.
+     */
+    sessionAccess?: boolean;
+
+    /**
+     * Minimum interval, in milliseconds, between session refreshes when `sessionAccess` is enabled.
+     * Defaults to 60000.
+     */
+    sessionAccessThrottleMs?: number;
+}
+
 export interface WebSocketSession {
     id: string;
     params: Record<string, string | string[]>;
@@ -404,6 +431,26 @@ export interface WebSocketEvent<T> {
 
 type WebSocketEventHandler<T = Record<string, unknown>> = (event: WebSocketEvent<T>) => void;
 
+export interface SseResponse<T = Record<string, unknown>> {
+    /**
+     * Per-connection state, exposed (unchanged) on every {@link SseEvent} fired for this connection. Lets an
+     * `sseEvent` handler share setup-time state between the `open` event and the later `close` / `timeout` /
+     * `error` events. Defaults to an empty object.
+     */
+    attributes?: T;
+
+    /**
+     * Client reconnection hint in milliseconds, sent to the browser as the initial `retry:` field. A negative
+     * value (the default) is not sent, leaving the client to use its own default.
+     */
+    retry?: number;
+
+    /**
+     * Async context timeout in milliseconds. A value of zero or less (the default) means no timeout.
+     */
+    timeout?: number;
+}
+
 export type SseEventType = 'open' | 'close' | 'timeout' | 'error';
 
 export interface SseEvent<T = Record<string, unknown>> {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/core",
-    "version": "8.0.0",
+    "version": "8.0.1",
     "description": "Shared type definition for core libraries.",
     "types": "index.d.ts",
     "files": [