json-as-xlsx 2.2.0 → 2.2.4

package/README.md

@@ -50,19 +50,61 @@ xlsx(data, settings) // Will download the excel file
 
 ### TypeScript
 
+Here is an example of a server setup using TS, thanks to @elyse0 for the contribution
+
 ```ts
-const jsonSheets: IJsonSheet[] = [{
-  sheet: "Friends",
-  columns: [
-    { label: "Name", value: "name" },
-    { label: "Username", value: "username" }
-  ],
-  content: [
-    { name: "Andreas", username: "andr34s" }
-  ]
-}]
-
-xlsx(jsonSheets)
+import xlsx, { IJsonSheet, ISettings } from 'json-as-xlsx'
+import express from 'express'
+
+const app = express()
+app.use(express.json())
+app.use(express.urlencoded({ extended: true }))
+
+const data: IJsonSheet[] = [
+  {
+    sheet: 'Adults',
+    columns: [
+      { label: 'User', value: 'user' },
+      { label: 'Age', value: 'age' }
+    ],
+    content: [
+      { user: 'Andrea', age: 20, more: { phone: '11111111' } },
+      { user: 'Luis', age: 21, more: { phone: '12345678' } }
+    ]
+  }, {
+    sheet: 'Children',
+    columns: [
+      { label: 'User', value: 'user' },
+      { label: 'Age', value: 'age' }
+    ],
+    content: [
+      { user: 'Manuel', age: 16, more: { phone: '99999999' } },
+      { user: 'Ana', age: 17, more: { phone: '87654321' } }
+    ]
+  }
+]
+
+const settings: ISettings = {
+  writeOptions: {
+    type: 'buffer',
+    bookType: 'xlsx'
+  }
+}
+
+app.get('/', (_, res) => {
+  const buffer = xlsx(data, settings)
+  res.writeHead(200, {
+    'Content-Type': 'application/octet-stream',
+    'Content-disposition': 'attachment; filename=MySheet.xlsx'
+  })
+  res.end(buffer)
+})
+
+const port = process.env.PORT ?? 3000
+
+app.listen(port, () => {
+  console.log(`Your app is listening on port ${port}`)
+})
 ```
 
 ## Examples

package/index.js

