@etsoo/appscript 1.1.48 → 1.1.52

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

@@ -5,6 +5,7 @@ import { AddressRegion } from '../address/AddressRegion';
 import { IActionResult } from '../result/IActionResult';
 import { IUserData } from '../state/User';
 import { IAppSettings } from './AppSettings';
+import { UserRole } from './UserRole';
 /**
  * Detect IP callback interface
  */
@@ -158,6 +159,12 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
      * @returns Time zone
      */
     getTimeZone(): string | undefined;
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean;
     /**
      * Callback where exit a page
      */
@@ -166,6 +173,15 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
      * Refresh token
      */
     refreshToken(): Promise<boolean>;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL
@@ -376,6 +392,12 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
      * @returns Time zone
      */
     getTimeZone(): string | undefined;
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean;
     /**
      * Callback where exit a page
      */
@@ -399,6 +421,15 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
      * Setup callback
      */
     setup(): void;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL

package/lib/cjs/app/CoreApp.js

@@ -338,6 +338,24 @@ class CoreApp {
         // settings.timeZone = Utils.getTimeZone()
         return (_a = this.settings.timeZone) !== null && _a !== void 0 ? _a : (_b = this.ipData) === null || _b === void 0 ? void 0 : _b.timezone;
     }
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles) {
+        var _a;
+        const userRole = (_a = this.userData) === null || _a === void 0 ? void 0 : _a.role;
+        if (userRole == null)
+            return false;
+        if (Array.isArray(roles)) {
+            return roles.some((role) => (userRole & role) === role);
+        }
+        // One role check
+        if ((userRole & roles) === roles)
+            return true;
+        return false;
+    }
     /**
      * Callback where exit a page
      */
@@ -389,6 +407,29 @@ class CoreApp {
      * 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();
+    }
+    /**
+     * Go to the login page
+     */
+    toLoginPage() {
+        window.location.replace(this.transformUrl('/'));
+    }
     /**
      * Transform URL
      * @param url URL

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

@@ -0,0 +1,42 @@
+/**
+ * Standard user roles
+ * @see com.etsoo.CoreFramework.Authentication.UserRole
+ */
+export declare enum UserRole {
+    /**
+     * Guest
+     */
+    Guest = 1,
+    /**
+     * Outsourcing
+     */
+    Outsourcing = 2,
+    /**
+     * Operator
+     */
+    Operator = 4,
+    /**
+     * User
+     */
+    User = 8,
+    /**
+     * Manager
+     */
+    Manager = 128,
+    /**
+     * Finance
+     */
+    Finance = 256,
+    /**
+     * HR Manager
+     */
+    HRManager = 512,
+    /**
+     * Administrator
+     */
+    Admin = 8192,
+    /**
+     * Founder, takes all ownership
+     */
+    Founder = 16384
+}

package/lib/cjs/app/UserRole.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserRole = void 0;
+/**
+ * Standard user roles
+ * @see com.etsoo.CoreFramework.Authentication.UserRole
+ */
+var UserRole;
+(function (UserRole) {
+    /**
+     * Guest
+     */
+    UserRole[UserRole["Guest"] = 1] = "Guest";
+    /**
+     * Outsourcing
+     */
+    UserRole[UserRole["Outsourcing"] = 2] = "Outsourcing";
+    /**
+     * Operator
+     */
+    UserRole[UserRole["Operator"] = 4] = "Operator";
+    /**
+     * User
+     */
+    UserRole[UserRole["User"] = 8] = "User";
+    /**
+     * Manager
+     */
+    UserRole[UserRole["Manager"] = 128] = "Manager";
+    /**
+     * Finance
+     */
+    UserRole[UserRole["Finance"] = 256] = "Finance";
+    /**
+     * HR Manager
+     */
+    UserRole[UserRole["HRManager"] = 512] = "HRManager";
+    /**
+     * Administrator
+     */
+    UserRole[UserRole["Admin"] = 8192] = "Admin";
+    /**
+     * Founder, takes all ownership
+     */
+    UserRole[UserRole["Founder"] = 16384] = "Founder";
+})(UserRole = exports.UserRole || (exports.UserRole = {}));

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

