@muhammara/native-core 7.0.0-alpha.1 → 7.0.0-beta.2

package/lib/recipe/info.js

@@ -1,8 +1,9 @@
 const fs = require("fs");
 const muhammara = require("../muhammara");
+var { recipeInfoKeys, standardInfoKeys } = require("../recipe-info");
 /**
  * @name info
- * @desc Add new PDF information, or retrieve existing PDF information.
+ * @desc Add standard and custom PDF information, or retrieve existing PDF information. Custom keys retain their spelling when written; array values are joined with a comma and space.
  * @memberof Recipe#
  * @function
  * @param {Object} [options] - The options (when missing obtains existing PDF information)
@@ -21,6 +22,14 @@ exports.info = function info(options) {
   } else {
     this.toWriteInfo_ = this.toWriteInfo_ || {};
     Object.assign(this.toWriteInfo_, options);
+    Object.entries(options).forEach(([key, value]) => {
+      if (!standardInfoKeys.includes(key)) {
+        this.custom(
+          key,
+          Array.isArray(value) ? value.join(", ") : String(value),
+        );
+      }
+    });
     result = this;
   }
 
@@ -33,60 +42,63 @@ exports._readInfo = function _readInfo() {
       ? new muhammara.PDFRStreamForBuffer(this.src)
       : this.src;
     const copyCtx = this.writer.createPDFCopyingContext(copyFrom);
-    const infoDict = copyCtx
-      .getSourceDocumentParser()
-      .queryDictionaryObject(
-        copyCtx.getSourceDocumentParser().getTrailer(),
-        "Info",
-      );
+    try {
+      const infoDict = copyCtx
+        .getSourceDocumentParser()
+        .queryDictionaryObject(
+          copyCtx.getSourceDocumentParser().getTrailer(),
+          "Info",
+        );
 
-    const oldInfo =
-      infoDict && infoDict.toJSObject ? infoDict.toJSObject() : null;
+      const oldInfo =
+        infoDict && infoDict.toJSObject ? infoDict.toJSObject() : null;
 
-    if (oldInfo) {
-      this.infoDictionary = {};
-      Object.getOwnPropertyNames(oldInfo).forEach((key) => {
-        if (!oldInfo[key]) {
-          return;
-        }
-        const oldInforSrc = this._parseObjectByType(oldInfo[key]);
-        if (!oldInforSrc) {
-          return;
-        }
-        switch (key) {
-          case "Trapped":
-            if (oldInforSrc && oldInforSrc.value) {
-              this.infoDictionary.trapped = oldInforSrc.value;
-            }
-            break;
-          case "CreationDate":
-            if (oldInforSrc && oldInforSrc.value) {
-              this.infoDictionary.creationDate = oldInforSrc.value;
-            }
-            break;
-          case "ModDate":
-            if (oldInforSrc && oldInforSrc.value) {
-              this.infoDictionary.modDate = oldInforSrc.value;
-            }
-            break;
-          case "Creator":
-            if (oldInforSrc && oldInforSrc.toText) {
-              this.infoDictionary.creator = oldInforSrc.toText();
-            }
-            break;
-          case "Producer":
-            if (oldInforSrc && oldInforSrc.toText) {
-              this.infoDictionary.producer = oldInforSrc.toText();
-            }
-            break;
-          default:
-            if (oldInforSrc && oldInforSrc.toText) {
-              this.infoDictionary[key.toLowerCase()] = oldInforSrc.toText();
-            }
-        }
-      });
+      if (oldInfo) {
+        this.infoDictionary = {};
+        Object.getOwnPropertyNames(oldInfo).forEach((key) => {
+          if (!oldInfo[key]) {
+            return;
+          }
+          const oldInforSrc = this._parseObjectByType(oldInfo[key]);
+          if (!oldInforSrc) {
+            return;
+          }
+          switch (key) {
+            case "Trapped":
+              if (oldInforSrc && oldInforSrc.value) {
+                this.infoDictionary.trapped = oldInforSrc.value;
+              }
+              break;
+            case "CreationDate":
+              if (oldInforSrc && oldInforSrc.value) {
+                this.infoDictionary.creationDate = oldInforSrc.value;
+              }
+              break;
+            case "ModDate":
+              if (oldInforSrc && oldInforSrc.value) {
+                this.infoDictionary.modDate = oldInforSrc.value;
+              }
+              break;
+            case "Creator":
+              if (oldInforSrc && oldInforSrc.toText) {
+                this.infoDictionary.creator = oldInforSrc.toText();
+              }
+              break;
+            case "Producer":
+              if (oldInforSrc && oldInforSrc.toText) {
+                this.infoDictionary.producer = oldInforSrc.toText();
+              }
+              break;
+            default:
+              if (oldInforSrc && oldInforSrc.toText) {
+                this.infoDictionary[key.toLowerCase()] = oldInforSrc.toText();
+              }
+          }
+        });
+      }
+    } finally {
+      copyCtx.end();
     }
-    copyCtx.end();
   }
 
   return this.infoDictionary;
@@ -102,24 +114,10 @@ exports._writeInfo = function _writeInfo() {
     */
 
   const infoDictionary = this.writer.getDocumentContext().getInfoDictionary();
