@shinobiapps/shinobi 0.1.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 (378) hide show
  1. package/CHANGELOG.md +70 -0
  2. package/CODE_OF_CONDUCT.md +70 -0
  3. package/LICENSE +21 -0
  4. package/README.md +269 -0
  5. package/SECURITY.md +75 -0
  6. package/dist/cli.d.ts +3 -0
  7. package/dist/cli.d.ts.map +1 -0
  8. package/dist/cli.js +200 -0
  9. package/dist/cli.js.map +1 -0
  10. package/dist/commands/cost.d.ts +9 -0
  11. package/dist/commands/cost.d.ts.map +1 -0
  12. package/dist/commands/cost.js +49 -0
  13. package/dist/commands/cost.js.map +1 -0
  14. package/dist/commands/digest.d.ts +29 -0
  15. package/dist/commands/digest.d.ts.map +1 -0
  16. package/dist/commands/digest.js +63 -0
  17. package/dist/commands/digest.js.map +1 -0
  18. package/dist/commands/init.d.ts +15 -0
  19. package/dist/commands/init.d.ts.map +1 -0
  20. package/dist/commands/init.js +81 -0
  21. package/dist/commands/init.js.map +1 -0
  22. package/dist/commands/sync.d.ts +5 -0
  23. package/dist/commands/sync.d.ts.map +1 -0
  24. package/dist/commands/sync.js +160 -0
  25. package/dist/commands/sync.js.map +1 -0
  26. package/dist/dashboard/auth.d.ts +17 -0
  27. package/dist/dashboard/auth.d.ts.map +1 -0
  28. package/dist/dashboard/auth.js +108 -0
  29. package/dist/dashboard/auth.js.map +1 -0
  30. package/dist/dashboard/server.d.ts +16 -0
  31. package/dist/dashboard/server.d.ts.map +1 -0
  32. package/dist/dashboard/server.js +1020 -0
  33. package/dist/dashboard/server.js.map +1 -0
  34. package/dist/dashboard/settings-store.d.ts +46 -0
  35. package/dist/dashboard/settings-store.d.ts.map +1 -0
  36. package/dist/dashboard/settings-store.js +183 -0
  37. package/dist/dashboard/settings-store.js.map +1 -0
  38. package/dist/dashboard-spa/apple-touch-icon.png +0 -0
  39. package/dist/dashboard-spa/assets/index-0vWLEg34.css +1 -0
  40. package/dist/dashboard-spa/assets/index-Rnhs9802.js +263 -0
  41. package/dist/dashboard-spa/assets/index-Rnhs9802.js.map +1 -0
  42. package/dist/dashboard-spa/icon-192.png +0 -0
  43. package/dist/dashboard-spa/icon-192.svg +4 -0
  44. package/dist/dashboard-spa/icon-512.png +0 -0
  45. package/dist/dashboard-spa/index.html +29 -0
  46. package/dist/dashboard-spa/manifest.webmanifest +37 -0
  47. package/dist/dashboard-spa/sw.js +111 -0
  48. package/dist/lib/config.d.ts +14 -0
  49. package/dist/lib/config.d.ts.map +1 -0
  50. package/dist/lib/config.js +36 -0
  51. package/dist/lib/config.js.map +1 -0
  52. package/dist/lib/db.d.ts +5 -0
  53. package/dist/lib/db.d.ts.map +1 -0
  54. package/dist/lib/db.js +33 -0
  55. package/dist/lib/db.js.map +1 -0
  56. package/dist/lib/fts.d.ts +2 -0
  57. package/dist/lib/fts.d.ts.map +1 -0
  58. package/dist/lib/fts.js +14 -0
  59. package/dist/lib/fts.js.map +1 -0
  60. package/dist/lib/json.d.ts +3 -0
  61. package/dist/lib/json.d.ts.map +1 -0
  62. package/dist/lib/json.js +16 -0
  63. package/dist/lib/json.js.map +1 -0
  64. package/dist/lib/migrations.d.ts +9 -0
  65. package/dist/lib/migrations.d.ts.map +1 -0
  66. package/dist/lib/migrations.js +94 -0
  67. package/dist/lib/migrations.js.map +1 -0
  68. package/dist/lib/priority.d.ts +2 -0
  69. package/dist/lib/priority.d.ts.map +1 -0
  70. package/dist/lib/priority.js +8 -0
  71. package/dist/lib/priority.js.map +1 -0
  72. package/dist/models/activity.d.ts +41 -0
  73. package/dist/models/activity.d.ts.map +1 -0
  74. package/dist/models/activity.js +55 -0
  75. package/dist/models/activity.js.map +1 -0
  76. package/dist/models/approvals.d.ts +43 -0
  77. package/dist/models/approvals.d.ts.map +1 -0
  78. package/dist/models/approvals.js +102 -0
  79. package/dist/models/approvals.js.map +1 -0
  80. package/dist/models/context.d.ts +25 -0
  81. package/dist/models/context.d.ts.map +1 -0
  82. package/dist/models/context.js +63 -0
  83. package/dist/models/context.js.map +1 -0
  84. package/dist/models/dead_ends-helpers.d.ts +3 -0
  85. package/dist/models/dead_ends-helpers.d.ts.map +1 -0
  86. package/dist/models/dead_ends-helpers.js +9 -0
  87. package/dist/models/dead_ends-helpers.js.map +1 -0
  88. package/dist/models/dead_ends.d.ts +41 -0
  89. package/dist/models/dead_ends.d.ts.map +1 -0
  90. package/dist/models/dead_ends.js +96 -0
  91. package/dist/models/dead_ends.js.map +1 -0
  92. package/dist/models/decision_drafts.d.ts +59 -0
  93. package/dist/models/decision_drafts.d.ts.map +1 -0
  94. package/dist/models/decision_drafts.js +105 -0
  95. package/dist/models/decision_drafts.js.map +1 -0
  96. package/dist/models/decisions-helpers.d.ts +3 -0
  97. package/dist/models/decisions-helpers.d.ts.map +1 -0
  98. package/dist/models/decisions-helpers.js +9 -0
  99. package/dist/models/decisions-helpers.js.map +1 -0
  100. package/dist/models/decisions.d.ts +51 -0
  101. package/dist/models/decisions.d.ts.map +1 -0
  102. package/dist/models/decisions.js +97 -0
  103. package/dist/models/decisions.js.map +1 -0
  104. package/dist/models/notes-helpers.d.ts +3 -0
  105. package/dist/models/notes-helpers.d.ts.map +1 -0
  106. package/dist/models/notes-helpers.js +9 -0
  107. package/dist/models/notes-helpers.js.map +1 -0
  108. package/dist/models/notes.d.ts +35 -0
  109. package/dist/models/notes.d.ts.map +1 -0
  110. package/dist/models/notes.js +66 -0
  111. package/dist/models/notes.js.map +1 -0
  112. package/dist/models/plans.d.ts +25 -0
  113. package/dist/models/plans.d.ts.map +1 -0
  114. package/dist/models/plans.js +39 -0
  115. package/dist/models/plans.js.map +1 -0
  116. package/dist/models/pr_links.d.ts +36 -0
  117. package/dist/models/pr_links.d.ts.map +1 -0
  118. package/dist/models/pr_links.js +45 -0
  119. package/dist/models/pr_links.js.map +1 -0
  120. package/dist/models/project_members.d.ts +22 -0
  121. package/dist/models/project_members.d.ts.map +1 -0
  122. package/dist/models/project_members.js +33 -0
  123. package/dist/models/project_members.js.map +1 -0
  124. package/dist/models/projects.d.ts +55 -0
  125. package/dist/models/projects.d.ts.map +1 -0
  126. package/dist/models/projects.js +126 -0
  127. package/dist/models/projects.js.map +1 -0
  128. package/dist/models/push_subscriptions.d.ts +24 -0
  129. package/dist/models/push_subscriptions.d.ts.map +1 -0
  130. package/dist/models/push_subscriptions.js +39 -0
  131. package/dist/models/push_subscriptions.js.map +1 -0
  132. package/dist/models/session_costs.d.ts +48 -0
  133. package/dist/models/session_costs.d.ts.map +1 -0
  134. package/dist/models/session_costs.js +77 -0
  135. package/dist/models/session_costs.js.map +1 -0
  136. package/dist/models/sessions.d.ts +41 -0
  137. package/dist/models/sessions.d.ts.map +1 -0
  138. package/dist/models/sessions.js +96 -0
  139. package/dist/models/sessions.js.map +1 -0
  140. package/dist/models/subtasks-helpers.d.ts +3 -0
  141. package/dist/models/subtasks-helpers.d.ts.map +1 -0
  142. package/dist/models/subtasks-helpers.js +9 -0
  143. package/dist/models/subtasks-helpers.js.map +1 -0
  144. package/dist/models/subtasks.d.ts +69 -0
  145. package/dist/models/subtasks.d.ts.map +1 -0
  146. package/dist/models/subtasks.js +215 -0
  147. package/dist/models/subtasks.js.map +1 -0
  148. package/dist/models/users.d.ts +25 -0
  149. package/dist/models/users.d.ts.map +1 -0
  150. package/dist/models/users.js +44 -0
  151. package/dist/models/users.js.map +1 -0
  152. package/dist/server/mcp.d.ts +6 -0
  153. package/dist/server/mcp.d.ts.map +1 -0
  154. package/dist/server/mcp.js +72 -0
  155. package/dist/server/mcp.js.map +1 -0
  156. package/dist/server/tools/approval.d.ts +3 -0
  157. package/dist/server/tools/approval.d.ts.map +1 -0
  158. package/dist/server/tools/approval.js +98 -0
  159. package/dist/server/tools/approval.js.map +1 -0
  160. package/dist/server/tools/args.d.ts +11 -0
  161. package/dist/server/tools/args.d.ts.map +1 -0
  162. package/dist/server/tools/args.js +79 -0
  163. package/dist/server/tools/args.js.map +1 -0
  164. package/dist/server/tools/context.d.ts +3 -0
  165. package/dist/server/tools/context.d.ts.map +1 -0
  166. package/dist/server/tools/context.js +72 -0
  167. package/dist/server/tools/context.js.map +1 -0
  168. package/dist/server/tools/dead_ends.d.ts +3 -0
  169. package/dist/server/tools/dead_ends.d.ts.map +1 -0
  170. package/dist/server/tools/dead_ends.js +111 -0
  171. package/dist/server/tools/dead_ends.js.map +1 -0
  172. package/dist/server/tools/decisions.d.ts +3 -0
  173. package/dist/server/tools/decisions.d.ts.map +1 -0
  174. package/dist/server/tools/decisions.js +101 -0
  175. package/dist/server/tools/decisions.js.map +1 -0
  176. package/dist/server/tools/extraction.d.ts +3 -0
  177. package/dist/server/tools/extraction.d.ts.map +1 -0
  178. package/dist/server/tools/extraction.js +145 -0
  179. package/dist/server/tools/extraction.js.map +1 -0
  180. package/dist/server/tools/git.d.ts +3 -0
  181. package/dist/server/tools/git.d.ts.map +1 -0
  182. package/dist/server/tools/git.js +86 -0
  183. package/dist/server/tools/git.js.map +1 -0
  184. package/dist/server/tools/history.d.ts +3 -0
  185. package/dist/server/tools/history.d.ts.map +1 -0
  186. package/dist/server/tools/history.js +51 -0
  187. package/dist/server/tools/history.js.map +1 -0
  188. package/dist/server/tools/index.d.ts +6 -0
  189. package/dist/server/tools/index.d.ts.map +1 -0
  190. package/dist/server/tools/index.js +41 -0
  191. package/dist/server/tools/index.js.map +1 -0
  192. package/dist/server/tools/notes.d.ts +3 -0
  193. package/dist/server/tools/notes.d.ts.map +1 -0
  194. package/dist/server/tools/notes.js +60 -0
  195. package/dist/server/tools/notes.js.map +1 -0
  196. package/dist/server/tools/plans.d.ts +3 -0
  197. package/dist/server/tools/plans.d.ts.map +1 -0
  198. package/dist/server/tools/plans.js +65 -0
  199. package/dist/server/tools/plans.js.map +1 -0
  200. package/dist/server/tools/plugin.d.ts +3 -0
  201. package/dist/server/tools/plugin.d.ts.map +1 -0
  202. package/dist/server/tools/plugin.js +26 -0
  203. package/dist/server/tools/plugin.js.map +1 -0
  204. package/dist/server/tools/projects.d.ts +3 -0
  205. package/dist/server/tools/projects.d.ts.map +1 -0
  206. package/dist/server/tools/projects.js +197 -0
  207. package/dist/server/tools/projects.js.map +1 -0
  208. package/dist/server/tools/recall.d.ts +3 -0
  209. package/dist/server/tools/recall.d.ts.map +1 -0
  210. package/dist/server/tools/recall.js +74 -0
  211. package/dist/server/tools/recall.js.map +1 -0
  212. package/dist/server/tools/registry.d.ts +8 -0
  213. package/dist/server/tools/registry.d.ts.map +1 -0
  214. package/dist/server/tools/registry.js +23 -0
  215. package/dist/server/tools/registry.js.map +1 -0
  216. package/dist/server/tools/subtasks.d.ts +3 -0
  217. package/dist/server/tools/subtasks.d.ts.map +1 -0
  218. package/dist/server/tools/subtasks.js +306 -0
  219. package/dist/server/tools/subtasks.js.map +1 -0
  220. package/dist/server/tools/types.d.ts +7 -0
  221. package/dist/server/tools/types.d.ts.map +1 -0
  222. package/dist/server/tools/types.js +2 -0
  223. package/dist/server/tools/types.js.map +1 -0
  224. package/dist/server/tools/workflow.d.ts +3 -0
  225. package/dist/server/tools/workflow.d.ts.map +1 -0
  226. package/dist/server/tools/workflow.js +434 -0
  227. package/dist/server/tools/workflow.js.map +1 -0
  228. package/dist/services/auth/magic-link.d.ts +27 -0
  229. package/dist/services/auth/magic-link.d.ts.map +1 -0
  230. package/dist/services/auth/magic-link.js +48 -0
  231. package/dist/services/auth/magic-link.js.map +1 -0
  232. package/dist/services/auth/session.d.ts +15 -0
  233. package/dist/services/auth/session.d.ts.map +1 -0
  234. package/dist/services/auth/session.js +65 -0
  235. package/dist/services/auth/session.js.map +1 -0
  236. package/dist/services/cost/claude-code-parser.d.ts +30 -0
  237. package/dist/services/cost/claude-code-parser.d.ts.map +1 -0
  238. package/dist/services/cost/claude-code-parser.js +110 -0
  239. package/dist/services/cost/claude-code-parser.js.map +1 -0
  240. package/dist/services/cost/pricing.d.ts +15 -0
  241. package/dist/services/cost/pricing.d.ts.map +1 -0
  242. package/dist/services/cost/pricing.js +33 -0
  243. package/dist/services/cost/pricing.js.map +1 -0
  244. package/dist/services/digest/generator.d.ts +51 -0
  245. package/dist/services/digest/generator.d.ts.map +1 -0
  246. package/dist/services/digest/generator.js +136 -0
  247. package/dist/services/digest/generator.js.map +1 -0
  248. package/dist/services/digest/scheduler.d.ts +3 -0
  249. package/dist/services/digest/scheduler.d.ts.map +1 -0
  250. package/dist/services/digest/scheduler.js +61 -0
  251. package/dist/services/digest/scheduler.js.map +1 -0
  252. package/dist/services/digest/telegram.d.ts +13 -0
  253. package/dist/services/digest/telegram.d.ts.map +1 -0
  254. package/dist/services/digest/telegram.js +68 -0
  255. package/dist/services/digest/telegram.js.map +1 -0
  256. package/dist/services/embedding/detect.d.ts +19 -0
  257. package/dist/services/embedding/detect.d.ts.map +1 -0
  258. package/dist/services/embedding/detect.js +64 -0
  259. package/dist/services/embedding/detect.js.map +1 -0
  260. package/dist/services/embedding/factory.d.ts +10 -0
  261. package/dist/services/embedding/factory.d.ts.map +1 -0
  262. package/dist/services/embedding/factory.js +79 -0
  263. package/dist/services/embedding/factory.js.map +1 -0
  264. package/dist/services/embedding/ollama.d.ts +14 -0
  265. package/dist/services/embedding/ollama.d.ts.map +1 -0
  266. package/dist/services/embedding/ollama.js +28 -0
  267. package/dist/services/embedding/ollama.js.map +1 -0
  268. package/dist/services/embedding/openai.d.ts +16 -0
  269. package/dist/services/embedding/openai.d.ts.map +1 -0
  270. package/dist/services/embedding/openai.js +33 -0
  271. package/dist/services/embedding/openai.js.map +1 -0
  272. package/dist/services/embedding/store.d.ts +25 -0
  273. package/dist/services/embedding/store.d.ts.map +1 -0
  274. package/dist/services/embedding/store.js +79 -0
  275. package/dist/services/embedding/store.js.map +1 -0
  276. package/dist/services/embedding/types.d.ts +9 -0
  277. package/dist/services/embedding/types.d.ts.map +1 -0
  278. package/dist/services/embedding/types.js +2 -0
  279. package/dist/services/embedding/types.js.map +1 -0
  280. package/dist/services/embedding/vector-math.d.ts +4 -0
  281. package/dist/services/embedding/vector-math.d.ts.map +1 -0
  282. package/dist/services/embedding/vector-math.js +27 -0
  283. package/dist/services/embedding/vector-math.js.map +1 -0
  284. package/dist/services/embedding/voyage.d.ts +16 -0
  285. package/dist/services/embedding/voyage.d.ts.map +1 -0
  286. package/dist/services/embedding/voyage.js +33 -0
  287. package/dist/services/embedding/voyage.js.map +1 -0
  288. package/dist/services/extraction/decision-extractor.d.ts +16 -0
  289. package/dist/services/extraction/decision-extractor.d.ts.map +1 -0
  290. package/dist/services/extraction/decision-extractor.js +111 -0
  291. package/dist/services/extraction/decision-extractor.js.map +1 -0
  292. package/dist/services/extraction/session-summarizer.d.ts +17 -0
  293. package/dist/services/extraction/session-summarizer.d.ts.map +1 -0
  294. package/dist/services/extraction/session-summarizer.js +112 -0
  295. package/dist/services/extraction/session-summarizer.js.map +1 -0
  296. package/dist/services/github/webhook.d.ts +17 -0
  297. package/dist/services/github/webhook.d.ts.map +1 -0
  298. package/dist/services/github/webhook.js +159 -0
  299. package/dist/services/github/webhook.js.map +1 -0
  300. package/dist/services/llm/factory.d.ts +3 -0
  301. package/dist/services/llm/factory.d.ts.map +1 -0
  302. package/dist/services/llm/factory.js +53 -0
  303. package/dist/services/llm/factory.js.map +1 -0
  304. package/dist/services/llm/openai-compat.d.ts +20 -0
  305. package/dist/services/llm/openai-compat.d.ts.map +1 -0
  306. package/dist/services/llm/openai-compat.js +53 -0
  307. package/dist/services/llm/openai-compat.js.map +1 -0
  308. package/dist/services/llm/types.d.ts +23 -0
  309. package/dist/services/llm/types.d.ts.map +1 -0
  310. package/dist/services/llm/types.js +2 -0
  311. package/dist/services/llm/types.js.map +1 -0
  312. package/dist/services/mentions/resolver.d.ts +36 -0
  313. package/dist/services/mentions/resolver.d.ts.map +1 -0
  314. package/dist/services/mentions/resolver.js +97 -0
  315. package/dist/services/mentions/resolver.js.map +1 -0
  316. package/dist/services/plugins/api.d.ts +55 -0
  317. package/dist/services/plugins/api.d.ts.map +1 -0
  318. package/dist/services/plugins/api.js +35 -0
  319. package/dist/services/plugins/api.js.map +1 -0
  320. package/dist/services/plugins/discovery.d.ts +7 -0
  321. package/dist/services/plugins/discovery.d.ts.map +1 -0
  322. package/dist/services/plugins/discovery.js +104 -0
  323. package/dist/services/plugins/discovery.js.map +1 -0
  324. package/dist/services/plugins/marketplace.d.ts +42 -0
  325. package/dist/services/plugins/marketplace.d.ts.map +1 -0
  326. package/dist/services/plugins/marketplace.js +186 -0
  327. package/dist/services/plugins/marketplace.js.map +1 -0
  328. package/dist/services/plugins/registry.d.ts +12 -0
  329. package/dist/services/plugins/registry.d.ts.map +1 -0
  330. package/dist/services/plugins/registry.js +66 -0
  331. package/dist/services/plugins/registry.js.map +1 -0
  332. package/dist/services/plugins/state.d.ts +12 -0
  333. package/dist/services/plugins/state.d.ts.map +1 -0
  334. package/dist/services/plugins/state.js +14 -0
  335. package/dist/services/plugins/state.js.map +1 -0
  336. package/dist/services/push/web-push.d.ts +26 -0
  337. package/dist/services/push/web-push.d.ts.map +1 -0
  338. package/dist/services/push/web-push.js +84 -0
  339. package/dist/services/push/web-push.js.map +1 -0
  340. package/dist/services/relay/client.d.ts +27 -0
  341. package/dist/services/relay/client.d.ts.map +1 -0
  342. package/dist/services/relay/client.js +219 -0
  343. package/dist/services/relay/client.js.map +1 -0
  344. package/dist/services/relay/types.d.ts +19 -0
  345. package/dist/services/relay/types.d.ts.map +1 -0
  346. package/dist/services/relay/types.js +2 -0
  347. package/dist/services/relay/types.js.map +1 -0
  348. package/dist/services/telemetry/client.d.ts +35 -0
  349. package/dist/services/telemetry/client.d.ts.map +1 -0
  350. package/dist/services/telemetry/client.js +125 -0
  351. package/dist/services/telemetry/client.js.map +1 -0
  352. package/dist/services/transcription/whisper.d.ts +16 -0
  353. package/dist/services/transcription/whisper.d.ts.map +1 -0
  354. package/dist/services/transcription/whisper.js +72 -0
  355. package/dist/services/transcription/whisper.js.map +1 -0
  356. package/docs/architecture.md +108 -0
  357. package/docs/configuration.md +73 -0
  358. package/docs/cursor-quirks.md +42 -0
  359. package/docs/embedding-providers.md +110 -0
  360. package/docs/github-integration.md +109 -0
  361. package/docs/plugin-development.md +104 -0
  362. package/docs/plugins.md +104 -0
  363. package/docs/relay.md +108 -0
  364. package/docs/remote-access.md +218 -0
  365. package/docs/sponsorship.md +54 -0
  366. package/migrations/.gitkeep +0 -0
  367. package/migrations/0001_initial_schema.sql +284 -0
  368. package/migrations/0002_activity_and_links.sql +26 -0
  369. package/migrations/0003_workspace.sql +7 -0
  370. package/migrations/0004_decision_drafts.sql +28 -0
  371. package/migrations/0005_project_summaries.sql +10 -0
  372. package/migrations/0006_push_and_approvals.sql +37 -0
  373. package/migrations/0007_session_costs.sql +17 -0
  374. package/migrations/0008_pr_links.sql +22 -0
  375. package/migrations/0009_telemetry.sql +17 -0
  376. package/migrations/0010_users_and_members.sql +40 -0
  377. package/migrations/0011_assignments_mentions.sql +20 -0
  378. package/package.json +95 -0
