feat(workspaces): toggle embedded viewer branding (#4762)

* feat(viewer): embedded viewer option to hide speckle branding

* chore(viewer): can edit embed options policy

* chore(embeds): tests for new policy and gql

packages/server/modules/workspaces/tests/integration/workspaces.graph.spec.ts

@@ -30,7 +30,10 @@ import {
   CreateWorkspaceProjectDocument,
   DismissWorkspaceDocument,
   GetActiveUserDiscoverableWorkspacesDocument,
-  GetWorkspaceWithMembersByRoleDocument
+  GetWorkspaceWithMembersByRoleDocument,
+  UpdateEmbedOptionsDocument,
+  WorkspaceEmbedOptionsDocument,
+  ProjectEmbedOptionsDocument
 } from '@/test/graphql/generated/graphql'
 import { beforeEachContext } from '@/test/hooks'
 import { AllScopes } from '@/modules/core/helpers/mainConstants'
@@ -1359,5 +1362,72 @@ describe('Workspaces GQL CRUD', () => {
         ).to.false
       })
     })
+
+    describe('mutation workspaceMutations.updateEmbedOptions', () => {
+      const workspace: BasicTestWorkspace = {
+        id: '',
+        ownerId: '',
+        slug: cryptoRandomString({ length: 10 }),
+        name: 'My Test Workspace'
+      }
+
+      const workspaceProject: BasicTestStream = {
+        id: '',
+        ownerId: '',
+        name: 'My Test Project',
+        isPublic: false
+      }
+
+      before(async () => {
+        await createTestWorkspace(workspace, testAdminUser, { addPlan: false })
+        workspaceProject.workspaceId = workspace.id
+        await createTestStream(workspaceProject, testAdminUser)
+      })
+
+      beforeEach(async () => {
+        await apollo.execute(UpdateEmbedOptionsDocument, {
+          input: {
+            workspaceId: workspace.id,
+            hideSpeckleBranding: false
+          }
+        })
+      })
+
+      it('should update options at workspace level', async () => {
+        const resA = await apollo.execute(UpdateEmbedOptionsDocument, {
+          input: {
+            workspaceId: workspace.id,
+            hideSpeckleBranding: true
+          }
+        })
+
+        expect(resA).to.not.haveGraphQLErrors()
+
+        const resB = await apollo.execute(WorkspaceEmbedOptionsDocument, {
+          workspaceId: workspace.id
+        })
+
+        expect(resB).to.not.haveGraphQLErrors()
+        expect(resB?.data?.workspace.embedOptions.hideSpeckleBranding).to.equal(true)
+      })
+
+      it('should update options at workspace project level', async () => {
+        const resA = await apollo.execute(UpdateEmbedOptionsDocument, {
+          input: {
+            workspaceId: workspace.id,
+            hideSpeckleBranding: true
+          }
+        })
+
+        expect(resA).to.not.haveGraphQLErrors()
+
+        const resB = await apollo.execute(ProjectEmbedOptionsDocument, {
+          projectId: workspaceProject.id
+        })
+
+        expect(resB).to.not.haveGraphQLErrors()
+        expect(resB.data?.project.embedOptions.hideSpeckleBranding).to.equal(true)
+      })
+    })
   })
 })

packages/server/modules/workspaces/tests/unit/services/management.spec.ts

@@ -260,6 +260,7 @@ describe('Workspace services', () => {
         logo: null,
         discoverabilityEnabled: false,
         domainBasedMembershipProtectionEnabled: false,
+        isEmbedSpeckleBrandingHidden: false,
         domains: []
       }
       return merge(workspace, input)
@@ -1139,7 +1140,8 @@ describe('Workspace role services', () => {
                   updatedAt: new Date(),
                   description: null,
                   discoverabilityEnabled: false,
-                  domainBasedMembershipProtectionEnabled: false
+                  domainBasedMembershipProtectionEnabled: false,
+                  isEmbedSpeckleBrandingHidden: false
                 }
               },
               getDomains: async () => {
@@ -1178,7 +1180,8 @@ describe('Workspace role services', () => {
           updatedAt: new Date(),
           description: null,
           discoverabilityEnabled: false,
-          domainBasedMembershipProtectionEnabled: false
+          domainBasedMembershipProtectionEnabled: false,
+          isEmbedSpeckleBrandingHidden: false
         }
 
         await addDomainToWorkspaceFactory({

packages/server/modules/workspaces/tests/unit/services/sso.spec.ts

@@ -383,6 +383,7 @@ describe('Workspace SSO services', () => {
               logo: null,
               domainBasedMembershipProtectionEnabled: false,
               discoverabilityEnabled: false,
+              isEmbedSpeckleBrandingHidden: false,
               createdAt: new Date(),
               updatedAt: new Date()
             }