updates

Author: MrRefactoring

src/api/boards.ts

@@ -1,6 +1,6 @@
 import type { Client, Request } from '~/interfaces';
-import { boardSchema, Board, CreateBoard } from '~/schemas/api/boards';
-import { customFieldsSchema, TrelloId } from '~/schemas/common';
+import { boardSchema, Board, CreateBoard, CreateCustomField } from '~/schemas/api/boards';
+import { CustomField, CustomFields, customFieldSchema, customFieldsSchema, TrelloId } from '~/schemas/common';
 import { Members } from './members';
 
 export class Boards {
@@ -22,6 +22,7 @@ export class Boards {
   }
 
   async getAll() {
+    // todo js doc
     const boardsId = await this.membersClient.getBoards('me');
 
     const boards: Board[] = [];
@@ -55,13 +56,65 @@ export class Boards {
     return this.client.sendRequest(request);
   }
 
+  /** Create a new Custom Field on a board. */
+  async createCustomField(customField: CreateCustomField): Promise<CustomField> {
+    const request: Request = {
+      url: '/customFields',
+      method: 'POST',
+      body: {
+        idModel: customField.boardId,
+        modelType: 'board',
+        name: customField.name,
+        type: customField.type,
+        options: '', // todo
+        pos: customField.pos,
+        display_cardFront: customField.cardFront ?? true,
+      },
+    };
+
+    return this.client.sendRequest(request, customFieldSchema);
+  }
+
   /** Get the Custom Field Definitions that exist on a board. */
-  async getCustomFields(boardId: TrelloId) {
+  async getAllCustomFields(boardId: TrelloId): Promise<CustomFields> {
     const request: Request = {
       url: `/boards/${boardId}/customFields`,
       method: 'GET',
-    }
+    };
 
     return this.client.sendRequest(request, customFieldsSchema);
   }
+
+  async getCustomField(customFieldId: TrelloId): Promise<CustomField> {
+    const request: Request = {
+      url: `/customFields/${customFieldId}`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(request, customFieldSchema);
+  }
+
+  async updateCustomField(customFieldId: TrelloId): Promise<CustomField> {
+    const request: Request = {
+      url: `/boards/${customFieldId}`,
+      method: 'PUT',
+      body: {
+        // todo
+        name: '',
+        pos: '',
+        'display/cardFront': false,
+      },
+    };
+
+    return this.client.sendRequest(request, customFieldSchema);
+  }
+
+  async deleteCustomField(customFieldId: TrelloId): Promise<void> {
+    const request: Request = {
+      url: `/customFields/${customFieldId}`,
+      method: 'DELETE',
+    };
+
+    return this.client.sendRequest(request);
+  }
 }

src/interfaces/request.ts

@@ -1,7 +1,7 @@
-export interface Request<T = never> {
+export interface Request {
   url: string;
   method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
   headers?: Record<string, string | number>;
   query?: Record<string, string | number>;
-  body?: T;
+  body?: object;
 }

src/schemas/api/boards/createCustomFieldSchema.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+import { trelloIdSchema } from '~/schemas/common/trelloIdSchema';
+
+export const createCustomFieldSchema = z.object({
+
+  boardId: trelloIdSchema,
+  /**
+   * The name of the Custom Field
+   */
+  name: z.string(),
+  /**
+   * The type of Custom Field to create.
+   */
+  type: z.enum(['checkbox', 'list', 'number', 'text', 'date']),
+  pos: z.union([z.string(), z.number()]),
+  /**
+   * Whether this Custom Field should be shown on the front of Cards
+   *
+   * @default true
+   */
+  cardFront: z.boolean().optional(),
+}).strict();
+
+export type CreateCustomField = z.infer<typeof createCustomFieldSchema>;

src/schemas/api/boards/index.ts

@@ -1,2 +1,3 @@
 export * from './boardSchema';
 export * from './createBoardSchema';
+export * from './createCustomFieldSchema';

tests/integration/api/boards.test.ts

@@ -26,7 +26,7 @@ describe('Boards Service Integration Tests', () => {
   });
 
   it('should successfully get custom fields', async () => {
-    const customFields = await trelloClient.boards.getCustomFields('639cdbf9f5557e00df01180d'); // todo
+    const customFields = await trelloClient.boards.getAllCustomFields('639cdbf9f5557e00df01180d'); // todo
 
     console.log(customFields);
   })