@pipedream/jira_service_desk 0.0.1 → 0.1.0

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

@@ -0,0 +1,53 @@
+import jiraServiceDesk from "../../jira_service_desk.app.mjs";
+
+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.1",
+  type: "action",
+  props: {
+    jiraServiceDesk,
+    cloudId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "cloudId",
+      ],
+    },
+    requestId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "requestId",
+        ({ cloudId }) => ({
+          cloudId,
+        }),
+      ],
+    },
+    body: {
+      type: "string",
+      label: "Comment Body",
+      description: "The content of the comment",
+    },
+    isPublic: {
+      type: "boolean",
+      label: "Public",
+      description: "Whether the comment is public or not",
+    },
+  },
+  async run({ $ }) {
+    const {
+      cloudId, requestId, body, isPublic,
+    } = this;
+    const response = await this.jiraServiceDesk.createRequestComment({
+      $,
+      cloudId,
+      requestId,
+      data: {
+        body,
+        public: isPublic,
+      },
+    });
+    $.export("$summary", "Successfully created comment on request");
+    return response;
+  },
+};

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

@@ -0,0 +1,115 @@
+import jiraServiceDesk from "../../jira_service_desk.app.mjs";
+
+export default {
+  key: "jira_service_desk-create-request",
+  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.0.1",
+  type: "action",
+  props: {
+    jiraServiceDesk,
+    cloudId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "cloudId",
+      ],
+    },
+    serviceDeskId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "serviceDeskId",
+        ({ cloudId }) => ({
+          cloudId,
+        }),
+      ],
+    },
+    requestTypeId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "requestTypeId",
+        ({
+          cloudId, serviceDeskId,
+        }) => ({
+          cloudId,
+          serviceDeskId,
+        }),
+      ],
+      reloadProps: true,
+    },
+    requestParticipants: {
+      type: "string[]",
+      label: "Request Participants",
+      description:
+        "Not available to users who only have the Service Desk customer permission.",
+      optional: true,
+    },
+  },
+  async additionalProps() {
+    const {
+      cloudId, serviceDeskId, requestTypeId,
+    } = this;
+    const types = await this.jiraServiceDesk.getRequestTypeFields({
+      cloudId,
+      serviceDeskId,
+      requestTypeId,
+    });
+
+    return Object.fromEntries(
+      types.map((field) => [
+        field.fieldId,
+        {
+          type: "string",
+          label: `Field: "${field.name}"`,
+          description: `[See the documentation](https://docs.atlassian.com/jira-servicedesk/REST/3.6.2/#fieldformats) for info on specific fields. If the provided value is not a string, it will be parsed as JSON.${field.description
+            ? `
+\\
+Field description: "${field.description}"`
+            : ""}${field.jiraSchema
+            ? `
+  \\
+  Field schema: \`${JSON.stringify(field.jiraSchema)}\``
+            : ""}`,
+          optional: !field.required,
+        },
+      ]),
+    );
+  },
+  async run({ $ }) {
+    const {
+      // eslint-disable-next-line no-unused-vars
+      jiraServiceDesk,
+      cloudId,
+      serviceDeskId,
+      requestTypeId,
+      requestParticipants,
+      ...requestFieldValues
+    } = this;
+
+    Object.entries(requestFieldValues).forEach(([
+      key,
+      value,
+    ]) => {
+      try {
+        const parsedValue = JSON.parse(value);
+        requestFieldValues[key] = parsedValue;
+      }
+      catch (err) {
+        // ignore non-serializable values
+      }
+    });
+
+    const response = await this.jiraServiceDesk.createCustomerRequest({
+      $,
+      cloudId,
+      data: {
+        serviceDeskId,
+        requestTypeId,
+        requestFieldValues,
+        requestParticipants,
+      },
+    });
+    $.export("$summary", "Successfully created request");
+    return response;
+  },
+};

package/jira_service_desk.app.mjs

@@ -0,0 +1,144 @@
+import { axios } from "@pipedream/platform";
+
+export default {
+  type: "app",
+  app: "jira_service_desk",
+  propDefinitions: {
+    cloudId: {
+      type: "string",
+      label: "Cloud ID",
+      description: "Select a site, or provide a custom ID.",
+      async options() {
+        const sites = await this.getSites();
+        return sites?.filter?.(({ scopes }) => scopes?.includes("write:servicedesk-request")).map(({
+          id, name,
+        }) => ({
+          label: name,
+          value: id,
+        }));
+      },
+    },
+    serviceDeskId: {
+      type: "string",
+      label: "Service Desk ID",
+      description: "Select a service desk, or provide a custom ID.",
+      async options({ cloudId }) {
+        const desks = await this.getServiceDesks({
+          cloudId,
+        });
+        return desks?.map?.(({
+          id, projectName,
+        }) => ({
+          label: projectName,
+          value: id,
+        }));
+      },
+    },
+    requestId: {
+      type: "string",
+      label: "Request ID",
+      description: "Select a request, or provide a custom ID.",
+      async options({ cloudId }) {
+        const requests = await this.getCustomerRequests({
+          cloudId,
+        });
+        return requests?.map?.(({
+          issueId, issueKey, requestFieldValues,
+        }) => {
+          const summary = requestFieldValues?.find?.(({ fieldId }) => fieldId === "summary")?.value;
+          return ({
+            label: `(${issueKey}) ${summary}`,
+            value: issueId,
+          });
+        });
+      },
+    },
+    requestTypeId: {
+      type: "string",
+      label: "Request Type ID",
+      description: "Select a request type, or provide a custom ID.",
+      async options({
+        cloudId, serviceDeskId,
+      }) {
+        const types = await this.getRequestTypes({
+          cloudId,
+          serviceDeskId,
+        });
+        return types?.map?.(({
+          id, name,
+        }) => ({
+          label: name,
+          value: id,
+        }));
+      },
+    },
+  },
+  methods: {
+    _baseUrl() {
+      return "https://api.atlassian.com";
+    },
+    async _makeRequest({
+      $ = this, path, headers, ...otherOpts
+    } = {}) {
+      return axios($, {
+        ...otherOpts,
+        url: this._baseUrl() + path,
+        headers: {
+          ...headers,
+          Authorization: `Bearer ${this.$auth.oauth_access_token}`,
+        },
+      });
+    },
+    async getSites() {
+      return this._makeRequest({
+        path: "/oauth/token/accessible-resources",
+      });
+    },
+    async getServiceDesks({ cloudId }) {
+      const response = await this._makeRequest({
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/servicedesk`,
+      });
+      return response.values;
+    },
+    async getRequestTypes({
+      cloudId, serviceDeskId,
+    }) {
+      const response = await this._makeRequest({
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/servicedesk/${serviceDeskId}/requesttype`,
+      });
+      return response.values;
+    },
+    async getRequestTypeFields({
+      cloudId, serviceDeskId, requestTypeId,
+    }) {
+      const response = await this._makeRequest({
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/servicedesk/${serviceDeskId}/requesttype/${requestTypeId}/field`,
+      });
+      return response.requestTypeFields;
+    },
+    async getCustomerRequests({ cloudId }) {
+      const response = await this._makeRequest({
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/request`,
+      });
+      return response.values;
+    },
+    async createCustomerRequest({
+      cloudId, ...opts
+    }) {
+      return this._makeRequest({
+        ...opts,
+        method: "POST",
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/request`,
+      });
+    },
+    async createRequestComment({
+      cloudId, requestId, ...opts
+    }) {
+      return this._makeRequest({
+        ...opts,
+        method: "POST",
+        path: `/ex/jira/${cloudId}/rest/servicedeskapi/request/${requestId}/comment`,
+      });
+    },
+  },
+};

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@pipedream/jira_service_desk",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Jira Service Desk Components",
-  "main": "dist/app/jira_service_desk.app.mjs",
+  "main": "jira_service_desk.app.mjs",
   "keywords": [
     "pipedream",
     "jira_service_desk"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/jira_service_desk",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.5.1"
   }
 }

