The BIM.works JavaScript packages can be installed from a private NPM package registry.

Where

Address: https://npm.bim.works

Username: Company wide username (to be supplied)

Password: To be supplied

<aside> 💡 Please email [email protected] to get your credentials

</aside>

Setup

The BIM.works packages are provided in two NPM scopes: @sascom and @bimworks

npm login --registry=https://npm.bim.works --scope=@sascom
npm login --registry=https://npm.bim.works --scope=@bimworks

Alternative

Alternatively you can also manually edit your .npmrc.

Edit your .npmrc file (~/.npmrc on linux) and add the following. This will make npm download all @sascom and @bimworks packages from npm.bim.works.

@sascom:registry=https://npm.bim.works
@bimworks:registry=https://npm.bim.works

And then login for both scopes with the supplied credentials

npm login --registry=https://npm.bim.works

Package.json

In your package.json, you can add the following packages, depending on which ones you’ll need.

<aside> 💡 Navigating your browser to https://npm.bim.works (and logging in with your credentials), shows you all the available packages. You can use that to find out what the latest versions are.

</aside>

"dependencies": {
  "@bimworks/jssdk": "1.3.0",
  "@bimworks/viewer2d": "1.3.0",
  "@bimworks/viewer3d": "1.3.0",
  "@bimworks/viewercommon": "1.3.0",
}

Usage