dsh-plugin-show-me-data 0.1.0

package/src/client/copy.js

@@ -0,0 +1,368 @@
+/**
+ * Every user-facing string in one place (docs/05 §6), so a test can assert that
+ * no raw key or bare English leaks into the panel and so translation is a data
+ * change rather than a code change.
+ *
+ * @module client/copy
+ */
+
+/** Chinese copy (the panel's primary language). */
+export const COPY = {
+  panelTitle: '数据雷达',
+  panelSubtitle: '全球宏观 · 利率 · 股市 · 债市',
+  open: '打开数据雷达',
+  close: '收起面板',
+  refresh: '刷新',
+  refreshing: '正在刷新…',
+  retry: '重试',
+  loading: '正在获取数据…',
+  empty: '这个范围里没有可用数据。',
+  degradedBanner: '部分数据源不可用，卡片显示的是上次成功的快照。',
+  unreachable: '插件未正确挂载（/api/show-me-data 不可达）。请检查挂载行与宿主日志。',
+  sourceBadge: '来源',
+  viewSource: '打开原始数据源',
+  showDataTable: '查看数据表',
+  hideDataTable: '收起数据表',
+  date: '日期',
+  value: '数值',
+  stats: '统计',
+  statsMean: '均值',
+  statsMin: '最小',
+  statsMax: '最大',
+  statsStdDev: '标准差',
+  statsPercentile: '分位',
+  statsYoy: '同比',
+  statsMom: '环比',
+  statsMissing: '缺口',
+  noteworthy: '今日值得关注',
+  noteworthyEmpty: '今天没有触发关注规则。',
+  tabToday: '今日',
+  tabCore: '核心',
+  tabMine: '我的',
+  tabSettings: '设置',
+  tabDetail: '详情',
+  groupUS: '美国',
+  groupCN: '中国',
+  groupGlobal: '全球',
+  groupCustom: '我的',
+  ai: 'AI 解析',
+  aiSummary: '时段总结',
+  aiAsk: '数据问答',
+  aiAskPlaceholder: '用面板内的数据提问，例如：美国 CPI 同比现在是多少？',
+  aiAskSubmit: '提问',
+  aiModeDeterministic: '确定性摘要模式',
+  aiModeLlm: '模型模式',
+  aiDegraded: 'AI 输出未通过溯源校验，已回退为确定性摘要。',
+  aiInsufficient: '数据不足',
+  aiCitations: '引用数据点',
+  discuss: '开独立会话讨论',
+  discussing: '正在开启会话…',
+  discussFailed: '独立会话不可用',
+  discussTurnFailed: '会话已创建，但本轮提问失败',
+  discussHint: '会新建一个 DSH 会话，并把面板数据作为上下文；没输入问题时面板会代你提出开场问题。回答在会话里流式生成，可以继续追问、换模型。',
+  discussOpened: '已在新会话中打开（回答正在会话里生成，稍后也会显示在这里）。',
+  discussAnswer: '会话里的回答',
+  discussOpening: '正在开启会话…',
+  discussRunning: '会话进行中',
+  discussReady: '会话已就绪',
+  discussRunningHint: '回答在会话里生成，完成后也会显示在这里（通常 30–60 秒）。',
+  discussOpenSession: '打开会话',
+  discussSessionStarted: '会话 ID：',
+  discussTimeout: '等待超时：会话仍在运行，请点击「打开会话」查看；或稍后重试。',
+  dismiss: '收起',
+  noteworthyDiscuss: '讨论',
+  noteworthyDiscussHint: '开一个独立会话，把这条的关注原因和面板数据一起带过去',
+  analyzeTab: '总体分析',
+  groupUs: '美国',
+  groupCn: '中国',
+  analyzeScope: '范围',
+  analyzeAll: '全部',
+  analyzeRun: '生成总体分析',
+  analyzeIdle: '选择范围后点「生成总体分析」：会综合该范围内所有指标与今日触发规则。',
+  analyzeEmpty: '该范围内没有可用指标。',
+  analyzeCount: '纳入指标',
+  analyzeDiscuss: '深入讨论',
+  analyzeDiscussHint: '带着这份总体数据开一个独立会话，可以继续追问',
+  iterateHint: '面板只读取已登记的数据源，无法自己接入新源。可以开一个独立会话，在插件工作区里迭代代码来接入（会话已带上这条需求与失败原因）。',
+  iterateAction: '开迭代会话接入数据源',
+  iterateOpening: '正在开会话…',
+  iterateTopic: '接入数据源',
+  viewDetail: '查看',
+  selectHint: '勾选后可跨板块统一分析',
+  selectedCount: '已选',
+  analyzeSelected: '分析选中',
+  clearSelection: '清除选择',
+  expand: '展开',
+  collapse: '收起',
+  barSize: '周期',
+  barDay: '日K',
+  barWeek: '周K',
+  barMonth: '月K',
+  chartCandle: 'K线',
+  chartArea: '面积',
+  chartLine: '折线',
+  chartBar: '柱状',
+  chartHint: '移动指针查看数值',
+  pointsUnit: '个观测点',
+  discussEmpty: '会话里这一轮没有产生文本（模型可能只给出了推理，或中途失败）；请打开该会话查看原因。',
+  discussIdle: '会话已就绪，但面板只注入了上下文、没有提问；请打开会话直接提问。',
+  discussAutoAsked: '面板已代你提出开场问题：',
+  discussQuestion: '本轮提问：',
+  aiCached: '来自缓存',
+  aiOffline: '未配置模型，本回答由本地规则生成。',
+  aiEmptyAnswer: '模型未返回可用的文本，已回退为确定性摘要',
+  addIndicator: '添加指标',
+  addSearchPlaceholder: '搜索指标（中文或英文，例如 非农 / CPI）',
+  addByText: '用自然语言添加',
+  addByTextPlaceholder: '例如：加上美国 30 年期房贷利率',
+  addConfirm: '加入我的',
+  addPreview: '预览',
+  addExists: '已存在，是否更新？',
+  addUnsupported: '无法添加（没有可用数据源）',
+  remove: '移除',
+  disclaimer: '数据来自公开源，仅供研究参考，不构成投资建议；口径以原始来源为准。',
+  lastUpdated: '更新于',
+  fromCache: '正在显示缓存',
+  settingsMount: '挂载检查清单',
+  settingsWhatIsThis: '这个面板在做什么',
+  settingsIntro: '下面是当前挂载生效的配置。多数项来自 profile 的行配置，改完需要重启 dsh 进程；面板内不可改的项已标注。',
+  settingsPrefix: '接口前缀',
+  settingsPrefixHint: '所有面板请求都走这个前缀',
+  settingsRoutes: '路由数',
+  settingsTools: '模型工具数',
+  settingsReadOnly: '行配置，面板内不可改',
+  settingsUnsupported: '暂不可用指标：',
+  settingsStorageHint: '未配置时为内存存储，重启后缓存与自选清空',
+  settingsAi: 'AI 设置',
+  settingsCurrentModel: '当前模型',
+  settingsAiEnabled: 'AI 开关',
+  settingsAiEnabledHint: '关掉后只用确定性摘要（不调用模型）',
+  settingsAiChars: '输出字数上限',
+  settingsAiCharsHint: '太小时推理模型会把预算用完、只留下空回答',
+  settingsAiCache: '结果缓存',
+  settingsAiCacheHint: '同一指标+同一区间在缓存期内直接复用',
+  settingsData: '数据与缓存',
+  settingsRefresh: '后台刷新间隔',
+  settingsRefreshHint: '0 表示不自动刷新，只在打开面板时取数',
+  settingsGroups: '展示分组',
+  settingsGroupsHint: '面板按这些分组归类卡片',
+  settingsNoteworthy: '关注项数量',
+  settingsNoteworthyHint: '「今日值得关注」最多显示几条',
+  settingsDebug: '调试日志',
+  settingsDebugHint: '开启后把 AI 诊断写到进程 stderr',
+  settingsSourcesHint: '可用性来自最近一次抓取；失败通常是上游限流或封锁。作为备用上游、从未被请求过的源会显示"未检查"——那不代表它坏了。',
+  settingsSourceOff: '已在配置中关闭',
+  settingsLast: '最后成功',
+  settingsHowToChange: '要修改以上任一项：编辑',
+  reload: '重新读取',
+  testSource: '测试连接',
+  testSourceHint: '忽略缓存重新请求该数据源的指标，确认上游此刻是否可用',
+  testAll: '全部测试',
+  testing: '测试中…',
+  testOk: '连接正常',
+  testFailed: '连接失败',
+  failedCount: '失败',
+  probeIndicators: '本次测试指标数',
+  notChecked: '未检查',
+  available: '可用',
+  unavailable: '失败',
+  yes: '是',
+  no: '否',
+  minutes: '分钟',
+  settingsStorage: '存储目录',
+  settingsAiMode: 'AI 模式',
+  settingsSources: '数据源开关',
+  settingsIndicators: '指标数量',
+  coldStart: '正在获取数据源数据…',
+  staleHint: '按该指标的发布频率判断，数据可能尚未更新。',
+  errorHint: '该数据源本次取数失败。点击重试，或查看健康状态。',
+  missingHint: '上游成功返回，但本范围内没有观测。',
+  hoverHint: '悬停查看数值，点击打开详情。',
+}
+
+/** English mirror, used when the locale service reports a non-Chinese locale. */
+export const COPY_EN = {
+  panelTitle: 'Data Radar',
+  panelSubtitle: 'Global macro · rates · equities · bonds',
+  open: 'Open Data Radar',
+  close: 'Collapse panel',
+  refresh: 'Refresh',
+  refreshing: 'Refreshing…',
+  retry: 'Retry',
+  loading: 'Fetching data…',
+  empty: 'No data available in this range.',
+  degradedBanner: 'Some sources are unavailable; cards show the last successful snapshot.',
+  unreachable: 'The plugin is not mounted correctly (/api/show-me-data is unreachable).',
+  sourceBadge: 'Source',
+  viewSource: 'Open the original source',
+  showDataTable: 'Show data table',
+  hideDataTable: 'Hide data table',
+  date: 'Date',
+  value: 'Value',
+  stats: 'Statistics',
+  statsMean: 'Mean',
+  statsMin: 'Min',
+  statsMax: 'Max',
+  statsStdDev: 'Std dev',
+  statsPercentile: 'Percentile',
+  statsYoy: 'YoY',
+  statsMom: 'MoM',
+  statsMissing: 'Gaps',
+  noteworthy: 'Worth watching today',
+  noteworthyEmpty: 'No rule fired today.',
+  tabToday: 'Today',
+  tabCore: 'Core',
+  tabMine: 'Mine',
+  tabSettings: 'Settings',
+  tabDetail: 'Detail',
+  groupUS: 'United States',
+  groupCN: 'China',
+  groupGlobal: 'Global',
+  groupCustom: 'Mine',
+  ai: 'AI analysis',
+  aiSummary: 'Period summary',
+  aiAsk: 'Ask the data',
+  aiAskPlaceholder: 'Ask using panel data, e.g. what is US CPI YoY now?',
+  aiAskSubmit: 'Ask',
+  aiModeDeterministic: 'Deterministic summary mode',
+  aiModeLlm: 'Model mode',
+  aiDegraded: 'The model output failed provenance validation; fell back to the deterministic summary.',
+  aiInsufficient: 'Insufficient data',
+  aiCitations: 'Cited data points',
+  discuss: 'Discuss in a session',
+  discussing: 'Opening a session…',
+  discussFailed: 'Independent sessions are unavailable',
+  discussTurnFailed: 'Session created, this turn failed',
+  discussHint: 'Creates a DSH session seeded with the panel data; with an empty question the panel asks an opening question for you. The answer streams in the session.',
+  discussOpened: 'Opened in a new session (the answer is generating there and will also appear here).',
+  discussAnswer: 'Answer from the session',
+  discussOpening: 'Opening a session…',
+  discussRunning: 'Session running',
+  discussReady: 'Session ready',
+  discussRunningHint: 'The answer is generating in the session and will appear here too (usually 30–60s).',
+  discussOpenSession: 'Open session',
+  discussSessionStarted: 'Session id: ',
+  discussTimeout: 'Timed out waiting: the session is still running — open it, or try again later.',
+  dismiss: 'Dismiss',
+  noteworthyDiscuss: 'Discuss',
+  noteworthyDiscussHint: 'Open a session seeded with this item\'s rule triggers and the panel data',
+  analyzeTab: 'Analysis',
+  groupUs: 'US',
+  groupCn: 'China',
+  analyzeScope: 'Scope',
+  analyzeAll: 'All',
+  analyzeRun: 'Run the analysis',
+  analyzeIdle: 'Pick a scope and run it: every indicator in scope plus today\'s triggered rules go into one digest.',
+  analyzeEmpty: 'No usable indicators in this scope.',
+  analyzeCount: 'Indicators in scope',
+  analyzeDiscuss: 'Discuss in a session',
+  analyzeDiscussHint: 'Open a session seeded with this whole-panel digest',
+  iterateHint: 'The panel only reads registered sources and cannot add one by itself. Open a session in the plugin workspace to add it (the request and the reasons travel with it).',
+  iterateAction: 'Open an iteration session',
+  iterateOpening: 'Opening a session…',
+  iterateTopic: 'Add a data source',
+  viewDetail: 'View',
+  selectHint: 'pick indicators to analyse them together',
+  selectedCount: 'Selected',
+  analyzeSelected: 'Analyse selection',
+  clearSelection: 'Clear',
+  expand: 'Expand',
+  collapse: 'Collapse',
+  barSize: 'Bars',
+  barDay: 'Daily',
+  barWeek: 'Weekly',
+  barMonth: 'Monthly',
+  chartCandle: 'Candles',
+  chartArea: 'Area',
+  chartLine: 'Line',
+  chartBar: 'Bars',
+  chartHint: 'Move the pointer to read values',
+  pointsUnit: 'observations',
+  discussEmpty: 'This turn produced no text (the model may have returned only reasoning, or failed midway); open the session to see why.',
+  discussIdle: 'The session is ready, but only context was seeded — no question was asked; open it and ask one.',
+  discussAutoAsked: 'The panel asked this opening question for you:',
+  discussQuestion: 'Question this turn:',
+  aiCached: 'From cache',
+  aiOffline: 'No model configured; this answer was generated by local rules.',
+  aiEmptyAnswer: 'The model returned no usable text; fell back to the deterministic summary',
+  addIndicator: 'Add indicator',
+  addSearchPlaceholder: 'Search indicators (Chinese or English)',
+  addByText: 'Add by description',
+  addByTextPlaceholder: 'e.g. add the US 30-year mortgage rate',
+  addConfirm: 'Add to mine',
+  addPreview: 'Preview',
+  addExists: 'Already added — update it?',
+  addUnsupported: 'Cannot add (no available source)',
+  remove: 'Remove',
+  disclaimer: 'Data comes from public sources, for research only, not investment advice.',
+  lastUpdated: 'Updated',
+  fromCache: 'Showing cache',
+  settingsMount: 'Mount checklist',
+  settingsWhatIsThis: 'What this panel is doing',
+  settingsIntro: 'Effective configuration of this mount. Most values come from the profile row and need a dsh restart; rows the panel cannot change say so.',
+  settingsPrefix: 'API prefix',
+  settingsPrefixHint: 'every panel request goes through this prefix',
+  settingsRoutes: 'Routes',
+  settingsTools: 'Model tools',
+  settingsReadOnly: 'row config, not editable here',
+  settingsUnsupported: 'Unavailable indicators:',
+  settingsStorageHint: 'memory when unset: cache and watchlist are cleared on restart',
+  settingsAi: 'AI',
+  settingsCurrentModel: 'Current model',
+  settingsAiEnabled: 'AI enabled',
+  settingsAiEnabledHint: 'off means deterministic summaries only',
+  settingsAiChars: 'Answer budget',
+  settingsAiCharsHint: 'too small and a reasoning model spends it all thinking',
+  settingsAiCache: 'Result cache',
+  settingsAiCacheHint: 'same indicator and range reuses the cached answer',
+  settingsData: 'Data and caching',
+  settingsRefresh: 'Background refresh',
+  settingsRefreshHint: '0 disables it: data is fetched when the panel opens',
+  settingsGroups: 'Display groups',
+  settingsGroupsHint: 'cards are grouped by these',
+  settingsNoteworthy: 'Noteworthy limit',
+  settingsNoteworthyHint: 'rows shown in "worth watching today"',
+  settingsDebug: 'Debug logging',
+  settingsDebugHint: 'writes AI diagnostics to the process stderr',
+  settingsSourcesHint: 'Availability comes from the last fetch; failures are usually upstream rate limits. A source only ever used as a fallback shows "not checked" — that is not a failure.',
+  settingsSourceOff: 'disabled in config',
+  settingsLast: 'last success',
+  settingsHowToChange: 'To change any of these, edit',
+  reload: 'Reload',
+  testSource: 'Test',
+  testSourceHint: 'Re-fetch this source\'s indicators, ignoring the cache, to see whether the upstream answers now',
+  testAll: 'Test all',
+  testing: 'Testing…',
+  testOk: 'reachable',
+  testFailed: 'unreachable',
+  failedCount: 'failed',
+  probeIndicators: 'indicators probed',
+  notChecked: 'not checked',
+  available: 'ok',
+  unavailable: 'failed',
+  yes: 'yes',
+  no: 'no',
+  minutes: 'min',
+  settingsStorage: 'Storage directory',
+  settingsAiMode: 'AI mode',
+  settingsSources: 'Source switches',
+  settingsIndicators: 'Indicator count',
+  coldStart: 'Fetching from data sources…',
+  staleHint: 'This indicator may not have been published yet for its frequency.',
+  errorHint: 'This source failed on this refresh. Retry, or check health.',
+  missingHint: 'The upstream answered, but has no observation in this range.',
+  hoverHint: 'Hover for values, click for detail.',
+}
+
+/** Group key → copy key. */
+export const GROUP_LABELS = { US: 'groupUS', CN: 'groupCN', GLOBAL: 'groupGlobal', CUSTOM: 'groupCustom' }
+
+/**
+ * Pick the copy table for a locale id.
+ *
+ * @param {string} [locale] - locale id such as 'zh-CN' or 'en'.
+ * @returns {typeof COPY} copy table.
+ */
+export function copyFor(locale) {
+  return typeof locale === 'string' && /^en/i.test(locale) ? COPY_EN : COPY
+}

