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

iXBRLViewerPlugin/viewer/src/js/summary.test.js

@@ -6,7 +6,8 @@ import { DocumentSummary } from "./summary.js";
 function testConcept(typedDomainElement) {
     return {
         isTypedDimension: () => typedDomainElement !== undefined,
-        typedDomainElement: () => typedDomainElement
+        typedDomainElement: () => typedDomainElement,
+        hasDefinition: true,
     }
 }
 
@@ -17,16 +18,17 @@ function testFact(conceptName, dimensions) {
     }
 }
 
-function testReportSet(concepts, facts, documents) {
+function testReportSet(concepts, facts, documents, softwareCredits) {
     const report = {
         getConcept: conceptName => concepts[conceptName],
-        localDocuments: () => documents
+        localDocuments: () => documents,
     }
     for (const f of facts) {
         f.report = report;
     }
     return {
         facts: () => facts,
+        getSoftwareCredits: () => softwareCredits,
         reports: [ report ]
     }
 }
@@ -34,7 +36,7 @@ function testReportSet(concepts, facts, documents) {
 describe("Facts summary", () => {
 
     test("no facts", () => {
-        const reportSet = testReportSet({}, [], {});
+        const reportSet = testReportSet({}, [], {}, []);
         const summary = new DocumentSummary(reportSet);
 
         expect(summary.totalFacts()).toBe(0);
@@ -43,9 +45,9 @@ describe("Facts summary", () => {
     test("multiple facts", () => {
         const facts = [];
         for (let i = 0; i < 10; i++) {
-            facts.push(testFact("eg:Concept1", {}));
+            facts.push(testFact("eg:Concept1", {}, []));
         }
-        const reportSet = testReportSet({}, facts, {});
+        const reportSet = testReportSet({}, facts, {}, []);
         const summary = new DocumentSummary(reportSet);
 
         expect(summary.totalFacts()).toBe(10);
@@ -55,7 +57,7 @@ describe("Facts summary", () => {
         const conceptName = "eg:Concept1";
         const fact1 = testFact(conceptName, {});
         const fact2 = testFact(conceptName, {});
-        const reportSet = testReportSet({}, [fact1, fact2], {});
+        const reportSet = testReportSet({}, [fact1, fact2], {}, []);
         const summary = new DocumentSummary(reportSet);
 
         expect(summary.totalFacts()).toBe(2);
@@ -66,7 +68,7 @@ describe("Facts summary", () => {
 describe("Tags summary", () => {
 
     test("no tags", () => {
-        const reportSet = testReportSet({}, [], {})
+        const reportSet = testReportSet({}, [], {}, [])
         const summary = new DocumentSummary(reportSet);
 
         expect(summary.tagCounts()).toEqual(new Map());
@@ -76,7 +78,7 @@ describe("Tags summary", () => {
         const fact1 = testFact("eg:Concept1", {});
         const fact2 = testFact("eg:Concept2", {});
         const fact3 = testFact("xz:Concept1", {});
-        const reportSet = testReportSet({}, [fact1, fact2, fact3], {})
+        const reportSet = testReportSet({}, [fact1, fact2, fact3], {}, [])
         const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
@@ -105,7 +107,7 @@ describe("Tags summary", () => {
         const concepts = {
             [dimension]: testConcept(),
         }
-        const reportSet = testReportSet(concepts, [fact], {})
+        const reportSet = testReportSet(concepts, [fact], {}, [])
         const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
@@ -135,7 +137,7 @@ describe("Tags summary", () => {
             [dimension2]: testConcept(),
             [dimension3]: testConcept(),
         }
-        const reportSet = testReportSet(concepts, [fact], {})
+        const reportSet = testReportSet(concepts, [fact], {}, [])
         const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
@@ -176,7 +178,7 @@ describe("Tags summary", () => {
         const concepts = {
             [dimension]: testConcept(typedDomain),
         }
-        const reportSet = testReportSet(concepts, [fact], {})
+        const reportSet = testReportSet(concepts, [fact], {}, [])
         const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
@@ -200,7 +202,7 @@ describe("Files summary", () => {
 
     test("no files", () => {
         const documentData = {}
-        const reportSet = testReportSet({}, [], documentData);
+        const reportSet = testReportSet({}, [], documentData, []);
         const summary = new DocumentSummary(reportSet);
 
         expect(summary.getLocalDocuments()).toEqual({
@@ -228,7 +230,7 @@ describe("Files summary", () => {
             'labelLinkbase.xml': ['labelLinkbase'],
             'unrecognizedLinkbase.xml': ['unrecognizedLinkbase'],
         }
-        const reportSet = testReportSet({}, [], documentData);
+        const reportSet = testReportSet({}, [], documentData, []);
         const summary = new DocumentSummary(reportSet);
 
         expect(summary.getLocalDocuments()).toEqual({
@@ -243,3 +245,39 @@ describe("Files summary", () => {
         });
     });
 });
+
+describe("Software credit", () => {
+
+    test("no credits", () => {
+        const softwareCredits = []
+        const documentData = {}
+        const reportSet = testReportSet({}, [], documentData, softwareCredits);
+        const summary = new DocumentSummary(reportSet);
+
+        expect(summary.getSoftwareCredits()).toEqual([]);
+    });
+
+    test("one credit", () => {
+        const softwareCredits = ["Example credit text"]
+        const documentData = {}
+        const reportSet = testReportSet({}, [], documentData, softwareCredits);
+        const summary = new DocumentSummary(reportSet);
+
+        expect(summary.getSoftwareCredits()).toEqual(["Example credit text"]);
+    });
+
+    test("multiple credits", () => {
+        const softwareCredits = [
+            "Example credit text A",
+            "Example credit text B",
+        ]
+        const documentData = {}
+        const reportSet = testReportSet({}, [], documentData, softwareCredits);
+        const summary = new DocumentSummary(reportSet);
+
+        expect(summary.getSoftwareCredits()).toEqual([
+            "Example credit text A",
+            "Example credit text B",
+        ]);
+    });
+});

iXBRLViewerPlugin/viewer/src/js/tableExport.js

@@ -1,7 +1,6 @@
 // See COPYRIGHT.md for copyright information
 
 import $ from 'jquery'
-import FileSaver from 'file-saver'
 import writeXlsxFile from 'write-excel-file'
 import { Fact } from './fact.js';
 
@@ -15,12 +14,13 @@ export class TableExport {
     static addHandles(iframe, reportSet) {
         $('table', iframe).each(function () {
             const table = $(this);
-            if (table.find(".ixbrl-element").length > 0) {
+            // Require at least two facts on different rows.
+            if (table.find("tr").filter((i, row) => $(row).find(".ixbrl-element").length > 0).length > 1) {
                 table.css("position", "relative");
                 const exporter = new TableExport(table, reportSet);
                 $('<div class="ixbrl-table-handle"><span>Export table</span></div>')
                     .appendTo(table)
-                    .click(() => exporter.exportTable());
+                    .on("click", () => exporter.exportTable());
             }
         });
     }

iXBRLViewerPlugin/viewer/src/js/taxonomynamer.js

@@ -0,0 +1,34 @@
+// See COPYRIGHT.md for copyright information
+
+export class TaxonomyNamer {
+    constructor(map) {
+        this.map = new Map(Array.from(map.entries()).map(([k,v]) => [new RegExp(k), new TaxonomyName(v[0], v[1])]));
+    }
+
+
+    getName(prefix, uri) {
+        for (const [re, name] of this.map.entries()) {
+            const m = uri.match(re);
+            if (m !== null)  {
+                return name;
+            }
+        }
+        return new TaxonomyName(prefix, prefix);
+    }
+
+    fromQName(qname) {
+        return this.getName(qname.prefix, qname.namespace);
+    }
+
+    convertQName(qname) {
+        const name = this.fromQName(qname)
+        return name.prefix + ':' + qname.localname;
+    }
+}
+
+export class TaxonomyName {
+    constructor(prefix, name) {
+        this.prefix = prefix;
+        this.name = name;
+    }
+}

iXBRLViewerPlugin/viewer/src/js/taxonomynamer.test.js

@@ -0,0 +1,32 @@
+// See COPYRIGHT.md for copyright information
+
+import { TaxonomyNamer } from './taxonomynamer.js';
+import { QName } from './qname.js';
+
+const prefixMap = {
+    "e": "http://example.com/",
+    "g": "http://eggsample.com/",
+};
+
+const preferredPrefixMap = new Map([
+    [ "http://ex.*\.com/", ["prefix1", "My Example"] ]
+]);
+
+function qname(s) {
+    return new QName(prefixMap, s);
+}
+
+describe("readableName", () => {
+    const namer = new TaxonomyNamer(preferredPrefixMap);
+    test("Taxonomy name match", () => {
+        expect(namer.fromQName(qname("e:1234")).prefix).toBe("prefix1");
+        expect(namer.fromQName(qname("e:1234")).name).toBe("My Example");
+        expect(namer.convertQName(qname("e:1234"))).toBe("prefix1:1234");
+    });
+    test("Unknown taxonomy", () => {
+        expect(namer.fromQName(qname("g:1234")).prefix).toBe("g");
+        expect(namer.fromQName(qname("g:1234")).name).toBe("g");
+        expect(namer.convertQName(qname("g:1234"))).toBe("g:1234");
+    });
+});
+

iXBRLViewerPlugin/viewer/src/js/theme.js

@@ -0,0 +1,49 @@
+// See COPYRIGHT.md for copyright information
+
+import { STORAGE_THEME } from "./util";
+
+const DARK_THEME = 'dark';
+const LIGHT_THEME = 'light';
+
+function getHtmlElement() {
+    return document.querySelector('html');
+}
+
+export function getVariable(name) {
+    const html = getHtmlElement();
+    return getComputedStyle(html).getPropertyValue(name);
+}
+
+function setTheme(theme) {
+    const html = getHtmlElement();
+    html.dataset.theme = `theme-${theme}`;
+}
+
+function getStoredTheme() {
+    return localStorage.getItem(STORAGE_THEME);
+}
+
+function storeTheme(theme) {
+    localStorage.setItem(STORAGE_THEME, theme);
+}
+
+export function getTheme() {
+    const html = getHtmlElement();
+    return html.dataset.theme.replace('theme-','');
+}
+
+export function initializeTheme() {
+    const storedTheme = getStoredTheme();
+    if (storedTheme !== null) {
+        setTheme(storedTheme);
+    } else {
+        setTheme(window.matchMedia(`(prefers-color-scheme: ${DARK_THEME})`).matches ? DARK_THEME : LIGHT_THEME);
+    }
+}
+
+export function toggleTheme() {
+    const currentTheme = getTheme();
+    const newTheme = currentTheme === LIGHT_THEME ? DARK_THEME : LIGHT_THEME;
+    setTheme(newTheme);
+    storeTheme(newTheme);
+}

iXBRLViewerPlugin/viewer/src/js/unit.js

@@ -1,9 +1,42 @@
 // See COPYRIGHT.md for copyright information
 
-import { measureLabel, NAMESPACE_ISO4217 } from "./util";
+import { NAMESPACE_ISO4217 } from "./util";
+import i18next from "i18next";
+import { utr } from "./utr";
+
+/**
+ * Transforms measure qname into title case label (or currency symbol, if applicable).
+ * @return {String} Measure Label
+ */
+
+function measureLabel(report, measure) {
+    const qname = report.qname(measure);
+    if (qname.namespace === NAMESPACE_ISO4217) {
+        // Prefer a name from our own i18n resources
+        const keyi18n = `currencies:unitFormat${qname.localname}`;
+        if (i18next.exists(keyi18n)) {
+            return i18next.t(keyi18n);
+        }
+        // Fall back on symbol from UTR ...
+        const utrEntry = utr.get(qname);
+        if (utrEntry !== undefined) {
+            // ... but disambiguate "$" symbol
+            return utrEntry.symbol == '$' ? `${qname.localname} $` : utrEntry.symbol;
+        }
+    }
+    if (measure.includes(':')) {
+        return measure.split(':')[1];
+    }
+    return measure;
+}
+
+export function measureName(report, measure) {
+    const qname = report.qname(measure);
+    const utrEntry = utr.get(qname);
+    return utrEntry?.name;
+}
 
 export class Unit {
-    
     constructor(reportSet, unitKey) {
         this._reportSet = reportSet;
         this._value = unitKey;
@@ -50,5 +83,43 @@ export class Unit {
     value() {
         return this._value;
     }
+
+    measureHTML(m) {
+        const span = document.createElement("span");
+        const name = measureName(this._reportSet, m);
+        if (name !== undefined) {
+            span.setAttribute("title", name);
+            span.classList.add("measure");
+        }
+        span.append(document.createTextNode(measureLabel(this._reportSet, m)));
+        return span;
+    }
+
+    partsHTML(parts) {
+        const span = document.createElement("span");
+        if (parts.length > 1) {
+            span.appendChild(document.createTextNode("("));
+        }
+        for (const [i, m] of parts.entries()) {
+            span.appendChild(this.measureHTML(m));
+            if (i < parts.length - 1) {
+                span.appendChild(document.createTextNode(" * "))
+            }
+        }
+        if (parts.length > 1) {
+            span.appendChild(document.createTextNode(")"));
+        }
+        return span;
+    }
+
+    html() {
+        const span = document.createElement("span");
+        span.append(this.partsHTML(this._numerators));
+        if (this._denominators.length > 0) {
+            span.append(document.createTextNode(" / "));
+            span.append(this.partsHTML(this._denominators));
+        }
+        return span;
+    }
 }
 

iXBRLViewerPlugin/viewer/src/js/unit.test.js

@@ -11,7 +11,7 @@ var testReportData = {
         "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
-    "facts": {}
+    "facts": {},
 };
 
 function testReport() {
@@ -57,12 +57,23 @@ describe("Unit label", () => {
 
     test("Unit label - known currency", () => {
         var unit = new Unit(testReport(), 'iso4217:USD');
+        // Note "US $" from i18n takes precedence over "USD $" generated from UTR
         expect(unit.label()).toEqual('US $');
     });
 
+    test("Unit label - UTR currency", () => {
+        var unit = new Unit(testReport(), 'iso4217:THB');
+        expect(unit.label()).toEqual('฿');
+    });
+
+    test("Unit label - UTR currency with '$' symbol", () => {
+        var unit = new Unit(testReport(), 'iso4217:SGD');
+        expect(unit.label()).toEqual('SGD $');
+    });
+
     test("Unit label - unknown", () => {
-        var unit = new Unit(testReport(), 'iso4217:ZAR');
-        expect(unit.label()).toEqual('ZAR');
+        var unit = new Unit(testReport(), 'iso4217:ZZZZ');
+        expect(unit.label()).toEqual('ZZZZ');
     });
 });
 

iXBRLViewerPlugin/viewer/src/js/util.js

@@ -2,16 +2,34 @@
 
 import moment from "moment";
 import Decimal from "decimal.js";
-import i18next from "i18next";
-
 
 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 GLOSSARY_URL = "https://xbrl.org/glossary/";
 
 // The number of distinct highlight colors defined in inspector.less
 export const HIGHLIGHT_COLORS = 3;
 
+// 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';
+export const FEATURE_SEARCH_ON_STARTUP = 'search_on_startup';
+export const FEATURE_HIGHLIGHT_FACTS_ON_STARTUP = 'highlight_facts_on_startup';
+
+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";
+
 /* 
  * 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
@@ -205,7 +223,7 @@ export function localId(viewerUniqueId) {
 
 export function getIXHiddenLinkStyle(domNode) {
     if (domNode.hasAttribute('style')) {
-        const re = /(?:^|\s|;)-(?:sec|esef)-ix-hidden:\s*([^\s;]+)/;
+        const re = /(?:^|\s|;)(?:-sec|-esef)?-ix-hidden:\s*([^\s;]+)/;
         const m = domNode.getAttribute('style').match(re);
         if (m) {
             return m[1];
@@ -213,18 +231,3 @@ export function getIXHiddenLinkStyle(domNode) {
     }
     return null;
 }
-
-/**
- * Transforms measure qname into title case label (or currency symbol, if applicable).
- * @return {String} Measure Label
- */
-
-export function measureLabel(report, measure) {
-    const qname = report.qname(measure);
-    if (qname.namespace === NAMESPACE_ISO4217) {
-        measure = i18next.t(`currencies:unitFormat${qname.localname}`, {defaultValue: qname.localname});
-    } else if (measure.includes(':')) {
-        measure = measure.split(':')[1];
-    }
-    return measure;
-}

iXBRLViewerPlugin/viewer/src/js/util.test.js

@@ -147,6 +147,7 @@ describe("Regex escape", () => {
 
 describe("Get IX Hidden Link Style", () => {
     it.each([
+        ["-ix-hidden:123", "123"],
         ["-sec-ix-hidden:123", "123"],
         ["-esef-ix-hidden:123", "123"],
         ["-xxx-ix-hidden:123", null],

iXBRLViewerPlugin/viewer/src/js/utr.js

@@ -0,0 +1,27 @@
+// See COPYRIGHT.md for copyright information
+
+// Class to expose properties of Unit Type Registry entries from viewer data
+
+export class UTREntry {
+    
+    constructor(symbol, name) {
+        this.symbol = symbol;
+        this.name = name;
+    }
+}
+
+class UTR {
+    constructor() {
+        self.entries = require("../data/utr.json");
+    }
+
+    get(qname) {
+        const u = self.entries[qname.namespace]?.[qname.localname]
+        if (u === undefined) {
+            return undefined;
+        }
+        return new UTREntry(u.s ?? u.n, u.n)
+    }
+}
+
+export const utr = new UTR();