@divyacon/piece-clickup 0.0.0-stage → 0.1.0

package/src/lib/actions/tasks/clickup-list-list-tasks.ts

@@ -0,0 +1,91 @@
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+import { Property, createAction } from '@agnocon/pieces-framework';
+import qs from 'qs';
+import { clickupAuth } from '../../auth';
+import { callClickUpApi, clickupCommon } from '../../common';
+import { ClickupTask } from '../../common/models';
+import { filterWorkspaceTasksOutputSchema } from '../../output-schemas';
+
+export const clickupListListTasksAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_list_list_tasks',
+  displayName: 'List List Tasks',
+  description: 'Retrieves the tasks contained in a specific ClickUp list.',
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      'List the tasks of one specific ClickUp list (resolve the list ID via Get List or the List dropdown), with paging and ordering. Pick this when you know the target list and want only its tasks; to search tasks across the whole workspace use List Tasks. Read-only and idempotent; results are paginated (page starts at 0).',
+    idempotent: true,
+  },
+  outputSchema: filterWorkspaceTasksOutputSchema,
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    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,
+    }),
+    subtasks: Property.Checkbox({
+      displayName: 'Include Subtasks',
+      description: 'Include subtasks in the response.',
+      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' },
+        ],
+      },
+    }),
+  },
+  async run(configValue) {
+    const { list_id, page, reverse, include_closed, subtasks, order_by } =
+      configValue.propsValue;
+    const auth = getAccessTokenOrThrow(configValue.auth);
+
+    const query: Record<string, unknown> = {
+      page,
+      reverse,
+      include_closed,
+      subtasks,
+      order_by,
+    };
+
+    return (
+      await callClickUpApi<ClickupTask>(
+        HttpMethod.GET,
+        `list/${list_id}/task?${decodeURIComponent(qs.stringify(query))}`,
+        auth,
+        undefined,
+        undefined,
+        {
+          'Content-Type': 'application/json',
+        }
+      )
+    ).body;
+  },
+});

package/src/lib/actions/tasks/clickup-list-tasks.ts

@@ -0,0 +1,143 @@
+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 clickupListTasksAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_list_tasks',
+  displayName: 'List Tasks',
+  description:
+    'Retrieves the tasks that meet specific criteria from a Workspace.',
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      'List tasks across an entire ClickUp workspace, filtered by space, folder, list, assignees, and tags, with paging and ordering. Pick this to search or browse tasks broadly across the workspace when you do not know a task ID; to list only the tasks of one specific list use List List Tasks, and for a known ID use Get Task. Read-only and idempotent; results are paginated (page starts at 0).',
+    idempotent: true,
+  },
+  outputSchema: filterWorkspaceTasksOutputSchema,
+  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' },
+        ],
+      },
+    }),
+  },
+  async run(configValue) {
+    const { list_id, folder_id, space_id, workspace_id, ...params } =
+      configValue.propsValue;
+    const auth = getAccessTokenOrThrow(configValue.auth);
+
+    // These ClickUp filters MUST be arrays (the API rejects a scalar with
+    // "<x>_ids must be an array"). The props are multi-selects, but an agent
+    // may send a single id as a scalar string — coerce to an array so that
+    // shape works instead of 400-ing.
+    const toArray = (v: unknown): unknown[] | undefined => {
+      if (v === undefined || v === null || v === '') return undefined;
+      return Array.isArray(v) ? v : [v];
+    };
+
+    const query: Record<string, unknown> = {
+      assignees: toArray(params.assignees),
+      tags: toArray(params.tags),
+      page: params.page,
+      reverse: params.reverse,
+      include_closed: params.include_closed,
+      order_by: params.order_by,
+    };
+
+    const listIds = toArray(list_id);
+    const folderIds = toArray(folder_id);
+    const spaceIds = toArray(space_id);
+    if (listIds) query['list_ids'] = listIds;
+    if (folderIds) query['project_ids'] = folderIds;
+    if (spaceIds) query['space_ids'] = spaceIds;
+
+    return (
+      await callClickUpApi<ClickupTask>(
+        HttpMethod.GET,
+        `team/${workspace_id}/task?${decodeURIComponent(qs.stringify(query))}`,
+        auth,
+        undefined,
+        undefined,
+        {
+          'Content-Type': 'application/json',
+        }
+      )
+    ).body;
+  },
+});

package/src/lib/actions/tasks/clickup-move-task-to-list.ts

