patram 0.1.1 → 0.3.0

package/lib/build-graph-identity.js

@@ -27,14 +27,14 @@ export function collectDocumentEntityKeys(mappings, claims) {
     const source_path = normalizeRepoRelativePath(claim.origin.path);
     const entity_map_key = getDocumentEntityMapKey(
       source_path,
-      mapping_definition.node.kind,
+      mapping_definition.node.class,
     );
     const entity_key = getStringClaimValue(claim);
     const existing_entity_key = document_entity_keys.get(entity_map_key);
 
     if (existing_entity_key && existing_entity_key !== entity_key) {
       throw new Error(
-        `Document "${source_path}" defines multiple ${mapping_definition.node.kind} ids.`,
+        `Document "${source_path}" defines multiple ${mapping_definition.node.class} ids.`,
       );
     }
 
@@ -47,7 +47,7 @@ export function collectDocumentEntityKeys(mappings, claims) {
 /**
  * Resolve the node key for one mapped claim.
  *
- * @param {{ field: string, key?: 'path' | 'value', kind: string }} node_mapping
+ * @param {{ field: string, key?: 'path' | 'value', class: string }} node_mapping
  * @param {PatramClaim} claim
  * @param {Map<string, string>} document_entity_keys
  * @returns {string}
@@ -55,7 +55,7 @@ export function collectDocumentEntityKeys(mappings, claims) {
 export function resolveNodeKey(node_mapping, claim, document_entity_keys) {
   const source_key = normalizeRepoRelativePath(claim.origin.path);
 
-  if (node_mapping.kind === 'document') {
+  if (node_mapping.class === 'document') {
     return source_key;
   }
 
@@ -65,7 +65,7 @@ export function resolveNodeKey(node_mapping, claim, document_entity_keys) {
 
   return (
     document_entity_keys.get(
-      getDocumentEntityMapKey(source_key, node_mapping.kind),
+      getDocumentEntityMapKey(source_key, node_mapping.class),
     ) ?? source_key
   );
 }
@@ -73,23 +73,30 @@ export function resolveNodeKey(node_mapping, claim, document_entity_keys) {
 /**
  * Resolve one edge target key and canonical path.
  *
- * @param {string} target_kind
+ * @param {string} target_class
  * @param {'path' | 'value'} target_type
  * @param {PatramClaim} claim
  * @param {Map<string, string>} document_entity_keys
+ * @param {Set<string>} document_paths
  * @returns {{ key: string, path?: string }}
  */
 export function resolveTargetReference(
-  target_kind,
+  target_class,
   target_type,
   claim,
   document_entity_keys,
+  document_paths,
 ) {
   if (target_type === 'value') {
-    return resolveValueTargetReference(target_kind, claim);
+    return resolveValueTargetReference(target_class, claim);
   }
 
-  return resolvePathTargetReference(target_kind, claim, document_entity_keys);
+  return resolvePathTargetReference(
+    target_class,
+    claim,
+    document_entity_keys,
+    document_paths,
+  );
 }
 
 /**
@@ -99,16 +106,17 @@ export function resolveTargetReference(
  * @param {string | undefined} source_path
  */
 export function setNonDocumentPath(graph_node, source_path) {
-  if (!source_path || graph_node.kind === 'document') {
+  if (!source_path || graph_node.$class === 'document') {
     return;
   }
 
-  if (!graph_node.path) {
+  if (!graph_node.$path) {
+    graph_node.$path = source_path;
     graph_node.path = source_path;
     return;
   }
 
-  if (graph_node.path !== source_path) {
+  if (graph_node.$path !== source_path) {
     throw new Error(
       `Node "${graph_node.id}" maps to multiple canonical paths.`,
     );
@@ -173,21 +181,26 @@ function resolveValueTargetReference(target_kind, claim) {
 }
 
 /**
- * @param {string} target_kind
+ * @param {string} target_class
  * @param {PatramClaim} claim
  * @param {Map<string, string>} document_entity_keys
+ * @param {Set<string>} document_paths
  * @returns {{ key: string, path?: string }}
  */
-function resolvePathTargetReference(target_kind, claim, document_entity_keys) {
-  const source_directory = posix.dirname(
-    normalizeRepoRelativePath(claim.origin.path),
-  );
+function resolvePathTargetReference(
+  target_class,
+  claim,
+  document_entity_keys,
+  document_paths,
+) {
   const raw_target = getPathTargetValue(claim);
-  const target_path = normalizeRepoRelativePath(
-    posix.join(source_directory, raw_target),
+  const target_path = resolveDirectiveAwareTargetPath(
+    claim,
+    raw_target,
+    document_paths,
   );
 
-  if (target_kind === 'document') {
+  if (target_class === 'document') {
     return {
       key: target_path,
       path: target_path,
@@ -195,7 +208,7 @@ function resolvePathTargetReference(target_kind, claim, document_entity_keys) {
   }
 
   const semantic_target_key = document_entity_keys.get(
-    getDocumentEntityMapKey(target_path, target_kind),
+    getDocumentEntityMapKey(target_path, target_class),
   );
 
   return {
@@ -204,6 +217,26 @@ function resolvePathTargetReference(target_kind, claim, document_entity_keys) {
   };
 }
 
+/**
+ * @param {PatramClaim} claim
+ * @param {string} raw_target
+ * @param {Set<string>} document_paths
+ * @returns {string}
+ */
+function resolveDirectiveAwareTargetPath(claim, raw_target, document_paths) {
+  const normalized_raw_target = normalizeRepoRelativePath(raw_target);
+
+  if (claim.type === 'directive' && document_paths.has(normalized_raw_target)) {
+    return normalized_raw_target;
+  }
+
+  const source_directory = posix.dirname(
+    normalizeRepoRelativePath(claim.origin.path),
+  );
+
+  return normalizeRepoRelativePath(posix.join(source_directory, raw_target));
+}
+
 /**
  * @param {PatramClaim} claim
  * @returns {string}
@@ -230,9 +263,9 @@ function getStringClaimValue(claim) {
 
 /**
  * @param {string} document_path
- * @param {string} kind_name
+ * @param {string} class_name
  * @returns {string}
  */
-function getDocumentEntityMapKey(document_path, kind_name) {
-  return `${kind_name}:${document_path}`;
+function getDocumentEntityMapKey(document_path, class_name) {
+  return `${class_name}:${document_path}`;
 }