@arsedizioni/ars-utils 22.0.37 → 22.0.39

package/package.json

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

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

@@ -1458,6 +1458,112 @@ declare class ClipperCollaborationService {
     static ɵprov: i0.ɵɵInjectableDeclaration<ClipperCollaborationService>;
 }
 
+/**
+ * Shared state and bootstrap for the Clipper application.
+ *
+ * Holds every piece of state used by more than one feature service (service URI,
+ * flags, login context, teams, dashboard, working-documents bag, channels and the
+ * various UI signals) plus the low-level helpers that mutate that state.
+ *
+ * The feature services (`ClipperLoginService`, `ClipperDocumentsService`, ...) inject
+ * this service to read shared state and call shared helpers. `ClipperService` (the
+ * barrel/facade) re-exports the state declared here.
+ */
+declare class ClipperCoreService {
+    private readonly httpClient;
+    private readonly destroyRef;
+    private readonly broadcastService;
+    /** Used to lazily resolve feature services inside `initialize`, avoiding circular DI. */
+    private readonly injector;
+    private broadcastInitialized;
+    private _appUri?;
+    /** @returns The URI of the Clipper web application, or `undefined` if not set. */
+    get appUri(): string | undefined;
+    private _serviceUri;
+    /** @returns The base URI of the Clipper REST API. */
+    get serviceUri(): string;
+    private _flags;
+    /** @returns The active feature flags. */
+    get flags(): ClipperServiceFlags;
+    private _loginInfo?;
+    /**
+     * Lazily loads the login context from `localStorage` on first access.
+     * @returns The current login context, or `undefined` if not authenticated.
+     */
+    get loginInfo(): ClipperLoginInfo | undefined;
+    private readonly _loggedIn;
+    readonly loggedIn: Signal<boolean>;
+    readonly loggingIn: i0.WritableSignal<boolean>;
+    readonly snapshot: i0.WritableSignal<ClipperSearchResult>;
+    readonly supportsRS: i0.WritableSignal<boolean>;
+    readonly referencesSnapshot: i0.WritableSignal<ClipperSearchResult>;
+    readonly dashboard: ClipperDashboard;
+    readonly bag: i0.WritableSignal<ClipperDocumentInfo[]>;
+    readonly bagTotal: Signal<number>;
+    readonly visible: i0.WritableSignal<boolean>;
+    private _teams;
+    /** @returns The shared teams collection. */
+    get teams(): NameValueItem<string>[];
+    readonly availableChannels: i0.WritableSignal<ClipperAvailableChannel[]>;
+    readonly activeChannels: Signal<ClipperAvailableChannel[]>;
+    readonly allowTags: i0.WritableSignal<boolean>;
+    readonly pendingNotes: i0.WritableSignal<number>;
+    /**
+     * Ensures a login-info object exists and returns it for further mutation.
+     * Replaces the inline `if (!this._loginInfo) { ... }` guards now that the field
+     * is private to this service.
+     * @returns The existing login-info object, or a freshly created empty one.
+     */
+    ensureLoginInfo(): ClipperLoginInfo;
+    /**
+     * Sets the logged-in state. The backing signal is read-only to consumers, so the
+     * feature services use this method instead.
+     * @param value - The new logged-in state.
+     */
+    setLoggedIn(value: boolean): void;
+    /**
+     * Replaces the shared teams collection (populated by the calendar, archive and
+     * collaboration queries).
+     * @param teams - The teams to store.
+     */
+    setTeams(teams: NameValueItem<string>[]): void;
+    /**
+     * Persists the current login context to `localStorage`.
+     */
+    storeContext(): void;
+    /**
+     * Updates the stored login context with the values from a fresh login result.
+     * @param result - The login result containing the new user context and channel settings.
+     */
+    updateContext(result: ClipperLoginResult): void;
+    /**
+     * Rebuilds the `availableChannels` signal from the current login context.
+     */
+    initializeChannels(): void;
+    /**
+     * Resets the login state, clears the stored login info, and broadcasts `LOGOUT_COMPLETED`.
+     */
+    reset(): void;
+    /**
+     * Clears all session-storage authentication keys and resets the login state.
+     * @param clearOAuthToken - When `true`, the OAuth bearer token is also removed.
+     */
+    clear(clearOAuthToken?: boolean): void;
+    /**
+     * Initialises the service with the API base URI, optional app URI, and feature flags.
+     * @param serviceUri - The base URI of the Clipper REST API.
+     * @param appUri - Optional URI of the Clipper web application (used to build document links).
+     * @param flags - Feature flags that control service behaviour. Defaults to `ClipperServiceFlags.None`.
+     */
+    initialize(serviceUri: string, appUri?: string, flags?: ClipperServiceFlags): void;
+    /**
+     * Ping
+     */
+    ping(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ClipperCoreService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ClipperCoreService>;
+}
+
 /**
  * Document search, references, export and metadata, plus the dashboard counters,
  * taxonomy/topics/tags lookups, the working-documents "bag" and saved searches.
@@ -1683,11 +1789,6 @@ declare class ClipperLoginService {
      * @returns An observable that completes once the logout request has been processed.
      */
     logout(forget?: boolean): rxjs.Observable<any>;
-    /**
-     * Clears all session-storage authentication keys and resets the login state.
-     * @param clearOAuthToken - When `true`, the OAuth bearer token is also removed.
-     */
-    clear(clearOAuthToken?: boolean): void;
     /**
      * Requests a new one-time password for the given repository.
      * @param id - The repository ID for which the OTP should be generated.
@@ -1707,7 +1808,6 @@ declare class ClipperLoginService {
  * `clipper.calendar.queryCalendar(...)`.
  */
 declare class ClipperService {
-    private readonly core;
     /** Authentication: login/logout, MFA, OTP. */
     readonly session: ClipperLoginService;
     /** Document search, references, export, working-documents bag and saved searches. */
@@ -1716,6 +1816,8 @@ declare class ClipperService {
     readonly account: ClipperAccountService;
     /** Archive folders and files. */
     readonly archive: ClipperArchiveService;
+    /** Core services and shared state. */
+    readonly core: ClipperCoreService;
     /** Calendar deadlines. */
     readonly calendar: ClipperCalendarService;
     /** Teams, contacts and shared notes. */
@@ -1771,5 +1873,5 @@ declare class ClipperService {
     static ɵprov: i0.ɵɵInjectableDeclaration<ClipperService>;
 }
 
-export { ClipperAccountService, ClipperArchiveCopyMode, ClipperArchiveFileStorageType, ClipperArchiveFileStorageTypes, ClipperArchiveFileType, ClipperArchiveFileTypes, ClipperArchiveFilesSearchParams, ClipperArchiveFoldersSearchParams, ClipperArchiveService, ClipperAuthInterceptor, ClipperAuthors, ClipperCalendarCopyMode, ClipperCalendarSearchParams, ClipperCalendarService, ClipperCalendarState, ClipperCalendarStates, ClipperChannel, ClipperChannelSettings, ClipperChannels, ClipperCollaborationService, ClipperDashboard, ClipperDocumentChangeReasons, ClipperDocumentContainer, ClipperDocumentsService, ClipperExportDocumentsFormat, ClipperFacet, ClipperLoginService, ClipperMessages, ClipperModel, ClipperModels, ClipperModule, ClipperModuleGroup, ClipperModuleGroups, ClipperModules, ClipperQueryDocumentFlags, ClipperQueryReferencesMode, ClipperRecurrenceType, ClipperRecurrenceTypes, ClipperRegions, ClipperSearchCalendarSnapshotResult, ClipperSearchFacetsSnapshot, ClipperSearchParams, ClipperSearchResult, ClipperSearchUtils, ClipperSectorTypes, ClipperSectors, ClipperSelectionMode, ClipperService, ClipperServiceFlags, ClipperSort, ClipperSources, ClipperTeamInfo, ClipperTeamProduct, ClipperTeamProductPermission, ClipperUpdateChannelsStateParams, ClipperUtils, NotesColors };
+export { ClipperAccountService, ClipperArchiveCopyMode, ClipperArchiveFileStorageType, ClipperArchiveFileStorageTypes, ClipperArchiveFileType, ClipperArchiveFileTypes, ClipperArchiveFilesSearchParams, ClipperArchiveFoldersSearchParams, ClipperArchiveService, ClipperAuthInterceptor, ClipperAuthors, ClipperCalendarCopyMode, ClipperCalendarSearchParams, ClipperCalendarService, ClipperCalendarState, ClipperCalendarStates, ClipperChannel, ClipperChannelSettings, ClipperChannels, ClipperCollaborationService, ClipperCoreService, ClipperDashboard, ClipperDocumentChangeReasons, ClipperDocumentContainer, ClipperDocumentsService, ClipperExportDocumentsFormat, ClipperFacet, ClipperLoginService, ClipperMessages, ClipperModel, ClipperModels, ClipperModule, ClipperModuleGroup, ClipperModuleGroups, ClipperModules, ClipperQueryDocumentFlags, ClipperQueryReferencesMode, ClipperRecurrenceType, ClipperRecurrenceTypes, ClipperRegions, ClipperSearchCalendarSnapshotResult, ClipperSearchFacetsSnapshot, ClipperSearchParams, ClipperSearchResult, ClipperSearchUtils, ClipperSectorTypes, ClipperSectors, ClipperSelectionMode, ClipperService, ClipperServiceFlags, ClipperSort, ClipperSources, ClipperTeamInfo, ClipperTeamProduct, ClipperTeamProductPermission, ClipperUpdateChannelsStateParams, ClipperUtils, NotesColors };
 export type { ClipperArchiveFileInfo, ClipperArchiveFilesCopyParams, ClipperArchiveFilesDeleteParams, ClipperArchiveFilesSearchResult, ClipperArchiveFolderTree, ClipperArchiveFoldersImportParams, ClipperArchiveFoldersSearchResult, ClipperArsEventInfo, ClipperAvailableChannel, ClipperCalendarCopyDeadlinesParams, ClipperCalendarSaveDeadlineParams, ClipperCalendarSearchResult, ClipperChannelSettingsItem, ClipperContactInfo, ClipperContactsSearchParams, ClipperDashboardItem, ClipperDashboardModelItem, ClipperDashboardResult, ClipperDayGroup, ClipperDayItem, ClipperDeadlineInfo, ClipperDeleteWorkingDocumentsParams, ClipperDocumentAnchorInfo, ClipperDocumentInfo, ClipperDocumentNote, ClipperDocumentNoteTracking, ClipperDocumentRelevantChunkHit, ClipperDocumentRelevants, ClipperDocumentStructure, ClipperDocumentUpdateStateParams, ClipperExportDocumentsParams, ClipperLastDaysResult, ClipperLoginInfo, ClipperLoginResult, ClipperNotesSearchParams, ClipperNotesSearchResult, ClipperNotifyDocumentNoteParams, ClipperOTPInfo, ClipperReferencesSearchParams, ClipperSearchArsEventsParams, ClipperSearchArsEventsResult, ClipperSearchCalendarSnapshotMonth, ClipperSearchFacet, ClipperSearchFacetGroup, ClipperSearchFacetsResult, ClipperSearchFilter, ClipperSendDocumentsByEmailParams, ClipperSettingsInfo, ClipperTaxonomyParams, ClipperTeamMemberInfo, ClipperTeamMembersSearchResult, ClipperTeamProductInfo, ClipperTeamsSearchParams, ClipperTeamsSearchResult, ClipperTopicInfo, ClipperUserChannelInfo, ClipperUserInfo, ClipperUserLink, ClipperUserSearch, ClipperUserTrialInfo, ClipperUserWorkingDocument, EditDialogCompleted, EditDialogData, EditedEventArgs, SectorInfo };