@coasys/ad4m 0.12.0 → 0.13.0-postmessage-ws-proxy.0

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 (388) hide show
  1. package/README.md +2 -25
  2. package/jest-setup.ts +1 -1
  3. package/lib/index.cjs +7444 -13939
  4. package/lib/index.js +5322 -11888
  5. package/lib/src/Ad4mClient.d.ts +9 -3
  6. package/lib/src/Ad4mClient.js +40 -13
  7. package/lib/src/Literal.js +6 -5
  8. package/lib/src/agent/Agent.js +26 -272
  9. package/lib/src/agent/AgentClient.d.ts +33 -21
  10. package/lib/src/agent/AgentClient.js +180 -373
  11. package/lib/src/agent/AgentStatus.js +2 -37
  12. package/lib/src/ai/AIClient.d.ts +12 -4
  13. package/lib/src/ai/AIClient.js +81 -285
  14. package/lib/src/ai/AITypes.d.ts +55 -0
  15. package/lib/src/ai/AITypes.js +18 -0
  16. package/lib/src/ai/Tasks.js +10 -133
  17. package/lib/src/apiClient.d.ts +53 -0
  18. package/lib/src/apiClient.js +234 -0
  19. package/lib/src/cache/PersistentCache.d.ts +40 -0
  20. package/lib/src/cache/PersistentCache.js +139 -0
  21. package/lib/src/expression/Expression.d.ts +1 -1
  22. package/lib/src/expression/Expression.js +13 -122
  23. package/lib/src/expression/ExpressionClient.d.ts +11 -3
  24. package/lib/src/expression/ExpressionClient.js +120 -75
  25. package/lib/src/expression/ExpressionRef.js +4 -27
  26. package/lib/src/generated/api/AIModelLoadingStatus.d.ts +7 -0
  27. package/lib/src/generated/api/AIModelLoadingStatus.js +2 -0
  28. package/lib/src/generated/api/AddLinkExpressionRequest.d.ts +6 -0
  29. package/lib/src/generated/api/AddLinkExpressionRequest.js +1 -0
  30. package/lib/src/generated/api/AddLinkRequest.d.ts +6 -0
  31. package/lib/src/generated/api/AddLinkRequest.js +1 -0
  32. package/lib/src/generated/api/AddLinksBulkRequest.d.ts +6 -0
  33. package/lib/src/generated/api/AddLinksBulkRequest.js +1 -0
  34. package/lib/src/generated/api/AddSdnaRequest.d.ts +6 -0
  35. package/lib/src/generated/api/AddSdnaRequest.js +2 -0
  36. package/lib/src/generated/api/ApplyTemplateRequest.d.ts +4 -0
  37. package/lib/src/generated/api/ApplyTemplateRequest.js +2 -0
  38. package/lib/src/generated/api/AuthInfoInput.d.ts +10 -0
  39. package/lib/src/generated/api/AuthInfoInput.js +1 -0
  40. package/lib/src/generated/api/CapabilityInput.d.ts +5 -0
  41. package/lib/src/generated/api/CapabilityInput.js +1 -0
  42. package/lib/src/generated/api/CommitBatchRequest.d.ts +3 -0
  43. package/lib/src/generated/api/CommitBatchRequest.js +2 -0
  44. package/lib/src/generated/api/ComputeLogEntry.d.ts +9 -0
  45. package/lib/src/generated/api/ComputeLogEntry.js +2 -0
  46. package/lib/src/generated/api/CreateExpressionRequest.d.ts +4 -0
  47. package/lib/src/generated/api/CreateExpressionRequest.js +2 -0
  48. package/lib/src/generated/api/CreatePerspectiveRequest.d.ts +3 -0
  49. package/lib/src/generated/api/CreatePerspectiveRequest.js +2 -0
  50. package/lib/src/generated/api/CreateSubjectRequest.d.ts +6 -0
  51. package/lib/src/generated/api/CreateSubjectRequest.js +2 -0
  52. package/lib/src/generated/api/EmbedRequest.d.ts +4 -0
  53. package/lib/src/generated/api/EmbedRequest.js +2 -0
  54. package/lib/src/generated/api/EntanglementProofInput.d.ts +6 -0
  55. package/lib/src/generated/api/EntanglementProofInput.js +2 -0
  56. package/lib/src/generated/api/ExecuteCommandsRequest.d.ts +4 -0
  57. package/lib/src/generated/api/ExecuteCommandsRequest.js +2 -0
  58. package/lib/src/generated/api/ExportRequest.d.ts +5 -0
  59. package/lib/src/generated/api/ExportRequest.js +2 -0
  60. package/lib/src/generated/api/ExpressionManyRequest.d.ts +3 -0
  61. package/lib/src/generated/api/ExpressionManyRequest.js +2 -0
  62. package/lib/src/generated/api/ExpressionProof.d.ts +4 -0
  63. package/lib/src/generated/api/ExpressionProof.js +2 -0
  64. package/lib/src/generated/api/ExpressionProofInput.d.ts +6 -0
  65. package/lib/src/generated/api/ExpressionProofInput.js +2 -0
  66. package/lib/src/generated/api/FriendSendMessageRequest.d.ts +3 -0
  67. package/lib/src/generated/api/FriendSendMessageRequest.js +2 -0
  68. package/lib/src/generated/api/FriendsListRequest.d.ts +3 -0
  69. package/lib/src/generated/api/FriendsListRequest.js +2 -0
  70. package/lib/src/generated/api/GenerateAgentRequest.d.ts +3 -0
  71. package/lib/src/generated/api/GenerateAgentRequest.js +2 -0
  72. package/lib/src/generated/api/GenerateJwtRequest.d.ts +4 -0
  73. package/lib/src/generated/api/GenerateJwtRequest.js +2 -0
  74. package/lib/src/generated/api/GetSubjectDataRequest.d.ts +4 -0
  75. package/lib/src/generated/api/GetSubjectDataRequest.js +2 -0
  76. package/lib/src/generated/api/ImportAgentRequest.d.ts +6 -0
  77. package/lib/src/generated/api/ImportAgentRequest.js +2 -0
  78. package/lib/src/generated/api/ImportRequest.d.ts +4 -0
  79. package/lib/src/generated/api/ImportRequest.js +2 -0
  80. package/lib/src/generated/api/JoinNeighbourhoodRequest.d.ts +3 -0
  81. package/lib/src/generated/api/JoinNeighbourhoodRequest.js +2 -0
  82. package/lib/src/generated/api/LanguageMetaInput.d.ts +6 -0
  83. package/lib/src/generated/api/LanguageMetaInput.js +2 -0
  84. package/lib/src/generated/api/Link.d.ts +5 -0
  85. package/lib/src/generated/api/Link.js +2 -0
  86. package/lib/src/generated/api/LinkExpression.d.ts +10 -0
  87. package/lib/src/generated/api/LinkExpression.js +1 -0
  88. package/lib/src/generated/api/LinkExpressionInput.d.ts +10 -0
  89. package/lib/src/generated/api/LinkExpressionInput.js +1 -0
  90. package/lib/src/generated/api/LinkInput.d.ts +5 -0
  91. package/lib/src/generated/api/LinkInput.js +2 -0
  92. package/lib/src/generated/api/LinkLanguageTemplatesRequest.d.ts +3 -0
  93. package/lib/src/generated/api/LinkLanguageTemplatesRequest.js +2 -0
  94. package/lib/src/generated/api/LinkMutations.d.ts +6 -0
  95. package/lib/src/generated/api/LinkMutations.js +1 -0
  96. package/lib/src/generated/api/LinkStatus.d.ts +1 -0
  97. package/lib/src/generated/api/LinkStatus.js +2 -0
  98. package/lib/src/generated/api/LockAgentRequest.d.ts +3 -0
  99. package/lib/src/generated/api/LockAgentRequest.js +2 -0
  100. package/lib/src/generated/api/ModelType.d.ts +1 -0
  101. package/lib/src/generated/api/ModelType.js +2 -0
  102. package/lib/src/generated/api/NotificationInput.d.ts +10 -0
  103. package/lib/src/generated/api/NotificationInput.js +2 -0
  104. package/lib/src/generated/api/OpenLinkRequest.d.ts +3 -0
  105. package/lib/src/generated/api/OpenLinkRequest.js +2 -0
  106. package/lib/src/generated/api/PermitCapabilityRequest.d.ts +3 -0
  107. package/lib/src/generated/api/PermitCapabilityRequest.js +2 -0
  108. package/lib/src/generated/api/PerspectiveInput.d.ts +4 -0
  109. package/lib/src/generated/api/PerspectiveInput.js +1 -0
  110. package/lib/src/generated/api/PromptRequest.d.ts +4 -0
  111. package/lib/src/generated/api/PromptRequest.js +2 -0
  112. package/lib/src/generated/api/PublishLanguageRequest.d.ts +5 -0
  113. package/lib/src/generated/api/PublishLanguageRequest.js +1 -0
  114. package/lib/src/generated/api/PublishNeighbourhoodRequest.d.ts +6 -0
  115. package/lib/src/generated/api/PublishNeighbourhoodRequest.js +1 -0
  116. package/lib/src/generated/api/QueryRequest.d.ts +7 -0
  117. package/lib/src/generated/api/QueryRequest.js +2 -0
  118. package/lib/src/generated/api/RemoveLinkRequest.d.ts +5 -0
  119. package/lib/src/generated/api/RemoveLinkRequest.js +1 -0
  120. package/lib/src/generated/api/RemoveLinksBulkRequest.d.ts +5 -0
  121. package/lib/src/generated/api/RemoveLinksBulkRequest.js +1 -0
  122. package/lib/src/generated/api/ResourceInput.d.ts +4 -0
  123. package/lib/src/generated/api/ResourceInput.js +2 -0
  124. package/lib/src/generated/api/SetDefaultModelRequest.d.ts +4 -0
  125. package/lib/src/generated/api/SetDefaultModelRequest.js +1 -0
  126. package/lib/src/generated/api/SetFreeHostingEnabledRequest.d.ts +3 -0
  127. package/lib/src/generated/api/SetFreeHostingEnabledRequest.js +2 -0
  128. package/lib/src/generated/api/SetMultiUserRequest.d.ts +3 -0
  129. package/lib/src/generated/api/SetMultiUserRequest.js +2 -0
  130. package/lib/src/generated/api/SetStatusRequest.d.ts +3 -0
  131. package/lib/src/generated/api/SetStatusRequest.js +2 -0
  132. package/lib/src/generated/api/SignMessageRequest.d.ts +3 -0
  133. package/lib/src/generated/api/SignMessageRequest.js +2 -0
  134. package/lib/src/generated/api/TrustedAgentsRequest.d.ts +3 -0
  135. package/lib/src/generated/api/TrustedAgentsRequest.js +2 -0
  136. package/lib/src/generated/api/UnlockAgentRequest.d.ts +4 -0
  137. package/lib/src/generated/api/UnlockAgentRequest.js +2 -0
  138. package/lib/src/generated/api/UpdateLinkRequest.d.ts +7 -0
  139. package/lib/src/generated/api/UpdateLinkRequest.js +1 -0
  140. package/lib/src/generated/api/UpdatePerspectiveRequest.d.ts +3 -0
  141. package/lib/src/generated/api/UpdatePerspectiveRequest.js +2 -0
  142. package/lib/src/generated/api/UserStatistics.d.ts +9 -0
  143. package/lib/src/generated/api/UserStatistics.js +2 -0
  144. package/lib/src/generated/api/VerificationRequestResult.d.ts +6 -0
  145. package/lib/src/generated/api/VerificationRequestResult.js +2 -0
  146. package/lib/src/generated/api/VerifySignatureRequest.d.ts +5 -0
  147. package/lib/src/generated/api/VerifySignatureRequest.js +2 -0
  148. package/lib/src/generated/api/WriteSettingsRequest.d.ts +3 -0
  149. package/lib/src/generated/api/WriteSettingsRequest.js +2 -0
  150. package/lib/src/generated/api/index.d.ts +42 -0
  151. package/lib/src/generated/api/index.js +7 -0
  152. package/lib/src/index.d.ts +7 -2
  153. package/lib/src/index.js +7 -2
  154. package/lib/src/jestSetup.d.ts +0 -1
  155. package/lib/src/jestSetup.js +1 -1
  156. package/lib/src/language/Icon.js +2 -21
  157. package/lib/src/language/Language.d.ts +26 -176
  158. package/lib/src/language/Language.js +32 -72
  159. package/lib/src/language/LanguageClient.d.ts +2 -2
  160. package/lib/src/language/LanguageClient.js +15 -105
  161. package/lib/src/language/LanguageHandle.js +2 -41
  162. package/lib/src/language/LanguageMeta.js +4 -75
  163. package/lib/src/language/LanguageRef.js +2 -25
  164. package/lib/src/links/Links.js +14 -111
  165. package/lib/src/model/Ad4mModel.d.ts +150 -62
  166. package/lib/src/model/Ad4mModel.js +689 -417
  167. package/lib/src/model/Ad4mModel.test.js +1434 -688
  168. package/lib/src/model/ModelQueryBuilder.d.ts +59 -38
  169. package/lib/src/model/ModelQueryBuilder.js +317 -153
  170. package/lib/src/model/Subject.js +6 -6
  171. package/lib/src/model/decorators.d.ts +36 -8
  172. package/lib/src/model/decorators.js +41 -14
  173. package/lib/src/model/hydration-batch.d.ts +34 -0
  174. package/lib/src/model/hydration-batch.js +147 -0
  175. package/lib/src/model/hydration-batching.test.d.ts +7 -0
  176. package/lib/src/model/hydration-batching.test.js +456 -0
  177. package/lib/src/model/hydration.d.ts +3 -92
  178. package/lib/src/model/hydration.js +3 -691
  179. package/lib/src/model/index.d.ts +3 -4
  180. package/lib/src/model/index.js +3 -4
  181. package/lib/src/model/json-schema.js +2 -2
  182. package/lib/src/model/model-manifest.d.ts +41 -0
  183. package/lib/src/model/model-manifest.js +11 -0
  184. package/lib/src/model/query-cache.d.ts +30 -0
  185. package/lib/src/model/query-cache.js +66 -0
  186. package/lib/src/model/query-cache.test.d.ts +1 -0
  187. package/lib/src/model/query-cache.test.js +43 -0
  188. package/lib/src/model/query-common.d.ts +1 -1
  189. package/lib/src/model/query-common.js +1 -1
  190. package/lib/src/model/query-sparql-batch.d.ts +17 -0
  191. package/lib/src/model/query-sparql-batch.js +260 -0
  192. package/lib/src/model/query-sparql.d.ts +51 -0
  193. package/lib/src/model/query-sparql.js +466 -0
  194. package/lib/src/model/query-sparql.test.d.ts +1 -0
  195. package/lib/src/model/query-sparql.test.js +312 -0
  196. package/lib/src/model/{surreal-utils.d.ts → query-utils.d.ts} +13 -9
  197. package/lib/src/model/query-utils.js +189 -0
  198. package/lib/src/model/relation-filtering.test.js +15 -15
  199. package/lib/src/model/sdna.js +1 -1
  200. package/lib/src/model/shacl-gen.js +46 -18
  201. package/lib/src/model/subscription-delta.test.d.ts +24 -0
  202. package/lib/src/model/subscription-delta.test.js +180 -0
  203. package/lib/src/model/subscription-pool.d.ts +39 -0
  204. package/lib/src/model/subscription-pool.js +165 -0
  205. package/lib/src/model/types.d.ts +60 -5
  206. package/lib/src/model/types.js +5 -2
  207. package/lib/src/neighbourhood/Neighbourhood.js +4 -32
  208. package/lib/src/neighbourhood/NeighbourhoodClient.d.ts +3 -3
  209. package/lib/src/neighbourhood/NeighbourhoodClient.js +40 -203
  210. package/lib/src/perspectives/LinkQuery.js +2 -42
  211. package/lib/src/perspectives/Perspective.d.ts +1 -1
  212. package/lib/src/perspectives/Perspective.js +10 -52
  213. package/lib/src/perspectives/PerspectiveClient.d.ts +22 -32
  214. package/lib/src/perspectives/PerspectiveClient.js +189 -454
  215. package/lib/src/perspectives/PerspectiveClient.test.d.ts +1 -0
  216. package/lib/src/perspectives/PerspectiveClient.test.js +224 -0
  217. package/lib/src/perspectives/PerspectiveDiff.js +4 -31
  218. package/lib/src/perspectives/PerspectiveHandle.js +3 -43
  219. package/lib/src/perspectives/PerspectiveProxy.d.ts +156 -78
  220. package/lib/src/perspectives/PerspectiveProxy.js +474 -389
  221. package/lib/src/perspectives/PerspectiveResolver.d.ts +0 -1
  222. package/lib/src/perspectives/PerspectiveResolver.js +0 -11
  223. package/lib/src/perspectives/WakerSubscriptionManager.d.ts +3 -3
  224. package/lib/src/perspectives/WakerSubscriptionManager.js +12 -12
  225. package/lib/src/runtime/RuntimeClient.d.ts +34 -6
  226. package/lib/src/runtime/RuntimeClient.js +131 -362
  227. package/lib/src/runtime/RuntimeResolver.d.ts +28 -1
  228. package/lib/src/runtime/RuntimeResolver.js +197 -4
  229. package/lib/src/runtime/RuntimeTypes.d.ts +101 -0
  230. package/lib/src/runtime/RuntimeTypes.js +45 -0
  231. package/lib/src/schema.gql +27 -1
  232. package/lib/src/shacl/SHACLFlow.d.ts +1 -1
  233. package/lib/src/shacl/SHACLFlow.js +9 -9
  234. package/lib/src/shacl/SHACLShape.d.ts +8 -1
  235. package/lib/src/shacl/SHACLShape.js +57 -38
  236. package/lib/src/shacl/SHACLShape.test.js +82 -0
  237. package/lib/src/typeDefs.js +3 -602
  238. package/lib/src/utils.d.ts +6 -6
  239. package/lib/src/utils.js +6 -6
  240. package/package.json +6 -18
  241. package/rollup.config.js +0 -7
  242. package/src/Ad4mClient.test.ts +1192 -1288
  243. package/src/Ad4mClient.ts +46 -15
  244. package/src/Literal.test.ts +10 -5
  245. package/src/Literal.ts +6 -5
  246. package/src/agent/Agent.ts +0 -99
  247. package/src/agent/AgentClient.ts +238 -465
  248. package/src/agent/AgentStatus.ts +0 -12
  249. package/src/ai/AIClient.ts +96 -296
  250. package/src/ai/AITypes.ts +66 -0
  251. package/src/ai/Tasks.ts +0 -52
  252. package/src/apiClient.ts +287 -0
  253. package/src/cache/PersistentCache.ts +145 -0
  254. package/src/cache/cache.test.ts +713 -0
  255. package/src/expression/Expression.ts +3 -43
  256. package/src/expression/ExpressionClient.ts +148 -77
  257. package/src/expression/ExpressionRef.ts +2 -8
  258. package/src/generated/api/AIModelLoadingStatus.ts +3 -0
  259. package/src/generated/api/AddLinkExpressionRequest.ts +4 -0
  260. package/src/generated/api/AddLinkRequest.ts +4 -0
  261. package/src/generated/api/AddLinksBulkRequest.ts +4 -0
  262. package/src/generated/api/AddSdnaRequest.ts +3 -0
  263. package/src/generated/api/ApplyTemplateRequest.ts +3 -0
  264. package/src/generated/api/AuthInfoInput.ts +4 -0
  265. package/src/generated/api/CapabilityInput.ts +4 -0
  266. package/src/generated/api/CommitBatchRequest.ts +3 -0
  267. package/src/generated/api/ComputeLogEntry.ts +3 -0
  268. package/src/generated/api/CreateExpressionRequest.ts +3 -0
  269. package/src/generated/api/CreatePerspectiveRequest.ts +3 -0
  270. package/src/generated/api/CreateSubjectRequest.ts +3 -0
  271. package/src/generated/api/EmbedRequest.ts +3 -0
  272. package/src/generated/api/EntanglementProofInput.ts +3 -0
  273. package/src/generated/api/ExecuteCommandsRequest.ts +3 -0
  274. package/src/generated/api/ExportRequest.ts +3 -0
  275. package/src/generated/api/ExpressionManyRequest.ts +3 -0
  276. package/src/generated/api/ExpressionProof.ts +3 -0
  277. package/src/generated/api/ExpressionProofInput.ts +3 -0
  278. package/src/generated/api/FriendSendMessageRequest.ts +3 -0
  279. package/src/generated/api/FriendsListRequest.ts +3 -0
  280. package/src/generated/api/GenerateAgentRequest.ts +3 -0
  281. package/src/generated/api/GenerateJwtRequest.ts +3 -0
  282. package/src/generated/api/GetSubjectDataRequest.ts +3 -0
  283. package/src/generated/api/ImportAgentRequest.ts +3 -0
  284. package/src/generated/api/ImportRequest.ts +3 -0
  285. package/src/generated/api/JoinNeighbourhoodRequest.ts +3 -0
  286. package/src/generated/api/LanguageMetaInput.ts +3 -0
  287. package/src/generated/api/Link.ts +3 -0
  288. package/src/generated/api/LinkExpression.ts +6 -0
  289. package/src/generated/api/LinkExpressionInput.ts +6 -0
  290. package/src/generated/api/LinkInput.ts +3 -0
  291. package/src/generated/api/LinkLanguageTemplatesRequest.ts +3 -0
  292. package/src/generated/api/LinkMutations.ts +5 -0
  293. package/src/generated/api/LinkStatus.ts +3 -0
  294. package/src/generated/api/LockAgentRequest.ts +3 -0
  295. package/src/generated/api/ModelType.ts +3 -0
  296. package/src/generated/api/NotificationInput.ts +3 -0
  297. package/src/generated/api/OpenLinkRequest.ts +3 -0
  298. package/src/generated/api/PermitCapabilityRequest.ts +3 -0
  299. package/src/generated/api/PerspectiveInput.ts +4 -0
  300. package/src/generated/api/PromptRequest.ts +3 -0
  301. package/src/generated/api/PublishLanguageRequest.ts +4 -0
  302. package/src/generated/api/PublishNeighbourhoodRequest.ts +4 -0
  303. package/src/generated/api/QueryRequest.ts +6 -0
  304. package/src/generated/api/RemoveLinkRequest.ts +4 -0
  305. package/src/generated/api/RemoveLinksBulkRequest.ts +4 -0
  306. package/src/generated/api/ResourceInput.ts +3 -0
  307. package/src/generated/api/SetDefaultModelRequest.ts +4 -0
  308. package/src/generated/api/SetFreeHostingEnabledRequest.ts +3 -0
  309. package/src/generated/api/SetMultiUserRequest.ts +3 -0
  310. package/src/generated/api/SetStatusRequest.ts +3 -0
  311. package/src/generated/api/SignMessageRequest.ts +3 -0
  312. package/src/generated/api/TrustedAgentsRequest.ts +3 -0
  313. package/src/generated/api/UnlockAgentRequest.ts +3 -0
  314. package/src/generated/api/UpdateLinkRequest.ts +5 -0
  315. package/src/generated/api/UpdatePerspectiveRequest.ts +3 -0
  316. package/src/generated/api/UserStatistics.ts +3 -0
  317. package/src/generated/api/VerificationRequestResult.ts +3 -0
  318. package/src/generated/api/VerifySignatureRequest.ts +3 -0
  319. package/src/generated/api/WriteSettingsRequest.ts +3 -0
  320. package/src/generated/api/index.ts +49 -0
  321. package/src/index.ts +7 -2
  322. package/src/jestSetup.ts +1 -1
  323. package/src/language/Icon.ts +0 -4
  324. package/src/language/Language.ts +51 -248
  325. package/src/language/LanguageClient.ts +21 -132
  326. package/src/language/LanguageHandle.ts +0 -14
  327. package/src/language/LanguageMeta.ts +0 -29
  328. package/src/language/LanguageRef.ts +0 -7
  329. package/src/links/Links.ts +0 -37
  330. package/src/model/Ad4mModel.test.ts +1690 -777
  331. package/src/model/Ad4mModel.ts +749 -477
  332. package/src/model/ModelQueryBuilder.ts +356 -171
  333. package/src/model/decorators.ts +71 -22
  334. package/src/model/hydration.ts +3 -772
  335. package/src/model/index.ts +3 -4
  336. package/src/model/json-schema.ts +2 -2
  337. package/src/model/query-cache.test.ts +54 -0
  338. package/src/model/query-cache.ts +79 -0
  339. package/src/model/query-common.ts +1 -1
  340. package/src/model/query-sparql.test.ts +376 -0
  341. package/src/model/query-sparql.ts +504 -0
  342. package/src/model/query-utils.ts +209 -0
  343. package/src/model/relation-filtering.test.ts +15 -15
  344. package/src/model/sdna.ts +1 -1
  345. package/src/model/shacl-gen.ts +47 -17
  346. package/src/model/types.ts +65 -5
  347. package/src/neighbourhood/Neighbourhood.ts +0 -9
  348. package/src/neighbourhood/NeighbourhoodClient.ts +42 -207
  349. package/src/neighbourhood/NeighbourhoodProxy.test.ts +34 -36
  350. package/src/perspectives/LinkQuery.ts +0 -15
  351. package/src/perspectives/Perspective.ts +1 -12
  352. package/src/perspectives/PerspectiveClient.test.ts +262 -0
  353. package/src/perspectives/PerspectiveClient.ts +254 -468
  354. package/src/perspectives/PerspectiveDiff.ts +0 -8
  355. package/src/perspectives/PerspectiveHandle.ts +1 -12
  356. package/src/perspectives/PerspectiveProxy.test.ts +125 -0
  357. package/src/perspectives/PerspectiveProxy.ts +522 -434
  358. package/src/perspectives/WakerSubscriptionManager.ts +13 -13
  359. package/src/runtime/RuntimeClient.ts +166 -369
  360. package/src/runtime/RuntimeTypes.ts +144 -0
  361. package/src/shacl/SHACLFlow.ts +9 -9
  362. package/src/shacl/SHACLShape.test.ts +94 -0
  363. package/src/shacl/SHACLShape.ts +66 -39
  364. package/src/typeDefs.ts +3 -5
  365. package/src/utils.ts +6 -6
  366. package/tsconfig.json +3 -7
  367. package/lib/src/model/query-surreal.d.ts +0 -44
  368. package/lib/src/model/query-surreal.js +0 -249
  369. package/lib/src/model/surreal-utils.js +0 -128
  370. package/shims/reflect-metadata.ts +0 -0
  371. package/shims/type-graphql.ts +0 -75
  372. package/src/PubSub.ts +0 -17
  373. package/src/agent/AgentResolver.ts +0 -263
  374. package/src/ai/AIResolver.ts +0 -372
  375. package/src/buildSchema.ts +0 -43
  376. package/src/expression/ExpressionResolver.ts +0 -64
  377. package/src/language/LanguageContext.ts +0 -37
  378. package/src/language/LanguageResolver.ts +0 -98
  379. package/src/model/Subject.ts +0 -159
  380. package/src/model/prolog-facts.ts +0 -145
  381. package/src/model/query-prolog.ts +0 -148
  382. package/src/model/query-surreal.ts +0 -280
  383. package/src/model/surreal-utils.ts +0 -147
  384. package/src/neighbourhood/NeighbourhoodResolver.ts +0 -100
  385. package/src/perspectives/PerspectiveResolver.ts +0 -372
  386. package/src/runtime/RuntimeResolver.ts +0 -617
  387. package/src/unwrapApolloResult.ts +0 -16
  388. package/tsconfig-browser.json +0 -82
