feat: add label functions

Author: dubisdev

src/TDSClient.ts

@@ -1,6 +1,7 @@
 import task from "./submodules/task";
 import project from "./submodules/project";
 import section from "./submodules/section";
+import label from "./submodules/label";
 import { ClientConstructor, TDSClient } from "./definitions";
 
 const TDSClientConstructor: ClientConstructor = (apiToken): TDSClient => {
@@ -13,6 +14,7 @@ const TDSClientConstructor: ClientConstructor = (apiToken): TDSClient => {
 		task: task(headers),
 		project: project(headers),
 		section: section(headers),
+		label: label(headers),
 	};
 };
 

src/__tests__/labels.tests.ts

@@ -0,0 +1,83 @@
+import TDSClient, { Label } from "..";
+import { CreatableLabel } from "../definitions";
+
+const myClient = TDSClient(process.env.TODOIST_TOKEN);
+
+describe("Client-Side Label Creation", () => {
+	test("Create Empty Label", () => {
+		const emptyLabel = Label({});
+		expect(emptyLabel).toMatchObject<CreatableLabel>({
+			name: "_No_Label_Name_Provided_",
+		});
+	});
+
+	test("Create Normal Label", () => {
+		let myLabel = Label({ name: "Label Name" });
+
+		expect(myLabel).toMatchObject<CreatableLabel>({ name: "Label Name" });
+	});
+});
+
+describe("API Label Functions", () => {
+	let labelID: number;
+
+	test("Create A Label", async () => {
+		let apiLabel = await myClient.label.create({ name: "Test Label" });
+
+		expect(apiLabel.id).toBeTruthy();
+
+		labelID = apiLabel.id;
+	});
+
+	test("Get A Label", async () => {
+		let apiLabel = await myClient.label.get(labelID);
+
+		expect(apiLabel.name).toBe("Test_Label");
+	});
+
+	// 2 active projects now
+	test("Create Two More Labels", async () => {
+		return await Promise.all([
+			myClient.label.create({ name: "Label 2" }),
+			myClient.label.create({ name: "Label 3" }),
+		]);
+	});
+
+	test("Get All Labels", async () => {
+		const responseLabels = await myClient.label.getAllJSON();
+		const testLabelExists = responseLabels.some(
+			(labelObj) => labelObj.name === "Test_Label"
+		);
+
+		expect(responseLabels.length).toBe(3);
+		expect(testLabelExists).toBe(true);
+	});
+
+	test("Get All Label Names", async () => {
+		const responseLabels = await myClient.label.getAll();
+		const testLabelExists = responseLabels.some(
+			(name) => name === "Test_Label"
+		);
+
+		expect(responseLabels.length).toBe(3);
+		expect(testLabelExists).toBe(true);
+	});
+
+	test("Update a label", async () => {
+		const repsonse = await myClient.label.update(labelID, {
+			name: "New label name",
+		});
+
+		expect(repsonse.status).toBe(204);
+	});
+
+	test("Delete All Previous Labels", async () => {
+		let allLabelsJSON = await myClient.label.getAllJSON();
+
+		let responses = await Promise.all(
+			allLabelsJSON.map(async (label) => myClient.label.delete(label.id))
+		);
+
+		responses.forEach(({ status }) => expect(status).toBe(204));
+	});
+});

src/definitions/Client.ts

