Module declarative 

Structs

YamlCompileContext

Public struct YamlCompileContext used by this module.

Constants

MAX_DECLARATIVE_FILES 🔒

MAX_DECLARATIVE_FILE_BYTES 🔒

YAML_BUFFER_LIMIT 🔒

YAML_INCLUDE_MAX_DEPTH 🔒

Functions

api_prefixed_route_path

Performs API prefixed route path.

artifact_shared_template_path

Resolves an app-owned artifact template without falling back to shell commands.

attach_yaml_source_map 🔒

Retains exact scalar declaration locations for generated JSON diagnostics.

build_source_path

Builds source path.

compile_yaml_matches_in_directory

Compiles matching YAML files to sibling JSON artifacts without invoking a toolchain.

compile_yaml_matches_in_directory_inner 🔒

Compiles YAML matches in directory inner.

copy_member 🔒

Copies member.

database_authoring_path 🔒

Resolves the source manifest-selected database contract for scoped compiler policy.

declarative_manifest_has_required_fields

Validates the minimum fields required by a declarative app manifest.

declarative_source_append_generated_route_mut

Performs declarative source append generated route mut.

declarative_source_append_surface

Performs declarative source append surface.

declarative_source_append_unique_string_mut

Appends a string to an array unless the same string is already present.

declarative_source_array_has_string

Performs declarative source array has string.

declarative_source_build_operation_mut

Performs declarative source build operation mut.

declarative_source_build_route_operation_mut

Performs declarative source build route operation mut.

declarative_source_build_surface_mut

Builds one generated surface from declarative entity, query, form, and route values.

declarative_source_compile_fixtures_in_directory

Performs declarative source compile fixtures in directory.

declarative_source_compile_pages_in_directory

Performs declarative source compile pages in directory.

declarative_source_copy_optional_member

Performs declarative source copy optional member.

declarative_source_default_context_binding_mut

Performs declarative source default context binding mut.

declarative_source_default_list_columns_from_form_mut

Performs declarative source default list columns from form mut.

declarative_source_default_list_columns_mut

Performs declarative source default list columns mut.

declarative_source_default_path_segment

Derives a stable generated-admin collection segment from entity metadata.

declarative_source_derive_generated_admin_routes

Derives missing generated-admin child routes and writes the route artifact.

declarative_source_derive_generated_api_routes

Derives missing generated-api mutation routes and writes the route artifact.

declarative_source_derive_generated_surface_fixture

Derives and writes the generated surface fixture from framework contract files.

declarative_source_derived_audit_events_mut

Performs declarative source derived audit events mut.

declarative_source_derived_defaults_mut

Performs declarative source derived defaults mut.

declarative_source_derived_filters_mut

Performs declarative source derived filters mut.

declarative_source_derived_response_fields_mut

Performs declarative source derived response fields mut.

declarative_source_derived_sorts_mut

Performs declarative source derived sorts mut.

declarative_source_derived_surface_uniqueness_rules_mut

Performs declarative source derived surface uniqueness rules mut.

declarative_source_find_field_decl

Finds one form-field declaration by its field id.

declarative_source_find_generated_form_for_entity

Performs declarative source find generated form for entity.

declarative_source_find_generated_query_for_entity

Performs declarative source find generated query for entity.

declarative_source_find_manage_route

Performs declarative source find manage route.

declarative_source_find_object_by_string_field

Finds the first object in an array whose named field equals the expected string.

declarative_source_framework_path

Builds a safe path to one framework-owned contract file.

declarative_source_generated_api_request_hooks 🔒

Performs declarative source generated API request hooks.

declarative_source_has_yaml_fixture

Performs declarative source has YAML fixture.

declarative_source_has_yaml_manifest

Returns whether the YAML app manifest exists at an app root.

declarative_source_has_yaml_page

Performs declarative source has YAML page.

declarative_source_identity_param

Performs declarative source identity param.

declarative_source_identity_param_from_surface

Performs declarative source identity param from surface.

declarative_source_label

Converts an identifier into the human-readable label used by generated surfaces.

declarative_source_load_fixture

Performs declarative source load fixture.

