@yuuvis/client-framework 3.5.0 → 3.7.0

package/lib/assets/i18n/de.json

@@ -1,9 +1,9 @@
 {
-  "yuv.pwa.update.title": "Update verfügbar",
+  "yuv.pwa.update.cancel": "Später",
+  "yuv.pwa.update.confirm": "Neu laden",
   "yuv.pwa.update.message": "Eine neue Version der Anwendung ist verfügbar. Jetzt neu laden, um zu aktualisieren?",
+  "yuv.pwa.update.title": "Update verfügbar",
   "yuv.pwa.update.unrecoverable.message": "Die Anwendung muss neu geladen werden, um fortzufahren.",
-  "yuv.pwa.update.confirm": "Neu laden",
-  "yuv.pwa.update.cancel": "Später",
   "yuv.session.expires.message": "Ihre Sitzung läuft in einer Minute ab.",
   "yuv.session.extend.action": "Sitzung verlängern",
   "yuv.action-menu.action.copy.dms.object.description": "",
@@ -11,7 +11,7 @@
   "yuv.action-menu.action.cut.dms.object.description": "",
   "yuv.action-menu.action.cut.dms.object.label": "Ausschneiden",
   "yuv.action-menu.action.delete.dms.object.confirm.cancel": "Abbrechen",
-  "yuv.action-menu.action.delete.dms.object.confirm.message": "Möchten Sie die ausgewählen Objekte wirklich löschen? Dieser Vorgang kann nicht rückgängig gemacht werden.",
+  "yuv.action-menu.action.delete.dms.object.confirm.message": "Möchten Sie die ausgewählten Objekte wirklich löschen? Dieser Vorgang kann nicht rückgängig gemacht werden.",
   "yuv.action-menu.action.delete.dms.object.confirm.ok": "Löschen",
   "yuv.action-menu.action.delete.dms.object.description": "Löscht das Objekt.",
   "yuv.action-menu.action.delete.dms.object.label": "Löschen",
@@ -83,7 +83,7 @@
   "yuv.audit.label.get.metadata": "Metadaten wurden gelesen",
   "yuv.audit.label.get.rendition.pdf": "PDF-Rendition wurde angefordert",
   "yuv.audit.label.get.rendition.text": "Text-Rendition wurde angefordert",
-  "yuv.audit.label.get.rendition.thumbnail": "Minituransicht wurde angefordert",
+  "yuv.audit.label.get.rendition.thumbnail": "Miniaturansicht wurde angefordert",
   "yuv.audit.label.paging": "Seitennavigation",
   "yuv.audit.label.paging.current": "Seite {{page}}",
   "yuv.audit.label.paging.next": "zur nächsten Seite",

package/lib/assets/i18n/en.json

@@ -1,9 +1,9 @@
 {
-  "yuv.pwa.update.title": "Update available",
+  "yuv.pwa.update.cancel": "Later",
+  "yuv.pwa.update.confirm": "Reload",
   "yuv.pwa.update.message": "A new version of the application is available. Reload now to update?",
+  "yuv.pwa.update.title": "Update available",
   "yuv.pwa.update.unrecoverable.message": "The application needs to be reloaded to continue.",
-  "yuv.pwa.update.confirm": "Reload",
-  "yuv.pwa.update.cancel": "Later",
   "yuv.session.expires.message": "Your session will expire in one minute.",
   "yuv.session.extend.action": "Extend session",
   "yuv.action-menu.action.copy.dms.object.description": "",
@@ -25,7 +25,7 @@
   "yuv.badge.empty.selection": "No badges currently available for selection.",
   "yuv.badge.lock.description": "This object is locked and cannot be modified.",
   "yuv.badge.lock.label": "Locked",
-  "yuv.badge.lock.self.description": "The object is locked by you.",
+  "yuv.badge.lock.self.description": "This object is locked by you.",
   "yuv.badge.lock.self.label": "Locked by you",
   "yuv.badge.retention.description": "This object is subject to a retention period.",
   "yuv.badge.retention.label": "Retention",
@@ -171,7 +171,7 @@
   "yuv.tile-config.slot.action.headline": "Actions",
   "yuv.tile-config.slot.badges.headline": "Badges",
   "yuv.tile-config.slot.icon.headline": "Icon",
-  "yuv.tile-config.slot.property.headline": "Attributes",
+  "yuv.tile-config.slot.property.headline": "Attribute",
   "yuv.tile-config.title": "Hit list configuration for {{bucket}}",
   "yuv.tile-config.trigger.tooltip": "Hit list configuration",
   "yuv.tile-list.item.actions-menu.button.tooltip": "Open actions menu",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuuvis/client-framework",
-  "version": "3.5.0",
+  "version": "3.7.0",
   "author": "OPTIMAL SYSTEMS GmbH <npm@optimal-systems.de>",
   "license": "MIT",
   "peerDependencies": {
@@ -8,16 +8,16 @@
     "@angular/common": "^21.2.9",
     "@angular/core": "^21.2.9",
     "angular-gridster2": "^21.0.1",
-    "@yuuvis/client-core": "^3.5.0",
-    "@yuuvis/client-shell-core": "^3.5.0",
-    "@yuuvis/client-components": "^3.5.0",
+    "@yuuvis/client-core": "^3.7.0",
+    "@yuuvis/client-shell-core": "^3.7.0",
+    "@yuuvis/client-components": "^3.7.0",
     "ng-dynamic-component": "^10.8.2",
     "modern-normalize": "^3.0.1"
   },
   "dependencies": {
     "@angular/material": "^21.2.7",
     "@ngrx/signals": "^21.1.0",
-    "@yuuvis/material": "^3.5.0",
+    "@yuuvis/material": "^3.7.0",
     "@yuuvis/media-viewer": "^3.0.2",
     "angular-split": "^20.0.0",
     "vis-network": "^10.0.2",

package/renderer/README.md

@@ -1,5 +1,215 @@
 # @yuuvis/client-framework/renderer
 
-Secondary entry point of `@yuuvis/client-framework`. It can be used by importing from `@yuuvis/client-framework/renderer`.
+Secondary entry point of `@yuuvis/client-framework`. Import everything from `@yuuvis/client-framework/renderer`.
 
-Provides default renderers for object type properties. Also comes with the `renderer.service` that allows to register custom renderers.
+Provides a pluggable rendering layer for two distinct things:
+
+1. **Property renderers** — components that render a single object-type property value (string, integer, datetime, file size, organization, table, …) inside list rows, summary panels, tile slots, smart-search results, and detail headers.
+2. **Audit renderers** — components that render the inner content of a single entry in the audit timeline (`ObjectAuditComponent`), keyed by the audit `action` (and optionally `subaction`).
+
+Both subsystems share the same shape: a service that maintains a registry, an abstract base component that consumers extend, and a directive that resolves and instantiates the right component for a given input.
+
+## Public API
+
+| Export | Kind | Purpose |
+|---|---|---|
+| `RendererService` | service (`providedIn: 'root'`) | Registry for property renderers. |
+| `RendererDirective` (`*yuvRenderer`) | structural directive | Renders a `ResolvedObjectConfigItem` using the registered renderer. |
+| `AbstractRendererComponent<T, U>` | abstract component | Base class for custom property renderers. |
+| `RendererComponent` | type | Union of the built-in property renderer components. |
+| `RendererDirectiveInput` | type alias of `ResolvedObjectConfigItem` | Input shape for `*yuvRenderer`. |
+| `AuditRendererService` | service (`providedIn: 'root'`) | Registry for audit-entry renderers. |
+| `AuditRendererDirective` (`[yuvAuditRenderer]`) | attribute directive | Renders an `AuditEntry` using the registered renderer. |
+| `AbstractAuditRendererComponent` | abstract component | Base class for custom audit renderers. |
+| `DefaultAuditRendererComponent` | component | Built-in fallback that resolves localized audit labels for all known actions (100, 200, 300, 400, custom 10000). |
+| Built-in property renderers | components | `StringRendererComponent`, `IntegerRendererComponent`, `DecimalRendererComponent`, `BooleanRendererComponent`, `DateTimeRendererComponent`, `FileSizeRendererComponent`, `IconRendererComponent`, `OrganizationRendererComponent`, `TableRendererComponent`, `UnknownRendererComponent` (fallback). |
+
+---
+
+## Property renderers
+
+### Rendering a property — `*yuvRenderer`
+
+`*yuvRenderer` takes a `ResolvedObjectConfigItem` and instantiates the matching renderer into the host view. The host owns the layout; the directive owns the value cell.
+
+```html
+@for (property of object.properties; track property.propertyName) {
+  <div class="row">
+    <div class="label">{{ property.label }}</div>
+    <div class="value">
+      <ng-container *yuvRenderer="property.value" />
+    </div>
+  </div>
+}
+```
+
+Input shape:
+
+```ts
+interface ResolvedObjectConfigItem {
+  propertyName: string;              // schema property name (e.g. 'system:contentStreamLength')
+  rendererType?: RendererType;       // optional explicit renderer key — wins over propertyName lookup
+  value?: unknown;                   // the value passed to the renderer
+  meta?: Record<string, unknown>;    // additional context (e.g. *_title for user fields)
+}
+```
+
+Resolution order inside `RendererService`:
+
+1. If `rendererType` is set → look up by that key (`getRendererByType`).
+2. Otherwise look up by `propertyName` (`getRenderer`). If not registered, fall back to the property's internal field type derived from `SystemService`.
+3. If nothing matches → `UnknownRendererComponent`.
+
+The directive re-renders only when the input object actually changes (deep equality via `JSON.stringify`).
+
+### Built-in registrations
+
+`RendererService` ships with these defaults (in `RendererService` constructor):
+
+| Key | Component |
+|---|---|
+| `integer` | `IntegerRendererComponent` |
+| `decimal` | `DecimalRendererComponent` |
+| `datetime` | `DateTimeRendererComponent` |
+| `icon` | `IconRendererComponent` |
+| `string` | `StringRendererComponent` |
+| `boolean` | `BooleanRendererComponent` |
+| `table` | `TableRendererComponent` |
+| `InternalFieldType.STRING_ORGANIZATION` / `STRING_ORGANIZATION_SET` | `OrganizationRendererComponent` |
+| `ContentStreamField.LENGTH` | `FileSizeRendererComponent` |
+
+### Registering a custom renderer
+
+Get the service and call one of the registration methods. Either overrides the default for that key.
+
+```ts
+import { inject, Injectable } from '@angular/core';
+import { RendererService } from '@yuuvis/client-framework/renderer';
+import { MyHashRendererComponent } from './my-hash.renderer';
+
+@Injectable({ providedIn: 'root' })
+export class MyAppRendererSetup {
+  #renderers = inject(RendererService);
+
+  init(): void {
+    // Override by renderer type (matches `rendererType` on ResolvedObjectConfigItem)
+    this.#renderers.registerRendererByType('string', MyHashRendererComponent);
+
+    // Or scope to a single property — and optionally to a specific object type
+    this.#renderers.registerRenderer(MyHashRendererComponent, 'document:sha256');
+    this.#renderers.registerRenderer(MyHashRendererComponent, 'document:sha256', 'system:document');
+  }
+}
+```
+
+Call this from `APP_INITIALIZER` or any service that runs before the views using the directive are constructed. Registrations are stored in a signal, so consumers that re-resolve their renderer will pick up changes; however the directive only re-resolves when its input changes — switching renderers at runtime requires re-pushing the input.
+
+### Writing a custom property renderer
+
+Extend `AbstractRendererComponent<T, U>`. `T` is the value type, `U` is the meta-shape (defaults to `null`).
+
+```ts
+import { ChangeDetectionStrategy, Component, computed } from '@angular/core';
+import { AbstractRendererComponent } from '@yuuvis/client-framework/renderer';
+
+@Component({
+  selector: 'app-hash-renderer',
+  standalone: true,
+  template: `<code class="hash" [title]="value()">{{ short() }}</code>`,
+  changeDetection: ChangeDetectionStrategy.OnPush
+})
+export class MyHashRendererComponent extends AbstractRendererComponent<string> {
+  protected short = computed(() => this.value()?.slice(0, 12) ?? '');
+}
+```
+
+The base class exposes:
+
+- `propertyName = input.required<string>()`
+- `value = input.required<T | null>()`
+- `meta = input<Record<string, unknown> | U>()`
+- `getProperty(): SchemaResponseFieldDefinition | undefined` — schema definition for the property from `SystemService`.
+
+All renderers must be `standalone: true` and should use `ChangeDetectionStrategy.OnPush`.
+
+---
+
+## Audit renderers
+
+### Rendering an audit entry — `[yuvAuditRenderer]`
+
+`[yuvAuditRenderer]` is the attribute-directive twin for the audit timeline. The host component (`ObjectAuditComponent`) owns the date column, timeline line, version badge, and creator label; the renderer owns the *inner content* of the entry.
+
+```html
+@for (item of items(); track item.creationDate + '-' + item.action) {
+  <li class="audit">
+    <time>{{ item.creationDate | localeDate }}</time>
+    <div class="content"><ng-container [yuvAuditRenderer]="item" /></div>
+    <span class="version">v{{ item.version }}</span>
+    <div class="creator">{{ item.createdBy.title }}</div>
+  </li>
+}
+```
+
+Resolution order inside `AuditRendererService.getAuditRenderer(action, subaction)`:
+
+1. `(action, subaction)` — if `subaction` is provided and a renderer is registered for the exact pair.
+2. `(action)` — action-only registration.
+3. `DefaultAuditRendererComponent` — built-in fallback that translates the well-known audit labels (`yuv.audit.label.*`) for actions 100/200/300/400 and custom action 10000.
+
+### Registering a custom audit renderer
+
+```ts
+import { inject, Injectable } from '@angular/core';
+import { AuditRendererService } from '@yuuvis/client-framework/renderer';
+import { CreatedAuditRendererComponent } from './created-audit.renderer';
+import { UpdatedAuditRendererComponent } from './updated-audit.renderer';
+
+@Injectable({ providedIn: 'root' })
+export class MyAppAuditSetup {
+  #audit = inject(AuditRendererService);
+
+  init(): void {
+    // Override every CREATE_METADATA (action 100) entry
+    this.#audit.registerAuditRenderer(CreatedAuditRendererComponent, 100);
+
+    // Override one specific (action, subaction) pair
+    this.#audit.registerAuditRenderer(UpdatedAuditRendererComponent, 300, 42);
+  }
+}
+```
+
+### Writing a custom audit renderer
+
+Extend `AbstractAuditRendererComponent`. The directive sets one input: `auditEntry: AuditEntry`.
+
+```ts
+import { ChangeDetectionStrategy, Component } from '@angular/core';
+import { AbstractAuditRendererComponent } from '@yuuvis/client-framework/renderer';
+
+@Component({
+  selector: 'app-created-audit',
+  standalone: true,
+  template: `
+    <span class="title">📄 Document created</span>
+    <small class="meta">action {{ auditEntry().action }}</small>
+  `,
+  changeDetection: ChangeDetectionStrategy.OnPush
+})
+export class CreatedAuditRendererComponent extends AbstractAuditRendererComponent {}
+```
+
+The base class exposes:
+
+- `auditEntry = input.required<AuditEntry>()` — the full entry, including `action`, `subaction`, `detail`, `creationDate`, `createdBy`, `version`.
+
+If you want to extend (rather than replace) the default labelling, you can compose `DefaultAuditRendererComponent` inside your own template, or read `auditEntry().detail` directly — its format is action-specific (the default renderer parses `[a,b]`-style payloads for tag/restore actions).
+
+---
+
+## Conventions
+
+- Both directives, both services, and both abstract base classes are tree-shakable per sub-library — import only what you need.
+- Renderers are looked up at directive instantiation time. Registering after the view exists is fine but only affects later input changes.
+- All built-in renderers use OnPush and are standalone — follow the same in custom renderers.
+- `RendererService` integrates with `SystemService` to fall back to the property's internal field type; custom renderers do not need to replicate this — register against the field-type key (`registerRendererByType`) to opt in.

package/types/yuuvis-client-framework-object-details.d.ts

@@ -14,14 +14,9 @@ declare class ObjectAuditComponent {
         arrowNext: any;
     };
     auditsRes: _angular_core.WritableSignal<AuditQueryResult | undefined>;
-    resolvedItems: _angular_core.WritableSignal<ResolvedAuditEntry[]>;
+    items: _angular_core.Signal<AuditEntry[]>;
     error: _angular_core.WritableSignal<boolean>;
     busy: _angular_core.WritableSignal<boolean>;
-    searchActions: {
-        label: string;
-        actions: string[];
-    }[];
-    auditLabels: Record<string, string>;
     dmsObject: _angular_core.InputSignal<DmsObject | undefined>;
     /**
      * A list of audits that should not be shown. Use the audit codes (like 100, 301, etc.).
@@ -42,9 +37,6 @@ declare class ObjectAuditComponent {
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ObjectAuditComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<ObjectAuditComponent, "yuv-object-audit", never, { "dmsObject": { "alias": "dmsObject"; "required": false; "isSignal": true; }; "skipActions": { "alias": "skipActions"; "required": false; "isSignal": true; }; "allActions": { "alias": "allActions"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
-interface ResolvedAuditEntry extends AuditEntry {
-    label: string;
-}
 
 interface HeaderData {
     title: RendererDirectiveInput;

package/types/yuuvis-client-framework-object-relationship.d.ts

@@ -47,7 +47,7 @@ declare class ObjectRelationshipComponent {
      * Display mode for the relationship view.
      */
     mode: _angular_core.ModelSignal<"list" | "graph">;
-    empty: _angular_core.Signal<boolean | undefined>;
+    empty: _angular_core.Signal<boolean>;
     /**
      * ID of the object to display relations for.
      */

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

@@ -1,7 +1,67 @@
 import * as i0 from '@angular/core';
-import { Type, ComponentRef } from '@angular/core';
+import { ComponentRef, Type } from '@angular/core';
+import { AuditEntry, SchemaResponseFieldDefinition, TranslateService, ResolvedObjectConfigItem, RendererType } from '@yuuvis/client-core';
 import * as dist_libs_yuuvis_client_core_types_yuuvis_client_core from 'dist/libs/yuuvis/client-core/types/yuuvis-client-core';
-import { SchemaResponseFieldDefinition, TranslateService, ResolvedObjectConfigItem, RendererType } from '@yuuvis/client-core';
+
+/**
+ * Abstract class to be extended by audit-entry renderers. The renderer controls the
+ * inner content of an audit timeline entry; the surrounding framing (date column,
+ * timeline line, version badge, creator) stays with the host component.
+ */
+declare abstract class AbstractAuditRendererComponent {
+    auditEntry: i0.InputSignal<AuditEntry>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractAuditRendererComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AbstractAuditRendererComponent, "yuv-abstract-audit-renderer", never, { "auditEntry": { "alias": "auditEntry"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+interface ResolvedAuditLabel {
+    label: string;
+    more?: string;
+}
+declare class DefaultAuditRendererComponent extends AbstractAuditRendererComponent {
+    #private;
+    protected resolved: i0.Signal<ResolvedAuditLabel>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DefaultAuditRendererComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DefaultAuditRendererComponent, "yuv-default-audit-renderer", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * Attribute directive that renders an `AuditEntry` using the component registered with
+ * `AuditRendererService` for the entry's `action` (and optionally `subaction`). Falls
+ * back to `DefaultAuditRendererComponent` when no override is registered.
+ */
+declare class AuditRendererDirective {
+    #private;
+    component: ComponentRef<AbstractAuditRendererComponent>;
+    yuvAuditRenderer: i0.InputSignal<AuditEntry>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AuditRendererDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AuditRendererDirective, "[yuvAuditRenderer]", never, { "yuvAuditRenderer": { "alias": "yuvAuditRenderer"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * Service for managing audit-entry renderers. Renderers are components that render the
+ * inner content of an audit entry in the timeline view of `ObjectAuditComponent`.
+ *
+ * Register a renderer for an `action` to override the default rendering of all audit
+ * entries with that action, or for an `action` + `subaction` pair to override a specific
+ * variant. Lookup prefers the subaction-specific renderer over the action-only renderer;
+ * if neither is registered, `DefaultAuditRendererComponent` is used.
+ */
+declare class AuditRendererService {
+    #private;
+    /**
+     * Register a renderer for a specific audit `action`. Pass `subaction` to scope the
+     * renderer to a particular (action, subaction) pair.
+     */
+    registerAuditRenderer(cmp: Type<AbstractAuditRendererComponent>, action: number, subaction?: number): void;
+    /**
+     * Resolve the renderer for an audit entry. Tries `(action, subaction)` first, falls
+     * back to `(action)`, then to `DefaultAuditRendererComponent`.
+     */
+    getAuditRenderer(action: number, subaction?: number): Type<AbstractAuditRendererComponent>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AuditRendererService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AuditRendererService>;
+}
 
 /**
  * Abstract class to be extended by property renderers
@@ -131,5 +191,5 @@ declare class RendererDirective {
     static ɵdir: i0.ɵɵDirectiveDeclaration<RendererDirective, "[yuvRenderer]", never, { "yuvRenderer": { "alias": "yuvRenderer"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-export { AbstractRendererComponent, BooleanRendererComponent, DateTimeRendererComponent, DecimalRendererComponent, FileSizeRendererComponent, IconRendererComponent, IntegerRendererComponent, OrganizationRendererComponent, RendererDirective, RendererService, StringRendererComponent, TableRendererComponent, UnknownRendererComponent };
+export { AbstractAuditRendererComponent, AbstractRendererComponent, AuditRendererDirective, AuditRendererService, BooleanRendererComponent, DateTimeRendererComponent, DecimalRendererComponent, DefaultAuditRendererComponent, FileSizeRendererComponent, IconRendererComponent, IntegerRendererComponent, OrganizationRendererComponent, RendererDirective, RendererService, StringRendererComponent, TableRendererComponent, UnknownRendererComponent };
 export type { RendererComponent, RendererDirectiveInput };