package/src/client/index.js

@@ -0,0 +1,169 @@
+/**
+ * Browser-half entry (docs/09 §3).
+ *
+ * Registers one 'shell.overlay' entry that manages its own open/close state, so
+ * the plugin never competes with the shipped overlay occupants. Every side effect
+ * (stylesheet, subscription) is owned by the plugin context and removed on
+ * unload.
+ *
+ * @module client/index
+ */
+import { api } from './api.js'
+import { copyFor } from './copy.js'
+import { applyIndicatorChange, createStore } from './store.js'
+import { createComponents, insertStyles } from './components.js'
+
+/** Services the client half needs. 'slots' is provided by the shipped runtime. */
+export const inject = ['slots']
+
+/** The slot this plugin contributes to. */
+export const SLOT = 'shell.overlay'
+
+/** A no-op React stand-in used only for the module-scope component bindings. */
+const PLACEHOLDER_REACT = { createElement: () => null, Fragment: null, useState: (v) => [v, () => {}], useEffect: () => {}, useMemo: (f) => f(), useRef: (v) => ({ current: v }) }
+
+/**
+ * The shared helpers the components need. The bundler concatenates the real
+ * implementations into this scope before this module, so the names resolve at
+ * call time; declaring the map keeps the dependency explicit.
+ */
+const SHARED_FORMAT = {
+  buildLinePath,
+  buildBarRects,
+  buildSparklineShape,
+  buildXAxis,
+  buildYAxis,
+  buildZeroLine,
+  buildTimeAxis,
+  buildCandles,
+  buildCrosshair,
+  buildReferenceLines,
+  nearestIndex,
+  valueDomain,
+  hasOhlc,
+  linearScale,
+  niceTicks,
+  formatValue,
+  formatChange,
+  formatAge,
+  changeColor,
+  statusDot,
+  metricTooltip,
+  truncate,
+}
+
+/** Registration id inside the overlay list. */
+export const ENTRY_ID = 'show-me-data'
+
+/**
+ * Build the module-level store and components once per page.
+ *
+ * @param {object} React - React instance from the loader.
+ * @param {object} format - the shared 'core/format' plus chart helpers.
+ * @param {{ locale?: string }} [options] - options.
+ * @returns {{ store: object, components: object, copy: object }} panel runtime.
+ */
+export function createPanelRuntime(React, format, options = {}) {
+  const store = createStore()
+  const copy = copyFor(options.locale)
+  const components = createComponents(React, { store, api, copy, format, sessions: options.sessions, applyIndicatorChange })
+  return { store, components, copy }
+}
+
+/**
+ * Build the panel's components for one React instance.
+ *
+ * Exported because the structure tests render components with a React stub; the
+ * runtime path calls it with the real React it receives.
+ *
+ * @param {object} React - React instance.
+ * @param {{ store?: object, copy?: object, api?: object, format?: object }} [deps] - overrides.
+ * @returns {object} components plus the store and copy table they use.
+ */
+export function initPanel(React, deps = {}) {
+  const store = deps.store ?? createStore()
+  const copy = deps.copy ?? copyFor('zh')
+  const components = createComponents(React, {
+    store,
+    api: deps.api ?? api,
+    copy,
+    format: deps.format ?? SHARED_FORMAT,
+    sessions: deps.sessions,
+    applyIndicatorChange: deps.applyIndicatorChange ?? applyIndicatorChange,
+    // Injectable so a test can drive the discussion poll to completion instead of
+    // leaving a timer that keeps the process alive.
+    pollIntervalMs: deps.pollIntervalMs,
+    pollTimeoutMs: deps.pollTimeoutMs,
+  })
+  // The store helpers ride along so the structure tests can exercise the state
+  // transitions (not just the render output) of one React instance.
+  return { ...components, store, copy, applyIndicatorChange, INITIAL_STATE }
+}
+
+/** Components for the shared-format placeholder React, so '__test' has bindings. */
+const PANEL = initPanel(PLACEHOLDER_REACT)
+const {
+  DataRadarOverlay,
+  MetricCard,
+  NoteworthyList,
+  Chart,
+  StatsStrip,
+  AiPanel,
+  DetailDrawer,
+  SettingsTab,
+  AddIndicatorTab,
+  Sparkline,
+} = PANEL
+
+/**
+ * Mount the browser half.
+ *
+ * @param {object} ctx - client plugin context.
+ * @param {object} [deps] - injectable dependencies (tests pass stubs).
+ * @param {object} [deps.React] - React instance.
+ * @param {object} [deps.format] - formatting helpers.
+ * @param {Document} [deps.document] - document (browser only).
+ * @returns {void}
+ */
+export function apply(ctx, deps = {}) {
+  const React = deps.React ?? require('react')
+  // The shared core modules are concatenated into this same scope by the
+  // bundler, so their symbols are referenced directly rather than re-imported.
+  const format = deps.format ?? {
+    buildLinePath,
+    buildBarRects,
+    buildSparklineShape,
+    buildXAxis,
+    buildYAxis,
+    buildZeroLine,
+    buildTimeAxis,
+    buildCandles,
+    buildCrosshair,
+    buildReferenceLines,
+    nearestIndex,
+    valueDomain,
+    hasOhlc,
+    linearScale,
+    niceTicks,
+    formatValue,
+    formatChange,
+    formatAge,
+    changeColor,
+    statusDot,
+    metricTooltip,
+    truncate,
+  }
+  const runtime = createPanelRuntime(React, format, {
+    locale: typeof navigator === 'undefined' ? undefined : navigator.language,
+    sessions: ctx.get !== undefined ? ctx.get('sessions') : undefined,
+  })
+  const doc = deps.document ?? (typeof document === 'undefined' ? undefined : document)
+
+  if (doc !== undefined) {
+    ctx.effect(() => insertStyles(doc), 'show-me-data: styles')
+  }
+
+  ctx.slots.inject(SLOT, () =>
+    ctx.slots.register({ name: SLOT, id: ENTRY_ID, order: 30 }, runtime.components.DataRadarOverlay),
+  )
+}