#3203 Docs: datastore-provider reference for datastoreControlPlaneStore and control-plane read options

What changed

swamp-club#3191 adds an optional method to the datastore provider contract, plus an optional argument on the control-plane read. Extension authors need both in the manual.

• datastoreControlPlaneStore?(): DatastoreControlPlaneStore on DatastoreProvider. It returns a read-only store, { get(key, options?) }, for records at the datastore-wide _control/<key>, whatever namespace a repo uses. swamp reads the datastore format marker (datastore-format) through it before every command that opens the datastore. Contract:

  • building it makes no sync service, binds no namespace and sends no request until get;
  • get is one request, with no credentials preflight;
  • only a missing record returns null; access denied and every other failure reject;
  • options.signal is honoured: the request and any retry backoff stop when it aborts.

  Without the method, swamp reads the marker through a fresh sync service's controlPlaneStore().

• ControlPlaneStore.get(key, options?) now takes { signal?: AbortSignal }. Ignoring it still works.

• assertDatastoreControlPlaneStoreConformance in @swamp-club/swamp-testing checks an implementation.

Page to update

content/manual/reference/extensions/datastore-provider.md:

• add the method to the provider table, with the contract above;
• add the get options to the control-plane store section;
• link the conformance check.