@terminal3/t3n-sdk 4.18.0 → 4.19.0

package/dist/index.d.ts

@@ -2968,6 +2968,56 @@ interface OrgContractGrants {
  * here would create maintenance churn against benign field additions.
  */
 declare function isOrgContractGrants(value: unknown): value is OrgContractGrants;
+/**
+ * One grant inside a role: a {@link UserGrant} body (without the
+ * grantee, which is bound at assignment time) plus the target contract.
+ * Mirrors the org-data `RoleGrant` wire shape.
+ */
+interface RoleGrant {
+    /** Target contract (canonical name, e.g. `"tee:z-payroll/contracts"`). */
+    contract_id: string;
+    /** WIT function names this grant confers. */
+    functions: string[];
+    /** Data scope paths this grant confers (canonicalised lowercase). */
+    scopes: string[];
+}
+/**
+ * A role: a named bundle of grants and/or composed sub-roles.
+ * Mirrors the org-data `RoleDefinition` wire shape.
+ */
+interface RoleDefinition {
+    /** Org-unique role identifier (slug; function-name grammar). */
+    role_id: string;
+    /** Human-facing label. */
+    label: string;
+    /** Composite: other role ids in the same org whose grants this role confers. */
+    includes: string[];
+    /** Grants this role confers directly. */
+    grants: RoleGrant[];
+}
+/**
+ * The roles assigned to one grantee within one org.
+ * Mirrors the org-data `RoleAssignments` wire shape.
+ */
+interface RoleAssignments {
+    /** Assigned role ids. */
+    roles: string[];
+}
+/** Response for `org-role-get`; `role` is `null` when the id is unknown. */
+interface RoleGetResponse {
+    role: RoleDefinition | null;
+}
+/** Shallow runtime guard for {@link RoleGetResponse}. */
+declare function isRoleGetResponse(value: unknown): value is RoleGetResponse;
+/** Response for `org-role-assignments-get`. */
+interface RoleAssignmentsResponse {
+    /** Echoed back so callers don't need to track which request this answers. */
+    grantee_did: string;
+    /** The grantee's assigned role ids (empty when none). */
+    roles: string[];
+}
+/** Shallow runtime guard for {@link RoleAssignmentsResponse}. */
+declare function isRoleAssignmentsResponse(value: unknown): value is RoleAssignmentsResponse;
 /** Response for `org-data-list`. */
 interface DataListResponse {
     /** Hex-encoded entry IDs for this page. */
@@ -3100,6 +3150,27 @@ interface DeleteGrantsInput {
     orgDid: string;
     contractId: string;
 }
+interface SetRoleInput {
+    orgDid: string;
+    role: RoleDefinition;
+}
+interface RoleIdInput {
+    orgDid: string;
+    roleId: string;
+}
+interface AssignRolesInput {
+    orgDid: string;
+    granteeDid: string;
+    /** Full replacement set of role ids; an empty list clears the assignment. */
+    roles: string[];
+}
+/** An (org, grantee) pair — the read/clear key for role assignments. */
+interface GranteeInput {
+    orgDid: string;
+    granteeDid: string;
+}
+/** Alias of {@link GranteeInput} — named for the `unassignRoles` call site. */
+type UnassignRolesInput = GranteeInput;
 interface WriteDataInputBase {
     orgDid: string;
     scope: string;
@@ -3289,6 +3360,21 @@ declare class OrgDataClient {
      * Delete the grant entry for a contract entirely.
      */
     deleteGrants(input: DeleteGrantsInput): Promise<MutationResponse>;
+    /** Upsert a role definition (org-admin only). */
+    setRole(input: SetRoleInput): Promise<MutationResponse>;
+    /** Delete a role definition (org-admin only). */
+    deleteRole(input: RoleIdInput): Promise<MutationResponse>;
+    /** Read one role definition (org-admin only); `role` is `null` if unknown. */
+    getRole(input: RoleIdInput): Promise<RoleGetResponse>;
+    /**
+     * Set a grantee's assigned roles (full replacement; empty list clears).
+     * Org-admin only.
+     */
+    assignRoles(input: AssignRolesInput): Promise<MutationResponse>;
+    /** Clear a grantee's role assignments (org-admin only). */
+    unassignRoles(input: UnassignRolesInput): Promise<MutationResponse>;
+    /** Read a grantee's assigned role ids (org-admin only). */
+    getRoleAssignments(input: GranteeInput): Promise<RoleAssignmentsResponse>;
     /**
      * Write a data entry to the org's scope.
      *
@@ -3436,6 +3522,21 @@ declare class SessionOrgDataClient {
     setGrants(input: SetGrantsInput): Promise<MutationResponse>;
     /** Mirrors {@link OrgDataClient.deleteGrants}. */
     deleteGrants(input: DeleteGrantsInput): Promise<MutationResponse>;
+    /** Upsert a role definition (org-admin only). */
+    setRole(input: SetRoleInput): Promise<MutationResponse>;
+    /** Delete a role definition (org-admin only). */
+    deleteRole(input: RoleIdInput): Promise<MutationResponse>;
+    /** Read one role definition (org-admin only); `role` is `null` if unknown. */
+    getRole(input: RoleIdInput): Promise<RoleGetResponse>;
+    /**
+     * Set a grantee's assigned roles (full replacement; empty list clears).
+     * Org-admin only.
+     */
+    assignRoles(input: AssignRolesInput): Promise<MutationResponse>;
+    /** Clear a grantee's role assignments (org-admin only). */
+    unassignRoles(input: UnassignRolesInput): Promise<MutationResponse>;
+    /** Read a grantee's assigned role ids (org-admin only). */
+    getRoleAssignments(input: GranteeInput): Promise<RoleAssignmentsResponse>;
     /** Mirrors {@link OrgDataClient.writeData}. */
     writeData(input: WriteDataInput): Promise<MutationResponse>;
     /** Mirrors {@link OrgDataClient.deleteData}. */
@@ -4283,5 +4384,5 @@ declare function tenantDidHex(tenantDid: string): string;
 declare function validateTail(tail: string): string;
 declare function canonicalTenantName(tenantDid: string, tail: string): string;
 
-export { AGENT_CARDS_SCOPE, AuthMethod, AuthenticationError, BASE_UNITS_PER_TOKEN, ContractResponseError, DEFAULT_ENVIRONMENT, DEFAULT_INDIVIDUAL_THRESHOLD_CENTS, DEFAULT_KYC_POLL_CADENCE, HandshakeError, HttpTransport, KycStatusTimeoutError, LogLevel, MockTransport, NODE_URLS, OrgDataClient, OtpRateLimitedError, RpcError, SessionExpiredError, SessionOrgDataClient, SessionStateError, SessionStatus, SessionUsageReportClient, T3nClient, T3nError, TERMINAL_KYC_STATUSES, TOKEN_DECIMALS, TenantClient, TenantContractsNamespace, TenantMapsNamespace, TenantNamespace, TenantSdkValidationError, TenantTokenNamespace, UnsupportedTenantSdkOperationError, UserUpsertError, WasmError, WireEncodingError, Z_PAYROLL_AUDIT_READ_FUNCTIONS, Z_PAYROLL_RUN_FUNCTIONS, _b64uEncode, assertShape, b64uDecodeStrict, b64uEncodeBytes, bytesToString, canonicalTenantName, clearKeyCache, compactDidFromBytes, createDefaultHandlers, createEmailOtpAuthInput, createEthAuthInput, createLogger, createMlKemPublicKeyHandler, createOidcAuthInput, createOrgDataClientFromSession, createRandomHandler, createUsageReportClientFromSession, createWorkloadAuthInput, decodeWasmErrorMessage, deriveAgentCardEntryId, eth_get_address, extractWasmError, fetchDkgAttestation, fetchMlKemPublicKey, formatTokens, generateRandomString, generateUUID, getEnvironment, getEnvironmentName, getGlobalLogLevel, getLogger, getNodeUrl, getScriptVersion, isAgentCardResponse, isDataGetResponse, isDataListResponse, isMutationResponse, isObject, isOrgAdminStatus, isOrgContractGrants, isOrgPolicyMeta, isOrgPolicyView, isOrgUsageReport, isOrgWriters, isUnsafeTrustServer, loadConfig, loadWasmComponent, maskKeyMaterial, mergeAgentAuthEntries, mergeDiscoverDids, metamask_get_address, metamask_sign, parseAgentAuthGet, parseAgentAuthPolicy, parseContractResponse, redactSecrets, redactSecretsFromJson, requestToWire, setEnvironment, setGlobalLogLevel, setNodeUrl, stringToBytes, tenantDidHex, toAgentAuthUpdateWire, toBaseUnits, validateConfig, validateTail, verifyDkgAttestation, verifyTdxQuote };
-export type { AdmitForOrgOptions, AgentAuthEntry, AgentAuthMergeResult, AgentAuthPolicy, AgentAuthScriptGrant, AgentAuthUpdateInput, AgentCardRefInput, AgentCardResponse, AgentCardSetInput, AuthInput, BalanceRow, ChargeReason, ClientAuth, ClientHandshake, ConfigValidationResult, ContractExecuteInput, ContractKind, ContractPublishInput, ContractRegisterResult, ContractResponseSchema, ContractSetDescriptorInput, CreatePolicyInput, DataGetInput, DataGetResponse, DataListInput, DataListResponse, DelegationGrantKind, DelegationGrantRef, DeleteDataInput, DeleteGrantsInput, DeleteScopeInput, Did, Direction, DkgAttestation, DkgVerifyResult, EmailOtpAuthInput, EmailOtpCredentials, Environment, EthAuthInput, ExecuteBusinessContractOptions, ExecuteOrgDataActionOptions, GetUsageOptions, GrantCheckParams, GrantCheckResult, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, ListContractsParams, ListContractsResult, ListContractsScope, ListedContract, Logger, MapCreateInput, MapLifecycleStatus, MapResponse, MapUpdateInput, MapVisibility, MutationResponse, OidcAuthInput, OidcCredentials, OrgAdminStatus, OrgContractGrants, OrgDataActionWire, OrgDataClientOptions, OrgPolicyMeta, OrgPolicyView, OrgUsageReport, OrgUsageReportInput, OrgWriters, OtpChannel, OtpMergeSuggestion, OtpRequestInput, OtpRequestResult, OtpVerifyInput, OtpVerifyResult, PayrollRunRequest, PeerQuoteResult, PolicyGetInput, PurgeOrgInput, QuoteVerifyResult, ReaderSet, RemoveMemberGrantsInput, SdkConfig, SessionCrypto, SessionId, SetGrantsInput, SetWritersInput, StringEncoding, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, TenantAdmitProjection, TenantAdmitStatus, TenantBaseClient, TenantClientConfig, TenantContractExecuteInput, TenantContractPublishInput, TenantContractSetDescriptorInput, TenantExecutionSession, TenantMapCreateInput, TenantMapUpdatePatch, TenantMeResponse, TenantSdkEnvironment, TenantSelfAdmitResult, TenantStatus, TenantTargetOptions, TokenTxKind, Transport, TrustAnchor, TrustAnchorOrUnsafe, UnsafeTrustServer, UpdateMetaInput, UsageEntry, UsagePage, UsageReportSignature, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WireBlock, WorkloadAuthInput, WriteDataInput, WriterSet, WritersGetInput };
+export { AGENT_CARDS_SCOPE, AuthMethod, AuthenticationError, BASE_UNITS_PER_TOKEN, ContractResponseError, DEFAULT_ENVIRONMENT, DEFAULT_INDIVIDUAL_THRESHOLD_CENTS, DEFAULT_KYC_POLL_CADENCE, HandshakeError, HttpTransport, KycStatusTimeoutError, LogLevel, MockTransport, NODE_URLS, OrgDataClient, OtpRateLimitedError, RpcError, SessionExpiredError, SessionOrgDataClient, SessionStateError, SessionStatus, SessionUsageReportClient, T3nClient, T3nError, TERMINAL_KYC_STATUSES, TOKEN_DECIMALS, TenantClient, TenantContractsNamespace, TenantMapsNamespace, TenantNamespace, TenantSdkValidationError, TenantTokenNamespace, UnsupportedTenantSdkOperationError, UserUpsertError, WasmError, WireEncodingError, Z_PAYROLL_AUDIT_READ_FUNCTIONS, Z_PAYROLL_RUN_FUNCTIONS, _b64uEncode, assertShape, b64uDecodeStrict, b64uEncodeBytes, bytesToString, canonicalTenantName, clearKeyCache, compactDidFromBytes, createDefaultHandlers, createEmailOtpAuthInput, createEthAuthInput, createLogger, createMlKemPublicKeyHandler, createOidcAuthInput, createOrgDataClientFromSession, createRandomHandler, createUsageReportClientFromSession, createWorkloadAuthInput, decodeWasmErrorMessage, deriveAgentCardEntryId, eth_get_address, extractWasmError, fetchDkgAttestation, fetchMlKemPublicKey, formatTokens, generateRandomString, generateUUID, getEnvironment, getEnvironmentName, getGlobalLogLevel, getLogger, getNodeUrl, getScriptVersion, isAgentCardResponse, isDataGetResponse, isDataListResponse, isMutationResponse, isObject, isOrgAdminStatus, isOrgContractGrants, isOrgPolicyMeta, isOrgPolicyView, isOrgUsageReport, isOrgWriters, isRoleAssignmentsResponse, isRoleGetResponse, isUnsafeTrustServer, loadConfig, loadWasmComponent, maskKeyMaterial, mergeAgentAuthEntries, mergeDiscoverDids, metamask_get_address, metamask_sign, parseAgentAuthGet, parseAgentAuthPolicy, parseContractResponse, redactSecrets, redactSecretsFromJson, requestToWire, setEnvironment, setGlobalLogLevel, setNodeUrl, stringToBytes, tenantDidHex, toAgentAuthUpdateWire, toBaseUnits, validateConfig, validateTail, verifyDkgAttestation, verifyTdxQuote };
+export type { AdmitForOrgOptions, AgentAuthEntry, AgentAuthMergeResult, AgentAuthPolicy, AgentAuthScriptGrant, AgentAuthUpdateInput, AgentCardRefInput, AgentCardResponse, AgentCardSetInput, AssignRolesInput, AuthInput, BalanceRow, ChargeReason, ClientAuth, ClientHandshake, ConfigValidationResult, ContractExecuteInput, ContractKind, ContractPublishInput, ContractRegisterResult, ContractResponseSchema, ContractSetDescriptorInput, CreatePolicyInput, DataGetInput, DataGetResponse, DataListInput, DataListResponse, DelegationGrantKind, DelegationGrantRef, DeleteDataInput, DeleteGrantsInput, DeleteScopeInput, Did, Direction, DkgAttestation, DkgVerifyResult, EmailOtpAuthInput, EmailOtpCredentials, Environment, EthAuthInput, ExecuteBusinessContractOptions, ExecuteOrgDataActionOptions, GetUsageOptions, GrantCheckParams, GrantCheckResult, GranteeInput, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, ListContractsParams, ListContractsResult, ListContractsScope, ListedContract, Logger, MapCreateInput, MapLifecycleStatus, MapResponse, MapUpdateInput, MapVisibility, MutationResponse, OidcAuthInput, OidcCredentials, OrgAdminStatus, OrgContractGrants, OrgDataActionWire, OrgDataClientOptions, OrgPolicyMeta, OrgPolicyView, OrgUsageReport, OrgUsageReportInput, OrgWriters, OtpChannel, OtpMergeSuggestion, OtpRequestInput, OtpRequestResult, OtpVerifyInput, OtpVerifyResult, PayrollRunRequest, PeerQuoteResult, PolicyGetInput, PurgeOrgInput, QuoteVerifyResult, ReaderSet, RemoveMemberGrantsInput, RoleAssignments, RoleAssignmentsResponse, RoleDefinition, RoleGetResponse, RoleGrant, RoleIdInput, SdkConfig, SessionCrypto, SessionId, SetGrantsInput, SetRoleInput, SetWritersInput, StringEncoding, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, TenantAdmitProjection, TenantAdmitStatus, TenantBaseClient, TenantClientConfig, TenantContractExecuteInput, TenantContractPublishInput, TenantContractSetDescriptorInput, TenantExecutionSession, TenantMapCreateInput, TenantMapUpdatePatch, TenantMeResponse, TenantSdkEnvironment, TenantSelfAdmitResult, TenantStatus, TenantTargetOptions, TokenTxKind, Transport, TrustAnchor, TrustAnchorOrUnsafe, UnassignRolesInput, UnsafeTrustServer, UpdateMetaInput, UsageEntry, UsagePage, UsageReportSignature, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WireBlock, WorkloadAuthInput, WriteDataInput, WriterSet, WritersGetInput };