Accessing Sencha’s npm Repository

If you are a TRIAL customer

The Ext JS 30-day trial packages are available to install from public npm. Install the latest Ext JS version using the following command and skip to Step 2.

$ npm install -g @sencha/ext-gen

If you are an ACTIVE customer

Ext JS and all related commercial packages are hosted on Sencha’s private npm registry. Login to the registry using the following command which configures npm to download packages in the @sencha scope from Sencha’s registry.

Username Note:

The email and password used during support portal activation (after license purchase) will be used to login to Sencha’s NPM repo. The username is the same as the email used, however, the @ character is replaced with ‘..’ two periods. For example [[email protected]](https://docs.sencha.com/cdn-cgi/l/email-protection) converts to username: name..gmail.com

$ npm login --registry=https://npm.sencha.com/ --scope=@sencha

Use this step when you need to login in server enviroment.

Login locally, so you can get the access token from your ~/.npmrc file.
In the CI Build steps, you can login one of two ways.

Using NPM Commands

Using npm commands. Replace the $SENCHA_NPM_TOKEN_VERDACCIO with the token from your ~/.npmrc file.

npm config set @sencha:registry https://npm.sencha.com/
npm config set //npm.sencha.com/:_authToken=$SENCHA_NPM_TOKEN_VERDACCIO

Writing an Auth File

Create and write a ~/.npmrc file. Replace the %npm.sencha.com-authtoken% with the token from your ~/.npmrc file.

# Remove previous file
rm -f ~/.npmrc
# Write new ~/.npmrc
echo "Writing auth tokens to ~/.npmrc"
echo "@sencha:registry=http://npm.sencha.com" >> ~/.npmrc
echo "//npm.sencha.com/:_authToken=%npm.sencha.com-authtoken%" >> ~/.npmrc
# Debug
echo "Debug contents of ~/.npmrc:"
echo "~~~~~~~~~~~~~~~~~~~~~~"
cat ~/.npmrc
echo "~~~~~~~~~~~~~~~~~~~~~~"
# Check login with whoami
echo "Invoking NPM whoami"
echo "~~~~~~~~~~~~~~~~~~~~~~"
npm --registry http://npm.sencha.com/ whoami
echo "~~~~~~~~~~~~~~~~~~~~~~"

Travis CI config

Here’s a Travis CI example configuration.

env:
  # npm.sencha.com
  # gem install travis
  # travis login --pro --github-token replace_with_github_personal_token
  # cd to/repo
  # travis encrypt SENCHA_NPM_TOKEN_VERDACCIO="replace_with_apikey"
  # SENCHA_NPM_TOKEN_VERDACCIO - secure: "XXXX... generation removed"
  # early-adopter
  # travis encrypt SENCHA_NPM_TOKEN_EARLYADOPTER="replace_with_apikey"
  - secure: "XXXX... generation removed"
os: osx
language: node_js
node_js:
 - "lts/*"
cache:
  npm: false
before_install:
  # NPM Login - commercial
  # - npm config set @sencha:registry https://npm.sencha.com/
  # - npm config set //npm.sencha.com/:_authToken=$SENCHA_NPM_TOKEN_VERDACCIO
  # NPM Login - early-adopter
  - npm config set @sencha:registry https://sencha.myget.org/F/early-adopter/npm/
  - npm config set //sencha.myget.org/F/early-adopter/npm/:_authToken=$SENCHA_NPM_TOKEN_EARLYADOPTER
install: 
  - cd internal-components
  - npm install
script:
  - npm run build
deploy:
  skip_cleanup: true
  provider: script
  script: bash deploy.sh
  on:
    branch: master 
# Run CLI in this repo
# Delete Cache
# travis cache
# travis cache --delete

Note: Existing customers use your support portal credentials. But switch the username, @ character with '..' two periods, so the username would look something like this after it’s converted: name..gmail.com.

Creating your own Copy of Sencha repo

Sometimes, especially for continuous integration, you may desire a scenario where you do not want to worry about access credentials or authentication to obtain content from our NPM repository.

This section outlines the way in which you can download all the Sencha node packages from our repo, saving them locally, without the need for constant authentication.

In this guide, we will use a target local directory of ‘./vendor’ to contain all the Sencha node packages. This can be named anything of meaning to you. The following steps assume you are in your application’s root directory.

    1. Login to Sencha’s NPM repository to authenticate yourself so you may access all Sencha packages.
      > npm set @sencha:registry=https://npm.sencha.com
      > npm login --registry=https://npm.sencha.com --scope=@sencha
    2. While authenticated, install all Sencha packages required by your application except @sencha/ext-webpack-plugin.
    3. After all packages are installed, copy the contents of ./node_modules/@sencha to ./vendor/@sencha. Ensure that any source control application you use has the ‘./vendor’ directory added to it so that these packages are available in any target system that will checkout your application.
    4. Update your package.json to link all required packages to their new location in the ./vendor folder. For example:
      “dependencies”: {
        “@sencha/ext”: “file:vendor/@sencha/ext”
      }
    5. Next, update the package.json file for each individual Sencha package found in the ‘vendor’ directory (e.g. vendor/@sencha/ext/package.json). You will want to
      a. Remove any/all “scripts” definitions in the file. For example:
        “scripts”: {
          “install”: “node authorize.js”
        }
      b. Update dependency references to reflect that other packages are now locally found in the vendor folder. For example:
        “@dependencies”: {
          “@sencha/ext-core”: “file:../ext-core”
        }
      c. Finally, remove any “_activatedby” property which may exist in the package.json (it should be located at the bottom). These properties are part of npm authentication and may cause issues if retained.
    6. As you will no longer be using Sencha NPM server, unregister the packages locally from the server by editing your .npmrc file and commenting out the following line (if present) by placing a hash symbol at the start:
      # @sencha:registry = “https://npm.sencha.com”
    7. Delete your ./node modules directory along with the package-lock.json file.
    8. Edit package.json and remove ‘@sencha/ext-webpack-plugin’ from the “devDependencies” block (if one exists).
    9. Run npm install to re-populate the node_modules required for your application. This will also populate the ‘node_modules/@sencha’ directory with links to your vendor directory locations, rather than downloading the source from our repository.
    10. Run npm install @sencha/ext-webpack-plugin --save-dev. NPM will install this package and its @sencha/cmd dependency from the public npm registry.
    11. If you previously have a build server configured with any Sencha authentication, you may remove this authentication from any buildspec files. As you will be using your own local copy of our packages, Sencha npm repo authentication is no longer necessary.
    12. Finally, commit these changes to any CVS and review CI/CD pipelines as necessary to ensure builds run correctly and without incident.