api2key-base-sdk 0.1.5 → 0.1.7

package/README.md

@@ -16,7 +16,8 @@
 6. `orders`
 7. `payment`
 8. `ai`
-9. `admin`
+9. `speech`
+10. `admin`
 
 安装原则：
 
@@ -36,7 +37,8 @@
 6. `orders`
 7. `payment`
 8. `ai`
-9. `admin`
+9. `speech`
+10. `admin`
 
 ### 1. `auth`
 
@@ -76,9 +78,18 @@
 
 负责用户级设置的读取与更新。
 
-### 5. `projects / orders / payment / ai`
+### 5. `projects / orders / payment / ai / speech`
 
-负责项目商品、会员、订单、支付、AI 等运行时能力。
+负责项目商品、会员、订单、支付、AI 以及语音运行时能力。
+
+其中 `speech` 对齐当前 `api2key-base-api` 的内置语音接口：
+
+1. `listVoices(...)`
+2. `synthesize(...)`
+3. `transcribe(...)`
+4. `transcribeSrt(...)`
+5. `getAsrTask(...)`
+6. `downloadAudio(...)`
 
 ### 6. `admin`
 
@@ -132,6 +143,7 @@ await baseClient.auth.resetPassword({
 const projectClient = createProjectPlatformClient({
   baseUrl: process.env.API2KEY_BASE_URL!,
   getAccessToken: () => process.env.ACCESS_TOKEN,
+  getApiKey: () => process.env.API_KEY,
   getProjectId: () => process.env.PROJECT_ID,
 });
 
@@ -141,9 +153,185 @@ const adminClient = createAdminPlatformClient({
 });
 
 const products = await projectClient.projects.getCatalogProducts(process.env.PROJECT_ID!);
+const voices = await projectClient.speech.listVoices({
+  provider: 'azure',
+  locale: 'zh-CN',
+});
 const projects = await adminClient.admin.listProjects();
 ```
 
+说明：
+
+1. SDK 仍然接收单一 `baseUrl`
+2. `/api/v1/*` 接口继续基于 `baseUrl` 访问
+3. `speech` 客户端会自动基于同一域名访问根路径下的 `/api/*` 语音接口，无需额外配置第二个 URL
+
+## Speech 示例
+
+推荐在项目级客户端上使用：
+
+```ts
+import { createProjectPlatformClient } from 'api2key-base-sdk';
+
+const client = createProjectPlatformClient({
+  baseUrl: process.env.API2KEY_BASE_URL!,
+  getAccessToken: () => process.env.ACCESS_TOKEN,
+  getApiKey: () => process.env.API_KEY,
+  getProjectId: () => process.env.PROJECT_ID,
+});
+```
+
+### 1. 获取声音列表
+
+```ts
+const voices = await client.speech.listVoices({
+  provider: 'azure',
+  locale: 'zh-CN',
+});
+
+console.log(voices.provider);
+console.log(voices.total);
+console.log(voices.voices[0]?.shortName);
+```
+
+### 2. 文本转音频
+
+```ts
+const synthesized = await client.speech.synthesize({
+  provider: 'azure',
+  text: '你好，欢迎使用 api2key speech client。',
+  locale: 'zh-CN',
+  voice: 'zh-CN-XiaoxiaoNeural',
+  format: 'audio-24khz-96kbitrate-mono-mp3',
+  rate: 1,
+  volume: 100,
+  pitch: 0,
+});
+
+console.log(synthesized.contentType);
+console.log(synthesized.creditsCharged);
+console.log(synthesized.storageKey);
+console.log(synthesized.downloadUrl);
+console.log(synthesized.audio.byteLength);
+```
+
+如果你要把返回音频写入文件，在 Node.js 中可以这样处理：
+
+```ts
+import { writeFile } from 'node:fs/promises';
+
+await writeFile('speech.mp3', Buffer.from(synthesized.audio));
+```
+
+### 3. 简洁音频转文本
+
+```ts
+import { readFile } from 'node:fs/promises';
+
+const audioBytes = await readFile('./sample.mp3');
+const audioBlob = new Blob([audioBytes], { type: 'audio/mpeg' });
+
+const transcript = await client.speech.transcribe({
+  provider: 'groq',
+  file: audioBlob,
+  fileName: 'sample.mp3',
+});
+
+console.log(transcript.language);
+console.log(transcript.full_text);
+console.log(transcript.segments.length);
+```
+
+也可以直接传远程地址：
+
+```ts
+const transcript = await client.speech.transcribe({
+  provider: 'groq',
+  audioUrl: 'https://example.com/sample.mp3',
+});
+```
+
+### 4. 音频转 SRT
+
+同步模式：
+
+```ts
+const srtResult = await client.speech.transcribeSrt({
+  provider: 'tencent',
+  file: audioBlob,
+  fileName: 'sample.mp3',
+  async: false,
+});
+
+if ('srt' in srtResult) {
+  console.log(srtResult.text);
+  console.log(srtResult.srt);
+}
+```
+
+异步模式：
+
+```ts
+const submitted = await client.speech.transcribeSrt({
+  provider: 'tencent',
+  file: audioBlob,
+  fileName: 'sample.mp3',
+  async: true,
+});
+
+if ('taskId' in submitted && !('srt' in submitted)) {
+  console.log(submitted.taskId);
+  console.log(submitted.statusStr);
+}
+```
+
+### 5. 查询异步字幕任务
+
+```ts
+const task = await client.speech.getAsrTask({
+  provider: 'tencent',
+  taskId: 123456,
+});
+
+console.log(task.status);
+console.log(task.statusStr);
+console.log(task.retryAfterSeconds);
+console.log(task.srt);
+```
+
+### 6. 通过存储 key 下载合成音频
+
+```ts
+const downloaded = await client.speech.downloadAudio({
+  key: synthesized.storageKey!,
+});
+
+console.log(downloaded.contentType);
+console.log(downloaded.fileName);
+console.log(downloaded.audio.byteLength);
+```
+
+### 7. 鉴权建议
+
+推荐方式：
+
+1. 服务端项目调用时，通过 `getApiKey()` 提供 `sk-...`
+2. 用户登录态场景，通过 `getAccessToken()` 提供 JWT
+3. 大多数项目建议同时提供 `getProjectId()`，保持语音接口和项目上下文一致
+
+### 8. 路径说明
+
+你只需要传一个 `baseUrl`，例如：
+
+```ts
+baseUrl: 'https://open.api2key.com/api/v1'
+```
+
+SDK 会自动处理：
+
+1. 普通平台接口继续访问 `/api/v1/*`
+2. speech client 自动访问同域名下的 `/api/*`
+
 ## 设计原则
 
 1. 新项目默认只依赖这个包

package/dist/admin/client.d.ts

@@ -50,7 +50,7 @@ export declare class AdminClient {
         }>;
     }>;
     createMembership(input: {
-        scopeType: 'project' | 'global';
+        scopeType: 'project' | 'account';
         userId?: string;
         email?: string;
         projectId?: string;
@@ -63,11 +63,11 @@ export declare class AdminClient {
         autoRenew?: boolean;
     }, accessToken?: string): Promise<{
         membershipId: string;
-        scopeType: 'project' | 'global';
+        scopeType: 'project' | 'account';
     }>;
     updateMembership(input: {
         id: string;
-        scopeType: 'project' | 'global';
+        scopeType: 'project' | 'account';
         projectId?: string;
         role?: string;
         tier?: string;
@@ -79,7 +79,7 @@ export declare class AdminClient {
     }, accessToken?: string): Promise<{
         id: string;
     }>;
-    deleteMembership(id: string, scopeType: 'project' | 'global', accessToken?: string): Promise<null>;
+    deleteMembership(id: string, scopeType: 'project' | 'account', accessToken?: string): Promise<null>;
     listUsers(filters?: {
         search?: string;
         projectId?: string;

package/dist/auth/client.d.ts

@@ -1,8 +1,9 @@
 import { PlatformHttpClient } from '../core/client';
-import type { AuthChangePasswordInput, AuthPasswordResetDispatchResult, AuthRegisterResult, AuthSession, AuthUser, AuthVerifyEmailInput, AuthResetPasswordInput } from '../core/types';
+import type { AuthChangePasswordInput, AuthMeResponse, AuthPasswordResetDispatchResult, AuthRegisterResult, AuthSession, AuthVerifyEmailInput, AuthResetPasswordInput } from '../core/types';
 export declare class AuthClient {
     private readonly http;
     constructor(http: PlatformHttpClient);
+    private normalizeAuthOptions;
     login(input: {
         email: string;
         password: string;
@@ -22,10 +23,10 @@ export declare class AuthClient {
         email: string;
     }): Promise<AuthPasswordResetDispatchResult | null>;
     resetPassword(input: AuthResetPasswordInput): Promise<null>;
-    me(accessToken?: string): Promise<{
-        user: AuthUser;
-        membership?: unknown;
-    }>;
+    me(options?: string | {
+        accessToken?: string;
+        projectId?: string;
+    }): Promise<AuthMeResponse>;
     logout(accessToken?: string): Promise<null>;
     sendChangePasswordCode(accessToken?: string): Promise<AuthPasswordResetDispatchResult>;
     changePassword(input: AuthChangePasswordInput, accessToken?: string): Promise<null>;

package/dist/auth/client.js

@@ -2,6 +2,11 @@ export class AuthClient {
     constructor(http) {
         this.http = http;
     }
+    normalizeAuthOptions(options) {
+        return typeof options === 'string'
+            ? { accessToken: options, projectId: undefined }
+            : (options ?? {});
+    }
     login(input) {
         return this.http.request('/api/v1/auth/login', {
             method: 'POST',
@@ -38,9 +43,14 @@ export class AuthClient {
             body: input,
         });
     }
-    me(accessToken) {
+    me(options) {
+        const normalizedOptions = this.normalizeAuthOptions(options);
         return this.http.request('/api/v1/auth/me', {
-            accessToken,
+            accessToken: normalizedOptions.accessToken,
+            projectId: normalizedOptions.projectId,
+            query: {
+                projectId: normalizedOptions.projectId,
+            },
         });
     }
     logout(accessToken) {

package/dist/core/client.d.ts

@@ -4,6 +4,8 @@ export declare class PlatformHttpClient {
     private readonly fetchImpl;
     private readonly options;
     constructor(options: PlatformClientOptions);
+    private resolveBaseUrl;
+    private buildUrl;
     private send;
     request<T>(path: string, requestOptions?: PlatformRequestOptions): Promise<T>;
     requestRaw(path: string, requestOptions?: PlatformRequestOptions): Promise<Response>;

package/dist/core/client.js

@@ -18,9 +18,29 @@ export class PlatformHttpClient {
         const fetchImpl = options.fetchImpl ?? fetch;
         this.fetchImpl = fetchImpl.bind(globalThis);
     }
+    resolveBaseUrl(mode = 'default') {
+        if (mode === 'origin') {
+            return new URL(this.baseUrl).origin;
+        }
+        return this.baseUrl;
+    }
+    buildUrl(path, requestOptions) {
+        if (/^https?:\/\//.test(path)) {
+            return `${path}${buildQueryString(requestOptions.query)}`;
+        }
+        return `${this.resolveBaseUrl(requestOptions.baseUrlMode)}${path}${buildQueryString(requestOptions.query)}`;
+    }
     async send(path, requestOptions = {}) {
         const headers = new Headers(this.options.defaultHeaders);
-        headers.set('Content-Type', 'application/json');
+        if (requestOptions.contentType === null) {
+            headers.delete('Content-Type');
+        }
+        else if (requestOptions.contentType) {
+            headers.set('Content-Type', requestOptions.contentType);
+        }
+        else if (requestOptions.rawBody === undefined) {
+            headers.set('Content-Type', 'application/json');
+        }
         if (requestOptions.headers) {
             for (const [key, value] of Object.entries(requestOptions.headers)) {
                 headers.set(key, value);
@@ -30,6 +50,10 @@ export class PlatformHttpClient {
         if (accessToken) {
             headers.set('Authorization', `Bearer ${accessToken}`);
         }
+        const apiKey = requestOptions.apiKey ?? (await this.options.getApiKey?.());
+        if (apiKey) {
+            headers.set('x-api-key', apiKey);
+        }
         const projectId = requestOptions.projectId ?? (await this.options.getProjectId?.());
         if (projectId) {
             headers.set('X-Project-Id', projectId);
@@ -41,13 +65,13 @@ export class PlatformHttpClient {
             }
             headers.set('X-Service-Secret', serviceSecret);
         }
-        const url = `${this.baseUrl}${path}${buildQueryString(requestOptions.query)}`;
+        const url = this.buildUrl(path, requestOptions);
         let response;
         try {
             response = await this.fetchImpl(url, {
                 method: requestOptions.method ?? 'GET',
                 headers,
-                body: requestOptions.body == null ? undefined : JSON.stringify(requestOptions.body),
+                body: requestOptions.rawBody ?? (requestOptions.body == null ? undefined : JSON.stringify(requestOptions.body)),
             });
         }
         catch (error) {

package/dist/core/types.d.ts

@@ -9,17 +9,22 @@ export interface PlatformClientOptions {
     fetchImpl?: typeof fetch;
     defaultHeaders?: Record<string, string>;
     getAccessToken?: () => MaybePromise<string | undefined>;
+    getApiKey?: () => MaybePromise<string | undefined>;
     getServiceSecret?: () => MaybePromise<string | undefined>;
     getProjectId?: () => MaybePromise<string | undefined>;
 }
 export interface PlatformRequestOptions {
     method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
     body?: unknown;
+    rawBody?: BodyInit;
     query?: Record<string, string | number | boolean | undefined | null>;
     headers?: Record<string, string>;
+    contentType?: string | null;
     accessToken?: string;
+    apiKey?: string;
     projectId?: string;
     useServiceSecret?: boolean;
+    baseUrlMode?: 'default' | 'origin';
 }
 export interface AuthUser {
     id: string;
@@ -29,12 +34,14 @@ export interface AuthUser {
     role: 'user' | 'admin' | 'super_admin';
     emailVerified?: boolean;
     emailVerifiedAt?: number | null;
+    credits?: number;
     creditsBalance?: number;
     projectId?: string | null;
     projectName?: string | null;
     projectSlug?: string | null;
     membership?: {
         tier: string;
+        status?: string;
         power?: number;
         endDate?: number | null;
     } | null;
@@ -58,6 +65,17 @@ export interface AuthSession {
     refreshToken?: string;
     expiresIn?: number;
 }
+export interface ProjectScope {
+    type: 'account' | 'project';
+    projectId?: string | null;
+    projectName?: string | null;
+    projectSlug?: string | null;
+}
+export interface AuthMeResponse {
+    user: AuthUser;
+    membership?: unknown;
+    scope?: ProjectScope;
+}
 export interface AuthRegistrationPending {
     requiresEmailVerification: true;
     email: string;
@@ -124,11 +142,26 @@ export interface MembershipView {
     is_active?: boolean;
     days_remaining?: number;
 }
+export interface CreditsAccountSummary {
+    balance: number;
+    reserved: number;
+    totalEarned: number;
+    totalSpent: number;
+}
+export interface CreditsBalanceScope {
+    type: ProjectScope['type'];
+    projectId?: ProjectScope['projectId'];
+    projectName?: ProjectScope['projectName'];
+    projectSlug?: ProjectScope['projectSlug'];
+}
 export interface CreditsBalance {
     balance: number;
-    reserved?: number;
-    total_earned?: number;
-    total_spent?: number;
+    reserved: number;
+    total_earned: number;
+    total_spent: number;
+    account: CreditsAccountSummary;
+    scope: CreditsBalanceScope;
+    user: AuthUser;
 }
 export interface CreditsLedgerItem {
     id: string;
@@ -219,6 +252,174 @@ export interface AiModelSummary {
     outputPricing?: number;
     locked?: boolean;
 }
+export type SpeechTtsProvider = 'azure' | 'tencent';
+export type SpeechAsrProvider = 'tencent' | 'groq' | 'bcut';
+export interface SpeechVoice {
+    provider: SpeechTtsProvider;
+    shortName: string;
+    displayName: string;
+    localName: string;
+    locale: string;
+    localeName: string;
+    gender: string;
+    voiceType?: string;
+    styles: string[];
+    roles: string[];
+    sampleRateHertz?: string;
+    sampleRates?: string[];
+    status?: string;
+    wordsPerMinute?: string;
+    secondaryLocales: string[];
+    recommendedScene?: string;
+    supportedLanguages?: string[];
+    emotions?: string[];
+}
+export interface SpeechAccessUser {
+    id: string;
+    email: string;
+    role: string;
+}
+export interface SpeechAccessProject {
+    id: string;
+    name: string;
+    slug: string;
+}
+export interface SpeechAccessMembership {
+    tier: string;
+    status: string;
+    end_date: number | null;
+    is_active: boolean;
+}
+export interface SpeechVoiceListResult {
+    provider: SpeechTtsProvider;
+    user: SpeechAccessUser;
+    project: SpeechAccessProject;
+    membership: SpeechAccessMembership;
+    total: number;
+    voices: SpeechVoice[];
+}
+export interface SpeechSynthesisRequest {
+    provider?: SpeechTtsProvider;
+    text: string;
+    voice?: string;
+    locale?: string;
+    rate?: number;
+    volume?: number;
+    pitch?: number;
+    style?: string;
+    styleDegree?: number;
+    role?: string;
+    emotionCategory?: string;
+    emotionIntensity?: number;
+    format?: string;
+}
+export interface SpeechSynthesisResult {
+    audio: ArrayBuffer;
+    contentType: string;
+    fileName: string | null;
+    provider: string | null;
+    voice: string | null;
+    locale: string | null;
+    format: string | null;
+    creditsCharged: number | null;
+    storageKey: string | null;
+    downloadUrl: string | null;
+    projectId: string | null;
+    providerRequestId: string | null;
+    headers: Headers;
+}
+export interface SpeechSimpleTranscriptSegment {
+    start: number;
+    end: number;
+    text: string;
+}
+export interface SpeechTranscribeResult {
+    language: string;
+    full_text: string;
+    segments: SpeechSimpleTranscriptSegment[];
+    srt: string;
+}
+export interface SpeechAsrSegment {
+    id: number;
+    startMs: number;
+    endMs: number;
+    startTimecode: string;
+    endTimecode: string;
+    text: string;
+    speakerId?: number;
+    emotionTypes?: string[];
+}
+export interface SpeechAsrSrtResult {
+    user: SpeechAccessUser;
+    project: SpeechAccessProject;
+    membership: SpeechAccessMembership;
+    provider: SpeechAsrProvider;
+    format: 'srt';
+    engineModelType: string;
+    taskId: number | null;
+    requestId?: string | null;
+    language: string;
+    durationMs: number;
+    sourceType: 'file' | 'url';
+    sourceName?: string | null;
+    sourceSize?: number | null;
+    text: string;
+    srt: string;
+    segments: SpeechAsrSegment[];
+}
+export interface SpeechAsrTaskSubmission {
+    user: SpeechAccessUser;
+    project: SpeechAccessProject;
+    membership: SpeechAccessMembership;
+    provider: SpeechAsrProvider;
+    taskId: number;
+    requestId?: string | null;
+    engineModelType: string;
+    status: number;
+    statusStr: string;
+    sourceType: 'file' | 'url';
+    sourceName?: string | null;
+    sourceSize?: number | null;
+}
+export interface SpeechAsrTaskResult {
+    user: SpeechAccessUser;
+    project: SpeechAccessProject;
+    membership: SpeechAccessMembership;
+    provider: SpeechAsrProvider;
+    format: 'srt';
+    taskId: number;
+    requestId?: string | null;
+    status: number;
+    statusStr: string;
+    retryAfterSeconds?: number | null;
+    durationMs: number;
+    language: string;
+    audioDurationSeconds?: number | null;
+    errorMessage?: string | null;
+    text: string;
+    srt: string;
+    segments: SpeechAsrSegment[];
+}
+export interface SpeechAsrRequestInput {
+    provider?: SpeechAsrProvider;
+    audioUrl?: string;
+    file?: Blob;
+    fileName?: string;
+    async?: boolean;
+    language?: string;
+    prompt?: string;
+    temperature?: number;
+    engineModelType?: string;
+    channelNum?: number;
+    speakerDiarization?: number;
+    speakerNumber?: number;
+    sentenceMaxLength?: number;
+    emotionRecognition?: number;
+    filterDirty?: number;
+    filterModal?: number;
+    filterPunc?: number;
+    convertNumMode?: number;
+}
 export interface AdminProject {
     id: string;
     name: string;
@@ -251,7 +452,7 @@ export interface AdminProduct {
 }
 export interface AdminMembershipRecord {
     id: string;
-    scopeType: 'project' | 'global';
+    scopeType: 'project' | 'account';
     role: string;
     tier: string;
     status: string;
@@ -276,7 +477,7 @@ export interface AdminMembershipRecord {
     } | null;
 }
 export interface AdminMembershipFilters {
-    scope?: 'project' | 'global';
+    scope?: 'project' | 'account';
     projectId?: string;
     status?: string;
     tier?: string;
@@ -295,7 +496,7 @@ export interface AdminUserRecord {
         name: string;
         slug: string;
     } | null;
-    globalMembership: {
+    accountMembership: {
         id: string;
         tier: string | null;
         status: string | null;
@@ -375,7 +576,26 @@ export interface AdminUserCreditsSummary {
         total_earned: number;
         total_spent: number;
     };
-    recentLedger: CreditsLedgerItem[];
+    projectAccounts?: Array<{
+        id: string;
+        projectId: string;
+        projectName?: string | null;
+        projectSlug?: string | null;
+        role: string;
+        tier: string;
+        status: string;
+        credits: number;
+        startDate?: number | null;
+        endDate?: number | null;
+        autoRenew: boolean;
+    }>;
+    recentLedger: Array<CreditsLedgerItem & {
+        scopeType?: 'account' | 'project';
+        projectId?: string | null;
+        projectName?: string | null;
+        projectSlug?: string | null;
+        refId?: string | null;
+    }>;
 }
 export interface AdminModelRecord {
     id: string;

package/dist/credits/client.d.ts

@@ -1,9 +1,13 @@
 import { PlatformHttpClient } from '../core/client';
 import type { CreditsBalance, CreditsLedgerItem } from '../core/types';
+type GetBalanceOptions = {
+    accessToken?: string;
+    projectId?: string;
+};
 export declare class CreditsClient {
     private readonly http;
     constructor(http: PlatformHttpClient);
-    getBalance(accessToken?: string): Promise<CreditsBalance>;
+    getBalance(options?: string | GetBalanceOptions): Promise<CreditsBalance>;
     getLedger(input: {
         accessToken?: string;
         page?: number;
@@ -38,3 +42,4 @@ export declare class CreditsClient {
         ok: boolean;
     }>;
 }
+export {};

package/dist/credits/client.js

@@ -2,8 +2,17 @@ export class CreditsClient {
     constructor(http) {
         this.http = http;
     }
-    getBalance(accessToken) {
-        return this.http.request('/api/v1/credits/balance', { accessToken });
+    getBalance(options) {
+        const normalizedOptions = typeof options === 'string'
+            ? { accessToken: options }
+            : (options ?? {});
+        return this.http.request('/api/v1/credits/balance', {
+            accessToken: normalizedOptions.accessToken,
+            projectId: normalizedOptions.projectId,
+            query: {
+                projectId: normalizedOptions.projectId,
+            },
+        });
     }
     getLedger(input) {
         return this.http.request('/api/v1/credits/ledger', {

package/dist/index.d.ts

@@ -7,10 +7,11 @@ import { CreditsClient } from './credits/client';
 import { OrdersClient } from './orders/client';
 import { PaymentClient } from './payment/client';
 import { ProjectsClient } from './projects/client';
+import { SpeechClient } from './speech/client';
 import { UserApiKeysClient } from './user/api-keys-client';
 import { UserSettingsClient } from './user/settings-client';
 export * from './core/errors';
-export type { AdminConfigItem, AdminMembershipFilters, AdminMembershipRecord, AdminModelInput, AdminModelRecord, AdminOrderFilters, AdminOrderRecord, AdminProduct, AdminProductBackfillResult, AdminProductListResult, AdminProject, AdminProjectExportFormat, AdminUserCreditsSummary, AdminUserRecord, AiModelSummary, AuthChangePasswordInput, AuthPasswordResetDispatchResult, AuthRegisterResult, AuthRegistrationPending, AuthSession, AuthUser, AuthVerificationDispatchResult, AuthVerifyEmailInput, AuthResetPasswordInput, CreditsBalance, CreditsLedgerItem, MembershipView, OrderDetail, OrderSummary, PaymentCreateResponse, PaymentQueryResponse, PlatformClientOptions, PlatformEnvelope, PlatformRequestOptions, ProductSummary, ProjectSummary, UpdateAdminUserInput, UserApiKeyRecord, UserApiKeySecret, UserSettingDefinition, UserSettingsPayload, } from './core/types';
+export type { AdminConfigItem, AdminMembershipFilters, AdminMembershipRecord, AdminModelInput, AdminModelRecord, AdminOrderFilters, AdminOrderRecord, AdminProduct, AdminProductBackfillResult, AdminProductListResult, AdminProject, AdminProjectExportFormat, AdminUserCreditsSummary, AdminUserRecord, AiModelSummary, AuthChangePasswordInput, AuthMeResponse, AuthPasswordResetDispatchResult, AuthRegisterResult, AuthRegistrationPending, AuthSession, AuthUser, AuthVerificationDispatchResult, AuthVerifyEmailInput, CreditsAccountSummary, AuthResetPasswordInput, CreditsBalance, CreditsBalanceScope, CreditsLedgerItem, MembershipView, OrderDetail, OrderSummary, PaymentCreateResponse, PaymentQueryResponse, PlatformClientOptions, PlatformEnvelope, PlatformRequestOptions, ProjectScope, ProductSummary, ProjectSummary, SpeechAccessMembership, SpeechAccessProject, SpeechAccessUser, SpeechAsrProvider, SpeechAsrRequestInput, SpeechAsrSegment, SpeechAsrSrtResult, SpeechAsrTaskResult, SpeechAsrTaskSubmission, SpeechSimpleTranscriptSegment, SpeechSynthesisRequest, SpeechSynthesisResult, SpeechTranscribeResult, SpeechTtsProvider, SpeechVoice, SpeechVoiceListResult, UpdateAdminUserInput, UserApiKeyRecord, UserApiKeySecret, UserSettingDefinition, UserSettingsPayload, } from './core/types';
 export declare class BasePlatformClient {
     readonly http: PlatformHttpClient;
     readonly auth: AuthClient;
@@ -26,6 +27,7 @@ export declare class ProjectPlatformClient {
     readonly orders: OrdersClient;
     readonly payment: PaymentClient;
     readonly ai: AiClient;
+    readonly speech: SpeechClient;
     constructor(options: PlatformClientOptions);
 }
 export declare function createProjectPlatformClient(options: PlatformClientOptions): ProjectPlatformClient;

package/dist/index.js

@@ -6,6 +6,7 @@ import { CreditsClient } from './credits/client.js';
 import { OrdersClient } from './orders/client.js';
 import { PaymentClient } from './payment/client.js';
 import { ProjectsClient } from './projects/client.js';
+import { SpeechClient } from './speech/client.js';
 import { UserApiKeysClient } from './user/api-keys-client.js';
 import { UserSettingsClient } from './user/settings-client.js';
 export * from './core/errors.js';
@@ -28,6 +29,7 @@ export class ProjectPlatformClient {
         this.orders = new OrdersClient(this.http);
         this.payment = new PaymentClient(this.http);
         this.ai = new AiClient(this.http);
+        this.speech = new SpeechClient(this.http);
     }
 }
 export function createProjectPlatformClient(options) {

package/dist/speech/client.d.ts

@@ -0,0 +1,32 @@
+import { PlatformHttpClient } from '../core/client';
+import type { SpeechAsrRequestInput, SpeechAsrSrtResult, SpeechAsrTaskResult, SpeechAsrTaskSubmission, SpeechSynthesisRequest, SpeechSynthesisResult, SpeechTranscribeResult, SpeechVoiceListResult } from '../core/types';
+type SpeechRequestAuth = {
+    accessToken?: string;
+    apiKey?: string;
+    projectId?: string;
+};
+export declare class SpeechClient {
+    private readonly http;
+    constructor(http: PlatformHttpClient);
+    listVoices(input?: SpeechRequestAuth & {
+        provider?: 'azure' | 'tencent';
+        locale?: string;
+        search?: string;
+    }): Promise<SpeechVoiceListResult>;
+    synthesize(input: SpeechRequestAuth & SpeechSynthesisRequest): Promise<SpeechSynthesisResult>;
+    transcribe(input: SpeechRequestAuth & SpeechAsrRequestInput): Promise<SpeechTranscribeResult>;
+    transcribeSrt(input: SpeechRequestAuth & SpeechAsrRequestInput): Promise<SpeechAsrSrtResult | SpeechAsrTaskSubmission>;
+    getAsrTask(input: SpeechRequestAuth & {
+        taskId: number | string;
+        provider?: 'tencent' | 'groq' | 'bcut';
+    }): Promise<SpeechAsrTaskResult>;
+    downloadAudio(input: {
+        key: string;
+    }): Promise<{
+        audio: ArrayBuffer;
+        contentType: string;
+        fileName: string | null;
+        headers: Headers;
+    }>;
+}
+export {};

package/dist/speech/client.js

@@ -0,0 +1,169 @@
+import { PlatformApiError, PlatformTransportError } from '../core/errors.js';
+function parseContentDispositionFileName(value) {
+    if (!value) {
+        return null;
+    }
+    const utf8Match = value.match(/filename\*=UTF-8''([^;]+)/i);
+    if (utf8Match) {
+        try {
+            return decodeURIComponent(utf8Match[1]);
+        }
+        catch {
+            return utf8Match[1];
+        }
+    }
+    const plainMatch = value.match(/filename="?([^";]+)"?/i);
+    return plainMatch?.[1] ?? null;
+}
+async function throwPlatformError(response) {
+    let payload = null;
+    try {
+        payload = (await response.json());
+    }
+    catch {
+        const detail = await response.text().catch(() => '');
+        throw new PlatformTransportError(`Platform API returned a non-JSON error response for ${response.url}: ${detail}`);
+    }
+    throw new PlatformApiError(payload.message, response.status, payload.code, payload.data);
+}
+function buildAsrFormData(input) {
+    const formData = new FormData();
+    const scalarEntries = [
+        ['provider', input.provider],
+        ['audioUrl', input.audioUrl],
+        ['async', input.async],
+        ['language', input.language],
+        ['prompt', input.prompt],
+        ['temperature', input.temperature],
+        ['engineModelType', input.engineModelType],
+        ['channelNum', input.channelNum],
+        ['speakerDiarization', input.speakerDiarization],
+        ['speakerNumber', input.speakerNumber],
+        ['sentenceMaxLength', input.sentenceMaxLength],
+        ['emotionRecognition', input.emotionRecognition],
+        ['filterDirty', input.filterDirty],
+        ['filterModal', input.filterModal],
+        ['filterPunc', input.filterPunc],
+        ['convertNumMode', input.convertNumMode],
+    ];
+    for (const [key, value] of scalarEntries) {
+        if (value == null) {
+            continue;
+        }
+        formData.append(key, String(value));
+    }
+    if (input.file) {
+        formData.append('file', input.file, input.fileName ?? 'audio');
+    }
+    return formData;
+}
+export class SpeechClient {
+    constructor(http) {
+        this.http = http;
+    }
+    listVoices(input = {}) {
+        return this.http.request('/api/voices', {
+            accessToken: input.accessToken,
+            apiKey: input.apiKey,
+            baseUrlMode: 'origin',
+            query: {
+                projectId: input.projectId,
+                provider: input.provider,
+                locale: input.locale,
+                search: input.search,
+            },
+        });
+    }
+    async synthesize(input) {
+        const response = await this.http.requestRaw('/api/speech', {
+            method: 'POST',
+            accessToken: input.accessToken,
+            apiKey: input.apiKey,
+            baseUrlMode: 'origin',
+            query: { projectId: input.projectId },
+            body: {
+                provider: input.provider,
+                text: input.text,
+                voice: input.voice,
+                locale: input.locale,
+                rate: input.rate,
+                volume: input.volume,
+                pitch: input.pitch,
+                style: input.style,
+                styleDegree: input.styleDegree,
+                role: input.role,
+                emotionCategory: input.emotionCategory,
+                emotionIntensity: input.emotionIntensity,
+                format: input.format,
+            },
+        });
+        if (!response.ok) {
+            return throwPlatformError(response);
+        }
+        return {
+            audio: await response.arrayBuffer(),
+            contentType: response.headers.get('Content-Type') ?? 'application/octet-stream',
+            fileName: parseContentDispositionFileName(response.headers.get('Content-Disposition')),
+            provider: response.headers.get('X-TTS-Provider'),
+            voice: response.headers.get('X-TTS-Voice'),
+            locale: response.headers.get('X-TTS-Locale'),
+            format: response.headers.get('X-TTS-Format'),
+            creditsCharged: response.headers.get('X-TTS-Credits-Charged') == null
+                ? null
+                : Number(response.headers.get('X-TTS-Credits-Charged')),
+            storageKey: response.headers.get('X-TTS-Storage-Key'),
+            downloadUrl: response.headers.get('X-TTS-Download-Url'),
+            projectId: response.headers.get('X-TTS-Project-Id'),
+            providerRequestId: response.headers.get('X-TTS-Provider-Request-Id'),
+            headers: response.headers,
+        };
+    }
+    transcribe(input) {
+        return this.http.request('/api/asr/transcribe', {
+            method: 'POST',
+            accessToken: input.accessToken,
+            apiKey: input.apiKey,
+            baseUrlMode: 'origin',
+            query: { projectId: input.projectId },
+            rawBody: buildAsrFormData(input),
+            contentType: null,
+        });
+    }
+    transcribeSrt(input) {
+        return this.http.request('/api/asr/srt', {
+            method: 'POST',
+            accessToken: input.accessToken,
+            apiKey: input.apiKey,
+            baseUrlMode: 'origin',
+            query: { projectId: input.projectId },
+            rawBody: buildAsrFormData(input),
+            contentType: null,
+        });
+    }
+    getAsrTask(input) {
+        return this.http.request(`/api/asr/tasks/${input.taskId}`, {
+            accessToken: input.accessToken,
+            apiKey: input.apiKey,
+            baseUrlMode: 'origin',
+            query: {
+                projectId: input.projectId,
+                provider: input.provider,
+            },
+        });
+    }
+    async downloadAudio(input) {
+        const response = await this.http.requestRaw('/api/files/download', {
+            baseUrlMode: 'origin',
+            query: { key: input.key },
+        });
+        if (!response.ok) {
+            return throwPlatformError(response);
+        }
+        return {
+            audio: await response.arrayBuffer(),
+            contentType: response.headers.get('Content-Type') ?? 'application/octet-stream',
+            fileName: parseContentDispositionFileName(response.headers.get('Content-Disposition')),
+            headers: response.headers,
+        };
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api2key-base-sdk",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "TypeScript SDK for consuming the Api2Key API stable APIs",
   "license": "UNLICENSED",
   "type": "module",
@@ -45,4 +45,4 @@
   "devDependencies": {
     "typescript": "^5.3.3"
   }
-}
+}