@coasys/ad4m 0.13.0-test-2 → 0.13.0-test-3
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.
- package/lib/index.cjs +1060 -147
- package/lib/index.js +1054 -147
- package/lib/src/index.d.ts +0 -1
- package/lib/src/index.js +0 -1
- package/lib/src/language/Language.d.ts +26 -214
- package/lib/src/language/Language.js +28 -2
- package/lib/src/model/Ad4mModel.d.ts +25 -1
- package/lib/src/model/Ad4mModel.js +139 -30
- package/lib/src/model/Ad4mModel.test.js +214 -32
- package/lib/src/model/ModelQueryBuilder.d.ts +19 -0
- package/lib/src/model/ModelQueryBuilder.js +62 -18
- package/lib/src/model/hydration-batching.test.d.ts +7 -0
- package/lib/src/model/hydration-batching.test.js +456 -0
- package/lib/src/model/hydration.d.ts +1 -0
- package/lib/src/model/hydration.js +279 -70
- package/lib/src/model/query-sparql.d.ts +78 -1
- package/lib/src/model/query-sparql.js +447 -16
- package/lib/src/model/query-sparql.test.d.ts +1 -0
- package/lib/src/model/query-sparql.test.js +495 -0
- package/lib/src/model/query-utils.js +4 -0
- package/lib/src/model/subscription-delta.test.d.ts +24 -0
- package/lib/src/model/subscription-delta.test.js +180 -0
- package/lib/src/model/subscription-pool.js +48 -2
- package/lib/src/model/types.d.ts +49 -1
- package/lib/src/perspectives/PerspectiveClient.d.ts +2 -0
- package/lib/src/perspectives/PerspectiveClient.js +37 -9
- package/lib/src/perspectives/PerspectiveClient.test.d.ts +1 -0
- package/lib/src/perspectives/PerspectiveClient.test.js +169 -0
- package/lib/src/perspectives/PerspectiveProxy.d.ts +3 -0
- package/lib/src/perspectives/PerspectiveProxy.js +15 -0
- package/package.json +1 -1
- package/src/Ad4mClient.test.ts +56 -1
- package/src/index.ts +0 -1
- package/src/language/Language.ts +54 -275
- package/src/model/Ad4mModel.test.ts +222 -35
- package/src/model/Ad4mModel.ts +144 -30
- package/src/model/ModelQueryBuilder.ts +66 -18
- package/src/model/hydration-batching.test.ts +563 -0
- package/src/model/hydration.ts +249 -47
- package/src/model/query-sparql.test.ts +568 -0
- package/src/model/query-sparql.ts +473 -16
- package/src/model/query-utils.ts +4 -0
- package/src/model/subscription-delta.test.ts +207 -0
- package/src/model/subscription-pool.ts +50 -2
- package/src/model/types.ts +50 -1
- package/src/perspectives/PerspectiveClient.test.ts +204 -0
- package/src/perspectives/PerspectiveClient.ts +36 -7
- package/src/perspectives/PerspectiveProxy.ts +18 -0
- package/lib/src/model/query-surreal.d.ts +0 -44
- package/lib/src/model/query-surreal.js +0 -249
- package/lib/src/model/surreal-utils.d.ts +0 -42
- package/lib/src/model/surreal-utils.js +0 -128
- package/src/language/LanguageContext.ts +0 -37
- package/tsconfig-browser.json +0 -82
|
@@ -405,6 +405,24 @@ export class PerspectiveProxy {
|
|
|
405
405
|
this.#client.addPerspectiveSyncStateChangeListener(this.#handle.uuid, this.#perspectiveSyncStateChangeCallbacks)
|
|
406
406
|
}
|
|
407
407
|
|
|
408
|
+
/** Update the proxy's internal handle and public fields in-place.
|
|
409
|
+
* Keeps the same object reference so all holders see the update. */
|
|
410
|
+
updateHandle(handle: PerspectiveHandle): void {
|
|
411
|
+
if (handle.uuid !== this.#handle.uuid) {
|
|
412
|
+
throw new Error(
|
|
413
|
+
`PerspectiveProxy.updateHandle: UUID mismatch — proxy is bound to "${this.#handle.uuid}" but received handle with UUID "${handle.uuid}". ` +
|
|
414
|
+
`This would silently diverge from listeners registered under the original UUID.`
|
|
415
|
+
);
|
|
416
|
+
}
|
|
417
|
+
this.#handle = handle;
|
|
418
|
+
this.uuid = handle.uuid;
|
|
419
|
+
this.name = handle.name;
|
|
420
|
+
this.owners = handle.owners;
|
|
421
|
+
this.sharedUrl = handle.sharedUrl;
|
|
422
|
+
this.neighbourhood = handle.neighbourhood;
|
|
423
|
+
this.state = handle.state;
|
|
424
|
+
}
|
|
425
|
+
|
|
408
426
|
/**
|
|
409
427
|
* Escapes special regex characters in a string to prevent ReDoS attacks
|
|
410
428
|
* and regex injection when building dynamic regular expressions.
|
|
@@ -1,44 +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
|
-
import type { RelationMetadataEntry } from "./decorators";
|
|
15
|
-
import type { Where, Query, ModelMetadata } from "./types";
|
|
16
|
-
/**
|
|
17
|
-
* Builds WHERE clause filters using SurrealDB graph traversal syntax.
|
|
18
|
-
*
|
|
19
|
-
* Translates where conditions into `->link[WHERE ...]` / `<-link[WHERE ...]`
|
|
20
|
-
* filters that SurrealDB can optimize via graph indexes.
|
|
21
|
-
*
|
|
22
|
-
* @param metadata - Model metadata from `getModelMetadata()`
|
|
23
|
-
* @param allRelationsMetadata - Full relation metadata (needed for belongs-to
|
|
24
|
-
* direction detection)
|
|
25
|
-
* @param where - User-supplied where conditions
|
|
26
|
-
* @returns Combined AND-joined condition string, or empty string
|
|
27
|
-
*/
|
|
28
|
-
export declare function buildGraphTraversalWhereClause(metadata: ModelMetadata, allRelationsMetadata: Record<string, RelationMetadataEntry>, where?: Where): string;
|
|
29
|
-
/**
|
|
30
|
-
* Builds a complete SurrealQL query from a Query object and model metadata.
|
|
31
|
-
*
|
|
32
|
-
* This is the core implementation behind `Ad4mModel.queryToSurrealQL()`.
|
|
33
|
-
* It produces a graph-traversal query that:
|
|
34
|
-
* 1. Filters nodes by required predicates (conformance check)
|
|
35
|
-
* 2. Applies user WHERE conditions
|
|
36
|
-
* 3. Fetches all outgoing links for hydration
|
|
37
|
-
*
|
|
38
|
-
* @param metadata - Model metadata from `getModelMetadata()`
|
|
39
|
-
* @param allRelationsMetadata - Full relation registry (for belongs-to detection)
|
|
40
|
-
* @param query - Query parameters
|
|
41
|
-
* @param modelClass - The model class (for `resolveParentPredicate`)
|
|
42
|
-
* @returns Complete SurrealQL query string
|
|
43
|
-
*/
|
|
44
|
-
export declare function buildSurrealQLQuery(metadata: ModelMetadata, allRelationsMetadata: Record<string, RelationMetadataEntry>, query: Query, modelClass: any): string;
|
|
@@ -1,249 +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
|
-
import { escapeSurrealString } from "../utils";
|
|
15
|
-
import { formatSurrealValue } from "./surreal-utils";
|
|
16
|
-
import { resolveParentPredicate } from "./query-common";
|
|
17
|
-
// ─── Graph Traversal WHERE Clause ────────────────────────────────────────────
|
|
18
|
-
/**
|
|
19
|
-
* Builds WHERE clause filters using SurrealDB graph traversal syntax.
|
|
20
|
-
*
|
|
21
|
-
* Translates where conditions into `->link[WHERE ...]` / `<-link[WHERE ...]`
|
|
22
|
-
* filters that SurrealDB can optimize via graph indexes.
|
|
23
|
-
*
|
|
24
|
-
* @param metadata - Model metadata from `getModelMetadata()`
|
|
25
|
-
* @param allRelationsMetadata - Full relation metadata (needed for belongs-to
|
|
26
|
-
* direction detection)
|
|
27
|
-
* @param where - User-supplied where conditions
|
|
28
|
-
* @returns Combined AND-joined condition string, or empty string
|
|
29
|
-
*/
|
|
30
|
-
export function buildGraphTraversalWhereClause(metadata, allRelationsMetadata, where) {
|
|
31
|
-
if (!where)
|
|
32
|
-
return '';
|
|
33
|
-
const conditions = [];
|
|
34
|
-
for (const [propertyName, condition] of Object.entries(where)) {
|
|
35
|
-
const isSpecial = ['id', 'author', 'timestamp'].includes(propertyName);
|
|
36
|
-
if (isSpecial) {
|
|
37
|
-
if (propertyName === 'author' || propertyName === 'timestamp') {
|
|
38
|
-
continue; // Filtered post-query in JS
|
|
39
|
-
}
|
|
40
|
-
const columnName = 'uri';
|
|
41
|
-
if (Array.isArray(condition)) {
|
|
42
|
-
const formattedValues = condition.map(v => formatSurrealValue(v)).join(', ');
|
|
43
|
-
conditions.push(`${columnName} IN [${formattedValues}]`);
|
|
44
|
-
}
|
|
45
|
-
else if (typeof condition === 'object' && condition !== null) {
|
|
46
|
-
const ops = condition;
|
|
47
|
-
if (ops.not !== undefined) {
|
|
48
|
-
if (Array.isArray(ops.not)) {
|
|
49
|
-
const formattedValues = ops.not.map(v => formatSurrealValue(v)).join(', ');
|
|
50
|
-
conditions.push(`${columnName} NOT IN [${formattedValues}]`);
|
|
51
|
-
}
|
|
52
|
-
else {
|
|
53
|
-
conditions.push(`${columnName} != ${formatSurrealValue(ops.not)}`);
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
if (ops.between !== undefined && Array.isArray(ops.between) && ops.between.length === 2) {
|
|
57
|
-
conditions.push(`${columnName} >= ${formatSurrealValue(ops.between[0])} AND ${columnName} <= ${formatSurrealValue(ops.between[1])}`);
|
|
58
|
-
}
|
|
59
|
-
if (ops.gt !== undefined) {
|
|
60
|
-
conditions.push(`${columnName} > ${formatSurrealValue(ops.gt)}`);
|
|
61
|
-
}
|
|
62
|
-
if (ops.gte !== undefined) {
|
|
63
|
-
conditions.push(`${columnName} >= ${formatSurrealValue(ops.gte)}`);
|
|
64
|
-
}
|
|
65
|
-
if (ops.lt !== undefined) {
|
|
66
|
-
conditions.push(`${columnName} < ${formatSurrealValue(ops.lt)}`);
|
|
67
|
-
}
|
|
68
|
-
if (ops.lte !== undefined) {
|
|
69
|
-
conditions.push(`${columnName} <= ${formatSurrealValue(ops.lte)}`);
|
|
70
|
-
}
|
|
71
|
-
if (ops.contains !== undefined) {
|
|
72
|
-
conditions.push(`${columnName} CONTAINS ${formatSurrealValue(ops.contains)}`);
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
else {
|
|
76
|
-
conditions.push(`${columnName} = ${formatSurrealValue(condition)}`);
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
else {
|
|
80
|
-
// Regular properties — check relation metadata first for direction
|
|
81
|
-
const relMeta = allRelationsMetadata[propertyName];
|
|
82
|
-
const isBelongs = relMeta?.kind === 'belongsToOne' || relMeta?.kind === 'belongsToMany';
|
|
83
|
-
if (relMeta) {
|
|
84
|
-
const predicate = escapeSurrealString(relMeta.predicate);
|
|
85
|
-
if (Array.isArray(condition)) {
|
|
86
|
-
const formattedValues = condition.map(v => formatSurrealValue(v)).join(', ');
|
|
87
|
-
if (isBelongs) {
|
|
88
|
-
conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri IN [${formattedValues}]]) > 0`);
|
|
89
|
-
}
|
|
90
|
-
else {
|
|
91
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri IN [${formattedValues}]]) > 0`);
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
else if (typeof condition === 'object' && condition !== null) {
|
|
95
|
-
const ops = condition;
|
|
96
|
-
if (ops.not !== undefined) {
|
|
97
|
-
if (Array.isArray(ops.not)) {
|
|
98
|
-
const formattedValues = ops.not.map(v => formatSurrealValue(v)).join(', ');
|
|
99
|
-
if (isBelongs) {
|
|
100
|
-
conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri IN [${formattedValues}]]) = 0`);
|
|
101
|
-
}
|
|
102
|
-
else {
|
|
103
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri IN [${formattedValues}]]) = 0`);
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
else {
|
|
107
|
-
if (isBelongs) {
|
|
108
|
-
conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri = ${formatSurrealValue(ops.not)}]) = 0`);
|
|
109
|
-
}
|
|
110
|
-
else {
|
|
111
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri = ${formatSurrealValue(ops.not)}]) = 0`);
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
else {
|
|
117
|
-
if (isBelongs) {
|
|
118
|
-
conditions.push(`count(<-link[WHERE predicate = '${predicate}' AND in.uri = ${formatSurrealValue(condition)}]) > 0`);
|
|
119
|
-
}
|
|
120
|
-
else {
|
|
121
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND out.uri = ${formatSurrealValue(condition)}]) > 0`);
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
continue;
|
|
125
|
-
}
|
|
126
|
-
const propMeta = metadata.properties[propertyName];
|
|
127
|
-
if (!propMeta)
|
|
128
|
-
continue;
|
|
129
|
-
const predicate = escapeSurrealString(propMeta.predicate);
|
|
130
|
-
const targetField = propMeta.resolveLanguage === 'literal' ? 'fn::parse_literal(out.uri)' : 'out.uri';
|
|
131
|
-
if (Array.isArray(condition)) {
|
|
132
|
-
const formattedValues = condition.map(v => formatSurrealValue(v)).join(', ');
|
|
133
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} IN [${formattedValues}]]) > 0`);
|
|
134
|
-
}
|
|
135
|
-
else if (typeof condition === 'object' && condition !== null) {
|
|
136
|
-
const ops = condition;
|
|
137
|
-
if (ops.not !== undefined) {
|
|
138
|
-
if (Array.isArray(ops.not)) {
|
|
139
|
-
const formattedValues = ops.not.map(v => formatSurrealValue(v)).join(', ');
|
|
140
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} IN [${formattedValues}]]) = 0`);
|
|
141
|
-
}
|
|
142
|
-
else {
|
|
143
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} = ${formatSurrealValue(ops.not)}]) = 0`);
|
|
144
|
-
}
|
|
145
|
-
}
|
|
146
|
-
const hasComparisonOps = ops.gt !== undefined || ops.gte !== undefined ||
|
|
147
|
-
ops.lt !== undefined || ops.lte !== undefined ||
|
|
148
|
-
ops.between !== undefined || ops.contains !== undefined;
|
|
149
|
-
if (hasComparisonOps) {
|
|
150
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}']) > 0`);
|
|
151
|
-
}
|
|
152
|
-
}
|
|
153
|
-
else {
|
|
154
|
-
conditions.push(`count(->link[WHERE predicate = '${predicate}' AND ${targetField} = ${formatSurrealValue(condition)}]) > 0`);
|
|
155
|
-
}
|
|
156
|
-
}
|
|
157
|
-
}
|
|
158
|
-
return conditions.join(' AND ');
|
|
159
|
-
}
|
|
160
|
-
// ─── Main Query Builder ─────────────────────────────────────────────────────
|
|
161
|
-
/**
|
|
162
|
-
* Builds a complete SurrealQL query from a Query object and model metadata.
|
|
163
|
-
*
|
|
164
|
-
* This is the core implementation behind `Ad4mModel.queryToSurrealQL()`.
|
|
165
|
-
* It produces a graph-traversal query that:
|
|
166
|
-
* 1. Filters nodes by required predicates (conformance check)
|
|
167
|
-
* 2. Applies user WHERE conditions
|
|
168
|
-
* 3. Fetches all outgoing links for hydration
|
|
169
|
-
*
|
|
170
|
-
* @param metadata - Model metadata from `getModelMetadata()`
|
|
171
|
-
* @param allRelationsMetadata - Full relation registry (for belongs-to detection)
|
|
172
|
-
* @param query - Query parameters
|
|
173
|
-
* @param modelClass - The model class (for `resolveParentPredicate`)
|
|
174
|
-
* @returns Complete SurrealQL query string
|
|
175
|
-
*/
|
|
176
|
-
export function buildSurrealQLQuery(metadata, allRelationsMetadata, query, modelClass) {
|
|
177
|
-
const { where } = query;
|
|
178
|
-
// Build graph traversal filters for required predicates
|
|
179
|
-
const graphTraversalFilters = [];
|
|
180
|
-
// Parent filter
|
|
181
|
-
if (query.parent) {
|
|
182
|
-
const parentPredicate = resolveParentPredicate(query.parent, modelClass);
|
|
183
|
-
graphTraversalFilters.push(`count(<-link[WHERE in.uri = ${formatSurrealValue(query.parent.id)} AND predicate = '${escapeSurrealString(parentPredicate)}']) > 0`);
|
|
184
|
-
}
|
|
185
|
-
// Required property filters
|
|
186
|
-
for (const [, propMeta] of Object.entries(metadata.properties)) {
|
|
187
|
-
if (propMeta.required) {
|
|
188
|
-
if (propMeta.getter)
|
|
189
|
-
continue;
|
|
190
|
-
if (propMeta.flag && propMeta.initial) {
|
|
191
|
-
graphTraversalFilters.push(`count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}' AND out.uri = '${escapeSurrealString(propMeta.initial)}']) > 0`);
|
|
192
|
-
}
|
|
193
|
-
else {
|
|
194
|
-
graphTraversalFilters.push(`count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}']) > 0`);
|
|
195
|
-
}
|
|
196
|
-
}
|
|
197
|
-
}
|
|
198
|
-
// Fallback: initial-value filters
|
|
199
|
-
if (graphTraversalFilters.length === 0) {
|
|
200
|
-
for (const [, propMeta] of Object.entries(metadata.properties)) {
|
|
201
|
-
if (propMeta.initial) {
|
|
202
|
-
if (propMeta.flag) {
|
|
203
|
-
graphTraversalFilters.push(`count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}' AND out.uri = '${escapeSurrealString(propMeta.initial)}']) > 0`);
|
|
204
|
-
}
|
|
205
|
-
else {
|
|
206
|
-
graphTraversalFilters.push(`count(->link[WHERE predicate = '${escapeSurrealString(propMeta.predicate)}']) > 0`);
|
|
207
|
-
}
|
|
208
|
-
break;
|
|
209
|
-
}
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
// Fallback: open-world structural matching
|
|
213
|
-
if (graphTraversalFilters.length === 0) {
|
|
214
|
-
const structuralPredicates = [];
|
|
215
|
-
for (const [, propMeta] of Object.entries(metadata.properties)) {
|
|
216
|
-
if (propMeta.predicate) {
|
|
217
|
-
structuralPredicates.push(`predicate = '${escapeSurrealString(propMeta.predicate)}'`);
|
|
218
|
-
}
|
|
219
|
-
}
|
|
220
|
-
if (metadata.relations) {
|
|
221
|
-
for (const [, relMeta] of Object.entries(metadata.relations)) {
|
|
222
|
-
if (relMeta.predicate) {
|
|
223
|
-
structuralPredicates.push(`predicate = '${escapeSurrealString(relMeta.predicate)}'`);
|
|
224
|
-
}
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
if (structuralPredicates.length > 0) {
|
|
228
|
-
graphTraversalFilters.push(`count(->link[WHERE (${structuralPredicates.join(' OR ')})]) > 0`);
|
|
229
|
-
}
|
|
230
|
-
}
|
|
231
|
-
// User WHERE clause
|
|
232
|
-
const userWhereClause = buildGraphTraversalWhereClause(metadata, allRelationsMetadata, where);
|
|
233
|
-
const whereConditions = [];
|
|
234
|
-
whereConditions.push(...graphTraversalFilters);
|
|
235
|
-
if (userWhereClause) {
|
|
236
|
-
whereConditions.push(userWhereClause);
|
|
237
|
-
}
|
|
238
|
-
whereConditions.push(`count(->link) > 0`);
|
|
239
|
-
const fullQuery = `
|
|
240
|
-
SELECT
|
|
241
|
-
id AS source,
|
|
242
|
-
uri AS source_uri,
|
|
243
|
-
->link AS links
|
|
244
|
-
FROM node
|
|
245
|
-
WHERE ${whereConditions.join(' AND ')}
|
|
246
|
-
FETCH links
|
|
247
|
-
`.trim();
|
|
248
|
-
return fullQuery;
|
|
249
|
-
}
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Shared SurrealQL 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
|
-
import type { WhereCondition, Where, ModelMetadata } from "./types";
|
|
8
|
-
/**
|
|
9
|
-
* Format a JavaScript value for embedding in a SurrealQL expression.
|
|
10
|
-
*
|
|
11
|
-
* - Strings are single-quoted with backslash / quote / newline escaping
|
|
12
|
-
* - Numbers and booleans are passed through as-is
|
|
13
|
-
* - Arrays are recursed
|
|
14
|
-
*/
|
|
15
|
-
export declare function formatSurrealValue(value: any): string;
|
|
16
|
-
/**
|
|
17
|
-
* Compile a single Where condition for a property into a SurrealQL
|
|
18
|
-
* graph-traversal sub-expression.
|
|
19
|
-
*
|
|
20
|
-
* Operates on the **target node** — generates `count(->link[WHERE ...]) > 0`
|
|
21
|
-
* style checks that can be used inside a `[WHERE ...]` filter on nodes.
|
|
22
|
-
*
|
|
23
|
-
* @param predicate - The predicate URI for the property
|
|
24
|
-
* @param condition - The Where condition value
|
|
25
|
-
* @param opts - Optional settings (e.g. `resolveLanguage`)
|
|
26
|
-
* @returns A single SurrealQL condition string
|
|
27
|
-
*/
|
|
28
|
-
export declare function buildWhereCondition(predicate: string, condition: WhereCondition, opts?: {
|
|
29
|
-
resolveLanguage?: string;
|
|
30
|
-
}): string;
|
|
31
|
-
/**
|
|
32
|
-
* Compile a full `Where` clause to an array of SurrealQL condition strings.
|
|
33
|
-
*
|
|
34
|
-
* When `metadata` is provided, property names are resolved to predicates
|
|
35
|
-
* using the model's property metadata. When `metadata` is `null`, property
|
|
36
|
-
* names are treated as raw predicate URIs.
|
|
37
|
-
*
|
|
38
|
-
* Only handles **regular properties** — special fields (`id`, `author`,
|
|
39
|
-
* `timestamp`) and relation fields are skipped (they are only relevant at
|
|
40
|
-
* runtime query time, not for compile-time getter generation).
|
|
41
|
-
*/
|
|
42
|
-
export declare function compileWhereClause(where: Where, metadata: ModelMetadata | null): string[];
|
|
@@ -1,128 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Shared SurrealQL 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
|
-
import { escapeSurrealString } from "../utils";
|
|
8
|
-
/**
|
|
9
|
-
* Format a JavaScript value for embedding in a SurrealQL expression.
|
|
10
|
-
*
|
|
11
|
-
* - Strings are single-quoted with backslash / quote / newline escaping
|
|
12
|
-
* - Numbers and booleans are passed through as-is
|
|
13
|
-
* - Arrays are recursed
|
|
14
|
-
*/
|
|
15
|
-
export function formatSurrealValue(value) {
|
|
16
|
-
if (typeof value === 'string') {
|
|
17
|
-
// Escape backslashes first, then single quotes and other special characters
|
|
18
|
-
const escaped = value
|
|
19
|
-
.replace(/\\/g, '\\\\') // Backslash -> \\
|
|
20
|
-
.replace(/'/g, "\\'") // Single quote -> \'
|
|
21
|
-
.replace(/"/g, '\\"') // Double quote -> \"
|
|
22
|
-
.replace(/\n/g, '\\n') // Newline -> \n
|
|
23
|
-
.replace(/\r/g, '\\r') // Carriage return -> \r
|
|
24
|
-
.replace(/\t/g, '\\t'); // Tab -> \t
|
|
25
|
-
return `'${escaped}'`;
|
|
26
|
-
}
|
|
27
|
-
else if (typeof value === 'number' || typeof value === 'boolean') {
|
|
28
|
-
return String(value);
|
|
29
|
-
}
|
|
30
|
-
else if (Array.isArray(value)) {
|
|
31
|
-
return `[${value.map(v => formatSurrealValue(v)).join(', ')}]`;
|
|
32
|
-
}
|
|
33
|
-
else {
|
|
34
|
-
return String(value);
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Compile a single Where condition for a property into a SurrealQL
|
|
39
|
-
* graph-traversal sub-expression.
|
|
40
|
-
*
|
|
41
|
-
* Operates on the **target node** — generates `count(->link[WHERE ...]) > 0`
|
|
42
|
-
* style checks that can be used inside a `[WHERE ...]` filter on nodes.
|
|
43
|
-
*
|
|
44
|
-
* @param predicate - The predicate URI for the property
|
|
45
|
-
* @param condition - The Where condition value
|
|
46
|
-
* @param opts - Optional settings (e.g. `resolveLanguage`)
|
|
47
|
-
* @returns A single SurrealQL condition string
|
|
48
|
-
*/
|
|
49
|
-
export function buildWhereCondition(predicate, condition, opts) {
|
|
50
|
-
const escapedPredicate = escapeSurrealString(predicate);
|
|
51
|
-
const targetField = opts?.resolveLanguage === 'literal'
|
|
52
|
-
? 'fn::parse_literal(out.uri)'
|
|
53
|
-
: 'out.uri';
|
|
54
|
-
if (Array.isArray(condition)) {
|
|
55
|
-
// Array values → IN clause
|
|
56
|
-
const formattedValues = condition.map(v => formatSurrealValue(v)).join(', ');
|
|
57
|
-
return `count(->link[WHERE predicate = '${escapedPredicate}' AND ${targetField} IN [${formattedValues}]]) > 0`;
|
|
58
|
-
}
|
|
59
|
-
else if (typeof condition === 'object' && condition !== null) {
|
|
60
|
-
// Operator object
|
|
61
|
-
const ops = condition;
|
|
62
|
-
const parts = [];
|
|
63
|
-
if (ops.not !== undefined) {
|
|
64
|
-
if (Array.isArray(ops.not)) {
|
|
65
|
-
const formattedValues = ops.not.map((v) => formatSurrealValue(v)).join(', ');
|
|
66
|
-
parts.push(`count(->link[WHERE predicate = '${escapedPredicate}' AND ${targetField} IN [${formattedValues}]]) = 0`);
|
|
67
|
-
}
|
|
68
|
-
else {
|
|
69
|
-
parts.push(`count(->link[WHERE predicate = '${escapedPredicate}' AND ${targetField} = ${formatSurrealValue(ops.not)}]) = 0`);
|
|
70
|
-
}
|
|
71
|
-
}
|
|
72
|
-
// Comparison operators — ensure property exists (actual comparison
|
|
73
|
-
// may be post-filtered in JS at runtime, but the SurrealQL condition
|
|
74
|
-
// is valid for compile-time getter generation too).
|
|
75
|
-
const hasComparisonOps = ops.gt !== undefined || ops.gte !== undefined ||
|
|
76
|
-
ops.lt !== undefined || ops.lte !== undefined ||
|
|
77
|
-
ops.between !== undefined || ops.contains !== undefined;
|
|
78
|
-
if (hasComparisonOps) {
|
|
79
|
-
parts.push(`count(->link[WHERE predicate = '${escapedPredicate}']) > 0`);
|
|
80
|
-
}
|
|
81
|
-
return parts.join(' AND ');
|
|
82
|
-
}
|
|
83
|
-
else {
|
|
84
|
-
// Simple equality
|
|
85
|
-
return `count(->link[WHERE predicate = '${escapedPredicate}' AND ${targetField} = ${formatSurrealValue(condition)}]) > 0`;
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* Compile a full `Where` clause to an array of SurrealQL condition strings.
|
|
90
|
-
*
|
|
91
|
-
* When `metadata` is provided, property names are resolved to predicates
|
|
92
|
-
* using the model's property metadata. When `metadata` is `null`, property
|
|
93
|
-
* names are treated as raw predicate URIs.
|
|
94
|
-
*
|
|
95
|
-
* Only handles **regular properties** — special fields (`id`, `author`,
|
|
96
|
-
* `timestamp`) and relation fields are skipped (they are only relevant at
|
|
97
|
-
* runtime query time, not for compile-time getter generation).
|
|
98
|
-
*/
|
|
99
|
-
export function compileWhereClause(where, metadata) {
|
|
100
|
-
const conditions = [];
|
|
101
|
-
for (const [propertyName, condition] of Object.entries(where)) {
|
|
102
|
-
// Skip special fields that don't apply at compile time
|
|
103
|
-
if (['id', 'author', 'timestamp'].includes(propertyName))
|
|
104
|
-
continue;
|
|
105
|
-
let predicate;
|
|
106
|
-
let resolveLanguage;
|
|
107
|
-
if (metadata) {
|
|
108
|
-
const propMeta = metadata.properties[propertyName];
|
|
109
|
-
if (propMeta) {
|
|
110
|
-
predicate = propMeta.predicate;
|
|
111
|
-
resolveLanguage = propMeta.resolveLanguage;
|
|
112
|
-
}
|
|
113
|
-
else {
|
|
114
|
-
// Property not found in metadata — treat name as raw predicate URI
|
|
115
|
-
predicate = propertyName;
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
else {
|
|
119
|
-
// No metadata — treat name as raw predicate URI
|
|
120
|
-
predicate = propertyName;
|
|
121
|
-
}
|
|
122
|
-
const cond = buildWhereCondition(predicate, condition, { resolveLanguage });
|
|
123
|
-
if (cond) {
|
|
124
|
-
conditions.push(cond);
|
|
125
|
-
}
|
|
126
|
-
}
|
|
127
|
-
return conditions;
|
|
128
|
-
}
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
import type { AppSignalCb } from '@holochain/client'
|
|
2
|
-
import { Expression } from "../expression/Expression";
|
|
3
|
-
|
|
4
|
-
export interface AgentService {
|
|
5
|
-
readonly did: string
|
|
6
|
-
createSignedExpression(data: any): Expression
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
export interface SignaturesService {
|
|
10
|
-
verify(expr: Expression): boolean
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
export interface LanguageContext {
|
|
14
|
-
agent: AgentService;
|
|
15
|
-
signatures: SignaturesService;
|
|
16
|
-
storageDirectory: string;
|
|
17
|
-
customSettings: object;
|
|
18
|
-
Holochain: HolochainLanguageDelegate | undefined;
|
|
19
|
-
ad4mSignal: Ad4mSignalCB;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
export class Dna {
|
|
23
|
-
file: Buffer
|
|
24
|
-
nick: string
|
|
25
|
-
zomeCalls: [string, string][]
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export interface HolochainLanguageDelegate {
|
|
29
|
-
/** Installs/registers a given DNA in the ad4m-executor */
|
|
30
|
-
registerDNAs(dnas: Dna[], holochainSignalCallback?: AppSignalCb): Promise<void>;
|
|
31
|
-
/** Makes a single call to a given holochain DNA. Underlying implementation puts these calls into a sync fifo queue */
|
|
32
|
-
call(dnaNick: string, zomeName: string, fnName: string, params: object|string): Promise<any>;
|
|
33
|
-
/** Makes all supplied calls in parallel to the provided holochain dna... Should only be called on read operations to avoid source chain async mutation errors */
|
|
34
|
-
callAsync(calls: {dnaNick: string, zomeName: string, fnName: string, params: object|string}[], timeoutMs?: number): Promise<any[]>;
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
export type Ad4mSignalCB = (signal: any) => void
|
package/tsconfig-browser.json
DELETED
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"include": ["./src/**/*.ts"],
|
|
3
|
-
"exclude": ["./src/buildSchema.ts", "./src/Ad4mClient.test.ts"],
|
|
4
|
-
"compilerOptions": {
|
|
5
|
-
"baseUrl": ".",
|
|
6
|
-
"paths": {
|
|
7
|
-
"type-graphql": ["./shims/type-graphql.ts"],
|
|
8
|
-
"reflect-metadata": ["./shims/reflect-metadata.ts"]
|
|
9
|
-
},
|
|
10
|
-
/* Visit https://aka.ms/tsconfig.json to read more about this file */
|
|
11
|
-
|
|
12
|
-
/* Basic Options */
|
|
13
|
-
// "incremental": true, /* Enable incremental compilation */
|
|
14
|
-
"target": "es2018", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
|
|
15
|
-
"lib": ["es2018", "esnext.asynciterable"],
|
|
16
|
-
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
|
|
17
|
-
// "lib": [], /* Specify library files to be included in the compilation. */
|
|
18
|
-
// "allowJs": true, /* Allow javascript files to be compiled. */
|
|
19
|
-
// "checkJs": true, /* Report errors in .js files. */
|
|
20
|
-
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
|
|
21
|
-
"declaration": true, /* Generates corresponding '.d.ts' file. */
|
|
22
|
-
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
|
|
23
|
-
// "sourceMap": true, /* Generates corresponding '.map' file. */
|
|
24
|
-
// "outFile": "./", /* Concatenate and emit output to single file. */
|
|
25
|
-
"rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
|
|
26
|
-
"outDir": "./lib",
|
|
27
|
-
// "composite": true, /* Enable project compilation */
|
|
28
|
-
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
|
|
29
|
-
// "removeComments": true, /* Do not emit comments to output. */
|
|
30
|
-
// "noEmit": true, /* Do not emit outputs. */
|
|
31
|
-
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
|
|
32
|
-
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
|
|
33
|
-
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
|
|
34
|
-
|
|
35
|
-
/* Strict Type-Checking Options */
|
|
36
|
-
// "strict": true, /* Enable all strict type-checking options. */
|
|
37
|
-
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
|
|
38
|
-
// "strictNullChecks": true, /* Enable strict null checks. */
|
|
39
|
-
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
|
40
|
-
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
|
41
|
-
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
|
42
|
-
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
|
|
43
|
-
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
|
|
44
|
-
|
|
45
|
-
/* Additional Checks */
|
|
46
|
-
// "noUnusedLocals": true, /* Report errors on unused locals. */
|
|
47
|
-
// "noUnusedParameters": true, /* Report errors on unused parameters. */
|
|
48
|
-
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
|
|
49
|
-
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
|
|
50
|
-
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
|
|
51
|
-
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
|
|
52
|
-
|
|
53
|
-
/* Module Resolution Options */
|
|
54
|
-
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
|
|
55
|
-
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
|
|
56
|
-
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
|
|
57
|
-
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
|
58
|
-
// "typeRoots": [], /* List of folders to include type definitions from. */
|
|
59
|
-
// "types": [], /* Type declaration files to be included in compilation. */
|
|
60
|
-
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
|
|
61
|
-
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
|
|
62
|
-
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
|
|
63
|
-
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
|
64
|
-
|
|
65
|
-
/* Source Map Options */
|
|
66
|
-
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
|
67
|
-
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
|
68
|
-
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
|
|
69
|
-
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
|
|
70
|
-
|
|
71
|
-
/* Experimental Options */
|
|
72
|
-
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
|
73
|
-
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
|
74
|
-
|
|
75
|
-
/* Advanced Options */
|
|
76
|
-
"skipLibCheck": true, /* Skip type checking of declaration files. */
|
|
77
|
-
"forceConsistentCasingInFileNames": true, /* Disallow inconsistently-cased references to the same file. */
|
|
78
|
-
"emitDecoratorMetadata": true,
|
|
79
|
-
"experimentalDecorators": true,
|
|
80
|
-
"allowSyntheticDefaultImports": true
|
|
81
|
-
},
|
|
82
|
-
}
|