package/sources/common.mjs

@@ -0,0 +1,61 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import jiraServiceDesk from "../jira_service_desk.app.mjs";
+
+export default {
+  props: {
+    jiraServiceDesk,
+    cloudId: {
+      propDefinition: [
+        jiraServiceDesk,
+        "cloudId",
+      ],
+    },
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastDate() {
+      return this.db.get("lastDate") ?? Date.now();
+    },
+    _setLastDate(value) {
+      this.db.set("lastDate", value);
+    },
+    getSummary() {
+      throw new Error("Summary method not implemented in component");
+    },
+    getRequestDate() {
+      throw new Error("Date method not implemented in component");
+    },
+  },
+  async run() {
+    const newDate = Date.now();
+    const lastDate = this._getLastDate();
+
+    const { cloudId } = this;
+    const requests = await this.jiraServiceDesk.getCustomerRequests({
+      cloudId,
+    });
+
+    requests
+      ?.filter?.((req) => this.getRequestDate(req) > lastDate)
+      .forEach((req) => {
+        const ts = this.getRequestDate(req);
+        const id = req.issueId + ts.toString();
+        const summary =
+          req.requestFieldValues.find(({ fieldId }) => fieldId === "summary")
+            ?.value ?? req.issueKey;
+        this.$emit(req, {
+          id,
+          summary: `${this.getSummary()}: ${summary}`,
+          ts,
+        });
+      });
+
+    this._setLastDate(newDate);
+  },
+};

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

