fixed requested changes, added additional missing types, changed `Gra…

…bToPan` constructor param for typescript compatibility
mozilla · Apr 10, 2024 · 25f049f · 25f049f
1 parent e850450
commit 25f049f
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 10 deletions.
diff --git a/web/annotation_editor_params.js b/web/annotation_editor_params.js
@@ -24,9 +24,9 @@ import { AnnotationEditorParamsType } from "pdfjs-lib";
  * @property {HTMLInputElement} editorInkColor
  * @property {HTMLInputElement} editorInkThickness
  * @property {HTMLInputElement} editorInkOpacity
- * @property {HTMLElement} editorStampAddImage
+ * @property {HTMLButtonElement} editorStampAddImage
  * @property {HTMLInputElement} editorFreeHighlightThickness
- * @property {HTMLElement} editorHighlightShowAll
+ * @property {HTMLButtonElement} editorHighlightShowAll
  */
 
 class AnnotationEditorParams {

diff --git a/web/app.js b/web/app.js
@@ -14,6 +14,8 @@
  */
 
 /** @typedef {import("./interfaces.js").IL10n} IL10n */
+/** @typedef {import("../src/display/api.js").PDFDocumentProxy} PDFDocumentProxy */
+/** @typedef {import("../src/display/api.js").PDFDocumentLoadingTask} PDFDocumentLoadingTask */
 
 import {
   animationStarted,
@@ -98,7 +100,9 @@ const PDFViewerApplication = {
     settled: false,
   },
   appConfig: null,
+  /** @type {PDFDocumentProxy} */
   pdfDocument: null,
+  /** @type {PDFDocumentLoadingTask} */
   pdfLoadingTask: null,
   printService: null,
   /** @type {PDFViewer} */

diff --git a/web/external_services.js b/web/external_services.js
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-/** @typedef {import("./l10n.js").L10n} L10n */
+/** @typedef {import("./interfaces.js").IL10n} IL10n */
 
 class BaseExternalServices {
   constructor() {
@@ -31,7 +31,7 @@ class BaseExternalServices {
   reportTelemetry(data) {}
 
   /**
-   * @returns {Promise<L10n>}
+   * @returns {Promise<IL10n>}
    */
   async createL10n() {
     throw new Error("Not implemented: createL10n");

diff --git a/web/grab_to_pan.js b/web/grab_to_pan.js
@@ -20,7 +20,7 @@ const CSS_CLASS_GRAB = "grab-to-pan-grab";
 class GrabToPan {
   /**
    * Construct a GrabToPan instance for a given HTML element.
-   * @param {Element} options.element
+   * @param {{element: Element}}
    */
   constructor({ element }) {
     this.element = element;

diff --git a/web/password_prompt.js b/web/password_prompt.js
@@ -13,6 +13,8 @@
  * limitations under the License.
  */
 
+/** @typedef {import("./overlay_manager.js").OverlayManager} OverlayManager */
+
 import { PasswordResponses } from "pdfjs-lib";
 
 /**

diff --git a/web/pdf_attachment_viewer.js b/web/pdf_attachment_viewer.js
@@ -31,7 +31,7 @@ import { waitOnEventOrTimeout } from "./event_utils.js";
 /**
  * @typedef {Object} PDFAttachmentViewerRenderParameters
  * @property {Object|null} attachments - A lookup table of attachment objects.
- * @property {boolean} keepRenderedCapability
+ * @property {boolean} [keepRenderedCapability]
  */
 
 class PDFAttachmentViewer extends BaseTreeViewer {

diff --git a/web/pdf_layer_viewer.js b/web/pdf_layer_viewer.js
@@ -16,7 +16,7 @@
 /** @typedef {import("./event_utils.js").EventBus} EventBus */
 // eslint-disable-next-line max-len
 /** @typedef {import("../src/optional_content_config.js").OptionalContentConfig} OptionalContentConfig */
-/** @typedef {import("../src/document.js").PDFDocument} PDFDocument */
+/** @typedef {import("../src/display/api.js").PDFDocumentProxy} PDFDocumentProxy */
 
 import { BaseTreeViewer } from "./base_tree_viewer.js";
 
@@ -30,7 +30,7 @@ import { BaseTreeViewer } from "./base_tree_viewer.js";
  * @typedef {Object} PDFLayerViewerRenderParameters
  * @property {OptionalContentConfig|null} optionalContentConfig - An
  *   {OptionalContentConfig} instance.
- * @property {PDFDocument} pdfDocument - A {PDFDocument} instance.
+ * @property {PDFDocumentProxy} pdfDocument - A {PDFDocument} instance.
  */
 
 class PDFLayerViewer extends BaseTreeViewer {

diff --git a/web/pdf_outline_viewer.js b/web/pdf_outline_viewer.js
@@ -17,7 +17,7 @@
 // eslint-disable-next-line max-len
 /** @typedef {import("./download_manager.js").DownloadManager} DownloadManager */
 /** @typedef {import("./interfaces").IPDFLinkService} IPDFLinkService */
-/** @typedef {import("../src/document.js").PDFDocument} PDFDocument */
+/** @typedef {import("../src/display/api.js").PDFDocumentProxy} PDFDocumentProxy */
 
 import { BaseTreeViewer } from "./base_tree_viewer.js";
 import { SidebarView } from "./ui_utils.js";
@@ -33,7 +33,7 @@ import { SidebarView } from "./ui_utils.js";
 /**
  * @typedef {Object} PDFOutlineViewerRenderParameters
  * @property {Array|null} outline - An array of outline objects.
- * @property {PDFDocument} pdfDocument - A {PDFDocument} instance.
+ * @property {PDFDocumentProxy} pdfDocument - A {PDFDocument} instance.
  */
 
 class PDFOutlineViewer extends BaseTreeViewer {

diff --git a/web/pdf_print_service.js b/web/pdf_print_service.js
@@ -13,6 +13,8 @@
  * limitations under the License.
  */
 
+/** @typedef {import("./interfaces.js").IPDFPrintServiceFactory} IPDFPrintServiceFactory */
+
 import {
   AnnotationMode,
   PixelsPerInch,
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,8 @@ @@
      * limitations under the License.
      */
+    /** @typedef {import("./overlay_manager.js").OverlayManager} OverlayManager */
     import { PasswordResponses } from "pdfjs-lib";
     /**
@@ Expand Down @@