updates

Author: MrRefactoring

src/api/boards.ts

@@ -1,17 +1,19 @@
 import type { Client, Request } from '@/interfaces';
-import { boardSchema, BoardSchema, CreateBoard } from '@/schemas/api/boards';
+import { boardSchema, Board, CreateBoard } from '@/schemas/api/boards';
 
 export class Boards {
   constructor(private client: Client) {}
 
   /** Create a new board. */
-  async createBoard<T = BoardSchema>(board: CreateBoard): Promise<T> {
+  async create<T = Board>(board: CreateBoard): Promise<T> {
     const request: Request = {
       url: '/boards',
       method: 'POST',
       query: board,
     };
 
-    return this.client.sendRequest(request, boardSchema);
+    return this.client.sendRequest<T, never>(request, boardSchema);
   }
+
+  async delete(boardId) {}
 }

src/baseClient.ts

@@ -29,6 +29,7 @@ export class BaseClient implements Client {
     });
 
     if (!response.ok) {
+      const text = await response.text();
       throw new Error('Request Error'); // todo handle error
     }
 

src/schemas/api/boards/boardSchema.ts

@@ -1,19 +1,21 @@
 import { z } from 'zod';
+import { prefsSchema } from '@/schemas/common/prefsSchema';
+import { colorSchema } from '@/schemas/common';
 
 export const boardSchema = z.object({
-  id: z.unknown(),
-  name: z.unknown(),
-  desc: z.unknown(),
-  descData: z.unknown(),
-  closed: z.unknown(),
+  id: z.string(),
+  name: z.string(),
+  desc: z.string(),
+  descData: z.string().nullable(),
+  closed: z.boolean(),
   idOrganization: z.unknown(),
   idEnterprise: z.unknown(),
-  pinned: z.unknown(),
-  url: z.unknown(),
-  shortUrl: z.unknown(),
-  prefs: z.unknown(),
-  labelNames: z.unknown(),
-  limits: z.unknown()
+  pinned: z.boolean(),
+  url: z.string().url(),
+  shortUrl: z.string().url(),
+  prefs: prefsSchema,
+  labelNames: z.record(colorSchema, z.string()),
+  limits: z.object({}).strict(),
 }).strict();
 
-export type BoardSchema = z.infer<typeof boardSchema>;
+export type Board = z.infer<typeof boardSchema>;

src/schemas/common/colorSchema.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+
+export const colorSchema = z.enum([
+  'green',
+  'yellow',
+  'orange',
+  'red',
+  'purple',
+  'blue',
+  'sky',
+  'lime',
+  'pink',
+  'black',
+  'green_dark',
+  'yellow_dark',
+  'orange_dark',
+  'red_dark',
+  'purple_dark',
+  'blue_dark',
+  'sky_dark',
+  'lime_dark',
+  'pink_dark',
+  'black_dark',
+  'green_light',
+  'yellow_light',
+  'orange_light',
+  'red_light',
+  'purple_light',
+  'blue_light',
+  'sky_light',
+  'lime_light',
+  'pink_light',
+  'black_light'
+]);

src/schemas/common/hexColorSchema.ts

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+
+export const hexColorSchema = z.string().regex(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/, {
+  message: 'Invalid hex color code',
+});

src/schemas/common/index.ts

@@ -0,0 +1,3 @@
+export * from './colorSchema';
+export * from './hexColorSchema';
+export * from './prefsSchema';

src/schemas/common/prefsSchema.ts

@@ -0,0 +1,41 @@
+import { z } from 'zod';
+import { colorSchema } from './colorSchema';
+import { hexColorSchema } from './hexColorSchema';
+
+export const prefsSchema = z.object({
+  permissionLevel: z.enum(['private']),
+  hideVotes: z.boolean(),
+  voting: z.enum(['disabled']),
+  comments: z.enum(['members']),
+  invitations: z.enum(['members']),
+  selfJoin: z.boolean(),
+  cardCovers: z.boolean(),
+  showCompleteStatus: z.boolean(),
+  cardCounts: z.boolean(),
+  isTemplate: z.boolean(),
+  cardAging: z.enum(['regular']),
+  calendarFeedEnabled: z.boolean(),
+  hiddenPluginBoardButtons: z.array(z.unknown()),
+  switcherViews: z.array(z.object({
+    viewType: z.enum(['Board', 'Table', 'Calendar', 'Dashboard', 'Timeline', 'Map']),
+    enabled: z.boolean(),
+  }).strict()),
+  background: colorSchema,
+  backgroundColor: hexColorSchema,
+  backgroundDarkColor: hexColorSchema.nullable(),
+  backgroundImage: z.unknown().nullable(),
+  backgroundDarkImage: z.unknown().nullable(),
+  backgroundImageScaled: z.unknown().nullable(),
+  backgroundTile: z.boolean(),
+  backgroundBrightness: z.enum(['dark']),
+  sharedSourceUrl: z.string().url().nullable(),
+  backgroundBottomColor: hexColorSchema,
+  backgroundTopColor: hexColorSchema,
+  canBePublic: z.boolean(),
+  canBeEnterprise: z.boolean(),
+  canBeOrg: z.boolean(),
+  canBePrivate: z.boolean(),
+  canInvite: z.boolean(),
+}).strict();
+
+export type Prefs = z.infer<typeof prefsSchema>;

tests/integration/api/boards.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import { type BoardSchema, CreateBoard } from '@/schemas/api/boards';
+import { Board, CreateBoard } from '@/schemas/api/boards';
 import { TrelloClient } from '@';
 import { config } from '@tests/integration/config';
 
@@ -9,14 +9,17 @@ const mockBoardInput: CreateBoard = {
 };
 
 describe('Boards Service Integration Tests', () => {
+  let board: Board | undefined;
   const trelloClient = new TrelloClient(config);
 
   it('should successfully create a board with valid input', async () => {
-    const result = await trelloClient.boards.createBoard(mockBoardInput);
+    board = await trelloClient.boards.createBoard<Board>(mockBoardInput); // todo remove generic use
 
-    // Verify the response matches our mock data
-    expect(result).toBeDefined();
-
-    // expect(result.id).toBe('board-123');
+    expect(board).toBeDefined();
+    expect(board.name).toBe(mockBoardInput.name);
   });
+
+  it('should successfully delete a board', async () => {
+
+  })
 });