@alis-build/alis-open-validation-v1 1.13.0 → 1.14.0

package/alis/open/validation/v1/test_pb.d.ts

@@ -1,7 +1,30 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/validation/v1/test.proto (package alis.open.validation.v1, syntax proto3)
 /* eslint-disable */
 
+// Checks protobuf messages against the validation rules of the service that
+// uses them, and lists those rules.
+//
+// `ValidationService` defines two RPCs:
+//
+// - `ValidateMessage` takes a message type name and the message as bytes, and
+//   returns the rules it violates (`Rule`) and the violations per field
+//   (`FieldViolation`). `field_paths` limits validation to some fields.
+// - `RetrieveRules` returns the rules that apply to a message type.
+//
+// Other services expose the same two RPCs with these request and response
+// messages, for example `alis.open.iam.v1.UsersService`, so that clients can
+// validate messages, most commonly requests built by a client-side
+// application, and read the service's validation rules as live
+// documentation.
+//
+// A `Rule` is identified by an expression-like `id`, such as
+// `length(F(name), I(1), I(64))`, and has a plain-language `description`, the
+// field paths it evaluates together, and any nested rules.
+//
+// `BookService` and `Book` in `test.proto` are a sample API for testing, not
+// part of the validation contract.
+
 import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 import type { Date, DateJson } from "@alis-build/google-type/google/type/date_pb.js";
