config: document extended metadata

- travis config - config: document extended metadata - config: ui document extenede metadata - closes #98
CERNDocumentServer · Jun 22, 2020 · f688736 · f688736
1 parent 24d302a
commit f688736
Show file tree

Hide file tree

Showing 5 changed files with 146 additions and 2 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -31,6 +31,7 @@ env:
   global:
     - ES7_DOWNLOAD_URL="https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.3.0-linux-x86_64.tar.gz"
     - ES_HOST=127.0.0.1
+    - PIPENV_PYUP_API_KEY=""
 
 python:
   - "3.6"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/cds_books/config.py b/cds_books/config.py
@@ -20,6 +20,8 @@
 
 from invenio_app_ils.config import RECORDS_REST_ENDPOINTS
 from invenio_app_ils.pidstore.pids import PATRON_PID_TYPE
+from invenio_records_rest.schemas.fields import SanitizedUnicode
+from marshmallow.fields import Bool
 
 from .literature.covers import build_syndetic_cover_urls
 from .patrons.api import Patron
@@ -243,3 +245,69 @@ def _parse_env_bool(var_name, default=None):
                        "invenio_opendefinition"]
 
 ILS_LITERATURE_COVER_URLS_BUILDER = build_syndetic_cover_urls
+
+# Namespaces for fields added to the metadata schema
+ILS_RECORDS_METADATA_NAMESPACES = {
+    "document": {
+        "accelerator_experiments": {
+            "@context": "https://test.org/accelerator_experiments/terms"
+        },
+        "standard_CERN_status": {
+            "@context": "https://test.org/standard_CERN_status/terms"
+        },
+    }
+}
+
+# Fields added to the metadata schema.
+ILS_RECORDS_METADATA_EXTENSIONS = {
+    "document": {
+        "accelerator_experiments:accelerator": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+        "accelerator_experiments:curated_relation": {
+            "elasticsearch": "boolean",
+            "marshmallow": Bool()
+        },
+        "accelerator_experiments:experiment": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+        "accelerator_experiments:institution": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+        "accelerator_experiments:legacy_name": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+        "accelerator_experiments:project": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+        "accelerator_experiments:study": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+        "standard_CERN_status:CERN_applicability": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+        "standard_CERN_status:standard_validity": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode(required=True)
+        },
+        "standard_CERN_status:checkdate": {
+            "elasticsearch": "date",
+            "marshmallow": SanitizedUnicode()
+        },
+        "standard_CERN_status:comment": {
+            "elasticsearch": "text",
+            "marshmallow": SanitizedUnicode()
+        },
+        "standard_CERN_status:expert": {
+            "elasticsearch": "keyword",
+            "marshmallow": SanitizedUnicode()
+        },
+    }
+}
diff --git a/ui/src/config.js b/ui/src/config.js
@@ -0,0 +1,74 @@
+const uiConfig = {
+  extensions: {
+    document: {
+      label: 'Other',
+      fields: {
+        'accelerator_experiments:accelerator': {
+          label: 'Accelerator',
+          type: 'string',
+          default: '',
+        },
+        'accelerator_experiments:curated_relation': {
+          label: 'Curated Relation',
+          type: 'boolean',
+          default: false,
+        },
+        'accelerator_experiments:experiment': {
+          label: 'Experiment',
+          type: 'string',
+          default: '',
+        },
+        'accelerator_experiments:institution': {
+          label: 'Institution',
+          type: 'string',
+          default: '',
+        },
+        'accelerator_experiments:legacy_name': {
+          label: 'Legacy Name',
+          type: 'string',
+          default: '',
+        },
+        'accelerator_experiments:project': {
+          label: 'Project',
+          type: 'string',
+          default: '',
+        },
+        'accelerator_experiments:study': {
+          label: 'Study',
+          type: 'string',
+          default: '',
+        },
+        'standard_CERN_status:CERN_applicability': {
+          label: 'Status CERN Applicability',
+          type: 'string',
+          default: '',
+        },
+        'standard_CERN_status:standard_validity': {
+          label: 'Status Standard Validity',
+          type: 'string',
+          default: '',
+          isRequired: true,
+        },
+        'standard_CERN_status:checkdate': {
+          label: 'Status check date',
+          type: 'date',
+          default: '',
+        },
+        'standard_CERN_status:comment': {
+          label: 'Status comment',
+          type: 'string',
+          default: '',
+        },
+        'standard_CERN_status:expert': {
+          label: 'Status expert',
+          type: 'string',
+          default: '',
+        },
+      },
+    },
+  },
+};
+
+export const config = {
+  uiConfig: uiConfig,
+};
diff --git a/ui/src/index.js b/ui/src/index.js
@@ -4,6 +4,7 @@ import 'react-app-polyfill/ie11'; // For IE 11 support
 import ReactDOM from 'react-dom';
 import { OverridableContext } from 'react-overridable';
 import 'semantic-ui-less/semantic.less';
+import { config } from './config';
 
 const CustomHome = ({ ...props }) => {
   return <>CERN Library Catalogue</>;
@@ -15,7 +16,7 @@ const overriddenCmps = {
 
 ReactDOM.render(
   <OverridableContext.Provider value={overriddenCmps}>
-    <InvenioILSApp />
+    <InvenioILSApp externalConfig={config} />
   </OverridableContext.Provider>,
   document.getElementById('app')
 );