@thejrsoft/subway-protocol 1.5.0 → 1.6.1

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,141 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.6.1] - 2026-05-13
4
+
5
+ ### Added (零破坏,向后兼容)
6
+
7
+ - `EXPLICIT_META` 新增 2 个终态 code:`EDGE_COMMAND_REJECTED` / `EDGE_PROGRAM_REJECTED`
8
+ - 用于 Edge 代理层合成终态消息(设备未响应时合成 "as-if device error response")
9
+ - 失败具体原因通过 `data.error.{phase, step, category, detail}` 表达
10
+
11
+ ### Migration
12
+
13
+ Edge `edge-proxy.manager.ts` 中 9 处错误响应合成调用迁移到 `dispatchMessage`:
14
+
15
+ ```typescript
16
+ // Before (v1.6.0 旧 Factory 调用)
17
+ MessageFactory.createCommandResponseMessage(
18
+ edgeId, requestRef, MessageStatus.FAILED, { error: '...' }
19
+ );
20
+
21
+ // After (v1.6.1 推荐)
22
+ MessageFactory.dispatchMessage({
23
+ clientId: edgeId, requestRef,
24
+ code: 'EDGE_COMMAND_REJECTED',
25
+ message: '...',
26
+ error: { phase: 'BATCH_EXECUTE', step: '...', category: 'TRANSPORT', detail: '...' },
27
+ });
28
+ ```
29
+
30
+ ---
31
+
32
+ ## [1.6.0] - 2026-05-13
33
+
34
+ ### ⚠️ BREAKING CHANGES — 硬切,零兼容(系统未上线)
35
+
36
+ #### 1. CodeMeta 单一信息源 — status / level 由 report.code 派生
37
+
38
+ 新设计:所有协议消息的 `status` 和 `level` 字段由 `report.code` 通过 `CodeMeta` 表自动派生。
39
+ 集成方收到消息后调用 `resolveCodeMeta(code)` 查表得到 `semantic` / `requiresErrorBlock` 等元数据。
40
+
41
+ ```typescript
42
+ import { resolveCodeMeta } from '@thejrsoft/subway-protocol';
43
+
44
+ const meta = resolveCodeMeta(msg.report.code);
45
+ // meta: { isTerminal, status, level, semantic, requiresErrorBlock }
46
+ switch (meta.semantic) {
47
+ case 'success': /* ALL_SUCCESS / ALL_ONLINE 等 */ break;
48
+ case 'partial': /* PARTIAL_SUCCESS / PARTIAL_ONLINE */ break;
49
+ case 'failure': /* ALL_FAILED / UPLOAD_FAILED */ break;
50
+ case 'busy': /* BUSY 并发拒绝 */ break;
51
+ case 'cancel': /* CANCELLED */ break;
52
+ case 'no-op': /* NO_PROGRAMS */ break;
53
+ // 进度语义: phase_start / phase_end / phase_failed / step_success ...
54
+ }
55
+ ```
56
+
57
+ #### 2. MessageStatus 单一 enum 取代 CommandStatus / ProgressStatus
58
+
59
+ ```typescript
60
+ // v1.5.0 (已删)
61
+ enum CommandStatus { COMPLETED, FAILED, TIMEOUT, CANCELLED, IN_PROGRESS } ← 删
62
+ enum ProgressStatus { PENDING, IN_PROGRESS, PAUSED, COMPLETED, FAILED, CANCELLED } ← 删
63
+
64
+ // v1.6.0 (新)
65
+ enum MessageStatus { IN_PROGRESS, COMPLETED, FAILED, CANCELLED }
66
+ ```
67
+
68
+ **删除的死代码值**:
69
+ - `ProgressStatus.PENDING` / `PAUSED`(v1.5.0 内 0 引用)
70
+ - `CommandStatus.TIMEOUT` 语义迁移到 `status=FAILED + data.error.category='TIMEOUT'`
71
+
72
+ #### 3. dispatchMessage 统一发消息接口
73
+
74
+ 替代旧 `MessageFactory.createCommandResponseMessage` / `createProgramResponseMessage` /
75
+ `createProgressUpdateMessage`:
76
+
77
+ ```typescript
78
+ MessageFactory.dispatchMessage({
79
+ clientId, requestRef,
80
+ code: 'PROGRAM_COMPLETED', // 单一信息源
81
+ message: 'Program upload completed',
82
+ data: { totalPrograms: 5, successCount: 5 },
83
+ // status / level / 消息类型由 CodeMeta 自动推导
84
+ });
85
+ ```
86
+
87
+ 设备端只填 `code` 和业务字段,违反 META 决策矩阵的风险归零。
88
+
89
+ #### 4. 拆分歧义 code — 一码一义原则
90
+
91
+ `PROGRAM_UPLOAD_FAILED` v1.5.0 既表 FAILED 又表 BUSY → v1.6.0 拆分:
92
+ - `PROGRAM_UPLOAD_FAILED`:仅表异常中断(status=FAILED + level=ERROR)
93
+ - `PROGRAM_UPLOAD_BUSY`:独立 code,表并发拒绝(status=FAILED + level=WARNING)
94
+
95
+ ### 新增
96
+
97
+ - `MessageStatus` enum(4 值)
98
+ - `CodeMeta` interface(5 字段)
99
+ - `CodeSemantic` 联合类型(15 值,覆盖终态 + 进度)
100
+ - `EXPLICIT_META` 终态显式表(~14 entries)
101
+ - `SUFFIX_RULES` 进度后缀规则(9 条)
102
+ - `resolveCodeMeta(code)` / `isKnownCode(code)` 工具函数
103
+ - `MessageFactory.dispatchMessage(params)` 统一发消息接口
104
+
105
+ ### 删除
106
+
107
+ - ✂️ `enum CommandStatus`(v1.5.0 5 值)
108
+ - ✂️ `enum ProgressStatus`(v1.5.0 6 值)
109
+ - ✂️ `CommandStatus.TIMEOUT`(合并到 data.error.category)
110
+ - ✂️ `ProgressStatus.PENDING` / `PAUSED`(0 引用死代码)
111
+
112
+ ### Migration
113
+
114
+ ```typescript
115
+ // v1.5.0
116
+ import { CommandStatus, ProgressStatus, MessageFactory } from '@thejrsoft/subway-protocol';
117
+ const msg = MessageFactory.createCommandResponseMessage(
118
+ clientId, requestRef, CommandStatus.COMPLETED, result, message,
119
+ );
120
+
121
+ // v1.6.0
122
+ import { MessageStatus, MessageFactory } from '@thejrsoft/subway-protocol';
123
+ const msg = MessageFactory.dispatchMessage({
124
+ clientId, requestRef,
125
+ code: 'SYNC_FUNCTIONS_SWITCH_WRITE_SUCCESS', // 单一信息源
126
+ message: 'Switch set to On',
127
+ result,
128
+ });
129
+ // status (COMPLETED) + level (INFO) 自动从 code 派生
130
+ ```
131
+
132
+ ### 协议设计依据
133
+
134
+ 完整设计原则、决策回放(CodeMeta 设计奇点、status 合并理由、为什么 semantic 不进消息等)
135
+ 见 `claude-docs/protocol-upgrade-proposal-v1.6.0.md`。
136
+
137
+ ---
138
+
3
139
  ## [1.5.0] - 2026-05-12
