@whooshbang/contracts 1.0.0-rc.13

package/dist/generated/contract-manifest.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * This interface was referenced by `ContractManifest`'s JSON-Schema
+ * via the `definition` "contractVersion".
+ */
+export type ContractVersion = string;
+/**
+ * This interface was referenced by `ContractManifest`'s JSON-Schema
+ * via the `definition` "artifactId".
+ */
+export type ArtifactId = string;
+/**
+ * This interface was referenced by `ContractManifest`'s JSON-Schema
+ * via the `definition` "relativePath".
+ */
+export type RelativePath = string;
+/**
+ * Machine-verifiable index of the public artifacts owned by WhooshBang.
+ */
+export interface ContractManifest {
+    schema: "flowxo.contract-manifest.v1";
+    artifact: "@whooshbang/contracts";
+    version: ContractVersion;
+    openapi: Artifact[];
+    schemas: Artifact[];
+    fixture_sets: FixtureSet[];
+    generated: GeneratedArtifact[];
+    compatibility: {
+        api_major: number;
+        status: "draft" | "release-candidate" | "stable" | "deprecated";
+    };
+}
+/**
+ * This interface was referenced by `ContractManifest`'s JSON-Schema
+ * via the `definition` "artifact".
+ */
+export interface Artifact {
+    id: ArtifactId;
+    version: ContractVersion;
+    path: RelativePath;
+}
+/**
+ * This interface was referenced by `ContractManifest`'s JSON-Schema
+ * via the `definition` "fixtureSet".
+ */
+export interface FixtureSet {
+    id: ArtifactId;
+    version: ContractVersion;
+    schema: RelativePath;
+    /**
+     * @minItems 1
+     */
+    fixtures: [RelativePath, ...RelativePath[]];
+}
+/**
+ * This interface was referenced by `ContractManifest`'s JSON-Schema
+ * via the `definition` "generatedArtifact".
+ */
+export interface GeneratedArtifact {
+    id: ArtifactId;
+    source: RelativePath;
+    path: RelativePath;
+}

package/dist/generated/contract-manifest.js

@@ -0,0 +1,6 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+export {};
+//# sourceMappingURL=contract-manifest.js.map

package/dist/generated/contract-manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-manifest.js","sourceRoot":"","sources":["../../src/generated/contract-manifest.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/generated/core-scenario.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * A deterministic C0-02 semantic, state, idempotency, or isolation scenario.
+ */
+export interface CoreContractScenario {
+    contract_version: "1.0.0-rc.13";
+    id: string;
+    category: "idempotency" | "isolation" | "subscription_replay" | "message_outcome" | "cancellation" | "credential_lifecycle";
+    given: {
+        [k: string]: unknown;
+    };
+    expected: {
+        [k: string]: unknown;
+    };
+}

package/dist/generated/core-scenario.js

@@ -0,0 +1,6 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+export {};
+//# sourceMappingURL=core-scenario.js.map

package/dist/generated/core-scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-scenario.js","sourceRoot":"","sources":["../../src/generated/core-scenario.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/generated/fixture-index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * The machine-readable index of deterministic C0-02 through C0-04 golden fixtures.
+ */
+export interface CoreFixtureIndex {
+    contract_version: "1.0.0-rc.13";
+    /**
+     * @minItems 1
+     */
+    fixtures: [
+        {
+            id: string;
+            kind: "request" | "success" | "problem" | "event" | "capability" | "scenario" | "signing_vector" | "delivery_case";
+            path: string;
+            schema_ref: string;
+            operation_id?: string;
+            status_code?: number;
+            problem_code?: string;
+        },
+        ...{
+            id: string;
+            kind: "request" | "success" | "problem" | "event" | "capability" | "scenario" | "signing_vector" | "delivery_case";
+            path: string;
+            schema_ref: string;
+            operation_id?: string;
+            status_code?: number;
+            problem_code?: string;
+        }[]
+    ];
+}

package/dist/generated/fixture-index.js

@@ -0,0 +1,6 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+export {};
+//# sourceMappingURL=fixture-index.js.map

package/dist/generated/fixture-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixture-index.js","sourceRoot":"","sources":["../../src/generated/fixture-index.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/generated/interaction-machine-scenario.d.ts

