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

iXBRLViewerPlugin/viewer/src/js/factset.test.js

@@ -1,15 +1,17 @@
 // See COPYRIGHT.md for copyright information
 
-import { Fact } from "./fact.js";
 import { FactSet } from "./factset.js";
-import { iXBRLReport } from "./report.js";
+import { Fact  } from "./fact.js";
+import { NAMESPACE_ISO4217, viewerUniqueId } from "./util.js";
+import { ReportSet } from "./reportset.js";
+import './test-utils.js';
 
 var i = 0;
 
 var testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {
@@ -71,12 +73,13 @@ var testReportData = {
     }
 };
 
-function testReport(facts) {
+function testReportSet(facts) {
     // 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);
-    return report;
+    const reportset = new ReportSet(data);
+    reportset._initialize();
+    return reportset;
 }
 
 function testFact(aspectData) {
@@ -84,42 +87,46 @@ function testFact(aspectData) {
     return factData;
 }
 
+function getFact(reportSet, id) {
+  return reportSet.getItemById(viewerUniqueId(0, id));
+}
+
 describe("Minimally unique labels (non-dimensional)", () => {
-  var report = testReport({ 
+  const reportSet = testReportSet({ 
       "f1": testFact({"c": "eg:Concept1", "p": "2018-01-01"}),
       "f2": testFact({"c": "eg:Concept2", "p": "2018-01-01"}),
       "f3": testFact({"c": "eg:Concept2", "p": "2019-01-01"}),
       "f4": testFact({"c": "eg:Concept2", "p": "2019-01-01"}),
   });
 
-  var f1 = new Fact(report, "f1");
-  var f2 = new Fact(report, "f2");
-  var f3 = new Fact(report, "f3");
-  var f4 = new Fact(report, "f3");
+  const f1 = getFact(reportSet, "f1");
+  const f2 = getFact(reportSet, "f2");
+  const f3 = getFact(reportSet, "f3");
+  const f4 = getFact(reportSet, "f4");
 
   test("Different concept", () => {
-    var fs = new FactSet([ f1, f2 ]);
+    const fs = new FactSet([ f1, f2 ]);
     expect(fs._allDimensions()).toEqual([]);
     expect(fs.minimallyUniqueLabel(f1)).toEqual("Concept 1");
     expect(fs.minimallyUniqueLabel(f2)).toEqual("Concept 2");
   });
 
   test("Different period", () => {
-    var fs = new FactSet([ f2, f3 ]);
+    const fs = new FactSet([ f2, f3 ]);
     expect(fs._allDimensions()).toEqual([]);
     expect(fs.minimallyUniqueLabel(f2)).toEqual("31 Dec 2017");
     expect(fs.minimallyUniqueLabel(f3)).toEqual("31 Dec 2018");
   });
 
   test("Different concept and period, concept takes precedence", () => {
-    var fs = new FactSet([ f1, f4 ]);
+    const fs = new FactSet([ f1, f4 ]);
     expect(fs._allDimensions()).toEqual([]);
     expect(fs.minimallyUniqueLabel(f1)).toEqual("Concept 1");
     expect(fs.minimallyUniqueLabel(f4)).toEqual("Concept 2");
   });
 
   test("Mix of period and concept differences", () => {
-    var fs = new FactSet([ f1, f2, f3 ]);
+    const fs = new FactSet([ f1, f2, f3 ]);
     expect(fs._allDimensions()).toEqual([]);
     expect(fs.minimallyUniqueLabel(f1)).toEqual("Concept 1, 31 Dec 2017");
     expect(fs.minimallyUniqueLabel(f2)).toEqual("Concept 2, 31 Dec 2017");
@@ -128,27 +135,27 @@ describe("Minimally unique labels (non-dimensional)", () => {
 });
 
 describe("Minimally unique labels (dimensional)", () => {
-  var report = testReport({ 
+  const reportSet = testReportSet({ 
       "f1": testFact({"c": "eg:Concept1", "p": "2018-01-01", "eg:Dimension1": "eg:DimensionValue1"}),
       "f2": testFact({"c": "eg:Concept1", "p": "2018-01-01", "eg:Dimension1": "eg:DimensionValue2"}),
       "f3": testFact({"c": "eg:Concept1", "p": "2019-01-01", "eg:Dimension1": "eg:DimensionValue2"}),
       "f4": testFact({"c": "eg:Concept1", "p": "2018-01-01" }),
   });
 
-  var f1 = new Fact(report, "f1");
-  var f2 = new Fact(report, "f2");
-  var f3 = new Fact(report, "f3");
-  var f4 = new Fact(report, "f4");
+  const f1 = getFact(reportSet, "f1");
+  const f2 = getFact(reportSet, "f2");
+  const f3 = getFact(reportSet, "f3");
+  const f4 = getFact(reportSet, "f4");
 
   test("Same concept & period, different dimension value", () => {
-    var fs = new FactSet([ f1, f2 ]);
+    const fs = new FactSet([ f1, f2 ]);
     expect(fs._allDimensions()).toEqual(["eg:Dimension1"]);
     expect(fs.minimallyUniqueLabel(f1)).toEqual("Dimension Value 1");
     expect(fs.minimallyUniqueLabel(f2)).toEqual("Dimension Value 2");
   });
 
   test("Different period, different dimension value", () => {
-    var fs = new FactSet([ f1, f3 ]);
+    const fs = new FactSet([ f1, f3 ]);
     expect(fs._allDimensions()).toEqual(["eg:Dimension1"]);
     /* Different period takes precedence */
     expect(fs.minimallyUniqueLabel(f1)).toEqual("31 Dec 2017");
@@ -156,7 +163,7 @@ describe("Minimally unique labels (dimensional)", () => {
   });
 
   test("Dimension present on one fact only", () => {
-    var fs = new FactSet([ f1, f4 ]);
+    const fs = new FactSet([ f1, f4 ]);
     expect(fs._allDimensions()).toEqual(["eg:Dimension1"]);
     /* Concept is included even though it's the same across all to avoid an
      * empty label */
@@ -167,16 +174,16 @@ describe("Minimally unique labels (dimensional)", () => {
 });
 
 describe("Minimally unique labels (duplicate facts)", () => {
-  var report = testReport({ 
+  const reportSet = testReportSet({ 
       "f1": testFact({"c": "eg:Concept1", "p": "2018-01-01", "eg:Dimension1": "eg:DimensionValue1"}),
       "f2": testFact({"c": "eg:Concept1", "p": "2018-01-01", "eg:Dimension1": "eg:DimensionValue1"}),
   });
 
-  var f1 = new Fact(report, "f1");
-  var f2 = new Fact(report, "f2");
+  const f1 = getFact(reportSet, "f1");
+  const f2 = getFact(reportSet, "f2");
 
   test("Two facts, all aspects the same", () => {
-    var fs = new FactSet([ f1, f2 ]);
+    const fs = new FactSet([ f1, f2 ]);
     expect(fs._allDimensions()).toEqual(["eg:Dimension1"]);
     expect(fs.minimallyUniqueLabel(f1)).toEqual("Concept 1");
     expect(fs.minimallyUniqueLabel(f2)).toEqual("Concept 1");
@@ -184,13 +191,13 @@ describe("Minimally unique labels (duplicate facts)", () => {
 });
 
 describe("Minimally unique labels (missing labels)", () => {
-  var report = testReport({ 
+  const reportSet = testReportSet({ 
       "f1": testFact({"c": "eg:Concept1", "p": "2018-01-01" }),
       "f2": testFact({"c": "eg:Concept4", "p": "2018-01-01" }),
   });
 
-  var f1 = new Fact(report, "f1");
-  var f2 = new Fact(report, "f2");
+  const f1 = getFact(reportSet, "f1");
+  const f2 = getFact(reportSet, "f2");
 
   test("Two facts, one has no label", () => {
     var fs = new FactSet([ f1, f2 ]);
@@ -199,3 +206,67 @@ describe("Minimally unique labels (missing labels)", () => {
     expect(fs.minimallyUniqueLabel(f2)).toEqual("eg:Concept4");
   });
 });
+
+function numericTestFact(value, decimals) {
+    var factData = { "d": decimals, "v": value, "a": { "c": "eg:Concept1", "u": "eg:pure" }};
+    return factData;
+}
+
+describe("Consistency", () => {
+    const reportSet = testReportSet({ 
+        "f1": numericTestFact(150, -1), // 145-155
+        "f2": numericTestFact(200, -2), // 150-250
+        "f3": numericTestFact(140, -1), // 135-145
+    });
+
+    const f1 = getFact(reportSet, "f1");
+    const f2 = getFact(reportSet, "f2");
+    const f3 = getFact(reportSet, "f3");
+
+    test("Inconsistent fact set", () => {
+      const factSet = new FactSet([f1, f2, f3]);
+      expect(factSet.valueIntersection()).toBeUndefined();
+      expect(factSet.isConsistent()).toBeFalsy();
+    });
+
+    test("Consistent fact sets - overlap", () => {
+      const factSet = new FactSet([f1, f2]);
+      const intersection = factSet.valueIntersection();
+      expect(intersection.a).toEqualDecimal(150);
+      expect(intersection.b).toEqualDecimal(155);
+      expect(factSet.isConsistent()).toBeTruthy();
+    });
+
+    test("Consistent fact sets - bounds coincide", () => {
+      const factSet = new FactSet([f1, f3]);
+      const intersection = factSet.valueIntersection();
+      expect(intersection.a).toEqualDecimal(145);
+      expect(intersection.b).toEqualDecimal(145);
+      expect(factSet.isConsistent()).toBeTruthy();
+    });
+  
+});
+
+describe("Most precise", () => {
+    const reportSet = testReportSet({ 
+        "f1": numericTestFact(150, -1), 
+        "f2": numericTestFact(200, 0), 
+        "f3": numericTestFact(140, 2),
+        "f4": numericTestFact(160, undefined)
+    });
+
+    const f1 = getFact(reportSet, "f1");
+    const f2 = getFact(reportSet, "f2");
+    const f3 = getFact(reportSet, "f3");
+    const f4 = getFact(reportSet, "f4");
+
+    test("Most precise - finite decimals", () => {
+        const factSet = new FactSet([f1, f2, f3]);
+        expect(factSet.mostPrecise()).toEqual(f3);
+    });
+
+    test("Most precise - mixture of finite and infinite", () => {
+        const factSet = new FactSet([f1, f2, f3, f4]);
+        expect(factSet.mostPrecise()).toEqual(f4);
+    });
+});

iXBRLViewerPlugin/viewer/src/js/footnote.js

@@ -2,10 +2,10 @@
 
 export class Footnote {
     constructor(report, footnoteId, title) {
-        this.id = footnoteId;
+        this.vuid = footnoteId;
         this.linkedFacts = [];
         this.title = title;
-        this.ixNode = report.getIXNodeForItemId(footnoteId);
+        this.ixNode = report.reportSet.getIXNodeForItemId(footnoteId);
     }
 
     // Facts that are the source of relationships to this fact.
@@ -21,6 +21,12 @@ export class Footnote {
         return this.textContent();
     }
 
+    readableValueHTML() {
+        const span = document.createElement("span");
+        span.append(document.createTextNode(this.textContent()));
+        return span;
+    }
+
     isTextBlock() {
         return false;
     }

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();
 });