@go-avro/avro-js 0.0.2-beta.1 → 0.0.2-beta.100

package/dist/types/api.d.ts

@@ -1,19 +1,598 @@
-export interface AvroUser {
+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 PaymentMethod {
+    allow_redisplay: string;
+    autopay: boolean;
+    billing_details: {
+        email: string;
+        name: string;
+    };
+    created: number;
+    customer: string;
+    id: string;
+    type: "us_bank_account" | "card";
+    us_bank_account: {
+        account_holder_type: string;
+        account_type: string;
+        bank_name: string;
+        financial_connections_account: string;
+        fingerprint: string;
+        last4: string;
+        networks: {
+            preferred: string;
+            supported: string[];
+        };
+        routing_number: string;
+        status_details: object;
+    } | null;
+    card: {
+        brand: string;
+        checks: {
+            address_line1_check: string;
+            address_postal_code_check: string;
+            cvc_check: string;
+        };
+        country: string;
+        exp_month: number;
+        exp_year: number;
+        fingerprint: string;
+        funding: string;
+        last4: string;
+        networks: {
+            preferred: string;
+            supported: string[];
+        };
+        three_d_secure_usage: {
+            supported: boolean;
+        };
+        wallet: {
+            type: string;
+        } | null;
+    } | null;
+}
+export interface Avro {
+    id: string;
+    name: string;
+    time_created: number;
+    time_updated: number;
+    emails: Email[];
+    totp_email_id: string;
+    billing_email_id: string;
+    join_email_id: string;
+}
+export interface Friendship {
+}
+export interface MemberState {
+    id: string;
+    state: string;
+    friendship: Friendship | null;
+    last_message_read_at: number | null;
+}
+export interface LineItem {
+    id: string;
+    line_item_type: "CUSTOM" | "ADDITIONAL_CHARGE" | "EVENT" | "SERVICE_MONTH";
+    name: string;
+    description: string;
+    cost: number | null;
+    amount: number | null;
+    time_created: number;
+}
+export interface CustomLineItem extends LineItem {
+    line_item_type: "CUSTOM";
+}
+export interface Reaction {
+    id: string;
+    message_id: string;
+    sender_id: string;
+    reaction: string;
+    time_created: number;
+    time_updated: number;
+}
+export interface Message {
+    id: string;
+    chat_id: string;
+    sender_id: string;
+    reply_to_id: string;
+    content: string;
+    reactions: Reaction[];
+    time_created: number;
+    time_updated: number;
+    time_sent: number;
+    message: string;
+}
+export interface Chat {
+    id: string;
+    name: string;
+    company_id: string;
+    time_created: number;
+    time_updated: number;
+    last_message: Message;
+    user_state: MemberState[];
+    messages: Message[];
+}
+export interface TeamLocation {
+    accuracy: number;
+    heading: number;
+    id: string;
+    latitude: number;
+    longitude: number;
+    time_collected: number;
+    time_created: number;
+    time_updated: number | null;
+}
+export interface Team {
+    autoconfigure: boolean;
+    company_id: string;
+    description: string;
+    end: number[];
+    end_time: number;
+    fixed_cost: number;
+    hourly_cost: number;
+    id: string;
+    items: string[];
+    km_cost: number;
+    max_distance: number;
+    max_jobs: number;
+    max_travel_time: number;
+    color: string;
+    name: string;
+    profile: string;
+    routes: string[];
+    skills: string[];
+    speed_factor: number;
+    start_latitude: number;
+    start_longitude: number;
+    end_latitude: number;
+    end_longitude: number;
+    start_time: number;
+    users: string[];
+    current_location: TeamLocation;
+    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;
+    notifications: number;
+}
+export interface Plan {
+    id: string;
+    name: string;
+    base_rate: number;
+    price_per_job: number;
+    description: string;
+    referral_codes: string[];
+    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";
+    type: "us_bank_account" | "card";
+    action_required_at: number;
+    time_created: number;
+    time_updated: number | null;
+}
+export interface BillUser {
+    id: string;
+    user_id: string;
+    bill_id: string;
+    invoice_id: string;
+    payment_attempts: BillPayment[];
+    time_created: number;
+    time_updated: number | null;
+    amount: number;
+}
+export interface User {
+    id: string;
+    username: string;
+    name: string;
+    verified: boolean;
+    companies: UserCompanyAssociation[] | null;
+    email: string | null;
+    phone_number: string | null;
+    time_created: number;
+    time_updated: number | null;
+    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;
+    time_started: number;
+    time_ended: number;
+    company_billable: boolean;
+    client_billable: boolean;
+}
+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;
+    billed: boolean;
+    paid: boolean;
+    tasks: string[];
+    time_updated: number | null;
+}
+export interface Session {
+    id: string;
+    user_id: string;
+    company_id: string;
+    time_started: number;
+    time_ended: number;
+    break_id: string;
+    is_paused: boolean;
+    team_id: string;
+    route_id: string;
+    breaks: Break[];
+}
+export interface Group {
+    id: string;
+    name: string;
+    is_active: boolean;
+    is_user_type: boolean;
+    users: string[];
+    permissions: string[];
+    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 interface UserCompanyAssociation {
+    id: string;
+    user: User;
+    company: string;
+    permissions: string[];
+    effective_permissions: string[];
+    time_created: number | null;
+    time_updated: number | null;
+    notification_setting: NotificationLevel[];
+    share_email_company_wide: boolean;
+    notifications: Notification[];
+    groups: string[];
+}
+export interface Email {
+    id: string;
+    company_id: string;
+    name: string;
+    mail_server: string;
+    mail_port: number;
+    mail_username: string;
+    mail_password: string | null;
+    mail_default_sender: string;
+    mail_use_tls: boolean;
+    mail_use_ssl: boolean;
+    mail_api_key: string;
+    is_company_wide: boolean;
+    users: User[];
+    type: "OUTLOOK" | "SMTP" | "GMAIL";
+    access_token?: string;
+    access_token_expiry?: number;
+    refresh_token?: string;
+    refresh_token_expiry?: number;
+}
+export interface Label {
+    name: string;
+    id: string;
+    company_id: string;
+    color: string;
+    jobs: string[];
+}
+export interface Bill {
+    id: string;
+    invoice_id: number;
+    intuit_id: string | null;
+    name: string;
+    amount: number;
+    billed_by: string;
+    customer_email: string | null;
+    manual_emails: string[][];
+    users: BillUser[];
+    paid: boolean;
+    paid_at: number;
+    time_created: number;
+    time_updated: number;
+    events: string[];
+    intent_created_at: number;
+    intent_last_created_at: number;
+    payment: BillPayment | null;
+    line_items: CustomLineItem[];
+    months: string[];
+    due_date: number;
+}
+export interface Skill {
+    id: string;
+    name: string;
+    company_id: string;
+    time_created: number;
+    time_updated: number;
+}
+export interface PlanPayment {
+    id: string;
+    amount: number;
+    stripe_pi_id: string;
+    company_id: string;
+    plan_id: string;
+    status: "created" | "processing" | "succeeded" | "failed" | "canceled";
+    time_created: number;
+    time_updated: number;
+}
+export interface Company {
     id: string;
     name: string;
     email: string;
-    teams: AvroTeam[];
+    emails: Email[];
+    skills: Skill[];
+    time_created: number;
+    time_updated: number | null;
+    users: UserCompanyAssociation[];
+    use_client_side_customer_start_billing: boolean;
+    use_client_side_customer_stop_billing: boolean;
+    use_client_side_employee_start_billing: boolean;
+    use_client_side_employee_stop_billing: boolean;
+    logo_url: string;
+    delay_scalar: number;
+    incomplete_payments: PlanPayment[];
+    overdue_threshold: number;
+    stripe_account_id: string;
+    is_restricted: false;
+    disabled_reason: string;
+    completed_onboarding: boolean;
+    restricted_soon: boolean;
+    service_email_id: string;
+    billing_email_id: string;
+    num_events: number;
+    num_jobs: number;
+    num_routes: number;
+    num_teams: number;
+    bills: Bill[];
+    enabled_payment_methods: string[];
+    sessions: Session[];
+    num_sessions: number;
+    labels: Label[];
+    groups: Group[];
+    indicator_lifetime: number;
+    available_plans: Plan[];
+    last_payment: number;
+    last_charged: number;
+    balance: number;
+    plan_id: string;
+    payment_methods: PaymentMethod[];
+    autopay_payment_id: string;
+    intuit_connected: boolean;
+}
+export interface RouteJob {
+    time_created: number;
+    route_id: string;
+    job_id: string;
+    id: string;
+    order: number;
+    estimated_arrival_time: number;
+    scheduled_arrival_time: number;
+    tasks: string[];
+}
+export interface Route {
+    company: string;
+    id: string;
+    is_internal: boolean;
+    jobs: RouteJob[];
+    name: string;
+    time_created: number;
+    time_updated: number | null;
+    teams: string[];
+    polyline: string;
+    is_optimized: boolean;
+    start_time: number;
+    end_time: number;
+    start_latitude: number;
+    start_longitude: number;
+    end_latitude: number;
+    end_longitude: number;
 }
-export interface AvroTeam {
+export interface Job {
+    address: string;
+    company: string;
+    description: string;
     id: string;
+    is_one_time: boolean;
+    autostart_radius: number;
+    latitude: number;
+    longitude: number;
     name: string;
-    members: AvroUser[];
+    internal_notes: string;
+    external_notes: string;
+    priority: number;
+    tasks: Task[];
+    time_created: number;
+    time_updated: number | null;
+    routes: RouteJob[];
+    subscribers: Subscription[];
+    manual_emails: string[][];
+    overdue_time: number;
+    last_completed_event: _Event | null;
+    last_event: _Event | null;
+    labels: string[];
+    owner: string;
 }
-export interface AvroJob {
+export interface Task {
+    enforce_proof_amount: boolean;
+    events: _Event[];
+    frequency: number;
     id: string;
-    location: {
-        lat: number;
-        lng: number;
+    job_id: string;
+    name: string;
+    internal_notes: string;
+    external_notes: string;
+    proof_amt: number;
+    images: string[];
+    time_created: number;
+    time_updated: number | null;
+    status: "PENDING_CUSTOMER" | "PENDING_COMPANY" | "ACTIVE" | "ARCHIVED" | "DRAFT";
+    created_by: UserCompanyAssociation | null;
+    overdueness: number | null;
+    overdue_time: number;
+    last_completed_event: _Event | null;
+    last_event: _Event | null;
+    delay: number;
+    skills: string[];
+    service: number;
+    bill_mode: "MONTH" | "SERVICE" | "NONE";
+    price: number;
+    services_remaining: number;
+    expire_on: number | null;
+    bill_day: number | null;
+    services_prepaid: number;
+    months_prepaid: number;
+    priority: boolean;
+    route_ids: string[];
+}
+export interface TaskWrapper {
+    latestEvent: number;
+    task: Task;
+}
+export interface JobWrapper {
+    latestEvent: number;
+    routeIndex: number;
+    job: Job;
+    frequency: number;
+    isOverdue: boolean;
+}
+export interface taskStartInfo {
+    name: string;
+    start: number;
+}
+export interface taskEndInfo {
+    end: number;
+    internal_notes: string;
+    external_notes: string;
+}
+export interface AdditionalCharge extends LineItem {
+    line_item_type: "ADDITIONAL_CHARGE";
+    time_updated: number | null;
+}
+export interface _Event extends LineItem {
+    breaks: string[];
+    line_item_type: "EVENT";
+    internal_notes: string;
+    external_notes: string;
+    proofs: string[];
+    tasks: string[];
+    time_ended: number;
+    time_started: number;
+    time_updated: number | null;
+    job_id: string;
+    job_name: string;
+    job_address: string;
+    bill_id: string;
+    billed_amount: number;
+    additional_charges: AdditionalCharge[];
+    user_id: string;
+    team_id: string;
+    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;
     };
-    status: 'active' | 'pending' | 'complete';
+    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;
 }

package/dist/types/api.js

@@ -1 +1,10 @@
-export {};
+export const NotificationLevel = {
+    IN_APP: 0,
+    EMAIL: 1,
+    SMS: 2,
+    PUSH: 3
+};
+export const LoginResponse = {
+    SUCCESS: "SUCCESS",
+    NEEDS_TOTP: "NEEDS_TOTP",
+};

package/dist/types/auth.d.ts

@@ -2,8 +2,3 @@ export interface Tokens {
     access_token: string;
     refresh_token: string;
 }
-export interface TokenStorage {
-    get(): Promise<Tokens | null>;
-    set(tokens: Tokens): Promise<void>;
-    clear(): Promise<void>;
-}

package/dist/types/cache.d.ts

@@ -0,0 +1,9 @@
+import { Tokens } from "../types/auth";
+export interface CacheData extends Tokens {
+    companyId: string;
+}
+export interface Cache {
+    get(key?: keyof CacheData): Promise<CacheData | string | null>;
+    set(data: Partial<CacheData>): Promise<void>;
+    clear(): Promise<void>;
+}

package/dist/types/cache.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go-avro/avro-js",
-  "version": "0.0.2-beta.1",
+  "version": "0.0.2-beta.100",
   "description": "JS client for Avro backend integration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -32,15 +32,13 @@
   "author": "Avro <info@goavro.com>",
   "license": "CC-BY-SA-4.0",
   "devDependencies": {
-    "@types/jest": "^29.0.0",
+    "@types/react": "^19.2.2",
     "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.38.0",
     "eslint": "^8.57.1",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",
-    "jest": "^29.0.0",
-    "ts-jest": "^29.0.0",
     "tsc-alias": "^1.8.16",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.38.0"
@@ -50,5 +48,9 @@
   ],
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@tanstack/react-query": "^5.90.2",
+    "socket.io-client": "^4.8.1"
   }
 }