@yuuvis/client-framework 3.4.2 → 3.5.0

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

@@ -1,7 +1,7 @@
 import * as _angular_core from '@angular/core';
 import { TemplateRef, OnDestroy, PipeTransform } from '@angular/core';
 import * as _yuuvis_client_core from '@yuuvis/client-core';
-import { AuditQueryResult, AuditEntry, DmsObject, AuditService, EventService, SystemService, TranslateService, VirtualObjectType, RetentionState, ObjectTypeFlavor, Situation, FlavoredDmsObject, ObjectTypeField } from '@yuuvis/client-core';
+import { AuditQueryResult, AuditEntry, DmsObject, VirtualObjectType, RetentionState, TranslateService, ObjectTypeFlavor, Situation, FlavoredDmsObject, ObjectTypeField } from '@yuuvis/client-core';
 import { RendererDirectiveInput } from '@yuuvis/client-framework/renderer';
 import { ObjectFormComponent, IObjectFormElementExtension, ObjectFormOptions, FormStatusChangedEvent } from '@yuuvis/client-framework/object-form';
 import * as i7 from '@yuuvis/client-framework/common';
@@ -9,13 +9,6 @@ import { FormGroup } from '@angular/forms';
 
 declare class ObjectAuditComponent {
     #private;
-    private auditService;
-    private eventService;
-    private system;
-    private translate;
-    private FILTER_CACHE_KEY;
-    private _objectID?;
-    private _objectTypeID?;
     icons: {
         filter: any;
         arrowNext: any;
@@ -28,7 +21,7 @@ declare class ObjectAuditComponent {
         label: string;
         actions: string[];
     }[];
-    auditLabels: any;
+    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.).
@@ -40,13 +33,12 @@ declare class ObjectAuditComponent {
      */
     allActions: _angular_core.InputSignal<boolean>;
     get objectID(): string | undefined;
-    constructor(auditService: AuditService, eventService: EventService, system: SystemService, translate: TranslateService);
+    constructor();
     /**
      * Execute a query from the search panel.
      */
     query(): void;
     goToPage(page: number): void;
-    private onError;
     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>;
 }

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

@@ -1,7 +1,7 @@
 import * as i0 from '@angular/core';
 import { Type, ComponentRef } from '@angular/core';
-import { 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 property renderers
@@ -31,6 +31,12 @@ declare class DecimalRendererComponent extends AbstractRendererComponent<number>
     static ɵcmp: i0.ɵɵComponentDeclaration<DecimalRendererComponent, "yuv-decimal-renderer", never, {}, {}, never, never, true, never>;
 }
 
+declare class FileSizeRendererComponent extends AbstractRendererComponent {
+    parsedValue: i0.Signal<number>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FileSizeRendererComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FileSizeRendererComponent, "yuv-string-renderer", never, {}, {}, never, never, true, never>;
+}
+
 declare class IconRendererComponent extends AbstractRendererComponent {
     #private;
     protected readonly customId: `${string}-${string}-${string}-${string}-${string}`;
@@ -49,7 +55,7 @@ declare class OrganizationRendererComponent extends AbstractRendererComponent {
     userAndRole: i0.WritableSignal<{
         type: string;
         label: string | undefined;
-    }[] | undefined>;
+    }[]>;
     userAndRoleLoading: i0.Signal<boolean>;
     static ɵfac: i0.ɵɵFactoryDeclaration<OrganizationRendererComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<OrganizationRendererComponent, "yuv-organization-renderer", never, {}, {}, never, never, true, never>;
@@ -70,7 +76,7 @@ declare class TableRendererComponent extends AbstractRendererComponent<any[]> {
     }[]>;
     protected tableData: i0.Signal<any[]>;
     protected reducedData: i0.Signal<boolean>;
-    protected getCellValue(row: any[], key: string): any;
+    protected getCellValue(row: any[], key: string): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<TableRendererComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TableRendererComponent, "yuv-table-renderer", never, {}, {}, never, never, true, never>;
 }
@@ -125,5 +131,5 @@ declare class RendererDirective {
     static ɵdir: i0.ɵɵDirectiveDeclaration<RendererDirective, "[yuvRenderer]", never, { "yuvRenderer": { "alias": "yuvRenderer"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-export { AbstractRendererComponent, DateTimeRendererComponent, DecimalRendererComponent, IconRendererComponent, IntegerRendererComponent, OrganizationRendererComponent, RendererDirective, RendererService, StringRendererComponent, UnknownRendererComponent };
+export { AbstractRendererComponent, BooleanRendererComponent, DateTimeRendererComponent, DecimalRendererComponent, FileSizeRendererComponent, IconRendererComponent, IntegerRendererComponent, OrganizationRendererComponent, RendererDirective, RendererService, StringRendererComponent, TableRendererComponent, UnknownRendererComponent };
 export type { RendererComponent, RendererDirectiveInput };

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

@@ -109,6 +109,22 @@ declare const defaultHaloFocusOffset = 3;
  */
 declare const haloFocusStyles: Partial<CSSStyleDeclaration>;
 
+/**
+ * Default interval (in milliseconds) for periodic PWA update checks.
+ *
+ * After the application stabilizes, {@link PwaUpdateService} polls the service
+ * worker for a newer deployed version on this interval. This complements the
+ * `VERSION_READY` event, which only fires while the tab is open and the service
+ * worker happens to detect a change — long-running sessions would otherwise
+ * never learn about a new release.
+ *
+ * Override via `providePwaUpdate({ checkInterval })`. Set `checkInterval` to `0`
+ * to disable polling and rely solely on `VERSION_READY`.
+ *
+ * @default 6 hours (21600000 milliseconds)
+ */
+declare const pwaUpdateDefaultCheckInterval: number;
+
 /**
  * Default session duration (in milliseconds) when no explicit duration is provided.
  *
@@ -303,6 +319,35 @@ interface HaloFocusConfig {
     outerColor?: string;
 }
 
+/**
+ * Configuration for the PWA update feature wired up by `providePwaUpdate()`.
+ *
+ * All label/message fields are passed through `TranslateService.instant()`, so
+ * you may supply either an i18n key or a literal string. When omitted, the
+ * built-in `yuv.pwa.update.*` keys are used.
+ */
+interface PwaUpdateConfig {
+    /**
+     * Interval (in milliseconds) for periodic update checks after the app becomes
+     * stable. Defaults to {@link pwaUpdateDefaultCheckInterval} (6 hours).
+     * Set to `0` to disable polling and rely solely on the `VERSION_READY` event.
+     */
+    checkInterval?: number;
+    /** Title shown in the update confirm dialog. @default 'yuv.pwa.update.title' */
+    title?: string;
+    /** Message shown when a new version is ready to activate. @default 'yuv.pwa.update.message' */
+    message?: string;
+    /**
+     * Message shown when the service worker enters an unrecoverable state and the
+     * page must be reloaded. @default 'yuv.pwa.update.unrecoverable.message'
+     */
+    unrecoverableMessage?: string;
+    /** Confirm button label. @default 'yuv.pwa.update.confirm' */
+    confirmLabel?: string;
+    /** Cancel button label. @default 'yuv.pwa.update.cancel' */
+    cancelLabel?: string;
+}
+
 type ChannelPayload = {
     type: ChannelMessage;
     expiresAt?: number;
@@ -389,6 +434,42 @@ interface SnackBarData {
  */
 declare function provideHaloFocus(config?: HaloFocusConfig): EnvironmentProviders;
 
+/**
+ * Provides and initializes PWA update detection for the application.
+ *
+ * On startup it boots {@link PwaUpdateService}, which watches for newly deployed
+ * versions of the app and, instead of reloading silently, asks the user to
+ * confirm before activating the update and reloading the page.
+ *
+ * **Detection:** reacts to the service worker `VERSION_READY` event and also
+ * polls `checkForUpdate()` on an interval (default 6 hours) once the app is
+ * stable, so long-running sessions still pick up new releases.
+ *
+ * **Prerequisite:** the service worker must be registered separately via
+ * `provideServiceWorker('ngsw-worker.js', { enabled: !isDevMode() })`. When the
+ * service worker is disabled (e.g. dev mode) this provider is a harmless no-op.
+ *
+ * @param config - Optional configuration (check interval, custom dialog labels/messages).
+ * @returns EnvironmentProviders for the PWA update feature.
+ *
+ * @example
+ * // app.config.ts
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideServiceWorker('ngsw-worker.js', { enabled: !isDevMode() }),
+ *     providePwaUpdate()
+ *   ]
+ * };
+ *
+ * @example
+ * // Custom check interval (1 hour) and labels
+ * providePwaUpdate({
+ *   checkInterval: 60 * 60 * 1000,
+ *   message: 'A new version is available. Reload now?'
+ * });
+ */
+declare function providePwaUpdate(config?: PwaUpdateConfig): EnvironmentProviders;
+
 /**
  * Provides and initializes the SessionService at application startup.
  *
@@ -770,6 +851,44 @@ declare class HaloUtilityService {
     static ɵprov: i0.ɵɵInjectableDeclaration<HaloUtilityService>;
 }
 
+/**
+ * Detects newly deployed versions of the application (PWA) and lets the user
+ * decide when to apply them.
+ *
+ * **Flow (per the Angular `SwUpdate` documentation):**
+ * 1. **Check** — listens for the `VERSION_READY` event and, additionally, polls
+ *    `checkForUpdate()` on an interval once the app is stable. The update is
+ *    *not* applied automatically.
+ * 2. **Ask** — when a new version is ready, prompts the user via the framework
+ *    {@link ConfirmService} dialog instead of reloading silently.
+ * 3. **Apply** — only after the user confirms, calls `activateUpdate()` and then
+ *    reloads the page so the new version takes effect.
+ *
+ * The service is a no-op when the service worker is disabled (e.g. dev mode),
+ * so it is safe to provide unconditionally.
+ *
+ * Wire it up via `providePwaUpdate()` in `app.config.ts`. The service worker
+ * itself must still be registered separately via `provideServiceWorker(...)`.
+ *
+ * @see https://angular.dev/ecosystem/service-workers/communications
+ */
+declare class PwaUpdateService {
+    #private;
+    /**
+     * Starts listening for updates. Called automatically by `providePwaUpdate()`.
+     * Does nothing when the service worker is not enabled.
+     */
+    init(config?: PwaUpdateConfig): void;
+    /**
+     * Manually triggers an update check (e.g. from a "check for updates" button).
+     * Resolves to `true` when a new version was found. Network errors are swallowed
+     * and resolve to `false`.
+     */
+    checkForUpdate(): Promise<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PwaUpdateService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PwaUpdateService>;
+}
+
 /**
  * Manages client-side session expiry: persists expiration, tracks user and HTTP activity,
  * shows a pre-expiry popup with an extend CTA, and syncs state across tabs via BroadcastChannel.
@@ -924,5 +1043,5 @@ declare class YuuvisClientFrameworkModule {
     static ɵinj: i0.ɵɵInjectorDeclaration<YuuvisClientFrameworkModule>;
 }
 
-export { ChannelMessage, HaloFocusService, HaloUtilityService, SessionService, SnackBarComponent, SnackBarService, YuuvisClientFrameworkModule, defaultHaloFocusOffset, haloExcludedElementsInMatFormField, haloFocusNavigationKeys, haloFocusStyles, provideHaloFocus, provideSession, sessionActivityWindowBeforeEnd, sessionDefaultDuration, sessionPopupBeforeEnd };
-export type { ChannelPayload, HaloFocusConfig, SnackBarData, SnackBarLevel, SnackBarMessage, SnackBarOptions };
+export { ChannelMessage, HaloFocusService, HaloUtilityService, PwaUpdateService, SessionService, SnackBarComponent, SnackBarService, YuuvisClientFrameworkModule, defaultHaloFocusOffset, haloExcludedElementsInMatFormField, haloFocusNavigationKeys, haloFocusStyles, provideHaloFocus, providePwaUpdate, provideSession, pwaUpdateDefaultCheckInterval, sessionActivityWindowBeforeEnd, sessionDefaultDuration, sessionPopupBeforeEnd };
+export type { ChannelPayload, HaloFocusConfig, PwaUpdateConfig, SnackBarData, SnackBarLevel, SnackBarMessage, SnackBarOptions };