Install browser SDK

Yarn or NPM can be used to install the package.

TypeScript type definitions are included as a part of the installed package.

Install the package

NPM

  1. Append the line below to your .npmrc file in the root of your project directory (where package.json is located). If .npmrc does not exist, create it in the root of your project directory.
.npmrc
 
@seeka-labs:registry=https://npm.packages.seeka.services/
  1. Login to NPM to get your token (this will create the token in .npmrc in your user directory) The username and password below can be found in API settings once approved for NPM registry access by our platform team.
npm login --registry=https://npm.packages.seeka.services
  1. Run the below command to get the contents of .npmrc in your user directory, and copy the line starting with //npm.packages.seeka.services/:_authToken into your projects .npmrc file.
cat ~/.npmrc

Your final .npmrc file in the root of your project should look like the below:

.npmrc
 
@seeka-labs:registry=https://npm.packages.seeka.services/
//npm.packages.seeka.services/:_authToken=aFwHegFR8v237ic23GsdhBwD5TfXEEFFbp2BHdq45309sS/ZB5268Asn9EMGaD45Adg
  1. Install the package
npm install --save @seeka-labs/converge@latest
  1. Ensure the .npmrc file is commited to your code repository to allow your CD pipeline to install the packages.

Yarn classic (v1)

  1. Append the line below to your .npmrc file in the root of your project directory (where package.json is located). If .npmrc does not exist, create it in the root of your project directory.
.npmrc
 
@seeka-labs:registry=https://npm.packages.seeka.services/
  1. Append the line below to your .yarnrc file in the root of your project directory (where package.json is located). If .yarnrc does not exist, create it in the root of your project directory.
.yarnrc
 
"@seeka-labs:registry" "https://npm.packages.seeka.services/"
  1. Login to NPM to get your token (this will create the token in .npmrc in your user directory) The username and password below can be found in API settings once approved for NPM registry access by our platform team.
npm login --registry=https://npm.packages.seeka.services
  1. Run the below command to get the contents of .npmrc in your user directory, and copy the line starting with //npm.packages.seeka.services/:_authToken into your projects .npmrc file.
cat ~/.npmrc

Your final .npmrc file in the root of your project should look like the below:

.npmrc
 
@seeka-labs:registry=https://npm.packages.seeka.services/
//npm.packages.seeka.services/:_authToken=aFwHegFR8v237ic23GsdhBwD5TfXEEFFbp2BHdq45309sS/ZB5268Asn9EMGaD45Adg
  1. Install the package
yarn add @seeka-labs/converge@latest
  1. Ensure .npmrc and .yarnrc files are commited to your code repository to allow your CD pipeline to install the packages.

If the error below happens when you try and install the package, ensure that .npmrc and .yarnrc are saved with UTF-8 encoding SyntaxError: Unknown token: { line: 1, col: 0, type: 'INVALID', value: undefined } 1:0 in \.yarnrc

Yarn v2+

The username and password below can be found in API settings once approved for NPM registry access by our platform team.

  1. Append the lines below to your .yarnrc.yml file in the root of your project directory (where package.json is located). If .yarnrc.yml does not exist, create it in the root of your project directory.
.yarnrc.yml
 
npmScopes:
  seeka-labs:npmAlwaysAuth: false
    npmRegistryServer: "https://npm.packages.seeka.services"
    npmAuthIdent: "yourSeekaNpmRegistryUsername:yourSeekaNpmRegistryPassword"
  1. Install the package
yarn add @seeka-labs/converge@latest
  1. Ensure .yarnrc.yml file is commited to your code repository to allow your CD pipeline to install the packages.

Version tags

  • latest - Latest stable release
  • alpha - Latest preview/development release
  • X.Y.Z - Specific version

To install a specific version, replace latest in the examples above with the version tag.