oarepo-runtime 2.0.0.dev13__tar.gz → 2.0.0.dev15__tar.gz

{oarepo_runtime-2.0.0.dev13 → oarepo_runtime-2.0.0.dev15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 2.0.0.dev13
+Version: 2.0.0.dev15
 Summary: A set of runtime extensions of Invenio repository
 Project-URL: Homepage, https://github.com/oarepo/oarepo-runtime
 License-Expression: MIT

{oarepo_runtime-2.0.0.dev13 → oarepo_runtime-2.0.0.dev15}/oarepo_runtime/__init__.py

@@ -19,6 +19,6 @@ from .api import Model
 from .ext import OARepoRuntime
 from .proxies import current_runtime
 
-__version__ = "2.0.0dev13"
+__version__ = "2.0.0dev15"
 
 __all__ = ("Model", "OARepoRuntime", "__version__", "current_runtime")

{oarepo_runtime-2.0.0.dev13 → oarepo_runtime-2.0.0.dev15}/oarepo_runtime/api.py

@@ -41,6 +41,21 @@ if TYPE_CHECKING:
     )
 
 
+@dataclasses.dataclass
+class ModelMetadata:
+    """Model metadata configuration.
+
+    ModeMetadata is used in oarepo-model to add metadata to the model's oarepo_model_arguments dict.
+    """
+
+    types: dict[str, Any]
+    """Dictionary of types passed from InvenioModelBuilder.type_registry"""
+    metadata_type: str | None = None
+    """Metadata type"""
+    record_type: str | None = None
+    """Record type"""
+
+
 @dataclasses.dataclass
 class Export:
     """Configuration of an export format.
@@ -110,6 +125,7 @@ class Model[
         media_draft_file_service: FileService | None = None,
         exports: list[Export] | None = None,
         records_alias_enabled: bool = True,
+        model_metadata: ModelMetadata | None = None,
     ):
         """Initialize the model configuration.
 
