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

invenio_app_ils/series/schemas/series/series-v2.0.0.json

@@ -0,0 +1,354 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Series",
+  "type": "object",
+  "required": ["$schema", "pid", "title", "mode_of_issuance"],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "abstract": {
+      "type": "string",
+      "description": ""
+    },
+    "access_urls": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "access_restriction": {
+            "items": {
+              "title": "Access restriction type",
+              "type": "string"
+            },
+            "title": "List of access restriction types (Vocabulary)",
+            "type": "array",
+            "uniqueItems": true
+          },
+          "open_access": {
+            "type": "boolean",
+            "title": "Indicate if the access to this URL is open or not",
+            "default": true
+          },
+          "description": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "login_required": {
+            "type": "boolean",
+            "title": "Indicate if the access to this link requires login",
+            "default": false
+          },
+          "value": {
+            "format": "uri",
+            "minLength": 1,
+            "type": "string"
+          }
+        },
+        "required": ["value"],
+        "title": "URL of external resource",
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "alternative_titles": {
+      "description": "Alternative titles of the document",
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "language": {
+            "maxLength": 3,
+            "minLength": 3,
+            "title": "ISO 639-3 language code (Vocabulary)",
+            "type": "string"
+          },
+          "value": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": {
+            "type": "string",
+            "title": "Type of alternative title (Vocabulary)"
+          }
+        },
+        "required": ["value"],
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "authors": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array",
+      "description": ""
+    },
+    "created_by": {
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "edition": {
+      "type": "string",
+      "description": "Edition"
+    },
+    "extensions": {
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "array",
+            "items": {
+              "type": ["boolean", "number", "string"]
+            }
+          },
+          { "type": "boolean" },
+          { "type": "number" },
+          { "type": "string" }
+        ]
+      }
+    },
+    "identifiers": {
+      "items": {
+        "properties": {
+          "material": {
+            "type": "string",
+            "title": "Material to which the identifiers refers to."
+          },
+          "scheme": {
+            "title": "Scheme of the identifier (Vocabulary)",
+            "type": "string"
+          },
+          "value": {
+            "title": "Value of the identifier",
+            "type": "string"
+          }
+        },
+        "required": ["value", "scheme"]
+      },
+      "title": "List of Identifiers of the record",
+      "type": "array"
+    },
+    "internal_notes": {
+      "items": {
+        "additionalProperties": false,
+        "description": "Visible only for Librarians",
+        "properties": {
+          "field": {
+            "title": "Field to which the note refers to",
+            "type": "string"
+          },
+          "user": {
+            "type": "string",
+            "title": "User who has composed the note."
+          },
+          "value": {
+            "title": "Note",
+            "type": "string"
+          }
+        },
+        "required": ["value"]
+      },
+      "minItems": 1,
+      "title": "List of internal notes",
+      "type": "array",
+      "uniqueItems": true
+    },
+    "keywords": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "source": {
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        }
+      },
+      "title": "Keywords of the series",
+      "type": "array"
+    },
+    "languages": {
+      "items": {
+        "maxLength": 3,
+        "minLength": 3,
+        "title": "ISO 639-3 language code",
+        "type": "string"
+      },
+      "type": "array",
+      "title": "List of languages of the series (Vocabulary)",
+      "description": ""
+    },
+    "mode_of_issuance": {
+      "title": "Mode of issuance",
+      "type": "string",
+      "enum": ["MULTIPART_MONOGRAPH", "SERIAL"],
+      "description": ""
+    },
+    "note": {
+      "title": "Note for the series",
+      "type": "string"
+    },
+    "pid": {
+      "title": "Series PID",
+      "type": "string"
+    },
+    "publication_year": {
+      "minLength": 1,
+      "title": "Year of the publication of the series",
+      "type": "string"
+    },
+    "publisher": {
+      "type": "string",
+      "title": "Publisher name"
+    },
+    "relations": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "relations_metadata": {
+      "type": "object",
+      "title": "Metadata to describe relations",
+      "properties": {
+        "multipart_monograph": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "pid": {
+                "type": "string"
+              },
+              "pid_type": {
+                "type": "string"
+              },
+              "volume": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "serial": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "pid": {
+                "type": "string"
+              },
+              "pid_type": {
+                "type": "string"
+              },
+              "volume": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "other": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "pid": {
+                "type": "string"
+              },
+              "pid_type": {
+                "type": "string"
+              },
+              "note": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    },
+    "series_type": {
+      "title": "Series type",
+      "type": "string"
+    },
+    "tags": {
+      "items": {
+        "title": "Tag name",
+        "type": "string"
+      },
+      "title": "List of tags of the series (Vocabulary)",
+      "type": "array",
+      "uniqueItems": true
+    },
+    "title": {
+      "type": "string"
+    },
+    "updated_by": {
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "title": "Last update entity information",
+      "type": "object"
+    },
+    "urls": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "description": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "value": {
+            "format": "uri",
+            "minLength": 1,
+            "type": "string"
+          },
+          "meta": {
+            "type": "string",
+            "description": "System information about the url."
+          }
+        },
+        "required": ["value"],
+        "title": "URL of external resource",
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "physical_volumes": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "description": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "location": {
+            "minLength": 1,
+            "type": "string"
+          }
+        },
+        "title": "Physical volumes description and location",
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    }
+  }
+}

