primitive-admin 1.2.0-alpha.14 → 1.2.0-alpha.15

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 (318) hide show
  1. package/README.md +102 -78
  2. package/assets/skill/skills/primitive-platform/SKILL.md +87 -23
  3. package/dist/bin/primitive.js +11 -82
  4. package/dist/bin/primitive.js.map +1 -1
  5. package/dist/src/commands/admins.js +79 -17
  6. package/dist/src/commands/admins.js.map +1 -1
  7. package/dist/src/commands/agent-sessions.js +2 -0
  8. package/dist/src/commands/agent-sessions.js.map +1 -1
  9. package/dist/src/commands/analytics.js +183 -12
  10. package/dist/src/commands/analytics.js.map +1 -1
  11. package/dist/src/commands/apps-children.js +2 -0
  12. package/dist/src/commands/apps-children.js.map +1 -1
  13. package/dist/src/commands/apps.js +19 -2
  14. package/dist/src/commands/apps.js.map +1 -1
  15. package/dist/src/commands/auth.js +11 -1
  16. package/dist/src/commands/auth.js.map +1 -1
  17. package/dist/src/commands/collections.js +13 -0
  18. package/dist/src/commands/collections.js.map +1 -1
  19. package/dist/src/commands/config.d.ts +1 -1
  20. package/dist/src/commands/config.js +40 -9
  21. package/dist/src/commands/config.js.map +1 -1
  22. package/dist/src/commands/connections.js +2 -0
  23. package/dist/src/commands/connections.js.map +1 -1
  24. package/dist/src/commands/database-type-configs.js +5 -3
  25. package/dist/src/commands/database-type-configs.js.map +1 -1
  26. package/dist/src/commands/databases.js +6 -4
  27. package/dist/src/commands/databases.js.map +1 -1
  28. package/dist/src/commands/db3-types.js +2 -0
  29. package/dist/src/commands/db3-types.js.map +1 -1
  30. package/dist/src/commands/db3.d.ts +12 -0
  31. package/dist/src/commands/db3.js +343 -24
  32. package/dist/src/commands/db3.js.map +1 -1
  33. package/dist/src/commands/documents.d.ts +52 -12
  34. package/dist/src/commands/documents.js +120 -29
  35. package/dist/src/commands/documents.js.map +1 -1
  36. package/dist/src/commands/email-templates.js +72 -0
  37. package/dist/src/commands/email-templates.js.map +1 -1
  38. package/dist/src/commands/functions.js +47 -10
  39. package/dist/src/commands/functions.js.map +1 -1
  40. package/dist/src/commands/groups.js +18 -3
  41. package/dist/src/commands/groups.js.map +1 -1
  42. package/dist/src/commands/init.js +7 -1
  43. package/dist/src/commands/init.js.map +1 -1
  44. package/dist/src/commands/integrations.js +80 -47
  45. package/dist/src/commands/integrations.js.map +1 -1
  46. package/dist/src/commands/metadata-category-configs.js +2 -0
  47. package/dist/src/commands/metadata-category-configs.js.map +1 -1
  48. package/dist/src/commands/metadata.js +41 -0
  49. package/dist/src/commands/metadata.js.map +1 -1
  50. package/dist/src/commands/prompts.js +73 -47
  51. package/dist/src/commands/prompts.js.map +1 -1
  52. package/dist/src/commands/rule-sets.js +2 -0
  53. package/dist/src/commands/rule-sets.js.map +1 -1
  54. package/dist/src/commands/schemas.d.ts +15 -0
  55. package/dist/src/commands/schemas.js +122 -0
  56. package/dist/src/commands/schemas.js.map +1 -0
  57. package/dist/src/commands/secrets.js +45 -3
  58. package/dist/src/commands/secrets.js.map +1 -1
  59. package/dist/src/commands/sessions.js +2 -0
  60. package/dist/src/commands/sessions.js.map +1 -1
  61. package/dist/src/commands/sync-schemas.d.ts +202 -0
  62. package/dist/src/commands/sync-schemas.js +629 -0
  63. package/dist/src/commands/sync-schemas.js.map +1 -0
  64. package/dist/src/commands/sync-user-properties.d.ts +118 -0
  65. package/dist/src/commands/sync-user-properties.js +276 -0
  66. package/dist/src/commands/sync-user-properties.js.map +1 -0
  67. package/dist/src/commands/sync.d.ts +243 -12
  68. package/dist/src/commands/sync.js +1474 -314
  69. package/dist/src/commands/sync.js.map +1 -1
  70. package/dist/src/commands/user-properties.d.ts +14 -0
  71. package/dist/src/commands/user-properties.js +79 -0
  72. package/dist/src/commands/user-properties.js.map +1 -0
  73. package/dist/src/commands/users.js +879 -16
  74. package/dist/src/commands/users.js.map +1 -1
  75. package/dist/src/commands/waitlist.js +39 -4
  76. package/dist/src/commands/waitlist.js.map +1 -1
  77. package/dist/src/lib/analytics-query.d.ts +58 -0
  78. package/dist/src/lib/analytics-query.js +134 -0
  79. package/dist/src/lib/analytics-query.js.map +1 -0
  80. package/dist/src/lib/api-client.d.ts +748 -95
  81. package/dist/src/lib/api-client.js +356 -158
  82. package/dist/src/lib/api-client.js.map +1 -1
  83. package/dist/src/lib/block-selector.d.ts +9 -15
  84. package/dist/src/lib/block-selector.js +9 -20
  85. package/dist/src/lib/block-selector.js.map +1 -1
  86. package/dist/src/lib/cli-manifest.d.ts +8 -0
  87. package/dist/src/lib/cli-manifest.js +10 -1
  88. package/dist/src/lib/cli-manifest.js.map +1 -1
  89. package/dist/src/lib/cli-version.d.ts +14 -0
  90. package/dist/src/lib/cli-version.js +38 -0
  91. package/dist/src/lib/cli-version.js.map +1 -0
  92. package/dist/src/lib/codegen-shared/prettierStable.d.ts +41 -0
  93. package/dist/src/lib/codegen-shared/prettierStable.js +146 -24
  94. package/dist/src/lib/codegen-shared/prettierStable.js.map +1 -1
  95. package/dist/src/lib/command-status.d.ts +110 -0
  96. package/dist/src/lib/command-status.js +184 -0
  97. package/dist/src/lib/command-status.js.map +1 -0
  98. package/dist/src/lib/config-object-descriptor.d.ts +6 -0
  99. package/dist/src/lib/config-object-descriptor.js +71 -0
  100. package/dist/src/lib/config-object-descriptor.js.map +1 -1
  101. package/dist/src/lib/config-toml.d.ts +11 -2
  102. package/dist/src/lib/config-toml.js +25 -2
  103. package/dist/src/lib/config-toml.js.map +1 -1
  104. package/dist/src/lib/data-input.d.ts +1 -1
  105. package/dist/src/lib/data-input.js +1 -1
  106. package/dist/src/lib/db-codegen/dbTsTypes.d.ts +1 -1
  107. package/dist/src/lib/db-codegen/dbTsTypes.js +3 -0
  108. package/dist/src/lib/db-codegen/dbTsTypes.js.map +1 -1
  109. package/dist/src/lib/db-codegen/dbTypeIR.d.ts +11 -1
  110. package/dist/src/lib/db-codegen/dbTypeIR.js +11 -5
  111. package/dist/src/lib/db-codegen/dbTypeIR.js.map +1 -1
  112. package/dist/src/lib/db-type-records.d.ts +95 -0
  113. package/dist/src/lib/db-type-records.js +219 -0
  114. package/dist/src/lib/db-type-records.js.map +1 -0
  115. package/dist/src/lib/db3-export.d.ts +51 -14
  116. package/dist/src/lib/db3-export.js +135 -27
  117. package/dist/src/lib/db3-export.js.map +1 -1
  118. package/dist/src/lib/db3-index-output.d.ts +68 -3
  119. package/dist/src/lib/db3-index-output.js +139 -3
  120. package/dist/src/lib/db3-index-output.js.map +1 -1
  121. package/dist/src/lib/db3-type-models.d.ts +39 -7
  122. package/dist/src/lib/db3-type-models.js +138 -27
  123. package/dist/src/lib/db3-type-models.js.map +1 -1
  124. package/dist/src/lib/deprecation.d.ts +2 -2
  125. package/dist/src/lib/deprecation.js +2 -2
  126. package/dist/src/lib/experimental-apis.d.ts +36 -0
  127. package/dist/src/lib/experimental-apis.js +46 -0
  128. package/dist/src/lib/experimental-apis.js.map +1 -0
  129. package/dist/src/lib/file-attachment.d.ts +24 -0
  130. package/dist/src/lib/file-attachment.js +31 -0
  131. package/dist/src/lib/file-attachment.js.map +1 -0
  132. package/dist/src/lib/function-authorize-check.d.ts +1 -1
  133. package/dist/src/lib/function-authorize-check.js +2 -1
  134. package/dist/src/lib/function-authorize-check.js.map +1 -1
  135. package/dist/src/lib/function-authorize-view.js +4 -0
  136. package/dist/src/lib/function-authorize-view.js.map +1 -1
  137. package/dist/src/lib/function-bundle.d.ts +27 -5
  138. package/dist/src/lib/function-bundle.js +106 -7
  139. package/dist/src/lib/function-bundle.js.map +1 -1
  140. package/dist/src/lib/function-collect.d.ts +2 -0
  141. package/dist/src/lib/function-collect.js +36 -7
  142. package/dist/src/lib/function-collect.js.map +1 -1
  143. package/dist/src/lib/function-db-types.d.ts +57 -40
  144. package/dist/src/lib/function-db-types.js +246 -285
  145. package/dist/src/lib/function-db-types.js.map +1 -1
  146. package/dist/src/lib/function-document-types.d.ts +19 -7
  147. package/dist/src/lib/function-document-types.js +24 -12
  148. package/dist/src/lib/function-document-types.js.map +1 -1
  149. package/dist/src/lib/function-run.d.ts +1 -1
  150. package/dist/src/lib/function-run.js +1 -1
  151. package/dist/src/lib/function-run.js.map +1 -1
  152. package/dist/src/lib/function-schema-codegen.d.ts +58 -18
  153. package/dist/src/lib/function-schema-codegen.js +85 -74
  154. package/dist/src/lib/function-schema-codegen.js.map +1 -1
  155. package/dist/src/lib/function-schema-refs.d.ts +98 -0
  156. package/dist/src/lib/function-schema-refs.js +177 -0
  157. package/dist/src/lib/function-schema-refs.js.map +1 -0
  158. package/dist/src/lib/function-sync.d.ts +38 -4
  159. package/dist/src/lib/function-sync.js +83 -14
  160. package/dist/src/lib/function-sync.js.map +1 -1
  161. package/dist/src/lib/function-typecheck.d.ts +52 -0
  162. package/dist/src/lib/function-typecheck.js +171 -54
  163. package/dist/src/lib/function-typecheck.js.map +1 -1
  164. package/dist/src/lib/generated-build-flags.d.ts +13 -0
  165. package/dist/src/lib/generated-build-flags.js +14 -0
  166. package/dist/src/lib/generated-build-flags.js.map +1 -0
  167. package/dist/src/lib/generated-config-surfaces.d.ts +211 -11
  168. package/dist/src/lib/generated-config-surfaces.js +579 -69
  169. package/dist/src/lib/generated-config-surfaces.js.map +1 -1
  170. package/dist/src/lib/generated-sdk-types.d.ts +1 -1
  171. package/dist/src/lib/generated-sdk-types.js +1 -1
  172. package/dist/src/lib/generated-sdk-types.js.map +1 -1
  173. package/dist/src/lib/integration-test-request.d.ts +54 -0
  174. package/dist/src/lib/integration-test-request.js +207 -0
  175. package/dist/src/lib/integration-test-request.js.map +1 -0
  176. package/dist/src/lib/metadata-report.d.ts +85 -0
  177. package/dist/src/lib/metadata-report.js +81 -0
  178. package/dist/src/lib/metadata-report.js.map +1 -0
  179. package/dist/src/lib/output.d.ts +1 -1
  180. package/dist/src/lib/output.js +1 -1
  181. package/dist/src/lib/platform-owned.js +5 -0
  182. package/dist/src/lib/platform-owned.js.map +1 -1
  183. package/dist/src/lib/primitive-declaration-names.d.ts +21 -0
  184. package/dist/src/lib/primitive-declaration-names.js +22 -0
  185. package/dist/src/lib/primitive-declaration-names.js.map +1 -0
  186. package/dist/src/lib/primitive-declaration.d.ts +143 -0
  187. package/dist/src/lib/primitive-declaration.js +658 -0
  188. package/dist/src/lib/primitive-declaration.js.map +1 -0
  189. package/dist/src/lib/prompt-schema-codegen.d.ts +36 -12
  190. package/dist/src/lib/prompt-schema-codegen.js +82 -98
  191. package/dist/src/lib/prompt-schema-codegen.js.map +1 -1
  192. package/dist/src/lib/prompt-schema-document.d.ts +35 -0
  193. package/dist/src/lib/prompt-schema-document.js +92 -0
  194. package/dist/src/lib/prompt-schema-document.js.map +1 -0
  195. package/dist/src/lib/prompt-schema-refs.d.ts +164 -0
  196. package/dist/src/lib/prompt-schema-refs.js +452 -0
  197. package/dist/src/lib/prompt-schema-refs.js.map +1 -0
  198. package/dist/src/lib/records-verbs.d.ts +12 -2
  199. package/dist/src/lib/records-verbs.js +7 -2
  200. package/dist/src/lib/records-verbs.js.map +1 -1
  201. package/dist/src/lib/register-commands.d.ts +28 -0
  202. package/dist/src/lib/register-commands.js +101 -0
  203. package/dist/src/lib/register-commands.js.map +1 -0
  204. package/dist/src/lib/retired-imports.d.ts +53 -0
  205. package/dist/src/lib/retired-imports.js +120 -0
  206. package/dist/src/lib/retired-imports.js.map +1 -0
  207. package/dist/src/lib/schema-codegen/compiledSpace.d.ts +62 -0
  208. package/dist/src/lib/schema-codegen/compiledSpace.js +103 -0
  209. package/dist/src/lib/schema-codegen/compiledSpace.js.map +1 -0
  210. package/dist/src/lib/schema-codegen/generated-db3-bridge.d.ts +86 -0
  211. package/dist/src/lib/schema-codegen/generated-db3-bridge.js +221 -0
  212. package/dist/src/lib/schema-codegen/generated-db3-bridge.js.map +1 -0
  213. package/dist/src/lib/schema-codegen/generated-db3-query-capabilities.d.ts +85 -0
  214. package/dist/src/lib/schema-codegen/generated-db3-query-capabilities.js +86 -0
  215. package/dist/src/lib/schema-codegen/generated-db3-query-capabilities.js.map +1 -0
  216. package/dist/src/lib/schema-codegen/generated-field-grammar.d.ts +209 -0
  217. package/dist/src/lib/schema-codegen/generated-field-grammar.js +379 -0
  218. package/dist/src/lib/schema-codegen/generated-field-grammar.js.map +1 -0
  219. package/dist/src/lib/schema-codegen/generated-field-table.d.ts +80 -0
  220. package/dist/src/lib/schema-codegen/generated-field-table.js +542 -0
  221. package/dist/src/lib/schema-codegen/generated-field-table.js.map +1 -0
  222. package/dist/src/lib/schema-codegen/generated-prompt-schemas.d.ts +195 -0
  223. package/dist/src/lib/schema-codegen/generated-prompt-schemas.js +503 -0
  224. package/dist/src/lib/schema-codegen/generated-prompt-schemas.js.map +1 -0
  225. package/dist/src/lib/schema-codegen/generated-schema-descriptor.d.ts +129 -0
  226. package/dist/src/lib/schema-codegen/generated-schema-descriptor.js +154 -1
  227. package/dist/src/lib/schema-codegen/generated-schema-descriptor.js.map +1 -1
  228. package/dist/src/lib/schema-codegen/generated-schema-file.d.ts +129 -0
  229. package/dist/src/lib/schema-codegen/generated-schema-file.js +475 -0
  230. package/dist/src/lib/schema-codegen/generated-schema-file.js.map +1 -0
  231. package/dist/src/lib/schema-codegen/generated-schema-provenance.d.ts +115 -0
  232. package/dist/src/lib/schema-codegen/generated-schema-provenance.js +274 -0
  233. package/dist/src/lib/schema-codegen/generated-schema-provenance.js.map +1 -0
  234. package/dist/src/lib/schema-codegen/generated-schema-refs.d.ts +366 -0
  235. package/dist/src/lib/schema-codegen/generated-schema-refs.js +1789 -0
  236. package/dist/src/lib/schema-codegen/generated-schema-refs.js.map +1 -0
  237. package/dist/src/lib/schema-codegen/namedRefs.d.ts +56 -0
  238. package/dist/src/lib/schema-codegen/namedRefs.js +143 -0
  239. package/dist/src/lib/schema-codegen/namedRefs.js.map +1 -0
  240. package/dist/src/lib/schema-codegen/schemaChanges.d.ts +74 -0
  241. package/dist/src/lib/schema-codegen/schemaChanges.js +277 -0
  242. package/dist/src/lib/schema-codegen/schemaChanges.js.map +1 -0
  243. package/dist/src/lib/schema-codegen/schemaDocs.d.ts +69 -0
  244. package/dist/src/lib/schema-codegen/schemaDocs.js +219 -0
  245. package/dist/src/lib/schema-codegen/schemaDocs.js.map +1 -0
  246. package/dist/src/lib/schema-codegen/schemaIR.d.ts +158 -0
  247. package/dist/src/lib/schema-codegen/schemaIR.js +279 -0
  248. package/dist/src/lib/schema-codegen/schemaIR.js.map +1 -0
  249. package/dist/src/lib/schema-codegen/schemaToTs.d.ts +40 -13
  250. package/dist/src/lib/schema-codegen/schemaToTs.js +124 -160
  251. package/dist/src/lib/schema-codegen/schemaToTs.js.map +1 -1
  252. package/dist/src/lib/schema-codegen/valuesLists.d.ts +35 -0
  253. package/dist/src/lib/schema-codegen/valuesLists.js +128 -0
  254. package/dist/src/lib/schema-codegen/valuesLists.js.map +1 -0
  255. package/dist/src/lib/schema-family-index.d.ts +228 -0
  256. package/dist/src/lib/schema-family-index.js +813 -0
  257. package/dist/src/lib/schema-family-index.js.map +1 -0
  258. package/dist/src/lib/schema-pins.d.ts +82 -0
  259. package/dist/src/lib/schema-pins.js +198 -0
  260. package/dist/src/lib/schema-pins.js.map +1 -0
  261. package/dist/src/lib/schema-preview.d.ts +244 -0
  262. package/dist/src/lib/schema-preview.js +498 -0
  263. package/dist/src/lib/schema-preview.js.map +1 -0
  264. package/dist/src/lib/skill-installer.d.ts +2 -2
  265. package/dist/src/lib/skill-installer.js +2 -21
  266. package/dist/src/lib/skill-installer.js.map +1 -1
  267. package/dist/src/lib/step-run-table.d.ts +1 -2
  268. package/dist/src/lib/step-run-table.js +1 -2
  269. package/dist/src/lib/step-run-table.js.map +1 -1
  270. package/dist/src/lib/swift-codegen/agentGenerator.d.ts +2 -1
  271. package/dist/src/lib/swift-codegen/agentGenerator.js +24 -22
  272. package/dist/src/lib/swift-codegen/agentGenerator.js.map +1 -1
  273. package/dist/src/lib/swift-codegen/banners.d.ts +12 -0
  274. package/dist/src/lib/swift-codegen/banners.js +12 -0
  275. package/dist/src/lib/swift-codegen/banners.js.map +1 -1
  276. package/dist/src/lib/swift-codegen/functionGenerator.d.ts +36 -1
  277. package/dist/src/lib/swift-codegen/functionGenerator.js +167 -50
  278. package/dist/src/lib/swift-codegen/functionGenerator.js.map +1 -1
  279. package/dist/src/lib/swift-codegen/schemaToSwift.d.ts +31 -7
  280. package/dist/src/lib/swift-codegen/schemaToSwift.js +213 -177
  281. package/dist/src/lib/swift-codegen/schemaToSwift.js.map +1 -1
  282. package/dist/src/lib/swift-codegen/sharedGenerator.d.ts +45 -0
  283. package/dist/src/lib/swift-codegen/sharedGenerator.js +120 -0
  284. package/dist/src/lib/swift-codegen/sharedGenerator.js.map +1 -0
  285. package/dist/src/lib/swift-codegen/userPropertiesGenerator.d.ts +30 -0
  286. package/dist/src/lib/swift-codegen/userPropertiesGenerator.js +69 -0
  287. package/dist/src/lib/swift-codegen/userPropertiesGenerator.js.map +1 -0
  288. package/dist/src/lib/sync-resource-types.d.ts +37 -5
  289. package/dist/src/lib/sync-resource-types.js +53 -5
  290. package/dist/src/lib/sync-resource-types.js.map +1 -1
  291. package/dist/src/lib/sync-selectors.d.ts +7 -0
  292. package/dist/src/lib/sync-selectors.js +22 -2
  293. package/dist/src/lib/sync-selectors.js.map +1 -1
  294. package/dist/src/lib/test-runs.d.ts +45 -0
  295. package/dist/src/lib/test-runs.js +150 -0
  296. package/dist/src/lib/test-runs.js.map +1 -0
  297. package/dist/src/lib/toml-database-config.d.ts +2 -1
  298. package/dist/src/lib/toml-database-config.js +4 -3
  299. package/dist/src/lib/toml-database-config.js.map +1 -1
  300. package/dist/src/lib/toml-scalar-edit.js +6 -4
  301. package/dist/src/lib/toml-scalar-edit.js.map +1 -1
  302. package/dist/src/lib/user-index.d.ts +80 -0
  303. package/dist/src/lib/user-index.js +166 -0
  304. package/dist/src/lib/user-index.js.map +1 -0
  305. package/dist/src/lib/user-properties/generated-properties-schema.d.ts +159 -0
  306. package/dist/src/lib/user-properties/generated-properties-schema.js +471 -0
  307. package/dist/src/lib/user-properties/generated-properties-schema.js.map +1 -0
  308. package/dist/src/lib/user-properties/user-properties-codegen.d.ts +55 -0
  309. package/dist/src/lib/user-properties/user-properties-codegen.js +129 -0
  310. package/dist/src/lib/user-properties/user-properties-codegen.js.map +1 -0
  311. package/dist/src/lib/user-walk.d.ts +31 -0
  312. package/dist/src/lib/user-walk.js +102 -0
  313. package/dist/src/lib/user-walk.js.map +1 -0
  314. package/dist/src/lib/worker-perf-format.d.ts +22 -0
  315. package/dist/src/lib/worker-perf-format.js +27 -0
  316. package/dist/src/lib/worker-perf-format.js.map +1 -0
  317. package/dist/src/types/index.d.ts +13 -34
  318. package/package.json +5 -3