@@ -1 +1 @@
-"use strict";exports.__esModule=true;exports.getWorksheetColumnWidths=exports.getJsonSheetRow=exports.getContentProperty=void 0;var xlsx_1=require("xlsx");function getContentProperty(content,property){function accessContentProperties(content,properties){var value=content[properties[0]];if(properties.length===1){return value!==null&&value!==void 0?value:""}if(value===undefined||typeof value==="string"||typeof value==="boolean"||typeof value==="number"||value instanceof Date){return""}return accessContentProperties(value,properties.slice(1))}var properties=property.split(".");return accessContentProperties(content,properties)}exports.getContentProperty=getContentProperty;function getJsonSheetRow(content,columns){var jsonSheetRow={};columns.forEach(function(column){if(typeof column.value==="function"){jsonSheetRow[column.label]=column.value(content)}else{jsonSheetRow[column.label]=getContentProperty(content,column.value)}});return jsonSheetRow}exports.getJsonSheetRow=getJsonSheetRow;function getWorksheetColumnWidths(worksheet,extraLength){var _a;if(extraLength===void 0){extraLength=1}var columnRange=xlsx_1.utils.decode_range((_a=worksheet["!ref"])!==null&&_a!==void 0?_a:"");var columnLetters=[];for(var C=columnRange.s.c;C<=columnRange.e.c;C++){var address=xlsx_1.utils.encode_col(C);columnLetters.push(address)}return columnLetters.map(function(column){var columnCells=Object.keys(worksheet).filter(function(cell){return cell.charAt(0)===column});var maxWidthCell=columnCells.reduce(function(previousCell,currentCell){return worksheet[previousCell].v.length>worksheet[currentCell].v.length?previousCell:currentCell});return{width:worksheet[maxWidthCell].v.length+extraLength}})}exports.getWorksheetColumnWidths=getWorksheetColumnWidths;function getWorksheet(jsonSheet,settings){var jsonSheetRows=jsonSheet.content.map(function(contentItem){return getJsonSheetRow(contentItem,jsonSheet.columns)});var worksheet=xlsx_1.utils.json_to_sheet(jsonSheetRows);worksheet["!cols"]=getWorksheetColumnWidths(worksheet,settings.extraLength);return worksheet}function writeWorkbook(workbook,settings){var _a,_b;if(settings===void 0){settings={}}var filename=((_a=settings.fileName)!==null&&_a!==void 0?_a:"Spreadsheet")+".xlsx";var writeOptions=(_b=settings.writeOptions)!==null&&_b!==void 0?_b:{};return writeOptions.type==="buffer"?(0,xlsx_1.write)(workbook,writeOptions):(0,xlsx_1.writeFile)(workbook,filename,writeOptions)}function xlsx(jsonSheets,settings){if(settings===void 0){settings={}}if(jsonSheets.length===0){return}var workbook=xlsx_1.utils.book_new();jsonSheets.forEach(function(actualSheet,actualIndex){var _a;var worksheet=getWorksheet(actualSheet,settings);var worksheetName=(_a=actualSheet.sheet)!==null&&_a!==void 0?_a:"Sheet "+(actualIndex+1);xlsx_1.utils.book_append_sheet(workbook,worksheet,worksheetName)});return writeWorkbook(workbook,settings)}exports["default"]=xlsx;module.exports=xlsx;module.exports.getContentProperty=getContentProperty;module.exports.getJsonSheetRow=getJsonSheetRow;module.exports.getWorksheetColumnWidths=getWorksheetColumnWidths;
+"use strict";exports.__esModule=true;exports.getWorksheetColumnWidths=exports.getJsonSheetRow=exports.getContentProperty=void 0;var xlsx_1=require("xlsx");function getContentProperty(content,property){function accessContentProperties(content,properties){var value=content[properties[0]];if(properties.length===1){return value!==null&&value!==void 0?value:""}if(value===undefined||typeof value==="string"||typeof value==="boolean"||typeof value==="number"||value instanceof Date){return""}return accessContentProperties(value,properties.slice(1))}var properties=property.split(".");return accessContentProperties(content,properties)}exports.getContentProperty=getContentProperty;function getJsonSheetRow(content,columns){var jsonSheetRow={};columns.forEach(function(column){if(typeof column.value==="function"){jsonSheetRow[column.label]=column.value(content)}else{jsonSheetRow[column.label]=getContentProperty(content,column.value)}});return jsonSheetRow}exports.getJsonSheetRow=getJsonSheetRow;function getWorksheetColumnWidths(worksheet,extraLength){var _a;if(extraLength===void 0){extraLength=1}var columnRange=xlsx_1.utils.decode_range((_a=worksheet["!ref"])!==null&&_a!==void 0?_a:"");var columnLetters=[];for(var C=columnRange.s.c;C<=columnRange.e.c;C++){var address=xlsx_1.utils.encode_col(C);columnLetters.push(address)}return columnLetters.map(function(column){var columnCells=Object.keys(worksheet).filter(function(cell){return cell.charAt(0)===column||cell.slice(0,2)===column});var maxWidthCell=columnCells.reduce(function(previousCell,currentCell){return worksheet[previousCell].v.length>worksheet[currentCell].v.length?previousCell:currentCell});return{width:worksheet[maxWidthCell].v.length+extraLength}})}exports.getWorksheetColumnWidths=getWorksheetColumnWidths;function getWorksheet(jsonSheet,settings){var jsonSheetRows;if(jsonSheet.content.length>0){jsonSheetRows=jsonSheet.content.map(function(contentItem){return getJsonSheetRow(contentItem,jsonSheet.columns)})}else{jsonSheetRows=jsonSheet.columns.map(function(column){var _a;return _a={},_a[column.label]="",_a})}var worksheet=xlsx_1.utils.json_to_sheet(jsonSheetRows);worksheet["!cols"]=getWorksheetColumnWidths(worksheet,settings.extraLength);return worksheet}function writeWorkbook(workbook,settings){var _a,_b;if(settings===void 0){settings={}}var filename=((_a=settings.fileName)!==null&&_a!==void 0?_a:"Spreadsheet")+".xlsx";var writeOptions=(_b=settings.writeOptions)!==null&&_b!==void 0?_b:{};return writeOptions.type==="buffer"?(0,xlsx_1.write)(workbook,writeOptions):(0,xlsx_1.writeFile)(workbook,filename,writeOptions)}function xlsx(jsonSheets,settings){if(settings===void 0){settings={}}if(jsonSheets.length===0){return}var workbook=xlsx_1.utils.book_new();jsonSheets.forEach(function(actualSheet,actualIndex){var _a;var worksheet=getWorksheet(actualSheet,settings);var worksheetName=(_a=actualSheet.sheet)!==null&&_a!==void 0?_a:"Sheet "+(actualIndex+1);xlsx_1.utils.book_append_sheet(workbook,worksheet,worksheetName)});return writeWorkbook(workbook,settings)}exports["default"]=xlsx;module.exports=xlsx;module.exports.getContentProperty=getContentProperty;module.exports.getJsonSheetRow=getJsonSheetRow;module.exports.getWorksheetColumnWidths=getWorksheetColumnWidths;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-as-xlsx",
-  "version": "2.2.0",
+  "version": "2.2.4",
   "main": "index.js",
   "license": "MIT",
   "description": "Create excel from json",
@@ -21,7 +21,7 @@
   "devDependencies": {
     "@types/jest": "^27.0.2",
     "@types/node": "^16.10.2",
-    "@vue/cli-service": "^4.5.13",
+    "@vue/cli-service": "^3.12.1",
     "express": "^4.17.1",
     "jest": "^27.3.1",
     "ts-jest": "^27.0.7",
@@ -35,7 +35,8 @@
     "ts-standard": "^10.0.0"
   },
   "files": [
-    "index.js"
+    "index.js",
+    "types/index.d.ts"
   ],
   "repository": {
     "type": "git",

package/types/index.d.ts

@@ -0,0 +1,34 @@
+import { WritingOptions } from 'xlsx'
+
+export interface IColumn {
+  label: string
+  value: string | ((value: IContent) => string | number | boolean | Date | IContent)
+}
+
+export interface IContent {
+  [key: string]: string | number | boolean | Date | IContent
+}
+
+export interface IJsonSheet {
+  sheet?: string
+  columns: IColumn[]
+  content: IContent[]
+}
+
+export interface ISettings {
+  extraLength?: number
+  fileName?: string
+  writeOptions?: WritingOptions
+}
+
+export interface IJsonSheetRow {
+  [key: string]: string | number | boolean | Date | IContent
+}
+
+export interface IWorksheetColumnWidth {
+  width: number
+}
+
+export function xlsx (jsonSheets: IJsonSheet[], settings?: ISettings): Buffer | undefined
+
+export default xlsx