ixbrl-viewer 1.4.9__tar.gz → 1.4.11__tar.gz

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/.github/workflows/node-tests.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4.1.1
-      - uses: actions/setup-node@v4.0.0
+      - uses: actions/setup-node@v4.0.1
         with:
           cache: 'npm'
           check-latest: true

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/.github/workflows/npm-package.yml

@@ -27,7 +27,7 @@ jobs:
         with:
           fetch-depth: 0 # npm run prod requires tags, sadly this is the only way to get them.
       - name: Install Node.js
-        uses: actions/setup-node@v4.0.0
+        uses: actions/setup-node@v4.0.1
         with:
           cache: 'npm'
           check-latest: true
@@ -42,13 +42,13 @@ jobs:
           npm version $(git describe --tags)
           npm pack
       - name: Upload ixbrlviewer.js artifact
-        uses: actions/upload-artifact@v3.1.3
+        uses: actions/upload-artifact@v4.0.0
         with:
           name: ixbrlviewer.js
           if-no-files-found: error
           path: iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js
       - name: Upload npm artifact
-        uses: actions/upload-artifact@v3.1.3
+        uses: actions/upload-artifact@v4.0.0
         with:
           name: npm package
           if-no-files-found: error
@@ -63,17 +63,17 @@ jobs:
     if: startsWith(github.ref, 'refs/tags')
     steps:
       - name: Install Node.js
-        uses: actions/setup-node@v4.0.0
+        uses: actions/setup-node@v4.0.1
         with:
           check-latest: true
           node-version: ${{ inputs.node_version }}
           registry-url: 'https://registry.npmjs.org' # Must explicitly set this for NODE_AUTH_TOKEN to work below
       - name: Download ixbrlviewer.js artifact
-        uses: actions/download-artifact@v3.0.2
+        uses: actions/download-artifact@v4.1.0
         with:
           name: ixbrlviewer.js
       - name: Download npm artifact
-        uses: actions/download-artifact@v3.0.2
+        uses: actions/download-artifact@v4.1.0
         with:
           name: npm package
       - name: Publish with npm

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/.github/workflows/puppeteer.yml

@@ -27,13 +27,13 @@ jobs:
       - uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 0 # npm run prod requires tags, sadly this is the only way to get them.
-      - uses: actions/setup-node@v4.0.0
+      - uses: actions/setup-node@v4.0.1
         with:
           cache: 'npm'
           check-latest: true
           node-version: ${{ matrix.node-version }}
       - name: Install Python 3
-        uses: actions/setup-python@v4.7.1
+        uses: actions/setup-python@v5.0.0
         with:
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
@@ -53,7 +53,7 @@ jobs:
         run: npx http-server . &> tests/puppeteer/artifacts/http_server.log &
       - name: Run puppeteer tests
         run: npm run test:puppeteer
-      - uses: actions/upload-artifact@v3.1.3
+      - uses: actions/upload-artifact@v4.0.0
         if: failure()
         with:
           name: ${{ github.run_id }}.${{ github.run_attempt }}_${{ matrix.os }}_${{ matrix.node-version }}_${{ matrix.python-version }}_artifacts

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/.github/workflows/python-package.yml

@@ -37,7 +37,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Install Node.js
-        uses: actions/setup-node@v4.0.0
+        uses: actions/setup-node@v4.0.1
         with:
           cache: 'npm'
           check-latest: true
@@ -47,7 +47,7 @@ jobs:
       - name: Build ixbrlviewer.js
         run: make prod
       - name: Install Python
-        uses: actions/setup-python@v4.7.1
+        uses: actions/setup-python@v5.0.0
         with:
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
@@ -60,13 +60,13 @@ jobs:
       - name: Build Python package
         run: python -m build
       - name: Upload source distribution artifact
