@go-avro/avro-js 0.0.48 → 0.0.49

package/dist/client/QueryClient.d.ts

@@ -9,17 +9,9 @@ import { CacheData } from '../types/cache';
 import { Waiver } from '../types/api/Waiver';
 import type { EmailSucceededPayload, EmailFailedPayload, EmailType } from '../types/api/EmailNotification';
 import type { BulkDeleteBillsResponse, BulkEmailBillsResponse } from '../client/hooks/bills';
-/** Callbacks for a tracked email request. */
 export interface TrackEmailOptions {
     emailType?: EmailType;
-    /**
-     * Pre-existing request_id to register. When omitted, a fresh uuid is
-     * generated. Pass this when the request_id was produced elsewhere
-     * (e.g. a bulk endpoint returns one in its synchronous response, or
-     * the caller wants to pre-generate it and ship it in the POST body).
-     */
     requestId?: string;
-    /** How long to wait before firing onTimeout (ms). Default 30 000. */
     timeout?: number;
     onSuccess?: (data: EmailSucceededPayload) => void;
     onFailure?: (data: EmailFailedPayload) => void;
@@ -757,20 +749,7 @@ export declare class AvroQueryClient {
         query?: string;
         offset?: number;
     }, cancelToken?: CancelToken, headers?: Record<string, string>): Promise<any>;
-    /**
-     * Lazily register socket listeners for email_succeeded / email_failed.
-     * Listeners live on the socket (not in a React effect) so they survive
-     * component unmounts.
-     */
     private _initEmailListeners;
-    /**
-     * Track an outbound email request.
-     *
-     * Generates a `request_id`, registers socket listeners (once), and returns
-     * the ID so callers can pass it in the HTTP body. The backend emits
-     * `email_succeeded` / `email_failed` to the user's GUID room; this method
-     * correlates the event by `request_id` and fires the appropriate callback.
-     */
     trackEmail(options?: TrackEmailOptions): string;
     sendEmail(emailId: string, formData: FormData, progressUpdateCallback?: (loaded: number, total: number) => void): Promise<void>;
     sendBillEmail(billId: string, body?: {

package/dist/client/QueryClient.js

@@ -1100,12 +1100,6 @@ export class AvroQueryClient {
             throw new StandardError(500, 'Failed to fetch sessions');
         });
     }
