@pipedream/jira_service_desk 0.3.0 → 1.0.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.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-incident/create-incident.mjs

@@ -10,7 +10,7 @@ export default {
     + " `serviceDeskId` is optional — if not provided, the tool calls **List My Requests** to discover it automatically."
     + " Returns the new 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: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -43,10 +43,10 @@ export default {
     },
   },
   async run({ $ }) {
-    // Auto-discover serviceDeskId if not provided — extract from existing requests
+    // Auto-discover serviceDeskId if not provided: extract from existing requests
     let serviceDeskId = this.serviceDeskId;
     if (!serviceDeskId) {
-      const existingRequests = await this.app.listMyRequests({
+      const { results: existingRequests } = await this.app.listMyRequests({
         $,
         cloudId: this.cloudId,
       });

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

@@ -5,7 +5,7 @@ export default {
   name: "Create Request",
   description:
     "Creates a new customer request. [See the documentation](https://docs.atlassian.com/jira-servicedesk/REST/3.6.2/#servicedeskapi/request-createCustomerRequest)",
-  version: "0.1.2",
+  version: "0.1.3",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

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

@@ -4,12 +4,13 @@ export default {
   key: "jira_service_desk-get-request",
   name: "Get Request",
   description:
-    "Fetches the full details of a Jira Service Desk request including its field values and complete comment thread in a single response."
+    "Fetches the full details of a Jira Service Desk request including its field values and comment thread in a single response."
+    + " Comments are paginated automatically up to `maxResults`; the summary says so when the thread was truncated."
     + " Use this to summarize a ticket without needing follow-up calls."
     + " 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.0.1",
+  version: "0.1.0",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -30,11 +31,21 @@ export default {
         "issueIdOrKey",
       ],
     },
+    maxResults: {
+      propDefinition: [
+        app,
+        "maxResults",
+      ],
+      label: "Max Comments",
+      description: "Maximum number of comments to return across all pages (1-1000).",
+    },
   },
   async run({ $ }) {
     const [
       request,
-      comments,
+      {
+        results: comments, hasMore,
+      },
     ] = await Promise.all([
       this.app.getRequest({
         $,
@@ -45,16 +56,20 @@ export default {
         $,
         cloudId: this.cloudId,
         issueIdOrKey: this.issueIdOrKey,
+        maxResults: this.maxResults,
       }),
     ]);
 
     const summary = request.requestFieldValues?.find?.(({ fieldId }) => fieldId === "summary")?.value
       || this.issueIdOrKey;
 
-    $.export("$summary", `Request ${request.issueKey}: ${summary} (${comments?.length ?? 0} comment(s))`);
+    $.export("$summary", `Request ${request.issueKey}: ${summary} (${comments.length}${hasMore
+      ? "+"
+      : ""} comment(s))`);
     return {
       ...request,
       comments,
+      commentsTruncated: hasMore,
     };
   },
 };

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

@@ -4,12 +4,14 @@ export default {
   key: "jira_service_desk-get-request-status",
   name: "Get Request Status",
   description:
-    "Returns the status history of a Jira Service Desk request — the current status plus all previous states with timestamps."
+    "Returns the status history of a Jira Service Desk request: the current status plus previous states with timestamps."
+    + " The history is paginated automatically up to `maxResults`."
+    + " Returns `{ statuses, truncated }`, newest first, where `truncated` is `true` when more entries remained unfetched."
     + " Use this to understand how a request has progressed through the workflow."
     + " 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: "0.0.1",
+  version: "1.0.0",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -30,15 +32,31 @@ export default {
         "issueIdOrKey",
       ],
     },
+    maxResults: {
+      propDefinition: [
+        app,
+        "maxResults",
+      ],
+      label: "Max Entries",
+      description: "Maximum number of status history entries to return across all pages (1-1000).",
+    },
   },
   async run({ $ }) {
-    const statuses = await this.app.getRequestStatus({
+    const {
+      results: statuses, hasMore,
+    } = await this.app.getRequestStatus({
       $,
       cloudId: this.cloudId,
       issueIdOrKey: this.issueIdOrKey,
+      maxResults: this.maxResults,
     });
     const current = statuses?.[0]?.status || "unknown";
-    $.export("$summary", `Status history for ${this.issueIdOrKey}: current status is "${current}" (${statuses?.length ?? 0} entries)`);
-    return statuses;
+    $.export("$summary", `Status history for ${this.issueIdOrKey}: current status is "${current}" (${statuses.length}${hasMore
+      ? "+"
+      : ""} entries)`);
+    return {
+      statuses,
+      truncated: hasMore,
+    };
   },
 };

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: "Retrieves available options for the Cloud ID field.",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

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

@@ -6,12 +6,14 @@ export default {
   description:
     "Lists Jira Service Desk requests owned or participated in by the current user."
     + " Defaults to open requests owned by the current user."
+    + " Results are paginated automatically up to `maxResults`."
+    + " Returns `{ requests, truncated }`, where `truncated` is `true` when more requests remained unfetched."
     + " Use **List Sites** first to obtain the required `cloudId`."
     + " Each result includes `issueKey`, `issueId`, and request field values (summary, status)."
     + " `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: "0.0.1",
+  version: "1.0.0",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -53,16 +55,31 @@ export default {
       ],
       optional: true,
     },
+    maxResults: {
+      propDefinition: [
+        app,
+        "maxResults",
+      ],
+      description: "Maximum number of requests to return across all pages (1-1000).",
+    },
   },
   async run({ $ }) {
-    const requests = await this.app.listMyRequests({
+    const {
+      results: requests, hasMore,
+    } = await this.app.listMyRequests({
       $,
       cloudId: this.cloudId,
       serviceDeskId: this.serviceDeskId,
       requestStatus: this.requestStatus,
       requestOwnership: this.requestOwnership,
+      maxResults: this.maxResults,
     });
-    $.export("$summary", `Found ${requests?.length ?? 0} request(s)`);
-    return requests;
+    $.export("$summary", `Found ${requests.length} request(s)${hasMore
+      ? ", truncated at Max Results; raise it to fetch more"
+      : ""}`);
+    return {
+      requests,
+      truncated: hasMore,
+    };
   },
 };

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

@@ -4,12 +4,14 @@ export default {
   key: "jira_service_desk-list-request-transitions",
   name: "List Request Transitions",
   description:
-    "Lists the available workflow transitions for a Jira Service Desk request — returns each transition's `id` and `name`."
-    + " **Call this before `Transition Request`** to obtain valid `transitionId` values."
+    "Lists the available workflow transitions for a Jira Service Desk request, returning each transition's `id` and `name`."
+    + " Transitions are paginated automatically up to `maxResults`."
+    + " Returns `{ transitions, truncated }`, where `truncated` is `true` when more transitions remained unfetched."
+    + " Call this before **Transition Request** to obtain valid `transitionId` values."
     + " 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: "0.0.1",
+  version: "1.0.0",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -30,14 +32,30 @@ export default {
         "issueIdOrKey",
       ],
     },
+    maxResults: {
+      propDefinition: [
+        app,
+        "maxResults",
+      ],
+      label: "Max Transitions",
+      description: "Maximum number of transitions to return across all pages (1-1000).",
+    },
   },
   async run({ $ }) {
-    const transitions = await this.app.getRequestTransitions({
+    const {
+      results: transitions, hasMore,
+    } = await this.app.getRequestTransitions({
       $,
       cloudId: this.cloudId,
       issueIdOrKey: this.issueIdOrKey,
+      maxResults: this.maxResults,
     });
-    $.export("$summary", `Found ${transitions?.length ?? 0} available transition(s) for ${this.issueIdOrKey}`);
-    return transitions;
+    $.export("$summary", `Found ${transitions.length}${hasMore
+      ? "+"
+      : ""} available transition(s) for ${this.issueIdOrKey}`);
+    return {
+      transitions,
+      truncated: hasMore,
+    };
   },
 };

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.1",
+  version: "0.0.2",
   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.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -34,7 +34,7 @@ export default {
     transitionId: {
       type: "string",
       label: "Transition ID",
-      description: "The ID of the transition to perform. Use **List Request Transitions** to retrieve available transition IDs and names.",
+      description: "The ID of the transition to perform. Use **List Request Transitions** to retrieve available transition IDs and names (in its `transitions` array).",
     },
     additionalComment: {
       type: "string",

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.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

package/common/constants.mjs

@@ -0,0 +1,20 @@
+// Jira Service Management caps the page size of each paginated `servicedeskapi`
+// resource server-side, and the cap differs per resource (verified live:
+// `/request` clamps to 100, `/request/{id}/comment` clamps to 50). Atlassian
+// documents the cap as an implementation detail that may change, so `_paginate`
+// requests this page size and then keys off the returned `isLastPage` and
+// `size` rather than assuming the page it asked for is the page it got.
+// https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#pagination
+const PAGE_SIZE = 100;
+
+// Ceiling on how many items a single action run will collect across pages.
+const MAX_RESULTS_DEFAULT = 100;
+const MAX_RESULTS_MIN = 1;
+const MAX_RESULTS_MAX = 1000;
+
+export default {
+  PAGE_SIZE,
+  MAX_RESULTS_DEFAULT,
+  MAX_RESULTS_MIN,
+  MAX_RESULTS_MAX,
+};

package/jira_service_desk.app.mjs

@@ -1,4 +1,5 @@
 import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
 
 export default {
   type: "app",
@@ -75,7 +76,16 @@ export default {
     issueIdOrKey: {
       type: "string",
       label: "Issue ID or Key",
-      description: "The ID or key of the Jira Service Desk request (e.g. `IT-42` or `10001`). Use **List My Requests** to find the `issueKey` of a request.",
+      description: "The ID or key of the Jira Service Desk request (e.g. `IT-42` or `10001`). Use **List My Requests** to find the `issueKey` of a request (in its `requests` array).",
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: `Maximum number of items to return across all pages (${constants.MAX_RESULTS_MIN}-${constants.MAX_RESULTS_MAX}).`,
+      optional: true,
+      default: constants.MAX_RESULTS_DEFAULT,
+      min: constants.MAX_RESULTS_MIN,
+      max: constants.MAX_RESULTS_MAX,
     },
   },
   methods: {
@@ -94,26 +104,76 @@ export default {
         },
       });
     },
+    /**
+     * Walks a paginated `servicedeskapi` collection until the API reports
+     * `isLastPage`, or until `maxResults` items have been collected.
+     *
+     * @returns {Promise<{ results: object[], hasMore: boolean }>} the collected
+     * items and whether the API still had more to give when collection stopped.
+     */
+    async _paginate({
+      $, path, params, maxResults = constants.MAX_RESULTS_DEFAULT,
+    }) {
+      const results = [];
+      let start = 0;
+      let isLastPage = false;
+
+      while (results.length < maxResults) {
+        const response = await this._makeRequest({
+          $,
+          path,
+          params: {
+            ...params,
+            start,
+            limit: Math.min(maxResults - results.length, constants.PAGE_SIZE),
+          },
+        });
+
+        const values = response?.values;
+        if (!values?.length) {
+          isLastPage = true;
+          break;
+        }
+
+        results.push(...values);
+        isLastPage = Boolean(response.isLastPage);
+        if (isLastPage) {
+          break;
+        }
+
+        // The API may cap a page below the requested `limit`, so advance by what
+        // was actually returned instead of by the requested page size.
+        start += response.size || values.length;
+      }
+
+      return {
+        results: results.slice(0, maxResults),
+        hasMore: !isLastPage || results.length > maxResults,
+      };
+    },
     async getSites({ $ } = {}) {
       return this._makeRequest({
         $,
         path: "/oauth/token/accessible-resources",
       });
     },
-    async getServiceDesks({ cloudId }) {
-      const response = await this._makeRequest({
+    async getServiceDesks({
+      $, cloudId,
+    }) {
+      const { results } = await this._paginate({
+        $,
         path: `/ex/jira/${cloudId}/rest/servicedeskapi/servicedesk`,
       });
-      return response.values;
+      return results;
     },
     async getRequestTypes({
       $, cloudId, serviceDeskId,
     }) {
-      const response = await this._makeRequest({
+      const { results } = await this._paginate({
         $,
         path: `/ex/jira/${cloudId}/rest/servicedeskapi/servicedesk/${serviceDeskId}/requesttype`,
       });
-      return response.values;
+      return results;
     },
     async getRequestTypeFields({
       cloudId, serviceDeskId, requestTypeId,
@@ -123,11 +183,14 @@ export default {
       });
       return response.requestTypeFields;
     },
-    async getCustomerRequests({ cloudId }) {
-      const response = await this._makeRequest({
+    async getCustomerRequests({
+      $, cloudId,
+    }) {
+      const { results } = await this._paginate({
+        $,
         path: `/ex/jira/${cloudId}/rest/servicedeskapi/request`,
       });
-      return response.values;
+      return results;
     },
     async createCustomerRequest({
       cloudId, ...opts
@@ -154,19 +217,21 @@ export default {
       });
     },
     async listMyRequests({
-      $, cloudId, serviceDeskId, requestStatus, requestOwnership,
+      $, cloudId, serviceDeskId, requestStatus, requestOwnership, maxResults,
     }) {
       const params = {
         requestStatus: requestStatus || "OPEN_REQUESTS",
         requestOwnership: requestOwnership || "OWNED_REQUESTS",
       };
-      if (serviceDeskId) params.serviceDeskId = serviceDeskId;
-      const response = await this._makeRequest({
+      if (serviceDeskId) {
+        params.serviceDeskId = serviceDeskId;
+      }
+      return this._paginate({
         $,
         path: `/ex/jira/${cloudId}/rest/servicedeskapi/request`,
         params,
+        maxResults,
       });
-      return response.values;
     },
     async getRequest({
       $, cloudId, issueIdOrKey,
@@ -177,31 +242,31 @@ export default {
       });
     },
     async getRequestComments({
-      $, cloudId, issueIdOrKey,
+      $, cloudId, issueIdOrKey, maxResults,
     }) {
-      const response = await this._makeRequest({
+      return this._paginate({
         $,
         path: `/ex/jira/${cloudId}/rest/servicedeskapi/request/${issueIdOrKey}/comment`,
+        maxResults,
       });
-      return response.values;
     },
     async getRequestStatus({
-      $, cloudId, issueIdOrKey,
+      $, cloudId, issueIdOrKey, maxResults,
     }) {
-      const response = await this._makeRequest({
+      return this._paginate({
         $,
         path: `/ex/jira/${cloudId}/rest/servicedeskapi/request/${issueIdOrKey}/status`,
+        maxResults,
       });
-      return response.values;
     },
     async getRequestTransitions({
-      $, cloudId, issueIdOrKey,
+      $, cloudId, issueIdOrKey, maxResults,
     }) {
-      const response = await this._makeRequest({
+      return this._paginate({
         $,
         path: `/ex/jira/${cloudId}/rest/servicedeskapi/request/${issueIdOrKey}/transition`,
+        maxResults,
       });
-      return response.values;
     },
     async transitionRequest({
       cloudId, issueIdOrKey, ...opts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/jira_service_desk",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "description": "Pipedream Jira Service Desk Components",
   "main": "jira_service_desk.app.mjs",
   "keywords": [

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.0.2",
+  version: "0.0.3",
   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.0.2",
+  version: "0.0.3",
   type: "source",
   dedupe: "unique",
   methods: {