@omnicoreos/planka-mcp 0.2.0

package/dist/schemas/entities.js

@@ -0,0 +1,202 @@
+/**
+ * Core entity schemas for PLANKA 2.0
+ * All types are derived from these Zod schemas.
+ */
+import { z } from "zod";
+// Card type enum - required for PLANKA 2.0
+export const CardTypeSchema = z.enum(["project", "story"]);
+export const ListTypeSchema = z.enum(["active", "closed"]);
+// Label colors - all valid PLANKA 2.0 colors
+export const LabelColorSchema = z.enum([
+    "muddy-grey",
+    "autumn-leafs",
+    "fresh-salad",
+    "lilac-eyes",
+    "silver-glint",
+    "deep-ocean",
+    "summer-sky",
+    "grey-stone",
+    "sugar-plum",
+    "shady-rust",
+    "wet-rock",
+    "turquoise-sea",
+    "lavender-fields",
+    "french-coast",
+    "sweet-lilac",
+    "pirate-gold",
+    "berry-red",
+    "pumpkin-orange",
+    "lagoon-blue",
+    "pink-tulip",
+    "light-mud",
+    "orange-peel",
+    "bright-moss",
+    "antique-blue",
+    "dark-granite",
+    "lagune-blue",
+    "sunny-grass",
+    "morning-sky",
+    "light-orange",
+    "midnight-blue",
+    "tank-green",
+    "gun-metal",
+    "wet-moss",
+    "red-burgundy",
+    "light-concrete",
+    "apricot-red",
+    "desert-sand",
+    "navy-blue",
+    "egg-yellow",
+    "coral-green",
+    "light-cocoa",
+    "modern-green",
+    "piggy-red",
+]);
+// User schema
+export const UserSchema = z.object({
+    id: z.string(),
+    email: z.string().email().optional(),
+    username: z.string().optional(),
+    name: z.string(),
+    avatarUrl: z.string().nullable().optional(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Project schema
+export const ProjectSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    background: z.string().nullable().optional(),
+    backgroundImage: z.string().nullable().optional(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Board schema
+export const BoardSchema = z.object({
+    id: z.string(),
+    projectId: z.string(),
+    name: z.string(),
+    position: z.number(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// List schema
+export const ListSchema = z.object({
+    id: z.string(),
+    boardId: z.string(),
+    name: z.string().nullable(), // Can be null for archive/trash
+    position: z.number().nullable(),
+    // Read paths must also tolerate Planka's internal archive/trash list types
+    // and future additions. Write paths stay strict through ListTypeSchema.
+    type: z.string().optional(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Card schema
+export const CardSchema = z.object({
+    id: z.string(),
+    boardId: z.string(),
+    listId: z.string(),
+    creatorUserId: z.string().optional(),
+    name: z.string(),
+    description: z.string().nullable().optional(),
+    position: z.number(),
+    type: CardTypeSchema,
+    dueDate: z.string().nullable().optional(),
+    isDueDateCompleted: z.boolean().optional(),
+    isCompleted: z.boolean().optional(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+    /**
+     * When the card entered its current list. Planka uses it as half of the
+     * pagination cursor of GET /api/lists/:id/cards (`before[id]` +
+     * `before[listChangedAt]`), so it has to survive parsing even though it is
+     * never displayed.
+     */
+    listChangedAt: z.string().nullable().optional(),
+});
+// TaskList (checklist container) schema - PLANKA 2.0
+export const TaskListSchema = z.object({
+    id: z.string(),
+    cardId: z.string(),
+    name: z.string(),
+    position: z.number(),
+    showOnFrontOfCard: z.boolean().optional(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Task (checklist item) schema - PLANKA 2.0 uses taskListId instead of cardId
+export const TaskSchema = z.object({
+    id: z.string(),
+    taskListId: z.string(),
+    name: z.string(),
+    position: z.number(),
+    isCompleted: z.boolean(),
+    assigneeUserId: z.string().nullable().optional(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Label schema
+// Note: `color` is intentionally typed as `z.string()` rather than
+// `LabelColorSchema` here. Read paths (e.g. planka_get_board) must accept
+// any color value the Planka backend returns, since the set of supported
+// colors evolves between Planka releases. Strict enum validation is kept
+// only on write paths (see schemas/requests.ts and tools/labels.ts), where
+// rejecting unknown colors is appropriate.
+export const LabelSchema = z.object({
+    id: z.string(),
+    boardId: z.string(),
+    name: z.string().nullable(),
+    color: z.string(),
+    position: z.number(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Card-Label relationship (junction table)
+export const CardLabelSchema = z.object({
+    id: z.string(),
+    cardId: z.string(),
+    labelId: z.string(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Comment schema
+export const CommentSchema = z.object({
+    id: z.string(),
+    cardId: z.string(),
+    userId: z.string(),
+    text: z.string(),
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+// Attachment schema
+// PLANKA 2.0 keeps the binary under `data` ({url, thumbnailUrls, size,
+// mimeType…}); a flat root-level `url` was the 1.x shape. Tolerate both.
+export const AttachmentSchema = z.object({
+    id: z.string(),
+    cardId: z.string(),
+    creatorUserId: z.string().optional(),
+    name: z.string(),
+    type: z.string().optional(), // "file" | "link" in 2.0
+    data: z
+        .object({
+        url: z.string().optional(),
+        size: z.number().optional(),
+        mimeType: z.string().nullable().optional(),
+        image: z
+            .object({
+            width: z.number().optional(),
+            height: z.number().optional(),
+        })
+            .passthrough()
+            .nullable()
+            .optional(),
+    })
+        .passthrough()
+        .nullable()
+        .optional(),
+    url: z.string().optional(), // 1.x compatibility
+    createdAt: z.string(),
+    updatedAt: z.string().nullable().optional(),
+});
+//# sourceMappingURL=entities.js.map

package/dist/schemas/entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../src/schemas/entities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,2CAA2C;AAC3C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AAG3D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAG3D,6CAA6C;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAAC;IACrC,YAAY;IACZ,cAAc;IACd,aAAa;IACb,YAAY;IACZ,cAAc;IACd,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,UAAU;IACV,eAAe;IACf,iBAAiB;IACjB,cAAc;IACd,aAAa;IACb,aAAa;IACb,WAAW;IACX,gBAAgB;IAChB,aAAa;IACb,YAAY;IACZ,WAAW;IACX,aAAa;IACb,aAAa;IACb,cAAc;IACd,cAAc;IACd,aAAa;IACb,aAAa;IACb,aAAa;IACb,cAAc;IACd,eAAe;IACf,YAAY;IACZ,WAAW;IACX,UAAU;IACV,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,aAAa;IACb,WAAW;IACX,YAAY;IACZ,aAAa;IACb,aAAa;IACb,cAAc;IACd,WAAW;CACZ,CAAC,CAAC;AAGH,cAAc;AACd,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC3C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,iBAAiB;AACjB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACjD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,eAAe;AACf,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,cAAc;AACd,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,gCAAgC;IAC7D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,2EAA2E;IAC3E,wEAAwE;IACxE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,cAAc;AACd,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC7C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACzC,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC1C,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC3C;;;;;OAKG;IACH,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC;AAGH,qDAAqD;AACrD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACzC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,8EAA8E;AAC9E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;IACxB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAChD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,eAAe;AACf,mEAAmE;AACnE,0EAA0E;AAC1E,yEAAyE;AACzE,yEAAyE;AACzE,2EAA2E;AAC3E,2CAA2C;AAC3C,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,2CAA2C;AAC3C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,iBAAiB;AACjB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,oBAAoB;AACpB,uEAAuE;AACvE,yEAAyE;AACzE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,yBAAyB;IACtD,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC;QACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAC1C,KAAK,EAAE,CAAC;aACL,MAAM,CAAC;YACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC9B,CAAC;aACD,WAAW,EAAE;aACb,QAAQ,EAAE;aACV,QAAQ,EAAE;KACd,CAAC;SACD,WAAW,EAAE;SACb,QAAQ,EAAE;SACV,QAAQ,EAAE;IACb,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,oBAAoB;IAChD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC"}