@@ -31,6 +31,7 @@
     "name": "Name",
     "no": "No",
     "noChanges": "No changes yet",
+    "noData": "No valid data",
     "noOptions": "No options",
     "ok": "OK",
     "open": "Open",

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

@@ -31,6 +31,7 @@
     "name": "姓名",
     "no": "否",
     "noChanges": "还没有任何修改",
+    "noData": "没有有效数据",
     "noOptions": "没有选项",
     "ok": "确定",
     "open": "打开",

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

@@ -31,6 +31,7 @@
     "name": "姓名",
     "no": "否",
     "noChanges": "還沒有任何修改",
+    "noData": "沒有有效數據",
     "noOptions": "沒有選項",
     "ok": "確定",
     "open": "打開",

package/lib/cjs/index.d.ts

@@ -4,6 +4,7 @@ export * from './address/AddressUtils';
 export * from './app/AppSettings';
 export * from './app/CoreApp';
 export * from './app/ExternalSettings';
+export * from './app/UserRole';
 export * from './bridges/ElectronBridge';
 export * from './bridges/IAppData';
 export * from './bridges/IBridge';

package/lib/cjs/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./address/AddressUtils"), exports);
 __exportStar(require("./app/AppSettings"), exports);
 __exportStar(require("./app/CoreApp"), exports);
 __exportStar(require("./app/ExternalSettings"), exports);
+__exportStar(require("./app/UserRole"), exports);
 // bridges
 __exportStar(require("./bridges/ElectronBridge"), exports);
 __exportStar(require("./bridges/IAppData"), exports);

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

@@ -5,6 +5,7 @@ import { AddressRegion } from '../address/AddressRegion';
 import { IActionResult } from '../result/IActionResult';
 import { IUserData } from '../state/User';
 import { IAppSettings } from './AppSettings';
+import { UserRole } from './UserRole';
 /**
  * Detect IP callback interface
  */
@@ -158,6 +159,12 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
      * @returns Time zone
      */
     getTimeZone(): string | undefined;
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean;
     /**
      * Callback where exit a page
      */
@@ -166,6 +173,15 @@ export interface ICoreApp<S extends IAppSettings, N, C extends NotificationCallP
      * Refresh token
      */
     refreshToken(): Promise<boolean>;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL
@@ -376,6 +392,12 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
      * @returns Time zone
      */
     getTimeZone(): string | undefined;
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean;
     /**
      * Callback where exit a page
      */
@@ -399,6 +421,15 @@ export declare abstract class CoreApp<S extends IAppSettings, N, C extends Notif
      * Setup callback
      */
     setup(): void;
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
     /**
      * Transform URL
      * @param url URL

package/lib/mjs/app/CoreApp.js

@@ -335,6 +335,24 @@ export class CoreApp {
         // settings.timeZone = Utils.getTimeZone()
         return (_a = this.settings.timeZone) !== null && _a !== void 0 ? _a : (_b = this.ipData) === null || _b === void 0 ? void 0 : _b.timezone;
     }
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles) {
+        var _a;
+        const userRole = (_a = this.userData) === null || _a === void 0 ? void 0 : _a.role;
+        if (userRole == null)
+            return false;
+        if (Array.isArray(roles)) {
+            return roles.some((role) => (userRole & role) === role);
+        }
+        // One role check
+        if ((userRole & roles) === roles)
+            return true;
+        return false;
+    }
     /**
      * Callback where exit a page
      */
@@ -386,6 +404,29 @@ export class CoreApp {
      * 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();
+    }
+    /**
+     * Go to the login page
+     */
+    toLoginPage() {
+        window.location.replace(this.transformUrl('/'));
+    }
     /**
      * Transform URL
      * @param url URL

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

@@ -0,0 +1,42 @@
+/**
+ * Standard user roles
+ * @see com.etsoo.CoreFramework.Authentication.UserRole
+ */
+export declare enum UserRole {
+    /**
+     * Guest
+     */
+    Guest = 1,
+    /**
+     * Outsourcing
+     */
+    Outsourcing = 2,
+    /**
+     * Operator
+     */
+    Operator = 4,
+    /**
+     * User
+     */
+    User = 8,
+    /**
+     * Manager
+     */
+    Manager = 128,
+    /**
+     * Finance
+     */
+    Finance = 256,
+    /**
+     * HR Manager
+     */
+    HRManager = 512,
+    /**
+     * Administrator
+     */
+    Admin = 8192,
+    /**
+     * Founder, takes all ownership
+     */
+    Founder = 16384
+}

