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

iXBRLViewerPlugin/viewer/src/js/ixbrlviewer.test.js

@@ -1,6 +1,13 @@
 // See COPYRIGHT.md for copyright information
 
 import {iXBRLViewer} from "./ixbrlviewer";
+import {
+    FEATURE_GUIDE_LINK,
+    FEATURE_REVIEW,
+    FEATURE_SUPPORT_LINK,
+    FEATURE_SURVEY_LINK,
+    USER_GUIDE_URL,
+} from "./util";
 describe("Feature enablement", () => {
     var viewer = null;
     beforeAll(() => {
@@ -8,58 +15,99 @@ describe("Feature enablement", () => {
     });
 
     test("Query parameter with no value results in enablement", () => {
-        viewer.setFeatures([], 'a')
-        expect(viewer._features).toEqual(new Set(['a']));
+        viewer.setFeatures({}, 'a')
+        expect(viewer._staticFeatures).toEqual({});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'true'});
         expect(viewer.isFeatureEnabled('a')).toBeTruthy();
     });
 
     test("Excluded from JSON, excluded from query", () => {
-        viewer.setFeatures([], '')
-        expect(viewer._features).toEqual(new Set([]));
+        viewer.setFeatures({}, '')
+        expect(viewer._staticFeatures).toEqual({});
+        expect(viewer._dynamicFeatures).toEqual({});
         expect(viewer.isFeatureEnabled('a')).toBeFalsy();
     });
 
     test("Excluded from JSON, enabled in query", () => {
-        viewer.setFeatures([], 'a=true')
-        expect(viewer._features).toEqual(new Set(['a']));
+        viewer.setFeatures({}, 'a=true')
+        expect(viewer._staticFeatures).toEqual({});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'true'});
         expect(viewer.isFeatureEnabled('a')).toBeTruthy();
     });
 
     test("Excluded from JSON, disabled in query", () => {
-        viewer.setFeatures([], 'a=false')
-        expect(viewer._features).toEqual(new Set([]));
+        viewer.setFeatures({}, 'a=false')
+        expect(viewer._staticFeatures).toEqual({});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'false'});
         expect(viewer.isFeatureEnabled('a')).toBeFalsy();
     });
 
     test("Excluded from JSON, enabled and disabled in query", () => {
-        viewer.setFeatures([], 'a=true&a=false&a')
-        expect(viewer._features).toEqual(new Set([]));
+        viewer.setFeatures({}, 'a=true&a=false&a')
+        expect(viewer._staticFeatures).toEqual({});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'false'});
         expect(viewer.isFeatureEnabled('a')).toBeFalsy();
     });
 
     test("Included in JSON, excluded from query", () => {
-        viewer.setFeatures(['a'], '')
-        expect(viewer._features).toEqual(new Set(['a']));
+        viewer.setFeatures({'a': true}, '')
+        expect(viewer._staticFeatures).toEqual({'a': true});
+        expect(viewer._dynamicFeatures).toEqual({});
         expect(viewer.isFeatureEnabled('a')).toBeTruthy();
     });
 
     test("Included in JSON, enabled in query", () => {
-        viewer.setFeatures(['a'], 'a=true')
-        expect(viewer._features).toEqual(new Set(['a']));
+        viewer.setFeatures({'a': true}, 'a=true')
+        expect(viewer._staticFeatures).toEqual({'a': true});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'true'});
         expect(viewer.isFeatureEnabled('a')).toBeTruthy();
     });
 
     test("Included in JSON, disabled in query", () => {
-        viewer.setFeatures(['a'], 'a=false')
-        expect(viewer._features).toEqual(new Set([]));
+        viewer.setFeatures({'a': true}, 'a=false')
+        expect(viewer._staticFeatures).toEqual({'a': true});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'false'});
         expect(viewer.isFeatureEnabled('a')).toBeFalsy();
     });
 
     test("Included in JSON, enabled and disabled in query", () => {
-        viewer.setFeatures(['a'], 'a=true&a=false&a')
-        expect(viewer._features).toEqual(new Set([]));
+        viewer.setFeatures({'a': true}, 'a=true&a=false&a')
+        expect(viewer._staticFeatures).toEqual({'a': true});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'false'});
         expect(viewer.isFeatureEnabled('a')).toBeFalsy();
     });
