ixbrl-viewer 1.4.21__tar.gz → 1.4.50__tar.gz

ixbrl_viewer-1.4.50/.babelrc

@@ -0,0 +1,7 @@
+{
+  "env": {
+    "test": {
+      "plugins": ["@babel/plugin-transform-modules-commonjs"]
+    }
+  }
+}

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/.github/dependabot.yml

@@ -8,6 +8,10 @@ updates:
       github-action-dependencies:
         patterns:
           - "*"
+    ignore:
+      - dependency-name: "softprops/action-gh-release"
+        versions:
+          - "2.2.0"
   - package-ecosystem: npm
     directory: "/"
     schedule:
@@ -28,24 +32,9 @@ updates:
         patterns:
           - "stylelint*"
     ignore:
-      - dependency-name: chart.js
-        versions:
-          - ">=3"
-      - dependency-name: css-loader
-        versions:
-          - ">=4"
-      - dependency-name: html-loader
-        versions:
-          - ">=1"
-      - dependency-name: i18next
-        versions:
-          - ">=21"
-      - dependency-name: less
-        versions:
-          - ">=4"
-      - dependency-name: less-loader
+      - dependency-name: "puppeteer-screen-recorder"
         versions:
-          - ">=7"
+          - "3.0.6"
   - package-ecosystem: pip
     directory: "/"
     insecure-external-code-execution: allow

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/.github/workflows/node-tests.yml

@@ -15,17 +15,17 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          - macos-12
-          - ubuntu-22.04
+          - macos-14
+          - ubuntu-24.04
           - windows-2022
         node-version:
           - '18'
           - '20'
-          - '21'
+          - '22'
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4.1.1
-      - uses: actions/setup-node@v4.0.2
+      - uses: actions/checkout@v4.2.2
+      - uses: actions/setup-node@v4.1.0
         with:
           cache: 'npm'
           check-latest: true

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/.github/workflows/npm-package.yml

@@ -4,14 +4,14 @@ on:
   workflow_call:
     inputs:
       node_version:
-        default: '20'
+        default: '22'
         description: 'Node version to use'
         required: false
         type: string
   workflow_dispatch:
     inputs:
       node_version:
-        default: '20'
+        default: '22'
         description: 'Node version to use'
         required: true
         type: string
@@ -20,14 +20,14 @@ permissions: {}
 
 jobs:
   build-package:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout ixbrl-viewer
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.2.2
         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.1.0
         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.1
+        uses: actions/upload-artifact@v4.6.0
         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.1
+        uses: actions/upload-artifact@v4.6.0
         with:
           name: npm package
           if-no-files-found: error
@@ -59,21 +59,21 @@ jobs:
     environment: release
     permissions:
       contents: write
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     if: startsWith(github.ref, 'refs/tags')
     steps:
       - name: Install Node.js
-        uses: actions/setup-node@v4.0.2
+        uses: actions/setup-node@v4.1.0
         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.4
+        uses: actions/download-artifact@v4.1.8
         with:
           name: ixbrlviewer.js
       - name: Download npm artifact
-        uses: actions/download-artifact@v4.1.4
+        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.2
+        uses: softprops/action-gh-release@v2.2.1
         with:
           fail_on_unmatched_files: true
           files: './*'

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/.github/workflows/puppeteer.yml

@@ -14,27 +14,27 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          - macos-12
-          - ubuntu-22.04
+          - macos-14
+          - ubuntu-24.04
           - windows-2022
         node-version:
           - '18'
           - '20'
-          - '21'
+          - '22'
         python-version:
           - '3.12'
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.2.2
         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.1.0
         with:
           cache: 'npm'
           check-latest: true
           node-version: ${{ matrix.node-version }}
       - name: Install Python 3
-        uses: actions/setup-python@v5.0.0
+        uses: actions/setup-python@v5.3.0
         with:
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
@@ -42,6 +42,15 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies
         run: npm ci
+      - name: Setup Chromium Sandbox
+        if: runner.os == 'Linux'
+        shell: bash
+        run: |
+          cd ~/.cache/puppeteer/chrome/linux-*/chrome-linux64
+          sudo chown root:root chrome_sandbox
+          sudo chmod 4755 chrome_sandbox
+          sudo cp -p chrome_sandbox /usr/local/sbin/chrome-devel-sandbox
+          echo "CHROME_DEVEL_SANDBOX=/usr/local/sbin/chrome-devel-sandbox" >> $GITHUB_ENV
       - name: Install Arelle
         run: pip install .[arelle]
       - name: Build viewer js
