@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
@@ -0,0 +1,152 @@
1
+ import { describe, expect, it } from "vitest";
2
+
3
+ import { expectInsightsIndex } from "./expectInsightsIndex";
4
+ import type { HttpTestClient } from "./types";
5
+
6
+ const jsonRequest = (method: string, body: unknown) => ({
7
+ method,
8
+ headers: { "content-type": "application/json" },
9
+ body: JSON.stringify(body),
10
+ });
11
+
12
+ type InstallationPage = {
13
+ readonly data: readonly {
14
+ readonly installId: string;
15
+ readonly lastKnownBundleId: string;
16
+ readonly latestStatus: string;
17
+ }[];
18
+ };
19
+
20
+ /**
21
+ * The Insights plugin's routes on a database: a client reports an event, and
22
+ * the admin routes read it back. The server must run `insights()`.
23
+ */
24
+ export const setupInsightsHttpTestSuite = (options: {
25
+ readonly getClient: () => HttpTestClient;
26
+ }): void => {
27
+ describe("Insights HTTP routes", () => {
28
+ it("records a reported event and reads it back", async () => {
29
+ const client = options.getClient();
30
+ const installId = `install-${crypto.randomUUID()}`;
31
+ const userId = `user-${crypto.randomUUID()}`;
32
+ const channel = `insights-${crypto.randomUUID()}`;
33
+ const event = {
34
+ appVersion: "1.0.0",
35
+ channel,
36
+ cohort: "default",
37
+ fingerprintHash: null,
38
+ fromBundleId: null,
39
+ fromReleaseId: null,
40
+ installId,
41
+ platform: "ios",
42
+ toBundleId: "00000000-0000-7000-8000-000000000001",
43
+ toReleaseId: null,
44
+ type: "UNCHANGED",
45
+ updateStrategy: null,
46
+ userId,
47
+ sdkVersion: "2.0.0",
48
+ };
49
+
50
+ const reported = await client.client(
51
+ "/events",
52
+ jsonRequest("POST", event),
53
+ );
54
+ expect(reported.status).toBe(204);
55
+ await reported.text();
56
+
57
+ const installation = await client.admin(
58
+ `/installations/${encodeURIComponent(installId)}`,
59
+ );
60
+ expect(installation.status).toBe(200);
61
+ expect(await installation.json()).toMatchObject({
62
+ installId,
63
+ latestStatus: "UNCHANGED",
64
+ lastKnownBundleId: event.toBundleId,
65
+ channel,
66
+ });
67
+ await expectInsightsIndex(async () => {
68
+ const page = await client.admin(
69
+ `/installations?userId=${encodeURIComponent(userId)}`,
70
+ );
71
+ return ((await page.json()) as InstallationPage).data.map(
72
+ ({ installId: id }) => id,
73
+ );
74
+ }, [installId]);
75
+ await expectInsightsIndex(async () => {
76
+ const overview = await client.admin(
77
+ `/overview?platform=ios&channel=${encodeURIComponent(channel)}&window=24h`,
78
+ );
79
+ return (
80
+ (await overview.json()) as {
81
+ readonly reportingInstallations: { readonly count: number };
82
+ }
83
+ ).reportingInstallations.count;
84
+ }, 1);
85
+ });
86
+
87
+ it("records an update failure in installation history and the failures read", async () => {
88
+ const client = options.getClient();
89
+ const installId = `install-${crypto.randomUUID()}`;
90
+ const channel = `insights-${crypto.randomUUID()}`;
91
+ const releaseId = "00000000-0000-7000-8000-0000000000b2";
92
+ const reported = await client.client(
93
+ "/events",
94
+ jsonRequest("POST", {
95
+ appVersion: "1.0.0",
96
+ channel,
97
+ cohort: "default",
98
+ fingerprintHash: null,
99
+ fromBundleId: "00000000-0000-7000-8000-000000000001",
100
+ fromReleaseId: null,
101
+ installId,
102
+ platform: "ios",
103
+ toBundleId: "00000000-0000-7000-8000-000000000002",
104
+ toReleaseId: releaseId,
105
+ type: "UPDATE_FAILED",
106
+ updateStrategy: "appVersion",
107
+ metadata: {
108
+ failure: { stage: "download", reason: "http", httpStatus: 403 },
109
+ },
110
+ }),
111
+ );
112
+ expect(reported.status).toBe(204);
113
+ await reported.text();
114
+
115
+ await expectInsightsIndex(async () => {
116
+ const page = await client.admin(
117
+ `/installations/${encodeURIComponent(installId)}/events?limit=10`,
118
+ );
119
+ return (
120
+ (await page.json()) as {
121
+ readonly data: readonly { type: string; failure?: unknown }[];
122
+ }
123
+ ).data.map(({ type, failure }) => ({ type, failure }));
124
+ }, [
125
+ {
126
+ type: "UPDATE_FAILED",
127
+ failure: { stage: "download", reason: "http", httpStatus: 403 },
128
+ },
129
+ ]);
130
+ const now = Date.now();
131
+ await expectInsightsIndex(async () => {
132
+ const failures = await client.admin(
133
+ `/failures?platform=ios&channel=${encodeURIComponent(channel)}&releaseId=${releaseId}&start=${now - 86_400_000}&end=${now + 3_600_000}`,
134
+ );
135
+ const body = (await failures.json()) as {
136
+ readonly failedUpdates: number;
137
+ readonly failedInstallations: number;
138
+ };
139
+ return [body.failedUpdates, body.failedInstallations];
140
+ }, [1, 1]);
141
+ });
142
+
143
+ it("refuses a malformed event", async () => {
144
+ const response = await options
145
+ .getClient()
146
+ .client("/events", jsonRequest("POST", { type: "UNCHANGED" }));
147
+
148
+ expect(response.status).toBe(400);
149
+ await response.text();
150
+ });
151
+ });
152
+ };
@@ -0,0 +1,36 @@
1
+ import { afterAll, beforeAll, beforeEach, describe } from "vitest";
2
+
3
+ import type { InsightsModel } from "../modelTypes";
4
+ import { registerInsightsModelTests } from "./insightsModelTests";
5
+ import type { DatabaseTestLifecycle } from "./types";
6
+
7
+ /**
8
+ * The Insights report contract on one database: pass the Insights plugin's
9
+ * model over it, `createInsightsModel(createDatabasePluginApis(database,
10
+ * [insights()]).insights)`, as `createDatabase`.
11
+ */
12
+ export const setupInsightsModelTestSuite = (
13
+ lifecycle: DatabaseTestLifecycle<InsightsModel>,
14
+ ): void => {
15
+ describe(lifecycle.name, () => {
16
+ let model: InsightsModel | undefined;
17
+ const getDatabase = (): InsightsModel => {
18
+ if (model === undefined) {
19
+ throw new Error("The model is unavailable outside the test lifecycle");
20
+ }
21
+ return model;
22
+ };
23
+ beforeAll(async () => {
24
+ await lifecycle.migrate();
25
+ model = await lifecycle.createDatabase();
26
+ });
27
+ beforeEach(async () => {
28
+ await lifecycle.reset(getDatabase());
29
+ });
30
+ afterAll(async () => {
31
+ await lifecycle.dispose(getDatabase());
32
+ model = undefined;
33
+ });
34
+ registerInsightsModelTests({ getDatabase });
35
+ });
36
+ };
@@ -0,0 +1,30 @@
1
+ /**
2
+ * The shapes `@hot-updater/test-utils` passes a plugin's suite, restated
3
+ * here so the plugin's tests need no dependency on that package.
4
+ */
5
+ export type HttpTestRequest = (
6
+ path: string,
7
+ init?: NonNullable<ConstructorParameters<typeof Request>[1]>,
8
+ ) => Promise<Response>;
9
+
10
+ /** A running server's client and admin mounts. */
11
+ export interface HttpTestClient {
12
+ readonly client: HttpTestRequest;
13
+ readonly admin: HttpTestRequest;
14
+ }
15
+
16
+ export type DatabaseTestState<TDatabase> = {
17
+ readonly getDatabase: () => TDatabase;
18
+ };
19
+
20
+ type Awaitable<T> = Promise<T> | T;
21
+
22
+ /** How a suite gets a database, and gives it back. */
23
+ export type DatabaseTestLifecycle<TDatabase> = {
24
+ readonly name: string;
25
+ readonly migrate: () => Awaitable<void>;
26
+ readonly createDatabase: () => Awaitable<TDatabase>;
27
+ /** Empties every table between tests. */
28
+ readonly reset: (database: TDatabase) => Awaitable<void>;
29
+ readonly dispose: (database: TDatabase) => Awaitable<void>;
30
+ };
@@ -1,7 +1,6 @@
1
1
  import type {
2
2
  ReportingOverview,
3
3
  InsightsBundleSelection,
4
- InsightsScope,
5
4
  ActiveInstallationWindow,
6
5
  CreateBundleEventRequest,
7
6
  CursorPage,
@@ -10,6 +9,7 @@ import type {
10
9
  InstallationHistoryRow,
11
10
  InstallationRow,
12
11
  } from "./domain";
12
+ import type { InsightsScope } from "./modelTypes";
13
13
 
14
14
  export type InsightsEventPageInput = {
15
15
  readonly beforeReceivedAtMs?: number;
@@ -2,14 +2,14 @@ import type { ReadBudgetServer } from "@hot-updater/test-utils";
2
2
 
3
3
  import { createMeasuredDatabase } from "./assembly/databasePlugins";
4
4
  import { targetBaseCandidateKey } from "./core/baseCandidates";
5
- import { builtInSchema } from "./db/builtInDatabase";
5
+ import { toolingTargetOf } from "./db/coreDatabase";
6
6
  import { apiKeys } from "./plugins/api-keys";
7
7
  import { insights } from "./plugins/insights";
8
8
 
9
9
  /** The server parts `setupReadBudgetTestSuite` takes, for the server's own backends. */
10
10
  export const readBudgetServer = {
11
11
  createMeasuredDatabase,
12
- builtInSchema,
12
+ toolingTargetOf,
13
13
  plugins: [insights(), apiKeys()],
14
14
  targetBaseCandidateKey,
15
15
  } satisfies ReadBudgetServer;
@@ -121,6 +121,10 @@ describe("Release catalog routes", () => {
121
121
  ),
122
122
  );
123
123
  expect(otherChannel.status).toBe(404);
124
+ expect(otherChannel.headers.get("cache-control")).toBe(
125
+ "public, max-age=0, s-maxage=5",
126
+ );
127
+ expect(otherChannel.headers.get("x-hot-updater-catalog")).toBe("none");
124
128
  expect(catalogReads()).toBe(2);
125
129
 
126
130
  const legacyAuthorityPath = await hotUpdater.handlers.client(
@@ -133,6 +137,9 @@ describe("Release catalog routes", () => {
133
137
  expect(legacyAuthorityPath.headers.get("cache-control")).toBe(
134
138
  "private, no-store",
135
139
  );
140
+ expect(legacyAuthorityPath.headers.has("x-hot-updater-catalog")).toBe(
141
+ false,
142
+ );
136
143
  expect(catalogReads()).toBe(2);
137
144
  const write = vi.spyOn(database.adapter, "write");
138
145
  const restarted = createHotUpdater({
@@ -0,0 +1,73 @@
1
+ import { afterEach, describe, expect, it, vi } from "vitest";
2
+
3
+ import { createHotUpdater } from "./index";
4
+ import { definePlugin, defineTable } from "./plugins";
5
+ import { createRuntimeDatabase } from "./runtime.testFixtures";
6
+
7
+ const DAY = 86_400_000;
8
+ const HOUR = 3_600_000;
9
+
10
+ /** A plugin whose notes expire a day after their `at`. */
11
+ const notes = definePlugin({
12
+ id: "notes",
13
+ schemaVersion: "1",
14
+ schema: {
15
+ notes: defineTable(
16
+ {
17
+ id: { type: "string", maxLength: 36 },
18
+ at: { type: "integer" },
19
+ },
20
+ { key: ["id"], retention: { field: "at", days: 1 } },
21
+ ),
22
+ },
23
+ init: ({ db }) => ({
24
+ api: {
25
+ write: (id: string, at: number) =>
26
+ db.transaction(async (tx) => {
27
+ tx.create("notes", { id, at });
28
+ }),
29
+ read: (id: string) => db.findOne("notes", { id }),
30
+ },
31
+ }),
32
+ });
33
+
34
+ const createServer = (database = createRuntimeDatabase()) =>
35
+ createHotUpdater({ clientAccess: "public", database, plugins: [notes] });
36
+
37
+ describe("server retention", () => {
38
+ afterEach(() => {
39
+ vi.useRealTimers();
40
+ });
41
+
42
+ it("prunes before the write that takes the lease, which keeps what it writes", async () => {
43
+ vi.useFakeTimers({ toFake: ["Date"] });
44
+ const hotUpdater = createServer();
45
+ // A fresh database: the first write takes the lease with nothing to prune.
46
+ await hotUpdater.api.notes.write("old", Date.now() - 2 * DAY);
47
+ await expect(hotUpdater.api.notes.read("old")).resolves.not.toBeNull();
48
+
49
+ vi.setSystemTime(Date.now() + HOUR + 1);
50
+ await hotUpdater.api.notes.write("new", Date.now());
51
+ await expect(hotUpdater.api.notes.read("old")).resolves.toBeNull();
52
+ await expect(hotUpdater.api.notes.read("new")).resolves.not.toBeNull();
53
+ });
54
+
55
+ it("prunes during a write once the lease is due, on one server an hour", async () => {
56
+ vi.useFakeTimers({ toFake: ["Date"] });
57
+ const database = createRuntimeDatabase();
58
+ const [one, two] = [createServer(database), createServer(database)];
59
+
60
+ // The first write takes the lease, due in an hour; nothing has expired.
61
+ await one.api.notes.write("fresh", Date.now());
62
+ // Within the hour no write prunes: the other server reads the lease.
63
+ await two.api.notes.write("stale", Date.now() - 2 * DAY);
64
+ await one.api.notes.write("second", Date.now());
65
+ await expect(one.api.notes.read("stale")).resolves.not.toBeNull();
66
+
67
+ // Once it is due, the next write, on either server, takes it and prunes.
68
+ vi.setSystemTime(Date.now() + HOUR + 1);
69
+ await two.api.notes.write("third", Date.now());
70
+ await expect(one.api.notes.read("stale")).resolves.toBeNull();
71
+ await expect(one.api.notes.read("fresh")).resolves.not.toBeNull();
72
+ });
73
+ });
@@ -5,7 +5,7 @@ import {
5
5
  import { describe, expect, expectTypeOf, it, vi } from "vitest";
6
6
 
7
7
  import packageJson from "../package.json" with { type: "json" };
8
- import { builtInSettings } from "./db/builtInDatabase";
8
+ import { coreSettings } from "./db/coreDatabase";
9
9
  import { createHotUpdater, HotUpdaterConfigError } from "./index";
10
10
  import type {
11
11
  ClientAccessPolicy,
@@ -49,7 +49,7 @@ describe("runtime createHotUpdater", () => {
49
49
  CreateHotUpdaterOptions["clientAccess"]
50
50
  >().toEqualTypeOf<ClientAccessPolicy>();
51
51
  expectTypeOf<keyof RuntimeHotUpdaterAPI>().toEqualTypeOf<
52
- "adapterName" | "api" | "core" | "handlers"
52
+ "adapterName" | "api" | "core" | "flush" | "handlers"
53
53
  >();
54
54
  });
55
55
 
@@ -74,6 +74,7 @@ describe("runtime createHotUpdater", () => {
74
74
  "adapterName",
75
75
  "api",
76
76
  "core",
77
+ "flush",
77
78
  "handlers",
78
79
  ]);
79
80
  expect(hotUpdater).not.toHaveProperty("authorityId");
@@ -131,7 +132,7 @@ describe("runtime createHotUpdater", () => {
131
132
  it("serves a fenced database once its settings are written", async () => {
132
133
  const hotUpdater = createHotUpdater({
133
134
  clientAccess: "public",
134
- database: await createFencedDatabase("kysely", builtInSettings),
135
+ database: await createFencedDatabase("kysely", coreSettings),
135
136
  });
136
137
 
137
138
  await expect(hotUpdater.core.listChannels()).resolves.toEqual([]);
@@ -186,23 +187,21 @@ describe("runtime createHotUpdater", () => {
186
187
  );
187
188
  });
188
189
 
189
- it("rejects a clientAccess object, naming apiKeys() and insights()", () => {
190
+ it("rejects a clientAccess object, naming what replaced it", () => {
190
191
  const withObject = (clientAccess: unknown) => () =>
191
192
  createHotUpdater({
192
193
  clientAccess: clientAccess as ClientAccessPolicy,
193
194
  database: createRuntimeDatabase(),
194
195
  });
195
- const keepInsights =
196
- "To keep Insights, which the release candidates ran by default, add insights() from @hot-updater/server/plugins/insights to plugins.";
196
+ const removed =
197
+ 'clientAccess objects were removed in 1.0. Set clientAccess: "public", or add a plugin that provides clientAuth to plugins.';
197
198
 
198
199
  expect(withObject({ type: "api-key", headerName: "x-client-key" })).toThrow(
199
- 'clientAccess: { type: "api-key" } was removed in 1.0. Remove it and add apiKeys({ headerName: "x-client-key" }) from @hot-updater/server/plugins/api-keys to plugins',
200
+ removed,
200
201
  );
201
- expect(withObject({ type: "api-key" })).toThrow(keepInsights);
202
- expect(withObject({ type: "public" })).toThrow(
203
- 'clientAccess objects were removed in 1.0. Use clientAccess: "public", or add apiKeys()',
202
+ expect(withObject({ type: "public" })).toThrow(removed);
203
+ expect(withObject("private")).toThrow(
204
+ 'clientAccess must be "public"; to protect client routes, add a plugin that provides clientAuth to plugins.',
204
205
  );
205
- expect(withObject({ type: "public" })).toThrow(keepInsights);
206
- expect(withObject("private")).toThrow(HotUpdaterConfigError);
207
206
  });
208
207
  });
@@ -8,8 +8,10 @@ import { createStoragePlugin } from "@hot-updater/plugin-core";
8
8
  import { createMemoryAdapter } from "@hot-updater/plugin-core/internal";
9
9
 
10
10
  import type { SchemaSettings } from "./database/fence";
11
- import { builtInSchema, createEngineDatabase } from "./db/builtInDatabase";
11
+ import { createEngineDatabase, toolingTargetOf } from "./db/coreDatabase";
12
12
  import { migrateSchema } from "./db/schemaSettings";
13
+ import { apiKeys } from "./plugins/api-keys";
14
+ import { insights } from "./plugins/insights";
13
15
 
14
16
  export const runtimeBundle: Bundle = {
15
17
  id: "00000000-0000-0000-0000-000000000001",
@@ -39,6 +41,9 @@ export const createRuntimeDatabase = (
39
41
  adapter: createMemoryAdapter(),
40
42
  });
41
43
 
44
+ /** Every table the runtime specs use: core's, Insights', and API keys'. */
45
+ const runtimeTables = toolingTargetOf([insights(), apiKeys()]).schema.tables;
46
+
42
47
  /**
43
48
  * An in-memory database behind the schema fence, as a provider builds it:
44
49
  * its tables and `settings` rows written first, or none at all.
@@ -49,7 +54,7 @@ export const createFencedDatabase = async (
49
54
  ): Promise<EngineDatabase> => {
50
55
  const adapter = createMemoryAdapter();
51
56
  if (settings !== undefined) {
52
- await migrateSchema(adapter, name, builtInSchema.tables, settings);
57
+ await migrateSchema(adapter, name, runtimeTables, settings);
53
58
  }
54
59
  return createEngineDatabase({ name, adapter });
55
60
  };
@@ -106,6 +106,7 @@ it("rejects broken providers while the unmodified provider passes the public sui
106
106
  import { createMemoryAdapter } from "@hot-updater/server/database";
107
107
  import { createDatabasePluginApis } from "@hot-updater/server/db";
108
108
  import { createInsightsModel, insights } from "@hot-updater/server/plugins/insights";
109
+ import { insightsTestSuite } from "@hot-updater/server/plugins/insights/testing";
109
110
  import { setupDatabaseTestSuite, startHttpTestServer } from "@hot-updater/test-utils";
110
111
  // An empty memory adapter per test, behind one adapter a mutant may break.
111
112
  let original = createMemoryAdapter();
@@ -125,7 +126,7 @@ it("rejects broken providers while the unmodified provider passes the public sui
125
126
  migrate: () => undefined,
126
127
  reset: () => { original = createMemoryAdapter(); },
127
128
  dispose: () => undefined,
128
- createInsightsModel: database => insightsModel(database),
129
+ plugins: [insightsTestSuite({ createModel: database => insightsModel(database) })],
129
130
  createHttpClient: options => {
130
131
  const handlers = createHotUpdater({
131
132
  ...options, plugins: [insights()], clientAccess: "public",
@@ -87,6 +87,7 @@ it("runs the complete contract from the published test-utils package", async ()
87
87
  import { kyselyAdapter } from "@hot-updater/server/adapters/kysely";
88
88
  import { createDatabasePluginApis, createMigrator } from "@hot-updater/server/db";
89
89
  import { createInsightsModel, insights } from "@hot-updater/server/plugins/insights";
90
+ import { insightsTestSuite } from "@hot-updater/server/plugins/insights/testing";
90
91
  import { setupDatabaseTestSuite, startHttpTestServer } from "@hot-updater/test-utils";
91
92
 
92
93
  const db = new PGlite();
@@ -97,12 +98,15 @@ it("runs the complete contract from the published test-utils package", async ()
97
98
  createHttpClient: (options) => startHttpTestServer(createHotUpdater({
98
99
  ...options, plugins: [insights()], clientAccess: "public",
99
100
  }).handlers),
100
- createInsightsModel: (database) =>
101
- createInsightsModel(createDatabasePluginApis(database, [insights()]).insights),
101
+ plugins: [insightsTestSuite({
102
+ createModel: (database) =>
103
+ createInsightsModel(createDatabasePluginApis(database, [insights()]).insights),
104
+ })],
102
105
  createDatabase: () => database,
106
+ // Core's tables and those of the plugins the server runs.
103
107
  migrate: async () => {
104
108
  const migration = await createMigrator(createHotUpdater({
105
- database, clientAccess: "public",
109
+ database, plugins: [insights()], clientAccess: "public",
106
110
  })).migrateToLatest({ mode: "from-schema", updateSettings: true });
107
111
  await migration.execute();
108
112
  },
@@ -1,104 +0,0 @@
1
- const require_resolveSchema = require("../database/resolveSchema.cjs");
2
- const require_schema = require("../core/schema.cjs");
3
- const require_fence = require("../database/fence.cjs");
4
- const require_builtIn = require("../plugins/builtIn.cjs");
5
- const require_schema$1 = require("../plugins/api-keys/schema.cjs");
6
- const require_plugins_api_keys_index = require("../plugins/api-keys/index.cjs");
7
- const require_schema$2 = require("../plugins/insights/schema.cjs");
8
- const require_plugins_insights_index = require("../plugins/insights/index.cjs");
9
- const require_schemaSettings = require("./schemaSettings.cjs");
10
- const require_engineMigrator = require("./engineMigrator.cjs");
11
- //#region src/db/builtInDatabase.ts
12
- /** Core and the built-in plugins: their tables keep their names. */
13
- const builtInModules = [
14
- require_schema.coreModule,
15
- {
16
- id: "insights",
17
- schema: require_schema$2.insightsSchema
18
- },
19
- {
20
- id: "apiKeys",
21
- schema: require_schema$1.apiKeysSchema
22
- }
23
- ];
24
- /**
25
- * Core's tables and the built-in plugins' (Insights and API keys): the tables
26
- * every provider's tooling creates, whichever plugins a server runs.
27
- */
28
- const builtInSchema = require_resolveSchema.resolveSchema(builtInModules);
29
- /** The settings rows a provider's database is fenced by. */
30
- const builtInSettings = {
31
- [require_fence.ENGINE_SCHEMA_KEY]: "1",
32
- "schema.core": require_schema.HOT_UPDATER_SCHEMA_VERSION,
33
- "schema.insights": require_plugins_insights_index.insights().schemaVersion,
34
- "schema.apiKeys": require_plugins_api_keys_index.apiKeys().schemaVersion
35
- };
36
- /** Creates the built-in tables, then writes their settings rows. */
37
- const migrateBuiltInSchema = (adapter, name) => require_schemaSettings.migrateSchema(adapter, name, builtInSchema.tables, builtInSettings);
38
- /** What `hot-updater db` creates for a server without third-party plugins. */
39
- const builtInTarget = {
40
- schema: builtInSchema,
41
- settings: builtInSettings
42
- };
43
- const addedPlugins = (plugins) => plugins.filter((plugin) => !(require_builtIn.builtInPlugin in plugin));
44
- /** Each third-party plugin's `schema.<id>` settings row. */
45
- const addedSettings = (plugins) => Object.fromEntries(addedPlugins(plugins).map(({ id, schemaVersion }) => [`schema.${id}`, schemaVersion]));
46
- /**
47
- * What `hot-updater db` creates for a server's plugins: the built-in tables,
48
- * then each third-party plugin's tables with its `schema.<id>` settings row.
49
- */
50
- const toolingTargetOf = (plugins) => {
51
- const settings = addedSettings(plugins);
52
- if (Object.keys(settings).length === 0) return builtInTarget;
53
- return {
54
- schema: require_resolveSchema.resolveSchema([...builtInModules, ...addedPlugins(plugins).map(({ id, schema }) => ({
55
- id,
56
- schema,
57
- namespace: id
58
- }))]),
59
- settings: {
60
- ...builtInSettings,
61
- ...settings
62
- }
63
- };
64
- };
65
- /**
66
- * A provider's database on the storage engine: its adapter behind the schema
67
- * fence, which checks the built-in settings rows before the first read or
68
- * write and names `hot-updater db migrate` when they are missing or stale.
69
- * When the adapter creates its own tables, `hot-updater db migrate` creates
70
- * the built-in tables and the server's plugin tables, then writes their
71
- * settings rows.
72
- */
73
- const createEngineDatabase = ({ name, adapter, onCachedRoutesChange }) => {
74
- const fenced = require_fence.withSchemaFence(adapter, name, builtInSettings);
75
- const createMigrator = ({ schema, settings } = builtInTarget) => require_engineMigrator.createEngineMigrator({
76
- adapterName: name,
77
- adapter,
78
- schema,
79
- settings,
80
- readSettings: async () => {
81
- const rows = await require_fence.readSettings(adapter, Object.keys(settings)).catch((error) => {
82
- if (require_fence.isMissingSchemaError(error)) return [];
83
- throw error;
84
- });
85
- return new Map(rows.flatMap((row) => row === null ? [] : [[String(row.key), row.value]]));
86
- }
87
- });
88
- return {
89
- name,
90
- adapter: fenced,
91
- ...onCachedRoutesChange === void 0 ? {} : { onCachedRoutesChange },
92
- ...adapter.dispose === void 0 ? {} : { dispose: () => adapter.dispose() },
93
- ...adapter.migrations === void 0 ? {} : { createMigrator }
94
- };
95
- };
96
- //#endregion
97
- exports.addedSettings = addedSettings;
98
- exports.builtInModules = builtInModules;
99
- exports.builtInSchema = builtInSchema;
100
- exports.builtInSettings = builtInSettings;
101
- exports.builtInTarget = builtInTarget;
102
- exports.createEngineDatabase = createEngineDatabase;
103
- exports.migrateBuiltInSchema = migrateBuiltInSchema;
104
- exports.toolingTargetOf = toolingTargetOf;
@@ -1,38 +0,0 @@
1
- import { SchemaSettings } from "../database/fence.cjs";
2
- import { ResolvedSchema } from "../database/resolveSchema.cjs";
3
- import { ToolingDatabase, ToolingTarget } from "./types.cjs";
4
- import "../database/index.cjs";
5
- import { DatabaseAdapter } from "@hot-updater/plugin-core/internal";
6
- //#region src/db/builtInDatabase.d.ts
7
- /**
8
- * Core's tables and the built-in plugins' (Insights and API keys): the tables
9
- * every provider's tooling creates, whichever plugins a server runs.
10
- */
11
- declare const builtInSchema: ResolvedSchema;
12
- /** The settings rows a provider's database is fenced by. */
13
- declare const builtInSettings: SchemaSettings;
14
- /** Creates the built-in tables, then writes their settings rows. */
15
- declare const migrateBuiltInSchema: (adapter: DatabaseAdapter, name: string) => Promise<void>;
16
- /** What `hot-updater db` creates for a server without third-party plugins. */
17
- declare const builtInTarget: ToolingTarget;
18
- interface EngineDatabaseOptions {
19
- readonly name: string;
20
- readonly adapter: DatabaseAdapter;
21
- /**
22
- * Purges a CDN's copies of the cacheable client routes. Core calls it after
23
- * a committed write that changes what those routes answer, since only core
24
- * knows which of its tables they read.
25
- */
26
- readonly onCachedRoutesChange?: () => Promise<void>;
27
- }
28
- /**
29
- * A provider's database on the storage engine: its adapter behind the schema
30
- * fence, which checks the built-in settings rows before the first read or
31
- * write and names `hot-updater db migrate` when they are missing or stale.
32
- * When the adapter creates its own tables, `hot-updater db migrate` creates
33
- * the built-in tables and the server's plugin tables, then writes their
34
- * settings rows.
35
- */
36
- declare const createEngineDatabase: ({ name, adapter, onCachedRoutesChange }: EngineDatabaseOptions) => ToolingDatabase;
37
- //#endregion
38
- export { EngineDatabaseOptions, builtInSchema, builtInSettings, builtInTarget, createEngineDatabase, migrateBuiltInSchema };