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

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 (309) hide show
  1. package/dist/adapters/drizzle.cjs +5 -5
  2. package/dist/adapters/drizzle.mjs +4 -4
  3. package/dist/adapters/kysely.cjs +3 -3
  4. package/dist/adapters/kysely.mjs +2 -2
  5. package/dist/adapters/mongodb.cjs +3 -3
  6. package/dist/adapters/mongodb.mjs +2 -2
  7. package/dist/adapters/mongodbAdapter.cjs +19 -1
  8. package/dist/adapters/mongodbAdapter.mjs +19 -1
  9. package/dist/adapters/prisma.cjs +5 -5
  10. package/dist/adapters/prisma.mjs +4 -4
  11. package/dist/assembly/assemblePlugins.cjs +47 -28
  12. package/dist/assembly/assemblePlugins.d.cts +3 -7
  13. package/dist/assembly/assemblePlugins.d.mts +3 -7
  14. package/dist/assembly/assemblePlugins.mjs +46 -27
  15. package/dist/assembly/clientPlugins.cjs +86 -0
  16. package/dist/assembly/clientPlugins.d.cts +16 -0
  17. package/dist/assembly/clientPlugins.d.mts +16 -0
  18. package/dist/assembly/clientPlugins.mjs +86 -0
  19. package/dist/assembly/configError.cjs +7 -0
  20. package/dist/assembly/configError.d.cts +7 -0
  21. package/dist/assembly/configError.d.mts +7 -0
  22. package/dist/assembly/configError.mjs +7 -0
  23. package/dist/assembly/databasePlugins.cjs +5 -1
  24. package/dist/assembly/databasePlugins.d.cts +5 -5
  25. package/dist/assembly/databasePlugins.d.mts +5 -5
  26. package/dist/assembly/databasePlugins.mjs +5 -1
  27. package/dist/assembly/pluginCli.cjs +125 -0
  28. package/dist/assembly/pluginCli.d.cts +59 -0
  29. package/dist/assembly/pluginCli.d.mts +59 -0
  30. package/dist/assembly/pluginCli.mjs +121 -0
  31. package/dist/createHotUpdaterCore.cjs +14 -16
  32. package/dist/createHotUpdaterCore.d.cts +10 -3
  33. package/dist/createHotUpdaterCore.d.mts +10 -3
  34. package/dist/createHotUpdaterCore.mjs +11 -13
  35. package/dist/database/aggregateBatching.cjs +626 -0
  36. package/dist/database/aggregateBatching.d.cts +10 -0
  37. package/dist/database/aggregateBatching.d.mts +10 -0
  38. package/dist/database/aggregateBatching.mjs +625 -0
  39. package/dist/{insights/errors.cjs → database/busy.cjs} +2 -15
  40. package/dist/database/busy.d.cts +12 -0
  41. package/dist/database/busy.d.mts +12 -0
  42. package/dist/{insights/errors.mjs → database/busy.mjs} +3 -14
  43. package/dist/database/database.cjs +22 -3
  44. package/dist/database/database.d.cts +15 -2
  45. package/dist/database/database.d.mts +15 -2
  46. package/dist/database/database.mjs +22 -3
  47. package/dist/database/definitions.d.cts +10 -0
  48. package/dist/database/definitions.d.mts +10 -0
  49. package/dist/database/engine.d.cts +2 -1
  50. package/dist/database/engine.d.mts +2 -1
  51. package/dist/database/engineAggregates.cjs +7 -4
  52. package/dist/database/engineAggregates.mjs +8 -5
  53. package/dist/database/engineReads.cjs +5 -3
  54. package/dist/database/engineReads.mjs +6 -4
  55. package/dist/database/engineTransaction.cjs +2 -6
  56. package/dist/database/engineTransaction.mjs +2 -6
  57. package/dist/database/fence.cjs +2 -1
  58. package/dist/database/fence.mjs +2 -1
  59. package/dist/database/index.cjs +17 -8
  60. package/dist/database/index.d.cts +5 -4
  61. package/dist/database/index.d.mts +5 -4
  62. package/dist/database/index.mjs +6 -5
  63. package/dist/database/kv/kvAdapter.cjs +15 -3
  64. package/dist/database/kv/kvAdapter.d.cts +8 -0
  65. package/dist/database/kv/kvAdapter.d.mts +8 -0
  66. package/dist/database/kv/kvAdapter.mjs +16 -4
  67. package/dist/database/resolveSchema.cjs +4 -1
  68. package/dist/database/resolveSchema.d.cts +1 -1
  69. package/dist/database/resolveSchema.d.mts +1 -1
  70. package/dist/database/resolveSchema.mjs +4 -1
  71. package/dist/database/retention.cjs +92 -0
  72. package/dist/database/retention.mjs +90 -0
  73. package/dist/database/schema.cjs +5 -2
  74. package/dist/database/schema.d.cts +30 -1
  75. package/dist/database/schema.d.mts +30 -1
  76. package/dist/database/schema.mjs +5 -2
  77. package/dist/database/sql/sqlAdapter.cjs +8 -0
  78. package/dist/database/sql/sqlAdapter.mjs +9 -1
  79. package/dist/database/sql/sqlSchema.cjs +56 -0
  80. package/dist/database/sql/sqlSchema.mjs +55 -1
  81. package/dist/db/coreDatabase.cjs +85 -0
  82. package/dist/db/coreDatabase.d.cts +57 -0
  83. package/dist/db/coreDatabase.d.mts +57 -0
  84. package/dist/db/coreDatabase.mjs +78 -0
  85. package/dist/db/index.cjs +11 -3
  86. package/dist/db/index.d.cts +7 -3
  87. package/dist/db/index.d.mts +7 -3
  88. package/dist/db/index.mjs +6 -3
  89. package/dist/db/types.d.cts +3 -3
  90. package/dist/db/types.d.mts +3 -3
  91. package/dist/diff.cjs +3 -0
  92. package/dist/diff.d.cts +2 -0
  93. package/dist/diff.d.mts +2 -0
  94. package/dist/diff.mjs +2 -0
  95. package/dist/handler.cjs +2 -14
  96. package/dist/handler.mjs +1 -13
  97. package/dist/handlerReleaseCatalogRoutes.cjs +21 -2
  98. package/dist/handlerReleaseCatalogRoutes.mjs +21 -2
  99. package/dist/index.cjs +2 -6
  100. package/dist/index.d.cts +4 -7
  101. package/dist/index.d.mts +4 -7
  102. package/dist/index.mjs +2 -4
  103. package/dist/package.cjs +1 -1
  104. package/dist/package.mjs +1 -1
  105. package/dist/{apiKeys.cjs → plugins/api-keys/apiKeys.cjs} +1 -1
  106. package/dist/{apiKeys.d.cts → plugins/api-keys/apiKeys.d.cts} +2 -2
  107. package/dist/{apiKeys.d.mts → plugins/api-keys/apiKeys.d.mts} +2 -2
  108. package/dist/{apiKeys.mjs → plugins/api-keys/apiKeys.mjs} +1 -1
  109. package/dist/plugins/api-keys/cli.cjs +115 -0
  110. package/dist/plugins/api-keys/cli.mjs +114 -0
  111. package/dist/plugins/api-keys/index.cjs +9 -6
  112. package/dist/plugins/api-keys/index.d.cts +4 -5
  113. package/dist/plugins/api-keys/index.d.mts +4 -5
  114. package/dist/plugins/api-keys/index.mjs +9 -7
  115. package/dist/plugins/api-keys/model.d.cts +20 -2
  116. package/dist/plugins/api-keys/model.d.mts +20 -2
  117. package/dist/plugins/definePlugin.cjs +1 -1
  118. package/dist/plugins/definePlugin.d.cts +130 -3
  119. package/dist/plugins/definePlugin.d.mts +130 -3
  120. package/dist/plugins/definePlugin.mjs +1 -1
  121. package/dist/plugins/index.cjs +25 -4
  122. package/dist/plugins/index.d.cts +7 -4
  123. package/dist/plugins/index.d.mts +7 -4
  124. package/dist/plugins/index.mjs +6 -4
  125. package/dist/plugins/insights/contract.cjs +193 -0
  126. package/dist/plugins/insights/contract.mjs +189 -0
  127. package/dist/{insights → plugins/insights}/domain.d.cts +60 -15
  128. package/dist/{insights → plugins/insights}/domain.d.mts +60 -15
  129. package/dist/plugins/insights/errors.cjs +15 -0
  130. package/dist/plugins/insights/errors.mjs +14 -0
  131. package/dist/{insights → plugins/insights}/eventInput.cjs +155 -22
  132. package/dist/{insights → plugins/insights}/eventInput.mjs +155 -22
  133. package/dist/plugins/insights/eventRow.cjs +49 -0
  134. package/dist/plugins/insights/eventRow.d.cts +64 -0
  135. package/dist/plugins/insights/eventRow.d.mts +64 -0
  136. package/dist/plugins/insights/eventRow.mjs +47 -0
  137. package/dist/plugins/insights/index.cjs +106 -26
  138. package/dist/plugins/insights/index.d.cts +130 -27
  139. package/dist/plugins/insights/index.d.mts +130 -27
  140. package/dist/plugins/insights/index.mjs +106 -29
  141. package/dist/plugins/insights/model.cjs +2 -2
  142. package/dist/plugins/insights/model.d.cts +1 -1
  143. package/dist/plugins/insights/model.d.mts +1 -1
  144. package/dist/plugins/insights/model.mjs +1 -1
  145. package/dist/plugins/insights/modelTypes.d.cts +176 -0
  146. package/dist/plugins/insights/modelTypes.d.mts +176 -0
  147. package/dist/plugins/insights/overview.cjs +109 -0
  148. package/dist/plugins/insights/overview.d.cts +15 -0
  149. package/dist/plugins/insights/overview.d.mts +15 -0
  150. package/dist/plugins/insights/overview.mjs +107 -0
  151. package/dist/{insights → plugins/insights}/provider.cjs +33 -14
  152. package/dist/{insights → plugins/insights}/provider.d.cts +2 -2
  153. package/dist/{insights → plugins/insights}/provider.d.mts +2 -2
  154. package/dist/{insights → plugins/insights}/provider.mjs +30 -11
  155. package/dist/{insights → plugins/insights}/queryInput.cjs +2 -2
  156. package/dist/{insights → plugins/insights}/queryInput.mjs +2 -2
  157. package/dist/plugins/insights/reads.cjs +298 -88
  158. package/dist/plugins/insights/reads.d.cts +61 -0
  159. package/dist/plugins/insights/reads.d.mts +61 -0
  160. package/dist/plugins/insights/reads.mjs +298 -90
  161. package/dist/plugins/insights/recordEvent.cjs +223 -39
  162. package/dist/plugins/insights/recordEvent.d.cts +9 -4
  163. package/dist/plugins/insights/recordEvent.d.mts +9 -4
  164. package/dist/plugins/insights/recordEvent.mjs +221 -37
  165. package/dist/{insights → plugins/insights}/routes.cjs +3 -30
  166. package/dist/{insights → plugins/insights}/routes.mjs +4 -28
  167. package/dist/plugins/insights/schema.cjs +182 -40
  168. package/dist/plugins/insights/schema.d.cts +446 -6
  169. package/dist/plugins/insights/schema.d.mts +446 -6
  170. package/dist/plugins/insights/schema.mjs +180 -41
  171. package/dist/plugins/insights/testing/eventRow.d.mts +64 -0
  172. package/dist/plugins/insights/testing/expectInsightsIndex.mjs +18 -0
  173. package/dist/plugins/insights/testing/fixtures.d.mts +8 -0
  174. package/dist/plugins/insights/testing/fixtures.mjs +25 -0
  175. package/dist/plugins/insights/testing/index.d.mts +24 -0
  176. package/dist/plugins/insights/testing/index.mjs +25 -0
  177. package/dist/plugins/insights/testing/insightsModelTests.mjs +714 -0
  178. package/dist/plugins/insights/testing/modelTypes.d.mts +176 -0
  179. package/dist/plugins/insights/testing/setupInsightsHttpTestSuite.d.mts +11 -0
  180. package/dist/plugins/insights/testing/setupInsightsHttpTestSuite.mjs +107 -0
  181. package/dist/plugins/insights/testing/setupInsightsModelTestSuite.d.mts +11 -0
  182. package/dist/plugins/insights/testing/setupInsightsModelTestSuite.mjs +31 -0
  183. package/dist/plugins/insights/testing/types.d.mts +26 -0
  184. package/dist/{insights → plugins/insights}/types.d.cts +3 -2
  185. package/dist/{insights → plugins/insights}/types.d.mts +3 -2
  186. package/package.json +18 -7
  187. package/src/adapters/drizzle.conformance.integration.spec.ts +2 -2
  188. package/src/adapters/drizzle.readBudgets.integration.spec.ts +6 -4
  189. package/src/adapters/drizzle.spec.ts +15 -7
  190. package/src/adapters/drizzle.ts +6 -6
  191. package/src/adapters/kysely.conformance.integration.spec.ts +2 -2
  192. package/src/adapters/kysely.readBudgets.integration.spec.ts +4 -2
  193. package/src/adapters/kysely.spec.ts +13 -9
  194. package/src/adapters/kysely.ts +2 -2
  195. package/src/adapters/mongodb.integration.spec.ts +98 -7
  196. package/src/adapters/mongodb.ts +2 -2
  197. package/src/adapters/mongodbAdapter.ts +14 -0
  198. package/src/adapters/prisma.conformance.integration.spec.ts +2 -2
  199. package/src/adapters/prisma.integration.spec.ts +16 -8
  200. package/src/adapters/prisma.readBudgets.integration.spec.ts +5 -2
  201. package/src/adapters/prisma.spec.ts +17 -9
  202. package/src/adapters/prisma.ts +6 -6
  203. package/src/adapters/prismaTestClients.ts +8 -1
  204. package/src/assembly/assemblePlugins.ts +73 -40
  205. package/src/assembly/assembly.spec.ts +63 -11
  206. package/src/assembly/assembly.types.spec.ts +50 -2
  207. package/src/assembly/clientPlugins.ts +113 -0
  208. package/src/assembly/configError.ts +4 -0
  209. package/src/assembly/databasePlugins.ts +11 -5
  210. package/src/assembly/pluginCli.spec.ts +254 -0
  211. package/src/assembly/pluginCli.ts +248 -0
  212. package/src/assembly/{builtInRoutes.spec.ts → pluginRoutes.spec.ts} +10 -37
  213. package/src/createHotUpdaterCore.ts +21 -17
  214. package/src/database/aggregateBatching.spec.ts +577 -0
  215. package/src/database/aggregateBatching.ts +803 -0
  216. package/src/{insights/errors.spec.ts → database/busy.spec.ts} +2 -5
  217. package/src/{insights/errors.ts → database/busy.ts} +1 -13
  218. package/src/database/database.ts +39 -8
  219. package/src/database/definitions.ts +4 -0
  220. package/src/database/engineAggregates.spec.ts +4 -7
  221. package/src/database/engineAggregates.ts +5 -9
  222. package/src/database/engineReads.ts +7 -5
  223. package/src/database/engineTransaction.ts +1 -7
  224. package/src/database/fence.spec.ts +5 -5
  225. package/src/database/fence.ts +4 -0
  226. package/src/database/index.ts +13 -7
  227. package/src/database/kv/kvAdapter.batching.integration.spec.ts +15 -0
  228. package/src/database/kv/kvAdapter.conformance.integration.spec.ts +2 -0
  229. package/src/database/kv/kvAdapter.spec.ts +128 -1
  230. package/src/database/kv/kvAdapter.ts +30 -1
  231. package/src/database/kv/kvTestStore.ts +28 -1
  232. package/src/database/resolveSchema.ts +4 -1
  233. package/src/database/retention.spec.ts +314 -0
  234. package/src/database/retention.ts +129 -0
  235. package/src/database/schema.ts +44 -0
  236. package/src/database/sql/sqlAdapter.integration.spec.ts +4 -7
  237. package/src/database/sql/sqlAdapter.readBudgets.integration.spec.ts +18 -4
  238. package/src/database/sql/sqlAdapter.spec.ts +91 -3
  239. package/src/database/sql/sqlAdapter.ts +20 -0
  240. package/src/database/sql/sqlSchema.ts +81 -0
  241. package/src/databaseTestSuite.spec.ts +9 -4
  242. package/src/db/coreDatabase.ts +153 -0
  243. package/src/db/engineSql.spec.ts +8 -7
  244. package/src/db/index.ts +19 -2
  245. package/src/db/pluginTables.spec.ts +57 -27
  246. package/src/db/types.ts +3 -3
  247. package/src/diff.ts +6 -0
  248. package/src/handler-standalone.integration.spec.ts +2 -3
  249. package/src/handler.ts +1 -32
  250. package/src/handlerReleaseCatalogRoutes.ts +26 -2
  251. package/src/index.ts +0 -10
  252. package/src/{apiKeys.integration.spec.ts → plugins/api-keys/apiKeys.integration.spec.ts} +4 -4
  253. package/src/{apiKeys.spec.ts → plugins/api-keys/apiKeys.spec.ts} +3 -3
  254. package/src/{apiKeys.ts → plugins/api-keys/apiKeys.ts} +1 -1
  255. package/src/plugins/api-keys/apiKeysPlugin.spec.ts +11 -15
  256. package/src/plugins/api-keys/cli.spec.ts +187 -0
  257. package/src/plugins/api-keys/cli.ts +140 -0
  258. package/src/plugins/api-keys/index.ts +48 -41
  259. package/src/plugins/api-keys/model.ts +21 -2
  260. package/src/plugins/definePlugin.ts +144 -2
  261. package/src/plugins/index.ts +20 -2
  262. package/src/plugins/insights/contract.spec.ts +285 -0
  263. package/src/plugins/insights/contract.ts +372 -0
  264. package/src/{insights → plugins/insights}/domain.ts +73 -15
  265. package/src/plugins/insights/errors.ts +11 -0
  266. package/src/{insights → plugins/insights}/eventInput.ts +189 -29
  267. package/src/plugins/insights/eventRow.ts +209 -0
  268. package/src/plugins/insights/index.ts +181 -45
  269. package/src/{insights → plugins/insights}/insights.integration.spec.ts +330 -34
  270. package/src/plugins/insights/insightsRollout.integration.spec.ts +1 -2
  271. package/src/plugins/insights/model.spec.ts +3 -5
  272. package/src/plugins/insights/model.ts +2 -3
  273. package/src/plugins/insights/modelTypes.ts +197 -0
  274. package/src/plugins/insights/overview.spec.ts +64 -0
  275. package/src/plugins/insights/overview.ts +214 -0
  276. package/src/{insights → plugins/insights}/provider.spec.ts +21 -10
  277. package/src/{insights → plugins/insights}/provider.ts +58 -21
  278. package/src/{insights → plugins/insights}/queryInput.ts +2 -2
  279. package/src/plugins/insights/reads.spec.ts +340 -52
  280. package/src/plugins/insights/reads.ts +453 -123
  281. package/src/plugins/insights/recordEvent.spec.ts +474 -20
  282. package/src/plugins/insights/recordEvent.ts +301 -63
  283. package/src/plugins/insights/retention.spec.ts +115 -0
  284. package/src/{insights → plugins/insights}/routes.ts +1 -31
  285. package/src/plugins/insights/schema.ts +356 -176
  286. package/src/plugins/insights/testing/expectInsightsIndex.spec.ts +42 -0
  287. package/src/plugins/insights/testing/expectInsightsIndex.ts +20 -0
  288. package/src/plugins/insights/testing/fixtures.ts +30 -0
  289. package/src/plugins/insights/testing/index.ts +45 -0
  290. package/src/plugins/insights/testing/insightsModelTests.ts +860 -0
  291. package/src/plugins/insights/testing/setupInsightsHttpTestSuite.ts +152 -0
  292. package/src/plugins/insights/testing/setupInsightsModelTestSuite.ts +36 -0
  293. package/src/plugins/insights/testing/types.ts +30 -0
  294. package/src/{insights → plugins/insights}/types.ts +1 -1
  295. package/src/readBudgets.testFixtures.ts +2 -2
  296. package/src/releaseCatalogRoutes.integration.spec.ts +7 -0
  297. package/src/retention.spec.ts +73 -0
  298. package/src/runtime.spec.ts +11 -12
  299. package/src/runtime.testFixtures.ts +7 -2
  300. package/src/testUtilsMutation.integration.spec.ts +2 -1
  301. package/src/testUtilsPackage.integration.spec.ts +7 -3
  302. package/dist/db/builtInDatabase.cjs +0 -104
  303. package/dist/db/builtInDatabase.d.cts +0 -38
  304. package/dist/db/builtInDatabase.d.mts +0 -38
  305. package/dist/db/builtInDatabase.mjs +0 -97
  306. package/dist/plugins/builtIn.cjs +0 -7
  307. package/dist/plugins/builtIn.mjs +0 -6
  308. package/src/db/builtInDatabase.ts +0 -149
  309. package/src/plugins/builtIn.ts +0 -5
