0.7.1 - Extract several types into interfaces.

Author: TeamworkGuy2

CHANGELOG.md

@@ -4,7 +4,13 @@ This project does its best to adhere to [Semantic Versioning](http://semver.org/
 
 
 --------
-### [0.7.0](N/A) - 2021-06-12
+### [0.7.1](N/A) - 2021-07-08
+#### Changed
+* Extract several parameter and field types into public interfaces
+
+
+--------
+### [0.7.0](https://github.com/TeamworkGuy2/excel-builder-ts/commit/9a1e834a13c844fc4cdc944e8b8409c3695207ef) - 2021-06-12
 #### Changed
 * Update to TypeScript 4.3
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "excel-builder-ts",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "TypeScript Port of excel-builder.js - A way to build excel files with javascript",
   "author": "TeamworkGuy2",
   "homepage": "https://github.com/TeamworkGuy2/excel-builder-ts",

workbook/Workbook.ts

@@ -37,15 +37,7 @@ class Workbook {
     worksheets: Worksheet[];
     tables: Workbook.Table[];
     drawings: Workbook.Drawing[];
-    media: {
-        [id: string]: {
-            id: string;
-            data: any;
-            fileName: string;
-            contentType: string;
-            extension: string;
-        }
-    };
+    media: { [id: string]: Workbook.Media };
     printTitles: {
         [sheetName: string]: {
             top?: number;
@@ -529,6 +521,15 @@ module Workbook {
         toXML(): string;
     }
 
+
+    export interface Media {
+        id: string;
+        data: any;
+        fileName: string;
+        contentType: string;
+        extension: string;
+    }
+
 }
 
 export = Workbook;

worksheet/StyleSheet.js

@@ -349,7 +349,7 @@ var StyleSheet = /** @class */ (function () {
         return records;
     };
     StyleSheet.prototype.exportCellFormatElement = function (doc, styleInstructions) {
-        var xf = doc.createElement("xf"), i = 0;
+        var xf = doc.createElement("xf");
         var allowed = ["applyAlignment", "applyBorder", "applyFill", "applyFont", "applyNumberFormat",
             "applyProtection", "borderId", "fillId", "fontId", "numFmtId", "pivotButton", "quotePrefix", "xfId"];
         var attributes = Object.keys(styleInstructions).filter(function (key) { return allowed.indexOf(key) != -1; });

worksheet/StyleSheet.ts

@@ -396,7 +396,7 @@ class StyleSheet {
 
 
     public exportCellFormatElement(doc: XmlDom, styleInstructions: StyleSheet.CellFormat) {
-        var xf = doc.createElement("xf"), i = 0;
+        var xf = doc.createElement("xf");
         var allowed = ["applyAlignment", "applyBorder", "applyFill", "applyFont", "applyNumberFormat",
             "applyProtection", "borderId", "fillId", "fontId", "numFmtId", "pivotButton", "quotePrefix", "xfId"]
         var attributes = <(keyof StyleSheet.CellFormat)[]>Object.keys(styleInstructions).filter((key) => allowed.indexOf(key) != -1);

worksheet/Worksheet.ts

@@ -39,27 +39,9 @@ class Worksheet {
     /** An array of attributes to apply to the 'pageSetup' element of the spreadsheet */
     pageSetup: { [prop: string]: any } | null;
     /** An array of attributes (only "ref" Ex: "A1:D1" for now) to apply to the autoFilter element of the spreadsheet. Only one autoFilter per Worksheet */
-    autoFilter: {
-        /** Letter portion of cell name that defines left to right where filter database starts at */
-        left: string;
-        /** Letter portion of cell name that defines left to right where filter database ends at */
-        right: string;
-        /** Row Number autFilter is applied to */
-        rowNum: number;
-    } | null;
+    autoFilter: Worksheet.AutoFilter | null;
     /** An array of attributes to apply to the 'extLst' element of a worksheet. Used for creating "Data Validations" or drop downs with specific data sets. */
-    dataValidations: {
-        /** cell where data validation drop down is */
-        sqref: string;
-        /** sheet where data is stored */
-        dataSheetName: string;
-        /** Column where data set sits */
-        column: string;
-        /** Row where data set starts */
-        topRow: number;
-        /** Row where data set ends */
-        bottomRow: number;
-    }[] | null;
+    dataValidations: Worksheet.DataValidation[] | null;
 
 
     /**
@@ -150,18 +132,12 @@ class Worksheet {
     //}
 
 
-    public setAutoFilter(autoFilter: { left: string; right: string; rowNum: number } | null) {
+    public setAutoFilter(autoFilter: Worksheet.AutoFilter | null) {
         this.autoFilter = autoFilter;
     }
 
 
-    public setDataValidations(dataValidations: {
-        sqref: string;
-        dataSheetName: string;
-        column: string;
-        topRow: number;
-        bottomRow: number;
-    }[]) {
+    public setDataValidations(dataValidations: Worksheet.DataValidation[]) {
         this.dataValidations = dataValidations;
     }
 
@@ -216,7 +192,7 @@ class Worksheet {
      * @param piece
      * @returns string | reduce
      */
-    public compilePageDetailPiece(piece: string | { font?: number; bold?: boolean; underline?: boolean; fontSize?: number; text?: string; [id: string]: any } | any[]): string {
+    public compilePageDetailPiece(piece: string | Worksheet.PageDetailPiece | Worksheet.PageDetailPiece[]): string {
         if (typeof piece === "string") {
             return '&"-,Regular"'.concat(piece);
         }
@@ -700,6 +676,16 @@ class Worksheet {
 
 module Worksheet {
 
+    export interface AutoFilter {
+        /** Letter portion of cell name that defines left to right where filter database starts at */
+        left: string;
+        /** Letter portion of cell name that defines left to right where filter database ends at */
+        right: string;
+        /** Row Number autFilter is applied to */
+        rowNum: number;
+    }
+
+
     export interface Column {
         min?: number;
         max?: number;
@@ -724,6 +710,20 @@ module Worksheet {
     }
 
 
+    export interface DataValidation {
+        /** cell where data validation drop down is */
+        sqref: string;
+        /** sheet where data is stored */
+        dataSheetName: string;
+        /** Column where data set sits */
+        column: string;
+        /** Row where data set starts */
+        topRow: number;
+        /** Row where data set ends */
+        bottomRow: number;
+    }
+
+
     export interface ExportData {
         id: string;
         name: string;
@@ -749,6 +749,16 @@ module Worksheet {
         footer?: string | number;
     }
 
+
+    export interface PageDetailPiece {
+        font?: number;
+        bold?: boolean;
+        underline?: boolean;
+        fontSize?: number;
+        text?: string;
+        [id: string]: any;
+    }
+
 }
 
 export = Worksheet;