@pipedream/jira_service_desk 2.0.1 → 2.1.0

package/actions/create-comment-on-request/create-comment-on-request.mjs

@@ -4,7 +4,7 @@ export default {
   key: "jira_service_desk-create-comment-on-request",
   name: "Create Comment on Request",
   description: "Create a comment on a customer request. [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-comment-post)",
-  version: "0.1.1",
+  version: "0.1.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-request/create-request.mjs

@@ -15,7 +15,7 @@ export default {
     + " Worked example: on service desk `1`, request type `4` (\"Onboard new employees\") requires `summary` and also accepts a `duedate`, so call with Summary `Joseph Wilson starts on September 1`, Description `Needs a laptop and an email account`, and Additional Field Values `{ \"duedate\": \"2026-09-01\" }`."
     + " Returns the created request including its `issueKey` and `issueId`."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-post)",
-  version: "1.0.1",
+  version: "1.0.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/download-issue-attachment/download-issue-attachment.mjs

@@ -0,0 +1,102 @@
+// x-pd-ai: optimized
+import path from "path";
+import fs from "fs";
+import stream from "stream";
+import { promisify } from "util";
+import { ConfigurationError } from "@pipedream/platform";
+import jiraServiceDesk from "../../jira_service_desk.app.mjs";
+import constants from "../../common/constants.mjs";
+
+const PIPELINE = promisify(stream.pipeline);
+
+export default {
+  key: "jira_service_desk-download-issue-attachment",
+  name: "Download Issue Attachment",
+  description: "Download the binary content of a Jira Service Desk attachment to the file-stash directory, returning the saved path plus the attachment metadata (`filename`, `mimeType`, `size`). Run **List Issue Attachments** first to obtain the attachment `id`, then pass both it and the same `issueIdOrKey` here. Example: passing `issueIdOrKey` `IT-42` and `attachmentId` `10042` downloads `screenshot.png` to `/tmp/10042-screenshot.png` and returns `{ \"filedata\": [\"10042-screenshot.png\", \"/tmp/10042-screenshot.png\"], \"attachment\": { \"id\": \"10042\", \"filename\": \"screenshot.png\", \"mimeType\": \"image/png\", \"size\": 84213 } }`. [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    jiraServiceDesk,
+    cloudId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "cloudId",
+      ],
+    },
+    issueIdOrKey: {
+      propDefinition: [
+        jiraServiceDesk,
+        "issueIdOrKey",
+      ],
+    },
+    attachmentId: {
+      type: "string",
+      label: "Attachment ID",
+      description: "The numeric ID of the attachment to download, e.g. `10042`. Run **List Issue Attachments** first to obtain the ID from an attachment's `id` field.",
+    },
+    syncDir: {
+      type: "dir",
+      accessMode: "write",
+      sync: true,
+    },
+  },
+  async run({ $ }) {
+    if (!/^\d+$/.test(this.attachmentId)) {
+      throw new ConfigurationError(`Invalid attachment ID "${this.attachmentId}". Attachment IDs must be numeric.`);
+    }
+
+    const { attachments } = await this.jiraServiceDesk.getIssueAttachments({
+      $,
+      cloudId: this.cloudId,
+      issueIdOrKey: this.issueIdOrKey,
+      maxResults: constants.MAX_RESULTS_MAX,
+    });
+    const metadata = attachments.find(({ id }) => id === this.attachmentId);
+    if (!metadata) {
+      throw new ConfigurationError(`Attachment ID "${this.attachmentId}" was not found on issue "${this.issueIdOrKey}". Run List Issue Attachments to confirm the ID and issue match. If this connection has customer-level access, note that internal (non-public) attachments aren't visible to it even if they exist.`);
+    }
+    if (metadata.size > constants.MAX_ATTACHMENT_SIZE_BYTES) {
+      throw new ConfigurationError(`Attachment "${metadata.filename}" is ${metadata.size} bytes, which exceeds the ${constants.MAX_ATTACHMENT_SIZE_BYTES}-byte (2GB) /tmp disk limit for this execution, so it cannot be downloaded.`);
+    }
+
+    const safeFilename = path.basename(metadata.filename ?? "");
+    if (!safeFilename || safeFilename === "." || safeFilename === "..") {
+      throw new Error(`Invalid attachment filename "${metadata.filename}" returned by Jira.`);
+    }
+    const savedFilename = `${this.attachmentId}-${safeFilename}`;
+    const stashDir = process.env.STASH_DIR || "/tmp";
+    const downloadedFilepath = path.join(stashDir, savedFilename);
+
+    const contentStream = await this.jiraServiceDesk.getAttachmentContent({
+      $,
+      cloudId: this.cloudId,
+      issueIdOrKey: this.issueIdOrKey,
+      attachmentId: this.attachmentId,
+    });
+    try {
+      await PIPELINE(contentStream, fs.createWriteStream(downloadedFilepath));
+    } catch (error) {
+      await fs.promises.rm(downloadedFilepath, {
+        force: true,
+      }).catch(() => {});
+      throw error;
+    }
+
+    const filedata = [
+      savedFilename,
+      downloadedFilepath,
+    ];
+
+    $.export("$summary", `Downloaded ${metadata.filename} (${metadata.size} bytes)`);
+
+    return {
+      filedata,
+      attachment: metadata,
+    };
+  },
+};

