@whooshbang/contracts 1.0.0-rc.13

package/dist/generated/webhook-delivery-case-v1.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * Deterministic customer webhook response classification, Retry-After, and delivery-bound cases.
+ */
+export interface WebhookDeliveryCaseSetV1 {
+    schema: "whooshbang.webhook-delivery-cases.v1";
+    /**
+     * @minItems 20
+     * @maxItems 64
+     */
+    cases: [
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        DeliveryCase,
+        ...DeliveryCase[]
+    ];
+}
+/**
+ * This interface was referenced by `WebhookDeliveryCaseSetV1`'s JSON-Schema
+ * via the `definition` "DeliveryCase".
+ */
+export interface DeliveryCase {
+    id: string;
+    attempt: number;
+    first_attempt_at_epoch_seconds: number;
+    now_epoch_seconds: number;
+    outcome: NetworkFailure | HttpOutcome;
+    expected: AcceptedExpectation | TerminalExpectation | RetryExpectation;
+}
+/**
+ * This interface was referenced by `WebhookDeliveryCaseSetV1`'s JSON-Schema
+ * via the `definition` "NetworkFailure".
+ */
+export interface NetworkFailure {
+    kind: "network_failure";
+}
+/**
+ * This interface was referenced by `WebhookDeliveryCaseSetV1`'s JSON-Schema
+ * via the `definition` "HttpOutcome".
+ */
+export interface HttpOutcome {
+    kind: "http";
+    status: number;
+    retry_after?: string;
+}
+/**
+ * This interface was referenced by `WebhookDeliveryCaseSetV1`'s JSON-Schema
+ * via the `definition` "AcceptedExpectation".
+ */
+export interface AcceptedExpectation {
+    action: "accepted";
+    reason: "http_2xx";
+}
+/**
+ * This interface was referenced by `WebhookDeliveryCaseSetV1`'s JSON-Schema
+ * via the `definition` "TerminalExpectation".
+ */
+export interface TerminalExpectation {
+    action: "terminal";
+    reason: "attempt_limit_exhausted" | "delivery_window_exhausted" | "http_terminal" | "redirect_not_followed" | "unexpected_http_status";
+}
+/**
+ * This interface was referenced by `WebhookDeliveryCaseSetV1`'s JSON-Schema
+ * via the `definition` "RetryExpectation".
+ */
+export interface RetryExpectation {
+    action: "retry";
+    reason: "network_failure" | "retryable_http_status";
+    latest_retry_at_epoch_seconds: number;
+    retry_after_seconds?: number;
+}

package/dist/generated/webhook-delivery-case-v1.js

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

package/dist/generated/webhook-delivery-case-v1.js.map

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

package/dist/generated/webhook-signing-vector-v1.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * Language-neutral deterministic Standard Webhooks V1 verification vectors. All key material is public synthetic test data and must never be used outside fixtures.
+ */
+export interface WebhookSigningVectorSetV1 {
+    schema: "whooshbang.webhook-signing-vectors.v1";
+    synthetic_verification_keys: {
+        [k: string]: string;
+    };
+    raw_bodies: {
+        [k: string]: string;
+    };
+    /**
+     * @minItems 16
+     * @maxItems 64
+     */
+    cases: [
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        VerificationCase,
+        ...VerificationCase[]
+    ];
+}
+/**
+ * This interface was referenced by `WebhookSigningVectorSetV1`'s JSON-Schema
+ * via the `definition` "VerificationCase".
+ */
+export interface VerificationCase {
+    id: string;
+    description?: string;
+    raw_body: string;
+    /**
+     * @minItems 0
+     * @maxItems 8
+     */
+    headers: [] | [Header] | [Header, Header] | [Header, Header, Header] | [Header, Header, Header, Header] | [Header, Header, Header, Header, Header] | [Header, Header, Header, Header, Header, Header] | [Header, Header, Header, Header, Header, Header, Header] | [Header, Header, Header, Header, Header, Header, Header, Header];
+    /**
+     * @minItems 0
+     * @maxItems 3
+     */
+    trusted_keys: [] | [string] | [string, string] | [string, string, string];
+    now_seconds: number;
+    tolerance_seconds: number;
+    duplicate_of?: string;
+    expected: VerifiedExpectation | RejectedExpectation;
+}
+/**
+ * This interface was referenced by `WebhookSigningVectorSetV1`'s JSON-Schema
+ * via the `definition` "Header".
+ */
+export interface Header {
+    name: string;
+    value: string;
+}
+/**
+ * This interface was referenced by `WebhookSigningVectorSetV1`'s JSON-Schema
+ * via the `definition` "VerifiedExpectation".
+ */
+export interface VerifiedExpectation {
+    verified: true;
+    event_id: string;
+    timestamp: number;
+    attempt: number;
+}
+/**
+ * This interface was referenced by `WebhookSigningVectorSetV1`'s JSON-Schema
+ * via the `definition` "RejectedExpectation".
+ */
+export interface RejectedExpectation {
+    verified: false;
+    reason: "crypto_unavailable" | "duplicate_header" | "duplicate_secret" | "duplicate_signature" | "invalid_body" | "invalid_clock" | "invalid_secret" | "invalid_tolerance" | "malformed_attempt" | "malformed_header" | "malformed_signature" | "malformed_timestamp" | "malformed_webhook_id" | "missing_header" | "signature_mismatch" | "timestamp_outside_tolerance" | "too_many_secrets" | "too_many_signatures" | "unsupported_signature_version";
+}

