API Reference
interfaces
Shaclpropertyshape

@coasys/ad4m / Exports / SHACLPropertyShape

Interface: SHACLPropertyShape

SHACL Property Shape Represents constraints on a single property path

Table of contents

Properties

Properties

adder

Optional adder: AD4MAction[]

AD4M-specific: Adder action for collection properties

Defined in

shacl/SHACLShape.ts:159 (opens in a new tab)


class

Optional class: string

sh:class — the target SHACL node shape URI that linked nodes must conform to. Set automatically when a relation has a target model. Enables typed construction on the Rust/MCP side by referencing the full target shape.

Defined in

shacl/SHACLShape.ts:176 (opens in a new tab)


conformanceConditions

Optional conformanceConditions: ConformanceCondition[]

AD4M-specific: Structured conformance conditions (DB-agnostic). Each condition describes a check on the target node (flag match or required property).

Defined in

shacl/SHACLShape.ts:171 (opens in a new tab)


datatype

Optional datatype: string

Expected datatype (e.g., xsd:string, xsd:integer)

Defined in

shacl/SHACLShape.ts:123 (opens in a new tab)


getter

Optional getter: string

AD4M-specific: Pre-computed SurrealQL getter expression for reading this relation/property. For relations with a target model, this encodes conformance filtering so that Rust/MCP can execute the exact same query as the JS runtime.

Defined in

shacl/SHACLShape.ts:167 (opens in a new tab)


hasValue

Optional hasValue: string

Fixed value constraint (for Flag properties)

Defined in

shacl/SHACLShape.ts:144 (opens in a new tab)


local

Optional local: boolean

AD4M-specific: Local-only property

Defined in

shacl/SHACLShape.ts:147 (opens in a new tab)


maxCount

Optional maxCount: number

Maximum cardinality (single-valued if 1, omit for collections)

Defined in

shacl/SHACLShape.ts:132 (opens in a new tab)


maxInclusive

Optional maxInclusive: number

Maximum value (inclusive) for numeric properties

Defined in

shacl/SHACLShape.ts:141 (opens in a new tab)


minCount

Optional minCount: number

Minimum cardinality (required if >= 1)

Defined in

shacl/SHACLShape.ts:129 (opens in a new tab)


minInclusive

Optional minInclusive: number

Minimum value (inclusive) for numeric properties

Defined in

shacl/SHACLShape.ts:138 (opens in a new tab)


name

Optional name: string

Property name (e.g., "name", "ingredients") - used for generating named URIs

Defined in

shacl/SHACLShape.ts:117 (opens in a new tab)


nodeKind

Optional nodeKind: "IRI" | "Literal" | "BlankNode"

Node kind constraint (IRI, Literal, BlankNode)

Defined in

shacl/SHACLShape.ts:126 (opens in a new tab)


path

path: string

The property path (predicate URI)

Defined in

shacl/SHACLShape.ts:120 (opens in a new tab)


pattern

Optional pattern: string

Regex pattern for string validation

Defined in

shacl/SHACLShape.ts:135 (opens in a new tab)


remover

Optional remover: AD4MAction[]

AD4M-specific: Remover action for collection properties

Defined in

shacl/SHACLShape.ts:162 (opens in a new tab)


resolveLanguage

Optional resolveLanguage: string

AD4M-specific: Language to resolve property values through

Defined in

shacl/SHACLShape.ts:153 (opens in a new tab)


setter

Optional setter: AD4MAction[]

AD4M-specific: Setter action for this property

Defined in

shacl/SHACLShape.ts:156 (opens in a new tab)


writable

Optional writable: boolean

AD4M-specific: Writable property

Defined in

shacl/SHACLShape.ts:150 (opens in a new tab)