@etsoo/appscript 1.5.51 → 1.5.52

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

@@ -129,6 +129,11 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      */
     get cachedUrl(): string | undefined | null;
     set cachedUrl(value: string | undefined | null);
+    /**
+     * Keep login or not
+     */
+    get keepLogin(): boolean;
+    set keepLogin(value: boolean);
     private _embedded;
     /**
      * Is embedded
@@ -154,6 +159,7 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
     protected passphrase: string;
     private apis;
     private tasks;
+    private clearInterval?;
     /**
      * Get persisted fields
      */
@@ -186,6 +192,10 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * Restore settings from persisted source
      */
     protected restore(): Promise<boolean>;
+    /**
+     * Dispose the application
+     */
+    dispose(): void;
     /**
      * Is valid password, override to implement custom check
      * @param password Input password
@@ -193,9 +203,8 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
     isValidPassword(password: string): boolean;
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin?: boolean): void;
+    persist(): void;
     /**
      * Add scheduled task
      * @param task Task, return false to stop

package/lib/cjs/app/CoreApp.js

@@ -96,6 +96,19 @@ class CoreApp {
     set cachedUrl(value) {
         this.storage.setData(this.fields.cachedUrl, value);
     }
+    /**
+     * Keep login or not
+     */
+    get keepLogin() {
+        return this.storage.getData(this.fields.keepLogin) ?? false;
+    }
+    set keepLogin(value) {
+        if (!value) {
+            // Clear the token
+            this.clearCacheToken();
+        }
+        this.storage.setData(this.fields.keepLogin, value);
+    }
     /**
      * Is embedded
      */
