opencandle 0.1.1 → 0.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 (278) hide show
  1. package/README.md +111 -79
  2. package/dist/analysts/contracts.d.ts +31 -0
  3. package/dist/analysts/contracts.js +158 -0
  4. package/dist/analysts/contracts.js.map +1 -0
  5. package/dist/analysts/orchestrator.d.ts +11 -2
  6. package/dist/analysts/orchestrator.js +156 -9
  7. package/dist/analysts/orchestrator.js.map +1 -1
  8. package/dist/cli.js +26 -10
  9. package/dist/cli.js.map +1 -1
  10. package/dist/config.d.ts +29 -5
  11. package/dist/config.js +18 -8
  12. package/dist/config.js.map +1 -1
  13. package/dist/index.d.ts +1 -1
  14. package/dist/index.js +1 -1
  15. package/dist/index.js.map +1 -1
  16. package/dist/infra/cache.d.ts +34 -0
  17. package/dist/infra/cache.js +44 -3
  18. package/dist/infra/cache.js.map +1 -1
  19. package/dist/infra/index.d.ts +1 -1
  20. package/dist/infra/index.js +1 -1
  21. package/dist/infra/index.js.map +1 -1
  22. package/dist/infra/opencandle-paths.d.ts +1 -0
  23. package/dist/infra/opencandle-paths.js +3 -0
  24. package/dist/infra/opencandle-paths.js.map +1 -1
  25. package/dist/infra/rate-limiter.js +7 -0
  26. package/dist/infra/rate-limiter.js.map +1 -1
  27. package/dist/memory/index.d.ts +3 -0
  28. package/dist/memory/index.js +2 -0
  29. package/dist/memory/index.js.map +1 -1
  30. package/dist/memory/manager.d.ts +19 -0
  31. package/dist/memory/manager.js +132 -0
  32. package/dist/memory/manager.js.map +1 -0
  33. package/dist/memory/sqlite.js +12 -1
  34. package/dist/memory/sqlite.js.map +1 -1
  35. package/dist/memory/types.d.ts +21 -0
  36. package/dist/memory/types.js +47 -0
  37. package/dist/memory/types.js.map +1 -0
  38. package/dist/onboarding/connect.d.ts +23 -0
  39. package/dist/onboarding/connect.js +107 -0
  40. package/dist/onboarding/connect.js.map +1 -0
  41. package/dist/onboarding/credential-interceptor.d.ts +44 -0
  42. package/dist/onboarding/credential-interceptor.js +72 -0
  43. package/dist/onboarding/credential-interceptor.js.map +1 -0
  44. package/dist/onboarding/degradation-accumulator.d.ts +21 -0
  45. package/dist/onboarding/degradation-accumulator.js +55 -0
  46. package/dist/onboarding/degradation-accumulator.js.map +1 -0
  47. package/dist/onboarding/prompt-user.d.ts +23 -0
  48. package/dist/onboarding/prompt-user.js +61 -0
  49. package/dist/onboarding/prompt-user.js.map +1 -0
  50. package/dist/onboarding/providers.d.ts +109 -0
  51. package/dist/onboarding/providers.js +236 -0
  52. package/dist/onboarding/providers.js.map +1 -0
  53. package/dist/onboarding/state.d.ts +31 -2
  54. package/dist/onboarding/state.js +141 -13
  55. package/dist/onboarding/state.js.map +1 -1
  56. package/dist/onboarding/tool-helpers.d.ts +34 -0
  57. package/dist/onboarding/tool-helpers.js +80 -0
  58. package/dist/onboarding/tool-helpers.js.map +1 -0
  59. package/dist/onboarding/tool-tags.d.ts +37 -0
  60. package/dist/onboarding/tool-tags.js +149 -0
  61. package/dist/onboarding/tool-tags.js.map +1 -0
  62. package/dist/onboarding/validation.d.ts +19 -0
  63. package/dist/onboarding/validation.js +117 -0
  64. package/dist/onboarding/validation.js.map +1 -0
  65. package/dist/pi/opencandle-extension.d.ts +5 -1
  66. package/dist/pi/opencandle-extension.js +345 -143
  67. package/dist/pi/opencandle-extension.js.map +1 -1
  68. package/dist/pi/session.d.ts +2 -0
  69. package/dist/pi/session.js +1 -1
  70. package/dist/pi/session.js.map +1 -1
  71. package/dist/pi/setup.d.ts +0 -1
  72. package/dist/pi/setup.js +66 -119
  73. package/dist/pi/setup.js.map +1 -1
  74. package/dist/prompts/context-builder.d.ts +26 -0
  75. package/dist/prompts/context-builder.js +127 -0
  76. package/dist/prompts/context-builder.js.map +1 -0
  77. package/dist/prompts/sections.d.ts +13 -0
  78. package/dist/prompts/sections.js +35 -0
  79. package/dist/prompts/sections.js.map +1 -0
  80. package/dist/providers/alpha-vantage.d.ts +3 -0
  81. package/dist/providers/alpha-vantage.js +204 -77
  82. package/dist/providers/alpha-vantage.js.map +1 -1
  83. package/dist/providers/coingecko.js +53 -37
  84. package/dist/providers/coingecko.js.map +1 -1
  85. package/dist/providers/exa-search.d.ts +39 -0
  86. package/dist/providers/exa-search.js +276 -0
  87. package/dist/providers/exa-search.js.map +1 -0
  88. package/dist/providers/fear-greed.js +23 -15
  89. package/dist/providers/fear-greed.js.map +1 -1
  90. package/dist/providers/finnhub.d.ts +17 -0
  91. package/dist/providers/finnhub.js +94 -0
  92. package/dist/providers/finnhub.js.map +1 -0
  93. package/dist/providers/fred.js +48 -28
  94. package/dist/providers/fred.js.map +1 -1
  95. package/dist/providers/index.d.ts +2 -0
  96. package/dist/providers/index.js +1 -0
  97. package/dist/providers/index.js.map +1 -1
  98. package/dist/providers/provider-credential-error.d.ts +8 -0
  99. package/dist/providers/provider-credential-error.js +22 -0
  100. package/dist/providers/provider-credential-error.js.map +1 -0
  101. package/dist/providers/reddit.d.ts +8 -0
  102. package/dist/providers/reddit.js +78 -43
  103. package/dist/providers/reddit.js.map +1 -1
  104. package/dist/providers/twitter.d.ts +20 -0
  105. package/dist/providers/twitter.js +137 -0
  106. package/dist/providers/twitter.js.map +1 -0
  107. package/dist/providers/web-search.d.ts +17 -0
  108. package/dist/providers/web-search.js +224 -0
  109. package/dist/providers/web-search.js.map +1 -0
  110. package/dist/providers/with-fallback.d.ts +15 -0
  111. package/dist/providers/with-fallback.js +32 -0
  112. package/dist/providers/with-fallback.js.map +1 -0
  113. package/dist/providers/wrap-provider.d.ts +20 -0
  114. package/dist/providers/wrap-provider.js +58 -0
  115. package/dist/providers/wrap-provider.js.map +1 -0
  116. package/dist/providers/yahoo-finance.js +77 -57
  117. package/dist/providers/yahoo-finance.js.map +1 -1
  118. package/dist/routing/classify-intent.js +22 -0
  119. package/dist/routing/classify-intent.js.map +1 -1
  120. package/dist/runtime/evidence.d.ts +35 -0
  121. package/dist/runtime/evidence.js +29 -0
  122. package/dist/runtime/evidence.js.map +1 -0
  123. package/dist/runtime/index.d.ts +16 -0
  124. package/dist/runtime/index.js +10 -0
  125. package/dist/runtime/index.js.map +1 -0
  126. package/dist/runtime/prompt-step.d.ts +41 -0
  127. package/dist/runtime/prompt-step.js +42 -0
  128. package/dist/runtime/prompt-step.js.map +1 -0
  129. package/dist/runtime/provider-ids.d.ts +14 -0
  130. package/dist/runtime/provider-ids.js +14 -0
  131. package/dist/runtime/provider-ids.js.map +1 -0
  132. package/dist/runtime/provider-tracker.d.ts +20 -0
  133. package/dist/runtime/provider-tracker.js +36 -0
  134. package/dist/runtime/provider-tracker.js.map +1 -0
  135. package/dist/runtime/run-context.d.ts +11 -0
  136. package/dist/runtime/run-context.js +14 -0
  137. package/dist/runtime/run-context.js.map +1 -0
  138. package/dist/runtime/session-coordinator.d.ts +47 -0
  139. package/dist/runtime/session-coordinator.js +171 -0
  140. package/dist/runtime/session-coordinator.js.map +1 -0
  141. package/dist/runtime/validation.d.ts +44 -0
  142. package/dist/runtime/validation.js +157 -0
  143. package/dist/runtime/validation.js.map +1 -0
  144. package/dist/runtime/workflow-events.d.ts +21 -0
  145. package/dist/runtime/workflow-events.js +31 -0
  146. package/dist/runtime/workflow-events.js.map +1 -0
  147. package/dist/runtime/workflow-runner.d.ts +36 -0
  148. package/dist/runtime/workflow-runner.js +129 -0
  149. package/dist/runtime/workflow-runner.js.map +1 -0
  150. package/dist/runtime/workflow-types.d.ts +60 -0
  151. package/dist/runtime/workflow-types.js +32 -0
  152. package/dist/runtime/workflow-types.js.map +1 -0
  153. package/dist/sentiment/adapters/finnhub.d.ts +7 -0
  154. package/dist/sentiment/adapters/finnhub.js +39 -0
  155. package/dist/sentiment/adapters/finnhub.js.map +1 -0
  156. package/dist/sentiment/adapters/reddit.d.ts +11 -0
  157. package/dist/sentiment/adapters/reddit.js +54 -0
  158. package/dist/sentiment/adapters/reddit.js.map +1 -0
  159. package/dist/sentiment/adapters/twitter.d.ts +9 -0
  160. package/dist/sentiment/adapters/twitter.js +32 -0
  161. package/dist/sentiment/adapters/twitter.js.map +1 -0
  162. package/dist/sentiment/adapters/web.d.ts +9 -0
  163. package/dist/sentiment/adapters/web.js +40 -0
  164. package/dist/sentiment/adapters/web.js.map +1 -0
  165. package/dist/sentiment/index.d.ts +16 -0
  166. package/dist/sentiment/index.js +44 -0
  167. package/dist/sentiment/index.js.map +1 -0
  168. package/dist/sentiment/keywords.d.ts +2 -0
  169. package/dist/sentiment/keywords.js +9 -0
  170. package/dist/sentiment/keywords.js.map +1 -0
  171. package/dist/sentiment/pipeline.d.ts +9 -0
  172. package/dist/sentiment/pipeline.js +57 -0
  173. package/dist/sentiment/pipeline.js.map +1 -0
  174. package/dist/sentiment/scorer.d.ts +9 -0
  175. package/dist/sentiment/scorer.js +64 -0
  176. package/dist/sentiment/scorer.js.map +1 -0
  177. package/dist/sentiment/store.d.ts +24 -0
  178. package/dist/sentiment/store.js +177 -0
  179. package/dist/sentiment/store.js.map +1 -0
  180. package/dist/sentiment/trends.d.ts +13 -0
  181. package/dist/sentiment/trends.js +73 -0
  182. package/dist/sentiment/trends.js.map +1 -0
  183. package/dist/sentiment/types.d.ts +66 -0
  184. package/dist/sentiment/types.js +54 -0
  185. package/dist/sentiment/types.js.map +1 -0
  186. package/dist/system-prompt.js +60 -2
  187. package/dist/system-prompt.js.map +1 -1
  188. package/dist/tool-kit.d.ts +9 -5
  189. package/dist/tool-kit.js +29 -6
  190. package/dist/tool-kit.js.map +1 -1
  191. package/dist/tools/fundamentals/company-overview.d.ts +3 -1
  192. package/dist/tools/fundamentals/company-overview.js +28 -17
  193. package/dist/tools/fundamentals/company-overview.js.map +1 -1
  194. package/dist/tools/fundamentals/comps.js +47 -39
  195. package/dist/tools/fundamentals/comps.js.map +1 -1
  196. package/dist/tools/fundamentals/dcf.js +83 -65
  197. package/dist/tools/fundamentals/dcf.js.map +1 -1
  198. package/dist/tools/fundamentals/earnings.d.ts +3 -1
  199. package/dist/tools/fundamentals/earnings.js +26 -18
  200. package/dist/tools/fundamentals/earnings.js.map +1 -1
  201. package/dist/tools/fundamentals/financials.d.ts +3 -1
  202. package/dist/tools/fundamentals/financials.js +24 -16
  203. package/dist/tools/fundamentals/financials.js.map +1 -1
  204. package/dist/tools/fundamentals/sec-filings.js +9 -1
  205. package/dist/tools/fundamentals/sec-filings.js.map +1 -1
  206. package/dist/tools/index.js +10 -2
  207. package/dist/tools/index.js.map +1 -1
  208. package/dist/tools/interaction/ask-user.d.ts +3 -0
  209. package/dist/tools/interaction/ask-user.js +51 -0
  210. package/dist/tools/interaction/ask-user.js.map +1 -0
  211. package/dist/tools/interaction/twitter-login.d.ts +8 -0
  212. package/dist/tools/interaction/twitter-login.js +77 -0
  213. package/dist/tools/interaction/twitter-login.js.map +1 -0
  214. package/dist/tools/macro/fear-greed.js +9 -1
  215. package/dist/tools/macro/fear-greed.js.map +1 -1
  216. package/dist/tools/macro/fred-data.d.ts +3 -1
  217. package/dist/tools/macro/fred-data.js +27 -16
  218. package/dist/tools/macro/fred-data.js.map +1 -1
  219. package/dist/tools/market/crypto-history.js +9 -1
  220. package/dist/tools/market/crypto-history.js.map +1 -1
  221. package/dist/tools/market/crypto-price.js +9 -1
  222. package/dist/tools/market/crypto-price.js.map +1 -1
  223. package/dist/tools/market/stock-history.js +28 -1
  224. package/dist/tools/market/stock-history.js.map +1 -1
  225. package/dist/tools/market/stock-quote.js +29 -4
  226. package/dist/tools/market/stock-quote.js.map +1 -1
  227. package/dist/tools/options/option-chain.js +9 -1
  228. package/dist/tools/options/option-chain.js.map +1 -1
  229. package/dist/tools/portfolio/correlation.js +15 -3
  230. package/dist/tools/portfolio/correlation.js.map +1 -1
  231. package/dist/tools/portfolio/predictions.js +6 -5
  232. package/dist/tools/portfolio/predictions.js.map +1 -1
  233. package/dist/tools/portfolio/risk-analysis.js +9 -1
  234. package/dist/tools/portfolio/risk-analysis.js.map +1 -1
  235. package/dist/tools/portfolio/tracker.js +6 -3
  236. package/dist/tools/portfolio/tracker.js.map +1 -1
  237. package/dist/tools/portfolio/watchlist.js +6 -1
  238. package/dist/tools/portfolio/watchlist.js.map +1 -1
  239. package/dist/tools/sentiment/reddit-sentiment.d.ts +3 -1
  240. package/dist/tools/sentiment/reddit-sentiment.js +112 -19
  241. package/dist/tools/sentiment/reddit-sentiment.js.map +1 -1
  242. package/dist/tools/sentiment/sentiment-summary.d.ts +7 -0
  243. package/dist/tools/sentiment/sentiment-summary.js +230 -0
  244. package/dist/tools/sentiment/sentiment-summary.js.map +1 -0
  245. package/dist/tools/sentiment/sentiment-trend.d.ts +22 -0
  246. package/dist/tools/sentiment/sentiment-trend.js +39 -0
  247. package/dist/tools/sentiment/sentiment-trend.js.map +1 -0
  248. package/dist/tools/sentiment/twitter-sentiment.d.ts +9 -0
  249. package/dist/tools/sentiment/twitter-sentiment.js +75 -0
  250. package/dist/tools/sentiment/twitter-sentiment.js.map +1 -0
  251. package/dist/tools/sentiment/web-search.d.ts +11 -0
  252. package/dist/tools/sentiment/web-search.js +115 -0
  253. package/dist/tools/sentiment/web-search.js.map +1 -0
  254. package/dist/tools/sentiment/web-sentiment.d.ts +8 -0
  255. package/dist/tools/sentiment/web-sentiment.js +66 -0
  256. package/dist/tools/sentiment/web-sentiment.js.map +1 -0
  257. package/dist/tools/technical/backtest.js +9 -1
  258. package/dist/tools/technical/backtest.js.map +1 -1
  259. package/dist/tools/technical/indicators.js +9 -1
  260. package/dist/tools/technical/indicators.js.map +1 -1
  261. package/dist/types/index.d.ts +16 -1
  262. package/dist/types/sentiment.d.ts +41 -0
  263. package/dist/workflows/compare-assets.d.ts +3 -0
  264. package/dist/workflows/compare-assets.js +21 -5
  265. package/dist/workflows/compare-assets.js.map +1 -1
  266. package/dist/workflows/index.d.ts +3 -3
  267. package/dist/workflows/index.js +3 -3
  268. package/dist/workflows/index.js.map +1 -1
  269. package/dist/workflows/options-screener.d.ts +3 -0
  270. package/dist/workflows/options-screener.js +24 -7
  271. package/dist/workflows/options-screener.js.map +1 -1
  272. package/dist/workflows/portfolio-builder.d.ts +3 -0
  273. package/dist/workflows/portfolio-builder.js +30 -9
  274. package/dist/workflows/portfolio-builder.js.map +1 -1
  275. package/package.json +27 -7
  276. package/dist/tools/sentiment/news-sentiment.d.ts +0 -7
  277. package/dist/tools/sentiment/news-sentiment.js +0 -57
  278. package/dist/tools/sentiment/news-sentiment.js.map +0 -1
