oarepo-runtime 1.5.91__tar.gz → 1.5.93__tar.gz

{oarepo_runtime-1.5.91/oarepo_runtime.egg-info → oarepo_runtime-1.5.93}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: oarepo-runtime
-Version: 1.5.91
+Version: 1.5.93
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

oarepo_runtime-1.5.93/oarepo_runtime/services/permissions/__init__.py

@@ -0,0 +1,3 @@
+from .generators import IfDraftType, RecordOwners, UserWithRole
+
+__all__ = ("RecordOwners", "UserWithRole", "IfDraftType")

{oarepo_runtime-1.5.91 → oarepo_runtime-1.5.93}/oarepo_runtime/services/permissions/generators.py

@@ -1,7 +1,14 @@
+from typing import Literal
+
+from flask import current_app
 from flask_principal import RoleNeed, UserNeed
-from invenio_records_permissions.generators import Generator
+from invenio_records_permissions.generators import (
+    ConditionalGenerator,
+    Disable,
+    Generator,
+)
 from invenio_search.engine import dsl
-from flask import current_app
+
 
 class RecordOwners(Generator):
     """Allows record owners."""
@@ -12,7 +19,7 @@ class RecordOwners(Generator):
             # 'record' is required, so if not passed we default to empty array,
             # i.e. superuser-access.
             return []
-        if current_app.config.get('INVENIO_RDM_ENABLED', False):
+        if current_app.config.get("INVENIO_RDM_ENABLED", False):
             owners = getattr(record.parent.access, "owned_by", None)
             if owners is not None:
                 owners_list = owners if isinstance(owners, list) else [owners]
@@ -27,11 +34,12 @@ class RecordOwners(Generator):
         """Filters for current identity as owner."""
         users = [n.value for n in identity.provides if n.method == "id"]
         if users:
-            if current_app.config.get('INVENIO_RDM_ENABLED', False):
+            if current_app.config.get("INVENIO_RDM_ENABLED", False):
                 return dsl.Q("terms", **{"parent.access.owned_by.user": users})
             else:
                 return dsl.Q("terms", **{"parent.owners.user": users})
 
+
 class UserWithRole(Generator):
     def __init__(self, *roles):
         self.roles = roles
@@ -46,3 +54,49 @@ class UserWithRole(Generator):
             if provide.method == "role" and provide.value in self.roles:
                 return dsl.Q("match_all")
         return dsl.Q("match_none")
+
+
+class IfDraftType(ConditionalGenerator):
+    def __init__(
+        self,
+        draft_types: list[
+            Literal["initial"] | Literal["metadata"] | Literal["new_version"]
+        ]
+        | Literal["initial"]
+        | Literal["metadata"]
+        | Literal["new_version"],
+        then_=None,
+        else_=None,
+    ):
+        if not isinstance(draft_types, (list, tuple)):
+            draft_types = [draft_types]
+        self._draft_types = draft_types
+        if not then_:
+            then_ = [Disable()]
+        if not else_:
+            else_ = [Disable()]
+        if not isinstance(then_, (list, tuple)):
+            then_ = [then_]
+        if not isinstance(else_, (list, tuple)):
+            else_ = [else_]
+        super().__init__(then_, else_)
+
+    def _condition(self, record=None, **kwargs):
+        if not record:
+            return False
+
+        index = record.versions.index
+        is_latest = record.versions.is_latest
+        is_draft = record.is_draft
+
+        if not is_draft:
+            return False
+
+        if index == 1 and not is_latest:
+            draft_type = "initial"
+        elif index > 1 and not is_latest:
+            draft_type = "new_version"
+        else:
+            draft_type = "metadata"
+
+        return draft_type in self._draft_types

{oarepo_runtime-1.5.91 → oarepo_runtime-1.5.93}/oarepo_runtime/services/schema/marshmallow.py

@@ -1,10 +1,12 @@
 import typing
 
-import marshmallow as ma
+from invenio_rdm_records.services.schemas.record import RDMRecordSchema
 from invenio_records_resources.services.records.schema import (
     BaseRecordSchema as InvenioBaseRecordSchema,
 )
 
+import marshmallow as ma
+
 
 class BaseRecordSchema(InvenioBaseRecordSchema):
     """Base record schema - in addition to invenio exposes $schema as well."""
@@ -12,6 +14,12 @@ class BaseRecordSchema(InvenioBaseRecordSchema):
     _schema = ma.fields.Str(attribute="$schema", data_key="$schema")
 
 