4
140
 
5
141
  ### ⚠️ BREAKING CHANGES — 无兼容、无 fallback(系统未上线)
@@ -15,7 +15,7 @@ function generateAsyncApiEnums() {
15
15
  ClientType: Object.values(index_1.ClientType),
16
16
  OperationType: Object.values(index_1.OperationType),
17
17
  Priority: Object.values(index_1.Priority),
18
- CommandStatus: Object.values(index_1.CommandStatus)
18
+ MessageStatus: Object.values(index_1.MessageStatus)
19
19
  };
20
20
  return `
21
21
  # AsyncAPI Enum Definitions
@@ -39,9 +39,9 @@ components:
39
39
  type: string
40
40
  enum: ${JSON.stringify(enums.Priority)}
41
41
 
42
- CommandStatus:
42
+ MessageStatus:
43
43
  type: string
44
- enum: ${JSON.stringify(enums.CommandStatus)}
44
+ enum: ${JSON.stringify(enums.MessageStatus)}
45
45
  `;
46
46
  }
47
47
  /**
@@ -0,0 +1,57 @@
1
+ /**
2
+ * CodeMeta — v1.6.0 协议核心
3
+ *
4
+ * report.code 是业务命运的单一信息源;status / level / semantic 全部由此派生。
5
+ *
6
+ * 设备端调用 dispatchMessage(code, data) 时,协议层自动按 code 推导 status / level,
7
+ * 集成方接收消息后调用 resolveCodeMeta(code) 查表得到 semantic / requiresErrorBlock 等。
8
+ *
9
+ * 设计依据:claude-docs/protocol-upgrade-proposal-v1.6.0.md
10
+ */
11
+ import type { ReportLevel } from './index';
12
+ /** v1.6.0:单一 status enum,合并 v1.5.0 的 CommandStatus + ProgressStatus */
13
+ export declare enum MessageStatus {
14
+ IN_PROGRESS = "IN_PROGRESS",
15
+ COMPLETED = "COMPLETED",
16
+ FAILED = "FAILED",
17
+ CANCELLED = "CANCELLED"
18
+ }
19
+ /** 业务语义分类——终态语义 + 进度语义 */
20
+ export type CodeSemantic = 'success' | 'partial' | 'failure' | 'no-op' | 'cancel' | 'busy' | 'phase_start' | 'phase_end' | 'phase_failed' | 'step_success' | 'step_skipped' | 'step_progress' | 'retry' | 'retry_pending' | 'warning';
21
+ /**
22
+ * 单一 code 的元数据描述符
23
+ *
24
+ * 派生字段(status / level)会序列化进消息;
25
+ * 客户端字段(semantic / requiresErrorBlock / isTerminal)仅供查表,不进消息。
26
+ */
27
+ export interface CodeMeta {
28
+ isTerminal: boolean;
29
+ status: MessageStatus;
30
+ level: ReportLevel;
31
+ semantic: CodeSemantic;
32
+ requiresErrorBlock: boolean;
33
+ }
34
+ /**
35
+ * 终态 code 显式 META 表
36
+ *
37
+ * 这些 code 是业务命运决断点,每个语义都是独特的,**不能用后缀规则推导**。
38
+ * 设备端发送终态消息时,dispatchMessage 在此表查询,自动填充消息字段。
39
+ */
40
+ export declare const EXPLICIT_META: Record<string, CodeMeta>;
41
+ /**
42
+ * 单一 code 解析入口
43
+ *
44
+ * 解析顺序:
45
+ * 1. 终态显式表(EXPLICIT_META) — 30 个 closed enum
46
+ * 2. 后缀规则(SUFFIX_RULES) — 9 条规则覆盖数百个进度 code
47
+ * 3. 兜底(FALLBACK_META) — 未知 code 降级
48
+ *
49
+ * @param code report.code 字符串
50
+ * @returns CodeMeta — status / level / semantic / requiresErrorBlock / isTerminal
51
+ */
52
+ export declare function resolveCodeMeta(code: string): CodeMeta;
53
+ /**
54
+ * 判断 code 是否已知(命中显式表或后缀规则,不走兜底)
55
+ */
56
+ export declare function isKnownCode(code: string): boolean;
57
+ //# sourceMappingURL=code-meta.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"code-meta.d.ts","sourceRoot":"","sources":["../src/code-meta.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,uEAAuE;AACvE,oBAAY,aAAa;IACvB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,SAAS,cAAc;CACxB;AAED,0BAA0B;AAC1B,MAAM,MAAM,YAAY,GAEpB,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,QAAQ,GACR,MAAM,GAEN,aAAa,GACb,WAAW,GACX,cAAc,GACd,cAAc,GACd,cAAc,GACd,eAAe,GACf,OAAO,GACP,eAAe,GACf,SAAS,CAAC;AAEd;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CA2HlD,CAAC;AAoHF;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAatD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAOjD"}
@@ -0,0 +1,286 @@
1
+ "use strict";
2
+ /**
3
+ * CodeMeta — v1.6.0 协议核心
4
+ *
5
+ * report.code 是业务命运的单一信息源;status / level / semantic 全部由此派生。
6
+ *
7
+ * 设备端调用 dispatchMessage(code, data) 时,协议层自动按 code 推导 status / level,
8
+ * 集成方接收消息后调用 resolveCodeMeta(code) 查表得到 semantic / requiresErrorBlock 等。
9
+ *
10
+ * 设计依据:claude-docs/protocol-upgrade-proposal-v1.6.0.md
11
+ */
12
+ Object.defineProperty(exports, "__esModule", { value: true });
13
+ exports.EXPLICIT_META = exports.MessageStatus = void 0;
14
+ exports.resolveCodeMeta = resolveCodeMeta;
15
+ exports.isKnownCode = isKnownCode;
16
+ /** v1.6.0:单一 status enum,合并 v1.5.0 的 CommandStatus + ProgressStatus */
17
+ var MessageStatus;
18
+ (function (MessageStatus) {
19
+ MessageStatus["IN_PROGRESS"] = "IN_PROGRESS";
20
+ MessageStatus["COMPLETED"] = "COMPLETED";
21
+ MessageStatus["FAILED"] = "FAILED";
22
+ MessageStatus["CANCELLED"] = "CANCELLED";
23
+ })(MessageStatus || (exports.MessageStatus = MessageStatus = {}));
24
+ /**
25
+ * 终态 code 显式 META 表
26
+ *
27
+ * 这些 code 是业务命运决断点,每个语义都是独特的,**不能用后缀规则推导**。
28
+ * 设备端发送终态消息时,dispatchMessage 在此表查询,自动填充消息字段。
29
+ */
30
+ exports.EXPLICIT_META = {
31
+ // ═══════════ PROGRAM 节目部署 ═══════════
32
+ PROGRAM_COMPLETED: {
33
+ isTerminal: true,
34
+ status: MessageStatus.COMPLETED,
35
+ level: 'INFO',
36
+ semantic: 'success',
37
+ requiresErrorBlock: false,
38
+ },
39
+ PROGRAM_PARTIALLY_SUCCEEDED: {
40
+ isTerminal: true,
41
+ status: MessageStatus.COMPLETED,
42
+ level: 'WARNING',
43
+ semantic: 'partial',
44
+ requiresErrorBlock: false,
45
+ },
46
+ PROGRAM_ALL_FAILED: {
47
+ isTerminal: true,
48
+ status: MessageStatus.FAILED,
49
+ level: 'ERROR',
50
+ semantic: 'failure',
51
+ requiresErrorBlock: true,
52
+ },
53
+ PROGRAM_NO_PROGRAMS: {
54
+ isTerminal: true,
55
+ status: MessageStatus.COMPLETED,
56
+ level: 'INFO',
57
+ semantic: 'no-op',
58
+ requiresErrorBlock: false,
59
+ },
60
+ PROGRAM_UPLOAD_FAILED: {
61
+ isTerminal: true,
62
+ status: MessageStatus.FAILED,
63
+ level: 'ERROR',
64
+ semantic: 'failure',
65
+ requiresErrorBlock: true,
66
+ },
67
+ PROGRAM_UPLOAD_BUSY: {
68
+ isTerminal: true,
69
+ status: MessageStatus.FAILED,
70
+ level: 'WARNING',
71
+ semantic: 'busy',
72
+ requiresErrorBlock: true,
73
+ },
74
+ PROGRAM_UPLOAD_CANCELLED: {
75
+ isTerminal: true,
76
+ status: MessageStatus.CANCELLED,
77
+ level: 'WARNING',
78
+ semantic: 'cancel',
79
+ requiresErrorBlock: true,
80
+ },
81
+ // ═══════════ QUICKLY_DETECTION 一键检测 ═══════════
82
+ QUICK_DETECTION_ALL_ONLINE: {
83
+ isTerminal: true,
84
+ status: MessageStatus.COMPLETED,
85
+ level: 'INFO',
86
+ semantic: 'success',
87
+ requiresErrorBlock: false,
88
+ },
89
+ QUICK_DETECTION_PARTIAL_ONLINE: {
90
+ isTerminal: true,
91
+ status: MessageStatus.COMPLETED,
92
+ level: 'WARNING',
93
+ semantic: 'partial',
94
+ requiresErrorBlock: false,
95
+ },
96
+ QUICK_DETECTION_ALL_OFFLINE: {
97
+ isTerminal: true,
98
+ status: MessageStatus.COMPLETED,
99
+ level: 'ERROR',
100
+ semantic: 'failure',
101
+ requiresErrorBlock: true,
102
+ },
103
+ QUICK_DETECTION_FAILED: {
104
+ isTerminal: true,
105
+ status: MessageStatus.FAILED,
106
+ level: 'ERROR',
107
+ semantic: 'failure',
108
+ requiresErrorBlock: true,
109
+ },
110
+ QUICK_DETECTION_BUSY: {
111
+ isTerminal: true,
112
+ status: MessageStatus.FAILED,
113
+ level: 'WARNING',
114
+ semantic: 'busy',
115
+ requiresErrorBlock: true,
116
+ },
117
+ // ═══════════ SYNC_MONITORING_TABLE 监播导出 ═══════════
118
+ SYNC_MONITORING_TABLE_READ_SUCCESS: {
119
+ isTerminal: true,
120
+ status: MessageStatus.COMPLETED,
121
+ level: 'INFO',
122
+ semantic: 'success',
123
+ requiresErrorBlock: false,
124
+ },
125
+ SYNC_MONITORING_TABLE_READ_FAILED: {
126
+ isTerminal: true,
127
+ status: MessageStatus.FAILED,
128
+ level: 'ERROR',
129
+ semantic: 'failure',
130
+ requiresErrorBlock: true,
131
+ },
132
+ // ═══════════ EDGE 代理层合成的终态拒绝 ═══════════
133
+ // 当 Edge 在转发命令到设备的过程中失败(设备不在线、命令格式错、转发失败等),
134
+ // Edge 合成一个终态消息发回 Gateway 让命令生命周期闭环。
135
+ // 具体失败原因通过 data.error.{phase, step, category, detail} 表达。
136
+ EDGE_COMMAND_REJECTED: {
137
+ isTerminal: true,
138
+ status: MessageStatus.FAILED,
139
+ level: 'ERROR',
140
+ semantic: 'failure',
141
+ requiresErrorBlock: true,
142
+ },
143
+ EDGE_PROGRAM_REJECTED: {
144
+ isTerminal: true,
145
+ status: MessageStatus.FAILED,
146
+ level: 'ERROR',
147
+ semantic: 'failure',
148
+ requiresErrorBlock: true,
149
+ },
150
+ };
151
+ const SUFFIX_RULES = [
152
+ {
153
+ suffix: '_FAILED',
154
+ meta: {
155
+ status: MessageStatus.IN_PROGRESS,
156
+ level: 'ERROR',
157
+ semantic: 'phase_failed',
158
+ requiresErrorBlock: true,
159
+ },
160
+ },
161
+ {
162
+ suffix: '_RETRY_PENDING',
163
+ meta: {
164
+ status: MessageStatus.IN_PROGRESS,
165
+ level: 'WARNING',
166
+ semantic: 'retry_pending',
167
+ requiresErrorBlock: false,
168
+ },
169
+ },
170
+ {
171
+ suffix: '_RETRY',
172
+ meta: {
173
+ status: MessageStatus.IN_PROGRESS,
174
+ level: 'WARNING',
175
+ semantic: 'retry',
176
+ requiresErrorBlock: false,
177
+ },
178
+ },
179
+ {
180
+ // 后缀或中缀都命中:例 PROGRAM_UPLOAD_WARN_CAN_BUS_ALARM
181
+ infix: '_WARN',
182
+ meta: {
183
+ status: MessageStatus.IN_PROGRESS,
184
+ level: 'WARNING',
185
+ semantic: 'warning',
186
+ requiresErrorBlock: false,
187
+ },
188
+ },
189
+ {
190
+ suffix: '_SKIPPED',
191
+ meta: {
192
+ status: MessageStatus.IN_PROGRESS,
193
+ level: 'INFO',
194
+ semantic: 'step_skipped',
195
+ requiresErrorBlock: false,
196
+ },
197
+ },
198
+ {
199
+ suffix: '_COMPLETED',
200
+ meta: {
201
+ status: MessageStatus.IN_PROGRESS,
202
+ level: 'INFO',
203
+ semantic: 'phase_end',
204
+ requiresErrorBlock: false,
205
+ },
206
+ },
207
+ {
208
+ suffix: '_START',
209
+ meta: {
210
+ status: MessageStatus.IN_PROGRESS,
211
+ level: 'INFO',
212
+ semantic: 'phase_start',
213
+ requiresErrorBlock: false,
214
+ },
215
+ },
216
+ {
217
+ suffix: '_PROGRESS',
218
+ meta: {
219
+ status: MessageStatus.IN_PROGRESS,
220
+ level: 'INFO',
221
+ semantic: 'step_progress',
222
+ requiresErrorBlock: false,
223
+ },
224
+ },
225
+ {
226
+ suffix: '_SUCCESS',
227
+ meta: {
228
+ status: MessageStatus.IN_PROGRESS,
229
+ level: 'INFO',
230
+ semantic: 'step_success',
231
+ requiresErrorBlock: false,
232
+ },
233
+ },
234
+ ];
235
+ /**
236
+ * 兜底 META(未知 code 时返回)
237
+ *
238
+ * 接收方收到未知 code 时降级到 step_progress,避免阻塞协议处理。
239
+ */
240
+ const FALLBACK_META = {
241
+ isTerminal: false,
242
+ status: MessageStatus.IN_PROGRESS,
243
+ level: 'INFO',
244
+ semantic: 'step_progress',
245
+ requiresErrorBlock: false,
246
+ };
247
+ /**
248
+ * 单一 code 解析入口
249
+ *
250
+ * 解析顺序:
251
+ * 1. 终态显式表(EXPLICIT_META) — 30 个 closed enum
252
+ * 2. 后缀规则(SUFFIX_RULES) — 9 条规则覆盖数百个进度 code
253
+ * 3. 兜底(FALLBACK_META) — 未知 code 降级
254
+ *
255
+ * @param code report.code 字符串
256
+ * @returns CodeMeta — status / level / semantic / requiresErrorBlock / isTerminal
257
+ */
258
+ function resolveCodeMeta(code) {
259
+ if (exports.EXPLICIT_META[code]) {
260
+ return exports.EXPLICIT_META[code];
261
+ }
262
+ for (const rule of SUFFIX_RULES) {
263
+ if (rule.suffix && code.endsWith(rule.suffix)) {
264
+ return { isTerminal: false, ...rule.meta };
265
+ }
266
+ if (rule.infix && code.includes(rule.infix)) {
267
+ return { isTerminal: false, ...rule.meta };
268
+ }
269
+ }
270
+ return FALLBACK_META;
271
+ }
272
+ /**
273
+ * 判断 code 是否已知(命中显式表或后缀规则,不走兜底)
274
+ */
275
+ function isKnownCode(code) {
276
+ if (exports.EXPLICIT_META[code])
277
+ return true;
278
+ for (const rule of SUFFIX_RULES) {
279
+ if (rule.suffix && code.endsWith(rule.suffix))
280
+ return true;
281
+ if (rule.infix && code.includes(rule.infix))
282
+ return true;
283
+ }
284
+ return false;
285
+ }
286
+ //# sourceMappingURL=code-meta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"code-meta.js","sourceRoot":"","sources":["../src/code-meta.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAkTH,0CAaC;AAKD,kCAOC;AAnUD,uEAAuE;AACvE,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,wCAAuB,CAAA;AACzB,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB;AAoCD;;;;;GAKG;AACU,QAAA,aAAa,GAA6B;IACrD,uCAAuC;IACvC,iBAAiB,EAAE;QACjB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,MAAqB;QAC5B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,KAAK;KAC1B;IACD,2BAA2B,EAAE;QAC3B,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,SAAwB;QAC/B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,KAAK;KAC1B;IACD,kBAAkB,EAAE;QAClB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAsB;QAC7B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,IAAI;KACzB;IACD,mBAAmB,EAAE;QACnB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,MAAqB;QAC5B,QAAQ,EAAE,OAAO;QACjB,kBAAkB,EAAE,KAAK;KAC1B;IACD,qBAAqB,EAAE;QACrB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAsB;QAC7B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,IAAI;KACzB;IACD,mBAAmB,EAAE;QACnB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,SAAwB;QAC/B,QAAQ,EAAE,MAAM;QAChB,kBAAkB,EAAE,IAAI;KACzB;IACD,wBAAwB,EAAE;QACxB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,SAAwB;QAC/B,QAAQ,EAAE,QAAQ;QAClB,kBAAkB,EAAE,IAAI;KACzB;IAED,iDAAiD;IACjD,0BAA0B,EAAE;QAC1B,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,MAAqB;QAC5B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,KAAK;KAC1B;IACD,8BAA8B,EAAE;QAC9B,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,SAAwB;QAC/B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,KAAK;KAC1B;IACD,2BAA2B,EAAE;QAC3B,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,OAAsB;QAC7B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,IAAI;KACzB;IACD,sBAAsB,EAAE;QACtB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAsB;QAC7B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,IAAI;KACzB;IACD,oBAAoB,EAAE;QACpB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,SAAwB;QAC/B,QAAQ,EAAE,MAAM;QAChB,kBAAkB,EAAE,IAAI;KACzB;IAED,qDAAqD;IACrD,kCAAkC,EAAE;QAClC,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,SAAS;QAC/B,KAAK,EAAE,MAAqB;QAC5B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,KAAK;KAC1B;IACD,iCAAiC,EAAE;QACjC,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAsB;QAC7B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,IAAI;KACzB;IAED,0CAA0C;IAC1C,4CAA4C;IAC5C,qCAAqC;IACrC,0DAA0D;IAC1D,qBAAqB,EAAE;QACrB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAsB;QAC7B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,IAAI;KACzB;IACD,qBAAqB,EAAE;QACrB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,aAAa,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAsB;QAC7B,QAAQ,EAAE,SAAS;QACnB,kBAAkB,EAAE,IAAI;KACzB;CACF,CAAC;AAkBF,MAAM,YAAY,GAAiB;IACjC;QACE,MAAM,EAAE,SAAS;QACjB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,OAAsB;YAC7B,QAAQ,EAAE,cAAc;YACxB,kBAAkB,EAAE,IAAI;SACzB;KACF;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,SAAwB;YAC/B,QAAQ,EAAE,eAAe;YACzB,kBAAkB,EAAE,KAAK;SAC1B;KACF;IACD;QACE,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,SAAwB;YAC/B,QAAQ,EAAE,OAAO;YACjB,kBAAkB,EAAE,KAAK;SAC1B;KACF;IACD;QACE,+CAA+C;QAC/C,KAAK,EAAE,OAAO;QACd,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,SAAwB;YAC/B,QAAQ,EAAE,SAAS;YACnB,kBAAkB,EAAE,KAAK;SAC1B;KACF;IACD;QACE,MAAM,EAAE,UAAU;QAClB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,MAAqB;YAC5B,QAAQ,EAAE,cAAc;YACxB,kBAAkB,EAAE,KAAK;SAC1B;KACF;IACD;QACE,MAAM,EAAE,YAAY;QACpB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,MAAqB;YAC5B,QAAQ,EAAE,WAAW;YACrB,kBAAkB,EAAE,KAAK;SAC1B;KACF;IACD;QACE,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,MAAqB;YAC5B,QAAQ,EAAE,aAAa;YACvB,kBAAkB,EAAE,KAAK;SAC1B;KACF;IACD;QACE,MAAM,EAAE,WAAW;QACnB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,MAAqB;YAC5B,QAAQ,EAAE,eAAe;YACzB,kBAAkB,EAAE,KAAK;SAC1B;KACF;IACD;QACE,MAAM,EAAE,UAAU;QAClB,IAAI,EAAE;YACJ,MAAM,EAAE,aAAa,CAAC,WAAW;YACjC,KAAK,EAAE,MAAqB;YAC5B,QAAQ,EAAE,cAAc;YACxB,kBAAkB,EAAE,KAAK;SAC1B;KACF;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,aAAa,GAAa;IAC9B,UAAU,EAAE,KAAK;IACjB,MAAM,EAAE,aAAa,CAAC,WAAW;IACjC,KAAK,EAAE,MAAqB;IAC5B,QAAQ,EAAE,eAAe;IACzB,kBAAkB,EAAE,KAAK;CAC1B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,IAAY;IAC1C,IAAI,qBAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,qBAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9C,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC;IACH,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,IAAI,qBAAa,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,CAAC;QAC3D,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;IAC3D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
package/dist/index.d.ts CHANGED
@@ -6,7 +6,10 @@
6
6
  * 1. 统一消息格式定义
