Get started

Module

@riducms/protocol

@riducms/protocol — Generated wire contracts and runtime guards shared by the SDK and admin.

Types 24

Functions 16

  • isValidationIssue()

    Guard an unknown value as a validation issue.

  • isErrorEnvelope()

    Guard an unknown value as a complete error envelope.

  • errorPayload()

    Return the payload inside a validated error envelope.

  • isPageEnvelope()

    Guard an unknown value as a page envelope.

  • bindSchemaManifest()

    Bind a compact wire manifest without expanding shared definitions into its resources. Each definition is checked once, so binding cost follows definitions, not placements.

  • blockDefinitionPath()

    Locate a canonical field path's innermost block definition among bound fields: the definition's slug and the field's path within it. A resource's own field has none. Only the containers along the path are resolved.

  • blockFieldCapabilities()

    The capabilities of a block definition's field at a placement without an entry of its own in `fields`, such as a row the client has yet to add: the definition's entry, located through the bound fields along the canonical path.

  • cloneSchemaField()

    Detached schema inspection for extension boundaries, retaining lazy reference bindings.

  • isAccessCapabilities()

    Public function isAccessCapabilities from @riducms/protocol.

  • isAdminCollectionListData()

    Decode the semantic list result once at the HTTP/bootstrap boundary.

  • isAdminLoaderResults()

    Validate the shared loader-result envelope. Application-specific values remain unknown here and are decoded by their generated loader references.

  • isAdminPreparedRouteData()

    Validate prepared domain data once, before route controllers receive it.

  • isRecord()

    Narrow a non-null, non-array object; its fields and prototype remain unchecked.

  • isUncountedPageEnvelope()

    Validate a `pagination=false` page, which must carry neither total.

  • mapBlockTypes()

    Project a container's placement views lazily, preserving its compact selection.

  • resolveBlockTypes()

    Resolve the block definitions a container selects, as placement views at its placement. Values, permissions and editor state are never cached here.

Interfaces 118

Constants 2