oarepo-runtime 2.0.0.dev4__tar.gz → 2.0.0.dev6__tar.gz

{oarepo_runtime-2.0.0.dev4 → oarepo_runtime-2.0.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 2.0.0.dev4
+Version: 2.0.0.dev6
 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.dev4 → oarepo_runtime-2.0.0.dev6}/oarepo_runtime/__init__.py

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

{oarepo_runtime-2.0.0.dev4 → oarepo_runtime-2.0.0.dev6}/oarepo_runtime/api.py

@@ -13,13 +13,16 @@ from __future__ import annotations
 
 import dataclasses
 from functools import cached_property
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, Any, cast
 
 from flask import current_app
+from invenio_base import invenio_url_for
 from invenio_base.utils import obj_or_import_string
 from invenio_records_resources.proxies import current_service_registry
 
 if TYPE_CHECKING:
+    from collections.abc import Mapping
+
     from flask_babel.speaklater import LazyString
     from flask_resources.responses import ResponseHandler
     from flask_resources.serializers import BaseSerializer
@@ -27,7 +30,11 @@ if TYPE_CHECKING:
     from invenio_records_resources.records.api import RecordBase
     from invenio_records_resources.resources.records.config import RecordResourceConfig
     from invenio_records_resources.resources.records.resource import RecordResource
-    from invenio_records_resources.services import RecordService, RecordServiceConfig
+    from invenio_records_resources.services import (
+        FileService,
+        RecordService,
+        RecordServiceConfig,
+    )
 
 
 @dataclasses.dataclass
@@ -37,6 +44,9 @@ class Export:
     Exports are shown on the record landing page and user can download them.
     """
 
+    code: str
+    """Code of the export format, used to identify the export format in the URL."""
+
     name: LazyString
     """Name of the export format, human readable."""
 
@@ -75,31 +85,25 @@ class Model[
     variable.
     """
 
-    name: str | LazyString
-    """Name of the model, human readable."""
-
-    version: str
-    """Version of the model, should be a valid semantic version."""
-
-    description: str | LazyString | None = None
-    """Description of the model, human readable."""
-
-    records_alias_enabled: bool = False
-    """Whether the records alias is enabled for this model. Such models will be searchable
-    via the `/api/records` endpoint."""
-
     def __init__(  # noqa: PLR0913 more attributes as we are creating a config
         self,
+        *,
+        code: str,
         name: str | LazyString,
         version: str,
         service: str | S,
         resource_config: RC | str,
+        ui_model: Mapping[str, Any] | None = None,
         # params with default values
         service_config: C | None = None,
         description: str | LazyString | None = None,
         record: type[R] | None = None,
         draft: type[D] | None = None,
-        resource: str | RR = "invenio_records_resources.resources.records.resource.RecordResource",
+        resource: (str | RR) = "invenio_records_resources.resources.records.resource.RecordResource",
+        file_service: FileService | None = None,
+        draft_file_service: FileService | None = None,
+        media_file_service: FileService | None = None,
+        media_draft_file_service: FileService | None = None,
         exports: list[Export] | None = None,
         records_alias_enabled: bool = True,
     ):
