web app types

tsconfig.json

@@ -16,8 +16,27 @@
       "display-node_utils": ["./src/display/node_utils"],
       "fluent-bundle": ["./node_modules/@fluent/bundle/esm/index.js"],
       "fluent-dom": ["./node_modules/@fluent/dom/esm/index.js"],
-      "web-null_l10n": ["../web/genericl10n.js"]
+
+      "web-null_l10n": ["./web/genericl10n"],
+      "web-alt_text_manager": ["./web/alt_text_manager"],
+      "web-annotation_editor_params": ["./web/annotation_editor_params"],
+      "web-pdf_attachment_viewer": ["./web/pdf_attachment_viewer"],
+      "web-pdf_cursor_tools": ["./web/pdf_cursor_tools"],
+      "web-pdf_document_properties": ["./web/pdf_document_properties"],
+      "web-pdf_find_bar": ["./web/pdf_find_bar"],
+      "web-pdf_layer_viewer": ["./web/pdf_layer_viewer"],
+      "web-pdf_outline_viewer": ["./web/pdf_outline_viewer"],
+      "web-pdf_presentation_mode": ["./web/pdf_presentation_mode"],
+      "web-pdf_sidebar": ["./web/pdf_sidebar"],
+      "web-pdf_thumbnail_viewer": ["./web/pdf_thumbnail_viewer"],
+      "web-secondary_toolbar": ["./web/secondary_toolbar"],
+      "web-toolbar": ["./web/toolbar"],
+      "web-com": ["./web/genericcom"],
+      "web-print_service": ["./web/pdf_print_service"],
+      "web-download_manager": ["./web/download_manager"],
+      "web-external_services": ["./web/genericcom"],
+      "web-preferences": ["./web/genericcom"]
     }
   },
-  "files": ["src/pdf.js", "web/pdf_viewer.component.js"]
+  "files": ["src/pdf.js", "web/pdf_viewer.component.js", "web/app.js"]
 }

web/annotation_editor_params.js

@@ -15,6 +15,20 @@
 
 import { AnnotationEditorParamsType } from "pdfjs-lib";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+
