@calimero-network/mero-js 19.24.1 → 19.25.0

package/dist/admin-api/admin-client.d.ts

@@ -1,5 +1,5 @@
 import { HttpClient } from '../http-client/index.js';
-import type { HealthStatus, AdminAuthStatus, InstallApplicationRequest, InstallApplicationResponseData, InstallDevApplicationRequest, UninstallApplicationResponseData, ListApplicationsResponseData, GetApplicationResponseData, ApplicationVersionEntry, GetApplicationAbiResponseData, GetLatestVersionResponseData, ListPackagesResponseData, ListVersionsResponseData, CreateContextRequest, CreateContextResponseData, DeleteContextResponseData, GetContextsResponseData, Context, GenerateContextIdentityResponseData, GetContextIdentitiesResponseData, JoinContextResponseData, JoinSubgroupInheritanceResponseData, ContextGroupResponseData, ContextStorageResponseData, InviteSpecializedNodeRequest, InviteSpecializedNodeResponseData, UpdateContextApplicationRequest, ResyncContextRequest, ResyncContextResponseData, ContextsWithExecutorsResponseData, UploadBlobRequest, UploadBlobResponseData, DeleteBlobResponseData, ListBlobsResponseData, GetBlobInfoResponseData, BlobReadOptions, CreateContextAliasRequest, CreateApplicationAliasRequest, CreateDeviceAliasRequest, CreateAliasResponseData, LookupAliasResponseData, DeleteAliasResponseData, ListAliasesResponseData, ListNamespacesResponseData, CreateNamespaceRequest, CreateNamespaceResponseData, DeleteNamespaceResponseData, CreateNamespaceInvitationRequest, CreateNamespaceInvitationResponseData, CreateRecursiveInvitationResponseData, JoinNamespaceRequest, JoinNamespaceResponseData, CreateGroupInNamespaceRequest, CreateGroupInNamespaceResponseData, SubgroupEntry, Namespace, NamespaceIdentity, NodeIdentity, AccountPairInitRequest, AccountPairInitResponseData, AccountPairCompleteRequest, AccountPairCompleteResponseData, AccountSignWithRootRequest, AccountSignWithRootResponseData, RelinkDeviceRequest, RelinkDeviceResponseData, RescopeDeviceRequest, RescopeDeviceResponseData, LabelDeviceRequest, LabelDeviceResponseData, AccountDeviceEntry, AccountApplicationEntry, RevokeAccountDeviceRequest, RevokeAccountDeviceResponseData, GroupInfoResponseData, CreateGroupRequest, CreateGroupResponseData, DeleteGroupResponseData, ListGroupMembersResponseData, ListGroupContextsResponseData, AddGroupMembersRequest, RemoveGroupMembersRequest, UpdateMemberRoleRequest, MemberCapabilities, SetMemberCapabilitiesRequest, SetDefaultCapabilitiesRequest, SetMemberAutoFollowRequest, SetSubgroupVisibilityRequest, SetTeeAdmissionPolicyRequest, GetTeeAdmissionPolicyResponseData, SetTeeAuthoringPolicyRequest, SetGroupMetadataRequest, SetMemberMetadataRequest, SetContextMetadataRequest, MetadataRecord, SyncGroupResponseData, UpgradeGroupRequest, UpgradeGroupResponseData, GroupUpgradeStatusResponseData, MigrationStatus, CascadeStatusEntry, RetryGroupUpgradeResponseData, ReparentGroupRequest, ReparentGroupResponseData, IssueOwnershipProofRequest, IssueNamespaceOwnershipProofRequest, IssueOwnershipProofResponseData, CreateGroupInvitationRequest, CreateGroupInvitationResponseData, CreateRecursiveGroupInvitationResponseData, JoinGroupRequest, JoinGroupResponseData, TeeInfoResponseData, TeeAttestRequest, TeeAttestResponseData, TeeVerifyQuoteRequest, TeeVerifyQuoteResponseData, PerformIntentRequest, PerformIntentResponseData, IntentRelayInfo, AdmitJoinRequest, AdmitJoinResponseData } from './admin-types.js';
+import type { HealthStatus, ReadinessStatus, AdminAuthStatus, InstallApplicationRequest, InstallApplicationResponseData, InstallDevApplicationRequest, UninstallApplicationResponseData, ListApplicationsResponseData, GetApplicationResponseData, ApplicationVersionEntry, GetApplicationAbiResponseData, GetLatestVersionResponseData, ListPackagesResponseData, ListVersionsResponseData, CreateContextRequest, CreateContextResponseData, DeleteContextResponseData, GetContextsResponseData, Context, GenerateContextIdentityResponseData, GetContextIdentitiesResponseData, JoinContextResponseData, JoinSubgroupInheritanceResponseData, ContextGroupResponseData, ContextStorageResponseData, InviteSpecializedNodeRequest, InviteSpecializedNodeResponseData, UpdateContextApplicationRequest, ResyncContextRequest, ResyncContextResponseData, ContextsWithExecutorsResponseData, UploadBlobRequest, UploadBlobResponseData, DeleteBlobResponseData, ListBlobsResponseData, GetBlobInfoResponseData, BlobReadOptions, CreateContextAliasRequest, CreateApplicationAliasRequest, CreateDeviceAliasRequest, CreateAliasResponseData, LookupAliasResponseData, DeleteAliasResponseData, ListAliasesResponseData, ListNamespacesResponseData, CreateNamespaceRequest, CreateNamespaceResponseData, DeleteNamespaceResponseData, CreateNamespaceInvitationRequest, CreateNamespaceInvitationResponseData, CreateRecursiveInvitationResponseData, JoinNamespaceRequest, JoinNamespaceResponseData, CreateGroupInNamespaceRequest, CreateGroupInNamespaceResponseData, SubgroupEntry, Namespace, NamespaceIdentity, NodeIdentity, AccountPairInitRequest, AccountPairInitResponseData, AccountPairCompleteRequest, AccountPairCompleteResponseData, AccountSignWithRootRequest, AccountSignWithRootResponseData, RelinkDeviceRequest, RelinkDeviceResponseData, RescopeDeviceRequest, RescopeDeviceResponseData, LabelDeviceRequest, LabelDeviceResponseData, AccountDeviceEntry, AccountApplicationEntry, RevokeAccountDeviceRequest, RevokeAccountDeviceResponseData, GroupInfoResponseData, CreateGroupRequest, CreateGroupResponseData, DeleteGroupResponseData, ListGroupMembersResponseData, ListGroupContextsResponseData, AddGroupMembersRequest, RemoveGroupMembersRequest, UpdateMemberRoleRequest, MemberCapabilities, SetMemberCapabilitiesRequest, SetDefaultCapabilitiesRequest, SetMemberAutoFollowRequest, SetSubgroupVisibilityRequest, SetTeeAdmissionPolicyRequest, GetTeeAdmissionPolicyResponseData, SetTeeAuthoringPolicyRequest, SetGroupMetadataRequest, SetMemberMetadataRequest, SetContextMetadataRequest, MetadataRecord, SyncGroupResponseData, UpgradeGroupRequest, UpgradeGroupResponseData, GroupUpgradeStatusResponseData, MigrationStatus, CascadeStatusEntry, RetryGroupUpgradeResponseData, ReparentGroupRequest, ReparentGroupResponseData, IssueOwnershipProofRequest, IssueNamespaceOwnershipProofRequest, IssueOwnershipProofResponseData, CreateGroupInvitationRequest, CreateGroupInvitationResponseData, CreateRecursiveGroupInvitationResponseData, JoinGroupRequest, JoinGroupResponseData, TeeInfoResponseData, TeeAttestRequest, TeeAttestResponseData, TeeVerifyQuoteRequest, TeeVerifyQuoteResponseData, PerformIntentRequest, PerformIntentResponseData, IntentRelayInfo, QueryContextRequest, QueryContextResponseData, ListMemberDevicesOptions, ListMemberDevicesResponseData, SealToAccountRequest, SealedEnvelope, AdmitJoinRequest, AdmitJoinResponseData } from './admin-types.js';
 /**
  * Compare two version strings by SemVer 2.0 precedence, ascending: negative if
  * `a < b`, positive if `a > b`, `0` if equal. Build metadata (`+...`) is stripped
@@ -15,6 +15,12 @@ export declare class AdminApiClient {
     private httpClient;
     constructor(httpClient: HttpClient);
     healthCheck(): Promise<HealthStatus>;
+    /**
+     * Whether the node has finished starting and its store answers. Public, like
+     * {@link healthCheck}; unlike it, a node that is up but not ready answers
+     * `503`, which this surfaces as an `HTTPError` whose body names the stage.
+     */
+    readinessCheck(): Promise<ReadinessStatus>;
     isAuthed(): Promise<AdminAuthStatus>;
     /**
      * Install a published application by its `package@version` coordinates. The
@@ -178,6 +184,16 @@ export declare class AdminApiClient {
      * {@link PerformIntentRequest.warrant}.
      */
     performIntent(contextId: string, request: PerformIntentRequest): Promise<PerformIntentResponseData>;
