@coasys/ad4m 0.12.1-dev → 0.13.0-test-2

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 (97) hide show
  1. package/lib/index.cjs +1469 -781
  2. package/lib/index.js +1453 -779
  3. package/lib/src/Literal.js +6 -5
  4. package/lib/src/agent/AgentClient.d.ts +8 -1
  5. package/lib/src/agent/AgentClient.js +73 -2
  6. package/lib/src/expression/ExpressionRef.js +2 -2
  7. package/lib/src/language/Language.d.ts +41 -3
  8. package/lib/src/model/Ad4mModel.d.ts +28 -28
  9. package/lib/src/model/Ad4mModel.js +129 -101
  10. package/lib/src/model/Ad4mModel.test.js +1543 -535
  11. package/lib/src/model/ModelQueryBuilder.d.ts +48 -34
  12. package/lib/src/model/ModelQueryBuilder.js +163 -78
  13. package/lib/src/model/Subject.js +6 -6
  14. package/lib/src/model/decorators.d.ts +14 -8
  15. package/lib/src/model/decorators.js +41 -14
  16. package/lib/src/model/hydration-batch.d.ts +34 -0
  17. package/lib/src/model/hydration-batch.js +147 -0
  18. package/lib/src/model/hydration.d.ts +3 -3
  19. package/lib/src/model/hydration.js +106 -36
  20. package/lib/src/model/index.d.ts +4 -1
  21. package/lib/src/model/index.js +4 -1
  22. package/lib/src/model/json-schema.js +2 -2
  23. package/lib/src/model/query-cache.d.ts +30 -0
  24. package/lib/src/model/query-cache.js +66 -0
  25. package/lib/src/model/query-cache.test.d.ts +1 -0
  26. package/lib/src/model/query-cache.test.js +43 -0
  27. package/lib/src/model/query-common.d.ts +1 -1
  28. package/lib/src/model/query-common.js +1 -1
  29. package/lib/src/model/query-sparql-batch.d.ts +17 -0
  30. package/lib/src/model/query-sparql-batch.js +260 -0
  31. package/lib/src/model/query-sparql.d.ts +47 -0
  32. package/lib/src/model/query-sparql.js +336 -0
  33. package/lib/src/model/query-utils.d.ts +45 -0
  34. package/lib/src/model/query-utils.js +140 -0
  35. package/lib/src/model/relation-filtering.test.js +15 -15
  36. package/lib/src/model/sdna.js +1 -1
  37. package/lib/src/model/shacl-gen.js +42 -18
  38. package/lib/src/model/subscription-pool.d.ts +39 -0
  39. package/lib/src/model/subscription-pool.js +119 -0
  40. package/lib/src/model/types.d.ts +3 -3
  41. package/lib/src/model/types.js +1 -1
  42. package/lib/src/perspectives/PerspectiveClient.d.ts +1 -17
  43. package/lib/src/perspectives/PerspectiveClient.js +5 -57
  44. package/lib/src/perspectives/PerspectiveProxy.d.ts +51 -30
  45. package/lib/src/perspectives/PerspectiveProxy.js +224 -177
  46. package/lib/src/perspectives/PerspectiveResolver.d.ts +0 -1
  47. package/lib/src/perspectives/PerspectiveResolver.js +0 -11
  48. package/lib/src/perspectives/WakerSubscriptionManager.d.ts +3 -3
  49. package/lib/src/perspectives/WakerSubscriptionManager.js +7 -8
  50. package/lib/src/runtime/RuntimeClient.d.ts +2 -0
  51. package/lib/src/runtime/RuntimeClient.js +17 -0
  52. package/lib/src/runtime/RuntimeResolver.d.ts +14 -0
  53. package/lib/src/runtime/RuntimeResolver.js +84 -0
  54. package/lib/src/schema.gql +14 -1
  55. package/lib/src/shacl/SHACLFlow.d.ts +1 -1
  56. package/lib/src/shacl/SHACLFlow.js +9 -9
  57. package/lib/src/shacl/SHACLShape.d.ts +1 -1
  58. package/lib/src/shacl/SHACLShape.js +38 -38
  59. package/lib/src/typeDefs.js +14 -1
  60. package/lib/src/utils.d.ts +6 -6
  61. package/lib/src/utils.js +6 -6
  62. package/package.json +1 -1
  63. package/src/Literal.test.ts +10 -5
  64. package/src/Literal.ts +6 -5
  65. package/src/agent/AgentClient.ts +81 -1
  66. package/src/expression/ExpressionRef.ts +2 -2
  67. package/src/language/Language.ts +48 -3
  68. package/src/model/Ad4mModel.test.ts +1515 -565
  69. package/src/model/Ad4mModel.ts +142 -102
  70. package/src/model/ModelQueryBuilder.ts +185 -86
  71. package/src/model/Subject.ts +6 -6
  72. package/src/model/decorators.ts +51 -22
  73. package/src/model/hydration-batch.ts +205 -0
  74. package/src/model/hydration.ts +102 -39
  75. package/src/model/index.ts +4 -1
  76. package/src/model/json-schema.ts +2 -2
  77. package/src/model/query-cache.test.ts +54 -0
  78. package/src/model/query-cache.ts +79 -0
  79. package/src/model/query-common.ts +1 -1
  80. package/src/model/query-sparql-batch.ts +301 -0
  81. package/src/model/query-sparql.ts +363 -0
  82. package/src/model/{surreal-utils.ts → query-utils.ts} +40 -27
  83. package/src/model/relation-filtering.test.ts +15 -15
  84. package/src/model/sdna.ts +1 -1
  85. package/src/model/shacl-gen.ts +42 -17
  86. package/src/model/subscription-pool.ts +163 -0
  87. package/src/model/types.ts +3 -3
  88. package/src/perspectives/PerspectiveClient.ts +5 -61
  89. package/src/perspectives/PerspectiveProxy.ts +226 -181
  90. package/src/perspectives/PerspectiveResolver.ts +0 -8
  91. package/src/perspectives/WakerSubscriptionManager.ts +8 -9
  92. package/src/runtime/RuntimeClient.ts +19 -0
  93. package/src/runtime/RuntimeResolver.ts +58 -0
  94. package/src/shacl/SHACLFlow.ts +9 -9
  95. package/src/shacl/SHACLShape.ts +39 -39
  96. package/src/utils.ts +6 -6
  97. package/src/model/query-surreal.ts +0 -280
