feat(api): add project mutations to public api schema (#6786)

Author: n1ru4l

.changeset/lemon-lies-carry.md

@@ -0,0 +1,10 @@
+  ---
+'hive': major
+---
+
+Add mutation fields for managing projects to the public api schema.
+- `Mutation.createProject`
+- `Mutation.updateProjectSlug`
+- `Mutation.deleteProject`
+
+**BREAKING CHANGE**: This renames and changes the types for existing types within the private GraphQL schema.

integration-tests/testkit/flow.ts

@@ -378,11 +378,7 @@ export function updateProjectSlug(input: UpdateProjectSlugInput, authToken: stri
       mutation updateProjectSlug($input: UpdateProjectSlugInput!) {
         updateProjectSlug(input: $input) {
           ok {
-            selector {
-              organizationSlug
-              projectSlug
-            }
-            project {
+            updatedProject {
               id
               name
               slug

integration-tests/testkit/seed.ts

@@ -230,7 +230,11 @@ export function initSeed() {
             async createProject(projectType: ProjectType = ProjectType.Single) {
               const projectResult = await createProject(
                 {
-                  organizationSlug: organization.slug,
+                  organization: {
+                    bySelector: {
+                      organizationSlug: organization.slug,
+                    },
+                  },
                   type: projectType,
                   slug: generateUnique(),
                 },

integration-tests/tests/api/project/crud.spec.ts

@@ -38,17 +38,20 @@ test.concurrent(`changing a project's slug should result changing its name`, asy
 
   const renameResult = await updateProjectSlug(
     {
-      organizationSlug: organization.slug,
-      projectSlug: project.slug,
+      project: {
+        bySelector: {
+          organizationSlug: organization.slug,
+          projectSlug: project.slug,
+        },
+      },
       slug: 'bar',
     },
     ownerToken,
   ).then(r => r.expectNoGraphQLErrors());
 
   expect(renameResult.updateProjectSlug.error).toBeNull();
-  expect(renameResult.updateProjectSlug.ok?.project.name).toBe('bar');
-  expect(renameResult.updateProjectSlug.ok?.project.slug).toBe('bar');
-  expect(renameResult.updateProjectSlug.ok?.selector.projectSlug).toBe('bar');
+  expect(renameResult.updateProjectSlug.ok?.updatedProject.name).toBe('bar');
+  expect(renameResult.updateProjectSlug.ok?.updatedProject.slug).toBe('bar');
 });
 
 test.concurrent(
@@ -60,17 +63,20 @@ test.concurrent(
 
     const renameResult = await updateProjectSlug(
       {
-        organizationSlug: organization.slug,
-        projectSlug: project.slug,
+        project: {
+          bySelector: {
+            organizationSlug: organization.slug,
+            projectSlug: project.slug,
+          },
+        },
         slug: project.slug,
       },
       ownerToken,
     ).then(r => r.expectNoGraphQLErrors());
 
     expect(renameResult.updateProjectSlug.error).toBeNull();
-    expect(renameResult.updateProjectSlug.ok?.project.name).toBe(project.slug);
-    expect(renameResult.updateProjectSlug.ok?.project.slug).toBe(project.slug);
-    expect(renameResult.updateProjectSlug.ok?.selector.projectSlug).toBe(project.slug);
+    expect(renameResult.updateProjectSlug.ok?.updatedProject.name).toBe(project.slug);
+    expect(renameResult.updateProjectSlug.ok?.updatedProject.slug).toBe(project.slug);
   },
 );
 
@@ -84,8 +90,12 @@ test.concurrent(
 
     const renameResult = await updateProjectSlug(
       {
-        organizationSlug: organization.slug,
-        projectSlug: project.slug,
+        project: {
+          bySelector: {
+            organizationSlug: organization.slug,
+            projectSlug: project.slug,
+          },
+        },
         slug: project2.slug,
       },
       ownerToken,
@@ -116,24 +126,27 @@ test.concurrent(
   `changing a project's slug to a slug taken by another organization should be possible`,
   async ({ expect }) => {
     const { createOrg, ownerToken } = await initSeed().createOwner();
-    const { createProject, organization, projects } = await createOrg();
-    const { createProject: createProject2, organization: organization2 } = await createOrg();
+    const { createProject, organization } = await createOrg();
+    const { createProject: createProject2 } = await createOrg();
     const { project } = await createProject(ProjectType.Single);
     const { project: project2 } = await createProject2(ProjectType.Single);
 
     const renameResult = await updateProjectSlug(
       {
-        organizationSlug: organization.slug,
-        projectSlug: project.slug,
+        project: {
+          bySelector: {
+            organizationSlug: organization.slug,
+            projectSlug: project.slug,
+          },
+        },
         slug: project2.slug,
       },
       ownerToken,
     ).then(r => r.expectNoGraphQLErrors());
 
     expect(renameResult.updateProjectSlug.error).toBeNull();
-    expect(renameResult.updateProjectSlug.ok?.project.name).toBe(project2.slug);
-    expect(renameResult.updateProjectSlug.ok?.project.slug).toBe(project2.slug);
-    expect(renameResult.updateProjectSlug.ok?.selector.projectSlug).toBe(project2.slug);
+    expect(renameResult.updateProjectSlug.ok?.updatedProject.name).toBe(project2.slug);
+    expect(renameResult.updateProjectSlug.ok?.updatedProject.slug).toBe(project2.slug);
   },
 );
 
@@ -146,8 +159,12 @@ test.concurrent(
 
     const renameResult = await updateProjectSlug(
       {
-        organizationSlug: organization.slug,
-        projectSlug: project.slug,
+        project: {
+          bySelector: {
+            organizationSlug: organization.slug,
+            projectSlug: project.slug,
+          },
+        },
         slug: 'view',
       },
       ownerToken,
@@ -167,8 +184,12 @@ test.concurrent(
 
     const renameResult = await updateProjectSlug(
       {
-        organizationSlug: organization.slug,
-        projectSlug: project.slug,
+        project: {
+          bySelector: {
+            organizationSlug: organization.slug,
+            projectSlug: project.slug,
+          },
+        },
         slug: 'new',
       },
       ownerToken,
@@ -188,8 +209,12 @@ test.concurrent(
 
     const renameResult = await updateProjectSlug(
       {
-        organizationSlug: organization.slug,
-        projectSlug: project.slug,
+        project: {
+          bySelector: {
+            organizationSlug: organization.slug,
+            projectSlug: project.slug,
+          },
+        },
         slug: 'new',
       },
       ownerToken,

packages/services/api/src/modules/organization/lib/organization-access-token-permissions.ts

@@ -32,6 +32,18 @@ export const permissionGroups: Array<PermissionGroup> = [
         title: 'Describe project',
         description: 'Fetch information about the specified projects.',
       },
+      {
+        id: 'project:delete',
+        title: 'Delete project',
+        description: 'Delete projects.',
+        dependsOn: 'project:describe',
+      },
+      {
+        id: 'project:modifySettings',
+        title: 'Modify Settings',
+        description: 'Modify the project settings.',
+        dependsOn: 'project:describe',
+      },
     ],
   },
   {

packages/services/api/src/modules/project/module.graphql.ts

@@ -7,9 +7,13 @@ export default gql`
   }
 
   extend type Mutation {
-    createProject(input: CreateProjectInput!): CreateProjectResult!
-    updateProjectSlug(input: UpdateProjectSlugInput!): UpdateProjectSlugResult!
-    deleteProject(selector: ProjectSelectorInput!): DeleteProjectPayload!
+    createProject(input: CreateProjectInput! @tag(name: "public")): CreateProjectResult!
+      @tag(name: "public")
+    updateProjectSlug(
+      input: UpdateProjectSlugInput! @tag(name: "public")
+    ): UpdateProjectSlugResult! @tag(name: "public")
+    deleteProject(input: DeleteProjectInput! @tag(name: "public")): DeleteProjectResult!
+      @tag(name: "public")
   }
 
   type UpdateProjectGitRepositoryResult {
@@ -27,42 +31,41 @@ export default gql`
   }
 
   input UpdateProjectSlugInput {
-    slug: String!
-    organizationSlug: String!
-    projectSlug: String!
+    project: ProjectReferenceInput! @tag(name: "public")
+    slug: String! @tag(name: "public")
   }
 
   type UpdateProjectSlugResult {
-    ok: UpdateProjectSlugOk
-    error: UpdateProjectSlugError
+    ok: UpdateProjectSlugOk @tag(name: "public")
+    error: UpdateProjectSlugError @tag(name: "public")
   }
 
   type UpdateProjectSlugOk {
-    selector: ProjectSelector!
-    project: Project!
+    updatedProject: Project! @tag(name: "public")
   }
 
-  type UpdateProjectSlugError implements Error {
-    message: String!
+  type UpdateProjectSlugError {
+    message: String! @tag(name: "public")
   }
 
   type CreateProjectResult {
-    ok: CreateProjectOk
-    error: CreateProjectError
+    ok: CreateProjectResultOk @tag(name: "public")
+    error: CreateProjectResultError @tag(name: "public")
   }
-  type CreateProjectOk {
-    createdProject: Project!
+
+  type CreateProjectResultOk {
+    createdProject: Project! @tag(name: "public")
     createdTargets: [Target!]!
     updatedOrganization: Organization!
   }
 
   type CreateProjectInputErrors {
-    slug: String
+    slug: String @tag(name: "public")
   }
 
-  type CreateProjectError implements Error {
-    message: String!
-    inputErrors: CreateProjectInputErrors!
+  type CreateProjectResultError {
+    message: String! @tag(name: "public")
+    inputErrors: CreateProjectInputErrors! @tag(name: "public")
   }
 
   input ProjectSelectorInput {
@@ -125,9 +128,9 @@ export default gql`
   }
 
   input CreateProjectInput {
-    slug: String!
-    type: ProjectType!
-    organizationSlug: String!
+    organization: OrganizationReferenceInput! @tag(name: "public")
+    slug: String! @tag(name: "public")
+    type: ProjectType! @tag(name: "public")
   }
 
   input UpdateProjectGitRepositoryInput {
@@ -141,8 +144,20 @@ export default gql`
     updatedProject: Project!
   }
 
-  type DeleteProjectPayload {
-    selector: ProjectSelector!
-    deletedProject: Project!
+  input DeleteProjectInput {
+    project: ProjectReferenceInput! @tag(name: "public")
+  }
+
+  type DeleteProjectResult {
+    ok: DeleteProjectResultOk @tag(name: "public")
+    error: DeleteProjectResultError @tag(name: "public")
+  }
+
+  type DeleteProjectResultOk {
+    deletedProjectId: ID! @tag(name: "public")
+  }
+
+  type DeleteProjectResultError {
+    message: String! @tag(name: "public")
   }
 `;