@arsedizioni/ars-utils 22.5.4 → 22.5.5

package/types/arsedizioni-ars-utils-help.d.ts

@@ -1,220 +0,0 @@
-import { Folder, ApiResult } from '@arsedizioni/ars-utils/core';
-import * as rxjs from 'rxjs';
-import { BehaviorSubject } from 'rxjs';
-import * as _angular_core from '@angular/core';
-import { OnDestroy } from '@angular/core';
-import { BreakpointObserver } from '@angular/cdk/layout';
-import { MatSidenav } from '@angular/material/sidenav';
-import { MatTree } from '@angular/material/tree';
-
-interface ChapterParentInfo {
-    id: string;
-    name: string;
-}
-interface Chapter extends Folder {
-    parents?: ChapterParentInfo[];
-}
-interface ChapterBag {
-    chapter: Chapter;
-    data: string;
-    hits: number;
-}
-interface ChapterTree extends Chapter {
-    subFolders: ChapterTree[];
-    path: string;
-}
-
-interface HelpViewerDialogData {
-    id?: string;
-}
-declare class IndexInfo {
-    id: string;
-    parent?: IndexInfo;
-    name: string;
-    itemsCount?: number;
-    children?: IndexInfo[];
-}
-declare class IndexNode extends IndexInfo {
-    expandable: boolean;
-    level: number;
-    constructor(item: IndexInfo, level: number);
-}
-declare class IndexTreeDataSource implements OnDestroy {
-    dataChange: BehaviorSubject<IndexInfo[]>;
-    get data(): IndexInfo[];
-    ngOnDestroy(): void;
-    /**
-     * Initialises the data source with a flat list of root nodes.
-     * @param data - Array of root `IndexInfo` items to display in the tree.
-     */
-    initialize(data: IndexInfo[]): void;
-    /**
-     * Recursively searches the tree for a node with the given id.
-     * @param node - The node to start from, or `null`/`undefined` to search from the root.
-     * @param id   - The id of the node to find.
-     * @returns The matching `IndexInfo`, or `undefined` if not found.
-     */
-    findNode(node: IndexInfo | undefined | null, id: string): IndexInfo | undefined;
-    /**
-     * Removes the node with the given id from the tree.
-     * @param id - The id of the node to remove.
-     */
-    removeNode(id: string): void;
-    /**
-     * Inserts a new node at the beginning of its parent's children, or at the root.
-     * @param node - The `IndexInfo` node to insert.
-     */
-    insertNode(node: IndexInfo): void;
-    /**
-     * Renames a node in the tree.
-     * @param id   - The id of the node to rename.
-     * @param name - The new display name.
-     */
-    renameNode(id: string, name: string): void;
-    /**
-     * Re-emits the current data to all subscribers, triggering a tree refresh.
-     */
-    update(): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<IndexTreeDataSource, never>;
-    static ɵprov: _angular_core.ɵɵInjectableDeclaration<IndexTreeDataSource>;
-}
-declare class HelpViewerComponent {
-    readonly indexPane: _angular_core.Signal<MatSidenav>;
-    private readonly destroyRef;
-    private readonly dialogRef;
-    protected readonly dialogData: HelpViewerDialogData;
-    private readonly dialogService;
-    private readonly helpService;
-    protected readonly breakpointObserver: BreakpointObserver;
-    protected readonly busy: _angular_core.WritableSignal<boolean>;
-    protected readonly page: _angular_core.WritableSignal<string>;
-    private indexId;
-    private indexPaneClosed;
-    protected indexNode: IndexInfo | undefined;
-    private readonly history;
-    protected readonly canGoBack: _angular_core.Signal<boolean>;
-    private tree;
-    readonly matTree: _angular_core.Signal<MatTree<IndexNode, IndexNode>>;
-    /** Provides the level of a flat node to the tree component. */
-    protected readonly levelAccessor: (node: IndexNode) => number;
-    /** Flat list of all tree nodes used as the tree data source. */
-    protected readonly flatNodes: _angular_core.WritableSignal<IndexNode[]>;
-    private folders?;
-    protected hasChild: (_: number, _node: IndexNode) => boolean;
-    constructor();
-    /**
-  * Handle filter pane visibility
-  */
-    private handleFilterPaneVisibility;
-    /**
-     * Shows or hides the index pane when the user clicks the toggle button.
-     * Also tracks the user's explicit intent so the pane is not auto-reopened.
-     */
-    protected toggleIndexPane(): void;
-    /**
-     * Closes the help viewer dialog.
-     */
-    protected close(): void;
-    /**
-     * Loads the table of contents from the help service and populates the tree.
-     */
-    protected getToc(): void;
-    /**
-     * Intercepts anchor clicks inside the help page and navigates to the referenced chapter.
-     * @param e - The click `MouseEvent` from the page content area.
-     * @returns `false` to prevent default browser navigation.
-     */
-    protected gotoChapter(e: MouseEvent): boolean;
-    /**
-     * Searches the folder list for a node matching the given id.
-     * @param id - The id of the folder to locate.
-     * @returns The matching `IndexInfo`, or `undefined` if not found.
-     */
-    private findFolder;
-    /**
-     * Expands the tree node that corresponds to the currently selected chapter,
-     * and all its ancestor nodes.
-     */
-    private expandCurrentFolder;
-    /**
-     * Recursively flattens a nested IndexInfo tree into a depth-first ordered array of IndexNodes.
-     * @param items - Root-level nodes to flatten.
-     * @param level - Current depth level.
-     */
-    private flattenNodes;
-    /**
-     * Retrieves and displays a help chapter by id.
-     * Optionally scrolls to an anchor or pixel offset after loading.
-     * @param id       - Chapter id, optionally followed by an anchor (`id#anchor`).
-     * @param position - Pixel scroll offset to restore (default `0`, meaning top).
-     */
-    protected getChapter(id: string, position?: number): void;
-    /**
-     * Scrolls the help content to a named anchor or a numeric pixel offset.
-     * @param anchor   - Named anchor (`<a name="…">`) to scroll to, if any.
-     * @param position - Fallback pixel offset (default `0`).
-     */
-    protected gotoPosition(anchor: string | undefined, position?: number): void;
-    /**
-     * Returns the current vertical scroll offset of the help content scroller.
-     * @returns The `scrollTop` value in pixels, or `0` if the element is not found.
-     */
-    protected getPosition(): number;
-    /**
-     * Scrolls the help content scroller to the specified pixel offset.
-     * @param position - The vertical pixel offset to scroll to.
-     */
-    protected setPosition(position: number): void;
-    /**
-     * Navigates back to the previous chapter in the browsing history.
-     */
-    protected back(): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<HelpViewerComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<HelpViewerComponent, "ng-component", never, {}, {}, never, never, true, never>;
-}
-
-declare class HelpService {
-    private readonly httpClient;
-    private readonly dialogService;
-    private serviceUri;
-    /**
-     * Initialises the service with the back-end base URI.
-     * Must be called once during application bootstrap before any other method.
-     * @param serviceUri - Base URL of the help service (e.g. `'https://api.example.com'`).
-     */
-    initialize(serviceUri: string): void;
-    /**
-     * Retrieves the HTML content and metadata of a help chapter.
-     * @param id    - The chapter id.
-     * @param query - Optional search query to highlight within the chapter content.
-     * @returns An observable that emits `ApiResult<ChapterBag>`.
-     */
-    getChapter(id: string, query?: string | undefined): rxjs.Observable<ApiResult<ChapterBag>>;
-    /**
-     * Retrieves metadata (title, path, etc.) for a help chapter without its content.
-     * @param id - The chapter id.
-     * @returns An observable that emits `ApiResult<Chapter>`.
-     */
-    getChapterInfo(id: string): rxjs.Observable<ApiResult<Chapter>>;
-    /**
-     * Retrieves a raw repository file by id.
-     * @param id - The repository file id.
-     * @returns An observable that emits `ApiResult<unknown>`.
-     */
-    getRepo(id: string): rxjs.Observable<ApiResult<unknown>>;
-    /**
-     * Retrieves the table of contents as a hierarchical `IndexInfo` tree.
-     * @returns An observable that emits `ApiResult<IndexInfo>`.
-     */
-    getToc(): rxjs.Observable<ApiResult<IndexInfo>>;
-    /**
-     * Opens the help viewer dialog, optionally pre-navigated to a specific chapter.
-     * @param id - The chapter id to open (default: `'1'`, the root chapter).
-     */
-    show(id?: string): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<HelpService, never>;
-    static ɵprov: _angular_core.ɵɵInjectableDeclaration<HelpService>;
-}
-
-export { HelpService, HelpViewerComponent, IndexInfo, IndexNode, IndexTreeDataSource };
-export type { Chapter, ChapterBag, ChapterParentInfo, ChapterTree, HelpViewerDialogData };

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

