@nu-art/thunderstorm-frontend 0.400.10 → 0.400.12

package/modules/ModuleFE_BrowserHistory.d.ts

@@ -1,5 +1,33 @@
 /**
  * Created by tacb0ss on 27/07/2018.
+ *
+ * @deprecated This module is deprecated. Use ModuleFE_RoutingV2 instead.
+ *
+ * Migration Guide:
+ *
+ * Query Parameters:
+ * - ModuleFE_BrowserHistory.getQueryParams() → ModuleFE_RoutingV2.getQueryParams()
+ * - ModuleFE_BrowserHistory.getQueryParameter(key) → ModuleFE_RoutingV2.getQueryParameter(key)
+ * - ModuleFE_BrowserHistory.setQuery(params) → ModuleFE_RoutingV2.setQuery(params)
+ * - ModuleFE_BrowserHistory.addQueryParam(key, value) → ModuleFE_RoutingV2.addQueryParam(key, value)
+ * - ModuleFE_BrowserHistory.removeQueryParam(key) → ModuleFE_RoutingV2.removeQueryParam(key)
+ *
+ * URL Utilities:
+ * - ModuleFE_BrowserHistory.getCurrent() → ModuleFE_RoutingV2.getCurrent()
+ * - ModuleFE_BrowserHistory.getCurrentUrl() → ModuleFE_RoutingV2.getCurrentUrl()
+ * - ModuleFE_BrowserHistory.getOrigin() → ModuleFE_RoutingV2.getOrigin()
+ *
+ * Navigation:
+ * - ModuleFE_BrowserHistory.push(location) → ModuleFE_RoutingV2.push(location)
+ * - ModuleFE_BrowserHistory.replace(location) → ModuleFE_RoutingV2.replace(location)
+ * - ModuleFE_BrowserHistory.setUrl(url, params) → Use ModuleFE_RoutingV2.push({pathname: url, search: ...})
+ *
+ * Utility Functions:
+ * - composeURL(url, params) → ModuleFE_RoutingV2.composeURL(url, params) (or import from routing module)
+ * - encodeUrlParams(params) → ModuleFE_RoutingV2.encodeUrlParams(params) (or import from routing module)
+ * - composeQuery(params) → ModuleFE_RoutingV2.composeQuery(params) (or import from routing module)
+ *
+ * This module will be removed in a future version. Please migrate to ModuleFE_RoutingV2.
  */
 import { Module } from '@nu-art/ts-common';
 import { History, LocationDescriptorObject } from 'history';
@@ -9,38 +37,204 @@ export type OnUrlParamsChangedListener = {
     __onUrlParamsChanged: VoidFunction;
 };
 export declare const dispatcher_urlParamsChanged: ThunderDispatcher<OnUrlParamsChangedListener, "__onUrlParamsChanged", [], void>;
