@kanipayments/test v0.0.1

Test Package

A demo package for testing the Kani NPM server

/src

The development files. These can be stand alone TS functions or React components.

Anything to be made available from the NPM package should be imported into the index.ts file and exported from there.

/lib

The output of the compiled TS files. This is what is published to NPM and is defined as the main entry point in the package.json file.

.npmrc

The NPM configuration. Defines the Kani NPM registry and the auth credentials. Username and email are required by NPM but not used by the Azure authentication process, so hold dummy values. The password is a Base64 version of the KaniCommonPAT token. The existing KaniCommonPAT token can be used, but package write permissions are required to publish to Azure Artifacts.

package.json

A standard package file configuration. The name must be unique for the published package. We can use scoping to avoid any name clashes by prefixing the package name with @kani/.

The version must be unique for each published package. This can be set manually in the file, or from the command line using npm version x.x.x.

Any static files such as CSS are not included in the output when compiling the typescript files. These should be copied to the output file to ensure they are available to the packaged components. This can be done using an NPM script, as shown in this example package.json file.