invenio_app_ils/stats/aggregations/aggr_file_download/os-v1/aggr-file-download-v1.json

@@ -0,0 +1,60 @@
+{
+  "index_patterns": ["__SEARCH_INDEX_PREFIX__stats-file-download-*"],
+  "settings": {
+    "index": {
+      "refresh_interval": "1m"
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "dynamic": false,
+    "dynamic_templates": [
+      {
+        "date_fields": {
+          "match_mapping_type": "date",
+          "mapping": {
+            "type": "date",
+            "format": "date_optional_time"
+          }
+        }
+      }
+    ],
+    "numeric_detection": false,
+    "properties": {
+      "bucket_id": {
+        "type": "keyword"
+      },
+      "collection": {
+        "type": "keyword"
+      },
+      "count": {
+        "type": "integer"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "eitem_pid": {
+        "type": "keyword"
+      },
+      "file_id": {
+        "type": "keyword"
+      },
+      "file_key": {
+        "type": "keyword"
+      },
+      "timestamp": {
+        "type": "date",
+        "format": "date_optional_time"
+      },
+      "unique_count": {
+        "type": "integer"
+      },
+      "unique_id": {
+        "type": "keyword"
+      }
+    }
+  },
+  "aliases": {
+    "__SEARCH_INDEX_PREFIX__stats-file-download": {}
+  }
+}

invenio_app_ils/stats/aggregations/aggr_file_download/os-v2/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2019 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""File download aggregations Elasticsearch index templates."""

invenio_app_ils/stats/aggregations/aggr_file_download/os-v2/aggr-file-download-v1.json

@@ -0,0 +1,60 @@
+{
+  "index_patterns": ["__SEARCH_INDEX_PREFIX__stats-file-download-*"],
+  "settings": {
+    "index": {
+      "refresh_interval": "1m"
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "dynamic": false,
+    "dynamic_templates": [
+      {
+        "date_fields": {
+          "match_mapping_type": "date",
+          "mapping": {
+            "type": "date",
+            "format": "date_optional_time"
+          }
+        }
+      }
+    ],
+    "numeric_detection": false,
+    "properties": {
+      "bucket_id": {
+        "type": "keyword"
+      },
+      "collection": {
+        "type": "keyword"
+      },
+      "count": {
+        "type": "integer"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "eitem_pid": {
+        "type": "keyword"
+      },
+      "file_id": {
+        "type": "keyword"
+      },
+      "file_key": {
+        "type": "keyword"
+      },
+      "timestamp": {
+        "type": "date",
+        "format": "date_optional_time"
+      },
+      "unique_count": {
+        "type": "integer"
+      },
+      "unique_id": {
+        "type": "keyword"
+      }
+    }
+  },
+  "aliases": {
+    "__SEARCH_INDEX_PREFIX__stats-file-download": {}
+  }
+}

invenio_app_ils/stats/event_builders.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details
+
+"""ILS stats event builders."""
+
+import datetime
+
+from flask import g
+from flask_login import current_user
+
+from invenio_app_ils.permissions import backoffice_permission
+from invenio_app_ils.records.api import IlsRecord
+
+
+def ils_record_changed_event_builder(
+    event, sender_app, method=None, record=None, **kwargs
+):
+    """Build an event for ILS record changes."""
+
+    if not method:
+        raise ValueError("Method must be provided to the event builder.")
+    if not record:
+        raise ValueError("Record must be provided to the event builder.")
+    if not isinstance(record, IlsRecord):
+        return None
+
+    # We have to get the pid_type directly through the private accessor,
+    # as the pid might not be registered directly after the record creation.
+    pid_type = record._pid_type
+
+    event_data = {
+        "timestamp": datetime.datetime.now(datetime.timezone.utc)
+        .replace(tzinfo=None)
+        .isoformat(),
+        "pid_type": pid_type,
+        "method": method,
+    }
+
+    event.update(event_data)
+    return event
+
+
+def add_librarian_user_id_to_event(event, sender_app, **kwargs):
+    """Add the user_id of the librarian performing the action to the event."""
+
+    user_id = None
+    if (
+        current_user
+        and current_user.is_authenticated
+        and backoffice_permission().allows(g.identity)
+    ):
+        user_id = current_user.get_id()
+
+    event.update({"user_id": user_id})
+
+    return event
+
+
+def add_record_pid_to_event(event, sender_app, record=None, **kwargs):
+    """Add the record pid to the event."""
+    if not record:
+        raise ValueError("Record must be provided to the event builder.")
+
+    # We have to get the pid directly from the record,
+    # as the pid might not yet be registered (e.g. after record creation).
+    event.update({"pid_value": record.get("pid")})
+
+    return event

invenio_app_ils/stats/file_download/os-v1/file-download-v1.json

@@ -0,0 +1,72 @@
+{
+  "index_patterns": ["__SEARCH_INDEX_PREFIX__events-stats-file-download-*"],
+  "settings": {
+    "index": {
+      "refresh_interval": "5s"
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "dynamic": false,
+    "dynamic_templates": [
+      {
+        "date_fields": {
+          "match_mapping_type": "date",
+          "mapping": {
+            "type": "date",
+            "format": "strict_date_hour_minute_second"
+          }
+        }
+      }
+    ],
+    "numeric_detection": false,
+    "properties": {
+      "bucket_id": {
+        "type": "keyword"
+      },
+      "collection": {
+        "type": "keyword"
+      },
+      "country": {
+        "type": "keyword"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "eitem_pid": {
+        "type": "keyword"
+      },
+      "file_id": {
+        "type": "keyword"
+      },
+      "file_key": {
+        "type": "keyword"
+      },
+      "is_robot": {
+        "type": "boolean"
+      },
+      "size": {
+        "type": "double"
+      },
+      "timestamp": {
+        "type": "date",
+        "format": "strict_date_hour_minute_second"
+      },
+      "updated_timestamp": {
+        "type": "date"
+      },
+      "unique_id": {
+        "type": "keyword"
+      },
+      "unique_session_id": {
+        "type": "keyword"
+      },
+      "visitor_id": {
+        "type": "keyword"
+      }
+    }
+  },
+  "aliases": {
+    "__SEARCH_INDEX_PREFIX__events-stats-file-download": {}
+  }
+}

invenio_app_ils/stats/file_download/os-v2/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2019 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""File download event Elasticsearch index templates."""