@@ -0,0 +1,55 @@
1
+ // Per-turn accumulator for soft-tier provider degradations. When a soft
2
+ // provider falls back to a keyless alternative (e.g. Brave → DuckDuckGo, Exa →
3
+ // keyless MCP, Finnhub → cached/free source), the tool result content carries
4
+ // a `[OPENCANDLE_SOFT_DEGRADED ...]` tag. The extension's `tool_result` hook
5
+ // records the provider id in this accumulator WITHOUT mutating the tool
6
+ // result; at `turn_end` the accumulator builds a single combined
7
+ // `[OPENCANDLE_SKIPPED ...]`-style annotation that gets appended to the
8
+ // session as a sidecar entry for observability.
9
+ //
10
+ // Per-provider state (never_ask / snoozed / completed) lives in the persistent
11
+ // OnboardingState on disk — the accumulator stays pure and consults the
12
+ // caller-supplied state snapshot at `buildCombinedAnnotation` time. This keeps
13
+ // the accumulator trivially testable without mocking the filesystem.
14
+ import { getProvider } from "./providers.js";
15
+ import { buildSkippedTag } from "./tool-tags.js";
16
+ export function createDegradationAccumulator() {
17
+ const recorded = new Set();
18
+ return {
19
+ record(provider) {
20
+ recorded.add(provider);
21
+ },
22
+ size() {
23
+ return recorded.size;
24
+ },
25
+ isEmpty() {
26
+ return recorded.size === 0;
27
+ },
28
+ buildCombinedAnnotation(state) {
29
+ if (recorded.size === 0)
30
+ return null;
31
+ const lines = [];
32
+ for (const provider of recorded) {
33
+ const descriptor = getProvider(provider);
34
+ const entry = state.providers[provider];
35
+ const silenced = entry?.status === "never_ask";
36
+ const alias = descriptor.aliases[0] ?? descriptor.id;
37
+ const baseRemediation = `run /connect ${alias} to unlock`;
38
+ const remediation = silenced
39
+ ? `${baseRemediation} (silenced)`
40
+ : baseRemediation;
41
+ lines.push(buildSkippedTag({
42
+ provider,
43
+ reason: "credential_not_provided",
44
+ remediation,
45
+ silenced: silenced || undefined,
46
+ }));
47
+ }
48
+ return lines.join("\n");
49
+ },
50
+ reset() {
51
+ recorded.clear();
52
+ },
53
+ };
54
+ }
55
+ //# sourceMappingURL=degradation-accumulator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"degradation-accumulator.js","sourceRoot":"","sources":["../../src/onboarding/degradation-accumulator.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,+EAA+E;AAC/E,8EAA8E;AAC9E,6EAA6E;AAC7E,wEAAwE;AACxE,iEAAiE;AACjE,wEAAwE;AACxE,gDAAgD;AAChD,EAAE;AACF,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,qEAAqE;AAGrE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAqBjD,MAAM,UAAU,4BAA4B;IAC1C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAc,CAAC;IAEvC,OAAO;QACL,MAAM,CAAC,QAAoB;YACzB,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QACD,IAAI;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QACD,OAAO;YACL,OAAO,QAAQ,CAAC,IAAI,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,uBAAuB,CAAC,KAAsB;YAC5C,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YACrC,MAAM,KAAK,GAAa,EAAE,CAAC;YAC3B,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE,CAAC;gBAChC,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;gBACzC,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACxC,MAAM,QAAQ,GAAG,KAAK,EAAE,MAAM,KAAK,WAAW,CAAC;gBAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC;gBACrD,MAAM,eAAe,GAAG,gBAAgB,KAAK,YAAY,CAAC;gBAC1D,MAAM,WAAW,GAAG,QAAQ;oBAC1B,CAAC,CAAC,GAAG,eAAe,aAAa;oBACjC,CAAC,CAAC,eAAe,CAAC;gBACpB,KAAK,CAAC,IAAI,CACR,eAAe,CAAC;oBACd,QAAQ;oBACR,MAAM,EAAE,yBAAyB;oBACjC,WAAW;oBACX,QAAQ,EAAE,QAAQ,IAAI,SAAS;iBAChC,CAAC,CACH,CAAC;YACJ,CAAC;YACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,KAAK;YACH,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC;KACF,CAAC;AACJ,CAAC"}
@@ -0,0 +1,23 @@
1
+ import type { ExtensionContext } from "@mariozechner/pi-coding-agent";
2
+ import type { AskUserHandler } from "../types/index.js";
3
+ export interface PromptOptions {
4
+ question: string;
5
+ questionType: "select" | "text" | "confirm";
6
+ options?: string[];
7
+ placeholder?: string;
8
+ reason?: string;
9
+ }
10
+ export interface PromptResult {
11
+ answer: string | null;
12
+ cancelled: boolean;
13
+ }
14
+ /**
15
+ * Ask the user a structured question, routing to the appropriate UI primitive
16
+ * (`ctx.ui.select` / `ctx.ui.input` / `ctx.ui.confirm`).
17
+ *
18
+ * When an `askUserHandler` is injected (test harness, programmatic runs), the
19
+ * handler takes precedence over `ctx.ui` and provides the answer directly.
20
+ *
21
+ * When neither a handler nor a UI is available, returns `{answer: null, cancelled: true}`.
22
+ */
23
+ export declare function promptUser(ctx: ExtensionContext, opts: PromptOptions, handler?: AskUserHandler): Promise<PromptResult>;
@@ -0,0 +1,61 @@
1
+ // Shared prompt primitive used by both the `ask_user` tool and the
2
+ // credential-interception handler in the Pi `tool_result` hook.
3
+ //
4
+ // The original `ask_user` tool embedded its UI routing in a closure inside
5
+ // `execute()`. Extracting it here means the `tool_result` handler can call
6
+ // the same logic without synthesizing a fake tool call (Pi has no "execute
7
+ // a tool now" API), and the headless harness's `askUserHandler` injection
8
+ // point is preserved for automated flows.
9
+ /**
10
+ * Ask the user a structured question, routing to the appropriate UI primitive
11
+ * (`ctx.ui.select` / `ctx.ui.input` / `ctx.ui.confirm`).
12
+ *
13
+ * When an `askUserHandler` is injected (test harness, programmatic runs), the
14
+ * handler takes precedence over `ctx.ui` and provides the answer directly.
15
+ *
16
+ * When neither a handler nor a UI is available, returns `{answer: null, cancelled: true}`.
17
+ */
18
+ export async function promptUser(ctx, opts, handler) {
19
+ // Priority: injected handler > UI > no-UI fallback.
20
+ if (handler) {
21
+ const result = await handler({
22
+ question: opts.question,
23
+ questionType: opts.questionType,
24
+ options: opts.options,
25
+ placeholder: opts.placeholder,
26
+ reason: opts.reason,
27
+ });
28
+ if (result.cancelled) {
29
+ return { answer: null, cancelled: true };
30
+ }
31
+ return { answer: result.answer ?? null, cancelled: false };
32
+ }
33
+ if (!ctx?.hasUI) {
34
+ return { answer: null, cancelled: true };
35
+ }
36
+ switch (opts.questionType) {
37
+ case "select": {
38
+ const options = opts.options ?? [];
39
+ if (options.length === 0) {
40
+ return { answer: null, cancelled: true };
41
+ }
42
+ const choice = await ctx.ui.select(opts.question, options);
43
+ if (choice === undefined) {
44
+ return { answer: null, cancelled: true };
45
+ }
46
+ return { answer: choice, cancelled: false };
47
+ }
48
+ case "text": {
49
+ const input = await ctx.ui.input(opts.question, opts.placeholder ?? "");
50
+ if (input === undefined || input.trim() === "") {
51
+ return { answer: null, cancelled: true };
52
+ }
53
+ return { answer: input.trim(), cancelled: false };
54
+ }
55
+ case "confirm": {
56
+ const confirmed = await ctx.ui.confirm(opts.question, opts.reason ?? "");
57
+ return { answer: confirmed ? "Yes" : "No", cancelled: false };
58
+ }
59
+ }
60
+ }
61
+ //# sourceMappingURL=prompt-user.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"prompt-user.js","sourceRoot":"","sources":["../../src/onboarding/prompt-user.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,gEAAgE;AAChE,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,2EAA2E;AAC3E,0EAA0E;AAC1E,0CAA0C;AAkB1C;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,GAAqB,EACrB,IAAmB,EACnB,OAAwB;IAExB,oDAAoD;IACpD,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;YAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAC3C,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;QAChB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IAC3C,CAAC;IAED,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;YACnC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YAC3C,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC3D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YAC3C,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAC9C,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;YACxE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC/C,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YAC3C,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QACpD,CAAC;QAED,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;YACzE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAChE,CAAC;IACH,CAAC;AACH,CAAC"}
@@ -0,0 +1,109 @@
1
+ export type ProviderId = "alpha_vantage" | "fred" | "finnhub" | "brave" | "exa";
2
+ export type ProviderCategory = "fundamentals" | "macro" | "news" | "web_search";
3
+ export type ProviderTier = "hard" | "soft";
4
+ export interface ProviderDescriptor {
5
+ readonly id: ProviderId;
6
+ readonly displayName: string;
7
+ readonly category: ProviderCategory;
8
+ /**
9
+ * `hard` providers pause the workflow with a just-in-time prompt when their
10
+ * credential is missing; they have no meaningful fallback.
11
+ *
12
+ * `soft` providers silently use a fallback path and surface a post-answer
13
+ * gap note in the final output.
14
+ */
15
+ readonly tier: ProviderTier;
16
+ /** Lowercase friendly aliases accepted by `/connect` in addition to the id. */
17
+ readonly aliases: readonly string[];
18
+ readonly signupUrl: string;
19
+ readonly freeTier: boolean;
20
+ readonly envVar: string;
21
+ /** Nested key path into `OpenCandleFileConfig` where the key is persisted. */
22
+ readonly configPath: readonly string[];
23
+ readonly unlocks: readonly string[];
24
+ /**
25
+ * Human copy describing the degraded experience when missing, or `null`
26
+ * when there is no fallback (hard tier).
27
+ */
28
+ readonly fallbackDescription: string | null;
29
+ readonly snoozeDurationDays: number;
30
+ readonly instructionsHint: string;
31
+ }
32
+ export declare const PROVIDERS: readonly [{
33
+ readonly id: "alpha_vantage";
34
+ readonly displayName: "Alpha Vantage";
35
+ readonly category: "fundamentals";
36
+ readonly tier: "hard";
37
+ readonly aliases: readonly ["financials", "fundamentals", "company-financials", "alphavantage"];
38
+ readonly signupUrl: "https://www.alphavantage.co/support/#api-key";
39
+ readonly freeTier: true;
40
+ readonly envVar: "ALPHA_VANTAGE_API_KEY";
41
+ readonly configPath: readonly ["providers", "alphaVantage", "apiKey"];
42
+ readonly unlocks: readonly ["company fundamentals", "income/balance/cashflow statements", "DCF valuation", "earnings history"];
43
+ readonly fallbackDescription: null;
44
+ readonly snoozeDurationDays: 7;
45
+ readonly instructionsHint: "Free, about 30 seconds, signup opens in your browser";
46
+ }, {
47
+ readonly id: "fred";
48
+ readonly displayName: "FRED";
49
+ readonly category: "macro";
50
+ readonly tier: "hard";
51
+ readonly aliases: readonly ["economy", "macro", "economic-data", "st-louis-fed"];
52
+ readonly signupUrl: "https://fredaccount.stlouisfed.org/apikeys";
53
+ readonly freeTier: true;
54
+ readonly envVar: "FRED_API_KEY";
55
+ readonly configPath: readonly ["providers", "fred", "apiKey"];
56
+ readonly unlocks: readonly ["interest rates", "inflation data", "yield curve", "economic indicators"];
57
+ readonly fallbackDescription: null;
58
+ readonly snoozeDurationDays: 7;
59
+ readonly instructionsHint: "Free, about 30 seconds, requires a St. Louis Fed account";
60
+ }, {
61
+ readonly id: "finnhub";
62
+ readonly displayName: "Finnhub";
63
+ readonly category: "news";
64
+ readonly tier: "soft";
65
+ readonly aliases: readonly ["news", "company-news", "finnhub-news"];
66
+ readonly signupUrl: "https://finnhub.io/register";
67
+ readonly freeTier: true;
68
+ readonly envVar: "FINNHUB_API_KEY";
69
+ readonly configPath: readonly ["providers", "finnhub", "apiKey"];
70
+ readonly unlocks: readonly ["ticker-tagged company news", "sentiment enrichment with a dedicated news source"];
71
+ readonly fallbackDescription: "Other sentiment sources (Reddit, Twitter, web search) continue to work without Finnhub";
72
+ readonly snoozeDurationDays: 7;
73
+ readonly instructionsHint: "Free, about 30 seconds, signup opens in your browser";
74
+ }, {
75
+ readonly id: "brave";
76
+ readonly displayName: "Brave Search";
77
+ readonly category: "web_search";
78
+ readonly tier: "soft";
79
+ readonly aliases: readonly ["brave", "brave-search"];
80
+ readonly signupUrl: "https://brave.com/search/api/";
81
+ readonly freeTier: true;
82
+ readonly envVar: "BRAVE_API_KEY";
83
+ readonly configPath: readonly ["providers", "brave", "apiKey"];
84
+ readonly unlocks: readonly ["tier-2 web search with freshness control", "independent search index outside of DuckDuckGo"];
85
+ readonly fallbackDescription: "Web search continues to work via DuckDuckGo (free, no key needed, lower-quality freshness)";
86
+ readonly snoozeDurationDays: 7;
87
+ readonly instructionsHint: "Free tier available, signup opens in your browser";
88
+ }, {
89
+ readonly id: "exa";
90
+ readonly displayName: "Exa";
91
+ readonly category: "web_search";
92
+ readonly tier: "soft";
93
+ readonly aliases: readonly ["exa", "exa-search"];
94
+ readonly signupUrl: "https://dashboard.exa.ai/";
95
+ readonly freeTier: false;
96
+ readonly envVar: "EXA_API_KEY";
97
+ readonly configPath: readonly ["providers", "exa", "apiKey"];
98
+ readonly unlocks: readonly ["tier-1 semantic web search", "full article text and highlights", "higher freshness accuracy than DuckDuckGo"];
99
+ readonly fallbackDescription: "Exa search continues to work via the keyless Exa MCP endpoint, which has lower rate limits but similar quality";
100
+ readonly snoozeDurationDays: 7;
101
+ readonly instructionsHint: "Paid with free tier, signup opens in your browser";
102
+ }];
103
+ export declare function listAllProviders(): readonly ProviderDescriptor[];
104
+ export declare function getProvider(id: ProviderId): ProviderDescriptor;
105
+ export declare function getProvidersByCategory(category: ProviderCategory): readonly ProviderDescriptor[];
106
+ export declare function getProvidersByTier(tier: ProviderTier): readonly ProviderDescriptor[];
107
+ export declare function hasCredential(id: ProviderId): boolean;
108
+ export declare function getCredentialSource(id: ProviderId): "env" | "file" | "absent";
109
+ export declare function resolveProviderFromArgument(arg: string): ProviderDescriptor | readonly ProviderDescriptor[] | undefined;
@@ -0,0 +1,236 @@
1
+ // Provider registry — single source of truth for OpenCandle's credentialed
2
+ // third-party data providers. Every setup pathway iterates this registry:
3
+ // first-run startup, the `/connect` command, the `tool_result` credential
4
+ // interception handler, and the gap-note generator all read from here.
5
+ //
6
+ // Adding a new credentialed provider is a two-step change: add its `ProviderId`
7
+ // to the literal union below, and add its descriptor to the `PROVIDERS` array.
8
+ // The `satisfies` check ensures TypeScript fails the build if the union and
9
+ // the array ever disagree.
10
+ import { getConfig, loadFileConfig } from "../config.js";
11
+ // Declaration order matters: picker display order, per-workflow prompt priority,
12
+ // getProvidersByCategory/getProvidersByTier iteration order.
13
+ export const PROVIDERS = [
14
+ {
15
+ id: "alpha_vantage",
16
+ displayName: "Alpha Vantage",
17
+ category: "fundamentals",
18
+ tier: "hard",
19
+ aliases: ["financials", "fundamentals", "company-financials", "alphavantage"],
20
+ signupUrl: "https://www.alphavantage.co/support/#api-key",
21
+ freeTier: true,
22
+ envVar: "ALPHA_VANTAGE_API_KEY",
23
+ configPath: ["providers", "alphaVantage", "apiKey"],
24
+ unlocks: [
25
+ "company fundamentals",
26
+ "income/balance/cashflow statements",
27
+ "DCF valuation",
28
+ "earnings history",
29
+ ],
30
+ fallbackDescription: null,
31
+ snoozeDurationDays: 7,
32
+ instructionsHint: "Free, about 30 seconds, signup opens in your browser",
33
+ },
34
+ {
35
+ id: "fred",
36
+ displayName: "FRED",
37
+ category: "macro",
38
+ tier: "hard",
39
+ aliases: ["economy", "macro", "economic-data", "st-louis-fed"],
40
+ signupUrl: "https://fredaccount.stlouisfed.org/apikeys",
41
+ freeTier: true,
42
+ envVar: "FRED_API_KEY",
43
+ configPath: ["providers", "fred", "apiKey"],
44
+ unlocks: [
45
+ "interest rates",
46
+ "inflation data",
47
+ "yield curve",
48
+ "economic indicators",
49
+ ],
50
+ fallbackDescription: null,
51
+ snoozeDurationDays: 7,
52
+ instructionsHint: "Free, about 30 seconds, requires a St. Louis Fed account",
53
+ },
54
+ {
55
+ id: "finnhub",
56
+ displayName: "Finnhub",
57
+ category: "news",
58
+ tier: "soft",
59
+ aliases: ["news", "company-news", "finnhub-news"],
60
+ signupUrl: "https://finnhub.io/register",
61
+ freeTier: true,
62
+ envVar: "FINNHUB_API_KEY",
63
+ configPath: ["providers", "finnhub", "apiKey"],
64
+ unlocks: [
65
+ "ticker-tagged company news",
66
+ "sentiment enrichment with a dedicated news source",
67
+ ],
68
+ // Finnhub is a soft enrichment source — sentiment-summary continues to work
69
+ // with Twitter/Reddit/web search when Finnhub is missing. The fallback is
70
+ // "the other sentiment sources still run".
71
+ fallbackDescription: "Other sentiment sources (Reddit, Twitter, web search) continue to work without Finnhub",
72
+ snoozeDurationDays: 7,
73
+ instructionsHint: "Free, about 30 seconds, signup opens in your browser",
74
+ },
75
+ {
76
+ id: "brave",
77
+ displayName: "Brave Search",
78
+ category: "web_search",
79
+ tier: "soft",
80
+ aliases: ["brave", "brave-search"],
81
+ signupUrl: "https://brave.com/search/api/",
82
+ freeTier: true,
83
+ envVar: "BRAVE_API_KEY",
84
+ configPath: ["providers", "brave", "apiKey"],
85
+ unlocks: [
86
+ "tier-2 web search with freshness control",
87
+ "independent search index outside of DuckDuckGo",
88
+ ],
89
+ fallbackDescription: "Web search continues to work via DuckDuckGo (free, no key needed, lower-quality freshness)",
90
+ snoozeDurationDays: 7,
91
+ instructionsHint: "Free tier available, signup opens in your browser",
92
+ },
93
+ {
94
+ id: "exa",
95
+ displayName: "Exa",
96
+ category: "web_search",
97
+ tier: "soft",
98
+ // Note: "search" is a multi-provider alias shared with Brave. The registry
99
+ // exposes it via resolveProviderFromArgument as a sub-picker case, not as a
100
+ // single-provider alias — so it intentionally does NOT appear in either
101
+ // provider's `aliases` array here. Keeping aliases unique-per-provider lets
102
+ // resolveProviderFromArgument cleanly distinguish the alias case from the
103
+ // sub-picker case.
104
+ aliases: ["exa", "exa-search"],
105
+ signupUrl: "https://dashboard.exa.ai/",
106
+ freeTier: false,
107
+ envVar: "EXA_API_KEY",
108
+ configPath: ["providers", "exa", "apiKey"],
109
+ unlocks: [
110
+ "tier-1 semantic web search",
111
+ "full article text and highlights",
112
+ "higher freshness accuracy than DuckDuckGo",
113
+ ],
114
+ fallbackDescription: "Exa search continues to work via the keyless Exa MCP endpoint, which has lower rate limits but similar quality",
115
+ snoozeDurationDays: 7,
116
+ instructionsHint: "Paid with free tier, signup opens in your browser",
117
+ },
118
+ ];
119
+ // -----------------------------------------------------------------------------
120
+ // Lookup helpers
121
+ // -----------------------------------------------------------------------------
122
+ // Lazy-built index — populated on first helper call so module import has no
123
+ // side effects. The test `importing the registry does not read the filesystem`
124
+ // relies on this.
125
+ let providersById;
126
+ function byId() {
127
+ if (!providersById) {
128
+ providersById = new Map(PROVIDERS.map((p) => [p.id, p]));
129
+ }
130
+ return providersById;
131
+ }
132
+ export function listAllProviders() {
133
+ return PROVIDERS;
134
+ }
135
+ export function getProvider(id) {
136
+ const found = byId().get(id);
137
+ if (!found) {
138
+ throw new Error(`Unknown provider id: "${id}"`);
139
+ }
140
+ return found;
141
+ }
142
+ export function getProvidersByCategory(category) {
143
+ return PROVIDERS.filter((p) => p.category === category);
144
+ }
145
+ export function getProvidersByTier(tier) {
146
+ return PROVIDERS.filter((p) => p.tier === tier);
147
+ }
148
+ // -----------------------------------------------------------------------------
149
+ // Credential source helpers
150
+ // -----------------------------------------------------------------------------
151
+ function readConfigValueByPath(obj, path) {
152
+ let cursor = obj;
153
+ for (const segment of path) {
154
+ if (cursor && typeof cursor === "object" && segment in cursor) {
155
+ cursor = cursor[segment];
156
+ }
157
+ else {
158
+ return undefined;
159
+ }
160
+ }
161
+ return typeof cursor === "string" && cursor.length > 0 ? cursor : undefined;
162
+ }
163
+ // Provider-id → `Config` field mapping. `Config` (in src/config.ts) is the
164
+ // canonical env-or-file resolved shape that tool implementations already use.
165
+ // `hasCredential` reads from `getConfig()` so that tests mocking `getConfig`
166
+ // see a consistent view; `getCredentialSource` reads `process.env` +
167
+ // `loadFileConfig` directly because it needs to distinguish env from file.
168
+ const CONFIG_FIELD_BY_ID = {
169
+ alpha_vantage: "alphaVantageApiKey",
170
+ fred: "fredApiKey",
171
+ finnhub: "finnhubApiKey",
172
+ brave: "braveApiKey",
173
+ exa: "exaApiKey",
174
+ };
175
+ export function hasCredential(id) {
176
+ const field = CONFIG_FIELD_BY_ID[id];
177
+ const value = getConfig()[field];
178
+ return typeof value === "string" && value.length > 0;
179
+ }
180
+ export function getCredentialSource(id) {
181
+ const descriptor = getProvider(id);
182
+ const envValue = process.env[descriptor.envVar];
183
+ if (envValue && envValue.length > 0)
184
+ return "env";
185
+ // Lazy file-config read — only invoked when env is absent.
186
+ const fileConfig = loadFileConfig();
187
+ const fileValue = readConfigValueByPath(fileConfig, descriptor.configPath);
188
+ if (fileValue)
189
+ return "file";
190
+ return "absent";
191
+ }
192
+ // -----------------------------------------------------------------------------
193
+ // /connect argument resolution
194
+ // -----------------------------------------------------------------------------
195
+ export function resolveProviderFromArgument(arg) {
196
+ const needle = arg.trim().toLowerCase();
197
+ if (!needle)
198
+ return undefined;
199
+ // 1. Exact provider id match (case-insensitive).
200
+ for (const p of PROVIDERS) {
201
+ if (p.id === needle)
202
+ return p;
203
+ }
204
+ // 2. Exact alias match.
205
+ for (const p of PROVIDERS) {
206
+ if (p.aliases.includes(needle))
207
+ return p;
208
+ }
209
+ // 3. Category match: if the needle matches a category name, return the
210
+ // providers in that category. One match → single descriptor. Multiple
211
+ // matches → array (triggers the sub-picker in the /connect handler).
212
+ const categories = [
213
+ "fundamentals",
214
+ "macro",
215
+ "news",
216
+ "web_search",
217
+ ];
218
+ const normalizedCategory = needle.replace("-", "_");
219
+ if (categories.includes(normalizedCategory)) {
220
+ const group = getProvidersByCategory(normalizedCategory);
221
+ if (group.length === 1)
222
+ return group[0];
223
+ if (group.length > 1)
224
+ return group;
225
+ }
226
+ // 4. Special shared alias: "search" → both web_search providers.
227
+ if (needle === "search" || needle === "web" || needle === "web-search") {
228
+ const searchProviders = getProvidersByCategory("web_search");
229
+ if (searchProviders.length === 1)
230
+ return searchProviders[0];
231
+ if (searchProviders.length > 1)
232
+ return searchProviders;
233
+ }
234
+ return undefined;
235
+ }
236
+ //# sourceMappingURL=providers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/onboarding/providers.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,0EAA0E;AAC1E,0EAA0E;AAC1E,uEAAuE;AACvE,EAAE;AACF,gFAAgF;AAChF,+EAA+E;AAC/E,4EAA4E;AAC5E,2BAA2B;AAE3B,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AA8CzD,iFAAiF;AACjF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB;QACE,EAAE,EAAE,eAAe;QACnB,WAAW,EAAE,eAAe;QAC5B,QAAQ,EAAE,cAAc;QACxB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,CAAC,YAAY,EAAE,cAAc,EAAE,oBAAoB,EAAE,cAAc,CAAC;QAC7E,SAAS,EAAE,8CAA8C;QACzD,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,uBAAuB;QAC/B,UAAU,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC;QACnD,OAAO,EAAE;YACP,sBAAsB;YACtB,oCAAoC;YACpC,eAAe;YACf,kBAAkB;SACnB;QACD,mBAAmB,EAAE,IAAI;QACzB,kBAAkB,EAAE,CAAC;QACrB,gBAAgB,EAAE,sDAAsD;KACzE;IACD;QACE,EAAE,EAAE,MAAM;QACV,WAAW,EAAE,MAAM;QACnB,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,cAAc,CAAC;QAC9D,SAAS,EAAE,4CAA4C;QACvD,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC;QAC3C,OAAO,EAAE;YACP,gBAAgB;YAChB,gBAAgB;YAChB,aAAa;YACb,qBAAqB;SACtB;QACD,mBAAmB,EAAE,IAAI;QACzB,kBAAkB,EAAE,CAAC;QACrB,gBAAgB,EAAE,0DAA0D;KAC7E;IACD;QACE,EAAE,EAAE,SAAS;QACb,WAAW,EAAE,SAAS;QACtB,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,cAAc,CAAC;QACjD,SAAS,EAAE,6BAA6B;QACxC,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,iBAAiB;QACzB,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC;QAC9C,OAAO,EAAE;YACP,4BAA4B;YAC5B,mDAAmD;SACpD;QACD,4EAA4E;QAC5E,0EAA0E;QAC1E,2CAA2C;QAC3C,mBAAmB,EACjB,wFAAwF;QAC1F,kBAAkB,EAAE,CAAC;QACrB,gBAAgB,EAAE,sDAAsD;KACzE;IACD;QACE,EAAE,EAAE,OAAO;QACX,WAAW,EAAE,cAAc;QAC3B,QAAQ,EAAE,YAAY;QACtB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC;QAClC,SAAS,EAAE,+BAA+B;QAC1C,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,eAAe;QACvB,UAAU,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC5C,OAAO,EAAE;YACP,0CAA0C;YAC1C,gDAAgD;SACjD;QACD,mBAAmB,EACjB,4FAA4F;QAC9F,kBAAkB,EAAE,CAAC;QACrB,gBAAgB,EAAE,mDAAmD;KACtE;IACD;QACE,EAAE,EAAE,KAAK;QACT,WAAW,EAAE,KAAK;QAClB,QAAQ,EAAE,YAAY;QACtB,IAAI,EAAE,MAAM;QACZ,2EAA2E;QAC3E,4EAA4E;QAC5E,wEAAwE;QACxE,4EAA4E;QAC5E,0EAA0E;QAC1E,mBAAmB;QACnB,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC;QAC9B,SAAS,EAAE,2BAA2B;QACtC,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,aAAa;QACrB,UAAU,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,QAAQ,CAAC;QAC1C,OAAO,EAAE;YACP,4BAA4B;YAC5B,kCAAkC;YAClC,2CAA2C;SAC5C;QACD,mBAAmB,EACjB,gHAAgH;QAClH,kBAAkB,EAAE,CAAC;QACrB,gBAAgB,EAAE,mDAAmD;KACtE;CAC+C,CAAC;AAEnD,gFAAgF;AAChF,iBAAiB;AACjB,gFAAgF;AAEhF,4EAA4E;AAC5E,+EAA+E;AAC/E,kBAAkB;AAClB,IAAI,aAA8D,CAAC;AAEnE,SAAS,IAAI;IACX,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,aAAa,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,EAAc;IACxC,MAAM,KAAK,GAAG,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,QAA0B;IAE1B,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,IAAkB;IAElB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAClD,CAAC;AAED,gFAAgF;AAChF,4BAA4B;AAC5B,gFAAgF;AAEhF,SAAS,qBAAqB,CAC5B,GAA4B,EAC5B,IAAuB;IAEvB,IAAI,MAAM,GAAY,GAAG,CAAC;IAC1B,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;QAC3B,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAK,MAAiB,EAAE,CAAC;YAC1E,MAAM,GAAI,MAAkC,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9E,CAAC;AAED,2EAA2E;AAC3E,8EAA8E;AAC9E,6EAA6E;AAC7E,qEAAqE;AACrE,2EAA2E;AAC3E,MAAM,kBAAkB,GAA2D;IACjF,aAAa,EAAE,oBAAoB;IACnC,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE,eAAe;IACxB,KAAK,EAAE,aAAa;IACpB,GAAG,EAAE,WAAW;CACjB,CAAC;AAEF,MAAM,UAAU,aAAa,CAAC,EAAc;IAC1C,MAAM,KAAK,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC;IACjC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,EAAc;IAEd,MAAM,UAAU,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAChD,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAElD,2DAA2D;IAC3D,MAAM,UAAU,GAAG,cAAc,EAAwC,CAAC;IAC1E,MAAM,SAAS,GAAG,qBAAqB,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAC3E,IAAI,SAAS;QAAE,OAAO,MAAM,CAAC;IAE7B,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,gFAAgF;AAChF,+BAA+B;AAC/B,gFAAgF;AAEhF,MAAM,UAAU,2BAA2B,CACzC,GAAW;IAKX,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACxC,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAE9B,iDAAiD;IACjD,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1B,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;YAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,wBAAwB;IACxB,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1B,IAAK,CAAC,CAAC,OAA6B,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,uEAAuE;IACvE,yEAAyE;IACzE,wEAAwE;IACxE,MAAM,UAAU,GAAgC;QAC9C,cAAc;QACd,OAAO;QACP,MAAM;QACN,YAAY;KACb,CAAC;IACF,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACpD,IAAK,UAAgC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACnE,MAAM,KAAK,GAAG,sBAAsB,CAAC,kBAAsC,CAAC,CAAC;QAC7E,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QACxC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;IACrC,CAAC;IAED,iEAAiE;IACjE,IAAI,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,YAAY,EAAE,CAAC;QACvE,MAAM,eAAe,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC;QAC7D,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC;QAC5D,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,eAAe,CAAC;IACzD,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}
@@ -1,8 +1,37 @@
1
- export declare const ONBOARDING_VERSION = 1;
1
+ import type { ProviderId } from "./providers.js";
2
+ export declare const ONBOARDING_VERSION = 2;
3
+ export type ProviderOnboardingEntry = {
4
+ status: "completed";
5
+ lastPromptAt: string;
6
+ } | {
7
+ status: "snoozed";
8
+ lastPromptAt: string;
9
+ snoozeUntil: string;
10
+ } | {
11
+ status: "never_ask";
12
+ lastPromptAt: string;
13
+ };
2
14
  export interface OnboardingState {
3
15
  version: number;
4
- financeSetupStatus?: "dismissed" | "completed";
16
+ /** ISO 8601 timestamp the welcome message was first seeded, or undefined if never. */
17
+ welcomeShownAt?: string;
18
+ providers: Partial<Record<ProviderId, ProviderOnboardingEntry>>;
5
19
  }
