@etsoo/appscript 1.1.53 → 1.1.57

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

@@ -12,6 +12,29 @@ 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 {}> {
+    /**
+     * Callback
+     */
+    callback?: (result: RefreshTokenResult) => void;
+    /**
+     * Data to pass
+     */
+    data?: D;
+    /**
+     * Show loading bar or not
+     */
+    showLoading?: boolean;
+}
 /**
  * Core application interface
  */
@@ -171,8 +194,9 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     pageExit(): void;
     /**
      * Refresh token
+     * @param props Props
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
     /**
      * Signout
      * @param apiUrl Signout API URL
@@ -195,8 +219,10 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     transformUrl(url: string): string;
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
+     * @param data Additional request data
      */
-    tryLogin(): Promise<boolean>;
+    tryLogin<D extends {} = {}>(data?: D): Promise<boolean>;
     /**
      * User login
      * @param user User data
@@ -420,8 +446,9 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
     abstract freshCountdownUI(callback?: () => PromiseLike<unknown>): void;
     /**
      * Refresh token
+     * @param props Props
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
     /**
      * Setup callback
      */
@@ -448,8 +475,10 @@ 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
+     * @param data Additional request data
      */
-    tryLogin(): Promise<boolean>;
+    tryLogin<D extends {} = {}>(_data?: D): Promise<boolean>;
     /**
      * User login
      * @param user User data

package/lib/cjs/app/CoreApp.js

@@ -399,8 +399,11 @@ class CoreApp {
     }
     /**
      * Refresh token
+     * @param props Props
      */