package/dist/handler.cjs CHANGED
@@ -1,6 +1,5 @@
1
1
  const require_fence = require("./database/fence.cjs");
2
- const require_routes = require("./insights/routes.cjs");
3
- const require_assemblePlugins = require("./assembly/assemblePlugins.cjs");
2
+ const require_configError = require("./assembly/configError.cjs");
4
3
  const require_handlerErrors = require("./handlerErrors.cjs");
5
4
  const require_handlerAdminRoutes = require("./handlerAdminRoutes.cjs");
6
5
  const require_handlerReleaseCatalogRoutes = require("./handlerReleaseCatalogRoutes.cjs");
@@ -85,8 +84,6 @@ function createHotUpdaterHandlers({ api, clientPolicy, downloadStorageObject, en
85
84
  ...require_handlerVersionRoutes.createVersionRouteHandlers(plugins),
86
85
  ...require_handlerReleaseCatalogRoutes.createReleaseCatalogRouteHandlers(),
87
86
  ...require_handlerAdminRoutes.createAdminRouteHandlers(),
88
- ...Object.fromEntries(require_routes.INSIGHTS_ROUTES.map(({ handler }) => [handler, require_routes.insightsDisabled])),
89
- appendBundleEvent: require_routes.createDroppedEventHandler(),
90
87
  ...downloadStorageObject === void 0 ? {} : { downloadStorageObject: createDownloadStorageRouteHandler(downloadStorageObject) }
91
88
  };
92
89
  const routes = [];
@@ -94,7 +91,7 @@ function createHotUpdaterHandlers({ api, clientPolicy, downloadStorageObject, en
94
91
  const mount = (router, admin) => (method, path, handler) => {
95
92
  const shape = `${admin ? "admin" : "client"} ${method} ${path.replaceAll(/:[^/]+/gu, ":")}`;
96
93
  const taken = shapes.get(shape);
97
- if (taken !== void 0) throw new require_assemblePlugins.HotUpdaterConfigError(`${handler} (${method} ${path}) collides with ${taken} on handlers.${admin ? "admin" : "client"}.`);
94
+ if (taken !== void 0) throw new require_configError.HotUpdaterConfigError(`${handler} (${method} ${path}) collides with ${taken} on handlers.${admin ? "admin" : "client"}.`);
98
95
  shapes.set(shape, handler);
99
96
  require_internalRouter.addRoute(router, method, path, handler);
100
97
  routes.push({
@@ -103,13 +100,6 @@ function createHotUpdaterHandlers({ api, clientPolicy, downloadStorageObject, en
103
100
  access: admin ? "admin" : PUBLIC_CLIENT_ROUTES.has(handler) ? "public" : "client"
104
101
  });
105
102
  };
106
- /** The Insights routes no plugin endpoint serves, which answer that Insights is off. */
107
- const mountInsights = (access, add) => {
108
- for (const route of require_routes.INSIGHTS_ROUTES) {
109
- const served = endpoints.some((endpoint) => endpoint.access === route.access && endpoint.method === route.method && endpoint.path === route.path);
110
- if (route.access === access && !served) add(route.method, route.path, route.handler);
111
- }
112
- };
113
103
  const clientRouter = require_internalRouter.createRouter();
114
104
  const addClientRoute = mount(clientRouter, false);
115
105
  addClientRoute("GET", "/version", "version");
@@ -117,12 +107,10 @@ function createHotUpdaterHandlers({ api, clientPolicy, downloadStorageObject, en
117
107
  addClientRoute("GET", "/release-catalogs/app-version/:platform/:channelKey/:appVersion", "appVersionReleaseCatalog");
118
108
  addClientRoute("GET", "/release-catalogs/fingerprint/:platform/:channelKey/:fingerprintHash", "fingerprintReleaseCatalog");
119
109
  addClientRoute("GET", "/artifacts/v1/:targetBundleId/from/:currentBundleId", "artifactV1");
120
- mountInsights("client", addClientRoute);
121
110
  const adminRouter = require_internalRouter.createRouter();
122
111
  const addAdminRoute = mount(adminRouter, true);
123
112
  addAdminRoute("GET", "/version", "adminVersion");
124
113
  for (const route of require_handlerAdminRoutes.ADMIN_ROUTES) addAdminRoute(route.method, route.path, route.handler);
125
- mountInsights("admin", addAdminRoute);
126
114
  for (const endpoint of endpoints) {
127
115
  const name = `plugin ${endpoint.plugin}: ${endpoint.method} ${endpoint.path}`;
128
116
  routeHandlers[name] = (params, request) => endpoint.handler(request, params);
package/dist/handler.mjs CHANGED
@@ -1,6 +1,5 @@
1
1
  import { HotUpdaterSchemaMigrationRequiredError } from "./database/fence.mjs";
2
- import { INSIGHTS_ROUTES, createDroppedEventHandler, insightsDisabled } from "./insights/routes.mjs";
3
- import { HotUpdaterConfigError } from "./assembly/assemblePlugins.mjs";
2
+ import { HotUpdaterConfigError } from "./assembly/configError.mjs";
4
3
  import { HandlerBadRequestError } from "./handlerErrors.mjs";
5
4
  import { ADMIN_ROUTES, createAdminRouteHandlers } from "./handlerAdminRoutes.mjs";
6
5
  import { createReleaseCatalogRouteHandlers } from "./handlerReleaseCatalogRoutes.mjs";
@@ -85,8 +84,6 @@ function createHotUpdaterHandlers({ api, clientPolicy, downloadStorageObject, en
85
84
  ...createVersionRouteHandlers(plugins),
86
85
  ...createReleaseCatalogRouteHandlers(),
87
86
  ...createAdminRouteHandlers(),
88
- ...Object.fromEntries(INSIGHTS_ROUTES.map(({ handler }) => [handler, insightsDisabled])),
89
- appendBundleEvent: createDroppedEventHandler(),
90
87
  ...downloadStorageObject === void 0 ? {} : { downloadStorageObject: createDownloadStorageRouteHandler(downloadStorageObject) }
91
88
  };
92
89
  const routes = [];
@@ -103,13 +100,6 @@ function createHotUpdaterHandlers({ api, clientPolicy, downloadStorageObject, en
103
100
  access: admin ? "admin" : PUBLIC_CLIENT_ROUTES.has(handler) ? "public" : "client"
104
101
  });
105
102
  };
106
- /** The Insights routes no plugin endpoint serves, which answer that Insights is off. */
107
- const mountInsights = (access, add) => {
108
- for (const route of INSIGHTS_ROUTES) {
109
- const served = endpoints.some((endpoint) => endpoint.access === route.access && endpoint.method === route.method && endpoint.path === route.path);
110
- if (route.access === access && !served) add(route.method, route.path, route.handler);
111
- }
112
- };
113
103
  const clientRouter = createRouter();
114
104
  const addClientRoute = mount(clientRouter, false);
115
105
  addClientRoute("GET", "/version", "version");
@@ -117,12 +107,10 @@ function createHotUpdaterHandlers({ api, clientPolicy, downloadStorageObject, en
117
107
  addClientRoute("GET", "/release-catalogs/app-version/:platform/:channelKey/:appVersion", "appVersionReleaseCatalog");
118
108
  addClientRoute("GET", "/release-catalogs/fingerprint/:platform/:channelKey/:fingerprintHash", "fingerprintReleaseCatalog");
119
109
  addClientRoute("GET", "/artifacts/v1/:targetBundleId/from/:currentBundleId", "artifactV1");
120
- mountInsights("client", addClientRoute);
121
110
  const adminRouter = createRouter();
122
111
  const addAdminRoute = mount(adminRouter, true);
123
112
  addAdminRoute("GET", "/version", "adminVersion");
124
113
  for (const route of ADMIN_ROUTES) addAdminRoute(route.method, route.path, route.handler);
125
- mountInsights("admin", addAdminRoute);
126
114
  for (const endpoint of endpoints) {
127
115
  const name = `plugin ${endpoint.plugin}: ${endpoint.method} ${endpoint.path}`;
128
116
  routeHandlers[name] = (params, request) => endpoint.handler(request, params);
@@ -5,20 +5,39 @@ const CATALOG_CONTENT_TYPE = "application/vnd.hot-updater.release-catalog+json;
5
5
  const ARTIFACT_CONTENT_TYPE = "application/vnd.hot-updater.artifact+json; version=1";
6
6
  const ORIGIN_CACHE_TTL_MS = 5e3;
7
7
  const ORIGIN_CACHE_MAX_ENTRIES = 128;
8
+ /** Marks the 404 of a scope that has no catalog. */
9
+ const NO_CATALOG_HEADER = "x-hot-updater-catalog";
10
+ /** A shared cache keeps a catalog, or a scope's lack of one, five seconds. */
11
+ const CATALOG_CACHE_CONTROL = "public, max-age=0, s-maxage=5";
8
12
  const privateNotFound = () => Response.json({ error: "Not found" }, {
9
13
  status: 404,
10
14
  headers: { "cache-control": "private, no-store" }
11
15
  });
16
+ /**
17
+ * A scope with no catalog yet, such as a store version before its first
18
+ * OTA release: cached like a catalog, so its update checks don't all reach
19
+ * the origin, and it holds nothing an API key protects. The header tells it
20
+ * apart from a 404 for a wrong URL: clients read it as "no update", and
21
+ * doctor as a live catalog route.
22
+ */
23
+ const missingCatalog = () => Response.json({ error: "Not found" }, {
24
+ status: 404,
25
+ headers: {
26
+ "cache-control": CATALOG_CACHE_CONTROL,
27
+ vary: "Accept-Encoding",
28
+ [NO_CATALOG_HEADER]: "none"
29
+ }
30
+ });
12
31
  const responseHash = async (body) => {
13
32
  const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(body));
14
33
  return [...new Uint8Array(digest)].map((byte) => byte.toString(16).padStart(2, "0")).join("");
15
34
  };
16
35
  const catalogResponse = async (catalog, request) => {
17
- if (catalog === null) return privateNotFound();
36
+ if (catalog === null) return missingCatalog();
18
37
  const body = JSON.stringify(catalog);
19
38
  const etag = `"sha256:${await responseHash(body)}"`;
20
39
  const headers = {
21
- "cache-control": "public, max-age=0, s-maxage=5",
40
+ "cache-control": CATALOG_CACHE_CONTROL,
22
41
  "content-type": CATALOG_CONTENT_TYPE,
23
42
  etag,
24
43
  vary: "Accept-Encoding"
@@ -5,20 +5,39 @@ const CATALOG_CONTENT_TYPE = "application/vnd.hot-updater.release-catalog+json;
5
5
  const ARTIFACT_CONTENT_TYPE = "application/vnd.hot-updater.artifact+json; version=1";
6
6
  const ORIGIN_CACHE_TTL_MS = 5e3;
7
7
  const ORIGIN_CACHE_MAX_ENTRIES = 128;
8
+ /** Marks the 404 of a scope that has no catalog. */
9
+ const NO_CATALOG_HEADER = "x-hot-updater-catalog";
10
+ /** A shared cache keeps a catalog, or a scope's lack of one, five seconds. */
11
+ const CATALOG_CACHE_CONTROL = "public, max-age=0, s-maxage=5";
8
12
  const privateNotFound = () => Response.json({ error: "Not found" }, {
9
13
  status: 404,
10
14
  headers: { "cache-control": "private, no-store" }
11
15
  });
16
+ /**
17
+ * A scope with no catalog yet, such as a store version before its first
18
+ * OTA release: cached like a catalog, so its update checks don't all reach
19
+ * the origin, and it holds nothing an API key protects. The header tells it
20
+ * apart from a 404 for a wrong URL: clients read it as "no update", and
21
+ * doctor as a live catalog route.
22
+ */
23
+ const missingCatalog = () => Response.json({ error: "Not found" }, {
24
+ status: 404,
25
+ headers: {
26
+ "cache-control": CATALOG_CACHE_CONTROL,
27
+ vary: "Accept-Encoding",
28
+ [NO_CATALOG_HEADER]: "none"
29
+ }
30
+ });
12
31
  const responseHash = async (body) => {
13
32
  const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(body));
14
33
  return [...new Uint8Array(digest)].map((byte) => byte.toString(16).padStart(2, "0")).join("");
15
34
  };
16
35
  const catalogResponse = async (catalog, request) => {
17
- if (catalog === null) return privateNotFound();
36
+ if (catalog === null) return missingCatalog();
18
37
  const body = JSON.stringify(catalog);
19
38
  const etag = `"sha256:${await responseHash(body)}"`;
20
39
  const headers = {
21
- "cache-control": "public, max-age=0, s-maxage=5",
40
+ "cache-control": CATALOG_CACHE_CONTROL,
22
41
  "content-type": CATALOG_CONTENT_TYPE,
23
42
  etag,
24
43
  vary: "Accept-Encoding"
package/dist/index.cjs CHANGED
@@ -1,13 +1,9 @@
1
1
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
- const require_provider = require("./insights/provider.cjs");
3
- const require_apiKeys = require("./apiKeys.cjs");
4
- const require_assemblePlugins = require("./assembly/assemblePlugins.cjs");
2
+ const require_configError = require("./assembly/configError.cjs");
5
3
  const require_version = require("./version.cjs");
6
4
  const require_handlerVersionRoutes = require("./handlerVersionRoutes.cjs");
7
5
  const require_createHotUpdaterCore = require("./createHotUpdaterCore.cjs");
8
- exports.API_KEY_HEADER_NAME = require_apiKeys.API_KEY_HEADER_NAME;
9
6
  exports.HOT_UPDATER_INFRASTRUCTURE_GENERATION = require_handlerVersionRoutes.HOT_UPDATER_INFRASTRUCTURE_GENERATION;
10
7
  exports.HOT_UPDATER_SERVER_VERSION = require_version.HOT_UPDATER_SERVER_VERSION;
11
- exports.HotUpdaterConfigError = require_assemblePlugins.HotUpdaterConfigError;
8
+ exports.HotUpdaterConfigError = require_configError.HotUpdaterConfigError;
12
9
  exports.createHotUpdater = require_createHotUpdaterCore.createHotUpdater;
13
- exports.createInsightsProvider = require_provider.createInsightsProvider;
package/dist/index.d.cts CHANGED
@@ -1,12 +1,9 @@
1
1
  import { HOT_UPDATER_SERVER_VERSION } from "./version.cjs";
2
- import { HotUpdaterConfigError } from "./assembly/assemblePlugins.cjs";
2
+ import { HotUpdaterConfigError } from "./assembly/configError.cjs";
3
+ import "./assembly/assemblePlugins.cjs";
3
4
  import { HotUpdaterHandler, HotUpdaterHandlers } from "./handlerTypes.cjs";
4
5
  import "./handler.cjs";
5
- import { ActiveInstallationWindow, CreateBundleEventRequest, CreateBundleEventRequestBase, CursorPage, EventCursorPage, EventHistoryRow, InsightsBundleSelection, InsightsCountMeasurement, InsightsScope, InstallationHistoryRow, InstallationRow, ReportingOverview } from "./insights/domain.cjs";
6
- import { InsightsEventPageInput, InsightsInstallationEventPageInput, InsightsProvider, InsightsUserInstallationPageInput } from "./insights/types.cjs";
7
- import { createInsightsProvider } from "./insights/provider.cjs";
8
- import { API_KEY_HEADER_NAME, ApiKeyManagementAPI, ApiKeyMetadata, CreatedApiKey } from "./apiKeys.cjs";
9
- import { ClientAccessPolicy, ClientAccessRule, CreateHotUpdaterOptions, HotUpdaterAPI, RemovedClientAccess, RuntimeHotUpdaterAPI, createHotUpdater } from "./createHotUpdaterCore.cjs";
6
+ import { ClientAccessPolicy, ClientAccessRule, CreateHotUpdaterOptions, HotUpdaterAPI, RuntimeHotUpdaterAPI, createHotUpdater } from "./createHotUpdaterCore.cjs";
10
7
  import { Bundle } from "./types/index.cjs";
11
8
  import { HOT_UPDATER_INFRASTRUCTURE_GENERATION } from "./handlerVersionRoutes.cjs";
12
- export { API_KEY_HEADER_NAME, type ActiveInstallationWindow, type ApiKeyManagementAPI, type ApiKeyMetadata, type Bundle, type ClientAccessPolicy, type ClientAccessRule, type CreateBundleEventRequest, type CreateBundleEventRequestBase, type CreateHotUpdaterOptions, type CreatedApiKey, type CursorPage, type EventCursorPage, type EventHistoryRow, HOT_UPDATER_INFRASTRUCTURE_GENERATION, HOT_UPDATER_SERVER_VERSION, type HotUpdaterAPI, HotUpdaterConfigError, type HotUpdaterHandler, type HotUpdaterHandlers, type InsightsBundleSelection, type InsightsCountMeasurement, type InsightsEventPageInput, type InsightsInstallationEventPageInput, type InsightsProvider, type InsightsScope, type InsightsUserInstallationPageInput, type InstallationHistoryRow, type InstallationRow, type RemovedClientAccess, type ReportingOverview, type RuntimeHotUpdaterAPI, createHotUpdater, createInsightsProvider };
9
+ export { type Bundle, type ClientAccessPolicy, type ClientAccessRule, type CreateHotUpdaterOptions, HOT_UPDATER_INFRASTRUCTURE_GENERATION, HOT_UPDATER_SERVER_VERSION, type HotUpdaterAPI, HotUpdaterConfigError, type HotUpdaterHandler, type HotUpdaterHandlers, type RuntimeHotUpdaterAPI, createHotUpdater };
package/dist/index.d.mts CHANGED
@@ -1,12 +1,9 @@
1
1
  import { HOT_UPDATER_SERVER_VERSION } from "./version.mjs";
2
- import { HotUpdaterConfigError } from "./assembly/assemblePlugins.mjs";
2
+ import { HotUpdaterConfigError } from "./assembly/configError.mjs";
3
+ import "./assembly/assemblePlugins.mjs";
3
4
  import { HotUpdaterHandler, HotUpdaterHandlers } from "./handlerTypes.mjs";
4
5
  import "./handler.mjs";
5
- import { ActiveInstallationWindow, CreateBundleEventRequest, CreateBundleEventRequestBase, CursorPage, EventCursorPage, EventHistoryRow, InsightsBundleSelection, InsightsCountMeasurement, InsightsScope, InstallationHistoryRow, InstallationRow, ReportingOverview } from "./insights/domain.mjs";
6
- import { InsightsEventPageInput, InsightsInstallationEventPageInput, InsightsProvider, InsightsUserInstallationPageInput } from "./insights/types.mjs";
7
- import { createInsightsProvider } from "./insights/provider.mjs";
8
- import { API_KEY_HEADER_NAME, ApiKeyManagementAPI, ApiKeyMetadata, CreatedApiKey } from "./apiKeys.mjs";
9
- import { ClientAccessPolicy, ClientAccessRule, CreateHotUpdaterOptions, HotUpdaterAPI, RemovedClientAccess, RuntimeHotUpdaterAPI, createHotUpdater } from "./createHotUpdaterCore.mjs";
6
+ import { ClientAccessPolicy, ClientAccessRule, CreateHotUpdaterOptions, HotUpdaterAPI, RuntimeHotUpdaterAPI, createHotUpdater } from "./createHotUpdaterCore.mjs";
10
7
  import { Bundle } from "./types/index.mjs";
11
8
  import { HOT_UPDATER_INFRASTRUCTURE_GENERATION } from "./handlerVersionRoutes.mjs";
12
- export { API_KEY_HEADER_NAME, type ActiveInstallationWindow, type ApiKeyManagementAPI, type ApiKeyMetadata, type Bundle, type ClientAccessPolicy, type ClientAccessRule, type CreateBundleEventRequest, type CreateBundleEventRequestBase, type CreateHotUpdaterOptions, type CreatedApiKey, type CursorPage, type EventCursorPage, type EventHistoryRow, HOT_UPDATER_INFRASTRUCTURE_GENERATION, HOT_UPDATER_SERVER_VERSION, type HotUpdaterAPI, HotUpdaterConfigError, type HotUpdaterHandler, type HotUpdaterHandlers, type InsightsBundleSelection, type InsightsCountMeasurement, type InsightsEventPageInput, type InsightsInstallationEventPageInput, type InsightsProvider, type InsightsScope, type InsightsUserInstallationPageInput, type InstallationHistoryRow, type InstallationRow, type RemovedClientAccess, type ReportingOverview, type RuntimeHotUpdaterAPI, createHotUpdater, createInsightsProvider };
9
+ export { type Bundle, type ClientAccessPolicy, type ClientAccessRule, type CreateHotUpdaterOptions, HOT_UPDATER_INFRASTRUCTURE_GENERATION, HOT_UPDATER_SERVER_VERSION, type HotUpdaterAPI, HotUpdaterConfigError, type HotUpdaterHandler, type HotUpdaterHandlers, type RuntimeHotUpdaterAPI, createHotUpdater };
package/dist/index.mjs CHANGED
@@ -1,7 +1,5 @@
1
- import { createInsightsProvider } from "./insights/provider.mjs";
2
- import { API_KEY_HEADER_NAME } from "./apiKeys.mjs";
3
- import { HotUpdaterConfigError } from "./assembly/assemblePlugins.mjs";
1
+ import { HotUpdaterConfigError } from "./assembly/configError.mjs";
4
2
  import { HOT_UPDATER_SERVER_VERSION } from "./version.mjs";
5
3
  import { HOT_UPDATER_INFRASTRUCTURE_GENERATION } from "./handlerVersionRoutes.mjs";
6
4
  import { createHotUpdater } from "./createHotUpdaterCore.mjs";
7
- export { API_KEY_HEADER_NAME, HOT_UPDATER_INFRASTRUCTURE_GENERATION, HOT_UPDATER_SERVER_VERSION, HotUpdaterConfigError, createHotUpdater, createInsightsProvider };
5
+ export { HOT_UPDATER_INFRASTRUCTURE_GENERATION, HOT_UPDATER_SERVER_VERSION, HotUpdaterConfigError, createHotUpdater };
package/dist/package.cjs CHANGED
@@ -1,5 +1,5 @@
1
1
  //#region package.json
2
- var version = "1.0.0-rc.16";
2
+ var version = "1.0.0-rc.18";
3
3
  //#endregion
4
4
  Object.defineProperty(exports, "version", {
5
5
  enumerable: true,
package/dist/package.mjs CHANGED
@@ -1,4 +1,4 @@
1
1
  //#region package.json
2
- var version = "1.0.0-rc.16";
2
+ var version = "1.0.0-rc.18";
3
3
  //#endregion
4
4
  export { version };
@@ -1,4 +1,4 @@
1
- //#region src/apiKeys.ts
1
+ //#region src/plugins/api-keys/apiKeys.ts
2
2
  const API_KEY_HEADER_NAME = "x-api-key";
3
3
  const BASE64URL_32_PATTERN = /^[A-Za-z0-9_-]{43}$/u;
4
4
  const bytesToBase64Url = (bytes) => {
@@ -1,5 +1,5 @@
1
- import { ApiKeyModel, ApiKeyRow } from "@hot-updater/plugin-core";
2
- //#region src/apiKeys.d.ts
1
+ import { ApiKeyRow } from "./model.cjs";
2
+ //#region src/plugins/api-keys/apiKeys.d.ts
3
3
  declare const API_KEY_HEADER_NAME = "x-api-key";
4
4
  type ApiKeyMetadata = Omit<ApiKeyRow, "hash">;
5
5
  interface CreatedApiKey {
@@ -1,5 +1,5 @@
1
- import { ApiKeyModel, ApiKeyRow } from "@hot-updater/plugin-core";
2
- //#region src/apiKeys.d.ts
1
+ import { ApiKeyRow } from "./model.mjs";
2
+ //#region src/plugins/api-keys/apiKeys.d.ts
3
3
  declare const API_KEY_HEADER_NAME = "x-api-key";
4
4
  type ApiKeyMetadata = Omit<ApiKeyRow, "hash">;
5
5
  interface CreatedApiKey {
@@ -1,4 +1,4 @@
1
- //#region src/apiKeys.ts
1
+ //#region src/plugins/api-keys/apiKeys.ts
2
2
  const API_KEY_HEADER_NAME = "x-api-key";
3
3
  const BASE64URL_32_PATTERN = /^[A-Za-z0-9_-]{43}$/u;
4
4
  const bytesToBase64Url = (bytes) => {
@@ -0,0 +1,115 @@
1
+ //#region src/plugins/api-keys/cli.ts
2
+ /** The environment variable init stores the app's API key in. */
3
+ const API_KEY_ENV = "HOT_UPDATER_API_KEY";
4
+ /** A new API key: 32 random bytes, base64url, as the plugin creates them. */
5
+ const generateApiKey = () => {
6
+ const bytes = crypto.getRandomValues(/* @__PURE__ */ new Uint8Array(32));
7
+ return btoa(String.fromCharCode(...bytes)).replaceAll("+", "-").replaceAll("/", "_").replace(/=+$/u, "");
8
+ };
9
+ const formatList = (ui, records) => records.length === 0 ? ui.muted("(no API keys)") : ui.table([
10
+ {
11
+ key: "id",
12
+ label: "ID",
13
+ format: ui.id
14
+ },
15
+ {
16
+ key: "name",
17
+ label: "Name"
18
+ },
19
+ {
20
+ key: "prefix",
21
+ label: "Prefix",
22
+ format: ui.muted
23
+ },
24
+ {
25
+ key: "status",
26
+ label: "Status",
27
+ format: (value) => value.trim() === "active" ? ui.success(value) : ui.danger(value)
28
+ },
29
+ {
30
+ key: "created",
31
+ label: "Created",
32
+ format: ui.muted
33
+ }
34
+ ], records.map((record) => ({
35
+ created: new Date(record.created_at_ms).toISOString(),
36
+ id: record.id,
37
+ name: record.name,
38
+ prefix: record.prefix,
39
+ status: record.revoked_at_ms === null ? "active" : "revoked"
40
+ })));
41
+ /**
42
+ * `hot-updater api-key create|list|revoke`, and the API key that init
43
+ * provisions for an app, sent in `headerName`.
44
+ */
45
+ const apiKeysCli = (headerName) => ({
46
+ commands: [{
47
+ name: "api-key",
48
+ description: "Manage API keys",
49
+ commands: [
50
+ {
51
+ name: "create",
52
+ description: "Create an API key",
53
+ options: [{
54
+ flags: "--name <name>",
55
+ description: "name used to identify the API key",
56
+ required: true
57
+ }],
58
+ async run({ api, options, ui }) {
59
+ const created = await api.create({ name: String(options.name) });
60
+ ui.message(ui.block("API key created", [
61
+ ui.kv("Name", created.record.name),
62
+ ui.kv("ID", ui.id(created.record.id)),
63
+ ui.kv("API key", ui.warning(created.apiKey))
64
+ ]));
65
+ ui.warn("Save this API key now. It will not be shown again.");
66
+ }
67
+ },
68
+ {
69
+ name: "list",
70
+ description: "List API keys",
71
+ options: [{
72
+ flags: "--json",
73
+ description: "output API key metadata as JSON"
74
+ }],
75
+ async run({ api, options, ui }) {
76
+ const records = [...await api.list()].sort((left, right) => right.created_at_ms - left.created_at_ms);
77
+ if (options.json) ui.print(JSON.stringify(records, null, 2));
78
+ else ui.message(formatList(ui, records));
79
+ }
80
+ },
81
+ {
82
+ name: "revoke",
83
+ description: "Revoke an API key",
84
+ arguments: [{
85
+ name: "id",
86
+ description: "API key id"
87
+ }],
88
+ options: [{
89
+ flags: "-y, --yes",
90
+ description: "skip confirmation prompt"
91
+ }],
92
+ async run({ api, args, options, ui }) {
93
+ const id = String(args.id);
94
+ if (!options.yes) await ui.confirm(`Revoke API key ${id}?`);
95
+ const revoked = await api.revoke({ id });
96
+ if (revoked === null) throw new Error(`API key "${id}" was not found.`);
97
+ ui.message(ui.block("API key revoked", [ui.kv("Name", revoked.name), ui.kv("ID", ui.id(revoked.id))]));
98
+ }
99
+ }
100
+ ]
101
+ }],
102
+ clientCredential: {
103
+ label: "API key",
104
+ header: headerName,
105
+ env: API_KEY_ENV,
106
+ generate: generateApiKey,
107
+ provision: async (api, { existing, name }) => (await api.provision({
108
+ ...existing === void 0 ? {} : { existingApiKey: existing },
109
+ name
110
+ })).apiKey
111
+ }
112
+ });
113
+ //#endregion
114
+ exports.API_KEY_ENV = API_KEY_ENV;
115
+ exports.apiKeysCli = apiKeysCli;
@@ -0,0 +1,114 @@
1
+ //#region src/plugins/api-keys/cli.ts
2
+ /** The environment variable init stores the app's API key in. */
3
+ const API_KEY_ENV = "HOT_UPDATER_API_KEY";
4
+ /** A new API key: 32 random bytes, base64url, as the plugin creates them. */
5
+ const generateApiKey = () => {
6
+ const bytes = crypto.getRandomValues(/* @__PURE__ */ new Uint8Array(32));
7
+ return btoa(String.fromCharCode(...bytes)).replaceAll("+", "-").replaceAll("/", "_").replace(/=+$/u, "");
8
+ };
9
+ const formatList = (ui, records) => records.length === 0 ? ui.muted("(no API keys)") : ui.table([
10
+ {
11
+ key: "id",
12
+ label: "ID",
13
+ format: ui.id
14
+ },
15
+ {
16
+ key: "name",
17
+ label: "Name"
18
+ },
19
+ {
20
+ key: "prefix",
21
+ label: "Prefix",
22
+ format: ui.muted
23
+ },
24
+ {
25
+ key: "status",
26
+ label: "Status",
27
+ format: (value) => value.trim() === "active" ? ui.success(value) : ui.danger(value)
28
+ },
29
+ {
30
+ key: "created",
31
+ label: "Created",
32
+ format: ui.muted
33
+ }
34
+ ], records.map((record) => ({
35
+ created: new Date(record.created_at_ms).toISOString(),
36
+ id: record.id,
37
+ name: record.name,
38
+ prefix: record.prefix,
39
+ status: record.revoked_at_ms === null ? "active" : "revoked"
40
+ })));
41
+ /**
42
+ * `hot-updater api-key create|list|revoke`, and the API key that init
43
+ * provisions for an app, sent in `headerName`.
44
+ */
45
+ const apiKeysCli = (headerName) => ({
46
+ commands: [{
47
+ name: "api-key",
48
+ description: "Manage API keys",
49
+ commands: [
50
+ {
51
+ name: "create",
52
+ description: "Create an API key",
53
+ options: [{
54
+ flags: "--name <name>",
55
+ description: "name used to identify the API key",
56
+ required: true
57
+ }],
58
+ async run({ api, options, ui }) {
59
+ const created = await api.create({ name: String(options.name) });
60
+ ui.message(ui.block("API key created", [
61
+ ui.kv("Name", created.record.name),
62
+ ui.kv("ID", ui.id(created.record.id)),
63
+ ui.kv("API key", ui.warning(created.apiKey))
64
+ ]));
65
+ ui.warn("Save this API key now. It will not be shown again.");
66
+ }
67
+ },
68
+ {
69
+ name: "list",
70
+ description: "List API keys",
71
+ options: [{
72
+ flags: "--json",
73
+ description: "output API key metadata as JSON"
74
+ }],
75
+ async run({ api, options, ui }) {
76
+ const records = [...await api.list()].sort((left, right) => right.created_at_ms - left.created_at_ms);
77
+ if (options.json) ui.print(JSON.stringify(records, null, 2));
78
+ else ui.message(formatList(ui, records));
79
+ }
80
+ },
81
+ {
82
+ name: "revoke",
83
+ description: "Revoke an API key",
84
+ arguments: [{
85
+ name: "id",
86
+ description: "API key id"
87
+ }],
88
+ options: [{
89
+ flags: "-y, --yes",
90
+ description: "skip confirmation prompt"
91
+ }],
92
+ async run({ api, args, options, ui }) {
93
+ const id = String(args.id);
94
+ if (!options.yes) await ui.confirm(`Revoke API key ${id}?`);
95
+ const revoked = await api.revoke({ id });
96
+ if (revoked === null) throw new Error(`API key "${id}" was not found.`);
97
+ ui.message(ui.block("API key revoked", [ui.kv("Name", revoked.name), ui.kv("ID", ui.id(revoked.id))]));
98
+ }
99
+ }
100
+ ]
101
+ }],
102
+ clientCredential: {
103
+ label: "API key",
104
+ header: headerName,
105
+ env: API_KEY_ENV,
106
+ generate: generateApiKey,
107
+ provision: async (api, { existing, name }) => (await api.provision({
108
+ ...existing === void 0 ? {} : { existingApiKey: existing },
109
+ name
110
+ })).apiKey
111
+ }
112
+ });
113
+ //#endregion
114
+ export { API_KEY_ENV, apiKeysCli };
@@ -1,18 +1,19 @@
1
1
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
- const require_apiKeys = require("../../apiKeys.cjs");
3
- const require_builtIn = require("../builtIn.cjs");
4
2
  const require_definePlugin = require("../definePlugin.cjs");
3
+ const require_apiKeys = require("./apiKeys.cjs");
4
+ const require_cli = require("./cli.cjs");
5
5
  const require_model = require("./model.cjs");
6
6
  const require_schema = require("./schema.cjs");
7
7
  //#region src/plugins/api-keys/index.ts
8
8
  /**
9
- * Built-in API keys: protects client routes with keys whose SHA-256 digests
9
+ * API keys: protects client routes with keys whose SHA-256 digests
10
10
  * are stored, and manages them in-process.
11
11
  */
12
12
  const apiKeys = (options = {}) => {
13
13
  const headerName = require_apiKeys.normalizeApiKeyHeaderName(options.headerName ?? "x-api-key");
14
- return require_builtIn.markBuiltIn(require_definePlugin.definePlugin({
14
+ return require_definePlugin.definePlugin({
15
15
  id: "apiKeys",
16
+ namespace: false,
16
17
  provides: { clientAuth: true },
17
18
  schemaVersion: "1.0.0",
18
19
  schema: require_schema.apiKeysSchema,
@@ -41,10 +42,12 @@ const apiKeys = (options = {}) => {
41
42
  })
42
43
  }
43
44
  };
44
- }
45
- }));
45
+ },
46
+ cli: require_cli.apiKeysCli(headerName)
47
+ });
46
48
  };
47
49
  //#endregion
50
+ exports.API_KEY_HEADER_NAME = require_apiKeys.API_KEY_HEADER_NAME;
48
51
  exports.apiKeys = apiKeys;
49
52
  exports.apiKeysSchema = require_schema.apiKeysSchema;
50
53
  exports.createApiKeyModel = require_model.createApiKeyModel;
@@ -1,17 +1,16 @@
1
1
  import { TableDefinition } from "../../database/schema.cjs";
2
2
  import { HotUpdaterPlugin } from "../definePlugin.cjs";
3
- import { ApiKeyMetadata, CreatedApiKey } from "../../apiKeys.cjs";
4
- import "../../index.cjs";
5
3
  import "../index.cjs";
6
4
  import { ApiKeysSchema, apiKeysSchema } from "./schema.cjs";
7
- import { createApiKeyModel } from "./model.cjs";
5
+ import { ApiKeyModel, ApiKeyRow, createApiKeyModel } from "./model.cjs";
6
+ import { API_KEY_HEADER_NAME, ApiKeyManagementAPI, ApiKeyMetadata, CreatedApiKey } from "./apiKeys.cjs";
8
7
  //#region src/plugins/api-keys/index.d.ts
9
8
  interface ApiKeysOptions {
10
9
  /** The request header that carries the key; defaults to `x-api-key`. */
11
10
  readonly headerName?: string;
12
11
  }
13
12
  /**
14
- * Built-in API keys: protects client routes with keys whose SHA-256 digests
13
+ * API keys: protects client routes with keys whose SHA-256 digests
15
14
  * are stored, and manages them in-process.
16
15
  */
17
16
  declare const apiKeys: (options?: ApiKeysOptions) => HotUpdaterPlugin<"apiKeys", {
@@ -82,4 +81,4 @@ declare const apiKeys: (options?: ApiKeysOptions) => HotUpdaterPlugin<"apiKeys",
82
81
  readonly clientAuth: true;
83
82
  }>;
84
83
  //#endregion
85
- export { ApiKeysOptions, type ApiKeysSchema, apiKeys, apiKeysSchema, createApiKeyModel };
84
+ export { API_KEY_HEADER_NAME, type ApiKeyManagementAPI, type ApiKeyMetadata, type ApiKeyModel, type ApiKeyRow, ApiKeysOptions, type ApiKeysSchema, type CreatedApiKey, apiKeys, apiKeysSchema, createApiKeyModel };
@@ -1,17 +1,16 @@
1
1
  import { TableDefinition } from "../../database/schema.mjs";
2
2
  import { HotUpdaterPlugin } from "../definePlugin.mjs";
3
- import { ApiKeyMetadata, CreatedApiKey } from "../../apiKeys.mjs";
4
- import "../../index.mjs";
5
3
  import "../index.mjs";
6
4
  import { ApiKeysSchema, apiKeysSchema } from "./schema.mjs";
7
- import { createApiKeyModel } from "./model.mjs";
5
+ import { ApiKeyModel, ApiKeyRow, createApiKeyModel } from "./model.mjs";
6
+ import { API_KEY_HEADER_NAME, ApiKeyManagementAPI, ApiKeyMetadata, CreatedApiKey } from "./apiKeys.mjs";
8
7
  //#region src/plugins/api-keys/index.d.ts
9
8
  interface ApiKeysOptions {
10
9
  /** The request header that carries the key; defaults to `x-api-key`. */
11
10
  readonly headerName?: string;
12
11
  }
13
12
  /**
14
- * Built-in API keys: protects client routes with keys whose SHA-256 digests
13
+ * API keys: protects client routes with keys whose SHA-256 digests
15
14
  * are stored, and manages them in-process.
16
15
  */
17
16
  declare const apiKeys: (options?: ApiKeysOptions) => HotUpdaterPlugin<"apiKeys", {
@@ -82,4 +81,4 @@ declare const apiKeys: (options?: ApiKeysOptions) => HotUpdaterPlugin<"apiKeys",
82
81
  readonly clientAuth: true;
83
82
  }>;
84
83
  //#endregion
85
- export { ApiKeysOptions, type ApiKeysSchema, apiKeys, apiKeysSchema, createApiKeyModel };
84
+ export { API_KEY_HEADER_NAME, type ApiKeyManagementAPI, type ApiKeyMetadata, type ApiKeyModel, type ApiKeyRow, ApiKeysOptions, type ApiKeysSchema, type CreatedApiKey, apiKeys, apiKeysSchema, createApiKeyModel };