Skip to main content

acosmi/
lib.rs

1//! # acosmi-sdk
2//!
3//! Acosmi Rust SDK — 模型网关(双格式 Anthropic + OpenAI)、Agent Run Gateway 与
4//! Compliance(电子证据、时间章、报告、签署 envelope)统一客户端。
5//!
6//! 端口自 [`acosmi-sdk-ts`](https://github.com/acosmi/sdk-ts) v2.8.0(事实标准主实现)。
7//! 跨语言契约(snake_case wire-format / 符号名对齐 / bug-for-bug 行为)见
8//! `docs/开发与发布手册.md` §5。
9//!
10//! ## 双格式红线
11//!
12//! `AnthropicAdapter` + `OpenAIAdapter` 等地位(对应两个不同下游产品),恒编译、不可降级。
13//!
14//! ## 运行时
15//!
16//! 仅原生 `tokio` + `reqwest`(rustls TLS)。流式走 `impl Stream`,取消走
17//! `tokio_util::CancellationToken`。
18//!
19//! ## 模块(随分阶段端口逐步填充)
20//!
21//! 各业务域 module 是该域对外切片的单一真相源;`lib.rs` 经 `pub use` 对齐
22//! `index.ts` 的逐域 re-export。
23
24#![forbid(unsafe_code)]
25
26/// SDK 版本(对齐 npm `@acosmi/sdk-ts` 主线 / `Cargo.toml` package.version)。
27pub const VERSION: &str = env!("CARGO_PKG_VERSION");
28
29mod macros;
30
31// === 业务域 module(P1→P8 分阶段填充)===
32// 已落地:shared(错误体系 + 跨域 DTO)/ core(http/retry/store/client 骨架)/ auth(types 前置)。
33// 待加入:auth 全量(P2) / models(+adapters)(P3) / chat+SSE(P4) / billing/skills/
34// notifications/agent_runs(P5) / compliance/support(P6) / 商品化(P7) / sanitize(P8)。
35pub mod agent_runs;
36pub mod auth;
37pub mod billing;
38pub mod casehall;
39pub mod chatbridge;
40pub mod compliance;
41pub mod core;
42pub mod enterprise;
43pub mod finance;
44pub mod models;
45pub mod notifications;
46pub mod pricing;
47pub mod products;
48/// Provider 无关的历史消息清洗子包(feature `sanitize`,默认开;对齐 npm 子路径 `./sanitize`,
49/// index.ts `export * as sanitize`)。经 [`core::sanitize_bridge`] 与 `Client` 接通。
50#[cfg(feature = "sanitize")]
51pub mod sanitize;
52pub mod shared;
53pub mod skills;
54pub mod subscription;
55pub mod support;
56
57// 逐域 re-export(对齐 index.ts 单一真源)。方法名 snake_case,类型名 PascalCase 保留跨语言锚点。
58pub use crate::auth::{
59    all_scopes, chat_bridge_scopes, code_challenge, commerce_scopes,
60    create_web_authorization_request, generate_code_verifier, generate_state,
61    is_invalid_grant_error, is_ssl_error, is_valid_token_set, model_scopes, new_token_set,
62    remote_control_scopes, resolve_success_redirect, skill_scopes, token_set_is_expired,
63    AuthorizeResult, ClientRegistration, CreateWebAuthorizationRequestOptions, LoginEvent,
64    LoginOptions, OAuthTokenEndpointError, RegisterWebOAuthClientOptions, ServerMetadata,
65    TokenResponse, TokenSet, WebAuthorizationCallbackParams, WebAuthorizationPending,
66    WebAuthorizationRequest,
67};
68pub use crate::core::{
69    read_gateway_request_id, AuthorityResult, AuthorityState, ChatOptions, ChatUsageEvent, Client,
70    Config, FileTokenStore, FilterStatus, GatewayRequestIDCallback, HttpBody, HttpClient,
71    HttpContext, HttpPurpose, HttpRequest, HttpResponse, HttpResponseMode, HttpTransport,
72    InMemoryTokenStore, StrictTokenAuthority, TokenAuthorityError, TokenStore, TransportError,
73    UpstreamActivityCallback, DEFAULT_GATEWAY_BASE_URL, GATEWAY_REQUEST_ID_HEADER,
74};
75// === models 域逐项 re-export(对齐 models/index.ts)===
76pub use crate::models::{
77    anthropic_response_text_content, anthropic_response_thinking_content,
78    anthropic_response_tool_use_blocks, bucket_info_is_commercial, bucket_row_is_commercial,
79    build_betas, classify_sources_event, extract_anthropic_block_meta,
80    find_desktop_visual_understanding_model, find_first_model_by_input_modality, get_adapter,
81    get_adapter_for_model, is_sse_comment_line, model_supports_image_input,
82    model_supports_input_modality, new_openai_stream_converter, new_thinking_config,
83    new_web_search_tool, parse_settlement, parse_sources_event, unique_merge, validate_end_user_id,
84    zero_model_capabilities, Adapter, AnthropicContentBlock, AnthropicResponse, AnthropicUsage,
85    BlockMeta, BucketInfo, BucketRow, ChatContentBlock, ChatMessage, ChatRequest, ChatResponse,
86    ChatUsage, EffortConfig, EmbeddingData, EmbeddingInput, EmbeddingRequest, EmbeddingResponse,
87    EmbeddingUsage, GeoLoc, ImageGenerationRequest, ImageGenerationResponse, InputModality,
88    ManagedModel, ModelCapabilities, MultimodalContent, OpenAIChatChoice, OpenAIChatMessage,
89    OpenAIChatResponse, OpenAIFunctionCall, OpenAIStreamChoice, OpenAIStreamChunk,
90    OpenAIStreamConverter, OpenAIStreamDelta, OpenAIStreamToolCall, OpenAIStreamUsage,
91    OpenAIStreamUsageCompletionDetails, OpenAIStreamUsagePromptDetails, OpenAIToolCall,
92    OpenAIUsage, OutputConfig, ProviderFormat, QuotaSummary, QuotaSummaryFreePool,
93    QuotaSummarySubscriptionPool, RerankDocument, RerankQuery, RerankRequest, RerankResponse,
94    RerankResult, ServerTool, SourcesEvent, SourcesEventIssueCode, SourcesEventParseResult,
95    StreamEvent, StreamSettlement, ThinkingConfig, VideoGenerationRequest, VideoTaskResponse,
96    WebSearchConfig, WebSearchSource, WindowLimitStatus, CREDIT_UNIT_COST_CNY,
97    CREDIT_UNIT_OFFICIAL_CNY, MAX_END_USER_ID_LENGTH, QUOTA_UNIT_MICRO_CREDIT,
98    SERVER_TOOL_TYPE_WEB_SEARCH, THINKING_HIGH, THINKING_MAX, THINKING_OFF,
99};
100// === billing 域逐项 re-export(对齐 billing/index.ts)===
101pub use crate::billing::{
102    BalanceDetail, BalanceDetailEntitlement, BuyResponse, ConsumeRecord, ConsumeRecordPage,
103    EntitlementBalance, EntitlementItem, ModelBucket, ModelByQuotaResponse, ModelCoefficient,
104    Order, OrderListItem, OrderStatus, PayPayload, PaymentMethod, TokenPackage, Transaction,
105    WalletStats,
106};
107// === skills 域逐项 re-export(对齐 skills/index.ts)===
108pub use crate::skills::{
109    CertificationStatus, GenerateSkillRequest, GenerateSkillResult, OptimizeSkillRequest,
110    OptimizeSkillResult, SkillBrowseListResponse, SkillBrowseResponse, SkillDownload,
111    SkillStoreItem, SkillStoreListItem, SkillStoreQuery, SkillSummary, ToolListResponse,
112    ToolProvider, ToolView,
113};
114// === notifications 域逐项 re-export(对齐 notifications/index.ts)===
115pub use crate::notifications::{
116    parse_notification_event, DeviceRegistration, Notification, NotificationList,
117    NotificationPreference, NotificationUnreadCount, WSEvent,
118};
119// === agent-runs 域逐项 re-export(对齐 agent-runs/index.ts)===
120pub use crate::agent_runs::{
121    is_terminal_remote_event, parse_remote_control_event, AdapterKind, AgentRun, AgentRunArtifact,
122    AgentRunArtifactPolicy, AgentRunCreateRequest, AgentRunCreateResponse, AgentRunDownload,
123    AgentRunErrorPayload, AgentRunListOptions, AgentRunListResult, AgentRunLocalContextPolicy,
124    AgentRunLocalToolResult, AgentRunRunOptions, AgentRunSettlement, AgentRunStatus,
125    AgentRunStreamEvent, AgentRunStreamOptions, AgentRunUsage, AgentRunWithLocalToolsOptions,
126    AgentRunsClient, ByokCreateRequest, ByokCredential, CrabCodeByokClient, LocalToolContext,
127    PermissionPolicy, RemoteControlEvent, RemotePermissionResultRequest, RemoteSessionTokenGrant,
128    RemoteUserMessageAck, RemoteUserMessageRequest, RunnerKind, WorkspacePolicy,
129};
130// === compliance 域逐项 re-export(对齐 compliance/index.ts)===
131pub use crate::compliance::{
132    classify_compliance_error, compliance_scopes, is_billing_confirmable,
133    is_compliance_business_error, is_compliance_terminal_error, ApproveSealApprovalQuery,
134    CancelSealApprovalQuery, ComplianceBillingDisplayStatus, ComplianceCapability,
135    ComplianceClient, ComplianceEnvelopeStatus, ComplianceErrorInfo, ComplianceErrorKey,
136    CompliancePollError, CompliancePollErrorKind, CompliancePollOptions,
137    ComplianceProviderRequestStatus, ComplianceProviderStatus, ComplianceReport,
138    ComplianceSealApprovalStatus, ComplianceWriteOptions, ContractTemplateField,
139    ContractTemplateFieldType, ContractTemplatePageItem, ContractTemplateResp,
140    ContractTemplateStatus, ContractTemplateVersion, CreateContractTemplateRequest,
141    CreateEvidenceAssetRequest, CreateH5SigningUrlRequest, CreateReportRequest,
142    CreateSigningEnvelopeRequest, EnvelopeContractItem, EvidenceAsset, EvidenceAssetPageItem,
143    EvidencePackage, EvidencePackagePageItem, IssueTimestampRequest, ListContractTemplatesRequest,
144    ListEvidenceAssetsRequest, ListEvidencePackagesRequest, ListOperationsRequest,
145    ListReportsRequest, ListSealApprovalsRequest, ListSealUsesRequest, ListSigningEnvelopesRequest,
146    ListTimestampsRequest, OperationBase, OperationDetail, OperationPageItem,
147    ProviderRequestStatusView, PublicEvidenceVerifyResult, RejectSealApprovalQuery, ReportDownload,
148    ReportPageItem, SealApproval, SealApprovalPageItem, SealUsePageItem, SignEnvelopeRequest,
149    SigningEnvelope, SigningEnvelopePageItem, SubmitSealApprovalRequest, TimestampPageItem,
150    TimestampToken, TimestampVerifyResult, TsaProvider, TsaStats, UpdateContractTemplateRequest,
151    UploadContractTemplatePdfRequest, VerifyTimestampRequest, VoidEnvelopeRequest,
152};
153// === support 域逐项 re-export(对齐 support/index.ts)===
154pub use crate::support::{BugReportResult, BugView};
155// === subscription 域逐项 re-export(对齐 subscription/index.ts)===
156pub use crate::subscription::{
157    Membership, RolloverPolicy, SubscriptionAudience, SubscriptionPlan, SubscriptionPrecheckResult,
158    SubscriptionTier, UserSubscription,
159};
160// === pricing 域逐项 re-export(对齐 pricing/index.ts)===
161pub use crate::pricing::{
162    ComplianceBenefitType, ComplianceQuoteResponse, ComplianceSku, PricingConfig,
163    PublicModelSummary,
164};
165// === products 域逐项 re-export(对齐 products/index.ts)===
166pub use crate::products::{Audience, BillingMode, Product, ProductFamily, RegionScope};
167// === casehall 域逐项 re-export(对齐 casehall/index.ts)===
168pub use crate::casehall::{
169    BookConsultationRequest, BookConsultationResult, CaseLead, CaseLeadIdResult, CaseMatter,
170    LawyerCredentialMyView, LawyerSummary, LegalBenefitType, LegalConsultation, LegalServiceOrder,
171    LegalServiceSku, LegalSkuCode, ListLawyersParams, SubmitCaseLeadRequest,
172};
173// === enterprise 域逐项 re-export(对齐 enterprise/index.ts)===
174pub use crate::enterprise::{
175    AssignSeatRequest, EnterpriseKycMyStatusView, EnterpriseMember, EnterpriseSummary,
176    InviteMemberRequest, MemberRole, OrgConsumeReport, OrgSeat, OrgSubscription,
177};
178// === finance 域逐项 re-export(对齐 finance/index.ts;所有 *Fen = i64 整数分 §3)===
179pub use crate::finance::{
180    CorporateTransfer, InitiateCorporateTransferInput, InitiateCorporateTransferResult, Invoice,
181    InvoiceType, RefundPolicy, RefundProductFamily, RefundRecord, RequestInvoiceInput,
182    RequestRefundInput,
183};
184// === chatbridge 域逐项 re-export(对齐 chatbridge/index.ts;secret 零导出 §安全红线)===
185pub use crate::chatbridge::{
186    as_credential_ref, is_channel_inbound_event, is_integration_status, is_platform, is_region,
187    BridgeThreadRef, ChannelAttachment, ChannelCard, ChannelCardAction, ChannelInboundEvent,
188    ChannelOutboundEvent, ChatBridgeClient, ChatBridgeSession, ChatCredentialPublic,
189    ChatIntegration, ChatThread, CreateIntegrationRequest, CredentialRef, IntegrationStatus,
190    Platform, Region, StoreCredentialRequest, ALL_INTEGRATION_STATUS, ALL_PLATFORMS, ALL_REGIONS,
191};
192pub use shared::{Error, Result};
193
194pub use crate::auth::auth::{
195    complete_web_authorization_request_with_transport, discover_web_oauth_metadata_with_transport,
196    discover_with_profile_with_transport, exchange_code_with_expiry_with_transport,
197    exchange_code_with_transport, refresh_token_with_transport,
198    register_web_oauth_client_with_transport, register_with_transport, revoke_token_with_transport,
199};
200
201pub use crate::auth::auth::discover_with_transport;
202
203#[cfg(feature = "native-http")]
204pub use crate::auth::auth::{
205    complete_web_authorization_request, discover, discover_web_oauth_metadata,
206    discover_with_profile, exchange_code, exchange_code_with_expiry, refresh_token, register,
207    register_web_oauth_client, revoke_token,
208};
209#[cfg(feature = "notifications-ws")]
210pub use crate::notifications::WSConfig;
211#[cfg(test)]
212mod scaffold_tests {
213    use super::*;
214
215    #[test]
216    fn version_is_wired() {
217        assert_eq!(VERSION, "6.0.0");
218    }
219}