@stelis/agent-q-core 0.0.0

package/dist/protocol.d.ts

@@ -0,0 +1,207 @@
+import { isClientName, isSafeDeviceId, isSafeRequestId, isSessionId, sanitizeDisplayText, type DeviceState, type ProvisioningState } from "./safe-text.js";
+import { makeConnectRequest as makeProviderConnectRequest, makeDisconnectRequest as makeProviderDisconnectRequest, makeGetAccountsRequest as makeProviderGetAccountsRequest, makeGetCapabilitiesRequest as makeProviderGetCapabilitiesRequest, type AccountsResponse, type CapabilitiesResponse, type ConnectRequest, type ConnectResponse, type DisconnectRequest, type DisconnectResponse, type GetAccountsRequest, type GetCapabilitiesRequest, type ProtocolErrorResponse, type SignPersonalMessageParams, type SignPersonalMessageRequest, type SignResultResponse, type SignTransactionParams, type SignTransactionRequest } from "./provider-protocol.js";
+import { ProtocolError } from "./protocol-error.js";
+import { AGENT_Q_POLICY_SCHEMA, APPROVAL_HISTORY_HIGHEST_ACTIONS, APPROVAL_HISTORY_POLICY_UPDATE_RESULTS, APPROVAL_HISTORY_REASON_CODE_PATTERN, APPROVAL_HISTORY_RULE_REF_PATTERN, MAX_APPROVAL_HISTORY_RECORDS, MAX_POLICY_CHAIN_ID_LENGTH, MAX_POLICY_CRITERION_VALUES, MAX_POLICY_FIELD_ID_LENGTH, MAX_POLICY_METHOD_LENGTH, MAX_POLICY_RULE_CRITERIA, MAX_POLICY_RULE_COUNT, MAX_POLICY_RULE_ID_LENGTH, MAX_POLICY_UPDATE_REQUEST_JSON_BYTES, MAX_POLICY_VALUE_LENGTH, POLICY_ACTIONS, POLICY_FIELD_ID_PATTERN, POLICY_ID_PATTERN, POLICY_IDENTIFIER_PATTERN, POLICY_OPERATORS, POLICY_PROPOSE_RESULT_STATUSES, POLICY_RULE_ID_PATTERN, SIGNING_HISTORY_RECORD_KINDS, SIGNING_HISTORY_TERMINAL_RESULTS, SIGN_CHAIN_PATTERN, SIGN_METHOD_PATTERN, UINT_DECIMAL_STRING_PATTERN } from "./protocol-management-primitives.js";
+import { ED25519_PUBLIC_KEY_BASE64_PATTERN, FORBIDDEN_SECRET_FIELD_NAMES, MAX_ACCOUNTS_PER_RESPONSE, MAX_CAPABILITY_ACCOUNTS_PER_CHAIN, MAX_CAPABILITY_CHAINS, MAX_PROTOCOL_RESPONSE_LINE_BYTES, MAX_RAW_PROTOCOL_JSON_BYTES, MAX_SESSION_TTL_MS, MAX_SIGN_RESULT_PAYLOAD_BASE64_CHARS, MAX_SIGNING_CAPABILITIES, MAX_SUI_SIGN_PERSONAL_MESSAGE_BASE64_CHARS, MAX_SUI_SIGN_PERSONAL_MESSAGE_BYTES, MAX_SUI_SIGN_TRANSACTION_TX_BYTES, MAX_SUI_SIGN_TRANSACTION_TX_BYTES_BASE64_CHARS, PROTOCOL_VERSION, SIGN_RESULT_ERROR_MESSAGES, SUI_ADDRESS_PATTERN, SUI_CHAIN_ID, SUI_DERIVATION_PATH, SUI_ED25519_SIGNATURE_BASE64_PATTERN, SUI_SIGN_PERSONAL_MESSAGE_METHOD, SUI_SIGN_TRANSACTION_METHOD, SUI_SIGN_TRANSACTION_NETWORKS, UNSUPPORTED_METHOD_MESSAGE, consumeProtocolResponseChunk, createRequestId, isSuiAddressForPublicKey, type SignResultErrorCode, type SuiSignMethod, type SuiSignTransactionNetwork } from "./protocol-primitives.js";
+export { isClientName, isSafeDeviceId, isSafeRequestId, isSessionId, sanitizeDisplayText };
+export { AGENT_Q_POLICY_SCHEMA, APPROVAL_HISTORY_HIGHEST_ACTIONS, APPROVAL_HISTORY_POLICY_UPDATE_RESULTS, APPROVAL_HISTORY_REASON_CODE_PATTERN, APPROVAL_HISTORY_RULE_REF_PATTERN, ED25519_PUBLIC_KEY_BASE64_PATTERN, FORBIDDEN_SECRET_FIELD_NAMES, MAX_ACCOUNTS_PER_RESPONSE, MAX_APPROVAL_HISTORY_RECORDS, MAX_CAPABILITY_ACCOUNTS_PER_CHAIN, MAX_CAPABILITY_CHAINS, MAX_POLICY_CHAIN_ID_LENGTH, MAX_POLICY_CRITERION_VALUES, MAX_POLICY_FIELD_ID_LENGTH, MAX_POLICY_METHOD_LENGTH, MAX_POLICY_RULE_CRITERIA, MAX_POLICY_RULE_COUNT, MAX_POLICY_RULE_ID_LENGTH, MAX_POLICY_UPDATE_REQUEST_JSON_BYTES, MAX_POLICY_VALUE_LENGTH, MAX_PROTOCOL_RESPONSE_LINE_BYTES, MAX_RAW_PROTOCOL_JSON_BYTES, MAX_SESSION_TTL_MS, MAX_SIGN_RESULT_PAYLOAD_BASE64_CHARS, MAX_SIGNING_CAPABILITIES, MAX_SUI_SIGN_PERSONAL_MESSAGE_BASE64_CHARS, MAX_SUI_SIGN_PERSONAL_MESSAGE_BYTES, MAX_SUI_SIGN_TRANSACTION_TX_BYTES, MAX_SUI_SIGN_TRANSACTION_TX_BYTES_BASE64_CHARS, POLICY_ACTIONS, POLICY_FIELD_ID_PATTERN, POLICY_ID_PATTERN, POLICY_IDENTIFIER_PATTERN, POLICY_OPERATORS, POLICY_PROPOSE_RESULT_STATUSES, POLICY_RULE_ID_PATTERN, PROTOCOL_VERSION, SIGNING_HISTORY_RECORD_KINDS, SIGNING_HISTORY_TERMINAL_RESULTS, SIGN_CHAIN_PATTERN, SIGN_METHOD_PATTERN, SIGN_RESULT_ERROR_MESSAGES, SUI_ADDRESS_PATTERN, SUI_CHAIN_ID, SUI_DERIVATION_PATH, SUI_ED25519_SIGNATURE_BASE64_PATTERN, SUI_SIGN_PERSONAL_MESSAGE_METHOD, SUI_SIGN_TRANSACTION_METHOD, SUI_SIGN_TRANSACTION_NETWORKS, UINT_DECIMAL_STRING_PATTERN, UNSUPPORTED_METHOD_MESSAGE, consumeProtocolResponseChunk, createRequestId, isSuiAddressForPublicKey, };
+export { ProtocolError };
+export type { DeviceState, ProvisioningState, SignResultErrorCode, SuiSignMethod, SuiSignTransactionNetwork };
+export type { Account, AccountsResponse, CapabilitiesResponse, CapabilityAccount, CapabilityChain, ConnectApprovedResponse, ConnectRejectedResponse, ConnectRequest, ConnectResponse, DisconnectRequest, DisconnectResponse, GetAccountsRequest, GetCapabilitiesRequest, ProtocolErrorResponse, SignPersonalMessageParams, SignPersonalMessageRequest, SignPersonalMessageSignedResponse, SignOperationType, SignResultAuthorization, SignResultPolicyRejectedResponse, SignResultResponse, SignResultSignedResponse, SignResultSigningFailedResponse, SignResultStatus, SignResultUserRejectedResponse, SignTransactionParams, SignTransactionRequest, SignTransactionSignedResponse, SupportedSignRoute, SigningCapabilities, SigningCapabilityEntry, } from "./provider-protocol.js";
+export { identifySignRoute, makeSignPersonalMessageRequest, makeSignTransactionRequest, } from "./provider-protocol.js";
+export interface DeviceStatus {
+    deviceId: string;
+    state: DeviceState;
+    firmwareName: string;
+    hardware: string;
+    firmwareVersion: string;
+}
+export interface ProvisioningStatus {
+    state: ProvisioningState;
+}
+export interface DeviceStatusSnapshot {
+    device: DeviceStatus;
+    provisioning: ProvisioningStatus;
+}
+export interface GetStatusRequest {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "get_status";
+}
+export interface IdentifyDeviceRequest {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "identify_device";
+    params: {
+        code: string;
+    };
+}
+export interface PolicyGetRequest {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "policy_get";
+    sessionId: string;
+}
+export interface GetApprovalHistoryRequest {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "get_approval_history";
+    sessionId: string;
+    params: {
+        limit: number;
+        beforeSeq?: string;
+    };
+}
+export interface PolicyProposeRequest {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "policy_propose";
+    sessionId: string;
+    params: {
+        policy: Record<string, unknown>;
+    };
+}
+export type ProtocolRequest = GetStatusRequest | IdentifyDeviceRequest | ConnectRequest | DisconnectRequest | GetCapabilitiesRequest | GetAccountsRequest | PolicyGetRequest | GetApprovalHistoryRequest | PolicyProposeRequest | SignTransactionRequest | SignPersonalMessageRequest;
+export interface StatusResponse {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "status";
+    device: DeviceStatus;
+    provisioning: ProvisioningStatus;
+}
+export interface IdentifyDeviceResponse {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "identify_device_result";
+    status: "displayed";
+    code: string;
+    device: DeviceStatus;
+}
+export type PolicyAction = "reject" | "sign";
+export type PolicyOperator = "eq" | "in" | "lte";
+export interface PolicyCriterion {
+    field: string;
+    op: PolicyOperator;
+    value?: string;
+    values?: string[];
+}
+export interface PolicyRule {
+    id: string;
+    chain: string;
+    method: string;
+    action: PolicyAction;
+    criteria: PolicyCriterion[];
+}
+export interface PolicyDocument {
+    schema: string;
+    policyId: string;
+    defaultAction: PolicyAction;
+    ruleCount: number;
+    rules: PolicyRule[];
+}
+export interface PolicyResponse {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "policy";
+    policy: PolicyDocument;
+}
+export type SigningHistoryRecordKind = "confirmation" | "terminal";
+export type SigningHistoryTerminalResult = "signed" | "user_rejected" | "user_timed_out" | "policy_rejected" | "signing_failed";
+export type ApprovalHistoryPolicyUpdateResult = "applied" | "rejected" | "timed_out" | "storage_error";
+export type ApprovalHistoryHighestAction = PolicyAction;
+interface ApprovalHistoryRecordBase {
+    seq: string;
+    uptimeMs: string;
+    timeSource: "uptime";
+    eventKind: "policy_update" | "signing";
+    reasonCode: string;
+}
+export interface PolicyUpdateApprovalHistoryRecord extends ApprovalHistoryRecordBase {
+    eventKind: "policy_update";
+    result: ApprovalHistoryPolicyUpdateResult;
+    policyHash: string;
+    ruleCount: number;
+    highestAction: ApprovalHistoryHighestAction;
+}
+export interface SigningApprovalHistoryRecord extends ApprovalHistoryRecordBase {
+    eventKind: "signing";
+    recordKind: SigningHistoryRecordKind;
+    authorization: "user" | "policy";
+    chain: string;
+    method: string;
+    payloadDigest: string;
+    confirmationKind?: "local_pin" | "physical_confirm" | "policy";
+    policyHash?: string;
+    ruleRef?: string;
+    terminalResult?: SigningHistoryTerminalResult;
+}
+export type ApprovalHistoryRecord = PolicyUpdateApprovalHistoryRecord | SigningApprovalHistoryRecord;
+export interface ApprovalHistoryResponse {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "approval_history";
+    records: ApprovalHistoryRecord[];
+    hasMore: boolean;
+}
+export type PolicyProposeResultStatus = "applied" | "rejected" | "timed_out" | "invalid_policy" | "ui_error" | "storage_error" | "consistency_error";
+export interface PolicyProposeResultPolicySummary {
+    policyHash: string;
+    ruleCount: number;
+    highestAction: ApprovalHistoryHighestAction;
+}
+export interface PolicyProposeResultResponse {
+    id: string;
+    version: typeof PROTOCOL_VERSION;
+    type: "policy_propose_result";
+    status: PolicyProposeResultStatus;
+    reasonCode: string;
+    policy?: PolicyProposeResultPolicySummary;
+}
+export type ProtocolResponse = StatusResponse | IdentifyDeviceResponse | ConnectResponse | DisconnectResponse | CapabilitiesResponse | AccountsResponse | PolicyResponse | ApprovalHistoryResponse | PolicyProposeResultResponse | SignResultResponse | ProtocolErrorResponse;
+export declare function makeGetStatusRequest(id?: string): GetStatusRequest;
+export declare function makeIdentifyDeviceRequest(code: string, id?: string): IdentifyDeviceRequest;
+export declare function createIdentificationCode(): string;
+export declare const makeConnectRequest: typeof makeProviderConnectRequest;
+export declare const makeDisconnectRequest: typeof makeProviderDisconnectRequest;
+export declare const makeGetCapabilitiesRequest: typeof makeProviderGetCapabilitiesRequest;
+export declare const makeGetAccountsRequest: typeof makeProviderGetAccountsRequest;
+export declare function makePolicyGetRequest(sessionId: string, id?: string): PolicyGetRequest;
+export declare function makeGetApprovalHistoryRequest(sessionId: string, params?: {
+    limit?: number;
+    beforeSeq?: string;
+}, id?: string): GetApprovalHistoryRequest;
+export declare function makePolicyProposeRequest(sessionId: string, policy: Record<string, unknown>, id?: string): PolicyProposeRequest;
+export declare function validatePolicyProposeRequestInput(sessionId: string, policy: Record<string, unknown>): void;
+export declare function validateSignRequestInput(chain: unknown, method: unknown, params: unknown, requestType?: string): SignTransactionParams;
+export declare function validateSignTransactionParamsInput(params: unknown, requestType?: string): SignTransactionParams;
+export declare function validateSignPersonalMessageRequestInput(chain: unknown, method: unknown, params: unknown, requestType?: string): SignPersonalMessageParams;
+export declare function validateSignPersonalMessageParamsInput(params: unknown, requestType?: string): SignPersonalMessageParams;
+export declare function validatePolicyProposeInput(policy: unknown): asserts policy is Record<string, unknown>;
+export declare function validateApprovalHistoryInput(params?: {
+    limit?: number;
+    beforeSeq?: string;
+}): {
+    limit: number;
+    beforeSeq?: string;
+};
+export declare function serializeRequest(request: ProtocolRequest): string;
+export declare function parseJsonLine(line: string): unknown;
+export declare function parseProtocolResponse(line: string, expectedId?: string): ProtocolResponse;
+export declare function parseProviderProtocolResponse(line: string, expectedId?: string): ProtocolResponse;
+export declare function assertStatusResponse(response: ProtocolResponse): StatusResponse;
+export declare function assertIdentifyDeviceResponse(response: ProtocolResponse): IdentifyDeviceResponse;
+export declare function assertConnectResponse(response: ProtocolResponse): ConnectResponse;
+export declare function assertDisconnectResponse(response: ProtocolResponse): DisconnectResponse;
+export declare function assertCapabilitiesResponse(response: ProtocolResponse): CapabilitiesResponse;
+export declare function assertAccountsResponse(response: ProtocolResponse): AccountsResponse;
+export declare function assertPolicyResponse(response: ProtocolResponse): PolicyResponse;
+export declare function assertApprovalHistoryResponse(response: ProtocolResponse): ApprovalHistoryResponse;
+export declare function assertPolicyProposeResultResponse(response: ProtocolResponse): PolicyProposeResultResponse;
+export declare function assertSignResultResponse(response: ProtocolResponse): SignResultResponse;
+export declare function sanitizeDeviceStatus(value: unknown): DeviceStatus | null;
+export declare function sanitizeProvisioningStatus(value: unknown): ProvisioningStatus | null;
+export declare function isSignChain(value: unknown): value is string;
+export declare function isSignMethod(value: unknown): value is string;
+export declare function isUint64DecimalString(value: unknown): value is string;
+export declare function sanitizeCurrentPolicyDocument(value: unknown): PolicyDocument | null;
+export declare function sanitizeDeviceStatusSnapshot(value: unknown): DeviceStatusSnapshot | null;