@intentrax/sdk 1.0.0

package/index.d.ts

@@ -0,0 +1,235 @@
+export declare const SDK_VERSION: "1.0.0";
+export declare const API_VERSION: "v1";
+export declare const VERIFY_REQUEST_HASH_DOMAIN: "INTENTRAX_PUBLIC_SDK_VERIFY_REQUEST_V1";
+export declare const IDEMPOTENCY_KEY_DOMAIN: "INTENTRAX_PUBLIC_SDK_IDEMPOTENCY_V1";
+export declare const AGENT_GATEWAY_ADMISSION_REQUEST_HASH_DOMAIN: "INTENTRAX_AGENT_GATEWAY_ADMISSION_REQUEST_V1";
+export declare const AGENT_ADMISSION_SCHEMA_VERSION: "intentrax.runtime.agent_admission_request/1.0";
+export declare const AGENT_ADMISSION_ENDPOINT: "/v1/agent/admissions";
+export declare const INTENT_EXECUTE_REQUEST_SCHEMA_VERSION: "intentrax.runtime.intent_execute.request/1.0";
+export declare const INTENT_EXECUTE_ENDPOINT: "/v1/intents/execute";
+export declare const INTENT_EXECUTE_MAX_REQUEST_BYTES: 4096;
+export declare const RECEIPT_VERIFICATION_REQUEST_SCHEMA_VERSION: "intentrax.runtime.proof_verification.request/1.0";
+export declare const RECEIPT_VERIFICATION_ENDPOINT: "/v1/proofs/verify";
+export declare const RECEIPT_VERIFICATION_REQUEST_HASH_DOMAIN: "INTENTRAX_RECEIPT_VERIFICATION_REQUEST_V1";
+export declare const RECEIPT_VERIFICATION_IDEMPOTENCY_DOMAIN: "INTENTRAX_RECEIPT_VERIFICATION_IDEMPOTENCY_V1";
+export declare const PROOF_EXPORT_ENDPOINT_PREFIX: "/v1/proofs";
+export declare const PROOF_REPLAY_REQUEST_SCHEMA_VERSION: "intentrax.runtime.proof_replay.request/1.0";
+export declare const PROOF_REPLAY_ENDPOINT: "/v1/proofs/replay";
+export declare const VERIFIER_HANDOFF_ENDPOINT_PREFIX: "/v1/evidence/dry-run";
+export declare const SDK_INPUT_ERROR_CODE: "INTX-SDK-INPUT-001";
+
+export type VerifyProofRequest = {
+  action: string;
+  execution_id: string;
+  intent_id: string;
+  payload_hash: string;
+  principal_id: string;
+  proof_id: string;
+  request_body_hash: string;
+  request_method: string;
+  request_path: string;
+  required_tier: "TIER_1" | "TIER_2" | "TIER_3" | "TIER_4";
+  timestamp: string;
+};
+
+export type AgentGatewayAdmissionRequest = {
+  schema_version: "intentrax.runtime.agent_admission_request/1.0";
+  tenant_id: string;
+  surface_id: string;
+  action: string;
+  adapter_id: string;
+  evidence_refs: string[];
+  proof_refs: string[];
+  request_payload_hash: string;
+  protocol_payload_ref: string;
+  idempotency_key_hash: string;
+};
+
+export type IntentExecuteRequest = {
+  schema_version: "intentrax.runtime.intent_execute.request/1.0";
+  intent_id: string;
+  tenant_id: string;
+  action: string;
+  idempotency_key: string;
+  proof_chain_fixture_ref: string;
+};
+
+export type ReceiptVerificationRequest = {
+  schema_version: "intentrax.runtime.proof_verification.request/1.0";
+  receipt_id: string;
+  receipt_hash: string;
+  evidence_record_hash: string;
+  handoff_hash: string;
+  proof_chain_fixture_ref: string;
+  proof_chain_fixture_hash: string;
+};
+
+export type ProofExportFormat = "json" | "aep-json" | "pdf";
+
+export type ProofExportRequest = {
+  proof_id: string;
+  format?: ProofExportFormat | "";
+};
+
+export type ProofReadRequest = {
+  proof_id: string;
+};
+
+export type ProofReplayRequest = {
+  schema_version: "intentrax.runtime.proof_replay.request/1.0";
+  proof_id: string;
+};
+
+export type ProofInclusionRequest = {
+  proof_id: string;
+};
+
+export type VerifierHandoffRequest = {
+  receipt_id: string;
+};
+
+export type SDKError = {
+  error_code: string;
+  error_type: "public_sdk_input_error";
+  message: string;
+  invalid_fields: string[];
+  retriable: false;
+};
+
+export declare function sha256Hex(value: string): string;
+export declare function isSha256Hex(value: unknown): boolean;
+export declare function isSha256Ref(value: unknown): boolean;
+export declare function canonicalJson(value: unknown): string;
+export declare function validateVerificationRequest(request: unknown): string[];
+export declare function verificationRequestHash(request: VerifyProofRequest): string;
+export declare function idempotencyInput(request: VerifyProofRequest): Record<string, unknown>;
+export declare function createIdempotencyKey(request: VerifyProofRequest): string;
+export declare function buildVerificationEnvelope(request: VerifyProofRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.verify/1.0";
+    request_hash: string;
+    idempotency_key: string;
+    request: VerifyProofRequest;
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function validateReceiptVerificationRequest(request: unknown): string[];
+export declare function receiptVerificationRequestHash(request: ReceiptVerificationRequest): string;
+export declare function receiptVerificationIdempotencyInput(request: ReceiptVerificationRequest): Record<string, unknown>;
+export declare function createReceiptVerificationIdempotencyKey(request: ReceiptVerificationRequest): string;
+export declare function buildReceiptVerificationEnvelope(request: ReceiptVerificationRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.receipt_verification/1.0";
+    endpoint: "/v1/proofs/verify";
+    request_hash: string;
+    idempotency_key: string;
+    request: ReceiptVerificationRequest;
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function normalizeProofExportFormat(format?: unknown): ProofExportFormat | string;
+export declare function validateProofExportRequest(request: unknown): string[];
+export declare function buildProofExportEnvelope(request: ProofExportRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.proof_export/1.0";
+    endpoint: string;
+    format: ProofExportFormat;
+    authoritative_json: boolean;
+    pdf_receipt_non_authoritative: boolean;
+    request: {
+      proof_id: string;
+      format: ProofExportFormat;
+    };
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function validateProofReadRequest(request: unknown): string[];
+export declare function buildProofReadEnvelope(request: ProofReadRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.proof_read/1.0";
+    endpoint: string;
+    request: {
+      proof_id: string;
+    };
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function validateProofReplayRequest(request: unknown): string[];
+export declare function buildProofReplayEnvelope(request: ProofReplayRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.proof_replay/1.0";
+    endpoint: "/v1/proofs/replay";
+    request: ProofReplayRequest;
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function validateProofInclusionRequest(request: unknown): string[];
+export declare function buildProofInclusionEnvelope(request: ProofInclusionRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.proof_inclusion/1.0";
+    endpoint: string;
+    request: {
+      proof_id: string;
+    };
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function validateVerifierHandoffRequest(request: unknown): string[];
+export declare function buildVerifierHandoffEnvelope(request: VerifierHandoffRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.verifier_handoff/1.0";
+    endpoint: string;
+    request: {
+      receipt_id: string;
+    };
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function validateIntentExecuteRequest(request: unknown): string[];
+export declare function buildIntentExecuteEnvelope(request: IntentExecuteRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.intent_execute/1.0";
+    endpoint: "/v1/intents/execute";
+    request: IntentExecuteRequest;
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};
+export declare function validateAgentGatewayAdmissionRequest(request: unknown): string[];
+export declare function agentGatewayAdmissionRequestHash(request: AgentGatewayAdmissionRequest): string;
+export declare function buildAgentGatewayAdmissionEnvelope(request: AgentGatewayAdmissionRequest): {
+  status: "PASS";
+  output: {
+    schema_version: "intentrax.public_sdk.agent_gateway_admission/1.0";
+    request_hash: string;
+    idempotency_key_hash: string;
+    endpoint: "/v1/agent/admissions";
+    request: AgentGatewayAdmissionRequest;
+  };
+} | {
+  status: "FAIL";
+  error: SDKError;
+};