Skip to content

CalimeroClient

CalimeroClient(CalimeroClientOptions(baseUrl:nodes:policy:session:retry:)), or CalimeroClient.connect(CalimeroConnectOptions(cluster:policy:zone:)) to read a Calimero Cloud cluster’s nodes from the node directory. An actor. Method names follow mero-js’s CalimeroClient.

Methods marked with a passkey (passkey:) are step-ups: the node answers 412 CONFIRM_REQUIRED and the client answers with that passkey’s assertion.

Group Methods
Credentials useApiKey, useSession, session, onSessionChange, useStepUp, useOperatorSigner, nodeUrl, nodes, connect
Identity signUp(_:name:invite:origin:), signIn(_:origin:), refresh, signOut, signOutEverywhere, forget, addPasskey(_:approver:)
Calls call, callJSON, callConfirmed, view, viewJSON, events, presenceStream
Blobs uploadFile(_:_:), blobContent, listBlobs, blobInfo
Organizations setRecoveryKey(_:publicKey:passkey:), startRecovery(_:seed:), updateTeam
Approvals appsReportAll, pendingApprovals, requestConsent, consentResult, confirmConsentReturn, openConsentPage, waitForConsent, checkConsentCode (the consent page); pageDeployment(_:), frontendManifest(_:)
Raw routes get, post, put, delete, postConfirmed, deleteConfirmed; JSONValue(encoding:) (a facade answer as JSON, to read as MeroKit’s types)

Every other route is a method of the generated facade, one per operation of core’s OpenAPI document, grouped by its x-calimero-group: client.auth (me, usage, apikeyCreate, aliasList, …), client.apps (create, get, list, blobDownload, presencePublish, …), client.orgs (create, get, teamCreate, inviteCreate, setMember, …), client.consent (pageCreate, pageResult), client.ops, client.packages, client.deployments (sign-up, deployers, deployments) and client.publicApi (attestation, releasesPublic, publisherBinding). import MeroAPI to name the types they answer. A step-up method takes passkey: (else the client’s useStepUp passkey); an operator decision takes operatorSigner: (else useOperatorSigner).