@@ -0,0 +1,21 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "jira_service_desk-new-request-created",
+  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.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getRequestDate(req) {
+      return req.createdDate.epochMillis;
+    },
+    getSummary() {
+      return "New Request";
+    },
+  },
+};

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

@@ -0,0 +1,61 @@
+export default {
+  _expands: ["participant", "status", "sla", "requestType", "serviceDesk"],
+  issueId: "107001",
+  issueKey: "HELPDESK-1",
+  requestTypeId: "25",
+  serviceDeskId: "10",
+  createdDate: {
+    iso8601: "2015-10-08T14:42:00+0700",
+    jira: "2015-10-08T14:42:00.000+0700",
+    friendly: "Monday 14:42 PM",
+    epochMillis: 1444290120000,
+  },
+  reporter: {
+    name: "fred",
+    key: "fred",
+    emailAddress: "fred@example.com",
+    displayName: "Fred F. User",
+    active: true,
+    timeZone: "Australia/Sydney",
+    _links: {
+      jiraRest: "http://www.example.com/jira/rest/api/2/user?username=fred",
+      avatarUrls: {
+        "48x48":
+          "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
+        "24x24":
+          "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
+        "16x16":
+          "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
+        "32x32":
+          "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred",
+      },
+      self: "http://www.example.com/jira/rest/api/2/user?username=fred",
+    },
+  },
+  requestFieldValues: [
+    {
+      fieldId: "summary",
+      label: "What do you need?",
+      value: "Request JSD help via REST",
+    },
+    {
+      fieldId: "description",
+      label: "Why do you need this?",
+      value: "I need a new mouse for my Mac",
+    },
+  ],
+  currentStatus: {
+    status: "Waiting for Support",
+    statusDate: {
+      iso8601: "2015-10-08T14:01:00+0700",
+      jira: "2015-10-08T14:01:00.000+0700",
+      friendly: "Today 14:01 PM",
+      epochMillis: 1444287660000,
+    },
+  },
+  _links: {
+    jiraRest: "http://host:port/context/rest/api/2/issue/107001",
+    web: "http://host:port/context/servicedesk/customer/portal/10/HELPDESK-1",
+    self: "http://host:port/context/rest/servicedeskapi/request/107001",
+  },
+};

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

@@ -0,0 +1,21 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "jira_service_desk-request-status-updated",
+  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.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getRequestDate(req) {
+      return req.currentStatus.statusDate.epochMillis;
+    },
+    getSummary() {
+      return "Request Updated";
+    },
+  },
+};

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

@@ -0,0 +1,61 @@
+export default {
+  _expands: ["participant", "status", "sla", "requestType", "serviceDesk"],
+  issueId: "107001",
+  issueKey: "HELPDESK-1",
+  requestTypeId: "25",
+  serviceDeskId: "10",
+  createdDate: {
+    iso8601: "2015-10-08T14:42:00+0700",
+    jira: "2015-10-08T14:42:00.000+0700",
+    friendly: "Monday 14:42 PM",
+    epochMillis: 1444290120000,
+  },
+  reporter: {
+    name: "fred",
+    key: "fred",
+    emailAddress: "fred@example.com",
+    displayName: "Fred F. User",
+    active: true,
+    timeZone: "Australia/Sydney",
+    _links: {
+      jiraRest: "http://www.example.com/jira/rest/api/2/user?username=fred",
+      avatarUrls: {
+        "48x48":
+          "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
+        "24x24":
+          "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
+        "16x16":
+          "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
+        "32x32":
+          "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred",
+      },
+      self: "http://www.example.com/jira/rest/api/2/user?username=fred",
+    },
+  },
+  requestFieldValues: [
+    {
+      fieldId: "summary",
+      label: "What do you need?",
+      value: "Request JSD help via REST",
+    },
+    {
+      fieldId: "description",
+      label: "Why do you need this?",
+      value: "I need a new mouse for my Mac",
+    },
+  ],
+  currentStatus: {
+    status: "Waiting for Support",
+    statusDate: {
+      iso8601: "2015-10-08T14:01:00+0700",
+      jira: "2015-10-08T14:01:00.000+0700",
+      friendly: "Today 14:01 PM",
+      epochMillis: 1444287660000,
+    },
+  },
+  _links: {
+    jiraRest: "http://host:port/context/rest/api/2/issue/107001",
+    web: "http://host:port/context/servicedesk/customer/portal/10/HELPDESK-1",
+    self: "http://host:port/context/rest/servicedeskapi/request/107001",
+  },
+};