declarative_source_load_manifest

Loads the declarative manifest text from an app root with a bounded read.

declarative_source_load_page_decl

Performs declarative source load page decl.

declarative_source_load_ref_target

Loads a bounded framework contract reference such as fields.yml#entity.fields.

declarative_source_manage_path_from_create_route 🔒

Performs declarative source manage path from create route.

declarative_source_operation_path

Builds one operation path using the route contract’s colon-parameter syntax.

declarative_source_option_values_mut

Performs declarative source option values mut.

declarative_source_path_segment_from_manage_path

Converts one generated-admin path into its final resource segment.

declarative_source_resolve_dotted_path

Resolves a dot-separated object or array path without creating intermediate values.

declarative_source_route_path_has_segment

Performs declarative source route path has segment.

declarative_source_route_path_to_surface_path

Performs declarative source route path to surface path.

declarative_source_runtime_collection

Performs declarative source runtime collection.

declarative_source_surface_anchor_route 🔒

Performs declarative source surface anchor route.

declarative_source_surface_path_to_route_path

Performs declarative source surface path to route path.

default_item_title_field

Returns the default item title field.

load_yaml_source

Loads YAML source.

normalize_compiled_json_references

Rewrites compiled YAML references to sibling JSON artifacts in a deployment tree.

normalize_compiled_json_references_inner 🔒

Normalizes compiled JSON references inner.

normalize_compiled_json_value 🔒

Normalizes compiled JSON value.

normalize_compiled_reference_text 🔒

Normalizes compiled reference text.

parse_yaml_file 🔒

Parses YAML file.

read_framework_contract 🔒

Reads framework contract.

read_json_or_yaml 🔒

Reads JSON or YAML.

resolve_array 🔒

Resolves array.

safe_relative_path 🔒

Builds a safe relative path.

yaml_append_indented_block

Adds indentation to every line of an included YAML block.

yaml_buffer_append

Appends bounded YAML source text to an output buffer.

yaml_compile_add_value

Adds a completed value to the active compile container or root.

yaml_compile_context_free

Releases a YAML compile context.

yaml_compile_context_init

Initializes a YAML compile context.

yaml_compile_enabled

Reads and compiles one YAML file to JSON.

yaml_compile_peek

Borrows the current compile container.

yaml_compile_pop

Completes and returns the current container.

yaml_compile_push

Pushes a mapping or sequence container.

yaml_compile_to_json

Compiles YAML text to one JSON value.

yaml_dup_parent_dir

Returns the parent directory of a YAML source file.

yaml_handle_mapping_end

Ends a YAML mapping container.

yaml_handle_mapping_start

Starts a YAML mapping container.

yaml_handle_scalar

Adds a scalar YAML value using the same scalar rules as saphyr.

yaml_handle_sequence_end

Ends a YAML sequence container.

yaml_handle_sequence_start

Starts a YAML sequence container.

yaml_join_relative_path

Resolves a safe include path relative to a YAML source file.

yaml_line_is_fields_include

Detects an include directive on one YAML line.

yaml_lookup_include_section_value

Looks up a dotted section in a compiled YAML JSON value.

yaml_parse_include_token

Parses !include relative[#section] into its two components.

yaml_preprocess_includes_from_file

Preprocesses bounded recursive YAML includes using app-relative paths.

yaml_preprocess_includes_inner 🔒

Performs YAML preprocess includes inner.

yaml_read_as_json

Performs YAML read as JSON.

yaml_scalar_is_bool

Identifies a YAML boolean scalar.

yaml_scalar_is_float

Identifies a finite floating-point YAML scalar.

yaml_scalar_is_integer

Identifies an integer YAML scalar.

yaml_scalar_is_null

Identifies a YAML null scalar.

yaml_tag_is_bool

Identifies the YAML boolean tag.

yaml_tag_is_float

Identifies the YAML floating-point tag.

yaml_tag_is_int

Identifies the YAML integer tag.

yaml_tag_is_null

Identifies the YAML null tag.

yaml_tag_is_str

Identifies the YAML string tag.

yaml_token_is_include_path

Identifies the supported YAML include token form.