@softheon/armature 17.26.0 → 17.26.2

package/lib/armature.module.d.ts

@@ -13,6 +13,7 @@ import * as i8 from "./alert-banner/alert-banner.module";
 import * as i9 from "@angular/router";
 import * as i10 from "@angular/common";
 import * as i11 from "@ngbracket/ngx-layout";
+import * as i12 from "./navigation/components/b2b-nav/b2b-nav.component";
 /**
  * Session base path factory
  * @param injector The angular injector
@@ -41,6 +42,6 @@ export declare class ArmatureModule {
      */
     static forRoot(configServiceClass?: any, ignoreCustomAppInitializer?: boolean): ModuleWithProviders<ArmatureModule>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ArmatureModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<ArmatureModule, [typeof i1.AppTemplateComponent], [typeof i2.FormsModule, typeof i3.NavigationModule, typeof i4.ArmatureHeaderModule, typeof i5.ArmatureFooterModule, typeof i6.BaseComponentModule, typeof i7.ThemeModule, typeof i8.AlertBannerModule, typeof i9.RouterModule, typeof i10.CommonModule, typeof i11.FlexLayoutModule], [typeof i2.FormsModule, typeof i3.NavigationModule, typeof i4.ArmatureHeaderModule, typeof i5.ArmatureFooterModule, typeof i6.BaseComponentModule, typeof i7.ThemeModule, typeof i8.AlertBannerModule, typeof i1.AppTemplateComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<ArmatureModule, [typeof i1.AppTemplateComponent], [typeof i2.FormsModule, typeof i3.NavigationModule, typeof i4.ArmatureHeaderModule, typeof i5.ArmatureFooterModule, typeof i6.BaseComponentModule, typeof i7.ThemeModule, typeof i8.AlertBannerModule, typeof i9.RouterModule, typeof i10.CommonModule, typeof i11.FlexLayoutModule, typeof i12.B2bNavComponent], [typeof i2.FormsModule, typeof i3.NavigationModule, typeof i4.ArmatureHeaderModule, typeof i5.ArmatureFooterModule, typeof i6.BaseComponentModule, typeof i7.ThemeModule, typeof i8.AlertBannerModule, typeof i1.AppTemplateComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<ArmatureModule>;
 }

package/lib/core/components/app-template/app-template.component.d.ts

@@ -69,5 +69,5 @@ export declare class AppTemplateComponent implements OnInit {
     /** Assigns the default navigation theme */
     private assignDefaultNavTheme;
     static ɵfac: i0.ɵɵFactoryDeclaration<AppTemplateComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<AppTemplateComponent, "sof-ar-app-template", never, {}, {}, never, ["[sof-ar-header-left]", "[sof-ar-header-center]", "[sof-ar-header-right]", "[sof-header-user-menu]", "[sof-ar-template-content]", "[sof-ar-nav-content-header]", "[sof-ar-footer-content]", "[sof-ar-nav-mobile-footer]"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AppTemplateComponent, "sof-ar-app-template", never, {}, {}, never, ["[sof-ar-header-left]", "[sof-ar-header-center]", "[sof-ar-header-right]", "[sof-header-user-menu]", "[sof-ar-template-content]", "[sof-ar-nav-content-header]", "[sof-ar-footer-content]", "[sof-ar-nav-mobile-footer]", "[sof-ar-nav-content-header]", "[sof-ar-footer-content]", "[sof-ar-nav-mobile-footer]"], false, never>;
 }

package/lib/header/components/header/header.component.d.ts

@@ -1,5 +1,5 @@
 import { MediaMatcher } from '@angular/cdk/layout';
-import { ChangeDetectorRef, EventEmitter, OnInit } from '@angular/core';
+import { ChangeDetectorRef, EventEmitter, OnInit, WritableSignal } from '@angular/core';
 import { MatSlideToggleChange } from '@angular/material/slide-toggle';
 import { TranslateService } from '@ngx-translate/core';
 import { OAuthService, OAuthStorage } from 'angular-oauth2-oidc';
@@ -9,6 +9,7 @@ import { HeaderAuthSettings } from '../../models/header-auth.settings';
 import { HeaderLanguageSettings } from '../../models/header-language.settings';
 import { HeaderThemeSettings } from '../../models/header-theme.settings';
 import { HeaderSettings } from '../../models/header.settings';
+import { HeaderExternalLinks } from '../../models/header-external-links';
 import * as i0 from "@angular/core";
 /** The Header Component */
 export declare class ArmatureHeaderComponent implements OnInit {
@@ -80,6 +81,8 @@ export declare class ArmatureHeaderComponent implements OnInit {
     get manageUrl(): string;
     /** The header language settings */
     headerLanguageSettings: HeaderLanguageSettings;
+    /** The header external links */
+    externalLinks: WritableSignal<Array<HeaderExternalLinks>>;
     /** the mobile query */
     mobileQuery: MediaQueryList;
     /** the mobile query listener2 */

package/lib/header/header-api.d.ts

@@ -9,3 +9,4 @@ export * from './models/header-theme.settings';
 export * from './models/header-auth.settings';
 export * from './models/mobile-header-nav.settings';
 export * from './models/header-language.settings';
+export * from './models/header-external-links';

package/lib/header/header.module.d.ts

@@ -13,8 +13,9 @@ import * as i11 from "@angular/material/icon";
 import * as i12 from "@angular/material/list";
 import * as i13 from "@angular/material/slide-toggle";
 import * as i14 from "@angular/material/sidenav";
+import * as i15 from "@angular/material/tooltip";
 export declare class ArmatureHeaderModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<ArmatureHeaderModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<ArmatureHeaderModule, [typeof i1.ArmatureHeaderComponent, typeof i2.MobileHeaderMenuComponent], [typeof i3.RouterModule, typeof i4.CommonModule, typeof i5.TranslateModule, typeof i6.FlexLayoutModule, typeof i7.MatToolbarModule, typeof i8.MatMenuModule, typeof i9.MatButtonToggleModule, typeof i10.MatButtonModule, typeof i11.MatIconModule, typeof i12.MatListModule, typeof i13.MatSlideToggleModule, typeof i14.MatSidenavModule], [typeof i1.ArmatureHeaderComponent, typeof i2.MobileHeaderMenuComponent, typeof i7.MatToolbarModule, typeof i8.MatMenuModule, typeof i9.MatButtonToggleModule, typeof i10.MatButtonModule, typeof i11.MatIconModule, typeof i12.MatListModule, typeof i13.MatSlideToggleModule, typeof i14.MatSidenavModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<ArmatureHeaderModule, [typeof i1.ArmatureHeaderComponent, typeof i2.MobileHeaderMenuComponent], [typeof i3.RouterModule, typeof i4.CommonModule, typeof i5.TranslateModule, typeof i6.FlexLayoutModule, typeof i7.MatToolbarModule, typeof i8.MatMenuModule, typeof i9.MatButtonToggleModule, typeof i10.MatButtonModule, typeof i11.MatIconModule, typeof i12.MatListModule, typeof i13.MatSlideToggleModule, typeof i14.MatSidenavModule, typeof i15.MatTooltipModule], [typeof i1.ArmatureHeaderComponent, typeof i2.MobileHeaderMenuComponent, typeof i7.MatToolbarModule, typeof i8.MatMenuModule, typeof i9.MatButtonToggleModule, typeof i10.MatButtonModule, typeof i11.MatIconModule, typeof i12.MatListModule, typeof i13.MatSlideToggleModule, typeof i14.MatSidenavModule, typeof i15.MatTooltipModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<ArmatureHeaderModule>;
 }

package/lib/header/models/header-external-links.d.ts

@@ -0,0 +1,13 @@
+/** The header external link configurations */
+export interface HeaderExternalLinks {
+    /** The link uri */
+    uri?: string;
+    /** The link text translate key */
+    translateKey?: string;
+    /** The link icon */
+    icon?: string;
+    /** The link icon alt text, also applies to log alt text */
+    iconAltTextTranslateKey?: string;
+    /** The link logo */
+    logo?: string;
+}

package/lib/header/models/header.settings.d.ts

@@ -1,5 +1,6 @@
 import { RoutePath } from '../../core/models/route-path';
 import { Styles } from '../../core/models/styles';
+import { HeaderExternalLinks } from './header-external-links';
 import { HeaderLanguageSettings } from './header-language.settings';
 /** the Header Settings */
 export interface HeaderSettings {
@@ -50,4 +51,6 @@ export interface HeaderSettings {
     darkThemeText?: string;
     /** True if we want to show username as unclickable*/
     makeUsernameUnclickable?: boolean;
+    /** The header external links */
+    externalLinks?: Array<HeaderExternalLinks>;
 }

package/lib/mfe/components/entity-base/entity-base.component.d.ts

@@ -0,0 +1,34 @@
+import { OnDestroy, OnInit } from '@angular/core';
+import { ActivatedRoute } from '@angular/router';
+import { EntityHelperService } from '../../services/entity-helper.service';
+import { EntityDto } from '../../models/entity-dto';
+import { EntityConfigBase } from '../../models/entity-config-base';
+import * as i0 from "@angular/core";
+/** The entity base component */
+export declare abstract class EntityBaseComponent<TConfig extends EntityConfigBase> implements OnInit, OnDestroy {
+    private readonly activatedRoute;
+    protected readonly entityHelper: EntityHelperService<TConfig>;
+    /** True if is expanded */
+    protected isExpanded: boolean;
+    /**
+     * Constructor
+     * @param activatedRoute The activated route
+     * @param entityHelper The entity helper service
+     */
+    constructor(activatedRoute: ActivatedRoute, entityHelper: EntityHelperService<TConfig>);
+    /** Life cycle hook for component initialization */
+    ngOnInit(): void;
+    /** Life cycle hook for component destruction */
+    ngOnDestroy(): void;
+    abstract onRowClick(entity: EntityDto): void;
+    /** Navigate back to list view */
+    returnToQueueView(): void;
+    /** Copies the entity url */
+    copyEntityUrl(): void;
+    /** Reloads the entity */
+    reloadEntity(): void;
+    /** Opens the entity view in a new route */
+    openEntityView(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EntityBaseComponent<any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EntityBaseComponent<any>, "ng-component", never, {}, {}, never, never, false, never>;
+}

package/lib/mfe/mfe.module.d.ts

@@ -0,0 +1,7 @@
+import * as i0 from "@angular/core";
+import * as i1 from "@angular/common";
+export declare class MfeModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MfeModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MfeModule, never, [typeof i1.CommonModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<MfeModule>;
+}

package/lib/mfe/models/entity-config-base.d.ts

@@ -0,0 +1,5 @@
+/** The entity configuration base */
+export interface EntityConfigBase {
+    /** The copy entity route prefix */
+    copyEntityRoutePrefix: string;
+}

package/lib/mfe/models/entity-dto.d.ts

@@ -0,0 +1,9 @@
+/** The entity dto */
+export interface EntityDto {
+    /** The folder ID */
+    folderId: number;
+    /** The drawer ID */
+    drawerId: number;
+    /** The task ID */
+    taskId: number;
+}

package/lib/mfe/services/entity-helper.service.d.ts

@@ -0,0 +1,60 @@
+import { HttpClient } from '@angular/common/http';
+import { WritableSignal } from '@angular/core';
+import { ActivatedRoute } from '@angular/router';
+import { TranslateService } from '@ngx-translate/core';
+import { Observable } from 'rxjs';
+import { EntityDto } from '../models/entity-dto';
+import { EntityConfigBase } from '../models/entity-config-base';
+import * as i0 from "@angular/core";
+/** The queue session storage prefix */
+export declare const ENTITY_SESSION_STORAGE_PREFIX = "mfe.entity.";
+/** The session storage queue name key */
+export declare const ENTITY_SS_CONFIG_PREFIX = "mfe.entity.entity-config-prefix";
+export declare class EntityHelperService<TConfig extends EntityConfigBase> {
+    private readonly http;
+    private readonly translateService;
+    /** The configuration behavior subject */
+    private readonly configBs;
+    /** The activated route subscription */
+    private activatedRouteSub;
+    /** The configuration observable */
+    readonly config$: Observable<TConfig>;
+    /** The configurations */
+    get config(): TConfig;
+    /** Sets the configurations */
+    set config(value: TConfig);
+    /** isLoaded behavior subject */
+    private readonly isLoadedBs;
+    /** Is loaded observable */
+    readonly isLoaded$: Observable<boolean>;
+    /** The current entity */
+    currentEntity: WritableSignal<EntityDto>;
+    /**
+     * Constructor
+     * @param http The http client
+     * @param translateService The translate service
+     */
+    constructor(http: HttpClient, translateService: TranslateService);
+    /**
+     * Initializes the current entity from route params
+     * @param activatedRoute The activated route
+     */
+    initializeRouteParams(activatedRoute: ActivatedRoute): void;
+    /**
+     * Initializes the configurations
+     */
+    initializeConfigurations(): void;
+    /**
+    *
+    * @param taskId The task id
+    * @param drawerId The drawer id
+    * @param entityId The entity id
+    * @param configPrefix Teh config prefix
+    * @param entityConfig The entity config
+    * @param enLangConfig The en lang config
+    */
+    loadConfigurations(configPrefix: string, entityConfig?: TConfig, enLangConfig?: JSON): void;
+    resetLoading(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EntityHelperService<any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EntityHelperService<any>>;
+}

package/lib/navigation/components/b2b-nav/b2b-nav.component.d.ts

@@ -0,0 +1,91 @@
+import { BreakpointState } from '@angular/cdk/layout';
+import { EventEmitter, OnInit, Signal } from '@angular/core';
+import { MatSidenavContent } from '@angular/material/sidenav';
+import { NavPanelLogo } from '../sof-navigation-panel/models/nav-panel-logo';
+import { NavNode } from '../../models/navigation';
+import { NavigationAdvancedSettings, NavigationSettings } from '../../models/nav.settings';
+import { NavigationThemeSettings } from '../../models/nav-theme.settings';
+import { HeaderLanguageSettings } from '../../../header/models/header-language.settings';
+import { MatMenuTrigger } from '@angular/material/menu';
+import * as i0 from "@angular/core";
+export declare class B2bNavComponent implements OnInit {
+    /** Utility for checking the matching state of media queries.*/
+    private breakpointObserver;
+    /** The router */
+    private router;
+    /** Has the small screen breakpoint been hit */
+    isSmallScreen: Signal<BreakpointState>;
+    /** The brand logo in the footer of the navigation panel */
+    brandLogo: NavPanelLogo;
+    /**
+   * Should scroll to top on `NavigationEnd` event?
+   * @default true
+  */
+    private scrollToTopOnNavigationEndEvent;
+    /**
+     * Is the nav panel open
+     * @note this is needed to pass panel opened state to the SofHeaderPortalComponent
+    */
+    isNavPanelOpenedEvent: EventEmitter<boolean>;
+    /**
+     * Main content for scroll position
+     * @note this is the element which has the apps 'main' scrollbar.
+    */
+    sidenavContent: MatSidenavContent;
+    /** Component Input - the navigation data */
+    navigationData: NavNode[];
+    /** Component Input - the navigation settings */
+    settings: NavigationSettings;
+    /** Component Input - the navigation settings */
+    advancedSettings: NavigationAdvancedSettings;
+    /** Component Input - the navigation settings */
+    themeSettings: NavigationThemeSettings;
+    /** Component Input - the navigation language settings */
+    languageSettings: HeaderLanguageSettings;
+    /** Current language **/
+    currentLang: string;
+    /** logOut text **/
+    logOutText: string;
+    /** Sets language **/
+    setLanguage$: EventEmitter<any>;
+    /** The mat menu trigger */
+    trigger: MatMenuTrigger;
+    /** True when the navigation is open */
+    isNavOpen: boolean;
+    /** The selected nav node */
+    selectedNode: NavNode;
+    /** Angular's router */
+    /** On Init - Initialize the settings */
+    ngOnInit(): void;
+    shrinkNav(): void;
+    openMenu(node: NavNode, event: MouseEvent): void;
+    /**
+     * Initializes the nav panel settings, defaults will be set if `null` or `undefined`
+     * @note The 'nullish coalescing assignment operator' `??=` assigns defaults for `boolean` and `number` types,
+     * for `number` types this will allow for `0` to be accepted. For a `string`, use 'logical OR assignment' `||=` operator,
+     * as this will also prevent empty strings `" "`.
+     * @see `??=` {@link [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Nullish_coalescing_assignment#using_nullish_coalescing_assignment)}
+     * @see `||=` {@link [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Logical_OR_assignment#try_it)}
+    */
+    private initSettings;
+    /**
+     * Scrolls to the top of page
+     * @note using `window.scrollTo` will not work if using this component as the main scrollbar does not live on the window level.
+     * Configuring `scrollPositionRestoration` in the router module will not work either.
+    */
+    scrollToTop(): void;
+    /** Initializes the advanced nav settings */
+    private initAdvancedSettings;
+    /** Initializes the nav theme settings */
+    private initThemeSettings;
+    /** Initializes the basic nav settings */
+    private initBasicSettings;
+    /**
+    * Sets the theme color
+    * @param variable the css variable name
+    * @param color the color
+    */
+    setThemeColor(variable: string, color: string): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<B2bNavComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<B2bNavComponent, "sof-nav-b2b", never, { "scrollToTopOnNavigationEndEvent": { "alias": "scrollToTopOnNavigationEndEvent"; "required": false; }; "navigationData": { "alias": "navigationData"; "required": false; }; "settings": { "alias": "settings"; "required": false; }; "advancedSettings": { "alias": "advancedSettings"; "required": false; }; "themeSettings": { "alias": "themeSettings"; "required": false; }; "languageSettings": { "alias": "languageSettings"; "required": false; }; "currentLang": { "alias": "currentLang"; "required": false; }; "logOutText": { "alias": "logOutText"; "required": false; }; }, { "isNavPanelOpenedEvent": "isNavPanelOpenedEvent"; "setLanguage$": "setLanguage$"; }, never, ["[sof-ar-nav-header]", "*"], true, never>;
+}

package/lib/navigation/models/nav.settings.d.ts

@@ -52,6 +52,8 @@ export interface NavigationSettings {
     allowNavToggle?: boolean;
     /** Whether to allow username to show up on sidenav mobile view */
     disableUsernameMobile?: boolean;
+    /** The navigation version */
+    version?: 'v1' | 'v2';
 }
 /** The Advanced Settings */
 export interface NavigationAdvancedSettings {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softheon/armature",
-  "version": "17.26.0",
+  "version": "17.26.2",
   "dependencies": {
     "tslib": "^2.5.0"
   },

package/public-api.d.ts

@@ -47,3 +47,9 @@ export * from './lib/component-save-print/sof-ar-component-save-print.module';
 export * from './lib/component-save-print/components/component-save-print/component-save-print.component';
 export * from './lib/component-save-print/services/component-save-print.service';
 export * from './lib/rbac/services/tokens';
+export * from './lib/mfe/mfe.module';
+export * from './lib/mfe/services/entity-helper.service';
+export * from './lib/mfe/components/entity-base/entity-base.component';
+export * from './lib/mfe/models/entity-config-base';
+export * from './lib/mfe/models/entity-dto';
+export * from './lib/navigation/components/b2b-nav/b2b-nav.component';