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

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

@@ -1,21 +1,25 @@
 // See COPYRIGHT.md for copyright information
 
 import { Unit } from "./unit.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",
-    }
+        "utr": "http://www.xbrl.org/2009/utr",
+        "xbrli": "http://www.xbrl.org/2003/instance",
+    },
+    "facts": {},
 };
 
 function testReport() {
     // Deep copy of standing data
     const data = JSON.parse(JSON.stringify(testReportData));
-    const report = new iXBRLReport(data);
+    const report = new ReportSet(data);
     report.setIXNodeMap({});
     return report;
 }
@@ -28,51 +32,80 @@ beforeAll(() => {
 describe("Unit label", () => {
     test("Unit label for simple unit", () => {
         var unit = new Unit(testReport(), 'iso4217:USD');
-        expect(unit.label()).toEqual('USD');
+        expect(unit.label()).toEqual('US $');
     });
 
     test("Unit label for complex unit", () => {
         var unit = new Unit(testReport(), 'iso4217:USD/eg:share');
-        expect(unit.label()).toEqual('USD/Share');
+        expect(unit.label()).toEqual('US $/share');
     });
 
     test("Unit label for complex unit with numerator parentheses", () => {
         var unit = new Unit(testReport(), '(iso4217:USD*eg:share)/eg:shareholder');
-        expect(unit.label()).toEqual('(USD*Share)/Shareholder');
+        expect(unit.label()).toEqual('(US $*share)/shareholder');
     });
 
     test("Unit label for complex unit with denominator parentheses", () => {
         var unit = new Unit(testReport(), 'iso4217:USD/(eg:share*eg:shareholder)');
-        expect(unit.label()).toEqual('USD/(Share*Shareholder)');
+        expect(unit.label()).toEqual('US $/(share*shareholder)');
     });
 });
 
-describe("Unit measure", () => {
-    test("Unit measure is simple unit", () => {
+describe("Unit label", () => {
+    test("Unit label - known currency", () => {
+        var unit = new Unit(testReport(), 'eg:share');
+        expect(unit.label()).toEqual('share');
+    });
+
+    test("Unit label - known currency", () => {
         var unit = new Unit(testReport(), 'iso4217:USD');
-        expect(unit.measure()).toEqual('iso4217:USD');
+        // Note "US $" from i18n takes precedence over "USD $" generated from UTR
+        expect(unit.label()).toEqual('US $');
     });
 
-    test("Unit measure is first numerator of complex unit", () => {
-        var unit = new Unit(testReport(), '(iso4217:USD*eg:share)/eg:shareholder');
-        expect(unit.measure()).toEqual('iso4217:USD');
+    test("Unit label - UTR currency", () => {
+        var unit = new Unit(testReport(), 'iso4217:THB');
+        expect(unit.label()).toEqual('฿');
     });
-});
 
-describe("Unit measure label", () => {
-    test("Unit measure label - known currency", () => {
-        var unit = new Unit(testReport(), 'eg:share');
-        expect(unit.measureLabel()).toEqual('eg:share');
+    test("Unit label - UTR currency with '$' symbol", () => {
+        var unit = new Unit(testReport(), 'iso4217:SGD');
+        expect(unit.label()).toEqual('SGD $');
     });
 
-    test("Unit measure label - known currency", () => {
-        var unit = new Unit(testReport(), 'iso4217:USD');
-        expect(unit.measureLabel()).toEqual('US $');
+    test("Unit label - UTR currency without symbol falls back to name", () => {
+        var unit = new Unit(testReport(), 'iso4217:YER');
+        expect(unit.label()).toEqual('Yemeni rial');
+    });
+
+    test("Unit label - UTR currency without symbol falls back to name", () => {
+        var unit = new Unit(testReport(), 'iso4217:XAU');
+        expect(unit.label()).toEqual('Gold');
     });
 
-    test("Unit measure label - unknown", () => {
-        var unit = new Unit(testReport(), 'iso4217:ZAR');
-        expect(unit.measureLabel()).toEqual('ZAR');
+    test("Unit label - unknown", () => {
+        var unit = new Unit(testReport(), 'iso4217:ZZZZ');
+        expect(unit.label()).toEqual('ZZZZ');
+    });
+
+    test("Unit label - UTR non-currency symbol used", () => {
+        var unit = new Unit(testReport(), 'utr:m3');
+        expect(unit.label()).toEqual('m³');
+    });
+
+    test("Unit label - UTR non-currency symbol used", () => {
+        var unit = new Unit(testReport(), 'utr:sqkm');
+        expect(unit.label()).toEqual('km²');
+    });
+
+    test("Unit label - UTR non-currency symbol used", () => {
+        var unit = new Unit(testReport(), 'utr:F');
+        expect(unit.label()).toEqual('°F');
+    });
+
+    test("Unit label - UTR non-currency without symbol falls back to name", () => {
+        var unit = new Unit(testReport(), 'xbrli:shares');
+        expect(unit.label()).toEqual('Share');
     });
 });
 
@@ -93,4 +126,8 @@ describe("Unit value", () => {
         var unit = new Unit(testReport(), '(iso4217:USD*eg:share)/eg:shareholder');
         expect(unit.value()).toEqual('(iso4217:USD*eg:share)/eg:shareholder');
     });
+    test("Unit value is simple unit", () => {
+        var unit = new Unit(testReport(), 'iso4217:USD');
+        expect(unit.value()).toEqual('iso4217:USD');
+    });
 });

iXBRLViewerPlugin/viewer/src/js/util.js

@@ -3,6 +3,38 @@
 import moment from "moment";
 import Decimal from "decimal.js";
 
+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 = 6;
+
+// 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 FEATURE_HIDE_CALCULATION_MODE_OPTION = 'hide_calculation_mode_option';
+
+export const IXBRL_VIEWER_DATASET_PREFIX = 'ixbrlViewer';
+
+export const STORAGE_APP_LANGUAGE = "ixbrl-viewer-app-language";
+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";
+export const USER_GUIDE_URL = "https://arelle-ixbrl-viewer.readthedocs.io/en/latest/user_guides/user_guide.html";
+
 /* 
  * 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
@@ -160,3 +192,65 @@ export function isTransparent(rgba) {
     const val = parseFloat(rgba.split(",")[3]);
     return !isNaN(val) && val < 0.1;
 }
+
+/**
+ * Prefix an item ID with the index of the report document that it appears in,
+ * in order to generate an ID that is guaranteed to be unique within the
+ * viewer. This is already within an iXBRL Document Set, but not across
+ * separate iXBRL documents or document sets.
+ * @param  {Number}  sourceReportIndex - index of the report document containing the fact
+ * @param  {String}  localId - local ID of the fact
+ * @return {String}   a viewer unique ID
+ */
+
+export function viewerUniqueId(sourceReportIndex, localId) {
+    if (localId === null || localId === undefined) {
+        return null;
+    }
+    return sourceReportIndex.toString() + "-" + localId;
+}
+
+export function localId(viewerUniqueId) {
+    return viewerUniqueId.replace(/^\d+-/,"");
+}
+
+/**
+ * Parses fact IDs from -sec-ix-hidden and -esef-ix-hidden style 
+ * attributes on a DOM node.  
+ * Any returned ID should be the ID of a fact in ix:hidden corresponding
+ * to the content contained in the DOM node.
+ * 
+ * @param  {Node}     domNode - DOM node to parse
+ * @return {String}   A fact ID, or null if the element does not have 
+ * a style attribute containing a custom CSS property in the required 
+ * format.
+ */
+
+export function getIXHiddenLinkStyle(domNode) {
+    if (domNode.hasAttribute('style')) {
+        const re = /(?:^|\s|;)(?:-sec|-esef)?-ix-hidden:\s*([^\s;]+)/;
+        const m = domNode.getAttribute('style').match(re);
+        if (m) {
+            return m[1];
+        }
+    }
+    return null;
+}
+
+/**
+ * Moves all attributes from one element to another, excluding data attributes created by the viewer application.
+ */
+export function moveNonAppAttributes(fromElement, toElement) {
+    for (const attr of [...fromElement.attributes]) {
+        if (!attr.name.startsWith("data-")) {
+            toElement.setAttribute(attr.name, attr.value); 
+            fromElement.removeAttribute(attr.name);
+        }
+    }
+    for (const [key, value] of Object.entries(fromElement.dataset)) {
+        if (!key.startsWith(IXBRL_VIEWER_DATASET_PREFIX)) {
+            toElement.dataset[key] = value;
+            delete fromElement.dataset[key];
+        }
+    }
+}

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

@@ -1,6 +1,6 @@
 // See COPYRIGHT.md for copyright information
 
-import { xbrlDateToMoment, momentToHuman, formatNumber, wrapLabel, escapeRegex, truncateLabel } from "./util.js"
+import { xbrlDateToMoment, momentToHuman, formatNumber, wrapLabel, escapeRegex, truncateLabel, getIXHiddenLinkStyle } from "./util.js"
 import moment from 'moment';
 import "./moment-jest.js";
 
@@ -144,3 +144,35 @@ describe("Regex escape", () => {
         expect(escapeRegex("a.b*{}")).toBe("a\\.b\\*\\{\\}")
     });
 });
+
+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],
+        ["-sec-ix-hidden: 123", "123"],
+        ["-sec-ix-hidden:123 ", "123"],
+        ["-sec-ix-hidden:123;", "123"],
+        ["-sec-ix-hidden:123 abc", "123"],
+        ["xxx-sec-ix-hidden:123", null],
+        ["xxx;-sec-ix-hidden:123", "123"],
+        [" -sec-ix-hidden:123", "123"],
+        [";-sec-ix-hidden:123", "123"],
+        ["-sec-ix-Hidden:123", null],
+        ["-sec-ix-hidden:123;-sec-ix-hidden:abc", "123"],
+        ["", null],
+        [null, null],
+    ])("Style value %p returns %p", (style, result) => {
+        const domNode = document.createElement('div');
+        domNode.setAttribute("style", style);
+        const id = getIXHiddenLinkStyle(domNode);
+        expect(id).toEqual(result);
+    });
+
+    test("No style attribute returns null", () => {
+        const domNode = document.createElement('div');
+        const id = getIXHiddenLinkStyle(domNode);
+        expect(id).toEqual(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)
+    }
+}
+
+export const utr = new UTR();