@doist/todoist-api-typescript 1.5.0

package/dist/authentication.js

@@ -0,0 +1,87 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revokeAuthToken = exports.getAuthToken = exports.getAuthorizationUrl = exports.getAuthStateParameter = void 0;
+var restClient_1 = require("./restClient");
+var uuid_1 = require("uuid");
+var types_1 = require("./types");
+var endpoints_1 = require("./consts/endpoints");
+function getAuthStateParameter() {
+    return (0, uuid_1.v4)();
+}
+exports.getAuthStateParameter = getAuthStateParameter;
+function getAuthorizationUrl(clientId, permissions, state) {
+    if (!(permissions === null || permissions === void 0 ? void 0 : permissions.length)) {
+        throw new Error('At least one scope value should be passed for permissions.');
+    }
+    var scope = permissions.join(',');
+    return "" + endpoints_1.API_AUTHORIZATION_BASE_URI + endpoints_1.ENDPOINT_AUTHORIZATION + "?client_id=" + clientId + "&scope=" + scope + "&state=" + state;
+}
+exports.getAuthorizationUrl = getAuthorizationUrl;
+function getAuthToken(args) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, (0, restClient_1.request)('POST', endpoints_1.API_AUTHORIZATION_BASE_URI, endpoints_1.ENDPOINT_GET_TOKEN, undefined, args)];
+                case 1:
+                    response = _b.sent();
+                    if (response.status !== 200 || !((_a = response.data) === null || _a === void 0 ? void 0 : _a.accessToken)) {
+                        throw new types_1.TodoistRequestError('Authentication token exchange failed.', response.status, response.data);
+                    }
+                    return [2 /*return*/, response.data];
+            }
+        });
+    });
+}
+exports.getAuthToken = getAuthToken;
+function revokeAuthToken(args) {
+    return __awaiter(this, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, restClient_1.request)('POST', endpoints_1.API_SYNC_BASE_URI, endpoints_1.ENDPOINT_REVOKE_TOKEN, undefined, args)];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, (0, restClient_1.isSuccess)(response)];
+            }
+        });
+    });
+}
+exports.revokeAuthToken = revokeAuthToken;

package/dist/consts/endpoints.d.ts

@@ -0,0 +1,15 @@
+export declare const API_REST_BASE_URI = "https://api.todoist.com/rest/v1/";
+export declare const API_SYNC_BASE_URI = "https://api.todoist.com/sync/v8/";
+export declare const API_AUTHORIZATION_BASE_URI = "https://todoist.com/oauth/";
+export declare const ENDPOINT_REST_TASKS = "tasks";
+export declare const ENDPOINT_REST_PROJECTS = "projects";
+export declare const ENDPOINT_REST_SECTIONS = "sections";
+export declare const ENDPOINT_REST_LABELS = "labels";
+export declare const ENDPOINT_REST_COMMENTS = "comments";
+export declare const ENDPOINT_REST_TASK_CLOSE = "close";
+export declare const ENDPOINT_REST_TASK_REOPEN = "reopen";
+export declare const ENDPOINT_REST_PROJECT_COLLABORATORS = "collaborators";
+export declare const ENDPOINT_SYNC_QUICK_ADD = "quick/add";
+export declare const ENDPOINT_AUTHORIZATION = "authorize";
+export declare const ENDPOINT_GET_TOKEN = "access_token";
+export declare const ENDPOINT_REVOKE_TOKEN = "access_tokens/revoke";

