@coasys/ad4m 0.13.0-test-7 → 0.13.0-test-8
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 +1109 -828
- package/lib/index.js +1096 -828
- package/lib/src/Ad4mClient.d.ts +4 -1
- package/lib/src/Ad4mClient.js +2 -2
- package/lib/src/agent/AgentClient.js +17 -0
- package/lib/src/ai/AIClient.js +1 -1
- package/lib/src/apiClient.d.ts +5 -1
- package/lib/src/apiClient.js +14 -6
- package/lib/src/generated/rest/AIModelLoadingStatus.d.ts +7 -0
- package/lib/src/generated/rest/AIModelLoadingStatus.js +2 -0
- package/lib/src/generated/rest/AddAgentInfosRequest.d.ts +3 -0
- package/lib/src/generated/rest/AddAgentInfosRequest.js +2 -0
- package/lib/src/generated/rest/AddLinkExpressionRequest.d.ts +6 -0
- package/lib/src/generated/rest/AddLinkExpressionRequest.js +1 -0
- package/lib/src/generated/rest/AddLinkRequest.d.ts +6 -0
- package/lib/src/generated/rest/AddLinkRequest.js +1 -0
- package/lib/src/generated/rest/AddLinksBulkRequest.d.ts +6 -0
- package/lib/src/generated/rest/AddLinksBulkRequest.js +1 -0
- package/lib/src/generated/rest/AddSdnaRequest.d.ts +6 -0
- package/lib/src/generated/rest/AddSdnaRequest.js +2 -0
- package/lib/src/generated/rest/ApplyTemplateRequest.d.ts +4 -0
- package/lib/src/generated/rest/ApplyTemplateRequest.js +2 -0
- package/lib/src/generated/rest/AuthInfoInput.d.ts +10 -0
- package/lib/src/generated/rest/AuthInfoInput.js +1 -0
- package/lib/src/generated/rest/BroadcastRequest.d.ts +6 -0
- package/lib/src/generated/rest/BroadcastRequest.js +1 -0
- package/lib/src/generated/rest/CapabilityInput.d.ts +5 -0
- package/lib/src/generated/rest/CapabilityInput.js +1 -0
- package/lib/src/generated/rest/CommitBatchRequest.d.ts +3 -0
- package/lib/src/generated/rest/CommitBatchRequest.js +2 -0
- package/lib/src/generated/rest/ComputeLogEntry.d.ts +9 -0
- package/lib/src/generated/rest/ComputeLogEntry.js +2 -0
- package/lib/src/generated/rest/CreateExpressionRequest.d.ts +4 -0
- package/lib/src/generated/rest/CreateExpressionRequest.js +2 -0
- package/lib/src/generated/rest/CreatePerspectiveRequest.d.ts +3 -0
- package/lib/src/generated/rest/CreatePerspectiveRequest.js +2 -0
- package/lib/src/generated/rest/CreateSubjectRequest.d.ts +6 -0
- package/lib/src/generated/rest/CreateSubjectRequest.js +2 -0
- package/lib/src/generated/rest/CreateUserRequest.d.ts +4 -0
- package/lib/src/generated/rest/CreateUserRequest.js +2 -0
- package/lib/src/generated/rest/CreateUserResponse.d.ts +5 -0
- package/lib/src/generated/rest/CreateUserResponse.js +2 -0
- package/lib/src/generated/rest/DecoratedExpressionProof.d.ts +6 -0
- package/lib/src/generated/rest/DecoratedExpressionProof.js +2 -0
- package/lib/src/generated/rest/DecoratedLinkExpression.d.ts +10 -0
- package/lib/src/generated/rest/DecoratedLinkExpression.js +1 -0
- package/lib/src/generated/rest/DisposeQueryRequest.d.ts +3 -0
- package/lib/src/generated/rest/DisposeQueryRequest.js +2 -0
- package/lib/src/generated/rest/EmailTestRequest.d.ts +6 -0
- package/lib/src/generated/rest/EmailTestRequest.js +2 -0
- package/lib/src/generated/rest/EmbedRequest.d.ts +4 -0
- package/lib/src/generated/rest/EmbedRequest.js +2 -0
- package/lib/src/generated/rest/EntanglementProofInput.d.ts +6 -0
- package/lib/src/generated/rest/EntanglementProofInput.js +2 -0
- package/lib/src/generated/rest/EntanglementProofPreflightRequest.d.ts +4 -0
- package/lib/src/generated/rest/EntanglementProofPreflightRequest.js +2 -0
- package/lib/src/generated/rest/ExecuteCommandsRequest.d.ts +4 -0
- package/lib/src/generated/rest/ExecuteCommandsRequest.js +2 -0
- package/lib/src/generated/rest/ExportRequest.d.ts +5 -0
- package/lib/src/generated/rest/ExportRequest.js +2 -0
- package/lib/src/generated/rest/ExpressionManyRequest.d.ts +3 -0
- package/lib/src/generated/rest/ExpressionManyRequest.js +2 -0
- package/lib/src/generated/rest/ExpressionProof.d.ts +4 -0
- package/lib/src/generated/rest/ExpressionProof.js +2 -0
- package/lib/src/generated/rest/ExpressionProofInput.d.ts +6 -0
- package/lib/src/generated/rest/ExpressionProofInput.js +2 -0
- package/lib/src/generated/rest/FriendSendMessageRequest.d.ts +3 -0
- package/lib/src/generated/rest/FriendSendMessageRequest.js +2 -0
- package/lib/src/generated/rest/FriendsListRequest.d.ts +3 -0
- package/lib/src/generated/rest/FriendsListRequest.js +2 -0
- package/lib/src/generated/rest/GenerateAgentRequest.d.ts +3 -0
- package/lib/src/generated/rest/GenerateAgentRequest.js +2 -0
- package/lib/src/generated/rest/GenerateJwtRequest.d.ts +4 -0
- package/lib/src/generated/rest/GenerateJwtRequest.js +2 -0
- package/lib/src/generated/rest/GetSubjectDataRequest.d.ts +4 -0
- package/lib/src/generated/rest/GetSubjectDataRequest.js +2 -0
- package/lib/src/generated/rest/HostingInfoResponse.d.ts +5 -0
- package/lib/src/generated/rest/HostingInfoResponse.js +2 -0
- package/lib/src/generated/rest/HostingWalletResponse.d.ts +4 -0
- package/lib/src/generated/rest/HostingWalletResponse.js +2 -0
- package/lib/src/generated/rest/ImportAgentRequest.d.ts +6 -0
- package/lib/src/generated/rest/ImportAgentRequest.js +2 -0
- package/lib/src/generated/rest/ImportRequest.d.ts +4 -0
- package/lib/src/generated/rest/ImportRequest.js +2 -0
- package/lib/src/generated/rest/JoinNeighbourhoodRequest.d.ts +3 -0
- package/lib/src/generated/rest/JoinNeighbourhoodRequest.js +2 -0
- package/lib/src/generated/rest/KeepAliveQueryRequest.d.ts +3 -0
- package/lib/src/generated/rest/KeepAliveQueryRequest.js +2 -0
- package/lib/src/generated/rest/LanguageMetaInput.d.ts +6 -0
- package/lib/src/generated/rest/LanguageMetaInput.js +2 -0
- package/lib/src/generated/rest/Link.d.ts +5 -0
- package/lib/src/generated/rest/Link.js +2 -0
- package/lib/src/generated/rest/LinkExpression.d.ts +10 -0
- package/lib/src/generated/rest/LinkExpression.js +1 -0
- package/lib/src/generated/rest/LinkExpressionInput.d.ts +10 -0
- package/lib/src/generated/rest/LinkExpressionInput.js +1 -0
- package/lib/src/generated/rest/LinkInput.d.ts +5 -0
- package/lib/src/generated/rest/LinkInput.js +2 -0
- package/lib/src/generated/rest/LinkLanguageTemplatesRequest.d.ts +3 -0
- package/lib/src/generated/rest/LinkLanguageTemplatesRequest.js +2 -0
- package/lib/src/generated/rest/LinkMutationRequest.d.ts +12 -0
- package/lib/src/generated/rest/LinkMutationRequest.js +1 -0
- package/lib/src/generated/rest/LinkMutationResponse.d.ts +9 -0
- package/lib/src/generated/rest/LinkMutationResponse.js +1 -0
- package/lib/src/generated/rest/LinkMutations.d.ts +6 -0
- package/lib/src/generated/rest/LinkMutations.js +1 -0
- package/lib/src/generated/rest/LinkMutationsRequest.d.ts +5 -0
- package/lib/src/generated/rest/LinkMutationsRequest.js +1 -0
- package/lib/src/generated/rest/LinkStatus.d.ts +1 -0
- package/lib/src/generated/rest/LinkStatus.js +2 -0
- package/lib/src/generated/rest/LinkUpdateInput.d.ts +5 -0
- package/lib/src/generated/rest/LinkUpdateInput.js +1 -0
- package/lib/src/generated/rest/LockAgentRequest.d.ts +3 -0
- package/lib/src/generated/rest/LockAgentRequest.js +2 -0
- package/lib/src/generated/rest/LoginUserRequest.d.ts +5 -0
- package/lib/src/generated/rest/LoginUserRequest.js +2 -0
- package/lib/src/generated/rest/ModelType.d.ts +1 -0
- package/lib/src/generated/rest/ModelType.js +2 -0
- package/lib/src/generated/rest/NotificationGrantRequest.d.ts +3 -0
- package/lib/src/generated/rest/NotificationGrantRequest.js +2 -0
- package/lib/src/generated/rest/NotificationInput.d.ts +10 -0
- package/lib/src/generated/rest/NotificationInput.js +2 -0
- package/lib/src/generated/rest/OpenLinkRequest.d.ts +3 -0
- package/lib/src/generated/rest/OpenLinkRequest.js +2 -0
- package/lib/src/generated/rest/PermitCapabilityRequest.d.ts +3 -0
- package/lib/src/generated/rest/PermitCapabilityRequest.js +2 -0
- package/lib/src/generated/rest/PerspectiveInput.d.ts +4 -0
- package/lib/src/generated/rest/PerspectiveInput.js +1 -0
- package/lib/src/generated/rest/PromptRequest.d.ts +4 -0
- package/lib/src/generated/rest/PromptRequest.js +2 -0
- package/lib/src/generated/rest/PublicPerspectiveInput.d.ts +4 -0
- package/lib/src/generated/rest/PublicPerspectiveInput.js +1 -0
- package/lib/src/generated/rest/PublishLanguageRequest.d.ts +5 -0
- package/lib/src/generated/rest/PublishLanguageRequest.js +1 -0
- package/lib/src/generated/rest/PublishNeighbourhoodRequest.d.ts +6 -0
- package/lib/src/generated/rest/PublishNeighbourhoodRequest.js +1 -0
- package/lib/src/generated/rest/QueryRequest.d.ts +7 -0
- package/lib/src/generated/rest/QueryRequest.js +2 -0
- package/lib/src/generated/rest/RemoveLinkRequest.d.ts +5 -0
- package/lib/src/generated/rest/RemoveLinkRequest.js +1 -0
- package/lib/src/generated/rest/RemoveLinksBulkRequest.d.ts +5 -0
- package/lib/src/generated/rest/RemoveLinksBulkRequest.js +1 -0
- package/lib/src/generated/rest/RequestCapabilityRequest.d.ts +4 -0
- package/lib/src/generated/rest/RequestCapabilityRequest.js +1 -0
- package/lib/src/generated/rest/RequestPaymentRequest.d.ts +3 -0
- package/lib/src/generated/rest/RequestPaymentRequest.js +2 -0
- package/lib/src/generated/rest/RequestVerificationRequest.d.ts +4 -0
- package/lib/src/generated/rest/RequestVerificationRequest.js +2 -0
- package/lib/src/generated/rest/ResourceInput.d.ts +4 -0
- package/lib/src/generated/rest/ResourceInput.js +2 -0
- package/lib/src/generated/rest/SetDefaultModelRequest.d.ts +4 -0
- package/lib/src/generated/rest/SetDefaultModelRequest.js +1 -0
- package/lib/src/generated/rest/SetFreeHostingEnabledRequest.d.ts +3 -0
- package/lib/src/generated/rest/SetFreeHostingEnabledRequest.js +2 -0
- package/lib/src/generated/rest/SetHotWalletAddressRequest.d.ts +3 -0
- package/lib/src/generated/rest/SetHotWalletAddressRequest.js +2 -0
- package/lib/src/generated/rest/SetMultiUserRequest.d.ts +3 -0
- package/lib/src/generated/rest/SetMultiUserRequest.js +2 -0
- package/lib/src/generated/rest/SetOnlineStatusRequest.d.ts +5 -0
- package/lib/src/generated/rest/SetOnlineStatusRequest.js +1 -0
- package/lib/src/generated/rest/SetStatusRequest.d.ts +3 -0
- package/lib/src/generated/rest/SetStatusRequest.js +2 -0
- package/lib/src/generated/rest/SetUserFreeAccessRequest.d.ts +4 -0
- package/lib/src/generated/rest/SetUserFreeAccessRequest.js +2 -0
- package/lib/src/generated/rest/SignMessageRequest.d.ts +3 -0
- package/lib/src/generated/rest/SignMessageRequest.js +2 -0
- package/lib/src/generated/rest/SignalRequest.d.ts +6 -0
- package/lib/src/generated/rest/SignalRequest.js +1 -0
- package/lib/src/generated/rest/SubscribeQueryRequest.d.ts +3 -0
- package/lib/src/generated/rest/SubscribeQueryRequest.js +2 -0
- package/lib/src/generated/rest/SubscribeQueryResponse.d.ts +4 -0
- package/lib/src/generated/rest/SubscribeQueryResponse.js +2 -0
- package/lib/src/generated/rest/TrustedAgentsRequest.d.ts +3 -0
- package/lib/src/generated/rest/TrustedAgentsRequest.js +2 -0
- package/lib/src/generated/rest/UnlockAgentRequest.d.ts +4 -0
- package/lib/src/generated/rest/UnlockAgentRequest.js +2 -0
- package/lib/src/generated/rest/UpdateLinkRequest.d.ts +7 -0
- package/lib/src/generated/rest/UpdateLinkRequest.js +1 -0
- package/lib/src/generated/rest/UpdatePerspectiveRequest.d.ts +3 -0
- package/lib/src/generated/rest/UpdatePerspectiveRequest.js +2 -0
- package/lib/src/generated/rest/UpdateProfileRequest.d.ts +5 -0
- package/lib/src/generated/rest/UpdateProfileRequest.js +1 -0
- package/lib/src/generated/rest/UserStatistics.d.ts +9 -0
- package/lib/src/generated/rest/UserStatistics.js +2 -0
- package/lib/src/generated/rest/VerificationRequestResult.d.ts +6 -0
- package/lib/src/generated/rest/VerificationRequestResult.js +2 -0
- package/lib/src/generated/rest/VerifyEmailRequest.d.ts +6 -0
- package/lib/src/generated/rest/VerifyEmailRequest.js +2 -0
- package/lib/src/generated/rest/VerifySignatureRequest.d.ts +5 -0
- package/lib/src/generated/rest/VerifySignatureRequest.js +2 -0
- package/lib/src/generated/rest/WriteSettingsRequest.d.ts +3 -0
- package/lib/src/generated/rest/WriteSettingsRequest.js +2 -0
- package/lib/src/generated/rest/index.d.ts +73 -0
- package/lib/src/generated/rest/index.js +8 -0
- package/lib/src/generated/rest/routes.d.ts +587 -0
- package/lib/src/generated/rest/routes.js +3 -0
- package/lib/src/index.d.ts +4 -0
- package/lib/src/index.js +4 -0
- package/lib/src/model/Ad4mModel.d.ts +30 -36
- package/lib/src/model/Ad4mModel.js +93 -382
- package/lib/src/model/Ad4mModel.test.js +735 -480
- package/lib/src/model/ModelQueryBuilder.d.ts +5 -10
- package/lib/src/model/ModelQueryBuilder.js +142 -62
- package/lib/src/model/decorators.d.ts +7 -4
- package/lib/src/model/decorators.js +0 -7
- package/lib/src/model/query-sparql.d.ts +0 -10
- package/lib/src/model/query-sparql.js +10 -15
- package/lib/src/model/query-sparql.test.js +10 -92
- package/lib/src/model/query-surreal.d.ts +44 -0
- package/lib/src/model/query-surreal.js +249 -0
- package/lib/src/model/shacl-gen.js +120 -47
- package/lib/src/model/surreal-utils.d.ts +42 -0
- package/lib/src/model/surreal-utils.js +128 -0
- package/lib/src/model/types.d.ts +140 -4
- package/lib/src/neighbourhood/NeighbourhoodProxy.test.js +33 -33
- package/lib/src/perspectives/PerspectiveClient.d.ts +13 -4
- package/lib/src/perspectives/PerspectiveClient.js +22 -6
- package/lib/src/perspectives/PerspectiveProxy.d.ts +27 -7
- package/lib/src/perspectives/PerspectiveProxy.js +60 -12
- package/lib/src/perspectives/PerspectiveProxy.test.d.ts +1 -0
- package/lib/src/perspectives/PerspectiveProxy.test.js +34 -0
- package/lib/src/perspectives/SparqlBindings.d.ts +47 -0
- package/lib/src/perspectives/SparqlBindings.js +65 -0
- package/lib/src/perspectives/WakerSubscriptionManager.js +5 -4
- package/lib/src/restClient.d.ts +52 -0
- package/lib/src/restClient.js +227 -0
- package/lib/src/shacl/NodeExpression.d.ts +44 -0
- package/lib/src/shacl/NodeExpression.js +39 -0
- package/lib/src/shacl/SHACLShape.d.ts +23 -0
- package/lib/src/shacl/SHACLShape.js +115 -1
- package/lib/src/shacl/SHACLShape.test.js +0 -82
- package/lib/src/shacl/builders.d.ts +58 -0
- package/lib/src/shacl/builders.js +76 -0
- package/lib/src/shacl/index.d.ts +36 -0
- package/lib/src/shacl/index.js +33 -0
- package/package.json +11 -8
- package/src/Ad4mClient.ts +7 -2
- package/src/agent/AgentClient.ts +23 -0
- package/src/ai/AIClient.ts +1 -1
- package/src/apiClient.ts +17 -6
- package/src/index.ts +4 -0
- package/src/model/Ad4mModel.test.ts +274 -72
- package/src/model/Ad4mModel.ts +140 -420
- package/src/model/ModelQueryBuilder.ts +136 -71
- package/src/model/decorators.ts +7 -13
- package/src/model/query-sparql.test.ts +35 -19
- package/src/model/query-sparql.ts +10 -16
- package/src/model/relation-filtering.test.ts +46 -39
- package/src/model/shacl-gen.ts +128 -54
- package/src/model/shacl-roundtrip.test.ts +197 -0
- package/src/model/types-typed-query.test.ts +360 -0
- package/src/model/types.ts +196 -4
- package/src/perspectives/PerspectiveClient.ts +24 -8
- package/src/perspectives/PerspectiveProxy.test.ts +85 -1
- package/src/perspectives/PerspectiveProxy.ts +65 -20
- package/src/perspectives/SparqlBindings.ts +79 -0
- package/src/perspectives/WakerSubscriptionManager.ts +5 -4
- package/src/shacl/NodeExpression.ts +54 -0
- package/src/shacl/SHACLShape.test.ts +172 -0
- package/src/shacl/SHACLShape.ts +173 -1
- package/src/shacl/builders.ts +86 -0
- package/src/shacl/index.ts +72 -0
- package/lib/src/model/model-manifest.d.ts +0 -41
- package/lib/src/model/model-manifest.js +0 -11
|
@@ -0,0 +1,249 @@
|
|
|
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
|
+
}
|
|
@@ -7,8 +7,6 @@
|
|
|
7
7
|
* decorators.ts stays focused on decorator registration logic.
|
|
8
8
|
*/
|
|
9
9
|
import { SHACLShape } from "../shacl/SHACLShape";
|
|
10
|
-
import { escapeQueryString } from "../utils";
|
|
11
|
-
import { compileWhereClause } from "./query-utils";
|
|
12
10
|
import { propertyNameToSetterName } from "./util";
|
|
13
11
|
/**
|
|
14
12
|
* Build a SHACL shape for a model class.
|
|
@@ -25,7 +23,6 @@ export function buildSHACL(subjectName, target, properties, allRelationsMeta, co
|
|
|
25
23
|
const obj = target.prototype;
|
|
26
24
|
// ── Determine namespace from first property or relation ─────────────
|
|
27
25
|
let namespace = "ad4m://";
|
|
28
|
-
const relations = Object.fromEntries(Object.entries(allRelationsMeta).filter(([, r]) => r.kind === 'hasMany' || r.kind === 'belongsToMany'));
|
|
29
26
|
// Try properties first
|
|
30
27
|
if (Object.keys(properties).length > 0) {
|
|
31
28
|
const firstProp = properties[Object.keys(properties)[0]];
|
|
@@ -37,8 +34,8 @@ export function buildSHACL(subjectName, target, properties, allRelationsMeta, co
|
|
|
37
34
|
}
|
|
38
35
|
}
|
|
39
36
|
// Fall back to relations if no properties
|
|
40
|
-
else if (Object.keys(
|
|
41
|
-
const firstRel =
|
|
37
|
+
else if (Object.keys(allRelationsMeta).length > 0) {
|
|
38
|
+
const firstRel = allRelationsMeta[Object.keys(allRelationsMeta)[0]];
|
|
42
39
|
if (firstRel.predicate) {
|
|
43
40
|
const match = firstRel.predicate.match(/^([^:]+:\/\/)/);
|
|
44
41
|
if (match) {
|
|
@@ -112,9 +109,19 @@ export function buildSHACL(subjectName, target, properties, allRelationsMeta, co
|
|
|
112
109
|
if (propMeta.writable !== undefined) {
|
|
113
110
|
propShape.writable = propMeta.writable;
|
|
114
111
|
}
|
|
115
|
-
if (propMeta.resolveLanguage) {
|
|
112
|
+
if (propMeta.resolveLanguage != null) {
|
|
116
113
|
propShape.resolveLanguage = propMeta.resolveLanguage;
|
|
117
114
|
}
|
|
115
|
+
// Explicit getter SPARQL — the executor evaluates this when
|
|
116
|
+
// hydrating the property, in addition to (or instead of)
|
|
117
|
+
// reading raw links via `propMeta.through`.
|
|
118
|
+
if (propMeta.getter) {
|
|
119
|
+
propShape.getter = propMeta.getter;
|
|
120
|
+
}
|
|
121
|
+
// Serializable transform expression (SHACL-AF Node Expression)
|
|
122
|
+
if (propMeta.transform) {
|
|
123
|
+
propShape.transform = propMeta.transform;
|
|
124
|
+
}
|
|
118
125
|
// ── Setter actions ──────────────────────────────────────────────
|
|
119
126
|
if (propMeta.prologSetter) {
|
|
120
127
|
console.warn(`[SHACL Generation] Custom Prolog setter for property '${propName}' in class '${subjectName}' is not yet supported. ` +
|
|
@@ -153,63 +160,82 @@ export function buildSHACL(subjectName, target, properties, allRelationsMeta, co
|
|
|
153
160
|
shape.addProperty(propShape);
|
|
154
161
|
}
|
|
155
162
|
// ── Convert relations to SHACL property shapes ─────────────────────
|
|
156
|
-
for (const relName in
|
|
157
|
-
const relMeta =
|
|
158
|
-
|
|
163
|
+
for (const relName in allRelationsMeta) {
|
|
164
|
+
const relMeta = allRelationsMeta[relName];
|
|
165
|
+
// Getter-only relations (no `through`) have no real link predicate
|
|
166
|
+
// but still need a SHACL property entry so the executor can find
|
|
167
|
+
// the getter expression. Synthesize a deterministic IRI so the
|
|
168
|
+
// SHACL graph is well-formed; the predicate is never used to match
|
|
169
|
+
// links because the getter is the sole source of values. Use
|
|
170
|
+
// slash separators so the result is a valid IRI (colons in the
|
|
171
|
+
// authority confuse strict SPARQL IRI parsers).
|
|
172
|
+
if (!relMeta.predicate && !relMeta.getter)
|
|
159
173
|
continue;
|
|
174
|
+
const synthesizedPath = relMeta.predicate
|
|
175
|
+
|| `ad4m://getter/${subjectName}/${relName}`;
|
|
160
176
|
const relShape = {
|
|
161
177
|
name: relName,
|
|
162
|
-
path:
|
|
178
|
+
path: synthesizedPath,
|
|
163
179
|
};
|
|
164
180
|
// Relations typically contain IRIs
|
|
165
181
|
relShape.nodeKind = 'IRI';
|
|
182
|
+
// Encode relation kind so the executor can derive direction and
|
|
183
|
+
// scalar-vs-collection rendering without consulting the JS class.
|
|
184
|
+
relShape.relationKind = relMeta.kind;
|
|
185
|
+
// Scalar relations cap at 1.
|
|
186
|
+
if (relMeta.kind === 'hasOne' || relMeta.kind === 'belongsToOne') {
|
|
187
|
+
relShape.maxCount = 1;
|
|
188
|
+
}
|
|
189
|
+
else if (relMeta.maxCount !== undefined) {
|
|
190
|
+
relShape.maxCount = relMeta.maxCount;
|
|
191
|
+
}
|
|
192
|
+
// Encode opt-out of type filtering (default true; only emit when false).
|
|
193
|
+
if (relMeta.filter === false) {
|
|
194
|
+
relShape.filter = false;
|
|
195
|
+
}
|
|
166
196
|
// AD4M-specific metadata
|
|
167
197
|
if (relMeta.local !== undefined) {
|
|
168
198
|
relShape.local = relMeta.local;
|
|
169
199
|
}
|
|
170
|
-
// Adder
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
200
|
+
// Adder / Remover actions — only meaningful for relations backed
|
|
201
|
+
// by a real link predicate. Getter-only relations are read-only.
|
|
202
|
+
if (relMeta.predicate) {
|
|
203
|
+
relShape.adder = [{
|
|
204
|
+
action: "addLink",
|
|
205
|
+
source: "this",
|
|
206
|
+
predicate: relMeta.predicate,
|
|
207
|
+
target: "value",
|
|
208
|
+
...(relMeta.local && { local: true })
|
|
209
|
+
}];
|
|
210
|
+
relShape.remover = [{
|
|
211
|
+
action: "removeLink",
|
|
212
|
+
source: "this",
|
|
213
|
+
predicate: relMeta.predicate,
|
|
214
|
+
target: "value",
|
|
215
|
+
...(relMeta.local && { local: true })
|
|
216
|
+
}];
|
|
217
|
+
}
|
|
186
218
|
// ── Build Getter (conformance filter) ───────────────────────────
|
|
187
219
|
// Priority chain:
|
|
188
220
|
// 1. Explicit getter string → use verbatim
|
|
189
|
-
// 2.
|
|
190
|
-
//
|
|
221
|
+
// 2. target + filter !== false → auto-derive conformance getter
|
|
222
|
+
// from the shape. Where-clause filtering is applied as a
|
|
223
|
+
// post-getter pass via `whereFilter` / `wherePredicates`, which
|
|
224
|
+
// use `parse_literal_value` and so transparently handle
|
|
225
|
+
// `literal:json:` envelopes that simple FILTER(STR(?x) = ...)
|
|
226
|
+
// comparisons can't.
|
|
191
227
|
if (relMeta.getter) {
|
|
192
228
|
relShape.getter = relMeta.getter;
|
|
193
229
|
}
|
|
194
|
-
else if (relMeta.
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
? TargetClass.getModelMetadata?.() ?? null
|
|
199
|
-
: null;
|
|
200
|
-
const conditions = compileWhereClause(relMeta.where, targetMetadata);
|
|
201
|
-
if (conditions.length > 0) {
|
|
202
|
-
const escapedPredicate = escapeQueryString(relMeta.predicate);
|
|
203
|
-
relShape.getter = `SELECT ?target WHERE { <Base> <${escapedPredicate}> ?target . ${conditions.join(' ')} }`;
|
|
204
|
-
}
|
|
205
|
-
}
|
|
206
|
-
catch (e) {
|
|
207
|
-
// Target metadata may not be available yet
|
|
208
|
-
}
|
|
209
|
-
}
|
|
210
|
-
else if (relMeta.target && relMeta.filter !== false) {
|
|
230
|
+
else if (relMeta.target
|
|
231
|
+
&& relMeta.filter !== false
|
|
232
|
+
&& relMeta.kind !== 'belongsToOne'
|
|
233
|
+
&& relMeta.kind !== 'belongsToMany') {
|
|
211
234
|
// Lazy conformance filter: store deferred reference,
|
|
212
|
-
// resolve on first access via a getter on relShape
|
|
235
|
+
// resolve on first access via a getter on relShape.
|
|
236
|
+
// Skipped for reverse relations (belongsTo*) because the
|
|
237
|
+
// auto-derived getter assumes forward direction; the executor's
|
|
238
|
+
// `resolve_reverse_relations` already populates these correctly.
|
|
213
239
|
const targetThunk = relMeta.target;
|
|
214
240
|
const predicate = relMeta.predicate;
|
|
215
241
|
let resolved = false;
|
|
@@ -246,6 +272,8 @@ export function buildSHACL(subjectName, target, properties, allRelationsMeta, co
|
|
|
246
272
|
});
|
|
247
273
|
}
|
|
248
274
|
// ── sh:class — target shape reference ───────────────────────────
|
|
275
|
+
// Also emit ad4m:targetClassName so the executor can look up the
|
|
276
|
+
// target class shape through its in-memory cache by bare name.
|
|
249
277
|
if (relMeta.target) {
|
|
250
278
|
try {
|
|
251
279
|
const TargetClass = relMeta.target();
|
|
@@ -253,9 +281,54 @@ export function buildSHACL(subjectName, target, properties, allRelationsMeta, co
|
|
|
253
281
|
if (targetSHACL?.shape?.nodeShapeUri) {
|
|
254
282
|
relShape.class = targetSHACL.shape.nodeShapeUri;
|
|
255
283
|
}
|
|
284
|
+
if (targetSHACL?.name) {
|
|
285
|
+
relShape.targetClassName = targetSHACL.name;
|
|
286
|
+
}
|
|
287
|
+
else {
|
|
288
|
+
const targetProto = TargetClass.prototype;
|
|
289
|
+
if (targetProto?.className) {
|
|
290
|
+
relShape.targetClassName = targetProto.className;
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
catch (e) {
|
|
295
|
+
// Target class resolution failed (typically a circular
|
|
296
|
+
// decorator dependency). Since the executor no longer
|
|
297
|
+
// receives target metadata over the wire, dropping the
|
|
298
|
+
// reference here would turn a transient build-time issue
|
|
299
|
+
// into a permanent broken-include at query time. Log
|
|
300
|
+
// loudly so the failure is discoverable.
|
|
301
|
+
console.warn(`[shacl-gen] Failed to resolve target class for relation `
|
|
302
|
+
+ `"${subjectName}.${relName}": ${e instanceof Error ? e.message : String(e)}`);
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
// ── Where-clause metadata for post-getter filtering ─────────────
|
|
306
|
+
// The executor uses these to apply where conditions against the
|
|
307
|
+
// target class without needing the target's ModelMetadata at query time.
|
|
308
|
+
if (relMeta.where) {
|
|
309
|
+
relShape.whereFilter = relMeta.where;
|
|
310
|
+
try {
|
|
311
|
+
const TargetClass = relMeta.target?.();
|
|
312
|
+
const targetMetadata = TargetClass
|
|
313
|
+
? TargetClass.getModelMetadata?.() ?? null
|
|
314
|
+
: null;
|
|
315
|
+
if (targetMetadata?.properties) {
|
|
316
|
+
const predicates = {};
|
|
317
|
+
for (const propName of Object.keys(relMeta.where)) {
|
|
318
|
+
if (['id', 'author', 'timestamp'].includes(propName))
|
|
319
|
+
continue;
|
|
320
|
+
const propMeta = targetMetadata.properties[propName];
|
|
321
|
+
if (propMeta?.predicate) {
|
|
322
|
+
predicates[propName] = propMeta.predicate;
|
|
323
|
+
}
|
|
324
|
+
}
|
|
325
|
+
if (Object.keys(predicates).length > 0) {
|
|
326
|
+
relShape.wherePredicates = predicates;
|
|
327
|
+
}
|
|
328
|
+
}
|
|
256
329
|
}
|
|
257
330
|
catch (e) {
|
|
258
|
-
// Target
|
|
331
|
+
// Target metadata may not be available yet
|
|
259
332
|
}
|
|
260
333
|
}
|
|
261
334
|
shape.addProperty(relShape);
|
|
@@ -0,0 +1,42 @@
|
|
|
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[];
|
|
@@ -0,0 +1,128 @@
|
|
|
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
|
+
}
|