Merge pull request #422 from NYPL/SCC-4345/add-recordType

Scc 4345/add record type
NYPL · Dec 6, 2024 · def2e6a · def2e6a
2 parents 75f1ae9 + 4741593
commit def2e6a
Show file tree

Hide file tree

Showing 11 changed files with 18,987 additions and 60 deletions.
diff --git a/config/production.env b/config/production.env
@@ -10,7 +10,7 @@ NYPL_OAUTH_URL=https://isso.nypl.org/
 ENCRYPTED_NYPL_OAUTH_ID=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAGswaQYJKoZIhvcNAQcGoFwwWgIBADBVBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDMLKVUQA58B6vprNcAIBEIAoaz0lI9EL2M9NyTuEwT8JDmPBt6aXfMiFs027DEuwsCN0wS0qWeFL1g==
 ENCRYPTED_NYPL_OAUTH_SECRET=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAIcwgYQGCSqGSIb3DQEHBqB3MHUCAQAwcAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAyWz91LOP2YP5fg0q0CARCAQ9inO9SV1M8R0Pkkx84r7UdwlU1FxfXvIjk/z6Qs81KBAVELhby2iD5LawQyDrR9tjhuMbotS6QnydwwMR/p8+qJXHI=
 
-NYPL_CORE_VERSION=v2.21
+NYPL_CORE_VERSION=v2.22
 
 LOG_LEVEL=info
 FEATURES=on-site-edd

diff --git a/config/qa.env b/config/qa.env
@@ -10,7 +10,7 @@ NYPL_OAUTH_URL=https://isso.nypl.org/
 ENCRYPTED_NYPL_OAUTH_ID=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAGswaQYJKoZIhvcNAQcGoFwwWgIBADBVBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDMLKVUQA58B6vprNcAIBEIAoaz0lI9EL2M9NyTuEwT8JDmPBt6aXfMiFs027DEuwsCN0wS0qWeFL1g==
 ENCRYPTED_NYPL_OAUTH_SECRET=AQECAHh7ea2tyZ6phZgT4B9BDKwguhlFtRC6hgt+7HbmeFsrsgAAAIcwgYQGCSqGSIb3DQEHBqB3MHUCAQAwcAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAyWz91LOP2YP5fg0q0CARCAQ9inO9SV1M8R0Pkkx84r7UdwlU1FxfXvIjk/z6Qs81KBAVELhby2iD5LawQyDrR9tjhuMbotS6QnydwwMR/p8+qJXHI=
 
-NYPL_CORE_VERSION=v2.21
+NYPL_CORE_VERSION=v2.22
 
 LOG_LEVEL=info
 FEATURES=on-site-edd

diff --git a/lib/elasticsearch/config.js b/lib/elasticsearch/config.js
@@ -74,6 +74,7 @@ const SEARCH_SCOPES = {
 }
 
 const FILTER_CONFIG = {
+  recordType: { operator: 'match', field: 'recordTypeId', repeatable: true },
   owner: { operator: 'match', field: 'items.owner_packed', repeatable: true, path: 'items' },
   subjectLiteral: { operator: 'match', field: 'subjectLiteral_exploded', repeatable: true },
   holdingLocation: { operator: 'match', field: 'items.holdingLocation_packed', repeatable: true, path: 'items' },

diff --git a/lib/jsonld_serializers.js b/lib/jsonld_serializers.js
@@ -1,6 +1,7 @@
 'use strict'
 
 const locations = require('@nypl/nypl-core-objects')('by-sierra-location')
+const recordTypes = require('@nypl/nypl-core-objects')('by-record-types')
 const NyplSourceMapper = require('research-catalog-indexer/lib/utils/nypl-source-mapper')
 
 const util = require('./util.js')
@@ -76,8 +77,9 @@ class JsonLdItemSerializer extends JsonLdSerializer {
       if (Array.isArray(v)) return v.map(formatVal)
       else if (v && typeof v === 'object') {
         const formatted = v
-          // Reassign id to @id, type to @type, value to @value
-          ;['id', 'type', 'value'].forEach((specialProp) => {
+        const properties = ['id', 'type', 'value']
+        // Reassign id to @id, type to @type, value to @value
+        properties.forEach((specialProp) => {
           if (formatted[specialProp]) {
             formatted[`@${specialProp}`] = formatted[specialProp]
             delete formatted[specialProp]
@@ -268,6 +270,10 @@ class ResourceSerializer extends JsonLdItemSerializer {
         stmts.hasItemDates = this.body.numItemDatesParsed[0] / numItems >= parseFloat(process.env.BIB_HAS_DATES_THRESHOLD)
       }
     }
+    if (this.body.recordTypeId) {
+      stmts.recordType = ResourceSerializer.getFormattedRecordType(this.body.recordTypeId)
+      delete stmts.recordTypeId
+    }
 
     // DFE depends on this being set to an empty array when null:
     stmts.electronicResources = stmts.electronicResources || []
@@ -280,6 +286,13 @@ class ResourceSerializer extends JsonLdItemSerializer {
   }
 }
 
+ResourceSerializer.getFormattedRecordType = function (recordTypeId) {
+  return {
+    '@id': recordTypeId,
+    prefLabel: recordTypes[recordTypeId].label
+  }
+}
+
 ResourceSerializer.formatElectronicResourceBlankNode = function (link, rdfsType) {
   // Get the link label (fall back on prefLabel if serialization moved it there)
   const label = link.label || link.prefLabel
@@ -485,6 +498,9 @@ class AggregationSerializer extends JsonLdItemSerializer {
         } else if (field === 'buildingLocation') {
           // Build buildingLocation agg labels from nypl-core:
           v.label = locations[v.value]?.label
+        } else if (field === 'recordType') {
+          // Build recordType agg labels from nypl-core:
+          v.label = recordTypes[v.value]?.label
         } else {
           v.label = v.value
         }

diff --git a/lib/resources.js b/lib/resources.js
@@ -32,6 +32,7 @@ const ITEM_FILTER_AGGREGATIONS = {
 
 // Configures aggregations:
 const AGGREGATIONS_SPEC = {
+  recordType: { terms: { field: 'recordTypeId' } },
   buildingLocation: { terms: { field: 'buildingLocationIds' } },
   owner: { nested: { path: 'items' }, aggs: { _nested: { terms: { field: 'items.owner_packed' } } } },
   subjectLiteral: { terms: { field: 'subjectLiteral.raw' } },

diff --git a/swagger.v1.1.x.json b/swagger.v1.1.x.json
@@ -97,7 +97,7 @@
           {
             "name": "filters[*]",
             "in": "query",
-            "description": "Specify a hash of filters to apply, where key is: 'buildingLocation', 'owner', 'subjectLiteral', 'holdingLocation', 'deliveryLocation', 'language', 'materialType', 'mediaType', 'carrierType', 'publisher', 'contributor', 'creator', 'issuance', 'createdYear', 'dateAfter', or 'dateBefore'",
+            "description": "Specify a hash of filters to apply, where key is: 'recordType', 'buildingLocation', 'owner', 'subjectLiteral', 'holdingLocation', 'deliveryLocation', 'language', 'materialType', 'mediaType', 'carrierType', 'publisher', 'contributor', 'creator', 'issuance', 'createdYear', 'dateAfter', or 'dateBefore'",
             "required": false,
             "type": "string"
           },
@@ -924,4 +924,4 @@
       }
     }
   }
-}
+}