Skip to content

0013 What else counts as public interface

Source: #491

This record amends 0012.

Context and Problem Statement

491 listed what counts as public interface. Some parts were not on that list, and

0012 left them open. Do they fall under the versioning promise?

Considered Options

  • Each part counts as public interface (not discussed in a source).
  • Each part can change in any release (not discussed in a source).

Decision Outcome

These count as public interface and follow the promise:

  • React props
  • the web component's attributes, properties and events
  • the plugin API
  • CLI exit codes
  • the lowest supported Node.js version
  • the lowest supported React version and browser versions

The theme tokens (--pk-*) do not. A minor release can change them, and the changelog names the change.

Reason: not recorded.

Consequences

  • Raising the lowest supported Node.js, React or browser version is a break. From 1.0.0 it waits for a major release.
  • A host that sets --pk-* tokens reads the changelog before it updates.
  • Versioning holds the full list.