@mistriwork/engine 0.0.0 → 1.0.0-rc.11

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 (572) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +16 -1
  3. package/dist/adapters/adapter.d.ts +726 -0
  4. package/dist/adapters/adapter.js +444 -0
  5. package/dist/adapters/cache/cacheStore.d.ts +75 -0
  6. package/dist/adapters/cache/cacheStore.js +160 -0
  7. package/dist/adapters/cache/resp.d.ts +52 -0
  8. package/dist/adapters/cache/resp.js +237 -0
  9. package/dist/adapters/commands/canonicalJson.d.ts +19 -0
  10. package/dist/adapters/commands/canonicalJson.js +154 -0
  11. package/dist/adapters/connect.d.ts +29 -0
  12. package/dist/adapters/connect.js +40 -0
  13. package/dist/adapters/connectionBudget.d.ts +101 -0
  14. package/dist/adapters/connectionBudget.js +128 -0
  15. package/dist/adapters/dbLatency.d.ts +35 -0
  16. package/dist/adapters/dbLatency.js +79 -0
  17. package/dist/adapters/epochCache.d.ts +50 -0
  18. package/dist/adapters/epochCache.js +85 -0
  19. package/dist/adapters/http/egress.d.ts +48 -0
  20. package/dist/adapters/http/egress.js +175 -0
  21. package/dist/adapters/http/httpAdapter.d.ts +71 -0
  22. package/dist/adapters/http/httpAdapter.js +512 -0
  23. package/dist/adapters/http/httpDescription.d.ts +32 -0
  24. package/dist/adapters/http/httpDescription.js +246 -0
  25. package/dist/adapters/http/openapi.d.ts +98 -0
  26. package/dist/adapters/http/openapi.js +487 -0
  27. package/dist/adapters/layoutRefusal.d.ts +24 -0
  28. package/dist/adapters/layoutRefusal.js +35 -0
  29. package/dist/adapters/net/networkPolicy.d.ts +44 -0
  30. package/dist/adapters/net/networkPolicy.js +123 -0
  31. package/dist/adapters/net/untrustedDatabase.d.ts +18 -0
  32. package/dist/adapters/net/untrustedDatabase.js +120 -0
  33. package/dist/adapters/poolAdmission.d.ts +43 -0
  34. package/dist/adapters/poolAdmission.js +184 -0
  35. package/dist/adapters/poolMetrics.d.ts +121 -0
  36. package/dist/adapters/poolMetrics.js +185 -0
  37. package/dist/adapters/postgres.d.ts +441 -0
  38. package/dist/adapters/postgres.js +1841 -0
  39. package/dist/adapters/postgresCatalog.d.ts +107 -0
  40. package/dist/adapters/postgresCatalog.js +421 -0
  41. package/dist/adapters/postgresCatalogDigest.d.ts +30 -0
  42. package/dist/adapters/postgresCatalogDigest.js +93 -0
  43. package/dist/adapters/postgresCatalogRows.d.ts +64 -0
  44. package/dist/adapters/postgresCatalogRows.js +37 -0
  45. package/dist/adapters/postgresDates.d.ts +1 -0
  46. package/dist/adapters/postgresDates.js +39 -0
  47. package/dist/adapters/postgresMaintenance.d.ts +33 -0
  48. package/dist/adapters/postgresMaintenance.js +179 -0
  49. package/dist/adapters/postgresPool.d.ts +255 -0
  50. package/dist/adapters/postgresPool.js +838 -0
  51. package/dist/adapters/postgresPooler.d.ts +28 -0
  52. package/dist/adapters/postgresPooler.js +267 -0
  53. package/dist/adapters/postgresReadCatalog.d.ts +31 -0
  54. package/dist/adapters/postgresReadCatalog.js +226 -0
  55. package/dist/adapters/postgresReadSnapshot.d.ts +46 -0
  56. package/dist/adapters/postgresReadSnapshot.js +133 -0
  57. package/dist/adapters/postgresSchemaEpoch.d.ts +24 -0
  58. package/dist/adapters/postgresSchemaEpoch.js +149 -0
  59. package/dist/adapters/postgresTransactionHandle.d.ts +173 -0
  60. package/dist/adapters/postgresTransactionHandle.js +524 -0
  61. package/dist/adapters/postgresValues.d.ts +30 -0
  62. package/dist/adapters/postgresValues.js +75 -0
  63. package/dist/adapters/postgresWriteAhead.d.ts +47 -0
  64. package/dist/adapters/postgresWriteAhead.js +209 -0
  65. package/dist/adapters/replicas.d.ts +70 -0
  66. package/dist/adapters/replicas.js +208 -0
  67. package/dist/adapters/reservedSql.d.ts +38 -0
  68. package/dist/adapters/reservedSql.js +264 -0
  69. package/dist/adapters/rolePrivileges.d.ts +17 -0
  70. package/dist/adapters/rolePrivileges.js +22 -0
  71. package/dist/adapters/scoped/keyRows.d.ts +65 -0
  72. package/dist/adapters/scoped/keyRows.js +179 -0
  73. package/dist/adapters/scoped/keyTypes.d.ts +34 -0
  74. package/dist/adapters/scoped/keyTypes.js +66 -0
  75. package/dist/adapters/scoped/postgresScopeCatalog.d.ts +34 -0
  76. package/dist/adapters/scoped/postgresScopeCatalog.js +457 -0
  77. package/dist/adapters/scoped/postgresTriggers.d.ts +137 -0
  78. package/dist/adapters/scoped/postgresTriggers.js +1545 -0
  79. package/dist/adapters/scoped/scopeTriggers.d.ts +122 -0
  80. package/dist/adapters/scoped/scopeTriggers.js +131 -0
  81. package/dist/adapters/scoped/scopedCommandOperations.d.ts +5 -0
  82. package/dist/adapters/scoped/scopedCommandOperations.js +48 -0
  83. package/dist/adapters/scoped/scopedReads.d.ts +22 -0
  84. package/dist/adapters/scoped/scopedReads.js +192 -0
  85. package/dist/adapters/scoped/scopedTransaction.d.ts +159 -0
  86. package/dist/adapters/scoped/scopedTransaction.js +547 -0
  87. package/dist/adapters/scoped/sqliteScopeCatalog.d.ts +32 -0
  88. package/dist/adapters/scoped/sqliteScopeCatalog.js +420 -0
  89. package/dist/adapters/scoped/sqliteTriggerSession.d.ts +64 -0
  90. package/dist/adapters/scoped/sqliteTriggerSession.js +245 -0
  91. package/dist/adapters/scoped/sqliteTriggers.d.ts +20 -0
  92. package/dist/adapters/scoped/sqliteTriggers.js +822 -0
  93. package/dist/adapters/scoped/storedText.d.ts +45 -0
  94. package/dist/adapters/scoped/storedText.js +61 -0
  95. package/dist/adapters/scoped/triggerEffects.d.ts +98 -0
  96. package/dist/adapters/scoped/triggerEffects.js +189 -0
  97. package/dist/adapters/scoped/triggerProof.d.ts +124 -0
  98. package/dist/adapters/scoped/triggerProof.js +366 -0
  99. package/dist/adapters/scoped/updateGuard.d.ts +3 -0
  100. package/dist/adapters/scoped/updateGuard.js +40 -0
  101. package/dist/adapters/serverSettings.d.ts +45 -0
  102. package/dist/adapters/serverSettings.js +46 -0
  103. package/dist/adapters/snapshotRead.d.ts +8 -0
  104. package/dist/adapters/snapshotRead.js +37 -0
  105. package/dist/adapters/sqlite.d.ts +273 -0
  106. package/dist/adapters/sqlite.js +1557 -0
  107. package/dist/adapters/sqliteCostlyReads.d.ts +33 -0
  108. package/dist/adapters/sqliteCostlyReads.js +49 -0
  109. package/dist/adapters/sqliteDecimals.d.ts +22 -0
  110. package/dist/adapters/sqliteDecimals.js +51 -0
  111. package/dist/adapters/sqliteHandles.d.ts +43 -0
  112. package/dist/adapters/sqliteHandles.js +143 -0
  113. package/dist/adapters/sqliteStatementProcess.d.ts +29 -0
  114. package/dist/adapters/sqliteStatementProcess.js +131 -0
  115. package/dist/adapters/statementControl.d.ts +34 -0
  116. package/dist/adapters/statementControl.js +90 -0
  117. package/dist/adapters/storeHost.d.ts +133 -0
  118. package/dist/adapters/storeHost.js +13 -0
  119. package/dist/adapters/telemetry/drivers.d.ts +21 -0
  120. package/dist/adapters/telemetry/drivers.js +321 -0
  121. package/dist/adapters/telemetry/metrics.d.ts +63 -0
  122. package/dist/adapters/telemetry/metrics.js +122 -0
  123. package/dist/adapters/telemetry/otlp.d.ts +12 -0
  124. package/dist/adapters/telemetry/otlp.js +320 -0
  125. package/dist/adapters/telemetry/otlpEncode.d.ts +48 -0
  126. package/dist/adapters/telemetry/otlpEncode.js +366 -0
  127. package/dist/adapters/telemetry/otlpEnv.d.ts +1 -0
  128. package/dist/adapters/telemetry/otlpEnv.js +12 -0
  129. package/dist/adapters/telemetry/serverTiming.d.ts +83 -0
  130. package/dist/adapters/telemetry/serverTiming.js +503 -0
  131. package/dist/adapters/telemetry/start.d.ts +10 -0
  132. package/dist/adapters/telemetry/start.js +25 -0
  133. package/dist/adapters/telemetry/statement.d.ts +16 -0
  134. package/dist/adapters/telemetry/statement.js +134 -0
  135. package/dist/adapters/telemetry/trace.d.ts +127 -0
  136. package/dist/adapters/telemetry/trace.js +295 -0
  137. package/dist/adapters/writeAhead.d.ts +27 -0
  138. package/dist/adapters/writeAhead.js +46 -0
  139. package/dist/adapters/writeAttribution.d.ts +18 -0
  140. package/dist/adapters/writeAttribution.js +23 -0
  141. package/dist/adapters/writeCapture.d.ts +80 -0
  142. package/dist/adapters/writeCapture.js +20 -0
  143. package/dist/adapters/writeLanes.d.ts +94 -0
  144. package/dist/adapters/writeLanes.js +232 -0
  145. package/dist/engine.d.ts +15 -0
  146. package/dist/engine.js +13 -0
  147. package/dist/server/auth/credentials.d.ts +61 -0
  148. package/dist/server/auth/credentials.js +260 -0
  149. package/dist/server/cacheService.d.ts +50 -0
  150. package/dist/server/cacheService.js +110 -0
  151. package/dist/server/cli/args.d.ts +182 -0
  152. package/dist/server/cli/args.js +348 -0
  153. package/dist/server/cli/bin.d.ts +5 -0
  154. package/dist/server/cli/bin.js +66 -0
  155. package/dist/server/cli/browser.d.ts +15 -0
  156. package/dist/server/cli/browser.js +37 -0
  157. package/dist/server/cli/config.d.ts +50 -0
  158. package/dist/server/cli/config.js +206 -0
  159. package/dist/server/cli/startup.d.ts +36 -0
  160. package/dist/server/cli/startup.js +128 -0
  161. package/dist/server/cli/startupOptions.d.ts +63 -0
  162. package/dist/server/cli/startupOptions.js +143 -0
  163. package/dist/server/cli/subcommand.d.ts +28 -0
  164. package/dist/server/cli/subcommand.js +32 -0
  165. package/dist/server/cli/usage.d.ts +13 -0
  166. package/dist/server/cli/usage.js +31 -0
  167. package/dist/server/clientHttp.d.ts +184 -0
  168. package/dist/server/clientHttp.js +700 -0
  169. package/dist/server/clientSurface.d.ts +128 -0
  170. package/dist/server/clientSurface.js +182 -0
  171. package/dist/server/columnGrants.d.ts +106 -0
  172. package/dist/server/columnGrants.js +741 -0
  173. package/dist/server/compileCache.d.ts +1 -0
  174. package/dist/server/compileCache.js +30 -0
  175. package/dist/server/config/locations.d.ts +1 -0
  176. package/dist/server/config/locations.js +15 -0
  177. package/dist/server/config/profile.d.ts +123 -0
  178. package/dist/server/config/profile.js +236 -0
  179. package/dist/server/configPaths.d.ts +7 -0
  180. package/dist/server/configPaths.js +34 -0
  181. package/dist/server/configSections.d.ts +64 -0
  182. package/dist/server/configSections.js +72 -0
  183. package/dist/server/connectionRedaction.d.ts +30 -0
  184. package/dist/server/connectionRedaction.js +77 -0
  185. package/dist/server/connections.d.ts +358 -0
  186. package/dist/server/connections.js +988 -0
  187. package/dist/server/constraints.d.ts +82 -0
  188. package/dist/server/constraints.js +169 -0
  189. package/dist/server/demo.d.ts +9 -0
  190. package/dist/server/demo.js +554 -0
  191. package/dist/server/devclient.d.ts +108 -0
  192. package/dist/server/devclient.js +361 -0
  193. package/dist/server/evidence.d.ts +55 -0
  194. package/dist/server/evidence.js +323 -0
  195. package/dist/server/hiddenColumns.d.ts +32 -0
  196. package/dist/server/hiddenColumns.js +244 -0
  197. package/dist/server/http/baselineHeaders.d.ts +24 -0
  198. package/dist/server/http/baselineHeaders.js +12 -0
  199. package/dist/server/http/captured.d.ts +35 -0
  200. package/dist/server/http/captured.js +73 -0
  201. package/dist/server/http/clock.d.ts +1 -0
  202. package/dist/server/http/clock.js +14 -0
  203. package/dist/server/http/connectionSource.d.ts +4 -0
  204. package/dist/server/http/connectionSource.js +48 -0
  205. package/dist/server/http/context.d.ts +189 -0
  206. package/dist/server/http/context.js +11 -0
  207. package/dist/server/http/crawlerText.d.ts +15 -0
  208. package/dist/server/http/crawlerText.js +32 -0
  209. package/dist/server/http/dataRoutes.d.ts +88 -0
  210. package/dist/server/http/dataRoutes.js +137 -0
  211. package/dist/server/http/door.d.ts +57 -0
  212. package/dist/server/http/door.js +39 -0
  213. package/dist/server/http/exportRoute.d.ts +15 -0
  214. package/dist/server/http/exportRoute.js +320 -0
  215. package/dist/server/http/firstPaint.d.ts +108 -0
  216. package/dist/server/http/firstPaint.js +262 -0
  217. package/dist/server/http/httpOperationRoutes.d.ts +11 -0
  218. package/dist/server/http/httpOperationRoutes.js +50 -0
  219. package/dist/server/http/pageReads.d.ts +20 -0
  220. package/dist/server/http/pageReads.js +205 -0
  221. package/dist/server/http/pageRoutes.d.ts +39 -0
  222. package/dist/server/http/pageRoutes.js +291 -0
  223. package/dist/server/http/probes.d.ts +22 -0
  224. package/dist/server/http/probes.js +27 -0
  225. package/dist/server/http/rateLimit.d.ts +131 -0
  226. package/dist/server/http/rateLimit.js +351 -0
  227. package/dist/server/http/readRoutes.d.ts +9 -0
  228. package/dist/server/http/readRoutes.js +131 -0
  229. package/dist/server/http/readRouting.d.ts +20 -0
  230. package/dist/server/http/readRouting.js +80 -0
  231. package/dist/server/http/recordCompose.d.ts +67 -0
  232. package/dist/server/http/recordCompose.js +167 -0
  233. package/dist/server/http/recordWrites.d.ts +89 -0
  234. package/dist/server/http/recordWrites.js +298 -0
  235. package/dist/server/http/refusalReport.d.ts +38 -0
  236. package/dist/server/http/refusalReport.js +75 -0
  237. package/dist/server/http/reply.d.ts +130 -0
  238. package/dist/server/http/reply.js +394 -0
  239. package/dist/server/http/requestOrigin.d.ts +11 -0
  240. package/dist/server/http/requestOrigin.js +8 -0
  241. package/dist/server/http/router.d.ts +45 -0
  242. package/dist/server/http/router.js +22 -0
  243. package/dist/server/http/serverCore.d.ts +68 -0
  244. package/dist/server/http/serverCore.js +177 -0
  245. package/dist/server/http/traceRequest.d.ts +30 -0
  246. package/dist/server/http/traceRequest.js +224 -0
  247. package/dist/server/http/trust.d.ts +261 -0
  248. package/dist/server/http/trust.js +472 -0
  249. package/dist/server/http/writeRefusal.d.ts +33 -0
  250. package/dist/server/http/writeRefusal.js +24 -0
  251. package/dist/server/httpConnection.d.ts +49 -0
  252. package/dist/server/httpConnection.js +170 -0
  253. package/dist/server/impact.d.ts +55 -0
  254. package/dist/server/impact.js +47 -0
  255. package/dist/server/journal.d.ts +134 -0
  256. package/dist/server/journal.js +398 -0
  257. package/dist/server/keysetReadHttp.d.ts +52 -0
  258. package/dist/server/keysetReadHttp.js +85 -0
  259. package/dist/server/layouts.d.ts +49 -0
  260. package/dist/server/layouts.js +192 -0
  261. package/dist/server/migrate/cli.d.ts +102 -0
  262. package/dist/server/migrate/cli.js +702 -0
  263. package/dist/server/migrate/database.d.ts +37 -0
  264. package/dist/server/migrate/database.js +247 -0
  265. package/dist/server/migrate/desired.d.ts +76 -0
  266. package/dist/server/migrate/desired.js +292 -0
  267. package/dist/server/migrate/files.d.ts +34 -0
  268. package/dist/server/migrate/files.js +141 -0
  269. package/dist/server/migrate/flyway.d.ts +7 -0
  270. package/dist/server/migrate/flyway.js +69 -0
  271. package/dist/server/migrate/history.d.ts +70 -0
  272. package/dist/server/migrate/history.js +211 -0
  273. package/dist/server/migrate/runner.d.ts +100 -0
  274. package/dist/server/migrate/runner.js +413 -0
  275. package/dist/server/migrate/snapshot.d.ts +30 -0
  276. package/dist/server/migrate/snapshot.js +239 -0
  277. package/dist/server/migrate/target.d.ts +33 -0
  278. package/dist/server/migrate/target.js +82 -0
  279. package/dist/server/openapiDraft.d.ts +25 -0
  280. package/dist/server/openapiDraft.js +171 -0
  281. package/dist/server/operations/diagnostics.d.ts +101 -0
  282. package/dist/server/operations/diagnostics.js +284 -0
  283. package/dist/server/operations/requestMetrics.d.ts +33 -0
  284. package/dist/server/operations/requestMetrics.js +94 -0
  285. package/dist/server/packageVersion.d.ts +1 -0
  286. package/dist/server/packageVersion.js +11 -0
  287. package/dist/server/poolConfig.d.ts +34 -0
  288. package/dist/server/poolConfig.js +114 -0
  289. package/dist/server/product.d.ts +20 -0
  290. package/dist/server/product.js +12 -0
  291. package/dist/server/recordHistoryOperations.d.ts +39 -0
  292. package/dist/server/recordHistoryOperations.js +43 -0
  293. package/dist/server/recordWriteOperations.d.ts +111 -0
  294. package/dist/server/recordWriteOperations.js +329 -0
  295. package/dist/server/resourceReadHttp.d.ts +81 -0
  296. package/dist/server/resourceReadHttp.js +606 -0
  297. package/dist/server/resourceReadOperations.d.ts +147 -0
  298. package/dist/server/resourceReadOperations.js +452 -0
  299. package/dist/server/scaffoldMachine.d.ts +54 -0
  300. package/dist/server/scaffoldMachine.js +184 -0
  301. package/dist/server/seed/cli.d.ts +20 -0
  302. package/dist/server/seed/cli.js +164 -0
  303. package/dist/server/seed/lexicon.d.ts +26 -0
  304. package/dist/server/seed/lexicon.js +585 -0
  305. package/dist/server/seed/seed.d.ts +70 -0
  306. package/dist/server/seed/seed.js +779 -0
  307. package/dist/server/seed/words.d.ts +21 -0
  308. package/dist/server/seed/words.js +164 -0
  309. package/dist/server/serverRequests.d.ts +6 -0
  310. package/dist/server/serverRequests.js +33 -0
  311. package/dist/server/serverTimeouts.d.ts +33 -0
  312. package/dist/server/serverTimeouts.js +32 -0
  313. package/dist/server/shapeonly.d.ts +32 -0
  314. package/dist/server/shapeonly.js +115 -0
  315. package/dist/server/startupWarnings.d.ts +32 -0
  316. package/dist/server/startupWarnings.js +92 -0
  317. package/dist/shared/addressParams.d.ts +28 -0
  318. package/dist/shared/addressParams.js +47 -0
  319. package/dist/shared/aggregate.d.ts +49 -0
  320. package/dist/shared/aggregate.js +107 -0
  321. package/dist/shared/appCards.d.ts +123 -0
  322. package/dist/shared/appCards.js +385 -0
  323. package/dist/shared/appComponents.d.ts +177 -0
  324. package/dist/shared/appComponents.js +422 -0
  325. package/dist/shared/appDocuments.d.ts +43 -0
  326. package/dist/shared/appDocuments.js +131 -0
  327. package/dist/shared/appEmbeds.d.ts +21 -0
  328. package/dist/shared/appEmbeds.js +24 -0
  329. package/dist/shared/appIcons.d.ts +28 -0
  330. package/dist/shared/appIcons.js +223 -0
  331. package/dist/shared/appLinks.d.ts +17 -0
  332. package/dist/shared/appLinks.js +124 -0
  333. package/dist/shared/appListColumns.d.ts +3 -0
  334. package/dist/shared/appListColumns.js +66 -0
  335. package/dist/shared/appLocale.d.ts +36 -0
  336. package/dist/shared/appLocale.js +86 -0
  337. package/dist/shared/appMessages.d.ts +44 -0
  338. package/dist/shared/appMessages.js +78 -0
  339. package/dist/shared/appNoun.d.ts +21 -0
  340. package/dist/shared/appNoun.js +32 -0
  341. package/dist/shared/autoBucket.d.ts +98 -0
  342. package/dist/shared/autoBucket.js +305 -0
  343. package/dist/shared/autoValues.d.ts +25 -0
  344. package/dist/shared/autoValues.js +25 -0
  345. package/dist/shared/breakdown.d.ts +228 -0
  346. package/dist/shared/breakdown.js +570 -0
  347. package/dist/shared/breakdowntext.d.ts +41 -0
  348. package/dist/shared/breakdowntext.js +400 -0
  349. package/dist/shared/builtInThemes.d.ts +2 -0
  350. package/dist/shared/builtInThemes.js +771 -0
  351. package/dist/shared/chartSeparation.d.ts +11 -0
  352. package/dist/shared/chartSeparation.js +58 -0
  353. package/dist/shared/clauses.d.ts +22 -0
  354. package/dist/shared/clauses.js +97 -0
  355. package/dist/shared/columnCaption.d.ts +16 -0
  356. package/dist/shared/columnCaption.js +90 -0
  357. package/dist/shared/commandFieldPath.d.ts +2 -0
  358. package/dist/shared/commandFieldPath.js +7 -0
  359. package/dist/shared/commandWire.d.ts +26 -0
  360. package/dist/shared/commandWire.js +41 -0
  361. package/dist/shared/computed.d.ts +161 -0
  362. package/dist/shared/computed.js +378 -0
  363. package/dist/shared/computedParse.d.ts +13 -0
  364. package/dist/shared/computedParse.js +278 -0
  365. package/dist/shared/computedValue.d.ts +47 -0
  366. package/dist/shared/computedValue.js +191 -0
  367. package/dist/shared/connection.d.ts +30 -0
  368. package/dist/shared/connection.js +1 -0
  369. package/dist/shared/csv.d.ts +20 -0
  370. package/dist/shared/csv.js +63 -0
  371. package/dist/shared/dashLayout.d.ts +30 -0
  372. package/dist/shared/dashLayout.js +132 -0
  373. package/dist/shared/dashboardAsks.d.ts +93 -0
  374. package/dist/shared/dashboardAsks.js +129 -0
  375. package/dist/shared/dashboardTrend.d.ts +20 -0
  376. package/dist/shared/dashboardTrend.js +50 -0
  377. package/dist/shared/decimals.d.ts +37 -0
  378. package/dist/shared/decimals.js +148 -0
  379. package/dist/shared/declaredReferences.d.ts +50 -0
  380. package/dist/shared/declaredReferences.js +202 -0
  381. package/dist/shared/definedFields.d.ts +63 -0
  382. package/dist/shared/definedFields.js +103 -0
  383. package/dist/shared/definedValues.d.ts +63 -0
  384. package/dist/shared/definedValues.js +184 -0
  385. package/dist/shared/displayDefaults.d.ts +135 -0
  386. package/dist/shared/displayDefaults.js +543 -0
  387. package/dist/shared/dueDate.d.ts +6 -0
  388. package/dist/shared/dueDate.js +6 -0
  389. package/dist/shared/duration.d.ts +4 -0
  390. package/dist/shared/duration.js +23 -0
  391. package/dist/shared/fileBounds.d.ts +9 -0
  392. package/dist/shared/fileBounds.js +9 -0
  393. package/dist/shared/filter.d.ts +238 -0
  394. package/dist/shared/filter.js +332 -0
  395. package/dist/shared/firstPaint.d.ts +24 -0
  396. package/dist/shared/firstPaint.js +33 -0
  397. package/dist/shared/form.d.ts +21 -0
  398. package/dist/shared/form.js +25 -0
  399. package/dist/shared/formValues.d.ts +104 -0
  400. package/dist/shared/formValues.js +352 -0
  401. package/dist/shared/funnel.d.ts +45 -0
  402. package/dist/shared/funnel.js +108 -0
  403. package/dist/shared/httpOperations.d.ts +48 -0
  404. package/dist/shared/httpOperations.js +9 -0
  405. package/dist/shared/iconGlyphs.d.ts +4 -0
  406. package/dist/shared/iconGlyphs.js +151 -0
  407. package/dist/shared/iconWeights.d.ts +3 -0
  408. package/dist/shared/iconWeights.js +162 -0
  409. package/dist/shared/imageWidths.d.ts +32 -0
  410. package/dist/shared/imageWidths.js +38 -0
  411. package/dist/shared/keysetPage.d.ts +64 -0
  412. package/dist/shared/keysetPage.js +161 -0
  413. package/dist/shared/like.d.ts +20 -0
  414. package/dist/shared/like.js +29 -0
  415. package/dist/shared/listEmpty.d.ts +12 -0
  416. package/dist/shared/listEmpty.js +36 -0
  417. package/dist/shared/listFilters.d.ts +28 -0
  418. package/dist/shared/listFilters.js +84 -0
  419. package/dist/shared/listPresentations.d.ts +199 -0
  420. package/dist/shared/listPresentations.js +7 -0
  421. package/dist/shared/listQuestion.d.ts +52 -0
  422. package/dist/shared/listQuestion.js +137 -0
  423. package/dist/shared/lookPalettes.d.ts +62 -0
  424. package/dist/shared/lookPalettes.js +306 -0
  425. package/dist/shared/maskQuoted.d.ts +24 -0
  426. package/dist/shared/maskQuoted.js +48 -0
  427. package/dist/shared/mentionLabel.d.ts +19 -0
  428. package/dist/shared/mentionLabel.js +38 -0
  429. package/dist/shared/mentionLookup.d.ts +17 -0
  430. package/dist/shared/mentionLookup.js +64 -0
  431. package/dist/shared/menuCounts.d.ts +16 -0
  432. package/dist/shared/menuCounts.js +74 -0
  433. package/dist/shared/model.d.ts +79 -0
  434. package/dist/shared/model.js +153 -0
  435. package/dist/shared/money.d.ts +53 -0
  436. package/dist/shared/money.js +98 -0
  437. package/dist/shared/moneyEntry.d.ts +7 -0
  438. package/dist/shared/moneyEntry.js +27 -0
  439. package/dist/shared/mount.d.ts +118 -0
  440. package/dist/shared/mount.js +248 -0
  441. package/dist/shared/niceTicks.d.ts +26 -0
  442. package/dist/shared/niceTicks.js +50 -0
  443. package/dist/shared/order.d.ts +59 -0
  444. package/dist/shared/order.js +133 -0
  445. package/dist/shared/page.d.ts +135 -0
  446. package/dist/shared/page.js +1187 -0
  447. package/dist/shared/pageAnatomy.d.ts +99 -0
  448. package/dist/shared/pageAnatomy.js +370 -0
  449. package/dist/shared/pageConfig.d.ts +25 -0
  450. package/dist/shared/pageConfig.js +1308 -0
  451. package/dist/shared/pageEmptyActions.d.ts +12 -0
  452. package/dist/shared/pageEmptyActions.js +20 -0
  453. package/dist/shared/pageLayouts.d.ts +72 -0
  454. package/dist/shared/pageLayouts.js +205 -0
  455. package/dist/shared/pageModel.d.ts +785 -0
  456. package/dist/shared/pageModel.js +121 -0
  457. package/dist/shared/pagePaths.d.ts +180 -0
  458. package/dist/shared/pagePaths.js +869 -0
  459. package/dist/shared/pagePlans.d.ts +52 -0
  460. package/dist/shared/pagePlans.js +108 -0
  461. package/dist/shared/pageRoutes.d.ts +9 -0
  462. package/dist/shared/pageRoutes.js +9 -0
  463. package/dist/shared/query.d.ts +166 -0
  464. package/dist/shared/query.js +1302 -0
  465. package/dist/shared/queryDates.d.ts +12 -0
  466. package/dist/shared/queryDates.js +101 -0
  467. package/dist/shared/queryOperands.d.ts +99 -0
  468. package/dist/shared/queryOperands.js +131 -0
  469. package/dist/shared/reads.d.ts +103 -0
  470. package/dist/shared/reads.js +154 -0
  471. package/dist/shared/recordLabel.d.ts +51 -0
  472. package/dist/shared/recordLabel.js +123 -0
  473. package/dist/shared/recordReadKeys.d.ts +30 -0
  474. package/dist/shared/recordReadKeys.js +51 -0
  475. package/dist/shared/recordReads.d.ts +268 -0
  476. package/dist/shared/recordReads.js +368 -0
  477. package/dist/shared/recordview.d.ts +198 -0
  478. package/dist/shared/recordview.js +356 -0
  479. package/dist/shared/referenceModel.d.ts +58 -0
  480. package/dist/shared/referenceModel.js +194 -0
  481. package/dist/shared/refusal.d.ts +80 -0
  482. package/dist/shared/refusal.js +184 -0
  483. package/dist/shared/relatedCreate.d.ts +30 -0
  484. package/dist/shared/relatedCreate.js +162 -0
  485. package/dist/shared/resourceHttp.d.ts +464 -0
  486. package/dist/shared/resourceHttp.js +1 -0
  487. package/dist/shared/richText.d.ts +85 -0
  488. package/dist/shared/richText.js +305 -0
  489. package/dist/shared/rollups.d.ts +143 -0
  490. package/dist/shared/rollups.js +64 -0
  491. package/dist/shared/rowScope.d.ts +72 -0
  492. package/dist/shared/rowScope.js +376 -0
  493. package/dist/shared/runtimeTables.d.ts +44 -0
  494. package/dist/shared/runtimeTables.js +79 -0
  495. package/dist/shared/schema.d.ts +529 -0
  496. package/dist/shared/schema.js +627 -0
  497. package/dist/shared/schematext.d.ts +38 -0
  498. package/dist/shared/schematext.js +101 -0
  499. package/dist/shared/scopeCatalog.d.ts +29 -0
  500. package/dist/shared/scopeCatalog.js +472 -0
  501. package/dist/shared/servedApp.d.ts +686 -0
  502. package/dist/shared/servedApp.js +45 -0
  503. package/dist/shared/sessionLease.d.ts +34 -0
  504. package/dist/shared/sessionLease.js +3 -0
  505. package/dist/shared/shape.d.ts +55 -0
  506. package/dist/shared/shape.js +168 -0
  507. package/dist/shared/slug.d.ts +1 -0
  508. package/dist/shared/slug.js +12 -0
  509. package/dist/shared/sortText.d.ts +14 -0
  510. package/dist/shared/sortText.js +26 -0
  511. package/dist/shared/sqlRelation.d.ts +4 -0
  512. package/dist/shared/sqlRelation.js +8 -0
  513. package/dist/shared/sqlsaved.d.ts +44 -0
  514. package/dist/shared/sqlsaved.js +63 -0
  515. package/dist/shared/stitchedPaths.d.ts +27 -0
  516. package/dist/shared/stitchedPaths.js +38 -0
  517. package/dist/shared/structuredFilter.d.ts +22 -0
  518. package/dist/shared/structuredFilter.js +1 -0
  519. package/dist/shared/subtitlePath.d.ts +20 -0
  520. package/dist/shared/subtitlePath.js +24 -0
  521. package/dist/shared/suggest.d.ts +18 -0
  522. package/dist/shared/suggest.js +59 -0
  523. package/dist/shared/tableSizing.d.ts +4 -0
  524. package/dist/shared/tableSizing.js +9 -0
  525. package/dist/shared/tagLists.d.ts +57 -0
  526. package/dist/shared/tagLists.js +34 -0
  527. package/dist/shared/textRules.d.ts +54 -0
  528. package/dist/shared/textRules.js +133 -0
  529. package/dist/shared/theme.d.ts +94 -0
  530. package/dist/shared/theme.js +800 -0
  531. package/dist/shared/themeColor.d.ts +34 -0
  532. package/dist/shared/themeColor.js +109 -0
  533. package/dist/shared/themeFaces.d.ts +30 -0
  534. package/dist/shared/themeFaces.js +42 -0
  535. package/dist/shared/themeInk.d.ts +20 -0
  536. package/dist/shared/themeInk.js +52 -0
  537. package/dist/shared/themeLooks.d.ts +9 -0
  538. package/dist/shared/themeLooks.js +572 -0
  539. package/dist/shared/themeParts.d.ts +26 -0
  540. package/dist/shared/themeParts.js +71 -0
  541. package/dist/shared/themePartsCheck.d.ts +21 -0
  542. package/dist/shared/themePartsCheck.js +91 -0
  543. package/dist/shared/themePresets.d.ts +85 -0
  544. package/dist/shared/themePresets.js +139 -0
  545. package/dist/shared/themeRecipeWords.d.ts +156 -0
  546. package/dist/shared/themeRecipeWords.js +156 -0
  547. package/dist/shared/themeRecipes.d.ts +213 -0
  548. package/dist/shared/themeRecipes.js +234 -0
  549. package/dist/shared/themeResolve.d.ts +55 -0
  550. package/dist/shared/themeResolve.js +52 -0
  551. package/dist/shared/themeTokens.d.ts +107 -0
  552. package/dist/shared/themeTokens.js +116 -0
  553. package/dist/shared/themeType.d.ts +38 -0
  554. package/dist/shared/themeType.js +205 -0
  555. package/dist/shared/unitWord.d.ts +4 -0
  556. package/dist/shared/unitWord.js +37 -0
  557. package/dist/shared/view.d.ts +195 -0
  558. package/dist/shared/view.js +987 -0
  559. package/dist/shared/viewLabels.d.ts +47 -0
  560. package/dist/shared/viewLabels.js +459 -0
  561. package/dist/shared/viewPaths.d.ts +248 -0
  562. package/dist/shared/viewPaths.js +294 -0
  563. package/dist/shared/viewtext.d.ts +57 -0
  564. package/dist/shared/viewtext.js +282 -0
  565. package/dist/shared/vocabulary.d.ts +71 -0
  566. package/dist/shared/vocabulary.js +249 -0
  567. package/dist/shared/weekStart.d.ts +7 -0
  568. package/dist/shared/weekStart.js +36 -0
  569. package/mark.svg +1 -0
  570. package/package.json +266 -3
  571. package/schema/model.d.ts +298 -0
  572. package/schema/theme.d.ts +587 -0
