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

iXBRLViewerPlugin/viewer/src/js/report.js

@@ -1,11 +1,7 @@
 // See COPYRIGHT.md for copyright information
 
-import { Fact } from "./fact.js"
-import { Footnote } from "./footnote.js"
-import { QName } from "./qname.js"
 import { Concept } from "./concept.js";
-import { setDefault, viewerUniqueId } from "./util.js";
-import $ from 'jquery'
+import { setDefault } from "./util.js";
 import i18next from "i18next";
 
 // Class to represent the XBRL data from a single target document in a single
@@ -169,7 +165,39 @@ export class XBRLReport {
                 return label;
             }
         }
-        return this.reportSet.roleMap()[rolePrefix];
+        return undefined;
+    }
+
+    getRoleLabelOrURI(rolePrefix) {
+        return this.getRoleLabel(rolePrefix) ?? this.reportSet.roleMap()[rolePrefix];
+    }
+
+    getLabelRoleLabel(rolePrefix) {
+        const roleURI = this.reportSet.roleMap()[rolePrefix];
+        if (roleURI === undefined) {
+            return undefined;
+        }
+
+        // Built-in label roles don't have a definition in the taxonomy. Do an
+        // i18n look-up on the last part of the URI. For "en" the camel-case
+        // splitter will do what we want for everything except standard label
+        // and documentation label 
+        const suffix = roleURI.split("/").pop();
+        if (roleURI.startsWith("http://www.xbrl.org/2003/role/") && i18next.exists(`labelRoles:${suffix}`)) {
+            return i18next.t(`labelRoles:${suffix}`);
+        }
+
+        // Attempt to get a label from the role definition
+        const label = this.getRoleLabel(rolePrefix);
+        if (label !== undefined) {
+            return label;
+        }
+
+        // Fall back on de-camel-casing the last part of the URI
+        return suffix
+            .replaceAll(/([A-Z][a-z]+)/g, ' $1')
+            .trim()
+            .replace(/^./, s => s.toUpperCase());
     }
 
     localDocuments() {
@@ -184,7 +212,7 @@ export class XBRLReport {
     }
 
     getScaleLabel(scale, unit) {
-        let label = i18next.t(`scale.${scale}`, {defaultValue:"noName"});
+        let label = i18next.t(`scale:${scale}`, {defaultValue:"noName"});
         if (unit && unit.isMonetary() && scale === -2) {
             let measure = unit.value() ?? '';
             if (measure) {
@@ -203,35 +231,47 @@ export class XBRLReport {
     }
 
     getLabel(c, rolePrefix, showPrefix) {
+        return this.getLabelAndLang(c, rolePrefix, showPrefix).label;
+    }
+
+    getLabelAndLang(c, rolePrefix, showPrefix) {
         rolePrefix = rolePrefix || 'std';
         const lang = this.reportSet.viewerOptions.language;
         const concept = this._reportData.concepts[c];
         if (concept === undefined) {
             console.log("Attempt to get label for undefined concept: " + c);
-            return "<no label>";
+            return { label: "<no label>" };
         }
         const labels = concept.labels[rolePrefix]
         if (labels === undefined || Object.keys(labels).length == 0) {
-            return undefined;
+            return { label: undefined };
         }
         else {
             let label;
+            let actualLang;
             if (lang && labels[lang]) {
                 label = labels[lang];
+                actualLang = lang;
             }
             else {
                 // Fall back on English, then any label deterministically.
-                label = labels["en"] || labels["en-us"] || labels[Object.keys(labels).sort()[0]];
+                for (const l of ["en", "en-us", Object.keys(labels).sort()[0]]) {
+                    if (labels[l] !== undefined) {
+                        label = labels[l];
+                        actualLang = l;
+                        break;
+                    }
+                }
             }
             if (label === undefined) {
-                return undefined;
+                return {label: undefined};
             }
             let s = '';
             if (showPrefix && this.reportSet.viewerOptions.showPrefixes) {
-                s = "(" + this.qname(c).prefix + ") ";
+                s = "(" + this.reportSet.taxonomyNamer.fromQName(this.qname(c)).prefix + ") ";
             }
             s += label;
-            return s;
+            return { label: s, lang: actualLang };
         }
     }
 
@@ -243,6 +283,14 @@ export class XBRLReport {
         return label;
     }
 
+    getLabelOrNameAndLang(c, rolePrefix, showPrefix) {
+        const labelLang = this.getLabelAndLang(c, rolePrefix, showPrefix);
+        if (labelLang.label === undefined) {
+            return { label: c };
+        }
+        return labelLang;
+    }
+
     isCalculationContributor(c) {
         if (this._calculationContributors === undefined) {
             if (this._reportData.rels?.calc) {
@@ -270,4 +318,11 @@ export class XBRLReport {
         }
         return this._calculationSummations.has(c);
     }
+
+    /**
+     * @return {Array[String]} Software credit text labels provided with this report for display purposes.
+     */
+    softwareCredits() {
+        return this._reportData.softwareCredits ?? [];
+    }
 }

iXBRLViewerPlugin/viewer/src/js/report.test.js

@@ -2,6 +2,7 @@
 
 import { ReportSet } from "./reportset.js";
 import { ViewerOptions } from "./viewerOptions.js";
+import { TestInspector } from "./test-utils.js";
 import { NAMESPACE_ISO4217 } from "./util";
 
 var testReportData = {
@@ -17,7 +18,11 @@ var testReportData = {
         "role1": "https://www.example.com/role1",
         "role2": "https://www.example.com/role2",
         "role3": "https://www.example.com/role3",
-        "role4": "https://www.example.com/role4"
+        "role4": "https://www.example.com/role4MoreWords",
+        "std": "http://www.xbrl.org/2003/role/label",
+        "doc": "http://www.xbrl.org/2003/role/documentation",
+        "verbose": "http://www.xbrl.org/2003/role/verboseLabel",
+        "total": "http://www.xbrl.org/2003/role/totalLabel",
     },
     "roleDefs": {
         "role1": { "en": "Role 1 Label" },
@@ -62,9 +67,15 @@ var testReportData = {
                 "p": "2018-01-01/2019-01-01",
             }
         }
-    }
+    },
+
+    "softwareCredits": ["Example credit text A", "Example credit text B"],
 };
 
+var insp = new TestInspector();
+beforeAll(() => {
+    return insp.i18nInit();
+});
 
 describe("Language options", () => {
     const testReportSet = new ReportSet(testReportData);
@@ -101,23 +112,33 @@ describe("Concept labels", () => {
     test("Label fallback", () => {
         vo.language = 'fr';
         expect(testReport.getLabel('eg:Concept3', 'std')).toBe("Concept trois");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std').label).toBe("Concept trois");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std').lang).toBe("fr");
         expect(testReport.getLabelOrName('eg:Concept3', 'std')).toBe("Concept trois");
         vo.language = 'es';
         expect(testReport.getLabel('eg:Concept3', 'std')).toBe("Concept cuatro");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std').label).toBe("Concept cuatro");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std').lang).toBe("es");
         expect(testReport.getLabelOrName('eg:Concept3', 'std')).toBe("Concept cuatro");
         // No English label, so fall back on German (de is first alphabetically)
         vo.language = 'en';
         expect(testReport.getLabel('eg:Concept3', 'std')).toBe("Concept vier");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std').label).toBe("Concept vier");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std').lang).toBe("de");
         expect(testReport.getLabelOrName('eg:Concept3', 'std')).toBe("Concept vier");
 
         // Attempt to get an undefined label type 
         expect(testReport.getLabel('eg:Concept3', 'doc')).toBeUndefined();
+        expect(testReport.getLabelAndLang('eg:Concept3', 'doc').label).toBeUndefined();
+        expect(testReport.getLabelAndLang('eg:Concept3', 'doc').lang).toBeUndefined();
         expect(testReport.getLabelOrName('eg:Concept3', 'doc')).toBe('eg:Concept3');
     });
 
     test("With prefix", () => {
         vo.language = 'fr';
         expect(testReport.getLabel('eg:Concept3', 'std', true)).toBe("(eg) Concept trois");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std', true).label).toBe("(eg) Concept trois");
+        expect(testReport.getLabelAndLang('eg:Concept3', 'std', true).lang).toBe("fr");
         expect(testReport.getLabelOrName('eg:Concept3', 'std', true)).toBe("(eg) Concept trois");
 
         expect(testReport.getLabel('eg:Concept3', 'doc', true)).toBeUndefined();
@@ -131,16 +152,66 @@ describe("ELR labels", () => {
     testReportSet._initialize();
     const testReport = testReportSet.reports[0];
     test("Present", () => {
-        expect(testReport.getRoleLabel("role1")).toBe("Role 1 Label");
+        expect(testReport.getRoleLabelOrURI("role1")).toBe("Role 1 Label");
+    });
+    test("Null", () => {
+        expect(testReport.getRoleLabelOrURI("role2")).toBe("https://www.example.com/role2");
+    });
+    test("No label", () => {
+        expect(testReport.getRoleLabelOrURI("role3")).toBe("https://www.example.com/role3");
+    });
+    test("Not present in roleDef", () => {
+        expect(testReport.getRoleLabelOrURI("role4")).toBe("https://www.example.com/role4MoreWords");
+    });
+});
+
+describe("Label role labels", () => {
+    const testReportSet = new ReportSet(testReportData);
+    testReportSet._initialize();
+    const testReport = testReportSet.reports[0];
+    test("Built-in (via i18n)", () => {
+        expect(testReport.getLabelRoleLabel("std")).toBe("Standard Label");
+    });
+    test("Built-in (via i18n)", () => {
+        expect(testReport.getLabelRoleLabel("doc")).toBe("Documentation Label");
+    });
+    test("Built-in (via de-camelcase)", () => {
+        expect(testReport.getLabelRoleLabel("verbose")).toBe("Verbose Label");
+    });
+    test("Present", () => {
+        expect(testReport.getLabelRoleLabel("role1")).toBe("Role 1 Label");
     });
     test("Null", () => {
-        expect(testReport.getRoleLabel("role2")).toBe("https://www.example.com/role2");
+        expect(testReport.getLabelRoleLabel("role2")).toBe("Role2");
     });
     test("No label", () => {
-        expect(testReport.getRoleLabel("role3")).toBe("https://www.example.com/role3");
+        expect(testReport.getLabelRoleLabel("role3")).toBe("Role3");
     });
     test("Not present in roleDef", () => {
-        expect(testReport.getRoleLabel("role4")).toBe("https://www.example.com/role4");
+        expect(testReport.getLabelRoleLabel("role4")).toBe("Role4 More Words");
+    });
+
+});
+
+describe("Fetching software credit", () => {
+
+    test("Successful", () => {
+        const testReportSet = new ReportSet(testReportData);
+        testReportSet._initialize();
+        const report = testReportSet.reports[0];
+
+        const softwareCredits = report.softwareCredits();
+        expect(softwareCredits).toEqual(["Example credit text A", "Example credit text B"]);
     });
 
+    test("Unset", () => {
+        let alternateData = JSON.parse(JSON.stringify(testReportData));
+        delete alternateData.softwareCredits;
+        const testReportSet = new ReportSet(alternateData);
+        testReportSet._initialize();
+        const report = testReportSet.reports[0];
+
+        const softwareCredits = report.softwareCredits();
+        expect(softwareCredits).toEqual([]);
+    });
 });

iXBRLViewerPlugin/viewer/src/js/reportset.js

@@ -7,8 +7,7 @@ import { Unit } from "./unit";
 import { titleCase, viewerUniqueId } from "./util.js";
 import { QName } from "./qname.js";
 import { ViewerOptions } from './viewerOptions.js';
-import $ from 'jquery'
-
+import { TaxonomyNamer } from './taxonomynamer.js';
 
 // Class represents the set of XBRL "target" reports shown in the viewer.
 // Each contained report represents the data from a single target document in a
@@ -19,6 +18,7 @@ export class ReportSet {
         this._data = data;
         this._ixNodeMap = {};
         this.viewerOptions = new ViewerOptions()
+        this.taxonomyNamer = new TaxonomyNamer(new Map());
     }
 
     /*
@@ -99,6 +99,10 @@ export class ReportSet {
         return this._data.prefixes;
     }
 
+    preferredPrefix(prefix) {
+        return this.taxonomyNamer.getName(prefix, this._data.prefixes[prefix]).prefix;
+    }
+
     namespaceGroups() {
         const counts = {};
         for (const f of this.facts()) {
@@ -118,6 +122,28 @@ export class ReportSet {
         return this._usedPrefixes;
     }
 
+    getUsedConceptDataTypes() {
+        if (this._usedDataTypes === undefined) {
+            const map = new Map()
+            for (const dt of Object.values(this._items)
+                    .filter(f => f instanceof Fact)
+                    .map(f => ({ dataType: f.concept().dataType(), isNumeric: f.isNumeric() }))
+                    .filter(t => t.dataType !== undefined)) {
+                map.set(dt.dataType.name, dt);
+            }
+            this._usedDataTypes = map.values().toArray();
+        }
+        return this._usedDataTypes;
+    }
+
+    /**
+     * @return {Array[String]} Sorted list of unique software credit text values
+     */
+    getSoftwareCredits() {
+        let softwareCredits = new Set(this.reports.flatMap(r => r.softwareCredits()));
+        return Array.from(softwareCredits).sort();
+    }
+
     getTargetDocuments() {
         if (this._targetDocuments === undefined) {
             this._targetDocuments = new Set(Object.values(this._items)
@@ -219,6 +245,10 @@ export class ReportSet {
         return this.reportsData().some(r => r.rels?.["w-n"] !== undefined);
     }
 
+    usesCalculations() {
+        return this.reportsData().some(r => Object.keys(r.rels?.calc ?? {}).length > 0);
+    }
+
     hasValidationErrors() {
         return this._data.validation !== undefined && this._data.validation.length > 0;
     }
@@ -230,5 +260,5 @@ export class ReportSet {
     factsForReport(report) {
         return Object.values(this._items).filter(i => i instanceof Fact && i.report == report);
     }
-    
+
 }

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

@@ -73,7 +73,10 @@ function multiReportTestData(withAnchoring) {
                         "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"],
                     },
                 ]
             },
@@ -112,7 +115,9 @@ function multiReportTestData(withAnchoring) {
 
                         "rels": {
                           ...anchoringRelationShips(withAnchoring)
-                        }
+                        },
+
+                        "softwareCredits": ["Example credit text A"],
                     }
                 ]
             }