+class RDMBaseRecordSchema(RDMRecordSchema):
+    """Base record schema - in addition to invenio exposes $schema as well."""
+
+    _schema = ma.fields.Str(attribute="$schema", data_key="$schema")
+
+
 class DictOnlySchema(ma.Schema):
     def get_attribute(self, obj: typing.Any, attr: str, default: typing.Any):
         if not isinstance(attr, int) and "." in attr:

{oarepo_runtime-1.5.91 → oarepo_runtime-1.5.93}/oarepo_runtime/services/search.py

@@ -2,11 +2,18 @@ import dataclasses
 import inspect
 from typing import List
 
+from invenio_rdm_records.services.config import (
+    RDMSearchDraftsOptions as BaseRDMSearchDraftsOptions,
+)
+from invenio_rdm_records.services.config import (
+    RDMSearchOptions as BaseRDMSearchOptions,
+)
 from invenio_records_resources.proxies import current_service_registry
 from invenio_records_resources.services.records import (
     SearchOptions as InvenioSearchOptions,
 )
 from invenio_records_resources.services.records.params import (
+    FacetsParam,
     PaginationParam,
     QueryStrParam,
     SortParam,
@@ -17,6 +24,7 @@ from invenio_search.engine import dsl
 # TODO: integrate this to invenio_records_resources.services.records and remove SearchOptions class
 from oarepo_runtime.i18n import lazy_gettext as _
 from oarepo_runtime.records.systemfields.icu import ICUSuggestField
+from oarepo_runtime.utils.functools import class_property
 
 from .facets.params import GroupedFacetsParam
 
@@ -47,13 +55,16 @@ class FuzzySuggestQueryParser(SuggestQueryParser):
         return dsl.Q("bool", should=[multi_match_with_bool_prefix, multi_match_fuzzy])
 
 
-class SearchOptions(InvenioSearchOptions):
-    params_interpreters_cls = [
-        QueryStrParam,
-        PaginationParam,
-        SortParam,
-        GroupedFacetsParam,
-    ]
+class SearchOptionsMixin:
+    @class_property
+    def params_interpreters_cls(cls):
+        """Replaces FacetsParam with GroupedFacetsParam."""
+        param_interpreters = [*super(SearchOptionsMixin, cls).params_interpreters_cls]
+        # replace FacetsParam with GroupedFacetsParam
+        for idx, interpreter in enumerate(param_interpreters):
+            if interpreter == FacetsParam:
+                param_interpreters[idx] = GroupedFacetsParam
+        return param_interpreters
 
     sort_options = {
         "title": dict(
@@ -75,6 +86,24 @@ class SearchOptions(InvenioSearchOptions):
     }
 
 
+class SearchOptions(SearchOptionsMixin, InvenioSearchOptions):
+    # TODO: should be changed
+    params_interpreters_cls = [
+        QueryStrParam,
+        PaginationParam,
+        SortParam,
+        GroupedFacetsParam,
+    ]
+
+
+class RDMSearchOptions(SearchOptionsMixin, BaseRDMSearchOptions):
+    pass
+
+
+class RDMSearchDraftsOptions(SearchOptionsMixin, BaseRDMSearchDraftsOptions):
+    pass
+
+
 @dataclasses.dataclass
 class SuggestField:
     field: str
@@ -192,3 +221,13 @@ class ICUSortOptions:
 class I18nSearchOptions(SearchOptions):
     extra_sort_options = {}
     record_cls = None
+
+
+class I18nRDMSearchOptions(RDMSearchOptions):
+    extra_sort_options = {}
+    record_cls = None
+
+
+class I18nRDMDraftsSearchOptions(RDMSearchDraftsOptions):
+    extra_sort_options = {}
+    record_cls = None

{oarepo_runtime-1.5.91 → oarepo_runtime-1.5.93/oarepo_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: oarepo-runtime
-Version: 1.5.91
+Version: 1.5.93
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo_runtime-1.5.91 → oarepo_runtime-1.5.93}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-runtime
-version = 1.5.91
+version = 1.5.93
 description = A set of runtime extensions of Invenio repository
 authors = Alzbeta Pokorna
 readme = README.md

oarepo_runtime-1.5.91/oarepo_runtime/services/permissions/__init__.py

@@ -1,3 +0,0 @@
-from .generators import RecordOwners, UserWithRole
-
-__all__ = ("RecordOwners", "UserWithRole")