@dtkt/protoform 0.0.0-stage → 0.1.0

package/dist/element.d.ts

@@ -0,0 +1,23 @@
+import { DescField, DescOneof, ScalarType } from '@bufbuild/protobuf';
+import { FieldElement } from './gen/dtkt/protoform/v1beta1/protoform_pb';
+import { Commentable } from './comments';
+export declare class Element {
+    readonly proto: FieldElement;
+    readonly valid: boolean;
+    readonly hidden: boolean;
+    /** Whether a `(buf.validate.field).required` rule applies. */
+    readonly required: boolean;
+    /** Explicit description or proto comments; empty if the field is undocumented. */
+    readonly documented: string;
+    constructor(desc: DescField | DescOneof);
+    type(): FieldElement["type"];
+    title(): string;
+    description(): string;
+}
+export declare function isIdentifier(desc: DescField): boolean;
+export declare function isOutputOnly(desc: DescField): boolean;
+/** Returns the (cached) Element for a descriptor; fields are re-created on every render. */
+export declare function elementFor(desc: DescField | DescOneof): Element;
+export declare function getFieldDescription(desc: DescField): string;
+export declare function getProtoDescription(desc: Commentable, multiline?: boolean): string;
+export declare function getScalarTypeName(scalarType: ScalarType): string;

package/dist/enum.d.ts

@@ -0,0 +1,17 @@
+import { DescField, DescEnum, EnumShape } from '@bufbuild/protobuf';
+import { BaseField } from './base';
+export type EnumFieldDesc = Extract<DescField, {
+    fieldKind: "enum";
+}>;
+export declare class EnumField extends BaseField<EnumFieldDesc> {
+    get(): number;
+    set(value: number): void;
+    /** Accepts a value name (`FOO_BAR`) or number. */
+    parse(value: string): void;
+    toString(): string;
+}
+export declare function parseEnum<Desc extends DescEnum>(descEnum: Desc, value: string): EnumShape<Desc> | undefined;
+export declare function formatEnum<Desc extends DescEnum>(descEnum: Desc, value: EnumShape<Desc>, trimPrefix?: boolean): string;
+/** A human-friendly label: `CONNECTION_STATE_NOT_READY` -> `Not ready`. */
+export declare function enumLabel<Desc extends DescEnum>(descEnum: Desc, value: EnumShape<Desc>): string;
+export declare function allEnumValues<Desc extends DescEnum>(descEnum: Desc): EnumShape<Desc>[];

package/dist/env.d.ts

@@ -0,0 +1,28 @@
+import { default as React } from 'react';
+import { Registry } from '@bufbuild/protobuf';
+import { Transport } from '@connectrpc/connect';
+import { Validator } from '@bufbuild/protovalidate';
+export declare const defaultRegistry: import('@bufbuild/protobuf').MutableRegistry;
+export declare const defaultValidator: Validator;
+export declare function createDefaultValidator(registry?: Registry): Validator;
+export declare function createDefaultTransport(registry?: Registry): Transport;
+export type EnvOptions = {
+    registry?: Registry;
+    validator?: Validator;
+    transport?: Transport;
+    /** Limits which message types can be chosen for `google.protobuf.Any` fields. */
+    anyTypeFilter?: (typeName: string) => boolean;
+};
+export declare class Env {
+    readonly registry: Registry;
+    readonly anyTypeFilter: (typeName: string) => boolean;
+    private _transport?;
+    private _validator?;
+    constructor({ registry, validator, transport, anyTypeFilter }?: EnvOptions);
+    /** Created on first use so importing the library has no side effects. */
+    get transport(): Transport;
+    /** Created on first use so importing the library has no side effects. */
+    get validator(): Validator;
+}
+export declare const EnvContext: React.Context<Env>;
+export declare const useEnv: () => Env;

package/dist/field.d.ts

