Add viewer.show-imported-depth to bblocks-config.yaml

Allows configuring the bblocks-viewer's showImported level directly in
bblocks-config.yaml under a viewer.show-imported-depth key, rather than
only via the viewer_show_imported workflow input. The value is written to
register.json as viewer.showImported so the viewer can read it without a
deployed config.js. The workflow input is kept for backwards compatibility
but deprecated in favour of the config file key.

Author: avillar

.github/workflows/validate-and-process.yml

@@ -64,9 +64,11 @@ on:
       viewer_show_imported:
         type: number
         description: |
-          Level up to which the deployed building blocks viewer will show imported building 
+          Level up to which the deployed building blocks viewer will show imported building
           blocks as well as local ones. 0 means "only local", and a negative number means
           "all imports".
+          Deprecated: set viewer.show-imported-depth in bblocks-config.yaml instead.
+          If that key is present, it takes precedence over this input.
         default: 0
       fallback_rainbow_instances:
         type: string
@@ -298,11 +300,17 @@ jobs:
           BBLOCKS_SPARQL='${{ inputs.fallback_sparql_endpoints }}'
           BBLOCKS_SPARQL="${BBLOCKS_SPARQL:-[]}"
 
+          # Prefer viewer.show-imported-depth from bblocks-config.yaml if present
+          SHOW_IMPORTED=$(yq '.viewer."show-imported-depth" // null' '${{ inputs.config_file }}' 2>/dev/null)
+          if [ "$SHOW_IMPORTED" = "null" ] || [ -z "$SHOW_IMPORTED" ]; then
+            SHOW_IMPORTED='${{ inputs.viewer_show_imported }}'
+          fi
+
           cat << EOF > config.js
           window.bblocksRegister = '${{ steps.get-pages-url.outputs.result }}/${{ inputs.register_file }}';
           window.bblocksViewer = {
             title: $(jq '.name // "${{ github.event.repository.name }}"' < "$REGISTER_FILE"),
-            showImported: ${{ inputs.viewer_show_imported }},
+            showImported: ${SHOW_IMPORTED},
             baseUrl: '${PAGES_PATH}${BASE_URL}',
             bblocksFallbackRainbowInstances: ${BBLOCKS_RAINBOW},
             bblocksFallbackSparqlEndpoints: ${BBLOCKS_SPARQL},

ogc/bblocks/entrypoint.py

@@ -231,6 +231,12 @@
             register_additional_metadata['sparqlEndpoint'] = sparql_conf['query']
         schema_oas30_downcompile = bb_config.get('schema-oas30-downcompile', False)
 
+    viewer_config = {}
+    if bb_config:
+        raw_viewer = bb_config.get('viewer', {}) or {}
+        if 'show-imported-depth' in raw_viewer:
+            viewer_config['showImported'] = raw_viewer['show-imported-depth']
+
     bb_local_config_file = Path('bblocks-config-local.yml')
     local_url_mappings = None
     if bb_local_config_file.is_file():
@@ -307,6 +313,7 @@
                     git_repo_path=git_repo_path,
                     viewer_path=(args.viewer_path or '.') if deploy_viewer else None,
                     additional_metadata=register_additional_metadata,
+                    viewer_config=viewer_config,
                     schemas_oas30_downcompile=schema_oas30_downcompile,
                     local_url_mappings=local_url_mappings,
                     links=[

ogc/bblocks/postprocess.py

@@ -51,7 +51,8 @@ def postprocess(registered_items_path: str | Path = 'registereditems',
                 additional_metadata: dict | None = None,
                 schemas_oas30_downcompile=False,
                 local_url_mappings: dict | None = None,
-                links: list[dict] = None) -> list[dict]:
+                links: list[dict] = None,
+                viewer_config: dict | None = None) -> list[dict]:
 
     cwd = Path().resolve()
 
@@ -513,6 +514,9 @@ def do_postprocess(bblock: BuildingBlock, light: bool = False) -> bool:
             output_register_json['imports'] = list(imported_bblocks.real_metadata_urls.values())
         output_register_json['bblocks'] = output_bblocks
 
+        if viewer_config:
+            output_register_json['viewer'] = viewer_config
+
         if transform_plugins:
             output_register_json['transformPlugins'] = transform_plugins