@@ -0,0 +1,44 @@
+import { Property, createAction } from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+
+import { clickupCommon, callClickUpApi3 } from '../../common';
+import { clickupAuth } from '../../auth';
+import { moveTaskOutputSchema } from '../../output-schemas';
+
+export const clickupMoveTaskToListAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_move_task_to_list',
+  description: "Move a task to a different list (the task's home list)",
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      "Re-home a ClickUp task by moving it to a different list, changing the task's home (primary) list. Pick this to relocate a task; to instead make a task appear in an extra list without changing its home use Add Task To List, and to remove a task entirely use Delete Task. Provide the destination list ID (resolve via Get List). Moving a task to its current home list is a no-op, so it is idempotent.",
+    idempotent: true,
+  },
+  displayName: 'Move Task To List',
+  outputSchema: moveTaskOutputSchema,
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    task_id: clickupCommon.task_id(),
+    destination_list_id: Property.ShortText({
+      displayName: 'Destination List ID',
+      description:
+        'The ID of the list to move the task into (its new home list). Resolve via Get List.',
+      required: true,
+    }),
+  },
+  async run(configValue) {
+    const { workspace_id, task_id, destination_list_id } =
+      configValue.propsValue;
+    const response = await callClickUpApi3(
+      HttpMethod.PUT,
+      `workspaces/${workspace_id}/tasks/${task_id}/home_list/${destination_list_id}`,
+      getAccessTokenOrThrow(configValue.auth),
+      {}
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/clickup-remove-tag-from-task.ts

@@ -0,0 +1,66 @@
+import {
+  OAuth2PropertyValue,
+  Property,
+  createAction,
+} from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+
+import { clickupCommon, callClickUpApi, listTags } from '../../common';
+import { clickupAuth } from '../../auth';
+
+export const clickupRemoveTagFromTaskAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_remove_tag_from_task',
+  description: 'Remove a tag from a task',
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      'Remove a tag from a ClickUp task by tag name. This only detaches the tag from this task; the tag itself remains in the space. Use Add Tag To Task to attach one. Removing a tag the task does not have is a no-op, so it is idempotent.',
+    idempotent: true,
+  },
+  displayName: 'Remove Tag From Task',
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    task_id: clickupCommon.task_id(),
+    tag_name: Property.Dropdown({
+      auth: clickupAuth,
+      displayName: 'Tag',
+      description: 'The name of the space tag to remove.',
+      required: true,
+      refreshers: ['space_id'],
+      options: async ({ auth, space_id }) => {
+        if (!auth || !space_id) {
+          return {
+            disabled: true,
+            placeholder: 'connect your account first and select a 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: tag.name,
+            };
+          }),
+        };
+      },
+    }),
+  },
+  async run(configValue) {
+    const { task_id, tag_name } = configValue.propsValue;
+    const response = await callClickUpApi(
+      HttpMethod.DELETE,
+      `task/${task_id}/tag/${encodeURIComponent(tag_name as string)}`,
+      getAccessTokenOrThrow(configValue.auth),
+      undefined
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/clickup-remove-task-from-list.ts

@@ -0,0 +1,39 @@
+import { Property, createAction } from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+
+import { clickupCommon, callClickUpApi } from '../../common';
+import { clickupAuth } from '../../auth';
+
+export const clickupRemoveTaskFromListAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_remove_task_from_list',
+  description: 'Remove a task from an additional list',
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      "Remove a ClickUp task from an additional (non-home) list. This requires the \"Tasks in Multiple Lists\" ClickApp to be enabled. It only detaches the task from an extra list — it does not delete the task or change its home list (use Delete Task or Move Task To List for those). Removing it from a list it is not in is a no-op, so it is idempotent.",
+    idempotent: true,
+  },
+  displayName: 'Remove Task From List',
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    task_id: Property.ShortText({
+      displayName: 'Task ID',
+      description: 'The ID of the task to remove from the list.',
+      required: true,
+    }),
+  },
+  async run(configValue) {
+    const { list_id, task_id } = configValue.propsValue;
+    const response = await callClickUpApi(
+      HttpMethod.DELETE,
+      `list/${list_id}/task/${task_id}`,
+      getAccessTokenOrThrow(configValue.auth),
+      undefined
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/clickup-set-task-status.ts

@@ -0,0 +1,40 @@
+import { 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 clickupSetTaskStatusAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_set_task_status',
+  description: 'Set the status of a ClickUp task',
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      'Change only the status of an existing ClickUp task (e.g. to In Progress or Complete). Pick this for the common "move the task to status X" intent; use Update Task to change other fields too. The status must be a valid label for the task list (select it from the Status dropdown, which lists the list-specific statuses) — a free-text or unknown status is rejected. Setting a status it already has is a no-op, so it is idempotent.',
+    idempotent: true,
+  },
+  displayName: 'Set Task Status',
+  outputSchema: taskOutputSchema,
+  props: {
+    workspace_id: clickupCommon.workspace_id(),
+    space_id: clickupCommon.space_id(),
+    list_id: clickupCommon.list_id(),
+    task_id: clickupCommon.task_id(),
+    status_id: clickupCommon.status_id(true),
+  },
+  async run(configValue) {
+    const { task_id, status_id } = configValue.propsValue;
+    const response = await callClickUpApi(
+      HttpMethod.PUT,
+      `task/${task_id}`,
+      getAccessTokenOrThrow(configValue.auth),
+      {
+        status: status_id,
+      }
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/clickup-unlink-tasks.ts

@@ -0,0 +1,43 @@
+import { Property, createAction } from '@agnocon/pieces-framework';
+import { HttpMethod, getAccessTokenOrThrow } from '@agnocon/pieces-common';
+
+import { callClickUpApi } from '../../common';
+import { clickupAuth } from '../../auth';
+import { taskWrapperOutputSchema } from '../../output-schemas';
+
+export const clickupUnlinkTasksAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_unlink_tasks',
+  description: 'Remove a link between two tasks',
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      'Remove a non-dependency link between two ClickUp tasks. Use Link Tasks to create one. Removing a link that does not exist is a no-op, so it is idempotent.',
+    idempotent: true,
+  },
+  displayName: 'Unlink Tasks',
+  outputSchema: taskWrapperOutputSchema,
+  props: {
+    task_id: Property.ShortText({
+      displayName: 'Task ID',
+      description: 'The ID of the first task.',
+      required: true,
+    }),
+    links_to: Property.ShortText({
+      displayName: 'Linked Task ID',
+      description: 'The ID of the task to unlink from.',
+      required: true,
+    }),
+  },
+  async run(configValue) {
+    const { task_id, links_to } = configValue.propsValue;
+    const response = await callClickUpApi(
+      HttpMethod.DELETE,
+      `task/${task_id}/link/${links_to}`,
+      getAccessTokenOrThrow(configValue.auth),
+      undefined
+    );
+
+    return response.body;
+  },
+});

package/src/lib/actions/tasks/clickup-update-task.ts

@@ -0,0 +1,82 @@
+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 clickupUpdateTaskAi = createAction({
+  auth: clickupAuth,
+  name: 'clickup_update_task',
+  description: 'Update task in a ClickUp workspace and list',
+  audience: 'ai',
+  aiMetadata: {
+    description:
+      'Modify fields of an existing ClickUp task identified by its task ID, including name, description, status, priority, and adding or removing assignees. Pick this to change multiple fields of a task you already have the ID for; for only the status use Set Task Status, and to create a new task use Create Task. Only the fields you supply are changed, so repeating the same update yields the same end state.',
+    idempotent: true,
+  },
+  displayName: 'Update Task',
+  outputSchema: taskOutputSchema,
+  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 task to update',
+      displayName: 'Task Name',
+      required: false,
+    }),
+    description: Property.LongText({
+      description: 'The description of the task to update',
+      displayName: 'Task Description',
+      required: false,
+    }),
+    status_id: clickupCommon.status_id(),
+    priority_id: clickupCommon.priority_id(),
+    add_assignee: clickupCommon.assignee_id(
+      false,
+      'Add Assignees',
+      'assignee(s) you want to add for the task'
+    ),
+    rem_assignee: clickupCommon.assignee_id(
+      false,
+      'Remove Assignees',
+      'assignee(s) you want to remove from the task'
+    ),
+  },
+  async run(configValue) {
+    const {
+      task_id,
+      name,
+      description,
+      status_id,
+      priority_id,
+      add_assignee,
+      rem_assignee,
+    } = configValue.propsValue;
+    const response = await callClickUpApi(
+      HttpMethod.PUT,
+      `task/${task_id}`,
+      getAccessTokenOrThrow(configValue.auth),
+      {
+        name: name,
+        description: description,
+        status: status_id,
+        priority: priority_id,
+        // Only send the assignees object for an actual add/remove. ClickUp
+        // rejects an empty/blank assignees object on ordinary field updates.
+        ...(add_assignee !== undefined || rem_assignee !== undefined
+          ? {
+              assignees: {
+                ...(add_assignee !== undefined ? { add: add_assignee } : {}),
+                ...(rem_assignee !== undefined ? { rem: rem_assignee } : {}),
+              },
+            }
+          : {}),
+      }
+    );
+
+    return response.body;
+  },
+});