Merge pull request #56 from dubisdev/v3

v3

Author: dubisdev

.github/workflows/tests.yml

@@ -1,6 +1,6 @@
 name: Run Tests
 
-on: [pull_request, push]
+on: [pull_request]
 
 jobs:
   run_tests:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "todoist-rest-client",
-  "version": "2.5.0",
+  "version": "3.0.0",
   "description": "A simple todoist-rest-api client",
   "author": "dubisdev",
   "license": "MIT",
@@ -20,12 +20,13 @@
   "types": "dist/index.d.ts",
   "dependencies": {
     "axios": "^0.24.0",
-    "moment": "^2.29.1"
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
+    "@types/uuid": "^8.3.1",
     "dotenv": "^10.0.0",
-    "jest": "^27.3.0",
+    "jest": "^27.3.1",
     "ts-jest": "^27.0.7",
     "typescript": "^4.4.4"
   },

src/TDSClient.ts

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

src/__tests__/comments.tests.ts

@@ -7,9 +7,8 @@ const myClient = TDSClient(process.env.TODOIST_TOKEN);
 let inboxProjectID: number;
 beforeAll(async () => {
 	inboxProjectID =
-		(await myClient.project.getAllJSON()).find(
-			(project) => project.inbox_project
-		)?.id || 0;
+		(await myClient.project.getAll()).find((project) => project.inbox_project)
+			?.id || 0;
 });
 
 describe("Client-Side Comment Creation", () => {
@@ -65,7 +64,7 @@ describe("API Comment Functions", () => {
 	});
 
 	test("Get All Comments", async () => {
-		const responseComments = await myClient.comment.getAllJSON({
+		const responseComments = await myClient.comment.getAll({
 			project_id: inboxProjectID,
 		});
 		const testCommmentExists = responseComments.some(
@@ -85,7 +84,7 @@ describe("API Comment Functions", () => {
 	});
 
 	test("Delete All Previous Comments", async () => {
-		let allCommentsJSON = await myClient.comment.getAllJSON({
+		let allCommentsJSON = await myClient.comment.getAll({
 			project_id: inboxProjectID,
 		});
 

src/__tests__/labels.tests.ts

@@ -44,7 +44,7 @@ describe("API Label Functions", () => {
 	});
 
 	test("Get All Labels", async () => {
-		const responseLabels = await myClient.label.getAllJSON();
+		const responseLabels = await myClient.label.getAll();
 		const testLabelExists = responseLabels.some(
 			(labelObj) => labelObj.name === "Test_Label"
 		);
@@ -54,7 +54,7 @@ describe("API Label Functions", () => {
 	});
 
 	test("Get All Label Names", async () => {
-		const responseLabels = await myClient.label.getAll();
+		const responseLabels = await myClient.extras.getAllLabelNames();
 		const testLabelExists = responseLabels.some(
 			(name) => name === "Test_Label"
 		);
@@ -72,7 +72,7 @@ describe("API Label Functions", () => {
 	});
 
 	test("Delete All Previous Labels", async () => {
-		let allLabelsJSON = await myClient.label.getAllJSON();
+		let allLabelsJSON = await myClient.label.getAll();
 
 		let responses = await Promise.all(
 			allLabelsJSON.map(async (label) => myClient.label.delete(label.id))

src/__tests__/projects.tests.ts

@@ -52,7 +52,7 @@ describe("API Project Functions", () => {
 
 	// 4 active projects now
 	test("Get All Active Projects JSON", async () => {
-		const responseProjects = await myClient.project.getAllJSON();
+		const responseProjects = await myClient.project.getAll();
 
 		const projectExists = responseProjects.some(
 			(projectObj) => projectObj.name === "P2"
@@ -62,12 +62,9 @@ describe("API Project Functions", () => {
 		expect(projectExists).toBe(true);
 	});
 
-	test("Get All Active Project Names", async () => {
-		const responseProjects = await myClient.project.getAll();
-		const projectExists = responseProjects.some((name) => name === "P2");
-
-		expect(responseProjects.length).toBe(4);
-		expect(projectExists).toBe(true);
+	test("Test getAllProjectNames", async () => {
+		let names = await myClient.extras.getAllProjectNames();
+		expect(typeof names[0]).toEqual("string");
 	});
 
 	test("Update a project", async () => {
@@ -87,7 +84,7 @@ describe("API Project Functions", () => {
 	});
 
 	test("Delete All Previous Projects", async () => {
-		let allProjectsJSON = await myClient.project.getAllJSON();
+		let allProjectsJSON = await myClient.project.getAll();
 
 		let responses = await Promise.all(
 			allProjectsJSON.map(async (project) => {

src/__tests__/section.tests.ts

@@ -7,9 +7,8 @@ const myClient = TDSClient(process.env.TODOIST_TOKEN);
 let inboxProjectID: number;
 beforeAll(async () => {
 	inboxProjectID =
-		(await myClient.project.getAllJSON()).find(
-			(project) => project.inbox_project
-		)?.id || 0;
+		(await myClient.project.getAll()).find((project) => project.inbox_project)
+			?.id || 0;
 });
 
 describe("Client-Side Section Creation", () => {
@@ -69,7 +68,7 @@ describe("API Section Functions", () => {
 	});
 
 	test("Get All Sections", async () => {
-		const responseSections = await myClient.section.getAllJSON(inboxProjectID);
+		const responseSections = await myClient.section.getAll(inboxProjectID);
 		const sectionExists = responseSections.some(
 			(sectionObj) => sectionObj.name === "Section 2"
 		);
@@ -79,7 +78,9 @@ describe("API Section Functions", () => {
 	});
 
 	test("Get All Section Names", async () => {
-		const responseSections = await myClient.section.getAll();
+		const responseSections = await myClient.extras.getAllSectionNames(
+			inboxProjectID
+		);
 		const sectionExists = responseSections.some((name) => name === "Section 2");
 
 		expect(responseSections.length).toBe(3);
@@ -89,12 +90,10 @@ describe("API Section Functions", () => {
 	test("Get Sections from Project (Inbox)", async () => {
 		const responseSections = await myClient.section.getAll(inboxProjectID);
 		const testSectionExists = responseSections.some(
-			(name) => name === "Test Section"
+			({ name }) => name === "Test Section"
 		);
 
 		expect(responseSections.length).toBe(3);
-		expect(typeof responseSections[0]).toBe("string");
-
 		expect(testSectionExists).toBe(true);
 	});
 
@@ -107,7 +106,7 @@ describe("API Section Functions", () => {
 	});
 
 	test("Delete All Previous Sections", async () => {
-		let allSectionsJSON = await myClient.section.getAllJSON();
+		let allSectionsJSON = await myClient.section.getAll();
 
 		let responses = await Promise.all(
 			allSectionsJSON.map(async (section) =>

src/__tests__/task.tests.ts

@@ -1,11 +1,10 @@
 import TDSClient, { Task } from "..";
 import { APITaskObject, CreatableTask } from "../definitions";
-import moment from "moment";
 
 const myClient = TDSClient(process.env.TODOIST_TOKEN);
 
 beforeAll(async () => {
-	let allTasksJSON = await myClient.task.getAllJSON();
+	let allTasksJSON = await myClient.task.getAll();
 	await Promise.all(allTasksJSON.map((task) => myClient.task.delete(task.id)));
 	console.log("Init: Deleted all tasks!");
 });
@@ -58,7 +57,7 @@ describe("API Tasks Functions", () => {
 	});
 
 	test("Close A Task", async () => {
-		let status = (await myClient.task.closeTask(generalExpectedTaskID)).status;
+		let status = (await myClient.task.close(generalExpectedTaskID)).status;
 
 		expect(status).toBe(204);
 	});
@@ -85,7 +84,7 @@ describe("API Tasks Functions", () => {
 	});
 
 	test("Get All Active Tasks JSON", async () => {
-		const responseTasks = await myClient.task.getAllJSON();
+		const responseTasks = await myClient.task.getAll();
 
 		const taskExists = responseTasks.some(
 			(taskObj) => taskObj.content === "Second task"
@@ -95,16 +94,8 @@ describe("API Tasks Functions", () => {
 		expect(taskExists).toBe(true);
 	});
 
-	test("Get All Active Tasks Names", async () => {
-		const responseTasks = await myClient.task.getAll();
-		const taskExists = responseTasks.some((name) => name === "Second task");
-
-		expect(responseTasks.length).toBe(2);
-		expect(taskExists).toBe(true);
-	});
-
 	test("Delete All Previous Tasks", async () => {
-		let allTasksJSON = await myClient.task.getAllJSON();
+		let allTasksJSON = await myClient.task.getAll();
 		let responses = await Promise.all(
 			allTasksJSON.map((task) => myClient.task.delete(task.id))
 		);
@@ -130,27 +121,22 @@ describe("API Tasks Functions", () => {
 		let allTodayJSON, allTodayNames;
 
 		await Promise.all([
-			(allTodayJSON = await myClient.task.getTodayJSON()),
-			(allTodayNames = await myClient.task.getToday()),
+			(allTodayJSON = await myClient.extras.getTodayTaskJSON()),
+			(allTodayNames = await myClient.extras.getTodayTaskNames()),
 		]);
-
 		const firstTaskExists =
 			allTodayJSON.some((taskObj) => taskObj.content === "First task") &&
 			allTodayNames.some((name) => name === "First task");
 
-		let normalDate = new Date().toISOString().substring(0, 10);
-		let momentDate = moment.parseZone(new Date()).format().substring(0, 10);
-
-		if (normalDate === momentDate) {
-			// GMT day = local day
-			expect(allTodayJSON.length).toBe(2);
-			expect(typeof allTodayJSON[0]).toBe("object");
-			expect(firstTaskExists).toBe(true);
-		} else {
-			// GMT day != local day (offset influence in day)
-			expect(allTodayJSON.length).toBe(0);
-			expect(firstTaskExists).toBe(false);
-		}
+		expect(allTodayJSON.length).toBe(2);
+		expect(typeof allTodayJSON[0]).toBe("object");
+		expect(firstTaskExists).toBe(true);
+	});
+
+	test("Test getAllTaskNames", async () => {
+		let names = await myClient.extras.getAllTaskNames();
+
+		expect(typeof names[0]).toEqual("string");
 	});
 
 	test("Search Tasks", async () => {
@@ -171,7 +157,7 @@ describe("API Tasks Functions", () => {
 });
 
 afterAll(async () => {
-	let allTasksJSON = await myClient.task.getAllJSON();
+	let allTasksJSON = await myClient.task.getAll();
 	await Promise.all(allTasksJSON.map((task) => myClient.task.delete(task.id)));
 	console.log("Finish: Deleted all tasks!");
 });

src/definitions/Client.ts

@@ -4,6 +4,7 @@ import {
 	SectionModule,
 	LabelModule,
 	CommentModule,
+	ExtrasModule,
 } from ".";
 import { AxiosRequestHeaders } from "axios";
 
@@ -18,6 +19,7 @@ export interface TDSClient {
 	section: SectionModule;
 	label: LabelModule;
 	comment: CommentModule;
+	extras: ExtrasModule;
 }
 
 export interface ClientConstructor {

src/definitions/Comments.ts

@@ -2,11 +2,9 @@ import { AxiosResponse } from "axios";
 
 export interface CommentModule {
 	get: (id: string | number) => Promise<APICommentObject>;
-
 	create: (comment: CreatableComment) => Promise<APICommentObject>;
 	delete: (id: number | string) => Promise<AxiosResponse>;
-	getAllJSON: (params: CommentSearchableParams) => Promise<APICommentObject[]>;
-
+	getAll: (params: CommentSearchableParams) => Promise<APICommentObject[]>;
 	update: (
 		id: number | string,
 		comment: CommentUpdatableParameters
@@ -23,14 +21,14 @@ export type UserCreatedProjectComment = {
 	task_id?: undefined;
 	project_id: number;
 	content?: string;
-	attachment?: object;
+	attachment?: TodoistFile;
 };
 
 export type UserCreatedTaskComment = {
 	task_id: number;
 	project_id?: undefined;
 	content?: string;
-	attachment?: object;
+	attachment?: TodoistFile;
 };
 
 export type CreatableComment = UserCreatedComment & {
@@ -41,28 +39,21 @@ export type CreatableComment = UserCreatedComment & {
 
 export type APICommentObject = APIProjectCommentObject | APITaskCommentObject;
 
-const myComment: APICommentObject = {
-	id: 123456,
-	posted: "",
-	content: "",
-	project_id: 123456,
-};
-
 export type APIProjectCommentObject = {
 	id: number;
 	project_id: number;
 	task_id?: undefined;
 	posted: string;
 	content: string;
-	attachment?: object;
+	attachment?: TodoistFile;
 };
 export type APITaskCommentObject = {
 	id: number;
 	task_id: number;
 	project_id?: undefined;
 	posted: string;
 	content: string;
-	attachment?: object;
+	attachment?: TodoistFile;
 };
 
 // See https://developer.todoist.com/rest/v1/#update-a-comment
@@ -73,3 +64,28 @@ export interface CommentUpdatableParameters {
 export type CommentSearchableParams =
 	| { project_id: number; task_id?: undefined }
 	| { task_id: number; project_id?: undefined };
+
+export interface BaseFileProperties {
+	file_name: string;
+	file_size: number;
+	file_type: string;
+	file_url: string;
+	upload_state?: "pending" | "completed";
+}
+
+export interface ImageFileProperties {
+	tn_l: [string, number, number];
+	tn_m: [string, number, number];
+	tn_s: [string, number, number];
+	file_duration?: undefined;
+}
+
+export interface AudioFileProperties {
+	file_duration: number;
+	tn_l?: undefined;
+	tn_m?: undefined;
+	tn_s?: undefined;
+}
+
+export type TodoistFile = BaseFileProperties &
+	(ImageFileProperties | AudioFileProperties);