package/actions/get-current-user/get-current-user.mjs

@@ -8,7 +8,7 @@ export default {
     + " Use this to identify who is logged in, or to filter requests by the current user's `account_id`."
     + " No `cloudId` required — this uses the Atlassian Identity API directly."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/get-request/get-request.mjs

@@ -10,7 +10,7 @@ export default {
     + " Use **List Sites** first to obtain the required `cloudId`."
     + " Use **List My Requests** to find the `issueKey` of a request (e.g. `IT-42`)."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-get)",
-  version: "0.2.1",
+  version: "0.2.2",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/get-request-status/get-request-status.mjs

@@ -11,7 +11,7 @@ export default {
     + " Use **List Sites** first to obtain the required `cloudId`."
     + " Use **List My Requests** to find the `issueKey` (e.g. `IT-42`)."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-status-get)",
-  version: "1.1.1",
+  version: "1.1.2",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-cloud-id-options/list-cloud-id-options.mjs

@@ -4,7 +4,7 @@ export default {
   key: "jira_service_desk-list-cloud-id-options",
   name: "List Cloud ID Options",
   description: "Lists the Atlassian sites you can raise requests on, as `{label, value}` options, to discover the `cloudId` every other Jira Service Desk tool needs. Takes no input beyond the account. Example: returns `[{ \"label\": \"acme\", \"value\": \"822faf0d-5427-420e-9016-999d3dc76918\" }]`. Use **List Sites** instead if you want the full site records. [See the documentation](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/#3-1-get-the-cloudid-for-your-site)",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-issue-attachments/list-issue-attachments.mjs

@@ -0,0 +1,59 @@
+// x-pd-ai: optimized
+import { ConfigurationError } from "@pipedream/platform";
+import jiraServiceDesk from "../../jira_service_desk.app.mjs";
+
+export default {
+  key: "jira_service_desk-list-issue-attachments",
+  name: "List Issue Attachments",
+  description: "List metadata for every attachment on a Jira Service Desk request. `issueIdOrKey` accepts either a Jira issue key (e.g. `IT-42`) or a numeric Jira issue ID (e.g. `10001`). Results are paginated automatically up to `maxResults`. Returns `{ attachments, truncated }`, where each attachment includes `id`, `filename`, `size` (bytes), `mimeType`, and `content` (an opaque reference URL whose exact shape varies by account access level and is **not** directly fetchable through this connection's authentication), and `truncated` is `true` when more attachments remained unfetched. Use **Download Issue Attachment** with an attachment `id` and the same `issueIdOrKey` to fetch the binary content — do not call `content` directly. If this connection has customer-level access rather than agent access, only public attachments are returned; internal attachments exist but won't appear here. Returns `{ attachments: [], truncated: false }` (no error) when the request exists but has no visible attachments. Example: issue `IT-42` with one attachment returns `{ \"attachments\": [{ \"id\": \"10042\", \"filename\": \"screenshot.png\", \"size\": 84213, \"mimeType\": \"image/png\", \"content\": \"<opaque reference URL>\" }], \"truncated\": false }`. [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-attachment-get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    jiraServiceDesk,
+    cloudId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "cloudId",
+      ],
+    },
+    issueIdOrKey: {
+      propDefinition: [
+        jiraServiceDesk,
+        "issueIdOrKey",
+      ],
+    },
+    maxResults: {
+      propDefinition: [
+        jiraServiceDesk,
+        "maxResults",
+      ],
+    },
+  },
+  async run({ $ }) {
+    if (!this.issueIdOrKey) {
+      throw new ConfigurationError("Issue ID or Key is required.");
+    }
+
+    const {
+      attachments, hasMore,
+    } = await this.jiraServiceDesk.getIssueAttachments({
+      $,
+      cloudId: this.cloudId,
+      issueIdOrKey: this.issueIdOrKey,
+      maxResults: this.maxResults,
+    });
+
+    $.export("$summary", `Found ${attachments.length}${hasMore
+      ? "+"
+      : ""} attachment(s) on issue ${this.issueIdOrKey}`);
+    return {
+      attachments,
+      truncated: hasMore,
+    };
+  },
+};

