maleo-identity 0.0.85__py3-none-any.whl → 0.1.24__py3-none-any.whl

maleo/identity/schemas/user_profile.py

@@ -0,0 +1,362 @@
+from pydantic import BaseModel, Field
+from typing import Annotated, Generic, Literal, TypeVar, overload
+from uuid import UUID
+from maleo.enums.identity import (
+    OptBloodType,
+    BloodTypeMixin,
+    OptListOfBloodTypes,
+    BloodTypesMixin,
+    OptGender,
+    GenderMixin,
+    OptListOfGenders,
+    GendersMixin,
+)
+from maleo.enums.status import (
+    ListOfDataStatuses,
+    FULL_DATA_STATUSES,
+)
+from maleo.schemas.mixins.filter import convert as convert_filter
+from maleo.schemas.mixins.identity import (
+    IdentifierMixin,
+    Ids,
+    UUIDs,
+    IntUserId,
+    IntUserIds,
+    IntOrganizationIds,
+    BirthDate,
+)
+from maleo.schemas.mixins.sort import convert as convert_sort
+from maleo.schemas.operation.enums import ResourceOperationStatusUpdateType
+from maleo.schemas.parameter import (
+    ReadSingleParameter as BaseReadSingleParameter,
+    ReadPaginatedMultipleParameter,
+    StatusUpdateParameter as BaseStatusUpdateParameter,
+    DeleteSingleParameter as BaseDeleteSingleParameter,
+)
+from maleo.types.datetime import OptDate
+from maleo.types.dict import StrToAnyDict
+from maleo.types.integer import OptListOfInts
+from maleo.types.string import OptStr
+from maleo.types.uuid import OptListOfUUIDs
+from ..enums.user_profile import IdentifierType
+from ..mixins.common import (
+    IdCard,
+    FullName,
+    BirthPlace,
+)
+from ..mixins.user_profile import (
+    LeadingTitle,
+    FirstName,
+    MiddleName,
+    LastName,
+    EndingTitle,
+    UserProfileIdentifier,
+)
+from ..types.user_profile import IdentifierValueType
+
+
+class CreateParameter(
+    BloodTypeMixin[OptBloodType],
+    GenderMixin[OptGender],
+    BirthDate[OptDate],
+    BirthPlace[OptStr],
+    FullName[str],
+    EndingTitle[OptStr],
+    LastName[str],
+    MiddleName[OptStr],
+    FirstName[str],
+    LeadingTitle[OptStr],
+    IdCard[OptStr],
+    IntUserId[int],
+):
+    pass
+
+
+class ReadMultipleParameter(
+    ReadPaginatedMultipleParameter,
+    BloodTypesMixin[OptListOfBloodTypes],
+    GendersMixin[OptListOfGenders],
+    UUIDs[OptListOfUUIDs],
+    Ids[OptListOfInts],
+    IntOrganizationIds[OptListOfInts],
+    IntUserIds[OptListOfInts],
+):
+    user_ids: Annotated[OptListOfInts, Field(None, description="User's IDs")] = None
+    organization_ids: Annotated[
+        OptListOfInts, Field(None, description="Organization's IDs")
+    ] = None
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    genders: Annotated[OptListOfGenders, Field(None, description="Genders")] = None
+    blood_types: Annotated[
+        OptListOfBloodTypes, Field(None, description="Blood Types")
+    ] = None
+
+    @property
+    def _query_param_fields(self) -> set[str]:
+        return {
+            "user_ids",
+            "organization_ids",
+            "ids",
+            "uuids",
+            "statuses",
+            "genders",
+            "blood_types",
+            "search",
+            "page",
+            "limit",
+            "use_cache",
+        }
+
+    def to_query_params(self) -> StrToAnyDict:
+        params = self.model_dump(
+            mode="json", include=self._query_param_fields, exclude_none=True
+        )
+        params["filters"] = convert_filter(self.date_filters)
+        params["sorts"] = convert_sort(self.sort_columns)
+        params = {k: v for k, v in params.items()}
+        return params
+
+
+class ReadSingleParameter(BaseReadSingleParameter[UserProfileIdentifier]):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: UserProfileIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(identifier=identifier, statuses=statuses, use_cache=use_cache)
+
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.USER_ID],
+        identifier_value: int,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID_CARD],
+        identifier_value: str,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+    ) -> "ReadSingleParameter":
+        return cls(
+            identifier=UserProfileIdentifier(
+                type=identifier_type,
+                value=identifier_value,
+            ),
+            statuses=statuses,
+            use_cache=use_cache,
+        )
+
+    def to_query_params(self) -> StrToAnyDict:
+        return self.model_dump(
+            mode="json", include={"statuses", "use_cache"}, exclude_none=True
+        )
+
+
+class FullUpdateData(
+    BloodTypeMixin[OptBloodType],
+    GenderMixin[OptGender],
+    BirthDate[OptDate],
+    BirthPlace[OptStr],
+    EndingTitle[OptStr],
+    LastName[str],
+    MiddleName[OptStr],
+    FirstName[str],
+    LeadingTitle[OptStr],
+    IdCard[OptStr],
+):
+    pass
+
+
+class PartialUpdateData(
+    BloodTypeMixin[OptBloodType],
+    GenderMixin[OptGender],
+    BirthDate[OptDate],
+    BirthPlace[OptStr],
+    EndingTitle[OptStr],
+    LastName[OptStr],
+    MiddleName[OptStr],
+    FirstName[OptStr],
+    LeadingTitle[OptStr],
+    IdCard[OptStr],
+):
+    pass
+
+
+UpdateDataT = TypeVar("UpdateDataT", FullUpdateData, PartialUpdateData)
+
+
+class UpdateDataMixin(BaseModel, Generic[UpdateDataT]):
+    data: UpdateDataT = Field(..., description="Update data")
+
+
+class UpdateParameter(
+    UpdateDataMixin[UpdateDataT],
+    IdentifierMixin[UserProfileIdentifier],
+    Generic[UpdateDataT],
+):
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.USER_ID],
+        identifier_value: int,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID_CARD],
+        identifier_value: str,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+    ) -> "UpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+    ) -> "UpdateParameter":
+        return cls(
+            identifier=UserProfileIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            data=data,
+        )
+
+
+class StatusUpdateParameter(
+    BaseStatusUpdateParameter[UserProfileIdentifier],
+):
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.USER_ID],
+        identifier_value: int,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID_CARD],
+        identifier_value: str,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+    ) -> "StatusUpdateParameter":
+        return cls(
+            identifier=UserProfileIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            type=type,
+        )
+
+
+class DeleteSingleParameter(BaseDeleteSingleParameter[UserProfileIdentifier]):
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID, IdentifierType.USER_ID],
+        identifier_value: int,
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.UUID], identifier_value: UUID
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID_CARD],
+        identifier_value: str,
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter": ...
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter":
+        return cls(
+            identifier=UserProfileIdentifier(
+                type=identifier_type, value=identifier_value
+            )
+        )