@@ -54,7 +63,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.1
+      - uses: actions/upload-artifact@v4.6.0
         if: failure()
         with:
           name: ${{ github.run_id }}.${{ github.run_attempt }}_${{ matrix.os }}_${{ matrix.node-version }}_${{ matrix.python-version }}_artifacts

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/.github/workflows/python-package.yml

@@ -4,7 +4,7 @@ on:
   workflow_call:
     inputs:
       node_version:
-        default: '20'
+        default: '22'
         description: 'Node version to use'
         required: false
         type: string
@@ -16,7 +16,7 @@ on:
   workflow_dispatch:
     inputs:
       node_version:
-        default: '20'
+        default: '22'
         description: 'Node version to use'
         required: true
         type: string
@@ -30,14 +30,14 @@ permissions: {}
 
 jobs:
   build-package:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout ixbrl-viewer
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.2.2
         with:
           fetch-depth: 0
       - name: Install Node.js
-        uses: actions/setup-node@v4.0.2
+        uses: actions/setup-node@v4.1.0
         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.0.0
+        uses: actions/setup-python@v5.3.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@v4.3.1
+        uses: actions/upload-artifact@v4.6.0
         with:
           name: source distribution
           if-no-files-found: error
           path: dist/*.tar.gz
       - name: Upload wheel artifact
-        uses: actions/upload-artifact@v4.3.1
+        uses: actions/upload-artifact@v4.6.0
         with:
           name: wheel
           if-no-files-found: error
@@ -77,17 +77,15 @@ jobs:
     environment: release
     permissions:
       contents: write
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     if: startsWith(github.ref, 'refs/tags')
     steps:
-      - name: Install twine
-        run: pip install -U twine
       - name: Download source distribution artifact
-        uses: actions/download-artifact@v4.1.4
+        uses: actions/download-artifact@v4.1.8
         with:
           name: source distribution
       - name: Download wheel artifact
-        uses: actions/download-artifact@v4.1.4
+        uses: actions/download-artifact@v4.1.8
         with:
           name: wheel
       - name: Publish package on release
@@ -95,9 +93,9 @@ jobs:
           TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
           TWINE_REPOSITORY: ${{ github.repository == 'Arelle/ixbrl-viewer' && 'pypi' || 'testpypi' }}
-        run: twine upload ./*
+        run: pipx run twine upload ./*
       - name: Upload release artifacts
-        uses: softprops/action-gh-release@v2.0.2
+        uses: softprops/action-gh-release@v2.2.1
         with:
           fail_on_unmatched_files: true
           files: './*'

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/.github/workflows/python-tests.yml

@@ -15,20 +15,19 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          - macos-12
-          - ubuntu-22.04
+          - macos-14
+          - ubuntu-24.04
           - windows-2022
         python-version:
-          - '3.8'
           - '3.9'
           - '3.10'
           - '3.11'
           - '3.12'
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.2.2
       - name: Install Python 3
-        uses: actions/setup-python@v5.0.0
+        uses: actions/setup-python@v5.3.0
         with:
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/.github/workflows/release-drafter.yml

@@ -9,7 +9,7 @@ permissions: {}
 
 jobs:
   update_release_draft:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     permissions:
       contents: write
       pull-requests: read

ixbrl_viewer-1.4.50/.npmignore

@@ -0,0 +1,15 @@
+.idea
+.mypy_cache
+.pytest_cache
+.tox
+.vscode
+/ixbrl-viewer*.tgz
+/tests/puppeteer/artifacts/
+Pipfile*
+__pycache__
+build
+iXBRLViewerPlugin/_version.py
+iXBRLViewerPlugin/viewer/src/fonts/
+iXBRLViewerPlugin/viewer/src/less/generated/
+ixbrl_viewer.egg-info
+node_modules/

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/Makefile

@@ -17,9 +17,9 @@ all: dev
 samples: Arelle
 	$(MAKE) -C $@
 
-dev: iXBRLViewerPlugin/viewer/dist/ixbrl_viewer.dev.js
+dev: iXBRLViewerPlugin/viewer/dist/ixbrlviewer.dev.js
 
-prod: iXBRLViewerPlugin/viewer/dist/ixbrl_viewer.js
+prod: iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js
 
 font: iXBRLViewerPlugin/viewer/src/less/generated/icons.less
 
@@ -28,10 +28,10 @@ FONT_FILES := iXBRLViewerPlugin/viewer/src/icons/*.svg iXBRLViewerPlugin/viewer/
 iXBRLViewerPlugin/viewer/src/less/generated/icons.less:	$(FONT_FILES)
 	npm run font
 
-iXBRLViewerPlugin/viewer/dist/ixbrl_viewer.dev.js:	iXBRLViewerPlugin/viewer/src/*/* iXBRLViewerPlugin/viewer/src/less/generated/icons.less
+iXBRLViewerPlugin/viewer/dist/ixbrlviewer.dev.js:	iXBRLViewerPlugin/viewer/src/*/* iXBRLViewerPlugin/viewer/src/less/generated/icons.less
 	npm run dev
 
-iXBRLViewerPlugin/viewer/dist/ixbrl_viewer.js:	iXBRLViewerPlugin/viewer/src/*/* iXBRLViewerPlugin/viewer/src/less/generated/icons.less
+iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js:	iXBRLViewerPlugin/viewer/src/*/* iXBRLViewerPlugin/viewer/src/less/generated/icons.less
 	npm run prod
 
 test: testplugin testviewer
@@ -53,5 +53,5 @@ dist: prod
 	mkdir -p $(DIST)
 	cp -r iXBRLViewerPlugin js/dist/ixbrlviewer.js $(DIST)
 	zip -r $(DIST).zip $(DIST) -x \*/__pycache__/\* \*/.\*