+/**
+ * @deprecated Use ModuleFE_RoutingV2 instead. This class will be removed in a future version.
+ *
+ * All functionality has been migrated to ModuleFE_RoutingV2. See file-level deprecation notice for migration guide.
+ */
 export declare class ModuleFE_BrowserHistory_Class extends Module {
     private readonly history;
     constructor();
     /**
      * Update and navigate according to query params
+     *
+     * @deprecated Use ModuleFE_RoutingV2.push() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.push({pathname: '/path', search: '?key=value'});
+     *
+     * // New:
+     * ModuleFE_RoutingV2.push({pathname: '/path', search: '?key=value'});
      */
     push(push: LocationDescriptorObject): void;
     /**
      * Update query params
+     *
+     * @deprecated Use ModuleFE_RoutingV2.replace() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.replace({pathname: '/path', search: '?key=value'});
+     *
+     * // New:
+     * ModuleFE_RoutingV2.replace({pathname: '/path', search: '?key=value'});
      */
     replace(push: LocationDescriptorObject): void;
     private composeQuery;
     private getEncodedQueryParams;
+    /**
+     * Get all query parameters from the current URL (decoded)
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getQueryParams() instead
+     *
+     * Migration:
+     * // Old:
+     * const params = ModuleFE_BrowserHistory.getQueryParams();
+     *
+     * // New:
+     * const params = ModuleFE_RoutingV2.getQueryParams();
+     */
     getQueryParams(): UrlQueryParams;
+    /**
+     * Replace all query parameters on the current route
+     *
+     * @deprecated Use ModuleFE_RoutingV2.setQuery() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.setQuery({key: 'value'});
+     *
+     * // New:
+     * ModuleFE_RoutingV2.setQuery({key: 'value'});
+     */
     setQuery(queryParams: UrlQueryParams): void;
+    /**
+     * Add or update a single query parameter on the current route
+     *
+     * @deprecated Use ModuleFE_RoutingV2.addQueryParam() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.addQueryParam('key', 'value');
+     *
+     * // New:
+     * ModuleFE_RoutingV2.addQueryParam('key', 'value');
+     */
     addQueryParam(key: string, value: string): void;
+    /**
+     * Remove a single query parameter from the current route
+     *
+     * @deprecated Use ModuleFE_RoutingV2.removeQueryParam() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.removeQueryParam('key');
+     *
+     * // New:
+     * ModuleFE_RoutingV2.removeQueryParam('key');
+     */
     removeQueryParam(key: string): void;
+    /**
+     * Set URL with optional query parameters
+     *
+     * @deprecated Use ModuleFE_RoutingV2.push() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.setUrl('/path', {key: 'value'});
+     *
+     * // New:
+     * const search = ModuleFE_RoutingV2.composeQuery({key: 'value'});
+     * ModuleFE_RoutingV2.push({pathname: '/path', search: search ? `?${search}` : ''});
+     */
     setUrl(url: string, queryParams?: UrlQueryParams): void;
     private createHistoryDataFromQueryParams;
     private updateQueryParams;
+    /**
+     * Get the window origin
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getOrigin() instead
+     *
+     * Migration:
+     * // Old:
+     * const origin = ModuleFE_BrowserHistory.getOrigin();
+     *
+     * // New:
+     * const origin = ModuleFE_RoutingV2.getOrigin();
+     */
     getOrigin(): string;
+    /**
+     * Get the current location object
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getCurrent() instead
+     *
+     * Migration:
+     * // Old:
+     * const location = ModuleFE_BrowserHistory.getCurrent();
+     *
+     * // New:
+     * const location = ModuleFE_RoutingV2.getCurrent();
+     */
     getCurrent(): import("history").Location<any>;
+    /**
+     * Get the history object (internal use)
+     *
+     * @deprecated This method is deprecated. The history object is no longer exposed.
+     * If you need navigation functionality, use ModuleFE_RoutingV2 methods instead.
+     */
     getHistory(): History<any>;
+    /**
+     * Get a single query parameter from the current URL
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getQueryParameter() instead
+     *
+     * Migration:
+     * // Old:
+     * const value = ModuleFE_BrowserHistory.getQueryParameter('key');
+     *
+     * // New:
+     * const value = ModuleFE_RoutingV2.getQueryParameter('key');
+     */
     getQueryParameter(key: string): string | null | undefined;
+    /**
+     * Get the current URL pathname
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getCurrentUrl() instead
+     *
+     * Migration:
+     * // Old:
+     * const url = ModuleFE_BrowserHistory.getCurrentUrl();
+     *
+     * // New:
+     * const url = ModuleFE_RoutingV2.getCurrentUrl();
+     */
     getCurrentUrl(): string;
 }
+/**
+ * @deprecated Use ModuleFE_RoutingV2.getCurrentUrl() instead
+ *
+ * Migration:
+ * // Old:
+ * const url = getCurrentUrl();
+ *
+ * // New:
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const url = ModuleFE_RoutingV2.getCurrentUrl();
+ */
 export declare function getCurrentUrl(): string;
+/**
+ * @deprecated Use ModuleFE_RoutingV2.getQueryParameter() instead
+ *
+ * Migration:
+ * // Old:
+ * const value = getQueryParameter('key');
+ *
+ * // New:
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const value = ModuleFE_RoutingV2.getQueryParameter('key');
+ */
 export declare function getQueryParameter(name: string): string | null | undefined;
+/**
+ * @deprecated Use ModuleFE_RoutingV2.getQueryParams() instead
+ *
+ * Migration:
+ * // Old:
+ * const params = getUrlQuery();
+ *
+ * // New:
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const params = ModuleFE_RoutingV2.getQueryParams();
+ */
 export declare function getUrlQuery(): UrlQueryParams;
-export declare function encodeUrlParams(queryParams?: UrlQueryParams): {
-    [key: string]: string | undefined;
-};
-export declare function composeQuery(queryParams?: UrlQueryParams): string;
-export declare function composeURL(url: string, queryParams?: UrlQueryParams): string;
 export declare const ModuleFE_BrowserHistory: ModuleFE_BrowserHistory_Class;

package/modules/ModuleFE_BrowserHistory.js

