Compatibility

Check runtime, React, and Ovok API requirements before integrating the SDK.

  • Stable unknown
  • Release candidate since 0.4.49-rc.2
  • Development since 0.4.49-dev.493+062a3db

Runtime

The package publishes CommonJS JavaScript and TypeScript declarations. The runtime must provide fetch, or the client must receive a compatible fetch implementation through its configuration. The SDK supports browsers, Node, and React Native environments that meet these requirements.

React

The framework-independent Ovok client is imported from @ovok/core. The optional React peer is used by the separate @ovok/core/react entry. Use the host application's React installation so providers and components share the same runtime.

In server-rendered applications, create user-specific clients in the correct request scope. Machine clientSecret values are server-only and are rejected in browser environments.

Ovok API compatibility

The SDK calls the Ovok API configured by baseUrl. API availability, project settings, identity, and permissions are controlled by that environment. A method compiling successfully does not mean the current user is authorized or that a project feature is enabled.

Match the SDK version to the backend release that provides the operations your application uses. Check the Ovok API documentation for request and authorization requirements.

Package entries

  • @ovok/core is the client entry.
  • @ovok/core/react provides React components and hooks.
  • @ovok/core/next and @ovok/core/next/react are deprecated aliases of the two, kept for one release.

See also

Last updated on

On this page