Added some more types in placeholder-plain

packages/placeholder-plain/dist/createBufferTrailer.d.ts

@@ -1,3 +1,9 @@
 export default createBufferTrailer;
-declare function createBufferTrailer(pdf: any, info: any, addedReferences: any): Buffer;
+/**
+ * @param {Buffer} pdf
+ * @param {import("./readPdf").ReadPdfReturnType} info
+ * @param {Map<number, number>} addedReferences
+ * @returns {Buffer}
+ */
+declare function createBufferTrailer(pdf: Buffer, info: import("./readPdf").ReadPdfReturnType, addedReferences: Map<number, number>): Buffer;
 //# sourceMappingURL=createBufferTrailer.d.ts.map

packages/placeholder-plain/dist/createBufferTrailer.js

@@ -1,3 +1,9 @@
+/**
+ * @param {Buffer} pdf
+ * @param {import("./readPdf").ReadPdfReturnType} info
+ * @param {Map<number, number>} addedReferences
+ * @returns {Buffer}
+ */
 const createBufferTrailer = (pdf, info, addedReferences) => {
   let rows = [];
   rows[0] = '0000000000 65535 f '; // info.xref.tableRows[0];

packages/placeholder-plain/dist/findObject.d.ts

@@ -2,7 +2,7 @@ export default findObject;
 /**
  * @param {Buffer} pdf
  * @param {Map} refTable
- * @returns {object}
+ * @returns {Buffer}
  */
-declare function findObject(pdf: Buffer, refTable: Map<any, any>, ref: any): object;
+declare function findObject(pdf: Buffer, refTable: Map<any, any>, ref: any): Buffer;
 //# sourceMappingURL=findObject.d.ts.map

packages/placeholder-plain/dist/findObject.js

@@ -3,7 +3,7 @@ import getIndexFromRef from './getIndexFromRef';
 /**
  * @param {Buffer} pdf
  * @param {Map} refTable
- * @returns {object}
+ * @returns {Buffer}
  */
 const findObject = (pdf, refTable, ref) => {
   const index = getIndexFromRef(refTable, ref);

packages/placeholder-plain/dist/readPdf.d.ts

@@ -1,19 +1,31 @@
 export default readPdf;
+export type ReadPdfReturnType = {
+    xref: import("./readRefTable").ReadRefTableReturnType;
+    rootRef: string;
+    root: Buffer;
+    infoRef: string;
+    trailerStart: number;
+    previousXrefs: any[];
+    xRefPosition: number;
+};
+/**
+ * @typedef {object} ReadPdfReturnType
+ * @prop {import("./readRefTable").ReadRefTableReturnType} xref
+ * @prop {string} rootRef
+ * @prop {Buffer} root
+ * @prop {string} infoRef
+ * @prop {number} trailerStart
+ * @prop {*[]} previousXrefs
+ * @prop {number} xRefPosition
+ */
 /**
  * Simplified parsing of a PDF Buffer.
  * Extracts reference table, root info and trailer start.
  *
  * See section 7.5.5 (File Trailer) of the PDF specs.
  *
  * @param {Buffer} pdfBuffer
+ * @returns {ReadPdfReturnType}
  */
-declare function readPdf(pdfBuffer: Buffer): {
-    xref: any;
-    rootRef: any;
-    root: any;
-    infoRef: any;
-    trailerStart: number;
-    previousXrefs: any[];
-    xRefPosition: string;
-};
+declare function readPdf(pdfBuffer: Buffer): ReadPdfReturnType;
 //# sourceMappingURL=readPdf.d.ts.map

packages/placeholder-plain/dist/readPdf.js

@@ -1,5 +1,11 @@
 import readRefTable from './readRefTable';
 import findObject from './findObject';
+
+/**
+ * @param {Buffer} trailer
+ * @param {string} key
+ * @returns {string}
+ */
 const getValue = (trailer, key) => {
   let index = trailer.indexOf(key);
   if (index === -1) {
@@ -13,13 +19,25 @@ const getValue = (trailer, key) => {
   return slice.slice(key.length + 1, index).toString().trim(); // key + at least one space
 };
 
+/**
+ * @typedef {object} ReadPdfReturnType
+ * @prop {import("./readRefTable").ReadRefTableReturnType} xref
+ * @prop {string} rootRef
+ * @prop {Buffer} root
+ * @prop {string} infoRef
+ * @prop {number} trailerStart
+ * @prop {*[]} previousXrefs
+ * @prop {number} xRefPosition
+ */
+
 /**
  * Simplified parsing of a PDF Buffer.
  * Extracts reference table, root info and trailer start.
  *
  * See section 7.5.5 (File Trailer) of the PDF specs.
  *
  * @param {Buffer} pdfBuffer
+ * @returns {ReadPdfReturnType}
  */
 const readPdf = pdfBuffer => {
   // Extract the trailer dictionary.

packages/placeholder-plain/dist/readRefTable.d.ts

@@ -4,11 +4,23 @@ export function getXref(pdf: any, position: any): {
     prev: string;
     xRefContent: Map<any, any>;
 };
-export function getFullXrefTable(pdf: any): any;
+export function getFullXrefTable(pdf: Buffer): GetFullXrefTableReturnType;
 export default readRefTable;
+export type GetFullXrefTableReturnType = Map<any, any>;
+export type ReadRefTableReturnType = {
+    startingIndex: number;
+    maxIndex: number;
+    offsets: GetFullXrefTableReturnType;
+};
+/**
+ * @typedef {object} ReadRefTableReturnType
+ * @prop {number} startingIndex
+ * @prop {number} maxIndex
+ * @prop {GetFullXrefTableReturnType} offsets
+ */
 /**
  * @param {Buffer} pdfBuffer
- * @returns {object}
+ * @returns {ReadRefTableReturnType}
  */
-declare function readRefTable(pdf: any): object;
+declare function readRefTable(pdf: any): ReadRefTableReturnType;
 //# sourceMappingURL=readRefTable.d.ts.map

packages/placeholder-plain/dist/readRefTable.js

@@ -52,6 +52,15 @@ export const getXref = (pdf, position) => {
     xRefContent
   };
 };
+
+/**
+ * @typedef {Map<*, *>} GetFullXrefTableReturnType
+ */
+
+/**
+ * @param {Buffer} pdf
+ * @returns {GetFullXrefTableReturnType}
+ */
 export const getFullXrefTable = pdf => {
   const lastTrailerPosition = getLastTrailerPosition(pdf);
   const lastXrefTable = getXref(pdf, lastTrailerPosition);
@@ -64,9 +73,16 @@ export const getFullXrefTable = pdf => {
   return mergedXrefTable;
 };
 
+/**
+ * @typedef {object} ReadRefTableReturnType
+ * @prop {number} startingIndex
+ * @prop {number} maxIndex
+ * @prop {GetFullXrefTableReturnType} offsets
+ */
+
 /**
  * @param {Buffer} pdfBuffer
- * @returns {object}
+ * @returns {ReadRefTableReturnType}
  */
 const readRefTable = pdf => {
   const fullXrefTable = getFullXrefTable(pdf);

packages/placeholder-plain/src/createBufferTrailer.js

@@ -1,3 +1,9 @@
+/**
+ * @param {Buffer} pdf
+ * @param {import("./readPdf").ReadPdfReturnType} info
+ * @param {Map<number, number>} addedReferences
+ * @returns {Buffer}
+ */
 const createBufferTrailer = (pdf, info, addedReferences) => {
     let rows = [];
     rows[0] = '0000000000 65535 f '; // info.xref.tableRows[0];

packages/placeholder-plain/src/findObject.js

@@ -3,7 +3,7 @@ import getIndexFromRef from './getIndexFromRef';
 /**
  * @param {Buffer} pdf
  * @param {Map} refTable
- * @returns {object}
+ * @returns {Buffer}
  */
 const findObject = (pdf, refTable, ref) => {
     const index = getIndexFromRef(refTable, ref);

packages/placeholder-plain/src/readPdf.js

@@ -1,6 +1,11 @@
 import readRefTable from './readRefTable';
 import findObject from './findObject';
 
+/**
+ * @param {Buffer} trailer
+ * @param {string} key
+ * @returns {string}
+ */
 const getValue = (trailer, key) => {
     let index = trailer.indexOf(key);
 
@@ -16,13 +21,25 @@ const getValue = (trailer, key) => {
     return slice.slice(key.length + 1, index).toString().trim(); // key + at least one space
 };
 
+/**
+ * @typedef {object} ReadPdfReturnType
+ * @prop {import("./readRefTable").ReadRefTableReturnType} xref
+ * @prop {string} rootRef
+ * @prop {Buffer} root
+ * @prop {string} infoRef
+ * @prop {number} trailerStart
+ * @prop {*[]} previousXrefs
+ * @prop {number} xRefPosition
+ */
+
 /**
  * Simplified parsing of a PDF Buffer.
  * Extracts reference table, root info and trailer start.
  *
  * See section 7.5.5 (File Trailer) of the PDF specs.
  *
  * @param {Buffer} pdfBuffer
+ * @returns {ReadPdfReturnType}
  */
 const readPdf = (pdfBuffer) => {
     // Extract the trailer dictionary.

packages/placeholder-plain/src/readRefTable.js

@@ -81,6 +81,14 @@ export const getXref = (pdf, position) => {
     };
 };
 
+/**
+ * @typedef {Map<*, *>} GetFullXrefTableReturnType
+ */
+
+/**
+ * @param {Buffer} pdf
+ * @returns {GetFullXrefTableReturnType}
+ */
 export const getFullXrefTable = (pdf) => {
     const lastTrailerPosition = getLastTrailerPosition(pdf);
     const lastXrefTable = getXref(pdf, lastTrailerPosition);
@@ -99,9 +107,16 @@ export const getFullXrefTable = (pdf) => {
     return mergedXrefTable;
 };
 
+/**
+ * @typedef {object} ReadRefTableReturnType
+ * @prop {number} startingIndex
+ * @prop {number} maxIndex
+ * @prop {GetFullXrefTableReturnType} offsets
+ */
+
 /**
  * @param {Buffer} pdfBuffer
- * @returns {object}
+ * @returns {ReadRefTableReturnType}
  */
 const readRefTable = (pdf) => {
     const fullXrefTable = getFullXrefTable(pdf);