@@ -0,0 +1,125 @@
1
+ // Anonymous, opt-in telemetry. Off by default. When SHINOBI_TELEMETRY=on,
2
+ // records events into the local telemetry_events table for inspection and
3
+ // optionally batches them to SHINOBI_TELEMETRY_ENDPOINT.
4
+ //
5
+ // Privacy rules (enforced by callers, not the transport):
6
+ // - NEVER include project titles, task titles, file paths, code snippets,
7
+ // decision bodies, note contents, prompt text, model output, IP addresses,
8
+ // usernames, or any identifier that links events to a specific human.
9
+ // - Allowed: enum values (tool name, view path, provider name), small
10
+ // non-negative integers (counts, byte sizes rounded), boolean flags.
11
+ import { stderr } from 'node:process';
12
+ import { getDb } from '../../lib/db.js';
13
+ import { readEnvFile } from '../../dashboard/settings-store.js';
14
+ let enabledCache = null;
15
+ function envValue(key) {
16
+ const env = readEnvFile().values;
17
+ return env[key] ?? process.env[key] ?? null;
18
+ }
19
+ export function isTelemetryEnabled() {
20
+ if (enabledCache !== null)
21
+ return enabledCache;
22
+ const raw = (envValue('SHINOBI_TELEMETRY') ?? 'off').toLowerCase();
23
+ enabledCache = raw === 'on' || raw === 'true' || raw === '1';
24
+ return enabledCache;
25
+ }
26
+ export function resetTelemetryEnabledCache() {
27
+ enabledCache = null;
28
+ }
29
+ export function trackEvent(eventType, payload) {
30
+ if (!isTelemetryEnabled())
31
+ return;
32
+ try {
33
+ getDb()
34
+ .prepare('INSERT INTO telemetry_events (event_type, payload_json) VALUES (?, ?)')
35
+ .run(eventType, payload ? JSON.stringify(payload) : null);
36
+ }
37
+ catch (err) {
38
+ // Telemetry must never break the host. Worst-case we silently drop.
39
+ stderr.write(`telemetry: insert failed (${err instanceof Error ? err.message : String(err)})\n`);
40
+ }
41
+ }
42
+ export function getTelemetrySummary() {
43
+ const db = getDb();
44
+ const total = db.prepare('SELECT COUNT(*) AS n FROM telemetry_events').get().n;
45
+ const unsent = db.prepare('SELECT COUNT(*) AS n FROM telemetry_events WHERE sent_at IS NULL').get().n;
46
+ const last = db.prepare('SELECT MAX(recorded_at) AS r, MAX(sent_at) AS s FROM telemetry_events').get();
47
+ const byType = db
48
+ .prepare(`SELECT event_type, COUNT(*) AS count
49
+ FROM telemetry_events
50
+ GROUP BY event_type
51
+ ORDER BY count DESC
52
+ LIMIT 30`)
53
+ .all();
54
+ const last7d = db.prepare(`SELECT COUNT(*) AS n FROM telemetry_events
55
+ WHERE recorded_at >= datetime('now', '-7 days')`).get().n;
56
+ return {
57
+ enabled: isTelemetryEnabled(),
58
+ total_events: total,
59
+ unsent_events: unsent,
60
+ last_recorded_at: last.r,
61
+ last_sent_at: last.s,
62
+ endpoint_configured: envValue('SHINOBI_TELEMETRY_ENDPOINT') !== null,
63
+ by_event_type: byType,
64
+ last_7d_count: last7d,
65
+ };
66
+ }
67
+ export async function flushTelemetry(batchLimit = 200) {
68
+ const endpoint = envValue('SHINOBI_TELEMETRY_ENDPOINT');
69
+ if (!endpoint) {
70
+ return { ok: false, attempted: 0, sent: 0, endpoint: null, error: 'SHINOBI_TELEMETRY_ENDPOINT not configured' };
71
+ }
72
+ const rows = getDb()
73
+ .prepare(`SELECT * FROM telemetry_events WHERE sent_at IS NULL ORDER BY id ASC LIMIT ?`)
74
+ .all(batchLimit);
75
+ if (rows.length === 0) {
76
+ return { ok: true, attempted: 0, sent: 0, endpoint };
77
+ }
78
+ const payload = rows.map((r) => ({
79
+ event_type: r.event_type,
80
+ payload: r.payload_json ? JSON.parse(r.payload_json) : null,
81
+ recorded_at: r.recorded_at,
82
+ }));
83
+ let response;
84
+ try {
85
+ response = await fetch(endpoint, {
86
+ method: 'POST',
87
+ headers: { 'Content-Type': 'application/json' },
88
+ body: JSON.stringify({ events: payload }),
89
+ });
90
+ }
91
+ catch (err) {
92
+ return {
93
+ ok: false,
94
+ attempted: rows.length,
95
+ sent: 0,
96
+ endpoint,
97
+ error: err instanceof Error ? err.message : String(err),
98
+ };
99
+ }
100
+ if (!response.ok) {
101
+ return {
102
+ ok: false,
103
+ attempted: rows.length,
104
+ sent: 0,
105
+ endpoint,
106
+ status: response.status,
107
+ error: `endpoint returned ${response.status}`,
108
+ };
109
+ }
110
+ // Mark rows as sent.
111
+ const markStmt = getDb().prepare('UPDATE telemetry_events SET sent_at = CURRENT_TIMESTAMP WHERE id = ?');
112
+ const tx = getDb().transaction((ids) => {
113
+ for (const id of ids)
114
+ markStmt.run(id);
115
+ });
116
+ tx(rows.map((r) => r.id));
117
+ return { ok: true, attempted: rows.length, sent: rows.length, endpoint, status: response.status };
118
+ }
119
+ export function purgeOldTelemetry(olderThanDays = 90) {
120
+ const r = getDb()
121
+ .prepare(`DELETE FROM telemetry_events WHERE recorded_at < datetime('now', ?)`)
122
+ .run(`-${olderThanDays} days`);
123
+ return r.changes;
124
+ }
125
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/services/telemetry/client.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,0EAA0E;AAC1E,yDAAyD;AACzD,EAAE;AACF,0DAA0D;AAC1D,4EAA4E;AAC5E,+EAA+E;AAC/E,0EAA0E;AAC1E,wEAAwE;AACxE,yEAAyE;AAEzE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAUhE,IAAI,YAAY,GAAmB,IAAI,CAAC;AAExC,SAAS,QAAQ,CAAC,GAAW;IAC3B,MAAM,GAAG,GAAG,WAAW,EAAE,CAAC,MAAM,CAAC;IACjC,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,kBAAkB;IAChC,IAAI,YAAY,KAAK,IAAI;QAAE,OAAO,YAAY,CAAC;IAC/C,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IACnE,YAAY,GAAG,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,GAAG,CAAC;IAC7D,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,0BAA0B;IACxC,YAAY,GAAG,IAAI,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,SAAiB,EAAE,OAAiC;IAC7E,IAAI,CAAC,kBAAkB,EAAE;QAAE,OAAO;IAClC,IAAI,CAAC;QACH,KAAK,EAAE;aACJ,OAAO,CAAC,uEAAuE,CAAC;aAChF,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,oEAAoE;QACpE,MAAM,CAAC,KAAK,CAAC,6BAA6B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACnG,CAAC;AACH,CAAC;AAaD,MAAM,UAAU,mBAAmB;IACjC,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IACnB,MAAM,KAAK,GAAI,EAAE,CAAC,OAAO,CAAC,4CAA4C,CAAC,CAAC,GAAG,EAAoB,CAAC,CAAC,CAAC;IAClG,MAAM,MAAM,GAAI,EAAE,CAAC,OAAO,CAAC,kEAAkE,CAAC,CAAC,GAAG,EAAoB,CAAC,CAAC,CAAC;IACzH,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,CAAC,uEAAuE,CAAC,CAAC,GAAG,EAGnG,CAAC;IACF,MAAM,MAAM,GAAG,EAAE;SACd,OAAO,CACN;;;;gBAIU,CACX;SACA,GAAG,EAAkD,CAAC;IACzD,MAAM,MAAM,GAAI,EAAE,CAAC,OAAO,CACxB;qDACiD,CAClD,CAAC,GAAG,EAAoB,CAAC,CAAC,CAAC;IAC5B,OAAO;QACL,OAAO,EAAE,kBAAkB,EAAE;QAC7B,YAAY,EAAE,KAAK;QACnB,aAAa,EAAE,MAAM;QACrB,gBAAgB,EAAE,IAAI,CAAC,CAAC;QACxB,YAAY,EAAE,IAAI,CAAC,CAAC;QACpB,mBAAmB,EAAE,QAAQ,CAAC,4BAA4B,CAAC,KAAK,IAAI;QACpE,aAAa,EAAE,MAAM;QACrB,aAAa,EAAE,MAAM;KACtB,CAAC;AACJ,CAAC;AAWD,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,UAAU,GAAG,GAAG;IACnD,MAAM,QAAQ,GAAG,QAAQ,CAAC,4BAA4B,CAAC,CAAC;IACxD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,2CAA2C,EAAE,CAAC;IAClH,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,EAAE;SACjB,OAAO,CACN,8EAA8E,CAC/E;SACA,GAAG,CAAC,UAAU,CAAC,CAAC;IACnB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvD,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC/B,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,OAAO,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI;QAC3D,WAAW,EAAE,CAAC,CAAC,WAAW;KAC3B,CAAC,CAAC,CAAC;IACJ,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;YAC/B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;SAC1C,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,EAAE,EAAE,KAAK;YACT,SAAS,EAAE,IAAI,CAAC,MAAM;YACtB,IAAI,EAAE,CAAC;YACP,QAAQ;YACR,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SACxD,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,SAAS,EAAE,IAAI,CAAC,MAAM;YACtB,IAAI,EAAE,CAAC;YACP,QAAQ;YACR,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,KAAK,EAAE,qBAAqB,QAAQ,CAAC,MAAM,EAAE;SAC9C,CAAC;IACJ,CAAC;IACD,qBAAqB;IACrB,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,OAAO,CAAC,sEAAsE,CAAC,CAAC;IACzG,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,GAAa,EAAE,EAAE;QAC/C,KAAK,MAAM,EAAE,IAAI,GAAG;YAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;AACpG,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,aAAa,GAAG,EAAE;IAClD,MAAM,CAAC,GAAG,KAAK,EAAE;SACd,OAAO,CAAC,qEAAqE,CAAC;SAC9E,GAAG,CAAC,IAAI,aAAa,OAAO,CAAC,CAAC;IACjC,OAAO,CAAC,CAAC,OAAO,CAAC;AACnB,CAAC"}
@@ -0,0 +1,16 @@
1
+ export type TranscriptionProviderKind = 'groq' | 'openai' | 'none';
2
+ export interface TranscriptionProvider {
3
+ readonly name: string;
4
+ readonly model: string;
5
+ readonly baseUrl: string;
6
+ readonly apiKey: string;
7
+ }
8
+ export declare function transcriptionProviderFromEnv(): TranscriptionProvider | null;
9
+ export interface TranscriptionResult {
10
+ text: string;
11
+ provider: string;
12
+ model: string;
13
+ duration_seconds: number | null;
14
+ }
15
+ export declare function transcribeAudio(audio: Buffer, filename: string, mimeType: string): Promise<TranscriptionResult>;
16
+ //# sourceMappingURL=whisper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"whisper.d.ts","sourceRoot":"","sources":["../../../src/services/transcription/whisper.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEnE,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAWD,wBAAgB,4BAA4B,IAAI,qBAAqB,GAAG,IAAI,CAwB3E;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAOD,wBAAsB,eAAe,CACnC,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,mBAAmB,CAAC,CAgC9B"}
@@ -0,0 +1,72 @@
1
+ // Whisper audio transcription via OpenAI-compatible /audio/transcriptions endpoint.
2
+ // Default provider: Groq (free tier whisper-large-v3). Falls back to OpenAI if Groq
3
+ // not configured. Picks provider from env in same chain as LLM factory.
4
+ import { stderr } from 'node:process';
5
+ function readEnvKind() {
6
+ const raw = (process.env['SHINOBI_TRANSCRIPTION_PROVIDER'] ?? 'auto').toLowerCase();
7
+ if (raw === 'groq' || raw === 'openai')
8
+ return raw;
9
+ if (raw === 'none')
10
+ return 'none';
11
+ if (process.env['GROQ_API_KEY'])
12
+ return 'groq';
13
+ if (process.env['OPENAI_API_KEY'])
14
+ return 'openai';
15
+ return 'none';
16
+ }
17
+ export function transcriptionProviderFromEnv() {
18
+ const kind = readEnvKind();
19
+ if (kind === 'none')
20
+ return null;
21
+ if (kind === 'groq') {
22
+ const apiKey = process.env['SHINOBI_TRANSCRIPTION_API_KEY'] ?? process.env['GROQ_API_KEY'];
23
+ if (!apiKey)
24
+ return null;
25
+ return {
26
+ name: 'groq',
27
+ apiKey,
28
+ model: process.env['SHINOBI_TRANSCRIPTION_MODEL'] ?? 'whisper-large-v3',
29
+ baseUrl: 'https://api.groq.com/openai/v1',
30
+ };
31
+ }
32
+ if (kind === 'openai') {
33
+ const apiKey = process.env['SHINOBI_TRANSCRIPTION_API_KEY'] ?? process.env['OPENAI_API_KEY'];
34
+ if (!apiKey)
35
+ return null;
36
+ return {
37
+ name: 'openai',
38
+ apiKey,
39
+ model: process.env['SHINOBI_TRANSCRIPTION_MODEL'] ?? 'whisper-1',
40
+ baseUrl: 'https://api.openai.com/v1',
41
+ };
42
+ }
43
+ return null;
44
+ }
45
+ export async function transcribeAudio(audio, filename, mimeType) {
46
+ const provider = transcriptionProviderFromEnv();
47
+ if (!provider) {
48
+ throw new Error('No transcription provider configured. Set SHINOBI_TRANSCRIPTION_PROVIDER + GROQ_API_KEY (or OPENAI_API_KEY).');
49
+ }
50
+ const form = new FormData();
51
+ form.append('file', new Blob([new Uint8Array(audio)], { type: mimeType }), filename);
52
+ form.append('model', provider.model);
53
+ form.append('response_format', 'verbose_json');
54
+ const response = await fetch(`${provider.baseUrl}/audio/transcriptions`, {
55
+ method: 'POST',
56
+ headers: { Authorization: `Bearer ${provider.apiKey}` },
57
+ body: form,
58
+ });
59
+ if (!response.ok) {
60
+ const body = await response.text();
61
+ stderr.write(`whisper transcribe failed: ${response.status} ${body.slice(0, 200)}\n`);
62
+ throw new Error(`whisper transcribe failed: ${response.status} ${body.slice(0, 200)}`);
63
+ }
64
+ const json = (await response.json());
65
+ return {
66
+ text: (json.text ?? '').trim(),
67
+ provider: provider.name,
68
+ model: provider.model,
69
+ duration_seconds: typeof json.duration === 'number' ? json.duration : null,
70
+ };
71
+ }
72
+ //# sourceMappingURL=whisper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"whisper.js","sourceRoot":"","sources":["../../../src/services/transcription/whisper.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,oFAAoF;AACpF,wEAAwE;AAExE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAWtC,SAAS,WAAW;IAClB,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,IAAI,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;IACpF,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IACnD,IAAI,GAAG,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;QAAE,OAAO,MAAM,CAAC;IAC/C,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAAE,OAAO,QAAQ,CAAC;IACnD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,4BAA4B;IAC1C,MAAM,IAAI,GAAG,WAAW,EAAE,CAAC;IAC3B,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC;IACjC,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC3F,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACzB,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,MAAM;YACN,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,IAAI,kBAAkB;YACvE,OAAO,EAAE,gCAAgC;SAC1C,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACzB,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM;YACN,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,IAAI,WAAW;YAChE,OAAO,EAAE,2BAA2B;SACrC,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAcD,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,KAAa,EACb,QAAgB,EAChB,QAAgB;IAEhB,MAAM,QAAQ,GAAG,4BAA4B,EAAE,CAAC;IAChD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CACb,8GAA8G,CAC/G,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACrF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAE/C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,CAAC,OAAO,uBAAuB,EAAE;QACvE,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,QAAQ,CAAC,MAAM,EAAE,EAAE;QACvD,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,CAAC,KAAK,CAAC,8BAA8B,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QACtF,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA6B,CAAC;IACjE,OAAO;QACL,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QAC9B,QAAQ,EAAE,QAAQ,CAAC,IAAI;QACvB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,gBAAgB,EAAE,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;KAC3E,CAAC;AACJ,CAAC"}
@@ -0,0 +1,108 @@
1
+ # Shinobi architecture
2
+
3
+ ## Module layout
4
+
5
+ ```
6
+ shinobi/
7
+ ├── src/
8
+ │ ├── cli.ts — Top-level command dispatch
9
+ │ ├── commands/
10
+ │ │ ├── init.ts — `shinobi init`
11
+ │ │ └── sync.ts — `shinobi sync {init,push,pull,status}`
12
+ │ ├── lib/
13
+ │ │ ├── db.ts — better-sqlite3 singleton, WAL + FK + busy_timeout
14
+ │ │ ├── migrations.ts — Scan migrations/, sha256 checksum, apply pending
15
+ │ │ ├── config.ts — Read/write ~/.shinobi/config.json
16
+ │ │ ├── json.ts — parseJsonOrNull / stringifyOrNull
17
+ │ │ ├── fts.ts — escapeFtsQuery
18
+ │ │ └── priority.ts — Shared CASE expression for ORDER BY priority
19
+ │ ├── models/ — Functional, no classes. Each file exports interfaces + functions.
20
+ │ │ ├── projects.ts
21
+ │ │ ├── subtasks.ts — Includes nextTask (priority + dep resolution)
22
+ │ │ ├── decisions.ts
23
+ │ │ ├── dead_ends.ts
24
+ │ │ ├── notes.ts
25
+ │ │ ├── plans.ts — Auto-versioned saves
26
+ │ │ ├── context.ts — Patch semantics (only present fields overwrite)
27
+ │ │ ├── sessions.ts
28
+ │ │ ├── activity.ts — Includes linkCommit helper
29
+ │ │ └── *-helpers.ts — Hydration helpers extracted to avoid import cycles
30
+ │ ├── services/
31
+ │ │ ├── embedding/
32
+ │ │ │ ├── types.ts — EmbeddingProvider interface
33
+ │ │ │ ├── openai.ts — text-embedding-3-small (1536d default)
34
+ │ │ │ ├── voyage.ts — voyage-3-lite (512d default)
35
+ │ │ │ ├── ollama.ts — nomic-embed-text (768d default)
36
+ │ │ │ ├── factory.ts — Pick provider from env
37
+ │ │ │ ├── vector-math.ts — pack / unpack / cosineSim
38
+ │ │ │ └── store.ts — updateRowEmbedding / semanticSearch
39
+ │ │ └── plugins/
40
+ │ │ ├── state.ts — Loaded plugins registry (avoids import cycle)
41
+ │ │ ├── api.ts — Read-only ShinobiApi facade
42
+ │ │ ├── discovery.ts — Tier 1 (user dir) + Tier 2 (npm) scan
43
+ │ │ └── registry.ts — Validate + register plugin tools
44
+ │ ├── server/
45
+ │ │ ├── mcp.ts — Server boot, ListTools + CallTool handlers
46
+ │ │ └── tools/ — 34 tool definitions
47
+ │ │ ├── types.ts — ShinobiTool interface
48
+ │ │ ├── registry.ts — Global tool list + appendTool
49
+ │ │ ├── args.ts — Typed arg coercion
50
+ │ │ ├── index.ts — registerBuiltins (called at startup)
51
+ │ │ └── *.ts — One file per tool group
52
+ │ └── dashboard/
53
+ │ ├── server.ts — Hono app + routes
54
+ │ ├── layout.ts — Base HTML + embedded CSS / JS
55
+ │ └── views.ts — Per-view HTML generators
56
+ ├── migrations/
57
+ │ ├── 0001_initial_schema.sql — 8 tables (projects, subtasks, decisions, dead_ends, notes, plans, context, sessions) + FTS5 mirrors
58
+ │ └── 0002_activity_and_links.sql — activity table + subtask embedding columns
59
+ ├── scripts/ — Smoke test harnesses (not shipped in tarball)
60
+ └── dist/ — Compiled JS shipped via `npm pack`
61
+ ```
62
+
63
+ ## Request lifecycle (MCP)
64
+
65
+ ```
66
+ MCP client (Claude Code) ─stdio─→ shinobi mcp
67
+ │
68
+ ├─ applyPendingMigrations()
69
+ ├─ registerBuiltins() ← 34 tool defs
70
+ ├─ loadDiscoveredPlugins() ← scan ~/.shinobi/plugins + node_modules/@shinobi/plugin-*
71
+ │
72
+ └─ Server.connect(StdioServerTransport)
73
+ │
74
+ ├─ ListToolsRequest → allTools() with schemas
75
+ └─ CallToolRequest → getTool(name).handler(args)
76
+ │
77
+ ├─ Model write (sync, transactional)
78
+ ├─ updateRowEmbedding (async, optional)
79
+ └─ recordActivity
80
+ ```
81
+
82
+ ## Request lifecycle (dashboard)
83
+
84
+ ```
85
+ Browser → http://127.0.0.1:8765/<path>
86
+ │
87
+ └─ Hono router
88
+ ├─ GET routes → model read → renderXxxView(...) → c.html(...)
89
+ └─ PATCH /api/* → model write → c.json(...)
90
+ ```
91
+
92
+ The dashboard is the same Node process as the MCP server when launched together; today they are separate CLI subcommands (`shinobi mcp` vs `shinobi dashboard`) and each opens its own DB handle.
93
+
94
+ ## Storage
95
+
96
+ SQLite via better-sqlite3. WAL mode + foreign_keys ON + busy_timeout 5000ms. Migrations are forward-only with sha256 checksum tracking — if an applied migration file changes content, the runner halts with a `mismatched` count.
97
+
98
+ FTS5 mirrors live alongside their base tables (`subtasks_fts`, `decisions_fts`, `dead_ends_fts`, `notes_fts`) with `ai`/`ad`/`au` triggers keeping them synchronized. Searches use `MATCH` against the FTS5 table and JOIN back to the base table by rowid.
99
+
100
+ Embeddings live in BLOB columns (`embedding`, `embedding_provider`, `embedding_dims`) on `decisions`, `dead_ends`, `notes`, and `subtasks`. The provider name is stored alongside so a switch in provider (different dimensions) doesn't produce silent comparison errors.
101
+
102
+ ## Sync model
103
+
104
+ `shinobi sync push` does `wal_checkpoint(TRUNCATE)` + `db.backup()` + git add+commit+push. `shinobi sync pull` does git pull + file copy back. There is no merge; the writer is whichever machine pushed last. For multi-writer scenarios, consider holding off on `pull` while another machine is mid-edit.
105
+
106
+ ## Plugin contract
107
+
108
+ A plugin is an ES module that exports `default` (or `register`) accepting `(registry, api)`. The `api` is a read-only facade — plugins can read projects/subtasks/decisions but cannot mutate state. Plugin tools must use the `plugin_*` prefix to avoid colliding with built-ins.
@@ -0,0 +1,73 @@
1
+ # Shinobi configuration
2
+
3
+ All configuration is via environment variables. `~/.shinobi/.env` is loaded automatically by the CLI; values in `process.env` take precedence.
4
+
5
+ ## Storage
6
+
7
+ | Variable | Default | Purpose |
8
+ |---|---|---|
9
+ | `SHINOBI_DB_PATH` | `~/.shinobi/shinobi.db` | SQLite file. WAL mode is enforced; the directory is created if missing. |
10
+ | `SHINOBI_CONFIG_DIR` | `~/.shinobi` | Where `config.json` and `.env` live. The default plugins directory is also derived from this. |
11
+ | `SHINOBI_MIGRATIONS_DIR` | `<package>/migrations` | Override the migrations source. Useful only for dev / testing. |
12
+
13
+ ## Dashboard
14
+
15
+ | Variable | Default | Purpose |
16
+ |---|---|---|
17
+ | `SHINOBI_DASHBOARD_PORT` | `8765` | Dashboard HTTP port. |
18
+ | `SHINOBI_DASHBOARD_HOST` | `127.0.0.1` | Bind host. Loopback (`127.0.0.1`, `localhost`, `::1`) skips auth; anything else (e.g. `0.0.0.0` for LAN access) auto-enables token auth. |
19
+ | `SHINOBI_DASHBOARD_TOKEN` | _(none)_ | Override the dashboard auth token. When unset and a non-loopback host is used, a token is auto-generated and persisted to `~/.shinobi/dashboard-token`. |
20
+
21
+ ### Auth flow (non-loopback only)
22
+
23
+ When the dashboard binds to a non-loopback host, every route except `GET /health` requires a token. Accepted credential locations, checked in order:
24
+
25
+ 1. `Authorization: Bearer <token>` header
26
+ 2. `X-Shinobi-Token: <token>` header
27
+ 3. `shinobi_token` cookie (set automatically after a successful `?token=` query)
28
+ 4. `?token=<token>` query string — used once, the response sets the cookie
29
+
30
+ Loopback binds skip the middleware entirely so local development stays zero-friction. The token file is created with `0600` permissions on POSIX systems.
31
+
32
+ ## Plugins
33
+
34
+ | Variable | Default | Purpose |
35
+ |---|---|---|
36
+ | `SHINOBI_PLUGINS_DIR` | `~/.shinobi/plugins` | Directory scanned for user-tier plugins (`.js` / `.mjs` files). |
37
+
38
+ Npm-tier plugins are discovered from `node_modules/@shinobi/plugin-*` in the current working directory at server start.
39
+
40
+ ## Embeddings (optional)
41
+
42
+ Shinobi falls back to FTS5 fulltext search by default. Configure a provider to enable semantic recall.
43
+
44
+ | Variable | Values | Default |
45
+ |---|---|---|
46
+ | `SHINOBI_EMBED_PROVIDER` | `openai` / `voyage` / `ollama` / `none` | `none` |
47
+ | `SHINOBI_EMBED_API_KEY` | provider auth token | falls back to `OPENAI_API_KEY` / `VOYAGE_API_KEY` |
48
+ | `SHINOBI_EMBED_MODEL` | model identifier | `text-embedding-3-small` (OpenAI) / `voyage-3-lite` (Voyage) / `nomic-embed-text` (Ollama) |
49
+ | `SHINOBI_EMBED_DIMS` | integer | `1536` (OpenAI) / `512` (Voyage) / `768` (Ollama) |
50
+ | `SHINOBI_OLLAMA_URL` | URL | `http://localhost:11434` |
51
+
52
+ When a provider is configured, write paths (`log_decision`, `log_dead_end`, `add_note`, `create_task`, `bulk_create_tasks`) generate and store embeddings synchronously after the row insert. Read paths (`recall`, `check_dead_ends`) prefer semantic match and fall back to FTS5 when no embedding is available.
53
+
54
+ ## Recall mode
55
+
56
+ `recall` accepts an optional `mode` argument: `auto` (default), `semantic`, or `fulltext`. The `auto` mode picks semantic when an embedding provider is configured, otherwise fulltext.
57
+
58
+ ## Sync
59
+
60
+ Configured per machine via `shinobi sync init`. The resulting `~/.shinobi/config.json` shape:
61
+
62
+ ```json
63
+ {
64
+ "sync": {
65
+ "repo_path": "/path/to/local/clone",
66
+ "branch": "main",
67
+ "last_push_at": "2026-05-23T16:30:00.000Z",
68
+ "last_pull_at": null
69
+ }
70
+ }
71
+ ```
72
+
73
+ There is no env override for sync paths — use `shinobi sync init <path> [branch]` to reconfigure.
@@ -0,0 +1,42 @@
1
+ # Cursor adapter — quirks log
2
+
3
+ Cursor is a Visual Studio Code fork, so the Shinobi VS Code extension runs
4
+ unchanged. We ship a separate `.vsix` (different display name + publisher
5
+ slot) so the listing does not collide on the Cursor extension marketplace
6
+ with the VS Code build. The source code is identical — see
7
+ `vscode-extension/scripts/build-cursor.js`.
8
+
9
+ This file collects any Cursor-specific gotchas worth knowing.
10
+
11
+ ## What works the same
12
+
13
+ - Activity bar container + tree data providers — Cursor renders them
14
+ identically to VS Code.
15
+ - StatusBarItem, ThemeIcon, QuickPick, showInformationMessage modals.
16
+ - `vscode.env.openExternal()` opens links in the user's default browser.
17
+ - Workspace configuration sync — `shinobi.activeProjectId` set in VS Code
18
+ is *not* shared with Cursor (different settings backing store).
19
+
20
+ ## Known quirks
21
+
22
+ > Add entries here as they surface during real Cursor usage.
23
+
24
+ - *(none yet — first packaged 2026-05-24)*
25
+
26
+ ## How to package
27
+
28
+ ```sh
29
+ cd vscode-extension
30
+ npm install
31
+ npm run package:cursor
32
+ # Produces shinobi-cursor-0.1.0.vsix in the vscode-extension/ directory.
33
+ ```
34
+
35
+ Install in Cursor via ⌃⇧P → "Extensions: Install from VSIX...".
36
+
37
+ ## Why not a separate repo?
38
+
39
+ The diff between the two manifests is ~10 lines and the source code is
40
+ 100% shared. A separate repo would double the maintenance overhead for
41
+ zero functional gain. If Cursor ever forks its extension API in a way
42
+ that requires meaningful divergence, split at that point.
@@ -0,0 +1,110 @@
1
+ # Embedding providers
2
+
3
+ Shinobi computes vector embeddings for decisions, dead-ends, notes, and
4
+ subtasks so `recall` (and a few other tools) can do semantic search.
5
+ Embedding is **optional** — when no provider is available, recall falls
6
+ back to SQLite FTS5 full-text search.
7
+
8
+ ## Provider chain
9
+
10
+ `SHINOBI_EMBED_PROVIDER` controls which provider is used:
11
+
12
+ | Value | Behaviour |
13
+ |---|---|
14
+ | `auto` *(default)* | Detect in order: ollama → voyage → openai → none |
15
+ | `ollama` | Use local Ollama only |
16
+ | `voyage` | Use Voyage AI (free tier) — requires `VOYAGE_API_KEY` |
17
+ | `openai` | Use OpenAI — requires `OPENAI_API_KEY` |
18
+ | `none` | Skip embedding entirely; force fulltext mode |
19
+
20
+ The detection chain is intentionally biased toward free/local:
21
+
22
+ 1. **Ollama** — probes `http://localhost:11434/api/tags`. If reachable AND
23
+ has a `nomic-embed-text` model installed → use it. Zero cost, zero
24
+ network. Best for solo / offline workflows.
25
+ 2. **Voyage** — if `VOYAGE_API_KEY` set in `~/.shinobi/.env` (or env var).
26
+ Free tier covers ~50M tokens/month.
27
+ 3. **OpenAI** — if `OPENAI_API_KEY` set. Paid only; selected last.
28
+ 4. **none** — semantic recall disabled, fulltext FTS5 still works for keyword
29
+ queries.
30
+
31
+ ## Quickstart: free local embeddings
32
+
33
+ ```sh
34
+ # 1. Install Ollama
35
+ curl -fsSL https://ollama.com/install.sh | sh # macOS/Linux
36
+ # Windows: download from https://ollama.com/download
37
+
38
+ # 2. Pull the embedding model (~250 MB, runs entirely on CPU)
39
+ ollama pull nomic-embed-text
40
+
41
+ # 3. Restart the dashboard — auto-detection picks ollama
42
+ shinobi dashboard
43
+ ```
44
+
45
+ The startup log will print the detection result the first time embedding
46
+ runs (next time you call `recall` or write a decision):
47
+
48
+ ```
49
+ embedding auto-detect:
50
+ ollama: reachable=true has_nomic=true (http://localhost:11434)
51
+ voyage api key: absent
52
+ openai api key: absent
53
+ → selected: ollama
54
+ ```
55
+
56
+ ## Inspecting detection
57
+
58
+ Dashboard endpoint:
59
+
60
+ ```sh
61
+ curl http://127.0.0.1:8765/api/embedding/detect
62
+ ```
63
+
64
+ Returns the full detection result without instantiating the provider.
65
+ Useful for verifying that the agent will pick what you expect before
66
+ running a write that would generate embeddings.
67
+
68
+ ## Pinning to a specific provider
69
+
70
+ When you want to force a choice instead of detection, set
71
+ `SHINOBI_EMBED_PROVIDER` explicitly:
72
+
73
+ ```ini
74
+ # ~/.shinobi/.env
75
+ SHINOBI_EMBED_PROVIDER=voyage
76
+ VOYAGE_API_KEY=pa-...
77
+ ```
78
+
79
+ The change requires a dashboard restart (`requiresRestart=true` on the
80
+ setting). Embedding provider instances are cached for the process lifetime
81
+ to avoid re-detecting on every call.
82
+
83
+ ## Embed failures are non-fatal
84
+
85
+ If embedding fails (network down, Ollama process died, API rate-limited),
86
+ the write to the underlying row still succeeds — `embedding`, `embedding_provider`,
87
+ and `embedding_dims` are left NULL on that row and a warning is logged to
88
+ stderr. The semantic search ignores rows without a current-provider
89
+ embedding, so a partial-coverage DB still produces correct (if narrower)
90
+ results. You can re-run a backfill later when the provider is back.
91
+
92
+ ## Custom model / dimensions
93
+
94
+ Override the default model per provider:
95
+
96
+ ```ini
97
+ SHINOBI_EMBED_MODEL=nomic-embed-text:v1.5 # ollama
98
+ SHINOBI_EMBED_MODEL=voyage-3 # voyage
99
+ SHINOBI_EMBED_MODEL=text-embedding-3-large # openai
100
+ SHINOBI_EMBED_DIMS=1536 # only honored by openai (matryoshka)
101
+ SHINOBI_OLLAMA_URL=http://other-host:11434 # remote Ollama
102
+ ```
103
+
104
+ ## Why the cache
105
+
106
+ Detection probes Ollama on each call by hitting `/api/tags`. To keep
107
+ hot-path embed calls fast, we cache the resolved provider instance for
108
+ the lifetime of the process. Settings changes require a dashboard restart
109
+ anyway (`requiresRestart=true`), so the cache is never stale during a
110
+ normal session.