// See COPYRIGHT.md for copyright information

import moment from "moment";
import Decimal from "decimal.js";

export const SHOW_FACT = 'SHOW_FACT';

export const NAMESPACE_ISO4217 = 'http://www.xbrl.org/2003/iso4217';
export const NAMESPACE_XBRLI = 'http://www.xbrl.org/2003/instance';

export const CALC_ARCROLE = "calc";
export const CALC11_ARCROLE = "calc11";
export const CALC_ARCROLES = [ CALC_ARCROLE, CALC11_ARCROLE ];

export const GLOSSARY_URL = "https://xbrl.org/glossary/";

// The number of distinct highlight colors defined in inspector.less
export const HIGHLIGHT_COLORS = 6;

// Feature names
export const FEATURE_GUIDE_LINK = 'guide_link';
export const FEATURE_HOME_LINK_LABEL = 'home_link_label';
export const FEATURE_HOME_LINK_URL = 'home_link_url';
export const FEATURE_REVIEW = 'review';
export const FEATURE_SUPPORT_LINK = 'support_link';
export const FEATURE_SURVEY_LINK = 'survey_link';

// This feature has no effect until we implement fact list by section
export const FEATURE_SEARCH_ON_STARTUP = 'search_on_startup';
export const FEATURE_HIGHLIGHT_FACTS_ON_STARTUP = 'highlight_facts_on_startup';
export const FEATURE_HIDE_CALCULATION_MODE_OPTION = 'hide_calculation_mode_option';

export const IXBRL_VIEWER_DATASET_PREFIX = 'ixbrlViewer';

export const STORAGE_APP_LANGUAGE = "ixbrl-viewer-app-language";
export const STORAGE_THEME = "ixbrl-viewer-theme";
export const STORAGE_HIGHLIGHT_FACTS = "ixbrl-viewer-highlight-all-facts";
export const STORAGE_HOME_LINK_QUERY = "ixbrl-viewer-home-link-query";
export const USER_GUIDE_URL = "https://arelle-ixbrl-viewer.readthedocs.io/en/latest/user_guides/user_guide.html";
export const ENTITY_CONCEPT_LOCALNAMES = [
    "NameOfReportingEntityOrOtherMeansOfIdentification", // IFRS
    "EntityRegistrantName", // SEC / DEI
    "EntityCurrentLegalOrRegisteredName", // UK
    "NameOfReportingEntity", // Denmark
];

export const ZOOM_LEVELS = [
    25,
    33,
    50,
    66,
    80,
    90,
    100,
    110,
    120,
    133,
    150,
    170,
    200,
    240,
    300,
    400,
    500,
];

export const FACTS_PER_GROUP = 20;

/* 
 * Takes a moment.js oject and converts it to a human readable date, or date
 * and time if the time component is not midnight.  Adjust specifies that a
 * date (but not a date time) should be shown as the day before.  This is to
 * satisfy the human convention of describing durations using inclusive dates.
 *
 * i.e. 2018-01-01T00:00:00 to 2019-01-01T00:00:00 is described as
 *      "Jan 1 2018 to Dec 31 2018"
 *
 */
export function momentToHuman(d, adjust) {
    if (d.hours() + d.minutes() + d.seconds() === 0) { 
        if (adjust) {
            d = d.clone().subtract(1, 'day');
        }
        return d.format('D MMM Y');
    }
    return d.format("D MMM Y HH:mm:ss");
}

/*
 * Format a number with a thousands separator, and the specified number of
 * decimal places.
 */
export function formatNumber(value, decimals) {
    const n = Decimal(value);
    const s = decimals === undefined ? n.toFixed() : n.toFixed(Math.max(0, decimals));
    const parts = s.split('.');
    parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ",");
    return parts.join('.');
}

/* 
 * Takes a string phrase and breaks it into separate phrases no bigger than
 * 'maxwidth'. breaks are made at complete words.
 */
export function wrapLabel(str, maxwidth) {
    const sections = [];
    const words = str.split(" ");
    let temp = "";

    words.forEach((item, index) => {
        if (temp.length > 0) {
            const concat = temp + ' ' + item;

            if (concat.length > maxwidth){
                sections.push(temp);
                temp = "";
            }
            else {
                if (index === (words.length-1)) {
                    sections.push(concat);
                    return;
                }
                else {
                    temp = concat;
                    return;
                }
            }
        }

        if (index === (words.length-1)) {
            sections.push(item);
            return;
        }

        if (item.length < maxwidth) {
            temp = item;
        }
        else {
            sections.push(item);
        }
    });
    return sections;
}

