|
| 1 | +import { read as readBufferWorkBook } from "xlsx" |
| 2 | +import jsonxlsx, { IContent, IJsonSheet, ISettings } from "../index" |
| 3 | + |
| 4 | +describe("json-as-xlsx", () => { |
| 5 | + it("should return undefined if sheets array is empty", () => { |
| 6 | + const sheets: IJsonSheet[] = [] |
| 7 | + const result = jsonxlsx(sheets) |
| 8 | + expect(result).toBeUndefined() |
| 9 | + }) |
| 10 | + |
| 11 | + describe("writeOptions.type is set to buffer", () => { |
| 12 | + const settings: ISettings = { |
| 13 | + writeOptions: { |
| 14 | + type: "buffer", |
| 15 | + }, |
| 16 | + } |
| 17 | + |
| 18 | + it("should return buffer", () => { |
| 19 | + const sheets = [ |
| 20 | + { |
| 21 | + columns: [{ label: "Name", value: "name" }], |
| 22 | + content: [{ name: "Martin" }], |
| 23 | + }, |
| 24 | + ] |
| 25 | + const buffer = jsonxlsx(sheets, settings) |
| 26 | + expect(buffer).toBeInstanceOf(Buffer) |
| 27 | + }) |
| 28 | + |
| 29 | + it("should return parsable xlsx buffer", () => { |
| 30 | + const sheets = [ |
| 31 | + { |
| 32 | + columns: [{ label: "Name", value: "name" }], |
| 33 | + content: [{ name: "Martin" }], |
| 34 | + }, |
| 35 | + ] |
| 36 | + const buffer = jsonxlsx(sheets, settings) |
| 37 | + const workBook = readBufferWorkBook(buffer) |
| 38 | + |
| 39 | + expect(workBook).toBeDefined() |
| 40 | + }) |
| 41 | + |
| 42 | + it("should return one column filled cells", () => { |
| 43 | + const sheets = [ |
| 44 | + { |
| 45 | + sheet: "Authors", |
| 46 | + columns: [{ label: "Name", value: "name" }], |
| 47 | + content: [{ name: "Martin" }, { name: "Kent" }], |
| 48 | + }, |
| 49 | + ] |
| 50 | + const buffer = jsonxlsx(sheets, settings) |
| 51 | + const workBook = readBufferWorkBook(buffer) |
| 52 | + const workSheet = workBook.Sheets.Authors |
| 53 | + |
| 54 | + expect(workSheet["!ref"]).toBe("A1:A3") |
| 55 | + expect(workSheet.A1.v).toBe("Name") |
| 56 | + expect(workSheet.A2.v).toBe("Martin") |
| 57 | + expect(workSheet.A3.v).toBe("Kent") |
| 58 | + }) |
| 59 | + |
| 60 | + it("should return only the column headers if there is no content", () => { |
| 61 | + const sheetName = "Authors" |
| 62 | + const sheets = [ |
| 63 | + { |
| 64 | + sheet: sheetName, |
| 65 | + columns: [ |
| 66 | + { label: "Name", value: "name" }, |
| 67 | + { label: "Age", value: "age" }, |
| 68 | + ], |
| 69 | + content: [], |
| 70 | + }, |
| 71 | + ] |
| 72 | + const buffer = jsonxlsx(sheets, settings) |
| 73 | + const workBook = readBufferWorkBook(buffer) |
| 74 | + const workSheet = workBook.Sheets[sheetName] |
| 75 | + |
| 76 | + expect(workSheet.A1.v).toBe("Name") |
| 77 | + expect(workSheet.B1.v).toBe("Age") |
| 78 | + }) |
| 79 | + |
| 80 | + it("should handle deep props", () => { |
| 81 | + const sheets = [ |
| 82 | + { |
| 83 | + sheet: "Users", |
| 84 | + columns: [{ label: "IP", value: "metadata.ip" }], |
| 85 | + content: [ |
| 86 | + { name: "Martin", metadata: { ip: "0.0.0.0" } }, |
| 87 | + { name: "Robert", metadata: { ip: "0.0.0.1" } }, |
| 88 | + ], |
| 89 | + }, |
| 90 | + ] |
| 91 | + const buffer = jsonxlsx(sheets, settings) |
| 92 | + const workBook = readBufferWorkBook(buffer) |
| 93 | + const workSheet = workBook.Sheets.Users |
| 94 | + |
| 95 | + expect(workSheet.A1.v).toBe("IP") |
| 96 | + expect(workSheet.A2.v).toBe("0.0.0.0") |
| 97 | + expect(workSheet.A3.v).toBe("0.0.0.1") |
| 98 | + }) |
| 99 | + |
| 100 | + it("should handle function column value", () => { |
| 101 | + const maskPhoneNumber = (cell: IContent): string => new String(cell.phone).replace(/^(\d{3})(\d{4}).*/, "$1-$2") |
| 102 | + |
| 103 | + const sheets = [ |
| 104 | + { |
| 105 | + sheet: "Users", |
| 106 | + columns: [{ label: "Phone number", value: maskPhoneNumber }], |
| 107 | + content: [ |
| 108 | + { name: "Martin", phone: "1234567" }, |
| 109 | + { name: "Robert", phone: "1234568" }, |
| 110 | + ], |
| 111 | + }, |
| 112 | + ] |
| 113 | + const buffer = jsonxlsx(sheets, settings) |
| 114 | + const workBook = readBufferWorkBook(buffer) |
| 115 | + const workSheet = workBook.Sheets.Users |
| 116 | + |
| 117 | + expect(workSheet.A1.v).toBe("Phone number") |
| 118 | + expect(workSheet.A2.v).toBe("123-4567") |
| 119 | + expect(workSheet.A3.v).toBe("123-4568") |
| 120 | + }) |
| 121 | + |
| 122 | + it("should call optional callback", () => { |
| 123 | + const callback = jest.fn() |
| 124 | + const sheets = [ |
| 125 | + { |
| 126 | + columns: [{ label: "Name", value: "name" }], |
| 127 | + content: [{ name: "Martin" }], |
| 128 | + }, |
| 129 | + ] |
| 130 | + jsonxlsx(sheets, settings, callback) |
| 131 | + |
| 132 | + expect(callback).toBeCalledTimes(1) |
| 133 | + }) |
| 134 | + |
| 135 | + it("should handle multiple sheets", () => { |
| 136 | + const sheets = [ |
| 137 | + { |
| 138 | + sheet: "Authors", |
| 139 | + columns: [ |
| 140 | + { label: "Name", value: "name" }, |
| 141 | + { label: "Age", value: "age" }, |
| 142 | + ], |
| 143 | + content: [ |
| 144 | + { name: "Martin", age: 50 }, |
| 145 | + { name: "Robert", age: 20 }, |
| 146 | + { name: "Andrea", age: 35 }, |
| 147 | + ], |
| 148 | + }, |
| 149 | + { |
| 150 | + sheet: "Books", |
| 151 | + columns: [ |
| 152 | + { label: "Title", value: "title" }, |
| 153 | + { label: "Author", value: "author" }, |
| 154 | + ], |
| 155 | + content: [ |
| 156 | + { title: "TDD", author: "Martin" }, |
| 157 | + { title: "Git", author: "Robert" }, |
| 158 | + ], |
| 159 | + }, |
| 160 | + ] |
| 161 | + const buffer = jsonxlsx(sheets, settings) |
| 162 | + const workBook = readBufferWorkBook(buffer) |
| 163 | + |
| 164 | + const authorsSheet = workBook.Sheets.Authors |
| 165 | + const booksSheet = workBook.Sheets.Books |
| 166 | + |
| 167 | + expect(workBook.SheetNames).toEqual(["Authors", "Books"]) |
| 168 | + |
| 169 | + expect(authorsSheet.A1.v).toBe("Name") |
| 170 | + expect(authorsSheet.B1.v).toBe("Age") |
| 171 | + expect(authorsSheet.A2.v).toBe("Martin") |
| 172 | + expect(authorsSheet.B2.v).toBe(50) |
| 173 | + expect(authorsSheet.A3.v).toBe("Robert") |
| 174 | + expect(authorsSheet.B3.v).toBe(20) |
| 175 | + expect(authorsSheet.A4.v).toBe("Andrea") |
| 176 | + expect(authorsSheet.B4.v).toBe(35) |
| 177 | + |
| 178 | + expect(booksSheet.A1.v).toBe("Title") |
| 179 | + expect(booksSheet.B1.v).toBe("Author") |
| 180 | + expect(booksSheet.A2.v).toBe("TDD") |
| 181 | + expect(booksSheet.B2.v).toBe("Martin") |
| 182 | + expect(booksSheet.A3.v).toBe("Git") |
| 183 | + expect(booksSheet.B3.v).toBe("Robert") |
| 184 | + }) |
| 185 | + }) |
| 186 | +}) |
0 commit comments