api2key-base-sdk 0.1.2 → 0.1.4

package/README.md

@@ -1,44 +1,42 @@
 # api2key-base-sdk
 
-`api2key-base-sdk` 现在只承载稳定的基础平台能力，不再包含项目业务 API 或后台管理 API。
+`api2key-base-sdk` 是当前唯一保留的 SDK 入口，统一承载基础平台能力、项目运行时能力和后台管理客户端。
 
 适合放进所有新项目作为默认基础依赖。
 
 ## 当前边界
 
-基础能力仅包括：
+当前统一暴露：
 
 1. `auth`
 2. `credits`
 3. `apiKeys`
 4. `settings`
-
-不再包含：
-
-1. 项目商品与项目会员接口
-2. 订单与支付接口
-3. AI 业务接口
-4. 管理后台接口
-
-这些能力已拆分为独立包：
-
-1. `api2key-project-sdk`
-2. `api2key-admin-sdk`
+5. `projects`
+6. `orders`
+7. `payment`
+8. `ai`
+9. `admin`
 
 安装原则：
 
 1. 所有新项目默认只安装 `api2key-base-sdk`
-2. 只有需要业务扩展能力时才安装 `api2key-project-sdk`
-3. 只有需要开发管理后台时才安装 `api2key-admin-sdk`
+2. 后台项目也只安装 `api2key-base-sdk`
+3. 单项目私有逻辑优先留在本地 facade，而不是再拆新的 SDK 包
 
 ## 暴露的客户端
 
-当前 `api2key-base-sdk` 只暴露以下客户端：
+当前 `api2key-base-sdk` 暴露以下客户端：
 
 1. `auth`
 2. `credits`
 3. `apiKeys`
 4. `settings`
+5. `projects`
+6. `orders`
+7. `payment`
+8. `ai`
+9. `admin`
 
 ### 1. `auth`
 
@@ -53,12 +51,12 @@
 
 ### 2. `credits`
 
-负责稳定的积分账户与流水能力。
+负责稳定的积分账户与服务侧扣减能力。
 
 当前主要方法包括：
 
 1. `getBalance(accessToken?)`
-2. `getLedger(input)`
+2. `getLedger(input)`（仅管理员账号可查询当前账户积分消耗流水，普通用户前台不应依赖）
 3. `spend(input)`
 4. `reserve(input)`
 5. `confirm(id)`
@@ -72,6 +70,14 @@
 
 负责用户级设置的读取与更新。
 
+### 5. `projects / orders / payment / ai`
+
+负责项目商品、会员、订单、支付、AI 等运行时能力。
+
+### 6. `admin`
+
+负责项目管理、产品管理、用户管理、会员管理、模型管理、后台积分操作等控制面能力。
+
 ## 适合哪些项目
 
 适合：
@@ -80,13 +86,7 @@
 2. 只需要登录、积分、用户设置、API Key 的项目
 3. 需要一个长期稳定基础依赖的项目
 
-不适合单独承载：
-
-1. 商品目录
-2. 会员业务
-3. 订单与支付业务
-4. AI 业务策略
-5. 管理后台接口
+适合同一个 SDK 内统一暴露所有共享客户端，但不适合把某个单项目专属兼容逻辑强行塞进共享包。
 
 ## 安装
 
