Specific resource fixes for annotation targets

Author: stephenwf

__tests__/presentation-4-parser/normalized-defaults.test.ts

@@ -157,10 +157,11 @@ describe("presentation-4 normalized defaults", () => {
     ]);
     expect((normalizedRange.items as unknown[]).length).toBe(0);
 
-    const normalizedTargetEntity = result.entities.ContentResource[(normalizedAnnotation as any).target.id] as any;
-    expect(normalizedTargetEntity).toBeTruthy();
-    expectArrayFields(normalizedTargetEntity, ["selector", "transform"]);
-    expect(Array.isArray(normalizedTargetEntity.source)).toBe(false);
+    const normalizedTarget = (normalizedAnnotation as any).target;
+    expect(normalizedTarget.type).toBe("SpecificResource");
+    expectArrayFields(normalizedTarget, ["selector", "transform"]);
+    expect(Array.isArray(normalizedTarget.source)).toBe(false);
+    expect(result.entities.ContentResource[normalizedTarget.id]).toBeUndefined();
   });
 
   test("applies canonical defaults for legacy-upgraded resources", () => {
@@ -202,12 +203,13 @@ describe("presentation-4 normalized defaults", () => {
     const result = normalize(legacyManifest as any);
     const annotation = result.entities.Annotation["https://example.org/canvas/1/annotation/1"] as any;
     const range = result.entities.Range["https://example.org/range/1"] as any;
-    const target = result.entities.ContentResource[annotation.target.id] as any;
+    const target = annotation.target;
 
     expect(annotation.body).toBeNull();
     expect(Array.isArray(range.supplementary)).toBe(true);
     expectArrayFields(target, ["selector", "transform"]);
     expect(Array.isArray(target.source)).toBe(false);
+    expect(result.entities.ContentResource[target.id]).toBeUndefined();
   });
 
   test("wraps multiple body/target values in minted List resources", () => {
@@ -247,7 +249,7 @@ describe("presentation-4 normalized defaults", () => {
     const normalized = normalize(manifest as any);
     const annotation = normalized.entities.Annotation["https://example.org/canvas/1/annotation/1"] as any;
     const body = normalized.entities.ContentResource[annotation.body.id] as any;
-    const target = normalized.entities.ContentResource[annotation.target.id] as any;
+    const target = annotation.target;
 
     expect(annotation.body.id.startsWith("vault://iiif-parser/v4/ContentResource/")).toBe(true);
     expect(annotation.target.id.startsWith("vault://iiif-parser/v4/ContentResource/")).toBe(true);
@@ -257,6 +259,8 @@ describe("presentation-4 normalized defaults", () => {
     expect(Array.isArray(target.items)).toBe(true);
     expect(body.items).toHaveLength(2);
     expect(target.items).toHaveLength(2);
+    expect(target.items[0].type).toBe("SpecificResource");
+    expect(normalized.entities.ContentResource[annotation.target.id]).toBeUndefined();
   });
 
   test("defaults annotation collection paging fields", () => {

__tests__/presentation-4-parser/specific-resource-parity.test.ts

@@ -51,7 +51,7 @@ describe("presentation-4 specific resource parity", () => {
     const normalizedAnnotation = result.entities.Annotation["https://example.org/canvas/1/annotation/1"] as any;
     const normalizedStart = result.entities.ContentResource[normalizedManifest.start.id] as any;
     const normalizedRangeItem = result.entities.ContentResource[normalizedRange.items[0].id] as any;
-    const normalizedTarget = result.entities.ContentResource[normalizedAnnotation.target.id] as any;
+    const normalizedTarget = normalizedAnnotation.target;
     const startSelector = normalizedStart.selector[0];
     const rangeSelector = normalizedRangeItem.selector[0];
     const targetSelector = normalizedTarget.selector[0];
@@ -68,11 +68,12 @@ describe("presentation-4 specific resource parity", () => {
     expect(rangeSelector.type).toBe("FragmentSelector");
     expect(rangeSelector.value).toBe("t=0,10");
 
-    expect(normalizedAnnotation.target.type).toBe("ContentResource");
+    expect(normalizedAnnotation.target.type).toBe("SpecificResource");
     expect(normalizedAnnotation.target.id.startsWith("vault://iiif-parser/v4/SpecificResource/")).toBe(true);
     expect(normalizedTarget.source.id).toBe("https://example.org/canvas/1");
     expect(targetSelector.type).toBe("FragmentSelector");
     expect(targetSelector.value).toBe("xywh=10,20,30,40");
+    expect(result.entities.ContentResource[normalizedAnnotation.target.id]).toBeUndefined();
 
     expect(targetSelector).toMatchInlineSnapshot(`
       {
@@ -138,13 +139,14 @@ describe("presentation-4 specific resource parity", () => {
 
     const normalized = normalize(manifest as any);
     const annotation = normalized.entities.Annotation["https://example.org/canvas/1/annotation/1"] as any;
-    const target = normalized.entities.ContentResource[annotation.target.id] as any;
+    const target = annotation.target;
     const targetSelector = target.selector[0];
 
-    expect(annotation.target.type).toBe("ContentResource");
+    expect(annotation.target.type).toBe("SpecificResource");
     expect(target.source.id).toBe("https://example.org/canvas/1");
     expect(targetSelector.type).toBe("FragmentSelector");
     expect(targetSelector.value).toBe("xywh=11,22,33,44");
+    expect(normalized.entities.ContentResource[annotation.target.id]).toBeUndefined();
 
     const serialized = serialize<any>(
       {
@@ -210,10 +212,11 @@ describe("presentation-4 specific resource parity", () => {
 
     const normalized = normalize(manifest as any);
     const annotation = normalized.entities.Annotation["https://example.org/canvas/1/annotation/1"] as any;
-    const target = normalized.entities.ContentResource[annotation.target.id] as any;
+    const target = annotation.target;
 
     expect(target.source.id).toBe("https://example.org/canvas/1");
     expect(target.source.type).toBe("Canvas");
     expect(Array.isArray(target.source)).toBe(false);
+    expect(normalized.entities.ContentResource[target.id]).toBeUndefined();
   });
 });

src/presentation-4/normalize.ts

@@ -349,6 +349,19 @@ function addFlagForExternalResource<T extends { items?: unknown }>(resource: T):
   return resource;
 }
 
+function isAnnotationTargetContext(context: TraversalContext): boolean {
+  return context.path.includes(".target");
+}
+
+function skipOnAnnotationTarget<T extends (resource: any, context: TraversalContext) => any>(traversal: T): T {
+  return (((resource: any, context: TraversalContext) => {
+    if (isAnnotationTargetContext(context)) {
+      return resource;
+    }
+    return traversal(resource, context);
+  }) as unknown) as T;
+}
+
 function ensureRangeSupplementaryArray<T extends { supplementary?: unknown }>(resource: T): T {
   if (resource && typeof resource === "object") {
     const supplementary = (resource as any).supplementary;
@@ -447,13 +460,16 @@ export function normalize(input: unknown): NormalizeResult {
   if (!isLegacySource) {
     contentResourceTraversals.push(ensureDefaultFields(emptyContentResource));
   }
-  contentResourceTraversals.push(map("ContentResource"), record("ContentResource"));
+  contentResourceTraversals.push(
+    skipOnAnnotationTarget(map("ContentResource")),
+    skipOnAnnotationTarget(record("ContentResource"))
+  );
 
   const specificResourceTraversals: Array<(resource: any, context: TraversalContext) => any> = [
     withId("SpecificResource", diagnostics),
     ensureDefaultFields(emptySpecificResource),
-    map("SpecificResource"),
-    record("SpecificResource"),
+    skipOnAnnotationTarget(map("SpecificResource")),
+    skipOnAnnotationTarget(record("SpecificResource")),
   ];
 
   const traversal = new Traverse(