-	
+
 .PHONY: samples

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: ixbrl-viewer
-Version: 1.4.21
+Version: 1.4.50
 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
@@ -19,14 +19,13 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Text Processing :: Markup :: XML
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
@@ -34,11 +33,11 @@ Requires-Dist: lxml<6,>=4
 Provides-Extra: arelle
 Requires-Dist: arelle_release==2.*; extra == "arelle"
 Provides-Extra: dev
-Requires-Dist: flake8==7.0.0; extra == "dev"
+Requires-Dist: flake8==7.1.1; extra == "dev"
 Requires-Dist: lxml-stubs==0.5.1; extra == "dev"
-Requires-Dist: mypy==1.9.0; extra == "dev"
-Requires-Dist: pytest==8.1.1; extra == "dev"
-Requires-Dist: typing-extensions==4.10.0; extra == "dev"
+Requires-Dist: mypy==1.14.1; extra == "dev"
+Requires-Dist: pytest==8.3.4; extra == "dev"
+Requires-Dist: typing-extensions==4.12.2; extra == "dev"
 
 # Arelle iXBRL Viewer
 
@@ -297,6 +296,34 @@ This mode replaces the namespace-based highlighting with optional highlighting b
 |---------------------------|----------------|
 | `--viewer-feature-review` | `?review=true` |
 
+# Runtime config
+
+When launched, the viewer will check for the existence of
+`ixbrlviewer.config.json` in the same directory as `ixbrlviewer.js`.  If found,
+this will be loaded and used to configure the viewer.
+
+The file supports the following keys:
+
+* `features` - a JSON object containing defaults for features. These will be
+overridden by features defined at generation time, and then by query
+parameters, as defined above.
+
+* `skin` - a JSON object supporting the following keys:
+
+    * `stylesheetUrl` - a URL to additional CSS definitions.
+    * `faviconUrl` - a URL to an icon file to be used as the favicon for the viewer.
+    * `footerLogoHtml` - a fragment of HTML that will be included in place of the standard footer logo.
+
+* `taxonomyNames` - a JSON object where:
+
+    * Keys are strings that will be treated as a regular expression to match
+      against a namespace.
+    * Values are an array of (prefix, name) where "prefix" is the preferred
+      namespace prefix for the namespace, and "name" is a short descriptive
+      name for the taxonomy.
+
+Relative URLs defined in the config file are resolved relative to the config file.
+
 # Disable viewer loading
 
 Loading of the viewer can be disabled by specifying `?disable-viewer` as a
@@ -304,9 +331,9 @@ query parameter.  This will leave the iXBRL document loaded in the browser, but
 without any viewer functionality.  In the case of an iXBRL document set, or
 multi-document viewer, the first document will be shown.
 
-## Running tests
+# Running tests
 
-### Running unit tests
+## Running unit tests
 
 In order to run the javascript unit tests make sure that you have installed all of the npm requirements.
 
@@ -316,7 +343,7 @@ In order to run the python unit tests make sure that you have pip installed requ
 
 Run the following command to run python unit tests: `pytest tests/unit_tests`
 
-### Running Puppeteer tests
+## Running Puppeteer tests
 
 All commands should be run from repository root
 

