abstract-sheet 0.0.3 → 0.0.5

package/src/abstract-sheet/abstract-sheet-xsd.xml

@@ -1,29 +1,30 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.1" encoding="UTF-8"?>
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
 
 	<xs:element name="AbstractSheet">
 		<xs:complexType>
 			<xs:sequence>
-				<xs:element name="Styles" type="Styles" minOccurs="0" />
-				<xs:element name="Sheets" type="Sheets" minOccurs="0" />
+				<xs:element name="Styles" type="Styles" minOccurs="0" maxOccurs="1" />
+				<xs:element name="Sheet" type="Sheet" />
 			</xs:sequence>
 		</xs:complexType>
 	</xs:element>
 
-
-	<xs:complexType name="Sheets">
-		<xs:sequence>
-			<xs:element name="Sheet" type="Sheet" minOccurs="0" />
-		</xs:sequence>
-	</xs:complexType>
-
 	<xs:complexType name="Sheet">
 		<xs:sequence>
-			<xs:element name="Rows" type="Rows" minOccurs="0" maxOccurs="1" />
+			<xs:element name="Cells" type="Cells" />
 			<xs:element name="RowInfos" type="RowInfos" minOccurs="0" maxOccurs="1" />
 			<xs:element name="ColInfos" type="ColInfos" minOccurs="0" maxOccurs="1" />
 		</xs:sequence>
 		<xs:attribute name="name" type="xs:string" use="required" />
+		<xs:attribute name="direction">
+			<xs:simpleType>
+				<xs:restriction base="xs:string">
+					<xs:enumeration value="row" />
+					<xs:enumeration value="col" />
+				</xs:restriction>
+			</xs:simpleType>
+		</xs:attribute>
 	</xs:complexType>
 
 	<xs:complexType name="ColInfos">
@@ -48,43 +49,20 @@
 		<xs:attribute name="heightPixels" type="xs:integer" />
 	</xs:complexType>
 
-
-	<xs:complexType name="Rows">
-		<xs:sequence>
-			<xs:element name="Row" type="Row" />
-		</xs:sequence>
-	</xs:complexType>
-
-	<xs:complexType name="Row">
+	<xs:complexType name="Cells">
 		<xs:sequence>
 			<xs:element name="Cell" type="Cell" />
 		</xs:sequence>
 	</xs:complexType>
 
 	<xs:complexType name="Cell">
-		<xs:attribute name="value" type="NumberOrString" use="required" />
+		<xs:attribute name="number" type="xs:string" use="optional" />
+		<xs:attribute name="text" type="xs:string" use="optional" />
+		<xs:attribute name="bool" type="xs:string" use="optional" />
+		<xs:attribute name="date" type="xs:string" use="optional" />
 		<xs:attribute name="styles" type="xs:string" />
-		<xs:attribute name="type">
-			<xs:simpleType>
-				<xs:restriction base="xs:string">
-					<xs:enumeration value="string" />
-					<xs:enumeration value="number" />
-				</xs:restriction>
-			</xs:simpleType>
-		</xs:attribute>
 	</xs:complexType>
 
-	<xs:simpleType name="NumberOrString">
-		<xs:union>
-			<xs:simpleType>
-				<xs:restriction base="xs:double" />
-			</xs:simpleType>
-			<xs:simpleType>
-				<xs:restriction base="xs:string" />
-			</xs:simpleType>
-		</xs:union>
-	</xs:simpleType>
-
 	<xs:complexType name="Styles">
 		<xs:sequence>
 			<xs:element name="Style" minOccurs="0" maxOccurs="unbounded" />
@@ -112,9 +90,9 @@
 			</xs:simpleType>
 		</xs:attribute>
 		<xs:attribute name="wrapText" type="xs:boolean" />
-		<xs:attribute name="textRotation" type="xs:boolean" />
-		<xs:attribute name="borderStyle" type="xs:string" />
-		<xs:attribute name="borderColor" type="xs:string" />
+		<xs:attribute name="textRotation" type="xs:double" />
+		<xs:attribute name="borderStyle" type="BorderStyle" />
+		<xs:attribute name="borderColor" type="BorderColor" />
 		<xs:attribute name="fillType">
 			<xs:simpleType>
 				<xs:restriction base="xs:string">