-    /* ── Email delivery tracking ──────────────────────────────────────── */
-    /**
-     * Lazily register socket listeners for email_succeeded / email_failed.
-     * Listeners live on the socket (not in a React effect) so they survive
-     * component unmounts.
-     */
     _initEmailListeners() {
         if (this._emailListenersInit)
             return;
@@ -1114,7 +1108,6 @@ export class AvroQueryClient {
             const entry = this._emailTracking.get(data.request_id);
             if (!entry)
                 return;
-            // Reset timeout — more recipients may follow for the same request_id
             clearTimeout(entry.timerId);
             entry.timerId = setTimeout(() => {
                 this._emailTracking.delete(data.request_id);
@@ -1132,21 +1125,10 @@ export class AvroQueryClient {
             entry.onFailure?.(data);
         });
     }
-    /**
-     * Track an outbound email request.
-     *
-     * Generates a `request_id`, registers socket listeners (once), and returns
-     * the ID so callers can pass it in the HTTP body. The backend emits
-     * `email_succeeded` / `email_failed` to the user's GUID room; this method
-     * correlates the event by `request_id` and fires the appropriate callback.
-     */
     trackEmail(options = {}) {
         this._initEmailListeners();
         const requestId = options.requestId ?? uuidv4();
         const { timeout = 30000 } = options;
-        // If this request_id is already being tracked, replace the existing
-        // entry so the latest caller's handlers win. (Callers that reuse a
-        // request_id are explicitly opting in to this behaviour.)
         const existing = this._emailTracking.get(requestId);
         if (existing) {
             clearTimeout(existing.timerId);

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

@@ -5,43 +5,15 @@ export interface EmailResult {
     status: EmailResultStatus;
     emailType?: EmailType;
     recipient?: string;
-    /**
-     * Bill GUID when the event came from a bill email — single or bulk.
-     * Use this to correlate per-bill outcomes when one `requestId`
-     * covers many bills (`POST /company/<id>/bills/bulk`).
-     */
     billGuid?: string;
     error?: EmailFailedPayload['error'];
 }
 export interface UseEmailStatusOptions {
-    /** How long to wait for a socket event before firing `onTimeout` (ms). Default 30 000. */
     timeout?: number;
-    /** Called when the backend reports success. */
     onSuccess?: (result: EmailResult) => void;
-    /** Called when the backend reports failure. */
     onFailure?: (result: EmailResult) => void;
-    /** Called when neither success nor failure arrives within the timeout window. */
     onTimeout?: (requestId: string) => void;
 }
-/**
- * Subscribe to backend email delivery notifications via Socket.IO.
- *
- * Delegates to `AvroQueryClient.trackEmail()` which registers socket
- * listeners on the client itself (not in a React effect), so
- * notifications survive component unmounts.
- *
- * Usage:
- * ```ts
- * const { trackEmail, pending, results } = useEmailStatus({
- *   onSuccess: (r) => toast.success(`Email sent to ${r.recipient}`),
- *   onFailure: (r) => toast.error(`Email failed: ${r.error?.message}`),
- *   onTimeout: (id) => toast.warn("Email status unknown"),
- * });
- *
- * const requestId = trackEmail("bill");
- * await avroQueryClient.sendBillingEmail({ billId, request_id: requestId });
- * ```
- */
 export declare function useEmailStatus(options?: UseEmailStatusOptions): {
     readonly trackEmail: (emailType?: EmailType, opts?: {
         requestId?: string;

package/dist/client/hooks/email.js

@@ -1,41 +1,16 @@
 import { useCallback, useRef, useState } from 'react';
 import { useAvroQueryClient } from '../../client/AvroQueryClientProvider';
-/* ──────────────────────────────────────────────────────────────────────── */
-/*  Hook                                                                                                                                                                                                        */
-/* ──────────────────────────────────────────────────────────────────────── */
-/**
- * Subscribe to backend email delivery notifications via Socket.IO.
- *
- * Delegates to `AvroQueryClient.trackEmail()` which registers socket
- * listeners on the client itself (not in a React effect), so
- * notifications survive component unmounts.
- *
- * Usage:
- * ```ts
- * const { trackEmail, pending, results } = useEmailStatus({
- *   onSuccess: (r) => toast.success(`Email sent to ${r.recipient}`),
- *   onFailure: (r) => toast.error(`Email failed: ${r.error?.message}`),
- *   onTimeout: (id) => toast.warn("Email status unknown"),
- * });
- *
- * const requestId = trackEmail("bill");
- * await avroQueryClient.sendBillingEmail({ billId, request_id: requestId });
- * ```
- */
 export function useEmailStatus(options = {}) {
     const { timeout = 30000 } = options;
     const client = useAvroQueryClient();
-    // Use refs for callbacks so the client-level handlers always see the latest
     const onSuccessRef = useRef(options.onSuccess);
     const onFailureRef = useRef(options.onFailure);
     const onTimeoutRef = useRef(options.onTimeout);
     onSuccessRef.current = options.onSuccess;
     onFailureRef.current = options.onFailure;
     onTimeoutRef.current = options.onTimeout;
-    // Expose reactive state so the UI can render pending / completed
     const [pending, setPending] = useState(new Map());
     const [results, setResults] = useState(new Map());
-    /* ── trackEmail — delegates to client.trackEmail() ──────────────── */
     const trackEmail = useCallback((emailType, opts = {}) => {
         const requestId = client.trackEmail({
             emailType,

package/package.json

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