@@ -125,10 +129,17 @@ class Model[
         :param records_alias_enabled: Whether the records alias is enabled for this model.
             Such models will be searchable via the `/api/records` endpoint.
         """
-        self.name = name
-        self.version = version
-        self.description = description
-        self.records_alias_enabled = records_alias_enabled
+        self._code = code
+        self._name = name
+        self._version = version
+        self._description = description
+        self._records_alias_enabled = records_alias_enabled
+        self._ui_model = ui_model or {}
+
+        self._file_service = file_service
+        self._draft_file_service = draft_file_service
+        self._media_file_service = media_file_service
+        self._media_draft_file_service = media_draft_file_service
 
         # lazy getters ...
         self._record = record
@@ -139,6 +150,40 @@ class Model[
         self._resource_config = resource_config
         self._exports = exports or []
 
+    @property
+    def code(self) -> str:
+        """Return the machine-understandable code of the model."""
+        return self._code
+
+    @property
+    def name(self) -> str | LazyString:
+        """Get the human-readable name of the model."""
+        return self._name
+
+    @property
+    def version(self) -> str:
+        """Get the model's version."""
+        return self._version
+
+    @property
+    def description(self) -> str | LazyString | None:
+        """Get the model's description."""
+        return self._description
+
+    @property
+    def records_alias_enabled(self) -> bool:
+        """Get the records alias enabled flag.
+
+        This switch determines whether the records alias (/api/records)
+        is enabled for this model and whether the model is indexed in global search.
+        """
+        return self._records_alias_enabled
+
+    @property
+    def ui_model(self) -> Mapping[str, Any]:
+        """Get the UI model."""
+        return self._ui_model
+
     @property
     def service(self) -> S:
         """Get the service."""
@@ -172,6 +217,35 @@ class Model[
             return None
         return self._draft
 
+    @property
+    def file_service(self) -> FileService | None:
+        """Get the file service."""
+        return self._file_service
+
+    @property
+    def draft_file_service(self) -> FileService | None:
+        """Get the draft file service."""
+        return self._draft_file_service
+
+    @property
+    def media_file_service(self) -> FileService | None:
+        """Get the media file service."""
+        return self._media_file_service
+
+    @property
+    def media_draft_file_service(self) -> FileService | None:
+        """Get the media draft file service."""
+        return self._media_draft_file_service
+
+    @property
+    def api_blueprint_name(self) -> str:
+        """Get the API blueprint name for the model."""
+        return cast("str", self.resource_config.blueprint_name)
+
+    def api_url(self, view_name: str, **kwargs: Any) -> str:
+        """Get the API URL for the model."""
+        return cast("str", invenio_url_for(f"{self.api_blueprint_name}.{view_name}", **kwargs))
+
     @cached_property
     def resource_config(self) -> RC:
         """Get the resource configuration."""

{oarepo_runtime-2.0.0.dev4 → oarepo_runtime-2.0.0.dev6}/oarepo_runtime/config.py

@@ -13,6 +13,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any
 
+from invenio_i18n import lazy_gettext as _
 from invenio_vocabularies import __version__ as vocabularies_version
 
 from .api import Model
@@ -43,7 +44,8 @@ def build_config[T](config_class: type[T], app: Flask, *args: Any, **kwargs: Any
 OAREPO_MODELS: dict[str, Model] = {
     # default invenio vocabularies
     "vocabularies": Model(
-        name="vocabularies",
+        code="vocabularies",
+        name=_("Base vocabularies"),
         version=vocabularies_version,
         service="vocabularies",
         description="Base (non-specialized) invenio vocabularies",
@@ -53,7 +55,8 @@ OAREPO_MODELS: dict[str, Model] = {
     ),
     # affiliations
     "affiliations": Model(
-        name="affiliations",
+        code="affiliations",
+        name=_("Affiliations"),
         version=vocabularies_version,
         service="affiliations",
         description="Affiliations vocabulary",
@@ -63,7 +66,8 @@ OAREPO_MODELS: dict[str, Model] = {
     ),
     # funders
     "funders": Model(
-        name="funders",
+        code="funders",
+        name=_("Funders"),
         version=vocabularies_version,
         service="funders",
         description="Funders vocabulary",
@@ -73,7 +77,8 @@ OAREPO_MODELS: dict[str, Model] = {
     ),
     # awards
     "awards": Model(
-        name="awards",
+        code="awards",
+        name=_("Awards"),
         version=vocabularies_version,
         service="awards",
         description="Awards vocabulary",
@@ -83,7 +88,8 @@ OAREPO_MODELS: dict[str, Model] = {
     ),
     # names
     "names": Model(
-        name="names",
+        code="names",
+        name=_("Names"),
         version=vocabularies_version,
         service="names",
         description="Names vocabulary",
@@ -93,7 +99,8 @@ OAREPO_MODELS: dict[str, Model] = {
     ),
     # subjects
     "subjects": Model(
-        name="subjects",
+        code="subjects",
+        name=_("Subjects"),
         version=vocabularies_version,
         service="subjects",
         description="Subjects vocabulary",

{oarepo_runtime-2.0.0.dev4 → oarepo_runtime-2.0.0.dev6}/oarepo_runtime/services/facets/params.py

@@ -32,7 +32,7 @@ log = logging.getLogger(__name__)
 class GroupedFacetsParam(FacetsParam):
     """Facet parameter class that supports grouping of facets."""
 
-    def __init__(self, config: SearchOptions):
+    def __init__(self, config: type[SearchOptions]):
         """Initialize the facets parameter with the given config."""
         super().__init__(config)
         self._facets = {**config.facets}