0.4.0 - Update TypeScript 2.8. Modify ExcelBuilder.createFile() JSZip parameter so JSZip is only required by ZipWorker. Add tsconfig 'strictNullChecks', 'noImplicitReturns', and 'forceConsistentCasingInFileNames'. Add npm script 'build-package' for release tarball.

Author: TeamworkGuy2

CHANGELOG.md

@@ -4,7 +4,18 @@ This project does its best to adhere to [Semantic Versioning](http://semver.org/
 
 
 --------
-### [0.3.2](N/A) - 2018-02-28
+### [0.4.0](https://github.com/TeamworkGuy2/excel-builder-ts/commit/3e3b0e09a3ff939db25b3d5d83537adc213ad5f5) - 2018-04-14
+#### Changed
+* Update to TypeScript 2.8
+* Update tsconfig.json with `strictNullChecks: true`, `noImplicitReturns: true` and `forceConsistentCasingInFileNames: true`
+* Added release tarball and npm script `build-package` to package.json referencing external process to generate tarball
+* Cleanup JSZip dependency:
+  * `ExcelBuilder.createFile()` now requires a JSZip instance or object with `file()` method instead of creating a JSZip instance from a constructor function and generating the zip file. i.e. use `ExcelBuilder.createFile(new JSZip(), ...).generateAsync(...)` instead of previously using `ExcelBuilder.createFile(JSZip, ...)`
+  * `JSZip` is only required if using `ZipWorker`
+
+
+--------
+### [0.3.2](https://github.com/TeamworkGuy2/excel-builder-ts/commit/ce1061e1897a1b369c97a2d70d3da05510926b20) - 2018-02-28
 #### Changed
 * Update to TypeScript 2.7
 * Update dependencies: mocha, @types/chai, @types/mocha

ExcelBuilder.js

@@ -1,5 +1,4 @@
 "use strict";
-/// <reference path="../definitions/jszip/jszip.d.ts" />
 var Workbook = require("./workbook/Workbook");
 /**
  * @name Excel
@@ -23,7 +22,7 @@ var ExcelBuilder = /** @class */ (function () {
      * options.base64 Whether to 'return' the generated file as a base64 string
      * options.success The callback function to run after workbook creation is successful.
      * options.error The callback function to run if there is an error creating the workbook.
-     * options.requireJsPath (Optional) The path to requirejs. Will use the id 'requirejs' to look up the script if not specified.
+     * options.requireJsPath The path to requirejs.
      */
     ExcelBuilder.createFileAsync = function (workbook, options, jszipPath, zipWorkerPath, worksheetExportWorkerPath) {
         workbook.generateFilesAsync({
@@ -46,13 +45,13 @@ var ExcelBuilder = /** @class */ (function () {
             }
         }, worksheetExportWorkerPath);
     };
-    /** Turns a workbook into a downloadable file.
-     * @param jszip A JSZip equivalent library to use to generate/zip the excel file
+    /** Generates the xml/binary data files for a workbook and loads them into the provided object.
+     * @param zip A JSZip library equivalent object with a file() method to add all the xlsx files to
      * @param workbook The workbook that is being converted
-     * @param options - options to modify how the excel doc is created. Only accepts a base64 boolean at the moment.
+     * @param options options to modify how the excel doc is created. Only accepts a base64 boolean at the moment.
+     * @returns the JSZip style object
      */
-    ExcelBuilder.createFile = function (jszip, workbook, options) {
-        var zip = new jszip();
+    ExcelBuilder.createFile = function (zip, workbook) {
         var files = workbook.generateFiles();
         Object.keys(files).forEach(function (path) {
             var content = files[path];
@@ -64,9 +63,7 @@ var ExcelBuilder = /** @class */ (function () {
                 zip.file(path, content, { base64: true, binary: true });
             }
         });
-        return zip.generateAsync({
-            base64: (!options || options.base64 !== false)
-        });
+        return zip;
     };
     return ExcelBuilder;
 }());

ExcelBuilder.ts

@@ -1,6 +1,5 @@
-/// <reference path="../definitions/jszip/jszip.d.ts" />
-
 import Workbook = require("./workbook/Workbook");
+import XmlDom = require("./xml/XmlDom")
 
 /**
  * @name Excel
@@ -25,9 +24,9 @@ class ExcelBuilder {
      * options.base64 Whether to 'return' the generated file as a base64 string
      * options.success The callback function to run after workbook creation is successful.
      * options.error The callback function to run if there is an error creating the workbook.
-     * options.requireJsPath (Optional) The path to requirejs. Will use the id 'requirejs' to look up the script if not specified.
+     * options.requireJsPath The path to requirejs.
      */
-    static createFileAsync(workbook: Workbook, options: { base64: boolean; error: () => void; requireJsPath?: string; success: (data: any) => void; }, jszipPath: string, zipWorkerPath: string, worksheetExportWorkerPath: string) {
+    static createFileAsync(workbook: Workbook, options: { base64: boolean; error: () => void; requireJsPath: string; success: (data: any) => void; }, jszipPath: string, zipWorkerPath: string, worksheetExportWorkerPath: string) {
 
         workbook.generateFilesAsync({
             requireJsPath: options.requireJsPath,
@@ -51,26 +50,25 @@ class ExcelBuilder {
     }
 
 
-    /** Turns a workbook into a downloadable file.
-     * @param jszip A JSZip equivalent library to use to generate/zip the excel file
+    /** Generates the xml/binary data files for a workbook and loads them into the provided object.
+     * @param zip A JSZip library equivalent object with a file() method to add all the xlsx files to
      * @param workbook The workbook that is being converted
-     * @param options - options to modify how the excel doc is created. Only accepts a base64 boolean at the moment.
+     * @param options options to modify how the excel doc is created. Only accepts a base64 boolean at the moment.
+     * @returns the JSZip style object
      */
-    static createFile(jszip: typeof JSZip, workbook: Workbook, options?: { base64?: boolean; }) {
-        var zip = new jszip();
+    static createFile<F extends { file(path: string, content: string | XmlDom, opts?: { base64?: boolean; binary?: boolean }): void }>(zip: F, workbook: Workbook): F {
         var files = workbook.generateFiles();
         Object.keys(files).forEach(function (path) {
             var content = files[path];
             path = path.substr(1);
             if (path.indexOf(".xml") !== -1 || path.indexOf(".rel") !== -1) {
                 zip.file(path, content, { base64: false });
-            } else {
+            }
+            else {
                 zip.file(path, content, { base64: true, binary: true });
             }
-        })
-        return zip.generateAsync({
-            base64: (!options || options.base64 !== false)
         });
+        return zip;
     }
 
 }

bin/excel-builder-ts-0.4.0.tgz

@@ -2,10 +2,10 @@ import Util = require("../util/Util");
 import XmlDom = require("../xml/XmlDom");
 
 class AbsoluteAnchor {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
+    x: number | null;
+    y: number | null;
+    width: number | null;
+    height: number | null;
 
 
     /**
@@ -51,13 +51,13 @@ class AbsoluteAnchor {
     public toXML(xmlDoc: XmlDom, content: XmlDom.NodeBase) {
         var root = Util.createElement(xmlDoc, "xdr:absoluteAnchor");
         var pos = Util.createElement(xmlDoc, "xdr:pos");
-        pos.setAttribute("x", <any>this.x);
-        pos.setAttribute("y", <any>this.y);
+        pos.setAttribute("x", this.x);
+        pos.setAttribute("y", this.y);
         root.appendChild(pos);
 
         var dimensions = Util.createElement(xmlDoc, "xdr:ext");
-        dimensions.setAttribute("cx", <any>this.width);
-        dimensions.setAttribute("cy", <any>this.height);
+        dimensions.setAttribute("cx", this.width);
+        dimensions.setAttribute("cy", this.height);
         root.appendChild(dimensions);
 
         root.appendChild(content);

drawings/AbsoluteAnchor.ts

@@ -20,17 +20,17 @@ var Drawing = /** @class */ (function () {
      * @returns a cell anchor object
      */
     Drawing.prototype.createAnchor = function (type, config) {
-        config = config || {};
-        config.drawing = this;
+        var cfg = (config != null ? config : {});
+        cfg.drawing = this;
         switch (type) {
             case "absoluteAnchor":
-                this.anchor = new AbsoluteAnchor(config);
+                this.anchor = new AbsoluteAnchor(cfg);
                 break;
             case "oneCellAnchor":
-                this.anchor = new OneCellAnchor(config);
+                this.anchor = new OneCellAnchor(cfg);
                 break;
             case "twoCellAnchor":
-                this.anchor = new TwoCellAnchor(config);
+                this.anchor = new TwoCellAnchor(cfg);
                 break;
         }
         return this.anchor;

drawings/Drawing.js

@@ -28,17 +28,17 @@ abstract class Drawing implements Drawings.Drawing {
      * @returns a cell anchor object
      */
     public createAnchor(type: "absoluteAnchor" | "oneCellAnchor" | "twoCellAnchor", config?: { drawing?: Drawings.Drawing; from?: Util.OffsetConfig; to?: Util.OffsetConfig; } & Util.Pos): Drawing.AnchorLike {
-        config = config || <any>{};
-        config.drawing = this;
+        var cfg = (config != null ? config : <any>{});
+        cfg.drawing = this;
         switch (type) {
             case "absoluteAnchor":
-                this.anchor = new AbsoluteAnchor(config);
+                this.anchor = new AbsoluteAnchor(cfg);
                 break;
             case "oneCellAnchor":
-                this.anchor = new OneCellAnchor(config);
+                this.anchor = new OneCellAnchor(cfg);
                 break;
             case "twoCellAnchor":
-                this.anchor = new TwoCellAnchor(<{ from: Util.OffsetConfig; to: Util.OffsetConfig; }><any>config);
+                this.anchor = new TwoCellAnchor(<{ from: Util.OffsetConfig; to: Util.OffsetConfig; }><any>cfg);
                 break;
         }
         return this.anchor;

drawings/Drawing.ts

@@ -2,12 +2,12 @@ import Util = require("../util/Util");
 import XmlDom = require("../xml/XmlDom");
 
 class OneCellAnchor {
-    x: number;
-    y: number;
-    xOff: number;
-    yOff: number;
-    width: number;
-    height: number;
+    x: number | null;
+    y: number | null;
+    xOff: number | null;
+    yOff: number | null;
+    width: number | null;
+    height: number | null;
 
 
     /**
@@ -32,7 +32,7 @@ class OneCellAnchor {
     }
 
 
-    public setPos(x: number, y: number, xOff: number, yOff: number) {
+    public setPos(x: number, y: number, xOff: number | undefined, yOff: number | undefined) {
         this.x = x;
         this.y = y;
         if (xOff !== undefined) {

drawings/OneCellAnchor.ts

@@ -3,7 +3,7 @@ import XmlDom = require("../xml/XmlDom");
 import Drawing = require("./Drawing");
 import Drawings = require("./Drawings");
 
-class Picture {
+class Picture implements Drawings.Drawing {
     static Cctor = (function () {
         var thisProto = Picture.prototype;
         Picture.prototype = new (<any>Drawing)();
@@ -24,7 +24,7 @@ class Picture {
         this.id = Util._uniqueId("Picture");
         this.pictureId = Util.uniqueId("Picture");
         this.fill = {};
-        this.mediaData = null;
+        this.mediaData = <any>null;
     }
 
 
@@ -85,7 +85,7 @@ class Picture {
         var pictureFill = Util.createElement(xmlDoc, "xdr:blipFill");
         pictureFill.appendChild(Util.createElement(xmlDoc, "a:blip", [
             ["xmlns:r", Util.schemas.relationships],
-            ["r:embed", this.mediaData.rId]
+            ["r:embed", <any>this.mediaData.rId]
         ]));
         pictureFill.appendChild(Util.createElement(xmlDoc, "a:srcRect"));
         var stretch = Util.createElement(xmlDoc, "a:stretch");

drawings/Picture.ts

@@ -16,7 +16,7 @@ class TwoCellAnchor {
     }
 
 
-    public setFrom(x: number, y: number, xOff: number, yOff: number) {
+    public setFrom(x: number | undefined, y: number | undefined, xOff: number, yOff: number) {
         this.from.x = x;
         this.from.y = y;
         if (xOff !== undefined) {
@@ -28,7 +28,7 @@ class TwoCellAnchor {
     }
 
 
-    public setTo(x: number, y: number, xOff: number, yOff: number) {
+    public setTo(x: number | undefined, y: number | undefined, xOff: number, yOff: number) {
         this.to.x = x;
         this.to.y = y;
         if (xOff !== undefined) {