ixbrl-viewer 1.4.29__tar.gz → 1.4.31__tar.gz

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/.github/dependabot.yml

@@ -27,6 +27,10 @@ updates:
       stylelint:
         patterns:
           - "stylelint*"
+    ignore:
+      - dependency-name: "puppeteer-screen-recorder"
+        versions:
+          - "3.0.5"
   - package-ecosystem: pip
     directory: "/"
     insecure-external-code-execution: allow

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/.github/workflows/node-tests.yml

@@ -25,7 +25,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4.1.7
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/setup-node@v4.0.3
         with:
           cache: 'npm'
           check-latest: true

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/.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.2
+        uses: actions/setup-node@v4.0.3
         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@v4.3.3
+        uses: actions/upload-artifact@v4.3.6
         with:
           name: ixbrlviewer.js
           if-no-files-found: error
           path: iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js
       - name: Upload npm artifact
-        uses: actions/upload-artifact@v4.3.3
+        uses: actions/upload-artifact@v4.3.6
         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.2
+        uses: actions/setup-node@v4.0.3
         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@v4.1.7
+        uses: actions/download-artifact@v4.1.8
         with:
           name: ixbrlviewer.js
       - name: Download npm artifact
-        uses: actions/download-artifact@v4.1.7
+        uses: actions/download-artifact@v4.1.8
         with:
           name: npm package
       - name: Publish with npm
@@ -83,7 +83,7 @@ jobs:
           NPM_CONFIG_DRY_RUN: ${{ github.repository != 'Arelle/ixbrl-viewer' }}
         run: npm publish ixbrl-viewer-*.tgz --access public
       - name: Upload release artifacts
-        uses: softprops/action-gh-release@v2.0.6
+        uses: softprops/action-gh-release@v2.0.8
         with:
           fail_on_unmatched_files: true
           files: './*'

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/.github/workflows/puppeteer.yml

@@ -28,13 +28,13 @@ jobs:
       - uses: actions/checkout@v4.1.7
         with:
           fetch-depth: 0 # npm run prod requires tags, sadly this is the only way to get them.
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/setup-node@v4.0.3
         with:
           cache: 'npm'
           check-latest: true
           node-version: ${{ matrix.node-version }}
       - name: Install Python 3
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.1.1
         with:
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
@@ -54,7 +54,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@v4.3.3
+      - uses: actions/upload-artifact@v4.3.6
         if: failure()
         with:
           name: ${{ github.run_id }}.${{ github.run_attempt }}_${{ matrix.os }}_${{ matrix.node-version }}_${{ matrix.python-version }}_artifacts

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/.github/workflows/python-package.yml

@@ -37,7 +37,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Install Node.js
-        uses: actions/setup-node@v4.0.2
+        uses: actions/setup-node@v4.0.3
         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@v5.1.0
+        uses: actions/setup-python@v5.1.1
         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@v4.3.3
