@arsedizioni/ars-utils 22.6.90 → 22.6.92

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arsedizioni/ars-utils",
-  "version": "22.6.90",
+  "version": "22.6.92",
   "author": {
     "email": "software@arsedizioni.it",
     "name": "Fabio Buscaroli, Alberto Doria"

package/types/arsedizioni-ars-utils-clipper.common.d.ts

@@ -585,6 +585,17 @@ export interface ClipperDocumentUpdateStateParams {
   documentIds: string[];
   isRead: boolean;
 }
+/**
+ * What a read-state update did on the server, document by document.
+ */
+export interface ClipperDocumentUpdateStateResult {
+  /** The documents that changed state and were written. */
+  updated: string[];
+  /** The documents older than the unread window, whose state is not kept. */
+  expired: string[];
+  /** How many documents changed state. */
+  count: number;
+}
 export interface ClipperDashboardModelItem {
   id?: ClipperModel;
   newItems: number;
@@ -839,9 +850,10 @@ export declare class ClipperDocumentsService {
   /**
    * Updates the state of one or more documents.
    * @param params - The document state update parameters.
-   * @returns An observable emitting the API result wrapping the number of updated documents.
+   * @returns An observable emitting the API result telling which documents changed state and which
+   * were too old to.
    */
-  updateState(params: ClipperDocumentUpdateStateParams): import("rxjs").Observable<ApiResult<number>>;
+  updateState(params: ClipperDocumentUpdateStateParams): import("rxjs").Observable<ApiResult<ClipperDocumentUpdateStateResult>>;
   /**
    * Exports a single document in PDF format.
    * @param id - The ID of the document to export.

package/types/arsedizioni-ars-utils-clipper.ui.d.ts

@@ -453,11 +453,23 @@ export declare class ClipperSearchResultManager extends ClipperDocumentManager {
   toggleSelection(item: ClipperDocumentInfo, e?: Event): void;
   /**
    * Sets the read state on the given item or on all currently selected items.
-   * Broadcasts a read-state-changed event and updates the unread counter.
+   *
+   * Only the documents the server reports as written change on screen and in the counters: a
+   * document older than the unread window keeps no state, and one already in the state asked for
+   * has nothing to count. Touching either would leave the counters out of step with the server.
    * @param value - The new read flag value.
    * @param item - When provided, only this item is updated; otherwise the full selection is used.
+   * @param silent - When `true`, suppresses the "too old" notice.
+   */
+  setRead(value: boolean, item?: ClipperDocumentInfo, silent?: boolean): void;
+  /**
+   * Words the notice for the documents a read-state update left alone because they are older than
+   * the unread window: a single document, the whole selection, or a part of it.
+   * @param expired - How many documents were too old.
+   * @param total - How many documents the update was asked for.
+   * @returns The message to show.
    */
-  setRead(value: boolean, item?: ClipperDocumentInfo): void;
+  private getExpiredReadStateMessage;
   /**
    * Opens a document by ID, either inline or in a new browser tab.
    * @param documentId - The ID of the document to open.
@@ -956,7 +968,7 @@ export declare class ClipperBrowserDialogComponent {
   static ɵfac: i0.ɵɵFactoryDeclaration<ClipperBrowserDialogComponent, never>;
   static ɵcmp: i0.ɵɵComponentDeclaration<ClipperBrowserDialogComponent, "ng-component", never, {}, {}, never, never, true, never>;
 }
-export interface ClipperDocumentDialogData {
+interface ClipperDocumentDialogData {
   selectionMode?: ClipperSelectionMode;
   selectableModules?: ClipperModule[];
   id: string;
@@ -965,7 +977,7 @@ export interface ClipperDocumentDialogData {
   theme?: ThemeType;
   canHandleTooManyResults?: boolean;
 }
-export declare class ClipperDocumentComponent extends ClipperDocumentManager {
+declare class ClipperDocumentComponent extends ClipperDocumentManager {
   readonly relevantsPane: import("@angular/core").Signal<MatDrawer>;
   /** Reference to the document iframe element, used to drive navigation imperatively. */
   private readonly iframeRef;
@@ -1373,7 +1385,7 @@ export declare class ClipperDocumentMenuComponent {
     };
   }, {}, never, never, true, never>;
 }
-export interface ClipperReferencesDialogData {
+interface ClipperReferencesDialogData {
   mode?: ClipperQueryReferencesMode;
   anchor?: string;
   anchorTitle?: string;
@@ -1381,10 +1393,10 @@ export interface ClipperReferencesDialogData {
   model: number;
   canHandleTooManyResults?: boolean;
 }
-export interface ClipperReferenceDialogResult {
+interface ClipperReferenceDialogResult {
   documentId: string;
 }
-export declare class ClipperReferencesComponent extends ClipperSearchResultManager {
+declare class ClipperReferencesComponent extends ClipperSearchResultManager {
   readonly filterPane: import("@angular/core").Signal<MatDrawer>;
   private readonly dialogRef;
   protected readonly dialogData: ClipperReferencesDialogData;
@@ -1643,4 +1655,5 @@ export declare class ClipperSearchResultItemComponent {
   }, {
     "item": "itemChange";
   }, never, never, true, never>;
-}
+}
+export type { ClipperDocumentDialogData, ClipperReferenceDialogResult, ClipperReferencesDialogData };