@@ -107,14 +107,27 @@ const baseClient = createBasePlatformClient({
 
 const me = await baseClient.auth.me();
 const credits = await baseClient.credits.getBalance();
-const settings = await baseClient.settings.get();
+
+const projectClient = createProjectPlatformClient({
+  baseUrl: process.env.API2KEY_BASE_URL!,
+  getAccessToken: () => process.env.ACCESS_TOKEN,
+  getProjectId: () => process.env.PROJECT_ID,
+});
+
+const adminClient = createAdminPlatformClient({
+  baseUrl: process.env.API2KEY_BASE_URL!,
+  getAccessToken: () => process.env.ADMIN_ACCESS_TOKEN,
+});
+
+const products = await projectClient.projects.getCatalogProducts(process.env.PROJECT_ID!);
+const projects = await adminClient.admin.listProjects();
 ```
 
 ## 设计原则
 
 1. 新项目默认只依赖这个包
-2. 业务扩展能力按需安装独立 SDK
-3. `api2key-base-api` 可以稳定演进而不被业务模块拖住
+2. 共享客户端统一收敛在一个包里
+3. `api2key-base-api` 可以继续保持清晰的路由分层，而不需要在消费侧安装多个 SDK
 
 ## Agent 约定
 
@@ -122,15 +135,16 @@ const settings = await baseClient.settings.get();
 
 规则：
 
-1. 如果需求属于认证、积分、用户设置、API Key，优先在这里找
-2. 不要把商品、会员、订单、支付、AI、后台管理方法加回这个包
-3. 如果新需求明显带有项目业务语义，应优先落到 `api2key-project-sdk`
-4. 如果新需求明显带有后台控制面语义，应优先落到 `api2key-admin-sdk`
+1. 如果需求属于共享客户端能力，优先在这里找
+2. 后端路由边界仍按 base/project/admin 区分，不要因为 SDK 合并而改乱 API 归属
+3. 如果新需求只服务单个项目，优先留在项目本地 facade
 
 ## 兼容说明
 
-当前仍保留 `createPlatformAClient` 作为过渡别名，但它现在只返回基础能力客户端。
+当前仍保留 `createPlatformAClient` 作为过渡别名，它返回基础能力客户端。
 
 建议新代码统一使用：
 
-- `createBasePlatformClient`
+- `createBasePlatformClient`
+- `createProjectPlatformClient`
+- `createAdminPlatformClient`

package/dist/admin/client.d.ts

@@ -1,5 +1,5 @@
 import type { PlatformHttpClient } from '../core/client';
-import type { AdminConfigItem, AdminMembershipFilters, AdminMembershipRecord, AdminOrderFilters, AdminOrderRecord, AdminProduct, AdminProject, AdminProjectExportFormat, AdminUserRecord } from '../core/types';
+import type { AdminConfigItem, AdminMembershipFilters, AdminMembershipRecord, AdminModelInput, AdminModelRecord, AdminOrderFilters, AdminOrderRecord, AdminProduct, AdminProductBackfillResult, AdminProductListResult, AdminProject, AdminProjectExportFormat, AdminUserCreditsSummary, AdminUserRecord, UpdateAdminUserInput } from '../core/types';
 export declare class AdminClient {
     private readonly http;
     constructor(http: PlatformHttpClient);
@@ -25,10 +25,14 @@ export declare class AdminClient {
     }, accessToken?: string): Promise<null>;
     deleteProject(id: string, accessToken?: string): Promise<null>;
     exportProject(id: string, format?: AdminProjectExportFormat, accessToken?: string): Promise<unknown>;
-    listProducts(projectId?: string, accessToken?: string): Promise<AdminProduct[]>;
+    listProducts(projectId?: string, accessToken?: string): Promise<AdminProductListResult>;
     createProduct(input: Omit<AdminProduct, 'id'>, accessToken?: string): Promise<AdminProduct>;
     updateProduct(input: AdminProduct, accessToken?: string): Promise<AdminProduct>;
     deleteProduct(id: string, accessToken?: string): Promise<null>;
+    backfillProductsProject(input: {
+        projectId: string;
+        productIds?: string[];
+    }, accessToken?: string): Promise<AdminProductBackfillResult>;
     listMemberships(filters?: AdminMembershipFilters, accessToken?: string): Promise<{
         memberships: AdminMembershipRecord[];
         unboundUsers: Array<{
@@ -84,6 +88,16 @@ export declare class AdminClient {
     }, accessToken?: string): Promise<{
         users: AdminUserRecord[];
     }>;
+    updateUser(input: UpdateAdminUserInput, accessToken?: string): Promise<{
+        userId: string;
+        name?: string | null;
+        status?: string;
+        projectId: string | null;
+        membershipTier?: string | null;
+        membershipStatus?: string | null;
+        membershipCredits?: number;
+        creditsBalance?: number;
+    }>;
     updateUserProject(input: {
         userId: string;
         projectId?: string | null;
@@ -112,4 +126,34 @@ export declare class AdminClient {
         key: string;
         value: string;
     }, accessToken?: string): Promise<AdminConfigItem>;
+    grantCredits(input: {
+        userId: string;
+        amount: number;
+        description?: string;
+        taskId?: string;
+    }, accessToken?: string): Promise<{
+        balanceAfter: number;
+        idempotent?: boolean;
+    }>;
+    getUserCredits(userId: string, accessToken?: string): Promise<AdminUserCreditsSummary>;
+    listManagedModels(accessToken?: string): Promise<{
+        models: AdminModelRecord[];
+        warning?: string | null;
+        schemaReady?: boolean;
+    }>;
+    createManagedModel(input: AdminModelInput, accessToken?: string): Promise<{
+        model: AdminModelRecord;
+    }>;
+    updateManagedModel(id: string, input: Partial<AdminModelInput>, accessToken?: string): Promise<{
+        model: AdminModelRecord;
+    }>;
+    deleteManagedModel(id: string, accessToken?: string): Promise<void>;
+    bulkDeleteManagedModels(ids: string[], accessToken?: string): Promise<{
+        deletedCount: number;
+    }>;
+    importManagedModels(input: AdminModelInput[], accessToken?: string): Promise<{
+        models: AdminModelRecord[];
+        count: number;
+    }>;
+    flushManagedModelCache(accessToken?: string): Promise<void>;
 }

package/dist/admin/client.js

@@ -68,6 +68,13 @@ export class AdminClient {
             accessToken,
         });
     }
+    backfillProductsProject(input, accessToken) {
+        return this.http.request('/api/v1/admin/products/backfill-project', {
+            method: 'POST',
+            body: input,
+            accessToken,
+        });
+    }
     listMemberships(filters = {}, accessToken) {
         return this.http.request('/api/v1/admin/memberships', {
             query: {
@@ -107,13 +114,16 @@ export class AdminClient {
             accessToken,
         });
     }
-    updateUserProject(input, accessToken) {
+    updateUser(input, accessToken) {
         return this.http.request('/api/v1/admin/users', {
             method: 'PUT',
             body: input,
             accessToken,
         });
     }
+    updateUserProject(input, accessToken) {
+        return this.updateUser(input, accessToken);
+    }
     deleteUsers(userIds, accessToken) {
         return this.http.request('/api/v1/admin/users', {
             method: 'DELETE',
@@ -143,4 +153,59 @@ export class AdminClient {
             accessToken,
         });
     }
+    grantCredits(input, accessToken) {
+        return this.http.request('/api/v1/credits/admin/grant', {
+            method: 'POST',
+            body: input,
+            accessToken,
+        });
+    }
+    getUserCredits(userId, accessToken) {
+        return this.http.request(`/api/v1/credits/admin/users/${encodeURIComponent(userId)}`, {
+            accessToken,
+        });
+    }
+    listManagedModels(accessToken) {
+        return this.http.request('/api/v1/admin/models', { accessToken });
+    }
+    createManagedModel(input, accessToken) {
+        return this.http.request('/api/v1/admin/models', {
+            method: 'POST',
+            body: input,
+            accessToken,
+        });
+    }
+    updateManagedModel(id, input, accessToken) {
+        return this.http.request(`/api/v1/admin/models/${encodeURIComponent(id)}`, {
+            method: 'PUT',
+            body: input,
+            accessToken,
+        });
+    }
+    deleteManagedModel(id, accessToken) {
+        return this.http.request(`/api/v1/admin/models/${encodeURIComponent(id)}`, {
+            method: 'DELETE',
+            accessToken,
+        });
+    }
+    bulkDeleteManagedModels(ids, accessToken) {
+        return this.http.request('/api/v1/admin/models/delete', {
+            method: 'POST',
+            body: { ids },
+            accessToken,
+        });
+    }
+    importManagedModels(input, accessToken) {
+        return this.http.request('/api/v1/admin/models/import', {
+            method: 'POST',
+            body: input,
+            accessToken,
+        });
+    }
+    flushManagedModelCache(accessToken) {
+        return this.http.request('/api/v1/admin/models/cache/flush', {
+            method: 'POST',
+            accessToken,
+        });
+    }
 }

package/dist/core/client.js

@@ -1,4 +1,4 @@
-import { PlatformApiError, PlatformTransportError } from './errors';
+import { PlatformApiError, PlatformTransportError } from './errors.js';
 function buildQueryString(query) {
     if (!query)
         return '';

package/dist/core/types.d.ts

@@ -336,3 +336,63 @@ export interface AdminConfigItem {
     description?: string;
     updated_at?: number;
 }
+export interface AdminUserCreditsSummary {
+    account: {
+        balance: number;
+        reserved: number;
+        total_earned: number;
+        total_spent: number;
+    };
+    recentLedger: CreditsLedgerItem[];
+}
+export interface AdminModelRecord {
+    id: string;
+    model_key: string;
+    model_id: string;
+    name: string;
+    provider: string;
+    model_type?: string | null;
+    min_tier?: string | null;
+    input_pricing: number;
+    output_pricing: number;
+    cache_ratio?: number | null;
+    enabled: number;
+    sort_order: number;
+    created_at?: number;
+    updated_at?: number;
+}
+export interface AdminModelInput {
+    model_key: string;
+    model_id: string;
+    name: string;
+    provider: string;
+    model_type?: string;
+    min_tier?: string;
+    input_pricing: number;
+    output_pricing: number;
+    cache_ratio?: number;
+    enabled?: number;
+    sort_order?: number;
+}
+export interface AdminProductListResult {
+    project: {
+        id: string;
+        name: string;
+        slug: string;
+        status: string;
+    } | null;
+    products: AdminProduct[];
+}
+export interface AdminProductBackfillResult {
+    updated: number;
+}
+export interface UpdateAdminUserInput {
+    userId: string;
+    name?: string | null;
+    status?: 'active' | 'disabled' | 'banned';
+    projectId?: string | null;
+    membershipTier?: string | null;
+    membershipStatus?: 'active' | 'expired' | 'cancelled';
+    membershipCredits?: number;
+    creditsBalance?: number;
+}

package/dist/index.d.ts

@@ -1,11 +1,16 @@
+import { AdminClient } from './admin/client';
+import { AiClient } from './ai/client';
+import { AuthClient } from './auth/client';
 import { PlatformHttpClient } from './core/client';
 import type { PlatformClientOptions } from './core/types';
-import { AuthClient } from './auth/client';
 import { CreditsClient } from './credits/client';
+import { OrdersClient } from './orders/client';
+import { PaymentClient } from './payment/client';
+import { ProjectsClient } from './projects/client';
 import { UserApiKeysClient } from './user/api-keys-client';
 import { UserSettingsClient } from './user/settings-client';
 export * from './core/errors';
-export type { AuthSession, AuthUser, CreditsBalance, CreditsLedgerItem, PlatformClientOptions, PlatformEnvelope, PlatformRequestOptions, UserApiKeyRecord, UserApiKeySecret, UserSettingDefinition, UserSettingsPayload, } from './core/types';
+export type { AdminConfigItem, AdminMembershipFilters, AdminMembershipRecord, AdminModelInput, AdminModelRecord, AdminOrderFilters, AdminOrderRecord, AdminProduct, AdminProductBackfillResult, AdminProductListResult, AdminProject, AdminProjectExportFormat, AdminUserCreditsSummary, AdminUserRecord, AiModelSummary, AuthSession, AuthUser, CreditsBalance, CreditsLedgerItem, MembershipView, OrderDetail, OrderSummary, PaymentCreateResponse, PaymentQueryResponse, PlatformClientOptions, PlatformEnvelope, PlatformRequestOptions, ProductSummary, ProjectSummary, UpdateAdminUserInput, UserApiKeyRecord, UserApiKeySecret, UserSettingDefinition, UserSettingsPayload, } from './core/types';
 export declare class BasePlatformClient {
     readonly http: PlatformHttpClient;
     readonly auth: AuthClient;
@@ -15,5 +20,20 @@ export declare class BasePlatformClient {
     constructor(options: PlatformClientOptions);
 }
 export declare function createBasePlatformClient(options: PlatformClientOptions): BasePlatformClient;
+export declare class ProjectPlatformClient {
+    readonly http: PlatformHttpClient;
+    readonly projects: ProjectsClient;
+    readonly orders: OrdersClient;
+    readonly payment: PaymentClient;
+    readonly ai: AiClient;
+    constructor(options: PlatformClientOptions);
+}
+export declare function createProjectPlatformClient(options: PlatformClientOptions): ProjectPlatformClient;
+export declare class AdminPlatformClient {
+    readonly http: PlatformHttpClient;
+    readonly admin: AdminClient;
+    constructor(options: PlatformClientOptions);
+}
+export declare function createAdminPlatformClient(options: PlatformClientOptions): AdminPlatformClient;
 export { BasePlatformClient as PlatformAClient };
 export declare const createPlatformAClient: typeof createBasePlatformClient;

package/dist/index.js

@@ -1,9 +1,14 @@
-import { PlatformHttpClient } from './core/client';
-import { AuthClient } from './auth/client';
-import { CreditsClient } from './credits/client';
-import { UserApiKeysClient } from './user/api-keys-client';
-import { UserSettingsClient } from './user/settings-client';
-export * from './core/errors';
+import { AdminClient } from './admin/client.js';
+import { AiClient } from './ai/client.js';
+import { AuthClient } from './auth/client.js';
+import { PlatformHttpClient } from './core/client.js';
+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 { UserApiKeysClient } from './user/api-keys-client.js';
+import { UserSettingsClient } from './user/settings-client.js';
+export * from './core/errors.js';
 export class BasePlatformClient {
     constructor(options) {
         this.http = new PlatformHttpClient(options);
@@ -16,5 +21,26 @@ export class BasePlatformClient {
 export function createBasePlatformClient(options) {
     return new BasePlatformClient(options);
 }
+export class ProjectPlatformClient {
+    constructor(options) {
+        this.http = new PlatformHttpClient(options);
+        this.projects = new ProjectsClient(this.http);
+        this.orders = new OrdersClient(this.http);
+        this.payment = new PaymentClient(this.http);
+        this.ai = new AiClient(this.http);
+    }
+}
+export function createProjectPlatformClient(options) {
+    return new ProjectPlatformClient(options);
+}
+export class AdminPlatformClient {
+    constructor(options) {
+        this.http = new PlatformHttpClient(options);
+        this.admin = new AdminClient(this.http);
+    }
+}
+export function createAdminPlatformClient(options) {
+    return new AdminPlatformClient(options);
+}
 export { BasePlatformClient as PlatformAClient };
 export const createPlatformAClient = createBasePlatformClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api2key-base-sdk",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "TypeScript SDK for consuming the Api2Key API stable APIs",
   "license": "UNLICENSED",
   "type": "module",
@@ -35,7 +35,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsc -p tsconfig.build.json && node ./scripts/fix-esm-imports.mjs",
     "clean": "rm -rf dist",
     "pack:check": "npm pack --dry-run",
     "release:check": "npm run clean && npm run type-check && npm run build && npm run pack:check",