UMFDevelopersActions & workflowsReferenceActionsSchemasPlayground

Public action API reference

Import from the repository public entry point, src/index.ts, or from the built browser ESM dist/umf.js. The package is private and not available through npm installation. Create the normal SDK registry with createUmfRegistry(); action support is included. All declaration operations receive that registry explicitly; they do not replace other installed vocabularies. A bare new Registry() remains available for consumers that deliberately choose their interpreted vocabularies.

Declaration operations

Obligation IDs are absolute JSON Pointers, including selected attachment/model paths. Dependency entries deduplicate by exact pointer. Arrays retain authored order. Unknown relevant members cannot be overridden into compatibility. Unrelated unknown extension content is preserved without automatically blocking assessment.

Explicit interpretation operations

These are separate from inspection. Narrow rule/selector helpers do not prove an entire declaration eligible for native execution.

Portable plans and frozen manifests

These operations inspect supplied artifacts and construct inert bytes. They do not install an executor, authenticate a selection cut, issue a read grant or authorize business writes. Current-main API contracts and the separately pinned browser-local demonstration are different source cohorts.

CONTRACT-902, CONTRACT-903 and CONTRACT-904 own these proposed versioned companion profiles. Exact types live in plan-types.ts, manifest-types.ts, manifest-construction.ts and bulk.ts alongside the public exports. Capability assessment and source inspection remain separate from an executor's current authority and durable outcomes.

Public types

The exported type inventory above is checked mechanically against src/index.ts. Consult src/extensions/actions/types.ts, expression.ts, selector.ts, evaluation.ts, plan-types.ts and manifest-types.ts for exact members; CONTRACT-900 through CONTRACT-904 own their respective semantics. Entity inputs contain a selected Key and ordered literal components, not database row IDs. Committed recipe outputs are empty; changed identities and receipts are consumer metadata.

Errors and diagnostics

UmfError aborts malformed public inputs or refused mutations; supplied sources remain unchanged. Known semantic diagnostics are errors. Unchecked meaning warns and sets interpretation completeness false. Diagnostic identity is code/path/severity; message text is explanatory.

Existing core and Registry diagnostics propagate. Each action is bounded to 128 parameters, 128 combined pre/postconditions, 128 frames per list, 128 outputs, 128 failures, 256 effects, 256 assignments per effect and 64 roles. Rule text is limited to 65536 UTF-16 code units. Core document and value bounds also apply.

Consumer operations are not portable exports

invoke, lookup, preview and readAtLeast belong to the separate trusted consumer. They are logical methods, not specified HTTP endpoints. Lookup never executes. Preview persists no business or terminal state. A committed result includes verified effects or handler checks, exact net changes, opaque version and receipt; runtime observations are not equivalent to declaration validation.

Start with execution for trusted setup. Check support before applying a model to a native store.