-    async refreshToken() {
+    async refreshToken(props) {
+        if (props && props.callback)
+            props.callback(true);
         return true;
     }
     /**
@@ -467,8 +470,10 @@ class CoreApp {
     }
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
+     * @param data Additional request data
      */
-    async tryLogin() {
+    async tryLogin(_data) {
         if (this._isTryingLogin)
             return false;
         this._isTryingLogin = true;

package/lib/cjs/i18n/en-US.json

@@ -22,6 +22,7 @@
     "failed": "Operation failed",
     "id": "Number#",
     "loading": "Loading...",
+    "login": "Login",
     "menuHome": "Home",
     "message": "Message",
     "mobile": "Mobile number",
@@ -42,6 +43,7 @@
     "refresh": "Refresh",
     "refreshing": "Refreshing",
     "releaseToRefresh": "Release to refresh",
+    "reloginTip": "Please enter your password, resubmit the data after successful login",
     "remove": "Remove",
     "renew": "Renew",
     "resending": "Resending",

package/lib/cjs/i18n/zh-CN.json

@@ -22,6 +22,7 @@
     "failed": "操作失败",
     "id": "编号",
     "loading": "正在加载...",
+    "login": "登录",
     "menuHome": "首页",
     "message": "留言",
     "mobile": "手机号码",
@@ -42,6 +43,7 @@
     "refresh": "刷新",
     "refreshing": "正在刷新",
     "releaseToRefresh": "释放刷新",
+    "reloginTip": "请输入您的登录密码，登录成功后请重新提交数据",
     "remove": "移除",
     "renew": "续费",
     "resending": "重新发送",

package/lib/cjs/i18n/zh-HK.json

@@ -22,6 +22,7 @@
     "failed": "操作失敗",
     "id": "編號",
     "loading": "正在加載...",
+    "login": "登錄",
     "menuHome": "首頁",
     "message": "留言",
     "mobilePhone": "手機號碼",
@@ -42,6 +43,7 @@
     "refresh": "刷新",
     "refreshing": "正在刷新",
     "releaseToRefresh": "釋放刷新",
+    "reloginTip": "請輸入您的登錄密碼，登錄成功後請重新提交數據",
     "remove": "移除",
     "renew": "續費",
     "resending": "重新發送",

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

@@ -12,6 +12,29 @@ 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 {}> {
+    /**
+     * Callback
+     */
+    callback?: (result: RefreshTokenResult) => void;
+    /**
+     * Data to pass
+     */
+    data?: D;
+    /**
+     * Show loading bar or not
+     */
+    showLoading?: boolean;
+}
 /**
  * Core application interface
  */
@@ -171,8 +194,9 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     pageExit(): void;
     /**
      * Refresh token
+     * @param props Props
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
     /**
      * Signout
      * @param apiUrl Signout API URL
@@ -195,8 +219,10 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
     transformUrl(url: string): string;
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
+     * @param data Additional request data
      */
-    tryLogin(): Promise<boolean>;
+    tryLogin<D extends {} = {}>(data?: D): Promise<boolean>;
     /**
      * User login
      * @param user User data
@@ -420,8 +446,9 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
     abstract freshCountdownUI(callback?: () => PromiseLike<unknown>): void;
     /**
      * Refresh token
+     * @param props Props
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>): Promise<boolean>;
     /**
      * Setup callback
      */
@@ -448,8 +475,10 @@ 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
+     * @param data Additional request data
      */
-    tryLogin(): Promise<boolean>;
+    tryLogin<D extends {} = {}>(_data?: D): Promise<boolean>;
     /**
      * User login
      * @param user User data

package/lib/mjs/app/CoreApp.js

@@ -396,8 +396,11 @@ export class CoreApp {
     }
     /**
      * Refresh token
+     * @param props Props
      */
-    async refreshToken() {
+    async refreshToken(props) {
+        if (props && props.callback)
+            props.callback(true);
         return true;
     }
     /**
@@ -464,8 +467,10 @@ export class CoreApp {
     }
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
+     * @param data Additional request data
      */
-    async tryLogin() {
+    async tryLogin(_data) {
         if (this._isTryingLogin)
             return false;
         this._isTryingLogin = true;

package/lib/mjs/i18n/en-US.json

@@ -22,6 +22,7 @@
     "failed": "Operation failed",
     "id": "Number#",
     "loading": "Loading...",
+    "login": "Login",
     "menuHome": "Home",
     "message": "Message",
     "mobile": "Mobile number",
@@ -42,6 +43,7 @@
     "refresh": "Refresh",
     "refreshing": "Refreshing",
     "releaseToRefresh": "Release to refresh",
+    "reloginTip": "Please enter your password, resubmit the data after successful login",
     "remove": "Remove",
     "renew": "Renew",
     "resending": "Resending",

package/lib/mjs/i18n/zh-CN.json

@@ -22,6 +22,7 @@
     "failed": "操作失败",
     "id": "编号",
     "loading": "正在加载...",
+    "login": "登录",
     "menuHome": "首页",
     "message": "留言",
     "mobile": "手机号码",
@@ -42,6 +43,7 @@
     "refresh": "刷新",
     "refreshing": "正在刷新",
     "releaseToRefresh": "释放刷新",
+    "reloginTip": "请输入您的登录密码，登录成功后请重新提交数据",
     "remove": "移除",
     "renew": "续费",
     "resending": "重新发送",

package/lib/mjs/i18n/zh-HK.json

@@ -22,6 +22,7 @@
     "failed": "操作失敗",
     "id": "編號",
     "loading": "正在加載...",
+    "login": "登錄",
     "menuHome": "首頁",
     "message": "留言",
     "mobilePhone": "手機號碼",
@@ -42,6 +43,7 @@
     "refresh": "刷新",
     "refreshing": "正在刷新",
     "releaseToRefresh": "釋放刷新",
+    "reloginTip": "請輸入您的登錄密碼，登錄成功後請重新提交數據",
     "remove": "移除",
     "renew": "續費",
     "resending": "重新發送",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/appscript",
-    "version": "1.1.53",
+    "version": "1.1.57",
     "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,37 @@ 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 {}> {
+    /**
+     * Callback
+     */
+    callback?: (result: RefreshTokenResult) => void;
+
+    /**
+     * Data to pass
+     */
+    data?: D;
+
+    /**
+     * Show loading bar or not
+     */
+    showLoading?: boolean;
+}
+
 /**
  * Core application interface
  */
@@ -231,8 +262,11 @@ export interface ICoreApp<
 
     /**
      * Refresh token
+     * @param props Props
      */
-    refreshToken(): Promise<boolean>;
+    refreshToken<D extends {} = {}>(
+        props?: RefreshTokenProps<D>
+    ): Promise<boolean>;
 
     /**
      * Signout
@@ -260,8 +294,10 @@ export interface ICoreApp<
 
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
+     * @param data Additional request data
      */
-    tryLogin(): Promise<boolean>;
+    tryLogin<D extends {} = {}>(data?: D): Promise<boolean>;
 
     /**
      * User login
@@ -823,8 +859,10 @@ export abstract class CoreApp<
 
     /**
      * Refresh token
+     * @param props Props
      */
-    async refreshToken(): Promise<boolean> {
+    async refreshToken<D extends {} = {}>(props?: RefreshTokenProps<D>) {
+        if (props && props.callback) props.callback(true);
         return true;
     }
 
@@ -901,8 +939,10 @@ export abstract class CoreApp<
 
     /**
      * Try login, returning false means is loading
+     * UI get involved while refreshToken not intended
+     * @param data Additional request data
      */
-    async tryLogin() {
+    async tryLogin<D extends {} = {}>(_data?: D) {
         if (this._isTryingLogin) return false;
         this._isTryingLogin = true;
         return true;

package/src/i18n/en-US.json

@@ -22,6 +22,7 @@
     "failed": "Operation failed",
     "id": "Number#",
     "loading": "Loading...",
+    "login": "Login",
     "menuHome": "Home",
     "message": "Message",
     "mobile": "Mobile number",
@@ -42,6 +43,7 @@
     "refresh": "Refresh",
     "refreshing": "Refreshing",
     "releaseToRefresh": "Release to refresh",
+    "reloginTip": "Please enter your password, resubmit the data after successful login",
     "remove": "Remove",
     "renew": "Renew",
     "resending": "Resending",

package/src/i18n/zh-CN.json

@@ -22,6 +22,7 @@
     "failed": "操作失败",
     "id": "编号",
     "loading": "正在加载...",
+    "login": "登录",
     "menuHome": "首页",
     "message": "留言",
     "mobile": "手机号码",
@@ -42,6 +43,7 @@
     "refresh": "刷新",
     "refreshing": "正在刷新",
     "releaseToRefresh": "释放刷新",
+    "reloginTip": "请输入您的登录密码，登录成功后请重新提交数据",
     "remove": "移除",
     "renew": "续费",
     "resending": "重新发送",

package/src/i18n/zh-HK.json

@@ -22,6 +22,7 @@
     "failed": "操作失敗",
     "id": "編號",
     "loading": "正在加載...",
+    "login": "登錄",
     "menuHome": "首頁",
     "message": "留言",
     "mobilePhone": "手機號碼",
@@ -42,6 +43,7 @@
     "refresh": "刷新",
     "refreshing": "正在刷新",
     "releaseToRefresh": "釋放刷新",
+    "reloginTip": "請輸入您的登錄密碼，登錄成功後請重新提交數據",
     "remove": "移除",
     "renew": "續費",
     "resending": "重新發送",