@@ -123,10 +101,10 @@
 				</xs:restriction>
 			</xs:simpleType>
 		</xs:attribute>
-		<xs:attribute name="foreground" type="xs:string" />
-		<xs:attribute name="background" type="xs:string" />
+		<xs:attribute name="foreground" type="HexColorWithOpacity" />
+		<xs:attribute name="background" type="HexColorWithOpacity" />
 		<xs:attribute name="bold" type="xs:boolean" />
-		<xs:attribute name="color" type="xs:string" />
+		<xs:attribute name="color" type="HexColorWithOpacity" />
 		<xs:attribute name="italic" type="xs:boolean" />
 		<xs:attribute name="font" type="xs:string" />
 		<xs:attribute name="strike" type="xs:boolean" />
@@ -143,4 +121,22 @@
 		<xs:attribute name="numberFormat" type="xs:string" />
 	</xs:complexType>
 
+	<xs:simpleType name="HexColorWithOpacity">
+		<xs:restriction base="xs:string">
+			<xs:pattern value="#[0-9a-fA-F]{8}" />
+		</xs:restriction>
+	</xs:simpleType>
+
+	<xs:simpleType name="BorderColor">
+		<xs:restriction base="xs:string">
+			<xs:pattern value="^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})(\s#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})){0,3}$" />
+		</xs:restriction>
+	</xs:simpleType>
+
+	<xs:simpleType name="BorderStyle">
+		<xs:restriction base="xs:string">
+			<xs:pattern value="^(dashDotDot|dashDot|dashed|dotted|hair|mediumDashDotDot|mediumDashDot|mediumDashed|medium|slantDashDot|thick|thin)(\s(dashDotDot|dashDot|dashed|dotted|hair|mediumDashDotDot|mediumDashDot|mediumDashed|medium|slantDashDot|thick|thin)){0,3}$" />
+		</xs:restriction>
+	</xs:simpleType>
+
 </xs:schema>

package/src/abstract-sheet/abstract-sheet.ts

@@ -1,15 +1,15 @@
 export type AbstractSheet = {
-  readonly sheets: Sheets;
+  readonly sheets: ReadonlyArray<Sheet>;
   readonly styles?: Styles;
+  readonly name?: string;
 };
 
-export type Sheets = ReadonlyArray<Sheet>;
-
 export type Sheet = {
   readonly name: string;
-  readonly rows: Rows;
+  readonly cells: ReadonlyArray<Cells>;
   readonly colInfo?: ColInfos;
   readonly rowInfo?: RowInfos;
+  readonly direction?: "row" | "col";
 };
 
 export type ColInfos = ReadonlyArray<ColInfo>;
@@ -20,17 +20,16 @@ export type RowInfos = ReadonlyArray<RowInfo>;
 
 export type RowInfo = { readonly hidden?: boolean; readonly heightPixels?: number };
 
-export type Rows = ReadonlyArray<Row>;
+export type Cells = ReadonlyArray<Cell>;
 
-export type Row = ReadonlyArray<Cell>;
+export type Cell = (NumberCell | TextCell | BoolCell | DateCell) & { readonly styles?: ReadonlyArray<string> };
 
-export type Cell = {
-  readonly value: string | number;
-  readonly styles?: ReadonlyArray<string>;
-  readonly type: CellType;
-};
+export type NumberCell = { readonly type: "number"; readonly value: string | number | boolean | Date };
+export type TextCell = { readonly type: "string"; readonly value: string | number | boolean | Date };
+export type BoolCell = { readonly type: "boolean"; readonly value: string | number | boolean | Date };
+export type DateCell = { readonly type: "date"; readonly value: string | number | boolean | Date };
 
-export type CellType = "string" | "number";
+export type CellType = Cell["type"];
 
 export type Styles = ReadonlyArray<Style>;
 

package/src/abstract-sheet-exporters/_style.ts