+
+    test("Value set in JSON, not included in query", () => {
+        viewer.setFeatures({'a': '1'}, '')
+        expect(viewer._staticFeatures).toEqual({'a': '1'});
+        expect(viewer._dynamicFeatures).toEqual({});
+        expect(viewer.getFeatureValue('a')).toEqual('1');
+        expect(viewer.isFeatureEnabled('a')).toBeTruthy();
+    });
+
+    test("Value not set in JSON, set in query", () => {
+        viewer.setFeatures({}, 'a=1')
+        expect(viewer._staticFeatures).toEqual({});
+        expect(viewer._dynamicFeatures).toEqual({'a': '1'});
+        expect(viewer.getFeatureValue('a')).toEqual('1');
+        expect(viewer.isFeatureEnabled('a')).toBeTruthy();
+    });
+
+    test("Value set in JSON, overwritten in query", () => {
+        viewer.setFeatures({'a': '1'}, 'a=2')
+        expect(viewer._staticFeatures).toEqual({'a': '1'});
+        expect(viewer._dynamicFeatures).toEqual({'a': '2'});
+        expect(viewer.getFeatureValue('a')).toEqual('2');
+        expect(viewer.isFeatureEnabled('a')).toBeTruthy();
+    });
+
+    test("Value set in JSON, overwritten in query with blank", () => {
+        viewer.setFeatures({'a': '1'}, 'a')
+        expect(viewer._staticFeatures).toEqual({'a': '1'});
+        expect(viewer._dynamicFeatures).toEqual({'a': 'true'});
+        expect(viewer.getFeatureValue('a')).toEqual('true');
+        expect(viewer.isFeatureEnabled('a')).toBeTruthy();
+    });
 });
 
 describe("Review mode enablement", () => {
@@ -69,12 +117,78 @@ describe("Review mode enablement", () => {
     });
 
     test("Review mode enabled", () => {
-        viewer.setFeatures(['review'], '')
+        viewer.setFeatures({[FEATURE_REVIEW]: true}, '')
         expect(viewer.isReviewModeEnabled()).toBeTruthy();
     });
 
     test("Review mode disabled", () => {
-        viewer.setFeatures(['a'], '')
+        viewer.setFeatures({'a': true}, '')
         expect(viewer.isReviewModeEnabled()).toBeFalsy();
     });
 });
+
+describe("Support link enablement", () => {
+    var viewer = null;
+    beforeAll(() => {
+        viewer = new iXBRLViewer({})
+    });
+
+    test("Support link enabled by JSON", () => {
+        viewer.setFeatures({[FEATURE_SUPPORT_LINK]: '/help'}, '')
+        expect(viewer.getSupportLinkUrl()).toEqual('/help');
+    });
+
+    test("Support link enabled by query", () => {
+        viewer.setFeatures({}, FEATURE_SUPPORT_LINK + '=/help')
+        expect(viewer.getSupportLinkUrl()).toEqual(null);
+    });
+
+    test("Support link disabled by query", () => {
+        viewer.setFeatures({[FEATURE_SUPPORT_LINK]: '/help'}, FEATURE_SUPPORT_LINK + '=false')
+        expect(viewer.getSupportLinkUrl()).toEqual('/help');
+    });
+});
+
+describe("Survey link enablement", () => {
+    var viewer = null;
+    beforeAll(() => {
+        viewer = new iXBRLViewer({})
+    });
+
+    test("Survey link enabled by JSON", () => {
+        viewer.setFeatures({[FEATURE_SURVEY_LINK]: '/survey'}, '')
+        expect(viewer.getSurveyLinkUrl()).toEqual('/survey');
+    });
+
+    test("Survey link enabled by query", () => {
+        viewer.setFeatures({}, FEATURE_SURVEY_LINK + '=/survey')
+        expect(viewer.getSurveyLinkUrl()).toEqual(null);
+    });
+
+    test("Survey link disabled by query", () => {
+        viewer.setFeatures({[FEATURE_SURVEY_LINK]: '/survey'}, FEATURE_SURVEY_LINK + '=false')
+        expect(viewer.getSurveyLinkUrl()).toEqual('/survey');
+    });
+});
+
+describe("Guide link enablement", () => {
+    var viewer = null;
+    beforeAll(() => {
+        viewer = new iXBRLViewer({})
+    });
+
+    test("Guide link enabled by JSON", () => {
+        viewer.setFeatures({[FEATURE_GUIDE_LINK]: '/guide'}, '')
+        expect(viewer.getGuideLinkUrl()).toEqual('/guide');
+    });
+
+    test("Guide link enabled by query", () => {
+        viewer.setFeatures({}, FEATURE_GUIDE_LINK + '=/guide')
+        expect(viewer.getGuideLinkUrl()).toEqual(USER_GUIDE_URL);
+    });
+
+    test("Guide link disabled by query", () => {
+        viewer.setFeatures({[FEATURE_GUIDE_LINK]: '/guide'}, FEATURE_GUIDE_LINK + '=false')
+        expect(viewer.getGuideLinkUrl()).toEqual('/guide');
+    });
+});

