adds can_load and can_publish (#420)

* add text class and tests

* formatting

* fix default values

* comments

* comment

* sort imports

* import alignments

* compare properties, not Base objects

* revert irrelevant changes

* tests

* use correct fixture

* fix tests property

.github/workflows/pr.yml

@@ -38,17 +38,17 @@ jobs:
         run: uv run pre-commit run --all-files
 
       - name: Run Speckle Server
-        run: docker compose up -d
+        run: docker compose up --detach --wait
 
-      # - name: Run tests
-      #   run: uv run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
+      - name: Run tests
+        run: uv run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
 
-      # - uses: codecov/codecov-action@v5
-      #   if: matrix.python-version == 3.13
-      #   with:
-      #     fail_ci_if_error: true # optional (default = false)
-      #     files: ./reports/test-results.xml # optional
-      #     token: ${{ secrets.CODECOV_TOKEN }}
+      - uses: codecov/codecov-action@v5
+        if: matrix.python-version == 3.13
+        with:
+          fail_ci_if_error: true # optional (default = false)
+          files: ./reports/test-results.xml # optional
+          token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Minimize uv cache
         run: uv cache prune --ci

src/specklepy/api/client.py

@@ -10,6 +10,7 @@ from specklepy.api.resources import (
     ServerResource,
     SubscriptionResource,
     VersionResource,
+    WorkspaceResource,
 )
 from specklepy.core.api.client import SpeckleClient as CoreSpeckleClient
 from specklepy.logging import metrics
@@ -111,6 +112,12 @@ class SpeckleClient(CoreSpeckleClient):
             client=self.httpclient,
             server_version=server_version,
         )
