@pipedream/linear_app 0.5.4 → 0.5.6

package/README.md

@@ -1,8 +1,11 @@
 # Overview
 
-With the Linear API, you can manage your workflow, track issues, and automate
-your development process. Here are some examples of what you can build:
+Linear helps streamline software project management, bug tracking, and task coordination. By using the Linear (API key) API with Pipedream, you can automate routine tasks, sync issues across platforms, and trigger custom workflows. Think auto-assignment of tasks based on specific triggers or pushing updates to a Slack channel when an issue's status changes. These automations save time and ensure that your development team stays focused on coding rather than on administrative overhead.
 
-- A custom workflow management tool
-- A tool to track issues and feature requests
-- A development process automation tool
+# Example Use Cases
+
+- **Sync Issues with Google Sheets**: Use Pipedream to monitor new issues in Linear and automatically add them to a Google Sheets spreadsheet. This can help with reporting, auditing, and providing a high-level overview of tasks without needing to access Linear directly.
+
+- **Automate Task Assignment Based on Labels**: When a new issue is created in Linear with a specific label (e.g., "urgent"), you can set up a Pipedream workflow to automatically assign it to a designated team member or escalate it by creating a high-priority notification in your team's messaging app, like Slack or Microsoft Teams.
+
+- **Create GitHub Issues from Linear Tasks**: For development teams using both Linear and GitHub, a workflow can be set up to create a new GitHub issue whenever a Linear task reaches a certain stage or is tagged for development. This ensures that your code repository is always in sync with your project management tool.

package/actions/create-issue/create-issue.mjs

