Merge pull request #13930 from michael-yx-wu/mw/fix-typings

Fix Viewer API definitions and include in CI

external/dist/legacy/web/pdf_viewer.d.ts

@@ -1 +1 @@
-export * from "pdfjs-dist/types/web/pdf_viewer.component";
+export * from "../../types/web/pdf_viewer.component";

external/dist/web/pdf_viewer.d.ts

@@ -1 +1 @@
-export * from "pdfjs-dist/types/web/pdf_viewer.component";
+export * from "../types/web/pdf_viewer.component";

test/types/main.ts

@@ -1,9 +1,12 @@
 import { getDocument } from "pdfjs-dist";
+import { EventBus } from "pdfjs-dist/web/pdf_viewer.component";
 
 class MainTest {
+  eventBus: EventBus;
   task: ReturnType<typeof getDocument> | undefined;
 
   constructor(public file: string) {
+    this.eventBus = new EventBus({});
   }
 
   loadPdf() {

test/types/tsconfig.json

@@ -17,7 +17,7 @@
     ],
     "paths": {
       "pdfjs-dist": ["../../build/typestest"],
-      "pdfjs-dist/*": ["../../build/typestest/build/*"]
+      "pdfjs-dist/*": ["../../build/typestest/types/*"]
     }
   },
   "files": [

web/annotation_layer_builder.js

@@ -13,6 +13,9 @@
  * limitations under the License.
  */
 
+// eslint-disable-next-line max-len
+/** @typedef {import("./interfaces").IPDFAnnotationLayerFactory} IPDFAnnotationLayerFactory */
+
 import { AnnotationLayer } from "pdfjs-lib";
 import { NullL10n } from "./l10n_utils.js";
 import { SimpleLinkService } from "./pdf_link_service.js";

web/base_viewer.js

@@ -139,7 +139,6 @@ function isSameScale(oldScale, newScale) {
 
 /**
  * Simple viewer control to display PDF content/pages.
- * @implements {IRenderableView}
  */
 class BaseViewer {
   /**

web/interfaces.js

@@ -106,6 +106,11 @@ class IPDFLinkService {
  * @interface
  */
 class IRenderableView {
+  constructor() {
+    /** @type {function | null} */
+    this.resume = null;
+  }
+
   /**
    * @type {string} - Unique ID for rendering queue.
    */
@@ -120,8 +125,6 @@ class IRenderableView {
    * @returns {Promise} Resolved on draw completion.
    */
   draw() {}
-
-  resume() {}
 }
 
 /**

web/pdf_link_service.js

@@ -13,6 +13,8 @@
  * limitations under the License.
  */
 
+/** @typedef {import("./interfaces").IPDFLinkService} IPDFLinkService */
+
 import { parseQueryString } from "./ui_utils.js";
 
 /**

web/pdf_page_view.js

@@ -13,6 +13,8 @@
  * limitations under the License.
  */
 
+/** @typedef {import("./interfaces").IRenderableView} IRenderableView */
+
 import {
   AnnotationMode,
   createPromiseCapability,

web/pdf_rendering_queue.js

@@ -33,6 +33,7 @@ class PDFRenderingQueue {
     this.pdfThumbnailViewer = null;
     this.onIdle = null;
     this.highestPriorityPage = null;
+    /** @type {number} */
     this.idleTimeout = null;
     this.printing = false;
     this.isThumbnailViewEnabled = false;

web/struct_tree_layer_builder.js

@@ -13,6 +13,9 @@
  * limitations under the License.
  */
 
+// eslint-disable-next-line max-len
+/** @typedef {import("./interfaces").IPDFStructTreeLayerFactory} IPDFStructTreeLayerFactory */
+
 const PDF_ROLE_TO_HTML_ROLE = {
   // Document level structure types
   Document: null, // There's a "document" role, but it doesn't make sense here.

web/text_highlighter.js

@@ -14,7 +14,7 @@
  */
 
 /**
- * @typedef {Object} TextHighlighter
+ * @typedef {Object} TextHighlighterOptions
  * @property {PDFFindController} findController
  * @property {EventBus} eventBus - The application event bus.
  * @property {number} pageIndex - The page index.
@@ -25,6 +25,9 @@
  * either the text layer or XFA layer depending on the type of document.
  */
 class TextHighlighter {
+  /**
+   * @param {TextHighlighterOptions} options
+   */
   constructor({ findController, eventBus, pageIndex }) {
     this.findController = findController;
     this.matches = [];

web/text_layer_builder.js

@@ -13,6 +13,9 @@
  * limitations under the License.
  */
 
+// eslint-disable-next-line max-len
+/** @typedef {import("./interfaces").IPDFTextLayerFactory} IPDFTextLayerFactory */
+
 import { renderTextLayer } from "pdfjs-lib";
 
 const EXPAND_DIVS_TIMEOUT = 300; // ms

web/ui_utils.js

@@ -284,12 +284,23 @@ function roundToDivide(x, div) {
   return r === 0 ? x : Math.round(x - r + div);
 }
 
+/**
+ * @typedef {Object} GetPageSizeInchesParameters
+ * @property {number[]} view
+ * @property {number} userUnit
+ * @property {number} rotate
+ */
+
+/**
+ * @typedef {Object} PageSize
+ * @property {number} width - In inches.
+ * @property {number} height - In inches.
+ */
+
 /**
  * Gets the size of the specified page, converted from PDF units to inches.
- * @param {Object} An Object containing the properties: {Array} `view`,
- *   {number} `userUnit`, and {number} `rotate`.
- * @returns {Object} An Object containing the properties: {number} `width`
- *   and {number} `height`, given in inches.
+ * @param {GetPageSizeInchesParameters} params
+ * @returns {PageSize}
  */
 function getPageSizeInches({ view, userUnit, rotate }) {
   const [x1, y1, x2, y2] = view;

web/xfa_layer_builder.js

@@ -13,12 +13,15 @@
  * limitations under the License.
  */
 
+/** @typedef {import("./interfaces").IPDFXfaLayerFactory} IPDFXfaLayerFactory */
+
 import { XfaLayer } from "pdfjs-lib";
 
 /**
  * @typedef {Object} XfaLayerBuilderOptions
  * @property {HTMLDivElement} pageDiv
  * @property {PDFPage} pdfPage
+ * @property {Object} [xfaHtml]
  * @property {AnnotationStorage} [annotationStorage]
  */