bimplus-signalr-client

bimplus-signalr-client is a javascript wrapper around SignalR

Quick Links

https://nemetschekprime.atlassian.net/wiki/spaces/bimpluspublic/pages/1090127532/Bimplus+Web+SDK+Reference

How to build

Install nodejs

http://www.nodejs.org/

Install local npm modules

Open up a normal command line (admin is not needed) and go to the bimplus-signalr-client folder

npm install

(whenever package.json has changed, you might to do this again)

Build BimplusSignalrClient

Library building process is using UMD (Universal Module Definition) output format so it's compatible with both cjs and amd module formats. The same library can be use in the client or on the server. Build process is using babel so it's possible to use new ES2015 code in source codes.

Library can be build in several ways as a dev or prod version. To run a dev build with source maps run:

npm run build

To build a prod version - uglified, minified run:

npm run build-prod

Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) :

npm run npm-publish

Check content of npm package (result is bimplus-renderer@(version).tar.gz)

npm run npm-pack

Develop/Debug BimplusSignalrClient

goto your bimplus-signalr-client folder

npm link

goto your application folder which uses the bimplus-signalr-client

npm link bimplus-signalr-client

Do you changes in the bimplus-signalr-client and build

npm run build

or

npm run build-prod

Your app will automatically get the changes done

After developing it might be wise to unlink: goto your bimplus-signalr-client folder

npm unlink

goto your application folder which uses the bimplus-signalr-client

npm unlink bimplus-signalr-client
npm install

Testing

Development requires Node.js ^20.19.0, ^22.13.0, or >=24.0.0; npm enforces this through devEngines.

Install the browser binaries once:

npx playwright install chromium firefox

Set the BIM_PASS environment variable for the live SignalR integration tests, then run all lint, unit, and Chromium/Firefox tests with coverage:

npm test

Documentation

bimplus-signalr-client uses local JSDoc tooling and a repository-owned Markdown renderer. Install dependencies with npm install, then generate the HTML API reference with:

npm run build-doc

HTML documentation is generated in the documentation folder.

To generate the API Markdown, run:

npm run build-docMd

The output is documentation/Bimplus-SignalR-doc.md.

To generate Markdown for Confluence, run:

npm run build-docConf

The converted output is documentation/Bimplus-SignalR-doc_confluence.md. npm run build-docAll generates the HTML, Markdown, and Confluence documentation.

The Confluence file can be inserted into a Confluence page:

• start confluence page editation mode
• choose Insert more content / {} Markup option from toolbar
• in popup window choose to Insert Markdown format
• copy content of the converted confluence markdown file into the field in Confluence
• save it (Please note that page links doesn't work in page preview mode)

Typescript definitions

• typescript definition file is located in subfolder 'types'