-        uses: actions/upload-artifact@v3.1.3
+        uses: actions/upload-artifact@v4.0.0
         with:
           name: source distribution
           if-no-files-found: error
           path: dist/*.tar.gz
       - name: Upload wheel artifact
-        uses: actions/upload-artifact@v3.1.3
+        uses: actions/upload-artifact@v4.0.0
         with:
           name: wheel
           if-no-files-found: error
@@ -83,11 +83,11 @@ jobs:
       - name: Install twine
         run: pip install -U twine
       - name: Download source distribution artifact
-        uses: actions/download-artifact@v3.0.2
+        uses: actions/download-artifact@v4.1.0
         with:
           name: source distribution
       - name: Download wheel artifact
-        uses: actions/download-artifact@v3.0.2
+        uses: actions/download-artifact@v4.1.0
         with:
           name: wheel
       - name: Publish package on release

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/.github/workflows/python-tests.yml

@@ -26,13 +26,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4.1.1
       - name: Install Python 3
-        uses: actions/setup-python@v4.7.1
+        uses: actions/setup-python@v5.0.0
         with:
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
           check-latest: true
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
-        run: pip install .[dev]
-      - name: Test with nose2
-        run: nose2
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          pip install .[arelle,dev]
+          pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/.gitignore

@@ -1,5 +1,9 @@
 .idea
+.mypy_cache
+.pytest_cache
+.tox
 .vscode
+build
 node_modules/
 dist/
 __pycache__
@@ -8,3 +12,4 @@ iXBRLViewerPlugin/viewer/src/fonts/
 iXBRLViewerPlugin/viewer/src/less/generated/
 iXBRLViewerPlugin/_version.py
 /ixbrl-viewer*.tgz
+ixbrl_viewer.egg-info

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/ARCHITECTURE.md

@@ -82,8 +82,9 @@ the viewer.
 ### docSetFiles
 
 `docSetFiles` is a list of files in the document set.  It is used to load other
-documents in the document set into iframes in tabs in the viewer.  For single
-file, non-stub viewers, this property is not present.
+documents in the document set into iframes in tabs in the viewer.  
+
+`docSetFiles` is a list of relative URLs.
 
 ### targetReports
 

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ixbrl-viewer
-Version: 1.4.9
+Version: 1.4.11
 Summary: The Arelle iXBRL Viewer allows iXBRL reports to be viewed interactively in a web browser.
 Author-email: "arelle.org" <support@arelle.org>
 License: Apache-2.0
@@ -29,12 +29,16 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: arelle_release==2.*
 Requires-Dist: lxml==4.*
-Requires-Dist: pycountry==22.*
+Requires-Dist: pycountry<24,>=22
+Provides-Extra: arelle
+Requires-Dist: arelle_release==2.*; extra == "arelle"
 Provides-Extra: dev
+Requires-Dist: flake8==6.1.0; extra == "dev"
+Requires-Dist: lxml-stubs==0.4.0; extra == "dev"
+Requires-Dist: mypy==1.8.0; extra == "dev"
 Requires-Dist: nose2==0.14.0; extra == "dev"
-Requires-Dist: typing-extensions==4.8.0; extra == "dev"
+Requires-Dist: typing-extensions==4.9.0; extra == "dev"
 
 # Arelle iXBRL Viewer
 

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/iXBRLViewerPlugin/_version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '1.4.9'
-__version_tuple__ = version_tuple = (1, 4, 9)
+__version__ = version = '1.4.11'
+__version_tuple__ = version_tuple = (1, 4, 11)

{ixbrl-viewer-1.4.9 → ixbrl-viewer-1.4.11}/iXBRLViewerPlugin/iXBRLViewer.py

@@ -95,6 +95,7 @@ class IXBRLViewerBuilder:
             "languages": {},
         }
         self.basenameSuffix = basenameSuffix
+        self.currentTargetReport = None
 
     def enableFeature(self, featureName: str):
         if featureName in self.taxonomyData["features"]:
@@ -148,21 +149,13 @@ class IXBRLViewerBuilder:
         if langCode not in self.taxonomyData["languages"]:
             self.taxonomyData["languages"][langCode] = self.makeLanguageName(langCode)
 
-    @property
-    def currentSourceReportData(self):
-        return self.taxonomyData["sourceReports"][-1]
-
-    @property
-    def currentReportData(self):
-        return self.currentSourceReportData["targetReports"][-1]
-            
     def addELR(self, report: ModelXbrl, elr):
         prefix = self.roleMap.getPrefix(elr)
-        if self.currentReportData.setdefault("roleDefs",{}).get(prefix, None) is None:
+        if self.currentTargetReport.setdefault("roleDefs",{}).get(prefix, None) is None:
             rts = report.roleTypes.get(elr, [])
             label = next((rt.definition for rt in rts if rt.definition is not None), None)
             if label is not None:
-                self.currentReportData["roleDefs"].setdefault(prefix,{})["en"] = label
+                self.currentTargetReport["roleDefs"].setdefault(prefix,{})["en"] = label
 
     def addConcept(self, report: ModelXbrl, concept, dimensionType = None):
         if concept is None:
@@ -170,7 +163,7 @@ class IXBRLViewerBuilder:
         labelsRelationshipSet = report.relationshipSet(XbrlConst.conceptLabel)
         labels = labelsRelationshipSet.fromModelObject(concept)
         conceptName = self.nsmap.qname(concept.qname)
-        if conceptName not in self.currentReportData["concepts"]:
+        if conceptName not in self.currentTargetReport["concepts"]:
             conceptData = {
                 "labels": {  }
             }
@@ -205,7 +198,7 @@ class IXBRLViewerBuilder:
                     conceptData['td'] = typedDomainName
                     self.addConcept(report, typedDomainElement)
 
-            self.currentReportData["concepts"][conceptName] = conceptData
+            self.currentTargetReport["concepts"][conceptName] = conceptData
 
     def treeWalk(self, rels, item, indent = 0):
         for r in rels.fromModelObject(item):
@@ -324,7 +317,7 @@ class IXBRLViewerBuilder:
                 if frel.toModelObject is not None:
                     factData.setdefault("fn", []).append(frel.toModelObject.id)
 
-        self.currentReportData["facts"][f.id] = factData
+        self.currentTargetReport["facts"][f.id] = factData
         self.addConcept(report, f.concept)
 
     def oimUnitString(self, unit):
@@ -348,10 +341,11 @@ class IXBRLViewerBuilder:
                 return "{}/{}".format(numeratorsString, denominatorsString)
         return numeratorsString
 
-    def addViewerToXMLDocument(self, xmlDocument, scriptUrl):
+    def addViewerData(self, viewerFile, scriptUrl):
+        viewerFile.xmlDocument = deepcopy(viewerFile.xmlDocument)
         taxonomyDataJSON = self.escapeJSONForScriptTag(json.dumps(self.taxonomyData, indent=1, allow_nan=False))
 
-        for child in xmlDocument.getroot():
+        for child in viewerFile.xmlDocument.getroot():
             if child.tag == '{http://www.w3.org/1999/xhtml}body':
                 for body_child in child:
                     if body_child.tag == '{http://www.w3.org/1999/xhtml}script' and body_child.get('type','') == 'application/x.ixbrl-viewer+json':
@@ -383,15 +377,18 @@ class IXBRLViewerBuilder:
         with open(os.path.join(os.path.dirname(__file__),"stubviewer.html")) as fin:
             return etree.parse(fin)
 
-    def addReport(self):
-        self.taxonomyData["sourceReports"].append({
-            "targetReports": [
-                {
-                    "concepts": {},
-                    "facts": {},
-                }
-            ]
-        })
+    def newTargetReport(self):
+        return {
+            "concepts": {},
+            "facts": {},
+        }
+
+    def addSourceReport(self):
+        sourceReport = {
+            "targetReports": []
+        }
+        self.taxonomyData["sourceReports"].append(sourceReport)
+        return sourceReport
 
     def createViewer(self, scriptUrl: str = DEFAULT_VIEWER_PATH, useStubViewer: bool = False, showValidations: bool = True, packageDownloadURL: str = None) -> Optional[iXBRLViewer]:
         """
@@ -411,59 +408,56 @@ class IXBRLViewerBuilder:
         self.roleMap.getPrefix(XbrlConst.dimensionDefault, "d-d")
         self.roleMap.getPrefix(WIDER_NARROWER_ARCROLE, "w-n")
 
-        # This is the document that we will embed the JSON taxonomy data in.
-        # This will be either the first document processed, or the stub document
-        xmlDocument = None
+        sourceReportsByFiles = dict()
+
+        if useStubViewer:
+            iv.addFile(iXBRLViewerFile(DEFAULT_OUTPUT_NAME, self.getStubDocument()))
 
         for n, report in enumerate(self.reports):
             self.footnoteRelationshipSet = ModelRelationshipSet(report, "XBRL-footnotes")
-            self.addReport()
+            self.currentTargetReport = self.newTargetReport()
             for f in report.facts:
                 self.addFact(report, f)
-            self.currentReportData["rels"] = self.getRelationships(report)
+            self.currentTargetReport["rels"] = self.getRelationships(report)
 
             docSetFiles = None
             report.info("viewer:info", "Creating iXBRL viewer (%d of %d)" % (n+1, len(self.reports)))
             if report.modelDocument.type == Type.INLINEXBRLDOCUMENTSET:
                 # Sort by object index to preserve order in which files were specified.
                 xmlDocsByFilename = {
-                    os.path.basename(self.outputFilename(doc.filepath)): deepcopy(doc.xmlDocument)
+                    os.path.basename(self.outputFilename(doc.filepath)): doc.xmlDocument
                     for doc in sorted(report.modelDocument.referencesDocument.keys(), key=lambda x: x.objectIndex)
                     if doc.type == Type.INLINEXBRL
                 }
                 docSetFiles = list(xmlDocsByFilename.keys())
 
-                if xmlDocument is None:
-                    if useStubViewer:
-                        xmlDocument = self.getStubDocument()
-                        iv.addFile(iXBRLViewerFile(DEFAULT_OUTPUT_NAME, xmlDocument))
-                    else:
-                        xmlDocument = next(iter(xmlDocsByFilename.values()))
-
                 for filename, docSetXMLDoc in xmlDocsByFilename.items():
                     iv.addFile(iXBRLViewerFile(filename, docSetXMLDoc))
 
             elif useStubViewer:
-                if xmlDocument is None:
-                    xmlDocument = self.getStubDocument()
-                    iv.addFile(iXBRLViewerFile(DEFAULT_OUTPUT_NAME, xmlDocument))
                 filename = self.outputFilename(os.path.basename(report.modelDocument.filepath))
                 docSetFiles = [ filename ]
                 iv.addFile(iXBRLViewerFile(filename, report.modelDocument.xmlDocument))
 
             else:
+                srcFilename = self.outputFilename(os.path.basename(report.modelDocument.filepath))
+                docSetFiles = [ srcFilename ]
                 if len(self.reports) == 1:
                     # If there is only a single report, call the output file "xbrlviewer.html"
                     filename = "xbrlviewer.html"
                 else:
                     # Otherwise, preserve filenames
-                    filename = self.outputFilename(os.path.basename(report.modelDocument.filepath))
-                    docSetFiles = [ filename ]
-                if xmlDocument is None:
-                    xmlDocument = deepcopy(report.modelDocument.xmlDocument)
-                    iv.addFile(iXBRLViewerFile(filename, xmlDocument))
-                else:
-                    iv.addFile(iXBRLViewerFile(filename, report.modelDocument.xmlDocument))
+                    filename = srcFilename
+                iv.addFile(iXBRLViewerFile(filename, report.modelDocument.xmlDocument))
+
+            docSetKey = frozenset(docSetFiles)
+            sourceReport = sourceReportsByFiles.get(docSetKey)
+            if sourceReport is None:
+                sourceReport = self.addSourceReport()
+                sourceReportsByFiles[docSetKey] = sourceReport
+                sourceReport["docSetFiles"] = list(urllib.parse.quote(f) for f in docSetFiles)
+
+            sourceReport["targetReports"].append(self.currentTargetReport)
 
             localDocs = defaultdict(set)
             for path, doc in report.urlDocs.items():
@@ -482,14 +476,11 @@ class IXBRLViewerBuilder:
                             linkbaseIdentifed = True
                     if not linkbaseIdentifed:
                         localDocs[doc.basename].add(UNRECOGNIZED_LINKBASE_LOCAL_DOCUMENTS_TYPE)
-            self.currentReportData["localDocs"] = {
+            self.currentTargetReport["localDocs"] = {
                 localDoc: sorted(docTypes)
                 for localDoc, docTypes in localDocs.items()
             }
 
-            if docSetFiles is not None:
-                self.currentSourceReportData["docSetFiles"] = list(urllib.parse.quote(f) for f in docSetFiles)
-
         self.taxonomyData["prefixes"] = self.nsmap.prefixmap
         self.taxonomyData["roles"] = self.roleMap.prefixmap
 
@@ -504,7 +495,7 @@ class IXBRLViewerBuilder:
             iv.addFilingDoc(filingDocZipPath)
             self.taxonomyData["filingDocuments"] = filingDocZipName
 
-        if not self.addViewerToXMLDocument(xmlDocument, scriptUrl):
+        if not self.addViewerData(iv.files[0], scriptUrl):
             return None
 
         return iv
@@ -524,9 +515,13 @@ class iXBRLViewer:
         self.filingDocuments = None
         # This is an arbitrary ModelXbrl used for logging only
         self.logger_model = logger_model
+        self.filenames = set()
 
     def addFile(self, ivf):
+        if ivf.filename in self.filenames:
+            return
         self.files.append(ivf)
+        self.filenames.add(ivf.filename)
 
     def addFilingDoc(self, filingDocuments):
         self.filingDocuments = filingDocuments