advisers 0.2.3 → 0.3.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/LICENSE +0 -0
- package/NOTICE +0 -0
- package/README-zh.md +15 -6
- package/README.md +22 -6
- package/THIRD-PARTY-NOTICES.md +1 -1
- package/bin/advisers.js +3323 -222
- package/index.js +1 -1
- package/lib/agent.js +0 -0
- package/lib/attachments.js +0 -0
- package/lib/audit-anchor.js +683 -0
- package/lib/backup.js +1345 -0
- package/lib/capture.js +0 -0
- package/lib/context-window.js +0 -0
- package/lib/digest.js +0 -0
- package/lib/doc-review.js +0 -0
- package/lib/egress.js +0 -0
- package/lib/error-codes.js +1373 -0
- package/lib/evidence.js +202 -26
- package/lib/fs-safe.js +70 -7
- package/lib/ical.js +0 -0
- package/lib/imap.js +6 -2
- package/lib/importers.js +0 -0
- package/lib/learning.js +0 -0
- package/lib/ledger-read.js +608 -0
- package/lib/mcp-server.js +294 -38
- package/lib/model.js +0 -0
- package/lib/node-warning-filter.js +15 -0
- package/lib/notify.js +13 -3
- package/lib/nudge.js +0 -0
- package/lib/ocr.js +0 -0
- package/lib/pdf.js +0 -0
- package/lib/pet-brief-store.js +0 -0
- package/lib/pet-brief.js +102 -39
- package/lib/receipt-verify.js +213 -15
- package/lib/relative-date.js +0 -0
- package/lib/remind.js +91 -36
- package/lib/research.js +0 -0
- package/lib/review.js +0 -0
- package/lib/routine.js +0 -0
- package/lib/safety/classifier.js +0 -0
- package/lib/safety/explain.js +0 -0
- package/lib/safety/index.js +0 -0
- package/lib/safety/redact.js +0 -0
- package/lib/safety/rules.js +0 -0
- package/lib/scheduler.js +0 -0
- package/lib/source.js +0 -0
- package/lib/sqlite.js +1214 -24
- package/lib/sync.js +0 -0
- package/lib/text-safe.js +229 -0
- package/lib/timestamp.js +0 -0
- package/lib/tos/index.js +1 -1
- package/lib/tos/manifest.json +6 -6
- package/lib/tos/privacy.zh-CN.md +12 -9
- package/lib/tos/safety.zh-CN.md +4 -3
- package/lib/tos/summary.zh-CN.md +3 -3
- package/lib/tos/terms.zh-CN.md +8 -6
- package/lib/tui/color.js +164 -0
- package/lib/tui/index.js +33 -0
- package/lib/tui/json.js +124 -0
- package/lib/tui/labels.js +50 -0
- package/lib/tui/policy.js +108 -0
- package/lib/tui/render.js +371 -0
- package/lib/tui/sanitize.js +142 -0
- package/lib/tui/text-file.js +116 -0
- package/lib/tui/width.js +577 -0
- package/lib/ui.js +0 -0
- package/lib/undo.js +0 -0
- package/lib/untrusted.js +0 -0
- package/lib/vault.js +0 -0
- package/package.json +6 -5
package/lib/sync.js
CHANGED
|
File without changes
|
package/lib/text-safe.js
ADDED
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Text safety primitives for terminal, console and log output (0.3.0 output kernel).
|
|
3
|
+
*
|
|
4
|
+
* This module is the single low-level chokepoint for text that originated outside the
|
|
5
|
+
* program: model output, tool results, IMAP greetings/status lines, webhook response
|
|
6
|
+
* bodies, parsed documents and any other remote or user-editable content. It removes
|
|
7
|
+
* the characters that can forge terminal state or log lines, without interpreting the
|
|
8
|
+
* payload:
|
|
9
|
+
*
|
|
10
|
+
* - escape sequences: CSI, OSC, DCS, SOS, PM, APC and the 8-bit C1 introducers;
|
|
11
|
+
* - remaining C0 controls (NUL/BEL/CR/...) and C1 controls (0x80-0x9F);
|
|
12
|
+
* - bidi overrides/isolates and zero-width/bidi marks that can reorder a rendered
|
|
13
|
+
* path or hide text (U+061C, U+200B-U+200F, U+202A-U+202E, U+2066-U+2069, U+FEFF);
|
|
14
|
+
* - line breaks: a console/log line must stay exactly one line.
|
|
15
|
+
*
|
|
16
|
+
* Invariants:
|
|
17
|
+
* - sanitizeConsoleText() always returns a single-line string with no ESC, CR, LF, NUL,
|
|
18
|
+
* BEL or C1 bytes; the returned string's length (in code points) is <= max.
|
|
19
|
+
* - Normal text - Chinese punctuation, emoji, combining sequences - is preserved;
|
|
20
|
+
* the module strips control characters, it does not transliterate or escape data.
|
|
21
|
+
* - No I/O, no dependencies beyond node:util.
|
|
22
|
+
*
|
|
23
|
+
* Callers: lib/tui/sanitize.js builds the display policy on top of these primitives.
|
|
24
|
+
* lib/notify.js (webhook response body) and lib/imap.js (server greeting/status) are
|
|
25
|
+
* expected to call sanitizeConsoleText() before writing remote text to stderr or
|
|
26
|
+
* reminders.log; that wiring lands with the Wave-2 CLI integration.
|
|
27
|
+
*/
|
|
28
|
+
/** Default cap (in code points) for a console/log line. */
|
|
29
|
+
export const DEFAULT_CONSOLE_TEXT_MAX = 2000
|
|
30
|
+
|
|
31
|
+
/** Marker appended when sanitizeConsoleText() truncates a value. */
|
|
32
|
+
export const TRUNCATION_MARK = '…'
|
|
33
|
+
|
|
34
|
+
const ESC = 0x1b
|
|
35
|
+
const BEL = 0x07
|
|
36
|
+
const ST_8BIT = 0x9c
|
|
37
|
+
const CSI_8BIT = 0x9b
|
|
38
|
+
const OSC_8BIT = 0x9d
|
|
39
|
+
const DCS_8BIT = 0x90
|
|
40
|
+
const PM_8BIT = 0x9e
|
|
41
|
+
const APC_8BIT = 0x9f
|
|
42
|
+
|
|
43
|
+
const BIDI_CONTROL_PATTERN = /[\u061C\u200B-\u200F\u202A-\u202E\u2066-\u2069\uFEFF]/g
|
|
44
|
+
// Each pattern keeps the character(s) named in the constant and removes the rest.
|
|
45
|
+
const C0_EXCEPT_LINE_CHARS = /[\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F]/g // keeps \t and \n
|
|
46
|
+
const C0_EXCEPT_NEWLINE = /[\u0000-\u0009\u000B-\u001F\u007F]/g // keeps \n only
|
|
47
|
+
const C0_EXCEPT_TAB = /[\u0000-\u0008\u000A-\u001F\u007F]/g // keeps \t only
|
|
48
|
+
const C0_ALL = /[\u0000-\u001F\u007F]/g
|
|
49
|
+
const C1_CONTROLS = /[\u0080-\u009F]/g
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Remove the UTF-8 BOM (U+FEFF) if it is the first character.
|
|
53
|
+
*
|
|
54
|
+
* Only the leading BOM is removed: a U+FEFF inside the payload is data (and is
|
|
55
|
+
* stripped by stripBidiControls() for display, but not here).
|
|
56
|
+
*
|
|
57
|
+
* @param {unknown} value
|
|
58
|
+
* @returns {string}
|
|
59
|
+
*/
|
|
60
|
+
export function stripBom(value) {
|
|
61
|
+
if (typeof value !== 'string' || value.length === 0) return typeof value === 'string' ? value : ''
|
|
62
|
+
return value.charCodeAt(0) === 0xfeff ? value.slice(1) : value
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Remove terminal escape sequences (ESC/CSI/OSC/DCS/SOS/PM/APC) and the 8-bit C1
|
|
67
|
+
* introducers with their payloads. Other characters, including plain C0/C1 controls,
|
|
68
|
+
* are left untouched for the caller to decide about.
|
|
69
|
+
*
|
|
70
|
+
* @param {unknown} value
|
|
71
|
+
* @returns {string}
|
|
72
|
+
*/
|
|
73
|
+
export function stripTerminalSequences(value) {
|
|
74
|
+
if (value === null || value === undefined) return ''
|
|
75
|
+
const text = typeof value === 'string' ? value : String(value)
|
|
76
|
+
if (text.length === 0) return ''
|
|
77
|
+
let out = ''
|
|
78
|
+
let index = 0
|
|
79
|
+
while (index < text.length) {
|
|
80
|
+
const code = text.charCodeAt(index)
|
|
81
|
+
if (code === ESC) {
|
|
82
|
+
index = skipEscapeSequence(text, index)
|
|
83
|
+
continue
|
|
84
|
+
}
|
|
85
|
+
if (code === CSI_8BIT || code === OSC_8BIT || code === DCS_8BIT || code === PM_8BIT || code === APC_8BIT || (code >= 0x91 && code <= 0x97)) {
|
|
86
|
+
index = skipC1Sequence(text, index)
|
|
87
|
+
continue
|
|
88
|
+
}
|
|
89
|
+
out += text[index]
|
|
90
|
+
index += 1
|
|
91
|
+
}
|
|
92
|
+
return out
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Remove bidi controls and zero-width bidi marks that can visually reorder or hide
|
|
97
|
+
* text (Trojan-Source class). Normal CJK punctuation and emoji are preserved.
|
|
98
|
+
*
|
|
99
|
+
* @param {unknown} value
|
|
100
|
+
* @returns {string}
|
|
101
|
+
*/
|
|
102
|
+
export function stripBidiControls(value) {
|
|
103
|
+
if (value === null || value === undefined) return ''
|
|
104
|
+
const text = typeof value === 'string' ? value : String(value)
|
|
105
|
+
return text.replace(BIDI_CONTROL_PATTERN, '')
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Remove remaining C0/C1 controls, optionally keeping line structure.
|
|
110
|
+
*
|
|
111
|
+
* @param {unknown} value
|
|
112
|
+
* @param {{ keepNewlines?: boolean, keepTabs?: boolean, replacement?: string }} [options]
|
|
113
|
+
* @returns {string}
|
|
114
|
+
*/
|
|
115
|
+
export function stripControlChars(value, { keepNewlines = true, keepTabs = true, replacement = ' ' } = {}) {
|
|
116
|
+
if (value === null || value === undefined) return ''
|
|
117
|
+
let text = typeof value === 'string' ? value : String(value)
|
|
118
|
+
if (keepNewlines && keepTabs) text = text.replace(C0_EXCEPT_LINE_CHARS, replacement)
|
|
119
|
+
else if (keepNewlines) text = text.replace(C0_EXCEPT_NEWLINE, replacement)
|
|
120
|
+
else if (keepTabs) text = text.replace(C0_EXCEPT_TAB, replacement)
|
|
121
|
+
else text = text.replace(C0_ALL, replacement)
|
|
122
|
+
return text.replace(C1_CONTROLS, replacement)
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Render an arbitrary value as one safe console/log line.
|
|
127
|
+
*
|
|
128
|
+
* Pipeline: strip escape sequences -> fold CR/LF to spaces -> remove bidi/zero-width
|
|
129
|
+
* marks -> replace remaining C0/C1 controls with spaces -> collapse spaces -> trim ->
|
|
130
|
+
* truncate to max code points (with a truncation marker inside the budget).
|
|
131
|
+
*
|
|
132
|
+
* The result never contains ESC, BEL, CR, LF or C1 controls; it is always one line.
|
|
133
|
+
*
|
|
134
|
+
* @param {unknown} value any value; null/undefined become ''
|
|
135
|
+
* @param {{ max?: number, keepTabs?: boolean, ellipsis?: string }} [options]
|
|
136
|
+
* @returns {string}
|
|
137
|
+
*/
|
|
138
|
+
export function sanitizeConsoleText(value, { max = DEFAULT_CONSOLE_TEXT_MAX, keepTabs = true, ellipsis = TRUNCATION_MARK } = {}) {
|
|
139
|
+
if (value === null || value === undefined) return ''
|
|
140
|
+
const raw = typeof value === 'string' ? value : String(value)
|
|
141
|
+
let text = stripTerminalSequences(raw)
|
|
142
|
+
text = text.replace(/\r\n?/g, ' ').replace(/\n+/g, ' ')
|
|
143
|
+
if (!keepTabs) text = text.replace(/\t+/g, ' ')
|
|
144
|
+
text = stripBidiControls(text)
|
|
145
|
+
text = text.replace(C0_EXCEPT_LINE_CHARS, ' ')
|
|
146
|
+
text = text.replace(C1_CONTROLS, ' ')
|
|
147
|
+
text = text.replace(/ {2,}/g, ' ').trim()
|
|
148
|
+
return truncateCodePoints(text, normalizeMax(max), String(ellipsis))
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
function normalizeMax(max) {
|
|
152
|
+
if (!Number.isSafeInteger(max) || max < 0) return DEFAULT_CONSOLE_TEXT_MAX
|
|
153
|
+
return max
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
function truncateCodePoints(text, max, ellipsis) {
|
|
157
|
+
if (max <= 0) return ''
|
|
158
|
+
const codePoints = Array.from(text)
|
|
159
|
+
if (codePoints.length <= max) return text
|
|
160
|
+
const mark = Array.from(ellipsis)
|
|
161
|
+
if (mark.length >= max) return codePoints.slice(0, max).join('')
|
|
162
|
+
return codePoints.slice(0, max - mark.length).join('') + ellipsis
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
function skipEscapeSequence(text, start) {
|
|
166
|
+
const length = text.length
|
|
167
|
+
if (start + 1 >= length) return length
|
|
168
|
+
const next = text.charCodeAt(start + 1)
|
|
169
|
+
if (next === 0x5b) return skipCsiPayload(text, start + 2)
|
|
170
|
+
if (next === 0x5d) return skipOscPayload(text, start + 2)
|
|
171
|
+
if (next === 0x50 || next === 0x58 || next === 0x5e || next === 0x5f) return skipStringPayload(text, start + 2)
|
|
172
|
+
if (next >= 0x20 && next <= 0x2f) {
|
|
173
|
+
let index = start + 1
|
|
174
|
+
while (index < length) {
|
|
175
|
+
const code = text.charCodeAt(index)
|
|
176
|
+
if (code < 0x20 || code > 0x2f) break
|
|
177
|
+
index += 1
|
|
178
|
+
}
|
|
179
|
+
if (index < length && text.charCodeAt(index) >= 0x30 && text.charCodeAt(index) <= 0x7e) return index + 1
|
|
180
|
+
return index
|
|
181
|
+
}
|
|
182
|
+
if (next >= 0x30 && next <= 0x7e) return start + 2
|
|
183
|
+
return start + 1
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
function skipCsiPayload(text, start) {
|
|
187
|
+
const length = text.length
|
|
188
|
+
let index = start
|
|
189
|
+
while (index < length) {
|
|
190
|
+
const code = text.charCodeAt(index)
|
|
191
|
+
if (code >= 0x40 && code <= 0x7e) return index + 1
|
|
192
|
+
index += 1
|
|
193
|
+
}
|
|
194
|
+
return length
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
function skipOscPayload(text, start) {
|
|
198
|
+
const length = text.length
|
|
199
|
+
let index = start
|
|
200
|
+
while (index < length) {
|
|
201
|
+
const code = text.charCodeAt(index)
|
|
202
|
+
if (code === BEL || code === ST_8BIT) return index + 1
|
|
203
|
+
if (code === ESC && index + 1 < length && text.charCodeAt(index + 1) === 0x5c) return index + 2
|
|
204
|
+
index += 1
|
|
205
|
+
}
|
|
206
|
+
return length
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
function skipStringPayload(text, start) {
|
|
210
|
+
const length = text.length
|
|
211
|
+
let index = start
|
|
212
|
+
while (index < length) {
|
|
213
|
+
const code = text.charCodeAt(index)
|
|
214
|
+
if (code === ST_8BIT) return index + 1
|
|
215
|
+
if (code === ESC && index + 1 < length && text.charCodeAt(index + 1) === 0x5c) return index + 2
|
|
216
|
+
index += 1
|
|
217
|
+
}
|
|
218
|
+
return length
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
function skipC1Sequence(text, start) {
|
|
222
|
+
const length = text.length
|
|
223
|
+
const introducer = text.charCodeAt(start)
|
|
224
|
+
if (introducer === CSI_8BIT) return skipCsiPayload(text, start + 1)
|
|
225
|
+
if (introducer === OSC_8BIT) return skipOscPayload(text, start + 1)
|
|
226
|
+
return skipStringPayload(text, start + 1)
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
|
package/lib/timestamp.js
CHANGED
|
File without changes
|
package/lib/tos/index.js
CHANGED
|
@@ -214,7 +214,7 @@ export function summaryLines({ version = currentTos().version, url = ONLINE_TOS_
|
|
|
214
214
|
'3. 本地优先助手,不提供法律/医疗/财务等专业意见;AI 输出可能出错,请自行核验并承担对外使用后果。',
|
|
215
215
|
'4. 禁止违法与有害用途:违法内容、诈骗、侵权、危害未成年人、深度伪造或逃避 AI 标识等(详见第 4 条)。',
|
|
216
216
|
'5. 你是内容安全审核与 AI 生成内容标识的第一责任人。',
|
|
217
|
-
'6. 数据默认留在本机;设置 ADVISERS_API_KEY
|
|
217
|
+
'6. 数据默认留在本机;设置 ADVISERS_API_KEY 后,相关输入会发送给你配置的模型服务;运行 bridge(Hermes 文件网关)时,本软件按轮询持续与 Hermes 交换明文 JSON 并可能经其平台出网,受保护事项模型调用 fail-closed。',
|
|
218
218
|
'7. 免责与责任限制:按“现状”提供;免费版本累计赔偿责任上限为人民币壹佰元(¥100),法律不得排除的责任除外。',
|
|
219
219
|
'8. 管辖:适用中华人民共和国法律;争议由运营者住所地有管辖权的人民法院管辖(第 15.2 条)。',
|
|
220
220
|
'9. 修改人格/例行、数据替换等操作每次会再次确认;TTS/DLC 在 0.2.0 不提供,未来将另行取得明确同意。',
|
package/lib/tos/manifest.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schema": "advisers.tos/1",
|
|
3
|
-
"version": "2026.11.
|
|
4
|
-
"effectiveFrom": "2026-11-
|
|
3
|
+
"version": "2026.11.3",
|
|
4
|
+
"effectiveFrom": "2026-11-20",
|
|
5
5
|
"language": "zh-CN",
|
|
6
6
|
"canonical": "docs/TOS.md",
|
|
7
7
|
"shortNotice": "docs/DISCLAIMER.md",
|
|
@@ -11,22 +11,22 @@
|
|
|
11
11
|
{
|
|
12
12
|
"path": "terms.zh-CN.md",
|
|
13
13
|
"source": "docs/TOS.md",
|
|
14
|
-
"sha256": "
|
|
14
|
+
"sha256": "6d508bd73eeac133f4a6b86df1ce0e4130acdfe65105b05137ccc3b2f4df28b0"
|
|
15
15
|
},
|
|
16
16
|
{
|
|
17
17
|
"path": "summary.zh-CN.md",
|
|
18
18
|
"source": "docs/DISCLAIMER.md",
|
|
19
|
-
"sha256": "
|
|
19
|
+
"sha256": "3deb9737a2a9e6eb2670e0d5d4b3af30e457b371f4658dd32ba2dcedf9b31b9c"
|
|
20
20
|
},
|
|
21
21
|
{
|
|
22
22
|
"path": "privacy.zh-CN.md",
|
|
23
23
|
"source": "docs/PRIVACY.md",
|
|
24
|
-
"sha256": "
|
|
24
|
+
"sha256": "26bb26e87abc399d253c671204eaf5706a1b0d219a1d50b3f48c59649b5753bc"
|
|
25
25
|
},
|
|
26
26
|
{
|
|
27
27
|
"path": "safety.zh-CN.md",
|
|
28
28
|
"source": "docs/SAFETY.md",
|
|
29
|
-
"sha256": "
|
|
29
|
+
"sha256": "08db776bf742741118fe75b21f1342fcfb9cf3584f15bcd8e6753f619a9afd0b"
|
|
30
30
|
}
|
|
31
31
|
]
|
|
32
32
|
}
|
package/lib/tos/privacy.zh-CN.md
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
| 项目 | 内容 |
|
|
4
4
|
|---|---|
|
|
5
|
-
| 文档版本 | 2026.11.
|
|
6
|
-
| 生效日期 | 2026-11-
|
|
5
|
+
| 文档版本 | 2026.11.3(与 docs/TOS.md 同版本) |
|
|
6
|
+
| 生效日期 | 2026-11-20 |
|
|
7
7
|
| 适用对象 | Advisers 用户、部署者与集成方 |
|
|
8
8
|
| 运营者 | PerryLink(本项目维护者,GitHub: https://github.com/PerryLink);联系与投诉渠道见第 12 节 |
|
|
9
9
|
| 语言效力 | 中文版为准;翻译仅供参考 |
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
## 1. 一句话结论
|
|
14
14
|
|
|
15
|
-
Advisers
|
|
15
|
+
Advisers 默认在本机运行:**没有账号、没有遥测、没有云服务、没有运营者服务器、没有自动更新检查**。你的数据默认保存在你的设备上;只有在你主动启用模型、网页研究、邮件导入、通知、同步、桥接(bridge/Hermes 文件网关)、MCP/DSH/桌宠等能力时,相关内容才会发送给你配置的第三方服务商,受其条款与隐私政策约束。
|
|
16
16
|
|
|
17
17
|
## 2. 运营者的角色
|
|
18
18
|
|
|
@@ -51,7 +51,7 @@ Advisers 默认在本机运行:**没有账号、没有遥测、没有云服务
|
|
|
51
51
|
|
|
52
52
|
## 4. 会出网的情形(完整清单)
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
除下表外,本软件**不会出网**;无遥测、无自动更新检查、无运营者端点。所有第三方接收方均由你配置或选择;运营者不控制其处理。第 11 行的 bridge 是**在 bridge 进程运行期间按轮询间隔持续工作**的通道:本软件只与你指定的本机目录交换 JSON 文件,不直接联网;对外发送由你的 Hermes 进程及其接入的消息平台完成。
|
|
55
55
|
|
|
56
56
|
| # | 功能 | 触发方式 | 接收方 | 发送/接收的数据 | 默认 | 你的控制 |
|
|
57
57
|
|---|---|---|---|---|---|---|
|
|
@@ -65,14 +65,17 @@ Advisers 默认在本机运行:**没有账号、没有遥测、没有云服务
|
|
|
65
65
|
| 8 | MCP 客户端 | `advisers mcp --stdio` | 连接它的 MCP 客户端(Claude Code/Cursor/Copilot Studio 等)及其模型服务商 | today/commitments/who/evidence 等工具结果 | 关(stdio、本地) | 选择可信客户端;其可能把结果发给云模型 |
|
|
66
66
|
| 9 | 桌宠消费端 | 读取 `pet-brief.json` | 桌宠应用(如 Pearl,默认关闭) | 脱敏投影(启发式脱敏,非 NER;secrecy≥2 排除) | 关 | 不在他人可见屏幕展示;关闭功能 |
|
|
67
67
|
| 10 | OCR/时间戳/外部命令 | `ADVISERS_OCR_CMD`、timestamp adapter、`ADVISERS_NOTIFY_CMD` | 你指定的外部程序 | 取决于该程序 | 关 | 自行审查;外部程序可能联网 |
|
|
68
|
+
| 11 | 桥接(bridge / Hermes 文件网关) | `advisers bridge --dir <目录>`(需另装并配置 Hermes bridge-adapter;该命令属受门控命令,需先接受当前 TOS) | 你配置的 Hermes 进程及其接入的消息平台(Telegram、飞书、企业微信、Slack、Discord、Email 等,取决于 Hermes 配置);模型调用时还包括模型服务商(默认 DeepSeek) | **收**:inbox JSON(消息文本、发送者标识、会话/线程 ID、附件元数据、回复关系)→ 本机账本与模型调用上下文;**发**:outbox JSON(回复文本、附件引用、幂等键)以**明文**写回该目录,由 Hermes 交给其接入平台;目录 0700、文件 0600 | **关**(需你显式运行 `advisers bridge`;不运行时本软件不经此通道) | 不运行该命令;审查 Hermes 及其平台配置;**不要把 bridge 目录放在同步盘/共享盘**(会被 OneDrive/Dropbox/Syncthing 等复制);受保护事项(secrecy>0)模型调用 fail-closed |
|
|
69
|
+
|
|
70
|
+
**关于 bridge(第 11 行)**:bridge 只与本机指定目录交换 JSON 文件,不直接建立网络连接;实际对外发送由你的 Hermes 进程及其接入的平台完成,受 Hermes 与该平台条款约束。inbox 内容会进入本机账本,并可能作为模型调用上下文发送给模型服务商(与第 1 行同口径);outbox 是**明文 JSON**(回复文本、附件引用、幂等键),目录按 0700、文件按 0600 创建,但若该目录位于同步盘、共享盘或被其他程序读取,其中的明面对话内容会被复制到你未预期的位置。请将 bridge 目录指向本机受控路径,并自行评估 Hermes 侧的数据处理与留存。
|
|
68
71
|
|
|
69
72
|
**关于默认服务商**:默认 DeepSeek。DeepSeek 是独立第三方,其处理受 [DeepSeek 开放平台服务协议](https://cdn.deepseek.com/policies/zh-CN/deepseek-open-platform-terms-of-service.html)、[DeepSeek 隐私政策](https://cdn.deepseek.com/policies/zh-CN/deepseek-privacy-policy.html) 及适用法律约束;运营者不是其处理者,也不代其作出留存/训练/删除承诺。请在启用前阅读其条款。
|
|
70
73
|
|
|
71
74
|
## 5. 第三方接收方与跨境
|
|
72
75
|
|
|
73
|
-
5.1 上述第三方可能包括:模型服务商(默认 DeepSeek)、IMAP 邮件服务商、你选择的同步盘/云服务、webhook 接收方、MCP 客户端、DSH
|
|
76
|
+
5.1 上述第三方可能包括:模型服务商(默认 DeepSeek)、IMAP 邮件服务商、你选择的同步盘/云服务、webhook 接收方、MCP 客户端、DSH 宿主、桌宠应用、你指定的外部命令,以及 bridge 场景下你的 Hermes 进程及其接入的消息平台。它们各自是独立的个人信息处理者或受托处理者(取决于其条款),运营者不控制其处理。
|
|
74
77
|
|
|
75
|
-
5.2 **跨境**:默认模型服务商为境内服务商,通常不构成向境外提供。若你把 `ADVISERS_BASE_URL`/`ADVISERS_PROVIDER`
|
|
78
|
+
5.2 **跨境**:默认模型服务商为境内服务商,通常不构成向境外提供。若你把 `ADVISERS_BASE_URL`/`ADVISERS_PROVIDER` 指向境外服务商,或通过宿主/客户端/bridge(经 Hermes 接入的平台)把数据传输至境外,你应自行判断是否构成《个人信息保护法》第 38 条的跨境提供,履行第 39 条的告知与单独同意、第 55 条的个人信息保护影响评估(PIPIA),以及适用的安全评估/标准合同/认证义务;涉及重要数据的,还应遵守《数据安全法》《网络数据安全管理条例》《促进和规范数据跨境流动规定》。不要把境内客户数据随意发送到境外模型。
|
|
76
79
|
|
|
77
80
|
## 6. 你的客户数据、委托处理与单独同意
|
|
78
81
|
|
|
@@ -96,13 +99,13 @@ Advisers 默认在本机运行:**没有账号、没有遥测、没有云服务
|
|
|
96
99
|
|
|
97
100
|
7.4 **更正**:`advisers prefs correct`、`memory accept/reject`、事项/承诺编辑命令;第三方服务商侧更正按其流程。
|
|
98
101
|
|
|
99
|
-
7.5 **撤回同意/停止出网**:取消 `ADVISERS_API_KEY`、IMAP 环境变量、`ADVISERS_NOTIFY_WEBHOOK`、sync
|
|
102
|
+
7.5 **撤回同意/停止出网**:取消 `ADVISERS_API_KEY`、IMAP 环境变量、`ADVISERS_NOTIFY_WEBHOOK`、sync 目录配置,停止 `advisers bridge`,或停止使用相应功能;本软件没有需要“撤回”的运营者侧同意(因为运营者不处理)。你对客户作出的同意,应由你按约定和法定程序撤回并停止处理。对本说明与 [服务条款](https://github.com/PerryLink/advisers/blob/main/docs/TOS.md) 的同意,可按 TOS 第 18.1 条撤回。
|
|
100
103
|
|
|
101
104
|
7.6 **投诉**:见第 12 节;你也可以向网信、市场监管等部门投诉(如 12377、12315、12345,按当地实际渠道)。
|
|
102
105
|
|
|
103
106
|
## 8. 安全措施与边界
|
|
104
107
|
|
|
105
|
-
8.1 本软件采取:HOME 0700、主要文件 0600、SQLite `secure_delete=ON`、AES-256-GCM + scrypt 的可选 vault/export/sync 加密、HMAC 审计链、受保护事项(secrecy>0)模型/研究/导入 fail-closed、IMAP 只读、webhook 最小化 payload、MCP
|
|
108
|
+
8.1 本软件采取:HOME 0700、主要文件 0600、SQLite `secure_delete=ON`、AES-256-GCM + scrypt 的可选 vault/export/sync 加密、HMAC 审计链、受保护事项(secrecy>0)模型/研究/导入 fail-closed、IMAP 只读、webhook 最小化 payload、MCP 只读为主且写操作需人工接受、bridge 目录 0700 与文件 0600(bridge 模型调用走同一 fail-closed 门)。
|
|
106
109
|
|
|
107
110
|
8.2 **边界**:默认数据库不加密;无法防御同机同用户的恶意程序、内存取证、已导出/已同步/已交付文件、第三方服务商侧、宿主/客户端侧、屏幕被他人看到、以及你自己的误操作。`advisers privacy --prove` 只验证本地可验证事实(无遥测、默认不出网、审计链、受保护事项 fail-closed),**不是第三方认证、不是合规认证、不是等保/算法备案/大模型登记**。
|
|
108
111
|
|
|
@@ -131,6 +134,6 @@ Advisers 默认在本机运行:**没有账号、没有遥测、没有云服务
|
|
|
131
134
|
|
|
132
135
|
---
|
|
133
136
|
|
|
134
|
-
**文档完 · v2026.11.
|
|
137
|
+
**文档完 · v2026.11.3 · 2026-11-20**
|
|
135
138
|
|
|
136
139
|
如中英文版本存在冲突,以本中文版本为准。本文件任何部分被认定无效,不影响其余部分的效力。
|
package/lib/tos/safety.zh-CN.md
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
| 项目 | 内容 |
|
|
4
4
|
|---|---|
|
|
5
5
|
| 适用对象 | Advisers 用户、集成方与扩展开发者 |
|
|
6
|
-
| 文档版本 | 2026.11.
|
|
7
|
-
| 最后更新 | 2026-11-
|
|
6
|
+
| 文档版本 | 2026.11.3(与 [docs/TOS.md](https://github.com/PerryLink/advisers/blob/main/docs/TOS.md) 同版本) |
|
|
7
|
+
| 最后更新 | 2026-11-20 |
|
|
8
8
|
| 范围 | 本软件自带的内容安全辅助机制、其能力边界、用户责任与申诉方式 |
|
|
9
9
|
| 性质 | 本文是解释性技术说明,不单独创设法律义务;与 TOS 冲突时以 TOS 为准 |
|
|
10
10
|
|
|
@@ -90,12 +90,13 @@ Advisers 包含(或按版本逐步接入)本地内容安全规则、可选
|
|
|
90
90
|
|
|
91
91
|
## 11. 与 TOS / 免责声明 / 隐私说明的关系
|
|
92
92
|
|
|
93
|
-
- 本说明是 [docs/TOS.md](https://github.com/PerryLink/advisers/blob/main/docs/TOS.md)(v2026.11.
|
|
93
|
+
- 本说明是 [docs/TOS.md](https://github.com/PerryLink/advisers/blob/main/docs/TOS.md)(v2026.11.3)、[docs/DISCLAIMER.md](https://github.com/PerryLink/advisers/blob/main/docs/DISCLAIMER.md) 与 [docs/PRIVACY.md](https://github.com/PerryLink/advisers/blob/main/docs/PRIVACY.md) 的补充说明,不构成独立法律承诺。
|
|
94
94
|
- 若本说明与 TOS 冲突,以 TOS 为准;TOS 与仓库许可证冲突时,许可证就相应代码/文档的授权优先。
|
|
95
95
|
|
|
96
96
|
## 12. 变更记录
|
|
97
97
|
|
|
98
98
|
| 版本 | 日期 | 变更 |
|
|
99
99
|
|---|---|---|
|
|
100
|
+
| 2026.11.3 | 2026-11-20 | 与 TOS/PRIVACY 同步版本:补充 bridge(Hermes 文件网关)出网披露;本文内容未作实质变更 |
|
|
100
101
|
| 2026.11.2 | 2026-11-17 | 定稿:删除审阅标记、写明 0.2.0 规则层接入范围以发布说明为准、出网清单与隐私说明对齐、标识义务按义务主体分层、申诉渠道与时限确定、TTS/深度合成口径具体化 |
|
|
101
102
|
| 2026.11.1 | 2026-11-17 | 首版:诚实口径、机制与边界、数据出网、健康使用、未成年人、AI 标识、TTS/深度合成、申诉渠道 |
|
package/lib/tos/summary.zh-CN.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
# 免责声明(短版 · TOS v2026.11.
|
|
1
|
+
# 免责声明(短版 · TOS v2026.11.3)
|
|
2
2
|
|
|
3
3
|
Advisers 是本地优先的 AI 工作助手,不是情感陪伴,也不提供法律、医疗、金融、心理等专业意见。
|
|
4
4
|
AI 输出可能错误、过时、不完整或带偏见;重要事实与结论请自行核验,并自行承担使用后果。
|
|
5
5
|
禁止使用本工具生成、复制、发布或传播违法、侵权、欺诈、骚扰、伪造或未标识合成内容等用途。
|
|
6
6
|
未成年人须在监护人同意与指导下使用;本软件不提供虚拟伴侣或其他亲密关系服务。
|
|
7
7
|
使用 TTS / 声音合成时,你须拥有相应声音与文本的合法授权,并保留 AI 生成内容的显式与隐式标识(0.2.0 不提供 TTS 能力)。
|
|
8
|
-
数据默认保存在本机(`~/.advisers`,可用 `ADVISERS_HOME`
|
|
8
|
+
数据默认保存在本机(`~/.advisers`,可用 `ADVISERS_HOME` 指定);不内置遥测、无账号、无运营者云服务;启用模型、网页研究、邮件导入、通知、同步、bridge(Hermes 文件网关)或宿主/客户端时,相关内容会发送给你配置的第三方服务商(默认模型服务商为 DeepSeek);默认数据库不加密。详见[隐私与数据流说明](https://github.com/PerryLink/advisers/blob/main/docs/PRIVACY.md)。
|
|
9
9
|
内容安全机制是辅助措施,不构成合规认证;你是内容安全审核与对外发布的第一责任人。
|
|
10
10
|
在适用法律允许的范围内,本软件按“现状”提供,不对间接损失承担责任(依法不得排除的责任除外;见 TOS 第 13 条,免费版本责任上限为人民币 100 元)。
|
|
11
|
-
完整条款见 [docs/TOS.md](https://github.com/PerryLink/advisers/blob/main/docs/TOS.md)(v2026.11.
|
|
11
|
+
完整条款见 [docs/TOS.md](https://github.com/PerryLink/advisers/blob/main/docs/TOS.md)(v2026.11.3);安全与内容审核说明见 [docs/SAFETY.md](https://github.com/PerryLink/advisers/blob/main/docs/SAFETY.md);隐私说明见 [docs/PRIVACY.md](https://github.com/PerryLink/advisers/blob/main/docs/PRIVACY.md)。
|
|
12
12
|
运营者:PerryLink(本项目维护者,GitHub: https://github.com/PerryLink);联系与投诉:GitHub Issues(https://github.com/PerryLink/advisers/issues);安全漏洞:GitHub 私密漏洞报告(见 [SECURITY.md](https://github.com/PerryLink/advisers/blob/main/SECURITY.md));许可:软件按 PolyForm Noncommercial 1.0.0 提供,仅限非商业用途,商业使用须另行取得书面商业授权。
|
package/lib/tos/terms.zh-CN.md
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
| 项目 | 内容 |
|
|
4
4
|
|---|---|
|
|
5
|
-
| 文档版本 | **2026.11.
|
|
6
|
-
| 生效日期 | 2026-11-
|
|
5
|
+
| 文档版本 | **2026.11.3** |
|
|
6
|
+
| 生效日期 | 2026-11-20 |
|
|
7
7
|
| 语言效力 | 中文版为唯一 canonical 文本;任何英文摘要或翻译仅供参考、不具约束力,与中文版冲突时以中文版为准。就许可证的授权范围而言,仓库许可证的英文原文优先(见 [LICENSING.md](https://github.com/PerryLink/advisers/blob/main/LICENSING.md))。 |
|
|
8
8
|
| 适用范围 | Advisers 软件(`advisers` CLI、`dsh-advisers` 宿主插件、各 workspace 包)、文档、示例、模板及其衍生项目(以下合称“本软件”)。 |
|
|
9
9
|
| 完整性校验 | 本文件正文的 SHA-256 由 `packages/advisers/lib/tos/manifest.json` 记录,并由 `scripts/check-tos.mjs` 在本地/CI 校验;正文发生任何实质变化必须升级文档版本并重新确认。本文件随 npm 包分发于 `packages/advisers/lib/tos/terms.zh-CN.md`。 |
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
|
|
57
57
|
2.1 **接受**:运营者在你首次使用受门控功能前,以显著方式向你展示本 TOS 的摘要、第 13 条(免责与责任限制)与第 15.2 条(管辖)的核心内容,并提供离线查看完整文本的入口(本 TOS 随软件分发于 `packages/advisers/lib/tos/terms.zh-CN.md`)。你作出明确同意后(交互界面**输入“同意”**或选择“同意”并确认;非交互环境使用 `--accept-tos` 或 `ADVISERS_ACCEPT_TOS=1`),本 TOS 对你生效,并记录版本、文本 SHA-256、时间与渠道到本地审计链。**仅继续运行、按 Enter 或保持默认选项,不构成本 TOS 的接受。** 你拒绝同意时,受门控的功能不得使用;不受门控的本地功能仍可使用,但仅受仓库许可证约束。
|
|
58
58
|
|
|
59
|
-
2.2 **版本与重新确认**:本 TOS 版本为 **2026.11.
|
|
59
|
+
2.2 **版本与重新确认**:本 TOS 版本为 **2026.11.3**。运营者可依第 15.4 条修订本 TOS;**实质修改**(尤其是第 13 条、第 15 条或你权利义务的变化)将升级版本号,并要求你在下次使用受门控功能时重新确认;未重新确认前,受门控的使用将被停止或限制。修订不具有溯及力。**本次修订(v2026.11.3)**为补充第 9.3(h) 条桥接(bridge/Hermes)出网披露并同步隐私说明的实质修订,你在重新确认后方可继续使用受门控功能;本次修订不改变第 13 条与第 15.2 条。
|
|
60
60
|
|
|
61
61
|
2.3 **修改即再确认(逐次确认场景)**:以下会改变行为、数据或对外内容的操作,每次发生(或清单指纹变化时)都需再次确认,而不是每个版本只确认一次:
|
|
62
62
|
|
|
@@ -261,13 +261,15 @@
|
|
|
261
261
|
|
|
262
262
|
(g)你自行配置的 OCR、时间戳、通知命令等外部命令。
|
|
263
263
|
|
|
264
|
+
(h)**桥接(bridge / Hermes 文件网关)**:运行 `advisers bridge --dir <目录>`(需另行安装并配置 Hermes bridge-adapter;该命令为受门控命令,需先接受当前版本的本 TOS)后,本软件会持续轮询该目录并与你的 Hermes 进程交换 JSON 文件;本软件本身不直接建立网络连接,对外发送由 Hermes 及其接入的平台完成。**收到(inbox)**:来自 Hermes 的消息 JSON(消息文本、发送者标识、会话/线程 ID、附件元数据、回复关系)会导入本机账本,并可能作为模型调用上下文发送给你配置的模型服务商(默认 DeepSeek,见 (a) 条);**发出(outbox)**:回复文本、附件引用与幂等键会以**明文 JSON** 写入该目录,交由 Hermes 及其接入的消息平台(如 Telegram、飞书、企业微信、Slack、Discord、Email 等,取决于你的 Hermes 配置)处理;目录按 0700、文件按 0600 创建。该目录若位于 OneDrive、Dropbox、Syncthing 等同步盘或共享盘,其中明文 JSON 可能被复制到你未预期的位置,请将 bridge 目录指向本机受控路径。受保护事项(secrecy>0)的模型调用按 fail-closed 拒绝;bridge 进程运行期间按轮询间隔持续工作,停止该命令即停止本软件侧的该通道。
|
|
265
|
+
|
|
264
266
|
除上述外,本软件**不含遥测、无自动更新检查、不内置运营者服务器地址**。
|
|
265
267
|
|
|
266
|
-
9.4
|
|
268
|
+
9.4 **第三方服务商**:上述服务商(含 bridge 场景下你的 Hermes 进程及其接入的消息平台)是独立的个人信息处理者或受托处理者(取决于其条款);运营者不控制其处理、不代其作出留存/训练/删除承诺。你应在启用前阅读其服务条款与隐私政策,并自行决定是否接受其数据使用、留存与跨境安排。
|
|
267
269
|
|
|
268
270
|
9.5 **你的客户数据与受托处理**:若你处理客户、当事人、同事或其他第三人的个人信息,你是该等信息的个人信息处理者(或受托处理者),应自行具备合法性基础(同意、合同、法定义务等),遵守最小必要、目的限制、告知、单独同意、影响评估与安全事件报告等义务。你与客户之间存在委托处理关系时,应依《个人信息保护法》第 21 条约定处理目的、期限、方式、种类、保护措施与双方权利义务,并监督受托处理。你因职业保密义务(如《律师法》第 38 条、行业保密规范)不得披露的信息,不应在未取得授权/同意的情况下输入模型或链接服务。
|
|
269
271
|
|
|
270
|
-
9.6 **跨境**:默认模型服务商为境内服务商,通常不构成向境外提供;若你将 `ADVISERS_BASE_URL`、`ADVISERS_PROVIDER`
|
|
272
|
+
9.6 **跨境**:默认模型服务商为境内服务商,通常不构成向境外提供;若你将 `ADVISERS_BASE_URL`、`ADVISERS_PROVIDER` 或其他链接指向境外服务商,或通过宿主/客户端/bridge(经 Hermes 接入的平台)把数据传输至境外,你应自行判断是否构成《个人信息保护法》第 38 条的跨境提供,履行第 39 条的告知与单独同意、第 55 条的个人信息保护影响评估及适用的安全评估/标准合同/认证义务,并评估客户数据的出境限制。涉及重要数据的,依《数据安全法》《网络数据安全管理条例》《促进和规范数据跨境流动规定》处理。
|
|
271
273
|
|
|
272
274
|
9.7 **敏感个人信息与未成年人**:对话、邮件、会议与附件可能包含《个人信息保护法》第 28 条的敏感个人信息(医疗健康、金融账户、行踪轨迹、特定身份、不满 14 周岁未成年人信息等)。请仅在具有特定目的、充分必要性与严格保护措施时处理,并取得单独同意。自伤/自杀等危机表达会触发本地提示与求助信息,不阻断对话;相关原文默认留在本地账本,不写入审计摘要。本软件不面向未成年人,详见第 8 条。
|
|
273
275
|
|
|
@@ -434,6 +436,6 @@
|
|
|
434
436
|
|
|
435
437
|
---
|
|
436
438
|
|
|
437
|
-
**文档完 · v2026.11.
|
|
439
|
+
**文档完 · v2026.11.3 · 2026-11-20**
|
|
438
440
|
|
|
439
441
|
如中英文版本存在冲突,以本中文版本为准。本文件任何部分被认定无效,不影响其余部分的效力。
|
package/lib/tui/color.js
ADDED
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Colour policy and the 16-colour SGR whitelist (0.3.0 output kernel).
|
|
3
|
+
*
|
|
4
|
+
* Semantics, in priority order (documented in docs/TUI.md and tested):
|
|
5
|
+
*
|
|
6
|
+
* 1. --color=always|never explicit flag wins over environment
|
|
7
|
+
* 2. NO_COLOR (present, non-empty) disables colour in auto mode
|
|
8
|
+
* 3. TERM=dumb / non-TTY stdout disables colour in auto mode
|
|
9
|
+
* 4. --plain / --accessible disable colour and all cursor control
|
|
10
|
+
*
|
|
11
|
+
* Only the following SGR codes may ever be emitted (16-colour safe palette):
|
|
12
|
+
* 1 bold, 2 dim, 22 reset bold/dim, 31 red, 32 green, 33 yellow, 39 reset fg.
|
|
13
|
+
* No 256-colour, truecolour, background, reverse, blink, underline or OSC of any
|
|
14
|
+
* kind. Colour never carries the only meaning: every line has a text prefix too.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
/** Accepted --color values. */
|
|
18
|
+
export const COLOR_MODES = Object.freeze(['auto', 'always', 'never'])
|
|
19
|
+
|
|
20
|
+
/** Named SGR codes the kernel may emit. */
|
|
21
|
+
export const SGR = Object.freeze({
|
|
22
|
+
bold: 1,
|
|
23
|
+
dim: 2,
|
|
24
|
+
resetIntensity: 22,
|
|
25
|
+
red: 31,
|
|
26
|
+
green: 32,
|
|
27
|
+
yellow: 33,
|
|
28
|
+
resetForeground: 39,
|
|
29
|
+
})
|
|
30
|
+
|
|
31
|
+
/** The complete SGR allowlist. Tests extract every emitted code and compare. */
|
|
32
|
+
export const ALLOWED_SGR_CODES = Object.freeze([1, 2, 22, 31, 32, 33, 39])
|
|
33
|
+
|
|
34
|
+
const SGR_PATTERN = /\u001b\[(\d+(?:;\d+)*)m/g
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Parse a --color value.
|
|
38
|
+
*
|
|
39
|
+
* @param {unknown} value
|
|
40
|
+
* @returns {'auto' | 'always' | 'never' | null} null when the value is not supported
|
|
41
|
+
*/
|
|
42
|
+
export function parseColorMode(value) {
|
|
43
|
+
if (typeof value !== 'string') return null
|
|
44
|
+
const mode = value.trim().toLowerCase()
|
|
45
|
+
return COLOR_MODES.includes(mode) ? mode : null
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Find --color in an argv-style array.
|
|
50
|
+
*
|
|
51
|
+
* Supports both `--color=never` and `--color never`.
|
|
52
|
+
*
|
|
53
|
+
* @param {unknown} argv
|
|
54
|
+
* @returns {{ found: boolean, mode: 'auto' | 'always' | 'never' | null, invalid: boolean }}
|
|
55
|
+
*/
|
|
56
|
+
export function readColorArg(argv) {
|
|
57
|
+
if (!Array.isArray(argv)) return { found: false, mode: null, invalid: false }
|
|
58
|
+
for (let index = 0; index < argv.length; index += 1) {
|
|
59
|
+
const argument = argv[index]
|
|
60
|
+
if (typeof argument !== 'string') continue
|
|
61
|
+
if (argument === '--color') {
|
|
62
|
+
const mode = parseColorMode(argv[index + 1])
|
|
63
|
+
return { found: true, mode, invalid: mode === null }
|
|
64
|
+
}
|
|
65
|
+
if (argument.startsWith('--color=')) {
|
|
66
|
+
const mode = parseColorMode(argument.slice('--color='.length))
|
|
67
|
+
return { found: true, mode, invalid: mode === null }
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
return { found: false, mode: null, invalid: false }
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* NO_COLOR convention: present and not an empty string disables colour.
|
|
75
|
+
*
|
|
76
|
+
* @param {NodeJS.ProcessEnv | Record<string, unknown>} [env]
|
|
77
|
+
* @returns {boolean}
|
|
78
|
+
*/
|
|
79
|
+
export function noColorEnv(env = process.env) {
|
|
80
|
+
return Boolean(env) && typeof env.NO_COLOR === 'string' && env.NO_COLOR !== ''
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Resolve whether SGR colour may be emitted.
|
|
85
|
+
*
|
|
86
|
+
* @param {{ mode?: 'auto' | 'always' | 'never', env?: Record<string, unknown>, stdoutIsTTY?: boolean, term?: string }} [options]
|
|
87
|
+
* @returns {boolean}
|
|
88
|
+
*/
|
|
89
|
+
export function resolveColorEnabled({ mode = 'auto', env = process.env, stdoutIsTTY = false, term } = {}) {
|
|
90
|
+
if (mode === 'always') return true
|
|
91
|
+
if (mode === 'never') return false
|
|
92
|
+
const terminal = term === undefined ? env?.TERM : term
|
|
93
|
+
if (!stdoutIsTTY) return false
|
|
94
|
+
if (terminal === 'dumb') return false
|
|
95
|
+
if (noColorEnv(env)) return false
|
|
96
|
+
return true
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Wrap text in whitelisted SGR codes.
|
|
101
|
+
*
|
|
102
|
+
* @param {unknown} text
|
|
103
|
+
* @param {string | string[] | null | undefined} style one or more keys of SGR
|
|
104
|
+
* @param {{ enabled?: boolean }} [options]
|
|
105
|
+
* @returns {string}
|
|
106
|
+
*/
|
|
107
|
+
export function styleText(text, style, { enabled = true } = {}) {
|
|
108
|
+
const value = text === null || text === undefined ? '' : String(text)
|
|
109
|
+
if (!enabled || style === null || style === undefined) return value
|
|
110
|
+
const names = Array.isArray(style) ? style : [style]
|
|
111
|
+
const codes = []
|
|
112
|
+
for (const name of names) {
|
|
113
|
+
if (typeof name !== 'string') continue
|
|
114
|
+
const code = SGR[name]
|
|
115
|
+
if (typeof code === 'number') codes.push(code)
|
|
116
|
+
}
|
|
117
|
+
if (codes.length === 0) return value
|
|
118
|
+
const open = codes.map((code) => `\u001b[${code}m`).join('')
|
|
119
|
+
const close = [...codes].reverse().map((code) => `\u001b[${resetCodeFor(code)}m`).join('')
|
|
120
|
+
return open + value + close
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function resetCodeFor(code) {
|
|
124
|
+
if (code === SGR.dim || code === SGR.bold) return SGR.resetIntensity
|
|
125
|
+
return SGR.resetForeground
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Remove only SGR colour sequences (other control characters are left for sanitisation).
|
|
130
|
+
*
|
|
131
|
+
* @param {unknown} value
|
|
132
|
+
* @returns {string}
|
|
133
|
+
*/
|
|
134
|
+
export function stripSgr(value) {
|
|
135
|
+
if (value === null || value === undefined) return ''
|
|
136
|
+
return String(value).replace(SGR_PATTERN, '')
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Extract every SGR code present in a string (test/audit helper).
|
|
141
|
+
*
|
|
142
|
+
* @param {unknown} value
|
|
143
|
+
* @returns {number[]}
|
|
144
|
+
*/
|
|
145
|
+
export function sgrCodes(value) {
|
|
146
|
+
if (value === null || value === undefined) return []
|
|
147
|
+
const text = String(value)
|
|
148
|
+
const codes = []
|
|
149
|
+
for (const match of text.matchAll(SGR_PATTERN)) {
|
|
150
|
+
for (const part of match[1].split(';')) codes.push(Number.parseInt(part, 10))
|
|
151
|
+
}
|
|
152
|
+
return codes
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* True when every SGR sequence in the string uses a whitelisted code.
|
|
157
|
+
*
|
|
158
|
+
* @param {unknown} value
|
|
159
|
+
* @returns {boolean}
|
|
160
|
+
*/
|
|
161
|
+
export function hasOnlyWhitelistedSgr(value) {
|
|
162
|
+
return sgrCodes(value).every((code) => ALLOWED_SGR_CODES.includes(code))
|
|
163
|
+
}
|
|
164
|
+
|