@kendew-agency/clickup-sdk 0.1.1

package/dist/methods/attachments/attachments.js

@@ -0,0 +1,27 @@
+import { Base } from "../base";
+export class Attachments extends Base {
+    /**
+     * Create a new task attachment
+     *
+     * @param params paramaters for creating a task attachment
+     * @returns the file stored in ClickUp or an error
+     * @see https://developer.clickup.com/reference/createtaskattachment
+     */
+    async createTaskAttachement(params) {
+        // Clicup expects a multipart/form-data request
+        // Create new formdata
+        const formData = new FormData();
+        // Sanitize file name by replacing spaces with dashes
+        const sanitizedFileName = params.attachment.name.replace(/\s+/g, "-");
+        // Append the attachment to the form data
+        formData.append(`attachment`, params.attachment, sanitizedFileName);
+        return this.request(`/task/${params.task_id}/attachment`, {
+            method: "POST",
+            query: {
+                custom_task_ids: params.custom_task_ids,
+                team_id: params.team_id,
+            },
+        });
+    }
+}
+//# sourceMappingURL=attachments.js.map

package/dist/methods/attachments/attachments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachments.js","sourceRoot":"","sources":["../../../src/methods/attachments/attachments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAM/B,MAAM,OAAO,WAAY,SAAQ,IAAI;IACnC;;;;;;OAMG;IACI,KAAK,CAAC,qBAAqB,CAAC,MAAkC;QACnE,+CAA+C;QAE/C,sBAAsB;QACtB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,qDAAqD;QACrD,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtE,yCAAyC;QACzC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAEpE,OAAO,IAAI,CAAC,OAAO,CACjB,SAAS,MAAM,CAAC,OAAO,aAAa,EACpC;YACE,MAAM,EAAE,MAAM;YACd,KAAK,EAAE;gBACL,eAAe,EAAE,MAAM,CAAC,eAAe;gBACvC,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB;SACF,CACF,CAAC;IACJ,CAAC;CACF"}

package/dist/methods/attachments/types.d.ts

@@ -0,0 +1,28 @@
+export type CreateTaskAttachemntParams = CreateTaskAttachemntParamsBase & CreateTaskAttachemntParamsConditional;
+type CreateTaskAttachemntParamsBase = {
+    task_id: string;
+    /**
+     * The attachment to upload.
+     * @description this differs from the documentation. Yet attachment `array` is not the correct type.
+     */
+    attachment: File;
+};
+type CreateTaskAttachemntParamsConditional = {
+    custom_task_ids: true;
+    team_id: number;
+} | {
+    custom_task_ids?: false;
+    team_id?: number;
+};
+export type CreateTaskAttachemntResponse = {
+    id: string;
+    version: string;
+    date: number;
+    title: string;
+    extension: string;
+    thumbnail_small: string;
+    thumbnail_large: string;
+    url: string;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/methods/attachments/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/methods/attachments/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,0BAA0B,GAAG,8BAA8B,GACrE,qCAAqC,CAAC;AAExC,KAAK,8BAA8B,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAEF,KAAK,qCAAqC,GACtC;IACE,eAAe,EAAE,IAAI,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,eAAe,CAAC,EAAE,KAAK,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEN,MAAM,MAAM,4BAA4B,GAAG;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}

package/dist/methods/attachments/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/methods/attachments/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/methods/attachments/types.ts"],"names":[],"mappings":""}

package/dist/methods/authorization/authorization.d.ts

@@ -0,0 +1,18 @@
+import { Base } from "../base";
+import type { AccessTokenResponse, GetAccessTokenParams, GetAuthorizedUserResponse } from "./types";
+export declare class Authorization extends Base {
+    /**
+     *
+     * @param params the parameters to get an access token
+     * @returns data or an error
+     * @see https://developer.clickup.com/reference/getaccesstoken
+     */
+    getAccessToken(params: GetAccessTokenParams): Promise<import("../../interfaces").Response<AccessTokenResponse>>;
+    /**
+     * Get the authorized user connected to the current token
+     * @returns data or an error
+     * @see https://developer.clickup.com/reference/getauthorizeduser
+     */
+    getAuthorizedUser(): Promise<import("../../interfaces").Response<GetAuthorizedUserResponse>>;
+}
+//# sourceMappingURL=authorization.d.ts.map