maleo/identity/schemas/user_system_role.py

@@ -0,0 +1,339 @@
+from pydantic import BaseModel, Field
+from typing import Annotated, Generic, Literal, TypeVar, overload
+from uuid import UUID
+from maleo.enums.system import (
+    SystemRole,
+    OptSystemRole,
+    FullSystemRoleMixin,
+    OptListOfSystemRoles,
+    FullSystemRolesMixin,
+)
+from maleo.enums.status import (
+    ListOfDataStatuses,
+    FULL_DATA_STATUSES,
+)
+from maleo.schemas.mixins.filter import convert as convert_filter
+from maleo.schemas.mixins.identity import (
+    IdentifierMixin,
+    Ids,
+    UUIDs,
+    IntUserId,
+    IntUserIds,
+)
+from maleo.schemas.mixins.sort import convert as convert_sort
+from maleo.schemas.operation.enums import ResourceOperationStatusUpdateType
+from maleo.schemas.parameter import (
+    ReadSingleParameter as BaseReadSingleParameter,
+    ReadPaginatedMultipleParameter,
+    StatusUpdateParameter as BaseStatusUpdateParameter,
+    DeleteSingleParameter as BaseDeleteSingleParameter,
+)
+from maleo.types.dict import StrToAnyDict
+from maleo.types.integer import OptInt, OptListOfInts
+from maleo.types.uuid import OptListOfUUIDs
+from ..enums.user_system_role import IdentifierType, OptListOfExpandableFields
+from ..mixins.user_system_role import Expand, UserSystemRoleIdentifier
+from ..types.user_system_role import CompositeIdentifierType, IdentifierValueType
+
+
+class StandardCreateData(FullSystemRoleMixin[SystemRole]):
+    pass
+
+
+class FullCreateData(
+    StandardCreateData,
+    IntUserId[int],
+):
+    pass
+
+
+class CreateParameter(Expand, FullCreateData):
+    pass
+
+
+class ReadMultipleParameter(
+    Expand,
+    ReadPaginatedMultipleParameter,
+    FullSystemRolesMixin[OptListOfSystemRoles],
+    IntUserIds[OptListOfInts],
+    UUIDs[OptListOfUUIDs],
+    Ids[OptListOfInts],
+):
+    ids: Annotated[OptListOfInts, Field(None, description="Ids")] = None
+    uuids: Annotated[OptListOfUUIDs, Field(None, description="UUIDs")] = None
+    user_ids: Annotated[OptListOfInts, Field(None, description="User's IDs")] = None
+    system_roles: Annotated[
+        OptListOfSystemRoles, Field(None, description="System Roles")
+    ] = None
+
+    @property
+    def _query_param_fields(self) -> set[str]:
+        return {
+            "ids",
+            "uuids",
+            "statuses",
+            "user_ids",
+            "system_roles",
+            "search",
+            "page",
+            "limit",
+            "use_cache",
+            "expand",
+        }
+
+    def to_query_params(self) -> StrToAnyDict:
+        params = self.model_dump(
+            mode="json", include=self._query_param_fields, exclude_none=True
+        )
+        params["filters"] = convert_filter(self.date_filters)
+        params["sorts"] = convert_sort(self.sort_columns)
+        params = {k: v for k, v in params.items()}
+        return params
+
+
+class ReadSingleParameter(Expand, BaseReadSingleParameter[UserSystemRoleIdentifier]):
+    @classmethod
+    def from_identifier(
+        cls,
+        identifier: UserSystemRoleIdentifier,
+        statuses: ListOfDataStatuses = FULL_DATA_STATUSES,
+        use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
+    ) -> "ReadSingleParameter":
+        return cls(
+            identifier=identifier, statuses=statuses, use_cache=use_cache, expand=expand
+        )
+
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID],
+        identifier_value: int,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.COMPOSITE],
+        identifier_value: CompositeIdentifierType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
+    ) -> "ReadSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
+    ) -> "ReadSingleParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        statuses: ListOfDataStatuses = list(FULL_DATA_STATUSES),
+        use_cache: bool = True,
+        expand: OptListOfExpandableFields = None,
+    ) -> "ReadSingleParameter":
+        return cls(
+            identifier=UserSystemRoleIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            statuses=statuses,
+            use_cache=use_cache,
+            expand=expand,
+        )
+
+    def to_query_params(self) -> StrToAnyDict:
+        return self.model_dump(
+            mode="json", include={"statuses", "use_cache", "expand"}, exclude_none=True
+        )
+
+
+class FullUpdateData(
+    FullSystemRoleMixin[SystemRole],
+    IntUserId[int],
+):
+    pass
+
+
+class PartialUpdateData(
+    FullSystemRoleMixin[OptSystemRole],
+    IntUserId[OptInt],
+):
+    pass
+
+
+UpdateDataT = TypeVar("UpdateDataT", FullUpdateData, PartialUpdateData)
+
+
+class UpdateDataMixin(BaseModel, Generic[UpdateDataT]):
+    data: UpdateDataT = Field(..., description="Update data")
+
+
+class UpdateParameter(
+    Expand,
+    UpdateDataMixin[UpdateDataT],
+    IdentifierMixin[UserSystemRoleIdentifier],
+    Generic[UpdateDataT],
+):
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID],
+        identifier_value: int,
+        data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.COMPOSITE],
+        identifier_value: CompositeIdentifierType,
+        data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
+    ) -> "UpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
+    ) -> "UpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        data: UpdateDataT,
+        expand: OptListOfExpandableFields = None,
+    ) -> "UpdateParameter":
+        return cls(
+            identifier=UserSystemRoleIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            data=data,
+            expand=expand,
+        )
+
+
+class StatusUpdateParameter(
+    Expand,
+    BaseStatusUpdateParameter[UserSystemRoleIdentifier],
+):
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.ID],
+        identifier_value: int,
+        type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.UUID],
+        identifier_value: UUID,
+        type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.COMPOSITE],
+        identifier_value: CompositeIdentifierType,
+        type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
+    ) -> "StatusUpdateParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
+    ) -> "StatusUpdateParameter": ...
+    @classmethod
+    def new(
+        cls,
+        identifier_type: IdentifierType,
+        identifier_value: IdentifierValueType,
+        type: ResourceOperationStatusUpdateType,
+        expand: OptListOfExpandableFields = None,
+    ) -> "StatusUpdateParameter":
+        return cls(
+            identifier=UserSystemRoleIdentifier(
+                type=identifier_type, value=identifier_value
+            ),
+            type=type,
+            expand=expand,
+        )
+
+
+class DeleteSingleParameter(BaseDeleteSingleParameter[UserSystemRoleIdentifier]):
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.ID], identifier_value: int
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: Literal[IdentifierType.UUID], identifier_value: UUID
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls,
+        identifier_type: Literal[IdentifierType.COMPOSITE],
+        identifier_value: CompositeIdentifierType,
+    ) -> "DeleteSingleParameter": ...
+    @overload
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter": ...
+    @classmethod
+    def new(
+        cls, identifier_type: IdentifierType, identifier_value: IdentifierValueType
+    ) -> "DeleteSingleParameter":
+        return cls(
+            identifier=UserSystemRoleIdentifier(
+                type=identifier_type, value=identifier_value
+            )
+        )

maleo/identity/types/api_key.py

@@ -0,0 +1,7 @@
+from typing import Tuple
+from uuid import UUID
+from maleo.types.integer import OptInt
+
+
+CompositeIdentifierType = Tuple[int, OptInt]
+IdentifierValueType = int | UUID | str | CompositeIdentifierType

maleo/identity/types/organization.py

@@ -0,0 +1,4 @@
+from uuid import UUID
+
+
+IdentifierValueType = int | UUID | str

maleo/identity/types/organization_registration_code.py

@@ -0,0 +1,4 @@
+from uuid import UUID
+
+
+IdentifierValueType = int | UUID | str