chore(release): release typescript v0.1.15

Author: shuakami

README.md

@@ -19,12 +19,10 @@ npm i uapi-sdk-typescript
 import { UapiClient } from 'uapi-sdk-typescript'
 
 const client = new UapiClient('https://uapis.cn', 'YOUR_API_KEY')
-const result = await client.misc.getMiscHotboard({ type: 'weibo' })
+const result = await (client as any).social.getSocialQqUserinfo({ qq: '10001' })
 console.log(result)
 ```
 
-这个接口默认只要传 `type` 就可以拿当前热榜。`time`、`keyword`、`timeStart`、`timeEnd`、`limit`、`sources` 都是按场景再传的可选参数。
-
 ## 特性
 
 现在你不再需要反反复复的查阅文档了。
@@ -35,67 +33,10 @@ console.log(result)
 
 针对 401、404、429 等标准 HTTP 响应，SDK 已将其统一映射为具名的错误类型。这些错误均附带 `code`、`status`、`details` 等关键上下文信息，确保你在日志或 APM 中能第一时间准确、快速地诊断问题。
 
-HTTP 封装基于 Axios，默认 15 秒超时并自动携带 `Authorization` 头。当前公开的构造参数只有 `baseURL` 和 `token`；如果你需要代理、重试或额外的 Header，建议在项目里再封装一层，或者按需扩展源码。
+HTTP 封装基于 Axios，默认 15 秒超时并自动携带 `Authorization` 头；如果你想接入代理、重试或额外的 Header，只需要在实例化后对 Axios 拦截器做扩展即可。
 
 如果你需要查看字段细节或内部逻辑，仓库中的 `./internal` 目录同步保留了由 `openapi-generator` 生成的完整结构体，随时可供参考。
 
-## 响应元信息
-
-每次请求完成后，SDK 会自动把响应 Header 解析成结构化的 `ResponseMeta`，你不用自己拆原始字符串。
-
-成功时可以通过 `client.lastResponseMeta` 读取，失败时可以通过 `err.meta` 读取，两条路径拿到的是同一套字段。
-
-```ts
-import { UapiClient, UapiError } from 'uapi-sdk-typescript'
-
-const client = new UapiClient('https://uapis.cn', 'YOUR_API_KEY')
-
-// 成功路径
-await client.social.getSocialQqUserinfo({ qq: '10001' })
-const meta = client.lastResponseMeta
-if (meta) {
-  console.log('这次请求原价:', meta.creditsRequested ?? 0, '积分')
-  console.log('这次实际扣费:', meta.creditsCharged ?? 0, '积分')
-  console.log('特殊计价:', meta.creditsPricing ?? '原价')
-  console.log('余额剩余:', meta.balanceRemainingCents ?? 0, '分')
-  console.log('资源包剩余:', meta.quotaRemainingCredits ?? 0, '积分')
-  console.log('当前有效额度桶:', meta.activeQuotaBuckets ?? 0)
-  console.log('额度用空即停:', meta.stopOnEmpty ?? false)
-  console.log('Key QPS:', meta.billingKeyRateRemaining ?? 0, '/', meta.billingKeyRateLimit ?? 0, meta.billingKeyRateUnit ?? 'req')
-  console.log('Request ID:', meta.requestId)
-}
-
-// 失败路径
-try {
-  await client.social.getSocialQqUserinfo({ qq: '10001' })
-} catch (err) {
-  if (err instanceof UapiError && err.meta) {
-    console.log('Retry-After 秒数:', err.meta.retryAfterSeconds ?? null)
-    console.log('Retry-After 原始值:', err.meta.retryAfterRaw ?? null)
-    console.log('访客 QPS:', err.meta.visitorRateRemaining ?? 0, '/', err.meta.visitorRateLimit ?? 0)
-    console.log('Request ID:', err.meta.requestId)
-  }
-}
-```
-
-常用字段一览：
-
-| 字段 | 说明 |
-|------|------|
-| `creditsRequested` | 这次请求原本要扣多少积分，也就是请求价 |
-| `creditsCharged` | 这次请求实际扣了多少积分 |
-| `creditsPricing` | 特殊计价原因，例如缓存半价 `cache-hit-half-price` |
-| `balanceRemainingCents` | 账户余额剩余（分） |
-| `quotaRemainingCredits` | 资源包剩余积分 |
-| `activeQuotaBuckets` | 当前还有多少个有效额度桶参与计费 |
-| `stopOnEmpty` | 额度耗尽后是否直接停止服务 |
-| `retryAfterSeconds` / `retryAfterRaw` | 限流后的等待时长；当服务端返回 HTTP 时间字符串时看 `retryAfterRaw` |
-| `requestId` | 请求唯一 ID，排障时使用 |
-| `billingKeyRateLimit` / `billingKeyRateRemaining` | Billing Key 当前 QPS 规则的上限与剩余 |
-| `billingIpRateLimit` / `billingIpRateRemaining` | Billing Key 单 IP 当前 QPS 规则的上限与剩余 |
-| `visitorRateLimit` / `visitorRateRemaining` | 访客当前 QPS 规则的上限与剩余 |
-| `rateLimitPolicies` / `rateLimits` | 完整结构化限流策略数据 |
-
 ## 错误模型概览
 
 | HTTP 状态码 | SDK 错误类型                                  | 附加信息                                                                          |

internal/README.md

@@ -1,27 +1,49 @@
-## uapi-sdk-typescript internal
+## uapi-sdk-typescript@1.0.0
 
-这个目录保留的是 OpenAPI Generator 生成的原始参考文档，主要用来对照 operation、model 和生成器层面的类名。
-如果你是想直接安装并使用 SDK，请优先查看仓库根目录的 `README.md`。
+This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
-### 安装
+Environment
+* Node.js
+* Webpack
+* Browserify
 
-```bash
-npm install uapi-sdk-typescript
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
 ```
 
-### 最小示例
+### Publishing
+
+First build the package then run `npm publish`
 
-```ts
-import { UapiClient } from 'uapi-sdk-typescript'
+### Consuming
 
