pbts is a simple pb.go to .ts converter. It converts the protoc generated Golang
definitions for protobuf messages into a Typescript abstract class.
The motivation for pbts is to be able to easily -
- define APIs using protobufs,
- implement the API server using Golang, and
- implement frontend client in Typescript.
The types generated by protoc and pbts respectively will ensure that (<pedantic>some</pedantic>)
breaking API changes will cause compile time errors.
- a
copyfunction is generated to copy data between instances. - following protobuf conventions,
int64types are serialized as strings. - the json field name in a proto field tag is preferred to a json field tag
- proto maps and oneofs are supported
# main.go
writer, _ := os.OpenFile("api.ts", ...)
g := pbts.NewGenerator(writer)
g.RegisterMany(
MyFirstStruct{},
MySecondStruct{},
)
g.Write()
Import the generated classes into your Typescript project for fun and profit.
type TestStruct struct {
Field *string `protobuf:"bytes,1,opt,name=field" json:"field,omitempty"`
FieldInt *int64 `protobuf:"varint,6,opt,name=field_int,json=fieldInt" json:"field_int,omitempty"`
OtherField string `json:"other_field"`
Metadata map[string]int32 `protobuf:"bytes,11,rep,name=metadata" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
Tags []string `protobuf:"bytes,12,rep,name=tags" json:"tags,omitempty"`
}
# api.ts
export abstract class MyFirstStruct {
field?: string;
fieldInt?: string;
other_field?: string;
metadata?: { [key: string]: number; };
tags?: string[];
static copy(from: MyFirstStruct, to?: MyFirstStruct): MyFirstStruct {
to = to || {};
to.field = from.field;
to.fieldInt = from.fieldInt;
to.other_field = from.other_field;
to.metadata = from.metadata;
to.tags = from.tags;
return to;
}
}
...
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent