What's Changed

• add -methodTreeShake flag by @pkieltyka in #411

Full Changelog: v0.31.2...v0.31.3

Docker

docker pull ghcr.io/webrpc/webrpc-gen:v0.31.3

Example: docker run -v $PWD:$PWD ghcr.io/webrpc/webrpc-gen:v0.31.3 -schema=$PWD/api.ridl -target=golang

Homebrew

brew tap webrpc/tap
brew install webrpc-gen

Build from source

go install -ldflags="-s -w -X github.com/webrpc/webrpc.VERSION=v0.31.3" github.com/webrpc/webrpc/cmd/webrpc-gen@v0.31.3

Download binaries

macOS: amd64, arm64 (Apple Silicon)
Linux: amd64, arm64
Windows: amd64, arm64

Full Changelog: v0.31.1...v0.31.2

Docker

docker pull ghcr.io/webrpc/webrpc-gen:v0.31.2

Example: docker run -v $PWD:$PWD ghcr.io/webrpc/webrpc-gen:v0.31.2 -schema=$PWD/api.ridl -target=golang

Homebrew

brew tap webrpc/tap
brew install webrpc-gen

Build from source

go install -ldflags="-s -w -X github.com/webrpc/webrpc.VERSION=v0.31.2" github.com/webrpc/webrpc/cmd/webrpc-gen@v0.31.2

Download binaries

macOS: amd64, arm64 (Apple Silicon)
Linux: amd64, arm64
Windows: amd64, arm64

What's Changed

• Bump hono from 4.10.1 to 4.10.3 in /_examples/node-ts/server-hono by @dependabot[bot] in #399
• Update to gen-golang@v0.23.2 by @VojtechVitek in #407
  • Remove server-only methods from client code by @VojtechVitek in webrpc/gen-golang#103
  • Improve WebrpcMethods(): Use pointer receivers, remove elem copying by @VojtechVitek in webrpc/gen-golang#104
  • Generate schema types only if server/client opts are disabled by @VojtechVitek in webrpc/gen-golang#102

Full Changelog: v0.31.0...v0.31.1

What's Changed

• Add new -schemaVersion= option to override schema version by @VojtechVitek in #404
  • Example:

    webrpc-gen -target=... -schemaVersion=v25.11.7-{sha} ...

  • Alternatively the value can be injected via $WEBRPC_SCHEMA_VERSION env var. This is useful for webrpc-gen used in //go:generate directive. Example:

    export WEBRPC_SCHEMA_VERSION=$(git log -1 --date=format:'%y.%-m.%-d' --format='v%ad-%h' ./proto/*.ridl)
    webrpc-gen -target=... # same as -schemaVersion=v25.11.7-{sha}

• Remove backward-compatibility with old webrpc-gen v0.6.0 templates by @VojtechVitek in #405
• Remove compatibility with deprecated v0.8.0 templates by @VojtechVitek in #406

Full Changelog: v0.30.5...v0.31.0

What's Changed

• Update to gen-typescript@v0.22.5 by @VojtechVitek in #403

Full Changelog: v0.30.4...v0.30.5

What's Changed

• Update to gen-typescript@v0.22.4 to hotfix Webrpc header key by @VojtechVitek in #402

Full Changelog: v0.30.3...v0.30.4

There's a bug in this release. Please don't use it.

What's Changed

• Update to gen-typescript@v0.22.3 and gen-openapi@v0.16.4 by @VojtechVitek in #400
• Update deps by @VojtechVitek in #401
• Fixes Webrpc client header in Typescript client, see webrpc/gen-typescript#47

Full Changelog: v0.30.2...v0.30.3

What's Changed

• Add comment about min supported ES version by @AlexanderKolberg in #398

New Contributors

• @AlexanderKolberg made their first contribution in #398

Full Changelog: v0.30.1...v0.30.2

Docker

docker pull ghcr.io/webrpc/webrpc-gen:v0.30.2

Example: docker run -v $PWD:$PWD ghcr.io/webrpc/webrpc-gen:v0.30.2 -schema=$PWD/api.ridl -target=golang

Homebrew

brew tap webrpc/tap
brew install webrpc-gen

Build from source

go install -ldflags="-s -w -X github.com/webrpc/webrpc.VERSION=v0.30.2" github.com/webrpc/webrpc/cmd/webrpc-gen@v0.30.2

Download binaries

macOS: amd64, arm64 (Apple Silicon)
Linux: amd64, arm64
Windows: amd64, arm64

Tiny update to offer graceful handling of bigint represented as numbers in JSON. See webrpc/gen-golang#100

Clients can now pass the bigint value in JSON as either a number or as a numbered string to a Go server. However, its always encoded as a numbered string.

TLDR

1. native bigint support for both Go and TS!
2. add support for "query keys" in TS generator, handy for react query / swr (see https://github.com/webrpc/gen-typescript/releases/tag/v0.21.0)

See https://github.com/webrpc/webrpc/tree/v0.30.0/_examples/node-ts example

Details

bigint

The v0.30.0 release of webrpc, together with the release of gen-golang@v0.23.0 and gen-typescript@v0.22.0 introduce native bigint type support for webrpc, for Go and Typescript server+clients.

webrpc = v1
version = v1
struct User
  address: bigint
  name: string

How does it work? You can just use bigint as a type in the webrpc schema. Over the wire as JSON, it will encode the bigints as a string, and then server and clients at runtime encode/decode the data to a native bigint type.

For Go, we introduce a type BigInt big.Int to add marshalling support. NOTE: you can still use + go.field.type = prototyp.BigInt or whatever custom bigint type on Go side like we did in the past, but now on the Web browser it'll be a bigint too. For example..

struct User
  - address: bigint
    + go.field.type = prototyp.BigInt # app's custom bigint type
  - name: string

For TS, we use the native bigint type available in browsers and nodejs. We have highly efficient encoder/decoders which based on schema definition will run optimized code to convert from string to bigint.

Of course, if you don't use bigints in your schema, then they won't be used, and generated helpers won't be included either.

Query Keys for React Query / SWR

The typescript generated client now includes a queryKey property with type-safe query key generators for each endpoint. This makes it easy to use with popular data-fetching libraries like tanstack query and Vercel's SWR

import { useQuery } from '@tanstack/react-query'
import { Example } from './client.gen'
const client = new Example('https://localhost:3000', fetch)
function UserProfile({ userId }) {
  const { data } = useQuery({
    queryKey: client.queryKey.getUser({ userId }),
    queryFn: ({ signal }) => client.getUser({ userId }, undefined, signal)
  })
  return <div>{data?.user.name}</div>
}