finej3 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +10 -0
  2. package/dist/cjs/types/calcd.d.ts +9 -0
  3. package/dist/esm/types/calcd.d.ts +9 -0
  4. package/dist/esm/types/calcd.d.ts.map +1 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,12 @@
4
4
 
5
5
  当前实现包含主站 88 个、搜索服务 12 个、客户端服务 15 个和计算器服务 2 个方法，共 117 个 HTTP 接口。不包含 WebSocket 推送。
6
6
 
7
+ ## 2.3.0 版本说明
8
+
9
+ - `calcd.calculateDps` 增加可选 `fillMinimumHaste` 的类型适配，供支持补足加速试算的计算器服务使用。
10
+ - 补充 `hasteAdjustment` 和 `hasteShortfall` 类型，区分原始装备加速与试算加速。
11
+ - 增加参数透传、补足结果和错误诊断的回归检查。
12
+
7
13
  ## 2.2.0 版本说明
8
14
 
9
15
  - 新增独立 `calcd` 客户端，通过 `listRotations` 查询循环目录，通过 `calculateDps` 提交装备快照计算 DPS。
@@ -90,6 +96,10 @@ SDK 不自动读取环境变量或加载 `.env`。公开接口可省略 `token`
90
96
 
91
97
  `calcd.listRotations({ spec? })` 调用 `GET /v1/rotations` 获取心法循环目录。`calcd.calculateDps({ rotationId, role })` 调用 `POST /v1/dps`，使用目录中的循环 ID 和角色原始装备快照计算木桩 DPS。两个接口均为公开接口。
92
98
 
