[Components] offlight #14052

luancazarine · luancazarine · commit a22d530ac089 · 2024-09-23T17:15:26.000-03:00
Sources
 - New Task Done (Instant)

Actions
 - Create Task
diff --git a/components/offlight/actions/create-task/create-task.mjs b/components/offlight/actions/create-task/create-task.mjs
@@ -1,64 +1,60 @@
 import offlight from "../../offlight.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "offlight-create-task",
   name: "Create Task",
   description: "Initiates the creation of a new task in Offlight. [See the documentation](https://www.offlight.work/docs/zapeir-api)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     offlight,
     taskName: {
-      propDefinition: [
-        offlight,
-        "taskName",
-      ],
+      type: "string",
+      label: "Task Name",
+      description: "The name of the task.",
     },
     taskNote: {
-      propDefinition: [
-        offlight,
-        "taskNote",
-      ],
+      type: "string",
+      label: "Task Note",
+      description: "A note about the task.",
       optional: true,
     },
     taskDeadline: {
-      propDefinition: [
-        offlight,
-        "taskDeadline",
-      ],
+      type: "string",
+      label: "Task Deadline",
+      description: "The deadline of the task. **In ISO 8601 format (YYY-MM-DD)**.",
       optional: true,
     },
     identifier: {
-      propDefinition: [
-        offlight,
-        "identifier",
-      ],
+      type: "string",
+      label: "Identifier",
+      description: "A unique identifier for the task.",
       optional: true,
     },
     sourceName: {
-      propDefinition: [
-        offlight,
-        "sourceName",
-      ],
+      type: "string",
+      label: "Source Name",
+      description: "The source name of the task.",
       optional: true,
     },
     sourceLink: {
-      propDefinition: [
-        offlight,
-        "sourceLink",
-      ],
+      type: "string",
+      label: "Source Link",
+      description: "The source link of the task.",
       optional: true,
     },
   },
   async run({ $ }) {
     const response = await this.offlight.createTask({
-      taskName: this.taskName,
-      taskNote: this.taskNote,
-      taskDeadline: this.taskDeadline,
-      identifier: this.identifier,
-      sourceName: this.sourceName,
-      sourceLink: this.sourceLink,
+      $,
+      data: {
+        task_name: this.taskName,
+        task_note: this.taskNote,
+        task_deadline: this.taskDeadline,
+        identifier: this.identifier,
+        source_name: this.sourceName,
+        source_link: this.sourceLink,
+      },
     });
 
     $.export("$summary", `Task successfully created with ID: ${response.id}`);
diff --git a/components/offlight/offlight.app.mjs b/components/offlight/offlight.app.mjs
@@ -3,104 +3,51 @@ import { axios } from "@pipedream/platform";
 export default {
   type: "app",
   app: "offlight",
-  propDefinitions: {
-    taskName: {
-      type: "string",
-      label: "Task Name",
-      description: "The name of the task.",
-    },
-    taskNote: {
-      type: "string",
-      label: "Task Note",
-      description: "A note about the task.",
-      optional: true,
-    },
-    taskDeadline: {
-      type: "string",
-      label: "Task Deadline",
-      description: "The deadline of the task (in ISO 8601 format).",
-      optional: true,
-    },
-    identifier: {
-      type: "string",
-      label: "Identifier",
-      description: "A unique identifier for the task.",
-      optional: true,
-    },
-    sourceName: {
-      type: "string",
-      label: "Source Name",
-      description: "The source name of the task.",
-      optional: true,
-    },
-    sourceLink: {
-      type: "string",
-      label: "Source Link",
-      description: "The source link of the task.",
-      optional: true,
-    },
-  },
   methods: {
-    authKeys() {
-      console.log(Object.keys(this.$auth));
-    },
     _baseUrl() {
-      return "https://www.offlight.work";
+      return "https://api.offlight.work";
+    },
+    _headers() {
+      return {
+        "x-api-key": `${this.$auth.api_token}`,
+      };
     },
-    async _makeRequest(opts = {}) {
-      const {
-        $ = this,
-        method = "GET",
-        path = "/",
-        headers,
-        ...otherOpts
-      } = opts;
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
       return axios($, {
-        ...otherOpts,
-        method,
         url: this._baseUrl() + path,
-        headers: {
-          ...headers,
-          "X-API-KEY": this.$auth.api_key,
-        },
+        headers: this._headers(),
+        ...opts,
       });
     },
-    async createTask({
-      taskName,
-      taskNote,
-      taskDeadline,
-      identifier,
-      sourceName,
-      sourceLink,
-    }) {
+    createTask(opts = {}) {
       return this._makeRequest({
         method: "POST",
         path: "/zapier/task",
-        data: {
-          task_name: taskName,
-          task_note: taskNote,
-          task_deadline: taskDeadline,
-          identifier: identifier,
-          source_name: sourceName,
-          source_link: sourceLink,
-        },
+        ...opts,
       });
     },
-    async getDoneTasks(opts = {}) {
+    getDoneTasks(opts = {}) {
       return this._makeRequest({
         ...opts,
         method: "GET",
         path: "/zapier/doneTasks",
       });
     },
-    async paginate(fn, ...opts) {
-      let results = [];
-      let response;
-      do {
-        response = await fn(...opts);
-        results = results.concat(response);
-      } while (response.length);
-      return results;
+    createWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/zapier/webhook",
+        ...opts,
+      });
+    },
+    deleteWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: "/zapier/webhook",
+        ...opts,
+      });
     },
   },
 };