package/dist/consts/endpoints.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASKS = exports.API_AUTHORIZATION_BASE_URI = exports.API_SYNC_BASE_URI = exports.API_REST_BASE_URI = void 0;
+exports.API_REST_BASE_URI = 'https://api.todoist.com/rest/v1/';
+exports.API_SYNC_BASE_URI = 'https://api.todoist.com/sync/v8/';
+exports.API_AUTHORIZATION_BASE_URI = 'https://todoist.com/oauth/';
+exports.ENDPOINT_REST_TASKS = 'tasks';
+exports.ENDPOINT_REST_PROJECTS = 'projects';
+exports.ENDPOINT_REST_SECTIONS = 'sections';
+exports.ENDPOINT_REST_LABELS = 'labels';
+exports.ENDPOINT_REST_COMMENTS = 'comments';
+exports.ENDPOINT_REST_TASK_CLOSE = 'close';
+exports.ENDPOINT_REST_TASK_REOPEN = 'reopen';
+exports.ENDPOINT_REST_PROJECT_COLLABORATORS = 'collaborators';
+exports.ENDPOINT_SYNC_QUICK_ADD = 'quick/add';
+exports.ENDPOINT_AUTHORIZATION = 'authorize';
+exports.ENDPOINT_GET_TOKEN = 'access_token';
+exports.ENDPOINT_REVOKE_TOKEN = 'access_tokens/revoke';

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './TodoistApi';
+export * from './restClient';
+export * from './authentication';
+export * from './types';
+export * from './utils';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./TodoistApi"), exports);
+__exportStar(require("./restClient"), exports);
+__exportStar(require("./authentication"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);

package/dist/restClient.d.ts

@@ -0,0 +1,4 @@
+import { AxiosResponse } from 'axios';
+import { HttpMethod } from './types/http';
+export declare function isSuccess(response: AxiosResponse): boolean;
+export declare function request<T extends unknown>(httpMethod: HttpMethod, baseUri: string, relativePath: string, apiToken?: string, payload?: unknown, requestId?: string): Promise<AxiosResponse<T>>;

package/dist/restClient.js

@@ -0,0 +1,144 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.request = exports.isSuccess = void 0;
+var axios_1 = __importDefault(require("axios"));
+var axios_case_converter_1 = __importDefault(require("axios-case-converter"));
+var url_join_1 = __importDefault(require("url-join"));
+var errors_1 = require("./types/errors");
+var uuid_1 = require("uuid");
+var axios_retry_1 = __importDefault(require("axios-retry"));
+var defaultHeaders = {
+    'Content-Type': 'application/json',
+};
+function getAuthHeader(apiKey) {
+    return "Bearer " + apiKey;
+}
+function isNetworkError(error) {
+    return Boolean(!error.response && error.code !== 'ECONNABORTED');
+}
+function getRetryDelay(retryCount) {
+    return retryCount === 1 ? 0 : 500;
+}
+function isAxiosError(error) {
+    var _a;
+    return Boolean((_a = error) === null || _a === void 0 ? void 0 : _a.isAxiosError);
+}
+function getTodoistRequestError(error, originalStack) {
+    var requestError = new errors_1.TodoistRequestError(error.message);
+    requestError.stack = isAxiosError(error) && originalStack ? originalStack.stack : error.stack;
+    if (isAxiosError(error) && error.response) {
+        requestError.httpStatusCode = error.response.status;
+        requestError.responseData = error.response.data;
+    }
+    return requestError;
+}
+function getRequestConfiguration(apiToken, requestId) {
+    var authHeader = apiToken ? { Authorization: getAuthHeader(apiToken) } : undefined;
+    var requestIdHeader = requestId ? { 'X-Request-Id': requestId } : undefined;
+    var headers = __assign(__assign(__assign({}, defaultHeaders), authHeader), requestIdHeader);
+    return { headers: headers };
+}
+function getAxiosClient(apiToken, requestId) {
+    var configuration = getRequestConfiguration(apiToken, requestId);
+    var client = (0, axios_case_converter_1.default)(axios_1.default.create(configuration));
+    (0, axios_retry_1.default)(client, {
+        retries: 3,
+        retryCondition: isNetworkError,
+        retryDelay: getRetryDelay,
+    });
+    return client;
+}
+function isSuccess(response) {
+    return response.status >= 200 && response.status < 300;
+}
+exports.isSuccess = isSuccess;
+function request(httpMethod, baseUri, relativePath, apiToken, payload, requestId) {
+    return __awaiter(this, void 0, void 0, function () {
+        var originalStack, axiosClient, _a, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    originalStack = new Error();
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 9, , 10]);
+                    if (httpMethod === 'POST' && !requestId) {
+                        requestId = (0, uuid_1.v4)();
+                    }
+                    axiosClient = getAxiosClient(apiToken, requestId);
+                    _a = httpMethod;
+                    switch (_a) {
+                        case 'GET': return [3 /*break*/, 2];
+                        case 'POST': return [3 /*break*/, 4];
+                        case 'DELETE': return [3 /*break*/, 6];
+                    }
+                    return [3 /*break*/, 8];
+                case 2: return [4 /*yield*/, axiosClient.get((0, url_join_1.default)(baseUri, relativePath), { params: payload })];
+                case 3: return [2 /*return*/, _b.sent()];
+                case 4: return [4 /*yield*/, axiosClient.post((0, url_join_1.default)(baseUri, relativePath), payload)];
+                case 5: return [2 /*return*/, _b.sent()];
+                case 6: return [4 /*yield*/, axiosClient.delete((0, url_join_1.default)(baseUri, relativePath))];
+                case 7: return [2 /*return*/, _b.sent()];
+                case 8: return [3 /*break*/, 10];
+                case 9:
+                    error_1 = _b.sent();
+                    if (!isAxiosError(error_1) && !(error_1 instanceof Error)) {
+                        throw new Error('An unknown error occurred during the request');
+                    }
+                    throw getTodoistRequestError(error_1, originalStack);
+                case 10: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.request = request;

package/dist/testUtils/asserts.d.ts

@@ -0,0 +1,2 @@
+export declare function assertInstance<T extends new (...args: any) => any>(value: unknown, type: T): asserts value is InstanceType<T>;
+export declare function assertInputValidationError(apiCall: () => Promise<unknown>): Promise<void>;

package/dist/testUtils/asserts.js

@@ -0,0 +1,76 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertInputValidationError = exports.assertInstance = void 0;
+var mocks_1 = require("./mocks");
+var runtypes_1 = require("runtypes");
+// Has to use 'any' to express constructor type
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function assertInstance(value, type) {
+    if (value instanceof type) {
+        return;
+    }
+    throw new TypeError("Unexpected type " + typeof value);
+}
+exports.assertInstance = assertInstance;
+function assertInputValidationError(apiCall) {
+    return __awaiter(this, void 0, void 0, function () {
+        var requestMock, e_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    requestMock = (0, mocks_1.setupRestClientMock)(undefined);
+                    expect.assertions(1);
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, apiCall()];
+                case 2:
+                    _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    e_1 = _a.sent();
+                    assertInstance(e_1, runtypes_1.ValidationError);
+                    expect(requestMock).not.toBeCalled();
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.assertInputValidationError = assertInputValidationError;

package/dist/testUtils/mocks.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="jest" />
+export declare function setupRestClientMock(responseData: unknown, status?: number): jest.SpyInstance;

package/dist/testUtils/mocks.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupRestClientMock = void 0;
+var jest_mock_extended_1 = require("jest-mock-extended");
+var restClient = __importStar(require("../restClient"));
+function setupRestClientMock(responseData, status) {
+    if (status === void 0) { status = 200; }
+    var response = (0, jest_mock_extended_1.mock)({ status: status, data: responseData });
+    return jest.spyOn(restClient, 'request').mockResolvedValue(response);
+}
+exports.setupRestClientMock = setupRestClientMock;

package/dist/testUtils/testDefaults.d.ts

@@ -0,0 +1,110 @@
+import { Label, Project, QuickAddTaskResponse, Section, Task, User, Comment, Attachment } from '../types';
+export declare const DEFAULT_AUTH_TOKEN = "AToken";
+export declare const DEFAULT_REQUEST_ID = "ARequestID";
+export declare const INVALID_ENTITY_ID: number;
+export declare const DEFAULT_DUE_DATE: {
+    recurring: boolean;
+    string: string;
+    date: string;
+};
+export declare const INVALID_DUE_DATE: {
+    recurring: string;
+    string: string;
+    date: string;
+};
+export declare const DEFAULT_QUICK_ADD_RESPONSE: QuickAddTaskResponse;
+export declare const DEFAULT_TASK: Task;
+export declare const INVALID_TASK: {
+    due: {
+        recurring: string;
+        string: string;
+        date: string;
+    };
+    id: number;
+    order: number;
+    content: string;
+    description: string;
+    projectId: number;
+    sectionId: number;
+    completed: boolean;
+    labelIds: number[];
+    priority: number;
+    commentCount: number;
+    created: string;
+    url: string;
+    parentId?: number | undefined;
+    assignee?: number | undefined;
+};
+export declare const DEFAULT_PROJECT: Project;
+export declare const INVALID_PROJECT: {
+    name: number;
+    id: number;
+    commentCount: number;
+    url: string;
+    color: number;
+    shared: boolean;
+    favorite: boolean;
+    parentId?: number | undefined;
+    order?: number | undefined;
+    inboxProject?: boolean | undefined;
+    teamInbox?: boolean | undefined;
+    syncId?: number | undefined;
+};
+export declare const DEFAULT_SECTION: Section;
+export declare const INVALID_SECTION: {
+    projectId: undefined;
+    id: number;
+    order: number;
+    name: string;
+};
+export declare const DEFAULT_LABEL: Label;
+export declare const INVALID_LABEL: {
+    favorite: string;
+    id: number;
+    order: number;
+    name: string;
+    color: number;
+};
+export declare const DEFAULT_USER: User;
+export declare const INVALID_USER: {
+    email: undefined;
+    id: number;
+    name: string;
+};
+export declare const DEFAULT_ATTACHMENT: Attachment;
+export declare const INVALID_ATTACHMENT: {
+    uploadState: string;
+    resourceType: string;
+    fileName?: string | undefined;
+    fileSize?: number | undefined;
+    fileType?: string | undefined;
+    fileUrl?: string | undefined;
+    fileDuration?: number | undefined;
+    image?: string | undefined;
+    imageWidth?: number | undefined;
+    imageHeight?: number | undefined;
+    url?: string | undefined;
+    title?: string | undefined;
+};
+export declare const DEFAULT_COMMENT: Comment;
+export declare const INVALID_COMMENT: {
+    attachment: {
+        uploadState: string;
+        resourceType: string;
+        fileName?: string | undefined;
+        fileSize?: number | undefined;
+        fileType?: string | undefined;
+        fileUrl?: string | undefined;
+        fileDuration?: number | undefined;
+        image?: string | undefined;
+        imageWidth?: number | undefined;
+        imageHeight?: number | undefined;
+        url?: string | undefined;
+        title?: string | undefined;
+    };
+    id: number;
+    content: string;
+    posted: string;
+    taskId?: number | undefined;
+    projectId?: number | undefined;
+};

package/dist/testUtils/testDefaults.js

@@ -0,0 +1,132 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INVALID_COMMENT = exports.DEFAULT_COMMENT = exports.INVALID_ATTACHMENT = exports.DEFAULT_ATTACHMENT = exports.INVALID_USER = exports.DEFAULT_USER = exports.INVALID_LABEL = exports.DEFAULT_LABEL = exports.INVALID_SECTION = exports.DEFAULT_SECTION = exports.INVALID_PROJECT = exports.DEFAULT_PROJECT = exports.INVALID_TASK = exports.DEFAULT_TASK = exports.DEFAULT_QUICK_ADD_RESPONSE = exports.INVALID_DUE_DATE = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = void 0;
+var DEFAULT_TASK_ID = 1234;
+var DEFAULT_TASK_CONTENT = 'This is a task';
+var DEFAULT_TASK_DESCRIPTION = 'A description';
+var DEFAULT_TASK_PRIORITY = 1;
+var DEFAULT_ORDER = 3;
+var DEFAULT_PROJECT_ID = 123;
+var DEFAULT_PROJECT_NAME = 'This is a project';
+var DEFAULT_LABEL_ID = 456;
+var DEFAULT_LABEL_NAME = 'This is a label';
+var DEFAULT_SECTION_ID = 456;
+var DEFAULT_SECTION_NAME = 'This is a section';
+var DEFAULT_PARENT_ID = 5678;
+var DEFAULT_ASSIGNEE = 1234;
+var DEFAULT_DATE = '2020-09-08T12:00:00Z';
+var DEFAULT_ENTITY_COLOR = 30;
+var DEFAULT_LABELS = [1, 2, 3];
+var DEFAULT_USER_ID = 5;
+var DEFAULT_USER_NAME = 'A User';
+var DEFAULT_USER_EMAIL = 'atestuser@doist.com';
+var DEFAULT_COMMENT_ID = 4;
+var DEFAULT_COMMENT_CONTENT = 'A comment';
+exports.DEFAULT_AUTH_TOKEN = 'AToken';
+exports.DEFAULT_REQUEST_ID = 'ARequestID';
+exports.INVALID_ENTITY_ID = 'invalid/entity/id';
+exports.DEFAULT_DUE_DATE = {
+    recurring: false,
+    string: 'a date string',
+    date: DEFAULT_DATE,
+};
+exports.INVALID_DUE_DATE = __assign(__assign({}, exports.DEFAULT_DUE_DATE), { recurring: 'false' });
+exports.DEFAULT_QUICK_ADD_RESPONSE = {
+    id: DEFAULT_TASK_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    content: DEFAULT_TASK_CONTENT,
+    description: DEFAULT_TASK_DESCRIPTION,
+    priority: DEFAULT_TASK_PRIORITY,
+    sectionId: DEFAULT_SECTION_ID,
+    parentId: DEFAULT_PARENT_ID,
+    childOrder: DEFAULT_ORDER,
+    labels: DEFAULT_LABELS,
+    responsibleUid: DEFAULT_ASSIGNEE,
+    checked: 0,
+    dateAdded: DEFAULT_DATE,
+    syncId: null,
+    due: {
+        date: DEFAULT_DATE,
+        timezone: null,
+        string: 'a date string',
+        lang: 'en',
+        isRecurring: false,
+    },
+};
+exports.DEFAULT_TASK = {
+    id: DEFAULT_TASK_ID,
+    order: DEFAULT_ORDER,
+    parentId: DEFAULT_PARENT_ID,
+    content: DEFAULT_TASK_CONTENT,
+    description: DEFAULT_TASK_DESCRIPTION,
+    projectId: DEFAULT_PROJECT_ID,
+    sectionId: DEFAULT_SECTION_ID,
+    completed: false,
+    labelIds: DEFAULT_LABELS,
+    priority: DEFAULT_TASK_PRIORITY,
+    commentCount: 0,
+    created: DEFAULT_DATE,
+    url: 'https://todoist.com/showTask?id=1234',
+    due: exports.DEFAULT_DUE_DATE,
+    assignee: DEFAULT_ASSIGNEE,
+};
+exports.INVALID_TASK = __assign(__assign({}, exports.DEFAULT_TASK), { due: exports.INVALID_DUE_DATE });
+exports.DEFAULT_PROJECT = {
+    id: DEFAULT_PROJECT_ID,
+    name: DEFAULT_PROJECT_NAME,
+    color: DEFAULT_ENTITY_COLOR,
+    order: DEFAULT_ORDER,
+    parentId: DEFAULT_PROJECT_ID,
+    commentCount: 0,
+    favorite: false,
+    shared: false,
+    url: "https://todoist.com/showProject?id=123",
+};
+exports.INVALID_PROJECT = __assign(__assign({}, exports.DEFAULT_PROJECT), { name: 123 });
+exports.DEFAULT_SECTION = {
+    id: DEFAULT_SECTION_ID,
+    name: DEFAULT_SECTION_NAME,
+    order: DEFAULT_ORDER,
+    projectId: DEFAULT_PROJECT_ID,
+};
+exports.INVALID_SECTION = __assign(__assign({}, exports.DEFAULT_SECTION), { projectId: undefined });
+exports.DEFAULT_LABEL = {
+    id: DEFAULT_LABEL_ID,
+    name: DEFAULT_LABEL_NAME,
+    color: DEFAULT_ENTITY_COLOR,
+    order: DEFAULT_ORDER,
+    favorite: false,
+};
+exports.INVALID_LABEL = __assign(__assign({}, exports.DEFAULT_LABEL), { favorite: 'true' });
+exports.DEFAULT_USER = {
+    id: DEFAULT_USER_ID,
+    name: DEFAULT_USER_NAME,
+    email: DEFAULT_USER_EMAIL,
+};
+exports.INVALID_USER = __assign(__assign({}, exports.DEFAULT_USER), { email: undefined });
+exports.DEFAULT_ATTACHMENT = {
+    resourceType: 'file',
+    fileType: 'image/png',
+    fileUrl: 'https://someurl.com/image.jpg',
+    uploadState: 'completed',
+};
+exports.INVALID_ATTACHMENT = __assign(__assign({}, exports.DEFAULT_ATTACHMENT), { uploadState: 'something random' });
+exports.DEFAULT_COMMENT = {
+    id: DEFAULT_COMMENT_ID,
+    content: DEFAULT_COMMENT_CONTENT,
+    projectId: DEFAULT_PROJECT_ID,
+    attachment: exports.DEFAULT_ATTACHMENT,
+    posted: DEFAULT_DATE,
+};
+exports.INVALID_COMMENT = __assign(__assign({}, exports.DEFAULT_COMMENT), { attachment: exports.INVALID_ATTACHMENT });