@docuninja/builder2.0 0.0.88 → 0.0.89

package/dist/builder/ui/index.d.ts

@@ -131,3 +131,5 @@ export * as BuilderTypes from '../types/api';
 export type { Rectangle } from '../../builder/index';
 export * from '../pdf-worker';
 export * from '../password-files';
+export * from '../websocket-manager';
+export * from './websockets';

package/dist/builder/ui/websockets.d.ts

@@ -11,7 +11,7 @@ type Props = {
  * 3. Manages component lifecycle (connect/disconnect on mount/unmount)
  */
 export declare function WebSockets({ children, context }: Props): import("@emotion/react/jsx-runtime").JSX.Element | null;
-export declare const events: readonly ["App\\Events\\DocumentFile\\DocumentFilePreviewGenerated"];
+export declare const events: readonly ["App\\Events\\DocumentFile\\DocumentFilePreviewGenerated", "App\\Events\\Document\\DocumentWasSigned"];
 export type Event = (typeof events)[number];
 export type Callbacks = Record<Event, (data: unknown) => unknown>;
 export type UsePrivateSocketEventsProps = {
@@ -35,4 +35,13 @@ export interface GenericMessage {
     message: string;
     link: string | null;
 }
+export type UseWebSocketSubscriptionProps = {
+    events: Event[] | string[];
+    onEvent: (eventName: Event | string, data: unknown) => void;
+    token: string;
+    companyId: string;
+    endpoint: string;
+    context?: "builder" | "sign";
+};
+export declare function useWebSocketSubscription({ events, onEvent, token, companyId, endpoint, context, }: UseWebSocketSubscriptionProps): void;
 export {};

package/dist/builder.d.ts

@@ -1,5 +1,6 @@
 import { Axios } from 'axios';
 import { Context } from 'react';
+import { default as default_2 } from 'pusher-js';
 import { FieldValues } from 'react-hook-form';
 import { JSX as JSX_2 } from '@emotion/react/jsx-runtime';
 import * as lib from 'pdfjs-dist';
@@ -207,6 +208,13 @@ export declare namespace BuilderTypes {
     }
 }
 
+export declare interface CallbackOptions<T> {
+    event: Event_2;
+    data: T;
+}
+
+export declare type Callbacks = Record<Event_2, (data: unknown) => unknown>;
+
 declare type CheckboxOperator = "checked" | "unchecked";
 
 export declare function checkPdfPassword(file: File, password: string): Promise<boolean>;
@@ -323,6 +331,14 @@ export declare type ConfirmationDialogProps = {
     action: React.ReactNode;
 };
 
+export declare type ConnectionConfig = {
+    context: "builder" | "sign";
+    token: string;
+    endpoint?: string;
+    onConnected?: () => void;
+    onError?: (error: PusherError) => void;
+};
+
 export declare type ConsentContinueButtonProps = {
     onClick: () => void;
     disabled: boolean;
@@ -517,6 +533,11 @@ export declare enum DocumentStatus {
     Voided = 8
 }
 
+declare type Event_2 = (typeof events)[number];
+export { Event_2 as Event }
+
+export declare const events: readonly ["App\\Events\\DocumentFile\\DocumentFilePreviewGenerated", "App\\Events\\Document\\DocumentWasSigned"];
+
 export declare interface GenericManyResponse<T> {
     data: T[];
     links: {
@@ -541,12 +562,19 @@ export declare interface GenericManyResponse<T> {
     };
 }
 
+export declare interface GenericMessage {
+    message: string;
+    link: string | null;
+}
+
 export declare interface GenericSingleResponse<T> {
     data: T;
 }
 
 export declare function getPasswordForPdf(file: File): Promise<string | null>;
 
+export declare const getWebSocketManager: () => WebSocketManager;
+
 export declare type ImportFromButtonProps = {
     onClick: () => void;
     isSubmitting: boolean;
@@ -595,6 +623,21 @@ export declare interface Plan {
     highlighted_features: string[];
 }
 
+declare type Props = {
+    children: React.ReactNode;
+    context: "builder" | "sign";
+};
+
+declare type PusherError = {
+    error?: {
+        type: string;
+        data: {
+            code?: number;
+            message?: string;
+        };
+    };
+};
+
 /** Hey there, you! So you want to add a prop onto this interface huh? No probs, but PLEASE notify upstream that this interface has changed so we can update the types in all repos :) */
 export declare type Rectangle = {
     id: string;
@@ -872,6 +915,13 @@ declare type SingleCondition = {
     value?: string | number | string[];
 };
 
+export declare interface SocketEventProps<T> {
+    on: Event_2 | Event_2[];
+    callback: (options: CallbackOptions<T>) => unknown;
+}
+
+export declare function socketId(): number | null;
+
 export declare type StartSigningButtonProps = {
     onClick: () => void;
 };
@@ -958,6 +1008,12 @@ export declare function useOptionalSignContextPlus(): (Sign & {
     http: Axios;
 }) | null;
 
+export declare function usePrivateSocketEvents({ context, }: UsePrivateSocketEventsProps): null;
+
+export declare type UsePrivateSocketEventsProps = {
+    context: "builder" | "sign";
+};
+
 export declare interface User {
     id: string;
     account_id: string | null;
@@ -990,6 +1046,19 @@ export declare function useSignContextPlus(): Sign & {
     http: Axios;
 };
 
+export declare function useSocketEvent<T>({ on, callback }: SocketEventProps<T>): void;
+
+export declare function useWebSocketSubscription({ events, onEvent, token, companyId, endpoint, context, }: UseWebSocketSubscriptionProps): void;
+
+export declare type UseWebSocketSubscriptionProps = {
+    events: Event_2[] | string[];
+    onEvent: (eventName: Event_2 | string, data: unknown) => void;
+    token: string;
+    companyId: string;
+    endpoint: string;
+    context?: "builder" | "sign";
+};
+
 export declare interface ValidationBag {
     message: string;
     errors: Record<string, string[]>;
@@ -1001,9 +1070,81 @@ export declare type ValidationErrorsProps = {
 
 declare type ValidationRule = "none" | "length" | "ssn" | "ein" | "email" | "url" | "zip" | "numbers_only" | "letters_only" | "custom";
 
+/**
+ * Singleton WebSocket Manager
+ *
+ * Ensures only one Pusher connection exists across the entire application.
+ * Manages connections for both "builder" and "sign" contexts.
+ *
+ * Handles React StrictMode double-mounting by checking connection state before creating new instances.
+ */
+declare class WebSocketManager {
+    private static instance;
+    private pusher;
+    private activeContexts;
+    private connectionConfig;
+    private isConnecting;
+    private readonly pusherKey;
+    private readonly pusherUrl;
+    private constructor();
+    /**
+     * Get the singleton instance
+     */
+    static getInstance(): WebSocketManager;
+    /**
+     * Connect to Pusher for a specific context
+     *
+     * This method is idempotent - calling it multiple times will reuse the existing connection.
+     * Prevents race conditions from StrictMode double-mounting or rapid successive calls.
+     */
+    connect(config: ConnectionConfig): default_2;
+    /**
+     * Create a new Pusher connection
+     */
+    private createPusherConnection;
+    /**
+     * Disconnect from Pusher
+     */
+    disconnect(): void;
+    /**
+     * Get the current Pusher instance
+     */
+    getPusher(): default_2 | null;
+    /**
+     * Check if connected
+     */
+    isConnected(): boolean;
+    /**
+     * Remove a context from active contexts (for feedback/debugging only)
+     *
+     * NOTE: This method no longer disconnects the connection.
+     * The singleton connection should persist across navigation.
+     * Use disconnect() explicitly if you need to close the connection.
+     */
+    removeContext(context: "builder" | "sign"): void;
+    /**
+     * Update connection configuration (e.g., when token changes)
+     */
+    updateConnection(config: Partial<ConnectionConfig>): void;
+}
+
+/**
+ * WebSockets Component (Refactored to use Singleton Manager)
+ *
+ * This component now acts as a thin wrapper that:
+ * 1. Initializes the singleton WebSocket manager
+ * 2. Updates the Zustand store with the connection instance
+ * 3. Manages component lifecycle (connect/disconnect on mount/unmount)
+ */
+export declare function WebSockets({ children, context }: Props): JSX_2.Element | null;
+
 export declare type WithSignerToken<T> = T & {
     "X-Signer-Token": string;
     "X-Signer-Token-Expires": string;
 };
 
+export declare type WithSocketId<T> = T & {
+    "x-socket-id": string;
+};
+
 export { }