invenio-app-ils 7.0.0__tar.gz → 7.1.1__tar.gz

{invenio_app_ils-7.0.0 → invenio_app_ils-7.1.1}/CHANGES.rst

@@ -8,6 +8,17 @@
 Changes
 =======
 
+Version 7.1.1 (released 2026-02-02)
+
+- fix(checkout): explicitly set transaction date on loan checkout
+
+Version 7.1.0 (released 2026-01-22)
+
+- stats: add document request stats endpoint and extend document request index
+- stats: fix Schema using deserialize to validate
+- stats: add order stats endpoint and extend orders index
+- stats: turn loan histogram endpoint into reusable component
+
 Version 7.0.0 (released 2026-01-06)
 
 - stats: generalize stat tracking loan extensions to track all transitions

{invenio_app_ils-7.0.0 → invenio_app_ils-7.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invenio-app-ils
-Version: 7.0.0
+Version: 7.1.1
 Summary: Invenio Integrated Library System.
 Home-page: https://github.com/inveniosoftware/invenio-app-ils
 Author: CERN
@@ -103,6 +103,17 @@ https://invenioils.docs.cern.ch
 Changes
 =======
 
+Version 7.1.1 (released 2026-02-02)
+
+- fix(checkout): explicitly set transaction date on loan checkout
+
+Version 7.1.0 (released 2026-01-22)
+
+- stats: add document request stats endpoint and extend document request index
+- stats: fix Schema using deserialize to validate
+- stats: add order stats endpoint and extend orders index
+- stats: turn loan histogram endpoint into reusable component
+
 Version 7.0.0 (released 2026-01-06)
 
 - stats: generalize stat tracking loan extensions to track all transitions

{invenio_app_ils-7.0.0 → invenio_app_ils-7.1.1}/docker-services.yml

@@ -14,7 +14,7 @@ services:
         - ENVIRONMENT=DEV
     image: invenio_app_ils-backend
     ports:
-      - "5000"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:5000:5000"
     environment:
       - "INVENIO_ACCOUNTS_SESSION_REDIS_URL=redis://cache:6379/1"
       - "INVENIO_BROKER_URL=amqp://guest:guest@mq:5672/"
@@ -34,20 +34,20 @@ services:
       dockerfile: ./docker/frontend/Dockerfile
     image: invenio_app_ils-frontend
     ports:
-      - "80"
-      - "443"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:80:80"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:443:443"
   lb:
     build: ./docker/lb/
     image: invenio_app_ils-lb
     ports:
-      - "80:80"
-      - "443:443"
-      - "8080:8080"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:80:80"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:443:443"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:8080:8080"
   cache:
     image: redis:6
     read_only: true
     ports:
-      - "6379:6379"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:6379:6379"
   db:
     image: postgres:14
     environment:
@@ -55,12 +55,12 @@ services:
       - "POSTGRES_PASSWORD=psw"
       - "POSTGRES_DB=ils"
     ports:
-      - "5432:5432"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:5432:5432"
   mq:
     image: rabbitmq:3-management
     ports:
-      - "15672:15672"
-      - "5672:5672"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:15672:15672"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:5672:5672"
   search:
     image: opensearchproject/opensearch::3.2.0
     environment:
@@ -75,12 +75,12 @@ services:
         hard: -1
     mem_limit: 1g
     ports:
-      - "9200:9200"
-      - "9300:9300"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:9200:9200"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:9300:9300"
   opensearch-dashboards:
     image: opensearchproject/opensearch-dashboards:3.2.0
     ports:
-      - "5601:5601"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:5601:5601"
     expose:
       - "5601"
     environment:
@@ -91,4 +91,4 @@ services:
     image: mher/flower:0.9.7
     command: --broker=amqp://guest:guest@mq:5672/ --broker_api=http://guest:guest@mq:15672/api/
     ports:
-      - "5555:5555"
+      - "${DOCKER_SERVICES_IP_BIND:-127.0.0.1}:5555:5555"

{invenio_app_ils-7.0.0 → invenio_app_ils-7.1.1}/invenio_app_ils/__init__.py

@@ -7,6 +7,6 @@
 
 """invenio-app-ils."""
 
-__version__ = "7.0.0"
+__version__ = "7.1.1"
 
 __all__ = ("__version__",)

invenio_app_ils-7.1.1/invenio_app_ils/acquisition/indexer.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Order indexer APIs."""
+
+from datetime import datetime
+
+from invenio_search import current_search_client
+
+from invenio_app_ils.acquisition.api import ORDER_PID_TYPE
+from invenio_app_ils.proxies import current_app_ils
+
+
+def index_stats_fields_for_order(order_dict):
+    """Indexer hook to modify the order record dict before indexing."""
+
+    # This is done through the hook and not through an indexer class,
+    # as we need access to the `_created` field
+
+    # Only calculate stats if order is received
+    if not order_dict.get("received_date"):
+        return
+
+    stats = {}
+
+    received_date = datetime.fromisoformat(order_dict["received_date"]).date()
+    creation_date = datetime.fromisoformat(order_dict["_created"]).date()
+
+    # Calculate order_processing_time
+    order_processing_time = (received_date - creation_date).days
+    stats["order_processing_time"] = order_processing_time if order_processing_time >= 0 else None
+
+    # Find related document request if any
+    order_pid = order_dict.get("pid")
+    if order_pid:
+        doc_req_search_cls = current_app_ils.document_request_search_cls
+        search_body = {
+            "query": {
+                "bool": {
+                    "must": [
+                        {"term": {"physical_item_provider.pid": order_pid}},
+                        {"term": {"physical_item_provider.pid_type": ORDER_PID_TYPE}},
+                    ],
+                }
+            },
+            "size": 1,
+        }
+
+        search_result = current_search_client.search(
+            index=doc_req_search_cls.Meta.index, body=search_body
+        )
+
+        hits = search_result["hits"]["hits"]
+        if len(hits) > 0:
+            doc_request = hits[0]["_source"]
+            doc_req_creation_date = datetime.fromisoformat(
+                doc_request["_created"]
+            ).date()
+
+            order_dict["doc_request"] = {}
+
+            # Calculate document_request_waiting_time
+            waiting_time = (received_date - doc_req_creation_date).days
+            stats["document_request_waiting_time"] = (
+                waiting_time if waiting_time >= 0 else None
+            )
+
+    order_dict["stats"] = stats

{invenio_app_ils-7.0.0/invenio_app_ils/acquisition/mappings/v7 → invenio_app_ils-7.1.1/invenio_app_ils/acquisition/mappings/os-v2}/acq_orders/order-v1.0.0.json

@@ -358,6 +358,11 @@
       },
       "provider_pid": {
         "type": "keyword"
+      },
+      "stats": {
+        "type": "object",
+        "dynamic": true,
+        "enabled": true
       }
     }
   }

invenio_app_ils-7.1.1/invenio_app_ils/acquisition/stats/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Invenio App ILS acquisition stats module."""

invenio_app_ils-7.1.1/invenio_app_ils/acquisition/stats/views.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Invenio App ILS acquisition stats views."""
+
+from flask import Blueprint, request
+from invenio_records_rest.query import default_search_factory
+from invenio_rest import ContentNegotiatedMethodView
+from marshmallow.exceptions import ValidationError
+
+from invenio_app_ils.acquisition.api import ORDER_PID_TYPE
+from invenio_app_ils.acquisition.proxies import current_ils_acq
+from invenio_app_ils.errors import InvalidParameterError
+from invenio_app_ils.permissions import need_permissions
+from invenio_app_ils.stats.histogram import (
+    HistogramParamsSchema,
+    create_histogram_view,
+    get_record_statistics,
+)
+
+
+def create_acquisition_stats_blueprint(app):
+    """Add statistics views to the blueprint."""
+    blueprint = Blueprint("invenio_app_ils_acquisition_stats", __name__, url_prefix="")
+
+    create_histogram_view(
+        blueprint, app, ORDER_PID_TYPE, OrderHistogramResource, "/acquisition"
+    )
+
+    return blueprint
+
+
+class OrderHistogramResource(ContentNegotiatedMethodView):
+    """Order stats resource."""
+
+    view_name = "order_histogram"
+
+    def __init__(self, serializers, ctx, *args, **kwargs):
+        """Constructor."""
+        super().__init__(serializers, *args, **kwargs)
+        for key, value in ctx.items():
+            setattr(self, key, value)
+
+    @need_permissions("stats-orders")
+    def get(self, **kwargs):
+        """Get order statistics."""
+
+        order_date_fields = [
+            "order_date",
+            "expected_delivery_date",
+            "received_date",
+            "_created",
+            "_updated",
+        ]
+
+        schema = HistogramParamsSchema(order_date_fields)
+        try:
+            parsed_args = schema.load(request.args.to_dict())
+        except ValidationError as e:
+            raise InvalidParameterError(description=e.messages) from e
+
+        # Construct search to allow for filtering with the q parameter
+        search_cls = current_ils_acq.order_search_cls
+        search = search_cls()
+        search, _ = default_search_factory(self, search)
+
+        aggregation_buckets = get_record_statistics(
+            order_date_fields,
+            search,
+            parsed_args["group_by"],
+            parsed_args["metrics"],
+        )
+
+        response = {
+            "buckets": aggregation_buckets,
+        }
+
+        return self.make_response(response, 200)

{invenio_app_ils-7.0.0 → invenio_app_ils-7.1.1}/invenio_app_ils/circulation/indexer.py

@@ -164,6 +164,8 @@ def index_stats_fields_for_loan(loan_dict):
         )
 
 
+    # Make use of the `extra_data` property as loans are part of `invenio-circulation`,
+    # which do not expose the `stats` property directly
     if not "extra_data" in loan_dict:
         loan_dict["extra_data"] = {}
     loan_dict["extra_data"]["stats"] = stats

{invenio_app_ils-7.0.0 → invenio_app_ils-7.1.1}/invenio_app_ils/circulation/loaders/schemas/json/loan_checkout.py

@@ -11,7 +11,7 @@ import arrow
 from flask import current_app
 from invenio_circulation.records.loaders.schemas.json import (
     DateString,
-    LoanItemPIDSchemaV1,
+    LoanItemPIDSchemaV1, DateTimeString, set_missing_transaction_date,
 )
 from marshmallow import ValidationError, fields, post_load, validates
 
@@ -28,6 +28,8 @@ class LoanCheckoutSchemaV1(LoanBaseSchemaV1):
     end_date = DateString()
     force = fields.Bool(load_default=False)
 
+    transaction_date = DateTimeString(missing=set_missing_transaction_date)
+
     @validates("force")
     def validate_force(self, value, **kwargs):
         """Validate that only librarian can perform a force checkout."""

invenio_app_ils-7.1.1/invenio_app_ils/circulation/stats/api.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019-2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""APIs for ILS circulation statistics."""
+
+from invenio_app_ils.circulation.search import get_most_loaned_documents
+from invenio_app_ils.proxies import current_app_ils
+
+
+def fetch_most_loaned_documents(from_date, to_date, bucket_size):
+    """Fetch the documents with the most loans within the date interval."""
+    # Create loans aggregation
+    most_loaned = get_most_loaned_documents(from_date, to_date, bucket_size)
+
+    # Prepare the loan and extension count
+    document_pids = []
+    document_metadata = {}
+    loan_result = most_loaned.execute()
+    for bucket in loan_result.aggregations.most_loaned_documents.buckets:
+        document_pid = bucket["key"]
+        loan_count = bucket["doc_count"]
+        loan_extensions = int(bucket["extensions"]["value"])
+        document_pids.append(document_pid)
+        document_metadata[document_pid] = dict(
+            loans=loan_count, extensions=loan_extensions
+        )
+
+    # Enhance the document serializer
+    doc_search = current_app_ils.document_search_cls()
+    doc_search = doc_search.with_preference_param().params(version=True)
+    doc_search = doc_search.search_by_pid(*document_pids)
+    doc_search = doc_search[0:bucket_size]
+    result = doc_search.execute()
+
+    for hit in result.hits:
+        pid = hit["pid"]
+        hit["loan_count"] = document_metadata[pid]["loans"]
+        hit["loan_extensions"] = document_metadata[pid]["extensions"]
+
+    res = result.to_dict()
+    res["hits"]["hits"] = sorted(
+        res["hits"]["hits"],
+        key=lambda hit: hit["_source"]["loan_count"],
+        reverse=True,
+    )
+
+    return res

{invenio_app_ils-7.0.0 → invenio_app_ils-7.1.1}/invenio_app_ils/circulation/stats/views.py

@@ -18,17 +18,17 @@ from invenio_records_rest.utils import obj_or_import_string
 from invenio_rest import ContentNegotiatedMethodView
 from marshmallow.exceptions import ValidationError
 
-from invenio_app_ils.circulation.stats.api import (
-    fetch_most_loaned_documents,
-    get_loan_statistics,
-)
-from invenio_app_ils.circulation.stats.schemas import HistogramParamsSchema
-from invenio_app_ils.circulation.stats.serializers import loan_stats_response
+from invenio_app_ils.circulation.stats.api import fetch_most_loaned_documents
 from invenio_app_ils.circulation.views import IlsCirculationResource
 from invenio_app_ils.config import RECORDS_REST_MAX_RESULT_WINDOW
 from invenio_app_ils.documents.api import DOCUMENT_PID_FETCHER, DOCUMENT_PID_TYPE
 from invenio_app_ils.errors import InvalidParameterError
 from invenio_app_ils.permissions import need_permissions
+from invenio_app_ils.stats.histogram import (
+    HistogramParamsSchema,
+    create_histogram_view,
+    get_record_statistics,
+)
 
 
 def create_most_loaned_documents_view(blueprint, app):
@@ -56,33 +56,18 @@ def create_most_loaned_documents_view(blueprint, app):
     )
 
 
