Refine metadata representation, expand test suite, fix raw DAG node a…

…nnotations
desci-labs · Oct 30, 2023 · 8f9a2cb · 8f9a2cb
1 parent 3637787
commit 8f9a2cb
Show file tree

Hide file tree

Showing 11 changed files with 1,363 additions and 827 deletions.
diff --git a/composites/01-researchObject.graphql b/composites/01-researchObject.graphql
@@ -6,5 +6,5 @@ type ResearchObject
   version: CommitID! @documentVersion
   title: String! @string(maxLength: 250)
   manifest: CID!
-  metadata: String @string(maxLength: 1024)
+  metadata: CID
 }
diff --git a/composites/06-attestation.graphql b/composites/06-attestation.graphql
@@ -11,8 +11,8 @@ type Attestation
 {
   source: DID! @documentAccount
   version: CommitID! @documentVersion
-  # 1. Any type of document, shown with relation on reciever end but cannot
-  #    use @documentRelation without specifying the target type
+  # 1. Any type of document, shown with relation on reciever end but cannot use
+  #    @documentRelation without specifying the target type before interfaces land
   # 2. This cannot be a DID, so attestations to people target the Profile
   targetID: StreamID!
   targetVersion: CommitID!

diff --git a/composites/07-researchComponent.graphql b/composites/07-researchComponent.graphql
@@ -7,17 +7,22 @@ type ResearchComponent
     accountRelation: LIST,
     description: "A contextualized DAG pointer for a research object"
   )
-  @createIndex(fields: [{ path: "dagNode" }])
   @createIndex(fields: [{ path: "mimeType" }])
   @createIndex(fields: [{ path: "researchObjectVersion" }])
+  # Don't join index with path as it prevents efficient reverse CID lookups
+  @createIndex(fields: [{ path: "dagNode" }])
 {
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
   name: String! @string(maxLength: 512)
   mimeType: String! @string(maxLength: 128)
+  metadata: CID
+
+  # CID not necessarily unique unless listed with path
   dagNode: CID!
+  pathToNode: String! @string(maxLength: 512)
 
-  # The associated research object in which this component lives
+  # The associated research object
   researchObjectID: StreamID! @documentReference(model: "ResearchObject")
   researchObject: ResearchObject! @relationDocument(property: "researchObjectID")
   researchObjectVersion: CommitID!

diff --git a/composites/11-annotation.graphql b/composites/11-annotation.graphql
@@ -2,26 +2,46 @@ type Claim @loadModel(id: "$CLAIM_ID") {
   id: ID!
 }
 
+type ResearchObject @loadModel(id: "$RESEARCH_OBJECT_ID") {
+  id: ID!
+}
+
 type Annotation
   @createModel(accountRelation: LIST, description: "Textual commentary")
   @createIndex(fields: [{ path: "targetVersion" }])
   @createIndex(fields: [{ path: "claimVersion" }])
+  @createIndex(fields: [{ path: "dagNode" }, { path: "pathToNode" }])
 {
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
+
+  # Textual commentary on target
   comment: String! @string(maxLength: 1024)
 
-  targetID: StreamID! # Research object, researchComponent, or annotation as reply
-  targetVersion: CommitID!
+  # Research object context
+  researchObjectID: StreamID! @documentReference(model: "ResearchObject")
+  researchObject: ResearchObject! @relationDocument(property: "researchObjectID")
+  researchObjectVersion: CommitID!
 
-  # If target is a component, identify the location of the annotation
-  # payload. For example a JSON path, line number, or coordinates in a pdf.
-  path: String @string(maxLength: 512)
+  # Research component or annotation as reply
+  # TODO: interface
+  targetID: StreamID
+  targetVersion: CommitID
+
+  # Alternatively, directly annotate a raw DAG node without a component.
+  # Path is necessary because CID is not necessarily unique.
+  dagNode: CID
+  pathToNode: String @string(maxLength: 512)
+
+  # Localization of the annotation payload, depending on file type. 
+  # For example a JSON path, line number, or coordinates.
+  locationOnFile: String @string(maxLength: 512)
 
   # Optionally tag a claim to contextualise the annotation
   claimID: StreamID @documentReference(model: "Claim")
   claim: Claim @relationDocument(property: "claimID")
   claimVersion: CommitID
 
-  metadataPayload: String @string(maxLength: 1024)
+  # Optionally suggest changes to metadata with a diff
+  metadataPayload: CID
 }
diff --git a/composites/additional-relations.graphql b/composites/additional-relations.graphql
@@ -50,8 +50,8 @@ type ResearchObject @loadModel(id: "$RESEARCH_OBJECT_ID") {
 
   researchFields: [ResearchFieldRelation] @relationFrom(model: "ResearchFieldRelation", property: "researchObjectID")
 
-  annotations: [Annotation] @relationFrom(model: "Annotation", property: "targetID")
-  annotationCount: Int! @relationCountFrom(model: "Annotation", property: "targetID")
+  annotations: [Annotation] @relationFrom(model: "Annotation", property: "researchObjectID")
+  annotationCount: Int! @relationCountFrom(model: "Annotation", property: "researchObjectID")
 }
 
 # Support for incoming relations on CeramicAccounts is coming, but we'd need a separate