+    /**
+     * Read a context as the session's ACCOUNT, without minting a warrant.
+     *
+     * Needs an account-authenticated session — one from {@link login}, not the
+     * admin password login — and refuses otherwise with a `401`. The account must
+     * be a member of the group owning the context (`403` if not), and the method
+     * must be declared read-only in the app's ABI (`409` if not; a write needs
+     * {@link performIntent}).
+     */
+    queryContext(contextId: string, request: QueryContextRequest): Promise<QueryContextResponseData>;
     /**
      * Ask what this node can do for a member in `contextId`, before they sign
      * anything.
@@ -366,6 +382,18 @@ export declare class AdminApiClient {
     getSubgroupVisibility(groupId: string): Promise<string>;
     deleteGroup(groupId: string): Promise<DeleteGroupResponseData>;
     listGroupMembers(groupId: string): Promise<ListGroupMembersResponseData>;
+    /**
+     * Member accounts in the group and the devices bound to each. An admin node
+     * sees every account; a plain member only its own. `403` if this node is not a
+     * member of the group.
+     */
+    listMemberDevices(groupId: string, options?: ListMemberDevicesOptions): Promise<ListMemberDevicesResponseData>;
+    /**
+     * Seal a small payload to a member account's root key. This node must be a
+     * member of the group, and `account` must be an account the group knows, so
+     * the route reaches no further than the caller already does.
+     */
+    sealToAccount(groupId: string, account: string, request: SealToAccountRequest): Promise<SealedEnvelope>;
     listGroupContexts(groupId: string): Promise<ListGroupContextsResponseData>;
     addGroupMembers(groupId: string, request: AddGroupMembersRequest): Promise<void>;
     removeGroupMembers(groupId: string, request: RemoveGroupMembersRequest): Promise<void>;