{ixbrl-viewer-1.4.21 → ixbrl_viewer-1.4.50}/README.md

@@ -255,6 +255,34 @@ This mode replaces the namespace-based highlighting with optional highlighting b
 |---------------------------|----------------|
 | `--viewer-feature-review` | `?review=true` |
 
+# Runtime config
+
+When launched, the viewer will check for the existence of
+`ixbrlviewer.config.json` in the same directory as `ixbrlviewer.js`.  If found,
+this will be loaded and used to configure the viewer.
+
+The file supports the following keys:
+
+* `features` - a JSON object containing defaults for features. These will be
+overridden by features defined at generation time, and then by query
+parameters, as defined above.
+
+* `skin` - a JSON object supporting the following keys:
+
+    * `stylesheetUrl` - a URL to additional CSS definitions.
+    * `faviconUrl` - a URL to an icon file to be used as the favicon for the viewer.
+    * `footerLogoHtml` - a fragment of HTML that will be included in place of the standard footer logo.
+
+* `taxonomyNames` - a JSON object where:
+
+    * Keys are strings that will be treated as a regular expression to match
+      against a namespace.
+    * Values are an array of (prefix, name) where "prefix" is the preferred
+      namespace prefix for the namespace, and "name" is a short descriptive
+      name for the taxonomy.
+
+Relative URLs defined in the config file are resolved relative to the config file.
+
 # Disable viewer loading
 
 Loading of the viewer can be disabled by specifying `?disable-viewer` as a
@@ -262,9 +290,9 @@ query parameter.  This will leave the iXBRL document loaded in the browser, but
 without any viewer functionality.  In the case of an iXBRL document set, or
 multi-document viewer, the first document will be shown.
 
-## Running tests
+# Running tests
 
-### Running unit tests
+## Running unit tests
 
 In order to run the javascript unit tests make sure that you have installed all of the npm requirements.
 
@@ -274,7 +302,7 @@ In order to run the python unit tests make sure that you have pip installed requ
 
 Run the following command to run python unit tests: `pytest tests/unit_tests`
 
-### Running Puppeteer tests
+## Running Puppeteer tests
 
 All commands should be run from repository root
 

ixbrl_viewer-1.4.50/docs/sample-config.json

@@ -0,0 +1,23 @@
+{
+    "skin": {
+        "stylesheetUrl": "./myskin.css",
+        "footerLogoHtml": "<b>Footer override</b>"
+    },
+    "features": {
+        "support_link": "https://www.example.com/getSupport",
+        "survey_link": "http://www.example.com/survey"
+    },
+    "taxonomyNames": {
+        "http://xbrl\\.frc\\.org\\.uk/cd/(\\d{4})-\\d{2}-\\d{2}/business": ["uk-bus", "UK Business"],
+        "http://xbrl\\.frc\\.org\\.uk/fr/(\\d{4})-\\d{2}-\\d{2}/core": ["uk-core", "UK Core"],
+        "http://xbrl\\.frc\\.org\\.uk/general/(\\d{4})-\\d{2}-\\d{2}/types": ["uk-types", "UK Types"],
+        "http://xbrl\\.frc\\.org\\.uk/reports/(\\d{4})-\\d{2}-\\d{2}/direp": ["uk-direp", "UK Directors' Report"],
+        "http://xbrl\\.frc\\.org\\.uk/reports/(\\d{4})-\\d{2}-\\d{2}/accrep": ["uk-accrep", "UK Accountant's Report"],
+        "http://xbrl\\.frc\\.org\\.uk/reports/(\\d{4})-\\d{2}-\\d{2}/aurep": ["uk-aurep", "UK Auditor's Report"],
+        "http://xbrl\\.frc\\.org\\.uk/cd/(\\d{4})-\\d{2}-\\d{2}/countries": ["uk-countries", "UK Countries"],
+        "http://xbrl\\.frc\\.org\\.uk/cd/(\\d{4})-\\d{2}-\\d{2}/currencies": ["uk-curr", "UK Currencies"],
+        "http://xbrl\\.frc\\.org\\.uk/cd/(\\d{4})-\\d{2}-\\d{2}/languages": ["uk-lang", "UK Languages"],
+        "http://xbrl\\.frc\\.org\\.uk/dpl/(\\d{4})-\\d{2}-\\d{2}": ["uk-dpl", "UK Detailed Profit & Loss"],
+        "http://xbrl\\.frc\\.org\\.uk/general/(\\d{4})-\\d{2}-\\d{2}/common": ["uk-common", "UK Common"]
+    }
+}