@@ -132,6 +148,7 @@ class Model[
             If not provided, no exports are available.
         :param records_alias_enabled: Whether the records alias is enabled for this model.
             Such models will be searchable via the `/api/records` endpoint.
+        :param model_metadata: Metadata of the model.
         """
         self._code = code
         self._name = name
@@ -153,6 +170,7 @@ class Model[
         self._resource = resource
         self._resource_config = resource_config
         self._exports = exports or []
+        self._model_metadata = model_metadata
 
     @property
     def code(self) -> str:
@@ -183,6 +201,11 @@ class Model[
         """
         return self._records_alias_enabled
 
+    @property
+    def model_metadata(self) -> ModelMetadata | None:
+        """Get the model metadata."""
+        return self._model_metadata
+
     @property
     def ui_model(self) -> Mapping[str, Any]:
         """Get the UI model."""

{oarepo_runtime-2.0.0.dev13 → oarepo_runtime-2.0.0.dev15}/oarepo_runtime/services/config/components.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2025 CESNET z.s.p.o.
 #
-# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+# This file is a part of oarepo-runtime (see https://github.com/oarepo/oarepo-runtime).
 #
 # oarepo-runtime is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.

oarepo_runtime-2.0.0.dev15/oarepo_runtime/services/generators.py

@@ -0,0 +1,77 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see https://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+"""Typed invenio generators."""
+
+from __future__ import annotations
+
+from abc import abstractmethod
+from typing import TYPE_CHECKING, Any, override
+
+from invenio_records_permissions.generators import (
+    ConditionalGenerator as InvenioConditionalGenerator,
+)
+from invenio_records_permissions.generators import Generator as InvenioGenerator
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+    from flask_principal import Need
+    from invenio_records_resources.records.api import Record
+    from invenio_search.engine import dsl
+
+
+class Generator(InvenioGenerator):
+    """Custom generator for the service.
+
+    This class will be removed when invenio has proper type stubs.
+    """
+
+    @override
+    def needs(self, **kwargs: Any) -> Sequence[Need]:  # type: ignore[reportIncompatibleMethodOverride]
+        return super().needs(**kwargs)  # type: ignore[no-any-return]
+
+    @override
+    def excludes(self, **kwargs: Any) -> Sequence[Need]:  # type: ignore[reportIncompatibleMethodOverride]
+        return super().excludes(**kwargs)  # type: ignore[no-any-return]
+
+    @override
+    def query_filter(self, **kwargs: Any) -> dsl.query.Query:  # type: ignore[reportIncompatibleMethodOverride]
+        return super().query_filter(**kwargs)  # type: ignore[no-any-return]
+
+
+class ConditionalGenerator(InvenioConditionalGenerator):
+    """Typed conditional generator.
+
+    This class will be removed when invenio has proper type stubs.
+    """
+
+    def __init__(self, then_: Sequence[InvenioGenerator], else_: Sequence[InvenioGenerator]) -> None:
+        """Initialize the conditional generator."""
+        super().__init__(then_=then_, else_=else_)
+
+    @abstractmethod
+    def _condition(self, **kwargs: Any) -> bool:
+        """Condition to choose generators set."""
+        raise NotImplementedError  # pragma: nocover
+
+    def _generators(self, record: Record, **kwargs: Any) -> Sequence[InvenioGenerator]:
+        """Get the "then" or "else" generators."""
+        return super()._generators(record=record, **kwargs)  # type: ignore[no-any-return]
+
+    @override
+    def needs(self, **kwargs: Any) -> Sequence[Need]:  # type: ignore[override]
+        return super().needs(**kwargs)  # type: ignore[no-any-return]
+
+    @override
+    def excludes(self, **kwargs: Any) -> Sequence[Need]:  # type: ignore[override]
+        return super().excludes(**kwargs)  # type: ignore[no-any-return]
+
+    @override
+    def query_filter(self, **kwargs: Any) -> dsl.query.Query:  # type: ignore[reportIncompatibleMethodOverride]
+        return super().query_filter(**kwargs)  # type: ignore[no-any-return]

{oarepo_runtime-2.0.0.dev13 → oarepo_runtime-2.0.0.dev15}/oarepo_runtime/services/records/__init__.py

@@ -11,6 +11,6 @@
 
 from __future__ import annotations
 
-from .links import pagination_links_html
+from .links import pagination_endpoint_links_html
 
-__all__ = ("pagination_links_html",)
+__all__ = ("pagination_endpoint_links_html",)

oarepo_runtime-2.0.0.dev15/oarepo_runtime/services/records/links.py

@@ -0,0 +1,35 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+
+"""Utility for rendering URI template links."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from invenio_records_resources.services.base.links import EndpointLink
+
+
+def pagination_endpoint_links_html(endpoint: str, params: dict[str, Any] | None = None) -> dict[str, EndpointLink]:
+    """Create pagination links (prev/self/next) from the same endpoint."""
+    return {
+        "prev_html": EndpointLink(
+            endpoint,
+            when=lambda pagination, _ctx: pagination.has_prev,
+            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.prev_page.page}),
+            params=params,
+        ),
+        "self_html": EndpointLink(endpoint, params=params),
+        "next_html": EndpointLink(
+            endpoint,
+            when=lambda pagination, _ctx: pagination.has_next,
+            vars=lambda pagination, _vars: _vars["args"].update({"page": pagination.next_page.page}),
+            params=params,
+        ),
+    }

oarepo_runtime-2.0.0.dev13/oarepo_runtime/services/records/links.py

@@ -1,31 +0,0 @@
-#
-# Copyright (c) 2025 CESNET z.s.p.o.
-#
-# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
-#
-# oarepo-runtime is free software; you can redistribute it and/or modify it
-# under the terms of the MIT License; see LICENSE file for more details.
-#
-
-"""Utility for rendering URI template links."""
-
-from __future__ import annotations
-
-from invenio_records_resources.services.base.links import Link
-
-
-def pagination_links_html(tpl: str) -> dict[str, Link]:
-    """Create pagination links (prev/self/next) from the same template."""
-    return {
-        "prev_html": Link(
-            tpl,
-            when=lambda pagination, _context: pagination.has_prev,
-            vars=lambda pagination, variables: variables["args"].update({"page": pagination.prev_page.page}),
-        ),
-        "self_html": Link(tpl),
-        "next_html": Link(
-            tpl,
-            when=lambda pagination, _context: pagination.has_next,
-            vars=lambda pagination, variables: variables["args"].update({"page": pagination.next_page.page}),
-        ),
-    }