ixbrl-viewer 1.4.21__py3-none-any.whl → 1.4.49__py3-none-any.whl

iXBRLViewerPlugin/viewer/src/js/calculation.js

@@ -1,10 +1,10 @@
 // See COPYRIGHT.md for copyright information
 
-import $ from 'jquery';
 import Decimal from 'decimal.js';
 import { setDefault } from './util.js';
 import { Interval } from './interval.js';
 import { FactSet } from './factset.js';
+import { CALC11_ARCROLE, CALC_ARCROLE } from './util.js';
 
 export class Calculation {
     
@@ -19,13 +19,16 @@ export class Calculation {
         const fact = this.fact;
         const report = fact.report;
         if (!this._conceptToFact) {
-            const rels = report.getChildRelationships(fact.conceptName(), "calc")
             const ctf = {};
-            for (const [elr, rr] of Object.entries(rels)) {
-                ctf[elr] = {};
-                if (rr.length > 0) {
-                    const otherFacts = report.getAlignedFacts(fact, {"c": rr.map(r => r.t )});
-                    otherFacts.forEach(otherFact => setDefault(ctf[elr], otherFact.conceptName(), new FactSet()).add(otherFact));
+            for (const version of [CALC_ARCROLE, CALC11_ARCROLE]) {
+                const rels = report.getChildRelationships(fact.conceptName(), version)
+                for (const [elr, rr] of Object.entries(rels)) {
+                    setDefault(ctf, version, {});
+                    ctf[version][elr] = {};
+                    if (rr.length > 0) {
+                        const otherFacts = report.getAlignedFacts(fact, {"c": rr.map(r => r.t )});
+                        otherFacts.forEach(otherFact => setDefault(ctf[version][elr], otherFact.conceptName(), new FactSet()).add(otherFact));
+                    }
                 }
             }
             this._conceptToFact = ctf;
@@ -41,11 +44,13 @@ export class Calculation {
     resolvedCalculations() {
         const calculations = [];
         const ctf = this.calculationFacts();
-        for (const [elr, concepts] of Object.entries(ctf)) {
-            if (Object.keys(concepts).length > 0) {
-                calculations.push(this.resolvedCalculation(elr));
-            }
-        } 
+        for (const [version, o] of Object.entries(ctf)) {
+            for (const [elr, concepts] of Object.entries(o)) {
+                if (Object.keys(concepts).length > 0) {
+                    calculations.push(this.resolvedCalculation(elr, version));
+                }
+            } 
+        }
         return calculations;
     }
 
@@ -56,35 +61,36 @@ export class Calculation {
         const ctf = this.calculationFacts();
         let bestMatchELR = "";
         let bestMatchCount = -1;
-        for (const [elr, rr] of Object.entries(ctf)) {
-            let matchCount = 0;
-            for (const [concept, calcFactSet] of Object.entries(rr)) {
-                let matched = 0;
-                for (const calcFact of calcFactSet.items()) {
-                    if (facts.includes(calcFact.vuid)) {
-                        matched = 1;
-                    } 
+        for (const [version, o] of Object.entries(ctf)) {
+            for (const [elr, rr] of Object.entries(o)) {
+                let matchCount = 0;
+                for (const [concept, calcFactSet] of Object.entries(rr)) {
+                    let matched = 0;
+                    for (const calcFact of calcFactSet.items()) {
+                        if (facts.includes(calcFact.vuid)) {
+                            matched = 1;
+                        } 
+                    }
+                    matchCount += matched;
                 }
-                matchCount += matched;
-            }
-            if (matchCount/Object.keys(rr).length > bestMatchCount) {
-                bestMatchCount = matchCount/Object.keys(rr).length;    
-                bestMatchELR = elr;
-            }
-        } 
+                if (matchCount/Object.keys(rr).length > bestMatchCount) {
+                    bestMatchCount = matchCount/Object.keys(rr).length;    
+                    bestMatchELR = elr;
+                }
+            } 
+        }
         return bestMatchELR;
     }
 
     /*
      * Returns a ResolvedCalculation object for the specified ELR
      */
-    resolvedCalculation(elr) {
-        const calc = [];
-        const calcFacts = this.calculationFacts()[elr];
+    resolvedCalculation(elr, version) {
+        const calcFacts = this.calculationFacts()[version][elr];
         const report = this.fact.report;
-        const rels = report.getChildRelationships(this.fact.conceptName(), "calc")[elr];
+        const rels = report.getChildRelationships(this.fact.conceptName(), version)[elr];
         const resolvedCalcClass = this.calc11 ? ResolvedCalc11Calculation : ResolvedLegacyCalculation;
-        const resolvedCalculation = new resolvedCalcClass(elr, this.fact);
+        const resolvedCalculation = new resolvedCalcClass(elr, this.fact, version);
         for (const r of rels) {
             const factset = calcFacts[r.t] ?? new FactSet();
             resolvedCalculation.addRow(new CalculationContribution(report.getConcept(r.t), r.w, factset));
@@ -122,11 +128,12 @@ class CalculationContribution {
 
 class AbstractResolvedCalculation {
 
-    constructor(elr, fact) {
+    constructor(elr, fact, relationshipVersion) {
         this.totalFact = fact;
         this.totalFactSet = new FactSet(fact.report.getAlignedFacts(fact));
         this.elr = elr;
         this.rows = [];
+        this.relationshipVersion = relationshipVersion;
     }
 
     addRow(contribution) {
@@ -173,13 +180,17 @@ export class ResolvedCalc11Calculation extends AbstractResolvedCalculation {
 export class ResolvedLegacyCalculation extends AbstractResolvedCalculation {
 
     binds() {
-        return super.binds() && this.rows.every((r) => r.facts.completeDuplicates());
+        return this.relationshipVersion == CALC_ARCROLE && super.binds() && this.rows.every((r) => r.facts.completeDuplicates());
     }
 
     unchecked() {
         return super.binds() && !this.binds();
     }
 
+    uncheckedDueToVersionMismatch() {
+        return this.relationshipVersion !== CALC_ARCROLE;
+    }
+
     calculatedTotal() {
         let total = new Decimal(0);
 

iXBRLViewerPlugin/viewer/src/js/calculationInspector.js

@@ -16,7 +16,7 @@ import $ from 'jquery';
 import i18next from 'i18next';
 
 import { Dialog } from './dialog.js';
-import { ResolvedCalc11Calculation, ResolvedLegacyCalculation } from './calculation.js';
+import { ResolvedCalc11Calculation } from './calculation.js';
 
 export class CalculationInspector extends Dialog {
     constructor() {
@@ -112,8 +112,6 @@ export class CalculationInspector extends Dialog {
         let hasIcons = false;
         for (const row of resolvedCalculation.rows) {
             let factText = "";
-            let minText = "";
-            let maxText = "";
 
             if (!row.facts.isEmpty()) {
                 let f = row.facts.items()[0];
@@ -162,7 +160,6 @@ export class CalculationInspector extends Dialog {
         const tbody = table.find("tbody");
         // We remove the padding on the icons column (used to indicate
         // duplicate facts) if it is empty to avoid an unsightly gap
-        var hasIcons = false;
         tbody.empty();
         table.removeClass("has-icons");
         if (resolvedCalculation instanceof ResolvedCalc11Calculation) {
@@ -176,13 +173,13 @@ export class CalculationInspector extends Dialog {
         const messageCell = table.find("td.status");
         messageCell.removeClass("inconsistent").removeClass("consistent").removeClass("unchecked");
         if (resolvedCalculation.unchecked()) {
-            messageCell.addClass("unchecked").find(".message").text("Calculation does not bind");
+            messageCell.addClass("unchecked").find(".message").text(i18next.t('calculation.does-not-bind'));
         } 
         else if (resolvedCalculation.isConsistent()) {
-            messageCell.addClass("consistent").find(".message").text("Calculation is consistent");
+            messageCell.addClass("consistent").find(".message").text(i18next.t('factDetails.calculationIsConsistent'));
         }
         else {
-            messageCell.addClass("inconsistent").find(".message").text("Calculation is inconsistent");
+            messageCell.addClass("inconsistent").find(".message").text(i18next.t('factDetails.calculationIsInconsistent'));
         }
     }
 }

iXBRLViewerPlugin/viewer/src/js/chart.js

@@ -1,14 +1,21 @@
 // See COPYRIGHT.md for copyright information
 
 import $ from 'jquery';
-import Chart from 'chart.js';
+import { BarController, BarElement, CategoryScale, Chart, LinearScale } from 'chart.js';
 import { AspectSet } from './aspect.js';
 import { wrapLabel } from "./util.js";
 import { Dialog } from './dialog.js';
+import { getVariable } from './theme.js';
+
 
 export class IXBRLChart extends Dialog {
     constructor() {
         super(".dialog.chart");
+        this.dataSetColours = [
+            getVariable('--colour-primary'),
+            getVariable('--colour-secondary'),
+            getVariable('--colour-warning'),
+        ]
     }
 
     _multiplierDescription(m) {
@@ -32,11 +39,7 @@ export class IXBRLChart extends Dialog {
     }
 
     dataSetColour(i) {
-        return [
-            '#66cc00',
-            '#0094ff',
-            '#fbad17'
-        ][i];
+        return this.dataSetColours[i];
     }
 
     addAspect(a) {
@@ -139,13 +142,13 @@ export class IXBRLChart extends Dialog {
         for (const av of fact.aspects()) {
             /* Don't show concept in list of additional aspects */
             if (av.name() != 'c') {
-                const a = $("<div>")
+                const a = $("<button>")
                     .addClass("other-aspect")
                     .appendTo($(".other-aspects",c));
                 if (dims.includes(av.name())) {
                     a.addClass("selected")
                         .text(av.label() + ": *")
-                        .click(() => this.removeAspect(av.name()));
+                        .on("click", () => this.removeAspect(av.name()));
                 }
                 else {
                     if (av.name() != 'u') {
@@ -154,7 +157,7 @@ export class IXBRLChart extends Dialog {
                     a.text(av.label() + ": " + av.valueLabel());
                     if (dims.length < 2) {
                         a.addClass("addable")
-                            .click(() => this.addAspect(av.name()));
+                            .on("click", () => this.addAspect(av.name()));
                     }
                 }
             }
@@ -173,6 +176,7 @@ export class IXBRLChart extends Dialog {
         this.setChartSize();
 
         const ctx = $("canvas", c);
+        Chart.register(BarController, BarElement, CategoryScale, LinearScale);
         const chart = new Chart(ctx, {
             type: "bar",
             data: {
@@ -183,29 +187,27 @@ export class IXBRLChart extends Dialog {
                 responsive: true,
                 maintainAspectRatio: false,
                 scales: {
-                    yAxes: [{
-                        ticks: {
-                            beginAtZero:true
-                        },
-                        scaleLabel: {
+                    y: {
+                        beginAtZero: true,
+                        title: {
                             display: true,
-                            labelString:  yLabel,
-                        }
-
-                    }],
-                    xAxes: [{
+                            text: yLabel,
+                        },
+                    },
+                    x: {
                         ticks: {
                             autoSkip: false
                         }
-                    }]
+                    }
                 }
                 
             }
         });
-        $(window).resize(() => {  
+        $(window).on("resize", () => {  
             this.setChartSize();
             chart.resize();
         });
+        $(".other-aspect", c).get(0)?.focus();
     }
 
     setChartSize() {

iXBRLViewerPlugin/viewer/src/js/concept.js

@@ -1,6 +1,7 @@
 // See COPYRIGHT.md for copyright information
 
-import $ from 'jquery'
+import { DataType } from "./datatype.js";
+import { Balance } from "./balance.js";
 
 export class Concept {
     constructor(report, name) {
@@ -24,6 +25,18 @@ export class Concept {
         }
     }
 
+    labels() {
+        if (!this._c.labels) {
+            return {};
+        }
+        const lang = this.report.reportSet.viewerOptions.language;
+        return Object.fromEntries(
+            Object.entries(this._c.labels)
+                .map(([role, labels]) => [role, labels[lang]])
+                .filter(([role, label]) => label !== undefined)
+        )
+    }
+
     references() {
         if (!this._c.r) {
             return [];
@@ -62,6 +75,18 @@ export class Concept {
     }
 
     typedDomainElement() {
-        return this._c.td
+        return this._c.td;
+    }
+
+    dataType() {
+        if (this._c.dt !== undefined) {
+            return new DataType(this.report, this._c.dt);
+        }
+    }
+
+    balance() {
+        if (this._c.b !== undefined) {
+            return new Balance(this._c.b);
+        }
     }
 }

iXBRLViewerPlugin/viewer/src/js/concept.test.js

@@ -2,6 +2,12 @@
 
 import { ReportSet } from "./reportset.js";
 import { NAMESPACE_ISO4217 } from "./util";
+import { TestInspector } from "./test-utils.js";
+
+const insp = new TestInspector();
+beforeAll(() => {
+    insp.i18nInit();
+});
 
 const testReportData = {
     "prefixes": {
@@ -15,14 +21,16 @@ const testReportData = {
                 "std": {
                     "en": "English label"
                 }
-            }
+            },
+            "b": "debit"
         },
         "eg:Concept2": {
             "labels": {
                 "std": {
                     "en": "English label for concept two"
                 }
-            }
+            },
+            "b": "credit"
         },
         "eg:Concept3": {
             "labels": {
@@ -86,3 +94,16 @@ describe("Concept references", () => {
             ]);
     });
 });
+
+describe("Balance types", () => {
+    test("Debit/Credit", () => {
+        const rs = new ReportSet(testReportData);
+        rs._initialize();
+        const r = rs.reports[0];
+        expect(r.getConcept("eg:Concept1").balance().balance).toBe("debit");
+        expect(r.getConcept("eg:Concept1").balance().label()).toBe("Debit");
+        expect(r.getConcept("eg:Concept2").balance().balance).toBe("credit");
+        expect(r.getConcept("eg:Concept2").balance().label()).toBe("Credit");
+        expect(r.getConcept("eg:Concept3").balance()).toBeUndefined();
+    });
+});

iXBRLViewerPlugin/viewer/src/js/datatype.js

@@ -0,0 +1,20 @@
+// See COPYRIGHT.md for copyright information
+
+import i18next from 'i18next';
+import { NAMESPACE_XBRLI } from "./util.js";
+
+export class DataType {
+    constructor(report, name) {
+        this.name = name;
+        this.report = report;
+        this.qname = report.qname(name);
+    }
+
+    label() {
+        if (this.qname.namespace == NAMESPACE_XBRLI) {
+            return i18next.t(`dataTypes:${this.qname.localname}`, {defaultValue: this.qname.qname});
+        }
+        return this.report.reportSet.taxonomyNamer.convertQName(this.qname);
+    }
+
+}

iXBRLViewerPlugin/viewer/src/js/datatype.test.js

@@ -0,0 +1,62 @@
+// See COPYRIGHT.md for copyright information
+
+import { ReportSet } from "./reportset.js";
+import { NAMESPACE_ISO4217, NAMESPACE_XBRLI } from "./util";
+import { TestInspector } from "./test-utils.js";
+
+const testReportData = {
+    "prefixes": {
+        "eg": "http://www.example.com",
+        "iso4217": NAMESPACE_ISO4217,
+        "xbrli": NAMESPACE_XBRLI,
+        "e": "http://example.com/entity",
+    },
+    "concepts": {
+    },
+    "facts": {
+    }
+}
+
+function testReport(concept) {
+    // Deep copy of standing data
+    const data = JSON.parse(JSON.stringify(testReportData));
+    data.concepts["eg:concept"] = concept;
+    const reportSet = new ReportSet(data);
+    reportSet.setIXNodeMap({});
+    return reportSet.reports[0];
+}
+
+const insp = new TestInspector();
+beforeAll(() => {
+    insp.i18nInit();
+});
+
+describe("Data types", () => {
+    test("Monetary", () => {
+        const r1 = testReport({ "dt": "xbrli:monetaryItemType" });
+        expect(r1.getConcept("eg:concept").dataType().label()).toBe("Monetary");
+    });
+
+    test("String", () => {
+        const r1 = testReport({ "dt": "xbrli:stringItemType" });
+        expect(r1.getConcept("eg:concept").dataType().label()).toBe("String");
+    });
+
+    test("Unknown xbrli", () => {
+        const r1 = testReport({ "dt": "xbrli:unknown" });
+        expect(r1.getConcept("eg:concept").dataType().label()).toBe("xbrli:unknown");
+    });
+
+    test("Custom", () => {
+        const r1 = testReport({ "dt": "eg:stringItemType" });
+        expect(r1.getConcept("eg:concept").dataType().label()).toBe("eg:stringItemType");
+    });
+
+    test("No datatype", () => {
+        const r1 = testReport({});
+        expect(r1.getConcept("eg:concept").dataType()).toBeUndefined();
+    });
+})
+
+
+

iXBRLViewerPlugin/viewer/src/js/dialog.js

@@ -6,9 +6,9 @@ export class Dialog {
     constructor(selector) {
         this.node = $("#dialog-templates").find(selector).clone().appendTo("#ixv #dialog-container");
 
-        $('.close', this.node).click(() => this.close());
-        $(document).bind("keyup", (e) => {
-            if (e.keyCode === 27) {
+        $('.close', this.node).on("click", () => this.close());
+        $(document).on("keyup", (e) => {
+            if (e.which === 27) {
                 this.close();
             }
         });
@@ -28,11 +28,13 @@ export class Dialog {
 
     close() {
         $('.dialog-mask').hide(); 
-        this.node.remove() ;
+        this.node.get(0).close();
+        this.node.remove();
     }
 
     show() {
         $('.dialog-mask').show(); 
+        this.node.get(0).showModal();
         this.node.show();
     }
 }

iXBRLViewerPlugin/viewer/src/js/fact.js

@@ -2,8 +2,6 @@
 
 import $ from 'jquery'
 import i18next from "i18next";
-import { isodateToHuman } from "./util.js"
-import { QName } from "./qname.js"
 import { Aspect } from "./aspect.js";
 import { Period } from './period.js';
 import { formatNumber, localId } from "./util.js";
@@ -25,18 +23,34 @@ export class Fact {
         return localId(this.vuid);
     }
 
+    isMandatory() {
+        return this.f.a.m
+    }
+
     getLabel(rolePrefix, withPrefix) {
         return this.report.getLabel(this.f.a.c, rolePrefix, withPrefix);
     }
 
+    getLabelAndLang(rolePrefix, withPrefix) {
+        return this.report.getLabelAndLang(this.f.a.c, rolePrefix, withPrefix);
+    }
+
     getLabelOrName(rolePrefix, withPrefix) {
         return this.report.getLabelOrName(this.f.a.c, rolePrefix, withPrefix);
     }
 
+    getLabelOrNameAndLang(rolePrefix, withPrefix) {
+        return this.report.getLabelOrNameAndLang(this.f.a.c, rolePrefix, withPrefix);
+    }
+
     conceptName() {
         return this.f.a.c;
     }
 
+    conceptDisplayName() {
+        return this.report.reportSet.taxonomyNamer.convertQName(this.conceptQName());
+    }
+
     concept() {
         return this.report.getConcept(this.f.a.c); 
     }
@@ -67,9 +81,16 @@ export class Fact {
     }
 
     readableValue(val) {
+        return this.readableValueHTML(val).textContent;
+    }
+
+    readableValueHTML(val) {
         let v = val === undefined ? this.f.v : val;
+        const span = document.createElement("span");
+        span.classList.add("fact-value");
         if (this.isInvalidIXValue()) {
-            v = "Invalid value";
+            span.classList.add("fact-value-invalid");
+            span.append(document.createTextNode("Invalid value"));
         }
         else if (this.isNumeric()) {
             const d = this.decimals();
@@ -81,14 +102,17 @@ export class Fact {
                 formattedNumber = formatNumber(v, d);
             }
             if (this.isMonetaryValue()) {
-                v = this.unitLabel() + " " + formattedNumber;
+                span.append(this.unitLabelHTML());
+                span.append(document.createTextNode(" " + formattedNumber));
             }
             else {
-                v = formattedNumber + " " + this.unitLabel();
+                span.append(document.createTextNode(formattedNumber + " "));
+                span.append(this.unitLabelHTML());
             }
         }
         else if (this.isNil()) {
-            v = "nil";
+            span.classList.add("fact-value-nil");
+            span.append(document.createTextNode("nil"));
         }
         else if (this.isTextBlock()) {
             const html = $("<div>").append($($.parseHTML(v, null, false)));
@@ -100,6 +124,7 @@ export class Fact {
                 .prepend(document.createTextNode(' '));
             /* Replace runs of whitespace (including nbsp) with a single space */
             v = html.text().replace(/[\u00a0\s]+/g, " ").trim();
+            span.append(document.createTextNode(v));
         }
         else if (this.isEnumeration()) {
             const labels = [];
@@ -107,8 +132,12 @@ export class Fact {
                 labels.push(this.report.getLabelOrName(qn, 'std'));
             }
             v = labels.join(', ');
+            span.append(document.createTextNode(v));
         }
-        return v;
+        else {
+            span.append(document.createTextNode(v));
+        }
+        return span;
     }
 
     /**
@@ -134,6 +163,10 @@ export class Fact {
         return this.unit()?.label() ?? i18next.t("factDetails.noUnit");
     }
 
+    unitLabelHTML() {
+        return this.unit()?.html() ?? document.createTextNode(i18next.t("factDetails.noUnit"));
+    }
+
     getConceptPrefix() {
         return this.conceptName().split(':')[0];
     }

iXBRLViewerPlugin/viewer/src/js/fact.test.js

@@ -690,10 +690,13 @@ describe("Get Label", () => {
 
     test("Get standard label", () => {
         expect(f.getLabel("std")).toEqual("English label")
+        expect(f.getLabelAndLang("std").label).toEqual("English label")
+        expect(f.getLabelAndLang("std").lang).toEqual("en")
     });
 
     test("Get non-existent label", () => {
         expect(f.getLabel("doc")).toBeUndefined();
+        expect(f.getLabelAndLang("doc").label).toBeUndefined();
     });
 
 });

iXBRLViewerPlugin/viewer/src/js/index.js

@@ -3,9 +3,17 @@
 import $ from 'jquery'
 import { iXBRLViewer } from "./ixbrlviewer.js";
 
+const scriptSrc = document.currentScript.src;
+
 $(() => {
-    const iv = new iXBRLViewer({
-        showValidationWarningOnStart: true
-    });
+    const options = {
+        showValidationWarningOnStart: true,
+    };
+    const configUrl = new URL("ixbrlviewer.config.json", scriptSrc);
+    if (configUrl.protocol != 'file:') {
+        options["configUrl"] = configUrl;
+    }
+
+    const iv = new iXBRLViewer(options);
     iv.load();
 });