@@ -1,280 +0,0 @@
1
- /**
2
- * SurrealQL query building utilities for Ad4mModel.
3
- *
4
- * Contains the graph-traversal WHERE clause builder, legacy
5
- * subquery-based clause builders, SELECT-field builders, and
6
- * the main `buildSurrealQLQuery()` function that produces a
7
- * complete SurrealQL query string from a `Query` object.
8
- *
9
- * All functions are stateless — model metadata and relation metadata
10
- * are passed in as parameters instead of accessed via `this`.
11
- *
12
- * @module
13
- */
14
-
15
- import { escapeSurrealString } from "../utils";
16
- import { formatSurrealValue } from "./surreal-utils";
17
- import { resolveParentPredicate } from "./query-common";
18
- import type { RelationMetadataEntry } from "./decorators";
19
- import type {
20
- Where, Query, ModelMetadata
21
- } from "./types";
22
-
23
- // ─── Graph Traversal WHERE Clause ────────────────────────────────────────────
24
-
25
- /**
26
- * Builds WHERE clause filters using SurrealDB graph traversal syntax.
27
- *
28
- * Translates where conditions into `->link[WHERE ...]` / `<-link[WHERE ...]`
29
- * filters that SurrealDB can optimize via graph indexes.
30
- *
31
- * @param metadata - Model metadata from `getModelMetadata()`
32
- * @param allRelationsMetadata - Full relation metadata (needed for belongs-to
33
- * direction detection)
34
- * @param where - User-supplied where conditions
35
- * @returns Combined AND-joined condition string, or empty string
36
- */
37
- export function buildGraphTraversalWhereClause(
38
- metadata: ModelMetadata,
39
- allRelationsMetadata: Record<string, RelationMetadataEntry>,
40
- where?: Where,
41
- ): string {
42
- if (!where) return '';
43
-
44
- const conditions: string[] = [];
45
-
46
- for (const [propertyName, condition] of Object.entries(where)) {
47
- const isSpecial = ['id', 'author', 'timestamp'].includes(propertyName);
48
-
49
- if (isSpecial) {
50
- if (propertyName === 'author' || propertyName === 'timestamp') {
51
- continue; // Filtered post-query in JS
52
- }
53
-
54
- const columnName = 'uri';
55
-
56
- if (Array.isArray(condition)) {
57
- const formattedValues = condition.map(v => formatSurrealValue(v)).join(', ');
58
- conditions.push(`${columnName} IN [${formattedValues}]`);
59
- } else if (typeof condition === 'object' && condition !== null) {
60
- const ops = condition as any;
61
- if (ops.not !== undefined) {
62
- if (Array.isArray(ops.not)) {
63
- const formattedValues = ops.not.map(v => formatSurrealValue(v)).join(', ');
64
- conditions.push(`${columnName} NOT IN [${formattedValues}]`);
65
- } else {
66
- conditions.push(`${columnName} != ${formatSurrealValue(ops.not)}`);
67
- }
68
- }
69
- if (ops.between !== undefined && Array.isArray(ops.between) && ops.between.length === 2) {
70
- conditions.push(`${columnName} >= ${formatSurrealValue(ops.between[0])} AND ${columnName} <= ${formatSurrealValue(ops.between[1])}`);
71
- }
72
- if (ops.gt !== undefined) {
73
- conditions.push(`${columnName} > ${formatSurrealValue(ops.gt)}`);
74
- }
75
- if (ops.gte !== undefined) {
76
- conditions.push(`${columnName} >= ${formatSurrealValue(ops.gte)}`);
77
- }
78
- if (ops.lt !== undefined) {
79
- conditions.push(`${columnName} < ${formatSurrealValue(ops.lt)}`);
80
- }
81
- if (ops.lte !== undefined) {
82
- conditions.push(`${columnName} <= ${formatSurrealValue(ops.lte)}`);
83
- }
84
- if (ops.contains !== undefined) {
85
- conditions.push(`${columnName} CONTAINS ${formatSurrealValue(ops.contains)}`);
86
- }
87
- } else {
88
- conditions.push(`${columnName} = ${formatSurrealValue(condition)}`);
89
- }
90
- } else {
91
- // Regular properties — check relation metadata first for direction
92
- const relMeta = allRelationsMetadata[propertyName];
93
- const isBelongs = relMeta?.kind === 'belongsToOne' || relMeta?.kind === 'belongsToMany';
94
-
95
- if (relMeta) {
96
- const predicate = escapeSurrealString(relMeta.predicate);
97
-
98
- if (Array.isArray(condition)) {
99
- const formattedValues = condition.map(v => formatSurrealValue(v)).join(', ');
100
- if (isBelongs) {
101
- conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri IN [${formattedValues}]]) > 0`);
102
- } else {
103
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri IN [${formattedValues}]]) > 0`);
104
- }
105
- } else if (typeof condition === 'object' && condition !== null) {
106
- const ops = condition as any;
107
- if (ops.not !== undefined) {
108
- if (Array.isArray(ops.not)) {
109
- const formattedValues = ops.not.map(v => formatSurrealValue(v)).join(', ');
110
- if (isBelongs) {
111
- conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri IN [${formattedValues}]]) = 0`);
112
- } else {
113
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri IN [${formattedValues}]]) = 0`);
114
- }
115
- } else {
116
- if (isBelongs) {
117
- conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri = ${formatSurrealValue(ops.not)}]) = 0`);
118
- } else {
119
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri = ${formatSurrealValue(ops.not)}]) = 0`);
120
- }
121
- }
122
- }
123
- } else {
124
- if (isBelongs) {
125
- conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri = ${formatSurrealValue(condition)}]) > 0`);
126
- } else {
127
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri = ${formatSurrealValue(condition)}]) > 0`);
128
- }
129
- }
130
- continue;
131
- }
132
-
133
- const propMeta = metadata.properties[propertyName];
134
- if (!propMeta) continue;
135
-
136
- const predicate = escapeSurrealString(propMeta.predicate);
137
- const targetField = propMeta.resolveLanguage === 'literal' ? 'fn::parse_literal(out.uri)' : 'out.uri';
138
-
139
- if (Array.isArray(condition)) {
140
- const formattedValues = condition.map(v => formatSurrealValue(v)).join(', ');
141
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} IN [${formattedValues}]]) > 0`);
142
- } else if (typeof condition === 'object' && condition !== null) {
143
- const ops = condition as any;
144
- if (ops.not !== undefined) {
145
- if (Array.isArray(ops.not)) {
146
- const formattedValues = ops.not.map(v => formatSurrealValue(v)).join(', ');
147
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} IN [${formattedValues}]]) = 0`);
148
- } else {
149
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} = ${formatSurrealValue(ops.not)}]) = 0`);
150
- }
151
- }
152
- const hasComparisonOps = ops.gt !== undefined || ops.gte !== undefined ||
153
- ops.lt !== undefined || ops.lte !== undefined ||
154
- ops.between !== undefined || ops.contains !== undefined;
155
- if (hasComparisonOps) {
156
- conditions.push(`count(->link[WHERE predicate = '${predicate}']) > 0`);
157
- }
158
- } else {
159
- conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} = ${formatSurrealValue(condition)}]) > 0`);
160
- }
161
- }
162
- }
163
-
164
- return conditions.join(' AND ');
165
- }
166
-
167
- // ─── Main Query Builder ─────────────────────────────────────────────────────
168
-
169
- /**
170
- * Builds a complete SurrealQL query from a Query object and model metadata.
171
- *
172
- * This is the core implementation behind `Ad4mModel.queryToSurrealQL()`.
173
- * It produces a graph-traversal query that:
174
- * 1. Filters nodes by required predicates (conformance check)
175
- * 2. Applies user WHERE conditions
176
- * 3. Fetches all outgoing links for hydration
177
- *
178
- * @param metadata - Model metadata from `getModelMetadata()`
179
- * @param allRelationsMetadata - Full relation registry (for belongs-to detection)
180
- * @param query - Query parameters
181
- * @param modelClass - The model class (for `resolveParentPredicate`)
182
- * @returns Complete SurrealQL query string
183
- */
184
- export function buildSurrealQLQuery(
185
- metadata: ModelMetadata,
186
- allRelationsMetadata: Record<string, RelationMetadataEntry>,
187
- query: Query,
188
- modelClass: any,
189
- ): string {
190
- const { where } = query;
191
-
192
- // Build graph traversal filters for required predicates
193
- const graphTraversalFilters: string[] = [];
194
-
195
- // Parent filter
196
- if (query.parent) {
197
- const parentPredicate = resolveParentPredicate(query.parent, modelClass);
198
- graphTraversalFilters.push(
199
- `count(<-link[WHERE in.uri = ${formatSurrealValue(query.parent.id)} AND predicate = '${escapeSurrealString(parentPredicate)}']) > 0`
200
- );
201
- }
202
-
203
- // Required property filters
204
- for (const [, propMeta] of Object.entries(metadata.properties)) {
205
- if (propMeta.required) {
206
- if (propMeta.getter) continue;
207
- if (propMeta.flag && propMeta.initial) {
208
- graphTraversalFilters.push(
209
- `count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}' AND out.uri = '${escapeSurrealString(propMeta.initial)}']) > 0`
210
- );
211
- } else {
212
- graphTraversalFilters.push(
213
- `count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}']) > 0`
214
- );
215
- }
216
- }
217
- }
218
-
219
- // Fallback: initial-value filters
220
- if (graphTraversalFilters.length === 0) {
221
- for (const [, propMeta] of Object.entries(metadata.properties)) {
222
- if (propMeta.initial) {
223
- if (propMeta.flag) {
224
- graphTraversalFilters.push(
225
- `count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}' AND out.uri = '${escapeSurrealString(propMeta.initial)}']) > 0`
226
- );
227
- } else {
228
- graphTraversalFilters.push(
229
- `count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}']) > 0`
230
- );
231
- }
232
- break;
233
- }
234
- }
235
- }
236
-
237
- // Fallback: open-world structural matching
238
- if (graphTraversalFilters.length === 0) {
239
- const structuralPredicates: string[] = [];
240
- for (const [, propMeta] of Object.entries(metadata.properties)) {
241
- if (propMeta.predicate) {
242
- structuralPredicates.push(`predicate = '${escapeSurrealString(propMeta.predicate)}'`);
243
- }
244
- }
245
- if (metadata.relations) {
246
- for (const [, relMeta] of Object.entries(metadata.relations)) {
247
- if (relMeta.predicate) {
248
- structuralPredicates.push(`predicate = '${escapeSurrealString(relMeta.predicate)}'`);
249
- }
250
- }
251
- }
252
- if (structuralPredicates.length > 0) {
253
- graphTraversalFilters.push(
254
- `count(->link[WHERE (${structuralPredicates.join(' OR ')})]) > 0`
255
- );
256
- }
257
- }
258
-
259
- // User WHERE clause
260
- const userWhereClause = buildGraphTraversalWhereClause(metadata, allRelationsMetadata, where);
261
-
262
- const whereConditions: string[] = [];
263
- whereConditions.push(...graphTraversalFilters);
264
- if (userWhereClause) {
265
- whereConditions.push(userWhereClause);
266
- }
267
- whereConditions.push(`count(->link) > 0`);
268
-
269
- const fullQuery = `
270
- SELECT
271
- id AS source,
272
- uri AS source_uri,
273
- ->link AS links
274
- FROM node
275
- WHERE ${whereConditions.join(' AND ')}
276
- FETCH links
277
- `.trim();
278
-
279
- return fullQuery;
280
- }