@whooshbang/contracts 1.0.0-rc.13

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

@@ -0,0 +1,169 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * Machine-client administration, locally generated credential metadata, durable long-poll, and contiguous acknowledgement contracts.
+ */
+export type MachineV1ContractDocument = CreateMachineClientRequest | MachineClient | RegisterMachineCredentialRequest | MachineCredential | MachineEventPollResponse | MachineEventAckRequest | MachineEventAckResponse | MachineCredentialBearer;
+export type OpaqueIdentifier = string;
+export type MachineClient = {
+    [k: string]: unknown;
+} & {
+    id: OpaqueIdentifier;
+    project_id: OpaqueIdentifier;
+    environment: Environment;
+    machine_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    subscriber_id: OpaqueIdentifier;
+    binding_id: OpaqueIdentifier;
+    display_name?: string;
+    status: "provisioning" | "active" | "revoked";
+    scope_summary: MachineScopeSummary;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+    last_used_at?: Timestamp;
+    revoked_at?: Timestamp;
+};
+export type Environment = "test" | "live";
+/**
+ * Fixed least-privilege capabilities, each constrained to this client's bound destination or stream.
+ *
+ * @minItems 4
+ * @maxItems 4
+ */
+export type MachineScopeSummary = [
+    MachineScope,
+    MachineScope,
+    MachineScope,
+    MachineScope
+];
+export type MachineScope = "machine-messages:write" | "machine-messages:read" | "machine-events:read" | "machine-events:ack";
+export type Timestamp = string;
+/**
+ * mcred_ followed by the canonical unpadded base64url encoding of exactly 16 random bytes.
+ */
+export type MachineCredentialId = string;
+/**
+ * The only secret-derived value accepted by the administration API.
+ */
+export type MachineSecretDigest = string;
+export type MachineCredential = {
+    [k: string]: unknown;
+} & {
+    credential_id: MachineCredentialId;
+    machine_client_id: OpaqueIdentifier;
+    status: "active" | "revoked";
+    scope_summary: MachineScopeSummary;
+    created_at: Timestamp;
+    last_used_at?: Timestamp;
+    revoked_at?: Timestamp;
+};
+/**
+ * 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";
+    /**
+     * An opaque identifier whose internal encoding is not a public promise.
+     */
+    id: string;
+    /**
+     * The opaque position of this event in the authenticated machine stream.
+     */
+    cursor: string;
+    type: "interaction.received";
+    /**
+     * An opaque identifier whose internal encoding is not a public promise.
+     */
+    message_id: string;
+    /**
+     * An opaque identifier whose internal encoding is not a public promise.
+     */
+    interaction_id: string;
+    /**
+     * Caller-owned opaque correlation returned as data, never treated as execution authority.
+     */
+    correlation_id?: string;
+    response?: ConfirmInteractionResponse | SelectInteractionResponse | InputInteractionResponse;
+    /**
+     * 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: string;
+    expires_at: string;
+};
+/**
+ * An opaque position within only the authenticated machine stream.
+ */
+export type MachineCursor = string;
+export type MachineEventAckRequest = {
+    [k: string]: unknown;
+} & {
+    cursor: MachineCursor;
+    disposition: MachineEventAckDisposition;
+    reason_code?: QuarantineReasonCode | null;
+};
+export type MachineEventAckDisposition = "processed" | "quarantined";
+export type QuarantineReasonCode = string;
+export type MachineEventAckResponse = {
+    [k: string]: unknown;
+} & {
+    event_id: OpaqueIdentifier;
+    cursor: MachineCursor;
+    disposition: MachineEventAckDisposition;
+    reason_code?: QuarantineReasonCode;
+    acknowledgement_status: "recorded" | "existing";
+    committed_cursor: MachineCursor | null;
+    advanced: boolean;
+};
+/**
+ * The exact runtime bearer syntax. The final segment is canonical unpadded base64url for exactly 32 locally generated random bytes.
+ */
+export type MachineCredentialBearer = string;
+export interface CreateMachineClientRequest {
+    machine_id: string;
+    notifier_id: OpaqueIdentifier;
+    subscriber_id: OpaqueIdentifier;
+    display_name?: string;
+}
+export interface RegisterMachineCredentialRequest {
+    credential_id: MachineCredentialId;
+    secret_sha256: MachineSecretDigest;
+}
+export interface MachineEventPollResponse {
+    schema: "whooshbang.machine-events.v1";
+    /**
+     * @maxItems 50
+     */
+    events: InteractionEvent[];
+    committed_cursor: MachineCursor | null;
+    server_time: Timestamp;
+}
+export interface ConfirmInteractionResponse {
+    type: "confirm";
+    value: boolean;
+}
+export interface SelectInteractionResponse {
+    type: "select";
+    value: string;
+}
+export interface InputInteractionResponse {
+    type: "input";
+    /**
+     * Untrusted input text after leading and trailing whitespace is removed.
+     */
+    value: string;
+}
+export interface SafeChannelContext {
+    /**
+     * An opaque identifier whose internal encoding is not a public promise.
+     */
+    binding_id: string;
+    channel: "telegram";
+    conversation_kind: "private_chat" | "thread" | "group";
+    display_name?: string;
+}

