Class: ParmanaClient

Defined in: typescript/src/client/ParmanaClient.ts:73

Canonical Parmana SDK client.

Constructors

Constructor

new ParmanaClient(configuration): ParmanaClient

Defined in: typescript/src/client/ParmanaClient.ts:142

Creates a Parmana SDK client.

Parameters

configuration

Configuration

Returns

ParmanaClient

Properties

configuration

readonly configuration: Configuration

Defined in: typescript/src/client/ParmanaClient.ts:77

Immutable SDK configuration.

Methods

endpoint()

endpoint(): string

Defined in: typescript/src/client/ParmanaClient.ts:180

Returns the configured Runtime endpoint.

Returns

string

---

health()

health(): Promise<HealthStatus>

Defined in: typescript/src/client/ParmanaClient.ts:187

Performs a Runtime health check.

Returns

Promise<HealthStatus>

---

version()

version(): Promise<unknown>

Defined in: typescript/src/client/ParmanaClient.ts:194

Returns the Runtime name, version, and API version.

Returns

Promise<unknown>

---

execute()

execute(transaction): Promise<ExecutionTrustRecord>

Defined in: typescript/src/client/ParmanaClient.ts:201

Executes a Business Transaction.

Parameters

transaction

BusinessTransaction

Returns

Promise<ExecutionTrustRecord>

---

verify()

verify(businessTransactionId): Promise<Verification>

Defined in: typescript/src/client/ParmanaClient.ts:213

Runs a fresh verification of an Execution Trust Record, appending a new Verification to its history. Distinct from getLatestVerification(), which reads the most recent one without re-verifying.

Parameters

businessTransactionId

string

Returns

Promise<Verification>

---

getLatestVerification()

getLatestVerification(businessTransactionId): Promise<Verification>

Defined in: typescript/src/client/ParmanaClient.ts:220

Returns the latest Verification.

Parameters

businessTransactionId

string

Returns

Promise<Verification>

---

replay()

replay(businessTransactionId): Promise<ReplayResult>

Defined in: typescript/src/client/ParmanaClient.ts:229

Performs deterministic replay.

Parameters

businessTransactionId

string

Returns

Promise<ReplayResult>

---

receipt()

receipt(businessTransactionId): Promise<Receipt>

Defined in: typescript/src/client/ParmanaClient.ts:236

Generates an execution receipt.

Parameters

businessTransactionId

string

Returns

Promise<Receipt>

---

createTransaction()

createTransaction(transaction): Promise<ExecutionTrustRecord>

Defined in: typescript/src/client/ParmanaClient.ts:245

Creates (executes) a Business Transaction via POST /transactions, a second, independent entry point into the identical execution pipeline as execute() (POST /execute). See TransactionApi.create.

Parameters

transaction

BusinessTransaction

Returns

Promise<ExecutionTrustRecord>

---

transaction()

transaction(businessTransactionId): Promise<BusinessTransaction>

Defined in: typescript/src/client/ParmanaClient.ts:254

Retrieves a Business Transaction.

Parameters

businessTransactionId

string

Returns

Promise<BusinessTransaction>

---

transactions()

transactions(page?, pageSize?): Promise<BusinessTransaction[]>

Defined in: typescript/src/client/ParmanaClient.ts:263

Lists Business Transactions.

Parameters

page?

number = 1

pageSize?

number = 25

Returns

Promise<BusinessTransaction[]>

---

trustRecord()

trustRecord(businessTransactionId): Promise<ExecutionTrustRecord>

Defined in: typescript/src/client/ParmanaClient.ts:270

Retrieves an Execution Trust Record.

Parameters

businessTransactionId

string

Returns

Promise<ExecutionTrustRecord>

---

validatePolicy()

validatePolicy(policyId, policyVersion): Promise<PolicyValidationResult>

Defined in: typescript/src/client/ParmanaClient.ts:279

Confirms that a policy (name + version) is loadable by the Runtime.

Parameters

policyId

string

policyVersion

string

Returns

Promise<PolicyValidationResult>

---

refusalRecord()

refusalRecord(businessTransactionId): Promise<RefusalRecord>

Defined in: typescript/src/client/ParmanaClient.ts:289

Retrieves a Refusal Record by Business Transaction ID.

Parameters

businessTransactionId

string

Returns

Promise<RefusalRecord>

---

verifyRefusalRecord()

verifyRefusalRecord(record): Promise<boolean>

Defined in: typescript/src/client/ParmanaClient.ts:296

Verifies a Refusal Record’s signature.

Parameters

record

RefusalRecord

Returns

Promise<boolean>

---

executionIntent()

executionIntent(businessTransactionId): Promise<ExecutionIntentView>

Defined in: typescript/src/client/ParmanaClient.ts:305

Retrieves an Execution Intent and its status by Business Transaction ID (ADR-0012). The intent is the signed statement, stored before an action is released, of what was about to be released.

Parameters

businessTransactionId

string

Returns

Promise<ExecutionIntentView>

---

verifyExecutionIntent()

verifyExecutionIntent(intent): Promise<boolean>

Defined in: typescript/src/client/ParmanaClient.ts:316

Verifies an Execution Intent’s hash and signature. Needs no credential. true proves the intent is genuine and unaltered. It does not prove the action was released, or what its result was.

Parameters

intent

ExecutionIntent

Returns

Promise<boolean>

---

unfinalizedExecutionIntents()

unfinalizedExecutionIntents(limit?): Promise<UnfinalizedExecutionIntents>

Defined in: typescript/src/client/ParmanaClient.ts:325

Lists Execution Intents that never reached a signed Trust Record and were not closed by hand, oldest first. Needs a credential provisioned as a verified human.

Parameters

limit?

number

Returns

Promise<UnfinalizedExecutionIntents>

---

finalizeExecutionIntent()

finalizeExecutionIntent(businessTransactionId): Promise<FinalizeExecutionIntentResult>

Defined in: typescript/src/client/ParmanaClient.ts:336

Rebuilds the signed Trust Record for a released action whose record was never produced. Never calls a connector. Safe to run twice. Needs a credential provisioned as a verified human.

Parameters

businessTransactionId

string

Returns

Promise<FinalizeExecutionIntentResult>

---

resolveExecutionIntent()

resolveExecutionIntent(businessTransactionId, input): Promise<ResolveExecutionIntentResult>

Defined in: typescript/src/client/ParmanaClient.ts:347

Closes a PREPARED or ERRORED intent that a verified human reconciled at the connector. The note is required. The resolution is an attributed operator statement in unsigned status, not a Trust Record.

Parameters

businessTransactionId

string

input

ResolveExecutionIntentInput

Returns

Promise<ResolveExecutionIntentResult>

---

verifyAuditEvent()

verifyAuditEvent(event, signature): Promise<boolean>

Defined in: typescript/src/client/ParmanaClient.ts:357

Verifies a signed caller-authentication audit event’s signature.

Parameters

event

AuditEvent

signature

Signature

Returns

Promise<boolean>