invenio-app-ils 1.0.0a54__py2.py3-none-any.whl → 6.1.0__py2.py3-none-any.whl

invenio_app_ils/items/mappings/v7/items/item-v2.0.0.json

@@ -0,0 +1,326 @@
+{
+  "settings": {
+    "analysis": {
+      "normalizer": {
+        "custom_normalizer": {
+          "type": "custom",
+          "char_filter": [
+            "strip_special_chars"
+          ],
+          "filter": [
+            "lowercase",
+            "asciifolding"
+          ]
+        }
+      },
+      "analyzer": {
+        "email": {
+          "type": "custom",
+          "tokenizer": "uax_url_email"
+        },
+        "custom_analyzer": {
+          "tokenizer": "standard",
+          "type": "custom",
+          "char_filter": [
+            "strip_special_chars"
+          ],
+          "filter": [
+            "lowercase",
+            "asciifolding"
+          ]
+        }
+      },
+      "filter": {
+        "asciifolding": {
+          "type": "asciifolding"
+        }
+      },
+      "char_filter": {
+        "strip_special_chars": {
+          "type": "pattern_replace",
+          "pattern": "[\\p{Punct}\\p{S}]",
+          "replacement": ""
+        }
+      }
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "_created": {
+        "type": "date"
+      },
+      "_updated": {
+        "type": "date"
+      },
+      "acquisition_pid": { "type": "keyword" },
+      "barcode": {
+        "type": "keyword"
+      },
+      "circulation": {
+        "properties": {
+          "document_pid": {
+            "type": "keyword"
+          },
+          "end_date": {
+            "type": "date"
+          },
+          "extension_count": {
+            "type": "short"
+          },
+          "is_overdue": {
+            "type": "boolean"
+          },
+          "item_pid": {
+            "properties": {
+              "type": {
+                "type": "keyword"
+              },
+              "value": {
+                "type": "keyword"
+              }
+            },
+            "type": "object"
+          },
+          "loan_pid": {
+            "type": "keyword"
+          },
+          "patron": {
+            "properties": {
+              "email": {
+                "type": "text",
+                "analyzer": "email"
+              },
+              "id": {
+                "type": "keyword"
+              },
+              "name": {
+                "type": "text",
+                "fields": {
+                  "keyword": {
+                    "type": "keyword"
+                  }
+                }
+              },
+              "location_pid": {
+                "type": "keyword"
+              },
+              "pid": {
+                "type": "keyword"
+              }
+            },
+            "type": "object"
+          },
+          "patron_pid": {
+            "type": "keyword"
+          },
+          "start_date": {
+            "type": "date"
+          },
+          "state": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "circulation_restriction": {
+        "type": "keyword"
+      },
+      "created_by": {
+        "properties": {
+          "type": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "description": {
+        "type": "text"
+      },
+      "document": {
+        "properties": {
+          "authors": {
+            "type": "text"
+          },
+          "cover_metadata": {
+            "properties": {},
+            "type": "object"
+          },
+          "document_type": {
+            "type": "keyword"
+          },
+          "edition": {
+            "type": "text"
+          },
+          "pid": {
+            "type": "keyword"
+          },
+          "publication_year": {
+            "type": "keyword"
+          },
+          "title": {
+            "type": "text",
+            "fields": {
+              "keyword": {
+                "type": "keyword"
+              },
+              "normalized_keyword": {
+                "type": "keyword",
+                "normalizer": "custom_normalizer"
+              }
+            },
+            "analyzer": "custom_analyzer",
+            "search_analyzer": "custom_analyzer"
+          }
+        },
+        "type": "object"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "internal_location": {
+        "properties": {
+          "legacy_id": {
+            "type": "keyword"
+          },
+          "location": {
+            "properties": {
+              "pid": {
+                "type": "keyword"
+              },
+              "legacy_id": {
+                "type": "keyword"
+              },
+              "name": {
+                "type": "keyword"
+              },
+              "opening_weekdays": {
+                "properties": {
+                  "weekday": {
+                    "type": "keyword"
+                  },
+                  "is_open": {
+                    "type": "boolean"
+                  },
+                  "times": {
+                    "properties": {
+                      "start_time": {
+                        "type": "keyword"
+                      },
+                      "end_time": {
+                        "type": "keyword"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "opening_exceptions": {
+                "properties": {
+                  "title": {
+                    "type": "keyword"
+                  },
+                  "is_open": {
+                    "type": "boolean"
+                  },
+                  "start_date": {
+                    "type": "date"
+                  },
+                  "end_date": {
+                    "type": "date"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "location_pid": {
+            "type": "keyword"
+          },
+          "name": {
+            "type": "keyword"
+          },
+          "notes": {
+            "type": "text"
+          },
+          "physical_location": {
+            "type": "keyword"
+          },
+          "pid": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "internal_location_pid": {
+        "type": "keyword"
+      },
+      "internal_notes": {
+        "type": "text"
+      },
+      "isbns": {
+        "properties": {
+          "description": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "legacy_id": {
+        "type": "keyword"
+      },
+      "legacy_library_id": {
+        "type": "keyword"
+      },
+      "medium": {
+        "type": "keyword"
+      },
+      "number_of_pages": {
+        "type": "integer"
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "price": {
+        "properties": {
+          "currency": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "float"
+          }
+        },
+        "type": "object"
+      },
+      "shelf": {
+        "type": "text"
+      },
+      "identifiers": {
+        "properties": {
+          "scheme": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "status": {
+        "type": "keyword"
+      }
+    }
+  }
+}

invenio_app_ils/items/schemas/items/item-v1.0.0.json

@@ -142,6 +142,28 @@
       "type": "string",
       "title": "The shelf location of this Item"
     },
+    "identifiers": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "scheme": {
+            "type": "string",
+            "title": "Type of identification"
+          },
+          "value": {
+            "minLength": 1,
+            "type": "string",
+            "title": "Scheme's value"
+          }
+        },
+        "required": ["scheme", "value"],
+        "title": "Identifiers",
+        "type": "object"
+      },
+      "title": "List of Identifiers",
+      "type": "array",
+      "uniqueItems": true
+    },
     "status": {
       "type": "string",
       "title": "The current status of this Item"

invenio_app_ils/items/schemas/items/item-v2.0.0.json

@@ -0,0 +1,172 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Schema for Item",
+  "type": "object",
+  "required": [
+    "$schema",
+    "created_by",
+    "internal_location_pid",
+    "barcode",
+    "status",
+    "pid",
+    "document_pid",
+    "circulation_restriction",
+    "medium"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "acquisition_pid": {
+      "type": "string",
+      "title": "The persistent identifier of the acquisition"
+    },
+    "barcode": {
+      "type": "string",
+      "title": "The barcode of this Item"
+    },
+    "circulation_restriction": {
+      "type": "string",
+      "title": "The circulation restriction on this Item"
+    },
+    "circulation": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "created_by": {
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "description": {
+      "type": "string",
+      "title": "Any extra description for this Item"
+    },
+    "document_pid": {
+      "type": "string",
+      "title": "The persistent identifier of its Document"
+    },
+    "document": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "internal_location_pid": {
+      "type": "string",
+      "title": "The persistent identifier of its Internal Location"
+    },
+    "internal_location": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "internal_notes": {
+      "type": "string",
+      "title": "Any extra description for this Item reserved for library usage"
+    },
+    "isbns": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "description": {
+            "title": "Free text, used to describe the document to ISBN refers to.",
+            "type": "string"
+          },
+          "value": {
+            "minLength": 1,
+            "type": "string"
+          }
+        },
+        "required": ["value"],
+        "title": "ISBN",
+        "type": "object"
+      },
+      "title": "List of ISBNs",
+      "type": "array",
+      "uniqueItems": true
+    },
+    "legacy_id": {
+      "type": "string",
+      "title": "The previous id of this Item before migration"
+    },
+    "legacy_library_id": {
+      "type": "string",
+      "title": "The previous id of the location of this Item before migration"
+    },
+    "medium": {
+      "type": "string",
+      "title": "The medium of this Item"
+    },
+    "number_of_pages": {
+      "minimum": 1,
+      "title": "Number of pages of the book",
+      "type": "integer"
+    },
+    "pid": {
+      "type": "string",
+      "title": "The persistent identifier of this Item"
+    },
+    "price": {
+      "properties": {
+        "currency": {
+          "title": "Currency of the price (Vocabulary)",
+          "type": "string"
+        },
+        "value": {
+          "minimum": 0,
+          "title": "Price value",
+          "type": "number"
+        }
+      },
+
+      "type": "object"
+    },
+    "shelf": {
+      "type": "string",
+      "title": "The shelf location of this Item"
+    },
+    "identifiers": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "scheme": {
+            "type": "string",
+            "title": "Type of identification"
+          },
+          "value": {
+            "minLength": 1,
+            "type": "string",
+            "title": "Scheme's value"
+          }
+        },
+        "required": ["scheme", "value"],
+        "title": "Identifiers",
+        "type": "object"
+      },
+      "title": "List of Identifiers",
+      "type": "array",
+      "uniqueItems": true
+    },
+    "status": {
+      "type": "string",
+      "title": "The current status of this Item"
+    }
+  }
+}

invenio_app_ils/items/search.py

@@ -7,8 +7,8 @@
 
 """ILS Items search APIs."""
 
-from elasticsearch_dsl import A, Q
 from invenio_search.api import RecordsSearch
+from invenio_search.engine import dsl
 
 from invenio_app_ils.errors import MissingRequiredParameterError
 from invenio_app_ils.proxies import current_app_ils
@@ -32,9 +32,20 @@ class ItemSearch(RecordsSearch):
         if document_pid:
             search = search.filter("term", document_pid=document_pid)
         else:
-            raise MissingRequiredParameterError(
-                description="document_pid is required"
-            )
+            raise MissingRequiredParameterError(description="document_pid is required")
+
+        if filter_states:
+            search = search.filter("terms", status=filter_states)
+        elif exclude_states:
+            search = search.exclude("terms", status=exclude_states)
+
+        return search
+
+    def search_by_barcode(self, barcode, filter_states=None, exclude_states=None):
+        """Retrieve items matching the given barcode."""
+        search = self
+
+        search = search.filter("term", barcode=barcode)
 
         if filter_states:
             search = search.filter("terms", status=filter_states)
@@ -53,9 +64,7 @@ class ItemSearch(RecordsSearch):
         search = self
 
         if internal_location_pid:
-            search = search.filter(
-                "term", internal_location_pid=internal_location_pid
-            )
+            search = search.filter("term", internal_location_pid=internal_location_pid)
         else:
             raise MissingRequiredParameterError(
                 description="internal_location_pid is required"
@@ -79,9 +88,7 @@ class ItemSearch(RecordsSearch):
                 "term", **{"internal_location.location_pid": location_pid}
             )
         else:
-            raise MissingRequiredParameterError(
-                description="location_pid is required"
-            )
+            raise MissingRequiredParameterError(description="location_pid is required")
 
         if filter_states:
             search = search.filter("terms", status=filter_states)
@@ -98,7 +105,7 @@ def get_items_aggregated_by_statuses(document_pid):
     search = search_cls().filter("term", document_pid=document_pid)
 
     # Aggregation
-    aggs = A("terms", field="status")
+    aggs = dsl.A("terms", field="status")
     search.aggs.bucket("statuses", aggs)
 
     return search

invenio_app_ils/items/serializers/item.py

@@ -10,6 +10,7 @@
 from invenio_records_rest.serializers.csv import CSVSerializer
 from invenio_records_rest.serializers.json import JSONSerializer
 
+from invenio_app_ils.literature.serializers.custom_fields import field_cover_metadata
 from invenio_app_ils.permissions import patron_permission
 
 FILTER_KEYS = [
@@ -48,16 +49,16 @@ class ItemCSVSerializer(CSVSerializer):
             pid, record, links_factory=links_factory, **kwargs
         )
         filter_circulation(item)
+        field_cover_metadata(item.get("metadata", {}).get("document", {}))
         return item
 
-    def transform_search_hit(
-        self, pid, record_hit, links_factory=None, **kwargs
-    ):
+    def transform_search_hit(self, pid, record_hit, links_factory=None, **kwargs):
         """Transform search result hit into an intermediate representation."""
         hit = super().transform_search_hit(
             pid, record_hit, links_factory=links_factory, **kwargs
         )
         filter_circulation(hit)
+        field_cover_metadata(hit.get("metadata", {}).get("document", {}))
         return hit
 
 
@@ -70,14 +71,14 @@ class ItemJSONSerializer(JSONSerializer):
             pid, record, links_factory=links_factory, **kwargs
         )
         filter_circulation(item)
+        field_cover_metadata(item.get("metadata", {}).get("document", {}))
         return item
 
-    def transform_search_hit(
-        self, pid, record_hit, links_factory=None, **kwargs
-    ):
+    def transform_search_hit(self, pid, record_hit, links_factory=None, **kwargs):
         """Transform search result hit into an intermediate representation."""
         hit = super().transform_search_hit(
             pid, record_hit, links_factory=links_factory, **kwargs
         )
         filter_circulation(hit)
+        field_cover_metadata(hit.get("metadata", {}).get("document", {}))
         return hit

invenio_app_ils/literature/api.py

@@ -25,6 +25,4 @@ LiteratureIdProvider = type(
     dict(pid_type=LITERATURE_PID_TYPE, default_status=PIDStatus.REGISTERED),
 )
 literature_pid_minter = dummy_pid_minter
-literature_pid_fetcher = partial(
-    pid_fetcher, provider_cls=LiteratureIdProvider
-)
+literature_pid_fetcher = partial(pid_fetcher, provider_cls=LiteratureIdProvider)

invenio_app_ils/literature/search.py

@@ -15,7 +15,7 @@ from invenio_app_ils.search_permissions import (
 )
 
 
-def search_factory_literature(self, search):
+def search_factory_literature(self, search, query_parser=None):
     """Search factory for literature (series and documents)."""
 
     def filter_serial_issues(search, query_string=None):
@@ -31,14 +31,12 @@ def search_factory_literature(self, search):
         if not strtobool(include_all):
             issue_query_string = "NOT document_type:SERIAL_ISSUE"
             if query_string:
-                query_string = "{} AND {}".format(
-                    query_string, issue_query_string
-                )
+                query_string = "({}) AND ({})".format(query_string, issue_query_string)
             else:
                 query_string = issue_query_string
         return search, query_string
 
-    return ils_search_factory(self, search, filter_serial_issues)
+    return ils_search_factory(self, search, query_parser, filter_serial_issues)
 
 
 class LiteratureSearch(RecordsSearch):

invenio_app_ils/literature/serializers/csv.py

@@ -23,9 +23,7 @@ class LiteratureCSVSerializer(CSVSerializer):
         field_cover_metadata(literature["metadata"])
         return literature
 
-    def transform_search_hit(
-        self, pid, record_hit, links_factory=None, **kwargs
-    ):
+    def transform_search_hit(self, pid, record_hit, links_factory=None, **kwargs):
         """Transform search result hit into an intermediate representation."""
         hit = super().transform_search_hit(
             pid, record_hit, links_factory=links_factory, **kwargs

invenio_app_ils/literature/serializers/json.py

@@ -23,9 +23,7 @@ class LiteratureJSONSerializer(JSONSerializer):
         field_cover_metadata(literature["metadata"])
         return literature
 
-    def transform_search_hit(
-        self, pid, record_hit, links_factory=None, **kwargs
-    ):
+    def transform_search_hit(self, pid, record_hit, links_factory=None, **kwargs):
         """Transform search result hit into an intermediate representation."""
         hit = super().transform_search_hit(
             pid, record_hit, links_factory=links_factory, **kwargs