@go-avro/avro-js 0.0.2-beta.17 → 0.0.2-beta.171

package/dist/client/hooks/users.js

@@ -0,0 +1,118 @@
+import { useMutation, useQuery } from "@tanstack/react-query";
+import { AvroQueryClient } from "../../client/QueryClient";
+import { AuthState } from "../../types/auth";
+AvroQueryClient.prototype.useGetUser = function (userId) {
+    return useQuery({
+        queryKey: ['user', userId],
+        queryFn: () => this.get(`/user/${userId}`),
+        enabled: Boolean(userId),
+    });
+};
+AvroQueryClient.prototype.useSearchUsers = function (searchUsername) {
+    return useQuery({
+        queryKey: ['user', 'search', searchUsername],
+        queryFn: () => {
+            if (!searchUsername)
+                return Promise.resolve([]);
+            return this.get(`/user/search/${searchUsername}`);
+        },
+        enabled: Boolean(searchUsername),
+    });
+};
+AvroQueryClient.prototype.useGetSelf = function () {
+    return useQuery({
+        queryKey: ['user'],
+        queryFn: () => this.get(`/user`),
+        enabled: this.getAuthState() === AuthState.AUTHENTICATED,
+    });
+};
+AvroQueryClient.prototype.useCreateSelf = function () {
+    const queryClient = this.getQueryClient();
+    return useMutation({
+        mutationFn: async (data) => {
+            return this.post('/user', JSON.stringify(data), undefined, { "Content-Type": "application/json" });
+        },
+        onSettled: () => {
+            queryClient.invalidateQueries({ queryKey: ['user'] });
+        },
+    });
+};
+AvroQueryClient.prototype.useUpdateSelf = function () {
+    const queryClient = this.getQueryClient();
+    return useMutation({
+        mutationFn: async (data) => {
+            return this.put(`/user`, JSON.stringify(data), undefined, { "Content-Type": "application/json" });
+        },
+        // Optimistically update the user data in the cache
+        onMutate: async (data) => {
+            await queryClient.cancelQueries({ queryKey: ['user'] });
+            const previousUser = queryClient.getQueryData(['user']);
+            if (previousUser) {
+                queryClient.setQueryData(['user'], { ...previousUser, ...data });
+            }
+            return { previousUser };
+        },
+        onError: (err, _, context) => {
+            if (context?.previousUser) {
+                queryClient.setQueryData(['user'], context.previousUser);
+            }
+        },
+        onSettled: () => {
+            queryClient.invalidateQueries({ queryKey: ['user'] });
+        },
+    });
+};
+AvroQueryClient.prototype.useUpdateUserCompany = function () {
+    const queryClient = this.getQueryClient();
+    return useMutation({
+        mutationFn: async ({ user_id, data }) => {
+            return this.put(`/company/${this.companyId}/user/${user_id}`, JSON.stringify(data), undefined, { "Content-Type": "application/json" });
+        },
+        // Optimistically update the user data and company data in the cache
+        onMutate: async (data) => {
+            await queryClient.cancelQueries({ queryKey: ['user'] });
+            await queryClient.cancelQueries({ queryKey: ['company', this.companyId] });
+            const previousCompany = queryClient.getQueryData(['company', this.companyId]);
+            if (previousCompany) {
+                let oldCompanyUser = previousCompany.users?.find((u) => u.user.id === data.user_id);
+                if (oldCompanyUser) {
+                    oldCompanyUser = { ...oldCompanyUser, ...data.data };
+                    const newUsers = previousCompany.users?.map((u) => u.user.id === data.user_id ? oldCompanyUser : u) ?? [];
+                    queryClient.setQueryData(['company', this.companyId], { ...previousCompany, users: newUsers });
+                }
+            }
+            return { previousCompany };
+        },
+        onError: (err, _, context) => {
+            if (context?.previousCompany) {
+                queryClient.setQueryData(['company', this.companyId], context.previousCompany);
+            }
+        },
+        onSettled: (data, error, variables) => {
+            queryClient.invalidateQueries({ queryKey: ['user'] });
+            queryClient.invalidateQueries({ queryKey: ['company', this.companyId] });
+        },
+    });
+};
+AvroQueryClient.prototype.useDeleteSelf = function () {
+    const queryClient = this.getQueryClient();
+    return useMutation({
+        mutationFn: async () => {
+            return this.delete(`/user`);
+        },
+        onMutate: async () => {
+            await queryClient.cancelQueries({ queryKey: ['user'] });
+            const previousUser = queryClient.getQueryData(['user']);
+            queryClient.removeQueries({ queryKey: ['user'] });
+            return { previousUser };
+        },
+        onError: (err, _, context) => {
+            if (context?.previousUser) {
+                queryClient.setQueryData(['user'], context.previousUser);
+            }
+        },
+        onSettled: () => {
+            queryClient.invalidateQueries({ queryKey: ['user'] });
+        },
+    });
+};