@@ -13,80 +36,114 @@ import type { EmptySchema, FieldMask, FieldMaskJson, Timestamp, TimestampJson }
 export declare const file_alis_open_validation_v1_test: GenFile;
 
 /**
+ * Definition of a Book resource
+ *
  * @generated from message alis.open.validation.v1.Book
  */
 export declare type Book = Message<"alis.open.validation.v1.Book"> & {
   /**
+   * The name of the Book.
+   * Format: "books/*".
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The display name of the Book.
+   *
    * @generated from field: string display_name = 2;
    */
   displayName: string;
 
   /**
+   * The author of the Book.
+   *
    * @generated from field: string author = 3;
    */
   author: string;
 
   /**
+   * The publication date of the Book.
+   *
    * @generated from field: google.type.Date publication_date = 4;
    */
   publicationDate?: Date | undefined;
 
   /**
+   * The last time the Book was updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 5;
    */
   updateTime?: Timestamp | undefined;
 
   /**
+   * The page count of the Book.
+   *
    * @generated from field: int32 page_count = 6;
    */
   pageCount: number;
 
   /**
+   * The type of the Book.
+   *
    * @generated from field: alis.open.validation.v1.Type type = 7;
    */
   type: Type;
 };
 
 /**
+ * Definition of a Book resource
+ *
  * @generated from message alis.open.validation.v1.Book
  */
 export declare type BookJson = {
   /**
+   * The name of the Book.
+   * Format: "books/*".
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The display name of the Book.
+   *
    * @generated from field: string display_name = 2;
    */
   displayName?: string;
 
   /**
+   * The author of the Book.
+   *
    * @generated from field: string author = 3;
    */
   author?: string;
 
   /**
+   * The publication date of the Book.
+   *
    * @generated from field: google.type.Date publication_date = 4;
    */
   publicationDate?: DateJson;
 
   /**
+   * The last time the Book was updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 5;
    */
   updateTime?: TimestampJson;
 
   /**
+   * The page count of the Book.
+   *
    * @generated from field: int32 page_count = 6;
    */
   pageCount?: number;
 
   /**
+   * The type of the Book.
+   *
    * @generated from field: alis.open.validation.v1.Type type = 7;
    */
   type?: TypeJson;
@@ -99,30 +156,48 @@ export declare type BookJson = {
 export declare const BookSchema: GenMessage<Book, {jsonType: BookJson}>;
 
 /**
+ * The request message for the GetBook method
+ *
  * @generated from message alis.open.validation.v1.GetBookRequest
  */
 export declare type GetBookRequest = Message<"alis.open.validation.v1.GetBookRequest"> & {
   /**
+   * The name of the Book to retrieve.
+   * Format: "books/*"
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * e.g. &field_mask.FieldMask{Paths: []string{"name", "display_name"}} --> File{Name, DisplayName}
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMask | undefined;
 };
 
 /**
+ * The request message for the GetBook method
+ *
  * @generated from message alis.open.validation.v1.GetBookRequest
  */
 export declare type GetBookRequestJson = {
   /**
+   * The name of the Book to retrieve.
+   * Format: "books/*"
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * e.g. &field_mask.FieldMask{Paths: []string{"name", "display_name"}} --> File{Name, DisplayName}
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 2;
    */
   readMask?: FieldMaskJson;
@@ -135,20 +210,28 @@ export declare type GetBookRequestJson = {
 export declare const GetBookRequestSchema: GenMessage<GetBookRequest, {jsonType: GetBookRequestJson}>;
 
 /**
+ * The request message for the CreateBook method
+ *
  * @generated from message alis.open.validation.v1.CreateBookRequest
  */
 export declare type CreateBookRequest = Message<"alis.open.validation.v1.CreateBookRequest"> & {
   /**
+   * The Book to create.
+   *
    * @generated from field: alis.open.validation.v1.Book book = 2;
    */
   book?: Book | undefined;
 };
 
 /**
+ * The request message for the CreateBook method
+ *
  * @generated from message alis.open.validation.v1.CreateBookRequest
  */
 export declare type CreateBookRequestJson = {
   /**
+   * The Book to create.
+   *
    * @generated from field: alis.open.validation.v1.Book book = 2;
    */
   book?: BookJson;
@@ -161,30 +244,44 @@ export declare type CreateBookRequestJson = {
 export declare const CreateBookRequestSchema: GenMessage<CreateBookRequest, {jsonType: CreateBookRequestJson}>;
 
 /**
+ * The request message for the UpdateBook method
+ *
  * @generated from message alis.open.validation.v1.UpdateBookRequest
  */
 export declare type UpdateBookRequest = Message<"alis.open.validation.v1.UpdateBookRequest"> & {
   /**
+   * The Book to update.
+   * The Book's `name` field is used to identify the Book to update.
+   *
    * @generated from field: alis.open.validation.v1.Book book = 1;
    */
   book?: Book | undefined;
 
   /**
+   * The list of fields to update.
+   *
    * @generated from field: google.protobuf.FieldMask update_mask = 2;
    */
   updateMask?: FieldMask | undefined;
 };
 
 /**
+ * The request message for the UpdateBook method
+ *
  * @generated from message alis.open.validation.v1.UpdateBookRequest
  */
 export declare type UpdateBookRequestJson = {
   /**
+   * The Book to update.
+   * The Book's `name` field is used to identify the Book to update.
+   *
    * @generated from field: alis.open.validation.v1.Book book = 1;
    */
   book?: BookJson;
 
   /**
+   * The list of fields to update.
+   *
    * @generated from field: google.protobuf.FieldMask update_mask = 2;
    */
   updateMask?: FieldMaskJson;
@@ -197,20 +294,30 @@ export declare type UpdateBookRequestJson = {
 export declare const UpdateBookRequestSchema: GenMessage<UpdateBookRequest, {jsonType: UpdateBookRequestJson}>;
 
 /**
+ * The request message for the DeleteBook method
+ *
  * @generated from message alis.open.validation.v1.DeleteBookRequest
  */
 export declare type DeleteBookRequest = Message<"alis.open.validation.v1.DeleteBookRequest"> & {
   /**
+   * The name of the Book to delete.
+   * Format: "books/*"
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 };
 
 /**
+ * The request message for the DeleteBook method
+ *
  * @generated from message alis.open.validation.v1.DeleteBookRequest
  */
 export declare type DeleteBookRequestJson = {
   /**
+   * The name of the Book to delete.
+   * Format: "books/*"
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
@@ -223,40 +330,74 @@ export declare type DeleteBookRequestJson = {
 export declare const DeleteBookRequestSchema: GenMessage<DeleteBookRequest, {jsonType: DeleteBookRequestJson}>;
 
 /**
+ * The request message for the ListBooks method
+ *
  * @generated from message alis.open.validation.v1.ListBooksRequest
  */
 export declare type ListBooksRequest = Message<"alis.open.validation.v1.ListBooksRequest"> & {
   /**
+   * The maximum number of Books to return. The service may return fewer than
+   * this value.
+   * If unspecified, at most 50 Book will be returned.
+   * The maximum value is 1000; values above 1000 will be coerced to 1000.
+   *
    * @generated from field: int32 page_size = 2;
    */
   pageSize: number;
 
   /**
+   * A page token, received from a previous `ListBooks` call.
+   * Provide this to retrieve the subsequent page.
+   *
+   * When paginating, all other parameters provided to `ListBooks` must match
+   * the call that provided the page token.
+   *
    * @generated from field: string page_token = 3;
    */
   pageToken: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * e.g. &field_mask.FieldMask{Paths: []string{"name", "display_name"}} --> File{Name, DisplayName}
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 4;
    */
   readMask?: FieldMask | undefined;
 };
 
 /**
+ * The request message for the ListBooks method
+ *
  * @generated from message alis.open.validation.v1.ListBooksRequest
  */
 export declare type ListBooksRequestJson = {
   /**
+   * The maximum number of Books to return. The service may return fewer than
+   * this value.
+   * If unspecified, at most 50 Book will be returned.
+   * The maximum value is 1000; values above 1000 will be coerced to 1000.
+   *
    * @generated from field: int32 page_size = 2;
    */
   pageSize?: number;
 
   /**
+   * A page token, received from a previous `ListBooks` call.
+   * Provide this to retrieve the subsequent page.
+   *
+   * When paginating, all other parameters provided to `ListBooks` must match
+   * the call that provided the page token.
+   *
    * @generated from field: string page_token = 3;
    */
   pageToken?: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * e.g. &field_mask.FieldMask{Paths: []string{"name", "display_name"}} --> File{Name, DisplayName}
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 4;
    */
   readMask?: FieldMaskJson;
@@ -269,40 +410,62 @@ export declare type ListBooksRequestJson = {
 export declare const ListBooksRequestSchema: GenMessage<ListBooksRequest, {jsonType: ListBooksRequestJson}>;
 
 /**
+ * The response message for the ListBooks method
+ *
  * @generated from message alis.open.validation.v1.ListBooksResponse
  */
 export declare type ListBooksResponse = Message<"alis.open.validation.v1.ListBooksResponse"> & {
   /**
+   * The list of Books returned
+   *
    * @generated from field: repeated alis.open.validation.v1.Book books = 1;
    */
   books: Book[];
 
   /**
+   * A token, which can be sent as `page_token` to retrieve the next page.
+   * If this field is omitted, there are no subsequent pages.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * e.g. &field_mask.FieldMask{Paths: []string{"name", "display_name"}} --> File{Name, DisplayName}
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 3;
    */
   readMask?: FieldMask | undefined;
 };
 
 /**
+ * The response message for the ListBooks method
+ *
  * @generated from message alis.open.validation.v1.ListBooksResponse
  */
 export declare type ListBooksResponseJson = {
   /**
+   * The list of Books returned
+   *
    * @generated from field: repeated alis.open.validation.v1.Book books = 1;
    */
   books?: BookJson[];
 
   /**
+   * A token, which can be sent as `page_token` to retrieve the next page.
+   * If this field is omitted, there are no subsequent pages.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken?: string;
 
   /**
+   * The fields to return in snake_case, as defined in the proto
+   * e.g. &field_mask.FieldMask{Paths: []string{"name", "display_name"}} --> File{Name, DisplayName}
+   * All fields are returned if not provided
+   *
    * @generated from field: google.protobuf.FieldMask read_mask = 3;
    */
   readMask?: FieldMaskJson;
@@ -315,31 +478,43 @@ export declare type ListBooksResponseJson = {
 export declare const ListBooksResponseSchema: GenMessage<ListBooksResponse, {jsonType: ListBooksResponseJson}>;
 
 /**
+ * The type of a Book.
+ *
  * @generated from enum alis.open.validation.v1.Type
  */
 export enum Type {
   /**
+   * Not set. The default value; should not be used.
+   *
    * @generated from enum value: TYPE_UNSPECIFIED = 0;
    */
   TYPE_UNSPECIFIED = 0,
 
   /**
+   * An anonymous book.
+   *
    * @generated from enum value: ANONYMOUS = 1;
    */
   ANONYMOUS = 1,
 
   /**
+   * A children's book.
+   *
    * @generated from enum value: CHILDREN = 2;
    */
   CHILDREN = 2,
 
   /**
+   * A book for adults.
+   *
    * @generated from enum value: ADULT = 3;
    */
   ADULT = 3,
 }
 
 /**
+ * The type of a Book.
+ *
  * @generated from enum alis.open.validation.v1.Type
  */
 export declare type TypeJson = "TYPE_UNSPECIFIED" | "ANONYMOUS" | "CHILDREN" | "ADULT";
@@ -350,10 +525,15 @@ export declare type TypeJson = "TYPE_UNSPECIFIED" | "ANONYMOUS" | "CHILDREN" | "
 export declare const TypeSchema: GenEnum<Type, TypeJson>;
 
 /**
+ * A sample book API defined for testing. It is not part of the validation
+ * contract.
+ *
  * @generated from service alis.open.validation.v1.BookService
  */
 export declare const BookService: GenService<{
   /**
+   * Get a Book resource
+   *
    * @generated from rpc alis.open.validation.v1.BookService.GetBook
    */
   getBook: {
@@ -362,6 +542,8 @@ export declare const BookService: GenService<{
     output: typeof BookSchema;
   },
   /**
+   * Create a new Book resource
+   *
    * @generated from rpc alis.open.validation.v1.BookService.CreateBook
    */
   createBook: {
@@ -370,6 +552,8 @@ export declare const BookService: GenService<{
     output: typeof BookSchema;
   },
   /**
+   * Update a Book resource
+   *
    * @generated from rpc alis.open.validation.v1.BookService.UpdateBook
    */
   updateBook: {
@@ -378,6 +562,8 @@ export declare const BookService: GenService<{
     output: typeof BookSchema;
   },
   /**
+   * Delete a Book
+   *
    * @generated from rpc alis.open.validation.v1.BookService.DeleteBook
    */
   deleteBook: {
@@ -386,6 +572,8 @@ export declare const BookService: GenService<{
     output: typeof EmptySchema;
   },
   /**
+   * Lists Book resources
+   *
    * @generated from rpc alis.open.validation.v1.BookService.ListBooks
    */
   listBooks: {

package/alis/open/validation/v1/test_pb.js

@@ -1,7 +1,30 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/validation/v1/test.proto (package alis.open.validation.v1, syntax proto3)
 /* eslint-disable */
 
+// Checks protobuf messages against the validation rules of the service that
+// uses them, and lists those rules.
+//
+// `ValidationService` defines two RPCs:
+//
+// - `ValidateMessage` takes a message type name and the message as bytes, and
+//   returns the rules it violates (`Rule`) and the violations per field
+//   (`FieldViolation`). `field_paths` limits validation to some fields.
+// - `RetrieveRules` returns the rules that apply to a message type.
+//
+// Other services expose the same two RPCs with these request and response
+// messages, for example `alis.open.iam.v1.UsersService`, so that clients can
+// validate messages, most commonly requests built by a client-side
+// application, and read the service's validation rules as live
+// documentation.
+//
+// A `Rule` is identified by an expression-like `id`, such as
+// `length(F(name), I(1), I(64))`, and has a plain-language `description`, the
+// field paths it evaluates together, and any nested rules.
+//
+// `BookService` and `Book` in `test.proto` are a sample API for testing, not
+// part of the validation contract.
+
 import { enumDesc, fileDesc, messageDesc, serviceDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
 import { file_google_type_date } from "@alis-build/google-type/google/type/date_pb.js";
@@ -68,12 +91,17 @@ export const TypeSchema = /*@__PURE__*/
   enumDesc(file_alis_open_validation_v1_test, 0);
 
 /**
+ * The type of a Book.
+ *
  * @generated from enum alis.open.validation.v1.Type
  */
 export const Type = /*@__PURE__*/
   tsEnum(TypeSchema);
 
 /**
+ * A sample book API defined for testing. It is not part of the validation
+ * contract.
+ *
  * @generated from service alis.open.validation.v1.BookService
  */
 export const BookService = /*@__PURE__*/

package/alis/open/validation/v1/validation_pb.d.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/validation/v1/validation.proto (package alis.open.validation.v1, syntax proto3)
 /* eslint-disable */
 
@@ -11,20 +11,30 @@ import type { Message } from "@bufbuild/protobuf";
 export declare const file_alis_open_validation_v1_validation: GenFile;
 
 /**
+ * Request message for `RetrieveRules`.
+ *
  * @generated from message alis.open.validation.v1.RetrieveRulesRequest
  */
 export declare type RetrieveRulesRequest = Message<"alis.open.validation.v1.RetrieveRulesRequest"> & {
   /**
+   * REQUIRED: The message type to retrieve rules for.
+   * E.g. "alis.os.processes.v1.CreateProcess"
+   *
    * @generated from field: string msg_type = 1;
    */
   msgType: string;
 };
 
 /**
+ * Request message for `RetrieveRules`.
+ *
  * @generated from message alis.open.validation.v1.RetrieveRulesRequest
  */
 export declare type RetrieveRulesRequestJson = {
   /**
+   * REQUIRED: The message type to retrieve rules for.
+   * E.g. "alis.os.processes.v1.CreateProcess"
+   *
    * @generated from field: string msg_type = 1;
    */
   msgType?: string;
@@ -37,20 +47,28 @@ export declare type RetrieveRulesRequestJson = {
 export declare const RetrieveRulesRequestSchema: GenMessage<RetrieveRulesRequest, {jsonType: RetrieveRulesRequestJson}>;
 
 /**
+ * Response message for `RetrieveRules`.
+ *
  * @generated from message alis.open.validation.v1.RetrieveRulesResponse
  */
 export declare type RetrieveRulesResponse = Message<"alis.open.validation.v1.RetrieveRulesResponse"> & {
   /**
+   * The rules for the message type.
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule rules = 1;
    */
   rules: Rule[];
 };
 
 /**
+ * Response message for `RetrieveRules`.
+ *
  * @generated from message alis.open.validation.v1.RetrieveRulesResponse
  */
 export declare type RetrieveRulesResponseJson = {
   /**
+   * The rules for the message type.
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule rules = 1;
    */
   rules?: RuleJson[];
@@ -63,40 +81,60 @@ export declare type RetrieveRulesResponseJson = {
 export declare const RetrieveRulesResponseSchema: GenMessage<RetrieveRulesResponse, {jsonType: RetrieveRulesResponseJson}>;
 
 /**
+ * Request message for `ValidateMessage`.
+ *
  * @generated from message alis.open.validation.v1.ValidateMessageRequest
  */
 export declare type ValidateMessageRequest = Message<"alis.open.validation.v1.ValidateMessageRequest"> & {
   /**
+   * REQUIRED: The message type to validate.
+   * E.g. "alis.os.processes.v1.CreateProcess"
+   *
    * @generated from field: string msg_type = 1;
    */
   msgType: string;
 
   /**
+   * REQUIRED: The msg to validate
+   *
    * @generated from field: bytes msg = 2;
    */
   msg: Uint8Array;
 
   /**
+   * Optional list of fields to validate. If empty, all fields will be validated.
+   * If a rule contains more than one field_path, all field_paths must be in this list for the rule to be applied.
+   *
    * @generated from field: repeated string field_paths = 3;
    */
   fieldPaths: string[];
 };
 
 /**
+ * Request message for `ValidateMessage`.
+ *
  * @generated from message alis.open.validation.v1.ValidateMessageRequest
  */
 export declare type ValidateMessageRequestJson = {
   /**
+   * REQUIRED: The message type to validate.
+   * E.g. "alis.os.processes.v1.CreateProcess"
+   *
    * @generated from field: string msg_type = 1;
    */
   msgType?: string;
 
   /**
+   * REQUIRED: The msg to validate
+   *
    * @generated from field: bytes msg = 2;
    */
   msg?: string;
 
   /**
+   * Optional list of fields to validate. If empty, all fields will be validated.
+   * If a rule contains more than one field_path, all field_paths must be in this list for the rule to be applied.
+   *
    * @generated from field: repeated string field_paths = 3;
    */
   fieldPaths?: string[];
@@ -109,30 +147,42 @@ export declare type ValidateMessageRequestJson = {
 export declare const ValidateMessageRequestSchema: GenMessage<ValidateMessageRequest, {jsonType: ValidateMessageRequestJson}>;
 
 /**
+ * Response message for `ValidateMessage`.
+ *
  * @generated from message alis.open.validation.v1.ValidateMessageResponse
  */
 export declare type ValidateMessageResponse = Message<"alis.open.validation.v1.ValidateMessageResponse"> & {
   /**
+   * The list of rules violated
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule violated_rules = 1;
    */
   violatedRules: Rule[];
 
   /**
+   * The list of fields with violations
+   *
    * @generated from field: repeated alis.open.validation.v1.FieldViolation violated_fields = 2;
    */
   violatedFields: FieldViolation[];
 };
 
 /**
+ * Response message for `ValidateMessage`.
+ *
  * @generated from message alis.open.validation.v1.ValidateMessageResponse
  */
 export declare type ValidateMessageResponseJson = {
   /**
+   * The list of rules violated
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule violated_rules = 1;
    */
   violatedRules?: RuleJson[];
 
   /**
+   * The list of fields with violations
+   *
    * @generated from field: repeated alis.open.validation.v1.FieldViolation violated_fields = 2;
    */
   violatedFields?: FieldViolationJson[];
@@ -145,50 +195,90 @@ export declare type ValidateMessageResponseJson = {
 export declare const ValidateMessageResponseSchema: GenMessage<ValidateMessageResponse, {jsonType: ValidateMessageResponseJson}>;
 
 /**
+ * A validation rule over one or more fields of a message, possibly composed of
+ * nested rules.
+ *
  * @generated from message alis.open.validation.v1.Rule
  */
 export declare type Rule = Message<"alis.open.validation.v1.Rule"> & {
   /**
+   * Unique identifier for the rule which reads like code
+   * Examples:
+   * regex(F(name), S("^[a-z][a-z0-9_]*$"))
+   * length(F(name), I(1), I(64))
+   * or(regex(name, "^[a-z][a-z0-9_]*$"), regex(name, "^[A-Z][A-Z0-9_]*$"))
+   * not(regex(name, "^[a-z][a-z0-9_]*$")).if(e-eq(state,"ACTIVE"))
+   * and(regex(name, "^[a-z][a-z0-9_]*$"), length(name, 1, 64))
+   * nested(subm,update_mask)
+   *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
+   * Clear description of the rule that can be understood by non-technical users.
+   *
    * @generated from field: string description = 2;
    */
   description: string;
 
   /**
+   * The field_paths that are evaluated together to determine if the rule is met.
+   * For most cases, this will be a single field_path.
+   * An example of a rule with multiple field paths is a rule that requires that the sum of two fields is less than a third field.
+   *
    * @generated from field: repeated string field_paths = 3;
    */
   fieldPaths: string[];
 
   /**
+   * A list of nested rules that this rule consists of.
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule nested_rules = 4;
    */
   nestedRules: Rule[];
 };
 
 /**
+ * A validation rule over one or more fields of a message, possibly composed of
+ * nested rules.
+ *
  * @generated from message alis.open.validation.v1.Rule
  */
 export declare type RuleJson = {
   /**
+   * Unique identifier for the rule which reads like code
+   * Examples:
+   * regex(F(name), S("^[a-z][a-z0-9_]*$"))
+   * length(F(name), I(1), I(64))
+   * or(regex(name, "^[a-z][a-z0-9_]*$"), regex(name, "^[A-Z][A-Z0-9_]*$"))
+   * not(regex(name, "^[a-z][a-z0-9_]*$")).if(e-eq(state,"ACTIVE"))
+   * and(regex(name, "^[a-z][a-z0-9_]*$"), length(name, 1, 64))
+   * nested(subm,update_mask)
+   *
    * @generated from field: string id = 1;
    */
   id?: string;
 
   /**
+   * Clear description of the rule that can be understood by non-technical users.
+   *
    * @generated from field: string description = 2;
    */
   description?: string;
 
   /**
+   * The field_paths that are evaluated together to determine if the rule is met.
+   * For most cases, this will be a single field_path.
+   * An example of a rule with multiple field paths is a rule that requires that the sum of two fields is less than a third field.
+   *
    * @generated from field: repeated string field_paths = 3;
    */
   fieldPaths?: string[];
 
   /**
+   * A list of nested rules that this rule consists of.
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule nested_rules = 4;
    */
   nestedRules?: RuleJson[];
@@ -201,30 +291,42 @@ export declare type RuleJson = {
 export declare const RuleSchema: GenMessage<Rule, {jsonType: RuleJson}>;
 
 /**
+ * The validation rules that a single field violates.
+ *
  * @generated from message alis.open.validation.v1.FieldViolation
  */
 export declare type FieldViolation = Message<"alis.open.validation.v1.FieldViolation"> & {
   /**
+   * The field path that has a violation
+   *
    * @generated from field: string field_path = 1;
    */
   fieldPath: string;
 
   /**
+   * The rules that were violated on this field
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule violated_rules = 2;
    */
   violatedRules: Rule[];
 };
 
 /**
+ * The validation rules that a single field violates.
+ *
  * @generated from message alis.open.validation.v1.FieldViolation
  */
 export declare type FieldViolationJson = {
   /**
+   * The field path that has a violation
+   *
    * @generated from field: string field_path = 1;
    */
   fieldPath?: string;
 
   /**
+   * The rules that were violated on this field
+   *
    * @generated from field: repeated alis.open.validation.v1.Rule violated_rules = 2;
    */
   violatedRules?: RuleJson[];
@@ -237,10 +339,15 @@ export declare type FieldViolationJson = {
 export declare const FieldViolationSchema: GenMessage<FieldViolation, {jsonType: FieldViolationJson}>;
 
 /**
+ * Validates protobuf messages against their validation rules and returns
+ * those rules.
+ *
  * @generated from service alis.open.validation.v1.ValidationService
  */
 export declare const ValidationService: GenService<{
   /**
+   * Retrieve the validation rules for a given message type.
+   *
    * @generated from rpc alis.open.validation.v1.ValidationService.RetrieveRules
    */
   retrieveRules: {
@@ -249,6 +356,9 @@ export declare const ValidationService: GenService<{
     output: typeof RetrieveRulesResponseSchema;
   },
   /**
+   * Validates if the given bytes are valid for the given message type.
+   * If the bytes cannot be marshalled into the message type, the rpc will return an error instead of the violations.
+   *
    * @generated from rpc alis.open.validation.v1.ValidationService.ValidateMessage
    */
   validateMessage: {

package/alis/open/validation/v1/validation_pb.js

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/open/validation/v1/validation.proto (package alis.open.validation.v1, syntax proto3)
 /* eslint-disable */
 
@@ -53,6 +53,9 @@ export const FieldViolationSchema = /*@__PURE__*/
   messageDesc(file_alis_open_validation_v1_validation, 5);
 
 /**
+ * Validates protobuf messages against their validation rules and returns
+ * those rules.
+ *
  * @generated from service alis.open.validation.v1.ValidationService
  */
 export const ValidationService = /*@__PURE__*/

package/package.json

@@ -25,5 +25,5 @@
   },
   "type": "module",
   "types": "./index.d.ts",
-  "version": "1.13.0"
+  "version": "1.14.0"
 }