6
20
  export declare function getDefaultOnboardingState(): OnboardingState;
7
21
  export declare function loadOnboardingState(path?: string): OnboardingState;
8
22
  export declare function saveOnboardingState(state: OnboardingState, path?: string): void;
23
+ export declare function markProviderCompleted(state: OnboardingState, id: ProviderId): OnboardingState;
24
+ export declare function markProviderSnoozed(state: OnboardingState, id: ProviderId, days: number): OnboardingState;
25
+ export declare function markProviderNeverAsk(state: OnboardingState, id: ProviderId): OnboardingState;
26
+ export declare function markWelcomeShown(state: OnboardingState): OnboardingState;
27
+ export declare function getProviderEntry(state: OnboardingState, id: ProviderId): ProviderOnboardingEntry | undefined;
28
+ export interface ShouldPromptOptions {
29
+ /**
30
+ * When true, treats a `completed` entry as eligible for re-prompt. This is
31
+ * how stale credentials (401 after a previously-connected key) get a fresh
32
+ * offer.
33
+ */
34
+ stale?: boolean;
35
+ }
36
+ export declare function shouldPrompt(state: OnboardingState, id: ProviderId, now: Date, options?: ShouldPromptOptions): boolean;
37
+ export declare function shouldShowWelcome(state: OnboardingState, hasUI: boolean): boolean;