@larisarozin/dodone-shared 1.0.0

package/dist/utils/ApiClient.d.ts

@@ -0,0 +1,204 @@
+import { AllowanceHistoryApprovalRequest, AllowanceHistoryClaimRequest, AllowanceHistoryResponse, AllowanceHistoryTaskItemResponse, PagedAllowanceHistoriesListRequest, PagedAllowanceHistoryTaskItemsListRequest } from "../types/AllowanceHistory";
+import { DataResponse, ResponseBase } from "../types/ApiResponse";
+import { DeviceRegistrationRequest } from "../types/DeviceRegistration";
+import { BonusApprovalRequest, TaskItemAllowanceApprovalRequest, TaskCommentCreateRequest, TaskCommentUpdateRequest, TaskItemTaskDetailsUpdateRequest } from "../types/TaskItem";
+import { TeamAllowanceIntervalCreateRequest, TeamAllowanceIntervalListResponse, TeamAllowanceIntervalResponse, TeamAllowanceIntervalUpdateRequest, TeamDetailsResponse, TeamDetailsUpdateRequest } from "../types/Team";
+import { ForgotPasswordRequest, ForgotPasswordResponse, RegisterRequest, ResetPasswordRequest, ResetPasswordResponse, SendPasswordResetEmailRequest, SendPasswordResetEmailResponse, User } from "../types/User";
+import { BulkNotificationPreferenceCreateRequest, BulkNotificationPreferenceUpdateRequest, UserNotificationPreferenceResponse } from "../types/UserNotificationPreferences";
+import { PagedListRequest, PagedListResponse, PagedTaskCommentListRequest, PagedTaskCommentListResponse, PagedTaskItemDetailsListResponse, PagedTaskItemListRequest, PagedTaskItemListResponse } from "./paging";
+export interface ApiClientConfig {
+    baseUrl: string;
+    token: string;
+}
+export declare class ApiClient {
+    private config;
+    constructor(config: ApiClientConfig);
+    /**
+     * Private helper to process ResponseBase for endpoints that don't return data
+     * @param response - The fetch response
+     * @param route - API route for error messaging
+     * @returns Promise with the parsed ResponseBase
+     */
+    private processNoDataResponse;
+    /**
+     * Private helper to process DataResponse for endpoints that return data
+     * @param response - The fetch response
+     * @param route - API route for error messaging
+     * @returns Promise with the unpacked data
+     */
+    private processDataResponse;
+    /**
+     * Makes an authenticated GET request with standardized error handling
+     * Always processes DataResponse wrapper
+     * @param route - API route (will be concatenated with baseUrl)
+     * @param options - Additional fetch options
+     * @returns Promise with the response data
+     */
+    get<T>(route: string, options?: RequestInit, processDataResponse?: boolean): Promise<T>;
+    /**
+     * Makes an authenticated POST request with standardized error handling
+     * Always processes DataResponse wrapper
+     */
+    post<T>(route: string, body?: any, options?: RequestInit, processDataResponse?: boolean): Promise<T>;
+    postMultimedia<T>(route: string, body?: any, options?: RequestInit): Promise<T>;
+    postNoData(route: string, body?: any, options?: RequestInit): Promise<boolean>;
+    postDontProcess<T>(route: string, body?: any, options?: RequestInit): Promise<T>;
+    /**
+     * Makes an authenticated PUT request with standardized error handling
+     * Always processes DataResponse wrapper
+     */
+    put<T>(route: string, body?: any, options?: RequestInit, processDataResponse?: boolean): Promise<T>;
+    /**
+     * Makes an authenticated DELETE request with standardized error handling
+     * Always processes ResponseBase (no data returned)
+     */
+    delete(route: string, options?: RequestInit, processResponse?: boolean): Promise<boolean>;
+    /**
+     * Generic paged list request
+     */
+    getPagedList<T>(endpoint: string, request: PagedListRequest): Promise<PagedListResponse<T>>;
+    getPagedListDetails<T>(endpoint: string, request: PagedListRequest): Promise<PagedListResponse<T>>;
+    getPagedTaskItemList<T>(endpoint: string, request: any): Promise<PagedTaskItemListResponse<T>>;
+    getPagedTaskItemListDetails<T>(endpoint: string, request: any): Promise<PagedTaskItemListResponse<T>>;
+    getPagedTaskCommentList<T>(endpoint: string, request: any): Promise<PagedTaskCommentListResponse<T>>;
+    getPagedAllowanceHistoriesList<T>(endpoint: string, request: PagedAllowanceHistoriesListRequest): Promise<PagedListResponse<T>>;
+    getPagedAllowanceHistoryTaskItemsList<T>(endpoint: string, request: PagedAllowanceHistoryTaskItemsListRequest): Promise<PagedListResponse<T>>;
+    private _tasks?;
+    private _comments?;
+    private _auth?;
+    private _notifications?;
+    private _teams?;
+    private _avatar?;
+    private _allowanceHistories?;
+    get clientConfig(): ApiClientConfig;
+    get allowanceHistories(): AllowanceHistories;
+    get avatar(): Avatar;
+    get notifications(): Notifications;
+    get teams(): Teams;
+    get tasks(): Tasks;
+    get comments(): TaskComments;
+    get auth(): Auth;
+}
+/**
+ * Auth API operations class
+ */
+declare class Auth {
+    private client;
+    constructor(client: ApiClient);
+    login(username: string, password: string): Promise<string>;
+    logout(): Promise<void>;
+    register(registerRequest: RegisterRequest): Promise<ResponseBase>;
+    forgotPassword(forgotPasswordRequest: ForgotPasswordRequest): Promise<ForgotPasswordResponse>;
+    resetPassword(resetPasswordRequest: ResetPasswordRequest): Promise<ResetPasswordResponse>;
+    sendPasswordResetEmail(sendPasswordResetEmailRequest: SendPasswordResetEmailRequest): Promise<SendPasswordResetEmailResponse>;
+}
+/**
+ * Teams API operations class
+ */
+declare class Teams {
+    private client;
+    constructor(client: ApiClient);
+    getTeamDetails(): Promise<any>;
+    updateTeamDetails(teamUpdateRequest: TeamDetailsUpdateRequest): Promise<DataResponse<TeamDetailsResponse>>;
+    getTeamMembers(request: PagedListRequest): Promise<PagedListResponse<User>>;
+    getTeamAllowanceIntervals(): Promise<TeamAllowanceIntervalListResponse>;
+    getTeamAllowanceInterval(id: number): Promise<TeamAllowanceIntervalResponse>;
+    createTeamAllowanceInterval(request: TeamAllowanceIntervalCreateRequest): Promise<TeamAllowanceIntervalResponse>;
+    updateTeamAllowanceInterval(request: TeamAllowanceIntervalUpdateRequest): Promise<TeamAllowanceIntervalResponse>;
+    deleteTeamAllowanceInterval(id: number): Promise<boolean>;
+}
+/**
+ * Notifications API operations class
+ */
+declare class Notifications {
+    private client;
+    constructor(client: ApiClient);
+    registerDevice(request: DeviceRegistrationRequest): Promise<boolean>;
+    unregisterDevice(fcmToken: string): Promise<boolean>;
+    updateUserNotificationPreferences(request: BulkNotificationPreferenceUpdateRequest): Promise<ResponseBase>;
+    createUserNotificationPreferences(request: BulkNotificationPreferenceCreateRequest): Promise<DataResponse<UserNotificationPreferenceResponse[]>>;
+    getUserNotificationPreferences(): Promise<DataResponse<UserNotificationPreferenceResponse[]>>;
+}
+/**
+ * Avatar API operations class
+ */
+declare class Avatar {
+    private client;
+    constructor(client: ApiClient);
+    uploadAvatar(formData: FormData): Promise<{
+        success: boolean;
+        fileName?: string;
+    }>;
+    deleteAvatar(): Promise<boolean>;
+    getAvatarUrl(fileName: string): string;
+    getAvatar(fileName: string): Promise<File | null>;
+}
+/**
+ * Task Comments API operations class
+ */
+declare class TaskComments {
+    private client;
+    constructor(client: ApiClient);
+    create(request: TaskCommentCreateRequest): Promise<any>;
+    update(request: TaskCommentUpdateRequest): Promise<any>;
+    delete(id: number): Promise<any>;
+    getList(request: PagedTaskCommentListRequest): Promise<PagedTaskCommentListResponse<any>>;
+}
+/**
+ * Allowance Histories API operations class
+ */
+declare class AllowanceHistories {
+    private client;
+    constructor(client: ApiClient);
+    getPagedList(request: PagedAllowanceHistoriesListRequest): Promise<PagedListResponse<AllowanceHistoryResponse>>;
+    getPagedTaskItemsList(request: PagedAllowanceHistoryTaskItemsListRequest): Promise<PagedListResponse<AllowanceHistoryTaskItemResponse>>;
+    approveAllowance(request: AllowanceHistoryApprovalRequest): Promise<AllowanceHistoryResponse>;
+    claimAllowance(request: AllowanceHistoryClaimRequest): Promise<AllowanceHistoryResponse>;
+}
+/**
+ * Tasks API operations class
+ */
+declare class Tasks {
+    private client;
+    constructor(client: ApiClient);
+    create(data: any): Promise<any>;
+    update(id: number, data: any): Promise<any>;
+    copy(id: number): Promise<any>;
+    copyList(body: any): Promise<boolean>;
+    delete(id: number): Promise<any>;
+    deleteList(body: any): Promise<boolean>;
+    pin(id: number, pinning: boolean): Promise<boolean>;
+    pinList(pinning: boolean, body: any): Promise<boolean>;
+    setActive(id: number, active: boolean): Promise<boolean>;
+    setActiveList(activating: boolean, body: any): Promise<boolean>;
+    setComplete(id: number, completing: boolean): Promise<boolean>;
+    setCompleteList(completing: boolean, body: any): Promise<boolean>;
+    archive(id: number, archiving: boolean): Promise<boolean>;
+    archiveList(archiving: boolean, body: any): Promise<boolean>;
+    approveBonus(request: BonusApprovalRequest): Promise<boolean>;
+    approveTaskItemAllowance(request: TaskItemAllowanceApprovalRequest): Promise<boolean>;
+    claimBonus(id: number): Promise<boolean>;
+    get(id: number): Promise<any>;
+    getDetails(id: number): Promise<any>;
+    getTaskDetails(id: number): Promise<any>;
+    updateTaskDetails(request: TaskItemTaskDetailsUpdateRequest): Promise<ResponseBase>;
+    getPagedList(request: PagedTaskItemListRequest): Promise<PagedTaskItemListResponse<any>>;
+    getPagedListDetails(request: PagedTaskItemListRequest): Promise<PagedTaskItemDetailsListResponse<any>>;
+}
+/**
+ * Functional approach - creates an API client instance
+ * @param baseUrl - Base URL for the API
+ * @param token - Authentication token
+ * @returns ApiClient instance
+ */
+export declare function createApiClient(baseUrl: string, token: string): ApiClient;
+/**
+ * Hook-friendly function for making authenticated API calls
+ * @param baseUrl - Base URL for the API
+ * @param token - Authentication token
+ * @param route - API route to call
+ * @param options - Additional fetch options
+ * @returns Promise with the response data
+ */
+export declare function apiCall<T>(baseUrl: string, token: string, route: string, options?: RequestInit): Promise<T>;
+export {};