@pipedream/vestaboard 0.0.2 → 0.1.1

package/actions/create-message/create-message.mjs

@@ -0,0 +1,63 @@
+import vestaboard from "../../vestaboard.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "vestaboard-create-message",
+  name: "Create Message",
+  description: "Creates a new message for a subscription. [See the docs](https://swagger.vestaboard.com/docs/vestaboard/b3A6MTYwMTA4OTc-post-v2-0-subscriptions-with-id-message)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    vestaboard,
+    subscriptionId: {
+      propDefinition: [
+        vestaboard,
+        "subscriptionId",
+      ],
+    },
+    text: {
+      type: "string",
+      label: "Text",
+      description: "The message to send to the specified Subscription. If text is specified, lines will be centered horizontally and vertically if possible. Character codes will be inferred for alphanumeric and punctuation, or can be explicitly specified in-line in the message with curly braces containing the character code. Either `text` or `characters` must be entered.",
+      optional: true,
+    },
+    characters: {
+      type: "string",
+      label: "Characters",
+      description: "A 6x22 two-dimensional array of character codes to send to the specified Subscription. If characters are specified, the characters will be shown in the exact position in the array. [See Character Code Reference](https://docs.vestaboard.com/characters). Either `text` or `characters` must be entered.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      subscriptionId,
+      text,
+      characters,
+    } = this;
+
+    if (!text && !characters) {
+      throw new ConfigurationError("Either `text` or `characters` must be entered");
+    }
+
+    const data = {};
+    if (text) {
+      data.text = text;
+    } else {
+      data.characters = Array.isArray(characters)
+        ? characters
+        : JSON.parse(characters);
+    }
+
+    const response = await this.vestaboard.createMessage({
+      subscriptionId,
+      data,
+      $,
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully created message with ID ${response.message.id}`);
+    }
+
+    return response;
+  },
+};

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

@@ -0,0 +1,23 @@
+import vestaboard from "../../vestaboard.app.mjs";
+
+export default {
+  key: "vestaboard-get-current-message",
+  name: "Get Current Message",
+  description: "Retrieves the current message. [See the docs](https://docs.vestaboard.com/read-write)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    vestaboard,
+  },
+  async run({ $ }) {
+    const response = await this.vestaboard.getCurrentMessage({
+      $,
+    });
+
+    if (response) {
+      $.export("$summary", "Successfully retrieved current message.");
+    }
+
+    return response;
+  },
+};

package/actions/get-subscriptions/get-subscriptions.mjs

@@ -0,0 +1,25 @@
+import vestaboard from "../../vestaboard.app.mjs";
+
+export default {
+  key: "vestaboard-get-subscriptions",
+  name: "Get Subscriptions",
+  description: "Get the list of subscriptions available to the viewer. [See the docs](https://swagger.vestaboard.com/docs/vestaboard/b3A6MTYwMTA4OTQ-get-v2-0-subscriptions)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    vestaboard,
+  },
+  async run({ $ }) {
+    const response = await this.vestaboard.listSubscriptions({
+      $,
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully retrieved ${response.subscriptions.length} subscription${response.subscriptions.length === 1
+        ? "s"
+        : ""}`);
+    }
+
+    return response;
+  },
+};

package/package.json

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

package/sources/new-current-message/new-current-message.mjs

@@ -0,0 +1,60 @@
+import vestaboard from "../../vestaboard.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  key: "vestaboard-new-current-message",
+  name: "New Current Message",
+  description: "Emit new event when a new message is displayed on a board. [See the docs](https://docs.vestaboard.com/read-write)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    vestaboard,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  hooks: {
+    async deploy() {
+      const { currentMessage } = await this.vestaboard.getCurrentMessage();
+      if (!currentMessage) {
+        return;
+      }
+      this.emitEvent(currentMessage);
+      this._setPreviousId(currentMessage.id);
+    },
+  },
+  methods: {
+    _getPreviousId() {
+      return this.db.get("previousId");
+    },
+    _setPreviousId(previousId) {
+      this.db.set("previousId", previousId);
+    },
+    generateMeta({ id }) {
+      const ts = Date.now();
+      return {
+        id: `${id}${ts}`,
+        summary: `New Message with ID ${id}`,
+        ts,
+      };
+    },
+    emitEvent(message) {
+      const meta = this.generateMeta(message);
+      this.$emit(message, meta);
+    },
+  },
+  async run() {
+    const previousId = this._getPreviousId();
+    const { currentMessage } = await this.vestaboard.getCurrentMessage();
+    if (!currentMessage || currentMessage.id === previousId) {
+      return;
+    }
+    this.emitEvent(currentMessage);
+    this._setPreviousId(currentMessage.id);
+  },
+};

package/vestaboard.app.mjs

@@ -0,0 +1,70 @@
+import { axios } from "@pipedream/platform";
+
+export default {
+  type: "app",
+  app: "vestaboard",
+  propDefinitions: {
+    subscriptionId: {
+      type: "string",
+      label: "Subscription",
+      description: "The ID of the Subscription to which to post",
+      async options() {
+        const { subscriptions } = await this.listSubscriptions();
+        return subscriptions?.map(({
+          _id, title,
+        }) => ({
+          label: title || _id,
+          value: _id,
+        })) || [];
+      },
+    },
+  },
+  methods: {
+    _baseUrl() {
+      return "https://platform.vestaboard.com/v2.0";
+    },
+    _headers() {
+      return {
+        "X-Vestaboard-Api-Key": this.$auth.api_key,
+        "X-Vestaboard-Api-Secret": this.$auth.api_secret,
+      };
+    },
+    async _makeRequest({
+      $ = this,
+      url,
+      headers,
+      path,
+      ...args
+    }) {
+      return axios($, {
+        url: url || `${this._baseUrl()}${path}`,
+        headers: headers || this._headers(),
+        ...args,
+      });
+    },
+    async getCurrentMessage(args = {}) {
+      return this._makeRequest({
+        url: "https://rw.vestaboard.com",
+        headers: {
+          "X-Vestaboard-Read-Write-Key": this.$auth.readwrite_api_key,
+        },
+        ...args,
+      });
+    },
+    listSubscriptions(args = {}) {
+      return this._makeRequest({
+        path: "/subscriptions",
+        ...args,
+      });
+    },
+    createMessage({
+      subscriptionId, ...args
+    } = {}) {
+      return this._makeRequest({
+        path: `/subscriptions/${subscriptionId}/message`,
+        method: "POST",
+        ...args,
+      });
+    },
+  },
+};