@alis-build/alis-open-options-v1 1.21.0 → 1.23.0

package/alis/open/options/v1/options_pb.d.ts

@@ -1,7 +1,37 @@
-// @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/options/v1/options.proto (package alis.open.options.v1, syntax proto3)
 /* eslint-disable */
 
+// Custom options that control how alis code generators treat a proto file,
+// currently JSON Schema (Draft 2020-12) generation by
+// `protoc-gen-go-jsonschema`.
+//
+// Three extensions, each at field number 1001 of its descriptor options
+// message, carry the options:
+//
+// - `(alis.open.options.v1.file)` (`FileOptions`): turns schema generation on
+//   for every message in the file.
+// - `(alis.open.options.v1.message)` (`MessageOptions`): overrides the file
+//   default for one message and declares schema-level oneof groups.
+// - `(alis.open.options.v1.field)` (`FieldOptions`): adds JSON Schema keywords
+//   to a field, such as `title`, `pattern`, `format`, numeric and length
+//   bounds, `enum`, `default` and `examples`.
+//
+// ```proto
+// import "alis/open/options/v1/options.proto";
+//
+// option (alis.open.options.v1.file).json_schema.generate = true;
+//
+// message Contact {
+//   string email = 1 [(alis.open.options.v1.field).json_schema = {
+//     format: "email"
+//   }];
+// }
+// ```
+//
+// A message referenced by a generating message is always generated, even if
+// it opts out, so that `$ref` pointers resolve.
+
 import type { GenExtension, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 import type { FieldOptions as FieldOptions$1, FileOptions as FileOptions$1, MessageOptions as MessageOptions$1 } from "@bufbuild/protobuf/wkt";
@@ -12,20 +42,30 @@ import type { FieldOptions as FieldOptions$1, FileOptions as FileOptions$1, Mess
 export declare const file_alis_open_options_v1_options: GenFile;
 
 /**
+ * FileOptions carries file-level options consumed by alis code generators.
+ *
  * @generated from message alis.open.options.v1.FileOptions
  */
 export declare type FileOptions = Message<"alis.open.options.v1.FileOptions"> & {
   /**
+   * Options controlling JSON Schema (Draft 2020-12) generation for this
+   * file, consumed by protoc-gen-go-jsonschema.
+   *
    * @generated from field: alis.open.options.v1.FileOptions.JsonSchema json_schema = 1;
    */
   jsonSchema?: FileOptions_JsonSchema | undefined;
 };
 
 /**
+ * FileOptions carries file-level options consumed by alis code generators.
+ *
  * @generated from message alis.open.options.v1.FileOptions
  */
 export declare type FileOptionsJson = {
   /**
+   * Options controlling JSON Schema (Draft 2020-12) generation for this
+   * file, consumed by protoc-gen-go-jsonschema.
+   *
    * @generated from field: alis.open.options.v1.FileOptions.JsonSchema json_schema = 1;
    */
   jsonSchema?: FileOptions_JsonSchemaJson;
@@ -38,20 +78,34 @@ export declare type FileOptionsJson = {
 export declare const FileOptionsSchema: GenMessage<FileOptions, {jsonType: FileOptionsJson}>;
 
 /**
+ * JsonSchema holds the file-level JSON Schema generation options.
+ *
  * @generated from message alis.open.options.v1.FileOptions.JsonSchema
  */
 export declare type FileOptions_JsonSchema = Message<"alis.open.options.v1.FileOptions.JsonSchema"> & {
   /**
+   * If true, schemas are generated for every message in this file unless a
+   * message explicitly sets its own `generate = false`. Messages referenced
+   * by a generating message (field dependencies and nested messages) are
+   * always generated regardless, so that `$ref` pointers resolve.
+   *
    * @generated from field: bool generate = 1;
    */
   generate: boolean;
 };
 
 /**
+ * JsonSchema holds the file-level JSON Schema generation options.
+ *
  * @generated from message alis.open.options.v1.FileOptions.JsonSchema
  */
 export declare type FileOptions_JsonSchemaJson = {
   /**
+   * If true, schemas are generated for every message in this file unless a
+   * message explicitly sets its own `generate = false`. Messages referenced
+   * by a generating message (field dependencies and nested messages) are
+   * always generated regardless, so that `$ref` pointers resolve.
+   *
    * @generated from field: bool generate = 1;
    */
   generate?: boolean;
@@ -64,20 +118,32 @@ export declare type FileOptions_JsonSchemaJson = {
 export declare const FileOptions_JsonSchemaSchema: GenMessage<FileOptions_JsonSchema, {jsonType: FileOptions_JsonSchemaJson}>;
 
 /**
+ * MessageOptions carries message-level options consumed by alis code
+ * generators.
+ *
  * @generated from message alis.open.options.v1.MessageOptions
  */
 export declare type MessageOptions = Message<"alis.open.options.v1.MessageOptions"> & {
   /**
+   * Options controlling JSON Schema (Draft 2020-12) generation for this
+   * message, consumed by protoc-gen-go-jsonschema.
+   *
    * @generated from field: alis.open.options.v1.MessageOptions.JsonSchema json_schema = 1;
    */
   jsonSchema?: MessageOptions_JsonSchema | undefined;
 };
 
 /**
+ * MessageOptions carries message-level options consumed by alis code
+ * generators.
+ *
  * @generated from message alis.open.options.v1.MessageOptions
  */
 export declare type MessageOptionsJson = {
   /**
+   * Options controlling JSON Schema (Draft 2020-12) generation for this
+   * message, consumed by protoc-gen-go-jsonschema.
+   *
    * @generated from field: alis.open.options.v1.MessageOptions.JsonSchema json_schema = 1;
    */
   jsonSchema?: MessageOptions_JsonSchemaJson;
@@ -90,30 +156,84 @@ export declare type MessageOptionsJson = {
 export declare const MessageOptionsSchema: GenMessage<MessageOptions, {jsonType: MessageOptionsJson}>;
 
 /**
+ * JsonSchema holds the message-level JSON Schema generation options.
+ *
  * @generated from message alis.open.options.v1.MessageOptions.JsonSchema
  */
 export declare type MessageOptions_JsonSchema = Message<"alis.open.options.v1.MessageOptions.JsonSchema"> & {
   /**
+   * Explicitly enables or disables schema generation for this message,
+   * overriding the file-level default. When unset, the file-level default
+   * applies — so setting other options here (such as `oneof`) does not
+   * change whether the message generates. An explicit false is still
+   * overridden when the message is referenced by a generating message (as a
+   * field dependency or nested message): generation is forced so that
+   * `$ref` pointers resolve. `optional` is required for that distinction —
+   * without presence, an explicit false is indistinguishable from unset.
+   *
    * @generated from field: optional bool generate = 1;
    */
   generate?: boolean | undefined;
 
   /**
+   * Declares oneof groups over this message's fields for schema purposes.
+   *
+   * Each entry names a set of fields (by proto field name) that are
+   * mutually exclusive. If `required` is true, exactly one of the listed
+   * fields must be set.
+   *
+   * The referenced names may be members of a proto `oneof` block, or
+   * ordinary singular fields treated as a virtual oneof (the same pattern
+   * as `buf.validate.message.oneof`). Repeated and map fields are not
+   * permitted as members.
+   *
+   * A group may deliberately cover only a subset of a proto `oneof`'s
+   * members: the schema then narrows the contract (like enum_int narrows a
+   * proto enum), and with `required: true` a value that sets an uncovered
+   * variant fails schema validation even though it is a legal proto value.
+   *
    * @generated from field: repeated alis.open.options.v1.MessageOptions.JsonSchema.Oneof oneof = 2;
    */
   oneof: MessageOptions_JsonSchema_Oneof[];
 };
 
 /**
+ * JsonSchema holds the message-level JSON Schema generation options.
+ *
  * @generated from message alis.open.options.v1.MessageOptions.JsonSchema
  */
 export declare type MessageOptions_JsonSchemaJson = {
   /**
+   * Explicitly enables or disables schema generation for this message,
+   * overriding the file-level default. When unset, the file-level default
+   * applies — so setting other options here (such as `oneof`) does not
+   * change whether the message generates. An explicit false is still
+   * overridden when the message is referenced by a generating message (as a
+   * field dependency or nested message): generation is forced so that
+   * `$ref` pointers resolve. `optional` is required for that distinction —
+   * without presence, an explicit false is indistinguishable from unset.
+   *
    * @generated from field: optional bool generate = 1;
    */
   generate?: boolean;
 
   /**
+   * Declares oneof groups over this message's fields for schema purposes.
+   *
+   * Each entry names a set of fields (by proto field name) that are
+   * mutually exclusive. If `required` is true, exactly one of the listed
+   * fields must be set.
+   *
+   * The referenced names may be members of a proto `oneof` block, or
+   * ordinary singular fields treated as a virtual oneof (the same pattern
+   * as `buf.validate.message.oneof`). Repeated and map fields are not
+   * permitted as members.
+   *
+   * A group may deliberately cover only a subset of a proto `oneof`'s
+   * members: the schema then narrows the contract (like enum_int narrows a
+   * proto enum), and with `required: true` a value that sets an uncovered
+   * variant fails schema validation even though it is a legal proto value.
+   *
    * @generated from field: repeated alis.open.options.v1.MessageOptions.JsonSchema.Oneof oneof = 2;
    */
   oneof?: MessageOptions_JsonSchema_OneofJson[];
@@ -126,30 +246,50 @@ export declare type MessageOptions_JsonSchemaJson = {
 export declare const MessageOptions_JsonSchemaSchema: GenMessage<MessageOptions_JsonSchema, {jsonType: MessageOptions_JsonSchemaJson}>;
 
 /**
+ * Oneof declares a mutually-exclusive group of fields on the enclosing
+ * message.
+ *
  * @generated from message alis.open.options.v1.MessageOptions.JsonSchema.Oneof
  */
 export declare type MessageOptions_JsonSchema_Oneof = Message<"alis.open.options.v1.MessageOptions.JsonSchema.Oneof"> & {
   /**
+   * Proto field names that participate in this oneof group. Must name
+   * fields defined on the enclosing message; must be at least two names;
+   * must not include repeated or map fields.
+   *
    * @generated from field: repeated string fields = 1;
    */
   fields: string[];
 
   /**
+   * If true, exactly one of `fields` must be set. If false or unset,
+   * at most one may be set.
+   *
    * @generated from field: optional bool required = 2;
    */
   required?: boolean | undefined;
 };
 
 /**
+ * Oneof declares a mutually-exclusive group of fields on the enclosing
+ * message.
+ *
  * @generated from message alis.open.options.v1.MessageOptions.JsonSchema.Oneof
  */
 export declare type MessageOptions_JsonSchema_OneofJson = {
   /**
+   * Proto field names that participate in this oneof group. Must name
+   * fields defined on the enclosing message; must be at least two names;
+   * must not include repeated or map fields.
+   *
    * @generated from field: repeated string fields = 1;
    */
   fields?: string[];
 
   /**
+   * If true, exactly one of `fields` must be set. If false or unset,
+   * at most one may be set.
+   *
    * @generated from field: optional bool required = 2;
    */
   required?: boolean;
@@ -162,20 +302,30 @@ export declare type MessageOptions_JsonSchema_OneofJson = {
 export declare const MessageOptions_JsonSchema_OneofSchema: GenMessage<MessageOptions_JsonSchema_Oneof, {jsonType: MessageOptions_JsonSchema_OneofJson}>;
 
 /**
+ * FieldOptions carries field-level options consumed by alis code generators.
+ *
  * @generated from message alis.open.options.v1.FieldOptions
  */
 export declare type FieldOptions = Message<"alis.open.options.v1.FieldOptions"> & {
   /**
+   * Options controlling how this field appears in generated JSON Schemas,
+   * consumed by protoc-gen-go-jsonschema.
+   *
    * @generated from field: alis.open.options.v1.FieldOptions.JsonSchema json_schema = 1;
    */
   jsonSchema?: FieldOptions_JsonSchema | undefined;
 };
 
 /**
+ * FieldOptions carries field-level options consumed by alis code generators.
+ *
  * @generated from message alis.open.options.v1.FieldOptions
  */
 export declare type FieldOptionsJson = {
   /**
+   * Options controlling how this field appears in generated JSON Schemas,
+   * consumed by protoc-gen-go-jsonschema.
+   *
    * @generated from field: alis.open.options.v1.FieldOptions.JsonSchema json_schema = 1;
    */
   jsonSchema?: FieldOptions_JsonSchemaJson;
@@ -188,330 +338,610 @@ export declare type FieldOptionsJson = {
 export declare const FieldOptionsSchema: GenMessage<FieldOptions, {jsonType: FieldOptionsJson}>;
 
 /**
+ * JsonSchema holds the field-level JSON Schema generation options. Unless a
+ * field's comment says otherwise, an option applies to the field's own
+ * schema for singular fields, and to each element or value for repeated and
+ * map fields; on message-typed fields, options are emitted as sibling
+ * keywords next to the field's `$ref` (JSON Schema Draft 2020-12
+ * semantics).
+ *
  * @generated from message alis.open.options.v1.FieldOptions.JsonSchema
  */
 export declare type FieldOptions_JsonSchema = Message<"alis.open.options.v1.FieldOptions.JsonSchema"> & {
   /**
+   * Short human-readable title for the field. Emitted as JSON Schema
+   * `title`, overriding the title derived from the first paragraph of the
+   * field's leading comment. Applies to all field types.
+   *
    * @generated from field: optional string title = 1;
    */
   title?: string | undefined;
 
   /**
+   * Human-readable description of the field. Emitted as JSON Schema
+   * `description`, overriding the description derived from the field's
+   * leading comment. Applies to all field types.
+   *
    * @generated from field: optional string description = 2;
    */
   description?: string | undefined;
 
   /**
+   * Excludes the field from the generated schema entirely: no property is
+   * emitted and the field never appears in `required`. Applies to all
+   * field types, including oneof members.
+   *
    * @generated from field: optional bool ignore = 3;
    */
   ignore?: boolean | undefined;
 
   /**
+   * Regular expression the value must match, e.g. "^[A-Z]+$". Emitted as
+   * JSON Schema `pattern`. Applies to string values; on repeated and map
+   * fields it applies to each element or value.
+   *
    * @generated from field: optional string pattern = 4;
    */
   pattern?: string | undefined;
 
   /**
+   * Semantic format annotation such as "email", "uuid", "ipv4", "uri", or
+   * "date-time". Emitted as JSON Schema `format`. Most validators treat
+   * this as an annotation, not an assertion. Applies to string values; on
+   * repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional string format = 5;
    */
   format?: string | undefined;
 
   /**
+   * Encoding of binary content stored in a string, e.g. "base64". Emitted
+   * as JSON Schema `contentEncoding`. bytes fields default to "base64";
+   * setting this overrides that default.
+   *
    * @generated from field: optional string content_encoding = 6;
    */
   contentEncoding?: string | undefined;
 
   /**
+   * Media type of the field's (decoded) content, e.g. "application/json".
+   * Emitted as JSON Schema `contentMediaType`.
+   *
    * @generated from field: optional string content_media_type = 7;
    */
   contentMediaType?: string | undefined;
 
   /**
+   * Minimum string length in characters. Emitted as JSON Schema
+   * `minLength`. Applies to string values; on repeated and map fields it
+   * applies to each element or value.
+   *
    * @generated from field: optional int64 min_length = 8;
    */
   minLength?: bigint | undefined;
 
   /**
+   * Maximum string length in characters. Emitted as JSON Schema
+   * `maxLength`. Applies to string values; on repeated and map fields it
+   * applies to each element or value.
+   *
    * @generated from field: optional int64 max_length = 9;
    */
   maxLength?: bigint | undefined;
 
   /**
+   * Inclusive lower bound for numeric values, unless `exclusive_minimum`
+   * is set. Emitted as JSON Schema `minimum`. Applies to numeric values;
+   * on repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional double minimum = 10;
    */
   minimum?: number | undefined;
 
   /**
+   * Inclusive upper bound for numeric values, unless `exclusive_maximum`
+   * is set. Emitted as JSON Schema `maximum`. Applies to numeric values;
+   * on repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional double maximum = 11;
    */
   maximum?: number | undefined;
 
   /**
+   * If true, the `minimum` value is emitted as JSON Schema
+   * `exclusiveMinimum` instead of `minimum` (the bound itself is not an
+   * allowed value). Requires `minimum` to be set.
+   *
    * @generated from field: optional bool exclusive_minimum = 12;
    */
   exclusiveMinimum?: boolean | undefined;
 
   /**
+   * If true, the `maximum` value is emitted as JSON Schema
+   * `exclusiveMaximum` instead of `maximum` (the bound itself is not an
+   * allowed value). Requires `maximum` to be set.
+   *
    * @generated from field: optional bool exclusive_maximum = 13;
    */
   exclusiveMaximum?: boolean | undefined;
 
   /**
+   * Minimum number of elements in a repeated field. Emitted as JSON Schema
+   * `minItems` on the array itself.
+   *
    * @generated from field: optional int64 min_items = 14;
    */
   minItems?: bigint | undefined;
 
   /**
+   * Maximum number of elements in a repeated field. Emitted as JSON Schema
+   * `maxItems` on the array itself.
+   *
    * @generated from field: optional int64 max_items = 15;
    */
   maxItems?: bigint | undefined;
 
   /**
+   * If true, all elements of a repeated field must be distinct. Emitted as
+   * JSON Schema `uniqueItems` on the array itself.
+   *
    * @generated from field: optional bool unique_items = 16;
    */
   uniqueItems?: boolean | undefined;
 
   /**
+   * Minimum number of entries in a map field. Emitted as JSON Schema
+   * `minProperties` on the object itself.
+   *
    * @generated from field: optional int64 min_properties = 17;
    */
   minProperties?: bigint | undefined;
 
   /**
+   * Maximum number of entries in a map field. Emitted as JSON Schema
+   * `maxProperties` on the object itself.
+   *
    * @generated from field: optional int64 max_properties = 18;
    */
   maxProperties?: bigint | undefined;
 
   /**
+   * Restricts a string or bytes field's value to a fixed set. Emitted as
+   * JSON Schema `enum`. On repeated and map fields the set applies to each
+   * element or value. Setting more than one enum_* variant, or using this
+   * variant on a field that is not string or bytes, is an error at
+   * generation time.
+   *
    * @generated from field: repeated string enum_string = 19;
    */
   enumString: string[];
 
   /**
+   * Restricts an integer field's value to a fixed set. Emitted as JSON
+   * Schema `enum`. Applies to integer fields (int32/int64/uint*\/sint*\/
+   * fixed*) and proto enum fields, where the values must be a subset of the
+   * enum's declared numeric values. On repeated and map fields the set
+   * applies to each element or value. Setting more than one enum_* variant,
+   * or using this variant on a non-integer field, is an error at generation
+   * time. Cannot express uint64 values above 2^63-1.
+   *
    * @generated from field: repeated int64 enum_int = 20;
    */
   enumInt: bigint[];
 
   /**
+   * Restricts a float or double field's value to a fixed set. Emitted as
+   * JSON Schema `enum`. On repeated and map fields the set applies to each
+   * element or value. Setting more than one enum_* variant, or using this
+   * variant on a non-numeric field, is an error at generation time.
+   *
    * @generated from field: repeated double enum_number = 21;
    */
   enumNumber: number[];
 
   /**
+   * Marks the field as deprecated. Emitted as JSON Schema `deprecated`.
+   * Applies to the field's schema root: on repeated and map fields it marks
+   * the array or object itself, not its elements.
+   *
    * @generated from field: optional bool deprecated = 22;
    */
   deprecated?: boolean | undefined;
 
   /**
+   * Marks the field as read-only. Emitted as JSON Schema `readOnly`.
+   * Applies to the field's schema root, like `deprecated`.
+   *
    * @generated from field: optional bool read_only = 23;
    */
   readOnly?: boolean | undefined;
 
   /**
+   * Marks the field as write-only. Emitted as JSON Schema `writeOnly`.
+   * Applies to the field's schema root, like `deprecated`.
+   *
    * @generated from field: optional bool write_only = 24;
    */
   writeOnly?: boolean | undefined;
 
   /**
+   * Requires numeric values to be a multiple of this number. Emitted as
+   * JSON Schema `multipleOf`. Numeric fields only; must be greater than 0.
+   * On repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional double multiple_of = 25;
    */
   multipleOf?: number | undefined;
 
   /**
+   * Default value for a string or bytes field. Emitted as JSON Schema
+   * `default`. Only valid on singular fields of those types: using it on a
+   * repeated, map, message-typed, or non-string field, or setting more than
+   * one default_* variant, is an error at generation time.
+   *
    * @generated from field: optional string default_string = 26;
    */
   defaultString?: string | undefined;
 
   /**
+   * Default value for an integer or proto enum field. Emitted as JSON
+   * Schema `default`. Only valid on singular fields of those types: using
+   * it on a repeated, map, message-typed, or non-integer field, or setting
+   * more than one default_* variant, is an error at generation time.
+   *
    * @generated from field: optional int64 default_int = 27;
    */
   defaultInt?: bigint | undefined;
 
   /**
+   * Default value for a float or double field. Emitted as JSON Schema
+   * `default`. Only valid on singular fields of those types: using it on a
+   * repeated, map, message-typed, or non-numeric field, or setting more
+   * than one default_* variant, is an error at generation time.
+   *
    * @generated from field: optional double default_number = 28;
    */
   defaultNumber?: number | undefined;
 
   /**
+   * Default value for a bool field. Emitted as JSON Schema `default`. Only
+   * valid on singular bool fields: using it on a repeated, map,
+   * message-typed, or non-bool field, or setting more than one default_*
+   * variant, is an error at generation time.
+   *
    * @generated from field: optional bool default_bool = 29;
    */
   defaultBool?: boolean | undefined;
 
   /**
+   * Example values for a string or bytes field. Emitted as JSON Schema
+   * `examples`. Only valid on singular fields of those types, same rules as
+   * default_string.
+   *
    * @generated from field: repeated string examples_string = 30;
    */
   examplesString: string[];
 
   /**
+   * Example values for an integer or proto enum field. Emitted as JSON
+   * Schema `examples`. Only valid on singular fields of those types, same
+   * rules as default_int.
+   *
    * @generated from field: repeated int64 examples_int = 31;
    */
   examplesInt: bigint[];
 
   /**
+   * Example values for a float or double field. Emitted as JSON Schema
+   * `examples`. Only valid on singular fields of those types, same rules as
+   * default_number. There is deliberately no examples_bool: a boolean
+   * example carries no information.
+   *
    * @generated from field: repeated double examples_number = 32;
    */
   examplesNumber: number[];
 };
 
 /**
+ * JsonSchema holds the field-level JSON Schema generation options. Unless a
+ * field's comment says otherwise, an option applies to the field's own
+ * schema for singular fields, and to each element or value for repeated and
+ * map fields; on message-typed fields, options are emitted as sibling
+ * keywords next to the field's `$ref` (JSON Schema Draft 2020-12
+ * semantics).
+ *
  * @generated from message alis.open.options.v1.FieldOptions.JsonSchema
  */
 export declare type FieldOptions_JsonSchemaJson = {
   /**
+   * Short human-readable title for the field. Emitted as JSON Schema
+   * `title`, overriding the title derived from the first paragraph of the
+   * field's leading comment. Applies to all field types.
+   *
    * @generated from field: optional string title = 1;
    */
   title?: string;
 
   /**
+   * Human-readable description of the field. Emitted as JSON Schema
+   * `description`, overriding the description derived from the field's
+   * leading comment. Applies to all field types.
+   *
    * @generated from field: optional string description = 2;
    */
   description?: string;
 
   /**
+   * Excludes the field from the generated schema entirely: no property is
+   * emitted and the field never appears in `required`. Applies to all
+   * field types, including oneof members.
+   *
    * @generated from field: optional bool ignore = 3;
    */
   ignore?: boolean;
 
   /**
+   * Regular expression the value must match, e.g. "^[A-Z]+$". Emitted as
+   * JSON Schema `pattern`. Applies to string values; on repeated and map
+   * fields it applies to each element or value.
+   *
    * @generated from field: optional string pattern = 4;
    */
   pattern?: string;
 
   /**
+   * Semantic format annotation such as "email", "uuid", "ipv4", "uri", or
+   * "date-time". Emitted as JSON Schema `format`. Most validators treat
+   * this as an annotation, not an assertion. Applies to string values; on
+   * repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional string format = 5;
    */
   format?: string;
 
   /**
+   * Encoding of binary content stored in a string, e.g. "base64". Emitted
+   * as JSON Schema `contentEncoding`. bytes fields default to "base64";
+   * setting this overrides that default.
+   *
    * @generated from field: optional string content_encoding = 6;
    */
   contentEncoding?: string;
 
   /**
+   * Media type of the field's (decoded) content, e.g. "application/json".
+   * Emitted as JSON Schema `contentMediaType`.
+   *
    * @generated from field: optional string content_media_type = 7;
    */
   contentMediaType?: string;
 
   /**
+   * Minimum string length in characters. Emitted as JSON Schema
+   * `minLength`. Applies to string values; on repeated and map fields it
+   * applies to each element or value.
+   *
    * @generated from field: optional int64 min_length = 8;
    */
   minLength?: string;
 
   /**
+   * Maximum string length in characters. Emitted as JSON Schema
+   * `maxLength`. Applies to string values; on repeated and map fields it
+   * applies to each element or value.
+   *
    * @generated from field: optional int64 max_length = 9;
    */
   maxLength?: string;
 
   /**
+   * Inclusive lower bound for numeric values, unless `exclusive_minimum`
+   * is set. Emitted as JSON Schema `minimum`. Applies to numeric values;
+   * on repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional double minimum = 10;
    */
   minimum?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * Inclusive upper bound for numeric values, unless `exclusive_maximum`
+   * is set. Emitted as JSON Schema `maximum`. Applies to numeric values;
+   * on repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional double maximum = 11;
    */
   maximum?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * If true, the `minimum` value is emitted as JSON Schema
+   * `exclusiveMinimum` instead of `minimum` (the bound itself is not an
+   * allowed value). Requires `minimum` to be set.
+   *
    * @generated from field: optional bool exclusive_minimum = 12;
    */
   exclusiveMinimum?: boolean;
 
   /**
+   * If true, the `maximum` value is emitted as JSON Schema
+   * `exclusiveMaximum` instead of `maximum` (the bound itself is not an
+   * allowed value). Requires `maximum` to be set.
+   *
    * @generated from field: optional bool exclusive_maximum = 13;
    */
   exclusiveMaximum?: boolean;
 
   /**
+   * Minimum number of elements in a repeated field. Emitted as JSON Schema
+   * `minItems` on the array itself.
+   *
    * @generated from field: optional int64 min_items = 14;
    */
   minItems?: string;
 
   /**
+   * Maximum number of elements in a repeated field. Emitted as JSON Schema
+   * `maxItems` on the array itself.
+   *
    * @generated from field: optional int64 max_items = 15;
    */
   maxItems?: string;
 
   /**
+   * If true, all elements of a repeated field must be distinct. Emitted as
+   * JSON Schema `uniqueItems` on the array itself.
+   *
    * @generated from field: optional bool unique_items = 16;
    */
   uniqueItems?: boolean;
 
   /**
+   * Minimum number of entries in a map field. Emitted as JSON Schema
+   * `minProperties` on the object itself.
+   *
    * @generated from field: optional int64 min_properties = 17;
    */
   minProperties?: string;
 
   /**
+   * Maximum number of entries in a map field. Emitted as JSON Schema
+   * `maxProperties` on the object itself.
+   *
    * @generated from field: optional int64 max_properties = 18;
    */
   maxProperties?: string;
 
   /**
+   * Restricts a string or bytes field's value to a fixed set. Emitted as
+   * JSON Schema `enum`. On repeated and map fields the set applies to each
+   * element or value. Setting more than one enum_* variant, or using this
+   * variant on a field that is not string or bytes, is an error at
+   * generation time.
+   *
    * @generated from field: repeated string enum_string = 19;
    */
   enumString?: string[];
 
   /**
+   * Restricts an integer field's value to a fixed set. Emitted as JSON
+   * Schema `enum`. Applies to integer fields (int32/int64/uint*\/sint*\/
+   * fixed*) and proto enum fields, where the values must be a subset of the
+   * enum's declared numeric values. On repeated and map fields the set
+   * applies to each element or value. Setting more than one enum_* variant,
+   * or using this variant on a non-integer field, is an error at generation
+   * time. Cannot express uint64 values above 2^63-1.
+   *
    * @generated from field: repeated int64 enum_int = 20;
    */
   enumInt?: string[];
 
   /**
+   * Restricts a float or double field's value to a fixed set. Emitted as
+   * JSON Schema `enum`. On repeated and map fields the set applies to each
+   * element or value. Setting more than one enum_* variant, or using this
+   * variant on a non-numeric field, is an error at generation time.
+   *
    * @generated from field: repeated double enum_number = 21;
    */
   enumNumber?: (number | "NaN" | "Infinity" | "-Infinity")[];
 
   /**
+   * Marks the field as deprecated. Emitted as JSON Schema `deprecated`.
+   * Applies to the field's schema root: on repeated and map fields it marks
+   * the array or object itself, not its elements.
+   *
    * @generated from field: optional bool deprecated = 22;
    */
   deprecated?: boolean;
 
   /**
+   * Marks the field as read-only. Emitted as JSON Schema `readOnly`.
+   * Applies to the field's schema root, like `deprecated`.
+   *
    * @generated from field: optional bool read_only = 23;
    */
   readOnly?: boolean;
 
   /**
+   * Marks the field as write-only. Emitted as JSON Schema `writeOnly`.
+   * Applies to the field's schema root, like `deprecated`.
+   *
    * @generated from field: optional bool write_only = 24;
    */
   writeOnly?: boolean;
 
   /**
+   * Requires numeric values to be a multiple of this number. Emitted as
+   * JSON Schema `multipleOf`. Numeric fields only; must be greater than 0.
+   * On repeated and map fields it applies to each element or value.
+   *
    * @generated from field: optional double multiple_of = 25;
    */
   multipleOf?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * Default value for a string or bytes field. Emitted as JSON Schema
+   * `default`. Only valid on singular fields of those types: using it on a
+   * repeated, map, message-typed, or non-string field, or setting more than
+   * one default_* variant, is an error at generation time.
+   *
    * @generated from field: optional string default_string = 26;
    */
   defaultString?: string;
 
   /**
+   * Default value for an integer or proto enum field. Emitted as JSON
+   * Schema `default`. Only valid on singular fields of those types: using
+   * it on a repeated, map, message-typed, or non-integer field, or setting
+   * more than one default_* variant, is an error at generation time.
+   *
    * @generated from field: optional int64 default_int = 27;
    */
   defaultInt?: string;
 
   /**
+   * Default value for a float or double field. Emitted as JSON Schema
+   * `default`. Only valid on singular fields of those types: using it on a
+   * repeated, map, message-typed, or non-numeric field, or setting more
+   * than one default_* variant, is an error at generation time.
+   *
    * @generated from field: optional double default_number = 28;
    */
   defaultNumber?: number | "NaN" | "Infinity" | "-Infinity";
 
   /**
+   * Default value for a bool field. Emitted as JSON Schema `default`. Only
+   * valid on singular bool fields: using it on a repeated, map,
+   * message-typed, or non-bool field, or setting more than one default_*
+   * variant, is an error at generation time.
+   *
    * @generated from field: optional bool default_bool = 29;
    */
   defaultBool?: boolean;
 
   /**
+   * Example values for a string or bytes field. Emitted as JSON Schema
+   * `examples`. Only valid on singular fields of those types, same rules as
+   * default_string.
+   *
    * @generated from field: repeated string examples_string = 30;
    */
   examplesString?: string[];
 
   /**
+   * Example values for an integer or proto enum field. Emitted as JSON
+   * Schema `examples`. Only valid on singular fields of those types, same
+   * rules as default_int.
+   *
    * @generated from field: repeated int64 examples_int = 31;
    */
   examplesInt?: string[];
 
   /**
+   * Example values for a float or double field. Emitted as JSON Schema
+   * `examples`. Only valid on singular fields of those types, same rules as
+   * default_number. There is deliberately no examples_bool: a boolean
+   * example carries no information.
+   *
    * @generated from field: repeated double examples_number = 32;
    */
   examplesNumber?: (number | "NaN" | "Infinity" | "-Infinity")[];
@@ -524,16 +954,45 @@ export declare type FieldOptions_JsonSchemaJson = {
 export declare const FieldOptions_JsonSchemaSchema: GenMessage<FieldOptions_JsonSchema, {jsonType: FieldOptions_JsonSchemaJson}>;
 
 /**
+ * File-level alis options.
+ *
+ * Usage: option (alis.open.options.v1.file).json_schema.generate = true;
+ *
  * @generated from extension: alis.open.options.v1.FileOptions file = 1001;
  */
 export declare const file: GenExtension<FileOptions$1, FileOptions>;
 
 /**
+ * Message-level alis options.
+ *
+ * Usage:
+ *   option (alis.open.options.v1.message).json_schema.generate = true;
+ *   option (alis.open.options.v1.message).json_schema.oneof = {
+ *     fields: ["field_a", "field_b", "field_c"],
+ *     required: true
+ *   };
+ *
  * @generated from extension: alis.open.options.v1.MessageOptions message = 1001;
  */
 export declare const message: GenExtension<MessageOptions$1, MessageOptions>;
 
 /**
+ * Field-level alis options.
+ *
+ * Usage:
+ * string email = 1 [
+ *   (alis.open.options.v1.field).json_schema = {
+ *     format: "email",
+ *     title: "Primary Email"
+ *   }
+ * ];
+ *
+ * string region = 2 [
+ *   (alis.open.options.v1.field).json_schema = {
+ *     enum_string: ["ALL", "EXPORT", "LOCAL"]
+ *   }
+ * ];
+ *
  * @generated from extension: alis.open.options.v1.FieldOptions field = 1001;
  */
 export declare const field: GenExtension<FieldOptions$1, FieldOptions>;

package/alis/open/options/v1/options_pb.js

@@ -1,7 +1,37 @@
-// @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/options/v1/options.proto (package alis.open.options.v1, syntax proto3)
 /* eslint-disable */
 
+// Custom options that control how alis code generators treat a proto file,
+// currently JSON Schema (Draft 2020-12) generation by
+// `protoc-gen-go-jsonschema`.
+//
+// Three extensions, each at field number 1001 of its descriptor options
+// message, carry the options:
+//
+// - `(alis.open.options.v1.file)` (`FileOptions`): turns schema generation on
+//   for every message in the file.
+// - `(alis.open.options.v1.message)` (`MessageOptions`): overrides the file
+//   default for one message and declares schema-level oneof groups.
+// - `(alis.open.options.v1.field)` (`FieldOptions`): adds JSON Schema keywords
+//   to a field, such as `title`, `pattern`, `format`, numeric and length
+//   bounds, `enum`, `default` and `examples`.
+//
+// ```proto
+// import "alis/open/options/v1/options.proto";
+//
+// option (alis.open.options.v1.file).json_schema.generate = true;
+//
+// message Contact {
+//   string email = 1 [(alis.open.options.v1.field).json_schema = {
+//     format: "email"
+//   }];
+// }
+// ```
+//
+// A message referenced by a generating message is always generated, even if
+// it opts out, so that `$ref` pointers resolve.
+
 import { extDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_descriptor } from "@bufbuild/protobuf/wkt";
 
@@ -61,18 +91,47 @@ export const FieldOptions_JsonSchemaSchema = /*@__PURE__*/
   messageDesc(file_alis_open_options_v1_options, 2, 0);
 
 /**
+ * File-level alis options.
+ *
+ * Usage: option (alis.open.options.v1.file).json_schema.generate = true;
+ *
  * @generated from extension: alis.open.options.v1.FileOptions file = 1001;
  */
 export const file = /*@__PURE__*/
   extDesc(file_alis_open_options_v1_options, 0);
 
 /**
+ * Message-level alis options.
+ *
+ * Usage:
+ *   option (alis.open.options.v1.message).json_schema.generate = true;
+ *   option (alis.open.options.v1.message).json_schema.oneof = {
+ *     fields: ["field_a", "field_b", "field_c"],
+ *     required: true
+ *   };
+ *
  * @generated from extension: alis.open.options.v1.MessageOptions message = 1001;
  */
 export const message = /*@__PURE__*/
   extDesc(file_alis_open_options_v1_options, 1);
 
 /**
+ * Field-level alis options.
+ *
+ * Usage:
+ * string email = 1 [
+ *   (alis.open.options.v1.field).json_schema = {
+ *     format: "email",
+ *     title: "Primary Email"
+ *   }
+ * ];
+ *
+ * string region = 2 [
+ *   (alis.open.options.v1.field).json_schema = {
+ *     enum_string: ["ALL", "EXPORT", "LOCAL"]
+ *   }
+ * ];
+ *
  * @generated from extension: alis.open.options.v1.FieldOptions field = 1001;
  */
 export const field = /*@__PURE__*/

package/package.json

@@ -23,5 +23,5 @@
   },
   "type": "module",
   "types": "./index.d.ts",
-  "version": "1.21.0"
+  "version": "1.23.0"
 }