@pipedream/pushcut 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Pushcut API enables the automation of iOS notifications with custom actions, triggering events based on various conditions. On Pipedream, you can harness this functionality to create intricate workflows, combining Pushcut notifications with a multitude of services to act based on data from APIs, schedules, or other apps. Think of Pushcut as a bridge between the real world and your digital tasks, letting you know when to act and offering shortcuts to execute specific automations directly from your iOS devices.
+
+# Example Use Cases
+
+- **Dynamic Notification for Calendar Events**: Send custom notifications for upcoming calendar events. By integrating with Google Calendar on Pipedream, you can schedule a workflow that fetches events and uses Pushcut to notify you with action buttons to check details or postpone events.
+
+- **Smart Home Alerts**: Combine Pushcut with IoT platforms like SmartThings. Set up a Pipedream workflow that listens for sensor triggers in your home—like motion or door openings—and then sends a Pushcut notification to your device with options to toggle devices or set modes.
+
+- **GitHub Repo Updates**: Stay on top of changes to your GitHub repositories. With a Pipedream workflow, get Pushcut notifications whenever there's a new commit, issue, or pull request. You can add action buttons to open the GitHub app, directly view the changes, or even run a CI/CD pipeline.

package/actions/execute-homekit-scene/execute-homekit-scene.mjs

@@ -0,0 +1,49 @@
+import pushcut from "../../pushcut.app.mjs";
+
+export default {
+  key: "pushcut-execute-homekit-scene",
+  name: "Execute Homekit Scene",
+  description: "Schedules an Automation Server action request for a homekit scene. [See the documentation](https://www.pushcut.io/webapi)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    pushcut,
+    homekit: {
+      propDefinition: [
+        pushcut,
+        "homekitScene",
+      ],
+    },
+    timeout: {
+      propDefinition: [
+        pushcut,
+        "timeout",
+      ],
+    },
+    delay: {
+      propDefinition: [
+        pushcut,
+        "delay",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.pushcut.executeAction({
+      data: {
+        homekit: this.homekit,
+        timeout: this.timeout,
+        delay: this.delay,
+      },
+      $,
+    });
+
+    $.export("$summary", `Successfully executed homekit ${this.homekit}.`);
+
+    return response;
+  },
+};

package/actions/execute-shortcut/execute-shortcut.mjs

@@ -0,0 +1,49 @@
+import pushcut from "../../pushcut.app.mjs";
+
+export default {
+  key: "pushcut-execute-shortcut",
+  name: "Execute Shortcut",
+  description: "Schedules an Automation Server action request for a shortcut. [See the documentation](https://www.pushcut.io/webapi)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    pushcut,
+    shortcut: {
+      propDefinition: [
+        pushcut,
+        "shortcut",
+      ],
+    },
+    timeout: {
+      propDefinition: [
+        pushcut,
+        "timeout",
+      ],
+    },
+    delay: {
+      propDefinition: [
+        pushcut,
+        "delay",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.pushcut.executeAction({
+      data: {
+        shortcut: this.shortcut,
+        timeout: this.timeout,
+        delay: this.delay,
+      },
+      $,
+    });
+
+    $.export("$summary", `Successfully executed shortcut ${this.shortcut}.`);
+
+    return response;
+  },
+};

package/actions/list-homekit-scene-options/list-homekit-scene-options.mjs

@@ -0,0 +1,26 @@
+import pushcut from "../../pushcut.app.mjs";
+
+export default {
+  key: "pushcut-list-homekit-scene-options",
+  name: "List Homekit Scene Options",
+  description: "Retrieves available options for the Homekit Scene field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    pushcut,
+  },
+  async run({ $ }) {
+    const options = await pushcut.propDefinitions.homekitScene.options.call(this.pushcut, {});
+    $.export("$summary", `Successfully retrieved ${options.length} option${
+      options.length === 1
+        ? ""
+        : "s"
+    }`);
+    return options;
+  },
+};

package/actions/list-notification-options/list-notification-options.mjs

@@ -0,0 +1,26 @@
+import pushcut from "../../pushcut.app.mjs";
+
+export default {
+  key: "pushcut-list-notification-options",
+  name: "List Notification Options",
+  description: "Retrieves available options for the Notification field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    pushcut,
+  },
+  async run({ $ }) {
+    const options = await pushcut.propDefinitions.notification.options.call(this.pushcut, {});
+    $.export("$summary", `Successfully retrieved ${options.length} option${
+      options.length === 1
+        ? ""
+        : "s"
+    }`);
+    return options;
+  },
+};

package/actions/list-shortcut-options/list-shortcut-options.mjs