package/lib/mjs/app/UserRole.js

@@ -0,0 +1,43 @@
+/**
+ * Standard user roles
+ * @see com.etsoo.CoreFramework.Authentication.UserRole
+ */
+export var UserRole;
+(function (UserRole) {
+    /**
+     * Guest
+     */
+    UserRole[UserRole["Guest"] = 1] = "Guest";
+    /**
+     * Outsourcing
+     */
+    UserRole[UserRole["Outsourcing"] = 2] = "Outsourcing";
+    /**
+     * Operator
+     */
+    UserRole[UserRole["Operator"] = 4] = "Operator";
+    /**
+     * User
+     */
+    UserRole[UserRole["User"] = 8] = "User";
+    /**
+     * Manager
+     */
+    UserRole[UserRole["Manager"] = 128] = "Manager";
+    /**
+     * Finance
+     */
+    UserRole[UserRole["Finance"] = 256] = "Finance";
+    /**
+     * HR Manager
+     */
+    UserRole[UserRole["HRManager"] = 512] = "HRManager";
+    /**
+     * Administrator
+     */
+    UserRole[UserRole["Admin"] = 8192] = "Admin";
+    /**
+     * Founder, takes all ownership
+     */
+    UserRole[UserRole["Founder"] = 16384] = "Founder";
+})(UserRole || (UserRole = {}));

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

@@ -31,6 +31,7 @@
     "name": "Name",
     "no": "No",
     "noChanges": "No changes yet",
+    "noData": "No valid data",
     "noOptions": "No options",
     "ok": "OK",
     "open": "Open",

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

@@ -31,6 +31,7 @@
     "name": "姓名",
     "no": "否",
     "noChanges": "还没有任何修改",
+    "noData": "没有有效数据",
     "noOptions": "没有选项",
     "ok": "确定",
     "open": "打开",

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

@@ -31,6 +31,7 @@
     "name": "姓名",
     "no": "否",
     "noChanges": "還沒有任何修改",
+    "noData": "沒有有效數據",
     "noOptions": "沒有選項",
     "ok": "確定",
     "open": "打開",

package/lib/mjs/index.d.ts

@@ -4,6 +4,7 @@ export * from './address/AddressUtils';
 export * from './app/AppSettings';
 export * from './app/CoreApp';
 export * from './app/ExternalSettings';
+export * from './app/UserRole';
 export * from './bridges/ElectronBridge';
 export * from './bridges/IAppData';
 export * from './bridges/IBridge';

package/lib/mjs/index.js

@@ -6,6 +6,7 @@ export * from './address/AddressUtils';
 export * from './app/AppSettings';
 export * from './app/CoreApp';
 export * from './app/ExternalSettings';
+export * from './app/UserRole';
 // bridges
 export * from './bridges/ElectronBridge';
 export * from './bridges/IAppData';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/appscript",
-    "version": "1.1.48",
+    "version": "1.1.52",
     "description": "Applications shared TypeScript framework",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -52,7 +52,7 @@
     },
     "homepage": "https://github.com/ETSOO/AppScript#readme",
     "dependencies": {
-        "@etsoo/notificationbase": "^1.0.93",
+        "@etsoo/notificationbase": "^1.0.94",
         "@etsoo/restclient": "^1.0.62",
         "@etsoo/shared": "^1.0.75"
     },
@@ -63,12 +63,12 @@
         "@babel/preset-env": "^7.16.4",
         "@babel/runtime-corejs3": "^7.16.3",
         "@types/jest": "^27.0.3",
-        "@typescript-eslint/eslint-plugin": "^5.4.0",
-        "@typescript-eslint/parser": "^5.4.0",
+        "@typescript-eslint/eslint-plugin": "^5.5.0",
+        "@typescript-eslint/parser": "^5.5.0",
         "eslint": "^8.3.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.25.3",
