bim+ webclient

bim+ webclient is a javascript module for integrating bimplus into custom web pages

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 webclient folder

npm install

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

Build webclient

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-webclient@(version).tar.gz)

npm run npm-pack

Develop/Debug webclient

goto your webclient folder

npm link

goto your application folder which uses the webclient

npm link bimplus-webclient

Do you changes in the webclient and build

npm run build

or

npm run build-prod

Your app will automatically get the changes done in the renderer

After developing it might be wise to unlink: goto your webclient folder

npm unlink

goto your application folder which uses the webclient

npm unlink bimplus-webclient
npm install

Unit testing

The tests run with Vitest in jsdom, Chromium, and Firefox. Install the browser binaries with npx playwright install before the first run. Run the tests with coverage using:

npm run test

The browser test API binds to 127.0.0.1, starting at port 41315, outside the Windows default dynamic port range. If the port is in use, Vitest selects the next available port so multiple test runs can execute concurrently.

Run Vitest in watch mode during development with:

npm run test-watch

Documentation

Bimplus webclient uses JSDoc for HTML documentation and a repository-owned renderer for Markdown API documentation. Install project dependencies with npm install before generating docs.

To create documentation in html format go to your webclient folder and run :

npm run build-doc

Documentation output will be in webclient/documentation folder

To create documentation in markdown format go to your webclient folder and run :

npm run build-docMd

Documentation output will be in webclient/documentation/Bimplus_WebClient_doc.md.

To create a markdown suitable for Confluence run script:

npm run build-docConf

This script will convert generated markdown into Confluence format. See console output for converted file name.

Content of the confluence file can be inserted into 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'