package/dist/index.d.ts

@@ -1,6 +1,32 @@
 export { AvroQueryClientConfig, AvroQueryClient } from './client/QueryClient';
+export { AvroQueryClientProvider, useAvroQueryClient } from './client/AvroQueryClientProvider';
 export { AuthManager } from './auth/AuthManager';
 export { MemoryStorage, LocalStorage } from './auth/storage';
+import './client/core/xhr';
+import './client/core/fetch';
+import './client/core/utils';
+import './client/hooks/root';
+import './client/hooks/jobs';
+import './client/hooks/routes';
+import './client/hooks/events';
+import './client/hooks/months';
+import './client/hooks/bills';
+import './client/hooks/companies';
+import './client/hooks/users';
+import './client/hooks/sessions';
+import './client/hooks/chats';
+import './client/hooks/catalog_items';
+import './client/hooks/messages';
+import './client/hooks/plans';
+import './client/hooks/analytics';
+import './client/hooks/avro';
+import './client/hooks/teams';
+import './client/hooks/labels';
+import './client/hooks/groups';
+import './client/hooks/skills';
+import './client/hooks/proposal';
 export * from './types/api';
-export * from './types/error';
+export * from './types/auth';
+export * from './types/cache';
 export * from './types/client';
+export * from './types/error';

package/dist/index.js

@@ -1,6 +1,32 @@
 export { AvroQueryClient } from './client/QueryClient';
+export { AvroQueryClientProvider, useAvroQueryClient } from './client/AvroQueryClientProvider';
 export { AuthManager } from './auth/AuthManager';
 export { MemoryStorage, LocalStorage } from './auth/storage';
+import './client/core/xhr';
+import './client/core/fetch';
+import './client/core/utils';
+import './client/hooks/root';
+import './client/hooks/jobs';
+import './client/hooks/routes';
+import './client/hooks/events';
+import './client/hooks/months';
+import './client/hooks/bills';
+import './client/hooks/companies';
+import './client/hooks/users';
+import './client/hooks/sessions';
+import './client/hooks/chats';
+import './client/hooks/catalog_items';
+import './client/hooks/messages';
+import './client/hooks/plans';
+import './client/hooks/analytics';
+import './client/hooks/avro';
+import './client/hooks/teams';
+import './client/hooks/labels';
+import './client/hooks/groups';
+import './client/hooks/skills';
+import './client/hooks/proposal';
 export * from './types/api';
-export * from './types/error';
+export * from './types/auth';
+export * from './types/cache';
 export * from './types/client';
+export * from './types/error';

package/dist/types/api.d.ts

@@ -1,3 +1,36 @@
+export interface ApiInfo {
+    app_semver: string;
+    db_healthy: boolean;
+    logged_in_as: string;
+    ors_healthy: string;
+    pelias_healthy: boolean;
+    version: string;
+    vroom_healthy: boolean;
+}
+export interface CatalogItem {
+    id: string;
+    name: string;
+    company_id: string;
+    description: string;
+    industry: string;
+    price_format: string;
+    payment_options: PaymentOption[];
+    recommended_frequency?: number | null;
+    recommended_activate_on?: number | null;
+    recommended_expire_on?: number | null;
+    time_created: number;
+    time_updated: number | null;
+    skills: string[];
+}
+export interface PaymentOption {
+    name: string;
+    id: string;
+    is_prepay: boolean;
+    price_under_prepay?: number;
+    price: number;
+    recommended_prepay_count?: number;
+    mode: "MONTH" | "SERVICE";
+}
 export interface PaymentMethod {
     allow_redisplay: string;
     autopay: boolean;
@@ -48,6 +81,33 @@ export interface PaymentMethod {
         } | null;
     } | null;
 }
