@etsoo/appscript 1.1.51 → 1.1.55

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

@@ -12,6 +12,25 @@ import { UserRole } from './UserRole';
 export interface IDetectIPCallback {
     (): void;
 }
+/**
+ * Refresh token result type
+ * true means success, false means failed but no any message
+ * other cases means failed with differnet message
+ */
+export declare type RefreshTokenResult = boolean | string | ApiDataError | IActionResult;
+/**
+ * Refresh token props
+ */
+export interface RefreshTokenProps<D extends {}> {
+    /**
+     * Data to pass
+     */
+    data?: D;
+    /**
+     * Callback
+     */
+    callback?: (result: RefreshTokenResult) => void;
+}
 /**
  * Core application interface
  */
@@ -171,8 +190,23 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     pageExit(): void;
     /**
      * Refresh token
+     * @param props Props
+     */
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
      */
-    refreshToken(): Promise<boolean>;
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    switchOrg(apiOrOrg: string | number): Promise<boolean | undefined>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL
@@ -406,12 +440,27 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
     abstract freshCountdownUI(callback?: () => PromiseLike<unknown>): void;
     /**
      * Refresh token
+     * @param callback Callback
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
     /**
      * Setup callback
      */
     setup(): void;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    switchOrg(apiOrOrg: string | number): Promise<boolean | undefined>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL
@@ -420,6 +469,7 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
     transformUrl(url: string): string;
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
      */
     tryLogin(): Promise<boolean>;
     /**

package/lib/cjs/app/CoreApp.js

@@ -399,14 +399,53 @@ class CoreApp {
     }
     /**
      * Refresh token
+     * @param callback Callback
      */
