@divyacon/piece-clickup 0.0.0-stage → 0.1.0

package/src/lib/actions/tasks/create-subtask.ts

@@ -0,0 +1,217 @@
+import {
+  OAuth2PropertyValue,
+  Property,
+  createAction,
+} from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+import { MarkdownVariant } from '@agnocon/pieces-framework';
+
+import {
+  clickupCommon,
+  callClickUpApi,
+  listAccessibleCustomFields,
+} from '../../common';
+import { clickupAuth } from '../../auth';
+import { taskOutputSchema } from '../../output-schemas';
+
+export const createClickupSubtask = createAction({
+  auth: clickupAuth,
+  name: 'create_subtask',
+  description: 'Creates a subtask in ClickUp',
+  audience: 'both',
+  aiMetadata: { description: 'Create a child task nested under an existing parent task in a ClickUp list, with optional status, priority, assignees, dates, time estimate, and custom fields. Pick this when the new task must belong to a parent task; use Create Task for a standalone top-level task. Each call creates a new subtask, so it is not idempotent.', idempotent: false },
+  displayName: 'Create Subtask',
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    task_id: clickupCommon.task_id(),
+    name: Property.ShortText({
+      description: 'The name of the subtask to create',
+      displayName: 'Subtask Name',
+      required: true,
+    }),
+    status_id: clickupCommon.status_id(),
+    priority_id: clickupCommon.priority_id(),
+    assignee_id: clickupCommon.assignee_id(
+      false,
+      'Assignee Id',
+      'ID of assignee for Clickup Subtask'
+    ),
+    description: Property.LongText({
+      description: 'The description of the subtask to create',
+      displayName: 'Subtask Description',
+      required: false,
+    }),
+    is_markdown: Property.Checkbox({
+      description: 'Is the description in markdown format',
+      displayName: 'Is Markdown',
+      required: false,
+      defaultValue: false,
+    }),
+    due_date: Property.DateTime({
+      description: 'The due date of the subtask',
+      displayName: 'Due Date',
+      required: false,
+    }),
+    due_date_time: Property.Checkbox({
+      description: 'Whether to include time in the due date',
+      displayName: 'Due Date Time',
+      required: false,
+      defaultValue: false,
+    }),
+    start_date: Property.DateTime({
+      description: 'The start date of the subtask',
+      displayName: 'Start Date',
+      required: false,
+    }),
+    start_date_time: Property.Checkbox({
+      description: 'Whether to include time in the start date',
+      displayName: 'Start Date Time',
+      required: false,
+      defaultValue: false,
+    }),
+    time_estimate: Property.Number({
+      description: 'The time estimate for the subtask in milliseconds',
+      displayName: 'Time Estimate',
+      required: false,
+    }),
+    check_required_custom_fields: Property.Checkbox({
+      description: 'Re-enable required custom fields validation for the subtask',
+      displayName: 'Check Required Custom Fields',
+      required: false,
+      defaultValue: false,
+    }),
+    custom_fields_info: Property.MarkDown({
+      value: `Select custom fields\n\nFor custom dropdown fields, choose a dropdown value based on the index (in the list, the first option is index 0, second is 1, third is 2, etc.)`,
+      variant: MarkdownVariant.INFO,
+    }),
+    custom_fields: Property.DynamicProperties({
+      auth: clickupAuth,
+      displayName: 'Custom Fields',
+      required: true,
+      refreshers: ['list_id', 'auth'],
+      props: async ({ list_id, auth }) => {
+        if (!list_id || !auth) {
+          return {};
+        }
+
+        // Ensure `auth` is of the correct type
+        const accessToken = getAccessTokenOrThrow(auth as OAuth2PropertyValue);
+
+        // Fetch custom fields using clickupCommon
+        const { fields: customFields } = await listAccessibleCustomFields(
+          accessToken,
+          list_id.toString()
+        );
+
+        // Map custom fields to InputPropertyMap
+        const dynamicProps: Record<string, any> = {};
+        customFields.forEach((field) => {
+          dynamicProps[field.id] = Property.ShortText({
+            displayName: field.name,
+            description: `Value for the custom field: ${field.name}`,
+            required: false,
+          });
+        });
+
+        return dynamicProps;
+      },
+    }),
+  },
+
+  outputSchema: taskOutputSchema,
+  async run(configValue) {
+    const {
+      list_id,
+      task_id,
+      name,
+      description,
+      status_id,
+      priority_id,
+      assignee_id,
+      is_markdown,
+      due_date,
+      due_date_time,
+      start_date,
+      start_date_time,
+      time_estimate,
+      check_required_custom_fields,
+      custom_fields,
+    } = configValue.propsValue;
+
+    type SubtaskData = {
+      name: string;
+      parent: string | undefined;
+      status?: string | undefined | string[];
+      priority?: number | undefined;
+      assignees?: number[] | undefined;
+      markdown_content?: string;
+      description?: string;
+      due_date?: number;
+      due_date_time?: boolean;
+      start_date?: number;
+      start_date_time?: boolean;
+      time_estimate?: number;
+      check_required_custom_fields?: boolean;
+      custom_fields?: { id: string; value: any }[];
+    };
+
+    const data: SubtaskData = {
+      name,
+      parent: task_id, // Parent task ID for the subtask
+      status: status_id,
+      priority: priority_id,
+      assignees: assignee_id,
+    };
+
+    // Add description or markdown content
+    if (is_markdown && description) {
+      data.markdown_content = description;
+    } else if (description) {
+      data.description = description;
+    }
+
+    // Convert due_date to integer format and add it
+    if (due_date) {
+      data.due_date = new Date(due_date).getTime();
+      data.due_date_time = due_date_time || false;
+    }
+
+    // Convert start_date to integer format and add it
+    if (start_date) {
+      data.start_date = new Date(start_date).getTime();
+      data.start_date_time = start_date_time || false;
+    }
+
+    // Add time estimate
+    if (time_estimate) {
+      data.time_estimate = time_estimate;
+    }
+
+    // Add check_required_custom_fields
+    if (check_required_custom_fields) {
+      data.check_required_custom_fields = check_required_custom_fields;
+    }
+
+    // Map custom_fields into the required format
+    if (custom_fields) {
+      data.custom_fields = Object.entries(custom_fields).map(
+        ([fieldId, value]) => ({
+          id: fieldId,
+          value,
+        })
+      );
+    }
+
+    // Make the API request
+    const response = await callClickUpApi(
+      HttpMethod.POST,
+      `list/${list_id}/task`,
+      getAccessTokenOrThrow(configValue.auth),
+      data
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/create-task-from-template.ts

@@ -0,0 +1,40 @@
+import { Property, createAction } from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+
+import { clickupCommon, callClickUpApi } from '../../common';
+import { clickupAuth } from '../../auth';
+import { taskOutputSchema } from '../../output-schemas';
+
+export const createClickupTaskFromTemplate = createAction({
+  auth: clickupAuth,
+  name: 'create_task_from_template',
+  description: 'Create a new task from Template',
+  audience: 'both',
+  aiMetadata: { description: 'Create a new ClickUp task in a list by instantiating an existing task template, supplying only the new task name. Pick this when the task should inherit structure (subtasks, fields, defaults) from a saved template; use Create Task for a task built from scratch. Each call creates a distinct task, so it is not idempotent.', idempotent: false },
+  displayName: 'Create Task From Template',
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    template_id: clickupCommon.template_id(true),
+    name: Property.ShortText({
+      description: 'The name of the task to create',
+      displayName: 'Task Name',
+      required: true,
+    }),
+  },
+  outputSchema: taskOutputSchema,
+  async run(configValue) {
+    const { list_id, name, template_id } = configValue.propsValue;
+    const response = await callClickUpApi(
+      HttpMethod.POST,
+      `list/${list_id}/taskTemplate/${template_id}`,
+      getAccessTokenOrThrow(configValue.auth),
+      {
+        name,
+      }
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/create-task.ts

@@ -0,0 +1,213 @@
+import {
+  OAuth2PropertyValue,
+  Property,
+  createAction,
+} from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+import { MarkdownVariant } from '@agnocon/pieces-framework';
+
+import {
+  clickupCommon,
+  callClickUpApi,
+  listAccessibleCustomFields,
+} from '../../common';
+import { clickupAuth } from '../../auth';
+import { taskOutputSchema } from '../../output-schemas';
+
+export const createClickupTask = createAction({
+  auth: clickupAuth,
+  name: 'create_task',
+  description: 'Create a new task in a ClickUp workspace and list',
+  audience: 'human',
+  aiMetadata: { description: 'Create a new top-level task in a ClickUp list, with optional status, priority, assignees, description, dates, time estimate, and custom fields. Pick this for a standalone task; use Create Subtask to nest under a parent or Create Task From Template to inherit a template. Each call creates a new task, so it is not idempotent.', idempotent: false },
+  displayName: 'Create Task',
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    name: Property.ShortText({
+      description: 'The name of task',
+      displayName: 'Name',
+      required: true,
+    }),
+    status_id: clickupCommon.status_id(),
+    priority_id: clickupCommon.priority_id(),
+    assignee_id: clickupCommon.assignee_id(
+      false,
+      'Assignee Id',
+      'ID of assignee for Clickup Task'
+    ),
+    description: Property.LongText({
+      description: 'The description of task',
+      displayName: 'Description',
+      required: false,
+    }),
+    is_markdown: Property.Checkbox({
+      description: 'Is the description in markdown format',
+      displayName: 'Is Markdown',
+      required: false,
+      defaultValue: false,
+    }),
+    due_date: Property.DateTime({
+      description: 'The due date of the task',
+      displayName: 'Due Date',
+      required: false,
+    }),
+    due_date_time: Property.Checkbox({
+      description: 'Whether to include time in the due date',
+      displayName: 'Due Date Time',
+      required: false,
+      defaultValue: false,
+    }),
+    start_date: Property.DateTime({
+      description: 'The start date of the task',
+      displayName: 'Start Date',
+      required: false,
+    }),
+    start_date_time: Property.Checkbox({
+      description: 'Whether to include time in the start date',
+      displayName: 'Start Date Time',
+      required: false,
+      defaultValue: false,
+    }),
+    time_estimate: Property.Number({
+      description: 'The time estimate for the task in milliseconds',
+      displayName: 'Time Estimate',
+      required: false,
+    }),
+    check_required_custom_fields: Property.Checkbox({
+      description: 'Re-enable required custom fields validation for the task',
+      displayName: 'Check Required Custom Fields',
+      required: false,
+      defaultValue: false,
+    }),
+    custom_fields_info: Property.MarkDown({
+      value: `Select custom fields\n\nFor custom dropdown fields, choose a dropdown value based on the index (in the list, the first option is index 0, second is 1, third is 2, etc.)`,
+      variant: MarkdownVariant.INFO,
+    }),
+    custom_fields: Property.DynamicProperties({
+      auth: clickupAuth,
+      displayName: 'Custom Fields',
+      required: true,
+      refreshers: ['list_id', 'auth'],
+      props: async ({ list_id, auth }) => {
+        if (!list_id || !auth) {
+          return {};
+        }
+
+        // Ensure `auth` is of the correct type
+        const accessToken = getAccessTokenOrThrow(auth as OAuth2PropertyValue);
+
+        // Fetch custom fields using clickupCommon
+        const { fields: customFields } = await listAccessibleCustomFields(
+          accessToken,
+          list_id.toString()
+        );
+
+        // Map custom fields to InputPropertyMap
+        const dynamicProps: Record<string, any> = {};
+        customFields.forEach((field) => {
+          dynamicProps[field.id] = Property.ShortText({
+            displayName: field.name,
+            description: `Value for the custom field: ${field.name}`,
+            required: false,
+          });
+        });
+
+        return dynamicProps;
+      },
+    }),
+  },
+
+  outputSchema: taskOutputSchema,
+  async run(configValue) {
+    const {
+      list_id,
+      name,
+      description,
+      status_id,
+      priority_id,
+      assignee_id,
+      is_markdown,
+      due_date,
+      due_date_time,
+      start_date,
+      start_date_time,
+      time_estimate,
+      check_required_custom_fields,
+      custom_fields,
+    } = configValue.propsValue;
+
+    type TaskData = {
+      name: string;
+      status?: string | undefined | string[];
+      priority?: number | undefined;
+      assignees?: number[] | undefined;
+      markdown_content?: string;
+      description?: string;
+      due_date?: number;
+      due_date_time?: boolean;
+      start_date?: number;
+      start_date_time?: boolean;
+      time_estimate?: number;
+      check_required_custom_fields?: boolean;
+      custom_fields?: { id: string; value: any }[];
+    };
+
+    const data: TaskData = {
+      name,
+      status: status_id,
+      priority: priority_id,
+      assignees: assignee_id,
+    };
+
+    // Add description or markdown content
+    if (is_markdown && description) {
+      data.markdown_content = description;
+    } else if (description) {
+      data.description = description;
+    }
+
+    // Convert due_date to integer format and add it
+    if (due_date) {
+      data.due_date = new Date(due_date).getTime();
+      data.due_date_time = due_date_time || false;
+    }
+
+    // Convert start_date to integer format and add it
+    if (start_date) {
+      data.start_date = new Date(start_date).getTime();
+      data.start_date_time = start_date_time || false;
+    }
+
+    // Add time estimate
+    if (time_estimate) {
+      data.time_estimate = time_estimate;
+    }
+
+    // Add check_required_custom_fields
+    if (check_required_custom_fields) {
+      data.check_required_custom_fields = check_required_custom_fields;
+    }
+
+    // Map custom_fields into the required format
+    if (custom_fields) {
+      data.custom_fields = Object.entries(custom_fields).map(
+        ([fieldId, value]) => ({
+          id: fieldId,
+          value,
+        })
+      );
+    }
+
+    // Make the API request
+    const response = await callClickUpApi(
+      HttpMethod.POST,
+      `list/${list_id}/task`,
+      getAccessTokenOrThrow(configValue.auth),
+      data
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/delete-task.ts

@@ -0,0 +1,33 @@
+import { createAction } from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+
+import { clickupCommon, callClickUpApi } from '../../common';
+import { clickupAuth } from '../../auth';
+
+export const deleteClickupTask = createAction({
+  auth: clickupAuth,
+  name: 'delete_task',
+  description: 'Delete a task in a workspace and list',
+  audience: 'human',
+  aiMetadata: { description: 'Permanently delete a ClickUp task identified by its task ID. Pick this to remove a task entirely; this is destructive and cannot be undone, so confirm the ID before calling. Deleting an already-deleted task fails rather than succeeding, so treat it as non-idempotent.', idempotent: false },
+  displayName: 'Delete Task',
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    task_id: clickupCommon.task_id()
+  },
+  async run(configValue) {
+    const {
+      task_id,
+    } = configValue.propsValue;
+    const response = await callClickUpApi(
+      HttpMethod.DELETE,
+      `task/${task_id}`,
+      getAccessTokenOrThrow(configValue.auth),
+      undefined
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/filter-workspace-tasks.ts

@@ -0,0 +1,127 @@
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+import {
+  OAuth2PropertyValue,
+  Property,
+  createAction,
+} from '@agnocon/pieces-framework';
+import qs from 'qs';
+import { clickupAuth } from '../../auth';
+import { callClickUpApi, clickupCommon, listTags } from '../../common';
+import { ClickupTask } from '../../common/models';
+import { filterWorkspaceTasksOutputSchema } from '../../output-schemas';
+
+export const filterClickupWorkspaceTasks = createAction({
+  auth: clickupAuth,
+  name: 'list_workspace_tasks',
+  displayName: 'List Team Tasks',
+  description:
+    'Retrieves the tasks that meet specific criteria from a Workspace.',
+  audience: 'human',
+  aiMetadata: { description: 'List tasks across an entire ClickUp workspace, filtered by space, folder, list, assignees, and tags, with paging, ordering, and inclusion of closed tasks. Pick this to search or browse tasks broadly when you do not know a specific task ID; use Get Task for a known ID or Get Task by Name to resolve a name within one list. Read-only and idempotent; results are paginated (page starts at 0).', idempotent: true },
+  props: {
+    workspace_id: clickupCommon.workspace_id(true),
+    space_id: clickupCommon.space_id(false, true),
+    folder_id: clickupCommon.folder_id(false, true),
+    list_id: clickupCommon.list_id(false, true),
+
+    assignees: clickupCommon.assignee_id(
+      false,
+      'Assignee Id',
+      'ID of assignee for Clickup Task'
+    ),
+    tags: Property.MultiSelectDropdown({
+      auth: clickupAuth,
+      displayName: 'Tags',
+      description: 'The tags to filter for',
+      refreshers: ['space_id', 'workspace_id'],
+      required: false,
+      options: async ({ auth, workspace_id, space_id }) => {
+        if (!auth || !workspace_id || !space_id) {
+          return {
+            disabled: true,
+            placeholder:
+              'connect your account first and select workspace and space',
+            options: [],
+          };
+        }
+        const accessToken = getAccessTokenOrThrow(auth as OAuth2PropertyValue);
+        const response = await listTags(accessToken, space_id as string);
+        return {
+          disabled: false,
+          options: response.tags.map((tag) => {
+            return {
+              label: tag.name,
+              value: encodeURIComponent(tag.name),
+            };
+          }),
+        };
+      },
+    }),
+
+    page: Property.Number({
+      displayName: 'Page',
+      description: 'Page to fetch (starts at 0).',
+      required: false,
+      defaultValue: 0,
+    }),
+    reverse: Property.Checkbox({
+      displayName: 'Reverse',
+      description: 'Tasks are displayed in reverse order.',
+      required: false,
+      defaultValue: false,
+    }),
+    include_closed: Property.Checkbox({
+      displayName: 'Include Closed',
+      description:
+        'Include or exclude closed tasks. By default, they are excluded.',
+      required: false,
+      defaultValue: false,
+    }),
+    order_by: Property.StaticDropdown({
+      displayName: 'Order By',
+      description:
+        'Order by a particular field. By default, tasks are ordered by created.',
+      required: false,
+      options: {
+        options: [
+          { value: 'id', label: 'Id' },
+          { value: 'created', label: 'Created at' },
+          { value: 'updated', label: 'Last updated' },
+          { value: 'due_date', label: 'Due date' },
+        ],
+      },
+    }),
+  },
+  outputSchema: filterWorkspaceTasksOutputSchema,
+  async run(configValue) {
+    const { list_id, folder_id, space_id, workspace_id, ...params } =
+      configValue.propsValue;
+    const auth = getAccessTokenOrThrow(configValue.auth);
+
+    const query: Record<string, unknown> = {
+      assignees: params.assignees,
+      tags: params.tags,
+      page: params.page,
+      reverse: params.reverse,
+      include_closed: params.include_closed,
+      order_by: params.order_by,
+    };
+
+    if (list_id) query['list_ids'] = list_id;
+    if (folder_id) query['project_ids'] = folder_id;
+    if (space_id) query['space_ids'] = space_id;
+
+    return (
+      await callClickUpApi<ClickupTask>(
+        HttpMethod.GET,
+        `team/${workspace_id}/task?${decodeURIComponent(qs.stringify(query))}`,
+        auth,
+        undefined,
+        undefined,
+        {
+          'Content-Type': 'application/json',
+        }
+      )
+    ).body;
+  },
+});