+        self.workspace = WorkspaceResource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
         self.subscription = SubscriptionResource(
             account=self.account,
             basepath=self.ws_url,

src/specklepy/api/resources/__init__.py

@@ -8,6 +8,7 @@ from specklepy.api.resources.current.project_resource import ProjectResource
 from specklepy.api.resources.current.server_resource import ServerResource
 from specklepy.api.resources.current.subscription_resource import SubscriptionResource
 from specklepy.api.resources.current.version_resource import VersionResource
+from specklepy.api.resources.current.workspace_resource import WorkspaceResource
 
 __all__ = [
     "ActiveUserResource",
@@ -18,4 +19,5 @@ __all__ = [
     "ServerResource",
     "SubscriptionResource",
     "VersionResource",
+    "WorkspaceResource",
 ]

src/specklepy/api/resources/current/active_user_resource.py

@@ -1,12 +1,17 @@
 from typing import List, Optional
 
-from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
+from specklepy.core.api.inputs.user_inputs import (
+    UserProjectsFilter,
+    UserUpdateInput,
+    UserWorkspacesFilter,
+)
 from specklepy.core.api.models import (
     PendingStreamCollaborator,
     Project,
     ResourceCollection,
     User,
 )
+from specklepy.core.api.models.current import PermissionCheckResult, Workspace
 from specklepy.core.api.resources import ActiveUserResource as CoreResource
 from specklepy.logging import metrics
 
@@ -51,3 +56,26 @@ class ActiveUserResource(CoreResource):
             metrics.SDK, self.account, {"name": "Active User Get Project Invites"}
         )
         return super().get_project_invites()
+
+    def can_create_personal_projects(self) -> PermissionCheckResult:
+        metrics.track(
+            metrics.SDK,
+            self.account,
+            {"name": "Active User Can Create Personal Projects Check"},
+        )
+        return super().can_create_personal_projects()
+
+    def get_workspaces(
+        self,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[UserWorkspacesFilter] = None,
+    ) -> ResourceCollection[Workspace]:
+        metrics.track(metrics.SDK, self.account, {"name": "Active User Get Workspaces"})
+        return super().get_workspaces(limit, cursor, filter)
+
+    def get_active_workspace(self) -> Optional[Workspace]:
+        metrics.track(
+            metrics.SDK, self.account, {"name": "Active User Get Active Workspace"}
+        )
+        return super().get_active_workspace()

src/specklepy/api/resources/current/project_resource.py

@@ -5,8 +5,10 @@ from specklepy.core.api.inputs.project_inputs import (
     ProjectModelsFilter,
     ProjectUpdateInput,
     ProjectUpdateRoleInput,
+    WorkspaceProjectCreateInput,
 )
 from specklepy.core.api.models import Project, ProjectWithModels, ProjectWithTeam
+from specklepy.core.api.models.current import ProjectPermissionChecks
 from specklepy.core.api.resources import ProjectResource as CoreResource
 from specklepy.logging import metrics
 
@@ -26,6 +28,12 @@ class ProjectResource(CoreResource):
         metrics.track(metrics.SDK, self.account, {"name": "Project Get "})
         return super().get(project_id)
 
+    def get_permissions(self, project_id: str) -> ProjectPermissionChecks:
+        metrics.track(
+            metrics.SDK, self.account, {"name": "Project Project Permissions "}
+        )
+        return super().get_permissions(project_id)
+
     def get_with_models(
         self,
         project_id: str,
@@ -50,6 +58,10 @@ class ProjectResource(CoreResource):
         metrics.track(metrics.SDK, self.account, {"name": "Project Create"})
         return super().create(input)
 
+    def create_in_workspace(self, input: WorkspaceProjectCreateInput) -> Project:
+        metrics.track(metrics.SDK, self.account, {"name": "Workspace Project Create"})
+        return super().create_in_workspace(input)
+
     def update(self, input: ProjectUpdateInput) -> Project:
         metrics.track(metrics.SDK, self.account, {"name": "Project Update"})
         return super().update(input)

src/specklepy/api/resources/current/workspace_resource.py

@@ -0,0 +1,32 @@
+from typing import Optional
+
+from specklepy.core.api.inputs.project_inputs import WorksaceProjectsFilter
+from specklepy.core.api.models.current import Project, ResourceCollection, Workspace
+from specklepy.core.api.resources import WorkspaceResource as CoreResource
+from specklepy.logging import metrics
+
+
+class WorkspaceResource(CoreResource):
+    """API Access class for workspace"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            server_version=server_version,
+        )
+
+    def get(self, workspace_id: str) -> Workspace:
+        metrics.track(metrics.SDK, self.account, {"name": "Workspace Get"})
+        return super().get(workspace_id)
+
+    def get_projects(
+        self,
+        workspace_id: str,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[WorksaceProjectsFilter] = None,
+    ) -> ResourceCollection[Project]:
+        metrics.track(metrics.SDK, self.account, {"name": "Workspace Get Projects"})
+        return super().get_projects(workspace_id, limit, cursor, filter)

src/specklepy/core/api/client.py

@@ -18,6 +18,7 @@ from specklepy.core.api.resources import (
     ServerResource,
     SubscriptionResource,
     VersionResource,
+    WorkspaceResource,
 )
 from specklepy.logging import metrics
 from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
@@ -223,6 +224,12 @@ class SpeckleClient:
             client=self.httpclient,
             server_version=server_version,
         )
+        self.workspace = WorkspaceResource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
         self.subscription = SubscriptionResource(
             account=self.account,
             basepath=self.ws_url,

src/specklepy/core/api/inputs/project_inputs.py

@@ -10,6 +10,13 @@ class ProjectCreateInput(GraphQLBaseModel):
     visibility: Optional[ProjectVisibility]
 
 
+class WorkspaceProjectCreateInput(GraphQLBaseModel):
+    name: Optional[str]
+    description: Optional[str]
+    visibility: Optional[ProjectVisibility]
+    workspaceId: str
+
+
 class ProjectInviteCreateInput(GraphQLBaseModel):
     email: Optional[str]
     role: Optional[str]
@@ -44,3 +51,12 @@ class ProjectUpdateRoleInput(GraphQLBaseModel):
     user_id: str
     project_id: str
     role: Optional[str]
+
+
+class WorksaceProjectsFilter(GraphQLBaseModel):
+    search: Optional[str]
+    """Filter out projects by name"""
+    with_project_role_only: Optional[bool]
+    """
+    Only return workspace projects that the active user has an explicit project role in
+    """

src/specklepy/core/api/inputs/user_inputs.py

@@ -11,5 +11,12 @@ class UserUpdateInput(GraphQLBaseModel):
 
 
 class UserProjectsFilter(GraphQLBaseModel):
-    search: str
+    search: Optional[str] = None
     only_with_roles: Optional[Sequence[str]] = None
+    workspace_id: Optional[str] = None
+    personal_only: Optional[bool] = None
+    include_implicit_access: Optional[bool] = None
+
+
+class UserWorkspacesFilter(GraphQLBaseModel):
+    search: Optional[str]

src/specklepy/core/api/models/current.py

@@ -3,6 +3,7 @@ from typing import Generic, List, Optional, TypeVar
 
 from specklepy.core.api.enums import ProjectVisibility
 from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
+from specklepy.logging.exceptions import WorkspacePermissionException
 
 T = TypeVar("T")
 
@@ -52,6 +53,10 @@ class ServerConfiguration(GraphQLBaseModel):
     object_size_limit_bytes: int
 
 
+class ServerWorkspacesInfo(GraphQLBaseModel):
+    workspaces_enabled: bool
+
+
 # Keeping this one all Optionals at the minute,
 #  because its used both as a deserialization model for GQL and Account Management
 class ServerInfo(GraphQLBaseModel):
@@ -61,13 +66,11 @@ class ServerInfo(GraphQLBaseModel):
     admin_contact: Optional[str] = None
     description: Optional[str] = None
     canonical_url: Optional[str] = None
-    roles: Optional[List[dict]] = None
     scopes: Optional[List[dict]] = None
     auth_strategies: Optional[List[dict]] = None
     version: Optional[str] = None
-    frontend2: Optional[bool] = None
     migration: Optional[ServerMigration] = None
-
+    workspaces: Optional[ServerWorkspacesInfo] = None
     # TODO separate gql model from account management model
 
 
@@ -129,7 +132,8 @@ class Version(GraphQLBaseModel):
     id: str
     message: Optional[str]
     preview_url: str
-    referenced_object: str
+    referenced_object: Optional[str]
+    """Maybe null if workspaces version history limit has been exceeded"""
     source_application: Optional[str]
 
 
@@ -148,6 +152,13 @@ class ModelWithVersions(Model):
     versions: ResourceCollection[Version]
 
 
+class ProjectPermissionChecks(GraphQLBaseModel):
+    can_create_model: "PermissionCheckResult"
+    can_delete: "PermissionCheckResult"
+    can_load: "PermissionCheckResult"
+    can_publish: "PermissionCheckResult"
+
+
 class Project(GraphQLBaseModel):
     allow_public_comments: bool
     created_at: datetime
@@ -177,3 +188,36 @@ class ProjectCommentCollection(ResourceCollection[T], Generic[T]):
 class UserSearchResultCollection(GraphQLBaseModel):
     items: List[LimitedUser]
     cursor: Optional[str] = None
+
+
+class PermissionCheckResult(GraphQLBaseModel):
+    authorized: bool
+    code: str
+    message: str
+
+    def ensure_authorised(self) -> None:
+        """Raises WorkspacePermissionException if not authorized"""
+        if not self.authorized:
+            raise WorkspacePermissionException(self.message)
+
+
+class WorkspacePermissionChecks(GraphQLBaseModel):
+    can_create_project: PermissionCheckResult
+
+
+class WorkspaceCreationState(GraphQLBaseModel):
+    completed: bool
+
+
+class Workspace(GraphQLBaseModel):
+    id: str
+    name: str
+    role: Optional[str]
+    slug: str
+    logo: Optional[str]
+    created_at: datetime
+    updated_at: datetime
+    read_only: bool
+    description: Optional[str]
+    creation_state: Optional[WorkspaceCreationState]
+    permissions: WorkspacePermissionChecks

src/specklepy/core/api/resources/__init__.py

@@ -10,6 +10,7 @@ from specklepy.core.api.resources.current.subscription_resource import (
     SubscriptionResource,
 )
 from specklepy.core.api.resources.current.version_resource import VersionResource
+from specklepy.core.api.resources.current.workspace_resource import WorkspaceResource
 
 __all__ = [
     "ActiveUserResource",
@@ -20,4 +21,5 @@ __all__ = [
     "ServerResource",
     "SubscriptionResource",
     "VersionResource",
+    "WorkspaceResource",
 ]

src/specklepy/core/api/resources/current/active_user_resource.py

@@ -2,13 +2,18 @@ from typing import List, Optional
 
 from gql import gql
 
-from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
+from specklepy.core.api.inputs.user_inputs import (
+    UserProjectsFilter,
+    UserUpdateInput,
+    UserWorkspacesFilter,
+)
 from specklepy.core.api.models import (
     PendingStreamCollaborator,
     Project,
     ResourceCollection,
     User,
 )
+from specklepy.core.api.models.current import PermissionCheckResult, Workspace
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse
 from specklepy.logging.exceptions import GraphQLException
@@ -190,3 +195,146 @@ class ActiveUserResource(ResourceBase):
             )
 
         return response.data.data
+
+    def can_create_personal_projects(self) -> PermissionCheckResult:
+        QUERY = gql(
+            """
+            query CanCreatePersonalProject {
+              data:activeUser {
+                data:permissions {
+                  data:canCreatePersonalProject {
+                    authorized
+                    code
+                    message
+                  }
+                }
+              }
+            }
+            """
+        )
+
+        response = self.make_request_and_parse_response(
+            DataResponse[Optional[DataResponse[DataResponse[PermissionCheckResult]]]],
+            QUERY,
+        )
+
+        if response.data is None:
+            raise GraphQLException(
+                "GraphQL response indicated that the ActiveUser could not be found"
+            )
+
+        return response.data.data.data
+
+    def get_workspaces(
+        self,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[UserWorkspacesFilter] = None,
+    ) -> ResourceCollection[Workspace]:
+        """
+        This feature is only available on Workspace enabled servers  (server versions
+        >=2.23.17) e.g. app.speckle.systems
+        """
+        QUERY = gql(
+            """
+            query ActiveUser($limit: Int!, $cursor: String, $filter: UserWorkspacesFilter) {
+              data:activeUser {
+                data:workspaces(limit: $limit, cursor: $cursor, filter: $filter) {
+                  cursor
+                  totalCount
+                  items {
+                    id
+                    name
+                    role
+                    slug
+                    logo
+                    createdAt
+                    updatedAt
+                    readOnly
+                    description
+                    creationState
+                    {
+                      completed
+                    }
+                    permissions {
+                      canCreateProject {
+                        authorized
+                        code
+                        message
+                      }
+                    }
+                  }
+                }
+              }
+            }
+            """  # noqa: E501
+        )
+
+        variables = {
+            "limit": limit,
+            "cursor": cursor,
+            "filter": filter.model_dump(warnings="error", by_alias=True)
+            if filter
+            else None,
+        }
+
+        response = self.make_request_and_parse_response(
+            DataResponse[Optional[DataResponse[ResourceCollection[Workspace]]]],
+            QUERY,
+            variables,
+        )
+
+        if response.data is None:
+            raise GraphQLException(
+                "GraphQL response indicated that the ActiveUser could not be found"
+            )
+
+        return response.data.data
+
+    def get_active_workspace(self) -> Optional[Workspace]:
+        """
+        This feature is only available on Workspace enabled servers  (server versions
+        >=2.23.17) e.g. app.speckle.systems
+        """
+        QUERY = gql(
+            """
+            query ActiveUser {
+              data:activeUser {
+                data:activeWorkspace {
+                  id
+                  name
+                  role
+                  slug
+                  logo
+                  createdAt
+                  updatedAt
+                  readOnly
+                  description
+                  creationState
+                  {
+                    completed
+                  }
+                  permissions {
+                    canCreateProject {
+                      authorized
+                      code
+                      message
+                    }
+                  }
+                }
+              }
+            }
+            """  # noqa: E501
+        )
+
+        response = self.make_request_and_parse_response(
+            DataResponse[Optional[DataResponse[Optional[Workspace]]]],
+            QUERY,
+        )
+
+        if response.data is None:
+            raise GraphQLException(
+                "GraphQL response indicated that the ActiveUser could not be found"
+            )
+
+        return response.data.data

src/specklepy/core/api/resources/current/project_resource.py

@@ -7,8 +7,10 @@ from specklepy.core.api.inputs.project_inputs import (
     ProjectModelsFilter,
     ProjectUpdateInput,
     ProjectUpdateRoleInput,
+    WorkspaceProjectCreateInput,
 )
 from specklepy.core.api.models import Project, ProjectWithModels, ProjectWithTeam
+from specklepy.core.api.models.current import ProjectPermissionChecks
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse
 
@@ -55,6 +57,46 @@ class ProjectResource(ResourceBase):
             DataResponse[Project], QUERY, variables
         ).data
 
+    def get_permissions(self, project_id: str) -> ProjectPermissionChecks:
+        QUERY = gql(
+            """
+            query Project($projectId: String!) {
+              data:project(id: $projectId) {
+                data:permissions {
+                  canCreateModel {
+                    authorized
+                    code
+                    message
+                  }
+                  canDelete {
+                    authorized
+                    code
+                    message
+                  }
+                  canLoad {
+                    authorized
+                    code
+                    message
+                  }
+                  canPublish {
+                    authorized
+                    code
+                    message
+                  }
+                }
+              }
+            }
+            """
+        )
+
+        variables = {
+            "projectId": project_id,
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[ProjectPermissionChecks]], QUERY, variables
+        ).data.data
+
     def get_with_models(
         self,
         project_id: str,
@@ -198,6 +240,12 @@ class ProjectResource(ResourceBase):
         ).data
 
     def create(self, input: ProjectCreateInput) -> Project:
+        """
+        Creates a non-workspace project (aka Personal Project)
+
+        see client.active_user.can_create_personal_projects to see if the user has
+        permission
+        """
         QUERY = gql(
             """
             mutation ProjectCreate($input: ProjectCreateInput) {
@@ -227,6 +275,45 @@ class ProjectResource(ResourceBase):
             DataResponse[DataResponse[Project]], QUERY, variables
         ).data.data
 
+    def create_in_workspace(self, input: WorkspaceProjectCreateInput) -> Project:
+        """
+        Creates a workspace project
+        This feature is only supported by Workspace Enabled Servers
+        (e.g. app.speckle.systems)
+
+        see `workspace.permissions.can_create_project` to see if the user has permission
+        """
+        QUERY = gql(
+            """
+          mutation WorkspaceProjectCreate($input: WorkspaceProjectCreateInput!) {
+            data:workspaceMutations {
+              data:projects {
+                data:create(input: $input) {
+                  id
+                  name
+                  description
+                  visibility
+                  allowPublicComments
+                  role
+                  createdAt
+                  updatedAt
+                  sourceApps
+                  workspaceId
+                }
+              }
+            }
+          }
+          """
+        )
+
+        variables = {
+            "input": input.model_dump(warnings="error", by_alias=True),
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[DataResponse[Project]]], QUERY, variables
+        ).data.data.data
+
     def update(self, input: ProjectUpdateInput) -> Project:
         QUERY = gql(
             """

src/specklepy/core/api/resources/current/server_resource.py

@@ -1,7 +1,6 @@
 import re
 from typing import Any, Dict, List, Tuple
 
-import requests
 from gql import gql
 
 from specklepy.core.api.models import ServerInfo
@@ -38,11 +37,6 @@ class ServerResource(ResourceBase):
                     adminContact
                     canonicalUrl
                     version
-                    roles {
-                        name
-                        description
-                        resourceTarget
-                    }
                     scopes {
                         name
                         description
@@ -52,6 +46,9 @@ class ServerResource(ResourceBase):
                         name
                         icon
                     }
+                    workspaces {
+                      workspacesEnabled
+                    }
                 }
             }
             """
@@ -60,16 +57,6 @@ class ServerResource(ResourceBase):
         server_info = self.make_request(
             query=query, return_type="serverInfo", schema=ServerInfo
         )
-        if isinstance(server_info, ServerInfo) and isinstance(
-            server_info.canonical_url, str
-        ):
-            r = requests.get(
-                server_info.canonical_url, headers={"User-Agent": "specklepy SDK"}
-            )
-            if "x-speckle-frontend-2" in r.headers:
-                server_info.frontend2 = True
-            else:
-                server_info.frontend2 = False
 
         return server_info
 

src/specklepy/core/api/resources/current/workspace_resource.py

@@ -0,0 +1,106 @@
+from typing import Optional
+
+from gql import gql
+
+from specklepy.core.api.inputs.project_inputs import WorksaceProjectsFilter
+from specklepy.core.api.models.current import Project, ResourceCollection, Workspace
+from specklepy.core.api.resource import ResourceBase
+from specklepy.core.api.responses import DataResponse
+
+NAME = "workspace"
+
+
+class WorkspaceResource(ResourceBase):
+    """API Access class for models"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            server_version=server_version,
+        )
+
+    def get(self, workspace_id: str) -> Workspace:
+        QUERY = gql(
+            """
+            query WorkspaceGet($workspaceId: String!) {
+              data:workspace(id: $workspaceId) {
+                id
+                name
+                role
+                slug
+                logo
+                createdAt
+                updatedAt
+                readOnly
+                description
+                creationState
+                {
+                  completed
+                }
+                permissions {
+                  canCreateProject {
+                    authorized
+                    code
+                    message
+                  }
+                }
+              }
+            }
+            """
+        )
+
+        variables = {
+            "workspaceId": workspace_id,
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[Workspace], QUERY, variables
+        ).data
+
+    def get_projects(
+        self,
+        workspace_id: str,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[WorksaceProjectsFilter] = None,
+    ) -> ResourceCollection[Project]:
+        QUERY = gql(
+            """
+            query Workspace($workspaceId: String!, $limit: Int!, $cursor: String, $filter: WorkspaceProjectsFilter) {
+              data:workspace(id: $workspaceId) {
+                data:projects(limit: $limit, cursor: $cursor, filter: $filter) {
+                  cursor
+                  items {
+                    allowPublicComments
+                    createdAt
+                    description
+                    id
+                    name
+                    role
+                    sourceApps
+                    updatedAt
+                    visibility
+                    workspaceId
+                  }
+                  totalCount
+                }
+              }
+            }
+            """  # noqa: E501
+        )
+
+        variables = {
+            "workspaceId": workspace_id,
+            "limit": limit,
+            "cursor": cursor,
+            "filter": filter.model_dump(warnings="error", by_alias=True)
+            if filter
+            else None,
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[ResourceCollection[Project]]], QUERY, variables
+        ).data.data

src/specklepy/logging/exceptions.py

@@ -58,3 +58,8 @@ class UnsupportedException(SpeckleException):
 class SpeckleWarning(Warning):
     def __init__(self, *args: object) -> None:
         super().__init__(*args)
+
+
+class WorkspacePermissionException(SpeckleException):
+    def __init__(self, message: str) -> None:
+        super().__init__(message=message)

src/specklepy/objects/annotation/__init__.py

@@ -0,0 +1,8 @@
+from .text import AlignmentHorizontal, AlignmentVertical, Text
+
+# re-export them at the geometry package level
+__all__ = [
+    "Text",
+    "AlignmentHorizontal",
+    "AlignmentVertical",
+]

src/specklepy/objects/annotation/text.py

@@ -0,0 +1,54 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Optional
+
+from specklepy.objects.base import Base
+from specklepy.objects.geometry import Plane, Point
+from specklepy.objects.interfaces import IHasUnits
+
+
+class AlignmentHorizontal(Enum):
+    Left = 0
+    Center = 1
+    Right = 2
+
+
+class AlignmentVertical(Enum):
+    Top = 0
+    Center = 1
+    Bottom = 2
+
+
+@dataclass(kw_only=True)
+class Text(Base, IHasUnits, speckle_type="Objects.Annotation.Text"):
+    """
+    Text class for representation in the viewer.
+    Units will be 'Units.None' if the text size is defined in pixels.
+    """
+
+    value: str  # Plain text, without formatting
+    origin: Point  # Relation to the text is defined by AlignmentH and AlignmentV
+    height: float  # Font height in linear units or pixels (if Units.None)
+    alignmentH: AlignmentHorizontal = field(
+        default_factory=lambda: AlignmentHorizontal.Left
+    )
+    alignmentV: AlignmentVertical = field(default_factory=lambda: AlignmentVertical.Top)
+    plane: Optional[Plane] = field(
+        default_factory=lambda: None
+    )  # None if the text object orientation follows camera view
+    maxWidth: Optional[float] = field(
+        default_factory=lambda: None
+    )  # Maximum width of the text field. None, if don't split into lines
+
+    def __repr__(self) -> str:
+        return (
+            f"{self.__class__.__name__}("
+            f"value: {self.value}, "
+            f"origin: {self.origin}, "
+            f"height: {self.height}, "
+            f"alignmentH: {self.alignmentH}, "
+            f"alignmentV: {self.alignmentV}, "
+            f"plane: {self.plane}, "
+            f"maxWidth: {self.maxWidth}, "
+            f"units: {self.units})"
+        )

src/specklepy/objects/geometry/mesh.py

@@ -13,12 +13,13 @@ class Mesh(
     IHasVolume,
     IHasUnits,
     speckle_type="Objects.Geometry.Mesh",
-    detachable={"vertices", "faces", "colors", "textureCoordinates"},
+    detachable={"vertices", "faces", "colors", "textureCoordinates", "vertexNormals"},
     chunkable={
         "vertices": 31250,
         "faces": 62500,
         "colors": 62500,
         "textureCoordinates": 31250,
+        "vertexNormals": 31250,
     },
     serialize_ignore={"vertices_count", "texture_coordinates_count"},
 ):
@@ -31,6 +32,7 @@ class Mesh(
     faces: List[int]
     colors: List[int] = field(default_factory=list)
     textureCoordinates: List[float] = field(default_factory=list)
+    vertexNormals: List[float] = field(default_factory=list)
 
     def __repr__(self) -> str:
         return (

src/specklepy/objects/geometry/region.py

@@ -47,7 +47,6 @@ class Region(
 
     @property
     def displayValue(self) -> List[Mesh]:
-        print(self._displayValue)
         return self._displayValue
 
     @displayValue.setter

tests/integration/client/current/test_active_user_resource.py

@@ -4,6 +4,7 @@ from specklepy.api.client import SpeckleClient
 from specklepy.core.api.inputs.project_inputs import ProjectCreateInput
 from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
 from specklepy.core.api.models import ResourceCollection, User
+from specklepy.logging.exceptions import GraphQLException
 
 
 @pytest.mark.run()
@@ -61,3 +62,24 @@ class TestActiveUserResource:
         assert len(res.items) == 1
         assert res.total_count == 1
         assert res.items[0].id == p1.id
+
+    def test_can_create_personal_projects(self, client: SpeckleClient):
+        res = client.active_user.can_create_personal_projects()
+        res.ensure_authorised()
+
+        assert res.authorized is True
+
+    def test_get_workspaces(self, client: SpeckleClient):
+        """
+        Test server is not workspace enabled, so we can't really test everything here
+        We'll just test client's error handling
+        """
+        with pytest.raises(GraphQLException):
+            _ = client.active_user.get_workspaces()
+
+    def test_get_active_workspace(self, client: SpeckleClient):
+        """
+        Test server is not workspace enabled, so we can't really test everything here
+        """
+        res = client.active_user.get_active_workspace()
+        assert res is None

tests/integration/client/current/test_project_resource.py

@@ -7,6 +7,7 @@ from specklepy.core.api.inputs.project_inputs import (
     ProjectUpdateInput,
 )
 from specklepy.core.api.models import Project
+from specklepy.core.api.models.current import ProjectPermissionChecks
 from specklepy.logging.exceptions import GraphQLException
 
 
@@ -65,6 +66,15 @@ class TestProjectResource:
         assert result.visibility == test_project.visibility
         assert result.created_at == test_project.created_at
 
+    def test_project_get_permissions(
+        self, client: SpeckleClient, test_project: Project
+    ):
+        result = client.project.get_permissions(test_project.id)
+
+        assert isinstance(result, ProjectPermissionChecks)
+        assert result.can_create_model.authorized is True
+        assert result.can_delete.authorized is True
+
     def test_project_update(self, client: SpeckleClient, test_project: Project):
         new_name = "MY new name"
         new_description = "MY new desc"

tests/integration/client/current/test_workspace_resource.py

@@ -0,0 +1,23 @@
+import pytest
+
+from specklepy.api.client import SpeckleClient
+from specklepy.logging.exceptions import GraphQLException
+
+
+@pytest.mark.run()
+class TestWorkspaceResource:
+    def test_get_workspace(self, client: SpeckleClient):
+        """
+        Test server is not workspace enabled, so we can't really test everything here
+        We'll just test client's error handling
+        """
+        with pytest.raises(GraphQLException):
+            client.workspace.get("not a real id")
+
+    def test_get_projects(self, client: SpeckleClient):
+        """
+        Test server is not workspace enabled, so we can't really test everything here
+        We'll just test client's error handling
+        """
+        with pytest.raises(GraphQLException):
+            client.workspace.get_projects("not a real id")

tests/objects/test_arc.py

@@ -151,6 +151,7 @@ def test_arc_serialization(sample_arc):
     serialized = serialize(sample_arc)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Arc)
     assert deserialized.startPoint.x == sample_arc.startPoint.x
     assert deserialized.startPoint.y == sample_arc.startPoint.y
     assert deserialized.startPoint.z == sample_arc.startPoint.z

tests/objects/test_box.py

@@ -116,6 +116,7 @@ def test_box_serialization(sample_box):
     serialized = serialize(sample_box)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Box)
     assert deserialized.basePlane.origin.x == sample_box.basePlane.origin.x
     assert deserialized.basePlane.origin.y == sample_box.basePlane.origin.y
     assert deserialized.basePlane.origin.z == sample_box.basePlane.origin.z

tests/objects/test_circle.py

@@ -107,6 +107,7 @@ def test_circle_serialization(sample_circle):
     serialized = serialize(sample_circle)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Circle)
     assert deserialized.plane.origin.x == sample_circle.plane.origin.x
     assert deserialized.plane.origin.y == sample_circle.plane.origin.y
     assert deserialized.plane.origin.z == sample_circle.plane.origin.z

tests/objects/test_control_point.py

@@ -70,6 +70,7 @@ def test_control_point_serialization(sample_control_point):
     serialized = serialize(sample_control_point)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, ControlPoint)
     assert deserialized.x == sample_control_point.x
     assert deserialized.y == sample_control_point.y
     assert deserialized.z == sample_control_point.z

tests/objects/test_curve.py

@@ -125,6 +125,7 @@ def test_curve_serialization(sample_curve):
     serialized = serialize(sample_curve)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Curve)
     assert deserialized.degree == sample_curve.degree
     assert deserialized.periodic == sample_curve.periodic
     assert deserialized.rational == sample_curve.rational

tests/objects/test_ellipse.py

@@ -104,6 +104,7 @@ def test_ellipse_serialization(sample_ellipse):
     serialized = serialize(sample_ellipse)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Ellipse)
     assert deserialized.plane.origin.x == sample_ellipse.plane.origin.x
     assert deserialized.plane.origin.y == sample_ellipse.plane.origin.y
     assert deserialized.plane.origin.z == sample_ellipse.plane.origin.z

tests/objects/test_line.py

@@ -83,6 +83,7 @@ def test_line_serialization(sample_line):
     serialized = serialize(sample_line)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Line)
     assert deserialized.start.x == sample_line.start.x
     assert deserialized.start.y == sample_line.start.y
     assert deserialized.start.z == sample_line.start.z

tests/objects/test_mesh.py

@@ -155,6 +155,7 @@ def test_mesh_creation(cube_vertices, cube_faces):
     assert mesh.faces == cube_faces
     assert mesh.colors == []
     assert mesh.textureCoordinates == []
+    assert mesh.vertexNormals == []
     assert mesh.units == Units.m.value
 
 
@@ -239,6 +240,7 @@ def test_mesh_serialization(full_mesh):
     serialized = serialize(full_mesh)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Mesh)
     assert deserialized.vertices == full_mesh.vertices
     assert deserialized.faces == full_mesh.faces
     assert deserialized.colors == full_mesh.colors

tests/objects/test_plane.py

@@ -111,6 +111,7 @@ def test_spiral_serialization(sample_spiral: Spiral):
     serialized = serialize(sample_spiral)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Spiral)
     assert deserialized.start_point.x == sample_spiral.start_point.x
     assert deserialized.start_point.y == sample_spiral.start_point.y
     assert deserialized.start_point.z == sample_spiral.start_point.z

tests/objects/test_point.py

@@ -30,6 +30,7 @@ def test_point_serialization():
     serialized = serialize(p1)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Point)
     assert deserialized.x == p1.x
     assert deserialized.y == p1.y
     assert deserialized.z == p1.z

tests/objects/test_point_cloud.py

@@ -47,6 +47,7 @@ def test_point_cloud_serialization(sample_point_cloud):
     serialized = serialize(sample_point_cloud)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, PointCloud)
     assert len(deserialized.points) == len(sample_point_cloud.points)
 
     for orig_point, deserial_point in zip(

tests/objects/test_polycurve.py

@@ -86,15 +86,21 @@ def test_polycurve_serialization(sample_polycurve: Polycurve):
     serialized = serialize(sample_polycurve)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Polycurve)
     assert len(deserialized.segments) == len(sample_polycurve.segments)
     assert deserialized.units == sample_polycurve.units
 
-    assert deserialized.segments[0].start.x == sample_polycurve.segments[0].start.x
-    assert deserialized.segments[0].start.y == sample_polycurve.segments[0].start.y
-    assert deserialized.segments[0].start.z == sample_polycurve.segments[0].start.z
-    assert deserialized.segments[0].end.x == sample_polycurve.segments[0].end.x
-    assert deserialized.segments[0].end.y == sample_polycurve.segments[0].end.y
-    assert deserialized.segments[0].end.z == sample_polycurve.segments[0].end.z
+    expectedSegment = sample_polycurve.segments[0]
+    segment = deserialized.segments[0]
+    assert isinstance(expectedSegment, Line)
+    assert isinstance(segment, Line)
+
+    assert segment.start.x == expectedSegment.start.x
+    assert segment.start.y == expectedSegment.start.y
+    assert segment.start.z == expectedSegment.start.z
+    assert segment.end.x == expectedSegment.end.x
+    assert segment.end.y == expectedSegment.end.y
+    assert segment.end.z == expectedSegment.end.z
 
 
 def test_polycurve_empty():

tests/objects/test_polyline.py

@@ -134,6 +134,7 @@ def test_polyline_serialization(sample_polyline):
     serialized = serialize(sample_polyline)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Polyline)
     assert deserialized.value == sample_polyline.value
     assert deserialized.units == sample_polyline.units
     assert deserialized.domain.start == sample_polyline.domain.start

tests/objects/test_region.py

@@ -69,6 +69,7 @@ def test_region_serialization(sample_region):
     serialized = serialize(sample_region)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Region)
     assert deserialized.hasHatchPattern == sample_region.hasHatchPattern
     assert deserialized.units == sample_region.units
 

tests/objects/test_spiral.py

@@ -113,6 +113,7 @@ def test_spiral_serialization(sample_spiral: Spiral):
     serialized = serialize(sample_spiral)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Spiral)
     assert deserialized.start_point.x == sample_spiral.start_point.x
     assert deserialized.start_point.y == sample_spiral.start_point.y
     assert deserialized.start_point.z == sample_spiral.start_point.z

tests/objects/test_surface.py

@@ -140,6 +140,7 @@ def test_surface_serialization(sample_surface: Surface):
     serialized = serialize(sample_surface)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Surface)
     assert deserialized.degreeU == sample_surface.degreeU
     assert deserialized.degreeV == sample_surface.degreeV
     assert deserialized.rational == sample_surface.rational

tests/objects/test_text.py

@@ -0,0 +1,100 @@
+import pytest
+
+from specklepy.core.api.operations import deserialize, serialize
+from specklepy.objects.annotation import AlignmentHorizontal, AlignmentVertical, Text
+from specklepy.objects.geometry import Plane, Point, Vector
+from specklepy.objects.models.units import Units
+
+
+@pytest.fixture
+def sample_point() -> Point:
+    return Point(x=0.0, y=0.0, z=0.0, units=Units.m)
+
+
+@pytest.fixture
+def sample_plane(sample_point: Point) -> Plane:
+    normal = Vector(x=0.0, y=0.0, z=1.0, units=Units.m)
+    xdir = Vector(x=1.0, y=0.0, z=0.0, units=Units.m)
+    ydir = Vector(x=0.0, y=1.0, z=0.0, units=Units.m)
+    return Plane(
+        origin=sample_point, normal=normal, xdir=xdir, ydir=ydir, units=Units.m
+    )
+
+
+@pytest.fixture
+def sample_text(sample_point: Point) -> Text:
+    return Text(value="text", origin=sample_point, height=0.5, units=Units.m)
+
+
+@pytest.fixture
+def sample_text_all_properties(sample_point: Point, sample_plane: Plane) -> Text:
+    return Text(
+        value="text",
+        origin=sample_point,
+        height=0.5,
+        alignmentH=AlignmentHorizontal.Center,
+        alignmentV=AlignmentVertical.Center,
+        plane=sample_plane,
+        maxWidth=20,
+        units=Units.m,
+    )
+
+
+def test_text_creation_minimal(sample_point: Point):
+    text_value = "text"
+
+    text_obj = Text(value=text_value, origin=sample_point, height=0.5, units=Units.m)
+    assert text_obj.value == text_value
+    assert text_obj.origin == sample_point
+    assert text_obj.height == 0.5
+    assert text_obj.alignmentH == AlignmentHorizontal.Left
+    assert text_obj.alignmentV == AlignmentVertical.Top
+    assert text_obj.plane is None
+    assert text_obj.maxWidth is None
+    assert text_obj.units == Units.m.value
+
+
+def test_text_creation_extended(sample_point: Point, sample_plane: Plane):
+    text_value = "text"
+    max_width = 20
+
+    text_obj = Text(
+        value=text_value,
+        origin=sample_point,
+        height=0.5,
+        alignmentH=AlignmentHorizontal.Center,
+        alignmentV=AlignmentVertical.Center,
+        plane=sample_plane,
+        maxWidth=max_width,
+        units=Units.m,
+    )
+    assert text_obj.value == text_value
+    assert text_obj.origin == sample_point
+    assert text_obj.height == 0.5
+    assert text_obj.alignmentH == AlignmentHorizontal.Center
+    assert text_obj.alignmentV == AlignmentVertical.Center
+    assert text_obj.plane == sample_plane
+    assert text_obj.maxWidth == max_width
+    assert text_obj.units == Units.m.value
+
+
+def test_point_serialization(sample_text_all_properties: Text):
+    serialized = serialize(sample_text_all_properties)
+    deserialized = deserialize(serialized)
+
+    assert isinstance(deserialized, Text)
+    assert deserialized.value == sample_text_all_properties.value
+    assert deserialized.origin.x == sample_text_all_properties.origin.x
+    assert deserialized.origin.y == sample_text_all_properties.origin.y
+    assert deserialized.origin.z == sample_text_all_properties.origin.z
+    assert deserialized.height == sample_text_all_properties.height
+    assert deserialized.alignmentH == sample_text_all_properties.alignmentH
+    assert deserialized.alignmentV == sample_text_all_properties.alignmentV
+    assert deserialized.plane.origin.x == sample_text_all_properties.plane.origin.x
+    assert deserialized.plane.origin.y == sample_text_all_properties.plane.origin.y
+    assert deserialized.plane.origin.z == sample_text_all_properties.plane.origin.z
+    assert deserialized.plane.normal.x == sample_text_all_properties.plane.normal.x
+    assert deserialized.plane.normal.y == sample_text_all_properties.plane.normal.y
+    assert deserialized.plane.normal.z == sample_text_all_properties.plane.normal.z
+    assert deserialized.maxWidth == sample_text_all_properties.maxWidth
+    assert deserialized.units == sample_text_all_properties.units

tests/objects/test_vector.py

@@ -36,6 +36,7 @@ def test_vector_serialization():
     serialized = serialize(v)
     deserialized = deserialize(serialized)
 
+    assert isinstance(deserialized, Vector)
     assert deserialized.x == v.x
     assert deserialized.y == v.y
     assert deserialized.z == v.z