@@ -1,73 +0,0 @@
-import * as _angular_core from '@angular/core';
-import { MatPaginator, PageEvent } from '@angular/material/paginator';
-import { ScreenService, SelectableModel } from '@arsedizioni/ars-utils/core';
-import { SupportNotificationInfo, SupportNotificationsSearchParams } from '@arsedizioni/ars-utils/support.common';
-
-declare class SupportNotificationsBrowserComponent {
-    readonly paginator: _angular_core.Signal<MatPaginator>;
-    protected readonly screenService: ScreenService;
-    private readonly supportService;
-    private readonly broadcastService;
-    private readonly dialogService;
-    private readonly destroyRef;
-    protected selection: SelectableModel<SupportNotificationInfo, number>;
-    protected searchParams: SupportNotificationsSearchParams;
-    protected total: _angular_core.WritableSignal<number>;
-    protected items: _angular_core.WritableSignal<SupportNotificationInfo[]>;
-    constructor();
-    /**
-     * Scrolls the notifications list back to the top.
-     */
-    private updateScroll;
-    /**
-     * Resets the `isMenuOpen` flag on all items after a context menu is closed.
-     */
-    protected updateMenuButtonsVisibility(): void;
-    /**
-     * Returns the ids of the currently selected items.
-     * Shows an error and returns `undefined` when the selection exceeds 50 items.
-     * @returns An array of selected notification ids, or `undefined` on validation failure.
-     */
-    private getSelectedIds;
-    /**
-     * Returns the CSS class to apply to the read-state indicator stripe.
-     * @param item - The notification to evaluate.
-     * @returns `'unread-bg'` when the notification has not been read, otherwise `undefined`.
-     */
-    protected getItemStateCssClass(item: SupportNotificationInfo): string | undefined;
-    /**
-     * Returns the tooltip text for the read-state indicator stripe.
-     * @param item - The notification to evaluate.
-     * @returns `'Non letto'` when unread, otherwise an empty string.
-     */
-    protected getItemStateTooltip(item: SupportNotificationInfo): string;
-    /**
-     * Resets pagination to page 0 and fetches a fresh result set.
-     */
-    protected find(): void;
-    /**
-     * Fetches the current page of notifications from the server.
-     */
-    private fetch;
-    /**
-     * Handles paginator page changes and loads the corresponding result page.
-     * @param e - The `PageEvent` emitted by `MatPaginator`.
-     */
-    protected fetchMore(e: PageEvent): void;
-    /**
-     * Marks one or more notifications as read or unread.
-     * When no specific item is supplied, acts on the current selection.
-     * @param item   - A single notification to mark, or `undefined` to use the selection.
-     * @param unmark - `true` to mark as unread; `false` (default) to mark as read.
-     */
-    protected mark(item?: SupportNotificationInfo, unmark?: boolean): void;
-    /**
-     * Opens the notification detail dialog for the given item.
-     * @param item - The notification to display.
-     */
-    protected show(item: SupportNotificationInfo): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SupportNotificationsBrowserComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SupportNotificationsBrowserComponent, "ng-component", never, {}, {}, never, never, true, never>;
-}
-
-export { SupportNotificationsBrowserComponent };

