ixbrl-viewer 1.4.1__py3-none-any.whl → 1.4.86__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,19 +18,26 @@ function testFact(conceptName, dimensions) {
     }
 }
 
-function testReport(concepts, facts, documents) {
-    return {
+function testReportSet(concepts, facts, documents, softwareCredits) {
+    const report = {
         getConcept: conceptName => concepts[conceptName],
+        localDocuments: () => documents,
+    }
+    for (const f of facts) {
+        f.report = report;
+    }
+    return {
         facts: () => facts,
-        localDocuments: () => documents
+        getSoftwareCredits: () => softwareCredits,
+        reports: [ report ]
     }
 }
 
 describe("Facts summary", () => {
 
     test("no facts", () => {
-        const report = testReport({}, [], {});
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet({}, [], {}, []);
+        const summary = new DocumentSummary(reportSet);
 
         expect(summary.totalFacts()).toBe(0);
     });
@@ -37,10 +45,10 @@ 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 report = testReport({}, facts, {});
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet({}, facts, {}, []);
+        const summary = new DocumentSummary(reportSet);
 
         expect(summary.totalFacts()).toBe(10);
     });
@@ -49,8 +57,8 @@ describe("Facts summary", () => {
         const conceptName = "eg:Concept1";
         const fact1 = testFact(conceptName, {});
         const fact2 = testFact(conceptName, {});
-        const report = testReport({}, [fact1, fact2], {});
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet({}, [fact1, fact2], {}, []);
+        const summary = new DocumentSummary(reportSet);
 
         expect(summary.totalFacts()).toBe(2);
     });
@@ -60,8 +68,8 @@ describe("Facts summary", () => {
 describe("Tags summary", () => {
 
     test("no tags", () => {
-        const report = testReport({}, [], {})
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet({}, [], {}, [])
+        const summary = new DocumentSummary(reportSet);
 
         expect(summary.tagCounts()).toEqual(new Map());
     });
@@ -70,8 +78,8 @@ describe("Tags summary", () => {
         const fact1 = testFact("eg:Concept1", {});
         const fact2 = testFact("eg:Concept2", {});
         const fact3 = testFact("xz:Concept1", {});
-        const report = testReport({}, [fact1, fact2, fact3], {})
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet({}, [fact1, fact2, fact3], {}, [])
+        const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
             'eg': {
@@ -99,8 +107,8 @@ describe("Tags summary", () => {
         const concepts = {
             [dimension]: testConcept(),
         }
-        const report = testReport(concepts, [fact], {})
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet(concepts, [fact], {}, [])
+        const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
             'eg': {
@@ -129,8 +137,8 @@ describe("Tags summary", () => {
             [dimension2]: testConcept(),
             [dimension3]: testConcept(),
         }
-        const report = testReport(concepts, [fact], {})
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet(concepts, [fact], {}, [])
+        const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
             'ab': {
@@ -170,8 +178,8 @@ describe("Tags summary", () => {
         const concepts = {
             [dimension]: testConcept(typedDomain),
         }
-        const report = testReport(concepts, [fact], {})
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet(concepts, [fact], {}, [])
+        const summary = new DocumentSummary(reportSet);
 
         expect(Object.fromEntries(summary.tagCounts())).toEqual({
             'eg': {
@@ -194,8 +202,8 @@ describe("Files summary", () => {
 
     test("no files", () => {
         const documentData = {}
-        const report = testReport({}, [], documentData);
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet({}, [], documentData, []);
+        const summary = new DocumentSummary(reportSet);
 
         expect(summary.getLocalDocuments()).toEqual({
             inline: [],
@@ -222,8 +230,8 @@ describe("Files summary", () => {
             'labelLinkbase.xml': ['labelLinkbase'],
             'unrecognizedLinkbase.xml': ['unrecognizedLinkbase'],
         }
-        const report = testReport({}, [], documentData);
-        const summary = new DocumentSummary(report);
+        const reportSet = testReportSet({}, [], documentData, []);
+        const summary = new DocumentSummary(reportSet);
 
         expect(summary.getLocalDocuments()).toEqual({
             inline: ['docset', 'inline.htm'],
@@ -237,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,33 +1,33 @@
 // 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';
 
 
 export class TableExport {
-    constructor(table, report) {
+    constructor(table, reportSet) {
         this._table = table;
-        this._report = report;
+        this._reportSet = reportSet;
     } 
 
-    static addHandles(iframe, report) {
+    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, report);
+                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());
             }
         });
     }
 
     _getRawTable() {
         const table = this._table;
-        const report = this._report;
+        const reportSet = this._reportSet;
         let maxRowLength = 0;
         const rows = [];
         table.find("tr").each(function () {
@@ -44,7 +44,7 @@ export class TableExport {
                 let fact = null;
                 if (facts.length > 0) {
                     const id = facts.first().data('ivids');
-                    fact = report.getItemById(id);
+                    fact = reportSet.getItemById(id);
                 }
                 if (fact instanceof Fact) {
                     const cell = { type: "fact", fact: fact};

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/test-utils.js

@@ -10,3 +10,49 @@ export function TestInspector() {
 }
 
 TestInspector.prototype = Object.create(Inspector.prototype);
+
+expect.extend({
+    toEqualDecimal(received, expected) {
+        const options = {
+              comment: 'decimal.js equality',
+              isNot: this.isNot,
+              promise: this.promise,
+        };
+        const pass = received.equals(expected);
+        const message = () =>
+              this.utils.matcherHint('toEqualDecimals', undefined, undefined, options) +
+              '\n\n' +
+              `Expected: ${this.isNot ? '(not) ' : ''}${this.utils.printExpected(new Decimal(expected))}\n` +
+              `Received: ${this.utils.printReceived(received)}`;
+
+        return {actual: received, message, pass};
+        
+    }
+});
+
+export function createSimpleFact(id, concept, options=null) {
+    options = options || {};
+    return {
+        [id]: {
+            "a": {
+                "c": concept,
+                "u": options["unit"],
+                "p": options["period"],
+            },
+            "d": options["decimals"],
+            "v": options["value"]
+        }
+    };
+}
+
+export function createNumericFact(id, concept, unit, period, value, decimals) {
+    const options = {
+        "unit": unit,
+        "period": period,
+        "value": value
+    };
+    if (decimals !== undefined) { 
+        options.decimals = decimals;
+    }
+    return createSimpleFact(id, concept, options);
+}

iXBRLViewerPlugin/viewer/src/js/theme.js

@@ -0,0 +1,50 @@
+// See COPYRIGHT.md for copyright information
+
+import { IXBRL_VIEWER_DATASET_PREFIX, STORAGE_THEME } from "./util";
+
+const DARK_THEME = 'dark';
+const LIGHT_THEME = 'light';
+const APP_THEME_DATASET_NAME = `${IXBRL_VIEWER_DATASET_PREFIX}Theme`;
+
+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[APP_THEME_DATASET_NAME] = 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[APP_THEME_DATASET_NAME];
+}
+
+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,29 +1,70 @@
 // See COPYRIGHT.md for copyright information
 
+import { NAMESPACE_ISO4217 } from "./util";
 import i18next from "i18next";
-import {titleCase} from "./util";
+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 for currencies
+        const keyi18n = `currencies:unitFormat${qname.localname}`;
+        if (i18next.exists(keyi18n)) {
+            return i18next.t(keyi18n);
+        }
+    }
+    // Pick symbol from UTR ...
+    const utrEntry = utr.get(qname);
+    if (utrEntry !== undefined) {
+        if (utrEntry.symbol !== undefined) {
+            // ... but disambiguate "$" symbol
+            return utrEntry.symbol == '$' ? `${qname.localname} $` : utrEntry.symbol;
+        }
+        // Fall back to name
+        return utrEntry.name;
+    }
+    // Otherwise the measure is not in the UTR so fallback to unitId 
+    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(report, unitKey) {
-        this._report = report;
+    constructor(reportSet, unitKey) {
+        this._reportSet = reportSet;
         this._value = unitKey;
         const split = unitKey
                 .split(/[()]/ig).join('') // TODO: replace with .replaceAll(/[()]/ig,'') when no longer supporting node 14
                 .split('/');
         this._numerators = split[0].split('*');
         this._denominators = split.length > 1 ? split[1].split('*') : [];
-        this._isMonetary = Boolean(this._numerators.find(n => this._report.qname(n).namespace === "http://www.xbrl.org/2003/iso4217"));
-        this._label = split.map(x => {
-                const part = x.split('*').map(y => {
-                    return titleCase(y.split(':')[1]);
-                }).join('*');
+        this._isMonetary =
+                this._denominators.length === 0 &&
+                this._numerators.length === 1 &&
+                this._reportSet.qname(this._numerators[0]).namespace === NAMESPACE_ISO4217;
+        this._label = split
+            .map(measure => {
+                const part = measure
+                    .split('*')
+                    .map(x => measureLabel(this._reportSet, x))
+                    .join('*');
                 return part.includes('*') ? `(${part})` : part;
-            }).join('/');
-        this._measure = this._numerators[0];
+            })
+            .join('/');
     }
 
-
     /**
      * Returns whether any of the numerators are an iso4217 monetary measure.
      * @return {Boolean}
@@ -41,32 +82,49 @@ export class Unit {
     }
 
     /**
-     * Returns the qname of the first numerator in the unit
-     * @return {String} QName string of a measure
+     * Returns the OIM format string representing the unit
+     * @return {String} OIM format unit string
      */
-    measure() {
-        return this._measure;
+    value() {
+        return this._value;
     }
 
-    /**
-     * Returns a readable label representing the first numerator in the unit
-     * @return {String} Label representing measure
-     */
-    measureLabel() {
-        const measure = this.measure();
-        const qname = this._report.qname(measure);
-        if (qname.namespace === "http://www.xbrl.org/2003/iso4217") {
-            return i18next.t(`currencies:unitFormat${qname.localname}`, {defaultValue: qname.localname});
+    measureHTML(m) {
+        const span = document.createElement("span");
+        const name = measureName(this._reportSet, m);
+        if (name !== undefined) {
+            span.setAttribute("title", name);
+            span.classList.add("measure");
         }
-        return measure;
+        span.append(document.createTextNode(measureLabel(this._reportSet, m)));
+        return span;
     }
 
-    /**
-     * Returns the OIM format string representing the unit
-     * @return {String} OIM format unit string
-     */
-    value() {
-        return this._value;
+    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;
     }
 }