Skip to content

Releases: STAPLE-verse/marker-template-spec

v1.1.0

Choose a tag to compare

@doomlab doomlab released this 09 Oct 00:26

Additive changes to the Core V1 form schema profile. Every package that conformed to 1.0.0 still conforms; the profile URIs and package schema are unchanged.

Core V1 now allows

  • the checkboxes widget: the standard RJSF widget for a multi-select array of enumerated strings, which Form Studio's "Checkboxes (Multi-select)" field writes
  • the enumNames keyword: display labels parallel to enum, which Form Studio writes when options have text different from their stored value

STAPLE forms using either were being rejected on import into MARKER ("The checkboxes widget is outside the Core V1 subset").

New capability fixtures: checkboxes-widget and enum-names.

Runtime: @staple-verse/marker-template-runtime@1.1.0 is attached as staple-verse-marker-template-runtime-1.1.0.tgz. Applications consume it by URL, as with 1.0.0:
https://github.com/STAPLE-verse/marker-template-spec/releases/download/v1.1.0/staple-verse-marker-template-runtime-1.1.0.tgz

v1.0.0 — First production-stable release

Choose a tag to compare

@marton-balazs-kovacs marton-balazs-kovacs released this 14 Sep 15:53

Declared production-stable per the promotion gate in CONTRIBUTING.md:
the candidate has been integrated in STAPLE, Form Studio, and MARKER.

No contract changes relative to 1.0.0-rc.4 — this release freezes
that content as final.

Full history: see CHANGELOG.md.

v1.0.0-rc.4

v1.0.0-rc.4 Pre-release
Pre-release

Choose a tag to compare

@marton-balazs-kovacs marton-balazs-kovacs released this 05 Sep 15:46

Removed role "Creator" as a mandatory role for published packages on at least one contributor. DataCite integration might need it later, but for a lean and robust first version it is premature without a use case.

v1.0.0-rc.3

v1.0.0-rc.3 Pre-release
Pre-release

Choose a tag to compare

@marton-balazs-kovacs marton-balazs-kovacs released this 28 Aug 10:58

Semantic V1 binding validation now reports one diagnostic per invalid binding.

Dispatch is keyed on valueKind, so a malformed predicate (or similar) no longer produces duplicated, contradictory SEMANTIC_COMPONENT_INVALID errors from the other binding kinds. Valid/invalid documents are unchanged.

v1.0.0-rc.2

v1.0.0-rc.2 Pre-release
Pre-release

Choose a tag to compare

@marton-balazs-kovacs marton-balazs-kovacs released this 27 Aug 12:10

Second V1 release candidate for the MARKER Metadata Template Specification.
Consumers must pin this exact candidate; it must not be assumed compatible
with v1.0.0-rc.1.

Changed

  • Exported analyzeSemanticV1Bindings and its SemanticBindingAnalysis
    result type from the TypeScript runtime's public entry point, so consumers
    can resolve a Semantic V1 field pointer and its effective Core value type
    without reimplementing the runtime's local-$ref and schema-variant
    resolution.
  • Added findAncestorNodeBindings, a standalone, non-normative query that
    returns the node bindings structurally containing a given field pointer,
    nearest first. It shares its containment logic with validateSemanticV1's
    node-ownership check, so the entry it marks nearest always agrees with
    what the runtime itself will accept as a conformant parentNodePointer.
  • Exported the supporting FieldResolutionStatus, JsonSchemaNode,
    TypedValueSchema, and SemanticAncestorNodeBinding types alongside the
    above.

Why

rc.1's TypeScript runtime only exposed whole-document validation
(validateSemanticV1). Form Studio's Visual Builder integration needs
per-binding field-pointer resolution and nearest-node-parent lookup while a
user is still mid-edit, before a document is fully valid. This candidate
adds those as non-normative, component-oriented queries built on the same
primitives the validator uses, so an authoring tool never has to
reimplement — and risk diverging from — the runtime's own resolution rules.

Installing

{
  "dependencies": {
    "@staple-verse/marker-template-runtime": "https://github.com/STAPLE-verse/marker-template-spec/releases/download/v1.0.0-rc.2/staple-verse-marker-template-runtime-1.0.0-rc.2.tgz"
  }
}

Core V1 & Semantic V1 release candidate

Pre-release

Choose a tag to compare

@marton-balazs-kovacs marton-balazs-kovacs released this 27 Aug 09:25

First V1 release candidate of the MARKER Metadata Template Specification.
Core V1 and Semantic V1 are complete enough for application integration,
but this tag is not yet the production-stable final v1.0.0.

Status

Consumers must pin this exact tag. An incompatible integration finding
produces a new rc.N rather than silently replacing this one. Final
v1.0.0 will be declared only after this candidate has been integrated
and verified in STAPLE, Form Studio, and MARKER, in that order.

Normative contract

  • Core V1 — conformsTo, metadata, form, and optional semantics
    package vocabulary; draft and published lifecycle metadata; draft-07
    form-schema profile; RFC 6901 field addressing; unified contributor
    credit with a reserved Creator role; staged validation and
    conformance model. See spec/v1/README.md.
  • Semantic V1 — optional binding profile for literal, iri, and
    node value kinds; local-$ref field resolution; explicit node
    ownership via parentNodePointer; exact value-to-IRI mappings; a
    deterministic, atomic, offline expanded JSON-LD projection algorithm.
    See spec/semantic/v1/README.md.
  • Stable profile URIs and package/component schema $ids are frozen
    under staplescience.com for this candidate (see the two spec READMEs
    above for the exact identifiers).

Fixtures and tooling

  • Normative JSON Schema (2020-12) for both components, with valid/invalid
    fixtures and stable diagnostic codes for every validation stage.
  • Portable, implementation-independent Semantic V1 projection fixtures,
    independently checked against expanded JSON-LD 1.1 / RDF via jsonld.
  • An optional, browser-safe TypeScript runtime
    (@staple-verse/marker-template-runtime@1.0.0-rc.1) implementing Core V1
    validation, Semantic V1 cross-component validation, and JSON-LD
    projection — non-normative, but exercised by the full conformance suite.
  • Application-compatibility evidence: Form Studio (65/65) and STAPLE
    (16/16) capability checks pass against this candidate.

Verify locally

npm ci
npm run check          # schema + rules conformance
npm run validate:jsonld # independent JSON-LD/RDF graph check