@@ -119,7 +132,8 @@ class CoreApp {
             this.fields.deviceId,
             this.fields.devicePassphrase,
             this.fields.serversideDeviceId,
-            this.fields.headerToken
+            this.fields.headerToken,
+            this.fields.keepLogin
         ];
     }
     /**
@@ -287,6 +301,20 @@ class CoreApp {
         }
         return false;
     }
+    /**
+     * Dispose the application
+     */
+    dispose() {
+        // Avoid duplicated call
+        if (!this._isReady)
+            return;
+        // Persist storage defined fields
+        this.persist();
+        // Clear the interval
+        this.clearInterval?.();
+        // Reset the status to false
+        this.isReady = false;
+    }
     /**
      * Is valid password, override to implement custom check
      * @param password Input password
@@ -303,13 +331,8 @@ class CoreApp {
     }
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin) {
-        if (!keepLogin) {
-            // Unconditional clear the cache for security
-            this.clearCacheToken();
-        }
+    persist() {
         // Devices
         const devices = this.storage.getPersistedData(this.fields.devices);
         if (devices != null) {
@@ -322,7 +345,7 @@ class CoreApp {
         }
         if (!this.authorized)
             return;
-        const fields = keepLogin
+        const fields = this.keepLogin
             ? this.persistedFields
             : this.persistedFields.filter((f) => f !== this.fields.headerToken);
         this.storage.copyTo(fields);
@@ -683,6 +706,8 @@ class CoreApp {
         this.onAuthorized(authorized);
         // Everything is ready, update the state
         this.authorized = authorized;
+        // Persist
+        this.persist();
     }
     /**
      * On authorized or not callback
@@ -1532,7 +1557,7 @@ class CoreApp {
      * Setup tasks
      */
     setupTasks() {
-        shared_1.ExtendUtils.intervalFor(() => {
+        this.clearInterval = shared_1.ExtendUtils.intervalFor(() => {
             // Exit when not authorized
             if (!this.authorized)
                 return;
@@ -1590,6 +1615,8 @@ class CoreApp {
      * @param apiUrl Signout API URL
      */
     async signout() {
+        // Clear the keep login status
+        this.keepLogin = false;
         const token = this.getCacheToken();
         if (token) {
             const result = await new AuthApi_1.AuthApi(this).signout({

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

@@ -94,7 +94,7 @@ export interface RefreshTokenProps {
 /**
  * App fields
  */
-export declare const appFields: readonly ["headerToken", "serversideDeviceId", "deviceId", "devices", "devicePassphrase", "cachedUrl", "embedded"];
+export declare const appFields: readonly ["headerToken", "serversideDeviceId", "deviceId", "devices", "devicePassphrase", "cachedUrl", "embedded", "keepLogin"];
 /**
  * Basic type template
  */
@@ -181,6 +181,10 @@ export interface IApp {
      * Cached URL
      */
     cachedUrl: string | undefined | null;
+    /**
+     * Keep login or not
+     */
+    keepLogin: boolean;
     /**
      * IP data
      */
@@ -294,6 +298,10 @@ export interface IApp {
      * @param callback Callback will be called when the IP is ready
      */
     detectIP(callback?: IDetectIPCallback): void;
+    /**
+     * Dispose the application
+     */
+    dispose(): void;
     /**
      * Download file
      * @param stream File stream
@@ -561,9 +569,8 @@ export interface IApp {
     signout(): Promise<void>;
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin?: boolean): void;
+    persist(): void;
     /**
      * Go to the login page
      * @param params Login parameters

package/lib/cjs/app/IApp.js

@@ -11,5 +11,6 @@ exports.appFields = [
     'devices',
     'devicePassphrase',
     'cachedUrl',
-    'embedded'
+    'embedded',
+    'keepLogin'
 ];

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

@@ -129,6 +129,11 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      */
     get cachedUrl(): string | undefined | null;
     set cachedUrl(value: string | undefined | null);
+    /**
+     * Keep login or not
+     */
+    get keepLogin(): boolean;
+    set keepLogin(value: boolean);
     private _embedded;
     /**
      * Is embedded
@@ -154,6 +159,7 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
     protected passphrase: string;
     private apis;
     private tasks;
+    private clearInterval?;
     /**
      * Get persisted fields
      */
@@ -186,6 +192,10 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * Restore settings from persisted source
      */
     protected restore(): Promise<boolean>;
+    /**
+     * Dispose the application
+     */
+    dispose(): void;
     /**
      * Is valid password, override to implement custom check
      * @param password Input password
@@ -193,9 +203,8 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
     isValidPassword(password: string): boolean;
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin?: boolean): void;
+    persist(): void;
     /**
      * Add scheduled task
      * @param task Task, return false to stop

package/lib/mjs/app/CoreApp.js

@@ -93,6 +93,19 @@ export class CoreApp {
     set cachedUrl(value) {
         this.storage.setData(this.fields.cachedUrl, value);
     }
+    /**
+     * Keep login or not
+     */
+    get keepLogin() {
+        return this.storage.getData(this.fields.keepLogin) ?? false;
+    }
+    set keepLogin(value) {
+        if (!value) {
+            // Clear the token
+            this.clearCacheToken();
+        }
+        this.storage.setData(this.fields.keepLogin, value);
+    }
     /**
      * Is embedded
      */
@@ -116,7 +129,8 @@ export class CoreApp {
             this.fields.deviceId,
             this.fields.devicePassphrase,
             this.fields.serversideDeviceId,
-            this.fields.headerToken
+            this.fields.headerToken,
+            this.fields.keepLogin
         ];
     }
     /**
@@ -284,6 +298,20 @@ export class CoreApp {
         }
         return false;
     }
+    /**
+     * Dispose the application
+     */
+    dispose() {
+        // Avoid duplicated call
+        if (!this._isReady)
+            return;
+        // Persist storage defined fields
+        this.persist();
+        // Clear the interval
+        this.clearInterval?.();
+        // Reset the status to false
+        this.isReady = false;
+    }
     /**
      * Is valid password, override to implement custom check
      * @param password Input password
@@ -300,13 +328,8 @@ export class CoreApp {
     }
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin) {
-        if (!keepLogin) {
-            // Unconditional clear the cache for security
-            this.clearCacheToken();
-        }
+    persist() {
         // Devices
         const devices = this.storage.getPersistedData(this.fields.devices);
         if (devices != null) {
@@ -319,7 +342,7 @@ export class CoreApp {
         }
         if (!this.authorized)
             return;
-        const fields = keepLogin
+        const fields = this.keepLogin
             ? this.persistedFields
             : this.persistedFields.filter((f) => f !== this.fields.headerToken);
         this.storage.copyTo(fields);
@@ -680,6 +703,8 @@ export class CoreApp {
         this.onAuthorized(authorized);
         // Everything is ready, update the state
         this.authorized = authorized;
+        // Persist
+        this.persist();
     }
     /**
      * On authorized or not callback
@@ -1529,7 +1554,7 @@ export class CoreApp {
      * Setup tasks
      */
     setupTasks() {
-        ExtendUtils.intervalFor(() => {
+        this.clearInterval = ExtendUtils.intervalFor(() => {
             // Exit when not authorized
             if (!this.authorized)
                 return;
@@ -1587,6 +1612,8 @@ export class CoreApp {
      * @param apiUrl Signout API URL
      */
     async signout() {
+        // Clear the keep login status
+        this.keepLogin = false;
         const token = this.getCacheToken();
         if (token) {
             const result = await new AuthApi(this).signout({

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

@@ -94,7 +94,7 @@ export interface RefreshTokenProps {
 /**
  * App fields
  */
-export declare const appFields: readonly ["headerToken", "serversideDeviceId", "deviceId", "devices", "devicePassphrase", "cachedUrl", "embedded"];
+export declare const appFields: readonly ["headerToken", "serversideDeviceId", "deviceId", "devices", "devicePassphrase", "cachedUrl", "embedded", "keepLogin"];
 /**
  * Basic type template
  */
@@ -181,6 +181,10 @@ export interface IApp {
      * Cached URL
      */
     cachedUrl: string | undefined | null;
+    /**
+     * Keep login or not
+     */
+    keepLogin: boolean;
     /**
      * IP data
      */
@@ -294,6 +298,10 @@ export interface IApp {
      * @param callback Callback will be called when the IP is ready
      */
     detectIP(callback?: IDetectIPCallback): void;
+    /**
+     * Dispose the application
+     */
+    dispose(): void;
     /**
      * Download file
      * @param stream File stream
@@ -561,9 +569,8 @@ export interface IApp {
     signout(): Promise<void>;
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin?: boolean): void;
+    persist(): void;
     /**
      * Go to the login page
      * @param params Login parameters

package/lib/mjs/app/IApp.js

@@ -8,5 +8,6 @@ export const appFields = [
     'devices',
     'devicePassphrase',
     'cachedUrl',
-    'embedded'
+    'embedded',
+    'keepLogin'
 ];

package/package.json

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

package/src/app/CoreApp.ts

@@ -249,6 +249,20 @@ export abstract class CoreApp<
         this.storage.setData(this.fields.cachedUrl, value);
     }
 
+    /**
+     * Keep login or not
+     */
+    get keepLogin() {
+        return this.storage.getData<boolean>(this.fields.keepLogin) ?? false;
+    }
+    set keepLogin(value: boolean) {
+        if (!value) {
+            // Clear the token
+            this.clearCacheToken();
+        }
+        this.storage.setData(this.fields.keepLogin, value);
+    }
+
     private _embedded: boolean;
     /**
      * Is embedded
@@ -287,6 +301,8 @@ export abstract class CoreApp<
 
     private tasks: [() => PromiseLike<void | false>, number, number][] = [];
 
+    private clearInterval?: () => void;
+
     /**
      * Get persisted fields
      */
@@ -295,7 +311,8 @@ export abstract class CoreApp<
             this.fields.deviceId,
             this.fields.devicePassphrase,
             this.fields.serversideDeviceId,
-            this.fields.headerToken
+            this.fields.headerToken,
+            this.fields.keepLogin
         ];
     }
 
@@ -507,6 +524,23 @@ export abstract class CoreApp<
         return false;
     }
 
+    /**
+     * Dispose the application
+     */
+    dispose() {
+        // Avoid duplicated call
+        if (!this._isReady) return;
+
+        // Persist storage defined fields
+        this.persist();
+
+        // Clear the interval
+        this.clearInterval?.();
+
+        // Reset the status to false
+        this.isReady = false;
+    }
+
     /**
      * Is valid password, override to implement custom check
      * @param password Input password
@@ -525,14 +559,8 @@ export abstract class CoreApp<
 
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin?: boolean) {
-        if (!keepLogin) {
-            // Unconditional clear the cache for security
-            this.clearCacheToken();
-        }
-
+    persist() {
         // Devices
         const devices = this.storage.getPersistedData<string[]>(
             this.fields.devices
@@ -548,7 +576,7 @@ export abstract class CoreApp<
 
         if (!this.authorized) return;
 
-        const fields = keepLogin
+        const fields = this.keepLogin
             ? this.persistedFields
             : this.persistedFields.filter((f) => f !== this.fields.headerToken);
 
@@ -1064,6 +1092,9 @@ export abstract class CoreApp<
 
         // Everything is ready, update the state
         this.authorized = authorized;
+
+        // Persist
+        this.persist();
     }
 
     /**
@@ -2106,7 +2137,7 @@ export abstract class CoreApp<
      * Setup tasks
      */
     protected setupTasks() {
-        ExtendUtils.intervalFor(() => {
+        this.clearInterval = ExtendUtils.intervalFor(() => {
             // Exit when not authorized
             if (!this.authorized) return;
 
@@ -2169,6 +2200,9 @@ export abstract class CoreApp<
      * @param apiUrl Signout API URL
      */
     async signout() {
+        // Clear the keep login status
+        this.keepLogin = false;
+
         const token = this.getCacheToken();
         if (token) {
             const result = await new AuthApi(this).signout(

package/src/app/IApp.ts

@@ -133,7 +133,8 @@ export const appFields = [
     'devices',
     'devicePassphrase',
     'cachedUrl',
-    'embedded'
+    'embedded',
+    'keepLogin'
 ] as const;
 
 /**
@@ -240,6 +241,11 @@ export interface IApp {
      */
     cachedUrl: string | undefined | null;
 
+    /**
+     * Keep login or not
+     */
+    keepLogin: boolean;
+
     /**
      * IP data
      */
@@ -391,6 +397,11 @@ export interface IApp {
      */
     detectIP(callback?: IDetectIPCallback): void;
 
+    /**
+     * Dispose the application
+     */
+    dispose(): void;
+
     /**
      * Download file
      * @param stream File stream
@@ -758,9 +769,8 @@ export interface IApp {
 
     /**
      * Persist settings to source when application exit
-     * @param keepLogin Keep login or not
      */
-    persist(keepLogin?: boolean): void;
+    persist(): void;
 
     /**
      * Go to the login page