@etsoo/appscript 1.5.53 → 1.5.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -635,15 +635,15 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
635
635
  signout(): Promise<void>;
636
636
  /**
637
637
  * Go to the login page
638
- * @params Login parameters
638
+ * @param data Login parameters
639
639
  */
640
- toLoginPage(params?: AppLoginParams): void;
640
+ toLoginPage(data?: AppLoginParams): void;
641
641
  /**
642
642
  * Try login, returning false means is loading
643
643
  * UI get involved while refreshToken not intended
644
- * @param params Login parameters
644
+ * @param data Login parameters
645
645
  */
646
- tryLogin(params?: AppTryLoginParams): Promise<boolean>;
646
+ tryLogin(data?: AppTryLoginParams): Promise<boolean>;
647
647
  /**
648
648
  * Update embedded status
649
649
  * @param embedded New embedded status
@@ -1635,27 +1635,27 @@ class CoreApp {
1635
1635
  // Clear, noTrigger = true, avoid state update
1636
1636
  this.userLogout(true, true);
1637
1637
  // Go to login page
1638
- this.toLoginPage({ tryLogin: false, removeUrl: true });
1638
+ this.toLoginPage({ params: { tryLogin: false }, removeUrl: true });
1639
1639
  }
1640
1640
  /**
1641
1641
  * Go to the login page
1642
- * @params Login parameters
1642
+ * @param data Login parameters
1643
1643
  */
