@ngstarter-ui/components 21.0.32 → 21.0.34

package/types/ngstarter-ui-components-pdf-viewer.d.ts

@@ -0,0 +1,393 @@
+import * as _angular_core from '@angular/core';
+import { TemplateRef } from '@angular/core';
+import { Observable } from 'rxjs';
+import { PluginRegistry } from '@embedpdf/core';
+import { PdfEngine } from '@embedpdf/models';
+
+type PdfViewerSource = string | ArrayBuffer | Uint8Array | Blob | null | undefined;
+interface PdfViewerAnnotationDataSourceContext {
+    source: PdfViewerSource;
+    documentName: string | null;
+    pageCount: number;
+}
+interface PdfViewerAnnotationDataSourceParams extends PdfViewerAnnotationDataSourceContext {
+    successCallback(annotations: PdfViewerAnnotationView[]): void;
+    failCallback(error?: unknown): void;
+}
+interface PdfViewerServerAnnotationDataSource {
+    getAnnotations(params: PdfViewerAnnotationDataSourceParams): void;
+}
+type PdfViewerAnnotationDataSourceResult = PdfViewerAnnotationView[] | Promise<PdfViewerAnnotationView[]> | Observable<PdfViewerAnnotationView[]>;
+type PdfViewerAnnotationDataSource = PdfViewerAnnotationDataSourceResult | PdfViewerServerAnnotationDataSource | ((params: PdfViewerAnnotationDataSourceContext) => PdfViewerAnnotationDataSourceResult);
+type PdfViewerAnnotationWhen = string | ((annotation: PdfViewerAnnotationView, index: number) => boolean);
+interface PdfViewerAnnotationTemplateContext {
+    $implicit: PdfViewerAnnotationView;
+    annotation: PdfViewerAnnotationView;
+    index: number;
+    goToPage(pageNumber: number): void;
+}
+interface PdfViewerLoadedEvent {
+    pageCount: number;
+}
+interface PdfViewerPageRenderedEvent {
+    pageNumber: number;
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface PdfViewerPageView {
+    pageNumber: number;
+    url: string | null;
+    scale: number;
+    renderedScale: number | null;
+    width: number;
+    height: number;
+    isRendering: boolean;
+    textGlyphs: PdfViewerTextGlyphView[];
+}
+interface PdfViewerThumbnailView {
+    pageNumber: number;
+    url: string;
+    width: number;
+    height: number;
+}
+interface PdfViewerAnnotationView {
+    id?: string | number;
+    type?: string;
+    label?: string;
+    author: string;
+    time?: string;
+    avatarUrl?: string;
+    avatarLabel?: string;
+    text: string;
+    pageNumber: number;
+    replyLabel?: string;
+    [key: string]: unknown;
+}
+interface PdfViewerSearchResultView {
+    id?: string | number;
+    pageNumber: number;
+    excerpt: string;
+}
+interface PdfViewerSearchOptions {
+    caseSensitive: boolean;
+    wholeWord: boolean;
+}
+interface PdfViewerTextRectView {
+    text: string;
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+interface PdfViewerTextGlyphView {
+    index: number;
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    lineTop: number;
+    lineHeight: number;
+    lineId: number;
+}
+interface PdfViewerSelectionRectView extends PdfViewerTextRectView {
+    pageNumber: number;
+}
+
+declare class PdfViewerAnnotationDef {
+    template: TemplateRef<PdfViewerAnnotationTemplateContext>;
+    readonly annotationWhen: _angular_core.InputSignal<PdfViewerAnnotationWhen | undefined>;
+    readonly defWhen: _angular_core.InputSignal<PdfViewerAnnotationWhen | undefined>;
+    readonly when: _angular_core.InputSignal<PdfViewerAnnotationWhen | undefined>;
+    constructor(template: TemplateRef<PdfViewerAnnotationTemplateContext>);
+    matches(annotation: PdfViewerAnnotationView, index: number, typeProperty: string): boolean;
+    hasWhen(): boolean;
+    private whenValue;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<PdfViewerAnnotationDef, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<PdfViewerAnnotationDef, "[ngsPdfViewerAnnotationDef], [ngsPdfViewerAnnotation]", never, { "annotationWhen": { "alias": "ngsPdfViewerAnnotation"; "required": false; "isSignal": true; }; "defWhen": { "alias": "ngsPdfViewerAnnotationDef"; "required": false; "isSignal": true; }; "when": { "alias": "ngsPdfViewerAnnotationWhen"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+interface PdfViewerPageListItem {
+    pageNumber: number;
+    thumbnail: PdfViewerThumbnailView | null;
+}
+type PdfViewerSpreadMode = 'single' | 'two-odd' | 'two-even';
+type PdfViewerScrollLayout = 'vertical' | 'horizontal';
+type PdfViewerZoomMode = 'custom' | 'fit-page' | 'fit-width';
+declare class PdfViewer {
+    private readonly textSelectionHorizontalPadding;
+    private readonly textSelectionLineHeight;
+    private readonly document;
+    private readonly destroyRef;
+    private readonly engineService;
+    private readonly hostElement;
+    private readonly platformId;
+    private readonly isBrowser;
+    private readonly viewerBody;
+    private readonly pageList;
+    protected readonly annotationDefs: _angular_core.Signal<readonly PdfViewerAnnotationDef[]>;
+    src: _angular_core.InputSignal<PdfViewerSource>;
+    documentName: _angular_core.InputSignal<string | null>;
+    wasmUrl: _angular_core.InputSignal<string>;
+    page: _angular_core.InputSignalWithTransform<number, unknown>;
+    scale: _angular_core.InputSignalWithTransform<number, unknown>;
+    minScale: _angular_core.InputSignalWithTransform<number, unknown>;
+    maxScale: _angular_core.InputSignalWithTransform<number, unknown>;
+    zoomStep: _angular_core.InputSignalWithTransform<number, unknown>;
+    maxRenderPixels: _angular_core.InputSignalWithTransform<number, unknown>;
+    maxRenderDimension: _angular_core.InputSignalWithTransform<number, unknown>;
+    renderAll: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    showToolbar: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    showPageList: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    showSearchPanel: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    showAnnotationsPanel: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    annotations: _angular_core.InputSignal<PdfViewerAnnotationView[]>;
+    annotationsDataSource: _angular_core.InputSignal<PdfViewerAnnotationDataSource | null>;
+    annotationTypeProperty: _angular_core.InputSignal<string>;
+    searchQuery: _angular_core.InputSignal<string>;
+    withAnnotations: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    withForms: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    loaded: _angular_core.OutputEmitterRef<PdfViewerLoadedEvent>;
+    pageChanged: _angular_core.OutputEmitterRef<number>;
+    pageRendered: _angular_core.OutputEmitterRef<PdfViewerPageRenderedEvent>;
+    error: _angular_core.OutputEmitterRef<unknown>;
+    protected readonly isLoading: _angular_core.WritableSignal<boolean>;
+    protected readonly errorState: _angular_core.WritableSignal<unknown>;
+    protected readonly renderedPages: _angular_core.WritableSignal<PdfViewerPageView[]>;
+    protected readonly thumbnailPages: _angular_core.WritableSignal<PdfViewerThumbnailView[]>;
+    protected readonly pageCount: _angular_core.WritableSignal<number>;
+    protected readonly activePage: _angular_core.WritableSignal<number>;
+    protected readonly zoom: _angular_core.WritableSignal<number>;
+    protected readonly pageListVisible: _angular_core.WritableSignal<boolean>;
+    protected readonly searchPanelVisible: _angular_core.WritableSignal<boolean>;
+    protected readonly annotationsPanelVisible: _angular_core.WritableSignal<boolean>;
+    protected readonly spreadMode: _angular_core.WritableSignal<PdfViewerSpreadMode>;
+    protected readonly scrollLayout: _angular_core.WritableSignal<PdfViewerScrollLayout>;
+    protected readonly zoomMode: _angular_core.WritableSignal<PdfViewerZoomMode>;
+    protected readonly annotationItems: _angular_core.WritableSignal<PdfViewerAnnotationView[]>;
+    protected readonly activeSearchQuery: _angular_core.WritableSignal<string>;
+    protected readonly pdfSearchResults: _angular_core.WritableSignal<PdfViewerSearchResultView[]>;
+    protected readonly selectionRects: _angular_core.WritableSignal<PdfViewerSelectionRectView[]>;
+    protected readonly hasDocument: _angular_core.Signal<boolean>;
+    protected readonly isPageListVisible: _angular_core.Signal<boolean>;
+    protected readonly isSearchPanelVisible: _angular_core.Signal<boolean>;
+    protected readonly isAnnotationsPanelVisible: _angular_core.Signal<boolean>;
+    protected readonly thumbnailPageMap: _angular_core.Signal<Map<number, PdfViewerThumbnailView>>;
+    protected readonly pageItems: _angular_core.Signal<PdfViewerPageListItem[]>;
+    protected readonly canGoPrevious: _angular_core.Signal<boolean>;
+    protected readonly canGoNext: _angular_core.Signal<boolean>;
+    protected readonly canZoomOut: _angular_core.Signal<boolean>;
+    protected readonly canZoomIn: _angular_core.Signal<boolean>;
+    protected readonly zoomLabel: _angular_core.Signal<string>;
+    protected readonly displayDocumentName: _angular_core.Signal<string>;
+    protected readonly zoomPresets: number[];
+    private engine;
+    private pdfDocument;
+    private registry;
+    private pageIntersectionObserver;
+    private visiblePageRatios;
+    private loadToken;
+    private renderToken;
+    private searchToken;
+    private scrollSyncFrame;
+    private programmaticScrollTargetPage;
+    private programmaticScrollTimeout;
+    private pageObserverFrame;
+    private pageObserverTimeout;
+    private visiblePageRenderFrame;
+    private visiblePageRenderTimeout;
+    private pageObserverRefreshAttempts;
+    private selectionStart;
+    private isViewInitialized;
+    private annotationDataSourceToken;
+    private annotationDataSourceCleanup;
+    private lastZoomChangeTime;
+    private readonly programmaticScrollMinDuration;
+    private readonly programmaticScrollMaxDuration;
+    private readonly qualityRenderZoomIdleDelay;
+    constructor();
+    ngAfterViewInit(): void;
+    previousPage(): void;
+    nextPage(): void;
+    zoomIn(): void;
+    zoomOut(): void;
+    togglePageList(): void;
+    protected toggleSearchPanel(): void;
+    protected toggleAnnotationsPanel(): void;
+    protected closeAsidePanel(): void;
+    protected updatePdfSearch(event: {
+        query: string;
+        options: PdfViewerSearchOptions;
+    }): Promise<void>;
+    protected selectSearchResult(result: PdfViewerSearchResultView): void;
+    protected setZoomPreset(scale: number): void;
+    protected isZoomPresetSelected(scale: number): boolean;
+    protected fitToPage(): void;
+    protected fitToWidth(): void;
+    protected setSpreadMode(mode: PdfViewerSpreadMode): void;
+    protected setScrollLayout(layout: PdfViewerScrollLayout): void;
+    protected rotateClockwise(): void;
+    protected rotateCounterClockwise(): void;
+    protected toggleFullscreen(): void;
+    setPage(pageNumber: number): void;
+    protected onViewerScroll(): void;
+    protected onViewerWheel(event: WheelEvent): void;
+    protected selectionRectsForPage(pageNumber: number): PdfViewerSelectionRectView[];
+    protected startTextSelection(event: PointerEvent | MouseEvent, page: PdfViewerPageView): void;
+    protected updateTextSelection(event: PointerEvent | MouseEvent, page: PdfViewerPageView): void;
+    protected finishTextSelection(event: PointerEvent | MouseEvent, page: PdfViewerPageView): void;
+    private loadAnnotationsDataSource;
+    private applyAnnotationDataSourceResult;
+    private setAnnotationItems;
+    private isServerAnnotationDataSource;
+    private isPromiseLike;
+    protected cancelTextSelection(): void;
+    private searchPdf;
+    private toSearchResultView;
+    private loadDocument;
+    private initializePageShells;
+    private getPageNumbersToDisplay;
+    private scheduleVisiblePagesRender;
+    private queueVisiblePageRenderFrame;
+    private scheduleCurrentVisiblePagesRender;
+    private renderVisiblePages;
+    private setZoom;
+    private applyInstantZoom;
+    private getPriorityPageNumbers;
+    private getVisiblePageNumbers;
+    private patchRenderedPage;
+    private renderThumbnails;
+    private getPageTextGlyphs;
+    private assignTextGlyphLines;
+    private getTextLines;
+    private rangesOverlap;
+    private getCaretOffsetAtPoint;
+    private getSelectionPoint;
+    private getSelectionRects;
+    private openSource;
+    private closeDocument;
+    private revokeRenderedPages;
+    private revokeThumbnailPages;
+    private revokeObjectUrl;
+    private getSourceName;
+    private sanitizePage;
+    private sanitizeScale;
+    private roundZoom;
+    private floorFitZoom;
+    private clamp;
+    private roundCssPixel;
+    private parseCssPixel;
+    private getDevicePixelRatio;
+    private getPageRasterRenderOptions;
+    private createDocumentId;
+    private isRenderCurrent;
+    private cancelScrollSyncFrame;
+    private cancelPageObserverFrame;
+    private cancelVisiblePageRenderFrame;
+    private getCurrentTime;
+    private getQualityRenderDelay;
+    private getZoomAnchor;
+    private restoreZoomAnchor;
+    private disconnectPageObserver;
+    private schedulePageObserverRefresh;
+    private scheduleNextPageObserverRefresh;
+    private setupPageIntersectionObserver;
+    private getFitScale;
+    private getScaleBounds;
+    private sanitizeZoomStep;
+    private sanitizePositiveNumber;
+    private getPageDisplaySize;
+    private getPageBaseSize;
+    private scrollToPage;
+    private syncActivePageFromViewport;
+    private syncActivePageFromIntersections;
+    private activatePageFromScroll;
+    private findActivePageInViewport;
+    private scrollPageListToPage;
+    private getPageScrollTop;
+    private getPageScrollLeft;
+    private getElementScrollTop;
+    private getProgrammaticScrollTimeout;
+    private startProgrammaticScrollLock;
+    private isProgrammaticScrollActive;
+    private completeProgrammaticScrollIfSettled;
+    private completeProgrammaticScroll;
+    private clearProgrammaticScrollLock;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<PdfViewer, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<PdfViewer, "ngs-pdf-viewer", ["ngsPdfViewer"], { "src": { "alias": "src"; "required": false; "isSignal": true; }; "documentName": { "alias": "documentName"; "required": false; "isSignal": true; }; "wasmUrl": { "alias": "wasmUrl"; "required": false; "isSignal": true; }; "page": { "alias": "page"; "required": false; "isSignal": true; }; "scale": { "alias": "scale"; "required": false; "isSignal": true; }; "minScale": { "alias": "minScale"; "required": false; "isSignal": true; }; "maxScale": { "alias": "maxScale"; "required": false; "isSignal": true; }; "zoomStep": { "alias": "zoomStep"; "required": false; "isSignal": true; }; "maxRenderPixels": { "alias": "maxRenderPixels"; "required": false; "isSignal": true; }; "maxRenderDimension": { "alias": "maxRenderDimension"; "required": false; "isSignal": true; }; "renderAll": { "alias": "renderAll"; "required": false; "isSignal": true; }; "showToolbar": { "alias": "showToolbar"; "required": false; "isSignal": true; }; "showPageList": { "alias": "showPageList"; "required": false; "isSignal": true; }; "showSearchPanel": { "alias": "showSearchPanel"; "required": false; "isSignal": true; }; "showAnnotationsPanel": { "alias": "showAnnotationsPanel"; "required": false; "isSignal": true; }; "annotations": { "alias": "annotations"; "required": false; "isSignal": true; }; "annotationsDataSource": { "alias": "annotationsDataSource"; "required": false; "isSignal": true; }; "annotationTypeProperty": { "alias": "annotationTypeProperty"; "required": false; "isSignal": true; }; "searchQuery": { "alias": "searchQuery"; "required": false; "isSignal": true; }; "withAnnotations": { "alias": "withAnnotations"; "required": false; "isSignal": true; }; "withForms": { "alias": "withForms"; "required": false; "isSignal": true; }; }, { "loaded": "loaded"; "pageChanged": "pageChanged"; "pageRendered": "pageRendered"; "error": "error"; }, ["annotationDefs"], never, true, never>;
+}
+
+declare class PdfViewerAnnotations {
+    annotations: _angular_core.InputSignal<PdfViewerAnnotationView[]>;
+    annotationDefs: _angular_core.InputSignal<readonly PdfViewerAnnotationDef[]>;
+    annotationTypeProperty: _angular_core.InputSignal<string>;
+    closed: _angular_core.OutputEmitterRef<void>;
+    pageSelected: _angular_core.OutputEmitterRef<number>;
+    protected readonly filterQuery: _angular_core.WritableSignal<string>;
+    protected readonly filteredAnnotations: _angular_core.Signal<PdfViewerAnnotationView[]>;
+    protected setFilterQuery(event: Event): void;
+    protected clearFilterQuery(): void;
+    protected getAnnotationTemplate(annotation: PdfViewerAnnotationView, index: number): TemplateRef<PdfViewerAnnotationTemplateContext> | null;
+    protected getAnnotationTemplateContext(annotation: PdfViewerAnnotationView, index: number): PdfViewerAnnotationTemplateContext;
+    protected getAnnotationTypeLabel(annotation: PdfViewerAnnotationView): string;
+    protected getAvatarLabel(annotation: PdfViewerAnnotationView): string;
+    protected getAvatarImage(annotation: PdfViewerAnnotationView): string;
+    protected getReplyLabel(annotation: PdfViewerAnnotationView): string;
+    private annotationMatchesFilter;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<PdfViewerAnnotations, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<PdfViewerAnnotations, "ngs-pdf-viewer-annotations", never, { "annotations": { "alias": "annotations"; "required": false; "isSignal": true; }; "annotationDefs": { "alias": "annotationDefs"; "required": false; "isSignal": true; }; "annotationTypeProperty": { "alias": "annotationTypeProperty"; "required": false; "isSignal": true; }; }, { "closed": "closed"; "pageSelected": "pageSelected"; }, never, never, true, never>;
+}
+
+declare class PdfViewerEngineService {
+    private readonly engines;
+    getEngine(wasmUrl: string): Promise<PdfEngine<Blob>>;
+    createRegistry(engine: PdfEngine<Blob>, defaultScale: number): Promise<PluginRegistry>;
+    private createEngine;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<PdfViewerEngineService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<PdfViewerEngineService>;
+}
+
+interface PdfViewerSearchResultPart {
+    text: string;
+    highlight: boolean;
+}
+interface PdfViewerSearchResultGroup {
+    pageNumber: number;
+    results: Array<{
+        result: PdfViewerSearchResultView;
+        index: number;
+    }>;
+}
+declare class PdfViewerSearch {
+    results: _angular_core.InputSignal<PdfViewerSearchResultView[]>;
+    query: _angular_core.InputSignal<string>;
+    closed: _angular_core.OutputEmitterRef<void>;
+    resultSelected: _angular_core.OutputEmitterRef<PdfViewerSearchResultView>;
+    searchChanged: _angular_core.OutputEmitterRef<{
+        query: string;
+        options: PdfViewerSearchOptions;
+    }>;
+    protected readonly caseSensitive: _angular_core.WritableSignal<boolean>;
+    protected readonly wholeWord: _angular_core.WritableSignal<boolean>;
+    protected readonly activeResultIndex: _angular_core.WritableSignal<number>;
+    protected readonly queryValue: _angular_core.WritableSignal<string>;
+    protected readonly hasQuery: _angular_core.Signal<boolean>;
+    protected readonly visibleResultGroups: _angular_core.Signal<PdfViewerSearchResultGroup[]>;
+    protected readonly resultCountLabel: _angular_core.Signal<string>;
+    constructor();
+    protected setQuery(event: Event): void;
+    protected clearQuery(): void;
+    protected setCaseSensitive(value: boolean): void;
+    protected setWholeWord(value: boolean): void;
+    protected previousResult(): void;
+    protected nextResult(): void;
+    protected selectResult(result: PdfViewerSearchResultView, index: number): void;
+    protected resultParts(result: PdfViewerSearchResultView): PdfViewerSearchResultPart[];
+    private emitSearchChanged;
+    private escapeRegExp;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<PdfViewerSearch, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<PdfViewerSearch, "ngs-pdf-viewer-search", never, { "results": { "alias": "results"; "required": false; "isSignal": true; }; "query": { "alias": "query"; "required": false; "isSignal": true; }; }, { "closed": "closed"; "resultSelected": "resultSelected"; "searchChanged": "searchChanged"; }, never, never, true, never>;
+}
+
+export { PdfViewer, PdfViewerAnnotationDef, PdfViewerAnnotations, PdfViewerEngineService, PdfViewerSearch };
+export type { PdfViewerAnnotationDataSource, PdfViewerAnnotationDataSourceContext, PdfViewerAnnotationDataSourceParams, PdfViewerAnnotationDataSourceResult, PdfViewerAnnotationTemplateContext, PdfViewerAnnotationView, PdfViewerAnnotationWhen, PdfViewerLoadedEvent, PdfViewerPageRenderedEvent, PdfViewerPageView, PdfViewerSearchOptions, PdfViewerSearchResultView, PdfViewerSelectionRectView, PdfViewerServerAnnotationDataSource, PdfViewerSource, PdfViewerTextGlyphView, PdfViewerTextRectView, PdfViewerThumbnailView };