updates

Author: MrRefactoring

package.json

@@ -45,7 +45,7 @@
     "prettier-plugin-jsdoc": "^1.3.2",
     "rollup": "^4.40.0",
     "tslib": "^2.8.1",
-    "typedoc": "^0.28.2",
+    "typedoc": "^0.28.3",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.30.1",
     "vitest": "^3.1.1"

pnpm-lock.yaml

@@ -1,6 +1,6 @@
 import type { Client, Request } from '~/interfaces';
 import { boardSchema, Board, CreateBoard } from '~/schemas/api/boards';
-import { TrelloId } from '~/schemas/common';
+import { customFieldsSchema, TrelloId } from '~/schemas/common';
 import { Members } from './members';
 
 export class Boards {
@@ -21,18 +21,10 @@ export class Boards {
     return this.client.sendRequest<T, never>(request, boardSchema);
   }
 
-  // async list() {
-  //   const request: Request = {
-  //     url: '/members/me/'
-  //   };
-  //
-  //   return this.client.sendRequest(request);
-  // }
-
   async getAll() {
     const boardsId = await this.membersClient.getBoards('me');
 
-    const  boards: Board[] = [];
+    const boards: Board[] = [];
 
     for (const { id } of boardsId) {
       const board = await this.get(id);
@@ -54,5 +46,22 @@ export class Boards {
     return this.client.sendRequest(request, boardSchema);
   }
 
-  // async delete(boardId) {}
+  async delete(boardId: TrelloId) {
+    const request: Request = {
+      url: `/boards/${boardId}`,
+      method: 'DELETE',
+    };
+
+    return this.client.sendRequest(request);
+  }
+
+  /** Get the Custom Field Definitions that exist on a board. */
+  async getCustomFields(boardId: TrelloId) {
+    const request: Request = {
+      url: `/boards/${boardId}/customFields`,
+      method: 'GET',
+    }
+
+    return this.client.sendRequest(request, customFieldsSchema);
+  }
 }

src/api/boards.ts

@@ -0,0 +1,37 @@
+import { z } from 'zod';
+import { trelloIdSchema } from './trelloIdSchema';
+import { colorSchema } from '~/schemas/common/colorSchema';
+
+const baseCustomFieldSchema = z.object({
+  id: trelloIdSchema,
+  idModel: z.string(),
+  modelType: z.enum(['card', 'board', 'member']),
+  fieldGroup:  z.string(),
+  name: z.string(),
+  pos: z.number(),
+  type: z.string(),
+  isSuggestedField: z.boolean(),
+  display: z.object({
+    cardFront: z.boolean(),
+  }).strict(),
+}).strict();
+
+export const customFieldSchema = z.discriminatedUnion('type', [
+  baseCustomFieldSchema.extend({
+    type: z.literal('date'),
+  }),
+  baseCustomFieldSchema.extend({
+    type: z.literal('list'),
+    options: z.array(z.object({
+      id: trelloIdSchema,
+      idCustomField: trelloIdSchema,
+      value: z.object({
+        text: z.string(),
+      }).strict(),
+      color: z.union([colorSchema, z.literal('none')]),
+      pos: z.number(),
+    }).strict())
+  }),
+]);
+
+export type CustomField = z.infer<typeof customFieldSchema>;

src/schemas/common/customFieldSchema.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+import { customFieldSchema } from '~/schemas/common/customFieldSchema';
+
+export const customFieldsSchema = z.array(customFieldSchema);
+
+export type CustomFields = z.infer<typeof customFieldSchema>;

src/schemas/common/customFieldsSchema.ts

@@ -1,5 +1,7 @@
 export * from './backgroundScaledImageSchema';
 export * from './colorSchema';
+export * from './customFieldSchema';
+export * from './customFieldsSchema';
 export * from './hexColorSchema';
 export * from './prefsSchema';
 export * from './trelloIdSchema';

src/schemas/common/index.ts

@@ -11,7 +11,7 @@ export const prefsSchema = z
     backgroundBrightness: z.enum(['light', 'dark']),
     backgroundColor: hexColorSchema.nullable(),
     backgroundDarkColor: hexColorSchema.nullable(),
-    backgroundDarkImage: z.unknown().nullable(),
+    backgroundDarkImage: z.string().url().nullable(),
     backgroundImage: z.string().url().nullable(),
     backgroundImageScaled: z.array(backgroundScaledImageSchema).nullable(),
     backgroundTile: z.boolean(),

src/schemas/common/prefsSchema.ts

@@ -19,13 +19,19 @@ describe('Boards Service Integration Tests', () => {
     expect(board.name).toBe(mockBoardInput.name);
   });
 
-  it('should successfully get all boards', async () => {
+  it.skip('should successfully get all boards', async () => {
     const boards = await trelloClient.boards.getAll();
 
     console.log(boards);
   });
 
-  it.skip('should successfully delete a board', async () => {
+  it('should successfully get custom fields', async () => {
+    const customFields = await trelloClient.boards.getCustomFields('639cdbf9f5557e00df01180d'); // todo
+
+    console.log(customFields);
+  })
 
+  it.skip('should successfully delete a board', async () => {
+    await trelloClient.boards.delete(board!.id);
   })
 });