package/dist/generated/webhook-signing-vector-v1.js

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

package/dist/generated/webhook-signing-vector-v1.js.map

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

package/dist/generated/whooshbang-event-v1.d.ts

@@ -0,0 +1,191 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * Strict public customer-event envelope and initial WhooshBang event union.
+ */
+export type WhooshBangEventV1ContractDocument = SubscriptionActivatedEvent | SubscriptionRevokedEvent | MessageProviderAcceptedEvent | MessageDeliveredEvent | MessageFailedEvent | MessageExpiredEvent | InteractionReceivedEvent | InteractionExpiredEvent | AgentBindingDegradedEvent;
+export type SubscriptionActivatedEvent = BaseEvent & {
+    type?: "subscription.activated";
+    data?: SubscriptionActivatedData;
+    [k: string]: unknown;
+};
+/**
+ * The stable logical event identifier. Dots and control characters are excluded so it is safe in the Standard Webhooks signing input.
+ */
+export type EventIdentifier = string;
+/**
+ * An RFC 3339 timestamp with an explicit UTC offset.
+ */
+export type Timestamp = string;
+/**
+ * A stable public resource identifier whose internal encoding is not a public promise.
+ */
+export type OpaqueIdentifier = string;
+/**
+ * The environment in which the immutable event occurred.
+ */
+export type Environment = "test" | "live";
+/**
+ * The initial provider-neutral channel vocabulary.
+ */
+export type Channel = "telegram";
+export type SubscriptionRevokedEvent = BaseEvent & {
+    type?: "subscription.revoked";
+    data?: SubscriptionRevokedData;
+    [k: string]: unknown;
+};
+export type MessageProviderAcceptedEvent = BaseEvent & {
+    type?: "message.provider_accepted";
+    data?: MessageProviderAcceptedData;
+    [k: string]: unknown;
+};
+/**
+ * Opaque customer correlation returned as data and never interpreted as authority or an executable command.
+ */
+export type CorrelationId = string;
+export type MessageDeliveredEvent = BaseEvent & {
+    type?: "message.delivered";
+    data?: MessageDeliveredData;
+    [k: string]: unknown;
+};
+export type MessageFailedEvent = BaseEvent & {
+    type?: "message.failed";
+    data?: MessageFailedData;
+    [k: string]: unknown;
+};
+export type MessageExpiredEvent = BaseEvent & {
+    type?: "message.expired";
+    data?: MessageExpiredData;
+    [k: string]: unknown;
+};
+export type InteractionReceivedEvent = BaseEvent & {
+    type?: "interaction.received";
+    data?: InteractionReceivedData;
+    [k: string]: unknown;
+};
+export type InteractionReceivedData = {
+    [k: string]: unknown;
+} & {
+    interaction_id: OpaqueIdentifier;
+    message_id: OpaqueIdentifier;
+    binding_id: OpaqueIdentifier;
+    channel: Channel;
+    correlation_id?: InteractionCorrelationId;
+    interaction_type: "confirm" | "select" | "input";
+    response: InteractionResponse;
+    occurred_at: Timestamp;
+    expires_at: Timestamp;
+};
+/**
+ * The C0-03 bounded opaque interaction correlation returned as data and never interpreted as authority.
+ */
+export type InteractionCorrelationId = string;
+export type InteractionResponse = ConfirmInteractionResponse | SelectInteractionResponse | InputInteractionResponse;
+export type InteractionExpiredEvent = BaseEvent & {
+    type?: "interaction.expired";
+    data?: InteractionExpiredData;
+    [k: string]: unknown;
+};
+export type AgentBindingDegradedEvent = BaseEvent & {
+    type?: "agent_binding.degraded";
+    data?: AgentBindingDegradedData;
+    [k: string]: unknown;
+};
+export interface BaseEvent {
+    schema: "whooshbang.event.v1";
+    id: EventIdentifier;
+    type: "subscription.activated" | "subscription.revoked" | "message.provider_accepted" | "message.delivered" | "message.failed" | "message.expired" | "interaction.received" | "interaction.expired" | "agent_binding.degraded";
+    created_at: Timestamp;
+    account_id: OpaqueIdentifier;
+    project_id: OpaqueIdentifier;
+    environment: Environment;
+    data: {
+        [k: string]: unknown;
+    };
+}
+export interface SubscriptionActivatedData {
+    subscription_link_id: OpaqueIdentifier;
+    binding_id: OpaqueIdentifier;
+    subscriber_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    channel: Channel;
+    state: "activated";
+    activated_at: Timestamp;
+}
+export interface SubscriptionRevokedData {
+    subscription_link_id: OpaqueIdentifier;
+    binding_id: OpaqueIdentifier;
+    subscriber_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    channel: Channel;
+    state: "revoked";
+    revoked_at: Timestamp;
+}
+export interface MessageProviderAcceptedData {
+    message_id: OpaqueIdentifier;
+    correlation_id?: CorrelationId;
+    state: "provider_accepted";
+    accepted_at: Timestamp;
+}
+export interface MessageDeliveredData {
+    message_id: OpaqueIdentifier;
+    correlation_id?: CorrelationId;
+    state: "delivered";
+    /**
+     * Delivery is claimed only when the provider supplied trustworthy delivery evidence.
+     */
+    evidence: "provider_delivery_receipt";
+    delivered_at: Timestamp;
+}
+export interface MessageFailedData {
+    message_id: OpaqueIdentifier;
+    correlation_id?: CorrelationId;
+    state: "terminal_failed";
+    /**
+     * A provider-neutral, safe public failure classification.
+     */
+    failure_code: string;
+    retryable: false;
+    failed_at: Timestamp;
+}
+export interface MessageExpiredData {
+    message_id: OpaqueIdentifier;
+    correlation_id?: CorrelationId;
+    state: "expired";
+    expired_at: Timestamp;
+}
+export interface ConfirmInteractionResponse {
+    type: "confirm";
+    value: boolean;
+}
+export interface SelectInteractionResponse {
+    type: "select";
+    /**
+     * Opaque customer data and never an executable command.
+     */
+    value: string;
+}
+export interface InputInteractionResponse {
+    type: "input";
+    value: string;
+}
+export interface InteractionExpiredData {
+    interaction_id: OpaqueIdentifier;
+    message_id: OpaqueIdentifier;
+    correlation_id?: InteractionCorrelationId;
+    interaction_type: "confirm" | "select" | "input";
+    expired_at: Timestamp;
+}
+export interface AgentBindingDegradedData {
+    agent_binding_id: OpaqueIdentifier;
+    binding_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    state: "degraded";
+    /**
+     * A safe public classification without provider identity or credentials.
+     */
+    degradation_code: string;
+    degraded_at: Timestamp;
+}

package/dist/generated/whooshbang-event-v1.js

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

package/dist/generated/whooshbang-event-v1.js.map

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