Merge pull request #89 from ghiscoding/chore/more-interface

chore: add more interfaces/types

Author: ghiscoding

packages/demo/src/examples/example13.ts

@@ -38,7 +38,7 @@ export default class Example {
     albumTable.setReferenceRange([1, 1], [3, originalData.length]);
     albumTable.setTableColumns(['Artist', 'Album', 'Price']);
 
-    // worksheet.sheetView.showGridLines = false;
+    worksheet.sheetView.showGridLines = false;
     worksheet.setData(originalData);
     workbook.addWorksheet(worksheet);
 

packages/excel-builder-vanilla/src/Excel/Drawing/AbsoluteAnchor.ts

@@ -1,3 +1,4 @@
+import type { AnchorOption } from './Drawing.js';
 import { Util } from '../Util.js';
 import type { XMLDOM } from '../XMLDOM.js';
 
@@ -16,7 +17,7 @@ export class AbsoluteAnchor {
   width: number | null = null;
   height: number | null = null;
 
-  constructor(config: any) {
+  constructor(config: AnchorOption) {
     if (config) {
       this.setPos(config.x, config.y);
       this.setDimensions(config.width, config.height);

packages/excel-builder-vanilla/src/Excel/Drawing/Drawing.ts

@@ -1,53 +1,60 @@
 import { uniqueId } from '../../utilities/uniqueId.js';
 import { AbsoluteAnchor } from './AbsoluteAnchor.js';
-import { Chart } from './Chart.js';
 import { OneCellAnchor } from './OneCellAnchor.js';
 import { TwoCellAnchor } from './TwoCellAnchor.js';
 // import { Picture } from './Picture.js';
 
+export interface AnchorOption {
+  /** X offset in EMU's */
+  x: number;
+  /** Y offset in EMU's */
+  y: number;
+  xOff?: boolean;
+  yOff?: boolean;
+  /** Width in EMU's */
+  height: number;
+  /** Height in EMU's */
+  width: number;
+  drawing?: Drawing;
+}
+
+export interface DualAnchorOption {
+  to: AnchorOption;
+  from: AnchorOption;
+  drawing?: Drawing;
+}
+
 /**
  * This is mostly a global spot where all of the relationship managers can get and set
  * path information from/to.
  * @module Excel/Drawing
  */
 export class Drawing {
-  anchor: any;
+  anchor!: AbsoluteAnchor | OneCellAnchor | TwoCellAnchor;
   id = uniqueId('Drawing');
 
-  get AbsoluteAnchor() {
-    return AbsoluteAnchor;
-  }
-  get Chart() {
-    return Chart;
-  }
-  get OneCellAnchor() {
-    return OneCellAnchor;
-  }
-  // get Picture() {
-  //   return Picture;
-  // }
-  get TwoCellAnchor() {
-    return TwoCellAnchor;
-  }
-
   /**
    *
    * @param {String} type Can be 'absoluteAnchor', 'oneCellAnchor', or 'twoCellAnchor'.
    * @param {Object} config Shorthand - pass the created anchor coords that can normally be used to construct it.
    * @returns {Anchor}
    */
-  createAnchor(type: string, config: any) {
-    config = config || {};
+  // TODO: couldn't get function override working, but hopefully in the future
+  // createAnchor(type: 'absoluteAnchor', config: AnchorOption): AbsoluteAnchor;
+  // createAnchor(type: 'oneCellAnchor', config: AnchorOption): OneCellAnchor;
+  // createAnchor(type: 'twoCellAnchor', config: DualAnchorOption): TwoCellAnchor;
+  createAnchor(type: 'absoluteAnchor' | 'oneCellAnchor' | 'twoCellAnchor', config: any): AbsoluteAnchor | OneCellAnchor | TwoCellAnchor {
+    config ??= {} as AnchorOption | DualAnchorOption;
     config.drawing = this;
     switch (type) {
       case 'absoluteAnchor':
-        this.anchor = new AbsoluteAnchor(config);
+        this.anchor = new AbsoluteAnchor(config as AnchorOption);
         break;
       case 'oneCellAnchor':
-        this.anchor = new OneCellAnchor(config);
+        this.anchor = new OneCellAnchor(config as AnchorOption);
         break;
       case 'twoCellAnchor':
-        this.anchor = new TwoCellAnchor(config);
+        this.anchor = new TwoCellAnchor(config as DualAnchorOption);
         break;
     }
     return this.anchor;

packages/excel-builder-vanilla/src/Excel/Drawing/OneCellAnchor.ts

@@ -1,3 +1,4 @@
+import type { AnchorOption } from './Drawing.js';
 import { Util } from '../Util.js';
 import type { XMLDOM } from '../XMLDOM.js';
 
@@ -18,7 +19,7 @@ export class OneCellAnchor {
   width: number | null = null;
   height: number | null = null;
 
-  constructor(config: any) {
+  constructor(config: AnchorOption) {
     if (config) {
       this.setPos(config.x, config.y, config.xOff, config.yOff);
       this.setDimensions(config.width, config.height);

packages/excel-builder-vanilla/src/Excel/Drawing/Picture.ts

@@ -1,14 +1,14 @@
+import { Drawing } from './Drawing.js';
 import { uniqueId } from '../../utilities/uniqueId.js';
 import { Util } from '../Util.js';
+import type { MediaMeta } from '../Workbook.js';
 import type { XMLDOM } from '../XMLDOM.js';
-import { Drawing } from './Drawing.js';
 
 export class Picture extends Drawing {
-  media: any = null;
   id = uniqueId('Picture');
   pictureId = Util.uniqueId('Picture');
   fill: any = {};
-  mediaData: any = null;
+  mediaData: MediaMeta | null = null;
   description = '';
 
   constructor() {
@@ -18,7 +18,7 @@ export class Picture extends Drawing {
     this.pictureId = Util.uniqueId('Picture');
   }
 
-  setMedia(mediaRef: any) {
+  setMedia(mediaRef: MediaMeta) {
     this.mediaData = mediaRef;
   }
 
@@ -39,11 +39,11 @@ export class Picture extends Drawing {
   }
 
   getMediaData() {
-    return this.mediaData;
+    return this.mediaData as MediaMeta;
   }
 
   setRelationshipId(rId: string) {
-    this.mediaData.rId = rId;
+    this.mediaData!.rId = rId;
   }
 
   toXML(xmlDoc: XMLDOM) {
@@ -53,7 +53,7 @@ export class Picture extends Drawing {
 
     const nameProperties = Util.createElement(xmlDoc, 'xdr:cNvPr', [
       ['id', this.pictureId],
-      ['name', this.mediaData.fileName],
+      ['name', this.mediaData!.fileName],
       ['descr', this.description || ''],
     ]);
     nonVisibleProperties.appendChild(nameProperties);
@@ -70,7 +70,7 @@ export class Picture extends Drawing {
     pictureFill.appendChild(
       Util.createElement(xmlDoc, 'a:blip', [
         ['xmlns:r', Util.schemas.relationships],
-        ['r:embed', this.mediaData.rId],
+        ['r:embed', this.mediaData!.rId],
       ]),
     );
     pictureFill.appendChild(Util.createElement(xmlDoc, 'a:srcRect'));

packages/excel-builder-vanilla/src/Excel/Drawing/TwoCellAnchor.ts

@@ -1,11 +1,12 @@
+import type { DualAnchorOption } from './Drawing.js';
 import { Util } from '../Util.js';
 import type { XMLDOM } from '../XMLDOM.js';
 
 export class TwoCellAnchor {
   from: any = { xOff: 0, yOff: 0 };
   to: any = { xOff: 0, yOff: 0 };
 
-  constructor(config: any) {
+  constructor(config: DualAnchorOption) {
     if (config) {
       this.setFrom(config.from.x, config.from.y, config.to.xOff, config.to.yOff);
       this.setTo(config.to.x, config.to.y, config.to.xOff, config.to.yOff);

packages/excel-builder-vanilla/src/Excel/RelationshipManager.ts

@@ -2,25 +2,31 @@ import { uniqueId } from '../utilities/uniqueId.js';
 import { Paths } from './Paths.js';
 import { Util } from './Util.js';
 
+type Relation = {
+  [id: string]: {
+    id: string;
+    schema: string;
+    object: any;
+    data?: {
+      id: number;
+      schema: string;
+      object: any;
+    };
+  };
+};
+
 /**
  * @module Excel/RelationshipManager
  */
 export class RelationshipManager {
-  relations: {
-    [id: string]: {
-      id: string;
-      schema: string;
-      object: any;
-      data?: { id: number; schema: string; object: any };
-    };
-  } = {};
+  relations: Relation = {};
   lastId = 1;
 
   constructor() {
     uniqueId('rId'); // priming
   }
 
-  importData(data: any) {
+  importData(data: { relations: Relation; lastId: number }) {
     this.relations = data.relations;
     this.lastId = data.lastId;
   }

packages/excel-builder-vanilla/src/Excel/SheetView.ts

@@ -13,24 +13,24 @@ interface SheetViewOption {
  */
 export class SheetView {
   pane: Pane;
-  showZeros = null; // Default
-  defaultGridColor = null;
-  colorId = null;
-  rightToLeft = null;
-  showFormulas = null;
-  showGridLines = null;
-  showOutlineSymbols = null;
-  showRowColHeaders = null;
-  showRuler = null;
-  showWhiteSpace = null;
-  tabSelected = null;
-  topLeftCell = null;
+  showZeros: boolean | null = null; // Default
+  defaultGridColor: string | null = null;
+  colorId: number | null = null;
+  rightToLeft: boolean | null = null;
+  showFormulas: boolean | null = null;
+  showGridLines: boolean | null = null;
+  showOutlineSymbols: boolean | null = null;
+  showRowColHeaders: boolean | null = null;
+  showRuler: boolean | null = null;
+  showWhiteSpace: boolean | null = null;
+  tabSelected: boolean | null = null;
+  topLeftCell: boolean | null = null;
   viewType = null; // http://www.datypic.com/sc/ooxml/t-ssml_ST_SheetViewType.html
-  windowProtection = null;
-  zoomScale = null;
-  zoomScaleNormal = null;
-  zoomScalePageLayoutView = null;
-  zoomScaleSheetLayoutView = null;
+  windowProtection: boolean | null = null;
+  zoomScale: boolean | null = null;
+  zoomScaleNormal: any = null;
+  zoomScalePageLayoutView: any = null;
+  zoomScaleSheetLayoutView: any = null;
 
   constructor(config?: SheetViewOption) {
     const conf = config || {};

packages/excel-builder-vanilla/src/Excel/Workbook.ts

@@ -9,6 +9,15 @@ import { Util } from './Util.js';
 import { Worksheet } from './Worksheet.js';
 import { XMLDOM } from './XMLDOM.js';
 
+export interface MediaMeta {
+  id: string;
+  data: string;
+  fileName: string;
+  contentType: string | null;
+  extension: string;
+  rId?: string;
+}
+
 /**
  * @module Excel/Workbook
  */
@@ -21,7 +30,7 @@ export class Workbook {
   worksheets: Worksheet[] = [];
   tables: Table[] = [];
   drawings: Drawings[] = [];
-  media: any = {};
+  media: { [filename: string]: MediaMeta } = {};
   printTitles: any;
 
   constructor() {