feat: export type declarations

Author: dubisdev

package.json

@@ -2,15 +2,22 @@
   "name": "todoist-rest-client",
   "version": "2.0.4",
   "description": "A simple todoist-rest-api client",
-  "author": "Dubisdev",
+  "author": "David Jiménez",
   "license": "MIT",
-  "main": "dist/index.js",
-  "type": "module",
-  "types": "dist/index.d.ts",
   "keywords": [
     "todoist",
     "rest-client"
   ],
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "types": "dist/index.d.ts",
   "dependencies": {
     "axios": "^0.24.0"
   },

src/TDSClient.ts

@@ -1,5 +1,6 @@
 import task from "./submodules/task";
 import project from "./submodules/project";
+import { ClientConstructor, TDSClient } from "./definitions";
 
 const TDSClientConstructor: ClientConstructor = (apiToken): TDSClient => {
 	if (!apiToken) throw new Error("Missing api token");

src/__tests__/projects.tests.ts

@@ -1,4 +1,5 @@
 import TDSClient, { Project } from "..";
+import { ClientCreatedProject } from "../definitions";
 
 const myClient = TDSClient(process.env.TODOIST_TOKEN);
 

src/__tests__/task.tests.ts

@@ -1,4 +1,5 @@
 import TDSClient, { Task } from "..";
+import { APITaskObject, ClientCreatedTask } from "../definitions";
 
 const myClient = TDSClient(process.env.TODOIST_TOKEN);
 

src/definitions/APIResponses.d.ts

@@ -0,0 +1,16 @@
+import { TaskModule, ProjectModule } from ".";
+import { AxiosRequestHeaders } from "axios";
+
+export interface AuthHeader extends AxiosRequestHeaders {
+	Authorization: string;
+}
+
+export interface TDSClient {
+	apiToken: string;
+	task: TaskModule;
+	project: ProjectModule;
+}
+
+export interface ClientConstructor {
+	(apiToken?: string): TDSClient;
+}

src/definitions/Client.d.ts

@@ -0,0 +1,41 @@
+import { AxiosResponse } from "axios";
+
+export interface ProjectModule {
+	create: (
+		project?: UserCreatedProject | ClientCreatedProject
+	) => Promise<APIProjectObject>;
+	getAll: () => Promise<string[]>;
+	getAllJSON: () => Promise<APIProjectObject[]>;
+	get: (id: string | number) => Promise<APIProjectObject>;
+	delete: (id: string | number) => Promise<AxiosResponse>;
+}
+
+/* CLIENT-LEVEL INTERFACES */
+
+export interface UserCreatedProject {
+	name?: string;
+	parent_id?: string;
+	color?: string;
+	favorite?: boolean;
+}
+
+export interface ClientCreatedProject extends UserCreatedProject {
+	name: string;
+}
+
+/* API-LEVEL INTERFACES */
+
+export interface APIProjectObject {
+	id: number;
+	name: string;
+	comment_count: number;
+	order: number;
+	color: number;
+	shared: boolean;
+	sync_id: number;
+	favorite: boolean;
+	parent_id?: number;
+	team_inbox?: boolean;
+	inbox_project?: boolean;
+	url: string;
+}