autotel-schema 2.0.4 → 3.0.0

package/LICENSE

@@ -1,21 +1,191 @@
-MIT License
-
-Copyright (c) Jag Reehal 2025
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty
+percent (50%) or more of the outstanding shares, or (iii) beneficial
+ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source,
+and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled
+object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that
+is included in or attached to the work (an example is provided in the
+Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as
+a whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the
+purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its
+representatives, including but not limited to communication on electronic
+mailing lists, source code control systems, and issue tracking systems that
+are managed by, or on behalf of, the Licensor for the purpose of discussing
+and improving the Work, but excluding communication that is conspicuously
+marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
+this section) patent license to make, have made, use, offer to sell, sell,
+import, and otherwise transfer the Work, where such license applies only to
+those patent claims licensable by such Contributor that are necessarily
+infringed by their Contribution(s) alone or by combination of their
+Contribution(s) with the Work to which such Contribution(s) was submitted.
+If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or
+contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such
+litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and
+in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works
+a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that
+You distribute, all copyright, patent, trademark, and attribution notices
+from the Source form of the Work, excluding those notices that do not
+pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must include a
+readable copy of the attribution notices contained within such NOTICE file,
+excluding those notices that do not pertain to any part of the Derivative
+Works, in at least one of the following places: within a NOTICE text file
+distributed as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or, within a
+display generated by the Derivative Works, if and wherever such third-party
+notices normally appear. The contents of the NOTICE file are for
+informational purposes only and do not modify the License. You may add Your
+own attribution notices within Derivative Works that You distribute,
+alongside or as an addendum to the NOTICE text from the Work, provided that
+such additional attribution notices cannot be construed as modifying the
+License.
+
+     You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in
+this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to
+the Licensor shall be under the terms and conditions of this License,
+without any additional terms or conditions. Notwithstanding the above,
+nothing herein shall supersede or modify the terms of any separate license
+agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor, except
+as required for reasonable and customary use in describing the origin of
+the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to
+in writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any
+warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
+FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
+determining the appropriateness of using or redistributing the Work and
+assume any risks associated with Your exercise of permissions under this
+License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether
+in tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to
+in writing, shall any Contributor be liable to You for damages, including
+any direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or
+inability to use the Work (including but not limited to damages for loss of
+goodwill, work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor has been
+advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the
+Work or Derivative Works thereof, You may choose to offer, and charge a fee
+for, acceptance of support, warranty, indemnity, or other liability
+obligations and/or rights consistent with this License. However, in
+accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if
+You agree to indemnify, defend, and hold each Contributor harmless for any
+liability incurred by, or claims asserted against, such Contributor by
+reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!)  The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included
+on the same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -121,11 +121,70 @@ init({
 });
 ```
 
+## 5. Scenario conformance: contract one exercised flow
+
+Spans and attributes contract your telemetry *surface*. A **scenario** contracts the *behaviour* of one exercised flow: which events must fire, how many times, in what topology — and, for async flows, **when the observation is complete**, because without a completion boundary a missing event and an event that hasn't fired *yet* are indistinguishable.
+
+```ts
+export const contract = defineContract({
+  service: 'transfer',
+  version: '1.3.0',
+  spans: { /* ... */ },
+  scenarios: {
+    'transfer.accept': {
+      completion: { mode: 'terminal-event', event: 'transfer.queued', observationBudgetMs: 5000 },
+      events: {
+        'transfer.request': { cardinality: 'exactly 1' },
+        'transfer.validate': { cardinality: 'exactly 1' },
+        'transfer.queued': { cardinality: 'exactly 1' },
+        'transfer.retry': { cardinality: 'at most 3' },
+      },
+      edges: [['transfer.request', 'transfer.validate']], // ancestor→descendant, infra spans in between are fine
+    },
+  },
+});
+```
+
+Checking yields **three** outcomes, not two — infrastructure slowness is not reported as behavioural regression:
+
+```ts
+import { checkScenario, formatScenarioResult } from 'autotel-schema';
+
+const result = await checkScenario(
+  contract.scenarios!['transfer.accept'],
+  () => collector.peekTrace(traceId), // TestSpanCollector from autotel — or any ScenarioSpan[] source
+  { name: 'transfer.accept' },
+);
+// result.outcome:
+//   'conformant'     — boundary closed, signature satisfied
+//   'non-conformant' — required behaviour missing or invalid (definitive)
+//   'incomplete'     — boundary didn't close within the observation budget
+if (result.outcome !== 'conformant') throw new Error(formatScenarioResult(result));
+```
+
+Semantics worth knowing:
+
+- **Absence is definitive only after closure** (closed-world). Excess is definitive immediately: an unexpected error span or an exceeded `max` cardinality fails fast while the flow is still open.
+- **Undeclared events are additive** — reported in `result.additions`, never a failure. Improving instrumentation must not break CI.
+- **The observation budget bounds how long the checker waits.** It is not a business SLO — assert deadlines separately on `result.spans`.
+- An `externally-reconciled` boundary never closes in-process: use it for phases verified by a deferred job keyed by a durable business ID.
+
+Don't hand-write the first draft — record it:
+
+```ts
+import { proposeScenario } from 'autotel-schema';
+
+const { scenario, notes } = proposeScenario(runs); // runs: ScenarioSpan[][] from N controlled executions
+// notes: 'transfer.validate: exactly 1 (20/20 runs)', 'notification.send: 0..1 (14/20 runs) — review: variable', ...
+```
+
+Stable events become required cardinality, variable ones get ranges flagged for review, and the completion boundary + budget are suggested from observed timings. Review, trim, commit.
+
 ## What this is / isn't
 
-- **Is**: a contract for your telemetry surface: span names, attribute keys, types, enums, stability, and breaking-vs-additive evolution.
-- **Isn't**: a contract for application message payloads (use [`autotel-message-contract`](../autotel-message-contract)) or evidence that interactions ran (use [`autotel-pact`](../autotel-pact)). It does not require the OpenTelemetry SDK. The processor works against structural span types.
+- **Is**: a contract for your telemetry surface: span names, attribute keys, types, enums, stability, and breaking-vs-additive evolution — and, per scenario, the behavioural signature of one exercised flow (events, cardinality, topology, completion).
+- **Isn't**: a contract for application message payloads (use [`autotel-message-contract`](../autotel-message-contract)) or evidence that contracted interactions ran (use [`autotel-pact`](../autotel-pact)). It does not require the OpenTelemetry SDK. The processor works against structural span types.
 
 ## License
 
-MIT © Jag Reehal
+Apache-2.0 © Jag Reehal

package/dist/contract-Ymh_Q37N.d.cts

@@ -0,0 +1,305 @@
+//#region src/scenario.d.ts
+/**
+ * Scenario conformance — a flow-level contract checked against collected spans.
+ *
+ * Where {@link ./contract} declares the *surface* of your telemetry (span
+ * names + attributes), a scenario declares the *behaviour* of one exercised
+ * flow: which events must fire, how many times, in what parent/child
+ * topology, and — critically — **when the observation is complete**, because
+ * for an async flow a missing event and an event that has not fired *yet* are
+ * indistinguishable without a completion boundary.
+ *
+ * Checking a scenario yields one of three outcomes, not two:
+ *
+ * - `conformant` — the boundary closed and the signature satisfied the contract
+ * - `non-conformant` — required behaviour was missing or invalid (definitive)
+ * - `incomplete` — the boundary did not close within the observation budget;
+ *   infrastructure slowness is *not* reported as behavioural regression
+ *
+ * Absence is definitive only after closure (closed-world semantics). Excess
+ * is definitive immediately: a `max` cardinality violation or an unexpected
+ * error span fails the check even while the flow is still open.
+ *
+ * Undeclared events are **additive**: reported in `result.additions`, never a
+ * failure — improving instrumentation must not break CI.
+ *
+ * The span input shape is structurally compatible with `SerializedSpan` from
+ * `autotel/test-span-collector`, so a test can feed a collector's output
+ * straight in. Like the rest of this package the module is dependency-free —
+ * usable from vitest, a deferred reconciliation job, or a CLI alike.
+ *
+ * @example
+ * ```ts
+ * const result = await checkScenario(
+ *   contract.scenarios!['transfer.accept'],
+ *   () => collector.peekTrace(traceId),
+ *   { name: 'transfer.accept' },
+ * );
+ * if (result.outcome === 'non-conformant') throw new Error(formatScenarioResult(result));
+ * ```
+ */
+/** A finished span/event as the scenario checker sees it. */
+interface ScenarioSpan {
+  spanId: string;
+  parentSpanId?: string;
+  name: string;
+  status: 'ok' | 'error' | 'unset';
+  attributes?: Record<string, unknown>;
+  /** Epoch ms. Optional — used by {@link proposeScenario} to suggest budgets. */
+  startTimeMs?: number;
+  durationMs?: number;
+}
+/** Canonical cardinality range. `max` omitted = unbounded. */
+interface Cardinality {
+  min: number;
+  max?: number;
+}
+/**
+ * Parse a cardinality shorthand: `'exactly 1'`, `'at least 1'`, `'at most 3'`,
+ * `'0..1'`, `'2..'`. A canonical {@link Cardinality} passes through.
+ */
+declare function parseCardinality(input: string | Cardinality): Cardinality;
+/** Declaration for one event (span name) a scenario expects to observe. */
+interface ScenarioEventSpec {
+  /** How many occurrences are permitted. Defaults to `'at least 1'`. */
+  cardinality?: string | Cardinality;
+  /**
+   * Expected terminal status. Defaults to non-error: an `error` status on an
+   * event not declared `status: 'error'` is a definitive violation.
+   */
+  status?: 'ok' | 'error';
+  description?: string;
+}
+/**
+ * How the observed phase of a scenario becomes complete. Every async
+ * conformance check must declare this — it is what makes absence meaningful.
+ *
+ * `externally-reconciled` never closes in-process: the phase is verified
+ * elsewhere (a deferred reconciliation job keyed by a durable business ID),
+ * so an in-process check reports at most definitive violations, never absence.
+ */
+type CompletionBoundary = {
+  mode: 'root-span-closed';
+  observationBudgetMs: number;
+} | {
+  mode: 'terminal-event';
+  event: string;
+  observationBudgetMs: number;
+} | {
+  mode: 'externally-reconciled';
+  reconciliationDeadlineMs: number;
+};
+/** The flow-level contract for one exercised scenario (or one phase of one). */
+interface ScenarioSpec {
+  description?: string;
+  /** When the observed phase is complete. See {@link CompletionBoundary}. */
+  completion: CompletionBoundary;
+  /** Events this scenario must (or may) observe, keyed by span name. */
+  events: Record<string, ScenarioEventSpec>;
+  /**
+   * Required ancestor→descendant edges by span name. Ancestor — not immediate
+   * parent — so a framework span inserted between the two does not break the
+   * contract (canonicalisation: infrastructure spans are not behaviour).
+   */
+  edges?: ReadonlyArray<readonly [string, string]>;
+  /** Edges that may appear but are not required. Documented, never enforced. */
+  optionalEdges?: ReadonlyArray<readonly [string, string]>;
+}
+type ScenarioOutcome = 'conformant' | 'non-conformant' | 'incomplete';
+type ScenarioViolationCode = 'missing_event' | 'cardinality_violation' | 'missing_edge' | 'unexpected_error';
+/** A definitive (breaking) discrepancy between observed spans and the scenario. */
+interface ScenarioViolation {
+  code: ScenarioViolationCode;
+  event?: string;
+  edge?: readonly [string, string];
+  message: string;
+}
+/** An additive observation — reported, never a failure. */
+interface ScenarioAddition {
+  code: 'undeclared_event';
+  event: string;
+  count: number;
+  message: string;
+}
+interface ScenarioResult {
+  scenario: string;
+  outcome: ScenarioOutcome;
+  /** Whether the completion boundary closed within the observation window. */
+  closed: boolean;
+  violations: ScenarioViolation[];
+  additions: ScenarioAddition[];
+  /** The evaluated snapshot — assert business values on this in your test. */
+  spans: ScenarioSpan[];
+}
+/**
+ * Structural validation for one scenario declaration. Called by
+ * `defineContract()` so a malformed scenario throws at module load.
+ */
+declare function validateScenarioSpec(name: string, spec: ScenarioSpec): void;
+/** Whether the scenario's completion boundary has closed for these spans. */
+declare function isScenarioClosed(spec: ScenarioSpec, spans: readonly ScenarioSpan[]): boolean;
+interface EvaluateScenarioOptions {
+  /** Name used in the result/messages. Defaults to `'scenario'`. */
+  name?: string;
+  /** Override closure detection (e.g. the poller already knows). */
+  closed?: boolean;
+}
+/**
+ * Pure three-state evaluation of collected spans against a scenario.
+ *
+ * Definitive at any time (no closure needed): an unexpected error status, a
+ * `max` cardinality exceeded. Meaningful only after closure: a missing event,
+ * a `min` cardinality not reached, a missing required edge.
+ */
+declare function evaluateScenario(spec: ScenarioSpec, spans: readonly ScenarioSpan[], options?: EvaluateScenarioOptions): ScenarioResult;
+interface CheckScenarioOptions {
+  /** Name used in the result/messages. Defaults to `'scenario'`. */
+  name?: string;
+  /** Poll interval while waiting for closure. Default 25ms. */
+  pollIntervalMs?: number;
+  /** Override the boundary's observation budget (how long the checker waits). */
+  budgetMs?: number;
+}
+/**
+ * Poll `getSpans` until the scenario's completion boundary closes, a
+ * definitive violation appears (fail fast), or the observation budget is
+ * spent — then evaluate.
+ *
+ * The observation budget bounds how long *this checker* waits; it is not a
+ * statement that the operation is allowed to take that long. Express a
+ * business deadline as its own assertion on the returned spans.
+ *
+ * An `externally-reconciled` boundary never closes in-process: the check
+ * evaluates the current snapshot once and reports `incomplete` unless a
+ * definitive violation is already present.
+ */
+declare function checkScenario(spec: ScenarioSpec, getSpans: () => readonly ScenarioSpan[] | Promise<readonly ScenarioSpan[]>, options?: CheckScenarioOptions): Promise<ScenarioResult>;
+/** Human-readable summary of a scenario result, for assertion messages. */
+declare function formatScenarioResult(result: ScenarioResult): string;
+interface ScenarioProposal {
+  scenario: ScenarioSpec;
+  /** Review annotations — what was observed and what to double-check. */
+  notes: string[];
+}
+/**
+ * Draft a scenario contract from repeated controlled runs (record → propose →
+ * commit). Events stable across every run become required with their observed
+ * cardinality; variable ones get a range and a review note. The draft is a
+ * starting point for human curation, not a finished contract.
+ */
+declare function proposeScenario(runs: ReadonlyArray<ReadonlyArray<ScenarioSpan>>, options?: {
+  name?: string;
+}): ScenarioProposal;
+//#endregion
+//#region src/contract.d.ts
+/** Scalar and array attribute types permitted on a span (OTLP value shapes). */
+type AttributeType = 'string' | 'number' | 'boolean' | 'string[]' | 'number[]' | 'boolean[]';
+declare const ATTRIBUTE_TYPES: readonly AttributeType[];
+/**
+ * Lifecycle of a span or attribute, mirroring how the OpenTelemetry semantic
+ * conventions stage their own surface. `stable` is a promise to agent readers
+ * that the name will not change without a major contract bump.
+ */
+type Stability = 'stable' | 'experimental' | 'deprecated';
+declare const STABILITIES: readonly Stability[];
+/** Declaration for a single attribute key on a span. */
+interface AttributeSpec {
+  /** OTLP value shape. Validated at runtime against the emitted value. */
+  type: AttributeType;
+  /** Lifecycle stage. Defaults to `stable`. */
+  stability?: Stability;
+  /** When `true`, the attribute must be present on every matching span. */
+  required?: boolean;
+  /** Human/agent-facing description of what the attribute means. */
+  description?: string;
+  /**
+   * Marks an attribute as intentionally high-cardinality (user id, sender
+   * domain, request id). For an agent reader these are the single most useful
+   * fields on a trace, so {@link ./redaction.highCardinalityKeys} surfaces them
+   * as a *protect* list — telling redactors/normalizers NOT to strip them.
+   */
+  highCardinality?: boolean;
+  /** Closed set of permitted values. Reported as `enum_violation` if exceeded. */
+  enum?: readonly (string | number)[];
+  /** Set when `stability: 'deprecated'`; explains what to use instead. */
+  replacedBy?: string;
+  /** Free-text note shown alongside deprecation warnings. */
+  deprecatedReason?: string;
+}
+/** Declaration for a single span name your service emits. */
+interface SpanSpec {
+  /** Human/agent-facing description of when this span is produced. */
+  description?: string;
+  /** Lifecycle stage. Defaults to `stable`. */
+  stability?: Stability;
+  /** Attributes specific to this span, keyed by attribute name. */
+  attributes?: Record<string, AttributeSpec>;
+  /**
+   * When `true`, attributes not declared here are allowed without an
+   * `unknown_attribute` violation. Defaults to the contract-level setting.
+   */
+  additionalAttributes?: boolean;
+}
+/** The full telemetry contract for one service. */
+interface TelemetryContract {
+  /** `service.name` this contract describes. */
+  service: string;
+  /**
+   * Semver of the *contract itself* (not the app). Bumped when the trace
+   * surface changes; surfaced to readers as the `telemetry.schema.version`
+   * resource attribute via {@link ./attrs.SCHEMA_ATTRS}.
+   */
+  version: string;
+  /** Spans this service emits, keyed by span name. */
+  spans: Record<string, SpanSpec>;
+  /** Attributes permitted on *any* span (e.g. `user.id`, `tenant.id`). */
+  commonAttributes?: Record<string, AttributeSpec>;
+  /**
+   * Default for `SpanSpec.additionalAttributes` when a span does not set it.
+   * Defaults to `false` (declared-only — the stricter, agent-friendlier mode).
+   */
+  additionalAttributes?: boolean;
+  /**
+   * Flow-level scenario contracts, keyed by scenario name: which events one
+   * exercised flow must emit, their cardinality and topology, and when the
+   * observation is complete. Checked with `checkScenario` ({@link ./scenario}).
+   */
+  scenarios?: Record<string, ScenarioSpec>;
+}
+/**
+ * Validate and freeze a telemetry contract. Throws on structural mistakes
+ * (bad semver, unknown attribute type, deprecation with no replacement) so the
+ * contract fails loudly at module load, not silently at runtime.
+ *
+ * @example
+ * ```ts
+ * export const contract = defineContract({
+ *   service: 'checkout',
+ *   version: '1.2.0',
+ *   commonAttributes: {
+ *     'user.id': { type: 'string', highCardinality: true, description: 'Authenticated user' },
+ *   },
+ *   spans: {
+ *     'checkout.charge': {
+ *       description: 'Charge a payment method',
+ *       attributes: {
+ *         'payment.provider': { type: 'string', required: true, enum: ['stripe', 'paypal'] },
+ *         'payment.amount_cents': { type: 'number', required: true },
+ *       },
+ *     },
+ *   },
+ * });
+ * ```
+ */
+declare function defineContract(contract: TelemetryContract): TelemetryContract;
+/**
+ * Resolve the effective attribute spec for `key` on `spanName`: span-specific
+ * attributes win over common attributes. Returns `undefined` when the key is
+ * declared nowhere.
+ */
+declare function resolveAttributeSpec(contract: TelemetryContract, spanName: string, key: string): AttributeSpec | undefined;
+/** Whether attributes outside the declared set are tolerated for a span. */
+declare function allowsAdditionalAttributes(contract: TelemetryContract, spanName: string): boolean;
+//#endregion
+export { validateScenarioSpec as A, ScenarioViolationCode as C, isScenarioClosed as D, formatScenarioResult as E, parseCardinality as O, ScenarioViolation as S, evaluateScenario as T, ScenarioOutcome as _, SpanSpec as a, ScenarioSpan as b, allowsAdditionalAttributes as c, Cardinality as d, CheckScenarioOptions as f, ScenarioEventSpec as g, ScenarioAddition as h, STABILITIES as i, proposeScenario as k, defineContract as l, EvaluateScenarioOptions as m, AttributeSpec as n, Stability as o, CompletionBoundary as p, AttributeType as r, TelemetryContract as s, ATTRIBUTE_TYPES as t, resolveAttributeSpec as u, ScenarioProposal as v, checkScenario as w, ScenarioSpec as x, ScenarioResult as y };
+//# sourceMappingURL=contract-Ymh_Q37N.d.cts.map

package/dist/contract-Ymh_Q37N.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-Ymh_Q37N.d.cts","names":[],"sources":["../src/scenario.ts","../src/contract.ts"],"mappings":";;AAyCA;;;;;;;;;;;;;AAQY;AAIZ;;;;AAEK;AAOL;;;;;;;;AAA0E;AAgC1E;;;;;;;;;AAQa;AAWb;AAAA,UAxEiB,YAAA;EACf,MAAA;EACA,YAAA;EACA,IAAA;EACA,MAAA;EACA,UAAA,GAAa,MAAM;EAqES;EAnE5B,WAAA;EACA,UAAA;AAAA;;UAIe,WAAA;EACf,GAAA;EACA,GAAG;AAAA;;;;;iBAOW,gBAAA,CAAiB,KAAA,WAAgB,WAAA,GAAc,WAAW;;UAgCzD,iBAAA;EA0Bf;EAxBA,WAAA,YAAuB,WAAW;EA0BtB;;;;EArBZ,MAAA;EACA,WAAA;AAAA;;;AA8B6B;AAG/B;;;;AAA2B;KAtBf,kBAAA;EACN,IAAA;EAA0B,mBAAA;AAAA;EAC1B,IAAA;EAAwB,KAAA;EAAe,mBAAA;AAAA;EACvC,IAAA;EAA+B,wBAAA;AAAA;;UAGpB,YAAA;EACf,WAAA;EA4BO;EA1BP,UAAA,EAAY,kBAAA;EA8BG;EA5Bf,MAAA,EAAQ,MAAA,SAAe,iBAAA;;;;;;EAMvB,KAAA,GAAQ,aAAA;EA0BD;EAxBP,aAAA,GAAgB,aAAA;AAAA;AAAA,KAGN,eAAA;AAAA,KAEA,qBAAA;;UAOK,iBAAA;EACf,IAAA,EAAM,qBAAqB;EAC3B,KAAA;EACA,IAAA;EACA,OAAA;AAAA;;UAIe,gBAAA;EACf,IAAA;EACA,KAAA;EACA,KAAA;EACA,OAAA;AAAA;AAAA,UAGe,cAAA;EACf,QAAA;EACA,OAAA,EAAS,eAAA;EAMU;EAJnB,MAAA;EACA,UAAA,EAAY,iBAAA;EACZ,SAAA,EAAW,gBAAA;EAqBwD;EAnBnE,KAAA,EAAO,YAAA;AAAA;;;AAmB4D;AA0DrE;iBA1DgB,oBAAA,CAAqB,IAAA,UAAc,IAAA,EAAM,YAAY;;iBA0DrD,gBAAA,CACd,IAAA,EAAM,YAAA,EACN,KAAA,WAAgB,YAAY;AAAA,UAgCb,uBAAA;EAjCf;EAmCA,IAAA;EAlCA;EAoCA,MAAM;AAAA;AAJR;;;;AAIQ;AAUR;;AAdA,iBAcgB,gBAAA,CACd,IAAA,EAAM,YAAA,EACN,KAAA,WAAgB,YAAA,IAChB,OAAA,GAAU,uBAAA,GACT,cAAA;AAAA,UA4Fc,oBAAA;EA9FC;EAgGhB,IAAA;EA9FC;EAgGD,cAAA;EAhGe;EAkGf,QAAA;AAAA;;;;;;;AAlGe;AA4FjB;;;;;;iBAsBsB,aAAA,CACpB,IAAA,EAAM,YAAA,EACN,QAAA,iBAAyB,YAAA,KAAiB,OAAA,UAAiB,YAAA,KAC3D,OAAA,GAAU,oBAAA,GACT,OAAA,CAAQ,cAAA;;iBAmDK,oBAAA,CAAqB,MAAsB,EAAd,cAAc;AAAA,UAS1C,gBAAA;EACf,QAAA,EAAU,YAAY;;EAEtB,KAAA;AAAA;;;;;;;iBASc,eAAA,CACd,IAAA,EAAM,aAAA,CAAc,aAAA,CAAc,YAAA,IAClC,OAAA;EAAY,IAAA;AAAA,IACX,gBAAA;;;;KCpdS,aAAA;AAAA,cAQC,eAAA,WAA0B,aAAa;;;;;;KAcxC,SAAA;AAAA,cAEC,WAAA,WAAsB,SAAS;ADiB8B;AAAA,UCVzD,aAAA;ED0CiB;ECxChC,IAAA,EAAM,aAAA;ED0C4B;ECxClC,SAAA,GAAY,SAAS;EDwCE;ECtCvB,QAAA;ED4CA;EC1CA,WAAA;ED0CW;AAWb;;;;;EC9CE,eAAA;EDgDI;EC9CJ,IAAA;ED8C2C;EC5C3C,UAAA;ED6CmC;EC3CnC,gBAAA;AAAA;AD8CF;AAAA,UC1CiB,QAAA;;EAEf,WAAA;ED6CuB;EC3CvB,SAAA,GAAY,SAAA;EDiDJ;EC/CR,UAAA,GAAa,MAAA,SAAe,aAAA;EDiDC;;;;EC5C7B,oBAAA;AAAA;;UAIe,iBAAA;EDsCf;ECpCA,OAAA;EDsCA;;;AAA6B;AAG/B;ECnCE,OAAA;;EAEA,KAAA,EAAO,MAAA,SAAe,QAAA;EDiCG;EC/BzB,gBAAA,GAAmB,MAAA,SAAe,aAAA;EDiCH;;;AAAA;EC5B/B,oBAAA;EDmCgC;;;;;EC7BhC,SAAA,GAAY,MAAA,SAAe,YAAA;AAAA;;;ADiCpB;AAIT;;;;;;;;;AAIS;AAGT;;;;;;;;;;;;iBCqBgB,cAAA,CAAe,QAAA,EAAU,iBAAA,GAAoB,iBAAiB;;;;;;iBAwC9D,oBAAA,CACd,QAAA,EAAU,iBAAA,EACV,QAAA,UACA,GAAA,WACC,aAAa;;iBAQA,0BAAA,CACd,QAAA,EAAU,iBAAiB,EAC3B,QAAA"}