@@ -0,0 +1,209 @@
1
+ /**
2
+ * Shared query compilation utilities.
3
+ *
4
+ * These functions are used by both the runtime query builder (`Ad4mModel`) and
5
+ * the compile-time SHACL generator (`decorators.ts`).
6
+ *
7
+ * All output uses native SPARQL syntax.
8
+ */
9
+
10
+ import type { WhereCondition, Where, ModelMetadata } from "./types";
11
+ import { escapeQueryString } from "../utils";
12
+
13
+ /**
14
+ * Format a JavaScript value for embedding in a query expression.
15
+ *
16
+ * - Strings are single-quoted with backslash / quote / newline escaping
17
+ * - Numbers and booleans are passed through as-is
18
+ * - Arrays are recursed
19
+ */
20
+ export function formatQueryValue(value: any): string {
21
+ if (typeof value === 'string') {
22
+ // Escape backslashes first, then single quotes and other special characters
23
+ const escaped = value
24
+ .replace(/\\/g, '\\\\') // Backslash -> \\
25
+ .replace(/'/g, "\\'") // Single quote -> \'
26
+ .replace(/"/g, '\\"') // Double quote -> \"
27
+ .replace(/\n/g, '\\n') // Newline -> \n
28
+ .replace(/\r/g, '\\r') // Carriage return -> \r
29
+ .replace(/\t/g, '\\t'); // Tab -> \t
30
+ return `'${escaped}'`;
31
+ } else if (typeof value === 'number' || typeof value === 'boolean') {
32
+ return String(value);
33
+ } else if (Array.isArray(value)) {
34
+ return `[${value.map(v => formatQueryValue(v)).join(', ')}]`;
35
+ } else {
36
+ return String(value);
37
+ }
38
+ }
39
+
40
+ /**
41
+ * Compile a single Where condition for a property into a SPARQL triple pattern
42
+ * that can be embedded in a getter's WHERE clause.
43
+ *
44
+ * The generated pattern operates on `?target` — e.g.:
45
+ * `?target <pred> <value> .`
46
+ * `FILTER EXISTS { ?target <pred> ?_v0 }`
47
+ *
48
+ * @param predicate - The predicate URI for the property
49
+ * @param condition - The Where condition value
50
+ * @param opts - Optional settings (e.g. `resolveLanguage`)
51
+ * @returns A single SPARQL condition string
52
+ */
53
+ export function buildWhereCondition(
54
+ predicate: string,
55
+ condition: WhereCondition,
56
+ opts?: { resolveLanguage?: string; varIndex?: number },
57
+ ): string {
58
+ const escapedPredicate = escapeQueryString(predicate);
59
+ // For literal-resolved properties, we match against the raw IRI (which is a literal: URI)
60
+ // For language-resolved properties, we match against the plain URI
61
+ // For literal-resolved properties, values are stored as IRIs like <literal:string:VALUE>
62
+ // For language-resolved properties, values are plain URIs
63
+ const isLiteral = !opts?.resolveLanguage || opts.resolveLanguage === 'literal';
64
+
65
+ const varSuffix = opts?.varIndex ?? 0;
66
+
67
+ function formatValue(v: any): string {
68
+ if (typeof v === 'string') {
69
+ return isLiteral
70
+ ? `<literal:string:${escapeQueryString(v)}>`
71
+ : `<${escapeQueryString(v)}>`;
72
+ }
73
+ // Numbers/booleans — also stored as literal:string: in AD4M
74
+ return `<literal:string:${v}>`;
75
+ }
76
+
77
+ /**
78
+ * For literal properties, generate a FILTER-based match that handles both
79
+ * the raw value and the literal-encoded value. This mirrors the Rust
80
+ * `build_projection_where_patterns` approach which uses:
81
+ * FILTER(STR(?var) = "value" || STR(?var) = "literal:string:encodedValue")
82
+ * This is more robust than exact IRI matching because it handles edge cases
83
+ * where the stored format might vary.
84
+ */
85
+ function formatLiteralFilter(varName: string, v: any): string {
86
+ const raw = escapeQueryString(String(v));
87
+ const encoded = encodeURIComponent(String(v))
88
+ .replace(/!/g, '%21')
89
+ .replace(/'/g, '%27')
90
+ .replace(/\(/g, '%28')
91
+ .replace(/\)/g, '%29')
92
+ .replace(/\*/g, '%2A');
93
+ if (typeof v === 'string') {
94
+ return `FILTER(STR(${varName}) = "${raw}" || STR(${varName}) = "literal:string:${encoded}")`;
95
+ } else if (typeof v === 'number') {
96
+ return `FILTER(STR(${varName}) = "${v}" || STR(${varName}) = "literal:number:${v}")`;
97
+ } else if (typeof v === 'boolean') {
98
+ return `FILTER(STR(${varName}) = "${v}" || STR(${varName}) = "literal:boolean:${v}")`;
99
+ }
100
+ return `FILTER(STR(${varName}) = "${raw}")`;
101
+ }
102
+
103
+ if (Array.isArray(condition)) {
104
+ // Array values → FILTER IN
105
+ if (isLiteral) {
106
+ const varName = `?_wc${varSuffix}`;
107
+ const inValues = (condition as any[]).flatMap(v => {
108
+ const raw = escapeQueryString(String(v));
109
+ const encoded = encodeURIComponent(String(v))
110
+ .replace(/!/g, '%21').replace(/'/g, '%27')
111
+ .replace(/\(/g, '%28').replace(/\)/g, '%29').replace(/\*/g, '%2A');
112
+ return [`"${raw}"`, `"literal:string:${encoded}"`];
113
+ }).join(', ');
114
+ return `?target <${escapedPredicate}> ${varName} . FILTER(STR(${varName}) IN (${inValues}))`;
115
+ }
116
+ const formattedValues = (condition as any[]).map(formatValue).join(', ');
117
+ return `FILTER EXISTS { ?target <${escapedPredicate}> ?_val . FILTER(?_val IN (${formattedValues})) }`;
118
+ } else if (typeof condition === 'object' && condition !== null) {
119
+ // Operator object
120
+ const ops = condition as any;
121
+ const parts: string[] = [];
122
+
123
+ if (ops.not !== undefined) {
124
+ if (Array.isArray(ops.not)) {
125
+ const formattedValues = ops.not.map((v: any) => formatValue(v)).join(', ');
126
+ // FILTER NOT EXISTS here is scoped to a specific predicate, not a global scan,
127
+ // so O(N²) behavior is bounded by the number of values for this property.
128
+ parts.push(
129
+ `FILTER NOT EXISTS { ?target <${escapedPredicate}> ?_nval . FILTER(?_nval IN (${formattedValues})) }`,
130
+ );
131
+ } else {
132
+ // FILTER NOT EXISTS here is scoped to a specific predicate, not a global scan,
133
+ // so O(N²) behavior is bounded by the number of values for this property.
134
+ parts.push(
135
+ `FILTER NOT EXISTS { ?target <${escapedPredicate}> ${formatValue(ops.not)} }`,
136
+ );
137
+ }
138
+ }
139
+
140
+ // Comparison operators — ensure property exists
141
+ const hasComparisonOps =
142
+ ops.gt !== undefined || ops.gte !== undefined ||
143
+ ops.lt !== undefined || ops.lte !== undefined ||
144
+ ops.between !== undefined || ops.contains !== undefined;
145
+ if (hasComparisonOps) {
146
+ parts.push(
147
+ `FILTER EXISTS { ?target <${escapedPredicate}> ?_cmp }`,
148
+ );
149
+ }
150
+
151
+ return parts.join(' ');
152
+ } else {
153
+ // Simple equality
154
+ if (isLiteral) {
155
+ // Use FILTER matching (mirrors Rust build_projection_where_patterns)
156
+ // to handle both raw values and literal-encoded IRIs robustly.
157
+ const varName = `?_wc${varSuffix}`;
158
+ return `?target <${escapedPredicate}> ${varName} . ${formatLiteralFilter(varName, condition)}`;
159
+ }
160
+ return `?target <${escapedPredicate}> ${formatValue(condition)} .`;
161
+ }
162
+ }
163
+
164
+ /**
165
+ * Compile a full `Where` clause to an array of SPARQL condition strings.
166
+ *
167
+ * When `metadata` is provided, property names are resolved to predicates
168
+ * using the model's property metadata. When `metadata` is `null`, property
169
+ * names are treated as raw predicate URIs.
170
+ *
171
+ * Only handles **regular properties** — special fields (`id`, `author`,
172
+ * `timestamp`) and relation fields are skipped (they are only relevant at
173
+ * runtime query time, not for compile-time getter generation).
174
+ */
175
+ export function compileWhereClause(
176
+ where: Where,
177
+ metadata: ModelMetadata | null,
178
+ ): string[] {
179
+ const conditions: string[] = [];
180
+
181
+ for (const [propertyName, condition] of Object.entries(where)) {
182
+ // Skip special fields that don't apply at compile time
183
+ if (['id', 'author', 'timestamp'].includes(propertyName)) continue;
184
+
185
+ let predicate: string;
186
+ let resolveLanguage: string | undefined;
187
+
188
+ if (metadata) {
189
+ const propMeta = metadata.properties[propertyName];
190
+ if (propMeta) {
191
+ predicate = propMeta.predicate;
192
+ resolveLanguage = propMeta.resolveLanguage;
193
+ } else {
194
+ // Property not found in metadata — treat name as raw predicate URI
195
+ predicate = propertyName;
196
+ }
197
+ } else {
198
+ // No metadata — treat name as raw predicate URI
199
+ predicate = propertyName;
200
+ }
201
+
202
+ const cond = buildWhereCondition(predicate, condition, { resolveLanguage, varIndex: conditions.length });
203
+ if (cond) {
204
+ conditions.push(cond);
205
+ }
206
+ }
207
+
208
+ return conditions;
209
+ }
@@ -22,7 +22,7 @@ import {
22
22
  SHACLPropertyShape,
23
23
  ConformanceCondition,
24
24
  } from "../shacl/SHACLShape";
25
- import { compileWhereClause } from "./surreal-utils";
25
+ import { compileWhereClause } from "./query-utils";
26
26
 
27
27
  // ============================================================================
28
28
  // Test models
@@ -65,7 +65,7 @@ class ParentWithRelations extends Ad4mModel {
65
65
  unfilteredItems: string[] = [];
66
66
 
67
67
  @HasMany({
68
- getter: "(<-link[WHERE predicate = 'test://custom'].in.uri)",
68
+ getter: "SELECT ?target WHERE { ?target <test://custom> ?source . }",
69
69
  })
70
70
  customItems: string[] = [];
71
71
  }
@@ -93,8 +93,8 @@ describe("buildConformanceFilter()", () => {
93
93
  expect(reqCond!.predicate).toBe("test://name");
94
94
  expect(reqCond!.value).toBeUndefined();
95
95
 
96
- // Getter string should be a SurrealQL expression
97
- expect(result!.getter).toContain("->link[WHERE predicate =");
96
+ // Getter string should be a SPARQL expression
97
+ expect(result!.getter).toContain("SELECT ?target WHERE");
98
98
  expect(result!.getter).toContain("test://has_flagged");
99
99
  expect(result!.getter).toContain("test://type");
100
100
  expect(result!.getter).toContain("test://flagged_type");
@@ -130,7 +130,7 @@ describe("buildConformanceFilter()", () => {
130
130
  @Property({
131
131
  through: "test://computed",
132
132
  required: true,
133
- getter: "(<-link[WHERE predicate = 'test://custom'].in.uri)[0]",
133
+ getter: "SELECT ?target WHERE { ?target <test://custom> ?source . } LIMIT 1",
134
134
  })
135
135
  computed: string = "";
136
136
  }
@@ -148,7 +148,7 @@ describe("buildConformanceFilter()", () => {
148
148
  // ============================================================================
149
149
 
150
150
  describe("SHACL shape getter serialization", () => {
151
- const testGetter = "(->link[WHERE predicate = 'test://pred'].out[WHERE count(->link[WHERE predicate = 'test://type' AND out.uri = 'test://flag']) > 0].uri)";
151
+ const testGetter = "SELECT ?target WHERE { <Base> <test://pred> ?target . ?target <test://type> <test://flag> . }";
152
152
  const testConditions: ConformanceCondition[] = [
153
153
  { type: "flag", predicate: "test://type", value: "test://flag" },
154
154
  { type: "required", predicate: "test://name" },
@@ -170,7 +170,7 @@ describe("SHACL shape getter serialization", () => {
170
170
  // Verify getter link exists
171
171
  const getterLink = links.find(l => l.predicate === "ad4m://getter");
172
172
  expect(getterLink).toBeDefined();
173
- expect(getterLink!.target).toBe(`literal://string:${testGetter}`);
173
+ expect(getterLink!.target).toBe(`literal:string:${testGetter}`);
174
174
 
175
175
  // Verify conditions link exists
176
176
  const conditionsLink = links.find(l => l.predicate === "ad4m://conformanceConditions");
@@ -338,7 +338,7 @@ describe("Ad4mModel.getModelMetadata() relation filtering fields", () => {
338
338
 
339
339
  // Explicit getter provided via decorator (getter-only, no predicate)
340
340
  expect(metadata.relations.customItems.getter).toBe(
341
- "(<-link[WHERE predicate = 'test://custom'].in.uri)"
341
+ "SELECT ?target WHERE { ?target <test://custom> ?source . }"
342
342
  );
343
343
  expect(metadata.relations.customItems.predicate).toBe("");
344
344
 
@@ -388,7 +388,7 @@ describe("Relation decorator validation", () => {
388
388
  @Model({ name: "InvalidGetterTarget" })
389
389
  class _Invalid extends Ad4mModel {
390
390
  @HasMany({
391
- getter: "(<-link.in.uri)",
391
+ getter: "SELECT ?target WHERE { ?target ?p ?source . }",
392
392
  target: () => FlaggedTarget,
393
393
  })
394
394
  items: string[] = [];
@@ -401,7 +401,7 @@ describe("Relation decorator validation", () => {
401
401
  @Model({ name: "InvalidGetterThrough" })
402
402
  class _Invalid extends Ad4mModel {
403
403
  @HasMany({
404
- getter: "(<-link.in.uri)",
404
+ getter: "SELECT ?target WHERE { ?target ?p ?source . }",
405
405
  through: "test://pred",
406
406
  })
407
407
  items: string[] = [];
@@ -414,7 +414,7 @@ describe("Relation decorator validation", () => {
414
414
  @Model({ name: "ValidGetterOnly" })
415
415
  class _Valid extends Ad4mModel {
416
416
  @HasMany({
417
- getter: "(<-link.in.uri)",
417
+ getter: "SELECT ?target WHERE { ?target ?p ?source . }",
418
418
  })
419
419
  items: string[] = [];
420
420
  }
@@ -551,7 +551,7 @@ describe("where clause validation", () => {
551
551
  class _Invalid extends Ad4mModel {
552
552
  @HasMany({
553
553
  where: { status: "active" },
554
- getter: "(<-link.in.uri)",
554
+ getter: "SELECT ?target WHERE { ?target ?p ?source . }",
555
555
  })
556
556
  items: string[] = [];
557
557
  }
@@ -574,7 +574,7 @@ describe("where clause validation", () => {
574
574
  });
575
575
 
576
576
  describe("where clause compilation", () => {
577
- it("should compile where clause to SurrealQL getter", () => {
577
+ it("should compile where clause to SPARQL getter", () => {
578
578
  @Model({ name: "WhereTarget" })
579
579
  class WhereTarget extends Ad4mModel {
580
580
  @Property({ through: "test://status", required: true })
@@ -760,7 +760,7 @@ describe("where clause compilation", () => {
760
760
  // ============================================================================
761
761
 
762
762
  describe("compileWhereClause()", () => {
763
- it("should compile simple equality to SurrealQL condition", () => {
763
+ it("should compile simple equality to SPARQL condition", () => {
764
764
  const conditions = compileWhereClause(
765
765
  { status: "active" },
766
766
  { properties: { status: { name: "status", predicate: "test://status", required: false, readOnly: false } }, relations: {}, className: "Test" }
@@ -776,7 +776,7 @@ describe("compileWhereClause()", () => {
776
776
  { properties: { status: { name: "status", predicate: "test://status", required: false, readOnly: false } }, relations: {}, className: "Test" }
777
777
  );
778
778
  expect(conditions).toHaveLength(1);
779
- expect(conditions[0]).toContain("= 0"); // negation
779
+ expect(conditions[0]).toContain("NOT EXISTS"); // negation
780
780
  expect(conditions[0]).toContain("archived");
781
781
  });
782
782
 
package/src/model/sdna.ts CHANGED
@@ -89,7 +89,7 @@ export function buildSDNA(
89
89
  // Optional properties (required: false) are excluded — they should
90
90
  // remain unset (undefined) until explicitly assigned.
91
91
  const effectiveInitial = initial
92
- ?? (required && writable && !flag && through ? "literal://string:" : undefined);
92
+ ?? (required && writable && !flag && through ? "literal:string:" : undefined);
93
93
 
94
94
  if (effectiveInitial) {
95
95
  constructorActions.push({
@@ -8,8 +8,8 @@
8
8
  */
9
9
  import { SHACLShape } from "../shacl/SHACLShape";
10
10
  import type { SHACLPropertyShape, ConformanceCondition } from "../shacl/SHACLShape";
11
- import { escapeSurrealString } from "../utils";
12
- import { compileWhereClause } from "./surreal-utils";
11
+ import { escapeQueryString } from "../utils";
12
+ import { compileWhereClause } from "./query-utils";
13
13
  import { propertyNameToSetterName } from "./util";
14
14
  import type { PropertyMetadataEntry, RelationMetadataEntry, Ad4mModelLike } from "./decorators";
15
15
 
@@ -128,6 +128,11 @@ export function buildSHACL(
128
128
  propShape.hasValue = propMeta.initial;
129
129
  }
130
130
 
131
+ // sh:in — allowed values (enum constraint)
132
+ if (propMeta.options && propMeta.options.length > 0) {
133
+ propShape.in = propMeta.options;
134
+ }
135
+
131
136
  // AD4M-specific metadata
132
137
  if (propMeta.local !== undefined) {
133
138
  propShape.local = propMeta.local;
@@ -163,7 +168,7 @@ export function buildSHACL(
163
168
  // ── Constructor / Destructor entries ────────────────────────────
164
169
  const effectiveInitial = propMeta.initial
165
170
  ?? (propMeta.required && propMeta.writable && !propMeta.flag && propMeta.through
166
- ? "literal://string:" : undefined);
171
+ ? "literal:string:" : undefined);
167
172
 
168
173
  if (effectiveInitial) {
169
174
  constructorActions.push({
@@ -224,7 +229,7 @@ export function buildSHACL(
224
229
  // ── Build Getter (conformance filter) ───────────────────────────
225
230
  // Priority chain:
226
231
  // 1. Explicit getter string → use verbatim
227
- // 2. `where` clause → compile DSL to SurrealQL getter
232
+ // 2. `where` clause → compile DSL to SPARQL getter
228
233
  // 3. target + filter !== false → auto-derive from shape
229
234
  if (relMeta.getter) {
230
235
  relShape.getter = relMeta.getter;
@@ -241,24 +246,49 @@ export function buildSHACL(
241
246
  );
242
247
 
243
248
  if (conditions.length > 0) {
244
- const escapedPredicate = escapeSurrealString(relMeta.predicate);
245
- relShape.getter = `(->link[WHERE predicate = '${escapedPredicate}'].out[WHERE ${conditions.join(' AND ')}].uri)`;
249
+ const escapedPredicate = escapeQueryString(relMeta.predicate);
250
+ relShape.getter = `SELECT ?target WHERE { <Base> <${escapedPredicate}> ?target . ${conditions.join(' ')} }`;
246
251
  }
247
252
  } catch (e) {
248
253
  // Target metadata may not be available yet
249
254
  }
250
255
  } else if (relMeta.target && relMeta.filter !== false) {
251
- try {
252
- const TargetClass = relMeta.target();
253
- const filter = conformanceFilterFn(relMeta.predicate, TargetClass);
254
- if (filter) {
255
- relShape.getter = filter.getter;
256
- relShape.conformanceConditions = filter.conformanceConditions;
256
+ // Lazy conformance filter: store deferred reference,
257
+ // resolve on first access via a getter on relShape
258
+ const targetThunk = relMeta.target;
259
+ const predicate = relMeta.predicate;
260
+ let resolved = false;
261
+ let cachedGetter: string | undefined;
262
+ let cachedConditions: ConformanceCondition[] | undefined;
263
+
264
+ const resolveFilter = () => {
265
+ if (resolved) return;
266
+ resolved = true;
267
+ try {
268
+ const TargetClass = targetThunk();
269
+ const filter = conformanceFilterFn(predicate, TargetClass);
270
+ if (filter) {
271
+ cachedGetter = filter.getter;
272
+ cachedConditions = filter.conformanceConditions;
273
+ }
274
+ } catch (e) {
275
+ // Target class may not be available yet
257
276
  }
258
- } catch (e) {
259
- // Target class may not be available yet — getter will be
260
- // absent and runtime will fall back to unfiltered get_links
261
- }
277
+ };
278
+
279
+ // Define lazy getters that resolve on first access
280
+ Object.defineProperty(relShape, 'getter', {
281
+ get() { resolveFilter(); return cachedGetter; },
282
+ set(v: string) { resolved = true; cachedGetter = v; },
283
+ enumerable: true,
284
+ configurable: true,
285
+ });
286
+ Object.defineProperty(relShape, 'conformanceConditions', {
287
+ get() { resolveFilter(); return cachedConditions; },
288
+ set(v: ConformanceCondition[]) { resolved = true; cachedConditions = v; },
289
+ enumerable: true,
290
+ configurable: true,
291
+ });
262
292
  }
263
293
 
264
294
  // ── sh:class — target shape reference ───────────────────────────
@@ -278,7 +308,7 @@ export function buildSHACL(
278
308
  }
279
309
 
280
310
  // Always set constructor and destructor actions on the shape, even
281
- // when empty. An empty array serialises to `literal://string:[]`
311
+ // when empty. An empty array serialises to `literal:string:[]`
282
312
  // which the Rust executor parses as a valid (no-op) command list,
283
313
  // avoiding "No SHACL constructor found" errors for models whose
284
314
  // properties are all optional and have no @Flag.
@@ -2,7 +2,7 @@
2
2
  * Shared type definitions for the Ad4mModel system.
3
3
  *
4
4
  * Extracted into a standalone module so that utility files
5
- * (`surreal-utils.ts`, `decorators.ts`, etc.) can import types without
5
+ * (`query-utils.ts`, `decorators.ts`, etc.) can import types without
6
6
  * creating circular runtime dependencies on `Ad4mModel.ts`.
7
7
  */
8
8
 
@@ -61,7 +61,51 @@ export type ParentScope =
61
61
  * ```
62
62
  */
63
63
  export interface IncludeMap {
64
- [relation: string]: boolean | RelationSubQuery;
64
+ [relation: string]: boolean | RelationSubQuery | IncludeProjection;
65
+ }
66
+
67
+ /**
68
+ * A lightweight projection that computes a scalar or list value from a relation
69
+ * without fully hydrating the linked instances.
70
+ *
71
+ * Keys in `IncludeMap` that begin with `$` are treated as projections.
72
+ * Results are attached directly to each queried instance under the same key.
73
+ *
74
+ * @example
75
+ * ```typescript
76
+ * // Attach a like-count to each post
77
+ * const posts = await Post.findAll(perspective, {
78
+ * include: {
79
+ * $likeCount: { from: 'likes', count: true },
80
+ * $myLike: { from: 'likes', limit: 1 },
81
+ * }
82
+ * });
83
+ * posts[0].$likeCount // number
84
+ * posts[0].$myLike // string ID or null
85
+ * ```
86
+ */
87
+ export interface IncludeProjection {
88
+ /** The relation name on the parent model to project over. */
89
+ from: string;
90
+ /** When true, attaches an integer count instead of a list. */
91
+ count?: true;
92
+ /**
93
+ * Serialised target class shape. Set automatically by `executeModelQuery`
94
+ * when a `where` clause is present and the target class is resolvable.
95
+ * @internal
96
+ */
97
+ targetShape?: ModelMetadata;
98
+ /** Post-hydration where clause applied to the target instances. */
99
+ where?: Where;
100
+ /** Limit results (when 1, the attached value is unwrapped to a scalar). */
101
+ limit?: number;
102
+ /** Order results before applying limit. */
103
+ order?: Order;
104
+ }
105
+
106
+ /** Type guard for IncludeProjection objects. */
107
+ export function isIncludeProjection(val: unknown): val is IncludeProjection {
108
+ return typeof val === 'object' && val !== null && 'from' in val;
65
109
  }
66
110
 
67
111
  export type Query = {
@@ -69,11 +113,27 @@ export type Query = {
69
113
  parent?: ParentScope;
70
114
  properties?: string[];
71
115
  include?: IncludeMap;
116
+ /**
117
+ * When true, eager-loads every declared forward relation on the model.
118
+ * Equivalent to listing all relation field names in `include: {}` explicitly.
119
+ * Useful for tree-walking and manifest-style inspections.
120
+ * Individual relations can still be overridden via `include` (explicit entries take precedence).
121
+ */
122
+ includeAll?: boolean;
72
123
  where?: Where;
73
124
  order?: Order;
74
125
  offset?: number;
75
126
  limit?: number;
76
127
  count?: boolean;
128
+ /**
129
+ * When true, SPARQL property getters (@Property with `getter`) ARE evaluated
130
+ * during collection hydration. Defaults to true — getters run post-pagination
131
+ * via batched VALUES queries so the cost is O(getters), not O(instances × getters).
132
+ *
133
+ * Set to false to explicitly skip getter evaluation for performance-sensitive
134
+ * queries where getter-backed properties are not needed.
135
+ */
136
+ deepQuery?: boolean;
77
137
  };
78
138
 
79
139
  /**
@@ -100,7 +160,7 @@ export type GetOptions = Pick<Query, 'include' | 'properties'>;
100
160
  // Result types
101
161
  // ---------------------------------------------------------------------------
102
162
 
103
- export type AllInstancesResult = { AllInstances: Ad4mModel[]; TotalCount?: number; isInit?: boolean };
163
+ export type AllInstancesResult = { AllInstances: Ad4mModel[]; TotalCount?: number };
104
164
  export type ResultsWithTotalCount<T> = { results: T[]; totalCount?: number };
105
165
  export type PaginationResult<T> = { results: T[]; totalCount?: number; pageSize: number; pageNumber: number };
106
166
 
@@ -134,7 +194,7 @@ export interface PropertyMetadata {
134
194
  prologGetter?: string;
135
195
  /** Custom Prolog setter code */
136
196
  prologSetter?: string;
137
- /** Custom SurrealQL getter code */
197
+ /** Custom getter code */
138
198
  getter?: string;
139
199
  /** Whether stored locally only */
140
200
  local?: boolean;
@@ -152,7 +212,7 @@ export interface RelationMetadata {
152
212
  name: string;
153
213
  /** The predicate URI (through value) */
154
214
  predicate: string;
155
- /** Custom SurrealQL getter code */
215
+ /** Custom getter code */
156
216
  getter?: string;
157
217
  /** Whether stored locally only */
158
218
  local?: boolean;
@@ -1,15 +1,8 @@
1
- import { Field, ObjectType } from "type-graphql";
2
1
  import { ExpressionGeneric } from "../expression/Expression";
3
2
  import { LanguageRef } from "../language/LanguageRef";
4
3
  import { Perspective } from "../perspectives/Perspective";
5
-
6
-
7
- @ObjectType()
8
4
  export class Neighbourhood {
9
- @Field()
10
5
  linkLanguage: string
11
-
12
- @Field()
13
6
  meta: Perspective
14
7
 
15
8
  constructor(linkLanguage: string, meta: Perspective) {
@@ -17,6 +10,4 @@ export class Neighbourhood {
17
10
  this.meta = meta;
18
11
  }
19
12
  }
20
-
21
- @ObjectType()
22
13
  export class NeighbourhoodExpression extends ExpressionGeneric(Neighbourhood) {};