http-request-manager 18.7.2 → 18.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-manager",
-  "version": "18.7.2",
+  "version": "18.7.3",
   "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

@@ -338,6 +338,24 @@ declare class ChannelMessage implements ChannelMessageInterface {
     static adapt(item?: any): ChannelMessage;
 }
 
+/**
+ * Channel type enum for different communication purposes
+ * - STATE: Private channels for state synchronization
+ * - MESSAGE: Messaging/communication channels
+ * - NOTIFICATION: Notification/broadcast channels
+ */
+declare enum ChannelType {
+    STATE = "SYS",
+    MESSAGE = "MES",
+    NOTIFICATION = "PUB"
+}
+/**
+ * Utility function to create prefixed channel name
+ * @param channelType - The type of channel
+ * @param channelName - The base channel name
+ * @returns Prefixed channel name (e.g., 'SYS-USERS123')
+ */
+declare function createChannelName(channelType: ChannelType, channelName: string): string;
 interface APIStateManagerData<T> {
     data: T[];
     dataObject: T | null;
@@ -399,6 +417,18 @@ declare class HTTPManagerStateService<T extends {
     wsOptions: WSOptions;
     connectionStatus$: Observable<boolean>;
     constructor(apiOptions: ApiRequest, dataType: DataType | undefined, database?: DatabaseStorage | undefined);
+    /**
+     * Add appropriate prefix to a channel name if not already present
+     */
+    private prefixChannel;
+    /**
+     * Remove any known prefix from a channel name
+     */
+    private stripChannelPrefix;
+    /**
+     * Get the base channel name without prefix (for display/user reference)
+     */
+    getBaseChannelName(channel: string): string;
     setApiRequestOptions(apiOptions?: ApiRequest, dataType?: DataType, database?: DatabaseStorage): void;
     private setupConnectionStatus;
     readonly initWS: (observableOrValue: WSOptions | Observable<WSOptions>) => rxjs.Subscription;
@@ -425,9 +455,26 @@ declare class HTTPManagerStateService<T extends {
     readonly createStream: (data: any | null, options?: RequestOptions) => ((observableOrValue?: any) => rxjs.Subscription) | ((observableOrValue: any) => rxjs.Subscription);
     readonly fetchStream: (options?: RequestOptions) => ((observableOrValue?: any) => rxjs.Subscription) | ((observableOrValue: any) => rxjs.Subscription);
     private wsCommunication;
+    /**
+     * Send a message to channel(s)
+     * @param message - The message content
+     * @param channels - Optional array of channel names (MES- prefix added automatically)
+     *                   Use 'allChannels' to broadcast to all
+     */
     wsMessaging(message: ChannelMessage, channels?: string[]): void;
     /**
-     * Subscribe to a single channel
+     * Subscribe to a messaging channel
+     * @param channel - Base channel name (MES- prefix added automatically)
+     */
+    subscribeToMessageChannel(channel: string): void;
+    /**
+     * Unsubscribe from a messaging channel
+     * @param channel - Base channel name (MES- prefix added automatically)
+     */
+    unsubscribeFromMessageChannel(channel: string): void;
+    /**
+     * Subscribe to a single channel (no automatic prefix)
+     * Use subscribeToMessageChannel() for MES- prefixed channels
      */
     subscribeToChannel(channel: string): void;
     /**
@@ -464,6 +511,7 @@ declare class HTTPManagerStateService<T extends {
     getUsersInChannel(channel: string): void;
     /**
      * Create a notification channel on the server
+     * @param channel - Base channel name (PUB- prefix added automatically)
      */
     createNotificationChannel(channel: string): void;
     /**
@@ -477,6 +525,7 @@ declare class HTTPManagerStateService<T extends {
     getTodaysNotificationChannels(): void;
     /**
      * Subscribe to a notification channel with optional date filters
+     * @param channel - Base channel name (PUB- prefix added automatically)
      */
     subscribeToNotificationChannel(channel: string, options?: {
         startEpoch?: number;
@@ -484,10 +533,12 @@ declare class HTTPManagerStateService<T extends {
     }, user?: any): void;
     /**
      * Unsubscribe from a notification channel
+     * @param channel - Base channel name (PUB- prefix added automatically)
      */
     unsubscribeFromNotificationChannel(channel: string): void;
     /**
      * Send a notification to a channel
+     * @param channel - Base channel name (PUB- prefix added automatically)
      */
     sendNotification(channel: string, content: any): void;
     private isEmpty;
@@ -2091,5 +2142,5 @@ declare class HttpRequestManagerModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<HttpRequestManagerModule>;
 }
 
-export { ApiRequest, AppService, AsymmetricalEncryptionService, CONFIG_SETTINGS_TOKEN, ChannelInfo, CommunicationType, ConfigHTTPOptions, ConfigOptions, DataType, DatabaseDataDemoComponent, DatabaseManagerService, DatabaseStorage, DbService, ErrorDisplaySettings, GlobalStoreOptions, HTTPManagerService, HTTPManagerSignalsService, HTTPManagerStateService, HeadersService, HttpRequestManagerModule, HttpRequestServicesDemoComponent, LocalStorageDemoComponent, LocalStorageManagerService, LocalStorageOptions, LocalStorageSignalsManagerService, PathQueryService, Random, RandomNumber, RandomNumbers, RandomNumbersUnique, RandomSignature, RandomStr, RequestErrorInterceptor, RequestHeadersInterceptor, RequestManagerDemoComponent, RequestManagerStateDemoComponent, RequestOptions, RequestService, RequestSignalsService, RetryOptions, SettingOptions, StateStorageOptions, StorageData, StorageOption, StorageType, StoreStateManagerService, SymmetricalEncryptionService, TableSchemaDef, UUID, UUID_STR, UtilsService, WSOptions, WSUser, WebsocketService, WithCredentialsInterceptor, countdown, delayedRetry, requestPolling, requestStreaming };
+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, RandomNumber, RandomNumbers, RandomNumbersUnique, RandomSignature, RandomStr, RequestErrorInterceptor, RequestHeadersInterceptor, RequestManagerDemoComponent, RequestManagerStateDemoComponent, RequestOptions, RequestService, RequestSignalsService, RetryOptions, SettingOptions, StateStorageOptions, StorageData, StorageOption, StorageType, StoreStateManagerService, SymmetricalEncryptionService, TableSchemaDef, UUID, UUID_STR, UtilsService, WSOptions, WSUser, WebsocketService, WithCredentialsInterceptor, countdown, createChannelName, delayedRetry, requestPolling, requestStreaming };
 export type { APIStateManagerData, ApiRequestInterface, ChannelInfoInterface, ConfigHTTPOptionsInterface, ConfigOptionsInterface, DatabaseStorageInterface, ErrorDisplaySettingsInterface, GlobalStoreOptionsInterface, LocalStorageOptionsInterface, RequestOptionsInterface, RetryOptionsInterface, SettingOptionsInterface, State, StateStorageOptionsInterface, StateStoreManagerData, StorageDataInterface, StorageOptionInterface, TableRecord, TableSchemaDefInterface, WSOptionsInterface, WSUserInterface };