@@ -1,4 +1,4 @@
-import { TaskModule, ProjectModule, SectionModule } from ".";
+import { TaskModule, ProjectModule, SectionModule, LabelModule } from ".";
 import { AxiosRequestHeaders } from "axios";
 
 export interface AuthHeader extends AxiosRequestHeaders {
@@ -10,6 +10,7 @@ export interface TDSClient {
 	task: TaskModule;
 	project: ProjectModule;
 	section: SectionModule;
+	label: LabelModule;
 }
 
 export interface ClientConstructor {

src/definitions/Labels.ts

@@ -0,0 +1,45 @@
+import { AxiosResponse } from "axios";
+import { ProjectColor } from ".";
+
+export interface LabelModule {
+	create: (label: CreatableLabel) => Promise<APILabelObject>;
+	delete: (id: number | string) => Promise<AxiosResponse>;
+	getAllJSON: () => Promise<APILabelObject[]>;
+	getAll: () => Promise<string[]>;
+	get: (id: string | number) => Promise<APILabelObject>;
+	update: (
+		id: number | string,
+		label: LabelUpdatableParameters
+	) => Promise<AxiosResponse>;
+}
+
+/* CLIENT-LEVEL INTERFACES */
+
+export interface UserCreatedLabel {
+	name?: string;
+	order?: number;
+	color?: ProjectColor;
+	favorite?: boolean;
+}
+
+export interface CreatableLabel extends UserCreatedLabel {
+	name: string;
+}
+
+/* API-LEVEL INTERFACES */
+
+export interface APILabelObject {
+	id: number;
+	name: string;
+	color: ProjectColor;
+	order: number;
+	favorite: boolean;
+}
+
+// See https://developer.todoist.com/rest/v1/#update-a-label
+export interface LabelUpdatableParameters {
+	name?: string;
+	color?: ProjectColor;
+	order?: number;
+	favorite?: boolean;
+}

src/definitions/index.ts

@@ -2,3 +2,4 @@ export * from "./Client";
 export * from "./Projects";
 export * from "./Tasks";
 export * from "./Sections";
+export * from "./Labels";

src/resources/Label.ts

@@ -0,0 +1,12 @@
+import { CreatableLabel, UserCreatedLabel } from "../definitions";
+
+const Label = (label: UserCreatedLabel): CreatableLabel => {
+	const { name = "_No_Label_Name_Provided_", ...restOfProperties } = label;
+
+	return {
+		name,
+		...restOfProperties,
+	};
+};
+
+export default Label;

src/resources/index.ts

@@ -1,5 +1,6 @@
 import Task from "./Task";
 import Project from "./Project";
 import Section from "./Section";
+import Label from "./Label";
 
-export { Task, Project, Section };
+export { Task, Project, Section, Label };

src/submodules/label.ts

@@ -0,0 +1,61 @@
+import axios from "axios";
+import { AuthHeader, APILabelObject, LabelModule } from "../definitions";
+
+const labelClientModule = (headers: AuthHeader): LabelModule => {
+	const getOneJSON = async (id: number | string) => {
+		let { data } = await axios.get(
+			`https://api.todoist.com/rest/v1/labels/${id}`,
+			{ headers }
+		);
+		return data as APILabelObject;
+	};
+
+	const getAllJSON = async () => {
+		let { data } = await axios.get(`https://api.todoist.com/rest/v1/labels`, {
+			headers,
+		});
+
+		return data as APILabelObject[];
+	};
+
+	return {
+		create: async (label) => {
+			let { data } = await axios.post(
+				`https://api.todoist.com/rest/v1/labels`,
+				label,
+				{ headers }
+			);
+			return data as APILabelObject;
+		},
+
+		getAll: async () => {
+			let json = await getAllJSON();
+			let arrayLabels: string[] = [];
+			json.forEach((label) => arrayLabels.push(label.name));
+			return arrayLabels;
+		},
+
+		getAllJSON,
+
+		get: async (id) => {
+			let project = await getOneJSON(id);
+			return project;
+		},
+
+		delete: async (id) => {
+			return await axios.delete(
+				`https://api.todoist.com/rest/v1/labels/${id}`,
+				{ headers }
+			);
+		},
+
+		update: async (id, label) => {
+			return await axios.post(
+				`https://api.todoist.com/rest/v1/labels/${id}`,
+				label,
+				{ headers }
+			);
+		},
+	};
+};
+export default labelClientModule;