iXBRLViewerPlugin/viewer/src/js/ixnode.js

@@ -46,6 +46,6 @@ export class IXNode {
     }
 
     htmlHidden() {
-        return this.wrapperNodes.is(':hidden') || this.wrapperNodes.is((i,e) => isTransparent($(e).css('color')));
+        return this.wrapperNodes.filter(':not(.ixbrl-no-highlight)').is(':hidden') || this.wrapperNodes.is((i,e) => isTransparent($(e).css('color')));
     }
 }

iXBRLViewerPlugin/viewer/src/js/menu.js

@@ -1,6 +1,7 @@
 // See COPYRIGHT.md for copyright information
 
 import $ from 'jquery'
+import i18next from "i18next";
 
 export class Menu {
     constructor(elt, attr) {
@@ -8,14 +9,14 @@ export class Menu {
         attr = attr || {};
         this.type = attr.type || "dropdown";
 
-        elt.find(".menu-title").click((e) => {
+        elt.find(".menu-title").on("click", (e) => {
             elt.find(".content-container").toggle();
             /* Stop an opening click from also being treated as an "out-of-menu"
              * closing click */
             e.stopPropagation();
         });
 
-        $('html').click((event) => {
+        $('html').on("click", (event) => {
             if ($(".content", elt).find($(event.target)).length === 0) {
                 this.close();
             }
@@ -50,7 +51,7 @@ export class Menu {
                 .attr({
                     href: filename})
                 .text(name)
-                .click(() => menu.close());
+                .on("click", () => menu.close());
         this._add(item);
     }
 
@@ -65,14 +66,14 @@ export class Menu {
                 $('<input type="checkbox"></input>')
                     .prop("checked", onByDefault)
                     .change(function () {
-                        callback($(this).prop("checked"));
+                        callback($(this).prop("checked"), true);
                         menu.close(); 
                     })
             )
             .append($("<span></span>").addClass("checkmark"));
         this._add(item, after);
         if (onByDefault) {
-            callback(true);
+            callback(true, false);
         }
     }
 
@@ -89,9 +90,8 @@ export class Menu {
                 .prepend(
                     $('<input type="radio"></input>')
                         .attr({ "name": name, "value": v})
-                        .change(function () {
+                        .on("change", function () {
                             callback($(this).val())
-                            menu.close(); 
                         })
                 )
                 .append($("<span></span>").addClass("checkmark"))
@@ -102,4 +102,22 @@ export class Menu {
             }
         }
     }
+
+    addLabel(name) {
+        const item = $('<div></div>')
+                .addClass("label")
+                .text(name)
+        this._add(item);
+    }
+
+    addLink(label, href) {
+        const item = $("<a></a>")
+                .attr("href", href)
+                .attr("target", "_blank")
+                .attr("title", label)
+                .attr("aria-label", label)
+                .addClass("item")
+                .text(label);
+        this._add(item);
+    }
 }

iXBRLViewerPlugin/viewer/src/js/number-matcher.js

@@ -47,9 +47,9 @@ const hyphen = '[-\u2014]';
 
 // everything that we allow immediately before a match 
 // (201c = left double quote, 2014 = em dash, 201d = right double quote)
-const begin_guard = '(?:^|(?<=(?:[/\u201c\u2014(]|' + one_ws + '|' + hyphen + ')))';
+const begin_guard = '(?:^|(?<=(?:[/\u201c\u2014([]|' + one_ws + '|' + hyphen + ')))';
 // everything that we allow immediately after a match
-const end_guard = '(?:$|(?=(?:[/,.:;\u201d\u2014)]|' + one_ws + '|' + hyphen + ')))';
+const end_guard = '(?:$|(?=(?:[/,.:;\u201d\u2014)\\]]|' + one_ws + '|' + hyphen + ')))';
 
 const ordinal_suffix = '(?:st|nd|rd|th)';
 const day = '[123]?\\d' + ordinal_suffix + '?';
@@ -90,6 +90,10 @@ const note = 'note' + ws + '\\d{1,3}';
 const level = 'level' + ws + '\\d{1,3}';
 const page = 'page' + ws + '\\d{1,3}';
 const tier = 'tier' + ws + '\\d{1,3}';
+const act = 'act' + ws + 'of' + ws + year; // e.g. 'SECURITIES EXCHANGE ACT OF 1934'
+// Note that this is a superset of "isoDate" but "dateMatch" appears before "do_not_want" so it won't exclude ISO dates.
+const phone_number = '\\d+-\\d+[-\\d]*'    // e.g. 275-3125. Also covers employer number (e.g. 47-2509828). 
+const form_name = '(?:10|8)-(?:k|q)'       // e.g. '10-K'
 
 const months_ended = r_or([number_word, '\\d+']) + ws + 'months ended';
 
@@ -98,7 +102,7 @@ const month_day_year = month_num + '/' + day_with_0 + '/' + year;
 const month_year = month_num + '/\\d\\d';
 
 const do_not_want = r_or([section, topic, form, asc, item, rule, note, level, page,
-                    tier, months_ended, month_day_year, month_year]);
+                    tier, act, phone_number, form_name, months_ended, month_day_year, month_year]);
 
 const number_separator = r_or([r_maybe(ws + hyphen + ws), ws]);
 const number_word_string = number_word + r_zero_or_more(number_separator + number_word);

iXBRLViewerPlugin/viewer/src/js/number-matcher.test.js

@@ -112,12 +112,16 @@ describe("Number match replace", () => {
         var numbers = [
             [ 'Sept 20th, 2019', '[[Sept 20th, 2019]]' ],
             [ 'abcd 37 abcd', 'abcd [[37]] abcd' ],
+            [ '2010-01-01', '[[2010-01-01]]' ],
             // Test "do not want" filtering
             [ 'abcd topic 37 abcd', 'abcd topic 37 abcd' ],
             [ 'abcd topic 37 93 abcd', 'abcd topic 37 [[93]] abcd' ],
             [ 'section 123(a)', 'section 123(a)' ],
             [ 'section 123a', 'section 123a' ],
             [ 'section 123', 'section 123' ],
+            [ 'securities exchange act of 1934', 'securities exchange act of 1934' ],
+            [ '10-K', '10-K' ],
+            [ '274-3125', '274-3125' ],
             // Doesn't match due to end guard
             [ '401(k)', '401(k)' ],
             [ 'N RM100', 'N [[RM100]]' ],

iXBRLViewerPlugin/viewer/src/js/outline.js

@@ -1,6 +1,24 @@
 // See COPYRIGHT.md for copyright information
 
-import $ from 'jquery'
+export class ReportSetOutline {
+    constructor(reportSet) {
+        this._reportSet = reportSet;
+        this.outlines = reportSet.reports.map(r => new DocumentOutline(r));
+    }
+
+    hasOutline() {
+        return this.outlines.some(o => Object.keys(o.sections).length > 0);
+    }
+
+    sortedSections() {
+        return this.outlines.flatMap(o => o.sortedSections());
+    }
+
+    groupsForFact(f) {
+        return this.outlines.find(o => o.report == f.report).groupsForFact(f);
+    }
+
+}
 
 // DocumentOutline chooses a fact for each presentation group (ELR) that
 // represents the start of that ELR.  This is done by deciding which ELRs each
@@ -8,7 +26,7 @@ import $ from 'jquery'
 // continuous run of facts in document order that participate in each ELR.
 export class DocumentOutline {
     constructor(report) {
-        this._report = report;
+        this.report = report;
         const facts = report.facts().sort((a, b) => a.ixNode.docOrderindex - b.ixNode.docOrderindex);
         const runLength = {};
         const runStart = {};
@@ -57,7 +75,8 @@ export class DocumentOutline {
     factInGroup(fact, elr) {
         // Roots are abstract so no need to check for concepts with outgoing
         // relationships only.
-        if (this._report.getParentRelationshipsInGroup(fact.conceptName(), "pres", elr).length == 0) {
+
+        if (this.report.getParentRelationshipsInGroup(fact.conceptName(), "pres", elr).length == 0) {
             return false;
         }
         const fd = fact.dimensions();
@@ -97,18 +116,18 @@ export class DocumentOutline {
     //   between presentation and dimensional ELRs.
     //
     _buildDimensionMap() {
-        const groups = this._report.relationshipGroups("pres");
+        const groups = this.report.relationshipGroups("pres");
         this.dimensionMap = {};
         for (const elr of groups) {
             this.dimensionMap[elr] = {};
-            for (const root of this._report.relationshipGroupRoots("pres", elr)) {
+            for (const root of this.report.relationshipGroupRoots("pres", elr)) {
                 this.buildDimensionMapFromSubTree("pres", elr, null, root);
             }
         }
     }
 
     buildDimensionMapFromSubTree(arcrole, elr, dimension, conceptName) {
-        const c = this._report.getConcept(conceptName);
+        const c = this.report.getConcept(conceptName);
         if (c.isTypedDimension()) {
             this.dimensionMap[elr][conceptName] = { typed: true };
             return
@@ -117,13 +136,13 @@ export class DocumentOutline {
             dimension = conceptName;
             this.dimensionMap[elr][dimension] = { members: {}, allowDefault: false};
         }
-        var children = this._report.getChildRelationships(conceptName, arcrole);
+        var children = this.report.getChildRelationships(conceptName, arcrole);
         if (!(elr in children)) {
             return
         }
         for (var rel of children[elr]) {
             if (dimension) {
-                if (this._report.dimensionDefault(dimension) == rel.t) {
+                if (this.report.dimensionDefault(dimension) == rel.t) {
                     this.dimensionMap[elr][dimension].allowDefault = true;
                 }
                 else {
@@ -136,10 +155,10 @@ export class DocumentOutline {
 
     // Returns a list of presentation groups that this fact participates in
     groupsForFact(fact) {
-        var factGroups = [];
-        for (const group of this._report.relationshipGroups("pres")) {
+        const factGroups = [];
+        for (const group of this.report.relationshipGroups("pres")) {
             if (this.factInGroup(fact, group)) {
-                factGroups.push(group);
+                factGroups.push({ elr: group, fact: this.sections[group], report: this.report});
             }
         }
         return factGroups;
@@ -152,7 +171,9 @@ export class DocumentOutline {
     sortedSections() {
         const sections = Object.keys(this.sections);
         const re = /\(parenthetical\)\s*$/i;
-        const filteredSections = sections.filter(s => !re.test(this._report.getRoleLabel(s)));
-        return filteredSections.sort((a, b) => this._report.getRoleLabel(a).localeCompare(this._report.getRoleLabel(b)));
+        const filteredSections = sections.filter(s => !re.test(this.report.getRoleLabelOrURI(s)));
+        return filteredSections
+            .sort((a, b) => this.report.getRoleLabelOrURI(a).localeCompare(this.report.getRoleLabelOrURI(b)))
+            .map(elr => ({ report: this.report, fact: this.sections[elr], elr: elr }));
     }
 }