@@ -0,0 +1,277 @@
1
+ /**
2
+ * The schema change classifier `config diff` reads (#5543, project
3
+ * `unified-schemas` phase 9, criterion 11).
4
+ *
5
+ * `classifySchemaChange(stored, local)` compares a stored compiled schema with
6
+ * the local one a push would send, keyword by keyword, and classifies each
7
+ * change from the keyword table's `tightens` and `extractor` columns:
8
+ *
9
+ * - `breaking`: the change narrows what the schema accepts on a row the
10
+ * merge gate's breaking-change extractor compares (`type`, `enum`,
11
+ * `required`, `properties`, `items`, `format`, `$ref`, the applicators);
12
+ * - `tightening`: it narrows what the schema accepts on any other row
13
+ * (`minimum`, `pattern`, `nullable`, `additionalProperties`, …);
14
+ * - `additive`: anything else (a loosening, an annotation, a key that is not
15
+ * a row).
16
+ *
17
+ * The extractor's own structural rules are applied as it applies them, so the
18
+ * classifier never answers `additive` where the gate answers breaking: `type`
19
+ * compares exactly (a union reorder is a change), `oneOf`, `anyOf` and
20
+ * `allOf` compare as whole subtrees, any difference at a node that carries
21
+ * `$ref` beside another key is breaking, and every change in a schema whose
22
+ * stored side holds an object or array `enum` member is breaking (the gate's
23
+ * membership test cannot find such a member). Direction is not distinguished:
24
+ * a newly required output property is breaking too.
25
+ */
26
+ import { SCHEMA_KEYWORDS } from "./generated-schema-descriptor.js";
27
+ /** The classes a change is given, weakest first. */
28
+ export const SCHEMA_CHANGE_CLASSES = Object.freeze(["additive", "tightening", "breaking"]);
29
+ /** The reason a change under a non-scalar stored `enum` is breaking. */
30
+ export const NON_SCALAR_ENUM_REASON = "non-scalar enum members cannot be compared by the gate";
31
+ function isObject(value) {
32
+ return value !== null && typeof value === "object" && !Array.isArray(value);
33
+ }
34
+ function hasOwn(value, key) {
35
+ return Object.prototype.hasOwnProperty.call(value, key);
36
+ }
37
+ function rowOf(keyword) {
38
+ return hasOwn(SCHEMA_KEYWORDS, keyword) ? SCHEMA_KEYWORDS[keyword] : undefined;
39
+ }
40
+ /** JSON with object keys sorted, so a key reorder is no change. */
41
+ function canonical(value) {
42
+ if (Array.isArray(value))
43
+ return `[${value.map(canonical).join(",")}]`;
44
+ if (isObject(value)) {
45
+ return `{${Object.keys(value)
46
+ .sort()
47
+ .map((key) => `${JSON.stringify(key)}:${canonical(value[key])}`)
48
+ .join(",")}}`;
49
+ }
50
+ return JSON.stringify(value) ?? "undefined";
51
+ }
52
+ const exact = (value) => JSON.stringify(value) ?? "undefined";
53
+ function members(list) {
54
+ return new Set(list.map(canonical));
55
+ }
56
+ /** The keywords compared as sets of members: a reorder is no change. */
57
+ const SET_KEYWORDS = new Set(["enum", "required"]);
58
+ function same(keyword, stored, local) {
59
+ if (SET_KEYWORDS.has(keyword) && Array.isArray(stored) && Array.isArray(local)) {
60
+ const a = members(stored);
61
+ const b = members(local);
62
+ return a.size === b.size && [...a].every((member) => b.has(member));
63
+ }
64
+ // The rows the gate compares are compared as it compares them: exactly.
65
+ return rowOf(keyword)?.extractor ? exact(stored) === exact(local) : canonical(stored) === canonical(local);
66
+ }
67
+ /** Whether a difference narrows what the schema accepts, in the row's direction. */
68
+ function tightensIn(direction, keyword, stored, local) {
69
+ switch (direction) {
70
+ case "raise":
71
+ case "lower":
72
+ if (local === undefined)
73
+ return false;
74
+ if (typeof stored !== "number" || typeof local !== "number")
75
+ return true;
76
+ return direction === "raise" ? local > stored : local < stored;
77
+ case "add": {
78
+ if (local === undefined)
79
+ return false;
80
+ if (!Array.isArray(local))
81
+ return true;
82
+ const before = Array.isArray(stored) ? members(stored) : new Set();
83
+ return local.some((member) => !before.has(canonical(member)));
84
+ }
85
+ case "remove": {
86
+ if (keyword === "properties") {
87
+ // A first map declares optional properties: nothing narrows.
88
+ if (stored === undefined)
89
+ return false;
90
+ if (!isObject(stored))
91
+ return true;
92
+ const after = isObject(local) ? local : {};
93
+ return Object.keys(stored).some((name) => !hasOwn(after, name));
94
+ }
95
+ // A list where there was none narrows from any value to the list; a
96
+ // list removed counts every member as gone, as the gate counts them.
97
+ if (stored === undefined || !Array.isArray(stored))
98
+ return true;
99
+ if (local !== undefined && !Array.isArray(local))
100
+ return true;
101
+ const after = members(Array.isArray(local) ? local : []);
102
+ return stored.some((member) => !after.has(canonical(member)));
103
+ }
104
+ case "set":
105
+ return local !== undefined;
106
+ case "on":
107
+ return local === true && stored !== true;
108
+ case "off":
109
+ return stored === true && local !== true;
110
+ case "close":
111
+ return (local === false || isObject(local)) && (stored === undefined || stored === true || isObject(stored));
112
+ case "any":
113
+ return true;
114
+ case "never":
115
+ return false;
116
+ }
117
+ }
118
+ /**
119
+ * How one keyword changed between the stored and the local value (either may
120
+ * be `undefined`, for absent): `none` when equal, `tightens` when the change
121
+ * narrows what the schema accepts in the row's `tightens` direction, and
122
+ * `loosens` otherwise. A key that is not a row never tightens.
123
+ */
124
+ export function keywordChange(keyword, stored, local) {
125
+ if (same(keyword, stored, local))
126
+ return "none";
127
+ const direction = rowOf(keyword)?.tightens ?? "never";
128
+ return tightensIn(direction, keyword, stored, local) ? "tightens" : "loosens";
129
+ }
130
+ /** The strongest of `classes` (`breaking > tightening > additive`); null when none is given. */
131
+ export function maxChangeClass(...classes) {
132
+ let strongest = -1;
133
+ for (const cls of classes) {
134
+ if (cls)
135
+ strongest = Math.max(strongest, SCHEMA_CHANGE_CLASSES.indexOf(cls));
136
+ }
137
+ return strongest < 0 ? null : SCHEMA_CHANGE_CLASSES[strongest];
138
+ }
139
+ const escapePointer = (segment) => segment.replace(/~/g, "~0").replace(/\//g, "~1");
140
+ function brief(value) {
141
+ const text = exact(value);
142
+ return text.length > 40 ? `${text.slice(0, 37)}…` : text;
143
+ }
144
+ function describe(keyword, stored, local) {
145
+ if (stored === undefined)
146
+ return `${keyword} set to ${brief(local)}`;
147
+ if (local === undefined)
148
+ return `${keyword} removed`;
149
+ if (SET_KEYWORDS.has(keyword) && Array.isArray(stored) && Array.isArray(local)) {
150
+ const before = members(stored);
151
+ const after = members(local);
152
+ const gone = stored.filter((member) => !after.has(canonical(member)));
153
+ const added = local.filter((member) => !before.has(canonical(member)));
154
+ const parts = keyword === "enum"
155
+ ? [...gone.map((member) => `enum value ${brief(member)} removed`), ...added.map((member) => `enum value ${brief(member)} added`)]
156
+ : [...added.map((member) => `${brief(member)} required`), ...gone.map((member) => `${brief(member)} no longer required`)];
157
+ if (parts.length > 0)
158
+ return parts.join(", ");
159
+ }
160
+ return `${keyword} ${brief(stored)} → ${brief(local)}`;
161
+ }
162
+ /** A node the gate reads only as a whole: `$ref` beside another key. */
163
+ function constrainedRef(node) {
164
+ return hasOwn(node, "$ref") && Object.keys(node).length > 1;
165
+ }
166
+ function compareNode(stored, local, pointer, out) {
167
+ if (exact(stored) === exact(local))
168
+ return;
169
+ if (isObject(stored) && !isObject(local)) {
170
+ out.push({ pointer, keyword: "(schema)", class: "breaking", detail: local === undefined ? "removed" : `replaced by ${brief(local)}` });
171
+ return;
172
+ }
173
+ if (!isObject(stored)) {
174
+ // A boolean (or malformed) stored schema: only `true`, or nothing, accepts as much.
175
+ out.push({ pointer, keyword: "(schema)", class: local === true ? "additive" : "tightening", detail: `${brief(stored)} → ${brief(local)}` });
176
+ return;
177
+ }
178
+ const node = local;
179
+ if (constrainedRef(stored) || constrainedRef(node)) {
180
+ out.push({ pointer, keyword: "$ref", class: "breaking", detail: "changed beside a $ref (compared as a whole)" });
181
+ return;
182
+ }
183
+ const keys = [...Object.keys(stored), ...Object.keys(node).filter((key) => !hasOwn(stored, key))];
184
+ for (const key of keys) {
185
+ const before = hasOwn(stored, key) ? stored[key] : undefined;
186
+ const after = hasOwn(node, key) ? node[key] : undefined;
187
+ if (key === "properties" && (before === undefined || isObject(before)) && (after === undefined || isObject(after))) {
188
+ const was = (before ?? {});
189
+ const now = (after ?? {});
190
+ for (const name of Object.keys(was)) {
191
+ const at = `${pointer}/properties/${escapePointer(name)}`;
192
+ if (!hasOwn(now, name))
193
+ out.push({ pointer: at, keyword: "properties", class: "breaking", detail: `property ${JSON.stringify(name)} removed` });
194
+ else
195
+ compareNode(was[name], now[name], at, out);
196
+ }
197
+ for (const name of Object.keys(now)) {
198
+ if (!hasOwn(was, name)) {
199
+ out.push({ pointer: `${pointer}/properties/${escapePointer(name)}`, keyword: "properties", class: "additive", detail: `property ${JSON.stringify(name)} added` });
200
+ }
201
+ }
202
+ continue;
203
+ }
204
+ if (key === "items" && isObject(before) && isObject(after)) {
205
+ compareNode(before, after, `${pointer}/items`, out);
206
+ continue;
207
+ }
208
+ const change = keywordChange(key, before, after);
209
+ if (change === "none")
210
+ continue;
211
+ const cls = change === "tightens" ? (rowOf(key)?.extractor ? "breaking" : "tightening") : "additive";
212
+ out.push({ pointer, keyword: key, class: cls, detail: describe(key, before, after) });
213
+ }
214
+ }
215
+ /**
216
+ * The first node the gate descends to (the root, each property, `items`) whose
217
+ * value the gate's identity comparisons can never match when both sides are
218
+ * parsed separately: an `enum` with an object or array member, or a non-string
219
+ * `format` or `$ref`.
220
+ */
221
+ function gateBlindSpot(node, pointer) {
222
+ if (!isObject(node))
223
+ return null;
224
+ if (Array.isArray(node.enum) && node.enum.some((member) => member !== null && typeof member === "object"))
225
+ return { pointer, keyword: "enum" };
226
+ for (const keyword of ["format", "$ref"]) {
227
+ if (hasOwn(node, keyword) && node[keyword] !== null && typeof node[keyword] === "object")
228
+ return { pointer, keyword };
229
+ }
230
+ if (isObject(node.properties)) {
231
+ for (const [name, child] of Object.entries(node.properties)) {
232
+ const found = gateBlindSpot(child, `${pointer}/properties/${escapePointer(name)}`);
233
+ if (found)
234
+ return found;
235
+ }
236
+ }
237
+ return gateBlindSpot(node.items, `${pointer}/items`);
238
+ }
239
+ /**
240
+ * Classify the changes from the `stored` compiled schema to the `local` one
241
+ * (`undefined` for a side that declares none). A slot the local side no
242
+ * longer declares is cleared by push and is breaking; a slot the stored side
243
+ * lacks is compared against the empty schema, unless its owner is new
244
+ * (`options.newOwner`), when it is additive.
245
+ */
246
+ export function classifySchemaChange(stored, local, options = {}) {
247
+ if (stored === undefined && local === undefined)
248
+ return { class: null, changes: [] };
249
+ const changes = [];
250
+ if (local === undefined) {
251
+ changes.push({ pointer: "", keyword: "(slot)", class: "breaking", detail: "cleared by push" });
252
+ }
253
+ else if (stored === undefined) {
254
+ if (options.newOwner) {
255
+ changes.push({ pointer: "", keyword: "(slot)", class: "additive", detail: "declared with its owner" });
256
+ }
257
+ else {
258
+ compareNode({}, local, "", changes);
259
+ if (changes.length === 0)
260
+ changes.push({ pointer: "", keyword: "(slot)", class: "additive", detail: "declared" });
261
+ }
262
+ }
263
+ else {
264
+ compareNode(stored, local, "", changes);
265
+ const blind = changes.length > 0 ? gateBlindSpot(stored, "") : null;
266
+ if (blind) {
267
+ changes.push({
268
+ pointer: blind.pointer,
269
+ keyword: blind.keyword,
270
+ class: "breaking",
271
+ detail: blind.keyword === "enum" ? NON_SCALAR_ENUM_REASON : `a non-string ${blind.keyword} cannot be compared by the gate`,
272
+ });
273
+ }
274
+ }
275
+ return { class: maxChangeClass(...changes.map((change) => change.class)), changes };
276
+ }
277
+ //# sourceMappingURL=schemaChanges.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schemaChanges.js","sourceRoot":"","sources":["../../../../src/lib/schema-codegen/schemaChanges.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EAAE,eAAe,EAA8B,MAAM,kCAAkC,CAAC;AAE/F,oDAAoD;AACpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,YAAY,EAAE,UAAU,CAAU,CAAC,CAAC;AAmCpG,wEAAwE;AACxE,MAAM,CAAC,MAAM,sBAAsB,GAAG,wDAAwD,CAAC;AAE/F,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,MAAM,CAAC,KAAa,EAAE,GAAW;IACxC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,KAAK,CAAC,OAAe;IAC5B,OAAO,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACjF,CAAC;AAED,mEAAmE;AACnE,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IACvE,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aAC1B,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;aAC/D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClB,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC;AAC9C,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC;AAE/E,SAAS,OAAO,CAAC,IAAe;IAC9B,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,wEAAwE;AACxE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAEnD,SAAS,IAAI,CAAC,OAAe,EAAE,MAAe,EAAE,KAAc;IAC5D,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/E,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,wEAAwE;IACxE,OAAO,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC;AAC7G,CAAC;AAED,oFAAoF;AACpF,SAAS,UAAU,CAAC,SAAgC,EAAE,OAAe,EAAE,MAAe,EAAE,KAAc;IACpG,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACV,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;YACtC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,OAAO,IAAI,CAAC;YACzE,OAAO,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC;QACjE,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;YACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YACvC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,EAAU,CAAC;YAC3E,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAChE,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,OAAO,KAAK,YAAY,EAAE,CAAC;gBAC7B,6DAA6D;gBAC7D,IAAI,MAAM,KAAK,SAAS;oBAAE,OAAO,KAAK,CAAC;gBACvC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAAE,OAAO,IAAI,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YAClE,CAAC;YACD,oEAAoE;YACpE,qEAAqE;YACrE,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;gBAAE,OAAO,IAAI,CAAC;YAChE,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACzD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAChE,CAAC;QACD,KAAK,KAAK;YACR,OAAO,KAAK,KAAK,SAAS,CAAC;QAC7B,KAAK,IAAI;YACP,OAAO,KAAK,KAAK,IAAI,IAAI,MAAM,KAAK,IAAI,CAAC;QAC3C,KAAK,KAAK;YACR,OAAO,MAAM,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC;QAC3C,KAAK,OAAO;YACV,OAAO,CAAC,KAAK,KAAK,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/G,KAAK,KAAK;YACR,OAAO,IAAI,CAAC;QACd,KAAK,OAAO;YACV,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe,EAAE,MAAe,EAAE,KAAc;IAC5E,IAAI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IAChD,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,IAAI,OAAO,CAAC;IACtD,OAAO,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AAChF,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,cAAc,CAAC,GAAG,OAAoD;IACpF,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC;IACnB,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,GAAG;YAAE,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,qBAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,aAAa,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAE5F,SAAS,KAAK,CAAC,KAAc;IAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,OAAO,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3D,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe,EAAE,MAAe,EAAE,KAAc;IAChE,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,GAAG,OAAO,WAAW,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;IACrE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,GAAG,OAAO,UAAU,CAAC;IACrD,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/E,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACvE,MAAM,KAAK,GACT,OAAO,KAAK,MAAM;YAChB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAC9H,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,GAAG,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AACzD,CAAC;AAED,wEAAwE;AACxE,SAAS,cAAc,CAAC,IAA6B;IACnD,OAAO,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,WAAW,CAAC,MAAe,EAAE,KAAc,EAAE,OAAe,EAAE,GAAmB;IACxF,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO;IAC3C,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QACvI,OAAO;IACT,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,oFAAoF;QACpF,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5I,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,KAAgC,CAAC;IAC9C,IAAI,cAAc,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QACnD,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,6CAA6C,EAAE,CAAC,CAAC;QACjH,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAClG,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxD,IAAI,GAAG,KAAK,YAAY,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACnH,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,EAAE,CAA4B,CAAC;YACtD,MAAM,GAAG,GAAG,CAAC,KAAK,IAAI,EAAE,CAA4B,CAAC;YACrD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpC,MAAM,EAAE,GAAG,GAAG,OAAO,eAAe,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC;oBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;;oBAC3I,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;YAClD,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;oBACvB,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,eAAe,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACpK,CAAC;YACH,CAAC;YACD,SAAS;QACX,CAAC;QACD,IAAI,GAAG,KAAK,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3D,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,QAAQ,EAAE,GAAG,CAAC,CAAC;YACpD,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QACjD,IAAI,MAAM,KAAK,MAAM;YAAE,SAAS;QAChC,MAAM,GAAG,GAAsB,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QACxH,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAa,EAAE,OAAe;IACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACjC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC/I,KAAK,MAAM,OAAO,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;QACzC,IAAI,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ;YAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IACxH,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5D,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,EAAE,GAAG,OAAO,eAAe,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnF,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;QAC1B,CAAC;IACH,CAAC;IACD,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAe,EAAE,KAAc,EAAE,UAA+B,EAAE;IACrG,IAAI,MAAM,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACrF,MAAM,OAAO,GAAmB,EAAE,CAAC;IACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACjG,CAAC;SAAM,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,yBAAyB,EAAE,CAAC,CAAC;QACzG,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;QACpH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpE,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,KAAK,EAAE,UAAU;gBACjB,MAAM,EAAE,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,OAAO,iCAAiC;aAC3H,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;AACtF,CAAC"}
@@ -0,0 +1,69 @@
1
+ /**
2
+ * Doc comments for generated TypeScript and Swift types, from the keyword
3
+ * table (#5530, project `unified-schemas` phase 1).
4
+ *
5
+ * A schema's constraint and annotation keywords do not change a generated
6
+ * type's shape, but an app developer reading a hover needs them: `string`
7
+ * alone hides `maxLength: 40`. Both renderers call `schemaDocs` at each
8
+ * declaration site — an object member and a root type — and print the result
9
+ * with `renderJsDocLines` (TS) or `renderSwiftDocLines` (Swift).
10
+ *
11
+ * Which keywords become docs is the table's `render` column
12
+ * (`schemaKeywordRender`, `doc` for an unknown key), read from the vendored
13
+ * descriptor, so codegen keeps no keyword list of its own.
14
+ *
15
+ * The validator also enforces keywords on nodes the renderers give no
16
+ * declaration site: the properties of a type-union or untyped object, any
17
+ * single-schema `items`, every `oneOf` and `anyOf` member, and a tagged
18
+ * union's member objects. Their keywords are hoisted onto the nearest site
19
+ * with a path prefix (`items.minimum`, `oneOf/1.properties.id.minimum`), so
20
+ * nothing the validator enforces is dropped. An `anyOf` member renders as a
21
+ * type (#5544), so the properties of an object member keep their own sites.
22
+ *
23
+ * #5540 — a `$comment` that is a db3 projection marker (written by the db3
24
+ * bridge, and so on every compiled node a db3 ref inlined) renders as one
25
+ * `projection:` line naming the projection, the type and the model, in place
26
+ * of the plain `$comment` entry.
27
+ */
28
+ /** One keyword line: the keyword (or hoisted path), its value as JSON, and its form. */
29
+ export interface SchemaDocEntry {
30
+ name: string;
31
+ value: string;
32
+ /**
33
+ * `tag` for a table keyword on the site's own node, which TS renders as
34
+ * `@<name> <value>`; `line` for an unknown key, a hoisted keyword, or a
35
+ * `deprecated` that is not exactly `true`, which renders as an inert
36
+ * `- <name>: <value>` line so it cannot mean anything to the TS compiler.
37
+ */
38
+ kind: "tag" | "line";
39
+ }
40
+ /** What one declaration site's doc comment says. */
41
+ export interface SchemaDocs {
42
+ /** The node's own string `description`, one entry per line. */
43
+ prose: string[];
44
+ entries: SchemaDocEntry[];
45
+ }
46
+ /**
47
+ * `text` made safe for one comment line: `*\/` cannot close a block comment,
48
+ * and every line terminator becomes its escape written as plain text.
49
+ */
50
+ export declare function commentSafe(text: string): string;
51
+ /**
52
+ * The doc comment for one declaration site's schema node: its own prose and
53
+ * keywords, then every keyword hoisted from beneath it.
54
+ */
55
+ export declare function schemaDocs(node: unknown): SchemaDocs;
56
+ /**
57
+ * The doc comment for a site whose type is a reference to a declaration
58
+ * emitted elsewhere (#5544): the node's own prose and keywords only, since
59
+ * everything beneath it is documented on that declaration.
60
+ */
61
+ export declare function schemaOwnDocs(node: unknown): SchemaDocs;
62
+ /**
63
+ * A JSDoc block at `pad`, or no lines when there is nothing to say. Only a
64
+ * `tag` entry carries a real `@`, and `deprecated` is a bare `@deprecated`;
65
+ * prose, names and values have theirs written as `&#64;`.
66
+ */
67
+ export declare function renderJsDocLines(docs: SchemaDocs, pad: string): string[];
68
+ /** `///` lines at `pad`, or none when there is nothing to say. */
69
+ export declare function renderSwiftDocLines(docs: SchemaDocs, pad: string): string[];
@@ -0,0 +1,219 @@
1
+ /**
2
+ * Doc comments for generated TypeScript and Swift types, from the keyword
3
+ * table (#5530, project `unified-schemas` phase 1).
4
+ *
5
+ * A schema's constraint and annotation keywords do not change a generated
6
+ * type's shape, but an app developer reading a hover needs them: `string`
7
+ * alone hides `maxLength: 40`. Both renderers call `schemaDocs` at each
8
+ * declaration site — an object member and a root type — and print the result
9
+ * with `renderJsDocLines` (TS) or `renderSwiftDocLines` (Swift).
10
+ *
11
+ * Which keywords become docs is the table's `render` column
12
+ * (`schemaKeywordRender`, `doc` for an unknown key), read from the vendored
13
+ * descriptor, so codegen keeps no keyword list of its own.
14
+ *
15
+ * The validator also enforces keywords on nodes the renderers give no
16
+ * declaration site: the properties of a type-union or untyped object, any
17
+ * single-schema `items`, every `oneOf` and `anyOf` member, and a tagged
18
+ * union's member objects. Their keywords are hoisted onto the nearest site
19
+ * with a path prefix (`items.minimum`, `oneOf/1.properties.id.minimum`), so
20
+ * nothing the validator enforces is dropped. An `anyOf` member renders as a
21
+ * type (#5544), so the properties of an object member keep their own sites.
22
+ *
23
+ * #5540 — a `$comment` that is a db3 projection marker (written by the db3
24
+ * bridge, and so on every compiled node a db3 ref inlined) renders as one
25
+ * `projection:` line naming the projection, the type and the model, in place
26
+ * of the plain `$comment` entry.
27
+ */
28
+ import { describeSchema, SCHEMA_KEYWORDS, schemaKeywordRender, } from "./generated-schema-descriptor.js";
29
+ import { parseDb3ProjectionMarker } from "./generated-db3-bridge.js";
30
+ const BACKSLASH = "\\";
31
+ const TERMINATOR_ESCAPES = new Map([
32
+ ["\n", `${BACKSLASH}n`],
33
+ ["\r", `${BACKSLASH}r`],
34
+ [String.fromCharCode(0x2028), `${BACKSLASH}u2028`],
35
+ [String.fromCharCode(0x2029), `${BACKSLASH}u2029`],
36
+ ]);
37
+ const TERMINATORS = new RegExp(`[${[...TERMINATOR_ESCAPES.keys()].join("")}]`, "g");
38
+ /**
39
+ * `text` made safe for one comment line: `*\/` cannot close a block comment,
40
+ * and every line terminator becomes its escape written as plain text.
41
+ */
42
+ export function commentSafe(text) {
43
+ return text
44
+ .replace(/\*\//g, `*${BACKSLASH}/`)
45
+ .replace(TERMINATORS, (terminator) => TERMINATOR_ESCAPES.get(terminator));
46
+ }
47
+ const isNode = (value) => !!value && typeof value === "object" && !Array.isArray(value);
48
+ const hasOwn = (node, key) => Object.prototype.hasOwnProperty.call(node, key);
49
+ const TABLE_ORDER = Object.keys(SCHEMA_KEYWORDS);
50
+ function jsonValue(value) {
51
+ return commentSafe(JSON.stringify(value) ?? String(value));
52
+ }
53
+ /** What each projection is, as the `projection:` line words it. */
54
+ const PROJECTION_MEANING = {
55
+ row: "as a stored row (id, the declared fields, the type's stamps; open)",
56
+ declared: "as declared (closed, storage keys stripped)",
57
+ };
58
+ /** A db3 projection marker's `projection:` line, or null for any other `$comment`. */
59
+ function projectionEntry(value, prefix) {
60
+ const marker = parseDb3ProjectionMarker(value);
61
+ if (!marker)
62
+ return null;
63
+ return {
64
+ name: commentSafe(`${prefix}projection`),
65
+ value: commentSafe(`${marker.projection} — db3 ${marker.type}.${marker.model} ${PROJECTION_MEANING[marker.projection]}`),
66
+ kind: "line",
67
+ };
68
+ }
69
+ function proseLines(description) {
70
+ const lines = description.split(/\r\n|\r|\n/).map((line) => commentSafe(line.trimEnd()));
71
+ while (lines.length > 0 && lines[0] === "")
72
+ lines.shift();
73
+ while (lines.length > 0 && lines[lines.length - 1] === "")
74
+ lines.pop();
75
+ return lines;
76
+ }
77
+ /**
78
+ * A node's own doc keywords: table rows in table order, then unknown keys in
79
+ * the schema's order. `prefix` is empty at a site and a path when hoisted.
80
+ */
81
+ function ownEntries(node, prefix, docs) {
82
+ const hoisted = prefix !== "";
83
+ for (const keyword of TABLE_ORDER) {
84
+ if (!hasOwn(node, keyword) || schemaKeywordRender(keyword) !== "doc")
85
+ continue;
86
+ const value = node[keyword];
87
+ if (keyword === "description" && typeof value === "string" && !hoisted) {
88
+ docs.prose.push(...proseLines(value));
89
+ continue;
90
+ }
91
+ const projection = keyword === "$comment" ? projectionEntry(value, prefix) : null;
92
+ if (projection) {
93
+ docs.entries.push(projection);
94
+ continue;
95
+ }
96
+ const tag = !hoisted && (keyword !== "deprecated" || value === true);
97
+ docs.entries.push({ name: commentSafe(prefix + keyword), value: jsonValue(value), kind: tag ? "tag" : "line" });
98
+ }
99
+ for (const [key, value] of Object.entries(node)) {
100
+ if (hasOwn(SCHEMA_KEYWORDS, key))
101
+ continue;
102
+ docs.entries.push({ name: commentSafe(prefix + key), value: jsonValue(value), kind: "line" });
103
+ }
104
+ }
105
+ /**
106
+ * The descriptor of a node's own keywords, `anyOf` aside: the renderers read
107
+ * an `anyOf` as its members and the rest of the node as their base (#5544).
108
+ */
109
+ function describeOwn(node) {
110
+ if (!Array.isArray(node.anyOf))
111
+ return describeSchema(node);
112
+ const { anyOf: _anyOf, ...rest } = node;
113
+ return describeSchema(rest);
114
+ }
115
+ /** Whether the node's `enum` or `const` decides its type, leaving its properties and items unrendered. */
116
+ const literalTyped = (node, d) => d.enumValues !== null || hasOwn(node, "const");
117
+ /** Whether the renderers give a node's declared properties sites of their own. */
118
+ function propertiesHaveSites(node, reach) {
119
+ const d = describeOwn(node);
120
+ if (reach === "member")
121
+ return d.object !== null;
122
+ return reach === "type" && d.object !== null && !literalTyped(node, d) && d.oneOf === null;
123
+ }
124
+ /** Whether the renderers render a node's single-schema `items` as its element type. */
125
+ function itemsRendered(node, reach) {
126
+ const d = describeOwn(node);
127
+ return reach !== "none" && d.array !== null && !literalTyped(node, d) && d.oneOf === null;
128
+ }
129
+ /**
130
+ * Hoist the keywords of every child the validator walks and the renderers give
131
+ * no site, depth first in the schema's key order.
132
+ */
133
+ function hoistChildren(node, prefix, reach, docs) {
134
+ const d = describeOwn(node);
135
+ const admits = (type) => d.types.length === 0 || d.types.includes(type);
136
+ const visit = (child, path, childReach) => {
137
+ if (!isNode(child))
138
+ return;
139
+ ownEntries(child, path, docs);
140
+ hoistChildren(child, path, childReach, docs);
141
+ };
142
+ for (const key of Object.keys(node)) {
143
+ const value = node[key];
144
+ if (key === "properties" && isNode(value) && admits("object")) {
145
+ if (propertiesHaveSites(node, reach))
146
+ continue;
147
+ for (const [name, child] of Object.entries(value))
148
+ visit(child, `${prefix}properties.${name}.`, "none");
149
+ }
150
+ else if (key === "items" && isNode(value) && admits("array")) {
151
+ visit(value, `${prefix}items.`, itemsRendered(node, reach) ? "type" : "none");
152
+ }
153
+ else if (key === "oneOf" && Array.isArray(value)) {
154
+ const tagged = reach !== "none" && d.oneOf?.kind === "valid";
155
+ value.forEach((member, index) => visit(member, `${prefix}oneOf/${index}.`, tagged ? "member" : "none"));
156
+ }
157
+ else if (key === "anyOf" && Array.isArray(value)) {
158
+ value.forEach((member, index) => visit(member, `${prefix}anyOf/${index}.`, reach === "type" ? "type" : "none"));
159
+ }
160
+ }
161
+ }
162
+ /**
163
+ * The doc comment for one declaration site's schema node: its own prose and
164
+ * keywords, then every keyword hoisted from beneath it.
165
+ */
166
+ export function schemaDocs(node) {
167
+ const docs = { prose: [], entries: [] };
168
+ if (!isNode(node))
169
+ return docs;
170
+ ownEntries(node, "", docs);
171
+ hoistChildren(node, "", "type", docs);
172
+ return docs;
173
+ }
174
+ /**
175
+ * The doc comment for a site whose type is a reference to a declaration
176
+ * emitted elsewhere (#5544): the node's own prose and keywords only, since
177
+ * everything beneath it is documented on that declaration.
178
+ */
179
+ export function schemaOwnDocs(node) {
180
+ const docs = { prose: [], entries: [] };
181
+ if (isNode(node))
182
+ ownEntries(node, "", docs);
183
+ return docs;
184
+ }
185
+ /**
186
+ * Authored text made inert to TypeScript: any `@` after whitespace starts a
187
+ * tag (`Use @deprecated …` marks the member deprecated), a line starting
188
+ * `@ts-ignore` is a directive, and `stripInternal` drops a declaration whose
189
+ * JSDoc contains `@internal` anywhere. Every authored `@` is written as the
190
+ * entity `&#64;`, which a hover still shows as `@`.
191
+ */
192
+ const tsInert = (text) => text.replace(/@/g, "&#64;");
193
+ /**
194
+ * A JSDoc block at `pad`, or no lines when there is nothing to say. Only a
195
+ * `tag` entry carries a real `@`, and `deprecated` is a bare `@deprecated`;
196
+ * prose, names and values have theirs written as `&#64;`.
197
+ */
198
+ export function renderJsDocLines(docs, pad) {
199
+ if (docs.prose.length === 0 && docs.entries.length === 0)
200
+ return [];
201
+ return [
202
+ `${pad}/**`,
203
+ ...docs.prose.map((line) => (line === "" ? `${pad} *` : `${pad} * ${tsInert(line)}`)),
204
+ ...docs.entries.map((entry) => entry.kind === "line"
205
+ ? `${pad} * - ${tsInert(entry.name)}: ${tsInert(entry.value)}`
206
+ : entry.name === "deprecated"
207
+ ? `${pad} * @deprecated`
208
+ : `${pad} * @${entry.name} ${tsInert(entry.value)}`),
209
+ `${pad} */`,
210
+ ];
211
+ }
212
+ /** `///` lines at `pad`, or none when there is nothing to say. */
213
+ export function renderSwiftDocLines(docs, pad) {
214
+ return [
215
+ ...docs.prose.map((line) => (line === "" ? `${pad}///` : `${pad}/// ${line}`)),
216
+ ...docs.entries.map((entry) => `${pad}/// - ${entry.name}: ${entry.value}`),
217
+ ];
218
+ }
219
+ //# sourceMappingURL=schemaDocs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schemaDocs.js","sourceRoot":"","sources":["../../../../src/lib/schema-codegen/schemaDocs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EACL,cAAc,EACd,eAAe,EACf,mBAAmB,GACpB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAsBrE,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAiB;IACjD,CAAC,IAAI,EAAE,GAAG,SAAS,GAAG,CAAC;IACvB,CAAC,IAAI,EAAE,GAAG,SAAS,GAAG,CAAC;IACvB,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,OAAO,CAAC;IAClD,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,OAAO,CAAC;CACnD,CAAC,CAAC;AACH,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAEpF;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI;SACR,OAAO,CAAC,OAAO,EAAE,IAAI,SAAS,GAAG,CAAC;SAClC,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,CAAC;AAC/E,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,KAAc,EAAoC,EAAE,CAClE,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEhE,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAE9F,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;AAEjD,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED,mEAAmE;AACnE,MAAM,kBAAkB,GAAG;IACzB,GAAG,EAAE,oEAAoE;IACzE,QAAQ,EAAE,6CAA6C;CAC/C,CAAC;AAEX,sFAAsF;AACtF,SAAS,eAAe,CAAC,KAAc,EAAE,MAAc;IACrD,MAAM,MAAM,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAC/C,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACzB,OAAO;QACL,IAAI,EAAE,WAAW,CAAC,GAAG,MAAM,YAAY,CAAC;QACxC,KAAK,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,UAAU,UAAU,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,IAAI,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QACxH,IAAI,EAAE,MAAM;KACb,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,WAAmB;IACrC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACzF,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;QAAE,KAAK,CAAC,KAAK,EAAE,CAAC;IAC1D,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE;QAAE,KAAK,CAAC,GAAG,EAAE,CAAC;IACvE,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,IAA6B,EAAE,MAAc,EAAE,IAAgB;IACjF,MAAM,OAAO,GAAG,MAAM,KAAK,EAAE,CAAC;IAC9B,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,mBAAmB,CAAC,OAAO,CAAC,KAAK,KAAK;YAAE,SAAS;QAC/E,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,OAAO,KAAK,aAAa,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC;YACvE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;YACtC,SAAS;QACX,CAAC;QACD,MAAM,UAAU,GAAG,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClF,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC9B,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAAG,CAAC,OAAO,IAAI,CAAC,OAAO,KAAK,YAAY,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC;QACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAClH,CAAC;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,IAAI,MAAM,CAAC,eAAe,EAAE,GAAG,CAAC;YAAE,SAAS;QAC3C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAChG,CAAC;AACH,CAAC;AASD;;;GAGG;AACH,SAAS,WAAW,CAAC,IAA6B;IAChD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;IAC5D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IACxC,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,0GAA0G;AAC1G,MAAM,YAAY,GAAG,CAAC,IAA6B,EAAE,CAAoC,EAAE,EAAE,CAC3F,CAAC,CAAC,UAAU,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAEjD,kFAAkF;AAClF,SAAS,mBAAmB,CAAC,IAA6B,EAAE,KAAY;IACtE,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,KAAK,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC;IACjD,OAAO,KAAK,KAAK,MAAM,IAAI,CAAC,CAAC,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC;AAC7F,CAAC;AAED,uFAAuF;AACvF,SAAS,aAAa,CAAC,IAA6B,EAAE,KAAY;IAChE,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,KAAK,KAAK,MAAM,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC;AAC5F,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,IAA6B,EAAE,MAAc,EAAE,KAAY,EAAE,IAAgB;IAClG,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAChF,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,IAAY,EAAE,UAAiB,EAAE,EAAE;QAChE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAAE,OAAO;QAC3B,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC,CAAC;IACF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,GAAG,KAAK,YAAY,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9D,IAAI,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC;gBAAE,SAAS;YAC/C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,KAAK,CAAC,KAAK,EAAE,GAAG,MAAM,cAAc,IAAI,GAAG,EAAE,MAAM,CAAC,CAAC;QAC1G,CAAC;aAAM,IAAI,GAAG,KAAK,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/D,KAAK,CAAC,KAAK,EAAE,GAAG,MAAM,QAAQ,EAAE,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAChF,CAAC;aAAM,IAAI,GAAG,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,MAAM,MAAM,GAAG,KAAK,KAAK,MAAM,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC;YAC7D,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,SAAS,KAAK,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1G,CAAC;aAAM,IAAI,GAAG,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,SAAS,KAAK,GAAG,EAAE,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,IAAa;IACtC,MAAM,IAAI,GAAe,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACpD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/B,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC3B,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACtC,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa;IACzC,MAAM,IAAI,GAAe,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACpD,IAAI,MAAM,CAAC,IAAI,CAAC;QAAE,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAgB,EAAE,GAAW;IAC5D,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACpE,OAAO;QACL,GAAG,GAAG,KAAK;QACX,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrF,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC5B,KAAK,CAAC,IAAI,KAAK,MAAM;YACnB,CAAC,CAAC,GAAG,GAAG,QAAQ,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YAC9D,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY;gBAC3B,CAAC,CAAC,GAAG,GAAG,gBAAgB;gBACxB,CAAC,CAAC,GAAG,GAAG,OAAO,KAAK,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CACxD;QACD,GAAG,GAAG,KAAK;KACZ,CAAC;AACJ,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,mBAAmB,CAAC,IAAgB,EAAE,GAAW;IAC/D,OAAO;QACL,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,IAAI,EAAE,CAAC,CAAC;QAC9E,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,SAAS,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;KAC5E,CAAC;AACJ,CAAC"}