1644
- toLoginPage(params) {
1644
+ toLoginPage(data) {
1645
1645
  // Destruct
1646
- const { removeUrl, showLoading, ...rest } = params ?? {};
1646
+ const { params = {}, removeUrl } = data ?? {};
1647
1647
  // Save the current URL
1648
1648
  this.cachedUrl = removeUrl ? undefined : globalThis.location.href;
1649
1649
  // URL with parameters
1650
- const url = '/'.addUrlParams(rest);
1650
+ const url = '/'.addUrlParams(params);
1651
1651
  this.navigate(url);
1652
1652
  }
1653
1653
  /**
1654
1654
  * Try login, returning false means is loading
1655
1655
  * UI get involved while refreshToken not intended
1656
- * @param params Login parameters
1656
+ * @param data Login parameters
1657
1657
  */
1658
- async tryLogin(params) {
1658
+ async tryLogin(data) {
1659
1659
  // Check status
1660
1660
  if (this._isTryingLogin)
1661
1661
  return false;
@@ -43,11 +43,16 @@ export type FormatResultCustomCallback = ((data: FormatResultCustom) => string |
43
43
  /**
44
44
  * Login parameters
45
45
  */
46
- export type AppLoginParams = DataTypes.SimpleObject & {
46
+ export type AppLoginParams = {
47
47
  /**
48
- * Try login with cached refresh token
48
+ * Login parameters to pass
49
49
  */
50
- tryLogin?: boolean;
50
+ params: DataTypes.SimpleObject & {
51
+ /**
52
+ * Try login with cached refresh token
53
+ */
54
+ tryLogin?: boolean;
55
+ };
51
56
  /**
52
57
  * Don't cache current URL instead of the default page
53
58
  */
@@ -573,15 +578,15 @@ export interface IApp {
573
578
  persist(): void;
574
579
  /**
575
580
  * Go to the login page
576
- * @param params Login parameters
581
+ * @param data Login parameters
577
582
  */
578
- toLoginPage(params?: AppLoginParams): void;
583
+ toLoginPage(data?: AppLoginParams): void;
579
584
  /**
580
585
  * Try login, returning false means is loading
581
586
  * UI get involved while refreshToken not intended
582
- * @param params Login parameters
587
+ * @param data Login parameters
583
588
  */
584
- tryLogin(params?: AppLoginParams): Promise<boolean>;
589
+ tryLogin(data?: AppLoginParams): Promise<boolean>;
585
590
  /**
586
591
  * Update API token and expires
587
592
  * @param name Api name
@@ -635,15 +635,15 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
635
635
  signout(): Promise<void>;
636
636
  /**
637
637
  * Go to the login page
638
- * @params Login parameters
638
+ * @param data Login parameters
639
639
  */
640
- toLoginPage(params?: AppLoginParams): void;
640
+ toLoginPage(data?: AppLoginParams): void;
641
641
  /**
642
642
  * Try login, returning false means is loading
643
643
  * UI get involved while refreshToken not intended
644
- * @param params Login parameters
644
+ * @param data Login parameters
645
645
  */
646
- tryLogin(params?: AppTryLoginParams): Promise<boolean>;
646
+ tryLogin(data?: AppTryLoginParams): Promise<boolean>;
647
647
  /**
648
648
  * Update embedded status
649
649
  * @param embedded New embedded status
@@ -1632,27 +1632,27 @@ export class CoreApp {
1632
1632
  // Clear, noTrigger = true, avoid state update
1633
1633
  this.userLogout(true, true);
1634
1634
  // Go to login page
1635
- this.toLoginPage({ tryLogin: false, removeUrl: true });
1635
+ this.toLoginPage({ params: { tryLogin: false }, removeUrl: true });
1636
1636
  }
1637
1637
  /**
1638
1638
  * Go to the login page
1639
- * @params Login parameters
1639
+ * @param data Login parameters
1640
1640
  */
1641
- toLoginPage(params) {
1641
+ toLoginPage(data) {
1642
1642
  // Destruct
1643
- const { removeUrl, showLoading, ...rest } = params ?? {};
1643
+ const { params = {}, removeUrl } = data ?? {};
1644
1644
  // Save the current URL
1645
1645
  this.cachedUrl = removeUrl ? undefined : globalThis.location.href;
1646
1646
  // URL with parameters
1647
- const url = '/'.addUrlParams(rest);
1647
+ const url = '/'.addUrlParams(params);
1648
1648
  this.navigate(url);
1649
1649
  }
1650
1650
  /**
1651
1651
  * Try login, returning false means is loading
1652
1652
  * UI get involved while refreshToken not intended
1653
- * @param params Login parameters
1653
+ * @param data Login parameters
1654
1654
  */
1655
- async tryLogin(params) {
1655
+ async tryLogin(data) {
1656
1656
  // Check status
1657
1657
  if (this._isTryingLogin)
1658
1658
  return false;
@@ -43,11 +43,16 @@ export type FormatResultCustomCallback = ((data: FormatResultCustom) => string |
43
43
  /**
44
44
  * Login parameters
45
45
  */
46
- export type AppLoginParams = DataTypes.SimpleObject & {
46
+ export type AppLoginParams = {
47
47
  /**
48
- * Try login with cached refresh token
48
+ * Login parameters to pass
49
49
  */
50
- tryLogin?: boolean;
50
+ params: DataTypes.SimpleObject & {
51
+ /**
52
+ * Try login with cached refresh token
53
+ */
54
+ tryLogin?: boolean;
55
+ };
51
56
  /**
52
57
  * Don't cache current URL instead of the default page
53
58
  */
@@ -573,15 +578,15 @@ export interface IApp {
573
578
  persist(): void;
574
579
  /**
575
580
  * Go to the login page
576
- * @param params Login parameters
581
+ * @param data Login parameters
577
582
  */
578
- toLoginPage(params?: AppLoginParams): void;
583
+ toLoginPage(data?: AppLoginParams): void;
579
584
  /**
580
585
  * Try login, returning false means is loading
581
586
  * UI get involved while refreshToken not intended
582
- * @param params Login parameters
587
+ * @param data Login parameters
583
588
  */
584
- tryLogin(params?: AppLoginParams): Promise<boolean>;
589
+ tryLogin(data?: AppLoginParams): Promise<boolean>;
585
590
  /**
586
591
  * Update API token and expires
587
592
  * @param name Api name
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@etsoo/appscript",
3
- "version": "1.5.53",
3
+ "version": "1.5.54",
4
4
  "description": "Applications shared TypeScript framework",
5
5
  "main": "lib/cjs/index.js",
6
6
  "module": "lib/mjs/index.js",
@@ -2229,22 +2229,22 @@ export abstract class CoreApp<
2229
2229
  this.userLogout(true, true);
2230
2230
 
2231
2231
  // Go to login page
2232
- this.toLoginPage({ tryLogin: false, removeUrl: true });
2232
+ this.toLoginPage({ params: { tryLogin: false }, removeUrl: true });
2233
2233
  }
2234
2234
 
2235
2235
  /**
2236
2236
  * Go to the login page
2237
- * @params Login parameters
2237
+ * @param data Login parameters
2238
2238
  */
2239
- toLoginPage(params?: AppLoginParams) {
2239
+ toLoginPage(data?: AppLoginParams) {
2240
2240
  // Destruct
2241
- const { removeUrl, showLoading, ...rest } = params ?? {};
2241
+ const { params = {}, removeUrl } = data ?? {};
2242
2242
 
2243
2243
  // Save the current URL
2244
2244
  this.cachedUrl = removeUrl ? undefined : globalThis.location.href;
2245
2245
 
2246
2246
  // URL with parameters
2247
- const url = '/'.addUrlParams(rest);
2247
+ const url = '/'.addUrlParams(params);
2248
2248
 
2249
2249
  this.navigate(url);
2250
2250
  }
@@ -2252,9 +2252,9 @@ export abstract class CoreApp<
2252
2252
  /**
2253
2253
  * Try login, returning false means is loading
2254
2254
  * UI get involved while refreshToken not intended
2255
- * @param params Login parameters
2255
+ * @param data Login parameters
2256
2256
  */
2257
- async tryLogin(params?: AppTryLoginParams) {
2257
+ async tryLogin(data?: AppTryLoginParams) {
2258
2258
  // Check status
2259
2259
  if (this._isTryingLogin) return false;
2260
2260
  this._isTryingLogin = true;
package/src/app/IApp.ts CHANGED
@@ -66,11 +66,16 @@ export type FormatResultCustomCallback =
66
66
  /**
67
67
  * Login parameters
68
68
  */
69
- export type AppLoginParams = DataTypes.SimpleObject & {
69
+ export type AppLoginParams = {
70
70
  /**
71
- * Try login with cached refresh token
71
+ * Login parameters to pass
72
72
  */
73
- tryLogin?: boolean;
73
+ params: DataTypes.SimpleObject & {
74
+ /**
75
+ * Try login with cached refresh token
76
+ */
77
+ tryLogin?: boolean;
78
+ };
74
79
 
75
80
  /**
76
81
  * Don't cache current URL instead of the default page
@@ -774,16 +779,16 @@ export interface IApp {
774
779
 
775
780
  /**
776
781
  * Go to the login page
777
- * @param params Login parameters
782
+ * @param data Login parameters
778
783
  */
779
- toLoginPage(params?: AppLoginParams): void;
784
+ toLoginPage(data?: AppLoginParams): void;
780
785
 
781
786
  /**
782
787
  * Try login, returning false means is loading
783
788
  * UI get involved while refreshToken not intended
784
- * @param params Login parameters
789
+ * @param data Login parameters
785
790
  */
786
- tryLogin(params?: AppLoginParams): Promise<boolean>;
791
+ tryLogin(data?: AppLoginParams): Promise<boolean>;
787
792
 
788
793
  /**
789
794
  * Update API token and expires