@backstage/plugin-scaffolder-backend-module-gitlab 0.4.1-next.1 → 0.4.1-next.3

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-scaffolder-backend-module-gitlab
 
+## 0.4.1-next.3
+
+### Patch Changes
+
+- d44a20a: Added additional plugin metadata to `package.json`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.19-next.3
+  - @backstage/integration@1.12.0-next.1
+  - @backstage/plugin-scaffolder-node@0.4.5-next.3
+  - @backstage/backend-common@0.23.0-next.3
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+
+## 0.4.1-next.2
+
+### Patch Changes
+
+- cf96041: Added `gitlab:issue:edit` action to edit existing GitLab issues
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.19-next.2
+  - @backstage/backend-common@0.23.0-next.2
+  - @backstage/integration@1.12.0-next.0
+  - @backstage/plugin-scaffolder-node@0.4.5-next.2
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+
 ## 0.4.1-next.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -19,7 +19,7 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
 var path__default = /*#__PURE__*/_interopDefaultCompat(path);
 
-const examples$8 = [
+const examples$9 = [
   {
     description: "Initializes a git repository with the content in the workspace, and publishes it to GitLab with the default configuration.",
     example: yaml__default.default.stringify({
@@ -120,12 +120,12 @@ const examples$8 = [
               {
                 name: "dev",
                 create: true,
-                protected: true,
+                protect: true,
                 ref: "master"
               },
               {
                 name: "master",
-                protected: true
+                protect: true
               }
             ]
           }
@@ -169,7 +169,7 @@ function createPublishGitlabAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:gitlab",
     description: "Initializes a git repository of the content in the workspace, and publishes it to GitLab.",
-    examples: examples$8,
+    examples: examples$9,
     schema: {
       input: {
         type: "object",
@@ -537,6 +537,18 @@ const commonGitlabConfigExample = {
   repoUrl: "gitlab.com?owner=namespace-or-owner&repo=project-name",
   token: "${{ secrets.USER_OAUTH_TOKEN }}"
 };
+var IssueType = /* @__PURE__ */ ((IssueType2) => {
+  IssueType2["ISSUE"] = "issue";
+  IssueType2["INCIDENT"] = "incident";
+  IssueType2["TEST"] = "test_case";
+  IssueType2["TASK"] = "task";
+  return IssueType2;
+})(IssueType || {});
+var IssueStateEvent = /* @__PURE__ */ ((IssueStateEvent2) => {
+  IssueStateEvent2["CLOSE"] = "close";
+  IssueStateEvent2["REOPEN"] = "reopen";
+  return IssueStateEvent2;
+})(IssueStateEvent || {});
 
 const parseRepoHost = (repoUrl) => {
   let parsed;
@@ -654,7 +666,7 @@ async function checkEpicScope(client, projectId, epicId) {
   }
 }
 
-const examples$7 = [
+const examples$8 = [
   {
     description: "Creating a group at the top level",
     example: yaml__default.default.stringify({
@@ -728,7 +740,7 @@ const createGitlabGroupEnsureExistsAction = (options) => {
     id: "gitlab:group:ensureExists",
     description: "Ensures a Gitlab group exists",
     supportsDryRun: true,
-    examples: examples$7,
+    examples: examples$8,
     schema: {
       input: commonGitlabConfig.merge(
         zod.z.object({
@@ -783,7 +795,7 @@ const createGitlabGroupEnsureExistsAction = (options) => {
   });
 };
 
-const examples$6 = [
+const examples$7 = [
   {
     description: "Create a GitLab issue with minimal options",
     example: yaml__default.default.stringify({
@@ -850,12 +862,6 @@ const examples$6 = [
   }
 ];
 
-var IssueType = /* @__PURE__ */ ((IssueType2) => {
-  IssueType2["ISSUE"] = "issue";
-  IssueType2["INCIDENT"] = "incident";
-  IssueType2["TEST"] = "test_case";
-  return IssueType2;
-})(IssueType || {});
 const issueInputProperties = zod.z.object({
   projectId: zod.z.number().describe("Project Id"),
   title: zod.z.string({ description: "Title of the issue" }),
@@ -904,7 +910,7 @@ const createGitlabIssueAction = (options) => {
   return pluginScaffolderNode.createTemplateAction({
     id: "gitlab:issues:create",
     description: "Creates a Gitlab issue.",
-    examples: examples$6,
+    examples: examples$7,
     schema: {
       input: commonGitlabConfig.merge(issueInputProperties),
       output: issueOutputProperties
@@ -933,11 +939,7 @@ const createGitlabIssueAction = (options) => {
         const api = getClient({ host, integrations, token });
         let isEpicScoped = false;
         if (epicId) {
-          isEpicScoped = await checkEpicScope(
-            api,
-            projectId,
-            epicId
-          );
+          isEpicScoped = await checkEpicScope(api, projectId, epicId);
           if (isEpicScoped) {
             ctx.logger.info("Epic is within Project Scope");
           } else {
@@ -985,6 +987,225 @@ const createGitlabIssueAction = (options) => {
   });
 };
 
+const examples$6 = [
+  {
+    description: "Edit a GitLab issue with minimal options",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Modified Test Issue",
+            description: "This is a modified description of the issue"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a GitLab issue with assignees and date options",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Test Issue",
+            assignees: [18],
+            description: "This is the edited description of the issue",
+            updatedAt: "2024-05-10 18:00:00.000",
+            dueDate: "2024-09-28"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab Issue with several options",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Test Edit Issue",
+            assignees: [18, 15],
+            description: "This is the description of the issue",
+            confidential: false,
+            updatedAt: "2024-05-10 18:00:00.000",
+            dueDate: "2024-09-28",
+            discussionLocked: true,
+            epicId: 1,
+            labels: "phase1:label1,phase2:label2"
+          }
+        }
+      ]
+    })
+  }
+];
+
+const editIssueInputProperties = zod.z.object({
+  projectId: zod.z.number().describe(
+    "The global ID or URL-encoded path of the project owned by the authenticated user."
+  ),
+  issueIid: zod.z.number().describe("The internal ID of a project's issue"),
+  addLabels: zod.z.string({
+    description: "Comma-separated label names to add to an issue. If a label does not already exist, this creates a new project label and assigns it to the issue."
+  }).optional(),
+  assignees: zod.z.array(zod.z.number(), {
+    description: "IDs of the users to assign the issue to."
+  }).optional(),
+  confidential: zod.z.boolean({ description: "Updates an issue to be confidential." }).optional(),
+  description: zod.z.string().describe("The description of an issue. Limited to 1,048,576 characters.").max(1048576).optional(),
+  discussionLocked: zod.z.boolean({
+    description: "Flag indicating if the issue\u2019s discussion is locked. If the discussion is locked only project members can add or edit comments."
+  }).optional(),
+  dueDate: zod.z.string().describe(
+    "The due date. Date time string in the format YYYY-MM-DD, for example 2016-03-11."
+  ).regex(/^\d{4}-\d{2}-\d{2}$/, "Invalid date format. Use YYYY-MM-DD").optional(),
+  epicId: zod.z.number({
+    description: "ID of the epic to add the issue to. Valid values are greater than or equal to 0."
+  }).min(0, "Valid values should be equal or greater than zero").optional(),
+  issueType: zod.z.nativeEnum(IssueType, {
+    description: "Updates the type of issue. One of issue, incident, test_case or task."
+  }).optional(),
+  labels: zod.z.string({
+    description: "Comma-separated label names for an issue. Set to an empty string to unassign all labels. If a label does not already exist, this creates a new project label and assigns it to the issue."
+  }).optional(),
+  milestoneId: zod.z.number({
+    description: "The global ID of a milestone to assign the issue to. Set to 0 or provide an empty value to unassign a milestone"
+  }).optional(),
+  removeLabels: zod.z.string({
+    description: "Comma-separated label names to remove from an issue."
+  }).optional(),
+  stateEvent: zod.z.nativeEnum(IssueStateEvent, {
+    description: "The state event of an issue. To close the issue, use close, and to reopen it, use reopen."
+  }).optional(),
+  title: zod.z.string().describe("The title of an issue.").optional(),
+  updatedAt: zod.z.string().describe(
+    "When the issue was updated. Date time string, ISO 8601 formatted"
+  ).regex(
+    /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{3})?Z$/,
+    "Invalid date format. Use YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.SSSZ"
+  ).optional(),
+  weight: zod.z.number({ description: "The issue weight" }).min(0, "Valid values should be equal or greater than zero").max(10, "Valid values should be equal or less than 10").optional()
+});
+const editIssueOutputProperties = zod.z.object({
+  issueUrl: zod.z.string({ description: "Issue WebUrl" }),
+  projectId: zod.z.number({
+    description: "The project id the issue belongs to WebUrl"
+  }),
+  issueId: zod.z.number({ description: "The issues Id" }),
+  issueIid: zod.z.number({
+    description: "The issues internal ID of a project's issue"
+  }),
+  state: zod.z.string({ description: "The state event of an issue" }),
+  title: zod.z.string({ description: "The title of an issue." }),
+  updatedAt: zod.z.string({ description: "The last updated time of the issue." })
+});
+const editGitlabIssueAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:issue:edit",
+    description: "Edit a Gitlab issue.",
+    examples: examples$6,
+    schema: {
+      input: commonGitlabConfig.merge(editIssueInputProperties),
+      output: editIssueOutputProperties
+    },
+    async handler(ctx) {
+      try {
+        const {
+          repoUrl,
+          projectId,
+          title,
+          addLabels,
+          removeLabels,
+          issueIid,
+          description,
+          confidential = false,
+          assignees = [],
+          updatedAt = "",
+          dueDate,
+          discussionLocked = false,
+          epicId,
+          labels,
+          issueType,
+          milestoneId,
+          stateEvent,
+          weight,
+          token
+        } = commonGitlabConfig.merge(editIssueInputProperties).parse(ctx.input);
+        const { host } = parseRepoUrl(repoUrl, integrations);
+        const api = getClient({ host, integrations, token });
+        let isEpicScoped = false;
+        if (epicId) {
+          isEpicScoped = await checkEpicScope(api, projectId, epicId);
+          if (isEpicScoped) {
+            ctx.logger.info("Epic is within Project Scope");
+          } else {
+            ctx.logger.warn(
+              "Chosen epic is not within the Project Scope. The issue will be created without an associated epic."
+            );
+          }
+        }
+        const mappedUpdatedAt = convertDate(
+          String(updatedAt),
+          (/* @__PURE__ */ new Date()).toISOString()
+        );
+        const editIssueOptions = {
+          addLabels,
+          assigneeIds: assignees,
+          confidential,
+          description,
+          discussionLocked,
+          dueDate,
+          epicId: isEpicScoped ? epicId : void 0,
+          issueType,
+          labels,
+          milestoneId,
+          removeLabels,
+          stateEvent,
+          title,
+          updatedAt: mappedUpdatedAt,
+          weight
+        };
+        const response = await api.Issues.edit(
+          projectId,
+          issueIid,
+          editIssueOptions
+        );
+        ctx.output("issueId", response.id);
+        ctx.output("projectId", response.project_id);
+        ctx.output("issueUrl", response.web_url);
+        ctx.output("issueIid", response.iid);
+        ctx.output("title", response.title);
+        ctx.output("state", response.state);
+        ctx.output("updatedAt", response.updated_at);
+      } catch (error) {
+        if (error instanceof zod.z.ZodError) {
+          throw new errors.InputError(`Validation error: ${error.message}`, {
+            validationErrors: error.errors
+          });
+        }
+        throw new errors.InputError(
+          `Failed to edit/modify GitLab issue: ${error.message}`
+        );
+      }
+    }
+  });
+};
+
 function createGitlabApi(options) {
   const { integrations, token: providedToken, repoUrl } = options;
   const { host } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
@@ -2120,6 +2341,7 @@ const gitlabModule = backendPluginApi.createBackendModule({
           createGitlabProjectDeployTokenAction({ integrations }),
           createGitlabProjectVariableAction({ integrations }),
           createGitlabRepoPushAction({ integrations }),
+          editGitlabIssueAction({ integrations }),
           createPublishGitlabAction({ config, integrations }),
           createPublishGitlabMergeRequestAction({ integrations }),
           createTriggerGitlabPipelineAction({ integrations })
@@ -2129,6 +2351,7 @@ const gitlabModule = backendPluginApi.createBackendModule({
   }
 });
 
+exports.IssueStateEvent = IssueStateEvent;
 exports.IssueType = IssueType;
 exports.createGitlabGroupEnsureExistsAction = createGitlabGroupEnsureExistsAction;
 exports.createGitlabIssueAction = createGitlabIssueAction;
@@ -2140,4 +2363,5 @@ exports.createPublishGitlabAction = createPublishGitlabAction;
 exports.createPublishGitlabMergeRequestAction = createPublishGitlabMergeRequestAction;
 exports.createTriggerGitlabPipelineAction = createTriggerGitlabPipelineAction;
 exports.default = gitlabModule;
+exports.editGitlabIssueAction = editGitlabIssueAction;
 //# sourceMappingURL=index.cjs.js.map