7
7
  * 2. 支持设备注册、命令执行、心跳等核心功能
8
8
  * 3. 支持 Edge 代理模式
9
+ *
10
+ * v1.6.0:单一 MessageStatus + CodeMeta + dispatchMessage(详见 code-meta.ts)
9
11
  */
12
+ import { MessageStatus } from './code-meta';
10
13
  export declare enum MessageType {
11
14
  REGISTER = "REGISTER",
12
15
  REGISTER_ACK = "REGISTER_ACK",
@@ -48,13 +51,7 @@ export declare enum Priority {
48
51
  CRITICAL = "CRITICAL",
49
52
  EMERGENCY = "EMERGENCY"
50
53
  }
51
- export declare enum CommandStatus {
52
- COMPLETED = "COMPLETED",
53
- FAILED = "FAILED",
54
- TIMEOUT = "TIMEOUT",
55
- CANCELLED = "CANCELLED",
56
- IN_PROGRESS = "IN_PROGRESS"
57
- }
54
+ export { MessageStatus, type CodeMeta, type CodeSemantic, resolveCodeMeta, isKnownCode, EXPLICIT_META } from './code-meta';
58
55
  export interface BaseMessage {
59
56
  type: MessageType;
60
57
  timestamp: string;
@@ -212,7 +209,7 @@ export interface CommandResponseMessage extends BaseMessage {
212
209
  type: MessageType.COMMAND_RESPONSE;
213
210
  clientId: string;
214
211
  requestRef: string;
215
- status: CommandStatus;
212
+ status: MessageStatus;
216
213
  result?: CommandResult;
217
214
  report?: ReportMessage;
218
215
  executionTime?: number;
@@ -288,7 +285,7 @@ export interface ProgramResponseMessage extends BaseMessage {
288
285
  type: MessageType.PROGRAM_RESPONSE;
289
286
  clientId: string;
290
287
  requestRef: string;
291
- status: CommandStatus;
288
+ status: MessageStatus;
292
289
  context?: ProgramContext;
293
290
  report?: ReportMessage;
294
291
  executionTime?: number;
@@ -338,14 +335,6 @@ export interface DeviceOperationRecord {
338
335
  operationType: OperationType;
339
336
  result?: Record<string, any>;
340
337
  }
341
- export declare enum ProgressStatus {
342
- PENDING = "PENDING",
343
- IN_PROGRESS = "IN_PROGRESS",
344
- PAUSED = "PAUSED",
345
- COMPLETED = "COMPLETED",
346
- FAILED = "FAILED",
347
- CANCELLED = "CANCELLED"
348
- }
349
338
  export interface ProgramContext {
350
339
  taskId: string;
351
340
  programId: string;
@@ -361,8 +350,8 @@ export declare enum ReportLevel {
361
350
  CRITICAL = "CRITICAL"
362
351
  }
363
352
  export type ErrorCategory = 'TRANSPORT' | 'TIMEOUT' | 'RESOURCE' | 'BUSINESS' | 'CONFIGURATION' | 'PROTOCOL' | 'AUTHORIZATION';
364
- export type ErrorPhase = 'PROGRAM_INIT' | 'PROGRAM_FETCH' | 'PROGRAM_EXTRACT' | 'PROGRAM_PREPROCESS' | 'PROGRAM_COMPILE' | 'PROGRAM_UPLOAD' | 'PROGRAM_STATS' | 'PROGRAM_COMPLETE' | 'DETECT_INIT' | 'SWITCH_DETECT' | 'SWITCH_CONFIG_READ' | 'SYNC_DETECT' | 'BARGRAPH_DETECT' | 'RATER_DETECT' | 'SYNC_RECOVER' | 'DETECT_COMPLETE' | 'SYNC_EXPORT' | 'BATCH_EXECUTE';
365
- export type ErrorStep = 'ValidateParameters' | 'PrepareResources' | 'LoadConfig' | 'CheckConcurrency' | 'Download' | 'VerifyChecksum' | 'ExtractZip' | 'ResizeImage' | 'AdjustColor' | 'GammaCorrect' | 'Histogram' | 'RGBCorrection' | 'CompileFrame' | 'MoveFrame' | 'VerifyFrameCount' | 'DeviceCheck' | 'DataTransfer' | 'ForbiddenTable' | 'StatusRecovery' | 'RetryLimitExceeded' | 'CloudReport';
353
+ export type ErrorPhase = 'PROGRAM_INIT' | 'PROGRAM_FETCH' | 'PROGRAM_EXTRACT' | 'PROGRAM_PREPROCESS' | 'PROGRAM_COMPILE' | 'PROGRAM_UPLOAD' | 'PROGRAM_STATS' | 'PROGRAM_COMPLETE' | 'DETECT_INIT' | 'SWITCH_DETECT' | 'SWITCH_CONFIG_READ' | 'SYNC_DETECT' | 'BARGRAPH_DETECT' | 'RATER_DETECT' | 'SYNC_RECOVER' | 'DETECT_COMPLETE' | 'SYNC_EXPORT' | 'BATCH_EXECUTE' | 'EDGE_PROXY';
354
+ export type ErrorStep = 'ValidateParameters' | 'PrepareResources' | 'LoadConfig' | 'CheckConcurrency' | 'Download' | 'VerifyChecksum' | 'ExtractZip' | 'ResizeImage' | 'AdjustColor' | 'GammaCorrect' | 'Histogram' | 'RGBCorrection' | 'CompileFrame' | 'MoveFrame' | 'VerifyFrameCount' | 'DeviceCheck' | 'DataTransfer' | 'ForbiddenTable' | 'StatusRecovery' | 'RetryLimitExceeded' | 'CloudReport' | 'ValidateCommandFormat' | 'CheckDeviceOnline' | 'DispatchToDevice' | 'AwaitDeviceResponse';
366
355
  export interface ErrorInfo {
367
356
  phase: ErrorPhase;
368
357
  step: ErrorStep;
@@ -384,7 +373,7 @@ export interface ProgressUpdateMessage extends BaseMessage {
384
373
  type: MessageType.PROGRESS_UPDATE;
385
374
  clientId: string;
386
375
  requestRef: string;
387
- status: ProgressStatus;
376
+ status: MessageStatus;
388
377
  phase: ProgressPhase | string;
389
378
  progress: number;
390
379
  sourceType: ProgressSourceType;
@@ -474,7 +463,7 @@ export declare class MessageFactory {
474
463
  * 创建进度更新消息
475
464
  */
476
465
  static createProgressUpdateMessage(clientId: string, // 添加:上报设备标识
477
- requestRef: string, phase: ProgressPhase | string, progress: number, message?: string, status?: ProgressStatus, options?: {
466
+ requestRef: string, phase: ProgressPhase | string, progress: number, message?: string, status?: MessageStatus, options?: {
478
467
  level?: ReportLevel;
479
468
  code?: string;
480
469
  data?: Record<string, any>;
@@ -485,7 +474,7 @@ export declare class MessageFactory {
485
474
  * 创建命令响应消息 (Backend 急需)
486
475
  */
487
476
  static createCommandResponseMessage(clientId: string, // 添加:响应设备标识
488
- requestRef: string, status: CommandStatus, result: any, message?: string, options?: {
477
+ requestRef: string, status: MessageStatus, result: any, message?: string, options?: {
489
478
  executionTime?: number;
490
479
  report?: ReportMessage;
491
480
  version?: string;
@@ -495,7 +484,7 @@ export declare class MessageFactory {
495
484
  * 创建程序响应消息
496
485
  */
497
486
  static createProgramResponseMessage(clientId: string, // 添加:响应设备标识
498
- requestRef: string, status: CommandStatus, result: any, message?: string, options?: {
487
+ requestRef: string, status: MessageStatus, result: any, message?: string, options?: {
499
488
  executionTime?: number;
500
489
  programStartTime?: number;
501
490
  }): ProgramResponseMessage;
@@ -542,9 +531,47 @@ export declare class MessageFactory {
542
531
  */
543
532
  static createUpdateRoutesAckMessage(clientId: string, // 改为 clientId,统一命名
544
533
  success: boolean, message?: string, routeCount?: number): UpdateRoutesAckMessage;
534
+ /**
535
+ * v1.6.0: 统一消息派发接口
536
+ *
537
+ * 设备端发送终态消息(COMMAND_RESPONSE / PROGRAM_RESPONSE)或进度消息(PROGRESS_UPDATE)时,
538
+ * 只需要提供 code 和业务字段,协议层通过 CodeMeta 自动推导 status / level / 消息类型。
539
+ *
540
+ * 替代旧的 createCommandResponseMessage / createProgramResponseMessage / createProgressUpdateMessage。
541
+ *
542
+ * @param params dispatch 参数
543
+ * @returns 完整的协议消息(具体类型由 code 派生的 isTerminal 决定)
544
+ * @throws Error 当 code 要求 data.error 但 params.error 缺失时
545
+ */
546
+ static dispatchMessage(params: {
547
+ clientId: string;
548
+ requestRef: string;
549
+ code: string;
550
+ message: string;
551
+ /** 终态消息:result 块;进度消息:业务平铺字段 */
552
+ data?: Record<string, any>;
553
+ /** v1.5.0 失败 schema — 当 code 要求时必填 */
554
+ error?: {
555
+ phase: string;
556
+ step: string;
557
+ category: string;
558
+ detail: string;
559
+ };
560
+ /** 仅进度消息:phase 与 progress */
561
+ phase?: ProgressPhase | string;
562
+ progress?: number;
563
+ /** 进度消息 sourceType(默认 COMMAND)*/
564
+ sourceType?: ProgressSourceType;
565
+ /** 终态消息 result 块(COMMAND_RESPONSE)*/
566
+ result?: any;
567
+ /** 终态消息 context(PROGRAM_RESPONSE)*/
568
+ context?: ProgramContext;
569
+ /** 终态消息 executionTime */
570
+ executionTime?: number;
571
+ }): CommandResponseMessage | ProgramResponseMessage | ProgressUpdateMessage;
545
572
  }
546
573
  export type AnyMessage = RegisterMessage | RegisterAckMessage | UnregisterMessage | UnregisterAckMessage | CommandMessage | CommandResponseMessage | ProgramMessage | ProgramResponseMessage | HeartbeatMessage | HeartbeatAckMessage | ProgressUpdateMessage | UpdateRoutesMessage | UpdateRoutesAckMessage | RegisterPendingMessage | AuthorizationGrantedMessage | AuthorizationRejectedMessage | DeviceApprovalRequestMessage | DeviceApprovalResponseMessage | ErrorMessage;
547
- export declare const PROTOCOL_VERSION = "1.5.0";
574
+ export declare const PROTOCOL_VERSION = "1.6.1";
548
575
  export declare const DEFAULT_TIMEOUT = 10000;
549
576
  export declare const DEFAULT_PRIORITY = Priority.NORMAL;
550
577
  export * from './command-types';