@plyaz/types 1.36.2 → 1.37.1

package/dist/core/events/index.d.ts

@@ -21,4 +21,4 @@ export { CoreEventScope, SystemEventAction, EntityEventAction, ValidationEventAc
 export type { CoreEventScopeType, SystemEventType, EntityEventType, ValidationEventType, SanitizationEventType, ApiEventType, CacheEventType, AuthEventType, DatabaseEventType, FeatureFlagEventType, StoreEventType, CoreEventType, } from './enums';
 export type { CoreEvent, CoreCrudOperation, CoreValidationStartedPayload, CoreValidationSuccessPayload, CoreValidationFailedPayload, CoreSanitizationStartedPayload, CoreSanitizationSuccessPayload, CoreSanitizationFailedPayload, CoreEntityCreatedPayload, CoreEntityUpdatedPayload, CoreEntityPatchedPayload, CoreEntityDeletedPayload, CoreEntityCreatingPayload, CoreEntityUpdatingPayload, CoreEntityPatchingPayload, CoreEntityDeletingPayload, CoreEntityErrorPayload, CoreEntityCompletePayload, CoreBulkCreatedPayload, CoreBulkDeletedPayload, CoreSystemInitializedPayload, CoreSystemReadyPayload, CoreSystemShutdownPayload, CoreSystemErrorPayload, CoreSystemWarningPayload, CoreApiRequestStartPayload, CoreApiRequestSuccessPayload, CoreApiRequestErrorPayload, CoreApiRetryPayload, CoreApiTimeoutPayload, CoreCacheHitPayload, CoreCacheMissPayload, CoreCacheSetPayload, CoreCacheDeletePayload, CoreCacheClearPayload, CoreCacheExpiredPayload, CoreCacheErrorPayload, CoreDatabaseConnectedPayload, CoreDatabaseDisconnectedPayload, CoreDatabaseQueryPayload, CoreDatabaseErrorPayload, CoreDatabaseTransactionStartPayload, CoreDatabaseTransactionCommitPayload, CoreDatabaseTransactionRollbackPayload, CoreAuthLoginPayload, CoreAuthLogoutPayload, CoreAuthTokenRefreshPayload, CoreAuthSessionExpiredPayload, CoreAuthUnauthorizedPayload, CoreFeatureFlagChangedPayload, CoreFeatureFlagEvaluatedPayload, CoreFeatureFlagRefreshedPayload, CoreStoreUpdatedPayload, CoreStoreResetPayload, CoreStoreHydratedPayload, CoreOperationRequestPayload, CoreOperationResultPayload, CoreOperationErrorPayload, CoreStorageUploadedPayload, CoreStorageDownloadedPayload, CoreStorageDeletedPayload, CoreStorageErrorPayload, CoreStorageHealthCheckPayload, CoreNotificationSentPayload, CoreNotificationFailedPayload, CoreNotificationDeliveredPayload, CoreNotificationOpenedPayload, CoreNotificationClickedPayload, CoreNotificationErrorPayload, CoreNotificationHealthCheckPayload, CoreEventPayloadMap, EventPersistenceConfig, DomainPersistenceConfig, PersistOperationConfig, FrontendEventHandlerConfig, DomainFrontendEventConfig, } from './payloads';
 export { STREAM_TRANSPORT, SYSTEM_STREAM_MESSAGE_TYPE, SYSTEM_STREAM_SUBTYPE, SYSTEM_STREAM_CHANNEL, SYSTEM_STREAM_EVENT, STREAM_MESSAGE_TYPE, STREAM_SUBTYPE, STREAM_SCOPE, STREAM_EVENT, STREAM_CHANNEL_PREFIX, STREAM_BROADCAST_CHANNEL, STREAM_PROGRESS_STATUS, FILES_STREAM_MESSAGE_TYPE, FILES_STREAM_SUBTYPE, FILES_STREAM_PROGRESS_STATUS, FILES_STREAM_EVENT, FILES_STREAM_CHANNEL_PREFIX, FILES_STREAM_BROADCAST_CHANNEL, FILES_STREAM_CHANNEL, } from './streaming';
-export type { StreamTransportType, StreamConnection, StreamConnectionInfo, SystemStreamMessageType, SystemStreamSubtype, SystemStreamChannel, StreamMessage, StreamMessageType, StreamMessageSubtype, StreamMessageScope, StreamProgressData, StreamProgressStatus, FilesUploadStreamProgress, FilesDownloadStreamProgress, FilesGenerateStreamProgress, StreamChannel, ChannelSubscription, StreamAuthResult, StreamAuthAdapterConfig, TokenAuthAdapterConfig, StreamTransportAdapterConfig, StreamBroadcasterConfig, StreamManagerStats, UseStreamConnectionOptions, UseStreamConnectionResult, UseStreamManagerOptions, UseStreamManagerResult, StreamResponse, StreamErrorEvent, PaginatedStreamResponse, StreamEndpointConfig, StreamEndpointCreateOptions, StreamBroadcasterInterface, ChannelControllerConfig, StreamMiddlewareContext, StreamMiddlewareResult, StreamMiddleware, RateLimitConfig, StreamEndpointEntry, StreamRegistryConfig, FilesStreamMessageType, FilesStreamSubtype, FilesStreamProgressStatus, FilesStreamProgressData, FilesStreamEventName, FilesStreamChannelPrefix, FilesStreamBroadcastChannel, FilesStreamChannel, } from './streaming';
+export type { StreamTransportType, StreamConnection, StreamConnectionInfo, SystemStreamMessageType, SystemStreamSubtype, SystemStreamChannel, StreamMessage, StreamMessageType, StreamMessageSubtype, StreamMessageScope, StreamProgressData, StreamProgressStatus, FilesUploadStreamProgress, FilesDownloadStreamProgress, FilesGenerateStreamProgress, StreamChannel, ChannelSubscription, StreamAuthResult, StreamAuthAdapterConfig, TokenAuthAdapterConfig, StreamTransportAdapterConfig, StreamBroadcasterConfig, StreamManagerStats, UseStreamConnectionOptions, UseStreamConnectionResult, UseStreamManagerOptions, UseStreamManagerResult, StreamResponse, StreamErrorEvent, PaginatedStreamResponse, StreamEndpointConfig, StreamEndpointCreateOptions, StreamBroadcasterInterface, ChannelControllerConfig, StreamMiddlewareContext, StreamMiddlewareResult, StreamMiddleware, RateLimitConfig, StreamEndpointEntry, StreamRegistryConfig, FilesStreamMessageType, FilesStreamSubtype, FilesStreamProgressStatus, FilesStreamProgressData, FilesStreamEventName, FilesStreamChannelPrefix, FilesStreamBroadcastChannel, FilesStreamChannel, FrameworkType, FrameworkAdapterConfig, FrameworkHandlerOptions, CoreRequestHandler, NextJSHandler, ExpressRequest, ExpressResponse, ExpressHandler, NestJSRequest, NestJSResponse, NestJSHandler, SSEConfig, WebSocketConfig, StreamingModuleServerConfig, StreamingModuleConfig, StreamingModuleAsyncOptions, } from './streaming';

package/dist/core/events/streaming/frameworks.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Framework Adapter Types
+ *
+ * Types for stream server framework adapters (Next.js, Express, NestJS, etc.).
+ * Used to integrate streaming with different web frameworks.
+ */
+import type { StreamTransportType, StreamTransportAdapterConfig, StreamChannel, StreamBroadcasterConfig } from './types';
+import type { StreamEndpointEntry } from './responses';
+/**
+ * Supported framework types for streaming adapters
+ */
+export type FrameworkType = 'nextjs' | 'express' | 'nestjs';
+/**
+ * Base configuration for framework adapters
+ */
+export interface FrameworkAdapterConfig {
+    /** Adapter name for logging */
+    name: string;
+    /** Whether adapter is enabled */
+    enabled?: boolean;
+}
+/**
+ * Options passed to framework handler creation
+ */
+export interface FrameworkHandlerOptions {
+    /** Transport type to use (default: 'sse') */
+    transport?: StreamTransportType;
+}
+/**
+ * Core request handler function type
+ * Used internally by the StreamServer
+ */
+export type CoreRequestHandler = (request: Request, transport?: StreamTransportType) => Promise<Response>;
+/**
+ * Next.js App Router handler function type
+ */
+export type NextJSHandler = (request: Request) => Promise<Response>;
+/**
+ * Express-compatible request interface
+ */
+export interface ExpressRequest {
+    /** Request URL */
+    url: string;
+    /** Request headers */
+    headers: Record<string, string | string[] | undefined>;
+    /** HTTP method */
+    method?: string;
+}
+/**
+ * Express-compatible response interface
+ */
+export interface ExpressResponse {
+    /** Write HTTP headers */
+    writeHead(statusCode: number, headers: Record<string, string>): void;
+    /** Write data to response */
+    write(chunk: string): boolean;
+    /** Listen for events */
+    on(event: string, callback: () => void): void;
+    /** End the response */
+    end(): void;
+}
+/**
+ * Express handler function type
+ */
+export type ExpressHandler = (req: ExpressRequest, res: ExpressResponse) => Promise<void>;
+/**
+ * NestJS-compatible request interface
+ */
+export interface NestJSRequest {
+    /** Request URL */
+    url: string;
+    /** Request headers */
+    headers: Record<string, string | string[] | undefined>;
+    /** HTTP method */
+    method?: string;
+    /** Query parameters (permissive for Express ParsedQs compatibility) */
+    query?: Record<string, unknown>;
+    /** Route parameters */
+    params?: Record<string, unknown>;
+}
+/**
+ * NestJS-compatible response interface
+ */
+export interface NestJSResponse {
+    /** Write HTTP headers */
+    writeHead(statusCode: number, headers: Record<string, string>): void;
+    /** Set individual header */
+    setHeader(name: string, value: string): void;
+    /** Set status code */
+    status(code: number): this;
+    /** Write data to response */
+    write(chunk: string): boolean;
+    /** Listen for events */
+    on(event: string, callback: () => void): void;
+    /** End the response */
+    end(): void;
+    /** Flush headers (optional) */
+    flushHeaders?(): void;
+}
+/**
+ * NestJS handler function type
+ */
+export type NestJSHandler = (req: NestJSRequest, res: NestJSResponse) => Promise<void>;
+/**
+ * SSE transport configuration for builder
+ */
+export interface SSEConfig extends Partial<StreamTransportAdapterConfig> {
+    /** Whether SSE is enabled */
+    enabled?: boolean;
+}
+/**
+ * WebSocket transport configuration for builder
+ */
+export interface WebSocketConfig extends Partial<StreamTransportAdapterConfig> {
+    /** Whether WebSocket is enabled */
+    enabled?: boolean;
+}
+/**
+ * Server configuration for StreamingModule
+ */
+export interface StreamingModuleServerConfig {
+    /** Broadcaster configuration */
+    broadcaster?: StreamBroadcasterConfig;
+    /** Default channels for new connections */
+    defaultChannels?: StreamChannel[];
+}
+/**
+ * Configuration for NestJS StreamingModule.forRoot()
+ */
+export interface StreamingModuleConfig {
+    /** StreamServer configuration */
+    server?: StreamingModuleServerConfig;
+    /** Stream endpoints to register */
+    endpoints?: StreamEndpointEntry[];
+    /** Whether module is global (default: true) */
+    isGlobal?: boolean;
+    /** Include StreamingController (default: true) */
+    includeController?: boolean;
+}
+/**
+ * Async configuration options for NestJS StreamingModule.forRootAsync()
+ */
+export interface StreamingModuleAsyncOptions {
+    /** Module imports */
+    imports?: unknown[];
+    /** Factory dependencies to inject */
+    inject?: unknown[];
+    /** Factory function to create config */
+    useFactory: (...args: unknown[]) => StreamingModuleConfig | Promise<StreamingModuleConfig>;
+    /** Whether module is global (default: true) */
+    isGlobal?: boolean;
+    /** Include StreamingController (default: true) */
+    includeController?: boolean;
+}

package/dist/core/events/streaming/index.d.ts

@@ -14,5 +14,6 @@
 export { STREAM_TRANSPORT, SYSTEM_STREAM_MESSAGE_TYPE, SYSTEM_STREAM_SUBTYPE, SYSTEM_STREAM_CHANNEL, SYSTEM_STREAM_EVENT, STREAM_MESSAGE_TYPE, STREAM_SUBTYPE, STREAM_SCOPE, STREAM_EVENT, STREAM_CHANNEL_PREFIX, STREAM_BROADCAST_CHANNEL, STREAM_PROGRESS_STATUS, } from './types';
 export type { StreamTransportType, StreamConnection, StreamConnectionInfo, SystemStreamMessageType, SystemStreamSubtype, SystemStreamChannel, StreamMessage, StreamMessageType, StreamMessageSubtype, StreamMessageScope, StreamProgressData, StreamProgressStatus, FilesUploadStreamProgress, FilesDownloadStreamProgress, FilesGenerateStreamProgress, StreamChannel, ChannelSubscription, StreamAuthResult, StreamAuthAdapterConfig, TokenAuthAdapterConfig, StreamTransportAdapterConfig, StreamBroadcasterConfig, StreamManagerStats, UseStreamConnectionOptions, UseStreamConnectionResult, UseStreamManagerOptions, UseStreamManagerResult, } from './types';
 export type { StreamResponse, StreamErrorEvent, PaginatedStreamResponse, StreamEndpointConfig, StreamEndpointCreateOptions, StreamBroadcasterInterface, ChannelControllerConfig, StreamMiddlewareContext, StreamMiddlewareResult, StreamMiddleware, RateLimitConfig, StreamEndpointEntry, StreamRegistryConfig, } from './responses';
+export type { FrameworkType, FrameworkAdapterConfig, FrameworkHandlerOptions, CoreRequestHandler, NextJSHandler, ExpressRequest, ExpressResponse, ExpressHandler, NestJSRequest, NestJSResponse, NestJSHandler, SSEConfig, WebSocketConfig, StreamingModuleServerConfig, StreamingModuleConfig, StreamingModuleAsyncOptions, } from './frameworks';
 export { FILES_STREAM_MESSAGE_TYPE, FILES_STREAM_SUBTYPE, FILES_STREAM_PROGRESS_STATUS, FILES_STREAM_EVENT, FILES_STREAM_CHANNEL_PREFIX, FILES_STREAM_BROADCAST_CHANNEL, FILES_STREAM_CHANNEL, } from '../../domain/files';
 export type { FilesStreamMessageType, FilesStreamSubtype, FilesStreamProgressStatus, FilesStreamProgressData, FilesStreamEventName, FilesStreamChannelPrefix, FilesStreamBroadcastChannel, FilesStreamChannel, } from '../../domain/files';

package/dist/errors/codes.d.ts

@@ -533,6 +533,7 @@ export declare const ERROR_CODES: {
     readonly STREAM_ENDPOINT_DISABLED: "stream.endpoint.disabled";
     readonly STREAM_UNKNOWN_ERROR: "stream.unknown.error";
     readonly STREAM_INITIALIZATION_FAILED: "stream.initialization.failed";
+    readonly STREAM_HANDLER_ERROR: "stream.handler.error";
 };
 /**
  * Type for all error code values
@@ -1101,6 +1102,7 @@ export declare const STREAM_ERROR_CODES: {
     readonly ENDPOINT_DISABLED: "stream.endpoint.disabled";
     readonly UNKNOWN_ERROR: "stream.unknown.error";
     readonly INITIALIZATION_FAILED: "stream.initialization.failed";
+    readonly HANDLER_ERROR: "stream.handler.error";
 };
 export type ApiErrorCodeValue = (typeof API_ERROR_CODES)[keyof typeof API_ERROR_CODES] | `HTTP_${number}`;
 export type NotificationErrorCodeValue = (typeof NOTIFICATION_ERROR_CODES)[keyof typeof NOTIFICATION_ERROR_CODES];

package/dist/errors/index.cjs

@@ -1024,7 +1024,8 @@ var ERROR_CODES = {
   STREAM_ENDPOINT_DISABLED: "stream.endpoint.disabled",
   // General
   STREAM_UNKNOWN_ERROR: "stream.unknown.error",
-  STREAM_INITIALIZATION_FAILED: "stream.initialization.failed"
+  STREAM_INITIALIZATION_FAILED: "stream.initialization.failed",
+  STREAM_HANDLER_ERROR: "stream.handler.error"
 };
 var API_ERROR_CODES = {
   CLIENT_INITIALIZATION_FAILED: ERROR_CODES.CLIENT_INITIALIZATION_FAILED,
@@ -1633,7 +1634,8 @@ var STREAM_ERROR_CODES = {
   ENDPOINT_DISABLED: ERROR_CODES.STREAM_ENDPOINT_DISABLED,
   // General
   UNKNOWN_ERROR: ERROR_CODES.STREAM_UNKNOWN_ERROR,
-  INITIALIZATION_FAILED: ERROR_CODES.STREAM_INITIALIZATION_FAILED
+  INITIALIZATION_FAILED: ERROR_CODES.STREAM_INITIALIZATION_FAILED,
+  HANDLER_ERROR: ERROR_CODES.STREAM_HANDLER_ERROR
 };
 var ERROR_DEFINITIONS = {
   // ===== Generic/Common Error Definitions =====
@@ -5880,6 +5882,14 @@ var ERROR_DEFINITIONS = {
     userMessage: "errors.stream.initialization_failed",
     severity: ERROR_SEVERITY.Critical,
     retryable: true
+  },
+  [ERROR_CODES.STREAM_HANDLER_ERROR]: {
+    code: ERROR_CODES.STREAM_HANDLER_ERROR,
+    status: HTTP_STATUS.INTERNAL_SERVER_ERROR,
+    category: ERROR_CATEGORY.System,
+    userMessage: "errors.stream.handler_error",
+    severity: ERROR_SEVERITY.High,
+    retryable: true
   }
 };