Functions#

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { ConstantSignature } from "./ConstantSignature.js";
import type { ExpressionBudgets } from "./ExpressionBudgets.js";
import type { FunctionSignature } from "./FunctionSignature.js";
import type { KeywordSignature } from "./KeywordSignature.js";
import type { NamespaceDefinition } from "./NamespaceDefinition.js";
import type { NodeDefinition } from "./NodeDefinition.js";
import type { OperatorsCatalog } from "./OperatorsCatalog.js";
import type { PropertySignature } from "./PropertySignature.js";
import type { ShadingCapability } from "./ShadingCapability.js";

/**
 * `engine_catalog`'s wire shape: the node table, the shading→capability
 * table (`document::vocabulary::SHADINGS`) a shading picker reads to grey
 * out exposure for a mode that cannot meter, and the full expression
 * vocabulary — namespace/builtin function tables, constants, keyword
 * literals, array/string methods, operators, properties, blocked member
 * names, and the sandbox's numeric budgets. Session-free. Named
 * `ShadingCapability` because `scene::Shading` is the mode-name enum.
 */
export type Catalog = { 
/**
 * derived — every registered node's definition.
 */
nodes: Array<NodeDefinition>, 
/**
 * derived — the shading→capability table.
 */
shadings: Array<ShadingCapability>, 
/**
 * derived — every expression namespace's function table, in
 * `expression::namespaces::NAMES` order.
 */
namespaces: Array<NamespaceDefinition>, 
/**
 * derived — the five builtin function groups (`Math`, `Number`,
 * `Object`, `Array`, `Global`), in `expression::builtins::BUILTIN_NAMES`
 * order. `Number`/`Array` each appear twice across `builtins`/`Global`
 * when a root is both an object with members and itself callable — see
 * `expression::builtins::GLOBAL_FUNCTIONS`'s doc comment.
 */
builtins: Array<NamespaceDefinition>, 
/**
 * derived — `Math`'s and `Number`'s numeric constants (`Math.PI`,
 * `Number.EPSILON`, …), which are values, not functions, so `builtins`
 * cannot carry them.
 */
constants: Array<ConstantSignature>, 
/**
 * derived — every `Value::Array` method, in
 * `expression::eval::ARRAY_METHODS` order.
 */
arrayMethods: Array<FunctionSignature>, 
/**
 * derived — every `Value::Text` method, in
 * `expression::eval::STRING_METHODS` order.
 */
stringMethods: Array<FunctionSignature>, 
/**
 * derived — the binary and unary operator tables.
 */
operators: OperatorsCatalog, 
/**
 * derived — fixed member names `Value::member` (`expression/value.rs`)
 * resolves directly, outside every method/function table above (a
 * plain field read, no call) — `expression::value::PROPERTIES`.
 */
properties: Array<PropertySignature>, 
/**
 * derived — every keyword literal (`true`, `false`, `null`,
 * `undefined`) the parser/evaluator resolve without a scope lookup —
 * `expression::value::KEYWORD_LITERALS`.
 */
keywords: Array<KeywordSignature>, 
/**
 * derived — member names `Value::member` refuses outright (a JS
 * prototype sandbox-escape name) — what a stored expression is REFUSED,
 * not what it is granted — `expression::eval::BLOCKED_KEYS`.
 */
blockedMemberNames: Array<string>, 
/**
 * derived — the expression sandbox's numeric budgets (`eval.rs`/
 * `parser.rs`/`document::model`'s own `pub const`s).
 */
budgets: ExpressionBudgets, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { FunctionSignature } from "./FunctionSignature.js";

/**
 * One expression namespace (`Point`, `Arc`, …) — its function table, mirrored
 * off `expression::namespaces::functions_of` without the `call` fn pointer,
 * which does not serialize.
 */
export type NamespaceDefinition = { 
/**
 * identity — the namespace root name (`Point.distance` reads as `Point`
 * + `distance`).
 */
name: string, 
/**
 * derived — every member function this namespace exposes.
 */
functions: Array<FunctionSignature>, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { ParameterSignature } from "./ParameterSignature.js";

/**
 * One `expression::namespaces::FunctionDefinition` without its `call` fn
 * pointer — the serializable half `Catalog.namespaces` mirrors.
 */
export type FunctionSignature = { 
/**
 * identity — the member name (`Point.distance`'s `distance`).
 */
name: string, 
/**
 * derived — the function's own parameters, in call order.
 */
parameters: Array<ParameterSignature>, 
/**
 * derived — the value-type word the function returns.
 */
returns: string, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * One `expression::namespaces::ParameterDefinition`, mirrored for the wire.
 */
export type ParameterSignature = { 
/**
 * identity — the parameter's name.
 */
name: string, 
/**
 * derived — the value-type word (`document::vocabulary::TYPE_REGISTRY`
 * where one applies, else the closest `Value` variant name).
 */
valueType: string, 
/**
 * derived — whether the closure tolerates this argument being absent.
 */
optional: boolean, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * One `Math`- or `Number`-style numeric constant, mirrored off
 * `expression::builtins::ConstantDefinition` for the wire.
 */
export type ConstantSignature = { 
/**
 * identity — which root this constant hangs on (`Math`, `Number`).
 */
object: string, 
/**
 * identity — the constant's name (`Math.PI`'s `PI`).
 */
name: string, 
/**
 * derived — the constant's numeric value.
 */
value: number, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * One `expression::value::PropertyDefinition`, mirrored for the wire —
 * `Value::member`'s hand-kept record, since `value.rs` itself is not a
 * data table.
 */
export type PropertySignature = { 
/**
 * identity — the value-type word of the receiver this property reads
 * from (`array`, `string`).
 */
receiver: string, 
/**
 * identity — the property's name (`length`).
 */
name: string, 
/**
 * derived — the value-type word this property reads back.
 */
returns: string, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * One `expression::value::KeywordDefinition`, mirrored for the wire.
 */
export type KeywordSignature = { 
/**
 * identity — the keyword's name (`true`, `null`, …).
 */
name: string, 
/**
 * derived — the value-type word this keyword evaluates to.
 */
valueType: string, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { BinaryOperatorSignature } from "./BinaryOperatorSignature.js";
import type { UnaryOperatorSignature } from "./UnaryOperatorSignature.js";

/**
 * `Catalog.operators`'s wire shape: the binary and unary operator tables.
 */
export type OperatorsCatalog = { 
/**
 * derived — every binary operator, in
 * `expression::parser::BINARY_OPERATORS` order.
 */
binary: Array<BinaryOperatorSignature>, 
/**
 * derived — every unary operator, in
 * `expression::parser::UNARY_OPERATORS` order.
 */
unary: Array<UnaryOperatorSignature>, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * One `expression::parser::BinaryOperatorDefinition`, mirrored for the wire.
 */
export type BinaryOperatorSignature = { 
/**
 * identity — the operator's token text (`+`, `**`, `===`, …).
 */
token: string, 
/**
 * derived — precedence tier; higher binds tighter.
 */
precedence: number, 
/**
 * derived — whether the operator groups right-to-left (`**` is the
 * only one).
 */
rightAssociative: boolean, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * One `expression::parser::UnaryOperatorDefinition`, mirrored for the wire.
 */
export type UnaryOperatorSignature = { 
/**
 * identity — the operator's token text (`+`, `-`, `!`, `~`).
 */
token: string, };

// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.

/**
 * The expression sandbox's DoS-guard budgets, mirrored off each `pub const`
 * at its own definition site — none of these live in this module.
 */
export type ExpressionBudgets = { 
/**
 * derived — `expression::eval::EVAL_STEP_BUDGET`.
 */
evalStepBudget: bigint, 
/**
 * derived — `expression::eval::MAX_ARRAY_LENGTH`.
 */
maxArrayLength: number, 
/**
 * derived — `expression::eval::MAX_CALL_DEPTH`.
 */
maxCallDepth: number, 
/**
 * derived — `expression::parser::EXPR_MAX_AST_DEPTH`.
 */
exprMaxAstDepth: number, 
/**
 * derived — `expression::parser::EXPR_MAX_LENGTH` (SSOT `document::model::EXPR_MAX_LENGTH`).
 */
exprMaxLength: number, };