package/actions/list-my-requests/list-my-requests.mjs

@@ -13,7 +13,7 @@ export default {
     + " `requestStatus`: `OPEN_REQUESTS` (default), `CLOSED_REQUESTS`, or `ALL_REQUESTS`."
     + " `requestOwnership`: `OWNED_REQUESTS` (default) or `PARTICIPATED_REQUESTS`."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-get)",
-  version: "1.1.1",
+  version: "1.1.2",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -60,7 +60,7 @@ export default {
         app,
         "maxResults",
       ],
-      description: "Maximum number of requests to return across all pages (1.1.10).",
+      description: "Maximum number of requests to return across all pages (1-1000).",
     },
   },
   async run({ $ }) {

package/actions/list-request-transitions/list-request-transitions.mjs

@@ -11,7 +11,7 @@ export default {
     + " Use **List Sites** first to obtain the required `cloudId`."
     + " Use **List My Requests** or **Get Request** to find the `issueKey` (e.g. `IT-42`)."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-transition-get)",
-  version: "1.1.1",
+  version: "1.1.2",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -38,7 +38,7 @@ export default {
         "maxResults",
       ],
       label: "Max Transitions",
-      description: "Maximum number of transitions to return across all pages (1.1.10).",
+      description: "Maximum number of transitions to return across all pages (1-1000).",
     },
   },
   async run({ $ }) {

package/actions/list-request-type-fields/list-request-type-fields.mjs

@@ -12,7 +12,7 @@ export default {
     + " Also returns `canRaiseOnBehalfOf` and `canAddRequestParticipants`, which tell you whether the `raiseOnBehalfOf` and `requestParticipants` arguments of **Create Request** are usable with this account."
     + " Hidden fields are only visible to service desk administrators."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-field-get)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-request-types/list-request-types.mjs

@@ -15,7 +15,7 @@ export default {
     + " Types with `canCreateRequest: false` cannot be used to raise a request."
     + " Then call **List Request Type Fields** to see what the chosen type requires."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-get)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-service-desks/list-service-desks.mjs

@@ -12,7 +12,7 @@ export default {
     + " Returns `{ serviceDesks, truncated }`, where `truncated` is `true` when more desks remained unfetched."
     + " Example: a site with one desk returns `{ \"serviceDesks\": [{ \"id\": \"1\", \"projectName\": \"Support\", \"projectKey\": \"SUP\" }], \"truncated\": false }`."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-get)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-sites/list-sites.mjs

@@ -8,7 +8,7 @@ export default {
     + " **Call this tool first** to obtain the `cloudId` (returned as `id`) required by every other Jira Service Desk tool."
     + " Each site includes its `id` (cloudId), `name`, and `url`."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/#3-1-get-the-cloudid-for-your-site)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/transition-request/transition-request.mjs

@@ -10,7 +10,7 @@ export default {
     + " Use **List My Requests** or **Get Request** to find the `issueKey` (e.g. `IT-42`)."
     + " Optionally include a comment to explain the transition."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-issueidorkey-transition-post)",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/update-issue-fields/update-issue-fields.mjs

@@ -11,7 +11,7 @@ export default {
     + " `fields` is a JSON object of field name-value pairs."
     + " Example: `{\"summary\": \"Updated title\", \"priority\": {\"name\": \"High\"}}`."
     + " [See the documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-put)",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   annotations: {
     destructiveHint: false,

package/common/constants.mjs

@@ -17,10 +17,20 @@ const REQUEST_FIELD = {
   DESCRIPTION: "description",
 };
 
+// The axios responseType used when streaming binary attachment content.
+const STREAM_RESPONSE_TYPE = "stream";
+
+// Pipedream's /tmp directory (the default file-stash download target) is capped at 2GB
+// per execution, so any attachment reported larger than this can never be downloaded.
+// https://pipedream.com/docs/workflows/limits#disk
+const MAX_ATTACHMENT_SIZE_BYTES = 2 * 1024 * 1024 * 1024;
+
 export default {
   PAGE_SIZE,
   MAX_RESULTS_DEFAULT,
   MAX_RESULTS_MIN,
   MAX_RESULTS_MAX,
   REQUEST_FIELD,
+  STREAM_RESPONSE_TYPE,
+  MAX_ATTACHMENT_SIZE_BYTES,
 };

package/jira_service_desk.app.mjs

@@ -247,5 +247,38 @@ export default {
         path: `/ex/jira/${cloudId}/rest/api/3/issue/${issueIdOrKey}`,
       });
     },
+    async getIssueAttachments({
+      $, cloudId, issueIdOrKey, maxResults,
+    }) {
+      const {
+        results, hasMore,
+      } = await this._paginate({
+        $,
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/request/${issueIdOrKey}/attachment`,
+        maxResults,
+      });
+      const attachments = results.map(({
+        filename, size, mimeType, _links,
+      }) => ({
+        id: _links?.jiraRest?.split("/").pop(),
+        filename,
+        size,
+        mimeType,
+        content: _links?.content,
+      }));
+      return {
+        attachments,
+        hasMore,
+      };
+    },
+    async getAttachmentContent({
+      $, cloudId, issueIdOrKey, attachmentId,
+    }) {
+      return this._makeRequest({
+        $,
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/request/${issueIdOrKey}/attachment/${attachmentId}`,
+        responseType: constants.STREAM_RESPONSE_TYPE,
+      });
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/jira_service_desk",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Pipedream Jira Service Desk Components",
   "main": "jira_service_desk.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.6.8"
+    "@pipedream/platform": "^3.4.0"
   }
 }

package/sources/new-request-created/new-request-created.mjs

@@ -6,7 +6,7 @@ export default {
   name: "New Request Created",
   description:
     "Emit new event when a customer request is created. [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-get)",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "source",
   dedupe: "unique",
   methods: {

package/sources/request-status-updated/request-status-updated.mjs

@@ -6,7 +6,7 @@ export default {
   name: "Request Status Updated",
   description:
     "Emit new event when a customer request is updated. [See the documentation](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-get)",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "source",
   dedupe: "unique",
   methods: {