ixbrl-viewer 1.4.39__tar.gz → 1.4.40__tar.gz

{ixbrl_viewer-1.4.39 → ixbrl_viewer-1.4.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ixbrl-viewer
-Version: 1.4.39
+Version: 1.4.40
 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
@@ -296,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
@@ -303,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.
 
@@ -315,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.39 → ixbrl_viewer-1.4.40}/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.40/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"]
+    }
+}

{ixbrl_viewer-1.4.39 → ixbrl_viewer-1.4.40}/iXBRLViewerPlugin/__init__.py

@@ -10,6 +10,7 @@ import tempfile
 import traceback
 from optparse import OptionGroup, OptionParser
 from pathlib import Path
+from typing import Any
 
 from arelle import Cntlr
 from arelle.LocalViewer import LocalViewer
@@ -100,8 +101,14 @@ def iXBRLViewerCommandLineOptionExtender(parser, *args, **kwargs):
     featureGroup = OptionGroup(parser, "Viewer Features",
                             "See viewer README for information on enabling/disabling features.")
     for featureConfig in FEATURE_CONFIGS:
-        arg = f'--viewer-feature-{featureConfig.key}'
-        featureGroup.add_option(arg, arg.lower(), action="store_true", default=False, help=featureConfig.description)
+        arg = f'--viewer-feature-{featureConfig.key}'.replace('_', '-')
+        featureGroup.add_option(
+            arg,
+            arg.lower(),
+            action=featureConfig.cliAction,
+            default=featureConfig.cliDefault,
+            help=featureConfig.description
+        )
     parser.add_option_group(featureGroup)
 
 def pluginData(cntlr: Cntlr):
@@ -130,7 +137,6 @@ def generateViewer(
         viewerURL: str | None = None,
         showValidationMessages: bool = False,
         zipViewerOutput: bool = False,
-        features: list[str] | None = None,
         packageDownloadURL: str | None = None,
         copyScript: bool = True,
 ) -> None:
@@ -143,7 +149,6 @@ def generateViewer(
     :param showValidationMessages: True if validation messages should be shown in the viewer.
     :param useStubViewer: True if the stub viewer should be used.
     :param zipViewerOutput: True if the destination is a zip archive.
-    :param features: Optional list of features to enable.
     :param packageDownloadURL: Optional URL to use as the report package download URL.
     :param copyScript: Controls if the script referenced by viewerURL is copied into the output directory, or directly set as the 'src' value of the script tag in the HTML iXBRL Viewer.
     """
@@ -185,9 +190,6 @@ def generateViewer(
             return
 
     try:
-        if features:
-            for feature in features:
-                bldr.enableFeature(feature)
         iv = bldr.createViewer(scriptUrl=viewerURL, showValidations=showValidationMessages, packageDownloadURL=packageDownloadURL)
         if iv is not None:
             iv.save(saveViewerDest, zipOutput=zipViewerOutput, copyScriptPath=copyScriptPath)
@@ -199,17 +201,21 @@ def generateViewer(
     resetPluginData(cntlr)
 
 
-def getFeaturesFromOptions(options: argparse.Namespace | OptionParser):
-    return [
-        featureConfig.key
-        for featureConfig in FEATURE_CONFIGS
-        if getattr(options, f'viewer_feature_{featureConfig.key}') or getattr(options, f'viewer_feature_{featureConfig.key.lower()}')
-    ]
+def getFeaturesFromOptions(options: argparse.Namespace | OptionParser) -> dict[str, Any]:
+    features = {}
+    for featureConfig in FEATURE_CONFIGS:
+        key = featureConfig.key
+        option = f'viewer_feature_{key}'
+        value = getattr(options, option, None)
+        if value is not None:
+            features[key] = value
+    return features
+
 
 def iXBRLViewerCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs):
     pd = pluginData(cntlr)
     if pd.builder is None:
-        pd.builder = IXBRLViewerBuilder(cntlr, useStubViewer = options.useStubViewer)
+        pd.builder = IXBRLViewerBuilder(cntlr, useStubViewer = options.useStubViewer, features=getFeaturesFromOptions(options))
     processModel(cntlr, modelXbrl)
 
 def iXBRLViewerCommandLineFilingEnd(cntlr, options, *args, **kwargs):
@@ -220,7 +226,6 @@ def iXBRLViewerCommandLineFilingEnd(cntlr, options, *args, **kwargs):
         copyScript=not options.viewerNoCopyScript,
         showValidationMessages=options.validationMessages,
         zipViewerOutput=options.zipViewerOutput,
-        features=getFeaturesFromOptions(options),
         packageDownloadURL=options.packageDownloadURL,
     )
 
@@ -315,19 +320,17 @@ def guiRun(cntlr, modelXbrl, attach, *args, **kwargs):
         global tempViewer
         tempViewer = tempfile.TemporaryDirectory()
         viewer_file_name = DEFAULT_OUTPUT_NAME
-        features = [
-            c.key
-            for c in FEATURE_CONFIGS
-            if cntlr.config.setdefault(f'{CONFIG_FEATURE_PREFIX}{c.key}', False)
-        ]
-        pluginData(cntlr).builder = IXBRLViewerBuilder(cntlr, useStubViewer = True)
+        features = {}
+        for featureConfig in FEATURE_CONFIGS:
+            if cntlr.config.setdefault(f'{CONFIG_FEATURE_PREFIX}{featureConfig.key}', False):
+                features[featureConfig.key] = True
+        pluginData(cntlr).builder = IXBRLViewerBuilder(cntlr, useStubViewer=True, features=features)
         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),
-            features=features,
         )
         if Path(tempViewer.name, viewer_file_name).exists():
             localViewer = iXBRLViewerLocalViewer("iXBRL Viewer",  os.path.dirname(__file__))

{ixbrl_viewer-1.4.39 → ixbrl_viewer-1.4.40}/iXBRLViewerPlugin/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.39'
-__version_tuple__ = version_tuple = (1, 4, 39)
+__version__ = version = '1.4.40'
+__version_tuple__ = version_tuple = (1, 4, 40)

ixbrl_viewer-1.4.40/iXBRLViewerPlugin/constants.py

@@ -0,0 +1,120 @@
+# See COPYRIGHT.md for copyright information
+
+import os
+
+from .featureConfig import FeatureConfig
+
+CONFIG_FEATURE_PREFIX = 'iXBRLViewerFeature_'
+CONFIG_FILE_DIRECTORY = 'iXBRLViewerFileDir'
+CONFIG_LAUNCH_ON_LOAD = 'iXBRLViewerLaunchOnLoad'
+CONFIG_COPY_SCRIPT = 'iXBRLViewerCopyScript'
+CONFIG_OUTPUT_FILE = 'iXBRLViewerOutputFile'
+CONFIG_SCRIPT_URL = 'iXBRLViewerScriptURL'
+CONFIG_ZIP_OUTPUT = 'iXBRLViewerZipOutput'
+
+ERROR_MESSAGE_CODE = 'viewer:error'
+EXCEPTION_MESSAGE_CODE = 'viewer:exception'
+INFO_MESSAGE_CODE = 'viewer:info'
+
+DEFAULT_LAUNCH_ON_LOAD = True
+DEFAULT_COPY_SCRIPT = True
+DEFAULT_OUTPUT_NAME = 'ixbrlviewer.html'
+DEFAULT_JS_FILENAME = 'ixbrlviewer.js'
+DEFAULT_VIEWER_PATH = os.path.join(os.path.dirname(__file__), "viewer", "dist", DEFAULT_JS_FILENAME)
+
+FEATURE_CONFIGS = [
+    FeatureConfig(
+        key='home_link_label',
+        label='Home Link (Label)',
+        description='Customizes the label of the "Home" link enabled by "home_link_url".',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
+    FeatureConfig(
+        key='home_link_url',
+        label='Home Link (URL)',
+        description='Adds a "Home" link that directs to the specified URL. Label can be customized with "home_link_label".',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
+    FeatureConfig(
+        key='support_link',
+        label='Support Link',
+        description='Adds a "Support" link that directs to the specified URL.',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
+    FeatureConfig(
+        key='survey_link',
+        label='Survey Link',
+        description='Adds a "Survey" link that directs to the specified URL.',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
+    FeatureConfig(
+        key='review',
+        label='Review Mode',
+        description='Enables highlighting of untagged numbers and dates.',
+        cliAction='store_true',
+        cliDefault=False,
+        guiVisible=True,
+        guiDefault=False
+    ),
+    FeatureConfig(
+        key='mandatory_facts',
+        label='Mandatory Facts',
+        description='Enables the display of mandatory facts for the selected taxonomy.',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None
+    ),
+    FeatureConfig(
+        key='search_on_startup',
+        label='Search on startup',
+        description='Show the search pane by default on startup',
+        cliAction='store_true',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None
+    ),
+    FeatureConfig(
+        key='highlight_facts_on_startup',
+        label='Highlight facts on startup',
+        description='Default "Highlight all facts" to on',
+        cliAction='store_true',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None
+    )
+]
+GUI_FEATURE_CONFIGS = [c for c in FEATURE_CONFIGS if c.guiVisible]
+
+MANDATORY_FACTS = {
+    "companies-house": [
+            "UKCompaniesHouseRegisteredNumber",
+            "EntityCurrentLegalOrRegisteredName",
+            "BalanceSheetDate",
+            "DateAuthorisationFinancialStatementsForIssue",
+            "DirectorSigningFinancialStatements",
+            "EntityDormantTruefalse",
+            "EntityTradingStatus",
+            "AccountsStatusAuditedOrUnaudited",
+            "AccountsTypeFullOrAbbreviated",
+            "AccountingStandardsApplied",
+            "LegalFormEntity",
+            "StartDateForPeriodCoveredByReport",
+            "EndDateForPeriodCoveredByReport",
+            "CharityRegistrationNumberEnglandWales",
+            "CharityRegistrationNumberScotland",
+            "CharityRegistrationNumberNorthernIreland"
+    ]
+}

{ixbrl_viewer-1.4.39 → ixbrl_viewer-1.4.40}/iXBRLViewerPlugin/featureConfig.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Any
 
 
 @dataclass(frozen=True, repr=False, eq=False)
@@ -6,5 +7,7 @@ class FeatureConfig:
     key: str
     label: str
     description: str
+    cliAction: str
+    cliDefault: Any
     guiVisible: bool
-    guiDefault: bool
+    guiDefault: Any

{ixbrl_viewer-1.4.39 → ixbrl_viewer-1.4.40}/iXBRLViewerPlugin/iXBRLViewer.py

@@ -13,6 +13,7 @@ import zipfile
 from collections import defaultdict
 from copy import deepcopy
 from pathlib import Path
+from typing import Any
 
 from arelle import XbrlConst
 from arelle.ModelDocument import ModelDocument, Type
@@ -23,7 +24,7 @@ from arelle.UrlUtil import isHttpUrl
 from arelle.ValidateXbrlCalcs import inferredDecimals
 from lxml import etree
 
-from .constants import DEFAULT_JS_FILENAME, DEFAULT_OUTPUT_NAME, ERROR_MESSAGE_CODE, FEATURE_CONFIGS, INFO_MESSAGE_CODE
+from .constants import DEFAULT_JS_FILENAME, DEFAULT_OUTPUT_NAME, ERROR_MESSAGE_CODE, FEATURE_CONFIGS, INFO_MESSAGE_CODE, MANDATORY_FACTS
 from .xhtmlserialize import XHTMLSerializer
 
 REPORT_TYPE_EXTENSIONS = ('.xbrl', '.xhtml', '.html', '.htm', '.json')
@@ -89,13 +90,20 @@ class IXBRLViewerBuilder:
             cntlr: Cntlr,
             basenameSuffix: str = '',
             useStubViewer: bool = False,
+            features: dict[str, Any] | None = None,
                  ):
+        if features is None:
+            features = {}
+        featureNames = {c.key for c in FEATURE_CONFIGS}
+        for featureName in features:
+            assert featureName in featureNames, \
+                f'Given feature name `{featureName}` does not match any defined features: {featureNames}'
         self.reportZip = None
         self.nsmap = NamespaceMap()
         self.roleMap = NamespaceMap()
         self.taxonomyData = {
             "sourceReports": [],
-            "features": [],
+            "features": features,
         }
         self.basenameSuffix = basenameSuffix
         self.currentTargetReport = None
@@ -120,14 +128,6 @@ class IXBRLViewerBuilder:
         self.reportCount = 0
         self.assets = []
 
-    def enableFeature(self, featureName: str):
-        if featureName in self.taxonomyData["features"]:
-            return
-        featureNames = [c.key for c in FEATURE_CONFIGS]
-        assert featureName in featureNames, \
-            f'Given feature name `{featureName}` does not match any defined features: {featureNames}'
-        self.taxonomyData["features"].append(featureName)
-
     def outputFilename(self, filename):
         (base, ext) = os.path.splitext(filename)
         return base + self.basenameSuffix + ext
@@ -155,7 +155,7 @@ class IXBRLViewerBuilder:
         """
         return s.replace("<","\\u003C").replace(">","\\u003E").replace("&","\\u0026")
 
-    def addELR(self, report: ModelXbrl, elr):
+    def addRoleDefinition(self, report: ModelXbrl, elr):
         prefix = self.roleMap.getPrefix(elr)
         if self.currentTargetReport.setdefault("roleDefs",{}).get(prefix, None) is None:
             rts = report.roleTypes.get(elr, [])
@@ -176,6 +176,7 @@ class IXBRLViewerBuilder:
             for lr in labels:
                 l = lr.toModelObject
                 conceptData["labels"].setdefault(self.roleMap.getPrefix(l.role),{})[l.xmlLang.lower()] = l.text;
+                self.addRoleDefinition(report, l.role)
 
             refData = []
             for _refRel in concept.modelXbrl.relationshipSet(XbrlConst.conceptReference).fromModelObject(concept):
@@ -193,9 +194,15 @@ class IXBRLViewerBuilder:
             if concept.isEnumeration:
                 conceptData["e"] = True
 
-            if concept.type is not None and concept.type.isTextBlock:
+            if concept.isTextBlock:
                 conceptData['t'] = True
 
+            if concept.balance is not None:
+                conceptData['b'] = concept.balance
+
+            if concept.type is not None:
+                conceptData['dt'] = self.nsmap.qname(concept.type.qname)
+
             if concept.isTypedDimension:
                 typedDomainElement = concept.typedDomainElement
                 if typedDomainElement is not None:
@@ -216,7 +223,7 @@ class IXBRLViewerBuilder:
         for baseSetKey, baseSetModelLinks  in report.baseSets.items():
             arcrole, ELR, linkqname, arcqname = baseSetKey
             if arcrole in (XbrlConst.summationItem, XbrlConst.summationItem11, WIDER_NARROWER_ARCROLE, XbrlConst.parentChild, XbrlConst.dimensionDefault) and ELR is not None:
-                self.addELR(report, ELR)
+                self.addRoleDefinition(report, ELR)
                 rr = dict()
                 relSet = report.relationshipSet(arcrole, ELR)
                 for r in relSet.modelRelationships:
@@ -256,11 +263,14 @@ class IXBRLViewerBuilder:
 
         self.idGen += 1
         conceptName = self.nsmap.qname(f.qname)
+        factList = MANDATORY_FACTS.get(self.taxonomyData["features"].get("mandatory_facts"), [])
+        isMandatory = f.qname.localName in factList
         scheme, ident = f.context.entityIdentifier
 
         aspects = {
             "c": conceptName,
             "e": self.nsmap.qname(QName(self.nsmap.getPrefix(scheme,"e"), scheme, ident)),
+            "m": isMandatory
         }
 
         factData = {
@@ -414,7 +424,11 @@ class IXBRLViewerBuilder:
         if softwareCredits:
             self.currentTargetReport["softwareCredits"] = list(softwareCredits)
         for f in report.facts:
-            self.addFact(report, f)
+            if f.isTuple:
+                for nestedTupleFact in f.ixIter():
+                    self.addFact(report, nestedTupleFact)
+            else:
+                self.addFact(report, f)
         self.currentTargetReport["rels"] = self.getRelationships(report)
 
         docSetFiles = None