package/dist/methods/authorization/authorization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.d.ts","sourceRoot":"","sources":["../../../src/methods/authorization/authorization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AAEjB,qBAAa,aAAc,SAAQ,IAAI;IACrC;;;;;OAKG;IACU,cAAc,CAAC,MAAM,EAAE,oBAAoB;IASxD;;;;OAIG;IACU,iBAAiB;CAK/B"}

package/dist/methods/authorization/authorization.js

@@ -0,0 +1,28 @@
+import { Base } from "../base";
+export class Authorization extends Base {
+    /**
+     *
+     * @param params the parameters to get an access token
+     * @returns data or an error
+     * @see https://developer.clickup.com/reference/getaccesstoken
+     */
+    async getAccessToken(params) {
+        return this.request("/oauth/token", {
+            method: "POST",
+            body: {
+                params,
+            },
+        });
+    }
+    /**
+     * Get the authorized user connected to the current token
+     * @returns data or an error
+     * @see https://developer.clickup.com/reference/getauthorizeduser
+     */
+    async getAuthorizedUser() {
+        return this.request("/user", {
+            method: "GET",
+        });
+    }
+}
+//# sourceMappingURL=authorization.js.map

package/dist/methods/authorization/authorization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.js","sourceRoot":"","sources":["../../../src/methods/authorization/authorization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAO/B,MAAM,OAAO,aAAc,SAAQ,IAAI;IACrC;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,MAA4B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAsB,cAAc,EAAE;YACvD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iBAAiB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAA4B,OAAO,EAAE;YACtD,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/methods/authorization/types.d.ts

