@propmix/profet-common-header 3.4.0-beta.1 → 3.5.0-beta.0

package/README.md

@@ -77,6 +77,10 @@ Use an initializer function to configure parameters
                 disableAppMenu: true
                 // disableAppMenu - Using this option to disable the app menu. 
                 //                  Default value is false
+
+                hideViewProfile: true
+                // hideViewProfile - Using this option to hide the "View Profile" button. 
+                //                   Default is false
             };
         
             return headerConfig;
@@ -97,6 +101,39 @@ Use the configuration option in the app.module.ts file
 
 INACTIVITY_LIMIT - Provide the value in milliseconds. The default value is 30 minutes
 
+## Outputs
+
+`logoutEvent` - Emitted during the logout process. It outputs an object with details about why the logout happened and its current lifecycle stage:
+
+*Example:*
+
+*HTML* -
+
+        <lib-header (logoutEvent)="handleLogout($event)"></lib-header>
+
+*Typescript* -
+
+        import { LogoutReason, LogoutStatus } from '@propmix/profet-common-header';
+
+        handleLogout(event: { reason: LogoutReason, status: LogoutStatus }) {
+            if (event.status === LogoutStatus.INITIATED) {
+                // Logout has started - clean up app state, save data, etc.
+                // e.g. clear local storage, cancel pending requests
+            }
+
+            if (event.status === LogoutStatus.COMPLETED) {
+                // Sign out is complete, redirect is about to happen
+            }
+
+            if (event.reason === LogoutReason.SESSION_TIMEOUT) {
+                // Triggered by inactivity timer
+            }
+
+            if (event.reason === LogoutReason.USER_INITIATED) {
+                // Triggered by user clicking the logout button
+            }
+        }
+
 ### Optional Observables
 
 The library provides two observables that can be consumed by the application if needed. However, using these observables is not mandatory.

package/esm2020/lib/common-header.interface.mjs

