@yuuvis/client-framework 3.0.1 → 3.2.0

package/types/yuuvis-client-framework-actions.d.ts

@@ -1,10 +1,10 @@
 import * as i0 from '@angular/core';
-import { Injector, Signal, TemplateRef } from '@angular/core';
+import { TemplateRef, Injector, Signal, InjectionToken } from '@angular/core';
 import * as i1 from '@ngx-translate/core';
-import { MatIconRegistry } from '@angular/material/icon';
+import { CdkMenu, CdkMenuItem, CdkContextMenuTrigger } from '@angular/cdk/menu';
 import { DmsObject } from '@yuuvis/client-core';
 import { Observable } from 'rxjs';
-import { CdkMenu, CdkMenuItem, CdkContextMenuTrigger } from '@angular/cdk/menu';
+import { MatIconRegistry } from '@angular/material/icon';
 
 /**
  * Module for the actions library.
@@ -15,6 +15,14 @@ declare class ActionsModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<ActionsModule>;
 }
 
+declare const ACTION_ICON: {
+    download: string;
+    delete: string;
+    copy: string;
+    cut: string;
+    manageFlavor: string;
+};
+
 type ActionClass = {
     new (...args: any[]): any;
 };
@@ -120,6 +128,79 @@ declare const BASE_ACTION: {
     delete: string;
 };
 
+interface ContextMenuAction extends Action {
+    iconName?: string;
+    disabled?: boolean;
+    executeFn?: (...args: any[]) => void;
+}
+interface ContextMenuItemSelectEvent {
+    action: ContextMenuAction;
+}
+
+declare class ContextmenuComponent {
+    actions: i0.InputSignal<ContextMenuAction[]>;
+    selection: i0.InputSignal<unknown[]>;
+    itemSelect: i0.OutputEmitterRef<ContextMenuItemSelectEvent>;
+    private translate;
+    cdkMenu: i0.Signal<CdkMenu>;
+    menuItems: i0.Signal<readonly (CdkMenuItem | null)[]>;
+    sortedActions: i0.Signal<ContextMenuAction[]>;
+    constructor();
+    onItemTrigger({ action }: ContextMenuItemSelectEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ContextmenuComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ContextmenuComponent, "yuv-contextmenu", never, { "actions": { "alias": "actions"; "required": false; "isSignal": true; }; "selection": { "alias": "selection"; "required": false; "isSignal": true; }; }, { "itemSelect": "itemSelect"; }, never, never, true, never>;
+}
+
+declare class YuvContextMenuTriggerDirective extends CdkContextMenuTrigger {
+    #private;
+    menuTemplateRef: TemplateRef<unknown>;
+    triggerWhen: i0.InputSignal<boolean | null>;
+    constructor();
+    _openOnContextMenu(event: MouseEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<YuvContextMenuTriggerDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<YuvContextMenuTriggerDirective, "[yuvContextMenuTrigger]", ["yuvContextMenuTrigger"], { "menuTemplateRef": { "alias": "yuvContextMenuTrigger"; "required": false; }; "triggerWhen": { "alias": "yuvContextMenuTriggerWhen"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare const ActionPriorityLevel: {
+    readonly LEVEL_1: 1;
+    readonly LEVEL_2: 2;
+    readonly LEVEL_3: 3;
+    readonly LEVEL_4: 4;
+    readonly LEVEL_5: 5;
+    readonly LEVEL_6: 6;
+    readonly LEVEL_7: 7;
+    readonly LEVEL_8: 8;
+    readonly LEVEL_9: 9;
+    readonly LEVEL_10: 10;
+};
+
+/**
+ * Service responsible for validating actions on DMS objects.
+ * Provides checks for document lock states and related user information.
+ */
+declare class ActionsValidationService {
+    #private;
+    private readonly translate;
+    /**
+     * Checks whether a DMS object is locked by another user.
+     *
+     * Delegates lock detection to {@link ObjectLockingService.getLockState}. When the
+     * object is locked by a different user, returns `state: true` along with a
+     * translated description identifying the lock holder.
+     *
+     * @param dmsObject - The DMS object to check for a lock.
+     * @returns An observable emitting an object with:
+     *   - `state`: `true` if the object is locked by another user, `false` otherwise.
+     *   - `description`: An optional translated message describing the lock state (only present when `state` is `true`).
+     */
+    checkDocumentLock(dmsObject: DmsObject): Observable<{
+        state: boolean;
+        description?: string;
+    }>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ActionsValidationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ActionsValidationService>;
+}
+
 declare class ActionsService {
     #private;
     readonly injector: Injector;
@@ -176,34 +257,33 @@ declare class ActionsService {
      * are available for use.
      */
     registerDefaultActions(): void;
-    private _actionsSupportsType;
     static ɵfac: i0.ɵɵFactoryDeclaration<ActionsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ActionsService>;
 }
 
+declare const ACTION_CONTEXT_TOKEN: InjectionToken<ActionContext>;
+
 declare class DeleteAction extends AbstractContextAction implements Action {
     #private;
-    private translate;
-    private retention;
     id: string;
     label: any;
     description: any;
-    priority: number;
+    priority: 8;
     icon: string;
     group: string;
     range: SelectionRange;
     supports: ActionSupport;
+    isDisabled(items: DmsObject[]): Observable<boolean>;
     isExecutable(items: DmsObject[]): Observable<boolean>;
     run(items: DmsObject[]): Observable<boolean>;
 }
 
 declare class DownloadAction extends AbstractContextAction implements Action {
-    private translate;
-    private dmsService;
+    #private;
     id: string;
     label: any;
     description: any;
-    priority: number;
+    priority: 2;
     icon: string;
     group: string;
     range: SelectionRange;
@@ -212,46 +292,5 @@ declare class DownloadAction extends AbstractContextAction implements Action {
     run(selection: DmsObject[]): Observable<boolean>;
 }
 
-declare const ACTION_ICON: {
-    download: string;
-    delete: string;
-    copy: string;
-    cut: string;
-    manageFlavor: string;
-};
-
-interface ContextMenuAction extends Action {
-    iconName?: string;
-    disabled?: boolean;
-    executeFn?: (...args: any[]) => void;
-}
-interface ContextMenuItemSelectEvent {
-    action: ContextMenuAction;
-}
-
-declare class ContextmenuComponent {
-    actions: i0.InputSignal<ContextMenuAction[]>;
-    selection: i0.InputSignal<unknown[]>;
-    itemSelect: i0.OutputEmitterRef<ContextMenuItemSelectEvent>;
-    private translate;
-    cdkMenu: i0.Signal<CdkMenu>;
-    menuItems: i0.Signal<readonly (CdkMenuItem | null)[]>;
-    sortedActions: i0.Signal<ContextMenuAction[]>;
-    constructor();
-    onItemTrigger({ action }: ContextMenuItemSelectEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ContextmenuComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ContextmenuComponent, "yuv-contextmenu", never, { "actions": { "alias": "actions"; "required": false; "isSignal": true; }; "selection": { "alias": "selection"; "required": false; "isSignal": true; }; }, { "itemSelect": "itemSelect"; }, never, never, true, never>;
-}
-
-declare class YuvContextMenuTriggerDirective extends CdkContextMenuTrigger {
-    #private;
-    menuTemplateRef: TemplateRef<unknown>;
-    triggerWhen: i0.InputSignal<boolean | null>;
-    constructor();
-    _openOnContextMenu(event: MouseEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<YuvContextMenuTriggerDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<YuvContextMenuTriggerDirective, "[yuvContextMenuTrigger]", ["yuvContextMenuTrigger"], { "menuTemplateRef": { "alias": "yuvContextMenuTrigger"; "required": false; }; "triggerWhen": { "alias": "yuvContextMenuTriggerWhen"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-export { ACTION_ICON, AbstractContextAction, ActionsModule, ActionsService, BASE_ACTION, ContextmenuComponent, DeleteAction, DownloadAction, SelectionRange, YuvContextMenuTriggerDirective };
+export { ACTION_CONTEXT_TOKEN, ACTION_ICON, AbstractContextAction, ActionPriorityLevel, ActionsModule, ActionsService, ActionsValidationService, BASE_ACTION, ContextmenuComponent, DeleteAction, DownloadAction, SelectionRange, YuvContextMenuTriggerDirective };
 export type { Action, ActionClass, ActionContext, ActionOptions, ActionSupport, BaseAction, ContextMenuAction, ContextMenuItemSelectEvent };

package/types/yuuvis-client-framework-badges.d.ts

@@ -0,0 +1,194 @@
+import * as _angular_core from '@angular/core';
+import { Signal } from '@angular/core';
+import { DmsObject, YuvUser, LockState } from '@yuuvis/client-core';
+import { Severity } from '@yuuvis/material/badge';
+
+type BadgeSeverity = Severity;
+
+interface BadgeContext {
+    currentUser?: YuvUser;
+    lockState?: LockState;
+}
+interface BadgeRule {
+    field: string;
+    op: 'isSet' | 'equals' | 'tagPresent';
+    value?: unknown;
+}
+interface Badge {
+    id: string;
+    labelKey: string;
+    descriptionKey?: string;
+    icon: string;
+    svgIcon?: boolean;
+    severity?: BadgeSeverity;
+    priority?: number;
+    /**
+     * Marks this badge as a context-specific variant of another badge id.
+     * The parent badge id alone is configured (e.g. in tile-config); the
+     * registry implicitly evaluates variants whenever their parent is in
+     * the id filter. Variants are hidden from selection UIs.
+     */
+    variantOf?: string;
+    applies?: (dmsObject: DmsObject, ctx: BadgeContext) => boolean;
+    rule?: BadgeRule;
+}
+
+declare class BadgeChipComponent {
+    #private;
+    badge: _angular_core.InputSignal<Badge>;
+    showLabel: _angular_core.InputSignal<boolean>;
+    readonly tooltip: _angular_core.Signal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<BadgeChipComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<BadgeChipComponent, "yuv-badge-chip", never, { "badge": { "alias": "badge"; "required": true; "isSignal": true; }; "showLabel": { "alias": "showLabel"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class BadgeSelectComponent {
+    #private;
+    selectedBadgeIds: _angular_core.InputSignal<string[]>;
+    bucket: _angular_core.InputSignal<string | undefined>;
+    badgeSelect: _angular_core.OutputEmitterRef<Badge>;
+    readonly badges: Signal<Badge[]>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<BadgeSelectComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<BadgeSelectComponent, "yuv-tile-badge-select", never, { "selectedBadgeIds": { "alias": "selectedBadgeIds"; "required": false; "isSignal": true; }; "bucket": { "alias": "bucket"; "required": false; "isSignal": true; }; }, { "badgeSelect": "badgeSelect"; }, never, never, true, never>;
+}
+
+/**
+ * Badge shown when an object is locked by another user.
+ */
+declare const LOCK_BADGE: Badge;
+/**
+ * Badge shown when an object is locked by the current user.
+ */
+declare const LOCK_SELF_BADGE: Badge;
+
+/**
+ * Badge definition for DMS objects that are subject to a destruction retention policy.
+ *
+ * This badge is displayed when a DMS object has the `DESTRUCTION_RETENTION` secondary object type
+ * assigned and an active or ongoing retention period. It helps users identify objects that are
+ * legally or organizationally protected from deletion during their retention period.
+ *
+ * **Applies when:**
+ * - The object includes the `SystemSOT.DESTRUCTION_RETENTION` secondary object type.
+ * - A retention start date (`RetentionField.RETENTION_START`) is present.
+ * - The retention period has started (start date is in the past), or an end date is set and
+ *   still lies in the future.
+ *
+ * @remarks
+ * - `severity` is set to `'danger'` to visually emphasize the retention constraint.
+ * - `priority` is `20`, which controls the display order relative to other badges.
+ */ declare const RETENTION_BADGE: Badge;
+
+declare class BadgeRegistryService {
+    #private;
+    /**
+     * Registers one or multiple badges in the registry.
+     *
+     * If a badge with the same id already exists in the same scope, it is replaced.
+     * Otherwise, the badge is added to the scope.
+     *
+     * @param badges An array of badges to register.
+     * @param bucket Optional bucket id (typically an APP_ID). If omitted, badges are
+     *               registered globally and visible to every consumer. If provided,
+     *               badges are scoped to that bucket and only visible when consumers
+     *               query with the matching bucket.
+     *
+     * @see {@link Badge}
+     */
+    registerBadges(badges: Badge[], bucket?: string): void;
+    /**
+     * Registers the default badges into the registry.
+     *
+     * Initializes three built-in badge types:
+     * - LOCK_BADGE: Indicates objects locked by other users
+     * - LOCK_SELF_BADGE: Indicates objects locked by the current user
+     * - RETENTION_BADGE: Indicates objects under retention hold
+     *
+     * @param bucket Optional bucket id. If omitted, defaults are registered globally.
+     *
+     * @see {@link Badge}
+     */
+    registerDefaultBadges(bucket?: string): void;
+    /**
+     * Unregisters one or multiple badges from the registry by id.
+     *
+     * Operates only on the specified scope: omitting `bucket` removes from the global
+     * scope only, providing `bucket` removes from that bucket only.
+     *
+     * @param id A single badge id or an array of badge ids to remove.
+     * @param bucket Optional bucket id.
+     */
+    unregister(id: string | string[], bucket?: string): void;
+    /**
+     * Returns a registered badge by id.
+     *
+     * Looks first in the given bucket (if any), then in the global scope.
+     *
+     * @param id The badge id.
+     * @param bucket Optional bucket id.
+     * @returns The matching badge, or undefined if no badge is registered with that id.
+     */
+    get(id: string, bucket?: string): Badge | undefined;
+    /**
+     * Returns all registered badges across the global scope and every bucket.
+     *
+     * Bucket entries override globals with the same id; remaining duplicates between
+     * buckets keep the first occurrence. Useful for tests and debug inspection.
+     */
+    all(): Badge[];
+    /**
+     * Returns a reactive list of badges visible in the given scope.
+     *
+     * The returned signal recomputes whenever the registry changes. The list contains
+     * the global badges merged with the named bucket's badges (bucket entries override
+     * globals with the same id), sorted by ascending priority. At equal priority,
+     * globals come first, then bucket-local badges.
+     *
+     * @param bucket Optional bucket id.
+     */
+    getBadgesForBucket(bucket?: string): Signal<Badge[]>;
+    /**
+     * Resolves all active badges for a given object in the given scope.
+     *
+     * The visible scope is `main ∪ bucket`. Variants only resolve when their parent id
+     * is present in the visible scope. If `idFilter` is provided, only badges whose id
+     * (or whose variant's parent id) is in the filter are considered. The resulting
+     * list is sorted by ascending priority.
+     *
+     * @param dmsObject The object to evaluate badges against.
+     * @param options Optional bucket and id filter.
+     */
+    getActiveBadges(dmsObject: DmsObject, options?: {
+        bucket?: string;
+        idFilter?: string[];
+    }): Badge[];
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<BadgeRegistryService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<BadgeRegistryService>;
+}
+
+declare class TileBadgesComponent {
+    #private;
+    dmsObject: _angular_core.InputSignal<DmsObject>;
+    badgeIds: _angular_core.InputSignal<string[] | undefined>;
+    bucket: _angular_core.InputSignal<string | undefined>;
+    readonly activeBadges: _angular_core.Signal<Badge[]>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<TileBadgesComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<TileBadgesComponent, "yuv-tile-badges", never, { "dmsObject": { "alias": "dmsObject"; "required": true; "isSignal": true; }; "badgeIds": { "alias": "badgeIds"; "required": false; "isSignal": true; }; "bucket": { "alias": "bucket"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * Evaluates a single badge rule against a given DMS object.
+ *
+ * Supported operations:
+ * - `isSet`: returns `true` when the field value is not `undefined`, `null`, or an empty string.
+ * - `equals`: returns `true` when the field value strictly equals `rule.value`.
+ * - `tagPresent`: returns `true` when the configured tags field contains a tag whose first element equals `rule.value`.
+ *
+ * @param rule Badge rule definition to evaluate.
+ * @param dmsObject Source object containing field data.
+ * @returns `true` if the rule matches; otherwise `false`.
+ */
+declare function evaluateRule(rule: BadgeRule, dmsObject: DmsObject): boolean;
+
+export { BadgeChipComponent, BadgeRegistryService, BadgeSelectComponent, LOCK_BADGE, LOCK_SELF_BADGE, RETENTION_BADGE, TileBadgesComponent, evaluateRule };
+export type { Badge, BadgeContext, BadgeRule, BadgeSeverity };