@hot-updater/server 1.0.0-rc.14 → 1.0.0-rc.16

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 (514) hide show
  1. package/dist/adapters/drizzle.cjs +35 -74
  2. package/dist/adapters/drizzle.d.cts +13 -5
  3. package/dist/adapters/drizzle.d.mts +13 -5
  4. package/dist/adapters/drizzle.mjs +34 -75
  5. package/dist/adapters/drizzleExecutor.cjs +114 -0
  6. package/dist/adapters/drizzleExecutor.d.cts +9 -0
  7. package/dist/adapters/drizzleExecutor.d.mts +9 -0
  8. package/dist/adapters/drizzleExecutor.mjs +112 -0
  9. package/dist/adapters/kysely.cjs +25 -31
  10. package/dist/adapters/kysely.d.cts +10 -6
  11. package/dist/adapters/kysely.d.mts +10 -6
  12. package/dist/adapters/kysely.mjs +25 -32
  13. package/dist/adapters/kyselyExecutor.cjs +32 -0
  14. package/dist/adapters/kyselyExecutor.d.cts +12 -0
  15. package/dist/adapters/kyselyExecutor.d.mts +12 -0
  16. package/dist/adapters/kyselyExecutor.mjs +32 -0
  17. package/dist/adapters/mongodb.cjs +28 -62
  18. package/dist/adapters/mongodb.d.cts +10 -5
  19. package/dist/adapters/mongodb.d.mts +10 -5
  20. package/dist/adapters/mongodb.mjs +28 -63
  21. package/dist/adapters/mongodbAdapter.cjs +174 -0
  22. package/dist/adapters/mongodbAdapter.d.cts +9 -0
  23. package/dist/adapters/mongodbAdapter.d.mts +9 -0
  24. package/dist/adapters/mongodbAdapter.mjs +173 -0
  25. package/dist/adapters/prisma.cjs +38 -257
  26. package/dist/adapters/prisma.d.cts +12 -7
  27. package/dist/adapters/prisma.d.mts +12 -7
  28. package/dist/adapters/prisma.mjs +38 -257
  29. package/dist/adapters/prismaExecutor.cjs +64 -0
  30. package/dist/adapters/prismaExecutor.mjs +64 -0
  31. package/dist/adapters/sqlProviders.cjs +9 -0
  32. package/dist/adapters/sqlProviders.mjs +9 -0
  33. package/dist/apiKeys.cjs +2 -6
  34. package/dist/apiKeys.d.cts +1 -23
  35. package/dist/apiKeys.d.mts +1 -23
  36. package/dist/apiKeys.mjs +2 -6
  37. package/dist/assembly/assemblePlugins.cjs +147 -0
  38. package/dist/assembly/assemblePlugins.d.cts +12 -0
  39. package/dist/assembly/assemblePlugins.d.mts +12 -0
  40. package/dist/assembly/assemblePlugins.mjs +146 -0
  41. package/dist/assembly/databasePlugins.cjs +23 -0
  42. package/dist/assembly/databasePlugins.d.cts +43 -0
  43. package/dist/assembly/databasePlugins.d.mts +43 -0
  44. package/dist/assembly/databasePlugins.mjs +22 -0
  45. package/dist/core/api.cjs +91 -0
  46. package/dist/core/api.d.cts +65 -0
  47. package/dist/core/api.d.mts +65 -0
  48. package/dist/core/api.mjs +87 -0
  49. package/dist/core/baseCandidates.cjs +71 -0
  50. package/dist/core/baseCandidates.d.cts +17 -0
  51. package/dist/core/baseCandidates.d.mts +17 -0
  52. package/dist/core/baseCandidates.mjs +69 -0
  53. package/dist/core/operations.cjs +350 -0
  54. package/dist/core/operations.mjs +350 -0
  55. package/dist/core/reads.cjs +273 -0
  56. package/dist/core/reads.d.cts +48 -0
  57. package/dist/core/reads.d.mts +48 -0
  58. package/dist/core/reads.mjs +267 -0
  59. package/dist/core/releases.cjs +193 -0
  60. package/dist/core/releases.mjs +190 -0
  61. package/dist/core/schema.cjs +279 -0
  62. package/dist/core/schema.d.cts +307 -0
  63. package/dist/core/schema.d.mts +307 -0
  64. package/dist/core/schema.mjs +277 -0
  65. package/dist/core/writes.cjs +96 -0
  66. package/dist/core/writes.mjs +91 -0
  67. package/dist/createHotUpdaterCore.cjs +58 -75
  68. package/dist/createHotUpdaterCore.d.cts +52 -44
  69. package/dist/createHotUpdaterCore.d.mts +52 -44
  70. package/dist/createHotUpdaterCore.mjs +59 -75
  71. package/dist/database/cursor.cjs +44 -0
  72. package/dist/database/cursor.d.cts +7 -0
  73. package/dist/database/cursor.d.mts +7 -0
  74. package/dist/database/cursor.mjs +40 -0
  75. package/dist/database/database.cjs +44 -0
  76. package/dist/database/database.d.cts +123 -0
  77. package/dist/database/database.d.mts +123 -0
  78. package/dist/database/database.mjs +44 -0
  79. package/dist/database/definitions.d.cts +68 -0
  80. package/dist/database/definitions.d.mts +68 -0
  81. package/dist/database/engine.cjs +37 -0
  82. package/dist/database/engine.d.cts +40 -0
  83. package/dist/database/engine.d.mts +40 -0
  84. package/dist/database/engine.mjs +37 -0
  85. package/dist/database/engineAggregates.cjs +115 -0
  86. package/dist/database/engineAggregates.mjs +112 -0
  87. package/dist/database/engineReads.cjs +180 -0
  88. package/dist/database/engineReads.d.cts +35 -0
  89. package/dist/database/engineReads.d.mts +35 -0
  90. package/dist/database/engineReads.mjs +179 -0
  91. package/dist/database/engineTransaction.cjs +403 -0
  92. package/dist/database/engineTransaction.d.cts +26 -0
  93. package/dist/database/engineTransaction.d.mts +26 -0
  94. package/dist/database/engineTransaction.mjs +402 -0
  95. package/dist/database/errors.cjs +27 -0
  96. package/dist/database/errors.d.cts +21 -0
  97. package/dist/database/errors.d.mts +21 -0
  98. package/dist/database/errors.mjs +24 -0
  99. package/dist/database/fence.cjs +124 -0
  100. package/dist/database/fence.d.cts +42 -0
  101. package/dist/database/fence.d.mts +42 -0
  102. package/dist/database/fence.mjs +116 -0
  103. package/dist/database/index.cjs +127 -0
  104. package/dist/database/index.d.cts +17 -0
  105. package/dist/database/index.d.mts +17 -0
  106. package/dist/database/index.mjs +15 -0
  107. package/dist/database/kv/kvAdapter.cjs +273 -0
  108. package/dist/database/kv/kvAdapter.d.cts +101 -0
  109. package/dist/database/kv/kvAdapter.d.mts +101 -0
  110. package/dist/database/kv/kvAdapter.mjs +272 -0
  111. package/dist/database/resolveSchema.cjs +196 -0
  112. package/dist/database/resolveSchema.d.cts +42 -0
  113. package/dist/database/resolveSchema.d.mts +42 -0
  114. package/dist/database/resolveSchema.mjs +193 -0
  115. package/dist/database/schema.cjs +21 -0
  116. package/dist/database/schema.d.cts +61 -0
  117. package/dist/database/schema.d.mts +61 -0
  118. package/dist/database/schema.mjs +20 -0
  119. package/dist/database/sql/sqlAdapter.cjs +282 -0
  120. package/dist/database/sql/sqlAdapter.d.cts +46 -0
  121. package/dist/database/sql/sqlAdapter.d.mts +46 -0
  122. package/dist/database/sql/sqlAdapter.mjs +279 -0
  123. package/dist/database/sql/sqlSchema.cjs +115 -0
  124. package/dist/database/sql/sqlSchema.d.cts +8 -0
  125. package/dist/database/sql/sqlSchema.d.mts +8 -0
  126. package/dist/database/sql/sqlSchema.mjs +111 -0
  127. package/dist/db/builtInDatabase.cjs +104 -0
  128. package/dist/db/builtInDatabase.d.cts +38 -0
  129. package/dist/db/builtInDatabase.d.mts +38 -0
  130. package/dist/db/builtInDatabase.mjs +97 -0
  131. package/dist/db/createBundleDiff.cjs +4 -4
  132. package/dist/db/createBundleDiff.d.cts +3 -2
  133. package/dist/db/createBundleDiff.d.mts +3 -2
  134. package/dist/db/createBundleDiff.mjs +5 -5
  135. package/dist/db/engineDrizzleSchema.cjs +54 -0
  136. package/dist/db/engineDrizzleSchema.mjs +54 -0
  137. package/dist/db/engineMigrator.cjs +53 -0
  138. package/dist/db/engineMigrator.mjs +53 -0
  139. package/dist/db/enginePrismaSchema.cjs +85 -0
  140. package/dist/db/enginePrismaSchema.d.cts +5 -0
  141. package/dist/db/enginePrismaSchema.d.mts +5 -0
  142. package/dist/db/enginePrismaSchema.mjs +84 -0
  143. package/dist/db/engineSql.cjs +26 -0
  144. package/dist/db/engineSql.d.cts +17 -0
  145. package/dist/db/engineSql.d.mts +17 -0
  146. package/dist/db/engineSql.mjs +25 -0
  147. package/dist/db/engineSqlMigrator.cjs +66 -0
  148. package/dist/db/engineSqlMigrator.mjs +66 -0
  149. package/dist/db/fixedMigratorShared.cjs +0 -11
  150. package/dist/db/fixedMigratorShared.mjs +1 -8
  151. package/dist/db/index.cjs +23 -8
  152. package/dist/db/index.d.cts +10 -3
  153. package/dist/db/index.d.mts +10 -3
  154. package/dist/db/index.mjs +16 -8
  155. package/dist/db/releaseCatalog.cjs +20 -43
  156. package/dist/db/releaseCatalog.d.cts +2 -2
  157. package/dist/db/releaseCatalog.d.mts +2 -2
  158. package/dist/db/releaseCatalog.mjs +20 -44
  159. package/dist/db/schemaSettings.cjs +63 -0
  160. package/dist/db/schemaSettings.d.cts +12 -0
  161. package/dist/db/schemaSettings.d.mts +12 -0
  162. package/dist/db/schemaSettings.mjs +62 -0
  163. package/dist/db/settingsMigrator.cjs +92 -0
  164. package/dist/db/settingsMigrator.mjs +89 -0
  165. package/dist/db/types.cjs +1 -12
  166. package/dist/db/types.d.cts +26 -66
  167. package/dist/db/types.d.mts +26 -66
  168. package/dist/db/types.mjs +2 -11
  169. package/dist/db/updateArtifacts.cjs +38 -67
  170. package/dist/db/updateArtifacts.mjs +40 -69
  171. package/dist/handler.cjs +72 -43
  172. package/dist/handler.d.cts +3 -5
  173. package/dist/handler.d.mts +3 -5
  174. package/dist/handler.mjs +73 -43
  175. package/dist/handlerAdminRoutes.cjs +375 -0
  176. package/dist/handlerAdminRoutes.mjs +373 -0
  177. package/dist/handlerParameters.cjs +6 -11
  178. package/dist/handlerParameters.mjs +6 -10
  179. package/dist/handlerReleaseCatalogRoutes.cjs +11 -13
  180. package/dist/handlerReleaseCatalogRoutes.mjs +11 -13
  181. package/dist/handlerTypes.d.cts +2 -55
  182. package/dist/handlerTypes.d.mts +2 -55
  183. package/dist/handlerVersionRoutes.cjs +20 -4
  184. package/dist/handlerVersionRoutes.mjs +20 -4
  185. package/dist/index.cjs +4 -7
  186. package/dist/index.d.cts +8 -7
  187. package/dist/index.d.mts +8 -7
  188. package/dist/index.mjs +4 -4
  189. package/dist/insights/domain.d.cts +12 -0
  190. package/dist/insights/domain.d.mts +12 -0
  191. package/dist/insights/errors.cjs +34 -0
  192. package/dist/insights/errors.mjs +34 -1
  193. package/dist/insights/eventInput.cjs +14 -19
  194. package/dist/insights/eventInput.mjs +15 -20
  195. package/dist/insights/provider.cjs +47 -23
  196. package/dist/insights/provider.mjs +47 -24
  197. package/dist/insights/routes.cjs +79 -14
  198. package/dist/insights/routes.mjs +77 -14
  199. package/dist/node.d.cts +1 -1
  200. package/dist/node.d.mts +1 -1
  201. package/dist/package.cjs +1 -1
  202. package/dist/package.mjs +1 -1
  203. package/dist/plugins/api-keys/index.cjs +50 -0
  204. package/dist/plugins/api-keys/index.d.cts +85 -0
  205. package/dist/plugins/api-keys/index.d.mts +85 -0
  206. package/dist/plugins/api-keys/index.mjs +47 -0
  207. package/dist/plugins/api-keys/model.cjs +58 -0
  208. package/dist/plugins/api-keys/model.d.cts +8 -0
  209. package/dist/plugins/api-keys/model.d.mts +8 -0
  210. package/dist/plugins/api-keys/model.mjs +58 -0
  211. package/dist/plugins/api-keys/schema.cjs +38 -0
  212. package/dist/plugins/api-keys/schema.d.cts +44 -0
  213. package/dist/plugins/api-keys/schema.d.mts +44 -0
  214. package/dist/plugins/api-keys/schema.mjs +39 -0
  215. package/dist/plugins/builtIn.cjs +7 -0
  216. package/dist/plugins/builtIn.mjs +6 -0
  217. package/dist/plugins/definePlugin.cjs +5 -0
  218. package/dist/plugins/definePlugin.d.cts +73 -0
  219. package/dist/plugins/definePlugin.d.mts +73 -0
  220. package/dist/plugins/definePlugin.mjs +5 -0
  221. package/dist/plugins/index.cjs +17 -0
  222. package/dist/plugins/index.d.cts +9 -0
  223. package/dist/plugins/index.d.mts +9 -0
  224. package/dist/plugins/index.mjs +7 -0
  225. package/dist/plugins/insights/index.cjs +48 -0
  226. package/dist/plugins/insights/index.d.cts +295 -0
  227. package/dist/plugins/insights/index.d.mts +295 -0
  228. package/dist/plugins/insights/index.mjs +44 -0
  229. package/dist/plugins/insights/model.cjs +17 -0
  230. package/dist/plugins/insights/model.d.cts +10 -0
  231. package/dist/plugins/insights/model.d.mts +10 -0
  232. package/dist/plugins/insights/model.mjs +17 -0
  233. package/dist/plugins/insights/reads.cjs +471 -0
  234. package/dist/plugins/insights/reads.mjs +466 -0
  235. package/dist/plugins/insights/recordEvent.cjs +135 -0
  236. package/dist/plugins/insights/recordEvent.d.cts +13 -0
  237. package/dist/plugins/insights/recordEvent.d.mts +13 -0
  238. package/dist/plugins/insights/recordEvent.mjs +132 -0
  239. package/dist/plugins/insights/schema.cjs +347 -0
  240. package/dist/plugins/insights/schema.d.cts +258 -0
  241. package/dist/plugins/insights/schema.d.mts +258 -0
  242. package/dist/plugins/insights/schema.mjs +344 -0
  243. package/dist/types/index.d.cts +2 -28
  244. package/dist/types/index.d.mts +2 -28
  245. package/package.json +28 -5
  246. package/src/adapters/drizzle.conformance.integration.spec.ts +34 -0
  247. package/src/adapters/drizzle.readBudgets.integration.spec.ts +41 -0
  248. package/src/adapters/drizzle.spec.ts +270 -399
  249. package/src/adapters/drizzle.ts +48 -140
  250. package/src/adapters/drizzleExecutor.ts +166 -0
  251. package/src/adapters/kysely.conformance.integration.spec.ts +36 -0
  252. package/src/adapters/kysely.readBudgets.integration.spec.ts +42 -0
  253. package/src/adapters/kysely.spec.ts +204 -171
  254. package/src/adapters/kysely.ts +32 -93
  255. package/src/adapters/kyselyExecutor.ts +53 -0
  256. package/src/adapters/mongodb.integration.spec.ts +143 -446
  257. package/src/adapters/mongodb.readBudgets.integration.spec.ts +61 -0
  258. package/src/adapters/mongodb.ts +36 -123
  259. package/src/adapters/mongodbAdapter.ts +293 -0
  260. package/src/adapters/prisma.conformance.integration.spec.ts +36 -0
  261. package/src/adapters/prisma.integration.spec.ts +138 -0
  262. package/src/adapters/prisma.readBudgets.integration.spec.ts +40 -0
  263. package/src/adapters/prisma.spec.ts +216 -433
  264. package/src/adapters/prisma.ts +60 -524
  265. package/src/adapters/prismaExecutor.ts +107 -0
  266. package/src/adapters/prismaTestClients.ts +175 -0
  267. package/src/adapters/sqlProviders.ts +14 -0
  268. package/src/apiKeys.integration.spec.ts +19 -119
  269. package/src/apiKeys.spec.ts +39 -35
  270. package/src/apiKeys.ts +2 -8
  271. package/src/assembly/assemblePlugins.ts +269 -0
  272. package/src/assembly/assembly.spec.ts +325 -0
  273. package/src/assembly/assembly.types.spec.ts +155 -0
  274. package/src/assembly/builtInRoutes.spec.ts +213 -0
  275. package/src/assembly/databasePlugins.spec.ts +71 -0
  276. package/src/assembly/databasePlugins.ts +96 -0
  277. package/src/core/api.ts +139 -0
  278. package/src/core/baseCandidates.spec.ts +378 -0
  279. package/src/core/baseCandidates.ts +136 -0
  280. package/src/core/index.ts +44 -0
  281. package/src/core/operations.spec.ts +415 -0
  282. package/src/core/operations.ts +551 -0
  283. package/src/core/reads.spec.ts +300 -0
  284. package/src/core/reads.ts +417 -0
  285. package/src/core/releases.spec.ts +308 -0
  286. package/src/core/releases.ts +345 -0
  287. package/src/core/schema.ts +173 -0
  288. package/src/core/writes.ts +160 -0
  289. package/src/createHotUpdaterCore.ts +191 -181
  290. package/src/database/cursor.ts +65 -0
  291. package/src/database/database.ts +335 -0
  292. package/src/database/database.types.spec.ts +135 -0
  293. package/src/database/definitions.ts +72 -0
  294. package/src/database/engine.ts +62 -0
  295. package/src/database/engineAggregates.spec.ts +539 -0
  296. package/src/database/engineAggregates.ts +193 -0
  297. package/src/database/engineReads.spec.ts +219 -0
  298. package/src/database/engineReads.ts +302 -0
  299. package/src/database/engineTransaction.spec.ts +710 -0
  300. package/src/database/engineTransaction.ts +588 -0
  301. package/src/database/errors.ts +30 -0
  302. package/src/database/fence.spec.ts +223 -0
  303. package/src/database/fence.ts +171 -0
  304. package/src/database/index.ts +154 -0
  305. package/src/database/kv/kvAdapter.conformance.integration.spec.ts +17 -0
  306. package/src/database/kv/kvAdapter.readBudgets.integration.spec.ts +17 -0
  307. package/src/database/kv/kvAdapter.spec.ts +468 -0
  308. package/src/database/kv/kvAdapter.ts +450 -0
  309. package/src/database/kv/kvTestStore.ts +91 -0
  310. package/src/database/memory.readBudgets.integration.spec.ts +13 -0
  311. package/src/database/resolveSchema.spec.ts +230 -0
  312. package/src/database/resolveSchema.ts +372 -0
  313. package/src/database/schema.ts +169 -0
  314. package/src/database/schema.types.spec.ts +94 -0
  315. package/src/database/sql/docker-compose.yml +36 -0
  316. package/src/database/sql/sqlAdapter.integration.spec.ts +148 -0
  317. package/src/database/sql/sqlAdapter.readBudgets.integration.spec.ts +109 -0
  318. package/src/database/sql/sqlAdapter.spec.ts +255 -0
  319. package/src/database/sql/sqlAdapter.ts +532 -0
  320. package/src/database/sql/sqlSchema.ts +205 -0
  321. package/src/database/sql/sqlTestExecutors.ts +183 -0
  322. package/src/databaseTestSuite.spec.ts +39 -0
  323. package/src/db/builtInDatabase.ts +149 -0
  324. package/src/db/bundleRows.spec.ts +3 -3
  325. package/src/db/createBundleDiff.spec.ts +43 -29
  326. package/src/db/createBundleDiff.ts +13 -7
  327. package/src/db/engineDrizzleSchema.ts +72 -0
  328. package/src/db/engineMigrator.ts +105 -0
  329. package/src/db/enginePrismaSchema.ts +147 -0
  330. package/src/db/engineSql.spec.ts +129 -0
  331. package/src/db/engineSql.ts +48 -0
  332. package/src/db/engineSqlMigrator.ts +116 -0
  333. package/src/db/fixedMigratorShared.ts +1 -20
  334. package/src/db/index.spec.ts +116 -829
  335. package/src/db/index.ts +43 -14
  336. package/src/db/pluginTables.spec.ts +218 -0
  337. package/src/db/releaseCatalog.ts +48 -90
  338. package/src/db/schemaSettings.ts +104 -0
  339. package/src/db/settingsMigrator.spec.ts +65 -0
  340. package/src/db/settingsMigrator.ts +152 -0
  341. package/src/db/types.ts +25 -171
  342. package/src/db/updateArtifacts.spec.ts +170 -294
  343. package/src/db/updateArtifacts.ts +74 -142
  344. package/src/db/updateCheck.bench.ts +47 -0
  345. package/src/handler-standalone.integration.spec.ts +204 -410
  346. package/src/handler.spec.ts +134 -51
  347. package/src/handler.testFixtures.ts +14 -19
  348. package/src/handler.ts +163 -75
  349. package/src/handlerAdminRoutes.spec.ts +183 -0
  350. package/src/handlerAdminRoutes.ts +536 -0
  351. package/src/handlerAuth.integration.spec.ts +3 -3
  352. package/src/handlerManagement.spec.ts +136 -196
  353. package/src/handlerReleaseCatalogRoutes.ts +15 -17
  354. package/src/handlerTypes.ts +3 -80
  355. package/src/handlerVersionRoutes.ts +20 -7
  356. package/src/index.ts +5 -12
  357. package/src/insights/domain.ts +12 -0
  358. package/src/insights/errors.spec.ts +48 -0
  359. package/src/insights/errors.ts +51 -0
  360. package/src/insights/eventInput.ts +27 -24
  361. package/src/insights/insights.integration.spec.ts +228 -78
  362. package/src/insights/provider.spec.ts +203 -25
  363. package/src/insights/provider.ts +88 -32
  364. package/src/insights/routes.ts +95 -20
  365. package/src/lintRules.spec.ts +76 -0
  366. package/src/plugins/api-keys/apiKeysPlugin.spec.ts +172 -0
  367. package/src/plugins/api-keys/index.ts +66 -0
  368. package/src/plugins/api-keys/model.ts +69 -0
  369. package/src/plugins/api-keys/schema.ts +22 -0
  370. package/src/plugins/builtIn.ts +5 -0
  371. package/src/plugins/definePlugin.ts +100 -0
  372. package/src/plugins/index.ts +55 -0
  373. package/src/plugins/insights/index.ts +86 -0
  374. package/src/plugins/insights/insightsRollout.integration.spec.ts +187 -0
  375. package/src/plugins/insights/model.spec.ts +66 -0
  376. package/src/plugins/insights/model.ts +19 -0
  377. package/src/plugins/insights/reads.spec.ts +725 -0
  378. package/src/plugins/insights/reads.ts +707 -0
  379. package/src/plugins/insights/recordEvent.spec.ts +443 -0
  380. package/src/plugins/insights/recordEvent.ts +238 -0
  381. package/src/plugins/insights/schema.ts +229 -0
  382. package/src/plugins/pluginTestHarness.spec.ts +56 -0
  383. package/src/readBudgets.testFixtures.ts +15 -0
  384. package/src/releaseCatalogRoutes.integration.spec.ts +47 -92
  385. package/src/runtime.spec.ts +91 -77
  386. package/src/runtime.testFixtures.ts +28 -44
  387. package/src/runtimeBundles.integration.spec.ts +112 -0
  388. package/src/testUtilsMutation.integration.spec.ts +215 -0
  389. package/src/testUtilsPackage.integration.spec.ts +176 -0
  390. package/src/types/index.ts +0 -32
  391. package/dist/adapters/databaseConstraintErrors.cjs +0 -22
  392. package/dist/adapters/databaseConstraintErrors.mjs +0 -21
  393. package/dist/adapters/databasePluginUtils.cjs +0 -130
  394. package/dist/adapters/databasePluginUtils.mjs +0 -118
  395. package/dist/adapters/drizzleCrud.cjs +0 -340
  396. package/dist/adapters/drizzleCrud.mjs +0 -337
  397. package/dist/adapters/drizzleLazyDB.cjs +0 -103
  398. package/dist/adapters/drizzleLazyDB.mjs +0 -103
  399. package/dist/adapters/drizzleQuery.cjs +0 -69
  400. package/dist/adapters/drizzleQuery.mjs +0 -69
  401. package/dist/adapters/kyselyCrud.cjs +0 -293
  402. package/dist/adapters/kyselyCrud.mjs +0 -292
  403. package/dist/adapters/kyselyQuery.cjs +0 -56
  404. package/dist/adapters/kyselyQuery.mjs +0 -56
  405. package/dist/adapters/mongodbCollections.cjs +0 -38
  406. package/dist/adapters/mongodbCollections.mjs +0 -32
  407. package/dist/adapters/mongodbQuery.cjs +0 -90
  408. package/dist/adapters/mongodbQuery.mjs +0 -83
  409. package/dist/adapters/mongodbReads.cjs +0 -206
  410. package/dist/adapters/mongodbReads.mjs +0 -206
  411. package/dist/adapters/mongodbWrites.cjs +0 -133
  412. package/dist/adapters/mongodbWrites.mjs +0 -133
  413. package/dist/adapters/prismaInsights.cjs +0 -99
  414. package/dist/adapters/prismaInsights.mjs +0 -97
  415. package/dist/adapters/prismaQuery.cjs +0 -57
  416. package/dist/adapters/prismaQuery.mjs +0 -56
  417. package/dist/adapters/prismaRows.cjs +0 -197
  418. package/dist/adapters/prismaRows.mjs +0 -188
  419. package/dist/db/databasePluginCore.cjs +0 -137
  420. package/dist/db/databasePluginCore.mjs +0 -137
  421. package/dist/db/fixedMigrator.cjs +0 -79
  422. package/dist/db/fixedMigrator.mjs +0 -78
  423. package/dist/db/fixedMigratorMongo.cjs +0 -321
  424. package/dist/db/fixedMigratorMongo.mjs +0 -321
  425. package/dist/db/mongoMigrationExecution.cjs +0 -11
  426. package/dist/db/mongoMigrationExecution.mjs +0 -11
  427. package/dist/db/schema/insightsCollation.cjs +0 -14
  428. package/dist/db/schema/insightsCollation.mjs +0 -14
  429. package/dist/db/schema/mongodb.cjs +0 -25
  430. package/dist/db/schema/mongodb.mjs +0 -25
  431. package/dist/db/schema/registry.cjs +0 -21
  432. package/dist/db/schema/registry.mjs +0 -17
  433. package/dist/db/schema/sql.cjs +0 -105
  434. package/dist/db/schema/sql.mjs +0 -97
  435. package/dist/db/schema/sqlOperations.cjs +0 -27
  436. package/dist/db/schema/sqlOperations.mjs +0 -26
  437. package/dist/db/schemaGenerators.cjs +0 -276
  438. package/dist/db/schemaGenerators.mjs +0 -274
  439. package/dist/db/schemaReadiness.cjs +0 -26
  440. package/dist/db/schemaReadiness.d.cts +0 -9
  441. package/dist/db/schemaReadiness.d.mts +0 -9
  442. package/dist/db/schemaReadiness.mjs +0 -25
  443. package/dist/db/sqlMigrationExecution.cjs +0 -67
  444. package/dist/db/sqlMigrationExecution.mjs +0 -67
  445. package/dist/handlerBundleRoutes.cjs +0 -155
  446. package/dist/handlerBundleRoutes.mjs +0 -155
  447. package/dist/handlerReleaseManagementRoutes.cjs +0 -124
  448. package/dist/handlerReleaseManagementRoutes.mjs +0 -124
  449. package/dist/schema/dsl.cjs +0 -103
  450. package/dist/schema/dsl.mjs +0 -87
  451. package/dist/schema/index.cjs +0 -20
  452. package/dist/schema/index.mjs +0 -7
  453. package/dist/schema/settings.cjs +0 -9
  454. package/dist/schema/settings.mjs +0 -9
  455. package/dist/schema/types.cjs +0 -8
  456. package/dist/schema/types.mjs +0 -6
  457. package/dist/schema/v1_0_0.cjs +0 -393
  458. package/dist/schema/v1_0_0.mjs +0 -385
  459. package/src/adapters/databaseConstraintErrors.ts +0 -25
  460. package/src/adapters/databasePluginTestDatabase.ts +0 -116
  461. package/src/adapters/databasePluginUtils.spec.ts +0 -29
  462. package/src/adapters/databasePluginUtils.ts +0 -238
  463. package/src/adapters/drizzleCrud.ts +0 -610
  464. package/src/adapters/drizzleLazyDB.ts +0 -284
  465. package/src/adapters/drizzleQuery.ts +0 -164
  466. package/src/adapters/kyselyCrud.ts +0 -696
  467. package/src/adapters/kyselyInsights.spec.ts +0 -168
  468. package/src/adapters/kyselyQuery.ts +0 -128
  469. package/src/adapters/mongodb.spec.ts +0 -230
  470. package/src/adapters/mongodbCollections.ts +0 -78
  471. package/src/adapters/mongodbQuery.ts +0 -245
  472. package/src/adapters/mongodbReads.ts +0 -387
  473. package/src/adapters/mongodbRows.spec.ts +0 -64
  474. package/src/adapters/mongodbRows.ts +0 -118
  475. package/src/adapters/mongodbTestClient.ts +0 -443
  476. package/src/adapters/mongodbTestFilter.ts +0 -170
  477. package/src/adapters/mongodbWrites.ts +0 -261
  478. package/src/adapters/prismaInsights.ts +0 -190
  479. package/src/adapters/prismaQuery.ts +0 -129
  480. package/src/adapters/prismaRows.spec.ts +0 -98
  481. package/src/adapters/prismaRows.ts +0 -308
  482. package/src/adapters/prismaTestClient.ts +0 -478
  483. package/src/calculatePagination.ts +0 -34
  484. package/src/db/databasePluginCore.spec.ts +0 -62
  485. package/src/db/databasePluginCore.testFixtures.ts +0 -76
  486. package/src/db/databasePluginCore.ts +0 -185
  487. package/src/db/databasePluginUpdateCheck.bench.ts +0 -117
  488. package/src/db/fixedMigrator.spec.ts +0 -294
  489. package/src/db/fixedMigrator.ts +0 -147
  490. package/src/db/fixedMigratorMongo.spec.ts +0 -253
  491. package/src/db/fixedMigratorMongo.ts +0 -425
  492. package/src/db/hotUpdaterSchema.ts +0 -5
  493. package/src/db/mongoMigrationExecution.ts +0 -23
  494. package/src/db/schema/definitions.ts +0 -1
  495. package/src/db/schema/insightsCollation.ts +0 -21
  496. package/src/db/schema/mongodb.ts +0 -40
  497. package/src/db/schema/registry.ts +0 -55
  498. package/src/db/schema/sql.ts +0 -244
  499. package/src/db/schema/sqlOperations.ts +0 -63
  500. package/src/db/schema/types.ts +0 -1
  501. package/src/db/schemaGenerators.ts +0 -495
  502. package/src/db/schemaReadiness.ts +0 -34
  503. package/src/db/sqlMigrationExecution.spec.ts +0 -65
  504. package/src/db/sqlMigrationExecution.ts +0 -108
  505. package/src/db/types.spec.ts +0 -63
  506. package/src/handlerBundleRoutes.ts +0 -259
  507. package/src/handlerReleaseManagementRoutes.ts +0 -213
  508. package/src/schema/dsl-all-versions.spec.ts +0 -35
  509. package/src/schema/dsl.ts +0 -187
  510. package/src/schema/index.ts +0 -10
  511. package/src/schema/settings.ts +0 -15
  512. package/src/schema/types.ts +0 -79
  513. package/src/schema/v1_0_0.spec.ts +0 -220
  514. package/src/schema/v1_0_0.ts +0 -511
