Merge pull request #1444 from FZJ-INM1-BDA/staging

v2.14.4

.github/workflows/ci.yml

@@ -14,8 +14,8 @@ jobs:
   #   runs-on: ubuntu-latest
 
   #   steps:
-  #   - uses: actions/checkout@v3
-  #   - uses: actions/setup-node@v1
+  #   - uses: actions/checkout@v4
+  #   - uses: actions/setup-node@v4
   #     with:
   #       node-version: '16.x'
   #   - run: npx prettier -c ./src
@@ -25,9 +25,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js 16.x for lint
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: '16.x'
     - run: npm i
@@ -41,9 +41,9 @@ jobs:
       NODE_ENV: test
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js 16.x
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: 16.x
     - run: npm i
@@ -59,7 +59,7 @@ jobs:
     if: always()
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
         python-version: '3.10'

.github/workflows/docker_img.yml

@@ -26,7 +26,9 @@ jobs:
       SIIBRA_API_LATEST: 'https://siibra-api-latest.apps-dev.hbp.eu/v3_0'
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+      with:
+        lfs: true
     - name: 'Set matomo env var'
       run: |
         echo "Using github.ref: $GITHUB_REF"
@@ -118,8 +120,9 @@ jobs:
           DEPLOY_ID=$(echo ${BRANCH_NAME//[_\/]/} | awk '{ print tolower($0) }')
           echo "DEPLOY_ID=$DEPLOY_ID" >> $GITHUB_OUTPUT
 
-          VERSION=$(jq -r '.version' package.json)
-          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          SXPLR_VERSION=$(jq -r '.version' package.json)
+          echo "SXPLR_VERSION=$SXPLR_VERSION"
+          echo "SXPLR_VERSION=$SXPLR_VERSION" >> $GITHUB_OUTPUT
 
   trigger-deploy-master-prod:
     if: ${{ needs.setting-vars.outputs.BRANCH_NAME == 'master' && success() }}
@@ -142,7 +145,7 @@ jobs:
     uses: ./.github/workflows/deploy-helm.yml
     with:
       DEPLOYMENT_NAME: master
-      IMAGE_TAG: ${{ needs.setting-vars.outputs.VERSION }}
+      IMAGE_TAG: ${{ needs.setting-vars.outputs.SXPLR_VERSION }}
     secrets:
       KUBECONFIG: ${{ secrets.KUBECONFIG }}
 

.github/workflows/release.yml

@@ -38,7 +38,7 @@ jobs:
         prerelease: false
 
     - name: Use Node.js 16.x 
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: '16.x'
 

docs/releases/v2.14.4.md

@@ -0,0 +1,13 @@
+# v2.14.4
+
+## Feature
+
+- Sagittal view of perspective PiP changes hemisphere when user navigates to the otehr hemisphere
+- Adds an additional degree adjustment to perspective PiP
+- Encode maximised panel state
+
+## Behind the Scenes
+
+- Fix CI/CD deploy on rancher
+- Update API docs
+- Update github action checkout/setupnode

mkdocs.yml

@@ -38,6 +38,7 @@ nav:
     - Differential gene expression analysis: "advanced/differential_gene_expression_analysis.md"
 
   - Release notes:
+    - v2.14.4: 'releases/v2.14.4.md'
     - v2.14.3: 'releases/v2.14.3.md'
     - v2.14.2: 'releases/v2.14.2.md'
     - v2.14.1: 'releases/v2.14.1.md'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "siibra-explorer",
-  "version": "2.14.3",
+  "version": "2.14.4",
   "description": "siibra-explorer - explore brain atlases. Based on humanbrainproject/nehuba & google/neuroglancer. Built with angular",
   "scripts": {
     "lint": "eslint src --ext .ts",
@@ -11,8 +11,8 @@
     "watch": "ng build --watch --configuration development",
     "test": "ng test",
     "test-ci": "ng test --progress false --watch false --browsers=ChromeHeadless",
-    "sapi-schema": "npx openapi-typescript@6.1.0 https://siibra-api-stable.apps-dev.hbp.eu/v3_0/openapi.json --output ./src/atlasComponents/sapi/schemaV3.ts && eslint ./src/atlasComponents/sapi/schemaV3.ts --no-ignore --fix",
-    "api-schema": "node src/plugin/generateTypes.js",
+    "sapi-schema": "curl 'https://siibra-api-stable.apps.hbp.eu/v3_0/openapi.json' | jq > ./src/atlasComponents/sapi/openapi.json && npx openapi-typescript@6.1.0 ./src/atlasComponents/sapi/openapi.json --output ./src/atlasComponents/sapi/schemaV3.ts && eslint ./src/atlasComponents/sapi/schemaV3.ts --no-ignore --fix",
+    "api-schema": "node src/api/generateSchema.mjs",
     "docs:json": "compodoc -p ./tsconfig.json -e json -d .",
     "storybook": "npm run docs:json && start-storybook -p 6006",
     "build-storybook": "npm run docs:json && build-storybook"

src/api/README.md

@@ -0,0 +1,39 @@
+# Post message API
+
+This page outline how an other application can communicate with siibra-explorer. This includes, but is not limited to how plugins communicate with siibra-explorer. 
+
+All communications between siibra-explorer and plugin will occur via the [postMessage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage).
+
+## APIs
+
+All APIs are categorized under `{broadcast|handshake|request}/sxplr.{$EVENT_NAME}__{toSxplr|fromSxplr}__{request|response}.json`
+
+The json files are JSON schema, of the shape of the request/response API clients can expect. The shape described by the aforementioned JSON schema complies with [jsonrpc 2.0](https://www.jsonrpc.org/specification) specification.
+
+- `fromSxplr`
+
+Request originates from siibra-explorer. Either `handshake` or `broadcast` events
+
+- `toSxplr`
+
+Request origintes from the client. `request` events
+
+- `request`
+
+Describes the schema of the request
+
+- `reesponse`
+
+Describe the schema of the response (if any)
+
+- `handshake`
+
+Sent from siibra-explorer to the client, and expects a response. Requests from a non-responding client is ignored. Broadcasts will not be made to non-responding clients.
+
+- `broadcast`
+
+Sent from siibra-explorer to client. Sent when (with a debounce timer) the state of siibra-explorer changes (either user initiated or otherwise).  Siibra-explorer does not expect a response. Siibra-explorer will only broadcast to clients who responded to a hand shake.
+
+- `request`
+
+Sent from the client to siibra-explorer. If the `id` field is present, siibra-explorer will respond success or error of the operation.

src/api/broadcast/README.md

@@ -0,0 +1,9 @@
+# Broadcasting API
+
+Broadcasting messages are sent under two circumstances:
+
+- the state of the viewer changed, initiated by any source (user, plugin etc). Sent to all active plugin clients.
+
+- immediately after the plugin client acknowledged `handshake.init` to the specific client. This is so that the client can get the current state of the viewer.
+
+Broadcasting messages never expects a response (and thus will never contain and `id` attribute)