/*
 * Truncate the label to the specified length, breaking on a word boundary, and
 * adding an ellipsis if the label is actually shortened.
 */
export function truncateLabel(label, length) {
    let vv = wrapLabel(label, length);
    let t = vv[0];
    if (vv.length > 1) {
        t += ' \u2026';
    }
    return t;
}

/* 
 * The JSON format supports datetimes being abbreviated to just xsd:dates.
 * moment.js doesn't support timezoned dates, so fix them to midnight before
 * passing to moment 
 *
 * Note that the strings we're working with are not raw XBRL 2.1 dates, and
 * do not apply different conventions for start and aned dates.  A date
 * with no time part always means T00:00:00.
 */
export function xbrlDateToMoment(dateString) {
    /* If the string has something after the date part other than a time part,
     * insert a time part of 'T00:00:00'
     *
     * i.e. 2010-01-01Z => 2010-01-01T00:00:00Z
     */
    dateString = dateString.replace(
        /^(\d{4,}-\d{2}-\d{2})(?!T|$)/, 
        (match, $1) => $1 + 'T00:00:00'
    );
    return moment.utc(dateString);
}

export function escapeRegex(text) {
    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
}

export function setDefault(obj, key, def) {
    if (!obj.hasOwnProperty(key)) {
        obj[key] = def;
    }
    return obj[key];
}

export function runGenerator(generator) {
    function resume() {
        const res = generator.next();
        if (!res.done) {
            setTimeout(resume, 0);
        }
        return;
    }
    setTimeout(resume, 0);
}

/**
 * Word-by-word title-casing that preserves existing uppercase characters
 * @param  {String} text  Text to title-case
 * @return {String} Title-cased string
 */
export function titleCase(text) {
    if (!text) return text;
    return text.split(' ').map(word => {
        return Array.from(word)
                .map((c, i) => (i === 0) ? c.toUpperCase() : c)
                .join('');
    }).join(' ');
}

/**
 * Extract the alpha value from an rgba(r,g,b,a) string and returns true if
 * transparent (a < 10%).  Returns false on rgb(r,g,b) strings.
 * @param  {String}  rgba   color string to parse
 * @return {Boolean} whether the value is transparent
 */
export function isTransparent(rgba) {
    const val = parseFloat(rgba.split(",")[3]);
    return !isNaN(val) && val < 0.1;
}

/**
 * Prefix an item ID with the index of the report document that it appears in,
 * in order to generate an ID that is guaranteed to be unique within the
 * viewer. This is already within an iXBRL Document Set, but not across
 * separate iXBRL documents or document sets.
 * @param  {Number}  sourceReportIndex - index of the report document containing the fact
 * @param  {String}  localId - local ID of the fact
 * @return {String}   a viewer unique ID
 */

export function viewerUniqueId(sourceReportIndex, localId) {
    if (localId === null || localId === undefined) {
        return null;
    }
    return sourceReportIndex.toString() + "-" + localId;
}

export function localId(viewerUniqueId) {
    return viewerUniqueId.replace(/^\d+-/,"");
}

/**
 * Parses fact IDs from -sec-ix-hidden and -esef-ix-hidden style 
 * attributes on a DOM node.  
 * Any returned ID should be the ID of a fact in ix:hidden corresponding
 * to the content contained in the DOM node.
 * 
 * @param  {Node}     domNode - DOM node to parse
 * @return {String}   A fact ID, or null if the element does not have 
 * a style attribute containing a custom CSS property in the required 
 * format.
 */

export function getIXHiddenLinkStyle(domNode) {
    if (domNode.hasAttribute('style')) {
        const re = /(?:^|\s|;)(?:-sec|-esef)?-ix-hidden:\s*([^\s;]+)/;
        const m = domNode.getAttribute('style').match(re);
        if (m) {
            return m[1];
        }
    }
    return null;
}

/**
 * Moves all attributes from one element to another, excluding data attributes created by the viewer application.
 */
export function moveNonAppAttributes(fromElement, toElement) {
    for (const attr of [...fromElement.attributes]) {
        if (!attr.name.startsWith("data-")) {
            toElement.setAttribute(attr.name, attr.value); 
            fromElement.removeAttribute(attr.name);
        }
    }
    for (const [key, value] of Object.entries(fromElement.dataset)) {
        if (!key.startsWith(IXBRL_VIEWER_DATASET_PREFIX)) {
            toElement.dataset[key] = value;
            delete fromElement.dataset[key];
        }
    }
}
