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

iXBRLViewerPlugin/viewer/src/js/reportset.test.js

@@ -0,0 +1,357 @@
+// See COPYRIGHT.md for copyright information
+
+import { ReportSet } from "./reportset.js";
+import { ViewerOptions } from "./viewerOptions.js";
+import { NAMESPACE_ISO4217, viewerUniqueId } from "./util.js";
+import { createNumericFact } from "./test-utils.js";
+
+function anchoringRelationShips(include) {
+    if (include) {
+        return {
+          "w-n": {
+            "role1": {
+              "eg:Concept1": [{"t": "eg:Concept2"}],
+            }
+          }
+        }
+    }
+    return {}
+}
+
+function multiReportTestData(withAnchoring) {
+    return {
+        "features": [],
+        "languages": {
+            "en-us": "English (US)",
+            "en": "English",
+            "fr": "French",
+        },
+        "prefixes": {
+            "eg": "http://www.example.com",
+            "iso4217": NAMESPACE_ISO4217
+        },
+        "roles": {
+            "role1": "https://www.example.com/role1",
+            "role2": "https://www.example.com/role2",
+            "role3": "https://www.example.com/role3",
+            "role4": "https://www.example.com/role4"
+        },
+        "sourceReports": [
+            { 
+                "targetReports": [
+                    {
+                        "roleDefs": {
+                            "role1": { "en": "Role 1 Label" },
+                            "role2": { "en": null },
+                            "role3": {}
+                        },
+                        "concepts": {
+                            "eg:Concept1": {
+                                "labels": {
+                                    "std": {
+                                        "en": "English label"
+                                    }
+                                }
+                            },
+                            "eg:Concept2": {
+                                "labels": {
+                                    "std": {
+                                        "en": "English label for concept two",
+                                        "en-us": "English (US) label for concept two",
+                                    }
+                                }
+                            },
+                            "eg:Concept3": {
+                                "labels": {
+                                    "std": {
+                                        "en": "Concept three"
+                                    }
+                                }
+                            }
+                        },
+
+                        "facts": {
+                            ...createNumericFact("f1", "eg:Concept1", "iso2417:USD", "2018-01-01/2019-01-01", 1000, -3),
+                            ...createNumericFact("f2", "eg:Concept2", "iso2417:USD", "2018-01-01/2019-01-01", 1000, -3),
+                        },
+
+
+                        "softwareCredits": ["Example credit text C", "Example credit text B"],
+                    },
+                ]
+            },
+            {
+                "targetReports": [
+                    {
+                        "roleDefs": {
+                        },
+                        "concepts": {
+                            "eg:Concept1": {
+                                "labels": {
+                                    "std": {
+                                        "en": "English label"
+                                    }
+                                }
+                            },
+                            "eg:Concept2": {
+                                "labels": {
+                                    "std": {
+                                        "en": "Report 2 English label for concept two",
+                                    }
+                                }
+                            },
+                            "eg:Concept3": {
+                                "labels": {
+                                    "std": {
+                                        "en-gb": "Concept three"
+                                    }
+                                }
+                            }
+                        },
+
+                        "facts": {
+                            ...createNumericFact("f1", "eg:Concept1", "iso2417:USD", "2018-01-01/2019-01-01", 2000, -3),
+                        },
+
+                        "rels": {
+                          ...anchoringRelationShips(withAnchoring)
+                        },
+
+                        "softwareCredits": ["Example credit text A"],
+                    }
+                ]
+            }
+        ]
+    };
+}
+
+// Legacy report data format - no "sourceReports" array
+function singleReportTestData() {
+    return {
+        "features": [],
+        "languages": {
+            "en-us": "English (US)",
+            "en": "English",
+            "fr": "French",
+        },
+        "prefixes": {
+            "eg": "http://www.example.com",
+            "iso4217": NAMESPACE_ISO4217
+        },
+        "roles": {
+            "role1": "https://www.example.com/role1",
+            "role2": "https://www.example.com/role2",
+            "role3": "https://www.example.com/role3",
+            "role4": "https://www.example.com/role4"
+        },
+        "roleDefs": {
+            "role1": { "en": "Role 1 Label" },
+            "role2": { "en": null },
+            "role3": {}
+        },
+        "concepts": {
+            "eg:Concept1": {
+                "labels": {
+                    "std": {
+                        "en": "English label"
+                    }
+                }
+            },
+            "eg:Concept2": {
+                "labels": {
+                    "std": {
+                        "en": "English label for concept two",
+                        "en-us": "English (US) label for concept two",
+                    }
+                }
+            },
+        },
+
+        "facts": {
+            ...createNumericFact("f1", "eg:Concept1", "iso2417:USD", "2018-01-01/2019-01-01", 1000, -3),
+            ...createNumericFact("f2", "eg:Concept2", "iso2417:USD", "2018-01-01/2019-01-01", 1000, -3),
+        },
+
+        "softwareCredits": ["Example credit text"],
+    };
+}
+
+describe("Multi report - basic", () => {
+    const testReportSet = new ReportSet(multiReportTestData());
+    testReportSet._initialize();
+    test("Report count", () => {
+        expect(testReportSet.reports).toHaveLength(2);
+    });
+});
+
+describe("Multi report - Language options", () => {
+    const testReportSet = new ReportSet(multiReportTestData());
+    testReportSet._initialize();
+    test("Available languages", () => {
+        const al = testReportSet.availableLanguages();
+        expect(al).toHaveLength(3);
+        expect(al).toEqual(expect.arrayContaining(["en", "en-us", "en-gb"]));
+    });
+});
+
+describe("Multi report - Fetching facts", () => {
+    const testReportSet = new ReportSet(multiReportTestData());
+    testReportSet._initialize();
+
+    test("Successful f1 (report 1)", () => {
+        const f = testReportSet.getItemById(viewerUniqueId(0, "f1"));
+        expect(f).not.toBeNull();
+        expect(f.decimals()).toEqual(-3);
+    });
+    test("Successful f2 (report 1)", () => {
+        const f = testReportSet.getItemById(viewerUniqueId(0, "f2"));
+        expect(f).not.toBeNull();
+        expect(f.decimals()).toEqual(-3);
+    });
+    test("Successful f1 (report 2)", () => {
+        const f = testReportSet.getItemById(viewerUniqueId(1, "f1"));
+        expect(f).not.toBeNull();
+        expect(f.decimals()).toEqual(-3);
+    });
+
+    test("Non-existent fact", () => {
+        const f = testReportSet.getItemById(viewerUniqueId(1, "f2"));
+        expect(f).toBeUndefined();
+    });
+});
+
+describe("Multi report - Concept labels", () => {
+    const testReportSet = new ReportSet(multiReportTestData());
+    testReportSet._initialize();
+    const testReport = testReportSet.reports[0];
+    const vo = new ViewerOptions();
+    testReportSet.viewerOptions = vo;
+    test("Label fallback", () => {
+        vo.language = 'en-us';
+        expect(testReportSet.reports[0].getLabel('eg:Concept2', 'std')).toBe("English (US) label for concept two");
+        // No en-US label in report 2, so fall back on en label
+        expect(testReportSet.reports[1].getLabel('eg:Concept2', 'std')).toBe("Report 2 English label for concept two");
+    });
+});
+
+describe("Multi report - ELR labels", () => {
+    const testReportSet = new ReportSet(multiReportTestData());
+    testReportSet._initialize();
+
+    test("Present", () => {
+        // Role 1 only has a label in report 1
+        expect(testReportSet.reports[0].getRoleLabelOrURI("role1")).toBe("Role 1 Label");
+        expect(testReportSet.reports[1].getRoleLabelOrURI("role1")).toBe("https://www.example.com/role1");
+    });
+});
+
+describe("Multi report - anchoring", () => {
+    test("Without anchoring", () => {
+        const testReportSet = new ReportSet(multiReportTestData(false));
+        testReportSet._initialize();
+        expect(testReportSet.usesAnchoring()).toBe(false);
+    });
+    test("With anchoring", () => {
+        const testReportSet = new ReportSet(multiReportTestData(true));
+        testReportSet._initialize();
+        expect(testReportSet.usesAnchoring()).toBe(true);
+    });
+});
+
+describe("Multi report - doc set files", () => {
+    test("Not overlapping", () => {
+        const data = multiReportTestData(false);
+        data.sourceReports[0].docSetFiles = ["a.html", "b.html"];
+        data.sourceReports[1].docSetFiles = ["c.html", "d.html"];
+        const testReportSet = new ReportSet(data);
+        testReportSet._initialize();
+        expect(testReportSet.reportFiles()).toStrictEqual([{"index": 0, "file": "a.html"}, {"index": 0, "file": "b.html"}, {"index": 1, "file": "c.html"}, {"index": 1, "file": "d.html"}]);
+    });
+    test("Repeated document set", () => {
+        const data = multiReportTestData(false);
+        data.sourceReports[0].docSetFiles = ["a.html", "b.html"];
+        data.sourceReports[1].docSetFiles = ["a.html", "b.html"];
+        const testReportSet = new ReportSet(data);
+        testReportSet._initialize();
+        expect(testReportSet.reportFiles()).toStrictEqual([{"index": 0, "file": "a.html"}, {"index": 0, "file": "b.html"}, {"index": 1, "file": "a.html"}, {"index": 1, "file": "b.html"}]);
+    });
+});
+
+describe("Single report - basic", () => {
+    const testReportSet = new ReportSet(singleReportTestData());
+    testReportSet._initialize();
+    test("Report count", () => {
+        expect(testReportSet.reports).toHaveLength(1);
+    });
+});
+
+describe("Single report - Language options", () => {
+    const testReportSet = new ReportSet(singleReportTestData());
+    testReportSet._initialize();
+    test("Available languages", () => {
+        const al = testReportSet.availableLanguages();
+        expect(al).toHaveLength(2);
+        expect(al).toEqual(expect.arrayContaining(["en", "en-us"]));
+    });
+});
+
+describe("Single report - Fetching facts", () => {
+    const testReportSet = new ReportSet(singleReportTestData());
+    testReportSet._initialize();
+
+    test("Successful f1", () => {
+        const f = testReportSet.getItemById(viewerUniqueId(0, "f1"));
+        expect(f).not.toBeNull();
+        expect(f.decimals()).toEqual(-3);
+    });
+    test("Successful f2", () => {
+        const f = testReportSet.getItemById(viewerUniqueId(0, "f2"));
+        expect(f).not.toBeNull();
+        expect(f.decimals()).toEqual(-3);
+    });
+    // There is no second report
+    test("Successful f1 (report 2)", () => {
+        const f = testReportSet.getItemById(viewerUniqueId(1, "f1"));
+        expect(f).toBeUndefined();
+    });
+});
+
+describe("Single report - Concept labels", () => {
+    const testReportSet = new ReportSet(singleReportTestData());
+    testReportSet._initialize();
+    const testReport = testReportSet.reports[0];
+    const vo = new ViewerOptions();
+    testReportSet.viewerOptions = vo;
+    test("Label fallback", () => {
+        vo.language = 'en-us';
+        expect(testReportSet.reports[0].getLabel('eg:Concept2', 'std')).toBe("English (US) label for concept two");
+    });
+});
+
+describe("ELR labels", () => {
+    const testReportSet = new ReportSet(singleReportTestData());
+    testReportSet._initialize();
+
+    test("Present", () => {
+        expect(testReportSet.reports[0].getRoleLabelOrURI("role1")).toBe("Role 1 Label");
+    });
+});
+
+describe("Fetching software credit", () => {
+
+    test("Single", () => {
+        const testReportSet = new ReportSet(singleReportTestData());
+        testReportSet._initialize();
+
+        const softwareCredits = testReportSet.getSoftwareCredits();
+        expect(softwareCredits).toEqual(["Example credit text"]);
+    });
+
+    test("Multiple", () => {
+        const testReportSet = new ReportSet(multiReportTestData(true));
+        testReportSet._initialize();
+
+        const softwareCredits = testReportSet.getSoftwareCredits();
+        expect(softwareCredits).toEqual(["Example credit text A", "Example credit text B", "Example credit text C"]);
+    });
+});