diff --git a/components/offlight/package.json b/components/offlight/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/offlight",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream OFFLIGHT Components",
   "main": "offlight.app.mjs",
   "keywords": [
@@ -11,5 +11,9 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.1"
   }
 }
+
diff --git a/components/offlight/sources/new-task-done-instant/new-task-done-instant.mjs b/components/offlight/sources/new-task-done-instant/new-task-done-instant.mjs
@@ -1,50 +1,55 @@
 import offlight from "../../offlight.app.mjs";
-import { axios } from "@pipedream/platform";
+import sampleEmit from "./test-event.mjs";
 
 export default {
   key: "offlight-new-task-done-instant",
-  name: "New Task Done Instant",
-  description: "Emit new event when a task is marked as complete. [See the documentation](https://www.offlight.work/docs/zapeir-api)",
-  version: "0.0.{{ts}}",
+  name: "New Task Done (Instant)",
+  description: "Emit new event when a task is marked as complete.",
+  version: "0.0.1",
   type: "source",
   dedupe: "unique",
   props: {
-    offlight: {
-      type: "app",
-      app: "offlight",
-    },
+    offlight,
     http: {
       type: "$.interface.http",
-      customResponse: false,
     },
     db: "$.service.db",
   },
+  methods: {
+    emitTask(task) {
+      this.$emit(task, {
+        id: task.id,
+        summary: `Task ${task.name} marked as done`,
+        ts: Date.parse(task.doneAt),
+      });
+    },
+  },
   hooks: {
     async deploy() {
-      const tasks = await this.offlight.getDoneTasks({
-        max: 50,
-      });
+      const tasks = await this.offlight.getDoneTasks();
       for (const task of tasks) {
-        this.$emit(task, {
-          id: task.id,
-          summary: `Task ${task.name} marked as done`,
-          ts: Date.parse(task.doneAt),
-        });
+        this.emitTask(task);
       }
     },
     async activate() {
-      // No specific activation for this component
+      await this.offlight.createWebhook({
+        data: {
+          purpose: "doneTask",
+          hookUrl: this.http.endpoint,
+        },
+      });
     },
     async deactivate() {
-      // No specific deactivation for this component
+      await this.offlight.deleteWebhook({
+        data: {
+          purpose: "doneTask",
+          hookUrl: this.http.endpoint,
+        },
+      });
     },
   },
-  async run(event) {
-    const { body: task } = event;
-    this.$emit(task, {
-      id: task.id,
-      summary: `Task ${task.name} marked as done`,
-      ts: Date.parse(task.doneAt),
-    });
+  async run({ body }) {
+    this.emitTask(body);
   },
+  sampleEmit,
 };
diff --git a/components/offlight/sources/new-task-done-instant/test-event.mjs b/components/offlight/sources/new-task-done-instant/test-event.mjs
@@ -0,0 +1,18 @@
+export default {
+  "createdAt": "2024-09-23T19:18:54.995Z",
+  "updatedAt": "2024-09-23T20:10:26.000Z",
+  "plannedDate": null,
+  "doneAt": "2024-09-23T20:10:25.136Z",
+  "deletedAt": null,
+  "id": "4e73c28d-0e2f-4352-9c86-62048255e1b8",
+  "name": "🤵 Welcome to OFFLIGHT",
+  "note": null,
+  "status": "done",
+  "deadline": null,
+  "goal": null,
+  "source": "admin",
+  "identifier": null,
+  "sourceName": null,
+  "link": null,
+  "creator": null
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@pipedream/offlight",`
`3`		`- "version": "0.0.1",`
	`3`	`+ "version": "0.1.0",`
`4`	`4`	`"description": "Pipedream OFFLIGHT Components",`
`5`	`5`	`"main": "offlight.app.mjs",`
`6`	`6`	`"keywords": [`
`@@ -11,5 +11,9 @@`
`11`	`11`	`"author": "Pipedream <[email protected]> (https://pipedream.com/)",`
`12`	`12`	`"publishConfig": {`
`13`	`13`	`"access": "public"`
	`14`	`+ },`
	`15`	`+ "dependencies": {`
	`16`	`+ "@pipedream/platform": "^3.0.1"`
`14`	`17`	`}`
`15`	`18`	`}`
	`19`	`+`