@@ -0,0 +1,263 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * A deterministic C0-03 interaction, credential, authorization, polling, acknowledgement, or quarantine scenario.
+ */
+export type InteractionMachineScenario = ({
+    category: "interaction_resolution";
+    given: InteractionResolutionGiven;
+    expected: InteractionResolutionExpected;
+    [k: string]: unknown;
+} | {
+    category: "callback_token";
+    given: CallbackTokenGiven;
+    expected: CallbackTokenExpected;
+    [k: string]: unknown;
+} | {
+    category: "machine_credential";
+    given: MachineCredentialGiven;
+    expected: MachineCredentialExpected;
+    [k: string]: unknown;
+} | {
+    category: "machine_authorization";
+    given: MachineAuthorizationGiven;
+    expected: MachineAuthorizationExpected;
+    [k: string]: unknown;
+} | {
+    category: "machine_poll";
+    given: MachinePollGiven;
+    expected: MachinePollExpected;
+    [k: string]: unknown;
+} | {
+    category: "machine_ack";
+    given: MachineAckGiven;
+    expected: MachineAckExpected;
+    [k: string]: unknown;
+} | {
+    category: "quarantine";
+    given: QuarantineGiven;
+    expected: QuarantineExpected;
+    [k: string]: unknown;
+}) & {
+    contract_version: "1.0.0-rc.13";
+    id: string;
+    category: "interaction_resolution" | "callback_token" | "machine_credential" | "machine_authorization" | "machine_poll" | "machine_ack" | "quarantine";
+    given: {
+        [k: string]: unknown;
+    };
+    expected: {
+        [k: string]: unknown;
+    };
+};
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachineAuthorizationExpected".
+ */
+export type MachineAuthorizationExpected = {
+    status?: number;
+    existence_disclosed?: false;
+    ack_recorded?: false;
+    committed_cursor?: NullableCursor;
+    authorized?: false;
+    provider_called?: false;
+    required_project_scope?: "messages:write" | "machine-clients:write";
+    resource_looked_up?: false;
+    machine_stream_selected?: false;
+} | {
+    authorized: true;
+    target_bound: true;
+    provider_call_allowed: true;
+} | {
+    authorized: true;
+    own_message_only: true;
+    message_returned: true;
+};
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "NullableCursor".
+ */
+export type NullableCursor = string | null;
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachinePollGiven".
+ */
+export type MachinePollGiven = {
+    committed_cursor: NullableCursor;
+    polled_event_id: string;
+    acknowledged: boolean;
+    client_restarted: boolean;
+} | {
+    committed_cursor: NullableCursor;
+    supplied_after: string;
+    supplied_cursor_issued: boolean;
+    supplied_cursor_committed: boolean;
+};
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachinePollExpected".
+ */
+export type MachinePollExpected = {
+    event_repeated: boolean;
+    event_id: string;
+    committed_cursor: NullableCursor;
+} | {
+    outcome: "cursor_mismatch";
+    events_returned: 0;
+    rewound: false;
+    committed_cursor: NullableCursor;
+};
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "InteractionResolutionGiven".
+ */
+export interface InteractionResolutionGiven {
+    state?: "open" | "answered" | "expired" | "cancelled" | "retired";
+    provider_update?: "duplicate" | "late_answer";
+    expires_at?: string;
+    response_at?: string;
+    provider_binding_matches?: boolean;
+    eligible_open_inputs?: number;
+    exact_reply_context?: boolean;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "InteractionResolutionExpected".
+ */
+export interface InteractionResolutionExpected {
+    state?: "open" | "answered" | "expired" | "cancelled" | "retired";
+    answers_created?: number;
+    events_created?: number;
+    outcome?: "answered" | "duplicate" | "expired" | "stale" | "identity_mismatch" | "ambiguous";
+    safe_diagnostic?: boolean;
+    trusted_provider_identity?: boolean;
+    routed_by_recency?: boolean;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "CallbackTokenGiven".
+ */
+export interface CallbackTokenGiven {
+    token: string;
+    random_bytes: 16;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "CallbackTokenExpected".
+ */
+export interface CallbackTokenExpected {
+    opaque: true;
+    contains_identity: false;
+    contains_answer: false;
+    contains_command: false;
+    contains_business_parameter: false;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachineCredentialGiven".
+ */
+export interface MachineCredentialGiven {
+    same_credential_id?: boolean;
+    same_digest?: boolean;
+    new_registered?: boolean;
+    new_smoke_tested?: boolean;
+    old_revoked_after_smoke_test?: boolean;
+    registration_response_lost?: boolean;
+    client_state?: "provisioning" | "active" | "revoked";
+    active_credentials?: number;
+    registration_accepted?: boolean;
+    credential_status?: "active" | "revoked";
+    same_revocation_replayed?: boolean;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachineCredentialExpected".
+ */
+export interface MachineCredentialExpected {
+    outcome?: "existing" | "conflict";
+    status?: number;
+    credentials_created?: number;
+    secret_returned?: false;
+    digest_returned?: false;
+    valid_credentials?: number;
+    machine_locked_out?: boolean;
+    old_credential_authorized?: boolean;
+    client_state?: "provisioning" | "active" | "revoked";
+    active_credentials?: number;
+    readable_secret_received?: false;
+    credential_status?: "active" | "revoked";
+    authorized?: false;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachineAuthorizationGiven".
+ */
+export interface MachineAuthorizationGiven {
+    authenticated_machine_id?: string;
+    event_machine_id?: string;
+    credential_subscriber_id?: string;
+    request_subscriber_id?: string;
+    credential_notifier_id?: string;
+    request_notifier_id?: string;
+    credential_machine_client_id?: string;
+    message_machine_client_id?: string;
+    credential_kind?: "machine" | "project";
+    credential_status?: "active" | "revoked";
+    scope?: "machine-messages:write" | "machine-messages:read";
+    authenticated_project_id?: string;
+    authenticated_environment?: "test" | "live";
+    bound_notifier_id?: string;
+    bound_subscriber_id?: string;
+    message_project_id?: string;
+    message_environment?: "test" | "live";
+    operation_id?: string;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachineAckGiven".
+ */
+export interface MachineAckGiven {
+    earlier_cursor?: string;
+    earlier_acknowledged?: boolean;
+    ack_cursor?: string;
+    event_id?: string;
+    cursor?: string;
+    disposition?: "processed" | "quarantined";
+    same_ack_replayed?: boolean;
+    recorded_disposition?: "processed" | "quarantined";
+    replayed_disposition?: "processed" | "quarantined";
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "MachineAckExpected".
+ */
+export interface MachineAckExpected {
+    ack_recorded?: boolean;
+    committed_cursor?: NullableCursor;
+    gap_skipped?: false;
+    outcome?: "existing" | "conflict";
+    status?: number;
+    events_skipped?: number;
+    committed_cursor_unchanged?: boolean;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "QuarantineGiven".
+ */
+export interface QuarantineGiven {
+    schema_valid: boolean;
+    stream_identity_valid: boolean;
+    durable_reason_recorded?: boolean;
+    signature_valid?: boolean;
+    reason_code: string;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "QuarantineExpected".
+ */
+export interface QuarantineExpected {
+    outcome: "recorded" | "integrity_failure";
+    cursor_may_advance: boolean;
+    ordinary_quarantine_allowed?: boolean;
+}

package/dist/generated/interaction-machine-scenario.js

@@ -0,0 +1,6 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+export {};
+//# sourceMappingURL=interaction-machine-scenario.js.map

package/dist/generated/interaction-machine-scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interaction-machine-scenario.js","sourceRoot":"","sources":["../../src/generated/interaction-machine-scenario.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/generated/interaction-v1.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * Provider-neutral confirm, single-select, input, lifecycle, callback-token, and authenticated answer-event contracts.
+ */
+export type InteractionV1ContractDocument = InteractionRequest | InteractionSummary | InteractionEvent | ProviderCallbackToken;
+/**
+ * A required-type tagged union. C0 supports confirm, single-select, and input only.
+ */
+export type InteractionRequest = ConfirmInteractionRequest | SelectInteractionRequest | InputInteractionRequest;
+export type InteractionPrompt = string;
+/**
+ * Caller-owned opaque correlation returned as data, never treated as execution authority.
+ */
+export type InteractionCorrelationId = string;
+/**
+ * The hosted interaction identity and first-terminal-writer state.
+ */
+export type InteractionSummary = {
+    [k: string]: unknown;
+} & {
+    id: OpaqueIdentifier;
+    type: "confirm" | "select" | "input";
+    state: InteractionState;
+    expires_at: Timestamp;
+    correlation_id?: InteractionCorrelationId;
+    answered_at?: Timestamp;
+    /**
+     * Whether the typed answer remains available inside its content-retention window. False preserves the answered terminal fact after answer deletion.
+     */
+    answer_retained?: boolean;
+    answer?: boolean | string;
+};
+/**
+ * An opaque identifier whose internal encoding is not a public promise.
+ */
+export type OpaqueIdentifier = string;
+export type InteractionState = "open" | "answered" | "expired" | "cancelled" | "retired";
+export type Timestamp = string;
+/**
+ * An authenticated, immutable human-answer fact. It is data for the consumer and never a command or proof of business success.
+ */
+export type InteractionEvent = {
+    [k: string]: unknown;
+} & {
+    schema: "whooshbang.interaction-event.v1";
+    id: OpaqueIdentifier;
+    /**
+     * The opaque position of this event in the authenticated machine stream.
+     */
+    cursor: string;
+    type: "interaction.received";
+    message_id: OpaqueIdentifier;
+    interaction_id: OpaqueIdentifier;
+    correlation_id?: InteractionCorrelationId;
+    response?: InteractionResponse;
+    /**
+     * False means the content window closed and response was removed. New retained events publish true; a retained legacy event may omit this member during rolling deployment.
+     */
+    answer_retained?: boolean;
+    channel_context: SafeChannelContext;
+    occurred_at: Timestamp;
+    expires_at: Timestamp;
+};
+export type InteractionResponse = ConfirmInteractionResponse | SelectInteractionResponse | InputInteractionResponse;
+/**
+ * Untrusted input text after leading and trailing whitespace is removed.
+ */
+export type TrimmedInputAnswer = string;
+/**
+ * An opaque single-purpose reference containing exactly 128 random bits and no trusted identity, answer, command, or business data.
+ */
+export type ProviderCallbackToken = string;
+export interface ConfirmInteractionRequest {
+    type: "confirm";
+    prompt: InteractionPrompt;
+    confirm_label?: string;
+    deny_label?: string;
+    /**
+     * Must be 30 seconds through 24 hours after server acceptance.
+     */
+    expires_at: string;
+    correlation_id?: InteractionCorrelationId;
+}
+export interface SelectInteractionRequest {
+    type: "select";
+    prompt: InteractionPrompt;
+    /**
+     * @minItems 2
+     * @maxItems 6
+     */
+    options: [InteractionOption, InteractionOption] | [InteractionOption, InteractionOption, InteractionOption] | [
+        InteractionOption,
+        InteractionOption,
+        InteractionOption,
+        InteractionOption
+    ] | [
+        InteractionOption,
+        InteractionOption,
+        InteractionOption,
+        InteractionOption,
+        InteractionOption
+    ] | [
+        InteractionOption,
+        InteractionOption,
+        InteractionOption,
+        InteractionOption,
+        InteractionOption,
+        InteractionOption
+    ];
+    /**
+     * Must be 30 seconds through 24 hours after server acceptance.
+     */
+    expires_at: string;
+    correlation_id?: InteractionCorrelationId;
+}
+export interface InteractionOption {
+    /**
+     * Opaque customer data. It is never interpreted as a command.
+     */
+    value: string;
+    label: string;
+}
+export interface InputInteractionRequest {
+    type: "input";
+    prompt: InteractionPrompt;
+    /**
+     * Must be 30 seconds through 24 hours after server acceptance.
+     */
+    expires_at: string;
+    correlation_id?: InteractionCorrelationId;
+}
+export interface ConfirmInteractionResponse {
+    type: "confirm";
+    value: boolean;
+}
+export interface SelectInteractionResponse {
+    type: "select";
+    value: string;
+}
+export interface InputInteractionResponse {
+    type: "input";
+    value: TrimmedInputAnswer;
+}
+export interface SafeChannelContext {
+    binding_id: OpaqueIdentifier;
+    channel: "telegram";
+    conversation_kind: "private_chat" | "thread" | "group";
+    display_name?: string;
+}

package/dist/generated/interaction-v1.js

@@ -0,0 +1,6 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+export {};
+//# sourceMappingURL=interaction-v1.js.map

package/dist/generated/interaction-v1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interaction-v1.js","sourceRoot":"","sources":["../../src/generated/interaction-v1.ts"],"names":[],"mappings":"AAAA;;;GAGG"}