@@ -0,0 +1,76 @@
1
+ import { execFileSync } from "node:child_process";
2
+ import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
3
+ import os from "node:os";
4
+ import path from "node:path";
5
+
6
+ import { afterAll, describe, expect, it } from "vitest";
7
+
8
+ const root = path.resolve(import.meta.dirname, "../../..");
9
+ const oxlint = path.join(root, "node_modules/.bin/oxlint");
10
+ const dir = mkdtempSync(path.join(os.tmpdir(), "hot-updater-lint-"));
11
+
12
+ afterAll(() => {
13
+ rmSync(dir, { recursive: true, force: true });
14
+ });
15
+
16
+ /**
17
+ * The lines `hot-updater/no-filtered-find-many` reports on `source` under the
18
+ * repo's oxlint config. oxlint lints only paths under its working directory,
19
+ * so it runs from the scratch directory.
20
+ */
21
+ const reported = (file: string, source: string): number[] => {
22
+ writeFileSync(path.join(dir, file), source);
23
+ let output: string;
24
+ try {
25
+ output = execFileSync(
26
+ oxlint,
27
+ ["-c", path.join(root, ".oxlintrc.json"), "--format", "json", file],
28
+ { cwd: dir, encoding: "utf8" },
29
+ );
30
+ } catch (error) {
31
+ // oxlint exits 1 when it reports an error.
32
+ output = (error as { stdout: string }).stdout;
33
+ }
34
+ const { diagnostics } = JSON.parse(output) as {
35
+ diagnostics: {
36
+ code: string;
37
+ labels: { span: { line: number } }[];
38
+ }[];
39
+ };
40
+ return diagnostics
41
+ .filter(({ code }) => code === "hot-updater(no-filtered-find-many)")
42
+ .map(({ labels }) => labels[0]!.span.line);
43
+ };
44
+
45
+ const filtered = [
46
+ "export const a = async (db: any) =>",
47
+ ' (await db.findMany("t", {})).rows.filter((row: any) => row.ok);',
48
+ "export const b = async (db: any) => {",
49
+ ' const page = await db.findMany("t", {});',
50
+ " return page.rows.find((row: any) => row.ok);",
51
+ "};",
52
+ "export const c = async (db: any) => {",
53
+ ' const { rows } = await db.findMany("t", {});',
54
+ " return rows.filter(Boolean);",
55
+ "};",
56
+ ].join("\n");
57
+
58
+ describe("hot-updater/no-filtered-find-many", () => {
59
+ it("reports findMany rows filtered in code", () => {
60
+ expect(reported("reads.ts", filtered)).toEqual([2, 5, 9]);
61
+ });
62
+
63
+ it("allows rows used whole, other arrays, and tests", () => {
64
+ expect(
65
+ reported(
66
+ "whole.ts",
67
+ [
68
+ "export const d = async (db: any) =>",
69
+ ' (await db.findMany("t", {})).rows.map((row: any) => row.id);',
70
+ "export const e = (items: number[]) => items.filter(Boolean);",
71
+ ].join("\n"),
72
+ ),
73
+ ).toEqual([]);
74
+ expect(reported("reads.spec.ts", filtered)).toEqual([]);
75
+ });
76
+ });
@@ -0,0 +1,172 @@
1
+ import {
2
+ createMemoryAdapter,
3
+ type DatabaseAdapter,
4
+ } from "@hot-updater/plugin-core/internal";
5
+ import { describe, expect, it, vi } from "vitest";
6
+
7
+ import { createHotUpdater } from "../../createHotUpdaterCore";
8
+ import { definePlugin } from "../definePlugin";
9
+ import { apiKeys } from "./index";
10
+
11
+ const API_KEY = "AQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQE";
12
+
13
+ /** A client endpoint with a cacheable answer, to see the policy's Vary. */
14
+ const cached = definePlugin({
15
+ id: "cached",
16
+ schemaVersion: "1",
17
+ schema: {},
18
+ init: () => ({
19
+ api: {},
20
+ endpoints: [
21
+ {
22
+ method: "GET",
23
+ path: "/cached",
24
+ access: "client",
25
+ handler: async () =>
26
+ new Response("ok", {
27
+ headers: { "cache-control": "public, max-age=60" },
28
+ }),
29
+ },
30
+ ],
31
+ }),
32
+ });
33
+
34
+ const start = (
35
+ options: { headerName?: string; adapter?: DatabaseAdapter } = {},
36
+ ) => {
37
+ const hotUpdater = createHotUpdater({
38
+ database: {
39
+ name: "memory",
40
+ adapter: options.adapter ?? createMemoryAdapter(),
41
+ },
42
+ plugins: [
43
+ apiKeys(
44
+ options.headerName === undefined
45
+ ? {}
46
+ : { headerName: options.headerName },
47
+ ),
48
+ cached,
49
+ ],
50
+ });
51
+ const client = (
52
+ path: string,
53
+ headers: Record<string, string> = {},
54
+ init: RequestInit = {},
55
+ ) =>
56
+ hotUpdater.handlers.client(
57
+ new Request(`https://updates.example.com${path}`, { ...init, headers }),
58
+ );
59
+ return { hotUpdater, client };
60
+ };
61
+
62
+ describe("API keys plugin", () => {
63
+ it("protects every client route but /version with a registered, active key", async () => {
64
+ const { hotUpdater, client } = start();
65
+ await hotUpdater.api.apiKeys.register({ apiKey: API_KEY, name: "App" });
66
+ const catalog = "/release-catalogs/app-version/ios/production/1.0.0";
67
+
68
+ expect((await client("/version")).status).toBe(200);
69
+ expect((await client(catalog)).status).toBe(401);
70
+ expect((await client(catalog, { "x-api-key": "not-a-key" })).status).toBe(
71
+ 401,
72
+ );
73
+ const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
74
+ expect(
75
+ (await client("/events", {}, { method: "POST", body: "{" })).status,
76
+ ).toBe(401);
77
+ expect(warn).not.toHaveBeenCalled();
78
+ // Past the key, /events answers that Insights is off: no insights() here.
79
+ const events = await client(
80
+ "/events",
81
+ { "x-api-key": API_KEY },
82
+ { method: "POST", body: "{" },
83
+ );
84
+ expect(events.status).toBe(204);
85
+ expect(events.headers.get("x-hot-updater-insights")).toBe("disabled");
86
+ expect(warn).toHaveBeenCalledOnce();
87
+ warn.mockRestore();
88
+ const allowed = await client("/cached", { "x-api-key": API_KEY });
89
+ expect(allowed.status).toBe(200);
90
+ expect(allowed.headers.get("vary")).toBe("x-api-key");
91
+ });
92
+
93
+ it("creates keys once in plaintext, lists and revokes them without hashes", async () => {
94
+ const { hotUpdater, client } = start();
95
+ const created = await hotUpdater.api.apiKeys.create({ name: " Deploy " });
96
+ expect(created.record).toMatchObject({
97
+ name: "Deploy",
98
+ prefix: created.apiKey.slice(0, 6),
99
+ role: "client",
100
+ revoked_at_ms: null,
101
+ });
102
+ const listed = await hotUpdater.api.apiKeys.list();
103
+ expect(listed).toEqual([created.record]);
104
+ expect(JSON.stringify(listed)).not.toContain("hash");
105
+ expect(
106
+ (await client("/cached", { "x-api-key": created.apiKey })).status,
107
+ ).toBe(200);
108
+
109
+ await expect(
110
+ hotUpdater.api.apiKeys.revoke({ id: created.record.id }),
111
+ ).resolves.toMatchObject({
112
+ id: created.record.id,
113
+ revoked_at_ms: expect.any(Number),
114
+ });
115
+ expect(
116
+ (await client("/cached", { "x-api-key": created.apiKey })).status,
117
+ ).toBe(401);
118
+ await expect(
119
+ hotUpdater.api.apiKeys.revoke({ id: "missing" }),
120
+ ).resolves.toBeNull();
121
+ });
122
+
123
+ it("provisions a saved key idempotently and a new key otherwise", async () => {
124
+ const { hotUpdater } = start();
125
+ const first = await hotUpdater.api.apiKeys.provision({
126
+ existingApiKey: API_KEY,
127
+ name: "Managed",
128
+ });
129
+ const again = await hotUpdater.api.apiKeys.provision({
130
+ existingApiKey: ` ${API_KEY} `,
131
+ name: "Managed",
132
+ });
133
+ expect(again.record.id).toBe(first.record.id);
134
+ const fresh = await hotUpdater.api.apiKeys.provision({ name: "Managed" });
135
+ expect(fresh.apiKey).not.toBe(API_KEY);
136
+ expect(await hotUpdater.api.apiKeys.list()).toHaveLength(2);
137
+ });
138
+
139
+ it("reads keys only from the configured header and varies by it", async () => {
140
+ const { hotUpdater, client } = start({ headerName: "X-Hot-Updater-Key" });
141
+ await hotUpdater.api.apiKeys.register({ apiKey: API_KEY, name: "App" });
142
+
143
+ expect((await client("/cached", { "x-api-key": API_KEY })).status).toBe(
144
+ 401,
145
+ );
146
+ const allowed = await client("/cached", { "x-hot-updater-key": API_KEY });
147
+ expect(allowed.status).toBe(200);
148
+ expect(allowed.headers.get("vary")).toBe("x-hot-updater-key");
149
+ expect(() => apiKeys({ headerName: "invalid header" })).toThrow(
150
+ "must name a valid header",
151
+ );
152
+ });
153
+
154
+ it("answers 503 when credential storage is unavailable", async () => {
155
+ const memory = createMemoryAdapter();
156
+ const { client } = start({
157
+ adapter: {
158
+ ...memory,
159
+ get: async () => {
160
+ throw new Error("storage unavailable");
161
+ },
162
+ query: async () => {
163
+ throw new Error("storage unavailable");
164
+ },
165
+ },
166
+ });
167
+ expect((await client("/cached", { "x-api-key": API_KEY })).status).toBe(
168
+ 503,
169
+ );
170
+ expect((await client("/version")).status).toBe(200);
171
+ });
172
+ });
@@ -0,0 +1,66 @@
1
+ import {
2
+ API_KEY_HEADER_NAME,
3
+ authenticateApiKey,
4
+ createApiKeyManagement,
5
+ normalizeApiKeyHeaderName,
6
+ provisionApiKey,
7
+ registerApiKey,
8
+ } from "../../apiKeys";
9
+ import { markBuiltIn } from "../builtIn";
10
+ import { definePlugin } from "../definePlugin";
11
+ import { createApiKeyModel } from "./model";
12
+ import { apiKeysSchema } from "./schema";
13
+
14
+ export { createApiKeyModel } from "./model";
15
+ export { apiKeysSchema, type ApiKeysSchema } from "./schema";
16
+
17
+ export interface ApiKeysOptions {
18
+ /** The request header that carries the key; defaults to `x-api-key`. */
19
+ readonly headerName?: string;
20
+ }
21
+
22
+ /**
23
+ * Built-in API keys: protects client routes with keys whose SHA-256 digests
24
+ * are stored, and manages them in-process.
25
+ */
26
+ export const apiKeys = (options: ApiKeysOptions = {}) => {
27
+ const headerName = normalizeApiKeyHeaderName(
28
+ options.headerName ?? API_KEY_HEADER_NAME,
29
+ );
30
+ return markBuiltIn(
31
+ definePlugin({
32
+ id: "apiKeys",
33
+ provides: { clientAuth: true },
34
+ schemaVersion: "1.0.0",
35
+ schema: apiKeysSchema,
36
+ init: ({ db }) => {
37
+ const model = createApiKeyModel(db);
38
+ return {
39
+ api: {
40
+ ...createApiKeyManagement({ apiKeys: model }),
41
+ /** Registers a known plaintext key idempotently, for managed init. */
42
+ register: (input: {
43
+ readonly apiKey: string;
44
+ readonly name: string;
45
+ readonly createdAtMs?: number;
46
+ }) => registerApiKey({ ...input, apiKeys: model }),
47
+ /** Reuses a saved key or creates one, for managed init. */
48
+ provision: (input: {
49
+ readonly existingApiKey?: string;
50
+ readonly name: string;
51
+ }) => provisionApiKey({ ...input, apiKeys: model }),
52
+ },
53
+ clientAuth: {
54
+ varyHeaders: [headerName],
55
+ authenticate: (headers: Headers) =>
56
+ authenticateApiKey({
57
+ apiKeys: model,
58
+ headerName,
59
+ request: { headers } as Request,
60
+ }),
61
+ },
62
+ };
63
+ },
64
+ }),
65
+ );
66
+ };
@@ -0,0 +1,69 @@
1
+ import type { ApiKeyModel, ApiKeyRow } from "@hot-updater/plugin-core";
2
+
3
+ import type { HotUpdaterDatabase } from "../../database/database";
4
+ import { DatabaseConstraintError } from "../../database/errors";
5
+ import type { ApiKeysSchema } from "./schema";
6
+
7
+ const toRow = (row: Readonly<Record<string, unknown>>): ApiKeyRow =>
8
+ ({
9
+ id: row.id,
10
+ hash: row.hash,
11
+ name: row.name,
12
+ prefix: row.prefix,
13
+ role: row.role,
14
+ created_at_ms: row.created_at_ms,
15
+ revoked_at_ms: row.revoked_at_ms,
16
+ }) as ApiKeyRow;
17
+
18
+ /** Today's `ApiKeyModel` on the engine: one unique read by hash, keyed writes. */
19
+ export const createApiKeyModel = (
20
+ db: HotUpdaterDatabase<ApiKeysSchema>,
21
+ ): ApiKeyModel => ({
22
+ async create(row) {
23
+ try {
24
+ return await db.transaction(async (tx) => {
25
+ if ((await tx.findOne("api_keys", { hash: row.hash })) !== null) {
26
+ return "existing" as const;
27
+ }
28
+ tx.create("api_keys", row);
29
+ return "created" as const;
30
+ });
31
+ } catch (error) {
32
+ if (error instanceof DatabaseConstraintError && error.reason === "unique")
33
+ return "existing";
34
+ throw error;
35
+ }
36
+ },
37
+ async findByHash(hash) {
38
+ const row = await db.findOne("api_keys", { hash });
39
+ return row === null ? null : toRow(row);
40
+ },
41
+ /** Every key, newest first, then by id; the whole list is the result. */
42
+ async list() {
43
+ const rows: ApiKeyRow[] = [];
44
+ let cursor: string | undefined;
45
+ do {
46
+ const page = await db.findMany("api_keys", {
47
+ index: "byCreated",
48
+ where: {},
49
+ order: "desc",
50
+ limit: 500,
51
+ ...(cursor === undefined ? {} : { cursor }),
52
+ });
53
+ rows.push(...page.rows.map(toRow));
54
+ cursor = page.next;
55
+ } while (cursor !== undefined);
56
+ return rows.sort(
57
+ (left, right) =>
58
+ right.created_at_ms - left.created_at_ms ||
59
+ (left.id < right.id ? -1 : left.id > right.id ? 1 : 0),
60
+ );
61
+ },
62
+ revoke: ({ id, revokedAtMs }) =>
63
+ db.transaction(async (tx) => {
64
+ const row = await tx.findOne("api_keys", { id });
65
+ if (row === null) return null;
66
+ tx.update("api_keys", row, { revoked_at_ms: revokedAtMs });
67
+ return toRow({ ...row, revoked_at_ms: revokedAtMs });
68
+ }),
69
+ });
@@ -0,0 +1,22 @@
1
+ import { defineTable } from "../../database/schema";
2
+
3
+ /** v1's `api_keys` columns; the plaintext key is never stored, only its SHA-256 digest. */
4
+ export const apiKeysSchema = {
5
+ api_keys: defineTable(
6
+ {
7
+ id: { type: "string", maxLength: 255 },
8
+ hash: { type: "string", maxLength: 64, unique: true },
9
+ name: { type: "string", maxLength: 64 },
10
+ prefix: { type: "string", maxLength: 16 },
11
+ role: { type: "string", maxLength: 16 },
12
+ created_at_ms: { type: "integer" },
13
+ revoked_at_ms: { type: "integer", required: false },
14
+ },
15
+ {
16
+ key: ["id"],
17
+ indexes: { byCreated: { eq: [], sort: ["created_at_ms"] } },
18
+ },
19
+ ),
20
+ } as const;
21
+
22
+ export type ApiKeysSchema = typeof apiKeysSchema;
@@ -0,0 +1,5 @@
1
+ /** Marks built-in plugins, whose tables keep their names instead of taking the plugin id as a namespace. */
2
+ export const builtInPlugin = Symbol.for("@hot-updater/server/built-in-plugin");
3
+
4
+ export const markBuiltIn = <TPlugin extends object>(plugin: TPlugin): TPlugin =>
5
+ Object.defineProperty(plugin, builtInPlugin, { value: true });
@@ -0,0 +1,100 @@
1
+ import type { CoreReads } from "../core/reads";
2
+ import type { HotUpdaterDatabase } from "../database/database";
3
+ import type { ModuleSchema } from "../database/schema";
4
+
5
+ export type PluginEndpointMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
6
+
7
+ export interface PluginEndpoint {
8
+ readonly method: PluginEndpointMethod;
9
+ /** Relative to the handler's mount; `:name` segments become `params`. */
10
+ readonly path: string;
11
+ /**
12
+ * `"client"` mounts on `handlers.client` behind the client-route policy;
13
+ * `"admin"` mounts on `handlers.admin`, which the host protects.
14
+ */
15
+ readonly access: "client" | "admin";
16
+ readonly handler: (
17
+ request: Request,
18
+ params: Readonly<Record<string, string>>,
19
+ ) => Promise<Response>;
20
+ }
21
+
22
+ /** The client-route policy a plugin provides, such as API keys. */
23
+ export interface ClientAuth {
24
+ /** Request headers the decision reads; core adds them to `Vary` on cacheable client responses. */
25
+ readonly varyHeaders: readonly string[];
26
+ /** Whether the request may use client routes; a throw answers 503. */
27
+ authenticate(headers: Headers): Promise<boolean>;
28
+ }
29
+
30
+ export interface PluginInstance<Api = unknown> {
31
+ readonly api: Api;
32
+ readonly endpoints?: readonly PluginEndpoint[];
33
+ readonly clientAuth?: ClientAuth;
34
+ }
35
+
36
+ /** Core's reads: bundles, Releases, Catalogs, and channels, each through a declared index. Plugins never write core. */
37
+ export type CoreReader = CoreReads;
38
+
39
+ export interface PluginContext<S extends ModuleSchema> {
40
+ /** The plugin's own tables and aggregates. */
41
+ readonly db: HotUpdaterDatabase<S>;
42
+ readonly core: CoreReader;
43
+ now(): number;
44
+ }
45
+
46
+ export interface PluginProvides {
47
+ readonly clientAuth?: true;
48
+ }
49
+
50
+ /** An instance whose `clientAuth` matches what the plugin declares it provides. */
51
+ export type InstanceFor<TProvides, TInstance> = TProvides extends {
52
+ readonly clientAuth: true;
53
+ }
54
+ ? TInstance & { readonly clientAuth: ClientAuth }
55
+ : TInstance & {
56
+ readonly clientAuth?: "Declare provides: { clientAuth: true } to return clientAuth";
57
+ };
58
+
59
+ export interface HotUpdaterPlugin<
60
+ TId extends string = string,
61
+ TSchema extends ModuleSchema = ModuleSchema,
62
+ TInstance extends PluginInstance = PluginInstance,
63
+ TProvides extends PluginProvides = PluginProvides,
64
+ > {
65
+ readonly id: TId;
66
+ /** Static, so the type system and startup can count client-route policies. */
67
+ readonly provides?: TProvides;
68
+ /** Stored under the settings key `schema.<id>`. */
69
+ readonly schemaVersion: string;
70
+ readonly schema: TSchema;
71
+ /** Called once at startup, synchronously. */
72
+ init(context: PluginContext<TSchema>): TInstance;
73
+ /** Only core modules carry a kind. */
74
+ readonly kind?: "Core is built in; it is not a plugin";
75
+ }
76
+
77
+ /** Declares a plugin; built-in and third-party plugins use the same contract. */
78
+ export const definePlugin = <
79
+ const TId extends string,
80
+ const TSchema extends ModuleSchema,
81
+ TInstance extends PluginInstance,
82
+ const TProvides extends PluginProvides = {},
83
+ >(plugin: {
84
+ readonly id: TId;
85
+ readonly provides?: TProvides;
86
+ readonly schemaVersion: string;
87
+ readonly schema: TSchema;
88
+ init(context: PluginContext<TSchema>): InstanceFor<TProvides, TInstance>;
89
+ }): HotUpdaterPlugin<TId, TSchema, TInstance, TProvides> =>
90
+ plugin as HotUpdaterPlugin<TId, TSchema, TInstance, TProvides>;
91
+
92
+ /** Any plugin, whatever its schema and API. */
93
+ export type AnyHotUpdaterPlugin = HotUpdaterPlugin<string, any, any, any>;
94
+
95
+ /** Each plugin's API by id. */
96
+ export type PluginApis<TPlugins extends readonly AnyHotUpdaterPlugin[]> = {
97
+ readonly [TPlugin in TPlugins[number] as TPlugin["id"]]: ReturnType<
98
+ TPlugin["init"]
99
+ >["api"];
100
+ };
@@ -0,0 +1,55 @@
1
+ /**
2
+ * The plugin authoring API. Built-in and third-party plugins declare their
3
+ * tables and aggregates here and receive a typed database handle in `init`.
4
+ */
5
+ export {
6
+ definePlugin,
7
+ type AnyHotUpdaterPlugin,
8
+ type ClientAuth,
9
+ type CoreReader,
10
+ type HotUpdaterPlugin,
11
+ type InstanceFor,
12
+ type PluginApis,
13
+ type PluginContext,
14
+ type PluginEndpoint,
15
+ type PluginEndpointMethod,
16
+ type PluginInstance,
17
+ type PluginProvides,
18
+ } from "./definePlugin";
19
+ export {
20
+ defineAggregate,
21
+ defineTable,
22
+ type AggregateDefinition,
23
+ type DerivedDefinition,
24
+ type FieldDefinition,
25
+ type FieldReference,
26
+ type FieldType,
27
+ type IndexDefinition,
28
+ type ModuleSchema,
29
+ type ReferenceAction,
30
+ type TableDefinition,
31
+ } from "../database/schema";
32
+ export type {
33
+ AggregateChanges,
34
+ AggregateIdentity,
35
+ AggregateRow,
36
+ CreateRow,
37
+ HotUpdaterDatabase,
38
+ HotUpdaterTransaction,
39
+ Lookup,
40
+ ReadOptions,
41
+ ReadRow,
42
+ TableRow,
43
+ UpdateSet,
44
+ } from "../database/database";
45
+ export type { Page } from "../database/engineReads";
46
+ export {
47
+ DatabaseAmbiguousCommitError,
48
+ DatabaseConflictError,
49
+ DatabaseConstraintError,
50
+ DatabaseTransactionError,
51
+ type ConstraintReason,
52
+ } from "../database/errors";
53
+ export { DatabaseQueryError } from "../database/engineReads";
54
+ export { DatabaseCursorError } from "../database/cursor";
55
+ export { HotUpdaterConfigError } from "../assembly/assemblePlugins";
@@ -0,0 +1,86 @@
1
+ import type {
2
+ BundleEventRow,
3
+ InsightsCountEventsInput,
4
+ InsightsCountLatestEventsInput,
5
+ InsightsFindLatestEventsInput,
6
+ InsightsGetAppUsageInput,
7
+ InsightsGetReleaseActivityInput,
8
+ InsightsListEventsInput,
9
+ } from "@hot-updater/plugin-core";
10
+
11
+ import type { HotUpdaterDatabase } from "../../database/database";
12
+ import { createInsightsProvider } from "../../insights/provider";
13
+ import {
14
+ createInsightsRouteHandlers,
15
+ INSIGHTS_ROUTES,
16
+ } from "../../insights/routes";
17
+ import { markBuiltIn } from "../builtIn";
18
+ import { definePlugin } from "../definePlugin";
19
+ import { createInsightsModel } from "./model";
20
+ import {
21
+ countEvents,
22
+ countLatestEvents,
23
+ findLatestEvents,
24
+ getAppUsage,
25
+ getReleaseActivity,
26
+ listEvents,
27
+ } from "./reads";
28
+ import { recordEvent } from "./recordEvent";
29
+ import { insightsSchema, type InsightsSchema } from "./schema";
30
+
31
+ export { createInsightsModel } from "./model";
32
+ export { insightsIdentity, type InsightsIdentityParts } from "./recordEvent";
33
+ export { insightsSchema, type InsightsSchema } from "./schema";
34
+
35
+ const createInsightsApi = (
36
+ db: HotUpdaterDatabase<InsightsSchema>,
37
+ now: () => number,
38
+ ) => ({
39
+ /** Records one validated event row; a repeated id changes nothing. */
40
+ recordEvent: (event: BundleEventRow) => recordEvent(db, event),
41
+ listEvents: (input: InsightsListEventsInput) => listEvents(db, input),
42
+ findLatestEvents: (input: InsightsFindLatestEventsInput) =>
43
+ findLatestEvents(db, input),
44
+ countLatestEvents: (input: InsightsCountLatestEventsInput) =>
45
+ countLatestEvents(db, input),
46
+ countEvents: (input: InsightsCountEventsInput) => countEvents(db, input),
47
+ getReleaseActivity: (input: InsightsGetReleaseActivityInput) =>
48
+ getReleaseActivity(db, input, now),
49
+ getAppUsage: (input: InsightsGetAppUsageInput) => getAppUsage(db, input, now),
50
+ });
51
+
52
+ export type InsightsApi = ReturnType<typeof createInsightsApi>;
53
+
54
+ /**
55
+ * Built-in Insights: bundle lifecycle events, each installation's latest
56
+ * event, and the counters, gauges, and sketches its reads come from. It
57
+ * serves `POST /events` to clients and the Insights reads to admins.
58
+ */
59
+ export const insights = () =>
60
+ markBuiltIn(
61
+ definePlugin({
62
+ id: "insights",
63
+ schemaVersion: "1.0.0",
64
+ schema: insightsSchema,
65
+ init: ({ db, now }) => {
66
+ const api = createInsightsApi(db, now);
67
+ const routes = createInsightsRouteHandlers(
68
+ createInsightsProvider(createInsightsModel(api)),
69
+ );
70
+ return {
71
+ api,
72
+ endpoints: INSIGHTS_ROUTES.map(
73
+ ({ access, method, path, handler }) => ({
74
+ access,
75
+ method,
76
+ path,
77
+ handler: (
78
+ request: Request,
79
+ params: Readonly<Record<string, string>>,
80
+ ) => routes[handler](params, request),
81
+ }),
82
+ ),
83
+ };
84
+ },
85
+ }),
86
+ );