package/dist/admin-api/admin-client.js

@@ -104,6 +104,14 @@ export class AdminApiClient {
     async healthCheck() {
         return unwrap(await this.httpClient.get('/admin-api/health'));
     }
+    /**
+     * Whether the node has finished starting and its store answers. Public, like
+     * {@link healthCheck}; unlike it, a node that is up but not ready answers
+     * `503`, which this surfaces as an `HTTPError` whose body names the stage.
+     */
+    async readinessCheck() {
+        return unwrap(await this.httpClient.get('/admin-api/ready'));
+    }
     async isAuthed() {
         return this.httpClient.get('/admin-api/is-authed');
     }
@@ -452,6 +460,18 @@ export class AdminApiClient {
     async performIntent(contextId, request) {
         return unwrap(await this.httpClient.post(`/admin-api/contexts/${contextId}/intents`, request));
     }
+    /**
+     * Read a context as the session's ACCOUNT, without minting a warrant.
+     *
+     * Needs an account-authenticated session — one from {@link login}, not the
+     * admin password login — and refuses otherwise with a `401`. The account must
+     * be a member of the group owning the context (`403` if not), and the method
+     * must be declared read-only in the app's ABI (`409` if not; a write needs
+     * {@link performIntent}).
+     */
+    async queryContext(contextId, request) {
+        return unwrap(await this.httpClient.post(`/admin-api/contexts/${contextId}/query`, request));
+    }
     /**
      * Ask what this node can do for a member in `contextId`, before they sign
      * anything.
@@ -725,6 +745,29 @@ export class AdminApiClient {
         }
         return response;
     }
+    /**
+     * Member accounts in the group and the devices bound to each. An admin node
+     * sees every account; a plain member only its own. `403` if this node is not a
+     * member of the group.
+     */
+    async listMemberDevices(groupId, options = {}) {
+        const params = new URLSearchParams();
+        if (options.offset !== undefined)
+            params.set('offset', String(options.offset));
+        if (options.limit !== undefined)
+            params.set('limit', String(options.limit));
+        const query = params.toString();
+        const path = `/admin-api/groups/${groupId}/member-devices${query ? `?${query}` : ''}`;
+        return this.httpClient.get(path);
+    }
+    /**
+     * Seal a small payload to a member account's root key. This node must be a
+     * member of the group, and `account` must be an account the group knows, so
+     * the route reaches no further than the caller already does.
+     */
+    async sealToAccount(groupId, account, request) {
+        return unwrap(await this.httpClient.post(`/admin-api/groups/${groupId}/accounts/${account}/seal`, request));
+    }
     async listGroupContexts(groupId) {
         return unwrap(await this.httpClient.get(`/admin-api/groups/${groupId}/contexts`));
     }

package/dist/admin-api/admin-types.d.ts

@@ -2,6 +2,15 @@ export { ApiResponse } from '../http-client/index.js';
 export interface HealthStatus {
     status: string;
 }
+/**
+ * What `GET /admin-api/ready` reports: `ready` once the node has finished
+ * starting up and its store answers. A node that is not ready answers `503`
+ * with its lifecycle stage (or `store_unavailable`) as the status, which the
+ * client surfaces as an `HTTPError`.
+ */
+export interface ReadinessStatus {
+    status: string;
+}
 export interface AdminAuthStatus {
     data: {
         status: string;
@@ -412,6 +421,24 @@ export interface PerformIntentRequest {
     authorProof: string;
 }
 /** What a performed intent reports back. */
+/**
+ * A read of a context, run as the caller's account. Needs no warrant: a read
+ * publishes nothing, so there is no peer to convince.
+ */
+export interface QueryContextRequest {
+    /**
+     * The method to call. It must be declared read-only in the application's ABI
+     * (a `&self` method in a Rust app); anything else is refused with a `409`,
+     * because a write needs a warrant ({@link PerformIntentRequest}).
+     */
+    method: string;
+    /** Its arguments, as the JSON the guest will receive. */
+    argsJson: unknown;
+}
+export interface QueryContextResponseData {
+    /** The method's own return value. */
+    returns: unknown | null;
+}
 export interface PerformIntentResponseData {
     /**
      * The context's scope root after the run — how a caller sees that it wrote.
@@ -1225,6 +1252,57 @@ export interface ListGroupMembersResponseData {
      */
     data?: GroupMember[];
 }
+/** One device bound to a member account. */
+export interface MemberDevice {
+    /** 64 hex; the form `revokeAccountDevice` takes. */
+    deviceId: string;
+    /**
+     * The key this device's signatures carry, 64 hex. Joins against the
+     * identities a context lists.
+     */
+    signingKey: string;
+}
+/** A member account and the devices bound to it in the namespace. */
+export interface MemberDevicesEntry {
+    /** The member's ACCOUNT, 64 hex. */
+    account: string;
+    devices: MemberDevice[];
+}
+export interface ListMemberDevicesOptions {
+    offset?: number;
+    limit?: number;
+}
+export interface ListMemberDevicesResponseData {
+    /**
+     * Every account in the group if the calling node is an admin; only its own
+     * entry if it is a plain member.
+     */
+    members: MemberDevicesEntry[];
+}
+export interface SealToAccountRequest {
+    /**
+     * Hex-encoded plaintext. Small by design: the route exists to hand an account
+     * something like a list of namespace ids, and the node caps the size.
+     */
+    plaintext: string;
+}
+/**
+ * A payload sealed to an account's root key. Only that account's root can open
+ * it; the node that sealed it cannot.
+ */
+export interface SealedEnvelope {
+    /**
+     * The root-key epoch it was sealed under. A rotated root still opens envelopes
+     * from its own epoch, so a recipient holding several needs to know which.
+     */
+    accountRootEpoch: number;
+    /** Hex, 32 bytes: the one-shot sender key. */
+    ephemeralPublicKey: string;
+    /** Hex, 12 bytes: the AES-256-GCM nonce. */
+    nonce: string;
+    /** Hex: the ciphertext with its 16-byte tag appended. */
+    ciphertext: string;
+}
 export interface GroupContextEntry {
     contextId: string;
     name?: string;