@@ -20,12 +20,44 @@
  */
 /**
  * Created by tacb0ss on 27/07/2018.
+ *
+ * @deprecated This module is deprecated. Use ModuleFE_RoutingV2 instead.
+ *
+ * Migration Guide:
+ *
+ * Query Parameters:
+ * - ModuleFE_BrowserHistory.getQueryParams() → ModuleFE_RoutingV2.getQueryParams()
+ * - ModuleFE_BrowserHistory.getQueryParameter(key) → ModuleFE_RoutingV2.getQueryParameter(key)
+ * - ModuleFE_BrowserHistory.setQuery(params) → ModuleFE_RoutingV2.setQuery(params)
+ * - ModuleFE_BrowserHistory.addQueryParam(key, value) → ModuleFE_RoutingV2.addQueryParam(key, value)
+ * - ModuleFE_BrowserHistory.removeQueryParam(key) → ModuleFE_RoutingV2.removeQueryParam(key)
+ *
+ * URL Utilities:
+ * - ModuleFE_BrowserHistory.getCurrent() → ModuleFE_RoutingV2.getCurrent()
+ * - ModuleFE_BrowserHistory.getCurrentUrl() → ModuleFE_RoutingV2.getCurrentUrl()
+ * - ModuleFE_BrowserHistory.getOrigin() → ModuleFE_RoutingV2.getOrigin()
+ *
+ * Navigation:
+ * - ModuleFE_BrowserHistory.push(location) → ModuleFE_RoutingV2.push(location)
+ * - ModuleFE_BrowserHistory.replace(location) → ModuleFE_RoutingV2.replace(location)
+ * - ModuleFE_BrowserHistory.setUrl(url, params) → Use ModuleFE_RoutingV2.push({pathname: url, search: ...})
+ *
+ * Utility Functions:
+ * - composeURL(url, params) → ModuleFE_RoutingV2.composeURL(url, params) (or import from routing module)
+ * - encodeUrlParams(params) → ModuleFE_RoutingV2.encodeUrlParams(params) (or import from routing module)
+ * - composeQuery(params) → ModuleFE_RoutingV2.composeQuery(params) (or import from routing module)
+ *
+ * This module will be removed in a future version. Please migrate to ModuleFE_RoutingV2.
  */
 import { _keys, composeQueryParams, exists, Module, } from '@nu-art/ts-common';
 import { createBrowserHistory } from 'history';
 import { ThunderDispatcher } from '../core/thunder-dispatcher.js';
 export const dispatcher_urlParamsChanged = new ThunderDispatcher('__onUrlParamsChanged');