@@ -0,0 +1,13 @@
+import type { User } from "../../types/clickup.types";
+export type GetAccessTokenParams = {
+    client_id: string;
+    client_secret: string;
+    code: string;
+};
+export type AccessTokenResponse = {
+    access_token: string;
+};
+export type GetAuthorizedUserResponse = {
+    user: User;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/methods/authorization/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/methods/authorization/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AAEtD,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC"}

package/dist/methods/authorization/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/methods/authorization/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/methods/authorization/types.ts"],"names":[],"mappings":""}

package/dist/methods/base.d.ts

@@ -0,0 +1,161 @@
+import type { ClickUpConfig } from "../types/config.types";
+import type { Response } from "../interfaces";
+type RequestOptions = {
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    body?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    headers?: Record<string, string>;
+};
+export declare abstract class Base {
+    protected config: ClickUpConfig;
+    constructor(config: ClickUpConfig);
+    /**
+     * Constructs a full URL for the ClickUp API by combining the base URL,
+     * endpoint path, and optional query parameters.
+     *
+     * @param endpoint - The API endpoint path (with or without leading slash)
+     * @param query - Optional query parameters to append to the URL
+     * @returns The complete URL string
+     */
+    private buildUrl;
+    /**
+     * Builds request headers by merging authorization, content-type, config headers,
+     * and request-specific headers with proper priority.
+     *
+     * @param hasBody - Whether the request includes a body (for Content-Type header)
+     * @param requestHeaders - Optional request-specific headers to merge
+     * @returns Record of header key-value pairs with all values as strings
+     */
+    private buildHeaders;
+    /**
+     * Prepares the request body for HTTP methods that support it.
+     * Serializes the body to JSON for POST, PUT, and PATCH requests.
+     * Returns undefined for GET and DELETE requests, ignoring any provided body.
+     *
+     * @param method - The HTTP method for the request
+     * @param body - Optional body data to serialize
+     * @returns JSON string for methods that accept body, undefined otherwise
+     */
+    private prepareRequestBody;
+    /**
+     * Extracts error message from HTTP response.
+     * @private
+     */
+    private extractErrorMessage;
+    /**
+     * Handles HTTP error responses (non-2xx status codes).
+     * @private
+     */
+    private handleHttpError;
+    /**
+     * Parses successful HTTP response body.
+     * @private
+     */
+    private parseSuccessResponse;
+    /**
+     * Makes an authenticated HTTP request to the ClickUp API.
+     *
+     * This protected method provides a reusable interface for all API method
+     * implementations, handling authentication, URL construction, header
+     * management, and error handling automatically.
+     *
+     * **Features:**
+     * - Automatic authentication with Bearer token from config
+     * - Base URL prepending (https://api.clickup.com/api/v2)
+     * - URL normalization (handles endpoints with or without leading slash)
+     * - Query parameter encoding for GET requests
+     * - Request body serialization for POST/PUT/PATCH (ignored for GET/DELETE)
+     * - Header merging with proper priority (auth > config > request-specific)
+     * - Content-Type header automatically added when body is present
+     * - Consistent error handling with structured error responses
+     * - JSON response parsing with empty body handling
+     *
+     * @template T - The expected response data type
+     *
+     * @param endpoint - The API endpoint path (e.g., "/task" or "task").
+     *                   Leading slash is optional and will be normalized.
+     *
+     * @param options - Optional request configuration
+     * @param options.method - HTTP method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"
+     *                         (default: "GET")
+     * @param options.body - Request body object for POST/PUT/PATCH requests.
+     *                       Automatically serialized to JSON. Ignored for GET/DELETE.
+     * @param options.query - Query parameters to append to URL. Values are
+     *                        automatically encoded. Null/undefined values are omitted.
+     * @param options.headers - Additional headers to merge with default headers.
+     *                          Cannot override Authorization header.
+     *
+     * @returns Promise resolving to Response<T> union type:
+     *          - Success: `{ data: T, error: null }`
+     *          - Error: `{ data: null, error: ErrorResponse }`
+     *
+     * **Error Cases:**
+     *
+     * The method returns structured errors (never throws) for:
+     *
+     * 1. **Missing API Token** (unauthorized)
+     *    - Returned when config.apiToken is not set
+     *    - statusCode: null
+     *    - message: "API token is required"
+     *
+     * 2. **401 Unauthorized** (unauthorized)
+     *    - Returned when API rejects authentication
+     *    - statusCode: 401
+     *    - message: Extracted from API response or "Unauthorized"
+     *
+     * 3. **HTTP Errors** (unknow_error)
+     *    - Returned for any non-2xx status code (except 401)
+     *    - statusCode: HTTP status code from response
+     *    - message: Extracted from API response or status text
+     *
+     * 4. **Network Errors** (unknow_error)
+     *    - Returned when fetch fails (connection, timeout, DNS, etc.)
+     *    - statusCode: null
+     *    - message: Error message from exception
+     *
+     * 5. **Invalid JSON** (unknow_error)
+     *    - Returned when response body is not valid JSON
+     *    - statusCode: null
+     *    - message: "Invalid JSON response"
+     *
+     * @example
+     * ```typescript
+     * // GET request with query parameters
+     * const result = await this.request<Task[]>("/task", {
+     *   query: { archived: false, page: 1 }
+     * });
+     * if (result.error) {
+     *   console.error(result.error.message);
+     * } else {
+     *   console.log(result.data); // Task[]
+     * }
+     *
+     * // POST request with body
+     * const result = await this.request<Task>("/task", {
+     *   method: "POST",
+     *   body: { name: "New Task", description: "Task details" }
+     * });
+     *
+     * // PUT request with custom headers
+     * const result = await this.request<Task>("/task/123", {
+     *   method: "PUT",
+     *   body: { status: "completed" },
+     *   headers: { "X-Request-ID": "abc123" }
+     * });
+     *
+     * // DELETE request
+     * const result = await this.request<void>("/task/123", {
+     *   method: "DELETE"
+     * });
+     *
+     * // PATCH request for partial update
+     * const result = await this.request<Task>("/task/123", {
+     *   method: "PATCH",
+     *   body: { priority: 3 }
+     * });
+     * ```
+     */
+    protected request<T>(endpoint: string, options?: RequestOptions): Promise<Response<T>>;
+}
+export {};
+//# sourceMappingURL=base.d.ts.map

package/dist/methods/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/methods/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,KAAK,cAAc,GAAG;IACpB,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,8BAAsB,IAAI;IACxB,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;gBAEpB,MAAM,EAAE,aAAa;IAIjC;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ;IAsBhB;;;;;;;OAOG;IACH,OAAO,CAAC,YAAY;IAqCpB;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;;OAGG;YACW,mBAAmB;IAuBjC;;;OAGG;YACW,eAAe;IAgC7B;;;OAGG;YACW,oBAAoB;IA6BlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsGG;cACa,OAAO,CAAC,CAAC,EACvB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CAuDxB"}

package/dist/methods/base.js

@@ -0,0 +1,314 @@
+export class Base {
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Constructs a full URL for the ClickUp API by combining the base URL,
+     * endpoint path, and optional query parameters.
+     *
+     * @param endpoint - The API endpoint path (with or without leading slash)
+     * @param query - Optional query parameters to append to the URL
+     * @returns The complete URL string
+     */
+    buildUrl(endpoint, query) {
+        const baseUrl = "https://api.clickup.com/api/v2";
+        const normalizedEndpoint = endpoint.startsWith("/")
+            ? endpoint
+            : `/${endpoint}`;
+        const url = `${baseUrl}${normalizedEndpoint}`;
+        if (!query || Object.keys(query).length === 0) {
+            return url;
+        }
+        const searchParams = new URLSearchParams();
+        for (const [key, value] of Object.entries(query)) {
+            if (value !== undefined && value !== null) {
+                searchParams.append(key, String(value));
+            }
+        }
+        const queryString = searchParams.toString();
+        return queryString ? `${url}?${queryString}` : url;
+    }
+    /**
+     * Builds request headers by merging authorization, content-type, config headers,
+     * and request-specific headers with proper priority.
+     *
+     * @param hasBody - Whether the request includes a body (for Content-Type header)
+     * @param requestHeaders - Optional request-specific headers to merge
+     * @returns Record of header key-value pairs with all values as strings
+     */
+    buildHeaders(hasBody, requestHeaders) {
+        const headers = {};
+        // 1. Start with Authorization header using Bearer token
+        headers.Authorization = `Bearer ${this.config.apiToken}`;
+        // 2. Add Content-Type when body is present
+        if (hasBody) {
+            headers["Content-Type"] = "application/json";
+        }
+        // 3. Merge config.headers if provided
+        if (this.config.headers) {
+            for (const [key, value] of Object.entries(this.config.headers)) {
+                // Don't override Authorization header from config
+                if (key !== "Authorization" && value !== undefined && value !== null) {
+                    headers[key] = String(value);
+                }
+            }
+        }
+        // 4. Merge request-specific headers from options
+        if (requestHeaders) {
+            for (const [key, value] of Object.entries(requestHeaders)) {
+                // Don't override Authorization header from request options
+                if (key !== "Authorization" && value !== undefined && value !== null) {
+                    headers[key] = String(value);
+                }
+            }
+        }
+        return headers;
+    }
+    /**
+     * Prepares the request body for HTTP methods that support it.
+     * Serializes the body to JSON for POST, PUT, and PATCH requests.
+     * Returns undefined for GET and DELETE requests, ignoring any provided body.
+     *
+     * @param method - The HTTP method for the request
+     * @param body - Optional body data to serialize
+     * @returns JSON string for methods that accept body, undefined otherwise
+     */
+    prepareRequestBody(method, body) {
+        // GET and DELETE requests should not have a body
+        if (method === "GET" || method === "DELETE") {
+            return undefined;
+        }
+        // POST, PUT, and PATCH requests serialize body to JSON
+        if (body && (method === "POST" || method === "PUT" || method === "PATCH")) {
+            return JSON.stringify(body);
+        }
+        return undefined;
+    }
+    /**
+     * Extracts error message from HTTP response.
+     * @private
+     */
+    async extractErrorMessage(response, defaultMessage) {
+        try {
+            const errorData = await response.json();
+            if (typeof errorData === "object" &&
+                errorData !== null &&
+                ("message" in errorData || "err" in errorData)) {
+                return (errorData.message ||
+                    errorData.err ||
+                    defaultMessage);
+            }
+            return defaultMessage;
+        }
+        catch {
+            return defaultMessage;
+        }
+    }
+    /**
+     * Handles HTTP error responses (non-2xx status codes).
+     * @private
+     */
+    async handleHttpError(response) {
+        if (response.status === 401) {
+            const errorMessage = await this.extractErrorMessage(response, "Unauthorized");
+            return {
+                error: {
+                    message: errorMessage,
+                    statusCode: 401,
+                    name: "unauthorized",
+                },
+                data: null,
+            };
+        }
+        const errorMessage = await this.extractErrorMessage(response, response.statusText || "Request failed");
+        return {
+            error: {
+                message: errorMessage,
+                statusCode: response.status,
+                name: "unknow_error",
+            },
+            data: null,
+        };
+    }
+    /**
+     * Parses successful HTTP response body.
+     * @private
+     */
+    async parseSuccessResponse(response) {
+        try {
+            const text = await response.text();
+            if (!text || text.trim() === "") {
+                return {
+                    data: {},
+                    error: null,
+                };
+            }
+            const data = JSON.parse(text);
+            return {
+                data,
+                error: null,
+            };
+        }
+        catch {
+            return {
+                error: {
+                    message: "Invalid JSON response",
+                    statusCode: null,
+                    name: "unknow_error",
+                },
+                data: null,
+            };
+        }
+    }
+    /**
+     * Makes an authenticated HTTP request to the ClickUp API.
+     *
+     * This protected method provides a reusable interface for all API method
+     * implementations, handling authentication, URL construction, header
+     * management, and error handling automatically.
+     *
+     * **Features:**
+     * - Automatic authentication with Bearer token from config
+     * - Base URL prepending (https://api.clickup.com/api/v2)
+     * - URL normalization (handles endpoints with or without leading slash)
+     * - Query parameter encoding for GET requests
+     * - Request body serialization for POST/PUT/PATCH (ignored for GET/DELETE)
+     * - Header merging with proper priority (auth > config > request-specific)
+     * - Content-Type header automatically added when body is present
+     * - Consistent error handling with structured error responses
+     * - JSON response parsing with empty body handling
+     *
+     * @template T - The expected response data type
+     *
+     * @param endpoint - The API endpoint path (e.g., "/task" or "task").
+     *                   Leading slash is optional and will be normalized.
+     *
+     * @param options - Optional request configuration
+     * @param options.method - HTTP method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"
+     *                         (default: "GET")
+     * @param options.body - Request body object for POST/PUT/PATCH requests.
+     *                       Automatically serialized to JSON. Ignored for GET/DELETE.
+     * @param options.query - Query parameters to append to URL. Values are
+     *                        automatically encoded. Null/undefined values are omitted.
+     * @param options.headers - Additional headers to merge with default headers.
+     *                          Cannot override Authorization header.
+     *
+     * @returns Promise resolving to Response<T> union type:
+     *          - Success: `{ data: T, error: null }`
+     *          - Error: `{ data: null, error: ErrorResponse }`
+     *
+     * **Error Cases:**
+     *
+     * The method returns structured errors (never throws) for:
+     *
+     * 1. **Missing API Token** (unauthorized)
+     *    - Returned when config.apiToken is not set
+     *    - statusCode: null
+     *    - message: "API token is required"
+     *
+     * 2. **401 Unauthorized** (unauthorized)
+     *    - Returned when API rejects authentication
+     *    - statusCode: 401
+     *    - message: Extracted from API response or "Unauthorized"
+     *
+     * 3. **HTTP Errors** (unknow_error)
+     *    - Returned for any non-2xx status code (except 401)
+     *    - statusCode: HTTP status code from response
+     *    - message: Extracted from API response or status text
+     *
+     * 4. **Network Errors** (unknow_error)
+     *    - Returned when fetch fails (connection, timeout, DNS, etc.)
+     *    - statusCode: null
+     *    - message: Error message from exception
+     *
+     * 5. **Invalid JSON** (unknow_error)
+     *    - Returned when response body is not valid JSON
+     *    - statusCode: null
+     *    - message: "Invalid JSON response"
+     *
+     * @example
+     * ```typescript
+     * // GET request with query parameters
+     * const result = await this.request<Task[]>("/task", {
+     *   query: { archived: false, page: 1 }
+     * });
+     * if (result.error) {
+     *   console.error(result.error.message);
+     * } else {
+     *   console.log(result.data); // Task[]
+     * }
+     *
+     * // POST request with body
+     * const result = await this.request<Task>("/task", {
+     *   method: "POST",
+     *   body: { name: "New Task", description: "Task details" }
+     * });
+     *
+     * // PUT request with custom headers
+     * const result = await this.request<Task>("/task/123", {
+     *   method: "PUT",
+     *   body: { status: "completed" },
+     *   headers: { "X-Request-ID": "abc123" }
+     * });
+     *
+     * // DELETE request
+     * const result = await this.request<void>("/task/123", {
+     *   method: "DELETE"
+     * });
+     *
+     * // PATCH request for partial update
+     * const result = await this.request<Task>("/task/123", {
+     *   method: "PATCH",
+     *   body: { priority: 3 }
+     * });
+     * ```
+     */
+    async request(endpoint, options) {
+        // 1. Validate API token is present
+        if (!this.config.apiToken) {
+            return {
+                error: {
+                    message: "API token is required",
+                    statusCode: null,
+                    name: "unauthorized",
+                },
+                data: null,
+            };
+        }
+        // 2. Extract options with defaults
+        const method = options?.method || "GET";
+        const { body, query, headers: requestHeaders } = options || {};
+        // 3. Build full URL with query parameters
+        const url = this.buildUrl(endpoint, query);
+        // 4. Prepare request body if applicable
+        const requestBody = this.prepareRequestBody(method, body);
+        // 5. Build headers with authentication
+        const headers = this.buildHeaders(!!requestBody, requestHeaders);
+        try {
+            // 6. Execute fetch with constructed parameters
+            const response = await fetch(url, {
+                method,
+                headers,
+                body: requestBody,
+            });
+            // 7. Handle HTTP errors or parse success response
+            if (!response.ok) {
+                return this.handleHttpError(response);
+            }
+            return this.parseSuccessResponse(response);
+        }
+        catch (error) {
+            // Network errors or other exceptions
+            const errorMessage = error instanceof Error ? error.message : "Network request failed";
+            return {
+                error: {
+                    message: errorMessage,
+                    statusCode: null,
+                    name: "unknow_error",
+                },
+                data: null,
+            };
+        }
+    }
+}
+//# sourceMappingURL=base.js.map

package/dist/methods/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/methods/base.ts"],"names":[],"mappings":"AAUA,MAAM,OAAgB,IAAI;IAGxB,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACK,QAAQ,CAAC,QAAgB,EAAE,KAA+B;QAChE,MAAM,OAAO,GAAG,gCAAgC,CAAC;QACjD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;YACjD,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,GAAG,OAAO,GAAG,kBAAkB,EAAE,CAAC;QAE9C,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC5C,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACK,YAAY,CAClB,OAAgB,EAChB,cAAuC;QAEvC,MAAM,OAAO,GAA2B,EAAE,CAAC;QAE3C,wDAAwD;QACxD,OAAO,CAAC,aAAa,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAEzD,2CAA2C;QAC3C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QAED,sCAAsC;QACtC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACxB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/D,kDAAkD;gBAClD,IAAI,GAAG,KAAK,eAAe,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACrE,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QAED,iDAAiD;QACjD,IAAI,cAAc,EAAE,CAAC;YACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC1D,2DAA2D;gBAC3D,IAAI,GAAG,KAAK,eAAe,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACrE,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;OAQG;IACK,kBAAkB,CACxB,MAAc,EACd,IAA8B;QAE9B,iDAAiD;QACjD,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,uDAAuD;QACvD,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,OAAO,CAAC,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,mBAAmB,CAC/B,QAA6B,EAC7B,cAAsB;QAEtB,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACxC,IACE,OAAO,SAAS,KAAK,QAAQ;gBAC7B,SAAS,KAAK,IAAI;gBAClB,CAAC,SAAS,IAAI,SAAS,IAAI,KAAK,IAAI,SAAS,CAAC,EAC9C,CAAC;gBACD,OAAO,CACJ,SAAkC,CAAC,OAAO;oBAC1C,SAA8B,CAAC,GAAG;oBACnC,cAAc,CACf,CAAC;YACJ,CAAC;YACD,OAAO,cAAc,CAAC;QACxB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,cAAc,CAAC;QACxB,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,eAAe,CAC3B,QAA6B;QAE7B,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CACjD,QAAQ,EACR,cAAc,CACf,CAAC;YACF,OAAO;gBACL,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;oBACrB,UAAU,EAAE,GAAG;oBACf,IAAI,EAAE,cAAc;iBACrB;gBACD,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CACjD,QAAQ,EACR,QAAQ,CAAC,UAAU,IAAI,gBAAgB,CACxC,CAAC;QACF,OAAO;YACL,KAAK,EAAE;gBACL,OAAO,EAAE,YAAY;gBACrB,UAAU,EAAE,QAAQ,CAAC,MAAM;gBAC3B,IAAI,EAAE,cAAc;aACrB;YACD,IAAI,EAAE,IAAI;SACX,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,oBAAoB,CAChC,QAA6B;QAE7B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAChC,OAAO;oBACL,IAAI,EAAE,EAAO;oBACb,KAAK,EAAE,IAAI;iBACZ,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAC;YACnC,OAAO;gBACL,IAAI;gBACJ,KAAK,EAAE,IAAI;aACZ,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO;gBACL,KAAK,EAAE;oBACL,OAAO,EAAE,uBAAuB;oBAChC,UAAU,EAAE,IAAI;oBAChB,IAAI,EAAE,cAAc;iBACrB;gBACD,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsGG;IACO,KAAK,CAAC,OAAO,CACrB,QAAgB,EAChB,OAAwB;QAExB,mCAAmC;QACnC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC1B,OAAO;gBACL,KAAK,EAAE;oBACL,OAAO,EAAE,uBAAuB;oBAChC,UAAU,EAAE,IAAI;oBAChB,IAAI,EAAE,cAAc;iBACrB;gBACD,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;QAED,mCAAmC;QACnC,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,KAAK,CAAC;QACxC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAE/D,0CAA0C;QAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAE3C,wCAAwC;QACxC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE1D,uCAAuC;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QAEjE,IAAI,CAAC;YACH,+CAA+C;YAC/C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAChC,MAAM;gBACN,OAAO;gBACP,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC;YAEH,kDAAkD;YAClD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,OAAO,IAAI,CAAC,eAAe,CAAI,QAAQ,CAAC,CAAC;YAC3C,CAAC;YAED,OAAO,IAAI,CAAC,oBAAoB,CAAI,QAAQ,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,qCAAqC;YACrC,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB,CAAC;YAEpE,OAAO;gBACL,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;oBACrB,UAAU,EAAE,IAAI;oBAChB,IAAI,EAAE,cAAc;iBACrB;gBACD,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}