@alis-build/common-es 1.0.3

package/google/api/expr/v1alpha1/syntax_pb.d.ts

@@ -0,0 +1,698 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// @generated by protoc-gen-es v2.11.0 with parameter "target=js+dts"
+// @generated from file google/api/expr/v1alpha1/syntax.proto (package google.api.expr.v1alpha1, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { NullValue } from "../../../protobuf/struct_pb";
+import type { Duration } from "../../../protobuf/duration_pb";
+import type { Timestamp } from "../../../protobuf/timestamp_pb";
+
+/**
+ * Describes the file google/api/expr/v1alpha1/syntax.proto.
+ */
+export declare const file_google_api_expr_v1alpha1_syntax: GenFile;
+
+/**
+ * An expression together with source information as returned by the parser.
+ *
+ * @generated from message google.api.expr.v1alpha1.ParsedExpr
+ */
+export declare type ParsedExpr = Message<"google.api.expr.v1alpha1.ParsedExpr"> & {
+  /**
+   * The parsed expression.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr expr = 2;
+   */
+  expr?: Expr;
+
+  /**
+   * The source info derived from input that generated the parsed `expr`.
+   *
+   * @generated from field: google.api.expr.v1alpha1.SourceInfo source_info = 3;
+   */
+  sourceInfo?: SourceInfo;
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.ParsedExpr.
+ * Use `create(ParsedExprSchema)` to create a new message.
+ */
+export declare const ParsedExprSchema: GenMessage<ParsedExpr>;
+
+/**
+ * An abstract representation of a common expression.
+ *
+ * Expressions are abstractly represented as a collection of identifiers,
+ * select statements, function calls, literals, and comprehensions. All
+ * operators with the exception of the '.' operator are modelled as function
+ * calls. This makes it easy to represent new operators into the existing AST.
+ *
+ * All references within expressions must resolve to a [Decl][google.api.expr.v1alpha1.Decl] provided at
+ * type-check for an expression to be valid. A reference may either be a bare
+ * identifier `name` or a qualified identifier `google.api.name`. References
+ * may either refer to a value or a function declaration.
+ *
+ * For example, the expression `google.api.name.startsWith('expr')` references
+ * the declaration `google.api.name` within a [Expr.Select][google.api.expr.v1alpha1.Expr.Select] expression, and
+ * the function declaration `startsWith`.
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr
+ */
+export declare type Expr = Message<"google.api.expr.v1alpha1.Expr"> & {
+  /**
+   * Required. An id assigned to this node by the parser which is unique in a
+   * given expression tree. This is used to associate type information and other
+   * attributes to a node in the parse tree.
+   *
+   * @generated from field: int64 id = 2;
+   */
+  id: bigint;
+
+  /**
+   * Required. Variants of expressions.
+   *
+   * @generated from oneof google.api.expr.v1alpha1.Expr.expr_kind
+   */
+  exprKind: {
+    /**
+     * A literal expression.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Constant const_expr = 3;
+     */
+    value: Constant;
+    case: "constExpr";
+  } | {
+    /**
+     * An identifier expression.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Expr.Ident ident_expr = 4;
+     */
+    value: Expr_Ident;
+    case: "identExpr";
+  } | {
+    /**
+     * A field selection expression, e.g. `request.auth`.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Expr.Select select_expr = 5;
+     */
+    value: Expr_Select;
+    case: "selectExpr";
+  } | {
+    /**
+     * A call expression, including calls to predefined functions and operators.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Expr.Call call_expr = 6;
+     */
+    value: Expr_Call;
+    case: "callExpr";
+  } | {
+    /**
+     * A list creation expression.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Expr.CreateList list_expr = 7;
+     */
+    value: Expr_CreateList;
+    case: "listExpr";
+  } | {
+    /**
+     * A map or message creation expression.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Expr.CreateStruct struct_expr = 8;
+     */
+    value: Expr_CreateStruct;
+    case: "structExpr";
+  } | {
+    /**
+     * A comprehension expression.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Expr.Comprehension comprehension_expr = 9;
+     */
+    value: Expr_Comprehension;
+    case: "comprehensionExpr";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.
+ * Use `create(ExprSchema)` to create a new message.
+ */
+export declare const ExprSchema: GenMessage<Expr>;
+
+/**
+ * An identifier expression. e.g. `request`.
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr.Ident
+ */
+export declare type Expr_Ident = Message<"google.api.expr.v1alpha1.Expr.Ident"> & {
+  /**
+   * Required. Holds a single, unqualified identifier, possibly preceded by a
+   * '.'.
+   *
+   * Qualified names are represented by the [Expr.Select][google.api.expr.v1alpha1.Expr.Select] expression.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.Ident.
+ * Use `create(Expr_IdentSchema)` to create a new message.
+ */
+export declare const Expr_IdentSchema: GenMessage<Expr_Ident>;
+
+/**
+ * A field selection expression. e.g. `request.auth`.
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr.Select
+ */
+export declare type Expr_Select = Message<"google.api.expr.v1alpha1.Expr.Select"> & {
+  /**
+   * Required. The target of the selection expression.
+   *
+   * For example, in the select expression `request.auth`, the `request`
+   * portion of the expression is the `operand`.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr operand = 1;
+   */
+  operand?: Expr;
+
+  /**
+   * Required. The name of the field to select.
+   *
+   * For example, in the select expression `request.auth`, the `auth` portion
+   * of the expression would be the `field`.
+   *
+   * @generated from field: string field = 2;
+   */
+  field: string;
+
+  /**
+   * Whether the select is to be interpreted as a field presence test.
+   *
+   * This results from the macro `has(request.auth)`.
+   *
+   * @generated from field: bool test_only = 3;
+   */
+  testOnly: boolean;
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.Select.
+ * Use `create(Expr_SelectSchema)` to create a new message.
+ */
+export declare const Expr_SelectSchema: GenMessage<Expr_Select>;
+
+/**
+ * A call expression, including calls to predefined functions and operators.
+ *
+ * For example, `value == 10`, `size(map_value)`.
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr.Call
+ */
+export declare type Expr_Call = Message<"google.api.expr.v1alpha1.Expr.Call"> & {
+  /**
+   * The target of an method call-style expression. For example, `x` in
+   * `x.f()`.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr target = 1;
+   */
+  target?: Expr;
+
+  /**
+   * Required. The name of the function or method being called.
+   *
+   * @generated from field: string function = 2;
+   */
+  function: string;
+
+  /**
+   * The arguments.
+   *
+   * @generated from field: repeated google.api.expr.v1alpha1.Expr args = 3;
+   */
+  args: Expr[];
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.Call.
+ * Use `create(Expr_CallSchema)` to create a new message.
+ */
+export declare const Expr_CallSchema: GenMessage<Expr_Call>;
+
+/**
+ * A list creation expression.
+ *
+ * Lists may either be homogenous, e.g. `[1, 2, 3]`, or heterogeneous, e.g.
+ * `dyn([1, 'hello', 2.0])`
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr.CreateList
+ */
+export declare type Expr_CreateList = Message<"google.api.expr.v1alpha1.Expr.CreateList"> & {
+  /**
+   * The elements part of the list.
+   *
+   * @generated from field: repeated google.api.expr.v1alpha1.Expr elements = 1;
+   */
+  elements: Expr[];
+
+  /**
+   * The indices within the elements list which are marked as optional
+   * elements.
+   *
+   * When an optional-typed value is present, the value it contains
+   * is included in the list. If the optional-typed value is absent, the list
+   * element is omitted from the CreateList result.
+   *
+   * @generated from field: repeated int32 optional_indices = 2;
+   */
+  optionalIndices: number[];
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.CreateList.
+ * Use `create(Expr_CreateListSchema)` to create a new message.
+ */
+export declare const Expr_CreateListSchema: GenMessage<Expr_CreateList>;
+
+/**
+ * A map or message creation expression.
+ *
+ * Maps are constructed as `{'key_name': 'value'}`. Message construction is
+ * similar, but prefixed with a type name and composed of field ids:
+ * `types.MyType{field_id: 'value'}`.
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr.CreateStruct
+ */
+export declare type Expr_CreateStruct = Message<"google.api.expr.v1alpha1.Expr.CreateStruct"> & {
+  /**
+   * The type name of the message to be created, empty when creating map
+   * literals.
+   *
+   * @generated from field: string message_name = 1;
+   */
+  messageName: string;
+
+  /**
+   * The entries in the creation expression.
+   *
+   * @generated from field: repeated google.api.expr.v1alpha1.Expr.CreateStruct.Entry entries = 2;
+   */
+  entries: Expr_CreateStruct_Entry[];
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.CreateStruct.
+ * Use `create(Expr_CreateStructSchema)` to create a new message.
+ */
+export declare const Expr_CreateStructSchema: GenMessage<Expr_CreateStruct>;
+
+/**
+ * Represents an entry.
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr.CreateStruct.Entry
+ */
+export declare type Expr_CreateStruct_Entry = Message<"google.api.expr.v1alpha1.Expr.CreateStruct.Entry"> & {
+  /**
+   * Required. An id assigned to this node by the parser which is unique
+   * in a given expression tree. This is used to associate type
+   * information and other attributes to the node.
+   *
+   * @generated from field: int64 id = 1;
+   */
+  id: bigint;
+
+  /**
+   * The `Entry` key kinds.
+   *
+   * @generated from oneof google.api.expr.v1alpha1.Expr.CreateStruct.Entry.key_kind
+   */
+  keyKind: {
+    /**
+     * The field key for a message creator statement.
+     *
+     * @generated from field: string field_key = 2;
+     */
+    value: string;
+    case: "fieldKey";
+  } | {
+    /**
+     * The key expression for a map creation statement.
+     *
+     * @generated from field: google.api.expr.v1alpha1.Expr map_key = 3;
+     */
+    value: Expr;
+    case: "mapKey";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * Required. The value assigned to the key.
+   *
+   * If the optional_entry field is true, the expression must resolve to an
+   * optional-typed value. If the optional value is present, the key will be
+   * set; however, if the optional value is absent, the key will be unset.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr value = 4;
+   */
+  value?: Expr;
+
+  /**
+   * Whether the key-value pair is optional.
+   *
+   * @generated from field: bool optional_entry = 5;
+   */
+  optionalEntry: boolean;
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.CreateStruct.Entry.
+ * Use `create(Expr_CreateStruct_EntrySchema)` to create a new message.
+ */
+export declare const Expr_CreateStruct_EntrySchema: GenMessage<Expr_CreateStruct_Entry>;
+
+/**
+ * A comprehension expression applied to a list or map.
+ *
+ * Comprehensions are not part of the core syntax, but enabled with macros.
+ * A macro matches a specific call signature within a parsed AST and replaces
+ * the call with an alternate AST block. Macro expansion happens at parse
+ * time.
+ *
+ * The following macros are supported within CEL:
+ *
+ * Aggregate type macros may be applied to all elements in a list or all keys
+ * in a map:
+ *
+ * *  `all`, `exists`, `exists_one` -  test a predicate expression against
+ *    the inputs and return `true` if the predicate is satisfied for all,
+ *    any, or only one value `list.all(x, x < 10)`.
+ * *  `filter` - test a predicate expression against the inputs and return
+ *    the subset of elements which satisfy the predicate:
+ *    `payments.filter(p, p > 1000)`.
+ * *  `map` - apply an expression to all elements in the input and return the
+ *    output aggregate type: `[1, 2, 3].map(i, i * i)`.
+ *
+ * The `has(m.x)` macro tests whether the property `x` is present in struct
+ * `m`. The semantics of this macro depend on the type of `m`. For proto2
+ * messages `has(m.x)` is defined as 'defined, but not set`. For proto3, the
+ * macro tests whether the property is set to its default. For map and struct
+ * types, the macro tests whether the property `x` is defined on `m`.
+ *
+ * @generated from message google.api.expr.v1alpha1.Expr.Comprehension
+ */
+export declare type Expr_Comprehension = Message<"google.api.expr.v1alpha1.Expr.Comprehension"> & {
+  /**
+   * The name of the iteration variable.
+   *
+   * @generated from field: string iter_var = 1;
+   */
+  iterVar: string;
+
+  /**
+   * The range over which var iterates.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr iter_range = 2;
+   */
+  iterRange?: Expr;
+
+  /**
+   * The name of the variable used for accumulation of the result.
+   *
+   * @generated from field: string accu_var = 3;
+   */
+  accuVar: string;
+
+  /**
+   * The initial value of the accumulator.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr accu_init = 4;
+   */
+  accuInit?: Expr;
+
+  /**
+   * An expression which can contain iter_var and accu_var.
+   *
+   * Returns false when the result has been computed and may be used as
+   * a hint to short-circuit the remainder of the comprehension.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr loop_condition = 5;
+   */
+  loopCondition?: Expr;
+
+  /**
+   * An expression which can contain iter_var and accu_var.
+   *
+   * Computes the next value of accu_var.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr loop_step = 6;
+   */
+  loopStep?: Expr;
+
+  /**
+   * An expression which can contain accu_var.
+   *
+   * Computes the result.
+   *
+   * @generated from field: google.api.expr.v1alpha1.Expr result = 7;
+   */
+  result?: Expr;
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Expr.Comprehension.
+ * Use `create(Expr_ComprehensionSchema)` to create a new message.
+ */
+export declare const Expr_ComprehensionSchema: GenMessage<Expr_Comprehension>;
+
+/**
+ * Represents a primitive literal.
+ *
+ * Named 'Constant' here for backwards compatibility.
+ *
+ * This is similar as the primitives supported in the well-known type
+ * `google.protobuf.Value`, but richer so it can represent CEL's full range of
+ * primitives.
+ *
+ * Lists and structs are not included as constants as these aggregate types may
+ * contain [Expr][google.api.expr.v1alpha1.Expr] elements which require evaluation and are thus not constant.
+ *
+ * Examples of literals include: `"hello"`, `b'bytes'`, `1u`, `4.2`, `-2`,
+ * `true`, `null`.
+ *
+ * @generated from message google.api.expr.v1alpha1.Constant
+ */
+export declare type Constant = Message<"google.api.expr.v1alpha1.Constant"> & {
+  /**
+   * Required. The valid constant kinds.
+   *
+   * @generated from oneof google.api.expr.v1alpha1.Constant.constant_kind
+   */
+  constantKind: {
+    /**
+     * null value.
+     *
+     * @generated from field: google.protobuf.NullValue null_value = 1;
+     */
+    value: NullValue;
+    case: "nullValue";
+  } | {
+    /**
+     * boolean value.
+     *
+     * @generated from field: bool bool_value = 2;
+     */
+    value: boolean;
+    case: "boolValue";
+  } | {
+    /**
+     * int64 value.
+     *
+     * @generated from field: int64 int64_value = 3;
+     */
+    value: bigint;
+    case: "int64Value";
+  } | {
+    /**
+     * uint64 value.
+     *
+     * @generated from field: uint64 uint64_value = 4;
+     */
+    value: bigint;
+    case: "uint64Value";
+  } | {
+    /**
+     * double value.
+     *
+     * @generated from field: double double_value = 5;
+     */
+    value: number;
+    case: "doubleValue";
+  } | {
+    /**
+     * string value.
+     *
+     * @generated from field: string string_value = 6;
+     */
+    value: string;
+    case: "stringValue";
+  } | {
+    /**
+     * bytes value.
+     *
+     * @generated from field: bytes bytes_value = 7;
+     */
+    value: Uint8Array;
+    case: "bytesValue";
+  } | {
+    /**
+     * protobuf.Duration value.
+     *
+     * Deprecated: duration is no longer considered a builtin cel type.
+     *
+     * @generated from field: google.protobuf.Duration duration_value = 8 [deprecated = true];
+     * @deprecated
+     */
+    value: Duration;
+    case: "durationValue";
+  } | {
+    /**
+     * protobuf.Timestamp value.
+     *
+     * Deprecated: timestamp is no longer considered a builtin cel type.
+     *
+     * @generated from field: google.protobuf.Timestamp timestamp_value = 9 [deprecated = true];
+     * @deprecated
+     */
+    value: Timestamp;
+    case: "timestampValue";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.Constant.
+ * Use `create(ConstantSchema)` to create a new message.
+ */
+export declare const ConstantSchema: GenMessage<Constant>;
+
+/**
+ * Source information collected at parse time.
+ *
+ * @generated from message google.api.expr.v1alpha1.SourceInfo
+ */
+export declare type SourceInfo = Message<"google.api.expr.v1alpha1.SourceInfo"> & {
+  /**
+   * The syntax version of the source, e.g. `cel1`.
+   *
+   * @generated from field: string syntax_version = 1;
+   */
+  syntaxVersion: string;
+
+  /**
+   * The location name. All position information attached to an expression is
+   * relative to this location.
+   *
+   * The location could be a file, UI element, or similar. For example,
+   * `acme/app/AnvilPolicy.cel`.
+   *
+   * @generated from field: string location = 2;
+   */
+  location: string;
+
+  /**
+   * Monotonically increasing list of code point offsets where newlines
+   * `\n` appear.
+   *
+   * The line number of a given position is the index `i` where for a given
+   * `id` the `line_offsets[i] < id_positions[id] < line_offsets[i+1]`. The
+   * column may be derivd from `id_positions[id] - line_offsets[i]`.
+   *
+   * @generated from field: repeated int32 line_offsets = 3;
+   */
+  lineOffsets: number[];
+
+  /**
+   * A map from the parse node id (e.g. `Expr.id`) to the code point offset
+   * within the source.
+   *
+   * @generated from field: map<int64, int32> positions = 4;
+   */
+  positions: { [key: string]: number };
+
+  /**
+   * A map from the parse node id where a macro replacement was made to the
+   * call `Expr` that resulted in a macro expansion.
+   *
+   * For example, `has(value.field)` is a function call that is replaced by a
+   * `test_only` field selection in the AST. Likewise, the call
+   * `list.exists(e, e > 10)` translates to a comprehension expression. The key
+   * in the map corresponds to the expression id of the expanded macro, and the
+   * value is the call `Expr` that was replaced.
+   *
+   * @generated from field: map<int64, google.api.expr.v1alpha1.Expr> macro_calls = 5;
+   */
+  macroCalls: { [key: string]: Expr };
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.SourceInfo.
+ * Use `create(SourceInfoSchema)` to create a new message.
+ */
+export declare const SourceInfoSchema: GenMessage<SourceInfo>;
+
+/**
+ * A specific position in source.
+ *
+ * @generated from message google.api.expr.v1alpha1.SourcePosition
+ */
+export declare type SourcePosition = Message<"google.api.expr.v1alpha1.SourcePosition"> & {
+  /**
+   * The soucre location name (e.g. file name).
+   *
+   * @generated from field: string location = 1;
+   */
+  location: string;
+
+  /**
+   * The UTF-8 code unit offset.
+   *
+   * @generated from field: int32 offset = 2;
+   */
+  offset: number;
+
+  /**
+   * The 1-based index of the starting line in the source text
+   * where the issue occurs, or 0 if unknown.
+   *
+   * @generated from field: int32 line = 3;
+   */
+  line: number;
+
+  /**
+   * The 0-based index of the starting position within the line of source text
+   * where the issue occurs.  Only meaningful if line is nonzero.
+   *
+   * @generated from field: int32 column = 4;
+   */
+  column: number;
+};
+
+/**
+ * Describes the message google.api.expr.v1alpha1.SourcePosition.
+ * Use `create(SourcePositionSchema)` to create a new message.
+ */
+export declare const SourcePositionSchema: GenMessage<SourcePosition>;