@microsoft/connected-workbooks/dist/src/utils/documentUtils.js

Microsoft backed, Excel advanced xlsx workbook generation JavaScript library

"use strict";
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (g && (g = 0, op[0] && (_ = 0)), _) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
var constants_1 = require("./constants");
var types_1 = require("../types");
var xmldom_qsa_1 = require("xmldom-qsa");
var createOrUpdateProperty = function (doc, parent, property, value) {
    if (value === undefined) {
        return;
    }
    var elements = parent.getElementsByTagName(property);
    if ((elements === null || elements === void 0 ? void 0 : elements.length) === 0) {
        var newElement = doc.createElement(property);
        newElement.textContent = value;
        parent.appendChild(newElement);
    }
    else if (elements.length > 1) {
        throw new Error("Invalid DocProps core.xml, multiple ".concat(property, " elements"));
    }
    else if ((elements === null || elements === void 0 ? void 0 : elements.length) > 0) {
        elements[0].textContent = value;
    }
};
var getDocPropsProperties = function (zip) { return __awaiter(void 0, void 0, void 0, function () {
    var docPropsCoreXmlString, parser, doc, properties;
    var _a;
    return __generator(this, function (_b) {
        switch (_b.label) {
            case 0: return [4 /*yield*/, ((_a = zip.file(constants_1.docPropsCoreXmlPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType))];
            case 1:
                docPropsCoreXmlString = _b.sent();
                if (docPropsCoreXmlString === undefined) {
                    throw new Error("DocProps core.xml was not found in template");
                }
                parser = new xmldom_qsa_1.DOMParser();
                doc = parser.parseFromString(docPropsCoreXmlString, constants_1.xmlTextResultType);
                properties = doc.getElementsByTagName(constants_1.docPropsRootElement).item(0);
                if (properties === null) {
                    throw new Error("Invalid DocProps core.xml");
                }
                return [2 /*return*/, { doc: doc, properties: properties }];
        }
    });
}); };
var getCellReferenceAbsolute = function (col, row) {
    return "$" + convertToExcelColumn(col) + "$" + row.toString();
};
var getCellReferenceRelative = function (col, row) {
    return convertToExcelColumn(col) + row.toString();
};
var convertToExcelColumn = function (index) {
    if (index >= 16384) {
        throw new Error(constants_1.columnIndexOutOfRangeErr);
    }
    var columnStr = "";
    var base = 26; // number of letters in the alphabet
    while (index >= 0) {
        var remainder = index % base;
        columnStr = String.fromCharCode(remainder + 65) + columnStr; // ASCII 'A' is 65
        index = Math.floor(index / base) - 1;
    }
    return columnStr;
};
var getTableReference = function (numberOfCols, numberOfRows) {
    return "A1:".concat(getCellReferenceRelative(numberOfCols, numberOfRows));
};
var createCellElement = function (doc, colIndex, rowIndex, data) {
    var cell = doc.createElementNS(doc.documentElement.namespaceURI, constants_1.element.kindCell);
    cell.setAttribute(constants_1.elementAttributes.row, getCellReferenceRelative(colIndex, rowIndex + 1));
    var cellData = doc.createElementNS(doc.documentElement.namespaceURI, constants_1.element.cellValue);
    updateCellData(data, cell, cellData, rowIndex === 0);
    cell.appendChild(cellData);
    return cell;
};
var updateCellData = function (data, cell, cellData, rowHeader) {
    switch (resolveType(data, rowHeader)) {
        case types_1.DataTypes.string:
            cell.setAttribute(constants_1.element.text, constants_1.dataTypeKind.string);
            break;
        case types_1.DataTypes.number:
            cell.setAttribute(constants_1.element.text, constants_1.dataTypeKind.number);
            break;
        case types_1.DataTypes.boolean:
            cell.setAttribute(constants_1.element.text, constants_1.dataTypeKind.boolean);
            break;
    }
    if (data.startsWith(" ") || data.endsWith(" ")) {
        cellData.setAttribute(constants_1.elementAttributes.space, "preserve");
    }
    cellData.textContent = data;
};
var resolveType = function (originalData, rowHeader) {
    var data = originalData;
    if (rowHeader || data.trim() === "") {
        // Headers and whitespace should be string by default.
        return types_1.DataTypes.string;
    }
    var dataType = isNaN(Number(data)) ? types_1.DataTypes.string : types_1.DataTypes.number;
    if (dataType == types_1.DataTypes.string) {
        if (data.trim() == constants_1.trueStr || data.trim() == constants_1.falseStr) {
            dataType = types_1.DataTypes.boolean;
        }
    }
    return dataType;
};
exports.default = {
    createOrUpdateProperty: createOrUpdateProperty,
    getDocPropsProperties: getDocPropsProperties,
    getCellReferenceRelative: getCellReferenceRelative,
    getCellReferenceAbsolute: getCellReferenceAbsolute,
    createCell: createCellElement,
    getTableReference: getTableReference,
    updateCellData: updateCellData,
    resolveType: resolveType,
    convertToExcelColumn: convertToExcelColumn,
};