Merge pull request #285 from pipwerks/2.2.9

2.2.10

Author: pipwerks

LICENSE.md

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright © 2021 Philip Hutchison
+Copyright © 2023 Philip Hutchison
 https://pipwerks.mit-license.org/
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

bower.json

@@ -1,7 +1,7 @@
 {
   "name": "pdfobject",
   "description": "An open-source standards-friendly JavaScript utility for embedding PDF files into HTML documents",
-  "version": "2.2.8",
+  "version": "2.2.10",
   "main": "pdfobject.js",
   "moduleType": [
 	  "globals",

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "pdfobject",
-  "version": "2.2.8",
+  "version": "2.2.10",
   "description": "An open-source standards-friendly JavaScript utility for embedding PDF files into HTML documents",
   "main": "pdfobject.js",
   "scripts": {

package.json

@@ -1,8 +1,8 @@
 /**
- *  PDFObject v2.2.8
+ *  PDFObject v2.2.10
  *  https://github.com/pipwerks/PDFObject
  *  @license
- *  Copyright (c) 2008-2022 Philip Hutchison
+ *  Copyright (c) 2008-2023 Philip Hutchison
  *  MIT-style license: http://pipwerks.mit-license.org/
  *  UMD module pattern from https://github.com/umdjs/umd/blob/master/templates/returnExports.js
  */
@@ -184,7 +184,7 @@
 
     };
 
-    let generatePDFObjectMarkup = function (embedType, targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles, PDFJS_URL){
+    let generatePDFObjectMarkup = function (embedType, targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles, customAttribute, PDFJS_URL){
 
         //Ensure target element is empty first
         emptyNodeContents(targetNode);
@@ -195,6 +195,8 @@
             //If PDFJS_URL already contains a ?, assume querystring is in place, and use an ampersand to append PDFJS's file parameter
             let connector = (PDFJS_URL.indexOf("?") !== -1) ? "&" : "?"; 
             source = PDFJS_URL + connector + "file=" + encodeURIComponent(url) + pdfOpenFragment;
+        } else {
+            source += pdfOpenFragment;
         }
 
         let el_type = (embedType === "pdfjs" || embedType === "iframe") ? "iframe" : "embed";
@@ -230,6 +232,12 @@
 
         }
 
+        //Allow developer to insert custom attribute on embed/iframe element, but ensure it does not conflict with attributes used by PDFObject
+        let reservedTokens = ["className", "type", "title", "src", "style", "id", "allow", "frameborder"];
+        if(customAttribute && customAttribute.key && reservedTokens.every(token => !customAttribute.key.includes(token))){
+            el.setAttribute(customAttribute.key, (typeof customAttribute.value !== "undefined") ? customAttribute.value : "");
+        }
+
         targetNode.classList.add("pdfobject-container");
         targetNode.appendChild(el);
 
@@ -263,6 +271,7 @@
         let targetNode = getTargetElement(selector);
         let fallbackHTML = "";
         let pdfOpenFragment = "";
+        let customAttribute = opt.customAttribute || {};
         let fallbackHTML_default = "<p>This browser does not support inline PDFs. Please download the PDF to view it: <a href='[url]'>Download PDF</a></p>";
 
         //Ensure URL is available. If not, exit now.
@@ -282,7 +291,7 @@
 
         //If the forcePDFJS option is invoked, skip everything else and embed as directed
         if(forcePDFJS && PDFJS_URL){
-            return generatePDFObjectMarkup("pdfjs", targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles, PDFJS_URL);
+            return generatePDFObjectMarkup("pdfjs", targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles, customAttribute, PDFJS_URL);
         }
 
         // --== Embed attempt #2 ==--
@@ -298,15 +307,15 @@
             //Forcing Safari desktop to use iframe due to freezing bug in macOS 11 (Big Sur)
             let embedtype = (forceIframe || supportRedirect || isSafariDesktop) ? "iframe" : "embed";
 
-            return generatePDFObjectMarkup(embedtype, targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles);
+            return generatePDFObjectMarkup(embedtype, targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles, customAttribute);
 
         }
 
         // --== Embed attempt #3 ==--
 
         //If everything else has failed and a PDFJS fallback is provided, try to use it
         if(PDFJS_URL){
-            return generatePDFObjectMarkup("pdfjs", targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles, PDFJS_URL);
+            return generatePDFObjectMarkup("pdfjs", targetNode, url, pdfOpenFragment, width, height, id, title, omitInlineStyles, customAttribute, PDFJS_URL);
         }
 
         // --== PDF embed not supported! Use fallback ==-- 

pdfobject.js

@@ -2,7 +2,7 @@ PDFObject is a lightweight JavaScript utility for dynamically embedding PDFs in
 
 Examples and documentation can be found at https://pdfobject.com.
 
-Copyright (c) 2008-2022 Philip Hutchison
+Copyright (c) 2008-2023 Philip Hutchison
 MIT-style license: http://pipwerks.mit-license.org/
 
 -----
@@ -11,6 +11,13 @@ MIT-style license: http://pipwerks.mit-license.org/
 
 ## Changelog
 
+### 2.2.10, May 2023
+Version bump for cleaning up docs and aligning on NPM. I'm a bit rusty.
+
+### 2.2.9, May 2023
+* Fixed regression for `pdfOpenParams` handling, resolves issue #272. Hat tip to Theo Beers.
+* Added ability to specify custom attribute on `embed` and `iframe` elements, per #274
+
 ### 2.2.8, April 2022
 * Refactored to reduce redundant code. Simplified iframe and PDFJS handling. Subsequently resolves #263 (double scroll bars) and PR #267 (PDFJS_URL param fix). Hat tip to Theo Beers, Sascha Greuel, meier-andersen, and everyone who helped identify and confirm the underlying issues.
 * Fixed `fallbackLink` handling to ensure `false` is respected. Hat tip to Theo Beers.