@tindtechnologies/pdfjs-viewer 5.4.624-tind.6 → 5.4.624-tind.8

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/pdfjs-viewer.iml" filepath="$PROJECT_DIR$/.idea/pdfjs-viewer.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/pdfjs-viewer.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -1,3 +1,70 @@
 # TIND PDF.js viewer
 
 This is a PDF.js viewer for TIND. It is based on the PDF.js viewer provided by Mozilla, but it has been modified to work with TIND.
+
+## Local PDF viewer changes
+
+- Registering download stats by intercepting the download button click and sending a `register_download=1` request before file retrieval (`src/web/only-register-download.js`).
+- Configurable chunk size by reading `rangeChunkSize` from the viewer URL and injecting it into `PDFViewerApplication.open` (`src/web/override-pdf-viewer-application-open.js`).
+- View-only HTML variant by generating `pdf_viewer_view_only.html` and hiding print/download controls during the viewer transform step (`gulpfile.mjs`).
+
+## Building
+
+1. Install the dependencies
+
+    ```shell
+    npm clean-install
+    ```
+
+2. Download PDF.js source code
+
+    ```shell
+    npx gulp pdfJsDownload
+    ```
+
+3. Install the PDF.js dependencies
+
+    ```shell
+    npx gulp pdfJsInstall
+    ```
+
+4. Run the complete build task
+
+    ```shell
+    npx gulp completeBuild
+    ```
+
+5. (Optional) Clean up built assets
+
+    ```shell
+    npx gulp clean
+    ```
+
+The output is available in the `build` directory with this structure:
+
+- `build/pdf.js` (downloaded PDF.js source, including `build/` artifacts)
+- `build/dist` (distribution assets from PDF.js `generic`, plus override and `package.json`)
+
+## Versioning
+
+Keep the upstream PDF.js version as the base and use a `-tind.N` suffix for publish increments.
+
+- First publish for upstream `5.4.624`: `5.4.624-tind.0`
+- Next publish: `5.4.624-tind.1`
+- After upgrading upstream to `5.4.625`: `5.4.625-tind.0`
+
+Examples:
+
+```shell
+# set explicit version
+npm version 5.4.624-tind.0 --no-git-tag-version
+
+# bump the tind prerelease number (tind.0 -> tind.1)
+npm version prerelease --preid=tind --no-git-tag-version
+```
+
+When publishing a prerelease version (`-tind.N`), npm requires an explicit dist-tag:
+
+```shell
+npm publish --tag tind
+```

package/gulpfile.mjs

