@zambon-dev/library 1.3.2 → 1.4.0

package/lib/components/sidebar-item/sidebar-item.component.d.ts

@@ -12,12 +12,15 @@ export declare class SidebarItemComponent extends BaseComponent implements OnIni
     protected isSelected: boolean;
     private _childHeight;
     private changeDetectorRef;
+    private sidebarConfigs;
     private sidebarService;
     get childHeight(): number;
     protected get areChildrenLoaded(): boolean;
+    protected get externalLinkText(): string;
     protected get isActive(): boolean;
     protected get isCollapsed(): boolean;
     protected get isParent(): boolean;
+    protected get opensInNewBrowserTab(): boolean;
     protected get hasIcon(): boolean;
     constructor();
     ngAfterViewInit(): void;

package/lib/models/sidebar/index.d.ts

@@ -1,4 +1,5 @@
 export * from './sidebar-configs';
 export * from './sidebar-menu';
+export * from './sidebar-menu-open-mode';
 export * from './sidebar-profile';
 export * from './sidebar-region';

package/lib/models/sidebar/sidebar-configs.d.ts

@@ -2,6 +2,8 @@ import { InjectionToken } from '@angular/core';
 export declare const SIDEBAR_CONFIGS: InjectionToken<SidebarConfigs>;
 export declare class SidebarConfigs {
     errorText: string;
+    /** Tooltip for items that open in a new browser tab. Rendered as-is, like {@link errorText}. */
+    externalLinkText: string;
     loadingText: string;
     logoCollapsedPath?: string;
     logoExpandedPath?: string;

package/lib/models/sidebar/sidebar-menu-open-mode.d.ts

@@ -0,0 +1,32 @@
+/**
+ * How a {@link SidebarMenu}'s `url` is opened when the item is clicked.
+ *
+ * Read the value off a menu through {@link toSidebarMenuOpenMode} rather than comparing the
+ * field directly: it crosses HTTP, so it can arrive as a string, as a number, as `null`, or not
+ * at all.
+ */
+export declare enum SidebarMenuOpenMode {
+    /** `url` is an internal Angular route and opens an application tab. The default. */
+    Internal = "internal",
+    /** `url` is an absolute http(s) address and opens in a new browser tab. */
+    ExternalNewTab = "externalNewTab",
+    /** `url` is an absolute http(s) address and opens embedded in an application tab. */
+    ExternalEmbedded = "externalEmbedded"
+}
+/**
+ * Parses the wire value of `SidebarMenu.openMode`.
+ *
+ * Deliberately a parser rather than a `?? Internal` fallback, because the field is deserialized
+ * straight from each application's menu endpoint and its shape is not guaranteed:
+ *
+ * - a **number** is read as the backend's enum ordinal, which is what an ASP.NET Core enum
+ *   property serializes to unless that backend registers a string converter;
+ * - a **string** is matched case-insensitively, so `'externalNewTab'` and `'ExternalNewTab'`
+ *   both work;
+ * - anything else — an omitted field from a backend that predates this feature, `null`, or a
+ *   mode introduced by a newer one — degrades to {@link SidebarMenuOpenMode.Internal}.
+ *
+ * Degrading to `Internal` keeps an unrecognized mode behaving the way menus behaved before
+ * external destinations existed, instead of producing an item that does nothing when clicked.
+ */
+export declare function toSidebarMenuOpenMode(value: unknown): SidebarMenuOpenMode;

package/lib/models/sidebar/sidebar-menu.d.ts

@@ -1,3 +1,4 @@
+import { SidebarMenuOpenMode } from './sidebar-menu-open-mode';
 export declare class SidebarMenu {
     childCount: number;
     children: SidebarMenu[];
@@ -6,6 +7,14 @@ export declare class SidebarMenu {
     id: number;
     label: string;
     isSelected: boolean;
+    /**
+     * How {@link url} is opened. An absent value means {@link SidebarMenuOpenMode.Internal}.
+     *
+     * Left optional and without an initializer on purpose: the constructor is an `Object.assign`,
+     * which would overwrite a default with the `null` a nullable backend column serializes to.
+     * Read it through `toSidebarMenuOpenMode(menu.openMode)` instead of comparing it directly.
+     */
+    openMode?: SidebarMenuOpenMode;
     parent: SidebarMenu | null;
     region?: string;
     url?: string;

package/lib/services/sidebar.service.d.ts

@@ -6,6 +6,7 @@ export declare abstract class SidebarService {
     childrenFailed: EventEmitter<SidebarMenu>;
     childrenLoading: EventEmitter<SidebarMenu>;
     childrenInitialized: EventEmitter<SidebarMenu>;
+    menuExternalUrlSelected: EventEmitter<SidebarMenu>;
     menuUrlSelected: EventEmitter<SidebarMenu>;
     selectionChanged: EventEmitter<SidebarMenu>;
     isActive: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zambon-dev/library",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Angular UI components and shared presentation utilities for Zambon applications.",
   "keywords": [
     "angular",