@pipedream/linear_app 0.3.3 → 0.4.1

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.3.3",
+  version: "0.3.5",
   props: {
     linearApp,
     teamId: {
@@ -49,11 +49,10 @@ export default {
         assigneeId,
       });
 
-    if (response.success) {
-      $.export("summary", `Created issue ${response._issue.id}`);
-    } else {
-      $.export("summary", "Failed to create issue");
-    }
+    const summary = response.success
+      ? `Created issue ${response._issue.id}`
+      : "Failed to create issue";
+    $.export("$summary", summary);
 
     return response;
   },

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

@@ -0,0 +1,24 @@
+import linearApp from "../../linear_app.app.mjs";
+
+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.0.2",
+  type: "action",
+  props: {
+    linearApp,
+    issueId: {
+      propDefinition: [
+        linearApp,
+        "issueId",
+      ],
+      description: "The issue ID",
+    },
+  },
+  async run({ $ }) {
+    const issue = await this.linearApp.getIssue(this.issueId);
+    $.export("$summary", `Found issue with ID ${this.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.1.3",
+  version: "0.1.4",
   type: "action",
   props: {
     linearApp,
@@ -12,7 +12,7 @@ export default {
   async run({ $ }) {
     const { nodes: teams } = await this.linearApp.listTeams();
 
-    $.export("summary", `Found ${teams.length} teams(s)`);
+    $.export("$summary", `Found ${teams.length} teams(s)`);
 
     return teams;
   },

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

@@ -1,3 +1,4 @@
+import constants from "../../common/constants.mjs";
 import linearApp from "../../linear_app.app.mjs";
 
 export default {
@@ -5,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.1.0",
+  version: "0.1.3",
   props: {
     linearApp,
     query: {
@@ -85,7 +86,7 @@ export default {
       includeArchived,
     } = this;
 
-    let issues = [];
+    const issues = [];
     let hasNextPage;
     let after;
     const filter = this.buildFilter();
@@ -101,15 +102,16 @@ export default {
           orderBy,
           after,
           includeArchived,
+          first: constants.DEFAULT_LIMIT,
         },
       });
 
-      issues = issues.concat(nodes);
+      issues.push(...nodes);
       after = pageInfo.endCursor;
       hasNextPage = pageInfo.hasNextPage;
     } while (hasNextPage);
 
-    $.export("summary", `Found ${issues.length} issues`);
+    $.export("$summary", `Found ${issues.length} issues`);
 
     return issues;
   },

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.0.2",
+  version: "0.0.4",
   props: {
     linearApp,
     issueId: {
@@ -62,11 +62,10 @@ export default {
         },
       });
 
-    if (response.success) {
-      $.export("summary", `Updated issue ${response._issue.id}`);
-    } else {
-      $.export("summary", "Failed to update issue");
-    }
+    const summary = response.summary
+      ? `Updated issue ${response._issue.id}`
+      : "Failed to update issue";
+    $.export("$summary", summary);
 
     return response;
   },

package/linear_app.app.mjs

@@ -25,7 +25,7 @@ export default {
     teamId: {
       type: "string",
       label: "Team ID",
-      description: "The identifier or key of the team associated with the issue.",
+      description: "The identifier or key of the team associated with the issue",
       async options({ prevContext }) {
         return this.listResourcesOptions({
           prevContext,
@@ -42,7 +42,7 @@ export default {
     projectId: {
       type: "string",
       label: "Project ID",
-      description: "The identifier or key of the project associated with the issue.",
+      description: "The identifier or key of the project associated with the issue",
       optional: true,
       async options({ prevContext }) {
         return this.listResourcesOptions({
@@ -65,7 +65,7 @@ export default {
     assigneeId: {
       type: "string",
       label: "Assignee ID",
-      description: "The identifier of the user to assign the issue to.",
+      description: "The identifier of the user to assign the issue to",
       optional: true,
       async options({ prevContext }) {
         return this.listResourcesOptions({
@@ -83,19 +83,19 @@ export default {
     boardOrder: {
       type: "string",
       label: "Board order",
-      description: "The position of the issue in its column on the board view.",
+      description: "The position of the issue in its column on the board view",
       optional: true,
     },
     issueDescription: {
       type: "string",
       label: "Description",
-      description: "The issue description in markdown format.",
+      description: "The issue description in markdown format",
       optional: true,
     },
     issueLabels: {
       type: "string[]",
       label: "Issue Labels",
-      description: "The labels in the issue.",
+      description: "The labels in the issue",
       optional: true,
       async options({ prevContext }) {
         return this.listResourcesOptions({
@@ -108,7 +108,7 @@ export default {
     query: {
       type: "string",
       label: "Query",
-      description: "Search string to look for.",
+      description: "Search string to look for",
     },
     orderBy: {
       type: "string",
@@ -120,7 +120,7 @@ export default {
     includeArchived: {
       type: "boolean",
       label: "Include archived",
-      description: "Should archived resources be included (default: `false`).",
+      description: "Should archived resources be included? (default: `false`)",
       optional: true,
     },
   },
@@ -153,6 +153,9 @@ export default {
     }) {
       return this.client().issueSearch(query, variables);
     },
+    async getIssue(id) {
+      return this.client().issue(id);
+    },
     async listTeams(variables = {}) {
       return this.client().teams(variables);
     },
@@ -168,6 +171,9 @@ export default {
     async listIssueLabels(variables = {}) {
       return this.client().issueLabels(variables);
     },
+    async listComments(variables = {}) {
+      return this.client().comments(variables);
+    },
     async listResourcesOptions({
       prevContext, resourcesFn, resouceMapper,
     }) {
@@ -197,5 +203,42 @@ export default {
         },
       };
     },
+    async *paginateResources({ resourcesFn }) {
+      const params = {
+        after: null,
+        first: constants.DEFAULT_LIMIT,
+      };
+      let hasNextPage = true;
+      do {
+        const {
+          nodes,
+          pageInfo,
+        } = await resourcesFn(params);
+        for (const d of nodes) {
+          yield d;
+        }
+        hasNextPage = pageInfo.hasNextPage;
+        if (hasNextPage) {
+          params.after = pageInfo.endCursor;
+        }
+      } while (hasNextPage);
+    },
+    isActionSet(body, actions) {
+      if (!actions.includes(body?.action)) {
+        return false;
+      }
+      return true;
+    },
+    async isProjectIdSet(body, projectId) {
+      if (projectId) {
+        if (!body.data?.projectId) {
+          const issue = body.data?.issue?.id && await this.getIssue(body.data?.issue?.id);
+          return issue?._project?.id === projectId;
+        } else {
+          return body.data.projectId === projectId;
+        }
+      }
+      return true;
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/linear_app",
-  "version": "0.3.3",
+  "version": "0.4.1",
   "description": "Pipedream Linear_app Components",
   "main": "linear_app.app.mjs",
   "keywords": [

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

@@ -0,0 +1,47 @@
+import common from "../common/webhook.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  ...common,
+  key: "linear_app-comment-created-instant",
+  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.0.3",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceTypes() {
+      return [
+        constants.RESOURCE_TYPE.COMMENT,
+      ];
+    },
+    getWebhookLabel() {
+      return "Comment created";
+    },
+    getActions() {
+      return [
+        constants.ACTION.CREATE,
+      ];
+    },
+    getResourcesFn() {
+      return this.linearApp.listComments;
+    },
+    async getLoadedProjectId(event) {
+      return event?._project?.id
+        || (await this.linearApp.getIssue(event?._issue?.id))?._project?.id;
+    },
+    getMetadata(resource) {
+      const {
+        delivery,
+        data,
+        createdAt,
+      } = resource;
+      return {
+        id: delivery,
+        summary: `New comment event created: ${data.body}`,
+        ts: Date.parse(createdAt),
+      };
+    },
+  },
+};

package/sources/common/webhook.mjs

@@ -4,37 +4,24 @@ import constants from "../../common/constants.mjs";
 export default {
   props: {
     linearApp,
-    teamId: {
+    teamIds: {
+      label: "Team IDs",
+      type: "string[]",
       propDefinition: [
         linearApp,
         "teamId",
       ],
       optional: true,
     },
-    projectId: {
-      propDefinition: [
-        linearApp,
-        "projectId",
-      ],
-    },
     http: "$.interface.http",
     db: "$.service.db",
   },
   methods: {
-    setWebhookId(id) {
-      this.db.set(constants.WEBHOOK_ID, id);
+    setWebhookId(teamId, id) {
+      this.db.set(`webhook-${teamId}`, id);
     },
-    getWebhookId() {
-      return this.db.get(constants.WEBHOOK_ID);
-    },
-    isRelevant(body) {
-      if (!this.getActions().includes(body?.action)) {
-        return false;
-      }
-      if (this.projectId) {
-        return body.data.projectId === this.projectId;
-      }
-      return true;
+    getWebhookId(teamId) {
+      return this.db.get(`webhook-${teamId}`);
     },
     isWebhookValid(clientIp) {
       return constants.CLIENT_IPS.includes(clientIp);
@@ -51,8 +38,39 @@ export default {
     getMetadata() {
       throw new Error("getMetadata is not implemented");
     },
+    getResourcesFn() {
+      throw new Error("Get resource function not implemented");
+    },
+    getLoadedProjectId() {
+      throw new Error("Get loaded project ID not implemented");
+    },
   },
   hooks: {
+    async deploy() {
+      // Retrieve historical events
+      console.log("Retrieving historical events...");
+      const events = this.linearApp.paginateResources({
+        resourcesFn: this.getResourcesFn(),
+      });
+      for await (const event of events) {
+        const loadedProjectId = await this.getLoadedProjectId(event);
+        if (this.projectId && loadedProjectId !== this.projectId) {
+          continue;
+        }
+        event.projectId = loadedProjectId;
+        const [
+          action,
+        ] = this.getActions();
+        const [
+          resourceType,
+        ] = this.getResourceTypes();
+        this.$emit(event, {
+          id: event.id,
+          ts: Date.parse(event.updatedAt),
+          summary: `New ${action} ${resourceType} event: ${event.id}`,
+        });
+      }
+    },
     async activate() {
       const params = {
         resourceTypes: this.getResourceTypes(),
@@ -60,19 +78,18 @@ export default {
         label: this.getWebhookLabel(),
       };
 
-      if (this.teamId) {
-        params.teamId = this.teamId;
-      } else {
-        params.allPublicTeams = true;
+      for (const teamId of this.teamIds) {
+        params.teamId = teamId;
+        const { _webhook: webhook } = await this.linearApp.createWebhook(params);
+        this.setWebhookId(teamId, webhook.id);
       }
-
-      const { _webhook: webhook } = await this.linearApp.createWebhook(params);
-      this.setWebhookId(webhook.id);
     },
     async deactivate() {
-      const webhookId = this.getWebhookId();
-      if (webhookId) {
-        await this.linearApp.deleteWebhook(webhookId);
+      for (const teamId of this.teamIds) {
+        const webhookId = this.getWebhookId(teamId);
+        if (webhookId) {
+          await this.linearApp.deleteWebhook(webhookId);
+        }
       }
     },
   },
@@ -95,9 +112,7 @@ export default {
       return;
     }
 
-    if (this.isRelevant(body)) {
-      const meta = this.getMetadata(resource);
-      this.$emit(body, meta);
-    }
+    const meta = this.getMetadata(resource);
+    this.$emit(body, meta);
   },
 };

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.1.0",
+  version: "0.2.2",
   dedupe: "unique",
   methods: {
     ...common.methods,
@@ -24,6 +24,13 @@ export default {
         constants.ACTION.CREATE,
       ];
     },
+    getResourcesFn() {
+      return this.linearApp.listIssues;
+    },
+    async getLoadedProjectId(event) {
+      return event?._project?.id
+        || (await this.linearApp.getIssue(event?.id))?._project?.id;
+    },
     getMetadata(resource) {
       const {
         delivery,

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.1.0",
+  version: "0.2.2",
   dedupe: "unique",
   methods: {
     ...common.methods,
@@ -24,6 +24,13 @@ export default {
         constants.ACTION.UPDATE,
       ];
     },
+    getResourcesFn() {
+      return this.linearApp.listIssues;
+    },
+    async getLoadedProjectId(event) {
+      return event?._project?.id
+        || (await this.linearApp.getIssue(event?.id))?._project?.id;
+    },
     getMetadata(resource) {
       const {
         delivery,