API Reference

This section documents the public APIs of soda-gql packages.

Work in Progress

API documentation is being developed. Some sections may be incomplete.

Packages

soda-gql is a monorepo with multiple packages. Here's an overview:

Core Packages

PackageDescription
@soda-gql/coreCore GraphQL types, utilities, and primitives
@soda-gql/runtimeRuntime execution helpers and adapters
@soda-gql/cliCommand-line interface for codegen
@soda-gql/configConfiguration utilities

Build Plugins

PackageDescription
@soda-gql/babel-pluginBabel transformation plugin
@soda-gql/tsc-pluginTypeScript compiler plugin
@soda-gql/webpack-pluginWebpack integration with HMR
@soda-gql/vite-pluginVite bundler plugin
@soda-gql/metro-pluginReact Native / Expo Metro plugin

Internal Packages

PackageDescription
@soda-gql/codegenSchema code generation
@soda-gql/builderStatic analysis and artifact generation
@soda-gql/commonShared utilities
@soda-gql/plugin-commonShared plugin utilities

Version Compatibility

soda-gql is currently at v0.1.0 (pre-release). APIs may change between minor versions. Once we reach v1.0.0, we will follow semantic versioning strictly.