@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
@@ -1,38 +0,0 @@
1
- import { SchemaSettings } from "../database/fence.mjs";
2
- import { ResolvedSchema } from "../database/resolveSchema.mjs";
3
- import { ToolingDatabase, ToolingTarget } from "./types.mjs";
4
- import "../database/index.mjs";
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 };
@@ -1,97 +0,0 @@
1
- import { resolveSchema } from "../database/resolveSchema.mjs";
2
- import { HOT_UPDATER_SCHEMA_VERSION, coreModule } from "../core/schema.mjs";
3
- import { ENGINE_SCHEMA_KEY, isMissingSchemaError, readSettings, withSchemaFence } from "../database/fence.mjs";
4
- import { builtInPlugin } from "../plugins/builtIn.mjs";
5
- import { apiKeysSchema } from "../plugins/api-keys/schema.mjs";
6
- import { apiKeys } from "../plugins/api-keys/index.mjs";
7
- import { insightsSchema } from "../plugins/insights/schema.mjs";
8
- import { insights } from "../plugins/insights/index.mjs";
9
- import { migrateSchema } from "./schemaSettings.mjs";
10
- import { createEngineMigrator } from "./engineMigrator.mjs";
11
- //#region src/db/builtInDatabase.ts
12
- /** Core and the built-in plugins: their tables keep their names. */
13
- const builtInModules = [
14
- coreModule,
15
- {
16
- id: "insights",
17
- schema: insightsSchema
18
- },
19
- {
20
- id: "apiKeys",
21
- schema: 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 = resolveSchema(builtInModules);
29
- /** The settings rows a provider's database is fenced by. */
30
- const builtInSettings = {
31
- [ENGINE_SCHEMA_KEY]: "1",
32
- "schema.core": HOT_UPDATER_SCHEMA_VERSION,
33
- "schema.insights": insights().schemaVersion,
34
- "schema.apiKeys": apiKeys().schemaVersion
35
- };
36
- /** Creates the built-in tables, then writes their settings rows. */
37
- const migrateBuiltInSchema = (adapter, name) => 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) => !(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: 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 = withSchemaFence(adapter, name, builtInSettings);
75
- const createMigrator = ({ schema, settings } = builtInTarget) => createEngineMigrator({
76
- adapterName: name,
77
- adapter,
78
- schema,
79
- settings,
80
- readSettings: async () => {
81
- const rows = await readSettings(adapter, Object.keys(settings)).catch((error) => {
82
- if (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
- export { addedSettings, builtInModules, builtInSchema, builtInSettings, builtInTarget, createEngineDatabase, migrateBuiltInSchema, toolingTargetOf };
@@ -1,7 +0,0 @@
1
- //#region src/plugins/builtIn.ts
2
- /** Marks built-in plugins, whose tables keep their names instead of taking the plugin id as a namespace. */
3
- const builtInPlugin = Symbol.for("@hot-updater/server/built-in-plugin");
4
- const markBuiltIn = (plugin) => Object.defineProperty(plugin, builtInPlugin, { value: true });
5
- //#endregion
6
- exports.builtInPlugin = builtInPlugin;
7
- exports.markBuiltIn = markBuiltIn;
@@ -1,6 +0,0 @@
1
- //#region src/plugins/builtIn.ts
2
- /** Marks built-in plugins, whose tables keep their names instead of taking the plugin id as a namespace. */
3
- const builtInPlugin = Symbol.for("@hot-updater/server/built-in-plugin");
4
- const markBuiltIn = (plugin) => Object.defineProperty(plugin, builtInPlugin, { value: true });
5
- //#endregion
6
- export { builtInPlugin, markBuiltIn };
@@ -1,149 +0,0 @@
1
- import type { DatabaseAdapter } from "@hot-updater/plugin-core/internal";
2
-
3
- import { coreModule, HOT_UPDATER_SCHEMA_VERSION } from "../core/schema";
4
- import type { ModelShape } from "../database/definitions";
5
- import {
6
- ENGINE_SCHEMA_KEY,
7
- ENGINE_SCHEMA_VERSION,
8
- isMissingSchemaError,
9
- readSettings,
10
- withSchemaFence,
11
- type SchemaSettings,
12
- } from "../database/fence";
13
- import { resolveSchema, type SchemaModule } from "../database/resolveSchema";
14
- import { apiKeys, apiKeysSchema } from "../plugins/api-keys";
15
- import { builtInPlugin } from "../plugins/builtIn";
16
- import { insights, insightsSchema } from "../plugins/insights";
17
- import { createEngineMigrator } from "./engineMigrator";
18
- import { migrateSchema } from "./schemaSettings";
19
- import type { ToolingDatabase, ToolingTarget } from "./types";
20
-
21
- /** Core and the built-in plugins: their tables keep their names. */
22
- export const builtInModules: readonly SchemaModule[] = [
23
- coreModule,
24
- { id: "insights", schema: insightsSchema },
25
- { id: "apiKeys", schema: apiKeysSchema },
26
- ];
27
-
28
- /**
29
- * Core's tables and the built-in plugins' (Insights and API keys): the tables
30
- * every provider's tooling creates, whichever plugins a server runs.
31
- */
32
- export const builtInSchema = resolveSchema(builtInModules);
33
-
34
- /** The settings rows a provider's database is fenced by. */
35
- export const builtInSettings: SchemaSettings = {
36
- [ENGINE_SCHEMA_KEY]: ENGINE_SCHEMA_VERSION,
37
- "schema.core": HOT_UPDATER_SCHEMA_VERSION,
38
- "schema.insights": insights().schemaVersion,
39
- "schema.apiKeys": apiKeys().schemaVersion,
40
- };
41
-
42
- /** Creates the built-in tables, then writes their settings rows. */
43
- export const migrateBuiltInSchema = (adapter: DatabaseAdapter, name: string) =>
44
- migrateSchema(adapter, name, builtInSchema.tables, builtInSettings);
45
-
46
- /** What `hot-updater db` creates for a server without third-party plugins. */
47
- export const builtInTarget: ToolingTarget = {
48
- schema: builtInSchema,
49
- settings: builtInSettings,
50
- };
51
-
52
- /** A plugin as the tooling reads it: its id, its tables, and their version. */
53
- export interface PluginTables {
54
- readonly id: string;
55
- readonly schemaVersion: string;
56
- readonly schema: Readonly<Record<string, ModelShape>>;
57
- }
58
-
59
- const addedPlugins = (plugins: readonly PluginTables[]) =>
60
- plugins.filter((plugin) => !(builtInPlugin in plugin));
61
-
62
- /** Each third-party plugin's `schema.<id>` settings row. */
63
- export const addedSettings = (
64
- plugins: readonly PluginTables[],
65
- ): SchemaSettings =>
66
- Object.fromEntries(
67
- addedPlugins(plugins).map(({ id, schemaVersion }) => [
68
- `schema.${id}`,
69
- schemaVersion,
70
- ]),
71
- );
72
-
73
- /**
74
- * What `hot-updater db` creates for a server's plugins: the built-in tables,
75
- * then each third-party plugin's tables with its `schema.<id>` settings row.
76
- */
77
- export const toolingTargetOf = (
78
- plugins: readonly PluginTables[],
79
- ): ToolingTarget => {
80
- const settings = addedSettings(plugins);
81
- if (Object.keys(settings).length === 0) return builtInTarget;
82
- return {
83
- schema: resolveSchema([
84
- ...builtInModules,
85
- ...addedPlugins(plugins).map(({ id, schema }) => ({
86
- id,
87
- schema,
88
- namespace: id,
89
- })),
90
- ]),
91
- settings: { ...builtInSettings, ...settings },
92
- };
93
- };
94
-
95
- export interface EngineDatabaseOptions {
96
- readonly name: string;
97
- readonly adapter: DatabaseAdapter;
98
- /**
99
- * Purges a CDN's copies of the cacheable client routes. Core calls it after
100
- * a committed write that changes what those routes answer, since only core
101
- * knows which of its tables they read.
102
- */
103
- readonly onCachedRoutesChange?: () => Promise<void>;
104
- }
105
-
106
- /**
107
- * A provider's database on the storage engine: its adapter behind the schema
108
- * fence, which checks the built-in settings rows before the first read or
109
- * write and names `hot-updater db migrate` when they are missing or stale.
110
- * When the adapter creates its own tables, `hot-updater db migrate` creates
111
- * the built-in tables and the server's plugin tables, then writes their
112
- * settings rows.
113
- */
114
- export const createEngineDatabase = ({
115
- name,
116
- adapter,
117
- onCachedRoutesChange,
118
- }: EngineDatabaseOptions): ToolingDatabase => {
119
- const fenced = withSchemaFence(adapter, name, builtInSettings);
120
- const createMigrator = ({ schema, settings } = builtInTarget) =>
121
- createEngineMigrator({
122
- adapterName: name,
123
- adapter,
124
- schema,
125
- settings,
126
- readSettings: async () => {
127
- const rows = await readSettings(adapter, Object.keys(settings)).catch(
128
- (error: unknown) => {
129
- if (isMissingSchemaError(error)) return [];
130
- throw error;
131
- },
132
- );
133
- return new Map(
134
- rows.flatMap((row) =>
135
- row === null ? [] : [[String(row.key), row.value]],
136
- ),
137
- );
138
- },
139
- });
140
- return {
141
- name,
142
- adapter: fenced,
143
- ...(onCachedRoutesChange === undefined ? {} : { onCachedRoutesChange }),
144
- ...(adapter.dispose === undefined
145
- ? {}
146
- : { dispose: () => adapter.dispose!() }),
147
- ...(adapter.migrations === undefined ? {} : { createMigrator }),
148
- };
149
- };
@@ -1,5 +0,0 @@
1
- /** Marks built-in plugins, whose tables keep their names instead of taking the plugin id as a namespace. */
2
- export const builtInPlugin = Symbol.for("@hot-updater/server/built-in-plugin");
3
-
4
- export const markBuiltIn = <TPlugin extends object>(plugin: TPlugin): TPlugin =>
5
- Object.defineProperty(plugin, builtInPlugin, { value: true });