-const client = new UapiClient('https://uapis.cn', 'YOUR_API_KEY')
-const result = await client.misc.getMiscHotboard({ type: 'weibo' })
-console.log(result)
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install uapi-sdk-typescript@1.0.0 --save
 ```
 
-### 说明
+_unPublished (not recommended):_
 
-下面继续保留自动生成的 API / Model 索引，方便你按生成器原始命名检索。
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
 
 ### Documentation for API Endpoints
 
@@ -458,3 +480,4 @@ Class | Method | HTTP request | Description
 ## Documentation For Authorization
 
 Endpoints do not require authorization.
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "uapi-sdk-typescript",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "type": "module",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

src/errors.ts

@@ -14,7 +14,6 @@ export interface RateLimitStateEntry {
 
 export interface ResponseMeta {
   requestId?: string
-  retryAfterRaw?: string
   retryAfterSeconds?: number
   debitStatus?: string
   creditsRequested?: number
@@ -32,21 +31,6 @@ export interface ResponseMeta {
   quotaRemainingCredits?: number
   visitorQuotaLimitCredits?: number
   visitorQuotaRemainingCredits?: number
-  billingKeyRateLimit?: number
-  billingKeyRateRemaining?: number
-  billingKeyRateUnit?: string
-  billingKeyRateWindowSeconds?: number
-  billingKeyRateResetAfterSeconds?: number
-  billingIpRateLimit?: number
-  billingIpRateRemaining?: number
-  billingIpRateUnit?: string
-  billingIpRateWindowSeconds?: number
-  billingIpRateResetAfterSeconds?: number
-  visitorRateLimit?: number
-  visitorRateRemaining?: number
-  visitorRateUnit?: string
-  visitorRateWindowSeconds?: number
-  visitorRateResetAfterSeconds?: number
   rawHeaders: Record<string, string>
 }
 
@@ -213,16 +197,8 @@ export function extractMetaFromHeaders(headers: any): ResponseMeta {
     }
   }
 
-  const billingKeyRatePolicy = rateLimitPolicies['billing-key-rate']
-  const billingKeyRateState = rateLimits['billing-key-rate']
-  const billingIpRatePolicy = rateLimitPolicies['billing-ip-rate']
-  const billingIpRateState = rateLimits['billing-ip-rate']
-  const visitorRatePolicy = rateLimitPolicies['visitor-rate']
-  const visitorRateState = rateLimits['visitor-rate']
-
   return {
     requestId: rawHeaders['x-request-id'],
-    retryAfterRaw: rawHeaders['retry-after'],
     retryAfterSeconds: parseNumber(rawHeaders['retry-after']),
     debitStatus: rawHeaders['uapi-debit-status'],
     creditsRequested: parseNumber(rawHeaders['uapi-credits-requested']),
@@ -240,21 +216,6 @@ export function extractMetaFromHeaders(headers: any): ResponseMeta {
     quotaRemainingCredits: rateLimits['billing-quota']?.remaining,
     visitorQuotaLimitCredits: rateLimitPolicies['visitor-quota']?.quota,
     visitorQuotaRemainingCredits: rateLimits['visitor-quota']?.remaining,
-    billingKeyRateLimit: billingKeyRatePolicy?.quota,
-    billingKeyRateRemaining: billingKeyRateState?.remaining,
-    billingKeyRateUnit: billingKeyRatePolicy?.unit ?? billingKeyRateState?.unit,
-    billingKeyRateWindowSeconds: billingKeyRatePolicy?.windowSeconds,
-    billingKeyRateResetAfterSeconds: billingKeyRateState?.resetAfterSeconds,
-    billingIpRateLimit: billingIpRatePolicy?.quota,
-    billingIpRateRemaining: billingIpRateState?.remaining,
-    billingIpRateUnit: billingIpRatePolicy?.unit ?? billingIpRateState?.unit,
-    billingIpRateWindowSeconds: billingIpRatePolicy?.windowSeconds,
-    billingIpRateResetAfterSeconds: billingIpRateState?.resetAfterSeconds,
-    visitorRateLimit: visitorRatePolicy?.quota,
-    visitorRateRemaining: visitorRateState?.remaining,
-    visitorRateUnit: visitorRatePolicy?.unit ?? visitorRateState?.unit,
-    visitorRateWindowSeconds: visitorRatePolicy?.windowSeconds,
-    visitorRateResetAfterSeconds: visitorRateState?.resetAfterSeconds,
     rawHeaders,
   }
 }