-    async refreshToken() {
+    async refreshToken(props) {
+        if (props && props.callback)
+            props.callback(true);
         return true;
     }
     /**
      * Setup callback
      */
     setup() { }
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    async signout(apiUrl) {
+        await this.api.put(apiUrl !== null && apiUrl !== void 0 ? apiUrl : 'User/Signout', undefined, {
+            onError: (error) => {
+                console.log(error);
+                // Prevent further processing
+                return false;
+            }
+        });
+        // Clear
+        this.userLogout();
+        // Go to login page
+        this.toLoginPage();
+    }
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    async switchOrg(apiOrOrg) {
+        const api = typeof apiOrOrg === 'number'
+            ? `Organization/Switch/${apiOrOrg}`
+            : apiOrOrg;
+        const result = await this.api.put(api);
+        if (result)
+            return await this.refreshToken();
+        return result;
+    }
+    /**
+     * Go to the login page
+     */
+    toLoginPage() {
+        window.location.replace(this.transformUrl('/'));
+    }
     /**
      * Transform URL
      * @param url URL
@@ -431,6 +470,7 @@ class CoreApp {
     }
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
      */
     async tryLogin() {
         if (this._isTryingLogin)

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

@@ -12,6 +12,25 @@ import { UserRole } from './UserRole';
 export interface IDetectIPCallback {
     (): void;
 }
+/**
+ * Refresh token result type
+ * true means success, false means failed but no any message
+ * other cases means failed with differnet message
+ */
+export declare type RefreshTokenResult = boolean | string | ApiDataError | IActionResult;
+/**
+ * Refresh token props
+ */
+export interface RefreshTokenProps<D extends {}> {
+    /**
+     * Data to pass
+     */
+    data?: D;
+    /**
+     * Callback
+     */
+    callback?: (result: RefreshTokenResult) => void;
+}
 /**
  * Core application interface
  */
@@ -171,8 +190,23 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     pageExit(): void;
     /**
      * Refresh token
+     * @param props Props
+     */
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
      */
-    refreshToken(): Promise<boolean>;
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    switchOrg(apiOrOrg: string | number): Promise<boolean | undefined>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL
@@ -406,12 +440,27 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
     abstract freshCountdownUI(callback?: () => PromiseLike<unknown>): void;
     /**
      * Refresh token
+     * @param callback Callback
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
     /**
      * Setup callback
      */
     setup(): void;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    switchOrg(apiOrOrg: string | number): Promise<boolean | undefined>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL
@@ -420,6 +469,7 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
     transformUrl(url: string): string;
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
      */
     tryLogin(): Promise<boolean>;
     /**

package/lib/mjs/app/CoreApp.js

@@ -396,14 +396,53 @@ export class CoreApp {
     }
     /**
      * Refresh token
+     * @param callback Callback
      */
-    async refreshToken() {
+    async refreshToken(props) {
+        if (props && props.callback)
+            props.callback(true);
         return true;
     }
     /**
      * Setup callback
      */
     setup() { }
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    async signout(apiUrl) {
+        await this.api.put(apiUrl !== null && apiUrl !== void 0 ? apiUrl : 'User/Signout', undefined, {
+            onError: (error) => {
+                console.log(error);
+                // Prevent further processing
+                return false;
+            }
+        });
+        // Clear
+        this.userLogout();
+        // Go to login page
+        this.toLoginPage();
+    }
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    async switchOrg(apiOrOrg) {
+        const api = typeof apiOrOrg === 'number'
+            ? `Organization/Switch/${apiOrOrg}`
+            : apiOrOrg;
+        const result = await this.api.put(api);
+        if (result)
+            return await this.refreshToken();
+        return result;
+    }
+    /**
+     * Go to the login page
+     */
+    toLoginPage() {
+        window.location.replace(this.transformUrl('/'));
+    }
     /**
      * Transform URL
      * @param url URL
@@ -428,6 +467,7 @@ export class CoreApp {
     }
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
      */
     async tryLogin() {
         if (this._isTryingLogin)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/appscript",
-    "version": "1.1.51",
+    "version": "1.1.55",
     "description": "Applications shared TypeScript framework",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -65,7 +65,7 @@
         "@types/jest": "^27.0.3",
         "@typescript-eslint/eslint-plugin": "^5.5.0",
         "@typescript-eslint/parser": "^5.5.0",
-        "eslint": "^8.3.0",
+        "eslint": "^8.4.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.25.3",
         "jest": "^27.4.3",

package/src/app/CoreApp.ts

@@ -29,6 +29,32 @@ export interface IDetectIPCallback {
     (): void;
 }
 
+/**
+ * Refresh token result type
+ * true means success, false means failed but no any message
+ * other cases means failed with differnet message
+ */
+export type RefreshTokenResult =
+    | boolean
+    | string
+    | ApiDataError
+    | IActionResult;
+
+/**
+ * Refresh token props
+ */
+export interface RefreshTokenProps<D extends {}> {
+    /**
+     * Data to pass
+     */
+    data?: D;
+
+    /**
+     * Callback
+     */
+    callback?: (result: RefreshTokenResult) => void;
+}
+
 /**
  * Core application interface
  */
@@ -231,8 +257,28 @@ export interface ICoreApp<
 
     /**
      * Refresh token
+     * @param props Props
+     */
+    refreshToken<D extends {} = {}>(
+        props?: RefreshTokenProps<D>
+    ): Promise<boolean>;
+
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    switchOrg(apiOrOrg: string | number): Promise<boolean | undefined>;
+
+    /**
+     * Go to the login page
      */
-    refreshToken(): Promise<boolean>;
+    toLoginPage(): void;
 
     /**
      * Transform URL
@@ -806,8 +852,10 @@ export abstract class CoreApp<
 
     /**
      * Refresh token
+     * @param callback Callback
      */
-    async refreshToken(): Promise<boolean> {
+    async refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>) {
+        if (props && props.callback) props.callback(true);
         return true;
     }
 
@@ -816,6 +864,47 @@ export abstract class CoreApp<
      */
     setup() {}
 
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    async signout(apiUrl?: string) {
+        await this.api.put<boolean>(apiUrl ?? 'User/Signout', undefined, {
+            onError: (error) => {
+                console.log(error);
+                // Prevent further processing
+                return false;
+            }
+        });
+
+        // Clear
+        this.userLogout();
+
+        // Go to login page
+        this.toLoginPage();
+    }
+
+    /**
+     * Switch organization
+     * @param apiOrOrg API URL or organization id
+     */
+    async switchOrg(apiOrOrg: string | number) {
+        const api =
+            typeof apiOrOrg === 'number'
+                ? `Organization/Switch/${apiOrOrg}`
+                : apiOrOrg;
+        const result = await this.api.put<boolean>(api);
+        if (result) return await this.refreshToken();
+        return result;
+    }
+
+    /**
+     * Go to the login page
+     */
+    toLoginPage() {
+        window.location.replace(this.transformUrl('/'));
+    }
+
     /**
      * Transform URL
      * @param url URL
@@ -843,6 +932,7 @@ export abstract class CoreApp<
 
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
      */
     async tryLogin() {
         if (this._isTryingLogin) return false;