+export type ScheduleItem = {
+    type: "location";
+    location: [number, number];
+    time_window: [number, number];
+} | {
+    type: "break";
+    start: [number, number];
+    time_window: [number, number];
+} | {
+    type: "job";
+    job_id: string;
+    task_ids: string[];
+    location: [number, number];
+    time_window: [number, number];
+};
+export type TeamSchedule = {
+    team_id: string;
+    schedule: ScheduleItem[];
+    name: string;
+    optimize: boolean;
+};
+export type RouteScheduleConfig = {
+    schedules: TeamSchedule[];
+    whitelist: string[];
+    blacklist: string[];
+    tasks: string[];
+};
 export interface Avro {
     id: string;
     name: string;
@@ -75,14 +135,8 @@ export interface LineItem {
     amount: number | null;
     time_created: number;
 }
-export interface CustomLineItem {
-    id: string;
+export interface CustomLineItem extends LineItem {
     line_item_type: "CUSTOM";
-    name: string;
-    description: string;
-    cost: number | null;
-    amount: number | null;
-    time_created: number;
 }
 export interface Reaction {
     id: string;
@@ -114,10 +168,13 @@ export interface Chat {
     user_state: MemberState[];
     messages: Message[];
 }
-export interface TeamLocation {
+export interface Location {
     accuracy: number;
     heading: number;
     id: string;
+    team_id: string | null;
+    user_company_id: string;
+    user_id: string;
     latitude: number;
     longitude: number;
     time_collected: number;
@@ -150,14 +207,13 @@ export interface Team {
     end_longitude: number;
     start_time: number;
     users: string[];
-    current_location: TeamLocation;
+    current_location: Location | null;
     start_address: string;
     end_address: string;
 }
 export interface Subscription {
     time_created: number;
     time_updated: string;
-    user: User;
     user_company_id: string;
     job_id: string;
     id: string;
@@ -173,10 +229,14 @@ export interface Plan {
     trial_period_days: number;
     time_created: number;
     time_updated: number;
+    available_to_new_companies?: boolean;
+    available_to?: string[];
 }
 export interface BillPayment {
     id: string;
     amount: number;
+    avro_fees: number;
+    stripe_fees: number;
     stripe_pi_id: string;
     bill_user_id: string;
     status: "created" | "processing" | "succeeded" | "failed" | "canceled" | "requires_action";
@@ -198,19 +258,21 @@ export interface BillUser {
 export interface User {
     id: string;
     username: string;
-    name: string;
+    first_name: string;
+    last_name: string;
     verified: boolean;
-    companies: UserCompanyAssociation[] | null;
     email: string | null;
     phone_number: string | null;
-    time_created: string | null;
-    time_updated: string | null;
+    time_created: number;
+    time_updated: number | null;
+    share_location: boolean;
     can_send_emails: boolean | null;
     payment_methods: PaymentMethod[];
     autopay_payment_types: string[];
     autopay: boolean | null;
     chats: Chat[];
     bills: BillUser[];
+    is_root: boolean;
 }
 export interface Break {
     id: string;
@@ -219,24 +281,20 @@ export interface Break {
     company_billable: boolean;
     client_billable: boolean;
 }
-export interface ServiceMonth {
-    id: string;
+export interface ServiceMonth extends LineItem {
     line_item_type: "SERVICE_MONTH";
     job_name: string;
     job_id: string | null;
     job_address: string;
     job_labels: string[];
     bill_id: string | null;
-    cost: number;
     billed: boolean;
     paid: boolean;
-    amount: number;
     tasks: string[];
-    time_created: number;
     time_updated: number | null;
 }
 export interface Session {
-    session_id: string;
+    id: string;
     user_id: string;
     company_id: string;
     time_started: number;
@@ -244,7 +302,7 @@ export interface Session {
     break_id: string;
     is_paused: boolean;
     team_id: string;
-    current_route_id: string;
+    route_id: string;
     breaks: Break[];
 }
 export interface Group {
@@ -253,23 +311,84 @@ export interface Group {
     is_active: boolean;
     is_user_type: boolean;
     users: string[];
-    permissions: string[];
+    permissions: Permission[];
     company_id: string;
     time_created: number;
     time_updated: number;
 }
+export declare const NotificationLevel: {
+    readonly IN_APP: 0;
+    readonly EMAIL: 1;
+    readonly SMS: 2;
+    readonly PUSH: 3;
+};
+export type NotificationLevel = typeof NotificationLevel[keyof typeof NotificationLevel];
+export declare const LoginResponse: {
+    readonly SUCCESS: "SUCCESS";
+    readonly NEEDS_TOTP: "NEEDS_TOTP";
+};
+export type LoginResponse = typeof LoginResponse[keyof typeof LoginResponse];
+export declare const Permission: {
+    readonly CAN_WRITE_COMPANY: "can_write_company";
+    readonly CAN_READ_GROUPS: "can_read_groups";
+    readonly CAN_WRITE_PROPOSALS: "can_write_proposals";
+    readonly CAN_READ_PROPOSALS: "can_read_proposals";
+    readonly CAN_WRITE_GROUPS: "can_write_groups";
+    readonly CAN_WRITE_ROUTES: "can_write_routes";
+    readonly CAN_WRITE_SUBSCRIPTIONS: "can_write_subscriptions";
+    readonly CAN_READ_SUBSCRIPTIONS: "can_read_subscriptions";
+    readonly CAN_WRITE_TEAMS: "can_write_teams";
+    readonly CAN_WRITE_JOBS: "can_write_jobs";
+    readonly CAN_WRITE_TASKS: "can_write_tasks";
+    readonly CAN_WRITE_ITEMS: "can_write_items";
+    readonly CAN_WRITE_SKILLS: "can_write_skills";
+    readonly CAN_WRITE_EMAILS: "can_write_emails";
+    readonly CAN_WRITE_OTHERS_SESSIONS: "can_write_others_sessions";
+    readonly CAN_READ_OTHERS_SESSIONS: "can_read_others_sessions";
+    readonly CAN_READ_SESSIONS: "can_read_sessions";
+    readonly CAN_WRITE_LABELS: "can_write_labels";
+    readonly CAN_READ_LABELS: "can_read_labels";
+    readonly CAN_READ_ROUTES: "can_read_routes";
+    readonly CAN_READ_TEAMS: "can_read_teams";
+    readonly CAN_READ_JOBS: "can_read_jobs";
+    readonly CAN_WRITE_EVENTS: "can_write_events";
+    readonly CAN_READ_TASKS: "can_read_tasks";
+    readonly CAN_READ_ITEMS: "can_read_items";
+    readonly CAN_READ_SKILLS: "can_read_skills";
+    readonly CAN_WRITE_SESSIONS: "can_write_sessions";
+    readonly CAN_READ_EMAILS: "can_read_emails";
+    readonly CAN_WRITE_SMS: "can_write_sms";
+    readonly CAN_READ_SMS: "can_read_sms";
+    readonly CAN_WRITE_NOTIFICATIONS: "can_write_notifications";
+    readonly CAN_READ_EVENTS: "can_read_events";
+    readonly CAN_READ_MONTHS: "can_read_months";
+    readonly CAN_WRITE_MONTHS: "can_write_months";
+    readonly CAN_WRITE_BILLS: "can_write_bills";
+    readonly CAN_READ_BILLS: "can_read_bills";
+    readonly CAN_OPTIMIZE: "can_optimize";
+    readonly CAN_READ_COMPANY: "can_read_company";
+    readonly CAN_WRITE_OTHERS_TIMECARDS: "can_write_others_timecards";
+    readonly CAN_READ_OTHERS_TIMECARDS: "can_read_others_timecards";
+    readonly CAN_WRITE_TIMECARDS: "can_write_timecards";
+    readonly CAN_READ_TIMECARDS: "can_read_timecards";
+    readonly CAN_APPROVE_TIME_OFF: "can_approve_time_off";
+    readonly IS_ROOT: "is_root";
+    readonly IS_CUSTOMER: "is_customer";
+};
+export type Permission = typeof Permission[keyof typeof Permission];
 export interface UserCompanyAssociation {
     id: string;
     user: User;
     company: string;
-    permissions: string[];
-    effective_permissions: string[];
+    permissions: Permission[];
+    effective_permissions: Permission[];
     time_created: number | null;
     time_updated: number | null;
-    notification_setting: number[];
+    notification_setting: NotificationLevel[];
     share_email_company_wide: boolean;
-    notifications: number[];
+    notifications: Notification[];
     groups: string[];
+    last_location: Location | null;
 }
 export interface Email {
     id: string;
@@ -308,13 +427,13 @@ export interface Bill {
     customer_email: string | null;
     manual_emails: string[][];
     users: BillUser[];
-    paid_at: number;
+    status: "SENT" | "PAID" | "PARTIALLY_PAID" | "MANUALLY_PAID";
     time_created: number;
     time_updated: number;
     events: string[];
     intent_created_at: number;
     intent_last_created_at: number;
-    payment: BillPayment | null;
+    payments: BillPayment[];
     line_items: CustomLineItem[];
     months: string[];
     due_date: number;
@@ -337,18 +456,14 @@ export interface PlanPayment {
     time_updated: number;
 }
 export interface Company {
-    events: _Event[];
-    months: ServiceMonth[];
     id: string;
-    jobs: Job[];
     name: string;
     email: string;
-    routes: Route[];
-    teams: Team[];
     emails: Email[];
     skills: Skill[];
-    time_created: string;
-    time_updated: string | null;
+    catalog_items: CatalogItem[];
+    time_created: number;
+    time_updated: number | null;
     users: UserCompanyAssociation[];
     use_client_side_customer_start_billing: boolean;
     use_client_side_customer_stop_billing: boolean;
@@ -356,10 +471,10 @@ export interface Company {
     use_client_side_employee_stop_billing: boolean;
     logo_url: string;
     delay_scalar: number;
-    incomplete_payments: PlanPayment[];
+    payments: PlanPayment[];
     overdue_threshold: number;
     stripe_account_id: string;
-    is_restricted: false;
+    is_restricted: boolean;
     disabled_reason: string;
     completed_onboarding: boolean;
     restricted_soon: boolean;
@@ -367,6 +482,9 @@ export interface Company {
     billing_email_id: string;
     num_events: number;
     num_jobs: number;
+    num_routes: number;
+    num_teams: number;
+    num_skills: number;
     bills: Bill[];
     enabled_payment_methods: string[];
     sessions: Session[];
@@ -380,8 +498,8 @@ export interface Company {
     balance: number;
     plan_id: string;
     payment_methods: PaymentMethod[];
-    autopay_payment_id: string;
     intuit_connected: boolean;
+    next_payment_due: number | null;
 }
 export interface RouteJob {
     time_created: number;
@@ -430,8 +548,9 @@ export interface Job {
     routes: RouteJob[];
     subscribers: Subscription[];
     manual_emails: string[][];
+    overdue_time: number;
     last_completed_event: _Event | null;
-    last_event: _Event | null;
+    current_event: _Event | null;
     labels: string[];
     owner: string;
 }
@@ -452,7 +571,8 @@ export interface Task {
     created_by: UserCompanyAssociation | null;
     overdueness: number | null;
     overdue_time: number;
-    last_event: _Event | null;
+    last_completed_event: _Event | null;
+    current_event: _Event | null;
     delay: number;
     skills: string[];
     service: number;
@@ -464,6 +584,7 @@ export interface Task {
     services_prepaid: number;
     months_prepaid: number;
     priority: boolean;
+    route_ids: string[];
 }
 export interface TaskWrapper {
     latestEvent: number;
@@ -485,25 +606,31 @@ export interface taskEndInfo {
     internal_notes: string;
     external_notes: string;
 }
-export interface AdditionalCharge {
-    id: string;
+export interface AdditionalCharge extends LineItem {
     line_item_type: "ADDITIONAL_CHARGE";
-    time_created: number;
     time_updated: number | null;
-    name: string;
-    amount: number;
 }
-export interface _Event {
-    breaks: string[];
+export interface UserEvent {
     id: string;
+    session_id: string;
+    event_id: string;
+    user_id: string | null;
+    team_id: string | null;
+    user_name: string | null;
+    team_name: string | null;
+    time_started: number | null;
+    time_ended: number | null;
+    time_created: number | null;
+    time_updated: number | null;
+}
+export interface _Event extends LineItem {
+    breaks: string[];
     line_item_type: "EVENT";
-    name: string;
     internal_notes: string;
     external_notes: string;
     proofs: string[];
     tasks: string[];
-    time_created: number;
-    time_ended: number;
+    time_ended: number | null;
     time_started: number;
     time_updated: number | null;
     job_id: string;
@@ -512,11 +639,76 @@ export interface _Event {
     bill_id: string;
     billed_amount: number;
     additional_charges: AdditionalCharge[];
-    user_id: string;
-    team_id: string;
-    cost: number;
+    users: UserEvent[];
     billed: boolean;
     paid: boolean;
     autostart: boolean;
     job_labels: string[];
 }
+export interface FinancialInsightData {
+    start: number;
+    end: number;
+    unbilled: {
+        events: {
+            count: number;
+            amount: number;
+        };
+        service_months: {
+            count: number;
+            amount: number;
+        };
+        total: number;
+    };
+    billed_unbilled: {
+        events: {
+            count: number;
+            amount: number;
+        };
+        service_months: {
+            count: number;
+            amount: number;
+        };
+        total: number;
+    };
+    paid_unbilled: {
+        events: {
+            count: number;
+            amount: number;
+        };
+        service_months: {
+            count: number;
+            amount: number;
+        };
+        total: number;
+    };
+    prepaid: {
+        events: {
+            count: number;
+            amount: number;
+        };
+        service_months: {
+            count: number;
+            amount: number;
+        };
+        total: number;
+    };
+    accounts_receivable: {
+        overdue: number;
+        not_overdue: number;
+    };
+    cash: number;
+}
+export interface EventInsightData {
+    start: number;
+    end: number;
+    events_per_job: {
+        id: string;
+        name: string;
+        event_count: number;
+    }[];
+    events_per_team: {
+        team_id: string;
+        event_count: number;
+    }[];
+    total_events: number;
+}