@@ -0,0 +1,17 @@
+import { DescField } from '@bufbuild/protobuf';
+import { Violation } from '@bufbuild/protovalidate';
+import { Element } from './element';
+import { Message } from './message';
+export interface Field {
+    readonly parent: Message;
+    readonly desc: DescField;
+    readonly elem: Element;
+    /** Location of the field in the message, e.g. `items[0].name`. */
+    readonly path: string;
+    readonly errors: Violation[];
+    /** Validation violations plus local input errors (e.g. unparsable numbers). */
+    errorMessages(): string[];
+    toString(): string;
+    parse(value: string): void;
+}
+export declare function createField(parent: Message, desc: DescField): Field;

package/dist/gen/dtkt/protoform/v1beta1/protoform_pb.d.ts

@@ -0,0 +1,463 @@
+import { GenExtension, GenFile, GenMessage } from '@bufbuild/protobuf/codegenv2';
+import { Message } from '@bufbuild/protobuf';
+import { FieldOptions } from '@bufbuild/protobuf/wkt';
+/**
+ * Describes the file dtkt/protoform/v1beta1/protoform.proto.
+ */
+export declare const file_dtkt_protoform_v1beta1_protoform: GenFile;
+
+/**
+ * @generated from message dtkt.protoform.v1beta1.FieldElement
+ */
+export declare type FieldElement = Message<"dtkt.protoform.v1beta1.FieldElement"> & {
+  /**
+   * @generated from field: optional string title = 1;
+   */
+  title?: string | undefined;
+
+  /**
+   * @generated from field: optional string description = 2;
+   */
+  description?: string | undefined;
+
+  /**
+   * @generated from field: optional bool hidden = 3;
+   */
+  hidden?: boolean | undefined;
+
+  /**
+   * @generated from oneof dtkt.protoform.v1beta1.FieldElement.type
+   */
+  type: {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.ConfirmElement confirm = 4;
+     */
+    value: ConfirmElement;
+    case: "confirm";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.InputElement input = 5;
+     */
+    value: InputElement;
+    case: "input";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.FileElement file = 6;
+     */
+    value: FileElement;
+    case: "file";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.SelectElement select = 7;
+     */
+    value: SelectElement;
+    case: "select";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.MultiSelectElement multi_select = 8;
+     */
+    value: MultiSelectElement;
+    case: "multiSelect";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * @generated from message dtkt.protoform.v1beta1.FieldElement
+ */
+export declare type FieldElementValid = Message<"dtkt.protoform.v1beta1.FieldElement"> & {
+  /**
+   * @generated from field: optional string title = 1;
+   */
+  title?: string | undefined;
+
+  /**
+   * @generated from field: optional string description = 2;
+   */
+  description?: string | undefined;
+
+  /**
+   * @generated from field: optional bool hidden = 3;
+   */
+  hidden?: boolean | undefined;
+
+  /**
+   * @generated from oneof dtkt.protoform.v1beta1.FieldElement.type
+   */
+  type: {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.ConfirmElement confirm = 4;
+     */
+    value: ConfirmElementValid;
+    case: "confirm";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.InputElement input = 5;
+     */
+    value: InputElementValid;
+    case: "input";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.FileElement file = 6;
+     */
+    value: FileElementValid;
+    case: "file";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.SelectElement select = 7;
+     */
+    value: SelectElementValid;
+    case: "select";
+  } | {
+    /**
+     * @generated from field: dtkt.protoform.v1beta1.MultiSelectElement multi_select = 8;
+     */
+    value: MultiSelectElementValid;
+    case: "multiSelect";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message dtkt.protoform.v1beta1.FieldElement.
+ * Use `create(FieldElementSchema)` to create a new message.
+ */
+export declare const FieldElementSchema: GenMessage<FieldElement, {validType: FieldElementValid}>;
+
+/**
+ * Confirm element (approve/decline)
+ *
+ * @generated from message dtkt.protoform.v1beta1.ConfirmElement
+ */
+export declare type ConfirmElement = Message<"dtkt.protoform.v1beta1.ConfirmElement"> & {
+  /**
+   * @generated from field: string approve = 1;
+   */
+  approve: string;
+
+  /**
+   * @generated from field: string decline = 2;
+   */
+  decline: string;
+
+  /**
+   * @generated from field: bool default_selected = 3;
+   */
+  defaultSelected: boolean;
+};
+
+export declare type ConfirmElementValid = ConfirmElement;
+
+/**
+ * Describes the message dtkt.protoform.v1beta1.ConfirmElement.
+ * Use `create(ConfirmElementSchema)` to create a new message.
+ */
+export declare const ConfirmElementSchema: GenMessage<ConfirmElement, {validType: ConfirmElementValid}>;
+
+/**
+ * Input element with multi-line text option
+ *
+ * @generated from message dtkt.protoform.v1beta1.InputElement
+ */
+export declare type InputElement = Message<"dtkt.protoform.v1beta1.InputElement"> & {
+  /**
+   * @generated from field: optional bool multiline_text = 1;
+   */
+  multilineText?: boolean | undefined;
+};
+
+export declare type InputElementValid = InputElement;
+
+/**
+ * Describes the message dtkt.protoform.v1beta1.InputElement.
+ * Use `create(InputElementSchema)` to create a new message.
+ */
+export declare const InputElementSchema: GenMessage<InputElement, {validType: InputElementValid}>;
+
+/**
+ * File element
+ *
+ * @generated from message dtkt.protoform.v1beta1.FileElement
+ */
+export declare type FileElement = Message<"dtkt.protoform.v1beta1.FileElement"> & {
+  /**
+   * @generated from field: repeated string allowed_types = 2;
+   */
+  allowedTypes: string[];
+};
+
+export declare type FileElementValid = FileElement;
+
+/**
+ * Describes the message dtkt.protoform.v1beta1.FileElement.
+ * Use `create(FileElementSchema)` to create a new message.
+ */
+export declare const FileElementSchema: GenMessage<FileElement, {validType: FileElementValid}>;
+
+/**
+ * Select element
+ *
+ * @generated from message dtkt.protoform.v1beta1.SelectElement
+ */
+export declare type SelectElement = Message<"dtkt.protoform.v1beta1.SelectElement"> & {
+  /**
+   * A fully-qualified method name to call at runtime to retrieve options for
+   * this select element. The method must return a message containing a repeated
+   * field to be used as the options for this select element.
+   *
+   * @generated from field: string method_name = 1;
+   */
+  methodName: string;
+
+  /**
+   * Name of a repeated field within the method's response whose value defines
+   * the select element's options.
+   *
+   * @generated from field: string response_field = 2;
+   */
+  responseField: string;
+
+  /**
+   * CEL expression to extract the label for each select element option.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: string label_expr = 3;
+   */
+  labelExpr: string;
+
+  /**
+   * Optional CEL expression to extract the value for each select element option.
+   * The resolved expression value must match the field type this option is
+   * applied to.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   * Default: resolved list item value (dynamic).
+   *
+   * @generated from field: optional string value_expr = 4;
+   */
+  valueExpr?: string | undefined;
+
+  /**
+   * Optional CEL expression to filter options returned by method response by
+   * only including options for which `filter_expr` returns `true`.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: optional string filter_expr = 5;
+   */
+  filterExpr?: string | undefined;
+
+  /**
+   * When defined, `filter_expr` is defined, and the method request contains a
+   * `filter (string)` field, set its value to `filter_expr`.
+   *
+   * @generated from field: optional bool use_filter_field = 6;
+   */
+  useFilterField?: boolean | undefined;
+};
+
+/**
+ * Select element
+ *
+ * @generated from message dtkt.protoform.v1beta1.SelectElement
+ */
+export declare type SelectElementValid = Message<"dtkt.protoform.v1beta1.SelectElement"> & {
+  /**
+   * A fully-qualified method name to call at runtime to retrieve options for
+   * this select element. The method must return a message containing a repeated
+   * field to be used as the options for this select element.
+   *
+   * @generated from field: string method_name = 1;
+   */
+  methodName: string;
+
+  /**
+   * Name of a repeated field within the method's response whose value defines
+   * the select element's options.
+   *
+   * @generated from field: string response_field = 2;
+   */
+  responseField: string;
+
+  /**
+   * CEL expression to extract the label for each select element option.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: string label_expr = 3;
+   */
+  labelExpr: string;
+
+  /**
+   * Optional CEL expression to extract the value for each select element option.
+   * The resolved expression value must match the field type this option is
+   * applied to.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   * Default: resolved list item value (dynamic).
+   *
+   * @generated from field: optional string value_expr = 4;
+   */
+  valueExpr?: string | undefined;
+
+  /**
+   * Optional CEL expression to filter options returned by method response by
+   * only including options for which `filter_expr` returns `true`.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: optional string filter_expr = 5;
+   */
+  filterExpr?: string | undefined;
+
+  /**
+   * When defined, `filter_expr` is defined, and the method request contains a
+   * `filter (string)` field, set its value to `filter_expr`.
+   *
+   * @generated from field: optional bool use_filter_field = 6;
+   */
+  useFilterField?: boolean | undefined;
+};
+
+/**
+ * Describes the message dtkt.protoform.v1beta1.SelectElement.
+ * Use `create(SelectElementSchema)` to create a new message.
+ */
+export declare const SelectElementSchema: GenMessage<SelectElement, {validType: SelectElementValid}>;
+
+/**
+ * Multi-select element
+ *
+ * @generated from message dtkt.protoform.v1beta1.MultiSelectElement
+ */
+export declare type MultiSelectElement = Message<"dtkt.protoform.v1beta1.MultiSelectElement"> & {
+  /**
+   * A fully-qualified method name to call at runtime to retrieve options for
+   * this select element. The method must return a message containing a repeated
+   * field to be used as the options for this select element.
+   *
+   * @generated from field: string method_name = 1;
+   */
+  methodName: string;
+
+  /**
+   * Name of a repeated field within the method's response whose value defines
+   * the select element's options.
+   *
+   * @generated from field: string response_field = 2;
+   */
+  responseField: string;
+
+  /**
+   * CEL expression to extract the label for each select element option.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: string label_expr = 3;
+   */
+  labelExpr: string;
+
+  /**
+   * Optional CEL expression to extract the value for each select element option.
+   * The resolved expression value must match the field type this option is
+   * applied to.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   * Default: resolved list item value (dynamic).
+   *
+   * @generated from field: optional string value_expr = 4;
+   */
+  valueExpr?: string | undefined;
+
+  /**
+   * Optional CEL expression to filter options returned by method response by
+   * only including options for which `filter_expr` returns `true`.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: optional string filter_expr = 5;
+   */
+  filterExpr?: string | undefined;
+
+  /**
+   * When defined, `filter_expr` is defined, and the method request contains a
+   * `filter (string)` field, set its value to `filter_expr`.
+   *
+   * @generated from field: optional bool use_filter_field = 6;
+   */
+  useFilterField?: boolean | undefined;
+};
+
+/**
+ * Multi-select element
+ *
+ * @generated from message dtkt.protoform.v1beta1.MultiSelectElement
+ */
+export declare type MultiSelectElementValid = Message<"dtkt.protoform.v1beta1.MultiSelectElement"> & {
+  /**
+   * A fully-qualified method name to call at runtime to retrieve options for
+   * this select element. The method must return a message containing a repeated
+   * field to be used as the options for this select element.
+   *
+   * @generated from field: string method_name = 1;
+   */
+  methodName: string;
+
+  /**
+   * Name of a repeated field within the method's response whose value defines
+   * the select element's options.
+   *
+   * @generated from field: string response_field = 2;
+   */
+  responseField: string;
+
+  /**
+   * CEL expression to extract the label for each select element option.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: string label_expr = 3;
+   */
+  labelExpr: string;
+
+  /**
+   * Optional CEL expression to extract the value for each select element option.
+   * The resolved expression value must match the field type this option is
+   * applied to.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   * Default: resolved list item value (dynamic).
+   *
+   * @generated from field: optional string value_expr = 4;
+   */
+  valueExpr?: string | undefined;
+
+  /**
+   * Optional CEL expression to filter options returned by method response by
+   * only including options for which `filter_expr` returns `true`.
+   * Each list item within the resolved `response_field` of the method's response
+   * will be available as `this` in the CEL expression context.
+   *
+   * @generated from field: optional string filter_expr = 5;
+   */
+  filterExpr?: string | undefined;
+
+  /**
+   * When defined, `filter_expr` is defined, and the method request contains a
+   * `filter (string)` field, set its value to `filter_expr`.
+   *
+   * @generated from field: optional bool use_filter_field = 6;
+   */
+  useFilterField?: boolean | undefined;
+};
+
+/**
+ * Describes the message dtkt.protoform.v1beta1.MultiSelectElement.
+ * Use `create(MultiSelectElementSchema)` to create a new message.
+ */
+export declare const MultiSelectElementSchema: GenMessage<MultiSelectElement, {validType: MultiSelectElementValid}>;
+
+/**
+ * @generated from extension: optional dtkt.protoform.v1beta1.FieldElement field = 50000;
+ */
+export declare const field: GenExtension<FieldOptions, FieldElement>;
+

package/dist/gen/dtkt/protoform/v1beta1/protoform_pb.js

@@ -0,0 +1,6 @@
+import { file_google_protobuf_descriptor as e } from "@bufbuild/protobuf/wkt";
+import { extDesc as t, fileDesc as n, messageDesc as r } from "@bufbuild/protobuf/codegenv2";
+import { file_buf_validate_validate as i } from "@bufbuild/protovalidate/gen/buf/validate/validate_pb.js";
+// lib/gen/dtkt/protoform/v1beta1/protoform_pb.js
+var a = /*@__PURE__*/ n("CiZkdGt0L3Byb3RvZm9ybS92MWJldGExL3Byb3RvZm9ybS5wcm90bxIWZHRrdC5wcm90b2Zvcm0udjFiZXRhMSKiAwoMRmllbGRFbGVtZW50EhIKBXRpdGxlGAEgASgJSAGIAQESGAoLZGVzY3JpcHRpb24YAiABKAlIAogBARITCgZoaWRkZW4YAyABKAhIA4gBARI5Cgdjb25maXJtGAQgASgLMiYuZHRrdC5wcm90b2Zvcm0udjFiZXRhMS5Db25maXJtRWxlbWVudEgAEjUKBWlucHV0GAUgASgLMiQuZHRrdC5wcm90b2Zvcm0udjFiZXRhMS5JbnB1dEVsZW1lbnRIABIzCgRmaWxlGAYgASgLMiMuZHRrdC5wcm90b2Zvcm0udjFiZXRhMS5GaWxlRWxlbWVudEgAEjcKBnNlbGVjdBgHIAEoCzIlLmR0a3QucHJvdG9mb3JtLnYxYmV0YTEuU2VsZWN0RWxlbWVudEgAEkIKDG11bHRpX3NlbGVjdBgIIAEoCzIqLmR0a3QucHJvdG9mb3JtLnYxYmV0YTEuTXVsdGlTZWxlY3RFbGVtZW50SABCBgoEdHlwZUIICgZfdGl0bGVCDgoMX2Rlc2NyaXB0aW9uQgkKB19oaWRkZW4iTAoOQ29uZmlybUVsZW1lbnQSDwoHYXBwcm92ZRgBIAEoCRIPCgdkZWNsaW5lGAIgASgJEhgKEGRlZmF1bHRfc2VsZWN0ZWQYAyABKAgiPgoMSW5wdXRFbGVtZW50EhsKDm11bHRpbGluZV90ZXh0GAEgASgISACIAQFCEQoPX211bHRpbGluZV90ZXh0IiQKC0ZpbGVFbGVtZW50EhUKDWFsbG93ZWRfdHlwZXMYAiADKAki2wIKDVNlbGVjdEVsZW1lbnQSPwoLbWV0aG9kX25hbWUYASABKAlCKrpIJ8gBAXIikgIfZHRrdC5leGFtcGxlLkdyZWV0U2VydmljZS5HcmVldBIrCg5yZXNwb25zZV9maWVsZBgCIAEoCUITukgQyAEBcguSAghtZXNzYWdlcxIoCgpsYWJlbF9leHByGAMgASgJQhS6SBHIAQFyDJICCXRoaXMudGV4dBIoCgp2YWx1ZV9leHByGAQgASgJQg+6SAxyCpICB3RoaXMuaWRIAIgBARI1CgtmaWx0ZXJfZXhwchgFIAEoCUIbukgYchaSAhNzaXplKHRoaXMudGV4dCkgPiAwSAGIAQESHQoQdXNlX2ZpbHRlcl9maWVsZBgGIAEoCEgCiAEBQg0KC192YWx1ZV9leHByQg4KDF9maWx0ZXJfZXhwckITChFfdXNlX2ZpbHRlcl9maWVsZCLgAgoSTXVsdGlTZWxlY3RFbGVtZW50Ej8KC21ldGhvZF9uYW1lGAEgASgJQiq6SCfIAQFyIpICH2R0a3QuZXhhbXBsZS5HcmVldFNlcnZpY2UuR3JlZXQSKwoOcmVzcG9uc2VfZmllbGQYAiABKAlCE7pIEMgBAXILkgIIbWVzc2FnZXMSKAoKbGFiZWxfZXhwchgDIAEoCUIUukgRyAEBcgySAgl0aGlzLnRleHQSKAoKdmFsdWVfZXhwchgEIAEoCUIPukgMcgqSAgd0aGlzLmlkSACIAQESNQoLZmlsdGVyX2V4cHIYBSABKAlCG7pIGHIWkgITc2l6ZSh0aGlzLnRleHQpID4gMEgBiAEBEh0KEHVzZV9maWx0ZXJfZmllbGQYBiABKAhIAogBAUINCgtfdmFsdWVfZXhwckIOCgxfZmlsdGVyX2V4cHJCEwoRX3VzZV9maWx0ZXJfZmllbGQ6XgoFZmllbGQSHS5nb29nbGUucHJvdG9idWYuRmllbGRPcHRpb25zGNCGAyABKAsyJC5kdGt0LnByb3RvZm9ybS52MWJldGExLkZpZWxkRWxlbWVudFIFZmllbGSIAQFCRVpDZ2l0aHViLmNvbS9kYXRha2l0LWRldi9kdGt0LXNkay9zZGstZ28vcHJvdG8vZHRrdC9wcm90b2Zvcm0vdjFiZXRhMWIGcHJvdG8z", [i, e]), o = /*@__PURE__*/ r(a, 0), s = /*@__PURE__*/ r(a, 1), c = /*@__PURE__*/ r(a, 2), l = /*@__PURE__*/ r(a, 3), u = /*@__PURE__*/ r(a, 4), d = /*@__PURE__*/ r(a, 5), f = /*@__PURE__*/ t(a, 0);
+export { s as ConfirmElementSchema, o as FieldElementSchema, l as FileElementSchema, c as InputElementSchema, d as MultiSelectElementSchema, u as SelectElementSchema, f as field, a as file_dtkt_protoform_v1beta1_protoform };

package/dist/gen/google/api/field_behavior_pb.d.ts

@@ -0,0 +1,133 @@
+import { GenEnum, GenExtension, GenFile } from '@bufbuild/protobuf/codegenv2';
+import { FieldOptions } from '@bufbuild/protobuf/wkt';
+/**
+ * Describes the file google/api/field_behavior.proto.
+ */
+export declare const file_google_api_field_behavior: GenFile;
+
+/**
+ * An indicator of the behavior of a given field (for example, that a field
+ * is required in requests, or given as output but ignored as input).
+ * This **does not** change the behavior in protocol buffers itself; it only
+ * denotes the behavior and may affect how API tooling handles the field.
+ *
+ * Note: This enum **may** receive new values in the future.
+ *
+ * @generated from enum google.api.FieldBehavior
+ */
+export enum FieldBehavior {
+  /**
+   * Conventional default for enums. Do not use this.
+   *
+   * @generated from enum value: FIELD_BEHAVIOR_UNSPECIFIED = 0;
+   */
+  FIELD_BEHAVIOR_UNSPECIFIED = 0,
+
+  /**
+   * Specifically denotes a field as optional.
+   * While all fields in protocol buffers are optional, this may be specified
+   * for emphasis if appropriate.
+   *
+   * @generated from enum value: OPTIONAL = 1;
+   */
+  OPTIONAL = 1,
+
+  /**
+   * Denotes a field as required.
+   * This indicates that the field **must** be provided as part of the request,
+   * and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+   *
+   * @generated from enum value: REQUIRED = 2;
+   */
+  REQUIRED = 2,
+
+  /**
+   * Denotes a field as output only.
+   * This indicates that the field is provided in responses, but including the
+   * field in a request does nothing (the server *must* ignore it and
+   * *must not* throw an error as a result of the field's presence).
+   *
+   * @generated from enum value: OUTPUT_ONLY = 3;
+   */
+  OUTPUT_ONLY = 3,
+
+  /**
+   * Denotes a field as input only.
+   * This indicates that the field is provided in requests, and the
+   * corresponding field is not included in output.
+   *
+   * @generated from enum value: INPUT_ONLY = 4;
+   */
+  INPUT_ONLY = 4,
+
+  /**
+   * Denotes a field as immutable.
+   * This indicates that the field may be set once in a request to create a
+   * resource, but may not be changed thereafter.
+   *
+   * @generated from enum value: IMMUTABLE = 5;
+   */
+  IMMUTABLE = 5,
+
+  /**
+   * Denotes that a (repeated) field is an unordered list.
+   * This indicates that the service may provide the elements of the list
+   * in any arbitrary  order, rather than the order the user originally
+   * provided. Additionally, the list's order may or may not be stable.
+   *
+   * @generated from enum value: UNORDERED_LIST = 6;
+   */
+  UNORDERED_LIST = 6,
+
+  /**
+   * Denotes that this field returns a non-empty default value if not set.
+   * This indicates that if the user provides the empty value in a request,
+   * a non-empty value will be returned. The user will not be aware of what
+   * non-empty value to expect.
+   *
+   * @generated from enum value: NON_EMPTY_DEFAULT = 7;
+   */
+  NON_EMPTY_DEFAULT = 7,
+
+  /**
+   * Denotes that the field in a resource (a message annotated with
+   * google.api.resource) is used in the resource name to uniquely identify the
+   * resource. For AIP-compliant APIs, this should only be applied to the
+   * `name` field on the resource.
+   *
+   * This behavior should not be applied to references to other resources within
+   * the message.
+   *
+   * The identifier field of resources often have different field behavior
+   * depending on the request it is embedded in (e.g. for Create methods name
+   * is optional and unused, while for Update methods it is required). Instead
+   * of method-specific annotations, only `IDENTIFIER` is required.
+   *
+   * @generated from enum value: IDENTIFIER = 8;
+   */
+  IDENTIFIER = 8,
+}
+
+/**
+ * Describes the enum google.api.FieldBehavior.
+ */
+export declare const FieldBehaviorSchema: GenEnum<FieldBehavior>;
+
+/**
+ * A designation of a specific field behavior (required, output only, etc.)
+ * in protobuf messages.
+ *
+ * Examples:
+ *
+ *   string name = 1 [(google.api.field_behavior) = REQUIRED];
+ *   State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ *   google.protobuf.Duration ttl = 1
+ *     [(google.api.field_behavior) = INPUT_ONLY];
+ *   google.protobuf.Timestamp expire_time = 1
+ *     [(google.api.field_behavior) = OUTPUT_ONLY,
+ *      (google.api.field_behavior) = IMMUTABLE];
+ *
+ * @generated from extension: repeated google.api.FieldBehavior field_behavior = 1052;
+ */
+export declare const field_behavior: GenExtension<FieldOptions, FieldBehavior[]>;
+