revealbi-node-sdk

DEVELOPMENT ENVIRONMENT

To do once: 0. Node 14 is not supported, update at least to Node 16.3 (Versions in between these two haven't been tested) 1. The native lib is not in git, so it must be built locally. Do that with generate-native.bat 2. Move to 'NodeJS' folder 2. Run 'npm install' 3. Run 'npx tsc'

DEV WORKFLOW

Running the development server: 'npm start' to start the typescript development app. There are other scripts available.

Debugging the native engine: Use the '_internal_revealEnginePrgPath' revealOption for reveal to set where the native engine is, set it to the bin\Debug exe, run, then attach to the process with VS.

Updating the sdk-model javascripts Those are the transpiled dataSource(Item) typescripts found under 'Reveal\CS\CP\Source\RPUI\JSNative\rpembedded\src\dataSources' (aka 'rpembedded') The output is under lib/sdk-model and lib/dts/sdk-model just run 'npx tsc' in 'NodeJS' folder.

If new dataSource(Item).ts files are added (under 'rpembedded' folder), update reveal.js following what's done for other DS/DSI.
    Please also make sure getProviderKey, toJson, and the constructor(json) methods are implemented in the datasource(item).ts class.

RELEASING

Publishing a new version update the version in 'package.json' the command is 'npm publish'