iXBRLViewerPlugin/viewer/src/js/search.js

@@ -1,56 +1,61 @@
 // See COPYRIGHT.md for copyright information
 
 import lunr from 'lunr'
-import $ from 'jquery'
-import Decimal from "decimal.js";
 
 export class ReportSearch {
-    constructor(report) {
-        this._report = report;
+    constructor(reportSet) {
+        this._reportSet = reportSet;
         this.ready = false;
     }
 
     * buildSearchIndex(doneCallback) {
         var docs = [];
         var dims = {};
-        var facts = this._report.facts();
+        var facts = this._reportSet.facts();
         this.periods = {};
-        for (var i = 0; i < facts.length; i++) {
-            var f = facts[i];
-            var doc = { "id": f.id };
-            var l = f.getLabel("std");
-            doc.concept = f.conceptQName().localname;
-            doc.doc = f.getLabel("doc");
-            doc.date = f.periodTo();
-            doc.startDate = f.periodFrom();
-            var dims = f.dimensions();
-            for (var d in dims) {
-                if (this._report.getConcept(d).isTypedDimension()) {
-                    if (dims[d] !== null) {
-                        l += " " + dims[d];
+        // Add hidden facts to index later, so that they appear later in the
+        // default search
+        for (const hidden of [false, true]) {
+            for (var i = 0; i < facts.length; i++) {
+                var f = facts[i];
+                if (f.isHidden() !== hidden) {
+                    continue;
+                }
+                var doc = { "id": f.vuid };
+                var l = f.getLabel("std");
+                doc.concept = f.conceptQName().localname;
+                doc.doc = f.getLabel("doc");
+                doc.date = f.periodTo();
+                doc.startDate = f.periodFrom();
+                var dims = f.dimensions();
+                for (var d in dims) {
+                    if (f.report.getConcept(d).isTypedDimension()) {
+                        if (dims[d] !== null) {
+                            l += " " + dims[d];
+                        }
+                    }
+                    else {
+                        l += " " + f.report.getLabel(dims[d], "std");
                     }
                 }
-                else {
-                    l += " " + this._report.getLabel(dims[d], "std");
+                doc.label = l;
+                doc.ref = f.concept().referenceValuesAsString();
+                const wider = f.widerConcepts();
+                if (wider.length > 0) {
+                    doc.widerConcept = f.report.qname(wider[0]).localname;
+                    doc.widerLabel = f.report.getLabel(wider[0], "std");
+                    doc.widerDoc = f.report.getLabel(wider[0], "doc");
                 }
-            }
-            doc.label = l;
-            doc.ref = f.concept().referenceValuesAsString();
-            const wider = f.widerConcepts();
-            if (wider.length > 0) {
-                doc.widerConcept = this._report.qname(wider[0]).localname;
-                doc.widerLabel = this._report.getLabel(wider[0], "std");
-                doc.widerDoc = this._report.getLabel(wider[0], "doc");
-            }
-            docs.push(doc);
+                docs.push(doc);
 
-            var p = f.period();
-            if (p) {
-                this.periods[p.key()] = p.toString();
-            }
+                var p = f.period();
+                if (p) {
+                    this.periods[p.key()] = p.toString();
+                }
 
-            if (i % 100 === 0) {
-                yield;
+                if (i % 100 === 0) {
+                    yield;
+                }
             }
         }
         const builder = new lunr.Builder();
@@ -88,7 +93,11 @@ export class ReportSearch {
     }
 
     visibilityFilter(s, item) {
-        return item.isHidden() ? s.showHiddenFacts : s.showVisibleFacts;
+        return (
+                s.visibilityFilter === '*' ||
+                s.visibilityFilter === 'visible' && !item.isHidden() ||
+                s.visibilityFilter === 'hidden' && item.isHidden()
+        )
     }
 
     periodFilter(s, item) {
@@ -140,6 +149,14 @@ export class ReportSearch {
         );
     }
 
+    dataTypesFilter(s, item) {
+        return (
+            s.dataTypesFilter == null ||
+            s.dataTypesFilter.length === 0 ||
+            s.dataTypesFilter.some(p => item.concept().dataType()?.name === p)
+        );
+    }
+
     unitsFilter(s, item) {
         return (
                 s.unitsFilter.length === 0 ||
@@ -154,6 +171,20 @@ export class ReportSearch {
         );
     }
 
+    targetDocumentFilter(s, item) {
+        return (
+            s.targetDocumentFilter.length === 0 ||
+            s.targetDocumentFilter.some(t => (item.targetDocument() ?? ':default') === t)
+        );
+    }
+
+    mandatoryFactFilter(s, item) {
+        if(!s.showMandatoryFacts) {
+            return true;
+        }
+        return item.isMandatory();
+    }
+
     search(s) {
         if (!this.ready) {
             return;
@@ -170,12 +201,15 @@ export class ReportSearch {
             this.factValueFilter,
             this.calculationsFilter,
             this.namespacesFilter,
+            this.dataTypesFilter,
             this.unitsFilter,
             this.scalesFilter,
+            this.targetDocumentFilter,
+            this.mandatoryFactFilter
         ];
 
         rr.forEach((r,_) => {
-                const item = searchIndex._report.getItemById(r.ref);
+                const item = searchIndex._reportSet.getItemById(r.ref);
                 if (filters.every(f => f(s, item))) {
                     results.push({
                         "fact": item,