@@ -0,0 +1,529 @@
1
+ /**
2
+ * The schema model every adapter produces, and the whole reason this tool
3
+ * can exist for more than one database.
4
+ *
5
+ * Most database clients treat a schema as a list of tables. The interesting
6
+ * structure is the edges: which column points at which table, and — the part
7
+ * almost nothing surfaces well — which columns elsewhere point back at the row
8
+ * you are looking at. Answering that second question is what turns a database
9
+ * from a list into something you can walk.
10
+ *
11
+ * Relational databases hand you both directions for free. `information_schema`
12
+ * knows every foreign key, so the reverse map is a filter over a list you
13
+ * already have. Adapters do the dialect-specific reading; everything above
14
+ * this file works on the model below and never learns which database it is.
15
+ */
16
+ import type { Rollup } from './rollups.js';
17
+ import type { TagSet } from './tagLists.js';
18
+ import type { ComputedColumn } from './computed.js';
19
+ export interface ColumnMeta {
20
+ name: string;
21
+ /** The database's own type string, shown as-is. Normalising it loses detail. */
22
+ type: string;
23
+ nullable: boolean;
24
+ /** True for the column(s) forming the primary key. */
25
+ primaryKey: boolean;
26
+ /** Server-projected editing affordance, never authority. Absent preserves existing behavior. */
27
+ writable?: boolean;
28
+ /** Server-projected: the column changes only through the App's actions
29
+ (transitions), so editors do not offer it. Never authority. */
30
+ changesBy?: 'actions';
31
+ /** Set when this column references another table. */
32
+ references?: {
33
+ table: string;
34
+ column: string;
35
+ };
36
+ /** Declared default, if any. */
37
+ default?: string;
38
+ /**
39
+ * The places a `numeric(p, s)` column holds (s), where `type` cannot say them: PostgreSQL's catalog calls the
40
+ * type plain `numeric`. Absent for an unconstrained numeric and for every other type; SQLite's declared type
41
+ * string carries its own (`decimals.ts` declaredScale).
42
+ */
43
+ scale?: number;
44
+ /** Public presence hint when a private schema projection omits the SQL default. */
45
+ hasDefault?: boolean;
46
+ /** Catalog-confirmed automatic identity assignment; absent is not a type-based guess. */
47
+ identity?: 'always' | 'by-default';
48
+ /**
49
+ * The values the database will accept, when it says so — an enum type, a
50
+ * native enum, a `CHECK (status IN (...))`.
51
+ *
52
+ * Absent when the column is unconstrained *or* when the adapter could not
53
+ * read the constraint, which are not the same thing; nothing may present
54
+ * this as "anything else is invalid".
55
+ */
56
+ allowed?: string[];
57
+ /**
58
+ * The database pins this integer to 0 and 1 (`CHECK (flag IN (0, 1))`), the
59
+ * flag of a dialect with no boolean type: it reads as yes or no, as a
60
+ * declared BOOLEAN does (`isFlagColumn`). The stored value stays 0 or 1.
61
+ */
62
+ flag?: true;
63
+ /**
64
+ * What the database holds a text column's length and form to: a
65
+ * `varchar(n)`'s n as `max`, and on PostgreSQL a CHECK in the simple form
66
+ * `char_length(col) >= n` as `min` or `col ~ '…'` as `pattern` (a whole-value
67
+ * JavaScript pattern). Display evidence like `allowed`; an App's own `text`
68
+ * rule wins key by key (textRules.ts). Absent where it says nothing a form can check.
69
+ */
70
+ text?: {
71
+ min?: number;
72
+ max?: number;
73
+ pattern?: string;
74
+ };
75
+ comment?: string;
76
+ /**
77
+ * An App's machine over this column (appMachine.ts), as the query language
78
+ * reads it: `status is open` is a state that is not final, `status is
79
+ * onBench` one of a group the machine names. Set on an App's catalog only.
80
+ */
81
+ states?: MachineStates;
82
+ }
83
+ /** A machine's states as a condition reads them: the open ones, the final ones, and the named groups. */
84
+ export interface MachineStates {
85
+ open: readonly string[];
86
+ final: readonly string[];
87
+ groups?: Readonly<Record<string, readonly string[]>>;
88
+ }
89
+ /** One foreign-key reference a column carries, and whether the key it came
90
+ * from has more than one column. */
91
+ export interface ColumnReferenceCandidate {
92
+ readonly reference: {
93
+ table: string;
94
+ column: string;
95
+ };
96
+ readonly composite: boolean;
97
+ }
98
+ export type ColumnReferenceChoice = {
99
+ kind: 'one';
100
+ reference: {
101
+ table: string;
102
+ column: string;
103
+ };
104
+ } | {
105
+ kind: 'none';
106
+ } | {
107
+ kind: 'conflict';
108
+ };
109
+ /**
110
+ * The one link a reader follows from a column that sits in several keys.
111
+ *
112
+ * Several references on one column is ordinary schema, not a mistake: a tenant
113
+ * table's ownership column carries its own single-column reference to the
114
+ * tenancy profile (the framework requires exactly that) and its part in each
115
+ * composite tenant key. So the question is never whether to accept them, only
116
+ * which one `references` says. A single-column key is the column's own target,
117
+ * so it wins. Two single-column keys disagreeing is the real contradiction:
118
+ * the column claims to be two different things, and a catalog that attests a
119
+ * write boundary refuses it. Components of composite keys that disagree name
120
+ * no single link, so the column shows none — every edge is still in
121
+ * `foreignKeys`, where the walk reads both directions anyway.
122
+ *
123
+ * Both callers read the same verdict, and they answer `conflict` differently on
124
+ * purpose. The scoped catalogs attest a write boundary, so a contradiction
125
+ * there refuses the whole catalog: a lease may not write through metadata it
126
+ * cannot vouch for. The adapters' own `describe`, which reads databases this
127
+ * tool did not design, shows the column no link and carries on — refusing
128
+ * there would blank an entire existing database in the browser over one odd
129
+ * pair of keys. Do not "fix" the second into the first.
130
+ */
131
+ export declare function chooseColumnReference(candidates: readonly ColumnReferenceCandidate[]): ColumnReferenceChoice;
132
+ /**
133
+ * The columns a connection's `"hidden"` keeps from everything served over it
134
+ * (server hiddenColumns.ts), on the table it cut them from. A symbol, so the
135
+ * names ride along with the served catalog on the server and are never
136
+ * written into a JSON answer: they are what lets an App's own `hidden` name a
137
+ * column the connection already hides, rather than be told it is no column.
138
+ */
139
+ export declare const CONNECTION_HIDDEN: unique symbol;
140
+ export interface TableMeta {
141
+ /** What the connection hides of this table (CONNECTION_HIDDEN); never serialized. */
142
+ readonly [CONNECTION_HIDDEN]?: readonly string[];
143
+ name: string;
144
+ /** Server-projected delete affordance, never authority; may account for hidden columns. */
145
+ deletable?: boolean;
146
+ /** Server capability projection; omitted retains ordinary insert behavior. */
147
+ insertable?: boolean;
148
+ /** Schema/namespace the table lives in. Empty when the database has none. */
149
+ schema: string;
150
+ /** Qualified name used everywhere as the table's identity. */
151
+ id: string;
152
+ columns: ColumnMeta[];
153
+ /**
154
+ * The engine this table is read on, where an App's catalog merges sources on
155
+ * more than one connection (appSourceCatalog.ts). The merged catalog's own
156
+ * `dialect` is the default source's and says nothing about another's tables.
157
+ * Absent on a one-connection catalog, where `dialect` is every table's.
158
+ */
159
+ sourceDialect?: Dialect;
160
+ /** Approximate row count when the database can give one cheaply. */
161
+ approxRows?: number;
162
+ /** An App's record name for this table, as a template ('PO-{id}'), where it
163
+ serves one: what makes `$label` a path here (recordLabel.ts). */
164
+ labelTemplate?: string;
165
+ /** Set where that template is the key in the App's own words ('SO-{id}'),
166
+ so a grid's key column reads as the record's name (appRecordLabels.ts). */
167
+ keyLabel?: true;
168
+ /** An App's rollups over the rows that point at this table, by name, where
169
+ it serves them: numbers read like columns and never written, which is
170
+ why they are not among `columns` (rollups.ts). */
171
+ rollups?: Record<string, Rollup>;
172
+ /** An App's computed columns on this table, by name, where it serves them to this reader: expressions over
173
+ its columns, read like columns and never written, beside `columns` for the reason rollups are (computed.ts). */
174
+ computed?: Record<string, ComputedColumn>;
175
+ /** An App's tags on this table's records, where it serves them to this reader: read as `tags`, beside `columns`
176
+ for the reason rollups are (tagLists.ts). */
177
+ tags?: TagSet;
178
+ /** An App's segments on this table (appSegments.ts): a name and the conditions it stands for, which the query
179
+ language reads as a word (`overdue and mine`) and writes inline. Set on an App's catalog only, and served to a
180
+ reader only where every column they name is one the reader may read. */
181
+ segments?: Readonly<Record<string, string>>;
182
+ comment?: string;
183
+ /**
184
+ * The columns the source can filter by, when it cannot filter by every one:
185
+ * an API filters only where it documents a parameter (adapters/http).
186
+ * Absent means any column, as for every database.
187
+ */
188
+ filterable?: string[];
189
+ /**
190
+ * The columns the source can sort by, when it cannot sort by every one: an
191
+ * API sorts by the values it documents (adapters/http). Absent means the
192
+ * database's own rule applies (see `indexed`).
193
+ */
194
+ sortable?: string[];
195
+ /** `false` when the source reports no totals (an API): lists page without one, and nothing asks for a count. */
196
+ countable?: false;
197
+ /** True for views — read-only, and worth saying so rather than surprising. */
198
+ isView: boolean;
199
+ /** An App's union (appUnions.ts): read by asking each branch it holds, never as a table. */
200
+ union?: import('./servedApp.js').UnionTable;
201
+ /**
202
+ * Columns that lead an index, primary key included.
203
+ *
204
+ * Only the *leading* column of each index, because that is the only one an
205
+ * `ORDER BY` can be satisfied by: an index on `(customer_id, opened_at)`
206
+ * makes `ORDER BY customer_id` free and `ORDER BY opened_at` a full sort.
207
+ * Recording the whole index would invite the wrong conclusion.
208
+ *
209
+ * Absent rather than empty when the adapter does not report indexes, so
210
+ * "no indexes" and "we did not look" stay distinguishable.
211
+ */
212
+ indexed?: string[];
213
+ /**
214
+ * Columns unique on their own by a constraint or a whole-table unique
215
+ * index (not a partial or expression one): what an App's natural-key
216
+ * address (`address:`) must be proven to be before it is accepted.
217
+ * Absent when there are none or the adapter cannot say, and either way
218
+ * nothing is proven.
219
+ */
220
+ unique?: string[];
221
+ /**
222
+ * Pairs of columns unique together, and by nothing more, by a constraint or
223
+ * a whole-table unique index (`UNIQUE (tenant_id, number)`): in a tenant
224
+ * App, a natural key unique within its tenant (appAddress.ts). Absent as
225
+ * `unique` is: nothing proven.
226
+ */
227
+ uniquePairs?: Array<[string, string]>;
228
+ /**
229
+ * Columns a trigram index (PostgreSQL's pg_trgm, GIN or GiST) covers, at any
230
+ * position: the only index a `contains` search (ILIKE '%x%') can use. Like
231
+ * `indexed`, absent means the adapter did not look — only PostgreSQL does.
232
+ */
233
+ trigram?: string[];
234
+ }
235
+ /**
236
+ * One foreign key edge, stored once and read in both directions.
237
+ *
238
+ * `from` is the side holding the column, which is the "many" end in the usual
239
+ * case. A reverse lookup is every edge whose `to.table` is the table in hand.
240
+ */
241
+ /** What the database does to the referencing rows when the referenced row goes. */
242
+ export type DeleteRule = 'cascade' | 'set null' | 'set default' | 'restrict' | 'no action';
243
+ export interface ForeignKey {
244
+ name: string;
245
+ from: {
246
+ table: string;
247
+ columns: string[];
248
+ };
249
+ to: {
250
+ table: string;
251
+ columns: string[];
252
+ };
253
+ /**
254
+ * The constraint's `ON DELETE` action.
255
+ *
256
+ * Carried because "three rows point at this one" is not an answer to "what
257
+ * happens if I delete it" — under `cascade` those three rows go too and so
258
+ * may their children; under `restrict` the delete simply fails; under `set
259
+ * null` they survive with a hole where the reference was. Three different
260
+ * outcomes behind one number, and a tool that shows the number without the
261
+ * rule is inviting the reader to guess which.
262
+ *
263
+ * Absent when the adapter does not report it, which is a "do not know" and
264
+ * must not be read as `no action`.
265
+ */
266
+ onDelete?: DeleteRule;
267
+ /**
268
+ * An App's declared reference (`references:` on a resource): a soft key
269
+ * the database does not know, joined like a real one within one connection.
270
+ * Never authority: no write, cascade or delete impact reads it, and it
271
+ * never enters a scoped catalog's fingerprint, which is the database's.
272
+ */
273
+ declared?: true;
274
+ /**
275
+ * A declared reference to a table in another source, on another
276
+ * connection: no statement can join it, so it is read in two steps, the
277
+ * list and then one batched read of the targets it names through the
278
+ * target source's own scoped reads (appStitchedReads.ts). Shown and
279
+ * followed like any reference; never filtered, sorted, grouped or rolled
280
+ * up through.
281
+ */
282
+ stitched?: true;
283
+ }
284
+ /**
285
+ * A dialect's spelling of an `ON DELETE` action, normalised.
286
+ *
287
+ * Each engine words these differently — SQLite in prose, Postgres as
288
+ * a single character — and the difference is not interesting upstream. Shared
289
+ * so the adapters cannot drift on a value the delete dialog reads
290
+ * literally.
291
+ *
292
+ * Unrecognised returns undefined rather than a default: "the adapter did not
293
+ * report it" and "the constraint says NO ACTION" lead to different advice, and
294
+ * conflating them presents an unknown as harmless.
295
+ */
296
+ export declare function deleteRuleOf(raw: unknown): DeleteRule | undefined;
297
+ export interface DatabaseSchema {
298
+ /** What to call this connection in the UI. */
299
+ label: string;
300
+ /** Which adapter produced it, for dialect-specific affordances. */
301
+ dialect: Dialect;
302
+ tables: TableMeta[];
303
+ foreignKeys: ForeignKey[];
304
+ /** When this was read. Introspection is on connect, not on every request. */
305
+ readAt: string;
306
+ }
307
+ /** `http` is an API read through its description (src/adapters/http), not a database: no SQL reaches it. */
308
+ export type Dialect = 'postgres' | 'sqlite' | 'mssql' | 'http';
309
+ /** Diagrams and exports also accept authored shapes without introspection
310
+ metadata: the tables and keys, the rest optional. Named for what it is —
311
+ a subset of the introspected schema — and not `SchemaShape`, which is the
312
+ public veneer's table → columns map in packages/mistri/schema/app.d.ts. */
313
+ export type SchemaSubset = Pick<DatabaseSchema, 'tables' | 'foreignKeys'> & Partial<Pick<DatabaseSchema, 'label' | 'dialect' | 'readAt'>>;
314
+ /**
315
+ * Columns elsewhere that point at this table — the "what refers to me"
316
+ * question. Deliberately derived rather than stored, so it cannot drift from
317
+ * the foreign key list it is computed from.
318
+ */
319
+ /** A column of the table, or a rollup or a computed column its catalog serves (rollups.ts, computed.ts): what a measure may read. */
320
+ export declare function columnOrRollup(table: TableMeta, name: string): boolean;
321
+ export declare function referencesTo(schema: DatabaseSchema, tableId: string): ForeignKey[];
322
+ /** Columns on this table that point elsewhere. */
323
+ export declare function referencesFrom(schema: DatabaseSchema, tableId: string): ForeignKey[];
324
+ export declare function findTable(schema: DatabaseSchema, tableId: string): TableMeta | undefined;
325
+ /**
326
+ * A table by its id, or by a bare name when only one table has it.
327
+ *
328
+ * A table's id is qualified where the engine qualifies things — `public.customer`
329
+ * on Postgres — and nobody types that when there is
330
+ * only one `customer`. Ambiguity is left unresolved rather than guessed: two
331
+ * schemas with a `customer` each is exactly when picking one silently writes
332
+ * to the wrong database.
333
+ */
334
+ export declare function tableNamed(schema: DatabaseSchema, asked: string): TableMeta | undefined;
335
+ export declare function looksLikeDate(column: ColumnMeta): boolean;
336
+ /** The column that names each row by what it is called (`name`, `title`, `invoice_number`), never one picked only
337
+ because it is text: the label of a table that has one, for a caller that must not take a guess for a name. */
338
+ export declare function rowName(table: TableMeta): string | undefined;
339
+ export declare function labelColumn(table: TableMeta): string | undefined;
340
+ /** Primary key columns, in declaration order. */
341
+ export declare function primaryKey(table: TableMeta): string[];
342
+ /**
343
+ * Where a row's name lives, as a view path.
344
+ *
345
+ * `labelColumn` answers "which of this table's own columns reads best", and
346
+ * for a well-normalised table the honest answer is none of them: employee
347
+ * carries `party_id`, and the name is `party.display_name`, one table away.
348
+ * So when a table's best label is its own key, the question is asked one
349
+ * forward hop further before giving up — a tool whose whole idea is walking
350
+ * references should not call a person "30" when the walk it teaches would
351
+ * have found the name.
352
+ *
353
+ * The hop is taken only across a link that is plausibly one-to-one: a
354
+ * reference that *is* the whole primary key (the subtype pattern —
355
+ * `person.party_id PRIMARY KEY REFERENCES party` — one-to-one by
356
+ * construction), or a reference into an identity table. Not any reference
357
+ * with a name on the other end: `invoice.customer_id` reaches a perfectly
358
+ * good name that is not the invoice's — forty invoices share it, and a trail
359
+ * of rows all called "Dry Creek Vineyards" identifies nothing.
360
+ *
361
+ * A table with a real label of its own keeps it, so nothing changes where
362
+ * things already read well. Self-references are skipped: the manager's name
363
+ * is not this row's name.
364
+ */
365
+ export declare function labelPath(schema: DatabaseSchema, table: TableMeta, preferred?: string | false): string | undefined;
366
+ /**
367
+ * The order a column's values sort in when it is not their text: the
368
+ * vocabulary the database declares over a text column (`CHECK (stage IN
369
+ * ('new', 'qualified', 'won', 'lost'))`), in the order it was written. A
370
+ * pipeline sorted A → Z put "Closed lost" before "Qualification"; sorted as
371
+ * declared it reads as the pipeline does. A native enum (Postgres) is
372
+ * left alone, since the engine already orders it so, and free text has none.
373
+ * Every value the column can hold is in the list or NULL, which is what lets
374
+ * a page continue past one by naming the values after it (keysetPage.ts).
375
+ */
376
+ export declare function declaredOrder(column: Pick<ColumnMeta, 'type' | 'allowed'> | undefined): readonly string[] | undefined;
377
+ export interface Order {
378
+ column: string;
379
+ direction: 'asc' | 'desc';
380
+ }
381
+ /**
382
+ * The order a table's rows are shown in when the query does not say.
383
+ *
384
+ * There has to be one, and not for taste: `LIMIT`/`OFFSET` without `ORDER BY`
385
+ * has no defined order in either SQLite or Postgres, so paging through an
386
+ * unordered table can repeat a row on page two and never show another. The
387
+ * database is free to hand back rows in whatever order it finds them, and
388
+ * Postgres in particular will change its mind after an UPDATE moves a row.
389
+ * A default order is what makes "Next" mean what it appears to mean.
390
+ *
391
+ * Given that it must exist, it may as well be useful. In order of preference:
392
+ *
393
+ * 1. When the row was last touched, newest first — *if the column is
394
+ * indexed*. On a table with an indexed `updated_at`, "what changed
395
+ * recently" is what people open it to see, and the database can answer it
396
+ * by walking the index backwards.
397
+ * 2. When it was created, newest first, under the same condition.
398
+ * 3. A single numeric primary key, descending. On an autoincrement key that
399
+ * is the same "newest first" by proxy.
400
+ * 4. Any other primary key, ascending. A text key sorts alphabetically —
401
+ * `country` starting at ZW rather than AU would be perverse — and a
402
+ * composite key ascending groups its children under their parent, which
403
+ * is how `invoice_line` wants to be read.
404
+ * 5. The label column, then the first column: neither is meaningful, but
405
+ * both are deterministic, which is the part that matters.
406
+ *
407
+ * The index condition is the one rule here that is not about taste. A default
408
+ * that nobody asked for must not be a default that costs anything: `ORDER BY
409
+ * updated_at DESC LIMIT 20` on an unindexed column is a full scan and a sort
410
+ * of the whole table to return twenty rows, and it would happen on every table
411
+ * you clicked. The primary key is always indexed, which is why it is the
412
+ * fallback rather than merely one option among several.
413
+ *
414
+ * A table whose adapter does not report indexes at all gets the key, not a
415
+ * guess — `indexed` is undefined rather than empty in that case precisely so
416
+ * the two can be told apart.
417
+ */
418
+ export declare function defaultOrder(table: TableMeta): Order[];
419
+ /**
420
+ * Make an order total by appending the primary key.
421
+ *
422
+ * Sorting by `status` leaves every row with the same status in an undefined
423
+ * order relative to its neighbours — which is the paging bug again, one level
424
+ * down: page one and page two disagree about which of two equal rows comes
425
+ * first, so one is shown twice and one not at all. Appending the key breaks
426
+ * every remaining tie the same way each time.
427
+ *
428
+ * A table with no primary key cannot be made stable this way, and is left
429
+ * alone rather than given a guess.
430
+ */
431
+ export declare function withKey(table: TableMeta, order: Order[]): Order[];
432
+ /**
433
+ * The order to actually run with, and whether the caller asked for it.
434
+ *
435
+ * `implicit` is reported rather than hidden: the grid shows which column it
436
+ * sorted by, so a default order is something the reader can see and disagree
437
+ * with rather than a silent rearrangement of their data.
438
+ */
439
+ export declare function resolveOrder(table: TableMeta, requested: Order[] | undefined): {
440
+ order: Order[];
441
+ implicit: boolean;
442
+ };
443
+ /**
444
+ * Reconstruct a table's DDL from the catalog.
445
+ *
446
+ * This is a *reconstruction*, and callers must say so. It is built from what
447
+ * introspection captured — columns, types, nullability, defaults, keys — and
448
+ * therefore omits anything the model does not carry: indexes, check
449
+ * constraints, triggers, partitioning, storage parameters. Presenting it as
450
+ * the definitive `CREATE TABLE` would be a lie that bites the first time
451
+ * someone copies it into a migration.
452
+ *
453
+ * An adapter that can produce the database's own stored DDL should do so
454
+ * instead; `SqliteAdapter` does, because `sqlite_master` keeps the original
455
+ * statement text verbatim.
456
+ */
457
+ export declare function renderDDL(schema: DatabaseSchema, tableId: string): string;
458
+ export type ColumnKind = 'number' | 'boolean' | 'date' | 'text' | 'other';
459
+ export declare function columnKind(type: string): ColumnKind;
460
+ /**
461
+ * What an aggregate other than a count reads from a value of this type.
462
+ * PostgreSQL has no sum, average, minimum, maximum or percentile of a boolean
463
+ * ("function avg(boolean) does not exist"), where SQLite holds one as
464
+ * 0 and 1 and add it up; read as an integer there, a won rate is the same
465
+ * number on every engine, a computed yes-or-no or a stored one.
466
+ */
467
+ export declare function aggregateInput(read: string, type: string | undefined, dialect: string | undefined): string;
468
+ /** A column that holds yes or no: declared BOOLEAN, or an integer a CHECK pins to 0 and 1. */
469
+ export declare function isFlagColumn(column: (Pick<ColumnMeta, 'type'> & {
470
+ flag?: true;
471
+ }) | undefined): boolean;
472
+ /**
473
+ * How a column holds the moment something happened, the one rule every `now`
474
+ * the server writes follows (appStamps.ts): a DATE the App's day, a
475
+ * TIMESTAMP or DATETIME an instant (zoned or the App's wall clock), and a text
476
+ * column named for a moment — SQLite keeps dates as text — `_on` a day and
477
+ * `_at` an instant, in the digits the typed column would hold. Undefined for
478
+ * any other column, a TIME of day among them.
479
+ */
480
+ export declare function momentColumn(column: Pick<ColumnMeta, 'name' | 'type'>): 'date' | 'instant' | 'instant-zoned' | undefined;
481
+ /**
482
+ * The column a state stamps as the record enters it, by its name: `ready_at`
483
+ * (or `ready_on`) beside a `ready` state is written the moment the record
484
+ * moves there, whatever moves it — a verb, a Save, a command — unless the
485
+ * write says it itself. Never the machine's own column or its `since`, never a
486
+ * key, a number or a flag.
487
+ */
488
+ export declare function stateStampColumn(state: string, columns: readonly ColumnMeta[], machine: {
489
+ column: string;
490
+ since?: string;
491
+ }): ColumnMeta | undefined;
492
+ /**
493
+ * Turn a value on its way *into* the database into the right JavaScript type
494
+ * for its column.
495
+ *
496
+ * Everything typed into a text input arrives as a string, including "17901"
497
+ * for a REAL column. SQLite's type affinity usually rescues that, but not
498
+ * always — a column with BLOB affinity stores the characters — and Postgres
499
+ * rejects it outright. Either way the stored value should be a number because
500
+ * the column says so, not because the driver was forgiving.
501
+ *
502
+ * Unparseable input is passed through unchanged rather than coerced to NaN or
503
+ * 0. Letting the database reject "abc" for an integer column gives the user a
504
+ * real error; silently storing 0 gives them a wrong number.
505
+ *
506
+ * Only a number a double holds exactly becomes one. An id past 2^53 or a
507
+ * numeric wider than fifteen digits stays the text it was typed as, and the
508
+ * database parses it exactly: through Number(), "9007199254740993" was
509
+ * written as …992, a different row. And only plain decimal text is read as
510
+ * a number at all — Number() also reads "0x1A" as 26 and "1e3" as 1000,
511
+ * which is not what was typed; those go to the database as given too.
512
+ */
513
+ export declare function coerceForColumn(declaredType: string, value: string | number | boolean | null): string | number | boolean | null;
514
+ /** A column that holds bytes: BLOB (SQLite), bytea (Postgres), (VAR)BINARY. */
515
+ export declare function isBinaryType(type: string | undefined): boolean;
516
+ /** A column that holds a JSON document: json and jsonb (Postgres), JSON (SQLite by declaration). */
517
+ export declare function isJsonType(type: string | undefined): boolean;
518
+ /** A column whose stored value an update can be compared on (scoped/updateGuard.ts): not a document, bytes, an array or a geometry. */
519
+ export declare function comparableType(type: string | undefined): boolean;
520
+ /**
521
+ * What an update of `values` expects the record to hold still: each column
522
+ * it writes, as the list or record showed it (`row`). Sent as the update's
523
+ * `expected`, it makes the write a compare-and-set, so a save made on a row
524
+ * someone else has since changed is refused rather than written over theirs
525
+ * — the lost update a writer pool would otherwise let through (server
526
+ * writeLanes.ts). Undefined when the row does not hold every written column
527
+ * as a plain value of a comparable type: the write is then as blind as ever.
528
+ */
529
+ export declare function expectedValues(table: Pick<TableMeta, 'columns'>, values: Record<string, unknown>, row: Record<string, unknown> | undefined): Record<string, string | number | boolean | null> | undefined;