-// move all the shit from here to the Routing module
+/**
+ * @deprecated Use ModuleFE_RoutingV2 instead. This class will be removed in a future version.
+ *
+ * All functionality has been migrated to ModuleFE_RoutingV2. See file-level deprecation notice for migration guide.
+ */
 export class ModuleFE_BrowserHistory_Class extends Module {
     history;
     constructor() {
@@ -34,12 +66,30 @@ export class ModuleFE_BrowserHistory_Class extends Module {
     }
     /**
      * Update and navigate according to query params
+     *
+     * @deprecated Use ModuleFE_RoutingV2.push() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.push({pathname: '/path', search: '?key=value'});
+     *
+     * // New:
+     * ModuleFE_RoutingV2.push({pathname: '/path', search: '?key=value'});
      */
     push(push) {
         this.history.push(push);
     }
     /**
      * Update query params
+     *
+     * @deprecated Use ModuleFE_RoutingV2.replace() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.replace({pathname: '/path', search: '?key=value'});
+     *
+     * // New:
+     * ModuleFE_RoutingV2.replace({pathname: '/path', search: '?key=value'});
      */
     replace(push) {
         this.history.replace(push);
@@ -72,6 +122,18 @@ export class ModuleFE_BrowserHistory_Class extends Module {
             return toRet;
         }, queryParams);
     };
+    /**
+     * Get all query parameters from the current URL (decoded)
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getQueryParams() instead
+     *
+     * Migration:
+     * // Old:
+     * const params = ModuleFE_BrowserHistory.getQueryParams();
+     *
+     * // New:
+     * const params = ModuleFE_RoutingV2.getQueryParams();
+     */
     getQueryParams() {
         const params = this.getEncodedQueryParams();
         _keys(params).forEach(key => {
@@ -83,21 +145,70 @@ export class ModuleFE_BrowserHistory_Class extends Module {
         });
         return params;
     }
+    /**
+     * Replace all query parameters on the current route
+     *
+     * @deprecated Use ModuleFE_RoutingV2.setQuery() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.setQuery({key: 'value'});
+     *
+     * // New:
+     * ModuleFE_RoutingV2.setQuery({key: 'value'});
+     */
     setQuery(queryParams) {
         const encodedQueryParams = encodeUrlParams(queryParams);
         this.updateQueryParams(encodedQueryParams);
     }
+    /**
+     * Add or update a single query parameter on the current route
+     *
+     * @deprecated Use ModuleFE_RoutingV2.addQueryParam() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.addQueryParam('key', 'value');
+     *
+     * // New:
+     * ModuleFE_RoutingV2.addQueryParam('key', 'value');
+     */
     addQueryParam(key, value) {
         const decodedQueryParams = this.getQueryParams();
         decodedQueryParams[key] = value;
         this.updateQueryParams(decodedQueryParams);
     }
+    /**
+     * Remove a single query parameter from the current route
+     *
+     * @deprecated Use ModuleFE_RoutingV2.removeQueryParam() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.removeQueryParam('key');
+     *
+     * // New:
+     * ModuleFE_RoutingV2.removeQueryParam('key');
+     */
     removeQueryParam(key) {
         const encodedQueryParams = this.getEncodedQueryParams();
         delete encodedQueryParams[key];
         const data = this.createHistoryDataFromQueryParams(encodedQueryParams);
         this.replace(data);
     }
+    /**
+     * Set URL with optional query parameters
+     *
+     * @deprecated Use ModuleFE_RoutingV2.push() instead
+     *
+     * Migration:
+     * // Old:
+     * ModuleFE_BrowserHistory.setUrl('/path', {key: 'value'});
+     *
+     * // New:
+     * const search = ModuleFE_RoutingV2.composeQuery({key: 'value'});
+     * ModuleFE_RoutingV2.push({pathname: '/path', search: search ? `?${search}` : ''});
+     */
     setUrl(url, queryParams) {
         this.push(this.createHistoryDataFromQueryParams(queryParams, url));
     }
@@ -111,15 +222,57 @@ export class ModuleFE_BrowserHistory_Class extends Module {
         const data = this.createHistoryDataFromQueryParams(encodedQueryParams);
         this.replace(data);
     }
+    /**
+     * Get the window origin
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getOrigin() instead
+     *
+     * Migration:
+     * // Old:
+     * const origin = ModuleFE_BrowserHistory.getOrigin();
+     *
+     * // New:
+     * const origin = ModuleFE_RoutingV2.getOrigin();
+     */
     getOrigin() {
         return window.location.origin;
     }
+    /**
+     * Get the current location object
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getCurrent() instead
+     *
+     * Migration:
+     * // Old:
+     * const location = ModuleFE_BrowserHistory.getCurrent();
+     *
+     * // New:
+     * const location = ModuleFE_RoutingV2.getCurrent();
+     */
     getCurrent() {
         return this.history.location;
     }
+    /**
+     * Get the history object (internal use)
+     *
+     * @deprecated This method is deprecated. The history object is no longer exposed.
+     * If you need navigation functionality, use ModuleFE_RoutingV2 methods instead.
+     */
     getHistory() {
         return this.history;
     }
+    /**
+     * Get a single query parameter from the current URL
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getQueryParameter() instead
+     *
+     * Migration:
+     * // Old:
+     * const value = ModuleFE_BrowserHistory.getQueryParameter('key');
+     *
+     * // New:
+     * const value = ModuleFE_RoutingV2.getQueryParameter('key');
+     */
     getQueryParameter(key) {
         const queryParams = ModuleFE_BrowserHistory.getQueryParams();
         const value = queryParams[key];
@@ -127,20 +280,78 @@ export class ModuleFE_BrowserHistory_Class extends Module {
             return null;
         return value;
     }
+    /**
+     * Get the current URL pathname
+     *
+     * @deprecated Use ModuleFE_RoutingV2.getCurrentUrl() instead
+     *
+     * Migration:
+     * // Old:
+     * const url = ModuleFE_BrowserHistory.getCurrentUrl();
+     *
+     * // New:
+     * const url = ModuleFE_RoutingV2.getCurrentUrl();
+     */
     getCurrentUrl() {
         return ModuleFE_BrowserHistory.getCurrent().pathname;
     }
 }
+/**
+ * @deprecated Use ModuleFE_RoutingV2.getCurrentUrl() instead
+ *
+ * Migration:
+ * // Old:
+ * const url = getCurrentUrl();
+ *
+ * // New:
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const url = ModuleFE_RoutingV2.getCurrentUrl();
+ */
 export function getCurrentUrl() {
     return ModuleFE_BrowserHistory.getCurrentUrl();
 }
+/**
+ * @deprecated Use ModuleFE_RoutingV2.getQueryParameter() instead
+ *
+ * Migration:
+ * // Old:
+ * const value = getQueryParameter('key');
+ *
+ * // New:
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const value = ModuleFE_RoutingV2.getQueryParameter('key');
+ */
 export function getQueryParameter(name) {
     return ModuleFE_BrowserHistory.getQueryParameter(name);
 }
+/**
+ * @deprecated Use ModuleFE_RoutingV2.getQueryParams() instead
+ *
+ * Migration:
+ * // Old:
+ * const params = getUrlQuery();
+ *
+ * // New:
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const params = ModuleFE_RoutingV2.getQueryParams();
+ */
 export function getUrlQuery() {
     return ModuleFE_BrowserHistory.getQueryParams();
 }
-export function encodeUrlParams(queryParams) {
+/**
+ * @deprecated Use ModuleFE_RoutingV2.encodeUrlParams() or import from routing module instead
+ *
+ * Migration:
+ * // Old:
+ * const encoded = encodeUrlParams(params);
+ *
+ * // New:
+ * import {encodeUrlParams} from '@nu-art/thunderstorm-frontend/modules/routing/ModuleFE_RoutingV2';
+ * // OR
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const encoded = ModuleFE_RoutingV2.encodeUrlParams(params);
+ */
+function encodeUrlParams(queryParams) {
     const encodedQueryParams = { ...queryParams };
     _keys(encodedQueryParams).forEach(key => {
         const value = encodedQueryParams[key];
@@ -152,13 +363,40 @@ export function encodeUrlParams(queryParams) {
     });
     return encodedQueryParams;
 }
-export function composeQuery(queryParams) {
+/**
+ * @deprecated Use ModuleFE_RoutingV2.composeQuery() or import from routing module instead
+ *
+ * Migration:
+ * // Old:
+ * const query = composeQuery(params);
+ *
+ * // New:
+ * import {composeQuery} from '@nu-art/thunderstorm-frontend/modules/routing/ModuleFE_RoutingV2';
+ * // OR
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const query = ModuleFE_RoutingV2.composeQuery(params);
+ */
+function composeQuery(queryParams) {
     const queryAsString = composeQueryParams(queryParams);
     if (queryAsString.length === 0)
         return '';
     return queryAsString;
 }
-export function composeURL(url, queryParams) {
+/**
+ * @deprecated Use ModuleFE_RoutingV2.composeURL() or import from routing module instead
+ *
+ * Migration:
+ * // Old:
+ * const url = composeURL('/path', params);
+ *
+ * // New:
+ * import {composeURL} from '@nu-art/thunderstorm-frontend/modules/routing/ModuleFE_RoutingV2';
+ * // OR
+ * import {ModuleFE_RoutingV2} from '@nu-art/thunderstorm-frontend';
+ * const url = ModuleFE_RoutingV2.composeURL('/path', params);
+ */
+// @ts-ignore
+function composeURL(url, queryParams) {
     const queryAsString = composeQuery(queryParams);
     return `${url}${queryAsString.length > 0 ? `?${queryAsString}` : ''}`;
 }

package/modules/ModuleFE_Thunderstorm.js

@@ -20,7 +20,7 @@
  */
 import { _keys, BadImplementationException, Module } from '@nu-art/ts-common';
 import { ModuleFE_Toaster } from '../component-modules/ModuleFE_Toaster.js';
-import { composeURL } from './ModuleFE_BrowserHistory.js';
+import { composeURL } from './routing/ModuleFE_RoutingV2.js';
 import { HttpMethod } from '@nu-art/thunderstorm-shared';
 import { base64ToBlob } from '../utils/tools.js';
 import { ModuleFE_XHR } from './http/ModuleFE_XHR.js';

package/modules/component-loader/entry-component-loading-module.js

@@ -21,14 +21,14 @@
 import { Module } from '@nu-art/ts-common';
 // noinspection TypeScriptPreferShortImport
 import { ModuleFE_XHR } from '../http/ModuleFE_XHR.js';
-import { ModuleFE_BrowserHistory } from '../ModuleFE_BrowserHistory.js';
+import { ModuleFE_RoutingV2 } from '../routing/ModuleFE_RoutingV2.js';
 import { HttpMethod } from '@nu-art/thunderstorm-shared';
 export class PageLoadingModule_Class extends Module {
     injected = {};
     loadScript(src, progressListener) {
         const apiDef = {
             method: HttpMethod.GET,
-            baseUrl: ModuleFE_BrowserHistory.getOrigin(),
+            baseUrl: ModuleFE_RoutingV2.getOrigin(),
             path: src
         };
         ModuleFE_XHR