-def create_loan_histogram_view(blueprint, app):
-    """Add url rule for loan histogram view."""
-
-    endpoints = app.config.get("RECORDS_REST_ENDPOINTS")
-    document_endpoint = endpoints.get(CIRCULATION_LOAN_PID_TYPE)
-    default_media_type = document_endpoint.get("default_media_type")
-    loan_stats_serializers = {"application/json": loan_stats_response}
-
-    loan_stats_view_func = LoanHistogramResource.as_view(
-        LoanHistogramResource.view_name,
-        serializers=loan_stats_serializers,
-        default_media_type=default_media_type,
-        ctx={},
-    )
-    blueprint.add_url_rule(
-        "/circulation/loans/stats",
-        view_func=loan_stats_view_func,
-        methods=["GET"],
-    )
-
-
 def create_circulation_stats_blueprint(app):
     """Add statistics views to the blueprint."""
     blueprint = Blueprint("invenio_app_ils_circulation_stats", __name__, url_prefix="")
 
     create_most_loaned_documents_view(blueprint, app)
-    create_loan_histogram_view(blueprint, app)
+    create_histogram_view(
+        blueprint,
+        app,
+        CIRCULATION_LOAN_PID_TYPE,
+        LoanHistogramResource,
+        "/circulation/loans",
+    )
 
     return blueprint
 
