Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

6.8 KB
Raw Blame
import { pagingNumber, z } from "../openapi";
import { MAX_TASK_POSITION } from "./controllers/next-task-position";
import { taskRecurrenceSchema } from "./recurrence/schema";
import { TICKET_ID_PATTERN } from "./ticket-id";
import { VALID_PRIORITIES } from "./validate-task-fields";

export const taskParam = z.object({ id: z.string() });

export const ticketIdParam = z.object({
  ticketId: z
    .string()
    .max(128)
    .refine((value) => TICKET_ID_PATTERN.test(value), "Invalid task ticket ID")
    .openapi({
      description: "Project key and task number, e.g. KAN-12.",
    }),
});

export const ticketIdQuery = z.object({
  workspaceId: z.string().min(1).optional().openapi({
    description: "Select a workspace if the ticket ID exists in more than one.",
  }),
  workspaceSlug: z.string().min(1).max(128).optional().openapi({
    description: "Select a workspace by its slug instead of its ID.",
  }),
  projectId: z.string().min(1).optional().openapi({
    description: "Select a project if the ticket ID exists more than once.",
  }),
});

export const projectIdParam = z.object({ projectId: z.string() });

export const assignedTasksQuery = z.object({
  workspaceId: z.string().min(1),
  countOnly: z.enum(["true", "false"]).optional().openapi({
    description:
      "Return only the total, with an empty tasks array, without loading task rows or labels.",
  }),
});

const priority = z.enum(VALID_PRIORITIES);

// Required object of optional filters: a RouteParameter cannot itself be optional.
export const listTasksQuery = z.object({
  status: z.string().optional(),
  priority: z.string().optional(),
  assigneeId: z.string().optional(),
  // Number("abc") is NaN, which used to reach the limit/offset clause unchecked.
  page: pagingNumber(1, 1_000_000).optional(),
  relatedPage: pagingNumber(1, 1_000_000).optional(),
  limit: pagingNumber(1, 100).optional(),
  sortBy: z
    .enum(["createdAt", "priority", "dueDate", "position", "title", "number"])
    .optional(),
  sortOrder: z.enum(["asc", "desc"]).optional(),
  dueBefore: z.string().optional(),
  dueAfter: z.string().optional(),
});

export const bulkUpdateBody = z.object({
  taskIds: z.array(z.string()).min(1),
  operation: z.enum([
    "updateStatus",
    "updatePriority",
    "updateAssignee",
    "delete",
    "addLabel",
    "removeLabel",
    "updateDueDate",
  ]),
  value: z.string().nullable().optional().openapi({
    description:
      "The new value for the chosen operation. Unused by `delete`; null clears an assignee or due date.",
  }),
});

export const createTaskBody = z.object({
  title: z.string(),
  description: z.string(),
  startDate: z.string().optional(),
  dueDate: z.string().optional(),
  priority,
  status: z.string().openapi({ description: "The target column's slug." }),
  userId: z.string().optional().openapi({ description: "Assignee, if any." }),
  recurrence: taskRecurrenceSchema
    .optional()
    .openapi({ description: "Omit to create a task that does not repeat." }),
  draftAssetIds: z.array(z.string()).max(100).optional(),
  customFields: z
    .array(z.object({ fieldId: z.string(), value: z.string() }))
    .optional(),
});

export const updateTaskBody = z.object({
  title: z.string(),
  description: z.string().optional().openapi({
    description:
      "Omit to preserve the existing description when updating a list summary.",
  }),
  startDate: z.string().optional(),
  dueDate: z.string().optional(),
  priority,
  status: z.string(),
  projectId: z.string(),
  position: z.number().int().min(0).max(MAX_TASK_POSITION),
  userId: z.string().optional(),
});

export const moveTaskBody = z.object({
  destinationProjectId: z.string(),
  destinationStatus: z.string().optional().openapi({
    description: "Defaults to the destination project's first column.",
  }),
});

export const importTasksBody = z.object({
  tasks: z.array(
    z.object({
      title: z.string(),
      description: z.string().optional(),
      status: z.string().openapi({
        description:
          "Column slug, current column name, or slugified current name. Unknown values map to planned with a warning; ambiguous names fail the task import.",
      }),
      priority: z.string().optional(),
      startDate: z.string().nullable().optional(),
      dueDate: z.string().nullable().optional(),
      userId: z.string().nullable().optional().openapi({
        description:
          "Assignable user's ID or email address. Emails match case-insensitively. Null, empty, or omitted leaves the task unassigned.",
      }),
    }),
  ),
});

export const updateStatusBody = z.object({ status: z.string() });
export const updatePriorityBody = z.object({ priority });
export const updateAssigneeBody = z.object({
  userId: z.string().nullable().openapi({ description: "Null unassigns." }),
});
export const updateDueDateBody = z.object({ dueDate: z.string().optional() });
export const updateRecurrenceBody = z.object({
  recurrence: z
    .union([taskRecurrenceSchema, z.null()])
    .openapi({ description: "Null stops the task from repeating." }),
});
export const updateTitleBody = z.object({ title: z.string() });
export const updateDescriptionBody = z.object({ description: z.string() });

const surface = z.enum(["description", "comment"]).openapi({
  description: "Where the image is used, which decides how it is scoped.",
});

export const imageUploadBody = z.object({
  filename: z.string(),
  contentType: z.string(),
  size: z.number(),
  surface,
});

export const finalizeImageUploadBody = z.object({
  key: z
    .string()
    .openapi({ description: "The key returned when the URL was issued." }),
  filename: z.string(),
  contentType: z.string(),
  size: z.number(),
  surface,
});

export const descriptionPageQuery = z.object({
  offset: pagingNumber(0, 2_000_000_000, 0),
  version: z
    .string()
    .regex(/^[0-9]{1,10}$/)
    .optional(),
});
export const descriptionMatchesQuery = z.object({
  query: z.string().trim().min(1).max(256),
  after: z.string().min(1).max(128).optional(),
});

export const duplicateTaskBody = z.object({ title: z.string().optional() });

export const stagedImageUploadBody = imageUploadBody.extend({
  surface: z.literal("description"),
});
export const finalizeStagedImageUploadBody = finalizeImageUploadBody.extend({
  surface: z.literal("description"),
});

export const reorderTasksBody = z.object({
  projectId: z.string(),
  expectedTasks: z
    .array(
      z.object({
        id: z.string(),
        position: z.number().int().min(0).max(MAX_TASK_POSITION).nullable(),
        status: z.string(),
      }),
    )
    .optional()
    .describe(
      "Previous complete contents of the affected columns; stale snapshots return 409",
    ),
  tasks: z
    .array(
      z.object({
        id: z.string(),
        position: z.number().int().min(0).max(MAX_TASK_POSITION),
        status: z.string().optional(),
      }),
    )
    .min(1),
});