+        uses: actions/upload-artifact@v4.3.6
         with:
           name: source distribution
           if-no-files-found: error
           path: dist/*.tar.gz
       - name: Upload wheel artifact
-        uses: actions/upload-artifact@v4.3.3
+        uses: actions/upload-artifact@v4.3.6
         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@v4.1.7
+        uses: actions/download-artifact@v4.1.8
         with:
           name: source distribution
       - name: Download wheel artifact
-        uses: actions/download-artifact@v4.1.7
+        uses: actions/download-artifact@v4.1.8
         with:
           name: wheel
       - name: Publish package on release
@@ -97,7 +97,7 @@ jobs:
           TWINE_REPOSITORY: ${{ github.repository == 'Arelle/ixbrl-viewer' && 'pypi' || 'testpypi' }}
         run: twine upload ./*
       - name: Upload release artifacts
-        uses: softprops/action-gh-release@v2.0.6
+        uses: softprops/action-gh-release@v2.0.8
         with:
           fail_on_unmatched_files: true
           files: './*'

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/.github/workflows/python-tests.yml

@@ -28,7 +28,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4.1.7
       - name: Install Python 3
-        uses: actions/setup-python@v5.1.0
+        uses: actions/setup-python@v5.1.1
         with:
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'

{ixbrl_viewer-1.4.29/ixbrl_viewer.egg-info → ixbrl_viewer-1.4.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ixbrl-viewer
-Version: 1.4.29
+Version: 1.4.31
 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
@@ -34,10 +34,10 @@ Requires-Dist: lxml<6,>=4
 Provides-Extra: arelle
 Requires-Dist: arelle_release==2.*; extra == "arelle"
 Provides-Extra: dev
-Requires-Dist: flake8==7.1.0; extra == "dev"
+Requires-Dist: flake8==7.1.1; extra == "dev"
 Requires-Dist: lxml-stubs==0.5.1; extra == "dev"
-Requires-Dist: mypy==1.10.1; extra == "dev"
-Requires-Dist: pytest==8.2.2; extra == "dev"
+Requires-Dist: mypy==1.11.2; extra == "dev"
+Requires-Dist: pytest==8.3.2; extra == "dev"
 Requires-Dist: typing-extensions==4.12.2; extra == "dev"
 
 # Arelle iXBRL Viewer

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/iXBRLViewerPlugin/__init__.py

@@ -21,7 +21,10 @@ from .constants import CONFIG_COPY_SCRIPT, CONFIG_FEATURE_PREFIX, CONFIG_LAUNCH_
     CONFIG_SCRIPT_URL, DEFAULT_COPY_SCRIPT, DEFAULT_LAUNCH_ON_LOAD, DEFAULT_OUTPUT_NAME, \
     DEFAULT_JS_FILENAME, DEFAULT_VIEWER_PATH, ERROR_MESSAGE_CODE, \
     EXCEPTION_MESSAGE_CODE, FEATURE_CONFIGS
-from .iXBRLViewer import IXBRLViewerBuilder, IXBRLViewerBuilderError
+from .iXBRLViewer import IXBRLViewerBuilder, IXBRLViewerBuilderError, isInlineDoc
+from .plugin import IXBRLViewerPluginData
+
+PLUGIN_NAME = 'ixbrl-viewer'
 
 #
 # GUI operation:
@@ -94,10 +97,6 @@ def iXBRLViewerCommandLineOptionExtender(parser, *args, **kwargs):
                       dest="zipViewerOutput",
                       help="Converts the viewer output into a self contained zip")
 
-    # Force "keepOpen" to true, so that all models are retained.  Needed for
-    # multi-instance viewers.
-    parser.set_defaults(keepOpen = True)
-
     featureGroup = OptionGroup(parser, "Viewer Features",
                             "See viewer README for information on enabling/disabling features.")
     for featureConfig in FEATURE_CONFIGS:
@@ -105,13 +104,31 @@ def iXBRLViewerCommandLineOptionExtender(parser, *args, **kwargs):
         featureGroup.add_option(arg, arg.lower(), action="store_true", default=False, help=featureConfig.description)
     parser.add_option_group(featureGroup)
 
+def pluginData(cntlr: Cntlr):
+    pluginData = cntlr.getPluginData(PLUGIN_NAME)
+    if pluginData is None:
+        pluginData = IXBRLViewerPluginData(PLUGIN_NAME)
+        cntlr.setPluginData(pluginData)
+    return pluginData
+
+def resetPluginData(cntlr: Cntlr):
+    pluginData(cntlr).builder = None
+
+def processModel(cntlr: Cntlr, modelXbrl: ModelXbrl):
+    try:
+        if isInlineDoc(modelXbrl.modelDocument):
+            pluginData(cntlr).builder.processModel(modelXbrl)
+    except IXBRLViewerBuilderError as ex:
+        print(ex)
+    except Exception as ex:
+        tb = traceback.format_tb(sys.exc_info()[2])
+        cntlr.addToLog(f"Exception {ex} \nTraceback {tb}", messageCode=EXCEPTION_MESSAGE_CODE)
 
 def generateViewer(
         cntlr: Cntlr,
         saveViewerDest: io.BytesIO | str | None,
         viewerURL: str | None = None,
         showValidationMessages: bool = False,
-        useStubViewer: bool = False,
         zipViewerOutput: bool = False,
         features: list[str] | None = None,
         packageDownloadURL: str | None = None,
@@ -138,13 +155,10 @@ def generateViewer(
 
     viewerURL = viewerURL or DEFAULT_VIEWER_PATH
 
-    if (cntlr.modelManager is None
-        or len(cntlr.modelManager.loadedModelXbrls) == 0
-        or any(not mx.modelDocument for mx in cntlr.modelManager.loadedModelXbrls)):
-        cntlr.addToLog(f"No taxonomy loaded. {abortGenerationMsg}", messageCode=ERROR_MESSAGE_CODE)
-        return
-    if cntlr.modelManager.modelXbrl.modelDocument.type not in (Type.INLINEXBRL, Type.INLINEXBRLDOCUMENTSET):
-        cntlr.addToLog(f"No inline XBRL document loaded. {abortGenerationMsg}", messageCode=ERROR_MESSAGE_CODE)
+    bldr = pluginData(cntlr).builder
+
+    if bldr.reportCount == 0:
+        cntlr.addToLog(f"No inline XBRL documents loaded. {abortGenerationMsg}", messageCode=ERROR_MESSAGE_CODE)
         return
 
     copyScriptPath = None
@@ -171,11 +185,10 @@ def generateViewer(
             return
 
     try:
-        viewerBuilder = IXBRLViewerBuilder(cntlr.modelManager.loadedModelXbrls)
         if features:
             for feature in features:
-                viewerBuilder.enableFeature(feature)
-        iv = viewerBuilder.createViewer(scriptUrl=viewerURL, showValidations=showValidationMessages, useStubViewer=useStubViewer, packageDownloadURL=packageDownloadURL)
+                bldr.enableFeature(feature)
+        iv = bldr.createViewer(scriptUrl=viewerURL, showValidations=showValidationMessages, packageDownloadURL=packageDownloadURL)
         if iv is not None:
             iv.save(saveViewerDest, zipOutput=zipViewerOutput, copyScriptPath=copyScriptPath)
     except IXBRLViewerBuilderError as ex:
@@ -183,6 +196,7 @@ def generateViewer(
     except Exception as ex:
         tb = traceback.format_tb(sys.exc_info()[2])
         cntlr.addToLog(f"Exception {ex} \nTraceback {tb}", messageCode=EXCEPTION_MESSAGE_CODE)
+    resetPluginData(cntlr)
 
 
 def getFeaturesFromOptions(options: argparse.Namespace | OptionParser):
@@ -192,15 +206,19 @@ def getFeaturesFromOptions(options: argparse.Namespace | OptionParser):
         if getattr(options, f'viewer_feature_{featureConfig.key}') or getattr(options, f'viewer_feature_{featureConfig.key.lower()}')
     ]
 
+def iXBRLViewerCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs):
+    pd = pluginData(cntlr)
+    if pd.builder is None:
+        pd.builder = IXBRLViewerBuilder(cntlr, useStubViewer = options.useStubViewer)
+    processModel(cntlr, modelXbrl)
 
-def iXBRLViewerCommandLineXbrlRun(cntlr, options, *args, **kwargs):
+def iXBRLViewerCommandLineFilingEnd(cntlr, options, *args, **kwargs):
     generateViewer(
         cntlr=cntlr,
         saveViewerDest=options.saveViewerDest or kwargs.get("responseZipStream"),
         viewerURL=options.viewerURL,
         copyScript=not options.viewerNoCopyScript,
         showValidationMessages=options.validationMessages,
-        useStubViewer=options.useStubViewer,
         zipViewerOutput=options.zipViewerOutput,
         features=getFeaturesFromOptions(options),
         packageDownloadURL=options.packageDownloadURL,
@@ -259,9 +277,11 @@ def commandLineOptionExtender(*args, **kwargs):
     iXBRLViewerCommandLineOptionExtender(*args, **kwargs)
 
 
-def commandLineRun(*args, **kwargs):
-    iXBRLViewerCommandLineXbrlRun(*args, **kwargs)
+def commandLineRun(cntlr, options, modelXbrl, *args, **kwargs):
+    iXBRLViewerCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs)
 
+def commandLineFilingEnd(*args, **kwargs):
+    iXBRLViewerCommandLineFilingEnd(*args, **kwargs)
 
 class iXBRLViewerLocalViewer(LocalViewer):
     # plugin-specific local file handler
@@ -300,12 +320,13 @@ def guiRun(cntlr, modelXbrl, attach, *args, **kwargs):
             for c in FEATURE_CONFIGS
             if cntlr.config.setdefault(f'{CONFIG_FEATURE_PREFIX}{c.key}', False)
         ]
+        pluginData(cntlr).builder = IXBRLViewerBuilder(cntlr, useStubViewer = True)
+        processModel(cntlr, modelXbrl)
         generateViewer(
             cntlr=cntlr,
             saveViewerDest=tempViewer.name,
             viewerURL=cntlr.config.get(CONFIG_SCRIPT_URL),
             copyScript=cntlr.config.get(CONFIG_COPY_SCRIPT, DEFAULT_COPY_SCRIPT),
-            useStubViewer=True,
             features=features,
         )
         if Path(tempViewer.name, viewer_file_name).exists():
@@ -325,7 +346,7 @@ def load_plugin_url():
 
 
 __pluginInfo__ = {
-    'name': 'ixbrl-viewer',
+    'name': PLUGIN_NAME,
     'aliases': [
         'iXBRLViewerPlugin',
     ],
@@ -335,7 +356,8 @@ __pluginInfo__ = {
     'author': 'Paul Warren',
     'copyright': 'Copyright :: Workiva Inc. :: 2019',
     'CntlrCmdLine.Options': commandLineOptionExtender,
-    'CntlrCmdLine.Filing.End': commandLineRun,
+    'CntlrCmdLine.Xbrl.Run': commandLineRun,
+    'CntlrCmdLine.Filing.End': commandLineFilingEnd,
     'CntlrWinMain.Menu.Tools': toolsMenuExtender,
     'CntlrWinMain.Xbrl.Loaded': guiRun,
 }

{ixbrl_viewer-1.4.29 → ixbrl_viewer-1.4.31}/iXBRLViewerPlugin/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.29'
-__version_tuple__ = version_tuple = (1, 4, 29)
+__version__ = version = '1.4.31'
+__version_tuple__ = version_tuple = (1, 4, 31)