package/dist/generated/machine-v1.js

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

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

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

package/dist/generated/provider-capabilities-v1.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Generated by `npm run contracts:generate`.
+ * Do not edit this file directly.
+ */
+/**
+ * This interface was referenced by `ProviderCapabilitiesV1`'s JSON-Schema
+ * via the `definition` "InteractionCapability".
+ */
+export type InteractionCapability = {
+    [k: string]: unknown;
+} & {
+    mode: "native" | "fallback" | "unsupported" | "conditional";
+    explanation?: SafeExplanation;
+};
+/**
+ * This interface was referenced by `ProviderCapabilitiesV1`'s JSON-Schema
+ * via the `definition` "SafeExplanation".
+ */
+export type SafeExplanation = string;
+/**
+ * This interface was referenced by `ProviderCapabilitiesV1`'s JSON-Schema
+ * via the `definition` "ContextSupport".
+ */
+export type ContextSupport = {
+    [k: string]: unknown;
+} & {
+    mode: "supported" | "unsupported" | "conditional";
+    explanation?: SafeExplanation;
+};
+/**
+ * This interface was referenced by `ProviderCapabilitiesV1`'s JSON-Schema
+ * via the `definition` "Degradation".
+ */
+export type Degradation = {
+    [k: string]: unknown;
+} & {
+    active: boolean;
+    code?: string;
+    explanation?: SafeExplanation;
+};
+/**
+ * Provider-neutral, renderer-facing delivery and interaction capabilities with explicit degradation.
+ */
+export interface ProviderCapabilitiesV1 {
+    schema: "whooshbang.provider-capabilities.v1";
+    provider: string;
+    text: {
+        supported: boolean;
+        maximum_bytes: number;
+    };
+    interaction: {
+        confirm: InteractionCapability;
+        select: InteractionCapability;
+        input: InteractionCapability;
+    };
+    streaming: {
+        mode: "native" | "edit" | "typing_then_final" | "final_only" | "unsupported";
+        explanation?: SafeExplanation;
+    };
+    edit: {
+        supported: boolean;
+    };
+    receipts: {
+        provider_accepted: boolean;
+        delivered: boolean;
+        read: boolean;
+    };
+    contexts: {
+        private_chat: ContextSupport;
+        thread: ContextSupport;
+        group: ContextSupport;
+    };
+    rate_limit: {
+        strategy: "provider_retry_after" | "token_bucket" | "fixed_window" | "adaptive" | "unknown";
+        explanation?: SafeExplanation;
+    };
+    degradation: Degradation;
+}

package/dist/generated/provider-capabilities-v1.js

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

package/dist/generated/provider-capabilities-v1.js.map

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