@pipedream/productlane 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Productlane API on Pipedream allows you to integrate and automate your product feedback loop. You can craft workflows to manage feature requests, prioritize product development, and engage with your user base more effectively. It's useful for product managers who want to streamline user feedback into actionable insights, and for development teams aiming to align their work with customer needs.
+
+# Example Use Cases
+
+- **Syncing Feature Requests to Project Management Tools**: Automatically create tasks in project management apps like Trello or Asana when new feature requests are submitted via Productlane.
+
+- **User Feedback Aggregation**: Gather and sort user feedback from Productlane, sending a daily or weekly digest to your team's Slack channel or email to keep everyone in the loop.
+
+- **Feature Launch Announcements**: When a feature moves to 'launched' status in Productlane, trigger a workflow to announce the update across multiple platforms, such as Twitter, company blog, or newsletter.

package/actions/create-contact/create-contact.mjs

@@ -0,0 +1,47 @@
+import productlane from "../../productlane.app.mjs";
+
+export default {
+  key: "productlane-create-contact",
+  name: "Create Contact",
+  description: "Creates a new contact with email, name, and an array of segments in Productlane. [See the documentation](https://productlane.com/docs/api-reference/contacts/create-contact)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    productlane,
+    email: {
+      propDefinition: [
+        productlane,
+        "email",
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the contact",
+      optional: true,
+    },
+    segments: {
+      type: "string[]",
+      label: "Segments",
+      description: "Array of segments",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.productlane.createContact({
+      $,
+      data: {
+        email: this.email,
+        name: this.name,
+        segments: this.segments,
+      },
+    });
+    $.export("$summary", `Successfully created contact ${this.email}`);
+    return response;
+  },
+};

package/actions/create-feedback/create-feedback.mjs

@@ -0,0 +1,105 @@
+import {
+  ORIGIN_OPTIONS, PAIN_LEVEL_OPTIONS,
+} from "../../common/constants.mjs";
+import productlane from "../../productlane.app.mjs";
+
+export default {
+  key: "productlane-create-feedback",
+  name: "Create Feedback",
+  description:
+    "Create new feedback in Productlane. [See the documentation](https://productlane.com/docs/api-reference/portal/create-feedback)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    productlane,
+    projectId: {
+      propDefinition: [
+        productlane,
+        "projectId",
+      ],
+    },
+    email: {
+      propDefinition: [
+        productlane,
+        "email",
+      ],
+      description: "The email for the feedback",
+    },
+    text: {
+      type: "string",
+      label: "Text",
+      description: "The text of the feedback",
+    },
+    notifyByEmail: {
+      propDefinition: [
+        productlane,
+        "notify",
+      ],
+      label: "Notify by Email",
+      description: "Whether to notify by email",
+    },
+    notifyBySlack: {
+      propDefinition: [
+        productlane,
+        "notify",
+      ],
+      label: "Notify by Slack",
+      description: "Whether to notify by slack",
+    },
+    origin: {
+      type: "string",
+      label: "Origin",
+      description: "The origin of the feedback",
+      optional: true,
+      options: ORIGIN_OPTIONS,
+    },
+    painLevel: {
+      type: "string",
+      label: "Pain Level",
+      description: "The pain level of the feedback",
+      options: PAIN_LEVEL_OPTIONS,
+    },
+  },
+  async run({ $ }) {
+    const {
+      email,
+      notifyByEmail,
+      notifyBySlack,
+      origin,
+      painLevel,
+      text,
+      projectId,
+    } = this;
+
+    const data = {
+      email: email,
+      notify: ((notifyByEmail ?? notifyBySlack) !== undefined)
+        ? {
+          email: notifyByEmail,
+          slack: notifyBySlack,
+        }
+        : undefined,
+      origin: origin,
+      painLevel: painLevel,
+      text: text,
+      projectId: projectId,
+    };
+
+    const response = await this.productlane.createFeedback({
+      $,
+      data,
+    });
+
+    $.export(
+      "$summary",
+      `Successfully created feedback with ID: ${response.id}`,
+    );
+
+    return response;
+  },
+};

package/actions/list-project-id-options/list-project-id-options.mjs

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

package/actions/upvote-project/upvote-project.mjs

@@ -0,0 +1,41 @@
+import productlane from "../../productlane.app.mjs";
+
+export default {
+  key: "productlane-upvote-project",
+  name: "Upvote Project",
+  description: "Upvotes a project by ID. [See the documentation](https://productlane.com/docs/api-reference/portal/upvote-project)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    productlane,
+    projectId: {
+      propDefinition: [
+        productlane,
+        "projectId",
+      ],
+    },
+    email: {
+      propDefinition: [
+        productlane,
+        "email",
+      ],
+      description: "The email associated with the upvote",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.productlane.upvoteProject({
+      $,
+      projectId: this.projectId,
+      data: {
+        email: this.email,
+      },
+    });
+    $.export("$summary", "Successfully upvoted project");
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,20 @@
+export const ORIGIN_OPTIONS = [
+  "INAPP",
+  "PORTAL",
+  "API",
+  "SLACK",
+  "INTERCOM",
+  "INTERCOM_ATTACHMENT",
+  "ZENDESK_ATTACHMENT",
+  "FRONT_ATTACHMENT",
+  "EMAIL",
+  "ZAPIER",
+  "HUBSPOT",
+];
+
+export const PAIN_LEVEL_OPTIONS = [
+  "UNKNOWN",
+  "LOW",
+  "MEDIUM",
+  "HIGH",
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/productlane",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream Productlane Components",
   "main": "productlane.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.6.8"
   }
 }

package/productlane.app.mjs

@@ -1,11 +1,83 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "productlane",
-  propDefinitions: {},
+  propDefinitions: {
+    projectId: {
+      type: "string",
+      label: "Project ID",
+      description: "The ID of the project. [See the documentation](https://productlane.com/docs/api-reference/portal/list-projects) for more information",
+      async options() {
+        const projects = await this.listProjects();
+        return projects.map((p) => ({
+          label: p.name,
+          value: p.id,
+        }));
+      },
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email of the contact",
+    },
+    notify: {
+      type: "boolean",
+      label: "Notify",
+      description: "Whether to notify",
+      optional: true,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://productlane.com/api/v1";
+    },
+    _workspaceId() {
+      return this.$auth.workspace_id;
+    },
+    async _makeRequest({
+      $ = this,
+      path,
+      headers,
+      ...otherOpts
+    }) {
+      return axios($, {
+        ...otherOpts,
+        url: this._baseUrl() + path,
+        headers: {
+          ...headers,
+          Authorization: `Bearer ${this.$auth.api_key}`,
+        },
+      });
+    },
+    async createContact(opts) {
+      return this._makeRequest({
+        ...opts,
+        path: "/contacts",
+        method: "POST",
+      });
+    },
+    async upvoteProject({
+      projectId, ...opts
+    }) {
+      return this._makeRequest({
+        ...opts,
+        path: `/projects/${projectId}/upvotes`,
+        method: "POST",
+      });
+    },
+    async createFeedback(opts) {
+      return this._makeRequest({
+        ...opts,
+        path: "/feedback",
+        method: "POST",
+      });
+    },
+    async listProjects() {
+      const { projects } = await this._makeRequest({
+        path: `/projects/${this._workspaceId()}`,
+      });
+      return projects;
     },
   },
-};
+};