json-as-xlsx 2.3.4 → 2.3.9

package/README.md

@@ -50,7 +50,7 @@ xlsx(data, settings) // Will download the excel file
 
 ## Examples
 
-This are files used for development, please change imports from `./index.js` to `json-as-xlsx`
+This are files used for development, please change imports from `../../src/index.js` to `json-as-xlsx`
 
-* [VueJS with JavaScript](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/src/App.vue)
-* [Express with TypeScript](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/server.ts)
+* [VueJS with JavaScript](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/examples/vue-app/App.vue)
+* [Express with TypeScript](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/examples/express/server.ts)

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "json-as-xlsx",
-  "version": "2.3.4",
-  "main": "index.js",
+  "version": "2.3.9",
+  "main": "src/index.ts",
   "license": "MIT",
   "types": "types/index.d.ts",
   "description": "Create excel xlsx file from json",
   "author": "LuisEnMarroquin <luis@marroquin.dev>",
   "homepage": "https://xlsx.marroquin.dev",
   "scripts": {
-    "start": "tsc --watch index.ts",
-    "build": "tsc index.ts && uglifyjs index.js --output index.js",
+    "start": "tsc --watch src/index.ts",
+    "build": "tsc src/index.ts && uglifyjs src/index.js --output src/index.js",
     "start-client": "vue-cli-service serve",
     "build-client": "vue-cli-service build",
-    "start-server": "npx nodemon --exec npx ts-node --skip-project server.ts",
+    "start-server": "npx nodemon --exec npx ts-node --skip-project examples/express/server.ts",
     "lint": "ts-standard --fix",
     "test": "jest"
   },
@@ -23,7 +23,7 @@
     "@types/express": "^4.17.13",
     "@types/jest": "^27.0.2",
     "@types/node": "^17.0.0",
-    "@vue/cli-service": "^3.12.1",
+    "@vue/cli-service": "^4.5.15",
     "express": "^4.17.1",
     "jest": "^27.3.1",
     "ts-jest": "^27.0.7",
@@ -34,7 +34,7 @@
     "vue-template-compiler": "^2.6.14"
   },
   "files": [
-    "index.js",
+    "src/index.js",
     "types/index.d.ts"
   ],
   "repository": {
@@ -50,7 +50,6 @@
     "excel",
     "jsonc",
     "json-xlsx",
-    "microsoft",
     "xlsx-json",
     "create-xlsx",
     "create-excel",
@@ -58,8 +57,10 @@
     "json-to-xlsx",
     "json-as-excel",
     "json-to-excel",
-    "microsoft-xlsx",
+    "xlsx-as-json",
     "xlsx-from-json",
+    "microsoft",
+    "microsoft-xlsx",
     "microsoft-excel"
   ],
   "browserslist": [

package/src/index.ts

@@ -0,0 +1,110 @@
+import { utils, WorkBook, WorkSheet, write, writeFile } from 'xlsx/dist/xlsx.mini.min'
+import { IColumn, IContent, IJsonSheet, IJsonSheetRow, ISettings, IWorksheetColumnWidth } from '../types/index'
+
+const getContentProperty = (content: IContent, property: string): string | number | boolean | Date | IContent => {
+  const accessContentProperties = (content: IContent, properties: string[]): string | number | boolean | Date | IContent => {
+    const value = content[properties[0]]
+
+    if (properties.length === 1) {
+      return value ?? ''
+    }
+
+    if (value === undefined || typeof value === 'string' || typeof value === 'boolean' ||
+      typeof value === 'number' || value instanceof Date) {
+      return ''
+    }
+
+    return accessContentProperties(value, properties.slice(1))
+  }
+
+  const properties = property.split('.')
+  return accessContentProperties(content, properties)
+}
+
+const getJsonSheetRow = (content: IContent, columns: IColumn[]): IJsonSheetRow => {
+  const jsonSheetRow: IJsonSheetRow = {}
+  columns.forEach((column) => {
+    if (typeof column.value === 'function') {
+      jsonSheetRow[column.label] = column.value(content)
+    } else {
+      jsonSheetRow[column.label] = getContentProperty(content, column.value)
+    }
+  })
+  return jsonSheetRow
+}
+
+const getWorksheetColumnWidths = (worksheet: WorkSheet, extraLength: number = 1): IWorksheetColumnWidth[] => {
+  const columnRange = utils.decode_range(worksheet['!ref'] ?? '')
+
+  // Column letters present in the workbook, e.g. A, B, C
+  const columnLetters: string[] = []
+  for (let C = columnRange.s.c; C <= columnRange.e.c; C++) {
+    const address = utils.encode_col(C)
+    columnLetters.push(address)
+  }
+
+  return columnLetters.map((column) => {
+    // Cells that belong to this column
+    const columnCells: string[] = Object.keys(worksheet).filter((cell) => {
+      return cell.charAt(0) === column || cell.slice(0, 2) === column
+    })
+
+    const maxWidthCell = columnCells.reduce((previousCell, currentCell) => {
+      return worksheet[previousCell].v.length > worksheet[currentCell].v.length
+        ? previousCell
+        : currentCell
+    })
+
+    return { width: worksheet[maxWidthCell].v.length as number + extraLength }
+  })
+}
+
+const getWorksheet = (jsonSheet: IJsonSheet, settings: ISettings): WorkSheet => {
+  let jsonSheetRows: IJsonSheetRow[]
+
+  if (jsonSheet.content.length > 0) {
+    jsonSheetRows = jsonSheet.content.map((contentItem) => {
+      return getJsonSheetRow(contentItem, jsonSheet.columns)
+    })
+  } else {
+    // If there's no content, show only column labels
+    jsonSheetRows = jsonSheet.columns.map((column) => ({ [column.label]: '' }))
+  }
+
+  const worksheet = utils.json_to_sheet(jsonSheetRows)
+  worksheet['!cols'] = getWorksheetColumnWidths(worksheet, settings.extraLength)
+
+  return worksheet
+}
+
+const writeWorkbook = (workbook: WorkBook, settings: ISettings = {}): Buffer | undefined => {
+  const filename = `${settings.fileName ?? 'Spreadsheet'}.xlsx`
+  const writeOptions = settings.writeOptions ?? {}
+
+  return writeOptions.type === 'buffer'
+    ? write(workbook, writeOptions)
+    : writeFile(workbook, filename, writeOptions)
+}
+
+type IWorkbookCallback = (workbook: WorkBook) => void
+
+const xlsx = (jsonSheets: IJsonSheet[], settings: ISettings = {}, workbookCallback: IWorkbookCallback = () => { }): Buffer | undefined => {
+  if (jsonSheets.length === 0) return
+
+  const workbook = utils.book_new() // Creating a workbook, this is the name given to an Excel file
+  jsonSheets.forEach((actualSheet, actualIndex) => {
+    const worksheet = getWorksheet(actualSheet, settings)
+    const worksheetName = actualSheet.sheet ?? `Sheet ${actualIndex + 1}`
+    utils.book_append_sheet(workbook, worksheet, worksheetName) // Add Worksheet to Workbook
+  })
+
+  workbookCallback(workbook)
+  return writeWorkbook(workbook, settings)
+}
+
+export default xlsx
+export { getContentProperty, getJsonSheetRow, getWorksheetColumnWidths }
+module.exports = xlsx
+module.exports.getContentProperty = getContentProperty
+module.exports.getJsonSheetRow = getJsonSheetRow
+module.exports.getWorksheetColumnWidths = getWorksheetColumnWidths