@appcues/flow-builder-api-client v6.2.0

Flow Builder Api Client

The typedoc documentation for this client can be found here

Testing The Client Locally Before Publishing To NPM

If you'd like to test the client in another project prior to publishing it, you can use NPM's link command.

1. Make sure you are using the same versions of node in BOTH repositories (use whatever version is the lowest). You can switch to a specific version of node by running nvm use NODE_VERSION.

2. Once the node versions are in sync, run npm run build which will build the latest code in the dist folder. Then run npm link in this repository, which will create a local symlink for @appcues/flow-builder-api-client to this repository. This symlink is created in nvm's folder for the specific node version you are using, which is why it's important that both projects are using the same version of node.

3. Let's say you would like to test your local flow-builder-api-client in Repository A. With your terminal opened to Repository A, run npm link @appcues/flow-builder-api-client. Two ways to confirm this has worked is:

Your terminal will print out the symlink from Repository A --> your local flow-builder-api-client folder You can view the node_modules/@appcues/flow-builder-api-client in Repository A which should reflect the latest local changes.

Once these steps are completed in order you should have the latest up to date version of your local flow-builder-api-client in the linked repo. Once you finish testing be sure to npm unlink on your repos

Updating the spec and client

1. Make your changes to the spec file
2. Rebuild the client with npm run build
3. Update the src/wrapper.ts to include the new client methods
4. Commit your changes to client (src/gen_client/api.ts). This will run the pre-commit hook, which runs the test suite.
5. After test suite passes and the PR is approved, follow instructions below to version, merge and publish

How to publish to npm

Here are some steps you should follow to publish the flow-builder-api-client to npm

1. Version bump: can be done by running npm version minor or npm version major depending on the caliber of your change. Make sure commit this change to your branch before merging master so you can have this in the master branch when publishing.

2. Merge Master: can be done by merging a PR through github. After merging be sure to git checkout master and git pull in order to get the latest code in order to keep the master branch as the source of truth when publishing to npm.

3. Publish: can be done by running npm publish. NOTE: you must have an NPM_TOKEN with publishing rights

Once these steps are done in order you should have the most up to date version of flow-builder-api-client published on npm.