Merge pull request #83 from cjxe/main

fix: type `null` is not assignable to type `IContent`
LuisEnMarroquin · Aug 24, 2023 · c243fef · c243fef
2 parents daeee56 + 95825e8
commit c243fef
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 5 deletions.
diff --git a/packages/main-library/package.json b/packages/main-library/package.json
@@ -1,6 +1,6 @@
 {
   "name": "json-as-xlsx",
-  "version": "2.5.3",
+  "version": "2.5.4",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/packages/main-library/src/__tests__/index.test.ts b/packages/main-library/src/__tests__/index.test.ts
@@ -182,5 +182,25 @@ describe("json-as-xlsx", () => {
       expect(booksSheet.A3.v).toBe("Git")
       expect(booksSheet.B3.v).toBe("Robert")
     })
+
+    it("should allow null value in content", () => {
+      const sheets = [
+        {
+          sheet: "Users",
+          columns: [{ label: "IP", value: "metadata.ip" }],
+          content: [
+            { name: "Martin", metadata: { ip: null } },
+            { name: "Robert", metadata: { ip: null } },
+          ],
+        },
+      ]
+      const buffer = jsonxlsx(sheets, settings)
+      const workBook = readBufferWorkBook(buffer)
+      const workSheet = workBook.Sheets.Users
+
+      expect(workSheet.A1.v).toBe("IP")
+      expect(workSheet.A2.v).toBe("")
+      expect(workSheet.A3.v).toBe("")
+    })
   })
 })
diff --git a/packages/main-library/src/index.ts b/packages/main-library/src/index.ts
@@ -2,7 +2,7 @@ import { utils, WorkBook, WorkSheet, write, writeFile, WritingOptions } from "xl
 
 export interface IColumn {
   label: string
-  value: string | ((value: IContent) => string | number | boolean | Date | IContent)
+  value: string | ((value: IContent) => string | number | boolean | Date | IContent | null)
   format?: string
 }
 
@@ -25,7 +25,7 @@ export interface ISettings {
 }
 
 export interface IJsonSheetRow {
-  [key: string]: string | number | boolean | Date | IContent
+  [key: string]: string | number | boolean | Date | IContent | null
 }
 
 export interface IWorksheetColumnWidth {
@@ -44,7 +44,7 @@ export const getContentProperty = (content: IContent, property: string): string
       return value ?? ""
     }
 
-    if (value === undefined || typeof value === "string" || typeof value === "boolean" || typeof value === "number" || value instanceof Date) {
+    if (value === undefined || value === null || typeof value === "string" || typeof value === "boolean" || typeof value === "number" || value instanceof Date) {
       return ""
     }
 
@@ -213,4 +213,4 @@ module.exports = xlsx
 module.exports.getContentProperty = getContentProperty
 module.exports.getJsonSheetRow = getJsonSheetRow
 module.exports.getWorksheetColumnWidths = getWorksheetColumnWidths
-module.exports.utils = utils
+module.exports.utils = utils