@@ -0,0 +1,26 @@
+import pushcut from "../../pushcut.app.mjs";
+
+export default {
+  key: "pushcut-list-shortcut-options",
+  name: "List Shortcut Options",
+  description: "Retrieves available options for the Shortcut field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    pushcut,
+  },
+  async run({ $ }) {
+    const options = await pushcut.propDefinitions.shortcut.options.call(this.pushcut, {});
+    $.export("$summary", `Successfully retrieved ${options.length} option${
+      options.length === 1
+        ? ""
+        : "s"
+    }`);
+    return options;
+  },
+};

package/actions/send-notification/send-notification.mjs

@@ -0,0 +1,35 @@
+import pushcut from "../../pushcut.app.mjs";
+
+export default {
+  key: "pushcut-send-notification",
+  name: "Send Notification",
+  description: "Sends a smart notification to your devices. [See the documentation](https://www.pushcut.io/webapi)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    pushcut,
+    notification: {
+      propDefinition: [
+        pushcut,
+        "notification",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.pushcut.sendNotification({
+      notification: this.notification,
+      $,
+    });
+
+    if (response.id) {
+      $.export("$summary", `Successfully sent notification with ID ${response.id}.`);
+    }
+
+    return response;
+  },
+};

package/package.json

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

package/pushcut.app.mjs

@@ -0,0 +1,103 @@
+import { axios } from "@pipedream/platform";
+
+export default {
+  type: "app",
+  app: "pushcut",
+  propDefinitions: {
+    notification: {
+      type: "string",
+      label: "Notification",
+      description: "Name of the notification",
+      async options() {
+        const notifications = await this.listNotifications();
+        return notifications?.map(({ id }) => id ) || [];
+      },
+    },
+    shortcut: {
+      type: "string",
+      label: "Shortcut",
+      description: "Name of the shortcut",
+      async options() {
+        const shortcuts = await this.listShortcuts();
+        return shortcuts?.map(({ id }) => id ) || [];
+      },
+    },
+    homekitScene: {
+      type: "string",
+      label: "Homekit Scene",
+      description: "Name of the homekit scene",
+      async options() {
+        const scenes = await this.listHomekitScenes();
+        return scenes?.map(({ id }) => id ) || [];
+      },
+    },
+    timeout: {
+      type: "string",
+      label: "Timeout",
+      description: "Timeout in seconds, or 'nowait'",
+      optional: true,
+      default: "nowait",
+    },
+    delay: {
+      type: "string",
+      label: "Delay",
+      description: "Duration in which this request should be executed. Eg: 10s, 15m, 6h",
+      optional: true,
+    },
+  },
+  methods: {
+    _baseUrl() {
+      return "https://api.pushcut.io/v1";
+    },
+    _headers() {
+      return {
+        "API-Key": `${this.$auth.api_key}`,
+      };
+    },
+    _makeRequest({
+      $ = this,
+      path,
+      ...args
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: this._headers(),
+        ...args,
+      });
+    },
+    listNotifications(args = {}) {
+      return this._makeRequest({
+        path: "/notifications",
+        ...args,
+      });
+    },
+    listShortcuts(args = {}) {
+      return this._makeRequest({
+        path: "/shortcuts",
+        ...args,
+      });
+    },
+    listHomekitScenes(args = {}) {
+      return this._makeRequest({
+        path: "/scenes",
+        ...args,
+      });
+    },
+    executeAction(args = {}) {
+      return this._makeRequest({
+        path: "/execute",
+        method: "POST",
+        ...args,
+      });
+    },
+    sendNotification({
+      notification, ...args
+    }) {
+      return this._makeRequest({
+        path: `/notifications/${notification}`,
+        method: "POST",
+        ...args,
+      });
+    },
+  },
+};

package/sources/action-created/action-created.mjs

@@ -0,0 +1,47 @@
+import pushcut from "../../pushcut.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  key: "pushcut-action-created",
+  name: "New Action Created",
+  description: "Emit new event when a new action is created.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    pushcut,
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    actionType: {
+      type: "string",
+      label: "Type",
+      description: "Type of new action to watch for",
+      options: [
+        "shortcut",
+        "homekit",
+      ],
+    },
+  },
+  methods: {
+    generateMeta(action) {
+      return {
+        id: action.id,
+        summary: `${action.id}`,
+        ts: Date.now(),
+      };
+    },
+  },
+  async run() {
+    const actions = this.actionType === "shortcut"
+      ? await this.pushcut.listShortcuts()
+      : await this.pushcut.listHomekitScenes();
+    for (const action of actions) {
+      const meta = this.generateMeta(action);
+      this.$emit(action, meta);
+    }
+  },
+};