Skip to content
DocsOpen Hub
Build web apps

Client SDKs and app updates

On this page

Cloudgate provides a JavaScript/TypeScript client SDK and a React SDK for application integration. Use the package that matches your app and its generated template rather than mixing setup instructions from different packages.

Select the package#

Package Role
@cloudgatedevs/cloudgate-client JavaScript/TypeScript client integration, including gateway requests and supported session/connection features
@cloudgatedevs/cloudgate-client-react React application integration and Cloudgate platform features

For a code app, inspect its existing package.json, lockfile, and template configuration first. Follow the installed SDK's exported API and generated app setup for providers, authentication, routing, and API environment selection.

Verify the integration#

Test a real sandbox page request from the browser. An internal sample request may bypass IdP authorization for development testing and can succeed while the browser receives 401.

Check the public route, actual response fields, loading states, empty results, and denied access. The workflow's saved examples are not a guarantee that a create/update form has the correct request schema.

Review an SDK update#

The developer workspace exposes Info & updates for the React SDK. It distinguishes the project dependency, the running version when reported, and available registry updates. Local SDK checkouts and unsupported package-source arrangements need their own update workflow.

For supported non-Git app updates, stop the Build environment and apply pending changes before preparing the update release. The update produces a candidate for normal review; it does not immediately replace the live app.

For Git-connected apps, update and commit package.json and its lockfile in Build, then create a release from the designated branch. The one-click update path directs Git apps to this source-controlled process.

Test compatibility#

Preview login, navigation, API calls, and any SDK-dependent widgets. Check pinned workflow dependencies separately. Rolling back an app artifact restores the earlier build; it does not automatically rewrite the source dependency files.

Need to investigate a problem? Start with troubleshooting