@coasys/ad4m 0.13.0-test-3 → 0.13.0-test-4

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 (334) hide show
  1. package/README.md +2 -25
  2. package/jest-setup.ts +1 -1
  3. package/lib/index.cjs +2406 -11070
  4. package/lib/index.js +2209 -10925
  5. package/lib/src/Ad4mClient.d.ts +7 -3
  6. package/lib/src/Ad4mClient.js +29 -13
  7. package/lib/src/agent/Agent.js +26 -272
  8. package/lib/src/agent/AgentClient.d.ts +10 -21
  9. package/lib/src/agent/AgentClient.js +75 -427
  10. package/lib/src/agent/AgentStatus.js +2 -37
  11. package/lib/src/ai/AIClient.d.ts +12 -4
  12. package/lib/src/ai/AIClient.js +81 -285
  13. package/lib/src/ai/AITypes.d.ts +55 -0
  14. package/lib/src/ai/AITypes.js +18 -0
  15. package/lib/src/ai/Tasks.js +10 -133
  16. package/lib/src/apiClient.d.ts +52 -0
  17. package/lib/src/apiClient.js +231 -0
  18. package/lib/src/expression/Expression.d.ts +1 -1
  19. package/lib/src/expression/Expression.js +13 -122
  20. package/lib/src/expression/ExpressionClient.d.ts +3 -3
  21. package/lib/src/expression/ExpressionClient.js +13 -76
  22. package/lib/src/expression/ExpressionRef.js +2 -25
  23. package/lib/src/generated/api/AIModelLoadingStatus.d.ts +7 -0
  24. package/lib/src/generated/api/AIModelLoadingStatus.js +2 -0
  25. package/lib/src/generated/api/AddLinkExpressionRequest.d.ts +6 -0
  26. package/lib/src/generated/api/AddLinkExpressionRequest.js +1 -0
  27. package/lib/src/generated/api/AddLinkRequest.d.ts +6 -0
  28. package/lib/src/generated/api/AddLinkRequest.js +1 -0
  29. package/lib/src/generated/api/AddLinksBulkRequest.d.ts +6 -0
  30. package/lib/src/generated/api/AddLinksBulkRequest.js +1 -0
  31. package/lib/src/generated/api/AddSdnaRequest.d.ts +6 -0
  32. package/lib/src/generated/api/AddSdnaRequest.js +2 -0
  33. package/lib/src/generated/api/ApplyTemplateRequest.d.ts +4 -0
  34. package/lib/src/generated/api/ApplyTemplateRequest.js +2 -0
  35. package/lib/src/generated/api/AuthInfoInput.d.ts +10 -0
  36. package/lib/src/generated/api/AuthInfoInput.js +1 -0
  37. package/lib/src/generated/api/CapabilityInput.d.ts +5 -0
  38. package/lib/src/generated/api/CapabilityInput.js +1 -0
  39. package/lib/src/generated/api/CommitBatchRequest.d.ts +3 -0
  40. package/lib/src/generated/api/CommitBatchRequest.js +2 -0
  41. package/lib/src/generated/api/ComputeLogEntry.d.ts +9 -0
  42. package/lib/src/generated/api/ComputeLogEntry.js +2 -0
  43. package/lib/src/generated/api/CreateExpressionRequest.d.ts +4 -0
  44. package/lib/src/generated/api/CreateExpressionRequest.js +2 -0
  45. package/lib/src/generated/api/CreatePerspectiveRequest.d.ts +3 -0
  46. package/lib/src/generated/api/CreatePerspectiveRequest.js +2 -0
  47. package/lib/src/generated/api/CreateSubjectRequest.d.ts +6 -0
  48. package/lib/src/generated/api/CreateSubjectRequest.js +2 -0
  49. package/lib/src/generated/api/EmbedRequest.d.ts +4 -0
  50. package/lib/src/generated/api/EmbedRequest.js +2 -0
  51. package/lib/src/generated/api/EntanglementProofInput.d.ts +6 -0
  52. package/lib/src/generated/api/EntanglementProofInput.js +2 -0
  53. package/lib/src/generated/api/ExecuteCommandsRequest.d.ts +4 -0
  54. package/lib/src/generated/api/ExecuteCommandsRequest.js +2 -0
  55. package/lib/src/generated/api/ExportRequest.d.ts +5 -0
  56. package/lib/src/generated/api/ExportRequest.js +2 -0
  57. package/lib/src/generated/api/ExpressionManyRequest.d.ts +3 -0
  58. package/lib/src/generated/api/ExpressionManyRequest.js +2 -0
  59. package/lib/src/generated/api/ExpressionProof.d.ts +4 -0
  60. package/lib/src/generated/api/ExpressionProof.js +2 -0
  61. package/lib/src/generated/api/ExpressionProofInput.d.ts +6 -0
  62. package/lib/src/generated/api/ExpressionProofInput.js +2 -0
  63. package/lib/src/generated/api/FriendSendMessageRequest.d.ts +3 -0
  64. package/lib/src/generated/api/FriendSendMessageRequest.js +2 -0
  65. package/lib/src/generated/api/FriendsListRequest.d.ts +3 -0
  66. package/lib/src/generated/api/FriendsListRequest.js +2 -0
  67. package/lib/src/generated/api/GenerateAgentRequest.d.ts +3 -0
  68. package/lib/src/generated/api/GenerateAgentRequest.js +2 -0
  69. package/lib/src/generated/api/GenerateJwtRequest.d.ts +4 -0
  70. package/lib/src/generated/api/GenerateJwtRequest.js +2 -0
  71. package/lib/src/generated/api/GetSubjectDataRequest.d.ts +4 -0
  72. package/lib/src/generated/api/GetSubjectDataRequest.js +2 -0
  73. package/lib/src/generated/api/ImportAgentRequest.d.ts +6 -0
  74. package/lib/src/generated/api/ImportAgentRequest.js +2 -0
  75. package/lib/src/generated/api/ImportRequest.d.ts +4 -0
  76. package/lib/src/generated/api/ImportRequest.js +2 -0
  77. package/lib/src/generated/api/JoinNeighbourhoodRequest.d.ts +3 -0
  78. package/lib/src/generated/api/JoinNeighbourhoodRequest.js +2 -0
  79. package/lib/src/generated/api/LanguageMetaInput.d.ts +6 -0
  80. package/lib/src/generated/api/LanguageMetaInput.js +2 -0
  81. package/lib/src/generated/api/Link.d.ts +5 -0
  82. package/lib/src/generated/api/Link.js +2 -0
  83. package/lib/src/generated/api/LinkExpression.d.ts +10 -0
  84. package/lib/src/generated/api/LinkExpression.js +1 -0
  85. package/lib/src/generated/api/LinkExpressionInput.d.ts +10 -0
  86. package/lib/src/generated/api/LinkExpressionInput.js +1 -0
  87. package/lib/src/generated/api/LinkInput.d.ts +5 -0
  88. package/lib/src/generated/api/LinkInput.js +2 -0
  89. package/lib/src/generated/api/LinkLanguageTemplatesRequest.d.ts +3 -0
  90. package/lib/src/generated/api/LinkLanguageTemplatesRequest.js +2 -0
  91. package/lib/src/generated/api/LinkMutations.d.ts +6 -0
  92. package/lib/src/generated/api/LinkMutations.js +1 -0
  93. package/lib/src/generated/api/LinkStatus.d.ts +1 -0
  94. package/lib/src/generated/api/LinkStatus.js +2 -0
  95. package/lib/src/generated/api/LockAgentRequest.d.ts +3 -0
  96. package/lib/src/generated/api/LockAgentRequest.js +2 -0
  97. package/lib/src/generated/api/ModelType.d.ts +1 -0
  98. package/lib/src/generated/api/ModelType.js +2 -0
  99. package/lib/src/generated/api/NotificationInput.d.ts +10 -0
  100. package/lib/src/generated/api/NotificationInput.js +2 -0
  101. package/lib/src/generated/api/OpenLinkRequest.d.ts +3 -0
  102. package/lib/src/generated/api/OpenLinkRequest.js +2 -0
  103. package/lib/src/generated/api/PermitCapabilityRequest.d.ts +3 -0
  104. package/lib/src/generated/api/PermitCapabilityRequest.js +2 -0
  105. package/lib/src/generated/api/PerspectiveInput.d.ts +4 -0
  106. package/lib/src/generated/api/PerspectiveInput.js +1 -0
  107. package/lib/src/generated/api/PromptRequest.d.ts +4 -0
  108. package/lib/src/generated/api/PromptRequest.js +2 -0
  109. package/lib/src/generated/api/PublishLanguageRequest.d.ts +5 -0
  110. package/lib/src/generated/api/PublishLanguageRequest.js +1 -0
  111. package/lib/src/generated/api/PublishNeighbourhoodRequest.d.ts +6 -0
  112. package/lib/src/generated/api/PublishNeighbourhoodRequest.js +1 -0
  113. package/lib/src/generated/api/QueryRequest.d.ts +7 -0
  114. package/lib/src/generated/api/QueryRequest.js +2 -0
  115. package/lib/src/generated/api/RemoveLinkRequest.d.ts +5 -0
  116. package/lib/src/generated/api/RemoveLinkRequest.js +1 -0
  117. package/lib/src/generated/api/RemoveLinksBulkRequest.d.ts +5 -0
  118. package/lib/src/generated/api/RemoveLinksBulkRequest.js +1 -0
  119. package/lib/src/generated/api/ResourceInput.d.ts +4 -0
  120. package/lib/src/generated/api/ResourceInput.js +2 -0
  121. package/lib/src/generated/api/SetDefaultModelRequest.d.ts +4 -0
  122. package/lib/src/generated/api/SetDefaultModelRequest.js +1 -0
  123. package/lib/src/generated/api/SetFreeHostingEnabledRequest.d.ts +3 -0
  124. package/lib/src/generated/api/SetFreeHostingEnabledRequest.js +2 -0
  125. package/lib/src/generated/api/SetMultiUserRequest.d.ts +3 -0
  126. package/lib/src/generated/api/SetMultiUserRequest.js +2 -0
  127. package/lib/src/generated/api/SetStatusRequest.d.ts +3 -0
  128. package/lib/src/generated/api/SetStatusRequest.js +2 -0
  129. package/lib/src/generated/api/SignMessageRequest.d.ts +3 -0
  130. package/lib/src/generated/api/SignMessageRequest.js +2 -0
  131. package/lib/src/generated/api/TrustedAgentsRequest.d.ts +3 -0
  132. package/lib/src/generated/api/TrustedAgentsRequest.js +2 -0
  133. package/lib/src/generated/api/UnlockAgentRequest.d.ts +4 -0
  134. package/lib/src/generated/api/UnlockAgentRequest.js +2 -0
  135. package/lib/src/generated/api/UpdateLinkRequest.d.ts +7 -0
  136. package/lib/src/generated/api/UpdateLinkRequest.js +1 -0
  137. package/lib/src/generated/api/UpdatePerspectiveRequest.d.ts +3 -0
  138. package/lib/src/generated/api/UpdatePerspectiveRequest.js +2 -0
  139. package/lib/src/generated/api/UserStatistics.d.ts +9 -0
  140. package/lib/src/generated/api/UserStatistics.js +2 -0
  141. package/lib/src/generated/api/VerificationRequestResult.d.ts +6 -0
  142. package/lib/src/generated/api/VerificationRequestResult.js +2 -0
  143. package/lib/src/generated/api/VerifySignatureRequest.d.ts +5 -0
  144. package/lib/src/generated/api/VerifySignatureRequest.js +2 -0
  145. package/lib/src/generated/api/WriteSettingsRequest.d.ts +3 -0
  146. package/lib/src/generated/api/WriteSettingsRequest.js +2 -0
  147. package/lib/src/generated/api/index.d.ts +42 -0
  148. package/lib/src/generated/api/index.js +7 -0
  149. package/lib/src/index.d.ts +6 -1
  150. package/lib/src/index.js +6 -1
  151. package/lib/src/jestSetup.d.ts +0 -1
  152. package/lib/src/jestSetup.js +1 -1
  153. package/lib/src/language/Icon.js +2 -21
  154. package/lib/src/language/Language.d.ts +1 -1
  155. package/lib/src/language/Language.js +10 -76
  156. package/lib/src/language/LanguageClient.d.ts +2 -2
  157. package/lib/src/language/LanguageClient.js +15 -105
  158. package/lib/src/language/LanguageHandle.js +2 -41
  159. package/lib/src/language/LanguageMeta.js +4 -75
  160. package/lib/src/language/LanguageRef.js +2 -25
  161. package/lib/src/links/Links.js +14 -111
  162. package/lib/src/model/Ad4mModel.d.ts +57 -38
  163. package/lib/src/model/Ad4mModel.js +594 -460
  164. package/lib/src/model/Ad4mModel.test.js +371 -815
  165. package/lib/src/model/ModelQueryBuilder.d.ts +9 -21
  166. package/lib/src/model/ModelQueryBuilder.js +138 -217
  167. package/lib/src/model/decorators.d.ts +22 -0
  168. package/lib/src/model/decorators.js +7 -0
  169. package/lib/src/model/hydration.d.ts +7 -60
  170. package/lib/src/model/hydration.js +7 -716
  171. package/lib/src/model/index.d.ts +0 -4
  172. package/lib/src/model/index.js +0 -4
  173. package/lib/src/model/model-manifest.d.ts +41 -0
  174. package/lib/src/model/model-manifest.js +11 -0
  175. package/lib/src/model/query-sparql.d.ts +4 -67
  176. package/lib/src/model/query-sparql.js +26 -322
  177. package/lib/src/model/query-sparql.test.js +35 -218
  178. package/lib/src/model/shacl-gen.js +4 -0
  179. package/lib/src/model/types.d.ts +47 -38
  180. package/lib/src/model/types.js +4 -1
  181. package/lib/src/neighbourhood/Neighbourhood.js +4 -32
  182. package/lib/src/neighbourhood/NeighbourhoodClient.d.ts +3 -3
  183. package/lib/src/neighbourhood/NeighbourhoodClient.js +40 -203
  184. package/lib/src/perspectives/LinkQuery.js +2 -42
  185. package/lib/src/perspectives/Perspective.d.ts +1 -1
  186. package/lib/src/perspectives/Perspective.js +10 -52
  187. package/lib/src/perspectives/PerspectiveClient.d.ts +12 -17
  188. package/lib/src/perspectives/PerspectiveClient.js +169 -429
  189. package/lib/src/perspectives/PerspectiveClient.test.js +55 -0
  190. package/lib/src/perspectives/PerspectiveDiff.js +4 -31
  191. package/lib/src/perspectives/PerspectiveHandle.js +3 -43
  192. package/lib/src/perspectives/PerspectiveProxy.d.ts +92 -71
  193. package/lib/src/perspectives/PerspectiveProxy.js +273 -310
  194. package/lib/src/runtime/RuntimeClient.d.ts +6 -6
  195. package/lib/src/runtime/RuntimeClient.js +93 -467
  196. package/lib/src/runtime/RuntimeTypes.d.ts +101 -0
  197. package/lib/src/runtime/RuntimeTypes.js +45 -0
  198. package/lib/src/shacl/SHACLShape.d.ts +7 -0
  199. package/lib/src/shacl/SHACLShape.js +19 -0
  200. package/lib/src/shacl/SHACLShape.test.js +82 -0
  201. package/lib/src/typeDefs.js +3 -628
  202. package/package.json +9 -24
  203. package/rollup.config.js +0 -7
  204. package/src/Ad4mClient.test.ts +1179 -1340
  205. package/src/Ad4mClient.ts +30 -15
  206. package/src/agent/Agent.ts +0 -99
  207. package/src/agent/AgentClient.ts +112 -526
  208. package/src/agent/AgentStatus.ts +0 -12
  209. package/src/ai/AIClient.ts +96 -296
  210. package/src/ai/AITypes.ts +66 -0
  211. package/src/ai/Tasks.ts +0 -52
  212. package/src/apiClient.ts +283 -0
  213. package/src/expression/Expression.ts +3 -43
  214. package/src/expression/ExpressionClient.ts +14 -77
  215. package/src/expression/ExpressionRef.ts +0 -6
  216. package/src/generated/api/AIModelLoadingStatus.ts +3 -0
  217. package/src/generated/api/AddLinkExpressionRequest.ts +4 -0
  218. package/src/generated/api/AddLinkRequest.ts +4 -0
  219. package/src/generated/api/AddLinksBulkRequest.ts +4 -0
  220. package/src/generated/api/AddSdnaRequest.ts +3 -0
  221. package/src/generated/api/ApplyTemplateRequest.ts +3 -0
  222. package/src/generated/api/AuthInfoInput.ts +4 -0
  223. package/src/generated/api/CapabilityInput.ts +4 -0
  224. package/src/generated/api/CommitBatchRequest.ts +3 -0
  225. package/src/generated/api/ComputeLogEntry.ts +3 -0
  226. package/src/generated/api/CreateExpressionRequest.ts +3 -0
  227. package/src/generated/api/CreatePerspectiveRequest.ts +3 -0
  228. package/src/generated/api/CreateSubjectRequest.ts +3 -0
  229. package/src/generated/api/EmbedRequest.ts +3 -0
  230. package/src/generated/api/EntanglementProofInput.ts +3 -0
  231. package/src/generated/api/ExecuteCommandsRequest.ts +3 -0
  232. package/src/generated/api/ExportRequest.ts +3 -0
  233. package/src/generated/api/ExpressionManyRequest.ts +3 -0
  234. package/src/generated/api/ExpressionProof.ts +3 -0
  235. package/src/generated/api/ExpressionProofInput.ts +3 -0
  236. package/src/generated/api/FriendSendMessageRequest.ts +3 -0
  237. package/src/generated/api/FriendsListRequest.ts +3 -0
  238. package/src/generated/api/GenerateAgentRequest.ts +3 -0
  239. package/src/generated/api/GenerateJwtRequest.ts +3 -0
  240. package/src/generated/api/GetSubjectDataRequest.ts +3 -0
  241. package/src/generated/api/ImportAgentRequest.ts +3 -0
  242. package/src/generated/api/ImportRequest.ts +3 -0
  243. package/src/generated/api/JoinNeighbourhoodRequest.ts +3 -0
  244. package/src/generated/api/LanguageMetaInput.ts +3 -0
  245. package/src/generated/api/Link.ts +3 -0
  246. package/src/generated/api/LinkExpression.ts +6 -0
  247. package/src/generated/api/LinkExpressionInput.ts +6 -0
  248. package/src/generated/api/LinkInput.ts +3 -0
  249. package/src/generated/api/LinkLanguageTemplatesRequest.ts +3 -0
  250. package/src/generated/api/LinkMutations.ts +5 -0
  251. package/src/generated/api/LinkStatus.ts +3 -0
  252. package/src/generated/api/LockAgentRequest.ts +3 -0
  253. package/src/generated/api/ModelType.ts +3 -0
  254. package/src/generated/api/NotificationInput.ts +3 -0
  255. package/src/generated/api/OpenLinkRequest.ts +3 -0
  256. package/src/generated/api/PermitCapabilityRequest.ts +3 -0
  257. package/src/generated/api/PerspectiveInput.ts +4 -0
  258. package/src/generated/api/PromptRequest.ts +3 -0
  259. package/src/generated/api/PublishLanguageRequest.ts +4 -0
  260. package/src/generated/api/PublishNeighbourhoodRequest.ts +4 -0
  261. package/src/generated/api/QueryRequest.ts +6 -0
  262. package/src/generated/api/RemoveLinkRequest.ts +4 -0
  263. package/src/generated/api/RemoveLinksBulkRequest.ts +4 -0
  264. package/src/generated/api/ResourceInput.ts +3 -0
  265. package/src/generated/api/SetDefaultModelRequest.ts +4 -0
  266. package/src/generated/api/SetFreeHostingEnabledRequest.ts +3 -0
  267. package/src/generated/api/SetMultiUserRequest.ts +3 -0
  268. package/src/generated/api/SetStatusRequest.ts +3 -0
  269. package/src/generated/api/SignMessageRequest.ts +3 -0
  270. package/src/generated/api/TrustedAgentsRequest.ts +3 -0
  271. package/src/generated/api/UnlockAgentRequest.ts +3 -0
  272. package/src/generated/api/UpdateLinkRequest.ts +5 -0
  273. package/src/generated/api/UpdatePerspectiveRequest.ts +3 -0
  274. package/src/generated/api/UserStatistics.ts +3 -0
  275. package/src/generated/api/VerificationRequestResult.ts +3 -0
  276. package/src/generated/api/VerifySignatureRequest.ts +3 -0
  277. package/src/generated/api/WriteSettingsRequest.ts +3 -0
  278. package/src/generated/api/index.ts +49 -0
  279. package/src/index.ts +6 -1
  280. package/src/jestSetup.ts +1 -1
  281. package/src/language/Icon.ts +0 -4
  282. package/src/language/Language.ts +2 -23
  283. package/src/language/LanguageClient.ts +21 -132
  284. package/src/language/LanguageHandle.ts +0 -14
  285. package/src/language/LanguageMeta.ts +0 -29
  286. package/src/language/LanguageRef.ts +0 -7
  287. package/src/links/Links.ts +0 -37
  288. package/src/model/Ad4mModel.test.ts +708 -876
  289. package/src/model/Ad4mModel.ts +613 -508
  290. package/src/model/ModelQueryBuilder.ts +178 -244
  291. package/src/model/decorators.ts +29 -0
  292. package/src/model/hydration.ts +9 -766
  293. package/src/model/index.ts +0 -4
  294. package/src/model/query-sparql.test.ts +34 -242
  295. package/src/model/query-sparql.ts +27 -337
  296. package/src/model/shacl-gen.ts +5 -0
  297. package/src/model/types.ts +51 -39
  298. package/src/neighbourhood/Neighbourhood.ts +0 -9
  299. package/src/neighbourhood/NeighbourhoodClient.ts +42 -207
  300. package/src/neighbourhood/NeighbourhoodProxy.test.ts +34 -36
  301. package/src/perspectives/LinkQuery.ts +0 -15
  302. package/src/perspectives/Perspective.ts +1 -12
  303. package/src/perspectives/PerspectiveClient.test.ts +206 -148
  304. package/src/perspectives/PerspectiveClient.ts +228 -442
  305. package/src/perspectives/PerspectiveDiff.ts +0 -8
  306. package/src/perspectives/PerspectiveHandle.ts +1 -12
  307. package/src/perspectives/PerspectiveProxy.test.ts +41 -0
  308. package/src/perspectives/PerspectiveProxy.ts +307 -348
  309. package/src/runtime/RuntimeClient.ts +112 -474
  310. package/src/runtime/RuntimeTypes.ts +144 -0
  311. package/src/shacl/SHACLShape.test.ts +94 -0
  312. package/src/shacl/SHACLShape.ts +27 -0
  313. package/src/typeDefs.ts +3 -5
  314. package/tsconfig.json +3 -7
  315. package/shims/reflect-metadata.ts +0 -0
  316. package/shims/type-graphql.ts +0 -75
  317. package/src/PubSub.ts +0 -17
  318. package/src/agent/AgentResolver.ts +0 -263
  319. package/src/ai/AIResolver.ts +0 -372
  320. package/src/buildSchema.ts +0 -43
  321. package/src/expression/ExpressionResolver.ts +0 -64
  322. package/src/language/LanguageResolver.ts +0 -98
  323. package/src/model/Subject.ts +0 -159
  324. package/src/model/hydration-batch.ts +0 -205
  325. package/src/model/hydration-batching.test.ts +0 -563
  326. package/src/model/prolog-facts.ts +0 -145
  327. package/src/model/query-prolog.ts +0 -148
  328. package/src/model/query-sparql-batch.ts +0 -301
  329. package/src/model/subscription-delta.test.ts +0 -207
  330. package/src/model/subscription-pool.ts +0 -211
  331. package/src/neighbourhood/NeighbourhoodResolver.ts +0 -100
  332. package/src/perspectives/PerspectiveResolver.ts +0 -364
  333. package/src/runtime/RuntimeResolver.ts +0 -749
  334. package/src/unwrapApolloResult.ts +0 -16
