feat: Add term definition (#1167)

* Start by copying the value of scopeNote. * Document in the GraphQL API that the value of scopeNote may change later.
netwerk-digitaal-erfgoed · Nov 23, 2023 · 517a5c7 · 517a5c7
1 parent 1fdf10b
commit 517a5c7
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/jest.config.js b/jest.config.js
@@ -11,9 +11,9 @@ export default {
   ],
   coverageThreshold: {
     global: {
-      lines: 90.94,
-      statements: 90.94,
-      branches: 95.86,
+      lines: 90.95,
+      statements: 90.95,
+      branches: 95.87,
       functions: 91.52,
     },
   },

diff --git a/packages/network-of-terms-graphql/src/resolvers.ts b/packages/network-of-terms-graphql/src/resolvers.ts
@@ -116,6 +116,7 @@ function term(term: Term) {
     hiddenLabel: term.hiddenLabels.map(
       (hiddenLabel: RDF.Term) => hiddenLabel.value
     ),
+    description: term.scopeNotes.map((scopeNote: RDF.Term) => scopeNote.value),
     scopeNote: term.scopeNotes.map((scopeNote: RDF.Term) => scopeNote.value),
     seeAlso: term.seeAlso.map((seeAlso: RDF.NamedNode) => seeAlso.value),
     broader: term.broaderTerms.map(related => ({

diff --git a/packages/network-of-terms-graphql/src/schema.ts b/packages/network-of-terms-graphql/src/schema.ts
@@ -44,6 +44,8 @@ export const schema = `
     prefLabel: [String]!
     altLabel: [String]!
     hiddenLabel: [String]!
+    description: [String]!
+    "For the full description of the term, use \`description\` instead of scopeNote. The contents of \`scopeNote\` may change later."
     scopeNote: [String]!
     seeAlso: [String]!
     broader: [RelatedTerm]

diff --git a/packages/network-of-terms-graphql/test/server.test.ts b/packages/network-of-terms-graphql/test/server.test.ts
@@ -102,6 +102,9 @@ describe('Server', () => {
         term.uri === 'https://example.com/resources/artwork'
     );
     expect(artwork.seeAlso).toEqual(['https://example.com/html/artwork']);
+    expect(artwork.description).toEqual([
+      'One of the most famous Dutch paintings',
+    ]);
 
     const prefLabels = body.data.terms[0].result.terms.map(
       ({prefLabel}: {prefLabel: string[]}) => prefLabel[0] ?? ''
@@ -229,6 +232,7 @@ function termsQuery(sources: string[], query = 'nachtwacht') {
               prefLabel
               altLabel
               hiddenLabel
+              description
               scopeNote
               seeAlso
               broader {