@@ -0,0 +1,113 @@
+import { Style } from "../abstract-sheet/abstract-sheet";
+
+export function createStyle(style: Style): any {
+  let s: any = {};
+  if (style.vertical || style.horizontal || style.wrapText !== undefined || style.textRotation !== undefined) {
+    s.alignment = {};
+    if (style.vertical) {
+      s.alignment.vertical = style.vertical;
+    }
+    if (style.horizontal) {
+      s.alignment.horizontal = style.horizontal;
+    }
+    if (style.wrapText !== undefined) {
+      s.alignment.wrapText = style.wrapText;
+    }
+    if (style.textRotation !== undefined) {
+      s.alignment.textRotation = style.textRotation;
+    }
+  }
+  if (style.fillType || style.foreground || style.background) {
+    s.fill = {};
+    if (style.fillType) {
+      s.fill.patternType = style.fillType;
+    }
+    if (style.foreground) {
+      s.fill.fgColor = { rgb: style.foreground.slice(1) };
+    }
+    if (style.background) {
+      s.fill.bgColor = { rgb: style.background.slice(1) };
+    }
+  }
+
+  if (style.borderStyle || style.borderColor) {
+    s.border = {};
+    if (style.borderStyle?.top || style.borderColor?.top) {
+      s.border.top = {};
+    }
+    if (style.borderStyle?.top) {
+      s.border.top.style = style.borderStyle.top;
+    }
+    if (style.borderColor?.top) {
+      s.border.top.color = { rgb: style.borderColor.top.slice(1) };
+    }
+    if (style.borderStyle?.right || style.borderColor?.right) {
+      s.border.right = {};
+    }
+    if (style.borderStyle?.right) {
+      s.border.right.style = style.borderStyle.right;
+    }
+    if (style.borderColor?.right) {
+      s.border.right.color = { rgb: style.borderColor.right.slice(1) };
+    }
+    if (style.borderStyle?.bottom || style.borderColor?.bottom) {
+      s.border.bottom = {};
+    }
+    if (style.borderStyle?.bottom) {
+      s.border.bottom.style = style.borderStyle.bottom;
+    }
+    if (style.borderColor?.bottom) {
+      s.border.bottom.color = { rgb: style.borderColor.bottom.slice(1) };
+    }
+    if (style.borderStyle?.left || style.borderColor?.left) {
+      s.border.left = {};
+    }
+    if (style.borderStyle?.left) {
+      s.border.left.style = style.borderStyle.left;
+    }
+    if (style.borderColor?.left) {
+      s.border.left.color = { rgb: style.borderColor.left.slice(1) };
+    }
+  }
+
+  if (
+    style.bold !== undefined ||
+    style.color ||
+    style.italic !== undefined ||
+    style.font ||
+    style.strike !== undefined ||
+    style.size !== undefined ||
+    style.underline !== undefined ||
+    style.script
+  ) {
+    s.font = {};
+    if (style.bold !== undefined) {
+      s.font.bold = style.bold;
+    }
+    if (style.color) {
+      s.font.color = { rgb: style.color.slice(1) };
+    }
+    if (style.italic !== undefined) {
+      s.font.italic = style.italic;
+    }
+    if (style.font) {
+      s.font.name = style.font;
+    }
+    if (style.strike !== undefined) {
+      s.font.strike = style.strike;
+    }
+    if (style.size !== undefined) {
+      s.font.sz = style.size;
+    }
+    if (style.underline !== undefined) {
+      s.font.underline = style.underline;
+    }
+    if (style.script !== undefined) {
+      s.font.vertAlign = style.script;
+    }
+  }
+  if (style.numberFormat !== undefined) {
+    s.font.numFmt = style.numberFormat;
+  }
+  return s;
+}

package/src/abstract-sheet-exporters/_xlsx-sheet.ts

@@ -1,11 +1,11 @@
 import * as XLSX from "xlsx-js-style";
-import { Style, CellType, Sheet } from "../abstract-sheet/abstract-sheet";
+import { CellType, Sheet } from "../abstract-sheet/abstract-sheet";
 