@@ -1,8 +1,10 @@
1
1
  /**
2
2
  * SPARQL query building utilities for Ad4mModel.
3
3
  *
4
- * Uses the direct triple + named graph storage model where each AD4M link
5
- * is stored in a named graph (keyed by link hash) with metadata in the default graph.
4
+ * Uses the RDF 1.2 reifier storage model where each AD4M link is stored as:
5
+ * 1. Direct triple: <source> <predicate> <target> . (default graph)
6
+ * 2. Reifier: <link:HASH> <http://www.w3.org/1999/02/22-rdf-syntax-ns#reifies> <<( source predicate target )>> .
7
+ * 3. Metadata: <link:HASH> ad4m://ontology/* "value" . (default graph)
6
8
  *
7
9
  * All AD4M URIs (source, predicate, target) become RDF IRIs.
8
10
  *
@@ -37,12 +39,7 @@ export function hasJsOnlyWhereFilters(
37
39
  for (const [propertyName, condition] of Object.entries(where)) {
38
40
  if (propertyName === "base" || propertyName === "id") continue;
39
41
 
40
- // author/timestamp: return true so that count() falls back to the full hydration
41
- // path (which uses buildSPARQLQuery — which DOES bind ?author/?timestamp via the
42
- // named graph block). buildSPARQLCountQuery intentionally omits the named graph,
43
- // so emitting an ?author FILTER there would produce unbound-variable SPARQL.
44
- // buildSPARQLWhereFilters still pushes these into FILTER when called from
45
- // buildSPARQLQuery / buildSPARQLGroupedCountQuery, which both include the named graph.
42
+ // author/timestamp filters are handled in JS
46
43
  if (propertyName === "author" || propertyName === "timestamp") return true;
47
44
 
48
45
  const propMeta = metadata.properties[propertyName];
@@ -254,7 +251,7 @@ export function buildSPARQLQuery(
254
251
  filterExpressions.push(...userFilters);
255
252
 
256
253
  // Main triple pattern — fetches all links for matched sources
257
- // The direct triple in named graph: GRAPH ?linkGraph { ?source ?predicate ?target }
254
+ // Direct triple in default graph + RDF 1.2 reifier for link metadata
258
255
  // FILTER(isIRI(?source)) excludes non-IRI subjects
259
256
  const joinClause = joinPatterns.join("\n");
260
257
  const filterClause = filterExpressions.length > 0
@@ -264,13 +261,8 @@ export function buildSPARQLQuery(
264
261
  // Determine if SPARQL-level pagination is safe.
265
262
  // When JS-only where filters exist, we must NOT limit at the SPARQL level
266
263
  // because the database would cap candidates before JS filters run.
267
- // Without an explicit ORDER BY, SPARQL OFFSET/LIMIT produces non-deterministic
268
- // ordering across different query plans and index traversals. Fall back to
269
- // JS-level slicing in that case to preserve the grouping order from the full
270
- // result set.
271
264
  const canPaginateInSPARQL = !hasJsOnlyWhereFilters(metadata, allRelationsMetadata, query.where)
272
- && (query.limit !== undefined || query.offset !== undefined)
273
- && query.order !== undefined && Object.keys(query.order).length > 0;
265
+ && (query.limit !== undefined || query.offset !== undefined);
274
266
 
275
267
  // Build a pagination subquery that constrains ?source to only the page
276
268
  // of interest. This avoids fetching all links for all matching instances.
@@ -282,23 +274,27 @@ export function buildSPARQLQuery(
282
274
  // Use the pagination subquery to constrain ?source, then fetch all links
283
275
  // for those sources only.
284
276
  return `
277
+
285
278
  SELECT ?source ?predicate ?target ?author ?timestamp WHERE {
286
279
  ${paginationSubquery}${joinClause}
287
- GRAPH ?linkGraph { ?source ?predicate ?target . }
280
+ ?source ?predicate ?target .
281
+ ?_reifier <http://www.w3.org/1999/02/22-rdf-syntax-ns#reifies> <<( ?source ?predicate ?target )>> .
288
282
  FILTER(isIRI(?source) && isIRI(?predicate))
289
- ?linkGraph <ad4m://ontology/author> ?author .
290
- ?linkGraph <ad4m://ontology/timestamp> ?timestamp .
283
+ ?_reifier <ad4m://ontology/author> ?author .
284
+ ?_reifier <ad4m://ontology/timestamp> ?timestamp .
291
285
  ${filterClause}
292
286
  }
293
287
  `.trim();
294
288
  }
295
289
 
296
290
  return `
291
+
297
292
  SELECT ?source ?predicate ?target ?author ?timestamp WHERE {${joinClause}
298
- GRAPH ?linkGraph { ?source ?predicate ?target . }
293
+ ?source ?predicate ?target .
294
+ ?_reifier <http://www.w3.org/1999/02/22-rdf-syntax-ns#reifies> <<( ?source ?predicate ?target )>> .
299
295
  FILTER(isIRI(?source) && isIRI(?predicate))
300
- ?linkGraph <ad4m://ontology/author> ?author .
301
- ?linkGraph <ad4m://ontology/timestamp> ?timestamp .
296
+ ?_reifier <ad4m://ontology/author> ?author .
297
+ ?_reifier <ad4m://ontology/timestamp> ?timestamp .
302
298
  ${filterClause}
303
299
  }
304
300
  ${buildSPARQLOrderLimitOffset(metadata, query)}
@@ -339,16 +335,10 @@ export function buildPaginationSubquery(
339
335
  ? `FILTER(\n ${filterExpressions.join(' &&\n ')}\n )`
340
336
  : '';
341
337
 
342
- // Build ORDER BY clause from query.order.
343
- // When ORDER BY references non-grouped variables we must use SAMPLE()
344
- // aggregates so the query is valid SPARQL 1.1.
338
+ // Build ORDER BY clause from query.order
345
339
  let orderByClause = '';
346
340
  const orderJoinPatterns: string[] = [];
347
- const sampleProjections: string[] = []; // e.g. (SAMPLE(?cfTarget_title) AS ?pg_sort_0)
348
- const needsGroupBy = query.order && Object.keys(query.order).length > 0;
349
-
350
341
  if (query.order) {
351
- let sortIdx = 0;
352
342
  const orderTerms = Object.entries(query.order).map(([prop, dir]) => {
353
343
  const sparqlVar = mapPropertyToSPARQLVar(prop, metadata);
354
344
  // Check if this order property's variable is already bound by existing
@@ -360,154 +350,26 @@ export function buildPaginationSubquery(
360
350
  orderJoinPatterns.push(`\n OPTIONAL { ?source <${propMeta.predicate}> ${sparqlVar} . }`);
361
351
  }
362
352
  }
363
- // Use SAMPLE() aggregate so ORDER BY is valid with GROUP BY ?source.
364
- const sortAlias = `?pg_sort_${sortIdx++}`;
365
- sampleProjections.push(`(SAMPLE(${sparqlVar}) AS ${sortAlias})`);
366
- return dir === 'DESC' ? `DESC(${sortAlias})` : `ASC(${sortAlias})`;
353
+ return dir === 'DESC' ? `DESC(${sparqlVar})` : `ASC(${sparqlVar})`;
367
354
  });
368
355
  if (orderTerms.length > 0) {
369
356
  orderByClause = `ORDER BY ${orderTerms.join(' ')}`;
370
357
  }
371
358
  }
372
359
 
360
+ // No default ordering — when no explicit order is specified, results come in
361
+ // natural (insertion) order.
362
+ const tsSelect = '';
363
+ const tsPattern = '';
364
+
373
365
  const limitClause = query.limit !== undefined ? `LIMIT ${query.limit}` : '';
374
366
  const offsetClause = query.offset !== undefined && query.offset > 0 ? `OFFSET ${query.offset}` : '';
375
367
 
376
- // When there's no ORDER BY, DISTINCT alone handles deduplication — no GROUP BY needed.
377
- // When there IS ORDER BY, use GROUP BY ?source with SAMPLE() aggregates for the sort keys.
378
- const sampleSelect = sampleProjections.length > 0 ? ' ' + sampleProjections.join(' ') : '';
379
- const groupByClause = needsGroupBy ? 'GROUP BY ?source' : '';
380
-
381
368
  return `
382
- { SELECT DISTINCT ?source${sampleSelect} WHERE {${innerJoin}${orderJoinPatterns.join('')}
369
+ { SELECT DISTINCT ?source${tsSelect} WHERE {${innerJoin}${orderJoinPatterns.join('')}${tsPattern}
383
370
  FILTER(isIRI(?source))
384
371
  ${innerFilter}
385
- } ${groupByClause} ${orderByClause} ${limitClause} ${offsetClause} }\n`;
386
- }
387
-
388
- /**
389
- * Build a SPARQL COUNT query that returns the total number of matching
390
- * instances WITHOUT hydrating them. Uses the same WHERE clause as
391
- * buildSPARQLQuery but wraps it in SELECT (COUNT(DISTINCT ?source) AS ?count).
392
- *
393
- * LIMIT/OFFSET from the query are stripped internally — this always counts
394
- * the full result set.
395
- */
396
- export function buildSPARQLCountQuery(
397
- metadata: ModelMetadata,
398
- allRelationsMetadata: Record<string, RelationMetadataEntry>,
399
- query: Query,
400
- modelClass: any,
401
- ): string {
402
- // Build the same join/filter patterns as buildSPARQLQuery
403
- const joinPatterns: string[] = [];
404
- const filterExpressions: string[] = [];
405
-
406
- if (query.parent) {
407
- const parentPredicate = resolveParentPredicate(query.parent, modelClass);
408
- joinPatterns.push(`\n ${iri(query.parent.id)} ${iri(parentPredicate)} ?source .`);
409
- }
410
-
411
- let hasConformance = false;
412
- for (const [, propMeta] of Object.entries(metadata.properties)) {
413
- if (propMeta.required) {
414
- if (propMeta.getter) continue;
415
- hasConformance = true;
416
- if (propMeta.flag && propMeta.initial) {
417
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ${iri(propMeta.initial)} .`);
418
- } else {
419
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ?cfTarget_${propMeta.name} .`);
420
- }
421
- }
422
- }
423
-
424
- if (!hasConformance) {
425
- for (const [, propMeta] of Object.entries(metadata.properties)) {
426
- if (propMeta.initial) {
427
- hasConformance = true;
428
- if (propMeta.flag) {
429
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ${iri(propMeta.initial)} .`);
430
- } else {
431
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ?cfInitTarget_${propMeta.name} .`);
432
- }
433
- break;
434
- }
435
- }
436
- }
437
-
438
- if (!hasConformance && joinPatterns.length === 0) {
439
- const knownPredicates: string[] = [];
440
- for (const [, propMeta] of Object.entries(metadata.properties)) {
441
- if (propMeta.predicate) knownPredicates.push(iri(propMeta.predicate));
442
- }
443
- if (metadata.relations) {
444
- for (const [, relMeta] of Object.entries(metadata.relations)) {
445
- if (relMeta.predicate) knownPredicates.push(iri(relMeta.predicate));
446
- }
447
- }
448
- if (knownPredicates.length > 0) {
449
- joinPatterns.push(`\n { SELECT DISTINCT ?source WHERE { ?source ?cf_structPred ?cf_structTarget . FILTER(?cf_structPred IN (${knownPredicates.join(", ")})) } }`);
450
- }
451
- }
452
-
453
- const { joins: userJoins, filters: userFilters } = buildSPARQLWhereFilters(metadata, allRelationsMetadata, query.where);
454
- joinPatterns.push(...userJoins);
455
- filterExpressions.push(...userFilters);
456
-
457
- const joinClause = joinPatterns.join('\n');
458
- const filterClause = filterExpressions.length > 0
459
- ? `FILTER(\n ${filterExpressions.join(' &&\n ')}\n )`
460
- : '';
461
-
462
- return `
463
- SELECT (COUNT(DISTINCT ?source) AS ?count) WHERE {${joinClause}
464
- FILTER(isIRI(?source))
465
- ${filterClause}
466
- }
467
- `.trim();
468
- }
469
-
470
- /**
471
- * Build a SPARQL query to fetch all links for a single instance.
472
- */
473
- export function buildSPARQLGetDataQuery(baseExpression: string): string {
474
- return `
475
- SELECT ?source ?predicate ?target ?author ?timestamp WHERE {
476
- GRAPH ?linkGraph { ${iri(baseExpression)} ?predicate ?target . }
477
- FILTER(isIRI(?predicate))
478
- BIND(${iri(baseExpression)} AS ?source)
479
- ?linkGraph <ad4m://ontology/author> ?author .
480
- ?linkGraph <ad4m://ontology/timestamp> ?timestamp .
481
- }
482
- `.trim();
483
- }
484
-
485
- /**
486
- * Group flat SPARQL link rows into the same shape that SPARQL returned:
487
- * `{ source_uri: string, links: Array<{predicate, target, author, timestamp}> }`
488
- */
489
- export function groupSPARQLResults(
490
- rows: Array<{ source: string; predicate: string; target: string; author: string; timestamp: string }>
491
- ): Array<{ source_uri: string; links: Array<{ predicate: string; target: string; author: string; timestamp: string }> }> {
492
- const grouped = new Map<string, { predicate: string; target: string; author: string; timestamp: string }[]>();
493
-
494
- for (const row of rows) {
495
- const key = row.source;
496
- if (!grouped.has(key)) {
497
- grouped.set(key, []);
498
- }
499
- grouped.get(key)!.push({
500
- predicate: row.predicate,
501
- target: row.target,
502
- author: row.author,
503
- timestamp: row.timestamp,
504
- });
505
- }
506
-
507
- return Array.from(grouped.entries()).map(([source_uri, links]) => ({
508
- source_uri,
509
- links,
510
- }));
372
+ } GROUP BY ?source ${orderByClause} ${limitClause} ${offsetClause} }\n`;
511
373
  }
512
374
 
513
375
  /**
@@ -546,46 +408,7 @@ function buildSPARQLWhereFilters(
546
408
  continue;
547
409
  }
548
410
 
549
- if (propertyName === "author") {
550
- // ?author is bound by the named graph block in buildSPARQLQuery /
551
- // buildSPARQLGroupedCountQuery — push equality/IN filters into SPARQL.
552
- if (Array.isArray(condition)) {
553
- const formatted = (condition as any[]).map(v => formatSPARQLValue(String(v))).join(', ');
554
- filters.push(`STR(?author) IN (${formatted})`);
555
- } else if (typeof condition === 'object' && condition !== null) {
556
- const ops = condition as any;
557
- if (ops.not !== undefined) {
558
- if (Array.isArray(ops.not)) {
559
- const formatted = (ops.not as any[]).map((v: any) => formatSPARQLValue(String(v))).join(', ');
560
- filters.push(`!(STR(?author) IN (${formatted}))`);
561
- } else {
562
- filters.push(`STR(?author) != ${formatSPARQLValue(String(ops.not))}`);
563
- }
564
- }
565
- // Other operators (gt/lt/etc.) fall through to JS post-filter
566
- } else {
567
- filters.push(`STR(?author) = ${formatSPARQLValue(String(condition))}`);
568
- }
569
- continue;
570
- }
571
-
572
- if (propertyName === "timestamp") {
573
- // ?timestamp is bound by the named graph block — push numeric comparisons.
574
- if (typeof condition === 'object' && condition !== null && !Array.isArray(condition)) {
575
- const ops = condition as any;
576
- if (ops.gt !== undefined) filters.push(`?timestamp > ${Number(ops.gt)}`);
577
- if (ops.gte !== undefined) filters.push(`?timestamp >= ${Number(ops.gte)}`);
578
- if (ops.lt !== undefined) filters.push(`?timestamp < ${Number(ops.lt)}`);
579
- if (ops.lte !== undefined) filters.push(`?timestamp <= ${Number(ops.lte)}`);
580
- if (ops.between !== undefined && Array.isArray(ops.between)) {
581
- filters.push(`?timestamp >= ${Number(ops.between[0])} && ?timestamp <= ${Number(ops.between[1])}`);
582
- }
583
- if (ops.not !== undefined) {
584
- filters.push(`?timestamp != ${Number(ops.not)}`);
585
- }
586
- } else if (typeof condition === 'number' || (typeof condition === 'string' && !isNaN(Number(condition)))) {
587
- filters.push(`?timestamp = ${Number(condition)}`);
588
- }
411
+ if (propertyName === "author" || propertyName === "timestamp") {
589
412
  continue;
590
413
  }
591
414
 
@@ -685,136 +508,3 @@ function buildSPARQLWhereFilters(
685
508
 
686
509
  return { joins, filters };
687
510
  }
688
-
689
- /**
690
- * Parse a SPARQL COUNT result row into a number.
691
- * Handles `row.count?.value` (RDF binding), `row.count` (direct number/string),
692
- * NaN results, and empty/malformed results.
693
- *
694
- * @returns The parsed count, or `null` if the result cannot be interpreted.
695
- */
696
- export function parseSparqlCount(result: any[]): number | null {
697
- if (!Array.isArray(result) || result.length === 0) return null;
698
- const row = result[0];
699
- const val = row.count?.value ?? row.count;
700
- if (val === undefined || val === null) return null;
701
- const parsed = typeof val === 'number' ? val : parseInt(String(val), 10);
702
- return isNaN(parsed) ? null : parsed;
703
- }
704
-
705
- /**
706
- * Build a SPARQL query that counts child instances grouped by parent IRI.
707
- *
708
- * Used by the projection Path A (`count: true`) in `hydrateRelations` to get
709
- * per-parent counts in a single round-trip with zero instance hydration.
710
- *
711
- * Includes the full named graph block so that `?author` and `?timestamp` are
712
- * bound and available for SPARQL FILTER expressions (unlike the intentionally
713
- * minimal `buildSPARQLCountQuery` which omits them for speed).
714
- *
715
- * @param metadata - Model metadata for the **child** (target) class
716
- * @param allRelationsMetadata - Relations metadata for the child class
717
- * @param relationPredicate - The predicate linking `?parent` → `?source` (child)
718
- * @param parentIds - IRI strings of all parent instances to count for
719
- * @param where - Optional filter applied to child instances
720
- */
721
- export function buildSPARQLGroupedCountQuery(
722
- metadata: ModelMetadata,
723
- allRelationsMetadata: Record<string, RelationMetadataEntry>,
724
- relationPredicate: string,
725
- parentIds: string[],
726
- where?: import('./types').Where,
727
- ): string {
728
- const joinPatterns: string[] = [];
729
- const filterExpressions: string[] = [];
730
-
731
- // Parent → child join and IN filter
732
- joinPatterns.push(`\n ?parent ${iri(relationPredicate)} ?source .`);
733
- const parentIris = parentIds.map(id => iri(id)).join(', ');
734
- filterExpressions.push(`?parent IN (${parentIris})`);
735
-
736
- // Conformance patterns (mirrors buildSPARQLCountQuery logic)
737
- let hasConformance = false;
738
- for (const [, propMeta] of Object.entries(metadata.properties)) {
739
- if (propMeta.required) {
740
- if (propMeta.getter) continue;
741
- hasConformance = true;
742
- if (propMeta.flag && propMeta.initial) {
743
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ${iri(propMeta.initial)} .`);
744
- } else {
745
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ?cfTarget_${propMeta.name} .`);
746
- }
747
- }
748
- }
749
-
750
- if (!hasConformance) {
751
- for (const [, propMeta] of Object.entries(metadata.properties)) {
752
- if (propMeta.initial) {
753
- hasConformance = true;
754
- if (propMeta.flag) {
755
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ${iri(propMeta.initial)} .`);
756
- } else {
757
- joinPatterns.push(`\n ?source ${iri(propMeta.predicate)} ?cfInitTarget_${propMeta.name} .`);
758
- }
759
- break;
760
- }
761
- }
762
- }
763
-
764
- if (!hasConformance && joinPatterns.length <= 1) {
765
- // Only the parent join so far — add open-world structural matching
766
- const knownPredicates: string[] = [];
767
- for (const [, propMeta] of Object.entries(metadata.properties)) {
768
- if (propMeta.predicate) knownPredicates.push(iri(propMeta.predicate));
769
- }
770
- if (metadata.relations) {
771
- for (const [, relMeta] of Object.entries(metadata.relations)) {
772
- if (relMeta.predicate) knownPredicates.push(iri(relMeta.predicate));
773
- }
774
- }
775
- if (knownPredicates.length > 0) {
776
- joinPatterns.push(`\n { SELECT DISTINCT ?source WHERE { ?source ?cf_structPred ?cf_structTarget . FILTER(?cf_structPred IN (${knownPredicates.join(', ')})) } }`);
777
- }
778
- }
779
-
780
- // User where-clause filters (including author/timestamp after the SPARQL push)
781
- const { joins: userJoins, filters: userFilters } = buildSPARQLWhereFilters(metadata, allRelationsMetadata, where);
782
- joinPatterns.push(...userJoins);
783
- filterExpressions.push(...userFilters);
784
-
785
- const joinClause = joinPatterns.join('\n');
786
- const filterClause = filterExpressions.length > 0
787
- ? `FILTER(\n ${filterExpressions.join(' &&\n ')}\n )`
788
- : '';
789
-
790
- return `
791
- SELECT ?parent (COUNT(DISTINCT ?source) AS ?count) WHERE {${joinClause}
792
- GRAPH ?linkGraph { ?source ?predicate ?target . }
793
- FILTER(isIRI(?source) && isIRI(?predicate))
794
- ?linkGraph <ad4m://ontology/author> ?author .
795
- ?linkGraph <ad4m://ontology/timestamp> ?timestamp .
796
- ${filterClause}
797
- }
798
- GROUP BY ?parent
799
- `.trim();
800
- }
801
-
802
- /**
803
- * Parse the result of `buildSPARQLGroupedCountQuery` into a map from parent IRI
804
- * to count. Missing parents (zero matches) are absent from the map — callers
805
- * should use `map.get(id) ?? 0`.
806
- *
807
- * @returns Map from parentId string → count number
808
- */
809
- export function parseSparqlGroupedCount(result: any[]): Map<string, number> {
810
- const out = new Map<string, number>();
811
- if (!Array.isArray(result)) return out;
812
- for (const row of result) {
813
- const parentVal = row.parent?.value ?? row.parent;
814
- const countVal = row.count?.value ?? row.count;
815
- if (!parentVal || countVal === undefined || countVal === null) continue;
816
- const parsed = typeof countVal === 'number' ? countVal : parseInt(String(countVal), 10);
817
- if (!isNaN(parsed)) out.set(String(parentVal), parsed);
818
- }
819
- return out;
820
- }
@@ -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;
@@ -41,48 +41,12 @@ export type ParentScope =
41
41
  | { model: typeof Ad4mModel; id: string; field?: string }
