Report ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Type · import type { Report } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 2. Operations, reports, causes, problems

The one result of every write, discriminated by outcome. Frozen. Narrow on outcome before reading reason, supersededBy or patch:

• 'refused' and 'rolled-back' carry reason;
• 'superseded' carries supersededBy;
• 'dry-run' carries patch (RFC 6902 over SessionState: what the write alone would have changed; a dry run runs no beforeCommit function).

Inherited from ReportFields: op, origin, seq, revision, changed, matched, pending, completed, problems.

Declaration ​

export type Report = ReportFields & ({
  readonly outcome: 'committed' | 'staged' | 'deferred' | 'other';
  readonly reason?: undefined;
  readonly supersededBy?: undefined;
  readonly patch?: undefined;
} | {
  readonly outcome: 'refused' | 'rolled-back';
  readonly reason: Reason;
  readonly supersededBy?: undefined;
  readonly patch?: undefined;
} | {
  readonly outcome: 'superseded';
  readonly supersededBy: OpId;
  readonly reason?: undefined;
  readonly patch?: undefined;
} | {
  readonly outcome: 'dry-run';
  readonly patch: readonly JsonPatchOp[];
  readonly reason?: undefined;
  readonly supersededBy?: undefined;
});

Generic-API test (spec 3.1) ​