@go-avro/avro-js 0.0.2-beta.36 → 0.0.2-beta.37

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/client/QueryClient.d.ts

@@ -1,8 +1,8 @@
 import { AuthManager } from '../auth/AuthManager';
-import { _Event, Bill, Company, Job, LineItem, ServiceMonth } from '../types/api';
+import { _Event, Bill, Company, Job, LineItem, ServiceMonth, User } from '../types/api';
 import { CancelToken, RetryStrategy } from '../types/client';
 import { StandardError } from '../types/error';
-import { InfiniteData, UseInfiniteQueryResult, useQuery, UseQueryResult } from '@tanstack/react-query';
+import { InfiniteData, UseInfiniteQueryResult, useMutation, useQuery, UseQueryResult } from '@tanstack/react-query';
 export interface AvroQueryClientConfig {
     baseUrl: string;
     authManager: AuthManager;
@@ -15,16 +15,16 @@ declare module '../client/QueryClient' {
         _xhr<T>(method: string, path: string, body: any, cancelToken?: CancelToken, headers?: Record<string, string>, isIdempotent?: boolean, retryCount?: number): 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;
-        getRoot(): ReturnType<typeof useQuery>;
-        getJobs(companyGuid: string, body: {
+        useGetRoot(): ReturnType<typeof useQuery>;
+        useGetJobs(companyGuid: string, body: {
             amt?: number;
             query?: string;
         }, total: number, onProgress?: (fraction: number) => void, isMainLoad?: boolean): UseQueryResult<Job[], StandardError>;
-        getRoutes(companyGuid: string, body: {
+        useGetRoutes(companyGuid: string, body: {
             amt?: number;
             query?: string;
         }, total: number, onProgress?: (fraction: number) => void): UseQueryResult<any[], StandardError>;
-        getEvents(companyGuid: string, body: {
+        useGetEvents(companyGuid: string, body: {
             amt?: number;
             known_ids?: string[];
             unknown_ids?: string[];
@@ -34,7 +34,7 @@ declare module '../client/QueryClient' {
             paid?: boolean;
             jobId?: string;
         }): UseInfiniteQueryResult<InfiniteData<_Event[], unknown>, Error>;
-        getMonths(companyGuid: string, body: {
+        useGetMonths(companyGuid: string, body: {
             amt?: number;
             known_ids?: string[];
             unknown_ids?: string[];
@@ -44,18 +44,36 @@ declare module '../client/QueryClient' {
             paid?: boolean;
             jobId?: string;
         }): UseInfiniteQueryResult<InfiniteData<ServiceMonth[], unknown>, Error>;
-        getBills(companyGuid: string, body: {
+        useGetBills(companyGuid: string, body: {
             amt?: number;
             known_ids?: string[];
             unknown_ids?: string[];
             query?: string;
             paid?: boolean;
         }): UseInfiniteQueryResult<InfiniteData<Bill[], unknown>, Error>;
-        getCompanies(options?: {}): UseQueryResult<{
+        useGetCompanies(options?: {}): UseQueryResult<{
             name: string;
             id: string;
         }[], StandardError>;
-        getCompany(companyId: string): UseQueryResult<Company, 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>;
+        useUpdateJob(): ReturnType<typeof useMutation<unknown, unknown, {
+            jobId: string;
+            updates: Partial<Job>;
+        }, unknown>>;
+        useDeleteJob(): ReturnType<typeof useMutation<unknown, unknown, {
+            jobId: string;
+        }, unknown>>;
+        useCreateJob(): ReturnType<typeof useMutation<{
+            id: string;
+        }, unknown, {
+            companyId: string;
+            jobData: Partial<Job>;
+        }, unknown>>;
     }
 }
 export declare class AvroQueryClient {

package/dist/client/hooks/bills.js

@@ -1,6 +1,6 @@
 import { AvroQueryClient } from '../../client/QueryClient';
-import { useQueryClient, useInfiniteQuery } from '@tanstack/react-query';
-AvroQueryClient.prototype.getBills = function (companyGuid, body) {
+import { useQueryClient, useInfiniteQuery, useQuery } from '@tanstack/react-query';
+AvroQueryClient.prototype.useGetBills = function (companyGuid, body) {
     const queryClient = useQueryClient();
     const result = useInfiniteQuery({
         queryKey: [
@@ -28,3 +28,10 @@ AvroQueryClient.prototype.getBills = function (companyGuid, body) {
     }
     return result;
 };
+AvroQueryClient.prototype.useGetBill = function (billId) {
+    return useQuery({
+        queryKey: ['bill', billId],
+        queryFn: () => this.get(`/bill/${billId}`),
+        enabled: Boolean(billId),
+    });
+};

package/dist/client/hooks/companies.js

@@ -1,13 +1,13 @@
 import { AvroQueryClient } from '../../client/QueryClient';
 import { useQuery } from '@tanstack/react-query';
-AvroQueryClient.prototype.getCompanies = function (options = {}) {
+AvroQueryClient.prototype.useGetCompanies = function (options = {}) {
     return useQuery({
         queryKey: ['/company/list'],
         queryFn: () => this.get('/company/list'),
         ...options,
     });
 };
-AvroQueryClient.prototype.getCompany = function (companyId) {
+AvroQueryClient.prototype.useGetCompany = function (companyId) {
     return useQuery({
         queryKey: ['company', companyId],
         queryFn: () => this.get(`/company/${companyId}`),

package/dist/client/hooks/events.js

@@ -1,6 +1,6 @@
 import { AvroQueryClient } from '../../client/QueryClient';
-import { useQueryClient, useInfiniteQuery } from '@tanstack/react-query';
-AvroQueryClient.prototype.getEvents = function (companyGuid, body) {
+import { useQueryClient, useInfiniteQuery, useQuery } from '@tanstack/react-query';
+AvroQueryClient.prototype.useGetEvents = function (companyGuid, body) {
     const queryClient = useQueryClient();
     const result = useInfiniteQuery({
         queryKey: [
@@ -32,3 +32,10 @@ AvroQueryClient.prototype.getEvents = function (companyGuid, body) {
     }
     return result;
 };
+AvroQueryClient.prototype.useGetEvent = function (eventId) {
+    return useQuery({
+        queryKey: ['event', eventId],
+        queryFn: () => this.get(`/event/${eventId}`),
+        enabled: Boolean(eventId),
+    });
+};

package/dist/client/hooks/jobs.js

@@ -1,6 +1,6 @@
 import { AvroQueryClient } from '../../client/QueryClient';
-import { useQuery, useQueryClient } from '@tanstack/react-query';
-AvroQueryClient.prototype.getJobs = function (companyGuid, body, total = 0, onProgress, isMainLoad = false) {
+import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
+AvroQueryClient.prototype.useGetJobs = function (companyGuid, body, total = 0, onProgress, isMainLoad = false) {
     const queryClient = useQueryClient();
     return useQuery({
         queryKey: [isMainLoad ? 'main' : 'jobs', companyGuid, body.amt ?? 50, body.query ?? ""],
@@ -45,3 +45,140 @@ AvroQueryClient.prototype.getJobs = function (companyGuid, body, total = 0, onPr
         ...isMainLoad ? { staleTime: Infinity, cacheTime: Infinity } : {},
     });
 };
+AvroQueryClient.prototype.useGetJob = function (jobId) {
+    return useQuery({
+        queryKey: ['job', jobId],
+        queryFn: () => this.get(`/job/${jobId}`),
+        enabled: Boolean(jobId),
+    });
+};
+AvroQueryClient.prototype.useCreateJob = function () {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: ({ companyId, jobData }) => {
+            return this.post(`/company/${companyId}/job`, JSON.stringify(jobData), undefined, {
+                "Content-Type": "application/json",
+            });
+        },
+        onMutate: async ({ companyId, jobData }) => {
+            await queryClient.cancelQueries({ queryKey: ['jobs'] });
+            const previousJobs = queryClient.getQueryData(['jobs']);
+            queryClient.setQueryData(['jobs'], (oldData) => {
+                if (!oldData)
+                    return [jobData];
+                if (oldData.pages) {
+                    const firstPage = oldData.pages[0] || [];
+                    return {
+                        ...oldData,
+                        pages: [[jobData, ...firstPage], ...oldData.pages.slice(1)],
+                    };
+                }
+                if (Array.isArray(oldData)) {
+                    return [jobData, ...oldData];
+                }
+                return oldData;
+            });
+            return { previousJobs };
+        },
+        onError: (err, variables, context) => {
+            if (context?.previousJobs) {
+                queryClient.setQueryData(['jobs'], context.previousJobs);
+            }
+        },
+        onSettled: (data, error, variables) => {
+            const { id: jobId } = data ?? {};
+            queryClient.invalidateQueries({ queryKey: ['jobs'] });
+            queryClient.invalidateQueries({ queryKey: ['job', jobId] });
+        },
+    });
+};
+AvroQueryClient.prototype.useUpdateJob = function () {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: ({ jobId, updates }) => {
+            return this.put(`/job/${jobId}`, JSON.stringify(updates), undefined, {
+                "Content-Type": "application/json",
+            });
+        },
+        onMutate: async ({ jobId, updates }) => {
+            await queryClient.cancelQueries({ queryKey: ['jobs'] });
+            await queryClient.cancelQueries({ queryKey: ['job', jobId] });
+            const previousJobs = queryClient.getQueryData(['jobs']);
+            const previousJob = queryClient.getQueryData(['job', jobId]);
+            queryClient.setQueryData(['job', jobId], (oldData) => oldData ? { ...oldData, ...updates } : undefined);
+            queryClient.setQueriesData({ queryKey: ['jobs'] }, (oldData) => {
+                if (!oldData)
+                    return oldData;
+                if (oldData.pages) {
+                    return {
+                        ...oldData,
+                        pages: oldData.pages.map((page) => page.map((job) => job.id === jobId ? { ...job, ...updates } : job)),
+                    };
+                }
+                if (Array.isArray(oldData)) {
+                    return oldData.map((job) => job.id === jobId ? { ...job, ...updates } : job);
+                }
+                return oldData;
+            });
+            return { previousJobs, previousJob };
+        },
+        onError: (err, variables, context) => {
+            const { jobId } = variables;
+            if (context?.previousJobs) {
+                queryClient.setQueryData(['jobs'], context.previousJobs);
+            }
+            if (context?.previousJob) {
+                queryClient.setQueryData(['job', jobId], context.previousJob);
+            }
+        },
+        onSettled: (data, error, variables) => {
+            const { jobId } = variables;
+            queryClient.invalidateQueries({ queryKey: ['jobs'] });
+            queryClient.invalidateQueries({ queryKey: ['job', jobId] });
+        },
+    });
+};
+AvroQueryClient.prototype.useDeleteJob = function () {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: async ({ jobId }) => {
+            return this.delete(`/job/${jobId}`, undefined, {
+                "Content-Type": "application/json",
+            });
+        },
+        onMutate: async ({ jobId }) => {
+            await queryClient.cancelQueries({ queryKey: ['jobs'] });
+            await queryClient.cancelQueries({ queryKey: ['job', jobId] });
+            const previousJobs = queryClient.getQueryData(['jobs']);
+            const previousJob = queryClient.getQueryData(['job', jobId]);
+            queryClient.setQueryData(['job', jobId], undefined);
+            queryClient.setQueriesData({ queryKey: ['jobs'] }, (oldData) => {
+                if (!oldData)
+                    return oldData;
+                if (oldData.pages) {
+                    const updatedPages = oldData.pages.map((page) => page.filter((job) => job.id !== jobId));
+                    return { ...oldData, pages: updatedPages };
+                }
+                if (Array.isArray(oldData)) {
+                    return oldData.filter((job) => job.id !== jobId);
+                }
+                return oldData;
+            });
+            return { previousJobs, previousJob };
+        },
+        onError: (_err, variables, context) => {
+            const { jobId } = variables;
+            if (context?.previousJobs) {
+                queryClient.setQueryData(['jobs'], context.previousJobs);
+            }
+            if (context?.previousJob) {
+                queryClient.setQueryData(['job', jobId], context.previousJob);
+            }
+        },
+        onSettled: (_data, _error, variables) => {
+            const { jobId } = variables;
+            queryClient.invalidateQueries({ queryKey: ['jobs'] });
+            queryClient.invalidateQueries({ queryKey: ['job', jobId] });
+        },
+    });
+};

package/dist/client/hooks/months.js

@@ -1,6 +1,6 @@
 import { AvroQueryClient } from '../../client/QueryClient';
 import { useQueryClient, useInfiniteQuery } from '@tanstack/react-query';
-AvroQueryClient.prototype.getMonths = function (companyGuid, body) {
+AvroQueryClient.prototype.useGetMonths = function (companyGuid, body) {
     const queryClient = useQueryClient();
     const result = useInfiniteQuery({
         queryKey: [

package/dist/client/hooks/root.js

@@ -1,6 +1,6 @@
 import { AvroQueryClient } from '../../client/QueryClient';
 import { useQuery } from '@tanstack/react-query';
-AvroQueryClient.prototype.getRoot = function () {
+AvroQueryClient.prototype.useGetRoot = function () {
     return useQuery({
         queryKey: ['health'],
         queryFn: () => this.get('/', undefined) // your async fetch function

package/dist/client/hooks/routes.js

@@ -1,6 +1,6 @@
 import { AvroQueryClient } from '../../client/QueryClient';
 import { useQuery, useQueryClient } from '@tanstack/react-query';
-AvroQueryClient.prototype.getRoutes = function (companyGuid, body, total = 0, onProgress) {
+AvroQueryClient.prototype.useGetRoutes = function (companyGuid, body, total = 0, onProgress) {
     const queryClient = useQueryClient();
     return useQuery({
         queryKey: ['routes', companyGuid, body.amt ?? 50, body.query ?? ""],

package/dist/client/hooks/users.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/client/hooks/users.js

@@ -0,0 +1,16 @@
+import { AvroQueryClient } from "../../client/QueryClient";
+import { useQuery } from "@tanstack/react-query";
+AvroQueryClient.prototype.useGetUser = function (userId) {
+    return useQuery({
+        queryKey: ['user', userId],
+        queryFn: () => this.get(`/user/${userId}`),
+        enabled: Boolean(userId),
+    });
+};
+AvroQueryClient.prototype.useGetSelf = function () {
+    return useQuery({
+        queryKey: ['user'],
+        queryFn: () => this.get(`/user`),
+        enabled: Boolean(this),
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go-avro/avro-js",
-  "version": "0.0.2-beta.36",
+  "version": "0.0.2-beta.37",
   "description": "JS client for Avro backend integration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",