@pipedream/trackingtime 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The TrackingTime API enables the automation of time tracking, task management, and reporting processes. In Pipedream, you can use this API to create powerful workflows that connect TrackingTime with other apps to streamline productivity, enhance project management, and generate insights on time allocation. Automate tasks based on project activities, sync time entries with calendars, or trigger notifications based on tracked time data.
+
+# Example Use Cases
+
+- **Automatically Log Time for Scheduled Meetings**: Sync your TrackingTime projects with Google Calendar events. Whenever a new event starts, trigger a workflow that logs time in TrackingTime for the duration of the event, ensuring accurate time tracking for meetings.
+
+- **Generate Weekly Time Reports**: Set up a weekly scheduled workflow that retrieves time tracking data from TrackingTime and compiles it into a report. This report can then be sent via email using a service like SendGrid, keeping stakeholders updated on time investment and project progress.
+
+- **Project Management Integration**: When a task is marked as completed in a project management tool like Trello, trigger a workflow that automatically stops the corresponding time entry in TrackingTime. This keeps your time records in sync with project milestones and deliverables.

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

@@ -0,0 +1,24 @@
+import trackingtime from "../../trackingtime.app.mjs";
+
+export default {
+  key: "trackingtime-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: {
+    trackingtime,
+  },
+  async run({ $ }) {
+    const options = await trackingtime.propDefinitions.projectId.options.call(this.trackingtime);
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

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

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

package/actions/start-tracking-time/start-tracking-time.mjs

@@ -0,0 +1,91 @@
+import app from "../../trackingtime.app.mjs";
+
+export default {
+  name: "Start Tracking Time",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  key: "trackingtime-start-tracking-time",
+  description: "Start tracking time of a task. [See the documentation](https://api.trackingtime.co/doc/time_tracking.html#sync:~:text=Sync%20tracking%20event-,Start%20Tracking%20Time,-Starts%20a%20timer)",
+  type: "action",
+  props: {
+    app,
+    taskId: {
+      propDefinition: [
+        app,
+        "taskId",
+      ],
+    },
+    projectId: {
+      propDefinition: [
+        app,
+        "projectId",
+      ],
+      optional: true,
+    },
+    date: {
+      label: "Date",
+      description: "The event's start date. Format ISO 8601: `yyyy-MM-dd HH:mm:ss` like `2014-01-31 17:30:59`",
+      type: "string",
+      optional: true,
+    },
+    estimatedTime: {
+      label: "Estimated Time",
+      description: "Set a new estimated time for this task",
+      type: "string",
+      optional: true,
+    },
+    stopRunningTask: {
+      label: "Stop Running Task",
+      description: "If set to true, any currently running task will be stopped before the new one is started.",
+      type: "boolean",
+      optional: true,
+    },
+    returnTask: {
+      label: "Return Task",
+      description: "If set to true, a task object is returned",
+      type: "boolean",
+      optional: true,
+    },
+    tags: {
+      label: "Tags",
+      description: "An array of tags to be added to the newly created time entry. E.g. `[{\"n\":\"name\",\"c\":\"color\",\"v\":\"value\",\"t\":\"type\"}]`",
+      type: "boolean",
+      optional: true,
+    },
+    timezone: {
+      label: "Timezone",
+      description: "The user's timezone as `GMT+3` or `GMT+03:00`",
+      type: "string",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const tags = typeof this.tags === "string"
+      ? JSON.parse(this.tags)
+      : this.tags;
+
+    const response = await this.app.startTrackingTime({
+      $,
+      taskId: this.taskId,
+      params: {
+        date: this.date,
+        projectId: this.projectId,
+        return_task: this.returnTask,
+        stop_running_task: this.stopRunningTask,
+        estimated_time: this.estimatedTime,
+        timezone: this.timezone,
+        tags,
+      },
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully started tracking time of the task ID ${this.taskId}`);
+    }
+
+    return response;
+  },
+};

package/actions/stop-tracking-time/stop-tracking-time.mjs

@@ -0,0 +1,35 @@
+import app from "../../trackingtime.app.mjs";
+
+export default {
+  name: "Stop Tracking Time",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  key: "trackingtime-stop-tracking-time",
+  description: "Stop tracking time of a task. [See the documentation](https://api.trackingtime.co/doc/time_tracking.html#sync:~:text=Sync%20tracking%20event-,Start%20Tracking%20Time,-Starts%20a%20timer)",
+  type: "action",
+  props: {
+    app,
+    taskId: {
+      propDefinition: [
+        app,
+        "taskId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.stopTrackingTime({
+      $,
+      taskId: this.taskId,
+    });
+
+    if (response) {
+      $.export("$summary", `Successfully stopped tracking time of the task ID ${this.taskId}`);
+    }
+
+    return response;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/trackingtime",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream TrackingTime Components",
   "main": "trackingtime.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/trackingtime.app.mjs

@@ -1,11 +1,83 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "trackingtime",
-  propDefinitions: {},
+  propDefinitions: {
+    taskId: {
+      label: "Task ID",
+      description: "The task ID",
+      type: "string",
+      async options() {
+        const { data: tasks } = await this.getTasks();
+
+        return tasks.map((task) => ({
+          label: task.name,
+          value: task.id,
+        }));
+      },
+    },
+    projectId: {
+      label: "Project ID",
+      description: "The project ID",
+      type: "string",
+      async options() {
+        const { data: projects } = await this.getProjects();
+
+        return projects.map((task) => ({
+          label: task.name,
+          value: task.id,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _appPassword() {
+      return this.$auth.app_password;
+    },
+    _apiUrl() {
+      return "https://app.trackingtime.co/api/v4";
+    },
+    _makeRequest({
+      $ = this, path, ...args
+    }) {
+      return axios($, {
+        url: `${this._apiUrl()}${path}`,
+        ...args,
+        auth: {
+          username: "API_TOKEN",
+          password: this._appPassword(),
+        },
+      });
+    },
+    startTrackingTime({
+      taskId, args,
+    }) {
+      return this._makeRequest({
+        path: `/tasks/track/${taskId}`,
+        ...args,
+      });
+    },
+    stopTrackingTime({
+      taskId, args,
+    }) {
+      return this._makeRequest({
+        path: `/tasks/stop/${taskId}`,
+        method: "post",
+        ...args,
+      });
+    },
+    getTasks(args = {}) {
+      return this._makeRequest({
+        path: "/tasks",
+        ...args,
+      });
+    },
+    getProjects(args = {}) {
+      return this._makeRequest({
+        path: "/projects",
+        ...args,
+      });
     },
   },
-};
+};