42
42
  | { id: string; predicate: string };
43
43
 
44
- /**
45
- * Descriptor for a user-named projection — a derived field computed from a
46
- * relation that is attached to the parent instance under a custom `$`-prefixed
47
- * key in the `IncludeMap`.
48
- *
49
- * The `from` field must name a declared relation on the model.
50
- *
51
- * @example
52
- * ```typescript
53
- * include: {
54
- * $signalCount: { from: 'signals', count: true },
55
- * $mySignal: { from: 'signals', where: { author: myDid }, limit: 1 },
56
- * $likeSignals: { from: 'signals', where: { signalTypeId: 'like' } },
57
- * }
58
- * ```
59
- */
60
- export interface IncludeProjection {
61
- /** Declared relation name on the model to derive the projection from. */
62
- from: string;
63
- /**
64
- * When true, the projection result is the count of matching instances
65
- * as a `number`. All other options (`where`, `limit`) are still applied
66
- * before counting. `count: true` → result type is `number`.
67
- */
68
- count?: true;
69
- /** Filter applied to the related instances before the projection result is produced. */
70
- where?: Where;
71
- /**
72
- * Maximum number of results to include.
73
- * When `limit` is `1`, the result type is `T | null` (unwrapped single instance)
74
- * rather than `T[]`.
75
- */
76
- limit?: number;
77
- }
78
-
79
44
  /**
80
45
  * Describes which relations to eager-load when querying.
81
46
  *
82
47
  * Each value is either:
83
48
  * - `true` — hydrate the relation one level deep
84
49
  * - A `RelationSubQuery` — scoped sub-query (filter / sort / paginate / nested include)
85
- * - An `IncludeProjection` — user-named derived field (count, filtered subset, single item)
86
50
  *
87
51
  * @example
88
52
  * ```typescript
@@ -94,20 +58,68 @@ export interface IncludeProjection {
94
58
  *
95
59
  * // Nested eager-load
96
60
  * { comments: { include: { author: true } } }
97
- *
98
- * // Projection: count + filtered single item
99
- * { $signalCount: { from: 'signals', count: true }, $mySignal: { from: 'signals', where: { author: myDid }, limit: 1 } }
100
61
  * ```
101
62
  */
102
63
  export interface IncludeMap {
103
64
  [relation: string]: boolean | RelationSubQuery | IncludeProjection;
104
65
  }
105
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;
109
+ }
110
+
106
111
  export type Query = {
107
112
  /** Filter to instances that are the target of a link from a given parent. */
108
113
  parent?: ParentScope;
109
114
  properties?: string[];
110
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;
111
123
  where?: Where;
112
124
  order?: Order;
113
125
  offset?: number;
@@ -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) {};