Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bufbuild/protobuf-es
Protocol Buffers for ECMAScript. The only JavaScript Protobuf library that is fully-compliant with Protobuf conformance tests.
https://github.com/bufbuild/protobuf-es
javascript protobuf protoc-plugin protocol-buffers schema typescipt
Last synced: about 2 months ago
JSON representation
Protocol Buffers for ECMAScript. The only JavaScript Protobuf library that is fully-compliant with Protobuf conformance tests.
- Host: GitHub
- URL: https://github.com/bufbuild/protobuf-es
- Owner: bufbuild
- License: apache-2.0
- Created: 2022-03-14T14:14:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T22:25:55.000Z (5 months ago)
- Last Synced: 2024-04-14T11:00:33.075Z (5 months ago)
- Topics: javascript, protobuf, protoc-plugin, protocol-buffers, schema, typescipt
- Language: TypeScript
- Homepage:
- Size: 11.3 MB
- Stars: 923
- Watchers: 20
- Forks: 51
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Protobuf-ES
[](./LICENSE) [](https://www.npmjs.com/package/@bufbuild/protobuf) [](https://www.npmjs.com/package/@bufbuild/protoplugin) [](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
A complete implementation of [Protocol Buffers](https://protobuf.dev/) in TypeScript,
suitable for web browsers and Node.js, created by [Buf](https://buf.build).
Protobuf-ES is the only fully-compliant JavaScript Protobuf library that passes the
Protobuf conformance tests—[read more on our blog][blog-post].
Protobuf-ES's companion RPC library is [Connect-ES](https://github.com/connectrpc/connect-es),
which supports the Connect, gRPC, and gRPC-Web protocols.
## What is Protocol Buffers?
In a nutshell, Protocol Buffers (aka Protobuf) has two main functions:
- It's a language for writing schemas for your data.
- It defines a binary format for serializing your data.
These two independent traits work together to allow your project and everyone who interacts with it to define messages,
fields, and service APIs in the exact same way. In a practical sense as it relates to **Protobuf-ES**, this means no
more disparate JSON types all over the place. Instead, you define a common schema in a Protobuf file, such as:
```proto
syntax = "proto3";
message User {
string first_name = 1;
string last_name = 2;
bool active = 3;
User manager = 4;
repeated string locations = 5;
map projects = 6;
}
```
You can then compile it to ECMAScript with `buf` or `protoc`, and use it like this:
```typescript
import { UserSchema } from "./gen/user_pb.js";
import { create, toBinary, toJson } from "@bufbuild/protobuf";
let user = create(UserSchema, {
firstName: "Homer",
lastName: "Simpson",
active: true,
locations: ["Springfield"],
projects: { SPP: "Springfield Power Plant" },
manager: {
firstName: "Montgomery",
lastName: "Burns",
},
});
const bytes = toBinary(UserSchema, user);
const json = toJson(UserSchema, user);
```
The benefits of using Protobuf extend to any application that interacts with yours, because the Protobuf file above
can be used to generate types in many languages. The added bonus is that no one has to write any boilerplate code to
make this happen. [Code generators](https://www.npmjs.com/package/@bufbuild/protoc-gen-es) handle all of this for you.
Protobuf also allows you to serialize this structured data. Your application running in the browser can send
a `User` object to a backend running an entirely different language, but using the exact same definition. Using an RPC
framework like [Connect-ES](https://github.com/connectrpc/connect-es), your data is serialized into bytes on the wire
and then deserialized at its destination using the defined schema.
## Quickstart
1. Install the code generator, the runtime library, and the [Buf CLI](https://buf.build/docs/ecosystem/cli-overview):
```shellsession
npm install @bufbuild/protobuf @bufbuild/protoc-gen-es @bufbuild/buf
```
2. Create a `buf.gen.yaml` file that looks like this:
```yaml
# Learn more: https://buf.build/docs/configuration/v2/buf-gen-yaml
version: v2
inputs:
- directory: proto
plugins:
- local: protoc-gen-es
opt: target=ts
out: src/gen
```
3. Download the [example.proto](packages/protobuf-example/proto/example.proto) into a `proto` directory:
```shellsession
mkdir proto
curl https://raw.githubusercontent.com/bufbuild/protobuf-es/main/packages/protobuf-example/proto/example.proto > proto/example.proto
```
4. Generate your code with `buf` or [`protoc`]:
```shellsession
npx buf generate
```
You should now see a generated file at `src/gen/example_pb.ts` that contains a type `User`, and a schema `UserSchema`.
From here, you can begin to work with your schema.
## Documentation
- [Manual](MANUAL.md) - Explains all aspects of using Protobuf with ECMAScript.
- [Code example](packages/protobuf-example) - Example code that uses Protobuf to manage a persistent list of users.
- [Plugin example](packages/protoplugin-example) - Shows how to write a custom plugin to generate Twirp clients from
Protobuf service definitions.
## Packages
- [@bufbuild/protobuf](https://www.npmjs.com/package/@bufbuild/protobuf):
Provides the runtime library, containing base types, generated well-known types, and core functionality.
- [@bufbuild/protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es):
Provides the code generator plugin `protoc-gen-es`. The code it generates depends on `@bufbuild/protobuf`.
- [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin):
Helps to create your own code generator plugin. The code it generates depends on `@bufbuild/protobuf`.
## Ecosystem
- [Connect-ES](https://github.com/connectrpc/connect-es):
Type-safe APIs with Protobuf and TypeScript
- [Connect-ES examples](https://github.com/connectrpc/examples-es):
Examples for using Connect with various TypeScript web frameworks and tooling
- [protobuf-conformance](https://github.com/bufbuild/protobuf-conformance):
A repository running the Protobuf conformance tests against various libraries.
- [Buf Studio](https://buf.build/studio): Web UI for ad-hoc RPCs
## TypeScript compatibility
The generated code is compatible with TypeScript **v4.9.5** or later, with the default compiler settings.
## Copyright
The [code to encode and decode varint](packages/protobuf/src/wire/varint.ts) is Copyright 2008 Google Inc., licensed
under BSD-3-Clause.
All other files are licensed under Apache-2.0, see [LICENSE](LICENSE).
[blog-post]: https://buf.build/blog/protobuf-conformance
[`protoc`]: MANUAL.md#generate-with-protoc