@go-avro/avro-js 0.0.2-beta.6 → 0.0.2-beta.61

package/README.md

@@ -10,6 +10,7 @@ This SDK provides:
 - Typed API interfaces for Avro entities (users, jobs, teams, etc.)
 - Pluggable token storage (in-memory, localStorage, SecureStore, etc.)
 - XHR-based requests for compatibility with React Native WebViews and older environments
+- Mutation and Data Hooks for easy plug-in use in React and React Native projects.
 
 ## Installation
 

package/dist/auth/AuthManager.d.ts

@@ -2,6 +2,7 @@ import { TokenStorage, Tokens } from '../types/auth';
 export declare class AuthManager {
     private storages;
     private baseUrl;
+    private tokenRefreshedCallbacks;
     constructor({ baseUrl, storage, }: {
         baseUrl: string;
         storage: TokenStorage | TokenStorage[];
@@ -9,6 +10,7 @@ export declare class AuthManager {
     isAuthenticated(): Promise<boolean>;
     fetchNewTokens(): Promise<Tokens>;
     accessToken(): Promise<string | undefined>;
+    onTokenRefreshed(callback: (accessToken: string) => void): void;
     refreshTokens(): Promise<Tokens | null>;
     setTokens(tokens: Tokens): Promise<void>;
     clearTokens(): Promise<void>;

package/dist/auth/AuthManager.js

@@ -1,5 +1,6 @@
 export class AuthManager {
     constructor({ baseUrl, storage, }) {
+        this.tokenRefreshedCallbacks = [];
         this.storages = Array.isArray(storage) ? storage : [storage];
         if (this.storages.length === 0) {
             throw new Error('At least one token storage must be provided');
@@ -88,10 +89,17 @@ export class AuthManager {
         const newToken = await this.refreshTokens();
         return newToken?.access_token;
     }
+    onTokenRefreshed(callback) {
+        this.tokenRefreshedCallbacks.push(callback);
+    }
     async refreshTokens() {
         try {
             const newToken = await this.fetchNewTokens();
             await Promise.all(this.storages.map(s => s.set(newToken)));
+            this.tokenRefreshedCallbacks.forEach(cb => {
+                if (newToken?.access_token)
+                    cb(newToken.access_token);
+            });
             return newToken;
         }
         catch (error) {

package/dist/client/QueryClient.d.ts

@@ -1,5 +1,10 @@
+import { InfiniteData, UseInfiniteQueryResult, useMutation, UseQueryResult } from '@tanstack/react-query';
 import { AuthManager } from '../auth/AuthManager';
+import { _Event, ApiInfo, Bill, Break, Company, Job, LineItem, Route, ServiceMonth, Session, User, UserCompanyAssociation } from '../types/api';
+import { Tokens } from '../types/auth';
 import { CancelToken, RetryStrategy } from '../types/client';
+import { StandardError } from '../types/error';
+import { Socket } from 'socket.io-client';
 export interface AvroQueryClientConfig {
     baseUrl: string;
     authManager: AuthManager;
@@ -7,20 +12,261 @@ export interface AvroQueryClientConfig {
     retryStrategy?: RetryStrategy;
     timeout?: number;
 }
+declare module '../client/QueryClient' {
+    interface AvroQueryClient {
+        _xhr<T>(method: string, path: string, body: any, cancelToken?: CancelToken, headers?: Record<string, string>, isIdempotent?: boolean, retryCount?: number, progressUpdateCallback?: (loaded: number, total: number) => void): Promise<T>;
+        _fetch<T>(method: string, path: string, body: any, cancelToken?: CancelToken, headers?: Record<string, string>, isIdempotent?: boolean, retryCount?: number): Promise<T>;
+        getDelay(strategy: RetryStrategy, attempt: number): number;
+        useGetRoot(): UseQueryResult<ApiInfo, StandardError>;
+        useGetJobs(companyGuid: string, body: {
+            amt?: number;
+            query?: string;
+        }, total: number, onProgress?: (fraction: number) => void, isMainLoad?: boolean): UseQueryResult<Job[], StandardError>;
+        useGetRoutes(companyGuid: string, body: {
+            amt?: number;
+            query?: string;
+        }, total: number, onProgress?: (fraction: number) => void): UseQueryResult<any[], StandardError>;
+        useGetEvents(companyGuid: string, body: {
+            amt?: number;
+            known_ids?: string[];
+            unknown_ids?: string[];
+            query?: string;
+            unbilled?: boolean;
+            billed?: boolean;
+            paid?: boolean;
+            jobId?: string;
+        }): UseInfiniteQueryResult<InfiniteData<_Event[], unknown>, StandardError>;
+        useGetMonths(companyGuid: string, body: {
+            amt?: number;
+            known_ids?: string[];
+            unknown_ids?: string[];
+            query?: string;
+            unbilled?: boolean;
+            billed?: boolean;
+            paid?: boolean;
+            jobId?: string;
+        }): UseInfiniteQueryResult<InfiniteData<ServiceMonth[], unknown>, StandardError>;
+        useGetBills(companyGuid: string, body: {
+            amt?: number;
+            known_ids?: string[];
+            unknown_ids?: string[];
+            query?: string;
+            paid?: boolean;
+        }): UseInfiniteQueryResult<InfiniteData<Bill[], unknown>, StandardError>;
+        useGetCompanies(options?: {}): UseQueryResult<{
+            name: string;
+            id: string;
+        }[], StandardError>;
+        useGetCompany(companyId: string): UseQueryResult<Company, StandardError>;
+        useGetJob(jobId: string): UseQueryResult<Job, StandardError>;
+        useGetEvent(eventId: string): UseQueryResult<_Event, StandardError>;
+        useGetUser(userId: string): UseQueryResult<User, StandardError>;
+        useGetSelf(): UseQueryResult<User, StandardError>;
+        useGetBill(billId: string): UseQueryResult<Bill, StandardError>;
+        useGetRoute(routeId: string): UseQueryResult<Route, StandardError>;
+        useGetUserSessions(): UseQueryResult<Session[], StandardError>;
+        useCreateEvent(): ReturnType<typeof useMutation<{
+            id: string;
+        }, StandardError, {
+            companyId: string;
+            eventData: Partial<_Event>;
+        }>>;
+        useCreateUserSession(): ReturnType<typeof useMutation<{
+            id: string;
+        }, StandardError, {
+            companyId: string;
+            sessionData: Partial<Session>;
+        }>>;
+        useCreateBill(): ReturnType<typeof useMutation<{
+            id: string;
+            invoice_id: number;
+        }, StandardError, {
+            companyId: string;
+            data: {
+                line_items: LineItem[];
+                due_date: number;
+                users: string[];
+                custom_emails: [string, string][];
+            };
+        }>>;
+        useCreateJob(): ReturnType<typeof useMutation<{
+            id: string;
+        }, StandardError, {
+            companyId: string;
+            jobData: Partial<Job>;
+        }>>;
+        useCreateSelf(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            username: string;
+            name: string;
+            email: string;
+            password: string;
+            phone_number: string;
+        }>>;
+        useCreateSessionBreak(): ReturnType<typeof useMutation<{
+            id: string;
+        }, StandardError, {
+            sessionId: string;
+            breakData: Partial<Break>;
+        }>>;
+        useUpdateEvent(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            eventId: string;
+            updates: Partial<_Event>;
+        }>>;
+        useUpdateUserSession(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            sessionId: string;
+            updates: Partial<Session>;
+        }>>;
+        useUpdateJob(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            jobId: string;
+            updates: Partial<Job>;
+        }>>;
+        useUpdateBill(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            billId: string;
+            updates: Partial<Bill>;
+        }>>;
+        useUpdateRoute(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            routeId: string;
+            updates: Partial<Route>;
+        }>>;
+        useUpdateEvents(): ReturnType<typeof useMutation<void, StandardError, {
+            companyId: string;
+            events: (_Event & {
+                page?: number;
+            })[];
+            action: "billed" | "paid";
+        }>>;
+        useUpdateMonths(): ReturnType<typeof useMutation<void, StandardError, {
+            companyId: string;
+            months: (ServiceMonth & {
+                page?: number;
+            })[];
+            action: "billed" | "paid";
+        }>>;
+        useUpdateUserCompany(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            company_id: string;
+            user_id: string;
+            data: Partial<UserCompanyAssociation>;
+        }>>;
+        useUpdateSessionBreak(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            breakId: string;
+            updates: Partial<Break>;
+        }>>;
+        useDeleteJob(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            jobId: string;
+        }>>;
+        useUpdateCompany(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            companyId: string;
+            companyData: Partial<Company | {
+                logo: File | null;
+            }>;
+        }>>;
+        useDeleteEvent(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            eventId: string;
+        }>>;
+        useDeleteBill(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            billId: string;
+        }>>;
+        useDeleteRoute(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, {
+            routeId: string;
+        }>>;
+        useDeleteSelf(): ReturnType<typeof useMutation<{
+            msg: string;
+        }, StandardError, void>>;
+    }
+}
 export declare class AvroQueryClient {
-    private config;
+    protected config: Required<AvroQueryClientConfig>;
+    readonly socket: Socket;
     constructor(config: AvroQueryClientConfig);
-    getDelay(strategy: RetryStrategy, attempt: number): number;
-    private _xhr;
-    private _fetch;
-    get<T>(path: string, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<T>;
-    post<T>(path: string, data: any, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<T>;
-    put<T>(path: string, data: any, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<T>;
-    delete<T>(path: string, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<T>;
+    emit(eventName: string, data: unknown): void;
+    on<T>(eventName: string, callback: (data: T) => void): void;
+    off(eventName: string, callback?: Function): void;
+    get<T>(path: string, cancelToken?: CancelToken, headers?: Record<string, string>, progressUpdateCallback?: (loaded: number, total: number) => void): Promise<T>;
+    post<T>(path: string, data: any, cancelToken?: CancelToken, headers?: Record<string, string>, progressUpdateCallback?: (loaded: number, total: number) => void): Promise<T>;
+    put<T>(path: string, data: any, cancelToken?: CancelToken, headers?: Record<string, string>, progressUpdateCallback?: (loaded: number, total: number) => void): Promise<T>;
+    delete<T>(path: string, cancelToken?: CancelToken, headers?: Record<string, string>, progressUpdateCallback?: (loaded: number, total: number) => void): Promise<T>;
     login(data: {
         username: string;
         password: string;
     }, cancelToken?: CancelToken): Promise<Boolean>;
-    logout(cancelToken?: CancelToken): Promise<void>;
-    fetchJobs(companyGuid: string, amt?: number, knownIds?: string[], unknownIds?: string[], keyword?: string, offset?: number, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<any>;
+    setTokens(tokens: Tokens): Promise<void>;
+    clearTokens(): Promise<void>;
+    useLogout(): ReturnType<typeof useMutation<void, StandardError, CancelToken | undefined>>;
+    fetchJobs(companyGuid: string, body?: {
+        amt?: number;
+        known_ids?: string[];
+        unknown_ids?: string[];
+        query?: string;
+        offset?: number;
+    }, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<any>;
+    fetchEvents(companyGuid: string, body?: {
+        amt?: number;
+        known_ids?: string[];
+        unknown_ids?: string[];
+        query?: string;
+        offset?: number;
+        unbilled?: boolean;
+        billed?: boolean;
+        paid?: boolean;
+        jobId?: string | null;
+    }, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<any>;
+    fetchMonths(companyGuid: string, body?: {
+        amt?: number;
+        known_ids?: string[];
+        unknown_ids?: string[];
+        query?: string;
+        offset?: number;
+        unbilled?: boolean;
+        billed?: boolean;
+        paid?: boolean;
+        jobId?: string | null;
+    }, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<any>;
+    fetchBills(companyGuid: string, body?: {
+        amt?: number;
+        known_ids?: string[];
+        unknown_ids?: string[];
+        query?: string;
+        offset?: number;
+        paid?: boolean;
+    }, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<any>;
+    fetchRoutes(companyGuid: string, body?: {
+        amt?: number;
+        known_ids?: string[];
+        unknown_ids?: string[];
+        query?: string;
+        offset?: number;
+    }, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<any>;
+    sendEmail(emailId: string, formData: FormData, progressUpdateCallback?: (loaded: number, total: number) => void): Promise<void>;
+    createBill(companyGuid: string, data: {
+        line_items: LineItem[];
+        due_date: number;
+        users: string[];
+        custom_emails: [string, string][];
+    }, cancelToken?: CancelToken): Promise<any>;
 }