-  const fields = [
-    {
-      key: "author",
-      type: "string",
-    },
-    {
-      key: "title",
-      type: "string",
-    },
-    {
-      key: "subject",
-      type: "string",
-    },
-    {
-      key: "keywords",
-      type: "array",
-    },
-  ];
+  var fields = standardInfoKeys.map((key) => ({
+    key,
+    type: key === recipeInfoKeys.keywords ? "array" : "string",
+  }));
   // const ignores = [
   //     'CreationDate', 'Creator', 'ModDate', 'Producer'
   // ];
@@ -168,7 +166,7 @@ exports._writeInfo = function _writeInfo() {
   infoDictionary.producer =
     "MuhammaraJS (https://github.com/julianhille/MuhammaraJS)";
   infoDictionary.creator =
-    "Hummus-Recipe (https://github.com/chunyenHuang/hummusRecipe)";
+    "Muhammara-Recipe (https://github.com/julianhille/MuhammaraJS)";
 
   fields.forEach((item) => {
     let value = options[item.key];
@@ -225,7 +223,7 @@ exports.structure = function structure(output) {
   // const outputFileType = path.extname(output);
   const outputFile = fs.openSync(output, "w");
   const muhammara = this.muhammara;
-  const pdfReader = this.pdfReader;
+  const pdfReader = this._getReader();
 
   const tabWidth = "  ";
   const structures = [
@@ -331,7 +329,7 @@ exports._parseObjectByType = function _parseObjectByType(inObject) {
     return;
   }
   const muhammara = this.muhammara;
-  const pdfReader = this.pdfReader;
+  const pdfReader = this._getReader();
   const type = inObject.getType();
   const label = muhammara.getTypeLabel(type);
   const saveToObject = this.pdfStructure || {};

package/lib/recipe/insertPage.js

@@ -1,6 +1,6 @@
 const muhammara = require("../muhammara");
 const fs = require("fs");
-const hummusUtils = require("./utils");
+const utils = require("./utils");
 /**
  * Insert a page from the other pdf
  * @name insertPage
@@ -11,26 +11,31 @@ const hummusUtils = require("./utils");
  * @param {number} srcPageNumber - The page number to be insterted from the other pdf.
  * @returns {Recipe} The recipe instance.
  * @throws {Error} If afterPageNumber is not a number.
+ * @throws {TypeError} If pdfSrc or srcPageNumber is missing.
  */
 exports.insertPage = function insertPage(
   afterPageNumber,
   pdfSrc,
   srcPageNumber,
 ) {
+  if (this.deletedPages?.size) {
+    throw new Error("insertPage cannot be combined with deletePage");
+  }
   if (isNaN(afterPageNumber)) {
     throw new Error("The afterPageNumber is inValid.");
   }
-  this.needToInsertPages = true;
-  if (pdfSrc && srcPageNumber) {
-    this.insertInformation = this.insertInformation || {};
-    this.insertInformation[afterPageNumber] =
-      this.insertInformation[afterPageNumber] || [];
-    this.insertInformation[afterPageNumber].push({
-      afterPageNumber,
-      pdfSrc,
-      srcPageNumber,
-    });
+  if (!pdfSrc || !srcPageNumber) {
+    throw new TypeError("insertPage requires pdfSrc and srcPageNumber");
   }
+  this.insertInformation = this.insertInformation || {};
+  this.insertInformation[afterPageNumber] =
+    this.insertInformation[afterPageNumber] || [];
+  this.insertInformation[afterPageNumber].push({
+    afterPageNumber,
+    pdfSrc,
+    srcPageNumber,
+  });
+  this.needToInsertPages = true;
   return this;
 };
 
@@ -53,7 +58,7 @@ exports._insertPages = function _insertPages() {
     const toAppendPage = pageNumber - 1;
     if (toAppendPage >= 0) {
       const specificRanges = [[lastInsertedOriginal, toAppendPage]];
-      hummusUtils.appendPDFPagesFromPDFWithAnnotations(pdfWriter, tmp, {
+      utils.appendPDFPagesFromPDFWithAnnotations(pdfWriter, tmp, {
         specificRanges,
       });
     }
@@ -65,11 +70,9 @@ exports._insertPages = function _insertPages() {
         const specificRanges = [
           [info.srcPageNumber - 1, info.srcPageNumber - 1],
         ];
-        hummusUtils.appendPDFPagesFromPDFWithAnnotations(
-          pdfWriter,
-          info.pdfSrc,
-          { specificRanges },
-        );
+        utils.appendPDFPagesFromPDFWithAnnotations(pdfWriter, info.pdfSrc, {
+          specificRanges,
+        });
       });
     }
   });