http-request-manager 18.10.0 → 18.10.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-manager",
-  "version": "18.10.0",
+  "version": "18.10.2",
   "homepage": "https://wavecoders.ca",
   "author": "Mike Bonifacio <wavecoders@gmail.com> (http://wavecoders@gmail.com/)",
   "description": "This is an Angular Module containing Components/Services using Material",

package/types/http-request-manager.d.ts

@@ -12,7 +12,6 @@ import { TranslateService } from '@ngx-translate/core';
 import * as _angular_forms from '@angular/forms';
 import { FormArray, FormBuilder, FormControl } from '@angular/forms';
 import { DataSource } from '@angular/cdk/collections';
-import * as http_request_manager from 'http-request-manager';
 import * as i4 from '@angular/common';
 import * as i7 from '@angular/material/button';
 import * as i20 from '@angular/material/tabs';
@@ -225,17 +224,6 @@ declare class ApiRequest implements ApiRequestInterface {
     static adapt(item?: any): ApiRequest;
 }
 
-interface ChannelInfoInterface {
-    name: string;
-    canSubscribe: boolean;
-}
-declare class ChannelInfo implements ChannelInfoInterface {
-    name: string;
-    canSubscribe: boolean;
-    constructor(name?: string, canSubscribe?: boolean);
-    static adapt(item?: any): ChannelInfo;
-}
-
 interface WSUserInterface {
     id: string;
     ldap?: string;
@@ -252,10 +240,96 @@ declare class WSUser implements WSUserInterface {
     static adapt(item?: any): WSUser;
 }
 
-declare enum CommunicationType {
-    MESSAGE = 0,
-    ALERT = 1,
-    OTHER = 2
+interface StateMessageInterface {
+    sessionId: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+    };
+    content: any;
+}
+declare class StateMessage implements StateMessageInterface {
+    sessionId: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+    };
+    content: any;
+    constructor(sessionId?: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+    }, content?: any);
+    static adapt(item?: any): StateMessage;
+}
+
+interface PublicMessageInterface {
+    sessionId: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+    };
+    content: {
+        message: string;
+        [key: string]: any;
+    };
+}
+declare class PublicMessage implements PublicMessageInterface {
+    sessionId: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+    };
+    content: {
+        message: string;
+        [key: string]: any;
+    };
+    constructor(sessionId?: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+    }, content?: {
+        message: string;
+        [key: string]: any;
+    });
+    static adapt(item?: any): PublicMessage;
+}
+
+interface NotificationMessageInterface {
+    sessionId: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+        color?: string;
+    };
+    message: string;
+    [key: string]: any;
+}
+declare class NotificationMessage implements NotificationMessageInterface {
+    sessionId: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+        color?: string;
+    };
+    message: string;
+    [key: string]: any;
+    constructor(sessionId?: {
+        id: string;
+        ldap?: string;
+        name?: string;
+        email?: string;
+        color?: string;
+    }, message?: string, additionalProperties?: any);
+    static adapt(item?: any): NotificationMessage;
 }
 
 interface DatabaseStorageInterface {
@@ -366,6 +440,53 @@ declare class ChannelMessage implements ChannelMessageInterface {
     static adapt(item?: any): ChannelMessage;
 }
 
+/**
+ * LoggerService for http-request-manager library
+ *
+ * Automatically enables debug logging in development mode,
+ * disables it in production mode.
+ *
+ * Usage:
+ * ```typescript
+ * constructor(private logger: LoggerService) {}
+ *
+ * this.logger.debug('WebSocket', 'Connected successfully');
+ * this.logger.info('HTTP', 'Request completed', { status: 200 });
+ * this.logger.warn('State', 'Cache miss for key', { key: 'user' });
+ * this.logger.error('Database', 'Connection failed', error);
+ * ```
+ */
+declare class LoggerService {
+    private debugMode;
+    constructor();
+    /**
+     * Debug level logging - only shown in development mode
+     * Use for: Detailed diagnostic information, state changes, connection events
+     */
+    debug(context: string, message: string, data?: any): void;
+    /**
+     * Info level logging - only shown in development mode
+     * Use for: Important operational messages, successful operations
+     */
+    info(context: string, message: string, data?: any): void;
+    /**
+     * Warning level logging - always shown
+     * Use for: Potential issues, deprecated usage, recoverable errors
+     */
+    warn(context: string, message: string, data?: any): void;
+    /**
+     * Error level logging - always shown
+     * Use for: Actual errors, failures, exceptions
+     */
+    error(context: string, message: string, data?: any): void;
+    /**
+     * Check if debug mode is enabled (development mode)
+     */
+    isDebugEnabled(): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LoggerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<LoggerService>;
+}
+
 /**
  * Channel type enum for different communication purposes
  * - STATE: Private channels for state synchronization (SYS- prefix)
@@ -397,6 +518,7 @@ declare class HTTPManagerStateService<T extends {
     dbManagerService: DatabaseManagerService;
     localStorageManagerService: LocalStorageManagerService;
     utils: UtilsService;
+    logger: LoggerService;
     error$: Observable<boolean>;
     isPending$: Observable<boolean>;
     private page;
@@ -587,6 +709,7 @@ declare class HTTPManagerStateService<T extends {
 }
 
 declare class WebsocketService {
+    private logger;
     private socket;
     private messages;
     messages$: Observable<any>;
@@ -630,25 +753,12 @@ declare class WebsocketService {
      * Get all notification channels (in-memory)
      */
     getNotificationChannels(): void;
-    /**
-     * Get today's notification channels from database
-     * Returns unique channels that have notifications posted today
-     */
     getTodaysNotificationChannels(): void;
-    /**
-     * Subscribe to a notification channel with optional date filters
-     */
     subscribeToNotificationChannel(channel: string, options?: {
         startEpoch?: number;
         endEpoch?: number;
     }, user?: any): void;
-    /**
-     * Unsubscribe from a notification channel
-     */
     unsubscribeFromNotificationChannel(channel: string): void;
-    /**
-     * Send a notification to a channel
-     */
     sendNotification(channel: string, content: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<WebsocketService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<WebsocketService>;
@@ -827,6 +937,62 @@ declare class WebSocketManagerService {
     static ɵprov: i0.ɵɵInjectableDeclaration<WebSocketManagerService>;
 }
 
+/**
+ * WebSocketMessageService - Unified service for sending WebSocket messages
+ *
+ * Provides type-safe methods for sending messages with automatic prefix management.
+ * Supports three message types: State (SYS-), Public (PUB-), and Notification (MES-).
+ *
+ * Features:
+ * - Type-safe message models
+ * - Automatic prefix management
+ * - Runtime validation
+ * - Boolean return values for success/failure
+ * - Silent failure with console errors
+ */
+declare class WebSocketMessageService {
+    private wsManagerService;
+    private logger;
+    /**
+     * Send state message (SYS- prefix)
+     * Used for CRUD operations and state synchronization
+     *
+     * @param path - Path array (e.g., ['ai', 'tests'])
+     * @param payload - StateMessage with sessionId and content
+     * @returns true if sent successfully, false otherwise
+     */
+    sendStateMessage(path: (string | number)[], payload: StateMessage): boolean;
+    /**
+     * Send public message (PUB- prefix)
+     * Used for chat, broadcast, general messaging
+     *
+     * @param channel - Channel name (without prefix)
+     * @param payload - PublicMessage with sessionId and content.message
+     * @returns true if sent successfully, false otherwise
+     */
+    sendPublicMessage(channel: string, payload: PublicMessage): boolean;
+    /**
+     * Send notification (MES- prefix)
+     * Used for persistent notifications with history
+     *
+     * @param channel - Channel name (without prefix)
+     * @param payload - NotificationMessage with sessionId and message
+     * @returns true if sent successfully, false otherwise
+     */
+    sendNotification(channel: string, payload: NotificationMessage): boolean;
+    /**
+     * Send to custom channel (no prefix)
+     * User provides full channel name
+     *
+     * @param channel - Full channel name
+     * @param payload - Any message payload
+     * @returns true if sent successfully, false otherwise
+     */
+    sendToCustomChannel(channel: string, payload: any): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WebSocketMessageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WebSocketMessageService>;
+}
+
 declare class RequestService extends WebsocketService {
     private http;
     private pathQueryService;
@@ -2431,7 +2597,7 @@ declare class MessageServiceDemo {
     communicationMessages$: rxjs.Observable<any[]>;
     latestCommunicationMessages$: rxjs.Observable<any>;
     connectionStatus$: rxjs.Observable<boolean>;
-    user$: rxjs.Observable<http_request_manager.WSUser | null>;
+    user$: rxjs.Observable<WSUser | null>;
     data$: rxjs.Observable<any>;
     /**
      * Helper to ensure channel has PUB- prefix
@@ -2631,7 +2797,8 @@ declare class WsDataControlComponent implements OnInit {
     user: any;
     path: (string | number)[];
     stateDataRequestService: StateDataRequestService;
-    user$: rxjs.Observable<http_request_manager.WSUser | null>;
+    webSocketMessageService: WebSocketMessageService;
+    user$: rxjs.Observable<WSUser | null>;
     users$: rxjs.Observable<any[]>;
     userAction$: rxjs.Observable<any>;
     data$: rxjs.Observable<any>;
@@ -2641,10 +2808,156 @@ declare class WsDataControlComponent implements OnInit {
     onAddData(): void;
     onUpdateData(data: any[]): void;
     onRemoveData(data: any): void;
+    /**
+     * Test direct state message via WebSocketMessageService
+     * Sends an UPDATE message that should trigger fetchRecord() in the state manager
+     *
+     * @param recordId - The record ID to update (default: 63)
+     * @param useFakeSessionId - If true, uses a fake sessionId to avoid filtering (default: true)
+     * @param customSessionId - Optional custom sessionId (overrides useFakeSessionId if provided)
+     */
+    onTestDirectStateMessage(recordId?: number, useFakeSessionId?: boolean, customSessionId?: string): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<WsDataControlComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<WsDataControlComponent, "app-ws-data-control", never, { "server": { "alias": "server"; "required": false; }; "wsServer": { "alias": "wsServer"; "required": false; }; "jwtToken": { "alias": "jwtToken"; "required": false; }; "user": { "alias": "user"; "required": false; }; "path": { "alias": "path"; "required": false; }; }, {}, never, never, false, never>;
 }
 
+interface SlideInterface {
+    title: string;
+    message: string;
+    image?: string;
+    icon?: string;
+}
+declare class Slide implements SlideInterface {
+    title: string;
+    message: string;
+    image?: string | undefined;
+    icon?: string | undefined;
+    constructor(title?: string, message?: string, image?: string | undefined, icon?: string | undefined);
+    static adapt(item?: any): Slide;
+}
+
+interface ActionInterface {
+    label: string;
+    action: 'close' | 'navigate' | 'callback' | 'custom';
+    target?: string;
+    callback?: string;
+    primary?: boolean;
+}
+declare class Action implements ActionInterface {
+    label: string;
+    action: 'close' | 'navigate' | 'callback' | 'custom';
+    target?: string | undefined;
+    callback?: string | undefined;
+    primary?: boolean | undefined;
+    constructor(label?: string, action?: 'close' | 'navigate' | 'callback' | 'custom', target?: string | undefined, callback?: string | undefined, primary?: boolean | undefined);
+    static adapt(item?: any): Action;
+}
+
+type DisplayType = 'snackbar' | 'dialog' | 'carousel' | 'banner' | 'inline';
+interface DisplayConfigInterface {
+    type: DisplayType;
+    supportsMarkdown?: boolean;
+    stackable?: boolean;
+    queueBehavior?: 'replace' | 'queue' | 'ignore';
+    autoDismiss?: number;
+    width?: string;
+    height?: string;
+}
+declare class DisplayConfig implements DisplayConfigInterface {
+    type: DisplayType;
+    supportsMarkdown?: boolean | undefined;
+    stackable?: boolean | undefined;
+    queueBehavior?: ("replace" | "queue" | "ignore") | undefined;
+    autoDismiss?: number | undefined;
+    width?: string | undefined;
+    height?: string | undefined;
+    constructor(type?: DisplayType, supportsMarkdown?: boolean | undefined, stackable?: boolean | undefined, queueBehavior?: ("replace" | "queue" | "ignore") | undefined, autoDismiss?: number | undefined, width?: string | undefined, height?: string | undefined);
+    static adapt(item?: any): DisplayConfig;
+}
+
+interface MessageContentInterface {
+    displayConfig?: DisplayConfig;
+    title?: string;
+    message: string;
+    slides?: Slide[];
+    image?: string;
+    images?: string[];
+    actions?: Action[];
+    messageType?: string;
+    icon?: string;
+    data?: any;
+}
+declare class MessageContent implements MessageContentInterface {
+    displayConfig?: DisplayConfig | undefined;
+    title?: string | undefined;
+    message: string;
+    slides?: Slide[] | undefined;
+    image?: string | undefined;
+    images?: string[] | undefined;
+    actions?: Action[] | undefined;
+    messageType?: string | undefined;
+    icon?: string | undefined;
+    data?: any;
+    constructor(displayConfig?: DisplayConfig | undefined, title?: string | undefined, message?: string, slides?: Slide[] | undefined, image?: string | undefined, images?: string[] | undefined, actions?: Action[] | undefined, messageType?: string | undefined, icon?: string | undefined, data?: any);
+    static adapt(item?: any): MessageContent;
+}
+interface CommunicationMessageInterface {
+    type: string;
+    messageId?: number;
+    channel?: string;
+    sessionId?: {
+        id: string;
+    };
+    timestamp?: string;
+    content: MessageContent;
+}
+declare class CommunicationMessage implements CommunicationMessageInterface {
+    type: string;
+    messageId?: number | undefined;
+    channel?: string | undefined;
+    sessionId?: {
+        id: string;
+    } | undefined;
+    timestamp?: string | undefined;
+    content: MessageContent;
+    constructor(type?: string, messageId?: number | undefined, channel?: string | undefined, sessionId?: {
+        id: string;
+    } | undefined, timestamp?: string | undefined, content?: MessageContent);
+    static adapt(item?: any): CommunicationMessage;
+}
+
+interface IDisplayStrategy {
+    name: string;
+    canHandle(message: CommunicationMessage): boolean;
+    display(message: CommunicationMessage, config: DisplayConfig): void;
+}
+
+interface DisplayRuleInterface {
+    id: string;
+    name?: string;
+    match: (message: CommunicationMessage) => boolean;
+    display: DisplayConfig;
+}
+declare class DisplayRule implements DisplayRuleInterface {
+    id: string;
+    name?: string | undefined;
+    match: (message: CommunicationMessage) => boolean;
+    display: DisplayConfig;
+    constructor(id?: string, name?: string | undefined, match?: (message: CommunicationMessage) => boolean, display?: DisplayConfig);
+    static adapt(item?: any): DisplayRule;
+}
+
+declare class MessageDisplayRouterService {
+    private snackbarStrategy;
+    private strategies;
+    private rules;
+    display(message: CommunicationMessage): void;
+    registerStrategies(strategies: IDisplayStrategy[]): void;
+    setRules(rules: DisplayRule[]): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MessageDisplayRouterService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MessageDisplayRouterService>;
+}
+
 declare class WsMessagingComponent implements OnInit, OnDestroy {
     server: string;
     wsServer: string;
@@ -2655,7 +2968,7 @@ declare class WsMessagingComponent implements OnInit, OnDestroy {
     fb: FormBuilder;
     messageService: MessageServiceDemo;
     stateService: StateServiceDemo;
-    toastService: ToastMessageDisplayService;
+    messageDisplayService: MessageDisplayRouterService;
     channels$: Observable<string[]>;
     subscribedChannels$: Observable<string[]>;
     user$: Observable<WSUser | null>;
@@ -2887,5 +3200,5 @@ declare class HttpRequestManagerModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<HttpRequestManagerModule>;
 }
 
-export { ApiRequest, AppService, AsymmetricalEncryptionService, CONFIG_SETTINGS_TOKEN, ChannelInfo, ChannelType, CommunicationType, ConfigHTTPOptions, ConfigOptions, DataType, DatabaseDataDemoComponent, DatabaseManagerService, DatabaseStorage, DbService, ErrorDisplaySettings, GlobalStoreOptions, HTTPManagerService, HTTPManagerSignalsService, HTTPManagerStateService, HeadersService, HttpRequestManagerModule, HttpRequestServicesDemoComponent, LocalStorageDemoComponent, LocalStorageManagerService, LocalStorageOptions, LocalStorageSignalsManagerService, PathQueryService, Random, RandomHSLColor, RandomHexColor, RandomNumber, RandomNumbers, RandomNumbersUnique, RandomPaletteColor, RandomSignature, RandomStr, RandomVisibleColor, RequestErrorInterceptor, RequestHeadersInterceptor, RequestManagerDemoComponent, RequestManagerStateDemoComponent, RequestOptions, RequestService, RequestSignalsService, RetryOptions, SettingOptions, StateStorageOptions, StorageData, StorageOption, StorageType, StoreStateManagerService, StreamType, SymmetricalEncryptionService, TableSchemaDef, UUID, UUID_STR, UserData, UtilsService, WSOptions, WSUser, WebSocketManagerService, WebsocketService, WithCredentialsInterceptor, countdown, createChannelName, delayedRetry, requestPolling, requestStreaming, streamAI, streamAuto, streamEvents, streamJSON, streamNDJSON };
-export type { APIStateManagerData, ApiRequestInterface, ChannelInfoInterface, ConfigHTTPOptionsInterface, ConfigOptionsInterface, DatabaseStorageInterface, ErrorDisplaySettingsInterface, GlobalStoreOptionsInterface, LocalStorageOptionsInterface, ParsingResult, RequestOptionsInterface, RetryOptionsInterface, SettingOptionsInterface, State, StateStorageOptionsInterface, StateStoreManagerData, StorageDataInterface, StorageOptionInterface, StreamConfig, StreamEvent, TableRecord, TableSchemaDefInterface, UserDataInterface, WSOptionsInterface, WSUserInterface };
+export { ApiRequest, AppService, AsymmetricalEncryptionService, CONFIG_SETTINGS_TOKEN, ChannelType, ConfigHTTPOptions, ConfigOptions, DataType, DatabaseDataDemoComponent, DatabaseManagerService, DatabaseStorage, DbService, ErrorDisplaySettings, GlobalStoreOptions, HTTPManagerService, HTTPManagerSignalsService, HTTPManagerStateService, HeadersService, HttpRequestManagerModule, HttpRequestServicesDemoComponent, LocalStorageDemoComponent, LocalStorageManagerService, LocalStorageOptions, LocalStorageSignalsManagerService, LoggerService, NotificationMessage, PathQueryService, PublicMessage, Random, RandomHSLColor, RandomHexColor, RandomNumber, RandomNumbers, RandomNumbersUnique, RandomPaletteColor, RandomSignature, RandomStr, RandomVisibleColor, RequestErrorInterceptor, RequestHeadersInterceptor, RequestManagerDemoComponent, RequestManagerStateDemoComponent, RequestOptions, RequestService, RequestSignalsService, RetryOptions, SettingOptions, StateMessage, StateStorageOptions, StorageData, StorageOption, StorageType, StoreStateManagerService, StreamType, SymmetricalEncryptionService, TableSchemaDef, UUID, UUID_STR, UserData, UtilsService, WSOptions, WebSocketMessageService, WithCredentialsInterceptor, countdown, createChannelName, delayedRetry, requestPolling, requestStreaming, streamAI, streamAuto, streamEvents, streamJSON, streamNDJSON };
+export type { APIStateManagerData, ApiRequestInterface, ConfigHTTPOptionsInterface, ConfigOptionsInterface, DatabaseStorageInterface, ErrorDisplaySettingsInterface, GlobalStoreOptionsInterface, LocalStorageOptionsInterface, NotificationMessageInterface, ParsingResult, PublicMessageInterface, RequestOptionsInterface, RetryOptionsInterface, SettingOptionsInterface, State, StateMessageInterface, StateStorageOptionsInterface, StateStoreManagerData, StorageDataInterface, StorageOptionInterface, StreamConfig, StreamEvent, TableRecord, TableSchemaDefInterface, UserDataInterface, WSOptionsInterface };