Components Library

The components package defines our prompt components. These components are used by both the sdk and the frontend packages. Our prompt components are implemented using Web Components and powered by Lit.

//TODO: link to prompt documentation here

Prerequisites

1. Ensure you have at least node 18 and npm 8 installed.

To test components locally

1. Navigate to the components package e.g. cd components
2. Run npm install to install dependencies
3. Run npm run build:watch from the root components directory. watch enables you to apply changes without needing to rebuild when testing locally.
4. Edit the root index.html file to create and edit prompts
5. If you are using VS Code you can use Live Server to serve the root index.html file and visualise your prompt components

To publish a new version of the package

1. Make the changes you require
2. Test those changes locally (see section above)
3. Manually upgrade the version of the package in package.json
4. Run npm run build to build and package your latest changes
5. Run npm publish (validate the changes were deployed successful based on the message in the terminal)
6. To use your new changes in any package that uses the Components package you need to upgrade the version to the one you just published

Adding new components

1. Create the new components in the src/components folder.
2. Export your component in src/index.ts