@etsoo/appscript 1.2.94 → 1.2.96

package/__tests__/app/CoreApp.ts

@@ -71,7 +71,7 @@ class CoreAppTest extends CoreApp<
                 /**
                  * App root url
                  */
-                homepage: '',
+                homepage: '/cms',
 
                 /**
                  * Web url of the cloud
@@ -125,6 +125,12 @@ class CoreAppTest extends CoreApp<
 
 const app = new CoreAppTest();
 
+test('Tests for addRootUrl', () => {
+    expect(app.addRootUrl('/home')).toBe('/cms/home');
+    expect(app.addRootUrl('./home')).toBe('/cms/./home');
+    expect(app.addRootUrl('home')).toBe('/cms/home');
+});
+
 test('Tests for encrypt / decrypt', () => {
     // Arrange
     const input = 'Hello, world!';

package/lib/cjs/app/CoreApp.d.ts

@@ -8,7 +8,7 @@ import { IActionResult } from '../result/IActionResult';
 import { InitCallResult, InitCallResultData } from '../result/InitCallResult';
 import { IUser } from '../state/User';
 import { IAppSettings } from './AppSettings';
-import { IApp, IAppFields, IDetectIPCallback, RefreshTokenProps, RefreshTokenResult } from './IApp';
+import { IApp, IAppFields, IDetectIPCallback, NavigateOptions, RefreshTokenProps, RefreshTokenResult } from './IApp';
 import { UserRole } from './UserRole';
 /**
  * Core application interface
@@ -141,6 +141,12 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Result
      */
     protected addIdentifier(field: string): string;
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url: string): string;
     /**
      * Restore settings from persisted source
      */
@@ -407,10 +413,11 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      */
     hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean;
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url: string): void;
+    navigate<T extends number | string | URL>(to: T, options?: T extends number ? never : NavigateOptions): void;
     /**
      * Callback where exit a page
      */

package/lib/cjs/app/CoreApp.js

@@ -149,6 +149,21 @@ class CoreApp {
     addIdentifier(field) {
         return field + '-' + this.name;
     }
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url) {
+        const page = this.settings.homepage;
+        const endSlash = page.endsWith('/');
+        return (page +
+            (endSlash
+                ? shared_1.Utils.trimStart(url, '/')
+                : url.startsWith('/')
+                    ? url
+                    : '/' + url));
+    }
     /**
      * Restore settings from persisted source
      */
@@ -979,11 +994,29 @@ class CoreApp {
         return false;
     }
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url) {
-        globalThis.location.href = this.settings.homepage + url;
+    navigate(to, options) {
+        if (typeof to === 'number') {
+            globalThis.history.go(to);
+        }
+        else {
+            const { state, replace = false } = options !== null && options !== void 0 ? options : {};
+            if (replace) {
+                if (state)
+                    globalThis.history.replaceState(state, '', to);
+                else
+                    globalThis.location.replace(to);
+            }
+            else {
+                if (state)
+                    globalThis.history.pushState(state, '', to);
+                else
+                    globalThis.location.assign(to);
+            }
+        }
     }
     /**
      * Callback where exit a page

package/lib/cjs/app/IApp.d.ts

@@ -13,6 +13,13 @@ import { UserRole } from './UserRole';
 export interface IDetectIPCallback {
     (): void;
 }
+/**
+ * Navigate options
+ */
+export interface NavigateOptions {
+    replace?: boolean;
+    state?: any;
+}
 /**
  * Refresh token result type
  * true means success, false means failed but no any message
@@ -122,6 +129,12 @@ export interface IApp {
      * Is screen size up 'md'
      */
     mdUp?: boolean;
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url: string): string;
     /**
      * Alert action result
      * @param result Action result
@@ -336,10 +349,11 @@ export interface IApp {
      */
     isValidPassword(password: string): boolean;
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url: string): void;
+    navigate<T extends number | string | URL>(to: T, options?: T extends number ? never : NavigateOptions): void;
     /**
      * Callback where exit a page
      */

package/lib/mjs/app/CoreApp.d.ts

@@ -8,7 +8,7 @@ import { IActionResult } from '../result/IActionResult';
 import { InitCallResult, InitCallResultData } from '../result/InitCallResult';
 import { IUser } from '../state/User';
 import { IAppSettings } from './AppSettings';
-import { IApp, IAppFields, IDetectIPCallback, RefreshTokenProps, RefreshTokenResult } from './IApp';
+import { IApp, IAppFields, IDetectIPCallback, NavigateOptions, RefreshTokenProps, RefreshTokenResult } from './IApp';
 import { UserRole } from './UserRole';
 /**
  * Core application interface
@@ -141,6 +141,12 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Result
      */
     protected addIdentifier(field: string): string;
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url: string): string;
     /**
      * Restore settings from persisted source
      */