@@ -5,7 +5,7 @@ export default {
   key: "linear_app-create-issue",
   name: "Create Issue",
   description: "Create an issue (API Key). See the docs [here](https://developers.linear.app/docs/graphql/working-with-the-graphql-api#creating-and-editing-issues)",
-  version: "0.4.4",
+  version: "0.4.5",
   props: {
     linearApp,
     teamId: {
@@ -14,6 +14,15 @@ export default {
         "teamId",
       ],
     },
+    projectId: {
+      propDefinition: [
+        linearApp,
+        "projectId",
+        ({ teamId }) => ({
+          teamId,
+        }),
+      ],
+    },
     title: {
       propDefinition: [
         linearApp,
@@ -44,6 +53,8 @@ export default {
   },
   async run({ $ }) {
     const {
+      linearApp,
+      projectId,
       title,
       description,
       teamId,
@@ -52,8 +63,9 @@ export default {
     } = this;
 
     const response =
-      await this.linearApp.createIssue({
+      await linearApp.createIssue({
         teamId,
+        projectId,
         title,
         description,
         assigneeId,

package/actions/get-issue/get-issue.mjs

@@ -4,7 +4,7 @@ export default {
   key: "linear_app-get-issue",
   name: "Get Issue",
   description: "Get an issue by ID (API Key). See the docs [here](https://developers.linear.app/docs/graphql/working-with-the-graphql-api)",
-  version: "0.1.4",
+  version: "0.1.5",
   type: "action",
   props: {
     linearApp,
@@ -17,8 +17,15 @@ export default {
     },
   },
   async run({ $ }) {
-    const issue = await this.linearApp.getIssue(this.issueId);
-    $.export("$summary", `Found issue with ID ${this.issueId}`);
+    const {
+      linearApp,
+      issueId,
+    } = this;
+
+    const issue = await linearApp.getIssue({
+      issueId,
+    });
+    $.export("$summary", `Found issue with ID ${issueId}`);
     return issue;
   },
 };

package/actions/get-teams/get-teams.mjs

@@ -4,7 +4,7 @@ export default {
   key: "linear_app-get-teams",
   name: "Get Teams",
   description: "Get all the teams (API Key). See the docs [here](https://developers.linear.app/docs/graphql/working-with-the-graphql-api)",
-  version: "0.2.4",
+  version: "0.2.5",
   type: "action",
   props: {
     linearApp,

package/actions/search-issues/search-issues.mjs

@@ -6,7 +6,7 @@ export default {
   name: "Search Issues",
   description: "Search issues (API Key). See the docs [here](https://developers.linear.app/docs/graphql/working-with-the-graphql-api)",
   type: "action",
-  version: "0.2.4",
+  version: "0.2.5",
   props: {
     linearApp,
     query: {

package/actions/update-issue/update-issue.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Update Issue",
   description: "Update an issue (API Key). See the docs [here](https://developers.linear.app/docs/graphql/working-with-the-graphql-api#creating-and-editing-issues)",
   type: "action",
-  version: "0.1.4",
+  version: "0.1.5",
   props: {
     linearApp,
     teamId: {

package/common/constants.mjs

@@ -43,65 +43,6 @@ const ORDER_BY_OPTIONS = [
   },
 ];
 
-const ISSUE_NODES = `
-  id
-  title
-  description
-  boardOrder
-  branchName
-  createdAt
-  customerTicketCount
-  identifier
-  number
-  priority
-  priorityLabel
-  sortOrder
-  updatedAt
-  url
-  assignee {
-    id
-    name
-    email
-  }
-  creator {
-    id
-    name
-    email
-  }
-  project {
-    id
-    name
-  }
-  state {
-    id
-    name
-  }
-  team {
-    id
-    name
-  }
-`;
-
-const COMMENT_NODES = `
-  id
-  body
-  createdAt
-  reactionData
-  updatedAt
-  issue {
-    id
-    title
-    project {
-      id
-      name
-    }
-  }
-  user {
-    id
-    name
-  }
-`;
-
 export default {
   WEBHOOK_ID,
   LINEAR_DELIVERY_HEADER,
@@ -113,6 +54,4 @@ export default {
   CLIENT_IPS,
   ORDER_BY_OPTIONS,
   FIELD,
-  ISSUE_NODES,
-  COMMENT_NODES,
 };

package/common/fragments.mjs

@@ -0,0 +1,104 @@
+export default {
+  pageInfo: `
+    fragment PageInfo on PageInfo {
+      startCursor
+      endCursor
+      hasPreviousPage
+      hasNextPage
+    }
+  `,
+  issue: `
+    fragment Issue on Issue {
+      trashed
+      labelIds
+      url
+      identifier
+      priorityLabel
+      previousIdentifiers
+      customerTicketCount
+      branchName
+      botActor {
+        avatarUrl
+        name
+        userDisplayName
+        subType
+        type
+        id
+      }
+      cycle {
+        id
+      }
+      dueDate
+      estimate
+      description
+      title
+      number
+      lastAppliedTemplate {
+        id
+      }
+      updatedAt
+      sortOrder
+      subIssueSortOrder
+      parent {
+        id
+      }
+      priority
+      project {
+        id
+      }
+      projectMilestone {
+        id
+      }
+      team {
+        id
+      }
+      archivedAt
+      createdAt
+      startedTriageAt
+      triagedAt
+      autoArchivedAt
+      autoClosedAt
+      canceledAt
+      completedAt
+      startedAt
+      snoozedUntilAt
+      id
+      assignee {
+        id
+      }
+      creator {
+        id
+      }
+      snoozedBy {
+        id
+      }
+      favorite {
+        id
+      }
+      state {
+        id
+      }
+    }
+  `,
+  comment: `
+    fragment Comment on Comment {
+      id
+      body
+      createdAt
+      reactionData
+      updatedAt
+      issue {
+        id
+        title
+        project {
+          id
+          name
+        }
+      }
+      user {
+        id
+        name
+      }
+    }
+  `,
+};

package/common/queries.mjs

@@ -0,0 +1,60 @@
+import fragments from "./fragments.mjs";
+
+export default {
+  getIssue: `
+    query GetIssue($issueId: String!) {
+      issue(id: $issueId) {
+        ...Issue
+      }
+    }
+    ${fragments.issue}
+  `,
+  listIssues: `
+    query ListIssues(
+      $filter: IssueFilter,
+      $before: String,
+      $after: String,
+      $first: Int,
+      $last: Int,
+      $includeArchived: Boolean,
+      $orderBy: PaginationOrderBy
+    ) {
+      issues(
+        filter: $filter,
+        before: $before,
+        after: $after,
+        first: $first,
+        last: $last,
+        includeArchived: $includeArchived,
+        orderBy: $orderBy
+      ) {
+        pageInfo {
+          ...PageInfo
+        }
+        nodes {
+          ...Issue
+        }
+      }
+    }
+    ${fragments.issue}
+    ${fragments.pageInfo}
+  `,
+  getComment: `
+    query GetComment($commentId: String!) {
+      comment(id: $commentId) {
+        ...Comment
+      }
+    }
+    ${fragments.comment}
+  `,
+  listProjects: `
+    query ListProjects {
+      projects {
+        nodes {
+          id
+          name
+        }
+      }
+    }
+  `,
+};

package/linear_app.app.mjs

@@ -2,6 +2,7 @@ import { LinearClient } from "@linear/sdk";
 import constants from "./common/constants.mjs";
 import utils from "./common/utils.mjs";
 import { axios } from "@pipedream/platform";
+import queries from "./common/queries.mjs";
 
 export default {
   type: "app",
@@ -57,7 +58,9 @@ export default {
       label: "Project",
       description: "The identifier or key of the project associated with the issue",
       optional: true,
-      async options({ prevContext }) {
+      async options({
+        teamId, prevContext,
+      }) {
         return this.listResourcesOptions({
           prevContext,
           resourcesFn: this.listProjects,
@@ -67,6 +70,17 @@ export default {
             label: name,
             value: id,
           }),
+          resourcesArgs: teamId && {
+            filter: {
+              issues: {
+                team: {
+                  id: {
+                    eq: teamId,
+                  },
+                },
+              },
+            },
+          },
         });
       },
     },
@@ -172,7 +186,7 @@ export default {
         Authorization: `${this.$auth.api_key}`,
       };
     },
-    async makeAxiosRequest({
+    makeAxiosRequest({
       $ = this, ...args
     }) {
       return axios($, {
@@ -181,6 +195,12 @@ export default {
         ...args,
       });
     },
+    post(args = {}) {
+      return this.makeAxiosRequest({
+        method: "POST",
+        ...args,
+      });
+    },
     getClientOptions(options = {}) {
       return {
         apiKey: this.$auth.api_key,
@@ -205,18 +225,19 @@ export default {
       return this.client().updateIssue(issueId, input);
     },
     async listIssues(variables) {
-      return this.client().issues(variables);
+      const { data: { issues } } = await this.post({
+        data: {
+          query: queries.listIssues,
+          variables,
+        },
+      });
+      return issues;
     },
-    async getIssue(id) {
-      const { data: { issue } } = await this.makeAxiosRequest({
-        method: "POST",
+    async getIssue(variables) {
+      const { data: { issue } } = await this.post({
         data: {
-          query: `
-          { 
-            issue(id: "${id}") { 
-              ${constants.ISSUE_NODES}
-            } 
-          }`,
+          query: queries.getIssue,
+          variables,
         },
       });
       return issue;
@@ -236,11 +257,11 @@ export default {
     async listTeams(variables = {}) {
       return this.client().teams(variables);
     },
-    async listProjects() {
-      const { data: { projects } } = await this.makeAxiosRequest({
-        method: "POST",
+    async listProjects(variables) {
+      const { data: { projects } } = await this.post({
         data: {
-          query: "{ projects { nodes { id name } } }",
+          query: queries.listProjects,
+          variables,
         },
       });
       return projects;
@@ -257,16 +278,11 @@ export default {
     async listComments(variables = {}) {
       return this.client().comments(variables);
     },
-    async getComment(id) {
-      const { data: { comment } } = await this.makeAxiosRequest({
-        method: "POST",
+    async getComment(variables) {
+      const { data: { comment } } = await this.post({
         data: {
-          query: `
-          { 
-            comment(id: "${id}") { 
-              ${constants.COMMENT_NODES}
-            } 
-          }`,
+          query: queries.getComment,
+          variables,
         },
       });
       return comment;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/linear_app",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "Pipedream Linear_app Components",
   "main": "linear_app.app.mjs",
   "keywords": [
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@linear/sdk": "^2.6.0",
-    "@pipedream/platform": "^1.3.0"
+    "@linear/sdk": "^13.0.0",
+    "@pipedream/platform": "^3.0.3"
   }
 }

package/sources/comment-created-instant/comment-created-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Created Comment (Instant)",
   description: "Emit new event when a new comment is created. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.1.4",
+  version: "0.1.6",
   dedupe: "unique",
   methods: {
     ...common.methods,
@@ -26,7 +26,9 @@ export default {
       return false;
     },
     async isFromProject(body) {
-      const comment = await this.linearApp.getComment(body.data.id);
+      const comment = await this.linearApp.getComment({
+        commentId: body.data.id,
+      });
       return !this.projectId || comment?.issue?.project?.id == this.projectId;
     },
     getResourcesFnArgs() {

package/sources/common/webhook.mjs

@@ -1,6 +1,7 @@
 import linearApp from "../../linear_app.app.mjs";
 import constants from "../../common/constants.mjs";
 import utils from "../../common/utils.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   props: {
@@ -12,6 +13,7 @@ export default {
         linearApp,
         "teamId",
       ],
+      reloadProps: true,
     },
     projectId: {
       propDefinition: [
@@ -22,6 +24,17 @@ export default {
     http: "$.interface.http",
     db: "$.service.db",
   },
+  async additionalProps() {
+    const props = {};
+    if (!(await this.isAdmin())) {
+      props.alert = {
+        type: "alert",
+        alertType: "error",
+        content: "You must have an admin role to create or manage webhooks. See the Linear [documentation](https://linear.app/docs/api-and-webhooks#webhooks) for details.",
+      };
+    }
+    return props;
+  },
   methods: {
     setWebhookId(teamId, id) {
       this.db.set(`webhook-${teamId}`, id);
@@ -59,9 +72,26 @@ export default {
     getLoadedProjectId() {
       throw new Error("Get loaded project ID not implemented");
     },
+    async isAdmin() {
+      const { data } = await this.linearApp.makeAxiosRequest({
+        method: "POST",
+        data: {
+          "query": `{ 
+            user(id: "me") {
+              admin
+            }
+          }`,
+        },
+      });
+      return data?.user?.admin;
+    },
   },
   hooks: {
     async deploy() {
+      if (!(await this.isAdmin())) {
+        throw new ConfigurationError("You must have an admin role to create or manage webhooks. See the Linear [documentation](https://linear.app/docs/api-and-webhooks#webhooks) for details.");
+      }
+
       // Retrieve historical events
       console.log("Retrieving historical events...");
       const stream = this.linearApp.paginateResources({

package/sources/issue-created-instant/issue-created-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Created Issue (Instant)",
   description: "Emit new event when a new issue is created. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.3.4",
+  version: "0.3.6",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/issue-updated-instant/issue-updated-instant.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Updated Issue (Instant)",
   description: "Emit new event when an issue is updated. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.3.4",
+  version: "0.3.6",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-issue-status-updated/new-issue-status-updated.mjs

@@ -7,7 +7,7 @@ export default {
   name: "New Issue Status Updated (Instant)",
   description: "Emit new event when the status of an issue is updated. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.1.4",
+  version: "0.1.6",
   dedupe: "unique",
   props: {
     linearApp: common.props.linearApp,