ixbrl-viewer 1.4.1__py3-none-any.whl → 1.4.86__py3-none-any.whl

iXBRLViewerPlugin/viewer/src/js/calculationInspector.js

@@ -0,0 +1,187 @@
+// Copyright 2021 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import $ from 'jquery';
+import i18next from 'i18next';
+
+import { Dialog } from './dialog.js';
+import { ResolvedCalc11Calculation } from './calculation.js';
+
+export class CalculationInspector extends Dialog {
+    constructor() {
+        super(".dialog.calculation-inspector");
+        this.addButton("Dismiss", true);
+    }
+
+    duplicateFactIcons(factset) {
+        const icons = $("<td></td>").addClass("icons");
+        if (factset.size() > 1 && !factset.completeDuplicates()) {
+            if (factset.isConsistent()) {
+                icons.append(
+                    $("<span></span>")
+                    .addClass("duplicate-facts")
+                    .attr("title", i18next.t('calculation.consistent-duplicate-facts-present', {nfacts: factset.size()}))
+                );
+            }
+            else {
+                icons.append(
+                    $("<span></span>")
+                    .addClass("duplicate-facts")
+                    .attr("title", i18next.t('calculation.inconsistent-duplicate-facts-present', {nfacts: factset.size()}))
+                );
+            }
+        }
+        return icons;
+    }
+
+    populateCalc11Table(resolvedCalculation, table) {
+        table.addClass("calc11");
+        const tbody = table.find("tbody");
+        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];
+                const reportedInterval = row.facts.valueIntersection();
+                if (reportedInterval === undefined) {
+                    factText = "n/a";
+                    minText = "n/a"; 
+                    maxText = "n/a";
+                }
+                else {
+                    factText = f.readableValue(reportedInterval.midpoint().toNumber());
+                    const contributionInterval = row.contributionInterval();
+                    minText = f.readableValue(contributionInterval.a.toNumber());
+                    maxText = f.readableValue(contributionInterval.b.toNumber());
+                }
+            }
+            const icons = this.duplicateFactIcons(row.facts);
+            hasIcons = hasIcons || icons.find("span").length > 0;
+            $("<tr></tr>")
+                .append($("<td></td>").addClass("weight").text(row.weightSign))
+                .append($("<td></td>").text(row.concept.label()).addClass("line-item"))
+                .append($("<td></td>").addClass("figure").text(factText))
+                .append(icons)
+                .append($("<td></td>").addClass("figure").text(minText))
+                .append($("<td></td>").addClass("figure").text(maxText))
+                .appendTo(tbody);
+        }
+        const fact = resolvedCalculation.totalFact;
+        const cvi = resolvedCalculation.calculatedTotalInterval();
+            $("<tr></tr>").addClass("total")
+                .append($("<td></td>"))
+                .append($("<td></td>").text(`${fact.concept().label()} (${i18next.t('calculation.calculated-total')})`).addClass("line-item"))
+                .append($("<td></td>").text(cvi === undefined ? 'n/a' : fact.readableValue(cvi.midpoint().toNumber())).addClass("figure"))
+                .append($("<td></td>").addClass("icons"))
+                .append($("<td></td>").text(cvi === undefined ? 'n/a' : fact.readableValue(cvi.a.toNumber())).addClass("figure"))
+                .append($("<td></td>").text(cvi === undefined ? 'n/a' : fact.readableValue(cvi.b.toNumber())).addClass("figure"))
+                .appendTo(tbody);
+
+        const tvi = resolvedCalculation.totalFactSet.valueIntersection();
+        const icons = this.duplicateFactIcons(resolvedCalculation.totalFactSet);
+        $("<tr></tr>")
+            .append($("<td></td>"))
+            .append($("<td></td>").text(`${fact.concept().label()} (${i18next.t('calculation.reported-total')})`).addClass("line-item"))
+            .append($("<td></td>").text(tvi === undefined ? 'n/a' : fact.readableValue(tvi.midpoint().toNumber())).addClass("figure"))
+            .append(icons)
+            .append($("<td></td>").text(tvi === undefined ? 'n/a' : fact.readableValue(tvi.a.toNumber())).addClass("figure"))
+            .append($("<td></td>").text(tvi === undefined ? 'n/a' : fact.readableValue(tvi.b.toNumber())).addClass("figure"))
+            .appendTo(tbody);
+        if (hasIcons) {
+            table.addClass("has-icons");
+        }
+    }
+
+    populateLegacyCalcTable(resolvedCalculation, table) {
+        table.removeClass("calc11");
+        const tbody = table.find("tbody");
+        let hasIcons = false;
+        for (const row of resolvedCalculation.rows) {
+            let factText = "";
+
+            if (!row.facts.isEmpty()) {
+                let f = row.facts.items()[0];
+                const reportedInterval = row.facts.valueIntersection();
+                if (reportedInterval === undefined) {
+                    factText = "Inconsistent duplicates";
+                }
+                else if (!row.facts.completeDuplicates()) {
+                    factText = "Duplicate facts"; 
+                }
+                else {
+                    factText = f.readableValue();
+                }
+            }
+            const icons = this.duplicateFactIcons(row.facts);
+            hasIcons = hasIcons || icons.find("span").length > 0;
+            $("<tr></tr>")
+                .append($("<td></td>").addClass("weight").text(row.weightSign))
+                .append($("<td></td>").text(row.concept.label()).addClass("line-item"))
+                .append($("<td></td>").addClass("figure").text(factText))
+                .append(icons)
+                .appendTo(tbody);
+        }
+        const fact = resolvedCalculation.totalFact;
+        const ct = resolvedCalculation.calculatedTotal();
+        $("<tr></tr>").addClass("total")
+            .append($("<td></td>"))
+            .append($("<td></td>").text(`${fact.concept().label()} (${i18next.t('calculation.calculated-total')})`).addClass("line-item"))
+            .append($("<td></td>").text(fact.readableValue(ct)).addClass("figure"))
+            .append($("<td></td>").addClass("icons"))
+            .appendTo(tbody);
+
+        $("<tr></tr>")
+            .append($("<td></td>"))
+            .append($("<td></td>").text(`${fact.concept().label()} (${i18next.t('calculation.reported-total')})`).addClass("line-item"))
+            .append($("<td></td>").text(fact.readableValue()).addClass("figure"))
+            .append($("<td></td>").addClass("icons"))
+            .appendTo(tbody);
+        if (hasIcons) {
+            table.addClass("has-icons");
+        }
+    }
+
+    displayCalculation(resolvedCalculation) {
+        const table = this.node.find("table.calculation-trace");
+        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
+        tbody.empty();
+        table.removeClass("has-icons");
+        if (resolvedCalculation instanceof ResolvedCalc11Calculation) {
+            this.populateCalc11Table(resolvedCalculation, table);
+        }
+        else {
+            this.populateLegacyCalcTable(resolvedCalculation, table);
+        }
+
+
+        const messageCell = table.find("td.status");
+        messageCell.removeClass("inconsistent").removeClass("consistent").removeClass("unchecked");
+        if (resolvedCalculation.unchecked()) {
+            messageCell.addClass("unchecked").find(".message").text(i18next.t('calculation.does-not-bind'));
+        } 
+        else if (resolvedCalculation.isConsistent()) {
+            messageCell.addClass("consistent").find(".message").text(i18next.t('factDetails.calculationIsConsistent'));
+        }
+        else {
+            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) {
@@ -76,7 +79,7 @@ export class IXBRLChart extends Dialog {
             covered[dims[1]] = null;
         }
 
-        const facts = fact.report().deduplicate(fact.report().getAlignedFacts(fact, covered));
+        const facts = fact.report.deduplicate(fact.report.getAlignedFacts(fact, covered));
 
         /* Get the unique aspect values along each dimension.  This is to ensure
          * that we assign facts to datasets consistently (we have one dataset per value
@@ -97,7 +100,7 @@ export class IXBRLChart extends Dialog {
         const uv2 = set2av.uniqueValues();
 
         const scale = this._chooseMultiplier(facts);
-        const yLabel = fact.measureLabel() + " " + this._multiplierDescription(scale);
+        const yLabel = fact.unitLabel() + " " + this._multiplierDescription(scale);
         const labels = [];
         
         const dataSets = [];
@@ -123,7 +126,7 @@ export class IXBRLChart extends Dialog {
                 if (dims[1]) {
                     covered[dims[1]] = uv2[j].value();
                 }
-                const dp = fact.report().getAlignedFacts(fact, covered);
+                const dp = fact.report.getAlignedFacts(fact, covered);
                 if (dp.length > 0) {
                     dataSets[j].data[i] = dp[0].value()/(10**scale);
                 }
@@ -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/chart.test.js

@@ -1,14 +1,14 @@
 // See COPYRIGHT.md for copyright information
 
-import { Fact } from "./fact.js";
 import { IXBRLChart } from "./chart.js";
-import { iXBRLReport } from "./report.js";
+import { ReportSet } from "./reportset.js";
 import { TestInspector } from "./test-utils.js";
+import { NAMESPACE_ISO4217 } from "./util";
 
 var testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {
@@ -74,21 +74,22 @@ var testReportData = {
 
 function testReport(facts, ixData) {
     // Deep copy of standing data
-    var data = JSON.parse(JSON.stringify(testReportData));
+    const data = JSON.parse(JSON.stringify(testReportData));
     data.facts = facts;
-    var report = new iXBRLReport(data);
-    report.setIXNodeMap(ixData);
-    return report;
+    const reportSet = new ReportSet(data);
+    reportSet.setIXNodeMap(ixData);
+    return reportSet;
 }
 
 function testFact(factData, ixData) {
     factData.a = factData.a || {};
     factData.a.c = factData.a.c || 'eg:Concept1';
     ixData = ixData || {};
-    return new Fact(testReport({"f1": factData}, {"f1": ixData }), "f1");
+    const reportSet = testReport({"f1": factData}, {"f1": ixData });
+    return reportSet.getItemById("0-f1"); 
 }
 
-var insp = new TestInspector();
+const insp = new TestInspector();
 beforeAll(() => {
     return insp.i18nInit();
 });

iXBRLViewerPlugin/viewer/src/js/concept.js

@@ -1,10 +1,15 @@
 // 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) {
-        this._c = report.data.concepts[name] || {};
+        const c = report.concepts()[name];
+        this.hasDefinition = (c !== undefined);
+        this._c = c ?? {};
+        this.name = name;
+        this.report = report;
     }
 
     /*
@@ -22,6 +27,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 [];
@@ -48,7 +65,11 @@ export class Concept {
     }
 
     isEnumeration() {
-        return Boolean(this._c.e);
+        return Boolean(this._c && this._c.e);
+    }
+
+    label() {
+        return this.report.getLabelOrName(this.name);
     }
 
     isTextBlock() {
@@ -56,6 +77,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

@@ -1,11 +1,18 @@
 // See COPYRIGHT.md for copyright information
 
-import { iXBRLReport } from "./report.js";
+import { ReportSet } from "./reportset.js";
+import { NAMESPACE_ISO4217 } from "./util";
+import { TestInspector } from "./test-utils.js";
 
-var testReportData = {
+const insp = new TestInspector();
+beforeAll(() => {
+    insp.i18nInit();
+});
+
+const testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {
@@ -14,14 +21,16 @@ var testReportData = {
                 "std": {
                     "en": "English label"
                 }
-            }
+            },
+            "b": "debit"
         },
         "eg:Concept2": {
             "labels": {
                 "std": {
                     "en": "English label for concept two"
                 }
-            }
+            },
+            "b": "credit"
         },
         "eg:Concept3": {
             "labels": {
@@ -48,7 +57,9 @@ var testReportData = {
 };
 
 describe("Concept references", () => {
-    var r = new iXBRLReport(testReportData);
+    const rs = new ReportSet(testReportData);
+    rs._initialize();
+    const r = rs.reports[0];
     test("Absent reference", () => {
         var c1 = r.getConcept("eg:Concept1");
         expect(c1.referenceValuesAsString()).toEqual("");
@@ -83,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/docOrderIndex.js

@@ -5,21 +5,21 @@ export class DocOrderIndex {
         this.index = [];
     }
 
-    addItem(id, docIndex) {
-        this.index.push({id: id, docIndex: docIndex});
+    addItem(vuid, docIndex) {
+        this.index.push({vuid: vuid, docIndex: docIndex});
     }
 
-    getAdjacentItem(id, offset) {
-        const currentIndex = this.index.findIndex(n => n.id == id);
+    getAdjacentItem(vuid, offset) {
+        const currentIndex = this.index.findIndex(n => n.vuid === vuid);
         const l = this.index.length;
-        return this.index[(currentIndex + offset + l) % l].id;
+        return this.index[(currentIndex + offset + l) % l].vuid;
     }
 
     getFirstInDocument(docIndex) {
-        return this.index.filter(n => n.docIndex == docIndex)[0].id;
+        return this.index.filter(n => n.docIndex === docIndex)[0].vuid;
     }
 
     getLastInDocument(docIndex) {
-        return this.index.filter(n => n.docIndex == docIndex).at(-1).id;
+        return this.index.filter(n => n.docIndex === docIndex).at(-1).vuid;
     }
 }