nrp_cmd.types

16class Model:
17    """Base model, which allows getting extra fields via normal dot operator."""
18
19    _extra_data: dict[str, Any]
20
21    def __getattr__(self, item: str) -> Any:  # noqa: ANN401
22        """Get extra fields from the model_extra attribute."""
23        if "_extra_data" not in self.__dict__:
24            self._extra_data: dict[str, Any] = {}
25
26        if item in self._extra_data:
27            return self._extra_data[item]
28        dash_item = item.replace("_", "-")
29        if dash_item in self._extra_data:
30            return self._extra_data[dash_item]
31
32        raise AttributeError(f"{self.__class__.__name__} has no attribute {item}")

118@extend_serialization(allow_extra_data=True)
119@define(kw_only=True)
120class RepositoryInfo(Model):
121    """Extra info downloaded from nrp-compatible invenio repository."""
122    schema: str
123    """Version of this configuration schema"""
124
125    name: str
126    """The name of the repository"""
127
128    description: str
129    """The description of the repository"""
130
131    version: str
132    """The version of the repository"""
133
134    invenio_version: str
135    """The version of invenio the repository is based on"""
136
137    links: RepositoryInfoLinks
138    """Links to the repository"""
139
140    transfers: list[str] = field(factory=list)
141    """List of supported file transfer protocols"""
142
143    models: dict[str, ModelInfo] = field(factory=dict)
144    """Information about the models in the repository"""
145
146    default_model: str | None = field(default=None)
147    """The default model for the repository. 
148    If set, it is used whenever the model is not specified."""

20@extend_serialization(Rename("self", "self_"), allow_extra_data=True)
21@define(kw_only=True)
22class RepositoryInfoLinks(Model):
23    """Links within the repository info endpoint."""
24
25    self_: URL
26    """Link to the repository itself"""
27
28    records: URL
29    """Link to the global search endpoint"""
30
31    drafts: URL
32    """Link to the user's records"""
33
34    models: Optional[URL]
35    """Link to the models in the repository"""
36
37    requests: URL
38    """Link to the requests in the repository"""

 86@extend_serialization(allow_extra_data=True)
 87@define(kw_only=True)
 88class ModelInfo(Model):
 89    """Information about metadata model within invenio server."""
 90    type: str
 91    """The type of the model"""
 92
 93    schema: str
 94    """The json schema of the model"""
 95
 96    name: str
 97    """The name of the model"""
 98
 99    description: str
100    """The description of the model"""
101
102    version: str
103    """The version of the model"""
104
105    features: list[str]
106    """List of features supported by the model"""
107
108    links: ModelInfoLinks
109    """Links to the model"""
110
111    content_types: list[ModelInfoContentType] = field(factory=list)
112    """List of supported content-types for API serialization"""
113    
114    metadata: bool = field(default=True)
115    """Whether the model contains metadata inside the metadata element."""

62@extend_serialization(allow_extra_data=True)
63@define(kw_only=True)
64class ModelInfoContentType(Model):
65    """Acceptable content-types for the model."""
66
67    content_type: str
68    """The content-type accepted by the model"""
69
70    name: str | None = None
71    """The name of the content-type"""
72
73    description: str | None = None
74    """The description of the content-type"""
75
76    schema: URL | None = None
77    """Machine parseable schema for the content-type"""
78    
79    can_export: bool = False
80    """Whether the content-type can be used for exporting records (via Accept header)"""
81    
82    can_deposit: bool = False
83    """Whether the content-type can be used for importing records (via Content-Type header)"""

41@extend_serialization(allow_extra_data=True)
42@define(kw_only=True)
43class ModelInfoLinks(Model):
44    """Links within the model info endpoint."""
45
46    records: URL
47    """Link to the published records"""
48
49    html: URL | None = field(default=None)
50    """Link to the model records' HTML listing page"""
51
52    drafts: Optional[URL] = field(default=None)
53    """Link to the user's draft records"""
54
55    deposit: Optional[URL] = field(default=None)
56    """Deposition link for the model"""
57
58    model: URL | None = field(default=None)
59    """Link to the model definition"""

55@extend_serialization(Rename("files", "files_"), 
56                      Omit("_etag", from_unstructure=True), 
57                      allow_extra_data=True)
58@define(kw_only=True)
59class Record(BaseRecord):
60    """Record in the repository."""
61
62    links: RecordLinks = field()
63    """Links of the record."""
64
65    files_: Optional[FilesEnabled] = None
66    """Files enabled marker."""
67
68    parent: Optional[ParentRecord] = None
69
70    @property
71    def metadata(self) -> dict:
72        """Return the metadata of the record."""
73        if 'metadata' in self._extra_data:
74            return self._extra_data['metadata']
75        return self._extra_data

28@define(kw_only=True)
29class RecordLinks(RESTObjectLinks):
30    """Links of a record."""
31
32    # TODO: add rest of the links here so that code editors can autocomplete
33    pass

36@define(kw_only=True)
37class FilesEnabled(Model):
38    """Files enabled marker."""
39
40    enabled: bool

43@define(kw_only=True)
44class ParentRecord(Model):
45    """Parent record of the record."""
46
47    communities: dict[str, str]
48    """Communities of the record."""
49
50    workflow: str
51    """Workflow of the record."""

78@extend_serialization(Omit("_etag", from_unstructure=True), allow_extra_data=True)
79@define(kw_only=True)
80class RecordList(RESTList[Record]):
81    """List of records."""
82
83    sortBy: Optional[str] = None
84    """Sort by field."""
85    aggregations: Optional[Any] = None
86    """Aggregations."""