-export function xlsxWorkSheet(s: Sheet, styles: Record<string, any>): XLSX.WorkSheet {
+export function xlsxWorkSheet(sheet: Sheet, styles: Record<string, any>): XLSX.WorkSheet {
   let colMax = -1;
   const cells: Record<string, XLSX.CellObject> = {};
-  for (let ri = 0; ri < s.rows.length; ri++) {
-    const r = s.rows[ri]!;
+  for (let ri = 0; ri < sheet.cells.length; ri++) {
+    const r = sheet.cells[ri]!;
     colMax = Math.max(r.length, colMax);
     for (let ci = 0; ci < r.length; ci++) {
       const c = r[ci]!;
@@ -15,23 +15,33 @@ export function xlsxWorkSheet(s: Sheet, styles: Record<string, any>): XLSX.WorkS
           s = { ...s!, ...styles[style] };
         }
       }
-      cells[`${XLSX.utils.encode_col(ci)}${ri + 1}`] = { v: c.value, t: columnType(c.type), s };
+      const key =
+        sheet.direction === "col" ? `${XLSX.utils.encode_col(ri)}${ci + 1}` : `${XLSX.utils.encode_col(ci)}${ri + 1}`;
+      cells[key] = { v: c.value, t: cellObject(c.type), s };
     }
   }
 
   return {
     "!type": "sheet",
-    "!ref": `A1:${XLSX.utils.encode_col(colMax)}${s.rows.length}`,
-    "!cols": s.colInfo?.map((i): XLSX.ColInfo => ({ wpx: i.widthPixels, hidden: i.hidden })),
-    "!rows": s.rowInfo?.map((i): XLSX.RowInfo => ({ hpx: i.heightPixels, hidden: i.hidden })),
+    "!ref": `A1:${
+      sheet.direction === "col"
+        ? `${XLSX.utils.encode_col(sheet.cells.length)}${colMax}`
+        : `${XLSX.utils.encode_col(colMax)}${sheet.cells.length}`
+    }`,
+    "!cols": sheet.colInfo?.map((i): XLSX.ColInfo => ({ wpx: i.widthPixels ?? 64, hidden: i.hidden })),
+    "!rows": sheet.rowInfo?.map((i): XLSX.RowInfo => ({ hpx: i.heightPixels ?? 15, hidden: i.hidden })),
     ...cells,
   };
 }
 