@@ -165,7 +170,9 @@ function singleReportTestData() {
         "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"],
     };
 }
 
@@ -233,8 +240,8 @@ describe("Multi report - ELR labels", () => {
 
     test("Present", () => {
         // Role 1 only has a label in report 1
-        expect(testReportSet.reports[0].getRoleLabel("role1")).toBe("Role 1 Label");
-        expect(testReportSet.reports[1].getRoleLabel("role1")).toBe("https://www.example.com/role1");
+        expect(testReportSet.reports[0].getRoleLabelOrURI("role1")).toBe("Role 1 Label");
+        expect(testReportSet.reports[1].getRoleLabelOrURI("role1")).toBe("https://www.example.com/role1");
     });
 });
 
@@ -326,6 +333,25 @@ describe("ELR labels", () => {
     testReportSet._initialize();
 
     test("Present", () => {
-        expect(testReportSet.reports[0].getRoleLabel("role1")).toBe("Role 1 Label");
+        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,8 +1,6 @@
 // See COPYRIGHT.md for copyright information
 
 import lunr from 'lunr'
-import $ from 'jquery'
-import Decimal from "decimal.js";
 
 export class ReportSearch {
     constructor(reportSet) {
@@ -15,42 +13,49 @@ export class ReportSearch {
         var dims = {};
         var facts = this._reportSet.facts();
         this.periods = {};
-        for (var i = 0; i < facts.length; i++) {
-            var f = facts[i];
-            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];
+        // 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 += " " + f.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 = f.report.qname(wider[0]).localname;
-                doc.widerLabel = f.report.getLabel(wider[0], "std");
-                doc.widerDoc = f.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 ||
@@ -161,6 +178,13 @@ export class ReportSearch {
         );
     }
 
+    mandatoryFactFilter(s, item) {
+        if(!s.showMandatoryFacts) {
+            return true;
+        }
+        return item.isMandatory();
+    }
+
     search(s) {
         if (!this.ready) {
             return;
@@ -177,9 +201,11 @@ export class ReportSearch {
             this.factValueFilter,
             this.calculationsFilter,
             this.namespacesFilter,
+            this.dataTypesFilter,
             this.unitsFilter,
             this.scalesFilter,
-            this.targetDocumentFilter
+            this.targetDocumentFilter,
+            this.mandatoryFactFilter
         ];
 
         rr.forEach((r,_) => {

iXBRLViewerPlugin/viewer/src/js/search.test.js

@@ -55,7 +55,7 @@ function createDimensionalizedFact(id, concept, options=null, dimensions= {}) {
 
 // Returns a report set with a single report
 function testReport(testData, sourceIXData) {
-    return testReportSet([ {data: testData, ixData: sourceIXData ?? {} } ])
+    return testReportSet([ {data: testData, ixData: sourceIXData ?? { } } ])
 }
 
 function mergeDicts(a, b) {
@@ -71,7 +71,7 @@ function testReportSet(reports) {
     };
 
     const ixData = {};
-    for (const [n, report] of reports.entries()) {
+    for (const report of reports.values()) {
         const targetReport = {};
         for (const key of ["languages", "prefixes", "roles"]) {
             reportSetData[key] = mergeDicts(reportSetData[key], report.data[key]);
@@ -83,12 +83,15 @@ function testReportSet(reports) {
 
         for (const id of Object.keys(targetReport.facts)) {
             if (!(id in ixData)) {
-                ixData[viewerUniqueId(n,id)] = report.ixData?.[id] ?? {};
+                ixData[viewerUniqueId(0, id)] = report.ixData?.[id] ?? {};
             }
         } 
         targetReports.push(targetReport);
     }
     const reportSet = new ReportSet(reportSetData);
+    for (const [id, data] of Object.entries(ixData)) {
+        ixData[id].isHidden ??= false;
+    }
     reportSet.setIXNodeMap(ixData);
     return reportSet;
 }
@@ -96,13 +99,13 @@ function testReportSet(reports) {
 function testSearchSpec(searchString='') {
     const spec = {};
     spec.searchString = searchString;
-    spec.showVisibleFacts = true;
-    spec.showHiddenFacts = true;
+    spec.visibilityFilter = '*';
     spec.namespacesFilter = [];
     spec.unitsFilter = [];
     spec.scalesFilter = [];
     spec.periodFilter = [];
     spec.conceptTypeFilter = '*';
+    spec.dataTypesFilter = [];
     spec.dimensionTypeFilter = [];
     spec.factValueFilter = '*';
     spec.calculationsFilter = [];

iXBRLViewerPlugin/viewer/src/js/summary.js

@@ -125,6 +125,20 @@ export class DocumentSummary {
         return this._totalFacts;
     }
 
+    hiddenFacts() {
+        if (this._hiddenFacts === undefined) {
+            this._hiddenFacts = this._reportSet.facts().filter(f => f.isHidden()).length;
+        }
+        return this._hiddenFacts;
+    }
+
+    mandatoryFacts() {
+        if (this._mandatoryFacts === undefined) {
+            this._mandatoryFacts = this._reportSet.facts().filter(f => f.isMandatory()).length;
+        }
+        return this._mandatoryFacts;
+    }
+
     tagCounts() {
         if (this._tagCounts === undefined) {
             this._buildTagCounts();
@@ -138,4 +152,12 @@ export class DocumentSummary {
         }
         return this._localFileSummary.getDocuments()
     }
+
+
+    /**
+     * @return {Array[String]} Report set's list of software credit text values.
+     */
+    getSoftwareCredits() {
+        return this._reportSet.getSoftwareCredits();
+    }
 }