@@ -1,2 +1,11 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbW9uLWhlYWRlci5pbnRlcmZhY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wcm9qZWN0cy9jb21tb24taGVhZGVyL3NyYy9saWIvY29tbW9uLWhlYWRlci5pbnRlcmZhY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFBST0ZFVF9BUFBTIH0gZnJvbSBcIi4vdXRpbHMvYXBwcy5lbnVtXCI7XG5cbmV4cG9ydCBpbnRlcmZhY2UgQXBwTWVudSB7XG4gICAgYXBwVHlwZTogUFJPRkVUX0FQUFM7XG4gICAgbWVudU5hbWU6IHN0cmluZztcbiAgICBpY29uPzogc3RyaW5nO1xuICAgIHBhdGg6IHN0cmluZztcbiAgICBncm91cEJ5Pzogc3RyaW5nO1xufVxuXG5leHBvcnQgdHlwZSBBcHBsaWNhdGlvbkNvbmZpZyA9IHtcbiAgICBba2V5IGluIFBST0ZFVF9BUFBTXToge1xuICAgICAgICBhcHBOYW1lOiBzdHJpbmc7XG4gICAgICAgIGFwcExvZ29Vcmk6IHN0cmluZztcbiAgICB9XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgSGVhZGVyQ29uZmlnIHtcbiAgICBhcGlVcmw6IHN0cmluZztcbiAgICBwb3J0YWxGcm9udGVuZFVybD86IHN0cmluZztcbiAgICBzaWduT3V0VXJsOiBzdHJpbmc7XG4gICAgYXBwVHlwZTogUFJPRkVUX0FQUFM7XG4gICAgZW5hYmxlTGFzdFVybFJlZGlyZWN0aW9uPzogYm9vbGVhbjtcbiAgICBkaXNhYmxlQXBwTWVudT86IGJvb2xlYW47XG4gICAgYXBwTG9nb05hdmlnYXRpb25Vcmw/OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQ29tcGFueSB7XG4gICAgaWQ6IG51bWJlcjtcbiAgICBjb21wYW55S2V5OiBzdHJpbmc7XG4gICAgbmFtZTogc3RyaW5nO1xuICAgIGxvZ28/OiBzdHJpbmc7XG4gICAgaXNBY3RpdmU6IGJvb2xlYW47XG4gICAgYmFzZVVybHM6IHtcbiAgICAgICAgcHJvZmV0X3BvcnRhbD86IHN0cmluZyxcbiAgICAgICAgYXBwcmFpc2FsX21hbmFnZW1lbnQ/OiBzdHJpbmcsXG4gICAgICAgIGFwcHJhaXNhbF9yZXZpZXc/OiBzdHJpbmcsXG4gICAgICAgIGFwcHJhaXNhbF92YWx1YXRpb24/OiBzdHJpbmdcbiAgICB9XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgU2Vzc2lvbk91dEluZm8ge1xuICAgIHNlc3Npb25PdXRUaW1lSW5NaW5zPzogbnVtYmVyO1xufSJdfQ==
+export var LogoutReason;
+(function (LogoutReason) {
+    LogoutReason["USER_INITIATED"] = "USER_INITIATED";
+    LogoutReason["SESSION_TIMEOUT"] = "SESSION_TIMEOUT";
+})(LogoutReason || (LogoutReason = {}));
+export var LogoutStatus;
+(function (LogoutStatus) {
+    LogoutStatus["INITIATED"] = "INITIATED";
+    LogoutStatus["COMPLETED"] = "COMPLETED";
+})(LogoutStatus || (LogoutStatus = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbW9uLWhlYWRlci5pbnRlcmZhY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wcm9qZWN0cy9jb21tb24taGVhZGVyL3NyYy9saWIvY29tbW9uLWhlYWRlci5pbnRlcmZhY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBOENBLE1BQU0sQ0FBTixJQUFZLFlBR1g7QUFIRCxXQUFZLFlBQVk7SUFDcEIsaURBQWlDLENBQUE7SUFDakMsbURBQW1DLENBQUE7QUFDdkMsQ0FBQyxFQUhXLFlBQVksS0FBWixZQUFZLFFBR3ZCO0FBRUQsTUFBTSxDQUFOLElBQVksWUFHWDtBQUhELFdBQVksWUFBWTtJQUNwQix1Q0FBdUIsQ0FBQTtJQUN2Qix1Q0FBdUIsQ0FBQTtBQUMzQixDQUFDLEVBSFcsWUFBWSxLQUFaLFlBQVksUUFHdkIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBQUk9GRVRfQVBQUyB9IGZyb20gXCIuL3V0aWxzL2FwcHMuZW51bVwiO1xuXG5leHBvcnQgaW50ZXJmYWNlIEFwcE1lbnUge1xuICAgIGFwcFR5cGU6IFBST0ZFVF9BUFBTO1xuICAgIG1lbnVOYW1lOiBzdHJpbmc7XG4gICAgaWNvbj86IHN0cmluZztcbiAgICBwYXRoOiBzdHJpbmc7XG4gICAgZ3JvdXBCeT86IHN0cmluZztcbn1cblxuZXhwb3J0IHR5cGUgQXBwbGljYXRpb25Db25maWcgPSB7XG4gICAgW2tleSBpbiBQUk9GRVRfQVBQU106IHtcbiAgICAgICAgYXBwTmFtZTogc3RyaW5nO1xuICAgICAgICBhcHBMb2dvVXJpOiBzdHJpbmc7XG4gICAgfVxufVxuXG5leHBvcnQgaW50ZXJmYWNlIEhlYWRlckNvbmZpZyB7XG4gICAgYXBpVXJsOiBzdHJpbmc7XG4gICAgcG9ydGFsRnJvbnRlbmRVcmw/OiBzdHJpbmc7XG4gICAgc2lnbk91dFVybDogc3RyaW5nO1xuICAgIGFwcFR5cGU6IFBST0ZFVF9BUFBTO1xuICAgIGVuYWJsZUxhc3RVcmxSZWRpcmVjdGlvbj86IGJvb2xlYW47XG4gICAgZGlzYWJsZUFwcE1lbnU/OiBib29sZWFuO1xuICAgIGFwcExvZ29OYXZpZ2F0aW9uVXJsPzogc3RyaW5nO1xuICAgIGhpZGVWaWV3UHJvZmlsZT86IGJvb2xlYW47XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQ29tcGFueSB7XG4gICAgaWQ6IG51bWJlcjtcbiAgICBjb21wYW55S2V5OiBzdHJpbmc7XG4gICAgbmFtZTogc3RyaW5nO1xuICAgIGxvZ28/OiBzdHJpbmc7XG4gICAgaXNBY3RpdmU6IGJvb2xlYW47XG4gICAgYmFzZVVybHM6IHtcbiAgICAgICAgcHJvZmV0X3BvcnRhbD86IHN0cmluZyxcbiAgICAgICAgYXBwcmFpc2FsX21hbmFnZW1lbnQ/OiBzdHJpbmcsXG4gICAgICAgIGFwcHJhaXNhbF9yZXZpZXc/OiBzdHJpbmcsXG4gICAgICAgIGFwcHJhaXNhbF92YWx1YXRpb24/OiBzdHJpbmdcbiAgICB9XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgU2Vzc2lvbk91dEluZm8ge1xuICAgIHNlc3Npb25PdXRUaW1lSW5NaW5zPzogbnVtYmVyO1xufVxuXG5leHBvcnQgZW51bSBMb2dvdXRSZWFzb24ge1xuICAgIFVTRVJfSU5JVElBVEVEID0gJ1VTRVJfSU5JVElBVEVEJyxcbiAgICBTRVNTSU9OX1RJTUVPVVQgPSAnU0VTU0lPTl9USU1FT1VUJ1xufVxuXG5leHBvcnQgZW51bSBMb2dvdXRTdGF0dXMge1xuICAgIElOSVRJQVRFRCA9ICdJTklUSUFURUQnLFxuICAgIENPTVBMRVRFRCA9ICdDT01QTEVURUQnXG59Il19