@walkme/sdk

WalkMe SDK

The Player SDK includes hooks, data and services that allow internal and external applications to interact with the Player and enhance its functionality.

Guidelines - In Progress

• Each SDK API would be considered finished after having documentation, working tests and examples showing how to use all the features implemented.
• Every SDK hook receives a JavaScript Object as a parameter ensuring that even if the API gets updated and some method ends up being changed, the SDK will remain compatible.
• Every new API should be approved by the SDK committee, keeping in mind that it is binding.
• Changes to the SDK API must be backward compatible.

Test

npm t

Build

npm run build -- --mode <level> --env.WP_PUBLIC_PATH_BASE=<target remote url>

<level> - for dev env's (Local, QA, Dev) use development, otherwise use production

<target remote url> - is a base URL when the SDK will be available later, for instance:

• Local: just omit this parameter
• QA: https://cdn.walkmeqa.com/sdk/
• Dev2: https://cdn2.walkmedev.com/sdk/
• Prod: https://cdn.walkme.com/sdk/

Examples:

For QA:

npm run build:dev -- --env.WP_PUBLIC_PATH_BASE=https://cdn.walkmeqa.com/sdk/ OR npm run build --mode development --env.WP_PUBLIC_PATH_BASE=https://cdn.walkmeqa.com/sdk/

For Production:

npm run build -- --mode production --env.WP_PUBLIC_PATH_BASE=https://cdn.walkme.com/sdk/

Publish

npm version patch

npm publish

Notes:

• You have to be authorized in @walkme organization in https://www.npmjs.com,
• Please note that users automatically gets update for patches and wont require to upgrade their package, for minor and major they required to npm i @walkme/sdk@latest

Usage

import sdk from '@walkme/sdk';

(async() => {
    
    await sdk.init();
    
    const key = 'some key';
    const val = 'some key';

    sdk.storage.save(key, val, 600);
    console.log(sdk.storage.get(key) === val); // will print true
    
})();

Work locally

Run:

npm run build:dev -- --watch

Link:

npm link

In the other project:

npm link @walkme/sdk

You're ready to go! use the SDK follow by the example above

Running example

Run:

npm run build:dev:example;

Then:

Desktop: Open example/dist/index.html in your browser

Web: Open example/dist/index.html (make sure you have ?platform=web to the URL)