@@ -190,7 +175,7 @@ class LoanHistogramResource(IlsCirculationResource):
         search = search_cls()
         search, _ = default_search_factory(self, search)
 
-        aggregation_buckets = get_loan_statistics(
+        aggregation_buckets = get_record_statistics(
             loan_date_fields,
             search,
             parsed_args["group_by"],

invenio_app_ils-7.1.1/invenio_app_ils/document_requests/indexer.py

@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019-2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""DocumentRequest indexer APIs."""
+
+from datetime import datetime
+
+from celery import shared_task
+from flask import current_app
+from invenio_indexer.api import RecordIndexer
+from invenio_search import current_search_client
+
+from invenio_app_ils.acquisition.api import ORDER_PID_TYPE
+from invenio_app_ils.acquisition.proxies import current_ils_acq
+from invenio_app_ils.documents.api import DOCUMENT_PID_TYPE
+from invenio_app_ils.ill.api import BORROWING_REQUEST_PID_TYPE
+from invenio_app_ils.ill.proxies import current_ils_ill
+from invenio_app_ils.indexer import ReferencedRecordsIndexer
+from invenio_app_ils.proxies import current_app_ils
+
+from .api import DOCUMENT_REQUEST_PID_TYPE
+
+
+def index_stats_fields_for_document_request(doc_request_dict):
+    """Indexer hook to modify the document request record dict before indexing."""
+
+    # This is done through the hook and not through an indexer class,
+    # as we need access to the `_created` field.
+
+    physical_item_provider = doc_request_dict.get("physical_item_provider")
+    if not physical_item_provider:
+        return
+
+    provider_pid = physical_item_provider["pid"]
+    provider_pid_type = physical_item_provider["pid_type"]
+
+    doc_request_created = doc_request_dict["_created"]
+    doc_request_creation_date = datetime.fromisoformat(doc_request_created).date()
+
+    provider_creation_date = None
+
+    if provider_pid_type == ORDER_PID_TYPE:
+        order_search_cls = current_ils_acq.order_search_cls
+        search_body = {
+            "query": {"term": {"pid": provider_pid}},
+            "size": 1,
+        }
+        search_result = current_search_client.search(
+            index=order_search_cls.Meta.index, body=search_body
+        )
+        hits = search_result["hits"]["hits"]
+        if len(hits) > 0:
+            order = hits[0]["_source"]
+            provider_creation_date = datetime.fromisoformat(order["_created"]).date()
+
+    elif provider_pid_type == BORROWING_REQUEST_PID_TYPE:
+        brw_req_search_cls = current_ils_ill.borrowing_request_search_cls
+        search_body = {
+            "query": {"term": {"pid": provider_pid}},
+            "size": 1,
+        }
+        search_result = current_search_client.search(
+            index=brw_req_search_cls.Meta.index, body=search_body
+        )
+        hits = search_result["hits"]["hits"]
+        if len(hits) > 0:
+            brw_req = hits[0]["_source"]
+            provider_creation_date = datetime.fromisoformat(brw_req["_created"]).date()
+    stats = {}
+    if provider_creation_date:
+        provider_creation_delay = (
+            provider_creation_date - doc_request_creation_date
+        ).days
+        stats["provider_creation_delay"] = (
+            provider_creation_delay if provider_creation_delay >= 0 else None
+        )
+
+    if stats:
+        doc_request_dict["stats"] = stats
+
+
+@shared_task(ignore_result=True)
+def index_referenced_records(docreq):
+    """Index referenced records."""
+    indexer = ReferencedRecordsIndexer()
+    indexed = dict(pid_type=DOCUMENT_REQUEST_PID_TYPE, record=docreq)
+
+    referenced = []
+
+    # fetch and index the document
+    document_pid = docreq.get("document_pid")
+    if document_pid:
+        document_cls = current_app_ils.document_record_cls
+        document = document_cls.get_record_by_pid(document_pid)
+        referenced.append(dict(pid_type=DOCUMENT_PID_TYPE, record=document))
+
+    # fetch and index the related order (physical_item_provider)
+    physical_item_provider = docreq.get("physical_item_provider")
+    if physical_item_provider:
+        provider_pid = physical_item_provider.get("pid")
+        provider_pid_type = physical_item_provider.get("pid_type")
+        if provider_pid and provider_pid_type == ORDER_PID_TYPE:
+            order_cls = current_ils_acq.order_record_cls
+            order = order_cls.get_record_by_pid(provider_pid)
+            referenced.append(dict(pid_type=ORDER_PID_TYPE, record=order))
+
+    indexer.index(indexed, referenced)
+
+
+class DocumentRequestIndexer(RecordIndexer):
+    """Indexer class for DocumentRequest record."""
+
+    def index(self, docreq, arguments=None, **kwargs):
+        """Index a DocumentRequest."""
+        super().index(docreq)
+        eta = datetime.utcnow() + current_app.config["ILS_INDEXER_TASK_DELAY"]
+        index_referenced_records.apply_async((docreq,), eta=eta)

{invenio_app_ils-7.0.0/invenio_app_ils/document_requests/mappings/v7 → invenio_app_ils-7.1.1/invenio_app_ils/document_requests/mappings/os-v2}/document_requests/document_request-v1.0.0.json

@@ -190,6 +190,11 @@
       },
       "publisher": {
         "type": "text"
+      },
+      "stats": {
+        "type": "object",
+        "dynamic": true,
+        "enabled": true
       }
     }
   }

invenio_app_ils-7.1.1/invenio_app_ils/document_requests/stats/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Invenio App ILS document requests stats module."""