@terminal3/t3n-sdk 4.28.0 → 4.29.0

package/dist/index.d.ts

@@ -4696,6 +4696,48 @@ interface ContractRegisterResult {
     /** Stable monotonic numeric contract id assigned at registration time. */
     contract_id: number;
 }
+/** Lifecycle status of a registered contract, mirroring the tenant contract's
+ * `ContractStatus` enum. */
+type ContractLifecycleStatus = "active" | "disabled";
+/**
+ * Descriptor facets on a {@link DetailedContract} row. A `null` `descriptor`
+ * on the enclosing row means *no descriptor is published*; a present value
+ * with an empty `summary` means a descriptor exists but carries no summary
+ * text — the two are deliberately distinguishable.
+ */
+interface ContractDescriptorFacets {
+    /** Contract-level summary from the descriptor (empty string when the
+     * published descriptor has no `summary` field). */
+    summary: string;
+    /** Contract-level tags from the descriptor (empty when absent). */
+    tags: string[];
+}
+/**
+ * One contract in a {@link ContractListDetailedPage}, mirroring the tenant
+ * contract's `contract-list-detailed` `DetailedContract` wire shape.
+ */
+interface DetailedContract {
+    /** Canonical `z:<tid>:<tail>` name. */
+    name: string;
+    /** Trailing tail segment (`z:<tid>:payroll` → `payroll`) for display. */
+    short_name: string;
+    /** Current registered version. */
+    version: string;
+    /** Lifecycle status. */
+    status: ContractLifecycleStatus;
+    /** Descriptor facets, or `null` when no descriptor is published for the
+     * current version. */
+    descriptor: ContractDescriptorFacets | null;
+}
+/**
+ * One page of {@link TenantContractsNamespace.listDetailed}. `next` is a cursor
+ * (a canonical contract name) to pass back as `after` for the following page,
+ * or `null` at the end of the inventory.
+ */
+interface ContractListDetailedPage {
+    contracts: DetailedContract[];
+    next: string | null;
+}
 
 type JsonObject = Record<string, unknown>;
 interface TenantExecutionSession {
@@ -4743,6 +4785,18 @@ interface TenantTargetOptions {
      */
     tenantTarget?: string;
 }
+/**
+ * Options for {@link TenantContractsNamespace.listDetailed} — a tenant target
+ * plus cursor pagination.
+ */
+interface ContractListDetailedOptions extends TenantTargetOptions {
+    /** Page cursor: the previous page's `next` (a canonical contract name).
+     * Omit for the first page. */
+    after?: string;
+    /** Max contracts in the page. Omit for the server default; values above the
+     * server ceiling are clamped down. */
+    limit?: number;
+}
 /**
  * Options for {@link TenantClient.admitForOrg}.
  */
@@ -4831,6 +4885,45 @@ declare class TenantContractsNamespace {
      * without one is not dispatchable through it.
      */
     setDescriptor(input: ContractSetDescriptorInput, opts?: TenantTargetOptions): Promise<unknown>;
+    /**
+     * List the canonical names of every contract registered under the resolved
+     * tenant — the org-admin inventory view.
+     *
+     * Dispatches `tee:tenant/contracts::contract-list`. Access is gated node-side
+     * by `resolve_tenant_did`: for an org-owned tenant the authenticated DID must
+     * be in the org's admin set (a non-admin gets a hard `OrgAdminRequired` error,
+     * never a masked-empty result); for an individual tenant the caller must be
+     * the tenant itself.
+     *
+     * Omit `tenantTarget` for individual self-management (the node resolves the
+     * target from the session DID); supply an org's 40-hex tid (or
+     * `did:t3n:<tid>`) to read an org-owned tenant's inventory as one of its
+     * admins.
+     *
+     * Returns the canonical `z:<tid>:<tail>` name of each live contract, one entry
+     * per name (version history collapsed to the `:current` name), lexicographically
+     * ordered. Names only — no descriptor or summary is carried.
+     */
+    list(opts?: TenantTargetOptions): Promise<string[]>;
+    /**
+     * List the resolved tenant's contracts with per-contract detail — current
+     * version, lifecycle status, and descriptor facets — one page at a time.
+     *
+     * Dispatches `tee:tenant/contracts::contract-list-detailed`, gated node-side
+     * by the same `resolve_tenant_did` admin check as {@link list}. Where `list`
+     * returns names only, this hydrates each row for an inventory view: `status`
+     * reflects `contract-enable` / `contract-disable`, and `descriptor` carries
+     * the published descriptor's `{summary, tags}` facets — or `null` when no
+     * descriptor has been published, which is deliberately distinct from a
+     * descriptor whose `summary` is empty.
+     *
+     * Cursor-paged: pass the previous page's `next` back as `opts.after`; a
+     * `null` `next` marks the end of the inventory. `opts.limit` caps the page
+     * (the server applies a default and a ceiling); omit for the default. Omit
+     * `tenantTarget` for individual self-management, or supply an org's tid to
+     * read an org-owned tenant's inventory as one of its admins.
+     */
+    listDetailed(opts?: ContractListDetailedOptions): Promise<ContractListDetailedPage>;
     disable(tail: string, opts?: TenantTargetOptions): Promise<unknown>;
     enable(tail: string, opts?: TenantTargetOptions): Promise<unknown>;
     unregister(tail: string, opts?: TenantTargetOptions): Promise<unknown>;
@@ -4939,4 +5032,4 @@ 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, InvokeError, 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, buildSecretWriteArgs, bytesToString, canonicalTenantName, clearKeyCache, clearManifestVersionFloor, compactDidFromBytes, createDefaultHandlers, createEmailOtpAuthInput, createEthAuthInput, createLogger, createMlKemPublicKeyHandler, createOidcAuthInput, createOrgDataClientFromSession, createRandomHandler, createUsageReportClientFromSession, createWorkloadAuthInput, decodeWasmErrorMessage, deriveAgentCardEntryId, eth_get_address, extractWasmError, fetchDkgAttestation, fetchMlKemPublicKey, fetchTrustedManifest, formatTokens, generateRandomString, generateUUID, getEnvironment, getEnvironmentName, getGlobalLogLevel, getLogger, getNodeUrl, getScriptVersion, invoke, isAgentCardResponse, isDataGetResponse, isDataListResponse, isListAgentsResponse, isMutationResponse, isObject, isOrgAdminStatus, isOrgContractGrants, isOrgPolicyMeta, isOrgPolicyView, isOrgUsageReport, isOrgWriters, isRoleAssignmentsResponse, isRoleGetResponse, isSecretListResponse, isSecretRecord, isSecretView, isUnsafeTrustServer, loadConfig, loadWasmComponent, manifestToTrustAnchor, maskKeyMaterial, mergeAgentAuthEntries, mergeDiscoverDids, metamask_get_address, metamask_sign, parseAgentAuthGet, parseAgentAuthPolicy, parseContractResponse, redactSecrets, redactSecretsFromJson, requestToWire, setEnvironment, setGlobalLogLevel, setNodeUrl, stringToBytes, tenantDidHex, toAgentAuthUpdateWire, toBaseUnits, validateConfig, validateTail, verifyDkgAttestation, verifyManifestSignature, verifyTdxQuote };
-export type { ActivityCallerType, ActivityEntry, ActivityOutcome, ActivityReport, AdmitForOrgOptions, AgentAuthEntry, AgentAuthMergeResult, AgentAuthPolicy, AgentAuthScriptGrant, AgentAuthUpdateInput, AgentCardRefInput, AgentCardResponse, AgentCardSetInput, AgentSummary, 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, FetchTrustedManifestOptions, GetActivityLogOptions, GetUsageOptions, GrantCheckParams, GrantCheckResult, GranteeInput, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, InvokeOptions, InvokeRequest, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, ListAgentsInput, ListAgentsResponse, 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, SecretKind, SecretListInput, SecretListResponse, SecretNameInput, SecretRecord, SecretSetValueInput, SecretView, SecretWriteInput, SessionCrypto, SessionId, SetGrantsInput, SetRoleInput, SetWritersInput, SignedTrustManifest, StringEncoding, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, TenantAdmitProjection, TenantAdmitStatus, TenantBaseClient, TenantClientConfig, TenantContractExecuteInput, TenantContractPublishInput, TenantContractSetDescriptorInput, TenantExecutionSession, TenantMapCreateInput, TenantMapUpdatePatch, TenantMeResponse, TenantSdkEnvironment, TenantSelfAdmitResult, TenantStatus, TenantTargetOptions, TokenTxKind, Transport, TrustAnchor, TrustAnchorOrUnsafe, TrustManifestPayload, UnassignRolesInput, UnsafeTrustServer, UpdateMetaInput, UsageEntry, UsagePage, UsageReportSignature, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WireBlock, WorkloadAuthInput, WriteDataInput, WriterSet, WritersGetInput };
+export type { ActivityCallerType, ActivityEntry, ActivityOutcome, ActivityReport, AdmitForOrgOptions, AgentAuthEntry, AgentAuthMergeResult, AgentAuthPolicy, AgentAuthScriptGrant, AgentAuthUpdateInput, AgentCardRefInput, AgentCardResponse, AgentCardSetInput, AgentSummary, AssignRolesInput, AuthInput, BalanceRow, ChargeReason, ClientAuth, ClientHandshake, ConfigValidationResult, ContractDescriptorFacets, ContractExecuteInput, ContractKind, ContractLifecycleStatus, ContractListDetailedOptions, ContractListDetailedPage, ContractPublishInput, ContractRegisterResult, ContractResponseSchema, ContractSetDescriptorInput, CreatePolicyInput, DataGetInput, DataGetResponse, DataListInput, DataListResponse, DelegationGrantKind, DelegationGrantRef, DeleteDataInput, DeleteGrantsInput, DeleteScopeInput, DetailedContract, Did, Direction, DkgAttestation, DkgVerifyResult, EmailOtpAuthInput, EmailOtpCredentials, Environment, EthAuthInput, ExecuteBusinessContractOptions, ExecuteOrgDataActionOptions, FetchTrustedManifestOptions, GetActivityLogOptions, GetUsageOptions, GrantCheckParams, GrantCheckResult, GranteeInput, GrantsGetInput, GuestToHostHandler, GuestToHostHandlers, HandshakeResult, InvokeOptions, InvokeRequest, JsonRpcRequest, JsonRpcResponse, KycPollCadence, KycPollOptions, KycStatus, KycStatusKind, ListAgentsInput, ListAgentsResponse, 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, SecretKind, SecretListInput, SecretListResponse, SecretNameInput, SecretRecord, SecretSetValueInput, SecretView, SecretWriteInput, SessionCrypto, SessionId, SetGrantsInput, SetRoleInput, SetWritersInput, SignedTrustManifest, StringEncoding, SubmitUserInputArgs, SubmitUserInputResult, T3nClientConfig, TenantAdmitProjection, TenantAdmitStatus, TenantBaseClient, TenantClientConfig, TenantContractExecuteInput, TenantContractPublishInput, TenantContractSetDescriptorInput, TenantExecutionSession, TenantMapCreateInput, TenantMapUpdatePatch, TenantMeResponse, TenantSdkEnvironment, TenantSelfAdmitResult, TenantStatus, TenantTargetOptions, TokenTxKind, Transport, TrustAnchor, TrustAnchorOrUnsafe, TrustManifestPayload, UnassignRolesInput, UnsafeTrustServer, UpdateMetaInput, UsageEntry, UsagePage, UsageReportSignature, UserGrant, UserInputProfile, UserUpsertErrorKind, WasmComponent, WasmNextResult, WireBlock, WorkloadAuthInput, WriteDataInput, WriterSet, WritersGetInput };