-const columnType = (colType: CellType | undefined): XLSX.CellObject["t"] => {
+const cellObject = (colType: CellType | undefined): XLSX.CellObject["t"] => {
   switch (colType) {
     case "number":
       return "n";
+    case "boolean":
+      return "b";
+    case "date":
+      return "d";
     case undefined:
     case "string":
       return "s";
@@ -42,115 +52,3 @@ const columnType = (colType: CellType | undefined): XLSX.CellObject["t"] => {
 };
 
 const exhaustiveCheck = (check: never): never => check;
-
-export function createStyle(style: Style): any {
-  let s: any = {};
-  if (style.vertical || style.horizontal || style.wrapText !== undefined || style.textRotation !== undefined) {
-    s.alignment = {};
-    if (style.vertical) {
-      s.alignment.vertical = style.vertical;
-    }
-    if (style.horizontal) {
-      s.alignment.horizontal = style.horizontal;
-    }
-    if (style.wrapText !== undefined) {
-      s.alignment.wrapText = style.wrapText;
-    }
-    if (style.textRotation !== undefined) {
-      s.alignment.textRotation = style.textRotation;
-    }
-  }
-  if (style.fillType || style.foreground || style.background) {
-    s.fill = {};
-    if (style.fillType) {
-      s.fill.patternType = style.fillType;
-    }
-    if (style.foreground) {
-      s.fill.fgColor = { rgb: style.foreground };
-    }
-    if (style.background) {
-      s.fill.bgColor = { rgb: style.background };
-    }
-  }
-
-  if (style.borderStyle || style.borderColor) {
-    s.border = {};
-    if (style.borderStyle?.top || style.borderColor?.top) {
-      s.border.top = {};
-    }
-    if (style.borderStyle?.top) {
-      s.border.top.style = style.borderStyle.top;
-    }
-    if (style.borderColor?.top) {
-      s.border.top.color = { rgb: style.borderColor.top };
-    }
-    if (style.borderStyle?.right || style.borderColor?.right) {
-      s.border.right = {};
-    }
-    if (style.borderStyle?.right) {
-      s.border.right.style = style.borderStyle.right;
-    }
-    if (style.borderColor?.right) {
-      s.border.right.color = { rgb: style.borderColor.right };
-    }
-    if (style.borderStyle?.bottom || style.borderColor?.bottom) {
-      s.border.bottom = {};
-    }
-    if (style.borderStyle?.bottom) {
-      s.border.bottom.style = style.borderStyle.bottom;
-    }
-    if (style.borderColor?.bottom) {
-      s.border.bottom.color = { rgb: style.borderColor.bottom };
-    }
-    if (style.borderStyle?.left || style.borderColor?.left) {
-      s.border.left = {};
-    }
-    if (style.borderStyle?.left) {
-      s.border.left.style = style.borderStyle.left;
-    }
-    if (style.borderColor?.left) {
-      s.border.left.color = { rgb: style.borderColor.left };
-    }
-  }
-
-  if (
-    style.bold !== undefined ||
-    style.color ||
-    style.italic !== undefined ||
-    style.font ||
-    style.strike !== undefined ||
-    style.size !== undefined ||
-    style.underline !== undefined ||
-    style.script
-  ) {
-    s.font = {};
-    if (style.bold !== undefined) {
-      s.font.bold = style.bold;
-    }
-    if (style.color) {
-      s.font.color = { rgb: style.color };
-    }
-    if (style.italic !== undefined) {
-      s.font.italic = style.italic;
-    }
-    if (style.font) {
-      s.font.name = style.font;
-    }
-    if (style.strike !== undefined) {
-      s.font.strike = style.strike;
-    }
-    if (style.size !== undefined) {
-      s.font.sz = style.size;
-    }
-    if (style.underline !== undefined) {
-      s.font.underline = style.underline;
-    }
-    if (style.script !== undefined) {
-      s.font.vertAlign = style.script;
-    }
-  }
-  if (style.numberFormat !== undefined) {
-    s.font.numFmt = style.numberFormat;
-  }
-  return s;
-}

package/src/abstract-sheet-exporters/csv.ts

@@ -1,11 +1,12 @@
 import * as XLSX from "xlsx-js-style";
 import { AbstractSheet } from "../abstract-sheet/abstract-sheet";
-import { createStyle, xlsxWorkSheet } from "./_xlsx-sheet";
+import { xlsxWorkSheet } from "./_xlsx-sheet";
+import { createStyle } from "./_style";
 
 export type CsvFile = { readonly name: string; readonly csv: string };
 
 export function toCsv(
-  as: AbstractSheet,
+  abstractSheets: ReadonlyArray<AbstractSheet>,
   options?: {
     readonly separator?: string;
     readonly rowSeparator?: string;
@@ -16,21 +17,24 @@ export function toCsv(
     readonly rawNumber?: boolean;
     readonly dateFormat?: string;
   }
-): ReadonlyArray<CsvFile> {
-  const styles = Object.fromEntries(as.styles?.map((s) => [s.name, createStyle(s)]) ?? []);
-  const mappedOptions: XLSX.Sheet2CSVOpts | undefined = options
-    ? {
-        FS: options.separator,
-        RS: options.rowSeparator,
-        strip: options.noTrailingSeparator,
-        blankrows: options.blankRows,
-        skipHidden: options.skipHidden,
-        forceQuotes: options.forceQuotes,
-        rawNumbers: options.rawNumber,
-        dateNF: options.dateFormat,
-      }
-    : undefined;
-  return as.sheets.map(
-    (s): CsvFile => ({ name: s.name, csv: XLSX.utils.sheet_to_csv(xlsxWorkSheet(s, styles), mappedOptions) })
-  );
+): ReadonlyArray<ReadonlyArray<CsvFile>> {
+  return (abstractSheets as Array<AbstractSheet>).map((as) => {
+    const styles = Object.fromEntries(as.styles?.map((s) => [s.name, createStyle(s)]) ?? []);
+    const mappedOptions: XLSX.Sheet2CSVOpts | undefined = options
+      ? {
+          FS: options.separator,
+          RS: options.rowSeparator,
+          strip: options.noTrailingSeparator,
+          blankrows: options.blankRows,
+          skipHidden: options.skipHidden,
+          forceQuotes: options.forceQuotes,
+          rawNumbers: options.rawNumber,
+          dateNF: options.dateFormat,
+        }
+      : undefined;
+
+    return as.sheets.map(
+      (s): CsvFile => ({ name: s.name, csv: XLSX.utils.sheet_to_csv(xlsxWorkSheet(s, styles), mappedOptions) })
+    );
+  }) as unknown as ReadonlyArray<ReadonlyArray<CsvFile>>;
 }

package/src/abstract-sheet-exporters/index.ts

@@ -1,2 +1,3 @@
 export * from "./csv";
 export * from "./xlsx";
+export * from "./react";