Skip to main content

NPM Repository

The VisuallyJs packages are hosted in two places:

  • In the public NPM repository (https://registry.npmjs.org) there is a watermarked version of each package which can be used for evaluation and for users who satisfy the conditions of non-commercial usage.
  • For licensees, the packages are hosted in our private VisuallyJs NPM repository. This repository is available to all licensees who currently have access to download new releases.

Repository URL​

Note the trailing slash on the repository location: this must be included.

https://download.jsplumbtoolkit.com/repository/visuallyjs/

Logon​

To login to the VisuallyJs NPM repository you use your licensee ID:

npm adduser --registry=https://download.jsplumbtoolkit.com/repository/visuallyjs/
...
Username:  <licensee id>
Password: <...>

Your password will have been supplied in an email from VisuallyJs.

.npmrc Setup​

You'll need to map the @visuallyjs scope to VisuallyJs's NPM repository. For that, ensure your .npmrc has this entry:

@visuallyjs:registry=https://download.jsplumbtoolkit.com/repository/visuallyjs/

Tokens​

Running the npm adduser command to login to the NPM repository will result in an authToken being written to your local .npmrc. For licensees, the number of active tokens is determined relative to the number of developer seats purchased: for single seat licensees, one token is supported. For holders of a small team (1-5 developers) license, 6 concurrent tokens are supported. For holders of a team (1-10 developers) license, 12 concurrent tokens are supported. The extra token(s) are intended to help if you have a machine that runs automated builds or some such setup. For holders of an unlimited seats developer license, unlimited NPM tokens are supported.

Repository Availability​

Whilst every effort is made to ensure the repository is available at all times, VisuallyJs enters into no Service Level Agreement with licensees as to the availability of the NPM repository. It is recommended that all licensees download the VisuallyJs packages from our Downloads Page, and/or configure a repository that proxies our repository (such as JFrog - instructions given below).

JFrog Setup​

You can

To use JFrog to serve VisuallyJs packages you need to setup both a remote repository and a virtual repository. The remote repository acs as the proxy to our repository, and the virtual repository rewrites the download URLs that our reposut

The steps you need to follow are:

  1. Generate a token​

Generate a token on the VisuallyJs NPM repository using the Logon instructions above. The token is written to your .npmrc file in this format:

//download.jsplumbtoolkit.com/repository/visuallyjs/:_authToken=89efb562-f762-adb1-fefe-9834fe32

  1. Create remote repository in JFrog​

Remote repository config

Select NPM as the repository type. Then enter these details:

Remote repository config

When you click the 'Test Connection' button you should see a dialog confirming a successful connection:

Remote repository connect

Your remote repository is now setup - it can proxy requests to our NPM repository. Press Create Remote Repository to finalise it. Now click on Set Up npm Client.

  1. Get client config instructions​

Enter your JFrog password and click on Generate Token & Create Instructions:

Generate NPM token

  1. Get .npmrc instructions​

Once the token has been created, scroll down to the Edit .npmrc (scoped) section. VisuallyJs is a scoped NPM package.

Remote repository connect

  1. Edit your .npmrc​

Lastly, edit your .npmrc to include the instructions JFrog supplied - the url to the registry to use, and the JFrog auth token:

@visuallyjs:registry=https://YOUR-HOST.jfrog.io/artifactory/api/npm/visuallyjs/

//YOUR-HOST.jfrog.io/artifactory/api/npm/visuallyjs/:_authToken=cmVmdGtuOjAxOjE4MjE3Mzg4OTM6R1Z5R292SFJaNHR6ckFWaVN1ZjAxT1BlOHpv

  1. Verifying your setup​

You can verify this is all setup correctly by running an npm view command:

npm view @visuallyjs/browser-ui@latest

You should see output like this:

@visuallyjs/[email protected] | Commercial | deps: none | versions: 18
VisuallyJs
https://visuallyjs.com/

dist
.tarball: https://YOUR-HOST.jfrog.io/artifactory/api/npm/visuallyjs/@visuallyjs/browser-ui/-/1.2.9.tgz
.shasum: a5dcc4043c21fd8650c4512d1ef53660c04cf71e
.integrity: sha512-Vo5Rrv9CnjokUX9riKFGTEznPB/tAc24tg4THXTdRBq+H86iMAvP864H9j5j3NBn6q3pShcV22Jn7fK7idVpFA==

dist-tags:
latest: 1.2.9  

published yesterday