-        "jest": "^27.3.1",
+        "jest": "^27.4.3",
         "ts-jest": "^27.0.7",
         "typescript": "^4.5.2"
     }

package/src/app/CoreApp.ts

@@ -20,6 +20,7 @@ import { ActionResultError } from '../result/ActionResultError';
 import { IActionResult } from '../result/IActionResult';
 import { IUserData } from '../state/User';
 import { IAppSettings } from './AppSettings';
+import { UserRole } from './UserRole';
 
 /**
  * Detect IP callback interface
@@ -216,6 +217,13 @@ export interface ICoreApp<
      */
     getTimeZone(): string | undefined;
 
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean;
+
     /**
      * Callback where exit a page
      */
@@ -226,6 +234,17 @@ export interface ICoreApp<
      */
     refreshToken(): Promise<boolean>;
 
+    /**
+     * Signout
+     * @param apiUrl Signout API URL
+     */
+    signout(apiUrl?: string): Promise<void>;
+
+    /**
+     * Go to the login page
+     */
+    toLoginPage(): void;
+
     /**
      * Transform URL
      * @param url URL
@@ -727,6 +746,25 @@ export abstract class CoreApp<
         return this.settings.timeZone ?? this.ipData?.timezone;
     }
 
+    /**
+     * Check use has the specific role permission or not
+     * @param roles Roles to check
+     * @returns Result
+     */
+    hasPermission(roles: number | UserRole | number[] | UserRole[]): boolean {
+        const userRole = this.userData?.role;
+        if (userRole == null) return false;
+
+        if (Array.isArray(roles)) {
+            return roles.some((role) => (userRole & role) === role);
+        }
+
+        // One role check
+        if ((userRole & roles) === roles) return true;
+
+        return false;
+    }
+
     /**
      * Callback where exit a page
      */
@@ -789,6 +827,33 @@ 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();
+    }
+
+    /**
+     * Go to the login page
+     */
+    toLoginPage() {
+        window.location.replace(this.transformUrl('/'));
+    }
+
     /**
      * Transform URL
      * @param url URL

package/src/app/UserRole.ts

@@ -0,0 +1,50 @@
+/**
+ * Standard user roles
+ * @see com.etsoo.CoreFramework.Authentication.UserRole
+ */
+export enum UserRole {
+    /**
+     * Guest
+     */
+    Guest = 1,
+
+    /**
+     * Outsourcing
+     */
+    Outsourcing = 2,
+
+    /**
+     * Operator
+     */
+    Operator = 4,
+
+    /**
+     * User
+     */
+    User = 8,
+
+    /**
+     * Manager
+     */
+    Manager = 128,
+
+    /**
+     * Finance
+     */
+    Finance = 256,
+
+    /**
+     * HR Manager
+     */
+    HRManager = 512,
+
+    /**
+     * Administrator
+     */
+    Admin = 8192,
+
+    /**
+     * Founder, takes all ownership
+     */
+    Founder = 16384
+}

package/src/i18n/en-US.json

@@ -31,6 +31,7 @@
     "name": "Name",
     "no": "No",
     "noChanges": "No changes yet",
+    "noData": "No valid data",
     "noOptions": "No options",
     "ok": "OK",
     "open": "Open",

package/src/i18n/zh-CN.json

@@ -31,6 +31,7 @@
     "name": "姓名",
     "no": "否",
     "noChanges": "还没有任何修改",
+    "noData": "没有有效数据",
     "noOptions": "没有选项",
     "ok": "确定",
     "open": "打开",

package/src/i18n/zh-HK.json

@@ -31,6 +31,7 @@
     "name": "姓名",
     "no": "否",
     "noChanges": "還沒有任何修改",
+    "noData": "沒有有效數據",
     "noOptions": "沒有選項",
     "ok": "確定",
     "open": "打開",

package/src/index.ts

@@ -7,6 +7,7 @@ export * from './address/AddressUtils';
 export * from './app/AppSettings';
 export * from './app/CoreApp';
 export * from './app/ExternalSettings';
+export * from './app/UserRole';
 
 // bridges
 export * from './bridges/ElectronBridge';