@pipedream/topdesk 0.1.0 → 0.2.0

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

@@ -4,7 +4,7 @@ export default {
   key: "topdesk-create-incident",
   name: "Create Incident",
   description: "Creates a new incident. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/createIncident)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/actions/get-incident/get-incident.mjs

@@ -4,7 +4,7 @@ export default {
   key: "topdesk-get-incident",
   name: "Get Incident",
   description: "Returns an incident by ID. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/getIncidentById)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/actions/get-incidents/get-incidents.mjs

@@ -4,7 +4,7 @@ export default {
   key: "topdesk-get-incidents",
   name: "Get Incidents",
   description: "Returns a list of incidents. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/getIncidents)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/actions/get-knowledge-item-statuses/get-knowledge-item-statuses.mjs

@@ -4,7 +4,7 @@ export default {
   key: "topdesk-get-knowledge-item-statuses",
   name: "Get Knowledge Item Statuses",
   description: "Returns the list of possible Knowledge Item statuses. [See the documentation](https://developers.topdesk.com/explorer/?page=knowledge-base#/Searchlists/getStatuses)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/actions/get-knowledge-items/get-knowledge-items.mjs

@@ -4,7 +4,7 @@ export default {
   key: "topdesk-get-knowledge-items",
   name: "Get Knowledge Items",
   description: "Returns a list of Knowledge Items. [See the documentation](https://developers.topdesk.com/explorer/?page=knowledge-base#/Knowledge%20Items/getKnowledgeItems)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/actions/update-incident/update-incident.mjs

@@ -4,7 +4,7 @@ export default {
   key: "topdesk-update-incident",
   name: "Update Incident",
   description: "Updates an existing incident. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/patchIncident)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/topdesk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pipedream TOPdesk Components",
   "main": "topdesk.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.1.0"
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/sources/common/base-polling.mjs

@@ -0,0 +1,99 @@
+import topdesk from "../../topdesk.app.mjs";
+import {
+  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL, ConfigurationError,
+} from "@pipedream/platform";
+
+export default {
+  props: {
+    topdesk,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastTs() {
+      return this.db.get("lastTs") || 0;
+    },
+    _setLastTs(lastTs) {
+      this.db.set("lastTs", lastTs);
+    },
+    _getPreviousValue() {
+      return this.db.get("previousValue");
+    },
+    _setPreviousValue(previousValue) {
+      this.db.set("previousValue", previousValue);
+    },
+    getArgs() {
+      return {};
+    },
+    getTsField() {
+      return "modificationDate";
+    },
+    paginateResults() {
+      return false;
+    },
+    isRelevant() {
+      return true;
+    },
+    async getPaginatedResources(opts = {}) {
+      const results = this.topdesk.paginate(opts);
+      const items = [];
+      for await (const result of results) {
+        items.push(result);
+      }
+      return items;
+    },
+    async processEvents(max) {
+      const lastTs = this._getLastTs();
+      let maxTs = lastTs;
+
+      const resourceFn = this.getResourceFn();
+      const args = this.getArgs();
+      const tsField = this.getTsField();
+
+      const results = this.paginateResults()
+        ? await this.getPaginatedResources({
+          fn: resourceFn,
+          fnArgs: args,
+          maxResults: max,
+        })
+        : [
+          await resourceFn(args),
+        ];
+
+      if (!results.length) {
+        return;
+      }
+
+      for (const result of results.reverse()) {
+        const ts = Date.parse(result[tsField]);
+        if (ts >= lastTs) {
+          maxTs = Math.max(ts, maxTs);
+          if (this.isRelevant(result)) {
+            this.$emit(result, this.generateMeta(result));
+          }
+        }
+      }
+
+      this._setLastTs(maxTs);
+    },
+    getResourceFn() {
+      throw new ConfigurationError("getResourceFn must be implemented");
+    },
+    generateMeta() {
+      throw new ConfigurationError("generateMeta must be implemented");
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.processEvents(10);
+    },
+  },
+  async run() {
+    await this.processEvents();
+  },
+};

package/sources/incident-updated/incident-updated.mjs

@@ -0,0 +1,28 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-incident-updated",
+  name: "Incident Updated",
+  description: "Emit new event when an incident is updated. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.listIncidents;
+    },
+    paginateResults() {
+      return true;
+    },
+    generateMeta(incident) {
+      const ts = Date.parse(incident.modificationDate);
+      return {
+        id: `${incident.id}-${ts}`,
+        summary: `Incident Updated: ${incident.id}`,
+        ts,
+      };
+    },
+  },
+};

package/sources/new-incident-assignee/new-incident-assignee.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-assignee",
+  name: "New Incident Assignee",
+  description: "Emit new event when an incident is assigned to a new user. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents_id__id_)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    incidentId: {
+      propDefinition: [
+        common.props.topdesk,
+        "incidentId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.getIncident;
+    },
+    getArgs() {
+      return {
+        incidentId: this.incidentId,
+      };
+    },
+    getTsField() {
+      return "modificationDate";
+    },
+    paginateResults() {
+      return false;
+    },
+    isRelevant(incident) {
+      const previousValue = this._getPreviousValue();
+      if (incident.operator?.id !== previousValue) {
+        this._setPreviousValue(incident.operator?.id);
+        return true;
+      }
+      return false;
+    },
+    generateMeta(incident) {
+      return {
+        id: incident.id,
+        summary: `New Incident Assignee: ${incident.operator?.name || `ID: ${incident.operator?.id}`}`,
+        ts: Date.parse(incident.modificationDate),
+      };
+    },
+  },
+};

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

@@ -0,0 +1,30 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-created",
+  name: "New Incident Created",
+  description: "Emit new event when a new incident is created. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.listIncidents;
+    },
+    getTsField() {
+      return "creationDate";
+    },
+    paginateResults() {
+      return true;
+    },
+    generateMeta(incident) {
+      return {
+        id: incident.id,
+        summary: `New Incident: ${incident.id}`,
+        ts: Date.parse(incident.creationDate),
+      };
+    },
+  },
+};

package/sources/new-incident-group-assigned/new-incident-group-assigned.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-group-assigned",
+  name: "New Incident Group Assigned",
+  description: "Emit new event when an incident is assigned to a new group. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents_id__id_)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    incidentId: {
+      propDefinition: [
+        common.props.topdesk,
+        "incidentId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.getIncident;
+    },
+    getArgs() {
+      return {
+        incidentId: this.incidentId,
+      };
+    },
+    getTsField() {
+      return "modificationDate";
+    },
+    paginateResults() {
+      return false;
+    },
+    isRelevant(incident) {
+      const previousValue = this._getPreviousValue();
+      if (incident.caller.department?.id !== previousValue) {
+        this._setPreviousValue(incident.caller.department?.id);
+        return true;
+      }
+      return false;
+    },
+    generateMeta(incident) {
+      return {
+        id: incident.id,
+        summary: `New Incident Group Assigned: ${incident.caller.department?.name || `ID: ${incident.caller.department?.id}`}`,
+        ts: Date.parse(incident.modificationDate),
+      };
+    },
+  },
+};

package/sources/new-incident-memo-reply/new-incident-memo-reply.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-memo-reply",
+  name: "New Incident Memo Reply",
+  description: "Emit new event when a new memo reply is created. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/progress%20trail%20%2F%20actions%20%2F%20requests/get_incidents_id__id__progresstrail)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    incidentId: {
+      propDefinition: [
+        common.props.topdesk,
+        "incidentId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.listProgressTrail;
+    },
+    getArgs() {
+      return {
+        incidentId: this.incidentId,
+      };
+    },
+    getTsField() {
+      return "creationDate";
+    },
+    paginateResults() {
+      return true;
+    },
+    isRelevant(item) {
+      const previousValue = this._getPreviousValue();
+      if (item.memoText !== previousValue) {
+        this._setPreviousValue(item.memoText);
+        return true;
+      }
+      return false;
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: `New Incident Memo Reply: ${item.memoText}`,
+        ts: Date.parse(item.creationDate),
+      };
+    },
+  },
+};

package/sources/new-incident-reply/new-incident-reply.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-reply",
+  name: "New Incident Reply",
+  description: "Emit new event when a new incident reply is created. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/progress%20trail%20%2F%20actions%20%2F%20requests/get_incidents_id__id__progresstrail)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    incidentId: {
+      propDefinition: [
+        common.props.topdesk,
+        "incidentId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.listProgressTrail;
+    },
+    getArgs() {
+      return {
+        incidentId: this.incidentId,
+      };
+    },
+    getTsField() {
+      return "creationDate";
+    },
+    paginateResults() {
+      return true;
+    },
+    isRelevant(item) {
+      const previousValue = this._getPreviousValue();
+      if (item.plainText !== previousValue) {
+        this._setPreviousValue(item.plainText);
+        return true;
+      }
+      return false;
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: `New Incident Reply: ${item.plainText}`,
+        ts: Date.parse(item.creationDate),
+      };
+    },
+  },
+};

package/sources/new-incident-status/new-incident-status.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-status",
+  name: "New Incident Status",
+  description: "Emit new event when an incident status is updated. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents_id__id_)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    incidentId: {
+      propDefinition: [
+        common.props.topdesk,
+        "incidentId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.getIncident;
+    },
+    getArgs() {
+      return {
+        incidentId: this.incidentId,
+      };
+    },
+    getTsField() {
+      return "modificationDate";
+    },
+    paginateResults() {
+      return false;
+    },
+    isRelevant(incident) {
+      const previousValue = this._getPreviousValue();
+      if (incident.processingStatus?.id !== previousValue) {
+        this._setPreviousValue(incident.processingStatus?.id);
+        return true;
+      }
+      return false;
+    },
+    generateMeta(incident) {
+      return {
+        id: incident.id,
+        summary: `New Incident Status: ${incident.processingStatus?.name || `ID: ${incident.processingStatus?.id}`}`,
+        ts: Date.parse(incident.modificationDate),
+      };
+    },
+  },
+};

package/topdesk.app.mjs

@@ -651,6 +651,14 @@ export default {
         ...opts,
       });
     },
+    listProgressTrail({
+      incidentId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/tas/api/incidents/id/${incidentId}/progresstrail`,
+        ...opts,
+      });
+    },
     async *paginate({
       fn,
       fnArgs = {},
@@ -665,7 +673,7 @@ export default {
           ...fnArgs,
           params: {
             ...fnArgs.params,
-            start: start + (fnArgs.params?.page_size || 100),
+            start,
             page_size: (fnArgs.params?.page_size || 100),
           },
         });