@@ -0,0 +1,263 @@
+import { join } from "node:path";
+import { spawn } from "node:child_process";
+import { PassThrough, Readable, Transform } from "node:stream";
+import { finished, pipeline } from "node:stream/promises";
+import { dest, parallel, series, src } from "gulp";
+import { rimraf } from "rimraf";
+import { JSDOM } from "jsdom";
+import * as tar from "tar";
+import Vinyl from "vinyl";
+
+const pdfJsDownloadUrl =
+  "https://github.com/mozilla/pdf.js/archive/refs/tags/v5.4.624.tar.gz";
+const buildDirectory = join(import.meta.dirname, "build");
+const pdfJsModuleDirectory = join(buildDirectory, "pdf.js");
+const distDirectory = join(buildDirectory, "dist");
+
+/**
+ * @param {readonly string[]} args
+ * @param {NodeJS.ProcessEnv} [env]
+ */
+function pdfJsNpmTask(args, env) {
+  return spawn("npm", args, {
+    cwd: pdfJsModuleDirectory,
+    env: {
+      ...process.env,
+      ...env,
+    },
+    stdio: "inherit",
+  });
+}
+
+/**
+ * @param {readonly string[]} args
+ */
+function pdfJsNpxTask(args) {
+  return spawn("npx", args, {
+    cwd: pdfJsModuleDirectory,
+    stdio: "inherit",
+  });
+}
+
+function pathFromArchiveRoot(path) {
+  const segments = path.split("/").filter(Boolean);
+  return segments.slice(1).join("/");
+}
+
+export async function pdfJsDownload() {
+  await rimraf(pdfJsModuleDirectory);
+
+  const response = await fetch(pdfJsDownloadUrl);
+  if (!response.ok) {
+    throw new Error(
+      `Failed to download PDF.js archive (${response.status} ${response.statusText}).`,
+    );
+  }
+  if (!response.body) {
+    throw new Error("PDF.js download returned an empty response body.");
+  }
+
+  const vinylStream = new PassThrough({ objectMode: true });
+  const output = vinylStream.pipe(dest(pdfJsModuleDirectory));
+  const parser = tar.t({
+    noResume: true,
+    onReadEntry(entry) {
+      if (entry.type !== "File") {
+        entry.resume();
+        return;
+      }
+
+      const relativePath = pathFromArchiveRoot(entry.path);
+      if (!relativePath) {
+        entry.resume();
+        return;
+      }
+
+      vinylStream.write(
+        new Vinyl({
+          base: pdfJsModuleDirectory,
+          cwd: import.meta.dirname,
+          contents: entry,
+          path: join(pdfJsModuleDirectory, relativePath),
+        }),
+      );
+    },
+  });
+
+  parser.once("error", (error) => {
+    vinylStream.destroy(error);
+  });
+  parser.once("end", () => {
+    vinylStream.end();
+  });
+
+  await Promise.all([
+    pipeline(Readable.fromWeb(response.body), parser),
+    finished(output),
+  ]);
+}
+
+export function pdfJsInstall() {
+  return pdfJsNpmTask(["clean-install", "--include", "dev"], {
+    PUPPETEER_SKIP_DOWNLOAD: "1",
+  });
+}
+
+export function pdfJsGeneric() {
+  return pdfJsNpxTask(["gulp", "generic"]);
+}
+
+export function clean() {
+  return rimraf(buildDirectory);
+}
+
+function distClean() {
+  return rimraf(distDirectory);
+}
+
+function copyPdfJsGenericAssets() {
+  return src(join(pdfJsModuleDirectory, "build/generic/**/*")).pipe(
+    dest(distDirectory),
+  );
+}
+
+const collectAssets = copyPdfJsGenericAssets;
+
+export const build = series(pdfJsGeneric, distClean, collectAssets);
+
+export function transformViewer() {
+  return src(join(distDirectory, "web/viewer.html"), {
+    base: join(distDirectory, "web"),
+  })
+    .pipe(
+      new Transform({
+        objectMode: true,
+        transform(file, _encoding, callback) {
+          if (file.isDirectory()) {
+            callback();
+            return;
+          }
+          if (file.isNull()) {
+            callback(null, file);
+            return;
+          }
+          if (file.isStream()) {
+            callback(new Error("Streaming Vinyl files are not supported."));
+            return;
+          }
+
+          const { window } = new JSDOM(file.contents.toString("utf8"));
+          const overrideScriptElement = window.document.createElement("script");
+          overrideScriptElement.src = "override-pdf-viewer-application-open.js";
+          const registerDownloadScriptElement =
+            window.document.createElement("script");
+          registerDownloadScriptElement.src = "only-register-download.js";
+
+          const title = window.document.head.querySelector("title");
+          if (title) {
+            title.after(overrideScriptElement);
+            title.after(registerDownloadScriptElement);
+          } else {
+            window.document.head.append(overrideScriptElement);
+          }
+
+          this.push(
+            Object.assign(file.clone({ contents: false }), {
+              path: join(file.base, "pdf_viewer.html"),
+              contents: Buffer.from(
+                window.document.documentElement.outerHTML,
+                "utf8",
+              ),
+            }),
+          );
+
+          const secondaryPrint =
+            window.document.getElementById("secondaryPrint");
+
+          if (secondaryPrint) {
+            secondaryPrint.style = "display:none !important";
+          }
+
+          const secondaryDownload =
+            window.document.getElementById("secondaryDownload");
+
+          if (secondaryDownload) {
+            secondaryDownload.style = "display:none !important";
+          }
+
+          const print = window.document.getElementById("printButton");
+
+          if (print) {
+            print.style = "display:none !important";
+          }
+
+          const download = window.document.getElementById("downloadButton");
+
+          if (download) {
+            download.style = "display:none !important";
+          }
+
+          this.push(
+            Object.assign(file.clone({ contents: false }), {
+              path: join(file.base, "pdf_viewer_view_only.html"),
+              contents: Buffer.from(
+                window.document.documentElement.outerHTML,
+                "utf8",
+              ),
+            }),
+          );
+
+          callback();
+        },
+      }),
+    )
+    .pipe(dest(join(distDirectory, "web")));
+}
+
+export function copySrcFilesIntoDist() {
+  return src(["**/*", "**/.*"], {
+    cwd: join(import.meta.dirname, "src"),
+    base: join(import.meta.dirname, "src"),
+    dot: true,
+    nodir: true,
+  }).pipe(dest(distDirectory));
+}
+
+export function copyPackageJsonIntoDist() {
+  return src(join(import.meta.dirname, "package.json"), {
+    base: import.meta.dirname,
+  }).pipe(dest(distDirectory));
+}
+
+function removeDevDependenciesFromDistPackageJson() {
+  return spawn("npm", ["pkg", "delete", "devDependencies"], {
+    cwd: distDirectory,
+    stdio: "inherit",
+  });
+}
+
+export function packageAsset() {
+  return spawn("npm", ["pack"], {
+    cwd: distDirectory,
+    stdio: "inherit",
+  });
+}
+
+export function createPackageLockInDist() {
+  return spawn("npm", ["install", "--package-lock-only"], {
+    cwd: distDirectory,
+    stdio: "inherit",
+  });
+}
+
+export const completeBuild = series(
+  build,
+  parallel(
+    transformViewer,
+    series(
+      parallel(copySrcFilesIntoDist, copyPackageJsonIntoDist),
+      removeDevDependenciesFromDistPackageJson,
+      createPackageLockInDist,
+    ),
+  ),
+);

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "@tindtechnologies/pdfjs-viewer",
-  "version": "5.4.624-tind.6",
+  "version": "5.4.624-tind.8",
   "repository": {
     "type": "git",
     "url": "https://github.com/tind/pdfjs-viewer"
   },
