fix: update typing for various methods

Author: privateOmega

src/helpers/render-document-file.ts

@@ -28,8 +28,8 @@ const convertHTML = HTMLToVDOM({
 
 // eslint-disable-next-line consistent-return, no-shadow
 export const buildImage = async (docxDocumentInstance, vNode: VNodeType, maximumWidth = null) => {
-  let response = null;
-  let base64Uri = null;
+  let response: { id: number; fileContent: string; fileNameWithExtension: string } | null = null;
+  let base64Uri: string | null = null;
   try {
     const imageSource = vNode.properties.src;
     if (isValidUrl(imageSource)) {

src/html-to-docx.ts

@@ -43,11 +43,12 @@ const convertHTML = HTMLToVDOM({
 
 const mergeOptions = <Type>(options: Type, patch: Type): Type => ({ ...options, ...patch });
 
-const fixupFontSize = (fontSize: string | number) => {
+const fixupFontSize = (fontSize?: string | number) => {
   let normalizedFontSize;
   if (typeof fontSize === 'string' && pointRegex.test(fontSize)) {
     const matchedParts = fontSize.match(pointRegex) as RegExpMatchArray;
 
+    // @ts-ignore
     normalizedFontSize = pointToHIP(matchedParts[1]);
   } else if (fontSize) {
     // assuming it is already in HIP
@@ -59,23 +60,33 @@ const fixupFontSize = (fontSize: string | number) => {
   return normalizedFontSize;
 };
 
-const normalizeUnits = (dimensioningObject: Object, defaultDimensionsProperty) => {
-  let normalizedUnitResult: {} | null = {};
+const normalizeUnits = (
+  dimensioningObject: DocumentOptions['pageSize'] | DocumentOptions['margins'],
+  defaultDimensionsProperty: DocumentOptions['pageSize'] | DocumentOptions['margins']
+) => {
+  let normalizedUnitResult: Partial<
+    DocumentOptions['pageSize'] | DocumentOptions['margins']
+  > | null = {};
   if (typeof dimensioningObject === 'object' && dimensioningObject !== null) {
     Object.keys(dimensioningObject).forEach((key) => {
       if (pixelRegex.test(dimensioningObject[key])) {
-        const matchedParts = dimensioningObject[key].match(pixelRegex);
+        const matchedParts = dimensioningObject[key].match(pixelRegex) as RegExpMatchArray;
+        // @ts-ignore
         normalizedUnitResult[key] = pixelToTWIP(matchedParts[1]);
       } else if (cmRegex.test(dimensioningObject[key])) {
-        const matchedParts = dimensioningObject[key].match(cmRegex);
+        const matchedParts = dimensioningObject[key].match(cmRegex) as RegExpMatchArray;
+        // @ts-ignore
         normalizedUnitResult[key] = cmToTWIP(matchedParts[1]);
       } else if (inchRegex.test(dimensioningObject[key])) {
-        const matchedParts = dimensioningObject[key].match(inchRegex);
+        const matchedParts = dimensioningObject[key].match(inchRegex) as RegExpMatchArray;
+        // @ts-ignore
         normalizedUnitResult[key] = inchToTWIP(matchedParts[1]);
       } else if (dimensioningObject[key]) {
+        // @ts-ignore
         normalizedUnitResult[key] = dimensioningObject[key];
       } else {
         // incase value is something like 0
+        // @ts-ignore
         normalizedUnitResult[key] = defaultDimensionsProperty[key];
       }
     });
@@ -96,6 +107,7 @@ const normalizeDocumentOptions = (
     switch (key) {
       case 'pageSize':
       case 'margins':
+        // @ts-ignore
         normalizedDocumentOptions[key] = normalizeUnits(
           documentOptions[key],
           defaultDocumentOptions[key]
@@ -142,6 +154,7 @@ async function addFilesToContainer(
   // Conversion to Word XML happens here
   docxDocument.documentXML = await renderDocumentFile(docxDocument);
 
+  // @ts-ignore
   zip
     .folder(relsFolderName)
     .file(
@@ -150,6 +163,7 @@ async function addFilesToContainer(
       { createFolders: false }
     );
 
+  // @ts-ignore
   zip.folder('docProps').file('core.xml', docxDocument.generateCoreXML(), {
     createFolders: false,
   });
@@ -169,6 +183,7 @@ async function addFilesToContainer(
       internalRelationship
     );
 
+    // @ts-ignore
     zip.folder(wordFolder).file(fileNameWithExt, headerXML.toString({ prettyPrint: true }), {
       createFolders: false,
     });
@@ -190,6 +205,7 @@ async function addFilesToContainer(
       internalRelationship
     );
 
+    // @ts-ignore
     zip.folder(wordFolder).file(fileNameWithExt, footerXML.toString({ prettyPrint: true }), {
       createFolders: false,
     });
@@ -203,13 +219,15 @@ async function addFilesToContainer(
     `${themeFolder}/${themeFileNameWithExt}`,
     internalRelationship
   );
+  // @ts-ignore
   zip
     .folder(wordFolder)
     .folder(themeFolder)
     .file(themeFileNameWithExt, docxDocument.generateThemeXML(), {
       createFolders: false,
     });
 
+  // @ts-ignore
   zip
     .folder(wordFolder)
     .file('document.xml', docxDocument.generateDocumentXML(), { createFolders: false })
@@ -222,6 +240,7 @@ async function addFilesToContainer(
   const relationshipXMLs = docxDocument.generateRelsXML();
   if (relationshipXMLs && Array.isArray(relationshipXMLs)) {
     relationshipXMLs.forEach(({ fileName, xmlString }) => {
+      // @ts-ignore
       zip.folder(wordFolder).folder(relsFolderName).file(`${fileName}.xml.rels`, xmlString, {
         createFolders: false,
       });