package/types/arsedizioni-ars-utils-tinymce.d.ts

@@ -1,63 +0,0 @@
-import * as _angular_core from '@angular/core';
-
-declare class TinymceUtils {
-    /**
-     * Returns `true` when the user agent currently prefers a dark color scheme.
-     * Evaluated on demand (not frozen at module load) and SSR-safe.
-     */
-    private static prefersDark;
-    /** URL of the TinyMCE script hosted on the Tiny Cloud CDN. */
-    static readonly CDN_URL = "https://cdn.tiny.cloud/1/5lnoc6ohmpjau6zyzgqyhyf52cueoennkcs8v1yfoak57ku9/tinymce/7/tinymce.min.js";
-    /** URL of the locally bundled TinyMCE script. */
-    static readonly LOCAL_URL = "/assets/tinymce/tinymce.min.js";
-    /**
-     * Full-featured TinyMCE base configuration with all standard plugins and toolbar.
-     */
-    static TinymceConfig: Record<string, any>;
-    /**
-     * Compact TinyMCE configuration with autoresize, bottom toolbar, and grouped toolbar buttons.
-     * Extends `TinymceConfig` with reduced height and a simplified toolbar.
-     */
-    static TinymceCompactConfig: Record<string, any>;
-    /**
-     * Extended compact TinyMCE configuration that adds fullscreen support and an insert group.
-     * Extends `TinymceCompactConfig`.
-     */
-    static TinymceCompactExtendedConfig: Record<string, any>;
-    /**
-     * Inject the TinyMCE script tag into the document head if it is not already present.
-     * @param useCDN - When `true`, loads from the Tiny Cloud CDN; otherwise uses the local asset.
-     */
-    static loadTinyMCEScript(useCDN?: boolean): void;
-}
-
-interface FullScreenEditorDialogData {
-    text: string;
-    configuration: Record<string, any>;
-    infoButtonLabel?: string;
-    onShowInfo?: Function;
-    disabled?: boolean;
-}
-declare class FullScreenEditorComponent {
-    /** Emitted with the edited text when the user saves. */
-    readonly saving: _angular_core.OutputEmitterRef<string>;
-    private readonly dialogRef;
-    /** Dialog configuration, injected and exposed as a signal. */
-    protected readonly dialogData: _angular_core.WritableSignal<FullScreenEditorDialogData>;
-    /** Whether the editor is in read-only mode. */
-    protected readonly disabled: _angular_core.WritableSignal<boolean>;
-    /** Current editor content, kept as a plain field for [(ngModel)] two-way binding. */
-    protected text: string;
-    /** TinyMCE editor configuration. */
-    protected tinymceConfig: Record<string, any>;
-    constructor();
-    /**
-     * Save the current editor content and close the dialog.
-     */
-    protected ok(): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FullScreenEditorComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FullScreenEditorComponent, "ng-component", never, {}, { "saving": "saving"; }, never, never, true, never>;
-}
-
-export { FullScreenEditorComponent, TinymceUtils };
-export type { FullScreenEditorDialogData };