smartclient-eval

Provides access to SmartClient Evaluation's client-side UI components documented here.

Installation

Install package and SmartClient runtime(s):

 npm install smartclient-eval [flags]

Update/reconfigure SmartClient runtime(s) (must be run from package directory):

 npm run update [flags]

where the supported flags are:

 --location=<directory>  where to install the SmartClient runtime(s);
                         default is to place runtime root (isomorphic)
                         in the parent of the node_modules directory
                         containing the smartclient-eval package

 --branch=<number>       desired branch (e.g. 11.1); default is release
                         branch

 --date=<date|'latest'>  desired build date, in format YYYY-MM-DD,
                         or 'latest'; default is 'latest'

 --runtime=<'release'|'debug'|'both'>
                         which runtime(s) to install; default is 'both'

 --skins[=<boolean>]     whether to install all skins or not;
                         default is to only install Tahoe

 --yes[=<boolean>]       assume answer 'yes' to prompts with default

After installation, command-line configuration is persisted, so command-line arguments only need to be supplied when updating if the desired configuration has changed.

Note that since 'npm update' no longer runs a package's update script if the version hasn't changed, you must use the syntax above, run from the package directory, to update the runtime(s) if the package has already been installed. (The smartclient-eval package is versioned separately from nighlty SDK builds.)

Command-line Examples

New install, selecting a specific branch and date:

 npm install smartclient-eval --branch=11.1 --date=2018-12-30

Update to latest nighlty build (run from package directory):

 npm run update --date=latest

Update to SmartClient 12.1 branch, installing all skins:

 npm run update --branch=12.1 --skins

Importing

Using smartclient-eval requires an environment, such as React, that defines "window" as a global with real browser document and navigator objects. In your React app, you can write:

 import 'smartclient-eval/debug';

or

 import 'smartclient-eval/release';

to import the debug or release framework, respectively. To import a skin, such as "Tahoe", you can write:

 import 'smartclient-eval/skins/Tahoe';

If you want to refer to SmartClient APIs through your own constant, you can always issue a declaration such as:

 const ISC: typeof isc = window['isc'];

after importing this package.

TypeScript

To provide typescript support, the installation process should automatically augment your tsconfig.json file to include SmartClient's typescript file.

Alternatively, you can copy the typescript declaration file, smartclient.d.ts, from the installed resources under the isomorphic directory to your app's source directory, and then import it from your app like:

 import 'smartclient.d.ts';