@@ -407,10 +413,11 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      */
     hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean;
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url: string): void;
+    navigate<T extends number | string | URL>(to: T, options?: T extends number ? never : NavigateOptions): void;
     /**
      * Callback where exit a page
      */

package/lib/mjs/app/CoreApp.js

@@ -146,6 +146,21 @@ export class CoreApp {
     addIdentifier(field) {
         return field + '-' + this.name;
     }
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url) {
+        const page = this.settings.homepage;
+        const endSlash = page.endsWith('/');
+        return (page +
+            (endSlash
+                ? Utils.trimStart(url, '/')
+                : url.startsWith('/')
+                    ? url
+                    : '/' + url));
+    }
     /**
      * Restore settings from persisted source
      */
@@ -976,11 +991,29 @@ export class CoreApp {
         return false;
     }
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url) {
-        globalThis.location.href = this.settings.homepage + url;
+    navigate(to, options) {
+        if (typeof to === 'number') {
+            globalThis.history.go(to);
+        }
+        else {
+            const { state, replace = false } = options !== null && options !== void 0 ? options : {};
+            if (replace) {
+                if (state)
+                    globalThis.history.replaceState(state, '', to);
+                else
+                    globalThis.location.replace(to);
+            }
+            else {
+                if (state)
+                    globalThis.history.pushState(state, '', to);
+                else
+                    globalThis.location.assign(to);
+            }
+        }
     }
     /**
      * Callback where exit a page

package/lib/mjs/app/IApp.d.ts

@@ -13,6 +13,13 @@ import { UserRole } from './UserRole';
 export interface IDetectIPCallback {
     (): void;
 }
+/**
+ * Navigate options
+ */
+export interface NavigateOptions {
+    replace?: boolean;
+    state?: any;
+}
 /**
  * Refresh token result type
  * true means success, false means failed but no any message
@@ -122,6 +129,12 @@ export interface IApp {
      * Is screen size up 'md'
      */
     mdUp?: boolean;
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url: string): string;
     /**
      * Alert action result
      * @param result Action result
@@ -336,10 +349,11 @@ export interface IApp {
      */
     isValidPassword(password: string): boolean;
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url: string): void;
+    navigate<T extends number | string | URL>(to: T, options?: T extends number ? never : NavigateOptions): void;
     /**
      * Callback where exit a page
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/appscript",
-    "version": "1.2.94",
+    "version": "1.2.96",
     "description": "Applications shared TypeScript framework",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/app/CoreApp.ts

@@ -46,6 +46,7 @@ import {
     IApp,
     IAppFields,
     IDetectIPCallback,
+    NavigateOptions,
     RefreshTokenProps,
     RefreshTokenResult
 } from './IApp';
@@ -302,6 +303,24 @@ export abstract class CoreApp<
         return field + '-' + this.name;
     }
 
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url: string) {
+        const page = this.settings.homepage;
+        const endSlash = page.endsWith('/');
+        return (
+            page +
+            (endSlash
+                ? Utils.trimStart(url, '/')
+                : url.startsWith('/')
+                ? url
+                : '/' + url)
+        );
+    }
+
     /**
      * Restore settings from persisted source
      */
@@ -1304,11 +1323,27 @@ export abstract class CoreApp<
     }
 
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url: string): void {
-        globalThis.location.href = this.settings.homepage + url;
+    navigate<T extends number | string | URL>(
+        to: T,
+        options?: T extends number ? never : NavigateOptions
+    ) {
+        if (typeof to === 'number') {
+            globalThis.history.go(to);
+        } else {
+            const { state, replace = false } = options ?? {};
+
+            if (replace) {
+                if (state) globalThis.history.replaceState(state, '', to);
+                else globalThis.location.replace(to);
+            } else {
+                if (state) globalThis.history.pushState(state, '', to);
+                else globalThis.location.assign(to);
+            }
+        }
     }
 
     /**

package/src/app/IApp.ts

@@ -21,6 +21,14 @@ export interface IDetectIPCallback {
     (): void;
 }
 
+/**
+ * Navigate options
+ */
+export interface NavigateOptions {
+    replace?: boolean;
+    state?: any;
+}
+
 /**
  * Refresh token result type
  * true means success, false means failed but no any message
@@ -162,6 +170,13 @@ export interface IApp {
      */
     mdUp?: boolean;
 
+    /**
+     * Add root (homepage) to the URL
+     * @param url URL to add
+     * @returns Result
+     */
+    addRootUrl(url: string): string;
+
     /**
      * Alert action result
      * @param result Action result
@@ -438,10 +453,14 @@ export interface IApp {
     isValidPassword(password: string): boolean;
 
     /**
-     * Navigate the Url
-     * @param url Url
+     * Navigate to Url or delta
+     * @param url Url or delta
+     * @param options Options
      */
-    navigate(url: string): void;
+    navigate<T extends number | string | URL>(
+        to: T,
+        options?: T extends number ? never : NavigateOptions
+    ): void;
 
     /**
      * Callback where exit a page