pdfjs-dist/lib/test/unit/struct_tree_spec.js

/**
 * @licstart The following is the entire license notice for the
 * Javascript code in this page
 *
 * 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.
 *
 * @licend The above is the entire license notice for the
 * Javascript code in this page
 */
"use strict";

var _test_utils = require("./test_utils.js");

var _api = require("../../display/api.js");

function equalTrees(rootA, rootB) {
  function walk(a, b) {
    expect(a.role).toEqual(b.role);
    expect(a.type).toEqual(b.type);
    expect("children" in a).toEqual("children" in b);

    if (!a.children) {
      return;
    }

    expect(a.children.length).toEqual(b.children.length);

    for (let i = 0; i < rootA.children.length; i++) {
      walk(a.children[i], b.children[i]);
    }
  }

  return walk(rootA, rootB);
}

describe("struct tree", function () {
  describe("getStructTree", function () {
    it("parses basic structure", async function () {
      const filename = "structure_simple.pdf";
      const params = (0, _test_utils.buildGetDocumentParams)(filename);
      const loadingTask = (0, _api.getDocument)(params);
      const doc = await loadingTask.promise;
      const page = await doc.getPage(1);
      const struct = await page.getStructTree();
      equalTrees({
        role: "Root",
        children: [{
          role: "Document",
          children: [{
            role: "H1",
            children: [{
              role: "NonStruct",
              children: [{
                type: "content"
              }]
            }]
          }, {
            role: "P",
            children: [{
              role: "NonStruct",
              children: [{
                type: "content"
              }]
            }]
          }, {
            role: "H2",
            children: [{
              role: "NonStruct",
              children: [{
                type: "content"
              }]
            }]
          }, {
            role: "P",
            children: [{
              role: "NonStruct",
              children: [{
                type: "content"
              }]
            }]
          }]
        }]
      }, struct);
      await loadingTask.destroy();
    });
    it("parses structure with marked content reference", async function () {
      const filename = "issue6782.pdf";
      const params = (0, _test_utils.buildGetDocumentParams)(filename);
      const loadingTask = (0, _api.getDocument)(params);
      const doc = await loadingTask.promise;
      const page = await doc.getPage(1);
      const struct = await page.getStructTree();
      equalTrees({
        role: "Root",
        children: [{
          role: "Part",
          children: [{
            role: "P",
            children: Array(27).fill({
              type: "content"
            })
          }]
        }]
      }, struct);
      await loadingTask.destroy();
    });
  });
});