@etsoo/appscript 1.1.53 → 1.1.54

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

@@ -12,6 +12,18 @@ 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 callback
+ */
+export interface RefreshTokenCallback {
+    (result: RefreshTokenResult): void;
+}
 /**
  * Core application interface
  */
@@ -171,8 +183,9 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     pageExit(): void;
     /**
      * Refresh token
+     * @param callback Callback
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken(callback?: RefreshTokenCallback): Promise<boolean>;
     /**
      * Signout
      * @param apiUrl Signout API URL
@@ -420,8 +433,9 @@ 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(callback?: RefreshTokenCallback): Promise<boolean>;
     /**
      * Setup callback
      */
@@ -448,6 +462,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,8 +399,11 @@ class CoreApp {
     }
     /**
      * Refresh token
+     * @param callback Callback
      */
-    async refreshToken() {
+    async refreshToken(callback) {
+        if (callback)
+            callback(true);
         return true;
     }
     /**
@@ -467,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,18 @@ 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 callback
+ */
+export interface RefreshTokenCallback {
+    (result: RefreshTokenResult): void;
+}
 /**
  * Core application interface
  */
@@ -171,8 +183,9 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     pageExit(): void;
     /**
      * Refresh token
+     * @param callback Callback
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken(callback?: RefreshTokenCallback): Promise<boolean>;
     /**
      * Signout
      * @param apiUrl Signout API URL
@@ -420,8 +433,9 @@ 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(callback?: RefreshTokenCallback): Promise<boolean>;
     /**
      * Setup callback
      */
@@ -448,6 +462,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,8 +396,11 @@ export class CoreApp {
     }
     /**
      * Refresh token
+     * @param callback Callback
      */
-    async refreshToken() {
+    async refreshToken(callback) {
+        if (callback)
+            callback(true);
         return true;
     }
     /**
@@ -464,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.53",
+    "version": "1.1.54",
     "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,24 @@ 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 callback
+ */
+export interface RefreshTokenCallback {
+    (result: RefreshTokenResult): void;
+}
+
 /**
  * Core application interface
  */
@@ -231,8 +249,9 @@ export interface ICoreApp<
 
     /**
      * Refresh token
+     * @param callback Callback
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken(callback?: RefreshTokenCallback): Promise<boolean>;
 
     /**
      * Signout
@@ -823,8 +842,10 @@ export abstract class CoreApp<
 
     /**
      * Refresh token
+     * @param callback Callback
      */
-    async refreshToken(): Promise<boolean> {
+    async refreshToken(callback?: RefreshTokenCallback) {
+        if (callback) callback(true);
         return true;
     }
 
@@ -901,6 +922,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;