@procaaso/procaaso-views-client NPM

pc-piral-proto-api

A typescript library that extends piral-core/lib/types/custom PiletCustomApi to inject paracloud API interaction objects into an end-user pilet.

Build

bazel build //lib/js/pc-piral-proto-api:package

NOTE: Make sure to update the package version appropriately in BUILD file.

Publish

yarn publish bazel-bin/lib/js/pc-piral-proto-api/package --non-interactive

Notes about dev

Current plan is to provide a pc-piral-instance which allows a scaffold to develop in. This will provide the ability to inject mock data similiar to what will be injected from the user interface. This mock data will be available to be gathered from the vscode extension (maybe syndi as a standalone in the future). A local json file will be written, by the extension, with the data relevant to the system, component, and so on. The procaasoData.json data will then be used by the mock data service to plug in the relevant info. The developer will then use the data injected into the piral instance with an external procaaso sdk. Instead of injecting the sdk(api) into the pilet with the piletApi, the user will instead install the sdk as a dependency directly in the pilet. This way the sdk can be revisioned and used without depending on a new deployment of the main UI. Then based on the data provided by the UI the sdk can easily be used.

Current thoughts on type for view context:

id: system, component, instrument, ect as defined by which pilet is being built. url: to be used by the api calls (http(s)://customerenv.procaaso.ai/.....) token: provided for mock situations to allow connection to cloud env. Not provided by UI as cookies are used instead. (Maybe not long term?)