99
+ 若返回 `HASTE_MISMATCH` 且 `details.hasteShortfall` 为正数，可用同一份快照调用 `calcd.calculateDps({ rotationId, role, fillMinimumHaste: true })`。实际补足后，`haste` 仍是装备加速，`hasteAdjustment` 提供 `addedHaste`（补足点数）和 `simulatedHaste`（试算加速）。正常结果省略该对象。
100
+
101
+ 2026-11-13 发布前实测时，公开计算器接口传入 `fillMinimumHaste` 会返回 `INVALID_REQUEST`。此选项需在所连接的服务端支持后启用。
102
+
93
103
  ```ts
94
104
  import { createJx3, type CalcdRole } from 'finej3';
95
105
 
package/dist/cjs/types/calcd.d.ts CHANGED
@@ -55,6 +55,8 @@ export interface CalcdRole {
55
55
  export interface CalcdDpsParams<Role extends CalcdRole = CalcdRole> {
56
56
  rotationId: string;
57
57
  role: Role;
58
+ /** 仅在实际加速低于所选循环最低可用档时，补到该档试算。默认关闭。 */
59
+ fillMinimumHaste?: boolean;
58
60
  }
59
61
  export interface CalcdDpsSkill {
60
62
  name: string;
@@ -84,6 +86,11 @@ export interface CalcdDpsData {
84
86
  externalBuffs: boolean;
85
87
  };
86
88
  haste: number;
89
+ /** 仅补足试算返回；haste 始终为原始装备加速。 */
90
+ hasteAdjustment?: {
91
+ addedHaste: number;
92
+ simulatedHaste: number;
93
+ };
87
94
  matchedVariant: CalcdVariant;
88
95
  durationSeconds: number;
89
96
  totalDamage: number;
@@ -99,6 +106,8 @@ export interface CalcdDpsData {
99
106
  /** HTTP 422 的 HASTE_MISMATCH 错误可提供此诊断信息。 */
100
107
  export interface CalcdHasteMismatchDetails {
101
108
  actualHaste: number;
109
+ /** 低于最低可用档时，补足到该档所需的点数。 */
110
+ hasteShortfall?: number;
102
111
  actualHasteTier: number;
103
112
  latencyTier: number;
104
113
  availableVariants: CalcdVariant[];
package/dist/esm/types/calcd.d.ts CHANGED
@@ -55,6 +55,8 @@ export interface CalcdRole {
55
55
  export interface CalcdDpsParams<Role extends CalcdRole = CalcdRole> {
56
56
  rotationId: string;
57
57
  role: Role;
58
+ /** 仅在实际加速低于所选循环最低可用档时，补到该档试算。默认关闭。 */
59
+ fillMinimumHaste?: boolean;
58
60
  }
59
61
  export interface CalcdDpsSkill {
60
62
  name: string;
@@ -84,6 +86,11 @@ export interface CalcdDpsData {
84
86
  externalBuffs: boolean;
85
87
  };
86
88
  haste: number;
89
+ /** 仅补足试算返回；haste 始终为原始装备加速。 */
90
+ hasteAdjustment?: {
91
+ addedHaste: number;
92
+ simulatedHaste: number;
93
+ };
87
94
  matchedVariant: CalcdVariant;
88
95
  durationSeconds: number;
89
96
  totalDamage: number;
@@ -99,6 +106,8 @@ export interface CalcdDpsData {
99
106
  /** HTTP 422 的 HASTE_MISMATCH 错误可提供此诊断信息。 */
100
107
  export interface CalcdHasteMismatchDetails {
101
108
  actualHaste: number;
109
+ /** 低于最低可用档时，补足到该档所需的点数。 */
110
+ hasteShortfall?: number;
102
111
  actualHasteTier: number;
103
112
  latencyTier: number;
104
113
  availableVariants: CalcdVariant[];
package/dist/esm/types/calcd.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"calcd.d.ts","sourceRoot":"","sources":["../../../src/types/calcd.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAE7C,kBAAkB;AAClB,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACpC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,sBAAsB;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,2BAA2B;AAC3B,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,iBAAiB,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;AAErE,+BAA+B;AAC/B,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,iBAAiB,CAAC;IAC9B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,2BAA2B;IAC3B,cAAc,CAAC,EAAE,iBAAiB,CAAC;IACnC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IACzC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IACzC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,aAAa,CAAC,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAC3C,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B;AAED,gCAAgC;AAChC,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,kBAAkB,EAAE,CAAC;CACjC;AAED,oCAAoC;AACpC,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS;IAChE,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE;QACT,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,OAAO,CAAC;KACxB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,YAAY,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,YAAY,EAAE,gBAAgB,EAAE,CAAC;IACjC,SAAS,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,YAAY,EAAE,CAAC;IAClC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,yCAAyC;AACzC,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC"}
1
+ {"version":3,"file":"calcd.d.ts","sourceRoot":"","sources":["../../../src/types/calcd.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAE7C,kBAAkB;AAClB,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACpC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,sBAAsB;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,2BAA2B;AAC3B,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,iBAAiB,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;AAErE,+BAA+B;AAC/B,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,iBAAiB,CAAC;IAC9B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,2BAA2B;IAC3B,cAAc,CAAC,EAAE,iBAAiB,CAAC;IACnC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IACzC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IACzC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,aAAa,CAAC,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAC3C,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B;AAED,gCAAgC;AAChC,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,kBAAkB,EAAE,CAAC;CACjC;AAED,oCAAoC;AACpC,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS;IAChE,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,sCAAsC;IACtC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE;QACT,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,OAAO,CAAC;KACxB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,eAAe,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,CAAC;IACjE,cAAc,EAAE,YAAY,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,YAAY,EAAE,gBAAgB,EAAE,CAAC;IACjC,SAAS,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,YAAY,EAAE,CAAC;IAClC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,yCAAyC;AACzC,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "finej3",
3
- "version": "2.2.0",
3
+ "version": "2.3.0",
4
4
  "description": "剑网 3 API 的 TypeScript SDK，支持主站、搜索、客户端和 DPS 计算器服务，提供 ESM 与 CommonJS 双格式。",
5
5
  "type": "module",
6
6
  "main": "./dist/cjs/index.js",