protovalidate-es

Protovalidate provides standard annotations to validate common rules on messages and fields, as well as the ability to use CEL to write custom rules. It's the next generation of protoc-gen-validate, the only widely used validation library for Protobuf.

With Protovalidate, you can annotate your Protobuf messages with both standard and custom validation rules:

syntax = "proto3";

package banking.v1;

import "buf/validate/validate.proto";

message MoneyTransfer {
  string to_account_id = 1 [
    // Standard rule: `to_account_id` must be a UUID.
    (buf.validate.field).string.uuid = true
  ];

  string from_account_id = 2 [
    // Standard rule: `from_account_id` must be a UUID.
    (buf.validate.field).string.uuid = true
  ];

  // Custom rule: `to_account_id` and `from_account_id` can't be the same.
  option (buf.validate.message).cel = {
    id: "to_account_id.not.from_account_id"
    message: "to_account_id and from_account_id should not be the same value"
    expression: "this.to_account_id != this.from_account_id"
  };
}

Once you've added @bufbuild/protovalidate to your project, validation is simple:

import { create } from "@bufbuild/protobuf";
import { createValidator } from "@bufbuild/protovalidate";
import { MoneyTransferSchema } from "./gen/banking_pb";

const transfer = create(MoneyTransferSchema);

const v = createValidator();

try {
  v.validate(MoneyTransferSchema, transfer);
} catch (e) {
  // Handle failure.
}

Packages

• @bufbuild/protovalidate: Validates Protobuf messages at runtime based on user-defined validation rules.

Note that protovalidate-es requires the Protobuf runtime @bufbuild/protobuf.

Additional Languages and Repositories

Protovalidate isn't just for ECMAScript! You might be interested in sibling repositories for other languages:

• protovalidate-go (Go)
• protovalidate-java (Java)
• protovalidate-python (Python)
• protovalidate-cc (C++)

Additionally, protovalidate's core repository provides:

• Protovalidate's Protobuf API
• Example .proto files using protovalidate
• Conformance testing utilities for acceptance testing of protovalidate implementations

Contribution

We genuinely appreciate any help! If you'd like to contribute, check out these resources:

• Contributing Guidelines: Guidelines to make your contribution process straightforward and meaningful
• Conformance testing utilities: Utilities providing acceptance testing of protovalidate implementations
• Protovalidate-ES conformance executor: Conformance testing executor

Related Sites

• Buf: Enterprise-grade Kafka and gRPC for the modern age
• Common Expression Language (CEL): The open-source technology at the core of Protovalidate

Legal

Offered under the Apache 2 license.