+/**
+ * @typedef {Object} AnnotationEditorParamsOptions
+ * @property {HTMLInputElement} editorFreeTextFontSize
+ * @property {HTMLInputElement} editorFreeTextColor
+ * @property {HTMLInputElement} editorInkColor
+ * @property {HTMLInputElement} editorInkThickness
+ * @property {HTMLInputElement} editorInkOpacity
+ * @property {HTMLElement} editorStampAddImage
+ * @property {HTMLInputElement} editorFreeHighlightThickness
+ * @property {HTMLElement} editorHighlightShowAll
+ */
+
 class AnnotationEditorParams {
   /**
    * @param {AnnotationEditorParamsOptions} options
@@ -25,6 +39,9 @@ class AnnotationEditorParams {
     this.#bindListeners(options);
   }
 
+  /**
+   * @param {AnnotationEditorParamsOptions} options
+   */
   #bindListeners({
     editorFreeTextFontSize,
     editorFreeTextColor,

web/app.js

@@ -80,6 +80,8 @@ import { SecondaryToolbar } from "web-secondary_toolbar";
 import { Toolbar } from "web-toolbar";
 import { ViewHistory } from "./view_history.js";
 
+/** @typedef {import("./interfaces.js").IL10n} IL10n */
+
 const FORCE_PAGES_LOADED_TIMEOUT = 10000; // ms
 const WHEEL_ZOOM_DISABLED_TIMEOUT = 1000; // ms
 

web/base_tree_viewer.js

@@ -43,14 +43,14 @@ class BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _dispatchEvent(count) {
     throw new Error("Not implemented: _dispatchEvent");
   }
 
   /**
-   * @private
+   * @protected
    */
   _bindLink(element, params) {
     throw new Error("Not implemented: _bindLink");
@@ -71,7 +71,9 @@ class BaseTreeViewer {
   /**
    * Prepend a button before a tree item which allows the user to collapse or
    * expand all tree items at that level; see `_toggleTreeItem`.
-   * @private
+   * @protected
+   * @param {Element} div
+   * @param {any} [hidden=false]
    */
   _addToggleButton(div, hidden = false) {
     const toggler = document.createElement("div");

web/external_services.js

@@ -13,6 +13,8 @@
  * limitations under the License.
  */
 
+/** @typedef {import("./l10n.js").L10n} L10n */
+
 class BaseExternalServices {
   constructor() {
     if (this.constructor === BaseExternalServices) {
@@ -28,6 +30,9 @@ class BaseExternalServices {
 
   reportTelemetry(data) {}
 
+  /**
+   * @returns {Promise<L10n>}
+   */
   async createL10n() {
     throw new Error("Not implemented: createL10n");
   }

web/pdf_attachment_viewer.js

@@ -17,6 +17,9 @@ import { BaseTreeViewer } from "./base_tree_viewer.js";
 import { getFilenameFromUrl } from "pdfjs-lib";
 import { waitOnEventOrTimeout } from "./event_utils.js";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+/** @typedef {import("./download_manager.js").DownloadManager} DownloadManager */
+
 /**
  * @typedef {Object} PDFAttachmentViewerOptions
  * @property {HTMLDivElement} container - The viewer element.
@@ -27,6 +30,7 @@ import { waitOnEventOrTimeout } from "./event_utils.js";
 /**
  * @typedef {Object} PDFAttachmentViewerRenderParameters
  * @property {Object|null} attachments - A lookup table of attachment objects.
+ * @property {boolean} keepRenderedCapability
  */
 
 class PDFAttachmentViewer extends BaseTreeViewer {
@@ -56,7 +60,7 @@ class PDFAttachmentViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   async _dispatchEvent(attachmentsCount) {
     this._renderedCapability.resolve();
@@ -87,7 +91,7 @@ class PDFAttachmentViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _bindLink(element, { content, filename }) {
     element.onclick = () => {

web/pdf_cursor_tools.js

@@ -17,6 +17,8 @@ import { AnnotationEditorType, shadow } from "pdfjs-lib";
 import { CursorTool, PresentationModeState } from "./ui_utils.js";
 import { GrabToPan } from "./grab_to_pan.js";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+
 /**
  * @typedef {Object} PDFCursorToolsOptions
  * @property {HTMLDivElement} container - The document container.

web/pdf_document_properties.js

@@ -16,6 +16,11 @@
 import { getPageSizeInches, isPortraitOrientation } from "./ui_utils.js";
 import { PDFDateString } from "pdfjs-lib";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+/** @typedef {import("./interfaces.js").IL10n} IL10n */
+/** @typedef {import("./overlay_manager.js").OverlayManager} OverlayManager */
+/** @typedef {import("../src/display/api").PDFDocumentProxy} PDFDocumentProxy */
+
 const DEFAULT_FIELD_CONTENT = "-";
 
 // See https://en.wikibooks.org/wiki/Lentis/Conversion_to_the_Metric_Standard_in_the_United_States

web/pdf_layer_viewer.js

@@ -15,6 +15,10 @@
 
 import { BaseTreeViewer } from "./base_tree_viewer.js";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+/** @typedef {import("../src/optional_content_config.js").OptionalContentConfig} OptionalContentConfig */
+/** @typedef {import("../src/document.js").PDFDocument} PDFDocument */
+
 /**
  * @typedef {Object} PDFLayerViewerOptions
  * @property {HTMLDivElement} container - The viewer element.
@@ -48,7 +52,7 @@ class PDFLayerViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _dispatchEvent(layersCount) {
     this.eventBus.dispatch("layersloaded", {
@@ -58,7 +62,7 @@ class PDFLayerViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _bindLink(element, { groupId, input }) {
     const setVisibility = () => {
@@ -97,7 +101,7 @@ class PDFLayerViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _addToggleButton(div, { name = null }) {
     super._addToggleButton(div, /* hidden = */ name === null);

web/pdf_outline_viewer.js

@@ -16,6 +16,11 @@
 import { BaseTreeViewer } from "./base_tree_viewer.js";
 import { SidebarView } from "./ui_utils.js";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+/** @typedef {import("./download_manager.js").DownloadManager} DownloadManager */
+/** @typedef {import("./interfaces").IPDFLinkService} IPDFLinkService */
+/** @typedef {import("../src/document.js").PDFDocument} PDFDocument */
+
 /**
  * @typedef {Object} PDFOutlineViewerOptions
  * @property {HTMLDivElement} container - The viewer element.
@@ -75,7 +80,7 @@ class PDFOutlineViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _dispatchEvent(outlineCount) {
     this._currentOutlineItemCapability = Promise.withResolvers();
@@ -98,7 +103,7 @@ class PDFOutlineViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _bindLink(
     element,
@@ -162,7 +167,7 @@ class PDFOutlineViewer extends BaseTreeViewer {
   }
 
   /**
-   * @private
+   * @protected
    */
   _addToggleButton(div, { count, items }) {
     let hidden = false;

web/pdf_presentation_mode.js

@@ -21,6 +21,9 @@ import {
 } from "./ui_utils.js";
 import { AnnotationEditorType } from "pdfjs-lib";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+/** @typedef {import("./pdf_viewer.js").PDFViewer} PDFViewer */
+
 const DELAY_BEFORE_HIDING_CONTROLS = 3000; // in ms
 const ACTIVE_SELECTOR = "pdfPresentationMode";
 const CONTROLS_SELECTOR = "pdfPresentationModeControls";

web/pdf_sidebar.js

@@ -26,6 +26,9 @@ const SIDEBAR_MIN_WIDTH = 200; // pixels
 const SIDEBAR_RESIZING_CLASS = "sidebarResizing";
 const UI_NOTIFICATION_CLASS = "pdfSidebarNotification";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+/** @typedef {import("./interfaces.js").IL10n} IL10n */
+
 /**
  * @typedef {Object} PDFSidebarOptions
  * @property {PDFSidebarElements} elements - The DOM elements.

web/secondary_toolbar.js

@@ -22,6 +22,8 @@ import {
 } from "./ui_utils.js";
 import { PagesCountLimit } from "./pdf_viewer.js";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+
 /**
  * @typedef {Object} SecondaryToolbarOptions
  * @property {HTMLDivElement} toolbar - Container for the secondary toolbar.

web/toolbar.js

@@ -22,6 +22,8 @@ import {
   toggleCheckedBtn,
 } from "./ui_utils.js";
 
+/** @typedef {import("./event_utils.js").EventBus} EventBus */
+
 /**
  * @typedef {Object} ToolbarOptions
  * @property {HTMLDivElement} container - Container for the secondary toolbar.