Adds one rule to a local element without replacing its existing rules.
Compares complete RAMEN workspaces and includes validation findings from both states.
Declares an annotation shape. Relationship selections refer to existing allowed definitions; declaring a shape never creates relations. Throws on unavailable or ambiguous selections without changing the model. Object selections are stored as references.
Adds an attribute to a local node and immediately validates the resulting project.
Adds a named data type and immediately validates the resulting project.
Adds one named literal to a local data type.
Creates another level in the same editable model workspace.
Creates a root node or a refinement and validates the resulting model.
Creates a root relation or a refinement and validates the resulting model.
Exports a single RAMEN graph. Annotation shapes and inherited declarations are stored once.
Returns an advisor or explains why the current model cannot provide suggestions.
Returns the annotation shapes declared directly by the project model.
Lists attributes visible on a local or imported node.
Returns the rules declared directly on an element, including one from an imported model.
Returns a detached declared data type, or undefined when absent. Built-in types have no declaration.
Returns a detached snapshot of the current project model.
Returns detached snapshots of the current model and every transitive dependency.
Returns the node that refines every selected node, or undefined for separate branches.
Returns a detached local or imported node, or undefined when absent. Ambiguous local IDs require a qualified reference.
Returns the node's base-first refinement lineage.
Returns detached project information, independently of the selected model level.
Lists all shared and shape-owned properties of one annotation shape.
Returns a detached local or imported relation, or undefined when absent.
Lists existing relationships with exact endpoints, including permitted predecessor definitions. Returns an empty list for no matches and all matches for parallel relationships; never edits the model. Requires valid node references and a valid model snapshot.
Lists current-level relations allowed by one annotation shape, including its cardinality rules.
Creates a RAMEN HAS_ANNOTATION relation when the node types permit it.
Opens an imported RAMEN project level for editing; the packaged reference model stays read-only.
Creates a RAMEN PART_OF relation when the node types permit it.
Shows the chosen next level and every later level that imports it.
Shows nodes, relationships and annotation declarations affected by removing a node.
Shows relationships and annotation declarations affected by removing a relationship.
Connects an Annotation to a Collection, Content or Entity, including their refinements.
Removes a locally declared annotation and validates the complete project.
Removes an attribute by stable identifier and validates the resulting project.
Removes one rule by ID from a local element while preserving its other rules.
Removes a local data type; unresolved references remain visible in validation diagnostics.
Removes one literal; an empty data type becomes unrestricted again.
Removes a next level; cascade also removes every level that depends on it.
Removes an unused node, or atomically removes its dependent definitions with cascade.
Removes an unused relation, or its dependants with explicit cascade.
Captures the entire editable RAMEN workspace, including sibling levels, as an independent state.
Lists properties and selected model relations available when declaring an annotation shape.
Lists annotation shapes available on a local or imported node.
Lists annotation shapes allowed on a carrier, optionally for one chosen Annotation node.
Optionalannotation: ElementInputLists possible relations and their compatible targets for one node.
Lists primitive and project-defined data types.
Lists local and imported node types that this level can refine.
Lists relations that can connect two nodes in this model.
Updates a local annotation shape, resolving endpoint selections or preserving supplied references, then validates the project.
Updates an attribute by stable identifier and validates the resulting project.
Updates one rule by ID on a local element while preserving its other rules.
Updates a local data type and validates the resulting project.
Updates one literal by stable identifier.
Updates this model's identity and the exact imports used by later levels.
Updates a level that directly imports this model.
Updates a local node and immediately validates the resulting project.
Updates a local relation and validates the resulting project.
Validates the complete current project and returns its graph on success.
Findings are returned in diagnostics; see Diagnostics.
Checks one property input for an annotation shape without requiring recorded nodes or links. Throws if the type or property is unavailable. Cross-record rules require validateInstances().
Checks whether a new attribute name conflicts with visible attributes.
Checks one local or inherited attribute input. Custom evaluators must work without a data graph. Invalid projects and values return diagnostics.
Validates a complete data graph against this RAMEN model.
Optionalconstraints: ConstraintRegistryReturns project-wide findings plus findings attached to a node, its ancestors or incident relations.
Checks one value against a built-in or declared data type, including literals and value rules. Invalid projects and values return diagnostics.
StaticcreateCreates an empty project that imports the current RAMEN reference model.
StaticcreateCreates another model level that imports an existing RAMEN project model.
StaticimportRestores an editable project from a shared graph and validates every model level.
StaticloadLoads a project with all models needed to resolve its imports. Content errors remain available through validate().
Adds the RAMEN vocabulary and annotation rules to shared generic editing.