c08b4ea30d
The Viewer API definitions do not compile because of missing imports and
anonymous objects are typed as `Object`. These issues were not caught
during CI because the test project was not compiling anything from the
Viewer API.
As an example of the first problem:
```
/**
* @implements MyInterface
*/
export class MyClass {
...
}
```
will generate a broken definition that doesn’t import MyInterface:
```
/**
* @implements MyInterface
*/
export class MyClass implements MyInterface {
...
}
```
This can be fixed by adding a typedef jsdoc to specify the import:
```
/** @typedef {import("./otherFile").MyInterface} MyInterface */
```
See https://github.com/jsdoc/jsdoc/issues/1537 and
https://github.com/microsoft/TypeScript/issues/22160 for more details.
As an example of the second problem:
```
/**
* 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`.
*/
function getPageSizeInches({ view, userUnit, rotate }) {
...
}
```
generates the broken definition:
```
function getPageSizeInches({ view, userUnit, rotate }: Object) {
...
}
```
The jsdoc should specify the type of each nested property:
```
/**
* Gets the size of the specified page, converted from PDF units to inches.
* @param {Object} options An object containing the properties: {Array} `view`,
* {number} `userUnit`, and {number} `rotate`.
* @param {number[]} options.view
* @param {number} options.userUnit
* @param {number} options.rotate
*/
```
137 lines
3.5 KiB
JavaScript
137 lines
3.5 KiB
JavaScript
/* Copyright 2021 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* 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]
|
|
*/
|
|
|
|
class XfaLayerBuilder {
|
|
/**
|
|
* @param {XfaLayerBuilderOptions} options
|
|
*/
|
|
constructor({ pageDiv, pdfPage, xfaHtml, annotationStorage }) {
|
|
this.pageDiv = pageDiv;
|
|
this.pdfPage = pdfPage;
|
|
this.xfaHtml = xfaHtml;
|
|
this.annotationStorage = annotationStorage;
|
|
|
|
this.div = null;
|
|
this._cancelled = false;
|
|
}
|
|
|
|
/**
|
|
* @param {PageViewport} viewport
|
|
* @param {string} intent (default value is 'display')
|
|
* @returns {Promise<Object | void>} A promise that is resolved when rendering
|
|
* of the XFA layer is complete. The first rendering will return an object
|
|
* with a `textDivs` property that can be used with the TextHighlighter.
|
|
*/
|
|
render(viewport, intent = "display") {
|
|
if (intent === "print") {
|
|
const parameters = {
|
|
viewport: viewport.clone({ dontFlip: true }),
|
|
div: this.div,
|
|
xfa: this.xfaHtml,
|
|
page: null,
|
|
annotationStorage: this.annotationStorage,
|
|
intent,
|
|
};
|
|
|
|
// Create an xfa layer div and render the form
|
|
const div = document.createElement("div");
|
|
this.pageDiv.appendChild(div);
|
|
parameters.div = div;
|
|
|
|
XfaLayer.render(parameters);
|
|
return Promise.resolve();
|
|
}
|
|
|
|
// intent === "display"
|
|
return this.pdfPage
|
|
.getXfa()
|
|
.then(xfa => {
|
|
if (this._cancelled) {
|
|
return Promise.resolve();
|
|
}
|
|
const parameters = {
|
|
viewport: viewport.clone({ dontFlip: true }),
|
|
div: this.div,
|
|
xfa,
|
|
page: this.pdfPage,
|
|
annotationStorage: this.annotationStorage,
|
|
intent,
|
|
};
|
|
|
|
if (this.div) {
|
|
return XfaLayer.update(parameters);
|
|
}
|
|
// Create an xfa layer div and render the form
|
|
this.div = document.createElement("div");
|
|
this.pageDiv.appendChild(this.div);
|
|
parameters.div = this.div;
|
|
return XfaLayer.render(parameters);
|
|
})
|
|
.catch(error => {
|
|
console.error(error);
|
|
});
|
|
}
|
|
|
|
cancel() {
|
|
this._cancelled = true;
|
|
}
|
|
|
|
hide() {
|
|
if (!this.div) {
|
|
return;
|
|
}
|
|
this.div.hidden = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @implements IPDFXfaLayerFactory
|
|
*/
|
|
class DefaultXfaLayerFactory {
|
|
/**
|
|
* @param {HTMLDivElement} pageDiv
|
|
* @param {PDFPage} pdfPage
|
|
* @param {AnnotationStorage} [annotationStorage]
|
|
* @param {Object} [xfaHtml]
|
|
*/
|
|
createXfaLayerBuilder(
|
|
pageDiv,
|
|
pdfPage,
|
|
annotationStorage = null,
|
|
xfaHtml = null
|
|
) {
|
|
return new XfaLayerBuilder({
|
|
pageDiv,
|
|
pdfPage,
|
|
annotationStorage,
|
|
xfaHtml,
|
|
});
|
|
}
|
|
}
|
|
|
|
export { DefaultXfaLayerFactory, XfaLayerBuilder };
|