-  "license": "Apache-2.0"
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "gulp": "^5.0.1",
+    "jsdom": "^28.0.0",
+    "rimraf": "^6.1.2",
+    "tar": "^7.5.7"
+  }
 }

package/{web → src/web}/override-pdf-viewer-application-open.js

@@ -1,6 +1,5 @@
 const OPEN_PATCHED_FLAG = Symbol("tindPdfViewerApplicationOpenPatched");
 const registeredDocuments = new WeakSet();
-const SIDEBAR_VIEW_NONE = 0;
 
 function patchPDFViewerApplicationOpen(evt) {
   const sourceWindow = evt?.detail?.source;
@@ -15,24 +14,9 @@ function patchPDFViewerApplicationOpen(evt) {
     return;
   }
 
-  const originalSetInitialView = app.setInitialView?.bind(app);
-  if (originalSetInitialView) {
-    // Force the initial sidebar state to "closed" after all startup state
-    // (preferences/history/document metadata) has been resolved.
-    app.setInitialView = (storedHash, options = {}) =>
-      originalSetInitialView(storedHash, {
-        ...options,
-        sidebarView: SIDEBAR_VIEW_NONE,
-      });
-  } else {
-    // Fallback for unexpected viewer versions without `setInitialView`.
-    win.PDFViewerApplicationOptions?.set("sidebarViewOnLoad", SIDEBAR_VIEW_NONE);
-  }
-
   const params = new URLSearchParams(win.location.search);
   const rangeChunkSize = Number(params.get("chunksize"));
   if (!Number.isInteger(rangeChunkSize) || rangeChunkSize <= 0) {
-    app[OPEN_PATCHED_FLAG] = true;
     return;
   }
 

package/LICENSE

@@ -1,177 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS