@pipedream/upkeep 0.0.1

package/common/utils.mjs

@@ -0,0 +1,84 @@
+const pageSize = 25;
+
+export default {
+  parseOne(obj) {
+    let parsed;
+    try {
+      parsed = JSON.parse(obj);
+    } catch (e) {
+      parsed = obj;
+    }
+    return parsed;
+  },
+  parseObject(obj) {
+    if (typeof obj === "string")
+      obj = JSON.parse(obj);
+    let parsed = {};
+    for (let key in obj) {
+      if (typeof obj[key] != "object" && typeof obj[key] != "number")
+        parsed[key] = this.parseOne(obj[key].replace(/(['"])?([a-z0-9A-Z_]+)(['"])?:/g, "\"$2\": ")); //replacing single quotes with doubles
+      else
+        parsed[key] = obj[key];
+    }
+    return parsed;
+  },
+  parseArray(arr) {
+    const result = [];
+    if (!arr)
+      return arr;
+    for (let obj of arr) {
+      result.push(this.parseOne(obj));
+    }
+    return result;
+  },
+  async asyncPropHandler({
+    resourceFn, page, labelVal,
+  } = {}) {
+    let resp;
+    try {
+      resp = await resourceFn({
+        params: {
+          offset: page * pageSize,
+          limit: (page + 1) * pageSize,
+        },
+      });
+    } catch (err) {
+      return [];
+    }
+    return resp.results.map((item) => ({
+      label: typeof labelVal.label == "string" ?
+        item[labelVal.label] :
+        labelVal.label(item),
+      value: item[labelVal.value],
+    }));
+  },
+  async *getResourcesStream({
+    resourceFn,
+    resourceFnArgs,
+    resourceLimit,
+  }) {
+    let page = 0, resourceCount = 0;
+    while (true) {
+      try {
+        const nextResources = await resourceFn({
+          ...resourceFnArgs,
+          params: {
+            ...resourceFnArgs?.params,
+            offset: page * pageSize,
+            limit: ++page * pageSize,
+          },
+        });
+        if (!nextResources?.results?.length)
+          return;
+        for (const resource of nextResources.results) {
+          if (resourceLimit && resourceLimit < ++resourceCount)
+            return;
+          else
+            yield resource;
+        }
+      } catch (err) { //sometimes the API returns an empty list, sometimes it returns a 404
+        return;
+      }
+    }
+  },
+};

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@pipedream/upkeep",
+  "version": "0.0.1",
+  "description": "Pipedream Upkeep Components",
+  "main": "upkeep.app.mjs",
+  "keywords": [
+    "pipedream",
+    "upkeep"
+  ],
+  "homepage": "https://pipedream.com/apps/upkeep",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "dependencies": {
+    "@pipedream/platform": "^1.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/sources/common/common.mjs

@@ -0,0 +1,83 @@
+import app from "../../upkeep.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  props: {
+    app,
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    db: "$.service.db",
+  },
+  methods: {
+    _getHookID() {
+      return this.db.get("hookId");
+    },
+    _setHookID(hookID) {
+      this.db.set("hookId", hookID);
+    },
+    getEvents() {
+      throw new Error("getEvents is not implemented!");
+    },
+    getTitle() {
+      throw new Error("getTitle is not implemented!");
+    },
+    getSummary() {
+      throw new Error("getSummary is not implemented!");
+    },
+    getTime() {
+      throw new Error("getTime is not implemented!");
+    },
+    getHistoricalEventsFn() {
+      return false;
+    },
+    processMeta(item) {
+      return {
+        summary: this.getSummary(item),
+        id: item?.id,
+        ts: this.getTime(item),
+      };
+    },
+  },
+  hooks: {
+    async activate() {
+      const { webhookId } = await this.app.createWebhook({
+        title: this.getTitle(),
+        endpoint: this.http.endpoint,
+        events: this.getEvents(),
+      });
+      this._setHookID(webhookId);
+      console.log(`Created webhook. (Hook ID: ${webhookId}, endpoint: ${this.http.endpoint})`);
+    },
+    async deploy() {
+      const resourceFn = this.getHistoricalEventsFn();
+      if (!resourceFn)
+        return;
+      const resourcesStream = utils.getResourcesStream({
+        resourceFn,
+        resourceLimit: 10,
+      });
+      for await (const item of resourcesStream) {
+        this.$emit(
+          item,
+          this.processMeta(item),
+        );
+      }
+    },
+    async deactivate() {
+      await this.app.deleteWebhook({
+        webhookId: this._getHookID(),
+      });
+    },
+  },
+  async run(event) {
+    this.http.respond({
+      status: 200,
+    });
+    this.$emit(
+      event,
+      this.processMeta(event.body),
+    );
+  },
+};

package/sources/common/eventTypes.mjs

@@ -0,0 +1,82 @@
+export default [
+  {
+    label: "Work Order Created",
+    value: "WORK_ORDER_CREATED",
+  },
+  {
+    label: "Work Order Updated",
+    value: "WORK_ORDER_UPDATED",
+  },
+  {
+    label: "Work Order Status Updated",
+    value: "WORK_ORDER_STATUS_UPDATED",
+  },
+  {
+    label: "Work Order Deleted",
+    value: "WORK_ORDER_DELETED",
+  },
+  {
+    label: "PM Work Order Created",
+    value: "PM_WORK_ORDER_CREATED",
+  },
+  {
+    label: "PM Work Order Updated",
+    value: "PM_WORK_ORDER_UPDATED",
+  },
+  {
+    label: "PM Work Order Deleted",
+    value: "PM_WORK_ORDER_DELETED",
+  },
+  {
+    label: "Work Order Schedule Created",
+    value: "WORK_ORDER_SCHEDULE_CREATED",
+  },
+  {
+    label: "Work Order Schedule Updated",
+    value: "WORK_ORDER_SCHEDULE_UPDATED",
+  },
+  {
+    label: "Work Order Schedule Status Updated",
+    value: "WORK_ORDER_SCHEDULE_STATUS_UPDATED",
+  },
+  {
+    label: "Work Order Schedule Deleted",
+    value: "WORK_ORDER_SCHEDULE_DELETED",
+  },
+  {
+    label: "Purchase Order Updated",
+    value: "PURCHASE_ORDER_UPDATED",
+  },
+  {
+    label: "Purchase Order Created",
+    value: "PURCHASE_ORDER_CREATED",
+  },
+  {
+    label: "Purchase Order Deleted",
+    value: "PURCHASE_ORDER_DELETED",
+  },
+  {
+    label: "Purchase Order Approved",
+    value: "PURCHASE_ORDER_APPROVED",
+  },
+  {
+    label: "Purchase Order Declined",
+    value: "PURCHASE_ORDER_DECLINED",
+  },
+  {
+    label: "Request Created",
+    value: "REQUEST_CREATED",
+  },
+  {
+    label: "Request Updated",
+    value: "REQUEST_UPDATED",
+  },
+  {
+    label: "Request Approved",
+    value: "REQUEST_APPROVED",
+  },
+  {
+    label: "Request Rejected",
+    value: "REQUEST_REJECTED",
+  },
+];

package/sources/custom-events/custom-events.mjs

@@ -0,0 +1,36 @@
+import common from "../common/common.mjs";
+import eventTypes from "../common/eventTypes.mjs";
+
+export default {
+  key: "upkeep-new-custom-events",
+  name: "New Custom Event",
+  description: "Emit new event when a configured event occurs.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  ...common,
+  props: {
+    ...common.props,
+    events: {
+      type: "string[]",
+      label: "Event types",
+      description: "Select from available UpKeep event types.",
+      options: eventTypes,
+    },
+  },
+  methods: {
+    ...common.methods,
+    getTitle() {
+      return "Pipedream - New Events";
+    },
+    getEvents() {
+      return this.events;
+    },
+    getSummary(item) {
+      return `New custom event (ITEM ID:${item?.id})`;
+    },
+    getTime() {
+      return new Date().getTime();
+    },
+  },
+};

package/sources/new-purchase-order/new-purchase-order.mjs

@@ -0,0 +1,33 @@
+import common from "../common/common.mjs";
+
+export default {
+  key: "upkeep-new-purchase-order",
+  name: "New Purchase Order Event",
+  description: "Emit new event when a purchase order is created.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  ...common,
+  methods: {
+    ...common.methods,
+    getTitle() {
+      return "Pipedream - New Purchase Order";
+    },
+    getEvents() {
+      return [
+        "PURCHASE_ORDER_CREATED",
+      ];
+    },
+    getSummary(item) {
+      return `New purchase order(ID:${item?.id}, TITLE:${item?.title})`;
+    },
+    getTime(item) {
+      return item?.createdAt ?
+        new Date(item?.createdAt).getTime() :
+        new Date().getTime();
+    },
+    getHistoricalEventsFn() {
+      return this.app.getPurchaseOrders;
+    },
+  },
+};

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

@@ -0,0 +1,33 @@
+import common from "../common/common.mjs";
+
+export default {
+  key: "upkeep-new-request",
+  name: "New Request Event",
+  description: "Emit new event when a request is created.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  ...common,
+  methods: {
+    ...common.methods,
+    getTitle() {
+      return "Pipedream - New Request";
+    },
+    getEvents() {
+      return [
+        "REQUEST_CREATED",
+      ];
+    },
+    getSummary(item) {
+      return `New request (ID:${item?.id}, TITLE:${item?.title})`;
+    },
+    getTime(item) {
+      return item?.createdAt ?
+        new Date(item?.createdAt).getTime() :
+        new Date().getTime();
+    },
+    getHistoricalEventsFn() {
+      return this.app.getRequests;
+    },
+  },
+};

package/sources/new-work-order/new-work-order.mjs

@@ -0,0 +1,33 @@
+import common from "../common/common.mjs";
+
+export default {
+  key: "upkeep-new-work-order",
+  name: "New Work Order Event",
+  description: "Emit new event when a work order is created.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  ...common,
+  methods: {
+    ...common.methods,
+    getTitle() {
+      return "Pipedream - New Work Order";
+    },
+    getEvents() {
+      return [
+        "WORK_ORDER_CREATED",
+      ];
+    },
+    getSummary(item) {
+      return `New work order(ID:${item?.id}, TITLE:${item?.title})`;
+    },
+    getTime(item) {
+      return item?.createdAt ?
+        new Date(item?.createdAt).getTime() :
+        new Date().getTime();
+    },
+    getHistoricalEventsFn() {
+      return this.app.getWorkOrders;
+    },
+  },
+};

package/sources/purchase-order-status-changed/purchase-order-status-change.mjs

@@ -0,0 +1,36 @@
+import common from "../common/common.mjs";
+
+export default {
+  key: "upkeep-purchase-order-status-change",
+  name: "New Purchase Order Status Change Event",
+  description: "Emit new event when a purchase order status is changed.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  ...common,
+  methods: {
+    ...common.methods,
+    getTitle() {
+      return "Pipedream - Purchase Order Status Change";
+    },
+    getEvents() {
+      return [
+        "PURCHASE_ORDER_APPROVED",
+        "PURCHASE_ORDER_DECLINED",
+      ];
+    },
+    getSummary(item) {
+      // eslint-disable-next-line multiline-ternary
+      return `Purchase order(ID:${item?.id}, TITLE:${item?.title}) was ${item?.approvedAt ? "approved" : "declined"} at ${item?.approvedAt ?? item?.declinedAt}`;
+    },
+    getTime(item) {
+      const date = item?.approvedAt || item?.declinedAt;
+      return date ?
+        new Date(date).getTime() :
+        new Date().getTime();
+    },
+    getHistoricalEventsFn() {
+      return this.app.getPurchaseOrders;
+    },
+  },
+};

package/sources/request-approved/request-approved.mjs

@@ -0,0 +1,33 @@
+import common from "../common/common.mjs";
+
+export default {
+  key: "upkeep-request-approved",
+  name: "New Request Approved Event",
+  description: "Emit new event when a request is approved.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  ...common,
+  methods: {
+    ...common.methods,
+    getTitle() {
+      return "Pipedream - Request Approved";
+    },
+    getEvents() {
+      return [
+        "REQUEST_APPROVED",
+      ];
+    },
+    getSummary(item) {
+      return `Request(ID:${item?.id}, TITLE:${item?.title}) has been approved at ${item?.updatedAt}`;
+    },
+    getTime(item) {
+      return item?.updatedAt ?
+        new Date(item?.updatedAt).getTime() :
+        new Date().getTime();
+    },
+    getHistoricalEventsFn() {
+      return this.app.getRequests;
+    },
+  },
+};

package/sources/work-order-status-change/work-order-status-change.mjs

@@ -0,0 +1,33 @@
+import common from "../common/common.mjs";
+
+export default {
+  key: "upkeep-work-order-status-change",
+  name: "New Work Order Status Change Event",
+  description: "Emit new event when a work order status is changed.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  ...common,
+  methods: {
+    ...common.methods,
+    getTitle() {
+      return "Pipedream - Work Order Status Change";
+    },
+    getEvents() {
+      return [
+        "WORK_ORDER_STATUS_UPDATED",
+      ];
+    },
+    getSummary(item) {
+      return `Work order(ID:${item?.id}, TITLE:${item?.title}) status has been changed to ${item?.status}`;
+    },
+    getTime(item) {
+      return item?.updatedAt ?
+        new Date(item?.updatedAt).getTime() :
+        new Date().getTime();
+    },
+    getHistoricalEventsFn() {
+      return this.app.getWorkOrders;
+    },
+  },
+};